From a5bd59d4551bc72951bbdbb144a2a85c0aba0fdd Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Mon, 13 May 2019 16:23:08 -0700 Subject: [PATCH] feat: run the generator --- package.json | 48 +- samples/drive/quickstart.js | 2 +- samples/oauth2.js | 2 +- samples/package.json | 9 +- samples/sampleclient.js | 2 +- samples/sheets/quickstart.js | 2 +- src/apis/abusiveexperiencereport/package.json | 12 +- src/apis/abusiveexperiencereport/v1.ts | 39 +- .../acceleratedmobilepageurl/package.json | 4 +- src/apis/acceleratedmobilepageurl/v1.ts | 45 +- src/apis/accessapproval/package.json | 4 +- src/apis/accessapproval/v1beta1.ts | 206 +- src/apis/accesscontextmanager/package.json | 4 +- src/apis/accesscontextmanager/v1.ts | 386 +- src/apis/accesscontextmanager/v1beta.ts | 360 +- src/apis/adexchangebuyer/package.json | 4 +- src/apis/adexchangebuyer/v1.2.ts | 104 +- src/apis/adexchangebuyer/v1.3.ts | 248 +- src/apis/adexchangebuyer/v1.4.ts | 595 +- src/apis/adexchangebuyer2/package.json | 4 +- src/apis/adexchangebuyer2/v2beta1.ts | 1711 +- src/apis/adexperiencereport/package.json | 4 +- src/apis/adexperiencereport/v1.ts | 42 +- src/apis/admin/datatransfer_v1.ts | 54 +- src/apis/admin/directory_v1.ts | 568 +- src/apis/admin/package.json | 4 +- src/apis/admin/reports_v1.ts | 103 +- src/apis/adsense/package.json | 4 +- src/apis/adsense/v1.4.ts | 361 +- src/apis/adsensehost/package.json | 4 +- src/apis/adsensehost/v4.1.ts | 202 +- src/apis/alertcenter/package.json | 4 +- src/apis/alertcenter/v1beta1.ts | 219 +- src/apis/analytics/package.json | 4 +- src/apis/analytics/v2.4.ts | 89 +- src/apis/analytics/v3.ts | 909 +- src/apis/analyticsreporting/package.json | 4 +- src/apis/analyticsreporting/v4.ts | 553 +- .../androiddeviceprovisioning/package.json | 4 +- src/apis/androiddeviceprovisioning/v1.ts | 440 +- src/apis/androidenterprise/package.json | 4 +- src/apis/androidenterprise/v1.ts | 1172 +- src/apis/androidmanagement/package.json | 4 +- src/apis/androidmanagement/v1.ts | 934 +- src/apis/androidpublisher/index.ts | 3 +- src/apis/androidpublisher/package.json | 4 +- src/apis/androidpublisher/v1.1.ts | 89 +- src/apis/androidpublisher/v1.ts | 59 +- src/apis/androidpublisher/v2.ts | 722 +- src/apis/androidpublisher/v3.ts | 1143 +- src/apis/appengine/package.json | 4 +- src/apis/appengine/v1.ts | 1047 +- src/apis/appengine/v1alpha.ts | 352 +- src/apis/appengine/v1beta.ts | 1070 +- src/apis/appsactivity/package.json | 4 +- src/apis/appsactivity/v1.ts | 104 +- src/apis/appstate/package.json | 4 +- src/apis/appstate/v1.ts | 63 +- src/apis/bigquery/package.json | 4 +- src/apis/bigquery/v2.ts | 2403 +- src/apis/bigquerydatatransfer/package.json | 4 +- src/apis/bigquerydatatransfer/v1.ts | 554 +- src/apis/bigtableadmin/package.json | 4 +- src/apis/bigtableadmin/v1.ts | 118 +- src/apis/bigtableadmin/v2.ts | 643 +- src/apis/binaryauthorization/package.json | 4 +- src/apis/binaryauthorization/v1beta1.ts | 325 +- src/apis/blogger/package.json | 4 +- src/apis/blogger/v2.ts | 32 +- src/apis/blogger/v3.ts | 162 +- src/apis/books/package.json | 4 +- src/apis/books/v1.ts | 257 +- src/apis/calendar/package.json | 4 +- src/apis/calendar/v3.ts | 1124 +- src/apis/chat/package.json | 4 +- src/apis/chat/v1.ts | 195 +- src/apis/civicinfo/package.json | 4 +- src/apis/civicinfo/v2.ts | 327 +- src/apis/classroom/package.json | 4 +- src/apis/classroom/v1.ts | 1309 +- src/apis/cloudasset/package.json | 4 +- src/apis/cloudasset/v1.ts | 312 +- src/apis/cloudasset/v1beta1.ts | 360 +- src/apis/cloudbilling/package.json | 4 +- src/apis/cloudbilling/v1.ts | 595 +- src/apis/cloudbuild/package.json | 4 +- src/apis/cloudbuild/v1.ts | 479 +- src/apis/cloudbuild/v1alpha1.ts | 372 +- src/apis/clouddebugger/package.json | 4 +- src/apis/clouddebugger/v2.ts | 531 +- src/apis/clouderrorreporting/package.json | 4 +- src/apis/clouderrorreporting/v1beta1.ts | 277 +- src/apis/cloudfunctions/package.json | 4 +- src/apis/cloudfunctions/v1.ts | 474 +- src/apis/cloudfunctions/v1beta2.ts | 332 +- src/apis/cloudidentity/package.json | 4 +- src/apis/cloudidentity/v1.ts | 245 +- src/apis/cloudidentity/v1beta1.ts | 242 +- src/apis/cloudiot/package.json | 4 +- src/apis/cloudiot/v1.ts | 689 +- src/apis/cloudkms/package.json | 4 +- src/apis/cloudkms/v1.ts | 497 +- src/apis/cloudprivatecatalog/package.json | 4 +- src/apis/cloudprivatecatalog/v1beta1.ts | 238 +- .../cloudprivatecatalogproducer/package.json | 4 +- .../cloudprivatecatalogproducer/v1beta1.ts | 475 +- src/apis/cloudprofiler/package.json | 4 +- src/apis/cloudprofiler/v2.ts | 96 +- src/apis/cloudresourcemanager/package.json | 4 +- src/apis/cloudresourcemanager/v1.ts | 1610 +- src/apis/cloudresourcemanager/v1beta1.ts | 780 +- src/apis/cloudresourcemanager/v2.ts | 437 +- src/apis/cloudresourcemanager/v2beta1.ts | 437 +- src/apis/cloudscheduler/package.json | 4 +- src/apis/cloudscheduler/v1.ts | 442 +- src/apis/cloudscheduler/v1beta1.ts | 453 +- src/apis/cloudsearch/package.json | 4 +- src/apis/cloudsearch/v1.ts | 1160 +- src/apis/cloudshell/package.json | 4 +- src/apis/cloudshell/v1.ts | 177 +- src/apis/cloudshell/v1alpha1.ts | 199 +- src/apis/cloudtasks/package.json | 4 +- src/apis/cloudtasks/v2.ts | 769 +- src/apis/cloudtasks/v2beta2.ts | 1393 +- src/apis/cloudtasks/v2beta3.ts | 777 +- src/apis/cloudtrace/package.json | 4 +- src/apis/cloudtrace/v1.ts | 188 +- src/apis/cloudtrace/v2.ts | 231 +- src/apis/commentanalyzer/package.json | 4 +- src/apis/commentanalyzer/v1alpha1.ts | 159 +- src/apis/composer/package.json | 4 +- src/apis/composer/v1.ts | 373 +- src/apis/composer/v1beta1.ts | 440 +- src/apis/compute/alpha.ts | 16308 +++----------- src/apis/compute/beta.ts | 18733 ++++------------ src/apis/compute/package.json | 4 +- src/apis/compute/v1.ts | 16043 ++++--------- src/apis/container/package.json | 4 +- src/apis/container/v1.ts | 2259 +- src/apis/container/v1beta1.ts | 1783 +- src/apis/containeranalysis/package.json | 4 +- src/apis/containeranalysis/v1alpha1.ts | 819 +- src/apis/containeranalysis/v1beta1.ts | 795 +- src/apis/content/index.ts | 3 +- src/apis/content/package.json | 4 +- src/apis/content/v2.1.ts | 1484 +- src/apis/content/v2.ts | 1942 +- src/apis/customsearch/package.json | 4 +- src/apis/customsearch/v1.ts | 115 +- src/apis/dataflow/package.json | 4 +- src/apis/dataflow/v1b3.ts | 2343 +- src/apis/datafusion/README.md | 47 + src/apis/datafusion/index.ts | 35 + src/apis/datafusion/package.json | 43 + src/apis/datafusion/tsconfig.json | 10 + src/apis/datafusion/v1beta1.ts | 2110 ++ src/apis/datafusion/webpack.config.js | 71 + src/apis/dataproc/package.json | 4 +- src/apis/dataproc/v1.ts | 2810 ++- src/apis/dataproc/v1beta2.ts | 1459 +- src/apis/datastore/package.json | 4 +- src/apis/datastore/v1.ts | 538 +- src/apis/datastore/v1beta1.ts | 239 +- src/apis/datastore/v1beta3.ts | 374 +- src/apis/deploymentmanager/alpha.ts | 882 +- src/apis/deploymentmanager/package.json | 4 +- src/apis/deploymentmanager/v2.ts | 919 +- src/apis/deploymentmanager/v2beta.ts | 853 +- src/apis/dfareporting/package.json | 4 +- src/apis/dfareporting/v3.1.ts | 3337 +-- src/apis/dfareporting/v3.2.ts | 3356 +-- src/apis/dfareporting/v3.3.ts | 3358 +-- src/apis/dialogflow/package.json | 4 +- src/apis/dialogflow/v2.ts | 1409 +- src/apis/dialogflow/v2beta1.ts | 1825 +- src/apis/digitalassetlinks/package.json | 4 +- src/apis/digitalassetlinks/v1.ts | 295 +- src/apis/discovery/package.json | 4 +- src/apis/discovery/v1.ts | 87 +- src/apis/dlp/package.json | 4 +- src/apis/dlp/v2.ts | 1754 +- src/apis/dns/package.json | 4 +- src/apis/dns/v1.ts | 551 +- src/apis/dns/v1beta2.ts | 504 +- src/apis/dns/v2beta1.ts | 694 +- src/apis/docs/package.json | 4 +- src/apis/docs/v1.ts | 1196 +- src/apis/doubleclickbidmanager/package.json | 4 +- src/apis/doubleclickbidmanager/v1.ts | 121 +- src/apis/doubleclicksearch/package.json | 4 +- src/apis/doubleclicksearch/v2.ts | 251 +- src/apis/drive/package.json | 4 +- src/apis/drive/v2.ts | 955 +- src/apis/drive/v3.ts | 763 +- src/apis/driveactivity/package.json | 4 +- src/apis/driveactivity/v2.ts | 144 +- src/apis/factchecktools/package.json | 4 +- src/apis/factchecktools/v1alpha1.ts | 184 +- src/apis/file/package.json | 4 +- src/apis/file/v1.ts | 350 +- src/apis/file/v1beta1.ts | 350 +- src/apis/firebasedynamiclinks/package.json | 4 +- src/apis/firebasedynamiclinks/v1.ts | 257 +- src/apis/firebasehosting/package.json | 4 +- src/apis/firebasehosting/v1beta1.ts | 277 +- src/apis/firebaserules/package.json | 4 +- src/apis/firebaserules/v1.ts | 287 +- src/apis/firestore/package.json | 4 +- src/apis/firestore/v1.ts | 824 +- src/apis/firestore/v1beta1.ts | 643 +- src/apis/firestore/v1beta2.ts | 337 +- src/apis/fitness/package.json | 4 +- src/apis/fitness/v1.ts | 442 +- src/apis/fusiontables/package.json | 4 +- src/apis/fusiontables/v1.ts | 186 +- src/apis/fusiontables/v2.ts | 259 +- src/apis/games/package.json | 4 +- src/apis/games/v1.ts | 1217 +- src/apis/gamesConfiguration/package.json | 4 +- .../gamesConfiguration/v1configuration.ts | 131 +- src/apis/gamesManagement/package.json | 4 +- src/apis/gamesManagement/v1management.ts | 224 +- src/apis/genomics/package.json | 4 +- src/apis/genomics/v1.ts | 248 +- src/apis/genomics/v1alpha2.ts | 635 +- src/apis/genomics/v2alpha1.ts | 436 +- src/apis/gmail/package.json | 4 +- src/apis/gmail/v1.ts | 866 +- src/apis/groupsmigration/package.json | 4 +- src/apis/groupsmigration/v1.ts | 26 +- src/apis/groupssettings/package.json | 4 +- src/apis/groupssettings/v1.ts | 158 +- src/apis/healthcare/index.ts | 13 +- src/apis/healthcare/package.json | 4 +- src/apis/healthcare/v1alpha.ts | 1763 -- src/apis/healthcare/v1alpha2.ts | 2855 +-- src/apis/healthcare/v1beta1.ts | 2580 +-- src/apis/iam/package.json | 4 +- src/apis/iam/v1.ts | 668 +- src/apis/iamcredentials/package.json | 4 +- src/apis/iamcredentials/v1.ts | 154 +- src/apis/iap/package.json | 4 +- src/apis/iap/v1.ts | 135 +- src/apis/iap/v1beta1.ts | 137 +- src/apis/identitytoolkit/package.json | 4 +- src/apis/identitytoolkit/v3.ts | 220 +- src/apis/index.ts | 3 + src/apis/indexing/package.json | 4 +- src/apis/indexing/v3.ts | 45 +- src/apis/jobs/package.json | 4 +- src/apis/jobs/v2.ts | 1344 +- src/apis/jobs/v3.ts | 1082 +- src/apis/jobs/v3p1beta1.ts | 1273 +- src/apis/kgsearch/package.json | 4 +- src/apis/kgsearch/v1.ts | 48 +- src/apis/language/package.json | 4 +- src/apis/language/v1.ts | 218 +- src/apis/language/v1beta1.ts | 194 +- src/apis/language/v1beta2.ts | 219 +- src/apis/libraryagent/package.json | 4 +- src/apis/libraryagent/v1.ts | 72 +- src/apis/licensing/package.json | 4 +- src/apis/licensing/v1.ts | 47 +- src/apis/logging/package.json | 4 +- src/apis/logging/v2.ts | 1721 +- src/apis/manufacturers/package.json | 4 +- src/apis/manufacturers/v1.ts | 246 +- src/apis/mirror/package.json | 4 +- src/apis/mirror/v1.ts | 326 +- src/apis/ml/package.json | 4 +- src/apis/ml/v1.ts | 1000 +- src/apis/monitoring/package.json | 4 +- src/apis/monitoring/v3.ts | 1972 +- src/apis/oauth2/package.json | 4 +- src/apis/oauth2/v1.ts | 41 +- src/apis/oauth2/v2.ts | 38 +- src/apis/oslogin/package.json | 4 +- src/apis/oslogin/v1.ts | 71 +- src/apis/oslogin/v1alpha.ts | 71 +- src/apis/oslogin/v1beta.ts | 71 +- src/apis/pagespeedonline/package.json | 4 +- src/apis/pagespeedonline/v1.ts | 55 +- src/apis/pagespeedonline/v2.ts | 59 +- src/apis/pagespeedonline/v4.ts | 62 +- src/apis/pagespeedonline/v5.ts | 54 +- src/apis/people/package.json | 4 +- src/apis/people/v1.ts | 500 +- src/apis/playcustomapp/package.json | 4 +- src/apis/playcustomapp/v1.ts | 26 +- src/apis/plus/package.json | 4 +- src/apis/plus/v1.ts | 249 +- src/apis/plusDomains/package.json | 4 +- src/apis/plusDomains/v1.ts | 291 +- src/apis/poly/package.json | 4 +- src/apis/poly/v1.ts | 243 +- src/apis/proximitybeacon/package.json | 4 +- src/apis/proximitybeacon/v1beta1.ts | 641 +- src/apis/pubsub/package.json | 4 +- src/apis/pubsub/v1.ts | 1143 +- src/apis/pubsub/v1beta1a.ts | 204 +- src/apis/pubsub/v1beta2.ts | 372 +- src/apis/redis/package.json | 4 +- src/apis/redis/v1.ts | 310 +- src/apis/redis/v1beta1.ts | 308 +- src/apis/remotebuildexecution/package.json | 4 +- src/apis/remotebuildexecution/v1.ts | 1073 +- src/apis/remotebuildexecution/v1alpha.ts | 1021 +- src/apis/remotebuildexecution/v2.ts | 1199 +- src/apis/replicapool/package.json | 4 +- src/apis/replicapool/v1beta1.ts | 234 +- src/apis/reseller/package.json | 4 +- src/apis/reseller/v1.ts | 366 +- src/apis/run/package.json | 4 +- src/apis/run/v1.ts | 42 +- src/apis/run/v1alpha1.ts | 3925 ++-- src/apis/runtimeconfig/package.json | 4 +- src/apis/runtimeconfig/v1.ts | 129 +- src/apis/runtimeconfig/v1beta1.ts | 530 +- src/apis/safebrowsing/package.json | 4 +- src/apis/safebrowsing/v4.ts | 178 +- src/apis/script/package.json | 4 +- src/apis/script/v1.ts | 386 +- src/apis/searchconsole/package.json | 4 +- src/apis/searchconsole/v1.ts | 34 +- src/apis/securitycenter/package.json | 4 +- src/apis/securitycenter/v1.ts | 823 +- src/apis/securitycenter/v1beta1.ts | 698 +- src/apis/servicebroker/package.json | 4 +- src/apis/servicebroker/v1.ts | 136 +- src/apis/servicebroker/v1alpha1.ts | 413 +- src/apis/servicebroker/v1beta1.ts | 513 +- .../serviceconsumermanagement/package.json | 4 +- src/apis/serviceconsumermanagement/v1.ts | 1500 +- src/apis/servicecontrol/package.json | 4 +- src/apis/servicecontrol/v1.ts | 779 +- src/apis/servicemanagement/package.json | 4 +- src/apis/servicemanagement/v1.ts | 1647 +- src/apis/servicenetworking/package.json | 4 +- src/apis/servicenetworking/v1.ts | 1380 +- src/apis/servicenetworking/v1beta.ts | 1344 +- src/apis/serviceusage/package.json | 4 +- src/apis/serviceusage/v1.ts | 1352 +- src/apis/serviceusage/v1beta1.ts | 1344 +- src/apis/sheets/package.json | 4 +- src/apis/sheets/v4.ts | 1761 +- src/apis/siteVerification/package.json | 4 +- src/apis/siteVerification/v1.ts | 46 +- src/apis/slides/package.json | 4 +- src/apis/slides/v1.ts | 1265 +- src/apis/sourcerepo/package.json | 4 +- src/apis/sourcerepo/v1.ts | 406 +- src/apis/spanner/package.json | 4 +- src/apis/spanner/v1.ts | 1459 +- src/apis/speech/package.json | 4 +- src/apis/speech/v1.ts | 346 +- src/apis/speech/v1p1beta1.ts | 414 +- src/apis/sqladmin/package.json | 4 +- src/apis/sqladmin/v1beta4.ts | 567 +- src/apis/storage/package.json | 4 +- src/apis/storage/v1.ts | 1959 +- src/apis/storage/v1beta1.ts | 151 +- src/apis/storage/v1beta2.ts | 396 +- src/apis/storagetransfer/package.json | 4 +- src/apis/storagetransfer/v1.ts | 583 +- src/apis/streetviewpublish/package.json | 4 +- src/apis/streetviewpublish/v1.ts | 359 +- src/apis/surveys/package.json | 4 +- src/apis/surveys/v2.ts | 153 +- src/apis/tagmanager/package.json | 4 +- src/apis/tagmanager/v1.ts | 264 +- src/apis/tagmanager/v2.ts | 630 +- src/apis/tasks/package.json | 4 +- src/apis/tasks/v1.ts | 108 +- src/apis/testing/package.json | 4 +- src/apis/testing/v1.ts | 455 +- src/apis/texttospeech/package.json | 4 +- src/apis/texttospeech/v1.ts | 115 +- src/apis/texttospeech/v1beta1.ts | 115 +- src/apis/toolresults/package.json | 4 +- src/apis/toolresults/v1beta3.ts | 899 +- src/apis/tpu/package.json | 4 +- src/apis/tpu/v1.ts | 184 +- src/apis/tpu/v1alpha1.ts | 184 +- src/apis/translate/package.json | 4 +- src/apis/translate/v2.ts | 101 +- src/apis/urlshortener/package.json | 4 +- src/apis/urlshortener/v1.ts | 67 +- src/apis/vault/package.json | 4 +- src/apis/vault/v1.ts | 285 +- src/apis/videointelligence/package.json | 4 +- src/apis/videointelligence/v1.ts | 980 +- src/apis/videointelligence/v1beta2.ts | 945 +- src/apis/videointelligence/v1p1beta1.ts | 945 +- src/apis/videointelligence/v1p2beta1.ts | 945 +- src/apis/videointelligence/v1p3beta1.ts | 945 +- src/apis/vision/package.json | 4 +- src/apis/vision/v1.ts | 3564 +-- src/apis/vision/v1p1beta1.ts | 3281 +-- src/apis/vision/v1p2beta1.ts | 3281 +-- src/apis/webfonts/package.json | 4 +- src/apis/webfonts/v1.ts | 39 +- src/apis/webmasters/package.json | 4 +- src/apis/webmasters/v3.ts | 663 +- src/apis/websecurityscanner/package.json | 4 +- src/apis/websecurityscanner/v1alpha.ts | 247 +- src/apis/websecurityscanner/v1beta.ts | 290 +- src/apis/youtube/package.json | 4 +- src/apis/youtube/v3.ts | 3508 +-- src/apis/youtubeAnalytics/package.json | 4 +- src/apis/youtubeAnalytics/v1.ts | 214 +- src/apis/youtubeAnalytics/v1beta1.ts | 214 +- src/apis/youtubeAnalytics/v2.ts | 306 +- src/apis/youtubereporting/package.json | 4 +- src/apis/youtubereporting/v1.ts | 133 +- src/generator/templates/api-endpoint.njk | 18 +- src/generator/templates/api-index.njk | 6 +- src/generator/templates/method-partial.njk | 2 +- src/generator/templates/package.json.njk | 8 +- src/index.ts | 2 +- 419 files changed, 60242 insertions(+), 158083 deletions(-) create mode 100644 src/apis/datafusion/README.md create mode 100644 src/apis/datafusion/index.ts create mode 100644 src/apis/datafusion/package.json create mode 100644 src/apis/datafusion/tsconfig.json create mode 100644 src/apis/datafusion/v1beta1.ts create mode 100644 src/apis/datafusion/webpack.config.js delete mode 100644 src/apis/healthcare/v1alpha.ts diff --git a/package.json b/package.json index c01b2a177fb..1e7e97eba30 100644 --- a/package.json +++ b/package.json @@ -8,8 +8,8 @@ }, "license": "Apache-2.0", "dependencies": { - "google-auth-library": "^3.0.0", - "googleapis-common": "^0.7.0" + "google-auth-library": "^4.0.0", + "googleapis-common": "^2.0.0" }, "files": [ "build/src", @@ -53,50 +53,50 @@ "node": ">=8.10.0" }, "devDependencies": { - "@compodoc/compodoc": "^1.1.7", + "@compodoc/compodoc": "^1.1.9", "@types/chai": "^4.1.7", "@types/execa": "^0.9.0", "@types/minimist": "^1.2.0", "@types/mkdirp": "^0.5.2", - "@types/mocha": "^5.2.0", + "@types/mocha": "^5.2.6", "@types/mv": "^2.1.0", "@types/ncp": "^2.0.1", - "@types/nock": "^10.0.0", - "@types/node": "^10.0.8", - "@types/nunjucks": "^3.0.0", - "@types/qs": "^6.5.1", + "@types/nock": "^10.0.2", + "@types/node": "^12.0.1", + "@types/nunjucks": "^3.1.1", + "@types/qs": "^6.5.3", "@types/rimraf": "^2.0.2", "@types/source-map-support": "^0.5.0", "@types/tmp": "^0.1.0", "@types/url-template": "^2.0.28", "assert-rejects": "^1.0.0", "chai": "^4.2.0", - "codecov": "^3.0.2", - "eslint": "^5.6.0", - "eslint-config-prettier": "^4.0.0", - "eslint-plugin-node": "^9.0.0", - "eslint-plugin-prettier": "^3.0.0", + "codecov": "^3.4.0", + "eslint": "^5.16.0", + "eslint-config-prettier": "^4.2.0", + "eslint-plugin-node": "^9.0.1", + "eslint-plugin-prettier": "^3.1.0", "execa": "^1.0.0", "gts": "^1.0.0", - "hard-rejection": "^2.0.0", + "hard-rejection": "^2.1.0", "intelli-espower-loader": "^1.0.1", "js-green-licenses": "^0.5.0", "minimist": "^1.2.0", "mkdirp": "^0.5.1", - "mocha": "^6.0.0", + "mocha": "^6.1.4", "mv": "^2.1.1", "ncp": "^2.0.0", - "nock": "^10.0.0", - "nunjucks": "^3.1.2", - "nyc": "^14.0.0", - "opn": "^5.3.0", + "nock": "^10.0.6", + "nunjucks": "^3.2.0", + "nyc": "^14.1.1", + "open": "^6.3.0", "p-queue": "^5.0.0", - "prettier": "^1.14.2", - "rimraf": "^2.6.2", + "prettier": "^1.17.1", + "rimraf": "^2.6.3", "server-destroy": "^1.0.1", - "source-map-support": "^0.5.5", + "source-map-support": "^0.5.12", "tmp": "^0.1.0", - "typescript": "~3.4.0", - "linkinator": "^1.1.2" + "typescript": "~3.4.5", + "linkinator": "^1.4.2" } } diff --git a/samples/drive/quickstart.js b/samples/drive/quickstart.js index db42a39a7f6..f3101d6e530 100644 --- a/samples/drive/quickstart.js +++ b/samples/drive/quickstart.js @@ -16,7 +16,7 @@ // [START main_body] const {google} = require('googleapis'); const express = require('express'); -const opn = require('opn'); +const opn = require('open'); const path = require('path'); const fs = require('fs'); diff --git a/samples/oauth2.js b/samples/oauth2.js index 1262b5f68af..9f66b67332c 100644 --- a/samples/oauth2.js +++ b/samples/oauth2.js @@ -17,7 +17,7 @@ const fs = require('fs'); const path = require('path'); const http = require('http'); const url = require('url'); -const opn = require('opn'); +const opn = require('open'); const destroyer = require('server-destroy'); const {google} = require('googleapis'); diff --git a/samples/package.json b/samples/package.json index 1922e8d5a3a..4ba7fe3c125 100644 --- a/samples/package.json +++ b/samples/package.json @@ -10,15 +10,14 @@ "test": "mocha ../build/test/samples" }, "dependencies": { - "axios": "^0.18.0", - "express": "^4.16.3", + "express": "^4.16.4", "googleapis": "^39.2.0", "nconf": "^0.10.0", - "opn": "^5.3.0", + "open": "^6.3.0", "server-destroy": "^1.0.1", - "uuid": "^3.2.1" + "uuid": "^3.3.2" }, "devDependencies": { - "mocha": "^6.0.0" + "mocha": "^6.1.4" } } diff --git a/samples/sampleclient.js b/samples/sampleclient.js index 86663260ba9..71407ab5e78 100644 --- a/samples/sampleclient.js +++ b/samples/sampleclient.js @@ -20,7 +20,7 @@ const {google} = require('googleapis'); const http = require('http'); const url = require('url'); -const opn = require('opn'); +const opn = require('open'); const destroyer = require('server-destroy'); const fs = require('fs'); const path = require('path'); diff --git a/samples/sheets/quickstart.js b/samples/sheets/quickstart.js index 600e62df153..2b7d4e9c7f0 100644 --- a/samples/sheets/quickstart.js +++ b/samples/sheets/quickstart.js @@ -16,7 +16,7 @@ // [START main_body] const {google} = require('googleapis'); const express = require('express'); -const opn = require('opn'); +const opn = require('open'); const path = require('path'); const fs = require('fs'); diff --git a/src/apis/abusiveexperiencereport/package.json b/src/apis/abusiveexperiencereport/package.json index 41c9f56dc87..f4ec61bc0db 100644 --- a/src/apis/abusiveexperiencereport/package.json +++ b/src/apis/abusiveexperiencereport/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^1.0.0", "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.4.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "typedoc": "^0.14.2", + "typescript": "~3.4.5", + "webpack": "^4.31.0", + "webpack-cli": "^3.3.2" } } diff --git a/src/apis/abusiveexperiencereport/v1.ts b/src/apis/abusiveexperiencereport/v1.ts index ea119208982..6157ab3a558 100644 --- a/src/apis/abusiveexperiencereport/v1.ts +++ b/src/apis/abusiveexperiencereport/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace abusiveexperiencereport_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace abusiveexperiencereport_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace abusiveexperiencereport_v1 { /** * Abusive Experience Report API * - * Views Abusive Experience Report data, and gets a list of sites that have a - * significant number of abusive experiences. + * Views Abusive Experience Report data, and gets a list of sites that have a significant number of abusive experiences. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace abusiveexperiencereport_v1 { violatingSites: Resource$Violatingsites; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.sites = new Resource$Sites(this.context); this.violatingSites = new Resource$Violatingsites(this.context); @@ -249,14 +247,7 @@ export namespace abusiveexperiencereport_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The required site name. This is the site property whose abusive - * experiences have been reviewed, and it must be URL-encoded. For example, - * sites/https%3A%2F%2Fwww.google.com. The server will return an error of - * BAD_REQUEST if this field is not filled in. Note that if the site - * property is not yet verified in Search Console, the reportUrl field - * returned by the API will lead to the verification page, prompting the - * user to go through that process before they can gain access to the - * Abusive Experience Report. + * The required site name. This is the site property whose abusive experiences have been reviewed, and it must be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Abusive Experience Report. */ name?: string; } diff --git a/src/apis/acceleratedmobilepageurl/package.json b/src/apis/acceleratedmobilepageurl/package.json index 3eceb67a368..e22018903fc 100644 --- a/src/apis/acceleratedmobilepageurl/package.json +++ b/src/apis/acceleratedmobilepageurl/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/acceleratedmobilepageurl/v1.ts b/src/apis/acceleratedmobilepageurl/v1.ts index 3bb259a85d3..a2bc56f5f11 100644 --- a/src/apis/acceleratedmobilepageurl/v1.ts +++ b/src/apis/acceleratedmobilepageurl/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace acceleratedmobilepageurl_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace acceleratedmobilepageurl_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace acceleratedmobilepageurl_v1 { /** * Accelerated Mobile Pages (AMP) URL API * - * Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given - * list of public URL(s). + * Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s). * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace acceleratedmobilepageurl_v1 { ampUrls: Resource$Ampurls; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.ampUrls = new Resource$Ampurls(this.context); } @@ -128,8 +126,7 @@ export namespace acceleratedmobilepageurl_v1 { */ ampUrl?: string; /** - * The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to - * the cached document in the Google AMP Cache. + * The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache. */ cdnAmpUrl?: string; /** @@ -163,9 +160,7 @@ export namespace acceleratedmobilepageurl_v1 { */ lookupStrategy?: string; /** - * List of URLs to look up for the paired AMP URLs. The URLs are - * case-sensitive. Up to 50 URLs per lookup (see [Usage - * Limits](/amp/cache/reference/limits)). + * List of URLs to look up for the paired AMP URLs. The URLs are case-sensitive. Up to 50 URLs per lookup (see [Usage Limits](/amp/cache/reference/limits)). */ urls?: string[]; } @@ -174,10 +169,7 @@ export namespace acceleratedmobilepageurl_v1 { */ export interface Schema$BatchGetAmpUrlsResponse { /** - * For each URL in BatchAmpUrlsRequest, the URL response. The response might - * not be in the same order as URLs in the batch request. If - * BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated only - * once. + * For each URL in BatchAmpUrlsRequest, the URL response. The response might not be in the same order as URLs in the batch request. If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated only once. */ ampUrls?: Schema$AmpUrl[]; /** @@ -194,8 +186,7 @@ export namespace acceleratedmobilepageurl_v1 { /** * acceleratedmobilepageurl.ampUrls.batchGet - * @desc Returns AMP URL(s) and equivalent [AMP Cache - * URL(s)](/amp/cache/overview#amp-cache-url-format). + * @desc Returns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format). * @alias acceleratedmobilepageurl.ampUrls.batchGet * @memberOf! () * diff --git a/src/apis/accessapproval/package.json b/src/apis/accessapproval/package.json index 5d25d04f36b..474d09c6bda 100644 --- a/src/apis/accessapproval/package.json +++ b/src/apis/accessapproval/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/accessapproval/v1beta1.ts b/src/apis/accessapproval/v1beta1.ts index 906ec1fad4a..0a10a413e9b 100644 --- a/src/apis/accessapproval/v1beta1.ts +++ b/src/apis/accessapproval/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace accessapproval_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace accessapproval_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace accessapproval_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.folders = new Resource$Folders(this.context); this.organizations = new Resource$Organizations(this.context); @@ -127,18 +126,11 @@ export namespace accessapproval_v1beta1 { */ export interface Schema$AccessApprovalSettings { /** - * The resource name of the settings. Format is one of: <ol> - * <li>"projects/{project_id}/accessApprovalSettings"</li> - * <li>"folders/{folder_id}/accessApprovalSettings"</li> - * <li>"organizations/{organization_id}/accessApprovalSettings"</li> - * <ol> + * The resource name of the settings. Format is one of: <ol> <li>"projects/{project_id}/accessApprovalSettings"</li> <li>"folders/{folder_id}/accessApprovalSettings"</li> <li>"organizations/{organization_id}/accessApprovalSettings"</li> <ol> */ name?: string; /** - * A list of email addresses to which notifications relating to approval - * requests should be sent. Notifications relating to a resource will be - * sent to all emails in the settings of ancestor resources of that - * resource. + * A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. */ notificationEmails?: string[]; } @@ -147,29 +139,11 @@ export namespace accessapproval_v1beta1 { */ export interface Schema$AccessLocations { /** - * The "home office" location of the principal. A two-letter - * country code (ISO 3166-1 alpha-2), such as "US", "DE" - * or "GB" or a region code. In some limited situations Google - * systems may refer refer to a region code instead of a country code. - * Possible Region Codes: <ol> <li>ASI: Asia</li> - * <li>EUR: Europe</li> <li>OCE: Oceania</li> - * <li>AFR: Africa</li> <li>NAM: North - * America</li> <li>SAM: South America</li> - * <li>ANT: Antarctica</li> <li>ANY: Any - * location</li> </ol> + * The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol> */ principalOfficeCountry?: string; /** - * Physical location of the principal at the time of the access. A - * two-letter country code (ISO 3166-1 alpha-2), such as "US", - * "DE" or "GB" or a region code. In some limited - * situations Google systems may refer refer to a region code instead of a - * country code. Possible Region Codes: <ol> <li>ASI: - * Asia</li> <li>EUR: Europe</li> <li>OCE: - * Oceania</li> <li>AFR: Africa</li> <li>NAM: - * North America</li> <li>SAM: South America</li> - * <li>ANT: Antarctica</li> <li>ANY: Any - * location</li> </ol> + * Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: <ol> <li>ASI: Asia</li> <li>EUR: Europe</li> <li>OCE: Oceania</li> <li>AFR: Africa</li> <li>NAM: North America</li> <li>SAM: South America</li> <li>ANT: Antarctica</li> <li>ANY: Any location</li> </ol> */ principalPhysicalLocationCountry?: string; } @@ -196,14 +170,11 @@ export namespace accessapproval_v1beta1 { */ dismiss?: Schema$DismissDecision; /** - * The resource name of the request. Format is - * "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}". + * The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}". */ name?: string; /** - * The requested expiration for the approval. If the request is approved, - * access will be granted from the time of approval until the expiration - * time. + * The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. */ requestedExpiration?: string; /** @@ -215,16 +186,13 @@ export namespace accessapproval_v1beta1 { */ requestedReason?: Schema$AccessReason; /** - * The resource for which approval is being requested. The format of the - * resource name is defined at - * https://cloud.google.com/apis/design/resource_names. The resource name - * here may either be a "full" resource name (e.g. - * "//library.googleapis.com/shelves/shelf1/books/book2") or a - * "relative" resource name (e.g. - * "shelves/shelf1/books/book2") as described in the resource name - * specification. + * The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. */ requestedResourceName?: string; + /** + * Properties related to the resource represented by requested_resource_name. + */ + requestedResourceProperties?: Schema$ResourceProperties; /** * The time at which approval was requested. */ @@ -274,11 +242,19 @@ export namespace accessapproval_v1beta1 { */ approvalRequests?: Schema$ApprovalRequest[]; /** - * Token to retrieve the next page of results, or empty if there are no - * more. + * Token to retrieve the next page of results, or empty if there are no more. */ nextPageToken?: string; } + /** + * The properties associated with the resource of the request. + */ + export interface Schema$ResourceProperties { + /** + * Whether an approval will exclude the descendants of the resource being requested. + */ + excludesDescendants?: boolean; + } export class Resource$Folders { context: APIRequestContext; @@ -292,8 +268,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.folders.getAccessApprovalSettings - * @desc Gets the settings associated with a project, folder, or - * organization. + * @desc Gets the settings associated with a project, folder, or organization. * @alias accessapproval.folders.getAccessApprovalSettings * @memberOf! () * @@ -369,8 +344,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.folders.updateAccessApprovalSettings - * @desc Updates the settings associated with a project, folder, or - * organization. Completely replaces the existing settings. + * @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings. * @alias accessapproval.folders.updateAccessApprovalSettings * @memberOf! () * @@ -466,10 +440,7 @@ export namespace accessapproval_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the settings. Format is one of:
    - *
  1. "projects/{project_id}/accessApprovalSettings"
    2. - *
  2. "folders/{folder_id}/accessApprovalSettings"
    3. - *
  3. "organizations/{organization_id}/accessApprovalSettings"
      4. + * The resource name of the settings. Format is one of:
      1. "projects/{project_id}/accessApprovalSettings"
      2. "folders/{folder_id}/accessApprovalSettings"
      3. "organizations/{organization_id}/accessApprovalSettings"
          4. */ name?: string; @@ -487,9 +458,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.folders.approvalRequests.approve - * @desc Approves a request and returns the updated ApprovalRequest. Returns - * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if - * the request exists but is not in a pending state. + * @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @alias accessapproval.folders.approvalRequests.approve * @memberOf! () * @@ -565,11 +534,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.folders.approvalRequests.dismiss - * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: - * This does not deny access to the resource if another request has been - * made and approved. It is equivalent in effect to ignoring the request - * altogether. Returns NOT_FOUND if the request does not exist. Returns - * FAILED_PRECONDITION if the request exists but is not in a pending state. + * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @alias accessapproval.folders.approvalRequests.dismiss * @memberOf! () * @@ -645,8 +610,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.folders.approvalRequests.get - * @desc Gets an approval request. Returns NOT_FOUND if the request does not - * exist. + * @desc Gets an approval request. Returns NOT_FOUND if the request does not exist. * @alias accessapproval.folders.approvalRequests.get * @memberOf! () * @@ -718,9 +682,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.folders.approvalRequests.list - * @desc Lists approval requests associated with a project, folder, or - * organization. Approval requests can be filtered by state (pending, - * active, dismissed). The order is reverse chronological. + * @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. * @alias accessapproval.folders.approvalRequests.list * @memberOf! () * @@ -860,12 +822,7 @@ export namespace accessapproval_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter on the type of approval requests to retrieve. Must be one of the - * following values:
          1. [not set]: Requests that are pending or have - * active approvals.
          2. ALL: All requests.
          3. PENDING: Only - * pending requests.
          4. ACTIVE: Only active (i.e. currently - * approved) requests.
          5. DISMISSED: Only dismissed (including - * expired) requests.
          + * A filter on the type of approval requests to retrieve. Must be one of the following values:
          1. [not set]: Requests that are pending or have active approvals.
          2. ALL: All requests.
          3. PENDING: Only pending requests.
          4. ACTIVE: Only active (i.e. currently approved) requests.
          5. DISMISSED: Only dismissed (including expired) requests.
          */ filter?: string; /** @@ -877,8 +834,7 @@ export namespace accessapproval_v1beta1 { */ pageToken?: string; /** - * The parent resource. This may be "projects/{project_id}", - * "folders/{folder_id}", or "organizations/{organization_id}". + * The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}". */ parent?: string; } @@ -895,8 +851,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.organizations.getAccessApprovalSettings - * @desc Gets the settings associated with a project, folder, or - * organization. + * @desc Gets the settings associated with a project, folder, or organization. * @alias accessapproval.organizations.getAccessApprovalSettings * @memberOf! () * @@ -972,8 +927,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.organizations.updateAccessApprovalSettings - * @desc Updates the settings associated with a project, folder, or - * organization. Completely replaces the existing settings. + * @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings. * @alias accessapproval.organizations.updateAccessApprovalSettings * @memberOf! () * @@ -1069,10 +1023,7 @@ export namespace accessapproval_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the settings. Format is one of:
            - *
          1. "projects/{project_id}/accessApprovalSettings"
            2. - *
          2. "folders/{folder_id}/accessApprovalSettings"
            3. - *
          3. "organizations/{organization_id}/accessApprovalSettings"
              4. + * The resource name of the settings. Format is one of:
              1. "projects/{project_id}/accessApprovalSettings"
              2. "folders/{folder_id}/accessApprovalSettings"
              3. "organizations/{organization_id}/accessApprovalSettings"
                  4. */ name?: string; @@ -1090,9 +1041,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.organizations.approvalRequests.approve - * @desc Approves a request and returns the updated ApprovalRequest. Returns - * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if - * the request exists but is not in a pending state. + * @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @alias accessapproval.organizations.approvalRequests.approve * @memberOf! () * @@ -1168,11 +1117,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.organizations.approvalRequests.dismiss - * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: - * This does not deny access to the resource if another request has been - * made and approved. It is equivalent in effect to ignoring the request - * altogether. Returns NOT_FOUND if the request does not exist. Returns - * FAILED_PRECONDITION if the request exists but is not in a pending state. + * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @alias accessapproval.organizations.approvalRequests.dismiss * @memberOf! () * @@ -1248,8 +1193,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.organizations.approvalRequests.get - * @desc Gets an approval request. Returns NOT_FOUND if the request does not - * exist. + * @desc Gets an approval request. Returns NOT_FOUND if the request does not exist. * @alias accessapproval.organizations.approvalRequests.get * @memberOf! () * @@ -1321,9 +1265,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.organizations.approvalRequests.list - * @desc Lists approval requests associated with a project, folder, or - * organization. Approval requests can be filtered by state (pending, - * active, dismissed). The order is reverse chronological. + * @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. * @alias accessapproval.organizations.approvalRequests.list * @memberOf! () * @@ -1463,12 +1405,7 @@ export namespace accessapproval_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter on the type of approval requests to retrieve. Must be one of the - * following values:
                  1. [not set]: Requests that are pending or have - * active approvals.
                  2. ALL: All requests.
                  3. PENDING: Only - * pending requests.
                  4. ACTIVE: Only active (i.e. currently - * approved) requests.
                  5. DISMISSED: Only dismissed (including - * expired) requests.
                  + * A filter on the type of approval requests to retrieve. Must be one of the following values:
                  1. [not set]: Requests that are pending or have active approvals.
                  2. ALL: All requests.
                  3. PENDING: Only pending requests.
                  4. ACTIVE: Only active (i.e. currently approved) requests.
                  5. DISMISSED: Only dismissed (including expired) requests.
                  */ filter?: string; /** @@ -1480,8 +1417,7 @@ export namespace accessapproval_v1beta1 { */ pageToken?: string; /** - * The parent resource. This may be "projects/{project_id}", - * "folders/{folder_id}", or "organizations/{organization_id}". + * The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}". */ parent?: string; } @@ -1498,8 +1434,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.projects.getAccessApprovalSettings - * @desc Gets the settings associated with a project, folder, or - * organization. + * @desc Gets the settings associated with a project, folder, or organization. * @alias accessapproval.projects.getAccessApprovalSettings * @memberOf! () * @@ -1575,8 +1510,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.projects.updateAccessApprovalSettings - * @desc Updates the settings associated with a project, folder, or - * organization. Completely replaces the existing settings. + * @desc Updates the settings associated with a project, folder, or organization. Completely replaces the existing settings. * @alias accessapproval.projects.updateAccessApprovalSettings * @memberOf! () * @@ -1672,10 +1606,7 @@ export namespace accessapproval_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the settings. Format is one of:
                    - *
                  1. "projects/{project_id}/accessApprovalSettings"
                    2. - *
                  2. "folders/{folder_id}/accessApprovalSettings"
                    3. - *
                  3. "organizations/{organization_id}/accessApprovalSettings"
                      4. + * The resource name of the settings. Format is one of:
                      1. "projects/{project_id}/accessApprovalSettings"
                      2. "folders/{folder_id}/accessApprovalSettings"
                      3. "organizations/{organization_id}/accessApprovalSettings"
                          4. */ name?: string; @@ -1693,9 +1624,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.projects.approvalRequests.approve - * @desc Approves a request and returns the updated ApprovalRequest. Returns - * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if - * the request exists but is not in a pending state. + * @desc Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @alias accessapproval.projects.approvalRequests.approve * @memberOf! () * @@ -1771,11 +1700,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.projects.approvalRequests.dismiss - * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: - * This does not deny access to the resource if another request has been - * made and approved. It is equivalent in effect to ignoring the request - * altogether. Returns NOT_FOUND if the request does not exist. Returns - * FAILED_PRECONDITION if the request exists but is not in a pending state. + * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * @alias accessapproval.projects.approvalRequests.dismiss * @memberOf! () * @@ -1851,8 +1776,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.projects.approvalRequests.get - * @desc Gets an approval request. Returns NOT_FOUND if the request does not - * exist. + * @desc Gets an approval request. Returns NOT_FOUND if the request does not exist. * @alias accessapproval.projects.approvalRequests.get * @memberOf! () * @@ -1924,9 +1848,7 @@ export namespace accessapproval_v1beta1 { /** * accessapproval.projects.approvalRequests.list - * @desc Lists approval requests associated with a project, folder, or - * organization. Approval requests can be filtered by state (pending, - * active, dismissed). The order is reverse chronological. + * @desc Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. * @alias accessapproval.projects.approvalRequests.list * @memberOf! () * @@ -2066,12 +1988,7 @@ export namespace accessapproval_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter on the type of approval requests to retrieve. Must be one of the - * following values:
                          1. [not set]: Requests that are pending or have - * active approvals.
                          2. ALL: All requests.
                          3. PENDING: Only - * pending requests.
                          4. ACTIVE: Only active (i.e. currently - * approved) requests.
                          5. DISMISSED: Only dismissed (including - * expired) requests.
                          + * A filter on the type of approval requests to retrieve. Must be one of the following values:
                          1. [not set]: Requests that are pending or have active approvals.
                          2. ALL: All requests.
                          3. PENDING: Only pending requests.
                          4. ACTIVE: Only active (i.e. currently approved) requests.
                          5. DISMISSED: Only dismissed (including expired) requests.
                          */ filter?: string; /** @@ -2083,8 +2000,7 @@ export namespace accessapproval_v1beta1 { */ pageToken?: string; /** - * The parent resource. This may be "projects/{project_id}", - * "folders/{folder_id}", or "organizations/{organization_id}". + * The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}". */ parent?: string; } diff --git a/src/apis/accesscontextmanager/package.json b/src/apis/accesscontextmanager/package.json index 97827af0bb2..548a74bacbc 100644 --- a/src/apis/accesscontextmanager/package.json +++ b/src/apis/accesscontextmanager/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 6ea7b2580cd..4d75e71d0a8 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace accesscontextmanager_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace accesscontextmanager_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace accesscontextmanager_v1 { /** * Access Context Manager API * - * An API for setting attribute based access control to requests to GCP - * services. + * An API for setting attribute based access control to requests to GCP services. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace accesscontextmanager_v1 { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accessPolicies = new Resource$Accesspolicies(this.context); this.operations = new Resource$Operations(this.context); @@ -122,9 +120,7 @@ export namespace accesscontextmanager_v1 { } /** - * An `AccessLevel` is a label that can be applied to requests to GCP - * services, along with a list of requirements necessary for the label to be - * applied. + * An `AccessLevel` is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied. */ export interface Schema$AccessLevel { /** @@ -140,9 +136,7 @@ export namespace accesscontextmanager_v1 { */ description?: string; /** - * Required. Resource name for the Access Level. The `short_name` component - * must begin with a letter and only include alphanumeric and '_'. - * Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` + * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` */ name?: string; /** @@ -155,11 +149,7 @@ export namespace accesscontextmanager_v1 { updateTime?: string; } /** - * `AccessPolicy` is a container for `AccessLevels` (which define the - * necessary attributes to use GCP services) and `ServicePerimeters` (which - * define regions of services able to freely pass data within a perimeter). An - * access policy is globally visible within an organization, and the - * restrictions it specifies apply to all projects within an organization. + * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. */ export interface Schema$AccessPolicy { /** @@ -167,14 +157,11 @@ export namespace accesscontextmanager_v1 { */ createTime?: string; /** - * Output only. Resource name of the `AccessPolicy`. Format: - * `accessPolicies/{policy_id}` + * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` */ name?: string; /** - * Required. The parent of this `AccessPolicy` in the Cloud Resource - * Hierarchy. Currently immutable once created. Format: - * `organizations/{organization_id}` + * Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` */ parent?: string; /** @@ -191,11 +178,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$BasicLevel { /** - * How the `conditions` list should be combined to determine if a request is - * granted this `AccessLevel`. If AND is used, each `Condition` in - * `conditions` must be satisfied for the `AccessLevel` to be applied. If OR - * is used, at least one `Condition` in `conditions` must be satisfied for - * the `AccessLevel` to be applied. Default behavior is AND. + * How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND. */ combiningFunction?: string; /** @@ -208,72 +191,40 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A condition necessary for an `AccessLevel` to be granted. The Condition is - * an AND over its fields. So a Condition is true if: 1) the request IP is - * from one of the listed subnetworks AND 2) the originating device complies - * with the listed device policy AND 3) all listed access levels are granted - * AND 4) the request was sent at a time allowed by the DateTimeRestriction. + * A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction. */ export interface Schema$Condition { /** - * Device specific restrictions, all restrictions must hold for the - * Condition to be true. If not specified, all devices are allowed. + * Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed. */ devicePolicy?: Schema$DevicePolicy; /** - * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that - * for a CIDR IP address block, the specified IP address portion must be - * properly truncated (i.e. all the host bits must be zero) or the input is - * considered malformed. For example, "192.0.2.0/24" is accepted - * but "192.0.2.1/24" is not. Similarly, for IPv6, - * "2001:db8::/32" is accepted whereas "2001:db8::1/32" - * is not. The originating IP of a request must be in one of the listed - * subnets in order for this Condition to be true. If empty, all IP - * addresses are allowed. + * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed. */ ipSubnetworks?: string[]; /** - * The request must be made by one of the provided user or service accounts. - * Groups are not supported. Syntax: `user:{emailid}` - * `serviceAccount:{emailid}` If not specified, a request may come from any - * user. + * The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user. */ members?: string[]; /** - * Whether to negate the Condition. If true, the Condition becomes a NAND - * over its non-empty fields, each field must be false for the Condition - * overall to be satisfied. Defaults to false. + * Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false. */ negate?: boolean; /** - * The request must originate from one of the provided countries/regions. - * Must be valid ISO 3166-1 alpha-2 codes. + * The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. */ regions?: string[]; /** - * A list of other access levels defined in the same `Policy`, referenced by - * resource name. Referencing an `AccessLevel` which does not exist is an - * error. All access levels listed must be granted for the Condition to be - * true. Example: - * "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` + * A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` */ requiredAccessLevels?: string[]; } /** - * `DevicePolicy` specifies device specific restrictions necessary to acquire - * a given access level. A `DevicePolicy` specifies requirements for requests - * from devices to be granted access levels, it does not do any enforcement on - * the device. `DevicePolicy` acts as an AND over all specified fields, and - * each repeated field is an OR over its elements. Any unset fields are - * ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type - * : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will - * be true for requests originating from encrypted Linux desktops and - * encrypted Windows desktops. + * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. */ export interface Schema$DevicePolicy { /** - * Allowed device management levels, an empty list allows all management - * levels. + * Allowed device management levels, an empty list allows all management levels. */ allowedDeviceManagementLevels?: string[]; /** @@ -293,17 +244,12 @@ export namespace accesscontextmanager_v1 { */ requireCorpOwned?: boolean; /** - * Whether or not screenlock is required for the DevicePolicy to be true. - * Defaults to `false`. + * Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. */ requireScreenlock?: boolean; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -315,8 +261,7 @@ export namespace accesscontextmanager_v1 { */ accessLevels?: Schema$AccessLevel[]; /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; } @@ -329,8 +274,7 @@ export namespace accesscontextmanager_v1 { */ accessPolicies?: Schema$AccessPolicy[]; /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; } @@ -352,8 +296,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$ListServicePerimetersResponse { /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; /** @@ -362,14 +305,11 @@ export namespace accesscontextmanager_v1 { servicePerimeters?: Schema$ServicePerimeter[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -377,26 +317,15 @@ export namespace accesscontextmanager_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -405,9 +334,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$OsConstraint { /** - * The minimum allowed OS version. If not set, any version of this OS - * satisfies the constraint. Format: `"major.minor.patch"`. - * Examples: `"10.5.301"`, `"9.2.1"`. + * The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. */ minimumVersion?: string; /** @@ -415,24 +342,12 @@ export namespace accesscontextmanager_v1 { */ osType?: string; /** - * Only allows requests from devices with a verified Chrome OS. - * Verifications includes requirements that the device is - * enterprise-managed, conformant to Dasher domain policies, and the caller - * has permission to call the API targeted by the request. + * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. */ requireVerifiedChromeOs?: boolean; } /** - * `ServicePerimeter` describes a set of GCP resources which can freely import - * and export data amongst themselves, but not export outside of the - * `ServicePerimeter`. If a request with a source within this - * `ServicePerimeter` has a target outside of the `ServicePerimeter`, the - * request will be blocked. Otherwise the request is allowed. There are two - * types of Service Perimeter - Regular and Bridge. Regular Service Perimeters - * cannot overlap, a single GCP project can only belong to a single regular - * Service Perimeter. Service Perimeter Bridges can contain only GCP projects - * as members, a single GCP project may belong to multiple Service Perimeter - * Bridges. + * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. */ export interface Schema$ServicePerimeter { /** @@ -440,29 +355,19 @@ export namespace accesscontextmanager_v1 { */ createTime?: string; /** - * Description of the `ServicePerimeter` and its use. Does not affect - * behavior. + * Description of the `ServicePerimeter` and its use. Does not affect behavior. */ description?: string; /** - * Required. Resource name for the ServicePerimeter. The `short_name` - * component must begin with a letter and only include alphanumeric and - * '_'. Format: - * `accessPolicies/{policy_id}/servicePerimeters/{short_name}` + * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` */ name?: string; /** - * Perimeter type indicator. A single project is allowed to be a member of - * single regular perimeter, but multiple service perimeter bridges. A - * project cannot be a included in a perimeter bridge without being included - * in regular perimeter. For perimeter bridges, the restricted service list - * as well as access level lists must be empty. + * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. */ perimeterType?: string; /** - * Current ServicePerimeter configuration. Specifies sets of resources, - * restricted services and access levels that determine perimeter content - * and boundaries. + * Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. */ status?: Schema$ServicePerimeterConfig; /** @@ -475,69 +380,24 @@ export namespace accesscontextmanager_v1 { updateTime?: string; } /** - * `ServicePerimeterConfig` specifies a set of GCP resources that describe - * specific Service Perimeter configuration. + * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. */ export interface Schema$ServicePerimeterConfig { /** - * A list of `AccessLevel` resource names that allow resources within the - * `ServicePerimeter` to be accessed from the internet. `AccessLevels` - * listed must be in the same policy as this `ServicePerimeter`. Referencing - * a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names - * are listed, resources within the perimeter can only be accessed via GCP - * calls with request origins within the perimeter. Example: - * `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service - * Perimeter Bridge, must be empty. + * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ accessLevels?: string[]; /** - * A list of GCP resources that are inside of the service perimeter. - * Currently only projects are allowed. Format: `projects/{project_number}` + * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ resources?: string[]; /** - * GCP services that are subject to the Service Perimeter restrictions. For - * example, if `storage.googleapis.com` is specified, access to the storage - * buckets inside the perimeter must meet the perimeter's access - * restrictions. + * GCP services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ restrictedServices?: string[]; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -545,14 +405,11 @@ export namespace accesscontextmanager_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -573,11 +430,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.create - * @desc Create an `AccessPolicy`. Fails if this organization already has a - * `AccessPolicy`. The longrunning Operation will have a successful status - * once the `AccessPolicy` has propagated to long-lasting storage. Syntactic - * and basic semantic errors will be returned in `metadata` as a BadRequest - * proto. + * @desc Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto. * @alias accesscontextmanager.accessPolicies.create * @memberOf! () * @@ -649,9 +502,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.delete - * @desc Delete an AccessPolicy by resource name. The longrunning Operation - * will have a successful status once the AccessPolicy has been removed from - * long-lasting storage. + * @desc Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage. * @alias accesscontextmanager.accessPolicies.delete * @memberOf! () * @@ -876,10 +727,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.patch - * @desc Update an AccessPolicy. The longrunning Operation from this RPC - * will have a successful status once the changes to the AccessPolicy have - * propagated to long-lasting storage. Syntactic and basic semantic errors - * will be returned in `metadata` as a BadRequest proto. + * @desc Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto. * @alias accesscontextmanager.accessPolicies.patch * @memberOf! () * @@ -972,8 +820,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy to delete. Format - * `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}` */ name?: string; } @@ -985,8 +832,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy to get. Format - * `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}` */ name?: string; } @@ -1002,13 +848,11 @@ export namespace accesscontextmanager_v1 { */ pageSize?: number; /** - * Next page token for the next batch of AccessPolicy instances. Defaults to - * the first page of results. + * Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results. */ pageToken?: string; /** - * Required. Resource name for the container to list AccessPolicy instances - * from. Format: `organizations/{org_id}` + * Required. Resource name for the container to list AccessPolicy instances from. Format: `organizations/{org_id}` */ parent?: string; } @@ -1020,8 +864,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the `AccessPolicy`. Format: - * `accessPolicies/{policy_id}` + * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` */ name?: string; /** @@ -1043,10 +886,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.accessLevels.create - * @desc Create an Access Level. The longrunning operation from this RPC - * will have a successful status once the Access Level has propagated to - * long-lasting storage. Access Levels containing errors will result in an - * error response for the first error encountered. + * @desc Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.accessLevels.create * @memberOf! () * @@ -1122,9 +962,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.accessLevels.delete - * @desc Delete an Access Level by resource name. The longrunning operation - * from this RPC will have a successful status once the Access Level has - * been removed from long-lasting storage. + * @desc Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage. * @alias accesscontextmanager.accessPolicies.accessLevels.delete * @memberOf! () * @@ -1349,10 +1187,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.accessLevels.patch - * @desc Update an Access Level. The longrunning operation from this RPC - * will have a successful status once the changes to the Access Level have - * propagated to long-lasting storage. Access Levels containing errors will - * result in an error response for the first error encountered. + * @desc Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.accessLevels.patch * @memberOf! () * @@ -1433,8 +1268,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy which owns this Access - * Level. Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}` */ parent?: string; @@ -1451,8 +1285,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Access Level. Format: - * `accessPolicies/{policy_id}/accessLevels/{access_level_id}` + * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` */ name?: string; } @@ -1464,17 +1297,11 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to return `BasicLevels` in the Cloud Common Expression Language - * rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels - * are returned as `BasicLevels` or `CustomLevels` based on how they were - * created. If set to CEL, all Access Levels are returned as `CustomLevels`. - * In the CEL case, `BasicLevels` are translated to equivalent - * `CustomLevels`. + * Whether to return `BasicLevels` in the Cloud Common Expression Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are returned as `BasicLevels` or `CustomLevels` based on how they were created. If set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent `CustomLevels`. */ accessLevelFormat?: string; /** - * Required. Resource name for the Access Level. Format: - * `accessPolicies/{policy_id}/accessLevels/{access_level_id}` + * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` */ name?: string; } @@ -1486,9 +1313,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to return `BasicLevels` in the Cloud Common Expression language, - * as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning - * `AccessLevels` in the format they were defined. + * Whether to return `BasicLevels` in the Cloud Common Expression language, as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning `AccessLevels` in the format they were defined. */ accessLevelFormat?: string; /** @@ -1496,13 +1321,11 @@ export namespace accesscontextmanager_v1 { */ pageSize?: number; /** - * Next page token for the next batch of Access Level instances. Defaults to - * the first page of results. + * Next page token for the next batch of Access Level instances. Defaults to the first page of results. */ pageToken?: string; /** - * Required. Resource name for the access policy to list Access Levels from. - * Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}` */ parent?: string; } @@ -1514,9 +1337,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Access Level. The `short_name` component - * must begin with a letter and only include alphanumeric and '_'. Format: - * `accessPolicies/{policy_id}/accessLevels/{short_name}` + * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` */ name?: string; /** @@ -1538,10 +1359,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.servicePerimeters.create - * @desc Create an Service Perimeter. The longrunning operation from this - * RPC will have a successful status once the Service Perimeter has - * propagated to long-lasting storage. Service Perimeters containing errors - * will result in an error response for the first error encountered. + * @desc Create an Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.servicePerimeters.create * @memberOf! () * @@ -1617,9 +1435,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.servicePerimeters.delete - * @desc Delete an Service Perimeter by resource name. The longrunning - * operation from this RPC will have a successful status once the Service - * Perimeter has been removed from long-lasting storage. + * @desc Delete an Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage. * @alias accesscontextmanager.accessPolicies.servicePerimeters.delete * @memberOf! () * @@ -1849,11 +1665,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.accessPolicies.servicePerimeters.patch - * @desc Update an Service Perimeter. The longrunning operation from this - * RPC will have a successful status once the changes to the Service - * Perimeter have propagated to long-lasting storage. Service Perimeter - * containing errors will result in an error response for the first error - * encountered. + * @desc Update an Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.servicePerimeters.patch * @memberOf! () * @@ -1934,8 +1746,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy which owns this Service - * Perimeter. Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy which owns this Service Perimeter. Format: `accessPolicies/{policy_id}` */ parent?: string; @@ -1952,8 +1763,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Service Perimeter. Format: - * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` + * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` */ name?: string; } @@ -1965,8 +1775,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Service Perimeter. Format: - * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` + * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` */ name?: string; } @@ -1982,13 +1791,11 @@ export namespace accesscontextmanager_v1 { */ pageSize?: number; /** - * Next page token for the next batch of Service Perimeter instances. - * Defaults to the first page of results. + * Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results. */ pageToken?: string; /** - * Required. Resource name for the access policy to list Service Perimeters - * from. Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to list Service Perimeters from. Format: `accessPolicies/{policy_id}` */ parent?: string; } @@ -2000,9 +1807,7 @@ export namespace accesscontextmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the ServicePerimeter. The `short_name` - * component must begin with a letter and only include alphanumeric and '_'. - * Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` + * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` */ name?: string; /** @@ -2024,15 +1829,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias accesscontextmanager.operations.cancel * @memberOf! () * @@ -2103,10 +1900,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias accesscontextmanager.operations.delete * @memberOf! () * @@ -2176,9 +1970,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias accesscontextmanager.operations.get * @memberOf! () * @@ -2249,15 +2041,7 @@ export namespace accesscontextmanager_v1 { /** * accesscontextmanager.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias accesscontextmanager.operations.list * @memberOf! () * diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index 495f898d74d..73b3cb041dd 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace accesscontextmanager_v1beta { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace accesscontextmanager_v1beta { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace accesscontextmanager_v1beta { /** * Access Context Manager API * - * An API for setting attribute based access control to requests to GCP - * services. + * An API for setting attribute based access control to requests to GCP services. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace accesscontextmanager_v1beta { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accessPolicies = new Resource$Accesspolicies(this.context); this.operations = new Resource$Operations(this.context); @@ -122,9 +120,7 @@ export namespace accesscontextmanager_v1beta { } /** - * An `AccessLevel` is a label that can be applied to requests to GCP - * services, along with a list of requirements necessary for the label to be - * applied. + * An `AccessLevel` is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied. */ export interface Schema$AccessLevel { /** @@ -140,9 +136,7 @@ export namespace accesscontextmanager_v1beta { */ description?: string; /** - * Required. Resource name for the Access Level. The `short_name` component - * must begin with a letter and only include alphanumeric and '_'. - * Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` + * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` */ name?: string; /** @@ -155,11 +149,7 @@ export namespace accesscontextmanager_v1beta { updateTime?: string; } /** - * `AccessPolicy` is a container for `AccessLevels` (which define the - * necessary attributes to use GCP services) and `ServicePerimeters` (which - * define regions of services able to freely pass data within a perimeter). An - * access policy is globally visible within an organization, and the - * restrictions it specifies apply to all projects within an organization. + * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. */ export interface Schema$AccessPolicy { /** @@ -167,14 +157,11 @@ export namespace accesscontextmanager_v1beta { */ createTime?: string; /** - * Output only. Resource name of the `AccessPolicy`. Format: - * `accessPolicies/{policy_id}` + * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` */ name?: string; /** - * Required. The parent of this `AccessPolicy` in the Cloud Resource - * Hierarchy. Currently immutable once created. Format: - * `organizations/{organization_id}` + * Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` */ parent?: string; /** @@ -191,11 +178,7 @@ export namespace accesscontextmanager_v1beta { */ export interface Schema$BasicLevel { /** - * How the `conditions` list should be combined to determine if a request is - * granted this `AccessLevel`. If AND is used, each `Condition` in - * `conditions` must be satisfied for the `AccessLevel` to be applied. If OR - * is used, at least one `Condition` in `conditions` must be satisfied for - * the `AccessLevel` to be applied. Default behavior is AND. + * How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND. */ combiningFunction?: string; /** @@ -204,72 +187,40 @@ export namespace accesscontextmanager_v1beta { conditions?: Schema$Condition[]; } /** - * A condition necessary for an `AccessLevel` to be granted. The Condition is - * an AND over its fields. So a Condition is true if: 1) the request IP is - * from one of the listed subnetworks AND 2) the originating device complies - * with the listed device policy AND 3) all listed access levels are granted - * AND 4) the request was sent at a time allowed by the DateTimeRestriction. + * A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction. */ export interface Schema$Condition { /** - * Device specific restrictions, all restrictions must hold for the - * Condition to be true. If not specified, all devices are allowed. + * Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed. */ devicePolicy?: Schema$DevicePolicy; /** - * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that - * for a CIDR IP address block, the specified IP address portion must be - * properly truncated (i.e. all the host bits must be zero) or the input is - * considered malformed. For example, "192.0.2.0/24" is accepted - * but "192.0.2.1/24" is not. Similarly, for IPv6, - * "2001:db8::/32" is accepted whereas "2001:db8::1/32" - * is not. The originating IP of a request must be in one of the listed - * subnets in order for this Condition to be true. If empty, all IP - * addresses are allowed. + * CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed. */ ipSubnetworks?: string[]; /** - * The request must be made by one of the provided user or service accounts. - * Groups are not supported. Syntax: `user:{emailid}` - * `serviceAccount:{emailid}` If not specified, a request may come from any - * user. + * The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user. */ members?: string[]; /** - * Whether to negate the Condition. If true, the Condition becomes a NAND - * over its non-empty fields, each field must be false for the Condition - * overall to be satisfied. Defaults to false. + * Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false. */ negate?: boolean; /** - * The request must originate from one of the provided countries/regions. - * Must be valid ISO 3166-1 alpha-2 codes. + * The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. */ regions?: string[]; /** - * A list of other access levels defined in the same `Policy`, referenced by - * resource name. Referencing an `AccessLevel` which does not exist is an - * error. All access levels listed must be granted for the Condition to be - * true. Example: - * "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` + * A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` */ requiredAccessLevels?: string[]; } /** - * `DevicePolicy` specifies device specific restrictions necessary to acquire - * a given access level. A `DevicePolicy` specifies requirements for requests - * from devices to be granted access levels, it does not do any enforcement on - * the device. `DevicePolicy` acts as an AND over all specified fields, and - * each repeated field is an OR over its elements. Any unset fields are - * ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type - * : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will - * be true for requests originating from encrypted Linux desktops and - * encrypted Windows desktops. + * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. */ export interface Schema$DevicePolicy { /** - * Allowed device management levels, an empty list allows all management - * levels. + * Allowed device management levels, an empty list allows all management levels. */ allowedDeviceManagementLevels?: string[]; /** @@ -289,8 +240,7 @@ export namespace accesscontextmanager_v1beta { */ requireCorpOwned?: boolean; /** - * Whether or not screenlock is required for the DevicePolicy to be true. - * Defaults to `false`. + * Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. */ requireScreenlock?: boolean; } @@ -303,8 +253,7 @@ export namespace accesscontextmanager_v1beta { */ accessLevels?: Schema$AccessLevel[]; /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; } @@ -317,8 +266,7 @@ export namespace accesscontextmanager_v1beta { */ accessPolicies?: Schema$AccessPolicy[]; /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; } @@ -327,8 +275,7 @@ export namespace accesscontextmanager_v1beta { */ export interface Schema$ListServicePerimetersResponse { /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; /** @@ -337,14 +284,11 @@ export namespace accesscontextmanager_v1beta { servicePerimeters?: Schema$ServicePerimeter[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -352,26 +296,15 @@ export namespace accesscontextmanager_v1beta { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -380,9 +313,7 @@ export namespace accesscontextmanager_v1beta { */ export interface Schema$OsConstraint { /** - * The minimum allowed OS version. If not set, any version of this OS - * satisfies the constraint. Format: `"major.minor.patch"`. - * Examples: `"10.5.301"`, `"9.2.1"`. + * The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. */ minimumVersion?: string; /** @@ -390,24 +321,12 @@ export namespace accesscontextmanager_v1beta { */ osType?: string; /** - * Only allows requests from devices with a verified Chrome OS. - * Verifications includes requirements that the device is - * enterprise-managed, conformant to Dasher domain policies, and the caller - * has permission to call the API targeted by the request. + * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. */ requireVerifiedChromeOs?: boolean; } /** - * `ServicePerimeter` describes a set of GCP resources which can freely import - * and export data amongst themselves, but not export outside of the - * `ServicePerimeter`. If a request with a source within this - * `ServicePerimeter` has a target outside of the `ServicePerimeter`, the - * request will be blocked. Otherwise the request is allowed. There are two - * types of Service Perimeter - Regular and Bridge. Regular Service Perimeters - * cannot overlap, a single GCP project can only belong to a single regular - * Service Perimeter. Service Perimeter Bridges can contain only GCP projects - * as members, a single GCP project may belong to multiple Service Perimeter - * Bridges. + * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. */ export interface Schema$ServicePerimeter { /** @@ -415,29 +334,19 @@ export namespace accesscontextmanager_v1beta { */ createTime?: string; /** - * Description of the `ServicePerimeter` and its use. Does not affect - * behavior. + * Description of the `ServicePerimeter` and its use. Does not affect behavior. */ description?: string; /** - * Required. Resource name for the ServicePerimeter. The `short_name` - * component must begin with a letter and only include alphanumeric and - * '_'. Format: - * `accessPolicies/{policy_id}/servicePerimeters/{short_name}` + * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` */ name?: string; /** - * Perimeter type indicator. A single project is allowed to be a member of - * single regular perimeter, but multiple service perimeter bridges. A - * project cannot be a included in a perimeter bridge without being included - * in regular perimeter. For perimeter bridges, restricted/unrestricted - * service lists as well as access lists must be empty. + * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty. */ perimeterType?: string; /** - * Current ServicePerimeter configuration. Specifies sets of resources, - * restricted/unrestricted services and access levels that determine - * perimeter content and boundaries. + * Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries. */ status?: Schema$ServicePerimeterConfig; /** @@ -450,76 +359,28 @@ export namespace accesscontextmanager_v1beta { updateTime?: string; } /** - * `ServicePerimeterConfig` specifies a set of GCP resources that describe - * specific Service Perimeter configuration. + * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. */ export interface Schema$ServicePerimeterConfig { /** - * A list of `AccessLevel` resource names that allow resources within the - * `ServicePerimeter` to be accessed from the internet. `AccessLevels` - * listed must be in the same policy as this `ServicePerimeter`. Referencing - * a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names - * are listed, resources within the perimeter can only be accessed via GCP - * calls with request origins within the perimeter. Example: - * `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service - * Perimeter Bridge, must be empty. + * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ accessLevels?: string[]; /** - * A list of GCP resources that are inside of the service perimeter. - * Currently only projects are allowed. Format: `projects/{project_number}` + * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ resources?: string[]; /** - * GCP services that are subject to the Service Perimeter restrictions. Must - * contain a list of services. For example, if `storage.googleapis.com` is - * specified, access to the storage buckets inside the perimeter must meet - * the perimeter's access restrictions. + * GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ restrictedServices?: string[]; /** - * GCP services that are not subject to the Service Perimeter restrictions. - * Deprecated. Must be set to a single wildcard "*". The wildcard - * means that unless explicitly specified by "restricted_services" - * list, any service is treated as unrestricted. + * GCP services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted. */ unrestrictedServices?: string[]; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -527,14 +388,11 @@ export namespace accesscontextmanager_v1beta { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -555,11 +413,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.create - * @desc Create an `AccessPolicy`. Fails if this organization already has a - * `AccessPolicy`. The longrunning Operation will have a successful status - * once the `AccessPolicy` has propagated to long-lasting storage. Syntactic - * and basic semantic errors will be returned in `metadata` as a BadRequest - * proto. + * @desc Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto. * @alias accesscontextmanager.accessPolicies.create * @memberOf! () * @@ -634,9 +488,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.delete - * @desc Delete an AccessPolicy by resource name. The longrunning Operation - * will have a successful status once the AccessPolicy has been removed from - * long-lasting storage. + * @desc Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage. * @alias accesscontextmanager.accessPolicies.delete * @memberOf! () * @@ -864,10 +716,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.patch - * @desc Update an AccessPolicy. The longrunning Operation from this RPC - * will have a successful status once the changes to the AccessPolicy have - * propagated to long-lasting storage. Syntactic and basic semantic errors - * will be returned in `metadata` as a BadRequest proto. + * @desc Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto. * @alias accesscontextmanager.accessPolicies.patch * @memberOf! () * @@ -960,8 +809,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy to delete. Format - * `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}` */ name?: string; } @@ -973,8 +821,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy to get. Format - * `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}` */ name?: string; } @@ -990,13 +837,11 @@ export namespace accesscontextmanager_v1beta { */ pageSize?: number; /** - * Next page token for the next batch of AccessPolicy instances. Defaults to - * the first page of results. + * Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results. */ pageToken?: string; /** - * Required. Resource name for the container to list AccessPolicy instances - * from. Format: `organizations/{org_id}` + * Required. Resource name for the container to list AccessPolicy instances from. Format: `organizations/{org_id}` */ parent?: string; } @@ -1008,8 +853,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the `AccessPolicy`. Format: - * `accessPolicies/{policy_id}` + * Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` */ name?: string; /** @@ -1031,10 +875,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.accessLevels.create - * @desc Create an Access Level. The longrunning operation from this RPC - * will have a successful status once the Access Level has propagated to - * long-lasting storage. Access Levels containing errors will result in an - * error response for the first error encountered. + * @desc Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.accessLevels.create * @memberOf! () * @@ -1110,9 +951,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.accessLevels.delete - * @desc Delete an Access Level by resource name. The longrunning operation - * from this RPC will have a successful status once the Access Level has - * been removed from long-lasting storage. + * @desc Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage. * @alias accesscontextmanager.accessPolicies.accessLevels.delete * @memberOf! () * @@ -1337,10 +1176,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.accessLevels.patch - * @desc Update an Access Level. The longrunning operation from this RPC - * will have a successful status once the changes to the Access Level have - * propagated to long-lasting storage. Access Levels containing errors will - * result in an error response for the first error encountered. + * @desc Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.accessLevels.patch * @memberOf! () * @@ -1421,8 +1257,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy which owns this Access - * Level. Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}` */ parent?: string; @@ -1439,8 +1274,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Access Level. Format: - * `accessPolicies/{policy_id}/accessLevels/{access_level_id}` + * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` */ name?: string; } @@ -1452,17 +1286,11 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to return `BasicLevels` in the Cloud Common Expression Language - * rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels - * are returned as `BasicLevels` or `CustomLevels` based on how they were - * created. If set to CEL, all Access Levels are returned as `CustomLevels`. - * In the CEL case, `BasicLevels` are translated to equivalent - * `CustomLevels`. + * Whether to return `BasicLevels` in the Cloud Common Expression Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are returned as `BasicLevels` or `CustomLevels` based on how they were created. If set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent `CustomLevels`. */ accessLevelFormat?: string; /** - * Required. Resource name for the Access Level. Format: - * `accessPolicies/{policy_id}/accessLevels/{access_level_id}` + * Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` */ name?: string; } @@ -1474,9 +1302,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to return `BasicLevels` in the Cloud Common Expression language, - * as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning - * `AccessLevels` in the format they were defined. + * Whether to return `BasicLevels` in the Cloud Common Expression language, as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning `AccessLevels` in the format they were defined. */ accessLevelFormat?: string; /** @@ -1484,13 +1310,11 @@ export namespace accesscontextmanager_v1beta { */ pageSize?: number; /** - * Next page token for the next batch of Access Level instances. Defaults to - * the first page of results. + * Next page token for the next batch of Access Level instances. Defaults to the first page of results. */ pageToken?: string; /** - * Required. Resource name for the access policy to list Access Levels from. - * Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}` */ parent?: string; } @@ -1502,9 +1326,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Access Level. The `short_name` component - * must begin with a letter and only include alphanumeric and '_'. Format: - * `accessPolicies/{policy_id}/accessLevels/{short_name}` + * Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` */ name?: string; /** @@ -1526,10 +1348,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.servicePerimeters.create - * @desc Create an Service Perimeter. The longrunning operation from this - * RPC will have a successful status once the Service Perimeter has - * propagated to long-lasting storage. Service Perimeters containing errors - * will result in an error response for the first error encountered. + * @desc Create an Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.servicePerimeters.create * @memberOf! () * @@ -1605,9 +1424,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.servicePerimeters.delete - * @desc Delete an Service Perimeter by resource name. The longrunning - * operation from this RPC will have a successful status once the Service - * Perimeter has been removed from long-lasting storage. + * @desc Delete an Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage. * @alias accesscontextmanager.accessPolicies.servicePerimeters.delete * @memberOf! () * @@ -1837,11 +1654,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.accessPolicies.servicePerimeters.patch - * @desc Update an Service Perimeter. The longrunning operation from this - * RPC will have a successful status once the changes to the Service - * Perimeter have propagated to long-lasting storage. Service Perimeter - * containing errors will result in an error response for the first error - * encountered. + * @desc Update an Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered. * @alias accesscontextmanager.accessPolicies.servicePerimeters.patch * @memberOf! () * @@ -1922,8 +1735,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the access policy which owns this Service - * Perimeter. Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy which owns this Service Perimeter. Format: `accessPolicies/{policy_id}` */ parent?: string; @@ -1940,8 +1752,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Service Perimeter. Format: - * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` + * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` */ name?: string; } @@ -1953,8 +1764,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the Service Perimeter. Format: - * `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` + * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` */ name?: string; } @@ -1970,13 +1780,11 @@ export namespace accesscontextmanager_v1beta { */ pageSize?: number; /** - * Next page token for the next batch of Service Perimeter instances. - * Defaults to the first page of results. + * Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results. */ pageToken?: string; /** - * Required. Resource name for the access policy to list Service Perimeters - * from. Format: `accessPolicies/{policy_id}` + * Required. Resource name for the access policy to list Service Perimeters from. Format: `accessPolicies/{policy_id}` */ parent?: string; } @@ -1988,9 +1796,7 @@ export namespace accesscontextmanager_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name for the ServicePerimeter. The `short_name` - * component must begin with a letter and only include alphanumeric and '_'. - * Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` + * Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` */ name?: string; /** @@ -2012,9 +1818,7 @@ export namespace accesscontextmanager_v1beta { /** * accesscontextmanager.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias accesscontextmanager.operations.get * @memberOf! () * diff --git a/src/apis/adexchangebuyer/package.json b/src/apis/adexchangebuyer/package.json index fa1b556fc66..18509ea6ea9 100644 --- a/src/apis/adexchangebuyer/package.json +++ b/src/apis/adexchangebuyer/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/adexchangebuyer/v1.2.ts b/src/apis/adexchangebuyer/v1.2.ts index 11679300010..fe9fa6653a1 100644 --- a/src/apis/adexchangebuyer/v1.2.ts +++ b/src/apis/adexchangebuyer/v1.2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace adexchangebuyer_v1_2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace adexchangebuyer_v1_2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,9 +75,7 @@ export namespace adexchangebuyer_v1_2 { /** * Ad Exchange Buyer API * - * Accesses your bidding-account information, submits creatives for - * validation, finds available direct deals, and retrieves performance - * reports. + * Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports. * * @example * const {google} = require('googleapis'); @@ -98,7 +93,10 @@ export namespace adexchangebuyer_v1_2 { creatives: Resource$Creatives; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.creatives = new Resource$Creatives(this.context); @@ -118,8 +116,7 @@ export namespace adexchangebuyer_v1_2 { url?: string; }>; /** - * The nid parameter value used in cookie match requests. Please contact - * your technical account manager if you need to change this. + * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. */ cookieMatchingNid?: string; /** @@ -135,25 +132,20 @@ export namespace adexchangebuyer_v1_2 { */ kind?: string; /** - * The maximum number of active creatives that an account can have, where a - * creative is active if it was inserted or bid with in the last 30 days. - * Please contact your technical account manager if you need to change this. + * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this. */ maximumActiveCreatives?: number; /** - * The sum of all bidderLocation.maximumQps values cannot exceed this. - * Please contact your technical account manager if you need to change this. + * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. */ maximumTotalQps?: number; /** - * The number of creatives that this account inserted or bid with in the - * last 30 days. + * The number of creatives that this account inserted or bid with in the last 30 days. */ numberActiveCreatives?: number; } /** - * An account feed lists Ad Exchange buyer accounts that the user has access - * to. Each entry in the feed corresponds to a single buyer account. + * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account. */ export interface Schema$AccountsList { /** @@ -174,8 +166,7 @@ export namespace adexchangebuyer_v1_2 { */ accountId?: number; /** - * Detected advertiser id, if any. Read-only. This field should not be set - * in requests. + * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ advertiserId?: string[]; /** @@ -187,9 +178,7 @@ export namespace adexchangebuyer_v1_2 { */ agencyId?: string; /** - * The last upload timestamp of this creative if it was uploaded via API. - * Read-only. The value of this field is generated, and will be ignored for - * uploads. (formatted RFC 3339 timestamp). + * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). */ apiUploadTimestamp?: string; /** @@ -205,21 +194,15 @@ export namespace adexchangebuyer_v1_2 { */ clickThroughUrl?: string[]; /** - * Shows any corrections that were applied to this creative. Read-only. This - * field should not be set in requests. + * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. */ corrections?: Array<{details?: string[]; reason?: string}>; /** - * The reasons for disapproval, if any. Note that not all disapproval - * reasons may be categorized, so it is possible for the creative to have a - * status of DISAPPROVED with an empty list for disapproval_reasons. In this - * case, please reach out to your TAM to help debug the issue. Read-only. - * This field should not be set in requests. + * The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests. */ disapprovalReasons?: Array<{details?: string[]; reason?: string}>; /** - * The filtering reasons for the creative. Read-only. This field should not - * be set in requests. + * The filtering reasons for the creative. Read-only. This field should not be set in requests. */ filteringReasons?: { date?: string; @@ -230,8 +213,7 @@ export namespace adexchangebuyer_v1_2 { */ height?: number; /** - * The HTML snippet that displays the ad when inserted in the web page. If - * set, videoURL should not be set. + * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. */ HTMLSnippet?: string; /** @@ -243,23 +225,19 @@ export namespace adexchangebuyer_v1_2 { */ kind?: string; /** - * Detected product categories, if any. Read-only. This field should not be - * set in requests. + * Detected product categories, if any. Read-only. This field should not be set in requests. */ productCategories?: number[]; /** - * All restricted categories for the ads that may be shown from this - * snippet. + * All restricted categories for the ads that may be shown from this snippet. */ restrictedCategories?: number[]; /** - * Detected sensitive categories, if any. Read-only. This field should not - * be set in requests. + * Detected sensitive categories, if any. Read-only. This field should not be set in requests. */ sensitiveCategories?: number[]; /** - * Creative serving status. Read-only. This field should not be set in - * requests. + * Creative serving status. Read-only. This field should not be set in requests. */ status?: string; /** @@ -267,8 +245,7 @@ export namespace adexchangebuyer_v1_2 { */ vendorType?: number[]; /** - * The version for this creative. Read-only. This field should not be set in - * requests. + * The version for this creative. Read-only. This field should not be set in requests. */ version?: number; /** @@ -281,9 +258,7 @@ export namespace adexchangebuyer_v1_2 { width?: number; } /** - * The creatives feed lists the active creatives for the Ad Exchange buyer - * accounts that the user has access to. Each entry in the feed corresponds to - * a single creative. + * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative. */ export interface Schema$CreativesList { /** @@ -295,9 +270,7 @@ export namespace adexchangebuyer_v1_2 { */ kind?: string; /** - * Continuation token used to page through creatives. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -654,8 +627,7 @@ export namespace adexchangebuyer_v1_2 { /** * adexchangebuyer.creatives.get - * @desc Gets the status for a single creative. A creative will be available - * 30-40 minutes after submission. + * @desc Gets the status for a single creative. A creative will be available 30-40 minutes after submission. * @alias adexchangebuyer.creatives.get * @memberOf! () * @@ -798,8 +770,7 @@ export namespace adexchangebuyer_v1_2 { /** * adexchangebuyer.creatives.list - * @desc Retrieves a list of the authenticated user's active creatives. A - * creative will be available 30-40 minutes after submission. + * @desc Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. * @alias adexchangebuyer.creatives.list * @memberOf! () * @@ -906,14 +877,11 @@ export namespace adexchangebuyer_v1_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of entries returned on one result page. If not set, the - * default is 100. Optional. + * Maximum number of entries returned on one result page. If not set, the default is 100. Optional. */ maxResults?: number; /** - * A continuation token, used to page through ad clients. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. Optional. + * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. */ pageToken?: string; /** diff --git a/src/apis/adexchangebuyer/v1.3.ts b/src/apis/adexchangebuyer/v1.3.ts index a3aa2a664db..08e9d4845ea 100644 --- a/src/apis/adexchangebuyer/v1.3.ts +++ b/src/apis/adexchangebuyer/v1.3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace adexchangebuyer_v1_3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace adexchangebuyer_v1_3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,9 +75,7 @@ export namespace adexchangebuyer_v1_3 { /** * Ad Exchange Buyer API * - * Accesses your bidding-account information, submits creatives for - * validation, finds available direct deals, and retrieves performance - * reports. + * Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports. * * @example * const {google} = require('googleapis'); @@ -103,7 +98,10 @@ export namespace adexchangebuyer_v1_3 { pretargetingConfig: Resource$Pretargetingconfig; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.billingInfo = new Resource$Billinginfo(this.context); @@ -128,8 +126,7 @@ export namespace adexchangebuyer_v1_3 { url?: string; }>; /** - * The nid parameter value used in cookie match requests. Please contact - * your technical account manager if you need to change this. + * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. */ cookieMatchingNid?: string; /** @@ -145,25 +142,20 @@ export namespace adexchangebuyer_v1_3 { */ kind?: string; /** - * The maximum number of active creatives that an account can have, where a - * creative is active if it was inserted or bid with in the last 30 days. - * Please contact your technical account manager if you need to change this. + * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this. */ maximumActiveCreatives?: number; /** - * The sum of all bidderLocation.maximumQps values cannot exceed this. - * Please contact your technical account manager if you need to change this. + * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. */ maximumTotalQps?: number; /** - * The number of creatives that this account inserted or bid with in the - * last 30 days. + * The number of creatives that this account inserted or bid with in the last 30 days. */ numberActiveCreatives?: number; } /** - * An account feed lists Ad Exchange buyer accounts that the user has access - * to. Each entry in the feed corresponds to a single buyer account. + * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account. */ export interface Schema$AccountsList { /** @@ -188,9 +180,7 @@ export namespace adexchangebuyer_v1_3 { */ accountName?: string; /** - * A list of adgroup IDs associated with this particular account. These IDs - * may show up as part of a realtime bidding BidRequest, which indicates a - * bid request for this account. + * A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account. */ billingId?: string[]; /** @@ -199,8 +189,7 @@ export namespace adexchangebuyer_v1_3 { kind?: string; } /** - * A billing info feed lists Billing Info the Ad Exchange buyer account has - * access to. Each entry in the feed corresponds to a single billing info. + * A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info. */ export interface Schema$BillingInfoList { /** @@ -221,13 +210,11 @@ export namespace adexchangebuyer_v1_3 { */ accountId?: string; /** - * The billing id to determine which adgroup to provide budget information - * for. This is required for get and update requests. + * The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. */ billingId?: string; /** - * The daily budget amount in unit amount of the account currency to apply - * for the billingId provided. This is required for update requests. + * The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. */ budgetAmount?: string; /** @@ -252,8 +239,7 @@ export namespace adexchangebuyer_v1_3 { */ accountId?: number; /** - * Detected advertiser id, if any. Read-only. This field should not be set - * in requests. + * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ advertiserId?: string[]; /** @@ -265,9 +251,7 @@ export namespace adexchangebuyer_v1_3 { */ agencyId?: string; /** - * The last upload timestamp of this creative if it was uploaded via API. - * Read-only. The value of this field is generated, and will be ignored for - * uploads. (formatted RFC 3339 timestamp). + * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). */ apiUploadTimestamp?: string; /** @@ -283,21 +267,15 @@ export namespace adexchangebuyer_v1_3 { */ clickThroughUrl?: string[]; /** - * Shows any corrections that were applied to this creative. Read-only. This - * field should not be set in requests. + * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. */ corrections?: Array<{details?: string[]; reason?: string}>; /** - * The reasons for disapproval, if any. Note that not all disapproval - * reasons may be categorized, so it is possible for the creative to have a - * status of DISAPPROVED with an empty list for disapproval_reasons. In this - * case, please reach out to your TAM to help debug the issue. Read-only. - * This field should not be set in requests. + * The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests. */ disapprovalReasons?: Array<{details?: string[]; reason?: string}>; /** - * The filtering reasons for the creative. Read-only. This field should not - * be set in requests. + * The filtering reasons for the creative. Read-only. This field should not be set in requests. */ filteringReasons?: { date?: string; @@ -308,8 +286,7 @@ export namespace adexchangebuyer_v1_3 { */ height?: number; /** - * The HTML snippet that displays the ad when inserted in the web page. If - * set, videoURL should not be set. + * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. */ HTMLSnippet?: string; /** @@ -338,23 +315,19 @@ export namespace adexchangebuyer_v1_3 { store?: string; }; /** - * Detected product categories, if any. Read-only. This field should not be - * set in requests. + * Detected product categories, if any. Read-only. This field should not be set in requests. */ productCategories?: number[]; /** - * All restricted categories for the ads that may be shown from this - * snippet. + * All restricted categories for the ads that may be shown from this snippet. */ restrictedCategories?: number[]; /** - * Detected sensitive categories, if any. Read-only. This field should not - * be set in requests. + * Detected sensitive categories, if any. Read-only. This field should not be set in requests. */ sensitiveCategories?: number[]; /** - * Creative serving status. Read-only. This field should not be set in - * requests. + * Creative serving status. Read-only. This field should not be set in requests. */ status?: string; /** @@ -362,13 +335,11 @@ export namespace adexchangebuyer_v1_3 { */ vendorType?: number[]; /** - * The version for this creative. Read-only. This field should not be set in - * requests. + * The version for this creative. Read-only. This field should not be set in requests. */ version?: number; /** - * The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should - * not be set. + * The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. */ videoURL?: string; /** @@ -377,9 +348,7 @@ export namespace adexchangebuyer_v1_3 { width?: number; } /** - * The creatives feed lists the active creatives for the Ad Exchange buyer - * accounts that the user has access to. Each entry in the feed corresponds to - * a single creative. + * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative. */ export interface Schema$CreativesList { /** @@ -391,9 +360,7 @@ export namespace adexchangebuyer_v1_3 { */ kind?: string; /** - * Continuation token used to page through creatives. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -414,13 +381,11 @@ export namespace adexchangebuyer_v1_3 { */ allowsAlcohol?: boolean; /** - * The account id that this deal was negotiated for. It is either the buyer - * or the client that this deal was negotiated on behalf of. + * The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of. */ buyerAccountId?: string; /** - * The currency code that applies to the fixed_cpm value. If not set then - * assumed to be USD. + * The currency code that applies to the fixed_cpm value. If not set then assumed to be USD. */ currencyCode?: string; /** @@ -428,16 +393,11 @@ export namespace adexchangebuyer_v1_3 { */ dealTier?: string; /** - * End time for when this deal stops being active. If not set then this deal - * is valid until manually disabled by the publisher. In seconds since the - * epoch. + * End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch. */ endTime?: string; /** - * The fixed price for this direct deal. In cpm micros of currency according - * to currency_code. If set, then this deal is eligible for the fixed price - * tier of buying (highest priority, pay exactly the configured fixed - * price). + * The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price). */ fixedCpm?: string; /** @@ -453,15 +413,11 @@ export namespace adexchangebuyer_v1_3 { */ name?: string; /** - * The minimum price for this direct deal. In cpm micros of currency - * according to currency_code. If set, then this deal is eligible for the - * private exchange tier of buying (below fixed price priority, run as a - * second price auction). + * The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction). */ privateExchangeMinCpm?: string; /** - * If true, the publisher has opted to have their blocks ignored when a - * creative is bid with for this deal. + * If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal. */ publisherBlocksOverriden?: boolean; /** @@ -469,15 +425,12 @@ export namespace adexchangebuyer_v1_3 { */ sellerNetwork?: string; /** - * Start time for when this deal becomes active. If not set then this deal - * is active immediately upon creation. In seconds since the epoch. + * Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch. */ startTime?: string; } /** - * A direct deals feed lists Direct Deals the Ad Exchange buyer account has - * access to. This includes direct deals set up for the buyer account as well - * as its merged stream seats. + * A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats. */ export interface Schema$DirectDealsList { /** @@ -502,8 +455,7 @@ export namespace adexchangebuyer_v1_3 { */ bidRequestRate?: number; /** - * Rate of various prefiltering statuses per match. Please refer to the - * callout-status-codes.txt file for different statuses. + * Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses. */ calloutStatusRate?: any[]; /** @@ -511,13 +463,11 @@ export namespace adexchangebuyer_v1_3 { */ cookieMatcherStatusRate?: any[]; /** - * Rate of ads with a given status. Please refer to the - * creative-status-codes.txt file for different statuses. + * Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses. */ creativeStatusRate?: any[]; /** - * The number of bid responses that were filtered due to a policy violation - * or other errors. + * The number of bid responses that were filtered due to a policy violation or other errors. */ filteredBidRate?: number; /** @@ -533,18 +483,15 @@ export namespace adexchangebuyer_v1_3 { */ kind?: string; /** - * The 50th percentile round trip latency(ms) as perceived from Google - * servers for the duration period covered by the report. + * The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ latency50thPercentile?: number; /** - * The 85th percentile round trip latency(ms) as perceived from Google - * servers for the duration period covered by the report. + * The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ latency85thPercentile?: number; /** - * The 95th percentile round trip latency(ms) as perceived from Google - * servers for the duration period covered by the report. + * The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ latency95thPercentile?: number; /** @@ -576,8 +523,7 @@ export namespace adexchangebuyer_v1_3 { */ region?: string; /** - * The number of properly formed bid responses received by our servers - * within the deadline. + * The number of properly formed bid responses received by our servers within the deadline. */ successfulRequestRate?: number; /** @@ -585,8 +531,7 @@ export namespace adexchangebuyer_v1_3 { */ timestamp?: string; /** - * The number of bid responses that were unsuccessful due to timeouts, - * incorrect formatting, etc. + * The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc. */ unsuccessfulRequestRate?: number; } @@ -605,13 +550,11 @@ export namespace adexchangebuyer_v1_3 { } export interface Schema$PretargetingConfig { /** - * The id for billing purposes, provided for reference. Leave this field - * blank for insert requests; the id will be generated automatically. + * The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically. */ billingId?: string; /** - * The config id; generated automatically. Leave this field blank for insert - * requests. + * The config id; generated automatically. Leave this field blank for insert requests. */ configId?: string; /** @@ -619,18 +562,15 @@ export namespace adexchangebuyer_v1_3 { */ configName?: string; /** - * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or - * PRETARGETING_CREATIVE_TYPE_VIDEO. + * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. */ creativeType?: string[]; /** - * Requests which allow one of these (width, height) pairs will match. All - * pairs must be supported ad dimensions. + * Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions. */ dimensions?: Array<{height?: string; width?: string}>; /** - * Requests with any of these content labels will not match. Values are from - * content-labels.txt in the downloadable files section. + * Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section. */ excludedContentLabels?: string[]; /** @@ -646,8 +586,7 @@ export namespace adexchangebuyer_v1_3 { */ excludedUserLists?: string[]; /** - * Requests containing any of these vertical ids will not match. Values are - * from the publisher-verticals.txt file in the downloadable files section. + * Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. */ excludedVerticals?: string[]; /** @@ -659,8 +598,7 @@ export namespace adexchangebuyer_v1_3 { */ isActive?: boolean; /** - * The kind of the resource, i.e. - * "adexchangebuyer#pretargetingConfig". + * The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig". */ kind?: string; /** @@ -668,18 +606,15 @@ export namespace adexchangebuyer_v1_3 { */ languages?: string[]; /** - * Requests containing any of these mobile carrier ids will match. Values - * are from mobile-carriers.csv in the downloadable files section. + * Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section. */ mobileCarriers?: string[]; /** - * Requests containing any of these mobile device ids will match. Values are - * from mobile-devices.csv in the downloadable files section. + * Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section. */ mobileDevices?: string[]; /** - * Requests containing any of these mobile operating system version ids will - * match. Values are from mobile-os.csv in the downloadable files section. + * Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section. */ mobileOperatingSystemVersions?: string[]; /** @@ -687,16 +622,11 @@ export namespace adexchangebuyer_v1_3 { */ placements?: Array<{token?: string; type?: string}>; /** - * Requests matching any of these platforms will match. Possible values are - * PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and - * PRETARGETING_PLATFORM_TABLET. + * Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. */ platforms?: string[]; /** - * Creative attributes should be declared here if all creatives - * corresponding to this pretargeting configuration have that creative - * attribute. Values are from pretargetable-creative-attributes.txt in the - * downloadable files section. + * Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section. */ supportedCreativeAttributes?: string[]; /** @@ -704,8 +634,7 @@ export namespace adexchangebuyer_v1_3 { */ userLists?: string[]; /** - * Requests that allow any of these vendor ids will match. Values are from - * vendors.txt in the downloadable files section. + * Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section. */ vendorTypes?: string[]; /** @@ -1076,8 +1005,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.billingInfo.get - * @desc Returns the billing information for one account specified by - * account ID. + * @desc Returns the billing information for one account specified by account ID. * @alias adexchangebuyer.billingInfo.get * @memberOf! () * @@ -1149,8 +1077,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.billingInfo.list - * @desc Retrieves a list of billing information for all accounts of the - * authenticated user. + * @desc Retrieves a list of billing information for all accounts of the authenticated user. * @alias adexchangebuyer.billingInfo.list * @memberOf! () * @@ -1247,8 +1174,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.budget.get - * @desc Returns the budget information for the adgroup specified by the - * accountId and billingId. + * @desc Returns the budget information for the adgroup specified by the accountId and billingId. * @alias adexchangebuyer.budget.get * @memberOf! () * @@ -1320,9 +1246,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.budget.patch - * @desc Updates the budget amount for the budget of the adgroup specified - * by the accountId and billingId, with the budget amount in the request. - * This method supports patch semantics. + * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics. * @alias adexchangebuyer.budget.patch * @memberOf! () * @@ -1395,8 +1319,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.budget.update - * @desc Updates the budget amount for the budget of the adgroup specified - * by the accountId and billingId, with the budget amount in the request. + * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. * @alias adexchangebuyer.budget.update * @memberOf! () * @@ -1532,8 +1455,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.creatives.get - * @desc Gets the status for a single creative. A creative will be available - * 30-40 minutes after submission. + * @desc Gets the status for a single creative. A creative will be available 30-40 minutes after submission. * @alias adexchangebuyer.creatives.get * @memberOf! () * @@ -1676,8 +1598,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.creatives.list - * @desc Retrieves a list of the authenticated user's active creatives. A - * creative will be available 30-40 minutes after submission. + * @desc Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. * @alias adexchangebuyer.creatives.list * @memberOf! () * @@ -1790,19 +1711,15 @@ export namespace adexchangebuyer_v1_3 { */ accountId?: number[]; /** - * When specified, only creatives for the given buyer creative ids are - * returned. + * When specified, only creatives for the given buyer creative ids are returned. */ buyerCreativeId?: string[]; /** - * Maximum number of entries returned on one result page. If not set, the - * default is 100. Optional. + * Maximum number of entries returned on one result page. If not set, the default is 100. Optional. */ maxResults?: number; /** - * A continuation token, used to page through ad clients. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. Optional. + * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. */ pageToken?: string; /** @@ -2084,14 +2001,11 @@ export namespace adexchangebuyer_v1_3 { */ endDateTime?: string; /** - * Maximum number of entries returned on one result page. If not set, the - * default is 100. Optional. + * Maximum number of entries returned on one result page. If not set, the default is 100. Optional. */ maxResults?: number; /** - * A continuation token, used to page through performance reports. To - * retrieve the next page, set this parameter to the value of - * "nextPageToken" from the previous response. Optional. + * A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. */ pageToken?: string; /** @@ -2330,8 +2244,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.pretargetingConfig.list - * @desc Retrieves a list of the authenticated user's pretargeting - * configurations. + * @desc Retrieves a list of the authenticated user's pretargeting configurations. * @alias adexchangebuyer.pretargetingConfig.list * @memberOf! () * @@ -2406,8 +2319,7 @@ export namespace adexchangebuyer_v1_3 { /** * adexchangebuyer.pretargetingConfig.patch - * @desc Updates an existing pretargeting config. This method supports patch - * semantics. + * @desc Updates an existing pretargeting config. This method supports patch semantics. * @alias adexchangebuyer.pretargetingConfig.patch * @memberOf! () * diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts index cd09950cd9a..056b4938c5b 100644 --- a/src/apis/adexchangebuyer/v1.4.ts +++ b/src/apis/adexchangebuyer/v1.4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace adexchangebuyer_v1_4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace adexchangebuyer_v1_4 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,9 +75,7 @@ export namespace adexchangebuyer_v1_4 { /** * Ad Exchange Buyer API * - * Accesses your bidding-account information, submits creatives for - * validation, finds available direct deals, and retrieves performance - * reports. + * Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports. * * @example * const {google} = require('googleapis'); @@ -108,7 +103,10 @@ export namespace adexchangebuyer_v1_4 { pubprofiles: Resource$Pubprofiles; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.billingInfo = new Resource$Billinginfo(this.context); @@ -132,11 +130,7 @@ export namespace adexchangebuyer_v1_4 { */ export interface Schema$Account { /** - * When this is false, bid requests that include a deal ID for a private - * auction or preferred deal are always sent to your bidder. When true, all - * active pretargeting configs will be applied to private auctions and - * preferred deals. Programmatic Guaranteed deals (when enabled) are always - * sent to your bidder. + * When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. */ applyPretargetingToNonGuaranteedDeals?: boolean; /** @@ -149,8 +143,7 @@ export namespace adexchangebuyer_v1_4 { url?: string; }>; /** - * The nid parameter value used in cookie match requests. Please contact - * your technical account manager if you need to change this. + * The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. */ cookieMatchingNid?: string; /** @@ -166,25 +159,20 @@ export namespace adexchangebuyer_v1_4 { */ kind?: string; /** - * The maximum number of active creatives that an account can have, where a - * creative is active if it was inserted or bid with in the last 30 days. - * Please contact your technical account manager if you need to change this. + * The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this. */ maximumActiveCreatives?: number; /** - * The sum of all bidderLocation.maximumQps values cannot exceed this. - * Please contact your technical account manager if you need to change this. + * The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. */ maximumTotalQps?: number; /** - * The number of creatives that this account inserted or bid with in the - * last 30 days. + * The number of creatives that this account inserted or bid with in the last 30 days. */ numberActiveCreatives?: number; } /** - * An account feed lists Ad Exchange buyer accounts that the user has access - * to. Each entry in the feed corresponds to a single buyer account. + * An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account. */ export interface Schema$AccountsList { /** @@ -242,9 +230,7 @@ export namespace adexchangebuyer_v1_4 { */ accountName?: string; /** - * A list of adgroup IDs associated with this particular account. These IDs - * may show up as part of a realtime bidding BidRequest, which indicates a - * bid request for this account. + * A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account. */ billingId?: string[]; /** @@ -253,8 +239,7 @@ export namespace adexchangebuyer_v1_4 { kind?: string; } /** - * A billing info feed lists Billing Info the Ad Exchange buyer account has - * access to. Each entry in the feed corresponds to a single billing info. + * A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info. */ export interface Schema$BillingInfoList { /** @@ -275,13 +260,11 @@ export namespace adexchangebuyer_v1_4 { */ accountId?: string; /** - * The billing id to determine which adgroup to provide budget information - * for. This is required for get and update requests. + * The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. */ billingId?: string; /** - * The daily budget amount in unit amount of the account currency to apply - * for the billingId provided. This is required for update requests. + * The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. */ budgetAmount?: string; /** @@ -338,18 +321,15 @@ export namespace adexchangebuyer_v1_4 { */ accountId?: number; /** - * The link to the Ad Preferences page. This is only supported for native - * ads. + * The link to the Ad Preferences page. This is only supported for native ads. */ adChoicesDestinationUrl?: string; /** - * Detected advertiser id, if any. Read-only. This field should not be set - * in requests. + * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ advertiserId?: string[]; /** - * The name of the company being advertised in the creative. The value - * provided must exist in the advertisers.txt file. + * The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file. */ advertiserName?: string; /** @@ -357,15 +337,11 @@ export namespace adexchangebuyer_v1_4 { */ agencyId?: string; /** - * The last upload timestamp of this creative if it was uploaded via API. - * Read-only. The value of this field is generated, and will be ignored for - * uploads. (formatted RFC 3339 timestamp). + * The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). */ apiUploadTimestamp?: string; /** - * List of buyer selectable attributes for the ads that may be shown from - * this snippet. Each attribute is represented by an integer as defined in - * buyer-declarable-creative-attributes.txt. + * List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt. */ attribute?: number[]; /** @@ -377,8 +353,7 @@ export namespace adexchangebuyer_v1_4 { */ clickThroughUrl?: string[]; /** - * Shows any corrections that were applied to this creative. Read-only. This - * field should not be set in requests. + * Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. */ corrections?: Array<{ contexts?: Array<{ @@ -391,33 +366,19 @@ export namespace adexchangebuyer_v1_4 { reason?: string; }>; /** - * Creative status identity type that the creative item applies to. Ad - * Exchange real-time bidding is migrating to the sizeless creative - * verification. Originally, Ad Exchange assigned creative verification - * status to a unique combination of a buyer creative ID and creative - * dimensions. Post-migration, a single verification status will be assigned - * at the buyer creative ID level. This field allows to distinguish whether - * a given creative status applies to a unique combination of a buyer - * creative ID and creative dimensions, or to a buyer creative ID as a - * whole. + * Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole. */ creativeStatusIdentityType?: string; /** - * Top-level deals status. Read-only. This field should not be set in - * requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) - * in servingRestrictions will also exist. Note that this may be nuanced - * with other contextual restrictions, in which case it may be preferable to - * read from servingRestrictions directly. + * Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly. */ dealsStatus?: string; /** - * Detected domains for this creative. Read-only. This field should not be - * set in requests. + * Detected domains for this creative. Read-only. This field should not be set in requests. */ detectedDomains?: string[]; /** - * The filtering reasons for the creative. Read-only. This field should not - * be set in requests. + * The filtering reasons for the creative. Read-only. This field should not be set in requests. */ filteringReasons?: { date?: string; @@ -428,8 +389,7 @@ export namespace adexchangebuyer_v1_4 { */ height?: number; /** - * The HTML snippet that displays the ad when inserted in the web page. If - * set, videoURL, videoVastXML, and nativeAd should not be set. + * The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set. */ HTMLSnippet?: string; /** @@ -441,13 +401,11 @@ export namespace adexchangebuyer_v1_4 { */ kind?: string; /** - * Detected languages for this creative. Read-only. This field should not be - * set in requests. + * Detected languages for this creative. Read-only. This field should not be set in requests. */ languages?: string[]; /** - * If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside - * of nativeAd should not be set. (The videoURL inside nativeAd can be set.) + * If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) */ nativeAd?: { advertiser?: string; @@ -466,37 +424,23 @@ export namespace adexchangebuyer_v1_4 { videoURL?: string; }; /** - * Top-level open auction status. Read-only. This field should not be set in - * requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) - * in servingRestrictions will also exist. Note that this may be nuanced - * with other contextual restrictions, in which case it may be preferable to - * read from ServingRestrictions directly. + * Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly. */ openAuctionStatus?: string; /** - * Detected product categories, if any. Each category is represented by an - * integer as defined in ad-product-categories.txt. Read-only. This field - * should not be set in requests. + * Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. */ productCategories?: number[]; /** - * All restricted categories for the ads that may be shown from this - * snippet. Each category is represented by an integer as defined in the - * ad-restricted-categories.txt. + * All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt. */ restrictedCategories?: number[]; /** - * Detected sensitive categories, if any. Each category is represented by an - * integer as defined in ad-sensitive-categories.txt. Read-only. This field - * should not be set in requests. + * Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. */ sensitiveCategories?: number[]; /** - * The granular status of this ad in specific contexts. A context here - * relates to where something ultimately serves (for example, a physical - * location, a platform, an HTTPS vs HTTP request, or the type of auction). - * Read-only. This field should not be set in requests. See the examples in - * the Creatives guide for more details. + * The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details. */ servingRestrictions?: Array<{ contexts?: Array<{ @@ -509,25 +453,19 @@ export namespace adexchangebuyer_v1_4 { reason?: string; }>; /** - * List of vendor types for the ads that may be shown from this snippet. - * Each vendor type is represented by an integer as defined in vendors.txt. + * List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. */ vendorType?: number[]; /** - * The version for this creative. Read-only. This field should not be set in - * requests. + * The version for this creative. Read-only. This field should not be set in requests. */ version?: number; /** - * The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and - * nativeAd should not be set. Note, this is different from - * resource.native_ad.video_url above. + * The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above. */ videoURL?: string; /** - * The contents of a VAST document for a video ad. This document should - * conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, - * and nativeAd and should not be set. + * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. */ videoVastXML?: string; /** @@ -553,9 +491,7 @@ export namespace adexchangebuyer_v1_4 { kind?: string; } /** - * The creatives feed lists the active creatives for the Ad Exchange buyer - * accounts that the user has access to. Each entry in the feed corresponds to - * a single creative. + * The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative. */ export interface Schema$CreativesList { /** @@ -567,29 +503,22 @@ export namespace adexchangebuyer_v1_4 { */ kind?: string; /** - * Continuation token used to page through creatives. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } export interface Schema$DealServingMetadata { /** - * True if alcohol ads are allowed for this deal (read-only). This field is - * only populated when querying for finalized orders using the method - * GetFinalizedOrderDeals + * True if alcohol ads are allowed for this deal (read-only). This field is only populated when querying for finalized orders using the method GetFinalizedOrderDeals */ alcoholAdsAllowed?: boolean; /** - * Tracks which parties (if any) have paused a deal. (readonly, except via - * PauseResumeOrderDeals action) + * Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action) */ dealPauseStatus?: Schema$DealServingMetadataDealPauseStatus; } /** - * Tracks which parties (if any) have paused a deal. The deal is considered - * paused if has_buyer_paused || has_seller_paused. Each of the - * has_buyer_paused or the has_seller_paused bits can be set independently. + * Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. */ export interface Schema$DealServingMetadataDealPauseStatus { buyerPauseReason?: string; @@ -607,9 +536,7 @@ export namespace adexchangebuyer_v1_4 { */ brandingType?: string; /** - * Indicates that this ExternalDealId exists under at least two different - * AdxInventoryDeals. Currently, the only case that the same ExternalDealId - * will exist is programmatic cross sell case. + * Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case. */ crossListedExternalDealIdType?: string; /** @@ -617,13 +544,11 @@ export namespace adexchangebuyer_v1_4 { */ description?: string; /** - * Non-binding estimate of the estimated gross spend for this deal Can be - * set by buyer or seller. + * Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. */ estimatedGrossSpend?: Schema$Price; /** - * Non-binding estimate of the impressions served per day Can be set by - * buyer or seller. + * Non-binding estimate of the impressions served per day Can be set by buyer or seller. */ estimatedImpressionsPerDay?: string; /** @@ -643,15 +568,13 @@ export namespace adexchangebuyer_v1_4 { */ rubiconNonGuaranteedTerms?: Schema$DealTermsRubiconNonGuaranteedTerms; /** - * For deals with Cost Per Day billing, defines the timezone used to mark - * the boundaries of a day (buyer-readonly) + * For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) */ sellerTimeZone?: string; } export interface Schema$DealTermsGuaranteedFixedPriceTerms { /** - * External billing info for this Deal. This field is relevant when external - * billing info such as price has a different currency code than DFP/AdX. + * External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. */ billingInfo?: Schema$DealTermsGuaranteedFixedPriceTermsBillingInfo; /** @@ -659,51 +582,39 @@ export namespace adexchangebuyer_v1_4 { */ fixedPrices?: Schema$PricePerBuyer[]; /** - * Guaranteed impressions as a percentage. This is the percentage of - * guaranteed looks that the buyer is guaranteeing to buy. + * Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. */ guaranteedImpressions?: string; /** - * Count of guaranteed looks. Required for deal, optional for product. For - * CPD deals, buyer changes to guaranteed_looks will be ignored. + * Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. */ guaranteedLooks?: string; /** - * Count of minimum daily looks for a CPD deal. For CPD deals, buyer should - * negotiate on this field instead of guaranteed_looks. + * Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. */ minimumDailyLooks?: string; } export interface Schema$DealTermsGuaranteedFixedPriceTermsBillingInfo { /** - * The timestamp (in ms since epoch) when the original reservation price for - * the deal was first converted to DFP currency. This is used to convert the - * contracted price into buyer's currency without discrepancy. + * The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy. */ currencyConversionTimeMs?: string; /** - * The DFP line item id associated with this deal. For features like CPD, - * buyers can retrieve the DFP line item for billing reconciliation. + * The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. */ dfpLineItemId?: string; /** - * The original contracted quantity (# impressions) for this deal. To ensure - * delivery, sometimes the publisher will book the deal with a impression - * buffer, such that guaranteed_looks is greater than the contracted - * quantity. However clients are billed using the original contracted - * quantity. + * The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. */ originalContractedQuantity?: string; /** - * The original reservation price for the deal, if the currency code is - * different from the one used in negotiation. + * The original reservation price for the deal, if the currency code is different from the one used in negotiation. */ price?: Schema$Price; } export interface Schema$DealTermsNonGuaranteedAuctionTerms { /** - * True if open auction buyers are allowed to compete with invited buyers in - * this private auction (buyer-readonly). + * True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). */ autoOptimizePrivateAuction?: boolean; /** @@ -762,9 +673,7 @@ export namespace adexchangebuyer_v1_4 { timeUnitType?: string; } /** - * This message carries publisher provided breakdown. E.g. {dimension_type: - * 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, - * {dimension_value: {id: 2, name: 'UK'}}]} + * This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]} */ export interface Schema$Dimension { dimensionType?: string; @@ -779,37 +688,21 @@ export namespace adexchangebuyer_v1_4 { */ id?: number; /** - * Name of the dimension mainly for debugging purposes, except for the case - * of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. + * Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. */ name?: string; /** - * Percent of total impressions for a dimension type. e.g. {dimension_type: - * 'GENDER', [{dimension_value: {id: 1, name: 'MALE', - * percentage: 60}}]} Gender MALE is 60% of all impressions which have - * gender. + * Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender. */ percentage?: number; } export interface Schema$EditAllOrderDealsRequest { /** - * List of deals to edit. Service may perform 3 different operations based - * on comparison of deals in this list vs deals already persisted in - * database: 1. Add new deal to proposal If a deal in this list does not - * exist in the proposal, the service will create a new deal and add it to - * the proposal. Validation will follow AddOrderDealsRequest. 2. Update - * existing deal in the proposal If a deal in this list already exist in the - * proposal, the service will update that existing deal to this new deal in - * the request. Validation will follow UpdateOrderDealsRequest. 3. Delete - * deals from the proposal (just need the id) If a existing deal in the - * proposal is not present in this list, the service will delete that deal - * from the proposal. Validation will follow DeleteOrderDealsRequest. + * List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest. */ deals?: Schema$MarketplaceDeal[]; /** - * If specified, also updates the proposal in the batch transaction. This is - * useful when the proposal and the deals need to be updated in one - * transaction. + * If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction. */ proposal?: Schema$Proposal; /** @@ -845,10 +738,7 @@ export namespace adexchangebuyer_v1_4 { } export interface Schema$GetOrderNotesResponse { /** - * The list of matching notes. The notes for a proposal are ordered from - * oldest to newest. If the notes span multiple proposals, they will be - * grouped by proposal, with the notes for the most recently modified - * proposal appearing first. + * The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first. */ notes?: Schema$MarketplaceNote[]; } @@ -865,8 +755,7 @@ export namespace adexchangebuyer_v1_4 { profiles?: Schema$PublisherProfileApiProto[]; } /** - * A proposal can contain multiple deals. A deal contains the terms and - * targeting information that is used for serving. + * A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. */ export interface Schema$MarketplaceDeal { /** @@ -890,30 +779,23 @@ export namespace adexchangebuyer_v1_4 { */ dealId?: string; /** - * Metadata about the serving status of this deal (readonly, writes via - * custom actions) + * Metadata about the serving status of this deal (readonly, writes via custom actions) */ dealServingMetadata?: Schema$DealServingMetadata; /** - * The set of fields around delivery control that are interesting for a - * buyer to see but are non-negotiable. These are set by the publisher. This - * message is assigned an id of 100 since some day we would want to model - * this as a protobuf extension. + * The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. */ deliveryControl?: Schema$DeliveryControl; /** - * The external deal id assigned to this deal once the deal is finalized. - * This is the deal-id that shows up in serving/reporting etc. (readonly) + * The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) */ externalDealId?: string; /** - * Proposed flight end time of the deal (ms since epoch) This will generally - * be stored in a granularity of a second. (updatable) + * Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) */ flightEndTimeMs?: string; /** - * Proposed flight start time of the deal (ms since epoch) This will - * generally be stored in a granularity of a second. (updatable) + * Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) */ flightStartTimeMs?: string; /** @@ -921,18 +803,15 @@ export namespace adexchangebuyer_v1_4 { */ inventoryDescription?: string; /** - * Indicates whether the current deal is a RFP template. RFP template is - * created by buyer and not based on seller created products. + * Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products. */ isRfpTemplate?: boolean; /** - * True, if the buyside inventory setup is complete for this deal. - * (readonly, except via OrderSetupCompleted action) + * True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action) */ isSetupComplete?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "adexchangebuyer#marketplaceDeal". + * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal". */ kind?: string; /** @@ -944,19 +823,15 @@ export namespace adexchangebuyer_v1_4 { */ name?: string; /** - * The product-id from which this deal was created. (readonly, except on - * create) + * The product-id from which this deal was created. (readonly, except on create) */ productId?: string; /** - * The revision number of the product that the deal was created from - * (readonly, except on create) + * The revision number of the product that the deal was created from (readonly, except on create) */ productRevisionNumber?: string; /** - * Specifies the creative source for programmatic deals, PUBLISHER means - * creative is provided by seller and ADVERTISR means creative is provided - * by buyer. (buyer-readonly) + * Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly) */ programmaticCreativeSource?: string; proposalId?: string; @@ -965,13 +840,11 @@ export namespace adexchangebuyer_v1_4 { */ sellerContacts?: Schema$ContactInformation[]; /** - * The shared targeting visible to buyers and sellers. Each shared targeting - * entity is AND'd together. (updatable) + * The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable) */ sharedTargetings?: Schema$SharedTargeting[]; /** - * The syndication product associated with the deal. (readonly, except on - * create) + * The syndication product associated with the deal. (readonly, except on create) */ syndicationProduct?: string; /** @@ -982,13 +855,11 @@ export namespace adexchangebuyer_v1_4 { } export interface Schema$MarketplaceDealParty { /** - * The buyer/seller associated with the deal. One of buyer/seller is - * specified for a deal-party. + * The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party. */ buyer?: Schema$Buyer; /** - * The buyer/seller associated with the deal. One of buyer/seller is - * specified for a deal party. + * The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party. */ seller?: Schema$Seller; } @@ -1011,8 +882,7 @@ export namespace adexchangebuyer_v1_4 { label?: string; } /** - * A proposal is associated with a bunch of notes which may optionally be - * associated with a deal and/or revision number. + * A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. */ export interface Schema$MarketplaceNote { /** @@ -1020,13 +890,11 @@ export namespace adexchangebuyer_v1_4 { */ creatorRole?: string; /** - * Notes can optionally be associated with a deal. (readonly, except on - * create) + * Notes can optionally be associated with a deal. (readonly, except on create) */ dealId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "adexchangebuyer#marketplaceNote". + * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote". */ kind?: string; /** @@ -1042,8 +910,7 @@ export namespace adexchangebuyer_v1_4 { */ proposalId?: string; /** - * If the note is associated with a proposal revision number, then store - * that here. (readonly, except on create) + * If the note is associated with a proposal revision number, then store that here. (readonly, except on create) */ proposalRevisionNumber?: string; /** @@ -1064,8 +931,7 @@ export namespace adexchangebuyer_v1_4 { */ bidRequestRate?: number; /** - * Rate of various prefiltering statuses per match. Please refer to the - * callout-status-codes.txt file for different statuses. + * Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses. */ calloutStatusRate?: any[]; /** @@ -1073,13 +939,11 @@ export namespace adexchangebuyer_v1_4 { */ cookieMatcherStatusRate?: any[]; /** - * Rate of ads with a given status. Please refer to the - * creative-status-codes.txt file for different statuses. + * Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses. */ creativeStatusRate?: any[]; /** - * The number of bid responses that were filtered due to a policy violation - * or other errors. + * The number of bid responses that were filtered due to a policy violation or other errors. */ filteredBidRate?: number; /** @@ -1095,18 +959,15 @@ export namespace adexchangebuyer_v1_4 { */ kind?: string; /** - * The 50th percentile round trip latency(ms) as perceived from Google - * servers for the duration period covered by the report. + * The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ latency50thPercentile?: number; /** - * The 85th percentile round trip latency(ms) as perceived from Google - * servers for the duration period covered by the report. + * The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ latency85thPercentile?: number; /** - * The 95th percentile round trip latency(ms) as perceived from Google - * servers for the duration period covered by the report. + * The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. */ latency95thPercentile?: number; /** @@ -1138,8 +999,7 @@ export namespace adexchangebuyer_v1_4 { */ region?: string; /** - * The number of properly formed bid responses received by our servers - * within the deadline. + * The number of properly formed bid responses received by our servers within the deadline. */ successfulRequestRate?: number; /** @@ -1147,8 +1007,7 @@ export namespace adexchangebuyer_v1_4 { */ timestamp?: string; /** - * The number of bid responses that were unsuccessful due to timeouts, - * incorrect formatting, etc. + * The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc. */ unsuccessfulRequestRate?: number; } @@ -1167,13 +1026,11 @@ export namespace adexchangebuyer_v1_4 { } export interface Schema$PretargetingConfig { /** - * The id for billing purposes, provided for reference. Leave this field - * blank for insert requests; the id will be generated automatically. + * The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically. */ billingId?: string; /** - * The config id; generated automatically. Leave this field blank for insert - * requests. + * The config id; generated automatically. Leave this field blank for insert requests. */ configId?: string; /** @@ -1181,18 +1038,15 @@ export namespace adexchangebuyer_v1_4 { */ configName?: string; /** - * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or - * PRETARGETING_CREATIVE_TYPE_VIDEO. + * List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. */ creativeType?: string[]; /** - * Requests which allow one of these (width, height) pairs will match. All - * pairs must be supported ad dimensions. + * Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions. */ dimensions?: Array<{height?: string; width?: string}>; /** - * Requests with any of these content labels will not match. Values are from - * content-labels.txt in the downloadable files section. + * Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section. */ excludedContentLabels?: string[]; /** @@ -1208,8 +1062,7 @@ export namespace adexchangebuyer_v1_4 { */ excludedUserLists?: string[]; /** - * Requests containing any of these vertical ids will not match. Values are - * from the publisher-verticals.txt file in the downloadable files section. + * Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. */ excludedVerticals?: string[]; /** @@ -1221,8 +1074,7 @@ export namespace adexchangebuyer_v1_4 { */ isActive?: boolean; /** - * The kind of the resource, i.e. - * "adexchangebuyer#pretargetingConfig". + * The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig". */ kind?: string; /** @@ -1230,25 +1082,19 @@ export namespace adexchangebuyer_v1_4 { */ languages?: string[]; /** - * Requests where the predicted viewability is below the specified decile - * will not match. E.g. if the buyer sets this value to 5, requests from - * slots where the predicted viewability is below 50% will not match. If the - * predicted viewability is unknown this field will be ignored. + * Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored. */ minimumViewabilityDecile?: number; /** - * Requests containing any of these mobile carrier ids will match. Values - * are from mobile-carriers.csv in the downloadable files section. + * Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section. */ mobileCarriers?: string[]; /** - * Requests containing any of these mobile device ids will match. Values are - * from mobile-devices.csv in the downloadable files section. + * Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section. */ mobileDevices?: string[]; /** - * Requests containing any of these mobile operating system version ids will - * match. Values are from mobile-os.csv in the downloadable files section. + * Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section. */ mobileOperatingSystemVersions?: string[]; /** @@ -1256,24 +1102,15 @@ export namespace adexchangebuyer_v1_4 { */ placements?: Array<{token?: string; type?: string}>; /** - * Requests matching any of these platforms will match. Possible values are - * PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and - * PRETARGETING_PLATFORM_TABLET. + * Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. */ platforms?: string[]; /** - * Creative attributes should be declared here if all creatives - * corresponding to this pretargeting configuration have that creative - * attribute. Values are from pretargetable-creative-attributes.txt in the - * downloadable files section. + * Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section. */ supportedCreativeAttributes?: string[]; /** - * Requests containing the specified type of user data will match. Possible - * values are HOSTED_MATCH_DATA, which means the request is - * cookie-targetable and has a match in the buyer's hosted match table, - * and COOKIE_OR_IDFA, which means the request has either a targetable - * cookie or an iOS IDFA. + * Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA. */ userIdentifierDataRequired?: string[]; /** @@ -1281,8 +1118,7 @@ export namespace adexchangebuyer_v1_4 { */ userLists?: string[]; /** - * Requests that allow any of these vendor ids will match. Values are from - * vendors.txt in the downloadable files section. + * Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section. */ vendorTypes?: string[]; /** @@ -1290,8 +1126,7 @@ export namespace adexchangebuyer_v1_4 { */ verticals?: string[]; /** - * Video requests satisfying any of these player size constraints will - * match. + * Video requests satisfying any of these player size constraints will match. */ videoPlayerSizes?: Array<{ aspectRatio?: string; @@ -1328,11 +1163,7 @@ export namespace adexchangebuyer_v1_4 { pricingType?: string; } /** - * Used to specify pricing rules for buyers. Each PricePerBuyer in a product - * can become [0,1] deals. To check if there is a PricePerBuyer for a - * particular buyer we look for the most specific matching rule - we first - * look for a rule matching the buyer and otherwise look for a matching rule - * where no buyer is set. + * Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. */ export interface Schema$PricePerBuyer { /** @@ -1344,9 +1175,7 @@ export namespace adexchangebuyer_v1_4 { */ billedBuyer?: Schema$Buyer; /** - * The buyer who will pay this price. If unset, all buyers can pay this - * price (if the advertisers match, and there's no more specific rule - * matching the buyer). + * The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). */ buyer?: Schema$Buyer; /** @@ -1359,23 +1188,15 @@ export namespace adexchangebuyer_v1_4 { referencePayload?: string; } /** - * A product is segment of inventory that a seller wishes to sell. It is - * associated with certain terms and targeting information which helps buyer - * know more about the inventory. Each field in a product can have one of the - * following setting: (readonly) - It is an error to try and set this field. - * (buyer-readonly) - Only the seller can set this field. (seller-readonly) - - * Only the buyer can set this field. (updatable) - The field is updatable at - * all times by either buyer or the seller. + * A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. */ export interface Schema$Product { /** - * The billed buyer corresponding to the buyer that created the offer. - * (readonly, except on create) + * The billed buyer corresponding to the buyer that created the offer. (readonly, except on create) */ billedBuyer?: Schema$Buyer; /** - * The buyer that created the offer if this is a buyer initiated offer - * (readonly, except on create) + * The buyer that created the offer if this is a buyer initiated offer (readonly, except on create) */ buyer?: Schema$Buyer; /** @@ -1383,8 +1204,7 @@ export namespace adexchangebuyer_v1_4 { */ creationTimeMs?: string; /** - * Optional contact information for the creator of this product. - * (buyer-readonly) + * Optional contact information for the creator of this product. (buyer-readonly) */ creatorContacts?: Schema$ContactInformation[]; /** @@ -1392,10 +1212,7 @@ export namespace adexchangebuyer_v1_4 { */ creatorRole?: string; /** - * The set of fields around delivery control that are interesting for a - * buyer to see but are non-negotiable. These are set by the publisher. This - * message is assigned an id of 100 since some day we would want to model - * this as a protobuf extension. + * The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. */ deliveryControl?: Schema$DeliveryControl; /** @@ -1403,15 +1220,11 @@ export namespace adexchangebuyer_v1_4 { */ flightEndTimeMs?: string; /** - * Inventory availability dates. (times are in ms since epoch) The - * granularity is generally in the order of seconds. (buyer-readonly) + * Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly) */ flightStartTimeMs?: string; /** - * If the creator has already signed off on the product, then the buyer can - * finalize the deal by accepting the product as is. When copying to a - * proposal, if any of the terms are changed, then auto_finalize is - * automatically set to false. + * If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. */ hasCreatorSignedOff?: boolean; /** @@ -1419,8 +1232,7 @@ export namespace adexchangebuyer_v1_4 { */ inventorySource?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "adexchangebuyer#product". + * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product". */ kind?: string; /** @@ -1436,10 +1248,7 @@ export namespace adexchangebuyer_v1_4 { */ legacyOfferId?: string; /** - * Marketplace publisher profile Id. This Id differs from the regular - * publisher_profile_id in that 1. This is a new id, the old Id will be - * deprecated in 2017. 2. This id uniquely identifies a publisher profile by - * itself. + * Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself. */ marketplacePublisherProfileId?: string; /** @@ -1455,10 +1264,7 @@ export namespace adexchangebuyer_v1_4 { */ productId?: string; /** - * Id of the publisher profile for a given seller. A (seller.account_id, - * publisher_profile_id) pair uniquely identifies a publisher profile. - * Buyers can call the PublisherProfiles::List endpoint to get a list of - * publisher profiles for a given seller. + * Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller. */ publisherProfileId?: string; /** @@ -1470,14 +1276,11 @@ export namespace adexchangebuyer_v1_4 { */ revisionNumber?: string; /** - * Information about the seller that created this product (readonly, except - * on create) + * Information about the seller that created this product (readonly, except on create) */ seller?: Schema$Seller; /** - * Targeting that is shared between the buyer and the seller. Each targeting - * criteria has a specified key and for each key there is a list of - * inclusion value or exclusion values. (buyer-readonly) + * Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly) */ sharedTargetings?: Schema$SharedTargeting[]; /** @@ -1485,8 +1288,7 @@ export namespace adexchangebuyer_v1_4 { */ state?: string; /** - * The syndication product associated with the deal. (readonly, except on - * create) + * The syndication product associated with the deal. (readonly, except on create) */ syndicationProduct?: string; /** @@ -1494,19 +1296,12 @@ export namespace adexchangebuyer_v1_4 { */ terms?: Schema$DealTerms; /** - * The web property code for the seller. This field is meant to be copied - * over as is when creating deals. + * The web property code for the seller. This field is meant to be copied over as is when creating deals. */ webPropertyCode?: string; } /** - * Represents a proposal in the marketplace. A proposal is the unit of - * negotiation between a seller and a buyer and contains deals which are - * served. Each field in a proposal can have one of the following setting: - * (readonly) - It is an error to try and set this field. (buyer-readonly) - - * Only the seller can set this field. (seller-readonly) - Only the buyer can - * set this field. (updatable) - The field is updatable at all times by either - * buyer or the seller. + * Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. */ export interface Schema$Proposal { /** @@ -1530,15 +1325,11 @@ export namespace adexchangebuyer_v1_4 { */ dbmAdvertiserIds?: string[]; /** - * When an proposal is in an accepted state, indicates whether the buyer has - * signed off. Once both sides have signed off on a deal, the proposal can - * be finalized by the seller. (seller-readonly) + * When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) */ hasBuyerSignedOff?: boolean; /** - * When an proposal is in an accepted state, indicates whether the buyer has - * signed off Once both sides have signed off on a deal, the proposal can be - * finalized by the seller. (buyer-readonly) + * When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) */ hasSellerSignedOff?: boolean; /** @@ -1550,14 +1341,11 @@ export namespace adexchangebuyer_v1_4 { */ isRenegotiating?: boolean; /** - * True, if the buyside inventory setup is complete for this proposal. - * (readonly, except via OrderSetupCompleted action) Deprecated in favor of - * deal level setup complete flag. + * True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag. */ isSetupComplete?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "adexchangebuyer#proposal". + * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". */ kind?: string; /** @@ -1565,8 +1353,7 @@ export namespace adexchangebuyer_v1_4 { */ labels?: Schema$MarketplaceLabel[]; /** - * The role of the last user that either updated the proposal or left a - * comment. (readonly) + * The role of the last user that either updated the proposal or left a comment. (readonly) */ lastUpdaterOrCommentorRole?: string; /** @@ -1582,8 +1369,7 @@ export namespace adexchangebuyer_v1_4 { */ originatorRole?: string; /** - * Optional private auction id if this proposal is a private auction - * proposal. + * Optional private auction id if this proposal is a private auction proposal. */ privateAuctionId?: string; /** @@ -1633,8 +1419,7 @@ export namespace adexchangebuyer_v1_4 { */ googlePlusLink?: string; /** - * True, if this is the parent profile, which represents all domains owned - * by the publisher. + * True, if this is the parent profile, which represents all domains owned by the publisher. */ isParent?: boolean; /** @@ -1642,8 +1427,7 @@ export namespace adexchangebuyer_v1_4 { */ isPublished?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "adexchangebuyer#publisherProfileApiProto". + * Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#publisherProfileApiProto". */ kind?: string; /** @@ -1660,8 +1444,7 @@ export namespace adexchangebuyer_v1_4 { */ overview?: string; /** - * The pair of (seller.account_id, profile_id) uniquely identifies a - * publisher profile for a given publisher. + * The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher. */ profileId?: number; /** @@ -1669,8 +1452,7 @@ export namespace adexchangebuyer_v1_4 { */ programmaticContact?: string; /** - * The list of domains represented in this publisher profile. Empty if this - * is a parent profile. + * The list of domains represented in this publisher profile. Empty if this is a parent profile. */ publisherDomains?: string[]; /** @@ -1721,8 +1503,7 @@ export namespace adexchangebuyer_v1_4 { } export interface Schema$Seller { /** - * The unique id for the seller. The seller fills in this field. The seller - * account id is then available to buyer in the product. + * The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. */ accountId?: string; /** @@ -1732,13 +1513,11 @@ export namespace adexchangebuyer_v1_4 { } export interface Schema$SharedTargeting { /** - * The list of values to exclude from targeting. Each value is AND'd - * together. + * The list of values to exclude from targeting. Each value is AND'd together. */ exclusions?: Schema$TargetingValue[]; /** - * The list of value to include as part of the targeting. Each value is - * OR'd together. + * The list of value to include as part of the targeting. Each value is OR'd together. */ inclusions?: Schema$TargetingValue[]; /** @@ -1752,8 +1531,7 @@ export namespace adexchangebuyer_v1_4 { */ creativeSizeValue?: Schema$TargetingValueCreativeSize; /** - * The daypart targeting to include / exclude. Filled in when the key is - * GOOG_DAYPART_TARGETING. + * The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. */ dayPartTargetingValue?: Schema$TargetingValueDayPartTargeting; demogAgeCriteriaValue?: Schema$TargetingValueDemogAgeCriteria; @@ -1788,8 +1566,7 @@ export namespace adexchangebuyer_v1_4 { */ nativeTemplate?: string; /** - * For regular or video creative size type, specifies the size of the - * creative. + * For regular or video creative size type, specifies the size of the creative. */ size?: Schema$TargetingValueSize; /** @@ -2205,8 +1982,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.billingInfo.get - * @desc Returns the billing information for one account specified by - * account ID. + * @desc Returns the billing information for one account specified by account ID. * @alias adexchangebuyer.billingInfo.get * @memberOf! () * @@ -2278,8 +2054,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.billingInfo.list - * @desc Retrieves a list of billing information for all accounts of the - * authenticated user. + * @desc Retrieves a list of billing information for all accounts of the authenticated user. * @alias adexchangebuyer.billingInfo.list * @memberOf! () * @@ -2376,8 +2151,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.budget.get - * @desc Returns the budget information for the adgroup specified by the - * accountId and billingId. + * @desc Returns the budget information for the adgroup specified by the accountId and billingId. * @alias adexchangebuyer.budget.get * @memberOf! () * @@ -2449,9 +2223,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.budget.patch - * @desc Updates the budget amount for the budget of the adgroup specified - * by the accountId and billingId, with the budget amount in the request. - * This method supports patch semantics. + * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics. * @alias adexchangebuyer.budget.patch * @memberOf! () * @@ -2524,8 +2296,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.budget.update - * @desc Updates the budget amount for the budget of the adgroup specified - * by the accountId and billingId, with the budget amount in the request. + * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. * @alias adexchangebuyer.budget.update * @memberOf! () * @@ -2735,8 +2506,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.creatives.get - * @desc Gets the status for a single creative. A creative will be available - * 30-40 minutes after submission. + * @desc Gets the status for a single creative. A creative will be available 30-40 minutes after submission. * @alias adexchangebuyer.creatives.get * @memberOf! () * @@ -2879,8 +2649,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.creatives.list - * @desc Retrieves a list of the authenticated user's active creatives. A - * creative will be available 30-40 minutes after submission. + * @desc Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. * @alias adexchangebuyer.creatives.list * @memberOf! () * @@ -3163,29 +2932,23 @@ export namespace adexchangebuyer_v1_4 { */ accountId?: number[]; /** - * When specified, only creatives for the given buyer creative ids are - * returned. + * When specified, only creatives for the given buyer creative ids are returned. */ buyerCreativeId?: string[]; /** - * When specified, only creatives having the given deals status are - * returned. + * When specified, only creatives having the given deals status are returned. */ dealsStatusFilter?: string; /** - * Maximum number of entries returned on one result page. If not set, the - * default is 100. Optional. + * Maximum number of entries returned on one result page. If not set, the default is 100. Optional. */ maxResults?: number; /** - * When specified, only creatives having the given open auction status are - * returned. + * When specified, only creatives having the given open auction status are returned. */ openAuctionStatusFilter?: string; /** - * A continuation token, used to page through ad clients. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. Optional. + * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. */ pageToken?: string; } @@ -3593,8 +3356,7 @@ export namespace adexchangebuyer_v1_4 { */ pqlQuery?: string; /** - * The proposalId to get deals for. To search across all proposals specify - * order_id = '-' as part of the URL. + * The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL. */ proposalId?: string; } @@ -3801,14 +3563,11 @@ export namespace adexchangebuyer_v1_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Query string to retrieve specific notes. To search the text contents of - * notes, please use syntax like "WHERE note.note = "foo" or "WHERE - * note.note LIKE "%bar%" + * Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%" */ pqlQuery?: string; /** - * The proposalId to get notes for. To search across all proposals specify - * order_id = '-' as part of the URL. + * The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL. */ proposalId?: string; } @@ -4014,14 +3773,11 @@ export namespace adexchangebuyer_v1_4 { */ endDateTime?: string; /** - * Maximum number of entries returned on one result page. If not set, the - * default is 100. Optional. + * Maximum number of entries returned on one result page. If not set, the default is 100. Optional. */ maxResults?: number; /** - * A continuation token, used to page through performance reports. To - * retrieve the next page, set this parameter to the value of - * "nextPageToken" from the previous response. Optional. + * A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. */ pageToken?: string; /** @@ -4260,8 +4016,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.pretargetingConfig.list - * @desc Retrieves a list of the authenticated user's pretargeting - * configurations. + * @desc Retrieves a list of the authenticated user's pretargeting configurations. * @alias adexchangebuyer.pretargetingConfig.list * @memberOf! () * @@ -4336,8 +4091,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.pretargetingConfig.patch - * @desc Updates an existing pretargeting config. This method supports patch - * semantics. + * @desc Updates an existing pretargeting config. This method supports patch semantics. * @alias adexchangebuyer.pretargetingConfig.patch * @memberOf! () * @@ -5065,8 +4819,7 @@ export namespace adexchangebuyer_v1_4 { /** * adexchangebuyer.proposals.setupcomplete - * @desc Update the given proposal to indicate that setup has been - * completed. + * @desc Update the given proposal to indicate that setup has been completed. * @alias adexchangebuyer.proposals.setupcomplete * @memberOf! () * @@ -5244,15 +4997,11 @@ export namespace adexchangebuyer_v1_4 { */ proposalId?: string; /** - * The last known revision number to update. If the head revision in the - * marketplace database has since changed, an error will be thrown. The - * caller should then fetch the latest proposal at head revision and retry - * the update at that revision. + * The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. */ revisionNumber?: string; /** - * The proposed action to take on the proposal. This field is required and - * it must be set when updating a proposal. + * The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. */ updateAction?: string; @@ -5295,15 +5044,11 @@ export namespace adexchangebuyer_v1_4 { */ proposalId?: string; /** - * The last known revision number to update. If the head revision in the - * marketplace database has since changed, an error will be thrown. The - * caller should then fetch the latest proposal at head revision and retry - * the update at that revision. + * The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. */ revisionNumber?: string; /** - * The proposed action to take on the proposal. This field is required and - * it must be set when updating a proposal. + * The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. */ updateAction?: string; diff --git a/src/apis/adexchangebuyer2/package.json b/src/apis/adexchangebuyer2/package.json index 1b5c8efb10a..4260fda5099 100644 --- a/src/apis/adexchangebuyer2/package.json +++ b/src/apis/adexchangebuyer2/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 5ae31aafec7..d730f368208 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace adexchangebuyer2_v2beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace adexchangebuyer2_v2beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * Ad Exchange Buyer API II * - * Accesses the latest features for managing Authorized Buyers accounts, - * Real-Time Bidding configurations and auction metrics, and Marketplace - * programmatic deals. + * Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace adexchangebuyer2_v2beta1 { bidders: Resource$Bidders; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.bidders = new Resource$Bidders(this.context); @@ -123,21 +120,15 @@ export namespace adexchangebuyer2_v2beta1 { } /** - * An absolute date range, specified by its start date and end date. The - * supported range of dates begins 30 days before today and ends today. - * Validity checked upon filter set creation. If a filter set with an absolute - * date range is run at a later date more than 30 days after start_date, it - * will fail. + * An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. */ export interface Schema$AbsoluteDateRange { /** - * The end date of the range (inclusive). Must be within the 30 days leading - * up to current date, and must be equal to or after start_date. + * The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. */ endDate?: Schema$Date; /** - * The start date of the range (inclusive). Must be within the 30 days - * leading up to current date, and must be equal to or before end_date. + * The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date. */ startDate?: Schema$Date; } @@ -173,8 +164,7 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$AdSize { /** - * The height of the ad slot in pixels. This field will be present only when - * size type is `PIXEL`. + * The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */ height?: string; /** @@ -182,13 +172,12 @@ export namespace adexchangebuyer2_v2beta1 { */ sizeType?: string; /** - * The width of the ad slot in pixels. This field will be present only when - * size type is `PIXEL`. + * The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. */ width?: string; } /** - * @OutputOnly The app type the restriction applies to for mobile device. + * Output only. The app type the restriction applies to for mobile device. */ export interface Schema$AppContext { /** @@ -197,7 +186,7 @@ export namespace adexchangebuyer2_v2beta1 { appTypes?: string[]; } /** - * @OutputOnly The auction type the restriction applies to. + * Output only. The auction type the restriction applies to. */ export interface Schema$AuctionContext { /** @@ -206,9 +195,7 @@ export namespace adexchangebuyer2_v2beta1 { auctionTypes?: string[]; } /** - * The set of metrics that are measured in numbers of bids, representing how - * many bids with the specified dimension values were considered eligible at - * each stage of the bidding funnel; + * The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel; */ export interface Schema$BidMetricsRow { /** @@ -228,8 +215,7 @@ export namespace adexchangebuyer2_v2beta1 { */ impressionsWon?: Schema$MetricValue; /** - * The number of bids for which the corresponding impression was measurable - * for viewability (as defined by Active View). + * The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View). */ measurableImpressions?: Schema$MetricValue; /** @@ -237,20 +223,16 @@ export namespace adexchangebuyer2_v2beta1 { */ rowDimensions?: Schema$RowDimensions; /** - * The number of bids for which the corresponding impression was viewable - * (as defined by Active View). + * The number of bids for which the corresponding impression was viewable (as defined by Active View). */ viewableImpressions?: Schema$MetricValue; } /** - * The number of impressions with the specified dimension values that were - * considered to have no applicable bids, as described by the specified - * status. + * The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status. */ export interface Schema$BidResponseWithoutBidsStatusRow { /** - * The number of impressions for which there was a bid response with the - * specified status. + * The number of impressions for which there was a bid response with the specified status. */ impressionCount?: Schema$MetricValue; /** @@ -258,14 +240,12 @@ export namespace adexchangebuyer2_v2beta1 { */ rowDimensions?: Schema$RowDimensions; /** - * The status specifying why the bid responses were considered to have no - * applicable bids. + * The status specifying why the bid responses were considered to have no applicable bids. */ status?: string; } /** - * Represents a buyer of inventory. Each buyer is identified by a unique - * Authorized Buyers account ID. + * Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. */ export interface Schema$Buyer { /** @@ -274,19 +254,15 @@ export namespace adexchangebuyer2_v2beta1 { accountId?: string; } /** - * The number of impressions with the specified dimension values where the - * corresponding bid request or bid response was not successful, as described - * by the specified callout status. + * The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status. */ export interface Schema$CalloutStatusRow { /** - * The ID of the callout status. See - * [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). + * The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). */ calloutStatusId?: number; /** - * The number of impressions for which there was a bid request or bid - * response with the specified callout status. + * The number of impressions for which there was a bid request or bid response with the specified callout status. */ impressionCount?: Schema$MetricValue; /** @@ -299,44 +275,23 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$CancelNegotiationRequest {} /** - * A client resource represents a client buyer&mdash;an agency, a brand, - * or an advertiser customer of the sponsor buyer. Users associated with the - * client buyer have restricted access to the Marketplace and certain other - * sections of the Authorized Buyers UI based on the role granted to the - * client buyer. All fields are required unless otherwise specified. + * A client resource represents a client buyer&mdash;an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the client buyer. All fields are required unless otherwise specified. */ export interface Schema$Client { /** - * The globally-unique numerical ID of the client. The value of this field - * is ignored in create and update operations. + * The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. */ clientAccountId?: string; /** - * Name used to represent this client to publishers. You may have multiple - * clients that map to the same entity, but for each client the combination - * of `clientName` and entity must be unique. You can specify this field as - * empty. + * Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty. */ clientName?: string; /** - * Numerical identifier of the client entity. The entity can be an - * advertiser, a brand, or an agency. This identifier is unique among all - * the entities with the same type. A list of all known advertisers with - * their identifiers is available in the - * [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) - * file. A list of all known brands with their identifiers is available in - * the - * [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) - * file. A list of all known agencies with their identifiers is available - * in the - * [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) - * file. + * Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file. */ entityId?: string; /** - * The name of the entity. This field is automatically fetched based on the - * type and ID. The value of this field is ignored in create and update - * operations. + * The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations. */ entityName?: string; /** @@ -344,19 +299,11 @@ export namespace adexchangebuyer2_v2beta1 { */ entityType?: string; /** - * Optional arbitrary unique identifier of this client buyer from the - * standpoint of its Ad Exchange sponsor buyer. This field can be used to - * associate a client buyer with the identifier in the namespace of its - * sponsor buyer, lookup client buyers by that identifier and verify whether - * an Ad Exchange counterpart of a given client buyer already exists. If - * present, must be unique among all the client buyers for its Ad Exchange - * sponsor buyer. + * Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer. */ partnerClientId?: string; /** - * The role which is assigned to the client buyer. Each role implies a set - * of permissions granted to the client. Must be one of - * `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. + * The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. */ role?: string; /** @@ -369,23 +316,15 @@ export namespace adexchangebuyer2_v2beta1 { visibleToSeller?: boolean; } /** - * A client user is created under a client buyer and has restricted access to - * the Marketplace and certain other sections of the Authorized Buyers UI - * based on the role granted to the associated client buyer. The only way a - * new client user can be created is via accepting an email invitation (see - * the accounts.clients.invitations.create method). All fields are required - * unless otherwise specified. + * A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. */ export interface Schema$ClientUser { /** - * Numerical account ID of the client buyer with which the user is - * associated; the buyer must be a client of the current sponsor buyer. The - * value of this field is ignored in an update operation. + * Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. */ clientAccountId?: string; /** - * User's email address. The value of this field is ignored in an update - * operation. + * User's email address. The value of this field is ignored in an update operation. */ email?: string; /** @@ -393,35 +332,29 @@ export namespace adexchangebuyer2_v2beta1 { */ status?: string; /** - * The unique numerical ID of the client user that has accepted an - * invitation. The value of this field is ignored in an update operation. + * The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. */ userId?: string; } /** - * An invitation for a new client user to get access to the Authorized Buyers - * UI. All fields are required unless otherwise specified. + * An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified. */ export interface Schema$ClientUserInvitation { /** - * Numerical account ID of the client buyer that the invited user is - * associated with. The value of this field is ignored in create operations. + * Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations. */ clientAccountId?: string; /** - * The email address to which the invitation is sent. Email addresses should - * be unique among all client users under each sponsor buyer. + * The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer. */ email?: string; /** - * The unique numerical ID of the invitation that is sent to the user. The - * value of this field is ignored in create operations. + * The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations. */ invitationId?: string; } /** - * Request message for indicating that the proposal's setup step is - * complete. + * Request message for indicating that the proposal's setup step is complete. */ export interface Schema$CompleteSetupRequest {} /** @@ -438,7 +371,7 @@ export namespace adexchangebuyer2_v2beta1 { name?: string; } /** - * @OutputOnly Shows any corrections that were applied to this creative. + * Output only. Shows any corrections that were applied to this creative. */ export interface Schema$Correction { /** @@ -459,8 +392,7 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$Creative { /** - * The account that this creative belongs to. Can be used to filter the - * response of the creatives.list method. + * The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */ accountId?: string; /** @@ -476,12 +408,11 @@ export namespace adexchangebuyer2_v2beta1 { */ agencyId?: string; /** - * @OutputOnly The last update timestamp of the creative via API. + * Output only. The last update timestamp of the creative via API. */ apiUpdateTime?: string; /** - * All attributes for the ads that may be shown from this creative. Can be - * used to filter the response of the creatives.list method. + * All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. */ attributes?: string[]; /** @@ -489,21 +420,15 @@ export namespace adexchangebuyer2_v2beta1 { */ clickThroughUrls?: string[]; /** - * @OutputOnly Shows any corrections that were applied to this creative. + * Output only. Shows any corrections that were applied to this creative. */ corrections?: Schema$Correction[]; /** - * The buyer-defined creative ID of this creative. Can be used to filter the - * response of the creatives.list method. + * The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. */ creativeId?: string; /** - * @OutputOnly The top-level deals status of this creative. If disapproved, - * an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in - * serving_restrictions will also exist. Note that this may be nuanced with - * other contextual restrictions, in which case, it may be preferable to - * read from serving_restrictions directly. Can be used to filter the - * response of the creatives.list method. + * Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. */ dealsStatus?: string; /** @@ -511,37 +436,25 @@ export namespace adexchangebuyer2_v2beta1 { */ declaredClickThroughUrls?: string[]; /** - * @OutputOnly Detected advertiser IDs, if any. + * Output only. Detected advertiser IDs, if any. */ detectedAdvertiserIds?: string[]; /** - * @OutputOnly The detected domains for this creative. + * Output only. The detected domains for this creative. */ detectedDomains?: string[]; /** - * @OutputOnly The detected languages for this creative. The order is - * arbitrary. The codes are 2 or 5 characters and are documented at - * https://developers.google.com/adwords/api/docs/appendix/languagecodes. + * Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. */ detectedLanguages?: string[]; /** - * @OutputOnly Detected product categories, if any. See the - * ad-product-categories.txt file in the technical documentation for a list - * of IDs. + * Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. */ detectedProductCategories?: number[]; /** - * @OutputOnly Detected sensitive categories, if any. See the - * ad-sensitive-categories.txt file in the technical documentation for a - * list of IDs. You should use these IDs along with the - * excluded-sensitive-category field in the bid request to filter your bids. + * Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. */ detectedSensitiveCategories?: number[]; - /** - * @OutputOnly The filtering stats for this creative. Deprecated; please use - * bidders.accounts.filterSets.filteredBids.creatives.list method instead. - */ - filteringStats?: Schema$FilteringStats; /** * An HTML creative. */ @@ -555,34 +468,23 @@ export namespace adexchangebuyer2_v2beta1 { */ native?: Schema$NativeContent; /** - * @OutputOnly The top-level open auction status of this creative. If - * disapproved, an entry for 'auctionType = OPEN_AUCTION' (or - * 'ALL') in serving_restrictions will also exist. Note that this - * may be nuanced with other contextual restrictions, in which case, it may - * be preferable to read from serving_restrictions directly. Can be used to - * filter the response of the creatives.list method. + * Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. */ openAuctionStatus?: string; /** - * All restricted categories for the ads that may be shown from this - * creative. + * All restricted categories for the ads that may be shown from this creative. */ restrictedCategories?: string[]; /** - * @OutputOnly The granular status of this ad in specific contexts. A - * context here relates to where something ultimately serves (for example, a - * physical location, a platform, an HTTPS vs HTTP request, or the type of - * auction). + * Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). */ servingRestrictions?: Schema$ServingRestriction[]; /** - * All vendor IDs for the ads that may be shown from this creative. See - * https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for - * possible values. + * All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. */ vendorIds?: number[]; /** - * @OutputOnly The version of this creative. + * Output only. The version of this creative. */ version?: number; /** @@ -608,9 +510,7 @@ export namespace adexchangebuyer2_v2beta1 { dealsId?: string; } /** - * Represents creative restrictions associated to Programmatic Guaranteed/ - * Preferred Deal in Ad Manager. This doesn't apply to Private Auction and - * AdX Preferred Deals. + * Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. */ export interface Schema$CreativeRestrictions { /** @@ -628,15 +528,11 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$CreativeSize { /** - * What formats are allowed by the publisher. If this repeated field is - * empty then all formats are allowed. For example, if this field contains - * AllowedFormatType.AUDIO then the publisher only allows an audio ad - * (without any video). + * What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). */ allowedFormats?: string[]; /** - * For video creatives specifies the sizes of companion ads (if present). - * Companion sizes may be filled in only when creative_size_type = VIDEO + * For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO */ companionSizes?: Schema$Size[]; /** @@ -644,24 +540,20 @@ export namespace adexchangebuyer2_v2beta1 { */ creativeSizeType?: string; /** - * The native template for this creative. It will have a value only if - * creative_size_type = CreativeSizeType.NATIVE. @OutputOnly + * Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. */ nativeTemplate?: string; /** - * For regular or video creative size type, specifies the size of the - * creative + * For regular or video creative size type, specifies the size of the creative */ size?: Schema$Size; /** - * The type of skippable ad for this creative. It will have a value only if - * creative_size_type = CreativeSizeType.VIDEO. + * The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. */ skippableAdType?: string; } /** - * Represents information for a creative that is associated with a - * Programmatic Guaranteed/Preferred Deal in Ad Manager. + * Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. */ export interface Schema$CreativeSpecification { /** @@ -674,9 +566,7 @@ export namespace adexchangebuyer2_v2beta1 { creativeSize?: Schema$AdSize; } /** - * The number of bids with the specified dimension values that did not win the - * auction (either were filtered pre-auction or lost the auction), as - * described by the specified creative status. + * The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status. */ export interface Schema$CreativeStatusRow { /** @@ -684,8 +574,7 @@ export namespace adexchangebuyer2_v2beta1 { */ bidCount?: Schema$MetricValue; /** - * The ID of the creative status. See - * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). + * The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). */ creativeStatusId?: number; /** @@ -694,8 +583,7 @@ export namespace adexchangebuyer2_v2beta1 { rowDimensions?: Schema$RowDimensions; } /** - * Generic targeting used for targeting dimensions that contains a list of - * included and excluded numeric IDs. + * Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. */ export interface Schema$CriteriaTargeting { /** @@ -708,36 +596,24 @@ export namespace adexchangebuyer2_v2beta1 { targetedCriteriaIds?: string[]; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } /** - * Daypart targeting message that specifies if the ad can be shown only during - * certain parts of a day/week. + * Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. */ export interface Schema$DayPart { /** @@ -745,15 +621,11 @@ export namespace adexchangebuyer2_v2beta1 { */ dayOfWeek?: string; /** - * The ending time of the day for the ad to show (minute level granularity). - * The end time is exclusive. This field is not available for filtering in - * PQL queries. + * The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. */ endTime?: Schema$TimeOfDay; /** - * The starting time of day for the ad to show (minute level granularity). - * The start time is inclusive. This field is not available for filtering in - * PQL queries. + * The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. */ startTime?: Schema$TimeOfDay; } @@ -771,22 +643,15 @@ export namespace adexchangebuyer2_v2beta1 { timeZoneType?: string; } /** - * A deal represents a segment of inventory for displaying ads on. A proposal - * can contain multiple deals. A deal contains the terms and targeting - * information that is used for serving. + * A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. */ export interface Schema$Deal { /** - * Proposed flight end time of the deal. This will generally be stored in a - * granularity of a second. A value is not required for Private Auction - * deals or Preferred Deals. + * Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. */ availableEndTime?: string; /** - * Optional proposed flight start time of the deal. This will generally be - * stored in the granularity of one second since deal serving starts at - * seconds boundary. Any time specified with more granularity (e.g., in - * milliseconds) will be truncated towards the start of time in seconds. + * Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. */ availableStartTime?: string; /** @@ -794,44 +659,35 @@ export namespace adexchangebuyer2_v2beta1 { */ buyerPrivateData?: Schema$PrivateData; /** - * The product ID from which this deal was created. Note: This field may be - * set only when creating the resource. Modifying this field while updating - * the resource will result in an error. + * The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ createProductId?: string; /** - * Optional revision number of the product that the deal was created from. - * If present on create, and the server `product_revision` has advanced - * sinced the passed-in `create_product_revision`, an `ABORTED` error will - * be returned. Note: This field may be set only when creating the - * resource. Modifying this field while updating the resource will result in - * an error. + * Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ createProductRevision?: string; /** - * The time of the deal creation. @OutputOnly + * Output only. The time of the deal creation. */ createTime?: string; /** - * Specifies the creative pre-approval policy. @OutputOnly + * Output only. Specifies the creative pre-approval policy. */ creativePreApprovalPolicy?: string; /** - * Restricitions about the creatives associated with the deal (i.e., size) - * This is available for Programmatic Guaranteed/Preferred Deals in Ad - * Manager. @OutputOnly + * Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. */ creativeRestrictions?: Schema$CreativeRestrictions; /** - * Specifies whether the creative is safeFrame compatible. @OutputOnly + * Output only. Specifies whether the creative is safeFrame compatible. */ creativeSafeFrameCompatibility?: string; /** - * A unique deal ID for the deal (server-assigned). @OutputOnly + * Output only. A unique deal ID for the deal (server-assigned). */ dealId?: string; /** - * Metadata about the serving status of this deal. @OutputOnly + * Output only. Metadata about the serving status of this deal. */ dealServingMetadata?: Schema$DealServingMetadata; /** @@ -839,8 +695,7 @@ export namespace adexchangebuyer2_v2beta1 { */ dealTerms?: Schema$DealTerms; /** - * The set of fields around delivery control that are interesting for a - * buyer to see but are non-negotiable. These are set by the publisher. + * The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. */ deliveryControl?: Schema$DeliveryControl; /** @@ -852,46 +707,39 @@ export namespace adexchangebuyer2_v2beta1 { */ displayName?: string; /** - * The external deal ID assigned to this deal once the deal is finalized. - * This is the deal ID that shows up in serving/reporting etc. @OutputOnly + * Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. */ externalDealId?: string; /** - * True, if the buyside inventory setup is complete for this deal. - * @OutputOnly + * Output only. True, if the buyside inventory setup is complete for this deal. */ isSetupComplete?: boolean; /** - * Specifies the creative source for programmatic deals. PUBLISHER means - * creative is provided by seller and ADVERTISER means creative is provided - * by buyer. @OutputOnly + * Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. */ programmaticCreativeSource?: string; /** - * ID of the proposal that this deal is part of. @OutputOnly + * Output only. ID of the proposal that this deal is part of. */ proposalId?: string; /** - * Seller contact information for the deal. @OutputOnly + * Output only. Seller contact information for the deal. */ sellerContacts?: Schema$ContactInformation[]; /** - * The syndication product associated with the deal. Note: This field may - * be set only when creating the resource. Modifying this field while - * updating the resource will result in an error. + * The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ syndicationProduct?: string; /** - * Specifies the subset of inventory targeted by the deal. @OutputOnly + * Output only. Specifies the subset of inventory targeted by the deal. */ targeting?: Schema$MarketplaceTargeting; /** - * The shared targeting visible to buyers and sellers. Each shared targeting - * entity is AND'd together. + * The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. */ targetingCriterion?: Schema$TargetingCriteria[]; /** - * The time when the deal was last updated. @OutputOnly + * Output only. The time when the deal was last updated. */ updateTime?: string; /** @@ -900,8 +748,7 @@ export namespace adexchangebuyer2_v2beta1 { webPropertyCode?: string; } /** - * Tracks which parties (if any) have paused a deal. The deal is considered - * paused if either hasBuyerPaused or hasSellPaused is true. + * Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. */ export interface Schema$DealPauseStatus { /** @@ -930,14 +777,12 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$DealServingMetadata { /** - * Tracks which parties (if any) have paused a deal. @OutputOnly + * Output only. Tracks which parties (if any) have paused a deal. */ dealPauseStatus?: Schema$DealPauseStatus; } /** - * The deal terms specify the details of a Product/deal. They specify things - * like price per buyer, the type of pricing model (e.g., fixed price, - * auction) and expected impressions from the publisher. + * The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. */ export interface Schema$DealTerms { /** @@ -949,13 +794,11 @@ export namespace adexchangebuyer2_v2beta1 { */ description?: string; /** - * Non-binding estimate of the estimated gross spend for this deal. Can be - * set by buyer or seller. + * Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. */ estimatedGrossSpend?: Schema$Price; /** - * Non-binding estimate of the impressions served per day. Can be set by - * buyer or seller. + * Non-binding estimate of the impressions served per day. Can be set by buyer or seller. */ estimatedImpressionsPerDay?: string; /** @@ -971,10 +814,7 @@ export namespace adexchangebuyer2_v2beta1 { */ nonGuaranteedFixedPriceTerms?: Schema$NonGuaranteedFixedPriceTerms; /** - * The time zone name. For deals with Cost Per Day billing, defines the time - * zone used to mark the boundaries of a day. It should be an IANA TZ name, - * such as "America/Los_Angeles". For more information, see - * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. + * The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. */ sellerTimeZone?: string; } @@ -983,20 +823,20 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$DeliveryControl { /** - * Specified the creative blocking levels to be applied. @OutputOnly + * Output only. Specified the creative blocking levels to be applied. */ creativeBlockingLevel?: string; /** - * Specifies how the impression delivery will be paced. @OutputOnly + * Output only. Specifies how the impression delivery will be paced. */ deliveryRateType?: string; /** - * Specifies any frequency caps. @OutputOnly + * Output only. Specifies any frequency caps. */ frequencyCaps?: Schema$FrequencyCap[]; } /** - * @OutputOnly The reason and details for a disapproval. + * Output only. The reason and details for a disapproval. */ export interface Schema$Disapproval { /** @@ -1009,16 +849,11 @@ export namespace adexchangebuyer2_v2beta1 { reason?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * The number of filtered bids with the specified dimension values that have - * the specified creative. + * The number of filtered bids with the specified dimension values that have the specified creative. */ export interface Schema$FilteredBidCreativeRow { /** @@ -1035,9 +870,7 @@ export namespace adexchangebuyer2_v2beta1 { rowDimensions?: Schema$RowDimensions; } /** - * The number of filtered bids with the specified dimension values, among - * those filtered due to the requested filtering reason (i.e. creative - * status), that have the specified detail. + * The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail. */ export interface Schema$FilteredBidDetailRow { /** @@ -1045,8 +878,7 @@ export namespace adexchangebuyer2_v2beta1 { */ bidCount?: Schema$MetricValue; /** - * The ID of the detail. The associated value can be looked up in the - * dictionary file corresponding to the DetailType in the response message. + * The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message. */ detailId?: number; /** @@ -1055,52 +887,23 @@ export namespace adexchangebuyer2_v2beta1 { rowDimensions?: Schema$RowDimensions; } /** - * @OutputOnly Filtering reasons for this creative during a period of a single - * day (from midnight to midnight Pacific). - */ - export interface Schema$FilteringStats { - /** - * The day during which the data was collected. The data is collected from - * 00:00:00 to 23:59:59 PT. During switches from PST to PDT and back, the - * day may contain 23 or 25 hours of data instead of the usual 24. - */ - date?: Schema$Date; - /** - * The set of filtering reasons for this date. - */ - reasons?: Schema$Reason[]; - } - /** - * A set of filters that is applied to a request for data. Within a filter - * set, an AND operation is performed across the filters represented by each - * field. An OR operation is performed across the filters represented by the - * multiple values of a repeated field, e.g., "format=VIDEO AND - * deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". + * A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". */ export interface Schema$FilterSet { /** - * An absolute date range, defined by a start date and an end date. - * Interpreted relative to Pacific time zone. + * An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. */ absoluteDateRange?: Schema$AbsoluteDateRange; /** - * The set of dimensions along which to break down the response; may be - * empty. If multiple dimensions are requested, the breakdown is along the - * Cartesian product of the requested dimensions. + * The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. */ breakdownDimensions?: string[]; /** - * The ID of the creative on which to filter; optional. This field may be - * set only for a filter set that accesses account-level troubleshooting - * data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x - * pattern. + * The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern. */ creativeId?: string; /** - * The ID of the deal on which to filter; optional. This field may be set - * only for a filter set that accesses account-level troubleshooting data, - * i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x - * pattern. + * The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern. */ dealId?: string; /** @@ -1108,63 +911,40 @@ export namespace adexchangebuyer2_v2beta1 { */ environment?: string; /** - * The list of formats on which to filter; may be empty. The filters - * represented by multiple formats are ORed together (i.e., if non-empty, - * results must match any one of the formats). + * The list of formats on which to filter; may be empty. The filters represented by multiple formats are ORed together (i.e., if non-empty, results must match any one of the formats). */ formats?: string[]; /** - * A user-defined name of the filter set. Filter set names must be unique - * globally and match one of the patterns: - `bidders/x/filterSets/x (for - * accessing bidder-level troubleshooting data) - - * `bidders/x/accounts/x/filterSets/x (for accessing account-level - * troubleshooting data) This field is required in create operations. + * A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/x/filterSets/x (for accessing bidder-level troubleshooting data) - `bidders/x/accounts/x/filterSets/x (for accessing account-level troubleshooting data) This field is required in create operations. */ name?: string; /** - * The list of platforms on which to filter; may be empty. The filters - * represented by multiple platforms are ORed together (i.e., if non-empty, - * results must match any one of the platforms). + * The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). */ platforms?: string[]; /** - * For Open Bidding partners only. The list of publisher identifiers on - * which to filter; may be empty. The filters represented by multiple - * publisher identifiers are ORed together. + * For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. */ publisherIdentifiers?: string[]; /** - * An open-ended realtime time range, defined by the aggregation start - * timestamp. + * An open-ended realtime time range, defined by the aggregation start timestamp. */ realtimeTimeRange?: Schema$RealtimeTimeRange; /** - * A relative date range, defined by an offset from today and a duration. - * Interpreted relative to Pacific time zone. + * A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. */ relativeDateRange?: Schema$RelativeDateRange; /** - * For Authorized Buyers only. The list of IDs of the seller (publisher) - * networks on which to filter; may be empty. The filters represented by - * multiple seller network IDs are ORed together (i.e., if non-empty, - * results must match any one of the publisher networks). See - * [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) - * file for the set of existing seller network IDs. + * For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. */ sellerNetworkIds?: number[]; /** - * The granularity of time intervals if a time series breakdown is desired; - * optional. + * The granularity of time intervals if a time series breakdown is desired; optional. */ timeSeriesGranularity?: string; } /** - * Represents a list of targeted and excluded mobile application IDs that - * publishers own. Mobile application IDs are from App Store and Google Play - * Store. Android App ID, for example, com.google.android.apps.maps, can be - * found in Google Play Store URL. iOS App ID (which is a number) can be found - * at the end of iTunes store URL. First party mobile applications is either - * included or excluded. + * Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. */ export interface Schema$FirstPartyMobileApplicationTargeting { /** @@ -1181,18 +961,15 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$FrequencyCap { /** - * The maximum number of impressions that can be served to a user within the - * specified time period. + * The maximum number of impressions that can be served to a user within the specified time period. */ maxImpressions?: number; /** - * The amount of time, in the units specified by time_unit_type. Defines the - * amount of time over which impressions per user are counted and capped. + * The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. */ numTimeUnits?: number; /** - * The time unit. Along with num_time_units defines the amount of time over - * which impressions per user are counted and capped. + * The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. */ timeUnitType?: string; } @@ -1205,8 +982,7 @@ export namespace adexchangebuyer2_v2beta1 { */ fixedPrices?: Schema$PricePerBuyer[]; /** - * Guaranteed impressions as a percentage. This is the percentage of - * guaranteed looks that the buyer is guaranteeing to buy. + * Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. */ guaranteedImpressions?: string; /** @@ -1236,8 +1012,7 @@ export namespace adexchangebuyer2_v2beta1 { width?: number; } /** - * An image resource. You may provide a larger image than was requested, so - * long as the aspect ratio is preserved. + * An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. */ export interface Schema$Image { /** @@ -1254,29 +1029,23 @@ export namespace adexchangebuyer2_v2beta1 { width?: number; } /** - * The set of metrics that are measured in numbers of impressions, - * representing how many impressions with the specified dimension values were - * considered eligible at each stage of the bidding funnel. + * The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel. */ export interface Schema$ImpressionMetricsRow { /** - * The number of impressions available to the buyer on Ad Exchange. In some - * cases this value may be unavailable. + * The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable. */ availableImpressions?: Schema$MetricValue; /** - * The number of impressions for which Ad Exchange sent the buyer a bid - * request. + * The number of impressions for which Ad Exchange sent the buyer a bid request. */ bidRequests?: Schema$MetricValue; /** - * The number of impressions that match the buyer's inventory - * pretargeting. + * The number of impressions that match the buyer's inventory pretargeting. */ inventoryMatches?: Schema$MetricValue; /** - * The number of impressions for which Ad Exchange received a response from - * the buyer that contained at least one applicable bid. + * The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid. */ responsesWithBids?: Schema$MetricValue; /** @@ -1284,16 +1053,12 @@ export namespace adexchangebuyer2_v2beta1 { */ rowDimensions?: Schema$RowDimensions; /** - * The number of impressions for which the buyer successfully sent a - * response to Ad Exchange. + * The number of impressions for which the buyer successfully sent a response to Ad Exchange. */ successfulResponses?: Schema$MetricValue; } /** - * Represents the size of an ad unit that can be targeted on an ad request. It - * only applies to Private Auction, AdX Preferred Deals and Auction Packages. - * This targeting does not apply to Programmatic Guaranteed and Preferred - * Deals in Ad Manager. + * Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. */ export interface Schema$InventorySizeTargeting { /** @@ -1306,8 +1071,7 @@ export namespace adexchangebuyer2_v2beta1 { targetedInventorySizes?: Schema$AdSize[]; } /** - * Response message for listing the metrics that are measured in number of - * bids. + * Response message for listing the metrics that are measured in number of bids. */ export interface Schema$ListBidMetricsResponse { /** @@ -1315,15 +1079,12 @@ export namespace adexchangebuyer2_v2beta1 { */ bidMetricsRows?: Schema$BidMetricsRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListBidMetricsRequest.pageToken field in the subsequent call to the - * bidMetrics.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics.list method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing all reasons that bid responses resulted in an - * error. + * Response message for listing all reasons that bid responses resulted in an error. */ export interface Schema$ListBidResponseErrorsResponse { /** @@ -1331,27 +1092,20 @@ export namespace adexchangebuyer2_v2beta1 { */ calloutStatusRows?: Schema$CalloutStatusRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListBidResponseErrorsRequest.pageToken field in the subsequent call to - * the bidResponseErrors.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListBidResponseErrorsRequest.pageToken field in the subsequent call to the bidResponseErrors.list method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing all reasons that bid responses were considered - * to have no applicable bids. + * Response message for listing all reasons that bid responses were considered to have no applicable bids. */ export interface Schema$ListBidResponsesWithoutBidsResponse { /** - * List of rows, with counts of bid responses without bids aggregated by - * status. + * List of rows, with counts of bid responses without bids aggregated by status. */ bidResponseWithoutBidsStatusRows?: Schema$BidResponseWithoutBidsStatusRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call - * to the bidResponsesWithoutBids.list method to retrieve the next page of - * results. + * A token to retrieve the next page of results. Pass this value in the ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to the bidResponsesWithoutBids.list method to retrieve the next page of results. */ nextPageToken?: string; } @@ -1361,9 +1115,7 @@ export namespace adexchangebuyer2_v2beta1 { */ clients?: Schema$Client[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListClientsRequest.pageToken field in the subsequent call to the - * accounts.clients.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the next page of results. */ nextPageToken?: string; } @@ -1373,18 +1125,13 @@ export namespace adexchangebuyer2_v2beta1 { */ invitations?: Schema$ClientUserInvitation[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListClientUserInvitationsRequest.pageToken field in the subsequent call - * to the clients.invitations.list method to retrieve the next page of - * results. + * A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results. */ nextPageToken?: string; } export interface Schema$ListClientUsersResponse { /** - * A token to retrieve the next page of results. Pass this value in the - * ListClientUsersRequest.pageToken field in the subsequent call to the - * clients.invitations.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results. */ nextPageToken?: string; /** @@ -1401,33 +1148,25 @@ export namespace adexchangebuyer2_v2beta1 { */ creatives?: Schema$Creative[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListCreativesRequest.page_token field in the subsequent call to - * `ListCreatives` method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing all creatives associated with a given filtered - * bid reason. + * Response message for listing all creatives associated with a given filtered bid reason. */ export interface Schema$ListCreativeStatusBreakdownByCreativeResponse { /** - * List of rows, with counts of bids with a given creative status aggregated - * by creative. + * List of rows, with counts of bids with a given creative status aggregated by creative. */ filteredBidCreativeRows?: Schema$FilteredBidCreativeRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the - * subsequent call to the filteredBids.creatives.list method to retrieve the - * next page of results. + * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent call to the filteredBids.creatives.list method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing all details associated with a given filtered - * bid reason. + * Response message for listing all details associated with a given filtered bid reason. */ export interface Schema$ListCreativeStatusBreakdownByDetailResponse { /** @@ -1435,15 +1174,11 @@ export namespace adexchangebuyer2_v2beta1 { */ detailType?: string; /** - * List of rows, with counts of bids with a given creative status aggregated - * by detail. + * List of rows, with counts of bids with a given creative status aggregated by detail. */ filteredBidDetailRows?: Schema$FilteredBidDetailRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListCreativeStatusBreakdownByDetailRequest.pageToken field in the - * subsequent call to the filteredBids.details.list method to retrieve the - * next page of results. + * A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent call to the filteredBids.details.list method to retrieve the next page of results. */ nextPageToken?: string; } @@ -1456,44 +1191,33 @@ export namespace adexchangebuyer2_v2beta1 { */ associations?: Schema$CreativeDealAssociation[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListDealAssociationsRequest.page_token field in the subsequent call to - * 'ListDealAssociation' method to retrieve the next page of - * results. + * A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing all reasons that bid requests were filtered - * and not sent to the buyer. + * Response message for listing all reasons that bid requests were filtered and not sent to the buyer. */ export interface Schema$ListFilteredBidRequestsResponse { /** - * List of rows, with counts of filtered bid requests aggregated by callout - * status. + * List of rows, with counts of filtered bid requests aggregated by callout status. */ calloutStatusRows?: Schema$CalloutStatusRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListFilteredBidRequestsRequest.pageToken field in the subsequent call to - * the filteredBidRequests.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the filteredBidRequests.list method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing all reasons that bids were filtered from the - * auction. + * Response message for listing all reasons that bids were filtered from the auction. */ export interface Schema$ListFilteredBidsResponse { /** - * List of rows, with counts of filtered bids aggregated by filtering reason - * (i.e. creative status). + * List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status). */ creativeStatusRows?: Schema$CreativeStatusRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListFilteredBidsRequest.pageToken field in the subsequent call to the - * filteredBids.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the next page of results. */ nextPageToken?: string; } @@ -1506,15 +1230,12 @@ export namespace adexchangebuyer2_v2beta1 { */ filterSets?: Schema$FilterSet[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListFilterSetsRequest.pageToken field in the subsequent call to the - * accounts.filterSets.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing the metrics that are measured in number of - * impressions. + * Response message for listing the metrics that are measured in number of impressions. */ export interface Schema$ListImpressionMetricsResponse { /** @@ -1522,9 +1243,7 @@ export namespace adexchangebuyer2_v2beta1 { */ impressionMetricsRows?: Schema$ImpressionMetricsRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListImpressionMetricsRequest.pageToken field in the subsequent call to - * the impressionMetrics.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListImpressionMetricsRequest.pageToken field in the subsequent call to the impressionMetrics.list method to retrieve the next page of results. */ nextPageToken?: string; } @@ -1533,27 +1252,20 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$ListLosingBidsResponse { /** - * List of rows, with counts of losing bids aggregated by loss reason (i.e. - * creative status). + * List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status). */ creativeStatusRows?: Schema$CreativeStatusRow[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListLosingBidsRequest.pageToken field in the subsequent call to the - * losingBids.list method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next page of results. */ nextPageToken?: string; } /** - * Response message for listing all reasons for which a buyer was not billed - * for a winning bid. + * Response message for listing all reasons for which a buyer was not billed for a winning bid. */ export interface Schema$ListNonBillableWinningBidsResponse { /** - * A token to retrieve the next page of results. Pass this value in the - * ListNonBillableWinningBidsRequest.pageToken field in the subsequent call - * to the nonBillableWinningBids.list method to retrieve the next page of - * results. + * A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results. */ nextPageToken?: string; /** @@ -1601,21 +1313,16 @@ export namespace adexchangebuyer2_v2beta1 { publisherProfiles?: Schema$PublisherProfile[]; } /** - * @OutputOnly The Geo criteria the restriction applies to. + * Output only. The Geo criteria the restriction applies to. */ export interface Schema$LocationContext { /** - * IDs representing the geo location for this context. Please refer to the - * [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) - * file for different geo criteria IDs. + * IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. */ geoCriteriaIds?: number[]; } /** - * Targeting represents different criteria that can be used by advertisers to - * target ad inventory. For example, they can choose to target ad requests - * only if the user is in the US. Multiple types of targeting are always - * applied as a logical AND, unless noted otherwise. + * Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. */ export interface Schema$MarketplaceTargeting { /** @@ -1631,8 +1338,7 @@ export namespace adexchangebuyer2_v2beta1 { */ placementTargeting?: Schema$PlacementTargeting; /** - * Technology targeting information, e.g., operating system, device - * category. + * Technology targeting information, e.g., operating system, device category. */ technologyTargeting?: Schema$TechnologyTargeting; /** @@ -1641,8 +1347,7 @@ export namespace adexchangebuyer2_v2beta1 { videoTargeting?: Schema$VideoTargeting; } /** - * A metric value, with an expected value and a variance; represents a count - * that may be either exact or estimated (i.e. when sampled). + * A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). */ export interface Schema$MetricValue { /** @@ -1650,12 +1355,7 @@ export namespace adexchangebuyer2_v2beta1 { */ value?: string; /** - * The variance (i.e. square of the standard deviation) of the metric value. - * If value is exact, variance is 0. Can be used to calculate margin of - * error as a percentage of value, using the following formula, where Z is - * the standard constant that depends on the desired size of the confidence - * interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError - * = 100 * Z * sqrt(variance) / value + * The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value */ variance?: string; } @@ -1664,8 +1364,7 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$MobileApplicationTargeting { /** - * Publisher owned apps to be targeted or excluded by the publisher to - * display the ads in. + * Publisher owned apps to be targeted or excluded by the publisher to display the ads in. */ firstPartyTargeting?: Schema$FirstPartyMobileApplicationTargeting; } @@ -1678,17 +1377,11 @@ export namespace adexchangebuyer2_v2beta1 { */ currencyCode?: string; /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ nanos?: number; /** - * The whole units of the amount. For example if `currencyCode` is - * `"USD"`, then 1 unit is one US dollar. + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ units?: string; } @@ -1697,8 +1390,7 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$NativeContent { /** - * The name of the advertiser or sponsor, to be displayed in the ad - * creative. + * The name of the advertiser or sponsor, to be displayed in the ad creative. */ advertiserName?: string; /** @@ -1751,8 +1443,7 @@ export namespace adexchangebuyer2_v2beta1 { videoUrl?: string; } /** - * The number of winning bids with the specified dimension values for which - * the buyer was not billed, as described by the specified status. + * The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status. */ export interface Schema$NonBillableWinningBidStatusRow { /** @@ -1769,13 +1460,11 @@ export namespace adexchangebuyer2_v2beta1 { status?: string; } /** - * Terms for Private Auctions. Note that Private Auctions can be created only - * by the seller, but they can be returned in a get or list request. + * Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. */ export interface Schema$NonGuaranteedAuctionTerms { /** - * True if open auction buyers are allowed to compete with invited buyers in - * this private auction. + * True if open auction buyers are allowed to compete with invited buyers in this private auction. */ autoOptimizePrivateAuction?: boolean; /** @@ -1784,8 +1473,7 @@ export namespace adexchangebuyer2_v2beta1 { reservePricesPerBuyer?: Schema$PricePerBuyer[]; } /** - * Terms for Preferred Deals. Note that Preferred Deals cannot be created via - * the API at this time, but can be returned in a get or list request. + * Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. */ export interface Schema$NonGuaranteedFixedPriceTerms { /** @@ -1798,25 +1486,23 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$Note { /** - * The timestamp for when this note was created. @OutputOnly + * Output only. The timestamp for when this note was created. */ createTime?: string; /** - * The role of the person (buyer/seller) creating the note. @OutputOnly + * Output only. The role of the person (buyer/seller) creating the note. */ creatorRole?: string; /** - * The actual note to attach. (max-length: 1024 unicode code units) Note: - * This field may be set only when creating the resource. Modifying this - * field while updating the resource will result in an error. + * The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ note?: string; /** - * The unique ID for the note. @OutputOnly + * Output only. The unique ID for the note. */ noteId?: string; /** - * The revision number of the proposal when the note is created. @OutputOnly + * Output only. The revision number of the proposal when the note is created. */ proposalRevision?: string; } @@ -1838,21 +1524,16 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$PauseProposalRequest { /** - * The reason why the proposal is being paused. This human readable message - * will be displayed in the seller's UI. (Max length: 1000 unicode code - * units.) + * The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.) */ reason?: string; } /** - * Represents targeting about where the ads can appear, e.g., certain sites or - * mobile applications. Different placement targeting types will be logically - * OR'ed. + * Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. */ export interface Schema$PlacementTargeting { /** - * Mobile application targeting information in a deal. This doesn't - * apply to Auction Packages. + * Mobile application targeting information in a deal. This doesn't apply to Auction Packages. */ mobileApplicationTargeting?: Schema$MobileApplicationTargeting; /** @@ -1861,7 +1542,7 @@ export namespace adexchangebuyer2_v2beta1 { urlTargeting?: Schema$UrlTargeting; } /** - * @OutputOnly The type of platform the restriction applies to. + * Output only. The type of platform the restriction applies to. */ export interface Schema$PlatformContext { /** @@ -1883,23 +1564,15 @@ export namespace adexchangebuyer2_v2beta1 { pricingType?: string; } /** - * Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in - * a product can become 0 or 1 deals. To check if there is a PricePerBuyer for - * a particular buyer or buyer/advertiser pair, we look for the most specific - * matching rule - we first look for a rule matching the buyer and advertiser, - * next a rule with the buyer but an empty advertiser list, and otherwise look - * for a matching rule where no buyer is set. + * Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. */ export interface Schema$PricePerBuyer { /** - * The list of advertisers for this price when associated with this buyer. - * If empty, all advertisers with this buyer pay this price. + * The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. */ advertiserIds?: string[]; /** - * The buyer who will pay this price. If unset, all buyers can pay this - * price (if the advertisers match, and there's no more specific rule - * matching the buyer). + * The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). */ buyer?: Schema$Buyer; /** @@ -1908,33 +1581,24 @@ export namespace adexchangebuyer2_v2beta1 { price?: Schema$Price; } /** - * Buyers are allowed to store certain types of private data in a - * proposal/deal. + * Buyers are allowed to store certain types of private data in a proposal/deal. */ export interface Schema$PrivateData { /** - * A buyer or seller specified reference ID. This can be queried in the list - * operations (max-length: 1024 unicode code units). + * A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). */ referenceId?: string; } /** - * Note: this resource requires whitelisting for access. Please contact your - * account manager for access to Marketplace resources. A product is a - * segment of inventory that a seller wishes to sell. It is associated with - * certain terms and targeting information which helps the buyer know more - * about the inventory. + * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. */ export interface Schema$Product { /** - * The proposed end time for the deal. The field will be truncated to the - * order of seconds during serving. + * The proposed end time for the deal. The field will be truncated to the order of seconds during serving. */ availableEndTime?: string; /** - * Inventory availability dates. The start time will be truncated to seconds - * during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) - * will be truncated to 3:23:34 when serving. + * Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving. */ availableStartTime?: string; /** @@ -1950,10 +1614,7 @@ export namespace adexchangebuyer2_v2beta1 { */ displayName?: string; /** - * If the creator has already signed off on the product, then the buyer can - * finalize the deal by accepting the product as is. When copying to a - * proposal, if any of the terms are changed, then auto_finalize is - * automatically set to false. + * If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. */ hasCreatorSignedOff?: boolean; /** @@ -1965,8 +1626,7 @@ export namespace adexchangebuyer2_v2beta1 { */ productRevision?: string; /** - * An ID which can be used by the Publisher Profile API to get more - * information about the seller that created this product. + * An ID which can be used by the Publisher Profile API to get more information about the seller that created this product. */ publisherProfileId?: string; /** @@ -1978,9 +1638,7 @@ export namespace adexchangebuyer2_v2beta1 { */ syndicationProduct?: string; /** - * Targeting that is shared between the buyer and the seller. Each targeting - * criterion has a specified key and for each key there is a list of - * inclusion value or exclusion values. + * Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values. */ targetingCriterion?: Schema$TargetingCriteria[]; /** @@ -1992,29 +1650,20 @@ export namespace adexchangebuyer2_v2beta1 { */ updateTime?: string; /** - * The web-property code for the seller. This needs to be copied as is when - * adding a new deal to a proposal. + * The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal. */ webPropertyCode?: string; } /** - * Note: this resource requires whitelisting for access. Please contact your - * account manager for access to Marketplace resources. Represents a proposal - * in the Marketplace. A proposal is the unit of negotiation between a seller - * and a buyer and contains deals which are served. Note: you can not update, - * create, or otherwise modify Private Auction or Preferred Deals deals - * through the API. Fields are updatable unless noted otherwise. + * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. */ export interface Schema$Proposal { /** - * Reference to the buyer that will get billed for this proposal. - * @OutputOnly + * Output only. Reference to the buyer that will get billed for this proposal. */ billedBuyer?: Schema$Buyer; /** - * Reference to the buyer on the proposal. Note: This field may be set only - * when creating the resource. Modifying this field while updating the - * resource will result in an error. + * Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ buyer?: Schema$Buyer; /** @@ -2026,9 +1675,7 @@ export namespace adexchangebuyer2_v2beta1 { */ buyerPrivateData?: Schema$PrivateData; /** - * The deals associated with this proposal. For Private Auction proposals - * (whose deals have NonGuaranteedAuctionTerms), there will only be one - * deal. + * The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. */ deals?: Schema$Deal[]; /** @@ -2036,70 +1683,56 @@ export namespace adexchangebuyer2_v2beta1 { */ displayName?: string; /** - * True if the proposal is being renegotiated. @OutputOnly + * Output only. True if the proposal is being renegotiated. */ isRenegotiating?: boolean; /** - * True, if the buyside inventory setup is complete for this proposal. - * @OutputOnly + * Output only. True, if the buyside inventory setup is complete for this proposal. */ isSetupComplete?: boolean; /** - * The role of the last user that either updated the proposal or left a - * comment. @OutputOnly + * Output only. The role of the last user that either updated the proposal or left a comment. */ lastUpdaterOrCommentorRole?: string; /** - * The notes associated with this proposal. @OutputOnly + * Output only. The notes associated with this proposal. */ notes?: Schema$Note[]; /** - * Indicates whether the buyer/seller created the proposal. @OutputOnly + * Output only. Indicates whether the buyer/seller created the proposal. */ originatorRole?: string; /** - * Private auction ID if this proposal is a private auction proposal. - * @OutputOnly + * Output only. Private auction ID if this proposal is a private auction proposal. */ privateAuctionId?: string; /** - * The unique ID of the proposal. @OutputOnly + * Output only. The unique ID of the proposal. */ proposalId?: string; /** - * The revision number for the proposal. Each update to the proposal or the - * deal causes the proposal revision number to auto-increment. The buyer - * keeps track of the last revision number they know of and pass it in when - * making an update. If the head revision number on the server has since - * incremented, then an ABORTED error is returned during the update - * operation to let the buyer know that a subsequent update was made. - * @OutputOnly + * Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. */ proposalRevision?: string; /** - * The current state of the proposal. @OutputOnly + * Output only. The current state of the proposal. */ proposalState?: string; /** - * Reference to the seller on the proposal. Note: This field may be set - * only when creating the resource. Modifying this field while updating the - * resource will result in an error. + * Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ seller?: Schema$Seller; /** - * Contact information for the seller. @OutputOnly + * Output only. Contact information for the seller. */ sellerContacts?: Schema$ContactInformation[]; /** - * The time when the proposal was last revised. @OutputOnly + * Output only. The time when the proposal was last revised. */ updateTime?: string; } /** - * Note: this resource requires whitelisting for access. Please contact your - * account manager for access to Marketplace resources. Represents a - * publisher profile in Marketplace. All fields are read only. All string - * fields are free-form text entered by the publisher unless noted otherwise. + * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise. */ export interface Schema$PublisherProfile { /** @@ -2107,14 +1740,11 @@ export namespace adexchangebuyer2_v2beta1 { */ audienceDescription?: string; /** - * Statement explaining what's unique about publisher's business, - * and why buyers should partner with the publisher. + * Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher. */ buyerPitchStatement?: string; /** - * Contact information for direct reservation deals. This is free text - * entered by the publisher and may include information like names, phone - * numbers and email addresses. + * Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. */ directDealsContact?: string; /** @@ -2122,10 +1752,7 @@ export namespace adexchangebuyer2_v2beta1 { */ displayName?: string; /** - * The list of domains represented in this publisher profile. Empty if this - * is a parent profile. These are top private domains, meaning that these - * will not contain a string like "photos.google.co.uk/123", but - * will instead contain "google.co.uk". + * The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". */ domains?: string[]; /** @@ -2133,8 +1760,7 @@ export namespace adexchangebuyer2_v2beta1 { */ googlePlusUrl?: string; /** - * A Google public URL to the logo for this publisher profile. The logo is - * stored as a PNG, JPG, or GIF image. + * A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image. */ logoUrl?: string; /** @@ -2146,9 +1772,7 @@ export namespace adexchangebuyer2_v2beta1 { */ overview?: string; /** - * Contact information for programmatic deals. This is free text entered by - * the publisher and may include information like names, phone numbers and - * email addresses. + * Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. */ programmaticDealsContact?: string; /** @@ -2168,15 +1792,12 @@ export namespace adexchangebuyer2_v2beta1 { */ seller?: Schema$Seller; /** - * Up to three key metrics and rankings. Max 100 characters each. For - * example "#1 Mobile News Site for 20 Straight Months". + * Up to three key metrics and rankings. Max 100 characters each. For example "#1 Mobile News Site for 20 Straight Months". */ topHeadlines?: string[]; } /** - * An open-ended realtime time range specified by the start timestamp. For - * filter sets that specify a realtime time range RTB metrics continue to be - * aggregated throughout the lifetime of the filter set. + * An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. */ export interface Schema$RealtimeTimeRange { /** @@ -2185,36 +1806,15 @@ export namespace adexchangebuyer2_v2beta1 { startTimestamp?: string; } /** - * A specific filtering status and how many times it occurred. - */ - export interface Schema$Reason { - /** - * The number of times the creative was filtered for the status. The count - * is aggregated across all publishers on the exchange. - */ - count?: string; - /** - * The filtering status code. Please refer to the - * [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt) - * file for different statuses. - */ - status?: number; - } - /** - * A relative date range, specified by an offset and a duration. The supported - * range of dates begins 30 days before today and ends today, i.e., the limits - * for these values are: offset_days >= 0 duration_days >= 1 offset_days - * + duration_days <= 30 + * A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 */ export interface Schema$RelativeDateRange { /** - * The number of days in the requested date range, e.g., for a range - * spanning today: 1. For a range spanning the last 7 days: 7. + * The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. */ durationDays?: number; /** - * The end date of the filter set, specified as the number of days before - * today, e.g., for a range where the last date is today: 0. + * The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. */ offsetDays?: number; } @@ -2228,19 +1828,15 @@ export namespace adexchangebuyer2_v2beta1 { association?: Schema$CreativeDealAssociation; } /** - * Request message to resume (unpause) serving for an already-finalized - * proposal. + * Request message to resume (unpause) serving for an already-finalized proposal. */ export interface Schema$ResumeProposalRequest {} /** - * A response may include multiple rows, breaking down along various - * dimensions. Encapsulates the values of all dimensions for a given row. + * A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. */ export interface Schema$RowDimensions { /** - * The publisher identifier for this row, if a breakdown by - * [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) - * was requested. + * The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. */ publisherIdentifier?: string; /** @@ -2249,7 +1845,7 @@ export namespace adexchangebuyer2_v2beta1 { timeInterval?: Schema$TimeInterval; } /** - * @OutputOnly A security context. + * Output only. A security context. */ export interface Schema$SecurityContext { /** @@ -2258,13 +1854,11 @@ export namespace adexchangebuyer2_v2beta1 { securities?: string[]; } /** - * Represents a seller of inventory. Each seller is identified by a unique Ad - * Manager account ID. + * Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. */ export interface Schema$Seller { /** - * The unique ID for the seller. The seller fills in this field. The seller - * account ID is then available to buyer in the product. + * The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. */ accountId?: string; /** @@ -2289,8 +1883,7 @@ export namespace adexchangebuyer2_v2beta1 { */ auctionType?: Schema$AuctionContext; /** - * Matches impressions coming from users *or* publishers in a specific - * location. + * Matches impressions coming from users *or* publishers in a specific location. */ location?: Schema$LocationContext; /** @@ -2303,10 +1896,7 @@ export namespace adexchangebuyer2_v2beta1 { securityType?: Schema$SecurityContext; } /** - * @OutputOnly A representation of the status of an ad in a specific context. - * A context here relates to where something ultimately serves (for example, a - * user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of - * auction). + * Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). */ export interface Schema$ServingRestriction { /** @@ -2314,26 +1904,20 @@ export namespace adexchangebuyer2_v2beta1 { */ contexts?: Schema$ServingContext[]; /** - * Disapproval bound to this restriction. Only present if - * status=DISAPPROVED. Can be used to filter the response of the - * creatives.list method. + * Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. */ disapproval?: Schema$Disapproval; /** - * Any disapprovals bound to this restriction. Only present if - * status=DISAPPROVED. Can be used to filter the response of the - * creatives.list method. Deprecated; please use disapproval field instead. + * Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. */ disapprovalReasons?: Schema$Disapproval[]; /** - * The status of the creative in this context (for example, it has been - * explicitly disapproved or is pending review). + * The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). */ status?: string; } /** - * Message depicting the size of the creative. The units of width and height - * depend on the type of the targeting. + * Message depicting the size of the creative. The units of width and height depend on the type of the targeting. */ export interface Schema$Size { /** @@ -2350,26 +1934,19 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$StopWatchingCreativeRequest {} /** - * Advertisers can target different attributes of an ad slot. For example, - * they can choose to show ads only if the user is in the U.S. Such targeting - * criteria can be specified as part of Shared Targeting. + * Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. */ export interface Schema$TargetingCriteria { /** - * The list of values to exclude from targeting. Each value is AND'd - * together. + * The list of values to exclude from targeting. Each value is AND'd together. */ exclusions?: Schema$TargetingValue[]; /** - * The list of value to include as part of the targeting. Each value is - * OR'd together. + * The list of value to include as part of the targeting. Each value is OR'd together. */ inclusions?: Schema$TargetingValue[]; /** - * The key representing the shared targeting criterion. Targeting criteria - * defined by Google ad servers will begin with GOOG_. Third parties may - * define their own keys. A list of permissible keys along with the - * acceptable values will be provided as part of the external documentation. + * The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. */ key?: string; } @@ -2378,14 +1955,11 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$TargetingValue { /** - * The creative size value to include/exclude. Filled in when key = - * GOOG_CREATIVE_SIZE + * The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE */ creativeSizeValue?: Schema$CreativeSize; /** - * The daypart targeting to include / exclude. Filled in when the key is - * GOOG_DAYPART_TARGETING. The definition of this targeting is derived from - * the structure used by Ad Manager. + * The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. */ dayPartTargetingValue?: Schema$DayPartTargeting; /** @@ -2419,26 +1993,20 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$TimeInterval { /** - * The timestamp marking the end of the range (exclusive) for which data is - * included. + * The timestamp marking the end of the range (exclusive) for which data is included. */ endTime?: string; /** - * The timestamp marking the start of the range (inclusive) for which data - * is included. + * The timestamp marking the start of the range (inclusive) for which data is included. */ startTime?: string; } /** - * Represents a time of day. The date and time zone are either not significant - * or are specified elsewhere. An API may choose to allow leap seconds. - * Related types are google.type.Date and `google.protobuf.Timestamp`. + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - * to allow the value "24:00:00" for scenarios like business - * closing time. + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number; /** @@ -2450,16 +2018,12 @@ export namespace adexchangebuyer2_v2beta1 { */ nanos?: number; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may - * allow the value 60 if it allows leap-seconds. + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number; } /** - * Represents a list of targeted and excluded URLs (e.g., google.com). For - * Private Auction and AdX Preferred Deals, URLs are either included or - * excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't - * apply. + * Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. */ export interface Schema$UrlTargeting { /** @@ -2480,8 +2044,7 @@ export namespace adexchangebuyer2_v2beta1 { */ videoUrl?: string; /** - * The contents of a VAST document for a video ad. This document should - * conform to the VAST 2.0 or 3.0 standard. + * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. */ videoVastXml?: string; } @@ -2490,14 +2053,11 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$VideoTargeting { /** - * A list of video positions to be excluded. Position types can either be - * included or excluded (XOR). + * A list of video positions to be excluded. Position types can either be included or excluded (XOR). */ excludedPositionTypes?: string[]; /** - * A list of video positions to be included. When the included list is - * present, the excluded list must be empty. When the excluded list is - * present, the included list must be empty. + * A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. */ targetedPositionTypes?: string[]; } @@ -2506,10 +2066,7 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$WatchCreativeRequest { /** - * The Pub/Sub topic to publish notifications to. This topic must already - * exist and must give permission to ad-exchange-buyside-reports@google.com - * to write to the topic. This should be the full resource name in - * "projects/{project_id}/topics/{topic_id}" format. + * The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format. */ topic?: string; } @@ -2859,8 +2416,7 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique numerical account ID for the buyer of which the client buyer is a - * customer; the sponsor buyer to create a client for. (required) + * Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required) */ accountId?: string; @@ -2897,20 +2453,15 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * Requested page size. The server may return fewer clients than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListClientsResponse.nextPageToken - * returned from the previous call to the accounts.clients.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method. */ pageToken?: string; /** - * Optional unique identifier (from the standpoint of an Ad Exchange sponsor - * buyer partner) of the client to return. If specified, at most one client - * will be returned in the response. + * Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response. */ partnerClientId?: string; } @@ -2922,8 +2473,7 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique numerical account ID for the buyer of which the client buyer is a - * customer; the sponsor buyer to update a client for. (required) + * Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required) */ accountId?: string; /** @@ -2945,8 +2495,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.clients.invitations.create - * @desc Creates and sends out an email invitation to access an Ad Exchange - * client buyer account. + * @desc Creates and sends out an email invitation to access an Ad Exchange client buyer account. * @alias adexchangebuyer2.accounts.clients.invitations.create * @memberOf! () * @@ -3104,8 +2653,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.clients.invitations.list - * @desc Lists all the client users invitations for a client with a given - * account ID. + * @desc Lists all the client users invitations for a client with a given account ID. * @alias adexchangebuyer2.accounts.clients.invitations.list * @memberOf! () * @@ -3203,8 +2751,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * Numerical account ID of the client buyer that the user should be - * associated with. (required) + * Numerical account ID of the client buyer that the user should be associated with. (required) */ clientAccountId?: string; @@ -3225,8 +2772,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * Numerical account ID of the client buyer that the user invitation to be - * retrieved is associated with. (required) + * Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required) */ clientAccountId?: string; /** @@ -3246,22 +2792,15 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * Numerical account ID of the client buyer to list invitations for. - * (required) You must either specify a string representation of a numerical - * account identifier or the `-` character to list all the invitations for - * all the clients of a given sponsor buyer. + * Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer. */ clientAccountId?: string; /** - * Requested page size. Server may return fewer clients than requested. If - * unspecified, server will pick an appropriate default. + * Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListClientUserInvitationsResponse.nextPageToken returned from the - * previous call to the clients.invitations.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method. */ pageToken?: string; } @@ -3351,8 +2890,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.clients.users.list - * @desc Lists all the known client users for a specified sponsor buyer - * account ID. + * @desc Lists all the known client users for a specified sponsor buyer account ID. * @alias adexchangebuyer2.accounts.clients.users.list * @memberOf! () * @@ -3432,8 +2970,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.clients.users.update - * @desc Updates an existing client user. Only the user status can be - * changed on update. + * @desc Updates an existing client user. Only the user status can be changed on update. * @alias adexchangebuyer2.accounts.clients.users.update * @memberOf! () * @@ -3522,8 +3059,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * Numerical account ID of the client buyer that the user to be retrieved is - * associated with. (required) + * Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) */ clientAccountId?: string; /** @@ -3539,27 +3075,19 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Numerical account ID of the sponsor buyer of the client to list users - * for. (required) + * Numerical account ID of the sponsor buyer of the client to list users for. (required) */ accountId?: string; /** - * The account ID of the client buyer to list users for. (required) You must - * specify either a string representation of a numerical account identifier - * or the `-` character to list all the client users for all the clients of - * a given sponsor buyer. + * The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer. */ clientAccountId?: string; /** - * Requested page size. The server may return fewer clients than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListClientUsersResponse.nextPageToken - * returned from the previous call to the accounts.clients.users.list - * method. + * A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method. */ pageToken?: string; } @@ -3575,8 +3103,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * Numerical account ID of the client buyer that the user to be retrieved is - * associated with. (required) + * Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) */ clientAccountId?: string; /** @@ -3830,8 +3357,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.creatives.stopWatching - * @desc Stops watching a creative. Will stop push notifications being sent - * to the topics when the creative changes status. + * @desc Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status. * @alias adexchangebuyer2.accounts.creatives.stopWatching * @memberOf! () * @@ -3980,8 +3506,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.creatives.watch - * @desc Watches a creative. Will result in push notifications being sent to - * the topic when the creative changes status. + * @desc Watches a creative. Will result in push notifications being sent to the topic when the creative changes status. * @alias adexchangebuyer2.accounts.creatives.watch * @memberOf! () * @@ -4063,13 +3588,11 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The account that this creative belongs to. Can be used to filter the - * response of the creatives.list method. + * The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */ accountId?: string; /** - * Indicates if multiple creatives can share an ID or not. Default is - * NO_DUPLICATES (one ID per creative). + * Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). */ duplicateIdMode?: string; @@ -4102,34 +3625,19 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The account to list the creatives from. Specify "-" to list all creatives - * the current user has access to. + * The account to list the creatives from. Specify "-" to list all creatives the current user has access to. */ accountId?: string; /** - * Requested page size. The server may return fewer creatives than requested - * (due to timeout constraint) even if more are available via another call. - * If unspecified, server will pick an appropriate default. Acceptable - * values are 1 to 1000, inclusive. + * Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListCreativesResponse.next_page_token - * returned from the previous call to 'ListCreatives' method. + * A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method. */ pageToken?: string; /** - * An optional query string to filter creatives. If no filter is specified, - * all active creatives will be returned.

                          Supported queries are:

                            - *
                          • accountId=account_id_string - *
                          • creativeId=creative_id_string
                          • dealsStatus: {approved, - * conditionally_approved, disapproved, not_checked} - *
                          • openAuctionStatus: {approved, conditionally_approved, disapproved, - * not_checked}
                          • attribute: {a numeric attribute from the list of - * attributes}
                          • disapprovalReason: {a reason from DisapprovalReason} - *
                          Example: 'accountId=12345 AND (dealsStatus:disapproved AND - * disapprovalReason:unacceptable_content) OR attribute:47' + * An optional query string to filter creatives. If no filter is specified, all active creatives will be returned.

                          Supported queries are:

                          • accountId=account_id_string
                          • creativeId=creative_id_string
                          • dealsStatus: {approved, conditionally_approved, disapproved, not_checked}
                          • openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked}
                          • attribute: {a numeric attribute from the list of attributes}
                          • disapprovalReason: {a reason from DisapprovalReason}
                          Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' */ query?: string; } @@ -4145,8 +3653,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * The creative ID of the creative to stop notifications for. Specify "-" to - * specify stopping account level notifications. + * The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications. */ creativeId?: string; @@ -4163,13 +3670,11 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The account that this creative belongs to. Can be used to filter the - * response of the creatives.list method. + * The account that this creative belongs to. Can be used to filter the response of the creatives.list method. */ accountId?: string; /** - * The buyer-defined creative ID of this creative. Can be used to filter the - * response of the creatives.list method. + * The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. */ creativeId?: string; @@ -4190,10 +3695,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * The creative ID to watch for status changes. Specify "-" to watch all - * creatives under the above account. If both creative-level and - * account-level notifications are sent, only a single notification will be - * sent to the creative-level notification topic. + * The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic. */ creativeId?: string; @@ -4477,36 +3979,23 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The account to list the associations from. Specify "-" to list all - * creatives the current user has access to. + * The account to list the associations from. Specify "-" to list all creatives the current user has access to. */ accountId?: string; /** - * The creative ID to list the associations from. Specify "-" to list all - * creatives under the above account. + * The creative ID to list the associations from. Specify "-" to list all creatives under the above account. */ creativeId?: string; /** - * Requested page size. Server may return fewer associations than requested. - * If unspecified, server will pick an appropriate default. + * Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListDealAssociationsResponse.next_page_token returned from the previous - * call to 'ListDealAssociations' method. + * A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method. */ pageToken?: string; /** - * An optional query string to filter deal associations. If no filter is - * specified, all associations will be returned. Supported queries are:
                            - *
                          • accountId=account_id_string - *
                          • creativeId=creative_id_string - *
                          • dealsId=deals_id_string
                          • dealsStatus:{approved, - * conditionally_approved, disapproved, not_checked} - *
                          • openAuctionStatus:{approved, conditionally_approved, disapproved, - * not_checked}
                          Example: 'dealsId=12345 AND dealsStatus:disapproved' + * An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are:
                          • accountId=account_id_string
                          • creativeId=creative_id_string
                          • dealsId=deals_id_string
                          • dealsStatus:{approved, conditionally_approved, disapproved, not_checked}
                          • openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked}
                          Example: 'dealsId=12345 AND dealsStatus:disapproved' */ query?: string; } @@ -4540,9 +4029,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.finalizedProposals.list - * @desc List finalized proposals, regardless if a proposal is being - * renegotiated. A filter expression (PQL query) may be specified to filter - * the results. The notes will not be returned. + * @desc List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned. * @alias adexchangebuyer2.accounts.finalizedProposals.list * @memberOf! () * @@ -4633,19 +4120,15 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * An optional PQL filter query used to query for proposals. Nested - * repeated fields, such as proposal.deals.targetingCriterion, cannot be - * filtered. + * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. */ filter?: string; /** - * Syntax the filter is written in. Current implementation defaults to PQL - * but in the future it will be LIST_FILTER. + * Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. */ filterSyntax?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** @@ -4735,8 +4218,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.products.list - * @desc List all products visible to the buyer (optionally filtered by the - * specified PQL query). + * @desc List all products visible to the buyer (optionally filtered by the specified PQL query). * @alias adexchangebuyer2.accounts.products.list * @memberOf! () * @@ -4843,15 +4325,11 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * An optional PQL query used to query for products. See - * https://developers.google.com/ad-manager/docs/pqlreference for - * documentation about PQL and examples. Nested repeated fields, such as - * product.targetingCriterion.inclusions, cannot be filtered. + * An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered. */ filter?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** @@ -4868,10 +4346,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.accept - * @desc Mark the proposal as accepted at the given revision number. If the - * number does not match the server's revision number an `ABORTED` error - * message will be returned. This call updates the proposal_state from - * `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. + * @desc Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. * @alias adexchangebuyer2.accounts.proposals.accept * @memberOf! () * @@ -4946,9 +4421,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.addNote - * @desc Create a new note and attach it to the proposal. The note is - * assigned a unique ID by the server. The proposal revision number will not - * increase when associated with a new note. + * @desc Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note. * @alias adexchangebuyer2.accounts.proposals.addNote * @memberOf! () * @@ -5023,9 +4496,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.cancelNegotiation - * @desc Cancel an ongoing negotiation on a proposal. This does not cancel - * or end serving for the deals if the proposal has been finalized, but only - * cancels a negotiation unilaterally. + * @desc Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally. * @alias adexchangebuyer2.accounts.proposals.cancelNegotiation * @memberOf! () * @@ -5100,13 +4571,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.completeSetup - * @desc Update the given proposal to indicate that setup has been - * completed. This method is called by the buyer when the line items have - * been created on their end for a finalized proposal and all the required - * creatives have been uploaded using the creatives API. This call updates - * the `is_setup_completed` bit on the proposal and also notifies the - * seller. The server will advance the revision number of the most recent - * proposal. + * @desc Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal. * @alias adexchangebuyer2.accounts.proposals.completeSetup * @memberOf! () * @@ -5181,8 +4646,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.create - * @desc Create the given proposal. Each created proposal and any deals it - * contains are assigned a unique ID by the server. + * @desc Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server. * @alias adexchangebuyer2.accounts.proposals.create * @memberOf! () * @@ -5256,8 +4720,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.get - * @desc Gets a proposal given its ID. The proposal is returned at its head - * revision. + * @desc Gets a proposal given its ID. The proposal is returned at its head revision. * @alias adexchangebuyer2.accounts.proposals.get * @memberOf! () * @@ -5330,12 +4793,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.list - * @desc List proposals. A filter expression (PQL query) may be specified to - * filter the results. To retrieve all finalized proposals, regardless if a - * proposal is being renegotiated, see the FinalizedProposals resource. Note - * that Bidder/ChildSeat relationships differ from the usual behavior. A - * Bidder account can only see its child seats' proposals by specifying the - * ChildSeat's accountId in the request path. + * @desc List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path. * @alias adexchangebuyer2.accounts.proposals.list * @memberOf! () * @@ -5416,11 +4874,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.pause - * @desc Update the given proposal to pause serving. This method will set - * the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true - * for all deals in the proposal. It is a no-op to pause an already-paused - * proposal. It is an error to call PauseProposal for a proposal that is not - * finalized or renegotiating. + * @desc Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating. * @alias adexchangebuyer2.accounts.proposals.pause * @memberOf! () * @@ -5495,12 +4949,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.resume - * @desc Update the given proposal to resume serving. This method will set - * the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false - * for all deals in the proposal. Note that if the `has_seller_paused` bit - * is also set, serving will not resume until the seller also resumes. It - * is a no-op to resume an already-running proposal. It is an error to call - * ResumeProposal for a proposal that is not finalized or renegotiating. + * @desc Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating. * @alias adexchangebuyer2.accounts.proposals.resume * @memberOf! () * @@ -5575,16 +5024,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.update - * @desc Update the given proposal at the client known revision number. If - * the server revision has advanced since the passed-in - * `proposal.proposal_revision`, an `ABORTED` error message will be - * returned. Only the buyer-modifiable fields of the proposal will be - * updated. Note that the deals in the proposal will be updated to match - * the passed-in copy. If a passed-in deal does not have a `deal_id`, the - * server will assign a new unique ID and create the deal. If passed-in deal - * has a `deal_id`, it will be updated to match the passed-in copy. Any - * existing deals not present in the passed-in proposal will be deleted. It - * is an error to pass in a deal with a `deal_id` not present at head. + * @desc Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head. * @alias adexchangebuyer2.accounts.proposals.update * @memberOf! () * @@ -5786,19 +5226,15 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * An optional PQL filter query used to query for proposals. Nested - * repeated fields, such as proposal.deals.targetingCriterion, cannot be - * filtered. + * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. */ filter?: string; /** - * Syntax the filter is written in. Current implementation defaults to PQL - * but in the future it will be LIST_FILTER. + * Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. */ filterSyntax?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** @@ -6135,8 +5571,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.create - * @desc Creates the specified filter set for the account with the given - * account ID. + * @desc Creates the specified filter set for the account with the given account ID. * @alias adexchangebuyer2.bidders.accounts.filterSets.create * @memberOf! () * @@ -6213,8 +5648,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.delete - * @desc Deletes the requested filter set from the account with the given - * account ID. + * @desc Deletes the requested filter set from the account with the given account ID. * @alias adexchangebuyer2.bidders.accounts.filterSets.delete * @memberOf! () * @@ -6284,8 +5718,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.get - * @desc Retrieves the requested filter set for the account with the given - * account ID. + * @desc Retrieves the requested filter set for the account with the given account ID. * @alias adexchangebuyer2.bidders.accounts.filterSets.get * @memberOf! () * @@ -6443,18 +5876,11 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the filter set is transient, or should be persisted indefinitely. - * By default, filter sets are not transient. If transient, it will be - * available for at least 1 hour after creation. + * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. */ isTransient?: boolean; /** - * Name of the owner (bidder or account) of the filter set to be created. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123` - For an account-level filter set for the buyer account - * representing bidder 123: `bidders/123/accounts/123` - For an - * account-level filter set for the child seat buyer account 456 whose - * bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; @@ -6471,12 +5897,7 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Full name of the resource to delete. For example: - For a bidder-level - * filter set for bidder 123: `bidders/123/filterSets/abc` - For an - * account-level filter set for the buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } @@ -6488,12 +5909,7 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Full name of the resource being requested. For example: - For a - * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - - * For an account-level filter set for the buyer account representing bidder - * 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level - * filter set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } @@ -6505,23 +5921,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the owner (bidder or account) of the filter sets to be listed. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123` - For an account-level filter set for the buyer account - * representing bidder 123: `bidders/123/accounts/123` - For an - * account-level filter set for the child seat buyer account 456 whose - * bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListFilterSetsResponse.nextPageToken - * returned from the previous call to the accounts.filterSets.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. */ pageToken?: string; } @@ -6620,24 +6028,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListBidMetricsResponse.nextPageToken - * returned from the previous call to the bidMetrics.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. */ pageToken?: string; } @@ -6650,10 +6049,8 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list - * @desc List all errors that occurred in bid responses, with the number of - * bid responses affected for each reason. - * @alias - * adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list + * @desc List all errors that occurred in bid responses, with the number of bid responses affected for each reason. + * @alias adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list * @memberOf! () * * @param {object} params Parameters for request @@ -6744,25 +6141,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListBidResponseErrorsResponse.nextPageToken returned from the previous - * call to the bidResponseErrors.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. */ pageToken?: string; } @@ -6775,11 +6162,8 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list - * @desc List all reasons for which bid responses were considered to have no - * applicable bids, with the number of bid responses affected for each - * reason. - * @alias - * adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list + * @desc List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason. + * @alias adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list * @memberOf! () * * @param {object} params Parameters for request @@ -6872,25 +6256,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListBidResponsesWithoutBidsResponse.nextPageToken returned from the - * previous call to the bidResponsesWithoutBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. */ pageToken?: string; } @@ -6903,10 +6277,8 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list - * @desc List all reasons that caused a bid request not to be sent for an - * impression, with the number of bid requests not sent for each reason. - * @alias - * adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list + * @desc List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason. + * @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list * @memberOf! () * * @param {object} params Parameters for request @@ -6997,25 +6369,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListFilteredBidRequestsResponse.nextPageToken returned from the previous - * call to the filteredBidRequests.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. */ pageToken?: string; } @@ -7036,8 +6398,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list - * @desc List all reasons for which bids were filtered, with the number of - * bids filtered for each reason. + * @desc List all reasons for which bids were filtered, with the number of bids filtered for each reason. * @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list * @memberOf! () * @@ -7123,24 +6484,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListFilteredBidsResponse.nextPageToken - * returned from the previous call to the filteredBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. */ pageToken?: string; } @@ -7153,10 +6505,8 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list - * @desc List all creatives associated with a specific reason for which bids - * were filtered, with the number of bids filtered for each creative. - * @alias - * adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list + * @desc List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative. + * @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list * @memberOf! () * * @param {object} params Parameters for request @@ -7265,31 +6615,19 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the creative status for which to retrieve a breakdown by - * creative. See - * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). + * The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from - * the previous call to the filteredBids.creatives.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. */ pageToken?: string; } @@ -7302,10 +6640,8 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list - * @desc List all details associated with a specific reason for which bids - * were filtered, with the number of bids filtered for each detail. - * @alias - * adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list + * @desc List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail. + * @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list * @memberOf! () * * @param {object} params Parameters for request @@ -7414,33 +6750,19 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the creative status for which to retrieve a breakdown by - * detail. See - * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). - * Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, - * and 87. + * The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from - * the previous call to the filteredBids.details.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. */ pageToken?: string; } @@ -7453,10 +6775,8 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list - * @desc Lists all metrics that are measured in terms of number of - * impressions. - * @alias - * adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list + * @desc Lists all metrics that are measured in terms of number of impressions. + * @alias adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list * @memberOf! () * * @param {object} params Parameters for request @@ -7547,25 +6867,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListImpressionMetricsResponse.nextPageToken returned from the previous - * call to the impressionMetrics.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. */ pageToken?: string; } @@ -7578,8 +6888,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.losingBids.list - * @desc List all reasons for which bids lost in the auction, with the - * number of bids that lost for each reason. + * @desc List all reasons for which bids lost in the auction, with the number of bids that lost for each reason. * @alias adexchangebuyer2.bidders.accounts.filterSets.losingBids.list * @memberOf! () * @@ -7665,24 +6974,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListLosingBidsResponse.nextPageToken - * returned from the previous call to the losingBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. */ pageToken?: string; } @@ -7695,10 +6995,8 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list - * @desc List all reasons for which winning bids were not billable, with the - * number of bids not billed for each reason. - * @alias - * adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list + * @desc List all reasons for which winning bids were not billable, with the number of bids not billed for each reason. + * @alias adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list * @memberOf! () * * @param {object} params Parameters for request @@ -7789,25 +7087,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListNonBillableWinningBidsResponse.nextPageToken returned from the - * previous call to the nonBillableWinningBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. */ pageToken?: string; } @@ -7852,8 +7140,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.create - * @desc Creates the specified filter set for the account with the given - * account ID. + * @desc Creates the specified filter set for the account with the given account ID. * @alias adexchangebuyer2.bidders.filterSets.create * @memberOf! () * @@ -7930,8 +7217,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.delete - * @desc Deletes the requested filter set from the account with the given - * account ID. + * @desc Deletes the requested filter set from the account with the given account ID. * @alias adexchangebuyer2.bidders.filterSets.delete * @memberOf! () * @@ -8001,8 +7287,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.get - * @desc Retrieves the requested filter set for the account with the given - * account ID. + * @desc Retrieves the requested filter set for the account with the given account ID. * @alias adexchangebuyer2.bidders.filterSets.get * @memberOf! () * @@ -8160,18 +7445,11 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the filter set is transient, or should be persisted indefinitely. - * By default, filter sets are not transient. If transient, it will be - * available for at least 1 hour after creation. + * Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. */ isTransient?: boolean; /** - * Name of the owner (bidder or account) of the filter set to be created. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123` - For an account-level filter set for the buyer account - * representing bidder 123: `bidders/123/accounts/123` - For an - * account-level filter set for the child seat buyer account 456 whose - * bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; @@ -8188,12 +7466,7 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Full name of the resource to delete. For example: - For a bidder-level - * filter set for bidder 123: `bidders/123/filterSets/abc` - For an - * account-level filter set for the buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } @@ -8205,12 +7478,7 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Full name of the resource being requested. For example: - For a - * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - - * For an account-level filter set for the buyer account representing bidder - * 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level - * filter set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } @@ -8222,23 +7490,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the owner (bidder or account) of the filter sets to be listed. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123` - For an account-level filter set for the buyer account - * representing bidder 123: `bidders/123/accounts/123` - For an - * account-level filter set for the child seat buyer account 456 whose - * bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListFilterSetsResponse.nextPageToken - * returned from the previous call to the accounts.filterSets.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. */ pageToken?: string; } @@ -8337,24 +7597,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListBidMetricsResponse.nextPageToken - * returned from the previous call to the bidMetrics.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. */ pageToken?: string; } @@ -8367,8 +7618,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.bidResponseErrors.list - * @desc List all errors that occurred in bid responses, with the number of - * bid responses affected for each reason. + * @desc List all errors that occurred in bid responses, with the number of bid responses affected for each reason. * @alias adexchangebuyer2.bidders.filterSets.bidResponseErrors.list * @memberOf! () * @@ -8460,25 +7710,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListBidResponseErrorsResponse.nextPageToken returned from the previous - * call to the bidResponseErrors.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. */ pageToken?: string; } @@ -8491,9 +7731,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list - * @desc List all reasons for which bid responses were considered to have no - * applicable bids, with the number of bid responses affected for each - * reason. + * @desc List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason. * @alias adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list * @memberOf! () * @@ -8587,25 +7825,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListBidResponsesWithoutBidsResponse.nextPageToken returned from the - * previous call to the bidResponsesWithoutBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. */ pageToken?: string; } @@ -8618,8 +7846,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.filteredBidRequests.list - * @desc List all reasons that caused a bid request not to be sent for an - * impression, with the number of bid requests not sent for each reason. + * @desc List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason. * @alias adexchangebuyer2.bidders.filterSets.filteredBidRequests.list * @memberOf! () * @@ -8711,25 +7938,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListFilteredBidRequestsResponse.nextPageToken returned from the previous - * call to the filteredBidRequests.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. */ pageToken?: string; } @@ -8750,8 +7967,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.filteredBids.list - * @desc List all reasons for which bids were filtered, with the number of - * bids filtered for each reason. + * @desc List all reasons for which bids were filtered, with the number of bids filtered for each reason. * @alias adexchangebuyer2.bidders.filterSets.filteredBids.list * @memberOf! () * @@ -8837,24 +8053,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListFilteredBidsResponse.nextPageToken - * returned from the previous call to the filteredBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. */ pageToken?: string; } @@ -8867,8 +8074,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list - * @desc List all creatives associated with a specific reason for which bids - * were filtered, with the number of bids filtered for each creative. + * @desc List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative. * @alias adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list * @memberOf! () * @@ -8978,31 +8184,19 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the creative status for which to retrieve a breakdown by - * creative. See - * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). + * The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from - * the previous call to the filteredBids.creatives.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. */ pageToken?: string; } @@ -9015,8 +8209,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.filteredBids.details.list - * @desc List all details associated with a specific reason for which bids - * were filtered, with the number of bids filtered for each detail. + * @desc List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail. * @alias adexchangebuyer2.bidders.filterSets.filteredBids.details.list * @memberOf! () * @@ -9126,33 +8319,19 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the creative status for which to retrieve a breakdown by - * detail. See - * [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). - * Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, - * and 87. + * The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from - * the previous call to the filteredBids.details.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. */ pageToken?: string; } @@ -9165,8 +8344,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.impressionMetrics.list - * @desc Lists all metrics that are measured in terms of number of - * impressions. + * @desc Lists all metrics that are measured in terms of number of impressions. * @alias adexchangebuyer2.bidders.filterSets.impressionMetrics.list * @memberOf! () * @@ -9258,25 +8436,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListImpressionMetricsResponse.nextPageToken returned from the previous - * call to the impressionMetrics.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. */ pageToken?: string; } @@ -9289,8 +8457,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.losingBids.list - * @desc List all reasons for which bids lost in the auction, with the - * number of bids that lost for each reason. + * @desc List all reasons for which bids lost in the auction, with the number of bids that lost for each reason. * @alias adexchangebuyer2.bidders.filterSets.losingBids.list * @memberOf! () * @@ -9376,24 +8543,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListLosingBidsResponse.nextPageToken - * returned from the previous call to the losingBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. */ pageToken?: string; } @@ -9406,8 +8564,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list - * @desc List all reasons for which winning bids were not billable, with the - * number of bids not billed for each reason. + * @desc List all reasons for which winning bids were not billable, with the number of bids not billed for each reason. * @alias adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list * @memberOf! () * @@ -9499,25 +8656,15 @@ export namespace adexchangebuyer2_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the filter set that should be applied to the requested metrics. - * For example: - For a bidder-level filter set for bidder 123: - * `bidders/123/filterSets/abc` - For an account-level filter set for the - * buyer account representing bidder 123: - * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter - * set for the child seat buyer account 456 whose bidder is 123: - * `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of - * ListNonBillableWinningBidsResponse.nextPageToken returned from the - * previous call to the nonBillableWinningBids.list method. + * A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. */ pageToken?: string; } diff --git a/src/apis/adexperiencereport/package.json b/src/apis/adexperiencereport/package.json index 3959fd32adb..a4c7f117436 100644 --- a/src/apis/adexperiencereport/package.json +++ b/src/apis/adexperiencereport/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/adexperiencereport/v1.ts b/src/apis/adexperiencereport/v1.ts index 80c84a14b8a..5ef1ced9a48 100644 --- a/src/apis/adexperiencereport/v1.ts +++ b/src/apis/adexperiencereport/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace adexperiencereport_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace adexperiencereport_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace adexperiencereport_v1 { /** * Ad Experience Report API * - * Views Ad Experience Report data, and gets a list of sites that have a - * significant number of annoying ads. + * Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace adexperiencereport_v1 { violatingSites: Resource$Violatingsites; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.sites = new Resource$Sites(this.context); this.violatingSites = new Resource$Violatingsites(this.context); @@ -266,14 +264,7 @@ export namespace adexperiencereport_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The required site name. It should be the site property whose ad - * experiences may have been reviewed, and it should be URL-encoded. For - * example, sites/https%3A%2F%2Fwww.google.com. The server will return an - * error of BAD_REQUEST if this field is not filled in. Note that if the - * site property is not yet verified in Search Console, the reportUrl field - * returned by the API will lead to the verification page, prompting the - * user to go through that process before they can gain access to the Ad - * Experience Report. + * The required site name. It should be the site property whose ad experiences may have been reviewed, and it should be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Ad Experience Report. */ name?: string; } @@ -286,8 +277,7 @@ export namespace adexperiencereport_v1 { /** * adexperiencereport.violatingSites.list - * @desc Lists sites with Ad Experience Report statuses of "Failing" or - * "Warning". + * @desc Lists sites with Ad Experience Report statuses of "Failing" or "Warning". * @alias adexperiencereport.violatingSites.list * @memberOf! () * diff --git a/src/apis/admin/datatransfer_v1.ts b/src/apis/admin/datatransfer_v1.ts index fcfc7e95b51..482f15aedae 100644 --- a/src/apis/admin/datatransfer_v1.ts +++ b/src/apis/admin/datatransfer_v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace admin_datatransfer_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace admin_datatransfer_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -96,7 +93,10 @@ export namespace admin_datatransfer_v1 { transfers: Resource$Transfers; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.applications = new Resource$Applications(this.context); this.transfers = new Resource$Transfers(this.context); @@ -124,9 +124,7 @@ export namespace admin_datatransfer_v1 { */ name?: string; /** - * The list of all possible transfer parameters for this application. These - * parameters can be used to select the data of the user in this application - * to be transfered. + * The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered. */ transferParams?: Schema$ApplicationTransferParam[]; } @@ -139,8 +137,7 @@ export namespace admin_datatransfer_v1 { */ applicationId?: string; /** - * The transfer parameters for the application. These parameters are used to - * select the data which will get transfered in context of this application. + * The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application. */ applicationTransferParams?: Schema$ApplicationTransferParam[]; /** @@ -153,8 +150,7 @@ export namespace admin_datatransfer_v1 { */ export interface Schema$ApplicationsListResponse { /** - * List of applications that support data transfer and are also installed - * for the customer. + * List of applications that support data transfer and are also installed for the customer. */ applications?: Schema$Application[]; /** @@ -179,8 +175,7 @@ export namespace admin_datatransfer_v1 { */ key?: string; /** - * The value of the coressponding transfer parameter. eg: 'PRIVATE' - * or 'SHARED' + * The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED' */ value?: string[]; } @@ -189,11 +184,7 @@ export namespace admin_datatransfer_v1 { */ export interface Schema$DataTransfer { /** - * List of per application data transfer resources. It contains data - * transfer details of the applications associated with this transfer - * resource. Note that this list is also used to specify the applications - * for which data transfer has to be done at the time of the transfer - * resource creation. + * List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation. */ applicationDataTransfers?: Schema$ApplicationDataTransfer[]; /** @@ -255,8 +246,7 @@ export namespace admin_datatransfer_v1 { /** * datatransfer.applications.get - * @desc Retrieves information about an application for the given - * application ID. + * @desc Retrieves information about an application for the given application ID. * @alias datatransfer.applications.get * @memberOf! () * @@ -590,8 +580,7 @@ export namespace admin_datatransfer_v1 { /** * datatransfer.transfers.list - * @desc Lists the transfers for a customer by source user, destination - * user, or status. + * @desc Lists the transfers for a customer by source user, destination user, or status. * @alias datatransfer.transfers.list * @memberOf! () * @@ -682,8 +671,7 @@ export namespace admin_datatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the resource to be retrieved. This is returned in the response from - * the insert method. + * ID of the resource to be retrieved. This is returned in the response from the insert method. */ dataTransferId?: string; } diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index c97b5546361..0440d9a5583 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace admin_directory_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace admin_directory_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace admin_directory_v1 { /** * Admin Directory API * - * Manages enterprise resources such as users and groups, administrative - * notifications, security features, and more. + * Manages enterprise resources such as users and groups, administrative notifications, security features, and more. * * @example * const {google} = require('googleapis'); @@ -115,7 +111,10 @@ export namespace admin_directory_v1 { verificationCodes: Resource$Verificationcodes; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.asps = new Resource$Asps(this.context); this.channels = new Resource$Channels(this.context); @@ -163,8 +162,7 @@ export namespace admin_directory_v1 { */ kind?: string; /** - * Group's primary email (Read-only) User's primary email - * (Read-only) + * Group's primary email (Read-only) User's primary email (Read-only) */ primaryEmail?: string; } @@ -194,13 +192,11 @@ export namespace admin_directory_v1 { */ blockedApiAccessBuckets?: string[]; /** - * Boolean to indicate whether to enforce app access settings on Android - * Drive or not. + * Boolean to indicate whether to enforce app access settings on Android Drive or not. */ enforceSettingsForAndroidDrive?: boolean; /** - * Error message provided by the Admin that will be shown to the user when - * an app is blocked. + * Error message provided by the Admin that will be shown to the user when an app is blocked. */ errorMessage?: string; /** @@ -208,8 +204,7 @@ export namespace admin_directory_v1 { */ etag?: string; /** - * Identifies the resource as an app access collection. Value: - * admin#directory#appaccesscollection + * Identifies the resource as an app access collection. Value: admin#directory#appaccesscollection */ kind?: string; /** @@ -217,8 +212,7 @@ export namespace admin_directory_v1 { */ resourceId?: string; /** - * Resource name given by the customer while creating/updating. Should be - * unique under given customer. + * Resource name given by the customer while creating/updating. Should be unique under given customer. */ resourceName?: string; /** @@ -251,8 +245,7 @@ export namespace admin_directory_v1 { */ lastTimeUsed?: string; /** - * The name of the application that the user, represented by their userId, - * entered when the ASP was created. + * The name of the application that the user, represented by their userId, entered when the ASP was created. */ name?: string; /** @@ -279,8 +272,7 @@ export namespace admin_directory_v1 { */ export interface Schema$Building { /** - * The postal address of the building. See PostalAddress for details. Note - * that only a single address line and region code are required. + * The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required. */ address?: Schema$BuildingAddress; /** @@ -288,19 +280,15 @@ export namespace admin_directory_v1 { */ buildingId?: string; /** - * The building name as seen by users in Calendar. Must be unique for the - * customer. For example, "NYC-CHEL". The maximum length is 100 - * characters. + * The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters. */ buildingName?: string; /** - * The geographic coordinates of the center of the building, expressed as - * latitude and longitude in decimal degrees. + * The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. */ coordinates?: Schema$BuildingCoordinates; /** - * A brief description of the building. For example, "Chelsea - * Market". + * A brief description of the building. For example, "Chelsea Market". */ description?: string; /** @@ -308,11 +296,7 @@ export namespace admin_directory_v1 { */ etags?: string; /** - * The display names for all floors in this building. The floors are - * expected to be sorted in ascending order, from lowest floor to highest - * floor. For example, ["B2", "B1", "L", - * "1", "2", "2M", "3", - * "PH"] Must contain at least one entry. + * The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry. */ floorNames?: string[]; /** @@ -329,20 +313,15 @@ export namespace admin_directory_v1 { */ addressLines?: string[]; /** - * Optional. Highest administrative subdivision which is used for postal - * addresses of a country or region. + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. */ administrativeArea?: string; /** - * Optional. BCP-47 language code of the contents of this address (if - * known). + * Optional. BCP-47 language code of the contents of this address (if known). */ languageCode?: string; /** - * Optional. Generally refers to the city/town portion of the address. - * Examples: US city, IT comune, UK post town. In regions of the world where - * localities are not well defined or do not fit into this structure well, - * leave locality empty and use addressLines. + * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines. */ locality?: string; /** @@ -388,8 +367,7 @@ export namespace admin_directory_v1 { */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -419,19 +397,15 @@ export namespace admin_directory_v1 { */ floorSection?: string; /** - * The read-only auto-generated name of the calendar resource which includes - * metadata about the resource such as building name, floor, capacity, etc. - * For example, "NYC-2-Training Room 1A (16)". + * The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, "NYC-2-Training Room 1A (16)". */ generatedResourceName?: string; /** - * The type of the resource. For calendar resources, the value is - * admin#directory#resources#calendars#CalendarResource. + * The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource. */ kind?: string; /** - * The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. - * Legacy data is set to CATEGORY_UNKNOWN. + * The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. */ resourceCategory?: string; /** @@ -439,8 +413,7 @@ export namespace admin_directory_v1 { */ resourceDescription?: string; /** - * The read-only email for the calendar resource. Generated as part of - * creating a new calendar resource. + * The read-only email for the calendar resource. Generated as part of creating a new calendar resource. */ resourceEmail?: string; /** @@ -448,8 +421,7 @@ export namespace admin_directory_v1 { */ resourceId?: string; /** - * The name of the calendar resource. For example, "Training Room - * 1A". + * The name of the calendar resource. For example, "Training Room 1A". */ resourceName?: string; /** @@ -474,13 +446,11 @@ export namespace admin_directory_v1 { */ items?: Schema$CalendarResource[]; /** - * Identifies this as a collection of CalendarResources. This is always - * admin#directory#resources#calendars#calendarResourcesList. + * Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -493,8 +463,7 @@ export namespace admin_directory_v1 { */ address?: string; /** - * Date and time of notification channel expiration, expressed as a Unix - * timestamp, in milliseconds. Optional. + * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ expiration?: string; /** @@ -502,8 +471,7 @@ export namespace admin_directory_v1 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a - * resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". */ kind?: string; /** @@ -515,8 +483,7 @@ export namespace admin_directory_v1 { */ payload?: boolean; /** - * An opaque ID that identifies the resource being watched on this channel. - * Stable across different API versions. + * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ resourceId?: string; /** @@ -524,8 +491,7 @@ export namespace admin_directory_v1 { */ resourceUri?: string; /** - * An arbitrary string delivered to the target address with each - * notification delivered over this channel. Optional. + * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ token?: string; /** @@ -609,8 +575,7 @@ export namespace admin_directory_v1 { */ lastEnrollmentTime?: string; /** - * Date and time the device was last synchronized with the policy settings - * in the G Suite administrator control panel (Read-only) + * Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) */ lastSync?: string; /** @@ -618,8 +583,7 @@ export namespace admin_directory_v1 { */ macAddress?: string; /** - * Mobile Equipment identifier for the 3G mobile card in the Chromebook - * (Read-only) + * Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only) */ meid?: string; /** @@ -647,8 +611,7 @@ export namespace admin_directory_v1 { */ platformVersion?: string; /** - * List of recent device users, in descending order by last login time - * (Read-only) + * List of recent device users, in descending order by last login time (Read-only) */ recentUsers?: Array<{email?: string; type?: string}>; /** @@ -691,8 +654,7 @@ export namespace admin_directory_v1 { willAutoRenew?: boolean; } /** - * JSON request template for firing actions on ChromeOs Device in Directory - * Devices API. + * JSON request template for firing actions on ChromeOs Device in Directory Devices API. */ export interface Schema$ChromeOsDeviceAction { /** @@ -702,8 +664,7 @@ export namespace admin_directory_v1 { deprovisionReason?: string; } /** - * JSON response template for List Chrome OS Devices operation in Directory - * API. + * JSON response template for List Chrome OS Devices operation in Directory API. */ export interface Schema$ChromeOsDevices { /** @@ -724,8 +685,7 @@ export namespace admin_directory_v1 { nextPageToken?: string; } /** - * JSON request template for moving ChromeOs Device to given OU in Directory - * Devices API. + * JSON request template for moving ChromeOs Device to given OU in Directory Devices API. */ export interface Schema$ChromeOsMoveDevicesToOu { /** @@ -738,8 +698,7 @@ export namespace admin_directory_v1 { */ export interface Schema$Customer { /** - * The customer's secondary contact email address. This email address - * cannot be on the same domain as the customerDomain + * The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain */ alternateEmail?: string; /** @@ -747,8 +706,7 @@ export namespace admin_directory_v1 { */ customerCreationTime?: string; /** - * The customer's primary domain name string. Do not include the www - * prefix when creating a new customer. + * The customer's primary domain name string. Do not include the www prefix when creating a new customer. */ customerDomain?: string; /** @@ -781,8 +739,7 @@ export namespace admin_directory_v1 { */ export interface Schema$CustomerPostalAddress { /** - * A customer's physical address. The address can be composed of one to - * three lines. + * A customer's physical address. The address can be composed of one to three lines. */ addressLine1?: string; /** @@ -798,13 +755,11 @@ export namespace admin_directory_v1 { */ contactName?: string; /** - * This is a required property. For countryCode information see the ISO 3166 - * country code elements. + * This is a required property. For countryCode information see the ISO 3166 country code elements. */ countryCode?: string; /** - * Name of the locality. An example of a locality value is the city of San - * Francisco. + * Name of the locality. An example of a locality value is the city of San Francisco. */ locality?: string; /** @@ -812,14 +767,11 @@ export namespace admin_directory_v1 { */ organizationName?: string; /** - * The postal code. A postalCode example is a postal zip code such as 10009. - * This is in accordance with - - * http://portablecontacts.net/draft-spec.html#address_element. + * The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element. */ postalCode?: string; /** - * Name of the region. An example of a region value is NY for the state of - * New York. + * Name of the region. An example of a region value is NY for the state of New York. */ region?: string; } @@ -844,8 +796,7 @@ export namespace admin_directory_v1 { */ kind?: string; /** - * The parent domain name that the domain alias is associated with. This can - * either be a primary or secondary domain name within a customer. + * The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer. */ parentDomainName?: string; /** @@ -942,8 +893,7 @@ export namespace admin_directory_v1 { */ export interface Schema$FeatureInstance { /** - * The feature that this is an instance of. A calendar resource may have - * multiple instances of a feature. + * The feature that this is an instance of. A calendar resource may have multiple instances of a feature. */ feature?: Schema$Feature; } @@ -973,8 +923,7 @@ export namespace admin_directory_v1 { */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -1061,8 +1010,7 @@ export namespace admin_directory_v1 { */ etag?: string; /** - * Unique identifier of customer member (Read-only) Unique identifier of - * group (Read-only) Unique identifier of member (Read-only) + * Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) */ id?: string; /** @@ -1108,8 +1056,7 @@ export namespace admin_directory_v1 { */ export interface Schema$MembersHasMember { /** - * Identifies whether the given user is a member of the group. Membership - * can be direct or nested. + * Identifies whether the given user is a member of the group. Membership can be direct or nested. */ isMember?: boolean; } @@ -1180,8 +1127,7 @@ export namespace admin_directory_v1 { */ etag?: string; /** - * Date and time the device was first synchronized with the policy settings - * in the G Suite administrator control panel (Read-only) + * Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only) */ firstSync?: string; /** @@ -1205,13 +1151,11 @@ export namespace admin_directory_v1 { */ kind?: string; /** - * Date and time the device was last synchronized with the policy settings - * in the G Suite administrator control panel (Read-only) + * Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) */ lastSync?: string; /** - * Boolean indicating if this account is on owner/primary profile or not - * (Read-only) + * Boolean indicating if this account is on owner/primary profile or not (Read-only) */ managedAccountIsOnOwnerProfile?: boolean; /** @@ -1288,8 +1232,7 @@ export namespace admin_directory_v1 { wifiMacAddress?: string; } /** - * JSON request template for firing commands on Mobile Device in Directory - * Devices API. + * JSON request template for firing commands on Mobile Device in Directory Devices API. */ export interface Schema$MobileDeviceAction { /** @@ -1419,8 +1362,7 @@ export namespace admin_directory_v1 { parentOrgUnitPath?: string; } /** - * JSON response template for List Organization Units operation in Directory - * API. + * JSON response template for List Organization Units operation in Directory API. */ export interface Schema$OrgUnits { /** @@ -1441,9 +1383,7 @@ export namespace admin_directory_v1 { */ export interface Schema$Privilege { /** - * A list of child privileges. Privileges for a service form a tree. Each - * privilege can have a list of child privileges; this list is empty for a - * leaf privilege. + * A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege. */ childPrivileges?: Schema$Privilege[]; /** @@ -1538,13 +1478,11 @@ export namespace admin_directory_v1 { */ etag?: string; /** - * The type of the API resource. This is always - * admin#directory#roleAssignment. + * The type of the API resource. This is always admin#directory#roleAssignment. */ kind?: string; /** - * If the role is restricted to an organization unit, this contains the ID - * for the organization unit the exercise of this role is restricted to. + * If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. */ orgUnitId?: string; /** @@ -1556,8 +1494,7 @@ export namespace admin_directory_v1 { */ roleId?: string; /** - * The scope in which this role is assigned. Possible values are: - - * CUSTOMER - ORG_UNIT + * The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT */ scopeType?: string; } @@ -1574,8 +1511,7 @@ export namespace admin_directory_v1 { */ items?: Schema$RoleAssignment[]; /** - * The type of the API resource. This is always - * admin#directory#roleAssignments. + * The type of the API resource. This is always admin#directory#roleAssignments. */ kind?: string; nextPageToken?: string; @@ -1664,15 +1600,11 @@ export namespace admin_directory_v1 { */ multiValued?: boolean; /** - * Indexing spec for a numeric field. By default, only exact match queries - * will be supported for numeric fields. Setting the numericIndexingSpec - * allows range queries to be supported. + * Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. */ numericIndexingSpec?: {maxValue?: number; minValue?: number}; /** - * Read ACLs on the field specifying who can view values of this field. - * Valid values are "ALL_DOMAIN_USERS" and - * "ADMINS_AND_SELF". + * Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". */ readAccessType?: string; } @@ -1698,8 +1630,7 @@ export namespace admin_directory_v1 { */ export interface Schema$Token { /** - * Whether the application is registered with Google. The value is true if - * the application has an anonymous Client ID. + * Whether the application is registered with Google. The value is true if the application has an anonymous Client ID. */ anonymous?: boolean; /** @@ -1719,8 +1650,7 @@ export namespace admin_directory_v1 { */ kind?: string; /** - * Whether the token is issued to an installed application. The value is - * true if the application is installed to a desktop or mobile device. + * Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device. */ nativeApp?: boolean; /** @@ -1927,9 +1857,7 @@ export namespace admin_directory_v1 { */ export interface Schema$UserAbout { /** - * About entry can have a type which indicates the content type. It can - * either be plain or html. By default, notes contents are assumed to - * contain plain text. + * About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text. */ contentType?: string; /** @@ -1974,8 +1902,7 @@ export namespace admin_directory_v1 { */ postalCode?: string; /** - * If this is user's primary address. Only one entry could be marked as - * primary. + * If this is user's primary address. Only one entry could be marked as primary. */ primary?: boolean; /** @@ -1983,9 +1910,7 @@ export namespace admin_directory_v1 { */ region?: string; /** - * User supplied address was structured. Structured addresses are NOT - * supported at this time. You might be able to write structured addresses, - * but any values will eventually be clobbered. + * User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses, but any values will eventually be clobbered. */ sourceIsStructured?: boolean; /** @@ -1993,17 +1918,12 @@ export namespace admin_directory_v1 { */ streetAddress?: string; /** - * Each entry can have a type which indicates standard values of that entry. - * For example address could be of home, work etc. In addition to the - * standard type, an entry can have a custom type and can take any value. - * Such type should have the CUSTOM value as type and also have a customType - * value. + * Each entry can have a type which indicates standard values of that entry. For example address could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value. */ type?: string; } /** - * JSON template for a set of custom properties (i.e. all fields in a - * particular schema) + * JSON template for a set of custom properties (i.e. all fields in a particular schema) */ export interface Schema$UserCustomProperties {} /** @@ -2019,15 +1939,11 @@ export namespace admin_directory_v1 { */ customType?: string; /** - * If this is user's primary email. Only one entry could be marked as - * primary. + * If this is user's primary email. Only one entry could be marked as primary. */ primary?: boolean; /** - * Each entry can have a type which indicates standard types of that entry. - * For example email could be of home, work etc. In addition to the standard - * type, an entry can have a custom type and can take any value Such types - * should have the CUSTOM value as type and also have a customType value. + * Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value. */ type?: string; } @@ -2050,9 +1966,7 @@ export namespace admin_directory_v1 { } export interface Schema$UserGender { /** - * AddressMeAs. A human-readable string containing the proper way to refer - * to the profile owner by humans, for example "he/him/his" or - * "they/them/their". + * AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans, for example "he/him/his" or "they/them/their". */ addressMeAs?: string; /** @@ -2081,22 +1995,15 @@ export namespace admin_directory_v1 { */ im?: string; /** - * If this is user's primary im. Only one entry could be marked as - * primary. + * If this is user's primary im. Only one entry could be marked as primary. */ primary?: boolean; /** - * Protocol used in the instant messenger. It should be one of the values - * from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and - * specify the custom name in customProtocol field. + * Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and specify the custom name in customProtocol field. */ protocol?: string; /** - * Each entry can have a type which indicates standard types of that entry. - * For example instant messengers could be of home, work etc. In addition to - * the standard type, an entry can have a custom type and can take any - * value. Such types should have the CUSTOM value as type and also have a - * customType value. + * Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value. */ type?: string; } @@ -2109,11 +2016,7 @@ export namespace admin_directory_v1 { */ customType?: string; /** - * Each entry can have a type which indicates standard type of that entry. - * For example, keyword could be of type occupation or outlook. In addition - * to the standard type, an entry can have a custom type and can give it any - * name. Such types should have the CUSTOM value as type and also have a - * customType value. + * Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. */ type?: string; /** @@ -2126,14 +2029,11 @@ export namespace admin_directory_v1 { */ export interface Schema$UserLanguage { /** - * Other language. User can provide own language name if there is no - * corresponding Google III language code. If this is set LanguageCode - * can't be set + * Other language. User can provide own language name if there is no corresponding Google III language code. If this is set LanguageCode can't be set */ customLanguage?: string; /** - * Language Code. Should be used for storing Google III LanguageCode string - * representation for language. Illegal values cause SchemaException. + * Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException. */ languageCode?: string; } @@ -2142,9 +2042,7 @@ export namespace admin_directory_v1 { */ export interface Schema$UserLocation { /** - * Textual location. This is most useful for display purposes to concisely - * describe the location. For example, "Mountain View, CA", - * "Near Seattle", "US-NYC-9TH 9A209A". + * Textual location. This is most useful for display purposes to concisely describe the location. For example, "Mountain View, CA", "Near Seattle", "US-NYC-9TH 9A209A". */ area?: string; /** @@ -2164,23 +2062,16 @@ export namespace admin_directory_v1 { */ floorName?: string; /** - * Floor section. More specific location within the floor. For example, if a - * floor is divided into sections "A", "B", and - * "C", this field would identify one of those values. + * Floor section. More specific location within the floor. For example, if a floor is divided into sections "A", "B", and "C", this field would identify one of those values. */ floorSection?: string; /** - * Each entry can have a type which indicates standard types of that entry. - * For example location could be of types default and desk. In addition to - * standard type, an entry can have a custom type and can give it any name. - * Such types should have "custom" as type and also have a - * customType value. + * Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type, an entry can have a custom type and can give it any name. Such types should have "custom" as type and also have a customType value. */ type?: string; } /** - * JSON request template for setting/revoking admin status of a user in - * Directory API. + * JSON request template for setting/revoking admin status of a user in Directory API. */ export interface Schema$UserMakeAdmin { /** @@ -2254,11 +2145,7 @@ export namespace admin_directory_v1 { */ title?: string; /** - * Each entry can have a type which indicates standard types of that entry. - * For example organization could be of school, work etc. In addition to the - * standard type, an entry can have a custom type and can give it any name. - * Such types should have the CUSTOM value as type and also have a - * CustomType value. + * Each entry can have a type which indicates standard types of that entry. For example organization could be of school, work etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value. */ type?: string; } @@ -2275,11 +2162,7 @@ export namespace admin_directory_v1 { */ primary?: boolean; /** - * Each entry can have a type which indicates standard types of that entry. - * For example phone could be of home_fax, work, mobile etc. In addition to - * the standard type, an entry can have a custom type and can give it any - * name. Such types should have the CUSTOM value as type and also have a - * customType value. + * Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax, work, mobile etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. */ type?: string; /** @@ -2325,8 +2208,7 @@ export namespace admin_directory_v1 { width?: number; } /** - * JSON template for a POSIX account entry. Description of the field family: - * go/fbs-posix. + * JSON template for a POSIX account entry. Description of the field family: go/fbs-posix. */ export interface Schema$UserPosixAccount { /** @@ -2379,8 +2261,7 @@ export namespace admin_directory_v1 { */ customType?: string; /** - * The relation of the user. Some of the possible values are mother, father, - * sister, brother, manager, assistant, partner. + * The relation of the user. Some of the possible values are mother, father, sister, brother, manager, assistant, partner. */ type?: string; /** @@ -2452,11 +2333,7 @@ export namespace admin_directory_v1 { */ primary?: boolean; /** - * Each entry can have a type which indicates standard types of that entry. - * For example website could be of home, work, blog etc. In addition to the - * standard type, an entry can have a custom type and can give it any name. - * Such types should have the CUSTOM value as type and also have a - * customType value. + * Each entry can have a type which indicates standard types of that entry. For example website could be of home, work, blog etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. */ type?: string; /** @@ -2473,8 +2350,7 @@ export namespace admin_directory_v1 { */ etag?: string; /** - * The type of the resource. This is always - * admin#directory#verificationCode. + * The type of the resource. This is always admin#directory#verificationCode. */ kind?: string; /** @@ -2482,14 +2358,12 @@ export namespace admin_directory_v1 { */ userId?: string; /** - * A current verification code for the user. Invalidated or used - * verification codes are not returned as part of the result. + * A current verification code for the user. Invalidated or used verification codes are not returned as part of the result. */ verificationCode?: string; } /** - * JSON response template for List verification codes operation in Directory - * API. + * JSON response template for List verification codes operation in Directory API. */ export interface Schema$VerificationCodes { /** @@ -2501,8 +2375,7 @@ export namespace admin_directory_v1 { */ items?: Schema$VerificationCode[]; /** - * The type of the resource. This is always - * admin#directory#verificationCodesList. + * The type of the resource. This is always admin#directory#verificationCodesList. */ kind?: string; } @@ -2738,8 +2611,7 @@ export namespace admin_directory_v1 { */ codeId?: number; /** - * Identifies the user in the API request. The value can be the user's - * primary email address, alias email address, or unique user ID. + * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */ userKey?: string; } @@ -2754,8 +2626,7 @@ export namespace admin_directory_v1 { */ codeId?: number; /** - * Identifies the user in the API request. The value can be the user's - * primary email address, alias email address, or unique user ID. + * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */ userKey?: string; } @@ -2766,8 +2637,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the user in the API request. The value can be the user's - * primary email address, alias email address, or unique user ID. + * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */ userKey?: string; } @@ -3400,13 +3270,11 @@ export namespace admin_directory_v1 { */ projection?: string; /** - * Search string in the format given at - * http://support.google.com/chromeos/a/bin/answer.py?answer=1698333 + * Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?answer=1698333 */ query?: string; /** - * Whether to return results in ascending or descending order. Only of use - * when orderBy is also used + * Whether to return results in ascending or descending order. Only of use when orderBy is also used */ sortOrder?: string; } @@ -4687,8 +4555,7 @@ export namespace admin_directory_v1 { /** * directory.groups.list - * @desc Retrieve all groups of a domain or of a user given a userKey - * (paginated) + * @desc Retrieve all groups of a domain or of a user given a userKey (paginated) * @alias directory.groups.list * @memberOf! () * @@ -4949,13 +4816,11 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Immutable ID of the G Suite account. In case of multi-domain, to fetch - * all groups for a customer, fill this field instead of domain. + * Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain. */ customer?: string; /** - * Name of the domain. Fill this field to get groups from only this domain. - * To return all groups in a multi-domain fill customer field instead. + * Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead. */ domain?: string; /** @@ -4971,20 +4836,15 @@ export namespace admin_directory_v1 { */ pageToken?: string; /** - * Query string search. Should be of the form "". Complete documentation is - * at - * https://developers.google.com/admin-sdk/directory/v1/guides/search-groups + * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups */ query?: string; /** - * Whether to return results in ascending or descending order. Only of use - * when orderBy is also used + * Whether to return results in ascending or descending order. Only of use when orderBy is also used */ sortOrder?: string; /** - * Email or immutable Id of the user if only those groups are to be listed, - * the given user is a member of. If Id, it should match with id of user - * object + * Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object */ userKey?: string; } @@ -4995,8 +4855,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Email or immutable ID of the group. If ID, it should match with id of - * group object + * Email or immutable ID of the group. If ID, it should match with id of group object */ groupKey?: string; @@ -5012,8 +4871,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Email or immutable ID of the group. If ID, it should match with id of - * group object + * Email or immutable ID of the group. If ID, it should match with id of group object */ groupKey?: string; @@ -5443,8 +5301,7 @@ export namespace admin_directory_v1 { /** * directory.members.hasMember - * @desc Checks whether the given user is a member of the group. Membership - * can be direct or nested. + * @desc Checks whether the given user is a member of the group. Membership can be direct or nested. * @alias directory.members.hasMember * @memberOf! () * @@ -5664,8 +5521,7 @@ export namespace admin_directory_v1 { /** * directory.members.patch - * @desc Update membership of a user in the specified group. This method - * supports patch semantics. + * @desc Update membership of a user in the specified group. This method supports patch semantics. * @alias directory.members.patch * @memberOf! () * @@ -5848,13 +5704,11 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the group in the API request. The value can be the group's - * email address, group alias, or the unique group ID. + * Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. */ groupKey?: string; /** - * Identifies the user member in the API request. The value can be the - * user's primary email address, alias, or unique ID. + * Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID. */ memberKey?: string; } @@ -5908,13 +5762,11 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Email or immutable ID of the group. If ID, it should match with id of - * group object + * Email or immutable ID of the group. If ID, it should match with id of group object */ groupKey?: string; /** - * Email or immutable ID of the user. If ID, it should match with id of - * member object + * Email or immutable ID of the user. If ID, it should match with id of member object */ memberKey?: string; @@ -5930,13 +5782,11 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Email or immutable ID of the group. If ID, it should match with id of - * group object + * Email or immutable ID of the group. If ID, it should match with id of group object */ groupKey?: string; /** - * Email or immutable ID of the user. If ID, it should match with id of - * member object + * Email or immutable ID of the user. If ID, it should match with id of member object */ memberKey?: string; @@ -6341,13 +6191,11 @@ export namespace admin_directory_v1 { */ projection?: string; /** - * Search string in the format given at - * http://support.google.com/a/bin/answer.py?answer=1408863#search + * Search string in the format given at http://support.google.com/a/bin/answer.py?answer=1408863#search */ query?: string; /** - * Whether to return results in ascending or descending order. Only of use - * when orderBy is also used + * Whether to return results in ascending or descending order. Only of use when orderBy is also used */ sortOrder?: string; } @@ -6743,8 +6591,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. The customerId is also - * returned as part of the Users resource. + * The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource. */ customer?: string; /** @@ -6760,8 +6607,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. The customerId is also - * returned as part of the Users resource. + * The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource. */ customer?: string; /** @@ -6781,8 +6627,7 @@ export namespace admin_directory_v1 { */ customer?: string; /** - * The ISO 639-1 code of the language notifications are returned in. The - * default is English (en). + * The ISO 639-1 code of the language notifications are returned in. The default is English (en). */ language?: string; /** @@ -7559,8 +7404,7 @@ export namespace admin_directory_v1 { /** * directory.resolvedAppAccessSettings.ListTrustedApps - * @desc Retrieves the list of apps trusted by the admin of the logged in - * user. + * @desc Retrieves the list of apps trusted by the admin of the logged in user. * @alias directory.resolvedAppAccessSettings.ListTrustedApps * @memberOf! () * @@ -8125,9 +7969,7 @@ export namespace admin_directory_v1 { */ buildingId?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; } @@ -8143,9 +7985,7 @@ export namespace admin_directory_v1 { */ buildingId?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; } @@ -8161,9 +8001,7 @@ export namespace admin_directory_v1 { */ coordinatesSource?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; @@ -8180,9 +8018,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -8210,9 +8046,7 @@ export namespace admin_directory_v1 { */ coordinatesSource?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; @@ -8237,9 +8071,7 @@ export namespace admin_directory_v1 { */ coordinatesSource?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; @@ -8558,10 +8390,7 @@ export namespace admin_directory_v1 { /** * directory.resources.calendars.patch - * @desc Updates a calendar resource. This method supports patch semantics, - * meaning you only need to include the fields you wish to update. Fields - * that are not present in the request will be preserved. This method - * supports patch semantics. + * @desc Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. This method supports patch semantics. * @alias directory.resources.calendars.patch * @memberOf! () * @@ -8637,9 +8466,7 @@ export namespace admin_directory_v1 { /** * directory.resources.calendars.update - * @desc Updates a calendar resource. This method supports patch semantics, - * meaning you only need to include the fields you wish to update. Fields - * that are not present in the request will be preserved. + * @desc Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. * @alias directory.resources.calendars.update * @memberOf! () * @@ -8726,9 +8553,7 @@ export namespace admin_directory_v1 { */ calendarResourceId?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; } @@ -8744,9 +8569,7 @@ export namespace admin_directory_v1 { */ calendarResourceId?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; } @@ -8758,9 +8581,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; @@ -8777,9 +8598,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -8787,12 +8606,7 @@ export namespace admin_directory_v1 { */ maxResults?: number; /** - * Field(s) to sort results by in either ascending or descending order. - * Supported fields include resourceId, resourceName, capacity, buildingId, - * and floorName. If no order is specified, defaults to ascending. Should be - * of the form "field [asc|desc], field [asc|desc], ...". For example - * buildingId, capacity desc would return results sorted first by buildingId - * in ascending order then by capacity in descending order. + * Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order. */ orderBy?: string; /** @@ -8800,14 +8614,7 @@ export namespace admin_directory_v1 { */ pageToken?: string; /** - * String query used to filter results. Should be of the form "field - * operator value" where field can be any of supported fields and operators - * can be any of supported operations. Operators include '=' for exact match - * and ':' for prefix match or HAS match where applicable. For prefix match, - * the value should always be followed by a *. Supported fields include - * generatedResourceName, name, buildingId, featureInstances.feature.name. - * For example buildingId=US-NYC-9TH AND - * featureInstances.feature.name:Phone. + * String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Supported fields include generatedResourceName, name, buildingId, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone. */ query?: string; } @@ -8823,9 +8630,7 @@ export namespace admin_directory_v1 { */ calendarResourceId?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; @@ -8846,9 +8651,7 @@ export namespace admin_directory_v1 { */ calendarResourceId?: string; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; @@ -9388,9 +9191,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -9406,9 +9207,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -9424,9 +9223,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; @@ -9443,9 +9240,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -9465,9 +9260,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -9488,9 +9281,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -9511,9 +9302,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the customer's G Suite account. As an account - * administrator, you can also use the my_customer alias to represent your - * account's customer ID. + * The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. */ customer?: string; /** @@ -9904,13 +9693,11 @@ export namespace admin_directory_v1 { */ pageToken?: string; /** - * Immutable ID of a role. If included in the request, returns only role - * assignments containing this role ID. + * Immutable ID of a role. If included in the request, returns only role assignments containing this role ID. */ roleId?: string; /** - * The user's primary email address, alias email address, or unique user ID. - * If included in the request, returns role assignments only for this user. + * The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user. */ userKey?: string; } @@ -11143,8 +10930,7 @@ export namespace admin_directory_v1 { /** * directory.tokens.list - * @desc Returns the set of tokens specified user has issued to 3rd party - * applications. + * @desc Returns the set of tokens specified user has issued to 3rd party applications. * @alias directory.tokens.list * @memberOf! () * @@ -11224,8 +11010,7 @@ export namespace admin_directory_v1 { */ clientId?: string; /** - * Identifies the user in the API request. The value can be the user's - * primary email address, alias email address, or unique user ID. + * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */ userKey?: string; } @@ -11240,8 +11025,7 @@ export namespace admin_directory_v1 { */ clientId?: string; /** - * Identifies the user in the API request. The value can be the user's - * primary email address, alias email address, or unique user ID. + * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */ userKey?: string; } @@ -11252,8 +11036,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the user in the API request. The value can be the user's - * primary email address, alias email address, or unique user ID. + * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */ userKey?: string; } @@ -11954,8 +11737,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Comma-separated list of schema names. All fields from these schemas are - * fetched. This should only be set when projection=custom. + * Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. */ customFieldMask?: string; /** @@ -11989,18 +11771,15 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Immutable ID of the G Suite account. In case of multi-domain, to fetch - * all users for a customer, fill this field instead of domain. + * Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. */ customer?: string; /** - * Comma-separated list of schema names. All fields from these schemas are - * fetched. This should only be set when projection=custom. + * Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. */ customFieldMask?: string; /** - * Name of the domain. Fill this field to get users from only this domain. - * To return all users in a multi-domain fill customer field instead. + * Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. */ domain?: string; /** @@ -12024,9 +11803,7 @@ export namespace admin_directory_v1 { */ projection?: string; /** - * Query string search. Should be of the form "". Complete documentation is - * at - * https://developers.google.com/admin-sdk/directory/v1/guides/search-users + * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users */ query?: string; /** @@ -12065,8 +11842,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Email or immutable ID of the user. If ID, it should match with id of user - * object + * Email or immutable ID of the user. If ID, it should match with id of user object */ userKey?: string; @@ -12098,8 +11874,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Email or immutable ID of the user. If ID, it should match with id of user - * object + * Email or immutable ID of the user. If ID, it should match with id of user object */ userKey?: string; @@ -12115,18 +11890,15 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Immutable ID of the G Suite account. In case of multi-domain, to fetch - * all users for a customer, fill this field instead of domain. + * Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. */ customer?: string; /** - * Comma-separated list of schema names. All fields from these schemas are - * fetched. This should only be set when projection=custom. + * Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. */ customFieldMask?: string; /** - * Name of the domain. Fill this field to get users from only this domain. - * To return all users in a multi-domain fill customer field instead. + * Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. */ domain?: string; /** @@ -12150,9 +11922,7 @@ export namespace admin_directory_v1 { */ projection?: string; /** - * Query string search. Should be of the form "". Complete documentation is - * at - * https://developers.google.com/admin-sdk/directory/v1/guides/search-users + * Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users */ query?: string; /** @@ -13049,8 +12819,7 @@ export namespace admin_directory_v1 { /** * directory.verificationCodes.list - * @desc Returns the current set of valid backup verification codes for the - * specified user. + * @desc Returns the current set of valid backup verification codes for the specified user. * @alias directory.verificationCodes.list * @memberOf! () * @@ -13154,8 +12923,7 @@ export namespace admin_directory_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the user in the API request. The value can be the user's - * primary email address, alias email address, or unique user ID. + * Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */ userKey?: string; } diff --git a/src/apis/admin/package.json b/src/apis/admin/package.json index 3afa1daa4f7..362a3bb6d59 100644 --- a/src/apis/admin/package.json +++ b/src/apis/admin/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index 8ad4711d9d6..1bbca1bb44d 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace admin_reports_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace admin_reports_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace admin_reports_v1 { /** * Admin Reports API * - * Fetches reports for the administrators of G Suite customers about the - * usage, collaboration, security, and risk for their users. + * Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users. * * @example * const {google} = require('googleapis'); @@ -100,7 +96,10 @@ export namespace admin_reports_v1 { userUsageReport: Resource$Userusagereport; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.activities = new Resource$Activities(this.context); this.channels = new Resource$Channels(this.context); @@ -196,8 +195,7 @@ export namespace admin_reports_v1 { */ address?: string; /** - * Date and time of notification channel expiration, expressed as a Unix - * timestamp, in milliseconds. Optional. + * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ expiration?: string; /** @@ -205,8 +203,7 @@ export namespace admin_reports_v1 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a - * resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". */ kind?: string; /** @@ -218,8 +215,7 @@ export namespace admin_reports_v1 { */ payload?: boolean; /** - * An opaque ID that identifies the resource being watched on this channel. - * Stable across different API versions. + * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ resourceId?: string; /** @@ -227,8 +223,7 @@ export namespace admin_reports_v1 { */ resourceUri?: string; /** - * An arbitrary string delivered to the target address with each - * notification delivered over this channel. Optional. + * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ token?: string; /** @@ -312,8 +307,7 @@ export namespace admin_reports_v1 { /** * reports.activities.list - * @desc Retrieves a list of activities for a specific customer and - * application. + * @desc Retrieves a list of activities for a specific customer and application. * @alias reports.activities.list * @memberOf! () * @@ -484,8 +478,7 @@ export namespace admin_reports_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * IP Address of host where the event was performed. Supports both IPv4 and - * IPv6 addresses. + * IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. */ actorIpAddress?: string; /** @@ -505,8 +498,7 @@ export namespace admin_reports_v1 { */ eventName?: string; /** - * Event parameters in the form [parameter1 name][operator][parameter1 - * value],[parameter2 name][operator][parameter2 value],... + * Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... */ filters?: string; /** @@ -514,8 +506,7 @@ export namespace admin_reports_v1 { */ maxResults?: number; /** - * the organizational unit's(OU) ID to filter activities from users - * belonging to a specific OU or one of its sub-OU(s) + * the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s) */ orgUnitID?: string; /** @@ -527,9 +518,7 @@ export namespace admin_reports_v1 { */ startTime?: string; /** - * Represents the profile id or the user email for which the data should be - * filtered. When 'all' is specified as the userKey, it returns usageReports - * for all users. + * Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. */ userKey?: string; } @@ -540,8 +529,7 @@ export namespace admin_reports_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * IP Address of host where the event was performed. Supports both IPv4 and - * IPv6 addresses. + * IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. */ actorIpAddress?: string; /** @@ -561,8 +549,7 @@ export namespace admin_reports_v1 { */ eventName?: string; /** - * Event parameters in the form [parameter1 name][operator][parameter1 - * value],[parameter2 name][operator][parameter2 value],... + * Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... */ filters?: string; /** @@ -570,8 +557,7 @@ export namespace admin_reports_v1 { */ maxResults?: number; /** - * the organizational unit's(OU) ID to filter activities from users - * belonging to a specific OU or one of its sub-OU(s) + * the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s) */ orgUnitID?: string; /** @@ -583,9 +569,7 @@ export namespace admin_reports_v1 { */ startTime?: string; /** - * Represents the profile id or the user email for which the data should be - * filtered. When 'all' is specified as the userKey, it returns usageReports - * for all users. + * Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. */ userKey?: string; @@ -692,8 +676,7 @@ export namespace admin_reports_v1 { /** * reports.customerUsageReports.get - * @desc Retrieves a report which is a collection of properties / statistics - * for a specific customer. + * @desc Retrieves a report which is a collection of properties / statistics for a specific customer. * @alias reports.customerUsageReports.get * @memberOf! () * @@ -781,8 +764,7 @@ export namespace admin_reports_v1 { */ customerId?: string; /** - * Represents the date in yyyy-mm-dd format for which the data is to be - * fetched. + * Represents the date in yyyy-mm-dd format for which the data is to be fetched. */ date?: string; /** @@ -790,8 +772,7 @@ export namespace admin_reports_v1 { */ pageToken?: string; /** - * Represents the application name, parameter name pairs to fetch in csv as - * app_name1:param_name1, app_name2:param_name2. + * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. */ parameters?: string; } @@ -804,8 +785,7 @@ export namespace admin_reports_v1 { /** * reports.entityUsageReports.get - * @desc Retrieves a report which is a collection of properties / statistics - * for a set of objects. + * @desc Retrieves a report which is a collection of properties / statistics for a set of objects. * @alias reports.entityUsageReports.get * @memberOf! () * @@ -897,8 +877,7 @@ export namespace admin_reports_v1 { */ customerId?: string; /** - * Represents the date in yyyy-mm-dd format for which the data is to be - * fetched. + * Represents the date in yyyy-mm-dd format for which the data is to be fetched. */ date?: string; /** @@ -922,8 +901,7 @@ export namespace admin_reports_v1 { */ pageToken?: string; /** - * Represents the application name, parameter name pairs to fetch in csv as - * app_name1:param_name1, app_name2:param_name2. + * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. */ parameters?: string; } @@ -936,8 +914,7 @@ export namespace admin_reports_v1 { /** * reports.userUsageReport.get - * @desc Retrieves a report which is a collection of properties / statistics - * for a set of users. + * @desc Retrieves a report which is a collection of properties / statistics for a set of users. * @alias reports.userUsageReport.get * @memberOf! () * @@ -1028,8 +1005,7 @@ export namespace admin_reports_v1 { */ customerId?: string; /** - * Represents the date in yyyy-mm-dd format for which the data is to be - * fetched. + * Represents the date in yyyy-mm-dd format for which the data is to be fetched. */ date?: string; /** @@ -1041,8 +1017,7 @@ export namespace admin_reports_v1 { */ maxResults?: number; /** - * the organizational unit's ID to filter usage parameters from users - * belonging to a specific OU or one of its sub-OU(s). + * the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s). */ orgUnitID?: string; /** @@ -1050,13 +1025,11 @@ export namespace admin_reports_v1 { */ pageToken?: string; /** - * Represents the application name, parameter name pairs to fetch in csv as - * app_name1:param_name1, app_name2:param_name2. + * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. */ parameters?: string; /** - * Represents the profile id or the user email for which the data should be - * filtered. + * Represents the profile id or the user email for which the data should be filtered. */ userKey?: string; } diff --git a/src/apis/adsense/package.json b/src/apis/adsense/package.json index c0af0c71338..da3c0e9ae89 100644 --- a/src/apis/adsense/package.json +++ b/src/apis/adsense/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts index 2fd75c2d634..50e7d894e1f 100644 --- a/src/apis/adsense/v1.4.ts +++ b/src/apis/adsense/v1.4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace adsense_v1_4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace adsense_v1_4 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace adsense_v1_4 { /** * AdSense Management API * - * Accesses AdSense publishers' inventory and generates performance - * reports. + * Accesses AdSense publishers' inventory and generates performance reports. * * @example * const {google} = require('googleapis'); @@ -105,7 +101,10 @@ export namespace adsense_v1_4 { urlchannels: Resource$Urlchannels; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.adclients = new Resource$Adclients(this.context); @@ -161,9 +160,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * Continuation token used to page through accounts. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -181,8 +178,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * This ad client's product code, which corresponds to the PRODUCT_CODE - * report dimension. + * This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. */ productCode?: string; /** @@ -204,9 +200,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * Continuation token used to page through ad clients. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -230,8 +224,7 @@ export namespace adsense_v1_4 { } export interface Schema$AdsenseReportsGenerateResponse { /** - * The averages of the report. This is the same length as any other row in - * the report; cells corresponding to dimension columns are empty. + * The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ averages?: string[]; /** @@ -239,9 +232,7 @@ export namespace adsense_v1_4 { */ endDate?: string; /** - * The header information of the columns requested in the report. This is a - * list of headers; one for each dimension in the request, followed by one - * for each metric in the request. + * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. */ headers?: Array<{currency?: string; name?: string; type?: string}>; /** @@ -249,10 +240,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * The output rows of the report. Each row is a list of cells; one for each - * dimension in the request, followed by one for each metric in the request. - * The dimension cells contain strings, and the metric cells contain - * numbers. + * The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers. */ rows?: string[][]; /** @@ -260,14 +248,11 @@ export namespace adsense_v1_4 { */ startDate?: string; /** - * The total number of rows matched by the report request. Fewer rows may be - * returned in the response due to being limited by the row count requested - * or the report row limit. + * The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit. */ totalMatchedRows?: string; /** - * The totals of the report. This is the same length as any other row in the - * report; cells corresponding to dimension columns are empty. + * The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ totals?: string[]; /** @@ -277,9 +262,7 @@ export namespace adsense_v1_4 { } export interface Schema$AdStyle { /** - * The colors which are included in the style. These are represented as six - * hexadecimal characters, similar to HTML color codes, but without the - * leading hash. + * The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. */ colors?: { background?: string; @@ -289,8 +272,7 @@ export namespace adsense_v1_4 { url?: string; }; /** - * The style of the corners in the ad (deprecated: never populated, - * ignored). + * The style of the corners in the ad (deprecated: never populated, ignored). */ corners?: string; /** @@ -308,8 +290,7 @@ export namespace adsense_v1_4 { */ code?: string; /** - * Settings specific to content ads (AFC) and highend mobile content ads - * (AFMC - deprecated). + * Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). */ contentAdsSettings?: { backupOption?: {color?: string; type?: string; url?: string}; @@ -330,8 +311,7 @@ export namespace adsense_v1_4 { type?: string; }; /** - * Unique identifier of this ad unit. This should be considered an opaque - * identifier; it is not safe to rely on it being in any particular format. + * Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -352,16 +332,11 @@ export namespace adsense_v1_4 { */ name?: string; /** - * ID of the saved ad style which holds this ad unit's style - * information. + * ID of the saved ad style which holds this ad unit's style information. */ savedStyleId?: string; /** - * Status of this ad unit. Possible values are: NEW: Indicates that the ad - * unit was created within the last seven days and does not yet have any - * activity associated with it. ACTIVE: Indicates that there has been - * activity on this ad unit in the last seven days. INACTIVE: Indicates - * that there has been no activity on this ad unit in the last seven days. + * Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days. */ status?: string; } @@ -379,16 +354,13 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * Continuation token used to page through ad units. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } export interface Schema$Alert { /** - * Unique identifier of this alert. This should be considered an opaque - * identifier; it is not safe to rely on it being in any particular format. + * Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -408,9 +380,7 @@ export namespace adsense_v1_4 { */ severity?: string; /** - * Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, - * ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, - * GRAYLISTED_PUBLISHER, API_HOLD. + * Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD. */ type?: string; } @@ -430,9 +400,7 @@ export namespace adsense_v1_4 { */ code?: string; /** - * Unique identifier of this custom channel. This should be considered an - * opaque identifier; it is not safe to rely on it being in any particular - * format. + * Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -467,9 +435,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * Continuation token used to page through custom channels. To retrieve the - * next page of results, set the next request's "pageToken" - * value to this. + * Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -498,15 +464,13 @@ export namespace adsense_v1_4 { */ paymentAmountCurrencyCode?: string; /** - * The date this payment was/will be credited to the user, or none if the - * payment threshold has not been met. + * The date this payment was/will be credited to the user, or none if the payment threshold has not been met. */ paymentDate?: string; } export interface Schema$Payments { /** - * The list of Payments for the account. One or both of a) the account's - * most recent payment; and b) the account's upcoming payment. + * The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment. */ items?: Schema$Payment[]; /** @@ -516,19 +480,15 @@ export namespace adsense_v1_4 { } export interface Schema$ReportingMetadataEntry { /** - * For metrics this is a list of dimension IDs which the metric is - * compatible with, for dimensions it is a list of compatibility groups the - * dimension belongs to. + * For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to. */ compatibleDimensions?: string[]; /** - * The names of the metrics the dimension or metric this reporting metadata - * entry describes is compatible with. + * The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with. */ compatibleMetrics?: string[]; /** - * Unique identifier of this reporting metadata entry, corresponding to the - * name of the appropriate dimension or metric. + * Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric. */ id?: string; /** @@ -536,22 +496,15 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * The names of the dimensions which the dimension or metric this reporting - * metadata entry describes requires to also be present in order for the - * report to be valid. Omitting these will not cause an error or warning, - * but may result in data which cannot be correctly interpreted. + * The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. */ requiredDimensions?: string[]; /** - * The names of the metrics which the dimension or metric this reporting - * metadata entry describes requires to also be present in order for the - * report to be valid. Omitting these will not cause an error or warning, - * but may result in data which cannot be correctly interpreted. + * The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. */ requiredMetrics?: string[]; /** - * The codes of the projects supported by the dimension or metric this - * reporting metadata entry describes. + * The codes of the projects supported by the dimension or metric this reporting metadata entry describes. */ supportedProducts?: string[]; } @@ -561,9 +514,7 @@ export namespace adsense_v1_4 { */ adStyle?: Schema$AdStyle; /** - * Unique identifier of this saved ad style. This should be considered an - * opaque identifier; it is not safe to rely on it being in any particular - * format. + * Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -589,9 +540,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * Continuation token used to page through ad units. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -623,17 +572,13 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * Continuation token used to page through saved reports. To retrieve the - * next page of results, set the next request's "pageToken" - * value to this. + * Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } export interface Schema$UrlChannel { /** - * Unique identifier of this URL channel. This should be considered an - * opaque identifier; it is not safe to rely on it being in any particular - * format. + * Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -641,8 +586,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * URL Pattern of this URL channel. Does not include "http://" or - * "https://". Example: www.example.com/home + * URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home */ urlPattern?: string; } @@ -660,9 +604,7 @@ export namespace adsense_v1_4 { */ kind?: string; /** - * Continuation token used to page through URL channels. To retrieve the - * next page of results, set the next request's "pageToken" - * value to this. + * Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -856,14 +798,11 @@ export namespace adsense_v1_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of accounts to include in the response, used for - * paging. + * The maximum number of accounts to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through accounts. To retrieve the next - * page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1051,14 +990,11 @@ export namespace adsense_v1_4 { */ accountId?: string; /** - * The maximum number of ad clients to include in the response, used for - * paging. + * The maximum number of ad clients to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad clients. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1075,8 +1011,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.adunits.get - * @desc Gets the specified ad unit in the specified ad client for the - * specified account. + * @desc Gets the specified ad unit in the specified ad client for the specified account. * @alias adsense.accounts.adunits.get * @memberOf! () * @@ -1224,8 +1159,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.adunits.list - * @desc List all ad units in the specified ad client for the specified - * account. + * @desc List all ad units in the specified ad client for the specified account. * @alias adsense.accounts.adunits.list * @memberOf! () * @@ -1360,14 +1294,11 @@ export namespace adsense_v1_4 { */ includeInactive?: boolean; /** - * The maximum number of ad units to include in the response, used for - * paging. + * The maximum number of ad units to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad units. To retrieve the next - * page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1477,14 +1408,11 @@ export namespace adsense_v1_4 { */ adUnitId?: string; /** - * The maximum number of custom channels to include in the response, used - * for paging. + * The maximum number of custom channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through custom channels. To retrieve - * the next page, set this parameter to the value of "nextPageToken" from - * the previous response. + * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1497,8 +1425,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.alerts.delete - * @desc Dismiss (delete) the specified alert from the specified publisher - * AdSense account. + * @desc Dismiss (delete) the specified alert from the specified publisher AdSense account. * @alias adsense.accounts.alerts.delete * @memberOf! () * @@ -1669,9 +1596,7 @@ export namespace adsense_v1_4 { */ accountId?: string; /** - * The locale to use for translating alert messages. The account locale will - * be used if this is not supplied. The AdSense default (English) will be - * used if the supplied locale is invalid or unsupported. + * The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. */ locale?: string; } @@ -1686,8 +1611,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.customchannels.get - * @desc Get the specified custom channel from the specified ad client for - * the specified account. + * @desc Get the specified custom channel from the specified ad client for the specified account. * @alias adsense.accounts.customchannels.get * @memberOf! () * @@ -1763,8 +1687,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.customchannels.list - * @desc List all custom channels in the specified ad client for the - * specified account. + * @desc List all custom channels in the specified ad client for the specified account. * @alias adsense.accounts.customchannels.list * @memberOf! () * @@ -1876,14 +1799,11 @@ export namespace adsense_v1_4 { */ adClientId?: string; /** - * The maximum number of custom channels to include in the response, used - * for paging. + * The maximum number of custom channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through custom channels. To retrieve - * the next page, set this parameter to the value of "nextPageToken" from - * the previous response. + * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1996,14 +1916,11 @@ export namespace adsense_v1_4 { */ includeInactive?: boolean; /** - * The maximum number of ad units to include in the response, used for - * paging. + * The maximum number of ad units to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad units. To retrieve the next - * page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -2109,9 +2026,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.reports.generate - * @desc Generate an AdSense report based on the report request sent in the - * query parameters. Returns the result as JSON; to retrieve output in CSV - * format specify "alt=csv" as a query parameter. + * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. * @alias adsense.accounts.reports.generate * @memberOf! () * @@ -2215,8 +2130,7 @@ export namespace adsense_v1_4 { */ accountId?: string; /** - * Optional currency to use when reporting on monetary metrics. Defaults to - * the account's currency if not set. + * Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. */ currency?: string; /** @@ -2232,8 +2146,7 @@ export namespace adsense_v1_4 { */ filter?: string[]; /** - * Optional locale to use for translating report output to a local language. - * Defaults to "en_US" if not specified. + * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. */ locale?: string; /** @@ -2245,9 +2158,7 @@ export namespace adsense_v1_4 { */ metric?: string[]; /** - * The name of a dimension or metric to sort the resulting report on, - * optionally prefixed with "+" to sort ascending or "-" to sort descending. - * If no prefix is specified, the column is sorted ascending. + * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. */ sort?: string[]; /** @@ -2259,8 +2170,7 @@ export namespace adsense_v1_4 { */ startIndex?: number; /** - * Whether the report should be generated in the AdSense account's local - * timezone. If false default PST/PDT timezone will be used. + * Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. */ useTimezoneReporting?: boolean; } @@ -2273,8 +2183,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.reports.saved.generate - * @desc Generate an AdSense report based on the saved report ID sent in the - * query parameters. + * @desc Generate an AdSense report based on the saved report ID sent in the query parameters. * @alias adsense.accounts.reports.saved.generate * @memberOf! () * @@ -2447,8 +2356,7 @@ export namespace adsense_v1_4 { */ accountId?: string; /** - * Optional locale to use for translating report output to a local language. - * Defaults to "en_US" if not specified. + * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. */ locale?: string; /** @@ -2476,14 +2384,11 @@ export namespace adsense_v1_4 { */ accountId?: string; /** - * The maximum number of saved reports to include in the response, used for - * paging. + * The maximum number of saved reports to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through saved reports. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -2673,14 +2578,11 @@ export namespace adsense_v1_4 { */ accountId?: string; /** - * The maximum number of saved ad styles to include in the response, used - * for paging. + * The maximum number of saved ad styles to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through saved ad styles. To retrieve - * the next page, set this parameter to the value of "nextPageToken" from - * the previous response. + * A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -2693,8 +2595,7 @@ export namespace adsense_v1_4 { /** * adsense.accounts.urlchannels.list - * @desc List all URL channels in the specified ad client for the specified - * account. + * @desc List all URL channels in the specified ad client for the specified account. * @alias adsense.accounts.urlchannels.list * @memberOf! () * @@ -2786,14 +2687,11 @@ export namespace adsense_v1_4 { */ adClientId?: string; /** - * The maximum number of URL channels to include in the response, used for - * paging. + * The maximum number of URL channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through URL channels. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -2886,14 +2784,11 @@ export namespace adsense_v1_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of ad clients to include in the response, used for - * paging. + * The maximum number of ad clients to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad clients. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -3053,8 +2948,7 @@ export namespace adsense_v1_4 { /** * adsense.adunits.list - * @desc List all ad units in the specified ad client for this AdSense - * account. + * @desc List all ad units in the specified ad client for this AdSense account. * @alias adsense.adunits.list * @memberOf! () * @@ -3172,14 +3066,11 @@ export namespace adsense_v1_4 { */ includeInactive?: boolean; /** - * The maximum number of ad units to include in the response, used for - * paging. + * The maximum number of ad units to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad units. To retrieve the next - * page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -3284,14 +3175,11 @@ export namespace adsense_v1_4 { */ adUnitId?: string; /** - * The maximum number of custom channels to include in the response, used - * for paging. + * The maximum number of custom channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through custom channels. To retrieve - * the next page, set this parameter to the value of "nextPageToken" from - * the previous response. + * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -3304,8 +3192,7 @@ export namespace adsense_v1_4 { /** * adsense.alerts.delete - * @desc Dismiss (delete) the specified alert from the publisher's AdSense - * account. + * @desc Dismiss (delete) the specified alert from the publisher's AdSense account. * @alias adsense.alerts.delete * @memberOf! () * @@ -3464,9 +3351,7 @@ export namespace adsense_v1_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The locale to use for translating alert messages. The account locale will - * be used if this is not supplied. The AdSense default (English) will be - * used if the supplied locale is invalid or unsupported. + * The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. */ locale?: string; } @@ -3556,8 +3441,7 @@ export namespace adsense_v1_4 { /** * adsense.customchannels.list - * @desc List all custom channels in the specified ad client for this - * AdSense account. + * @desc List all custom channels in the specified ad client for this AdSense account. * @alias adsense.customchannels.list * @memberOf! () * @@ -3659,14 +3543,11 @@ export namespace adsense_v1_4 { */ adClientId?: string; /** - * The maximum number of custom channels to include in the response, used - * for paging. + * The maximum number of custom channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through custom channels. To retrieve - * the next page, set this parameter to the value of "nextPageToken" from - * the previous response. + * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -3774,14 +3655,11 @@ export namespace adsense_v1_4 { */ includeInactive?: boolean; /** - * The maximum number of ad units to include in the response, used for - * paging. + * The maximum number of ad units to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad units. To retrieve the next - * page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -3805,8 +3683,7 @@ export namespace adsense_v1_4 { /** * adsense.metadata.dimensions.list - * @desc List the metadata for the dimensions available to this AdSense - * account. + * @desc List the metadata for the dimensions available to this AdSense account. * @alias adsense.metadata.dimensions.list * @memberOf! () * @@ -3892,8 +3769,7 @@ export namespace adsense_v1_4 { /** * adsense.metadata.metrics.list - * @desc List the metadata for the metrics available to this AdSense - * account. + * @desc List the metadata for the metrics available to this AdSense account. * @alias adsense.metadata.metrics.list * @memberOf! () * @@ -4065,9 +3941,7 @@ export namespace adsense_v1_4 { /** * adsense.reports.generate - * @desc Generate an AdSense report based on the report request sent in the - * query parameters. Returns the result as JSON; to retrieve output in CSV - * format specify "alt=csv" as a query parameter. + * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. * @alias adsense.reports.generate * @memberOf! () * @@ -4170,8 +4044,7 @@ export namespace adsense_v1_4 { */ accountId?: string[]; /** - * Optional currency to use when reporting on monetary metrics. Defaults to - * the account's currency if not set. + * Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. */ currency?: string; /** @@ -4187,8 +4060,7 @@ export namespace adsense_v1_4 { */ filter?: string[]; /** - * Optional locale to use for translating report output to a local language. - * Defaults to "en_US" if not specified. + * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. */ locale?: string; /** @@ -4200,9 +4072,7 @@ export namespace adsense_v1_4 { */ metric?: string[]; /** - * The name of a dimension or metric to sort the resulting report on, - * optionally prefixed with "+" to sort ascending or "-" to sort descending. - * If no prefix is specified, the column is sorted ascending. + * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. */ sort?: string[]; /** @@ -4214,8 +4084,7 @@ export namespace adsense_v1_4 { */ startIndex?: number; /** - * Whether the report should be generated in the AdSense account's local - * timezone. If false default PST/PDT timezone will be used. + * Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. */ useTimezoneReporting?: boolean; } @@ -4228,8 +4097,7 @@ export namespace adsense_v1_4 { /** * adsense.reports.saved.generate - * @desc Generate an AdSense report based on the saved report ID sent in the - * query parameters. + * @desc Generate an AdSense report based on the saved report ID sent in the query parameters. * @alias adsense.reports.saved.generate * @memberOf! () * @@ -4397,8 +4265,7 @@ export namespace adsense_v1_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional locale to use for translating report output to a local language. - * Defaults to "en_US" if not specified. + * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. */ locale?: string; /** @@ -4422,14 +4289,11 @@ export namespace adsense_v1_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of saved reports to include in the response, used for - * paging. + * The maximum number of saved reports to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through saved reports. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -4609,14 +4473,11 @@ export namespace adsense_v1_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of saved ad styles to include in the response, used - * for paging. + * The maximum number of saved ad styles to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through saved ad styles. To retrieve - * the next page, set this parameter to the value of "nextPageToken" from - * the previous response. + * A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -4629,8 +4490,7 @@ export namespace adsense_v1_4 { /** * adsense.urlchannels.list - * @desc List all URL channels in the specified ad client for this AdSense - * account. + * @desc List all URL channels in the specified ad client for this AdSense account. * @alias adsense.urlchannels.list * @memberOf! () * @@ -4714,14 +4574,11 @@ export namespace adsense_v1_4 { */ adClientId?: string; /** - * The maximum number of URL channels to include in the response, used for - * paging. + * The maximum number of URL channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through URL channels. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } diff --git a/src/apis/adsensehost/package.json b/src/apis/adsensehost/package.json index b118c10e9f5..a827cc3eca9 100644 --- a/src/apis/adsensehost/package.json +++ b/src/apis/adsensehost/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/adsensehost/v4.1.ts b/src/apis/adsensehost/v4.1.ts index 233c22d1859..243e47ab6fa 100644 --- a/src/apis/adsensehost/v4.1.ts +++ b/src/apis/adsensehost/v4.1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace adsensehost_v4_1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace adsensehost_v4_1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace adsensehost_v4_1 { /** * AdSense Host API * - * Generates performance reports, generates ad codes, and provides publisher - * management capabilities for AdSense Hosts. + * Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts. * * @example * const {google} = require('googleapis'); @@ -101,7 +97,10 @@ export namespace adsensehost_v4_1 { urlchannels: Resource$Urlchannels; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.adclients = new Resource$Adclients(this.context); @@ -158,8 +157,7 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * This ad client's product code, which corresponds to the PRODUCT_CODE - * report dimension. + * This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. */ productCode?: string; /** @@ -181,9 +179,7 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * Continuation token used to page through ad clients. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -199,9 +195,7 @@ export namespace adsensehost_v4_1 { } export interface Schema$AdStyle { /** - * The colors included in the style. These are represented as six - * hexadecimal characters, similar to HTML color codes, but without the - * leading hash. + * The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. */ colors?: { background?: string; @@ -211,8 +205,7 @@ export namespace adsensehost_v4_1 { url?: string; }; /** - * The style of the corners in the ad (deprecated: never populated, - * ignored). + * The style of the corners in the ad (deprecated: never populated, ignored). */ corners?: string; /** @@ -230,8 +223,7 @@ export namespace adsensehost_v4_1 { */ code?: string; /** - * Settings specific to content ads (AFC) and highend mobile content ads - * (AFMC - deprecated). + * Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). */ contentAdsSettings?: { backupOption?: {color?: string; type?: string; url?: string}; @@ -243,8 +235,7 @@ export namespace adsensehost_v4_1 { */ customStyle?: Schema$AdStyle; /** - * Unique identifier of this ad unit. This should be considered an opaque - * identifier; it is not safe to rely on it being in any particular format. + * Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -265,11 +256,7 @@ export namespace adsensehost_v4_1 { */ name?: string; /** - * Status of this ad unit. Possible values are: NEW: Indicates that the ad - * unit was created within the last seven days and does not yet have any - * activity associated with it. ACTIVE: Indicates that there has been - * activity on this ad unit in the last seven days. INACTIVE: Indicates - * that there has been no activity on this ad unit in the last seven days. + * Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days. */ status?: string; } @@ -287,16 +274,13 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * Continuation token used to page through ad units. To retrieve the next - * page of results, set the next request's "pageToken" value - * to this. + * Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } export interface Schema$AssociationSession { /** - * Hosted account id of the associated publisher after association. Present - * if status is ACCEPTED. + * Hosted account id of the associated publisher after association. Present if status is ACCEPTED. */ accountId?: string; /** @@ -308,23 +292,19 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * The products to associate with the user. Options: AFC, AFG, AFV, AFS - * (deprecated), AFMC (deprecated) + * The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated) */ productCodes?: string[]; /** - * Redirect URL of this association session. Used to redirect users into the - * AdSense association flow. + * Redirect URL of this association session. Used to redirect users into the AdSense association flow. */ redirectUrl?: string; /** - * Status of the completed association, available once the association - * callback token has been verified. One of ACCEPTED, REJECTED, or ERROR. + * Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR. */ status?: string; /** - * The preferred locale of the user themselves when going through the - * AdSense association flow. + * The preferred locale of the user themselves when going through the AdSense association flow. */ userLocale?: string; /** @@ -342,9 +322,7 @@ export namespace adsensehost_v4_1 { */ code?: string; /** - * Unique identifier of this custom channel. This should be considered an - * opaque identifier; it is not safe to rely on it being in any particular - * format. + * Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -370,22 +348,17 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * Continuation token used to page through custom channels. To retrieve the - * next page of results, set the next request's "pageToken" - * value to this. + * Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } export interface Schema$Report { /** - * The averages of the report. This is the same length as any other row in - * the report; cells corresponding to dimension columns are empty. + * The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ averages?: string[]; /** - * The header information of the columns requested in the report. This is a - * list of headers; one for each dimension in the request, followed by one - * for each metric in the request. + * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. */ headers?: Array<{currency?: string; name?: string; type?: string}>; /** @@ -393,21 +366,15 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * The output rows of the report. Each row is a list of cells; one for each - * dimension in the request, followed by one for each metric in the request. - * The dimension cells contain strings, and the metric cells contain - * numbers. + * The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers. */ rows?: string[][]; /** - * The total number of rows matched by the report request. Fewer rows may be - * returned in the response due to being limited by the row count requested - * or the report row limit. + * The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit. */ totalMatchedRows?: string; /** - * The totals of the report. This is the same length as any other row in the - * report; cells corresponding to dimension columns are empty. + * The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. */ totals?: string[]; /** @@ -417,9 +384,7 @@ export namespace adsensehost_v4_1 { } export interface Schema$UrlChannel { /** - * Unique identifier of this URL channel. This should be considered an - * opaque identifier; it is not safe to rely on it being in any particular - * format. + * Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. */ id?: string; /** @@ -427,8 +392,7 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * URL Pattern of this URL channel. Does not include "http://" or - * "https://". Example: www.example.com/home + * URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home */ urlPattern?: string; } @@ -446,9 +410,7 @@ export namespace adsensehost_v4_1 { */ kind?: string; /** - * Continuation token used to page through URL channels. To retrieve the - * next page of results, set the next request's "pageToken" - * value to this. + * Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. */ nextPageToken?: string; } @@ -538,8 +500,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.list - * @desc List hosted accounts associated with this AdSense account by ad - * client id. + * @desc List hosted accounts associated with this AdSense account by ad client id. * @alias adsensehost.accounts.list * @memberOf! () * @@ -640,8 +601,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.adclients.get - * @desc Get information about one of the ad clients in the specified - * publisher's AdSense account. + * @desc Get information about one of the ad clients in the specified publisher's AdSense account. * @alias adsensehost.accounts.adclients.get * @memberOf! () * @@ -816,14 +776,11 @@ export namespace adsensehost_v4_1 { */ accountId?: string; /** - * The maximum number of ad clients to include in the response, used for - * paging. + * The maximum number of ad clients to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad clients. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -836,8 +793,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.adunits.delete - * @desc Delete the specified ad unit from the specified publisher AdSense - * account. + * @desc Delete the specified ad unit from the specified publisher AdSense account. * @alias adsensehost.accounts.adunits.delete * @memberOf! () * @@ -985,8 +941,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.adunits.getAdCode - * @desc Get ad code for the specified ad unit, attaching the specified host - * custom channels. + * @desc Get ad code for the specified ad unit, attaching the specified host custom channels. * @alias adsensehost.accounts.adunits.getAdCode * @memberOf! () * @@ -1061,8 +1016,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.adunits.insert - * @desc Insert the supplied ad unit into the specified publisher AdSense - * account. + * @desc Insert the supplied ad unit into the specified publisher AdSense account. * @alias adsensehost.accounts.adunits.insert * @memberOf! () * @@ -1212,8 +1166,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.adunits.patch - * @desc Update the supplied ad unit in the specified publisher AdSense - * account. This method supports patch semantics. + * @desc Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics. * @alias adsensehost.accounts.adunits.patch * @memberOf! () * @@ -1288,8 +1241,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.adunits.update - * @desc Update the supplied ad unit in the specified publisher AdSense - * account. + * @desc Update the supplied ad unit in the specified publisher AdSense account. * @alias adsensehost.accounts.adunits.update * @memberOf! () * @@ -1467,14 +1419,11 @@ export namespace adsensehost_v4_1 { */ includeInactive?: boolean; /** - * The maximum number of ad units to include in the response, used for - * paging. + * The maximum number of ad units to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad units. To retrieve the next - * page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1533,9 +1482,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.accounts.reports.generate - * @desc Generate an AdSense report based on the report request sent in the - * query parameters. Returns the result as JSON; to retrieve output in CSV - * format specify "alt=csv" as a query parameter. + * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. * @alias adsensehost.accounts.reports.generate * @memberOf! () * @@ -1638,8 +1585,7 @@ export namespace adsensehost_v4_1 { */ filter?: string[]; /** - * Optional locale to use for translating report output to a local language. - * Defaults to "en_US" if not specified. + * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. */ locale?: string; /** @@ -1651,9 +1597,7 @@ export namespace adsensehost_v4_1 { */ metric?: string[]; /** - * The name of a dimension or metric to sort the resulting report on, - * optionally prefixed with "+" to sort ascending or "-" to sort descending. - * If no prefix is specified, the column is sorted ascending. + * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. */ sort?: string[]; /** @@ -1674,8 +1618,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.adclients.get - * @desc Get information about one of the ad clients in the Host AdSense - * account. + * @desc Get information about one of the ad clients in the Host AdSense account. * @alias adsensehost.adclients.get * @memberOf! () * @@ -1837,14 +1780,11 @@ export namespace adsensehost_v4_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of ad clients to include in the response, used for - * paging. + * The maximum number of ad clients to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through ad clients. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1857,8 +1797,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.associationsessions.start - * @desc Create an association session for initiating an association with an - * AdSense user. + * @desc Create an association session for initiating an association with an AdSense user. * @alias adsensehost.associationsessions.start * @memberOf! () * @@ -1934,8 +1873,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.associationsessions.verify - * @desc Verify an association session after the association callback - * returns from AdSense signup. + * @desc Verify an association session after the association callback returns from AdSense signup. * @alias adsensehost.associationsessions.verify * @memberOf! () * @@ -2353,8 +2291,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.customchannels.patch - * @desc Update a custom channel in the host AdSense account. This method - * supports patch semantics. + * @desc Update a custom channel in the host AdSense account. This method supports patch semantics. * @alias adsensehost.customchannels.patch * @memberOf! () * @@ -2565,14 +2502,11 @@ export namespace adsensehost_v4_1 { */ adClientId?: string; /** - * The maximum number of custom channels to include in the response, used - * for paging. + * The maximum number of custom channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through custom channels. To retrieve - * the next page, set this parameter to the value of "nextPageToken" from - * the previous response. + * A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -2623,9 +2557,7 @@ export namespace adsensehost_v4_1 { /** * adsensehost.reports.generate - * @desc Generate an AdSense report based on the report request sent in the - * query parameters. Returns the result as JSON; to retrieve output in CSV - * format specify "alt=csv" as a query parameter. + * @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. * @alias adsensehost.reports.generate * @memberOf! () * @@ -2722,8 +2654,7 @@ export namespace adsensehost_v4_1 { */ filter?: string[]; /** - * Optional locale to use for translating report output to a local language. - * Defaults to "en_US" if not specified. + * Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. */ locale?: string; /** @@ -2735,9 +2666,7 @@ export namespace adsensehost_v4_1 { */ metric?: string[]; /** - * The name of a dimension or metric to sort the resulting report on, - * optionally prefixed with "+" to sort ascending or "-" to sort descending. - * If no prefix is specified, the column is sorted ascending. + * The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. */ sort?: string[]; /** @@ -3024,14 +2953,11 @@ export namespace adsensehost_v4_1 { */ adClientId?: string; /** - * The maximum number of URL channels to include in the response, used for - * paging. + * The maximum number of URL channels to include in the response, used for paging. */ maxResults?: number; /** - * A continuation token, used to page through URL channels. To retrieve the - * next page, set this parameter to the value of "nextPageToken" from the - * previous response. + * A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } diff --git a/src/apis/alertcenter/package.json b/src/apis/alertcenter/package.json index 9b928eff02c..244f99fb332 100644 --- a/src/apis/alertcenter/package.json +++ b/src/apis/alertcenter/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index 9968bca4941..e4f5ed1f2dd 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace alertcenter_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace alertcenter_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace alertcenter_v1beta1 { v1beta1: Resource$V1beta1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.alerts = new Resource$Alerts(this.context); this.v1beta1 = new Resource$V1beta1(this.context); @@ -129,10 +128,7 @@ export namespace alertcenter_v1beta1 { */ email?: string; /** - * Optional. Details of the login action associated with the warning event. - * This is only available for: * Suspicious login * Suspicious login (less - * secure app) * Suspicious programmatic login * User suspended (suspicious - * activity) + * Optional. Details of the login action associated with the warning event. This is only available for: * Suspicious login * Suspicious login (less secure app) * Suspicious programmatic login * User suspended (suspicious activity) */ loginDetails?: Schema$LoginDetails; } @@ -165,15 +161,11 @@ export namespace alertcenter_v1beta1 { */ query?: string; /** - * List of alert ids superseded by this alert. It is used to indicate that - * this alert is essentially extension of superseded alerts and we found the - * relationship after creating these alerts. + * List of alert ids superseded by this alert. It is used to indicate that this alert is essentially extension of superseded alerts and we found the relationship after creating these alerts. */ supersededAlerts?: string[]; /** - * Alert id superseding this alert. It is used to indicate that superseding - * alert is essentially extension of this alert and we found the - * relationship after creating both alerts. + * Alert id superseding this alert. It is used to indicate that superseding alert is essentially extension of this alert and we found the relationship after creating both alerts. */ supersedingAlert?: string; /** @@ -181,8 +173,7 @@ export namespace alertcenter_v1beta1 { */ threshold?: string; /** - * The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * - * USER_EVENTS + * The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * USER_EVENTS */ triggerSource?: string; /** @@ -211,8 +202,7 @@ export namespace alertcenter_v1beta1 { */ customerId?: string; /** - * Optional. The data associated with this alert, for example - * google.apps.alertcenter.type.DeviceCompromised. + * Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised. */ data?: {[key: string]: any}; /** @@ -220,33 +210,23 @@ export namespace alertcenter_v1beta1 { */ deleted?: boolean; /** - * Optional. The time the event that caused this alert ceased being active. - * If provided, the end time must not be earlier than the start time. If not - * provided, it indicates an ongoing alert. + * Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert. */ endTime?: string; /** - * Output only. An optional [Security Investigation - * Tool](https://support.google.com/a/answer/7575955) query for this alert. + * Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert. */ securityInvestigationToolLink?: string; /** - * Required. A unique identifier for the system that reported the alert. - * This is output only after alert is created. Supported sources are any of - * the following: * Google Operations * Mobile device management * Gmail - * phishing * Domain wide takeout * Government attack warning * Google - * identity + * Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * Government attack warning * Google identity */ source?: string; /** - * Required. The time the event that caused this alert was started or - * detected. + * Required. The time the event that caused this alert was started or detected. */ startTime?: string; /** - * Required. The type of the alert. This is output only after alert is - * created. For a list of available alert types see [G Suite Alert - * types](/admin-sdk/alertcenter/reference/alert-types). + * Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). */ type?: string; /** @@ -293,8 +273,7 @@ export namespace alertcenter_v1beta1 { csv?: Schema$Csv; } /** - * Alert for setting the domain or IP that malicious email comes from as - * whitelisted domain or IP in Gmail advanced settings. + * Alert for setting the domain or IP that malicious email comes from as whitelisted domain or IP in Gmail advanced settings. */ export interface Schema$BadWhitelist { /** @@ -315,31 +294,24 @@ export namespace alertcenter_v1beta1 { sourceIp?: string; } /** - * A reference to a Cloud Pubsub topic. To register for notifications, the - * owner of the topic must grant - * `alerts-api-push-notifications@system.gserviceaccount.com` the - * `projects.topics.publish` permission. + * A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. */ export interface Schema$CloudPubsubTopic { /** - * Optional. The format of the payload that would be sent. If not specified - * the format will be JSON. + * Optional. The format of the payload that would be sent. If not specified the format will be JSON. */ payloadFormat?: string; /** - * The `name` field of a Cloud Pubsub [Topic] - * (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). + * The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). */ topicName?: string; } /** - * A representation of a CSV file attachment, as a list of column headers and - * a list of data rows. + * A representation of a CSV file attachment, as a list of column headers and a list of data rows. */ export interface Schema$Csv { /** - * The list of data rows in a CSV file, as string arrays rather than as a - * single comma-separated string. + * The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string. */ dataRows?: Schema$CsvRow[]; /** @@ -352,8 +324,7 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$CsvRow { /** - * The data entries in a CSV file row, as a string array rather than a - * single comma-separated string. + * The data entries in a CSV file row, as a string array rather than a single comma-separated string. */ entries?: string[]; } @@ -375,8 +346,7 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$DeviceCompromisedSecurityDetail { /** - * The device compromised state. Possible values are - * "`Compromised`" or "`Not Compromised`". + * The device compromised state. Possible values are "`Compromised`" or "`Not Compromised`". */ deviceCompromisedState?: string; /** @@ -414,8 +384,7 @@ export namespace alertcenter_v1beta1 { customerPrimaryDomain?: string; } /** - * A takeout operation for the entire domain was initiated by an admin. - * Derived from audit logs. + * A takeout operation for the entire domain was initiated by an admin. Derived from audit logs. */ export interface Schema$DomainWideTakeoutInitiated { /** @@ -428,11 +397,7 @@ export namespace alertcenter_v1beta1 { takeoutRequestId?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -456,8 +421,7 @@ export namespace alertcenter_v1beta1 { */ md5HashSubject?: string; /** - * The snippet of the message body text (only available for reported - * emails). + * The snippet of the message body text (only available for reported emails). */ messageBodySnippet?: string; /** @@ -478,14 +442,11 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$GoogleOperations { /** - * The list of emails which correspond to the users directly affected by the - * incident. + * The list of emails which correspond to the users directly affected by the incident. */ affectedUserEmails?: string[]; /** - * Optional. Application-specific data for an incident, provided when the G - * Suite application which reported the incident cannot be completely - * restored to a valid state. + * Optional. Application-specific data for an incident, provided when the G Suite application which reported the incident cannot be completely restored to a valid state. */ attachmentData?: Schema$Attachment; /** @@ -502,8 +463,7 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$ListAlertFeedbackResponse { /** - * The list of alert feedback. Feedback entries for each alert are ordered - * by creation time descending. + * The list of alert feedback. Feedback entries for each alert are ordered by creation time descending. */ feedback?: Schema$AlertFeedback[]; } @@ -516,10 +476,7 @@ export namespace alertcenter_v1beta1 { */ alerts?: Schema$Alert[]; /** - * The token for the next page. If not empty, indicates that there may be - * more alerts that match the listing request; this value can be used in a - * subsequent ListAlertsRequest to get alerts continuing from last result of - * the current list call. + * The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call. */ nextPageToken?: string; } @@ -528,21 +485,16 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$LoginDetails { /** - * Optional. The human-readable IP address (for example, `11.22.33.44`) that - * is associated with the warning event. + * Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event. */ ipAddress?: string; /** - * Optional. The successful login time that is associated with the warning - * event. This will not be present for blocked login attempts. + * Optional. The successful login time that is associated with the warning event. This will not be present for blocked login attempts. */ loginTime?: string; } /** - * Proto for all phishing alerts with common payload. Supported types are any - * of the following: * User reported phishing * User reported spam spike * - * Suspicious message reported * Phishing reclassification * Malware - * reclassification + * Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification */ export interface Schema$MailPhishing { /** @@ -572,8 +524,7 @@ export namespace alertcenter_v1beta1 { fromHeader?: string; } /** - * Settings for callback notifications. For more details see [G Suite Alert - * Notification](/admin-sdk/alertcenter/guides/notifications). + * Settings for callback notifications. For more details see [G Suite Alert Notification](/admin-sdk/alertcenter/guides/notifications). */ export interface Schema$Notification { /** @@ -582,11 +533,7 @@ export namespace alertcenter_v1beta1 { cloudPubsubTopic?: Schema$CloudPubsubTopic; } /** - * Alert for a spike in user reported phishing. <aside - * class="warning"><b>Warning</b>: This type has been - * deprecated. Use - * [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) - * instead.</aside> + * Alert for a spike in user reported phishing. <aside class="warning"><b>Warning</b>: This type has been deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead.</aside> */ export interface Schema$PhishingSpike { /** @@ -683,9 +630,7 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$UndeleteAlertRequest { /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alert is associated with. Inferred from the caller - * identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. */ customerId?: string; } @@ -700,11 +645,7 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.delete - * @desc Marks the specified alert for deletion. An alert that has been - * marked for deletion is removed from Alert Center after 30 days. Marking - * an alert for deletion has no effect on an alert which has already been - * marked for deletion. Attempting to mark a nonexistent alert for deletion - * results in a `NOT_FOUND` error. + * @desc Marks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion has no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` error. * @alias alertcenter.alerts.delete * @memberOf! () * @@ -776,8 +717,7 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.get - * @desc Gets the specified alert. Attempting to get a nonexistent alert - * returns `NOT_FOUND` error. + * @desc Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error. * @alias alertcenter.alerts.get * @memberOf! () * @@ -923,12 +863,7 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.undelete - * @desc Restores, or "undeletes", an alert that was marked for deletion - * within the past 30 days. Attempting to undelete an alert which was marked - * for deletion over 30 days ago (which has been removed from the Alert - * Center database) or a nonexistent alert returns a `NOT_FOUND` error. - * Attempting to undelete an alert which has not been marked for deletion - * has no effect. + * @desc Restores, or "undeletes", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert which has not been marked for deletion has no effect. * @alias alertcenter.alerts.undelete * @memberOf! () * @@ -1010,9 +945,7 @@ export namespace alertcenter_v1beta1 { */ alertId?: string; /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alert is associated with. Inferred from the caller - * identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. */ customerId?: string; } @@ -1027,9 +960,7 @@ export namespace alertcenter_v1beta1 { */ alertId?: string; /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alert is associated with. Inferred from the caller - * identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. */ customerId?: string; } @@ -1040,35 +971,23 @@ export namespace alertcenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alerts are associated with. Inferred from the caller - * identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided. */ customerId?: string; /** - * Optional. A query string for filtering alert results. For more details, - * see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and - * [Supported query filter - * fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list). + * Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list). */ filter?: string; /** - * Optional. The sort order of the list results. If not specified results - * may be returned in arbitrary order. You can sort the results in - * descending order based on the creation timestamp using - * `order_by="create_time desc"`. Currently, supported sorting are - * `create_time asc`, `create_time desc`, `update_time desc` + * Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc` */ orderBy?: string; /** - * Optional. The requested page size. Server may return fewer items than - * requested. If unspecified, server picks an appropriate default. + * Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. - * If empty, a new iteration is started. To continue an iteration, pass in - * the value from the previous ListAlertsResponse's next_page_token field. + * Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field. */ pageToken?: string; } @@ -1097,8 +1016,7 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.feedback.create - * @desc Creates new feedback for an alert. Attempting to create a feedback - * for a non-existent alert returns `NOT_FOUND` error. + * @desc Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns `NOT_FOUND` error. * @alias alertcenter.alerts.feedback.create * @memberOf! () * @@ -1174,8 +1092,7 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.feedback.list - * @desc Lists all the feedback for an alert. Attempting to list feedbacks - * for a non-existent alert returns `NOT_FOUND` error. + * @desc Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND` error. * @alias alertcenter.alerts.feedback.list * @memberOf! () * @@ -1269,9 +1186,7 @@ export namespace alertcenter_v1beta1 { */ alertId?: string; /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alert is associated with. Inferred from the caller - * identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. */ customerId?: string; @@ -1288,21 +1203,15 @@ export namespace alertcenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The alert identifier. The "-" wildcard could be used to - * represent all alerts. + * Required. The alert identifier. The "-" wildcard could be used to represent all alerts. */ alertId?: string; /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alert feedback are associated with. Inferred from the - * caller identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided. */ customerId?: string; /** - * Optional. A query string for filtering alert feedback results. For more - * details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) - * and [Supported query filter - * fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list). + * Optional. A query string for filtering alert feedback results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list). */ filter?: string; } @@ -1461,9 +1370,7 @@ export namespace alertcenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alert settings are associated with. Inferred from the - * caller identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided. */ customerId?: string; } @@ -1475,9 +1382,7 @@ export namespace alertcenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The unique identifier of the G Suite organization account of - * the customer the alert settings are associated with. Inferred from the - * caller identity if not provided. + * Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided. */ customerId?: string; diff --git a/src/apis/analytics/package.json b/src/apis/analytics/package.json index 4cabad8fd85..5099fb2b12f 100644 --- a/src/apis/analytics/package.json +++ b/src/apis/analytics/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/analytics/v2.4.ts b/src/apis/analytics/v2.4.ts index e3b9851f997..6429b039dcb 100644 --- a/src/apis/analytics/v2.4.ts +++ b/src/apis/analytics/v2.4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace analytics_v2_4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace analytics_v2_4 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -96,7 +93,10 @@ export namespace analytics_v2_4 { management: Resource$Management; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.data = new Resource$Data(this.context); this.management = new Resource$Management(this.context); @@ -195,23 +195,19 @@ export namespace analytics_v2_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A comma-separated list of Analytics dimensions. E.g., - * 'ga:browser,ga:city'. + * A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. */ dimensions?: string; /** - * End date for fetching report data. All requests should specify an end - * date formatted as YYYY-MM-DD. + * End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD. */ 'end-date'?: string; /** - * A comma-separated list of dimension or metric filters to be applied to - * the report data. + * A comma-separated list of dimension or metric filters to be applied to the report data. */ filters?: string; /** - * Unique table ID for retrieving report data. Table ID is of the form - * ga:XXXX, where XXXX is the Analytics view (profile) ID. + * Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. */ ids?: string; /** @@ -219,9 +215,7 @@ export namespace analytics_v2_4 { */ 'max-results'?: number; /** - * A comma-separated list of Analytics metrics. E.g., - * 'ga:sessions,ga:pageviews'. At least one metric must be specified to - * retrieve a valid Analytics report. + * A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report. */ metrics?: string; /** @@ -229,18 +223,15 @@ export namespace analytics_v2_4 { */ segment?: string; /** - * A comma-separated list of dimensions or metrics that determine the sort - * order for the report data. + * A comma-separated list of dimensions or metrics that determine the sort order for the report data. */ sort?: string; /** - * Start date for fetching report data. All requests should specify a start - * date formatted as YYYY-MM-DD. + * Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD. */ 'start-date'?: string; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -354,8 +345,7 @@ export namespace analytics_v2_4 { */ 'max-results'?: number; /** - * An index of the first account to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -451,8 +441,7 @@ export namespace analytics_v2_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Account ID to retrieve goals for. Can either be a specific account ID or - * '~all', which refers to all the accounts that user has access to. + * Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. */ accountId?: string; /** @@ -460,20 +449,15 @@ export namespace analytics_v2_4 { */ 'max-results'?: number; /** - * View (Profile) ID to retrieve goals for. Can either be a specific view - * (profile) ID or '~all', which refers to all the views (profiles) that - * user has access to. + * View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. */ profileId?: string; /** - * An index of the first goal to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web property ID to retrieve goals for. Can either be a specific web - * property ID or '~all', which refers to all the web properties that user - * has access to. + * Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. */ webPropertyId?: string; } @@ -568,9 +552,7 @@ export namespace analytics_v2_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Account ID for the views (profiles) to retrieve. Can either be a specific - * account ID or '~all', which refers to all the accounts to which the user - * has access. + * Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. */ accountId?: string; /** @@ -578,14 +560,11 @@ export namespace analytics_v2_4 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web property ID for the views (profiles) to retrieve. Can either be a - * specific web property ID or '~all', which refers to all the web - * properties to which the user has access. + * Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. */ webPropertyId?: string; } @@ -682,8 +661,7 @@ export namespace analytics_v2_4 { */ 'max-results'?: number; /** - * An index of the first advanced segment to retrieve. Use this parameter as - * a pagination mechanism along with the max-results parameter. + * An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -777,9 +755,7 @@ export namespace analytics_v2_4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Account ID to retrieve web properties for. Can either be a specific - * account ID or '~all', which refers to all the accounts that user has - * access to. + * Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. */ accountId?: string; /** @@ -787,8 +763,7 @@ export namespace analytics_v2_4 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index f491e1f95cd..b75c109875d 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace analytics_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace analytics_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -99,7 +96,10 @@ export namespace analytics_v3 { userDeletion: Resource$Userdeletion; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.data = new Resource$Data(this.context); this.management = new Resource$Management(this.context); @@ -114,8 +114,7 @@ export namespace analytics_v3 { */ export interface Schema$Account { /** - * Child link for an account entry. Points to the list of web properties for - * this account. + * Child link for an account entry. Points to the list of web properties for this account. */ childLink?: {href?: string; type?: string}; /** @@ -173,10 +172,7 @@ export namespace analytics_v3 { name?: string; } /** - * An account collection provides a list of Analytics accounts to which a user - * has access. The account collection is the entry point to all management - * information. Each resource in the collection corresponds to a single - * Analytics account. + * An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account. */ export interface Schema$Accounts { /** @@ -184,10 +180,7 @@ export namespace analytics_v3 { */ items?: Schema$Account[]; /** - * The maximum number of entries the response can contain, regardless of the - * actual number of entries returned. Its value ranges from 1 to 1000 with a - * value of 1000 by default, or otherwise specified by the max-results query - * parameter. + * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -203,13 +196,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the entries, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -218,9 +209,7 @@ export namespace analytics_v3 { username?: string; } /** - * An AccountSummary collection lists a summary of accounts, properties and - * views (profiles) to which the user has access. Each resource in the - * collection corresponds to a single AccountSummary. + * An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary. */ export interface Schema$AccountSummaries { /** @@ -228,10 +217,7 @@ export namespace analytics_v3 { */ items?: Schema$AccountSummary[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -247,13 +233,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -262,8 +246,7 @@ export namespace analytics_v3 { username?: string; } /** - * JSON template for an Analytics AccountSummary. An AccountSummary is a - * lightweight tree comprised of properties/profiles. + * JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles. */ export interface Schema$AccountSummary { /** @@ -288,9 +271,7 @@ export namespace analytics_v3 { webProperties?: Schema$WebPropertySummary[]; } /** - * JSON template for an Analytics account ticket. The account ticket consists - * of the ticket ID and the basic information for the account, property and - * profile. + * JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile. */ export interface Schema$AccountTicket { /** @@ -310,8 +291,7 @@ export namespace analytics_v3 { */ profile?: Schema$Profile; /** - * Redirect URI where the user will be sent after accepting Terms of - * Service. Must be configured in APIs console as a callback URL. + * Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL. */ redirectUri?: string; /** @@ -320,10 +300,7 @@ export namespace analytics_v3 { webproperty?: Schema$Webproperty; } /** - * JSON template for an Analytics account tree requests. The account tree - * request is used in the provisioning api to create an account, property, and - * view (profile). It contains the basic information required to make these - * fields. + * JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields. */ export interface Schema$AccountTreeRequest { accountName?: string; @@ -337,9 +314,7 @@ export namespace analytics_v3 { websiteUrl?: string; } /** - * JSON template for an Analytics account tree response. The account tree - * response is used in the provisioning api to return the result of creating - * an account, property, and view (profile). + * JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile). */ export interface Schema$AccountTreeResponse { /** @@ -364,8 +339,7 @@ export namespace analytics_v3 { */ export interface Schema$AdWordsAccount { /** - * True if auto-tagging is enabled on the Google Ads account. Read-only - * after the insert operation. + * True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. */ autoTaggingEnabled?: boolean; /** @@ -412,8 +386,7 @@ export namespace analytics_v3 { */ attributeNames?: string[]; /** - * Etag of collection. This etag can be compared with the last response etag - * to check if response has changed. + * Etag of collection. This etag can be compared with the last response etag to check if response has changed. */ etag?: string; /** @@ -460,8 +433,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Parent link for this custom data source. Points to the web property to - * which this custom data source belongs. + * Parent link for this custom data source. Points to the web property to which this custom data source belongs. */ parentLink?: {href?: string; type?: string}; /** @@ -489,15 +461,12 @@ export namespace analytics_v3 { */ uploadType?: string; /** - * Web property ID of the form UA-XXXXX-YY to which this custom data source - * belongs. + * Web property ID of the form UA-XXXXX-YY to which this custom data source belongs. */ webPropertyId?: string; } /** - * Lists Analytics custom data sources to which the user has access. Each - * resource in the collection corresponds to a single Analytics custom data - * source. + * Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source. */ export interface Schema$CustomDataSources { /** @@ -505,10 +474,7 @@ export namespace analytics_v3 { */ items?: Schema$CustomDataSource[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -524,13 +490,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -563,8 +527,7 @@ export namespace analytics_v3 { */ index?: number; /** - * Kind value for a custom dimension. Set to - * "analytics#customDimension". It is a read-only field. + * Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. */ kind?: string; /** @@ -572,8 +535,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Parent link for the custom dimension. Points to the property to which the - * custom dimension belongs. + * Parent link for the custom dimension. Points to the property to which the custom dimension belongs. */ parentLink?: {href?: string; type?: string}; /** @@ -594,9 +556,7 @@ export namespace analytics_v3 { webPropertyId?: string; } /** - * A custom dimension collection lists Analytics custom dimensions to which - * the user has access. Each resource in the collection corresponds to a - * single Analytics custom dimension. + * A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension. */ export interface Schema$CustomDimensions { /** @@ -604,10 +564,7 @@ export namespace analytics_v3 { */ items?: Schema$CustomDimension[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -623,13 +580,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -662,8 +617,7 @@ export namespace analytics_v3 { */ index?: number; /** - * Kind value for a custom metric. Set to - * "analytics#customMetric". It is a read-only field. + * Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. */ kind?: string; /** @@ -679,8 +633,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Parent link for the custom metric. Points to the property to which the - * custom metric belongs. + * Parent link for the custom metric. Points to the property to which the custom metric belongs. */ parentLink?: {href?: string; type?: string}; /** @@ -705,9 +658,7 @@ export namespace analytics_v3 { webPropertyId?: string; } /** - * A custom metric collection lists Analytics custom metrics to which the user - * has access. Each resource in the collection corresponds to a single - * Analytics custom metric. + * A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric. */ export interface Schema$CustomMetrics { /** @@ -715,10 +666,7 @@ export namespace analytics_v3 { */ items?: Schema$CustomMetric[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -734,13 +682,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -753,8 +699,7 @@ export namespace analytics_v3 { */ export interface Schema$EntityAdWordsLink { /** - * A list of Google Ads client accounts. These cannot be MCC accounts. This - * field is required when creating a Google Ads link. It cannot be empty. + * A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. */ adWordsAccounts?: Schema$AdWordsAccount[]; /** @@ -783,8 +728,7 @@ export namespace analytics_v3 { selfLink?: string; } /** - * An entity Google Ads link collection provides a list of GA-Google Ads links - * Each resource in this collection corresponds to a single link. + * An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link. */ export interface Schema$EntityAdWordsLinks { /** @@ -792,10 +736,7 @@ export namespace analytics_v3 { */ items?: Schema$EntityAdWordsLink[]; /** - * The maximum number of entries the response can contain, regardless of the - * actual number of entries returned. Its value ranges from 1 to 1000 with a - * value of 1000 by default, or otherwise specified by the max-results query - * parameter. + * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -811,24 +752,20 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the entries, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; } /** - * JSON template for an Analytics Entity-User Link. Returns permissions that a - * user has for an entity. + * JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. */ export interface Schema$EntityUserLink { /** - * Entity for this link. It can be an account, a web property, or a view - * (profile). + * Entity for this link. It can be an account, a web property, or a view (profile). */ entity?: { accountRef?: Schema$AccountRef; @@ -857,8 +794,7 @@ export namespace analytics_v3 { userRef?: Schema$UserRef; } /** - * An entity user link collection provides a list of Analytics ACL links Each - * resource in this collection corresponds to a single link. + * An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link. */ export interface Schema$EntityUserLinks { /** @@ -866,10 +802,7 @@ export namespace analytics_v3 { */ items?: Schema$EntityUserLink[]; /** - * The maximum number of entries the response can contain, regardless of the - * actual number of entries returned. Its value ranges from 1 to 1000 with a - * value of 1000 by default, or otherwise specified by the max-results query - * parameter. + * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -885,13 +818,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the entries, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; } @@ -912,22 +843,15 @@ export namespace analytics_v3 { */ description?: string; /** - * If true, the end user will be able to edit the experiment via the Google - * Analytics user interface. + * If true, the end user will be able to edit the experiment via the Google Analytics user interface. */ editableInGaUi?: boolean; /** - * The ending time of the experiment (the time the status changed from - * RUNNING to ENDED). This field is present only if the experiment has - * ended. This field is read-only. + * The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only. */ endTime?: string; /** - * Boolean specifying whether to distribute traffic evenly across all - * variations. If the value is False, content experiments follows the - * default behavior of adjusting traffic dynamically based on variation - * performance. Optional -- defaults to False. This field may not be changed - * for an experiment whose status is ENDED. + * Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED. */ equalWeighting?: boolean; /** @@ -935,8 +859,7 @@ export namespace analytics_v3 { */ id?: string; /** - * Internal ID for the web property to which this experiment belongs. This - * field is read-only. + * Internal ID for the web property to which this experiment belongs. This field is read-only. */ internalWebPropertyId?: string; /** @@ -944,58 +867,35 @@ export namespace analytics_v3 { */ kind?: string; /** - * An integer number in [3, 90]. Specifies the minimum length of the - * experiment. Can be changed for a running experiment. This field may not - * be changed for an experiments whose status is ENDED. + * An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED. */ minimumExperimentLengthInDays?: number; /** - * Experiment name. This field may not be changed for an experiment whose - * status is ENDED. This field is required when creating an experiment. + * Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment. */ name?: string; /** - * The metric that the experiment is optimizing. Valid values: - * "ga:goal(n)Completions", "ga:adsenseAdsClicks", - * "ga:adsenseAdsViewed", "ga:adsenseRevenue", - * "ga:bounces", "ga:pageviews", - * "ga:sessionDuration", "ga:transactions", - * "ga:transactionRevenue". This field is required if status is - * "RUNNING" and servingFramework is one of "REDIRECT" - * or "API". + * The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API". */ objectiveMetric?: string; /** - * Whether the objectiveMetric should be minimized or maximized. Possible - * values: "MAXIMUM", "MINIMUM". Optional--defaults to - * "MAXIMUM". Cannot be specified without objectiveMetric. Cannot - * be modified when status is "RUNNING" or "ENDED". + * Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED". */ optimizationType?: string; /** - * Parent link for an experiment. Points to the view (profile) to which this - * experiment belongs. + * Parent link for an experiment. Points to the view (profile) to which this experiment belongs. */ parentLink?: {href?: string; type?: string}; /** - * View (Profile) ID to which this experiment belongs. This field is - * read-only. + * View (Profile) ID to which this experiment belongs. This field is read-only. */ profileId?: string; /** - * Why the experiment ended. Possible values: "STOPPED_BY_USER", - * "WINNER_FOUND", "EXPERIMENT_EXPIRED", - * "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". - * "ENDED_WITH_NO_WINNER" means that the experiment didn't - * expire but no winner was projected to be found. If the experiment status - * is changed via the API to ENDED this field is set to STOPPED_BY_USER. - * This field is read-only. + * Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only. */ reasonExperimentEnded?: string; /** - * Boolean specifying whether variations URLS are rewritten to match those - * of the original. This field may not be changed for an experiments whose - * status is ENDED. + * Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED. */ rewriteVariationUrlsAsOriginal?: boolean; /** @@ -1003,41 +903,23 @@ export namespace analytics_v3 { */ selfLink?: string; /** - * The framework used to serve the experiment variations and evaluate the - * results. One of: - REDIRECT: Google Analytics redirects traffic to - * different variation pages, reports the chosen variation and evaluates the - * results. - API: Google Analytics chooses and reports the variation to - * serve and evaluates the results; the caller is responsible for serving - * the selected variation. - EXTERNAL: The variations will be served - * externally and the chosen variation reported to Google Analytics. The - * caller is responsible for serving the selected variation and evaluating - * the results. + * The framework used to serve the experiment variations and evaluate the results. One of: - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results. */ servingFramework?: string; /** - * The snippet of code to include on the control page(s). This field is - * read-only. + * The snippet of code to include on the control page(s). This field is read-only. */ snippet?: string; /** - * The starting time of the experiment (the time the status changed from - * READY_TO_RUN to RUNNING). This field is present only if the experiment - * has started. This field is read-only. + * The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only. */ startTime?: string; /** - * Experiment status. Possible values: "DRAFT", - * "READY_TO_RUN", "RUNNING", "ENDED". - * Experiments can be created in the "DRAFT", - * "READY_TO_RUN" or "RUNNING" state. This field is - * required when creating an experiment. + * Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment. */ status?: string; /** - * A floating-point number in (0, 1]. Specifies the fraction of the traffic - * that participates in the experiment. Can be changed for a running - * experiment. This field may not be changed for an experiments whose status - * is ENDED. + * A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED. */ trafficCoverage?: number; /** @@ -1045,10 +927,7 @@ export namespace analytics_v3 { */ updated?: string; /** - * Array of variations. The first variation in the array is the original. - * The number of variations may not change once an experiment is in the - * RUNNING state. At least two variations are required before status can be - * set to RUNNING. + * Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING. */ variations?: Array<{ name?: string; @@ -1058,26 +937,20 @@ export namespace analytics_v3 { won?: boolean; }>; /** - * Web property ID to which this experiment belongs. The web property ID is - * of the form UA-XXXXX-YY. This field is read-only. + * Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only. */ webPropertyId?: string; /** - * A floating-point number in (0, 1). Specifies the necessary confidence - * level to choose a winner. This field may not be changed for an - * experiments whose status is ENDED. + * A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED. */ winnerConfidenceLevel?: number; /** - * Boolean specifying whether a winner has been found for this experiment. - * This field is read-only. + * Boolean specifying whether a winner has been found for this experiment. This field is read-only. */ winnerFound?: boolean; } /** - * An experiment collection lists Analytics experiments to which the user has - * access. Each view (profile) can have a set of experiments. Each resource in - * the Experiment collection corresponds to a single Analytics experiment. + * An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment. */ export interface Schema$Experiments { /** @@ -1085,10 +958,7 @@ export namespace analytics_v3 { */ items?: Schema$Experiment[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -1104,13 +974,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * resources in the result. + * The total number of results for the query, regardless of the number of resources in the result. */ totalResults?: number; /** @@ -1173,8 +1041,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Parent link for this filter. Points to the account to which this filter - * belongs. + * Parent link for this filter. Points to the account to which this filter belongs. */ parentLink?: {href?: string; type?: string}; /** @@ -1192,8 +1059,7 @@ export namespace analytics_v3 { */ selfLink?: string; /** - * Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, - * UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. + * Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. */ type?: string; /** @@ -1218,42 +1084,11 @@ export namespace analytics_v3 { */ expressionValue?: string; /** - * Field to filter. Possible values: - Content and Traffic - - * PAGE_REQUEST_URI, - PAGE_HOSTNAME, - PAGE_TITLE, - REFERRAL, - - * COST_DATA_URI (Campaign target URL), - HIT_TYPE, - - * INTERNAL_SEARCH_TERM, - INTERNAL_SEARCH_TYPE, - - * SOURCE_PROPERTY_TRACKING_ID, - Campaign or AdGroup - - * CAMPAIGN_SOURCE, - CAMPAIGN_MEDIUM, - CAMPAIGN_NAME, - - * CAMPAIGN_AD_GROUP, - CAMPAIGN_TERM, - CAMPAIGN_CONTENT, - - * CAMPAIGN_CODE, - CAMPAIGN_REFERRAL_PATH, - E-Commerce - - * TRANSACTION_COUNTRY, - TRANSACTION_REGION, - TRANSACTION_CITY, - - * TRANSACTION_AFFILIATION (Store or order location), - ITEM_NAME, - - * ITEM_CODE, - ITEM_VARIATION, - TRANSACTION_ID, - - * TRANSACTION_CURRENCY_CODE, - PRODUCT_ACTION_TYPE, - Audience/Users - - * BROWSER, - BROWSER_VERSION, - BROWSER_SIZE, - PLATFORM, - - * PLATFORM_VERSION, - LANGUAGE, - SCREEN_RESOLUTION, - SCREEN_COLORS, - - * JAVA_ENABLED (Boolean Field), - FLASH_VERSION, - GEO_SPEED (Connection - * speed), - VISITOR_TYPE, - GEO_ORGANIZATION (ISP organization), - - * GEO_DOMAIN, - GEO_IP_ADDRESS, - GEO_IP_VERSION, - Location - - * GEO_COUNTRY, - GEO_REGION, - GEO_CITY, - Event - EVENT_CATEGORY, - * - EVENT_ACTION, - EVENT_LABEL, - Other - CUSTOM_FIELD_1, - - * CUSTOM_FIELD_2, - USER_DEFINED_VALUE, - Application - APP_ID, - - * APP_INSTALLER_ID, - APP_NAME, - APP_VERSION, - SCREEN, - IS_APP - * (Boolean Field), - IS_FATAL_EXCEPTION (Boolean Field), - - * EXCEPTION_DESCRIPTION, - Mobile device - IS_MOBILE (Boolean Field, - * Deprecated. Use DEVICE_CATEGORY=mobile), - IS_TABLET (Boolean Field, - * Deprecated. Use DEVICE_CATEGORY=tablet), - DEVICE_CATEGORY, - - * MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - MOBILE_HAS_NFC_SUPPORT - * (Boolean Field), - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), - - * MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - MOBILE_BRAND_NAME, - - * MOBILE_MODEL_NAME, - MOBILE_MARKETING_NAME, - MOBILE_POINTING_METHOD, - * - Social - SOCIAL_NETWORK, - SOCIAL_ACTION, - SOCIAL_ACTION_TARGET, - * - Custom dimension - CUSTOM_DIMENSION (See accompanying field index), + * Field to filter. Possible values: - Content and Traffic - PAGE_REQUEST_URI, - PAGE_HOSTNAME, - PAGE_TITLE, - REFERRAL, - COST_DATA_URI (Campaign target URL), - HIT_TYPE, - INTERNAL_SEARCH_TERM, - INTERNAL_SEARCH_TYPE, - SOURCE_PROPERTY_TRACKING_ID, - Campaign or AdGroup - CAMPAIGN_SOURCE, - CAMPAIGN_MEDIUM, - CAMPAIGN_NAME, - CAMPAIGN_AD_GROUP, - CAMPAIGN_TERM, - CAMPAIGN_CONTENT, - CAMPAIGN_CODE, - CAMPAIGN_REFERRAL_PATH, - E-Commerce - TRANSACTION_COUNTRY, - TRANSACTION_REGION, - TRANSACTION_CITY, - TRANSACTION_AFFILIATION (Store or order location), - ITEM_NAME, - ITEM_CODE, - ITEM_VARIATION, - TRANSACTION_ID, - TRANSACTION_CURRENCY_CODE, - PRODUCT_ACTION_TYPE, - Audience/Users - BROWSER, - BROWSER_VERSION, - BROWSER_SIZE, - PLATFORM, - PLATFORM_VERSION, - LANGUAGE, - SCREEN_RESOLUTION, - SCREEN_COLORS, - JAVA_ENABLED (Boolean Field), - FLASH_VERSION, - GEO_SPEED (Connection speed), - VISITOR_TYPE, - GEO_ORGANIZATION (ISP organization), - GEO_DOMAIN, - GEO_IP_ADDRESS, - GEO_IP_VERSION, - Location - GEO_COUNTRY, - GEO_REGION, - GEO_CITY, - Event - EVENT_CATEGORY, - EVENT_ACTION, - EVENT_LABEL, - Other - CUSTOM_FIELD_1, - CUSTOM_FIELD_2, - USER_DEFINED_VALUE, - Application - APP_ID, - APP_INSTALLER_ID, - APP_NAME, - APP_VERSION, - SCREEN, - IS_APP (Boolean Field), - IS_FATAL_EXCEPTION (Boolean Field), - EXCEPTION_DESCRIPTION, - Mobile device - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), - DEVICE_CATEGORY, - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - MOBILE_HAS_NFC_SUPPORT (Boolean Field), - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - MOBILE_BRAND_NAME, - MOBILE_MODEL_NAME, - MOBILE_MARKETING_NAME, - MOBILE_POINTING_METHOD, - Social - SOCIAL_NETWORK, - SOCIAL_ACTION, - SOCIAL_ACTION_TARGET, - Custom dimension - CUSTOM_DIMENSION (See accompanying field index), */ field?: string; /** - * The Index of the custom dimension. Set only if the field is a is - * CUSTOM_DIMENSION. + * The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. */ fieldIndex?: number; /** @@ -1261,10 +1096,7 @@ export namespace analytics_v3 { */ kind?: string; /** - * Match type for this filter. Possible values are BEGINS_WITH, EQUAL, - * ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, - * PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all - * other filters must use MATCHES. + * Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES. */ matchType?: string; } @@ -1294,8 +1126,7 @@ export namespace analytics_v3 { name?: string; } /** - * A filter collection lists filters created by users in an Analytics account. - * Each resource in the collection corresponds to a filter. + * A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter. */ export interface Schema$Filters { /** @@ -1303,10 +1134,7 @@ export namespace analytics_v3 { */ items?: Schema$Filter[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1,000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -1322,13 +1150,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -1341,8 +1167,7 @@ export namespace analytics_v3 { */ export interface Schema$GaData { /** - * Column headers that list dimension names followed by the metric names. - * The order of dimensions and metrics is same as specified in the request. + * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. */ columnHeaders?: Array<{ columnType?: string; @@ -1366,10 +1191,7 @@ export namespace analytics_v3 { */ id?: string; /** - * The maximum number of rows the response can contain, regardless of the - * actual number of rows returned. Its value ranges from 1 to 10,000 with a - * value of 1000 by default, or otherwise specified by the max-results query - * parameter. + * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -1385,8 +1207,7 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * Information for the view (profile), for which the Analytics data was - * requested. + * Information for the view (profile), for which the Analytics data was requested. */ profileInfo?: { accountId?: string; @@ -1413,9 +1234,7 @@ export namespace analytics_v3 { 'start-index'?: number; }; /** - * Analytics data rows, where each row contains a list of dimension values - * followed by the metric values. The order of dimensions and metrics is - * same as specified in the request. + * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. */ rows?: string[][]; /** @@ -1431,14 +1250,11 @@ export namespace analytics_v3 { */ selfLink?: string; /** - * The total number of rows for the query, regardless of the number of rows - * in the response. + * The total number of rows for the query, regardless of the number of rows in the response. */ totalResults?: number; /** - * Total values for the requested metrics over all the results, not just the - * results returned in this response. The order of the metric totals is same - * as the metric order specified in the request. + * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. */ totalsForAllResults?: {[key: string]: string}; } @@ -1488,8 +1304,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Parent link for a goal. Points to the view (profile) to which this goal - * belongs. + * Parent link for a goal. Points to the view (profile) to which this goal belongs. */ parentLink?: {href?: string; type?: string}; /** @@ -1501,8 +1316,7 @@ export namespace analytics_v3 { */ selfLink?: string; /** - * Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, - * VISIT_NUM_PAGES, AND EVENT. + * Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT. */ type?: string; /** @@ -1535,15 +1349,12 @@ export namespace analytics_v3 { comparisonValue?: string; }; /** - * Web property ID to which this goal belongs. The web property ID is of the - * form UA-XXXXX-YY. + * Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY. */ webPropertyId?: string; } /** - * A goal collection lists Analytics goals to which the user has access. Each - * view (profile) can have a set of goals. Each resource in the Goal - * collection corresponds to a single Analytics goal. + * A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal. */ export interface Schema$Goals { /** @@ -1551,10 +1362,7 @@ export namespace analytics_v3 { */ items?: Schema$Goal[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -1570,13 +1378,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * resources in the result. + * The total number of results for the query, regardless of the number of resources in the result. */ totalResults?: number; /** @@ -1606,17 +1412,11 @@ export namespace analytics_v3 { */ export interface Schema$IncludeConditions { /** - * The look-back window lets you specify a time frame for evaluating the - * behavior that qualifies users for your audience. For example, if your - * filters include users from Central Asia, and Transactions Greater than 2, - * and you set the look-back window to 14 days, then any user from Central - * Asia whose cumulative transactions exceed 2 during the last 14 days is - * added to the audience. + * The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. */ daysToLookBack?: number; /** - * Boolean indicating whether this segment is a smart list. - * https://support.google.com/analytics/answer/4628577 + * Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 */ isSmartList?: boolean; /** @@ -1649,8 +1449,7 @@ export namespace analytics_v3 { */ id?: string; /** - * Internal ID for the web property to which this linked foreign account - * belongs. + * Internal ID for the web property to which this linked foreign account belongs. */ internalWebPropertyId?: string; /** @@ -1658,8 +1457,7 @@ export namespace analytics_v3 { */ kind?: string; /** - * The foreign account ID. For example the an Google Ads `linkedAccountId` - * has the following format XXX-XXX-XXXX. + * The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. */ linkedAccountId?: string; /** @@ -1671,13 +1469,11 @@ export namespace analytics_v3 { */ status?: string; /** - * The type of the foreign account. For example, `ADWORDS_LINKS`, - * `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. + * The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. */ type?: string; /** - * Web property ID of the form UA-XXXXX-YY to which this linked foreign - * account belongs. + * Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. */ webPropertyId?: string; } @@ -1686,8 +1482,7 @@ export namespace analytics_v3 { */ export interface Schema$McfData { /** - * Column headers that list dimension names followed by the metric names. - * The order of dimensions and metrics is same as specified in the request. + * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. */ columnHeaders?: Array<{ columnType?: string; @@ -1703,10 +1498,7 @@ export namespace analytics_v3 { */ id?: string; /** - * The maximum number of rows the response can contain, regardless of the - * actual number of rows returned. Its value ranges from 1 to 10,000 with a - * value of 1000 by default, or otherwise specified by the max-results query - * parameter. + * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -1722,8 +1514,7 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * Information for the view (profile), for which the Analytics data was - * requested. + * Information for the view (profile), for which the Analytics data was requested. */ profileInfo?: { accountId?: string; @@ -1750,9 +1541,7 @@ export namespace analytics_v3 { 'start-index'?: number; }; /** - * Analytics data rows, where each row contains a list of dimension values - * followed by the metric values. The order of dimensions and metrics is - * same as specified in the request. + * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. */ rows?: Array< Array<{ @@ -1776,14 +1565,11 @@ export namespace analytics_v3 { */ selfLink?: string; /** - * The total number of rows for the query, regardless of the number of rows - * in the response. + * The total number of rows for the query, regardless of the number of rows in the response. */ totalResults?: number; /** - * Total values for the requested metrics over all the results, not just the - * results returned in this response. The order of the metric totals is same - * as the metric order specified in the request. + * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. */ totalsForAllResults?: {[key: string]: string}; } @@ -1800,8 +1586,7 @@ export namespace analytics_v3 { */ botFilteringEnabled?: boolean; /** - * Child link for this view (profile). Points to the list of goals for this - * view (profile). + * Child link for this view (profile). Points to the list of goals for this view (profile). */ childLink?: {href?: string; type?: string}; /** @@ -1809,11 +1594,7 @@ export namespace analytics_v3 { */ created?: string; /** - * The currency type associated with this view (profile), defaults to USD. - * The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, - * RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, - * CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, - * HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL + * The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL */ currency?: string; /** @@ -1825,9 +1606,7 @@ export namespace analytics_v3 { */ eCommerceTracking?: boolean; /** - * Indicates whether enhanced ecommerce tracking is enabled for this view - * (profile). This property can only be enabled if ecommerce tracking is - * enabled. + * Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. */ enhancedECommerceTracking?: boolean; /** @@ -1851,8 +1630,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Parent link for this view (profile). Points to the web property to which - * this view (profile) belongs. + * Parent link for this view (profile). Points to the web property to which this view (profile) belongs. */ parentLink?: {href?: string; type?: string}; /** @@ -1876,18 +1654,15 @@ export namespace analytics_v3 { */ starred?: boolean; /** - * Whether or not Analytics will strip search category parameters from the - * URLs in your reports. + * Whether or not Analytics will strip search category parameters from the URLs in your reports. */ stripSiteSearchCategoryParameters?: boolean; /** - * Whether or not Analytics will strip search query parameters from the URLs - * in your reports. + * Whether or not Analytics will strip search query parameters from the URLs in your reports. */ stripSiteSearchQueryParameters?: boolean; /** - * Time zone for which this view (profile) has been configured. Time zones - * are identified by strings from the TZ database. + * Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. */ timezone?: string; /** @@ -1899,8 +1674,7 @@ export namespace analytics_v3 { */ updated?: string; /** - * Web property ID of the form UA-XXXXX-YY to which this view (profile) - * belongs. + * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. */ webPropertyId?: string; /** @@ -1929,17 +1703,7 @@ export namespace analytics_v3 { */ profileRef?: Schema$ProfileRef; /** - * The rank of this profile filter link relative to the other filters linked - * to the same profile. For readonly (i.e., list and get) operations, the - * rank always starts at 1. For write (i.e., create, update, or delete) - * operations, you may specify a value between 0 and 255 inclusively, [0, - * 255]. In order to insert a link at the end of the list, either don't - * specify a rank or set a rank to a number greater than the largest rank in - * the list. In order to insert a link to the beginning of the list specify - * a rank that is less than or equal to 1. The new link will move all - * existing filters with the same or lower rank down the list. After the - * link is inserted/updated/deleted all profile filter links will be - * renumbered starting at 1. + * The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1. */ rank?: number; /** @@ -1948,9 +1712,7 @@ export namespace analytics_v3 { selfLink?: string; } /** - * A profile filter link collection lists profile filter links between - * profiles and filters. Each resource in the collection corresponds to a - * profile filter link. + * A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link. */ export interface Schema$ProfileFilterLinks { /** @@ -1958,10 +1720,7 @@ export namespace analytics_v3 { */ items?: Schema$ProfileFilterLink[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1,000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -1977,13 +1736,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -2020,15 +1777,12 @@ export namespace analytics_v3 { */ name?: string; /** - * Web property ID of the form UA-XXXXX-YY to which this view (profile) - * belongs. + * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. */ webPropertyId?: string; } /** - * A view (profile) collection lists Analytics views (profiles) to which the - * user has access. Each resource in the collection corresponds to a single - * Analytics view (profile). + * A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile). */ export interface Schema$Profiles { /** @@ -2036,10 +1790,7 @@ export namespace analytics_v3 { */ items?: Schema$Profile[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -2055,13 +1806,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -2070,8 +1819,7 @@ export namespace analytics_v3 { username?: string; } /** - * JSON template for an Analytics ProfileSummary. ProfileSummary returns basic - * information (i.e., summary) for a profile. + * JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile. */ export interface Schema$ProfileSummary { /** @@ -2100,8 +1848,7 @@ export namespace analytics_v3 { */ export interface Schema$RealtimeData { /** - * Column headers that list dimension names followed by the metric names. - * The order of dimensions and metrics is same as specified in the request. + * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. */ columnHeaders?: Array<{ columnType?: string; @@ -2117,8 +1864,7 @@ export namespace analytics_v3 { */ kind?: string; /** - * Information for the view (profile), for which the real time data was - * requested. + * Information for the view (profile), for which the real time data was requested. */ profileInfo?: { accountId?: string; @@ -2140,9 +1886,7 @@ export namespace analytics_v3 { sort?: string[]; }; /** - * Real time data rows, where each row contains a list of dimension values - * followed by the metric values. The order of dimensions and metrics is - * same as specified in the request. + * Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. */ rows?: string[][]; /** @@ -2150,14 +1894,11 @@ export namespace analytics_v3 { */ selfLink?: string; /** - * The total number of rows for the query, regardless of the number of rows - * in the response. + * The total number of rows for the query, regardless of the number of rows in the response. */ totalResults?: number; /** - * Total values for the requested metrics over all the results, not just the - * results returned in this response. The order of the metric totals is same - * as the metric order specified in the request. + * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. */ totalsForAllResults?: {[key: string]: string}; } @@ -2170,8 +1911,7 @@ export namespace analytics_v3 { */ accountId?: string; /** - * The simple audience definition that will cause a user to be added to an - * audience. + * The simple audience definition that will cause a user to be added to an audience. */ audienceDefinition?: {includeConditions?: Schema$IncludeConditions}; /** @@ -2191,8 +1931,7 @@ export namespace analytics_v3 { */ id?: string; /** - * Internal ID for the web property to which this remarketing audience - * belongs. + * Internal ID for the web property to which this remarketing audience belongs. */ internalWebPropertyId?: string; /** @@ -2200,8 +1939,7 @@ export namespace analytics_v3 { */ kind?: string; /** - * The linked ad accounts associated with this remarketing audience. A - * remarketing audience can have only one linkedAdAccount currently. + * The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. */ linkedAdAccounts?: Schema$LinkedForeignAccount[]; /** @@ -2213,8 +1951,7 @@ export namespace analytics_v3 { */ name?: string; /** - * A state based audience definition that will cause a user to be added or - * removed from an audience. + * A state based audience definition that will cause a user to be added or removed from an audience. */ stateBasedAudienceDefinition?: { excludeConditions?: {exclusionDuration?: string; segment?: string}; @@ -2225,15 +1962,12 @@ export namespace analytics_v3 { */ updated?: string; /** - * Web property ID of the form UA-XXXXX-YY to which this remarketing - * audience belongs. + * Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. */ webPropertyId?: string; } /** - * A remarketing audience collection lists Analytics remarketing audiences to - * which the user has access. Each resource in the collection corresponds to a - * single Analytics remarketing audience. + * A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience. */ export interface Schema$RemarketingAudiences { /** @@ -2241,10 +1975,7 @@ export namespace analytics_v3 { */ items?: Schema$RemarketingAudience[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -2260,13 +1991,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -2299,8 +2028,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Segment ID. Can be used with the 'segment' parameter in Core - * Reporting API. + * Segment ID. Can be used with the 'segment' parameter in Core Reporting API. */ segmentId?: string; /** @@ -2308,8 +2036,7 @@ export namespace analytics_v3 { */ selfLink?: string; /** - * Type for a segment. Possible values are "BUILT_IN" or - * "CUSTOM". + * Type for a segment. Possible values are "BUILT_IN" or "CUSTOM". */ type?: string; /** @@ -2318,8 +2045,7 @@ export namespace analytics_v3 { updated?: string; } /** - * An segment collection lists Analytics segments that the user has access to. - * Each resource in the collection corresponds to a single Analytics segment. + * An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment. */ export interface Schema$Segments { /** @@ -2327,10 +2053,7 @@ export namespace analytics_v3 { */ items?: Schema$Segment[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -2346,13 +2069,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -2381,10 +2102,7 @@ export namespace analytics_v3 { */ dimensions?: string; /** - * The type of download you need to use for the report data file. Possible - * values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is - * `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is - * `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. + * The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. */ downloadType?: string; /** @@ -2428,8 +2146,7 @@ export namespace analytics_v3 { */ 'start-date'?: string; /** - * Status of this unsampled report. Possible values are PENDING, COMPLETED, - * or FAILED. + * Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. */ status?: string; /** @@ -2441,16 +2158,12 @@ export namespace analytics_v3 { */ updated?: string; /** - * Web property ID to which this unsampled report belongs. The web property - * ID is of the form UA-XXXXX-YY. + * Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. */ webPropertyId?: string; } /** - * An unsampled report collection lists Analytics unsampled reports to which - * the user has access. Each view (profile) can have a set of unsampled - * reports. Each resource in the unsampled report collection corresponds to a - * single Analytics unsampled report. + * An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report. */ export interface Schema$UnsampledReports { /** @@ -2458,10 +2171,7 @@ export namespace analytics_v3 { */ items?: Schema$UnsampledReport[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -2477,13 +2187,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * resources in the result. + * The total number of results for the query, regardless of the number of resources in the result. */ totalResults?: number; /** @@ -2516,8 +2224,7 @@ export namespace analytics_v3 { */ kind?: string; /** - * Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, - * DELETED. + * Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED. */ status?: string; /** @@ -2526,9 +2233,7 @@ export namespace analytics_v3 { uploadTime?: string; } /** - * Upload collection lists Analytics uploads to which the user has access. - * Each custom data source can have a set of uploads. Each resource in the - * upload collection corresponds to a single Analytics data upload. + * Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload. */ export interface Schema$Uploads { /** @@ -2536,10 +2241,7 @@ export namespace analytics_v3 { */ items?: Schema$Upload[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -2555,13 +2257,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * resources in the result. + * The total number of results for the query, regardless of the number of resources in the result. */ totalResults?: number; } @@ -2570,8 +2270,7 @@ export namespace analytics_v3 { */ export interface Schema$UserDeletionRequest { /** - * This marks the point in time for which all user data before should be - * deleted + * This marks the point in time for which all user data before should be deleted */ deletionRequestTime?: string; /** @@ -2606,9 +2305,7 @@ export namespace analytics_v3 { kind?: string; } /** - * A web property collection lists Analytics web properties to which the user - * has access. Each resource in the collection corresponds to a single - * Analytics web property. + * A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property. */ export interface Schema$Webproperties { /** @@ -2616,10 +2313,7 @@ export namespace analytics_v3 { */ items?: Schema$Webproperty[]; /** - * The maximum number of resources the response can contain, regardless of - * the actual number of resources returned. Its value ranges from 1 to 1000 - * with a value of 1000 by default, or otherwise specified by the - * max-results query parameter. + * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. */ itemsPerPage?: number; /** @@ -2635,13 +2329,11 @@ export namespace analytics_v3 { */ previousLink?: string; /** - * The starting index of the resources, which is 1 by default or otherwise - * specified by the start-index query parameter. + * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. */ startIndex?: number; /** - * The total number of results for the query, regardless of the number of - * results in the response. + * The total number of results for the query, regardless of the number of results in the response. */ totalResults?: number; /** @@ -2658,8 +2350,7 @@ export namespace analytics_v3 { */ accountId?: string; /** - * Child link for this web property. Points to the list of views (profiles) - * for this web property. + * Child link for this web property. Points to the list of views (profiles) for this web property. */ childLink?: {href?: string; type?: string}; /** @@ -2667,16 +2358,11 @@ export namespace analytics_v3 { */ created?: string; /** - * Set to true to reset the retention period of the user identifier with - * each new event from that user (thus setting the expiration date to - * current time plus retention period). Set to false to delete data - * associated with the user identifer automatically after the rentention - * period. This property cannot be set on insert. + * Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifer automatically after the rentention period. This property cannot be set on insert. */ dataRetentionResetOnNewActivity?: boolean; /** - * The length of time for which user and event data is retained. This - * property cannot be set on insert. + * The length of time for which user and event data is retained. This property cannot be set on insert. */ dataRetentionTtl?: string; /** @@ -2708,8 +2394,7 @@ export namespace analytics_v3 { */ name?: string; /** - * Parent link for this web property. Points to the account to which this - * web property belongs. + * Parent link for this web property. Points to the account to which this web property belongs. */ parentLink?: {href?: string; type?: string}; /** @@ -2767,8 +2452,7 @@ export namespace analytics_v3 { name?: string; } /** - * JSON template for an Analytics WebPropertySummary. WebPropertySummary - * returns basic information (i.e., summary) for a web property. + * JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property. */ export interface Schema$WebPropertySummary { /** @@ -2915,29 +2599,23 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A comma-separated list of Analytics dimensions. E.g., - * 'ga:browser,ga:city'. + * A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. */ dimensions?: string; /** - * End date for fetching Analytics data. Request can should specify an end - * date formatted as YYYY-MM-DD, or as a relative date (e.g., today, - * yesterday, or 7daysAgo). The default value is yesterday. + * End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. */ 'end-date'?: string; /** - * A comma-separated list of dimension or metric filters to be applied to - * Analytics data. + * A comma-separated list of dimension or metric filters to be applied to Analytics data. */ filters?: string; /** - * Unique table ID for retrieving Analytics data. Table ID is of the form - * ga:XXXX, where XXXX is the Analytics view (profile) ID. + * Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. */ ids?: string; /** - * The response will include empty rows if this parameter is set to true, - * the default is true + * The response will include empty rows if this parameter is set to true, the default is true */ 'include-empty-rows'?: boolean; /** @@ -2945,8 +2623,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * A comma-separated list of Analytics metrics. E.g., - * 'ga:sessions,ga:pageviews'. At least one metric must be specified. + * A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. */ metrics?: string; /** @@ -2962,19 +2639,15 @@ export namespace analytics_v3 { */ segment?: string; /** - * A comma-separated list of dimensions or metrics that determine the sort - * order for Analytics data. + * A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. */ sort?: string; /** - * Start date for fetching Analytics data. Requests can specify a start date - * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, - * or 7daysAgo). The default value is 7daysAgo. + * Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. */ 'start-date'?: string; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -3073,24 +2746,19 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A comma-separated list of Multi-Channel Funnels dimensions. E.g., - * 'mcf:source,mcf:medium'. + * A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. */ dimensions?: string; /** - * End date for fetching Analytics data. Requests can specify a start date - * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, - * or 7daysAgo). The default value is 7daysAgo. + * End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. */ 'end-date'?: string; /** - * A comma-separated list of dimension or metric filters to be applied to - * the Analytics data. + * A comma-separated list of dimension or metric filters to be applied to the Analytics data. */ filters?: string; /** - * Unique table ID for retrieving Analytics data. Table ID is of the form - * ga:XXXX, where XXXX is the Analytics view (profile) ID. + * Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. */ ids?: string; /** @@ -3098,9 +2766,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * A comma-separated list of Multi-Channel Funnels metrics. E.g., - * 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must - * be specified. + * A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. */ metrics?: string; /** @@ -3108,19 +2774,15 @@ export namespace analytics_v3 { */ samplingLevel?: string; /** - * A comma-separated list of dimensions or metrics that determine the sort - * order for the Analytics data. + * A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data. */ sort?: string; /** - * Start date for fetching Analytics data. Requests can specify a start date - * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, - * or 7daysAgo). The default value is 7daysAgo. + * Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. */ 'start-date'?: string; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -3219,18 +2881,15 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A comma-separated list of real time dimensions. E.g., - * 'rt:medium,rt:city'. + * A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. */ dimensions?: string; /** - * A comma-separated list of dimension or metric filters to be applied to - * real time data. + * A comma-separated list of dimension or metric filters to be applied to real time data. */ filters?: string; /** - * Unique table ID for retrieving real time data. Table ID is of the form - * ga:XXXX, where XXXX is the Analytics view (profile) ID. + * Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. */ ids?: string; /** @@ -3238,13 +2897,11 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At - * least one metric must be specified. + * A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified. */ metrics?: string; /** - * A comma-separated list of dimensions or metrics that determine the sort - * order for real time data. + * A comma-separated list of dimensions or metrics that determine the sort order for real time data. */ sort?: string; } @@ -3408,8 +3065,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first account to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -3422,8 +3078,7 @@ export namespace analytics_v3 { /** * analytics.management.accountSummaries.list - * @desc Lists account summaries (lightweight tree comprised of - * accounts/properties/profiles) to which the user has access. + * @desc Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access. * @alias analytics.management.accountSummaries.list * @memberOf! () * @@ -3504,13 +3159,11 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of account summaries to include in this response, - * where the largest acceptable value is 1000. + * The maximum number of account summaries to include in this response, where the largest acceptable value is 1000. */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -3871,8 +3524,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first account-user link to retrieve. Use this parameter - * as a pagination mechanism along with the max-results parameter. + * An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -4095,8 +3747,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * A 1-based index of the first custom data source to retrieve. Use this - * parameter as a pagination mechanism along with the max-results parameter. + * A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** @@ -4342,8 +3993,7 @@ export namespace analytics_v3 { /** * analytics.management.customDimensions.patch - * @desc Updates an existing custom dimension. This method supports patch - * semantics. + * @desc Updates an existing custom dimension. This method supports patch semantics. * @alias analytics.management.customDimensions.patch * @memberOf! () * @@ -4555,8 +4205,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** @@ -4580,8 +4229,7 @@ export namespace analytics_v3 { */ customDimensionId?: string; /** - * Force the update and ignore any warnings related to the custom dimension - * being linked to a custom data source / data set. + * Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** @@ -4610,8 +4258,7 @@ export namespace analytics_v3 { */ customDimensionId?: string; /** - * Force the update and ignore any warnings related to the custom dimension - * being linked to a custom data source / data set. + * Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** @@ -4862,8 +4509,7 @@ export namespace analytics_v3 { /** * analytics.management.customMetrics.patch - * @desc Updates an existing custom metric. This method supports patch - * semantics. + * @desc Updates an existing custom metric. This method supports patch semantics. * @alias analytics.management.customMetrics.patch * @memberOf! () * @@ -5075,8 +4721,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** @@ -5100,8 +4745,7 @@ export namespace analytics_v3 { */ customMetricId?: string; /** - * Force the update and ignore any warnings related to the custom metric - * being linked to a custom data source / data set. + * Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** @@ -5130,8 +4774,7 @@ export namespace analytics_v3 { */ customMetricId?: string; /** - * Force the update and ignore any warnings related to the custom metric - * being linked to a custom data source / data set. + * Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** @@ -5470,8 +5113,7 @@ export namespace analytics_v3 { /** * analytics.management.experiments.patch - * @desc Update an existing experiment. This method supports patch - * semantics. + * @desc Update an existing experiment. This method supports patch semantics. * @alias analytics.management.experiments.patch * @memberOf! () * @@ -5729,8 +5371,7 @@ export namespace analytics_v3 { */ profileId?: string; /** - * An index of the first experiment to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** @@ -6308,8 +5949,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -6798,8 +6438,7 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Account ID to retrieve goals for. Can either be a specific account ID or - * '~all', which refers to all the accounts that user has access to. + * Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. */ accountId?: string; /** @@ -6807,20 +6446,15 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * View (Profile) ID to retrieve goals for. Can either be a specific view - * (profile) ID or '~all', which refers to all the views (profiles) that - * user has access to. + * View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. */ profileId?: string; /** - * An index of the first goal to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web property ID to retrieve goals for. Can either be a specific web - * property ID or '~all', which refers to all the web properties that user - * has access to. + * Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. */ webPropertyId?: string; } @@ -7198,8 +6832,7 @@ export namespace analytics_v3 { /** * analytics.management.profileFilterLinks.patch - * @desc Update an existing profile filter link. This method supports patch - * semantics. + * @desc Update an existing profile filter link. This method supports patch semantics. * @alias analytics.management.profileFilterLinks.patch * @memberOf! () * @@ -7443,19 +7076,15 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * Profile ID to retrieve filter links for. Can either be a specific profile - * ID or '~all', which refers to all the profiles that user has access to. + * Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. */ profileId?: string; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web property Id for profile filter links for. Can either be a specific - * web property ID or '~all', which refers to all the web properties that - * user has access to. + * Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. */ webPropertyId?: string; } @@ -7823,8 +7452,7 @@ export namespace analytics_v3 { /** * analytics.management.profiles.patch - * @desc Updates an existing view (profile). This method supports patch - * semantics. + * @desc Updates an existing view (profile). This method supports patch semantics. * @alias analytics.management.profiles.patch * @memberOf! () * @@ -8042,9 +7670,7 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Account ID for the view (profiles) to retrieve. Can either be a specific - * account ID or '~all', which refers to all the accounts to which the user - * has access. + * Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. */ accountId?: string; /** @@ -8052,14 +7678,11 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web property ID for the views (profiles) to retrieve. Can either be a - * specific web property ID or '~all', which refers to all the web - * properties to which the user has access. + * Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. */ webPropertyId?: string; } @@ -8352,8 +7975,7 @@ export namespace analytics_v3 { /** * analytics.management.profileUserLinks.update - * @desc Updates permissions for an existing user on the given view - * (profile). + * @desc Updates permissions for an existing user on the given view (profile). * @alias analytics.management.profileUserLinks.update * @memberOf! () * @@ -8495,20 +8117,15 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * View (Profile) ID to retrieve the profile-user links for. Can either be a - * specific profile ID or '~all', which refers to all the profiles that user - * has access to. + * View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. */ profileId?: string; /** - * An index of the first profile-user link to retrieve. Use this parameter - * as a pagination mechanism along with the max-results parameter. + * An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web Property ID which the given view (profile) belongs to. Can either be - * a specific web property ID or '~all', which refers to all the web - * properties that user has access to. + * Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. */ webPropertyId?: string; } @@ -8856,8 +8473,7 @@ export namespace analytics_v3 { /** * analytics.management.remarketingAudience.patch - * @desc Updates an existing remarketing audience. This method supports - * patch semantics. + * @desc Updates an existing remarketing audience. This method supports patch semantics. * @alias analytics.management.remarketingAudience.patch * @memberOf! () * @@ -9087,8 +8703,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** @@ -9243,8 +8858,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first segment to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -9664,8 +9278,7 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Account ID to retrieve unsampled reports for. Must be a specific account - * ID, ~all is not supported. + * Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. */ accountId?: string; /** @@ -9673,18 +9286,15 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * View (Profile) ID to retrieve unsampled reports for. Must be a specific - * view (profile) ID, ~all is not supported. + * View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. */ profileId?: string; /** - * An index of the first unsampled report to retrieve. Use this parameter as - * a pagination mechanism along with the max-results parameter. + * An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web property ID to retrieve unsampled reports for. Must be a specific web - * property ID, ~all is not supported. + * Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. */ webPropertyId?: string; } @@ -10082,8 +9692,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * A 1-based index of the first upload to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** @@ -10210,9 +9819,7 @@ export namespace analytics_v3 { /** * analytics.management.webproperties.insert - * @desc Create a new property if the account has fewer than 20 properties. - * Web properties are visible in the Google Analytics interface only if they - * have at least one profile. + * @desc Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile. * @alias analytics.management.webproperties.insert * @memberOf! () * @@ -10363,8 +9970,7 @@ export namespace analytics_v3 { /** * analytics.management.webproperties.patch - * @desc Updates an existing web property. This method supports patch - * semantics. + * @desc Updates an existing web property. This method supports patch semantics. * @alias analytics.management.webproperties.patch * @memberOf! () * @@ -10556,9 +10162,7 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Account ID to retrieve web properties for. Can either be a specific - * account ID or '~all', which refers to all the accounts that user has - * access to. + * Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. */ accountId?: string; /** @@ -10566,8 +10170,7 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter. + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } @@ -10700,8 +10303,7 @@ export namespace analytics_v3 { /** * analytics.management.webPropertyAdWordsLinks.get - * @desc Returns a web property-Google Ads link to which the user has - * access. + * @desc Returns a web property-Google Ads link to which the user has access. * @alias analytics.management.webPropertyAdWordsLinks.get * @memberOf! () * @@ -10934,8 +10536,7 @@ export namespace analytics_v3 { /** * analytics.management.webPropertyAdWordsLinks.patch - * @desc Updates an existing webProperty-Google Ads link. This method - * supports patch semantics. + * @desc Updates an existing webProperty-Google Ads link. This method supports patch semantics. * @alias analytics.management.webPropertyAdWordsLinks.patch * @memberOf! () * @@ -11169,13 +10770,11 @@ export namespace analytics_v3 { */ accountId?: string; /** - * The maximum number of webProperty-Google Ads links to include in this - * response. + * The maximum number of webProperty-Google Ads links to include in this response. */ 'max-results'?: number; /** - * An index of the first webProperty-Google Ads link to retrieve. Use this - * parameter as a pagination mechanism along with the max-results parameter. + * An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** @@ -11602,14 +11201,11 @@ export namespace analytics_v3 { */ 'max-results'?: number; /** - * An index of the first webProperty-user link to retrieve. Use this - * parameter as a pagination mechanism along with the max-results parameter. + * An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** - * Web Property ID for the webProperty-user links to retrieve. Can either be - * a specific web property ID or '~all', which refers to all the web - * properties that user has access to. + * Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. */ webPropertyId?: string; } @@ -11734,8 +11330,7 @@ export namespace analytics_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core - * Reporting API + * Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API */ reportType?: string; } diff --git a/src/apis/analyticsreporting/package.json b/src/apis/analyticsreporting/package.json index e30ccb8cad2..8d13d19fd57 100644 --- a/src/apis/analyticsreporting/package.json +++ b/src/apis/analyticsreporting/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/analyticsreporting/v4.ts b/src/apis/analyticsreporting/v4.ts index 0f29979353c..d7e38d37e40 100644 --- a/src/apis/analyticsreporting/v4.ts +++ b/src/apis/analyticsreporting/v4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace analyticsreporting_v4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace analyticsreporting_v4 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace analyticsreporting_v4 { userActivity: Resource$Useractivity; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.reports = new Resource$Reports(this.context); this.userActivity = new Resource$Useractivity(this.context); @@ -121,14 +120,7 @@ export namespace analyticsreporting_v4 { } /** - * An Activity represents data for an activity of a user. Note that an - * Activity is different from a hit. A hit might result in multiple - * Activity's. For example, if a hit includes a transaction and a goal - * completion, there will be two Activity protos for this hit, one for - * ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct - * one Activity. In classic e-commerce, data for one transaction might be sent - * through multiple hits. These hits will be merged into one ECOMMERCE - * Activity. + * An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity. */ export interface Schema$Activity { /** @@ -144,15 +136,11 @@ export namespace analyticsreporting_v4 { */ appview?: Schema$ScreenviewData; /** - * For manual campaign tracking, it is the value of the utm_campaign - * campaign tracking parameter. For AdWords autotagging, it is the name(s) - * of the online ad campaign(s) you use for the property. If you use - * neither, its value is (not set). + * For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set). */ campaign?: string; /** - * The Channel Group associated with an end user's session for this View - * (defined by the View's Channel Groupings). + * The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings). */ channelGrouping?: string; /** @@ -164,13 +152,11 @@ export namespace analyticsreporting_v4 { */ ecommerce?: Schema$EcommerceData; /** - * This field contains all the details pertaining to an event and will be - * set if `activity_type` equals `EVENT`. + * This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`. */ event?: Schema$EventData; /** - * This field contains a list of all the goals that were reached in this - * activity when `activity_type` equals `GOAL`. + * This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`. */ goals?: Schema$GoalSetData; /** @@ -178,13 +164,7 @@ export namespace analyticsreporting_v4 { */ hostname?: string; /** - * For manual campaign tracking, it is the value of the utm_term campaign - * tracking parameter. For AdWords traffic, it contains the best matching - * targeting criteria. For the display network, where multiple targeting - * criteria could have caused the ad to show up, it returns the best - * matching targeting criteria as selected by Ads. This could be - * display_keyword, site placement, boomuserlist, user_interest, age, or - * gender. Otherwise its value is (not set). + * For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set). */ keyword?: string; /** @@ -192,68 +172,37 @@ export namespace analyticsreporting_v4 { */ landingPagePath?: string; /** - * The type of referrals. For manual campaign tracking, it is the value of - * the utm_medium campaign tracking parameter. For AdWords autotagging, it - * is cpc. If users came from a search engine detected by Google Analytics, - * it is organic. If the referrer is not a search engine, it is referral. If - * users came directly to the property and document.referrer is empty, its - * value is (none). + * The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none). */ medium?: string; /** - * This will be set if `activity_type` equals `PAGEVIEW`. This field - * contains all the details about the visitor and the page that was visited. + * This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited. */ pageview?: Schema$PageviewData; /** - * The source of referrals. For manual campaign tracking, it is the value of - * the utm_source campaign tracking parameter. For AdWords autotagging, it - * is google. If you use neither, it is the domain of the source (e.g., - * document.referrer) referring the users. It may also contain a port - * address. If users arrived without a referrer, its value is (direct). + * The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct). */ source?: string; } /** - * Defines a cohort. A cohort is a group of users who share a common - * characteristic. For example, all users with the same acquisition date - * belong to the same cohort. + * Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort. */ export interface Schema$Cohort { /** - * This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users - * whose first visit date is between start date and end date defined in the - * DateRange. The date ranges should be aligned for cohort requests. If the - * request contains `ga:cohortNthDay` it should be exactly one day long, if - * `ga:cohortNthWeek` it should be aligned to the week boundary (starting at - * Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range - * should be aligned to the month (starting at the first and ending on the - * last day of the month). For LTV requests there are no such restrictions. - * You do not need to supply a date range for the - * `reportsRequest.dateRanges` field. + * This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be aligned for cohort requests. If the request contains `ga:cohortNthDay` it should be exactly one day long, if `ga:cohortNthWeek` it should be aligned to the week boundary (starting at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV requests there are no such restrictions. You do not need to supply a date range for the `reportsRequest.dateRanges` field. */ dateRange?: Schema$DateRange; /** - * A unique name for the cohort. If not defined name will be auto-generated - * with values cohort_[1234...]. + * A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...]. */ name?: string; /** - * Type of the cohort. The only supported type as of now is - * `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as - * `FIRST_VISIT_DATE` type cohort. + * Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort. */ type?: string; } /** - * Defines a cohort group. For example: "cohortGroup": { - * "cohorts": [{ "name": "cohort 1", - * "type": "FIRST_VISIT_DATE", "dateRange": { - * "startDate": "2015-08-01", "endDate": - * "2015-08-01" } },{ "name": "cohort - * 2" "type": "FIRST_VISIT_DATE" - * "dateRange": { "startDate": "2015-07-01", - * "endDate": "2015-07-01" } }] } + * Defines a cohort group. For example: "cohortGroup": { "cohorts": [{ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" } },{ "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" } }] } */ export interface Schema$CohortGroup { /** @@ -261,26 +210,7 @@ export namespace analyticsreporting_v4 { */ cohorts?: Schema$Cohort[]; /** - * Enable Life Time Value (LTV). LTV measures lifetime value for users - * acquired through different channels. Please see: [Cohort - * Analysis](https://support.google.com/analytics/answer/6074676) and - * [Lifetime Value](https://support.google.com/analytics/answer/6182550) If - * the value of lifetimeValue is false: - The metric values are similar to - * the values in the web interface cohort report. - The cohort definition - * date ranges must be aligned to the calendar week and month. i.e. while - * requesting `ga:cohortNthWeek` the `startDate` in the cohort definition - * should be a Sunday and the `endDate` should be the following Saturday, - * and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the - * month and `endDate` should be the last day of the month. When the - * lifetimeValue is true: - The metric values will correspond to the values - * in the web interface LifeTime value report. - The Lifetime Value report - * shows you how user value (Revenue) and engagement (Appviews, Goal - * Completions, Sessions, and Session Duration) grow during the 90 days - * after a user is acquired. - The metrics are calculated as a cumulative - * average per user per the time increment. - The cohort definition date - * ranges need not be aligned to the calendar week and month boundaries. - - * The `viewId` must be an [app view - * ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) + * Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) */ lifetimeValue?: boolean; } @@ -306,15 +236,12 @@ export namespace analyticsreporting_v4 { */ index?: number; /** - * Value of the custom dimension. Default value (i.e. empty string) - * indicates clearing sesion/visitor scope custom dimension value. + * Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value. */ value?: string; } /** - * A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The - * start and end dates are specified in - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. + * A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. */ export interface Schema$DateRange { /** @@ -327,8 +254,7 @@ export namespace analyticsreporting_v4 { startDate?: string; } /** - * Used to return a list of metrics for a single DateRange / dimension - * combination + * Used to return a list of metrics for a single DateRange / dimension combination */ export interface Schema$DateRangeValues { /** @@ -341,37 +267,11 @@ export namespace analyticsreporting_v4 { values?: string[]; } /** - * [Dimensions](https://support.google.com/analytics/answer/1033861) are - * attributes of your data. For example, the dimension `ga:city` indicates the - * city, for example, "Paris" or "New York", from which a - * session originates. + * [Dimensions](https://support.google.com/analytics/answer/1033861) are attributes of your data. For example, the dimension `ga:city` indicates the city, for example, "Paris" or "New York", from which a session originates. */ export interface Schema$Dimension { /** - * If non-empty, we place dimension values into buckets after string to - * int64. Dimension values that are not the string representation of an - * integral value will be converted to zero. The bucket values have to be - * in increasing order. Each bucket is closed on the lower end, and open on - * the upper end. The "first" bucket includes all values less than - * the first boundary, the "last" bucket includes all values up to - * infinity. Dimension values that fall in a bucket get transformed to a new - * dimension value. For example, if one gives a list of "0, 1, 3, 4, - * 7", then we return the following buckets: - bucket #1: values < - * 0, dimension value "<0" - bucket #2: values in [0,1), - * dimension value "0" - bucket #3: values in [1,3), dimension - * value "1-2" - bucket #4: values in [3,4), dimension value - * "3" - bucket #5: values in [4,7), dimension value - * "4-6" - bucket #6: values >= 7, dimension value - * "7+" NOTE: If you are applying histogram mutation on any - * dimension, and using that dimension in sort, you will want to use the - * sort type `HISTOGRAM_BUCKET` for that purpose. Without that the dimension - * values will be sorted according to dictionary (lexicographic) order. For - * example the ascending dictionary order is: "<50", - * "1001+", "121-1000", "50-120" And the - * ascending `HISTOGRAM_BUCKET` order is: "<50", - * "50-120", "121-1000", "1001+" The client - * has to explicitly request `"orderType": - * "HISTOGRAM_BUCKET"` for a histogram-mutated dimension. + * If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of "0, 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0, dimension value "<0" - bucket #2: values in [0,1), dimension value "0" - bucket #3: values in [1,3), dimension value "1-2" - bucket #4: values in [3,4), dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" - bucket #6: values >= 7, dimension value "7+" NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is: "<50", "1001+", "121-1000", "50-120" And the ascending `HISTOGRAM_BUCKET` order is: "<50", "50-120", "121-1000", "1001+" The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension. */ histogramBuckets?: string[]; /** @@ -392,15 +292,11 @@ export namespace analyticsreporting_v4 { */ dimensionName?: string; /** - * Strings or regular expression to match against. Only the first value of - * the list is used for comparison unless the operator is `IN_LIST`. If - * `IN_LIST` operator, then the entire list is used to filter the dimensions - * as explained in the description of the `IN_LIST` operator. + * Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list is used to filter the dimensions as explained in the description of the `IN_LIST` operator. */ expressions?: string[]; /** - * Logical `NOT` operator. If this boolean is set to true, then the matching - * dimension values will be excluded in the report. The default is false. + * Logical `NOT` operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false. */ not?: boolean; /** @@ -409,24 +305,20 @@ export namespace analyticsreporting_v4 { operator?: string; } /** - * A group of dimension filters. Set the operator value to specify how the - * filters are logically combined. + * A group of dimension filters. Set the operator value to specify how the filters are logically combined. */ export interface Schema$DimensionFilterClause { /** - * The repeated set of filters. They are logically combined based on the - * operator specified. + * The repeated set of filters. They are logically combined based on the operator specified. */ filters?: Schema$DimensionFilter[]; /** - * The operator for combining multiple dimension filters. If unspecified, it - * is treated as an `OR`. + * The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`. */ operator?: string; } /** - * Dynamic segment definition for defining the segment within the request. A - * segment can select users, sessions or both. + * Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both. */ export interface Schema$DynamicSegment { /** @@ -493,31 +385,20 @@ export namespace analyticsreporting_v4 { */ export interface Schema$GetReportsRequest { /** - * Requests, each request will have a separate response. There can be a - * maximum of 5 requests. All requests should have the same `dateRanges`, - * `viewId`, `segments`, `samplingLevel`, and `cohortGroup`. + * Requests, each request will have a separate response. There can be a maximum of 5 requests. All requests should have the same `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`. */ reportRequests?: Schema$ReportRequest[]; /** - * Enables [resource based - * quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4), - * (defaults to `False`). If this field is set to `True` the per view - * (profile) quotas are governed by the computational cost of the request. - * Note that using cost based quotas will higher enable sampling rates. (10 - * Million for `SMALL`, 100M for `LARGE`. See the [limits and quotas - * documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) - * for details. + * Enables [resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is set to `True` the per view (profile) quotas are governed by the computational cost of the request. Note that using cost based quotas will higher enable sampling rates. (10 Million for `SMALL`, 100M for `LARGE`. See the [limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details. */ useResourceQuotas?: boolean; } /** - * The main response class which holds the reports from the Reporting API - * `batchGet` call. + * The main response class which holds the reports from the Reporting API `batchGet` call. */ export interface Schema$GetReportsResponse { /** - * The amount of resource quota tokens deducted to execute the query. - * Includes all responses. + * The amount of resource quota tokens deducted to execute the query. Includes all responses. */ queryCost?: number; /** @@ -576,33 +457,19 @@ export namespace analyticsreporting_v4 { goals?: Schema$GoalData[]; } /** - * [Metrics](https://support.google.com/analytics/answer/1033861) are the - * quantitative measurements. For example, the metric `ga:users` indicates the - * total number of users for the requested time period. + * [Metrics](https://support.google.com/analytics/answer/1033861) are the quantitative measurements. For example, the metric `ga:users` indicates the total number of users for the requested time period. */ export interface Schema$Metric { /** - * An alias for the metric expression is an alternate name for the - * expression. The alias can be used for filtering and sorting. This field - * is optional and is useful if the expression is not a single metric but a - * complex expression which cannot be used in filtering and sorting. The - * alias is also used in the response column header. + * An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header. */ alias?: string; /** - * A metric expression in the request. An expression is constructed from one - * or more metrics and numbers. Accepted operators include: Plus (+), Minus - * (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, - * Positive cardinal numbers (0-9), can include decimals and is limited to - * 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the - * metric expression is just a single metric name like `ga:users`. Adding - * mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result - * in unexpected results. + * A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results. */ expression?: string; /** - * Specifies how the metric expression should be formatted, for example - * `INTEGER`. + * Specifies how the metric expression should be formatted, for example `INTEGER`. */ formattingType?: string; } @@ -615,36 +482,28 @@ export namespace analyticsreporting_v4 { */ comparisonValue?: string; /** - * The metric that will be filtered on. A metricFilter must contain a metric - * name. A metric name can be an alias earlier defined as a metric or it can - * also be a metric expression. + * The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression. */ metricName?: string; /** - * Logical `NOT` operator. If this boolean is set to true, then the matching - * metric values will be excluded in the report. The default is false. + * Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false. */ not?: boolean; /** - * Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, - * the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the - * metric is missing and would ignore the comparisonValue. + * Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore the comparisonValue. */ operator?: string; } /** - * Represents a group of metric filters. Set the operator value to specify how - * the filters are logically combined. + * Represents a group of metric filters. Set the operator value to specify how the filters are logically combined. */ export interface Schema$MetricFilterClause { /** - * The repeated set of filters. They are logically combined based on the - * operator specified. + * The repeated set of filters. They are logically combined based on the operator specified. */ filters?: Schema$MetricFilter[]; /** - * The operator for combining multiple metric filters. If unspecified, it is - * treated as an `OR`. + * The operator for combining multiple metric filters. If unspecified, it is treated as an `OR`. */ operator?: string; } @@ -679,9 +538,7 @@ export namespace analyticsreporting_v4 { */ export interface Schema$OrderBy { /** - * The field which to sort by. The default sort order is ascending. Example: - * `ga:browser`. Note, that you can only specify one field for sort here. - * For example, `ga:browser, ga:city` is not valid. + * The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` is not valid. */ fieldName?: string; /** @@ -694,8 +551,7 @@ export namespace analyticsreporting_v4 { sortOrder?: string; } /** - * A list of segment filters in the `OR` group are combined with the logical - * OR operator. + * A list of segment filters in the `OR` group are combined with the logical OR operator. */ export interface Schema$OrFiltersForSegment { /** @@ -717,51 +573,27 @@ export namespace analyticsreporting_v4 { pageTitle?: string; } /** - * The Pivot describes the pivot section in the request. The Pivot helps - * rearrange the information in the table for certain reports by pivoting your - * data on a second dimension. + * The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension. */ export interface Schema$Pivot { /** - * DimensionFilterClauses are logically combined with an `AND` operator: - * only data that is included by all these DimensionFilterClauses - * contributes to the values in this pivot region. Dimension filters can be - * used to restrict the columns shown in the pivot region. For example if - * you have `ga:browser` as the requested dimension in the pivot region, and - * you specify key filters to restrict `ga:browser` to only "IE" - * or "Firefox", then only those two browsers would show up as - * columns. + * DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify key filters to restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers would show up as columns. */ dimensionFilterClauses?: Schema$DimensionFilterClause[]; /** - * A list of dimensions to show as pivot columns. A Pivot can have a maximum - * of 4 dimensions. Pivot dimensions are part of the restriction on the - * total number of dimensions allowed in the request. + * A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request. */ dimensions?: Schema$Dimension[]; /** - * Specifies the maximum number of groups to return. The default value is - * 10, also the maximum value is 1,000. + * Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000. */ maxGroupCount?: number; /** - * The pivot metrics. Pivot metrics are part of the restriction on total - * number of metrics allowed in the request. + * The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request. */ metrics?: Schema$Metric[]; /** - * If k metrics were requested, then the response will contain some - * data-dependent multiple of k columns in the report. E.g., if you pivoted - * on the dimension `ga:browser` then you'd get k columns for - * "Firefox", k columns for "IE", k columns for - * "Chrome", etc. The ordering of the groups of columns is - * determined by descending order of "total" for the first of the - * k values. Ties are broken by lexicographic ordering of the first pivot - * dimension, then lexicographic ordering of the second pivot dimension, and - * so on. E.g., if the totals for the first value for Firefox, IE, and - * Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, - * Firefox, IE. The following let you choose which of the groups of k - * columns are included in the response. + * If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response. */ startGroup?: number; } @@ -779,8 +611,7 @@ export namespace analyticsreporting_v4 { totalPivotGroupsCount?: number; } /** - * The headers for the each of the metric column corresponding to the metrics - * requested in the pivots section of the response. + * The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response. */ export interface Schema$PivotHeaderEntry { /** @@ -814,8 +645,7 @@ export namespace analyticsreporting_v4 { */ itemRevenue?: number; /** - * The product name, supplied by the e-commerce tracking application, for - * the purchased items. + * The product name, supplied by the e-commerce tracking application, for the purchased items. */ productName?: string; /** @@ -849,26 +679,19 @@ export namespace analyticsreporting_v4 { */ export interface Schema$ReportData { /** - * The last time the data in the report was refreshed. All the hits received - * before this timestamp are included in the calculation of the report. + * The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report. */ dataLastRefreshed?: string; /** - * Indicates if response to this request is golden or not. Data is golden - * when the exact same request will not produce any new results if asked at - * a later point in time. + * Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time. */ isDataGolden?: boolean; /** - * Minimum and maximum values seen over all matching rows. These are both - * empty when `hideValueRanges` in the request is false, or when rowCount is - * zero. + * Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero. */ maximums?: Schema$DateRangeValues[]; /** - * Minimum and maximum values seen over all matching rows. These are both - * empty when `hideValueRanges` in the request is false, or when rowCount is - * zero. + * Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero. */ minimums?: Schema$DateRangeValues[]; /** @@ -880,31 +703,15 @@ export namespace analyticsreporting_v4 { */ rows?: Schema$ReportRow[]; /** - * If the results are - * [sampled](https://support.google.com/analytics/answer/2637192), this - * returns the total number of samples read, one entry per date range. If - * the results are not sampled this field will not be defined. See - * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - * for details. + * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ samplesReadCounts?: string[]; /** - * If the results are - * [sampled](https://support.google.com/analytics/answer/2637192), this - * returns the total number of samples present, one entry per date range. If - * the results are not sampled this field will not be defined. See - * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - * for details. + * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ samplingSpaceSizes?: string[]; /** - * For each requested date range, for the set of all rows that match the - * query, every requested value format gets a total. The total for a value - * format is computed by first totaling the metrics mentioned in the value - * format and then evaluating the value format as a scalar expression. E.g., - * The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum - * of all relevant ga:sessions) + 2)`. Totals are computed before - * pagination. + * For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. Totals are computed before pagination. */ totals?: Schema$DateRangeValues[]; } @@ -913,30 +720,15 @@ export namespace analyticsreporting_v4 { */ export interface Schema$ReportRequest { /** - * Cohort group associated with this request. If there is a cohort group in - * the request the `ga:cohort` dimension must be present. Every - * [ReportRequest](#ReportRequest) within a `batchGet` method must contain - * the same `cohortGroup` definition. + * Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `cohortGroup` definition. */ cohortGroup?: Schema$CohortGroup; /** - * Date ranges in the request. The request can have a maximum of 2 date - * ranges. The response will contain a set of metric values for each - * combination of the dimensions for each date range in the request. So, if - * there are two date ranges, there will be two set of metric values, one - * for the original date range and one for the second date range. The - * `reportRequest.dateRanges` field should not be specified for cohorts or - * Lifetime value requests. If a date range is not provided, the default - * date range is (startDate: current date - 7 days, endDate: current date - - * 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method - * must contain the same `dateRanges` definition. + * Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition. */ dateRanges?: Schema$DateRange[]; /** - * The dimension filter clauses for filtering Dimension Values. They are - * logically combined with the `AND` operator. Note that filtering occurs - * before any dimensions are aggregated, so that the returned metrics - * represent the total for only the relevant dimensions. + * The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions. */ dimensionFilterClauses?: Schema$DimensionFilterClause[]; /** @@ -944,65 +736,39 @@ export namespace analyticsreporting_v4 { */ dimensions?: Schema$Dimension[]; /** - * Dimension or metric filters that restrict the data returned for your - * request. To use the `filtersExpression`, supply a dimension or metric on - * which to filter, followed by the filter expression. For example, the - * following expression selects `ga:browser` dimension which starts with - * Firefox; `ga:browser=~^Firefox`. For more information on dimensions and - * metric filters, see [Filters - * reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters). + * Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters). */ filtersExpression?: string; /** - * If set to true, hides the total of all metrics for all the matching rows, - * for every date range. The default false and will return the totals. + * If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals. */ hideTotals?: boolean; /** - * If set to true, hides the minimum and maximum across all matching rows. - * The default is false and the value ranges are returned. + * If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned. */ hideValueRanges?: boolean; /** - * If set to false, the response does not include rows if all the retrieved - * metrics are equal to zero. The default is false which will exclude these - * rows. + * If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows. */ includeEmptyRows?: boolean; /** - * The metric filter clauses. They are logically combined with the `AND` - * operator. Metric filters look at only the first date range and not the - * comparing date range. Note that filtering on metrics occurs after the - * metrics are aggregated. + * The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated. */ metricFilterClauses?: Schema$MetricFilterClause[]; /** - * The metrics requested. Requests must specify at least one metric. - * Requests can have a total of 10 metrics. + * The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics. */ metrics?: Schema$Metric[]; /** - * Sort order on output rows. To compare two rows, the elements of the - * following are applied in order until a difference is found. All date - * ranges in the output get the same row order. + * Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order. */ orderBys?: Schema$OrderBy[]; /** - * Page size is for paging and specifies the maximum number of returned - * rows. Page size should be >= 0. A query returns the default of 1,000 - * rows. The Analytics Core Reporting API returns a maximum of 100,000 rows - * per request, no matter how many you ask for. It can also return fewer - * rows than requested, if there aren't as many dimension segments as - * you expect. For instance, there are fewer than 300 possible values for - * `ga:country`, so when segmenting only by country, you can't get more - * than 300 rows, even if you set `pageSize` to a higher value. + * Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value. */ pageSize?: number; /** - * A continuation token to get the next page of the results. Adding this to - * the request will return the rows after the pageToken. The pageToken - * should be the value returned in the nextPageToken parameter in the - * response to the GetReports request. + * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request. */ pageToken?: string; /** @@ -1010,28 +776,15 @@ export namespace analyticsreporting_v4 { */ pivots?: Schema$Pivot[]; /** - * The desired report - * [sample](https://support.google.com/analytics/answer/2637192) size. If - * the the `samplingLevel` field is unspecified the `DEFAULT` sampling level - * is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method - * must contain the same `samplingLevel` definition. See [developer - * guide](/analytics/devguides/reporting/core/v4/basics#sampling) for - * details. + * The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ samplingLevel?: string; /** - * Segment the data returned for the request. A segment definition helps - * look at a subset of the segment request. A request can contain up to four - * segments. Every [ReportRequest](#ReportRequest) within a `batchGet` - * method must contain the same `segments` definition. Requests with - * segments must have the `ga:segment` dimension. + * Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension. */ segments?: Schema$Segment[]; /** - * The Analytics [view - * ID](https://support.google.com/analytics/answer/1009618) from which to - * retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` - * method must contain the same `viewId`. + * The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`. */ viewId?: string; } @@ -1049,8 +802,7 @@ export namespace analyticsreporting_v4 { metrics?: Schema$DateRangeValues[]; } /** - * The resource quota tokens remaining for the property after the request is - * completed. + * The resource quota tokens remaining for the property after the request is completed. */ export interface Schema$ResourceQuotasRemaining { /** @@ -1068,8 +820,7 @@ export namespace analyticsreporting_v4 { */ appName?: string; /** - * Mobile manufacturer or branded name. Eg: "Google", - * "Apple" etc. + * Mobile manufacturer or branded name. Eg: "Google", "Apple" etc. */ mobileDeviceBranding?: string; /** @@ -1082,49 +833,31 @@ export namespace analyticsreporting_v4 { screenName?: string; } /** - * The request to fetch User Report from Reporting API `userActivity:get` - * call. + * The request to fetch User Report from Reporting API `userActivity:get` call. */ export interface Schema$SearchUserActivityRequest { /** - * Set of all activity types being requested. Only acvities matching these - * types will be returned in the response. If empty, all activies will be - * returned. + * Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned. */ activityTypes?: string[]; /** - * Date range for which to retrieve the user activity. If a date range is - * not provided, the default date range is (startDate: current date - 7 - * days, endDate: current date - 1 day). + * Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). */ dateRange?: Schema$DateRange; /** - * Page size is for paging and specifies the maximum number of returned - * rows. Page size should be > 0. If the value is 0 or if the field - * isn't specified, the request returns the default of 1000 rows per - * page. + * Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page. */ pageSize?: number; /** - * A continuation token to get the next page of the results. Adding this to - * the request will return the rows after the pageToken. The pageToken - * should be the value returned in the nextPageToken parameter in the - * response to the [SearchUserActivityRequest](#SearchUserActivityRequest) - * request. + * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the [SearchUserActivityRequest](#SearchUserActivityRequest) request. */ pageToken?: string; /** - * Required. Unique user Id to query for. Every - * [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this - * field. + * Required. Unique user Id to query for. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this field. */ user?: Schema$User; /** - * Required. The Analytics [view - * ID](https://support.google.com/analytics/answer/1009618) from which to - * retrieve data. Every - * [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the - * `viewId`. + * Required. The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the `viewId`. */ viewId?: string; } @@ -1133,17 +866,11 @@ export namespace analyticsreporting_v4 { */ export interface Schema$SearchUserActivityResponse { /** - * This token should be passed to - * [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the - * next page. + * This token should be passed to [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the next page. */ nextPageToken?: string; /** - * This field represents the [sampling - * rate](https://support.google.com/analytics/answer/2637192) for the given - * request and is a number between 0.0 to 1.0. See [developer - * guide](/analytics/devguides/reporting/core/v4/basics#sampling) for - * details. + * This field represents the [sampling rate](https://support.google.com/analytics/answer/2637192) for the given request and is a number between 0.0 to 1.0. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ sampleRate?: number; /** @@ -1156,9 +883,7 @@ export namespace analyticsreporting_v4 { totalRows?: number; } /** - * The segment definition, if the report needs to be segmented. A Segment is a - * subset of the Analytics data. For example, of the entire set of users, one - * Segment might be users from a particular country or city. + * The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city. */ export interface Schema$Segment { /** @@ -1171,13 +896,11 @@ export namespace analyticsreporting_v4 { segmentId?: string; } /** - * SegmentDefinition defines the segment to be a set of SegmentFilters which - * are combined together with a logical `AND` operation. + * SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical `AND` operation. */ export interface Schema$SegmentDefinition { /** - * A segment is defined by a set of segment filters which are combined - * together with a logical `AND` operation. + * A segment is defined by a set of segment filters which are combined together with a logical `AND` operation. */ segmentFilters?: Schema$SegmentFilter[]; } @@ -1211,39 +934,24 @@ export namespace analyticsreporting_v4 { operator?: string; } /** - * SegmentFilter defines the segment to be either a simple or a sequence - * segment. A simple segment condition contains dimension and metric - * conditions to select the sessions or users. A sequence segment condition - * can be used to select users or sessions based on sequential conditions. + * SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions. */ export interface Schema$SegmentFilter { /** - * If true, match the complement of simple or sequence segment. For example, - * to match all visits not from "New York", we can define the - * segment as follows: "sessionSegment": { - * "segmentFilters": [{ "simpleSegment" :{ - * "orFiltersForSegment": [{ "segmentFilterClauses":[{ - * "dimensionFilter": { "dimensionName": - * "ga:city", "expressions": - * ["New York"] } }] }] - * }, "not": "True" }] }, + * If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] } }] }] }, "not": "True" }] }, */ not?: boolean; /** - * Sequence conditions consist of one or more steps, where each step is - * defined by one or more dimension/metric conditions. Multiple steps can be - * combined with special sequence operators. + * Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators. */ sequenceSegment?: Schema$SequenceSegment; /** - * A Simple segment conditions consist of one or more dimension/metric - * conditions that can be combined + * A Simple segment conditions consist of one or more dimension/metric conditions that can be combined */ simpleSegment?: Schema$SimpleSegment; } /** - * Filter Clause to be used in a segment definition, can be wither a metric or - * a dimension filter. + * Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter. */ export interface Schema$SegmentFilterClause { /** @@ -1264,8 +972,7 @@ export namespace analyticsreporting_v4 { */ export interface Schema$SegmentMetricFilter { /** - * The value to compare against. If the operator is `BETWEEN`, this value is - * treated as minimum comparison value. + * The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value. */ comparisonValue?: string; /** @@ -1273,20 +980,15 @@ export namespace analyticsreporting_v4 { */ maxComparisonValue?: string; /** - * The metric that will be filtered on. A `metricFilter` must contain a - * metric name. + * The metric that will be filtered on. A `metricFilter` must contain a metric name. */ metricName?: string; /** - * Specifies is the operation to perform to compare the metric. The default - * is `EQUAL`. + * Specifies is the operation to perform to compare the metric. The default is `EQUAL`. */ operator?: string; /** - * Scope for a metric defines the level at which that metric is defined. The - * specified metric scope must be equal to or greater than its primary scope - * as defined in the data model. The primary scope is defined by if the - * segment is selecting users or sessions. + * Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions. */ scope?: string; } @@ -1295,25 +997,20 @@ export namespace analyticsreporting_v4 { */ export interface Schema$SegmentSequenceStep { /** - * Specifies if the step immediately precedes or can be any time before the - * next step. + * Specifies if the step immediately precedes or can be any time before the next step. */ matchType?: string; /** - * A sequence is specified with a list of Or grouped filters which are - * combined with `AND` operator. + * A sequence is specified with a list of Or grouped filters which are combined with `AND` operator. */ orFiltersForSegment?: Schema$OrFiltersForSegment[]; } /** - * Sequence conditions consist of one or more steps, where each step is - * defined by one or more dimension/metric conditions. Multiple steps can be - * combined with special sequence operators. + * Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators. */ export interface Schema$SequenceSegment { /** - * If set, first step condition must match the first hit of the visitor (in - * the date range). + * If set, first step condition must match the first hit of the visitor (in the date range). */ firstStepShouldMatchFirstHit?: boolean; /** @@ -1322,24 +1019,20 @@ export namespace analyticsreporting_v4 { segmentSequenceSteps?: Schema$SegmentSequenceStep[]; } /** - * A Simple segment conditions consist of one or more dimension/metric - * conditions that can be combined. + * A Simple segment conditions consist of one or more dimension/metric conditions that can be combined. */ export interface Schema$SimpleSegment { /** - * A list of segment filters groups which are combined with logical `AND` - * operator. + * A list of segment filters groups which are combined with logical `AND` operator. */ orFiltersForSegment?: Schema$OrFiltersForSegment[]; } /** - * Represents details collected when the visitor performs a transaction on the - * page. + * Represents details collected when the visitor performs a transaction on the page. */ export interface Schema$TransactionData { /** - * The transaction ID, supplied by the e-commerce tracking method, for the - * purchase in the shopping cart. + * The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart. */ transactionId?: string; /** @@ -1360,8 +1053,7 @@ export namespace analyticsreporting_v4 { */ export interface Schema$User { /** - * Type of the user in the request. The field `userId` is associated with - * this type. + * Type of the user in the request. The field `userId` is associated with this type. */ type?: string; /** @@ -1370,8 +1062,7 @@ export namespace analyticsreporting_v4 { userId?: string; } /** - * This represents a user session performed on a specific device at a certain - * time over a period of time. + * This represents a user session performed on a specific device at a certain time over a period of time. */ export interface Schema$UserActivitySession { /** @@ -1379,10 +1070,7 @@ export namespace analyticsreporting_v4 { */ activities?: Schema$Activity[]; /** - * The data source of a hit. By default, hits sent from analytics.js are - * reported as "web" and hits sent from the mobile SDKs are - * reported as "app". These values can be overridden in the - * Measurement Protocol. + * The data source of a hit. By default, hits sent from analytics.js are reported as "web" and hits sent from the mobile SDKs are reported as "app". These values can be overridden in the Measurement Protocol. */ dataSource?: string; /** @@ -1390,8 +1078,7 @@ export namespace analyticsreporting_v4 { */ deviceCategory?: string; /** - * Platform on which the activity happened: "android", - * "ios" etc. + * Platform on which the activity happened: "android", "ios" etc. */ platform?: string; /** diff --git a/src/apis/androiddeviceprovisioning/package.json b/src/apis/androiddeviceprovisioning/package.json index c882db7399d..58cd296bb3d 100644 --- a/src/apis/androiddeviceprovisioning/package.json +++ b/src/apis/androiddeviceprovisioning/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index 08538a71767..a12c84d0662 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace androiddeviceprovisioning_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace androiddeviceprovisioning_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Android Device Provisioning Partner API * - * Automates Android zero-touch enrollment for device resellers, customers, - * and EMMs. + * Automates Android zero-touch enrollment for device resellers, customers, and EMMs. * * @example * const {google} = require('googleapis'); @@ -115,7 +110,10 @@ export namespace androiddeviceprovisioning_v1 { partners: Resource$Partners; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.customers = new Resource$Customers(this.context); this.operations = new Resource$Operations(this.context); @@ -153,15 +151,12 @@ export namespace androiddeviceprovisioning_v1 { */ deviceId?: string; /** - * The resource name of the device in the format - * `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. + * The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. */ deviceName?: string; } /** - * Request to claim devices asynchronously in batch. Claiming a device adds - * the device to zero-touch enrollment and shows the device in the - * customer's view of the portal. + * Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal. */ export interface Schema$ClaimDevicesRequest { /** @@ -170,13 +165,11 @@ export namespace androiddeviceprovisioning_v1 { claims?: Schema$PartnerClaim[]; } /** - * A reseller, vendor, or customer in the zero-touch reseller and customer - * APIs. + * A reseller, vendor, or customer in the zero-touch reseller and customer APIs. */ export interface Schema$Company { /** - * Input only. Optional. Email address of customer's users in the admin - * role. Each email address must be associated with a Google Account. + * Input only. Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account. */ adminEmails?: string[]; /** @@ -184,45 +177,28 @@ export namespace androiddeviceprovisioning_v1 { */ companyId?: string; /** - * Required. The name of the company. For example _XYZ Corp_. Displayed to - * the company's employees in the zero-touch enrollment portal. + * Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal. */ companyName?: string; /** - * Output only. The API resource name of the company. The resource name is - * one of the following formats: * - * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * - * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * - * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` - * Assigned by the server. + * Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. */ name?: string; /** - * Input only. Email address of customer's users in the owner role. At - * least one `owner_email` is required. Each email address must be - * associated with a Google Account. Owners share the same access as admins - * but can also add, delete, and edit your organization's portal users. + * Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. */ ownerEmails?: string[]; /** - * Output only. Whether any user from the company has accepted the latest - * Terms of Service (ToS). See TermsStatus. + * Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus. */ termsStatus?: string; } /** - * A configuration collects the provisioning options for Android devices. Each - * configuration combines the following: * The EMM device policy controller - * (DPC) installed on the devices. * EMM policies enforced on the devices. * - * Metadata displayed on the device to help users during setup. Customers can - * add as many configurations as they need. However, zero-touch enrollment - * works best when a customer sets a default configuration that's applied - * to any new devices the organization purchases. + * A configuration collects the provisioning options for Android devices. Each configuration combines the following: * The EMM device policy controller (DPC) installed on the devices. * EMM policies enforced on the devices. * Metadata displayed on the device to help users during setup. Customers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases. */ export interface Schema$Configuration { /** - * Required. The name of the organization. Zero-touch enrollment shows this - * organization name to device users during device provisioning. + * Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning. */ companyName?: string; /** @@ -230,29 +206,19 @@ export namespace androiddeviceprovisioning_v1 { */ configurationId?: string; /** - * Required. A short name that describes the configuration's purpose. - * For example, _Sales team_ or _Temporary employees_. The zero-touch - * enrollment portal displays this name to IT admins. + * Required. A short name that describes the configuration's purpose. For example, _Sales team_ or _Temporary employees_. The zero-touch enrollment portal displays this name to IT admins. */ configurationName?: string; /** - * Required. The email address that device users can contact to get help. - * Zero-touch enrollment shows this email address to device users before - * device provisioning. The value is validated on input. + * Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input. */ contactEmail?: string; /** - * Required. The telephone number that device users can call, using another - * device, to get help. Zero-touch enrollment shows this number to device - * users before device provisioning. Accepts numerals, spaces, the plus - * sign, hyphens, and parentheses. + * Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses. */ contactPhone?: string; /** - * A message, containing one or two sentences, to help device users get help - * or give them more details about what’s happening to their device. - * Zero-touch enrollment shows this message before the device is - * provisioned. + * A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned. */ customMessage?: string; /** @@ -260,23 +226,15 @@ export namespace androiddeviceprovisioning_v1 { */ dpcExtras?: string; /** - * Required. The resource name of the selected DPC (device policy - * controller) in the format `customers/[CUSTOMER_ID]/dpcs/x. To list the - * supported DPCs, call `customers.dpcs.list`. + * Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/x. To list the supported DPCs, call `customers.dpcs.list`. */ dpcResourcePath?: string; /** - * Required. Whether this is the default configuration that zero-touch - * enrollment applies to any new devices the organization purchases in the - * future. Only one customer configuration can be the default. Setting this - * value to `true`, changes the previous default configuration's - * `isDefault` value to `false`. + * Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`. */ isDefault?: boolean; /** - * Output only. The API resource name in the format - * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by - * the server. + * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server. */ name?: string; } @@ -285,10 +243,7 @@ export namespace androiddeviceprovisioning_v1 { */ export interface Schema$CreateCustomerRequest { /** - * Required. The company data to populate the new customer. Must contain a - * value for `companyName` and at least one `owner_email` that's - * associated with a Google Account. The values for `companyId` and `name` - * must be empty. + * Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that's associated with a Google Account. The values for `companyId` and `name` must be empty. */ customer?: Schema$Company; } @@ -297,8 +252,7 @@ export namespace androiddeviceprovisioning_v1 { */ export interface Schema$CustomerApplyConfigurationRequest { /** - * Required. The configuration applied to the device in the format - * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. + * Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. */ configuration?: string; /** @@ -324,8 +278,7 @@ export namespace androiddeviceprovisioning_v1 { */ customers?: Schema$Company[]; /** - * A token used to access the next page of results. Omitted if no further - * results are available. + * A token used to access the next page of results. Omitted if no further results are available. */ nextPageToken?: string; } @@ -338,8 +291,7 @@ export namespace androiddeviceprovisioning_v1 { */ devices?: Schema$Device[]; /** - * A token used to access the next page of results. Omitted if no further - * results are available. + * A token used to access the next page of results. Omitted if no further results are available. */ nextPageToken?: string; } @@ -348,8 +300,7 @@ export namespace androiddeviceprovisioning_v1 { */ export interface Schema$CustomerListDpcsResponse { /** - * The list of DPCs available to the customer that support zero-touch - * enrollment. + * The list of DPCs available to the customer that support zero-touch enrollment. */ dpcs?: Schema$Dpc[]; } @@ -376,11 +327,7 @@ export namespace androiddeviceprovisioning_v1 { */ export interface Schema$Device { /** - * Output only. The provisioning claims for a device. Devices claimed for - * zero-touch enrollment have a claim with the type - * `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or - * `partners.devices.unclaimAsync` to remove the device from zero-touch - * enrollment. + * Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment. */ claims?: Schema$DeviceClaim[]; /** @@ -392,26 +339,20 @@ export namespace androiddeviceprovisioning_v1 { */ deviceId?: string; /** - * The hardware IDs that identify a manufactured device. To learn more, read - * [Identifiers](/zero-touch/guides/identifiers). + * The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](/zero-touch/guides/identifiers). */ deviceIdentifier?: Schema$DeviceIdentifier; /** - * The metadata attached to the device. Structured as key-value pairs. To - * learn more, read [Device metadata](/zero-touch/guides/metadata). + * The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](/zero-touch/guides/metadata). */ deviceMetadata?: Schema$DeviceMetadata; /** - * Output only. The API resource name in the format - * `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. + * Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. */ name?: string; } /** - * A record of a device claimed by a reseller for a customer. Devices claimed - * for zero-touch enrollment have a claim with the type - * `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for - * customers](/zero-touch/guides/how-it-works#claim). + * A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim). */ export interface Schema$DeviceClaim { /** @@ -427,20 +368,16 @@ export namespace androiddeviceprovisioning_v1 { */ sectionType?: string; /** - * The timestamp when the device will exit ‘vacation mode’. This value is - * present iff the device is in 'vacation mode'. + * The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'. */ vacationModeExpireTime?: string; /** - * The timestamp when the device was put into ‘vacation mode’. This value is - * present iff the device is in 'vacation mode'. + * The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'. */ vacationModeStartTime?: string; } /** - * Encapsulates hardware and product IDs to identify a manufactured device. To - * understand requirements on identifier sets, read - * [Identifiers](/zero-touch/guides/identifiers). + * Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](/zero-touch/guides/identifiers). */ export interface Schema$DeviceIdentifier { /** @@ -448,10 +385,7 @@ export namespace androiddeviceprovisioning_v1 { */ imei?: string; /** - * The device manufacturer’s name. Matches the device's built-in value - * returned from `android.os.Build.MANUFACTURER`. Allowed values are listed - * in - * [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). + * The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). */ manufacturer?: string; /** @@ -459,20 +393,16 @@ export namespace androiddeviceprovisioning_v1 { */ meid?: string; /** - * The device model's name. Matches the device's built-in value - * returned from `android.os.Build.MODEL`. Allowed values are listed in - * [models](/zero-touch/resources/manufacturer-names#model-names). + * The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). */ model?: string; /** - * The manufacturer's serial number for the device. This value might not - * be unique across different device models. + * The manufacturer's serial number for the device. This value might not be unique across different device models. */ serialNumber?: string; } /** - * Metadata entries that can be attached to a `Device`. To learn more, read - * [Device metadata](/zero-touch/guides/metadata). + * Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](/zero-touch/guides/metadata). */ export interface Schema$DeviceMetadata { /** @@ -481,13 +411,7 @@ export namespace androiddeviceprovisioning_v1 { entries?: {[key: string]: string}; } /** - * A `DeviceReference` is an API abstraction that lets you supply a _device_ - * argument to a method using one of the following identifier types: * A - * numeric API resource ID. * Real-world hardware IDs, such as IMEI number, - * belonging to the manufactured device. Methods that operate on devices - * take a `DeviceReference` as a parameter type because it's more flexible - * for the caller. To learn more about device identifiers, read - * [Identifiers](/zero-touch/guides/identifiers). + * A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](/zero-touch/guides/identifiers). */ export interface Schema$DeviceReference { /** @@ -500,16 +424,11 @@ export namespace androiddeviceprovisioning_v1 { deviceIdentifier?: Schema$DeviceIdentifier; } /** - * Tracks the status of a long-running operation to asynchronously update a - * batch of reseller metadata attached to devices. To learn more, read - * [Long‑running batch - * operations](/zero-touch/guides/how-it-works#operations). + * Tracks the status of a long-running operation to asynchronously update a batch of reseller metadata attached to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). */ export interface Schema$DevicesLongRunningOperationMetadata { /** - * The number of metadata updates in the operation. This might be different - * from the number of updates in the request if the API can't parse some - * of the updates. + * The number of metadata updates in the operation. This might be different from the number of updates in the request if the API can't parse some of the updates. */ devicesCount?: number; /** @@ -517,64 +436,42 @@ export namespace androiddeviceprovisioning_v1 { */ processingStatus?: string; /** - * The processing progress of the operation. Measured as a number from 0 to - * 100. A value of 10O doesnt always mean the operation completed—check for - * the inclusion of a `done` field. + * The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesnt always mean the operation completed—check for the inclusion of a `done` field. */ progress?: number; } /** - * Tracks the status of a long-running operation to claim, unclaim, or attach - * metadata to devices. To learn more, read [Long‑running batch - * operations](/zero-touch/guides/how-it-works#operations). + * Tracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). */ export interface Schema$DevicesLongRunningOperationResponse { /** - * The processing status for each device in the operation. One - * `PerDeviceStatus` per device. The list order matches the items in the - * original request. + * The processing status for each device in the operation. One `PerDeviceStatus` per device. The list order matches the items in the original request. */ perDeviceStatus?: Schema$OperationPerDevice[]; /** - * A summary of how many items in the operation the server processed - * successfully. Updated as the operation progresses. + * A summary of how many items in the operation the server processed successfully. Updated as the operation progresses. */ successCount?: number; } /** - * An EMM's DPC ([device policy - * controller](http://developer.android.com/work/dpc/build-dpc.html)). - * Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a - * device to maintain the customer's mobile policies. All the DPCs listed - * by the API support zero-touch enrollment and are available in Google Play. + * An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a device to maintain the customer's mobile policies. All the DPCs listed by the API support zero-touch enrollment and are available in Google Play. */ export interface Schema$Dpc { /** - * Output only. The title of the DPC app in Google Play. For example, - * _Google Apps Device Policy_. Useful in an application's user - * interface. + * Output only. The title of the DPC app in Google Play. For example, _Google Apps Device Policy_. Useful in an application's user interface. */ dpcName?: string; /** - * Output only. The API resource name in the format - * `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To - * maintain a reference to a DPC across customer accounts, persist and match - * the last path component (`DPC_ID`). + * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across customer accounts, persist and match the last path component (`DPC_ID`). */ name?: string; /** - * Output only. The DPC's Android application ID that looks like a Java - * package name. Zero-touch enrollment installs the DPC app onto a device - * using this identifier. + * Output only. The DPC's Android application ID that looks like a Java package name. Zero-touch enrollment installs the DPC app onto a device using this identifier. */ packageName?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -586,8 +483,7 @@ export namespace androiddeviceprovisioning_v1 { */ deviceIdentifier?: Schema$DeviceIdentifier; /** - * Required. The maximum number of devices to show in a page of results. - * Must be between 1 and 100 inclusive. + * Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. */ limit?: string; /** @@ -604,8 +500,7 @@ export namespace androiddeviceprovisioning_v1 { */ devices?: Schema$Device[]; /** - * A token used to access the next page of results. Omitted if no further - * results are available. + * A token used to access the next page of results. Omitted if no further results are available. */ nextPageToken?: string; /** @@ -622,8 +517,7 @@ export namespace androiddeviceprovisioning_v1 { */ customerId?: string[]; /** - * Required. The maximum number of devices to show in a page of results. - * Must be between 1 and 100 inclusive. + * Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. */ limit?: string; /** @@ -644,8 +538,7 @@ export namespace androiddeviceprovisioning_v1 { */ devices?: Schema$Device[]; /** - * A token used to access the next page of results. Omitted if no further - * results are available. + * A token used to access the next page of results. Omitted if no further results are available. */ nextPageToken?: string; /** @@ -662,8 +555,7 @@ export namespace androiddeviceprovisioning_v1 { */ customers?: Schema$Company[]; /** - * A token to retrieve the next page of results. Omitted if no further - * results are available. + * A token to retrieve the next page of results. Omitted if no further results are available. */ nextPageToken?: string; /** @@ -680,8 +572,7 @@ export namespace androiddeviceprovisioning_v1 { */ customers?: Schema$Company[]; /** - * A token to retrieve the next page of results. Omitted if no further - * results are available. + * A token to retrieve the next page of results. Omitted if no further results are available. */ nextPageToken?: string; /** @@ -694,8 +585,7 @@ export namespace androiddeviceprovisioning_v1 { */ export interface Schema$ListVendorsResponse { /** - * A token to retrieve the next page of results. Omitted if no further - * results are available. + * A token to retrieve the next page of results. Omitted if no further results are available. */ nextPageToken?: string; /** @@ -703,51 +593,37 @@ export namespace androiddeviceprovisioning_v1 { */ totalSize?: number; /** - * List of vendors of the reseller partner. Fields `name`, `companyId` and - * `companyName` are populated to the Company object. + * List of vendors of the reseller partner. Fields `name`, `companyId` and `companyName` are populated to the Company object. */ vendors?: Schema$Company[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** - * This field will always be not set if the operation is created by - * `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, - * error information for each device is set in - * `response.perDeviceStatus.result.status`. + * This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`. */ error?: Schema$Status; /** - * This field will contain a `DevicesLongRunningOperationMetadata` object if - * the operation is created by `claimAsync`, `unclaimAsync`, or - * `updateMetadataAsync`. + * This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * This field will contain a `DevicesLongRunningOperationResponse` object if - * the operation is created by `claimAsync`, `unclaimAsync`, or - * `updateMetadataAsync`. + * This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. */ response?: {[key: string]: any}; } /** - * A task for each device in the operation. Corresponds to each device change - * in the request. + * A task for each device in the operation. Corresponds to each device change in the request. */ export interface Schema$OperationPerDevice { /** @@ -805,8 +681,7 @@ export namespace androiddeviceprovisioning_v1 { */ sectionType?: string; /** - * The duration of the vacation unlock starting from when the request is - * processed. (1 day is treated as 24 hours) + * The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours) */ vacationModeDays?: number; /** @@ -836,40 +711,7 @@ export namespace androiddeviceprovisioning_v1 { status?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -877,14 +719,11 @@ export namespace androiddeviceprovisioning_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -905,8 +744,7 @@ export namespace androiddeviceprovisioning_v1 { */ sectionType?: string; /** - * The duration of the vacation unlock starting from when the request is - * processed. (1 day is treated as 24 hours) + * The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours) */ vacationModeDays?: number; /** @@ -1060,8 +898,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of customers to show in a page of results. A number - * between 1 and 100 (inclusive). + * The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive). */ pageSize?: number; /** @@ -1078,8 +915,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.customers.configurations.create - * @desc Creates a new configuration. Once created, a customer can apply the - * configuration to devices. + * @desc Creates a new configuration. Once created, a customer can apply the configuration to devices. * @alias androiddeviceprovisioning.customers.configurations.create * @memberOf! () * @@ -1155,8 +991,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.customers.configurations.delete - * @desc Deletes an unused configuration. The API call fails if the customer - * has devices with the configuration applied. + * @desc Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied. * @alias androiddeviceprovisioning.customers.configurations.delete * @memberOf! () * @@ -1463,8 +1298,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The customer that manages the configuration. An API resource - * name in the format `customers/[CUSTOMER_ID]`. + * Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`. */ parent?: string; @@ -1481,9 +1315,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The configuration to delete. An API resource name in the format - * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the - * configuration is applied to any devices, the API call fails. + * Required. The configuration to delete. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the configuration is applied to any devices, the API call fails. */ name?: string; } @@ -1495,8 +1327,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The configuration to get. An API resource name in the format - * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. + * Required. The configuration to get. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. */ name?: string; } @@ -1508,8 +1339,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The customer that manages the listed configurations. An API - * resource name in the format `customers/[CUSTOMER_ID]`. + * Required. The customer that manages the listed configurations. An API resource name in the format `customers/[CUSTOMER_ID]`. */ parent?: string; } @@ -1521,16 +1351,11 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The API resource name in the format - * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by - * the server. + * Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server. */ name?: string; /** - * Required. The field mask applied to the target `Configuration` before - * updating the fields. To learn more about using field masks, read - * [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) - * in the Protocol Buffers documentation. + * Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation. */ updateMask?: string; @@ -1548,10 +1373,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.customers.devices.applyConfiguration - * @desc Applies a Configuration to the device to register the device for - * zero-touch enrollment. After applying a configuration to a device, the - * device automatically provisions itself on first boot, or next factory - * reset. + * @desc Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset. * @alias androiddeviceprovisioning.customers.devices.applyConfiguration * @memberOf! () * @@ -1852,9 +1674,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.customers.devices.unclaim - * @desc Unclaims a device from a customer and removes it from zero-touch - * enrollment. After removing a device, a customer must contact their - * reseller to register the device into zero-touch enrollment again. + * @desc Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again. * @alias androiddeviceprovisioning.customers.devices.unclaim * @memberOf! () * @@ -1935,8 +1755,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The customer managing the device. An API resource name in the - * format `customers/[CUSTOMER_ID]`. + * Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. */ parent?: string; @@ -1953,8 +1772,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The device to get. An API resource name in the format - * `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. + * Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. */ name?: string; } @@ -1966,8 +1784,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of devices to show in a page of results. Must be - * between 1 and 100 inclusive. + * The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. */ pageSize?: string; /** @@ -1975,8 +1792,7 @@ export namespace androiddeviceprovisioning_v1 { */ pageToken?: string; /** - * Required. The customer managing the devices. An API resource name in the - * format `customers/[CUSTOMER_ID]`. + * Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. */ parent?: string; } @@ -1988,8 +1804,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The customer managing the device in the format - * `customers/[CUSTOMER_ID]`. + * Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`. */ parent?: string; @@ -2006,8 +1821,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The customer managing the device. An API resource name in the - * format `customers/[CUSTOMER_ID]`. + * Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. */ parent?: string; @@ -2025,8 +1839,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.customers.dpcs.list - * @desc Lists the DPCs (device policy controllers) that support zero-touch - * enrollment. + * @desc Lists the DPCs (device policy controllers) that support zero-touch enrollment. * @alias androiddeviceprovisioning.customers.dpcs.list * @memberOf! () * @@ -2107,8 +1920,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The customer that can use the DPCs in configurations. An API - * resource name in the format `customers/[CUSTOMER_ID]`. + * Required. The customer that can use the DPCs in configurations. An API resource name in the format `customers/[CUSTOMER_ID]`. */ parent?: string; } @@ -2121,9 +1933,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias androiddeviceprovisioning.operations.get * @memberOf! () * @@ -2226,11 +2036,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.customers.create - * @desc Creates a customer for zero-touch enrollment. After the method - * returns successfully, admin and owner roles can manage devices and EMM - * configs by calling API methods or using their zero-touch enrollment - * portal. The customer receives an email that welcomes them to zero-touch - * enrollment and explains how to sign into the portal. + * @desc Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal. * @alias androiddeviceprovisioning.partners.customers.create * @memberOf! () * @@ -2304,9 +2110,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.customers.list - * @desc Lists the customers that are enrolled to the reseller identified by - * the `partnerId` argument. This list includes customers that the reseller - * created and customers that enrolled themselves using the portal. + * @desc Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal. * @alias androiddeviceprovisioning.partners.customers.list * @memberOf! () * @@ -2392,8 +2196,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource ID in the format `partners/[PARTNER_ID]` - * that identifies the reseller. + * Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller. */ parent?: string; @@ -2410,8 +2213,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of results to be returned. If not specified or 0, all - * the records are returned. + * The maximum number of results to be returned. If not specified or 0, all the records are returned. */ pageSize?: number; /** @@ -2432,9 +2234,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.devices.claim - * @desc Claims a device for a customer and adds it to zero-touch - * enrollment. If the device is already claimed by another customer, the - * call returns an error. + * @desc Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error. * @alias androiddeviceprovisioning.partners.devices.claim * @memberOf! () * @@ -2510,9 +2310,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.devices.claimAsync - * @desc Claims a batch of devices for a customer asynchronously. Adds the - * devices to zero-touch enrollment. To learn more, read [Long‑running batch - * operations](/zero-touch/guides/how-it-works#operations). + * @desc Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). * @alias androiddeviceprovisioning.partners.devices.claimAsync * @memberOf! () * @@ -2679,10 +2477,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.devices.findByOwner - * @desc Finds devices claimed for customers. The results only contain - * devices registered to the reseller that's identified by the `partnerId` - * argument. The customer's devices purchased from other resellers don't - * appear in the results. + * @desc Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results. * @alias androiddeviceprovisioning.partners.devices.findByOwner * @memberOf! () * @@ -2911,8 +2706,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.devices.unclaim - * @desc Unclaims a device from a customer and removes it from zero-touch - * enrollment. + * @desc Unclaims a device from a customer and removes it from zero-touch enrollment. * @alias androiddeviceprovisioning.partners.devices.unclaim * @memberOf! () * @@ -2985,9 +2779,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.devices.unclaimAsync - * @desc Unclaims a batch of devices for a customer asynchronously. Removes - * the devices from zero-touch enrollment. To learn more, read [Long‑running - * batch operations](/zero-touch/guides/how-it-works#operations). + * @desc Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). * @alias androiddeviceprovisioning.partners.devices.unclaimAsync * @memberOf! () * @@ -3062,10 +2854,7 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.devices.updateMetadataAsync - * @desc Updates the reseller metadata attached to a batch of devices. This - * method updates devices asynchronously and returns an `Operation` that can - * be used to track progress. Read [Long‑running batch - * operations](/zero-touch/guides/how-it-works#operations). + * @desc Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). * @alias androiddeviceprovisioning.partners.devices.updateMetadataAsync * @memberOf! () * @@ -3215,8 +3004,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The device API resource name in the format - * `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. + * Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. */ name?: string; } @@ -3232,8 +3020,7 @@ export namespace androiddeviceprovisioning_v1 { */ deviceId?: string; /** - * Required. The owner of the newly set metadata. Set this to the partner - * ID. + * Required. The owner of the newly set metadata. Set this to the partner ID. */ metadataOwnerId?: string; @@ -3508,8 +3295,7 @@ export namespace androiddeviceprovisioning_v1 { */ pageToken?: string; /** - * Required. The resource name in the format - * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. + * Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. */ parent?: string; } diff --git a/src/apis/androidenterprise/package.json b/src/apis/androidenterprise/package.json index 09662807920..8698868c4a9 100644 --- a/src/apis/androidenterprise/package.json +++ b/src/apis/androidenterprise/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 261374aa07f..731133e05ab 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace androidenterprise_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace androidenterprise_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -110,7 +107,10 @@ export namespace androidenterprise_v1 { webapps: Resource$Webapps; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.devices = new Resource$Devices(this.context); this.enterprises = new Resource$Enterprises(this.context); @@ -138,8 +138,7 @@ export namespace androidenterprise_v1 { } /** - * This represents an enterprise admin who can manage the enterprise in the - * managed Google Play store. + * This represents an enterprise admin who can manage the enterprise in the managed Google Play store. */ export interface Schema$Administrator { /** @@ -152,8 +151,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$AdministratorWebToken { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#administratorWebToken". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebToken". */ kind?: string; /** @@ -162,14 +160,11 @@ export namespace androidenterprise_v1 { token?: string; } /** - * Specification for a token used to generate iframes. The token specifies - * what data the admin is allowed to modify and the URI the iframe is allowed - * to communiate with. + * Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with. */ export interface Schema$AdministratorWebTokenSpec { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#administratorWebTokenSpec". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebTokenSpec". */ kind?: string; /** @@ -177,8 +172,7 @@ export namespace androidenterprise_v1 { */ managedConfigurations?: Schema$AdministratorWebTokenSpecManagedConfigurations; /** - * The URI of the parent frame hosting the iframe. To prevent XSS, the - * iframe may not be hosted at other URIs. This URI must be https. + * The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https. */ parent?: string; /** @@ -237,13 +231,11 @@ export namespace androidenterprise_v1 { enabled?: boolean; } /** - * Represents the list of app restrictions available to be pre-configured for - * the product. + * Represents the list of app restrictions available to be pre-configured for the product. */ export interface Schema$AppRestrictionsSchema { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#appRestrictionsSchema". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema". */ kind?: string; /** @@ -252,54 +244,40 @@ export namespace androidenterprise_v1 { restrictions?: Schema$AppRestrictionsSchemaRestriction[]; } /** - * An event generated when a new app version is uploaded to Google Play and - * its app restrictions schema changed. To fetch the app restrictions schema - * for an app, use Products.getAppRestrictionsSchema on the EMM API. + * An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API. */ export interface Schema$AppRestrictionsSchemaChangeEvent { /** - * The id of the product (e.g. "app:com.google.android.gm") for - * which the app restriction schema changed. This field will always be - * present. + * The id of the product (e.g. "app:com.google.android.gm") for which the app restriction schema changed. This field will always be present. */ productId?: string; } /** - * A restriction in the App Restriction Schema represents a piece of - * configuration that may be pre-applied. + * A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied. */ export interface Schema$AppRestrictionsSchemaRestriction { /** - * The default value of the restriction. bundle and bundleArray restrictions - * never have a default value. + * The default value of the restriction. bundle and bundleArray restrictions never have a default value. */ defaultValue?: Schema$AppRestrictionsSchemaRestrictionRestrictionValue; /** - * A longer description of the restriction, giving more detail of what it - * affects. + * A longer description of the restriction, giving more detail of what it affects. */ description?: string; /** - * For choice or multiselect restrictions, the list of possible entries' - * human-readable names. + * For choice or multiselect restrictions, the list of possible entries' human-readable names. */ entry?: string[]; /** - * For choice or multiselect restrictions, the list of possible entries' - * machine-readable values. These values should be used in the - * configuration, either as a single string value for a choice restriction - * or in a stringArray for a multiselect restriction. + * For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction. */ entryValue?: string[]; /** - * The unique key that the product uses to identify the restriction, e.g. - * "com.google.android.gm.fieldname". + * The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname". */ key?: string; /** - * For bundle or bundleArray restrictions, the list of nested restrictions. - * A bundle restriction is always nested within a bundleArray restriction, - * and a bundleArray restriction is at most two levels deep. + * For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep. */ nestedRestriction?: Schema$AppRestrictionsSchemaRestriction[]; /** @@ -328,13 +306,11 @@ export namespace androidenterprise_v1 { */ valueInteger?: number; /** - * The list of string values - this will only be present if type is - * multiselect. + * The list of string values - this will only be present if type is multiselect. */ valueMultiselect?: string[]; /** - * The string value - this will be present for types string, choice and - * hidden. + * The string value - this will be present for types string, choice and hidden. */ valueString?: string; } @@ -343,26 +319,20 @@ export namespace androidenterprise_v1 { */ export interface Schema$ApprovalUrlInfo { /** - * A URL that displays a product's permissions and that can also be used - * to approve the product with the Products.approve call. + * A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call. */ approvalUrl?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#approvalUrlInfo". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo". */ kind?: string; } /** - * An event generated when a new version of an app is uploaded to Google Play. - * Notifications are sent for new public versions only: alpha, beta, or canary - * versions do not generate this event. To fetch up-to-date version history - * for an app, use Products.Get on the EMM API. + * An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API. */ export interface Schema$AppUpdateEvent { /** - * The id of the product (e.g. "app:com.google.android.gm") that - * was updated. This field will always be present. + * The id of the product (e.g. "app:com.google.android.gm") that was updated. This field will always be present. */ productId?: string; } @@ -379,9 +349,7 @@ export namespace androidenterprise_v1 { */ track?: string; /** - * Track ids that the app version is published in. Replaces the track field - * (deprecated), but doesn't include the production track (see - * isProduction instead). + * Track ids that the app version is published in. Replaces the track field (deprecated), but doesn't include the production track (see isProduction instead). */ trackId?: string[]; /** @@ -389,32 +357,25 @@ export namespace androidenterprise_v1 { */ versionCode?: number; /** - * The string used in the Play store by the app developer to identify the - * version. The string is not necessarily unique or localized (for example, - * the string could be "1.4"). + * The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4"). */ versionString?: string; } /** - * An AuthenticationToken is used by the EMM's device policy client on a - * device to provision the given EMM-managed user on that device. + * An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device. */ export interface Schema$AuthenticationToken { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#authenticationToken". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken". */ kind?: string; /** - * The authentication token to be passed to the device policy client on the - * device where it can be used to provision the account for which this token - * was generated. + * The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated. */ token?: string; } /** - * The auto-install constraint. Defines a set of restrictions for - * installation. At least one of the fields must be set. + * The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set. */ export interface Schema$AutoInstallConstraint { /** @@ -432,8 +393,7 @@ export namespace androidenterprise_v1 { } export interface Schema$AutoInstallPolicy { /** - * The constraints for auto-installing the app. You can specify a maximum of - * one constraint. + * The constraints for auto-installing the app. You can specify a maximum of one constraint. */ autoInstallConstraint?: Schema$AutoInstallConstraint[]; /** @@ -441,27 +401,20 @@ export namespace androidenterprise_v1 { */ autoInstallMode?: string; /** - * The priority of the install, as an unsigned integer. A lower number means - * higher priority. + * The priority of the install, as an unsigned integer. A lower number means higher priority. */ autoInstallPriority?: number; /** - * The minimum version of the app. If a lower version of the app is - * installed, then the app will be auto-updated according to the - * auto-install constraints, instead of waiting for the regular auto-update. + * The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. */ minimumVersionCode?: number; } /** - * A configuration variables resource contains the managed configuration - * settings ID to be applied to a single user, as well as the variable set - * that is attributed to the user. The variable set will be used to replace - * placeholders in the managed configuration settings. + * A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. */ export interface Schema$ConfigurationVariables { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#configurationVariables". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables". */ kind?: string; /** @@ -474,32 +427,19 @@ export namespace androidenterprise_v1 { variableSet?: Schema$VariableSet[]; } /** - * A Devices resource represents a mobile device managed by the EMM and - * belonging to a specific enterprise user. + * A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. */ export interface Schema$Device { /** - * The Google Play Services Android ID for the device encoded as a lowercase - * hex string. For example, "123456789abcdef0". + * The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0". */ androidId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#device". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device". */ kind?: string; /** - * Identifies the extent to which the device is controlled by a managed - * Google Play EMM in various deployment configurations. Possible values - * include: - "managedDevice", a device that has the EMM's - * device policy controller (DPC) as the device owner. - - * "managedProfile", a device that has a profile managed by the - * DPC (DPC is profile owner) in addition to a separate, personal profile - * that is unavailable to the DPC. - "containerApp", no longer - * used (deprecated). - "unmanagedProfile", a device that has - * been allowed (by the domain's admin, using the Admin Console to - * enable the privilege) to use managed Google Play, but the profile is - * itself not owned by a DPC. + * Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC. */ managementType?: string; /** @@ -516,48 +456,29 @@ export namespace androidenterprise_v1 { */ device?: Schema$Device[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#devicesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse". */ kind?: string; } /** - * The state of a user's device, as accessed by the getState and setState - * methods on device resources. + * The state of a user's device, as accessed by the getState and setState methods on device resources. */ export interface Schema$DeviceState { /** - * The state of the Google account on the device. "enabled" - * indicates that the Google account on the device can be used to access - * Google services (including Google Play), while "disabled" means - * that it cannot. A new device is initially in the "disabled" - * state. + * The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state. */ accountState?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#deviceState". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState". */ kind?: string; } /** - * An Enterprises resource represents the binding between an EMM and a - * specific organization. That binding can be instantiated in one of two - * different ways using this API as follows: - For Google managed domain - * customers, the process involves using Enterprises.enroll and - * Enterprises.setAccount (in conjunction with artifacts obtained from the - * Admin console and the Google API Console) and submitted to the EMM through - * a more-or-less manual process. - For managed Google Play Accounts - * customers, the process involves using Enterprises.generateSignupUrl and - * Enterprises.completeSignup in conjunction with the managed Google Play - * sign-up UI (Google-provided mechanism) to create the binding without manual - * steps. As an EMM, you can support either or both approaches in your EMM - * console. See Create an Enterprise for details. + * An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. */ export interface Schema$Enterprise { /** - * Admins of the enterprise. This is only supported for enterprises created - * via the EMM-initiated flow. + * Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. */ administrator?: Schema$Administrator[]; /** @@ -565,8 +486,7 @@ export namespace androidenterprise_v1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#enterprise". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". */ kind?: string; /** @@ -579,8 +499,7 @@ export namespace androidenterprise_v1 { primaryDomain?: string; } /** - * A service account that can be used to authenticate as the enterprise to API - * calls that require such authentication. + * A service account that can be used to authenticate as the enterprise to API calls that require such authentication. */ export interface Schema$EnterpriseAccount { /** @@ -588,8 +507,7 @@ export namespace androidenterprise_v1 { */ accountEmail?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#enterpriseAccount". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount". */ kind?: string; } @@ -602,8 +520,7 @@ export namespace androidenterprise_v1 { */ enterprise?: Schema$Enterprise[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#enterprisesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse". */ kind?: string; } @@ -613,47 +530,24 @@ export namespace androidenterprise_v1 { */ messageId?: string; /** - * The name of the Cloud Pub/Sub topic to which notifications for this - * enterprise's enrolled account will be sent. + * The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent. */ topicName?: string; } /** - * The presence of an Entitlements resource indicates that a user has the - * right to use a particular app. Entitlements are user specific, not device - * specific. This allows a user with an entitlement to an app to install the - * app on all their devices. It's also possible for a user to hold an - * entitlement to an app without installing the app on any device. The API - * can be used to create an entitlement. As an option, you can also use the - * API to trigger the installation of an app on all a user's managed - * devices at the same time the entitlement is created. If the app is free, - * creating the entitlement also creates a group license for that app. For - * paid apps, creating the entitlement consumes one license, and that license - * remains consumed until the entitlement is removed. If the enterprise - * hasn't purchased enough licenses, then no entitlement is created and - * the installation fails. An entitlement is also not created for an app if - * the app requires permissions that the enterprise hasn't accepted. If - * an entitlement is deleted, the app may be uninstalled from a user's - * device. As a best practice, uninstall the app by calling Installs.delete() - * before deleting the entitlement. Entitlements for apps that a user pays - * for on an unmanaged profile have "userPurchase" as the - * entitlement reason. These entitlements cannot be removed via the API. + * The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. */ export interface Schema$Entitlement { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#entitlement". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". */ kind?: string; /** - * The ID of the product that the entitlement is for. For example, - * "app:com.google.android.gm". + * The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". */ productId?: string; /** - * The reason for the entitlement. For example, "free" for free - * apps. This property is temporary: it will be replaced by the acquisition - * kind field of group licenses. + * The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. */ reason?: string; } @@ -662,82 +556,44 @@ export namespace androidenterprise_v1 { */ export interface Schema$EntitlementsListResponse { /** - * An entitlement of a user to a product (e.g. an app). For example, a free - * app that they have installed, or a paid app that they have been allocated - * a license to. + * An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to. */ entitlement?: Schema$Entitlement[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#entitlementsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse". */ kind?: string; } /** - * Group license objects allow you to keep track of licenses (called - * entitlements) for both free and paid apps. For a free app, a group license - * is created when an enterprise admin first approves the product in Google - * Play or when the first entitlement for the product is created for a user - * via the API. For a paid app, a group license object is only created when an - * enterprise admin purchases the product in Google Play for the first time. - * Use the API to query group licenses. A Grouplicenses resource includes the - * total number of licenses purchased (paid apps only) and the total number of - * licenses currently in use. In other words, the total number of Entitlements - * that exist for the product. Only one group license object is created per - * product and group license objects are never deleted. If a product is - * unapproved, its group license remains. This allows enterprise admins to - * keep track of any remaining entitlements for the product. + * Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product. */ export interface Schema$GroupLicense { /** - * How this group license was acquired. "bulkPurchase" means that - * this Grouplicenses resource was created because the enterprise purchased - * licenses for this product; otherwise, the value is "free" (for - * free products). + * How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products). */ acquisitionKind?: string; /** - * Whether the product to which this group license relates is currently - * approved by the enterprise. Products are approved when a group license is - * first created, but this approval may be revoked by an enterprise admin - * via Google Play. Unapproved products will not be visible to end users in - * collections, and new entitlements to them should not normally be created. + * Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created. */ approval?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#groupLicense". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense". */ kind?: string; /** - * The total number of provisioned licenses for this product. Returned by - * read operations, but ignored in write operations. + * The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. */ numProvisioned?: number; /** - * The number of purchased licenses (possibly in multiple purchases). If - * this field is omitted, then there is no limit on the number of licenses - * that can be provisioned (for example, if the acquisition kind is - * "free"). + * The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is "free"). */ numPurchased?: number; /** - * The permission approval status of the product. This field is only set if - * the product is approved. Possible states are: - - * "currentApproved", the current set of permissions is approved, - * but additional permissions will require the administrator to reapprove - * the product (If the product was approved without specifying the approved - * permissions setting, then this is the default behavior.), - - * "needsReapproval", the product has unapproved permissions. No - * additional product licenses can be assigned until the product is - * reapproved, - "allCurrentAndFutureApproved", the current - * permissions are approved and any future permission updates will be - * automatically approved without administrator review. + * The permission approval status of the product. This field is only set if the product is approved. Possible states are: - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.), - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review. */ permissions?: string; /** - * The ID of the product that the license is for. For example, - * "app:com.google.android.gm". + * The ID of the product that the license is for. For example, "app:com.google.android.gm". */ productId?: string; } @@ -750,8 +606,7 @@ export namespace androidenterprise_v1 { */ groupLicense?: Schema$GroupLicense[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#groupLicensesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicensesListResponse". */ kind?: string; } @@ -760,8 +615,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$GroupLicenseUsersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#groupLicenseUsersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicenseUsersListResponse". */ kind?: string; /** @@ -770,46 +624,23 @@ export namespace androidenterprise_v1 { user?: Schema$User[]; } /** - * The existence of an Installs resource indicates that an app is installed on - * a particular device (or that an install is pending). The API can be used - * to create an install resource using the update method. This triggers the - * actual install of the app on the device. If the user does not already have - * an entitlement for the app, then an attempt is made to create one. If this - * fails (for example, because the app is not free and there is no available - * license), then the creation of the install fails. The API can also be used - * to update an installed app. If the update method is used on an existing - * install, then the app will be updated to the latest available version. Note - * that it is not possible to force the installation of a specific version of - * an app: the version code is read-only. If a user installs an app - * themselves (as permitted by the enterprise), then again an install resource - * and possibly an entitlement resource are automatically created. The API - * can also be used to delete an install resource, which triggers the removal - * of the app from the device. Note that deleting an install does not - * automatically remove the corresponding entitlement, even if there are no - * remaining installs. The install resource will also be deleted if the user - * uninstalls the app themselves. + * The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves. */ export interface Schema$Install { /** - * Install state. The state "installPending" means that an install - * request has recently been made and download to the device is in progress. - * The state "installed" means that the app has been installed. - * This field is read-only. + * Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only. */ installState?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#install". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". */ kind?: string; /** - * The ID of the product that the install is for. For example, - * "app:com.google.android.gm". + * The ID of the product that the install is for. For example, "app:com.google.android.gm". */ productId?: string; /** - * The version of the installed product. Guaranteed to be set only if the - * install state is "installed". + * The version of the installed product. Guaranteed to be set only if the install state is "installed". */ versionCode?: number; } @@ -826,14 +657,11 @@ export namespace androidenterprise_v1 { */ failureDetails?: string; /** - * The reason for the installation failure. This field will always be - * present. + * The reason for the installation failure. This field will always be present. */ failureReason?: string; /** - * The id of the product (e.g. "app:com.google.android.gm") for - * which the install failure event occured. This field will always be - * present. + * The id of the product (e.g. "app:com.google.android.gm") for which the install failure event occured. This field will always be present. */ productId?: string; /** @@ -846,13 +674,11 @@ export namespace androidenterprise_v1 { */ export interface Schema$InstallsListResponse { /** - * An installation of an app for a user on a specific device. The existence - * of an install implies that the user must have an entitlement to the app. + * An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app. */ install?: Schema$Install[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#installsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse". */ kind?: string; } @@ -870,35 +696,28 @@ export namespace androidenterprise_v1 { text?: string; } /** - * Maintenance window for managed Google Play Accounts. This allows Play store - * to update the apps on the foreground in the designated window. + * Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window. */ export interface Schema$MaintenanceWindow { /** - * Duration of the maintenance window, in milliseconds. The duration must be - * between 30 minutes and 24 hours (inclusive). + * Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive). */ durationMs?: string; /** - * Start time of the maintenance window, in milliseconds after midnight on - * the device. Windows can span midnight. + * Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight. */ startTimeAfterMidnightMs?: string; } /** - * A managed configuration resource contains the set of managed properties - * defined by the app developer in the app's managed configurations - * schema, as well as any configuration variables defined for the user. + * A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. */ export interface Schema$ManagedConfiguration { /** - * Contains the ID of the managed configuration profile and the set of - * configuration variables (if any) defined for the user. + * Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. */ configurationVariables?: Schema$ConfigurationVariables; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#managedConfiguration". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". */ kind?: string; /** @@ -906,8 +725,7 @@ export namespace androidenterprise_v1 { */ managedProperty?: Schema$ManagedProperty[]; /** - * The ID of the product that the managed configuration is for, e.g. - * "app:com.google.android.gm". + * The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". */ productId?: string; } @@ -916,8 +734,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$ManagedConfigurationsForDeviceListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#managedConfigurationsForDeviceListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForDeviceListResponse". */ kind?: string; /** @@ -930,8 +747,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$ManagedConfigurationsForUserListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#managedConfigurationsForUserListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForUserListResponse". */ kind?: string; /** @@ -940,20 +756,15 @@ export namespace androidenterprise_v1 { managedConfigurationForUser?: Schema$ManagedConfiguration[]; } /** - * A managed configurations settings resource contains the set of managed - * properties that have been configured for an Android app to be applied to a - * set of users. The app's developer would have defined configurable - * properties in the managed configurations schema. + * A managed configurations settings resource contains the set of managed properties that have been configured for an Android app to be applied to a set of users. The app's developer would have defined configurable properties in the managed configurations schema. */ export interface Schema$ManagedConfigurationsSettings { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#managedConfigurationsSettings". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsSettings". */ kind?: string; /** - * The last updated time of the managed configuration settings in - * milliseconds since 1970-01-01T00:00:00Z. + * The last updated time of the managed configuration settings in milliseconds since 1970-01-01T00:00:00Z. */ lastUpdatedTimestampMillis?: string; /** @@ -974,21 +785,16 @@ export namespace androidenterprise_v1 { */ export interface Schema$ManagedConfigurationsSettingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#managedConfigurationsSettingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsSettingsListResponse". */ kind?: string; /** - * A managed configurations settings for an app that may be assigned to a - * group of users in an enterprise. + * A managed configurations settings for an app that may be assigned to a group of users in an enterprise. */ managedConfigurationsSettings?: Schema$ManagedConfigurationsSettings[]; } /** - * A managed property of a managed configuration. The property must match one - * of the properties in the app restrictions schema of the product. Exactly - * one of the value fields must be populated, and it must match the - * property's type in the app restrictions schema. + * A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. */ export interface Schema$ManagedProperty { /** @@ -996,33 +802,27 @@ export namespace androidenterprise_v1 { */ key?: string; /** - * The boolean value - this will only be present if type of the property is - * bool. + * The boolean value - this will only be present if type of the property is bool. */ valueBool?: boolean; /** - * The bundle of managed properties - this will only be present if type of - * the property is bundle. + * The bundle of managed properties - this will only be present if type of the property is bundle. */ valueBundle?: Schema$ManagedPropertyBundle; /** - * The list of bundles of properties - this will only be present if type of - * the property is bundle_array. + * The list of bundles of properties - this will only be present if type of the property is bundle_array. */ valueBundleArray?: Schema$ManagedPropertyBundle[]; /** - * The integer value - this will only be present if type of the property is - * integer. + * The integer value - this will only be present if type of the property is integer. */ valueInteger?: number; /** - * The string value - this will only be present if type of the property is - * string, choice or hidden. + * The string value - this will only be present if type of the property is string, choice or hidden. */ valueString?: string; /** - * The list of string values - this will only be present if type of the - * property is multiselect. + * The list of string values - this will only be present if type of the property is multiselect. */ valueStringArray?: string[]; } @@ -1048,11 +848,7 @@ export namespace androidenterprise_v1 { */ dpcPackageName?: string; /** - * Identifies the extent to which the device is controlled by an Android EMM - * in various deployment configurations. Possible values include: - - * "managedDevice", a device where the DPC is set as device owner, - * - "managedProfile", a device where the DPC is set as profile - * owner. + * Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations. Possible values include: - "managedDevice", a device where the DPC is set as device owner, - "managedProfile", a device where the DPC is set as profile owner. */ managementType?: string; /** @@ -1065,20 +861,15 @@ export namespace androidenterprise_v1 { */ export interface Schema$NewPermissionsEvent { /** - * The set of permissions that the enterprise admin has already approved for - * this application. Use Permissions.Get on the EMM API to retrieve details - * about these permissions. + * The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions. */ approvedPermissions?: string[]; /** - * The id of the product (e.g. "app:com.google.android.gm") for - * which new permissions were added. This field will always be present. + * The id of the product (e.g. "app:com.google.android.gm") for which new permissions were added. This field will always be present. */ productId?: string; /** - * The set of permissions that the app is currently requesting. Use - * Permissions.Get on the EMM API to retrieve details about these - * permissions. + * The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions. */ requestedPermissions?: string[]; } @@ -1095,8 +886,7 @@ export namespace androidenterprise_v1 { */ appUpdateEvent?: Schema$AppUpdateEvent; /** - * The ID of the enterprise for which the notification is sent. This will - * always be present. + * The ID of the enterprise for which the notification is sent. This will always be present. */ enterpriseId?: string; /** @@ -1124,20 +914,16 @@ export namespace androidenterprise_v1 { */ productAvailabilityChangeEvent?: Schema$ProductAvailabilityChangeEvent; /** - * The time when the notification was published in milliseconds since - * 1970-01-01T00:00:00Z. This will always be present. + * The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present. */ timestampMillis?: string; } /** - * A resource returned by the PullNotificationSet API, which contains a - * collection of notifications for enterprises associated with the service - * account authenticated for the request. + * A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request. */ export interface Schema$NotificationSet { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#notificationSet". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#notificationSet". */ kind?: string; /** @@ -1145,9 +931,7 @@ export namespace androidenterprise_v1 { */ notification?: Schema$Notification[]; /** - * The notification set ID, required to mark the notification as received - * with the Enterprises.AcknowledgeNotification API. This will be omitted if - * no notifications are present. + * The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present. */ notificationSetId?: string; } @@ -1157,23 +941,15 @@ export namespace androidenterprise_v1 { totalResults?: number; } /** - * A Permissions resource represents some extra capability, to be granted to - * an Android app, which requires explicit consent. An enterprise admin must - * consent to these permissions on behalf of their users before an entitlement - * for the app can be created. The permissions collection is read-only. The - * information provided for each permission (localized name and description) - * is intended to be used in the MDM user interface when obtaining consent - * from the enterprise. + * A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise. */ export interface Schema$Permission { /** - * A longer description of the Permissions resource, giving more details of - * what it affects. + * A longer description of the Permissions resource, giving more details of what it affects. */ description?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#permission". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission". */ kind?: string; /** @@ -1190,28 +966,15 @@ export namespace androidenterprise_v1 { */ export interface Schema$Policy { /** - * The auto-update policy for apps installed on the device. - * "choiceToTheUser" allows the device's user to configure the - * app update policy. "always" enables auto updates. - * "never" disables auto updates. "wifiOnly" enables - * auto updates only when the device is connected to wifi. + * The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi. */ autoUpdatePolicy?: string; /** - * The maintenance window defining when apps running in the foreground - * should be updated. + * The maintenance window defining when apps running in the foreground should be updated. */ maintenanceWindow?: Schema$MaintenanceWindow; /** - * The availability granted to the device for the specified products. - * "all" gives the device access to all products, regardless of - * approval status. "all" does not enable automatic visibility of - * "alpha" or "beta" tracks. "whitelist" - * grants the device access the products specified in productPolicy[]. Only - * products that are approved or products that were previously approved - * (products with revoked approval) by the enterprise can be whitelisted. If - * no value is provided, the availability set at the user level is applied - * by default. + * The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default. */ productAvailabilityPolicy?: string; /** @@ -1220,13 +983,7 @@ export namespace androidenterprise_v1 { productPolicy?: Schema$ProductPolicy[]; } /** - * A Products resource represents an app in the Google Play store that is - * available to at least some users in the enterprise. (Some apps are - * restricted to a single enterprise, and no information about them is made - * available outside that enterprise.) The information provided for each - * product (localized name, icon, link to the full Google Play details page) - * is intended to allow a basic representation of the product within an EMM - * user interface. + * A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface. */ export interface Schema$Product { /** @@ -1266,28 +1023,19 @@ export namespace androidenterprise_v1 { */ detailsUrl?: string; /** - * How and to whom the package is made available. The value - * publicGoogleHosted means that the package is available through the Play - * store and not restricted to a specific enterprise. The value - * privateGoogleHosted means that the package is a private app (restricted - * to an enterprise) but hosted by Google. The value privateSelfHosted means - * that the package is a private app (restricted to an enterprise) and is - * privately hosted. + * How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted. */ distributionChannel?: string; /** - * A link to an image that can be used as an icon for the product. This - * image is suitable for use at up to 512px x 512px. + * A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px. */ iconUrl?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#product". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product". */ kind?: string; /** - * The approximate time (within 7 days) the app was last published, - * expressed in milliseconds since epoch. + * The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch. */ lastUpdatedTimestampMillis?: string; /** @@ -1299,14 +1047,11 @@ export namespace androidenterprise_v1 { */ permissions?: Schema$ProductPermission[]; /** - * A string of the form app:<package name>. For example, - * app:com.google.android.gm represents the Gmail app. + * A string of the form app:<package name>. For example, app:com.google.android.gm represents the Gmail app. */ productId?: string; /** - * Whether this product is free, free with in-app purchases, or paid. If the - * pricing is unknown, this means the product is not generally available - * anymore (even though it might still be available to people who own it). + * Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it). */ productPricing?: string; /** @@ -1326,8 +1071,7 @@ export namespace androidenterprise_v1 { */ signingCertificate?: Schema$ProductSigningCertificate; /** - * A link to a smaller image that can be used as an icon for the product. - * This image is suitable for use at up to 128px x 128px. + * A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px. */ smallIconUrl?: string; /** @@ -1335,8 +1079,7 @@ export namespace androidenterprise_v1 { */ title?: string; /** - * A link to the managed Google Play details page for the product, for use - * by an Enterprise admin. + * A link to the managed Google Play details page for the product, for use by an Enterprise admin. */ workDetailsUrl?: string; } @@ -1345,13 +1088,11 @@ export namespace androidenterprise_v1 { */ export interface Schema$ProductApprovalEvent { /** - * Whether the product was approved or unapproved. This field will always be - * present. + * Whether the product was approved or unapproved. This field will always be present. */ approved?: string; /** - * The id of the product (e.g. "app:com.google.android.gm") for - * which the approval status has changed. This field will always be present. + * The id of the product (e.g. "app:com.google.android.gm") for which the approval status has changed. This field will always be present. */ productId?: string; } @@ -1364,17 +1105,12 @@ export namespace androidenterprise_v1 { */ availabilityStatus?: string; /** - * The id of the product (e.g. "app:com.google.android.gm") for - * which the product availability changed. This field will always be - * present. + * The id of the product (e.g. "app:com.google.android.gm") for which the product availability changed. This field will always be present. */ productId?: string; } /** - * A product permissions resource represents the set of permissions required - * by a specific app and whether or not they have been accepted by an - * enterprise admin. The API can be used to read the set of permissions, and - * also to update the set to indicate that permissions have been accepted. + * A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted. */ export interface Schema$ProductPermission { /** @@ -1387,13 +1123,11 @@ export namespace androidenterprise_v1 { state?: string; } /** - * Information about the permissions required by a specific app and whether - * they have been accepted by the enterprise. + * Information about the permissions required by a specific app and whether they have been accepted by the enterprise. */ export interface Schema$ProductPermissions { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#productPermissions". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions". */ kind?: string; /** @@ -1401,8 +1135,7 @@ export namespace androidenterprise_v1 { */ permission?: Schema$ProductPermission[]; /** - * The ID of the app that the permissions relate to, e.g. - * "app:com.google.android.gm". + * The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm". */ productId?: string; } @@ -1419,14 +1152,11 @@ export namespace androidenterprise_v1 { */ managedConfiguration?: Schema$ManagedConfiguration; /** - * The ID of the product. For example, - * "app:com.google.android.gm". + * The ID of the product. For example, "app:com.google.android.gm". */ productId?: string; /** - * Grants the device visibility to the specified product release track(s), - * identified by trackIds. The list of release tracks of a product can be - * obtained by calling Products.Get. + * Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get. */ trackIds?: string[]; /** @@ -1436,21 +1166,11 @@ export namespace androidenterprise_v1 { } export interface Schema$ProductsApproveRequest { /** - * The approval URL that was shown to the user. Only the permissions shown - * to the user with that URL will be accepted, which may not be the - * product's entire set of permissions. For example, the URL may only - * display new permissions from an update after the product was approved, or - * not include new permissions if the product was updated since the URL was - * generated. + * The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated. */ approvalUrlInfo?: Schema$ApprovalUrlInfo; /** - * Sets how new permission requests for the product are handled. - * "allPermissions" automatically approves all current and future - * permissions for the product. "currentPermissionsOnly" approves - * the current set of permissions for the product, but any future - * permissions added through updates will require manual reapproval. If not - * specified, only the current set of permissions will be approved. + * Sets how new permission requests for the product are handled. "allPermissions" automatically approves all current and future permissions for the product. "currentPermissionsOnly" approves the current set of permissions for the product, but any future permissions added through updates will require manual reapproval. If not specified, only the current set of permissions will be approved. */ approvedPermissions?: string; } @@ -1459,8 +1179,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$ProductSet { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#productSet". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet". */ kind?: string; /** @@ -1468,50 +1187,23 @@ export namespace androidenterprise_v1 { */ productId?: string[]; /** - * The interpretation of this product set. "unknown" should never - * be sent and is ignored if received. "whitelist" means that the - * user is entitled to access the product set. "includeAll" means - * that all products are accessible, including products that are approved, - * products with revoked approval, and products that have never been - * approved. "allApproved" means that the user is entitled to - * access all products that are approved for the enterprise. If the value is - * "allApproved" or "includeAll", the productId field is - * ignored. If no value is provided, it is interpreted as - * "whitelist" for backwards compatibility. Further - * "allApproved" or "includeAll" does not enable - * automatic visibility of "alpha" or "beta" tracks for - * Android app. Use ProductVisibility to enable "alpha" or - * "beta" tracks per user. + * The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user. */ productSetBehavior?: string; /** - * Additional list of product IDs making up the product set. Unlike the - * productID array, in this list It's possible to specify which tracks - * (alpha, beta, production) of a product are visible to the user. See - * ProductVisibility and its fields for more information. Specifying the - * same product ID both here and in the productId array is not allowed and - * it will result in an error. + * Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error. */ productVisibility?: Schema$ProductVisibility[]; } export interface Schema$ProductsGenerateApprovalUrlResponse { /** - * A URL that can be rendered in an iframe to display the permissions (if - * any) of a product. This URL can be used to approve the product only once - * and only within 24 hours of being generated, using the Products.approve - * call. If the product is currently unapproved and has no permissions, this - * URL will point to an empty page. If the product is currently approved, a - * URL will only be generated if that product has added permissions since it - * was last approved, and the URL will only display those new permissions - * that have not yet been accepted. + * A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted. */ url?: string; } export interface Schema$ProductSigningCertificate { /** - * The base64 urlsafe encoded SHA1 hash of the certificate. (This field is - * deprecated in favor of SHA2-256. It should not be used and may be removed - * at any time.) + * The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.) */ certificateHashSha1?: string; /** @@ -1524,8 +1216,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$ProductsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#productsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse". */ kind?: string; /** @@ -1533,8 +1224,7 @@ export namespace androidenterprise_v1 { */ pageInfo?: Schema$PageInfo; /** - * Information about a product (e.g. an app) in the Google Play store, for - * display to an enterprise admin. + * Information about a product (e.g. an app) in the Google Play store, for display to an enterprise admin. */ product?: Schema$Product[]; /** @@ -1547,13 +1237,11 @@ export namespace androidenterprise_v1 { */ export interface Schema$ProductVisibility { /** - * The product ID to make visible to the user. Required for each item in the - * productVisibility list. + * The product ID to make visible to the user. Required for each item in the productVisibility list. */ productId?: string; /** - * Grants the user visibility to the specified product track(s), identified - * by trackIds. + * Grants the user visibility to the specified product track(s), identified by trackIds. */ trackIds?: string[]; /** @@ -1562,8 +1250,7 @@ export namespace androidenterprise_v1 { tracks?: string[]; } /** - * A service account identity, including the name and credentials that can be - * used to authenticate as the service account. + * A service account identity, including the name and credentials that can be used to authenticate as the service account. */ export interface Schema$ServiceAccount { /** @@ -1571,13 +1258,11 @@ export namespace androidenterprise_v1 { */ key?: Schema$ServiceAccountKey; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#serviceAccount". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccount". */ kind?: string; /** - * The account name of the service account, in the form of an email address. - * Assigned by the server. + * The account name of the service account, in the form of an email address. Assigned by the server. */ name?: string; } @@ -1586,26 +1271,19 @@ export namespace androidenterprise_v1 { */ export interface Schema$ServiceAccountKey { /** - * The body of the private key credentials file, in string format. This is - * only populated when the ServiceAccountKey is created, and is not stored - * by Google. + * The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. */ data?: string; /** - * An opaque, unique identifier for this ServiceAccountKey. Assigned by the - * server. + * An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#serviceAccountKey". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey". */ kind?: string; /** - * Public key data for the credentials file. This is an X.509 cert. If you - * are using the googleCredentials key type, this is identical to the cert - * that can be retrieved by using the X.509 cert url inside of the - * credentials file. + * Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file. */ publicData?: string; /** @@ -1620,84 +1298,61 @@ export namespace androidenterprise_v1 { serviceAccountKey?: Schema$ServiceAccountKey[]; } /** - * A resource returned by the GenerateSignupUrl API, which contains the Signup - * URL and Completion Token. + * A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token. */ export interface Schema$SignupInfo { /** - * An opaque token that will be required, along with the Enterprise Token, - * for obtaining the enterprise resource from CompleteSignup. + * An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup. */ completionToken?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#signupInfo". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#signupInfo". */ kind?: string; /** - * A URL under which the Admin can sign up for an enterprise. The page - * pointed to cannot be rendered in an iframe. + * A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe. */ url?: string; } /** - * Definition of a managed Google Play store cluster, a list of products - * displayed as part of a store page. + * Definition of a managed Google Play store cluster, a list of products displayed as part of a store page. */ export interface Schema$StoreCluster { /** - * Unique ID of this cluster. Assigned by the server. Immutable once - * assigned. + * Unique ID of this cluster. Assigned by the server. Immutable once assigned. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#storeCluster". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". */ kind?: string; /** - * Ordered list of localized strings giving the name of this page. The text - * displayed is the one that best matches the user locale, or the first - * entry if there is no good match. There needs to be at least one entry. + * Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry. */ name?: Schema$LocalizedText[]; /** - * String (US-ASCII only) used to determine order of this cluster within the - * parent page's elements. Page elements are sorted in lexicographic - * order of this field. Duplicated values are allowed, but ordering between - * elements with duplicate order is undefined. The value of this field is - * never visible to a user, it is used solely for the purpose of defining an - * ordering. Maximum length is 256 characters. + * String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. */ orderInPage?: string; /** - * List of products in the order they are displayed in the cluster. There - * should not be duplicates within a cluster. + * List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. */ productId?: string[]; } /** - * General setting for the managed Google Play store layout, currently only - * specifying the page to display the first time the store is opened. + * General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened. */ export interface Schema$StoreLayout { /** - * The ID of the store page to be used as the homepage. The homepage is the - * first page shown in the managed Google Play Store. Not specifying a - * homepage is equivalent to setting the store layout type to - * "basic". + * The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to "basic". */ homepageId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#storeLayout". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout". */ kind?: string; /** - * The store layout type. By default, this value is set to "basic" - * if the homepageId field is not set, and to "custom" otherwise. - * If set to "basic", the layout will consist of all approved apps - * that have been whitelisted for the user. + * The store layout type. By default, this value is set to "basic" if the homepageId field is not set, and to "custom" otherwise. If set to "basic", the layout will consist of all approved apps that have been whitelisted for the user. */ storeLayoutType?: string; } @@ -1710,8 +1365,7 @@ export namespace androidenterprise_v1 { */ cluster?: Schema$StoreCluster[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#storeLayoutClustersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse". */ kind?: string; } @@ -1720,8 +1374,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$StoreLayoutPagesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#storeLayoutPagesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutPagesListResponse". */ kind?: string; /** @@ -1730,9 +1383,7 @@ export namespace androidenterprise_v1 { page?: Schema$StorePage[]; } /** - * Definition of a managed Google Play store page, made of a localized name - * and links to other pages. A page also contains clusters defined as a - * subcollection. + * Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection. */ export interface Schema$StorePage { /** @@ -1740,21 +1391,15 @@ export namespace androidenterprise_v1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#storePage". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage". */ kind?: string; /** - * Ordered list of pages a user should be able to reach from this page. The - * list can't include this page. It is recommended that the basic pages - * are created first, before adding the links between pages. The API - * doesn't verify that the pages exist or the pages are reachable. + * Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages. The API doesn't verify that the pages exist or the pages are reachable. */ link?: string[]; /** - * Ordered list of localized strings giving the name of this page. The text - * displayed is the one that best matches the user locale, or the first - * entry if there is no good match. There needs to be at least one entry. + * Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry. */ name?: Schema$LocalizedText[]; } @@ -1767,50 +1412,28 @@ export namespace androidenterprise_v1 { */ export interface Schema$TrackInfo { /** - * A modifiable name for a track. This is the visible name in the play - * developer console. + * A modifiable name for a track. This is the visible name in the play developer console. */ trackAlias?: string; /** - * Unmodifiable, unique track identifier. This identifier is the - * releaseTrackId in the url of the play developer console page that - * displays the track information. + * Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the track information. */ trackId?: string; } /** - * A Users resource represents an account associated with an enterprise. The - * account may be specific to a device or to an individual user (who can then - * use the account across multiple devices). The account may provide access to - * managed Google Play only, or to other Google services, depending on the - * identity model: - The Google managed domain identity model requires - * synchronization to Google account sources (via primaryEmail). - The - * managed Google Play Accounts identity model provides a dynamic means for - * enterprises to create user or device accounts as needed. These accounts - * provide access to managed Google Play. + * A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play. */ export interface Schema$User { /** - * A unique identifier you create for this user, such as "user342" - * or "asset#44418". Do not use personally identifiable - * information (PII) for this property. Must always be set for EMM-managed - * users. Not set for Google-managed users. + * A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. */ accountIdentifier?: string; /** - * The type of account that this user represents. A userAccount can be - * installed on multiple devices, but a deviceAccount is specific to a - * single device. An EMM-managed user (emmManaged) can be either type - * (userAccount, deviceAccount), but a Google-managed user (googleManaged) - * is always a userAccount. + * The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. */ accountType?: string; /** - * The name that will appear in user interfaces. Setting this property is - * optional when creating EMM-managed users. If you do set this property, - * use something generic about the organization (such as "Example, - * Inc.") or your name (as EMM). Not used for Google-managed user - * accounts. + * The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. */ displayName?: string; /** @@ -1818,20 +1441,15 @@ export namespace androidenterprise_v1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#user". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". */ kind?: string; /** - * The entity that manages the user. With googleManaged users, the source of - * truth is Google so EMMs have to make sure a Google Account exists for the - * user. With emmManaged users, the EMM is in charge. + * The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. */ managementType?: string; /** - * The user's primary email address, for example, - * "jsmith@example.com". Will always be set for Google managed - * users and not set for EMM managed users. + * The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. */ primaryEmail?: string; } @@ -1840,8 +1458,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$UsersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#usersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse". */ kind?: string; /** @@ -1850,20 +1467,15 @@ export namespace androidenterprise_v1 { user?: Schema$User[]; } /** - * A UserToken is used by a user when setting up a managed device or profile - * with their managed Google Play account on a device. When the user enters - * their email address and token (activation code) the appropriate EMM app can - * be automatically downloaded. + * A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded. */ export interface Schema$UserToken { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#userToken". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken". */ kind?: string; /** - * The token (activation code) to be entered by the user. This consists of a - * sequence of decimal digits. Note that the leading digit may be 0. + * The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0. */ token?: string; /** @@ -1872,15 +1484,11 @@ export namespace androidenterprise_v1 { userId?: string; } /** - * A variable set is a key-value pair of EMM-provided placeholders and its - * corresponding value, which is attributed to a user. For example, $FIRSTNAME - * could be a placeholder, and its value could be Alice. Placeholders should - * start with a '$' sign and should be alphanumeric only. + * A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only. */ export interface Schema$VariableSet { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#variableSet". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet". */ kind?: string; /** @@ -1893,26 +1501,15 @@ export namespace androidenterprise_v1 { userValue?: string; } /** - * A WebApps resource represents a web app created for an enterprise. Web apps - * are published to managed Google Play and can be distributed like other - * Android apps. On a user's device, a web app opens its specified URL. + * A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL. */ export interface Schema$WebApp { /** - * The display mode of the web app. Possible values include: - - * "minimalUi", the device's status bar, navigation bar, the - * app's URL, and a refresh button are visible when the app is open. For - * HTTP URLs, you can only select this option. - "standalone", the - * device's status bar and navigation bar are visible when the app is - * open. - "fullScreen", the app opens in full screen mode, hiding - * the device's status and navigation bars. All browser UI elements, - * page URL, system status bar and back button are not visible, and the web - * app takes up the entirety of the available display area. + * The display mode of the web app. Possible values include: - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - "standalone", the device's status bar and navigation bar are visible when the app is open. - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area. */ displayMode?: string; /** - * A list of icons representing this website. If absent, a default icon (for - * create) or the current icon (for update) will be used. + * A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used. */ icons?: Schema$WebAppIcon[]; /** @@ -1920,25 +1517,19 @@ export namespace androidenterprise_v1 { */ isPublished?: boolean; /** - * The start URL, i.e. the URL that should load when the user opens the - * application. + * The start URL, i.e. the URL that should load when the user opens the application. */ startUrl?: string; /** - * The title of the web app as displayed to the user (e.g., amongst a list - * of other applications, or as a label for an icon). + * The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon). */ title?: string; /** - * The current version of the app. Note that the version can automatically - * increase during the lifetime of the web app, while Google does internal - * housekeeping to keep the web app up-to-date. + * The current version of the app. Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date. */ versionCode?: string; /** - * The ID of the application. A string of the form "app:<package - * name>" where the package name always starts with the prefix - * "com.google.enterprise.webapp." followed by a random id. + * The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id. */ webAppId?: string; } @@ -1947,10 +1538,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$WebAppIcon { /** - * The actual bytes of the image in a base64url encoded string (c.f. - * RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe - * Alphabet"). - The image type can be png or jpg. - The image should - * ideally be square. - The image should ideally have a size of 512x512. + * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512. */ imageData?: string; } @@ -1959,8 +1547,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$WebAppsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidenterprise#webAppsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#webAppsListResponse". */ kind?: string; /** @@ -2050,11 +1637,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.devices.getState - * @desc Retrieves whether a device's access to Google services is enabled - * or disabled. The device state takes effect only if enforcing EMM policies - * on Android devices is enabled in the Google Admin Console. Otherwise, the - * device state is ignored and all devices are allowed access to Google - * services. This is only supported for Google-managed users. + * @desc Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users. * @alias androidenterprise.devices.getState * @memberOf! () * @@ -2278,11 +1861,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.devices.setState - * @desc Sets whether a device's access to Google services is enabled or - * disabled. The device state takes effect only if enforcing EMM policies on - * Android devices is enabled in the Google Admin Console. Otherwise, the - * device state is ignored and all devices are allowed access to Google - * services. This is only supported for Google-managed users. + * @desc Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users. * @alias androidenterprise.devices.setState * @memberOf! () * @@ -2500,9 +2079,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * Mask that identifies which fields to update. If not set, all modifiable - * fields will be modified. When set in a query parameter, this field - * should be specified as updateMask=,,... + * Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,... */ updateMask?: string; /** @@ -2554,9 +2131,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * Mask that identifies which fields to update. If not set, all modifiable - * fields will be modified. When set in a query parameter, this field - * should be specified as updateMask=,,... + * Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,... */ updateMask?: string; /** @@ -2578,9 +2153,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.acknowledgeNotificationSet - * @desc Acknowledges notifications that were received from - * Enterprises.PullNotificationSet to prevent subsequent calls from - * returning the same notifications. + * @desc Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications. * @alias androidenterprise.enterprises.acknowledgeNotificationSet * @memberOf! () * @@ -2652,9 +2225,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.completeSignup - * @desc Completes the signup flow, by specifying the Completion token and - * Enterprise token. This request must not be called multiple times for a - * given Enterprise Token. + * @desc Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token. * @alias androidenterprise.enterprises.completeSignup * @memberOf! () * @@ -2728,10 +2299,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.createWebToken - * @desc Returns a unique token to access an embeddable UI. To generate a - * web UI, pass the generated token into the managed Google Play javascript - * API. Each token may only be used to start one UI session. See the - * javascript API documentation for further information. + * @desc Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information. * @alias androidenterprise.enterprises.createWebToken * @memberOf! () * @@ -3030,17 +2598,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.getServiceAccount - * @desc Returns a service account and credentials. The service account can - * be bound to the enterprise by calling setAccount. The service account is - * unique to this enterprise and EMM, and will be deleted if the enterprise - * is unbound. The credentials contain private key data and are not stored - * server-side. This method can only be called after calling - * Enterprises.Enroll or Enterprises.CompleteSignup, and before - * Enterprises.SetAccount; at other times it will return an error. - * Subsequent calls after the first will generate a new, unique set of - * credentials, and invalidate the previously generated credentials. Once - * the service account is bound to the enterprise, it can be managed using - * the serviceAccountKeys resource. + * @desc Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource. * @alias androidenterprise.enterprises.getServiceAccount * @memberOf! () * @@ -3117,9 +2675,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.getStoreLayout - * @desc Returns the store layout for the enterprise. If the store layout - * has not been set, returns "basic" as the store layout type and no - * homepage. + * @desc Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage. * @alias androidenterprise.enterprises.getStoreLayout * @memberOf! () * @@ -3193,11 +2749,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.list - * @desc Looks up an enterprise by domain name. This is only supported for - * enterprises created via the Google-initiated creation flow. Lookup of the - * id is not needed for enterprises created via the EMM-initiated flow since - * the EMM learns the enterprise ID in the callback specified in the - * Enterprises.generateSignupUrl call. + * @desc Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call. * @alias androidenterprise.enterprises.list * @memberOf! () * @@ -3272,20 +2824,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.pullNotificationSet - * @desc Pulls and returns a notification set for the enterprises associated - * with the service account authenticated for the request. The notification - * set may be empty if no notification are pending. A notification set - * returned needs to be acknowledged within 20 seconds by calling - * Enterprises.AcknowledgeNotificationSet, unless the notification set is - * empty. Notifications that are not acknowledged within the 20 seconds will - * eventually be included again in the response to another - * PullNotificationSet request, and those that are never acknowledged will - * ultimately be deleted according to the Google Cloud Platform Pub/Sub - * system policy. Multiple requests might be performed concurrently to - * retrieve notifications, in which case the pending notifications (if any) - * will be split among each caller, if any are pending. If no notifications - * are present, an empty notification list is returned. Subsequent requests - * may return more notifications once they become available. + * @desc Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available. * @alias androidenterprise.enterprises.pullNotificationSet * @memberOf! () * @@ -3360,8 +2899,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.sendTestPushNotification - * @desc Sends a test notification to validate the EMM integration with the - * Google Cloud Pub/Sub service for this enterprise. + * @desc Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise. * @alias androidenterprise.enterprises.sendTestPushNotification * @memberOf! () * @@ -3460,8 +2998,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.setAccount - * @desc Sets the account that will be used to authenticate to the API as - * the enterprise. + * @desc Sets the account that will be used to authenticate to the API as the enterprise. * @alias androidenterprise.enterprises.setAccount * @memberOf! () * @@ -3536,14 +3073,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.enterprises.setStoreLayout - * @desc Sets the store layout for the enterprise. By default, - * storeLayoutType is set to "basic" and the basic store layout is enabled. - * The basic layout only contains apps approved by the admin, and that have - * been added to the available product set for a user (using the - * setAvailableProductSet call). Apps on the page are sorted in order of - * their product ID value. If you create a custom store layout (by setting - * storeLayoutType = "custom" and setting a homepage), the basic store - * layout is disabled. + * @desc Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled. * @alias androidenterprise.enterprises.setStoreLayout * @memberOf! () * @@ -3697,8 +3227,7 @@ export namespace androidenterprise_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The notification set ID as returned by Enterprises.PullNotificationSet. - * This must be provided. + * The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided. */ notificationSetId?: string; } @@ -3760,13 +3289,7 @@ export namespace androidenterprise_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The callback URL to which the Admin will be redirected after successfully - * creating an enterprise. Before redirecting there the system will add a - * single query parameter to this URL named "enterpriseToken" which will - * contain an opaque token to be used for the CompleteSignup request. Beware - * that this means that the URL will be parsed, the parameter added and then - * a new URL formatted, i.e. there may be some minor formatting changes and, - * more importantly, the URL must be well-formed so that it can be parsed. + * The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed. */ callbackUrl?: string; } @@ -3828,13 +3351,7 @@ export namespace androidenterprise_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The request mode for pulling notifications. Specifying - * waitForNotifications will cause the request to block and wait until one - * or more notifications are present, or return an empty notification list - * if no notifications are present after some time. Speciying - * returnImmediately will cause the request to immediately return the - * pending notifications, or an empty list if no notifications are present. - * If omitted, defaults to waitForNotifications. + * The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications. */ requestMode?: string; } @@ -4131,8 +3648,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.entitlements.patch - * @desc Adds or updates an entitlement to an app for a user. This method - * supports patch semantics. + * @desc Adds or updates an entitlement to an app for a user. This method supports patch semantics. * @alias androidenterprise.entitlements.patch * @memberOf! () * @@ -4299,8 +3815,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the entitlement (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". */ entitlementId?: string; /** @@ -4319,8 +3834,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the entitlement (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". */ entitlementId?: string; /** @@ -4356,15 +3870,11 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the entitlement (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". */ entitlementId?: string; /** - * Set to true to also install the product on all the user's devices where - * possible. Failure to install on one or more devices will not prevent this - * operation from returning successfully, as long as the entitlement was - * successfully assigned to the user. + * Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. */ install?: boolean; /** @@ -4389,15 +3899,11 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the entitlement (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". */ entitlementId?: string; /** - * Set to true to also install the product on all the user's devices where - * possible. Failure to install on one or more devices will not prevent this - * operation from returning successfully, as long as the entitlement was - * successfully assigned to the user. + * Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. */ install?: boolean; /** @@ -4494,8 +4000,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.grouplicenses.list - * @desc Retrieves IDs of all products for which the enterprise has a group - * license. + * @desc Retrieves IDs of all products for which the enterprise has a group license. * @alias androidenterprise.grouplicenses.list * @memberOf! () * @@ -4587,8 +4092,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the product the group license is for, e.g. - * "app:com.google.android.gm". + * The ID of the product the group license is for, e.g. "app:com.google.android.gm". */ groupLicenseId?: string; } @@ -4613,8 +4117,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.grouplicenseusers.list - * @desc Retrieves the IDs of the users who have been granted entitlements - * under the license. + * @desc Retrieves the IDs of the users who have been granted entitlements under the license. * @alias androidenterprise.grouplicenseusers.list * @memberOf! () * @@ -4709,8 +4212,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the product the group license is for, e.g. - * "app:com.google.android.gm". + * The ID of the product the group license is for, e.g. "app:com.google.android.gm". */ groupLicenseId?: string; } @@ -4723,9 +4225,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.installs.delete - * @desc Requests to remove an app from a device. A call to get or list will - * still show the app as installed on the device until it is actually - * removed. + * @desc Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed. * @alias androidenterprise.installs.delete * @memberOf! () * @@ -4873,8 +4373,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.installs.list - * @desc Retrieves the details of all apps installed on the specified - * device. + * @desc Retrieves the details of all apps installed on the specified device. * @alias androidenterprise.installs.list * @memberOf! () * @@ -4951,9 +4450,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.installs.patch - * @desc Requests to install the latest version of an app to a device. If - * the app is already installed, then it is updated to the latest version if - * necessary. This method supports patch semantics. + * @desc Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. This method supports patch semantics. * @alias androidenterprise.installs.patch * @memberOf! () * @@ -5028,9 +4525,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.installs.update - * @desc Requests to install the latest version of an app to a device. If - * the app is already installed, then it is updated to the latest version if - * necessary. + * @desc Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. * @alias androidenterprise.installs.update * @memberOf! () * @@ -5119,8 +4614,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the product represented by the install, e.g. - * "app:com.google.android.gm". + * The ID of the product represented by the install, e.g. "app:com.google.android.gm". */ installId?: string; /** @@ -5143,8 +4637,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the product represented by the install, e.g. - * "app:com.google.android.gm". + * The ID of the product represented by the install, e.g. "app:com.google.android.gm". */ installId?: string; /** @@ -5186,8 +4679,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the product represented by the install, e.g. - * "app:com.google.android.gm". + * The ID of the product represented by the install, e.g. "app:com.google.android.gm". */ installId?: string; /** @@ -5215,8 +4707,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the product represented by the install, e.g. - * "app:com.google.android.gm". + * The ID of the product represented by the install, e.g. "app:com.google.android.gm". */ installId?: string; /** @@ -5238,8 +4729,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsfordevice.delete - * @desc Removes a per-device managed configuration for an app for the - * specified device. + * @desc Removes a per-device managed configuration for an app for the specified device. * @alias androidenterprise.managedconfigurationsfordevice.delete * @memberOf! () * @@ -5413,8 +4903,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsfordevice.list - * @desc Lists all the per-device managed configurations for the specified - * device. Only the ID is set. + * @desc Lists all the per-device managed configurations for the specified device. Only the ID is set. * @alias androidenterprise.managedconfigurationsfordevice.list * @memberOf! () * @@ -5513,8 +5002,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsfordevice.patch - * @desc Adds or updates a per-device managed configuration for an app for - * the specified device. This method supports patch semantics. + * @desc Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics. * @alias androidenterprise.managedconfigurationsfordevice.patch * @memberOf! () * @@ -5604,8 +5092,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsfordevice.update - * @desc Adds or updates a per-device managed configuration for an app for - * the specified device. + * @desc Adds or updates a per-device managed configuration for an app for the specified device. * @alias androidenterprise.managedconfigurationsfordevice.update * @memberOf! () * @@ -5710,8 +5197,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForDeviceId?: string; /** @@ -5735,8 +5221,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForDeviceId?: string; /** @@ -5780,8 +5265,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForDeviceId?: string; /** @@ -5810,8 +5294,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForDeviceId?: string; /** @@ -5833,8 +5316,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsforuser.delete - * @desc Removes a per-user managed configuration for an app for the - * specified user. + * @desc Removes a per-user managed configuration for an app for the specified user. * @alias androidenterprise.managedconfigurationsforuser.delete * @memberOf! () * @@ -5912,8 +5394,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsforuser.get - * @desc Retrieves details of a per-user managed configuration for an app - * for the specified user. + * @desc Retrieves details of a per-user managed configuration for an app for the specified user. * @alias androidenterprise.managedconfigurationsforuser.get * @memberOf! () * @@ -5995,8 +5476,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsforuser.list - * @desc Lists all the per-user managed configurations for the specified - * user. Only the ID is set. + * @desc Lists all the per-user managed configurations for the specified user. Only the ID is set. * @alias androidenterprise.managedconfigurationsforuser.list * @memberOf! () * @@ -6088,12 +5568,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsforuser.patch - * @desc Adds or updates the managed configuration settings for an app for - * the specified user. If you support the Managed configurations iframe, you - * can apply managed configurations to a user by specifying an mcmId and its - * associated configuration variables (if any) in the request. - * Alternatively, all EMMs can apply managed configurations by passing a - * list of managed properties. This method supports patch semantics. + * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. This method supports patch semantics. * @alias androidenterprise.managedconfigurationsforuser.patch * @memberOf! () * @@ -6176,12 +5651,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationsforuser.update - * @desc Adds or updates the managed configuration settings for an app for - * the specified user. If you support the Managed configurations iframe, you - * can apply managed configurations to a user by specifying an mcmId and its - * associated configuration variables (if any) in the request. - * Alternatively, all EMMs can apply managed configurations by passing a - * list of managed properties. + * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. * @alias androidenterprise.managedconfigurationsforuser.update * @memberOf! () * @@ -6275,8 +5745,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForUserId?: string; /** @@ -6296,8 +5765,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForUserId?: string; /** @@ -6333,8 +5801,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForUserId?: string; /** @@ -6359,8 +5826,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the managed configuration (a product ID), e.g. - * "app:com.google.android.gm". + * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". */ managedConfigurationForUserId?: string; /** @@ -6382,8 +5848,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.managedconfigurationssettings.list - * @desc Lists all the managed configurations settings for the specified - * app. Only the ID and the name is set. + * @desc Lists all the managed configurations settings for the specified app. Only the ID and the name is set. * @alias androidenterprise.managedconfigurationssettings.list * @memberOf! () * @@ -6492,8 +5957,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The ID of the product for which the managed configurations settings - * applies to. + * The ID of the product for which the managed configurations settings applies to. */ productId?: string; } @@ -6506,8 +5970,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.permissions.get - * @desc Retrieves details of an Android app permission for display to an - * enterprise admin. + * @desc Retrieves details of an Android app permission for display to an enterprise admin. * @alias androidenterprise.permissions.get * @memberOf! () * @@ -6603,11 +6066,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.products.approve - * @desc Approves the specified product and the relevant app permissions, if - * any. The maximum number of products that you can approve per enterprise - * customer is 1,000. To learn how to use managed Google Play to design and - * create a store layout to display approved products to your users, see - * Store Layout Design. + * @desc Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. * @alias androidenterprise.products.approve * @memberOf! () * @@ -6680,14 +6139,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.products.generateApprovalUrl - * @desc Generates a URL that can be rendered in an iframe to display the - * permissions (if any) of a product. An enterprise admin must view these - * permissions and accept them on behalf of their organization in order to - * approve that product. Admins should accept the displayed permissions by - * interacting with a separate UI element in the EMM console, which in turn - * should trigger the use of this URL as the approvalUrlInfo.approvalUrl - * property in a Products.approve call to approve the product. This URL can - * only be used to display permissions for up to 1 day. + * @desc Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day. * @alias androidenterprise.products.generateApprovalUrl * @memberOf! () * @@ -6847,12 +6299,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.products.getAppRestrictionsSchema - * @desc Retrieves the schema that defines the configurable properties for - * this product. All products have a schema, but this schema may be empty if - * no managed configurations have been defined. This schema can be used to - * populate a UI that allows an admin to configure the product. To apply a - * managed configuration based on the schema obtained using this API, see - * Managed Configurations through Play. + * @desc Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play. * @alias androidenterprise.products.getAppRestrictionsSchema * @memberOf! () * @@ -7009,8 +6456,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.products.list - * @desc Finds approved products that match a query, or all approved - * products if there is no query. + * @desc Finds approved products that match a query, or all approved products if there is no query. * @alias androidenterprise.products.list * @memberOf! () * @@ -7090,8 +6536,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.products.unapprove - * @desc Unapproves the specified product (and the relevant app permissions, - * if any) + * @desc Unapproves the specified product (and the relevant app permissions, if any) * @alias androidenterprise.products.unapprove * @memberOf! () * @@ -7195,8 +6640,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The BCP 47 language code used for permission names and descriptions in - * the returned iframe, for instance "en-US". + * The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US". */ languageCode?: string; /** @@ -7266,9 +6710,7 @@ export namespace androidenterprise_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies whether to search among all products (false) or among only - * products that have been approved (true). Only "true" is supported, and - * should be specified. + * Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified. */ approved?: boolean; /** @@ -7276,29 +6718,19 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; /** - * The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). - * Results are returned in the language best matching the preferred - * language. + * The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language. */ language?: string; /** - * Specifies the maximum number of products that can be returned per - * request. If not specified, uses a default value of 100, which is also the - * maximum retrievable within a single response. + * Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response. */ maxResults?: number; /** - * The search query as typed in the Google Play store search box. If - * omitted, all approved apps will be returned (using the pagination - * parameters), including apps that are not available in the store (e.g. - * unpublished apps). + * The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps). */ query?: string; /** - * A pagination token is contained in a request's response when there are - * more products. The token can be used in a subsequent request to obtain - * more products, and so forth. This parameter cannot be used in the initial - * request. + * A pagination token is contained in a request's response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request. */ token?: string; } @@ -7327,11 +6759,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.serviceaccountkeys.delete - * @desc Removes and invalidates the specified credentials for the service - * account associated with this enterprise. The calling service account must - * have been retrieved by calling Enterprises.GetServiceAccount and must - * have been set as the enterprise service account by calling - * Enterprises.SetAccount. + * @desc Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. * @alias androidenterprise.serviceaccountkeys.delete * @memberOf! () * @@ -7404,11 +6832,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.serviceaccountkeys.insert - * @desc Generates new credentials for the service account associated with - * this enterprise. The calling service account must have been retrieved by - * calling Enterprises.GetServiceAccount and must have been set as the - * enterprise service account by calling Enterprises.SetAccount. Only the - * type of the key should be populated in the resource to be inserted. + * @desc Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted. * @alias androidenterprise.serviceaccountkeys.insert * @memberOf! () * @@ -7483,11 +6907,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.serviceaccountkeys.list - * @desc Lists all active credentials for the service account associated - * with this enterprise. Only the ID and key type are returned. The calling - * service account must have been retrieved by calling - * Enterprises.GetServiceAccount and must have been set as the enterprise - * service account by calling Enterprises.SetAccount. + * @desc Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. * @alias androidenterprise.serviceaccountkeys.list * @memberOf! () * @@ -8528,8 +7948,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.storelayoutpages.patch - * @desc Updates the content of a store page. This method supports patch - * semantics. + * @desc Updates the content of a store page. This method supports patch semantics. * @alias androidenterprise.storelayoutpages.patch * @memberOf! () * @@ -8864,11 +8283,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.generateAuthenticationToken - * @desc Generates an authentication token which the device policy client - * can use to provision the given EMM-managed user account on a device. The - * generated token is single-use and expires after a few minutes. You can - * provision a maximum of 10 devices per user. This call only works with - * EMM-managed accounts. + * @desc Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts. * @alias androidenterprise.users.generateAuthenticationToken * @memberOf! () * @@ -8945,9 +8360,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.generateToken - * @desc Generates a token (activation code) to allow this user to configure - * their managed account in the Android Setup Wizard. Revokes any previously - * generated token. This call only works with Google managed accounts. + * @desc Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token. This call only works with Google managed accounts. * @alias androidenterprise.users.generateToken * @memberOf! () * @@ -9171,11 +8584,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.insert - * @desc Creates a new EMM-managed user. The Users resource passed in the - * body of the request should include an accountIdentifier and an - * accountType. If a corresponding user already exists with the same account - * identifier, the user will be updated with the resource. In this case only - * the displayName field can be changed. + * @desc Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed. * @alias androidenterprise.users.insert * @memberOf! () * @@ -9246,10 +8655,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.list - * @desc Looks up a user by primary email address. This is only supported - * for Google-managed users. Lookup of the id is not needed for EMM-managed - * users because the id is already returned in the result of the - * Users.insert call. + * @desc Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call. * @alias androidenterprise.users.list * @memberOf! () * @@ -9322,11 +8728,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.patch - * @desc Updates the details of an EMM-managed user. Can be used with - * EMM-managed users only (not Google managed users). Pass the new details - * in the Users resource in the request body. Only the displayName field can - * be changed. Other fields must either be unset or have the currently - * active value. This method supports patch semantics. + * @desc Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics. * @alias androidenterprise.users.patch * @memberOf! () * @@ -9399,9 +8801,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.revokeDeviceAccess - * @desc Revokes access to all devices currently provisioned to the user. - * The user will no longer be able to use the managed Play store on any of - * their managed devices. This call only works with EMM-managed accounts. + * @desc Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts. * @alias androidenterprise.users.revokeDeviceAccess * @memberOf! () * @@ -9474,8 +8874,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.revokeToken - * @desc Revokes a previously generated token (activation code) for the - * user. + * @desc Revokes a previously generated token (activation code) for the user. * @alias androidenterprise.users.revokeToken * @memberOf! () * @@ -9548,10 +8947,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.setAvailableProductSet - * @desc Modifies the set of products that a user is entitled to access - * (referred to as whitelisted products). Only products that are approved or - * products that were previously approved (products with revoked approval) - * can be whitelisted. + * @desc Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted. * @alias androidenterprise.users.setAvailableProductSet * @memberOf! () * @@ -9629,11 +9025,7 @@ export namespace androidenterprise_v1 { /** * androidenterprise.users.update - * @desc Updates the details of an EMM-managed user. Can be used with - * EMM-managed users only (not Google managed users). Pass the new details - * in the Users resource in the request body. Only the displayName field can - * be changed. Other fields must either be unset or have the currently - * active value. + * @desc Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. * @alias androidenterprise.users.update * @memberOf! () * diff --git a/src/apis/androidmanagement/package.json b/src/apis/androidmanagement/package.json index 8011059d951..f3446642e08 100644 --- a/src/apis/androidmanagement/package.json +++ b/src/apis/androidmanagement/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 4ea89049f48..b26f7b0eb0d 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace androidmanagement_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace androidmanagement_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace androidmanagement_v1 { /** * Android Management API * - * The Android Management API provides remote enterprise management of Android - * devices and apps. + * The Android Management API provides remote enterprise management of Android devices and apps. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace androidmanagement_v1 { signupUrls: Resource$Signupurls; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.enterprises = new Resource$Enterprises(this.context); this.signupUrls = new Resource$Signupurls(this.context); @@ -135,15 +133,11 @@ export namespace androidmanagement_v1 { packageName?: string; } /** - * A compliance rule condition which is satisfied if the Android Framework API - * level on the device doesn't meet a minimum requirement. There can only - * be one rule with this type of condition per policy. + * A compliance rule condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. There can only be one rule with this type of condition per policy. */ export interface Schema$ApiLevelCondition { /** - * The minimum desired Android Framework API level. If the device - * doesn't meet the minimum requirement, this condition is satisfied. - * Must be greater than zero. + * The minimum desired Android Framework API level. If the device doesn't meet the minimum requirement, this condition is satisfied. Must be greater than zero. */ minApiLevel?: number; } @@ -156,8 +150,7 @@ export namespace androidmanagement_v1 { */ managedProperties?: Schema$ManagedProperty[]; /** - * The name of the app in the form - * enterprises/{enterpriseId}/applications/{package_name}. + * The name of the app in the form enterprises/{enterpriseId}/applications/{package_name}. */ name?: string; /** @@ -187,8 +180,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$ApplicationPermission { /** - * A longer description of the permission, providing more detail on what it - * affects. Localized. + * A longer description of the permission, providing more detail on what it affects. Localized. */ description?: string; /** @@ -205,10 +197,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$ApplicationPolicy { /** - * The default policy for all permissions requested by the app. If - * specified, this overrides the policy-level default_permission_policy - * which applies to all apps. It does not override the permission_grants - * which applies to all apps. + * The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps. */ defaultPermissionPolicy?: string; /** @@ -216,8 +205,7 @@ export namespace androidmanagement_v1 { */ delegatedScopes?: string[]; /** - * Whether the app is disabled. When disabled, the app data is still - * preserved. + * Whether the app is disabled. When disabled, the app data is still preserved. */ disabled?: boolean; /** @@ -229,50 +217,23 @@ export namespace androidmanagement_v1 { */ lockTaskAllowed?: boolean; /** - * Managed configuration applied to the app. The format for the - * configuration is dictated by the ManagedProperty values supported by the - * app. Each field name in the managed configuration must match the key - * field of the ManagedProperty. The field value must be compatible with the - * type of the ManagedProperty: <table> - * <tr><td><i>type</i></td><td><i>JSON - * value</i></td></tr> - * <tr><td>BOOL</td><td>true or - * false</td></tr> - * <tr><td>STRING</td><td>string</td></tr> - * <tr><td>INTEGER</td><td>number</td></tr> - * <tr><td>CHOICE</td><td>string</td></tr> - * <tr><td>MULTISELECT</td><td>array of - * strings</td></tr> - * <tr><td>HIDDEN</td><td>string</td></tr> - * <tr><td>BUNDLE_ARRAY</td><td>array of - * objects</td></tr> </table> + * Managed configuration applied to the app. The format for the configuration is dictated by the ManagedProperty values supported by the app. Each field name in the managed configuration must match the key field of the ManagedProperty. The field value must be compatible with the type of the ManagedProperty: <table> <tr><td><i>type</i></td><td><i>JSON value</i></td></tr> <tr><td>BOOL</td><td>true or false</td></tr> <tr><td>STRING</td><td>string</td></tr> <tr><td>INTEGER</td><td>number</td></tr> <tr><td>CHOICE</td><td>string</td></tr> <tr><td>MULTISELECT</td><td>array of strings</td></tr> <tr><td>HIDDEN</td><td>string</td></tr> <tr><td>BUNDLE_ARRAY</td><td>array of objects</td></tr> </table> */ managedConfiguration?: {[key: string]: any}; /** - * The managed configurations template for the app, saved from the managed - * configurations iframe. This field is ignored if managed_configuration is - * set. + * The managed configurations template for the app, saved from the managed configurations iframe. This field is ignored if managed_configuration is set. */ managedConfigurationTemplate?: Schema$ManagedConfigurationTemplate; /** - * The minimum version of the app that runs on the device. If set, the - * device attempts to update the app to at least this version code. If the - * app is not up-to-date, the device will contain a NonComplianceDetail with - * non_compliance_reason set to APP_NOT_UPDATED. The app must already be - * published to Google Play with a version code greater than or equal to - * this value. At most 20 apps may specify a minimum version code per - * policy. + * The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. */ minimumVersionCode?: number; /** - * The package name of the app. For example, com.google.android.youtube for - * the YouTube app. + * The package name of the app. For example, com.google.android.youtube for the YouTube app. */ packageName?: string; /** - * Explicit permission grants or denials for the app. These values override - * the default_permission_policy and permission_grants which apply to all - * apps. + * Explicit permission grants or denials for the app. These values override the default_permission_policy and permission_grants which apply to all apps. */ permissionGrants?: Schema$PermissionGrant[]; } @@ -305,16 +266,11 @@ export namespace androidmanagement_v1 { */ packageName?: string; /** - * The SHA-256 hash of the app's APK file, which can be used to verify - * the app hasn't been modified. Each byte of the hash value is - * represented as a two-digit hexadecimal number. + * The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number. */ packageSha256Hash?: string; /** - * The SHA-1 hash of each android.content.pm.Signature - * (https://developer.android.com/reference/android/content/pm/Signature.html) - * associated with the app package. Each byte of each hash value is - * represented as a two-digit hexadecimal number. + * The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. */ signingKeyCertFingerprints?: string[]; /** @@ -322,8 +278,7 @@ export namespace androidmanagement_v1 { */ state?: string; /** - * The app version code, which can be used to determine whether one version - * is more recent than another. + * The app version code, which can be used to determine whether one version is more recent than another. */ versionCode?: number; /** @@ -341,17 +296,20 @@ export namespace androidmanagement_v1 { includeRemovedApps?: boolean; } /** - * A rule for automatically choosing a private key and certificate to - * authenticate the device to a server. + * An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a device or work profile to displays a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified. + */ + export interface Schema$BlockAction { + /** + * Number of days the policy is non-compliant before the device or work profile is blocked. To block access immediately, set to 0. blockAfterDays must be less than wipeAfterDays. + */ + blockAfterDays?: number; + } + /** + * A rule for automatically choosing a private key and certificate to authenticate the device to a server. */ export interface Schema$ChoosePrivateKeyRule { /** - * The package names for which outgoing requests are subject to this rule. - * If no package names are specified, then the rule applies to all packages. - * For each package name listed, the rule applies to that package and all - * other packages that shared the same Android UID. The SHA256 hash of the - * signing key signatures of each package_name will be verified against - * those provided by Play + * The package names for which outgoing requests are subject to this rule. If no package names are specified, then the rule applies to all packages. For each package name listed, the rule applies to that package and all other packages that shared the same Android UID. The SHA256 hash of the signing key signatures of each package_name will be verified against those provided by Play */ packageNames?: string[]; /** @@ -359,9 +317,7 @@ export namespace androidmanagement_v1 { */ privateKeyAlias?: string; /** - * The URL pattern to match against the URL of the outgoing request. The - * pattern may contain asterisk (*) wildcards. Any URL is matched if - * unspecified. + * The URL pattern to match against the URL of the outgoing request. The pattern may contain asterisk (*) wildcards. Any URL is matched if unspecified. */ urlPattern?: string; } @@ -370,24 +326,19 @@ export namespace androidmanagement_v1 { */ export interface Schema$Command { /** - * The timestamp at which the command was created. The timestamp is - * automatically generated by the server. + * The timestamp at which the command was created. The timestamp is automatically generated by the server. */ createTime?: string; /** - * The duration for which the command is valid. The command will expire if - * not executed by the device during this time. The default duration if - * unspecified is ten minutes. There is no maximum duration. + * The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration. */ duration?: string; /** - * If the command failed, an error code explaining the failure. This is not - * set when the command is cancelled by the caller. + * If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller. */ errorCode?: string; /** - * For commands of type RESET_PASSWORD, optionally specifies the new - * password. + * For commands of type RESET_PASSWORD, optionally specifies the new password. */ newPassword?: string; /** @@ -399,47 +350,33 @@ export namespace androidmanagement_v1 { */ type?: string; /** - * The resource name of the user that owns the device in the form - * enterprises/{enterpriseId}/users/{userId}. This is automatically - * generated by the server based on the device the command is sent to. + * The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to. */ userName?: string; } /** - * A rule declaring which mitigating actions to take when a device is not - * compliant with its policy. For every rule, there is always an implicit - * mitigating action to set policy_compliant to false for the Device resource, - * and display a message on the device indicating that the device is not - * compliant with its policy. Other mitigating actions may optionally be taken - * as well, depending on the field values in the rule. + * A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule. */ export interface Schema$ComplianceRule { /** - * A condition which is satisfied if the Android Framework API level on the - * device doesn't meet a minimum requirement. + * A condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. */ apiLevelCondition?: Schema$ApiLevelCondition; /** - * If set to true, the rule includes a mitigating action to disable apps so - * that the device is effectively disabled, but app data is preserved. If - * the device is running an app in locked task mode, the app will be closed - * and a UI showing the reason for non-compliance will be displayed. + * If set to true, the rule includes a mitigating action to disable apps so that the device is effectively disabled, but app data is preserved. If the device is running an app in locked task mode, the app will be closed and a UI showing the reason for non-compliance will be displayed. */ disableApps?: boolean; /** - * A condition which is satisfied if there exists any matching - * NonComplianceDetail for the device. + * A condition which is satisfied if there exists any matching NonComplianceDetail for the device. */ nonComplianceDetailCondition?: Schema$NonComplianceDetailCondition; /** - * If set, the rule includes a mitigating action to disable apps specified - * in the list, but app data is preserved. + * If set, the rule includes a mitigating action to disable apps specified in the list, but app data is preserved. */ packageNamesToDisable?: string[]; } /** - * A device owned by an enterprise. Unless otherwise noted, all fields are - * read-only and can't be modified by enterprises.devices.patch. + * A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. */ export interface Schema$Device { /** @@ -447,9 +384,7 @@ export namespace androidmanagement_v1 { */ apiLevel?: number; /** - * Reports for apps installed on the device. This information is only - * available when application_reports_enabled is true in the device's - * policy. + * Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. */ applicationReports?: Schema$ApplicationReport[]; /** @@ -465,19 +400,15 @@ export namespace androidmanagement_v1 { */ appliedState?: string; /** - * Device settings information. This information is only available if - * deviceSettingsEnabled is true in the device's policy. + * Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. */ deviceSettings?: Schema$DeviceSettings; /** - * If the device state is DISABLED, an optional message that is displayed on - * the device indicating the reason the device is disabled. This field can - * be modified by a patch request. + * If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request. */ disabledReason?: Schema$UserFacingMessage; /** - * Detailed information about displays on the device. This information is - * only available if displayInfoEnabled is true in the device's policy. + * Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. */ displays?: Schema$Display[]; /** @@ -485,13 +416,11 @@ export namespace androidmanagement_v1 { */ enrollmentTime?: string; /** - * If the device was enrolled with an enrollment token with additional data - * provided, this field contains that data. + * If the device was enrolled with an enrollment token with additional data provided, this field contains that data. */ enrollmentTokenData?: string; /** - * If the device was enrolled with an enrollment token, this field contains - * the name of the token. + * If the device was enrolled with an enrollment token, this field contains the name of the token. */ enrollmentTokenName?: string; /** @@ -499,8 +428,7 @@ export namespace androidmanagement_v1 { */ hardwareInfo?: Schema$HardwareInfo; /** - * Hardware status samples in chronological order. This information is only - * available if hardwareStatusEnabled is true in the device's policy. + * Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. */ hardwareStatusSamples?: Schema$HardwareStatus[]; /** @@ -516,29 +444,23 @@ export namespace androidmanagement_v1 { */ lastStatusReportTime?: string; /** - * The type of management mode Android Device Policy takes on the device. - * This influences which policy settings are supported. + * The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. */ managementMode?: string; /** - * Events related to memory and storage measurements in chronological order. - * This information is only available if memoryInfoEnabled is true in the - * device's policy. + * Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy. */ memoryEvents?: Schema$MemoryEvent[]; /** - * Memory information. This information is only available if - * memoryInfoEnabled is true in the device's policy. + * Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. */ memoryInfo?: Schema$MemoryInfo; /** - * The name of the device in the form - * enterprises/{enterpriseId}/devices/{deviceId}. + * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. */ name?: string; /** - * Device network information. This information is only available if - * networkInfoEnabled is true in the device's policy. + * Device network information. This information is only available if networkInfoEnabled is true in the device's policy. */ networkInfo?: Schema$NetworkInfo; /** @@ -550,46 +472,35 @@ export namespace androidmanagement_v1 { */ policyCompliant?: boolean; /** - * The name of the policy applied to the device, in the form - * enterprises/{enterpriseId}/policies/{policyId}. If not specified, the - * policy_name for the device's user is applied. This field can be - * modified by a patch request. You can specify only the policyId when - * calling enterprises.devices.patch, as long as the policyId doesn’t - * contain any slashes. The rest of the policy name is inferred. + * The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred. */ policyName?: string; /** - * Power management events on the device in chronological order. This - * information is only available if powerManagementEventsEnabled is true in - * the device's policy. + * Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. */ powerManagementEvents?: Schema$PowerManagementEvent[]; /** - * If the same physical device has been enrolled multiple times, this field - * contains its previous device names. The serial number is used as the - * unique identifier to determine if the same physical device has enrolled - * previously. The names are in chronological order. + * If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order. */ previousDeviceNames?: string[]; /** - * Detailed information about the device software. This information is only - * available if softwareInfoEnabled is true in the device's policy. + * Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy. */ softwareInfo?: Schema$SoftwareInfo; /** - * The state to be applied to the device. This field can be modified by a - * patch request. Note that when calling enterprises.devices.patch, ACTIVE - * and DISABLED are the only allowable values. To enter the device into a - * DELETED state, call enterprises.devices.delete. + * The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete. */ state?: string; + /** + * Map of selected system properties name and value related to the device. + */ + systemProperties?: {[key: string]: string}; /** * The user who owns the device. */ user?: Schema$User; /** - * The resource name of the user that owns this device in the form - * enterprises/{enterpriseId}/users/{userId}. + * The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. */ userName?: string; } @@ -598,8 +509,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$DeviceSettings { /** - * Whether ADB (https://developer.android.com/studio/command-line/adb.html) - * is enabled on the device. + * Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. */ adbEnabled?: boolean; /** @@ -623,9 +533,7 @@ export namespace androidmanagement_v1 { */ unknownSourcesEnabled?: boolean; /** - * Whether Verify Apps (Google Play Protect - * (https://support.google.com/googleplay/answer/2812853)) is enabled on the - * device. + * Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. */ verifyAppsEnabled?: boolean; } @@ -663,11 +571,7 @@ export namespace androidmanagement_v1 { width?: number; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** @@ -675,62 +579,39 @@ export namespace androidmanagement_v1 { */ export interface Schema$EnrollmentToken { /** - * Optional, arbitrary data associated with the enrollment token. This could - * contain, for example, the ID of an org unit the device is assigned to - * after enrollment. After a device enrolls with the token, this data will - * be exposed in the enrollment_token_data field of the Device resource. The - * data must be 1024 characters or less; otherwise, the creation request - * will fail. + * Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail. */ additionalData?: string; /** - * The length of time the enrollment token is valid, ranging from 1 minute - * to 30 days. If not specified, the default duration is 1 hour. + * The length of time the enrollment token is valid, ranging from 1 minute to 30 days. If not specified, the default duration is 1 hour. */ duration?: string; /** - * The expiration time of the token. This is a read-only field generated by - * the server. + * The expiration time of the token. This is a read-only field generated by the server. */ expirationTimestamp?: string; /** - * The name of the enrollment token, which is generated by the server during - * creation, in the form - * enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. + * The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. */ name?: string; /** - * Whether the enrollment token is for one time use only. If the flag is set - * to true, only one device can use it for registration. + * Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration. */ oneTimeOnly?: boolean; /** - * The name of the policy initially applied to the enrolled device, in the - * form enterprises/{enterpriseId}/policies/{policyId}. If not specified, - * the policy_name for the device’s user is applied. If user_name is also - * not specified, enterprises/{enterpriseId}/policies/default is applied by - * default. When updating this field, you can specify only the policyId as - * long as the policyId doesn’t contain any slashes. The rest of the policy - * name will be inferred. + * The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred. */ policyName?: string; /** - * A JSON string whose UTF-8 representation can be used to generate a QR - * code to enroll a device with this enrollment token. To enroll a device - * using NFC, the NFC record must contain a serialized java.util.Properties - * representation of the properties in the JSON. + * A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. */ qrCode?: string; /** - * The user associated with this enrollment token. If it's specified - * when the enrollment token is created and the user does not exist, the - * user will be created. This field must not contain personally identifiable - * information. Only the account_identifier field needs to be set. + * The user associated with this enrollment token. If it's specified when the enrollment token is created and the user does not exist, the user will be created. This field must not contain personally identifiable information. Only the account_identifier field needs to be set. */ user?: Schema$User; /** - * The token value that's passed to the device and authorizes the device - * to enroll. This is a read-only field generated by the server. + * The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server. */ value?: string; } @@ -751,75 +632,53 @@ export namespace androidmanagement_v1 { */ enterpriseDisplayName?: string; /** - * An image displayed as a logo during device provisioning. Supported types - * are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, - * image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. + * An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. */ logo?: Schema$ExternalData; /** - * The name of the enterprise which is generated by the server during - * creation, in the form enterprises/{enterpriseId}. + * The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. */ name?: string; /** - * A color in RGB format that indicates the predominant color to display in - * the device management app UI. The color components are stored as follows: - * (red << 16) | (green << 8) | blue, where the value of each - * component is between 0 and 255, inclusive. + * A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive. */ primaryColor?: number; /** - * The topic that Cloud Pub/Sub notifications are published to, in the form - * projects/{project}/topics/{topic}. This field is only required if Pub/Sub - * notifications are enabled. + * The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled. */ pubsubTopic?: string; /** - * Sign-in details of the enterprise. Maximum of 1 SigninDetail is - * supported. + * Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. */ signinDetails?: Schema$SigninDetail[]; /** - * Terms and conditions that must be accepted when provisioning a device for - * this enterprise. A page of terms is generated for each value in this - * list. + * Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list. */ termsAndConditions?: Schema$TermsAndConditions[]; } /** - * Data hosted at an external location. The data is to be downloaded by - * Android Device Policy and verified against the hash. + * Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. */ export interface Schema$ExternalData { /** - * The base-64 encoded SHA-256 hash of the content hosted at url. If the - * content doesn't match this hash, Android Device Policy won't use - * the data. + * The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. */ sha256Hash?: string; /** - * The absolute URL to the data, which must use either the http or https - * scheme. Android Device Policy doesn't provide any credentials in the - * GET request, so the URL must be publicly accessible. Including a long, - * random component in the URL may be used to prevent attackers from - * discovering the URL. + * The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL. */ url?: string; } /** - * Information about device hardware. The fields related to temperature - * thresholds are only available if hardwareStatusEnabled is true in the - * device's policy. + * Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. */ export interface Schema$HardwareInfo { /** - * Battery shutdown temperature thresholds in Celsius for each battery on - * the device. + * Battery shutdown temperature thresholds in Celsius for each battery on the device. */ batteryShutdownTemperatures?: number[]; /** - * Battery throttling temperature thresholds in Celsius for each battery on - * the device. + * Battery throttling temperature thresholds in Celsius for each battery on the device. */ batteryThrottlingTemperatures?: number[]; /** @@ -827,13 +686,11 @@ export namespace androidmanagement_v1 { */ brand?: string; /** - * CPU shutdown temperature thresholds in Celsius for each CPU on the - * device. + * CPU shutdown temperature thresholds in Celsius for each CPU on the device. */ cpuShutdownTemperatures?: number[]; /** - * CPU throttling temperature thresholds in Celsius for each CPU on the - * device. + * CPU throttling temperature thresholds in Celsius for each CPU on the device. */ cpuThrottlingTemperatures?: number[]; /** @@ -841,13 +698,11 @@ export namespace androidmanagement_v1 { */ deviceBasebandVersion?: string; /** - * GPU shutdown temperature thresholds in Celsius for each GPU on the - * device. + * GPU shutdown temperature thresholds in Celsius for each GPU on the device. */ gpuShutdownTemperatures?: number[]; /** - * GPU throttling temperature thresholds in Celsius for each GPU on the - * device. + * GPU throttling temperature thresholds in Celsius for each GPU on the device. */ gpuThrottlingTemperatures?: number[]; /** @@ -876,8 +731,7 @@ export namespace androidmanagement_v1 { skinThrottlingTemperatures?: number[]; } /** - * Hardware status. Temperatures may be compared to the temperature thresholds - * available in hardwareInfo to determine hardware health. + * Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. */ export interface Schema$HardwareStatus { /** @@ -889,9 +743,7 @@ export namespace androidmanagement_v1 { */ cpuTemperatures?: number[]; /** - * CPU usages in percentage for each core available on the device. Usage is - * 0 for each unplugged core. Empty array implies that CPU usage is not - * supported in the system. + * CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system. */ cpuUsages?: number[]; /** @@ -899,8 +751,7 @@ export namespace androidmanagement_v1 { */ createTime?: string; /** - * Fan speeds in RPM for each fan on the device. Empty array means that - * there are no fans or fan speed is not supported on the system. + * Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system. */ fanSpeeds?: number[]; /** @@ -921,15 +772,11 @@ export namespace androidmanagement_v1 { */ createTime?: string; /** - * Optionally, a machine-readable value to be read by the EMM. For example, - * setting values that the admin can choose to query against in the EMM - * console (e.g. “notify me if the battery_warning data < 10”). + * Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”). */ data?: string; /** - * The key for the app state. Acts as a point of reference for what the app - * is providing state for. For example, when providing managed configuration - * feedback, this key could be the managed configuration key. + * The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key. */ key?: string; /** @@ -937,9 +784,7 @@ export namespace androidmanagement_v1 { */ lastUpdateTime?: string; /** - * Optionally, a free-form message string to explain the app state. If the - * state was triggered by a particular value (e.g. a managed configuration - * value), it should be included in the message. + * Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message. */ message?: string; /** @@ -1009,13 +854,11 @@ export namespace androidmanagement_v1 { webApps?: Schema$WebApp[]; } /** - * The managed configurations template for the app, saved from the managed - * configurations iframe. + * The managed configurations template for the app, saved from the managed configurations iframe. */ export interface Schema$ManagedConfigurationTemplate { /** - * Optional, a map containing <key, value> configuration variables - * defined for the configuration. + * Optional, a map containing <key, value> configuration variables defined for the configuration. */ configurationVariables?: {[key: string]: string}; /** @@ -1028,13 +871,11 @@ export namespace androidmanagement_v1 { */ export interface Schema$ManagedProperty { /** - * The default value of the property. BUNDLE_ARRAY properties don't have - * a default value. + * The default value of the property. BUNDLE_ARRAY properties don't have a default value. */ defaultValue?: any; /** - * A longer description of the property, providing more detail of what it - * affects. Localized. + * A longer description of the property, providing more detail of what it affects. Localized. */ description?: string; /** @@ -1042,13 +883,11 @@ export namespace androidmanagement_v1 { */ entries?: Schema$ManagedPropertyEntry[]; /** - * The unique key that the app uses to identify the property, e.g. - * "com.google.android.gm.fieldname". + * The unique key that the app uses to identify the property, e.g. "com.google.android.gm.fieldname". */ key?: string; /** - * For BUNDLE_ARRAY properties, the list of nested properties. A - * BUNDLE_ARRAY property is at most two levels deep. + * For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY property is at most two levels deep. */ nestedProperties?: Schema$ManagedProperty[]; /** @@ -1069,8 +908,7 @@ export namespace androidmanagement_v1 { */ name?: string; /** - * The machine-readable value of the entry, which should be used in the - * configuration. Not localized. + * The machine-readable value of the entry, which should be used in the configuration. Not localized. */ value?: string; } @@ -1079,8 +917,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$MemoryEvent { /** - * The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, - * the total capacity in bytes of the storage medium. + * The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium. */ byteCount?: string; /** @@ -1131,26 +968,15 @@ export namespace androidmanagement_v1 { */ export interface Schema$NonComplianceDetail { /** - * If the policy setting could not be applied, the current value of the - * setting on the device. + * If the policy setting could not be applied, the current value of the setting on the device. */ currentValue?: any; /** - * For settings with nested fields, if a particular nested field is out of - * compliance, this specifies the full path to the offending field. The path - * is formatted in the same way the policy JSON field would be referenced in - * JavaScript, that is: 1) For object-typed fields, the field name is - * followed by a dot then by a subfield name. 2) For array-typed fields, - * the field name is followed by the array index enclosed in brackets. For - * example, to indicate a problem with the url field in the externalData - * field in the 3rd application, the path would be - * applications[2].externalData.url + * For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url */ fieldPath?: string; /** - * If package_name is set and the non-compliance reason is APP_NOT_INSTALLED - * or APP_NOT_UPDATED, the detailed reason the app can't be installed or - * updated. + * If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated. */ installationFailureReason?: string; /** @@ -1158,50 +984,37 @@ export namespace androidmanagement_v1 { */ nonComplianceReason?: string; /** - * The package name indicating which app is out of compliance, if - * applicable. + * The package name indicating which app is out of compliance, if applicable. */ packageName?: string; /** - * The name of the policy setting. This is the JSON field name of a - * top-level Policy field. + * The name of the policy setting. This is the JSON field name of a top-level Policy field. */ settingName?: string; } /** - * A compliance rule condition which is satisfied if there exists any matching - * NonComplianceDetail for the device. A NonComplianceDetail matches a - * NonComplianceDetailCondition if all the fields which are set within the - * NonComplianceDetailCondition match the corresponding NonComplianceDetail - * fields. + * A compliance rule condition which is satisfied if there exists any matching NonComplianceDetail for the device. A NonComplianceDetail matches a NonComplianceDetailCondition if all the fields which are set within the NonComplianceDetailCondition match the corresponding NonComplianceDetail fields. */ export interface Schema$NonComplianceDetailCondition { /** - * The reason the device is not in compliance with the setting. If not set, - * then this condition matches any reason. + * The reason the device is not in compliance with the setting. If not set, then this condition matches any reason. */ nonComplianceReason?: string; /** - * The package name of the app that's out of compliance. If not set, - * then this condition matches any package name. + * The package name of the app that's out of compliance. If not set, then this condition matches any package name. */ packageName?: string; /** - * The name of the policy setting. This is the JSON field name of a - * top-level Policy field. If not set, then this condition matches any - * setting name. + * The name of the policy setting. This is the JSON field name of a top-level Policy field. If not set, then this condition matches any setting name. */ settingName?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is false, it means the operation is still in progress. If - * true, the operation is completed, and either error or response is - * available. + * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ done?: boolean; /** @@ -1209,26 +1022,15 @@ export namespace androidmanagement_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the name - * should have the format of operations/some/unique/name. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as Delete, the response is - * google.protobuf.Empty. If the original method is standard - * Get/Create/Update, the response should be the resource. For other - * methods, the response should have the type XxxResponse, where Xxx is the - * original method name. For example, if the original method name is - * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. + * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ response?: {[key: string]: any}; } @@ -1246,8 +1048,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$PasswordRequirements { /** - * Number of incorrect device-unlock passwords that can be entered before a - * device is wiped. A value of 0 means there is no restriction. + * Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. */ maximumFailedPasswordsForWipe?: number; /** @@ -1255,45 +1056,35 @@ export namespace androidmanagement_v1 { */ passwordExpirationTimeout?: string; /** - * The length of the password history. After setting this field, the user - * won't be able to enter a new password that is the same as any - * password in the history. A value of 0 means there is no restriction. + * The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. */ passwordHistoryLength?: number; /** - * The minimum allowed password length. A value of 0 means there is no - * restriction. Only enforced when password_quality is NUMERIC, - * NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + * The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. */ passwordMinimumLength?: number; /** - * Minimum number of letters required in the password. Only enforced when - * password_quality is COMPLEX. + * Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. */ passwordMinimumLetters?: number; /** - * Minimum number of lower case letters required in the password. Only - * enforced when password_quality is COMPLEX. + * Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. */ passwordMinimumLowerCase?: number; /** - * Minimum number of non-letter characters (numerical digits or symbols) - * required in the password. Only enforced when password_quality is COMPLEX. + * Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. */ passwordMinimumNonLetter?: number; /** - * Minimum number of numerical digits required in the password. Only - * enforced when password_quality is COMPLEX. + * Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. */ passwordMinimumNumeric?: number; /** - * Minimum number of symbols required in the password. Only enforced when - * password_quality is COMPLEX. + * Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. */ passwordMinimumSymbols?: number; /** - * Minimum number of upper case letters required in the password. Only - * enforced when password_quality is COMPLEX. + * Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. */ passwordMinimumUpperCase?: number; /** @@ -1310,8 +1101,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$PermissionGrant { /** - * The Android permission or group, e.g. android.permission.READ_CALENDAR or - * android.permission_group.CALENDAR. + * The Android permission or group, e.g. android.permission.READ_CALENDAR or android.permission_group.CALENDAR. */ permission?: string; /** @@ -1320,35 +1110,24 @@ export namespace androidmanagement_v1 { policy?: string; } /** - * A default activity for handling intents that match a particular intent - * filter. + * A default activity for handling intents that match a particular intent filter. */ export interface Schema$PersistentPreferredActivity { /** - * The intent actions to match in the filter. If any actions are included in - * the filter, then an intent's action must be one of those values for - * it to match. If no actions are included, the intent action is ignored. + * The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. */ actions?: string[]; /** - * The intent categories to match in the filter. An intent includes the - * categories that it requires, all of which must be included in the filter - * in order to match. In other words, adding a category to the filter has no - * impact on matching unless that category is specified in the intent. + * The intent categories to match in the filter. An intent includes the categories that it requires, all of which must be included in the filter in order to match. In other words, adding a category to the filter has no impact on matching unless that category is specified in the intent. */ categories?: string[]; /** - * The activity that should be the default intent handler. This should be an - * Android component name, e.g. com.android.enterprise.app/.MainActivity. - * Alternatively, the value may be the package name of an app, which causes - * Android Device Policy to choose an appropriate activity from the app to - * handle the intent. + * The activity that should be the default intent handler. This should be an Android component name, e.g. com.android.enterprise.app/.MainActivity. Alternatively, the value may be the package name of an app, which causes Android Device Policy to choose an appropriate activity from the app to handle the intent. */ receiverActivity?: string; } /** - * A policy resources represents a group settings that govern the behavior of - * a managed device and the apps installed on it. + * A policy resources represents a group settings that govern the behavior of a managed device and the apps installed on it. */ export interface Schema$Policy { /** @@ -1364,19 +1143,15 @@ export namespace androidmanagement_v1 { */ adjustVolumeDisabled?: boolean; /** - * Configuration for an always-on VPN connection. Use with - * vpn_config_disabled to prevent modification of this setting. + * Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. */ alwaysOnVpnPackage?: Schema$AlwaysOnVpnPackage; /** - * The app tracks for Android Device Policy the device can access. The - * device receives the latest version among all accessible tracks. If no - * tracks are specified, then the device only uses the production track. + * The app tracks for Android Device Policy the device can access. The device receives the latest version among all accessible tracks. If no tracks are specified, then the device only uses the production track. */ androidDevicePolicyTracks?: string[]; /** - * The app auto update policy, which controls when automatic app updates can - * be applied. + * The app auto update policy, which controls when automatic app updates can be applied. */ appAutoUpdatePolicy?: string; /** @@ -1384,15 +1159,11 @@ export namespace androidmanagement_v1 { */ applications?: Schema$ApplicationPolicy[]; /** - * Whether auto time is required, which prevents the user from manually - * setting the date and time. + * Whether auto time is required, which prevents the user from manually setting the date and time. */ autoTimeRequired?: boolean; /** - * Whether applications other than the ones configured in applications are - * blocked from being installed. When set, applications that were installed - * under a previous policy but no longer appear in the policy are - * automatically uninstalled. + * Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled. */ blockApplicationsEnabled?: boolean; /** @@ -1404,9 +1175,7 @@ export namespace androidmanagement_v1 { */ bluetoothContactSharingDisabled?: boolean; /** - * Whether bluetooth is disabled. Prefer this setting over - * bluetooth_config_disabled because bluetooth_config_disabled can be - * bypassed by the user. + * Whether bluetooth is disabled. Prefer this setting over bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by the user. */ bluetoothDisabled?: boolean; /** @@ -1418,17 +1187,11 @@ export namespace androidmanagement_v1 { */ cellBroadcastsConfigDisabled?: boolean; /** - * Rules for automatically choosing a private key and certificate to - * authenticate the device to a server. The rules are ordered by increasing - * precedence, so if an outgoing request matches more than one rule, the - * last rule defines which private key to use. + * Rules for automatically choosing a private key and certificate to authenticate the device to a server. The rules are ordered by increasing precedence, so if an outgoing request matches more than one rule, the last rule defines which private key to use. */ choosePrivateKeyRules?: Schema$ChoosePrivateKeyRule[]; /** - * Rules declaring which mitigating actions to take when a device is not - * compliant with its policy. When the conditions for multiple rules are - * satisfied, all of the mitigating actions for the rules are taken. There - * is a maximum limit of 100 rules. + * Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. */ complianceRules?: Schema$ComplianceRule[]; /** @@ -1468,16 +1231,11 @@ export namespace androidmanagement_v1 { */ factoryResetDisabled?: boolean; /** - * Email addresses of device administrators for factory reset protection. - * When the device is factory reset, it will require one of these admins to - * log in with the Google account email and password to unlock the device. - * If no admins are specified, the device won't provide factory reset - * protection. + * Email addresses of device administrators for factory reset protection. When the device is factory reset, it will require one of these admins to log in with the Google account email and password to unlock the device. If no admins are specified, the device won't provide factory reset protection. */ frpAdminEmails?: string[]; /** - * Whether the user is allowed to have fun. Controls whether the Easter egg - * game in Settings is disabled. + * Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled. */ funDisabled?: boolean; /** @@ -1485,8 +1243,7 @@ export namespace androidmanagement_v1 { */ installAppsDisabled?: boolean; /** - * Whether the user is allowed to enable the "Unknown Sources" - * setting, which allows installation of apps from unknown sources. + * Whether the user is allowed to enable the "Unknown Sources" setting, which allows installation of apps from unknown sources. */ installUnknownSourcesAllowed?: boolean; /** @@ -1498,28 +1255,25 @@ export namespace androidmanagement_v1 { */ keyguardDisabledFeatures?: string[]; /** - * Whether the kiosk custom launcher is enabled. This replaces the home - * screen with a launcher that locks down the device to the apps installed - * via the applications setting. The apps appear on a single page in - * alphabetical order. It is recommended to also use status_bar_disabled to - * block access to device settings. + * Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. The apps appear on a single page in alphabetical order. It is recommended to also use status_bar_disabled to block access to device settings. */ kioskCustomLauncherEnabled?: boolean; /** - * The degree of location detection enabled. The user may change the value - * unless the user is otherwise blocked from accessing device settings. + * The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings. */ locationMode?: string; /** - * A message displayed to the user in the device administators settings - * screen. + * A message displayed to the user in the device administators settings screen. */ longSupportMessage?: Schema$UserFacingMessage; /** - * Maximum time in milliseconds for user activity until the device locks. A - * value of 0 means there is no restriction. + * Maximum time in milliseconds for user activity until the device locks. A value of 0 means there is no restriction. */ maximumTimeToLock?: string; + /** + * The minimum allowed Android API level. + */ + minimumApiLevel?: number; /** * Whether configuring mobile networks is disabled. */ @@ -1533,19 +1287,11 @@ export namespace androidmanagement_v1 { */ mountPhysicalMediaDisabled?: boolean; /** - * The name of the policy in the form - * enterprises/{enterpriseId}/policies/{policyId}. + * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. */ name?: string; /** - * Whether the network escape hatch is enabled. If a network connection - * can't be made at boot time, the escape hatch prompts the user to - * temporarily connect to a network in order to refresh the device policy. - * After applying policy, the temporary network will be forgotten and the - * device will continue booting. This prevents being unable to connect to a - * network if there is no suitable network in the last policy and the device - * boots into an app in lock task mode, or the user is otherwise unable to - * reach device settings. + * Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings. */ networkEscapeHatchEnabled?: boolean; /** @@ -1553,8 +1299,7 @@ export namespace androidmanagement_v1 { */ networkResetDisabled?: boolean; /** - * Network configuration for the device. See configure networks for more - * information. + * Network configuration for the device. See configure networks for more information. */ openNetworkConfiguration?: {[key: string]: any}; /** @@ -1566,9 +1311,7 @@ export namespace androidmanagement_v1 { */ outgoingCallsDisabled?: boolean; /** - * Password requirement policies. Different policies can be set for work - * profile or fully managed devices by setting the password_scope field in - * the policy. + * Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. */ passwordPolicies?: Schema$PasswordRequirements[]; /** @@ -1576,14 +1319,11 @@ export namespace androidmanagement_v1 { */ passwordRequirements?: Schema$PasswordRequirements; /** - * Explicit permission or group grants or denials for all apps. These values - * override the default_permission_policy. + * Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. */ permissionGrants?: Schema$PermissionGrant[]; /** - * If present, only the input methods provided by packages in this list are - * permitted. If this field is present, but the list is empty, then only - * system input methods are permitted. + * If present, only the input methods provided by packages in this list are permitted. If this field is present, but the list is empty, then only system input methods are permitted. */ permittedInputMethods?: Schema$PackageNameList; /** @@ -1591,22 +1331,19 @@ export namespace androidmanagement_v1 { */ persistentPreferredActivities?: Schema$PersistentPreferredActivity[]; /** - * This mode controls which apps are available to the user in the Play Store - * and the behavior on the device when apps are removed from the policy. + * This mode controls which apps are available to the user in the Play Store and the behavior on the device when apps are removed from the policy. */ playStoreMode?: string; /** - * Allows showing UI on a device for a user to choose a private key alias if - * there are no matching rules in ChoosePrivateKeyRules. For devices below - * Android P, setting this may leave enterprise keys vulnerable. + * Rules that define the behavior when a particular policy can not be applied on device + */ + policyEnforcementRules?: Schema$PolicyEnforcementRule[]; + /** + * Allows showing UI on a device for a user to choose a private key alias if there are no matching rules in ChoosePrivateKeyRules. For devices below Android P, setting this may leave enterprise keys vulnerable. */ privateKeySelectionEnabled?: boolean; /** - * The network-independent global HTTP proxy. Typically proxies should be - * configured per-network in open_network_configuration. However for unusual - * configurations like general internal filtering a global HTTP proxy may be - * useful. If the proxy is not accessible, network access may break. The - * global proxy is only a recommendation and some apps may ignore it. + * The network-independent global HTTP proxy. Typically proxies should be configured per-network in open_network_configuration. However for unusual configurations like general internal filtering a global HTTP proxy may be useful. If the proxy is not accessible, network access may break. The global proxy is only a recommendation and some apps may ignore it. */ recommendedGlobalProxy?: Schema$ProxyInfo; /** @@ -1638,14 +1375,11 @@ export namespace androidmanagement_v1 { */ shareLocationDisabled?: boolean; /** - * A message displayed to the user in the settings screen wherever - * functionality has been disabled by the admin. + * A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. */ shortSupportMessage?: Schema$UserFacingMessage; /** - * Flag to skip hints on the first use. Enterprise admin can enable the - * system recommendation for apps to skip their user tutorial and other - * introductory hints on first start-up. + * Flag to skip hints on the first use. Enterprise admin can enable the system recommendation for apps to skip their user tutorial and other introductory hints on first start-up. */ skipFirstUseHintsEnabled?: boolean; /** @@ -1653,9 +1387,7 @@ export namespace androidmanagement_v1 { */ smsDisabled?: boolean; /** - * Whether the status bar is disabled. This disables notifications, quick - * settings, and other screen overlays that allow escape from full-screen - * mode. + * Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode. */ statusBarDisabled?: boolean; /** @@ -1663,15 +1395,11 @@ export namespace androidmanagement_v1 { */ statusReportingSettings?: Schema$StatusReportingSettings; /** - * The battery plugged in modes for which the device stays on. When using - * this setting, it is recommended to clear maximum_time_to_lock so that the - * device doesn't lock itself while it stays on. + * The battery plugged in modes for which the device stays on. When using this setting, it is recommended to clear maximum_time_to_lock so that the device doesn't lock itself while it stays on. */ stayOnPluggedModes?: string[]; /** - * The system update policy, which controls how OS updates are applied. If - * the update type is WINDOWED, the update window will automatically apply - * to Play app updates as well. + * The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well. */ systemUpdate?: Schema$SystemUpdate; /** @@ -1683,8 +1411,7 @@ export namespace androidmanagement_v1 { */ uninstallAppsDisabled?: boolean; /** - * Whether the microphone is muted and adjusting microphone volume is - * disabled. + * Whether the microphone is muted and adjusting microphone volume is disabled. */ unmuteMicrophoneDisabled?: boolean; /** @@ -1696,8 +1423,7 @@ export namespace androidmanagement_v1 { */ usbMassStorageEnabled?: boolean; /** - * The version of the policy. This is a read-only field. The version is - * incremented each time the policy is updated. + * The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. */ version?: string; /** @@ -1713,6 +1439,23 @@ export namespace androidmanagement_v1 { */ wifiConfigsLockdownEnabled?: boolean; } + /** + * A rule that defines the actions to take if a device or work profile is not compliant with the policy specified in settingName. + */ + export interface Schema$PolicyEnforcementRule { + /** + * An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified. + */ + blockAction?: Schema$BlockAction; + /** + * The top-level policy to enforce. For example, applications or passwordRequirements. + */ + settingName?: string; + /** + * An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified. + */ + wipeAction?: Schema$WipeAction; + } /** * A power management event. */ @@ -1731,14 +1474,11 @@ export namespace androidmanagement_v1 { eventType?: string; } /** - * Configuration info for an HTTP proxy. For a direct proxy, set the host, - * port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri - * field. + * Configuration info for an HTTP proxy. For a direct proxy, set the host, port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri field. */ export interface Schema$ProxyInfo { /** - * For a direct proxy, the hosts for which the proxy is bypassed. The host - * names may contain wildcards such as *.example.com. + * For a direct proxy, the hosts for which the proxy is bypassed. The host names may contain wildcards such as *.example.com. */ excludedHosts?: string[]; /** @@ -1776,25 +1516,15 @@ export namespace androidmanagement_v1 { */ export interface Schema$SigninDetail { /** - * A JSON string whose UTF-8 representation can be used to generate a QR - * code to enroll a device with this enrollment token. To enroll a device - * using NFC, the NFC record must contain a serialized java.util.Properties - * representation of the properties in the JSON. This is a read-only field - * generated by the server. + * A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server. */ qrCode?: string; /** - * An enterprise wide enrollment token used to trigger custom sign-in flow. - * This is a read-only field generated by the server. + * An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. */ signinEnrollmentToken?: string; /** - * Sign-in URL for authentication when device is provisioned with a sign-in - * enrollment token. The sign-in endpoint should finish authentication flow - * with a URL in the form of - * https://enterprise.google.com/android/enroll?et=<token> for a - * successful login, or https://enterprise.google.com/android/enroll/invalid - * for a failed login. + * Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. */ signinUrl?: string; } @@ -1803,13 +1533,11 @@ export namespace androidmanagement_v1 { */ export interface Schema$SignupUrl { /** - * The name of the resource. Use this value in the signupUrl field when - * calling enterprises.create to complete the enterprise signup flow. + * The name of the resource. Use this value in the signupUrl field when calling enterprises.create to complete the enterprise signup flow. */ name?: string; /** - * A URL where an enterprise admin can register their enterprise. The page - * can't be rendered in an iframe. + * A URL where an enterprise admin can register their enterprise. The page can't be rendered in an iframe. */ url?: string; } @@ -1818,8 +1546,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$SoftwareInfo { /** - * Android build ID string meant for displaying to the user. For example, - * shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. + * Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. */ androidBuildNumber?: string; /** @@ -1843,10 +1570,7 @@ export namespace androidmanagement_v1 { */ bootloaderVersion?: string; /** - * SHA-256 hash of android.content.pm.Signature - * (https://developer.android.com/reference/android/content/pm/Signature.html) - * associated with the system package, which can be used to verify that the - * system build hasn't been modified. + * SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified. */ deviceBuildSignature?: string; /** @@ -1863,39 +1587,7 @@ export namespace androidmanagement_v1 { securityPatchLevel?: string; } /** - * The Status type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by gRPC (https://github.com/grpc). The error model is designed to be: - * Simple to use and understand for most users Flexible enough to meet - * unexpected needsOverviewThe Status message contains three pieces of data: - * error code, error message, and error details. The error code should be an - * enum value of google.rpc.Code, but it may accept additional error codes if - * needed. The error message should be a developer-facing English message that - * helps developers understand and resolve the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may - * contain arbitrary information about the error. There is a predefined set of - * error detail types in the package google.rpc that can be used for common - * error conditions.Language mappingThe Status message is the logical - * representation of the error model, but it is not necessarily the actual - * wire format. When the Status message is exposed in different client - * libraries and different wire protocols, it can be mapped differently. For - * example, it will likely be mapped to some exceptions in Java, but more - * likely mapped to some error codes in C.Other usesThe error model and the - * Status message can be used in a variety of environments, either with or - * without APIs, to provide a consistent developer experience across different - * environments.Example uses of this error model include: Partial errors. If a - * service needs to return partial errors to the client, it may embed the - * Status in the normal response to indicate the partial errors. Workflow - * errors. A typical workflow has multiple steps. Each step may have a Status - * message for error reporting. Batch operations. If a client uses batch - * request and batch response, the Status message should be used directly - * inside batch response, one for each error sub-response. Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the Status message. Logging. If some API errors are stored in logs, - * the message Status could be used directly after any stripping needed for - * security/privacy reasons. + * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1903,14 +1595,11 @@ export namespace androidmanagement_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1919,8 +1608,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$StatusReportingSettings { /** - * Application reporting settings. Only applicable if - * application_reports_enabled is true. + * Application reporting settings. Only applicable if application_reports_enabled is true. */ applicationReportingSettings?: Schema$ApplicationReportingSettings; /** @@ -1961,18 +1649,11 @@ export namespace androidmanagement_v1 { */ export interface Schema$SystemUpdate { /** - * If the type is WINDOWED, the end of the maintenance window, measured as - * the number of minutes after midnight in device's local time. This - * value must be between 0 and 1439, inclusive. If this value is less than - * start_minutes, then the maintenance window spans midnight. If the - * maintenance window specified is smaller than 30 minutes, the actual - * window is extended to 30 minutes beyond the start time. + * If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. */ endMinutes?: number; /** - * If the type is WINDOWED, the start of the maintenance window, measured as - * the number of minutes after midnight in the device's local time. This - * value must be between 0 and 1439, inclusive. + * If the type is WINDOWED, the start of the maintenance window, measured as the number of minutes after midnight in the device's local time. This value must be between 0 and 1439, inclusive. */ startMinutes?: number; /** @@ -1985,8 +1666,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$TermsAndConditions { /** - * A well-formatted HTML string. It will be parsed on the client with - * android.text.Html#fromHtml. + * A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml. */ content?: Schema$UserFacingMessage; /** @@ -1999,30 +1679,20 @@ export namespace androidmanagement_v1 { */ export interface Schema$User { /** - * A unique identifier you create for this user, such as user342 or - * asset#44418. This field must be set when the user is created and - * can't be updated. This field must not contain personally identifiable - * information (PII). This identifier must be 1024 characters or less; - * otherwise, the update policy request will fail. + * A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail. */ accountIdentifier?: string; } /** - * Provides a user-facing message with locale info. The maximum message length - * is 4096 characters. + * Provides a user-facing message with locale info. The maximum message length is 4096 characters. */ export interface Schema$UserFacingMessage { /** - * The default message displayed if no localized message is specified or the - * user's locale doesn't match with any of the localized messages. A - * default message must be provided if any localized messages are provided. + * The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. */ defaultMessage?: string; /** - * A map containing <locale, message> pairs, where locale is a - * well-formed BCP 47 language - * (https://www.w3.org/International/articles/language-tags/) code, such as - * en-US, es-ES, or fr. + * A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr. */ localizedMessages?: {[key: string]: string}; } @@ -2039,24 +1709,19 @@ export namespace androidmanagement_v1 { */ icons?: Schema$WebAppIcon[]; /** - * The name of the web app, which is generated by the server during creation - * in the form enterprises/{enterpriseId}/webApps/{packageName}. + * The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. */ name?: string; /** - * The start URL, i.e. the URL that should load when the user opens the - * application. + * The start URL, i.e. the URL that should load when the user opens the application. */ startUrl?: string; /** - * The title of the web app as displayed to the user (e.g., amongst a list - * of other applications, or as a label for an icon). + * The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon). */ title?: string; /** - * The current version of the app.<p>Note that the version can - * automatically increase during the lifetime of the web app, while Google - * does internal housekeeping to keep the web app up-to-date. + * The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date. */ versionCode?: string; } @@ -2065,11 +1730,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$WebAppIcon { /** - * The actual bytes of the image in a base64url encoded string (c.f. - * RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe - * Alphabet"). <ul> <li>The image type can be png or jpg. - * <li>The image should ideally be square. <li>The image should - * ideally have a size of 512x512. </ul> + * The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul> */ imageData?: string; } @@ -2078,27 +1739,35 @@ export namespace androidmanagement_v1 { */ export interface Schema$WebToken { /** - * The name of the web token, which is generated by the server during - * creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}. + * The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}. */ name?: string; /** - * The URL of the parent frame hosting the iframe with the embedded UI. To - * prevent XSS, the iframe may not be hosted at other URLs. The URL must use - * the https scheme. + * The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe may not be hosted at other URLs. The URL must use the https scheme. */ parentFrameUrl?: string; /** - * Permissions available to an admin in the embedded UI. An admin must have - * all of these permissions in order to view the UI. + * Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. */ permissions?: string[]; /** - * The token value which is used in the hosting page to generate the iframe - * with the embedded UI. This is a read-only field generated by the server. + * The token value which is used in the hosting page to generate the iframe with the embedded UI. This is a read-only field generated by the server. */ value?: string; } + /** + * An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified. + */ + export interface Schema$WipeAction { + /** + * Whether the factory-reset protection data is preserved on the device. This setting doesn’t apply to work profiles. + */ + preserveFrp?: boolean; + /** + * Number of days the policy is non-compliant before the device or work profile is wiped. wipeAfterDays must be greater than blockAfterDays. + */ + wipeAfterDays?: number; + } export class Resource$Enterprises { context: APIRequestContext; @@ -2122,8 +1791,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.create - * @desc Creates an enterprise. This is the last step in the enterprise - * signup flow. + * @desc Creates an enterprise. This is the last step in the enterprise signup flow. * @alias androidmanagement.enterprises.create * @memberOf! () * @@ -2354,8 +2022,7 @@ export namespace androidmanagement_v1 { */ enterpriseToken?: string; /** - * The ID of the Google Cloud Platform project which will own the - * enterprise. + * The ID of the Google Cloud Platform project which will own the enterprise. */ projectId?: string; /** @@ -2391,8 +2058,7 @@ export namespace androidmanagement_v1 { */ name?: string; /** - * The field mask indicating the fields to update. If not set, all - * modifiable fields will be modified. + * The field mask indicating the fields to update. If not set, all modifiable fields will be modified. */ updateMask?: string; @@ -2490,14 +2156,11 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The preferred language for localized application info, as a BCP47 tag - * (e.g. "en-US", "de"). If not specified the default language of the - * application will be used. + * The preferred language for localized application info, as a BCP47 tag (e.g. "en-US", "de"). If not specified the default language of the application will be used. */ languageCode?: string; /** - * The name of the application in the form - * enterprises/{enterpriseId}/applications/{package_name}. + * The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}. */ name?: string; } @@ -2655,9 +2318,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.devices.issueCommand - * @desc Issues a command to a device. The Operation resource returned - * contains a Command in its metadata field. Use the get operation method to - * get the status of the command. + * @desc Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command. * @alias androidmanagement.enterprises.devices.issueCommand * @memberOf! () * @@ -2889,8 +2550,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device in the form - * enterprises/{enterpriseId}/devices/{deviceId}. + * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. */ name?: string; /** @@ -2906,8 +2566,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device in the form - * enterprises/{enterpriseId}/devices/{deviceId}. + * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. */ name?: string; } @@ -2919,8 +2578,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device in the form - * enterprises/{enterpriseId}/devices/{deviceId}. + * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. */ name?: string; @@ -2937,8 +2595,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The requested page size. The actual page size may be fixed to a min or - * max value. + * The requested page size. The actual page size may be fixed to a min or max value. */ pageSize?: number; /** @@ -2958,13 +2615,11 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device in the form - * enterprises/{enterpriseId}/devices/{deviceId}. + * The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. */ name?: string; /** - * The field mask indicating the fields to update. If not set, all - * modifiable fields will be modified. + * The field mask indicating the fields to update. If not set, all modifiable fields will be modified. */ updateMask?: string; @@ -2982,15 +2637,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.devices.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or - * other methods to check whether the cancellation succeeded or whether the - * operation completed despite cancellation. On successful cancellation, the - * operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to Code.CANCELLED. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. * @alias androidmanagement.enterprises.devices.operations.cancel * @memberOf! () * @@ -3060,10 +2707,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.devices.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns google.rpc.Code.UNIMPLEMENTED. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. * @alias androidmanagement.enterprises.devices.operations.delete * @memberOf! () * @@ -3133,9 +2777,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.devices.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias androidmanagement.enterprises.devices.operations.get * @memberOf! () * @@ -3207,15 +2849,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.devices.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: - * the name binding allows API services to override the binding to use - * different resource name schemes, such as users/x/operations. To override - * the binding, API services can add a binding such as - * "/v1/{name=users/x}/operations" to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias androidmanagement.enterprises.devices.operations.list * @memberOf! () * @@ -3436,8 +3070,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.enrollmentTokens.delete - * @desc Deletes an enrollment token. This operation invalidates the token, - * preventing its future use. + * @desc Deletes an enrollment token. This operation invalidates the token, preventing its future use. * @alias androidmanagement.enterprises.enrollmentTokens.delete * @memberOf! () * @@ -3531,8 +3164,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the enrollment token in the form - * enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. + * The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. */ name?: string; } @@ -3545,8 +3177,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.policies.delete - * @desc Deletes a policy. This operation is only permitted if no devices - * are currently referencing the policy. + * @desc Deletes a policy. This operation is only permitted if no devices are currently referencing the policy. * @alias androidmanagement.enterprises.policies.delete * @memberOf! () * @@ -3844,8 +3475,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the policy in the form - * enterprises/{enterpriseId}/policies/{policyId}. + * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. */ name?: string; } @@ -3857,8 +3487,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the policy in the form - * enterprises/{enterpriseId}/policies/{policyId}. + * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. */ name?: string; } @@ -3870,8 +3499,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The requested page size. The actual page size may be fixed to a min or - * max value. + * The requested page size. The actual page size may be fixed to a min or max value. */ pageSize?: number; /** @@ -3891,13 +3519,11 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the policy in the form - * enterprises/{enterpriseId}/policies/{policyId}. + * The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. */ name?: string; /** - * The field mask indicating the fields to update. If not set, all - * modifiable fields will be modified. + * The field mask indicating the fields to update. If not set, all modifiable fields will be modified. */ updateMask?: string; @@ -4302,8 +3928,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the web app in the form - * enterprises/{enterpriseId}/webApps/{packageName}. + * The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}. */ name?: string; } @@ -4315,8 +3940,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the web app in the form - * enterprises/{enterpriseId}/webApp/{packageName}. + * The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}. */ name?: string; } @@ -4328,8 +3952,7 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The requested page size. The actual page size may be fixed to a min or - * max value. + * The requested page size. The actual page size may be fixed to a min or max value. */ pageSize?: number; /** @@ -4349,13 +3972,11 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the web app in the form - * enterprises/{enterpriseId}/webApps/{packageName}. + * The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}. */ name?: string; /** - * The field mask indicating the fields to update. If not set, all - * modifiable fields will be modified. + * The field mask indicating the fields to update. If not set, all modifiable fields will be modified. */ updateMask?: string; @@ -4373,8 +3994,7 @@ export namespace androidmanagement_v1 { /** * androidmanagement.enterprises.webTokens.create - * @desc Creates a web token to access an embeddable managed Google Play web - * UI for a given enterprise. + * @desc Creates a web token to access an embeddable managed Google Play web UI for a given enterprise. * @alias androidmanagement.enterprises.webTokens.create * @memberOf! () * @@ -4553,17 +4173,11 @@ export namespace androidmanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The callback URL that the admin will be redirected to after successfully - * creating an enterprise. Before redirecting there the system will add a - * query parameter to this URL named enterpriseToken which will contain an - * opaque token to be used for the create enterprise request. The URL will - * be parsed then reformatted in order to add the enterpriseToken parameter, - * so there may be some minor formatting changes. + * The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes. */ callbackUrl?: string; /** - * The ID of the Google Cloud Platform project which will own the - * enterprise. + * The ID of the Google Cloud Platform project which will own the enterprise. */ projectId?: string; } diff --git a/src/apis/androidpublisher/index.ts b/src/apis/androidpublisher/index.ts index 808630ff53f..2e23842a03f 100644 --- a/src/apis/androidpublisher/index.ts +++ b/src/apis/androidpublisher/index.ts @@ -14,9 +14,8 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; - -import {androidpublisher_v1} from './v1'; import {androidpublisher_v1_1} from './v1.1'; +import {androidpublisher_v1} from './v1'; import {androidpublisher_v2} from './v2'; import {androidpublisher_v3} from './v3'; diff --git a/src/apis/androidpublisher/package.json b/src/apis/androidpublisher/package.json index a215ce5438f..7a8f0f98b30 100644 --- a/src/apis/androidpublisher/package.json +++ b/src/apis/androidpublisher/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/androidpublisher/v1.1.ts b/src/apis/androidpublisher/v1.1.ts index 340440d47c2..2fc3d6c2429 100644 --- a/src/apis/androidpublisher/v1.1.ts +++ b/src/apis/androidpublisher/v1.1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace androidpublisher_v1_1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace androidpublisher_v1_1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -96,7 +93,10 @@ export namespace androidpublisher_v1_1 { purchases: Resource$Purchases; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.inapppurchases = new Resource$Inapppurchases(this.context); this.purchases = new Resource$Purchases(this.context); @@ -104,23 +104,19 @@ export namespace androidpublisher_v1_1 { } /** - * An InappPurchase resource indicates the status of a user's inapp - * product purchase. + * An InappPurchase resource indicates the status of a user's inapp product purchase. */ export interface Schema$InappPurchase { /** - * The consumption state of the inapp product. Possible values are: - Yet - * to be consumed - Consumed + * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed */ consumptionState?: number; /** - * A developer-specified string that contains supplemental information about - * an order. + * A developer-specified string that contains supplemental information about an order. */ developerPayload?: string; /** - * This kind represents an inappPurchase object in the androidpublisher - * service. + * This kind represents an inappPurchase object in the androidpublisher service. */ kind?: string; /** @@ -128,47 +124,36 @@ export namespace androidpublisher_v1_1 { */ orderId?: string; /** - * The purchase state of the order. Possible values are: - Purchased - - * Canceled + * The purchase state of the order. Possible values are: - Purchased - Canceled */ purchaseState?: number; /** - * The time the product was purchased, in milliseconds since the epoch (Jan - * 1, 1970). + * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). */ purchaseTime?: string; /** - * The type of purchase of the inapp product. This field is only set if this - * purchase was not made using the standard in-app billing flow. Possible - * values are: - Test (i.e. purchased from a license testing account) - - * Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching - * a video ad instead of paying) + * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) */ purchaseType?: number; } /** - * A SubscriptionPurchase resource indicates the status of a user's - * subscription purchase. + * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. */ export interface Schema$SubscriptionPurchase { /** - * Whether the subscription will automatically be renewed when it reaches - * its current expiry time. + * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ autoRenewing?: boolean; /** - * Time at which the subscription was granted, in milliseconds since the - * Epoch. + * Time at which the subscription was granted, in milliseconds since the Epoch. */ initiationTimestampMsec?: string; /** - * This kind represents a subscriptionPurchase object in the - * androidpublisher service. + * This kind represents a subscriptionPurchase object in the androidpublisher service. */ kind?: string; /** - * Time at which the subscription will expire, in milliseconds since the - * Epoch. + * Time at which the subscription will expire, in milliseconds since the Epoch. */ validUntilTimestampMsec?: string; } @@ -264,8 +249,7 @@ export namespace androidpublisher_v1_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application the inapp product was sold in (for - * example, 'com.some.thing'). + * The package name of the application the inapp product was sold in (for example, 'com.some.thing'). */ packageName?: string; /** @@ -273,8 +257,7 @@ export namespace androidpublisher_v1_1 { */ productId?: string; /** - * The token provided to the user's device when the inapp product was - * purchased. + * The token provided to the user's device when the inapp product was purchased. */ token?: string; } @@ -287,8 +270,7 @@ export namespace androidpublisher_v1_1 { /** * androidpublisher.purchases.cancel - * @desc Cancels a user's subscription purchase. The subscription remains - * valid until its expiration time. + * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time. * @alias androidpublisher.purchases.cancel * @memberOf! () * @@ -361,8 +343,7 @@ export namespace androidpublisher_v1_1 { /** * androidpublisher.purchases.get - * @desc Checks whether a user's subscription purchase is valid and returns - * its expiry time. + * @desc Checks whether a user's subscription purchase is valid and returns its expiry time. * @alias androidpublisher.purchases.get * @memberOf! () * @@ -445,8 +426,7 @@ export namespace androidpublisher_v1_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -454,8 +434,7 @@ export namespace androidpublisher_v1_1 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -466,8 +445,7 @@ export namespace androidpublisher_v1_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -475,8 +453,7 @@ export namespace androidpublisher_v1_1 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } diff --git a/src/apis/androidpublisher/v1.ts b/src/apis/androidpublisher/v1.ts index de9dd89a2ce..e2c22195760 100644 --- a/src/apis/androidpublisher/v1.ts +++ b/src/apis/androidpublisher/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace androidpublisher_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace androidpublisher_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,35 +92,33 @@ export namespace androidpublisher_v1 { purchases: Resource$Purchases; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.purchases = new Resource$Purchases(this.context); } } /** - * A SubscriptionPurchase resource indicates the status of a user's - * subscription purchase. + * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. */ export interface Schema$SubscriptionPurchase { /** - * Whether the subscription will automatically be renewed when it reaches - * its current expiry time. + * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ autoRenewing?: boolean; /** - * Time at which the subscription was granted, in milliseconds since the - * Epoch. + * Time at which the subscription was granted, in milliseconds since the Epoch. */ initiationTimestampMsec?: string; /** - * This kind represents a subscriptionPurchase object in the - * androidpublisher service. + * This kind represents a subscriptionPurchase object in the androidpublisher service. */ kind?: string; /** - * Time at which the subscription will expire, in milliseconds since the - * Epoch. + * Time at which the subscription will expire, in milliseconds since the Epoch. */ validUntilTimestampMsec?: string; } @@ -136,8 +131,7 @@ export namespace androidpublisher_v1 { /** * androidpublisher.purchases.cancel - * @desc Cancels a user's subscription purchase. The subscription remains - * valid until its expiration time. + * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time. * @alias androidpublisher.purchases.cancel * @memberOf! () * @@ -210,8 +204,7 @@ export namespace androidpublisher_v1 { /** * androidpublisher.purchases.get - * @desc Checks whether a user's subscription purchase is valid and returns - * its expiry time. + * @desc Checks whether a user's subscription purchase is valid and returns its expiry time. * @alias androidpublisher.purchases.get * @memberOf! () * @@ -294,8 +287,7 @@ export namespace androidpublisher_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -303,8 +295,7 @@ export namespace androidpublisher_v1 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -315,8 +306,7 @@ export namespace androidpublisher_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -324,8 +314,7 @@ export namespace androidpublisher_v1 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index a2f2f08c847..26c85fe2d03 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace androidpublisher_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace androidpublisher_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -99,7 +96,10 @@ export namespace androidpublisher_v2 { reviews: Resource$Reviews; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.edits = new Resource$Edits(this.context); this.inappproducts = new Resource$Inappproducts(this.context); @@ -124,13 +124,11 @@ export namespace androidpublisher_v2 { */ export interface Schema$ApkBinary { /** - * A sha1 hash of the APK payload, encoded as a hex string and matching the - * output of the sha1sum command. + * A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command. */ sha1?: string; /** - * A sha256 hash of the APK payload, encoded as a hex string and matching - * the output of the sha256sum command. + * A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command. */ sha256?: string; } @@ -146,8 +144,7 @@ export namespace androidpublisher_v2 { } export interface Schema$ApkListingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#apkListingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apkListingsListResponse". */ kind?: string; listings?: Schema$ApkListing[]; @@ -167,8 +164,7 @@ export namespace androidpublisher_v2 { export interface Schema$ApksListResponse { apks?: Schema$Apk[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#apksListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse". */ kind?: string; } @@ -191,13 +187,11 @@ export namespace androidpublisher_v2 { defaultLanguage?: string; } /** - * Represents an edit of an app. An edit allows clients to make multiple - * changes before committing them in one operation. + * Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation. */ export interface Schema$AppEdit { /** - * The time at which the edit will expire and will be no longer valid for - * use in any subsequent API calls (encoded as seconds since the Epoch). + * The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch). */ expiryTimeSeconds?: string; /** @@ -207,26 +201,22 @@ export namespace androidpublisher_v2 { } export interface Schema$Bundle { /** - * A sha1 hash of the upload payload, encoded as a hex string and matching - * the output of the sha1sum command. + * A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command. */ sha1?: string; /** - * A sha256 hash of the upload payload, encoded as a hex string and matching - * the output of the sha256sum command. + * A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command. */ sha256?: string; /** - * The version code of the Android App Bundle. As specified in the Android - * App Bundle's base module APK manifest file. + * The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file. */ versionCode?: number; } export interface Schema$BundlesListResponse { bundles?: Schema$Bundle[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#bundlesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#bundlesListResponse". */ kind?: string; } @@ -284,8 +274,7 @@ export namespace androidpublisher_v2 { */ manufacturer?: string; /** - * Comma separated list of native platforms (e.g. "arm", - * "arm7") + * Comma separated list of native platforms (e.g. "arm", "arm7") */ nativePlatform?: string; /** @@ -311,14 +300,11 @@ export namespace androidpublisher_v2 { } export interface Schema$ExpansionFile { /** - * If set this field indicates that this APK has an Expansion File uploaded - * to it: this APK does not reference another APK's Expansion File. The - * field's value is the size of the uploaded Expansion File in bytes. + * If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes. */ fileSize?: string; /** - * If set this APK's Expansion File references another APK's - * Expansion File. The file_size field will not be set. + * If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set. */ referencesVersion?: number; } @@ -326,10 +312,7 @@ export namespace androidpublisher_v2 { expansionFile?: Schema$ExpansionFile; } /** - * Defines an APK available for this application that is hosted externally and - * not uploaded to Google Play. This function is only available to enterprises - * who are using Google Play for Work, and whos application is restricted to - * the enterprise private channel + * Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel */ export interface Schema$ExternallyHostedApk { /** @@ -337,8 +320,7 @@ export namespace androidpublisher_v2 { */ applicationLabel?: string; /** - * A certificate (or array of certificates if a certificate-chain is used) - * used to signed this APK, represented as a base64 encoded byte array. + * A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array. */ certificateBase64s?: string[]; /** @@ -346,13 +328,11 @@ export namespace androidpublisher_v2 { */ externallyHostedUrl?: string; /** - * The SHA1 checksum of this APK, represented as a base64 encoded byte - * array. + * The SHA1 checksum of this APK, represented as a base64 encoded byte array. */ fileSha1Base64?: string; /** - * The SHA256 checksum of this APK, represented as a base64 encoded byte - * array. + * The SHA256 checksum of this APK, represented as a base64 encoded byte array. */ fileSha256Base64?: string; /** @@ -434,20 +414,15 @@ export namespace androidpublisher_v2 { } export interface Schema$InAppProduct { /** - * The default language of the localized data, as defined by BCP 47. e.g. - * "en-US", "en-GB". + * The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". */ defaultLanguage?: string; /** - * Default price cannot be zero. In-app products can never be free. Default - * price is always in the developer's Checkout merchant currency. + * Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. */ defaultPrice?: Schema$Price; /** - * Grace period of the subscription, specified in ISO 8601 format. It will - * allow developers to give their subscribers a grace period when the - * payment for the new recurrence period is declined. Acceptable values = - * "P3D" (three days) and "P7D" (seven days) + * Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days) */ gracePeriod?: string; /** @@ -459,8 +434,7 @@ export namespace androidpublisher_v2 { */ packageName?: string; /** - * Prices per buyer region. None of these prices should be zero. In-app - * products can never be free. + * Prices per buyer region. None of these prices should be zero. In-app products can never be free. */ prices?: {[key: string]: Schema$Price}; /** @@ -468,8 +442,7 @@ export namespace androidpublisher_v2 { */ purchaseType?: string; /** - * Definition of a season for a seasonal subscription. Can be defined only - * for yearly subscriptions. + * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. */ season?: Schema$Season; /** @@ -478,16 +451,11 @@ export namespace androidpublisher_v2 { sku?: string; status?: string; /** - * Subscription period, specified in ISO 8601 format. Acceptable values are - * "P1W" (one week), "P1M" (one month), "P3M" - * (three months), "P6M" (six months), and "P1Y" (one - * year). + * Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). */ subscriptionPeriod?: string; /** - * Trial period, specified in ISO 8601 format. Acceptable values are - * anything between "P7D" (seven days) and "P999D" (999 - * days). Seasonal subscriptions cannot have a trial period. + * Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. */ trialPeriod?: string; } @@ -498,8 +466,7 @@ export namespace androidpublisher_v2 { export interface Schema$InappproductsListResponse { inappproduct?: Schema$InAppProduct[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#inappproductsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse". */ kind?: string; pageInfo?: Schema$PageInfo; @@ -511,13 +478,11 @@ export namespace androidpublisher_v2 { */ fullDescription?: string; /** - * Language localization code (for example, "de-AT" for Austrian - * German). + * Language localization code (for example, "de-AT" for Austrian German). */ language?: string; /** - * Short description of the app (previously known as promo text); this may - * be up to 80 characters in length. + * Short description of the app (previously known as promo text); this may be up to 80 characters in length. */ shortDescription?: string; /** @@ -531,16 +496,14 @@ export namespace androidpublisher_v2 { } export interface Schema$ListingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#listingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse". */ kind?: string; listings?: Schema$Listing[]; } export interface Schema$MonthDay { /** - * Day of a month, value in [1, 31] range. Valid range depends on the - * specified month. + * Day of a month, value in [1, 31] range. Valid range depends on the specified month. */ day?: number; /** @@ -559,29 +522,24 @@ export namespace androidpublisher_v2 { */ currency?: string; /** - * The price in millionths of the currency base unit represented as a - * string. + * The price in millionths of the currency base unit represented as a string. */ priceMicros?: string; } /** - * A ProductPurchase resource indicates the status of a user's inapp - * product purchase. + * A ProductPurchase resource indicates the status of a user's inapp product purchase. */ export interface Schema$ProductPurchase { /** - * The consumption state of the inapp product. Possible values are: - Yet - * to be consumed - Consumed + * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed */ consumptionState?: number; /** - * A developer-specified string that contains supplemental information about - * an order. + * A developer-specified string that contains supplemental information about an order. */ developerPayload?: string; /** - * This kind represents an inappPurchase object in the androidpublisher - * service. + * This kind represents an inappPurchase object in the androidpublisher service. */ kind?: string; /** @@ -589,30 +547,21 @@ export namespace androidpublisher_v2 { */ orderId?: string; /** - * The purchase state of the order. Possible values are: - Purchased - - * Canceled + * The purchase state of the order. Possible values are: - Purchased - Canceled */ purchaseState?: number; /** - * The time the product was purchased, in milliseconds since the epoch (Jan - * 1, 1970). + * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). */ purchaseTimeMillis?: string; /** - * The type of purchase of the inapp product. This field is only set if this - * purchase was not made using the standard in-app billing flow. Possible - * values are: - Test (i.e. purchased from a license testing account) - - * Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching - * a video ad instead of paying) + * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) */ purchaseType?: number; } export interface Schema$Prorate { /** - * Default price cannot be zero and must be less than the full subscription - * price. Default price is always in the developer's Checkout merchant - * currency. Targeted countries have their prices set automatically based on - * the default_price. + * Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. */ defaultPrice?: Schema$Price; /** @@ -651,8 +600,7 @@ export namespace androidpublisher_v2 { } export interface Schema$ReviewsReplyRequest { /** - * The text to set as the reply. Replies of more than approximately 350 - * characters will be rejected. HTML tags will be stripped. + * The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped. */ replyText?: string; } @@ -665,10 +613,7 @@ export namespace androidpublisher_v2 { */ end?: Schema$MonthDay; /** - * Optionally present list of prorations for the season. Each proration is a - * one-off discounted entry into a subscription. Each proration contains the - * first date on which the discount is available and the new pricing - * information. + * Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. */ prorations?: Schema$Prorate[]; /** @@ -677,189 +622,130 @@ export namespace androidpublisher_v2 { start?: Schema$MonthDay; } /** - * Information provided by the user when they complete the subscription - * cancellation flow (cancellation reason survey). + * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ export interface Schema$SubscriptionCancelSurveyResult { /** - * The cancellation reason the user chose in the survey. Possible values - * are: - Other - I don't use this service enough - Technical issues - * - Cost-related reasons - I found a better app + * The cancellation reason the user chose in the survey. Possible values are: - Other - I don't use this service enough - Technical issues - Cost-related reasons - I found a better app */ cancelSurveyReason?: number; /** - * The customized input cancel reason from the user. Only present when - * cancelReason is 0. + * The customized input cancel reason from the user. Only present when cancelReason is 0. */ userInputCancelReason?: string; } /** - * A SubscriptionDeferralInfo contains the data needed to defer a subscription - * purchase to a future expiry time. + * A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time. */ export interface Schema$SubscriptionDeferralInfo { /** - * The desired next expiry time to assign to the subscription, in - * milliseconds since the Epoch. The given time must be later/greater than - * the current expiry time for the subscription. + * The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription. */ desiredExpiryTimeMillis?: string; /** - * The expected expiry time for the subscription. If the current expiry time - * for the subscription is not the value specified here, the deferral will - * not occur. + * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur. */ expectedExpiryTimeMillis?: string; } /** - * Contains the price change information for a subscription that can be used - * to control the user journey for the price change in the app. This can be in - * the form of seeking confirmation from the user or tailoring the experience - * for a successful conversion. + * Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion. */ export interface Schema$SubscriptionPriceChange { /** - * The new price the subscription will renew with if the price change is - * accepted by the user. + * The new price the subscription will renew with if the price change is accepted by the user. */ newPrice?: Schema$Price; /** - * The current state of the price change. Possible values are: - - * Outstanding: State for a pending price change waiting for the user to - * agree. In this state, you can optionally seek confirmation from the user - * using the In-App API. - Accepted: State for an accepted price change - * that the subscription will renew with unless it's canceled. The price - * change takes effect on a future date when the subscription renews. Note - * that the change might not occur when the subscription is renewed next. + * The current state of the price change. Possible values are: - Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. - Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next. */ state?: number; } /** - * A SubscriptionPurchase resource indicates the status of a user's - * subscription purchase. + * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. */ export interface Schema$SubscriptionPurchase { /** - * Whether the subscription will automatically be renewed when it reaches - * its current expiry time. + * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ autoRenewing?: boolean; /** - * The reason why a subscription was canceled or is not auto-renewing. - * Possible values are: - User canceled the subscription - Subscription - * was canceled by the system, for example because of a billing problem - - * Subscription was replaced with a new subscription - Subscription was - * canceled by the developer + * The reason why a subscription was canceled or is not auto-renewing. Possible values are: - User canceled the subscription - Subscription was canceled by the system, for example because of a billing problem - Subscription was replaced with a new subscription - Subscription was canceled by the developer */ cancelReason?: number; /** - * Information provided by the user when they complete the subscription - * cancellation flow (cancellation reason survey). + * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ cancelSurveyResult?: Schema$SubscriptionCancelSurveyResult; /** - * ISO 3166-1 alpha-2 billing country/region code of the user at the time - * the subscription was granted. + * ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted. */ countryCode?: string; /** - * A developer-specified string that contains supplemental information about - * an order. + * A developer-specified string that contains supplemental information about an order. */ developerPayload?: string; /** - * The email address of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ emailAddress?: string; /** - * Time at which the subscription will expire, in milliseconds since the - * Epoch. + * Time at which the subscription will expire, in milliseconds since the Epoch. */ expiryTimeMillis?: string; /** - * The family name of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ familyName?: string; /** - * The given name of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ givenName?: string; /** - * This kind represents a subscriptionPurchase object in the - * androidpublisher service. + * This kind represents a subscriptionPurchase object in the androidpublisher service. */ kind?: string; /** - * The purchase token of the originating purchase if this subscription is - * one of the following: - Re-signup of a canceled but non-lapsed - * subscription - Upgrade/downgrade from a previous subscription For - * example, suppose a user originally signs up and you receive purchase - * token X, then the user cancels and goes through the resignup flow (before - * their subscription lapses) and you receive purchase token Y, and finally - * the user upgrades their subscription and you receive purchase token Z. If - * you call this API with purchase token Z, this field will be set to Y. If - * you call this API with purchase token Y, this field will be set to X. If - * you call this API with purchase token X, this field will not be set. + * The purchase token of the originating purchase if this subscription is one of the following: - Re-signup of a canceled but non-lapsed subscription - Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set. */ linkedPurchaseToken?: string; /** - * The order id of the latest recurring order associated with the purchase - * of the subscription. + * The order id of the latest recurring order associated with the purchase of the subscription. */ orderId?: string; /** - * The payment state of the subscription. Possible values are: - Payment - * pending - Payment received - Free trial - Pending deferred - * upgrade/downgrade + * The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade */ paymentState?: number; /** - * Price of the subscription, not including tax. Price is expressed in - * micro-units, where 1,000,000 micro-units represents one unit of the - * currency. For example, if the subscription price is €1.99, - * price_amount_micros is 1990000. + * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. */ priceAmountMicros?: string; /** - * The latest price change information available. This is present only when - * there is an upcoming price change for the subscription yet to be applied. - * Once the subscription renews with the new price or the subscription is - * canceled, no price change information will be returned. + * The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned. */ priceChange?: Schema$SubscriptionPriceChange; /** - * ISO 4217 currency code for the subscription price. For example, if the - * price is specified in British pounds sterling, price_currency_code is - * "GBP". + * ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP". */ priceCurrencyCode?: string; /** - * The profile id of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ profileId?: string; /** - * The profile name of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ profileName?: string; /** - * The type of purchase of the subscription. This field is only set if this - * purchase was not made using the standard in-app billing flow. Possible - * values are: - Test (i.e. purchased from a license testing account) + * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) */ purchaseType?: number; /** - * Time at which the subscription was granted, in milliseconds since the - * Epoch. + * Time at which the subscription was granted, in milliseconds since the Epoch. */ startTimeMillis?: string; /** - * The time at which the subscription was canceled by the user, in - * milliseconds since the epoch. Only present if cancelReason is 0. + * The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0. */ userCancellationTimeMillis?: string; } @@ -894,39 +780,32 @@ export namespace androidpublisher_v2 { track?: string; userFraction?: number; /** - * Version codes to make active on this track. Note that this list should - * contain all versions you wish to be active, including those you wish to - * retain from previous releases. + * Version codes to make active on this track. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. */ versionCodes?: number[]; } export interface Schema$TracksListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#tracksListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse". */ kind?: string; tracks?: Schema$Track[]; } export interface Schema$UserComment { /** - * Integer Android SDK version of the user's device at the time the - * review was written, e.g. 23 is Marshmallow. May be absent. + * Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent. */ androidOsVersion?: number; /** - * Integer version code of the app as installed at the time the review was - * written. May be absent. + * Integer version code of the app as installed at the time the review was written. May be absent. */ appVersionCode?: number; /** - * String version name of the app as installed at the time the review was - * written. May be absent. + * String version name of the app as installed at the time the review was written. May be absent. */ appVersionName?: string; /** - * Codename for the reviewer's device, e.g. klte, flounder. May be - * absent. + * Codename for the reviewer's device, e.g. klte, flounder. May be absent. */ device?: string; /** @@ -938,14 +817,11 @@ export namespace androidpublisher_v2 { */ lastModified?: Schema$Timestamp; /** - * Untranslated text of the review, in the case where the review has been - * translated. If the review has not been translated this is left blank. + * Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank. */ originalText?: string; /** - * Language code for the reviewer. This is taken from the device settings so - * is not guaranteed to match the language the review is written in. May be - * absent. + * Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent. */ reviewerLanguage?: string; /** @@ -953,9 +829,7 @@ export namespace androidpublisher_v2 { */ starRating?: number; /** - * The content of the comment, i.e. review body. In some cases users have - * been able to write a review with separate title and body; in those cases - * the title and body are concatenated and separated by a tab character. + * The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character. */ text?: string; /** @@ -968,28 +842,23 @@ export namespace androidpublisher_v2 { thumbsUpCount?: number; } /** - * A VoidedPurchase resource indicates a purchase that was either - * canceled/refunded/charged-back. + * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back. */ export interface Schema$VoidedPurchase { /** - * This kind represents a voided purchase object in the androidpublisher - * service. + * This kind represents a voided purchase object in the androidpublisher service. */ kind?: string; /** - * The time at which the purchase was made, in milliseconds since the epoch - * (Jan 1, 1970). + * The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970). */ purchaseTimeMillis?: string; /** - * The token that was generated when a purchase was made. This uniquely - * identifies a purchase. + * The token that was generated when a purchase was made. This uniquely identifies a purchase. */ purchaseToken?: string; /** - * The time at which the purchase was canceled/refunded/charged-back, in - * milliseconds since the epoch (Jan 1, 1970). + * The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970). */ voidedTimeMillis?: string; } @@ -1101,9 +970,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.delete - * @desc Deletes an edit for an app. Creating a new edit will automatically - * delete any of your previous edits so this method need only be called if - * you want to preemptively abandon an edit. + * @desc Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit. * @alias androidpublisher.edits.delete * @memberOf! () * @@ -1175,9 +1042,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.get - * @desc Returns information about the edit specified. Calls will fail if - * the edit is no long active (e.g. has been deleted, superseded or - * expired). + * @desc Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired). * @alias androidpublisher.edits.get * @memberOf! () * @@ -1249,8 +1114,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.insert - * @desc Creates a new edit for an app, populated with the app's current - * state. + * @desc Creates a new edit for an app, populated with the app's current state. * @alias androidpublisher.edits.insert * @memberOf! () * @@ -1321,8 +1185,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.validate - * @desc Checks that the edit can be successfully committed. The edit's - * changes are not applied to the live app. + * @desc Checks that the edit can be successfully committed. The edit's changes are not applied to the live app. * @alias androidpublisher.edits.validate * @memberOf! () * @@ -1404,8 +1267,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1420,8 +1282,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1436,8 +1297,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1448,8 +1308,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -1469,8 +1328,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1483,8 +1341,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.apklistings.delete - * @desc Deletes the APK-specific localized listing for a specified APK and - * language code. + * @desc Deletes the APK-specific localized listing for a specified APK and language code. * @alias androidpublisher.edits.apklistings.delete * @memberOf! () * @@ -1559,8 +1416,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.apklistings.deleteall - * @desc Deletes all the APK-specific localized listings for a specified - * APK. + * @desc Deletes all the APK-specific localized listings for a specified APK. * @alias androidpublisher.edits.apklistings.deleteall * @memberOf! () * @@ -1634,8 +1490,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.apklistings.get - * @desc Fetches the APK-specific localized listing for a specified APK and - * language code. + * @desc Fetches the APK-specific localized listing for a specified APK and language code. * @alias androidpublisher.edits.apklistings.get * @memberOf! () * @@ -1790,8 +1645,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.apklistings.patch - * @desc Updates or creates the APK-specific localized listing for a - * specified APK and language code. This method supports patch semantics. + * @desc Updates or creates the APK-specific localized listing for a specified APK and language code. This method supports patch semantics. * @alias androidpublisher.edits.apklistings.patch * @memberOf! () * @@ -1869,8 +1723,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.apklistings.update - * @desc Updates or creates the APK-specific localized listing for a - * specified APK and language code. + * @desc Updates or creates the APK-specific localized listing for a specified APK and language code. * @alias androidpublisher.edits.apklistings.update * @memberOf! () * @@ -1955,8 +1808,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The APK version code whose APK-specific listings should be read or - * modified. + * The APK version code whose APK-specific listings should be read or modified. */ apkVersionCode?: number; /** @@ -1964,14 +1816,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the APK-specific localized - * listing to read or modify. For example, to select Austrian German, pass - * "de-AT". + * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1983,8 +1832,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The APK version code whose APK-specific listings should be read or - * modified. + * The APK version code whose APK-specific listings should be read or modified. */ apkVersionCode?: number; /** @@ -1992,8 +1840,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2005,8 +1852,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The APK version code whose APK-specific listings should be read or - * modified. + * The APK version code whose APK-specific listings should be read or modified. */ apkVersionCode?: number; /** @@ -2014,14 +1860,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the APK-specific localized - * listing to read or modify. For example, to select Austrian German, pass - * "de-AT". + * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2033,8 +1876,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The APK version code whose APK-specific listings should be read or - * modified. + * The APK version code whose APK-specific listings should be read or modified. */ apkVersionCode?: number; /** @@ -2042,8 +1884,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2055,8 +1896,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The APK version code whose APK-specific listings should be read or - * modified. + * The APK version code whose APK-specific listings should be read or modified. */ apkVersionCode?: number; /** @@ -2064,14 +1904,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the APK-specific localized - * listing to read or modify. For example, to select Austrian German, pass - * "de-AT". + * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2088,8 +1925,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The APK version code whose APK-specific listings should be read or - * modified. + * The APK version code whose APK-specific listings should be read or modified. */ apkVersionCode?: number; /** @@ -2097,14 +1933,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the APK-specific localized - * listing to read or modify. For example, to select Austrian German, pass - * "de-AT". + * The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2122,10 +1955,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.apks.addexternallyhosted - * @desc Creates a new APK without uploading the APK itself to Google Play, - * instead hosting the APK at a specified URL. This function is only - * available to enterprises using Google Play for Work whose application is - * configured to restrict distribution to the enterprise domain. + * @desc Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain. * @alias androidpublisher.edits.apks.addexternallyhosted * @memberOf! () * @@ -2373,8 +2203,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2394,8 +2223,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2411,8 +2239,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2514,12 +2341,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.bundles.upload - * @desc Uploads a new Android App Bundle to this edit. If you are using the - * Google API client libraries, please increase the timeout of the http - * request before calling this endpoint (a timeout of 2 minutes is - * recommended). See: - * https://developers.google.com/api-client-library/java/google-api-java-client/errors - * for an example in java. + * @desc Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java. * @alias androidpublisher.edits.bundles.upload * @memberOf! () * @@ -2611,8 +2433,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2624,9 +2445,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Must be set to true if the bundle installation may trigger a warning on - * user devices (for example, if installation size may be over a threshold, - * typically 100 MB). + * Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB). */ ackBundleInstallationWarning?: boolean; /** @@ -2634,8 +2453,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2663,8 +2481,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.deobfuscationfiles.upload - * @desc Uploads the deobfuscation file of the specified APK. If a - * deobfuscation file already exists, it will be replaced. + * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced. * @alias androidpublisher.edits.deobfuscationfiles.upload * @memberOf! () * @@ -2786,8 +2603,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier of the Android app for which the deobfuscatiuon files - * are being uploaded; for example, "com.spiffygame". + * Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". */ packageName?: string; @@ -2815,8 +2631,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.details.get - * @desc Fetches app details for this edit. This includes the default - * language and developer support contact information. + * @desc Fetches app details for this edit. This includes the default language and developer support contact information. * @alias androidpublisher.edits.details.get * @memberOf! () * @@ -2891,8 +2706,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.details.patch - * @desc Updates app details for this edit. This method supports patch - * semantics. + * @desc Updates app details for this edit. This method supports patch semantics. * @alias androidpublisher.edits.details.patch * @memberOf! () * @@ -3055,8 +2869,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3072,8 +2885,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -3094,8 +2906,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -3200,9 +3011,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.expansionfiles.patch - * @desc Updates the APK's Expansion File configuration to reference another - * APK's Expansion Files. To add a new Expansion File use the Upload method. - * This method supports patch semantics. + * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics. * @alias androidpublisher.edits.expansionfiles.patch * @memberOf! () * @@ -3290,8 +3099,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.expansionfiles.update - * @desc Updates the APK's Expansion File configuration to reference another - * APK's Expansion Files. To add a new Expansion File use the Upload method. + * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. * @alias androidpublisher.edits.expansionfiles.update * @memberOf! () * @@ -3489,8 +3297,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -3502,8 +3309,7 @@ export namespace androidpublisher_v2 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3515,8 +3321,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -3528,8 +3333,7 @@ export namespace androidpublisher_v2 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -3546,8 +3350,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -3559,8 +3362,7 @@ export namespace androidpublisher_v2 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -3577,8 +3379,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -3590,8 +3391,7 @@ export namespace androidpublisher_v2 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -3865,8 +3665,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.images.upload - * @desc Uploads a new image and adds it to the list of images for the - * specified language and image type. + * @desc Uploads a new image and adds it to the list of images for the specified language and image type. * @alias androidpublisher.edits.images.upload * @memberOf! () * @@ -3963,8 +3762,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier an image within the set of images attached to this - * edit. + * Unique identifier an image within the set of images attached to this edit. */ imageId?: string; /** @@ -3972,14 +3770,11 @@ export namespace androidpublisher_v2 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3999,14 +3794,11 @@ export namespace androidpublisher_v2 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4026,14 +3818,11 @@ export namespace androidpublisher_v2 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4053,14 +3842,11 @@ export namespace androidpublisher_v2 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -4386,8 +4172,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.listings.patch - * @desc Creates or updates a localized store listing. This method supports - * patch semantics. + * @desc Creates or updates a localized store listing. This method supports patch semantics. * @alias androidpublisher.edits.listings.patch * @memberOf! () * @@ -4548,13 +4333,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4570,8 +4353,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4587,13 +4369,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4609,8 +4389,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4626,13 +4405,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -4653,13 +4430,11 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -4909,8 +4684,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4930,8 +4704,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4956,8 +4729,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4979,8 +4751,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.tracks.get - * @desc Fetches the track configuration for the specified track type. - * Includes the APK version codes that are in this track. + * @desc Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track. * @alias androidpublisher.edits.tracks.get * @memberOf! () * @@ -5128,8 +4899,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.tracks.patch - * @desc Updates the track configuration for the specified track type. This - * method supports patch semantics. + * @desc Updates the track configuration for the specified track type. This method supports patch semantics. * @alias androidpublisher.edits.tracks.patch * @memberOf! () * @@ -5289,8 +5059,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -5310,8 +5079,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -5327,8 +5095,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -5353,8 +5120,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -5600,8 +5366,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.inappproducts.list - * @desc List all the in-app products for an Android app, both subscriptions - * and managed in-app products.. + * @desc List all the in-app products for an Android app, both subscriptions and managed in-app products.. * @alias androidpublisher.inappproducts.list * @memberOf! () * @@ -5685,8 +5450,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.inappproducts.patch - * @desc Updates the details of an in-app product. This method supports - * patch semantics. + * @desc Updates the details of an in-app product. This method supports patch semantics. * @alias androidpublisher.inappproducts.patch * @memberOf! () * @@ -5847,8 +5611,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app with the in-app product; for - * example, "com.spiffygame". + * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". */ packageName?: string; /** @@ -5880,9 +5643,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true the prices for all regions targeted by the parent app that don't - * have a price specified for this in-app product will be auto converted to - * the target currency based on the default price. Defaults to false. + * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. */ autoConvertMissingPrices?: boolean; /** @@ -5907,8 +5668,7 @@ export namespace androidpublisher_v2 { */ maxResults?: number; /** - * Unique identifier for the Android app with in-app products; for example, - * "com.spiffygame". + * Unique identifier for the Android app with in-app products; for example, "com.spiffygame". */ packageName?: string; /** @@ -5928,14 +5688,11 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true the prices for all regions targeted by the parent app that don't - * have a price specified for this in-app product will be auto converted to - * the target currency based on the default price. Defaults to false. + * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. */ autoConvertMissingPrices?: boolean; /** - * Unique identifier for the Android app with the in-app product; for - * example, "com.spiffygame". + * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". */ packageName?: string; /** @@ -5956,14 +5713,11 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true the prices for all regions targeted by the parent app that don't - * have a price specified for this in-app product will be auto converted to - * the target currency based on the default price. Defaults to false. + * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. */ autoConvertMissingPrices?: boolean; /** - * Unique identifier for the Android app with the in-app product; for - * example, "com.spiffygame". + * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". */ packageName?: string; /** @@ -6064,20 +5818,15 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The order ID provided to the user when the subscription or in-app order - * was purchased. + * The order ID provided to the user when the subscription or in-app order was purchased. */ orderId?: string; /** - * The package name of the application for which this subscription or in-app - * item was purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). */ packageName?: string; /** - * Whether to revoke the purchased item. If set to true, access to the - * subscription or in-app item will be terminated immediately. If the item - * is a recurring subscription, all future payments will also be terminated. - * Consumed in-app items need to be handled by developer's app. (optional) + * Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional) */ revoke?: boolean; } @@ -6188,8 +5937,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application the inapp product was sold in (for - * example, 'com.some.thing'). + * The package name of the application the inapp product was sold in (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6197,8 +5945,7 @@ export namespace androidpublisher_v2 { */ productId?: string; /** - * The token provided to the user's device when the inapp product was - * purchased. + * The token provided to the user's device when the inapp product was purchased. */ token?: string; } @@ -6211,8 +5958,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.purchases.subscriptions.cancel - * @desc Cancels a user's subscription purchase. The subscription remains - * valid until its expiration time. + * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time. * @alias androidpublisher.purchases.subscriptions.cancel * @memberOf! () * @@ -6286,8 +6032,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.purchases.subscriptions.defer - * @desc Defers a user's subscription purchase until a specified future - * expiration time. + * @desc Defers a user's subscription purchase until a specified future expiration time. * @alias androidpublisher.purchases.subscriptions.defer * @memberOf! () * @@ -6373,8 +6118,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.purchases.subscriptions.get - * @desc Checks whether a user's subscription purchase is valid and returns - * its expiry time. + * @desc Checks whether a user's subscription purchase is valid and returns its expiry time. * @alias androidpublisher.purchases.subscriptions.get * @memberOf! () * @@ -6452,8 +6196,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.purchases.subscriptions.refund - * @desc Refunds a user's subscription purchase, but the subscription - * remains valid until its expiration time and it will continue to recur. + * @desc Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur. * @alias androidpublisher.purchases.subscriptions.refund * @memberOf! () * @@ -6527,9 +6270,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.purchases.subscriptions.revoke - * @desc Refunds and immediately revokes a user's subscription purchase. - * Access to the subscription will be terminated immediately and it will - * stop recurring. + * @desc Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring. * @alias androidpublisher.purchases.subscriptions.revoke * @memberOf! () * @@ -6610,8 +6351,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6619,8 +6359,7 @@ export namespace androidpublisher_v2 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6632,8 +6371,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6641,8 +6379,7 @@ export namespace androidpublisher_v2 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; @@ -6659,8 +6396,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6668,8 +6404,7 @@ export namespace androidpublisher_v2 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6681,8 +6416,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6690,8 +6424,7 @@ export namespace androidpublisher_v2 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6703,8 +6436,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6712,8 +6444,7 @@ export namespace androidpublisher_v2 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6819,12 +6550,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The time, in milliseconds since the Epoch, of the newest voided in-app - * product purchase that you want to see in the response. The value of this - * parameter cannot be greater than the current time and is ignored if a - * pagination token is set. Default value is current time. Note: This filter - * is applied on the time at which the record is seen as voided by our - * systems and not the actual voided time returned in the response. + * The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. */ endTime?: string; /** @@ -6832,8 +6558,7 @@ export namespace androidpublisher_v2 { */ maxResults?: number; /** - * The package name of the application for which voided purchases need to be - * returned (for example, 'com.some.thing'). + * The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6841,12 +6566,7 @@ export namespace androidpublisher_v2 { */ startIndex?: number; /** - * The time, in milliseconds since the Epoch, of the oldest voided in-app - * product purchase that you want to see in the response. The value of this - * parameter cannot be older than 30 days and is ignored if a pagination - * token is set. Default value is current time minus 30 days. Note: This - * filter is applied on the time at which the record is seen as voided by - * our systems and not the actual voided time returned in the response. + * The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. */ startTime?: string; /** @@ -6936,8 +6656,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.reviews.list - * @desc Returns a list of reviews. Only reviews from last week will be - * returned. + * @desc Returns a list of reviews. Only reviews from last week will be returned. * @alias androidpublisher.reviews.list * @memberOf! () * @@ -7097,8 +6816,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app for which we want reviews; for - * example, "com.spiffygame". + * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". */ packageName?: string; /** @@ -7121,8 +6839,7 @@ export namespace androidpublisher_v2 { */ maxResults?: number; /** - * Unique identifier for the Android app for which we want reviews; for - * example, "com.spiffygame". + * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". */ packageName?: string; /** @@ -7145,8 +6862,7 @@ export namespace androidpublisher_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app for which we want reviews; for - * example, "com.spiffygame". + * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". */ packageName?: string; /** diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 40b362b8cee..8fe032dc6ce 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace androidpublisher_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace androidpublisher_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -94,15 +91,22 @@ export namespace androidpublisher_v3 { context: APIRequestContext; edits: Resource$Edits; inappproducts: Resource$Inappproducts; + internalappsharingartifacts: Resource$Internalappsharingartifacts; orders: Resource$Orders; purchases: Resource$Purchases; reviews: Resource$Reviews; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.edits = new Resource$Edits(this.context); this.inappproducts = new Resource$Inappproducts(this.context); + this.internalappsharingartifacts = new Resource$Internalappsharingartifacts( + this.context + ); this.orders = new Resource$Orders(this.context); this.purchases = new Resource$Purchases(this.context); this.reviews = new Resource$Reviews(this.context); @@ -124,13 +128,11 @@ export namespace androidpublisher_v3 { */ export interface Schema$ApkBinary { /** - * A sha1 hash of the APK payload, encoded as a hex string and matching the - * output of the sha1sum command. + * A sha1 hash of the APK payload, encoded as a hex string and matching the output of the sha1sum command. */ sha1?: string; /** - * A sha256 hash of the APK payload, encoded as a hex string and matching - * the output of the sha256sum command. + * A sha256 hash of the APK payload, encoded as a hex string and matching the output of the sha256sum command. */ sha256?: string; } @@ -149,8 +151,7 @@ export namespace androidpublisher_v3 { export interface Schema$ApksListResponse { apks?: Schema$Apk[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#apksListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#apksListResponse". */ kind?: string; } @@ -173,13 +174,11 @@ export namespace androidpublisher_v3 { defaultLanguage?: string; } /** - * Represents an edit of an app. An edit allows clients to make multiple - * changes before committing them in one operation. + * Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation. */ export interface Schema$AppEdit { /** - * The time at which the edit will expire and will be no longer valid for - * use in any subsequent API calls (encoded as seconds since the Epoch). + * The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch). */ expiryTimeSeconds?: string; /** @@ -189,26 +188,22 @@ export namespace androidpublisher_v3 { } export interface Schema$Bundle { /** - * A sha1 hash of the upload payload, encoded as a hex string and matching - * the output of the sha1sum command. + * A sha1 hash of the upload payload, encoded as a hex string and matching the output of the sha1sum command. */ sha1?: string; /** - * A sha256 hash of the upload payload, encoded as a hex string and matching - * the output of the sha256sum command. + * A sha256 hash of the upload payload, encoded as a hex string and matching the output of the sha256sum command. */ sha256?: string; /** - * The version code of the Android App Bundle. As specified in the Android - * App Bundle's base module APK manifest file. + * The version code of the Android App Bundle. As specified in the Android App Bundle's base module APK manifest file. */ versionCode?: number; } export interface Schema$BundlesListResponse { bundles?: Schema$Bundle[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#bundlesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#bundlesListResponse". */ kind?: string; } @@ -270,8 +265,7 @@ export namespace androidpublisher_v3 { */ manufacturer?: string; /** - * Comma separated list of native platforms (e.g. "arm", - * "arm7") + * Comma separated list of native platforms (e.g. "arm", "arm7") */ nativePlatform?: string; /** @@ -297,14 +291,11 @@ export namespace androidpublisher_v3 { } export interface Schema$ExpansionFile { /** - * If set this field indicates that this APK has an Expansion File uploaded - * to it: this APK does not reference another APK's Expansion File. The - * field's value is the size of the uploaded Expansion File in bytes. + * If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes. */ fileSize?: string; /** - * If set this APK's Expansion File references another APK's - * Expansion File. The file_size field will not be set. + * If set this APK's Expansion File references another APK's Expansion File. The file_size field will not be set. */ referencesVersion?: number; } @@ -312,10 +303,7 @@ export namespace androidpublisher_v3 { expansionFile?: Schema$ExpansionFile; } /** - * Defines an APK available for this application that is hosted externally and - * not uploaded to Google Play. This function is only available to enterprises - * who are using Google Play for Work, and whos application is restricted to - * the enterprise private channel + * Defines an APK available for this application that is hosted externally and not uploaded to Google Play. This function is only available to enterprises who are using Google Play for Work, and whos application is restricted to the enterprise private channel */ export interface Schema$ExternallyHostedApk { /** @@ -323,8 +311,7 @@ export namespace androidpublisher_v3 { */ applicationLabel?: string; /** - * A certificate (or array of certificates if a certificate-chain is used) - * used to signed this APK, represented as a base64 encoded byte array. + * A certificate (or array of certificates if a certificate-chain is used) used to signed this APK, represented as a base64 encoded byte array. */ certificateBase64s?: string[]; /** @@ -332,13 +319,11 @@ export namespace androidpublisher_v3 { */ externallyHostedUrl?: string; /** - * The SHA1 checksum of this APK, represented as a base64 encoded byte - * array. + * The SHA1 checksum of this APK, represented as a base64 encoded byte array. */ fileSha1Base64?: string; /** - * The SHA256 checksum of this APK, represented as a base64 encoded byte - * array. + * The SHA256 checksum of this APK, represented as a base64 encoded byte array. */ fileSha256Base64?: string; /** @@ -420,20 +405,15 @@ export namespace androidpublisher_v3 { } export interface Schema$InAppProduct { /** - * The default language of the localized data, as defined by BCP 47. e.g. - * "en-US", "en-GB". + * The default language of the localized data, as defined by BCP 47. e.g. "en-US", "en-GB". */ defaultLanguage?: string; /** - * Default price cannot be zero. In-app products can never be free. Default - * price is always in the developer's Checkout merchant currency. + * Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency. */ defaultPrice?: Schema$Price; /** - * Grace period of the subscription, specified in ISO 8601 format. It will - * allow developers to give their subscribers a grace period when the - * payment for the new recurrence period is declined. Acceptable values = - * "P3D" (three days) and "P7D" (seven days) + * Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = "P3D" (three days) and "P7D" (seven days) */ gracePeriod?: string; /** @@ -445,8 +425,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; /** - * Prices per buyer region. None of these prices should be zero. In-app - * products can never be free. + * Prices per buyer region. None of these prices should be zero. In-app products can never be free. */ prices?: {[key: string]: Schema$Price}; /** @@ -454,8 +433,7 @@ export namespace androidpublisher_v3 { */ purchaseType?: string; /** - * Definition of a season for a seasonal subscription. Can be defined only - * for yearly subscriptions. + * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. */ season?: Schema$Season; /** @@ -464,16 +442,11 @@ export namespace androidpublisher_v3 { sku?: string; status?: string; /** - * Subscription period, specified in ISO 8601 format. Acceptable values are - * "P1W" (one week), "P1M" (one month), "P3M" - * (three months), "P6M" (six months), and "P1Y" (one - * year). + * Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). */ subscriptionPeriod?: string; /** - * Trial period, specified in ISO 8601 format. Acceptable values are - * anything between "P7D" (seven days) and "P999D" (999 - * days). Seasonal subscriptions cannot have a trial period. + * Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period. */ trialPeriod?: string; } @@ -484,26 +457,40 @@ export namespace androidpublisher_v3 { export interface Schema$InappproductsListResponse { inappproduct?: Schema$InAppProduct[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#inappproductsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#inappproductsListResponse". */ kind?: string; pageInfo?: Schema$PageInfo; tokenPagination?: Schema$TokenPagination; } + /** + * An artifact resource which gets created when uploading an APK or Android App Bundle through internal app sharing. + */ + export interface Schema$InternalAppSharingArtifact { + /** + * The SHA256 fingerprint of the certificate used to signed the generated artifact. + */ + certificateFingerprint?: string; + /** + * The download URL generated for the uploaded artifact. Users that are authorized to download can follow the link to the Play Store app to install it. + */ + downloadUrl?: string; + /** + * The SHA-256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command. + */ + sha256?: string; + } export interface Schema$Listing { /** * Full description of the app; this may be up to 4000 characters in length. */ fullDescription?: string; /** - * Language localization code (for example, "de-AT" for Austrian - * German). + * Language localization code (for example, "de-AT" for Austrian German). */ language?: string; /** - * Short description of the app (previously known as promo text); this may - * be up to 80 characters in length. + * Short description of the app (previously known as promo text); this may be up to 80 characters in length. */ shortDescription?: string; /** @@ -517,8 +504,7 @@ export namespace androidpublisher_v3 { } export interface Schema$ListingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#listingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#listingsListResponse". */ kind?: string; listings?: Schema$Listing[]; @@ -535,8 +521,7 @@ export namespace androidpublisher_v3 { } export interface Schema$MonthDay { /** - * Day of a month, value in [1, 31] range. Valid range depends on the - * specified month. + * Day of a month, value in [1, 31] range. Valid range depends on the specified month. */ day?: number; /** @@ -555,29 +540,28 @@ export namespace androidpublisher_v3 { */ currency?: string; /** - * The price in millionths of the currency base unit represented as a - * string. + * The price in millionths of the currency base unit represented as a string. */ priceMicros?: string; } /** - * A ProductPurchase resource indicates the status of a user's inapp - * product purchase. + * A ProductPurchase resource indicates the status of a user's inapp product purchase. */ export interface Schema$ProductPurchase { /** - * The consumption state of the inapp product. Possible values are: - Yet - * to be consumed - Consumed + * The acknowledgement state of the inapp product. Possible values are: - Yet to be acknowledged - Acknowledged + */ + acknowledgementState?: number; + /** + * The consumption state of the inapp product. Possible values are: - Yet to be consumed - Consumed */ consumptionState?: number; /** - * A developer-specified string that contains supplemental information about - * an order. + * A developer-specified string that contains supplemental information about an order. */ developerPayload?: string; /** - * This kind represents an inappPurchase object in the androidpublisher - * service. + * This kind represents an inappPurchase object in the androidpublisher service. */ kind?: string; /** @@ -585,30 +569,27 @@ export namespace androidpublisher_v3 { */ orderId?: string; /** - * The purchase state of the order. Possible values are: - Purchased - - * Canceled + * The purchase state of the order. Possible values are: - Purchased - Canceled */ purchaseState?: number; /** - * The time the product was purchased, in milliseconds since the epoch (Jan - * 1, 1970). + * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). */ purchaseTimeMillis?: string; /** - * The type of purchase of the inapp product. This field is only set if this - * purchase was not made using the standard in-app billing flow. Possible - * values are: - Test (i.e. purchased from a license testing account) - - * Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching - * a video ad instead of paying) + * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) */ purchaseType?: number; } + export interface Schema$ProductPurchasesAcknowledgeRequest { + /** + * Payload to attach to the purchase. + */ + developerPayload?: string; + } export interface Schema$Prorate { /** - * Default price cannot be zero and must be less than the full subscription - * price. Default price is always in the developer's Checkout merchant - * currency. Targeted countries have their prices set automatically based on - * the default_price. + * Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. */ defaultPrice?: Schema$Price; /** @@ -647,8 +628,7 @@ export namespace androidpublisher_v3 { } export interface Schema$ReviewsReplyRequest { /** - * The text to set as the reply. Replies of more than approximately 350 - * characters will be rejected. HTML tags will be stripped. + * The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped. */ replyText?: string; } @@ -661,10 +641,7 @@ export namespace androidpublisher_v3 { */ end?: Schema$MonthDay; /** - * Optionally present list of prorations for the season. Each proration is a - * one-off discounted entry into a subscription. Each proration contains the - * first date on which the discount is available and the new pricing - * information. + * Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. */ prorations?: Schema$Prorate[]; /** @@ -673,198 +650,143 @@ export namespace androidpublisher_v3 { start?: Schema$MonthDay; } /** - * Information provided by the user when they complete the subscription - * cancellation flow (cancellation reason survey). + * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ export interface Schema$SubscriptionCancelSurveyResult { /** - * The cancellation reason the user chose in the survey. Possible values - * are: - Other - I don't use this service enough - Technical issues - * - Cost-related reasons - I found a better app + * The cancellation reason the user chose in the survey. Possible values are: - Other - I don't use this service enough - Technical issues - Cost-related reasons - I found a better app */ cancelSurveyReason?: number; /** - * The customized input cancel reason from the user. Only present when - * cancelReason is 0. + * The customized input cancel reason from the user. Only present when cancelReason is 0. */ userInputCancelReason?: string; } /** - * A SubscriptionDeferralInfo contains the data needed to defer a subscription - * purchase to a future expiry time. + * A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time. */ export interface Schema$SubscriptionDeferralInfo { /** - * The desired next expiry time to assign to the subscription, in - * milliseconds since the Epoch. The given time must be later/greater than - * the current expiry time for the subscription. + * The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription. */ desiredExpiryTimeMillis?: string; /** - * The expected expiry time for the subscription. If the current expiry time - * for the subscription is not the value specified here, the deferral will - * not occur. + * The expected expiry time for the subscription. If the current expiry time for the subscription is not the value specified here, the deferral will not occur. */ expectedExpiryTimeMillis?: string; } /** - * Contains the price change information for a subscription that can be used - * to control the user journey for the price change in the app. This can be in - * the form of seeking confirmation from the user or tailoring the experience - * for a successful conversion. + * Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion. */ export interface Schema$SubscriptionPriceChange { /** - * The new price the subscription will renew with if the price change is - * accepted by the user. + * The new price the subscription will renew with if the price change is accepted by the user. */ newPrice?: Schema$Price; /** - * The current state of the price change. Possible values are: - - * Outstanding: State for a pending price change waiting for the user to - * agree. In this state, you can optionally seek confirmation from the user - * using the In-App API. - Accepted: State for an accepted price change - * that the subscription will renew with unless it's canceled. The price - * change takes effect on a future date when the subscription renews. Note - * that the change might not occur when the subscription is renewed next. + * The current state of the price change. Possible values are: - Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. - Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next. */ state?: number; } /** - * A SubscriptionPurchase resource indicates the status of a user's - * subscription purchase. + * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. */ export interface Schema$SubscriptionPurchase { /** - * Whether the subscription will automatically be renewed when it reaches - * its current expiry time. + * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ autoRenewing?: boolean; /** - * Time at which the subscription will be automatically resumed, in - * milliseconds since the Epoch. Only present if the user has requested to - * pause the subscription. + * Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription. */ autoResumeTimeMillis?: string; /** - * The reason why a subscription was canceled or is not auto-renewing. - * Possible values are: - User canceled the subscription - Subscription - * was canceled by the system, for example because of a billing problem - - * Subscription was replaced with a new subscription - Subscription was - * canceled by the developer + * The reason why a subscription was canceled or is not auto-renewing. Possible values are: - User canceled the subscription - Subscription was canceled by the system, for example because of a billing problem - Subscription was replaced with a new subscription - Subscription was canceled by the developer */ cancelReason?: number; /** - * Information provided by the user when they complete the subscription - * cancellation flow (cancellation reason survey). + * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ cancelSurveyResult?: Schema$SubscriptionCancelSurveyResult; /** - * ISO 3166-1 alpha-2 billing country/region code of the user at the time - * the subscription was granted. + * ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted. */ countryCode?: string; /** - * A developer-specified string that contains supplemental information about - * an order. + * A developer-specified string that contains supplemental information about an order. */ developerPayload?: string; /** - * The email address of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ emailAddress?: string; /** - * Time at which the subscription will expire, in milliseconds since the - * Epoch. + * Time at which the subscription will expire, in milliseconds since the Epoch. */ expiryTimeMillis?: string; /** - * The family name of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ familyName?: string; /** - * The given name of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ givenName?: string; /** - * This kind represents a subscriptionPurchase object in the - * androidpublisher service. + * This kind represents a subscriptionPurchase object in the androidpublisher service. */ kind?: string; /** - * The purchase token of the originating purchase if this subscription is - * one of the following: - Re-signup of a canceled but non-lapsed - * subscription - Upgrade/downgrade from a previous subscription For - * example, suppose a user originally signs up and you receive purchase - * token X, then the user cancels and goes through the resignup flow (before - * their subscription lapses) and you receive purchase token Y, and finally - * the user upgrades their subscription and you receive purchase token Z. If - * you call this API with purchase token Z, this field will be set to Y. If - * you call this API with purchase token Y, this field will be set to X. If - * you call this API with purchase token X, this field will not be set. + * The purchase token of the originating purchase if this subscription is one of the following: - Re-signup of a canceled but non-lapsed subscription - Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set. */ linkedPurchaseToken?: string; /** - * The order id of the latest recurring order associated with the purchase - * of the subscription. + * The order id of the latest recurring order associated with the purchase of the subscription. */ orderId?: string; /** - * The payment state of the subscription. Possible values are: - Payment - * pending - Payment received - Free trial - Pending deferred - * upgrade/downgrade + * The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade */ paymentState?: number; /** - * Price of the subscription, not including tax. Price is expressed in - * micro-units, where 1,000,000 micro-units represents one unit of the - * currency. For example, if the subscription price is €1.99, - * price_amount_micros is 1990000. + * Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. */ priceAmountMicros?: string; /** - * The latest price change information available. This is present only when - * there is an upcoming price change for the subscription yet to be applied. - * Once the subscription renews with the new price or the subscription is - * canceled, no price change information will be returned. + * The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned. */ priceChange?: Schema$SubscriptionPriceChange; /** - * ISO 4217 currency code for the subscription price. For example, if the - * price is specified in British pounds sterling, price_currency_code is - * "GBP". + * ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP". */ priceCurrencyCode?: string; /** - * The profile id of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ profileId?: string; /** - * The profile name of the user when the subscription was purchased. Only - * present for purchases made with 'Subscribe with Google'. + * The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ profileName?: string; /** - * The type of purchase of the subscription. This field is only set if this - * purchase was not made using the standard in-app billing flow. Possible - * values are: - Test (i.e. purchased from a license testing account) + * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) */ purchaseType?: number; /** - * Time at which the subscription was granted, in milliseconds since the - * Epoch. + * Time at which the subscription was granted, in milliseconds since the Epoch. */ startTimeMillis?: string; /** - * The time at which the subscription was canceled by the user, in - * milliseconds since the epoch. Only present if cancelReason is 0. + * The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0. */ userCancellationTimeMillis?: string; } + export interface Schema$SubscriptionPurchasesAcknowledgeRequest { + /** + * Payload to attach to the purchase. + */ + developerPayload?: string; + } export interface Schema$SubscriptionPurchasesDeferRequest { /** * The information about the new desired expiry time for the subscription. @@ -891,8 +813,7 @@ export namespace androidpublisher_v3 { } export interface Schema$Track { /** - * A list of all active releases in this track during a read request. On an - * update request, it represents desired changes. + * A list of all active releases in this track during a read request. On an update request, it represents desired changes. */ releases?: Schema$TrackRelease[]; /** @@ -903,9 +824,7 @@ export namespace androidpublisher_v3 { export interface Schema$TrackRelease { countryTargeting?: Schema$CountryTargeting; /** - * The release name, used to identify this release in the Play Console UI. - * Not required to be unique. This is optional, if not set it will be - * generated from the version_name in the APKs. + * The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. */ name?: string; /** @@ -917,46 +836,36 @@ export namespace androidpublisher_v3 { */ status?: string; /** - * Fraction of users who are eligible to receive the release. 0 < - * fraction < 1. To be set, release status must be "inProgress" - * or "halted". + * Fraction of users who are eligible to receive the release. 0 < fraction < 1. To be set, release status must be "inProgress" or "halted". */ userFraction?: number; /** - * A list of all version codes of APKs that will be exposed to the users of - * this track when this release is rolled out. Note that this list should - * contain all versions you wish to be active, including those you wish to - * retain from previous releases. + * A list of all version codes of APKs that will be exposed to the users of this track when this release is rolled out. Note that this list should contain all versions you wish to be active, including those you wish to retain from previous releases. */ versionCodes?: string[]; } export interface Schema$TracksListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "androidpublisher#tracksListResponse". + * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse". */ kind?: string; tracks?: Schema$Track[]; } export interface Schema$UserComment { /** - * Integer Android SDK version of the user's device at the time the - * review was written, e.g. 23 is Marshmallow. May be absent. + * Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent. */ androidOsVersion?: number; /** - * Integer version code of the app as installed at the time the review was - * written. May be absent. + * Integer version code of the app as installed at the time the review was written. May be absent. */ appVersionCode?: number; /** - * String version name of the app as installed at the time the review was - * written. May be absent. + * String version name of the app as installed at the time the review was written. May be absent. */ appVersionName?: string; /** - * Codename for the reviewer's device, e.g. klte, flounder. May be - * absent. + * Codename for the reviewer's device, e.g. klte, flounder. May be absent. */ device?: string; /** @@ -968,14 +877,11 @@ export namespace androidpublisher_v3 { */ lastModified?: Schema$Timestamp; /** - * Untranslated text of the review, in the case where the review has been - * translated. If the review has not been translated this is left blank. + * Untranslated text of the review, in the case where the review has been translated. If the review has not been translated this is left blank. */ originalText?: string; /** - * Language code for the reviewer. This is taken from the device settings so - * is not guaranteed to match the language the review is written in. May be - * absent. + * Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent. */ reviewerLanguage?: string; /** @@ -983,9 +889,7 @@ export namespace androidpublisher_v3 { */ starRating?: number; /** - * The content of the comment, i.e. review body. In some cases users have - * been able to write a review with separate title and body; in those cases - * the title and body are concatenated and separated by a tab character. + * The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character. */ text?: string; /** @@ -998,28 +902,23 @@ export namespace androidpublisher_v3 { thumbsUpCount?: number; } /** - * A VoidedPurchase resource indicates a purchase that was either - * canceled/refunded/charged-back. + * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back. */ export interface Schema$VoidedPurchase { /** - * This kind represents a voided purchase object in the androidpublisher - * service. + * This kind represents a voided purchase object in the androidpublisher service. */ kind?: string; /** - * The time at which the purchase was made, in milliseconds since the epoch - * (Jan 1, 1970). + * The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970). */ purchaseTimeMillis?: string; /** - * The token that was generated when a purchase was made. This uniquely - * identifies a purchase. + * The token that was generated when a purchase was made. This uniquely identifies a purchase. */ purchaseToken?: string; /** - * The time at which the purchase was canceled/refunded/charged-back, in - * milliseconds since the epoch (Jan 1, 1970). + * The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970). */ voidedTimeMillis?: string; } @@ -1129,9 +1028,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.delete - * @desc Deletes an edit for an app. Creating a new edit will automatically - * delete any of your previous edits so this method need only be called if - * you want to preemptively abandon an edit. + * @desc Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit. * @alias androidpublisher.edits.delete * @memberOf! () * @@ -1203,9 +1100,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.get - * @desc Returns information about the edit specified. Calls will fail if - * the edit is no long active (e.g. has been deleted, superseded or - * expired). + * @desc Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired). * @alias androidpublisher.edits.get * @memberOf! () * @@ -1277,8 +1172,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.insert - * @desc Creates a new edit for an app, populated with the app's current - * state. + * @desc Creates a new edit for an app, populated with the app's current state. * @alias androidpublisher.edits.insert * @memberOf! () * @@ -1349,8 +1243,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.validate - * @desc Checks that the edit can be successfully committed. The edit's - * changes are not applied to the live app. + * @desc Checks that the edit can be successfully committed. The edit's changes are not applied to the live app. * @alias androidpublisher.edits.validate * @memberOf! () * @@ -1432,8 +1325,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1448,8 +1340,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1464,8 +1355,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1476,8 +1366,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -1497,8 +1386,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1511,10 +1399,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.apks.addexternallyhosted - * @desc Creates a new APK without uploading the APK itself to Google Play, - * instead hosting the APK at a specified URL. This function is only - * available to enterprises using Google Play for Work whose application is - * configured to restrict distribution to the enterprise domain. + * @desc Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain. * @alias androidpublisher.edits.apks.addexternallyhosted * @memberOf! () * @@ -1762,8 +1647,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -1783,8 +1667,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -1800,8 +1683,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -1903,12 +1785,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.bundles.upload - * @desc Uploads a new Android App Bundle to this edit. If you are using the - * Google API client libraries, please increase the timeout of the http - * request before calling this endpoint (a timeout of 2 minutes is - * recommended). See: - * https://developers.google.com/api-client-library/java/google-api-java-client/errors - * for an example in java. + * @desc Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java. * @alias androidpublisher.edits.bundles.upload * @memberOf! () * @@ -2000,8 +1877,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2013,9 +1889,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Must be set to true if the bundle installation may trigger a warning on - * user devices (for example, if installation size may be over a threshold, - * typically 100 MB). + * Must be set to true if the bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB). */ ackBundleInstallationWarning?: boolean; /** @@ -2023,8 +1897,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2052,8 +1925,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.deobfuscationfiles.upload - * @desc Uploads the deobfuscation file of the specified APK. If a - * deobfuscation file already exists, it will be replaced. + * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced. * @alias androidpublisher.edits.deobfuscationfiles.upload * @memberOf! () * @@ -2175,8 +2047,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier of the Android app for which the deobfuscatiuon files - * are being uploaded; for example, "com.spiffygame". + * Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". */ packageName?: string; @@ -2204,8 +2075,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.details.get - * @desc Fetches app details for this edit. This includes the default - * language and developer support contact information. + * @desc Fetches app details for this edit. This includes the default language and developer support contact information. * @alias androidpublisher.edits.details.get * @memberOf! () * @@ -2280,8 +2150,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.details.patch - * @desc Updates app details for this edit. This method supports patch - * semantics. + * @desc Updates app details for this edit. This method supports patch semantics. * @alias androidpublisher.edits.details.patch * @memberOf! () * @@ -2444,8 +2313,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2461,8 +2329,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2483,8 +2350,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2589,9 +2455,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.expansionfiles.patch - * @desc Updates the APK's Expansion File configuration to reference another - * APK's Expansion Files. To add a new Expansion File use the Upload method. - * This method supports patch semantics. + * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics. * @alias androidpublisher.edits.expansionfiles.patch * @memberOf! () * @@ -2679,8 +2543,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.expansionfiles.update - * @desc Updates the APK's Expansion File configuration to reference another - * APK's Expansion Files. To add a new Expansion File use the Upload method. + * @desc Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. * @alias androidpublisher.edits.expansionfiles.update * @memberOf! () * @@ -2878,8 +2741,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -2891,8 +2753,7 @@ export namespace androidpublisher_v3 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -2904,8 +2765,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -2917,8 +2777,7 @@ export namespace androidpublisher_v3 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2935,8 +2794,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -2948,8 +2806,7 @@ export namespace androidpublisher_v3 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -2966,8 +2823,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version code of the APK whose Expansion File configuration is being - * read or modified. + * The version code of the APK whose Expansion File configuration is being read or modified. */ apkVersionCode?: number; /** @@ -2979,8 +2835,7 @@ export namespace androidpublisher_v3 { */ expansionFileType?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -3254,8 +3109,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.images.upload - * @desc Uploads a new image and adds it to the list of images for the - * specified language and image type. + * @desc Uploads a new image and adds it to the list of images for the specified language and image type. * @alias androidpublisher.edits.images.upload * @memberOf! () * @@ -3352,8 +3206,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier an image within the set of images attached to this - * edit. + * Unique identifier an image within the set of images attached to this edit. */ imageId?: string; /** @@ -3361,14 +3214,11 @@ export namespace androidpublisher_v3 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3388,14 +3238,11 @@ export namespace androidpublisher_v3 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3415,14 +3262,11 @@ export namespace androidpublisher_v3 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3442,14 +3286,11 @@ export namespace androidpublisher_v3 { */ imageType?: string; /** - * The language code (a BCP-47 language tag) of the localized listing whose - * images are to read or modified. For example, to select Austrian German, - * pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -3775,8 +3616,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.listings.patch - * @desc Creates or updates a localized store listing. This method supports - * patch semantics. + * @desc Creates or updates a localized store listing. This method supports patch semantics. * @alias androidpublisher.edits.listings.patch * @memberOf! () * @@ -3937,13 +3777,11 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3959,8 +3797,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3976,13 +3813,11 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -3998,8 +3833,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4015,13 +3849,11 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -4042,13 +3874,11 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * The language code (a BCP-47 language tag) of the localized listing to - * read or modify. For example, to select Austrian German, pass "de-AT". + * The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". */ language?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; @@ -4298,8 +4128,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4319,8 +4148,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4345,8 +4173,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4368,8 +4195,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.get - * @desc Fetches the track configuration for the specified track type. - * Includes the APK version codes that are in this track. + * @desc Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track. * @alias androidpublisher.edits.tracks.get * @memberOf! () * @@ -4517,8 +4343,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.patch - * @desc Updates the track configuration for the specified track type. This - * method supports patch semantics. + * @desc Updates the track configuration for the specified track type. This method supports patch semantics. * @alias androidpublisher.edits.tracks.patch * @memberOf! () * @@ -4678,8 +4503,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4699,8 +4523,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; } @@ -4716,8 +4539,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4742,8 +4564,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier for the Android app that is being updated; for example, - * "com.spiffygame". + * Unique identifier for the Android app that is being updated; for example, "com.spiffygame". */ packageName?: string; /** @@ -4989,8 +4810,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.list - * @desc List all the in-app products for an Android app, both subscriptions - * and managed in-app products.. + * @desc List all the in-app products for an Android app, both subscriptions and managed in-app products.. * @alias androidpublisher.inappproducts.list * @memberOf! () * @@ -5074,8 +4894,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.inappproducts.patch - * @desc Updates the details of an in-app product. This method supports - * patch semantics. + * @desc Updates the details of an in-app product. This method supports patch semantics. * @alias androidpublisher.inappproducts.patch * @memberOf! () * @@ -5236,8 +5055,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app with the in-app product; for - * example, "com.spiffygame". + * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". */ packageName?: string; /** @@ -5269,9 +5087,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true the prices for all regions targeted by the parent app that don't - * have a price specified for this in-app product will be auto converted to - * the target currency based on the default price. Defaults to false. + * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. */ autoConvertMissingPrices?: boolean; /** @@ -5296,8 +5112,7 @@ export namespace androidpublisher_v3 { */ maxResults?: number; /** - * Unique identifier for the Android app with in-app products; for example, - * "com.spiffygame". + * Unique identifier for the Android app with in-app products; for example, "com.spiffygame". */ packageName?: string; /** @@ -5317,14 +5132,11 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true the prices for all regions targeted by the parent app that don't - * have a price specified for this in-app product will be auto converted to - * the target currency based on the default price. Defaults to false. + * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. */ autoConvertMissingPrices?: boolean; /** - * Unique identifier for the Android app with the in-app product; for - * example, "com.spiffygame". + * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". */ packageName?: string; /** @@ -5345,14 +5157,11 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true the prices for all regions targeted by the parent app that don't - * have a price specified for this in-app product will be auto converted to - * the target currency based on the default price. Defaults to false. + * If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. */ autoConvertMissingPrices?: boolean; /** - * Unique identifier for the Android app with the in-app product; for - * example, "com.spiffygame". + * Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". */ packageName?: string; /** @@ -5366,6 +5175,244 @@ export namespace androidpublisher_v3 { requestBody?: Schema$InAppProduct; } + export class Resource$Internalappsharingartifacts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * androidpublisher.internalappsharingartifacts.uploadapk + * @desc Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java. + * @alias androidpublisher.internalappsharingartifacts.uploadapk + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {object} params.media Media object + * @param {string} params.media.mimeType Media mime-type + * @param {string|object} params.media.body Media body contents + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + uploadapk( + params?: Params$Resource$Internalappsharingartifacts$Uploadapk, + options?: MethodOptions + ): GaxiosPromise; + uploadapk( + params: Params$Resource$Internalappsharingartifacts$Uploadapk, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadapk( + params: Params$Resource$Internalappsharingartifacts$Uploadapk, + callback: BodyResponseCallback + ): void; + uploadapk( + callback: BodyResponseCallback + ): void; + uploadapk( + paramsOrCallback?: + | Params$Resource$Internalappsharingartifacts$Uploadapk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Internalappsharingartifacts$Uploadapk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Internalappsharingartifacts$Uploadapk; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + mediaUrl: ( + rootUrl + + '/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * androidpublisher.internalappsharingartifacts.uploadbundle + * @desc Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java. + * @alias androidpublisher.internalappsharingartifacts.uploadbundle + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {object} params.media Media object + * @param {string} params.media.mimeType Media mime-type + * @param {string|object} params.media.body Media body contents + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + uploadbundle( + params?: Params$Resource$Internalappsharingartifacts$Uploadbundle, + options?: MethodOptions + ): GaxiosPromise; + uploadbundle( + params: Params$Resource$Internalappsharingartifacts$Uploadbundle, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadbundle( + params: Params$Resource$Internalappsharingartifacts$Uploadbundle, + callback: BodyResponseCallback + ): void; + uploadbundle( + callback: BodyResponseCallback + ): void; + uploadbundle( + paramsOrCallback?: + | Params$Resource$Internalappsharingartifacts$Uploadbundle + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Internalappsharingartifacts$Uploadbundle; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Internalappsharingartifacts$Uploadbundle; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + mediaUrl: ( + rootUrl + + '/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Internalappsharingartifacts$Uploadapk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Unique identifier for the Android app; for example, "com.spiffygame". + */ + packageName?: string; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + export interface Params$Resource$Internalappsharingartifacts$Uploadbundle + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Unique identifier for the Android app; for example, "com.spiffygame". + */ + packageName?: string; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + export class Resource$Orders { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -5453,20 +5500,15 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The order ID provided to the user when the subscription or in-app order - * was purchased. + * The order ID provided to the user when the subscription or in-app order was purchased. */ orderId?: string; /** - * The package name of the application for which this subscription or in-app - * item was purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). */ packageName?: string; /** - * Whether to revoke the purchased item. If set to true, access to the - * subscription or in-app item will be terminated immediately. If the item - * is a recurring subscription, all future payments will also be terminated. - * Consumed in-app items need to be handled by developer's app. (optional) + * Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional) */ revoke?: boolean; } @@ -5492,6 +5534,81 @@ export namespace androidpublisher_v3 { this.context = context; } + /** + * androidpublisher.purchases.products.acknowledge + * @desc Acknowledges a purchase of an inapp item. + * @alias androidpublisher.purchases.products.acknowledge + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing'). + * @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1'). + * @param {string} params.token The token provided to the user's device when the subscription was purchased. + * @param {().ProductPurchasesAcknowledgeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + acknowledge( + params?: Params$Resource$Purchases$Products$Acknowledge, + options?: MethodOptions + ): GaxiosPromise; + acknowledge( + params: Params$Resource$Purchases$Products$Acknowledge, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acknowledge( + params: Params$Resource$Purchases$Products$Acknowledge, + callback: BodyResponseCallback + ): void; + acknowledge(callback: BodyResponseCallback): void; + acknowledge( + paramsOrCallback?: + | Params$Resource$Purchases$Products$Acknowledge + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Purchases$Products$Acknowledge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Purchases$Products$Acknowledge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['packageName', 'productId', 'token'], + pathParams: ['packageName', 'productId', 'token'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * androidpublisher.purchases.products.get * @desc Checks the purchase and consumption status of an inapp item. @@ -5569,6 +5686,31 @@ export namespace androidpublisher_v3 { } } + export interface Params$Resource$Purchases$Products$Acknowledge + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The package name of the application the inapp product was sold in (for example, 'com.some.thing'). + */ + packageName?: string; + /** + * The inapp product SKU (for example, 'com.some.thing.inapp1'). + */ + productId?: string; + /** + * The token provided to the user's device when the subscription was purchased. + */ + token?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProductPurchasesAcknowledgeRequest; + } export interface Params$Resource$Purchases$Products$Get extends StandardParameters { /** @@ -5577,8 +5719,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application the inapp product was sold in (for - * example, 'com.some.thing'). + * The package name of the application the inapp product was sold in (for example, 'com.some.thing'). */ packageName?: string; /** @@ -5586,8 +5727,7 @@ export namespace androidpublisher_v3 { */ productId?: string; /** - * The token provided to the user's device when the inapp product was - * purchased. + * The token provided to the user's device when the inapp product was purchased. */ token?: string; } @@ -5598,10 +5738,84 @@ export namespace androidpublisher_v3 { this.context = context; } + /** + * androidpublisher.purchases.subscriptions.acknowledge + * @desc Acknowledges a subscription purchase. + * @alias androidpublisher.purchases.subscriptions.acknowledge + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when the subscription was purchased. + * @param {().SubscriptionPurchasesAcknowledgeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + acknowledge( + params?: Params$Resource$Purchases$Subscriptions$Acknowledge, + options?: MethodOptions + ): GaxiosPromise; + acknowledge( + params: Params$Resource$Purchases$Subscriptions$Acknowledge, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acknowledge( + params: Params$Resource$Purchases$Subscriptions$Acknowledge, + callback: BodyResponseCallback + ): void; + acknowledge(callback: BodyResponseCallback): void; + acknowledge( + paramsOrCallback?: + | Params$Resource$Purchases$Subscriptions$Acknowledge + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Purchases$Subscriptions$Acknowledge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Purchases$Subscriptions$Acknowledge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['packageName', 'subscriptionId', 'token'], + pathParams: ['packageName', 'subscriptionId', 'token'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * androidpublisher.purchases.subscriptions.cancel - * @desc Cancels a user's subscription purchase. The subscription remains - * valid until its expiration time. + * @desc Cancels a user's subscription purchase. The subscription remains valid until its expiration time. * @alias androidpublisher.purchases.subscriptions.cancel * @memberOf! () * @@ -5675,8 +5889,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.purchases.subscriptions.defer - * @desc Defers a user's subscription purchase until a specified future - * expiration time. + * @desc Defers a user's subscription purchase until a specified future expiration time. * @alias androidpublisher.purchases.subscriptions.defer * @memberOf! () * @@ -5762,8 +5975,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.purchases.subscriptions.get - * @desc Checks whether a user's subscription purchase is valid and returns - * its expiry time. + * @desc Checks whether a user's subscription purchase is valid and returns its expiry time. * @alias androidpublisher.purchases.subscriptions.get * @memberOf! () * @@ -5841,8 +6053,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.purchases.subscriptions.refund - * @desc Refunds a user's subscription purchase, but the subscription - * remains valid until its expiration time and it will continue to recur. + * @desc Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur. * @alias androidpublisher.purchases.subscriptions.refund * @memberOf! () * @@ -5916,9 +6127,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.purchases.subscriptions.revoke - * @desc Refunds and immediately revokes a user's subscription purchase. - * Access to the subscription will be terminated immediately and it will - * stop recurring. + * @desc Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring. * @alias androidpublisher.purchases.subscriptions.revoke * @memberOf! () * @@ -5991,6 +6200,31 @@ export namespace androidpublisher_v3 { } } + export interface Params$Resource$Purchases$Subscriptions$Acknowledge + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). + */ + packageName?: string; + /** + * The purchased subscription ID (for example, 'monthly001'). + */ + subscriptionId?: string; + /** + * The token provided to the user's device when the subscription was purchased. + */ + token?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SubscriptionPurchasesAcknowledgeRequest; + } export interface Params$Resource$Purchases$Subscriptions$Cancel extends StandardParameters { /** @@ -5999,8 +6233,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6008,8 +6241,7 @@ export namespace androidpublisher_v3 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6021,8 +6253,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6030,8 +6261,7 @@ export namespace androidpublisher_v3 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; @@ -6048,8 +6278,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6057,8 +6286,7 @@ export namespace androidpublisher_v3 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6070,8 +6298,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6079,8 +6306,7 @@ export namespace androidpublisher_v3 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6092,8 +6318,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The package name of the application for which this subscription was - * purchased (for example, 'com.some.thing'). + * The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6101,8 +6326,7 @@ export namespace androidpublisher_v3 { */ subscriptionId?: string; /** - * The token provided to the user's device when the subscription was - * purchased. + * The token provided to the user's device when the subscription was purchased. */ token?: string; } @@ -6208,12 +6432,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The time, in milliseconds since the Epoch, of the newest voided in-app - * product purchase that you want to see in the response. The value of this - * parameter cannot be greater than the current time and is ignored if a - * pagination token is set. Default value is current time. Note: This filter - * is applied on the time at which the record is seen as voided by our - * systems and not the actual voided time returned in the response. + * The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. */ endTime?: string; /** @@ -6221,8 +6440,7 @@ export namespace androidpublisher_v3 { */ maxResults?: number; /** - * The package name of the application for which voided purchases need to be - * returned (for example, 'com.some.thing'). + * The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). */ packageName?: string; /** @@ -6230,12 +6448,7 @@ export namespace androidpublisher_v3 { */ startIndex?: number; /** - * The time, in milliseconds since the Epoch, of the oldest voided in-app - * product purchase that you want to see in the response. The value of this - * parameter cannot be older than 30 days and is ignored if a pagination - * token is set. Default value is current time minus 30 days. Note: This - * filter is applied on the time at which the record is seen as voided by - * our systems and not the actual voided time returned in the response. + * The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. */ startTime?: string; /** @@ -6325,8 +6538,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.reviews.list - * @desc Returns a list of reviews. Only reviews from last week will be - * returned. + * @desc Returns a list of reviews. Only reviews from last week will be returned. * @alias androidpublisher.reviews.list * @memberOf! () * @@ -6486,8 +6698,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app for which we want reviews; for - * example, "com.spiffygame". + * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". */ packageName?: string; /** @@ -6510,8 +6721,7 @@ export namespace androidpublisher_v3 { */ maxResults?: number; /** - * Unique identifier for the Android app for which we want reviews; for - * example, "com.spiffygame". + * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". */ packageName?: string; /** @@ -6534,8 +6744,7 @@ export namespace androidpublisher_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier for the Android app for which we want reviews; for - * example, "com.spiffygame". + * Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". */ packageName?: string; /** diff --git a/src/apis/appengine/package.json b/src/apis/appengine/package.json index 7415ce36f23..f06acf70b95 100644 --- a/src/apis/appengine/package.json +++ b/src/apis/appengine/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index dca7a636b1f..13b70b4c218 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace appengine_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace appengine_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,21 +108,21 @@ export namespace appengine_v1 { apps: Resource$Apps; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.apps = new Resource$Apps(this.context); } } /** - * Google Cloud Endpoints - * (https://cloud.google.com/appengine/docs/python/endpoints/) configuration - * for API handlers. + * Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. */ export interface Schema$ApiConfigHandler { /** - * Action to take when users access resources that require authentication. - * Defaults to redirect. + * Action to take when users access resources that require authentication. Defaults to redirect. */ authFailAction?: string; /** @@ -156,24 +152,19 @@ export namespace appengine_v1 { scriptPath?: string; } /** - * An Application resource contains the top-level configuration of an App - * Engine application. + * An Application resource contains the top-level configuration of an App Engine application. */ export interface Schema$Application { /** - * Google Apps authentication domain that controls which users can access - * this application.Defaults to open access for any Google Account. + * Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. */ authDomain?: string; /** - * Google Cloud Storage bucket that can be used for storing files associated - * with this application. This bucket is associated with the application and - * can be used by the gcloud deployment commands.@OutputOnly + * Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly */ codeBucket?: string; /** - * Google Cloud Storage bucket that can be used by this application to store - * content.@OutputOnly + * Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly */ defaultBucket?: string; /** @@ -181,14 +172,11 @@ export namespace appengine_v1 { */ defaultCookieExpiration?: string; /** - * Hostname used to reach this application, as resolved by App - * Engine.@OutputOnly + * Hostname used to reach this application, as resolved by App Engine.@OutputOnly */ defaultHostname?: string; /** - * HTTP path dispatch rules for requests to the application that do not - * explicitly target a service or version. Rules are order-dependent. Up to - * 20 dispatch rules can be supported. + * HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. */ dispatchRules?: Schema$UrlDispatchRule[]; /** @@ -196,28 +184,20 @@ export namespace appengine_v1 { */ featureSettings?: Schema$FeatureSettings; /** - * The Google Container Registry domain used for storing managed build - * docker images for this application. + * The Google Container Registry domain used for storing managed build docker images for this application. */ gcrDomain?: string; iap?: Schema$IdentityAwareProxy; /** - * Identifier of the Application resource. This identifier is equivalent to - * the project ID of the Google Cloud Platform project where you want to - * deploy your application. Example: myapp. + * Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp. */ id?: string; /** - * Location from which this application runs. Application instances run out - * of the data centers in the specified location, which is also where all of - * the application's end user content is stored.Defaults to - * us-central.View the list of supported locations - * (https://cloud.google.com/appengine/docs/locations). + * Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). */ locationId?: string; /** - * Full path to the Application resource in the API. Example: - * apps/myapp.@OutputOnly + * Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly */ name?: string; /** @@ -226,97 +206,65 @@ export namespace appengine_v1 { servingStatus?: string; } /** - * An SSL certificate that a user has been authorized to administer. A user is - * authorized to administer any certificate that applies to one of their - * authorized domains. + * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. */ export interface Schema$AuthorizedCertificate { /** - * The SSL certificate serving the AuthorizedCertificate resource. This must - * be obtained independently from a certificate authority. + * The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. */ certificateRawData?: Schema$CertificateRawData; /** - * The user-specified display name of the certificate. This is not - * guaranteed to be unique. Example: My Certificate. + * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. */ displayName?: string; /** - * Aggregate count of the domain mappings with this certificate mapped. This - * count includes domain mappings on applications for which the user does - * not have VIEWER permissions.Only returned by GET or LIST requests when - * specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ domainMappingsCount?: number; /** - * Topmost applicable domains of this certificate. This certificate applies - * to these domains and their subdomains. Example: example.com.@OutputOnly + * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly */ domainNames?: string[]; /** - * The time when this certificate expires. To update the renewal time on - * this certificate, upload an SSL certificate with a different expiration - * time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly */ expireTime?: string; /** - * Relative name of the certificate. This is a unique value autogenerated on - * AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly */ id?: string; /** - * Only applicable if this certificate is managed by App Engine. Managed - * certificates are tied to the lifecycle of a DomainMapping and cannot be - * updated or deleted via the AuthorizedCertificates API. If this - * certificate is manually administered by the user, this field will be - * empty.@OutputOnly + * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly */ managedCertificate?: Schema$ManagedCertificate; /** - * Full path to the AuthorizedCertificate resource in the API. Example: - * apps/myapp/authorizedCertificates/12345.@OutputOnly + * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly */ name?: string; /** - * The full paths to user visible Domain Mapping resources that have this - * certificate mapped. Example: apps/myapp/domainMappings/example.com.This - * may not represent the full list of mapped domain mappings if the user - * does not have VIEWER permissions on all of the applications that have - * this certificate mapped. See domain_mappings_count for a complete - * count.Only returned by GET or LIST requests when specifically requested - * by the view=FULL_CERTIFICATE option.@OutputOnly + * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ visibleDomainMappings?: string[]; } /** - * A domain that a user has been authorized to administer. To authorize use of - * a domain, verify ownership via Webmaster Central - * (https://www.google.com/webmasters/verification/home). + * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home). */ export interface Schema$AuthorizedDomain { /** - * Fully qualified domain name of the domain authorized for use. Example: - * example.com. + * Fully qualified domain name of the domain authorized for use. Example: example.com. */ id?: string; /** - * Full path to the AuthorizedDomain resource in the API. Example: - * apps/myapp/authorizedDomains/example.com.@OutputOnly + * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly */ name?: string; } /** - * Automatic scaling is based on request rate, response latencies, and other - * application metrics. + * Automatic scaling is based on request rate, response latencies, and other application metrics. */ export interface Schema$AutomaticScaling { /** - * The time period that the Autoscaler - * (https://cloud.google.com/compute/docs/autoscaler/) should wait before it - * starts collecting information from a new instance. This prevents the - * autoscaler from collecting information when the instance is initializing, - * during which the collected usage would not be reliable. Only applicable - * in the App Engine flexible environment. + * The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. */ coolDownPeriod?: string; /** @@ -328,39 +276,31 @@ export namespace appengine_v1 { */ diskUtilization?: Schema$DiskUtilization; /** - * Number of concurrent requests an automatic scaling instance can accept - * before the scheduler spawns a new instance.Defaults to a runtime-specific - * value. + * Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value. */ maxConcurrentRequests?: number; /** - * Maximum number of idle instances that should be maintained for this - * version. + * Maximum number of idle instances that should be maintained for this version. */ maxIdleInstances?: number; /** - * Maximum amount of time that a request should wait in the pending queue - * before starting a new instance to handle it. + * Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. */ maxPendingLatency?: string; /** - * Maximum number of instances that should be started to handle requests for - * this version. + * Maximum number of instances that should be started to handle requests for this version. */ maxTotalInstances?: number; /** - * Minimum number of idle instances that should be maintained for this - * version. Only applicable for the default version of a service. + * Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. */ minIdleInstances?: number; /** - * Minimum amount of time a request should wait in the pending queue before - * starting a new instance to handle it. + * Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. */ minPendingLatency?: string; /** - * Minimum number of running instances that should be maintained for this - * version. + * Minimum number of running instances that should be maintained for this version. */ minTotalInstances?: number; /** @@ -377,15 +317,11 @@ export namespace appengine_v1 { standardSchedulerSettings?: Schema$StandardSchedulerSettings; } /** - * A service with basic scaling will create an instance when the application - * receives a request. The instance will be turned down when the app becomes - * idle. Basic scaling is ideal for work that is intermittent or driven by - * user activity. + * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. */ export interface Schema$BasicScaling { /** - * Duration of time after the last request that an instance must wait before - * the instance is shut down. + * Duration of time after the last request that an instance must wait before the instance is shut down. */ idleTimeout?: string; /** @@ -416,51 +352,33 @@ export namespace appengine_v1 { */ export interface Schema$CertificateRawData { /** - * Unencrypted PEM encoded RSA private key. This field is set once on - * certificate creation and then encrypted. The key size must be 2048 bits - * or fewer. Must include the header and footer. Example: <pre> - * -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END - * RSA PRIVATE KEY----- </pre> @InputOnly + * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly */ privateKey?: string; /** - * PEM encoded x.509 public key certificate. This field is set once on - * certificate creation. Must include the header and footer. Example: - * <pre> -----BEGIN CERTIFICATE----- <certificate_value> - * -----END CERTIFICATE----- </pre> + * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre> */ publicCertificate?: string; } /** - * Options for the build operations performed as a part of the version - * deployment. Only applicable for App Engine flexible environment when - * creating a version using source code directly. + * Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. */ export interface Schema$CloudBuildOptions { /** - * Path to the yaml file used in deployment, used to determine runtime - * configuration details.Required for flexible environment builds.See - * https://cloud.google.com/appengine/docs/standard/python/config/appref for - * more details. + * Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. */ appYamlPath?: string; /** - * The Cloud Build timeout used as part of any dependent builds performed by - * version creation. Defaults to 10 minutes. + * The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. */ cloudBuildTimeout?: string; } /** - * Docker image that is used to create a container and start a VM instance for - * the version that you deploy. Only applicable for instances running in the - * App Engine flexible environment. + * Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. */ export interface Schema$ContainerInfo { /** - * URI to the hosted container image in Google Container Registry. The URI - * must be fully qualified and include a tag or digest. Examples: - * "gcr.io/my-project/image:tag" or - * "gcr.io/my-project/image@digest" + * URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" */ image?: string; } @@ -473,41 +391,34 @@ export namespace appengine_v1 { */ aggregationWindowLength?: string; /** - * Target CPU utilization ratio to maintain when scaling. Must be between 0 - * and 1. + * Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. */ targetUtilization?: number; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1 { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1alpha.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Alpha { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1beta.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Beta { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } @@ -516,11 +427,7 @@ export namespace appengine_v1 { */ export interface Schema$DebugInstanceRequest { /** - * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa - * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh - * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For - * more information, see Adding and Removing SSH Keys - * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). + * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). */ sshKey?: string; } @@ -529,21 +436,15 @@ export namespace appengine_v1 { */ export interface Schema$Deployment { /** - * Options for any Google Cloud Build builds created as a part of this - * deployment.These options will only be used if a new build is created, - * such as when deploying to the App Engine flexible environment using files - * or zip. + * Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. */ cloudBuildOptions?: Schema$CloudBuildOptions; /** - * The Docker image for the container that runs the version. Only applicable - * for instances running in the App Engine flexible environment. + * The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment. */ container?: Schema$ContainerInfo; /** - * Manifest of the files stored in Google Cloud Storage that are included as - * part of this version. All files must be readable using the credentials - * supplied with this call. + * Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call. */ files?: {[key: string]: Schema$FileInfo}; /** @@ -552,8 +453,7 @@ export namespace appengine_v1 { zip?: Schema$ZipInfo; } /** - * Target scaling by disk usage. Only applicable in the App Engine flexible - * environment. + * Target scaling by disk usage. Only applicable in the App Engine flexible environment. */ export interface Schema$DiskUtilization { /** @@ -578,71 +478,44 @@ export namespace appengine_v1 { */ export interface Schema$DomainMapping { /** - * Relative name of the domain serving the application. Example: - * example.com. + * Relative name of the domain serving the application. Example: example.com. */ id?: string; /** - * Full path to the DomainMapping resource in the API. Example: - * apps/myapp/domainMapping/example.com.@OutputOnly + * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly */ name?: string; /** - * The resource records required to configure this domain mapping. These - * records must be added to the domain's DNS configuration in order to - * serve the application via this domain mapping.@OutputOnly + * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly */ resourceRecords?: Schema$ResourceRecord[]; /** - * SSL configuration for this domain. If unconfigured, this domain will not - * serve with SSL. + * SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. */ sslSettings?: Schema$SslSettings; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** - * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The - * Endpoints API Service provides tooling for serving Open API and gRPC - * endpoints via an NGINX proxy. Only valid for App Engine Flexible - * environment deployments.The fields here refer to the name and configuration - * ID of a "service" resource in the Service Management API - * (https://cloud.google.com/service-management/overview). + * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). */ export interface Schema$EndpointsApiService { /** - * Endpoints service configuration ID as specified by the Service Management - * API. For example "2016-09-19r1".By default, the rollout - * strategy for Endpoints is RolloutStrategy.FIXED. This means that - * Endpoints starts up with a particular configuration ID. When a new - * configuration is rolled out, Endpoints must be given the new - * configuration ID. The config_id field is used to give the configuration - * ID and is required in this case.Endpoints also has a rollout strategy - * called RolloutStrategy.MANAGED. When using this, Endpoints fetches the - * latest configuration and does not need the configuration ID. In this - * case, config_id must be omitted. + * Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. */ configId?: string; /** - * Enable or disable trace sampling. By default, this is set to false for - * enabled. + * Enable or disable trace sampling. By default, this is set to false for enabled. */ disableTraceSampling?: boolean; /** - * Endpoints service name which is the name of the "service" - * resource in the Service Management API. For example - * "myapi.endpoints.myproject.cloud.goog" + * Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" */ name?: string; /** - * Endpoints rollout strategy. If FIXED, config_id must be specified. If - * MANAGED, config_id must be omitted. + * Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. */ rolloutStrategy?: string; } @@ -673,34 +546,24 @@ export namespace appengine_v1 { staticFile?: string; } /** - * The feature specific settings to be used in the application. These define - * behaviors that are user configurable. + * The feature specific settings to be used in the application. These define behaviors that are user configurable. */ export interface Schema$FeatureSettings { /** - * Boolean value indicating if split health checks should be used instead of - * the legacy health checks. At an app.yaml level, this means defaulting to - * 'readiness_check' and 'liveness_check' values instead of - * 'health_check' ones. Once the legacy 'health_check' - * behavior is deprecated, and this value is always true, this setting can - * be removed. + * Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed. */ splitHealthChecks?: boolean; /** - * If true, use Container-Optimized OS - * (https://cloud.google.com/container-optimized-os/) base image for VMs, - * rather than a base Debian image. + * If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image. */ useContainerOptimizedOs?: boolean; } /** - * Single source file that is part of the version to be deployed. Each source - * file that is deployed must be specified separately. + * Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. */ export interface Schema$FileInfo { /** - * The MIME type of the file.Defaults to the value from Google Cloud - * Storage. + * The MIME type of the file.Defaults to the value from Google Cloud Storage. */ mimeType?: string; /** @@ -708,15 +571,12 @@ export namespace appengine_v1 { */ sha1Sum?: string; /** - * URL source to use to fetch this file. Must be a URL to a resource in - * Google Cloud Storage in the form - * 'http(s)://storage.googleapis.com/<bucket>/<object>'. + * URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ sourceUrl?: string; } /** - * A single firewall rule that is evaluated against incoming traffic and - * provides an action to take on matched requests. + * A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. */ export interface Schema$FirewallRule { /** @@ -724,35 +584,20 @@ export namespace appengine_v1 { */ action?: string; /** - * An optional string description of this rule. This field has a maximum - * length of 100 characters. + * An optional string description of this rule. This field has a maximum length of 100 characters. */ description?: string; /** - * A positive integer between 1, Int32.MaxValue-1 that defines the order of - * rule evaluation. Rules with the lowest priority are evaluated first.A - * default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic - * when no previous rule matches. Only the action of this rule can be - * modified by the user. + * A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. */ priority?: number; /** - * IP address or range, defined using CIDR notation, of requests that this - * rule applies to. You can use the wildcard character "*" to - * match all IPs equivalent to "0/0" and "::/0" - * together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or - * 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be - * silently performed on addresses which are not properly truncated. For - * example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. - * Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as - * 2001:db8::/32. + * IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. */ sourceRange?: string; } /** - * Health checking configuration for VM instances. Unhealthy instances are - * killed and replaced with new instances. Only applicable for instances in - * App Engine flexible environment. + * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. */ export interface Schema$HealthCheck { /** @@ -764,18 +609,15 @@ export namespace appengine_v1 { */ disableHealthCheck?: boolean; /** - * Number of consecutive successful health checks required before receiving - * traffic. + * Number of consecutive successful health checks required before receiving traffic. */ healthyThreshold?: number; /** - * Host header to send when performing an HTTP health check. Example: - * "myapp.appspot.com" + * Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" */ host?: string; /** - * Number of consecutive failed health checks required before an instance is - * restarted. + * Number of consecutive failed health checks required before an instance is restarted. */ restartThreshold?: number; /** @@ -783,8 +625,7 @@ export namespace appengine_v1 { */ timeout?: string; /** - * Number of consecutive failed health checks required before removing - * traffic. + * Number of consecutive failed health checks required before removing traffic. */ unhealthyThreshold?: number; } @@ -793,9 +634,7 @@ export namespace appengine_v1 { */ export interface Schema$IdentityAwareProxy { /** - * Whether the serving infrastructure will authenticate and authorize all - * incoming requests.If true, the oauth2_client_id and oauth2_client_secret - * fields must be non-empty. + * Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty. */ enabled?: boolean; /** @@ -803,10 +642,7 @@ export namespace appengine_v1 { */ oauth2ClientId?: string; /** - * OAuth2 client secret to use for the authentication flow.For security - * reasons, this value cannot be retrieved via the API. Instead, the SHA-256 - * hash of the value is returned in the oauth2_client_secret_sha256 - * field.@InputOnly + * OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly */ oauth2ClientSecret?: string; /** @@ -815,8 +651,7 @@ export namespace appengine_v1 { oauth2ClientSecretSha256?: string; } /** - * An Instance resource is the computing unit that App Engine uses to - * automatically scale an application. + * An Instance resource is the computing unit that App Engine uses to automatically scale an application. */ export interface Schema$Instance { /** @@ -836,8 +671,7 @@ export namespace appengine_v1 { */ errors?: number; /** - * Relative name of the instance within the version. Example: - * instance-1.@OutputOnly + * Relative name of the instance within the version. Example: instance-1.@OutputOnly */ id?: string; /** @@ -845,8 +679,7 @@ export namespace appengine_v1 { */ memoryUsage?: string; /** - * Full path to the Instance resource in the API. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly + * Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly */ name?: string; /** @@ -862,33 +695,27 @@ export namespace appengine_v1 { */ startTime?: string; /** - * Whether this instance is in debug mode. Only applicable for instances in - * App Engine flexible environment.@OutputOnly + * Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmDebugEnabled?: boolean; /** - * Virtual machine ID of this instance. Only applicable for instances in App - * Engine flexible environment.@OutputOnly + * Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmId?: string; /** - * The IP address of this instance. Only applicable for instances in App - * Engine flexible environment.@OutputOnly + * The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmIp?: string; /** - * Name of the virtual machine where this instance lives. Only applicable - * for instances in App Engine flexible environment.@OutputOnly + * Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmName?: string; /** - * Status of the virtual machine where this instance lives. Only applicable - * for instances in App Engine flexible environment.@OutputOnly + * Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmStatus?: string; /** - * Zone where the virtual machine is located. Only applicable for instances - * in App Engine flexible environment.@OutputOnly + * Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmZoneName?: string; } @@ -1023,8 +850,7 @@ export namespace appengine_v1 { versions?: Schema$Version[]; } /** - * Health checking configuration for VM instances. Unhealthy instances are - * killed and replaced with new instances. + * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. */ export interface Schema$LivenessCheck { /** @@ -1032,13 +858,11 @@ export namespace appengine_v1 { */ checkInterval?: string; /** - * Number of consecutive failed checks required before considering the VM - * unhealthy. + * Number of consecutive failed checks required before considering the VM unhealthy. */ failureThreshold?: number; /** - * Host header to send when performing a HTTP Liveness check. Example: - * "myapp.appspot.com" + * Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" */ host?: string; /** @@ -1050,8 +874,7 @@ export namespace appengine_v1 { */ path?: string; /** - * Number of consecutive successful checks required before considering the - * VM healthy. + * Number of consecutive successful checks required before considering the VM healthy. */ successThreshold?: number; /** @@ -1064,13 +887,11 @@ export namespace appengine_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -1078,13 +899,11 @@ export namespace appengine_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: "projects/example-project/locations/us-east1" + * Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" */ name?: string; } @@ -1093,13 +912,11 @@ export namespace appengine_v1 { */ export interface Schema$LocationMetadata { /** - * App Engine flexible environment is available in the given - * location.@OutputOnly + * App Engine flexible environment is available in the given location.@OutputOnly */ flexibleEnvironmentAvailable?: boolean; /** - * App Engine standard environment is available in the given - * location.@OutputOnly + * App Engine standard environment is available in the given location.@OutputOnly */ standardEnvironmentAvailable?: boolean; } @@ -1108,78 +925,50 @@ export namespace appengine_v1 { */ export interface Schema$ManagedCertificate { /** - * Time at which the certificate was last renewed. The renewal process is - * fully managed. Certificate renewal will automatically occur before the - * certificate expires. Renewal errors can be tracked via - * ManagementStatus.@OutputOnly + * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly */ lastRenewalTime?: string; /** - * Status of certificate management. Refers to the most recent certificate - * acquisition or renewal attempt.@OutputOnly + * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly */ status?: string; } /** - * A service with manual scaling runs continuously, allowing you to perform - * complex initialization and rely on the state of its memory over time. + * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. */ export interface Schema$ManualScaling { /** - * Number of instances to assign to the service at the start. This number - * can later be altered by using the Modules API - * (https://cloud.google.com/appengine/docs/python/modules/functions) - * set_num_instances() function. + * Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. */ instances?: number; } /** - * Extra network settings. Only applicable in the App Engine flexible - * environment. + * Extra network settings. Only applicable in the App Engine flexible environment. */ export interface Schema$Network { /** - * List of ports, or port pairs, to forward from the virtual machine to the - * application container. Only applicable in the App Engine flexible - * environment. + * List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. */ forwardedPorts?: string[]; /** - * Tag to apply to the instance during creation. Only applicable in the App - * Engine flexible environment. + * Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. */ instanceTag?: string; /** - * Google Compute Engine network where the virtual machines are created. - * Specify the short name, not the resource path.Defaults to default. + * Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. */ name?: string; /** - * Enable session affinity. Only applicable in the App Engine flexible - * environment. + * Enable session affinity. Only applicable in the App Engine flexible environment. */ sessionAffinity?: boolean; /** - * Google Cloud Platform sub-network where the virtual machines are created. - * Specify the short name, not the resource path.If a subnetwork name is - * specified, a network name will also be required unless it is for the - * default network. If the network that the instance is being created in is - * a Legacy network, then the IP address is allocated from the IPv4Range. If - * the network that the instance is being created in is an auto Subnet Mode - * Network, then only network name should be specified (not the - * subnetwork_name) and the IP address is created from the IPCidrRange of - * the subnetwork that exists in that zone for that network. If the network - * that the instance is being created in is a custom Subnet Mode Network, - * then the subnetwork_name must be specified and the IP address is created - * from the IPCidrRange of the subnetwork.If specified, the subnetwork must - * exist in the same region as the App Engine flexible environment - * application. + * Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. */ subnetworkName?: string; } /** - * Target scaling by network usage. Only applicable in the App Engine flexible - * environment. + * Target scaling by network usage. Only applicable in the App Engine flexible environment. */ export interface Schema$NetworkUtilization { /** @@ -1200,14 +989,11 @@ export namespace appengine_v1 { targetSentPacketsPerSecond?: number; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is false, it means the operation is still in progress. If - * true, the operation is completed, and either error or response is - * available. + * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ done?: boolean; /** @@ -1215,26 +1001,15 @@ export namespace appengine_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the name - * should have the format of operations/some/unique/name. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as Delete, the response is - * google.protobuf.Empty. If the original method is standard - * Get/Create/Update, the response should be the resource. For other - * methods, the response should have the type XxxResponse, where Xxx is the - * original method name. For example, if the original method name is - * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. + * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ response?: {[key: string]: any}; } @@ -1248,8 +1023,7 @@ export namespace appengine_v1 { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -1257,13 +1031,11 @@ export namespace appengine_v1 { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -1285,8 +1057,7 @@ export namespace appengine_v1 { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -1294,13 +1065,11 @@ export namespace appengine_v1 { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -1322,8 +1091,7 @@ export namespace appengine_v1 { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -1331,13 +1099,11 @@ export namespace appengine_v1 { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1beta.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -1350,14 +1116,11 @@ export namespace appengine_v1 { warning?: string[]; } /** - * Readiness checking configuration for VM instances. Unhealthy instances are - * removed from traffic rotation. + * Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. */ export interface Schema$ReadinessCheck { /** - * A maximum time limit on application initialization, measured from moment - * the application successfully replies to a healthcheck until it is ready - * to serve traffic. + * A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. */ appStartTimeout?: string; /** @@ -1369,8 +1132,7 @@ export namespace appengine_v1 { */ failureThreshold?: number; /** - * Host header to send when performing a HTTP Readiness check. Example: - * "myapp.appspot.com" + * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" */ host?: string; /** @@ -1378,8 +1140,7 @@ export namespace appengine_v1 { */ path?: string; /** - * Number of consecutive successful checks required before receiving - * traffic. + * Number of consecutive successful checks required before receiving traffic. */ successThreshold?: number; /** @@ -1392,8 +1153,7 @@ export namespace appengine_v1 { */ export interface Schema$RepairApplicationRequest {} /** - * Target scaling by request utilization. Only applicable in the App Engine - * flexible environment. + * Target scaling by request utilization. Only applicable in the App Engine flexible environment. */ export interface Schema$RequestUtilization { /** @@ -1410,13 +1170,11 @@ export namespace appengine_v1 { */ export interface Schema$ResourceRecord { /** - * Relative name of the object affected by this record. Only applicable for - * CNAME records. Example: 'www'. + * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. */ name?: string; /** - * Data for this record. Values vary by record type, as defined in RFC 1035 - * (section 5) and RFC 1034 (section 3.6.1). + * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ rrdata?: string; /** @@ -1455,27 +1213,19 @@ export namespace appengine_v1 { scriptPath?: string; } /** - * A Service resource is a logical component of an application that can share - * state and communicate in a secure fashion with other services. For example, - * an application that handles customer requests might include separate - * services to handle tasks such as backend data analysis or API requests from - * mobile devices. Each service has a collection of versions that define a - * specific set of code used to implement the functionality of that service. + * A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service. */ export interface Schema$Service { /** - * Relative name of the service within the application. Example: - * default.@OutputOnly + * Relative name of the service within the application. Example: default.@OutputOnly */ id?: string; /** - * Full path to the Service resource in the API. Example: - * apps/myapp/services/default.@OutputOnly + * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly */ name?: string; /** - * Mapping that defines fractional HTTP traffic diversion to different - * versions within the service. + * Mapping that defines fractional HTTP traffic diversion to different versions within the service. */ split?: Schema$TrafficSplit; } @@ -1484,29 +1234,15 @@ export namespace appengine_v1 { */ export interface Schema$SslSettings { /** - * ID of the AuthorizedCertificate resource configuring SSL for the - * application. Clearing this field will remove SSL support.By default, a - * managed certificate is automatically created for every domain mapping. To - * omit SSL support or to configure SSL manually, specify - * SslManagementType.MANUAL on a CREATE or UPDATE request. You must be - * authorized to administer the AuthorizedCertificate resource to manually - * map it to a DomainMapping resource. Example: 12345. + * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345. */ certificateId?: string; /** - * ID of the managed AuthorizedCertificate resource currently being - * provisioned, if applicable. Until the new managed certificate has been - * successfully provisioned, the previous SSL state will be preserved. Once - * the provisioning process completes, the certificate_id field will reflect - * the new managed certificate and this field will be left empty. To remove - * SSL support while there is still a pending managed certificate, clear the - * certificate_id field with an UpdateDomainMappingRequest.@OutputOnly + * ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly */ pendingManagedCertificateId?: string; /** - * SSL management type for this domain. If AUTOMATIC, a managed certificate - * is automatically provisioned. If MANUAL, certificate_id must be manually - * specified in order to configure SSL for this domain. + * SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. */ sslManagementType?: string; } @@ -1515,13 +1251,11 @@ export namespace appengine_v1 { */ export interface Schema$StandardSchedulerSettings { /** - * Maximum number of instances to run for this version. Set to zero to - * disable max_instances configuration. + * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. */ maxInstances?: number; /** - * Minimum number of instances to run for this version. Set to zero to - * disable min_instances configuration. + * Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. */ minInstances?: number; /** @@ -1534,23 +1268,15 @@ export namespace appengine_v1 { targetThroughputUtilization?: number; } /** - * Files served directly to the user for a given URL, such as images, CSS - * stylesheets, or JavaScript source files. Static file handlers describe - * which files in the application directory are static files, and which URLs - * serve them. + * Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. */ export interface Schema$StaticFilesHandler { /** - * Whether files should also be uploaded as code data. By default, files - * declared in static file handlers are uploaded as static data and are only - * served to end users; they cannot be read by the application. If enabled, - * uploads are charged against both your code and static data storage - * resource quotas. + * Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas. */ applicationReadable?: boolean; /** - * Time a static file served by this handler should be cached by web proxies - * and browsers. + * Time a static file served by this handler should be cached by web proxies and browsers. */ expiration?: string; /** @@ -1558,62 +1284,24 @@ export namespace appengine_v1 { */ httpHeaders?: {[key: string]: string}; /** - * MIME type used to serve all files served by this handler.Defaults to - * file-specific MIME types, which are derived from each file's filename - * extension. + * MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension. */ mimeType?: string; /** - * Path to the static files matched by the URL pattern, from the application - * root directory. The path can refer to text matched in groupings in the - * URL pattern. + * Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern. */ path?: string; /** - * Whether this handler should match the request if the file referenced by - * the handler does not exist. + * Whether this handler should match the request if the file referenced by the handler does not exist. */ requireMatchingFile?: boolean; /** - * Regular expression that matches the file paths for all files that should - * be referenced by this handler. + * Regular expression that matches the file paths for all files that should be referenced by this handler. */ uploadPathRegex?: string; } /** - * The Status type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by gRPC (https://github.com/grpc). The error model is designed to be: - * Simple to use and understand for most users Flexible enough to meet - * unexpected needsOverviewThe Status message contains three pieces of data: - * error code, error message, and error details. The error code should be an - * enum value of google.rpc.Code, but it may accept additional error codes if - * needed. The error message should be a developer-facing English message that - * helps developers understand and resolve the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may - * contain arbitrary information about the error. There is a predefined set of - * error detail types in the package google.rpc that can be used for common - * error conditions.Language mappingThe Status message is the logical - * representation of the error model, but it is not necessarily the actual - * wire format. When the Status message is exposed in different client - * libraries and different wire protocols, it can be mapped differently. For - * example, it will likely be mapped to some exceptions in Java, but more - * likely mapped to some error codes in C.Other usesThe error model and the - * Status message can be used in a variety of environments, either with or - * without APIs, to provide a consistent developer experience across different - * environments.Example uses of this error model include: Partial errors. If a - * service needs to return partial errors to the client, it may embed the - * Status in the normal response to indicate the partial errors. Workflow - * errors. A typical workflow has multiple steps. Each step may have a Status - * message for error reporting. Batch operations. If a client uses batch - * request and batch response, the Status message should be used directly - * inside batch response, one for each error sub-response. Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the Status message. Logging. If some API errors are stored in logs, - * the message Status could be used directly after any stripping needed for - * security/privacy reasons. + * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1621,37 +1309,24 @@ export namespace appengine_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Traffic routing configuration for versions within a single service. Traffic - * splits define how traffic directed to the service is assigned to versions. + * Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. */ export interface Schema$TrafficSplit { /** - * Mapping from version IDs within the service to fractional (0.000, 1] - * allocations of traffic for that version. Each version can be specified - * only once, but some versions in the service may not have any traffic - * allocation. Services that have traffic allocated cannot be deleted until - * either the service is deleted or their traffic allocation is removed. - * Allocations must sum to 1. Up to two decimal place precision is supported - * for IP-based splits and up to three decimal places is supported for - * cookie-based splits. + * Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits. */ allocations?: {[key: string]: number}; /** - * Mechanism used to determine which version a request is sent to. The - * traffic selection algorithm will be stable for either type until - * allocations are changed. + * Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed. */ shardBy?: string; } @@ -1660,27 +1335,20 @@ export namespace appengine_v1 { */ export interface Schema$UrlDispatchRule { /** - * Domain name to match against. The wildcard "*" is supported if - * specified before a period: "*.".Defaults to matching all - * domains: "*". + * Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*". */ domain?: string; /** - * Pathname within the host. Must start with a "/". A single - * "*" can be included at the end of the path.The sum of the - * lengths of the domain and path may not exceed 100 characters. + * Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters. */ path?: string; /** - * Resource ID of a service in this application that should serve the - * matched request. The service must already exist. Example: default. + * Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default. */ service?: string; } /** - * URL pattern and description of how the URL should be handled. App Engine - * can handle URLs by executing application code or by serving static files - * uploaded with the version, such as images, CSS, or JavaScript. + * URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript. */ export interface Schema$UrlMap { /** @@ -1688,24 +1356,19 @@ export namespace appengine_v1 { */ apiEndpoint?: Schema$ApiEndpointHandler; /** - * Action to take when users access resources that require authentication. - * Defaults to redirect. + * Action to take when users access resources that require authentication. Defaults to redirect. */ authFailAction?: string; /** - * Level of login required to access this resource. Not supported for - * Node.js in the App Engine standard environment. + * Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. */ login?: string; /** - * 30x code to use when performing redirects for the secure field. Defaults - * to 302. + * 30x code to use when performing redirects for the secure field. Defaults to 302. */ redirectHttpResponseCode?: string; /** - * Executes a script to handle the requests that match this URL pattern. - * Only the auto value is supported for Node.js in the App Engine standard - * environment, for example "script": "auto". + * Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". */ script?: Schema$ScriptHandler; /** @@ -1717,39 +1380,28 @@ export namespace appengine_v1 { */ staticFiles?: Schema$StaticFilesHandler; /** - * URL prefix. Uses regular expression syntax, which means regexp special - * characters must be escaped, but should not contain groupings. All URLs - * that begin with this prefix are handled by this handler, using the - * portion of the URL after the prefix as part of the file path. + * URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. */ urlRegex?: string; } /** - * A Version resource is a specific set of source code and configuration files - * that are deployed into a service. + * A Version resource is a specific set of source code and configuration files that are deployed into a service. */ export interface Schema$Version { /** - * Serving configuration for Google Cloud Endpoints - * (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned - * in GET requests if view=FULL is set. + * Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set. */ apiConfig?: Schema$ApiConfigHandler; /** - * Automatic scaling is based on request rate, response latencies, and other - * application metrics. + * Automatic scaling is based on request rate, response latencies, and other application metrics. */ automaticScaling?: Schema$AutomaticScaling; /** - * A service with basic scaling will create an instance when the application - * receives a request. The instance will be turned down when the app becomes - * idle. Basic scaling is ideal for work that is intermittent or driven by - * user activity. + * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. */ basicScaling?: Schema$BasicScaling; /** - * Metadata settings that are supplied to this version to enable beta - * runtime features. + * Metadata settings that are supplied to this version to enable beta runtime features. */ betaSettings?: {[key: string]: string}; /** @@ -1761,27 +1413,19 @@ export namespace appengine_v1 { */ createTime?: string; /** - * Duration that static files should be cached by web proxies and browsers. - * Only applicable if the corresponding StaticFilesHandler - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) - * does not specify its own expiration time.Only returned in GET requests if - * view=FULL is set. + * Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. */ defaultExpiration?: string; /** - * Code and application artifacts that make up this version.Only returned in - * GET requests if view=FULL is set. + * Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. */ deployment?: Schema$Deployment; /** - * Total size in bytes of all the files that are included in this version - * and currently hosted on the App Engine disk.@OutputOnly + * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly */ diskUsageBytes?: string; /** - * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud - * Endpoints Extensible Service Proxy will be provided to serve the API - * implemented by the app. + * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. */ endpointsApiService?: Schema$EndpointsApiService; /** @@ -1793,88 +1437,63 @@ export namespace appengine_v1 { */ env?: string; /** - * Environment variables available to the application.Only returned in GET - * requests if view=FULL is set. + * Environment variables available to the application.Only returned in GET requests if view=FULL is set. */ envVariables?: {[key: string]: string}; /** - * Custom static error pages. Limited to 10KB per page.Only returned in GET - * requests if view=FULL is set. + * Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. */ errorHandlers?: Schema$ErrorHandler[]; /** - * An ordered list of URL-matching patterns that should be applied to - * incoming requests. The first matching URL handles the request and other - * request handlers are not attempted.Only returned in GET requests if - * view=FULL is set. + * An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set. */ handlers?: Schema$UrlMap[]; /** - * Configures health checking for instances. Unhealthy instances are stopped - * and replaced with new instances. Only applicable in the App Engine - * flexible environment.Only returned in GET requests if view=FULL is set. + * Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set. */ healthCheck?: Schema$HealthCheck; /** - * Relative name of the version within the service. Example: v1. Version - * names can contain only lowercase letters, numbers, or hyphens. Reserved - * names: "default", "latest", and any name with the - * prefix "ah-". + * Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". */ id?: string; /** - * Before an application can receive email or XMPP messages, the application - * must be configured to enable the service. + * Before an application can receive email or XMPP messages, the application must be configured to enable the service. */ inboundServices?: string[]; /** - * Instance class that is used to run this version. Valid values are: - * AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, - * B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for - * ManualScaling or BasicScaling. + * Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. */ instanceClass?: string; /** - * Configuration for third-party Python runtime libraries that are required - * by the application.Only returned in GET requests if view=FULL is set. + * Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. */ libraries?: Schema$Library[]; /** - * Configures liveness health checking for instances. Unhealthy instances - * are stopped and replaced with new instancesOnly returned in GET requests - * if view=FULL is set. + * Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. */ livenessCheck?: Schema$LivenessCheck; /** - * A service with manual scaling runs continuously, allowing you to perform - * complex initialization and rely on the state of its memory over time. + * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. */ manualScaling?: Schema$ManualScaling; /** - * Full path to the Version resource in the API. Example: - * apps/myapp/services/default/versions/v1.@OutputOnly + * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly */ name?: string; /** - * Extra network settings. Only applicable in the App Engine flexible - * environment. + * Extra network settings. Only applicable in the App Engine flexible environment. */ network?: Schema$Network; /** - * Files that match this pattern will not be built into this version. Only - * applicable for Go runtimes.Only returned in GET requests if view=FULL is - * set. + * Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. */ nobuildFilesRegex?: string; /** - * Configures readiness health checking for instances. Unhealthy instances - * are not put into the backend traffic rotation.Only returned in GET - * requests if view=FULL is set. + * Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. */ readinessCheck?: Schema$ReadinessCheck; /** - * Machine resources for this version. Only applicable in the App Engine - * flexible environment. + * Machine resources for this version. Only applicable in the App Engine flexible environment. */ resources?: Schema$Resources; /** @@ -1882,14 +1501,11 @@ export namespace appengine_v1 { */ runtime?: string; /** - * The version of the API in the given runtime environment. Please see the - * app.yaml reference for valid values at - * https://cloud.google.com/appengine/docs/standard/<language>/config/appref + * The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref */ runtimeApiVersion?: string; /** - * The channel of the runtime to use. Only available for some runtimes. - * Defaults to the default channel. + * The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. */ runtimeChannel?: string; /** @@ -1897,9 +1513,7 @@ export namespace appengine_v1 { */ runtimeMainExecutablePath?: string; /** - * Current serving status of this version. Only the versions with a SERVING - * status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is - * an invalid value. Defaults to SERVING. + * Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. */ servingStatus?: string; /** @@ -1907,8 +1521,7 @@ export namespace appengine_v1 { */ threadsafe?: boolean; /** - * Serving URL for this version. Example: - * "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly */ versionUrl?: string; /** @@ -1920,14 +1533,12 @@ export namespace appengine_v1 { */ vpcAccessConnector?: Schema$VpcAccessConnector; /** - * The Google Compute Engine zones that are supported by this version in the - * App Engine flexible environment. Deprecated. + * The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. */ zones?: string[]; } /** - * Volumes mounted within the app container. Only applicable in the App Engine - * flexible environment. + * Volumes mounted within the app container. Only applicable in the App Engine flexible environment. */ export interface Schema$Volume { /** @@ -1948,8 +1559,7 @@ export namespace appengine_v1 { */ export interface Schema$VpcAccessConnector { /** - * Full Serverless VPC Access Connector name e.g. - * /projects/my-project/locations/us-central1/connectors/c1. + * Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. */ name?: string; } @@ -1958,15 +1568,11 @@ export namespace appengine_v1 { */ export interface Schema$ZipInfo { /** - * An estimate of the number of files in a zip for a zip deployment. If set, - * must be greater than or equal to the actual number of files. Used for - * optimizing performance; if not provided, deployment may be slow. + * An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. */ filesCount?: number; /** - * URL of the zip file to deploy from. Must be a URL to a resource in Google - * Cloud Storage in the form - * 'http(s)://storage.googleapis.com/<bucket>/<object>'. + * URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ sourceUrl?: string; } @@ -1997,13 +1603,7 @@ export namespace appengine_v1 { /** * appengine.apps.create - * @desc Creates an App Engine application for a Google Cloud Platform - * project. Required fields: id - The ID of the target Cloud Platform - * project. location - The region - * (https://cloud.google.com/appengine/docs/locations) where you want the - * App Engine application located.For more information about App Engine - * applications, see Managing Projects, Applications, and Billing - * (https://cloud.google.com/appengine/docs/standard/python/console/). + * @desc Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/). * @alias appengine.apps.create * @memberOf! () * @@ -2143,10 +1743,7 @@ export namespace appengine_v1 { /** * appengine.apps.patch - * @desc Updates the specified Application resource. You can update the - * following fields: auth_domain - Google authentication domain for - * controlling user access to the application. default_cookie_expiration - - * Cookie expiration policy for the application. + * @desc Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. * @alias appengine.apps.patch * @memberOf! () * @@ -2218,16 +1815,7 @@ export namespace appengine_v1 { /** * appengine.apps.repair - * @desc Recreates the required App Engine features for the specified App - * Engine application, for example a Cloud Storage bucket or App Engine - * service account. Use this method if you receive an error message about a - * missing feature, for example, Error retrieving the App Engine service - * account. If you have deleted your App Engine service account, this will - * not be able to recreate it. Instead, you should attempt to use the IAM - * undelete API if possible at - * https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D - * . If the deletion was recent, the numeric ID can be found in the Cloud - * Console Activity Log. + * @desc Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log. * @alias appengine.apps.repair * @memberOf! () * @@ -2318,8 +1906,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Application resource to get. Example: - * apps/myapp. + * Part of `name`. Name of the Application resource to get. Example: apps/myapp. */ appsId?: string; } @@ -2330,8 +1917,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Application resource to update. Example: - * apps/myapp. + * Part of `name`. Name of the Application resource to update. Example: apps/myapp. */ appsId?: string; /** @@ -2683,11 +2269,7 @@ export namespace appengine_v1 { /** * appengine.apps.authorizedCertificates.patch - * @desc Updates the specified SSL certificate. To renew a certificate and - * maintain its existing domain mappings, update certificate_data with a new - * certificate. The new certificate must be applicable to the same domains - * as the original certificate. The certificate display_name may also be - * updated. + * @desc Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated. * @alias appengine.apps.authorizedCertificates.patch * @memberOf! () * @@ -2773,8 +2355,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; @@ -2791,8 +2372,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to delete. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -2808,8 +2388,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -2829,8 +2408,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -2854,8 +2432,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -2863,8 +2440,7 @@ export namespace appengine_v1 { */ authorizedCertificatesId?: string; /** - * Standard field mask for the set of fields to be updated. Updates are only - * supported on the certificate_raw_data and display_name fields. + * Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. */ updateMask?: string; @@ -2974,8 +2550,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -2996,10 +2571,7 @@ export namespace appengine_v1 { /** * appengine.apps.domainMappings.create - * @desc Maps a domain to an application. A user must be authorized to - * administer a domain in order to map it to an application. For a list of - * available authorized domains, see - * AuthorizedDomains.ListAuthorizedDomains. + * @desc Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains. * @alias appengine.apps.domainMappings.create * @memberOf! () * @@ -3075,9 +2647,7 @@ export namespace appengine_v1 { /** * appengine.apps.domainMappings.delete - * @desc Deletes the specified domain mapping. A user must be authorized to - * administer the associated domain in order to delete a DomainMapping - * resource. + * @desc Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource. * @alias appengine.apps.domainMappings.delete * @memberOf! () * @@ -3308,10 +2878,7 @@ export namespace appengine_v1 { /** * appengine.apps.domainMappings.patch - * @desc Updates the specified domain mapping. To map an SSL certificate to - * a domain mapping, update certificate_id to point to an - * AuthorizedCertificate resource. A user must be authorized to administer - * the associated domain in order to update a DomainMapping resource. + * @desc Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource. * @alias appengine.apps.domainMappings.patch * @memberOf! () * @@ -3394,13 +2961,11 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** - * Whether the domain creation should override any existing mappings for - * this domain. By default, overrides are rejected. + * Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. */ overrideStrategy?: string; @@ -3417,8 +2982,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to delete. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -3434,8 +2998,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -3451,8 +3014,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -3472,8 +3034,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -3508,11 +3069,7 @@ export namespace appengine_v1 { /** * appengine.apps.firewall.ingressRules.batchUpdate - * @desc Replaces the entire firewall ruleset in one bulk operation. This - * overrides and replaces the rules of an existing firewall with the new - * rules.If the final rule does not match traffic with the '*' wildcard IP - * range, then an "allow all" rule is explicitly added to the end of the - * list. + * @desc Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list. * @alias appengine.apps.firewall.ingressRules.batchUpdate * @memberOf! () * @@ -3981,8 +3538,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall collection to set. Example: - * apps/myapp/firewall/ingressRules. + * Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules. */ appsId?: string; @@ -3999,8 +3555,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Firewall collection in which to - * create a new rule. Example: apps/myapp/firewall/ingressRules. + * Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules. */ appsId?: string; @@ -4017,8 +3572,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall resource to delete. Example: - * apps/myapp/firewall/ingressRules/100. + * Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100. */ appsId?: string; /** @@ -4034,8 +3588,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall resource to retrieve. Example: - * apps/myapp/firewall/ingressRules/100. + * Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. */ appsId?: string; /** @@ -4051,14 +3604,11 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the Firewall collection to retrieve. Example: - * apps/myapp/firewall/ingressRules. + * Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules. */ appsId?: string; /** - * A valid IP Address. If set, only rules matching this address will be - * returned. The first returned rule will be the rule that fires on requests - * from this IP. + * A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP. */ matchingAddress?: string; /** @@ -4078,8 +3628,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall resource to update. Example: - * apps/myapp/firewall/ingressRules/100. + * Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100. */ appsId?: string; /** @@ -4279,8 +3828,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. The resource that owns the locations collection, if - * applicable. + * Part of `name`. The resource that owns the locations collection, if applicable. */ appsId?: string; /** @@ -4305,9 +3853,7 @@ export namespace appengine_v1 { /** * appengine.apps.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias appengine.apps.operations.get * @memberOf! () * @@ -4381,15 +3927,7 @@ export namespace appengine_v1 { /** * appengine.apps.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: - * the name binding allows API services to override the binding to use - * different resource name schemes, such as users/x/operations. To override - * the binding, API services can add a binding such as - * "/v1/{name=users/x}/operations" to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias appengine.apps.operations.list * @memberOf! () * @@ -4829,8 +4367,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -4846,8 +4383,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -4863,8 +4399,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -4884,24 +4419,11 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/services/default. + * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. */ appsId?: string; /** - * Set to true to gradually shift traffic to one or more versions that you - * specify. By default, traffic is shifted immediately. For gradual traffic - * migration, the target versions must be located within instances that are - * configured for both warmup requests - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) - * and automatic scaling - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). - * You must specify the shardBy - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) - * field in the Service resource. Gradual traffic migration is not supported - * in the App Engine flexible environment. For examples, see Migrating and - * Splitting Traffic - * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + * Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). */ migrateTraffic?: boolean; /** @@ -5082,9 +4604,7 @@ export namespace appengine_v1 { /** * appengine.apps.services.versions.get - * @desc Gets the specified Version resource. By default, only a BASIC_VIEW - * will be returned. Specify the FULL_VIEW parameter to get the full - * resource. + * @desc Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource. * @alias appengine.apps.services.versions.get * @memberOf! () * @@ -5238,36 +4758,7 @@ export namespace appengine_v1 { /** * appengine.apps.services.versions.patch - * @desc Updates the specified Version resource. You can specify the - * following fields depending on the App Engine environment and type of - * scaling that the version resource uses:Standard environment - * instance_class - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic - * scaling in the standard environment: automatic_scaling.min_idle_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.max_idle_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) - * automaticScaling.standard_scheduler_settings.max_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) - * automaticScaling.standard_scheduler_settings.min_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) - * automaticScaling.standard_scheduler_settings.target_cpu_utilization - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) - * automaticScaling.standard_scheduler_settings.target_throughput_utilization - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic - * scaling or manual scaling in the standard environment: serving_status - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)Flexible - * environment serving_status - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic - * scaling in the flexible environment: - * automatic_scaling.min_total_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.max_total_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.cool_down_period_sec - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.cpu_utilization.target_utilization - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + * @desc Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) * @alias appengine.apps.services.versions.patch * @memberOf! () * @@ -5352,8 +4843,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent resource to create this version - * under. Example: apps/myapp/services/default. + * Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -5374,8 +4864,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. */ appsId?: string; /** @@ -5395,8 +4884,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. */ appsId?: string; /** @@ -5420,8 +4908,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Service resource. Example: - * apps/myapp/services/default. + * Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -5449,8 +4936,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/services/default/versions/1. + * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. */ appsId?: string; /** @@ -5480,12 +4966,7 @@ export namespace appengine_v1 { /** * appengine.apps.services.versions.instances.debug - * @desc Enables debugging on a VM instance. This allows you to use the SSH - * command to connect to the virtual machine where the instance lives. While - * in "debug mode", the instance continues to serve live traffic. You should - * delete the instance when you are done debugging and then allow the system - * to take over and determine if another instance should be started.Only - * applicable for instances in App Engine flexible environment. + * @desc Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment. * @alias appengine.apps.services.versions.instances.debug * @memberOf! () * @@ -5715,9 +5196,7 @@ export namespace appengine_v1 { /** * appengine.apps.services.versions.instances.list - * @desc Lists the instances of a version.Tip: To aggregate details about - * instances over time, see the Stackdriver Monitoring API - * (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). + * @desc Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). * @alias appengine.apps.services.versions.instances.list * @memberOf! () * @@ -5804,8 +5283,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. */ appsId?: string; /** @@ -5834,8 +5312,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. */ appsId?: string; /** @@ -5859,8 +5336,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. */ appsId?: string; /** @@ -5884,8 +5360,7 @@ export namespace appengine_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Version resource. Example: - * apps/myapp/services/default/versions/v1. + * Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1. */ appsId?: string; /** diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 46460eb4efd..4d78e75687f 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace appengine_v1alpha { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace appengine_v1alpha { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,89 +108,66 @@ export namespace appengine_v1alpha { apps: Resource$Apps; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.apps = new Resource$Apps(this.context); } } /** - * An SSL certificate that a user has been authorized to administer. A user is - * authorized to administer any certificate that applies to one of their - * authorized domains. + * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. */ export interface Schema$AuthorizedCertificate { /** - * The SSL certificate serving the AuthorizedCertificate resource. This must - * be obtained independently from a certificate authority. + * The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. */ certificateRawData?: Schema$CertificateRawData; /** - * The user-specified display name of the certificate. This is not - * guaranteed to be unique. Example: My Certificate. + * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. */ displayName?: string; /** - * Aggregate count of the domain mappings with this certificate mapped. This - * count includes domain mappings on applications for which the user does - * not have VIEWER permissions.Only returned by GET or LIST requests when - * specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ domainMappingsCount?: number; /** - * Topmost applicable domains of this certificate. This certificate applies - * to these domains and their subdomains. Example: example.com.@OutputOnly + * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly */ domainNames?: string[]; /** - * The time when this certificate expires. To update the renewal time on - * this certificate, upload an SSL certificate with a different expiration - * time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly */ expireTime?: string; /** - * Relative name of the certificate. This is a unique value autogenerated on - * AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly */ id?: string; /** - * Only applicable if this certificate is managed by App Engine. Managed - * certificates are tied to the lifecycle of a DomainMapping and cannot be - * updated or deleted via the AuthorizedCertificates API. If this - * certificate is manually administered by the user, this field will be - * empty.@OutputOnly + * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly */ managedCertificate?: Schema$ManagedCertificate; /** - * Full path to the AuthorizedCertificate resource in the API. Example: - * apps/myapp/authorizedCertificates/12345.@OutputOnly + * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly */ name?: string; /** - * The full paths to user visible Domain Mapping resources that have this - * certificate mapped. Example: apps/myapp/domainMappings/example.com.This - * may not represent the full list of mapped domain mappings if the user - * does not have VIEWER permissions on all of the applications that have - * this certificate mapped. See domain_mappings_count for a complete - * count.Only returned by GET or LIST requests when specifically requested - * by the view=FULL_CERTIFICATE option.@OutputOnly + * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ visibleDomainMappings?: string[]; } /** - * A domain that a user has been authorized to administer. To authorize use of - * a domain, verify ownership via Webmaster Central - * (https://www.google.com/webmasters/verification/home). + * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home). */ export interface Schema$AuthorizedDomain { /** - * Fully qualified domain name of the domain authorized for use. Example: - * example.com. + * Fully qualified domain name of the domain authorized for use. Example: example.com. */ id?: string; /** - * Full path to the AuthorizedDomain resource in the API. Example: - * apps/myapp/authorizedDomains/example.com.@OutputOnly + * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly */ name?: string; } @@ -203,51 +176,38 @@ export namespace appengine_v1alpha { */ export interface Schema$CertificateRawData { /** - * Unencrypted PEM encoded RSA private key. This field is set once on - * certificate creation and then encrypted. The key size must be 2048 bits - * or fewer. Must include the header and footer. Example: <pre> - * -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END - * RSA PRIVATE KEY----- </pre> @InputOnly + * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly */ privateKey?: string; /** - * PEM encoded x.509 public key certificate. This field is set once on - * certificate creation. Must include the header and footer. Example: - * <pre> -----BEGIN CERTIFICATE----- <certificate_value> - * -----END CERTIFICATE----- </pre> + * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre> */ publicCertificate?: string; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1 { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1alpha.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Alpha { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1beta.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Beta { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } @@ -256,33 +216,24 @@ export namespace appengine_v1alpha { */ export interface Schema$DomainMapping { /** - * Relative name of the domain serving the application. Example: - * example.com. + * Relative name of the domain serving the application. Example: example.com. */ id?: string; /** - * Full path to the DomainMapping resource in the API. Example: - * apps/myapp/domainMapping/example.com.@OutputOnly + * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly */ name?: string; /** - * The resource records required to configure this domain mapping. These - * records must be added to the domain's DNS configuration in order to - * serve the application via this domain mapping.@OutputOnly + * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly */ resourceRecords?: Schema$ResourceRecord[]; /** - * SSL configuration for this domain. If unconfigured, this domain will not - * serve with SSL. + * SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. */ sslSettings?: Schema$SslSettings; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** @@ -355,13 +306,11 @@ export namespace appengine_v1alpha { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -369,13 +318,11 @@ export namespace appengine_v1alpha { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: "projects/example-project/locations/us-east1" + * Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" */ name?: string; } @@ -384,13 +331,11 @@ export namespace appengine_v1alpha { */ export interface Schema$LocationMetadata { /** - * App Engine flexible environment is available in the given - * location.@OutputOnly + * App Engine flexible environment is available in the given location.@OutputOnly */ flexibleEnvironmentAvailable?: boolean; /** - * App Engine standard environment is available in the given - * location.@OutputOnly + * App Engine standard environment is available in the given location.@OutputOnly */ standardEnvironmentAvailable?: boolean; } @@ -399,27 +344,20 @@ export namespace appengine_v1alpha { */ export interface Schema$ManagedCertificate { /** - * Time at which the certificate was last renewed. The renewal process is - * fully managed. Certificate renewal will automatically occur before the - * certificate expires. Renewal errors can be tracked via - * ManagementStatus.@OutputOnly + * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly */ lastRenewalTime?: string; /** - * Status of certificate management. Refers to the most recent certificate - * acquisition or renewal attempt.@OutputOnly + * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly */ status?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is false, it means the operation is still in progress. If - * true, the operation is completed, and either error or response is - * available. + * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ done?: boolean; /** @@ -427,26 +365,15 @@ export namespace appengine_v1alpha { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the name - * should have the format of operations/some/unique/name. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as Delete, the response is - * google.protobuf.Empty. If the original method is standard - * Get/Create/Update, the response should be the resource. For other - * methods, the response should have the type XxxResponse, where Xxx is the - * original method name. For example, if the original method name is - * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. + * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ response?: {[key: string]: any}; } @@ -460,8 +387,7 @@ export namespace appengine_v1alpha { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -469,13 +395,11 @@ export namespace appengine_v1alpha { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -497,8 +421,7 @@ export namespace appengine_v1alpha { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -506,13 +429,11 @@ export namespace appengine_v1alpha { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -534,8 +455,7 @@ export namespace appengine_v1alpha { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -543,13 +463,11 @@ export namespace appengine_v1alpha { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1beta.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -566,13 +484,11 @@ export namespace appengine_v1alpha { */ export interface Schema$ResourceRecord { /** - * Relative name of the object affected by this record. Only applicable for - * CNAME records. Example: 'www'. + * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. */ name?: string; /** - * Data for this record. Values vary by record type, as defined in RFC 1035 - * (section 5) and RFC 1034 (section 3.6.1). + * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ rrdata?: string; /** @@ -585,57 +501,16 @@ export namespace appengine_v1alpha { */ export interface Schema$SslSettings { /** - * ID of the AuthorizedCertificate resource configuring SSL for the - * application. Clearing this field will remove SSL support.By default, a - * managed certificate is automatically created for every domain mapping. To - * omit SSL support or to configure SSL manually, specify - * no_managed_certificate on a CREATE or UPDATE request. You must be - * authorized to administer the AuthorizedCertificate resource to manually - * map it to a DomainMapping resource. Example: 12345. + * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345. */ certificateId?: string; /** - * Whether the mapped certificate is an App Engine managed certificate. - * Managed certificates are created by default with a domain mapping. To opt - * out, specify no_managed_certificate on a CREATE or UPDATE - * request.@OutputOnly + * Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly */ isManagedCertificate?: boolean; } /** - * The Status type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by gRPC (https://github.com/grpc). The error model is designed to be: - * Simple to use and understand for most users Flexible enough to meet - * unexpected needsOverviewThe Status message contains three pieces of data: - * error code, error message, and error details. The error code should be an - * enum value of google.rpc.Code, but it may accept additional error codes if - * needed. The error message should be a developer-facing English message that - * helps developers understand and resolve the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may - * contain arbitrary information about the error. There is a predefined set of - * error detail types in the package google.rpc that can be used for common - * error conditions.Language mappingThe Status message is the logical - * representation of the error model, but it is not necessarily the actual - * wire format. When the Status message is exposed in different client - * libraries and different wire protocols, it can be mapped differently. For - * example, it will likely be mapped to some exceptions in Java, but more - * likely mapped to some error codes in C.Other usesThe error model and the - * Status message can be used in a variety of environments, either with or - * without APIs, to provide a consistent developer experience across different - * environments.Example uses of this error model include: Partial errors. If a - * service needs to return partial errors to the client, it may embed the - * Status in the normal response to indicate the partial errors. Workflow - * errors. A typical workflow has multiple steps. Each step may have a Status - * message for error reporting. Batch operations. If a client uses batch - * request and batch response, the Status message should be used directly - * inside batch response, one for each error sub-response. Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the Status message. Logging. If some API errors are stored in logs, - * the message Status could be used directly after any stripping needed for - * security/privacy reasons. + * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -643,14 +518,11 @@ export namespace appengine_v1alpha { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -996,11 +868,7 @@ export namespace appengine_v1alpha { /** * appengine.apps.authorizedCertificates.patch - * @desc Updates the specified SSL certificate. To renew a certificate and - * maintain its existing domain mappings, update certificate_data with a new - * certificate. The new certificate must be applicable to the same domains - * as the original certificate. The certificate display_name may also be - * updated. + * @desc Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated. * @alias appengine.apps.authorizedCertificates.patch * @memberOf! () * @@ -1086,8 +954,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; @@ -1104,8 +971,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to delete. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -1121,8 +987,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -1142,8 +1007,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -1167,8 +1031,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -1176,8 +1039,7 @@ export namespace appengine_v1alpha { */ authorizedCertificatesId?: string; /** - * Standard field mask for the set of fields to be updated. Updates are only - * supported on the certificate_raw_data and display_name fields. + * Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. */ updateMask?: string; @@ -1287,8 +1149,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -1309,10 +1170,7 @@ export namespace appengine_v1alpha { /** * appengine.apps.domainMappings.create - * @desc Maps a domain to an application. A user must be authorized to - * administer a domain in order to map it to an application. For a list of - * available authorized domains, see - * AuthorizedDomains.ListAuthorizedDomains. + * @desc Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains. * @alias appengine.apps.domainMappings.create * @memberOf! () * @@ -1389,9 +1247,7 @@ export namespace appengine_v1alpha { /** * appengine.apps.domainMappings.delete - * @desc Deletes the specified domain mapping. A user must be authorized to - * administer the associated domain in order to delete a DomainMapping - * resource. + * @desc Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource. * @alias appengine.apps.domainMappings.delete * @memberOf! () * @@ -1624,10 +1480,7 @@ export namespace appengine_v1alpha { /** * appengine.apps.domainMappings.patch - * @desc Updates the specified domain mapping. To map an SSL certificate to - * a domain mapping, update certificate_id to point to an - * AuthorizedCertificate resource. A user must be authorized to administer - * the associated domain in order to update a DomainMapping resource. + * @desc Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource. * @alias appengine.apps.domainMappings.patch * @memberOf! () * @@ -1712,20 +1565,15 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** - * Whether a managed certificate should be provided by App Engine. If true, - * a certificate ID must be manaually set in the DomainMapping resource to - * configure SSL for this domain. If false, a managed certificate will be - * provisioned and a certificate ID will be automatically populated. + * Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. */ noManagedCertificate?: boolean; /** - * Whether the domain creation should override any existing mappings for - * this domain. By default, overrides are rejected. + * Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. */ overrideStrategy?: string; @@ -1742,8 +1590,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to delete. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -1759,8 +1606,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -1776,8 +1622,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -1797,8 +1642,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -1806,12 +1650,7 @@ export namespace appengine_v1alpha { */ domainMappingsId?: string; /** - * Whether a managed certificate should be provided by App Engine. If true, - * a certificate ID must be manually set in the DomainMapping resource to - * configure SSL for this domain. If false, a managed certificate will be - * provisioned and a certificate ID will be automatically populated. Only - * applicable if ssl_settings.certificate_id is specified in the update - * mask. + * Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask. */ noManagedCertificate?: boolean; /** @@ -2007,8 +1846,7 @@ export namespace appengine_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. The resource that owns the locations collection, if - * applicable. + * Part of `name`. The resource that owns the locations collection, if applicable. */ appsId?: string; /** @@ -2033,9 +1871,7 @@ export namespace appengine_v1alpha { /** * appengine.apps.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias appengine.apps.operations.get * @memberOf! () * @@ -2109,15 +1945,7 @@ export namespace appengine_v1alpha { /** * appengine.apps.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: - * the name binding allows API services to override the binding to use - * different resource name schemes, such as users/x/operations. To override - * the binding, API services can add a binding such as - * "/v1/{name=users/x}/operations" to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias appengine.apps.operations.list * @memberOf! () * diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 4922770e338..eae4690bf9b 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace appengine_v1beta { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace appengine_v1beta { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,21 +108,21 @@ export namespace appengine_v1beta { apps: Resource$Apps; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.apps = new Resource$Apps(this.context); } } /** - * Google Cloud Endpoints - * (https://cloud.google.com/appengine/docs/python/endpoints/) configuration - * for API handlers. + * Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. */ export interface Schema$ApiConfigHandler { /** - * Action to take when users access resources that require authentication. - * Defaults to redirect. + * Action to take when users access resources that require authentication. Defaults to redirect. */ authFailAction?: string; /** @@ -156,24 +152,19 @@ export namespace appengine_v1beta { scriptPath?: string; } /** - * An Application resource contains the top-level configuration of an App - * Engine application. + * An Application resource contains the top-level configuration of an App Engine application. */ export interface Schema$Application { /** - * Google Apps authentication domain that controls which users can access - * this application.Defaults to open access for any Google Account. + * Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. */ authDomain?: string; /** - * Google Cloud Storage bucket that can be used for storing files associated - * with this application. This bucket is associated with the application and - * can be used by the gcloud deployment commands.@OutputOnly + * Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly */ codeBucket?: string; /** - * Google Cloud Storage bucket that can be used by this application to store - * content.@OutputOnly + * Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly */ defaultBucket?: string; /** @@ -181,14 +172,11 @@ export namespace appengine_v1beta { */ defaultCookieExpiration?: string; /** - * Hostname used to reach this application, as resolved by App - * Engine.@OutputOnly + * Hostname used to reach this application, as resolved by App Engine.@OutputOnly */ defaultHostname?: string; /** - * HTTP path dispatch rules for requests to the application that do not - * explicitly target a service or version. Rules are order-dependent. Up to - * 20 dispatch rules can be supported. + * HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. */ dispatchRules?: Schema$UrlDispatchRule[]; /** @@ -196,28 +184,20 @@ export namespace appengine_v1beta { */ featureSettings?: Schema$FeatureSettings; /** - * The Google Container Registry domain used for storing managed build - * docker images for this application. + * The Google Container Registry domain used for storing managed build docker images for this application. */ gcrDomain?: string; iap?: Schema$IdentityAwareProxy; /** - * Identifier of the Application resource. This identifier is equivalent to - * the project ID of the Google Cloud Platform project where you want to - * deploy your application. Example: myapp. + * Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp. */ id?: string; /** - * Location from which this application runs. Application instances run out - * of the data centers in the specified location, which is also where all of - * the application's end user content is stored.Defaults to - * us-central.View the list of supported locations - * (https://cloud.google.com/appengine/docs/locations). + * Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). */ locationId?: string; /** - * Full path to the Application resource in the API. Example: - * apps/myapp.@OutputOnly + * Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly */ name?: string; /** @@ -226,97 +206,65 @@ export namespace appengine_v1beta { servingStatus?: string; } /** - * An SSL certificate that a user has been authorized to administer. A user is - * authorized to administer any certificate that applies to one of their - * authorized domains. + * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. */ export interface Schema$AuthorizedCertificate { /** - * The SSL certificate serving the AuthorizedCertificate resource. This must - * be obtained independently from a certificate authority. + * The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. */ certificateRawData?: Schema$CertificateRawData; /** - * The user-specified display name of the certificate. This is not - * guaranteed to be unique. Example: My Certificate. + * The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. */ displayName?: string; /** - * Aggregate count of the domain mappings with this certificate mapped. This - * count includes domain mappings on applications for which the user does - * not have VIEWER permissions.Only returned by GET or LIST requests when - * specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + * Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ domainMappingsCount?: number; /** - * Topmost applicable domains of this certificate. This certificate applies - * to these domains and their subdomains. Example: example.com.@OutputOnly + * Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly */ domainNames?: string[]; /** - * The time when this certificate expires. To update the renewal time on - * this certificate, upload an SSL certificate with a different expiration - * time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + * The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly */ expireTime?: string; /** - * Relative name of the certificate. This is a unique value autogenerated on - * AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + * Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly */ id?: string; /** - * Only applicable if this certificate is managed by App Engine. Managed - * certificates are tied to the lifecycle of a DomainMapping and cannot be - * updated or deleted via the AuthorizedCertificates API. If this - * certificate is manually administered by the user, this field will be - * empty.@OutputOnly + * Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly */ managedCertificate?: Schema$ManagedCertificate; /** - * Full path to the AuthorizedCertificate resource in the API. Example: - * apps/myapp/authorizedCertificates/12345.@OutputOnly + * Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly */ name?: string; /** - * The full paths to user visible Domain Mapping resources that have this - * certificate mapped. Example: apps/myapp/domainMappings/example.com.This - * may not represent the full list of mapped domain mappings if the user - * does not have VIEWER permissions on all of the applications that have - * this certificate mapped. See domain_mappings_count for a complete - * count.Only returned by GET or LIST requests when specifically requested - * by the view=FULL_CERTIFICATE option.@OutputOnly + * The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly */ visibleDomainMappings?: string[]; } /** - * A domain that a user has been authorized to administer. To authorize use of - * a domain, verify ownership via Webmaster Central - * (https://www.google.com/webmasters/verification/home). + * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home). */ export interface Schema$AuthorizedDomain { /** - * Fully qualified domain name of the domain authorized for use. Example: - * example.com. + * Fully qualified domain name of the domain authorized for use. Example: example.com. */ id?: string; /** - * Full path to the AuthorizedDomain resource in the API. Example: - * apps/myapp/authorizedDomains/example.com.@OutputOnly + * Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly */ name?: string; } /** - * Automatic scaling is based on request rate, response latencies, and other - * application metrics. + * Automatic scaling is based on request rate, response latencies, and other application metrics. */ export interface Schema$AutomaticScaling { /** - * The time period that the Autoscaler - * (https://cloud.google.com/compute/docs/autoscaler/) should wait before it - * starts collecting information from a new instance. This prevents the - * autoscaler from collecting information when the instance is initializing, - * during which the collected usage would not be reliable. Only applicable - * in the App Engine flexible environment. + * The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. */ coolDownPeriod?: string; /** @@ -324,7 +272,7 @@ export namespace appengine_v1beta { */ cpuUtilization?: Schema$CpuUtilization; /** - * Target scaling by user-provided metrics. + * Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment. */ customMetrics?: Schema$CustomMetric[]; /** @@ -332,39 +280,31 @@ export namespace appengine_v1beta { */ diskUtilization?: Schema$DiskUtilization; /** - * Number of concurrent requests an automatic scaling instance can accept - * before the scheduler spawns a new instance.Defaults to a runtime-specific - * value. + * Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value. */ maxConcurrentRequests?: number; /** - * Maximum number of idle instances that should be maintained for this - * version. + * Maximum number of idle instances that should be maintained for this version. */ maxIdleInstances?: number; /** - * Maximum amount of time that a request should wait in the pending queue - * before starting a new instance to handle it. + * Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. */ maxPendingLatency?: string; /** - * Maximum number of instances that should be started to handle requests for - * this version. + * Maximum number of instances that should be started to handle requests for this version. */ maxTotalInstances?: number; /** - * Minimum number of idle instances that should be maintained for this - * version. Only applicable for the default version of a service. + * Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. */ minIdleInstances?: number; /** - * Minimum amount of time a request should wait in the pending queue before - * starting a new instance to handle it. + * Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. */ minPendingLatency?: string; /** - * Minimum number of running instances that should be maintained for this - * version. + * Minimum number of running instances that should be maintained for this version. */ minTotalInstances?: number; /** @@ -381,15 +321,11 @@ export namespace appengine_v1beta { standardSchedulerSettings?: Schema$StandardSchedulerSettings; } /** - * A service with basic scaling will create an instance when the application - * receives a request. The instance will be turned down when the app becomes - * idle. Basic scaling is ideal for work that is intermittent or driven by - * user activity. + * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. */ export interface Schema$BasicScaling { /** - * Duration of time after the last request that an instance must wait before - * the instance is shut down. + * Duration of time after the last request that an instance must wait before the instance is shut down. */ idleTimeout?: string; /** @@ -420,8 +356,7 @@ export namespace appengine_v1beta { */ export interface Schema$BuildInfo { /** - * The Google Cloud Build id. Example: - * "f966068f-08b2-42c8-bdfe-74137dff2bf9" + * The Google Cloud Build id. Example: "f966068f-08b2-42c8-bdfe-74137dff2bf9" */ cloudBuildId?: string; } @@ -430,51 +365,33 @@ export namespace appengine_v1beta { */ export interface Schema$CertificateRawData { /** - * Unencrypted PEM encoded RSA private key. This field is set once on - * certificate creation and then encrypted. The key size must be 2048 bits - * or fewer. Must include the header and footer. Example: <pre> - * -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END - * RSA PRIVATE KEY----- </pre> @InputOnly + * Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly */ privateKey?: string; /** - * PEM encoded x.509 public key certificate. This field is set once on - * certificate creation. Must include the header and footer. Example: - * <pre> -----BEGIN CERTIFICATE----- <certificate_value> - * -----END CERTIFICATE----- </pre> + * PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: <pre> -----BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre> */ publicCertificate?: string; } /** - * Options for the build operations performed as a part of the version - * deployment. Only applicable for App Engine flexible environment when - * creating a version using source code directly. + * Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. */ export interface Schema$CloudBuildOptions { /** - * Path to the yaml file used in deployment, used to determine runtime - * configuration details.Required for flexible environment builds.See - * https://cloud.google.com/appengine/docs/standard/python/config/appref for - * more details. + * Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. */ appYamlPath?: string; /** - * The Cloud Build timeout used as part of any dependent builds performed by - * version creation. Defaults to 10 minutes. + * The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. */ cloudBuildTimeout?: string; } /** - * Docker image that is used to create a container and start a VM instance for - * the version that you deploy. Only applicable for instances running in the - * App Engine flexible environment. + * Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. */ export interface Schema$ContainerInfo { /** - * URI to the hosted container image in Google Container Registry. The URI - * must be fully qualified and include a tag or digest. Examples: - * "gcr.io/my-project/image:tag" or - * "gcr.io/my-project/image@digest" + * URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" */ image?: string; } @@ -487,41 +404,34 @@ export namespace appengine_v1beta { */ aggregationWindowLength?: string; /** - * Target CPU utilization ratio to maintain when scaling. Must be between 0 - * and 1. + * Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. */ targetUtilization?: number; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1 { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1alpha.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Alpha { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } /** - * Metadata for the given google.longrunning.Operation during a - * google.appengine.v1beta.CreateVersionRequest. + * Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Beta { /** - * The Cloud Build ID if one was created as part of the version create. - * @OutputOnly + * The Cloud Build ID if one was created as part of the version create. @OutputOnly */ cloudBuildId?: string; } @@ -538,16 +448,11 @@ export namespace appengine_v1beta { */ metricName?: string; /** - * May be used instead of target_utilization when an instance can handle a - * specific amount of work/resources and the metric value is equal to the - * current amount of work remaining. The autoscaler will try to keep the - * number of instances equal to the metric value divided by - * single_instance_assignment. + * May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment. */ singleInstanceAssignment?: number; /** - * The type of the metric. Must be a string representing a Stackdriver - * metric type e.g. GAGUE, DELTA_PER_SECOND, etc. + * The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc. */ targetType?: string; /** @@ -560,11 +465,7 @@ export namespace appengine_v1beta { */ export interface Schema$DebugInstanceRequest { /** - * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa - * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh - * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For - * more information, see Adding and Removing SSH Keys - * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). + * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). */ sshKey?: string; } @@ -573,26 +474,19 @@ export namespace appengine_v1beta { */ export interface Schema$Deployment { /** - * Google Cloud Build build information. Only applicable for instances - * running in the App Engine flexible environment. + * Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment. */ build?: Schema$BuildInfo; /** - * Options for any Google Cloud Build builds created as a part of this - * deployment.These options will only be used if a new build is created, - * such as when deploying to the App Engine flexible environment using files - * or zip. + * Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. */ cloudBuildOptions?: Schema$CloudBuildOptions; /** - * The Docker image for the container that runs the version. Only applicable - * for instances running in the App Engine flexible environment. + * The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment. */ container?: Schema$ContainerInfo; /** - * Manifest of the files stored in Google Cloud Storage that are included as - * part of this version. All files must be readable using the credentials - * supplied with this call. + * Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call. */ files?: {[key: string]: Schema$FileInfo}; /** @@ -601,8 +495,7 @@ export namespace appengine_v1beta { zip?: Schema$ZipInfo; } /** - * Target scaling by disk usage. Only applicable in the App Engine flexible - * environment. + * Target scaling by disk usage. Only applicable in the App Engine flexible environment. */ export interface Schema$DiskUtilization { /** @@ -627,71 +520,44 @@ export namespace appengine_v1beta { */ export interface Schema$DomainMapping { /** - * Relative name of the domain serving the application. Example: - * example.com. + * Relative name of the domain serving the application. Example: example.com. */ id?: string; /** - * Full path to the DomainMapping resource in the API. Example: - * apps/myapp/domainMapping/example.com.@OutputOnly + * Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly */ name?: string; /** - * The resource records required to configure this domain mapping. These - * records must be added to the domain's DNS configuration in order to - * serve the application via this domain mapping.@OutputOnly + * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly */ resourceRecords?: Schema$ResourceRecord[]; /** - * SSL configuration for this domain. If unconfigured, this domain will not - * serve with SSL. + * SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. */ sslSettings?: Schema$SslSettings; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** - * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The - * Endpoints API Service provides tooling for serving Open API and gRPC - * endpoints via an NGINX proxy. Only valid for App Engine Flexible - * environment deployments.The fields here refer to the name and configuration - * ID of a "service" resource in the Service Management API - * (https://cloud.google.com/service-management/overview). + * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). */ export interface Schema$EndpointsApiService { /** - * Endpoints service configuration ID as specified by the Service Management - * API. For example "2016-09-19r1".By default, the rollout - * strategy for Endpoints is RolloutStrategy.FIXED. This means that - * Endpoints starts up with a particular configuration ID. When a new - * configuration is rolled out, Endpoints must be given the new - * configuration ID. The config_id field is used to give the configuration - * ID and is required in this case.Endpoints also has a rollout strategy - * called RolloutStrategy.MANAGED. When using this, Endpoints fetches the - * latest configuration and does not need the configuration ID. In this - * case, config_id must be omitted. + * Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. */ configId?: string; /** - * Enable or disable trace sampling. By default, this is set to false for - * enabled. + * Enable or disable trace sampling. By default, this is set to false for enabled. */ disableTraceSampling?: boolean; /** - * Endpoints service name which is the name of the "service" - * resource in the Service Management API. For example - * "myapi.endpoints.myproject.cloud.goog" + * Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" */ name?: string; /** - * Endpoints rollout strategy. If FIXED, config_id must be specified. If - * MANAGED, config_id must be omitted. + * Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. */ rolloutStrategy?: string; } @@ -722,34 +588,24 @@ export namespace appengine_v1beta { staticFile?: string; } /** - * The feature specific settings to be used in the application. These define - * behaviors that are user configurable. + * The feature specific settings to be used in the application. These define behaviors that are user configurable. */ export interface Schema$FeatureSettings { /** - * Boolean value indicating if split health checks should be used instead of - * the legacy health checks. At an app.yaml level, this means defaulting to - * 'readiness_check' and 'liveness_check' values instead of - * 'health_check' ones. Once the legacy 'health_check' - * behavior is deprecated, and this value is always true, this setting can - * be removed. + * Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed. */ splitHealthChecks?: boolean; /** - * If true, use Container-Optimized OS - * (https://cloud.google.com/container-optimized-os/) base image for VMs, - * rather than a base Debian image. + * If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image. */ useContainerOptimizedOs?: boolean; } /** - * Single source file that is part of the version to be deployed. Each source - * file that is deployed must be specified separately. + * Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. */ export interface Schema$FileInfo { /** - * The MIME type of the file.Defaults to the value from Google Cloud - * Storage. + * The MIME type of the file.Defaults to the value from Google Cloud Storage. */ mimeType?: string; /** @@ -757,15 +613,12 @@ export namespace appengine_v1beta { */ sha1Sum?: string; /** - * URL source to use to fetch this file. Must be a URL to a resource in - * Google Cloud Storage in the form - * 'http(s)://storage.googleapis.com/<bucket>/<object>'. + * URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ sourceUrl?: string; } /** - * A single firewall rule that is evaluated against incoming traffic and - * provides an action to take on matched requests. + * A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. */ export interface Schema$FirewallRule { /** @@ -773,35 +626,20 @@ export namespace appengine_v1beta { */ action?: string; /** - * An optional string description of this rule. This field has a maximum - * length of 100 characters. + * An optional string description of this rule. This field has a maximum length of 100 characters. */ description?: string; /** - * A positive integer between 1, Int32.MaxValue-1 that defines the order of - * rule evaluation. Rules with the lowest priority are evaluated first.A - * default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic - * when no previous rule matches. Only the action of this rule can be - * modified by the user. + * A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user. */ priority?: number; /** - * IP address or range, defined using CIDR notation, of requests that this - * rule applies to. You can use the wildcard character "*" to - * match all IPs equivalent to "0/0" and "::/0" - * together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or - * 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be - * silently performed on addresses which are not properly truncated. For - * example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. - * Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as - * 2001:db8::/32. + * IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. */ sourceRange?: string; } /** - * Health checking configuration for VM instances. Unhealthy instances are - * killed and replaced with new instances. Only applicable for instances in - * App Engine flexible environment. + * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. */ export interface Schema$HealthCheck { /** @@ -813,18 +651,15 @@ export namespace appengine_v1beta { */ disableHealthCheck?: boolean; /** - * Number of consecutive successful health checks required before receiving - * traffic. + * Number of consecutive successful health checks required before receiving traffic. */ healthyThreshold?: number; /** - * Host header to send when performing an HTTP health check. Example: - * "myapp.appspot.com" + * Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" */ host?: string; /** - * Number of consecutive failed health checks required before an instance is - * restarted. + * Number of consecutive failed health checks required before an instance is restarted. */ restartThreshold?: number; /** @@ -832,8 +667,7 @@ export namespace appengine_v1beta { */ timeout?: string; /** - * Number of consecutive failed health checks required before removing - * traffic. + * Number of consecutive failed health checks required before removing traffic. */ unhealthyThreshold?: number; } @@ -842,9 +676,7 @@ export namespace appengine_v1beta { */ export interface Schema$IdentityAwareProxy { /** - * Whether the serving infrastructure will authenticate and authorize all - * incoming requests.If true, the oauth2_client_id and oauth2_client_secret - * fields must be non-empty. + * Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty. */ enabled?: boolean; /** @@ -852,15 +684,11 @@ export namespace appengine_v1beta { */ oauth2ClientId?: string; /** - * InputOnly OAuth client info required to generate client id to be used for - * IAP. + * InputOnly OAuth client info required to generate client id to be used for IAP. */ oauth2ClientInfo?: Schema$OAuth2ClientInfo; /** - * OAuth2 client secret to use for the authentication flow.For security - * reasons, this value cannot be retrieved via the API. Instead, the SHA-256 - * hash of the value is returned in the oauth2_client_secret_sha256 - * field.@InputOnly + * OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly */ oauth2ClientSecret?: string; /** @@ -869,8 +697,7 @@ export namespace appengine_v1beta { oauth2ClientSecretSha256?: string; } /** - * An Instance resource is the computing unit that App Engine uses to - * automatically scale an application. + * An Instance resource is the computing unit that App Engine uses to automatically scale an application. */ export interface Schema$Instance { /** @@ -890,8 +717,7 @@ export namespace appengine_v1beta { */ errors?: number; /** - * Relative name of the instance within the version. Example: - * instance-1.@OutputOnly + * Relative name of the instance within the version. Example: instance-1.@OutputOnly */ id?: string; /** @@ -899,8 +725,7 @@ export namespace appengine_v1beta { */ memoryUsage?: string; /** - * Full path to the Instance resource in the API. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly + * Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly */ name?: string; /** @@ -916,33 +741,27 @@ export namespace appengine_v1beta { */ startTime?: string; /** - * Whether this instance is in debug mode. Only applicable for instances in - * App Engine flexible environment.@OutputOnly + * Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmDebugEnabled?: boolean; /** - * Virtual machine ID of this instance. Only applicable for instances in App - * Engine flexible environment.@OutputOnly + * Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmId?: string; /** - * The IP address of this instance. Only applicable for instances in App - * Engine flexible environment.@OutputOnly + * The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmIp?: string; /** - * Name of the virtual machine where this instance lives. Only applicable - * for instances in App Engine flexible environment.@OutputOnly + * Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmName?: string; /** - * Status of the virtual machine where this instance lives. Only applicable - * for instances in App Engine flexible environment.@OutputOnly + * Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmStatus?: string; /** - * Zone where the virtual machine is located. Only applicable for instances - * in App Engine flexible environment.@OutputOnly + * Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly */ vmZoneName?: string; } @@ -1077,8 +896,7 @@ export namespace appengine_v1beta { versions?: Schema$Version[]; } /** - * Health checking configuration for VM instances. Unhealthy instances are - * killed and replaced with new instances. + * Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. */ export interface Schema$LivenessCheck { /** @@ -1086,13 +904,11 @@ export namespace appengine_v1beta { */ checkInterval?: string; /** - * Number of consecutive failed checks required before considering the VM - * unhealthy. + * Number of consecutive failed checks required before considering the VM unhealthy. */ failureThreshold?: number; /** - * Host header to send when performing a HTTP Liveness check. Example: - * "myapp.appspot.com" + * Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" */ host?: string; /** @@ -1104,8 +920,7 @@ export namespace appengine_v1beta { */ path?: string; /** - * Number of consecutive successful checks required before considering the - * VM healthy. + * Number of consecutive successful checks required before considering the VM healthy. */ successThreshold?: number; /** @@ -1118,13 +933,11 @@ export namespace appengine_v1beta { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -1132,13 +945,11 @@ export namespace appengine_v1beta { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: "projects/example-project/locations/us-east1" + * Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" */ name?: string; } @@ -1147,13 +958,11 @@ export namespace appengine_v1beta { */ export interface Schema$LocationMetadata { /** - * App Engine flexible environment is available in the given - * location.@OutputOnly + * App Engine flexible environment is available in the given location.@OutputOnly */ flexibleEnvironmentAvailable?: boolean; /** - * App Engine standard environment is available in the given - * location.@OutputOnly + * App Engine standard environment is available in the given location.@OutputOnly */ standardEnvironmentAvailable?: boolean; } @@ -1162,78 +971,50 @@ export namespace appengine_v1beta { */ export interface Schema$ManagedCertificate { /** - * Time at which the certificate was last renewed. The renewal process is - * fully managed. Certificate renewal will automatically occur before the - * certificate expires. Renewal errors can be tracked via - * ManagementStatus.@OutputOnly + * Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly */ lastRenewalTime?: string; /** - * Status of certificate management. Refers to the most recent certificate - * acquisition or renewal attempt.@OutputOnly + * Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly */ status?: string; } /** - * A service with manual scaling runs continuously, allowing you to perform - * complex initialization and rely on the state of its memory over time. + * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. */ export interface Schema$ManualScaling { /** - * Number of instances to assign to the service at the start. This number - * can later be altered by using the Modules API - * (https://cloud.google.com/appengine/docs/python/modules/functions) - * set_num_instances() function. + * Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. */ instances?: number; } /** - * Extra network settings. Only applicable in the App Engine flexible - * environment. + * Extra network settings. Only applicable in the App Engine flexible environment. */ export interface Schema$Network { /** - * List of ports, or port pairs, to forward from the virtual machine to the - * application container. Only applicable in the App Engine flexible - * environment. + * List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. */ forwardedPorts?: string[]; /** - * Tag to apply to the instance during creation. Only applicable in the App - * Engine flexible environment. + * Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. */ instanceTag?: string; /** - * Google Compute Engine network where the virtual machines are created. - * Specify the short name, not the resource path.Defaults to default. + * Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. */ name?: string; /** - * Enable session affinity. Only applicable in the App Engine flexible - * environment. + * Enable session affinity. Only applicable in the App Engine flexible environment. */ sessionAffinity?: boolean; /** - * Google Cloud Platform sub-network where the virtual machines are created. - * Specify the short name, not the resource path.If a subnetwork name is - * specified, a network name will also be required unless it is for the - * default network. If the network that the instance is being created in is - * a Legacy network, then the IP address is allocated from the IPv4Range. If - * the network that the instance is being created in is an auto Subnet Mode - * Network, then only network name should be specified (not the - * subnetwork_name) and the IP address is created from the IPCidrRange of - * the subnetwork that exists in that zone for that network. If the network - * that the instance is being created in is a custom Subnet Mode Network, - * then the subnetwork_name must be specified and the IP address is created - * from the IPCidrRange of the subnetwork.If specified, the subnetwork must - * exist in the same region as the App Engine flexible environment - * application. + * Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. */ subnetworkName?: string; } /** - * Target scaling by network usage. Only applicable in the App Engine flexible - * environment. + * Target scaling by network usage. Only applicable in the App Engine flexible environment. */ export interface Schema$NetworkUtilization { /** @@ -1259,8 +1040,7 @@ export namespace appengine_v1beta { */ applicationName?: string; /** - * Nameof the client to be generated. Optional - If not provided, the name - * will be autogenerated by the backend. + * Nameof the client to be generated. Optional - If not provided, the name will be autogenerated by the backend. */ clientName?: string; /** @@ -1269,14 +1049,11 @@ export namespace appengine_v1beta { developerEmailAddress?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is false, it means the operation is still in progress. If - * true, the operation is completed, and either error or response is - * available. + * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ done?: boolean; /** @@ -1284,26 +1061,15 @@ export namespace appengine_v1beta { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the name - * should have the format of operations/some/unique/name. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as Delete, the response is - * google.protobuf.Empty. If the original method is standard - * Get/Create/Update, the response should be the resource. For other - * methods, the response should have the type XxxResponse, where Xxx is the - * original method name. For example, if the original method name is - * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. + * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ response?: {[key: string]: any}; } @@ -1317,8 +1083,7 @@ export namespace appengine_v1beta { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -1326,13 +1091,11 @@ export namespace appengine_v1beta { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -1354,8 +1117,7 @@ export namespace appengine_v1beta { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -1363,13 +1125,11 @@ export namespace appengine_v1beta { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -1391,8 +1151,7 @@ export namespace appengine_v1beta { */ endTime?: string; /** - * Ephemeral message that may change every time the operation is polled. - * @OutputOnly + * Ephemeral message that may change every time the operation is polled. @OutputOnly */ ephemeralMessage?: string; /** @@ -1400,13 +1159,11 @@ export namespace appengine_v1beta { */ insertTime?: string; /** - * API method that initiated this operation. Example: - * google.appengine.v1beta.Versions.CreateVersion.@OutputOnly + * API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly */ method?: string; /** - * Name of the resource that this operation is acting on. Example: - * apps/myapp/services/default.@OutputOnly + * Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly */ target?: string; /** @@ -1419,14 +1176,11 @@ export namespace appengine_v1beta { warning?: string[]; } /** - * Readiness checking configuration for VM instances. Unhealthy instances are - * removed from traffic rotation. + * Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. */ export interface Schema$ReadinessCheck { /** - * A maximum time limit on application initialization, measured from moment - * the application successfully replies to a healthcheck until it is ready - * to serve traffic. + * A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. */ appStartTimeout?: string; /** @@ -1438,8 +1192,7 @@ export namespace appengine_v1beta { */ failureThreshold?: number; /** - * Host header to send when performing a HTTP Readiness check. Example: - * "myapp.appspot.com" + * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" */ host?: string; /** @@ -1447,8 +1200,7 @@ export namespace appengine_v1beta { */ path?: string; /** - * Number of consecutive successful checks required before receiving - * traffic. + * Number of consecutive successful checks required before receiving traffic. */ successThreshold?: number; /** @@ -1461,8 +1213,7 @@ export namespace appengine_v1beta { */ export interface Schema$RepairApplicationRequest {} /** - * Target scaling by request utilization. Only applicable in the App Engine - * flexible environment. + * Target scaling by request utilization. Only applicable in the App Engine flexible environment. */ export interface Schema$RequestUtilization { /** @@ -1479,13 +1230,11 @@ export namespace appengine_v1beta { */ export interface Schema$ResourceRecord { /** - * Relative name of the object affected by this record. Only applicable for - * CNAME records. Example: 'www'. + * Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. */ name?: string; /** - * Data for this record. Values vary by record type, as defined in RFC 1035 - * (section 5) and RFC 1034 (section 3.6.1). + * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ rrdata?: string; /** @@ -1524,27 +1273,19 @@ export namespace appengine_v1beta { scriptPath?: string; } /** - * A Service resource is a logical component of an application that can share - * state and communicate in a secure fashion with other services. For example, - * an application that handles customer requests might include separate - * services to handle tasks such as backend data analysis or API requests from - * mobile devices. Each service has a collection of versions that define a - * specific set of code used to implement the functionality of that service. + * A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service. */ export interface Schema$Service { /** - * Relative name of the service within the application. Example: - * default.@OutputOnly + * Relative name of the service within the application. Example: default.@OutputOnly */ id?: string; /** - * Full path to the Service resource in the API. Example: - * apps/myapp/services/default.@OutputOnly + * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly */ name?: string; /** - * Mapping that defines fractional HTTP traffic diversion to different - * versions within the service. + * Mapping that defines fractional HTTP traffic diversion to different versions within the service. */ split?: Schema$TrafficSplit; } @@ -1553,29 +1294,15 @@ export namespace appengine_v1beta { */ export interface Schema$SslSettings { /** - * ID of the AuthorizedCertificate resource configuring SSL for the - * application. Clearing this field will remove SSL support.By default, a - * managed certificate is automatically created for every domain mapping. To - * omit SSL support or to configure SSL manually, specify - * SslManagementType.MANUAL on a CREATE or UPDATE request. You must be - * authorized to administer the AuthorizedCertificate resource to manually - * map it to a DomainMapping resource. Example: 12345. + * ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345. */ certificateId?: string; /** - * ID of the managed AuthorizedCertificate resource currently being - * provisioned, if applicable. Until the new managed certificate has been - * successfully provisioned, the previous SSL state will be preserved. Once - * the provisioning process completes, the certificate_id field will reflect - * the new managed certificate and this field will be left empty. To remove - * SSL support while there is still a pending managed certificate, clear the - * certificate_id field with an UpdateDomainMappingRequest.@OutputOnly + * ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly */ pendingManagedCertificateId?: string; /** - * SSL management type for this domain. If AUTOMATIC, a managed certificate - * is automatically provisioned. If MANUAL, certificate_id must be manually - * specified in order to configure SSL for this domain. + * SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. */ sslManagementType?: string; } @@ -1584,13 +1311,11 @@ export namespace appengine_v1beta { */ export interface Schema$StandardSchedulerSettings { /** - * Maximum number of instances to run for this version. Set to zero to - * disable max_instances configuration. + * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. */ maxInstances?: number; /** - * Minimum number of instances to run for this version. Set to zero to - * disable min_instances configuration. + * Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. */ minInstances?: number; /** @@ -1603,23 +1328,15 @@ export namespace appengine_v1beta { targetThroughputUtilization?: number; } /** - * Files served directly to the user for a given URL, such as images, CSS - * stylesheets, or JavaScript source files. Static file handlers describe - * which files in the application directory are static files, and which URLs - * serve them. + * Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. */ export interface Schema$StaticFilesHandler { /** - * Whether files should also be uploaded as code data. By default, files - * declared in static file handlers are uploaded as static data and are only - * served to end users; they cannot be read by the application. If enabled, - * uploads are charged against both your code and static data storage - * resource quotas. + * Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas. */ applicationReadable?: boolean; /** - * Time a static file served by this handler should be cached by web proxies - * and browsers. + * Time a static file served by this handler should be cached by web proxies and browsers. */ expiration?: string; /** @@ -1627,62 +1344,24 @@ export namespace appengine_v1beta { */ httpHeaders?: {[key: string]: string}; /** - * MIME type used to serve all files served by this handler.Defaults to - * file-specific MIME types, which are derived from each file's filename - * extension. + * MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension. */ mimeType?: string; /** - * Path to the static files matched by the URL pattern, from the application - * root directory. The path can refer to text matched in groupings in the - * URL pattern. + * Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern. */ path?: string; /** - * Whether this handler should match the request if the file referenced by - * the handler does not exist. + * Whether this handler should match the request if the file referenced by the handler does not exist. */ requireMatchingFile?: boolean; /** - * Regular expression that matches the file paths for all files that should - * be referenced by this handler. + * Regular expression that matches the file paths for all files that should be referenced by this handler. */ uploadPathRegex?: string; } /** - * The Status type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by gRPC (https://github.com/grpc). The error model is designed to be: - * Simple to use and understand for most users Flexible enough to meet - * unexpected needsOverviewThe Status message contains three pieces of data: - * error code, error message, and error details. The error code should be an - * enum value of google.rpc.Code, but it may accept additional error codes if - * needed. The error message should be a developer-facing English message that - * helps developers understand and resolve the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may - * contain arbitrary information about the error. There is a predefined set of - * error detail types in the package google.rpc that can be used for common - * error conditions.Language mappingThe Status message is the logical - * representation of the error model, but it is not necessarily the actual - * wire format. When the Status message is exposed in different client - * libraries and different wire protocols, it can be mapped differently. For - * example, it will likely be mapped to some exceptions in Java, but more - * likely mapped to some error codes in C.Other usesThe error model and the - * Status message can be used in a variety of environments, either with or - * without APIs, to provide a consistent developer experience across different - * environments.Example uses of this error model include: Partial errors. If a - * service needs to return partial errors to the client, it may embed the - * Status in the normal response to indicate the partial errors. Workflow - * errors. A typical workflow has multiple steps. Each step may have a Status - * message for error reporting. Batch operations. If a client uses batch - * request and batch response, the Status message should be used directly - * inside batch response, one for each error sub-response. Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the Status message. Logging. If some API errors are stored in logs, - * the message Status could be used directly after any stripping needed for - * security/privacy reasons. + * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1690,37 +1369,24 @@ export namespace appengine_v1beta { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Traffic routing configuration for versions within a single service. Traffic - * splits define how traffic directed to the service is assigned to versions. + * Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. */ export interface Schema$TrafficSplit { /** - * Mapping from version IDs within the service to fractional (0.000, 1] - * allocations of traffic for that version. Each version can be specified - * only once, but some versions in the service may not have any traffic - * allocation. Services that have traffic allocated cannot be deleted until - * either the service is deleted or their traffic allocation is removed. - * Allocations must sum to 1. Up to two decimal place precision is supported - * for IP-based splits and up to three decimal places is supported for - * cookie-based splits. + * Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits. */ allocations?: {[key: string]: number}; /** - * Mechanism used to determine which version a request is sent to. The - * traffic selection algorithm will be stable for either type until - * allocations are changed. + * Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed. */ shardBy?: string; } @@ -1729,27 +1395,20 @@ export namespace appengine_v1beta { */ export interface Schema$UrlDispatchRule { /** - * Domain name to match against. The wildcard "*" is supported if - * specified before a period: "*.".Defaults to matching all - * domains: "*". + * Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*". */ domain?: string; /** - * Pathname within the host. Must start with a "/". A single - * "*" can be included at the end of the path.The sum of the - * lengths of the domain and path may not exceed 100 characters. + * Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters. */ path?: string; /** - * Resource ID of a service in this application that should serve the - * matched request. The service must already exist. Example: default. + * Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default. */ service?: string; } /** - * URL pattern and description of how the URL should be handled. App Engine - * can handle URLs by executing application code or by serving static files - * uploaded with the version, such as images, CSS, or JavaScript. + * URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript. */ export interface Schema$UrlMap { /** @@ -1757,24 +1416,19 @@ export namespace appengine_v1beta { */ apiEndpoint?: Schema$ApiEndpointHandler; /** - * Action to take when users access resources that require authentication. - * Defaults to redirect. + * Action to take when users access resources that require authentication. Defaults to redirect. */ authFailAction?: string; /** - * Level of login required to access this resource. Not supported for - * Node.js in the App Engine standard environment. + * Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. */ login?: string; /** - * 30x code to use when performing redirects for the secure field. Defaults - * to 302. + * 30x code to use when performing redirects for the secure field. Defaults to 302. */ redirectHttpResponseCode?: string; /** - * Executes a script to handle the requests that match this URL pattern. - * Only the auto value is supported for Node.js in the App Engine standard - * environment, for example "script": "auto". + * Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". */ script?: Schema$ScriptHandler; /** @@ -1786,39 +1440,28 @@ export namespace appengine_v1beta { */ staticFiles?: Schema$StaticFilesHandler; /** - * URL prefix. Uses regular expression syntax, which means regexp special - * characters must be escaped, but should not contain groupings. All URLs - * that begin with this prefix are handled by this handler, using the - * portion of the URL after the prefix as part of the file path. + * URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. */ urlRegex?: string; } /** - * A Version resource is a specific set of source code and configuration files - * that are deployed into a service. + * A Version resource is a specific set of source code and configuration files that are deployed into a service. */ export interface Schema$Version { /** - * Serving configuration for Google Cloud Endpoints - * (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned - * in GET requests if view=FULL is set. + * Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set. */ apiConfig?: Schema$ApiConfigHandler; /** - * Automatic scaling is based on request rate, response latencies, and other - * application metrics. + * Automatic scaling is based on request rate, response latencies, and other application metrics. */ automaticScaling?: Schema$AutomaticScaling; /** - * A service with basic scaling will create an instance when the application - * receives a request. The instance will be turned down when the app becomes - * idle. Basic scaling is ideal for work that is intermittent or driven by - * user activity. + * A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. */ basicScaling?: Schema$BasicScaling; /** - * Metadata settings that are supplied to this version to enable beta - * runtime features. + * Metadata settings that are supplied to this version to enable beta runtime features. */ betaSettings?: {[key: string]: string}; /** @@ -1830,27 +1473,19 @@ export namespace appengine_v1beta { */ createTime?: string; /** - * Duration that static files should be cached by web proxies and browsers. - * Only applicable if the corresponding StaticFilesHandler - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) - * does not specify its own expiration time.Only returned in GET requests if - * view=FULL is set. + * Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. */ defaultExpiration?: string; /** - * Code and application artifacts that make up this version.Only returned in - * GET requests if view=FULL is set. + * Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. */ deployment?: Schema$Deployment; /** - * Total size in bytes of all the files that are included in this version - * and currently hosted on the App Engine disk.@OutputOnly + * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly */ diskUsageBytes?: string; /** - * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud - * Endpoints Extensible Service Proxy will be provided to serve the API - * implemented by the app. + * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. */ endpointsApiService?: Schema$EndpointsApiService; /** @@ -1862,88 +1497,63 @@ export namespace appengine_v1beta { */ env?: string; /** - * Environment variables available to the application.Only returned in GET - * requests if view=FULL is set. + * Environment variables available to the application.Only returned in GET requests if view=FULL is set. */ envVariables?: {[key: string]: string}; /** - * Custom static error pages. Limited to 10KB per page.Only returned in GET - * requests if view=FULL is set. + * Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. */ errorHandlers?: Schema$ErrorHandler[]; /** - * An ordered list of URL-matching patterns that should be applied to - * incoming requests. The first matching URL handles the request and other - * request handlers are not attempted.Only returned in GET requests if - * view=FULL is set. + * An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set. */ handlers?: Schema$UrlMap[]; /** - * Configures health checking for instances. Unhealthy instances are stopped - * and replaced with new instances. Only applicable in the App Engine - * flexible environment.Only returned in GET requests if view=FULL is set. + * Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set. */ healthCheck?: Schema$HealthCheck; /** - * Relative name of the version within the service. Example: v1. Version - * names can contain only lowercase letters, numbers, or hyphens. Reserved - * names: "default", "latest", and any name with the - * prefix "ah-". + * Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". */ id?: string; /** - * Before an application can receive email or XMPP messages, the application - * must be configured to enable the service. + * Before an application can receive email or XMPP messages, the application must be configured to enable the service. */ inboundServices?: string[]; /** - * Instance class that is used to run this version. Valid values are: - * AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, - * B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for - * ManualScaling or BasicScaling. + * Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. */ instanceClass?: string; /** - * Configuration for third-party Python runtime libraries that are required - * by the application.Only returned in GET requests if view=FULL is set. + * Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. */ libraries?: Schema$Library[]; /** - * Configures liveness health checking for instances. Unhealthy instances - * are stopped and replaced with new instancesOnly returned in GET requests - * if view=FULL is set. + * Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. */ livenessCheck?: Schema$LivenessCheck; /** - * A service with manual scaling runs continuously, allowing you to perform - * complex initialization and rely on the state of its memory over time. + * A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. */ manualScaling?: Schema$ManualScaling; /** - * Full path to the Version resource in the API. Example: - * apps/myapp/services/default/versions/v1.@OutputOnly + * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly */ name?: string; /** - * Extra network settings. Only applicable in the App Engine flexible - * environment. + * Extra network settings. Only applicable in the App Engine flexible environment. */ network?: Schema$Network; /** - * Files that match this pattern will not be built into this version. Only - * applicable for Go runtimes.Only returned in GET requests if view=FULL is - * set. + * Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. */ nobuildFilesRegex?: string; /** - * Configures readiness health checking for instances. Unhealthy instances - * are not put into the backend traffic rotation.Only returned in GET - * requests if view=FULL is set. + * Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. */ readinessCheck?: Schema$ReadinessCheck; /** - * Machine resources for this version. Only applicable in the App Engine - * flexible environment. + * Machine resources for this version. Only applicable in the App Engine flexible environment. */ resources?: Schema$Resources; /** @@ -1951,14 +1561,11 @@ export namespace appengine_v1beta { */ runtime?: string; /** - * The version of the API in the given runtime environment. Please see the - * app.yaml reference for valid values at - * https://cloud.google.com/appengine/docs/standard/<language>/config/appref + * The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref */ runtimeApiVersion?: string; /** - * The channel of the runtime to use. Only available for some runtimes. - * Defaults to the default channel. + * The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. */ runtimeChannel?: string; /** @@ -1966,9 +1573,7 @@ export namespace appengine_v1beta { */ runtimeMainExecutablePath?: string; /** - * Current serving status of this version. Only the versions with a SERVING - * status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is - * an invalid value. Defaults to SERVING. + * Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. */ servingStatus?: string; /** @@ -1976,8 +1581,7 @@ export namespace appengine_v1beta { */ threadsafe?: boolean; /** - * Serving URL for this version. Example: - * "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly */ versionUrl?: string; /** @@ -1989,14 +1593,12 @@ export namespace appengine_v1beta { */ vpcAccessConnector?: Schema$VpcAccessConnector; /** - * The Google Compute Engine zones that are supported by this version in the - * App Engine flexible environment. Deprecated. + * The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. */ zones?: string[]; } /** - * Volumes mounted within the app container. Only applicable in the App Engine - * flexible environment. + * Volumes mounted within the app container. Only applicable in the App Engine flexible environment. */ export interface Schema$Volume { /** @@ -2017,8 +1619,7 @@ export namespace appengine_v1beta { */ export interface Schema$VpcAccessConnector { /** - * Full Serverless VPC Access Connector name e.g. - * /projects/my-project/locations/us-central1/connectors/c1. + * Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. */ name?: string; } @@ -2027,15 +1628,11 @@ export namespace appengine_v1beta { */ export interface Schema$ZipInfo { /** - * An estimate of the number of files in a zip for a zip deployment. If set, - * must be greater than or equal to the actual number of files. Used for - * optimizing performance; if not provided, deployment may be slow. + * An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow. */ filesCount?: number; /** - * URL of the zip file to deploy from. Must be a URL to a resource in Google - * Cloud Storage in the form - * 'http(s)://storage.googleapis.com/<bucket>/<object>'. + * URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'. */ sourceUrl?: string; } @@ -2066,13 +1663,7 @@ export namespace appengine_v1beta { /** * appengine.apps.create - * @desc Creates an App Engine application for a Google Cloud Platform - * project. Required fields: id - The ID of the target Cloud Platform - * project. location - The region - * (https://cloud.google.com/appengine/docs/locations) where you want the - * App Engine application located.For more information about App Engine - * applications, see Managing Projects, Applications, and Billing - * (https://cloud.google.com/appengine/docs/standard/python/console/). + * @desc Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/). * @alias appengine.apps.create * @memberOf! () * @@ -2215,10 +1806,7 @@ export namespace appengine_v1beta { /** * appengine.apps.patch - * @desc Updates the specified Application resource. You can update the - * following fields: auth_domain - Google authentication domain for - * controlling user access to the application. default_cookie_expiration - - * Cookie expiration policy for the application. + * @desc Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. * @alias appengine.apps.patch * @memberOf! () * @@ -2293,16 +1881,7 @@ export namespace appengine_v1beta { /** * appengine.apps.repair - * @desc Recreates the required App Engine features for the specified App - * Engine application, for example a Cloud Storage bucket or App Engine - * service account. Use this method if you receive an error message about a - * missing feature, for example, Error retrieving the App Engine service - * account. If you have deleted your App Engine service account, this will - * not be able to recreate it. Instead, you should attempt to use the IAM - * undelete API if possible at - * https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D - * . If the deletion was recent, the numeric ID can be found in the Cloud - * Console Activity Log. + * @desc Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log. * @alias appengine.apps.repair * @memberOf! () * @@ -2393,8 +1972,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Application resource to get. Example: - * apps/myapp. + * Part of `name`. Name of the Application resource to get. Example: apps/myapp. */ appsId?: string; } @@ -2405,8 +1983,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Application resource to update. Example: - * apps/myapp. + * Part of `name`. Name of the Application resource to update. Example: apps/myapp. */ appsId?: string; /** @@ -2756,11 +2333,7 @@ export namespace appengine_v1beta { /** * appengine.apps.authorizedCertificates.patch - * @desc Updates the specified SSL certificate. To renew a certificate and - * maintain its existing domain mappings, update certificate_data with a new - * certificate. The new certificate must be applicable to the same domains - * as the original certificate. The certificate display_name may also be - * updated. + * @desc Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated. * @alias appengine.apps.authorizedCertificates.patch * @memberOf! () * @@ -2846,8 +2419,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; @@ -2864,8 +2436,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to delete. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -2881,8 +2452,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -2902,8 +2472,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -2927,8 +2496,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/authorizedCertificates/12345. + * Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. */ appsId?: string; /** @@ -2936,8 +2504,7 @@ export namespace appengine_v1beta { */ authorizedCertificatesId?: string; /** - * Standard field mask for the set of fields to be updated. Updates are only - * supported on the certificate_raw_data and display_name fields. + * Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. */ updateMask?: string; @@ -3047,8 +2614,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -3069,10 +2635,7 @@ export namespace appengine_v1beta { /** * appengine.apps.domainMappings.create - * @desc Maps a domain to an application. A user must be authorized to - * administer a domain in order to map it to an application. For a list of - * available authorized domains, see - * AuthorizedDomains.ListAuthorizedDomains. + * @desc Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains. * @alias appengine.apps.domainMappings.create * @memberOf! () * @@ -3148,9 +2711,7 @@ export namespace appengine_v1beta { /** * appengine.apps.domainMappings.delete - * @desc Deletes the specified domain mapping. A user must be authorized to - * administer the associated domain in order to delete a DomainMapping - * resource. + * @desc Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource. * @alias appengine.apps.domainMappings.delete * @memberOf! () * @@ -3383,10 +2944,7 @@ export namespace appengine_v1beta { /** * appengine.apps.domainMappings.patch - * @desc Updates the specified domain mapping. To map an SSL certificate to - * a domain mapping, update certificate_id to point to an - * AuthorizedCertificate resource. A user must be authorized to administer - * the associated domain in order to update a DomainMapping resource. + * @desc Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource. * @alias appengine.apps.domainMappings.patch * @memberOf! () * @@ -3470,13 +3028,11 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** - * Whether the domain creation should override any existing mappings for - * this domain. By default, overrides are rejected. + * Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. */ overrideStrategy?: string; @@ -3493,8 +3049,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to delete. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -3510,8 +3065,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -3527,8 +3081,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -3548,8 +3101,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/domainMappings/example.com. + * Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. */ appsId?: string; /** @@ -3584,11 +3136,7 @@ export namespace appengine_v1beta { /** * appengine.apps.firewall.ingressRules.batchUpdate - * @desc Replaces the entire firewall ruleset in one bulk operation. This - * overrides and replaces the rules of an existing firewall with the new - * rules.If the final rule does not match traffic with the '*' wildcard IP - * range, then an "allow all" rule is explicitly added to the end of the - * list. + * @desc Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list. * @alias appengine.apps.firewall.ingressRules.batchUpdate * @memberOf! () * @@ -4056,8 +3604,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall collection to set. Example: - * apps/myapp/firewall/ingressRules. + * Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules. */ appsId?: string; @@ -4074,8 +3621,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Firewall collection in which to - * create a new rule. Example: apps/myapp/firewall/ingressRules. + * Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules. */ appsId?: string; @@ -4092,8 +3638,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall resource to delete. Example: - * apps/myapp/firewall/ingressRules/100. + * Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100. */ appsId?: string; /** @@ -4109,8 +3654,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall resource to retrieve. Example: - * apps/myapp/firewall/ingressRules/100. + * Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. */ appsId?: string; /** @@ -4126,14 +3670,11 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the Firewall collection to retrieve. Example: - * apps/myapp/firewall/ingressRules. + * Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules. */ appsId?: string; /** - * A valid IP Address. If set, only rules matching this address will be - * returned. The first returned rule will be the rule that fires on requests - * from this IP. + * A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP. */ matchingAddress?: string; /** @@ -4153,8 +3694,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the Firewall resource to update. Example: - * apps/myapp/firewall/ingressRules/100. + * Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100. */ appsId?: string; /** @@ -4354,8 +3894,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. The resource that owns the locations collection, if - * applicable. + * Part of `name`. The resource that owns the locations collection, if applicable. */ appsId?: string; /** @@ -4380,9 +3919,7 @@ export namespace appengine_v1beta { /** * appengine.apps.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias appengine.apps.operations.get * @memberOf! () * @@ -4456,15 +3993,7 @@ export namespace appengine_v1beta { /** * appengine.apps.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: - * the name binding allows API services to override the binding to use - * different resource name schemes, such as users/x/operations. To override - * the binding, API services can add a binding such as - * "/v1/{name=users/x}/operations" to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias appengine.apps.operations.list * @memberOf! () * @@ -4901,8 +4430,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -4918,8 +4446,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -4935,8 +4462,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Application resource. Example: - * apps/myapp. + * Part of `parent`. Name of the parent Application resource. Example: apps/myapp. */ appsId?: string; /** @@ -4956,24 +4482,11 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/services/default. + * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. */ appsId?: string; /** - * Set to true to gradually shift traffic to one or more versions that you - * specify. By default, traffic is shifted immediately. For gradual traffic - * migration, the target versions must be located within instances that are - * configured for both warmup requests - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) - * and automatic scaling - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). - * You must specify the shardBy - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) - * field in the Service resource. Gradual traffic migration is not supported - * in the App Engine flexible environment. For examples, see Migrating and - * Splitting Traffic - * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + * Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). */ migrateTraffic?: boolean; /** @@ -5154,9 +4667,7 @@ export namespace appengine_v1beta { /** * appengine.apps.services.versions.get - * @desc Gets the specified Version resource. By default, only a BASIC_VIEW - * will be returned. Specify the FULL_VIEW parameter to get the full - * resource. + * @desc Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource. * @alias appengine.apps.services.versions.get * @memberOf! () * @@ -5310,36 +4821,7 @@ export namespace appengine_v1beta { /** * appengine.apps.services.versions.patch - * @desc Updates the specified Version resource. You can specify the - * following fields depending on the App Engine environment and type of - * scaling that the version resource uses:Standard environment - * instance_class - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic - * scaling in the standard environment: automatic_scaling.min_idle_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.max_idle_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) - * automaticScaling.standard_scheduler_settings.max_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) - * automaticScaling.standard_scheduler_settings.min_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) - * automaticScaling.standard_scheduler_settings.target_cpu_utilization - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) - * automaticScaling.standard_scheduler_settings.target_throughput_utilization - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic - * scaling or manual scaling in the standard environment: serving_status - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)Flexible - * environment serving_status - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic - * scaling in the flexible environment: - * automatic_scaling.min_total_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.max_total_instances - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.cool_down_period_sec - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) - * automatic_scaling.cpu_utilization.target_utilization - * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) + * @desc Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) * @alias appengine.apps.services.versions.patch * @memberOf! () * @@ -5424,8 +4906,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent resource to create this version - * under. Example: apps/myapp/services/default. + * Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -5446,8 +4927,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. */ appsId?: string; /** @@ -5467,8 +4947,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. */ appsId?: string; /** @@ -5492,8 +4971,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Service resource. Example: - * apps/myapp/services/default. + * Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. */ appsId?: string; /** @@ -5521,8 +4999,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource to update. Example: - * apps/myapp/services/default/versions/1. + * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. */ appsId?: string; /** @@ -5552,12 +5029,7 @@ export namespace appengine_v1beta { /** * appengine.apps.services.versions.instances.debug - * @desc Enables debugging on a VM instance. This allows you to use the SSH - * command to connect to the virtual machine where the instance lives. While - * in "debug mode", the instance continues to serve live traffic. You should - * delete the instance when you are done debugging and then allow the system - * to take over and determine if another instance should be started.Only - * applicable for instances in App Engine flexible environment. + * @desc Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment. * @alias appengine.apps.services.versions.instances.debug * @memberOf! () * @@ -5787,9 +5259,7 @@ export namespace appengine_v1beta { /** * appengine.apps.services.versions.instances.list - * @desc Lists the instances of a version.Tip: To aggregate details about - * instances over time, see the Stackdriver Monitoring API - * (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). + * @desc Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). * @alias appengine.apps.services.versions.instances.list * @memberOf! () * @@ -5876,8 +5346,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. */ appsId?: string; /** @@ -5906,8 +5375,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. */ appsId?: string; /** @@ -5931,8 +5399,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `name`. Name of the resource requested. Example: - * apps/myapp/services/default/versions/v1/instances/instance-1. + * Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. */ appsId?: string; /** @@ -5956,8 +5423,7 @@ export namespace appengine_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Part of `parent`. Name of the parent Version resource. Example: - * apps/myapp/services/default/versions/v1. + * Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1. */ appsId?: string; /** diff --git a/src/apis/appsactivity/package.json b/src/apis/appsactivity/package.json index ca3d71e1e0c..c61fb91ddad 100644 --- a/src/apis/appsactivity/package.json +++ b/src/apis/appsactivity/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/appsactivity/v1.ts b/src/apis/appsactivity/v1.ts index cc323219eba..89c633aedfd 100644 --- a/src/apis/appsactivity/v1.ts +++ b/src/apis/appsactivity/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace appsactivity_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace appsactivity_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,16 +92,17 @@ export namespace appsactivity_v1 { activities: Resource$Activities; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.activities = new Resource$Activities(this.context); } } /** - * An Activity resource is a combined view of multiple events. An activity has - * a list of individual events and a combined view of the common fields among - * all events. + * An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events. */ export interface Schema$Activity { /** @@ -121,14 +119,11 @@ export namespace appsactivity_v1 { */ export interface Schema$Event { /** - * Additional event types. Some events may have multiple types when multiple - * actions are part of a single event. For example, creating a document, - * renaming it, and sharing it may be part of a single file-creation event. + * Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event. */ additionalEventTypes?: string[]; /** - * The time at which the event occurred formatted as Unix time in - * milliseconds. + * The time at which the event occurred formatted as Unix time in milliseconds. */ eventTimeMillis?: string; /** @@ -136,13 +131,11 @@ export namespace appsactivity_v1 { */ fromUserDeletion?: boolean; /** - * Extra information for move type events, such as changes in an - * object's parents. + * Extra information for move type events, such as changes in an object's parents. */ move?: Schema$Move; /** - * Extra information for permissionChange type events, such as the user or - * group the new permission applies to. + * Extra information for permissionChange type events, such as the user or group the new permission applies to. */ permissionChanges?: Schema$PermissionChange[]; /** @@ -163,8 +156,7 @@ export namespace appsactivity_v1 { user?: Schema$User; } /** - * The response from the list request. Contains a list of activities and a - * token to retrieve the next page of results. + * The response from the list request. Contains a list of activities and a token to retrieve the next page of results. */ export interface Schema$ListActivitiesResponse { /** @@ -177,8 +169,7 @@ export namespace appsactivity_v1 { nextPageToken?: string; } /** - * Contains information about changes in an object's parents as a result - * of a move type event. + * Contains information about changes in an object's parents as a result of a move type event. */ export interface Schema$Move { /** @@ -191,8 +182,7 @@ export namespace appsactivity_v1 { removedParents?: Schema$Parent[]; } /** - * Contains information about a parent object. For example, a folder in Drive - * is a parent for all files within it. + * Contains information about a parent object. For example, a folder in Drive is a parent for all files within it. */ export interface Schema$Parent { /** @@ -209,9 +199,7 @@ export namespace appsactivity_v1 { title?: string; } /** - * Contains information about the permissions and type of access allowed with - * regards to a Google Drive object. This is a subset of the fields contained - * in a corresponding Drive Permissions object. + * Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object. */ export interface Schema$Permission { /** @@ -219,13 +207,11 @@ export namespace appsactivity_v1 { */ name?: string; /** - * The ID for this permission. Corresponds to the Drive API's permission - * ID returned as part of the Drive Permissions resource. + * The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource. */ permissionId?: string; /** - * Indicates the Google Drive permissions role. The role determines a - * user's ability to read, write, or comment on the file. + * Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file. */ role?: string; /** @@ -242,8 +228,7 @@ export namespace appsactivity_v1 { withLink?: boolean; } /** - * Contains information about a Drive object's permissions that changed as - * a result of a permissionChange type event. + * Contains information about a Drive object's permissions that changed as a result of a permissionChange type event. */ export interface Schema$PermissionChange { /** @@ -282,8 +267,7 @@ export namespace appsactivity_v1 { */ export interface Schema$Target { /** - * The ID of the target. For example, in Google Drive, this is the file or - * folder ID. + * The ID of the target. For example, in Google Drive, this is the file or folder ID. */ id?: string; /** @@ -291,8 +275,7 @@ export namespace appsactivity_v1 { */ mimeType?: string; /** - * The name of the target. For example, in Google Drive, this is the title - * of the file. + * The name of the target. For example, in Google Drive, this is the title of the file. */ name?: string; } @@ -301,8 +284,7 @@ export namespace appsactivity_v1 { */ export interface Schema$User { /** - * A boolean which indicates whether the specified User was deleted. If - * true, name, photo and permission_id will be omitted. + * A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted. */ isDeleted?: boolean; /** @@ -314,14 +296,11 @@ export namespace appsactivity_v1 { */ name?: string; /** - * The permission ID associated with this user. Equivalent to the Drive - * API's permission ID for this user, returned as part of the Drive - * Permissions resource. + * The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource. */ permissionId?: string; /** - * The profile photo of the user. Not present if the user has no profile - * photo. + * The profile photo of the user. Not present if the user has no profile photo. */ photo?: Schema$Photo; } @@ -334,12 +313,7 @@ export namespace appsactivity_v1 { /** * appsactivity.activities.list - * @desc Returns a list of activities visible to the current logged in user. - * Visible activities are determined by the visibility settings of the - * object that was acted on, e.g. Drive files a user can see. An activity is - * a record of past events. Multiple events may be merged if they are - * similar. A request is scoped to activities from a given Google service - * using the source parameter. + * @desc Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter. * @alias appsactivity.activities.list * @memberOf! () * @@ -426,8 +400,7 @@ export namespace appsactivity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the Drive folder containing the items for which to return - * activities. + * Identifies the Drive folder containing the items for which to return activities. */ 'drive.ancestorId'?: string; /** @@ -435,13 +408,11 @@ export namespace appsactivity_v1 { */ 'drive.fileId'?: string; /** - * Indicates the strategy to use when grouping singleEvents items in the - * associated combinedEvent object. + * Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object. */ groupingStrategy?: string; /** - * The maximum number of events to return on a page. The response includes a - * continuation token if there are more events. + * The maximum number of events to return on a page. The response includes a continuation token if there are more events. */ pageSize?: number; /** @@ -449,14 +420,11 @@ export namespace appsactivity_v1 { */ pageToken?: string; /** - * The Google service from which to return activities. Possible values of - * source are: - drive.google.com + * The Google service from which to return activities. Possible values of source are: - drive.google.com */ source?: string; /** - * The ID used for ACL checks (does not filter the resulting event list by - * the assigned value). Use the special value me to indicate the currently - * authenticated user. + * The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user. */ userId?: string; } diff --git a/src/apis/appstate/package.json b/src/apis/appstate/package.json index 48d8f085480..57c7c150ee8 100644 --- a/src/apis/appstate/package.json +++ b/src/apis/appstate/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/appstate/v1.ts b/src/apis/appstate/v1.ts index cf5f98d952a..453499a00d8 100644 --- a/src/apis/appstate/v1.ts +++ b/src/apis/appstate/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace appstate_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace appstate_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace appstate_v1 { states: Resource$States; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.states = new Resource$States(this.context); } @@ -114,8 +114,7 @@ export namespace appstate_v1 { */ data?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string appstate#getResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse. */ kind?: string; /** @@ -132,8 +131,7 @@ export namespace appstate_v1 { */ items?: Schema$GetResponse[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string appstate#listResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse. */ kind?: string; /** @@ -150,8 +148,7 @@ export namespace appstate_v1 { */ data?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string appstate#updateRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest. */ kind?: string; } @@ -164,8 +161,7 @@ export namespace appstate_v1 { */ currentStateVersion?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string appstate#writeResult. + * Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult. */ kind?: string; /** @@ -182,9 +178,7 @@ export namespace appstate_v1 { /** * appstate.states.clear - * @desc Clears (sets to empty) the data for the passed key if and only if - * the passed version matches the currently stored version. This method - * results in a conflict error on version mismatch. + * @desc Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch. * @alias appstate.states.clear * @memberOf! () * @@ -258,11 +252,7 @@ export namespace appstate_v1 { /** * appstate.states.delete - * @desc Deletes a key and the data associated with it. The key is removed - * and no longer counts against the key quota. Note that since this method - * is not safe in the face of concurrent modifications, it should only be - * used for development and testing purposes. Invoking this method in - * shipping code can result in data loss and data corruption. + * @desc Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption. * @alias appstate.states.delete * @memberOf! () * @@ -333,8 +323,7 @@ export namespace appstate_v1 { /** * appstate.states.get - * @desc Retrieves the data corresponding to the passed key. If the key does - * not exist on the server, an HTTP 404 will be returned. + * @desc Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned. * @alias appstate.states.get * @memberOf! () * @@ -480,9 +469,7 @@ export namespace appstate_v1 { /** * appstate.states.update - * @desc Update the data associated with the input key if and only if the - * passed version matches the currently stored version. This method is safe - * in the face of concurrent writes. Maximum per-key size is 128KB. + * @desc Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB. * @alias appstate.states.update * @memberOf! () * @@ -563,8 +550,7 @@ export namespace appstate_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version of the data to be cleared. Version strings are returned by - * the server. + * The version of the data to be cleared. Version strings are returned by the server. */ currentDataVersion?: string; /** @@ -612,10 +598,7 @@ export namespace appstate_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The version of the app state your application is attempting to update. If - * this does not match the current version, this method will return a - * conflict error. If there is no data stored on the server for this key, - * the update will succeed irrespective of the value of this parameter. + * The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter. */ currentStateVersion?: string; /** diff --git a/src/apis/bigquery/package.json b/src/apis/bigquery/package.json index e18eb555bbf..4b036fa724e 100644 --- a/src/apis/bigquery/package.json +++ b/src/apis/bigquery/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index ea33a52b687..0cc60148c5f 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace bigquery_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace bigquery_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -94,95 +91,99 @@ export namespace bigquery_v2 { context: APIRequestContext; datasets: Resource$Datasets; jobs: Resource$Jobs; + models: Resource$Models; projects: Resource$Projects; tabledata: Resource$Tabledata; tables: Resource$Tables; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.datasets = new Resource$Datasets(this.context); this.jobs = new Resource$Jobs(this.context); + this.models = new Resource$Models(this.context); this.projects = new Resource$Projects(this.context); this.tabledata = new Resource$Tabledata(this.context); this.tables = new Resource$Tables(this.context); } } + /** + * Aggregate metrics for classification models. For multi-class models, the metrics are either macro-averaged: metrics are calculated for each label and then an unweighted average is taken of those values or micro-averaged: the metric is calculated globally by counting the total number of correctly predicted rows. + */ + export interface Schema$AggregateClassificationMetrics { + /** + * Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric. + */ + accuracy?: number; + /** + * The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric. + */ + f1Score?: number; + /** + * Logarithmic Loss. For multiclass this is a macro-averaged metric. + */ + logLoss?: number; + /** + * Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier. + */ + precision?: number; + /** + * Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric. + */ + recall?: number; + /** + * Area Under a ROC Curve. For multiclass this is a macro-averaged metric. + */ + rocAuc?: number; + /** + * Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + */ + threshold?: number; + } export interface Schema$BigQueryModelTraining { /** - * [Output-only, Beta] Index of current ML training iteration. Updated - * during create model query job to show job progress. + * [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. */ currentIteration?: number; /** - * [Output-only, Beta] Expected number of iterations for the create model - * query job specified as num_iterations in the input query. The actual - * total number of iterations may be less than this number due to early - * stop. + * [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. */ expectedTotalIterations?: string; } export interface Schema$BigtableColumn { /** - * [Optional] The encoding of the values when the type is not STRING. - * Acceptable encoding values are: TEXT - indicates values are alphanumeric - * text strings. BINARY - indicates values are encoded using HBase - * Bytes.toBytes family of functions. 'encoding' can also be set at - * the column family level. However, the setting at this level takes - * precedence if 'encoding' is set at both levels. + * [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. */ encoding?: string; /** - * [Optional] If the qualifier is not a valid BigQuery field identifier i.e. - * does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided - * as the column field name and is used as field name in queries. + * [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. */ fieldName?: string; /** - * [Optional] If this is set, only the latest version of value in this - * column are exposed. 'onlyReadLatest' can also be set at the - * column family level. However, the setting at this level takes precedence - * if 'onlyReadLatest' is set at both levels. + * [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. */ onlyReadLatest?: boolean; /** - * [Required] Qualifier of the column. Columns in the parent column family - * that has this exact qualifier are exposed as . field. If the qualifier is - * valid UTF-8 string, it can be specified in the qualifier_string field. - * Otherwise, a base-64 encoded value must be set to qualifier_encoded. The - * column field name is the same as the column qualifier. However, if the - * qualifier is not a valid BigQuery field identifier i.e. does not match - * [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. + * [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. */ qualifierEncoded?: string; qualifierString?: string; /** - * [Optional] The type to convert the value in cells of this column. The - * values are expected to be encoded using HBase Bytes.toBytes function when - * using the BINARY encoding value. Following BigQuery types are allowed - * (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is - * BYTES. 'type' can also be set at the column family level. - * However, the setting at this level takes precedence if 'type' is - * set at both levels. + * [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. */ type?: string; } export interface Schema$BigtableColumnFamily { /** - * [Optional] Lists of columns that should be exposed as individual fields - * as opposed to a list of (column name, value) pairs. All columns whose - * qualifier matches a qualifier in this list can be accessed as .. Other - * columns can be accessed as a list through .Column field. + * [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. */ columns?: Schema$BigtableColumn[]; /** - * [Optional] The encoding of the values when the type is not STRING. - * Acceptable encoding values are: TEXT - indicates values are alphanumeric - * text strings. BINARY - indicates values are encoded using HBase - * Bytes.toBytes family of functions. This can be overridden for a specific - * column by listing that column in 'columns' and specifying an - * encoding for it. + * [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */ encoding?: string; /** @@ -190,76 +191,93 @@ export namespace bigquery_v2 { */ familyId?: string; /** - * [Optional] If this is set only the latest version of value are exposed - * for all columns in this column family. This can be overridden for a - * specific column by listing that column in 'columns' and - * specifying a different setting for that column. + * [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. */ onlyReadLatest?: boolean; /** - * [Optional] The type to convert the value in cells of this column family. - * The values are expected to be encoded using HBase Bytes.toBytes function - * when using the BINARY encoding value. Following BigQuery types are - * allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default - * type is BYTES. This can be overridden for a specific column by listing - * that column in 'columns' and specifying a type for it. + * [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. */ type?: string; } export interface Schema$BigtableOptions { /** - * [Optional] List of column families to expose in the table schema along - * with their types. This list restricts the column families that can be - * referenced in queries and specifies their value types. You can use this - * list to do type conversions - see the 'type' field for more - * details. If you leave this list empty, all column families are present in - * the table schema and their values are read as BYTES. During a query only - * the column families referenced in that query are read from Bigtable. + * [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. */ columnFamilies?: Schema$BigtableColumnFamily[]; /** - * [Optional] If field is true, then the column families that are not - * specified in columnFamilies list are not exposed in the table schema. - * Otherwise, they are read with BYTES type values. The default value is - * false. + * [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false. */ ignoreUnspecifiedColumnFamilies?: boolean; /** - * [Optional] If field is true, then the rowkey column families will be read - * and converted to string. Otherwise they are read with BYTES type values - * and users need to manually cast them with CAST if necessary. The default - * value is false. + * [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false. */ readRowkeyAsString?: boolean; } + /** + * Evaluation metrics for binary classification models. + */ + export interface Schema$BinaryClassificationMetrics { + /** + * Aggregate classification metrics. + */ + aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics; + /** + * Binary confusion matrix at multiple thresholds. + */ + binaryConfusionMatrixList?: Schema$BinaryConfusionMatrix[]; + } + /** + * Confusion matrix for binary classification models. + */ + export interface Schema$BinaryConfusionMatrix { + /** + * Number of false samples predicted as false. + */ + falseNegatives?: string; + /** + * Number of false samples predicted as true. + */ + falsePositives?: string; + /** + * Threshold value used when computing each of the following metric. + */ + positiveClassThreshold?: number; + /** + * Aggregate precision. + */ + precision?: number; + /** + * Aggregate recall. + */ + recall?: number; + /** + * Number of true samples predicted as false. + */ + trueNegatives?: string; + /** + * Number of true samples predicted as true. + */ + truePositives?: string; + } export interface Schema$BqmlIterationResult { /** - * [Output-only, Beta] Time taken to run the training iteration in - * milliseconds. + * [Output-only, Beta] Time taken to run the training iteration in milliseconds. */ durationMs?: string; /** - * [Output-only, Beta] Eval loss computed on the eval data at the end of the - * iteration. The eval loss is used for early stopping to avoid overfitting. - * No eval loss if eval_split_method option is specified as no_split or - * auto_split with input data size less than 500 rows. + * [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows. */ evalLoss?: number; /** - * [Output-only, Beta] Index of the ML training iteration, starting from - * zero for each training run. + * [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run. */ index?: number; /** - * [Output-only, Beta] Learning rate used for this iteration, it varies for - * different training iterations if learn_rate_strategy option is not - * constant. + * [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant. */ learnRate?: number; /** - * [Output-only, Beta] Training loss computed on the training data at the - * end of the iteration. The training loss function is defined by model - * type. + * [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type. */ trainingLoss?: number; } @@ -269,116 +287,118 @@ export namespace bigquery_v2 { */ iterationResults?: Schema$BqmlIterationResult[]; /** - * [Output-only, Beta] Training run start time in milliseconds since the - * epoch. + * [Output-only, Beta] Training run start time in milliseconds since the epoch. */ startTime?: string; /** - * [Output-only, Beta] Different state applicable for a training run. IN - * PROGRESS: Training run is in progress. FAILED: Training run ended due to - * a non-retryable failure. SUCCEEDED: Training run successfully completed. - * CANCELLED: Training run cancelled by the user. + * [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user. */ state?: string; /** - * [Output-only, Beta] Training options used by this training run. These - * options are mutable for subsequent training runs. Default values are - * explicitly stored for options not specified in the input query of the - * first training run. For subsequent training runs, any option not - * explicitly specified in the input query will be copied from the previous - * training run. + * [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run. */ trainingOptions?: { - earlyStop?: boolean; - l1Reg?: number; + minRelProgress?: number; l2Reg?: number; - learnRate?: number; learnRateStrategy?: string; + warmStart?: boolean; lineSearchInitLearnRate?: number; + earlyStop?: boolean; + l1Reg?: number; maxIteration?: string; - minRelProgress?: number; - warmStart?: boolean; + learnRate?: number; }; } + /** + * Information about a single cluster for clustering model. + */ + export interface Schema$ClusterInfo { + /** + * Centroid id. + */ + centroidId?: string; + /** + * Cluster radius, the average distance from centroid to each point assigned to the cluster. + */ + clusterRadius?: number; + /** + * Cluster size, the total number of points assigned to the cluster. + */ + clusterSize?: string; + } export interface Schema$Clustering { /** - * [Repeated] One or more fields on which data should be clustered. Only - * top-level, non-repeated, simple-type fields are supported. When you - * cluster a table using multiple columns, the order of columns you specify - * is important. The order of the specified columns determines the sort - * order of the data. + * [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. */ fields?: string[]; } + /** + * Evaluation metrics for clustering models. + */ + export interface Schema$ClusteringMetrics { + /** + * Davies-Bouldin index. + */ + daviesBouldinIndex?: number; + /** + * Mean of squared distances between each sample to its cluster centroid. + */ + meanSquaredDistance?: number; + } + /** + * Confusion matrix for multi-class classification models. + */ + export interface Schema$ConfusionMatrix { + /** + * Confidence threshold used when computing the entries of the confusion matrix. + */ + confidenceThreshold?: number; + /** + * One row per actual label. + */ + rows?: Schema$Row[]; + } export interface Schema$CsvOptions { /** - * [Optional] Indicates if BigQuery should accept rows that are missing - * trailing optional columns. If true, BigQuery treats missing trailing - * columns as null values. If false, records with missing trailing columns - * are treated as bad records, and if there are too many bad records, an - * invalid error is returned in the job result. The default value is false. + * [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. */ allowJaggedRows?: boolean; /** - * [Optional] Indicates if BigQuery should allow quoted data sections that - * contain newline characters in a CSV file. The default value is false. + * [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. */ allowQuotedNewlines?: boolean; /** - * [Optional] The character encoding of the data. The supported values are - * UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the - * data after the raw, binary data has been split using the values of the - * quote and fieldDelimiter properties. + * [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. */ encoding?: string; /** - * [Optional] The separator for fields in a CSV file. BigQuery converts the - * string to ISO-8859-1 encoding, and then uses the first byte of the - * encoded string to split the data in its raw, binary state. BigQuery also - * supports the escape sequence "\t" to specify a tab separator. - * The default value is a comma (','). + * [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). */ fieldDelimiter?: string; /** - * [Optional] The value that is used to quote data sections in a CSV file. - * BigQuery converts the string to ISO-8859-1 encoding, and then uses the - * first byte of the encoded string to split the data in its raw, binary - * state. The default value is a double-quote ('"'). If your - * data does not contain quoted sections, set the property value to an empty - * string. If your data contains quoted newline characters, you must also - * set the allowQuotedNewlines property to true. + * [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. */ quote?: string; /** - * [Optional] The number of rows at the top of a CSV file that BigQuery will - * skip when reading the data. The default value is 0. This property is - * useful if you have header rows in the file that should be skipped. + * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. */ skipLeadingRows?: string; } export interface Schema$Dataset { /** - * [Optional] An array of objects that define dataset access for one or more - * entities. You can set this property when inserting or updating a dataset - * in order to control who is allowed to access the data. If unspecified at - * dataset creation time, BigQuery adds default dataset access for the - * following entities: access.specialGroup: projectReaders; access.role: - * READER; access.specialGroup: projectWriters; access.role: WRITER; - * access.specialGroup: projectOwners; access.role: OWNER; - * access.userByEmail: [dataset creator email]; access.role: OWNER; + * [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; */ access?: Array<{ domain?: string; - groupByEmail?: string; + userByEmail?: string; iamMember?: string; - role?: string; specialGroup?: string; - userByEmail?: string; + role?: string; view?: Schema$TableReference; + groupByEmail?: string; }>; /** - * [Output-only] The time when this dataset was created, in milliseconds - * since the epoch. + * [Output-only] The time when this dataset was created, in milliseconds since the epoch. */ creationTime?: string; /** @@ -386,32 +406,11 @@ export namespace bigquery_v2 { */ datasetReference?: Schema$DatasetReference; /** - * [Optional] The default partition expiration for all partitioned tables in - * the dataset, in milliseconds. Once this property is set, all - * newly-created partitioned tables in the dataset will have an expirationMs - * property in the timePartitioning settings set to this value, and changing - * the value will only affect new tables, not existing ones. The storage in - * a partition will have an expiration time of its partition time plus this - * value. Setting this property overrides the use of - * defaultTableExpirationMs for partitioned tables: only one of - * defaultTableExpirationMs and defaultPartitionExpirationMs will be used - * for any new partitioned table. If you provide an explicit - * timePartitioning.expirationMs when creating or updating a partitioned - * table, that value takes precedence over the default partition expiration - * time indicated by this property. + * [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property. */ defaultPartitionExpirationMs?: string; /** - * [Optional] The default lifetime of all tables in the dataset, in - * milliseconds. The minimum value is 3600000 milliseconds (one hour). Once - * this property is set, all newly-created tables in the dataset will have - * an expirationTime property set to the creation time plus the value in - * this property, and changing the value will only affect new tables, not - * existing ones. When the expirationTime for a given table is reached, that - * table will be deleted automatically. If a table's expirationTime is - * modified or removed before the table expires, or if you provide an - * explicit expirationTime when creating a table, that value takes - * precedence over the default expiration time indicated by this property. + * [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property. */ defaultTableExpirationMs?: string; /** @@ -427,10 +426,7 @@ export namespace bigquery_v2 { */ friendlyName?: string; /** - * [Output-only] The fully-qualified unique name of the dataset in the - * format projectId:datasetId. The dataset name without the project name is - * given in the datasetId field. When creating a new dataset, leave this - * field blank, and instead specify the datasetId field. + * [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. */ id?: string; /** @@ -438,65 +434,50 @@ export namespace bigquery_v2 { */ kind?: string; /** - * The labels associated with this dataset. You can use these to organize - * and group your datasets. You can set this property when inserting or - * updating a dataset. See Creating and Updating Dataset Labels for more - * information. + * The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information. */ labels?: {[key: string]: string}; /** - * [Output-only] The date when this dataset or any of its tables was last - * modified, in milliseconds since the epoch. + * [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch. */ lastModifiedTime?: string; /** - * The geographic location where the dataset should reside. The default - * value is US. See details at - * https://cloud.google.com/bigquery/docs/locations. + * The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations. */ location?: string; /** - * [Output-only] A URL that can be used to access the resource again. You - * can use this URL in Get or Update requests to the resource. + * [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. */ selfLink?: string; } export interface Schema$DatasetList { /** - * An array of the dataset resources in the project. Each resource contains - * basic information. For full information about a particular dataset - * resource, use the Datasets: get method. This property is omitted when - * there are no datasets in the project. + * An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. */ datasets?: Array<{ - datasetReference?: Schema$DatasetReference; - friendlyName?: string; - id?: string; kind?: string; labels?: {[key: string]: string}; + datasetReference?: Schema$DatasetReference; + id?: string; location?: string; + friendlyName?: string; }>; /** - * A hash value of the results page. You can use this property to determine - * if the page has changed since the last request. + * A hash value of the results page. You can use this property to determine if the page has changed since the last request. */ etag?: string; /** - * The list type. This property always returns the value - * "bigquery#datasetList". + * The list type. This property always returns the value "bigquery#datasetList". */ kind?: string; /** - * A token that can be used to request the next results page. This property - * is omitted on the final results page. + * A token that can be used to request the next results page. This property is omitted on the final results page. */ nextPageToken?: string; } export interface Schema$DatasetReference { /** - * [Required] A unique ID for this dataset, without the project name. The ID - * must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - * The maximum length is 1,024 characters. + * [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. */ datasetId?: string; /** @@ -506,39 +487,40 @@ export namespace bigquery_v2 { } export interface Schema$DestinationTableProperties { /** - * [Optional] The description for the destination table. This will only be - * used if the destination table is newly created. If the table already - * exists and a value different than the current description is provided, - * the job will fail. + * [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. */ description?: string; /** - * [Optional] The friendly name for the destination table. This will only be - * used if the destination table is newly created. If the table already - * exists and a value different than the current friendly name is provided, - * the job will fail. + * [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail. */ friendlyName?: string; /** - * [Optional] The labels associated with this table. You can use these to - * organize and group your tables. This will only be used if the destination - * table is newly created. If the table already exists and labels are - * different than the current labels are provided, the job will fail. + * [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. */ labels?: {[key: string]: string}; } export interface Schema$EncryptionConfiguration { /** - * [Optional] Describes the Cloud KMS encryption key that will be used to - * protect destination BigQuery table. The BigQuery Service Account - * associated with your project requires access to this encryption key. + * [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. */ kmsKeyName?: string; } + /** + * A single entry in the confusion matrix. + */ + export interface Schema$Entry { + /** + * Number of items being predicted as this label. + */ + itemCount?: string; + /** + * The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold. + */ + predictedLabel?: string; + } export interface Schema$ErrorProto { /** - * Debugging information. This property is internal to Google and should not - * be used. + * Debugging information. This property is internal to Google and should not be used. */ debugInfo?: string; /** @@ -554,6 +536,27 @@ export namespace bigquery_v2 { */ reason?: string; } + /** + * Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. + */ + export interface Schema$EvaluationMetrics { + /** + * Populated for binary classification models. + */ + binaryClassificationMetrics?: Schema$BinaryClassificationMetrics; + /** + * [Beta] Populated for clustering models. + */ + clusteringMetrics?: Schema$ClusteringMetrics; + /** + * Populated for multi-class classification models. + */ + multiClassClassificationMetrics?: Schema$MultiClassClassificationMetrics; + /** + * Populated for regression models. + */ + regressionMetrics?: Schema$RegressionMetrics; + } export interface Schema$ExplainQueryStage { /** * Number of parallel input segments completed. @@ -636,8 +639,7 @@ export namespace bigquery_v2 { */ status?: string; /** - * List of operations within the stage in dependency order (approximately - * chronological). + * List of operations within the stage in dependency order (approximately chronological). */ steps?: Schema$ExplainQueryStep[]; /** @@ -685,8 +687,7 @@ export namespace bigquery_v2 { } export interface Schema$ExternalDataConfiguration { /** - * Try to detect schema and format options automatically. Any option - * specified explicitly will be honored. + * Try to detect schema and format options automatically. Any option specified explicitly will be honored. */ autodetect?: boolean; /** @@ -694,10 +695,7 @@ export namespace bigquery_v2 { */ bigtableOptions?: Schema$BigtableOptions; /** - * [Optional] The compression type of the data source. Possible values - * include GZIP and NONE. The default value is NONE. This setting is ignored - * for Google Cloud Bigtable, Google Cloud Datastore backups and Avro - * formats. + * [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. */ compression?: string; /** @@ -709,60 +707,27 @@ export namespace bigquery_v2 { */ googleSheetsOptions?: Schema$GoogleSheetsOptions; /** - * [Optional, Experimental] If hive partitioning is enabled, which mode to - * use. Two modes are supported: - AUTO: automatically infer partition key - * name(s) and type(s). - STRINGS: automatic infer partition key name(s). - * All types are strings. Not all storage formats support hive partitioning - * -- requesting hive partitioning on an unsupported format will lead to an - * error. + * [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. */ hivePartitioningMode?: string; /** - * [Optional] Indicates if BigQuery should allow extra values that are not - * represented in the table schema. If true, the extra values are ignored. - * If false, records with extra columns are treated as bad records, and if - * there are too many bad records, an invalid error is returned in the job - * result. The default value is false. The sourceFormat property determines - * what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named - * values that don't match any column names Google Cloud Bigtable: This - * setting is ignored. Google Cloud Datastore backups: This setting is - * ignored. Avro: This setting is ignored. + * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. */ ignoreUnknownValues?: boolean; /** - * [Optional] The maximum number of bad records that BigQuery can ignore - * when reading data. If the number of bad records exceeds this value, an - * invalid error is returned in the job result. This is only valid for CSV, - * JSON, and Google Sheets. The default value is 0, which requires that all - * records are valid. This setting is ignored for Google Cloud Bigtable, - * Google Cloud Datastore backups and Avro formats. + * [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. */ maxBadRecords?: number; /** - * [Optional] The schema for the data. Schema is required for CSV and JSON - * formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore - * backups, and Avro formats. + * [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. */ schema?: Schema$TableSchema; /** - * [Required] The data format. For CSV files, specify "CSV". For - * Google sheets, specify "GOOGLE_SHEETS". For newline-delimited - * JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify - * "AVRO". For Google Cloud Datastore backups, specify - * "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify - * "BIGTABLE". + * [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". */ sourceFormat?: string; /** - * [Required] The fully-qualified URIs that point to your data in Google - * Cloud. For Google Cloud Storage URIs: Each URI can contain one - * '*' wildcard character and it must come after the - * 'bucket' name. Size limits related to load jobs apply to external - * data sources. For Google Cloud Bigtable URIs: Exactly one URI can be - * specified and it has be a fully specified and valid HTTPS URL for a - * Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly - * one URI can be specified. Also, the '*' wildcard character is not - * allowed. + * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */ sourceUris?: string[]; } @@ -772,10 +737,7 @@ export namespace bigquery_v2 { */ cacheHit?: boolean; /** - * [Output-only] The first errors or warnings encountered during the running - * of the job. The final message includes the number of errors that caused - * the process to stop. Errors here do not necessarily mean that the job has - * completed or was unsuccessful. + * [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. */ errors?: Schema$ErrorProto[]; /** @@ -783,17 +745,11 @@ export namespace bigquery_v2 { */ etag?: string; /** - * Whether the query has completed or not. If rows or totalRows are present, - * this will always be true. If this is false, totalRows will not be - * available. + * Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. */ jobComplete?: boolean; /** - * Reference to the BigQuery Job that was created to run the query. This - * field will be present even if the original request timed out, in which - * case GetQueryResults can be used to read the results once the query has - * completed. Since this API only returns the first page of results, - * subsequent pages can be fetched via the same mechanism (GetQueryResults). + * Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). */ jobReference?: Schema$JobReference; /** @@ -801,8 +757,7 @@ export namespace bigquery_v2 { */ kind?: string; /** - * [Output-only] The number of rows affected by a DML statement. Present - * only for DML statements INSERT, UPDATE or DELETE. + * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */ numDmlAffectedRows?: string; /** @@ -810,15 +765,11 @@ export namespace bigquery_v2 { */ pageToken?: string; /** - * An object with as many results as can be contained within the maximum - * permitted reply size. To get any additional rows, you can call - * GetQueryResults and specify the jobReference returned above. Present only - * when the query completes successfully. + * An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. */ rows?: Schema$TableRow[]; /** - * The schema of the results. Present only when the query completes - * successfully. + * The schema of the results. Present only when the query completes successfully. */ schema?: Schema$TableSchema; /** @@ -826,9 +777,7 @@ export namespace bigquery_v2 { */ totalBytesProcessed?: string; /** - * The total number of rows in the complete query result set, which can be - * more than the number of rows in this single page of results. Present only - * when the query completes successfully. + * The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully. */ totalRows?: string; } @@ -844,27 +793,43 @@ export namespace bigquery_v2 { } export interface Schema$GoogleSheetsOptions { /** - * [Beta] [Optional] Range of a sheet to query from. Only used when - * non-empty. Typical format: - * sheet_name!top_left_cell_id:bottom_right_cell_id For example: - * sheet1!A1:B20 + * [Beta] [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20 */ range?: string; /** - * [Optional] The number of rows at the top of a sheet that BigQuery will - * skip when reading the data. The default value is 0. This property is - * useful if you have header rows that should be skipped. When autodetect is - * on, behavior is the following: * skipLeadingRows unspecified - Autodetect - * tries to detect headers in the first row. If they are not detected, the - * row is read as data. Otherwise data is read starting from the second row. - * * skipLeadingRows is 0 - Instructs autodetect that there are no headers - * and data should be read starting from the first row. * skipLeadingRows = - * N > 0 - Autodetect skips N-1 rows and tries to detect headers in row - * N. If headers are not detected, row N is just skipped. Otherwise row N is - * used to extract column names for the detected schema. + * [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. */ skipLeadingRows?: string; } + /** + * Information about a single iteration of the training run. + */ + export interface Schema$IterationResult { + /** + * [Beta] Information about top clusters for clustering models. + */ + clusterInfos?: Schema$ClusterInfo[]; + /** + * Time taken to run the iteration in milliseconds. + */ + durationMs?: string; + /** + * Loss computed on the eval data at the end of iteration. + */ + evalLoss?: number; + /** + * Index of the iteration, 0 based. + */ + index?: number; + /** + * Learn rate used for this iteration. + */ + learnRate?: number; + /** + * Loss computed on the training data at the end of iteration. + */ + trainingLoss?: number; + } export interface Schema$Job { /** * [Required] Describes the job configuration. @@ -891,13 +856,11 @@ export namespace bigquery_v2 { */ selfLink?: string; /** - * [Output-only] Information about the job, including starting time and - * ending time of the job. + * [Output-only] Information about the job, including starting time and ending time of the job. */ statistics?: Schema$JobStatistics; /** - * [Output-only] The status of this job. Examine this value when polling an - * asynchronous job to see if the job is complete. + * [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. */ status?: Schema$JobStatus; /** @@ -921,10 +884,7 @@ export namespace bigquery_v2 { */ copy?: Schema$JobConfigurationTableCopy; /** - * [Optional] If set, don't actually run this job. A valid query will - * return a mostly empty response with some processing statistics, while an - * invalid query will return the same error it would if it wasn't a dry - * run. Behavior of non-query jobs is undefined. + * [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. */ dryRun?: boolean; /** @@ -932,22 +892,15 @@ export namespace bigquery_v2 { */ extract?: Schema$JobConfigurationExtract; /** - * [Optional] Job timeout in milliseconds. If this time limit is exceeded, - * BigQuery may attempt to terminate the job. + * [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. */ jobTimeoutMs?: string; /** - * [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or - * UNKNOWN. + * [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. */ jobType?: string; /** - * The labels associated with this job. You can use these to organize and - * group your jobs. Label keys and values can be no longer than 63 - * characters, can only contain lowercase letters, numeric characters, - * underscores and dashes. International characters are allowed. Label - * values are optional. Label keys must start with a letter and each label - * in the list must have a different key. + * The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. */ labels?: {[key: string]: string}; /** @@ -961,36 +914,27 @@ export namespace bigquery_v2 { } export interface Schema$JobConfigurationExtract { /** - * [Optional] The compression type to use for exported files. Possible - * values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is - * NONE. DEFLATE and SNAPPY are only supported for Avro. + * [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. */ compression?: string; /** - * [Optional] The exported file format. Possible values include CSV, - * NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with - * nested or repeated fields cannot be exported as CSV. + * [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. */ destinationFormat?: string; /** - * [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI - * as necessary. The fully-qualified Google Cloud Storage URI where the - * extracted table should be written. + * [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. */ destinationUri?: string; /** - * [Pick one] A list of fully-qualified Google Cloud Storage URIs where the - * extracted table should be written. + * [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. */ destinationUris?: string[]; /** - * [Optional] Delimiter to use between fields in the exported data. Default - * is ',' + * [Optional] Delimiter to use between fields in the exported data. Default is ',' */ fieldDelimiter?: string; /** - * [Optional] Whether to print out a header row in the results. Default is - * true. + * [Optional] Whether to print out a header row in the results. Default is true. */ printHeader?: boolean; /** @@ -1000,36 +944,23 @@ export namespace bigquery_v2 { } export interface Schema$JobConfigurationLoad { /** - * [Optional] Accept rows that are missing trailing optional columns. The - * missing values are treated as nulls. If false, records with missing - * trailing columns are treated as bad records, and if there are too many - * bad records, an invalid error is returned in the job result. The default - * value is false. Only applicable to CSV, ignored for other formats. + * [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. */ allowJaggedRows?: boolean; /** - * Indicates if BigQuery should allow quoted data sections that contain - * newline characters in a CSV file. The default value is false. + * Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. */ allowQuotedNewlines?: boolean; /** - * [Optional] Indicates if we should automatically infer the options and - * schema for CSV and JSON sources. + * [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. */ autodetect?: boolean; /** - * [Beta] Clustering specification for the destination table. Must be - * specified with time-based partitioning, data in the table will be first - * partitioned and subsequently clustered. + * [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. */ clustering?: Schema$Clustering; /** - * [Optional] Specifies whether the job is allowed to create new tables. The - * following values are supported: CREATE_IF_NEEDED: If the table does not - * exist, BigQuery creates the table. CREATE_NEVER: The table must already - * exist. If it does not, a 'notFound' error is returned in the job - * result. The default value is CREATE_IF_NEEDED. Creation, truncation and - * append actions occur as one atomic update upon job completion. + * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */ createDisposition?: string; /** @@ -1041,98 +972,51 @@ export namespace bigquery_v2 { */ destinationTable?: Schema$TableReference; /** - * [Beta] [Optional] Properties with which to create the destination table - * if it is new. + * [Beta] [Optional] Properties with which to create the destination table if it is new. */ destinationTableProperties?: Schema$DestinationTableProperties; /** - * [Optional] The character encoding of the data. The supported values are - * UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the - * data after the raw, binary data has been split using the values of the - * quote and fieldDelimiter properties. + * [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. */ encoding?: string; /** - * [Optional] The separator for fields in a CSV file. The separator can be - * any ISO-8859-1 single-byte character. To use a character in the range - * 128-255, you must encode the character as UTF8. BigQuery converts the - * string to ISO-8859-1 encoding, and then uses the first byte of the - * encoded string to split the data in its raw, binary state. BigQuery also - * supports the escape sequence "\t" to specify a tab separator. - * The default value is a comma (','). + * [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). */ fieldDelimiter?: string; /** - * [Optional, Experimental] If hive partitioning is enabled, which mode to - * use. Two modes are supported: - AUTO: automatically infer partition key - * name(s) and type(s). - STRINGS: automatic infer partition key name(s). - * All types are strings. Not all storage formats support hive partitioning - * -- requesting hive partitioning on an unsupported format will lead to an - * error. + * [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. */ hivePartitioningMode?: string; /** - * [Optional] Indicates if BigQuery should allow extra values that are not - * represented in the table schema. If true, the extra values are ignored. - * If false, records with extra columns are treated as bad records, and if - * there are too many bad records, an invalid error is returned in the job - * result. The default value is false. The sourceFormat property determines - * what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named - * values that don't match any column names + * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names */ ignoreUnknownValues?: boolean; /** - * [Optional] The maximum number of bad records that BigQuery can ignore - * when running the job. If the number of bad records exceeds this value, an - * invalid error is returned in the job result. This is only valid for CSV - * and JSON. The default value is 0, which requires that all records are - * valid. + * [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. */ maxBadRecords?: number; /** - * [Optional] Specifies a string that represents a null value in a CSV file. - * For example, if you specify "x/", BigQuery interprets - * "x/" as a null value when loading a CSV file. The default value - * is the empty string. If you set this property to a custom value, BigQuery - * throws an error if an empty string is present for all data types except - * for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the - * empty string as an empty value. + * [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "x/", BigQuery interprets "x/" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. */ nullMarker?: string; /** - * If sourceFormat is set to "DATASTORE_BACKUP", indicates which - * entity properties to load into BigQuery from a Cloud Datastore backup. - * Property names are case sensitive and must be top-level properties. If no - * properties are specified, BigQuery loads all properties. If any named - * property isn't found in the Cloud Datastore backup, an invalid error - * is returned in the job result. + * If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. */ projectionFields?: string[]; /** - * [Optional] The value that is used to quote data sections in a CSV file. - * BigQuery converts the string to ISO-8859-1 encoding, and then uses the - * first byte of the encoded string to split the data in its raw, binary - * state. The default value is a double-quote ('"'). If your - * data does not contain quoted sections, set the property value to an empty - * string. If your data contains quoted newline characters, you must also - * set the allowQuotedNewlines property to true. + * [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. */ quote?: string; /** - * [TrustedTester] Range partitioning specification for this table. Only one - * of timePartitioning and rangePartitioning should be specified. + * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */ rangePartitioning?: Schema$RangePartitioning; /** - * [Optional] The schema for the destination table. The schema can be - * omitted if the destination table already exists, or if you're loading - * data from Google Cloud Datastore. + * [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. */ schema?: Schema$TableSchema; /** - * [Deprecated] The inline schema. For CSV schemas, specify as - * "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, - * bar:INTEGER, baz:FLOAT". + * [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". */ schemaInline?: string; /** @@ -1140,98 +1024,49 @@ export namespace bigquery_v2 { */ schemaInlineFormat?: string; /** - * Allows the schema of the destination table to be updated as a side effect - * of the load job if a schema is autodetected or supplied in the job - * configuration. Schema update options are supported in two cases: when - * writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE - * and the destination table is a partition of a table, specified by - * partition decorators. For normal tables, WRITE_TRUNCATE will always - * overwrite the schema. One or more of the following values are specified: - * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. - * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original - * schema to nullable. + * Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */ schemaUpdateOptions?: string[]; /** - * [Optional] The number of rows at the top of a CSV file that BigQuery will - * skip when loading the data. The default value is 0. This property is - * useful if you have header rows in the file that should be skipped. + * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. */ skipLeadingRows?: number; /** - * [Optional] The format of the data files. For CSV files, specify - * "CSV". For datastore backups, specify - * "DATASTORE_BACKUP". For newline-delimited JSON, specify - * "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". - * For parquet, specify "PARQUET". For orc, specify - * "ORC". The default value is CSV. + * [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. */ sourceFormat?: string; /** - * [Required] The fully-qualified URIs that point to your data in Google - * Cloud. For Google Cloud Storage URIs: Each URI can contain one - * '*' wildcard character and it must come after the - * 'bucket' name. Size limits related to load jobs apply to external - * data sources. For Google Cloud Bigtable URIs: Exactly one URI can be - * specified and it has be a fully specified and valid HTTPS URL for a - * Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly - * one URI can be specified. Also, the '*' wildcard character is not - * allowed. + * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */ sourceUris?: string[]; /** - * Time-based partitioning specification for the destination table. Only one - * of timePartitioning and rangePartitioning should be specified. + * Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */ timePartitioning?: Schema$TimePartitioning; /** - * [Optional] If sourceFormat is set to "AVRO", indicates whether - * to enable interpreting logical types into their corresponding types (ie. - * TIMESTAMP), instead of only using their raw types (ie. INTEGER). + * [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER). */ useAvroLogicalTypes?: boolean; /** - * [Optional] Specifies the action that occurs if the destination table - * already exists. The following values are supported: WRITE_TRUNCATE: If - * the table already exists, BigQuery overwrites the table data. - * WRITE_APPEND: If the table already exists, BigQuery appends the data to - * the table. WRITE_EMPTY: If the table already exists and contains data, a - * 'duplicate' error is returned in the job result. The default - * value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery - * is able to complete the job successfully. Creation, truncation and append - * actions occur as one atomic update upon job completion. + * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ writeDisposition?: string; } export interface Schema$JobConfigurationQuery { /** - * [Optional] If true and query uses legacy SQL dialect, allows the query to - * produce arbitrarily large result tables at a slight cost in performance. - * Requires destinationTable to be set. For standard SQL queries, this flag - * is ignored and large results are always allowed. However, you must still - * set destinationTable when result size exceeds the allowed maximum - * response size. + * [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. */ allowLargeResults?: boolean; /** - * [Beta] Clustering specification for the destination table. Must be - * specified with time-based partitioning, data in the table will be first - * partitioned and subsequently clustered. + * [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. */ clustering?: Schema$Clustering; /** - * [Optional] Specifies whether the job is allowed to create new tables. The - * following values are supported: CREATE_IF_NEEDED: If the table does not - * exist, BigQuery creates the table. CREATE_NEVER: The table must already - * exist. If it does not, a 'notFound' error is returned in the job - * result. The default value is CREATE_IF_NEEDED. Creation, truncation and - * append actions occur as one atomic update upon job completion. + * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */ createDisposition?: string; /** - * [Optional] Specifies the default dataset to use for unqualified table - * names in the query. Note that this does not alter behavior of unqualified - * dataset names. + * [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. */ defaultDataset?: Schema$DatasetReference; /** @@ -1239,35 +1074,23 @@ export namespace bigquery_v2 { */ destinationEncryptionConfiguration?: Schema$EncryptionConfiguration; /** - * [Optional] Describes the table where the query results should be stored. - * If not present, a new table will be created to store the results. This - * property must be set for large results that exceed the maximum response - * size. + * [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size. */ destinationTable?: Schema$TableReference; /** - * [Optional] If true and query uses legacy SQL dialect, flattens all nested - * and repeated fields in the query results. allowLargeResults must be true - * if this is set to false. For standard SQL queries, this flag is ignored - * and results are never flattened. + * [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. */ flattenResults?: boolean; /** - * [Optional] Limits the billing tier for this job. Queries that have - * resource usage beyond this tier will fail (without incurring a charge). - * If unspecified, this will be set to your project default. + * [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. */ maximumBillingTier?: number; /** - * [Optional] Limits the bytes billed for this job. Queries that will have - * bytes billed beyond this limit will fail (without incurring a charge). If - * unspecified, this will be set to your project default. + * [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. */ maximumBytesBilled?: string; /** - * Standard SQL only. Set to POSITIONAL to use positional (?) query - * parameters or to NAMED to use named (@myparam) query parameters in this - * query. + * Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */ parameterMode?: string; /** @@ -1275,13 +1098,11 @@ export namespace bigquery_v2 { */ preserveNulls?: boolean; /** - * [Optional] Specifies a priority for the query. Possible values include - * INTERACTIVE and BATCH. The default value is INTERACTIVE. + * [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. */ priority?: string; /** - * [Required] SQL query text to execute. The useLegacySql field can be used - * to indicate whether the query uses legacy SQL or standard SQL. + * [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. */ query?: string; /** @@ -1289,49 +1110,27 @@ export namespace bigquery_v2 { */ queryParameters?: Schema$QueryParameter[]; /** - * [TrustedTester] Range partitioning specification for this table. Only one - * of timePartitioning and rangePartitioning should be specified. + * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */ rangePartitioning?: Schema$RangePartitioning; /** - * Allows the schema of the destination table to be updated as a side effect - * of the query job. Schema update options are supported in two cases: when - * writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE - * and the destination table is a partition of a table, specified by - * partition decorators. For normal tables, WRITE_TRUNCATE will always - * overwrite the schema. One or more of the following values are specified: - * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. - * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original - * schema to nullable. + * Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. */ schemaUpdateOptions?: string[]; /** - * [Optional] If querying an external data source outside of BigQuery, - * describes the data format, location and other properties of the data - * source. By defining these properties, the data source can then be queried - * as if it were a standard BigQuery table. + * [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. */ tableDefinitions?: {[key: string]: Schema$ExternalDataConfiguration}; /** - * Time-based partitioning specification for the destination table. Only one - * of timePartitioning and rangePartitioning should be specified. + * Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */ timePartitioning?: Schema$TimePartitioning; /** - * Specifies whether to use BigQuery's legacy SQL dialect for this - * query. The default value is true. If set to false, the query will use - * BigQuery's standard SQL: - * https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set - * to false, the value of flattenResults is ignored; query will be run as if - * flattenResults is false. + * Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */ useLegacySql?: boolean; /** - * [Optional] Whether to look for the result in the query cache. The query - * cache is a best-effort cache that will be flushed whenever tables in the - * query are modified. Moreover, the query cache is only available when a - * query does not have a destination table specified. The default value is - * true. + * [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. */ useQueryCache?: boolean; /** @@ -1339,27 +1138,13 @@ export namespace bigquery_v2 { */ userDefinedFunctionResources?: Schema$UserDefinedFunctionResource[]; /** - * [Optional] Specifies the action that occurs if the destination table - * already exists. The following values are supported: WRITE_TRUNCATE: If - * the table already exists, BigQuery overwrites the table data and uses the - * schema from the query result. WRITE_APPEND: If the table already exists, - * BigQuery appends the data to the table. WRITE_EMPTY: If the table already - * exists and contains data, a 'duplicate' error is returned in the - * job result. The default value is WRITE_EMPTY. Each action is atomic and - * only occurs if BigQuery is able to complete the job successfully. - * Creation, truncation and append actions occur as one atomic update upon - * job completion. + * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ writeDisposition?: string; } export interface Schema$JobConfigurationTableCopy { /** - * [Optional] Specifies whether the job is allowed to create new tables. The - * following values are supported: CREATE_IF_NEEDED: If the table does not - * exist, BigQuery creates the table. CREATE_NEVER: The table must already - * exist. If it does not, a 'notFound' error is returned in the job - * result. The default value is CREATE_IF_NEEDED. Creation, truncation and - * append actions occur as one atomic update upon job completion. + * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */ createDisposition?: string; /** @@ -1379,15 +1164,7 @@ export namespace bigquery_v2 { */ sourceTables?: Schema$TableReference[]; /** - * [Optional] Specifies the action that occurs if the destination table - * already exists. The following values are supported: WRITE_TRUNCATE: If - * the table already exists, BigQuery overwrites the table data. - * WRITE_APPEND: If the table already exists, BigQuery appends the data to - * the table. WRITE_EMPTY: If the table already exists and contains data, a - * 'duplicate' error is returned in the job result. The default - * value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery - * is able to complete the job successfully. Creation, truncation and append - * actions occur as one atomic update upon job completion. + * [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ writeDisposition?: string; } @@ -1400,15 +1177,15 @@ export namespace bigquery_v2 { * List of jobs that were requested. */ jobs?: Array<{ - configuration?: Schema$JobConfiguration; + user_email?: string; errorResult?: Schema$ErrorProto; - id?: string; - jobReference?: Schema$JobReference; kind?: string; + jobReference?: Schema$JobReference; + status?: Schema$JobStatus; state?: string; statistics?: Schema$JobStatistics; - status?: Schema$JobStatus; - user_email?: string; + id?: string; + configuration?: Schema$JobConfiguration; }>; /** * The resource type of the response. @@ -1421,14 +1198,11 @@ export namespace bigquery_v2 { } export interface Schema$JobReference { /** - * [Required] The ID of the job. The ID must contain only letters (a-z, - * A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length - * is 1,024 characters. + * [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. */ jobId?: string; /** - * The geographic location of the job. See details at - * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -1438,18 +1212,15 @@ export namespace bigquery_v2 { } export interface Schema$JobStatistics { /** - * [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and - * EXTRACT jobs. + * [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. */ completionRatio?: number; /** - * [Output-only] Creation time of this job, in milliseconds since the epoch. - * This field will be present on all jobs. + * [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. */ creationTime?: string; /** - * [Output-only] End time of this job, in milliseconds since the epoch. This - * field will be present whenever a job is in the DONE state. + * [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. */ endTime?: string; /** @@ -1479,16 +1250,13 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{name?: string; slotMs?: string}>; + reservationUsage?: Array<{slotMs?: string; name?: string}>; /** - * [Output-only] Start time of this job, in milliseconds since the epoch. - * This field will be present when the job transitions from the PENDING - * state to either RUNNING or DONE. + * [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. */ startTime?: string; /** - * [Output-only] [Deprecated] Use the bytes processed in the query - * statistics instead. + * [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. */ totalBytesProcessed?: string; /** @@ -1506,20 +1274,11 @@ export namespace bigquery_v2 { */ cacheHit?: boolean; /** - * The DDL operation performed, possibly dependent on the pre-existence of - * the DDL target. Possible values (new values might be added in the - * future): "CREATE": The query created the DDL target. - * "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT - * EXISTS while the table already exists, or the query is DROP TABLE IF - * EXISTS while the table does not exist. "REPLACE": The query - * replaced the DDL target. Example case: the query is CREATE OR REPLACE - * TABLE, and the table already exists. "DROP": The query deleted - * the DDL target. + * The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. */ ddlOperationPerformed?: string; /** - * The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE - * queries. + * The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. */ ddlTargetRoutine?: Schema$RoutineReference; /** @@ -1543,8 +1302,7 @@ export namespace bigquery_v2 { */ modelTrainingExpectedTotalIteration?: string; /** - * [Output-only] The number of rows affected by a DML statement. Present - * only for DML statements INSERT, UPDATE or DELETE. + * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */ numDmlAffectedRows?: string; /** @@ -1552,8 +1310,7 @@ export namespace bigquery_v2 { */ queryPlan?: Schema$ExplainQueryStage[]; /** - * [Output-only] Referenced tables for the job. Queries that reference more - * than 50 tables will not have a complete list. + * [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. */ referencedTables?: Schema$TableReference[]; /** @@ -1561,29 +1318,11 @@ export namespace bigquery_v2 { */ reservationUsage?: Array<{name?: string; slotMs?: string}>; /** - * [Output-only] The schema of the results. Present only for successful dry - * run of non-legacy SQL queries. + * [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */ schema?: Schema$TableSchema; /** - * The type of query statement, if valid. Possible values (new values might - * be added in the future): "SELECT": SELECT query. - * "INSERT": INSERT query; see - * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. - * "UPDATE": UPDATE query; see - * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. - * "DELETE": DELETE query; see - * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. - * "MERGE": MERGE query; see - * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. - * "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. - * "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS - * SELECT ... . "DROP_TABLE": DROP TABLE query. - * "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . - * "DROP_VIEW": DROP VIEW query. "CREATE_FUNCTION": - * CREATE FUNCTION query. "DROP_FUNCTION" : DROP FUNCTION query. - * "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER - * VIEW query. + * The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. */ statementType?: string; /** @@ -1599,16 +1338,11 @@ export namespace bigquery_v2 { */ totalBytesProcessed?: string; /** - * [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and - * this field specifies the accuracy of the estimate. Possible values can - * be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is - * precise. LOWER_BOUND: estimate is lower bound of what the query would - * cost. UPPER_BOUND: estimate is upper bound of what the query would cost. + * [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. */ totalBytesProcessedAccuracy?: string; /** - * [Output-only] Total number of partitions processed from all partitioned - * tables referenced in the job. + * [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. */ totalPartitionsProcessed?: string; /** @@ -1616,17 +1350,13 @@ export namespace bigquery_v2 { */ totalSlotMs?: string; /** - * Standard SQL only: list of undeclared query parameters detected during a - * dry run validation. + * Standard SQL only: list of undeclared query parameters detected during a dry run validation. */ undeclaredQueryParameters?: Schema$QueryParameter[]; } export interface Schema$JobStatistics3 { /** - * [Output-only] The number of bad records encountered. Note that if the job - * has failed because of more bad records encountered than the maximum - * allowed in the load job configuration, then this number can be less than - * the total number of bad records present in the input data. + * [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. */ badRecords?: string; /** @@ -1638,40 +1368,31 @@ export namespace bigquery_v2 { */ inputFiles?: string; /** - * [Output-only] Size of the loaded data in bytes. Note that while a load - * job is in the running state, this value may change. + * [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. */ outputBytes?: string; /** - * [Output-only] Number of rows imported in a load job. Note that while an - * import job is in the running state, this value may change. + * [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. */ outputRows?: string; } export interface Schema$JobStatistics4 { /** - * [Output-only] Number of files per destination URI or URI pattern - * specified in the extract configuration. These values will be in the same - * order as the URIs specified in the 'destinationUris' field. + * [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. */ destinationUriFileCounts?: string[]; /** - * [Output-only] Number of user bytes extracted into the result. This is the - * byte count as computed by BigQuery for billing purposes. + * [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. */ inputBytes?: string; } export interface Schema$JobStatus { /** - * [Output-only] Final error result of the job. If present, indicates that - * the job has completed and was unsuccessful. + * [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. */ errorResult?: Schema$ErrorProto; /** - * [Output-only] The first errors encountered during the running of the job. - * The final message includes the number of errors that caused the process - * to stop. Errors here do not necessarily mean that the job has completed - * or was unsuccessful. + * [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. */ errors?: Schema$ErrorProto[]; /** @@ -1684,10 +1405,28 @@ export namespace bigquery_v2 { */ export interface Schema$JsonObject {} export interface Schema$JsonValue {} + export interface Schema$ListModelsResponse { + /** + * Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels. + */ + models?: Schema$Model[]; + /** + * A token to request the next page of results. + */ + nextPageToken?: string; + } + /** + * BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses. + */ + export interface Schema$LocationMetadata { + /** + * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations. + */ + legacyLocationId?: string; + } export interface Schema$MaterializedViewDefinition { /** - * [Output-only] [TrustedTester] The time when this materialized view was - * last modified, in milliseconds since the epoch. + * [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch. */ lastRefreshTime?: string; /** @@ -1695,21 +1434,100 @@ export namespace bigquery_v2 { */ query?: string; } + export interface Schema$Model { + /** + * Output only. The time when this model was created, in millisecs since the epoch. + */ + creationTime?: string; + /** + * [Optional] A user-friendly description of this model. @mutable bigquery.models.patch + */ + description?: string; + /** + * Output only. A hash of this resource. + */ + etag?: string; + /** + * [Optional] The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. @mutable bigquery.models.patch + */ + expirationTime?: string; + /** + * Output only. Input feature columns that were used to train this model. + */ + featureColumns?: Schema$StandardSqlField[]; + /** + * [Optional] A descriptive name for this model. @mutable bigquery.models.patch + */ + friendlyName?: string; + /** + * Output only. Label columns that were used to train this model. The output of the model will have a “predicted_” prefix to these columns. + */ + labelColumns?: Schema$StandardSqlField[]; + /** + * [Optional] The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. @mutable bigquery.models.patch + */ + labels?: {[key: string]: string}; + /** + * Output only. The time when this model was last modified, in millisecs since the epoch. + */ + lastModifiedTime?: string; + /** + * Output only. The geographic location where the model resides. This value is inherited from the dataset. + */ + location?: string; + /** + * Required. Unique identifier for this model. + */ + modelReference?: Schema$ModelReference; + /** + * Output only. Type of the model resource. + */ + modelType?: string; + /** + * Output only. Information for all training runs in increasing order of start_time. + */ + trainingRuns?: Schema$TrainingRun[]; + } export interface Schema$ModelDefinition { /** - * [Output-only, Beta] Model options used for the first training run. These - * options are immutable for subsequent training runs. Default values are - * used for any options not specified in the input query. + * [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query. */ - modelOptions?: {labels?: string[]; lossType?: string; modelType?: string}; + modelOptions?: {lossType?: string; modelType?: string; labels?: string[]}; /** - * [Output-only, Beta] Information about ml training runs, each training run - * comprises of multiple iterations and there may be multiple training runs - * for the model if warm start is used or if a user decides to continue a - * previously cancelled query. + * [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query. */ trainingRuns?: Schema$BqmlTrainingRun[]; } + /** + * Id path of a model. + */ + export interface Schema$ModelReference { + /** + * [Required] The ID of the dataset containing this model. + */ + datasetId?: string; + /** + * [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + */ + modelId?: string; + /** + * [Required] The ID of the project containing this model. + */ + projectId?: string; + } + /** + * Evaluation metrics for multi-class classification models. + */ + export interface Schema$MultiClassClassificationMetrics { + /** + * Aggregate classification metrics. + */ + aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics; + /** + * Confusion matrix at different thresholds. + */ + confusionMatrixList?: Schema$ConfusionMatrix[]; + } export interface Schema$ProjectList { /** * A hash of the page of results @@ -1727,11 +1545,11 @@ export namespace bigquery_v2 { * Projects to which you have at least READ access. */ projects?: Array<{ - friendlyName?: string; id?: string; - kind?: string; - numericId?: string; projectReference?: Schema$ProjectReference; + friendlyName?: string; + numericId?: string; + kind?: string; }>; /** * The total number of projects in the list. @@ -1740,15 +1558,13 @@ export namespace bigquery_v2 { } export interface Schema$ProjectReference { /** - * [Required] ID of the project. Can be either the numeric ID or the - * assigned ID of the project. + * [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project. */ projectId?: string; } export interface Schema$QueryParameter { /** - * [Optional] If unset, this is a positional parameter. Otherwise, should be - * unique within a query. + * [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. */ name?: string; /** @@ -1766,12 +1582,11 @@ export namespace bigquery_v2 { */ arrayType?: Schema$QueryParameterType; /** - * [Optional] The types of the fields of this struct, in order, if this is a - * struct. + * [Optional] The types of the fields of this struct, in order, if this is a struct. */ structTypes?: Array<{ - description?: string; name?: string; + description?: string; type?: Schema$QueryParameterType; }>; /** @@ -1785,8 +1600,7 @@ export namespace bigquery_v2 { */ arrayValues?: Schema$QueryParameterValue[]; /** - * [Optional] The struct field values, in order of the struct type's - * declaration. + * [Optional] The struct field values, in order of the struct type's declaration. */ structValues?: {[key: string]: Schema$QueryParameterValue}; /** @@ -1796,17 +1610,11 @@ export namespace bigquery_v2 { } export interface Schema$QueryRequest { /** - * [Optional] Specifies the default datasetId and projectId to assume for - * any unqualified table names in the query. If not set, all table names in - * the query string must be qualified in the format - * 'datasetId.tableId'. + * [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'. */ defaultDataset?: Schema$DatasetReference; /** - * [Optional] If set to true, BigQuery doesn't run the job. Instead, if - * the query is valid, BigQuery returns statistics about the job such as how - * many bytes would be processed. If the query is invalid, an error returns. - * The default value is false. + * [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false. */ dryRun?: boolean; /** @@ -1814,22 +1622,15 @@ export namespace bigquery_v2 { */ kind?: string; /** - * The geographic location where the job should run. See details at - * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** - * [Optional] The maximum number of rows of data to return per page of - * results. Setting this flag to a small value such as 1000 and then paging - * through results might improve reliability when the query result set is - * large. In addition to this limit, responses are also limited to 10 MB. By - * default, there is no maximum row count, and only the byte limit applies. + * [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. */ maxResults?: number; /** - * Standard SQL only. Set to POSITIONAL to use positional (?) query - * parameters or to NAMED to use named (@myparam) query parameters in this - * query. + * Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. */ parameterMode?: string; /** @@ -1837,9 +1638,7 @@ export namespace bigquery_v2 { */ preserveNulls?: boolean; /** - * [Required] A query string, following the BigQuery query syntax, of the - * query to execute. Example: "SELECT count(f1) FROM - * [myProjectId:myDatasetId.myTableId]". + * [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". */ query?: string; /** @@ -1847,28 +1646,15 @@ export namespace bigquery_v2 { */ queryParameters?: Schema$QueryParameter[]; /** - * [Optional] How long to wait for the query to complete, in milliseconds, - * before the request times out and returns. Note that this is only a - * timeout for the request, not the query. If the query takes longer to run - * than the timeout value, the call returns without any results and with the - * 'jobComplete' flag set to false. You can call GetQueryResults() - * to wait for the query to complete and read the results. The default value - * is 10000 milliseconds (10 seconds). + * [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds). */ timeoutMs?: number; /** - * Specifies whether to use BigQuery's legacy SQL dialect for this - * query. The default value is true. If set to false, the query will use - * BigQuery's standard SQL: - * https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set - * to false, the value of flattenResults is ignored; query will be run as if - * flattenResults is false. + * Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. */ useLegacySql?: boolean; /** - * [Optional] Whether to look for the result in the query cache. The query - * cache is a best-effort cache that will be flushed whenever tables in the - * query are modified. The default value is true. + * [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. */ useQueryCache?: boolean; } @@ -1878,24 +1664,15 @@ export namespace bigquery_v2 { */ cacheHit?: boolean; /** - * [Output-only] The first errors or warnings encountered during the running - * of the job. The final message includes the number of errors that caused - * the process to stop. Errors here do not necessarily mean that the job has - * completed or was unsuccessful. + * [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. */ errors?: Schema$ErrorProto[]; /** - * Whether the query has completed or not. If rows or totalRows are present, - * this will always be true. If this is false, totalRows will not be - * available. + * Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. */ jobComplete?: boolean; /** - * Reference to the Job that was created to run the query. This field will - * be present even if the original request timed out, in which case - * GetQueryResults can be used to read the results once the query has - * completed. Since this API only returns the first page of results, - * subsequent pages can be fetched via the same mechanism (GetQueryResults). + * Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). */ jobReference?: Schema$JobReference; /** @@ -1903,8 +1680,7 @@ export namespace bigquery_v2 { */ kind?: string; /** - * [Output-only] The number of rows affected by a DML statement. Present - * only for DML statements INSERT, UPDATE or DELETE. + * [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */ numDmlAffectedRows?: string; /** @@ -1912,33 +1688,25 @@ export namespace bigquery_v2 { */ pageToken?: string; /** - * An object with as many results as can be contained within the maximum - * permitted reply size. To get any additional rows, you can call - * GetQueryResults and specify the jobReference returned above. + * An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. */ rows?: Schema$TableRow[]; /** - * The schema of the results. Present only when the query completes - * successfully. + * The schema of the results. Present only when the query completes successfully. */ schema?: Schema$TableSchema; /** - * The total number of bytes processed for this query. If this query was a - * dry run, this is the number of bytes that would be processed if the query - * were run. + * The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run. */ totalBytesProcessed?: string; /** - * The total number of rows in the complete query result set, which can be - * more than the number of rows in this single page of results. + * The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. */ totalRows?: string; } export interface Schema$QueryTimelineSample { /** - * Total number of units currently being processed by workers. This does not - * correspond directly to slot usage. This is the largest value observed - * since the last sample. + * Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. */ activeUnits?: string; /** @@ -1960,15 +1728,38 @@ export namespace bigquery_v2 { } export interface Schema$RangePartitioning { /** - * [TrustedTester] [Required] The table is partitioned by this field. The - * field must be a top-level NULLABLE/REQUIRED field. The only supported - * type is INTEGER/INT64. + * [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. */ field?: string; /** * [TrustedTester] [Required] Defines the ranges for range partitioning. */ - range?: {end?: string; interval?: string; start?: string}; + range?: {interval?: string; start?: string; end?: string}; + } + /** + * Evaluation metrics for regression models. + */ + export interface Schema$RegressionMetrics { + /** + * Mean absolute error. + */ + meanAbsoluteError?: number; + /** + * Mean squared error. + */ + meanSquaredError?: number; + /** + * Mean squared log error. + */ + meanSquaredLogError?: number; + /** + * Median absolute error. + */ + medianAbsoluteError?: number; + /** + * R^2 score. + */ + rSquared?: number; } export interface Schema$RoutineReference { /** @@ -1980,69 +1771,97 @@ export namespace bigquery_v2 { */ projectId?: string; /** - * [Required] The ID of the routine. The ID must contain only letters (a-z, - * A-Z), numbers (0-9), or underscores (_). The maximum length is 256 - * characters. + * [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. */ routineId?: string; } - export interface Schema$Streamingbuffer { + /** + * A single row in the confusion matrix. + */ + export interface Schema$Row { /** - * [Output-only] A lower-bound estimate of the number of bytes currently in - * the streaming buffer. + * The original label of this row. */ - estimatedBytes?: string; + actualLabel?: string; /** - * [Output-only] A lower-bound estimate of the number of rows currently in - * the streaming buffer. + * Info describing predicted label distribution. */ - estimatedRows?: string; + entries?: Schema$Entry[]; + } + /** + * The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY<DATE>>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} + */ + export interface Schema$StandardSqlDataType { /** - * [Output-only] Contains the timestamp of the oldest entry in the streaming - * buffer, in milliseconds since the epoch, if the streaming buffer is - * available. + * The type of the array's elements, if type_kind = "ARRAY". */ - oldestEntryTime?: string; - } - export interface Schema$Table { + arrayElementType?: Schema$StandardSqlDataType; /** - * [Beta] Clustering specification for the table. Must be specified with - * partitioning, data in the table will be first partitioned and - * subsequently clustered. + * The fields of this struct, in order, if type_kind = "STRUCT". */ - clustering?: Schema$Clustering; + structType?: Schema$StandardSqlStructType; /** - * [Output-only] The time when this table was created, in milliseconds since - * the epoch. + * Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY"). */ - creationTime?: string; + typeKind?: string; + } + /** + * A field or a column. + */ + export interface Schema$StandardSqlField { /** - * [Optional] A user-friendly description of this table. + * Optional. The name of this field. Can be absent for struct fields. */ - description?: string; + name?: string; /** - * Custom encryption configuration (e.g., Cloud KMS keys). + * Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). + */ + type?: Schema$StandardSqlDataType; + } + export interface Schema$StandardSqlStructType { + fields?: Schema$StandardSqlField[]; + } + export interface Schema$Streamingbuffer { + /** + * [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer. + */ + estimatedBytes?: string; + /** + * [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer. + */ + estimatedRows?: string; + /** + * [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available. + */ + oldestEntryTime?: string; + } + export interface Schema$Table { + /** + * [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered. + */ + clustering?: Schema$Clustering; + /** + * [Output-only] The time when this table was created, in milliseconds since the epoch. + */ + creationTime?: string; + /** + * [Optional] A user-friendly description of this table. + */ + description?: string; + /** + * Custom encryption configuration (e.g., Cloud KMS keys). */ encryptionConfiguration?: Schema$EncryptionConfiguration; /** - * [Output-only] A hash of the table metadata. Used to ensure there were no - * concurrent modifications to the resource when attempting an update. Not - * guaranteed to change when the table contents or the fields numRows, - * numBytes, numLongTermBytes or lastModifiedTime change. + * [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change. */ etag?: string; /** - * [Optional] The time when this table expires, in milliseconds since the - * epoch. If not present, the table will persist indefinitely. Expired - * tables will be deleted and their storage reclaimed. The - * defaultTableExpirationMs property of the encapsulating dataset can be - * used to set a default expirationTime on newly created tables. + * [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables. */ expirationTime?: string; /** - * [Optional] Describes the data format, location, and other properties of a - * table stored outside of BigQuery. By defining these properties, the data - * source can then be queried as if it were a standard BigQuery table. + * [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. */ externalDataConfiguration?: Schema$ExternalDataConfiguration; /** @@ -2058,22 +1877,15 @@ export namespace bigquery_v2 { */ kind?: string; /** - * The labels associated with this table. You can use these to organize and - * group your tables. Label keys and values can be no longer than 63 - * characters, can only contain lowercase letters, numeric characters, - * underscores and dashes. International characters are allowed. Label - * values are optional. Label keys must start with a letter and each label - * in the list must have a different key. + * The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. */ labels?: {[key: string]: string}; /** - * [Output-only] The time when this table was last modified, in milliseconds - * since the epoch. + * [Output-only] The time when this table was last modified, in milliseconds since the epoch. */ lastModifiedTime?: string; /** - * [Output-only] The geographic location where the table resides. This value - * is inherited from the dataset. + * [Output-only] The geographic location where the table resides. This value is inherited from the dataset. */ location?: string; /** @@ -2081,41 +1893,31 @@ export namespace bigquery_v2 { */ materializedView?: Schema$MaterializedViewDefinition; /** - * [Output-only, Beta] Present iff this table represents a ML model. - * Describes the training information for the model, and it is required to - * run 'PREDICT' queries. + * [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries. */ model?: Schema$ModelDefinition; /** - * [Output-only] The size of this table in bytes, excluding any data in the - * streaming buffer. + * [Output-only] The size of this table in bytes, excluding any data in the streaming buffer. */ numBytes?: string; /** - * [Output-only] The number of bytes in the table that are considered - * "long-term storage". + * [Output-only] The number of bytes in the table that are considered "long-term storage". */ numLongTermBytes?: string; /** - * [Output-only] [TrustedTester] The physical size of this table in bytes, - * excluding any data in the streaming buffer. This includes compression and - * storage used for time travel. + * [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel. */ numPhysicalBytes?: string; /** - * [Output-only] The number of rows of data in this table, excluding any - * data in the streaming buffer. + * [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer. */ numRows?: string; /** - * [TrustedTester] Range partitioning specification for this table. Only one - * of timePartitioning and rangePartitioning should be specified. + * [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */ rangePartitioning?: Schema$RangePartitioning; /** - * [Beta] [Optional] If set to true, queries over this table require a - * partition filter that can be used for partition elimination to be - * specified. + * [Beta] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. */ requirePartitionFilter?: boolean; /** @@ -2127,9 +1929,7 @@ export namespace bigquery_v2 { */ selfLink?: string; /** - * [Output-only] Contains information regarding this table's streaming - * buffer, if one is present. This field will be absent if the table is not - * being streamed to or if there is no data in the streaming buffer. + * [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer. */ streamingBuffer?: Schema$Streamingbuffer; /** @@ -2137,17 +1937,11 @@ export namespace bigquery_v2 { */ tableReference?: Schema$TableReference; /** - * Time-based partitioning specification for this table. Only one of - * timePartitioning and rangePartitioning should be specified. + * Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. */ timePartitioning?: Schema$TimePartitioning; /** - * [Output-only] Describes the table type. The following values are - * supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined - * by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result - * is persisted. EXTERNAL: A table that references data stored in an - * external storage system, such as Google Cloud Storage. The default value - * is TABLE. + * [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. */ type?: string; /** @@ -2160,9 +1954,7 @@ export namespace bigquery_v2 { } export interface Schema$TableDataInsertAllRequest { /** - * [Optional] Accept rows that contain values that do not match the schema. - * The unknown values are ignored. Default is false, which treats unknown - * values as errors. + * [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors. */ ignoreUnknownValues?: boolean; /** @@ -2174,18 +1966,11 @@ export namespace bigquery_v2 { */ rows?: Array<{insertId?: string; json?: Schema$JsonObject}>; /** - * [Optional] Insert all valid rows of a request, even if invalid rows - * exist. The default value is false, which causes the entire request to - * fail if any invalid rows exist. + * [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist. */ skipInvalidRows?: boolean; /** - * If specified, treats the destination table as a base template, and - * inserts the rows into an instance table named - * "{destination}{templateSuffix}". BigQuery will manage creation - * of the instance table, using the schema of the base template table. See - * https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables - * for considerations when working with templates tables. + * If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables. */ templateSuffix?: string; } @@ -2209,9 +1994,7 @@ export namespace bigquery_v2 { */ kind?: string; /** - * A token used for paging results. Providing this token instead of the - * startIndex parameter can help you retrieve stable results when an - * underlying table is changing. + * A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing. */ pageToken?: string; /** @@ -2225,8 +2008,7 @@ export namespace bigquery_v2 { } export interface Schema$TableFieldSchema { /** - * [Optional] The categories attached to this field, used for field-level - * access control. + * [Optional] The categories attached to this field, used for field-level access control. */ categories?: {names?: string[]}; /** @@ -2234,27 +2016,19 @@ export namespace bigquery_v2 { */ description?: string; /** - * [Optional] Describes the nested schema fields if the type property is set - * to RECORD. + * [Optional] Describes the nested schema fields if the type property is set to RECORD. */ fields?: Schema$TableFieldSchema[]; /** - * [Optional] The field mode. Possible values include NULLABLE, REQUIRED and - * REPEATED. The default value is NULLABLE. + * [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. */ mode?: string; /** - * [Required] The field name. The name must contain only letters (a-z, A-Z), - * numbers (0-9), or underscores (_), and must start with a letter or - * underscore. The maximum length is 128 characters. + * [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. */ name?: string; /** - * [Required] The field data type. Possible values include STRING, BYTES, - * INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), - * BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD - * (where RECORD indicates that the field contains a nested schema) or - * STRUCT (same as RECORD). + * [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). */ type?: string; } @@ -2276,16 +2050,16 @@ export namespace bigquery_v2 { */ tables?: Array<{ clustering?: Schema$Clustering; - creationTime?: string; - expirationTime?: string; - friendlyName?: string; + type?: string; id?: string; - kind?: string; - labels?: {[key: string]: string}; + expirationTime?: string; tableReference?: Schema$TableReference; timePartitioning?: Schema$TimePartitioning; - type?: string; + friendlyName?: string; + kind?: string; view?: {useLegacySql?: boolean}; + creationTime?: string; + labels?: {[key: string]: string}; }>; /** * The total number of tables in the dataset. @@ -2302,16 +2076,13 @@ export namespace bigquery_v2 { */ projectId?: string; /** - * [Required] The ID of the table. The ID must contain only letters (a-z, - * A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 - * characters. + * [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. */ tableId?: string; } export interface Schema$TableRow { /** - * Represents a single row in the result set, consisting of one or more - * fields. + * Represents a single row in the result set, consisting of one or more fields. */ f?: Schema$TableCell[]; } @@ -2323,36 +2094,117 @@ export namespace bigquery_v2 { } export interface Schema$TimePartitioning { /** - * [Optional] Number of milliseconds for which to keep the storage for - * partitions in the table. The storage in a partition will have an - * expiration time of its partition time plus this value. + * [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. */ expirationMs?: string; /** - * [Beta] [Optional] If not set, the table is partitioned by pseudo column, - * referenced via either '_PARTITIONTIME' as TIMESTAMP type, or - * '_PARTITIONDATE' as DATE type. If field is specified, the table - * is instead partitioned by this field. The field must be a top-level - * TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. + * [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. */ field?: string; requirePartitionFilter?: boolean; /** - * [Required] The only type supported is DAY, which will generate one - * partition per day. + * [Required] The only type supported is DAY, which will generate one partition per day. */ type?: string; } + export interface Schema$TrainingOptions { + /** + * The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties + */ + dataSplitColumn?: string; + /** + * The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2. + */ + dataSplitEvalFraction?: number; + /** + * The data split type for training and evaluation, e.g. RANDOM. + */ + dataSplitMethod?: string; + /** + * [Beta] Distance type for clustering models. + */ + distanceType?: string; + /** + * Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). + */ + earlyStop?: boolean; + /** + * Specifies the initial learning rate for line search to start at. + */ + initialLearnRate?: number; + /** + * Name of input label columns in training data. + */ + inputLabelColumns?: string[]; + /** + * L1 regularization coefficient. + */ + l1Regularization?: number; + /** + * L2 regularization coefficient. + */ + l2Regularization?: number; + /** + * Weights associated with each label class, for rebalancing the training data. + */ + labelClassWeights?: {[key: string]: number}; + /** + * Learning rate in training. + */ + learnRate?: number; + /** + * The strategy to determine learning rate. + */ + learnRateStrategy?: string; + /** + * Type of loss function used during training run. + */ + lossType?: string; + /** + * The maximum number of iterations in training. + */ + maxIterations?: string; + /** + * When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. + */ + minRelativeProgress?: number; + /** + * [Beta] Number of clusters for clustering models. + */ + numClusters?: string; + /** + * Whether to train a model from the last checkpoint. + */ + warmStart?: boolean; + } + /** + * Information about a single training query run for the model. + */ + export interface Schema$TrainingRun { + /** + * The evaluation metrics over training/eval data that were computed at the end of training. + */ + evaluationMetrics?: Schema$EvaluationMetrics; + /** + * Output of each iteration run, results.size() <= max_iterations. + */ + results?: Schema$IterationResult[]; + /** + * The start time of this training run. + */ + startTime?: string; + /** + * Options that were used for this training run, includes user specified and default options that were used. + */ + trainingOptions?: Schema$TrainingOptions; + } export interface Schema$UserDefinedFunctionResource { /** - * [Pick one] An inline resource that contains code for a user-defined - * function (UDF). Providing a inline code resource is equivalent to - * providing a URI for a file containing the same code. + * [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. */ inlineCode?: string; /** - * [Pick one] A code resource to load from a Google Cloud Storage URI - * (gs://bucket/path). + * [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). */ resourceUri?: string; } @@ -2362,10 +2214,7 @@ export namespace bigquery_v2 { */ query?: string; /** - * Specifies whether to use BigQuery's legacy SQL for this view. The - * default value is true. If set to false, the view will use BigQuery's - * standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries - * and views that reference this view must use the same flag value. + * Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value. */ useLegacySql?: boolean; /** @@ -2382,24 +2231,19 @@ export namespace bigquery_v2 { /** * bigquery.datasets.delete - * @desc Deletes the dataset specified by the datasetId value. Before you - * can delete a dataset, you must delete all its tables, either manually or - * by specifying deleteContents. Immediately after deletion, you can create - * another dataset with the same name. + * @desc Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2431,10 +2275,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2517,14 +2360,12 @@ export namespace bigquery_v2 { * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2559,10 +2400,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2644,14 +2484,12 @@ export namespace bigquery_v2 { * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2687,10 +2525,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2765,22 +2602,19 @@ export namespace bigquery_v2 { /** * bigquery.datasets.list - * @desc Lists all datasets in the specified project to which you have been - * granted the READER dataset role. + * @desc Lists all datasets in the specified project to which you have been granted the READER dataset role. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2806,8 +2640,8 @@ export namespace bigquery_v2 { * return; * } * for (var i = 0; i < datasetsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `datasetsPage`: console.log(JSON.stringify(datasetsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `datasetsPage`: + * console.log(JSON.stringify(datasetsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2825,10 +2659,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2908,24 +2741,19 @@ export namespace bigquery_v2 { /** * bigquery.datasets.patch - * @desc Updates information in an existing dataset. The update method - * replaces the entire dataset resource, whereas the patch method only - * replaces fields that are provided in the submitted dataset resource. This - * method supports patch semantics. + * @desc Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2941,8 +2769,7 @@ export namespace bigquery_v2 { * datasetId: 'my-dataset-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -2966,10 +2793,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3045,23 +2871,19 @@ export namespace bigquery_v2 { /** * bigquery.datasets.update - * @desc Updates information in an existing dataset. The update method - * replaces the entire dataset resource, whereas the patch method only - * replaces fields that are provided in the submitted dataset resource. + * @desc Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3077,8 +2899,7 @@ export namespace bigquery_v2 { * datasetId: 'my-dataset-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -3102,10 +2923,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3191,8 +3011,7 @@ export namespace bigquery_v2 { */ datasetId?: string; /** - * If True, delete all the tables in the dataset. If False and the dataset - * contains tables, the request will fail. Default is False + * If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False */ deleteContents?: boolean; /** @@ -3242,11 +3061,7 @@ export namespace bigquery_v2 { */ all?: boolean; /** - * An expression for filtering the results of the request by label. The - * syntax is "labels.[:]". Multiple filters can be ANDed - * together by connecting with a space. Example: - * "labels.department:receiving labels.active". See Filtering datasets using - * labels for details. + * An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details. */ filter?: string; /** @@ -3254,8 +3069,7 @@ export namespace bigquery_v2 { */ maxResults?: number; /** - * Page token, returned by a previous call, to request the next page of - * results + * Page token, returned by a previous call, to request the next page of results */ pageToken?: string; /** @@ -3312,24 +3126,19 @@ export namespace bigquery_v2 { /** * bigquery.jobs.cancel - * @desc Requests that a job be cancelled. This call will return - * immediately, and the client will need to poll for the job status to see - * if the cancel completed successfully. Cancelled jobs may still incur - * costs. + * @desc Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3364,10 +3173,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3445,23 +3253,19 @@ export namespace bigquery_v2 { /** * bigquery.jobs.get - * @desc Returns information about a specific job. Job information is - * available for a six month period after creation. Requires that you're the - * person who ran the job, or have the Is Owner project role. + * @desc Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3496,10 +3300,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3582,14 +3385,12 @@ export namespace bigquery_v2 { * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3618,8 +3419,8 @@ export namespace bigquery_v2 { * return; * } * for (var i = 0; i < errorsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `errorsPage`: console.log(JSON.stringify(errorsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `errorsPage`: + * console.log(JSON.stringify(errorsPage[i], null, 2)); * } * * if (response.pageToken) { @@ -3637,10 +3438,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3734,14 +3534,12 @@ export namespace bigquery_v2 { * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3760,8 +3558,8 @@ export namespace bigquery_v2 { * media: { * // TODO: Add desired media content for upload. See * // https://github.com/google/google-api-nodejs-client#media-uploads - * mimeType: '', // See - * https://www.w3.org/Protocols/rfc1341/4_Content-Type.html body: '', + * mimeType: '', // See https://www.w3.org/Protocols/rfc1341/4_Content-Type.html + * body: '', * }, * * auth: authClient, @@ -3784,10 +3582,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3869,25 +3666,19 @@ export namespace bigquery_v2 { /** * bigquery.jobs.list - * @desc Lists all jobs that you started in the specified project. Job - * information is available for a six month period after creation. The job - * list is sorted in reverse chronological order, by job creation time. - * Requires the Can View project role, or the Is Owner project role if you - * set the allUsers property. + * @desc Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3932,10 +3723,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4017,22 +3807,19 @@ export namespace bigquery_v2 { /** * bigquery.jobs.query - * @desc Runs a BigQuery SQL query synchronously and returns query results - * if the query completes within a specified timeout. + * @desc Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4068,10 +3855,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4158,9 +3944,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. Required except for US and EU. See - * details at - * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -4179,9 +3963,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. Required except for US and EU. See - * details at - * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -4201,9 +3983,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location where the job should run. Required except for US - * and EU. See details at - * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -4211,8 +3991,7 @@ export namespace bigquery_v2 { */ maxResults?: number; /** - * Page token, returned by a previous call, to request the next page of - * results + * Page token, returned by a previous call, to request the next page of results */ pageToken?: string; /** @@ -4224,9 +4003,7 @@ export namespace bigquery_v2 { */ startIndex?: string; /** - * How long to wait for the query to complete, in milliseconds, before - * returning. Default is 10 seconds. If the timeout passes before the job - * completes, the 'jobComplete' field in the response will be false + * How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false */ timeoutMs?: number; } @@ -4272,8 +4049,7 @@ export namespace bigquery_v2 { */ allUsers?: boolean; /** - * Max value for job creation time, in milliseconds since the POSIX epoch. - * If set, only jobs created before or at this timestamp are returned + * Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned */ maxCreationTime?: string; /** @@ -4281,13 +4057,11 @@ export namespace bigquery_v2 { */ maxResults?: number; /** - * Min value for job creation time, in milliseconds since the POSIX epoch. - * If set, only jobs created after or at this timestamp are returned + * Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned */ minCreationTime?: string; /** - * Page token, returned by a previous call, to request the next page of - * results + * Page token, returned by a previous call, to request the next page of results */ pageToken?: string; /** @@ -4320,6 +4094,395 @@ export namespace bigquery_v2 { requestBody?: Schema$QueryRequest; } + export class Resource$Models { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * bigquery.models.delete + * @desc Deletes the model specified by modelId from the dataset. + * @alias bigquery.models.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the model to delete. + * @param {string} params.modelId Model ID of the model to delete. + * @param {string} params.projectId Project ID of the model to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Models$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Models$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Models$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Models$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Models$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Models$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'modelId'], + pathParams: ['datasetId', 'modelId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigquery.models.get + * @desc Gets the specified model resource by model ID. + * @alias bigquery.models.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the requested model. + * @param {string} params.modelId Model ID of the requested model. + * @param {string} params.projectId Project ID of the requested model. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Models$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Models$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Models$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Models$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Models$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Models$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'modelId'], + pathParams: ['datasetId', 'modelId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigquery.models.list + * @desc Lists all models in the specified dataset. Requires the READER dataset role. + * @alias bigquery.models.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the models to list. + * @param {integer=} params.maxResults The maximum number of results per page. + * @param {string=} params.pageToken Page token, returned by a previous call to request the next page of results + * @param {string} params.projectId Project ID of the models to list. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Models$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Models$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Models$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Models$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Models$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Models$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId'], + pathParams: ['datasetId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigquery.models.patch + * @desc Patch specific fields in the specified model. + * @alias bigquery.models.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the model to patch. + * @param {string} params.modelId Model ID of the model to patch. + * @param {string} params.projectId Project ID of the model to patch. + * @param {().Model} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Models$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Models$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Models$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Models$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Models$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Models$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'modelId'], + pathParams: ['datasetId', 'modelId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Models$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Dataset ID of the model to delete. + */ + datasetId?: string; + /** + * Model ID of the model to delete. + */ + modelId?: string; + /** + * Project ID of the model to delete. + */ + projectId?: string; + } + export interface Params$Resource$Models$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Dataset ID of the requested model. + */ + datasetId?: string; + /** + * Model ID of the requested model. + */ + modelId?: string; + /** + * Project ID of the requested model. + */ + projectId?: string; + } + export interface Params$Resource$Models$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Dataset ID of the models to list. + */ + datasetId?: string; + /** + * The maximum number of results per page. + */ + maxResults?: number; + /** + * Page token, returned by a previous call to request the next page of results + */ + pageToken?: string; + /** + * Project ID of the models to list. + */ + projectId?: string; + } + export interface Params$Resource$Models$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Dataset ID of the model to patch. + */ + datasetId?: string; + /** + * Model ID of the model to patch. + */ + modelId?: string; + /** + * Project ID of the model to patch. + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Model; + } + export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -4328,22 +4491,19 @@ export namespace bigquery_v2 { /** * bigquery.projects.getServiceAccount - * @desc Returns the email address of the service account for your project - * used for interactions with Google Cloud KMS. + * @desc Returns the email address of the service account for your project used for interactions with Google Cloud KMS. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4375,10 +4535,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4469,14 +4628,12 @@ export namespace bigquery_v2 { * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4499,8 +4656,8 @@ export namespace bigquery_v2 { * return; * } * for (var i = 0; i < projectsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `projectsPage`: console.log(JSON.stringify(projectsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `projectsPage`: + * console.log(JSON.stringify(projectsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -4518,10 +4675,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4621,8 +4777,7 @@ export namespace bigquery_v2 { */ maxResults?: number; /** - * Page token, returned by a previous call, to request the next page of - * results + * Page token, returned by a previous call, to request the next page of results */ pageToken?: string; } @@ -4635,22 +4790,19 @@ export namespace bigquery_v2 { /** * bigquery.tabledata.insertAll - * @desc Streams data into BigQuery one record at a time without needing to - * run a load job. Requires the WRITER dataset role. + * @desc Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4692,10 +4844,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4783,22 +4934,19 @@ export namespace bigquery_v2 { /** * bigquery.tabledata.list - * @desc Retrieves table data from a specified set of rows. Requires the - * READER dataset role. + * @desc Retrieves table data from a specified set of rows. Requires the READER dataset role. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4849,10 +4997,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4982,8 +5129,7 @@ export namespace bigquery_v2 { */ projectId?: string; /** - * List of fields to return (comma-separated). If unspecified, all fields - * are returned + * List of fields to return (comma-separated). If unspecified, all fields are returned */ selectedFields?: string; /** @@ -5004,22 +5150,19 @@ export namespace bigquery_v2 { /** * bigquery.tables.delete - * @desc Deletes the table specified by tableId from the dataset. If the - * table contains data, all the data will be deleted. + * @desc Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5054,10 +5197,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5134,23 +5276,19 @@ export namespace bigquery_v2 { /** * bigquery.tables.get - * @desc Gets the specified table resource by table ID. This method does not - * return the data in the table, it only returns the table resource, which - * describes the structure of this table. + * @desc Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5188,10 +5326,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5276,14 +5413,12 @@ export namespace bigquery_v2 { * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5322,10 +5457,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5402,22 +5536,19 @@ export namespace bigquery_v2 { /** * bigquery.tables.list - * @desc Lists all tables in the specified dataset. Requires the READER - * dataset role. + * @desc Lists all tables in the specified dataset. Requires the READER dataset role. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5446,8 +5577,8 @@ export namespace bigquery_v2 { * return; * } * for (var i = 0; i < tablesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `tablesPage`: console.log(JSON.stringify(tablesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `tablesPage`: + * console.log(JSON.stringify(tablesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -5465,10 +5596,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5548,24 +5678,19 @@ export namespace bigquery_v2 { /** * bigquery.tables.patch - * @desc Updates information in an existing table. The update method - * replaces the entire table resource, whereas the patch method only - * replaces fields that are provided in the submitted table resource. This - * method supports patch semantics. + * @desc Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5584,8 +5709,7 @@ export namespace bigquery_v2 { * tableId: 'my-table-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -5609,10 +5733,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5690,23 +5813,19 @@ export namespace bigquery_v2 { /** * bigquery.tables.update - * @desc Updates information in an existing table. The update method - * replaces the entire table resource, whereas the patch method only - * replaces fields that are provided in the submitted table resource. + * @desc Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the BigQuery API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/bigquery - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5725,8 +5844,7 @@ export namespace bigquery_v2 { * tableId: 'my-table-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -5750,10 +5868,9 @@ export namespace bigquery_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5864,8 +5981,7 @@ export namespace bigquery_v2 { */ projectId?: string; /** - * List of fields to return (comma-separated). If unspecified, all fields - * are returned + * List of fields to return (comma-separated). If unspecified, all fields are returned */ selectedFields?: string; /** @@ -5908,8 +6024,7 @@ export namespace bigquery_v2 { */ maxResults?: number; /** - * Page token, returned by a previous call, to request the next page of - * results + * Page token, returned by a previous call, to request the next page of results */ pageToken?: string; /** diff --git a/src/apis/bigquerydatatransfer/package.json b/src/apis/bigquerydatatransfer/package.json index f35d867a953..101f3c432c0 100644 --- a/src/apis/bigquerydatatransfer/package.json +++ b/src/apis/bigquerydatatransfer/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index f321556a62e..b634d282881 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace bigquerydatatransfer_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace bigquerydatatransfer_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace bigquerydatatransfer_v1 { /** * BigQuery Data Transfer API * - * Schedule queries or transfer external data from SaaS applications to Google - * BigQuery on a regular basis. + * Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis. * * @example * const {google} = require('googleapis'); @@ -113,19 +108,17 @@ export namespace bigquerydatatransfer_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A request to determine whether the user has valid credentials. This method - * is used to limit the number of OAuth popups in the user interface. The user - * id is inferred from the API call context. If the data source has the - * Google+ authorization type, this method returns false, as it cannot be - * determined whether the credentials are already valid merely based on the - * user id. + * A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id. */ export interface Schema$CheckValidCredsRequest {} /** @@ -138,8 +131,7 @@ export namespace bigquerydatatransfer_v1 { hasValidCreds?: boolean; } /** - * Represents data source metadata. Metadata is sufficient to render UI and - * request proper OAuth tokens. + * Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens. */ export interface Schema$DataSource { /** @@ -151,10 +143,7 @@ export namespace bigquerydatatransfer_v1 { */ clientId?: string; /** - * Specifies whether the data source supports automatic data refresh for the - * past few days, and how it's supported. For some data sources, data - * might not be complete until a few days later, so it's useful to - * refresh data automatically. + * Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically. */ dataRefreshType?: string; /** @@ -162,14 +151,11 @@ export namespace bigquerydatatransfer_v1 { */ dataSourceId?: string; /** - * Default data refresh window on days. Only meaningful when - * `data_refresh_type` = `SLIDING_WINDOW`. + * Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. */ defaultDataRefreshWindowDays?: number; /** - * Default data transfer schedule. Examples of valid schedules include: - * `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and - * `first sunday of quarter 00:00`. + * Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. */ defaultSchedule?: string; /** @@ -201,15 +187,11 @@ export namespace bigquerydatatransfer_v1 { */ parameters?: Schema$DataSourceParameter[]; /** - * Api auth scopes for which refresh token needs to be obtained. These are - * scopes needed by a data source to prepare data and ingest them into - * BigQuery, e.g., https://www.googleapis.com/auth/bigquery + * Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery */ scopes?: string[]; /** - * Specifies whether the data source supports a user defined schedule, or - * operates on the default schedule. When set to `true`, user can override - * default schedule. + * Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule. */ supportsCustomSchedule?: boolean; /** @@ -221,17 +203,12 @@ export namespace bigquerydatatransfer_v1 { */ transferType?: string; /** - * The number of seconds to wait for an update from the data source before - * the Data Transfer Service marks the transfer as FAILED. + * The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. */ updateDeadlineSeconds?: number; } /** - * Represents a data source parameter with validation rules, so that - * parameters can be rendered in the UI. These parameters are given to us by - * supported data sources, and include all needed information for rendering - * and validation. Thus, whoever uses this api can decide to generate either - * generic ui, or custom data source specific forms. + * Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms. */ export interface Schema$DataSourceParameter { /** @@ -283,8 +260,7 @@ export namespace bigquerydatatransfer_v1 { */ type?: string; /** - * Description of the requirements for this field, in case the user input - * does not fulfill the regex pattern or min/max values. + * Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values. */ validationDescription?: string; /** @@ -297,11 +273,7 @@ export namespace bigquerydatatransfer_v1 { validationRegex?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -313,9 +285,7 @@ export namespace bigquerydatatransfer_v1 { */ dataSources?: Schema$DataSource[]; /** - * Output only. The next-pagination token. For multiple-page list results, - * this token can be used as the `ListDataSourcesRequest.page_token` to - * request the next page of list results. + * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results. */ nextPageToken?: string; } @@ -337,9 +307,7 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$ListTransferConfigsResponse { /** - * Output only. The next-pagination token. For multiple-page list results, - * this token can be used as the `ListTransferConfigsRequest.page_token` to - * request the next page of list results. + * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results. */ nextPageToken?: string; /** @@ -352,9 +320,7 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$ListTransferLogsResponse { /** - * Output only. The next-pagination token. For multiple-page list results, - * this token can be used as the `GetTransferRunLogRequest.page_token` to - * request the next page of list results. + * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results. */ nextPageToken?: string; /** @@ -367,9 +333,7 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$ListTransferRunsResponse { /** - * Output only. The next-pagination token. For multiple-page list results, - * this token can be used as the `ListTransferRunsRequest.page_token` to - * request the next page of list results. + * Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results. */ nextPageToken?: string; /** @@ -382,13 +346,11 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -396,13 +358,11 @@ export namespace bigquerydatatransfer_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -411,25 +371,15 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$ScheduleOptions { /** - * If true, automatic scheduling of data transfer runs for this - * configuration will be disabled. The runs can be started on ad-hoc basis - * using StartManualTransferRuns API. When automatic scheduling is disabled, - * the TransferConfig.schedule field will be ignored. + * If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored. */ disableAutoScheduling?: boolean; /** - * Defines time to stop scheduling transfer runs. A transfer run cannot be - * scheduled at or after the end time. The end time can be changed at any - * moment. The time when a data transfer can be trigerred manually is not - * limited by this option. + * Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option. */ endTime?: string; /** - * Specifies time to start scheduling transfer runs. The first run will be - * scheduled at or after the start time according to a recurrence pattern - * defined in the schedule string. The start time can be changed at any - * moment. The time when a data transfer can be trigerred manually is not - * limited by this option. + * Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option. */ startTime?: string; } @@ -438,13 +388,11 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$ScheduleTransferRunsRequest { /** - * End time of the range of transfer runs. For example, - * `"2017-05-30T00:00:00+00:00"`. + * End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. */ endTime?: string; /** - * Start time of the range of transfer runs. For example, - * `"2017-05-25T00:00:00+00:00"`. + * Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. */ startTime?: string; } @@ -462,8 +410,7 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$StartManualTransferRunsRequest { /** - * Specific run_time for a transfer run to be started. The - * requested_run_time must not be in the future. + * Specific run_time for a transfer run to be started. The requested_run_time must not be in the future. */ requestedRunTime?: string; /** @@ -481,40 +428,7 @@ export namespace bigquerydatatransfer_v1 { runs?: Schema$TransferRun[]; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -522,52 +436,33 @@ export namespace bigquerydatatransfer_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * A specification for a time range, this will request transfer runs with - * run_time between start_time (inclusive) and end_time (exclusive). + * A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive). */ export interface Schema$TimeRange { /** - * End time of the range of transfer runs. For example, - * `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the - * future. Creates transfer runs where run_time is in the range betwen - * start_time (inclusive) and end_time (exlusive). + * End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive). */ endTime?: string; /** - * Start time of the range of transfer runs. For example, - * `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly - * less than the end_time. Creates transfer runs where run_time is in the - * range betwen start_time (inclusive) and end_time (exlusive). + * Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range betwen start_time (inclusive) and end_time (exlusive). */ startTime?: string; } /** - * Represents a data transfer configuration. A transfer configuration contains - * all metadata needed to perform a data transfer. For example, - * `destination_dataset_id` specifies where data should be stored. When a new - * transfer configuration is created, the specified `destination_dataset_id` - * is created when needed and shared with the appropriate data source service - * account. + * Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. */ export interface Schema$TransferConfig { /** - * The number of days to look back to automatically refresh the data. For - * example, if `data_refresh_window_days = 10`, then every day BigQuery - * reingests data for [today-10, today-1], rather than ingesting data for - * just [today-1]. Only valid if the data source supports the feature. Set - * the value to 0 to use the default value. + * The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. */ dataRefreshWindowDays?: number; /** @@ -583,8 +478,7 @@ export namespace bigquerydatatransfer_v1 { */ destinationDatasetId?: string; /** - * Is this config disabled. When set to true, no runs are scheduled for a - * given transfer. + * Is this config disabled. When set to true, no runs are scheduled for a given transfer. */ disabled?: boolean; /** @@ -592,13 +486,7 @@ export namespace bigquerydatatransfer_v1 { */ displayName?: string; /** - * The resource name of the transfer config. Transfer config names have the - * form of - * `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. - * The name is automatically generated based on the config_id specified in - * CreateTransferConfigRequest along with project_id and region. If - * config_id is not provided, usually a uuid, even though it is not - * guaranteed or required, will be generated for config_id. + * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. */ name?: string; /** @@ -610,14 +498,7 @@ export namespace bigquerydatatransfer_v1 { */ params?: {[key: string]: any}; /** - * Data transfer schedule. If the data source does not support a custom - * schedule, this should be empty. If it is empty, the default value for the - * data source will be used. The specified times are in UTC. Examples of - * valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun - * 13:15`, and `first sunday of quarter 00:00`. See more explanation about - * the format here: - * https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format - * NOTE: the granularity should be at least 8 hours, or less frequent. + * Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent. */ schedule?: string; /** @@ -667,8 +548,7 @@ export namespace bigquerydatatransfer_v1 { */ destinationDatasetId?: string; /** - * Output only. Time when transfer run ended. Parameter ignored by server - * for input requests. + * Output only. Time when transfer run ended. Parameter ignored by server for input requests. */ endTime?: string; /** @@ -676,9 +556,7 @@ export namespace bigquerydatatransfer_v1 { */ errorStatus?: Schema$Status; /** - * The resource name of the transfer run. Transfer run names have the form - * `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. - * The name is ignored when creating a transfer run. + * The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. */ name?: string; /** @@ -686,16 +564,11 @@ export namespace bigquerydatatransfer_v1 { */ params?: {[key: string]: any}; /** - * For batch transfer runs, specifies the date and time that data should be - * ingested. + * For batch transfer runs, specifies the date and time that data should be ingested. */ runTime?: string; /** - * Output only. Describes the schedule of this transfer run if it was - * created as part of a regular schedule. For batch transfer runs that are - * scheduled manually, this is empty. NOTE: the system might choose to delay - * the schedule depending on the current load, so `schedule_time` - * doesn't always match this. + * Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this. */ schedule?: string; /** @@ -703,8 +576,7 @@ export namespace bigquerydatatransfer_v1 { */ scheduleTime?: string; /** - * Output only. Time when transfer run was started. Parameter ignored by - * server for input requests. + * Output only. Time when transfer run was started. Parameter ignored by server for input requests. */ startTime?: string; /** @@ -744,11 +616,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.dataSources.checkValidCreds - * @desc Returns true if valid credentials exist for the given data source - * and requesting user. Some data sources doesn't support service account, - * so we need to talk to them on behalf of the end user. This API just - * checks whether we have OAuth token for the particular user, which is a - * pre-requisite before user can create a transfer config. + * @desc Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config. * @alias bigquerydatatransfer.projects.dataSources.checkValidCreds * @memberOf! () * @@ -828,8 +696,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.dataSources.get - * @desc Retrieves a supported data source and returns its settings, which - * can be used for UI rendering. + * @desc Retrieves a supported data source and returns its settings, which can be used for UI rendering. * @alias bigquerydatatransfer.projects.dataSources.get * @memberOf! () * @@ -901,8 +768,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.dataSources.list - * @desc Lists supported data sources and returns their settings, which can - * be used for UI rendering. + * @desc Lists supported data sources and returns their settings, which can be used for UI rendering. * @alias bigquerydatatransfer.projects.dataSources.list * @memberOf! () * @@ -988,8 +854,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The data source in the form: - * `projects/{project_id}/dataSources/{data_source_id}` + * The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; @@ -1006,8 +871,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/dataSources/{data_source_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; } @@ -1023,15 +887,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListDataSourcesRequest` list results. For multiple-page results, - * `ListDataSourcesResponse` outputs a `next_page` token, which can be used - * as the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned. Must - * be in the form: `projects/{project_id}` + * The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` */ parent?: string; } @@ -1246,13 +1106,8 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.dataSources.checkValidCreds - * @desc Returns true if valid credentials exist for the given data source - * and requesting user. Some data sources doesn't support service account, - * so we need to talk to them on behalf of the end user. This API just - * checks whether we have OAuth token for the particular user, which is a - * pre-requisite before user can create a transfer config. - * @alias - * bigquerydatatransfer.projects.locations.dataSources.checkValidCreds + * @desc Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config. + * @alias bigquerydatatransfer.projects.locations.dataSources.checkValidCreds * @memberOf! () * * @param {object} params Parameters for request @@ -1331,8 +1186,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.dataSources.get - * @desc Retrieves a supported data source and returns its settings, which - * can be used for UI rendering. + * @desc Retrieves a supported data source and returns its settings, which can be used for UI rendering. * @alias bigquerydatatransfer.projects.locations.dataSources.get * @memberOf! () * @@ -1404,8 +1258,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.dataSources.list - * @desc Lists supported data sources and returns their settings, which can - * be used for UI rendering. + * @desc Lists supported data sources and returns their settings, which can be used for UI rendering. * @alias bigquerydatatransfer.projects.locations.dataSources.list * @memberOf! () * @@ -1491,8 +1344,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The data source in the form: - * `projects/{project_id}/dataSources/{data_source_id}` + * The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; @@ -1509,8 +1361,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/dataSources/{data_source_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; } @@ -1526,15 +1377,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListDataSourcesRequest` list results. For multiple-page results, - * `ListDataSourcesResponse` outputs a `next_page` token, which can be used - * as the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned. Must - * be in the form: `projects/{project_id}` + * The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` */ parent?: string; } @@ -1629,8 +1476,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.transferConfigs.delete - * @desc Deletes a data transfer configuration, including any associated - * transfer runs and logs. + * @desc Deletes a data transfer configuration, including any associated transfer runs and logs. * @alias bigquerydatatransfer.projects.locations.transferConfigs.delete * @memberOf! () * @@ -1857,8 +1703,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.transferConfigs.patch - * @desc Updates a data transfer configuration. All fields must be set, even - * if they are not updated. + * @desc Updates a data transfer configuration. All fields must be set, even if they are not updated. * @alias bigquerydatatransfer.projects.locations.transferConfigs.patch * @memberOf! () * @@ -1934,12 +1779,8 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns - * @desc Creates transfer runs for a time range [start_time, end_time]. For - * each date - or whatever granularity the data source supports - in the - * range, one transfer run is created. Note that runs are created per UTC - * time in the time range. DEPRECATED: use StartManualTransferRuns instead. - * @alias - * bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns + * @desc Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead. + * @alias bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns * @memberOf! () * * @param {object} params Parameters for request @@ -2023,12 +1864,8 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns - * @desc Start manual transfer runs to be executed now with schedule_time - * equal to current time. The transfer runs can be created for a time range - * where the run_time is between start_time (inclusive) and end_time - * (exclusive), or for a specific run_time. - * @alias - * bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns + * @desc Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. + * @alias bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns * @memberOf! () * * @param {object} params Parameters for request @@ -2119,37 +1956,15 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional OAuth2 authorization code to use with this transfer - * configuration. This is required if new credentials are needed, as - * indicated by `CheckValidCreds`. In order to obtain authorization_code, - * please make a request to - * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * * client_id should be OAuth client_id of BigQuery DTS API for the given - * data source returned by ListDataSources method. * data_source_scopes are - * the scopes returned by ListDataSources method. * redirect_uri is an - * optional parameter. If not specified, then authorization code is posted - * to the opener of authorization flow window. Otherwise it will be sent - * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means - * that authorization code should be returned in the title bar of the - * browser, with the page text prompting the user to copy the code and - * paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** - * The BigQuery project id where the transfer configuration should be - * created. Must be in the format - * projects/{project_id}/locations/{location_id} If specified location and - * location of the destination bigquery dataset do not match - the request - * will fail. + * The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. */ parent?: string; /** - * Optional version info. If users want to find a very recent access token, - * that is, immediately after approving access, users have to set the - * version_info claim in the token request. To obtain the version_info, - * users must use the “none+gsession” response type. which be return a - * version_info back in the authorization response which be be put in a JWT - * claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; @@ -2166,8 +1981,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -2179,8 +1993,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -2192,8 +2005,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When specified, only configurations of requested data sources are - * returned. + * When specified, only configurations of requested data sources are returned. */ dataSourceIds?: string[]; /** @@ -2201,15 +2013,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListTransfersRequest` list results. For multiple-page results, - * `ListTransfersResponse` outputs a `next_page` token, which can be used as - * the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned: - * `projects/{project_id}`. + * The BigQuery project id for which data sources should be returned: `projects/{project_id}`. */ parent?: string; } @@ -2221,30 +2029,11 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional OAuth2 authorization code to use with this transfer - * configuration. If it is provided, the transfer configuration will be - * associated with the authorizing user. In order to obtain - * authorization_code, please make a request to - * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * * client_id should be OAuth client_id of BigQuery DTS API for the given - * data source returned by ListDataSources method. * data_source_scopes are - * the scopes returned by ListDataSources method. * redirect_uri is an - * optional parameter. If not specified, then authorization code is posted - * to the opener of authorization flow window. Otherwise it will be sent - * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means - * that authorization code should be returned in the title bar of the - * browser, with the page text prompting the user to copy the code and - * paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** - * The resource name of the transfer config. Transfer config names have the - * form of - * `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. - * The name is automatically generated based on the config_id specified in - * CreateTransferConfigRequest along with project_id and region. If - * config_id is not provided, usually a uuid, even though it is not - * guaranteed or required, will be generated for config_id. + * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. */ name?: string; /** @@ -2252,12 +2041,7 @@ export namespace bigquerydatatransfer_v1 { */ updateMask?: string; /** - * Optional version info. If users want to find a very recent access token, - * that is, immediately after approving access, users have to set the - * version_info claim in the token request. To obtain the version_info, - * users must use the “none+gsession” response type. which be return a - * version_info back in the authorization response which be be put in a JWT - * claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; @@ -2274,8 +2058,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: - * `projects/{project_id}/transferConfigs/{config_id}`. + * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -2292,8 +2075,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: - * `projects/{project_id}/transferConfigs/{config_id}`. + * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -2316,8 +2098,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.transferConfigs.runs.delete * @desc Deletes the specified transfer run. - * @alias - * bigquerydatatransfer.projects.locations.transferConfigs.runs.delete + * @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.delete * @memberOf! () * * @param {object} params Parameters for request @@ -2543,8 +2324,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -2556,8 +2336,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -2573,16 +2352,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListTransferRunsRequest` list results. For multiple-page results, - * `ListTransferRunsResponse` outputs a `next_page` token, which can be used - * as the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * Name of transfer configuration for which transfer runs should be - * retrieved. Format of transfer configuration resource name is: - * `projects/{project_id}/transferConfigs/{config_id}`. + * Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; /** @@ -2604,8 +2378,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list * @desc Returns user facing log messages for the data transfer run. - * @alias - * bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list + * @alias bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list * @memberOf! () * * @param {object} params Parameters for request @@ -2691,8 +2464,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Message types to return. If not populated - INFO, WARNING and ERROR - * messages are returned. + * Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. */ messageTypes?: string[]; /** @@ -2700,15 +2472,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListTransferLogsRequest` list results. For multiple-page results, - * `ListTransferLogsResponse` outputs a `next_page` token, which can be used - * as the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * Transfer run name in the form: - * `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. */ parent?: string; } @@ -2801,8 +2569,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.transferConfigs.delete - * @desc Deletes a data transfer configuration, including any associated - * transfer runs and logs. + * @desc Deletes a data transfer configuration, including any associated transfer runs and logs. * @alias bigquerydatatransfer.projects.transferConfigs.delete * @memberOf! () * @@ -3029,8 +2796,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.transferConfigs.patch - * @desc Updates a data transfer configuration. All fields must be set, even - * if they are not updated. + * @desc Updates a data transfer configuration. All fields must be set, even if they are not updated. * @alias bigquerydatatransfer.projects.transferConfigs.patch * @memberOf! () * @@ -3106,10 +2872,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.transferConfigs.scheduleRuns - * @desc Creates transfer runs for a time range [start_time, end_time]. For - * each date - or whatever granularity the data source supports - in the - * range, one transfer run is created. Note that runs are created per UTC - * time in the time range. DEPRECATED: use StartManualTransferRuns instead. + * @desc Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead. * @alias bigquerydatatransfer.projects.transferConfigs.scheduleRuns * @memberOf! () * @@ -3194,10 +2957,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.transferConfigs.startManualRuns - * @desc Start manual transfer runs to be executed now with schedule_time - * equal to current time. The transfer runs can be created for a time range - * where the run_time is between start_time (inclusive) and end_time - * (exclusive), or for a specific run_time. + * @desc Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. * @alias bigquerydatatransfer.projects.transferConfigs.startManualRuns * @memberOf! () * @@ -3289,37 +3049,15 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional OAuth2 authorization code to use with this transfer - * configuration. This is required if new credentials are needed, as - * indicated by `CheckValidCreds`. In order to obtain authorization_code, - * please make a request to - * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * * client_id should be OAuth client_id of BigQuery DTS API for the given - * data source returned by ListDataSources method. * data_source_scopes are - * the scopes returned by ListDataSources method. * redirect_uri is an - * optional parameter. If not specified, then authorization code is posted - * to the opener of authorization flow window. Otherwise it will be sent - * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means - * that authorization code should be returned in the title bar of the - * browser, with the page text prompting the user to copy the code and - * paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** - * The BigQuery project id where the transfer configuration should be - * created. Must be in the format - * projects/{project_id}/locations/{location_id} If specified location and - * location of the destination bigquery dataset do not match - the request - * will fail. + * The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. */ parent?: string; /** - * Optional version info. If users want to find a very recent access token, - * that is, immediately after approving access, users have to set the - * version_info claim in the token request. To obtain the version_info, - * users must use the “none+gsession” response type. which be return a - * version_info back in the authorization response which be be put in a JWT - * claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; @@ -3336,8 +3074,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -3349,8 +3086,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -3362,8 +3098,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When specified, only configurations of requested data sources are - * returned. + * When specified, only configurations of requested data sources are returned. */ dataSourceIds?: string[]; /** @@ -3371,15 +3106,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListTransfersRequest` list results. For multiple-page results, - * `ListTransfersResponse` outputs a `next_page` token, which can be used as - * the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned: - * `projects/{project_id}`. + * The BigQuery project id for which data sources should be returned: `projects/{project_id}`. */ parent?: string; } @@ -3391,30 +3122,11 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional OAuth2 authorization code to use with this transfer - * configuration. If it is provided, the transfer configuration will be - * associated with the authorizing user. In order to obtain - * authorization_code, please make a request to - * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= - * * client_id should be OAuth client_id of BigQuery DTS API for the given - * data source returned by ListDataSources method. * data_source_scopes are - * the scopes returned by ListDataSources method. * redirect_uri is an - * optional parameter. If not specified, then authorization code is posted - * to the opener of authorization flow window. Otherwise it will be sent - * to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means - * that authorization code should be returned in the title bar of the - * browser, with the page text prompting the user to copy the code and - * paste it in the application. + * Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. */ authorizationCode?: string; /** - * The resource name of the transfer config. Transfer config names have the - * form of - * `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. - * The name is automatically generated based on the config_id specified in - * CreateTransferConfigRequest along with project_id and region. If - * config_id is not provided, usually a uuid, even though it is not - * guaranteed or required, will be generated for config_id. + * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. */ name?: string; /** @@ -3422,12 +3134,7 @@ export namespace bigquerydatatransfer_v1 { */ updateMask?: string; /** - * Optional version info. If users want to find a very recent access token, - * that is, immediately after approving access, users have to set the - * version_info claim in the token request. To obtain the version_info, - * users must use the “none+gsession” response type. which be return a - * version_info back in the authorization response which be be put in a JWT - * claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; @@ -3444,8 +3151,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: - * `projects/{project_id}/transferConfigs/{config_id}`. + * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -3462,8 +3168,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: - * `projects/{project_id}/transferConfigs/{config_id}`. + * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -3712,8 +3417,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -3725,8 +3429,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -3742,16 +3445,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListTransferRunsRequest` list results. For multiple-page results, - * `ListTransferRunsResponse` outputs a `next_page` token, which can be used - * as the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * Name of transfer configuration for which transfer runs should be - * retrieved. Format of transfer configuration resource name is: - * `projects/{project_id}/transferConfigs/{config_id}`. + * Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; /** @@ -3773,8 +3471,7 @@ export namespace bigquerydatatransfer_v1 { /** * bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list * @desc Returns user facing log messages for the data transfer run. - * @alias - * bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list + * @alias bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list * @memberOf! () * * @param {object} params Parameters for request @@ -3860,8 +3557,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Message types to return. If not populated - INFO, WARNING and ERROR - * messages are returned. + * Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. */ messageTypes?: string[]; /** @@ -3869,15 +3565,11 @@ export namespace bigquerydatatransfer_v1 { */ pageSize?: number; /** - * Pagination token, which can be used to request a specific page of - * `ListTransferLogsRequest` list results. For multiple-page results, - * `ListTransferLogsResponse` outputs a `next_page` token, which can be used - * as the `page_token` value to request the next page of list results. + * Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. */ pageToken?: string; /** - * Transfer run name in the form: - * `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. */ parent?: string; } diff --git a/src/apis/bigtableadmin/package.json b/src/apis/bigtableadmin/package.json index 958f7b938a4..d24114720df 100644 --- a/src/apis/bigtableadmin/package.json +++ b/src/apis/bigtableadmin/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/bigtableadmin/v1.ts b/src/apis/bigtableadmin/v1.ts index 8b7df6d8667..265b42f7a3c 100644 --- a/src/apis/bigtableadmin/v1.ts +++ b/src/apis/bigtableadmin/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace bigtableadmin_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace bigtableadmin_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,37 +108,33 @@ export namespace bigtableadmin_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A resizable group of nodes in a particular cloud location, capable of - * serving all Tables in the parent Instance. + * A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. */ export interface Schema$Cluster { /** - * (`CreationOnly`) The type of storage used by this cluster to serve its - * parent instance's tables, unless explicitly overridden. + * (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. */ defaultStorageType?: string; /** - * (`CreationOnly`) The location where this cluster's nodes and storage - * reside. For best performance, clients should be located as close as - * possible to this cluster. Currently only zones are supported, so values - * should be of the form `projects/<project>/locations/<zone>`. + * (`CreationOnly`) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`. */ location?: string; /** - * (`OutputOnly`) The unique name of the cluster. Values are of the form - * `projects/<project>/instances/<instance>/clusters/a-z*`. + * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/a-z*`. */ name?: string; /** - * The number of nodes allocated to this cluster. More nodes enable higher - * throughput and more consistent performance. + * The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. */ serveNodes?: number; /** @@ -167,13 +159,7 @@ export namespace bigtableadmin_v1 { */ requestTime?: string; /** - * Keys: the full `name` of each table that existed in the instance when - * CreateCluster was first called, i.e. - * `projects/<project>/instances/<instance>/tables/<table>`. - * Any table added to the instance by a later API call will be created in - * the new cluster by that API call, not this one. Values: information on - * how much of a table's data has been copied to the newly-created - * cluster so far. + * Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>`. Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far. */ tables?: {[key: string]: Schema$TableProgress}; } @@ -186,15 +172,11 @@ export namespace bigtableadmin_v1 { */ cluster?: Schema$Cluster; /** - * The ID to be used when referring to the new cluster within its instance, - * e.g., just `mycluster` rather than - * `projects/myproject/instances/myinstance/clusters/mycluster`. + * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. */ clusterId?: string; /** - * The unique name of the instance in which to create the new cluster. - * Values are of the form - * `projects/<project>/instances/<instance>`. + * The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`. */ parent?: string; } @@ -207,8 +189,7 @@ export namespace bigtableadmin_v1 { */ finishTime?: string; /** - * The request that prompted the initiation of this CreateInstance - * operation. + * The request that prompted the initiation of this CreateInstance operation. */ originalRequest?: Schema$CreateInstanceRequest; /** @@ -221,11 +202,7 @@ export namespace bigtableadmin_v1 { */ export interface Schema$CreateInstanceRequest { /** - * The clusters to be created within the instance, mapped by desired cluster - * ID, e.g., just `mycluster` rather than - * `projects/myproject/instances/myinstance/clusters/mycluster`. Fields - * marked `OutputOnly` must be left blank. Currently, at most two clusters - * can be specified. + * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified. */ clusters?: {[key: string]: Schema$Cluster}; /** @@ -233,43 +210,28 @@ export namespace bigtableadmin_v1 { */ instance?: Schema$Instance; /** - * The ID to be used when referring to the new instance within its project, - * e.g., just `myinstance` rather than - * `projects/myproject/instances/myinstance`. + * The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`. */ instanceId?: string; /** - * The unique name of the project in which to create the new instance. - * Values are of the form `projects/<project>`. + * The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`. */ parent?: string; } /** - * A collection of Bigtable Tables and the resources that serve them. All - * tables in an instance are served from all Clusters in the instance. + * A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. */ export interface Schema$Instance { /** - * The descriptive name for this instance as it appears in UIs. Can be - * changed at any time, but should be kept globally unique to avoid - * confusion. + * The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. */ displayName?: string; /** - * Labels are a flexible and lightweight mechanism for organizing cloud - * resources into groups that reflect a customer's organizational needs - * and deployment strategies. They can be used to filter resources and - * aggregate metrics. * Label keys must be between 1 and 63 characters long - * and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * - * Label values must be between 0 and 63 characters long and must conform to - * the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 - * labels can be associated with a given resource. * Keys and values must - * both be under 128 bytes. + * Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. */ labels?: {[key: string]: string}; /** - * (`OutputOnly`) The unique name of the instance. Values are of the form - * `projects/<project>/instances/a-z+[a-z0-9]`. + * (`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/a-z+[a-z0-9]`. */ name?: string; /** @@ -299,13 +261,11 @@ export namespace bigtableadmin_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -313,13 +273,11 @@ export namespace bigtableadmin_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -332,8 +290,7 @@ export namespace bigtableadmin_v1 { */ instance?: Schema$Instance; /** - * The subset of Instance fields which should be replaced. Must be - * explicitly set. + * The subset of Instance fields which should be replaced. Must be explicitly set. */ updateMask?: string; } @@ -342,9 +299,7 @@ export namespace bigtableadmin_v1 { */ export interface Schema$TableProgress { /** - * Estimate of the number of bytes copied so far for this table. This will - * eventually reach 'estimated_size_bytes' unless the table copy is - * CANCELLED. + * Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED. */ estimatedCopiedBytes?: string; /** @@ -383,8 +338,7 @@ export namespace bigtableadmin_v1 { */ finishTime?: string; /** - * The request that prompted the initiation of this UpdateInstance - * operation. + * The request that prompted the initiation of this UpdateInstance operation. */ originalRequest?: Schema$PartialUpdateInstanceRequest; /** diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index d215b90f0e7..d4827fb1fc8 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace bigtableadmin_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace bigtableadmin_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace bigtableadmin_v2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); @@ -121,8 +120,7 @@ export namespace bigtableadmin_v2 { } /** - * A configuration object describing how Cloud Bigtable should treat traffic - * from a particular end user application. + * A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. */ export interface Schema$AppProfile { /** @@ -130,13 +128,7 @@ export namespace bigtableadmin_v2 { */ description?: string; /** - * Strongly validated etag for optimistic concurrency control. Preserve the - * value returned from `GetAppProfile` when calling `UpdateAppProfile` to - * fail the request if there has been a modification in the mean time. The - * `update_mask` of the request need not include `etag` for this protection - * to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and - * [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more - * details. + * Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. */ etag?: string; /** @@ -144,8 +136,7 @@ export namespace bigtableadmin_v2 { */ multiClusterRoutingUseAny?: Schema$MultiClusterRoutingUseAny; /** - * (`OutputOnly`) The unique name of the app profile. Values are of the form - * `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. + * (`OutputOnly`) The unique name of the app profile. Values are of the form `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. */ name?: string; /** @@ -154,27 +145,7 @@ export namespace bigtableadmin_v2 { singleClusterRouting?: Schema$SingleClusterRouting; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -182,25 +153,16 @@ export namespace bigtableadmin_v2 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -213,36 +175,20 @@ export namespace bigtableadmin_v2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Request message for - * google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency + * Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency */ export interface Schema$CheckConsistencyRequest { /** @@ -251,41 +197,32 @@ export namespace bigtableadmin_v2 { consistencyToken?: string; } /** - * Response message for - * google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency + * Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency */ export interface Schema$CheckConsistencyResponse { /** - * True only if the token is consistent. A token is consistent if - * replication has caught up with the restrictions specified in the request. + * True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request. */ consistent?: boolean; } /** - * A resizable group of nodes in a particular cloud location, capable of - * serving all Tables in the parent Instance. + * A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. */ export interface Schema$Cluster { /** - * (`CreationOnly`) The type of storage used by this cluster to serve its - * parent instance's tables, unless explicitly overridden. + * (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. */ defaultStorageType?: string; /** - * (`CreationOnly`) The location where this cluster's nodes and storage - * reside. For best performance, clients should be located as close as - * possible to this cluster. Currently only zones are supported, so values - * should be of the form `projects/<project>/locations/<zone>`. + * (`CreationOnly`) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`. */ location?: string; /** - * (`OutputOnly`) The unique name of the cluster. Values are of the form - * `projects/<project>/instances/<instance>/clusters/a-z*`. + * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects/<project>/instances/<instance>/clusters/a-z*`. */ name?: string; /** - * The number of nodes allocated to this cluster. More nodes enable higher - * throughput and more consistent performance. + * The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. */ serveNodes?: number; /** @@ -307,10 +244,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$ColumnFamily { /** - * Garbage collection rule specified as a protobuf. Must serialize to at - * most 500 bytes. NOTE: Garbage collection executes opportunistically in - * the background, and so it's possible for reads to return a cell even - * if it matches the active GC expression for its family. + * Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family. */ gcRule?: Schema$GcRule; } @@ -331,13 +265,7 @@ export namespace bigtableadmin_v2 { */ requestTime?: string; /** - * Keys: the full `name` of each table that existed in the instance when - * CreateCluster was first called, i.e. - * `projects/<project>/instances/<instance>/tables/<table>`. - * Any table added to the instance by a later API call will be created in - * the new cluster by that API call, not this one. Values: information on - * how much of a table's data has been copied to the newly-created - * cluster so far. + * Keys: the full `name` of each table that existed in the instance when CreateCluster was first called, i.e. `projects/<project>/instances/<instance>/tables/<table>`. Any table added to the instance by a later API call will be created in the new cluster by that API call, not this one. Values: information on how much of a table's data has been copied to the newly-created cluster so far. */ tables?: {[key: string]: Schema$TableProgress}; } @@ -350,15 +278,11 @@ export namespace bigtableadmin_v2 { */ cluster?: Schema$Cluster; /** - * The ID to be used when referring to the new cluster within its instance, - * e.g., just `mycluster` rather than - * `projects/myproject/instances/myinstance/clusters/mycluster`. + * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. */ clusterId?: string; /** - * The unique name of the instance in which to create the new cluster. - * Values are of the form - * `projects/<project>/instances/<instance>`. + * The unique name of the instance in which to create the new cluster. Values are of the form `projects/<project>/instances/<instance>`. */ parent?: string; } @@ -371,8 +295,7 @@ export namespace bigtableadmin_v2 { */ finishTime?: string; /** - * The request that prompted the initiation of this CreateInstance - * operation. + * The request that prompted the initiation of this CreateInstance operation. */ originalRequest?: Schema$CreateInstanceRequest; /** @@ -385,11 +308,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$CreateInstanceRequest { /** - * The clusters to be created within the instance, mapped by desired cluster - * ID, e.g., just `mycluster` rather than - * `projects/myproject/instances/myinstance/clusters/mycluster`. Fields - * marked `OutputOnly` must be left blank. Currently, at most two clusters - * can be specified. + * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified. */ clusters?: {[key: string]: Schema$Cluster}; /** @@ -397,14 +316,11 @@ export namespace bigtableadmin_v2 { */ instance?: Schema$Instance; /** - * The ID to be used when referring to the new instance within its project, - * e.g., just `myinstance` rather than - * `projects/myproject/instances/myinstance`. + * The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`. */ instanceId?: string; /** - * The unique name of the project in which to create the new instance. - * Values are of the form `projects/<project>`. + * The unique name of the project in which to create the new instance. Values are of the form `projects/<project>`. */ parent?: string; } @@ -413,20 +329,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$CreateTableRequest { /** - * The optional list of row keys that will be used to initially split the - * table into several tablets (tablets are similar to HBase regions). Given - * two split keys, `s1` and `s2`, three tablets will be created, spanning - * the key ranges: `[, s1), [s1, s2), [s2, )`. Example: * Row keys := - * `["a", "apple", "custom", - * "customer_1", "customer_2",` `"other", - * "zz"]` * initial_split_keys := `["apple", - * "customer_1", "customer_2", "other"]` * Key - * assignment: - Tablet 1 `[, apple) => - * {"a"}.` - Tablet 2 `[apple, customer_1) => - * {"apple", "custom"}.` - Tablet 3 `[customer_1, - * customer_2) => {"customer_1"}.` - Tablet 4 `[customer_2, - * other) => {"customer_2"}.` - Tablet 5 `[other, ) - * => {"other", "zz"}.` + * The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, `s1` and `s2`, three tablets will be created, spanning the key ranges: `[, s1), [s1, s2), [s2, )`. Example: * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",` `"other", "zz"]` * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]` * Key assignment: - Tablet 1 `[, apple) => {"a"}.` - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.` - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.` - Tablet 4 `[customer_2, other) => {"customer_2"}.` - Tablet 5 `[other, ) => {"other", "zz"}.` */ initialSplits?: Schema$Split[]; /** @@ -434,14 +337,12 @@ export namespace bigtableadmin_v2 { */ table?: Schema$Table; /** - * The name by which the new table should be referred to within the parent - * instance, e.g., `foobar` rather than `<parent>/tables/foobar`. + * The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`. */ tableId?: string; } /** - * Request message for - * google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange + * Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange */ export interface Schema$DropRowRangeRequest { /** @@ -449,45 +350,32 @@ export namespace bigtableadmin_v2 { */ deleteAllDataFromTable?: boolean; /** - * Delete all rows that start with this row key prefix. Prefix cannot be - * zero length. + * Delete all rows that start with this row key prefix. Prefix cannot be zero length. */ rowKeyPrefix?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -500,8 +388,7 @@ export namespace bigtableadmin_v2 { */ intersection?: Schema$Intersection; /** - * Delete cells in a column older than the given age. Values must be at - * least one millisecond, and will be truncated to microsecond granularity. + * Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity. */ maxAge?: string; /** @@ -514,13 +401,11 @@ export namespace bigtableadmin_v2 { union?: Schema$Union; } /** - * Request message for - * google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken + * Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken */ export interface Schema$GenerateConsistencyTokenRequest {} /** - * Response message for - * google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken + * Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken */ export interface Schema$GenerateConsistencyTokenResponse { /** @@ -533,31 +418,19 @@ export namespace bigtableadmin_v2 { */ export interface Schema$GetIamPolicyRequest {} /** - * A collection of Bigtable Tables and the resources that serve them. All - * tables in an instance are served from all Clusters in the instance. + * A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. */ export interface Schema$Instance { /** - * The descriptive name for this instance as it appears in UIs. Can be - * changed at any time, but should be kept globally unique to avoid - * confusion. + * The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. */ displayName?: string; /** - * Labels are a flexible and lightweight mechanism for organizing cloud - * resources into groups that reflect a customer's organizational needs - * and deployment strategies. They can be used to filter resources and - * aggregate metrics. * Label keys must be between 1 and 63 characters long - * and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * - * Label values must be between 0 and 63 characters long and must conform to - * the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 - * labels can be associated with a given resource. * Keys and values must - * both be under 128 bytes. + * Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. */ labels?: {[key: string]: string}; /** - * (`OutputOnly`) The unique name of the instance. Values are of the form - * `projects/<project>/instances/a-z+[a-z0-9]`. + * (`OutputOnly`) The unique name of the instance. Values are of the form `projects/<project>/instances/a-z+[a-z0-9]`. */ name?: string; /** @@ -587,16 +460,11 @@ export namespace bigtableadmin_v2 { */ appProfiles?: Schema$AppProfile[]; /** - * Locations from which AppProfile information could not be retrieved, due - * to an outage or some other transient condition. AppProfiles from these - * locations may be missing from `app_profiles`. Values are of the form - * `projects/<project>/locations/<zone_id>` + * Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from `app_profiles`. Values are of the form `projects/<project>/locations/<zone_id>` */ failedLocations?: string[]; /** - * Set if not all app profiles could be returned in a single response. Pass - * this value to `page_token` in another request to get the next page of - * results. + * Set if not all app profiles could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. */ nextPageToken?: string; } @@ -609,11 +477,7 @@ export namespace bigtableadmin_v2 { */ clusters?: Schema$Cluster[]; /** - * Locations from which Cluster information could not be retrieved, due to - * an outage or some other transient condition. Clusters from these - * locations may be missing from `clusters`, or may only have partial - * information returned. Values are of the form - * `projects/<project>/locations/<zone_id>` + * Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from `clusters`, or may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>` */ failedLocations?: string[]; /** @@ -626,12 +490,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$ListInstancesResponse { /** - * Locations from which Instance information could not be retrieved, due to - * an outage or some other transient condition. Instances whose Clusters are - * all in one of the failed locations may be missing from `instances`, and - * Instances with at least one Cluster in a failed location may only have - * partial information returned. Values are of the form - * `projects/<project>/locations/<zone_id>` + * Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from `instances`, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form `projects/<project>/locations/<zone_id>` */ failedLocations?: string[]; /** @@ -661,8 +520,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$ListTablesResponse { /** - * Set if not all tables could be returned in a single response. Pass this - * value to `page_token` in another request to get the next page of results. + * Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. */ nextPageToken?: string; /** @@ -675,13 +533,11 @@ export namespace bigtableadmin_v2 { */ export interface Schema$Modification { /** - * Create a new column family with the specified schema, or fail if one - * already exists with the given ID. + * Create a new column family with the specified schema, or fail if one already exists with the given ID. */ create?: Schema$ColumnFamily; /** - * Drop (delete) the column family with the given ID, or fail if no such - * family exists. + * Drop (delete) the column family with the given ID, or fail if no such family exists. */ drop?: boolean; /** @@ -689,40 +545,29 @@ export namespace bigtableadmin_v2 { */ id?: string; /** - * Update an existing column family to the specified schema, or fail if no - * column family exists with the given ID. + * Update an existing column family to the specified schema, or fail if no column family exists with the given ID. */ update?: Schema$ColumnFamily; } /** - * Request message for - * google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies + * Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies */ export interface Schema$ModifyColumnFamiliesRequest { /** - * Modifications to be atomically applied to the specified table's - * families. Entries are applied in order, meaning that earlier - * modifications can be masked by later ones (in the case of repeated - * updates to the same family, for example). + * Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). */ modifications?: Schema$Modification[]; } /** - * Read/write requests may be routed to any cluster in the instance, and will - * fail over to another cluster in the event of transient errors or delays. - * Choosing this option sacrifices read-your-writes consistency to improve - * availability. + * Read/write requests may be routed to any cluster in the instance, and will fail over to another cluster in the event of transient errors or delays. Choosing this option sacrifices read-your-writes consistency to improve availability. */ export interface Schema$MultiClusterRoutingUseAny {} /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -730,26 +575,15 @@ export namespace bigtableadmin_v2 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -762,30 +596,12 @@ export namespace bigtableadmin_v2 { */ instance?: Schema$Instance; /** - * The subset of Instance fields which should be replaced. Must be - * explicitly set. + * The subset of Instance fields which should be replaced. Must be explicitly set. */ updateMask?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -793,20 +609,11 @@ export namespace bigtableadmin_v2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -819,30 +626,20 @@ export namespace bigtableadmin_v2 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * Unconditionally routes all read/write requests to a specific cluster. This - * option preserves read-your-writes consistency, but does not improve - * availability. + * Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency, but does not improve availability. */ export interface Schema$SingleClusterRouting { /** - * Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are - * allowed by this app profile. It is unsafe to send these requests to the - * same table/row/column in multiple clusters. + * Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters. */ allowTransactionalWrites?: boolean; /** @@ -860,40 +657,7 @@ export namespace bigtableadmin_v2 { key?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -901,46 +665,32 @@ export namespace bigtableadmin_v2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * A collection of user data indexed by row, column, and timestamp. Each table - * is served using the resources of its parent cluster. + * A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. */ export interface Schema$Table { /** - * Output only. Map from cluster ID to per-cluster table state. If it could - * not be determined whether or not the table has data in a particular - * cluster (for example, if its zone is unavailable), then there will be an - * entry for the cluster with UNKNOWN `replication_status`. Views: - * `REPLICATION_VIEW`, `FULL` + * Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `FULL` */ clusterStates?: {[key: string]: Schema$ClusterState}; /** - * (`CreationOnly`) The column families configured for this table, mapped by - * column family ID. Views: `SCHEMA_VIEW`, `FULL` + * (`CreationOnly`) The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL` */ columnFamilies?: {[key: string]: Schema$ColumnFamily}; /** - * (`CreationOnly`) The granularity (i.e. `MILLIS`) at which timestamps are - * stored in this table. Timestamps not matching the granularity will be - * rejected. If unspecified at creation time, the value will be set to - * `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. + * (`CreationOnly`) The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. */ granularity?: string; /** - * Output only. The unique name of the table. Values are of the form - * `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`. - * Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL` + * Output only. The unique name of the table. Values are of the form `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL` */ name?: string; } @@ -949,9 +699,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$TableProgress { /** - * Estimate of the number of bytes copied so far for this table. This will - * eventually reach 'estimated_size_bytes' unless the table copy is - * CANCELLED. + * Estimate of the number of bytes copied so far for this table. This will eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED. */ estimatedCopiedBytes?: string; /** @@ -965,10 +713,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -977,8 +722,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1021,8 +765,7 @@ export namespace bigtableadmin_v2 { */ finishTime?: string; /** - * The request that prompted the initiation of this UpdateInstance - * operation. + * The request that prompted the initiation of this UpdateInstance operation. */ originalRequest?: Schema$PartialUpdateInstanceRequest; /** @@ -1041,15 +784,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias bigtableadmin.operations.cancel * @memberOf! () * @@ -1119,10 +854,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias bigtableadmin.operations.delete * @memberOf! () * @@ -1192,9 +924,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias bigtableadmin.operations.get * @memberOf! () * @@ -1319,15 +1049,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.operations.projects.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias bigtableadmin.operations.projects.operations.list * @memberOf! () * @@ -1672,8 +1394,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.getIamPolicy - * @desc Gets the access control policy for an instance resource. Returns an - * empty policy if an instance exists but does not have a policy set. + * @desc Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. * @alias bigtableadmin.projects.instances.getIamPolicy * @memberOf! () * @@ -1825,9 +1546,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.partialUpdateInstance - * @desc Partially updates an instance within a project. This method can - * modify all fields of an Instance and is the preferred way to update an - * Instance. + * @desc Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance. * @alias bigtableadmin.projects.instances.partialUpdateInstance * @memberOf! () * @@ -1903,8 +1622,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.setIamPolicy - * @desc Sets the access control policy on an instance resource. Replaces - * any existing policy. + * @desc Sets the access control policy on an instance resource. Replaces any existing policy. * @alias bigtableadmin.projects.instances.setIamPolicy * @memberOf! () * @@ -1978,8 +1696,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.testIamPermissions - * @desc Returns permissions that the caller has on the specified instance - * resource. + * @desc Returns permissions that the caller has on the specified instance resource. * @alias bigtableadmin.projects.instances.testIamPermissions * @memberOf! () * @@ -2062,9 +1779,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.update - * @desc Updates an instance within a project. This method updates only the - * display name and type for an Instance. To update other Instance - * properties, such as labels, use PartialUpdateInstance. + * @desc Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. * @alias bigtableadmin.projects.instances.update * @memberOf! () * @@ -2142,8 +1857,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the project in which to create the new instance. - * Values are of the form `projects/`. + * The unique name of the project in which to create the new instance. Values are of the form `projects/`. */ parent?: string; @@ -2160,8 +1874,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the instance to be deleted. Values are of the form - * `projects//instances/`. + * The unique name of the instance to be deleted. Values are of the form `projects//instances/`. */ name?: string; } @@ -2173,8 +1886,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the requested instance. Values are of the form - * `projects//instances/`. + * The unique name of the requested instance. Values are of the form `projects//instances/`. */ name?: string; } @@ -2186,8 +1898,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2208,8 +1919,7 @@ export namespace bigtableadmin_v2 { */ pageToken?: string; /** - * The unique name of the project for which a list of instances is - * requested. Values are of the form `projects/`. + * The unique name of the project for which a list of instances is requested. Values are of the form `projects/`. */ parent?: string; } @@ -2221,13 +1931,11 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * (`OutputOnly`) The unique name of the instance. Values are of the form - * `projects//instances/a-z+[a-z0-9]`. + * (`OutputOnly`) The unique name of the instance. Values are of the form `projects//instances/a-z+[a-z0-9]`. */ name?: string; /** - * The subset of Instance fields which should be replaced. Must be - * explicitly set. + * The subset of Instance fields which should be replaced. Must be explicitly set. */ updateMask?: string; @@ -2244,8 +1952,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2262,8 +1969,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2280,8 +1986,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * (`OutputOnly`) The unique name of the instance. Values are of the form - * `projects//instances/a-z+[a-z0-9]`. + * (`OutputOnly`) The unique name of the instance. Values are of the form `projects//instances/a-z+[a-z0-9]`. */ name?: string; @@ -2681,9 +2386,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID to be used when referring to the new app profile within its - * instance, e.g., just `myprofile` rather than - * `projects/myproject/instances/myinstance/appProfiles/myprofile`. + * The ID to be used when referring to the new app profile within its instance, e.g., just `myprofile` rather than `projects/myproject/instances/myinstance/appProfiles/myprofile`. */ appProfileId?: string; /** @@ -2691,8 +2394,7 @@ export namespace bigtableadmin_v2 { */ ignoreWarnings?: boolean; /** - * The unique name of the instance in which to create the new app profile. - * Values are of the form `projects//instances/`. + * The unique name of the instance in which to create the new app profile. Values are of the form `projects//instances/`. */ parent?: string; @@ -2713,8 +2415,7 @@ export namespace bigtableadmin_v2 { */ ignoreWarnings?: boolean; /** - * The unique name of the app profile to be deleted. Values are of the form - * `projects//instances//appProfiles/`. + * The unique name of the app profile to be deleted. Values are of the form `projects//instances//appProfiles/`. */ name?: string; } @@ -2726,8 +2427,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the requested app profile. Values are of the form - * `projects//instances//appProfiles/`. + * The unique name of the requested app profile. Values are of the form `projects//instances//appProfiles/`. */ name?: string; } @@ -2747,11 +2447,7 @@ export namespace bigtableadmin_v2 { */ pageToken?: string; /** - * The unique name of the instance for which a list of app profiles is - * requested. Values are of the form - * `projects//instances/`. Use ` = '-'` to list - * AppProfiles for all Instances in a project, e.g., - * `projects/myproject/instances/-`. + * The unique name of the instance for which a list of app profiles is requested. Values are of the form `projects//instances/`. Use ` = '-'` to list AppProfiles for all Instances in a project, e.g., `projects/myproject/instances/-`. */ parent?: string; } @@ -2767,13 +2463,11 @@ export namespace bigtableadmin_v2 { */ ignoreWarnings?: boolean; /** - * (`OutputOnly`) The unique name of the app profile. Values are of the form - * `projects//instances//appProfiles/_a-zA-Z0-9*`. + * (`OutputOnly`) The unique name of the app profile. Values are of the form `projects//instances//appProfiles/_a-zA-Z0-9*`. */ name?: string; /** - * The subset of app profile fields which should be replaced. If unset, all - * fields will be replaced. + * The subset of app profile fields which should be replaced. If unset, all fields will be replaced. */ updateMask?: string; @@ -3166,14 +2860,11 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID to be used when referring to the new cluster within its instance, - * e.g., just `mycluster` rather than - * `projects/myproject/instances/myinstance/clusters/mycluster`. + * The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. */ clusterId?: string; /** - * The unique name of the instance in which to create the new cluster. - * Values are of the form `projects//instances/`. + * The unique name of the instance in which to create the new cluster. Values are of the form `projects//instances/`. */ parent?: string; @@ -3190,8 +2881,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the cluster to be deleted. Values are of the form - * `projects//instances//clusters/`. + * The unique name of the cluster to be deleted. Values are of the form `projects//instances//clusters/`. */ name?: string; } @@ -3203,8 +2893,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the requested cluster. Values are of the form - * `projects//instances//clusters/`. + * The unique name of the requested cluster. Values are of the form `projects//instances//clusters/`. */ name?: string; } @@ -3220,11 +2909,7 @@ export namespace bigtableadmin_v2 { */ pageToken?: string; /** - * The unique name of the instance for which a list of clusters is - * requested. Values are of the form - * `projects//instances/`. Use ` = '-'` to list - * Clusters for all Instances in a project, e.g., - * `projects/myproject/instances/-`. + * The unique name of the instance for which a list of clusters is requested. Values are of the form `projects//instances/`. Use ` = '-'` to list Clusters for all Instances in a project, e.g., `projects/myproject/instances/-`. */ parent?: string; } @@ -3236,8 +2921,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * (`OutputOnly`) The unique name of the cluster. Values are of the form - * `projects//instances//clusters/a-z*`. + * (`OutputOnly`) The unique name of the cluster. Values are of the form `projects//instances//clusters/a-z*`. */ name?: string; @@ -3255,9 +2939,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.checkConsistency - * @desc Checks replication consistency based on a consistency token, that - * is, if replication has caught up based on the conditions specified in the - * token and the check request. + * @desc Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. * @alias bigtableadmin.projects.instances.tables.checkConsistency * @memberOf! () * @@ -3337,9 +3019,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.create - * @desc Creates a new table in the specified instance. The table can be - * created with a full set of initial column families, specified in the - * request. + * @desc Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request. * @alias bigtableadmin.projects.instances.tables.create * @memberOf! () * @@ -3483,9 +3163,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.dropRowRange - * @desc Permanently drop/delete a row range from a specified table. The - * request can specify whether to delete all rows in a table, or only those - * that match a particular prefix. + * @desc Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. * @alias bigtableadmin.projects.instances.tables.dropRowRange * @memberOf! () * @@ -3559,10 +3237,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.generateConsistencyToken - * @desc Generates a consistency token for a Table, which can be used in - * CheckConsistency to check whether mutations to the table that finished - * before this call started have been replicated. The tokens will be - * available for 90 days. + * @desc Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. * @alias bigtableadmin.projects.instances.tables.generateConsistencyToken * @memberOf! () * @@ -3718,8 +3393,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.getIamPolicy - * @desc Gets the access control policy for an instance resource. Returns an - * empty policy if an table exists but does not have a policy set. + * @desc Gets the access control policy for an instance resource. Returns an empty policy if an table exists but does not have a policy set. * @alias bigtableadmin.projects.instances.tables.getIamPolicy * @memberOf! () * @@ -3871,10 +3545,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.modifyColumnFamilies - * @desc Performs a series of column family modifications on the specified - * table. Either all or none of the modifications will occur before this - * method returns, but data requests received prior to that point may see a - * table where only some modifications have taken effect. + * @desc Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect. * @alias bigtableadmin.projects.instances.tables.modifyColumnFamilies * @memberOf! () * @@ -3948,8 +3619,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.setIamPolicy - * @desc Sets the access control policy on a table resource. Replaces any - * existing policy. + * @desc Sets the access control policy on a table resource. Replaces any existing policy. * @alias bigtableadmin.projects.instances.tables.setIamPolicy * @memberOf! () * @@ -4023,8 +3693,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.testIamPermissions - * @desc Returns permissions that the caller has on the specified table - * resource. + * @desc Returns permissions that the caller has on the specified table resource. * @alias bigtableadmin.projects.instances.tables.testIamPermissions * @memberOf! () * @@ -4114,9 +3783,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the Table for which to check replication consistency. - * Values are of the form - * `projects//instances//tables/`. + * The unique name of the Table for which to check replication consistency. Values are of the form `projects//instances//tables/
                          `. */ name?: string; @@ -4133,8 +3800,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the instance in which to create the table. Values are - * of the form `projects//instances/`. + * The unique name of the instance in which to create the table. Values are of the form `projects//instances/`. */ parent?: string; @@ -4151,8 +3817,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the table to be deleted. Values are of the form - * `projects//instances//tables/
                          `. + * The unique name of the table to be deleted. Values are of the form `projects//instances//tables/
                          `. */ name?: string; } @@ -4164,8 +3829,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the table on which to drop a range of rows. Values are - * of the form `projects//instances//tables/
                          `. + * The unique name of the table on which to drop a range of rows. Values are of the form `projects//instances//tables/
                          `. */ name?: string; @@ -4182,9 +3846,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the Table for which to create a consistency token. - * Values are of the form - * `projects//instances//tables/
                          `. + * The unique name of the Table for which to create a consistency token. Values are of the form `projects//instances//tables/
                          `. */ name?: string; @@ -4201,13 +3863,11 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the requested table. Values are of the form - * `projects//instances//tables/
                          `. + * The unique name of the requested table. Values are of the form `projects//instances//tables/
                          `. */ name?: string; /** - * The view to be applied to the returned table's fields. Defaults to - * `SCHEMA_VIEW` if unspecified. + * The view to be applied to the returned table's fields. Defaults to `SCHEMA_VIEW` if unspecified. */ view?: string; } @@ -4219,8 +3879,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4237,12 +3896,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of results per page. A page_size of zero lets the server - * choose the number of items to return. A page_size which is strictly - * positive will return at most that many items. A negative page_size will - * cause an error. Following the first request, subsequent paginated calls - * are not required to pass a page_size. If a page_size is set in subsequent - * calls, it must match the page_size given in the first request. + * Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. */ pageSize?: number; /** @@ -4250,13 +3904,11 @@ export namespace bigtableadmin_v2 { */ pageToken?: string; /** - * The unique name of the instance for which tables should be listed. Values - * are of the form `projects//instances/`. + * The unique name of the instance for which tables should be listed. Values are of the form `projects//instances/`. */ parent?: string; /** - * The view to be applied to the returned tables' fields. Defaults to - * `NAME_ONLY` if unspecified; no others are currently supported. + * The view to be applied to the returned tables' fields. Defaults to `NAME_ONLY` if unspecified; no others are currently supported. */ view?: string; } @@ -4268,8 +3920,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique name of the table whose families should be modified. Values - * are of the form `projects//instances//tables/
                          `. + * The unique name of the table whose families should be modified. Values are of the form `projects//instances//tables/
                          `. */ name?: string; @@ -4286,8 +3937,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4304,8 +3954,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/binaryauthorization/package.json b/src/apis/binaryauthorization/package.json index 01214c751cc..80b4ca480a6 100644 --- a/src/apis/binaryauthorization/package.json +++ b/src/apis/binaryauthorization/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index 707eebe5b4a..c505115100f 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace binaryauthorization_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace binaryauthorization_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace binaryauthorization_v1beta1 { /** * Binary Authorization API * - * The management interface for Binary Authorization, a system providing - * policy control for images deployed to Kubernetes Engine clusters. + * The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters. * * @example * const {google} = require('googleapis'); @@ -113,18 +108,17 @@ export namespace binaryauthorization_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * An admission rule specifies either that all container images used in a pod - * creation request must be attested to by one or more attestors, that all pod - * creations will be allowed, or that all pod creations will be denied. Images - * matching an admission whitelist pattern are exempted from admission rules - * and will never block a pod creation. + * An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission whitelist pattern are exempted from admission rules and will never block a pod creation. */ export interface Schema$AdmissionRule { /** @@ -136,41 +130,29 @@ export namespace binaryauthorization_v1beta1 { */ evaluationMode?: string; /** - * Optional. The resource names of the attestors that must attest to a - * container image, in the format `projects/x/attestors/x. Each attestor - * must exist before a policy can reference it. To add an attestor to a - * policy the principal issuing the policy change request must be able to - * read the attestor resource. Note: this field must be non-empty when the - * evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be - * empty. + * Optional. The resource names of the attestors that must attest to a container image, in the format `projects/x/attestors/x. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. */ requireAttestationsBy?: string[]; } /** - * An admission whitelist pattern exempts images from checks by admission - * rules. + * An admission whitelist pattern exempts images from checks by admission rules. */ export interface Schema$AdmissionWhitelistPattern { /** - * An image name pattern to whitelist, in the form `registry/path/to/image`. - * This supports a trailing `*` as a wildcard, but this is allowed only in - * text after the `registry/` part. + * An image name pattern to whitelist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part. */ namePattern?: string; } /** - * An attestor that attests to container image artifacts. An existing attestor - * cannot be modified except where indicated. + * An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated. */ export interface Schema$Attestor { /** - * Optional. A descriptive comment. This field may be updated. The field - * may be displayed in chooser dialogs. + * Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs. */ description?: string; /** - * Required. The resource name, in the format: `projects/x/attestors/x. This - * field may not be updated. + * Required. The resource name, in the format: `projects/x/attestors/x. This field may not be updated. */ name?: string; /** @@ -183,18 +165,11 @@ export namespace binaryauthorization_v1beta1 { userOwnedDrydockNote?: Schema$UserOwnedDrydockNote; } /** - * An attestor public key that will be used to verify attestations signed by - * this attestor. + * An attestor public key that will be used to verify attestations signed by this attestor. */ export interface Schema$AttestorPublicKey { /** - * ASCII-armored representation of a PGP public key, as the entire output by - * the command `gpg --export --armor foo@example.com` (either LF or CRLF - * line endings). When using this field, `id` should be left blank. The - * BinAuthz API handlers will calculate the ID and fill it in automatically. - * BinAuthz computes this ID as the OpenPGP RFC4880 V4 fingerprint, - * represented as upper-case hex. If `id` is provided by the caller, it - * will be overwritten by the API-calculated ID. + * ASCII-armored representation of a PGP public key, as the entire output by the command `gpg --export --armor foo@example.com` (either LF or CRLF line endings). When using this field, `id` should be left blank. The BinAuthz API handlers will calculate the ID and fill it in automatically. BinAuthz computes this ID as the OpenPGP RFC4880 V4 fingerprint, represented as upper-case hex. If `id` is provided by the caller, it will be overwritten by the API-calculated ID. */ asciiArmoredPgpPublicKey?: string; /** @@ -202,18 +177,11 @@ export namespace binaryauthorization_v1beta1 { */ comment?: string; /** - * The ID of this public key. Signatures verified by BinAuthz must include - * the ID of the public key that can be used to verify them, and that ID - * must match the contents of this field exactly. Additional restrictions on - * this field can be imposed based on which public key type is encapsulated. - * See the documentation on `public_key` cases below for details. + * The ID of this public key. Signatures verified by BinAuthz must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. Additional restrictions on this field can be imposed based on which public key type is encapsulated. See the documentation on `public_key` cases below for details. */ id?: string; /** - * A raw PKIX SubjectPublicKeyInfo format public key. NOTE: `id` may be - * explicitly provided by the caller when using this type of public key, but - * it MUST be a valid RFC3986 URI. If `id` is left blank, a default one will - * be computed based on the digest of the DER encoding of the public key. + * A raw PKIX SubjectPublicKeyInfo format public key. NOTE: `id` may be explicitly provided by the caller when using this type of public key, but it MUST be a valid RFC3986 URI. If `id` is left blank, a default one will be computed based on the digest of the DER encoding of the public key. */ pkixPublicKey?: Schema$PkixPublicKey; } @@ -222,106 +190,53 @@ export namespace binaryauthorization_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$IamPolicy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -338,28 +253,20 @@ export namespace binaryauthorization_v1beta1 { */ attestors?: Schema$Attestor[]; /** - * A token to retrieve the next page of results. Pass this value in the - * ListAttestorsRequest.page_token field in the subsequent call to the - * `ListAttestors` method to retrieve the next page of results. + * A token to retrieve the next page of results. Pass this value in the ListAttestorsRequest.page_token field in the subsequent call to the `ListAttestors` method to retrieve the next page of results. */ nextPageToken?: string; } /** - * A public key in the PkixPublicKey format (see - * https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public - * keys of this type are typically textually encoded using the PEM format. + * A public key in the PkixPublicKey format (see https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public keys of this type are typically textually encoded using the PEM format. */ export interface Schema$PkixPublicKey { /** - * A PEM-encoded public key, as described in - * https://tools.ietf.org/html/rfc7468#section-13 + * A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13 */ publicKeyPem?: string; /** - * The signature algorithm used to verify a message against a signature - * using this key. These signature algorithm must match the structure and - * any object identifiers encoded in `public_key_pem` (i.e. this algorithm - * must match that of the public key). + * The signature algorithm used to verify a message against a signature using this key. These signature algorithm must match the structure and any object identifiers encoded in `public_key_pem` (i.e. this algorithm must match that of the public key). */ signatureAlgorithm?: string; } @@ -368,24 +275,15 @@ export namespace binaryauthorization_v1beta1 { */ export interface Schema$Policy { /** - * Optional. Admission policy whitelisting. A matching admission request - * will always be permitted. This feature is typically used to exclude - * Google or third-party infrastructure images from Binary Authorization - * policies. + * Optional. Admission policy whitelisting. A matching admission request will always be permitted. This feature is typically used to exclude Google or third-party infrastructure images from Binary Authorization policies. */ admissionWhitelistPatterns?: Schema$AdmissionWhitelistPattern[]; /** - * Optional. Per-cluster admission rules. Cluster spec format: - * `location.clusterId`. There can be at most one admission rule per cluster - * spec. A `location` is either a compute zone (e.g. us-central1-a) or a - * region (e.g. us-central1). For `clusterId` syntax restrictions see - * https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters. + * Optional. Per-cluster admission rules. Cluster spec format: `location.clusterId`. There can be at most one admission rule per cluster spec. A `location` is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). For `clusterId` syntax restrictions see https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters. */ clusterAdmissionRules?: {[key: string]: Schema$AdmissionRule}; /** - * Required. Default admission rule for a cluster without a per-cluster, - * per- kubernetes-service-account, or per-istio-service-identity admission - * rule. + * Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule. */ defaultAdmissionRule?: Schema$AdmissionRule; /** @@ -393,15 +291,11 @@ export namespace binaryauthorization_v1beta1 { */ description?: string; /** - * Optional. Controls the evaluation of a Google-maintained global admission - * policy for common system-level images. Images not covered by the global - * policy will be subject to the project admission policy. This setting has - * no effect when specified inside a global admission policy. + * Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy. */ globalPolicyEvaluationMode?: string; /** - * Output only. The resource name, in the format `projects/x/policy`. There - * is at most one policy per project. + * Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project. */ name?: string; /** @@ -414,10 +308,7 @@ export namespace binaryauthorization_v1beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$IamPolicy; } @@ -426,10 +317,7 @@ export namespace binaryauthorization_v1beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -438,42 +326,24 @@ export namespace binaryauthorization_v1beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * An user owned drydock note references a Drydock ATTESTATION_AUTHORITY Note - * created by the user. + * An user owned drydock note references a Drydock ATTESTATION_AUTHORITY Note created by the user. */ export interface Schema$UserOwnedDrydockNote { /** - * Output only. This field will contain the service account email address - * that this Attestor will use as the principal when querying Container - * Analysis. Attestor administrators must grant this service account the IAM - * role needed to read attestations from the note_reference in Container - * Analysis (`containeranalysis.notes.occurrences.viewer`). This email - * address is fixed for the lifetime of the Attestor, but callers should not - * make any other assumptions about the service account email; future - * versions may use an email based on a different naming pattern. + * Output only. This field will contain the service account email address that this Attestor will use as the principal when querying Container Analysis. Attestor administrators must grant this service account the IAM role needed to read attestations from the note_reference in Container Analysis (`containeranalysis.notes.occurrences.viewer`). This email address is fixed for the lifetime of the Attestor, but callers should not make any other assumptions about the service account email; future versions may use an email based on a different naming pattern. */ delegationServiceAccountEmail?: string; /** - * Required. The Drydock resource name of a ATTESTATION_AUTHORITY Note, - * created by the user, in the format: `projects/x/notes/x (or the legacy - * `providers/x/notes/x). This field may not be updated. An attestation by - * this attestor is stored as a Drydock ATTESTATION_AUTHORITY Occurrence - * that names a container image and that links to this Note. Drydock is an - * external dependency. + * Required. The Drydock resource name of a ATTESTATION_AUTHORITY Note, created by the user, in the format: `projects/x/notes/x (or the legacy `providers/x/notes/x). This field may not be updated. An attestation by this attestor is stored as a Drydock ATTESTATION_AUTHORITY Occurrence that names a container image and that links to this Note. Drydock is an external dependency. */ noteReference?: string; /** - * Optional. Public keys that verify attestations signed by this attestor. - * This field may be updated. If this field is non-empty, one of the - * specified public keys must verify that an attestation was signed by this - * attestor for the image specified in the admission request. If this field - * is empty, this attestor always returns that no valid attestations exist. + * Optional. Public keys that verify attestations signed by this attestor. This field may be updated. If this field is non-empty, one of the specified public keys must verify that an attestation was signed by this attestor for the image specified in the admission request. If this field is empty, this attestor always returns that no valid attestations exist. */ publicKeys?: Schema$AttestorPublicKey[]; } @@ -490,8 +360,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.getPolicy - * @desc Gets the policy for this project. Returns a default policy if the - * project does not have one. + * @desc Gets the policy for this project. Returns a default policy if the project does not have one. * @alias binaryauthorization.projects.getPolicy * @memberOf! () * @@ -561,11 +430,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.updatePolicy - * @desc Creates or updates a project's policy, and returns a copy of the - * new policy. A policy is always updated as a whole, to avoid race - * conditions with concurrent policy enforcement (or management!) requests. - * Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the - * request is malformed. + * @desc Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed. * @alias binaryauthorization.projects.updatePolicy * @memberOf! () * @@ -643,8 +508,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the policy to retrieve, in the format - * `projects/x/policy`. + * Required. The resource name of the policy to retrieve, in the format `projects/x/policy`. */ name?: string; } @@ -656,8 +520,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name, in the format `projects/x/policy`. There - * is at most one policy per project. + * Output only. The resource name, in the format `projects/x/policy`. There is at most one policy per project. */ name?: string; @@ -675,9 +538,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.create - * @desc Creates an attestor, and returns a copy of the new attestor. - * Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the - * request is malformed, ALREADY_EXISTS if the attestor already exists. + * @desc Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists. * @alias binaryauthorization.projects.attestors.create * @memberOf! () * @@ -752,8 +613,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.delete - * @desc Deletes an attestor. Returns NOT_FOUND if the attestor does not - * exist. + * @desc Deletes an attestor. Returns NOT_FOUND if the attestor does not exist. * @alias binaryauthorization.projects.attestors.delete * @memberOf! () * @@ -893,8 +753,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias binaryauthorization.projects.attestors.getIamPolicy * @memberOf! () * @@ -969,8 +828,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.list - * @desc Lists attestors. Returns INVALID_ARGUMENT if the project does not - * exist. + * @desc Lists attestors. Returns INVALID_ARGUMENT if the project does not exist. * @alias binaryauthorization.projects.attestors.list * @memberOf! () * @@ -1049,8 +907,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias binaryauthorization.projects.attestors.setIamPolicy * @memberOf! () * @@ -1126,11 +983,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias binaryauthorization.projects.attestors.testIamPermissions * @memberOf! () * @@ -1213,8 +1066,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.update - * @desc Updates an attestor. Returns NOT_FOUND if the attestor does not - * exist. + * @desc Updates an attestor. Returns NOT_FOUND if the attestor does not exist. * @alias binaryauthorization.projects.attestors.update * @memberOf! () * @@ -1313,8 +1165,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the attestors to delete, in the format - * `projects/x/attestors/x`. + * Required. The name of the attestors to delete, in the format `projects/x/attestors/x`. */ name?: string; } @@ -1326,8 +1177,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the attestor to retrieve, in the format - * `projects/x/attestors/x`. + * Required. The name of the attestor to retrieve, in the format `projects/x/attestors/x`. */ name?: string; } @@ -1339,8 +1189,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1352,19 +1201,15 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. The server may return fewer results than requested. - * If unspecified, the server will pick an appropriate default. + * Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListAttestorsResponse.next_page_token - * returned from the previous call to the `ListAttestors` method. + * A token identifying a page of results the server should return. Typically, this is the value of ListAttestorsResponse.next_page_token returned from the previous call to the `ListAttestors` method. */ pageToken?: string; /** - * Required. The resource name of the project associated with the attestors, - * in the format `projects/x`. + * Required. The resource name of the project associated with the attestors, in the format `projects/x`. */ parent?: string; } @@ -1376,8 +1221,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1394,8 +1238,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1412,8 +1255,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name, in the format: `projects/x/attestors/x`. - * This field may not be updated. + * Required. The resource name, in the format: `projects/x/attestors/x`. This field may not be updated. */ name?: string; @@ -1431,8 +1273,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.policy.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias binaryauthorization.projects.policy.getIamPolicy * @memberOf! () * @@ -1507,8 +1348,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.policy.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias binaryauthorization.projects.policy.setIamPolicy * @memberOf! () * @@ -1584,11 +1424,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.policy.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias binaryauthorization.projects.policy.testIamPermissions * @memberOf! () * @@ -1678,8 +1514,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1691,8 +1526,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1709,8 +1543,7 @@ export namespace binaryauthorization_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/blogger/package.json b/src/apis/blogger/package.json index 38d71716e76..50d1fc8f01f 100644 --- a/src/apis/blogger/package.json +++ b/src/apis/blogger/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts index 932cb10827b..e6b99e2974b 100644 --- a/src/apis/blogger/v2.ts +++ b/src/apis/blogger/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace blogger_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace blogger_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -99,7 +96,10 @@ export namespace blogger_v2 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.blogs = new Resource$Blogs(this.context); this.comments = new Resource$Comments(this.context); @@ -265,8 +265,7 @@ export namespace blogger_v2 { */ selfLink?: string; /** - * The title of this entity. This is the name displayed in the Admin user - * interface. + * The title of this entity. This is the name displayed in the Admin user interface. */ title?: string; /** @@ -1252,8 +1251,7 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the user whose blogs are to be fetched. Either the word 'self' - * (sans quote marks) or the user's profile identifier. + * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. */ userId?: string; } diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts index c83847fa92f..9df8e66368e 100644 --- a/src/apis/blogger/v3.ts +++ b/src/apis/blogger/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace blogger_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace blogger_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -102,7 +99,10 @@ export namespace blogger_v3 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.blogs = new Resource$Blogs(this.context); this.blogUserInfos = new Resource$Bloguserinfos(this.context); @@ -201,8 +201,7 @@ export namespace blogger_v3 { */ photosAlbumKey?: string; /** - * Access permissions that the user has for the blog (ADMIN, AUTHOR, or - * READER). + * Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). */ role?: string; /** @@ -340,8 +339,7 @@ export namespace blogger_v3 { */ status?: string; /** - * The title of this entity. This is the name displayed in the Admin user - * interface. + * The title of this entity. This is the name displayed in the Admin user interface. */ title?: string; /** @@ -821,8 +819,7 @@ export namespace blogger_v3 { */ maxPosts?: number; /** - * Access level with which to view the blog. Note that some fields require - * elevated access. + * Access level with which to view the blog. Note that some fields require elevated access. */ view?: string; } @@ -837,8 +834,7 @@ export namespace blogger_v3 { */ url?: string; /** - * Access level with which to view the blog. Note that some fields require - * elevated access. + * Access level with which to view the blog. Note that some fields require elevated access. */ view?: string; } @@ -849,29 +845,23 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the response is a list of blogs with per-user information instead - * of just blogs. + * Whether the response is a list of blogs with per-user information instead of just blogs. */ fetchUserInfo?: boolean; /** - * User access types for blogs to include in the results, e.g. AUTHOR will - * return blogs where the user has author level access. If no roles are - * specified, defaults to ADMIN and AUTHOR roles. + * User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. */ role?: string[]; /** - * Blog statuses to include in the result (default: Live blogs only). Note - * that ADMIN access is required to view deleted blogs. + * Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. */ status?: string[]; /** - * ID of the user whose blogs are to be fetched. Either the word 'self' - * (sans quote marks) or the user's profile identifier. + * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. */ userId?: string; /** - * Access level with which to view the blogs. Note that some fields require - * elevated access. + * Access level with which to view the blogs. Note that some fields require elevated access. */ view?: string; } @@ -974,8 +964,7 @@ export namespace blogger_v3 { */ maxPosts?: number; /** - * ID of the user whose blogs are to be fetched. Either the word 'self' - * (sans quote marks) or the user's profile identifier. + * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. */ userId?: string; } @@ -1288,8 +1277,7 @@ export namespace blogger_v3 { /** * blogger.comments.listByBlog - * @desc Retrieves the comments for a blog, across all posts, possibly - * filtered. + * @desc Retrieves the comments for a blog, across all posts, possibly filtered. * @alias blogger.comments.listByBlog * @memberOf! () * @@ -1573,10 +1561,7 @@ export namespace blogger_v3 { */ postId?: string; /** - * Access level for the requested comment (default: READER). Note that some - * comments will require elevated permissions, for example comments where - * the parent posts which is in a draft state, or comments that are pending - * moderation. + * Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation. */ view?: string; } @@ -1619,8 +1604,7 @@ export namespace blogger_v3 { */ status?: string[]; /** - * Access level with which to view the returned result. Note that some - * fields require elevated access. + * Access level with which to view the returned result. Note that some fields require elevated access. */ view?: string; } @@ -1925,8 +1909,7 @@ export namespace blogger_v3 { /** * blogger.pages.list - * @desc Retrieves the pages for a blog, optionally including non-LIVE - * statuses. + * @desc Retrieves the pages for a blog, optionally including non-LIVE statuses. * @alias blogger.pages.list * @memberOf! () * @@ -2372,8 +2355,7 @@ export namespace blogger_v3 { */ status?: string[]; /** - * Access level with which to view the returned result. Note that some - * fields require elevated access. + * Access level with which to view the returned result. Note that some fields require elevated access. */ view?: string; } @@ -2392,13 +2374,11 @@ export namespace blogger_v3 { */ pageId?: string; /** - * Whether a publish action should be performed when the page is updated - * (default: false). + * Whether a publish action should be performed when the page is updated (default: false). */ publish?: boolean; /** - * Whether a revert action should be performed when the page is updated - * (default: false). + * Whether a revert action should be performed when the page is updated (default: false). */ revert?: boolean; @@ -2452,13 +2432,11 @@ export namespace blogger_v3 { */ pageId?: string; /** - * Whether a publish action should be performed when the page is updated - * (default: false). + * Whether a publish action should be performed when the page is updated (default: false). */ publish?: boolean; /** - * Whether a revert action should be performed when the page is updated - * (default: false). + * Whether a revert action should be performed when the page is updated (default: false). */ revert?: boolean; @@ -3026,8 +3004,7 @@ export namespace blogger_v3 { /** * blogger.posts.publish - * @desc Publishes a draft post, optionally at the specific time of the - * given publishDate parameter. + * @desc Publishes a draft post, optionally at the specific time of the given publishDate parameter. * @alias blogger.posts.publish * @memberOf! () * @@ -3346,9 +3323,7 @@ export namespace blogger_v3 { */ blogId?: string; /** - * Whether the body content of the post is included (default: true). This - * should be set to false when the post bodies are not required, to help - * minimize traffic. + * Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. */ fetchBody?: boolean; /** @@ -3364,8 +3339,7 @@ export namespace blogger_v3 { */ postId?: string; /** - * Access level with which to view the returned result. Note that some - * fields require elevated access. + * Access level with which to view the returned result. Note that some fields require elevated access. */ view?: string; } @@ -3388,8 +3362,7 @@ export namespace blogger_v3 { */ path?: string; /** - * Access level with which to view the returned result. Note that some - * fields require elevated access. + * Access level with which to view the returned result. Note that some fields require elevated access. */ view?: string; } @@ -3404,13 +3377,11 @@ export namespace blogger_v3 { */ blogId?: string; /** - * Whether the body content of the post is included with the result - * (default: true). + * Whether the body content of the post is included with the result (default: true). */ fetchBody?: boolean; /** - * Whether image URL metadata for each post is included in the returned - * result (default: false). + * Whether image URL metadata for each post is included in the returned result (default: false). */ fetchImages?: boolean; /** @@ -3438,9 +3409,7 @@ export namespace blogger_v3 { */ endDate?: string; /** - * Whether the body content of posts is included (default: true). This - * should be set to false when the post bodies are not required, to help - * minimize traffic. + * Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. */ fetchBodies?: boolean; /** @@ -3472,8 +3441,7 @@ export namespace blogger_v3 { */ status?: string[]; /** - * Access level with which to view the returned result. Note that some - * fields require escalated access. + * Access level with which to view the returned result. Note that some fields require escalated access. */ view?: string; } @@ -3488,13 +3456,11 @@ export namespace blogger_v3 { */ blogId?: string; /** - * Whether the body content of the post is included with the result - * (default: true). + * Whether the body content of the post is included with the result (default: true). */ fetchBody?: boolean; /** - * Whether image URL metadata for each post is included in the returned - * result (default: false). + * Whether image URL metadata for each post is included in the returned result (default: false). */ fetchImages?: boolean; /** @@ -3506,13 +3472,11 @@ export namespace blogger_v3 { */ postId?: string; /** - * Whether a publish action should be performed when the post is updated - * (default: false). + * Whether a publish action should be performed when the post is updated (default: false). */ publish?: boolean; /** - * Whether a revert action should be performed when the post is updated - * (default: false). + * Whether a revert action should be performed when the post is updated (default: false). */ revert?: boolean; @@ -3536,10 +3500,7 @@ export namespace blogger_v3 { */ postId?: string; /** - * Optional date and time to schedule the publishing of the Blog. If no - * publishDate parameter is given, the post is either published at the a - * previously saved schedule date (if present), or the current time. If a - * future date is given, the post will be scheduled to be published. + * Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published. */ publishDate?: string; } @@ -3569,9 +3530,7 @@ export namespace blogger_v3 { */ blogId?: string; /** - * Whether the body content of posts is included (default: true). This - * should be set to false when the post bodies are not required, to help - * minimize traffic. + * Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. */ fetchBodies?: boolean; /** @@ -3594,13 +3553,11 @@ export namespace blogger_v3 { */ blogId?: string; /** - * Whether the body content of the post is included with the result - * (default: true). + * Whether the body content of the post is included with the result (default: true). */ fetchBody?: boolean; /** - * Whether image URL metadata for each post is included in the returned - * result (default: false). + * Whether image URL metadata for each post is included in the returned result (default: false). */ fetchImages?: boolean; /** @@ -3612,13 +3569,11 @@ export namespace blogger_v3 { */ postId?: string; /** - * Whether a publish action should be performed when the post is updated - * (default: false). + * Whether a publish action should be performed when the post is updated (default: false). */ publish?: boolean; /** - * Whether a revert action should be performed when the post is updated - * (default: false). + * Whether a revert action should be performed when the post is updated (default: false). */ revert?: boolean; @@ -3636,9 +3591,7 @@ export namespace blogger_v3 { /** * blogger.postUserInfos.get - * @desc Gets one post and user info pair, by post ID and user ID. The post - * user info contains per-user information about the post, such as access - * rights, specific to the user. + * @desc Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user. * @alias blogger.postUserInfos.get * @memberOf! () * @@ -3715,9 +3668,7 @@ export namespace blogger_v3 { /** * blogger.postUserInfos.list - * @desc Retrieves a list of post and post user info pairs, possibly - * filtered. The post user info contains per-user information about the - * post, such as access rights, specific to the user. + * @desc Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user. * @alias blogger.postUserInfos.list * @memberOf! () * @@ -3819,8 +3770,7 @@ export namespace blogger_v3 { */ postId?: string; /** - * ID of the user for the per-user information to be fetched. Either the - * word 'self' (sans quote marks) or the user's profile identifier. + * ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. */ userId?: string; } @@ -3868,13 +3818,11 @@ export namespace blogger_v3 { */ status?: string[]; /** - * ID of the user for the per-user information to be fetched. Either the - * word 'self' (sans quote marks) or the user's profile identifier. + * ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. */ userId?: string; /** - * Access level with which to view the returned result. Note that some - * fields require elevated access. + * Access level with which to view the returned result. Note that some fields require elevated access. */ view?: string; } diff --git a/src/apis/books/package.json b/src/apis/books/package.json index 5e0749d8f76..81de9631269 100644 --- a/src/apis/books/package.json +++ b/src/apis/books/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts index 0b40783e814..665043363e6 100644 --- a/src/apis/books/v1.ts +++ b/src/apis/books/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace books_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace books_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -107,7 +104,10 @@ export namespace books_v1 { volumes: Resource$Volumes; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.bookshelves = new Resource$Bookshelves(this.context); this.cloudloading = new Resource$Cloudloading(this.context); @@ -127,13 +127,11 @@ export namespace books_v1 { export interface Schema$Annotation { /** - * Anchor text after excerpt. For requests, if the user bookmarked a screen - * that has no flowing text on it, then this field should be empty. + * Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. */ afterSelectedText?: string; /** - * Anchor text before excerpt. For requests, if the user bookmarked a screen - * that has no flowing text on it, then this field should be empty. + * Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. */ beforeSelectedText?: string; /** @@ -237,8 +235,7 @@ export namespace books_v1 { */ selfLink?: string; /** - * Timestamp for the last time this data was updated. (RFC 3339 UTC - * date-time format). + * Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). */ updated?: string; /** @@ -256,13 +253,11 @@ export namespace books_v1 { */ kind?: string; /** - * Token to pass in for pagination for the next page. This will not be - * present if this request does not have more results. + * Token to pass in for pagination for the next page. This will not be present if this request does not have more results. */ nextPageToken?: string; /** - * Total number of annotations found. This may be greater than the number of - * notes returned in this response if results have been paginated. + * Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated. */ totalItems?: number; } @@ -276,8 +271,7 @@ export namespace books_v1 { */ kind?: string; /** - * Token to pass in for pagination for the next page. This will not be - * present if this request does not have more results. + * Token to pass in for pagination for the next page. This will not be present if this request does not have more results. */ nextPageToken?: string; /** @@ -325,8 +319,7 @@ export namespace books_v1 { */ access?: string; /** - * Created time for this bookshelf (formatted UTC timestamp with millisecond - * resolution). + * Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). */ created?: string; /** @@ -350,8 +343,7 @@ export namespace books_v1 { */ title?: string; /** - * Last modified time of this bookshelf (formatted UTC timestamp with - * millisecond resolution). + * Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). */ updated?: string; /** @@ -359,8 +351,7 @@ export namespace books_v1 { */ volumeCount?: number; /** - * Last time a volume was added or removed from this bookshelf (formatted - * UTC timestamp with millisecond resolution). + * Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). */ volumesLastUpdated?: string; } @@ -405,8 +396,7 @@ export namespace books_v1 { */ message?: string; /** - * Client nonce for verification. Download access and client-validation - * only. + * Client nonce for verification. Download access and client-validation only. */ nonce?: string; /** @@ -422,8 +412,7 @@ export namespace books_v1 { */ signature?: string; /** - * Client app identifier for verification. Download access and - * client-validation only. + * Client app identifier for verification. Download access and client-validation only. */ source?: string; /** @@ -510,8 +499,7 @@ export namespace books_v1 { */ deviceAllowed?: boolean; /** - * If restricted, the number of content download licenses already acquired - * (including the requesting client, if licensed). + * If restricted, the number of content download licenses already acquired (including the requesting client, if licensed). */ downloadsAcquired?: number; /** @@ -523,8 +511,7 @@ export namespace books_v1 { */ kind?: string; /** - * If restricted, the maximum number of content download licenses for this - * volume. + * If restricted, the maximum number of content download licenses for this volume. */ maxDownloadDevices?: number; /** @@ -532,14 +519,11 @@ export namespace books_v1 { */ message?: string; /** - * Client nonce for verification. Download access and client-validation - * only. + * Client nonce for verification. Download access and client-validation only. */ nonce?: string; /** - * Error/warning reason code. Additional codes may be added in the future. 0 - * OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 - * WARNING_USED_LAST_ACCESS + * Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS */ reasonCode?: string; /** @@ -551,8 +535,7 @@ export namespace books_v1 { */ signature?: string; /** - * Client app identifier for verification. Download access and - * client-validation only. + * Client app identifier for verification. Download access and client-validation only. */ source?: string; /** @@ -655,15 +638,11 @@ export namespace books_v1 { */ selfLink?: string; /** - * Timestamp for the last time an item in this layer was updated. (RFC 3339 - * UTC date-time format). + * Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format). */ updated?: string; /** - * The current version of this layer's volume annotations. Note that - * this version applies only to the data in the - * books.layers.volumeAnnotations.* responses. The actual annotation data is - * versioned separately. + * The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately. */ volumeAnnotationsVersion?: string; /** @@ -755,8 +734,7 @@ export namespace books_v1 { */ pdfPosition?: string; /** - * Timestamp when this reading position was last updated (formatted UTC - * timestamp with millisecond resolution). + * Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution). */ updated?: string; /** @@ -800,13 +778,11 @@ export namespace books_v1 { */ kind?: string; /** - * Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, - * FIVE or NOT_RATED. + * Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. */ rating?: string; /** - * Information regarding the source of this review, when the review is not - * from a Google Books user. + * Information regarding the source of this review, when the review is not from a Google Books user. */ source?: {description?: string; extraDescription?: string; url?: string}; /** @@ -814,8 +790,7 @@ export namespace books_v1 { */ title?: string; /** - * Source type for this review. Possible values are EDITORIAL, WEB_USER or - * GOOGLE_USER. + * Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. */ type?: string; /** @@ -863,9 +838,7 @@ export namespace books_v1 { } export interface Schema$Volume { /** - * Any information about a volume related to reading or obtaining that - * volume text. This information can depend on country (books may be public - * domain in one country but not in another, e.g.). + * Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.). */ accessInfo?: { accessViewStatus?: string; @@ -892,8 +865,7 @@ export namespace books_v1 { webReaderLink?: string; }; /** - * Opaque identifier for a specific version of a volume resource. (In LITE - * projection) + * Opaque identifier for a specific version of a volume resource. (In LITE projection) */ etag?: string; /** @@ -915,10 +887,7 @@ export namespace books_v1 { */ recommendedInfo?: {explanation?: string}; /** - * Any information about a volume related to the eBookstore and/or - * purchaseability. This information can depend on the country where the - * request originates from (i.e. books may not be for sale in certain - * countries). + * Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries). */ saleInfo?: { buyLink?: string; @@ -945,8 +914,7 @@ export namespace books_v1 { */ selfLink?: string; /** - * User specific information related to this volume. (e.g. page this user - * last read or whether they purchased this book) + * User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) */ userInfo?: { acquiredTime?: string; @@ -1090,8 +1058,7 @@ export namespace books_v1 { */ selfLink?: string; /** - * Timestamp for the last time this anntoation was updated. (RFC 3339 UTC - * date-time format). + * Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). */ updated?: string; /** @@ -1109,8 +1076,7 @@ export namespace books_v1 { */ kind?: string; /** - * Token to pass in for pagination for the next page. This will not be - * present if this request does not have more results. + * Token to pass in for pagination for the next page. This will not be present if this request does not have more results. */ nextPageToken?: string; /** @@ -1118,10 +1084,7 @@ export namespace books_v1 { */ totalItems?: number; /** - * The version string for all of the volume annotations in this layer (not - * just the ones in this response). Note: the version string doesn't - * apply to the annotation data, just the information in this response (e.g. - * the location of annotations in the book). + * The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book). */ version?: string; } @@ -1135,15 +1098,13 @@ export namespace books_v1 { */ kind?: string; /** - * Total number of volumes found. This might be greater than the number of - * volumes returned in this response if results have been paginated. + * Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. */ totalItems?: number; } export interface Schema$Volumeseriesinfo { /** - * The display number string. This should be used only for display purposes - * and the actual sequence should be inferred from the below orderNumber. + * The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. */ bookDisplayNumber?: string; /** @@ -1724,8 +1685,7 @@ export namespace books_v1 { */ drive_document_id?: string; /** - * The document MIME type. It can be set only if the drive_document_id is - * set. + * The document MIME type. It can be set only if the drive_document_id is set. */ mime_type?: string; /** @@ -1936,8 +1896,7 @@ export namespace books_v1 { /** * books.familysharing.share - * @desc Initiates sharing of the content with the user's family. Empty - * response indicates success. + * @desc Initiates sharing of the content with the user's family. Empty response indicates success. * @alias books.familysharing.share * @memberOf! () * @@ -2011,8 +1970,7 @@ export namespace books_v1 { /** * books.familysharing.unshare - * @desc Initiates revoking content that has already been shared with the - * user's family. Empty response indicates success. + * @desc Initiates revoking content that has already been shared with the user's family. Empty response indicates success. * @alias books.familysharing.unshare * @memberOf! () * @@ -2553,8 +2511,7 @@ export namespace books_v1 { */ contentVersion?: string; /** - * The requested pixel height for any images. If height is provided width - * must also be provided. + * The requested pixel height for any images. If height is provided width must also be provided. */ h?: number; /** @@ -2562,8 +2519,7 @@ export namespace books_v1 { */ layerId?: string; /** - * The locale information for the data. ISO-639-1 language and ISO-3166-1 - * country code. Ex: 'en_US'. + * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. */ locale?: string; /** @@ -2579,8 +2535,7 @@ export namespace books_v1 { */ volumeId?: string; /** - * The requested pixel width for any images. If width is provided height - * must also be provided. + * The requested pixel width for any images. If width is provided height must also be provided. */ w?: number; } @@ -2592,8 +2547,7 @@ export namespace books_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The list of Annotation Data Ids to retrieve. Pagination is ignored if - * this is set. + * The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. */ annotationDataId?: string[]; /** @@ -2601,8 +2555,7 @@ export namespace books_v1 { */ contentVersion?: string; /** - * The requested pixel height for any images. If height is provided width - * must also be provided. + * The requested pixel height for any images. If height is provided width must also be provided. */ h?: number; /** @@ -2610,8 +2563,7 @@ export namespace books_v1 { */ layerId?: string; /** - * The locale information for the data. ISO-639-1 language and ISO-3166-1 - * country code. Ex: 'en_US'. + * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. */ locale?: string; /** @@ -2631,13 +2583,11 @@ export namespace books_v1 { */ source?: string; /** - * RFC 3339 timestamp to restrict to items updated prior to this timestamp - * (exclusive). + * RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). */ updatedMax?: string; /** - * RFC 3339 timestamp to restrict to items updated since this timestamp - * (inclusive). + * RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). */ updatedMin?: string; /** @@ -2645,8 +2595,7 @@ export namespace books_v1 { */ volumeId?: string; /** - * The requested pixel width for any images. If width is provided height - * must also be provided. + * The requested pixel width for any images. If width is provided height must also be provided. */ w?: number; } @@ -2839,8 +2788,7 @@ export namespace books_v1 { */ layerId?: string; /** - * The locale information for the data. ISO-639-1 language and ISO-3166-1 - * country code. Ex: 'en_US'. + * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. */ locale?: string; /** @@ -2876,8 +2824,7 @@ export namespace books_v1 { */ layerId?: string; /** - * The locale information for the data. ISO-639-1 language and ISO-3166-1 - * country code. Ex: 'en_US'. + * The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. */ locale?: string; /** @@ -2889,8 +2836,7 @@ export namespace books_v1 { */ pageToken?: string; /** - * Set to true to return deleted annotations. updatedMin must be in the - * request to use this. Defaults to false. + * Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. */ showDeleted?: boolean; /** @@ -2906,13 +2852,11 @@ export namespace books_v1 { */ startPosition?: string; /** - * RFC 3339 timestamp to restrict to items updated prior to this timestamp - * (exclusive). + * RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). */ updatedMax?: string; /** - * RFC 3339 timestamp to restrict to items updated since this timestamp - * (inclusive). + * RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). */ updatedMin?: string; /** @@ -3164,8 +3108,7 @@ export namespace books_v1 { /** * books.myconfig.syncVolumeLicenses - * @desc Request downloaded content access for specified volumes on the My - * eBooks shelf. + * @desc Request downloaded content access for specified volumes on the My eBooks shelf. * @alias books.myconfig.syncVolumeLicenses * @memberOf! () * @@ -3244,9 +3187,7 @@ export namespace books_v1 { /** * books.myconfig.updateUserSettings - * @desc Sets the settings for the user. If a sub-object is specified, it - * will overwrite the existing sub-object stored in the server. Unspecified - * sub-objects will retain the existing value. + * @desc Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value. * @alias books.myconfig.updateUserSettings * @memberOf! () * @@ -3364,8 +3305,7 @@ export namespace books_v1 { */ cpksver?: string; /** - * The type of access license to request. If not specified, the default is - * BOTH. + * The type of access license to request. If not specified, the default is BOTH. */ licenseTypes?: string; /** @@ -3875,8 +3815,7 @@ export namespace books_v1 { */ country?: string; /** - * Requests that only the summary of the specified layer be provided in the - * response. + * Requests that only the summary of the specified layer be provided in the response. */ showOnlySummaryInResponse?: boolean; /** @@ -3917,8 +3856,7 @@ export namespace books_v1 { */ pageToken?: string; /** - * Set to true to return deleted annotations. updatedMin must be in the - * request to use this. Defaults to false. + * Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. */ showDeleted?: boolean; /** @@ -3926,13 +3864,11 @@ export namespace books_v1 { */ source?: string; /** - * RFC 3339 timestamp to restrict to items updated prior to this timestamp - * (exclusive). + * RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). */ updatedMax?: string; /** - * RFC 3339 timestamp to restrict to items updated since this timestamp - * (inclusive). + * RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). */ updatedMin?: string; /** @@ -4134,8 +4070,7 @@ export namespace books_v1 { /** * books.mylibrary.bookshelves.get - * @desc Retrieves metadata for a specific bookshelf belonging to the - * authenticated user. + * @desc Retrieves metadata for a specific bookshelf belonging to the authenticated user. * @alias books.mylibrary.bookshelves.get * @memberOf! () * @@ -4210,8 +4145,7 @@ export namespace books_v1 { /** * books.mylibrary.bookshelves.list - * @desc Retrieves a list of bookshelves belonging to the authenticated - * user. + * @desc Retrieves a list of bookshelves belonging to the authenticated user. * @alias books.mylibrary.bookshelves.list * @memberOf! () * @@ -4520,8 +4454,7 @@ export namespace books_v1 { */ volumeId?: string; /** - * Position on shelf to move the item (0 puts the item before the current - * first item, 1 puts it between the first and the second and so on.) + * Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) */ volumePosition?: number; } @@ -4982,8 +4915,7 @@ export namespace books_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for - * generating notification title and body. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body. */ locale?: string; /** @@ -5159,8 +5091,7 @@ export namespace books_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if - * unset. + * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. */ locale?: string; } @@ -5176,13 +5107,11 @@ export namespace books_v1 { */ categoryId?: string[]; /** - * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if - * unset. + * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. */ locale?: string; /** - * The maximum allowed maturity rating of returned volumes. Books with a - * higher maturity rating are filtered out. + * The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out. */ maxAllowedMaturityRating?: string; /** @@ -5286,13 +5215,11 @@ export namespace books_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for - * generating recommendations. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. */ locale?: string; /** - * The maximum allowed maturity rating of returned recommendations. Books - * with a higher maturity rating are filtered out. + * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. */ maxAllowedMaturityRating?: string; /** @@ -6074,8 +6001,7 @@ export namespace books_v1 { */ libraryRestrict?: string; /** - * The maximum allowed maturity rating of returned recommendations. Books - * with a higher maturity rating are filtered out. + * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. */ maxAllowedMaturityRating?: string; /** @@ -6211,13 +6137,11 @@ export namespace books_v1 { */ association?: string; /** - * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for - * generating recommendations. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. */ locale?: string; /** - * The maximum allowed maturity rating of returned recommendations. Books - * with a higher maturity rating are filtered out. + * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. */ maxAllowedMaturityRating?: string; /** @@ -6331,8 +6255,7 @@ export namespace books_v1 { */ country?: string; /** - * ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for - * generating recommendations. + * ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations. */ locale?: string; /** @@ -6340,8 +6263,7 @@ export namespace books_v1 { */ maxResults?: number; /** - * The processing state of the user uploaded volumes to be returned. - * Applicable only if the UPLOADED is specified in the acquireMethod. + * The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod. */ processingState?: string[]; /** @@ -6531,13 +6453,11 @@ export namespace books_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for - * generating recommendations. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. */ locale?: string; /** - * The maximum allowed maturity rating of returned recommendations. Books - * with a higher maturity rating are filtered out. + * The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. */ maxAllowedMaturityRating?: string; /** @@ -6553,8 +6473,7 @@ export namespace books_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for - * generating recommendations. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. */ locale?: string; /** @@ -6663,8 +6582,7 @@ export namespace books_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for - * generating recommendations. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. */ locale?: string; /** @@ -6684,8 +6602,7 @@ export namespace books_v1 { */ startIndex?: number; /** - * The ids of the volumes to be returned. If not specified all that match - * the processingState are returned. + * The ids of the volumes to be returned. If not specified all that match the processingState are returned. */ volumeId?: string[]; } diff --git a/src/apis/calendar/package.json b/src/apis/calendar/package.json index d894769493b..35327134450 100644 --- a/src/apis/calendar/package.json +++ b/src/apis/calendar/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 39a6e1e0790..c6191c4a007 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace calendar_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace calendar_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -102,7 +99,10 @@ export namespace calendar_v3 { settings: Resource$Settings; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.acl = new Resource$Acl(this.context); this.calendarList = new Resource$Calendarlist(this.context); @@ -129,14 +129,11 @@ export namespace calendar_v3 { */ kind?: string; /** - * Token used to access the next page of this result. Omitted if no further - * results are available, in which case nextSyncToken is provided. + * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ nextPageToken?: string; /** - * Token used at a later point in time to retrieve only the entries that - * have changed since this result was returned. Omitted if further results - * are available, in which case nextPageToken is provided. + * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ nextSyncToken?: string; } @@ -154,16 +151,7 @@ export namespace calendar_v3 { */ kind?: string; /** - * The role assigned to the scope. Possible values are: - "none" - * - Provides no access. - "freeBusyReader" - Provides read - * access to free/busy information. - "reader" - Provides read - * access to the calendar. Private events will appear to users with reader - * access, but event details will be hidden. - "writer" - - * Provides read and write access to the calendar. Private events will - * appear to users with writer access, and event details will be visible. - - * "owner" - Provides ownership of the calendar. This role has all - * of the permissions of the writer role with the additional ability to see - * and manipulate ACLs. + * The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. */ role?: string; /** @@ -173,8 +161,7 @@ export namespace calendar_v3 { } export interface Schema$Calendar { /** - * Conferencing properties for this calendar, for example what types of - * conferences are allowed. + * Conferencing properties for this calendar, for example what types of conferences are allowed. */ conferenceProperties?: Schema$ConferenceProperties; /** @@ -186,8 +173,7 @@ export namespace calendar_v3 { */ etag?: string; /** - * Identifier of the calendar. To retrieve IDs call the calendarList.list() - * method. + * Identifier of the calendar. To retrieve IDs call the calendarList.list() method. */ id?: string; /** @@ -203,8 +189,7 @@ export namespace calendar_v3 { */ summary?: string; /** - * The time zone of the calendar. (Formatted as an IANA Time Zone Database - * name, e.g. "Europe/Zurich".) Optional. + * The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. */ timeZone?: string; } @@ -222,49 +207,29 @@ export namespace calendar_v3 { */ kind?: string; /** - * Token used to access the next page of this result. Omitted if no further - * results are available, in which case nextSyncToken is provided. + * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ nextPageToken?: string; /** - * Token used at a later point in time to retrieve only the entries that - * have changed since this result was returned. Omitted if further results - * are available, in which case nextPageToken is provided. + * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ nextSyncToken?: string; } export interface Schema$CalendarListEntry { /** - * The effective access role that the authenticated user has on the - * calendar. Read-only. Possible values are: - "freeBusyReader" - * - Provides read access to free/busy information. - "reader" - - * Provides read access to the calendar. Private events will appear to users - * with reader access, but event details will be hidden. - - * "writer" - Provides read and write access to the calendar. - * Private events will appear to users with writer access, and event details - * will be visible. - "owner" - Provides ownership of the - * calendar. This role has all of the permissions of the writer role with - * the additional ability to see and manipulate ACLs. + * The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. */ accessRole?: string; /** - * The main color of the calendar in the hexadecimal format - * "#0088aa". This property supersedes the index-based colorId - * property. To set or change this property, you need to specify - * colorRgbFormat=true in the parameters of the insert, update and patch - * methods. Optional. + * The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. */ backgroundColor?: string; /** - * The color of the calendar. This is an ID referring to an entry in the - * calendar section of the colors definition (see the colors endpoint). This - * property is superseded by the backgroundColor and foregroundColor - * properties and can be ignored when using these properties. Optional. + * The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional. */ colorId?: string; /** - * Conferencing properties for this calendar, for example what types of - * conferences are allowed. + * Conferencing properties for this calendar, for example what types of conferences are allowed. */ conferenceProperties?: Schema$ConferenceProperties; /** @@ -272,8 +237,7 @@ export namespace calendar_v3 { */ defaultReminders?: Schema$EventReminder[]; /** - * Whether this calendar list entry has been deleted from the calendar list. - * Read-only. Optional. The default is False. + * Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. */ deleted?: boolean; /** @@ -285,16 +249,11 @@ export namespace calendar_v3 { */ etag?: string; /** - * The foreground color of the calendar in the hexadecimal format - * "#ffffff". This property supersedes the index-based colorId - * property. To set or change this property, you need to specify - * colorRgbFormat=true in the parameters of the insert, update and patch - * methods. Optional. + * The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. */ foregroundColor?: string; /** - * Whether the calendar has been hidden from the list. Optional. The default - * is False. + * Whether the calendar has been hidden from the list. Optional. The default is False. */ hidden?: boolean; /** @@ -306,23 +265,19 @@ export namespace calendar_v3 { */ kind?: string; /** - * Geographic location of the calendar as free-form text. Optional. - * Read-only. + * Geographic location of the calendar as free-form text. Optional. Read-only. */ location?: string; /** - * The notifications that the authenticated user is receiving for this - * calendar. + * The notifications that the authenticated user is receiving for this calendar. */ notificationSettings?: {notifications?: Schema$CalendarNotification[]}; /** - * Whether the calendar is the primary calendar of the authenticated user. - * Read-only. Optional. The default is False. + * Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. */ primary?: boolean; /** - * Whether the calendar content shows up in the calendar UI. Optional. The - * default is False. + * Whether the calendar content shows up in the calendar UI. Optional. The default is False. */ selected?: boolean; /** @@ -330,8 +285,7 @@ export namespace calendar_v3 { */ summary?: string; /** - * The summary that the authenticated user has set for this calendar. - * Optional. + * The summary that the authenticated user has set for this calendar. Optional. */ summaryOverride?: string; /** @@ -341,25 +295,11 @@ export namespace calendar_v3 { } export interface Schema$CalendarNotification { /** - * The method used to deliver the notification. Possible values are: - - * "email" - Notifications are sent via email. - "sms" - * - Deprecated. Once this feature is shutdown, the API will no longer - * return notifications using this method. Any newly added SMS notifications - * will be ignored. See Google Calendar SMS notifications to be removed for - * more information. Notifications are sent via SMS. This value is read-only - * and is ignored on inserts and updates. SMS notifications are only - * available for G Suite customers. Required when adding a notification. + * The method used to deliver the notification. Possible values are: - "email" - Notifications are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information. Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers. Required when adding a notification. */ method?: string; /** - * The type of notification. Possible values are: - - * "eventCreation" - Notification sent when a new event is put on - * the calendar. - "eventChange" - Notification sent when an - * event is changed. - "eventCancellation" - Notification sent - * when an event is cancelled. - "eventResponse" - Notification - * sent when an attendee responds to the event invitation. - - * "agenda" - An agenda with the events of the day (sent out in - * the morning). Required when adding a notification. + * The type of notification. Possible values are: - "eventCreation" - Notification sent when a new event is put on the calendar. - "eventChange" - Notification sent when an event is changed. - "eventCancellation" - Notification sent when an event is cancelled. - "eventResponse" - Notification sent when an attendee responds to the event invitation. - "agenda" - An agenda with the events of the day (sent out in the morning). Required when adding a notification. */ type?: string; } @@ -369,8 +309,7 @@ export namespace calendar_v3 { */ address?: string; /** - * Date and time of notification channel expiration, expressed as a Unix - * timestamp, in milliseconds. Optional. + * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ expiration?: string; /** @@ -378,8 +317,7 @@ export namespace calendar_v3 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a - * resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". */ kind?: string; /** @@ -391,8 +329,7 @@ export namespace calendar_v3 { */ payload?: boolean; /** - * An opaque ID that identifies the resource being watched on this channel. - * Stable across different API versions. + * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ resourceId?: string; /** @@ -400,8 +337,7 @@ export namespace calendar_v3 { */ resourceUri?: string; /** - * An arbitrary string delivered to the target address with each - * notification delivered over this channel. Optional. + * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ token?: string; /** @@ -415,22 +351,17 @@ export namespace calendar_v3 { */ background?: string; /** - * The foreground color that can be used to write on top of a background - * with 'background' color. + * The foreground color that can be used to write on top of a background with 'background' color. */ foreground?: string; } export interface Schema$Colors { /** - * A global palette of calendar colors, mapping from the color ID to its - * definition. A calendarListEntry resource refers to one of these color IDs - * in its color field. Read-only. + * A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only. */ calendar?: {[key: string]: Schema$ColorDefinition}; /** - * A global palette of event colors, mapping from the color ID to its - * definition. An event resource may refer to one of these color IDs in its - * color field. Read-only. + * A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only. */ event?: {[key: string]: Schema$ColorDefinition}; /** @@ -438,56 +369,37 @@ export namespace calendar_v3 { */ kind?: string; /** - * Last modification time of the color palette (as a RFC3339 timestamp). - * Read-only. + * Last modification time of the color palette (as a RFC3339 timestamp). Read-only. */ updated?: string; } export interface Schema$ConferenceData { /** - * The ID of the conference. Can be used by developers to keep track of - * conferences, should not be displayed to users. Values for solution types: - * - "eventHangout": unset. - "eventNamedHangout": the - * name of the Hangout. - "hangoutsMeet": the 10-letter meeting - * code, for example "aaa-bbbb-ccc". Optional. + * The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types: - "eventHangout": unset. - "eventNamedHangout": the name of the Hangout. - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. */ conferenceId?: string; /** - * The conference solution, such as Hangouts or Hangouts Meet. Unset for a - * conference with a failed create request. Either conferenceSolution and at - * least one entryPoint, or createRequest is required. + * The conference solution, such as Hangouts or Hangouts Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required. */ conferenceSolution?: Schema$ConferenceSolution; /** - * A request to generate a new conference and attach it to the event. The - * data is generated asynchronously. To see whether the data is present - * check the status field. Either conferenceSolution and at least one - * entryPoint, or createRequest is required. + * A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either conferenceSolution and at least one entryPoint, or createRequest is required. */ createRequest?: Schema$CreateConferenceRequest; /** - * Information about individual conference entry points, such as URLs or - * phone numbers. All of them must belong to the same conference. Either - * conferenceSolution and at least one entryPoint, or createRequest is - * required. + * Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required. */ entryPoints?: Schema$EntryPoint[]; /** - * Additional notes (such as instructions from the domain administrator, - * legal notices) to display to the user. Can contain HTML. The maximum - * length is 2048 characters. Optional. + * Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. */ notes?: string; /** - * Additional properties related to a conference. An example would be a - * solution-specific setting for enabling video streaming. + * Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. */ parameters?: Schema$ConferenceParameters; /** - * The signature of the conference data. Genereated on server side. Must be - * preserved while copying the conference data between events, otherwise the - * conference data will not be copied. Unset for a conference with a failed - * create request. Optional for a conference with a pending create request. + * The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request. */ signature?: string; } @@ -502,20 +414,13 @@ export namespace calendar_v3 { } export interface Schema$ConferenceProperties { /** - * The types of conference solutions that are supported for this calendar. - * The possible values are: - "eventHangout" - - * "eventNamedHangout" - "hangoutsMeet" Optional. + * The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional. */ allowedConferenceSolutionTypes?: string[]; } export interface Schema$ConferenceRequestStatus { /** - * The current status of the conference create request. Read-only. The - * possible values are: - "pending": the conference create - * request is still being processed. - "success": the conference - * create request succeeded, the entry points are populated. - - * "failure": the conference create request failed, there are no - * entry points. + * The current status of the conference create request. Read-only. The possible values are: - "pending": the conference create request is still being processed. - "success": the conference create request succeeded, the entry points are populated. - "failure": the conference create request failed, there are no entry points. */ statusCode?: string; } @@ -525,8 +430,7 @@ export namespace calendar_v3 { */ iconUri?: string; /** - * The key which can uniquely identify the conference solution for this - * event. + * The key which can uniquely identify the conference solution for this event. */ key?: Schema$ConferenceSolutionKey; /** @@ -536,13 +440,7 @@ export namespace calendar_v3 { } export interface Schema$ConferenceSolutionKey { /** - * The conference solution type. If a client encounters an unfamiliar or - * empty type, it should still be able to display the entry points. However, - * it should disallow modifications. The possible values are: - - * "eventHangout" for Hangouts for consumers - * (http://hangouts.google.com) - "eventNamedHangout" for classic - * Hangouts for G Suite users (http://hangouts.google.com) - - * "hangoutsMeet" for Hangouts Meet (http://meet.google.com) + * The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) */ type?: string; } @@ -552,9 +450,7 @@ export namespace calendar_v3 { */ conferenceSolutionKey?: Schema$ConferenceSolutionKey; /** - * The client-generated unique ID for this request. Clients should - * regenerate this ID for every new request. If an ID provided is the same - * as for the previous request, the request is ignored. + * The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. */ requestId?: string; /** @@ -564,83 +460,43 @@ export namespace calendar_v3 { } export interface Schema$EntryPoint { /** - * The access code to access the conference. The maximum length is 128 - * characters. When creating new conference data, populate only the subset - * of {meetingCode, accessCode, passcode, password, pin} fields that match - * the terminology that the conference provider uses. Only the populated - * fields should be displayed. Optional. + * The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ accessCode?: string; /** - * Features of the entry point, such as being toll or toll-free. One entry - * point can have multiple features. However, toll and toll-free cannot be - * both set on the same entry point. + * Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. */ entryPointFeatures?: string[]; /** - * The type of the conference entry point. Possible values are: - - * "video" - joining a conference over HTTP. A conference can have - * zero or one video entry point. - "phone" - joining a conference - * by dialing a phone number. A conference can have zero or more phone entry - * points. - "sip" - joining a conference over SIP. A conference - * can have zero or one sip entry point. - "more" - further - * conference joining instructions, for example additional phone numbers. A - * conference can have zero or one more entry point. A conference with only - * a more entry point is not a valid conference. + * The type of the conference entry point. Possible values are: - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. */ entryPointType?: string; /** - * The label for the URI. Visible to end users. Not localized. The maximum - * length is 512 characters. Examples: - for video: - * meet.google.com/aaa-bbbb-ccc - for phone: +1 123 268 2601 - for sip: - * 12345678@altostrat.com - for more: should not be filled Optional. + * The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples: - for video: meet.google.com/aaa-bbbb-ccc - for phone: +1 123 268 2601 - for sip: 12345678@altostrat.com - for more: should not be filled Optional. */ label?: string; /** - * The meeting code to access the conference. The maximum length is 128 - * characters. When creating new conference data, populate only the subset - * of {meetingCode, accessCode, passcode, password, pin} fields that match - * the terminology that the conference provider uses. Only the populated - * fields should be displayed. Optional. + * The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ meetingCode?: string; /** - * The passcode to access the conference. The maximum length is 128 - * characters. When creating new conference data, populate only the subset - * of {meetingCode, accessCode, passcode, password, pin} fields that match - * the terminology that the conference provider uses. Only the populated - * fields should be displayed. + * The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. */ passcode?: string; /** - * The password to access the conference. The maximum length is 128 - * characters. When creating new conference data, populate only the subset - * of {meetingCode, accessCode, passcode, password, pin} fields that match - * the terminology that the conference provider uses. Only the populated - * fields should be displayed. Optional. + * The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ password?: string; /** - * The PIN to access the conference. The maximum length is 128 characters. - * When creating new conference data, populate only the subset of - * {meetingCode, accessCode, passcode, password, pin} fields that match the - * terminology that the conference provider uses. Only the populated fields - * should be displayed. Optional. + * The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. */ pin?: string; /** - * The CLDR/ISO 3166 region code for the country associated with this phone - * access. Example: "SE" for Sweden. Calendar backend will - * populate this field only for EntryPointType.PHONE. + * The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE. */ regionCode?: string; /** - * The URI of the entry point. The maximum length is 1300 characters. - * Format: - for video, http: or https: schema is required. - for phone, - * tel: schema is required. The URI should include the entire dial sequence - * (e.g., tel:+12345678900,,,123456789;1234). - for sip, sip: schema is - * required, e.g., sip:12345678@myprovider.com. - for more, http: or https: - * schema is required. + * The URI of the entry point. The maximum length is 1300 characters. Format: - for video, http: or https: schema is required. - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. - for more, http: or https: schema is required. */ uri?: string; } @@ -650,54 +506,33 @@ export namespace calendar_v3 { */ domain?: string; /** - * Specific reason for the error. Some of the possible values are: - - * "groupTooBig" - The group of users requested is too large for a - * single query. - "tooManyCalendarsRequested" - The number of - * calendars requested is too large for a single query. - - * "notFound" - The requested resource was not found. - - * "internalError" - The API service has encountered an internal - * error. Additional error types may be added in the future, so clients - * should gracefully handle additional error statuses not included in this - * list. + * Specific reason for the error. Some of the possible values are: - "groupTooBig" - The group of users requested is too large for a single query. - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query. - "notFound" - The requested resource was not found. - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list. */ reason?: string; } export interface Schema$Event { /** - * Whether anyone can invite themselves to the event (currently works for - * Google+ events only). Optional. The default is False. + * Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. */ anyoneCanAddSelf?: boolean; /** - * File attachments for the event. Currently only Google Drive attachments - * are supported. In order to modify attachments the supportsAttachments - * request parameter should be set to true. There can be at most 25 - * attachments per event, + * File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, */ attachments?: Schema$EventAttachment[]; /** - * The attendees of the event. See the Events with attendees guide for more - * information on scheduling events with other calendar users. + * The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. */ attendees?: Schema$EventAttendee[]; /** - * Whether attendees may have been omitted from the event's - * representation. When retrieving an event, this may be due to a - * restriction specified by the maxAttendee query parameter. When updating - * an event, this can be used to only update the participant's response. - * Optional. The default is False. + * Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. */ attendeesOmitted?: boolean; /** - * The color of the event. This is an ID referring to an entry in the event - * section of the colors definition (see the colors endpoint). Optional. + * The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. */ colorId?: string; /** - * The conference-related information, such as details of a Hangouts Meet - * conference. To create new conference details use the createRequest field. - * To persist your changes, remember to set the conferenceDataVersion - * request parameter to 1 for all event modification requests. + * The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. */ conferenceData?: Schema$ConferenceData; /** @@ -718,14 +553,11 @@ export namespace calendar_v3 { */ description?: string; /** - * The (exclusive) end time of the event. For a recurring event, this is the - * end time of the first instance. + * The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. */ end?: Schema$EventDateTime; /** - * Whether the end time is actually unspecified. An end time is still - * provided for compatibility reasons, even if this attribute is set to - * True. The default is False. + * Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. */ endTimeUnspecified?: boolean; /** @@ -753,23 +585,19 @@ export namespace calendar_v3 { width?: number; }; /** - * Whether attendees other than the organizer can invite others to the - * event. Optional. The default is True. + * Whether attendees other than the organizer can invite others to the event. Optional. The default is True. */ guestsCanInviteOthers?: boolean; /** - * Whether attendees other than the organizer can modify the event. - * Optional. The default is False. + * Whether attendees other than the organizer can modify the event. Optional. The default is False. */ guestsCanModify?: boolean; /** - * Whether attendees other than the organizer can see who the event's - * attendees are. Optional. The default is True. + * Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. */ guestsCanSeeOtherGuests?: boolean; /** - * An absolute link to the Google+ hangout associated with this event. - * Read-only. + * An absolute link to the Google+ hangout associated with this event. Read-only. */ hangoutLink?: string; /** @@ -777,30 +605,11 @@ export namespace calendar_v3 { */ htmlLink?: string; /** - * Event unique identifier as defined in RFC5545. It is used to uniquely - * identify events accross calendaring systems and must be supplied when - * importing events via the import method. Note that the icalUID and the id - * are not identical and only one of them should be supplied at event - * creation time. One difference in their semantics is that in recurring - * events, all occurrences of one event have different ids while they all - * share the same icalUIDs. + * Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. */ iCalUID?: string; /** - * Opaque identifier of the event. When creating new single or recurring - * events, you can specify their IDs. Provided IDs must follow these rules: - * - characters allowed in the ID are those used in base32hex encoding, i.e. - * lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the - * length of the ID must be between 5 and 1024 characters - the ID must be - * unique per calendar Due to the globally distributed nature of the - * system, we cannot guarantee that ID collisions will be detected at event - * creation time. To minimize the risk of collisions we recommend using an - * established UUID algorithm such as one described in RFC4122. If you do - * not specify an ID, it will be automatically generated by the server. Note - * that the icalUID and the id are not identical and only one of them should - * be supplied at event creation time. One difference in their semantics is - * that in recurring events, all occurrences of one event have different ids - * while they all share the same icalUIDs. + * Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. */ id?: string; /** @@ -812,17 +621,11 @@ export namespace calendar_v3 { */ location?: string; /** - * Whether this is a locked event copy where no changes can be made to the - * main event fields "summary", "description", - * "location", "start", "end" or - * "recurrence". The default is False. Read-Only. + * Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. */ locked?: boolean; /** - * The organizer of the event. If the organizer is also an attendee, this is - * indicated with a separate entry in attendees with the organizer field set - * to True. To change the organizer, use the move operation. Read-only, - * except when importing an event. + * The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. */ organizer?: { displayName?: string; @@ -831,30 +634,19 @@ export namespace calendar_v3 { self?: boolean; }; /** - * For an instance of a recurring event, this is the time at which this - * event would start according to the recurrence data in the recurring event - * identified by recurringEventId. It uniquely identifies the instance - * within the recurring event series even if the instance was moved to a - * different time. Immutable. + * For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. */ originalStartTime?: Schema$EventDateTime; /** - * Whether this is a private event copy where changes are not shared with - * other copies on other calendars. Optional. Immutable. The default is - * False. + * Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. */ privateCopy?: boolean; /** - * List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as - * specified in RFC5545. Note that DTSTART and DTEND lines are not allowed - * in this field; event start and end times are specified in the start and - * end fields. This field is omitted for single events or instances of - * recurring events. + * List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. */ recurrence?: string[]; /** - * For an instance of a recurring event, this is the id of the recurring - * event to which this instance belongs. Immutable. + * For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. */ recurringEventId?: string; /** @@ -866,43 +658,15 @@ export namespace calendar_v3 { */ sequence?: number; /** - * Source from which the event was created. For example, a web page, an - * email message or any document identifiable by an URL with HTTP or HTTPS - * scheme. Can only be seen or modified by the creator of the event. + * Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. */ source?: {title?: string; url?: string}; /** - * The (inclusive) start time of the event. For a recurring event, this is - * the start time of the first instance. + * The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. */ start?: Schema$EventDateTime; /** - * Status of the event. Optional. Possible values are: - - * "confirmed" - The event is confirmed. This is the default - * status. - "tentative" - The event is tentatively confirmed. - - * "cancelled" - The event is cancelled (deleted). The list method - * returns cancelled events only on incremental sync (when syncToken or - * updatedMin are specified) or if the showDeleted flag is set to true. The - * get method always returns them. A cancelled status represents two - * different states depending on the event type: - Cancelled exceptions of - * an uncancelled recurring event indicate that this instance should no - * longer be presented to the user. Clients should store these events for - * the lifetime of the parent recurring event. Cancelled exceptions are only - * guaranteed to have values for the id, recurringEventId and - * originalStartTime fields populated. The other fields might be empty. - - * All other cancelled events represent deleted events. Clients should - * remove their locally synced copies. Such cancelled events will eventually - * disappear, so do not rely on them being available indefinitely. Deleted - * events are only guaranteed to have the id field populated. On the - * organizer's calendar, cancelled events continue to expose event - * details (summary, location, etc.) so that they can be restored - * (undeleted). Similarly, the events to which the user was invited and that - * they manually removed continue to provide details. However, incremental - * sync requests with showDeleted set to false will not return these - * details. If an event changes its organizer (for example via the move - * operation) and the original organizer is not on the attendee list, it - * will leave behind a cancelled event where only the id field is guaranteed - * to be populated. + * Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. */ status?: string; /** @@ -910,12 +674,7 @@ export namespace calendar_v3 { */ summary?: string; /** - * Whether the event blocks time on the calendar. Optional. Possible values - * are: - "opaque" - Default value. The event does block time on - * the calendar. This is equivalent to setting Show me as to Busy in the - * Calendar UI. - "transparent" - The event does not block time - * on the calendar. This is equivalent to setting Show me as to Available in - * the Calendar UI. + * Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. */ transparency?: string; /** @@ -923,26 +682,17 @@ export namespace calendar_v3 { */ updated?: string; /** - * Visibility of the event. Optional. Possible values are: - - * "default" - Uses the default visibility for events on the - * calendar. This is the default value. - "public" - The event is - * public and event details are visible to all readers of the calendar. - - * "private" - The event is private and only event attendees may - * view event details. - "confidential" - The event is private. - * This value is provided for compatibility reasons. + * Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons. */ visibility?: string; } export interface Schema$EventAttachment { /** - * ID of the attached file. Read-only. For Google Drive files, this is the - * ID of the corresponding Files resource entry in the Drive API. + * ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. */ fileId?: string; /** - * URL link to the attachment. For adding Google Drive file attachments use - * the same format as in alternateLink property of the Files resource in the - * Drive API. Required when adding an attachment. + * URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment. */ fileUrl?: string; /** @@ -972,14 +722,11 @@ export namespace calendar_v3 { */ displayName?: string; /** - * The attendee's email address, if available. This field must be - * present when adding an attendee. It must be a valid email address as per - * RFC5322. Required when adding an attendee. + * The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee. */ email?: string; /** - * The attendee's Profile ID, if available. It corresponds to the id - * field in the People collection of the Google+ API + * The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API */ id?: string; /** @@ -987,91 +734,53 @@ export namespace calendar_v3 { */ optional?: boolean; /** - * Whether the attendee is the organizer of the event. Read-only. The - * default is False. + * Whether the attendee is the organizer of the event. Read-only. The default is False. */ organizer?: boolean; /** - * Whether the attendee is a resource. Can only be set when the attendee is - * added to the event for the first time. Subsequent modifications are - * ignored. Optional. The default is False. + * Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. */ resource?: boolean; /** - * The attendee's response status. Possible values are: - - * "needsAction" - The attendee has not responded to the - * invitation. - "declined" - The attendee has declined the - * invitation. - "tentative" - The attendee has tentatively - * accepted the invitation. - "accepted" - The attendee has - * accepted the invitation. + * The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation. - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation. */ responseStatus?: string; /** - * Whether this entry represents the calendar on which this copy of the - * event appears. Read-only. The default is False. + * Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. */ self?: boolean; } export interface Schema$EventDateTime { /** - * The date, in the format "yyyy-mm-dd", if this is an all-day - * event. + * The date, in the format "yyyy-mm-dd", if this is an all-day event. */ date?: string; /** - * The time, as a combined date-time value (formatted according to RFC3339). - * A time zone offset is required unless a time zone is explicitly specified - * in timeZone. + * The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. */ dateTime?: string; /** - * The time zone in which the time is specified. (Formatted as an IANA Time - * Zone Database name, e.g. "Europe/Zurich".) For recurring events - * this field is required and specifies the time zone in which the - * recurrence is expanded. For single events this field is optional and - * indicates a custom time zone for the event start/end. + * The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. */ timeZone?: string; } export interface Schema$EventReminder { /** - * The method used by this reminder. Possible values are: - - * "email" - Reminders are sent via email. - "sms" - - * Deprecated. Once this feature is shutdown, the API will no longer return - * reminders using this method. Any newly added SMS reminders will be - * ignored. See Google Calendar SMS notifications to be removed for more - * information. Reminders are sent via SMS. These are only available for G - * Suite customers. Requests to set SMS reminders for other account types - * are ignored. - "popup" - Reminders are sent via a UI popup. - * Required when adding a reminder. + * The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder. */ method?: string; /** - * Number of minutes before the start of the event when the reminder should - * trigger. Valid values are between 0 and 40320 (4 weeks in minutes). - * Required when adding a reminder. + * Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder. */ minutes?: number; } export interface Schema$Events { /** - * The user's access role for this calendar. Read-only. Possible values - * are: - "none" - The user has no access. - - * "freeBusyReader" - The user has read access to free/busy - * information. - "reader" - The user has read access to the - * calendar. Private events will appear to users with reader access, but - * event details will be hidden. - "writer" - The user has read - * and write access to the calendar. Private events will appear to users - * with writer access, and event details will be visible. - - * "owner" - The user has ownership of the calendar. This role has - * all of the permissions of the writer role with the additional ability to - * see and manipulate ACLs. + * The user's access role for this calendar. Read-only. Possible values are: - "none" - The user has no access. - "freeBusyReader" - The user has read access to free/busy information. - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. */ accessRole?: string; /** - * The default reminders on the calendar for the authenticated user. These - * reminders apply to all events on this calendar that do not explicitly - * override them (i.e. do not have reminders.useDefault set to True). + * The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). */ defaultReminders?: Schema$EventReminder[]; /** @@ -1091,14 +800,11 @@ export namespace calendar_v3 { */ kind?: string; /** - * Token used to access the next page of this result. Omitted if no further - * results are available, in which case nextSyncToken is provided. + * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ nextPageToken?: string; /** - * Token used at a later point in time to retrieve only the entries that - * have changed since this result was returned. Omitted if further results - * are available, in which case nextPageToken is provided. + * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ nextSyncToken?: string; /** @@ -1110,15 +816,13 @@ export namespace calendar_v3 { */ timeZone?: string; /** - * Last modification time of the calendar (as a RFC3339 timestamp). - * Read-only. + * Last modification time of the calendar (as a RFC3339 timestamp). Read-only. */ updated?: string; } export interface Schema$FreeBusyCalendar { /** - * List of time ranges during which this calendar should be regarded as - * busy. + * List of time ranges during which this calendar should be regarded as busy. */ busy?: Schema$TimePeriod[]; /** @@ -1138,14 +842,11 @@ export namespace calendar_v3 { } export interface Schema$FreeBusyRequest { /** - * Maximal number of calendars for which FreeBusy information is to be - * provided. Optional. Maximum value is 50. + * Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50. */ calendarExpansionMax?: number; /** - * Maximal number of calendar identifiers to be provided for a single group. - * Optional. An error is returned for a group with more members than this - * value. Maximum value is 100. + * Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100. */ groupExpansionMax?: number; /** @@ -1207,9 +908,7 @@ export namespace calendar_v3 { */ kind?: string; /** - * Value of the user setting. The format of the value depends on the ID of - * the setting. It must always be a UTF-8 string of length up to 1024 - * characters. + * Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters. */ value?: string; } @@ -1227,14 +926,11 @@ export namespace calendar_v3 { */ kind?: string; /** - * Token used to access the next page of this result. Omitted if no further - * results are available, in which case nextSyncToken is provided. + * Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. */ nextPageToken?: string; /** - * Token used at a later point in time to retrieve only the entries that - * have changed since this result was returned. Omitted if further results - * are available, in which case nextPageToken is provided. + * Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. */ nextSyncToken?: string; } @@ -1547,8 +1243,7 @@ export namespace calendar_v3 { /** * calendar.acl.patch - * @desc Updates an access control rule. This method supports patch - * semantics. + * @desc Updates an access control rule. This method supports patch semantics. * @alias calendar.acl.patch * @memberOf! () * @@ -1775,9 +1470,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** @@ -1792,9 +1485,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** @@ -1809,14 +1500,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Whether to send notifications about the calendar sharing change. - * Optional. The default is True. + * Whether to send notifications about the calendar sharing change. Optional. The default is True. */ sendNotifications?: boolean; @@ -1832,15 +1520,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Maximum number of entries returned on one result page. By default the - * value is 100 entries. The page size can never be larger than 250 entries. - * Optional. + * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. */ maxResults?: number; /** @@ -1848,21 +1532,11 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Whether to include deleted ACLs in the result. Deleted ACLs are - * represented by role equal to "none". Deleted ACLs will always be included - * if syncToken is provided. Optional. The default is False. + * Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False. */ showDeleted?: boolean; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. All entries - * deleted since the previous list request will always be in the result set - * and it is not allowed to set showDeleted to False. If the syncToken - * expires, the server will respond with a 410 GONE response code and the - * client should clear its storage and perform a full synchronization - * without any syncToken. Learn more about incremental synchronization. - * Optional. The default is to return all entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; } @@ -1873,9 +1547,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** @@ -1883,9 +1555,7 @@ export namespace calendar_v3 { */ ruleId?: string; /** - * Whether to send notifications about the calendar sharing change. Note - * that there are no notifications on access removal. Optional. The default - * is True. + * Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. */ sendNotifications?: boolean; @@ -1901,9 +1571,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** @@ -1911,9 +1579,7 @@ export namespace calendar_v3 { */ ruleId?: string; /** - * Whether to send notifications about the calendar sharing change. Note - * that there are no notifications on access removal. Optional. The default - * is True. + * Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. */ sendNotifications?: boolean; @@ -1929,15 +1595,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Maximum number of entries returned on one result page. By default the - * value is 100 entries. The page size can never be larger than 250 entries. - * Optional. + * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. */ maxResults?: number; /** @@ -1945,21 +1607,11 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Whether to include deleted ACLs in the result. Deleted ACLs are - * represented by role equal to "none". Deleted ACLs will always be included - * if syncToken is provided. Optional. The default is False. + * Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False. */ showDeleted?: boolean; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. All entries - * deleted since the previous list request will always be in the result set - * and it is not allowed to set showDeleted to False. If the syncToken - * expires, the server will respond with a 410 GONE response code and the - * client should clear its storage and perform a full synchronization - * without any syncToken. Learn more about incremental synchronization. - * Optional. The default is to return all entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; @@ -2274,8 +1926,7 @@ export namespace calendar_v3 { /** * calendar.calendarList.patch - * @desc Updates an existing calendar on the user's calendar list. This - * method supports patch semantics. + * @desc Updates an existing calendar on the user's calendar list. This method supports patch semantics. * @alias calendar.calendarList.patch * @memberOf! () * @@ -2510,9 +2161,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; } @@ -2523,9 +2172,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; } @@ -2537,10 +2184,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to use the foregroundColor and backgroundColor fields to write - * the calendar colors (RGB). If this feature is used, the index-based - * colorId field will be set to the best matching option automatically. - * Optional. The default is False. + * Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. */ colorRgbFormat?: boolean; @@ -2557,14 +2201,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of entries returned on one result page. By default the - * value is 100 entries. The page size can never be larger than 250 entries. - * Optional. + * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. */ maxResults?: number; /** - * The minimum access role for the user in the returned entries. Optional. - * The default is no restriction. + * The minimum access role for the user in the returned entries. Optional. The default is no restriction. */ minAccessRole?: string; /** @@ -2572,8 +2213,7 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Whether to include deleted calendar list entries in the result. Optional. - * The default is False. + * Whether to include deleted calendar list entries in the result. Optional. The default is False. */ showDeleted?: boolean; /** @@ -2581,19 +2221,7 @@ export namespace calendar_v3 { */ showHidden?: boolean; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. If only - * read-only fields such as calendar properties or ACLs have changed, the - * entry won't be returned. All entries deleted and hidden since the - * previous list request will always be in the result set and it is not - * allowed to set showDeleted neither showHidden to False. To ensure client - * state consistency minAccessRole query parameter cannot be specified - * together with nextSyncToken. If the syncToken expires, the server will - * respond with a 410 GONE response code and the client should clear its - * storage and perform a full synchronization without any syncToken. Learn - * more about incremental synchronization. Optional. The default is to - * return all entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; } @@ -2605,16 +2233,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Whether to use the foregroundColor and backgroundColor fields to write - * the calendar colors (RGB). If this feature is used, the index-based - * colorId field will be set to the best matching option automatically. - * Optional. The default is False. + * Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. */ colorRgbFormat?: boolean; @@ -2631,16 +2254,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Whether to use the foregroundColor and backgroundColor fields to write - * the calendar colors (RGB). If this feature is used, the index-based - * colorId field will be set to the best matching option automatically. - * Optional. The default is False. + * Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. */ colorRgbFormat?: boolean; @@ -2657,14 +2275,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of entries returned on one result page. By default the - * value is 100 entries. The page size can never be larger than 250 entries. - * Optional. + * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. */ maxResults?: number; /** - * The minimum access role for the user in the returned entries. Optional. - * The default is no restriction. + * The minimum access role for the user in the returned entries. Optional. The default is no restriction. */ minAccessRole?: string; /** @@ -2672,8 +2287,7 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Whether to include deleted calendar list entries in the result. Optional. - * The default is False. + * Whether to include deleted calendar list entries in the result. Optional. The default is False. */ showDeleted?: boolean; /** @@ -2681,19 +2295,7 @@ export namespace calendar_v3 { */ showHidden?: boolean; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. If only - * read-only fields such as calendar properties or ACLs have changed, the - * entry won't be returned. All entries deleted and hidden since the - * previous list request will always be in the result set and it is not - * allowed to set showDeleted neither showHidden to False. To ensure client - * state consistency minAccessRole query parameter cannot be specified - * together with nextSyncToken. If the syncToken expires, the server will - * respond with a 410 GONE response code and the client should clear its - * storage and perform a full synchronization without any syncToken. Learn - * more about incremental synchronization. Optional. The default is to - * return all entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; @@ -2711,8 +2313,7 @@ export namespace calendar_v3 { /** * calendar.calendars.clear - * @desc Clears a primary calendar. This operation deletes all events - * associated with the primary calendar of an account. + * @desc Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. * @alias calendar.calendars.clear * @memberOf! () * @@ -2782,8 +2383,7 @@ export namespace calendar_v3 { /** * calendar.calendars.delete - * @desc Deletes a secondary calendar. Use calendars.clear for clearing all - * events on primary calendars. + * @desc Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. * @alias calendar.calendars.delete * @memberOf! () * @@ -2996,8 +2596,7 @@ export namespace calendar_v3 { /** * calendar.calendars.patch - * @desc Updates metadata for a calendar. This method supports patch - * semantics. + * @desc Updates metadata for a calendar. This method supports patch semantics. * @alias calendar.calendars.patch * @memberOf! () * @@ -3147,9 +2746,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; } @@ -3160,9 +2757,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; } @@ -3173,9 +2768,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; } @@ -3197,9 +2790,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; @@ -3215,9 +2806,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; @@ -3556,8 +3145,7 @@ export namespace calendar_v3 { /** * calendar.events.import - * @desc Imports an event. This operation is used to add a private copy of an - * existing event to a calendar. + * @desc Imports an event. This operation is used to add a private copy of an existing event to a calendar. * @alias calendar.events.import * @memberOf! () * @@ -3806,8 +3394,8 @@ export namespace calendar_v3 { * @param {boolean=} params.showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False. * @param {boolean=} params.singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. * @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. - * @param {string=} params.timeMax Upper bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. - * @param {string=} params.timeMin Lower bound (inclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. + * @param {string=} params.timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. + * @param {string=} params.timeMin Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. * @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. * @param {string=} params.updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3874,8 +3462,7 @@ export namespace calendar_v3 { /** * calendar.events.move - * @desc Moves an event to another calendar, i.e. changes an event's - * organizer. + * @desc Moves an event to another calendar, i.e. changes an event's organizer. * @alias calendar.events.move * @memberOf! () * @@ -4198,8 +3785,8 @@ export namespace calendar_v3 { * @param {boolean=} params.showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False. * @param {boolean=} params.singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. * @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. - * @param {string=} params.timeMax Upper bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. - * @param {string=} params.timeMin Lower bound (inclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. + * @param {string=} params.timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. + * @param {string=} params.timeMin Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. * @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. * @param {string=} params.updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. * @param {().Channel} params.resource Request body data @@ -4273,9 +3860,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** @@ -4283,10 +3868,7 @@ export namespace calendar_v3 { */ eventId?: string; /** - * Deprecated. Please use sendUpdates instead. Whether to send - * notifications about the deletion of the event. Note that some emails - * might still be sent even if you set the value to false. The default is - * false. + * Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false. */ sendNotifications?: boolean; /** @@ -4301,18 +3883,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to always include a value in the email field for the organizer, - * creator and attendees, even if no real email is available (i.e. a - * generated, non-working value will be provided). The use of this option is - * discouraged and should only be used by clients which cannot handle the - * absence of an email address value in the mentioned places. Optional. The - * default is False. + * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. */ alwaysIncludeEmail?: boolean; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** @@ -4320,14 +3895,11 @@ export namespace calendar_v3 { */ eventId?: string; /** - * The maximum number of attendees to include in the response. If there are - * more than the specified number of attendees, only the participant is - * returned. Optional. + * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. */ maxAttendees?: number; /** - * Time zone used in the response. Optional. The default is the time zone of - * the calendar. + * Time zone used in the response. Optional. The default is the time zone of the calendar. */ timeZone?: string; } @@ -4338,22 +3910,15 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Version number of conference data supported by the API client. Version 0 - * assumes no conference data support and ignores conference data in the - * event's body. Version 1 enables support for copying of ConferenceData as - * well as for creating new conferences using the createRequest field of - * conferenceData. The default is 0. + * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. */ conferenceDataVersion?: number; /** - * Whether API client performing operation supports event attachments. - * Optional. The default is False. + * Whether API client performing operation supports event attachments. Optional. The default is False. */ supportsAttachments?: boolean; @@ -4369,40 +3934,27 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Version number of conference data supported by the API client. Version 0 - * assumes no conference data support and ignores conference data in the - * event's body. Version 1 enables support for copying of ConferenceData as - * well as for creating new conferences using the createRequest field of - * conferenceData. The default is 0. + * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. */ conferenceDataVersion?: number; /** - * The maximum number of attendees to include in the response. If there are - * more than the specified number of attendees, only the participant is - * returned. Optional. + * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. */ maxAttendees?: number; /** - * Deprecated. Please use sendUpdates instead. Whether to send - * notifications about the creation of the new event. Note that some emails - * might still be sent even if you set the value to false. The default is - * false. + * Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false. */ sendNotifications?: boolean; /** - * Whether to send notifications about the creation of the new event. Note - * that some emails might still be sent. The default is false. + * Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. */ sendUpdates?: string; /** - * Whether API client performing operation supports event attachments. - * Optional. The default is False. + * Whether API client performing operation supports event attachments. Optional. The default is False. */ supportsAttachments?: boolean; @@ -4418,18 +3970,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to always include a value in the email field for the organizer, - * creator and attendees, even if no real email is available (i.e. a - * generated, non-working value will be provided). The use of this option is - * discouraged and should only be used by clients which cannot handle the - * absence of an email address value in the mentioned places. Optional. The - * default is False. + * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. */ alwaysIncludeEmail?: boolean; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** @@ -4437,15 +3982,11 @@ export namespace calendar_v3 { */ eventId?: string; /** - * The maximum number of attendees to include in the response. If there are - * more than the specified number of attendees, only the participant is - * returned. Optional. + * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. */ maxAttendees?: number; /** - * Maximum number of events returned on one result page. By default the - * value is 250 events. The page size can never be larger than 2500 events. - * Optional. + * Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. */ maxResults?: number; /** @@ -4457,26 +3998,19 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Whether to include deleted events (with status equals "cancelled") in the - * result. Cancelled instances of recurring events will still be included if - * singleEvents is False. Optional. The default is False. + * Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False. */ showDeleted?: boolean; /** - * Upper bound (exclusive) for an event's start time to filter by. Optional. - * The default is not to filter by start time. Must be an RFC3339 timestamp - * with mandatory time zone offset. + * Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset. */ timeMax?: string; /** - * Lower bound (inclusive) for an event's end time to filter by. Optional. - * The default is not to filter by end time. Must be an RFC3339 timestamp - * with mandatory time zone offset. + * Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset. */ timeMin?: string; /** - * Time zone used in the response. Optional. The default is the time zone of - * the calendar. + * Time zone used in the response. Optional. The default is the time zone of the calendar. */ timeZone?: string; } @@ -4487,43 +4021,27 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to always include a value in the email field for the organizer, - * creator and attendees, even if no real email is available (i.e. a - * generated, non-working value will be provided). The use of this option is - * discouraged and should only be used by clients which cannot handle the - * absence of an email address value in the mentioned places. Optional. The - * default is False. + * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. */ alwaysIncludeEmail?: boolean; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Specifies event ID in the iCalendar format to be included in the - * response. Optional. + * Specifies event ID in the iCalendar format to be included in the response. Optional. */ iCalUID?: string; /** - * The maximum number of attendees to include in the response. If there are - * more than the specified number of attendees, only the participant is - * returned. Optional. + * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. */ maxAttendees?: number; /** - * Maximum number of events returned on one result page. The number of - * events in the resulting page may be less than this value, or none at all, - * even if there are more events matching the query. Incomplete pages can be - * detected by a non-empty nextPageToken field in the response. By default - * the value is 250 events. The page size can never be larger than 2500 - * events. Optional. + * Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. */ maxResults?: number; /** - * The order of the events returned in the result. Optional. The default is - * an unspecified, stable order. + * The order of the events returned in the result. Optional. The default is an unspecified, stable order. */ orderBy?: string; /** @@ -4531,84 +4049,47 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Extended properties constraint specified as propertyName=value. Matches - * only private properties. This parameter might be repeated multiple times - * to return events that match all given constraints. + * Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. */ privateExtendedProperty?: string[]; /** - * Free text search terms to find events that match these terms in any - * field, except for extended properties. Optional. + * Free text search terms to find events that match these terms in any field, except for extended properties. Optional. */ q?: string; /** - * Extended properties constraint specified as propertyName=value. Matches - * only shared properties. This parameter might be repeated multiple times - * to return events that match all given constraints. + * Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. */ sharedExtendedProperty?: string[]; /** - * Whether to include deleted events (with status equals "cancelled") in the - * result. Cancelled instances of recurring events (but not the underlying - * recurring event) will still be included if showDeleted and singleEvents - * are both False. If showDeleted and singleEvents are both True, only - * single instances of deleted events (but not the underlying recurring - * events) are returned. Optional. The default is False. + * Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. */ showDeleted?: boolean; /** - * Whether to include hidden invitations in the result. Optional. The - * default is False. + * Whether to include hidden invitations in the result. Optional. The default is False. */ showHiddenInvitations?: boolean; /** - * Whether to expand recurring events into instances and only return single - * one-off events and instances of recurring events, but not the underlying - * recurring events themselves. Optional. The default is False. + * Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. */ singleEvents?: boolean; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. All events - * deleted since the previous list request will always be in the result set - * and it is not allowed to set showDeleted to False. There are several - * query parameters that cannot be specified together with nextSyncToken to - * ensure consistency of the client state. These are: - iCalUID - orderBy - * - privateExtendedProperty - q - sharedExtendedProperty - timeMin - - * timeMax - updatedMin If the syncToken expires, the server will respond - * with a 410 GONE response code and the client should clear its storage and - * perform a full synchronization without any syncToken. Learn more about - * incremental synchronization. Optional. The default is to return all - * entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; /** - * Upper bound (exclusive) for an event's end time to filter by. Optional. - * The default is not to filter by end time. Must be an RFC3339 timestamp - * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, - * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If - * timeMin is set, timeMax must be greater than timeMin. + * Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. */ timeMax?: string; /** - * Lower bound (inclusive) for an event's start time to filter by. Optional. - * The default is not to filter by start time. Must be an RFC3339 timestamp - * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, - * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If - * timeMax is set, timeMin must be smaller than timeMax. + * Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. */ timeMin?: string; /** - * Time zone used in the response. Optional. The default is the time zone of - * the calendar. + * Time zone used in the response. Optional. The default is the time zone of the calendar. */ timeZone?: string; /** - * Lower bound for an event's last modification time (as a RFC3339 - * timestamp) to filter by. When specified, entries deleted since this time - * will always be included regardless of showDeleted. Optional. The default - * is not to filter by last modification time. + * Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. */ updatedMin?: string; } @@ -4619,13 +4100,11 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier of the source calendar where the event currently is - * on. + * Calendar identifier of the source calendar where the event currently is on. */ calendarId?: string; /** - * Calendar identifier of the target calendar where the event is to be moved - * to. + * Calendar identifier of the target calendar where the event is to be moved to. */ destination?: string; /** @@ -4633,15 +4112,11 @@ export namespace calendar_v3 { */ eventId?: string; /** - * Deprecated. Please use sendUpdates instead. Whether to send - * notifications about the change of the event's organizer. Note that some - * emails might still be sent even if you set the value to false. The - * default is false. + * Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false. */ sendNotifications?: boolean; /** - * Guests who should receive notifications about the change of the event's - * organizer. + * Guests who should receive notifications about the change of the event's organizer. */ sendUpdates?: string; } @@ -4652,26 +4127,15 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to always include a value in the email field for the organizer, - * creator and attendees, even if no real email is available (i.e. a - * generated, non-working value will be provided). The use of this option is - * discouraged and should only be used by clients which cannot handle the - * absence of an email address value in the mentioned places. Optional. The - * default is False. + * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. */ alwaysIncludeEmail?: boolean; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Version number of conference data supported by the API client. Version 0 - * assumes no conference data support and ignores conference data in the - * event's body. Version 1 enables support for copying of ConferenceData as - * well as for creating new conferences using the createRequest field of - * conferenceData. The default is 0. + * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. */ conferenceDataVersion?: number; /** @@ -4679,26 +4143,19 @@ export namespace calendar_v3 { */ eventId?: string; /** - * The maximum number of attendees to include in the response. If there are - * more than the specified number of attendees, only the participant is - * returned. Optional. + * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. */ maxAttendees?: number; /** - * Deprecated. Please use sendUpdates instead. Whether to send - * notifications about the event update (for example, description changes, - * etc.). Note that some emails might still be sent even if you set the - * value to false. The default is false. + * Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false. */ sendNotifications?: boolean; /** - * Guests who should receive notifications about the event update (for - * example, title changes, etc.). + * Guests who should receive notifications about the event update (for example, title changes, etc.). */ sendUpdates?: string; /** - * Whether API client performing operation supports event attachments. - * Optional. The default is False. + * Whether API client performing operation supports event attachments. Optional. The default is False. */ supportsAttachments?: boolean; @@ -4714,21 +4171,15 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Deprecated. Please use sendUpdates instead. Whether to send - * notifications about the creation of the event. Note that some emails - * might still be sent even if you set the value to false. The default is - * false. + * Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false. */ sendNotifications?: boolean; /** - * Guests who should receive notifications about the creation of the new - * event. + * Guests who should receive notifications about the creation of the new event. */ sendUpdates?: string; /** @@ -4743,26 +4194,15 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to always include a value in the email field for the organizer, - * creator and attendees, even if no real email is available (i.e. a - * generated, non-working value will be provided). The use of this option is - * discouraged and should only be used by clients which cannot handle the - * absence of an email address value in the mentioned places. Optional. The - * default is False. + * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. */ alwaysIncludeEmail?: boolean; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Version number of conference data supported by the API client. Version 0 - * assumes no conference data support and ignores conference data in the - * event's body. Version 1 enables support for copying of ConferenceData as - * well as for creating new conferences using the createRequest field of - * conferenceData. The default is 0. + * Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. */ conferenceDataVersion?: number; /** @@ -4770,26 +4210,19 @@ export namespace calendar_v3 { */ eventId?: string; /** - * The maximum number of attendees to include in the response. If there are - * more than the specified number of attendees, only the participant is - * returned. Optional. + * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. */ maxAttendees?: number; /** - * Deprecated. Please use sendUpdates instead. Whether to send - * notifications about the event update (for example, description changes, - * etc.). Note that some emails might still be sent even if you set the - * value to false. The default is false. + * Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false. */ sendNotifications?: boolean; /** - * Guests who should receive notifications about the event update (for - * example, title changes, etc.). + * Guests who should receive notifications about the event update (for example, title changes, etc.). */ sendUpdates?: string; /** - * Whether API client performing operation supports event attachments. - * Optional. The default is False. + * Whether API client performing operation supports event attachments. Optional. The default is False. */ supportsAttachments?: boolean; @@ -4805,43 +4238,27 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to always include a value in the email field for the organizer, - * creator and attendees, even if no real email is available (i.e. a - * generated, non-working value will be provided). The use of this option is - * discouraged and should only be used by clients which cannot handle the - * absence of an email address value in the mentioned places. Optional. The - * default is False. + * Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. */ alwaysIncludeEmail?: boolean; /** - * Calendar identifier. To retrieve calendar IDs call the calendarList.list - * method. If you want to access the primary calendar of the currently - * logged in user, use the "primary" keyword. + * Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. */ calendarId?: string; /** - * Specifies event ID in the iCalendar format to be included in the - * response. Optional. + * Specifies event ID in the iCalendar format to be included in the response. Optional. */ iCalUID?: string; /** - * The maximum number of attendees to include in the response. If there are - * more than the specified number of attendees, only the participant is - * returned. Optional. + * The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. */ maxAttendees?: number; /** - * Maximum number of events returned on one result page. The number of - * events in the resulting page may be less than this value, or none at all, - * even if there are more events matching the query. Incomplete pages can be - * detected by a non-empty nextPageToken field in the response. By default - * the value is 250 events. The page size can never be larger than 2500 - * events. Optional. + * Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. */ maxResults?: number; /** - * The order of the events returned in the result. Optional. The default is - * an unspecified, stable order. + * The order of the events returned in the result. Optional. The default is an unspecified, stable order. */ orderBy?: string; /** @@ -4849,84 +4266,47 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Extended properties constraint specified as propertyName=value. Matches - * only private properties. This parameter might be repeated multiple times - * to return events that match all given constraints. + * Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. */ privateExtendedProperty?: string[]; /** - * Free text search terms to find events that match these terms in any - * field, except for extended properties. Optional. + * Free text search terms to find events that match these terms in any field, except for extended properties. Optional. */ q?: string; /** - * Extended properties constraint specified as propertyName=value. Matches - * only shared properties. This parameter might be repeated multiple times - * to return events that match all given constraints. + * Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. */ sharedExtendedProperty?: string[]; /** - * Whether to include deleted events (with status equals "cancelled") in the - * result. Cancelled instances of recurring events (but not the underlying - * recurring event) will still be included if showDeleted and singleEvents - * are both False. If showDeleted and singleEvents are both True, only - * single instances of deleted events (but not the underlying recurring - * events) are returned. Optional. The default is False. + * Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. */ showDeleted?: boolean; /** - * Whether to include hidden invitations in the result. Optional. The - * default is False. + * Whether to include hidden invitations in the result. Optional. The default is False. */ showHiddenInvitations?: boolean; /** - * Whether to expand recurring events into instances and only return single - * one-off events and instances of recurring events, but not the underlying - * recurring events themselves. Optional. The default is False. + * Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. */ singleEvents?: boolean; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. All events - * deleted since the previous list request will always be in the result set - * and it is not allowed to set showDeleted to False. There are several - * query parameters that cannot be specified together with nextSyncToken to - * ensure consistency of the client state. These are: - iCalUID - orderBy - * - privateExtendedProperty - q - sharedExtendedProperty - timeMin - - * timeMax - updatedMin If the syncToken expires, the server will respond - * with a 410 GONE response code and the client should clear its storage and - * perform a full synchronization without any syncToken. Learn more about - * incremental synchronization. Optional. The default is to return all - * entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; /** - * Upper bound (exclusive) for an event's end time to filter by. Optional. - * The default is not to filter by end time. Must be an RFC3339 timestamp - * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, - * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If - * timeMin is set, timeMax must be greater than timeMin. + * Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. */ timeMax?: string; /** - * Lower bound (inclusive) for an event's start time to filter by. Optional. - * The default is not to filter by start time. Must be an RFC3339 timestamp - * with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, - * 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If - * timeMax is set, timeMin must be smaller than timeMax. + * Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. */ timeMin?: string; /** - * Time zone used in the response. Optional. The default is the time zone of - * the calendar. + * Time zone used in the response. Optional. The default is the time zone of the calendar. */ timeZone?: string; /** - * Lower bound for an event's last modification time (as a RFC3339 - * timestamp) to filter by. When specified, entries deleted since this time - * will always be included regardless of showDeleted. Optional. The default - * is not to filter by last modification time. + * Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. */ updatedMin?: string; @@ -5271,9 +4651,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of entries returned on one result page. By default the - * value is 100 entries. The page size can never be larger than 250 entries. - * Optional. + * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. */ maxResults?: number; /** @@ -5281,13 +4659,7 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. If the - * syncToken expires, the server will respond with a 410 GONE response code - * and the client should clear its storage and perform a full - * synchronization without any syncToken. Learn more about incremental - * synchronization. Optional. The default is to return all entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; } @@ -5298,9 +4670,7 @@ export namespace calendar_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of entries returned on one result page. By default the - * value is 100 entries. The page size can never be larger than 250 entries. - * Optional. + * Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. */ maxResults?: number; /** @@ -5308,13 +4678,7 @@ export namespace calendar_v3 { */ pageToken?: string; /** - * Token obtained from the nextSyncToken field returned on the last page of - * results from the previous list request. It makes the result of this list - * request contain only entries that have changed since then. If the - * syncToken expires, the server will respond with a 410 GONE response code - * and the client should clear its storage and perform a full - * synchronization without any syncToken. Learn more about incremental - * synchronization. Optional. The default is to return all entries. + * Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. */ syncToken?: string; diff --git a/src/apis/chat/package.json b/src/apis/chat/package.json index 7ca18296636..3b119f2b71c 100644 --- a/src/apis/chat/package.json +++ b/src/apis/chat/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index ef814867101..ac5ae137155 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace chat_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace chat_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,17 +108,17 @@ export namespace chat_v1 { spaces: Resource$Spaces; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.spaces = new Resource$Spaces(this.context); } } /** - * List of string parameters to supply when the action method is invoked. For - * example, consider three snooze buttons: snooze now, snooze 1 day, snooze - * next week. You might use action method = snooze(), passing the snooze type - * and snooze time in the list of string parameters. + * List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters. */ export interface Schema$ActionParameter { /** @@ -143,32 +139,20 @@ export namespace chat_v1 { */ type?: string; /** - * URL for users to auth or config. (Only for REQUEST_CONFIG response - * types.) + * URL for users to auth or config. (Only for REQUEST_CONFIG response types.) */ url?: string; } /** - * Annotations associated with the plain-text body of the message. Example - * plain-text message body: ``` Hello @FooBot how are you!" ``` The - * corresponding annotations metadata: ``` "annotations":[{ - * "type":"USER_MENTION", "startIndex":6, - * "length":7, "userMention": { "user": { - * "name":"users/107946847022116401880", - * "displayName":"FooBot", - * "avatarUrl":"https://goo.gl/aeDtrS", - * "type":"BOT" }, - * "type":"MENTION" } }] ``` + * Annotations associated with the plain-text body of the message. Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/107946847022116401880", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` */ export interface Schema$Annotation { /** - * Length of the substring in the plain-text message body this annotation - * corresponds to. + * Length of the substring in the plain-text message body this annotation corresponds to. */ length?: number; /** - * Start index (0-based, inclusive) in the plain-text message body this - * annotation corresponds to. + * Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to. */ startIndex?: number; /** @@ -215,9 +199,7 @@ export namespace chat_v1 { sections?: Schema$Section[]; } /** - * A card action is the action associated with the card. For an invoice card, - * a typical action would be: delete invoice, email invoice or open the - * invoice in browser. + * A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser. */ export interface Schema$CardAction { /** @@ -243,9 +225,7 @@ export namespace chat_v1 { */ subtitle?: string; /** - * The title must be specified. The header has a fixed height: if both a - * title and subtitle is specified, each will take up 1 line. If only the - * title is specified, it will take up both lines. + * The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each will take up 1 line. If only the title is specified, it will take up both lines. */ title?: string; } @@ -254,16 +234,11 @@ export namespace chat_v1 { */ export interface Schema$DeprecatedEvent { /** - * The form action data associated with an interactive card that was - * clicked. Only populated for CARD_CLICKED events. See the [Interactive - * Cards guide](/hangouts/chat/how-tos/cards-onclick) for more information. + * The form action data associated with an interactive card that was clicked. Only populated for CARD_CLICKED events. See the [Interactive Cards guide](/hangouts/chat/how-tos/cards-onclick) for more information. */ action?: Schema$FormAction; /** - * The URL the bot should redirect the user to after they have completed an - * authorization or configuration flow outside of Hangouts Chat. See the - * [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p) - * for more information. + * The URL the bot should redirect the user to after they have completed an authorization or configuration flow outside of Hangouts Chat. See the [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p) for more information. */ configCompleteRedirectUrl?: string; /** @@ -279,17 +254,11 @@ export namespace chat_v1 { */ space?: Schema$Space; /** - * The bot-defined key for the thread related to the event. See the - * thread_key field of the `spaces.message.create` request for more - * information. + * The bot-defined key for the thread related to the event. See the thread_key field of the `spaces.message.create` request for more information. */ threadKey?: string; /** - * A secret value that bots can use to verify if a request is from Google. - * The token is randomly generated by Google, remains static, and can be - * obtained from the Hangouts Chat API configuration page in the Cloud - * Console. Developers can revoke/regenerate it if needed from the same - * page. + * A secret value that bots can use to verify if a request is from Google. The token is randomly generated by Google, remains static, and can be obtained from the Hangouts Chat API configuration page in the Cloud Console. Developers can revoke/regenerate it if needed from the same page. */ token?: string; /** @@ -302,21 +271,15 @@ export namespace chat_v1 { user?: Schema$User; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A form action describes the behavior when the form is submitted. For - * example, an Apps Script can be invoked to handle the form. + * A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. */ export interface Schema$FormAction { /** - * Apps Script function to invoke when the containing element is - * clicked/activated. + * Apps Script function to invoke when the containing element is clicked/activated. */ actionMethodName?: string; /** @@ -346,8 +309,7 @@ export namespace chat_v1 { */ export interface Schema$ImageButton { /** - * The icon specified by an enum that indices to an icon provided by Chat - * API. + * The icon specified by an enum that indices to an icon provided by Chat API. */ icon?: string; /** @@ -355,8 +317,7 @@ export namespace chat_v1 { */ iconUrl?: string; /** - * The name of this image_button which will be used for accessibility. - * Default value will be provided if developers don't specify. + * The name of this image_button which will be used for accessibility. Default value will be provided if developers don't specify. */ name?: string; /** @@ -365,8 +326,7 @@ export namespace chat_v1 { onClick?: Schema$OnClick; } /** - * A UI element contains a key (label) and a value (content). And this element - * may also contain some actions such as onclick button. + * A UI element contains a key (label) and a value (content). And this element may also contain some actions such as onclick button. */ export interface Schema$KeyValue { /** @@ -386,8 +346,7 @@ export namespace chat_v1 { */ contentMultiline?: boolean; /** - * An enum value that will be replaced by the Chat API with the - * corresponding icon image. + * An enum value that will be replaced by the Chat API with the corresponding icon image. */ icon?: string; /** @@ -395,8 +354,7 @@ export namespace chat_v1 { */ iconUrl?: string; /** - * The onclick action. Only the top label, bottom label and content region - * are clickable. + * The onclick action. Only the top label, bottom label and content region are clickable. */ onClick?: Schema$OnClick; /** @@ -410,16 +368,13 @@ export namespace chat_v1 { */ memberships?: Schema$Membership[]; /** - * Continuation token to retrieve the next page of results. It will be empty - * for the last page of results. + * Continuation token to retrieve the next page of results. It will be empty for the last page of results. */ nextPageToken?: string; } export interface Schema$ListSpacesResponse { /** - * Continuation token to retrieve the next page of results. It will be empty - * for the last page of results. Tokens expire in an hour. An error is - * thrown if an expired token is passed. + * Continuation token to retrieve the next page of results. It will be empty for the last page of results. Tokens expire in an hour. An error is thrown if an expired token is passed. */ nextPageToken?: string; /** @@ -432,8 +387,7 @@ export namespace chat_v1 { */ export interface Schema$Membership { /** - * The creation time of the membership a.k.a the time at which the member - * joined the space, if applicable. + * The creation time of the membership a.k.a the time at which the member joined the space, if applicable. */ createTime?: string; /** @@ -441,9 +395,7 @@ export namespace chat_v1 { */ member?: Schema$User; /** - * Resource name of the membership, in the form - * "spaces/x/members/*". Example: - * spaces/AAAAMpdlehY/members/105115627578887013105 + * Resource name of the membership, in the form "spaces/x/members/*". Example: spaces/AAAAMpdlehY/members/105115627578887013105 */ name?: string; /** @@ -456,8 +408,7 @@ export namespace chat_v1 { */ export interface Schema$Message { /** - * Input only. Parameters that a bot can use to configure how its response - * is posted. + * Input only. Parameters that a bot can use to configure how its response is posted. */ actionResponse?: Schema$ActionResponse; /** @@ -469,30 +420,23 @@ export namespace chat_v1 { */ argumentText?: string; /** - * Rich, formatted and interactive cards that can be used to display UI - * elements such as: formatted texts, buttons, clickable images. Cards are - * normally displayed below the plain-text body of the message. + * Rich, formatted and interactive cards that can be used to display UI elements such as: formatted texts, buttons, clickable images. Cards are normally displayed below the plain-text body of the message. */ cards?: Schema$Card[]; /** - * Output only. The time at which the message was created in Hangouts Chat - * server. + * Output only. The time at which the message was created in Hangouts Chat server. */ createTime?: string; /** - * A plain-text description of the message's cards, used when the actual - * cards cannot be displayed (e.g. mobile notifications). + * A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). */ fallbackText?: string; /** - * Resource name, in the form "spaces/x/messages/*". Example: - * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 + * Resource name, in the form "spaces/x/messages/*". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 */ name?: string; /** - * Text for generating preview chips. This text will not be displayed to the - * user, but any links to images, web pages, videos, etc. included here will - * generate preview chips. + * Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. */ previewText?: string; /** @@ -535,10 +479,7 @@ export namespace chat_v1 { url?: string; } /** - * A section contains a collection of widgets that are rendered (vertically) - * in the order that they are specified. Across all platforms, cards have a - * narrow fixed width, so there is currently no need for layout properties - * (e.g. float). + * A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there is currently no need for layout properties (e.g. float). */ export interface Schema$Section { /** @@ -559,8 +500,7 @@ export namespace chat_v1 { */ displayName?: string; /** - * Resource name of the space, in the form "spaces/*". Example: - * spaces/AAAAMpdlehYs + * Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs */ name?: string; /** @@ -592,8 +532,7 @@ export namespace chat_v1 { */ export interface Schema$Thread { /** - * Resource name, in the form "spaces/x/threads/*". Example: - * spaces/AAAAMpdlehY/threads/UMxbHmzDlr4 + * Resource name, in the form "spaces/x/threads/*". Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4 */ name?: string; } @@ -632,8 +571,7 @@ export namespace chat_v1 { */ export interface Schema$WidgetMarkup { /** - * A list of buttons. Buttons is also oneof data and only one of these - * fields should be set. + * A list of buttons. Buttons is also oneof data and only one of these fields should be set. */ buttons?: Schema$Button[]; /** @@ -807,8 +745,7 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the space, in the form "spaces/x". Example: - * spaces/AAAAMpdlehY + * Required. Resource name of the space, in the form "spaces/x". Example: spaces/AAAAMpdlehY */ name?: string; } @@ -819,8 +756,7 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. The value is capped at 1000. Server may return fewer - * results than requested. If unspecified, server will default to 100. + * Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100. */ pageSize?: number; /** @@ -993,9 +929,7 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the membership to be retrieved, in the form - * "spaces/x/members/x". Example: - * spaces/AAAAMpdlehY/members/105115627578887013105 + * Required. Resource name of the membership to be retrieved, in the form "spaces/x/members/x". Example: spaces/AAAAMpdlehY/members/105115627578887013105 */ name?: string; } @@ -1007,8 +941,7 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. The value is capped at 1000. Server may return fewer - * results than requested. If unspecified, server will default to 100. + * Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100. */ pageSize?: number; /** @@ -1016,8 +949,7 @@ export namespace chat_v1 { */ pageToken?: string; /** - * Required. The resource name of the space for which membership list is to - * be fetched, in the form "spaces/x". Example: spaces/AAAAMpdlehY + * Required. The resource name of the space for which membership list is to be fetched, in the form "spaces/x". Example: spaces/AAAAMpdlehY */ parent?: string; } @@ -1320,18 +1252,11 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Space resource name, in the form "spaces/x". Example: - * spaces/AAAAMpdlehY + * Required. Space resource name, in the form "spaces/x". Example: spaces/AAAAMpdlehY */ parent?: string; /** - * Opaque thread identifier string that can be specified to group messages - * into a single thread. If this is the first message with a given thread - * identifier, a new thread is created. Subsequent messages with the same - * thread identifier will be posted into the same thread. This relieves bots - * and webhooks from having to store the Hangouts Chat thread ID of a thread - * (created earlier by them) to post further updates to it. Has no effect - * if thread field, corresponding to an existing thread, is set in message. + * Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message. */ threadKey?: string; @@ -1348,9 +1273,7 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the message to be deleted, in the form - * "spaces/x/messages/x" Example: - * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 + * Required. Resource name of the message to be deleted, in the form "spaces/x/messages/x" Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 */ name?: string; } @@ -1362,9 +1285,7 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the message to be retrieved, in the form - * "spaces/x/messages/x". Example: - * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 + * Required. Resource name of the message to be retrieved, in the form "spaces/x/messages/x". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 */ name?: string; } @@ -1376,13 +1297,11 @@ export namespace chat_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name, in the form "spaces/x/messages/x". Example: - * spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 + * Resource name, in the form "spaces/x/messages/x". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 */ name?: string; /** - * Required. The field paths to be updated. Currently supported field - * paths: "text", "cards". + * Required. The field paths to be updated. Currently supported field paths: "text", "cards". */ updateMask?: string; diff --git a/src/apis/civicinfo/package.json b/src/apis/civicinfo/package.json index 52ff18d9d7c..62abd617334 100644 --- a/src/apis/civicinfo/package.json +++ b/src/apis/civicinfo/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/civicinfo/v2.ts b/src/apis/civicinfo/v2.ts index 9c6f84f5b48..5c0ea2bab81 100644 --- a/src/apis/civicinfo/v2.ts +++ b/src/apis/civicinfo/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace civicinfo_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace civicinfo_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace civicinfo_v2 { /** * Google Civic Information API * - * Provides polling places, early vote locations, contest data, election - * officials, and government representatives for U.S. residential addresses. + * Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses. * * @example * const {google} = require('googleapis'); @@ -98,7 +94,10 @@ export namespace civicinfo_v2 { representatives: Resource$Representatives; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.divisions = new Resource$Divisions(this.context); this.elections = new Resource$Elections(this.context); @@ -115,14 +114,11 @@ export namespace civicinfo_v2 { */ electionAdministrationBody?: Schema$AdministrativeBody; /** - * An ID for this object. IDs may change in future requests and should not - * be cached. Access to this field requires special access that can be - * requested from the Request more link on the Quotas page. + * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page. */ id?: string; /** - * The city or county that provides election information for this voter. - * This object can have the same elements as state. + * The city or county that provides election information for this voter. This object can have the same elements as state. */ local_jurisdiction?: Schema$AdministrationRegion; /** @@ -130,25 +126,21 @@ export namespace civicinfo_v2 { */ name?: string; /** - * A list of sources for this area. If multiple sources are listed the data - * has been aggregated from those sources. + * A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources. */ sources?: Schema$Source[]; } /** - * Information about an election administrative body (e.g. County Board of - * Elections). + * Information about an election administrative body (e.g. County Board of Elections). */ export interface Schema$AdministrativeBody { /** - * A URL provided by this administrative body for information on absentee - * voting. + * A URL provided by this administrative body for information on absentee voting. */ absenteeVotingInfoUrl?: string; addressLines?: string[]; /** - * A URL provided by this administrative body to give contest information to - * the voter. + * A URL provided by this administrative body to give contest information to the voter. */ ballotInfoUrl?: string; /** @@ -156,8 +148,7 @@ export namespace civicinfo_v2 { */ correspondenceAddress?: Schema$SimpleAddressType; /** - * A URL provided by this administrative body for looking up general - * election information. + * A URL provided by this administrative body for looking up general election information. */ electionInfoUrl?: string; /** @@ -165,18 +156,15 @@ export namespace civicinfo_v2 { */ electionOfficials?: Schema$ElectionOfficial[]; /** - * A URL provided by this administrative body for confirming that the voter - * is registered to vote. + * A URL provided by this administrative body for confirming that the voter is registered to vote. */ electionRegistrationConfirmationUrl?: string; /** - * A URL provided by this administrative body for looking up how to register - * to vote. + * A URL provided by this administrative body for looking up how to register to vote. */ electionRegistrationUrl?: string; /** - * A URL provided by this administrative body describing election rules to - * the voter. + * A URL provided by this administrative body describing election rules to the voter. */ electionRulesUrl?: string; /** @@ -217,10 +205,7 @@ export namespace civicinfo_v2 { */ email?: string; /** - * The candidate's name. If this is a joint ticket it will indicate the - * name of the candidate at the top of a ticket followed by a / and that - * name of candidate at the bottom of the ticket. e.g. "Mitt Romney / - * Paul Ryan" + * The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan" */ name?: string; /** @@ -249,9 +234,7 @@ export namespace civicinfo_v2 { */ id?: string; /** - * The type of channel. The following is a list of types of channels, but is - * not exhaustive. More channel types may be added at a later time. One of: - * GooglePlus, YouTube, Facebook, Twitter + * The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter */ type?: string; } @@ -260,8 +243,7 @@ export namespace civicinfo_v2 { */ export interface Schema$Contest { /** - * A number specifying the position of this contest on the voter's - * ballot. + * A number specifying the position of this contest on the voter's ballot. */ ballotPlacement?: string; /** @@ -277,22 +259,15 @@ export namespace civicinfo_v2 { */ district?: Schema$ElectoralDistrict; /** - * A description of any additional eligibility requirements for voting in - * this contest. + * A description of any additional eligibility requirements for voting in this contest. */ electorateSpecifications?: string; /** - * An ID for this object. IDs may change in future requests and should not - * be cached. Access to this field requires special access that can be - * requested from the Request more link on the Quotas page. + * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page. */ id?: string; /** - * The levels of government of the office for this contest. There may be - * more than one in cases where a jurisdiction effectively acts at two - * different levels of government; for example, the mayor of the District of - * Columbia acts at "locality" level, but also effectively at both - * "administrative-area-2" and "administrative-area-1". + * The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1". */ level?: string[]; /** @@ -312,60 +287,43 @@ export namespace civicinfo_v2 { */ primaryParty?: string; /** - * The set of ballot responses for the referendum. A ballot response - * represents a line on the ballot. Common examples might include - * "yes" or "no" for referenda. This field is only - * populated for contests of type 'Referendum'. + * The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'. */ referendumBallotResponses?: string[]; /** - * Specifies a short summary of the referendum that is typically on the - * ballot below the title but above the text. This field is only populated - * for contests of type 'Referendum'. + * Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'. */ referendumBrief?: string; /** - * A statement in opposition to the referendum. It does not necessarily - * appear on the ballot. This field is only populated for contests of type - * 'Referendum'. + * A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'. */ referendumConStatement?: string; /** - * Specifies what effect abstaining (not voting) on the proposition will - * have (i.e. whether abstaining is considered a vote against it). This - * field is only populated for contests of type 'Referendum'. + * Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'. */ referendumEffectOfAbstain?: string; /** - * The threshold of votes that the referendum needs in order to pass, e.g. - * "two-thirds". This field is only populated for contests of type - * 'Referendum'. + * The threshold of votes that the referendum needs in order to pass, e.g. "two-thirds". This field is only populated for contests of type 'Referendum'. */ referendumPassageThreshold?: string; /** - * A statement in favor of the referendum. It does not necessarily appear on - * the ballot. This field is only populated for contests of type - * 'Referendum'. + * A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'. */ referendumProStatement?: string; /** - * A brief description of the referendum. This field is only populated for - * contests of type 'Referendum'. + * A brief description of the referendum. This field is only populated for contests of type 'Referendum'. */ referendumSubtitle?: string; /** - * The full text of the referendum. This field is only populated for - * contests of type 'Referendum'. + * The full text of the referendum. This field is only populated for contests of type 'Referendum'. */ referendumText?: string; /** - * The title of the referendum (e.g. 'Proposition 42'). This field - * is only populated for contests of type 'Referendum'. + * The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'. */ referendumTitle?: string; /** - * A link to the referendum. This field is only populated for contests of - * type 'Referendum'. + * A link to the referendum. This field is only populated for contests of type 'Referendum'. */ referendumUrl?: string; /** @@ -373,20 +331,15 @@ export namespace civicinfo_v2 { */ roles?: string[]; /** - * A list of sources for this contest. If multiple sources are listed, the - * data has been aggregated from those sources. + * A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources. */ sources?: Schema$Source[]; /** - * "Yes" or "No" depending on whether this a contest - * being held outside the normal election cycle. + * "Yes" or "No" depending on whether this a contest being held outside the normal election cycle. */ special?: string; /** - * The type of contest. Usually this will be 'General', - * 'Primary', or 'Run-off' for contests with candidates. For - * referenda this will be 'Referendum'. For Retention contests this - * will typically be 'Retention'. + * The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'. For Retention contests this will typically be 'Retention'. */ type?: string; } @@ -410,24 +363,17 @@ export namespace civicinfo_v2 { */ export interface Schema$DivisionSearchResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "civicinfo#divisionSearchResponse". + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse". */ kind?: string; results?: Schema$DivisionSearchResult[]; } /** - * Represents a political geographic division that matches the requested - * query. + * Represents a political geographic division that matches the requested query. */ export interface Schema$DivisionSearchResult { /** - * Other Open Civic Data identifiers that refer to the same division -- for - * example, those that refer to other political divisions whose boundaries - * are defined to be coterminous with this one. For example, - * ocd-division/country:us/state:wy will include an alias of - * ocd-division/country:us/state:wy/cd:1, since Wyoming has only one - * Congressional district. + * Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district. */ aliases?: string[]; /** @@ -456,11 +402,7 @@ export namespace civicinfo_v2 { */ name?: string; /** - * The political division of the election. Represented as an OCD Division - * ID. Voters within these political jurisdictions are covered by this - * election. This is typically a state such as - * ocd-division/country:us/state:ca or for the midterms or general election - * the entire US (i.e. ocd-division/country:us). + * The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us). */ ocdDivisionId?: string; } @@ -501,8 +443,7 @@ export namespace civicinfo_v2 { */ elections?: Schema$Election[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "civicinfo#electionsQueryResponse". + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse". */ kind?: string; } @@ -511,9 +452,7 @@ export namespace civicinfo_v2 { */ export interface Schema$ElectoralDistrict { /** - * An identifier for this district, relative to its scope. For example, the - * 34th State Senate district would have id "34" and a scope of - * stateUpper. + * An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper. */ id?: string; kgForeignKey?: string; @@ -522,10 +461,7 @@ export namespace civicinfo_v2 { */ name?: string; /** - * The geographic scope of this district. If unspecified the district's - * geography is not known. One of: national, statewide, congressional, - * stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, - * township, countyCouncil, cityCouncil, ward, special + * The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special */ scope?: string; } @@ -537,15 +473,7 @@ export namespace civicinfo_v2 { */ export interface Schema$GeographicDivision { /** - * Any other valid OCD IDs that refer to the same division. Because OCD IDs - * are meant to be human-readable and at least somewhat predictable, there - * are occasionally several identifiers for a single division. These - * identifiers are defined to be equivalent to one another, and one is - * always indicated as the primary identifier. The primary identifier will - * be returned in ocd_id above, and any other equivalent valid identifiers - * will be returned in this list. For example, if this division's OCD - * ID is ocd-division/country:us/district:dc, this will contain - * ocd-division/country:us/state:dc. + * Any other valid OCD IDs that refer to the same division. Because OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list. For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc. */ alsoKnownAs?: string[]; /** @@ -553,9 +481,7 @@ export namespace civicinfo_v2 { */ name?: string; /** - * List of indices in the offices array, one for each office elected from - * this division. Will only be present if includeOffices was true (or - * absent) in the request. + * List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request. */ officeIndices?: number[]; } @@ -600,11 +526,7 @@ export namespace civicinfo_v2 { */ divisionId?: string; /** - * The levels of government of which this office is part. There may be more - * than one in cases where a jurisdiction effectively acts at two different - * levels of government; for example, the mayor of the District of Columbia - * acts at "locality" level, but also effectively at both - * "administrative-area-2" and "administrative-area-1". + * The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1". */ levels?: string[]; /** @@ -612,20 +534,15 @@ export namespace civicinfo_v2 { */ name?: string; /** - * List of indices in the officials array of people who presently hold this - * office. + * List of indices in the officials array of people who presently hold this office. */ officialIndices?: number[]; /** - * The roles which this office fulfills. Roles are not meant to be - * exhaustive, or to exactly specify the entire set of responsibilities of a - * given office, but are meant to be rough categories that are useful for - * general selection from or sorting of a list of offices. + * The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices. */ roles?: string[]; /** - * A list of sources for this office. If multiple sources are listed, the - * data has been aggregated from those sources. + * A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources. */ sources?: Schema$Source[]; } @@ -673,9 +590,7 @@ export namespace civicinfo_v2 { temporaryData?: Schema$MessageSet; } /** - * A location where a voter can vote. This may be an early vote site, an - * election day voting location, or a drop off location for a completed - * ballot. + * A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot. */ export interface Schema$PollingLocation { /** @@ -683,33 +598,23 @@ export namespace civicinfo_v2 { */ address?: Schema$SimpleAddressType; /** - * The last date that this early vote site or drop off location may be used. - * This field is not populated for polling locations. + * The last date that this early vote site or drop off location may be used. This field is not populated for polling locations. */ endDate?: string; /** - * An ID for this object. IDs may change in future requests and should not - * be cached. Access to this field requires special access that can be - * requested from the Request more link on the Quotas page. + * An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page. */ id?: string; /** - * Latitude of the location, in degrees north of the equator. Only some - * locations -- generally, ballot drop boxes for vote-by-mail elections -- - * will have this set; for others, use a geocoding service like the Google - * Maps API to resolve the address to a geographic point. + * Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point. */ latitude?: number; /** - * Longitude of the location, in degrees east of the Prime Meridian. Only - * some locations -- generally, ballot drop boxes for vote-by-mail elections - * -- will have this set; for others, use a geocoding service like the - * Google Maps API to resolve the address to a geographic point. + * Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point. */ longitude?: number; /** - * The name of the early vote site or drop off location. This field is not - * populated for polling locations. + * The name of the early vote site or drop off location. This field is not populated for polling locations. */ name?: string; /** @@ -721,18 +626,15 @@ export namespace civicinfo_v2 { */ pollingHours?: string; /** - * A list of sources for this location. If multiple sources are listed the - * data has been aggregated from those sources. + * A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources. */ sources?: Schema$Source[]; /** - * The first date that this early vote site or drop off location may be - * used. This field is not populated for polling locations. + * The first date that this early vote site or drop off location may be used. This field is not populated for polling locations. */ startDate?: string; /** - * The services provided by this early vote site or drop off location. This - * field is not populated for polling locations. + * The services provided by this early vote site or drop off location. This field is not populated for polling locations. */ voterServices?: string; } @@ -776,19 +678,16 @@ export namespace civicinfo_v2 { */ divisions?: {[key: string]: Schema$GeographicDivision}; /** - * Elected offices referenced by the divisions listed above. Will only be - * present if includeOffices was true in the request. + * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request. */ offices?: Schema$Office[]; /** - * Officials holding the offices listed above. Will only be present if - * includeOffices was true in the request. + * Officials holding the offices listed above. Will only be present if includeOffices was true in the request. */ officials?: Schema$Official[]; } /** - * A request for political geography and representative information for an - * address. + * A request for political geography and representative information for an address. */ export interface Schema$RepresentativeInfoRequest { contextParams?: Schema$ContextParams; @@ -802,8 +701,7 @@ export namespace civicinfo_v2 { */ divisions?: {[key: string]: Schema$GeographicDivision}; /** - * Identifies what kind of resource this is. Value: the fixed string - * "civicinfo#representativeInfoResponse". + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse". */ kind?: string; /** @@ -811,13 +709,11 @@ export namespace civicinfo_v2 { */ normalizedInput?: Schema$SimpleAddressType; /** - * Elected offices referenced by the divisions listed above. Will only be - * present if includeOffices was true in the request. + * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request. */ offices?: Schema$Office[]; /** - * Officials holding the offices listed above. Will only be present if - * includeOffices was true in the request. + * Officials holding the offices listed above. Will only be present if includeOffices was true in the request. */ officials?: Schema$Official[]; } @@ -933,16 +829,11 @@ export namespace civicinfo_v2 { */ contests?: Schema$Contest[]; /** - * Locations where a voter is eligible to drop off a completed ballot. The - * voter must have received and completed a ballot prior to arriving at the - * location. The location may not have ballots available on the premises. - * These locations could be open on or before election day as indicated in - * the pollingHours field. + * Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field. */ dropOffLocations?: Schema$PollingLocation[]; /** - * Locations where the voter is eligible to vote early, prior to election - * day. + * Locations where the voter is eligible to vote early, prior to election day. */ earlyVoteSites?: Schema$PollingLocation[]; /** @@ -950,13 +841,11 @@ export namespace civicinfo_v2 { */ election?: Schema$Election; /** - * Identifies what kind of resource this is. Value: the fixed string - * "civicinfo#voterInfoResponse". + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse". */ kind?: string; /** - * Specifies whether voters in the precinct vote only by mailing their - * ballots (with the possible option of dropping off their ballots as well). + * Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well). */ mailOnly?: boolean; /** @@ -964,16 +853,7 @@ export namespace civicinfo_v2 { */ normalizedInput?: Schema$SimpleAddressType; /** - * When there are multiple elections for a voter address, the otherElections - * field is populated in the API response and there are two - * possibilities: 1. If the earliest election is not the intended election, - * specify the election ID of the desired election in a second API request - * using the electionId field. 2. If these elections occur on the same day, - * the API doesn?t return any polling location, contest, or election - * official information to ensure that an additional query is made. For - * user-facing applications, we recommend displaying these elections to the - * user to disambiguate. A second API request using the electionId field - * should be made for the election that is relevant to the user. + * When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user. */ otherElections?: Schema$Election[]; /** @@ -983,8 +863,7 @@ export namespace civicinfo_v2 { precinctId?: string; segments?: Schema$StreetSegment[]; /** - * Local Election Information for the state that the voter votes in. For the - * US, there will only be one element in this array. + * Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array. */ state?: Schema$AdministrationRegion[]; } @@ -1085,11 +964,7 @@ export namespace civicinfo_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The search query. Queries can cover any parts of a OCD ID or a human - * readable division name. All words given in the query are treated as - * required patterns. In addition to that, most query operators of the - * Apache Lucene library are supported. See - * http://lucene.apache.org/core/2_9_4/queryparsersyntax.html + * The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html */ query?: string; @@ -1185,8 +1060,7 @@ export namespace civicinfo_v2 { /** * civicinfo.elections.voterInfoQuery - * @desc Looks up information relevant to a voter based on the voter's - * registered address. + * @desc Looks up information relevant to a voter based on the voter's registered address. * @alias civicinfo.elections.voterInfoQuery * @memberOf! () * @@ -1289,11 +1163,7 @@ export namespace civicinfo_v2 { */ address?: string; /** - * The unique ID of the election to look up. A list of election IDs can be - * obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no - * election ID is specified in the query and there is more than one election - * with data for the given voter, the additional elections are provided in - * the otherElections response field. + * The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field. */ electionId?: string; /** @@ -1301,9 +1171,7 @@ export namespace civicinfo_v2 { */ officialOnly?: boolean; /** - * If set to true, the query will return the success codeand include any - * partial information when it is unable to determine a matching address or - * unable to determine the election for electionId=0 queries. + * If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries. */ returnAllAvailableData?: boolean; @@ -1321,8 +1189,7 @@ export namespace civicinfo_v2 { /** * civicinfo.representatives.representativeInfoByAddress - * @desc Looks up political geography and representative information for a - * single address. + * @desc Looks up political geography and representative information for a single address. * @alias civicinfo.representatives.representativeInfoByAddress * @memberOf! () * @@ -1407,8 +1274,7 @@ export namespace civicinfo_v2 { /** * civicinfo.representatives.representativeInfoByDivision - * @desc Looks up representative information for a single geographic - * division. + * @desc Looks up representative information for a single geographic division. * @alias civicinfo.representatives.representativeInfoByDivision * @memberOf! () * @@ -1497,25 +1363,19 @@ export namespace civicinfo_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The address to look up. May only be specified if the field ocdId is not - * given in the URL. + * The address to look up. May only be specified if the field ocdId is not given in the URL. */ address?: string; /** - * Whether to return information about offices and officials. If false, only - * the top-level district information will be returned. + * Whether to return information about offices and officials. If false, only the top-level district information will be returned. */ includeOffices?: boolean; /** - * A list of office levels to filter by. Only offices that serve at least - * one of these levels will be returned. Divisions that don't contain a - * matching office will not be returned. + * A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. */ levels?: string[]; /** - * A list of office roles to filter by. Only offices fulfilling one of these - * roles will be returned. Divisions that don't contain a matching office - * will not be returned. + * A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. */ roles?: string[]; @@ -1532,9 +1392,7 @@ export namespace civicinfo_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of office levels to filter by. Only offices that serve at least - * one of these levels will be returned. Divisions that don't contain a - * matching office will not be returned. + * A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. */ levels?: string[]; /** @@ -1542,16 +1400,11 @@ export namespace civicinfo_v2 { */ ocdId?: string; /** - * If true, information about all divisions contained in the division - * requested will be included as well. For example, if querying - * ocd-division/country:us/district:dc, this would also return all DC's - * wards and ANCs. + * If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs. */ recursive?: boolean; /** - * A list of office roles to filter by. Only offices fulfilling one of these - * roles will be returned. Divisions that don't contain a matching office - * will not be returned. + * A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. */ roles?: string[]; diff --git a/src/apis/classroom/package.json b/src/apis/classroom/package.json index 32a43bc9942..c77f9ebbc4c 100644 --- a/src/apis/classroom/package.json +++ b/src/apis/classroom/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 94cf0a6e73c..bfb5cac32bb 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace classroom_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace classroom_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -115,7 +111,10 @@ export namespace classroom_v1 { userProfiles: Resource$Userprofiles; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.courses = new Resource$Courses(this.context); this.invitations = new Resource$Invitations(this.context); @@ -129,13 +128,11 @@ export namespace classroom_v1 { */ export interface Schema$Announcement { /** - * Absolute link to this announcement in the Classroom web UI. This is only - * populated if `state` is `PUBLISHED`. Read-only. + * Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. */ alternateLink?: string; /** - * Assignee mode of the announcement. If unspecified, the default value is - * `ALL_STUDENTS`. + * Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`. */ assigneeMode?: string; /** @@ -151,20 +148,15 @@ export namespace classroom_v1 { */ creatorUserId?: string; /** - * Classroom-assigned identifier of this announcement, unique per course. - * Read-only. + * Classroom-assigned identifier of this announcement, unique per course. Read-only. */ id?: string; /** - * Identifiers of students with access to the announcement. This field is - * set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the - * `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in - * this field will be able to see the announcement. + * Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be able to see the announcement. */ individualStudentsOptions?: Schema$IndividualStudentsOptions; /** - * Additional materials. Announcements must have no more than 20 material - * items. + * Additional materials. Announcements must have no more than 20 material items. */ materials?: Schema$Material[]; /** @@ -172,13 +164,11 @@ export namespace classroom_v1 { */ scheduledTime?: string; /** - * Status of this announcement. If unspecified, the default state is - * `DRAFT`. + * Status of this announcement. If unspecified, the default state is `DRAFT`. */ state?: string; /** - * Description of this announcement. The text must be a valid UTF-8 string - * containing no more than 30,000 characters. + * Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters. */ text?: string; /** @@ -191,8 +181,7 @@ export namespace classroom_v1 { */ export interface Schema$Assignment { /** - * Drive folder where attachments from student submissions are placed. This - * is only populated for course teachers and administrators. + * Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. */ studentWorkFolder?: Schema$DriveFolder; } @@ -201,18 +190,12 @@ export namespace classroom_v1 { */ export interface Schema$AssignmentSubmission { /** - * Attachments added by the student. Drive files that correspond to - * materials with a share mode of STUDENT_COPY may not exist yet if the - * student has not accessed the assignment in Classroom. Some attachment - * metadata is only populated if the requesting user has permission to - * access it. Identifier and alternate_link fields are always available, but - * others (e.g. title) may not be. + * Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be. */ attachments?: Schema$Attachment[]; } /** - * Attachment added to student assignment work. When creating attachments, - * setting the `form` field is not supported. + * Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. */ export interface Schema$Attachment { /** @@ -233,15 +216,11 @@ export namespace classroom_v1 { youTubeVideo?: Schema$YouTubeVideo; } /** - * A reference to a Cloud Pub/Sub topic. To register for notifications, the - * owner of the topic must grant - * `classroom-notifications@system.gserviceaccount.com` the - * `projects.topics.publish` permission. + * A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. */ export interface Schema$CloudPubsubTopic { /** - * The `name` field of a Cloud Pub/Sub - * [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). + * The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). */ topicName?: string; } @@ -254,20 +233,15 @@ export namespace classroom_v1 { */ alternateLink?: string; /** - * The Calendar ID for a calendar that all course members can see, to which - * Classroom adds events for course work and announcements in the course. - * Read-only. + * The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. */ calendarId?: string; /** - * The email address of a Google group containing all members of the course. - * This group does not accept email and can only be used for permissions. - * Read-only. + * The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. */ courseGroupEmail?: string; /** - * Sets of materials that appear on the "about" page of this - * course. Read-only. + * Sets of materials that appear on the "about" page of this course. Read-only. */ courseMaterialSets?: Schema$CourseMaterialSet[]; /** @@ -275,105 +249,64 @@ export namespace classroom_v1 { */ courseState?: string; /** - * Creation time of the course. Specifying this field in a course update - * mask results in an error. Read-only. + * Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. */ creationTime?: string; /** - * Optional description. For example, "We'll be learning about the - * structure of living creatures from a combination of textbooks, guest - * lectures, and lab work. Expect to be excited!" If set, this field - * must be a valid UTF-8 string and no longer than 30,000 characters. + * Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. */ description?: string; /** - * Optional heading for the description. For example, "Welcome to 10th - * Grade Biology." If set, this field must be a valid UTF-8 string and - * no longer than 3600 characters. + * Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. */ descriptionHeading?: string; /** - * Enrollment code to use when joining this course. Specifying this field in - * a course update mask results in an error. Read-only. + * Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. */ enrollmentCode?: string; /** - * Whether or not guardian notifications are enabled for this course. - * Read-only. + * Whether or not guardian notifications are enabled for this course. Read-only. */ guardiansEnabled?: boolean; /** - * Identifier for this course assigned by Classroom. When creating a - * course, you may optionally set this identifier to an alias string in the - * request to create a corresponding alias. The `id` is still assigned by - * Classroom and cannot be updated after the course is created. Specifying - * this field in a course update mask results in an error. + * Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. */ id?: string; /** - * Name of the course. For example, "10th Grade Biology". The name - * is required. It must be between 1 and 750 characters and a valid UTF-8 - * string. + * Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. */ name?: string; /** - * The identifier of the owner of a course. When specified as a parameter - * of a create course request, this field is required. The identifier can be - * one of the following: * the numeric identifier for the user * the email - * address of the user * the string literal `"me"`, indicating the - * requesting user This must be set in a create request. Admins can also - * specify this field in a patch course request to transfer ownership. In - * other contexts, it is read-only. + * The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. */ ownerId?: string; /** - * Optional room location. For example, "301". If set, this field - * must be a valid UTF-8 string and no longer than 650 characters. + * Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. */ room?: string; /** - * Section of the course. For example, "Period 2". If set, this - * field must be a valid UTF-8 string and no longer than 2800 characters. + * Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. */ section?: string; /** - * Information about a Drive Folder that is shared with all teachers of the - * course. This field will only be set for teachers of the course and - * domain administrators. Read-only. + * Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. */ teacherFolder?: Schema$DriveFolder; /** - * The email address of a Google group containing all teachers of the - * course. This group does not accept email and can only be used for - * permissions. Read-only. + * The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. */ teacherGroupEmail?: string; /** - * Time of the most recent update to this course. Specifying this field in a - * course update mask results in an error. Read-only. + * Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. */ updateTime?: string; } /** - * Alternative identifier for a course. An alias uniquely identifies a - * course. It must be unique within one of the following scopes: * domain: A - * domain-scoped alias is visible to all users within the alias creator's - * domain and can be created only by a domain admin. A domain-scoped alias is - * often used when a course has an identifier external to Classroom. * - * project: A project-scoped alias is visible to any request from an - * application using the Developer Console project ID that created the alias - * and can be created by any project. A project-scoped alias is often used - * when an application has alternative identifiers. A random value can also be - * used to avoid duplicate courses in the event of transmission failures, as - * retrying a request will return `ALREADY_EXISTS` if a previous one has - * succeeded. + * Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded. */ export interface Schema$CourseAlias { /** - * Alias string. The format of the string indicates the desired alias - * scoping. * `d:<name>` indicates a domain-scoped alias. Example: - * `d:math_101` * `p:<name>` indicates a project-scoped alias. - * Example: `p:abc123` This field has a maximum length of 256 characters. + * Alias string. The format of the string indicates the desired alias scoping. * `d:<name>` indicates a domain-scoped alias. Example: `d:math_101` * `p:<name>` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. */ alias?: string; } @@ -399,9 +332,7 @@ export namespace classroom_v1 { youTubeVideo?: Schema$YouTubeVideo; } /** - * A set of materials that appears on the "About" page of the - * course. These materials might include a syllabus, schedule, or other - * background information relating to the course as a whole. + * A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole. */ export interface Schema$CourseMaterialSet { /** @@ -427,24 +358,19 @@ export namespace classroom_v1 { */ export interface Schema$CourseWork { /** - * Absolute link to this course work in the Classroom web UI. This is only - * populated if `state` is `PUBLISHED`. Read-only. + * Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. */ alternateLink?: string; /** - * Assignee mode of the coursework. If unspecified, the default value is - * `ALL_STUDENTS`. + * Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. */ assigneeMode?: string; /** - * Assignment details. This is populated only when `work_type` is - * `ASSIGNMENT`. Read-only. + * Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. */ assignment?: Schema$Assignment; /** - * Whether this course work item is associated with the Developer Console - * project making the request. See google.classroom.Work.CreateCourseWork - * for more details. Read-only. + * Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only. */ associatedWithDeveloper?: boolean; /** @@ -460,49 +386,35 @@ export namespace classroom_v1 { */ creatorUserId?: string; /** - * Optional description of this course work. If set, the description must be - * a valid UTF-8 string containing no more than 30,000 characters. + * Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. */ description?: string; /** - * Optional date, in UTC, that submissions for this course work are due. - * This must be specified if `due_time` is specified. + * Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. */ dueDate?: Schema$Date; /** - * Optional time of day, in UTC, that submissions for this course work are - * due. This must be specified if `due_date` is specified. + * Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. */ dueTime?: Schema$TimeOfDay; /** - * Classroom-assigned identifier of this course work, unique per course. - * Read-only. + * Classroom-assigned identifier of this course work, unique per course. Read-only. */ id?: string; /** - * Identifiers of students with access to the coursework. This field is set - * only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is - * `INDIVIDUAL_STUDENTS`, then only students specified in this field will be - * assigned the coursework. + * Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be assigned the coursework. */ individualStudentsOptions?: Schema$IndividualStudentsOptions; /** - * Additional materials. CourseWork must have no more than 20 material - * items. + * Additional materials. CourseWork must have no more than 20 material items. */ materials?: Schema$Material[]; /** - * Maximum grade for this course work. If zero or unspecified, this - * assignment is considered ungraded. This must be a non-negative integer - * value. + * Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. */ maxPoints?: number; /** - * Multiple choice question details. For read operations, this field is - * populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write - * operations, this field must be specified when creating course work with a - * `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set - * otherwise. + * Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. */ multipleChoiceQuestion?: Schema$MultipleChoiceQuestion; /** @@ -514,18 +426,15 @@ export namespace classroom_v1 { */ state?: string; /** - * Setting to determine when students are allowed to modify submissions. If - * unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. + * Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. */ submissionModificationMode?: string; /** - * Title of this course work. The title must be a valid UTF-8 string - * containing between 1 and 3000 characters. + * Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. */ title?: string; /** - * Identifier for the topic that this coursework is associated with. Must - * match an existing topic in the course. + * Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. */ topicId?: string; /** @@ -533,8 +442,7 @@ export namespace classroom_v1 { */ updateTime?: string; /** - * Type of this course work. The type is set when the course work is - * created and cannot be changed. + * Type of this course work. The type is set when the course work is created and cannot be changed. */ workType?: string; } @@ -548,30 +456,19 @@ export namespace classroom_v1 { courseId?: string; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } @@ -614,26 +511,19 @@ export namespace classroom_v1 { title?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A class of notifications that an application can register to receive. For - * example: "all roster changes for a domain". + * A class of notifications that an application can register to receive. For example: "all roster changes for a domain". */ export interface Schema$Feed { /** - * Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. - * This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`. + * Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`. */ courseRosterChangesInfo?: Schema$CourseRosterChangesInfo; /** - * Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. - * This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`. + * Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`. */ courseWorkChangesInfo?: Schema$CourseWorkChangesInfo; /** @@ -650,9 +540,7 @@ export namespace classroom_v1 { */ formUrl?: string; /** - * URL of the form responses document. Only set if respsonses have been - * recorded and only when the requesting user is an editor of the form. - * Read-only. + * URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. */ responseUrl?: string; /** @@ -690,8 +578,7 @@ export namespace classroom_v1 { */ gradeTimestamp?: string; /** - * The denominator of the grade at this time in the submission grade - * history. + * The denominator of the grade at this time in the submission grade history. */ maxPoints?: number; /** @@ -700,8 +587,7 @@ export namespace classroom_v1 { pointsEarned?: number; } /** - * Association between a student and a guardian of that student. The guardian - * may receive information about the student's course work. + * Association between a student and a guardian of that student. The guardian may receive information about the student's course work. */ export interface Schema$Guardian { /** @@ -713,8 +599,7 @@ export namespace classroom_v1 { */ guardianProfile?: Schema$UserProfile; /** - * The email address to which the initial guardian invitation was sent. This - * field is only visible to domain administrators. + * The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators. */ invitedEmailAddress?: string; /** @@ -723,8 +608,7 @@ export namespace classroom_v1 { studentId?: string; } /** - * An invitation to become the guardian of a specified user, sent to a - * specified email address. + * An invitation to become the guardian of a specified user, sent to a specified email address. */ export interface Schema$GuardianInvitation { /** @@ -736,8 +620,7 @@ export namespace classroom_v1 { */ invitationId?: string; /** - * Email address that the invitation was sent to. This field is only visible - * to domain administrators. + * Email address that the invitation was sent to. This field is only visible to domain administrators. */ invitedEmailAddress?: string; /** @@ -750,13 +633,11 @@ export namespace classroom_v1 { studentId?: string; } /** - * Assignee details about a coursework/announcement. This field is set if and - * only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. + * Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. */ export interface Schema$IndividualStudentsOptions { /** - * Identifiers for the students that have access to the - * coursework/announcement. + * Identifiers for the students that have access to the coursework/announcement. */ studentIds?: string[]; } @@ -777,10 +658,7 @@ export namespace classroom_v1 { */ role?: string; /** - * Identifier of the invited user. When specified as a parameter of a - * request, this identifier can be set to one of the following: * the - * numeric identifier for the user * the email address of the user * the - * string literal `"me"`, indicating the requesting user + * Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -797,8 +675,7 @@ export namespace classroom_v1 { */ title?: string; /** - * URL to link to. This must be a valid UTF-8 string containing between 1 - * and 2024 characters. + * URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. */ url?: string; } @@ -811,8 +688,7 @@ export namespace classroom_v1 { */ announcements?: Schema$Announcement[]; /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; } @@ -825,8 +701,7 @@ export namespace classroom_v1 { */ aliases?: Schema$CourseAlias[]; /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; } @@ -839,8 +714,7 @@ export namespace classroom_v1 { */ courses?: Schema$Course[]; /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; } @@ -853,8 +727,7 @@ export namespace classroom_v1 { */ courseWork?: Schema$CourseWork[]; /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; } @@ -867,8 +740,7 @@ export namespace classroom_v1 { */ guardianInvitations?: Schema$GuardianInvitation[]; /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; } @@ -877,13 +749,11 @@ export namespace classroom_v1 { */ export interface Schema$ListGuardiansResponse { /** - * Guardians on this page of results that met the criteria specified in the - * request. + * Guardians on this page of results that met the criteria specified in the request. */ guardians?: Schema$Guardian[]; /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; } @@ -896,8 +766,7 @@ export namespace classroom_v1 { */ invitations?: Schema$Invitation[]; /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; } @@ -906,8 +775,7 @@ export namespace classroom_v1 { */ export interface Schema$ListStudentsResponse { /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; /** @@ -920,8 +788,7 @@ export namespace classroom_v1 { */ export interface Schema$ListStudentSubmissionsResponse { /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; /** @@ -934,8 +801,7 @@ export namespace classroom_v1 { */ export interface Schema$ListTeachersResponse { /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; /** @@ -948,8 +814,7 @@ export namespace classroom_v1 { */ export interface Schema$ListTopicResponse { /** - * Token identifying the next page of results to return. If empty, no - * further results are available. + * Token identifying the next page of results to return. If empty, no further results are available. */ nextPageToken?: string; /** @@ -958,8 +823,7 @@ export namespace classroom_v1 { topic?: Schema$Topic[]; } /** - * Material attached to course work. When creating attachments, setting the - * `form` field is not supported. + * Material attached to course work. When creating attachments, setting the `form` field is not supported. */ export interface Schema$Material { /** @@ -971,8 +835,7 @@ export namespace classroom_v1 { */ form?: Schema$Form; /** - * Link material. On creation, will be upgraded to a more appropriate type - * if possible, and this will be reflected in the response. + * Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response. */ link?: Schema$Link; /** @@ -985,13 +848,11 @@ export namespace classroom_v1 { */ export interface Schema$ModifyAnnouncementAssigneesRequest { /** - * Mode of the announcement describing whether it will be accessible by all - * students or specified individual students. + * Mode of the announcement describing whether it will be accessible by all students or specified individual students. */ assigneeMode?: string; /** - * Set which students can view or cannot view the announcement. Must be - * specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. + * Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. */ modifyIndividualStudentsOptions?: Schema$ModifyIndividualStudentsOptions; } @@ -1000,8 +861,7 @@ export namespace classroom_v1 { */ export interface Schema$ModifyAttachmentsRequest { /** - * Attachments to add. A student submission may not have more than 20 - * attachments. Form attachments are not supported. + * Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported. */ addAttachments?: Schema$Attachment[]; } @@ -1010,29 +870,24 @@ export namespace classroom_v1 { */ export interface Schema$ModifyCourseWorkAssigneesRequest { /** - * Mode of the coursework describing whether it will be assigned to all - * students or specified individual students. + * Mode of the coursework describing whether it will be assigned to all students or specified individual students. */ assigneeMode?: string; /** - * Set which students are assigned or not assigned to the coursework. Must - * be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. + * Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. */ modifyIndividualStudentsOptions?: Schema$ModifyIndividualStudentsOptions; } /** - * Contains fields to add or remove students from a course work or - * announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. + * Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. */ export interface Schema$ModifyIndividualStudentsOptions { /** - * Ids of students to be added as having access to this - * coursework/announcement. + * Ids of students to be added as having access to this coursework/announcement. */ addStudentIds?: string[]; /** - * Ids of students to be removed from having access to this - * coursework/announcement. + * Ids of students to be removed from having access to this coursework/announcement. */ removeStudentIds?: string[]; } @@ -1063,8 +918,7 @@ export namespace classroom_v1 { */ familyName?: string; /** - * The user's full name formed by concatenating the first and last name - * values. Read-only. + * The user's full name formed by concatenating the first and last name values. Read-only. */ fullName?: string; /** @@ -1077,8 +931,7 @@ export namespace classroom_v1 { */ export interface Schema$ReclaimStudentSubmissionRequest {} /** - * An instruction to Classroom to send notifications from the `feed` to the - * provided destination. + * An instruction to Classroom to send notifications from the `feed` to the provided destination. */ export interface Schema$Registration { /** @@ -1086,13 +939,11 @@ export namespace classroom_v1 { */ cloudPubsubTopic?: Schema$CloudPubsubTopic; /** - * The time until which the `Registration` is effective. This is a - * read-only field assigned by the server. + * The time until which the `Registration` is effective. This is a read-only field assigned by the server. */ expiryTime?: string; /** - * Specification for the class of notifications that Classroom should - * deliver to the destination. + * Specification for the class of notifications that Classroom should deliver to the destination. */ feed?: Schema$Feed; /** @@ -1156,23 +1007,16 @@ export namespace classroom_v1 { */ profile?: Schema$UserProfile; /** - * Information about a Drive Folder for this student's work in this - * course. Only visible to the student and domain administrators. Read-only. + * Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only. */ studentWorkFolder?: Schema$DriveFolder; /** - * Identifier of the user. When specified as a parameter of a request, this - * identifier can be one of the following: * the numeric identifier for the - * user * the email address of the user * the string literal - * `"me"`, indicating the requesting user + * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } /** - * Student submission for course work. StudentSubmission items are generated - * when a CourseWork item is created. StudentSubmissions that have never been - * accessed (i.e. with `state` = NEW) may not have a creation time or update - * time. + * Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. */ export interface Schema$StudentSubmission { /** @@ -1180,21 +1024,15 @@ export namespace classroom_v1 { */ alternateLink?: string; /** - * Optional grade. If unset, no grade was set. This value must be - * non-negative. Decimal (i.e. non-integer) values are allowed, but will be - * rounded to two decimal places. This may be modified only by course - * teachers. + * Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This may be modified only by course teachers. */ assignedGrade?: number; /** - * Submission content when course_work_type is ASSIGNMENT. Students can - * modify this content using google.classroom.Work.ModifyAttachments. + * Submission content when course_work_type is ASSIGNMENT. Students can modify this content using google.classroom.Work.ModifyAttachments. */ assignmentSubmission?: Schema$AssignmentSubmission; /** - * Whether this student submission is associated with the Developer Console - * project making the request. See google.classroom.Work.CreateCourseWork - * for more details. Read-only. + * Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only. */ associatedWithDeveloper?: boolean; /** @@ -1210,20 +1048,15 @@ export namespace classroom_v1 { */ courseWorkType?: string; /** - * Creation time of this submission. This may be unset if the student has - * not accessed this item. Read-only. + * Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. */ creationTime?: string; /** - * Optional pending grade. If unset, no grade was set. This value must be - * non-negative. Decimal (i.e. non-integer) values are allowed, but will be - * rounded to two decimal places. This is only visible to and modifiable by - * course teachers. + * Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This is only visible to and modifiable by course teachers. */ draftGrade?: number; /** - * Classroom-assigned Identifier for the student submission. This is unique - * among submissions for the relevant course work. Read-only. + * Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. */ id?: string; /** @@ -1243,13 +1076,11 @@ export namespace classroom_v1 { */ state?: string; /** - * The history of the submission (includes state and grade histories). - * Read-only. + * The history of the submission (includes state and grade histories). Read-only. */ submissionHistory?: Schema$SubmissionHistory[]; /** - * Last update time of this submission. This may be unset if the student has - * not accessed this item. Read-only. + * Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. */ updateTime?: string; /** @@ -1258,8 +1089,7 @@ export namespace classroom_v1 { userId?: string; } /** - * The history of the submission. This currently includes state and grade - * histories. + * The history of the submission. This currently includes state and grade histories. */ export interface Schema$SubmissionHistory { /** @@ -1284,23 +1114,16 @@ export namespace classroom_v1 { */ profile?: Schema$UserProfile; /** - * Identifier of the user. When specified as a parameter of a request, this - * identifier can be one of the following: * the numeric identifier for the - * user * the email address of the user * the string literal - * `"me"`, indicating the requesting user + * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } /** - * Represents a time of day. The date and time zone are either not significant - * or are specified elsewhere. An API may choose to allow leap seconds. - * Related types are google.type.Date and `google.protobuf.Timestamp`. + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - * to allow the value "24:00:00" for scenarios like business - * closing time. + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number; /** @@ -1312,8 +1135,7 @@ export namespace classroom_v1 { */ nanos?: number; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may - * allow the value 60 if it allows leap-seconds. + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number; } @@ -1326,11 +1148,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * The name of the topic, generated by the user. Leading and trailing - * whitespaces, if any, will be trimmed. Also, multiple consecutive - * whitespaces will be collapsed into one inside the name. The result must - * be a non-empty string. Topic names are case sensitive, and must be no - * longer than 100 characters. + * The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters. */ name?: string; /** @@ -1371,10 +1189,7 @@ export namespace classroom_v1 { */ photoUrl?: string; /** - * Represents whether a G Suite for Education user's domain - * administrator has explicitly verified them as being a teacher. If the - * user is not a member of a G Suite for Education domain, than this field - * will always be false. Read-only + * Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false. Read-only */ verifiedTeacher?: boolean; } @@ -1420,14 +1235,7 @@ export namespace classroom_v1 { /** * classroom.courses.create - * @desc Creates a course. The user specified in `ownerId` is the owner of - * the created course and added as a teacher. This method returns the - * following error codes: * `PERMISSION_DENIED` if the requesting user is - * not permitted to create courses or for access errors. * `NOT_FOUND` if - * the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the - * course owner's account is disabled or for the following request errors: - * * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was - * specified in the `id` and already exists. + * @desc Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists. * @alias classroom.courses.create * @memberOf! () * @@ -1495,10 +1303,7 @@ export namespace classroom_v1 { /** * classroom.courses.delete - * @desc Deletes a course. This method returns the following error codes: - * * `PERMISSION_DENIED` if the requesting user is not permitted to delete - * the requested course or for access errors. * `NOT_FOUND` if no course - * exists with the requested ID. + * @desc Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * @alias classroom.courses.delete * @memberOf! () * @@ -1566,10 +1371,7 @@ export namespace classroom_v1 { /** * classroom.courses.get - * @desc Returns a course. This method returns the following error codes: - * * `PERMISSION_DENIED` if the requesting user is not permitted to access - * the requested course or for access errors. * `NOT_FOUND` if no course - * exists with the requested ID. + * @desc Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * @alias classroom.courses.get * @memberOf! () * @@ -1637,12 +1439,7 @@ export namespace classroom_v1 { /** * classroom.courses.list - * @desc Returns a list of courses that the requesting user is permitted to - * view, restricted to those that match the request. Returned courses are - * ordered by creation time, with the most recently created coming first. - * This method returns the following error codes: * `PERMISSION_DENIED` for - * access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * - * `NOT_FOUND` if any users specified in the query arguments do not exist. + * @desc Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. * @alias classroom.courses.list * @memberOf! () * @@ -1716,13 +1513,7 @@ export namespace classroom_v1 { /** * classroom.courses.patch - * @desc Updates one or more fields in a course. This method returns the - * following error codes: * `PERMISSION_DENIED` if the requesting user is - * not permitted to modify the requested course or for access errors. * - * `NOT_FOUND` if no course exists with the requested ID. * - * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or - * if no update mask is supplied. * `FAILED_PRECONDITION` for the following - * request errors: * CourseNotModifiable + * @desc Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * @alias classroom.courses.patch * @memberOf! () * @@ -1792,11 +1583,7 @@ export namespace classroom_v1 { /** * classroom.courses.update - * @desc Updates a course. This method returns the following error codes: - * * `PERMISSION_DENIED` if the requesting user is not permitted to modify - * the requested course or for access errors. * `NOT_FOUND` if no course - * exists with the requested ID. * `FAILED_PRECONDITION` for the following - * request errors: * CourseNotModifiable + * @desc Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * @alias classroom.courses.update * @memberOf! () * @@ -1882,8 +1669,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course to delete. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. */ id?: string; } @@ -1894,8 +1680,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course to return. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. */ id?: string; } @@ -1906,34 +1691,23 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts returned courses to those in one of the specified states The - * default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. + * Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. */ courseStates?: string[]; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * Restricts returned courses to those having a student with the specified - * identifier. The identifier can be one of the following: * the numeric - * identifier for the user * the email address of the user * the string - * literal `"me"`, indicating the requesting user + * Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ studentId?: string; /** - * Restricts returned courses to those having a teacher with the specified - * identifier. The identifier can be one of the following: * the numeric - * identifier for the user * the email address of the user * the string - * literal `"me"`, indicating the requesting user + * Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ teacherId?: string; } @@ -1944,19 +1718,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course to update. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. */ id?: string; /** - * Mask that identifies which fields on the course to update. This field is - * required to do an update. The update will fail if invalid fields are - * specified. The following fields are valid: * `name` * `section` * - * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` - * Note: patches to ownerId are treated as being effective immediately, but - * in practice it may take some time for the ownership transfer of all - * affected resources to complete. When set in a query parameter, this - * field should be specified as `updateMask=,,...` + * Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` */ updateMask?: string; @@ -1972,8 +1738,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course to update. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. */ id?: string; @@ -1991,13 +1756,7 @@ export namespace classroom_v1 { /** * classroom.courses.aliases.create - * @desc Creates an alias for a course. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to create the alias or for access errors. * `NOT_FOUND` if the - * course does not exist. * `ALREADY_EXISTS` if the alias already exists. * - * `FAILED_PRECONDITION` if the alias requested does not make sense for the - * requesting user or course (for example, if a user not in a domain - * attempts to access a domain-scoped alias). + * @desc Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias). * @alias classroom.courses.aliases.create * @memberOf! () * @@ -2072,12 +1831,7 @@ export namespace classroom_v1 { /** * classroom.courses.aliases.delete - * @desc Deletes an alias of a course. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to remove the alias or for access errors. * `NOT_FOUND` if the - * alias does not exist. * `FAILED_PRECONDITION` if the alias requested does - * not make sense for the requesting user or course (for example, if a - * user not in a domain attempts to delete a domain-scoped alias). + * @desc Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias). * @alias classroom.courses.aliases.delete * @memberOf! () * @@ -2150,10 +1904,7 @@ export namespace classroom_v1 { /** * classroom.courses.aliases.list - * @desc Returns a list of aliases for a course. This method returns the - * following error codes: * `PERMISSION_DENIED` if the requesting user is - * not permitted to access the course or for access errors. * `NOT_FOUND` if - * the course does not exist. + * @desc Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist. * @alias classroom.courses.aliases.list * @memberOf! () * @@ -2243,8 +1994,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course to alias. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; @@ -2265,8 +2015,7 @@ export namespace classroom_v1 { */ alias?: string; /** - * Identifier of the course whose alias should be deleted. This identifier - * can be either the Classroom-assigned identifier or an alias. + * Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; } @@ -2278,20 +2027,15 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -2304,13 +2048,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.create - * @desc Creates an announcement. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access the requested course, create announcements in the requested - * course, share a Drive attachment, or for access errors. * - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the - * requested course does not exist. * `FAILED_PRECONDITION` for the - * following request error: * AttachmentNotVisible + * @desc Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible * @alias classroom.courses.announcements.create * @memberOf! () * @@ -2385,15 +2123,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.delete - * @desc Deletes an announcement. This request must be made by the - * Developer Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding announcement item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting developer project did not - * create the corresponding announcement, if the requesting user is not - * permitted to delete the requested course or for access errors. * - * `FAILED_PRECONDITION` if the requested announcement has already been - * deleted. * `NOT_FOUND` if no course exists with the requested ID. + * @desc Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. * @alias classroom.courses.announcements.delete * @memberOf! () * @@ -2465,11 +2195,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.get - * @desc Returns an announcement. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access the requested course or announcement, or for access errors. * - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the - * requested course or announcement does not exist. + * @desc Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist. * @alias classroom.courses.announcements.get * @memberOf! () * @@ -2543,13 +2269,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.list - * @desc Returns a list of announcements that the requester is permitted to - * view. Course students may only view `PUBLISHED` announcements. Course - * teachers and domain administrators may view all announcements. This - * method returns the following error codes: * `PERMISSION_DENIED` if the - * requesting user is not permitted to access the requested course or for - * access errors. * `INVALID_ARGUMENT` if the request is malformed. * - * `NOT_FOUND` if the requested course does not exist. + * @desc Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @alias classroom.courses.announcements.list * @memberOf! () * @@ -2634,13 +2354,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.modifyAssignees - * @desc Modifies assignee mode and options of an announcement. Only a - * teacher of the course that contains the announcement may call this - * method. This method returns the following error codes: * - * `PERMISSION_DENIED` if the requesting user is not permitted to access the - * requested course or course work or for access errors. * - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the - * requested course or course work does not exist. + * @desc Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * @alias classroom.courses.announcements.modifyAssignees * @memberOf! () * @@ -2716,13 +2430,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.patch - * @desc Updates one or more fields of an announcement. This method returns - * the following error codes: * `PERMISSION_DENIED` if the requesting - * developer project did not create the corresponding announcement or for - * access errors. * `INVALID_ARGUMENT` if the request is malformed. * - * `FAILED_PRECONDITION` if the requested announcement has already been - * deleted. * `NOT_FOUND` if the requested course or announcement does not - * exist + * @desc Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist * @alias classroom.courses.announcements.patch * @memberOf! () * @@ -2805,8 +2513,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; @@ -2823,13 +2530,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Identifier of the announcement to delete. This identifier is a - * Classroom-assigned identifier. + * Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier. */ id?: string; } @@ -2841,8 +2546,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -2858,33 +2562,23 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restriction on the `state` of announcements returned. If this argument is - * left unspecified, the default value is `PUBLISHED`. + * Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. */ announcementStates?: string[]; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Optional sort ordering for results. A comma-separated list of fields with - * an optional sort direction keyword. Supported field is `updateTime`. - * Supported direction keywords are `asc` and `desc`. If not specified, - * `updateTime desc` is the default behavior. Examples: `updateTime asc`, - * `updateTime` + * Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime` */ orderBy?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -2896,8 +2590,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -2918,8 +2611,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -2927,14 +2619,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the announcement to update. This - * field is required to do an update. The update fails if invalid fields are - * specified. If a field supports empty values, it can be cleared by - * specifying it in the update mask and not in the Announcement object. If a - * field that does not support empty values is included in the update mask - * and not set in the Announcement object, an `INVALID_ARGUMENT` error will - * be returned. The following fields may be specified by teachers: * - * `text` * `state` * `scheduled_time` + * Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` */ updateMask?: string; @@ -2956,18 +2641,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.create - * @desc Creates course work. The resulting course work (and corresponding - * student submissions) are associated with the Developer Console project of - * the [OAuth client ID](https://support.google.com/cloud/answer/6158849) - * used to make the request. Classroom API requests to modify course work - * and student submissions must be made with an OAuth client ID from the - * associated Developer Console project. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to access the requested course, create course work in the - * requested course, share a Drive attachment, or for access errors. * - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the - * requested course does not exist. * `FAILED_PRECONDITION` for the - * following request error: * AttachmentNotVisible + * @desc Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible * @alias classroom.courses.courseWork.create * @memberOf! () * @@ -3042,15 +2716,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.delete - * @desc Deletes a course work. This request must be made by the Developer - * Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding course work item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting developer project did not - * create the corresponding course work, if the requesting user is not - * permitted to delete the requested course or for access errors. * - * `FAILED_PRECONDITION` if the requested course work has already been - * deleted. * `NOT_FOUND` if no course exists with the requested ID. + * @desc Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. * @alias classroom.courses.courseWork.delete * @memberOf! () * @@ -3123,11 +2789,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.get - * @desc Returns course work. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access the requested course or course work, or for access errors. * - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the - * requested course or course work does not exist. + * @desc Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * @alias classroom.courses.courseWork.get * @memberOf! () * @@ -3202,13 +2864,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.list - * @desc Returns a list of course work that the requester is permitted to - * view. Course students may only view `PUBLISHED` course work. Course - * teachers and domain administrators may view all course work. This method - * returns the following error codes: * `PERMISSION_DENIED` if the - * requesting user is not permitted to access the requested course or for - * access errors. * `INVALID_ARGUMENT` if the request is malformed. * - * `NOT_FOUND` if the requested course does not exist. + * @desc Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @alias classroom.courses.courseWork.list * @memberOf! () * @@ -3288,13 +2944,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.modifyAssignees - * @desc Modifies assignee mode and options of a coursework. Only a teacher - * of the course that contains the coursework may call this method. This - * method returns the following error codes: * `PERMISSION_DENIED` if the - * requesting user is not permitted to access the requested course or course - * work or for access errors. * `INVALID_ARGUMENT` if the request is - * malformed. * `NOT_FOUND` if the requested course or course work does not - * exist. + * @desc Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * @alias classroom.courses.courseWork.modifyAssignees * @memberOf! () * @@ -3369,26 +3019,14 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.patch - * @desc Updates one or more fields of a course work. See - * google.classroom.v1.CourseWork for details of which fields may be updated - * and who may change them. This request must be made by the Developer - * Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding course work item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting developer project did not - * create the corresponding course work, if the user is not permitted to - * make the requested modification to the student submission, or for access - * errors. * `INVALID_ARGUMENT` if the request is malformed. * - * `FAILED_PRECONDITION` if the requested course work has already been - * deleted. * `NOT_FOUND` if the requested course, course work, or student - * submission does not exist. + * @desc Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @alias classroom.courses.courseWork.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.id Identifier of the course work. - * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` + * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * @param {().CourseWork} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3465,8 +3103,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; @@ -3483,13 +3120,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Identifier of the course work to delete. This identifier is a - * Classroom-assigned identifier. + * Identifier of the course work to delete. This identifier is a Classroom-assigned identifier. */ id?: string; } @@ -3501,8 +3136,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -3518,34 +3152,23 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Restriction on the work status to return. Only courseWork that matches is - * returned. If unspecified, items with a work status of `PUBLISHED` is - * returned. + * Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. */ courseWorkStates?: string[]; /** - * Optional sort ordering for results. A comma-separated list of fields with - * an optional sort direction keyword. Supported fields are `updateTime` and - * `dueDate`. Supported direction keywords are `asc` and `desc`. If not - * specified, `updateTime desc` is the default behavior. Examples: `dueDate - * asc,updateTime desc`, `updateTime,dueDate desc` + * Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` */ orderBy?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -3557,8 +3180,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -3579,8 +3201,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -3588,15 +3209,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work to update. This - * field is required to do an update. The update fails if invalid fields are - * specified. If a field supports empty values, it can be cleared by - * specifying it in the update mask and not in the CourseWork object. If a - * field that does not support empty values is included in the update mask - * and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be - * returned. The following fields may be specified by teachers: * `title` - * * `description` * `state` * `due_date` * `due_time` * `max_points` * - * `scheduled_time` * `submission_modification_mode` + * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` */ updateMask?: string; @@ -3614,11 +3227,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.get - * @desc Returns a student submission. * `PERMISSION_DENIED` if the - * requesting user is not permitted to access the requested course, course - * work, or student submission or for access errors. * `INVALID_ARGUMENT` if - * the request is malformed. * `NOT_FOUND` if the requested course, course - * work, or student submission does not exist. + * @desc Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @alias classroom.courses.courseWork.studentSubmissions.get * @memberOf! () * @@ -3694,16 +3303,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.list - * @desc Returns a list of student submissions that the requester is - * permitted to view, factoring in the OAuth scopes of the request. `-` may - * be specified as the `course_work_id` to include student submissions for - * multiple course work items. Course students may only view their own - * work. Course teachers and domain administrators may view all student - * submissions. This method returns the following error codes: * - * `PERMISSION_DENIED` if the requesting user is not permitted to access the - * requested course or course work, or for access errors. * - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the - * requested course does not exist. + * @desc Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @alias classroom.courses.courseWork.studentSubmissions.list * @memberOf! () * @@ -3792,18 +3392,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.modifyAttachments - * @desc Modifies attachments of student submission. Attachments may only - * be added to student submissions belonging to course work objects with a - * `workType` of `ASSIGNMENT`. This request must be made by the Developer - * Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding course work item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access the requested course or course work, if the user is not permitted - * to modify attachments on the requested student submission, or for access - * errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` - * if the requested course, course work, or student submission does not - * exist. + * @desc Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @alias classroom.courses.courseWork.studentSubmissions.modifyAttachments * @memberOf! () * @@ -3882,18 +3471,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.patch - * @desc Updates one or more fields of a student submission. See - * google.classroom.v1.StudentSubmission for details of which fields may be - * updated and who may change them. This request must be made by the - * Developer Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding course work item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting developer project did not - * create the corresponding course work, if the user is not permitted to - * make the requested modification to the student submission, or for access - * errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` - * if the requested course, course work, or student submission does not - * exist. + * @desc Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @alias classroom.courses.courseWork.studentSubmissions.patch * @memberOf! () * @@ -3971,20 +3549,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.reclaim - * @desc Reclaims a student submission on behalf of the student that owns - * it. Reclaiming a student submission transfers ownership of attached - * Drive files to the student and updates the submission state. Only the - * student that owns the requested student submission may call this method, - * and only for a student submission that has been turned in. This request - * must be made by the Developer Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding course work item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access the requested course or course work, unsubmit the requested - * student submission, or for access errors. * `FAILED_PRECONDITION` if the - * student submission has not been turned in. * `INVALID_ARGUMENT` if the - * request is malformed. * `NOT_FOUND` if the requested course, course work, - * or student submission does not exist. + * @desc Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @alias classroom.courses.courseWork.studentSubmissions.reclaim * @memberOf! () * @@ -4059,20 +3624,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.return - * @desc Returns a student submission. Returning a student submission - * transfers ownership of attached Drive files to the student and may also - * update the submission state. Unlike the Classroom application, returning - * a student submission does not set assignedGrade to the draftGrade value. - * Only a teacher of the course that contains the requested student - * submission may call this method. This request must be made by the - * Developer Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding course work item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access the requested course or course work, return the requested student - * submission, or for access errors. * `INVALID_ARGUMENT` if the request is - * malformed. * `NOT_FOUND` if the requested course, course work, or student - * submission does not exist. + * @desc Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @alias classroom.courses.courseWork.studentSubmissions.return * @memberOf! () * @@ -4147,18 +3699,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.turnIn - * @desc Turns in a student submission. Turning in a student submission - * transfers ownership of attached Drive files to the teacher and may also - * update the submission state. This may only be called by the student that - * owns the specified student submission. This request must be made by the - * Developer Console project of the [OAuth client - * ID](https://support.google.com/cloud/answer/6158849) used to create the - * corresponding course work item. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access the requested course or course work, turn in the requested student - * submission, or for access errors. * `INVALID_ARGUMENT` if the request is - * malformed. * `NOT_FOUND` if the requested course, course work, or student - * submission does not exist. + * @desc Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @alias classroom.courses.courseWork.studentSubmissions.turnIn * @memberOf! () * @@ -4240,8 +3781,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -4261,44 +3801,31 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Identifier of the student work to request. This may be set to the string - * literal `"-"` to request student work for all course work in the - * specified course. + * Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course. */ courseWorkId?: string; /** - * Requested lateness value. If specified, returned student submissions are - * restricted by the requested value. If unspecified, submissions are - * returned regardless of `late` value. + * Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value. */ late?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * Requested submission states. If specified, returned student submissions - * match one of the specified submission states. + * Requested submission states. If specified, returned student submissions match one of the specified submission states. */ states?: string[]; /** - * Optional argument to restrict returned student work to those owned by the - * student with the specified identifier. The identifier can be one of the - * following: * the numeric identifier for the user * the email address of - * the user * the string literal `"me"`, indicating the requesting user + * Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -4310,8 +3837,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -4336,8 +3862,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -4349,10 +3874,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the student submission to update. - * This field is required to do an update. The update fails if invalid - * fields are specified. The following fields may be specified by teachers: - * * `draft_grade` * `assigned_grade` + * Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade` */ updateMask?: string; @@ -4369,8 +3891,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -4395,8 +3916,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -4421,8 +3941,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -4448,15 +3967,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.create - * @desc Adds a user as a student of a course. This method returns the - * following error codes: * `PERMISSION_DENIED` if the requesting user is - * not permitted to create students in this course or for access errors. * - * `NOT_FOUND` if the requested course ID does not exist. * - * `FAILED_PRECONDITION` if the requested user's account is disabled, for - * the following request errors: * CourseMemberLimitReached * - * CourseNotModifiable * UserGroupsMembershipLimitReached * - * `ALREADY_EXISTS` if the user is already a student or teacher in the - * course. + * @desc Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course. * @alias classroom.courses.students.create * @memberOf! () * @@ -4530,11 +4041,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.delete - * @desc Deletes a student of a course. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to delete students of this course or for access errors. * - * `NOT_FOUND` if no student of this course has the requested ID or if the - * course does not exist. + * @desc Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. * @alias classroom.courses.students.delete * @memberOf! () * @@ -4607,11 +4114,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.get - * @desc Returns a student of a course. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to view students of this course or for access errors. * - * `NOT_FOUND` if no student of this course has the requested ID or if the - * course does not exist. + * @desc Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. * @alias classroom.courses.students.get * @memberOf! () * @@ -4684,10 +4187,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.list - * @desc Returns a list of students of this course that the requester is - * permitted to view. This method returns the following error codes: * - * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for - * access errors. + * @desc Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors. * @alias classroom.courses.students.list * @memberOf! () * @@ -4772,15 +4272,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course to create the student in. This identifier can be - * either the Classroom-assigned identifier or an alias. + * Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Enrollment code of the course to create the student in. This code is - * required if userId corresponds to the requesting user; it may be omitted - * if the requesting user has administrative permissions to create students - * for any user. + * Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user. */ enrollmentCode?: string; @@ -4797,14 +4293,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Identifier of the student to delete. The identifier can be one of the - * following: * the numeric identifier for the user * the email address of - * the user * the string literal `"me"`, indicating the requesting user + * Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -4816,14 +4309,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Identifier of the student to return. The identifier can be one of the - * following: * the numeric identifier for the user * the email address of - * the user * the string literal `"me"`, indicating the requesting user + * Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -4835,19 +4325,15 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Maximum number of items to return. Zero means no maximum. The server may - * return fewer than the specified number of results. + * Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -4860,15 +4346,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.create - * @desc Creates a teacher of a course. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to create teachers in this course or for access errors. * - * `NOT_FOUND` if the requested course ID does not exist. * - * `FAILED_PRECONDITION` if the requested user's account is disabled, for - * the following request errors: * CourseMemberLimitReached * - * CourseNotModifiable * CourseTeacherLimitReached * - * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is - * already a teacher or student in the course. + * @desc Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course. * @alias classroom.courses.teachers.create * @memberOf! () * @@ -4941,12 +4419,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.delete - * @desc Deletes a teacher of a course. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to delete teachers of this course or for access errors. * - * `NOT_FOUND` if no teacher of this course has the requested ID or if the - * course does not exist. * `FAILED_PRECONDITION` if the requested ID - * belongs to the primary teacher of this course. + * @desc Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * @alias classroom.courses.teachers.delete * @memberOf! () * @@ -5019,11 +4492,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.get - * @desc Returns a teacher of a course. This method returns the following - * error codes: * `PERMISSION_DENIED` if the requesting user is not - * permitted to view teachers of this course or for access errors. * - * `NOT_FOUND` if no teacher of this course has the requested ID or if the - * course does not exist. + * @desc Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * @alias classroom.courses.teachers.get * @memberOf! () * @@ -5096,10 +4565,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.list - * @desc Returns a list of teachers of this course that the requester is - * permitted to view. This method returns the following error codes: * - * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for - * access errors. + * @desc Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors. * @alias classroom.courses.teachers.list * @memberOf! () * @@ -5184,8 +4650,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; @@ -5202,14 +4667,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Identifier of the teacher to delete. The identifier can be one of the - * following: * the numeric identifier for the user * the email address of - * the user * the string literal `"me"`, indicating the requesting user + * Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -5221,14 +4683,11 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Identifier of the teacher to return. The identifier can be one of the - * following: * the numeric identifier for the user * the email address of - * the user * the string literal `"me"`, indicating the requesting user + * Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -5240,19 +4699,15 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Maximum number of items to return. Zero means no maximum. The server may - * return fewer than the specified number of results. + * Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -5265,11 +4720,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.create - * @desc Creates a topic. This method returns the following error codes: * - * `PERMISSION_DENIED` if the requesting user is not permitted to access the - * requested course, create a topic in the requested course, or for access - * errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` - * if the requested course does not exist. + * @desc Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @alias classroom.courses.topics.create * @memberOf! () * @@ -5342,11 +4793,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.delete - * @desc Deletes a topic. This method returns the following error codes: * - * `PERMISSION_DENIED` if the requesting user is not allowed to delete the - * requested topic or for access errors. * `FAILED_PRECONDITION` if the - * requested topic has already been deleted. * `NOT_FOUND` if no course or - * topic exists with the requested ID. + * @desc Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID. * @alias classroom.courses.topics.delete * @memberOf! () * @@ -5419,11 +4866,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.get - * @desc Returns a topic. This method returns the following error codes: * - * `PERMISSION_DENIED` if the requesting user is not permitted to access the - * requested course or topic, or for access errors. * `INVALID_ARGUMENT` if - * the request is malformed. * `NOT_FOUND` if the requested course or topic - * does not exist. + * @desc Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist. * @alias classroom.courses.topics.get * @memberOf! () * @@ -5496,11 +4939,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.list - * @desc Returns the list of topics that the requester is permitted to view. - * This method returns the following error codes: * `PERMISSION_DENIED` if - * the requesting user is not permitted to access the requested course or - * for access errors. * `INVALID_ARGUMENT` if the request is malformed. * - * `NOT_FOUND` if the requested course does not exist. + * @desc Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @alias classroom.courses.topics.list * @memberOf! () * @@ -5576,11 +5015,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.patch - * @desc Updates one or more fields of a topic. This method returns the - * following error codes: * `PERMISSION_DENIED` if the requesting developer - * project did not create the corresponding topic or for access errors. * - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the - * requested course or topic does not exist + * @desc Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist * @alias classroom.courses.topics.patch * @memberOf! () * @@ -5662,8 +5097,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; @@ -5680,8 +5114,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -5713,20 +5146,15 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -5738,8 +5166,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the course. This identifier can be either the - * Classroom-assigned identifier or an alias. + * Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. */ courseId?: string; /** @@ -5747,13 +5174,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the topic to update. This field is - * required to do an update. The update fails if invalid fields are - * specified. If a field supports empty values, it can be cleared by - * specifying it in the update mask and not in the Topic object. If a field - * that does not support empty values is included in the update mask and not - * set in the Topic object, an `INVALID_ARGUMENT` error will be returned. - * The following fields may be specified: * `name` + * Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified: * `name` */ updateMask?: string; @@ -5771,15 +5192,7 @@ export namespace classroom_v1 { /** * classroom.invitations.accept - * @desc Accepts an invitation, removing it and adding the invited user to - * the teachers or students (as appropriate) of the specified course. Only - * the invited user may accept an invitation. This method returns the - * following error codes: * `PERMISSION_DENIED` if the requesting user is - * not permitted to accept the requested invitation or for access errors. * - * `FAILED_PRECONDITION` for the following request errors: * - * CourseMemberLimitReached * CourseNotModifiable * - * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * - * `NOT_FOUND` if no invitation exists with the requested ID. + * @desc Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID. * @alias classroom.invitations.accept * @memberOf! () * @@ -5851,15 +5264,7 @@ export namespace classroom_v1 { /** * classroom.invitations.create - * @desc Creates an invitation. Only one invitation for a user and course - * may exist at a time. Delete and re-create an invitation to make changes. - * This method returns the following error codes: * `PERMISSION_DENIED` if - * the requesting user is not permitted to create invitations for this - * course or for access errors. * `NOT_FOUND` if the course or the user does - * not exist. * `FAILED_PRECONDITION` if the requested user's account is - * disabled or if the user already has this role or a role with greater - * permissions. * `ALREADY_EXISTS` if an invitation for the specified user - * and course already exists. + * @desc Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists. * @alias classroom.invitations.create * @memberOf! () * @@ -5930,10 +5335,7 @@ export namespace classroom_v1 { /** * classroom.invitations.delete - * @desc Deletes an invitation. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * delete the requested invitation or for access errors. * `NOT_FOUND` if no - * invitation exists with the requested ID. + * @desc Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. * @alias classroom.invitations.delete * @memberOf! () * @@ -6005,10 +5407,7 @@ export namespace classroom_v1 { /** * classroom.invitations.get - * @desc Returns an invitation. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * view the requested invitation or for access errors. * `NOT_FOUND` if no - * invitation exists with the requested ID. + * @desc Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. * @alias classroom.invitations.get * @memberOf! () * @@ -6081,11 +5480,7 @@ export namespace classroom_v1 { /** * classroom.invitations.list - * @desc Returns a list of invitations that the requesting user is permitted - * to view, restricted to those that match the list request. *Note:* At - * least one of `user_id` or `course_id` must be supplied. Both fields can - * be supplied. This method returns the following error codes: * - * `PERMISSION_DENIED` for access errors. + * @desc Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * @alias classroom.invitations.list * @memberOf! () * @@ -6213,26 +5608,19 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts returned invitations to those for a course with the specified - * identifier. + * Restricts returned invitations to those for a course with the specified identifier. */ courseId?: string; /** - * Maximum number of items to return. Zero means no maximum. The server may - * return fewer than the specified number of results. + * Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * Restricts returned invitations to those for a specific user. The - * identifier can be one of the following: * the numeric identifier for the - * user * the email address of the user * the string literal `"me"`, - * indicating the requesting user + * Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -6245,27 +5633,7 @@ export namespace classroom_v1 { /** * classroom.registrations.create - * @desc Creates a `Registration`, causing Classroom to start sending - * notifications from the provided `feed` to the destination provided in - * `cloudPubSubTopic`. Returns the created `Registration`. Currently, this - * will be the same as the argument, but with server-assigned fields such as - * `expiry_time` and `id` filled in. Note that any value specified for the - * `expiry_time` or `id` fields will be ignored. While Classroom may - * validate the `cloudPubSubTopic` and return errors on a best effort basis, - * it is the caller's responsibility to ensure that it exists and that - * Classroom has permission to publish to it. This method may return the - * following error codes: * `PERMISSION_DENIED` if: * the authenticated - * user does not have permission to receive notifications from the - * requested field; or * the credential provided does not include the - * appropriate scope for the requested feed. * another access - * error is encountered. * `INVALID_ARGUMENT` if: * no - * `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is - * not valid; or * no `feed` is specified, or the specified `feed` is - * not valid. * `NOT_FOUND` if: * the specified `feed` cannot be - * located, or the requesting user does not have permission to - * determine whether or not it exists; or * the specified - * `cloudPubsubTopic` cannot be located, or Classroom has not been - * granted permission to publish to it. + * @desc Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the credential provided does not include the appropriate scope for the requested feed. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it. * @alias classroom.registrations.create * @memberOf! () * @@ -6336,8 +5704,7 @@ export namespace classroom_v1 { /** * classroom.registrations.delete - * @desc Deletes a `Registration`, causing Classroom to stop sending - * notifications for that `Registration`. + * @desc Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`. * @alias classroom.registrations.delete * @memberOf! () * @@ -6447,10 +5814,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.get - * @desc Returns a user profile. This method returns the following error - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to - * access this user profile, if no profile exists with the requested ID, or - * for access errors. + * @desc Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors. * @alias classroom.userProfiles.get * @memberOf! () * @@ -6529,9 +5893,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifier of the profile to return. The identifier can be one of the - * following: * the numeric identifier for the user * the email address of - * the user * the string literal `"me"`, indicating the requesting user + * Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -6544,30 +5906,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.create - * @desc Creates a guardian invitation, and sends an email to the guardian - * asking them to confirm that they are the student's guardian. Once the - * guardian accepts the invitation, their `state` will change to `COMPLETED` - * and they will start receiving guardian notifications. A `Guardian` - * resource will also be created to represent the active guardian. The - * request object must have the `student_id` and `invited_email_address` - * fields set. Failing to set these fields, or setting any other fields in - * the request, will result in an error. This method returns the following - * error codes: * `PERMISSION_DENIED` if the current user does not have - * permission to manage guardians, if the guardian in question has already - * rejected too many requests for that student, if guardians are not - * enabled for the domain in question, or for other access errors. * - * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian - * link limit. * `INVALID_ARGUMENT` if the guardian email address is not - * valid (for example, if it is too long), or if the format of the student - * ID provided cannot be recognized (it is not an email address, nor a - * `user_id` from this API). This error will also be returned if read-only - * fields are set, or if the `state` field is set to to a value other than - * `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student - * ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if - * there is already a pending guardian invitation for the student and - * `invited_email_address` provided, or if the provided - * `invited_email_address` matches the Google account of an existing - * `Guardian` for this user. + * @desc Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user. * @alias classroom.userProfiles.guardianInvitations.create * @memberOf! () * @@ -6641,17 +5980,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.get - * @desc Returns a specific guardian invitation. This method returns the - * following error codes: * `PERMISSION_DENIED` if the requesting user is - * not permitted to view guardian invitations for the student identified - * by the `student_id`, if guardians are not enabled for the domain in - * question, or for other access errors. * `INVALID_ARGUMENT` if a - * `student_id` is specified, but its format cannot be recognized (it is - * not an email address, nor a `student_id` from the API, nor the literal - * string `me`). * `NOT_FOUND` if Classroom cannot find any record of the - * given student or `invitation_id`. May also be returned if the student - * exists, but the requesting user does not have access to see that - * student. + * @desc Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student. * @alias classroom.userProfiles.guardianInvitations.get * @memberOf! () * @@ -6726,19 +6055,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.list - * @desc Returns a list of guardian invitations that the requesting user is - * permitted to view, filtered by the parameters provided. This method - * returns the following error codes: * `PERMISSION_DENIED` if a - * `student_id` is specified, and the requesting user is not permitted to - * view guardian invitations for that student, if `"-"` is specified as - * the `student_id` and the user is not a domain administrator, if - * guardians are not enabled for the domain in question, or for other - * access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but - * its format cannot be recognized (it is not an email address, nor a - * `student_id` from the API, nor the literal string `me`). May also be - * returned if an invalid `page_token` or `state` is provided. * - * `NOT_FOUND` if a `student_id` is specified, and its format can be - * recognized, but Classroom has no record of that student. + * @desc Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. * @alias classroom.userProfiles.guardianInvitations.list * @memberOf! () * @@ -6824,20 +6141,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.patch - * @desc Modifies a guardian invitation. Currently, the only valid - * modification is to change the `state` from `PENDING` to `COMPLETE`. This - * has the effect of withdrawing the invitation. This method returns the - * following error codes: * `PERMISSION_DENIED` if the current user does - * not have permission to manage guardians, if guardians are not enabled - * for the domain in question or for other access errors. * - * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. - * * `INVALID_ARGUMENT` if the format of the student ID provided cannot be - * recognized (it is not an email address, nor a `user_id` from this API), - * or if the passed `GuardianInvitation` has a `state` other than - * `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if - * the student ID provided is a valid student ID, but Classroom has no - * record of that student, or if the `id` field does not refer to a - * guardian invitation known to Classroom. + * @desc Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom. * @alias classroom.userProfiles.guardianInvitations.patch * @memberOf! () * @@ -6954,35 +6258,23 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If specified, only results with the specified `invited_email_address` - * will be returned. + * If specified, only results with the specified `invited_email_address` will be returned. */ invitedEmailAddress?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * If specified, only results with the specified `state` values will be - * returned. Otherwise, results with a `state` of `PENDING` will be - * returned. + * If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned. */ states?: string[]; /** - * The ID of the student whose guardian invitations are to be returned. The - * identifier can be one of the following: * the numeric identifier for the - * user * the email address of the user * the string literal `"me"`, - * indicating the requesting user * the string literal `"-"`, indicating - * that results should be returned for all students that the requesting - * user is permitted to view guardian invitations. + * The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. */ studentId?: string; } @@ -7002,11 +6294,7 @@ export namespace classroom_v1 { */ studentId?: string; /** - * Mask that identifies which fields on the course to update. This field is - * required to do an update. The update will fail if invalid fields are - * specified. The following fields are valid: * `state` When set in a - * query parameter, this field should be specified as - * `updateMask=,,...` + * Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` */ updateMask?: string; @@ -7024,18 +6312,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardians.delete - * @desc Deletes a guardian. The guardian will no longer receive guardian - * notifications and the guardian will no longer be accessible via the API. - * This method returns the following error codes: * `PERMISSION_DENIED` if - * no user that matches the provided `student_id` is visible to the - * requesting user, if the requesting user is not permitted to manage - * guardians for the student identified by the `student_id`, if guardians - * are not enabled for the domain in question, or for other access errors. - * * `INVALID_ARGUMENT` if a `student_id` is specified, but its format - * cannot be recognized (it is not an email address, nor a `student_id` - * from the API). * `NOT_FOUND` if the requesting user is permitted to - * modify guardians for the requested `student_id`, but no `Guardian` - * record exists for that student with the provided `guardian_id`. + * @desc Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`. * @alias classroom.userProfiles.guardians.delete * @memberOf! () * @@ -7107,17 +6384,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardians.get - * @desc Returns a specific guardian. This method returns the following - * error codes: * `PERMISSION_DENIED` if no user that matches the provided - * `student_id` is visible to the requesting user, if the requesting user - * is not permitted to view guardian information for the student - * identified by the `student_id`, if guardians are not enabled for the - * domain in question, or for other access errors. * `INVALID_ARGUMENT` if - * a `student_id` is specified, but its format cannot be recognized (it is - * not an email address, nor a `student_id` from the API, nor the literal - * string `me`). * `NOT_FOUND` if the requesting user is permitted to view - * guardians for the requested `student_id`, but no `Guardian` record - * exists for that student that matches the provided `guardian_id`. + * @desc Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`. * @alias classroom.userProfiles.guardians.get * @memberOf! () * @@ -7189,22 +6456,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardians.list - * @desc Returns a list of guardians that the requesting user is permitted - * to view, restricted to those that match the request. To list guardians - * for any student that the requesting user may view guardians for, use the - * literal character `-` for the student ID. This method returns the - * following error codes: * `PERMISSION_DENIED` if a `student_id` is - * specified, and the requesting user is not permitted to view guardian - * information for that student, if `"-"` is specified as the `student_id` - * and the user is not a domain administrator, if guardians are not - * enabled for the domain in question, if the `invited_email_address` - * filter is set by a user who is not a domain administrator, or for other - * access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but - * its format cannot be recognized (it is not an email address, nor a - * `student_id` from the API, nor the literal string `me`). May also be - * returned if an invalid `page_token` is provided. * `NOT_FOUND` if a - * `student_id` is specified, and its format can be recognized, but - * Classroom has no record of that student. + * @desc Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. * @alias classroom.userProfiles.guardians.list * @memberOf! () * @@ -7294,9 +6546,7 @@ export namespace classroom_v1 { */ guardianId?: string; /** - * The student whose guardian is to be deleted. One of the following: * the - * numeric identifier for the user * the email address of the user * the - * string literal `"me"`, indicating the requesting user + * The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ studentId?: string; } @@ -7312,9 +6562,7 @@ export namespace classroom_v1 { */ guardianId?: string; /** - * The student whose guardian is being requested. One of the following: * - * the numeric identifier for the user * the email address of the user * the - * string literal `"me"`, indicating the requesting user + * The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ studentId?: string; } @@ -7326,30 +6574,19 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Filter results by the email address that the original invitation was sent - * to, resulting in this guardian link. This filter can only be used by - * domain administrators. + * Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. */ invitedEmailAddress?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the - * server may assign a maximum. The server may return fewer than the - * specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that - * the subsequent page of results should be returned. The list request must - * be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * Filter results by the student who the guardian is linked to. The - * identifier can be one of the following: * the numeric identifier for the - * user * the email address of the user * the string literal `"me"`, - * indicating the requesting user * the string literal `"-"`, indicating - * that results should be returned for all students that the requesting - * user has access to view. + * Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. */ studentId?: string; } diff --git a/src/apis/cloudasset/package.json b/src/apis/cloudasset/package.json index f6481c90c62..b9937ffba17 100644 --- a/src/apis/cloudasset/package.json +++ b/src/apis/cloudasset/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index acc3f255205..01802fc7778 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudasset_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudasset_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace cloudasset_v1 { v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.v1 = new Resource$V1(this.context); @@ -121,8 +120,7 @@ export namespace cloudasset_v1 { } /** - * Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM - * policies, and other non-GCP assets. + * Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets. */ export interface Schema$Asset { /** @@ -130,16 +128,11 @@ export namespace cloudasset_v1 { */ assetType?: string; /** - * Representation of the actual Cloud IAM policy set on a cloud resource. - * For each resource, there must be at most one Cloud IAM policy set on it. + * Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it. */ iamPolicy?: Schema$Policy; /** - * The full name of the asset. For example: - * `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - * See [Resource - * Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - * for more information. + * The full name of the asset. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. */ name?: string; /** @@ -148,27 +141,7 @@ export namespace cloudasset_v1 { resource?: Schema$Resource; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -176,25 +149,16 @@ export namespace cloudasset_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -216,30 +180,15 @@ export namespace cloudasset_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -248,58 +197,40 @@ export namespace cloudasset_v1 { */ export interface Schema$ExportAssetsRequest { /** - * A list of asset types of which to take a snapshot for. For example: - * "compute.googleapis.com/Disk". If specified, only matching - * assets will be returned. See [Introduction to Cloud Asset - * Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) - * for all supported asset types. + * A list of asset types of which to take a snapshot for. For example: "compute.googleapis.com/Disk". If specified, only matching assets will be returned. See [Introduction to Cloud Asset Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) for all supported asset types. */ assetTypes?: string[]; /** - * Asset content type. If not specified, no content but the asset name will - * be returned. + * Asset content type. If not specified, no content but the asset name will be returned. */ contentType?: string; /** - * Required. Output configuration indicating where the results will be - * output to. All results will be in newline delimited JSON format. + * Required. Output configuration indicating where the results will be output to. All results will be in newline delimited JSON format. */ outputConfig?: Schema$OutputConfig; /** - * Timestamp to take an asset snapshot. This can only be set to a timestamp - * between 2018-10-02 UTC (inclusive) and the current time. If not - * specified, the current time will be used. Due to delays in resource data - * collection and indexing, there is a volatile window during which running - * the same query may get different results. + * Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results. */ readTime?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -308,23 +239,20 @@ export namespace cloudasset_v1 { */ export interface Schema$GcsDestination { /** - * The uri of the Cloud Storage object. It's the same uri that is used - * by gsutil. For example: "gs://bucket_name/object_name". See - * [Viewing and Editing Object - * Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) - * for more information. + * The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. */ uri?: string; + /** + * The uri prefix of all generated Cloud Storage objects. For example: "gs://bucket_name/object_name_prefix". Each object uri is in format: "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only contains assets for that type. <shard number> starts from 0. For example: "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is the first shard of output objects containing all compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be returned if file with the same name "gs://bucket_name/object_name_prefix" already exists. + */ + uriPrefix?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -332,26 +260,15 @@ export namespace cloudasset_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -365,24 +282,7 @@ export namespace cloudasset_v1 { gcsDestination?: Schema$GcsDestination; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -390,20 +290,11 @@ export namespace cloudasset_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -416,40 +307,23 @@ export namespace cloudasset_v1 { */ export interface Schema$Resource { /** - * The content of the resource, in which some sensitive fields are scrubbed - * away and may not be present. + * The content of the resource, in which some sensitive fields are scrubbed away and may not be present. */ data?: {[key: string]: any}; /** - * The URL of the discovery document containing the resource's JSON - * schema. For example: - * `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. - * It will be left unspecified for resources without a discovery-based API, - * such as Cloud Bigtable. + * The URL of the discovery document containing the resource's JSON schema. For example: `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. It will be left unspecified for resources without a discovery-based API, such as Cloud Bigtable. */ discoveryDocumentUri?: string; /** - * The JSON schema name listed in the discovery document. Example: - * "Project". It will be left unspecified for resources (such as - * Cloud Bigtable) without a discovery-based API. + * The JSON schema name listed in the discovery document. Example: "Project". It will be left unspecified for resources (such as Cloud Bigtable) without a discovery-based API. */ discoveryName?: string; /** - * The full name of the immediate parent of this resource. See [Resource - * Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - * for more information. For GCP assets, it is the parent resource defined - * in the [Cloud IAM policy - * hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). - * For example: - * `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. - * For third-party assets, it is up to the users to define. + * The full name of the immediate parent of this resource. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. For GCP assets, it is the parent resource defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). For example: `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. For third-party assets, it is up to the users to define. */ parent?: string; /** - * The REST URL for accessing the resource. An HTTP GET operation using this - * URL returns the resource itself. Example: - * `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. - * It will be left unspecified for resources without a REST API. + * The REST URL for accessing the resource. An HTTP GET operation using this URL returns the resource itself. Example: `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. It will be left unspecified for resources without a REST API. */ resourceUrl?: string; /** @@ -458,40 +332,7 @@ export namespace cloudasset_v1 { version?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -499,20 +340,16 @@ export namespace cloudasset_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Temporal asset. In addition to the asset, the temporal asset includes the - * status of the asset and valid from and to time of it. + * Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it. */ export interface Schema$TemporalAsset { /** @@ -533,8 +370,7 @@ export namespace cloudasset_v1 { */ export interface Schema$TimeWindow { /** - * End time of the time window (inclusive). Current timestamp if not - * specified. + * End time of the time window (inclusive). Current timestamp if not specified. */ endTime?: string; /** @@ -551,9 +387,7 @@ export namespace cloudasset_v1 { /** * cloudasset.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudasset.operations.get * @memberOf! () * @@ -642,12 +476,7 @@ export namespace cloudasset_v1 { /** * cloudasset.batchGetAssetsHistory - * @desc Batch gets the update history of assets that overlap a time window. - * For RESOURCE content, this API outputs history with asset in both - * non-delete or deleted status. For IAM_POLICY content, this API outputs - * history when the asset and its attached IAM POLICY both exist. This can - * create gaps in the output history. If a specified asset does not exist, - * this API returns an INVALID_ARGUMENT error. + * @desc Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error. * @alias cloudasset.batchGetAssetsHistory * @memberOf! () * @@ -734,10 +563,7 @@ export namespace cloudasset_v1 { /** * cloudasset.exportAssets - * @desc Exports assets with time and resource types to a given Cloud - * Storage location. The output format is newline-delimited JSON. This API - * implements the google.longrunning.Operation API allowing you to keep - * track of the export. + * @desc Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export. * @alias cloudasset.exportAssets * @memberOf! () * @@ -818,14 +644,7 @@ export namespace cloudasset_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of the full names of the assets. For example: - * `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - * See [Resource - * Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - * and [Resource Name - * Format](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/resource-name-format) - * for more info. The request becomes a no-op if the asset name list is - * empty, and the max size of the asset name list is 100 in one request. + * A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) and [Resource Name Format](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/resource-name-format) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. */ assetNames?: string[]; /** @@ -833,15 +652,11 @@ export namespace cloudasset_v1 { */ contentType?: string; /** - * Required. The relative name of the root asset. It can only be an - * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id")", or a project number (such as - * "projects/12345"). + * Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). */ parent?: string; /** - * End time of the time window (inclusive). Current timestamp if not - * specified. + * End time of the time window (inclusive). Current timestamp if not specified. */ 'readTimeWindow.endTime'?: string; /** @@ -856,10 +671,7 @@ export namespace cloudasset_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The relative name of the root asset. This can only be an - * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id"), or a project number (such as - * "projects/12345"), or a folder number (such as "folders/123"). + * Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123"). */ parent?: string; diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index ba62d02e24a..261c803788a 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudasset_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudasset_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace cloudasset_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.folders = new Resource$Folders(this.context); this.organizations = new Resource$Organizations(this.context); @@ -123,8 +122,7 @@ export namespace cloudasset_v1beta1 { } /** - * Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM - * policies, and other non-GCP assets. + * Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets. */ export interface Schema$Asset { /** @@ -132,16 +130,11 @@ export namespace cloudasset_v1beta1 { */ assetType?: string; /** - * Representation of the actual Cloud IAM policy set on a cloud resource. - * For each resource, there must be at most one Cloud IAM policy set on it. + * Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it. */ iamPolicy?: Schema$Policy; /** - * The full name of the asset. For example: - * `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - * See [Resource - * Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - * for more information. + * The full name of the asset. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. */ name?: string; /** @@ -150,27 +143,7 @@ export namespace cloudasset_v1beta1 { resource?: Schema$Resource; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -178,25 +151,16 @@ export namespace cloudasset_v1beta1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -218,30 +182,15 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -250,58 +199,40 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$ExportAssetsRequest { /** - * A list of asset types of which to take a snapshot for. For example: - * "google.compute.Disk". If specified, only matching assets will - * be returned. See [Introduction to Cloud Asset - * Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) - * for all supported asset types. + * A list of asset types of which to take a snapshot for. For example: "google.compute.Disk". If specified, only matching assets will be returned. See [Introduction to Cloud Asset Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) for all supported asset types. */ assetTypes?: string[]; /** - * Asset content type. If not specified, no content but the asset name will - * be returned. + * Asset content type. If not specified, no content but the asset name will be returned. */ contentType?: string; /** - * Required. Output configuration indicating where the results will be - * output to. All results will be in newline delimited JSON format. + * Required. Output configuration indicating where the results will be output to. All results will be in newline delimited JSON format. */ outputConfig?: Schema$OutputConfig; /** - * Timestamp to take an asset snapshot. This can only be set to a timestamp - * between 2018-10-02 UTC (inclusive) and the current time. If not - * specified, the current time will be used. Due to delays in resource data - * collection and indexing, there is a volatile window during which running - * the same query may get different results. + * Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results. */ readTime?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -310,23 +241,20 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$GcsDestination { /** - * The uri of the Cloud Storage object. It's the same uri that is used - * by gsutil. For example: "gs://bucket_name/object_name". See - * [Viewing and Editing Object - * Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) - * for more information. + * The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. */ uri?: string; + /** + * The uri prefix of all generated Cloud Storage objects. For example: "gs://bucket_name/object_name_prefix". Each object uri is in format: "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only contains assets for that type. <shard number> starts from 0. For example: "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first shard of output objects containing all google.compute.disk assets. An INVALID_ARGUMENT error will be returned if file with the same name "gs://bucket_name/object_name_prefix" already exists. + */ + uriPrefix?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -334,26 +262,15 @@ export namespace cloudasset_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -367,24 +284,7 @@ export namespace cloudasset_v1beta1 { gcsDestination?: Schema$GcsDestination; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -392,20 +292,11 @@ export namespace cloudasset_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -418,40 +309,23 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$Resource { /** - * The content of the resource, in which some sensitive fields are scrubbed - * away and may not be present. + * The content of the resource, in which some sensitive fields are scrubbed away and may not be present. */ data?: {[key: string]: any}; /** - * The URL of the discovery document containing the resource's JSON - * schema. For example: - * `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. - * It will be left unspecified for resources without a discovery-based API, - * such as Cloud Bigtable. + * The URL of the discovery document containing the resource's JSON schema. For example: `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. It will be left unspecified for resources without a discovery-based API, such as Cloud Bigtable. */ discoveryDocumentUri?: string; /** - * The JSON schema name listed in the discovery document. Example: - * "Project". It will be left unspecified for resources (such as - * Cloud Bigtable) without a discovery-based API. + * The JSON schema name listed in the discovery document. Example: "Project". It will be left unspecified for resources (such as Cloud Bigtable) without a discovery-based API. */ discoveryName?: string; /** - * The full name of the immediate parent of this resource. See [Resource - * Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - * for more information. For GCP assets, it is the parent resource defined - * in the [Cloud IAM policy - * hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). - * For example: - * `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. - * For third-party assets, it is up to the users to define. + * The full name of the immediate parent of this resource. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. For GCP assets, it is the parent resource defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). For example: `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. For third-party assets, it is up to the users to define. */ parent?: string; /** - * The REST URL for accessing the resource. An HTTP GET operation using this - * URL returns the resource itself. Example: - * `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. - * It will be left unspecified for resources without a REST API. + * The REST URL for accessing the resource. An HTTP GET operation using this URL returns the resource itself. Example: `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. It will be left unspecified for resources without a REST API. */ resourceUrl?: string; /** @@ -460,40 +334,7 @@ export namespace cloudasset_v1beta1 { version?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -501,20 +342,16 @@ export namespace cloudasset_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Temporal asset. In addition to the asset, the temporal asset includes the - * status of the asset and valid from and to time of it. + * Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it. */ export interface Schema$TemporalAsset { /** @@ -535,8 +372,7 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$TimeWindow { /** - * End time of the time window (inclusive). Current timestamp if not - * specified. + * End time of the time window (inclusive). Current timestamp if not specified. */ endTime?: string; /** @@ -555,10 +391,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.folders.exportAssets - * @desc Exports assets with time and resource types to a given Cloud - * Storage location. The output format is newline-delimited JSON. This API - * implements the google.longrunning.Operation API allowing you to keep - * track of the export. + * @desc Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export. * @alias cloudasset.folders.exportAssets * @memberOf! () * @@ -640,10 +473,7 @@ export namespace cloudasset_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The relative name of the root asset. This can only be an - * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id"), a project number (such as "projects/12345"), - * or a folder number (such as "folders/123"). + * Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), a project number (such as "projects/12345"), or a folder number (such as "folders/123"). */ parent?: string; @@ -661,9 +491,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.folders.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudasset.folders.operations.get * @memberOf! () * @@ -756,12 +584,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.organizations.batchGetAssetsHistory - * @desc Batch gets the update history of assets that overlap a time window. - * For RESOURCE content, this API outputs history with asset in both - * non-delete or deleted status. For IAM_POLICY content, this API outputs - * history when the asset and its attached IAM POLICY both exist. This can - * create gaps in the output history. If a specified asset does not exist, - * this API returns an INVALID_ARGUMENT error. + * @desc Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error. * @alias cloudasset.organizations.batchGetAssetsHistory * @memberOf! () * @@ -848,10 +671,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.organizations.exportAssets - * @desc Exports assets with time and resource types to a given Cloud - * Storage location. The output format is newline-delimited JSON. This API - * implements the google.longrunning.Operation API allowing you to keep - * track of the export. + * @desc Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export. * @alias cloudasset.organizations.exportAssets * @memberOf! () * @@ -933,12 +753,7 @@ export namespace cloudasset_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of the full names of the assets. For example: - * `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - * See [Resource - * Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - * for more info. The request becomes a no-op if the asset name list is - * empty, and the max size of the asset name list is 100 in one request. + * A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. */ assetNames?: string[]; /** @@ -946,15 +761,11 @@ export namespace cloudasset_v1beta1 { */ contentType?: string; /** - * Required. The relative name of the root asset. It can only be an - * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id")", or a project number (such as - * "projects/12345"). + * Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). */ parent?: string; /** - * End time of the time window (inclusive). Current timestamp if not - * specified. + * End time of the time window (inclusive). Current timestamp if not specified. */ 'readTimeWindow.endTime'?: string; /** @@ -970,10 +781,7 @@ export namespace cloudasset_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The relative name of the root asset. This can only be an - * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id"), a project number (such as "projects/12345"), - * or a folder number (such as "folders/123"). + * Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), a project number (such as "projects/12345"), or a folder number (such as "folders/123"). */ parent?: string; @@ -991,9 +799,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.organizations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudasset.organizations.operations.get * @memberOf! () * @@ -1086,12 +892,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.projects.batchGetAssetsHistory - * @desc Batch gets the update history of assets that overlap a time window. - * For RESOURCE content, this API outputs history with asset in both - * non-delete or deleted status. For IAM_POLICY content, this API outputs - * history when the asset and its attached IAM POLICY both exist. This can - * create gaps in the output history. If a specified asset does not exist, - * this API returns an INVALID_ARGUMENT error. + * @desc Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error. * @alias cloudasset.projects.batchGetAssetsHistory * @memberOf! () * @@ -1178,10 +979,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.projects.exportAssets - * @desc Exports assets with time and resource types to a given Cloud - * Storage location. The output format is newline-delimited JSON. This API - * implements the google.longrunning.Operation API allowing you to keep - * track of the export. + * @desc Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export. * @alias cloudasset.projects.exportAssets * @memberOf! () * @@ -1263,12 +1061,7 @@ export namespace cloudasset_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of the full names of the assets. For example: - * `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - * See [Resource - * Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - * for more info. The request becomes a no-op if the asset name list is - * empty, and the max size of the asset name list is 100 in one request. + * A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. */ assetNames?: string[]; /** @@ -1276,15 +1069,11 @@ export namespace cloudasset_v1beta1 { */ contentType?: string; /** - * Required. The relative name of the root asset. It can only be an - * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id")", or a project number (such as - * "projects/12345"). + * Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). */ parent?: string; /** - * End time of the time window (inclusive). Current timestamp if not - * specified. + * End time of the time window (inclusive). Current timestamp if not specified. */ 'readTimeWindow.endTime'?: string; /** @@ -1300,10 +1089,7 @@ export namespace cloudasset_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The relative name of the root asset. This can only be an - * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id"), a project number (such as "projects/12345"), - * or a folder number (such as "folders/123"). + * Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), a project number (such as "projects/12345"), or a folder number (such as "folders/123"). */ parent?: string; @@ -1321,9 +1107,7 @@ export namespace cloudasset_v1beta1 { /** * cloudasset.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudasset.projects.operations.get * @memberOf! () * diff --git a/src/apis/cloudbilling/package.json b/src/apis/cloudbilling/package.json index b007e96adad..3b44f209f73 100644 --- a/src/apis/cloudbilling/package.json +++ b/src/apis/cloudbilling/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index b878e63babf..0f25f2ae498 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudbilling_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudbilling_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudbilling_v1 { /** * Cloud Billing API * - * Allows developers to manage billing for their Google Cloud Platform - * projects programmatically. + * Allows developers to manage billing for their Google Cloud Platform projects programmatically. * * @example * const {google} = require('googleapis'); @@ -115,7 +110,10 @@ export namespace cloudbilling_v1 { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.billingAccounts = new Resource$Billingaccounts(this.context); this.projects = new Resource$Projects(this.context); @@ -128,36 +126,14 @@ export namespace cloudbilling_v1 { */ export interface Schema$AggregationInfo { /** - * The number of intervals to aggregate over. Example: If aggregation_level - * is "DAILY" and aggregation_count is 14, aggregation will be - * over 14 days. + * The number of intervals to aggregate over. Example: If aggregation_level is "DAILY" and aggregation_count is 14, aggregation will be over 14 days. */ aggregationCount?: number; aggregationInterval?: string; aggregationLevel?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -165,25 +141,16 @@ export namespace cloudbilling_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -192,34 +159,23 @@ export namespace cloudbilling_v1 { logType?: string; } /** - * A billing account in [GCP Console](https://console.cloud.google.com/). You - * can assign a billing account to one or more projects. + * A billing account in [GCP Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. */ export interface Schema$BillingAccount { /** - * The display name given to the billing account, such as `My Billing - * Account`. This name is displayed in the GCP Console. + * The display name given to the billing account, such as `My Billing Account`. This name is displayed in the GCP Console. */ displayName?: string; /** - * If this account is a - * [subaccount](https://cloud.google.com/billing/docs/concepts), then this - * will be the resource name of the master billing account that it is being - * resold through. Otherwise this will be empty. + * If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the master billing account that it is being resold through. Otherwise this will be empty. */ masterBillingAccount?: string; /** - * The resource name of the billing account. The resource name has the form - * `billingAccounts/{billing_account_id}`. For example, - * `billingAccounts/012345-567890-ABCDEF` would be the resource name for - * billing account `012345-567890-ABCDEF`. + * The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. */ name?: string; /** - * True if the billing account is open, and will therefore be charged for - * any usage on associated projects. False if the billing account is closed, - * and therefore projects associated with it will be unable to use paid - * services. + * True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. */ open?: boolean; } @@ -228,30 +184,15 @@ export namespace cloudbilling_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -260,15 +201,11 @@ export namespace cloudbilling_v1 { */ export interface Schema$Category { /** - * The type of product the SKU refers to. Example: "Compute", - * "Storage", "Network", "ApplicationServices" - * etc. + * The type of product the SKU refers to. Example: "Compute", "Storage", "Network", "ApplicationServices" etc. */ resourceFamily?: string; /** - * A group classification for related SKUs. Example: "RAM", - * "GPU", "Prediction", "Ops", - * "GoogleEgress" etc. + * A group classification for related SKUs. Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc. */ resourceGroup?: string; /** @@ -276,38 +213,28 @@ export namespace cloudbilling_v1 { */ serviceDisplayName?: string; /** - * Represents how the SKU is consumed. Example: "OnDemand", - * "Preemptible", "Commit1Mo", "Commit1Yr" - * etc. + * Represents how the SKU is consumed. Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc. */ usageType?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -320,9 +247,7 @@ export namespace cloudbilling_v1 { */ billingAccounts?: Schema$BillingAccount[]; /** - * A token to retrieve the next page of results. To retrieve the next page, - * call `ListBillingAccounts` again with the `page_token` field set to this - * value. This field is empty if there are no more results to retrieve. + * A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ nextPageToken?: string; } @@ -331,14 +256,11 @@ export namespace cloudbilling_v1 { */ export interface Schema$ListProjectBillingInfoResponse { /** - * A token to retrieve the next page of results. To retrieve the next page, - * call `ListProjectBillingInfo` again with the `page_token` field set to - * this value. This field is empty if there are no more results to retrieve. + * A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ nextPageToken?: string; /** - * A list of `ProjectBillingInfo` resources representing the projects - * associated with the billing account. + * A list of `ProjectBillingInfo` resources representing the projects associated with the billing account. */ projectBillingInfo?: Schema$ProjectBillingInfo[]; } @@ -347,9 +269,7 @@ export namespace cloudbilling_v1 { */ export interface Schema$ListServicesResponse { /** - * A token to retrieve the next page of results. To retrieve the next page, - * call `ListServices` again with the `page_token` field set to this value. - * This field is empty if there are no more results to retrieve. + * A token to retrieve the next page of results. To retrieve the next page, call `ListServices` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ nextPageToken?: string; /** @@ -362,9 +282,7 @@ export namespace cloudbilling_v1 { */ export interface Schema$ListSkusResponse { /** - * A token to retrieve the next page of results. To retrieve the next page, - * call `ListSkus` again with the `page_token` field set to this value. This - * field is empty if there are no more results to retrieve. + * A token to retrieve the next page of results. To retrieve the next page, call `ListSkus` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. */ nextPageToken?: string; /** @@ -381,39 +299,16 @@ export namespace cloudbilling_v1 { */ currencyCode?: string; /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ nanos?: number; /** - * The whole units of the amount. For example if `currencyCode` is - * `"USD"`, then 1 unit is one US dollar. + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ units?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -421,20 +316,11 @@ export namespace cloudbilling_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -443,24 +329,15 @@ export namespace cloudbilling_v1 { version?: number; } /** - * Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` - * `tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` - * `[start_usage_amount: 100, unit_price: $5]` The above expresses a pricing - * formula where the first 20GB is free, the next 80GB is priced at $10 per GB - * followed by $5 per GB for additional usage. + * Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` `tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` `[start_usage_amount: 100, unit_price: $5]` The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage. */ export interface Schema$PricingExpression { /** - * The base unit for the SKU which is the unit used in usage exports. - * Example: "By" + * The base unit for the SKU which is the unit used in usage exports. Example: "By" */ baseUnit?: string; /** - * Conversion factor for converting from price per usage_unit to price per - * base_unit, and start_usage_amount to start_usage_amount in base_unit. - * unit_price / base_unit_conversion_factor = price per base_unit. - * start_usage_amount * base_unit_conversion_factor = start_usage_amount in - * base_unit. + * Conversion factor for converting from price per usage_unit to price per base_unit, and start_usage_amount to start_usage_amount in base_unit. unit_price / base_unit_conversion_factor = price per base_unit. start_usage_amount * base_unit_conversion_factor = start_usage_amount in base_unit. */ baseUnitConversionFactor?: number; /** @@ -468,26 +345,15 @@ export namespace cloudbilling_v1 { */ baseUnitDescription?: string; /** - * The recommended quantity of units for displaying pricing info. When - * displaying pricing info it is recommended to display: (unit_price * - * display_quantity) per display_quantity usage_unit. This field does not - * affect the pricing formula and is for display purposes only. Example: If - * the unit_price is "0.0001 USD", the usage_unit is - * "GB" and the display_quantity is "1000" then the - * recommended way of displaying the pricing info is "0.10 USD per 1000 - * GB" + * The recommended quantity of units for displaying pricing info. When displaying pricing info it is recommended to display: (unit_price * display_quantity) per display_quantity usage_unit. This field does not affect the pricing formula and is for display purposes only. Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and the display_quantity is "1000" then the recommended way of displaying the pricing info is "0.10 USD per 1000 GB" */ displayQuantity?: number; /** - * The list of tiered rates for this pricing. The total cost is computed by - * applying each of the tiered rates on usage. This repeated list is sorted - * by ascending order of start_usage_amount. + * The list of tiered rates for this pricing. The total cost is computed by applying each of the tiered rates on usage. This repeated list is sorted by ascending order of start_usage_amount. */ tieredRates?: Schema$TierRate[]; /** - * The short hand for unit of usage this pricing is specified in. Example: - * usage_unit of "GiBy" means that usage is specified in - * "Gibi Byte". + * The short hand for unit of usage this pricing is specified in. Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte". */ usageUnit?: string; /** @@ -500,25 +366,15 @@ export namespace cloudbilling_v1 { */ export interface Schema$PricingInfo { /** - * Aggregation Info. This can be left unspecified if the pricing expression - * doesn't require aggregation. + * Aggregation Info. This can be left unspecified if the pricing expression doesn't require aggregation. */ aggregationInfo?: Schema$AggregationInfo; /** - * Conversion rate used for currency conversion, from USD to the currency - * specified in the request. This includes any surcharge collected for - * billing in non USD currency. If a currency is not specified in the - * request this defaults to 1.0. Example: USD * currency_conversion_rate = - * JPY + * Conversion rate used for currency conversion, from USD to the currency specified in the request. This includes any surcharge collected for billing in non USD currency. If a currency is not specified in the request this defaults to 1.0. Example: USD * currency_conversion_rate = JPY */ currencyConversionRate?: number; /** - * The timestamp from which this pricing was effective within the requested - * time range. This is guaranteed to be greater than or equal to the - * start_time field in the request and less than the end_time field in the - * request. If a time range was not specified in the request this field will - * be equivalent to a time within the last 12 hours, indicating the latest - * pricing info. + * The timestamp from which this pricing was effective within the requested time range. This is guaranteed to be greater than or equal to the start_time field in the request and less than the end_time field in the request. If a time range was not specified in the request this field will be equivalent to a time within the last 12 hours, indicating the latest pricing info. */ effectiveTime?: string; /** @@ -526,41 +382,28 @@ export namespace cloudbilling_v1 { */ pricingExpression?: Schema$PricingExpression; /** - * An optional human readable summary of the pricing information, has a - * maximum length of 256 characters. + * An optional human readable summary of the pricing information, has a maximum length of 256 characters. */ summary?: string; } /** - * Encapsulation of billing information for a GCP Console project. A project - * has at most one associated billing account at a time (but a billing account - * can be assigned to multiple projects). + * Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects). */ export interface Schema$ProjectBillingInfo { /** - * The resource name of the billing account associated with the project, if - * any. For example, `billingAccounts/012345-567890-ABCDEF`. + * The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`. */ billingAccountName?: string; /** - * True if the project is associated with an open billing account, to which - * usage on the project is charged. False if the project is associated with - * a closed billing account, or no billing account at all, and therefore - * cannot use paid services. This field is read-only. + * True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only. */ billingEnabled?: boolean; /** - * The resource name for the `ProjectBillingInfo`; has the form - * `projects/{project_id}/billingInfo`. For example, the resource name for - * the billing information for project `tokyo-rain-123` would be - * `projects/tokyo-rain-123/billingInfo`. This field is read-only. + * The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only. */ name?: string; /** - * The ID of the project that this `ProjectBillingInfo` represents, such as - * `tokyo-rain-123`. This is a convenience field so that you don't need - * to parse the `name` field to obtain a project ID. This field is - * read-only. + * The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only. */ projectId?: string; } @@ -569,8 +412,7 @@ export namespace cloudbilling_v1 { */ export interface Schema$Service { /** - * The business under which the service is offered. Ex. - * "businessEntities/GCP", "businessEntities/Maps" + * The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps" */ businessEntityName?: string; /** @@ -578,8 +420,7 @@ export namespace cloudbilling_v1 { */ displayName?: string; /** - * The resource name for the service. Example: - * "services/DA34-426B-A397" + * The resource name for the service. Example: "services/DA34-426B-A397" */ name?: string; /** @@ -592,17 +433,11 @@ export namespace cloudbilling_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -615,13 +450,11 @@ export namespace cloudbilling_v1 { */ category?: Schema$Category; /** - * A human readable description of the SKU, has a maximum length of 256 - * characters. + * A human readable description of the SKU, has a maximum length of 256 characters. */ description?: string; /** - * The resource name for the SKU. Example: - * "services/DA34-426B-A397/skus/AA95-CD31-42FE" + * The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" */ name?: string; /** @@ -629,14 +462,11 @@ export namespace cloudbilling_v1 { */ pricingInfo?: Schema$PricingInfo[]; /** - * Identifies the service provider. This is 'Google' for first party - * services in Google Cloud Platform. + * Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform. */ serviceProviderName?: string; /** - * List of service regions this SKU is offered at. Example: - * "asia-east1" Service regions can be found at - * https://cloud.google.com/about/locations/ + * List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/ */ serviceRegions?: string[]; /** @@ -649,10 +479,7 @@ export namespace cloudbilling_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -661,8 +488,7 @@ export namespace cloudbilling_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -671,14 +497,11 @@ export namespace cloudbilling_v1 { */ export interface Schema$TierRate { /** - * Usage is priced at this rate only after this amount. Example: - * start_usage_amount of 10 indicates that the usage will be priced at the - * unit_price after the first 10 usage_units. + * Usage is priced at this rate only after this amount. Example: start_usage_amount of 10 indicates that the usage will be priced at the unit_price after the first 10 usage_units. */ startUsageAmount?: number; /** - * The price per unit of usage. Example: unit_price of amount $10 indicates - * that each unit will cost $10. + * The price per unit of usage. Example: unit_price of amount $10 indicates that each unit will cost $10. */ unitPrice?: Schema$Money; } @@ -693,14 +516,7 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.create - * @desc Creates a billing account. This method can only be used to create - * [billing subaccounts](https://cloud.google.com/billing/docs/concepts) by - * GCP resellers. When creating a subaccount, the current authenticated user - * must have the `billing.accounts.update` IAM permission on the master - * account, which is typically given to billing account - * [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). - * This method will return an error if the master account has not been - * provisioned as a reseller account. + * @desc Creates a billing account. This method can only be used to create [billing subaccounts](https://cloud.google.com/billing/docs/concepts) by GCP resellers. When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the master account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the master account has not been provisioned as a reseller account. * @alias cloudbilling.billingAccounts.create * @memberOf! () * @@ -774,23 +590,19 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.get - * @desc Gets information about a billing account. The current authenticated - * user must be a [viewer of the billing - * account](https://cloud.google.com/billing/docs/how-to/billing-access). + * @desc Gets information about a billing account. The current authenticated user must be a [viewer of the billing account](https://cloud.google.com/billing/docs/how-to/billing-access). * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -801,8 +613,7 @@ export namespace cloudbilling_v1 { * var request = { * // The resource name of the billing account to retrieve. For example, * // `billingAccounts/012345-567890-ABCDEF`. - * name: 'billingAccounts/my-billing-account', // TODO: Update - * placeholder value. + * name: 'billingAccounts/my-billing-account', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -824,10 +635,9 @@ export namespace cloudbilling_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -902,10 +712,7 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.getIamPolicy - * @desc Gets the access control policy for a billing account. The caller - * must have the `billing.accounts.getIamPolicy` permission on the account, - * which is often given to billing account - * [viewers](https://cloud.google.com/billing/docs/how-to/billing-access). + * @desc Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access). * @alias cloudbilling.billingAccounts.getIamPolicy * @memberOf! () * @@ -977,23 +784,19 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.list - * @desc Lists the billing accounts that the current authenticated user has - * permission to - * [view](https://cloud.google.com/billing/docs/how-to/billing-access). + * @desc Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access). * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1016,9 +819,8 @@ export namespace cloudbilling_v1 { * return; * } * for (var i = 0; i < billingAccountsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `billingAccountsPage`: console.log(JSON.stringify(billingAccountsPage[i], - * null, 2)); + * // TODO: Change code below to process each resource in `billingAccountsPage`: + * console.log(JSON.stringify(billingAccountsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1036,10 +838,9 @@ export namespace cloudbilling_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1126,12 +927,7 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.patch - * @desc Updates a billing account's fields. Currently the only field that - * can be edited is `display_name`. The current authenticated user must have - * the `billing.accounts.update` IAM permission, which is typically given to - * the - * [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) - * of the billing account. + * @desc Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account. * @alias cloudbilling.billingAccounts.patch * @memberOf! () * @@ -1204,10 +1000,7 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.setIamPolicy - * @desc Sets the access control policy for a billing account. Replaces any - * existing policy. The caller must have the `billing.accounts.setIamPolicy` - * permission on the account, which is often given to billing account - * [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). + * @desc Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). * @alias cloudbilling.billingAccounts.setIamPolicy * @memberOf! () * @@ -1280,10 +1073,7 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.testIamPermissions - * @desc Tests the access control policy for a billing account. This method - * takes the resource and a set of permissions as input and returns the - * subset of the input permissions that the caller is allowed for that - * resource. + * @desc Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource. * @alias cloudbilling.billingAccounts.testIamPermissions * @memberOf! () * @@ -1384,8 +1174,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the billing account to retrieve. For example, - * `billingAccounts/012345-567890-ABCDEF`. + * The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. */ name?: string; } @@ -1397,8 +1186,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1410,23 +1198,15 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Options for how to filter the returned billing accounts. Currently this - * only supports filtering for - * [subaccounts](https://cloud.google.com/billing/docs/concepts) under a - * single provided reseller billing account. (e.g. - * "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean - * algebra and other fields are not currently supported. + * Options for how to filter the returned billing accounts. Currently this only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided reseller billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported. */ filter?: string; /** - * Requested page size. The maximum page size is 100; this is also the - * default. + * Requested page size. The maximum page size is 100; this is also the default. */ pageSize?: number; /** - * A token identifying a page of results to return. This should be a - * `next_page_token` value returned from a previous `ListBillingAccounts` - * call. If unspecified, the first page of results is returned. + * A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned. */ pageToken?: string; } @@ -1442,8 +1222,7 @@ export namespace cloudbilling_v1 { */ name?: string; /** - * The update mask applied to the resource. Only "display_name" is currently - * supported. + * The update mask applied to the resource. Only "display_name" is currently supported. */ updateMask?: string; @@ -1460,8 +1239,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1478,8 +1256,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1497,24 +1274,19 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.projects.list - * @desc Lists the projects associated with a billing account. The current - * authenticated user must have the `billing.resourceAssociations.list` IAM - * permission, which is often given to billing account - * [viewers](https://cloud.google.com/billing/docs/how-to/billing-access). + * @desc Lists the projects associated with a billing account. The current authenticated user must have the `billing.resourceAssociations.list` IAM permission, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access). * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1523,11 +1295,9 @@ export namespace cloudbilling_v1 { * * authorize(function(authClient) { * var request = { - * // The resource name of the billing account associated with the - * projects that - * // you want to list. For example, - * `billingAccounts/012345-567890-ABCDEF`. name: - * 'billingAccounts/my-billing-account', // TODO: Update placeholder value. + * // The resource name of the billing account associated with the projects that + * // you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. + * name: 'billingAccounts/my-billing-account', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1543,8 +1313,7 @@ export namespace cloudbilling_v1 { * return; * } * for (var i = 0; i < projectBillingInfoPage.length; i++) { - * // TODO: Change code below to process each resource in - * `projectBillingInfoPage`: + * // TODO: Change code below to process each resource in `projectBillingInfoPage`: * console.log(JSON.stringify(projectBillingInfoPage[i], null, 2)); * } * @@ -1563,10 +1332,9 @@ export namespace cloudbilling_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1662,20 +1430,15 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the billing account associated with the projects - * that you want to list. For example, - * `billingAccounts/012345-567890-ABCDEF`. + * The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. */ name?: string; /** - * Requested page size. The maximum page size is 100; this is also the - * default. + * Requested page size. The maximum page size is 100; this is also the default. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous `ListProjectBillingInfo` - * call. If unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned. */ pageToken?: string; } @@ -1688,24 +1451,19 @@ export namespace cloudbilling_v1 { /** * cloudbilling.projects.getBillingInfo - * @desc Gets the billing information for a project. The current - * authenticated user must have [permission to view the - * project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo - * ). + * @desc Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ). * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1738,10 +1496,9 @@ export namespace cloudbilling_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1821,46 +1578,19 @@ export namespace cloudbilling_v1 { /** * cloudbilling.projects.updateBillingInfo - * @desc Sets or updates the billing account associated with a project. You - * specify the new billing account by setting the `billing_account_name` in - * the `ProjectBillingInfo` resource to the resource name of a billing - * account. Associating a project with an open billing account enables - * billing on the project and allows charges for resource usage. If the - * project already had a billing account, this method changes the billing - * account used for resource usage charges. *Note:* Incurred charges that - * have not yet been reported in the transaction history of the GCP Console - * might be billed to the new billing account, even if the charge occurred - * before the new billing account was assigned to the project. The current - * authenticated user must have ownership privileges for both the - * [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo - * ) and the [billing - * account](https://cloud.google.com/billing/docs/how-to/billing-access). - * You can disable billing on the project by setting the - * `billing_account_name` field to empty. This action disassociates the - * current billing account from the project. Any billable activity of your - * in-use services will stop, and your application could stop functioning as - * expected. Any unbilled charges to date will be billed to the previously - * associated account. The current authenticated user must be either an - * owner of the project or an owner of the billing account for the project. - * Note that associating a project with a *closed* billing account will have - * much the same effect as disabling billing on the project: any paid - * resources used by the project will be shut down. Thus, unless you wish to - * disable billing, you should always call this method with the name of an - * *open* billing account. + * @desc Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the GCP Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://cloud.google.com/billing/docs/how-to/billing-access). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1869,22 +1599,22 @@ export namespace cloudbilling_v1 { * * authorize(function(authClient) { * var request = { - * // The resource name of the project associated with the billing - * information + * // The resource name of the project associated with the billing information * // that you want to update. For example, `projects/tokyo-rain-123`. * name: 'projects/my-project', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * * auth: authClient, * }; * - * cloudbilling.projects.updateBillingInfo(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudbilling.projects.updateBillingInfo(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1898,10 +1628,9 @@ export namespace cloudbilling_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1989,8 +1718,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the project for which billing information is - * retrieved. For example, `projects/tokyo-rain-123`. + * The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. */ name?: string; } @@ -2002,8 +1730,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the project associated with the billing information - * that you want to update. For example, `projects/tokyo-rain-123`. + * The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`. */ name?: string; @@ -2030,14 +1757,12 @@ export namespace cloudbilling_v1 { * // 1. If not already done, enable the Google Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2060,8 +1785,8 @@ export namespace cloudbilling_v1 { * return; * } * for (var i = 0; i < servicesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `servicesPage`: console.log(JSON.stringify(servicesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `servicesPage`: + * console.log(JSON.stringify(servicesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2079,10 +1804,9 @@ export namespace cloudbilling_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2169,9 +1893,7 @@ export namespace cloudbilling_v1 { */ pageSize?: number; /** - * A token identifying a page of results to return. This should be a - * `next_page_token` value returned from a previous `ListServices` call. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListServices` call. If unspecified, the first page of results is returned. */ pageToken?: string; } @@ -2191,14 +1913,12 @@ export namespace cloudbilling_v1 { * // 1. If not already done, enable the Google Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2244,10 +1964,9 @@ export namespace cloudbilling_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2334,18 +2053,11 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ISO 4217 currency code for the pricing info in the response proto. - * Will use the conversion rate as of start_time. Optional. If not specified - * USD will be used. + * The ISO 4217 currency code for the pricing info in the response proto. Will use the conversion rate as of start_time. Optional. If not specified USD will be used. */ currencyCode?: string; /** - * Optional exclusive end time of the time range for which the pricing - * versions will be returned. Timestamps in the future are not allowed. The - * time range has to be within a single calendar month in - * America/Los_Angeles timezone. Time range as a whole is optional. If not - * specified, the latest pricing will be returned (up to 12 hours old at - * most). + * Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most). */ endTime?: string; /** @@ -2353,9 +2065,7 @@ export namespace cloudbilling_v1 { */ pageSize?: number; /** - * A token identifying a page of results to return. This should be a - * `next_page_token` value returned from a previous `ListSkus` call. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListSkus` call. If unspecified, the first page of results is returned. */ pageToken?: string; /** @@ -2363,12 +2073,7 @@ export namespace cloudbilling_v1 { */ parent?: string; /** - * Optional inclusive start time of the time range for which the pricing - * versions will be returned. Timestamps in the future are not allowed. The - * time range has to be within a single calendar month in - * America/Los_Angeles timezone. Time range as a whole is optional. If not - * specified, the latest pricing will be returned (up to 12 hours old at - * most). + * Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most). */ startTime?: string; } diff --git a/src/apis/cloudbuild/package.json b/src/apis/cloudbuild/package.json index ae3db0b7043..f609a8d738c 100644 --- a/src/apis/cloudbuild/package.json +++ b/src/apis/cloudbuild/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 3766e3dc8a7..1970b736df3 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudbuild_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudbuild_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace cloudbuild_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); @@ -121,16 +120,11 @@ export namespace cloudbuild_v1 { } /** - * Files in the workspace to upload to Cloud Storage upon successful - * completion of all build steps. + * Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. */ export interface Schema$ArtifactObjects { /** - * Cloud Storage bucket and optional object path, in the form - * "gs://bucket/path/to/somewhere/". (see [Bucket Name - * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - * Files in the workspace matching any path pattern will be uploaded to - * Cloud Storage with this location as a prefix. + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. */ location?: string; /** @@ -143,8 +137,7 @@ export namespace cloudbuild_v1 { timing?: Schema$TimeSpan; } /** - * An artifact that was uploaded during a build. This is a single record in - * the artifact manifest JSON file. + * An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file. */ export interface Schema$ArtifactResult { /** @@ -152,58 +145,33 @@ export namespace cloudbuild_v1 { */ fileHash?: Schema$FileHashes[]; /** - * The path of an artifact in a Google Cloud Storage bucket, with the - * generation number. For example, - * `gs://mybucket/path/to/output.jar#generation`. + * The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`. */ location?: string; } /** - * Artifacts produced by a build that should be uploaded upon successful - * completion of all build steps. + * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. */ export interface Schema$Artifacts { /** - * A list of images to be pushed upon the successful completion of all build - * steps. The images will be pushed using the builder service account's - * credentials. The digests of the pushed images will be stored in the - * Build resource's results field. If any of the images fail to be - * pushed, the build is marked FAILURE. + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ images?: string[]; /** - * A list of objects to be uploaded to Cloud Storage upon successful - * completion of all build steps. Files in the workspace matching specified - * paths globs will be uploaded to the specified Cloud Storage location - * using the builder service account's credentials. The location and - * generation of the uploaded objects will be stored in the Build - * resource's results field. If any objects fail to be pushed, the - * build is marked FAILURE. + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. */ objects?: Schema$ArtifactObjects; } /** - * A build resource in the Cloud Build API. At a high level, a `Build` - * describes where to find source code, how to build it (for example, the - * builder image to run on the source), and where to store the built - * artifacts. Fields can include the following variables, which will be - * expanded when the build is created: - $PROJECT_ID: the project ID of the - * build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the - * source repository name specified by RepoSource. - $BRANCH_NAME: the branch - * name specified by RepoSource. - $TAG_NAME: the tag name specified by - * RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by - * RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: - * first 7 characters of $REVISION_ID or $COMMIT_SHA. + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. */ export interface Schema$Build { /** - * Artifacts produced by the build that should be uploaded upon successful - * completion of all build steps. + * Artifacts produced by the build that should be uploaded upon successful completion of all build steps. */ artifacts?: Schema$Artifacts; /** - * Output only. The ID of the `BuildTrigger` that triggered this build, if - * it was triggered automatically. + * Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. */ buildTriggerId?: string; /** @@ -211,9 +179,7 @@ export namespace cloudbuild_v1 { */ createTime?: string; /** - * Output only. Time at which execution of the build was finished. The - * difference between finish_time and start_time is the duration of the - * build's execution. + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. */ finishTime?: string; /** @@ -221,19 +187,11 @@ export namespace cloudbuild_v1 { */ id?: string; /** - * A list of images to be pushed upon the successful completion of all build - * steps. The images are pushed using the builder service account's - * credentials. The digests of the pushed images will be stored in the - * `Build` resource's results field. If any of the images fail to be - * pushed, the build status is marked `FAILURE`. + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. */ images?: string[]; /** - * Google Cloud Storage bucket where logs should be written (see [Bucket - * Name - * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - * Logs file names will be of the format - * `${logs_bucket}/log-${build_id}.txt`. + * Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. */ logsBucket?: string; /** @@ -289,16 +247,11 @@ export namespace cloudbuild_v1 { */ tags?: string[]; /** - * Amount of time that this build should be allowed to run, to second - * granularity. If this amount of time elapses, work on the build will cease - * and the build status will be `TIMEOUT`. Default time is ten minutes. + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes. */ timeout?: string; /** - * Output only. Stores timing information for phases of the build. Valid - * keys are: * BUILD: time to execute all build steps * PUSH: time to push - * all specified images. * FETCHSOURCE: time to fetch source. If the build - * does not specify source or images, these keys will not be included. + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. */ timing?: {[key: string]: Schema$TimeSpan}; } @@ -316,26 +269,15 @@ export namespace cloudbuild_v1 { */ export interface Schema$BuildOptions { /** - * Requested disk size for the VM that runs the build. Note that this is - * *NOT* "disk free"; some of the space will be used by the - * operating system and build utilities. Also note that this is the minimum - * disk size that will be allocated for the build -- the build may run with - * a larger disk than requested. At present, the maximum disk size is - * 1000GB; builds that request more than the maximum are rejected with an - * error. + * Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. */ diskSizeGb?: string; /** - * A list of global environment variable definitions that will exist for all - * build steps in this build. If a variable is defined in both globally and - * in a build step, the variable will use the build step value. The - * elements are of the form "KEY=VALUE" for the environment - * variable "KEY" being given the value "VALUE". + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[]; /** - * Option to specify the logging mode, which determines where the logs are - * stored. + * Option to specify the logging mode, which determines where the logs are stored. */ logging?: string; /** @@ -351,10 +293,7 @@ export namespace cloudbuild_v1 { */ requestedVerifyOption?: string; /** - * A list of global environment variables, which are encrypted using a Cloud - * Key Management Service crypto key. These values must be specified in the - * build's `Secret`. These variables will be available to all build - * steps in this build. + * A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. */ secretEnv?: string[]; /** @@ -362,23 +301,15 @@ export namespace cloudbuild_v1 { */ sourceProvenanceHash?: string[]; /** - * Option to specify behavior when there is an error in the substitution - * checks. + * Option to specify behavior when there is an error in the substitution checks. */ substitutionOption?: string; /** - * Global list of volumes to mount for ALL build steps Each volume is - * created as an empty volume prior to starting the build process. Upon - * completion of the build, volumes and their contents are discarded. Global - * volume names and paths cannot conflict with the volumes defined a build - * step. Using a global volume in a build with only one step is not valid - * as it is indicative of a build request with an incorrect configuration. + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** - * Option to specify a `WorkerPool` for the build. User specifies the pool - * with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". - * This is an experimental field. + * Option to specify a `WorkerPool` for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field. */ workerPool?: string; } @@ -387,78 +318,43 @@ export namespace cloudbuild_v1 { */ export interface Schema$BuildStep { /** - * A list of arguments that will be presented to the step when it is - * started. If the image used to run the step's container has an - * entrypoint, the `args` are used as arguments to that entrypoint. If the - * image does not define an entrypoint, the first element in args is used as - * the entrypoint, and the remainder will be used as arguments. + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. */ args?: string[]; /** - * Working directory to use when running this step's container. If this - * value is a relative path, it is relative to the build's working - * directory. If this value is absolute, it may be outside the build's - * working directory, in which case the contents of the path may not be - * persisted across build step executions, unless a `volume` for that path - * is specified. If the build specifies a `RepoSource` with `dir` and a - * step with a `dir`, which specifies an absolute path, the `RepoSource` - * `dir` is ignored for the step's execution. + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. */ dir?: string; /** - * Entrypoint to be used instead of the build step image's default - * entrypoint. If unset, the image's default entrypoint is used. + * Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. */ entrypoint?: string; /** - * A list of environment variable definitions to be used when running a - * step. The elements are of the form "KEY=VALUE" for the - * environment variable "KEY" being given the value - * "VALUE". + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[]; /** - * Unique identifier for this build step, used in `wait_for` to reference - * this build step as a dependency. + * Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. */ id?: string; /** - * Required. The name of the container image that will run this particular - * build step. If the image is available in the host's Docker - * daemon's cache, it will be run directly. If not, the host will - * attempt to pull the image first, using the builder service account's - * credentials if necessary. The Docker daemon's cache will already - * have the latest versions of all of the officially supported build steps - * ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - * The Docker daemon will also have cached many of the layers for some - * popular images, like "ubuntu", "debian", but they - * will be refreshed at the time you attempt to use them. If you built an - * image in a previous build step, it will be stored in the host's - * Docker daemon's cache and is available to use as the name for a later - * build step. + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. */ name?: string; /** - * Output only. Stores timing information for pulling this build step's - * builder image only. + * Output only. Stores timing information for pulling this build step's builder image only. */ pullTiming?: Schema$TimeSpan; /** - * A list of environment variables which are encrypted using a Cloud Key - * Management Service crypto key. These values must be specified in the - * build's `Secret`. + * A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. */ secretEnv?: string[]; /** - * Output only. Status of the build step. At this time, build step status is - * only updated on build completion; step status is not updated in real-time - * as the build progresses. + * Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. */ status?: string; /** - * Time limit for executing this build step. If not defined, the step has no - * time limit and will be allowed to continue to run until either it - * completes or the build itself times out. + * Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. */ timeout?: string; /** @@ -466,25 +362,16 @@ export namespace cloudbuild_v1 { */ timing?: Schema$TimeSpan; /** - * List of volumes to mount into the build step. Each volume is created as - * an empty volume prior to execution of the build step. Upon completion of - * the build, volumes and their contents are discarded. Using a named - * volume in only one step is not valid as it is indicative of a build - * request with an incorrect configuration. + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** - * The ID(s) of the step(s) that this build step depends on. This build step - * will not start until all the build steps in `wait_for` have completed - * successfully. If `wait_for` is empty, this build step will start when all - * previous build steps in the `Build.Steps` list have completed - * successfully. + * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. */ waitFor?: string[]; } /** - * Configuration for an automated build in response to source repository - * changes. + * Configuration for an automated build in response to source repository changes. */ export interface Schema$BuildTrigger { /** @@ -504,13 +391,11 @@ export namespace cloudbuild_v1 { */ disabled?: boolean; /** - * Path, from the source root, to a file whose contents is used for the - * template. + * Path, from the source root, to a file whose contents is used for the template. */ filename?: string; /** - * GitHubEventsConfig describes the configuration of a trigger that creates - * a build whenever a GitHub event is received. + * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. */ github?: Schema$GitHubEventsConfig; /** @@ -518,22 +403,11 @@ export namespace cloudbuild_v1 { */ id?: string; /** - * ignored_files and included_files are file glob matches using - * http://godoc/pkg/path/filepath#Match extended with support for - * "**". If ignored_files and changed files are both empty, then - * they are not used to determine whether or not to trigger a build. If - * ignored_files is not empty, then we ignore any files that match any of - * the ignored_file globs. If the change has no files that are outside of - * the ignored_files globs, then we do not trigger a build. + * ignored_files and included_files are file glob matches using http://godoc/pkg/path/filepath#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. */ ignoredFiles?: string[]; /** - * If any of the files altered in the commit pass the ignored_files filter - * and included_files is empty, then as far as this filter is concerned, we - * should trigger the build. If any of the files altered in the commit pass - * the ignored_files filter and included_files is not empty, then we make - * sure that at least one of those files matches a included_files glob. If - * not, then we do not trigger a build. + * If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. */ includedFiles?: string[]; /** @@ -541,10 +415,11 @@ export namespace cloudbuild_v1 { */ substitutions?: {[key: string]: string}; /** - * Template describing the types of source changes to trigger a build. - * Branch and tag names in trigger templates are interpreted as regular - * expressions. Any branch or tag change that matches that regular - * expression will trigger a build. + * Tags for annotation of a `BuildTrigger` + */ + tags?: string[]; + /** + * Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. */ triggerTemplate?: Schema$RepoSource; } @@ -557,8 +432,7 @@ export namespace cloudbuild_v1 { */ digest?: string; /** - * Name used to push the container image to Google Container Registry, as - * presented to `docker push`. + * Name used to push the container image to Google Container Registry, as presented to `docker push`. */ name?: string; /** @@ -575,21 +449,15 @@ export namespace cloudbuild_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A CheckSuiteFilter is a filter that indicates that we should build on all - * check suite events. + * A CheckSuiteFilter is a filter that indicates that we should build on all check suite events. */ export interface Schema$CheckSuiteFilter {} /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Container message for hashes of byte content of files, used in - * SourceProvenance messages to verify integrity of source input to the build. + * Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. */ export interface Schema$FileHashes { /** @@ -598,13 +466,11 @@ export namespace cloudbuild_v1 { fileHash?: Schema$Hash[]; } /** - * GitHubEventsConfig describes the configuration of a trigger that creates a - * build whenever a GitHub event is received. This message is experimental. + * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. */ export interface Schema$GitHubEventsConfig { /** - * Output only. Indicates that a build was generated from a check suite - * event. + * Output only. Indicates that a build was generated from a check suite event. */ checkSuite?: Schema$CheckSuiteFilter; /** @@ -681,14 +547,11 @@ export namespace cloudbuild_v1 { operations?: Schema$Operation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -696,43 +559,28 @@ export namespace cloudbuild_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * PullRequestFilter contains filter properties for matching GitHub Pull - * Requests. + * PullRequestFilter contains filter properties for matching GitHub Pull Requests. */ export interface Schema$PullRequestFilter { /** - * Regex of branches to match. The syntax of the regular expressions - * accepted is the syntax accepted by RE2 and described at - * https://github.com/google/re2/wiki/Syntax + * Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ branch?: string; /** - * Whether to block builds on a "/gcbrun" comment from a - * repository owner or collaborator. + * Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator. */ commentControl?: string; } @@ -741,15 +589,11 @@ export namespace cloudbuild_v1 { */ export interface Schema$PushFilter { /** - * Regexes of branches to match. The syntax of the regular expressions - * accepted is the syntax accepted by RE2 and described at - * https://github.com/google/re2/wiki/Syntax + * Regexes of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ branch?: string; /** - * Regexes of tags to match. The syntax of the regular expressions accepted - * is the syntax accepted by RE2 and described at - * https://github.com/google/re2/wiki/Syntax + * Regexes of tags to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */ tag?: string; } @@ -766,19 +610,15 @@ export namespace cloudbuild_v1 { */ commitSha?: string; /** - * Directory, relative to the source root, in which to run the build. This - * must be a relative path. If a step's `dir` is specified and is an - * absolute path, this value is ignored for that step's execution. + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. */ dir?: string; /** - * ID of the project that owns the Cloud Source Repository. If omitted, the - * project ID requesting the build is assumed. + * ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. */ projectId?: string; /** - * Name of the Cloud Source Repository. If omitted, the name - * "default" is assumed. + * Name of the Cloud Source Repository. If omitted, the name "default" is assumed. */ repoName?: string; /** @@ -791,8 +631,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$Results { /** - * Path to the artifact manifest. Only populated when artifacts are - * uploaded. + * Path to the artifact manifest. Only populated when artifacts are uploaded. */ artifactManifest?: string; /** @@ -800,16 +639,11 @@ export namespace cloudbuild_v1 { */ artifactTiming?: Schema$TimeSpan; /** - * List of build step digests, in the order corresponding to build step - * indices. + * List of build step digests, in the order corresponding to build step indices. */ buildStepImages?: string[]; /** - * List of build step outputs, produced by builder images, in the order - * corresponding to build step indices. [Cloud - * Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can - * produce this output by writing to `$BUILDER_OUTPUT/output`. Only the - * first 4KB of data is stored. + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. */ buildStepOutputs?: string[]; /** @@ -826,8 +660,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$RetryBuildRequest {} /** - * Pairs a set of secret environment variables containing encrypted values - * with the Cloud KMS key to use to decrypt the value. + * Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. */ export interface Schema$Secret { /** @@ -835,11 +668,7 @@ export namespace cloudbuild_v1 { */ kmsKeyName?: string; /** - * Map of environment variable name to its encrypted value. Secret - * environment variables must be unique across all of a build's secrets, - * and must be used by at least one build step. Values can be at most 64 KB - * in size. There can be at most 100 secret values across all of a - * build's secrets. + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. */ secretEnv?: {[key: string]: string}; } @@ -848,8 +677,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$Source { /** - * If provided, get the source from this location in a Cloud Source - * Repository. + * If provided, get the source from this location in a Cloud Source Repository. */ repoSource?: Schema$RepoSource; /** @@ -858,66 +686,24 @@ export namespace cloudbuild_v1 { storageSource?: Schema$StorageSource; } /** - * Provenance of the source. Ways to find the original source, or verify that - * some source was used for this build. + * Provenance of the source. Ways to find the original source, or verify that some source was used for this build. */ export interface Schema$SourceProvenance { /** - * Output only. Hash(es) of the build source, which can be used to verify - * that the original source integrity was maintained in the build. Note that - * `FileHashes` will only be populated if `BuildOptions` has requested a - * `SourceProvenanceHash`. The keys to this map are file paths used as - * build source and the values contain the hash values for those files. If - * the build source came in a single package such as a gzipped tarfile - * (`.tar.gz`), the `FileHash` will be for the single path to that file. + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes}; /** - * A copy of the build's `source.repo_source`, if exists, with any - * revisions resolved. + * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. */ resolvedRepoSource?: Schema$RepoSource; /** - * A copy of the build's `source.storage_source`, if exists, with any - * generations resolved. + * A copy of the build's `source.storage_source`, if exists, with any generations resolved. */ resolvedStorageSource?: Schema$StorageSource; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -925,14 +711,11 @@ export namespace cloudbuild_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -941,18 +724,15 @@ export namespace cloudbuild_v1 { */ export interface Schema$StorageSource { /** - * Google Cloud Storage bucket containing the source (see [Bucket Name - * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + * Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ bucket?: string; /** - * Google Cloud Storage generation for the object. If the generation is - * omitted, the latest generation will be used. + * Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. */ generation?: string; /** - * Google Cloud Storage object containing the source. This object must be a - * gzipped archive file (`.tar.gz`) containing source to build. + * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. */ object?: string; } @@ -970,20 +750,15 @@ export namespace cloudbuild_v1 { startTime?: string; } /** - * Volume describes a Docker container volume which is mounted into build - * steps in order to persist files across build step execution. + * Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. */ export interface Schema$Volume { /** - * Name of the volume to mount. Volume names must be unique per build step - * and must be valid names for Docker volumes. Each named volume must be - * used by at least two build steps. + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */ name?: string; /** - * Path at which to mount the volume. Paths must be absolute and cannot - * conflict with other volume paths on the same build step or with certain - * reserved volume paths. + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */ path?: string; } @@ -996,15 +771,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias cloudbuild.operations.cancel * @memberOf! () * @@ -1074,9 +841,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudbuild.operations.get * @memberOf! () * @@ -1146,15 +911,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias cloudbuild.operations.list * @memberOf! () * @@ -1372,10 +1129,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.create - * @desc Starts a build with the specified configuration. This method - * returns a long-running `Operation`, which includes the build ID. Pass the - * build ID to `GetBuild` to determine the build status (such as `SUCCESS` - * or `FAILURE`). + * @desc Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). * @alias cloudbuild.projects.builds.create * @memberOf! () * @@ -1450,9 +1204,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.get - * @desc Returns information about a previously requested build. The - * `Build` that is returned includes its status (such as `SUCCESS`, - * `FAILURE`, or `WORKING`), and timing information. + * @desc Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. * @alias cloudbuild.projects.builds.get * @memberOf! () * @@ -1525,9 +1277,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.list - * @desc Lists previously requested builds. Previously requested builds may - * still be in-progress, or may have finished successfully or - * unsuccessfully. + * @desc Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. * @alias cloudbuild.projects.builds.list * @memberOf! () * @@ -1604,23 +1354,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.builds.retry - * @desc Creates a new build based on the specified build. This method - * creates a new build using the original build request, which may or may - * not result in an identical build. For triggered builds: * Triggered - * builds resolve to a precise revision; therefore a retry of a triggered - * build will result in a build that uses the same revision. For - * non-triggered builds that specify `RepoSource`: * If the original build - * built from the tip of a branch, the retried build will build from the tip - * of that branch, which may not be the same revision as the original build. - * * If the original build specified a commit sha or revision ID, the - * retried build will use the identical source. For builds that specify - * `StorageSource`: * If the original build pulled source from Google Cloud - * Storage without specifying the generation of the object, the new build - * will use the current object, which may be different from the original - * build source. * If the original build pulled source from Cloud Storage - * and specified the generation of the object, the new build will attempt to - * use the same object, which may or may not be available depending on the - * bucket's lifecycle management settings. + * @desc Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. * @alias cloudbuild.projects.builds.retry * @memberOf! () * @@ -1877,8 +1611,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.delete - * @desc Deletes a `BuildTrigger` by its project ID and trigger ID. This - * API is experimental. + * @desc Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental. * @alias cloudbuild.projects.triggers.delete * @memberOf! () * @@ -1950,8 +1683,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.get - * @desc Returns information about a `BuildTrigger`. This API is - * experimental. + * @desc Returns information about a `BuildTrigger`. This API is experimental. * @alias cloudbuild.projects.triggers.get * @memberOf! () * @@ -2108,8 +1840,7 @@ export namespace cloudbuild_v1 { /** * cloudbuild.projects.triggers.patch - * @desc Updates a `BuildTrigger` by its project ID and trigger ID. This - * API is experimental. + * @desc Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental. * @alias cloudbuild.projects.triggers.patch * @memberOf! () * diff --git a/src/apis/cloudbuild/v1alpha1.ts b/src/apis/cloudbuild/v1alpha1.ts index 05333d99e43..248f2ab9080 100644 --- a/src/apis/cloudbuild/v1alpha1.ts +++ b/src/apis/cloudbuild/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudbuild_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudbuild_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,23 +108,21 @@ export namespace cloudbuild_v1alpha1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * Files in the workspace to upload to Cloud Storage upon successful - * completion of all build steps. + * Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. */ export interface Schema$ArtifactObjects { /** - * Cloud Storage bucket and optional object path, in the form - * "gs://bucket/path/to/somewhere/". (see [Bucket Name - * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - * Files in the workspace matching any path pattern will be uploaded to - * Cloud Storage with this location as a prefix. + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. */ location?: string; /** @@ -141,8 +135,7 @@ export namespace cloudbuild_v1alpha1 { timing?: Schema$TimeSpan; } /** - * An artifact that was uploaded during a build. This is a single record in - * the artifact manifest JSON file. + * An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file. */ export interface Schema$ArtifactResult { /** @@ -150,58 +143,33 @@ export namespace cloudbuild_v1alpha1 { */ fileHash?: Schema$FileHashes[]; /** - * The path of an artifact in a Google Cloud Storage bucket, with the - * generation number. For example, - * `gs://mybucket/path/to/output.jar#generation`. + * The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`. */ location?: string; } /** - * Artifacts produced by a build that should be uploaded upon successful - * completion of all build steps. + * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. */ export interface Schema$Artifacts { /** - * A list of images to be pushed upon the successful completion of all build - * steps. The images will be pushed using the builder service account's - * credentials. The digests of the pushed images will be stored in the - * Build resource's results field. If any of the images fail to be - * pushed, the build is marked FAILURE. + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ images?: string[]; /** - * A list of objects to be uploaded to Cloud Storage upon successful - * completion of all build steps. Files in the workspace matching specified - * paths globs will be uploaded to the specified Cloud Storage location - * using the builder service account's credentials. The location and - * generation of the uploaded objects will be stored in the Build - * resource's results field. If any objects fail to be pushed, the - * build is marked FAILURE. + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. */ objects?: Schema$ArtifactObjects; } /** - * A build resource in the Cloud Build API. At a high level, a `Build` - * describes where to find source code, how to build it (for example, the - * builder image to run on the source), and where to store the built - * artifacts. Fields can include the following variables, which will be - * expanded when the build is created: - $PROJECT_ID: the project ID of the - * build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the - * source repository name specified by RepoSource. - $BRANCH_NAME: the branch - * name specified by RepoSource. - $TAG_NAME: the tag name specified by - * RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by - * RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: - * first 7 characters of $REVISION_ID or $COMMIT_SHA. + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. */ export interface Schema$Build { /** - * Artifacts produced by the build that should be uploaded upon successful - * completion of all build steps. + * Artifacts produced by the build that should be uploaded upon successful completion of all build steps. */ artifacts?: Schema$Artifacts; /** - * Output only. The ID of the `BuildTrigger` that triggered this build, if - * it was triggered automatically. + * Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. */ buildTriggerId?: string; /** @@ -209,9 +177,7 @@ export namespace cloudbuild_v1alpha1 { */ createTime?: string; /** - * Output only. Time at which execution of the build was finished. The - * difference between finish_time and start_time is the duration of the - * build's execution. + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. */ finishTime?: string; /** @@ -219,19 +185,11 @@ export namespace cloudbuild_v1alpha1 { */ id?: string; /** - * A list of images to be pushed upon the successful completion of all build - * steps. The images are pushed using the builder service account's - * credentials. The digests of the pushed images will be stored in the - * `Build` resource's results field. If any of the images fail to be - * pushed, the build status is marked `FAILURE`. + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. */ images?: string[]; /** - * Google Cloud Storage bucket where logs should be written (see [Bucket - * Name - * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - * Logs file names will be of the format - * `${logs_bucket}/log-${build_id}.txt`. + * Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. */ logsBucket?: string; /** @@ -287,16 +245,11 @@ export namespace cloudbuild_v1alpha1 { */ tags?: string[]; /** - * Amount of time that this build should be allowed to run, to second - * granularity. If this amount of time elapses, work on the build will cease - * and the build status will be `TIMEOUT`. Default time is ten minutes. + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes. */ timeout?: string; /** - * Output only. Stores timing information for phases of the build. Valid - * keys are: * BUILD: time to execute all build steps * PUSH: time to push - * all specified images. * FETCHSOURCE: time to fetch source. If the build - * does not specify source or images, these keys will not be included. + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. */ timing?: {[key: string]: Schema$TimeSpan}; } @@ -314,26 +267,15 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$BuildOptions { /** - * Requested disk size for the VM that runs the build. Note that this is - * *NOT* "disk free"; some of the space will be used by the - * operating system and build utilities. Also note that this is the minimum - * disk size that will be allocated for the build -- the build may run with - * a larger disk than requested. At present, the maximum disk size is - * 1000GB; builds that request more than the maximum are rejected with an - * error. + * Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. */ diskSizeGb?: string; /** - * A list of global environment variable definitions that will exist for all - * build steps in this build. If a variable is defined in both globally and - * in a build step, the variable will use the build step value. The - * elements are of the form "KEY=VALUE" for the environment - * variable "KEY" being given the value "VALUE". + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[]; /** - * Option to specify the logging mode, which determines where the logs are - * stored. + * Option to specify the logging mode, which determines where the logs are stored. */ logging?: string; /** @@ -349,10 +291,7 @@ export namespace cloudbuild_v1alpha1 { */ requestedVerifyOption?: string; /** - * A list of global environment variables, which are encrypted using a Cloud - * Key Management Service crypto key. These values must be specified in the - * build's `Secret`. These variables will be available to all build - * steps in this build. + * A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. */ secretEnv?: string[]; /** @@ -360,23 +299,15 @@ export namespace cloudbuild_v1alpha1 { */ sourceProvenanceHash?: string[]; /** - * Option to specify behavior when there is an error in the substitution - * checks. + * Option to specify behavior when there is an error in the substitution checks. */ substitutionOption?: string; /** - * Global list of volumes to mount for ALL build steps Each volume is - * created as an empty volume prior to starting the build process. Upon - * completion of the build, volumes and their contents are discarded. Global - * volume names and paths cannot conflict with the volumes defined a build - * step. Using a global volume in a build with only one step is not valid - * as it is indicative of a build request with an incorrect configuration. + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** - * Option to specify a `WorkerPool` for the build. User specifies the pool - * with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". - * This is an experimental field. + * Option to specify a `WorkerPool` for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field. */ workerPool?: string; } @@ -385,78 +316,43 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$BuildStep { /** - * A list of arguments that will be presented to the step when it is - * started. If the image used to run the step's container has an - * entrypoint, the `args` are used as arguments to that entrypoint. If the - * image does not define an entrypoint, the first element in args is used as - * the entrypoint, and the remainder will be used as arguments. + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. */ args?: string[]; /** - * Working directory to use when running this step's container. If this - * value is a relative path, it is relative to the build's working - * directory. If this value is absolute, it may be outside the build's - * working directory, in which case the contents of the path may not be - * persisted across build step executions, unless a `volume` for that path - * is specified. If the build specifies a `RepoSource` with `dir` and a - * step with a `dir`, which specifies an absolute path, the `RepoSource` - * `dir` is ignored for the step's execution. + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. */ dir?: string; /** - * Entrypoint to be used instead of the build step image's default - * entrypoint. If unset, the image's default entrypoint is used. + * Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. */ entrypoint?: string; /** - * A list of environment variable definitions to be used when running a - * step. The elements are of the form "KEY=VALUE" for the - * environment variable "KEY" being given the value - * "VALUE". + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ env?: string[]; /** - * Unique identifier for this build step, used in `wait_for` to reference - * this build step as a dependency. + * Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. */ id?: string; /** - * Required. The name of the container image that will run this particular - * build step. If the image is available in the host's Docker - * daemon's cache, it will be run directly. If not, the host will - * attempt to pull the image first, using the builder service account's - * credentials if necessary. The Docker daemon's cache will already - * have the latest versions of all of the officially supported build steps - * ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - * The Docker daemon will also have cached many of the layers for some - * popular images, like "ubuntu", "debian", but they - * will be refreshed at the time you attempt to use them. If you built an - * image in a previous build step, it will be stored in the host's - * Docker daemon's cache and is available to use as the name for a later - * build step. + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. */ name?: string; /** - * Output only. Stores timing information for pulling this build step's - * builder image only. + * Output only. Stores timing information for pulling this build step's builder image only. */ pullTiming?: Schema$TimeSpan; /** - * A list of environment variables which are encrypted using a Cloud Key - * Management Service crypto key. These values must be specified in the - * build's `Secret`. + * A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. */ secretEnv?: string[]; /** - * Output only. Status of the build step. At this time, build step status is - * only updated on build completion; step status is not updated in real-time - * as the build progresses. + * Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. */ status?: string; /** - * Time limit for executing this build step. If not defined, the step has no - * time limit and will be allowed to continue to run until either it - * completes or the build itself times out. + * Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. */ timeout?: string; /** @@ -464,19 +360,11 @@ export namespace cloudbuild_v1alpha1 { */ timing?: Schema$TimeSpan; /** - * List of volumes to mount into the build step. Each volume is created as - * an empty volume prior to execution of the build step. Upon completion of - * the build, volumes and their contents are discarded. Using a named - * volume in only one step is not valid as it is indicative of a build - * request with an incorrect configuration. + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. */ volumes?: Schema$Volume[]; /** - * The ID(s) of the step(s) that this build step depends on. This build step - * will not start until all the build steps in `wait_for` have completed - * successfully. If `wait_for` is empty, this build step will start when all - * previous build steps in the `Build.Steps` list have completed - * successfully. + * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. */ waitFor?: string[]; } @@ -489,8 +377,7 @@ export namespace cloudbuild_v1alpha1 { */ digest?: string; /** - * Name used to push the container image to Google Container Registry, as - * presented to `docker push`. + * Name used to push the container image to Google Container Registry, as presented to `docker push`. */ name?: string; /** @@ -499,16 +386,11 @@ export namespace cloudbuild_v1alpha1 { pushTiming?: Schema$TimeSpan; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Container message for hashes of byte content of files, used in - * SourceProvenance messages to verify integrity of source input to the build. + * Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. */ export interface Schema$FileHashes { /** @@ -543,21 +425,15 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$Network { /** - * Network on which the workers are created. "default" network is - * used if empty. + * Network on which the workers are created. "default" network is used if empty. */ network?: string; /** - * Project id containing the defined network and subnetwork. For a peered - * VPC, this will be the same as the project_id in which the workers are - * created. For a shared VPC, this will be the project sharing the network - * with the project_id project in which workers will be created. For custom - * workers with no VPC, this will be the same as project_id. + * Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. */ projectId?: string; /** - * Subnetwork on which the workers are created. "default" - * subnetwork is used if empty. + * Subnetwork on which the workers are created. "default" subnetwork is used if empty. */ subnetwork?: string; } @@ -574,19 +450,15 @@ export namespace cloudbuild_v1alpha1 { */ commitSha?: string; /** - * Directory, relative to the source root, in which to run the build. This - * must be a relative path. If a step's `dir` is specified and is an - * absolute path, this value is ignored for that step's execution. + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. */ dir?: string; /** - * ID of the project that owns the Cloud Source Repository. If omitted, the - * project ID requesting the build is assumed. + * ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. */ projectId?: string; /** - * Name of the Cloud Source Repository. If omitted, the name - * "default" is assumed. + * Name of the Cloud Source Repository. If omitted, the name "default" is assumed. */ repoName?: string; /** @@ -599,8 +471,7 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$Results { /** - * Path to the artifact manifest. Only populated when artifacts are - * uploaded. + * Path to the artifact manifest. Only populated when artifacts are uploaded. */ artifactManifest?: string; /** @@ -608,16 +479,11 @@ export namespace cloudbuild_v1alpha1 { */ artifactTiming?: Schema$TimeSpan; /** - * List of build step digests, in the order corresponding to build step - * indices. + * List of build step digests, in the order corresponding to build step indices. */ buildStepImages?: string[]; /** - * List of build step outputs, produced by builder images, in the order - * corresponding to build step indices. [Cloud - * Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can - * produce this output by writing to `$BUILDER_OUTPUT/output`. Only the - * first 4KB of data is stored. + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. */ buildStepOutputs?: string[]; /** @@ -630,8 +496,7 @@ export namespace cloudbuild_v1alpha1 { numArtifacts?: string; } /** - * Pairs a set of secret environment variables containing encrypted values - * with the Cloud KMS key to use to decrypt the value. + * Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. */ export interface Schema$Secret { /** @@ -639,11 +504,7 @@ export namespace cloudbuild_v1alpha1 { */ kmsKeyName?: string; /** - * Map of environment variable name to its encrypted value. Secret - * environment variables must be unique across all of a build's secrets, - * and must be used by at least one build step. Values can be at most 64 KB - * in size. There can be at most 100 secret values across all of a - * build's secrets. + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. */ secretEnv?: {[key: string]: string}; } @@ -652,8 +513,7 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$Source { /** - * If provided, get the source from this location in a Cloud Source - * Repository. + * If provided, get the source from this location in a Cloud Source Repository. */ repoSource?: Schema$RepoSource; /** @@ -662,28 +522,19 @@ export namespace cloudbuild_v1alpha1 { storageSource?: Schema$StorageSource; } /** - * Provenance of the source. Ways to find the original source, or verify that - * some source was used for this build. + * Provenance of the source. Ways to find the original source, or verify that some source was used for this build. */ export interface Schema$SourceProvenance { /** - * Output only. Hash(es) of the build source, which can be used to verify - * that the original source integrity was maintained in the build. Note that - * `FileHashes` will only be populated if `BuildOptions` has requested a - * `SourceProvenanceHash`. The keys to this map are file paths used as - * build source and the values contain the hash values for those files. If - * the build source came in a single package such as a gzipped tarfile - * (`.tar.gz`), the `FileHash` will be for the single path to that file. + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes}; /** - * A copy of the build's `source.repo_source`, if exists, with any - * revisions resolved. + * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. */ resolvedRepoSource?: Schema$RepoSource; /** - * A copy of the build's `source.storage_source`, if exists, with any - * generations resolved. + * A copy of the build's `source.storage_source`, if exists, with any generations resolved. */ resolvedStorageSource?: Schema$StorageSource; } @@ -692,18 +543,15 @@ export namespace cloudbuild_v1alpha1 { */ export interface Schema$StorageSource { /** - * Google Cloud Storage bucket containing the source (see [Bucket Name - * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + * Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ bucket?: string; /** - * Google Cloud Storage generation for the object. If the generation is - * omitted, the latest generation will be used. + * Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. */ generation?: string; /** - * Google Cloud Storage object containing the source. This object must be a - * gzipped archive file (`.tar.gz`) containing source to build. + * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. */ object?: string; } @@ -721,78 +569,49 @@ export namespace cloudbuild_v1alpha1 { startTime?: string; } /** - * Volume describes a Docker container volume which is mounted into build - * steps in order to persist files across build step execution. + * Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. */ export interface Schema$Volume { /** - * Name of the volume to mount. Volume names must be unique per build step - * and must be valid names for Docker volumes. Each named volume must be - * used by at least two build steps. + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */ name?: string; /** - * Path at which to mount the volume. Paths must be absolute and cannot - * conflict with other volume paths on the same build step or with certain - * reserved volume paths. + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */ path?: string; } /** - * WorkerConfig defines the configuration to be used for a creating workers in - * the pool. + * WorkerConfig defines the configuration to be used for a creating workers in the pool. */ export interface Schema$WorkerConfig { /** - * Size of the disk attached to the worker, in GB. See - * https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud - * Build will use a standard disk size. `disk_size` is overridden if you - * specify a different disk size in `build_options`. In this case, a VM with - * a disk size specified in the `build_options` will be created on demand at - * build time. For more information see - * https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions + * Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions */ diskSizeGb?: string; /** - * Machine Type of the worker, such as n1-standard-1. See - * https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud - * Build will use a standard unspecified machine to create the worker pool. - * `machine_type` is overridden if you specify a different machine type in - * `build_options`. In this case, the VM specified in the `build_options` - * will be created on demand at build time. For more information see - * https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes + * Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes */ machineType?: string; /** - * The network definition used to create the worker. If this section is left - * empty, the workers will be created in WorkerPool.project_id on the - * default network. + * The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. */ network?: Schema$Network; /** - * The tag applied to the worker, and the same tag used by the firewall - * rule. It is used to identify the Cloud Build workers among other VMs. The - * default value for tag is `worker`. + * The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. */ tag?: string; } /** - * Configuration for a WorkerPool to run the builds. Workers are machines - * that Cloud Build uses to run your builds. By default, all workers run in a - * project owned by Cloud Build. To have full control over the workers that - * execute your builds -- such as enabling them to access private resources on - * your private network -- you can request Cloud Build to run the workers in - * your own project by creating a custom workers pool. + * Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool. */ export interface Schema$WorkerPool { /** - * Output only. Time at which the request to create the `WorkerPool` was - * received. + * Output only. Time at which the request to create the `WorkerPool` was received. */ createTime?: string; /** - * Output only. Time at which the request to delete the `WorkerPool` was - * received. + * Output only. Time at which the request to delete the `WorkerPool` was received. */ deleteTime?: string; /** @@ -804,17 +623,11 @@ export namespace cloudbuild_v1alpha1 { */ projectId?: string; /** - * List of regions to create the `WorkerPool`. Regions can't be empty. - * If Cloud Build adds a new GCP region in the future, the existing - * `WorkerPool` will not be enabled in the new region automatically; you - * must add the new region to the `regions` field to enable the `WorkerPool` - * in that region. + * List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region. */ regions?: string[]; /** - * Output only. The service account used to manage the `WorkerPool`. The - * service account must have the Compute Instance Admin (Beta) permission at - * the project level. + * Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level. */ serviceAccountEmail?: string; /** @@ -822,8 +635,7 @@ export namespace cloudbuild_v1alpha1 { */ status?: string; /** - * Output only. Time at which the request to update the `WorkerPool` was - * received. + * Output only. Time at which the request to update the `WorkerPool` was received. */ updateTime?: string; /** @@ -853,8 +665,7 @@ export namespace cloudbuild_v1alpha1 { /** * cloudbuild.projects.workerPools.create - * @desc Creates a `WorkerPool` to run the builds, and returns the new - * worker pool. This API is experimental. + * @desc Creates a `WorkerPool` to run the builds, and returns the new worker pool. This API is experimental. * @alias cloudbuild.projects.workerPools.create * @memberOf! () * @@ -929,8 +740,7 @@ export namespace cloudbuild_v1alpha1 { /** * cloudbuild.projects.workerPools.delete - * @desc Deletes a `WorkerPool` by its project ID and WorkerPool name. This - * API is experimental. + * @desc Deletes a `WorkerPool` by its project ID and WorkerPool name. This API is experimental. * @alias cloudbuild.projects.workerPools.delete * @memberOf! () * @@ -999,8 +809,7 @@ export namespace cloudbuild_v1alpha1 { /** * cloudbuild.projects.workerPools.get - * @desc Returns information about a `WorkerPool`. This API is - * experimental. + * @desc Returns information about a `WorkerPool`. This API is experimental. * @alias cloudbuild.projects.workerPools.get * @memberOf! () * @@ -1243,8 +1052,7 @@ export namespace cloudbuild_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * "projects/project-1/workerPools/workerpool-name" + * The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" */ name?: string; } @@ -1256,8 +1064,7 @@ export namespace cloudbuild_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * "projects/project-1/workerPools/workerpool-name" + * The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" */ name?: string; } @@ -1281,8 +1088,7 @@ export namespace cloudbuild_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: - * "projects/project-1/workerPools/workerpool-name" + * The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" */ name?: string; diff --git a/src/apis/clouddebugger/package.json b/src/apis/clouddebugger/package.json index 8e5a63b2fd0..1ff429329ed 100644 --- a/src/apis/clouddebugger/package.json +++ b/src/apis/clouddebugger/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index a5638098f5a..36adf5299c1 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace clouddebugger_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace clouddebugger_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace clouddebugger_v2 { /** * Stackdriver Debugger API * - * Examines the call stack and variables of a running application without - * stopping or slowing it down. + * Examines the call stack and variables of a running application without stopping or slowing it down. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace clouddebugger_v2 { debugger: Resource$Debugger; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.controller = new Resource$Controller(this.context); this.debugger = new Resource$Debugger(this.context); @@ -139,14 +137,11 @@ export namespace clouddebugger_v2 { */ export interface Schema$Breakpoint { /** - * Action that the agent should perform when the code at the breakpoint - * location is hit. + * Action that the agent should perform when the code at the breakpoint location is hit. */ action?: string; /** - * Condition that triggers the breakpoint. The condition is a compound - * boolean expression composed using expressions in a programming language - * at the source location. + * Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. */ condition?: string; /** @@ -154,24 +149,15 @@ export namespace clouddebugger_v2 { */ createTime?: string; /** - * Values of evaluated expressions at breakpoint time. The evaluated - * expressions appear in exactly the same order they are listed in the - * `expressions` field. The `name` field holds the original expression text, - * the `value` or `members` field holds the result of the evaluated - * expression. If the expression cannot be evaluated, the `status` inside - * the `Variable` will indicate an error and contain the error text. + * Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text. */ evaluatedExpressions?: Schema$Variable[]; /** - * List of read-only expressions to evaluate at the breakpoint location. The - * expressions are composed using expressions in the programming language at - * the source location. If the breakpoint action is `LOG`, the evaluated - * expressions are included in log statements. + * List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements. */ expressions?: string[]; /** - * Time this breakpoint was finalized as seen by the server in seconds - * resolution. + * Time this breakpoint was finalized as seen by the server in seconds resolution. */ finalTime?: string; /** @@ -179,13 +165,11 @@ export namespace clouddebugger_v2 { */ id?: string; /** - * When true, indicates that this is a final result and the breakpoint state - * will not change from here on. + * When true, indicates that this is a final result and the breakpoint state will not change from here on. */ isFinalState?: boolean; /** - * A set of custom breakpoint properties, populated by the agent, to be - * displayed to the user. + * A set of custom breakpoint properties, populated by the agent, to be displayed to the user. */ labels?: {[key: string]: string}; /** @@ -197,28 +181,15 @@ export namespace clouddebugger_v2 { */ logLevel?: string; /** - * Only relevant when action is `LOG`. Defines the message to log when the - * breakpoint hits. The message may include parameter placeholders `$0`, - * `$1`, etc. These placeholders are replaced with the evaluated value of - * the appropriate expression. Expressions not referenced in - * `log_message_format` are not logged. Example: `Message received, id = - * $0, count = $1` with `expressions` = `[ message.id, message.count ]`. + * Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`. */ logMessageFormat?: string; /** - * The stack at breakpoint time, where stack_frames[0] represents the most - * recently entered function. + * The stack at breakpoint time, where stack_frames[0] represents the most recently entered function. */ stackFrames?: Schema$StackFrame[]; /** - * Breakpoint status. The status includes an error flag and a human - * readable message. This field is usually unset. The message can be either - * informational or an error message. Regardless, clients should always - * display the text message back to the user. Error status indicates - * complete failure of the breakpoint. Example (non-final state): `Still - * loading symbols...` Examples (final state): * `Invalid line number` - * referring to location * `Field f not found in class C` referring to - * condition + * Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition */ status?: Schema$StatusMessage; /** @@ -226,22 +197,12 @@ export namespace clouddebugger_v2 { */ userEmail?: string; /** - * The `variable_table` exists to aid with computation, memory and network - * traffic optimization. It enables storing a variable once and reference - * it from multiple variables, including variables stored in the - * `variable_table` itself. For example, the same `this` object, which may - * appear at many levels of the stack, can have all of its data stored once - * in this table. The stack frame variables then would hold only a - * reference to it. The variable `var_table_index` field is an index into - * this repeated field. The stored objects are nameless and get their name - * from the referencing variable. The effective variable is a merge of the - * referencing variable and the referenced variable. + * The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable. */ variableTable?: Schema$Variable[]; } /** - * A CloudRepoSourceContext denotes a particular revision in a cloud repo (a - * repo hosted by the Google Cloud Platform). + * A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). */ export interface Schema$CloudRepoSourceContext { /** @@ -262,14 +223,11 @@ export namespace clouddebugger_v2 { revisionId?: string; } /** - * A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud - * workspace is a place associated with a repo where modified files can be - * stored before they are committed. + * A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. */ export interface Schema$CloudWorkspaceId { /** - * The unique name of the workspace within the repo. This is the name - * chosen by the client in the Source API's CreateWorkspace method. + * The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. */ name?: string; /** @@ -282,8 +240,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$CloudWorkspaceSourceContext { /** - * The ID of the snapshot. An empty snapshot_id refers to the most recent - * snapshot. + * The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. */ snapshotId?: string; /** @@ -292,26 +249,19 @@ export namespace clouddebugger_v2 { workspaceId?: Schema$CloudWorkspaceId; } /** - * Represents the debugged application. The application may include one or - * more replicated processes executing the same code. Each of these processes - * is attached with a debugger agent, carrying out the debugging commands. - * Agents attached to the same debuggee identify themselves as such by using - * exactly the same Debuggee message value when registering. + * Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering. */ export interface Schema$Debuggee { /** - * Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` - * (for example `google.com/java-gcp/v1.1`). + * Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`). */ agentVersion?: string; /** - * Human readable description of the debuggee. Including a human-readable - * project name, environment name and version information is recommended. + * Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. */ description?: string; /** - * References to the locations and revisions of the source code used in the - * deployed application. + * References to the locations and revisions of the source code used in the deployed application. */ extSourceContexts?: Schema$ExtendedSourceContext[]; /** @@ -319,58 +269,40 @@ export namespace clouddebugger_v2 { */ id?: string; /** - * If set to `true`, indicates that the agent should disable itself and - * detach from the debuggee. + * If set to `true`, indicates that the agent should disable itself and detach from the debuggee. */ isDisabled?: boolean; /** - * If set to `true`, indicates that Controller service does not detect any - * activity from the debuggee agents and the application is possibly - * stopped. + * If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. */ isInactive?: boolean; /** - * A set of custom debuggee properties, populated by the agent, to be - * displayed to the user. + * A set of custom debuggee properties, populated by the agent, to be displayed to the user. */ labels?: {[key: string]: string}; /** - * Project the debuggee is associated with. Use project number or id when - * registering a Google Cloud Platform project. + * Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project. */ project?: string; /** - * References to the locations and revisions of the source code used in the - * deployed application. + * References to the locations and revisions of the source code used in the deployed application. */ sourceContexts?: Schema$SourceContext[]; /** - * Human readable message to be displayed to the user about this debuggee. - * Absence of this field indicates no status. The message can be either - * informational or an error status. + * Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status. */ status?: Schema$StatusMessage; /** - * Uniquifier to further distinguish the application. It is possible that - * different applications might have identical values in the debuggee - * message, thus, incorrectly identified as a single application by the - * Controller service. This field adds salt to further distinguish the - * application. Agents should consider seeding this field with value that - * identifies the code, binary, configuration and environment. + * Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment. */ uniquifier?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * An ExtendedSourceContext is a SourceContext combined with additional - * details describing the context. + * An ExtendedSourceContext is a SourceContext combined with additional details describing the context. */ export interface Schema$ExtendedSourceContext { /** @@ -387,11 +319,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$FormatMessage { /** - * Format template for the message. The `format` uses placeholders `$0`, - * `$1`, etc. to reference parameters. `$$` can be used to denote the `$` - * character. Examples: * `Failed to load '$0' which helps debug - * $1 the first time it is loaded. Again, $0 is very important.` * - * `Please pay $$10 to use $0 instead of $1.` + * Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` */ format?: string; /** @@ -412,9 +340,7 @@ export namespace clouddebugger_v2 { */ aliasName?: string; /** - * The full project name within the host. Projects may be nested, so - * "project/subproject" is a valid project name. The "repo - * name" is hostURI/project. + * The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. */ gerritProject?: string; /** @@ -431,14 +357,12 @@ export namespace clouddebugger_v2 { */ export interface Schema$GetBreakpointResponse { /** - * Complete breakpoint state. The fields `id` and `location` are guaranteed - * to be set. + * Complete breakpoint state. The fields `id` and `location` are guaranteed to be set. */ breakpoint?: Schema$Breakpoint; } /** - * A GitSourceContext denotes a particular revision in a third party Git - * repository (e.g. GitHub). + * A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). */ export interface Schema$GitSourceContext { /** @@ -455,19 +379,15 @@ export namespace clouddebugger_v2 { */ export interface Schema$ListActiveBreakpointsResponse { /** - * List of all active breakpoints. The fields `id` and `location` are - * guaranteed to be set on each breakpoint. + * List of all active breakpoints. The fields `id` and `location` are guaranteed to be set on each breakpoint. */ breakpoints?: Schema$Breakpoint[]; /** - * A token that can be used in the next method call to block until the list - * of breakpoints changes. + * A token that can be used in the next method call to block until the list of breakpoints changes. */ nextWaitToken?: string; /** - * If set to `true`, indicates that there is no change to the list of active - * breakpoints and the server-selected timeout has expired. The - * `breakpoints` field would be empty and should be ignored. + * If set to `true`, indicates that there is no change to the list of active breakpoints and the server-selected timeout has expired. The `breakpoints` field would be empty and should be ignored. */ waitExpired?: boolean; } @@ -476,16 +396,11 @@ export namespace clouddebugger_v2 { */ export interface Schema$ListBreakpointsResponse { /** - * List of breakpoints matching the request. The fields `id` and `location` - * are guaranteed to be set on each breakpoint. The fields: `stack_frames`, - * `evaluated_expressions` and `variable_table` are cleared on each - * breakpoint regardless of its status. + * List of breakpoints matching the request. The fields `id` and `location` are guaranteed to be set on each breakpoint. The fields: `stack_frames`, `evaluated_expressions` and `variable_table` are cleared on each breakpoint regardless of its status. */ breakpoints?: Schema$Breakpoint[]; /** - * A wait token that can be used in the next call to `list` (REST) or - * `ListBreakpoints` (RPC) to block until the list of breakpoints has - * changes. + * A wait token that can be used in the next call to `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakpoints has changes. */ nextWaitToken?: string; } @@ -494,16 +409,12 @@ export namespace clouddebugger_v2 { */ export interface Schema$ListDebuggeesResponse { /** - * List of debuggees accessible to the calling user. The fields - * `debuggee.id` and `description` are guaranteed to be set. The - * `description` field is a human readable field provided by agents and can - * be displayed to users. + * List of debuggees accessible to the calling user. The fields `debuggee.id` and `description` are guaranteed to be set. The `description` field is a human readable field provided by agents and can be displayed to users. */ debuggees?: Schema$Debuggee[]; } /** - * Selects a repo using a Google Cloud Platform project ID (e.g. - * winged-cargo-31) and a repo name within that project. + * Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. */ export interface Schema$ProjectRepoId { /** @@ -520,8 +431,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$RegisterDebuggeeRequest { /** - * Debuggee information to register. The fields `project`, `uniquifier`, - * `description` and `agent_version` of the debuggee must be set. + * Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set. */ debuggee?: Schema$Debuggee; } @@ -530,11 +440,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$RegisterDebuggeeResponse { /** - * Debuggee resource. The field `id` is guaranteed to be set (in addition to - * the echoed fields). If the field `is_disabled` is set to `true`, the - * agent should disable itself by removing all breakpoints and detaching - * from the application. It should however continue to poll - * `RegisterDebuggee` until reenabled. + * Debuggee resource. The field `id` is guaranteed to be set (in addition to the echoed fields). If the field `is_disabled` is set to `true`, the agent should disable itself by removing all breakpoints and detaching from the application. It should however continue to poll `RegisterDebuggee` until reenabled. */ debuggee?: Schema$Debuggee; } @@ -556,14 +462,12 @@ export namespace clouddebugger_v2 { */ export interface Schema$SetBreakpointResponse { /** - * Breakpoint resource. The field `id` is guaranteed to be set (in addition - * to the echoed fileds). + * Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fileds). */ breakpoint?: Schema$Breakpoint; } /** - * A SourceContext is a reference to a tree of files. A SourceContext together - * with a path point to a unique revision of a single file or directory. + * A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. */ export interface Schema$SourceContext { /** @@ -588,9 +492,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$SourceLocation { /** - * Column within a line. The first column in a line as the value `1`. Agents - * that do not support setting breakpoints on specific columns ignore this - * field. + * Column within a line. The first column in a line as the value `1`. Agents that do not support setting breakpoints on specific columns ignore this field. */ column?: number; /** @@ -607,8 +509,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$StackFrame { /** - * Set of arguments passed to this function. Note that this might not be - * populated for all stack frames. + * Set of arguments passed to this function. Note that this might not be populated for all stack frames. */ arguments?: Schema$Variable[]; /** @@ -616,8 +517,7 @@ export namespace clouddebugger_v2 { */ function?: string; /** - * Set of local variables at the stack frame location. Note that this might - * not be populated for all stack frames. + * Set of local variables at the stack frame location. Note that this might not be populated for all stack frames. */ locals?: Schema$Variable[]; /** @@ -626,11 +526,7 @@ export namespace clouddebugger_v2 { location?: Schema$SourceLocation; } /** - * Represents a contextual status message. The message can indicate an error - * or informational status, and refer to specific parts of the containing - * object. For example, the `Breakpoint.status` field can indicate an error - * referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location - * not found`. + * Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. */ export interface Schema$StatusMessage { /** @@ -651,66 +547,16 @@ export namespace clouddebugger_v2 { */ export interface Schema$UpdateActiveBreakpointRequest { /** - * Updated breakpoint information. The field `id` must be set. The agent - * must echo all Breakpoint specification fields in the update. + * Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update. */ breakpoint?: Schema$Breakpoint; } /** - * Response for updating an active breakpoint. The message is defined to allow - * future extensions. + * Response for updating an active breakpoint. The message is defined to allow future extensions. */ export interface Schema$UpdateActiveBreakpointResponse {} /** - * Represents a variable or an argument possibly of a compound object type. - * Note how the following variables are represented: 1) A simple variable: - * int x = 5 { name: "x", value: "5", type: - * "int" } // Captured variable 2) A compound object: struct - * T { int m1; int m2; }; T x = { 3, 7 }; { // - * Captured variable name: "x", type: "T", - * members { name: "m1", value: "3", type: "int" - * }, members { name: "m2", value: "7", type: - * "int" } } 3) A pointer where the pointee was captured: T x = - * { 3, 7 }; T* p = &x; { // Captured variable name: - * "p", type: "T*", value: - * "0x00500500", members { name: "m1", value: - * "3", type: "int" }, members { name: - * "m2", value: "7", type: "int" } } 4) A - * pointer where the pointee was not captured: T* p = new T; { // - * Captured variable name: "p", type: - * "T*", value: "0x00400400" status { - * is_error: true, description { format: "unavailable" } } } The - * status should describe the reason for the missing value, such as - * `<optimized out>`, `<inaccessible>`, `<pointers limit - * reached>`. Note that a null pointer should not have members. 5) An - * unnamed value: int* p = new int(7); { // Captured variable - * name: "p", value: "0x00500500", type: - * "int*", members { value: "7", type: - * "int" } } 6) An unnamed pointer where the pointee was not - * captured: int* p = new int(7); int** pp = &p; { // - * Captured variable name: "pp", value: - * "0x00500500", type: "int**", members { - * value: "0x00400400", type: "int*" status { - * is_error: true, description: { format: - * "unavailable" } } } } } To optimize - * computation, memory and network traffic, variables that repeat in the - * output multiple times can be stored once in a shared variable table and be - * referenced using the `var_table_index` field. The variables stored in the - * shared table are nameless and are essentially a partition of the complete - * variable. To reconstruct the complete variable, merge the referencing - * variable with the referenced variable. When using the shared variable - * table, the following variables: T x = { 3, 7 }; T* p = &x; - * T& r = x; { name: "x", var_table_index: 3, type: - * "T" } // Captured variables { name: "p", value - * "0x00500500", type="T*", var_table_index: 3 } { - * name: "r", type="T&", var_table_index: 3 } { - * // Shared variable table entry #3: members { name: "m1", - * value: "3", type: "int" }, members { name: - * "m2", value: "7", type: "int" } } Note - * that the pointer address is stored with the referencing variable and not - * with the referenced variable. This allows the referenced variable to be - * shared between pointers and references. The type field is optional. The - * debugger agent may or may not support it. + * Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. */ export interface Schema$Variable { /** @@ -722,25 +568,11 @@ export namespace clouddebugger_v2 { */ name?: string; /** - * Status associated with the variable. This field will usually stay unset. - * A status of a single variable only applies to that variable or - * expression. The rest of breakpoint data still remains valid. Variables - * might be reported in error state even when breakpoint is not in final - * state. The message may refer to variable name with `refers_to` set to - * `VARIABLE_NAME`. Alternatively `refers_to` will be set to - * `VARIABLE_VALUE`. In either case variable value and members will be - * unset. Example of error message applied to name: `Invalid expression - * syntax`. Example of information message applied to value: `Not - * captured`. Examples of error message applied to value: * `Malformed - * string`, * `Field f not found in class C` * `Null pointer - * dereference` + * Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` */ status?: Schema$StatusMessage; /** - * Variable type (e.g. `MyClass`). If the variable is split with - * `var_table_index`, `type` goes next to `value`. The interpretation of a - * type is agent specific. It is recommended to include the dynamic type - * rather than a static type of an object. + * Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. */ type?: string; /** @@ -748,9 +580,7 @@ export namespace clouddebugger_v2 { */ value?: string; /** - * Reference to a variable in the shared variable table. More than one - * variable can reference the same variable in the table. The - * `var_table_index` field is an index into `variable_table` in Breakpoint. + * Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. */ varTableIndex?: number; } @@ -776,28 +606,19 @@ export namespace clouddebugger_v2 { /** * clouddebugger.controller.debuggees.register - * @desc Registers the debuggee with the controller service. All agents - * attached to the same application must call this method with exactly the - * same request content to get back the same stable `debuggee_id`. Agents - * should call this method again whenever `google.rpc.Code.NOT_FOUND` is - * returned from any controller method. This protocol allows the controller - * service to disable debuggees, recover from data loss, or change the - * `debuggee_id` format. Agents must handle `debuggee_id` value changing - * upon re-registration. + * @desc Registers the debuggee with the controller service. All agents attached to the same application must call this method with exactly the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This protocol allows the controller service to disable debuggees, recover from data loss, or change the `debuggee_id` format. Agents must handle `debuggee_id` value changing upon re-registration. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -813,8 +634,10 @@ export namespace clouddebugger_v2 { * auth: authClient, * }; * - * cloudDebugger.controller.debuggees.register(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudDebugger.controller.debuggees.register(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -828,10 +651,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -934,30 +756,19 @@ export namespace clouddebugger_v2 { /** * clouddebugger.controller.debuggees.breakpoints.list - * @desc Returns the list of all active breakpoints for the debuggee. The - * breakpoint specification (`location`, `condition`, and `expressions` - * fields) is semantically immutable, although the field values may change. - * For example, an agent may update the location line number to reflect the - * actual line where the breakpoint was set, but this doesn't change the - * breakpoint semantics. This means that an agent does not need to check if - * a breakpoint has changed when it encounters the same breakpoint on a - * successive call. Moreover, an agent should remember the breakpoints that - * are completed until the controller removes them from the active list to - * avoid setting those breakpoints again. + * @desc Returns the list of all active breakpoints for the debuggee. The breakpoint specification (`location`, `condition`, and `expressions` fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -972,8 +783,10 @@ export namespace clouddebugger_v2 { * auth: authClient, * }; * - * cloudDebugger.controller.debuggees.breakpoints.list(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudDebugger.controller.debuggees.breakpoints.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -987,10 +800,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1079,27 +891,19 @@ export namespace clouddebugger_v2 { /** * clouddebugger.controller.debuggees.breakpoints.update - * @desc Updates the breakpoint state or mutable fields. The entire - * Breakpoint message must be sent back to the controller service. Updates - * to active breakpoint fields are only allowed if the new value does not - * change the breakpoint specification. Updates to the `location`, - * `condition` and `expressions` fields should not alter the breakpoint - * semantics. These may only make changes such as canonicalizing a value or - * snapping the location to the correct line of code. + * @desc Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expressions` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1115,16 +919,17 @@ export namespace clouddebugger_v2 { * id: 'my-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * * auth: authClient, * }; * - * cloudDebugger.controller.debuggees.breakpoints.update(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudDebugger.controller.debuggees.breakpoints.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1138,10 +943,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1241,18 +1045,11 @@ export namespace clouddebugger_v2 { */ debuggeeId?: string; /** - * If set to `true` (recommended), returns `google.rpc.Code.OK` status and - * sets the `wait_expired` response field to `true` when the server-selected - * timeout has expired. If set to `false` (deprecated), returns - * `google.rpc.Code.ABORTED` status when the server-selected timeout has - * expired. + * If set to `true` (recommended), returns `google.rpc.Code.OK` status and sets the `wait_expired` response field to `true` when the server-selected timeout has expired. If set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status when the server-selected timeout has expired. */ successOnTimeout?: boolean; /** - * A token that, if specified, blocks the method call until the list of - * active breakpoints has changed, or a server-selected timeout has expired. - * The value should be set from the `next_wait_token` field in the last - * response. The initial value should be set to `"init"`. + * A token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server-selected timeout has expired. The value should be set from the `next_wait_token` field in the last response. The initial value should be set to `"init"`. */ waitToken?: string; } @@ -1306,14 +1103,12 @@ export namespace clouddebugger_v2 { * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1325,8 +1120,10 @@ export namespace clouddebugger_v2 { * auth: authClient, * }; * - * cloudDebugger.debugger.debuggees.list(request, function(err, response) - * { if (err) { console.error(err); return; + * cloudDebugger.debugger.debuggees.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1340,10 +1137,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1433,13 +1229,11 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The client version making the call. Schema: `domain/type/version` (e.g., - * `google.com/intellij/v1`). + * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** - * When set to `true`, the result includes all debuggees. Otherwise, the - * result includes only debuggees that are active. + * When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active. */ includeInactive?: boolean; /** @@ -1463,14 +1257,12 @@ export namespace clouddebugger_v2 { * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1488,8 +1280,10 @@ export namespace clouddebugger_v2 { * auth: authClient, * }; * - * cloudDebugger.debugger.debuggees.breakpoints.delete(request, - * function(err) { if (err) { console.error(err); return; + * cloudDebugger.debugger.debuggees.breakpoints.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; * } * }); * }); @@ -1500,10 +1294,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1589,14 +1382,12 @@ export namespace clouddebugger_v2 { * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1614,8 +1405,10 @@ export namespace clouddebugger_v2 { * auth: authClient, * }; * - * cloudDebugger.debugger.debuggees.breakpoints.get(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudDebugger.debugger.debuggees.breakpoints.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1629,10 +1422,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1722,14 +1514,12 @@ export namespace clouddebugger_v2 { * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1744,8 +1534,10 @@ export namespace clouddebugger_v2 { * auth: authClient, * }; * - * cloudDebugger.debugger.debuggees.breakpoints.list(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudDebugger.debugger.debuggees.breakpoints.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1759,10 +1551,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1855,14 +1646,12 @@ export namespace clouddebugger_v2 { * // 1. If not already done, enable the Stackdriver Debugger API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/clouddebugger - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1881,8 +1670,10 @@ export namespace clouddebugger_v2 { * auth: authClient, * }; * - * cloudDebugger.debugger.debuggees.breakpoints.set(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudDebugger.debugger.debuggees.breakpoints.set(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1896,10 +1687,9 @@ export namespace clouddebugger_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1992,8 +1782,7 @@ export namespace clouddebugger_v2 { */ breakpointId?: string; /** - * The client version making the call. Schema: `domain/type/version` (e.g., - * `google.com/intellij/v1`). + * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** @@ -2013,8 +1802,7 @@ export namespace clouddebugger_v2 { */ breakpointId?: string; /** - * The client version making the call. Schema: `domain/type/version` (e.g., - * `google.com/intellij/v1`). + * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** @@ -2034,8 +1822,7 @@ export namespace clouddebugger_v2 { */ 'action.value'?: string; /** - * The client version making the call. Schema: `domain/type/version` (e.g., - * `google.com/intellij/v1`). + * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** @@ -2043,26 +1830,19 @@ export namespace clouddebugger_v2 { */ debuggeeId?: string; /** - * When set to `true`, the response includes the list of breakpoints set by - * any user. Otherwise, it includes only breakpoints set by the caller. + * When set to `true`, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller. */ includeAllUsers?: boolean; /** - * When set to `true`, the response includes active and inactive - * breakpoints. Otherwise, it includes only active breakpoints. + * When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints. */ includeInactive?: boolean; /** - * This field is deprecated. The following fields are always stripped out of - * the result: `stack_frames`, `evaluated_expressions` and `variable_table`. + * This field is deprecated. The following fields are always stripped out of the result: `stack_frames`, `evaluated_expressions` and `variable_table`. */ stripResults?: boolean; /** - * A wait token that, if specified, blocks the call until the breakpoints - * list has changed, or a server selected timeout has expired. The value - * should be set from the last response. The error code - * `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should - * be called again with the same `wait_token`. + * A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response. The error code `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should be called again with the same `wait_token`. */ waitToken?: string; } @@ -2074,8 +1854,7 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The client version making the call. Schema: `domain/type/version` (e.g., - * `google.com/intellij/v1`). + * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** diff --git a/src/apis/clouderrorreporting/package.json b/src/apis/clouderrorreporting/package.json index e783e353ea5..3e7a3c0a708 100644 --- a/src/apis/clouderrorreporting/package.json +++ b/src/apis/clouderrorreporting/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index b3d4a4bf2d8..b4b45b8c161 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace clouderrorreporting_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace clouderrorreporting_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace clouderrorreporting_v1beta1 { /** * Stackdriver Error Reporting API * - * Groups and counts similar errors from cloud services and applications, - * reports new errors, and provides access to error groups and their - * associated errors. + * Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors. * * @example * const {google} = require('googleapis'); @@ -114,7 +108,10 @@ export namespace clouderrorreporting_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -125,9 +122,7 @@ export namespace clouderrorreporting_v1beta1 { */ export interface Schema$DeleteEventsResponse {} /** - * A description of the context in which an error occurred. This data should - * be provided by the application when reporting an error, unless the error - * report has been generated automatically from Google App Engine logs. + * A description of the context in which an error occurred. This data should be provided by the application when reporting an error, unless the error report has been generated automatically from Google App Engine logs. */ export interface Schema$ErrorContext { /** @@ -135,24 +130,15 @@ export namespace clouderrorreporting_v1beta1 { */ httpRequest?: Schema$HttpRequestContext; /** - * The location in the source code where the decision was made to report the - * error, usually the place where it was logged. For a logged exception this - * would be the source line where the exception is logged, usually close to - * the place where it was caught. + * The location in the source code where the decision was made to report the error, usually the place where it was logged. For a logged exception this would be the source line where the exception is logged, usually close to the place where it was caught. */ reportLocation?: Schema$SourceLocation; /** - * Source code that was used to build the executable which has caused the - * given error message. + * Source code that was used to build the executable which has caused the given error message. */ sourceReferences?: Schema$SourceReference[]; /** - * The user who caused or was affected by the crash. This can be a user ID, - * an email address, or an arbitrary token that uniquely identifies the - * user. When sending an error report, leave this field empty if the user - * was not logged in. In this case the Error Reporting system will use other - * data, such as remote IP address, to distinguish affected users. See - * `affected_users_count` in `ErrorGroupStats`. + * The user who caused or was affected by the crash. This can be a user ID, an email address, or an arbitrary token that uniquely identifies the user. When sending an error report, leave this field empty if the user was not logged in. In this case the Error Reporting system will use other data, such as remote IP address, to distinguish affected users. See `affected_users_count` in `ErrorGroupStats`. */ user?: string; } @@ -165,9 +151,7 @@ export namespace clouderrorreporting_v1beta1 { */ context?: Schema$ErrorContext; /** - * Time when the event occurred as provided in the error report. If the - * report did not contain a timestamp, the time the error was received by - * the Error Reporting system is used. + * Time when the event occurred as provided in the error report. If the report did not contain a timestamp, the time the error was received by the Error Reporting system is used. */ eventTime?: string; /** @@ -184,13 +168,11 @@ export namespace clouderrorreporting_v1beta1 { */ export interface Schema$ErrorGroup { /** - * Group IDs are unique for a given project. If the same kind of error - * occurs in different service contexts, it will receive the same group ID. + * Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID. */ groupId?: string; /** - * The group resource name. Example: - * <code>projects/my-project-123/groups/my-groupid</code> + * The group resource name. Example: <code>projects/my-project-123/groups/my-groupid</code> */ name?: string; /** @@ -199,37 +181,23 @@ export namespace clouderrorreporting_v1beta1 { trackingIssues?: Schema$TrackingIssue[]; } /** - * Data extracted for a specific group based on certain filter criteria, such - * as a given time period and/or service filter. + * Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter. */ export interface Schema$ErrorGroupStats { /** - * Service contexts with a non-zero error count for the given filter - * criteria. This list can be truncated if multiple services are affected. - * Refer to `num_affected_services` for the total count. + * Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected. Refer to `num_affected_services` for the total count. */ affectedServices?: Schema$ServiceContext[]; /** - * Approximate number of affected users in the given group that match the - * filter criteria. Users are distinguished by data in the `ErrorContext` of - * the individual error events, such as their login name or their remote IP - * address in case of HTTP requests. The number of affected users can be - * zero even if the number of errors is non-zero if no data was provided - * from which the affected user could be deduced. Users are counted based on - * data in the request context that was provided in the error report. If - * more users are implicitly affected, such as due to a crash of the whole - * service, this is not reflected here. + * Approximate number of affected users in the given group that match the filter criteria. Users are distinguished by data in the `ErrorContext` of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here. */ affectedUsersCount?: string; /** - * Approximate total number of events in the given group that match the - * filter criteria. + * Approximate total number of events in the given group that match the filter criteria. */ count?: string; /** - * Approximate first occurrence that was ever seen for this group and which - * matches the given filter criteria, ignoring the time_range that was - * specified in the request. + * Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. */ firstSeenTime?: string; /** @@ -237,35 +205,24 @@ export namespace clouderrorreporting_v1beta1 { */ group?: Schema$ErrorGroup; /** - * Approximate last occurrence that was ever seen for this group and which - * matches the given filter criteria, ignoring the time_range that was - * specified in the request. + * Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. */ lastSeenTime?: string; /** - * The total number of services with a non-zero error count for the given - * filter criteria. + * The total number of services with a non-zero error count for the given filter criteria. */ numAffectedServices?: number; /** - * An arbitrary event that is chosen as representative for the whole group. - * The representative event is intended to be used as a quick preview for - * the whole group. Events in the group are usually sufficiently similar to - * each other such that showing an arbitrary representative provides insight - * into the characteristics of the group as a whole. + * An arbitrary event that is chosen as representative for the whole group. The representative event is intended to be used as a quick preview for the whole group. Events in the group are usually sufficiently similar to each other such that showing an arbitrary representative provides insight into the characteristics of the group as a whole. */ representative?: Schema$ErrorEvent; /** - * Approximate number of occurrences over time. Timed counts returned by - * ListGroups are guaranteed to be: - Inside the requested time interval - - * Non-overlapping, and - Ordered by ascending time. + * Approximate number of occurrences over time. Timed counts returned by ListGroups are guaranteed to be: - Inside the requested time interval - Non-overlapping, and - Ordered by ascending time. */ timedCounts?: Schema$TimedCount[]; } /** - * HTTP request data that is related to a reported error. This data should be - * provided by the application when reporting an error, unless the error - * report has been generated automatically from Google App Engine logs. + * HTTP request data that is related to a reported error. This data should be provided by the application when reporting an error, unless the error report has been generated automatically from Google App Engine logs. */ export interface Schema$HttpRequestContext { /** @@ -277,9 +234,7 @@ export namespace clouderrorreporting_v1beta1 { */ referrer?: string; /** - * The IP address from which the request originated. This can be IPv4, IPv6, - * or a token which is derived from the IP address, depending on the data - * that has been provided in the error report. + * The IP address from which the request originated. This can be IPv4, IPv6, or a token which is derived from the IP address, depending on the data that has been provided in the error report. */ remoteIp?: string; /** @@ -304,14 +259,11 @@ export namespace clouderrorreporting_v1beta1 { */ errorEvents?: Schema$ErrorEvent[]; /** - * If non-empty, more results are available. Pass this token, along with the - * same query parameters as the first request, to view the next page of - * results. + * If non-empty, more results are available. Pass this token, along with the same query parameters as the first request, to view the next page of results. */ nextPageToken?: string; /** - * The timestamp specifies the start time to which the request was - * restricted. + * The timestamp specifies the start time to which the request was restricted. */ timeRangeBegin?: string; } @@ -324,16 +276,11 @@ export namespace clouderrorreporting_v1beta1 { */ errorGroupStats?: Schema$ErrorGroupStats[]; /** - * If non-empty, more results are available. Pass this token, along with the - * same query parameters as the first request, to view the next page of - * results. + * If non-empty, more results are available. Pass this token, along with the same query parameters as the first request, to view the next page of results. */ nextPageToken?: string; /** - * The timestamp specifies the start time to which the request was - * restricted. The start time is set based on the requested time range. It - * may be adjusted to a later time if a project has exceeded the storage - * quota and older data has been deleted. + * The timestamp specifies the start time to which the request was restricted. The start time is set based on the requested time range. It may be adjusted to a later time if a project has exceeded the storage quota and older data has been deleted. */ timeRangeBegin?: string; } @@ -346,31 +293,11 @@ export namespace clouderrorreporting_v1beta1 { */ context?: Schema$ErrorContext; /** - * [Optional] Time when the event occurred. If not provided, the time when - * the event was received by the Error Reporting system will be used. + * [Optional] Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system will be used. */ eventTime?: string; /** - * [Required] The error message. If no `context.reportLocation` is provided, - * the message must contain a header (typically consisting of the exception - * type name and an error message) and an exception stack trace in one of - * the supported programming languages and formats. Supported languages are - * Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace - * formats are: * **Java**: Must be the return value of - * [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). - * * **Python**: Must be the return value of - * [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). - * * **JavaScript**: Must be the value of - * [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as - * returned by V8. * **Ruby**: Must contain frames returned by - * [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). - * * **C#**: Must be the return value of - * [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). - * * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` - * and contain the result of - * [`(string)$exception`](http://php.net/manual/en/exception.tostring.php). - * * **Go**: Must be the return value of - * [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). + * [Required] The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` and contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). */ message?: string; /** @@ -379,55 +306,36 @@ export namespace clouderrorreporting_v1beta1 { serviceContext?: Schema$ServiceContext; } /** - * Response for reporting an individual error event. Data may be added to this - * message in the future. + * Response for reporting an individual error event. Data may be added to this message in the future. */ export interface Schema$ReportErrorEventResponse {} /** - * Describes a running service that sends errors. Its version changes over - * time and multiple versions can run in parallel. + * Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel. */ export interface Schema$ServiceContext { /** - * Type of the MonitoredResource. List of possible values: - * https://cloud.google.com/monitoring/api/resources Value is set - * automatically for incoming errors and must not be set when reporting - * errors. + * Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors. */ resourceType?: string; /** - * An identifier of the service, such as the name of the executable, job, or - * Google App Engine service name. This field is expected to have a low - * number of values that are relatively stable over time, as opposed to - * `version`, which can be changed whenever new code is deployed. Contains - * the service name for error reports extracted from Google App Engine logs - * or `default` if the App Engine default service is used. + * An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to `version`, which can be changed whenever new code is deployed. Contains the service name for error reports extracted from Google App Engine logs or `default` if the App Engine default service is used. */ service?: string; /** - * Represents the source code version that the developer provided, which - * could represent a version label or a Git SHA-1 hash, for example. For App - * Engine standard environment, the version is set to the version of the - * app. + * Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app. */ version?: string; } /** - * Indicates a location in the source code of the service for which errors are - * reported. `functionName` must be provided by the application when reporting - * an error, unless the error report contains a `message` with a supported - * exception stack trace. All fields are optional for the later case. + * Indicates a location in the source code of the service for which errors are reported. `functionName` must be provided by the application when reporting an error, unless the error report contains a `message` with a supported exception stack trace. All fields are optional for the later case. */ export interface Schema$SourceLocation { /** - * The source code filename, which can include a truncated relative path, or - * a full path from a production machine. + * The source code filename, which can include a truncated relative path, or a full path from a production machine. */ filePath?: string; /** - * Human-readable name of a function or method. The value can include - * optional context like the class or package name. For example, - * `my.package.MyClass.method` in case of Java. + * Human-readable name of a function or method. The value can include optional context like the class or package name. For example, `my.package.MyClass.method` in case of Java. */ functionName?: string; /** @@ -436,24 +344,20 @@ export namespace clouderrorreporting_v1beta1 { lineNumber?: number; } /** - * A reference to a particular snapshot of the source tree used to build and - * deploy an application. + * A reference to a particular snapshot of the source tree used to build and deploy an application. */ export interface Schema$SourceReference { /** - * Optional. A URI string identifying the repository. Example: - * "https://github.com/GoogleCloudPlatform/kubernetes.git" + * Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" */ repository?: string; /** - * The canonical and persistent identifier of the deployed revision. Example - * (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" + * The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" */ revisionId?: string; } /** - * The number of errors in a given time period. All numbers are approximate - * since the error events are sampled before counting them. + * The number of errors in a given time period. All numbers are approximate since the error events are sampled before counting them. */ export interface Schema$TimedCount { /** @@ -474,8 +378,7 @@ export namespace clouderrorreporting_v1beta1 { */ export interface Schema$TrackingIssue { /** - * A URL pointing to a related entry in an issue tracking system. Example: - * https://github.com/user/project/issues/4 + * A URL pointing to a related entry in an issue tracking system. Example: https://github.com/user/project/issues/4 */ url?: string; } @@ -580,10 +483,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Required] The resource name of the Google Cloud Platform project. - * Written as `projects/` plus the [Google Cloud Platform project - * ID](https://support.google.com/cloud/answer/6158840). Example: - * `projects/my-project-123`. + * [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; } @@ -678,12 +578,7 @@ export namespace clouderrorreporting_v1beta1 { /** * clouderrorreporting.projects.events.report - * @desc Report an individual error event. This endpoint accepts **either** - * an OAuth token, **or** an [API - * key](https://support.google.com/cloud/answer/6158862) for authentication. - * To use an API key, append it to the URL as the value of a `key` - * parameter. For example: `POST - * https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456` + * @desc Report an individual error event. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456` * @alias clouderrorreporting.projects.events.report * @memberOf! () * @@ -782,25 +677,19 @@ export namespace clouderrorreporting_v1beta1 { */ pageToken?: string; /** - * [Required] The resource name of the Google Cloud Platform project. - * Written as `projects/` plus the [Google Cloud Platform project - * ID](https://support.google.com/cloud/answer/6158840). Example: - * `projects/my-project-123`. + * [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; /** - * [Optional] The exact value to match against - * [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + * [Optional] The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). */ 'serviceFilter.resourceType'?: string; /** - * [Optional] The exact value to match against - * [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + * [Optional] The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). */ 'serviceFilter.service'?: string; /** - * [Optional] The exact value to match against - * [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + * [Optional] The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). */ 'serviceFilter.version'?: string; /** @@ -816,10 +705,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Required] The resource name of the Google Cloud Platform project. - * Written as `projects/` plus the [Google Cloud Platform project - * ID](https://support.google.com/cloud/answer/6158840). Example: - * `projects/my-project-123`. + * [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; @@ -912,8 +798,7 @@ export namespace clouderrorreporting_v1beta1 { /** * clouderrorreporting.projects.groups.update - * @desc Replace the data for the specified group. Fails if the group does - * not exist. + * @desc Replace the data for the specified group. Fails if the group does not exist. * @alias clouderrorreporting.projects.groups.update * @memberOf! () * @@ -993,13 +878,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Required] The group resource name. Written as - * projects/projectID/groups/group_name. - * Call - * groupStats.list to return a list of groups belonging to - * this project. Example: - * projects/my-project-123/groups/my-group + * [Required] The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project. Example: projects/my-project-123/groups/my-group */ groupName?: string; } @@ -1011,8 +890,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The group resource name. Example: - * projects/my-project-123/groups/my-groupid + * The group resource name. Example: projects/my-project-123/groups/my-groupid */ name?: string; @@ -1125,13 +1003,11 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Optional] The alignment of the timed counts to be returned. Default is - * `ALIGNMENT_EQUAL_AT_END`. + * [Optional] The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`. */ alignment?: string; /** - * [Optional] Time where the timed counts shall be aligned if rounded - * alignment is chosen. Default is 00:00 UTC. + * [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. */ alignmentTime?: string; /** @@ -1139,46 +1015,35 @@ export namespace clouderrorreporting_v1beta1 { */ groupId?: string[]; /** - * [Optional] The sort order in which the results are returned. Default is - * `COUNT_DESC`. + * [Optional] The sort order in which the results are returned. Default is `COUNT_DESC`. */ order?: string; /** - * [Optional] The maximum number of results to return per response. Default - * is 20. + * [Optional] The maximum number of results to return per response. Default is 20. */ pageSize?: number; /** - * [Optional] A `next_page_token` provided by a previous response. To view - * additional results, pass this token along with the identical query - * parameters as the first request. + * [Optional] A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. */ pageToken?: string; /** - * [Required] The resource name of the Google Cloud Platform project. - * Written as projects/ plus the Google Cloud - * Platform project ID. Example: projects/my-project-123. + * [Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123. */ projectName?: string; /** - * [Optional] The exact value to match against - * [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + * [Optional] The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). */ 'serviceFilter.resourceType'?: string; /** - * [Optional] The exact value to match against - * [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + * [Optional] The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). */ 'serviceFilter.service'?: string; /** - * [Optional] The exact value to match against - * [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + * [Optional] The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). */ 'serviceFilter.version'?: string; /** - * [Optional] The preferred duration for a single returned `TimedCount`. If - * not set, no timed counts are returned. + * [Optional] The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned. */ timedCountDuration?: string; /** diff --git a/src/apis/cloudfunctions/package.json b/src/apis/cloudfunctions/package.json index 8842b324644..cf6b695bd81 100644 --- a/src/apis/cloudfunctions/package.json +++ b/src/apis/cloudfunctions/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 5c0c485dd89..969132db090 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudfunctions_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudfunctions_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace cloudfunctions_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); @@ -121,27 +120,7 @@ export namespace cloudfunctions_v1 { } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -149,25 +128,16 @@ export namespace cloudfunctions_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -180,30 +150,15 @@ export namespace cloudfunctions_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -221,8 +176,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$CallFunctionResponse { /** - * Either system or user-function generated error. Set if execution was not - * successful. + * Either system or user-function generated error. Set if execution was not successful. */ error?: string; /** @@ -230,15 +184,12 @@ export namespace cloudfunctions_v1 { */ executionId?: string; /** - * Result populated for successful execution of synchronous function. Will - * not be populated if function does not return a result through context. + * Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context. */ result?: string; } /** - * Describes a Cloud Function that contains user computation executed in - * response to an event. It encapsulate function and triggers configurations. - * LINT.IfChange + * Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. LINT.IfChange */ export interface Schema$CloudFunction { /** @@ -250,12 +201,7 @@ export namespace cloudfunctions_v1 { */ description?: string; /** - * The name of the function (as defined in source code) that will be - * executed. Defaults to the resource name suffix, if not specified. For - * backward compatibility, if function with given name is not found, then - * the system will try to use function named "function". For - * Node.js this is name of a function exported by the module specified in - * `source_location`. + * The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`. */ entryPoint?: string; /** @@ -275,44 +221,27 @@ export namespace cloudfunctions_v1 { */ labels?: {[key: string]: string}; /** - * The limit on the maximum number of function instances that may coexist at - * a given time. + * The limit on the maximum number of function instances that may coexist at a given time. */ maxInstances?: number; /** - * A user-defined name of the function. Function names must be unique - * globally and match pattern `projects/x/locations/x/functions/x + * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x */ name?: string; /** - * The VPC Network that this cloud function can connect to. It can be either - * the fully-qualified URI, or the short name of the network resource. If - * the short network name is used, the network must belong to the same - * project. Otherwise, it must belong to a project within the same - * organization. The format of this field is either - * `projects/{project}/global/networks/{network}` or `{network}`, where - * {project} is a project id where the network is defined, and {network} is - * the short name of the network. This field is mutually exclusive with - * `vpc_connector` and will be replaced by it. See [the VPC - * documentation](https://cloud.google.com/compute/docs/vpc) for more - * information on connecting Cloud projects. This feature is currently in - * alpha, available only for whitelisted users. + * The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. This feature is currently in alpha, available only for whitelisted users. */ network?: string; /** - * Required. The runtime in which the function is going to run. Choices: * - * `nodejs6`: Node.js 6 * `nodejs8`: Node.js 8 * `nodejs10`: Node.js 10 * - * `python37`: Python 3.7 * `go111`: Go 1.11 + * Required. The runtime in which the function is going to run. Choices: * `nodejs6`: Node.js 6 * `nodejs8`: Node.js 8 * `nodejs10`: Node.js 10 * `python37`: Python 3.7 * `go111`: Go 1.11 */ runtime?: string; /** - * The email of the function's service account. If empty, defaults to - * {project_id}@appspot.gserviceaccount.com. + * The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com. */ serviceAccountEmail?: string; /** - * The Google Cloud Storage URL, starting with gs://, pointing to the zip - * archive which contains the function. + * The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. */ sourceArchiveUrl?: string; /** @@ -320,8 +249,7 @@ export namespace cloudfunctions_v1 { */ sourceRepository?: Schema$SourceRepository; /** - * The Google Cloud Storage signed URL used for source uploading, generated - * by google.cloud.functions.v1.GenerateUploadUrl + * The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl */ sourceUploadUrl?: string; /** @@ -329,9 +257,7 @@ export namespace cloudfunctions_v1 { */ status?: string; /** - * The function execution timeout. Execution is considered failed and can be - * terminated if the function is not completed at the end of the timeout - * period. Defaults to 60 seconds. + * The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. */ timeout?: string; /** @@ -339,38 +265,20 @@ export namespace cloudfunctions_v1 { */ updateTime?: string; /** - * Output only. The version identifier of the Cloud Function. Each - * deployment attempt results in a new version of a function being created. + * Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. */ versionId?: string; /** - * The VPC Network Connector that this cloud function can connect to. It can - * be either the fully-qualified URI, or the short name of the network - * connector resource. The format of this field is - * `projects/x/locations/x/connectors/x This field is mutually exclusive - * with `network` field and will eventually replace it. See [the VPC - * documentation](https://cloud.google.com/compute/docs/vpc) for more - * information on connecting Cloud projects. This feature is currently in - * alpha, available only for whitelisted users. + * The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/x/locations/x/connectors/x This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. This feature is currently in alpha, available only for whitelisted users. */ vpcConnector?: string; } /** - * Describes EventTrigger, used to request events be sent from another - * service. + * Describes EventTrigger, used to request events be sent from another service. */ export interface Schema$EventTrigger { /** - * Required. The type of event to observe. For example: - * `providers/cloud.storage/eventTypes/object.change` and - * `providers/cloud.pubsub/eventTypes/topic.publish`. Event types match - * pattern `providers/x/eventTypes/*.*`. The pattern contains: 1. - * namespace: For example, `cloud.storage` and - * `google.firebase.analytics`. 2. resource type: The type of resource on - * which event occurs. For example, the Google Cloud Storage API includes - * the type `object`. 3. action: The action that generates the event. For - * example, action for a Google Cloud Storage Object is 'change'. - * These parts are lower case. + * Required. The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`. Event types match pattern `providers/x/eventTypes/*.*`. The pattern contains: 1. namespace: For example, `cloud.storage` and `google.firebase.analytics`. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type `object`. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. */ eventType?: string; /** @@ -378,60 +286,37 @@ export namespace cloudfunctions_v1 { */ failurePolicy?: Schema$FailurePolicy; /** - * Required. The resource(s) from which to observe events, for example, - * `projects/_/buckets/myBucket`. Not all syntactically correct values are - * accepted by all services. For example: 1. The authorization model must - * support it. Google Cloud Functions only allows EventTriggers to be - * deployed that observe resources in the same project as the - * `CloudFunction`. 2. The resource type must match the pattern expected for - * an `event_type`. For example, an `EventTrigger` that has an - * `event_type` of "google.pubsub.topic.publish" should have a - * resource that matches Google Cloud Pub/Sub topics. Additionally, some - * services may support short names when creating an `EventTrigger`. These - * will always be returned in the normalized "long" format. See - * each *service's* documentation for supported formats. + * Required. The resource(s) from which to observe events, for example, `projects/_/buckets/myBucket`. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the `CloudFunction`. 2. The resource type must match the pattern expected for an `event_type`. For example, an `EventTrigger` that has an `event_type` of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an `EventTrigger`. These will always be returned in the normalized "long" format. See each *service's* documentation for supported formats. */ resource?: string; /** - * The hostname of the service that should be observed. If no string is - * provided, the default service implementing the API will be used. For - * example, `storage.googleapis.com` is the default for all event types in - * the `google.storage` namespace. + * The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, `storage.googleapis.com` is the default for all event types in the `google.storage` namespace. */ service?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Describes the policy in case of function's execution failure. If empty, - * then defaults to ignoring failures (i.e. not retrying them). + * Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them). */ export interface Schema$FailurePolicy { /** @@ -444,8 +329,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$GenerateDownloadUrlRequest { /** - * The optional version of function. If not set, default, current version is - * used. + * The optional version of function. If not set, default, current version is used. */ versionId?: string; } @@ -454,8 +338,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$GenerateDownloadUrlResponse { /** - * The generated Google Cloud Storage signed URL that should be used for - * function source code download. + * The generated Google Cloud Storage signed URL that should be used for function source code download. */ downloadUrl?: string; } @@ -468,9 +351,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$GenerateUploadUrlResponse { /** - * The generated Google Cloud Storage signed URL that should be used for a - * function source code upload. The uploaded file should be a zip archive - * which contains a function. + * The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function. */ uploadUrl?: string; } @@ -492,9 +373,7 @@ export namespace cloudfunctions_v1 { */ functions?: Schema$CloudFunction[]; /** - * If not empty, indicates that there may be more functions that match the - * request; this value should be passed in a new - * google.cloud.functions.v1.ListFunctionsRequest to get more functions. + * If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1.ListFunctionsRequest to get more functions. */ nextPageToken?: string; } @@ -529,13 +408,11 @@ export namespace cloudfunctions_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -543,25 +420,20 @@ export namespace cloudfunctions_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -569,26 +441,15 @@ export namespace cloudfunctions_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -601,8 +462,7 @@ export namespace cloudfunctions_v1 { */ request?: {[key: string]: any}; /** - * Target of the operation - for example - * projects/project-1/locations/region-1/functions/function-1 + * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ target?: string; /** @@ -614,8 +474,7 @@ export namespace cloudfunctions_v1 { */ updateTime?: string; /** - * Version id of the function created or updated by an API call. This field - * is only populated for Create and Update operations. + * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ versionId?: string; } @@ -628,8 +487,7 @@ export namespace cloudfunctions_v1 { */ request?: {[key: string]: any}; /** - * Target of the operation - for example - * projects/project-1/locations/region-1/functions/function-1 + * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ target?: string; /** @@ -641,30 +499,12 @@ export namespace cloudfunctions_v1 { */ updateTime?: string; /** - * Version id of the function created or updated by an API call. This field - * is only populated for Create and Update operations. + * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ versionId?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -672,20 +512,11 @@ export namespace cloudfunctions_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -694,10 +525,7 @@ export namespace cloudfunctions_v1 { version?: number; } /** - * Describes the retry policy in case of function's execution failure. A - * function execution will be retried on any failure. A failed execution will - * be retried up to 7 days with an exponential backoff (capped at 10 seconds). - * Retried execution is charged as any other execution. + * Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution. */ export interface Schema$Retry {} /** @@ -705,80 +533,29 @@ export namespace cloudfunctions_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * Describes SourceRepository, used to represent parameters related to source - * repository where a function is hosted. + * Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. */ export interface Schema$SourceRepository { /** - * Output only. The URL pointing to the hosted repository where the function - * were defined at the time of deployment. It always points to a specific - * commit in the format described above. + * Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. */ deployedUrl?: string; /** - * The URL pointing to the hosted repository where the function is defined. - * There are supported Cloud Source Repository URLs in the following - * formats: To refer to a specific commit: - * `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x - * To refer to a moveable alias (branch): - * `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x - * In particular, to refer to HEAD use `master` moveable alias. To refer to - * a specific fixed alias (tag): - * `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x - * You may omit `paths/x if you want to use the main directory. + * The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x To refer to a moveable alias (branch): `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x You may omit `paths/x if you want to use the main directory. */ url?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -786,14 +563,11 @@ export namespace cloudfunctions_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -802,10 +576,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -814,8 +585,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -828,9 +598,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudfunctions.operations.get * @memberOf! () * @@ -901,15 +669,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias cloudfunctions.operations.list * @memberOf! () * @@ -1002,11 +762,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A filter for matching the requested operations.

                          The - * supported formats of filter are:
                          To query for specific - * function: project:*,location:*,function:*
                          To query for - * all of the latest operations for a project: - * project:*,latest:true + * Required. A filter for matching the requested operations.

                          The supported formats of filter are:
                          To query for specific function: project:*,location:*,function:*
                          To query for all of the latest operations for a project: project:*,latest:true */ filter?: string; /** @@ -1154,10 +910,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.call - * @desc Synchronously invokes a deployed Cloud Function. To be used for - * testing purposes as very limited traffic is allowed. For more information - * on the actual limits, refer to [Rate - * Limits](https://cloud.google.com/functions/quotas#rate_limits). + * @desc Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits, refer to [Rate Limits](https://cloud.google.com/functions/quotas#rate_limits). * @alias cloudfunctions.projects.locations.functions.call * @memberOf! () * @@ -1232,9 +985,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.create - * @desc Creates a new function. If a function with the given name already - * exists in the specified project, the long running operation will return - * `ALREADY_EXISTS` error. + * @desc Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. * @alias cloudfunctions.projects.locations.functions.create * @memberOf! () * @@ -1310,9 +1061,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.delete - * @desc Deletes a function with the given name from the specified project. - * If the given function is used by some trigger, the trigger will be - * updated to remove this function. + * @desc Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function. * @alias cloudfunctions.projects.locations.functions.delete * @memberOf! () * @@ -1384,10 +1133,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.generateDownloadUrl - * @desc Returns a signed URL for downloading deployed function source code. - * The URL is only valid for a limited period and should be used within - * minutes after generation. For more information about the signed URL usage - * see: https://cloud.google.com/storage/docs/access-control/signed-urls + * @desc Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within minutes after generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls * @alias cloudfunctions.projects.locations.functions.generateDownloadUrl * @memberOf! () * @@ -1470,22 +1216,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.generateUploadUrl - * @desc Returns a signed URL for uploading a function source code. For more - * information about the signed URL usage see: - * https://cloud.google.com/storage/docs/access-control/signed-urls. Once - * the function source code upload is complete, the used signed URL should - * be provided in CreateFunction or UpdateFunction request as a reference to - * the function source code. When uploading source code to the generated - * signed URL, please follow these restrictions: * Source file type should - * be a zip file. * Source file size should not exceed 100MB limit. * No - * credentials should be attached - the signed URLs provide access to the - * target bucket using internal service identity; if credentials were - * attached, the identity from the credentials would be used, but that - * identity does not have permissions to upload files to the URL. When - * making a HTTP PUT request, these two headers need to be specified: * - * `content-type: application/zip` * `x-goog-content-length-range: - * 0,104857600` And this header SHOULD NOT be specified: * `Authorization: - * Bearer YOUR_TOKEN` + * @desc Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 100MB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,104857600` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` * @alias cloudfunctions.projects.locations.functions.generateUploadUrl * @memberOf! () * @@ -1639,8 +1370,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.getIamPolicy - * @desc Gets the IAM access control policy for a function. Returns an empty - * policy if the function exists and does not have a policy set. + * @desc Gets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set. * @alias cloudfunctions.projects.locations.functions.getIamPolicy * @memberOf! () * @@ -1866,8 +1596,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.setIamPolicy - * @desc Sets the IAM access control policy on the specified function. - * Replaces any existing policy. + * @desc Sets the IAM access control policy on the specified function. Replaces any existing policy. * @alias cloudfunctions.projects.locations.functions.setIamPolicy * @memberOf! () * @@ -1941,9 +1670,7 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.testIamPermissions - * @desc Tests the specified permissions against the IAM access control - * policy for a function. If the function does not exist, this will return - * an empty set of permissions, not a NOT_FOUND error. + * @desc Tests the specified permissions against the IAM access control policy for a function. If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error. * @alias cloudfunctions.projects.locations.functions.testIamPermissions * @memberOf! () * @@ -2050,8 +1777,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location in which the function should be created, - * specified in the format `projects/x/locations/x` + * The project and location in which the function should be created, specified in the format `projects/x/locations/x` */ location?: string; @@ -2080,8 +1806,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of function for which source code Google Cloud Storage signed - * URL should be generated. + * The name of function for which source code Google Cloud Storage signed URL should be generated. */ name?: string; @@ -2098,8 +1823,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location in which the Google Cloud Storage signed URL - * should be generated, specified in the format `projects/x/locations/x`. + * The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/x/locations/x`. */ parent?: string; @@ -2128,8 +1852,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2145,15 +1868,11 @@ export namespace cloudfunctions_v1 { */ pageSize?: number; /** - * The value returned by the last `ListFunctionsResponse`; indicates that - * this is a continuation of a prior `ListFunctions` call, and that the - * system should return the next page of data. + * The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data. */ pageToken?: string; /** - * The project and location from which the function should be listed, - * specified in the format `projects/x/locations/x` If you want to list - * functions in all locations, use "-" in place of a location. + * The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location. */ parent?: string; } @@ -2165,8 +1884,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A user-defined name of the function. Function names must be unique - * globally and match pattern `projects/x/locations/x/functions/x` + * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x` */ name?: string; /** @@ -2187,8 +1905,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2205,8 +1922,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index 6aa307aa954..d55dca74ad6 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudfunctions_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudfunctions_v1beta2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace cloudfunctions_v1beta2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); @@ -134,8 +133,7 @@ export namespace cloudfunctions_v1beta2 { */ export interface Schema$CallFunctionResponse { /** - * Either system or user-function generated error. Set if execution was not - * successful. + * Either system or user-function generated error. Set if execution was not successful. */ error?: string; /** @@ -143,14 +141,12 @@ export namespace cloudfunctions_v1beta2 { */ executionId?: string; /** - * Result populated for successful execution of synchronous function. Will - * not be populated if function does not return a result through context. + * Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context. */ result?: string; } /** - * Describes a Cloud Function that contains user computation executed in - * response to an event. It encapsulate function and triggers configurations. + * Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. */ export interface Schema$CloudFunction { /** @@ -158,12 +154,7 @@ export namespace cloudfunctions_v1beta2 { */ availableMemoryMb?: number; /** - * The name of the function (as defined in source code) that will be - * executed. Defaults to the resource name suffix, if not specified. For - * backward compatibility, if function with given name is not found, then - * the system will try to use function named "function". For - * Node.js this is name of a function exported by the module specified in - * `source_location`. + * The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`. */ entryPoint?: string; /** @@ -183,50 +174,31 @@ export namespace cloudfunctions_v1beta2 { */ labels?: {[key: string]: string}; /** - * Output only. Name of the most recent operation modifying the function. If - * the function status is `DEPLOYING` or `DELETING`, then it points to the - * active operation. + * Output only. Name of the most recent operation modifying the function. If the function status is `DEPLOYING` or `DELETING`, then it points to the active operation. */ latestOperation?: string; /** - * The limit on the maximum number of function instances that may coexist at - * a given time. + * The limit on the maximum number of function instances that may coexist at a given time. */ maxInstances?: number; /** - * A user-defined name of the function. Function names must be unique - * globally and match pattern `projects/x/locations/x/functions/x + * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x */ name?: string; /** - * The VPC Network that this cloud function can connect to. It can be either - * the fully-qualified URI, or the short name of the network resource. If - * the short network name is used, the network must belong to the same - * project. Otherwise, it must belong to a project within the same - * organization. The format of this field is either - * `projects/{project}/global/networks/{network}` or `{network}`, where - * {project} is a project id where the network is defined, and {network} is - * the short name of the network. This field is mutually exclusive with - * `vpc_connector` and will be replaced by it. See [the VPC - * documentation](https://cloud.google.com/compute/docs/vpc) for more - * information on connecting Cloud projects. This feature is currently in - * alpha, available only for whitelisted users. + * The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. This feature is currently in alpha, available only for whitelisted users. */ network?: string; /** - * Required. The runtime in which the function is going to run. Choices: * - * `nodejs6`: Node.js 6 * `nodejs8`: Node.js 8 * `nodejs10`: Node.js 10 * - * `python37`: Python 3.7 * `go111`: Go 1.11 + * Required. The runtime in which the function is going to run. Choices: * `nodejs6`: Node.js 6 * `nodejs8`: Node.js 8 * `nodejs10`: Node.js 10 * `python37`: Python 3.7 * `go111`: Go 1.11 */ runtime?: string; /** - * The email of the function's service account. If empty, defaults to - * {project_id}@appspot.gserviceaccount.com. + * The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com. */ serviceAccount?: string; /** - * The Google Cloud Storage URL, starting with gs://, pointing to the zip - * archive which contains the function. + * The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. */ sourceArchiveUrl?: string; /** @@ -234,21 +206,11 @@ export namespace cloudfunctions_v1beta2 { */ sourceRepository?: Schema$SourceRepository; /** - * The URL pointing to the hosted repository where the function is defined. - * There are supported Cloud Source Repository URLs in the following - * formats: To refer to a specific commit: - * `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x - * To refer to a moveable alias (branch): - * `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x - * In particular, to refer to HEAD use `master` moveable alias. To refer to - * a specific fixed alias (tag): - * `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x - * You may omit `paths/x if you want to use the main directory. + * The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x To refer to a moveable alias (branch): `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x You may omit `paths/x if you want to use the main directory. */ sourceRepositoryUrl?: string; /** - * The Google Cloud Storage signed URL used for source uploading, generated - * by google.cloud.functions.v1beta2.GenerateUploadUrl + * The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1beta2.GenerateUploadUrl */ sourceUploadUrl?: string; /** @@ -256,9 +218,7 @@ export namespace cloudfunctions_v1beta2 { */ status?: string; /** - * The function execution timeout. Execution is considered failed and can be - * terminated if the function is not completed at the end of the timeout - * period. Defaults to 60 seconds. + * The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. */ timeout?: string; /** @@ -266,36 +226,20 @@ export namespace cloudfunctions_v1beta2 { */ updateTime?: string; /** - * Output only. The version identifier of the Cloud Function. Each - * deployment attempt results in a new version of a function being created. + * Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. */ versionId?: string; /** - * The VPC Network Connector that this cloud function can connect to. It can - * be either the fully-qualified URI, or the short name of the network - * connector resource. The format of this field is - * `projects/x/locations/x/connectors/x This field is mutually exclusive - * with `network` field and will eventually replace it. See [the VPC - * documentation](https://cloud.google.com/compute/docs/vpc) for more - * information on connecting Cloud projects. This feature is currently in - * alpha, available only for whitelisted users. + * The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/x/locations/x/connectors/x This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. This feature is currently in alpha, available only for whitelisted users. */ vpcConnector?: string; } /** - * Describes EventTrigger, used to request events be sent from another - * service. + * Describes EventTrigger, used to request events be sent from another service. */ export interface Schema$EventTrigger { /** - * `event_type` names contain the service that is sending an event and the - * kind of event that was fired. Must be of the form - * `providers/x/eventTypes/x e.g. Directly handle a Message published to - * Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. - * Handle an object changing in Google Cloud Storage: - * `providers/cloud.storage/eventTypes/object.change` Handle a write to the - * Firebase Realtime Database: - * `providers/google.firebase.database/eventTypes/ref.write` + * `event_type` names contain the service that is sending an event and the kind of event that was fired. Must be of the form `providers/x/eventTypes/x e.g. Directly handle a Message published to Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. Handle an object changing in Google Cloud Storage: `providers/cloud.storage/eventTypes/object.change` Handle a write to the Firebase Realtime Database: `providers/google.firebase.database/eventTypes/ref.write` */ eventType?: string; /** @@ -303,24 +247,16 @@ export namespace cloudfunctions_v1beta2 { */ failurePolicy?: Schema$FailurePolicy; /** - * Which instance of the source's service should send events. E.g. for - * Pub/Sub this would be a Pub/Sub topic at `projects/x/topics/x. For Google - * Cloud Storage this would be a bucket at `projects/x/buckets/x. For any - * source that only supports one instance per-project, this should be the - * name of the project (`projects/x) + * Which instance of the source's service should send events. E.g. for Pub/Sub this would be a Pub/Sub topic at `projects/x/topics/x. For Google Cloud Storage this would be a bucket at `projects/x/buckets/x. For any source that only supports one instance per-project, this should be the name of the project (`projects/x) */ resource?: string; /** - * The hostname of the service that should be observed. If no string is - * provided, the default service implementing the API will be used. For - * example, `storage.googleapis.com` is the default for all event types in - * the `google.storage` namespace. + * The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, `storage.googleapis.com` is the default for all event types in the `google.storage` namespace. */ service?: string; } /** - * Describes the policy in case of function's execution failure. If empty, - * then defaults to ignoring failures (i.e. not retrying them). + * Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them). */ export interface Schema$FailurePolicy { /** @@ -342,8 +278,7 @@ export namespace cloudfunctions_v1beta2 { */ export interface Schema$GenerateDownloadUrlResponse { /** - * The generated Google Cloud Storage signed URL that should be used for - * function source code download. + * The generated Google Cloud Storage signed URL that should be used for function source code download. */ downloadUrl?: string; } @@ -356,9 +291,7 @@ export namespace cloudfunctions_v1beta2 { */ export interface Schema$GenerateUploadUrlResponse { /** - * The generated Google Cloud Storage signed URL that should be used for a - * function source code upload. The uploaded file should be a zip archive - * which contains a function. + * The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function. */ uploadUrl?: string; } @@ -380,10 +313,7 @@ export namespace cloudfunctions_v1beta2 { */ functions?: Schema$CloudFunction[]; /** - * If not empty, indicates that there may be more functions that match the - * request; this value should be passed in a new - * google.cloud.functions.v1beta2.ListFunctionsRequest to get more - * functions. + * If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1beta2.ListFunctionsRequest to get more functions. */ nextPageToken?: string; } @@ -418,13 +348,11 @@ export namespace cloudfunctions_v1beta2 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -432,25 +360,20 @@ export namespace cloudfunctions_v1beta2 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -458,26 +381,15 @@ export namespace cloudfunctions_v1beta2 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -490,8 +402,7 @@ export namespace cloudfunctions_v1beta2 { */ request?: {[key: string]: any}; /** - * Target of the operation - for example - * projects/project-1/locations/region-1/functions/function-1 + * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ target?: string; /** @@ -503,8 +414,7 @@ export namespace cloudfunctions_v1beta2 { */ updateTime?: string; /** - * Version id of the function created or updated by an API call. This field - * is only populated for Create and Update operations. + * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ versionId?: string; } @@ -517,8 +427,7 @@ export namespace cloudfunctions_v1beta2 { */ request?: {[key: string]: any}; /** - * Target of the operation - for example - * projects/project-1/locations/region-1/functions/function-1 + * Target of the operation - for example projects/project-1/locations/region-1/functions/function-1 */ target?: string; /** @@ -530,16 +439,12 @@ export namespace cloudfunctions_v1beta2 { */ updateTime?: string; /** - * Version id of the function created or updated by an API call. This field - * is only populated for Create and Update operations. + * Version id of the function created or updated by an API call. This field is only populated for Create and Update operations. */ versionId?: string; } /** - * Describes the retry policy in case of function's execution failure. A - * function execution will be retried on any failure. A failed execution will - * be retried up to 7 days with an exponential backoff (capped at 10 seconds). - * Retried execution is charged as any other execution. + * Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution. */ export interface Schema$Retry {} /** @@ -551,72 +456,28 @@ export namespace cloudfunctions_v1beta2 { */ branch?: string; /** - * Output only. The id of the revision that was resolved at the moment of - * function creation or update. For example when a user deployed from a - * branch, it will be the revision id of the latest change on this branch at - * that time. If user deployed from revision then this value will be always - * equal to the revision specified by the user. + * Output only. The id of the revision that was resolved at the moment of function creation or update. For example when a user deployed from a branch, it will be the revision id of the latest change on this branch at that time. If user deployed from revision then this value will be always equal to the revision specified by the user. */ deployedRevision?: string; /** - * URL to the hosted repository where the function is defined. Only paths in - * https://source.developers.google.com domain are supported. The path - * should contain the name of the repository. + * URL to the hosted repository where the function is defined. Only paths in https://source.developers.google.com domain are supported. The path should contain the name of the repository. */ repositoryUrl?: string; /** - * The id of the revision that captures the state of the repository from - * which the function should be fetched. + * The id of the revision that captures the state of the repository from which the function should be fetched. */ revision?: string; /** - * The path within the repository where the function is defined. The path - * should point to the directory where Cloud Functions files are located. - * Use "/" if the function is defined directly in the root - * directory of a repository. + * The path within the repository where the function is defined. The path should point to the directory where Cloud Functions files are located. Use "/" if the function is defined directly in the root directory of a repository. */ sourcePath?: string; /** - * The name of the tag that captures the state of the repository from which - * the function should be fetched. + * The name of the tag that captures the state of the repository from which the function should be fetched. */ tag?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -624,14 +485,11 @@ export namespace cloudfunctions_v1beta2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -644,9 +502,7 @@ export namespace cloudfunctions_v1beta2 { /** * cloudfunctions.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudfunctions.operations.get * @memberOf! () * @@ -717,15 +573,7 @@ export namespace cloudfunctions_v1beta2 { /** * cloudfunctions.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias cloudfunctions.operations.list * @memberOf! () * @@ -821,11 +669,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A filter for matching the requested operations.

                          The - * supported formats of filter are:
                          To query for specific - * function: project:*,location:*,function:*
                          To query for - * all of the latest operations for a project: - * project:*,latest:true + * Required. A filter for matching the requested operations.

                          The supported formats of filter are:
                          To query for specific function: project:*,location:*,function:*
                          To query for all of the latest operations for a project: project:*,latest:true */ filter?: string; /** @@ -973,10 +817,7 @@ export namespace cloudfunctions_v1beta2 { /** * cloudfunctions.projects.locations.functions.call - * @desc Synchronously invokes a deployed Cloud Function. To be used for - * testing purposes as very limited traffic is allowed. For more information - * on the actual limits refer to [API Calls]( - * https://cloud.google.com/functions/quotas#rate_limits). + * @desc Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits refer to [API Calls]( https://cloud.google.com/functions/quotas#rate_limits). * @alias cloudfunctions.projects.locations.functions.call * @memberOf! () * @@ -1054,9 +895,7 @@ export namespace cloudfunctions_v1beta2 { /** * cloudfunctions.projects.locations.functions.create - * @desc Creates a new function. If a function with the given name already - * exists in the specified project, the long running operation will return - * `ALREADY_EXISTS` error. + * @desc Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. * @alias cloudfunctions.projects.locations.functions.create * @memberOf! () * @@ -1132,9 +971,7 @@ export namespace cloudfunctions_v1beta2 { /** * cloudfunctions.projects.locations.functions.delete - * @desc Deletes a function with the given name from the specified project. - * If the given function is used by some trigger, the trigger will be - * updated to remove this function. + * @desc Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function. * @alias cloudfunctions.projects.locations.functions.delete * @memberOf! () * @@ -1206,10 +1043,7 @@ export namespace cloudfunctions_v1beta2 { /** * cloudfunctions.projects.locations.functions.generateDownloadUrl - * @desc Returns a signed URL for downloading deployed function source code. - * The URL is only valid for a limited period and should be used within - * minutes after generation. For more information about the signed URL usage - * see: https://cloud.google.com/storage/docs/access-control/signed-urls + * @desc Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within minutes after generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls * @alias cloudfunctions.projects.locations.functions.generateDownloadUrl * @memberOf! () * @@ -1292,22 +1126,7 @@ export namespace cloudfunctions_v1beta2 { /** * cloudfunctions.projects.locations.functions.generateUploadUrl - * @desc Returns a signed URL for uploading a function source code. For more - * information about the signed URL usage see: - * https://cloud.google.com/storage/docs/access-control/signed-urls Once the - * function source code upload is complete, the used signed URL should be - * provided in CreateFunction or UpdateFunction request as a reference to - * the function source code. When uploading source code to the generated - * signed URL, please follow these restrictions: * Source file type should - * be a zip file. * Source file size should not exceed 100MB limit. * No - * credentials should be attached - the signed URLs provide access to the - * target bucket using internal service identity; if credentials were - * attached, the identity from the credentials would be used, but that - * identity does not have permissions to upload files to the URL. When - * making a HTTP PUT request, these two headers need to be specified: * - * `content-type: application/zip` * `x-goog-content-length-range: - * 0,104857600` And this header SHOULD NOT be specified: * `Authorization: - * Bearer YOUR_TOKEN` + * @desc Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 100MB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,104857600` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` * @alias cloudfunctions.projects.locations.functions.generateUploadUrl * @memberOf! () * @@ -1637,8 +1456,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location in which the function should be created, - * specified in the format `projects/x/locations/x` + * The project and location in which the function should be created, specified in the format `projects/x/locations/x` */ location?: string; @@ -1667,8 +1485,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of function for which source code Google Cloud Storage signed - * URL should be generated. + * The name of function for which source code Google Cloud Storage signed URL should be generated. */ name?: string; @@ -1685,8 +1502,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location in which the Google Cloud Storage signed URL - * should be generated, specified in the format `projects/x/locations/x`. + * The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/x/locations/x`. */ parent?: string; @@ -1715,9 +1531,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location from which the function should be listed, - * specified in the format `projects/x/locations/x` If you want to list - * functions in all locations, use "-" in place of a location. + * The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location. */ location?: string; /** @@ -1725,9 +1539,7 @@ export namespace cloudfunctions_v1beta2 { */ pageSize?: number; /** - * The value returned by the last `ListFunctionsResponse`; indicates that - * this is a continuation of a prior `ListFunctions` call, and that the - * system should return the next page of data. + * The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data. */ pageToken?: string; } diff --git a/src/apis/cloudidentity/package.json b/src/apis/cloudidentity/package.json index 5cdcd649796..e289d8cd384 100644 --- a/src/apis/cloudidentity/package.json +++ b/src/apis/cloudidentity/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 9ea538c8ea0..e93f6d8ec05 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudidentity_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudidentity_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,29 +108,25 @@ export namespace cloudidentity_v1 { groups: Resource$Groups; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.groups = new Resource$Groups(this.context); } } /** - * An EntityKey uniquely identifies an Entity. Namespaces are used to provide - * isolation for IDs. A single ID can be reused across namespaces but the - * combination of a namespace and an ID must be unique. + * An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. */ export interface Schema$EntityKey { /** - * The ID of the entity within the given namespace. The ID must be unique - * within its namespace. + * The ID of the entity within the given namespace. The ID must be unique within its namespace. */ id?: string; /** - * Namespaces provide isolation for IDs, so an ID only needs to be unique - * within its namespace. Namespaces are currently only created as part of - * IdentitySource creation from Admin Console. A namespace - * `"identitysources/{identity_source_id}"` is created - * corresponding to every Identity Source `identity_source_id`. + * Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. */ namespace?: string; } @@ -147,10 +139,7 @@ export namespace cloudidentity_v1 { */ createTime?: string; /** - * An extended description to help users determine the purpose of a Group. - * For example, you can include information about who should join the Group, - * the types of messages to send to the Group, links to FAQs about the - * Group, or related Groups. Maximum length is 4,096 characters. + * An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters. */ description?: string; /** @@ -158,27 +147,19 @@ export namespace cloudidentity_v1 { */ displayName?: string; /** - * EntityKey of the Group. Must be set when creating a Group, read-only - * afterwards. + * EntityKey of the Group. Must be set when creating a Group, read-only afterwards. */ groupKey?: Schema$EntityKey; /** - * `Required`. Labels for Group resource. For creating Groups under a - * namespace, set label key to 'labels/system/groups/external' and - * label value as empty. + * `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. */ labels?: {[key: string]: string}; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where group_id is the - * unique ID assigned to the Group. Must be left blank while creating a - * Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group. */ name?: string; /** - * The entity under which this Group resides in Cloud Identity resource - * hierarchy. Must be set when creating a Group, read-only afterwards. - * Currently allowed types: `identitysources`. + * The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`. */ parent?: string; /** @@ -195,8 +176,7 @@ export namespace cloudidentity_v1 { */ groups?: Schema$Group[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results available for listing. + * Token to retrieve the next page of results, or empty if there are no more results available for listing. */ nextPageToken?: string; } @@ -206,26 +186,19 @@ export namespace cloudidentity_v1 { */ memberships?: Schema$Membership[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results available for listing. + * Token to retrieve the next page of results, or empty if there are no more results available for listing. */ nextPageToken?: string; } export interface Schema$LookupGroupNameResponse { /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where `group_id` is the - * unique ID assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ name?: string; } export interface Schema$LookupMembershipNameResponse { /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership being looked up. Format: - * `groups/{group_id}/memberships/{member_id}`, where `group_id` is the - * unique ID assigned to the Group to which Membership belongs to, and - * `member_id` is the unique ID assigned to the member. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership being looked up. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member. */ name?: string; } @@ -238,23 +211,15 @@ export namespace cloudidentity_v1 { */ createTime?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership in the format: - * `groups/{group_id}/memberships/{member_id}`, where group_id is the unique - * ID assigned to the Group to which Membership belongs to, and member_id is - * the unique ID assigned to the member Must be left blank while creating a - * Membership. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership. */ name?: string; /** - * EntityKey of the entity to be added as the member. Must be set while - * creating a Membership, read-only afterwards. Currently allowed entity - * types: `Users`, `Groups`. + * EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. */ preferredMemberKey?: Schema$EntityKey; /** - * Roles for a member within the Group. Currently supported - * MembershipRoles: `"MEMBER"`. + * Roles for a member within the Group. Currently supported MembershipRoles: `"MEMBER"`. */ roles?: Schema$MembershipRole[]; /** @@ -267,20 +232,16 @@ export namespace cloudidentity_v1 { */ export interface Schema$MembershipRole { /** - * MembershipRole in string format. Currently supported MembershipRoles: - * `"MEMBER"`. + * MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER"`. */ name?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -288,26 +249,15 @@ export namespace cloudidentity_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -317,46 +267,12 @@ export namespace cloudidentity_v1 { */ groups?: Schema$Group[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results available for specified query. + * Token to retrieve the next page of results, or empty if there are no more results available for specified query. */ nextPageToken?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -364,14 +280,11 @@ export namespace cloudidentity_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -671,9 +584,7 @@ export namespace cloudidentity_v1 { /** * cloudidentity.groups.lookup - * @desc Looks up [resource - * name](https://cloud.google.com/apis/design/resource_names) of a Group by - * its EntityKey. + * @desc Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Group by its EntityKey. * @alias cloudidentity.groups.lookup * @memberOf! () * @@ -915,9 +826,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where `group_id` is the - * unique ID assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ name?: string; } @@ -928,9 +837,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where `group_id` is the - * unique ID assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ name?: string; } @@ -941,8 +848,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The default page size is 200 (max 1000) for the BASIC view, and 50 (max - * 500) for the FULL view. + * The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. */ pageSize?: number; /** @@ -950,8 +856,7 @@ export namespace cloudidentity_v1 { */ pageToken?: string; /** - * `Required`. May be made Optional in the future. Customer ID to list all - * groups from. + * `Required`. May be made Optional in the future. Customer ID to list all groups from. */ parent?: string; /** @@ -966,16 +871,11 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the entity within the given namespace. The ID must be unique - * within its namespace. + * The ID of the entity within the given namespace. The ID must be unique within its namespace. */ 'groupKey.id'?: string; /** - * Namespaces provide isolation for IDs, so an ID only needs to be unique - * within its namespace. Namespaces are currently only created as part of - * IdentitySource creation from Admin Console. A namespace - * `"identitysources/{identity_source_id}"` is created corresponding to - * every Identity Source `identity_source_id`. + * Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. */ 'groupKey.namespace'?: string; } @@ -986,10 +886,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where group_id is the - * unique ID assigned to the Group. Must be left blank while creating a - * Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group. */ name?: string; /** @@ -1009,19 +906,15 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The default page size is 200 (max 1000) for the BASIC view, and 50 (max - * 500) for the FULL view. + * The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. */ pageSize?: number; /** - * The next_page_token value returned from a previous search request, if - * any. + * The next_page_token value returned from a previous search request, if any. */ pageToken?: string; /** - * `Required`. Query string for performing search on groups. Users can - * search on parent and label attributes of groups. EXACT match ('==') is - * supported on parent, and CONTAINS match ('in') is supported on labels. + * `Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels. */ query?: string; /** @@ -1338,9 +1231,7 @@ export namespace cloudidentity_v1 { /** * cloudidentity.groups.memberships.lookup - * @desc Looks up [resource - * name](https://cloud.google.com/apis/design/resource_names) of a - * Membership within a Group by member's EntityKey. + * @desc Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Membership within a Group by member's EntityKey. * @alias cloudidentity.groups.memberships.lookup * @memberOf! () * @@ -1433,9 +1324,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group to create Membership within. Format: `groups/{group_id}`, where - * `group_id` is the unique ID assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ parent?: string; @@ -1452,11 +1341,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership to be deleted. Format: - * `groups/{group_id}/memberships/{member_id}`, where `group_id` is the - * unique ID assigned to the Group to which Membership belongs to, and - * member_id is the unique ID assigned to the member. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member. */ name?: string; } @@ -1468,11 +1353,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership to be retrieved. Format: - * `groups/{group_id}/memberships/{member_id}`, where `group_id` is the - * unique id assigned to the Group to which Membership belongs to, and - * `member_id` is the unique ID assigned to the member. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member. */ name?: string; } @@ -1484,8 +1365,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The default page size is 200 (max 1000) for the BASIC view, and 50 (max - * 500) for the FULL view. + * The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. */ pageSize?: number; /** @@ -1493,9 +1373,7 @@ export namespace cloudidentity_v1 { */ pageToken?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group to list Memberships within. Format: `groups/{group_id}`, where - * `group_id` is the unique ID assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ parent?: string; /** @@ -1511,22 +1389,15 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the entity within the given namespace. The ID must be unique - * within its namespace. + * The ID of the entity within the given namespace. The ID must be unique within its namespace. */ 'memberKey.id'?: string; /** - * Namespaces provide isolation for IDs, so an ID only needs to be unique - * within its namespace. Namespaces are currently only created as part of - * IdentitySource creation from Admin Console. A namespace - * `"identitysources/{identity_source_id}"` is created corresponding to - * every Identity Source `identity_source_id`. + * Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. */ 'memberKey.namespace'?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group to lookup Membership within. Format: `groups/{group_id}`, - * where `group_id` is the unique ID assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ parent?: string; } diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 26fb90984a7..463b6359a76 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudidentity_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudidentity_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,29 +108,25 @@ export namespace cloudidentity_v1beta1 { groups: Resource$Groups; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.groups = new Resource$Groups(this.context); } } /** - * An EntityKey uniquely identifies an Entity. Namespaces are used to provide - * isolation for ids. A single Id can be reused across namespaces but the - * combination of a namespace and an id must be unique. + * An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for ids. A single Id can be reused across namespaces but the combination of a namespace and an id must be unique. */ export interface Schema$EntityKey { /** - * The id of the entity within the given namespace. The id must be unique - * within its namespace. + * The id of the entity within the given namespace. The id must be unique within its namespace. */ id?: string; /** - * Namespaces provide isolation for ids, i.e an id only needs to be unique - * within its namespace. Namespaces are currently only created as part of - * IdentitySource creation from Admin Console. A namespace - * `"identitysources/{identity_source_id}"` is created - * corresponding to every Identity Source `identity_source_id`. + * Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. */ namespace?: string; } @@ -151,10 +143,7 @@ export namespace cloudidentity_v1beta1 { */ createTime?: string; /** - * An extended description to help users determine the purpose of a Group. - * For example, you can include information about who should join the Group, - * the types of messages to send to the Group, links to FAQs about the - * Group, or related Groups. Maximum length is 4,096 characters. + * An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters. */ description?: string; /** @@ -162,27 +151,19 @@ export namespace cloudidentity_v1beta1 { */ displayName?: string; /** - * EntityKey of the Group. Must be set when creating a Group, read-only - * afterwards. + * EntityKey of the Group. Must be set when creating a Group, read-only afterwards. */ groupKey?: Schema$EntityKey; /** - * Labels for Group resource. Required. For creating Groups under a - * namespace, set label key to 'labels/system/groups/external' and - * label value as empty. + * Labels for Group resource. Required. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. */ labels?: {[key: string]: string}; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where group_id is the - * unique id assigned to the Group. Must be left blank while creating a - * Group + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group */ name?: string; /** - * The entity under which this Group resides in Cloud Identity resource - * hierarchy. Must be set when creating a Group, read-only afterwards. - * Currently allowed types: 'identitysources'. + * The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: 'identitysources'. */ parent?: string; /** @@ -196,26 +177,19 @@ export namespace cloudidentity_v1beta1 { */ memberships?: Schema$Membership[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results available for listing. + * Token to retrieve the next page of results, or empty if there are no more results available for listing. */ nextPageToken?: string; } export interface Schema$LookupGroupNameResponse { /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where `group_id` is the - * unique id assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. */ name?: string; } export interface Schema$LookupMembershipNameResponse { /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership being looked up. Format: - * `groups/{group_id}/memberships/{member_id}`, where `group_id` is the - * unique id assigned to the Group to which Membership belongs to, and - * `member_id` is the unique id assigned to the member. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership being looked up. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique id assigned to the member. */ name?: string; } @@ -228,23 +202,15 @@ export namespace cloudidentity_v1beta1 { */ createTime?: string; /** - * EntityKey of the entity to be added as the member. Must be set while - * creating a Membership, read-only afterwards. Currently allowed entity - * types: `Users`, `Groups`. + * EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. */ memberKey?: Schema$EntityKey; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership in the format: - * `groups/{group_id}/memberships/{member_id}`, where group_id is the unique - * id assigned to the Group to which Membership belongs to, and member_id is - * the unique id assigned to the member Must be left blank while creating a - * Membership. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique id assigned to the member Must be left blank while creating a Membership. */ name?: string; /** - * Roles for a member within the Group. Currently supported - * MembershipRoles: `"MEMBER"`. + * Roles for a member within the Group. Currently supported MembershipRoles: `"MEMBER"`. */ roles?: Schema$MembershipRole[]; /** @@ -257,20 +223,16 @@ export namespace cloudidentity_v1beta1 { */ export interface Schema$MembershipRole { /** - * MembershipRole in string format. Currently supported MembershipRoles: - * `"MEMBER"`. + * MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER"`. */ name?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -278,26 +240,15 @@ export namespace cloudidentity_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -307,46 +258,12 @@ export namespace cloudidentity_v1beta1 { */ groups?: Schema$Group[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results available for specified query. + * Token to retrieve the next page of results, or empty if there are no more results available for specified query. */ nextPageToken?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -354,14 +271,11 @@ export namespace cloudidentity_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -587,9 +501,7 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.lookup - * @desc Looks up [resource - * name](https://cloud.google.com/apis/design/resource_names) of a Group by - * its EntityKey. + * @desc Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Group by its EntityKey. * @alias cloudidentity.groups.lookup * @memberOf! () * @@ -837,9 +749,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where `group_id` is the - * unique id assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. */ name?: string; } @@ -850,9 +760,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where `group_id` is the - * unique id assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. */ name?: string; } @@ -863,16 +771,11 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the entity within the given namespace. The id must be unique - * within its namespace. + * The id of the entity within the given namespace. The id must be unique within its namespace. */ 'groupKey.id'?: string; /** - * Namespaces provide isolation for ids, i.e an id only needs to be unique - * within its namespace. Namespaces are currently only created as part of - * IdentitySource creation from Admin Console. A namespace - * `"identitysources/{identity_source_id}"` is created corresponding to - * every Identity Source `identity_source_id`. + * Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. */ 'groupKey.namespace'?: string; } @@ -883,10 +786,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group in the format: `groups/{group_id}`, where group_id is the - * unique id assigned to the Group. Must be left blank while creating a - * Group + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group */ name?: string; /** @@ -906,22 +806,15 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The default page size is 200 (max 1000) for the BASIC view, and 50 (max - * 500) for the FULL view. + * The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. */ pageSize?: number; /** - * The next_page_token value returned from a previous search request, if - * any. + * The next_page_token value returned from a previous search request, if any. */ pageToken?: string; /** - * Query string for performing search on groups. Users can search on - * namespace and label attributes of groups. EXACT match ('=') is supported - * on namespace, and CONTAINS match (':') is supported on labels. This is a - * `required` field. Multiple queries can be combined using `AND` operator. - * The operator is case sensitive. An example query would be: - * "namespace= AND labels:". + * Query string for performing search on groups. Users can search on namespace and label attributes of groups. EXACT match ('=') is supported on namespace, and CONTAINS match (':') is supported on labels. This is a `required` field. Multiple queries can be combined using `AND` operator. The operator is case sensitive. An example query would be: "namespace= AND labels:". */ query?: string; /** @@ -1238,9 +1131,7 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.memberships.lookup - * @desc Looks up [resource - * name](https://cloud.google.com/apis/design/resource_names) of a - * Membership within a Group by member's EntityKey. + * @desc Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Membership within a Group by member's EntityKey. * @alias cloudidentity.groups.memberships.lookup * @memberOf! () * @@ -1333,9 +1224,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group to create Membership within. Format: `groups/{group_id}`, where - * `group_id` is the unique id assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. */ parent?: string; @@ -1352,11 +1241,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership to be deleted. Format: - * `groups/{group_id}/memberships/{member_id}`, where `group_id` is the - * unique id assigned to the Group to which Membership belongs to, and - * member_id is the unique id assigned to the member. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique id assigned to the member. */ name?: string; } @@ -1368,11 +1253,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Membership to be retrieved. Format: - * `groups/{group_id}/memberships/{member_id}`, where `group_id` is the - * unique id assigned to the Group to which Membership belongs to, and - * `member_id` is the unique id assigned to the member. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique id assigned to the member. */ name?: string; } @@ -1384,8 +1265,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The default page size is 200 (max 1000) for the BASIC view, and 50 (max - * 500) for the FULL view. + * The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. */ pageSize?: number; /** @@ -1393,14 +1273,11 @@ export namespace cloudidentity_v1beta1 { */ pageToken?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group to list Memberships within. Format: `groups/{group_id}`, where - * `group_id` is the unique id assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. */ parent?: string; /** - * Membership resource view to be returned. Defaults to - * MembershipView.BASIC. + * Membership resource view to be returned. Defaults to MembershipView.BASIC. */ view?: string; } @@ -1412,22 +1289,15 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the entity within the given namespace. The id must be unique - * within its namespace. + * The id of the entity within the given namespace. The id must be unique within its namespace. */ 'memberKey.id'?: string; /** - * Namespaces provide isolation for ids, i.e an id only needs to be unique - * within its namespace. Namespaces are currently only created as part of - * IdentitySource creation from Admin Console. A namespace - * `"identitysources/{identity_source_id}"` is created corresponding to - * every Identity Source `identity_source_id`. + * Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. */ 'memberKey.namespace'?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of - * the Group to lookup Membership within. Format: `groups/{group_id}`, - * where `group_id` is the unique id assigned to the Group. + * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. */ parent?: string; } diff --git a/src/apis/cloudiot/package.json b/src/apis/cloudiot/package.json index e9a1f64aa41..a0baf74e35f 100644 --- a/src/apis/cloudiot/package.json +++ b/src/apis/cloudiot/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index 384db229364..a3315ad3231 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudiot_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudiot_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudiot_v1 { /** * Cloud IoT API * - * Registers and manages IoT (Internet of Things) devices that connect to the - * Google Cloud Platform. + * Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace cloudiot_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,14 +122,11 @@ export namespace cloudiot_v1 { */ export interface Schema$BindDeviceToGatewayRequest { /** - * The device to associate with the specified gateway. The value of - * `device_id` can be either the device numeric ID or the user-defined - * device identifier. + * The device to associate with the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. */ deviceId?: string; /** - * The value of `gateway_id` can be either the device numeric ID or the - * user-defined device identifier. + * The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. */ gatewayId?: string; } @@ -144,30 +139,15 @@ export namespace cloudiot_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -176,26 +156,15 @@ export namespace cloudiot_v1 { */ export interface Schema$Device { /** - * If a device is blocked, connections or requests from this device will - * fail. Can be used to temporarily prevent the device from connecting if, - * for example, the sensor is generating bad data and needs maintenance. + * If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance. */ blocked?: boolean; /** - * The most recent device configuration, which is eventually sent from Cloud - * IoT Core to the device. If not present on creation, the configuration - * will be initialized with an empty payload and version value of `1`. To - * update this field after creation, use the - * `DeviceManager.ModifyCloudToDeviceConfig` method. + * The most recent device configuration, which is eventually sent from Cloud IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and version value of `1`. To update this field after creation, use the `DeviceManager.ModifyCloudToDeviceConfig` method. */ config?: Schema$DeviceConfig; /** - * The credentials used to authenticate this device. To allow credential - * rotation without interruption, multiple device credentials can be bound - * to this device. No more than 3 credentials can be bound to a single - * device at a time. When new credentials are added to a device, they are - * verified against the registry credentials. For details, see the - * description of the `DeviceRegistry.credentials` field. + * The credentials used to authenticate this device. To allow credential rotation without interruption, multiple device credentials can be bound to this device. No more than 3 credentials can be bound to a single device at a time. When new credentials are added to a device, they are verified against the registry credentials. For details, see the description of the `DeviceRegistry.credentials` field. */ credentials?: Schema$DeviceCredential[]; /** @@ -203,86 +172,55 @@ export namespace cloudiot_v1 { */ gatewayConfig?: Schema$GatewayConfig; /** - * The user-defined device identifier. The device ID must be unique within a - * device registry. + * The user-defined device identifier. The device ID must be unique within a device registry. */ id?: string; /** - * [Output only] The last time a cloud-to-device config version - * acknowledgment was received from the device. This field is only for - * configurations sent through MQTT. + * [Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT. */ lastConfigAckTime?: string; /** - * [Output only] The last time a cloud-to-device config version was sent to - * the device. + * [Output only] The last time a cloud-to-device config version was sent to the device. */ lastConfigSendTime?: string; /** - * [Output only] The error message of the most recent error, such as a - * failure to publish to Cloud Pub/Sub. 'last_error_time' is the - * timestamp of this field. If no errors have occurred, this field has an - * empty message and the status code 0 == OK. Otherwise, this field is - * expected to have a status code other than OK. + * [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK. */ lastErrorStatus?: Schema$Status; /** - * [Output only] The time the most recent error occurred, such as a failure - * to publish to Cloud Pub/Sub. This field is the timestamp of - * 'last_error_status'. + * [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'. */ lastErrorTime?: string; /** - * [Output only] The last time a telemetry event was received. Timestamps - * are periodically collected and written to storage; they may be stale by a - * few minutes. + * [Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. */ lastEventTime?: string; /** - * [Output only] The last time an MQTT `PINGREQ` was received. This field - * applies only to devices connecting through MQTT. MQTT clients usually - * only send `PINGREQ` messages if the connection is idle, and no other - * messages have been sent. Timestamps are periodically collected and - * written to storage; they may be stale by a few minutes. + * [Output only] The last time an MQTT `PINGREQ` was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send `PINGREQ` messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. */ lastHeartbeatTime?: string; /** - * [Output only] The last time a state event was received. Timestamps are - * periodically collected and written to storage; they may be stale by a few - * minutes. + * [Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. */ lastStateTime?: string; /** - * **Beta Feature** The logging verbosity for device activity. If - * unspecified, DeviceRegistry.log_level will be used. + * **Beta Feature** The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used. */ logLevel?: string; /** - * The metadata key-value pairs assigned to the device. This metadata is not - * interpreted or indexed by Cloud IoT Core. It can be used to add - * contextual information for the device. Keys must conform to the regular - * expression a-zA-Z+ and be less than 128 bytes in length. Values are - * free-form strings. Each value must be less than or equal to 32 KB in - * size. The total size of all keys and values must be less than 256 KB, - * and the maximum number of key-value pairs is 500. + * The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression a-zA-Z+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500. */ metadata?: {[key: string]: string}; /** - * The resource path name. For example, - * `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or - * `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. - * When `name` is populated as a response from the service, it always ends - * in the device numeric ID. + * The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. */ name?: string; /** - * [Output only] A server-defined unique numeric ID for the device. This is - * a more compact way to identify devices, and it is globally unique. + * [Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique. */ numId?: string; /** - * [Output only] The state most recently received from the device. If no - * state has been reported, this field is not present. + * [Output only] The state most recently received from the device. If no state has been reported, this field is not present. */ state?: Schema$DeviceState; } @@ -295,27 +233,15 @@ export namespace cloudiot_v1 { */ binaryData?: string; /** - * [Output only] The time at which this configuration version was updated in - * Cloud IoT Core. This timestamp is set by the server. + * [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server. */ cloudUpdateTime?: string; /** - * [Output only] The time at which Cloud IoT Core received the - * acknowledgment from the device, indicating that the device has received - * this configuration version. If this field is not present, the device has - * not yet acknowledged that it received this version. Note that when the - * config was sent to the device, many config versions may have been - * available in Cloud IoT Core while the device was disconnected, and on - * connection, only the latest version is sent to the device. Some versions - * may never be sent to the device, and therefore are never acknowledged. - * This timestamp is set by Cloud IoT Core. + * [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core. */ deviceAckTime?: string; /** - * [Output only] The version of this update. The version number is assigned - * by the server, and is always greater than 0 after device creation. The - * version must be 0 on the `CreateDevice` request if a `config` is - * specified; the response of `CreateDevice` will always have a value of 1. + * [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the `CreateDevice` request if a `config` is specified; the response of `CreateDevice` will always have a value of 1. */ version?: string; } @@ -324,23 +250,11 @@ export namespace cloudiot_v1 { */ export interface Schema$DeviceCredential { /** - * [Optional] The time at which this credential becomes invalid. This - * credential will be ignored for new client authentication requests after - * this timestamp; however, it will not be automatically deleted. + * [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted. */ expirationTime?: string; /** - * A public key used to verify the signature of JSON Web Tokens (JWTs). When - * adding a new device credential, either via device creation or via - * modifications, this public key credential may be required to be signed by - * one of the registry level certificates. More specifically, if the - * registry contains at least one certificate, any new device credential - * must be signed by one of the registry certificates. As a result, when the - * registry contains certificates, only X.509 certificates are accepted as - * device credentials. However, if the registry does not contain a - * certificate, self-signed certificates and public keys will be accepted. - * New device credentials must be different from every registry-level - * certificate. + * A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate. */ publicKey?: Schema$PublicKeyCredential; } @@ -349,28 +263,11 @@ export namespace cloudiot_v1 { */ export interface Schema$DeviceRegistry { /** - * The credentials used to verify the device credentials. No more than 10 - * credentials can be bound to a single registry at a time. The verification - * process occurs at the time of device creation or update. If this field is - * empty, no verification is performed. Otherwise, the credentials of a - * newly created device or added credentials of an updated device should be - * signed with one of these registry credentials. Note, however, that - * existing devices will never be affected by modifications to this list of - * credentials: after a device has been successfully created in a registry, - * it should be able to connect even if its registry credentials are - * revoked, deleted, or modified. + * The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. */ credentials?: Schema$RegistryCredential[]; /** - * The configuration for notification of telemetry events received from the - * device. All telemetry events that were successfully published by the - * device and acknowledged by Cloud IoT Core are guaranteed to be delivered - * to Cloud Pub/Sub. If multiple configurations match a message, only the - * first matching configuration is used. If you try to publish a device - * telemetry event using MQTT without specifying a Cloud Pub/Sub topic for - * the device's registry, the connection closes automatically. If you - * try to do so using an HTTP connection, an error is returned. Up to 10 - * configurations may be provided. + * The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided. */ eventNotificationConfigs?: Schema$EventNotificationConfig[]; /** @@ -382,9 +279,7 @@ export namespace cloudiot_v1 { */ id?: string; /** - * **Beta Feature** The default logging verbosity for activity from devices - * in this registry. The verbosity level can be overridden by - * Device.log_level. + * **Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level. */ logLevel?: string; /** @@ -392,17 +287,11 @@ export namespace cloudiot_v1 { */ mqttConfig?: Schema$MqttConfig; /** - * The resource path name. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ name?: string; /** - * The configuration for notification of new states received from the - * device. State updates are guaranteed to be stored in the state history, - * but notifications to Cloud Pub/Sub are not guaranteed. For example, if - * permissions are misconfigured or the specified topic doesn't exist, - * no notification will be published but the state will still be stored in - * Cloud IoT Core. + * The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core. */ stateNotificationConfig?: Schema$StateNotificationConfig; } @@ -415,17 +304,12 @@ export namespace cloudiot_v1 { */ binaryData?: string; /** - * [Output only] The time at which this state version was updated in Cloud - * IoT Core. + * [Output only] The time at which this state version was updated in Cloud IoT Core. */ updateTime?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -433,44 +317,32 @@ export namespace cloudiot_v1 { */ export interface Schema$EventNotificationConfig { /** - * A Cloud Pub/Sub topic name. For example, - * `projects/myProject/topics/deviceEvents`. + * A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. */ pubsubTopicName?: string; /** - * If the subfolder name matches this string exactly, this configuration - * will be used. The string must not include the leading '/' - * character. If empty, all strings are matched. This field is used only for - * telemetry events; subfolders are not supported for state changes. + * If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes. */ subfolderMatches?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -479,8 +351,7 @@ export namespace cloudiot_v1 { */ export interface Schema$GatewayConfig { /** - * Indicates how to authorize and/or authenticate devices to access the - * gateway. + * Indicates how to authorize and/or authenticate devices to access the gateway. */ gatewayAuthMethod?: string; /** @@ -492,8 +363,7 @@ export namespace cloudiot_v1 { */ lastAccessedGatewayId?: string; /** - * [Output only] The most recent time at which the device accessed the - * gateway specified in `last_accessed_gateway`. + * [Output only] The most recent time at which the device accessed the gateway specified in `last_accessed_gateway`. */ lastAccessedGatewayTime?: string; } @@ -506,8 +376,7 @@ export namespace cloudiot_v1 { */ export interface Schema$HttpConfig { /** - * If enabled, allows devices to use DeviceService via the HTTP protocol. - * Otherwise, any requests to DeviceService will fail for this registry. + * If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. */ httpEnabledState?: string; } @@ -516,8 +385,7 @@ export namespace cloudiot_v1 { */ export interface Schema$ListDeviceConfigVersionsResponse { /** - * The device configuration for the last few versions. Versions are listed - * in decreasing order, starting from the most recent one. + * The device configuration for the last few versions. Versions are listed in decreasing order, starting from the most recent one. */ deviceConfigs?: Schema$DeviceConfig[]; } @@ -530,9 +398,7 @@ export namespace cloudiot_v1 { */ deviceRegistries?: Schema$DeviceRegistry[]; /** - * If not empty, indicates that there may be more registries that match the - * request; this value should be passed in a new - * `ListDeviceRegistriesRequest`. + * If not empty, indicates that there may be more registries that match the request; this value should be passed in a new `ListDeviceRegistriesRequest`. */ nextPageToken?: string; } @@ -545,8 +411,7 @@ export namespace cloudiot_v1 { */ devices?: Schema$Device[]; /** - * If not empty, indicates that there may be more devices that match the - * request; this value should be passed in a new `ListDevicesRequest`. + * If not empty, indicates that there may be more devices that match the request; this value should be passed in a new `ListDevicesRequest`. */ nextPageToken?: string; } @@ -555,8 +420,7 @@ export namespace cloudiot_v1 { */ export interface Schema$ListDeviceStatesResponse { /** - * The last few device states. States are listed in descending order of - * server update time, starting from the most recent one. + * The last few device states. States are listed in descending order of server update time, starting from the most recent one. */ deviceStates?: Schema$DeviceState[]; } @@ -569,11 +433,7 @@ export namespace cloudiot_v1 { */ binaryData?: string; /** - * The version number to update. If this value is zero, it will not check - * the version number of the server and will always update the current - * version; otherwise, this update will fail if the version number found on - * the server does not match this version number. This is used to support - * multiple simultaneous updates without losing data. + * The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data. */ versionToUpdate?: string; } @@ -582,47 +442,20 @@ export namespace cloudiot_v1 { */ export interface Schema$MqttConfig { /** - * If enabled, allows connections using the MQTT protocol. Otherwise, MQTT - * connections to this registry will fail. + * If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. */ mqttEnabledState?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -678,12 +511,7 @@ export namespace cloudiot_v1 { */ binaryData?: string; /** - * Optional subfolder for the command. If empty, the command will be - * delivered to the /devices/{device-id}/commands topic, otherwise it will - * be delivered to the /devices/{device-id}/commands/{subfolder} topic. - * Multi-level subfolders are allowed. This field must not have more than - * 256 characters, and must not contain any MQTT wildcards ("+" or - * "#") or null characters. + * Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. */ subfolder?: string; } @@ -696,10 +524,7 @@ export namespace cloudiot_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } @@ -708,46 +533,12 @@ export namespace cloudiot_v1 { */ export interface Schema$StateNotificationConfig { /** - * A Cloud Pub/Sub topic name. For example, - * `projects/myProject/topics/deviceEvents`. + * A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. */ pubsubTopicName?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -755,14 +546,11 @@ export namespace cloudiot_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -771,10 +559,7 @@ export namespace cloudiot_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -783,8 +568,7 @@ export namespace cloudiot_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -793,14 +577,11 @@ export namespace cloudiot_v1 { */ export interface Schema$UnbindDeviceFromGatewayRequest { /** - * The device to disassociate from the specified gateway. The value of - * `device_id` can be either the device numeric ID or the user-defined - * device identifier. + * The device to disassociate from the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. */ deviceId?: string; /** - * The value of `gateway_id` can be either the device numeric ID or the - * user-defined device identifier. + * The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. */ gatewayId?: string; } @@ -1171,8 +952,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias cloudiot.projects.locations.registries.getIamPolicy * @memberOf! () * @@ -1403,8 +1183,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias cloudiot.projects.locations.registries.setIamPolicy * @memberOf! () * @@ -1477,9 +1256,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. * @alias cloudiot.projects.locations.registries.testIamPermissions * @memberOf! () * @@ -1652,8 +1429,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the registry. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -1670,8 +1446,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and cloud region where this device registry must be created. - * For example, `projects/example-project/locations/us-central1`. + * The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`. */ parent?: string; @@ -1688,8 +1463,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device registry. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ name?: string; } @@ -1701,8 +1475,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device registry. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ name?: string; } @@ -1714,8 +1487,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1732,21 +1504,15 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of registries to return in the response. If this value - * is zero, the service will select a default size. A call may return fewer - * objects than requested. A non-empty `next_page_token` in the response - * indicates that more data is available. + * The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ pageSize?: number; /** - * The value returned by the last `ListDeviceRegistriesResponse`; indicates - * that this is a continuation of a prior `ListDeviceRegistries` call and - * the system should return the next page of data. + * The value returned by the last `ListDeviceRegistriesResponse`; indicates that this is a continuation of a prior `ListDeviceRegistries` call and the system should return the next page of data. */ pageToken?: string; /** - * The project and cloud region path. For example, - * `projects/example-project/locations/us-central1`. + * The project and cloud region path. For example, `projects/example-project/locations/us-central1`. */ parent?: string; } @@ -1758,16 +1524,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource path name. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ name?: string; /** - * Only updates the `device_registry` fields indicated by this mask. The - * field mask must not be empty, and it must not contain fields that are - * immutable or only set by the server. Mutable top-level fields: - * `event_notification_config`, `http_config`, `mqtt_config`, and - * `state_notification_config`. + * Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`. */ updateMask?: string; @@ -1784,8 +1545,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1802,8 +1562,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1820,8 +1579,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the registry. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -2141,11 +1899,8 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig - * @desc Modifies the configuration for the device, which is eventually sent - * from the Cloud IoT Core servers. Returns the modified configuration - * version and its metadata. - * @alias - * cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig + * @desc Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata. + * @alias cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig * @memberOf! () * * @param {object} params Parameters for request @@ -2292,19 +2047,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.devices.sendCommandToDevice - * @desc Sends a command to the specified device. In order for a device to - * be able to receive commands, it must: 1) be connected to Cloud IoT Core - * using the MQTT protocol, and 2) be subscribed to the group of MQTT topics - * specified by /devices/{device-id}/commands/#. This subscription will - * receive commands at the top-level topic /devices/{device-id}/commands - * as well as commands for subfolders, like - * /devices/{device-id}/commands/subfolder. Note that subscribing to - * specific subfolders is not supported. If the command could not be - * delivered to the device, this method will return an error; in particular, - * if the device is not subscribed, this method will return - * FAILED_PRECONDITION. Otherwise, this method will return OK. If the - * subscription is QoS 1, at least once delivery will be guaranteed; for QoS - * 0, no acknowledgment will be expected from the device. + * @desc Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device. * @alias cloudiot.projects.locations.registries.devices.sendCommandToDevice * @memberOf! () * @@ -2393,9 +2136,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device registry where this device should be created. For - * example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -2412,10 +2153,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; } @@ -2427,15 +2165,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fields of the `Device` resource to be returned in the response. If - * the field mask is unset or empty, all fields are returned. + * The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. */ fieldMask?: string; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; } @@ -2447,57 +2181,39 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of device string IDs. For example, `['device0', 'device12']`. If - * empty, this field is ignored. Maximum IDs: 10,000 + * A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000 */ deviceIds?: string[]; /** - * A list of device numeric IDs. If empty, this field is ignored. Maximum - * IDs: 10,000. + * A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000. */ deviceNumIds?: string[]; /** - * The fields of the `Device` resource to be returned in the response. The - * fields `id` and `num_id` are always returned, along with any other fields - * specified. + * The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified. */ fieldMask?: string; /** - * If set, returns only the gateways with which the specified device is - * associated. The device ID can be numeric (`num_id`) or the user-defined - * string (`id`). For example, if `456` is specified, returns only the - * gateways to which the device with `num_id` 456 is bound. + * If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound. */ 'gatewayListOptions.associationsDeviceId'?: string; /** - * If set, only devices associated with the specified gateway are returned. - * The gateway ID can be numeric (`num_id`) or the user-defined string - * (`id`). For example, if `123` is specified, only devices bound to the - * gateway with `num_id` 123 are returned. + * If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned. */ 'gatewayListOptions.associationsGatewayId'?: string; /** - * If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` - * is specified, only non-gateway devices are returned. If - * `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. + * If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. */ 'gatewayListOptions.gatewayType'?: string; /** - * The maximum number of devices to return in the response. If this value is - * zero, the service will select a default size. A call may return fewer - * objects than requested. A non-empty `next_page_token` in the response - * indicates that more data is available. + * The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ pageSize?: number; /** - * The value returned by the last `ListDevicesResponse`; indicates that this - * is a continuation of a prior `ListDevices` call and the system should - * return the next page of data. + * The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data. */ pageToken?: string; /** - * The device registry path. Required. For example, - * `projects/my-project/locations/us-central1/registries/my-registry`. + * The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. */ parent?: string; } @@ -2509,10 +2225,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; @@ -2529,18 +2242,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource path name. For example, - * `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or - * `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. - * When `name` is populated as a response from the service, it always ends - * in the device numeric ID. + * The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. */ name?: string; /** - * Only updates the `device` fields indicated by this mask. The field mask - * must not be empty, and it must not contain fields that are immutable or - * only set by the server. Mutable top-level fields: `credentials`, - * `blocked`, and `metadata` + * Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` */ updateMask?: string; @@ -2557,10 +2263,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; @@ -2578,8 +2281,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.devices.configVersions.list - * @desc Lists the last few versions of the device configuration in - * descending order (i.e.: newest first). + * @desc Lists the last few versions of the device configuration in descending order (i.e.: newest first). * @alias cloudiot.projects.locations.registries.devices.configVersions.list * @memberOf! () * @@ -2670,16 +2372,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; /** - * The number of versions to list. Versions are listed in decreasing order - * of the version number. The maximum number of versions retained is 10. If - * this value is zero, it will return all the versions available. + * The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available. */ numVersions?: number; } @@ -2692,8 +2389,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.devices.states.list - * @desc Lists the last few versions of the device state in descending order - * (i.e.: newest first). + * @desc Lists the last few versions of the device state in descending order (i.e.: newest first). * @alias cloudiot.projects.locations.registries.devices.states.list * @memberOf! () * @@ -2774,16 +2470,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; /** - * The number of states to list. States are listed in descending order of - * update time. The maximum number of states retained is 10. If this value - * is zero, it will return all the states available. + * The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available. */ numStates?: number; } @@ -2882,8 +2573,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias cloudiot.projects.locations.registries.groups.getIamPolicy * @memberOf! () * @@ -2956,8 +2646,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias cloudiot.projects.locations.registries.groups.setIamPolicy * @memberOf! () * @@ -3030,9 +2719,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. * @alias cloudiot.projects.locations.registries.groups.testIamPermissions * @memberOf! () * @@ -3115,8 +2802,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway * @desc Deletes the association between the device and the gateway. - * @alias - * cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway + * @alias cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway * @memberOf! () * * @param {object} params Parameters for request @@ -3206,8 +2892,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the registry. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -3224,8 +2909,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3242,8 +2926,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3260,8 +2943,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3278,8 +2960,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the registry. For example, - * `projects/example-project/locations/us-central1/registries/my-registry`. + * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -3457,11 +3138,8 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.devices.modifyCloudToDeviceConfig - * @desc Modifies the configuration for the device, which is eventually sent - * from the Cloud IoT Core servers. Returns the modified configuration - * version and its metadata. - * @alias - * cloudiot.projects.locations.registries.groups.devices.modifyCloudToDeviceConfig + * @desc Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata. + * @alias cloudiot.projects.locations.registries.groups.devices.modifyCloudToDeviceConfig * @memberOf! () * * @param {object} params Parameters for request @@ -3608,21 +3286,8 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.devices.sendCommandToDevice - * @desc Sends a command to the specified device. In order for a device to - * be able to receive commands, it must: 1) be connected to Cloud IoT Core - * using the MQTT protocol, and 2) be subscribed to the group of MQTT topics - * specified by /devices/{device-id}/commands/#. This subscription will - * receive commands at the top-level topic /devices/{device-id}/commands - * as well as commands for subfolders, like - * /devices/{device-id}/commands/subfolder. Note that subscribing to - * specific subfolders is not supported. If the command could not be - * delivered to the device, this method will return an error; in particular, - * if the device is not subscribed, this method will return - * FAILED_PRECONDITION. Otherwise, this method will return OK. If the - * subscription is QoS 1, at least once delivery will be guaranteed; for QoS - * 0, no acknowledgment will be expected from the device. - * @alias - * cloudiot.projects.locations.registries.groups.devices.sendCommandToDevice + * @desc Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device. + * @alias cloudiot.projects.locations.registries.groups.devices.sendCommandToDevice * @memberOf! () * * @param {object} params Parameters for request @@ -3710,15 +3375,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fields of the `Device` resource to be returned in the response. If - * the field mask is unset or empty, all fields are returned. + * The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. */ fieldMask?: string; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; } @@ -3730,57 +3391,39 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of device string IDs. For example, `['device0', 'device12']`. If - * empty, this field is ignored. Maximum IDs: 10,000 + * A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000 */ deviceIds?: string[]; /** - * A list of device numeric IDs. If empty, this field is ignored. Maximum - * IDs: 10,000. + * A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000. */ deviceNumIds?: string[]; /** - * The fields of the `Device` resource to be returned in the response. The - * fields `id` and `num_id` are always returned, along with any other fields - * specified. + * The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified. */ fieldMask?: string; /** - * If set, returns only the gateways with which the specified device is - * associated. The device ID can be numeric (`num_id`) or the user-defined - * string (`id`). For example, if `456` is specified, returns only the - * gateways to which the device with `num_id` 456 is bound. + * If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound. */ 'gatewayListOptions.associationsDeviceId'?: string; /** - * If set, only devices associated with the specified gateway are returned. - * The gateway ID can be numeric (`num_id`) or the user-defined string - * (`id`). For example, if `123` is specified, only devices bound to the - * gateway with `num_id` 123 are returned. + * If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned. */ 'gatewayListOptions.associationsGatewayId'?: string; /** - * If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` - * is specified, only non-gateway devices are returned. If - * `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. + * If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. */ 'gatewayListOptions.gatewayType'?: string; /** - * The maximum number of devices to return in the response. If this value is - * zero, the service will select a default size. A call may return fewer - * objects than requested. A non-empty `next_page_token` in the response - * indicates that more data is available. + * The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ pageSize?: number; /** - * The value returned by the last `ListDevicesResponse`; indicates that this - * is a continuation of a prior `ListDevices` call and the system should - * return the next page of data. + * The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data. */ pageToken?: string; /** - * The device registry path. Required. For example, - * `projects/my-project/locations/us-central1/registries/my-registry`. + * The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. */ parent?: string; } @@ -3792,10 +3435,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; @@ -3812,18 +3452,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource path name. For example, - * `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or - * `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. - * When `name` is populated as a response from the service, it always ends - * in the device numeric ID. + * The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. */ name?: string; /** - * Only updates the `device` fields indicated by this mask. The field mask - * must not be empty, and it must not contain fields that are immutable or - * only set by the server. Mutable top-level fields: `credentials`, - * `blocked`, and `metadata` + * Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` */ updateMask?: string; @@ -3840,10 +3473,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; @@ -3861,10 +3491,8 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.devices.configVersions.list - * @desc Lists the last few versions of the device configuration in - * descending order (i.e.: newest first). - * @alias - * cloudiot.projects.locations.registries.groups.devices.configVersions.list + * @desc Lists the last few versions of the device configuration in descending order (i.e.: newest first). + * @alias cloudiot.projects.locations.registries.groups.devices.configVersions.list * @memberOf! () * * @param {object} params Parameters for request @@ -3954,16 +3582,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; /** - * The number of versions to list. Versions are listed in decreasing order - * of the version number. The maximum number of versions retained is 10. If - * this value is zero, it will return all the versions available. + * The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available. */ numVersions?: number; } @@ -3976,8 +3599,7 @@ export namespace cloudiot_v1 { /** * cloudiot.projects.locations.registries.groups.devices.states.list - * @desc Lists the last few versions of the device state in descending order - * (i.e.: newest first). + * @desc Lists the last few versions of the device state in descending order (i.e.: newest first). * @alias cloudiot.projects.locations.registries.groups.devices.states.list * @memberOf! () * @@ -4058,16 +3680,11 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, - * `projects/p0/locations/us-central1/registries/registry0/devices/device0` - * or - * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; /** - * The number of states to list. States are listed in descending order of - * update time. The maximum number of states retained is 10. If this value - * is zero, it will return all the states available. + * The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available. */ numStates?: number; } diff --git a/src/apis/cloudkms/package.json b/src/apis/cloudkms/package.json index c9e478a6042..efb0a670e53 100644 --- a/src/apis/cloudkms/package.json +++ b/src/apis/cloudkms/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index f34212ebf68..6a9bf894321 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudkms_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudkms_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudkms_v1 { /** * Cloud Key Management Service (KMS) API * - * Manages keys and performs cryptographic operations in a central cloud - * service, for direct use by other cloud resources and applications. + * Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace cloudkms_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,8 +122,7 @@ export namespace cloudkms_v1 { */ export interface Schema$AsymmetricDecryptRequest { /** - * Required. The data encrypted with the named CryptoKeyVersion's public - * key using OAEP. + * Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP. */ ciphertext?: string; } @@ -143,9 +140,7 @@ export namespace cloudkms_v1 { */ export interface Schema$AsymmetricSignRequest { /** - * Required. The digest of the data to sign. The digest must be produced - * with the same digest algorithm as specified by the key version's - * algorithm. + * Required. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm. */ digest?: Schema$Digest; } @@ -159,27 +154,7 @@ export namespace cloudkms_v1 { signature?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -187,25 +162,16 @@ export namespace cloudkms_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -218,37 +184,20 @@ export namespace cloudkms_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A CryptoKey represents a logical key that can be used for cryptographic - * operations. A CryptoKey is made up of one or more versions, which - * represent the actual key material used in cryptographic operations. + * A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of one or more versions, which represent the actual key material used in cryptographic operations. */ export interface Schema$CryptoKey { /** @@ -256,30 +205,19 @@ export namespace cloudkms_v1 { */ createTime?: string; /** - * Labels with user-defined metadata. For more information, see [Labeling - * Keys](/kms/docs/labeling-keys). + * Labels with user-defined metadata. For more information, see [Labeling Keys](/kms/docs/labeling-keys). */ labels?: {[key: string]: string}; /** - * Output only. The resource name for this CryptoKey in the format - * `projects/x/locations/x/keyRings/x/cryptoKeys/x. + * Output only. The resource name for this CryptoKey in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x. */ name?: string; /** - * At next_rotation_time, the Key Management Service will automatically: 1. - * Create a new version of this CryptoKey. 2. Mark the new version as - * primary. Key rotations performed manually via CreateCryptoKeyVersion and - * UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys - * with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, - * this field must be omitted. + * At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. */ nextRotationTime?: string; /** - * Output only. A copy of the "primary" CryptoKeyVersion that will - * be used by Encrypt when this CryptoKey is given in EncryptRequest.name. - * The CryptoKey's primary version can be updated via - * UpdateCryptoKeyPrimaryVersion. All keys with purpose ENCRYPT_DECRYPT - * have a primary. For other keys, this field will be omitted. + * Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. All keys with purpose ENCRYPT_DECRYPT have a primary. For other keys, this field will be omitted. */ primary?: Schema$CryptoKeyVersion; /** @@ -287,39 +225,24 @@ export namespace cloudkms_v1 { */ purpose?: string; /** - * next_rotation_time will be advanced by this period when the service - * automatically rotates a key. Must be at least one day. If - * rotation_period is set, next_rotation_time must also be set. Keys with - * purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this - * field must be omitted. + * next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least one day. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. */ rotationPeriod?: string; /** - * A template describing settings for new CryptoKeyVersion instances. The - * properties of new CryptoKeyVersion instances created by either - * CreateCryptoKeyVersion or auto-rotation are controlled by this template. + * A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template. */ versionTemplate?: Schema$CryptoKeyVersionTemplate; } /** - * A CryptoKeyVersion represents an individual cryptographic key, and the - * associated key material. An ENABLED version can be used for cryptographic - * operations. For security reasons, the raw cryptographic key material - * represented by a CryptoKeyVersion can never be viewed or exported. It can - * only be used to encrypt, decrypt, or sign data when an authorized user or - * application invokes Cloud KMS. + * A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS. */ export interface Schema$CryptoKeyVersion { /** - * Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion - * supports. + * Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. */ algorithm?: string; /** - * Output only. Statement that was generated and signed by the HSM at key - * creation time. Use this statement to verify attributes of the key as - * stored on the HSM, independently of Google. Only provided for key - * versions with protection_level HSM. + * Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM. */ attestation?: Schema$KeyOperationAttestation; /** @@ -327,28 +250,23 @@ export namespace cloudkms_v1 { */ createTime?: string; /** - * Output only. The time this CryptoKeyVersion's key material was - * destroyed. Only present if state is DESTROYED. + * Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. */ destroyEventTime?: string; /** - * Output only. The time this CryptoKeyVersion's key material is - * scheduled for destruction. Only present if state is DESTROY_SCHEDULED. + * Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. */ destroyTime?: string; /** - * Output only. The time this CryptoKeyVersion's key material was - * generated. + * Output only. The time this CryptoKeyVersion's key material was generated. */ generateTime?: string; /** - * Output only. The resource name for this CryptoKeyVersion in the format - * `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x. + * Output only. The resource name for this CryptoKeyVersion in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x. */ name?: string; /** - * Output only. The ProtectionLevel describing how crypto operations are - * performed with this CryptoKeyVersion. + * Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. */ protectionLevel?: string; /** @@ -357,21 +275,15 @@ export namespace cloudkms_v1 { state?: string; } /** - * A CryptoKeyVersionTemplate specifies the properties to use when creating a - * new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or - * automatically as a result of auto-rotation. + * A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. */ export interface Schema$CryptoKeyVersionTemplate { /** - * Required. Algorithm to use when creating a CryptoKeyVersion based on this - * template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is - * implied if both this field is omitted and CryptoKey.purpose is - * ENCRYPT_DECRYPT. + * Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT. */ algorithm?: string; /** - * ProtectionLevel to use when creating a CryptoKeyVersion based on this - * template. Immutable. Defaults to SOFTWARE. + * ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE. */ protectionLevel?: string; } @@ -380,13 +292,11 @@ export namespace cloudkms_v1 { */ export interface Schema$DecryptRequest { /** - * Optional data that must match the data originally supplied in - * EncryptRequest.additional_authenticated_data. + * Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data. */ additionalAuthenticatedData?: string; /** - * Required. The encrypted data originally returned in - * EncryptResponse.ciphertext. + * Required. The encrypted data originally returned in EncryptResponse.ciphertext. */ ciphertext?: string; } @@ -425,20 +335,11 @@ export namespace cloudkms_v1 { */ export interface Schema$EncryptRequest { /** - * Optional data that, if specified, must also be provided during decryption - * through DecryptRequest.additional_authenticated_data. The maximum size - * depends on the key version's protection_level. For SOFTWARE keys, the - * AAD must be no larger than 64KiB. For HSM keys, the combined length of - * the plaintext and additional_authenticated_data fields must be no larger - * than 8KiB. + * Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. */ additionalAuthenticatedData?: string; /** - * Required. The data to encrypt. Must be no larger than 64KiB. The maximum - * size depends on the key version's protection_level. For SOFTWARE - * keys, the plaintext must be no larger than 64KiB. For HSM keys, the - * combined length of the plaintext and additional_authenticated_data fields - * must be no larger than 8KiB. + * Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. */ plaintext?: string; } @@ -456,43 +357,32 @@ export namespace cloudkms_v1 { name?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Contains an HSM-generated attestation about a key operation. For more - * information, see [Verifying attestations] - * (https://cloud.google.com/kms/docs/attest-key). + * Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). */ export interface Schema$KeyOperationAttestation { /** - * Output only. The attestation data provided by the HSM when the key - * operation was performed. + * Output only. The attestation data provided by the HSM when the key operation was performed. */ content?: string; /** @@ -509,8 +399,7 @@ export namespace cloudkms_v1 { */ createTime?: string; /** - * Output only. The resource name for the KeyRing in the format - * `projects/x/locations/x/keyRings/x. + * Output only. The resource name for the KeyRing in the format `projects/x/locations/x/keyRings/x. */ name?: string; } @@ -523,8 +412,7 @@ export namespace cloudkms_v1 { */ cryptoKeys?: Schema$CryptoKey[]; /** - * A token to retrieve next page of results. Pass this value in - * ListCryptoKeysRequest.page_token to retrieve the next page of results. + * A token to retrieve next page of results. Pass this value in ListCryptoKeysRequest.page_token to retrieve the next page of results. */ nextPageToken?: string; /** @@ -541,9 +429,7 @@ export namespace cloudkms_v1 { */ cryptoKeyVersions?: Schema$CryptoKeyVersion[]; /** - * A token to retrieve next page of results. Pass this value in - * ListCryptoKeyVersionsRequest.page_token to retrieve the next page of - * results. + * A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results. */ nextPageToken?: string; /** @@ -560,8 +446,7 @@ export namespace cloudkms_v1 { */ keyRings?: Schema$KeyRing[]; /** - * A token to retrieve next page of results. Pass this value in - * ListKeyRingsRequest.page_token to retrieve the next page of results. + * A token to retrieve next page of results. Pass this value in ListKeyRingsRequest.page_token to retrieve the next page of results. */ nextPageToken?: string; /** @@ -587,13 +472,11 @@ export namespace cloudkms_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -601,13 +484,11 @@ export namespace cloudkms_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -616,30 +497,12 @@ export namespace cloudkms_v1 { */ export interface Schema$LocationMetadata { /** - * Indicates whether CryptoKeys with protection_level HSM can be created in - * this location. + * Indicates whether CryptoKeys with protection_level HSM can be created in this location. */ hsmAvailable?: boolean; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -647,20 +510,11 @@ export namespace cloudkms_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -677,11 +531,7 @@ export namespace cloudkms_v1 { */ algorithm?: string; /** - * The public key, encoded in PEM format. For more information, see the [RFC - * 7468](https://tools.ietf.org/html/rfc7468) sections for [General - * Considerations](https://tools.ietf.org/html/rfc7468#section-2) and - * [Textual Encoding of Subject Public Key Info] - * (https://tools.ietf.org/html/rfc7468#section-13). + * The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). */ pem?: string; } @@ -694,17 +544,11 @@ export namespace cloudkms_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -713,10 +557,7 @@ export namespace cloudkms_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -725,8 +566,7 @@ export namespace cloudkms_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1102,8 +942,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias cloudkms.projects.locations.keyRings.getIamPolicy * @memberOf! () * @@ -1253,8 +1092,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias cloudkms.projects.locations.keyRings.setIamPolicy * @memberOf! () * @@ -1327,11 +1165,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias cloudkms.projects.locations.keyRings.testIamPermissions * @memberOf! () * @@ -1420,13 +1254,11 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. It must be unique within a location and match the regular - * expression `[a-zA-Z0-9_-]{1,63}` + * Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` */ keyRingId?: string; /** - * Required. The resource name of the location associated with the KeyRings, - * in the format `projects/x/locations/x`. + * Required. The resource name of the location associated with the KeyRings, in the format `projects/x/locations/x`. */ parent?: string; @@ -1455,8 +1287,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1468,20 +1299,15 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional limit on the number of KeyRings to include in the response. - * Further KeyRings can subsequently be obtained by including the - * ListKeyRingsResponse.next_page_token in a subsequent request. If - * unspecified, the server will pick an appropriate default. + * Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional pagination token, returned earlier via - * ListKeyRingsResponse.next_page_token. + * Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. */ pageToken?: string; /** - * Required. The resource name of the location associated with the KeyRings, - * in the format `projects/x/locations/x`. + * Required. The resource name of the location associated with the KeyRings, in the format `projects/x/locations/x`. */ parent?: string; } @@ -1493,8 +1319,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1511,8 +1336,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1534,8 +1358,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.create - * @desc Create a new CryptoKey within a KeyRing. CryptoKey.purpose and - * CryptoKey.version_template.algorithm are required. + * @desc Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required. * @alias cloudkms.projects.locations.keyRings.cryptoKeys.create * @memberOf! () * @@ -1611,8 +1434,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.decrypt - * @desc Decrypts data that was protected by Encrypt. The CryptoKey.purpose - * must be ENCRYPT_DECRYPT. + * @desc Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. * @alias cloudkms.projects.locations.keyRings.cryptoKeys.decrypt * @memberOf! () * @@ -1687,8 +1509,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.encrypt - * @desc Encrypts data, so that it can only be recovered by a call to - * Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. + * @desc Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. * @alias cloudkms.projects.locations.keyRings.cryptoKeys.encrypt * @memberOf! () * @@ -1763,8 +1584,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.get - * @desc Returns metadata for a given CryptoKey, as well as its primary - * CryptoKeyVersion. + * @desc Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion. * @alias cloudkms.projects.locations.keyRings.cryptoKeys.get * @memberOf! () * @@ -1835,8 +1655,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy * @memberOf! () * @@ -2060,8 +1879,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy * @memberOf! () * @@ -2134,11 +1952,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions * @memberOf! () * @@ -2220,10 +2034,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion - * @desc Update the version of a CryptoKey that will be used in Encrypt. - * Returns an error if called on an asymmetric key. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion + * @desc Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on an asymmetric key. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion * @memberOf! () * * @param {object} params Parameters for request @@ -2306,8 +2118,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. It must be unique within a KeyRing and match the regular - * expression `[a-zA-Z0-9_-]{1,63}` + * Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` */ cryptoKeyId?: string; /** @@ -2328,8 +2139,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the CryptoKey to use for decryption. The - * server will choose the appropriate version. + * Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version. */ name?: string; @@ -2346,9 +2156,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the CryptoKey or CryptoKeyVersion to use - * for encryption. If a CryptoKey is specified, the server will use its - * primary version. + * Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version. */ name?: string; @@ -2377,8 +2185,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2390,20 +2197,15 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional limit on the number of CryptoKeys to include in the response. - * Further CryptoKeys can subsequently be obtained by including the - * ListCryptoKeysResponse.next_page_token in a subsequent request. If - * unspecified, the server will pick an appropriate default. + * Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional pagination token, returned earlier via - * ListCryptoKeysResponse.next_page_token. + * Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. */ pageToken?: string; /** - * Required. The resource name of the KeyRing to list, in the format - * `projects/x/locations/x/keyRings/x`. + * Required. The resource name of the KeyRing to list, in the format `projects/x/locations/x/keyRings/x`. */ parent?: string; /** @@ -2419,8 +2221,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name for this CryptoKey in the format - * `projects/x/locations/x/keyRings/x/cryptoKeys/x`. + * Output only. The resource name for this CryptoKey in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x`. */ name?: string; /** @@ -2441,8 +2242,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2459,8 +2259,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2495,11 +2294,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricDecrypt - * @desc Decrypts data that was encrypted with a public key retrieved from - * GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose - * ASYMMETRIC_DECRYPT. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricDecrypt + * @desc Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricDecrypt * @memberOf! () * * @param {object} params Parameters for request @@ -2580,11 +2376,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricSign - * @desc Signs data using a CryptoKeyVersion with CryptoKey.purpose - * ASYMMETRIC_SIGN, producing a signature that can be verified with the - * public key retrieved from GetPublicKey. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricSign + * @desc Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricSign * @memberOf! () * * @param {object} params Parameters for request @@ -2662,10 +2455,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create - * @desc Create a new CryptoKeyVersion in a CryptoKey. The server will - * assign the next sequential id. If unset, state will be set to ENABLED. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create + * @desc Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create * @memberOf! () * * @param {object} params Parameters for request @@ -2739,14 +2530,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy - * @desc Schedule a CryptoKeyVersion for destruction. Upon calling this - * method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED and - * destroy_time will be set to a time 24 hours in the future, at which point - * the state will be changed to DESTROYED, and the key material will be - * irrevocably destroyed. Before the destroy_time is reached, - * RestoreCryptoKeyVersion may be called to reverse the process. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy + * @desc Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED and destroy_time will be set to a time 24 hours in the future, at which point the state will be changed to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy * @memberOf! () * * @param {object} params Parameters for request @@ -2821,8 +2606,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get * @desc Returns metadata for a given CryptoKeyVersion. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get * @memberOf! () * * @param {object} params Parameters for request @@ -2892,10 +2676,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.getPublicKey - * @desc Returns the public key for the given CryptoKeyVersion. The - * CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.getPublicKey + * @desc Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.getPublicKey * @memberOf! () * * @param {object} params Parameters for request @@ -2969,8 +2751,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list * @desc Lists CryptoKeyVersions. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list * @memberOf! () * * @param {object} params Parameters for request @@ -3055,11 +2836,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch - * @desc Update a CryptoKeyVersion's metadata. state may be changed between - * ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and - * RestoreCryptoKeyVersion to move between other states. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch + * @desc Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch * @memberOf! () * * @param {object} params Parameters for request @@ -3131,11 +2909,8 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore - * @desc Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon - * restoration of the CryptoKeyVersion, state will be set to DISABLED, and - * destroy_time will be cleared. - * @alias - * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore + * @desc Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore * @memberOf! () * * @param {object} params Parameters for request @@ -3216,8 +2991,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the CryptoKeyVersion to use for - * decryption. + * Required. The resource name of the CryptoKeyVersion to use for decryption. */ name?: string; @@ -3251,8 +3025,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the CryptoKey associated with the - * CryptoKeyVersions. + * Required. The name of the CryptoKey associated with the CryptoKeyVersions. */ parent?: string; @@ -3310,21 +3083,15 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional limit on the number of CryptoKeyVersions to include in the - * response. Further CryptoKeyVersions can subsequently be obtained by - * including the ListCryptoKeyVersionsResponse.next_page_token in a - * subsequent request. If unspecified, the server will pick an appropriate - * default. + * Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional pagination token, returned earlier via - * ListCryptoKeyVersionsResponse.next_page_token. + * Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. */ pageToken?: string; /** - * Required. The resource name of the CryptoKey to list, in the format - * `projects/x/locations/x/keyRings/x/cryptoKeys/x`. + * Required. The resource name of the CryptoKey to list, in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x`. */ parent?: string; /** @@ -3340,8 +3107,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name for this CryptoKeyVersion in the format - * `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x`. + * Output only. The resource name for this CryptoKeyVersion in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x`. */ name?: string; /** @@ -3380,8 +3146,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.importJobs.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias cloudkms.projects.locations.keyRings.importJobs.getIamPolicy * @memberOf! () * @@ -3453,8 +3218,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.importJobs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias cloudkms.projects.locations.keyRings.importJobs.setIamPolicy * @memberOf! () * @@ -3527,11 +3291,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.importJobs.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias cloudkms.projects.locations.keyRings.importJobs.testIamPermissions * @memberOf! () * @@ -3620,8 +3380,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -3633,8 +3392,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3651,8 +3409,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/cloudprivatecatalog/package.json b/src/apis/cloudprivatecatalog/package.json index 8b5cb70b71f..acbe2357442 100644 --- a/src/apis/cloudprivatecatalog/package.json +++ b/src/apis/cloudprivatecatalog/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudprivatecatalog/v1beta1.ts b/src/apis/cloudprivatecatalog/v1beta1.ts index fd42c7c50be..c4afb558942 100644 --- a/src/apis/cloudprivatecatalog/v1beta1.ts +++ b/src/apis/cloudprivatecatalog/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * Cloud Private Catalog API * - * Enable cloud users to discover enterprise catalogs and products in their - * organizations. + * Enable cloud users to discover enterprise catalogs and products in their organizations. * * @example * const {google} = require('googleapis'); @@ -115,7 +110,10 @@ export namespace cloudprivatecatalog_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.folders = new Resource$Folders(this.context); this.organizations = new Resource$Organizations(this.context); @@ -124,8 +122,7 @@ export namespace cloudprivatecatalog_v1beta1 { } /** - * The readonly representation of a catalog computed with a given resource - * context. + * The readonly representation of a catalog computed with a given resource context. */ export interface Schema$GoogleCloudPrivatecatalogV1beta1Catalog { /** @@ -141,8 +138,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ displayName?: string; /** - * Output only. The resource name of the target catalog, in the format of - * `catalogs/{catalog_id}'. + * Output only. The resource name of the target catalog, in the format of `catalogs/{catalog_id}'. */ name?: string; /** @@ -151,14 +147,11 @@ export namespace cloudprivatecatalog_v1beta1 { updateTime?: string; } /** - * The readonly representation of a product computed with a given resource - * context. + * The readonly representation of a product computed with a given resource context. */ export interface Schema$GoogleCloudPrivatecatalogV1beta1Product { /** - * Output only. The type of the product asset. It can be one of the - * following values: * `google.deploymentmanager.Template` * - * `google.cloudprivatecatalog.ListingOnly` + * Output only. The type of the product asset. It can be one of the following values: * `google.deploymentmanager.Template` * `google.cloudprivatecatalog.ListingOnly` */ assetType?: string; /** @@ -166,38 +159,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ createTime?: string; /** - * Output only. The display metadata to describe the product. The JSON - * schema of the metadata differs by Product.asset_type. When the type is - * `google.deploymentmanager.Template`, the schema is as follows: ``` - * "$schema": http://json-schema.org/draft-04/schema# type: object - * properties: name: type: string minLength: 1 maxLength: 64 - * description: type: string minLength: 1 maxLength: 2048 - * tagline: type: string minLength: 1 maxLength: 100 - * support_info: type: string minLength: 1 maxLength: 2048 - * creator: type: string minLength: 1 maxLength: 100 - * documentation: type: array items: type: object properties: - * url: type: string pattern: - * "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - * title: type: string minLength: 1 maxLength: - * 64 description: type: string minLength: 1 - * maxLength: 2048 required: - name - description additionalProperties: - * false ``` When the asset type is - * `google.cloudprivatecatalog.ListingOnly`, the schema is as follows: ``` - * "$schema": http://json-schema.org/draft-04/schema# type: object - * properties: name: type: string minLength: 1 maxLength: 64 - * description: type: string minLength: 1 maxLength: 2048 - * tagline: type: string minLength: 1 maxLength: 100 - * support_info: type: string minLength: 1 maxLength: 2048 - * creator: type: string minLength: 1 maxLength: 100 - * documentation: type: array items: type: object properties: - * url: type: string pattern: - * "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - * title: type: string minLength: 1 maxLength: - * 64 description: type: string minLength: 1 - * maxLength: 2048 signup_url: type: string pattern: - * "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - * required: - name - description - signup_url additionalProperties: false - * ``` + * Output only. The display metadata to describe the product. The JSON schema of the metadata differs by Product.asset_type. When the type is `google.deploymentmanager.Template`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 required: - name - description additionalProperties: false ``` When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 signup_url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" required: - name - description - signup_url additionalProperties: false ``` */ displayMetadata?: {[key: string]: any}; /** @@ -205,9 +167,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ iconUri?: string; /** - * Output only. The resource name of the target product, in the format of - * `products/a-z*[a-z0-9]'. A unique identifier for the product under a - * catalog. + * Output only. The resource name of the target product, in the format of `products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog. */ name?: string; /** @@ -224,8 +184,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ catalogs?: Schema$GoogleCloudPrivatecatalogV1beta1Catalog[]; /** - * A pagination token returned from a previous call to SearchCatalogs that - * indicates from where listing should continue. This field is optional. + * A pagination token returned from a previous call to SearchCatalogs that indicates from where listing should continue. This field is optional. */ nextPageToken?: string; } @@ -234,8 +193,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ export interface Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse { /** - * A pagination token returned from a previous call to SearchProducts that - * indicates from where listing should continue. This field is optional. + * A pagination token returned from a previous call to SearchProducts that indicates from where listing should continue. This field is optional. */ nextPageToken?: string; /** @@ -248,8 +206,7 @@ export namespace cloudprivatecatalog_v1beta1 { */ export interface Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse { /** - * A pagination token returned from a previous call to SearchVersions that - * indicates from where the listing should continue. This field is optional. + * A pagination token returned from a previous call to SearchVersions that indicates from where the listing should continue. This field is optional. */ nextPageToken?: string; /** @@ -258,14 +215,11 @@ export namespace cloudprivatecatalog_v1beta1 { versions?: Schema$GoogleCloudPrivatecatalogV1beta1Version[]; } /** - * The consumer representation of a version which is a child resource under a - * `Product` with asset data. + * The consumer representation of a version which is a child resource under a `Product` with asset data. */ export interface Schema$GoogleCloudPrivatecatalogV1beta1Version { /** - * Output only. The asset which has been validated and is ready to be - * provisioned. See google.cloud.privatecatalogproducer.v1beta.Version.asset - * for details. + * Output only. The asset which has been validated and is ready to be provisioned. See google.cloud.privatecatalogproducer.v1beta.Version.asset for details. */ asset?: {[key: string]: any}; /** @@ -273,14 +227,11 @@ export namespace cloudprivatecatalog_v1beta1 { */ createTime?: string; /** - * Output only. The user-supplied description of the version. Maximum of 256 - * characters. + * Output only. The user-supplied description of the version. Maximum of 256 characters. */ description?: string; /** - * Output only. The resource name of the version, in the format - * `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. - * A unique identifier for the version under a product. + * Output only. The resource name of the version, in the format `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A unique identifier for the version under a product. */ name?: string; /** @@ -310,8 +261,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.folders.catalogs.search - * @desc Search Catalog resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.folders.catalogs.search * @memberOf! () * @@ -426,20 +376,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchCatalogs that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the catalogs. The supported queries are: * Get a - * single catalog: `name=catalogs/{catalog_id}` + * The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}` */ query?: string; /** - * Required. The name of the resource context. It can be in following - * formats: * `projects/{project_id}` * `folders/{folder_id}` * - * `organizations/{organization_id}` + * Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` */ resource?: string; } @@ -452,8 +397,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.folders.products.search - * @desc Search Product resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.folders.products.search * @memberOf! () * @@ -568,21 +512,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchProducts that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the products. The supported queries are: * List - * products of all catalogs: empty * List products under a catalog: - * `parent=catalogs/{catalog_id}` * Get a product by name: - * `name=catalogs/{catalog_id}/products/{product_id}` + * The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}` */ query?: string; /** - * Required. The name of the resource context. See - * SearchCatalogsRequest.resource for details. + * Required. The name of the resource context. See SearchCatalogsRequest.resource for details. */ resource?: string; } @@ -595,8 +533,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.folders.versions.search - * @desc Search Version resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.folders.versions.search * @memberOf! () * @@ -711,22 +648,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchVersions that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the versions. Required. The supported queries are: * - * List versions under a product: - * `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by - * name: - * `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}` + * The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}` */ query?: string; /** - * Required. The name of the resource context. See - * SearchCatalogsRequest.resource for details. + * Required. The name of the resource context. See SearchCatalogsRequest.resource for details. */ resource?: string; } @@ -752,8 +682,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.organizations.catalogs.search - * @desc Search Catalog resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.organizations.catalogs.search * @memberOf! () * @@ -868,20 +797,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchCatalogs that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the catalogs. The supported queries are: * Get a - * single catalog: `name=catalogs/{catalog_id}` + * The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}` */ query?: string; /** - * Required. The name of the resource context. It can be in following - * formats: * `projects/{project_id}` * `folders/{folder_id}` * - * `organizations/{organization_id}` + * Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` */ resource?: string; } @@ -894,8 +818,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.organizations.products.search - * @desc Search Product resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.organizations.products.search * @memberOf! () * @@ -1010,21 +933,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchProducts that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the products. The supported queries are: * List - * products of all catalogs: empty * List products under a catalog: - * `parent=catalogs/{catalog_id}` * Get a product by name: - * `name=catalogs/{catalog_id}/products/{product_id}` + * The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}` */ query?: string; /** - * Required. The name of the resource context. See - * SearchCatalogsRequest.resource for details. + * Required. The name of the resource context. See SearchCatalogsRequest.resource for details. */ resource?: string; } @@ -1037,8 +954,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.organizations.versions.search - * @desc Search Version resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.organizations.versions.search * @memberOf! () * @@ -1153,22 +1069,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchVersions that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the versions. Required. The supported queries are: * - * List versions under a product: - * `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by - * name: - * `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}` + * The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}` */ query?: string; /** - * Required. The name of the resource context. See - * SearchCatalogsRequest.resource for details. + * Required. The name of the resource context. See SearchCatalogsRequest.resource for details. */ resource?: string; } @@ -1194,8 +1103,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.projects.catalogs.search - * @desc Search Catalog resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.projects.catalogs.search * @memberOf! () * @@ -1310,20 +1218,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchCatalogs that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the catalogs. The supported queries are: * Get a - * single catalog: `name=catalogs/{catalog_id}` + * The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}` */ query?: string; /** - * Required. The name of the resource context. It can be in following - * formats: * `projects/{project_id}` * `folders/{folder_id}` * - * `organizations/{organization_id}` + * Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` */ resource?: string; } @@ -1336,8 +1239,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.projects.products.search - * @desc Search Product resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.projects.products.search * @memberOf! () * @@ -1452,21 +1354,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchProducts that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the products. The supported queries are: * List - * products of all catalogs: empty * List products under a catalog: - * `parent=catalogs/{catalog_id}` * Get a product by name: - * `name=catalogs/{catalog_id}/products/{product_id}` + * The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}` */ query?: string; /** - * Required. The name of the resource context. See - * SearchCatalogsRequest.resource for details. + * Required. The name of the resource context. See SearchCatalogsRequest.resource for details. */ resource?: string; } @@ -1479,8 +1375,7 @@ export namespace cloudprivatecatalog_v1beta1 { /** * cloudprivatecatalog.projects.versions.search - * @desc Search Version resources that consumers have access to, within the - * scope of the consumer cloud resource hierarchy context. + * @desc Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context. * @alias cloudprivatecatalog.projects.versions.search * @memberOf! () * @@ -1595,22 +1490,15 @@ export namespace cloudprivatecatalog_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to SearchVersions that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The query to filter the versions. Required. The supported queries are: * - * List versions under a product: - * `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by - * name: - * `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}` + * The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}` */ query?: string; /** - * Required. The name of the resource context. See - * SearchCatalogsRequest.resource for details. + * Required. The name of the resource context. See SearchCatalogsRequest.resource for details. */ resource?: string; } diff --git a/src/apis/cloudprivatecatalogproducer/package.json b/src/apis/cloudprivatecatalogproducer/package.json index f3fc5d507b4..135951fd5b1 100644 --- a/src/apis/cloudprivatecatalogproducer/package.json +++ b/src/apis/cloudprivatecatalogproducer/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudprivatecatalogproducer/v1beta1.ts b/src/apis/cloudprivatecatalogproducer/v1beta1.ts index b7a944fb6ed..37f0525c4dc 100644 --- a/src/apis/cloudprivatecatalogproducer/v1beta1.ts +++ b/src/apis/cloudprivatecatalogproducer/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,13 +91,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * Cloud Private Catalog Producer API * - * Enables cloud users to manage and share enterprise catalogs intheir - * organizations. + * Enables cloud users to manage and share enterprise catalogs intheir organizations. * * @example * const {google} = require('googleapis'); - * const cloudprivatecatalogproducer = - * google.cloudprivatecatalogproducer('v1beta1'); + * const cloudprivatecatalogproducer = google.cloudprivatecatalogproducer('v1beta1'); * * @namespace cloudprivatecatalogproducer * @type {Function} @@ -115,7 +109,10 @@ export namespace cloudprivatecatalogproducer_v1beta1 { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.catalogs = new Resource$Catalogs(this.context); this.operations = new Resource$Operations(this.context); @@ -123,18 +120,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { } /** - * An association tuple that pairs a `Catalog` to a resource that can use the - * `Catalog`. After association, a google.cloud.privatecatalog.v1beta1.Catalog - * becomes available to consumers under specified Association.resource and all - * of its child nodes. Users who have the `cloudprivatecatalog.targets.get` - * permission on any of the resource nodes can access the catalog and child - * products under the node. For example, suppose the cloud resource hierarchy - * is as follows: * organizations/example.com * folders/team * - * projects/test After creating an association with - * `organizations/example.com`, the catalog `catalogs/1` is accessible from - * the following paths: * organizations/example.com * folders/team * - * projects/test Users can access them by - * google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action. + * An association tuple that pairs a `Catalog` to a resource that can use the `Catalog`. After association, a google.cloud.privatecatalog.v1beta1.Catalog becomes available to consumers under specified Association.resource and all of its child nodes. Users who have the `cloudprivatecatalog.targets.get` permission on any of the resource nodes can access the catalog and child products under the node. For example, suppose the cloud resource hierarchy is as follows: * organizations/example.com * folders/team * projects/test After creating an association with `organizations/example.com`, the catalog `catalogs/1` is accessible from the following paths: * organizations/example.com * folders/team * projects/test Users can access them by google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action. */ export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1Association { /** @@ -142,25 +128,16 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ createTime?: string; /** - * Output only. The resource name of the catalog association, in the format - * `catalogs/{catalog_id}/associations/{association_id}'. A unique - * identifier for the catalog association, which is generated by catalog - * service. + * Output only. The resource name of the catalog association, in the format `catalogs/{catalog_id}/associations/{association_id}'. A unique identifier for the catalog association, which is generated by catalog service. */ name?: string; /** - * Required. The user-supplied fully qualified name of the `Resource` - * associated to the `Catalog`. It supports `Organization`, `Folder`, and - * `Project`. Values are of the form * - * `//cloudresourcemanager.googleapis.com/projects/{product_number}` * - * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * - * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}` + * Required. The user-supplied fully qualified name of the `Resource` associated to the `Catalog`. It supports `Organization`, `Folder`, and `Project`. Values are of the form * `//cloudresourcemanager.googleapis.com/projects/{product_number}` * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}` */ resource?: string; } /** - * The producer representation of a catalog which is a curated collection of - * solutions that can be managed, controlled, and shared by cloud admins. + * The producer representation of a catalog which is a curated collection of solutions that can be managed, controlled, and shared by cloud admins. */ export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1Catalog { /** @@ -168,27 +145,19 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ createTime?: string; /** - * Required. The user-supplied description of the catalog. Maximum of 512 - * characters. + * Required. The user-supplied description of the catalog. Maximum of 512 characters. */ description?: string; /** - * Required. The user-supplied descriptive name of the catalog as it appears - * in UIs. Maximum 256 characters in length. + * Required. The user-supplied descriptive name of the catalog as it appears in UIs. Maximum 256 characters in length. */ displayName?: string; /** - * Output only. The resource name of the catalog, in the format - * `catalogs/{catalog_id}'. A unique identifier for the catalog, which - * is generated by catalog service. + * Output only. The resource name of the catalog, in the format `catalogs/{catalog_id}'. A unique identifier for the catalog, which is generated by catalog service. */ name?: string; /** - * Required. The parent resource name of the catalog, which can't be - * changed after a catalog is created. It can only be an organization. - * Values are of the form - * `//cloudresourcemanager.googleapis.com/organizations/<id>`. Maximum - * 256 characters in length. + * Required. The parent resource name of the catalog, which can't be changed after a catalog is created. It can only be an organization. Values are of the form `//cloudresourcemanager.googleapis.com/organizations/<id>`. Maximum 256 characters in length. */ parent?: string; /** @@ -204,10 +173,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest { /** - * The user-supplied `Association` that is going to be created. If the - * `resource` field is set, the - * `privatecatalogproducer.catalogTargets.associate` permission is checked - * on the target resource. + * The user-supplied `Association` that is going to be created. If the `resource` field is set, the `privatecatalogproducer.catalogTargets.associate` permission is checked on the target resource. */ association?: Schema$GoogleCloudPrivatecatalogproducerV1beta1Association; } @@ -217,9 +183,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ associations?: Schema$GoogleCloudPrivatecatalogproducerV1beta1Association[]; /** - * A pagination token returned from a previous call to `ListAssociations` - * that indicates where the listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to `ListAssociations` that indicates where the listing should continue from. This field is optional. */ nextPageToken?: string; } @@ -229,15 +193,13 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ catalogs?: Schema$GoogleCloudPrivatecatalogproducerV1beta1Catalog[]; /** - * A pagination token returned from a previous call to ListCatalogs that - * indicates where the listing should continue from. This field is optional. + * A pagination token returned from a previous call to ListCatalogs that indicates where the listing should continue from. This field is optional. */ nextPageToken?: string; } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse { /** - * A pagination token returned from a previous call to ListProducts that - * indicates where the listing should continue from. This field is optional. + * A pagination token returned from a previous call to ListProducts that indicates where the listing should continue from. This field is optional. */ nextPageToken?: string; /** @@ -247,8 +209,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { } export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse { /** - * A pagination token returned from a previous call to ListProducts that - * indicates where the listing should continue from. This field is optional. + * A pagination token returned from a previous call to ListProducts that indicates where the listing should continue from. This field is optional. */ nextPageToken?: string; /** @@ -257,21 +218,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { versions?: Schema$GoogleCloudPrivatecatalogproducerV1beta1Version[]; } /** - * The producer representation of a product which is a child resource of - * `Catalog` with display metadata and a list of `Version` resources. + * The producer representation of a product which is a child resource of `Catalog` with display metadata and a list of `Version` resources. */ export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1Product { /** - * Required. The type of the product asset, which cannot be changed after - * the product is created. It supports the values - * `google.deploymentmanager.Template` and - * `google.cloudprivatecatalog.ListingOnly`. Other values will be rejected - * by the server. Read only after creation. The following fields or - * resource types have different validation rules under each `asset_type` - * values: * Product.display_metadata has different validation schema for - * each asset type value. See its comment for details. * Version resource - * isn't allowed to be added under the - * `google.cloudprivatecatalog.ListingOnly` type. + * Required. The type of the product asset, which cannot be changed after the product is created. It supports the values `google.deploymentmanager.Template` and `google.cloudprivatecatalog.ListingOnly`. Other values will be rejected by the server. Read only after creation. The following fields or resource types have different validation rules under each `asset_type` values: * Product.display_metadata has different validation schema for each asset type value. See its comment for details. * Version resource isn't allowed to be added under the `google.cloudprivatecatalog.ListingOnly` type. */ assetType?: string; /** @@ -279,52 +230,15 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ createTime?: string; /** - * The user-supplied display metadata to describe the product. The JSON - * schema of the metadata differs by Product.asset_type. When the type is - * `google.deploymentmanager.Template`, the schema is as follows: ``` - * "$schema": http://json-schema.org/draft-04/schema# type: object - * properties: name: type: string minLength: 1 maxLength: 64 - * description: type: string minLength: 1 maxLength: 2048 - * tagline: type: string minLength: 1 maxLength: 100 - * support_info: type: string minLength: 1 maxLength: 2048 - * creator: type: string minLength: 1 maxLength: 100 - * documentation: type: array items: type: object properties: - * url: type: string pattern: - * "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - * title: type: string minLength: 1 maxLength: - * 64 description: type: string minLength: 1 - * maxLength: 2048 required: - name - description additionalProperties: - * false ``` When the asset type is - * `google.cloudprivatecatalog.ListingOnly`, the schema is as follows: ``` - * "$schema": http://json-schema.org/draft-04/schema# type: object - * properties: name: type: string minLength: 1 maxLength: 64 - * description: type: string minLength: 1 maxLength: 2048 - * tagline: type: string minLength: 1 maxLength: 100 - * support_info: type: string minLength: 1 maxLength: 2048 - * creator: type: string minLength: 1 maxLength: 100 - * documentation: type: array items: type: object properties: - * url: type: string pattern: - * "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - * title: type: string minLength: 1 maxLength: - * 64 description: type: string minLength: 1 - * maxLength: 2048 signup_url: type: string pattern: - * "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - * required: - name - description - signup_url additionalProperties: false - * ``` + * The user-supplied display metadata to describe the product. The JSON schema of the metadata differs by Product.asset_type. When the type is `google.deploymentmanager.Template`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 required: - name - description additionalProperties: false ``` When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 signup_url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" required: - name - description - signup_url additionalProperties: false ``` */ displayMetadata?: {[key: string]: any}; /** - * Output only. The public accessible URI of the icon uploaded by - * PrivateCatalogProducer.UploadIcon. If no icon is uploaded, it will be - * the default icon's URI. + * Output only. The public accessible URI of the icon uploaded by PrivateCatalogProducer.UploadIcon. If no icon is uploaded, it will be the default icon's URI. */ iconUri?: string; /** - * Required. The resource name of the product in the format - * `catalogs/{catalog_id}/products/a-z*[a-z0-9]'. A unique identifier - * for the product under a catalog, which cannot be changed after the - * product is created. The final segment of the name must between 1 and 256 - * characters in length. + * Required. The resource name of the product in the format `catalogs/{catalog_id}/products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog, which cannot be changed after the product is created. The final segment of the name must between 1 and 256 characters in length. */ name?: string; /** @@ -335,21 +249,16 @@ export namespace cloudprivatecatalogproducer_v1beta1 { export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest {} export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest { /** - * The raw icon bytes user-supplied to be uploaded to the product. The - * format of the icon can only be PNG or JPEG. The minimum allowed - * dimensions are 130x130 pixels and the maximum dimensions are 10000x10000 - * pixels. Required. + * The raw icon bytes user-supplied to be uploaded to the product. The format of the icon can only be PNG or JPEG. The minimum allowed dimensions are 130x130 pixels and the maximum dimensions are 10000x10000 pixels. Required. */ icon?: string; } /** - * The producer representation of a version, which is a child resource under a - * `Product` with asset data. + * The producer representation of a version, which is a child resource under a `Product` with asset data. */ export interface Schema$GoogleCloudPrivatecatalogproducerV1beta1Version { /** - * Output only. The asset which has been validated and is ready to be - * provisioned. See Version.original_asset for the schema. + * Output only. The asset which has been validated and is ready to be provisioned. See Version.original_asset for the schema. */ asset?: {[key: string]: any}; /** @@ -361,25 +270,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ description?: string; /** - * Required. The resource name of the version, in the format - * `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. - * A unique identifier for the version under a product, which can't be - * changed after the version is created. The final segment of the name must - * between 1 and 63 characters in length. + * Required. The resource name of the version, in the format `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A unique identifier for the version under a product, which can't be changed after the version is created. The final segment of the name must between 1 and 63 characters in length. */ name?: string; /** - * The user-supplied asset payload. The maximum size of the payload is 2MB. - * The JSON schema of the payload is defined as: ``` type: object - * properties: mainTemplate: type: string description: The file - * name of the main template and name prefix of schema file. The content - * of the main template should be set in the imports list. The schema - * file name is expected to be <mainTemplate>.schema in the - * imports list. required: true imports: type: array description: - * Import template and schema file contents. Required to have both - * <mainTemplate> and <mainTemplate>.schema files. required: - * true minItems: 2 items: type: object properties: - * name: type: string content: type: string ``` + * The user-supplied asset payload. The maximum size of the payload is 2MB. The JSON schema of the payload is defined as: ``` type: object properties: mainTemplate: type: string description: The file name of the main template and name prefix of schema file. The content of the main template should be set in the imports list. The schema file name is expected to be <mainTemplate>.schema in the imports list. required: true imports: type: array description: Import template and schema file contents. Required to have both <mainTemplate> and <mainTemplate>.schema files. required: true minItems: 2 items: type: object properties: name: type: string content: type: string ``` */ originalAsset?: {[key: string]: any}; /** @@ -388,27 +283,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { updateTime?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$GoogleIamV1AuditConfig { /** @@ -416,25 +291,16 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ auditLogConfigs?: Schema$GoogleIamV1AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$GoogleIamV1AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -447,52 +313,20 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ export interface Schema$GoogleIamV1Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$GoogleTypeExpr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$GoogleIamV1Policy { /** @@ -500,20 +334,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ auditConfigs?: Schema$GoogleIamV1AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$GoogleIamV1Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -526,17 +351,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ export interface Schema$GoogleIamV1SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$GoogleIamV1Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -545,10 +364,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ export interface Schema$GoogleIamV1TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -557,8 +373,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ export interface Schema$GoogleIamV1TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -580,14 +395,11 @@ export namespace cloudprivatecatalogproducer_v1beta1 { operations?: Schema$GoogleLongrunningOperation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -595,72 +407,24 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ error?: Schema$GoogleRpcStatus; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobufEmpty {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpcStatus { /** @@ -668,43 +432,32 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$GoogleTypeExpr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -800,10 +553,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.catalogs.delete - * @desc Soft deletes an existing Catalog and all resources under it. The - * catalog can only be deleted if there is no associations under it or - * DeleteCatalogRequest.force is true. The delete operation can be recovered - * by the PrivateCatalogProducer.UndeleteCatalog method. + * @desc Soft deletes an existing Catalog and all resources under it. The catalog can only be deleted if there is no associations under it or DeleteCatalogRequest.force is true. The delete operation can be recovered by the PrivateCatalogProducer.UndeleteCatalog method. * @alias cloudprivatecatalogproducer.catalogs.delete * @memberOf! () * @@ -1074,8 +824,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.catalogs.list - * @desc Lists Catalog resources that the producer has access to, within the - * scope of the parent resource. + * @desc Lists Catalog resources that the producer has access to, within the scope of the parent resource. * @alias cloudprivatecatalogproducer.catalogs.list * @memberOf! () * @@ -1564,9 +1313,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Forces deletion of the `Catalog` and its `Association` resources. If the - * `Catalog` is still associated with other resources and force is not set - * to true, then the operation fails. + * Forces deletion of the `Catalog` and its `Association` resources. If the `Catalog` is still associated with other resources and force is not set to true, then the operation fails. */ force?: boolean; /** @@ -1593,8 +1340,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1609,9 +1355,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to ListCatalogs that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to ListCatalogs that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** @@ -1626,9 +1370,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the catalog, in the format - * `catalogs/{catalog_id}'. A unique identifier for the catalog, which is - * generated by catalog service. + * Output only. The resource name of the catalog, in the format `catalogs/{catalog_id}'. A unique identifier for the catalog, which is generated by catalog service. */ name?: string; /** @@ -1649,8 +1391,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1667,8 +1408,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2138,8 +1878,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ pageToken?: string; /** - * The resource name of the `Catalog` whose `Associations` are being - * retrieved. In the format `catalogs/`. + * The resource name of the `Catalog` whose `Associations` are being retrieved. In the format `catalogs/`. */ parent?: string; } @@ -2511,8 +2250,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.catalogs.products.list - * @desc Lists Product resources that the producer has access to, within the - * scope of the parent catalog. + * @desc Lists Product resources that the producer has access to, within the scope of the parent catalog. * @alias cloudprivatecatalogproducer.catalogs.products.list * @memberOf! () * @@ -2781,8 +2519,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression used to restrict the returned results based upon - * properties of the product. + * A filter expression used to restrict the returned results based upon properties of the product. */ filter?: string; /** @@ -2790,9 +2527,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to ListProducts that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to ListProducts that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** @@ -2808,11 +2543,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the product in the format - * `catalogs/{catalog_id}/products/a-z*[a-z0-9]'. A unique identifier for - * the product under a catalog, which cannot be changed after the product is - * created. The final segment of the name must between 1 and 256 characters - * in length. + * Required. The resource name of the product in the format `catalogs/{catalog_id}/products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog, which cannot be changed after the product is created. The final segment of the name must between 1 and 256 characters in length. */ name?: string; /** @@ -2834,11 +2565,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.catalogs.products.icons.upload - * @desc Creates an Icon instance under a given Product. If Product only has - * a default icon, a new Icon instance is created and associated with the - * given Product. If Product already has a non-default icon, the action - * creates a new Icon instance, associates the newly created Icon with the - * given Product and deletes the old icon. + * @desc Creates an Icon instance under a given Product. If Product only has a default icon, a new Icon instance is created and associated with the given Product. If Product already has a non-default icon, the action creates a new Icon instance, associates the newly created Icon with the given Product and deletes the old icon. * @alias cloudprivatecatalogproducer.catalogs.products.icons.upload * @memberOf! () * @@ -3194,8 +2921,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.catalogs.products.versions.list - * @desc Lists Version resources that the producer has access to, within the - * scope of the parent Product. + * @desc Lists Version resources that the producer has access to, within the scope of the parent Product. * @alias cloudprivatecatalogproducer.catalogs.products.versions.list * @memberOf! () * @@ -3450,9 +3176,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ pageSize?: number; /** - * A pagination token returned from a previous call to ListVersions that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to ListVersions that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** @@ -3468,11 +3192,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the version, in the format - * `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A - * unique identifier for the version under a product, which can't be changed - * after the version is created. The final segment of the name must between - * 1 and 63 characters in length. + * Required. The resource name of the version, in the format `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A unique identifier for the version under a product, which can't be changed after the version is created. The final segment of the name must between 1 and 63 characters in length. */ name?: string; /** @@ -3494,15 +3214,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias cloudprivatecatalogproducer.operations.cancel * @memberOf! () * @@ -3579,10 +3291,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias cloudprivatecatalogproducer.operations.delete * @memberOf! () * @@ -3655,9 +3364,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudprivatecatalogproducer.operations.get * @memberOf! () * @@ -3736,15 +3443,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { /** * cloudprivatecatalogproducer.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias cloudprivatecatalogproducer.operations.list * @memberOf! () * diff --git a/src/apis/cloudprofiler/package.json b/src/apis/cloudprofiler/package.json index 3d496ca995c..b931a418cc8 100644 --- a/src/apis/cloudprofiler/package.json +++ b/src/apis/cloudprofiler/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudprofiler/v2.ts b/src/apis/cloudprofiler/v2.ts index 02a6d0465c9..12a13f91bb5 100644 --- a/src/apis/cloudprofiler/v2.ts +++ b/src/apis/cloudprofiler/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudprofiler_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudprofiler_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,17 +108,17 @@ export namespace cloudprofiler_v2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * CreateProfileRequest describes a profile resource online creation request. - * The deployment field must be populated. The profile_type specifies the list - * of profile types supported by the agent. The creation call will hang until - * a profile of one of these types needs to be collected. + * CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected. */ export interface Schema$CreateProfileRequest { /** @@ -139,30 +135,15 @@ export namespace cloudprofiler_v2 { */ export interface Schema$Deployment { /** - * Labels identify the deployment within the user universe and same target. - * Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. - * Value for an individual label must be <= 512 bytes, the total size of - * all label names and values must be <= 1024 bytes. Label named - * "language" can be used to record the programming language of - * the profiled deployment. The standard choices for the value include - * "java", "go", "python", "ruby", - * "nodejs", "php", "dotnet". For deployments - * running on Google Cloud Platform, "zone" or "region" - * label should be present describing the deployment location. An example of - * a zone is "us-central1-a", an example of a region is - * "us-central1" or "us-central". + * Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named "language" can be used to record the programming language of the profiled deployment. The standard choices for the value include "java", "go", "python", "ruby", "nodejs", "php", "dotnet". For deployments running on Google Cloud Platform, "zone" or "region" label should be present describing the deployment location. An example of a zone is "us-central1-a", an example of a region is "us-central1" or "us-central". */ labels?: {[key: string]: string}; /** - * Project ID is the ID of a cloud project. Validation regex: - * `^a-z{4,61}[a-z0-9]$`. + * Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`. */ projectId?: string; /** - * Target is the service name used to group related deployments: * Service - * name for GAE Flex / Standard. * Cluster and container name for GKE. * - * User-specified string for direct GCE profiling (e.g. Java). * Job name - * for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`. + * Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`. */ target?: string; } @@ -175,18 +156,11 @@ export namespace cloudprofiler_v2 { */ deployment?: Schema$Deployment; /** - * Duration of the profiling session. Input (for the offline mode) or output - * (for the online mode). The field represents requested profiling duration. - * It may slightly differ from the effective profiling duration, which is - * recorded in the profile data, in case the profiling can't be stopped - * immediately (e.g. in case stopping the profiling is handled - * asynchronously). + * Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously). */ duration?: string; /** - * Input only. Labels associated to this specific profile. These labels will - * get merged with the deployment labels for the final data set. See - * documentation on deployment labels for validation rules and limits. + * Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits. */ labels?: {[key: string]: string}; /** @@ -194,14 +168,11 @@ export namespace cloudprofiler_v2 { */ name?: string; /** - * Input only. Profile bytes, as a gzip compressed serialized proto, the - * format is - * https://github.com/google/pprof/blob/master/proto/profile.proto. + * Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto. */ profileBytes?: string; /** - * Type of profile. For offline mode, this must be specified when creating - * the profile. For online mode it is assigned and returned by the server. + * Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server. */ profileType?: string; } @@ -223,16 +194,7 @@ export namespace cloudprofiler_v2 { /** * cloudprofiler.projects.profiles.create - * @desc CreateProfile creates a new profile resource in the online mode. - * The server ensures that the new profiles are created at a constant rate - * per deployment, so the creation request may hang for some time until the - * next profile session is available. The request may fail with ABORTED - * error if the creation is not available within ~1m, the response will - * indicate the duration of the backoff the client should take before - * attempting creating a profile again. The backoff duration is returned in - * google.rpc.RetryInfo extension on the response status. To a gRPC client, - * the extension will be return as a binary-serialized proto in the trailing - * metadata item named "google.rpc.retryinfo-bin". + * @desc CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin". * @alias cloudprofiler.projects.profiles.create * @memberOf! () * @@ -306,9 +268,7 @@ export namespace cloudprofiler_v2 { /** * cloudprofiler.projects.profiles.createOffline - * @desc CreateOfflineProfile creates a new profile resource in the offline - * mode. The client provides the profile to create along with the profile - * bytes, the server records it. + * @desc CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it. * @alias cloudprofiler.projects.profiles.createOffline * @memberOf! () * @@ -382,10 +342,7 @@ export namespace cloudprofiler_v2 { /** * cloudprofiler.projects.profiles.patch - * @desc UpdateProfile updates the profile bytes and labels on the profile - * resource created in the online mode. Updating the bytes for profiles - * created in the offline mode is currently not supported: the profile - * content must be provided at the time of the profile creation. + * @desc UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation. * @alias cloudprofiler.projects.profiles.patch * @memberOf! () * @@ -502,10 +459,7 @@ export namespace cloudprofiler_v2 { */ name?: string; /** - * Field mask used to specify the fields to be overwritten. Currently only - * profile_bytes and labels fields are supported by UpdateProfile, so only - * those fields can be specified in the mask. When no mask is provided, all - * fields are overwritten. + * Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten. */ updateMask?: string; diff --git a/src/apis/cloudresourcemanager/package.json b/src/apis/cloudresourcemanager/package.json index fbeb82c00c1..731986e5ffb 100644 --- a/src/apis/cloudresourcemanager/package.json +++ b/src/apis/cloudresourcemanager/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index c01aafea2a9..5697c79ba87 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudresourcemanager_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudresourcemanager_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudresourcemanager_v1 { /** * Cloud Resource Manager API * - * Creates, reads, and updates metadata for Google Cloud Platform resource - * containers. + * Creates, reads, and updates metadata for Google Cloud Platform resource containers. * * @example * const {google} = require('googleapis'); @@ -117,7 +112,10 @@ export namespace cloudresourcemanager_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.folders = new Resource$Folders(this.context); this.liens = new Resource$Liens(this.context); @@ -137,27 +135,7 @@ export namespace cloudresourcemanager_v1 { resourceId?: Schema$ResourceId; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -165,25 +143,16 @@ export namespace cloudresourcemanager_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -196,71 +165,28 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A `Constraint` that is either enforced or not. For example a constraint - * `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM - * instance, serial port connections will not be opened to that instance. + * A `Constraint` that is either enforced or not. For example a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance. */ export interface Schema$BooleanConstraint {} /** - * Used in `policy_type` to specify how `boolean_policy` will behave at this - * resource. + * Used in `policy_type` to specify how `boolean_policy` will behave at this resource. */ export interface Schema$BooleanPolicy { /** - * If `true`, then the `Policy` is enforced. If `false`, then any - * configuration is acceptable. Suppose you have a `Constraint` - * `constraints/compute.disableSerialPortAccess` with `constraint_default` - * set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following - * behavior: - If the `Policy` at this resource has enforced set to - * `false`, serial port connection attempts will be allowed. - If the - * `Policy` at this resource has enforced set to `true`, serial port - * connection attempts will be refused. - If the `Policy` at this resource - * is `RestoreDefault`, serial port connection attempts will be allowed. - * - If no `Policy` is set at this resource or anywhere higher in the - * resource hierarchy, serial port connection attempts will be allowed. - - * If no `Policy` is set at this resource, but one exists higher in the - * resource hierarchy, the behavior is as if the`Policy` were set at this - * resource. The following examples demonstrate the different possible - * layerings: Example 1 (nearest `Constraint` wins): `organizations/foo` - * has a `Policy` with: {enforced: false} `projects/bar` has no - * `Policy` set. The constraint at `projects/bar` and `organizations/foo` - * will not be enforced. Example 2 (enforcement gets replaced): - * `organizations/foo` has a `Policy` with: {enforced: false} - * `projects/bar` has a `Policy` with: {enforced: true} The constraint - * at `organizations/foo` is not enforced. The constraint at `projects/bar` - * is enforced. Example 3 (RestoreDefault): `organizations/foo` has a - * `Policy` with: {enforced: true} `projects/bar` has a `Policy` with: - * {RestoreDefault: {}} The constraint at `organizations/foo` is enforced. - * The constraint at `projects/bar` is not enforced, because - * `constraint_default` for the `Constraint` is `ALLOW`. + * If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable. Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess` with `constraint_default` set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following behavior: - If the `Policy` at this resource has enforced set to `false`, serial port connection attempts will be allowed. - If the `Policy` at this resource has enforced set to `true`, serial port connection attempts will be refused. - If the `Policy` at this resource is `RestoreDefault`, serial port connection attempts will be allowed. - If no `Policy` is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed. - If no `Policy` is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if the`Policy` were set at this resource. The following examples demonstrate the different possible layerings: Example 1 (nearest `Constraint` wins): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has no `Policy` set. The constraint at `projects/bar` and `organizations/foo` will not be enforced. Example 2 (enforcement gets replaced): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has a `Policy` with: {enforced: true} The constraint at `organizations/foo` is not enforced. The constraint at `projects/bar` is enforced. Example 3 (RestoreDefault): `organizations/foo` has a `Policy` with: {enforced: true} `projects/bar` has a `Policy` with: {RestoreDefault: {}} The constraint at `organizations/foo` is enforced. The constraint at `projects/bar` is not enforced, because `constraint_default` for the `Constraint` is `ALLOW`. */ enforced?: boolean; } @@ -273,25 +199,12 @@ export namespace cloudresourcemanager_v1 { */ constraint?: string; /** - * The current version, for concurrency control. Not sending an `etag` will - * cause the `Policy` to be cleared blindly. + * The current version, for concurrency control. Not sending an `etag` will cause the `Policy` to be cleared blindly. */ etag?: string; } /** - * A `Constraint` describes a way in which a resource's configuration can - * be restricted. For example, it controls which cloud services can be - * activated across an organization, or whether a Compute Engine instance can - * have serial port connections established. `Constraints` can be configured - * by the organization's policy adminstrator to fit the needs of the - * organzation by setting Policies for `Constraints` at different locations in - * the organization's resource hierarchy. Policies are inherited down the - * resource hierarchy from higher levels, but can also be overridden. For - * details about the inheritance rules please read about Policies. - * `Constraints` have a default behavior determined by the - * `constraint_default` field, which is the enforcement behavior that is used - * in the absence of a `Policy` being defined or inherited for the resource in - * question. + * A `Constraint` describes a way in which a resource's configuration can be restricted. For example, it controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. `Constraints` can be configured by the organization's policy adminstrator to fit the needs of the organzation by setting Policies for `Constraints` at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about Policies. `Constraints` have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a `Policy` being defined or inherited for the resource in question. */ export interface Schema$Constraint { /** @@ -299,13 +212,11 @@ export namespace cloudresourcemanager_v1 { */ booleanConstraint?: Schema$BooleanConstraint; /** - * The evaluation behavior of this constraint in the absense of - * 'Policy'. + * The evaluation behavior of this constraint in the absense of 'Policy'. */ constraintDefault?: string; /** - * Detailed description of what this `Constraint` controls as well as how - * and where it is enforced. Mutable. + * Detailed description of what this `Constraint` controls as well as how and where it is enforced. Mutable. */ description?: string; /** @@ -317,8 +228,7 @@ export namespace cloudresourcemanager_v1 { */ listConstraint?: Schema$ListConstraint; /** - * Immutable value, required to globally be unique. For example, - * `constraints/serviceuser.services` + * Immutable value, required to globally be unique. For example, `constraints/serviceuser.services` */ name?: string; /** @@ -327,39 +237,27 @@ export namespace cloudresourcemanager_v1 { version?: number; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -368,8 +266,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$FolderOperation { /** - * The resource name of the folder or organization we are either creating - * the folder under or moving the folder to. + * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ destinationParent?: string; /** @@ -381,8 +278,7 @@ export namespace cloudresourcemanager_v1 { */ operationType?: string; /** - * The resource name of the folder's parent. Only applicable when the - * operation_type is MOVE. + * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ sourceParent?: string; } @@ -404,9 +300,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$GetAncestryResponse { /** - * Ancestors are ordered from bottom to top of the resource hierarchy. The - * first ancestor is the project itself, followed by the project's - * parent, etc.. + * Ancestors are ordered from bottom to top of the resource hierarchy. The first ancestor is the project itself, followed by the project's parent, etc.. */ ancestor?: Schema$Ancestor[]; } @@ -433,8 +327,7 @@ export namespace cloudresourcemanager_v1 { constraint?: string; } /** - * A Lien represents an encumbrance on the actions that can be performed on a - * resource. + * A Lien represents an encumbrance on the actions that can be performed on a resource. */ export interface Schema$Lien { /** @@ -442,59 +335,41 @@ export namespace cloudresourcemanager_v1 { */ createTime?: string; /** - * A system-generated unique identifier for this Lien. Example: - * `liens/1234abcd` + * A system-generated unique identifier for this Lien. Example: `liens/1234abcd` */ name?: string; /** - * A stable, user-visible/meaningful string identifying the origin of the - * Lien, intended to be inspected programmatically. Maximum length of 200 - * characters. Example: 'compute.googleapis.com' + * A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com' */ origin?: string; /** - * A reference to the resource this Lien is attached to. The server will - * validate the parent against those for which Liens are supported. Example: - * `projects/1234` + * A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234` */ parent?: string; /** - * Concise user-visible strings indicating why an action cannot be performed - * on a resource. Maximum length of 200 characters. Example: 'Holds - * production API key' + * Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key' */ reason?: string; /** - * The types of operations which should be blocked as a result of this Lien. - * Each value should correspond to an IAM permission. The server will - * validate the permissions against those for which Liens are supported. An - * empty list is meaningless and will be rejected. Example: - * ['resourcemanager.projects.delete'] + * The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete'] */ restrictions?: string[]; } /** - * The request sent to the [ListAvailableOrgPolicyConstraints] - * google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method. + * The request sent to the [ListAvailableOrgPolicyConstraints] google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method. */ export interface Schema$ListAvailableOrgPolicyConstraintsRequest { /** - * Size of the pages to be returned. This is currently unsupported and will - * be ignored. The server may at any point start using this field to limit - * page size. + * Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size. */ pageSize?: number; /** - * Page token used to retrieve the next page. This is currently unsupported - * and will be ignored. The server may at any point start using this field. + * Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field. */ pageToken?: string; } /** - * The response returned from the ListAvailableOrgPolicyConstraints method. - * Returns all `Constraints` that could be set at this level of the hierarchy - * (contrast with the response from `ListPolicies`, which returns all policies - * which are set). + * The response returned from the ListAvailableOrgPolicyConstraints method. Returns all `Constraints` that could be set at this level of the hierarchy (contrast with the response from `ListPolicies`, which returns all policies which are set). */ export interface Schema$ListAvailableOrgPolicyConstraintsResponse { /** @@ -507,20 +382,15 @@ export namespace cloudresourcemanager_v1 { nextPageToken?: string; } /** - * A `Constraint` that allows or disallows a list of string values, which are - * configured by an Organization's policy administrator with a `Policy`. + * A `Constraint` that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a `Policy`. */ export interface Schema$ListConstraint { /** - * Optional. The Google Cloud Console will try to default to a configuration - * that matches the value specified in this `Constraint`. + * Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Constraint`. */ suggestedValue?: string; /** - * Indicates whether subtrees of Cloud Resource Manager resource hierarchy - * can be used in `Policy.allowed_values` and `Policy.denied_values`. For - * example, `"under:folders/123"` would match any resource under - * the 'folders/123' folder. + * Indicates whether subtrees of Cloud Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder. */ supportsUnder?: boolean; } @@ -533,8 +403,7 @@ export namespace cloudresourcemanager_v1 { */ liens?: Schema$Lien[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -543,58 +412,33 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$ListOrgPoliciesRequest { /** - * Size of the pages to be returned. This is currently unsupported and will - * be ignored. The server may at any point start using this field to limit - * page size. + * Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size. */ pageSize?: number; /** - * Page token used to retrieve the next page. This is currently unsupported - * and will be ignored. The server may at any point start using this field. + * Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field. */ pageToken?: string; } /** - * The response returned from the ListOrgPolicies method. It will be empty if - * no `Policies` are set on the resource. + * The response returned from the ListOrgPolicies method. It will be empty if no `Policies` are set on the resource. */ export interface Schema$ListOrgPoliciesResponse { /** - * Page token used to retrieve the next page. This is currently not used, - * but the server may at any point start supplying a valid token. + * Page token used to retrieve the next page. This is currently not used, but the server may at any point start supplying a valid token. */ nextPageToken?: string; /** - * The `Policies` that are set on the resource. It will be empty if no - * `Policies` are set. + * The `Policies` that are set on the resource. It will be empty if no `Policies` are set. */ policies?: Schema$OrgPolicy[]; } /** - * Used in `policy_type` to specify how `list_policy` behaves at this - * resource. `ListPolicy` can define specific values and subtrees of Cloud - * Resource Manager resource hierarchy (`Organizations`, `Folders`, - * `Projects`) that are allowed or denied by setting the `allowed_values` and - * `denied_values` fields. This is achieved by using the `under:` and optional - * `is:` prefixes. The `under:` prefix is used to denote resource subtree - * values. The `is:` prefix is used to denote specific values, and is required - * only if the value contains a ":". Values prefixed with - * "is:" are treated the same as values with no prefix. Ancestry - * subtrees must be in one of the following formats: - - * “projects/<project-id>”, e.g. “projects/tokyo-rain-123” - - * “folders/<folder-id>”, e.g. “folders/1234” - - * “organizations/<organization-id>”, e.g. “organizations/1234” The - * `supports_under` field of the associated `Constraint` defines whether - * ancestry prefixes can be used. You can set `allowed_values` and - * `denied_values` in the same `Policy` if `all_values` is - * `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all - * values. If `all_values` is set to either `ALLOW` or `DENY`, - * `allowed_values` and `denied_values` must be unset. + * Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - “projects/<project-id>”, e.g. “projects/tokyo-rain-123” - “folders/<folder-id>”, e.g. “folders/1234” - “organizations/<organization-id>”, e.g. “organizations/1234” The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset. */ export interface Schema$ListPolicy { /** - * List of values allowed at this resource. Can only be set if `all_values` - * is set to `ALL_VALUES_UNSPECIFIED`. + * List of values allowed at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. */ allowedValues?: string[]; /** @@ -602,117 +446,37 @@ export namespace cloudresourcemanager_v1 { */ allValues?: string; /** - * List of values denied at this resource. Can only be set if `all_values` - * is set to `ALL_VALUES_UNSPECIFIED`. + * List of values denied at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. */ deniedValues?: string[]; /** - * Determines the inheritance behavior for this `Policy`. By default, a - * `ListPolicy` set at a resource supercedes any `Policy` set anywhere up - * the resource hierarchy. However, if `inherit_from_parent` is set to - * `true`, then the values from the effective `Policy` of the parent - * resource are inherited, meaning the values set in this `Policy` are added - * to the values inherited up the hierarchy. Setting `Policy` hierarchies - * that inherit both allowed values and denied values isn't recommended - * in most circumstances to keep the configuration simple and - * understandable. However, it is possible to set a `Policy` with - * `allowed_values` set that inherits a `Policy` with `denied_values` set. - * In this case, the values that are allowed must be in `allowed_values` and - * not present in `denied_values`. For example, suppose you have a - * `Constraint` `constraints/serviceuser.services`, which has a - * `constraint_type` of `list_constraint`, and with `constraint_default` set - * to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied - * that restricts the allowed API activations to {`E1`, `E2`}. Then, if a - * `Policy` is applied to a project below the Organization that has - * `inherit_from_parent` set to `false` and field all_values set to DENY, - * then an attempt to activate any API will be denied. The following - * examples demonstrate different possible layerings for `projects/bar` - * parented by `organizations/foo`: Example 1 (no inherited values): - * `organizations/foo` has a `Policy` with values: {allowed_values: “E1” - * allowed_values:”E2”} `projects/bar` has `inherit_from_parent` `false` - * and values: {allowed_values: "E3" allowed_values: - * "E4"} The accepted values at `organizations/foo` are `E1`, - * `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example - * 2 (inherited values): `organizations/foo` has a `Policy` with values: - * {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a - * `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: - * true} The accepted values at `organizations/foo` are `E1`, `E2`. The - * accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example - * 3 (inheriting both allowed and denied values): `organizations/foo` has - * a `Policy` with values: {allowed_values: "E1" - * allowed_values: "E2"} `projects/bar` has a `Policy` with: - * {denied_values: "E1"} The accepted values at - * `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` - * is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a - * `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} - * `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The - * accepted values at `organizations/foo` are `E1`, `E2`. The accepted - * values at `projects/bar` are either all or none depending on the value of - * `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no - * policy inherits parent policy): `organizations/foo` has no `Policy` - * set. `projects/bar` has no `Policy` set. The accepted values at both - * levels are either all or none depending on the value of - * `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 - * (ListConstraint allowing all): `organizations/foo` has a `Policy` with - * values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` - * has a `Policy` with: {all: ALLOW} The accepted values at - * `organizations/foo` are `E1`, E2`. Any value is accepted at - * `projects/bar`. Example 7 (ListConstraint allowing none): - * `organizations/foo` has a `Policy` with values: {allowed_values: “E1” - * allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: - * DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value - * is accepted at `projects/bar`. Example 10 (allowed and denied subtrees - * of Resource Manager hierarchy): Given the following resource hierarchy - * O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has - * a `Policy` with values: {allowed_values: - * "under:organizations/O1"} `projects/bar` has a `Policy` with: - * {allowed_values: "under:projects/P3"} {denied_values: - * "under:folders/F2"} The accepted values at `organizations/foo` - * are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, - * `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are - * `organizations/O1`, `folders/F1`, `projects/P1`. + * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. */ inheritFromParent?: boolean; /** - * Optional. The Google Cloud Console will try to default to a configuration - * that matches the value specified in this `Policy`. If `suggested_value` - * is not set, it will inherit the value specified higher in the hierarchy, - * unless `inherit_from_parent` is `false`. + * Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Policy`. If `suggested_value` is not set, it will inherit the value specified higher in the hierarchy, unless `inherit_from_parent` is `false`. */ suggestedValue?: string; } /** - * A page of the response received from the ListProjects method. A paginated - * response where more pages are available has `next_page_token` set. This - * token can be used in a subsequent request to retrieve the next request - * page. + * A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page. */ export interface Schema$ListProjectsResponse { /** - * Pagination token. If the result set is too large to fit in a single - * response, this token is returned. It encodes the position of the current - * result cursor. Feeding this value into a new list request with the - * `page_token` parameter gives the next page of the results. When - * `next_page_token` is not filled in, there is no next page and the list - * returned is the last page in the result set. Pagination tokens have a - * limited lifetime. + * Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. */ nextPageToken?: string; /** - * The list of Projects that matched the list filter. This list can be - * paginated. + * The list of Projects that matched the list filter. This list can be paginated. */ projects?: Schema$Project[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -720,70 +484,45 @@ export namespace cloudresourcemanager_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The root node in the resource hierarchy to which a particular entity's - * (e.g., company) resources belong. + * The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong. */ export interface Schema$Organization { /** - * Timestamp when the Organization was created. Assigned by the server. - * @OutputOnly + * Timestamp when the Organization was created. Assigned by the server. @OutputOnly */ creationTime?: string; /** - * A human-readable string that refers to the Organization in the GCP - * Console UI. This string is set by the server and cannot be changed. The - * string will be set to the primary domain (for example, - * "google.com") of the G Suite customer that owns the - * organization. @OutputOnly + * A human-readable string that refers to the Organization in the GCP Console UI. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the G Suite customer that owns the organization. @OutputOnly */ displayName?: string; /** - * The organization's current lifecycle state. Assigned by the server. - * @OutputOnly + * The organization's current lifecycle state. Assigned by the server. @OutputOnly */ lifecycleState?: string; /** - * Output Only. The resource name of the organization. This is the - * organization's relative path in the API. Its format is - * "organizations/[organization_id]". For example, - * "organizations/1234". + * Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". */ name?: string; /** - * The owner of this Organization. The owner should be specified on - * creation. Once set, it cannot be changed. This field is required. + * The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required. */ owner?: Schema$OrganizationOwner; } /** - * The entity that owns an Organization. The lifetime of the Organization and - * all of its descendants are bound to the `OrganizationOwner`. If the - * `OrganizationOwner` is deleted, the Organization and all its descendants - * will be deleted. + * The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. */ export interface Schema$OrganizationOwner { /** @@ -792,8 +531,7 @@ export namespace cloudresourcemanager_v1 { directoryCustomerId?: string; } /** - * Defines a Cloud Organization `Policy` which is used to specify - * `Constraints` for configurations of Cloud Platform resources. + * Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources. */ export interface Schema$OrgPolicy { /** @@ -801,21 +539,11 @@ export namespace cloudresourcemanager_v1 { */ booleanPolicy?: Schema$BooleanPolicy; /** - * The name of the `Constraint` the `Policy` is configuring, for example, - * `constraints/serviceuser.services`. Immutable after creation. + * The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`. Immutable after creation. */ constraint?: string; /** - * An opaque tag indicating the current version of the `Policy`, used for - * concurrency control. When the `Policy` is returned from either a - * `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the - * version of the current `Policy` to use when executing a read-modify-write - * loop. When the `Policy` is returned from a `GetEffectivePolicy` request, - * the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` - * method, use the `etag` value that was returned from a `GetOrgPolicy` - * request as part of a read-modify-write loop for concurrency control. Not - * setting the `etag`in a `SetOrgPolicy` request will result in an - * unconditional write of the `Policy`. + * An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`. */ etag?: string; /** @@ -823,15 +551,11 @@ export namespace cloudresourcemanager_v1 { */ listPolicy?: Schema$ListPolicy; /** - * Restores the default behavior of the constraint; independent of - * `Constraint` type. + * Restores the default behavior of the constraint; independent of `Constraint` type. */ restoreDefault?: Schema$RestoreDefault; /** - * The time stamp the `Policy` was previously updated. This is set by the - * server, not specified by the caller, and represents the last time a call - * to `SetOrgPolicy` was made for that `Policy`. Any value set by the client - * will be ignored. + * The time stamp the `Policy` was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to `SetOrgPolicy` was made for that `Policy`. Any value set by the client will be ignored. */ updateTime?: string; /** @@ -840,24 +564,7 @@ export namespace cloudresourcemanager_v1 { version?: number; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -865,20 +572,11 @@ export namespace cloudresourcemanager_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -887,9 +585,7 @@ export namespace cloudresourcemanager_v1 { version?: number; } /** - * A Project is a high-level Google Cloud Platform entity. It is a container - * for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform - * resources. + * A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. */ export interface Schema$Project { /** @@ -897,16 +593,7 @@ export namespace cloudresourcemanager_v1 { */ createTime?: string; /** - * The labels associated with this Project. Label keys must be between 1 - * and 63 characters long and must conform to the following regular - * expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be - * between 0 and 63 characters long and must conform to the regular - * expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label value can be - * empty. No more than 256 labels can be associated with a given resource. - * Clients should store labels in a representation such as JSON that does - * not depend on specific characters being disallowed. Example: - * <code>"environment" : "dev"</code> - * Read-write. + * The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: <code>"environment" : "dev"</code> Read-write. */ labels?: {[key: string]: string}; /** @@ -914,38 +601,24 @@ export namespace cloudresourcemanager_v1 { */ lifecycleState?: string; /** - * The optional user-assigned display name of the Project. When present it - * must be between 4 to 30 characters. Allowed characters are: lowercase and - * uppercase letters, numbers, hyphen, single-quote, double-quote, space, - * and exclamation point. Example: <code>My Project</code> - * Read-write. + * The optional user-assigned display name of the Project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: <code>My Project</code> Read-write. */ name?: string; /** - * An optional reference to a parent Resource. Supported parent types - * include "organization" and "folder". Once set, the - * parent cannot be cleared. The `parent` can be set on creation or using - * the `UpdateProject` method; the end user must have the - * `resourcemanager.projects.create` permission on the parent. Read-write. + * An optional reference to a parent Resource. Supported parent types include "organization" and "folder". Once set, the parent cannot be cleared. The `parent` can be set on creation or using the `UpdateProject` method; the end user must have the `resourcemanager.projects.create` permission on the parent. Read-write. */ parent?: Schema$ResourceId; /** - * The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase - * letters, digits, or hyphens. It must start with a letter. Trailing - * hyphens are prohibited. Example: <code>tokyo-rain-123</code> - * Read-only after creation. + * The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: <code>tokyo-rain-123</code> Read-only after creation. */ projectId?: string; /** - * The number uniquely identifying the project. Example: - * <code>415104041262</code> Read-only. + * The number uniquely identifying the project. Example: <code>415104041262</code> Read-only. */ projectNumber?: string; } /** - * A status object which is used as the `metadata` field for the Operation - * returned by CreateProject. It provides insight for when significant phases - * of Project creation have completed. + * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. */ export interface Schema$ProjectCreationStatus { /** @@ -953,9 +626,7 @@ export namespace cloudresourcemanager_v1 { */ createTime?: string; /** - * True if the project can be retrieved using GetProject. No other - * operations on the project are guaranteed to work until the project - * creation is complete. + * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ gettable?: boolean; /** @@ -964,34 +635,20 @@ export namespace cloudresourcemanager_v1 { ready?: boolean; } /** - * A container to reference an id for any resource type. A `resource` in - * Google Cloud Platform is a generic term for something you (a developer) may - * want to interact with through one of our API's. Some examples are an - * App Engine app, a Compute Engine instance, a Cloud SQL database, and so on. + * A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on. */ export interface Schema$ResourceId { /** - * Required field for the type-specific id. This should correspond to the id - * used in the type-specific API's. + * Required field for the type-specific id. This should correspond to the id used in the type-specific API's. */ id?: string; /** - * Required field representing the resource type this id is for. At present, - * the valid types are: "organization" and "folder". + * Required field representing the resource type this id is for. At present, the valid types are: "organization" and "folder". */ type?: string; } /** - * Ignores policies set above this resource and restores the - * `constraint_default` enforcement behavior of the specific `Constraint` at - * this resource. Suppose that `constraint_default` is set to `ALLOW` for the - * `Constraint` `constraints/serviceuser.services`. Suppose that organization - * foo.com sets a `Policy` at their Organization resource node that restricts - * the allowed service activations to deny all service activations. They could - * then set a `Policy` with the `policy_type` `restore_default` on several - * experimental projects, restoring the `constraint_default` enforcement of - * the `Constraint` for only those projects, allowing those projects to have - * all services activated. + * Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific `Constraint` at this resource. Suppose that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/serviceuser.services`. Suppose that organization foo.com sets a `Policy` at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a `Policy` with the `policy_type` `restore_default` on several experimental projects, restoring the `constraint_default` enforcement of the `Constraint` for only those projects, allowing those projects to have all services activated. */ export interface Schema$RestoreDefault {} /** @@ -999,25 +656,15 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$SearchOrganizationsRequest { /** - * An optional query string used to filter the Organizations to return in - * the response. Filter rules are case-insensitive. Organizations may be - * filtered by `owner.directoryCustomerId` or by `domain`, where the domain - * is a G Suite domain, for example: |Filter|Description| - * |------|-----------| |owner.directorycustomerid:123456789|Organizations - * with `owner.directory_customer_id` equal to `123456789`.| - * |domain:google.com|Organizations corresponding to the domain - * `google.com`.| This field is optional. + * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: | Filter | Description | |-------------------------------------|----------------------------------| | owner.directorycustomerid:123456789 | Organizations with `owner.directory_customer_id` equal to `123456789`.| | domain:google.com | Organizations corresponding to the domain `google.com`.| This field is optional. */ filter?: string; /** - * The maximum number of Organizations to return in the response. This field - * is optional. + * The maximum number of Organizations to return in the response. This field is optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to `SearchOrganizations` - * that indicates from where listing should continue. This field is - * optional. + * A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue. This field is optional. */ pageToken?: string; } @@ -1026,16 +673,11 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$SearchOrganizationsResponse { /** - * A pagination token to be used to retrieve the next page of results. If - * the result is too large to fit within the page size specified in the - * request, this field will be set with a token that can be used to fetch - * the next page of results. If this field is empty, it indicates that this - * response contains the last page of results. + * A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results. */ nextPageToken?: string; /** - * The list of Organizations that matched the search query, possibly - * paginated. + * The list of Organizations that matched the search query, possibly paginated. */ organizations?: Schema$Organization[]; } @@ -1044,17 +686,11 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -1068,40 +704,7 @@ export namespace cloudresourcemanager_v1 { policy?: Schema$OrgPolicy; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1109,14 +712,11 @@ export namespace cloudresourcemanager_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1125,10 +725,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1137,8 +734,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1162,14 +758,12 @@ export namespace cloudresourcemanager_v1 { * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1202,10 +796,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1283,25 +876,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.folders.getEffectiveOrgPolicy - * @desc Gets the effective `Policy` on a resource. This is the result of - * merging `Policies` in the resource hierarchy. The returned `Policy` will - * not have an `etag`set because it is a computed `Policy` across multiple - * resources. Subtrees of Resource Manager resource hierarchy with 'under:' - * prefix will not be expanded. + * @desc Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1310,9 +897,8 @@ export namespace cloudresourcemanager_v1 { * * authorize(function(authClient) { * var request = { - * // The name of the resource to start computing the effective - * `Policy`. resource_: 'folders/my-folder', // TODO: Update placeholder - * value. + * // The name of the resource to start computing the effective `Policy`. + * resource_: 'folders/my-folder', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1321,8 +907,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.folders.getEffectiveOrgPolicy(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudResourceManager.folders.getEffectiveOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1336,10 +924,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1421,25 +1008,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.folders.getOrgPolicy - * @desc Gets a `Policy` on a resource. If no `Policy` is set on the - * resource, a `Policy` is returned with default values including - * `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can - * be used with `SetOrgPolicy()` to create or update a `Policy` during - * read-modify-write. + * @desc Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1458,8 +1039,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.folders.getOrgPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.folders.getOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1473,10 +1056,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1556,22 +1138,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.folders.listAvailableOrgPolicyConstraints - * @desc Lists `Constraints` that could be applied on the specified - * resource. + * @desc Lists `Constraints` that could be applied on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1601,20 +1180,17 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < constraintsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `constraintsPage`: console.log(JSON.stringify(constraintsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `constraintsPage`: + * console.log(JSON.stringify(constraintsPage[i], null, 2)); * } * * if (response.nextPageToken) { * request.resource.pageToken = response.nextPageToken; - * cloudResourceManager.folders.listAvailableOrgPolicyConstraints(request, - * handlePage); + * cloudResourceManager.folders.listAvailableOrgPolicyConstraints(request, handlePage); * } * }; * - * cloudResourceManager.folders.listAvailableOrgPolicyConstraints(request, - * handlePage); + * cloudResourceManager.folders.listAvailableOrgPolicyConstraints(request, handlePage); * }); * * function authorize(callback) { @@ -1623,10 +1199,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1735,14 +1310,12 @@ export namespace cloudresourcemanager_v1 { * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1772,8 +1345,8 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < policiesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `policiesPage`: console.log(JSON.stringify(policiesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `policiesPage`: + * console.log(JSON.stringify(policiesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1791,10 +1364,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1878,24 +1450,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.folders.setOrgPolicy - * @desc Updates the specified `Policy` on the resource. Creates a new - * `Policy` for that `Constraint` on the resource if one does not exist. Not - * supplying an `etag` on the request `Policy` results in an unconditional - * write of the `Policy`. + * @desc Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1914,8 +1481,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.folders.setOrgPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.folders.setOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1929,10 +1498,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2122,25 +1690,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.liens.create - * @desc Create a Lien which applies to the resource denoted by the `parent` - * field. Callers of this method will require permission on the `parent` - * resource. For example, applying to `projects/1234` requires permission - * `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit - * the number of Liens which may be applied. + * @desc Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2173,10 +1735,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2249,24 +1810,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.liens.delete - * @desc Delete a Lien by `name`. Callers of this method will require - * permission on the `parent` resource. For example, a Lien with a `parent` - * of `projects/1234` requires permission - * `resourcemanager.projects.updateLiens`. + * @desc Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2295,10 +1851,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2371,10 +1926,7 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.liens.get - * @desc Retrieve a Lien by `name`. Callers of this method will require - * permission on the `parent` resource. For example, a Lien with a `parent` - * of `projects/1234` requires permission requires permission - * `resourcemanager.projects.get` or `resourcemanager.projects.updateLiens`. + * @desc Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission requires permission `resourcemanager.projects.get` or `resourcemanager.projects.updateLiens`. * @alias cloudresourcemanager.liens.get * @memberOf! () * @@ -2443,24 +1995,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.liens.list - * @desc List all Liens applied to the `parent` resource. Callers of this - * method will require permission on the `parent` resource. For example, a - * Lien with a `parent` of `projects/1234` requires permission - * `resourcemanager.projects.get`. + * @desc List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2502,10 +2049,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2621,18 +2167,15 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. This is a suggestion for the - * server. + * The maximum number of items to return. This is a suggestion for the server. */ pageSize?: number; /** - * The `next_page_token` value returned from a previous List request, if - * any. + * The `next_page_token` value returned from a previous List request, if any. */ pageToken?: string; /** - * The name of the resource to list all attached Liens. For example, - * `projects/1234`. + * The name of the resource to list all attached Liens. For example, `projects/1234`. */ parent?: string; } @@ -2645,23 +2188,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2693,10 +2232,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2797,14 +2335,12 @@ export namespace cloudresourcemanager_v1 { * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2814,8 +2350,7 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // Name of the resource for the `Policy` to clear. - * resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2824,8 +2359,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.clearOrgPolicy(request, - * function(err) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.clearOrgPolicy(request, function(err) { + * if (err) { + * console.error(err); + * return; * } * }); * }); @@ -2836,10 +2373,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2917,22 +2453,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.get - * @desc Fetches an Organization resource identified by the specified - * resource name. + * @desc Fetches an Organization resource identified by the specified resource name. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2941,15 +2474,16 @@ export namespace cloudresourcemanager_v1 { * * authorize(function(authClient) { * var request = { - * // The resource name of the Organization to fetch, e.g. - * "organizations/1234". name: 'organizations/my-organization', // TODO: - * Update placeholder value. + * // The resource name of the Organization to fetch, e.g. "organizations/1234". + * name: 'organizations/my-organization', // TODO: Update placeholder value. * * auth: authClient, * }; * - * cloudResourceManager.organizations.get(request, function(err, response) - * { if (err) { console.error(err); return; + * cloudResourceManager.organizations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2963,10 +2497,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3042,25 +2575,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.getEffectiveOrgPolicy - * @desc Gets the effective `Policy` on a resource. This is the result of - * merging `Policies` in the resource hierarchy. The returned `Policy` will - * not have an `etag`set because it is a computed `Policy` across multiple - * resources. Subtrees of Resource Manager resource hierarchy with 'under:' - * prefix will not be expanded. + * @desc Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3069,9 +2596,8 @@ export namespace cloudresourcemanager_v1 { * * authorize(function(authClient) { * var request = { - * // The name of the resource to start computing the effective - * `Policy`. resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * // The name of the resource to start computing the effective `Policy`. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3080,8 +2606,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.getEffectiveOrgPolicy(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.getEffectiveOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3095,10 +2623,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3180,26 +2707,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.getIamPolicy - * @desc Gets the access control policy for an Organization resource. May be - * empty if no such policy or resource exists. The `resource` field should - * be the organization's resource name, e.g. "organizations/123". - * Authorization requires the Google IAM permission - * `resourcemanager.organizations.getIamPolicy` on the specified - * organization + * @desc Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123". Authorization requires the Google IAM permission `resourcemanager.organizations.getIamPolicy` on the specified organization * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3209,9 +2729,8 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3220,8 +2739,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.getIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3235,10 +2756,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3316,25 +2836,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.getOrgPolicy - * @desc Gets a `Policy` on a resource. If no `Policy` is set on the - * resource, a `Policy` is returned with default values including - * `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can - * be used with `SetOrgPolicy()` to create or update a `Policy` during - * read-modify-write. + * @desc Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3344,8 +2858,7 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // Name of the resource the `Policy` is set on. - * resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3354,8 +2867,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.getOrgPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.getOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3369,10 +2884,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3452,22 +2966,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints - * @desc Lists `Constraints` that could be applied on the specified - * resource. + * @desc Lists `Constraints` that could be applied on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3477,8 +2988,7 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // Name of the resource to list `Constraints` for. - * resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3498,20 +3008,17 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < constraintsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `constraintsPage`: console.log(JSON.stringify(constraintsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `constraintsPage`: + * console.log(JSON.stringify(constraintsPage[i], null, 2)); * } * * if (response.nextPageToken) { * request.resource.pageToken = response.nextPageToken; - * cloudResourceManager.organizations.listAvailableOrgPolicyConstraints(request, - * handlePage); + * cloudResourceManager.organizations.listAvailableOrgPolicyConstraints(request, handlePage); * } * }; * - * cloudResourceManager.organizations.listAvailableOrgPolicyConstraints(request, - * handlePage); + * cloudResourceManager.organizations.listAvailableOrgPolicyConstraints(request, handlePage); * }); * * function authorize(callback) { @@ -3520,16 +3027,14 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); * } - * @alias - * cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints + * @alias cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints * @memberOf! () * * @param {object} params Parameters for request @@ -3633,14 +3138,12 @@ export namespace cloudresourcemanager_v1 { * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3650,8 +3153,7 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // Name of the resource to list Policies for. - * resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3671,19 +3173,17 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < policiesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `policiesPage`: console.log(JSON.stringify(policiesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `policiesPage`: + * console.log(JSON.stringify(policiesPage[i], null, 2)); * } * * if (response.nextPageToken) { * request.resource.pageToken = response.nextPageToken; - * cloudResourceManager.organizations.listOrgPolicies(request, - * handlePage); + * cloudResourceManager.organizations.listOrgPolicies(request, handlePage); * } * }; * - * cloudResourceManager.organizations.listOrgPolicies(request, - * handlePage); + * cloudResourceManager.organizations.listOrgPolicies(request, handlePage); * }); * * function authorize(callback) { @@ -3692,10 +3192,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3779,25 +3278,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.search - * @desc Searches Organization resources that are visible to the user and - * satisfy the specified filter. This method returns Organizations in an - * unspecified order. New Organizations do not necessarily appear at the end - * of the results. Search will only return organizations on which the user - * has the permission `resourcemanager.organizations.get` + * @desc Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results. Search will only return organizations on which the user has the permission `resourcemanager.organizations.get` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3824,9 +3317,8 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < organizationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `organizationsPage`: console.log(JSON.stringify(organizationsPage[i], - * null, 2)); + * // TODO: Change code below to process each resource in `organizationsPage`: + * console.log(JSON.stringify(organizationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -3844,10 +3336,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3933,26 +3424,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.setIamPolicy - * @desc Sets the access control policy on an Organization resource. - * Replaces any existing policy. The `resource` field should be the - * organization's resource name, e.g. "organizations/123". Authorization - * requires the Google IAM permission - * `resourcemanager.organizations.setIamPolicy` on the specified - * organization + * @desc Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123". Authorization requires the Google IAM permission `resourcemanager.organizations.setIamPolicy` on the specified organization * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3962,9 +3446,8 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3973,8 +3456,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.setIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3988,10 +3473,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4069,24 +3553,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.setOrgPolicy - * @desc Updates the specified `Policy` on the resource. Creates a new - * `Policy` for that `Constraint` on the resource if one does not exist. Not - * supplying an `etag` on the request `Policy` results in an unconditional - * write of the `Policy`. + * @desc Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4096,8 +3575,7 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // Resource name of the resource to attach the `Policy`. - * resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -4106,8 +3584,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.setOrgPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.setOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4121,10 +3601,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4204,24 +3683,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.organizations.testIamPermissions - * @desc Returns permissions that a caller has on the specified - * Organization. The `resource` field should be the organization's resource - * name, e.g. "organizations/123". There are no permissions required for - * making this API call. + * @desc Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123". There are no permissions required for making this API call. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4230,11 +3704,9 @@ export namespace cloudresourcemanager_v1 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -4243,8 +3715,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.testIamPermissions(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4258,10 +3732,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4372,9 +3845,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Organization to fetch. This is the - * organization's relative path in the API, formatted as - * "organizations/[organizationId]". For example, "organizations/1234". + * The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234". */ name?: string; } @@ -4403,8 +3874,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4484,8 +3954,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4519,8 +3988,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4545,14 +4013,12 @@ export namespace cloudresourcemanager_v1 { * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4585,10 +4051,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4666,34 +4131,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.create - * @desc Request that a new Project be created. The result is an Operation - * which can be used to track the creation process. It is automatically - * deleted after a few hours, so there is no need to call DeleteOperation. - * Our SLO permits Project creation to take up to 30 seconds at the 90th - * percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile - * latency. 95th percentile latency is around 11 seconds. We recommend - * polling at the 5th second with an exponential backoff. Authorization - * requires the Google IAM permission `resourcemanager.projects.create` on - * the specified parent for the new project. The parent is identified by a - * specified ResourceId, which must include both an ID and a type, such as - * organization. This method does not associate the new project with a - * billing account. You can set or update the billing account associated - * with a project using the [`projects.updateBillingInfo`] - * (/billing/reference/rest/v1/projects/updateBillingInfo) method. + * @desc Request that a new Project be created. The result is an Operation which can be used to track the creation process. It is automatically deleted after a few hours, so there is no need to call DeleteOperation. Our SLO permits Project creation to take up to 30 seconds at the 90th percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th percentile latency is around 11 seconds. We recommend polling at the 5th second with an exponential backoff. Authorization requires the Google IAM permission `resourcemanager.projects.create` on the specified parent for the new project. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4726,10 +4176,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4804,31 +4253,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.delete - * @desc Marks the Project identified by the specified `project_id` (for - * example, `my-project-123`) for deletion. This method will only affect the - * Project if it has a lifecycle state of ACTIVE. This method changes the - * Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion - * starts at an unspecified time, at which point the Project is no longer - * accessible. Until the deletion completes, you can check the lifecycle - * state checked by retrieving the Project with GetProject, and the Project - * remains visible to ListProjects. However, you cannot update the project. - * After the deletion completes, the Project is not retrievable by the - * GetProject and ListProjects methods. The caller must have modify - * permissions for this Project. + * @desc Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4858,10 +4295,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4937,23 +4373,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.get - * @desc Retrieves the Project identified by the specified `project_id` (for - * example, `my-project-123`). The caller must have read permissions for - * this Project. + * @desc Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4986,10 +4418,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5065,23 +4496,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.getAncestry - * @desc Gets a list of ancestors in the resource hierarchy for the Project - * identified by the specified `project_id` (for example, `my-project-123`). - * The caller must have read permissions for this Project. + * @desc Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5101,8 +4528,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.projects.getAncestry(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.getAncestry(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5116,10 +4545,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5201,25 +4629,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.getEffectiveOrgPolicy - * @desc Gets the effective `Policy` on a resource. This is the result of - * merging `Policies` in the resource hierarchy. The returned `Policy` will - * not have an `etag`set because it is a computed `Policy` across multiple - * resources. Subtrees of Resource Manager resource hierarchy with 'under:' - * prefix will not be expanded. + * @desc Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5228,9 +4650,8 @@ export namespace cloudresourcemanager_v1 { * * authorize(function(authClient) { * var request = { - * // The name of the resource to start computing the effective - * `Policy`. resource_: 'projects/my-project', // TODO: Update placeholder - * value. + * // The name of the resource to start computing the effective `Policy`. + * resource_: 'projects/my-project', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -5239,8 +4660,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.projects.getEffectiveOrgPolicy(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.getEffectiveOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5254,10 +4677,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5339,26 +4761,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.getIamPolicy - * @desc Returns the IAM access control policy for the specified Project. - * Permission is denied if the policy or the resource does not exist. - * Authorization requires the Google IAM permission - * `resourcemanager.projects.getIamPolicy` on the project. For additional - * information about resource structure and identification, see [Resource - * Names](/apis/design/resource_names). + * @desc Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist. Authorization requires the Google IAM permission `resourcemanager.projects.getIamPolicy` on the project. For additional information about resource structure and identification, see [Resource Names](/apis/design/resource_names). * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5368,8 +4783,8 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'my-resource', // TODO: Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -5378,8 +4793,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.projects.getIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5393,10 +4810,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5474,25 +4890,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.getOrgPolicy - * @desc Gets a `Policy` on a resource. If no `Policy` is set on the - * resource, a `Policy` is returned with default values including - * `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can - * be used with `SetOrgPolicy()` to create or update a `Policy` during - * read-modify-write. + * @desc Gets a `Policy` on a resource. If no `Policy` is set on the resource, a `Policy` is returned with default values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with `SetOrgPolicy()` to create or update a `Policy` during read-modify-write. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5511,8 +4921,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.projects.getOrgPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.getOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5526,10 +4938,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5609,26 +5020,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.list - * @desc Lists Projects that are visible to the user and satisfy the - * specified filter. This method returns Projects in an unspecified order. - * This method is eventually consistent with project mutations; this means - * that a newly created project may not appear in the results or recent - * updates to an existing project may not be reflected in the results. To - * retrieve the latest state of a project, use the GetProject method. + * @desc Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavorial difference. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5651,8 +5055,8 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < projectsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `projectsPage`: console.log(JSON.stringify(projectsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `projectsPage`: + * console.log(JSON.stringify(projectsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -5670,10 +5074,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5682,7 +5085,7 @@ export namespace cloudresourcemanager_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:how*|The project's name starts with "how".| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. If you specify a filter that has both `parent.type` and `parent.id`, then the `resourcemanager.projects.list` permission is checked on the parent. If the user has this permission, all projects under the parent will be returned after remaining filters have been applied. If the user lacks this permission, then all projects for which the user has the `resourcemanager.projects.get` permission will be returned after remaining filters have been applied. If no filter is specified, the call will return projects for which the user has `resourcemanager.projects.get` permissions. Optional. + * @param {string=} params.filter An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big |The project's label `color` has the value `red` and its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results. Optional. * @param {integer=} params.pageSize The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional. * @param {string=} params.pageToken A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5752,22 +5155,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.listAvailableOrgPolicyConstraints - * @desc Lists `Constraints` that could be applied on the specified - * resource. + * @desc Lists `Constraints` that could be applied on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5797,20 +5197,17 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < constraintsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `constraintsPage`: console.log(JSON.stringify(constraintsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `constraintsPage`: + * console.log(JSON.stringify(constraintsPage[i], null, 2)); * } * * if (response.nextPageToken) { * request.resource.pageToken = response.nextPageToken; - * cloudResourceManager.projects.listAvailableOrgPolicyConstraints(request, - * handlePage); + * cloudResourceManager.projects.listAvailableOrgPolicyConstraints(request, handlePage); * } * }; * - * cloudResourceManager.projects.listAvailableOrgPolicyConstraints(request, - * handlePage); + * cloudResourceManager.projects.listAvailableOrgPolicyConstraints(request, handlePage); * }); * * function authorize(callback) { @@ -5819,10 +5216,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5931,14 +5327,12 @@ export namespace cloudresourcemanager_v1 { * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5968,8 +5362,8 @@ export namespace cloudresourcemanager_v1 { * return; * } * for (var i = 0; i < policiesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `policiesPage`: console.log(JSON.stringify(policiesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `policiesPage`: + * console.log(JSON.stringify(policiesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -5987,10 +5381,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6074,49 +5467,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.setIamPolicy - * @desc Sets the IAM access control policy for the specified Project. - * Overwrites any existing policy. The following constraints apply when - * using `setIamPolicy()`: + Project does not support `allUsers` and - * `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The - * owner role can be granted only to `user` and `serviceAccount`. + Service - * accounts can be made owners of a project directly without any - * restrictions. However, to be added as an owner, a user must be invited - * via Cloud Platform console and must accept the invitation. + A user - * cannot be granted the owner role using `setIamPolicy()`. The user must be - * granted the owner role using the Cloud Platform Console and must - * explicitly accept the invitation. + You can only grant ownership of a - * project to a member by using the GCP Console. Inviting a member will - * deliver an invitation email that they must accept. An invitation email is - * not generated if you are granting a role other than owner, or if both the - * member you are inviting and the project are part of your organization. + - * Membership changes that leave the project without any owners that have - * accepted the Terms of Service (ToS) will be rejected. + If the project - * is not part of an organization, there must be at least one owner who has - * accepted the Terms of Service (ToS) agreement in the policy. Calling - * `setIamPolicy()` to remove the last ToS-accepted owner from the policy - * will fail. This restriction also applies to legacy projects that no - * longer have owners who have accepted the ToS. Edits to IAM policies will - * be rejected until the lack of a ToS-accepting owner is rectified. + This - * method will replace the existing policy, and cannot be used to append - * additional IAM settings. Note: Removing service accounts from policies - * or changing their roles can render services completely inoperable. It is - * important to understand how the service account is being used before - * removing or updating its roles. Authorization requires the Google IAM - * permission `resourcemanager.projects.setIamPolicy` on the project + * @desc Sets the IAM access control policy for the specified Project. Overwrites any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + You can only grant ownership of a project to a member by using the GCP Console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. Authorization requires the Google IAM permission `resourcemanager.projects.setIamPolicy` on the project * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6126,8 +5489,8 @@ export namespace cloudresourcemanager_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'my-resource', // TODO: Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -6136,8 +5499,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.projects.setIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6151,10 +5516,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6232,24 +5596,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.setOrgPolicy - * @desc Updates the specified `Policy` on the resource. Creates a new - * `Policy` for that `Constraint` on the resource if one does not exist. Not - * supplying an `etag` on the request `Policy` results in an unconditional - * write of the `Policy`. + * @desc Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on the resource if one does not exist. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6268,8 +5627,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.projects.setOrgPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.setOrgPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6283,10 +5644,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6366,22 +5726,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.testIamPermissions - * @desc Returns permissions that a caller has on the specified Project. - * There are no permissions required for making this API call. + * @desc Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6390,10 +5747,9 @@ export namespace cloudresourcemanager_v1 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'my-resource', // TODO: Update placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -6402,8 +5758,10 @@ export namespace cloudresourcemanager_v1 { * auth: authClient, * }; * - * cloudResourceManager.projects.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6417,10 +5775,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6506,25 +5863,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.undelete - * @desc Restores the Project identified by the specified `project_id` (for - * example, `my-project-123`). You can only use this method for a Project - * that has a lifecycle state of DELETE_REQUESTED. After deletion starts, - * the Project cannot be restored. The caller must have modify permissions - * for this Project. + * @desc Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6558,10 +5909,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6639,23 +5989,19 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.update - * @desc Updates the attributes of the Project identified by the specified - * `project_id` (for example, `my-project-123`). The caller must have - * modify permissions for this Project. + * @desc Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6669,8 +6015,7 @@ export namespace cloudresourcemanager_v1 { * projectId: 'my-project-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -6694,10 +6039,9 @@ export namespace cloudresourcemanager_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6865,8 +6209,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6899,36 +6242,15 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An expression for filtering the results of the request. Filter rules are - * case insensitive. The fields eligible for filtering are: + `name` + `id` - * + labels.key where *key* is the name of a label - * Some examples of using labels as filters: |Filter|Description| - * |------|-----------| |name:how*|The project's name starts with "how".| - * |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent - * to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project - * has the label `color`.| |labels.color:red|The project's label `color` has - * the value `red`.| |labels.color:red labels.size:big|The project's - * label `color` has the value `red` and its label `size` has the value - * `big`. If you specify a filter that has both `parent.type` and - * `parent.id`, then the `resourcemanager.projects.list` permission is - * checked on the parent. If the user has this permission, all projects - * under the parent will be returned after remaining filters have been - * applied. If the user lacks this permission, then all projects for which - * the user has the `resourcemanager.projects.get` permission will be - * returned after remaining filters have been applied. If no filter is - * specified, the call will return projects for which the user has - * `resourcemanager.projects.get` permissions. Optional. + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big |The project's label `color` has the value `red` and its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results. Optional. */ filter?: string; /** - * The maximum number of Projects to return in the response. The server can - * return fewer Projects than requested. If unspecified, server picks an - * appropriate default. Optional. + * The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to ListProjects that - * indicates from where listing should continue. Optional. + * A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional. */ pageToken?: string; } @@ -6974,8 +6296,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -7009,8 +6330,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index c26e149ee16..f96881ab22c 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudresourcemanager_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudresourcemanager_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudresourcemanager_v1beta1 { /** * Cloud Resource Manager API * - * Creates, reads, and updates metadata for Google Cloud Platform resource - * containers. + * Creates, reads, and updates metadata for Google Cloud Platform resource containers. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace cloudresourcemanager_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.organizations = new Resource$Organizations(this.context); this.projects = new Resource$Projects(this.context); @@ -131,27 +129,7 @@ export namespace cloudresourcemanager_v1beta1 { resourceId?: Schema$ResourceId; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -159,25 +137,16 @@ export namespace cloudresourcemanager_v1beta1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -190,67 +159,40 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -259,8 +201,7 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$FolderOperation { /** - * The resource name of the folder or organization we are either creating - * the folder under or moving the folder to. + * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ destinationParent?: string; /** @@ -272,8 +213,7 @@ export namespace cloudresourcemanager_v1beta1 { */ operationType?: string; /** - * The resource name of the folder's parent. Only applicable when the - * operation_type is MOVE. + * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ sourceParent?: string; } @@ -295,9 +235,7 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$GetAncestryResponse { /** - * Ancestors are ordered from bottom to top of the resource hierarchy. The - * first ancestor is the project itself, followed by the project's - * parent, etc. + * Ancestors are ordered from bottom to top of the resource hierarchy. The first ancestor is the project itself, followed by the project's parent, etc. */ ancestor?: Schema$Ancestor[]; } @@ -310,89 +248,58 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$ListOrganizationsResponse { /** - * A pagination token to be used to retrieve the next page of results. If - * the result is too large to fit within the page size specified in the - * request, this field will be set with a token that can be used to fetch - * the next page of results. If this field is empty, it indicates that this - * response contains the last page of results. + * A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results. */ nextPageToken?: string; /** - * The list of Organizations that matched the list query, possibly - * paginated. + * The list of Organizations that matched the list query, possibly paginated. */ organizations?: Schema$Organization[]; } /** - * A page of the response received from the ListProjects method. A paginated - * response where more pages are available has `next_page_token` set. This - * token can be used in a subsequent request to retrieve the next request - * page. + * A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page. */ export interface Schema$ListProjectsResponse { /** - * Pagination token. If the result set is too large to fit in a single - * response, this token is returned. It encodes the position of the current - * result cursor. Feeding this value into a new list request with the - * `page_token` parameter gives the next page of the results. When - * `next_page_token` is not filled in, there is no next page and the list - * returned is the last page in the result set. Pagination tokens have a - * limited lifetime. + * Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. */ nextPageToken?: string; /** - * The list of Projects that matched the list filter. This list can be - * paginated. + * The list of Projects that matched the list filter. This list can be paginated. */ projects?: Schema$Project[]; } /** - * The root node in the resource hierarchy to which a particular entity's - * (e.g., company) resources belong. + * The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong. */ export interface Schema$Organization { /** - * Timestamp when the Organization was created. Assigned by the server. - * @OutputOnly + * Timestamp when the Organization was created. Assigned by the server. @OutputOnly */ creationTime?: string; /** - * A human-readable string that refers to the Organization in the GCP - * Console UI. This string is set by the server and cannot be changed. The - * string will be set to the primary domain (for example, - * "google.com") of the G Suite customer that owns the - * organization. @OutputOnly + * A human-readable string that refers to the Organization in the GCP Console UI. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the G Suite customer that owns the organization. @OutputOnly */ displayName?: string; /** - * The organization's current lifecycle state. Assigned by the server. - * @OutputOnly + * The organization's current lifecycle state. Assigned by the server. @OutputOnly */ lifecycleState?: string; /** - * Output Only. The resource name of the organization. This is the - * organization's relative path in the API. Its format is - * "organizations/[organization_id]". For example, - * "organizations/1234". + * Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". */ name?: string; /** - * An immutable id for the Organization that is assigned on creation. This - * should be omitted when creating a new Organization. This field is - * read-only. + * An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. */ organizationId?: string; /** - * The owner of this Organization. The owner should be specified on - * creation. Once set, it cannot be changed. This field is required. + * The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required. */ owner?: Schema$OrganizationOwner; } /** - * The entity that owns an Organization. The lifetime of the Organization and - * all of its descendants are bound to the `OrganizationOwner`. If the - * `OrganizationOwner` is deleted, the Organization and all its descendants - * will be deleted. + * The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. */ export interface Schema$OrganizationOwner { /** @@ -401,24 +308,7 @@ export namespace cloudresourcemanager_v1beta1 { directoryCustomerId?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -426,20 +316,11 @@ export namespace cloudresourcemanager_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -448,9 +329,7 @@ export namespace cloudresourcemanager_v1beta1 { version?: number; } /** - * A Project is a high-level Google Cloud Platform entity. It is a container - * for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform - * resources. + * A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. */ export interface Schema$Project { /** @@ -458,16 +337,7 @@ export namespace cloudresourcemanager_v1beta1 { */ createTime?: string; /** - * The labels associated with this Project. Label keys must be between 1 - * and 63 characters long and must conform to the following regular - * expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be - * between 0 and 63 characters long and must conform to the regular - * expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label value can be - * empty. No more than 256 labels can be associated with a given resource. - * Clients should store labels in a representation such as JSON that does - * not depend on specific characters being disallowed. Example: - * <code>"environment" : "dev"</code> - * Read-write. + * The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: <code>"environment" : "dev"</code> Read-write. */ labels?: {[key: string]: string}; /** @@ -475,38 +345,24 @@ export namespace cloudresourcemanager_v1beta1 { */ lifecycleState?: string; /** - * The optional user-assigned display name of the Project. When present it - * must be between 4 to 30 characters. Allowed characters are: lowercase and - * uppercase letters, numbers, hyphen, single-quote, double-quote, space, - * and exclamation point. Example: <code>My Project</code> - * Read-write. + * The optional user-assigned display name of the Project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: <code>My Project</code> Read-write. */ name?: string; /** - * An optional reference to a parent Resource. Supported parent types - * include "organization" and "folder". Once set, the - * parent cannot be cleared. The `parent` can be set on creation or using - * the `UpdateProject` method; the end user must have the - * `resourcemanager.projects.create` permission on the parent. Read-write. + * An optional reference to a parent Resource. Supported parent types include "organization" and "folder". Once set, the parent cannot be cleared. The `parent` can be set on creation or using the `UpdateProject` method; the end user must have the `resourcemanager.projects.create` permission on the parent. Read-write. */ parent?: Schema$ResourceId; /** - * The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase - * letters, digits, or hyphens. It must start with a letter. Trailing - * hyphens are prohibited. Example: <code>tokyo-rain-123</code> - * Read-only after creation. + * The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: <code>tokyo-rain-123</code> Read-only after creation. */ projectId?: string; /** - * The number uniquely identifying the project. Example: - * <code>415104041262</code> Read-only. + * The number uniquely identifying the project. Example: <code>415104041262</code> Read-only. */ projectNumber?: string; } /** - * A status object which is used as the `metadata` field for the Operation - * returned by CreateProject. It provides insight for when significant phases - * of Project creation have completed. + * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. */ export interface Schema$ProjectCreationStatus { /** @@ -514,9 +370,7 @@ export namespace cloudresourcemanager_v1beta1 { */ createTime?: string; /** - * True if the project can be retrieved using GetProject. No other - * operations on the project are guaranteed to work until the project - * creation is complete. + * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ gettable?: boolean; /** @@ -525,21 +379,15 @@ export namespace cloudresourcemanager_v1beta1 { ready?: boolean; } /** - * A container to reference an id for any resource type. A `resource` in - * Google Cloud Platform is a generic term for something you (a developer) may - * want to interact with through one of our API's. Some examples are an - * App Engine app, a Compute Engine instance, a Cloud SQL database, and so on. + * A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on. */ export interface Schema$ResourceId { /** - * Required field for the type-specific id. This should correspond to the id - * used in the type-specific API's. + * Required field for the type-specific id. This should correspond to the id used in the type-specific API's. */ id?: string; /** - * Required field representing the resource type this id is for. At present, - * the valid types are "project", "folder", and - * "organization". + * Required field representing the resource type this id is for. At present, the valid types are "project", "folder", and "organization". */ type?: string; } @@ -548,17 +396,11 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -567,10 +409,7 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -579,8 +418,7 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -597,22 +435,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.organizations.get - * @desc Fetches an Organization resource identified by the specified - * resource name. + * @desc Fetches an Organization resource identified by the specified resource name. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -621,15 +456,16 @@ export namespace cloudresourcemanager_v1beta1 { * * authorize(function(authClient) { * var request = { - * // The resource name of the Organization to fetch, e.g. - * "organizations/1234". name: 'organizations/my-organization', // TODO: - * Update placeholder value. + * // The resource name of the Organization to fetch, e.g. "organizations/1234". + * name: 'organizations/my-organization', // TODO: Update placeholder value. * * auth: authClient, * }; * - * cloudResourceManager.organizations.get(request, function(err, response) - * { if (err) { console.error(err); return; + * cloudResourceManager.organizations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -643,10 +479,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -723,23 +558,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.organizations.getIamPolicy - * @desc Gets the access control policy for an Organization resource. May be - * empty if no such policy or resource exists. The `resource` field should - * be the organization's resource name, e.g. "organizations/123". + * @desc Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123". * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -749,9 +580,8 @@ export namespace cloudresourcemanager_v1beta1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -760,8 +590,10 @@ export namespace cloudresourcemanager_v1beta1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.getIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -775,10 +607,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -856,24 +687,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.organizations.list - * @desc Lists Organization resources that are visible to the user and - * satisfy the specified filter. This method returns Organizations in an - * unspecified order. New Organizations do not necessarily appear at the end - * of the list. + * @desc Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -896,9 +722,8 @@ export namespace cloudresourcemanager_v1beta1 { * return; * } * for (var i = 0; i < organizationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `organizationsPage`: console.log(JSON.stringify(organizationsPage[i], - * null, 2)); + * // TODO: Change code below to process each resource in `organizationsPage`: + * console.log(JSON.stringify(organizationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -916,10 +741,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1007,23 +831,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.organizations.setIamPolicy - * @desc Sets the access control policy on an Organization resource. - * Replaces any existing policy. The `resource` field should be the - * organization's resource name, e.g. "organizations/123". + * @desc Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123". * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1033,9 +853,8 @@ export namespace cloudresourcemanager_v1beta1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1044,8 +863,10 @@ export namespace cloudresourcemanager_v1beta1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.setIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1059,10 +880,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1140,23 +960,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.organizations.testIamPermissions - * @desc Returns permissions that a caller has on the specified - * Organization. The `resource` field should be the organization's resource - * name, e.g. "organizations/123". + * @desc Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123". * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1165,11 +981,9 @@ export namespace cloudresourcemanager_v1beta1 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'organizations/my-organization', // TODO: Update - * placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1178,8 +992,10 @@ export namespace cloudresourcemanager_v1beta1 { * auth: authClient, * }; * - * cloudResourceManager.organizations.testIamPermissions(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1193,10 +1009,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1283,22 +1098,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.organizations.update - * @desc Updates an Organization resource identified by the specified - * resource name. + * @desc Updates an Organization resource identified by the specified resource name. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1309,21 +1121,21 @@ export namespace cloudresourcemanager_v1beta1 { * var request = { * // Output Only. The resource name of the organization. This is the * // organization's relative path in the API. Its format is - * // "organizations/[organization_id]". For example, - * "organizations/1234". name: 'organizations/my-organization', // TODO: - * Update placeholder value. + * // "organizations/[organization_id]". For example, "organizations/1234". + * name: 'organizations/my-organization', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * * auth: authClient, * }; * - * cloudResourceManager.organizations.update(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.organizations.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1337,10 +1149,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1424,14 +1235,11 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Organization to fetch. This is the - * organization's relative path in the API, formatted as - * "organizations/[organizationId]". For example, "organizations/1234". + * The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234". */ name?: string; /** - * The id of the Organization resource to fetch. This field is deprecated - * and will be removed in v1. Use name instead. + * The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead. */ organizationId?: string; } @@ -1443,8 +1251,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1461,25 +1268,15 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional query string used to filter the Organizations to return in - * the response. Filter rules are case-insensitive. Organizations may be - * filtered by `owner.directoryCustomerId` or by `domain`, where the domain - * is a G Suite domain, for example: |Filter|Description| - * |------|-----------| |owner.directorycustomerid:123456789|Organizations - * with `owner.directory_customer_id` equal to `123456789`.| - * |domain:google.com|Organizations corresponding to the domain - * `google.com`.| This field is optional. + * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional. */ filter?: string; /** - * The maximum number of Organizations to return in the response. This field - * is optional. + * The maximum number of Organizations to return in the response. This field is optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to `ListOrganizations` - * that indicates from where listing should continue. This field is - * optional. + * A pagination token returned from a previous call to `ListOrganizations` that indicates from where listing should continue. This field is optional. */ pageToken?: string; } @@ -1491,8 +1288,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1509,8 +1305,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1527,9 +1322,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output Only. The resource name of the organization. This is the - * organization's relative path in the API. Its format is - * "organizations/[organization_id]". For example, "organizations/1234". + * Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". */ name?: string; @@ -1547,30 +1340,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.create - * @desc Creates a Project resource. Initially, the Project resource is - * owned by its creator exclusively. The creator can later grant permission - * to others to read or update the Project. Several APIs are activated - * automatically for the Project, including Google Cloud Storage. The parent - * is identified by a specified ResourceId, which must include both an ID - * and a type, such as project, folder, or organization. This method does - * not associate the new project with a billing account. You can set or - * update the billing account associated with a project using the - * [`projects.updateBillingInfo`] - * (/billing/reference/rest/v1/projects/updateBillingInfo) method. + * @desc Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as project, folder, or organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1603,10 +1385,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1680,31 +1461,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.delete - * @desc Marks the Project identified by the specified `project_id` (for - * example, `my-project-123`) for deletion. This method will only affect the - * Project if it has a lifecycle state of ACTIVE. This method changes the - * Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion - * starts at an unspecified time, at which point the project is no longer - * accessible. Until the deletion completes, you can check the lifecycle - * state checked by retrieving the Project with GetProject, and the Project - * remains visible to ListProjects. However, you cannot update the project. - * After the deletion completes, the Project is not retrievable by the - * GetProject and ListProjects methods. The caller must have modify - * permissions for this Project. + * @desc Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1734,10 +1503,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1813,23 +1581,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.get - * @desc Retrieves the Project identified by the specified `project_id` (for - * example, `my-project-123`). The caller must have read permissions for - * this Project. + * @desc Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1862,10 +1626,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1941,23 +1704,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.getAncestry - * @desc Gets a list of ancestors in the resource hierarchy for the Project - * identified by the specified `project_id` (for example, `my-project-123`). - * The caller must have read permissions for this Project. + * @desc Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1977,8 +1736,10 @@ export namespace cloudresourcemanager_v1beta1 { * auth: authClient, * }; * - * cloudResourceManager.projects.getAncestry(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.getAncestry(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1992,10 +1753,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2076,24 +1836,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.getIamPolicy - * @desc Returns the IAM access control policy for the specified Project. - * Permission is denied if the policy or the resource does not exist. For - * additional information about resource structure and identification, see - * [Resource Names](/apis/design/resource_names). + * @desc Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist. For additional information about resource structure and identification, see [Resource Names](/apis/design/resource_names). * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2103,8 +1858,8 @@ export namespace cloudresourcemanager_v1beta1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'my-resource', // TODO: Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2113,8 +1868,10 @@ export namespace cloudresourcemanager_v1beta1 { * auth: authClient, * }; * - * cloudResourceManager.projects.getIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2128,10 +1885,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2208,26 +1964,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.list - * @desc Lists Projects that are visible to the user and satisfy the - * specified filter. This method returns Projects in an unspecified order. - * This method is eventually consistent with project mutations; this means - * that a newly created project may not appear in the results or recent - * updates to an existing project may not be reflected in the results. To - * retrieve the latest state of a project, use the GetProjectmethod. + * @desc Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavorial difference. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2250,8 +1999,8 @@ export namespace cloudresourcemanager_v1beta1 { * return; * } * for (var i = 0; i < projectsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `projectsPage`: console.log(JSON.stringify(projectsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `projectsPage`: + * console.log(JSON.stringify(projectsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2269,10 +2018,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2281,7 +2029,7 @@ export namespace cloudresourcemanager_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:how*|The project's name starts with "how".| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. If you specify a filter that has both `parent.type` and `parent.id`, then the `resourcemanager.projects.list` permission is checked on the parent. If the user has this permission, all projects under the parent will be returned after remaining filters have been applied. If the user lacks this permission, then all projects for which the user has the `resourcemanager.projects.get` permission will be returned after remaining filters have been applied. If no filter is specified, the call will return projects for which the user has `resourcemanager.projects.get` permissions. Optional. + * @param {string=} params.filter An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big |The project's label `color` has the value `red` and its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results. Optional. * @param {integer=} params.pageSize The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional. * @param {string=} params.pageToken A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2351,45 +2099,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.setIamPolicy - * @desc Sets the IAM access control policy for the specified Project. - * Overwrites any existing policy. The following constraints apply when - * using `setIamPolicy()`: + Project does not support `allUsers` and - * `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The - * owner role can be granted only to `user` and `serviceAccount`. + Service - * accounts can be made owners of a project directly without any - * restrictions. However, to be added as an owner, a user must be invited - * via Cloud Platform console and must accept the invitation. + A user - * cannot be granted the owner role using `setIamPolicy()`. The user must be - * granted the owner role using the Cloud Platform Console and must - * explicitly accept the invitation. + Invitations to grant the owner role - * cannot be sent using `setIamPolicy()`; they must be sent only using the - * Cloud Platform Console. + Membership changes that leave the project - * without any owners that have accepted the Terms of Service (ToS) will be - * rejected. + If the project is not part of an organization, there must be - * at least one owner who has accepted the Terms of Service (ToS) agreement - * in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted - * owner from the policy will fail. This restriction also applies to legacy - * projects that no longer have owners who have accepted the ToS. Edits to - * IAM policies will be rejected until the lack of a ToS-accepting owner is - * rectified. + This method will replace the existing policy, and cannot be - * used to append additional IAM settings. Note: Removing service accounts - * from policies or changing their roles can render services completely - * inoperable. It is important to understand how the service account is - * being used before removing or updating its roles. + * @desc Sets the IAM access control policy for the specified Project. Overwrites any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2399,8 +2121,8 @@ export namespace cloudresourcemanager_v1beta1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'my-resource', // TODO: Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2409,8 +2131,10 @@ export namespace cloudresourcemanager_v1beta1 { * auth: authClient, * }; * - * cloudResourceManager.projects.setIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2424,10 +2148,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2511,14 +2234,12 @@ export namespace cloudresourcemanager_v1beta1 { * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2527,10 +2248,9 @@ export namespace cloudresourcemanager_v1beta1 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'my-resource', // TODO: Update placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2539,8 +2259,10 @@ export namespace cloudresourcemanager_v1beta1 { * auth: authClient, * }; * - * cloudResourceManager.projects.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudResourceManager.projects.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2554,10 +2276,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2643,25 +2364,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.undelete - * @desc Restores the Project identified by the specified `project_id` (for - * example, `my-project-123`). You can only use this method for a Project - * that has a lifecycle state of DELETE_REQUESTED. After deletion starts, - * the Project cannot be restored. The caller must have modify permissions - * for this Project. + * @desc Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2695,10 +2410,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2776,23 +2490,19 @@ export namespace cloudresourcemanager_v1beta1 { /** * cloudresourcemanager.projects.update - * @desc Updates the attributes of the Project identified by the specified - * `project_id` (for example, `my-project-123`). The caller must have - * modify permissions for this Project. + * @desc Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2806,8 +2516,7 @@ export namespace cloudresourcemanager_v1beta1 { * projectId: 'my-project-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -2831,10 +2540,9 @@ export namespace cloudresourcemanager_v1beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2973,8 +2681,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2990,36 +2697,15 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An expression for filtering the results of the request. Filter rules are - * case insensitive. The fields eligible for filtering are: + `name` + `id` - * + labels.key where *key* is the name of a label - * Some examples of using labels as filters: |Filter|Description| - * |------|-----------| |name:how*|The project's name starts with "how".| - * |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent - * to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project - * has the label `color`.| |labels.color:red|The project's label `color` has - * the value `red`.| |labels.color:red labels.size:big|The project's - * label `color` has the value `red` and its label `size` has the value - * `big`. If you specify a filter that has both `parent.type` and - * `parent.id`, then the `resourcemanager.projects.list` permission is - * checked on the parent. If the user has this permission, all projects - * under the parent will be returned after remaining filters have been - * applied. If the user lacks this permission, then all projects for which - * the user has the `resourcemanager.projects.get` permission will be - * returned after remaining filters have been applied. If no filter is - * specified, the call will return projects for which the user has - * `resourcemanager.projects.get` permissions. Optional. + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big |The project's label `color` has the value `red` and its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results. Optional. */ filter?: string; /** - * The maximum number of Projects to return in the response. The server can - * return fewer Projects than requested. If unspecified, server picks an - * appropriate default. Optional. + * The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to ListProjects that - * indicates from where listing should continue. Optional. + * A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional. */ pageToken?: string; } @@ -3031,8 +2717,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3049,8 +2734,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 4960ec50881..3c448d762f7 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudresourcemanager_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudresourcemanager_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudresourcemanager_v2 { /** * Cloud Resource Manager API * - * Creates, reads, and updates metadata for Google Cloud Platform resource - * containers. + * Creates, reads, and updates metadata for Google Cloud Platform resource containers. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace cloudresourcemanager_v2 { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.folders = new Resource$Folders(this.context); this.operations = new Resource$Operations(this.context); @@ -122,27 +120,7 @@ export namespace cloudresourcemanager_v2 { } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -150,25 +128,16 @@ export namespace cloudresourcemanager_v2 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -181,94 +150,61 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * A Folder in an Organization's resource hierarchy, used to organize that - * Organization's resources. + * A Folder in an Organization's resource hierarchy, used to organize that Organization's resources. */ export interface Schema$Folder { /** - * Output only. Timestamp when the Folder was created. Assigned by the - * server. + * Output only. Timestamp when the Folder was created. Assigned by the server. */ createTime?: string; /** - * The folder’s display name. A folder’s display name must be unique amongst - * its siblings, e.g. no two folders with the same parent can share the same - * display name. The display name must start and end with a letter or digit, - * may contain letters, digits, spaces, hyphens and underscores and can be - * no longer than 30 characters. This is captured by the regular expression: - * [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. + * The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. */ displayName?: string; /** - * Output only. The lifecycle state of the folder. Updates to the - * lifecycle_state must be performed via DeleteFolder and UndeleteFolder. + * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ lifecycleState?: string; /** - * Output only. The resource name of the Folder. Its format is - * `folders/{folder_id}`, for example: "folders/1234". + * Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */ name?: string; /** - * The Folder’s parent's resource name. Updates to the folder's - * parent must be performed via MoveFolder. + * The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ parent?: string; } @@ -277,8 +213,7 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$FolderOperation { /** - * The resource name of the folder or organization we are either creating - * the folder under or moving the folder to. + * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ destinationParent?: string; /** @@ -290,8 +225,7 @@ export namespace cloudresourcemanager_v2 { */ operationType?: string; /** - * The resource name of the folder's parent. Only applicable when the - * operation_type is MOVE. + * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ sourceParent?: string; } @@ -313,13 +247,11 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$ListFoldersResponse { /** - * A possibly paginated list of Folders that are direct descendants of the - * specified parent resource. + * A possibly paginated list of Folders that are direct descendants of the specified parent resource. */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `ListFolders` that - * indicates from where listing should continue. This field is optional. + * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. This field is optional. */ nextPageToken?: string; } @@ -328,21 +260,16 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$MoveFolderRequest { /** - * The resource name of the Folder or Organization to reparent the folder - * under. Must be of the form `folders/{folder_id}` or - * `organizations/{org_id}`. + * The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ destinationParent?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -350,48 +277,20 @@ export namespace cloudresourcemanager_v2 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -399,20 +298,11 @@ export namespace cloudresourcemanager_v2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -421,9 +311,7 @@ export namespace cloudresourcemanager_v2 { version?: number; } /** - * A status object which is used as the `metadata` field for the Operation - * returned by CreateProject. It provides insight for when significant phases - * of Project creation have completed. + * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. */ export interface Schema$ProjectCreationStatus { /** @@ -431,9 +319,7 @@ export namespace cloudresourcemanager_v2 { */ createTime?: string; /** - * True if the project can be retrieved using GetProject. No other - * operations on the project are guaranteed to work until the project - * creation is complete. + * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ gettable?: boolean; /** @@ -446,31 +332,15 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$SearchFoldersRequest { /** - * The maximum number of folders to return in the response. This field is - * optional. + * The maximum number of folders to return in the response. This field is optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to `SearchFolders` that - * indicates from where search should continue. This field is optional. + * A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. This field is optional. */ pageToken?: string; /** - * Search criteria used to select the Folders to return. If no search - * criteria is specified then all accessible folders will be returned. Query - * expressions can be used to restrict results based upon displayName, - * lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` - * can be used along with the suffix wildcard symbol `*`. The displayName - * field in a query expression should use escaped quotes for values that - * include whitespace to prevent unexpected behavior. Some example queries - * are: |Query | Description| |----- | -----------| |displayName=Test* | - * Folders whose display name starts with "Test".| - * |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.| - * |parent=folders/123 | Folders whose parent is "folders/123".| - * |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose - * parent is "folders/123".| |displayName=\\"Test - * String\\"|Folders whose display name includes both "Test" - * and "String".| + * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: |Query | Description| |----- | -----------| |displayName=Test* | Folders whose display name starts with "Test".| |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.| |parent=folders/123 | Folders whose parent is "folders/123".| |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent is "folders/123".| |displayName=\\"Test String\\"|Folders whose display name includes both "Test" and "String".| */ query?: string; } @@ -479,13 +349,11 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$SearchFoldersResponse { /** - * A possibly paginated folder search results. the specified parent - * resource. + * A possibly paginated folder search results. the specified parent resource. */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `SearchFolders` that - * indicates from where searching should continue. This field is optional. + * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. This field is optional. */ nextPageToken?: string; } @@ -494,55 +362,16 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -550,14 +379,11 @@ export namespace cloudresourcemanager_v2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -566,10 +392,7 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -578,8 +401,7 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -596,24 +418,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.create - * @desc Creates a Folder in the resource hierarchy. Returns an Operation - * which can be used to track the progress of the folder creation workflow. - * Upon success the Operation.response field will be populated with the - * created Folder. In order to succeed, the addition of this new Folder - * must not violate the Folder naming, height or fanout constraints. + The - * Folder's display_name must be distinct from all other Folder's that share - * its parent. + The addition of the Folder must not cause the active Folder - * hierarchy to exceed a height of 4. Note, the full active + deleted Folder - * hierarchy is allowed to reach a height of 8; this provides additional - * headroom when moving folders that contain deleted folders. + The addition - * of the Folder must not cause the total number of Folders under its parent - * to exceed 100. If the operation fails due to a folder constraint - * violation, some errors may be returned by the CreateFolder request, with - * status code FAILED_PRECONDITION and an error description. Other folder - * constraint violations will be communicated in the Operation, with the - * specific PreconditionFailure returned via the details list in the - * Operation.error field. The caller must have - * `resourcemanager.folders.create` permission on the identified parent. + * @desc Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 100. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent. * @alias cloudresourcemanager.folders.create * @memberOf! () * @@ -685,12 +490,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.delete - * @desc Requests deletion of a Folder. The Folder is moved into the - * DELETE_REQUESTED state immediately, and is deleted approximately 30 days - * later. This method may only be called on an empty Folder in the ACTIVE - * state, where a Folder is empty if it doesn't contain any Folders or - * Projects in the ACTIVE state. The caller must have - * `resourcemanager.folders.delete` permission on the identified folder. + * @desc Requests deletion of a Folder. The Folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty Folder in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. The caller must have `resourcemanager.folders.delete` permission on the identified folder. * @alias cloudresourcemanager.folders.delete * @memberOf! () * @@ -759,10 +559,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.get - * @desc Retrieves a Folder identified by the supplied resource name. Valid - * Folder resource names have the format `folders/{folder_id}` (for example, - * `folders/1234`). The caller must have `resourcemanager.folders.get` - * permission on the identified folder. + * @desc Retrieves a Folder identified by the supplied resource name. Valid Folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder. * @alias cloudresourcemanager.folders.get * @memberOf! () * @@ -831,11 +628,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.getIamPolicy - * @desc Gets the access control policy for a Folder. The returned policy - * may be empty if no such policy or resource exists. The `resource` field - * should be the Folder's resource name, e.g. "folders/1234". The caller - * must have `resourcemanager.folders.getIamPolicy` permission on the - * identified folder. + * @desc Gets the access control policy for a Folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the Folder's resource name, e.g. "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder. * @alias cloudresourcemanager.folders.getIamPolicy * @memberOf! () * @@ -909,12 +702,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.list - * @desc Lists the Folders that are direct descendants of supplied parent - * resource. List provides a strongly consistent view of the Folders - * underneath the specified parent resource. List returns Folders sorted - * based upon the (ascending) lexical ordering of their display_name. The - * caller must have `resourcemanager.folders.list` permission on the - * identified parent. + * @desc Lists the Folders that are direct descendants of supplied parent resource. List provides a strongly consistent view of the Folders underneath the specified parent resource. List returns Folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent. * @alias cloudresourcemanager.folders.list * @memberOf! () * @@ -988,19 +776,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.move - * @desc Moves a Folder under a new resource parent. Returns an Operation - * which can be used to track the progress of the folder move workflow. Upon - * success the Operation.response field will be populated with the moved - * Folder. Upon failure, a FolderOperationError categorizing the failure - * cause will be returned - if the failure occurs synchronously then the - * FolderOperationError will be returned via the Status.details field and if - * it occurs asynchronously then the FolderOperation will be returned via - * the Operation.error field. In addition, the Operation.metadata field will - * be populated with a FolderOperation message as an aid to stateless - * clients. Folder moves will be rejected if they violate either the naming, - * height or fanout constraints described in the CreateFolder documentation. - * The caller must have `resourcemanager.folders.move` permission on the - * folder's current and proposed new parent. + * @desc Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent. * @alias cloudresourcemanager.folders.move * @memberOf! () * @@ -1072,17 +848,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.patch - * @desc Updates a Folder, changing its display_name. Changes to the folder - * display_name will be rejected if they violate either the display_name - * formatting rules or naming constraints described in the CreateFolder - * documentation. The Folder's display name must start and end with a - * letter or digit, may contain letters, digits, spaces, hyphens and - * underscores and can be no longer than 30 characters. This is captured by - * the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. - * The caller must have `resourcemanager.folders.update` permission on the - * identified folder. If the update fails due to the unique name constraint - * then a PreconditionFailure explaining this violation will be returned in - * the Status.details field. + * @desc Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field. * @alias cloudresourcemanager.folders.patch * @memberOf! () * @@ -1153,11 +919,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.search - * @desc Search for folders that match specific filter criteria. Search - * provides an eventually consistent view of the folders a user has access - * to which meet the specified filter criteria. This will only return - * folders on which the caller has the permission - * `resourcemanager.folders.get`. + * @desc Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. * @alias cloudresourcemanager.folders.search * @memberOf! () * @@ -1230,11 +992,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.setIamPolicy - * @desc Sets the access control policy on a Folder, replacing any existing - * policy. The `resource` field should be the Folder's resource name, e.g. - * "folders/1234". The caller must have - * `resourcemanager.folders.setIamPolicy` permission on the identified - * folder. + * @desc Sets the access control policy on a Folder, replacing any existing policy. The `resource` field should be the Folder's resource name, e.g. "folders/1234". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder. * @alias cloudresourcemanager.folders.setIamPolicy * @memberOf! () * @@ -1308,10 +1066,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.testIamPermissions - * @desc Returns permissions that a caller has on the specified Folder. The - * `resource` field should be the Folder's resource name, e.g. - * "folders/1234". There are no permissions required for making this API - * call. + * @desc Returns permissions that a caller has on the specified Folder. The `resource` field should be the Folder's resource name, e.g. "folders/1234". There are no permissions required for making this API call. * @alias cloudresourcemanager.folders.testIamPermissions * @memberOf! () * @@ -1394,13 +1149,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.folders.undelete - * @desc Cancels the deletion request for a Folder. This method may only be - * called on a Folder in the DELETE_REQUESTED state. In order to succeed, - * the Folder's parent must be in the ACTIVE state. In addition, - * reintroducing the folder into the tree must not violate folder naming, - * height and fanout constraints described in the CreateFolder - * documentation. The caller must have `resourcemanager.folders.undelete` - * permission on the identified folder. + * @desc Cancels the deletion request for a Folder. This method may only be called on a Folder in the DELETE_REQUESTED state. In order to succeed, the Folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder. * @alias cloudresourcemanager.folders.undelete * @memberOf! () * @@ -1479,8 +1228,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the new Folder's parent. Must be of the form - * `folders/{folder_id}` or `organizations/{org_id}`. + * The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ parent?: string; @@ -1496,8 +1244,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * the resource name of the Folder to be deleted. Must be of the form - * `folders/{folder_id}`. + * the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1508,8 +1255,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to retrieve. Must be of the form - * `folders/{folder_id}`. + * The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1521,8 +1267,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1538,26 +1283,19 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of Folders to return in the response. This field is - * optional. + * The maximum number of Folders to return in the response. This field is optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to `ListFolders` that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The resource name of the Organization or Folder whose Folders are being - * listed. Must be of the form `folders/{folder_id}` or - * `organizations/{org_id}`. Access to this method is controlled by checking - * the `resourcemanager.folders.list` permission on the `parent`. + * The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. */ parent?: string; /** - * Controls whether Folders in the DELETE_REQUESTED state should be - * returned. Defaults to false. This field is optional. + * Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional. */ showDeleted?: boolean; } @@ -1568,8 +1306,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to move. Must be of the form - * folders/{folder_id} + * The resource name of the Folder to move. Must be of the form folders/{folder_id} */ name?: string; @@ -1585,8 +1322,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the Folder. Its format is - * `folders/{folder_id}`, for example: "folders/1234". + * Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */ name?: string; /** @@ -1618,8 +1354,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1636,8 +1371,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1653,8 +1387,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to undelete. Must be of the form - * `folders/{folder_id}`. + * The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */ name?: string; @@ -1672,9 +1405,7 @@ export namespace cloudresourcemanager_v2 { /** * cloudresourcemanager.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudresourcemanager.operations.get * @memberOf! () * diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 5ec52f8a184..48985c210e5 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudresourcemanager_v2beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudresourcemanager_v2beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * Cloud Resource Manager API * - * Creates, reads, and updates metadata for Google Cloud Platform resource - * containers. + * Creates, reads, and updates metadata for Google Cloud Platform resource containers. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace cloudresourcemanager_v2beta1 { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.folders = new Resource$Folders(this.context); this.operations = new Resource$Operations(this.context); @@ -122,27 +120,7 @@ export namespace cloudresourcemanager_v2beta1 { } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -150,25 +128,16 @@ export namespace cloudresourcemanager_v2beta1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -181,94 +150,61 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * A Folder in an Organization's resource hierarchy, used to organize that - * Organization's resources. + * A Folder in an Organization's resource hierarchy, used to organize that Organization's resources. */ export interface Schema$Folder { /** - * Output only. Timestamp when the Folder was created. Assigned by the - * server. + * Output only. Timestamp when the Folder was created. Assigned by the server. */ createTime?: string; /** - * The folder’s display name. A folder’s display name must be unique amongst - * its siblings, e.g. no two folders with the same parent can share the same - * display name. The display name must start and end with a letter or digit, - * may contain letters, digits, spaces, hyphens and underscores and can be - * no longer than 30 characters. This is captured by the regular expression: - * [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. + * The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. */ displayName?: string; /** - * Output only. The lifecycle state of the folder. Updates to the - * lifecycle_state must be performed via DeleteFolder and UndeleteFolder. + * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ lifecycleState?: string; /** - * Output only. The resource name of the Folder. Its format is - * `folders/{folder_id}`, for example: "folders/1234". + * Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */ name?: string; /** - * The Folder’s parent's resource name. Updates to the folder's - * parent must be performed via MoveFolder. + * The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ parent?: string; } @@ -277,8 +213,7 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$FolderOperation { /** - * The resource name of the folder or organization we are either creating - * the folder under or moving the folder to. + * The resource name of the folder or organization we are either creating the folder under or moving the folder to. */ destinationParent?: string; /** @@ -290,8 +225,7 @@ export namespace cloudresourcemanager_v2beta1 { */ operationType?: string; /** - * The resource name of the folder's parent. Only applicable when the - * operation_type is MOVE. + * The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */ sourceParent?: string; } @@ -313,13 +247,11 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$ListFoldersResponse { /** - * A possibly paginated list of Folders that are direct descendants of the - * specified parent resource. + * A possibly paginated list of Folders that are direct descendants of the specified parent resource. */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `ListFolders` that - * indicates from where listing should continue. This field is optional. + * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. This field is optional. */ nextPageToken?: string; } @@ -328,21 +260,16 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$MoveFolderRequest { /** - * The resource name of the Folder or Organization to reparent the folder - * under. Must be of the form `folders/{folder_id}` or - * `organizations/{org_id}`. + * The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ destinationParent?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -350,48 +277,20 @@ export namespace cloudresourcemanager_v2beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -399,20 +298,11 @@ export namespace cloudresourcemanager_v2beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -421,9 +311,7 @@ export namespace cloudresourcemanager_v2beta1 { version?: number; } /** - * A status object which is used as the `metadata` field for the Operation - * returned by CreateProject. It provides insight for when significant phases - * of Project creation have completed. + * A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed. */ export interface Schema$ProjectCreationStatus { /** @@ -431,9 +319,7 @@ export namespace cloudresourcemanager_v2beta1 { */ createTime?: string; /** - * True if the project can be retrieved using GetProject. No other - * operations on the project are guaranteed to work until the project - * creation is complete. + * True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete. */ gettable?: boolean; /** @@ -446,31 +332,15 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$SearchFoldersRequest { /** - * The maximum number of folders to return in the response. This field is - * optional. + * The maximum number of folders to return in the response. This field is optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to `SearchFolders` that - * indicates from where search should continue. This field is optional. + * A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. This field is optional. */ pageToken?: string; /** - * Search criteria used to select the Folders to return. If no search - * criteria is specified then all accessible folders will be returned. Query - * expressions can be used to restrict results based upon displayName, - * lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` - * can be used along with the suffix wildcard symbol `*`. The displayName - * field in a query expression should use escaped quotes for values that - * include whitespace to prevent unexpected behavior. Some example queries - * are: |Query | Description| |----- | -----------| |displayName=Test* | - * Folders whose display name starts with "Test".| - * |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.| - * |parent=folders/123 | Folders whose parent is "folders/123".| - * |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose - * parent is "folders/123".| |displayName=\\"Test - * String\\"|Folders whose display name includes both "Test" - * and "String".| + * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: |Query | Description| |----- | -----------| |displayName=Test* | Folders whose display name starts with "Test".| |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.| |parent=folders/123 | Folders whose parent is "folders/123".| |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent is "folders/123".| |displayName=\\"Test String\\"|Folders whose display name includes both "Test" and "String".| */ query?: string; } @@ -479,13 +349,11 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$SearchFoldersResponse { /** - * A possibly paginated folder search results. the specified parent - * resource. + * A possibly paginated folder search results. the specified parent resource. */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `SearchFolders` that - * indicates from where searching should continue. This field is optional. + * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. This field is optional. */ nextPageToken?: string; } @@ -494,55 +362,16 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -550,14 +379,11 @@ export namespace cloudresourcemanager_v2beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -566,10 +392,7 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -578,8 +401,7 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -596,24 +418,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.create - * @desc Creates a Folder in the resource hierarchy. Returns an Operation - * which can be used to track the progress of the folder creation workflow. - * Upon success the Operation.response field will be populated with the - * created Folder. In order to succeed, the addition of this new Folder - * must not violate the Folder naming, height or fanout constraints. + The - * Folder's display_name must be distinct from all other Folder's that share - * its parent. + The addition of the Folder must not cause the active Folder - * hierarchy to exceed a height of 4. Note, the full active + deleted Folder - * hierarchy is allowed to reach a height of 8; this provides additional - * headroom when moving folders that contain deleted folders. + The addition - * of the Folder must not cause the total number of Folders under its parent - * to exceed 100. If the operation fails due to a folder constraint - * violation, some errors may be returned by the CreateFolder request, with - * status code FAILED_PRECONDITION and an error description. Other folder - * constraint violations will be communicated in the Operation, with the - * specific PreconditionFailure returned via the details list in the - * Operation.error field. The caller must have - * `resourcemanager.folders.create` permission on the identified parent. + * @desc Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 100. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent. * @alias cloudresourcemanager.folders.create * @memberOf! () * @@ -685,12 +490,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.delete - * @desc Requests deletion of a Folder. The Folder is moved into the - * DELETE_REQUESTED state immediately, and is deleted approximately 30 days - * later. This method may only be called on an empty Folder in the ACTIVE - * state, where a Folder is empty if it doesn't contain any Folders or - * Projects in the ACTIVE state. The caller must have - * `resourcemanager.folders.delete` permission on the identified folder. + * @desc Requests deletion of a Folder. The Folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty Folder in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. The caller must have `resourcemanager.folders.delete` permission on the identified folder. * @alias cloudresourcemanager.folders.delete * @memberOf! () * @@ -759,10 +559,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.get - * @desc Retrieves a Folder identified by the supplied resource name. Valid - * Folder resource names have the format `folders/{folder_id}` (for example, - * `folders/1234`). The caller must have `resourcemanager.folders.get` - * permission on the identified folder. + * @desc Retrieves a Folder identified by the supplied resource name. Valid Folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder. * @alias cloudresourcemanager.folders.get * @memberOf! () * @@ -831,11 +628,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.getIamPolicy - * @desc Gets the access control policy for a Folder. The returned policy - * may be empty if no such policy or resource exists. The `resource` field - * should be the Folder's resource name, e.g. "folders/1234". The caller - * must have `resourcemanager.folders.getIamPolicy` permission on the - * identified folder. + * @desc Gets the access control policy for a Folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the Folder's resource name, e.g. "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder. * @alias cloudresourcemanager.folders.getIamPolicy * @memberOf! () * @@ -909,12 +702,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.list - * @desc Lists the Folders that are direct descendants of supplied parent - * resource. List provides a strongly consistent view of the Folders - * underneath the specified parent resource. List returns Folders sorted - * based upon the (ascending) lexical ordering of their display_name. The - * caller must have `resourcemanager.folders.list` permission on the - * identified parent. + * @desc Lists the Folders that are direct descendants of supplied parent resource. List provides a strongly consistent view of the Folders underneath the specified parent resource. List returns Folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent. * @alias cloudresourcemanager.folders.list * @memberOf! () * @@ -988,19 +776,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.move - * @desc Moves a Folder under a new resource parent. Returns an Operation - * which can be used to track the progress of the folder move workflow. Upon - * success the Operation.response field will be populated with the moved - * Folder. Upon failure, a FolderOperationError categorizing the failure - * cause will be returned - if the failure occurs synchronously then the - * FolderOperationError will be returned via the Status.details field and if - * it occurs asynchronously then the FolderOperation will be returned via - * the Operation.error field. In addition, the Operation.metadata field will - * be populated with a FolderOperation message as an aid to stateless - * clients. Folder moves will be rejected if they violate either the naming, - * height or fanout constraints described in the CreateFolder documentation. - * The caller must have `resourcemanager.folders.move` permission on the - * folder's current and proposed new parent. + * @desc Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent. * @alias cloudresourcemanager.folders.move * @memberOf! () * @@ -1072,17 +848,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.patch - * @desc Updates a Folder, changing its display_name. Changes to the folder - * display_name will be rejected if they violate either the display_name - * formatting rules or naming constraints described in the CreateFolder - * documentation. The Folder's display name must start and end with a - * letter or digit, may contain letters, digits, spaces, hyphens and - * underscores and can be no longer than 30 characters. This is captured by - * the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. - * The caller must have `resourcemanager.folders.update` permission on the - * identified folder. If the update fails due to the unique name constraint - * then a PreconditionFailure explaining this violation will be returned in - * the Status.details field. + * @desc Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field. * @alias cloudresourcemanager.folders.patch * @memberOf! () * @@ -1153,11 +919,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.search - * @desc Search for folders that match specific filter criteria. Search - * provides an eventually consistent view of the folders a user has access - * to which meet the specified filter criteria. This will only return - * folders on which the caller has the permission - * `resourcemanager.folders.get`. + * @desc Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. * @alias cloudresourcemanager.folders.search * @memberOf! () * @@ -1230,11 +992,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.setIamPolicy - * @desc Sets the access control policy on a Folder, replacing any existing - * policy. The `resource` field should be the Folder's resource name, e.g. - * "folders/1234". The caller must have - * `resourcemanager.folders.setIamPolicy` permission on the identified - * folder. + * @desc Sets the access control policy on a Folder, replacing any existing policy. The `resource` field should be the Folder's resource name, e.g. "folders/1234". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder. * @alias cloudresourcemanager.folders.setIamPolicy * @memberOf! () * @@ -1308,10 +1066,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.testIamPermissions - * @desc Returns permissions that a caller has on the specified Folder. The - * `resource` field should be the Folder's resource name, e.g. - * "folders/1234". There are no permissions required for making this API - * call. + * @desc Returns permissions that a caller has on the specified Folder. The `resource` field should be the Folder's resource name, e.g. "folders/1234". There are no permissions required for making this API call. * @alias cloudresourcemanager.folders.testIamPermissions * @memberOf! () * @@ -1394,13 +1149,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.folders.undelete - * @desc Cancels the deletion request for a Folder. This method may only be - * called on a Folder in the DELETE_REQUESTED state. In order to succeed, - * the Folder's parent must be in the ACTIVE state. In addition, - * reintroducing the folder into the tree must not violate folder naming, - * height and fanout constraints described in the CreateFolder - * documentation. The caller must have `resourcemanager.folders.undelete` - * permission on the identified folder. + * @desc Cancels the deletion request for a Folder. This method may only be called on a Folder in the DELETE_REQUESTED state. In order to succeed, the Folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder. * @alias cloudresourcemanager.folders.undelete * @memberOf! () * @@ -1479,8 +1228,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the new Folder's parent. Must be of the form - * `folders/{folder_id}` or `organizations/{org_id}`. + * The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ parent?: string; @@ -1496,8 +1244,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * the resource name of the Folder to be deleted. Must be of the form - * `folders/{folder_id}`. + * the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1508,8 +1255,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to retrieve. Must be of the form - * `folders/{folder_id}`. + * The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1521,8 +1267,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1538,26 +1283,19 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of Folders to return in the response. This field is - * optional. + * The maximum number of Folders to return in the response. This field is optional. */ pageSize?: number; /** - * A pagination token returned from a previous call to `ListFolders` that - * indicates where this listing should continue from. This field is - * optional. + * A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional. */ pageToken?: string; /** - * The resource name of the Organization or Folder whose Folders are being - * listed. Must be of the form `folders/{folder_id}` or - * `organizations/{org_id}`. Access to this method is controlled by checking - * the `resourcemanager.folders.list` permission on the `parent`. + * The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. */ parent?: string; /** - * Controls whether Folders in the DELETE_REQUESTED state should be - * returned. Defaults to false. This field is optional. + * Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional. */ showDeleted?: boolean; } @@ -1568,8 +1306,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to move. Must be of the form - * folders/{folder_id} + * The resource name of the Folder to move. Must be of the form folders/{folder_id} */ name?: string; @@ -1585,8 +1322,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the Folder. Its format is - * `folders/{folder_id}`, for example: "folders/1234". + * Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */ name?: string; /** @@ -1618,8 +1354,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1636,8 +1371,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1653,8 +1387,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to undelete. Must be of the form - * `folders/{folder_id}`. + * The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */ name?: string; @@ -1672,9 +1405,7 @@ export namespace cloudresourcemanager_v2beta1 { /** * cloudresourcemanager.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudresourcemanager.operations.get * @memberOf! () * diff --git a/src/apis/cloudscheduler/package.json b/src/apis/cloudscheduler/package.json index e7f1fcf24c6..17a3f893cee 100644 --- a/src/apis/cloudscheduler/package.json +++ b/src/apis/cloudscheduler/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index 10e00a5c4c0..9a0ad76c641 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudscheduler_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudscheduler_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,21 +108,17 @@ export namespace cloudscheduler_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * App Engine target. The job will be pushed to a job handler by means of an - * HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job - * is acknowledged by means of an HTTP response code in the range [200 - 299]. - * Error 503 is considered an App Engine system error instead of an - * application error. Requests returning error 503 will be retried regardless - * of retry configuration and not counted against retry counts. Any other - * response code, or a failure to receive a response before the deadline, - * constitutes a failed attempt. + * App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt. */ export interface Schema$AppEngineHttpTarget { /** @@ -134,147 +126,57 @@ export namespace cloudscheduler_v1 { */ appEngineRouting?: Schema$AppEngineRouting; /** - * Body. HTTP request body. A request body is allowed only if the HTTP - * method is POST or PUT. It will result in invalid argument error to set a - * body on a job with an incompatible HttpMethod. + * Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. */ body?: string; /** - * HTTP request headers. This map contains the header field names and - * values. Headers can be set when the job is created. Cloud Scheduler sets - * some headers to default values: * `User-Agent`: By default, this header - * is `"AppEngine-Google; (+http://code.google.com/appengine)"`. - * This header can be modified, but Cloud Scheduler will append - * `"AppEngine-Google; (+http://code.google.com/appengine)"` to - * the modified `User-Agent`. * `X-CloudScheduler`: This header will be - * set to true. If the job has an body, Cloud Scheduler sets the following - * headers: * `Content-Type`: By default, the `Content-Type` header is set - * to `"application/octet-stream"`. The default can be - * overridden by explictly setting `Content-Type` to a particular media - * type when the job is created. For example, `Content-Type` can be set - * to `"application/json"`. * `Content-Length`: This is computed - * by Cloud Scheduler. This value is output only. It cannot be changed. - * The headers below are output only. They cannot be set or overridden: * - * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google - * internal use only. In addition, some App Engine headers, which contain - * job-specific information, are also be sent to the job handler. + * HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. */ headers?: {[key: string]: string}; /** - * The HTTP method to use for the request. PATCH and OPTIONS are not - * permitted. + * The HTTP method to use for the request. PATCH and OPTIONS are not permitted. */ httpMethod?: string; /** - * The relative URI. The relative URL must begin with "/" and - * must be a valid HTTP relative URL. It can contain a path, query string - * arguments, and `#` fragments. If the relative URL is empty, then the root - * path "/" will be used. No spaces are allowed, and the maximum - * length allowed is 2083 characters. + * The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ relativeUri?: string; } /** - * App Engine Routing. For more information about services, versions, and - * instances see [An Overview of App - * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), - * [Microservices Architecture on Google App - * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App Engine Routing. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ export interface Schema$AppEngineRouting { /** - * Output only. The host that the job is sent to. For more information - * about how App Engine requests are routed, see - * [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). - * The host is constructed as: * `host = - * [application_domain_name]`</br> `| [service] + '.' + - * [application_domain_name]`</br> `| [version] + '.' + - * [application_domain_name]`</br> `| [version_dot_service]+ - * '.' + [application_domain_name]`</br> `| [instance] + - * '.' + [application_domain_name]`</br> `| - * [instance_dot_service] + '.' + - * [application_domain_name]`</br> `| [instance_dot_version] + - * '.' + [application_domain_name]`</br> `| - * [instance_dot_version_dot_service] + '.' + - * [application_domain_name]` * `application_domain_name` = The domain name - * of the app, for example <app-id>.appspot.com, which is associated - * with the job's project ID. * `service =` service * `version =` - * version * `version_dot_service =` version `+ '.' +` service - * * `instance =` instance * `instance_dot_service =` instance `+ - * '.' +` service * `instance_dot_version =` instance `+ - * '.' +` version * `instance_dot_version_dot_service =` instance - * `+ '.' +` version `+ '.' +` service If service is - * empty, then the job will be sent to the service which is the default - * service when the job is attempted. If version is empty, then the job - * will be sent to the version which is the default version when the job is - * attempted. If instance is empty, then the job will be sent to an - * instance which is available when the job is attempted. If service, - * version, or instance is invalid, then the job will be sent to the default - * version of the default service when the job is attempted. + * Output only. The host that the job is sent to. For more information about how App Engine requests are routed, see [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]`</br> `| [service] + '.' + [application_domain_name]`</br> `| [version] + '.' + [application_domain_name]`</br> `| [version_dot_service]+ '.' + [application_domain_name]`</br> `| [instance] + '.' + [application_domain_name]`</br> `| [instance_dot_service] + '.' + [application_domain_name]`</br> `| [instance_dot_version] + '.' + [application_domain_name]`</br> `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example <app-id>.appspot.com, which is associated with the job's project ID. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. */ host?: string; /** - * App instance. By default, the job is sent to an instance which is - * available when the job is attempted. Requests can only be sent to a - * specific instance if [manual scaling is used in App Engine - * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). - * App Engine Flex does not support instances. For more information, see - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ instance?: string; /** - * App service. By default, the job is sent to the service which is the - * default service when the job is attempted. + * App service. By default, the job is sent to the service which is the default service when the job is attempted. */ service?: string; /** - * App version. By default, the job is sent to the version which is the - * default version when the job is attempted. + * App version. By default, the job is sent to the version which is the default version when the job is attempted. */ version?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Http target. The job will be pushed to the job handler by means of an HTTP - * request via an http_method such as HTTP POST, HTTP GET, etc. The job is - * acknowledged by means of an HTTP response code in the range [200 - 299]. A - * failure to receive a response constitutes a failed execution. For a - * redirected request, the response returned by the redirected request is - * considered. + * Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. */ export interface Schema$HttpTarget { /** - * HTTP request body. A request body is allowed only if the HTTP method is - * POST, PUT, or PATCH. It is an error to set body on a job with an - * incompatible HttpMethod. + * HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. */ body?: string; /** - * The user can specify HTTP request headers to send with the job's HTTP - * request. This map contains the header field names and values. Repeated - * headers are not supported, but a header value can contain commas. These - * headers represent a subset of the headers that will accompany the - * job's HTTP request. Some HTTP request headers will be ignored or - * replaced. A partial list of headers that will be ignored or replaced is - * below: - Host: This will be computed by Cloud Scheduler and derived from - * uri. * `Content-Length`: This will be computed by Cloud Scheduler. * - * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * - * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google - * internal use only. The total size of headers must be less than 80KB. + * The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB. */ headers?: {[key: string]: string}; /** @@ -282,12 +184,15 @@ export namespace cloudscheduler_v1 { */ httpMethod?: string; /** - * Required. The full URI path that the request will be sent to. This - * string must begin with either "http://" or - * "https://". Some examples of valid values for uri are: - * `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will - * encode some characters for safety and compatibility. The maximum allowed - * URL length is 2083 characters after encoding. + * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to a GCP endpoint. + */ + oauthToken?: Schema$OAuthToken; + /** + * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. + */ + oidcToken?: Schema$OidcToken; + /** + * Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. */ uri?: string; } @@ -300,9 +205,11 @@ export namespace cloudscheduler_v1 { */ appEngineHttpTarget?: Schema$AppEngineHttpTarget; /** - * Optionally caller-specified in CreateJob or UpdateJob. A human-readable - * description for the job. This string must not contain more than 500 - * characters. + * The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. + */ + attemptDeadline?: string; + /** + * Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters. */ description?: string; /** @@ -314,17 +221,7 @@ export namespace cloudscheduler_v1 { */ lastAttemptTime?: string; /** - * Optionally caller-specified in CreateJob, after which it becomes output - * only. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` - * can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons - * (:), or periods (.). For more information, see [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the job's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** @@ -336,26 +233,11 @@ export namespace cloudscheduler_v1 { */ retryConfig?: Schema$RetryConfig; /** - * Required, except when used with UpdateJob. Describes the schedule on - * which the job will be executed. The schedule can be either of the - * following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) - * * English-like - * [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) - * As a general rule, execution `n + 1` of a job will not begin until - * execution `n` has finished. Cloud Scheduler will never allow two - * simultaneously outstanding executions. For example, this implies that if - * the `n+1`th execution is scheduled to run at 16:00 but the `n`th - * execution takes until 16:15, the `n+1`th execution will not start until - * `16:15`. A scheduled start time will be delayed if the previous execution - * has not ended when its scheduled time occurs. If retry_count > 0 and - * a job attempt fails, the job will be tried a total of retry_count times, - * with exponential backoff, until the next scheduled start time. + * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. */ schedule?: string; /** - * Output only. The next time the job is scheduled. Note that this may be a - * retry of a previously failed attempt or the next execution time according - * to the schedule. + * Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. */ scheduleTime?: string; /** @@ -363,18 +245,11 @@ export namespace cloudscheduler_v1 { */ state?: string; /** - * Output only. The response from the target for the last attempted - * execution. + * Output only. The response from the target for the last attempted execution. */ status?: Schema$Status; /** - * Specifies the time zone to be used in interpreting schedule. The value of - * this field must be a time zone name from the [tz - * database](http://en.wikipedia.org/wiki/Tz_database). Note that some time - * zones include a provision for daylight savings time. The rules for - * daylight saving time are determined by the chosen tz. For UTC use the - * string "utc". If a time zone is not specified, the default will - * be in UTC (also known as GMT). + * Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). */ timeZone?: string; /** @@ -391,11 +266,7 @@ export namespace cloudscheduler_v1 { */ jobs?: Schema$Job[]; /** - * A token to retrieve next page of results. Pass this value in the - * page_token field in the subsequent call to ListJobs to retrieve the next - * page of results. If this is empty it indicates that there are no more - * results through which to paginate. The page token is valid for only 2 - * hours. + * A token to retrieve next page of results. Pass this value in the page_token field in the subsequent call to ListJobs to retrieve the next page of results. If this is empty it indicates that there are no more results through which to paginate. The page token is valid for only 2 hours. */ nextPageToken?: string; } @@ -417,13 +288,11 @@ export namespace cloudscheduler_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -431,29 +300,46 @@ export namespace cloudscheduler_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } + /** + * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should be used when sending requests to a GCP endpoint. + */ + export interface Schema$OAuthToken { + /** + * OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + */ + scope?: string; + /** + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. + */ + serviceAccountEmail?: string; + } + /** + * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization should be used when sending requests to third party endpoints or Cloud Run. + */ + export interface Schema$OidcToken { + /** + * Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + */ + audience?: string; + /** + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. + */ + serviceAccountEmail?: string; + } /** * Request message for PauseJob. */ export interface Schema$PauseJobRequest {} /** - * A message that is published by publishers and consumed by subscribers. The - * message must contain either a non-empty data field or at least one - * attribute. Note that client libraries represent this object differently - * depending on the language. See the corresponding <a - * href="https://cloud.google.com/pubsub/docs/reference/libraries">client - * library documentation</a> for more information. See <a - * href="https://cloud.google.com/pubsub/quotas">Quotas and - * limits</a> for more information about message limits. + * A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> for more information about message limits. */ export interface Schema$PubsubMessage { /** @@ -461,46 +347,32 @@ export namespace cloudscheduler_v1 { */ attributes?: {[key: string]: string}; /** - * The message data field. If this field is empty, the message must contain - * at least one attribute. + * The message data field. If this field is empty, the message must contain at least one attribute. */ data?: string; /** - * ID of this message, assigned by the server when the message is published. - * Guaranteed to be unique within the topic. This value may be read by a - * subscriber that receives a `PubsubMessage` via a `Pull` call or a push - * delivery. It must not be populated by the publisher in a `Publish` call. + * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ messageId?: string; /** - * The time at which the message was published, populated by the server when - * it receives the `Publish` call. It must not be populated by the publisher - * in a `Publish` call. + * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ publishTime?: string; } /** - * Pub/Sub target. The job will be delivered by publishing a message to the - * given Pub/Sub topic. + * Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. */ export interface Schema$PubsubTarget { /** - * Attributes for PubsubMessage. Pubsub message must contain either - * non-empty data, or at least one attribute. + * Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ attributes?: {[key: string]: string}; /** - * The message payload for PubsubMessage. Pubsub message must contain - * either non-empty data, or at least one attribute. + * The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ data?: string; /** - * Required. The name of the Cloud Pub/Sub topic to which messages will be - * published when a job is delivered. The topic name must be in the same - * format as required by PubSub's - * [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), - * for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in - * the same project as the Cloud Scheduler job. + * Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job. */ topicName?: string; } @@ -509,53 +381,27 @@ export namespace cloudscheduler_v1 { */ export interface Schema$ResumeJobRequest {} /** - * Settings that determine the retry behavior. By default, if a job does not - * complete successfully (meaning that an acknowledgement is not received from - * the handler, then it will be retried with exponential backoff according to - * the settings in RetryConfig. + * Settings that determine the retry behavior. By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. */ export interface Schema$RetryConfig { /** - * The maximum amount of time to wait before retrying a job after it fails. - * The default value of this field is 1 hour. + * The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. */ maxBackoffDuration?: string; /** - * The time between retries will double `max_doublings` times. A job's - * retry interval starts at min_backoff_duration, then doubles - * `max_doublings` times, then increases linearly, and finally retries - * retries at intervals of max_backoff_duration up to retry_count times. For - * example, if min_backoff_duration is 10s, max_backoff_duration is 300s, - * and `max_doublings` is 3, then the a job will first be retried in 10s. - * The retry interval will double three times, and then increase linearly by - * 2^3 * 10s. Finally, the job will retry at intervals of - * max_backoff_duration until the job has been attempted retry_count times. - * Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, - * 300s, .... The default value of this field is 5. + * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the a job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. */ maxDoublings?: number; /** - * The time limit for retrying a failed job, measured from time when an - * execution was first attempted. If specified with retry_count, the job - * will be retried until both limits are reached. The default value for - * max_retry_duration is zero, which means retry duration is unlimited. + * The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. */ maxRetryDuration?: string; /** - * The minimum amount of time to wait before retrying a job after it fails. - * The default value of this field is 5 seconds. + * The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. */ minBackoffDuration?: string; /** - * The number of attempts that the system will make to run a job using the - * exponential backoff procedure described by max_doublings. The default - * value of retry_count is zero. If retry_count is zero, a job attempt will - * *not* be retried if it fails. Instead the Cloud Scheduler system will - * wait for the next scheduled execution time. If retry_count is set to a - * non-zero number then Cloud Scheduler will retry failed attempts, using - * exponential backoff, retry_count times, or until the next scheduled - * execution time, whichever comes first. Values greater than 5 and - * negative values are not allowed. + * The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. */ retryCount?: number; } @@ -564,40 +410,7 @@ export namespace cloudscheduler_v1 { */ export interface Schema$RunJobRequest {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -605,14 +418,11 @@ export namespace cloudscheduler_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1115,12 +925,7 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.patch - * @desc Updates a job. If successful, the updated Job is returned. If the - * job does not exist, `NOT_FOUND` is returned. If UpdateJob does not - * successfully return, it is possible for the job to be in an - * Job.State.UPDATE_FAILED state. A job in this state may not be executed. - * If this happens, retry the UpdateJob request until a successful response - * is received. + * @desc Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. * @alias cloudscheduler.projects.locations.jobs.patch * @memberOf! () * @@ -1192,10 +997,7 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.pause - * @desc Pauses a job. If a job is paused then the system will stop - * executing the job until it is re-enabled via ResumeJob. The state of the - * job is stored in state; if paused it will be set to Job.State.PAUSED. A - * job must be in Job.State.ENABLED to be paused. + * @desc Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. * @alias cloudscheduler.projects.locations.jobs.pause * @memberOf! () * @@ -1266,10 +1068,7 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.resume - * @desc Resume a job. This method reenables a job after it has been - * Job.State.PAUSED. The state of a job is stored in Job.state; after - * calling this method it will be set to Job.State.ENABLED. A job must be in - * Job.State.PAUSED to be resumed. + * @desc Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. * @alias cloudscheduler.projects.locations.jobs.resume * @memberOf! () * @@ -1340,8 +1139,7 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.run - * @desc Forces a job to run now. When this method is called, Cloud - * Scheduler will dispatch the job, even if the job is already running. + * @desc Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. * @alias cloudscheduler.projects.locations.jobs.run * @memberOf! () * @@ -1419,8 +1217,7 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The location name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID`. + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */ parent?: string; @@ -1437,8 +1234,7 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; } @@ -1450,8 +1246,7 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; } @@ -1463,23 +1258,15 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. The maximum page size is 500. If unspecified, the - * page size will be the maximum. Fewer jobs than requested might be - * returned, even if more jobs exist; use next_page_token to determine if - * more jobs exist. + * Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. */ pageSize?: number; /** - * A token identifying a page of results the server will return. To request - * the first page results, page_token must be empty. To request the next - * page of results, page_token must be the value of next_page_token returned - * from the previous call to ListJobs. It is an error to switch the value of - * filter or order_by while iterating through pages. + * A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages. */ pageToken?: string; /** - * Required. The location name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID`. + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */ parent?: string; } @@ -1491,17 +1278,7 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optionally caller-specified in CreateJob, after which it becomes output - * only. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` - * can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons - * (:), or periods (.). For more information, see [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the job's location. The list - * of available locations can be obtained by calling ListLocations. For - * more information, see https://cloud.google.com/about/locations/. * - * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** @@ -1522,8 +1299,7 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; @@ -1540,8 +1316,7 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; @@ -1558,8 +1333,7 @@ export namespace cloudscheduler_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index 2905c677319..4b1d9da93c7 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudscheduler_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudscheduler_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,21 +108,17 @@ export namespace cloudscheduler_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * App Engine target. The job will be pushed to a job handler by means of an - * HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job - * is acknowledged by means of an HTTP response code in the range [200 - 299]. - * Error 503 is considered an App Engine system error instead of an - * application error. Requests returning error 503 will be retried regardless - * of retry configuration and not counted against retry counts. Any other - * response code, or a failure to receive a response before the deadline, - * constitutes a failed attempt. + * App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt. */ export interface Schema$AppEngineHttpTarget { /** @@ -134,147 +126,57 @@ export namespace cloudscheduler_v1beta1 { */ appEngineRouting?: Schema$AppEngineRouting; /** - * Body. HTTP request body. A request body is allowed only if the HTTP - * method is POST or PUT. It will result in invalid argument error to set a - * body on a job with an incompatible HttpMethod. + * Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. */ body?: string; /** - * HTTP request headers. This map contains the header field names and - * values. Headers can be set when the job is created. Cloud Scheduler sets - * some headers to default values: * `User-Agent`: By default, this header - * is `"AppEngine-Google; (+http://code.google.com/appengine)"`. - * This header can be modified, but Cloud Scheduler will append - * `"AppEngine-Google; (+http://code.google.com/appengine)"` to - * the modified `User-Agent`. * `X-CloudScheduler`: This header will be - * set to true. If the job has an body, Cloud Scheduler sets the following - * headers: * `Content-Type`: By default, the `Content-Type` header is set - * to `"application/octet-stream"`. The default can be - * overridden by explictly setting `Content-Type` to a particular media - * type when the job is created. For example, `Content-Type` can be set - * to `"application/json"`. * `Content-Length`: This is computed - * by Cloud Scheduler. This value is output only. It cannot be changed. - * The headers below are output only. They cannot be set or overridden: * - * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google - * internal use only. In addition, some App Engine headers, which contain - * job-specific information, are also be sent to the job handler. + * HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. */ headers?: {[key: string]: string}; /** - * The HTTP method to use for the request. PATCH and OPTIONS are not - * permitted. + * The HTTP method to use for the request. PATCH and OPTIONS are not permitted. */ httpMethod?: string; /** - * The relative URI. The relative URL must begin with "/" and - * must be a valid HTTP relative URL. It can contain a path, query string - * arguments, and `#` fragments. If the relative URL is empty, then the root - * path "/" will be used. No spaces are allowed, and the maximum - * length allowed is 2083 characters. + * The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ relativeUri?: string; } /** - * App Engine Routing. For more information about services, versions, and - * instances see [An Overview of App - * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), - * [Microservices Architecture on Google App - * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App Engine Routing. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ export interface Schema$AppEngineRouting { /** - * Output only. The host that the job is sent to. For more information - * about how App Engine requests are routed, see - * [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). - * The host is constructed as: * `host = - * [application_domain_name]`</br> `| [service] + '.' + - * [application_domain_name]`</br> `| [version] + '.' + - * [application_domain_name]`</br> `| [version_dot_service]+ - * '.' + [application_domain_name]`</br> `| [instance] + - * '.' + [application_domain_name]`</br> `| - * [instance_dot_service] + '.' + - * [application_domain_name]`</br> `| [instance_dot_version] + - * '.' + [application_domain_name]`</br> `| - * [instance_dot_version_dot_service] + '.' + - * [application_domain_name]` * `application_domain_name` = The domain name - * of the app, for example <app-id>.appspot.com, which is associated - * with the job's project ID. * `service =` service * `version =` - * version * `version_dot_service =` version `+ '.' +` service - * * `instance =` instance * `instance_dot_service =` instance `+ - * '.' +` service * `instance_dot_version =` instance `+ - * '.' +` version * `instance_dot_version_dot_service =` instance - * `+ '.' +` version `+ '.' +` service If service is - * empty, then the job will be sent to the service which is the default - * service when the job is attempted. If version is empty, then the job - * will be sent to the version which is the default version when the job is - * attempted. If instance is empty, then the job will be sent to an - * instance which is available when the job is attempted. If service, - * version, or instance is invalid, then the job will be sent to the default - * version of the default service when the job is attempted. + * Output only. The host that the job is sent to. For more information about how App Engine requests are routed, see [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]`</br> `| [service] + '.' + [application_domain_name]`</br> `| [version] + '.' + [application_domain_name]`</br> `| [version_dot_service]+ '.' + [application_domain_name]`</br> `| [instance] + '.' + [application_domain_name]`</br> `| [instance_dot_service] + '.' + [application_domain_name]`</br> `| [instance_dot_version] + '.' + [application_domain_name]`</br> `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example <app-id>.appspot.com, which is associated with the job's project ID. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. */ host?: string; /** - * App instance. By default, the job is sent to an instance which is - * available when the job is attempted. Requests can only be sent to a - * specific instance if [manual scaling is used in App Engine - * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). - * App Engine Flex does not support instances. For more information, see - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ instance?: string; /** - * App service. By default, the job is sent to the service which is the - * default service when the job is attempted. + * App service. By default, the job is sent to the service which is the default service when the job is attempted. */ service?: string; /** - * App version. By default, the job is sent to the version which is the - * default version when the job is attempted. + * App version. By default, the job is sent to the version which is the default version when the job is attempted. */ version?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Http target. The job will be pushed to the job handler by means of an HTTP - * request via an http_method such as HTTP POST, HTTP GET, etc. The job is - * acknowledged by means of an HTTP response code in the range [200 - 299]. A - * failure to receive a response constitutes a failed execution. For a - * redirected request, the response returned by the redirected request is - * considered. + * Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. */ export interface Schema$HttpTarget { /** - * HTTP request body. A request body is allowed only if the HTTP method is - * POST, PUT, or PATCH. It is an error to set body on a job with an - * incompatible HttpMethod. + * HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. */ body?: string; /** - * The user can specify HTTP request headers to send with the job's HTTP - * request. This map contains the header field names and values. Repeated - * headers are not supported, but a header value can contain commas. These - * headers represent a subset of the headers that will accompany the - * job's HTTP request. Some HTTP request headers will be ignored or - * replaced. A partial list of headers that will be ignored or replaced is - * below: - Host: This will be computed by Cloud Scheduler and derived from - * uri. * `Content-Length`: This will be computed by Cloud Scheduler. * - * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * - * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google - * internal use only. The total size of headers must be less than 80KB. + * The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB. */ headers?: {[key: string]: string}; /** @@ -282,28 +184,15 @@ export namespace cloudscheduler_v1beta1 { */ httpMethod?: string; /** - * If specified, an [OAuth - * token](https://developers.google.com/identity/protocols/OAuth2) will be - * generated and attached as an `Authorization` header in the HTTP request. - * This type of authorization should be used when sending requests to a GCP - * endpoint. + * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to a GCP endpoint. */ oauthToken?: Schema$OAuthToken; /** - * If specified, an - * [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) - * token will be generated and attached as an `Authorization` header in the - * HTTP request. This type of authorization should be used when sending - * requests to third party endpoints. + * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. */ oidcToken?: Schema$OidcToken; /** - * Required. The full URI path that the request will be sent to. This - * string must begin with either "http://" or - * "https://". Some examples of valid values for uri are: - * `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will - * encode some characters for safety and compatibility. The maximum allowed - * URL length is 2083 characters after encoding. + * Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. */ uri?: string; } @@ -316,20 +205,11 @@ export namespace cloudscheduler_v1beta1 { */ appEngineHttpTarget?: Schema$AppEngineHttpTarget; /** - * The deadline for job attempts. If the request handler does not respond by - * this deadline then the request is cancelled and the attempt is marked as - * a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in - * execution logs. Cloud Scheduler will retry the job according to the - * RetryConfig. The allowed duration for this deadline is: * For HTTP - * targets, between 15 seconds and 30 minutes. * For App Engine HTTP - * targets, between 15 seconds and 24 hours. * For PubSub targets, this - * field is ignored. + * The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * For PubSub targets, this field is ignored. */ attemptDeadline?: string; /** - * Optionally caller-specified in CreateJob or UpdateJob. A human-readable - * description for the job. This string must not contain more than 500 - * characters. + * Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters. */ description?: string; /** @@ -341,17 +221,7 @@ export namespace cloudscheduler_v1beta1 { */ lastAttemptTime?: string; /** - * Optionally caller-specified in CreateJob, after which it becomes output - * only. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` - * can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons - * (:), or periods (.). For more information, see [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the job's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** @@ -363,26 +233,11 @@ export namespace cloudscheduler_v1beta1 { */ retryConfig?: Schema$RetryConfig; /** - * Required, except when used with UpdateJob. Describes the schedule on - * which the job will be executed. The schedule can be either of the - * following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) - * * English-like - * [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) - * As a general rule, execution `n + 1` of a job will not begin until - * execution `n` has finished. Cloud Scheduler will never allow two - * simultaneously outstanding executions. For example, this implies that if - * the `n+1`th execution is scheduled to run at 16:00 but the `n`th - * execution takes until 16:15, the `n+1`th execution will not start until - * `16:15`. A scheduled start time will be delayed if the previous execution - * has not ended when its scheduled time occurs. If retry_count > 0 and - * a job attempt fails, the job will be tried a total of retry_count times, - * with exponential backoff, until the next scheduled start time. + * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. */ schedule?: string; /** - * Output only. The next time the job is scheduled. Note that this may be a - * retry of a previously failed attempt or the next execution time according - * to the schedule. + * Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. */ scheduleTime?: string; /** @@ -390,18 +245,11 @@ export namespace cloudscheduler_v1beta1 { */ state?: string; /** - * Output only. The response from the target for the last attempted - * execution. + * Output only. The response from the target for the last attempted execution. */ status?: Schema$Status; /** - * Specifies the time zone to be used in interpreting schedule. The value of - * this field must be a time zone name from the [tz - * database](http://en.wikipedia.org/wiki/Tz_database). Note that some time - * zones include a provision for daylight savings time. The rules for - * daylight saving time are determined by the chosen tz. For UTC use the - * string "utc". If a time zone is not specified, the default will - * be in UTC (also known as GMT). + * Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). */ timeZone?: string; /** @@ -418,11 +266,7 @@ export namespace cloudscheduler_v1beta1 { */ jobs?: Schema$Job[]; /** - * A token to retrieve next page of results. Pass this value in the - * page_token field in the subsequent call to ListJobs to retrieve the next - * page of results. If this is empty it indicates that there are no more - * results through which to paginate. The page token is valid for only 2 - * hours. + * A token to retrieve next page of results. Pass this value in the page_token field in the subsequent call to ListJobs to retrieve the next page of results. If this is empty it indicates that there are no more results through which to paginate. The page token is valid for only 2 hours. */ nextPageToken?: string; } @@ -444,13 +288,11 @@ export namespace cloudscheduler_v1beta1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -458,55 +300,37 @@ export namespace cloudscheduler_v1beta1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** - * Contains information needed for generating an [OAuth - * token](https://developers.google.com/identity/protocols/OAuth2). This type - * of authorization should be used when sending requests to a GCP endpoint. + * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should be used when sending requests to a GCP endpoint. */ export interface Schema$OAuthToken { /** - * OAuth scope to be used for generating OAuth access token. If not - * specified, "https://www.googleapis.com/auth/cloud-platform" - * will be used. + * OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. */ scope?: string; /** - * [Service account - * email](https://cloud.google.com/iam/docs/service-accounts) to be used for - * generating OAuth token. The service account must be within the same - * project as the job. The caller must have iam.serviceAccounts.actAs - * permission for the service account. + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. */ serviceAccountEmail?: string; } /** - * Contains information needed for generating an [OpenID Connect - * token](https://developers.google.com/identity/protocols/OpenIDConnect). - * This type of authorization should be used when sending requests to third - * party endpoints. + * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization should be used when sending requests to third party endpoints or Cloud Run. */ export interface Schema$OidcToken { /** - * Audience to be used when generating OIDC token. If not specified, the URI - * specified in target will be used. + * Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. */ audience?: string; /** - * [Service account - * email](https://cloud.google.com/iam/docs/service-accounts) to be used for - * generating OIDC token. The service account must be within the same - * project as the job. The caller must have iam.serviceAccounts.actAs - * permission for the service account. + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account. */ serviceAccountEmail?: string; } @@ -515,14 +339,7 @@ export namespace cloudscheduler_v1beta1 { */ export interface Schema$PauseJobRequest {} /** - * A message that is published by publishers and consumed by subscribers. The - * message must contain either a non-empty data field or at least one - * attribute. Note that client libraries represent this object differently - * depending on the language. See the corresponding <a - * href="https://cloud.google.com/pubsub/docs/reference/libraries">client - * library documentation</a> for more information. See <a - * href="https://cloud.google.com/pubsub/quotas">Quotas and - * limits</a> for more information about message limits. + * A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> for more information about message limits. */ export interface Schema$PubsubMessage { /** @@ -530,46 +347,32 @@ export namespace cloudscheduler_v1beta1 { */ attributes?: {[key: string]: string}; /** - * The message data field. If this field is empty, the message must contain - * at least one attribute. + * The message data field. If this field is empty, the message must contain at least one attribute. */ data?: string; /** - * ID of this message, assigned by the server when the message is published. - * Guaranteed to be unique within the topic. This value may be read by a - * subscriber that receives a `PubsubMessage` via a `Pull` call or a push - * delivery. It must not be populated by the publisher in a `Publish` call. + * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ messageId?: string; /** - * The time at which the message was published, populated by the server when - * it receives the `Publish` call. It must not be populated by the publisher - * in a `Publish` call. + * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ publishTime?: string; } /** - * Pub/Sub target. The job will be delivered by publishing a message to the - * given Pub/Sub topic. + * Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. */ export interface Schema$PubsubTarget { /** - * Attributes for PubsubMessage. Pubsub message must contain either - * non-empty data, or at least one attribute. + * Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ attributes?: {[key: string]: string}; /** - * The message payload for PubsubMessage. Pubsub message must contain - * either non-empty data, or at least one attribute. + * The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */ data?: string; /** - * Required. The name of the Cloud Pub/Sub topic to which messages will be - * published when a job is delivered. The topic name must be in the same - * format as required by PubSub's - * [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), - * for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in - * the same project as the Cloud Scheduler job. + * Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job. */ topicName?: string; } @@ -578,53 +381,27 @@ export namespace cloudscheduler_v1beta1 { */ export interface Schema$ResumeJobRequest {} /** - * Settings that determine the retry behavior. By default, if a job does not - * complete successfully (meaning that an acknowledgement is not received from - * the handler, then it will be retried with exponential backoff according to - * the settings in RetryConfig. + * Settings that determine the retry behavior. By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. */ export interface Schema$RetryConfig { /** - * The maximum amount of time to wait before retrying a job after it fails. - * The default value of this field is 1 hour. + * The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. */ maxBackoffDuration?: string; /** - * The time between retries will double `max_doublings` times. A job's - * retry interval starts at min_backoff_duration, then doubles - * `max_doublings` times, then increases linearly, and finally retries - * retries at intervals of max_backoff_duration up to retry_count times. For - * example, if min_backoff_duration is 10s, max_backoff_duration is 300s, - * and `max_doublings` is 3, then the a job will first be retried in 10s. - * The retry interval will double three times, and then increase linearly by - * 2^3 * 10s. Finally, the job will retry at intervals of - * max_backoff_duration until the job has been attempted retry_count times. - * Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, - * 300s, .... The default value of this field is 5. + * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the a job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. */ maxDoublings?: number; /** - * The time limit for retrying a failed job, measured from time when an - * execution was first attempted. If specified with retry_count, the job - * will be retried until both limits are reached. The default value for - * max_retry_duration is zero, which means retry duration is unlimited. + * The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. */ maxRetryDuration?: string; /** - * The minimum amount of time to wait before retrying a job after it fails. - * The default value of this field is 5 seconds. + * The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. */ minBackoffDuration?: string; /** - * The number of attempts that the system will make to run a job using the - * exponential backoff procedure described by max_doublings. The default - * value of retry_count is zero. If retry_count is zero, a job attempt will - * *not* be retried if it fails. Instead the Cloud Scheduler system will - * wait for the next scheduled execution time. If retry_count is set to a - * non-zero number then Cloud Scheduler will retry failed attempts, using - * exponential backoff, retry_count times, or until the next scheduled - * execution time, whichever comes first. Values greater than 5 and - * negative values are not allowed. + * The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. */ retryCount?: number; } @@ -633,40 +410,7 @@ export namespace cloudscheduler_v1beta1 { */ export interface Schema$RunJobRequest {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -674,14 +418,11 @@ export namespace cloudscheduler_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1190,12 +931,7 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.patch - * @desc Updates a job. If successful, the updated Job is returned. If the - * job does not exist, `NOT_FOUND` is returned. If UpdateJob does not - * successfully return, it is possible for the job to be in an - * Job.State.UPDATE_FAILED state. A job in this state may not be executed. - * If this happens, retry the UpdateJob request until a successful response - * is received. + * @desc Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. * @alias cloudscheduler.projects.locations.jobs.patch * @memberOf! () * @@ -1267,10 +1003,7 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.pause - * @desc Pauses a job. If a job is paused then the system will stop - * executing the job until it is re-enabled via ResumeJob. The state of the - * job is stored in state; if paused it will be set to Job.State.PAUSED. A - * job must be in Job.State.ENABLED to be paused. + * @desc Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. * @alias cloudscheduler.projects.locations.jobs.pause * @memberOf! () * @@ -1344,10 +1077,7 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.resume - * @desc Resume a job. This method reenables a job after it has been - * Job.State.PAUSED. The state of a job is stored in Job.state; after - * calling this method it will be set to Job.State.ENABLED. A job must be in - * Job.State.PAUSED to be resumed. + * @desc Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. * @alias cloudscheduler.projects.locations.jobs.resume * @memberOf! () * @@ -1421,8 +1151,7 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.run - * @desc Forces a job to run now. When this method is called, Cloud - * Scheduler will dispatch the job, even if the job is already running. + * @desc Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. * @alias cloudscheduler.projects.locations.jobs.run * @memberOf! () * @@ -1503,8 +1232,7 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The location name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID`. + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */ parent?: string; @@ -1521,8 +1249,7 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; } @@ -1534,8 +1261,7 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; } @@ -1547,23 +1273,15 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. The maximum page size is 500. If unspecified, the - * page size will be the maximum. Fewer jobs than requested might be - * returned, even if more jobs exist; use next_page_token to determine if - * more jobs exist. + * Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. */ pageSize?: number; /** - * A token identifying a page of results the server will return. To request - * the first page results, page_token must be empty. To request the next - * page of results, page_token must be the value of next_page_token returned - * from the previous call to ListJobs. It is an error to switch the value of - * filter or order_by while iterating through pages. + * A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages. */ pageToken?: string; /** - * Required. The location name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID`. + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */ parent?: string; } @@ -1575,17 +1293,7 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optionally caller-specified in CreateJob, after which it becomes output - * only. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` - * can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons - * (:), or periods (.). For more information, see [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the job's location. The list - * of available locations can be obtained by calling ListLocations. For - * more information, see https://cloud.google.com/about/locations/. * - * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** @@ -1606,8 +1314,7 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; @@ -1624,8 +1331,7 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; @@ -1642,8 +1348,7 @@ export namespace cloudscheduler_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The job name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */ name?: string; diff --git a/src/apis/cloudsearch/package.json b/src/apis/cloudsearch/package.json index abbfedf01b4..7b5c3a5066a 100644 --- a/src/apis/cloudsearch/package.json +++ b/src/apis/cloudsearch/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 960147d6364..fd48e2add9c 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudsearch_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudsearch_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudsearch_v1 { /** * Cloud Search API * - * Cloud Search provides cloud-based search capabilities over G Suite data. - * The Cloud Search API allows indexing of non-G Suite data into Cloud Search. + * Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search. * * @example * const {google} = require('googleapis'); @@ -119,7 +114,10 @@ export namespace cloudsearch_v1 { stats: Resource$Stats; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.debug = new Resource$Debug(this.context); this.indexing = new Resource$Indexing(this.context); @@ -132,22 +130,11 @@ export namespace cloudsearch_v1 { } /** - * Used to provide a search operator for boolean properties. This is optional. - * Search operators let users restrict the query to specific fields relevant - * to the type of item being searched. + * Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ export interface Schema$BooleanOperatorOptions { /** - * Indicates the operator name required in the query in order to isolate the - * boolean property. For example, if operatorName is *closed* and the - * property's name is *isClosed*, then queries like - * *closed:&lt;value&gt;* will show results only where the value of - * the property named *isClosed* matches *&lt;value&gt;*. By - * contrast, a search that uses the same *&lt;value&gt;* without an - * operator will return all items where *&lt;value&gt;* matches the - * value of any String properties or text within the content field for the - * item. The operator name can only contain lowercase letters (a-z). The - * maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the boolean property. For example, if operatorName is *closed* and the property's name is *isClosed*, then queries like *closed:&lt;value&gt;* will show results only where the value of the property named *isClosed* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } @@ -190,15 +177,11 @@ export namespace cloudsearch_v1 { itemCountByStatus?: Schema$ItemCountByStatus[]; } /** - * Datasource is a logical namespace for items to be indexed. All items must - * belong to a datasource. This is the prerequisite before items can be - * indexed into Cloud Search. + * Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. */ export interface Schema$DataSource { /** - * If true, Indexing API rejects any modification calls to this datasource - * such as create, update, and delete. Disabling this does not imply halting - * process of previously accepted data. + * If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data. */ disableModifications?: boolean; /** @@ -206,8 +189,7 @@ export namespace cloudsearch_v1 { */ disableServing?: boolean; /** - * Required. Display name of the datasource The maximum length is 300 - * characters. + * Required. Display name of the datasource The maximum length is 300 characters. */ displayName?: string; /** @@ -215,34 +197,19 @@ export namespace cloudsearch_v1 { */ indexingServiceAccounts?: string[]; /** - * This field restricts visibility to items at the datasource level. Items - * within the datasource are restricted to the union of users and groups - * included in this field. Note that, this does not ensure access to a - * specific item, as users need to have ACL permissions on the contained - * items. This ensures a high level access on the entire datasource, and - * that the individual items are not shared outside this visibility. + * This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. */ itemsVisibility?: Schema$GSuitePrincipal[]; /** - * Name of the datasource resource. Format: datasources/{source_id}. <br - * />The name is ignored when creating a datasource. + * Name of the datasource resource. Format: datasources/{source_id}. <br />The name is ignored when creating a datasource. */ name?: string; /** - * IDs of the Long Running Operations (LROs) currently running for this - * schema. + * IDs of the Long Running Operations (LROs) currently running for this schema. */ operationIds?: string[]; /** - * A short name or alias for the source. This value will be used to match - * the 'source' operator. For example, if the short name is - * *&lt;value&gt;* then queries like *source:&lt;value&gt;* - * will only return results for this source. The value must be unique across - * all datasources. The value must only contain alphanumeric characters - * (a-zA-Z0-9). The value cannot start with 'google' and cannot be - * one of the following: mail, gmail, docs, drive, groups, sites, calendar, - * hangouts, gplus, keep, people, teams. Its maximum length is 32 - * characters. + * A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. */ shortName?: string; } @@ -251,10 +218,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$DataSourceIndexStats { /** - * Date for which index stats were calculated. If the date of request is not - * the current date then stats calculated on the next day are returned. - * Stats are calculated close to mid night in this case. If date of request - * is current date, then real time stats are returned. + * Date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned. */ date?: Schema$Date; /** @@ -267,13 +231,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$DataSourceRestriction { /** - * Filter options restricting the results. If multiple filters are present, - * they are grouped by object type before joining. Filters with the same - * object type are joined conjunctively, then the resulting expressions are - * joined disjunctively. The maximum number of elements is 20. NOTE: - * Suggest API supports only few filters at the moment: - * "objecttype", "type" and "mimetype". For - * now, schema specific filters cannot be used to filter suggestions. + * Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions. */ filterOptions?: Schema$FilterOptions[]; /** @@ -282,11 +240,7 @@ export namespace cloudsearch_v1 { source?: Schema$Source; } /** - * Represents a whole calendar date, for example a date of birth. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the [Proleptic Gregorian - * Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The - * date must be a valid calendar date between the year 1 and 9999. + * Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. */ export interface Schema$Date { /** @@ -303,43 +257,19 @@ export namespace cloudsearch_v1 { year?: number; } /** - * Optional. Provides a search operator for date properties. Search operators - * let users restrict the query to specific fields relevant to the type of - * item being searched. + * Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ export interface Schema$DateOperatorOptions { /** - * Indicates the operator name required in the query in order to isolate the - * date property using the greater-than operator. For example, if - * greaterThanOperatorName is *closedafter* and the property's name is - * *closeDate*, then queries like *closedafter:&lt;value&gt;* will - * show results only where the value of the property named *closeDate* is - * later than *&lt;value&gt;*. The operator name can only contain - * lowercase letters (a-z). The maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:&lt;value&gt;* will show results only where the value of the property named *closeDate* is later than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ greaterThanOperatorName?: string; /** - * Indicates the operator name required in the query in order to isolate the - * date property using the less-than operator. For example, if - * lessThanOperatorName is *closedbefore* and the property's name is - * *closeDate*, then queries like *closedbefore:&lt;value&gt;* will - * show results only where the value of the property named *closeDate* is - * earlier than *&lt;value&gt;*. The operator name can only contain - * lowercase letters (a-z). The maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:&lt;value&gt;* will show results only where the value of the property named *closeDate* is earlier than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ lessThanOperatorName?: string; /** - * Indicates the actual string required in the query in order to isolate the - * date property. For example, suppose an issue tracking schema object has a - * property named *closeDate* that specifies an operator with an - * operatorName of *closedon*. For searches on that data, queries like - * *closedon:&lt;value&gt;* will show results only where the value - * of the *closeDate* property matches *&lt;value&gt;*. By contrast, - * a search that uses the same *&lt;value&gt;* without an operator - * will return all items where *&lt;value&gt;* matches the value of - * any String properties or text within the content field for the indexed - * datasource. The operator name can only contain lowercase letters (a-z). - * The maximum length is 32 characters. + * Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:&lt;value&gt;* will show results only where the value of the *closeDate* property matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } @@ -363,15 +293,13 @@ export namespace cloudsearch_v1 { */ export interface Schema$DebugOptions { /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ enableDebugging?: boolean; } export interface Schema$DeleteQueueItemsRequest { /** - * Name of connector making this call. <br />Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** @@ -384,30 +312,20 @@ export namespace cloudsearch_v1 { queue?: string; } /** - * A reference to a top-level property within the object that should be - * displayed in search results. The values of the chosen properties will be - * displayed in the search results along with the dislpay label for that - * property if one is specified. If a display label is not specified, only the - * values will be shown. + * A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties will be displayed in the search results along with the dislpay label for that property if one is specified. If a display label is not specified, only the values will be shown. */ export interface Schema$DisplayedProperty { /** - * The name of the top-level property as defined in a property definition - * for the object. If the name is not a defined property in the schema, an - * error will be given when attempting to update the schema. + * The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error will be given when attempting to update the schema. */ propertyName?: string; } /** - * Used to provide a search operator for double properties. This is optional. - * Search operators let users restrict the query to specific fields relevant - * to the type of item being searched. + * Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ export interface Schema$DoubleOperatorOptions { /** - * Indicates the operator name required in the query in order to use the - * double property in sorting or as a facet. The operator name can only - * contain lowercase letters (a-z). The maximum length is 32 characters. + * Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } @@ -445,8 +363,7 @@ export namespace cloudsearch_v1 { type?: string; } /** - * The time span search restrict (e.g. "after:2017-09-11 - * before:2017-09-12"). + * The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12"). */ export interface Schema$DriveTimeSpanRestrict { type?: string; @@ -461,42 +378,16 @@ export namespace cloudsearch_v1 { emailAddress?: string; } /** - * Used to provide a search operator for enum properties. This is optional. - * Search operators let users restrict the query to specific fields relevant - * to the type of item being searched. For example, if you provide no operator - * for a *priority* enum property with possible values *p0* and *p1*, a query - * that contains the term *p0* will return items that have *p0* as the value - * of the *priority* property, as well as any items that contain the string - * *p0* in other fields. If you provide an operator name for the enum, such as - * *priority*, then search users can use that operator to refine results to - * only items that have *p0* as this property's value, with the query - * *priority:p0*. + * Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* will return items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*. */ export interface Schema$EnumOperatorOptions { /** - * Indicates the operator name required in the query in order to isolate the - * enum property. For example, if operatorName is *priority* and the - * property's name is *priorityVal*, then queries like - * *priority:&lt;value&gt;* will show results only where the value - * of the property named *priorityVal* matches *&lt;value&gt;*. By - * contrast, a search that uses the same *&lt;value&gt;* without an - * operator will return all items where *&lt;value&gt;* matches the - * value of any String properties or text within the content field for the - * item. The operator name can only contain lowercase letters (a-z). The - * maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:&lt;value&gt;* will show results only where the value of the property named *priorityVal* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } /** - * Options for enum properties, which allow you to define a restricted set of - * strings to match user queries, set rankings for those string values, and - * define an operator name to be paired with those strings so that users can - * narrow results to only items with a specific value. For example, for items - * in a request tracking system with priority information, you could define - * *p0* as an allowable enum value and tie this enum to the operator name - * *priority* so that search users could add *priority:p0* to their query to - * restrict the set of results to only those items indexed with the value - * *p0*. + * Options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*. */ export interface Schema$EnumPropertyOptions { /** @@ -504,49 +395,24 @@ export namespace cloudsearch_v1 { */ operatorOptions?: Schema$EnumOperatorOptions; /** - * Used to specify the ordered ranking for the enumeration that determines - * how the integer values provided in the possible EnumValuePairs are used - * to rank results. If specified, integer values must be provided for all - * possible EnumValuePair values given for this property. Can only be used - * if isRepeatable is false. + * Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false. */ orderedRanking?: string; /** - * The list of possible values for the enumeration property. All - * EnumValuePairs must provide a string value. If you specify an integer - * value for one EnumValuePair, then all possible EnumValuePairs must - * provide an integer value. Both the string value and integer value must be - * unique over all possible values. Once set, possible values cannot be - * removed or modified. If you supply an ordered ranking and think you might - * insert additional enum values in the future, leave gaps in the initial - * integer values to allow adding a value in between previously registered - * values. The maximum number of elements is 100. + * The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100. */ possibleValues?: Schema$EnumValuePair[]; } /** - * The enumeration value pair defines two things: a required string value and - * an optional integer value. The string value defines the necessary query - * term required to retrieve that item, such as *p0* for a priority item. The - * integer value determines the ranking of that string value relative to other - * enumerated values for the same property. For example, you might associate - * *p0* with *0* and define another enum pair such as *p1* and *1*. You must - * use the integer value in combination with ordered ranking to set the - * ranking of a given value relative to other enumerated values for the same - * property name. Here, a ranking order of DESCENDING for *priority* - * properties results in a ranking boost for items indexed with a value of - * *p0* compared to items indexed with a value of *p1*. Without a specified - * ranking order, the integer value has no effect on item ranking. + * The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking. */ export interface Schema$EnumValuePair { /** - * The integer value of the EnumValuePair which must be non-negative. - * Optional. + * The integer value of the EnumValuePair which must be non-negative. Optional. */ integerValue?: number; /** - * The string value of the EnumValuePair. The maximum length is 32 - * characters. + * The string value of the EnumValuePair. The maximum length is 32 characters. */ stringValue?: string; } @@ -573,40 +439,29 @@ export namespace cloudsearch_v1 { source?: Schema$Source; } /** - * A bucket in a facet is the basic unit of operation. A bucket can comprise - * either a single value OR a contiguous range of values, depending on the - * type of the field bucketed. FacetBucket is currently used only for - * returning the response object. + * A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object. */ export interface Schema$FacetBucket { /** - * Number of results that match the bucket value. Counts are only returned - * for searches when count accuracy is ensured. Can be empty. + * Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty. */ count?: number; /** - * Percent of results that match the bucket value. This value is between - * (0-100]. Percentages are returned for all searches, but are an estimate. - * Because percentages are always returned, you should render percentages - * instead of counts. + * Percent of results that match the bucket value. This value is between (0-100]. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts. */ percentage?: number; value?: Schema$Value; } /** - * Specifies operators to return facet results for. There will be one - * FacetResult for every source_name/object_type/operator_name combination. + * Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination. */ export interface Schema$FacetOptions { /** - * Maximum number of facet buckets that should be returned for this facet. - * Defaults to 10. Maximum value is 100. + * Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100. */ numFacetBuckets?: number; /** - * If object_type is set, only those objects of that type will be used to - * compute facets. If empty, then all objects will be used to compute - * facets. + * If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets. */ objectType?: string; /** @@ -614,8 +469,7 @@ export namespace cloudsearch_v1 { */ operatorName?: string; /** - * Source name to facet on. Format: datasources/{source_id} If empty, all - * data sources will be used. + * Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used. */ sourceName?: string; } @@ -651,13 +505,7 @@ export namespace cloudsearch_v1 { field?: string; } /** - * A generic way of expressing filters in a query, which supports two - * approaches: <br/><br/> **1. Setting a ValueFilter.** The name - * must match an operator_name defined in the schema for your data source. - * <br/> **2. Setting a CompositeFilter.** The filters are evaluated - * using the logical operator. The top-level operators can only be either an - * AND or a NOT. AND can appear only at the top-most level. OR can appear only - * under a top-level AND. + * A generic way of expressing filters in a query, which supports two approaches: <br/><br/> **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. <br/> **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. */ export interface Schema$Filter { compositeFilter?: Schema$CompositeFilter; @@ -672,34 +520,20 @@ export namespace cloudsearch_v1 { */ filter?: Schema$Filter; /** - * If object_type is set, only objects of that type are returned. This - * should correspond to the name of the object that was registered within - * the definition of schema. The maximum length is 256 characters. + * If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters. */ objectType?: string; } /** - * Indicates which freshness property to use when adjusting search ranking for - * an item. Fresher, more recent dates indicate higher quality. Use the - * freshness option property that best works with your data. For fileshare - * documents, last modified time is most relevant. For calendar event data, - * the time when the event occurs is a more relevant freshness indicator. In - * this way, calendar events that occur closer to the time of the search query - * are considered higher quality and ranked accordingly. + * Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly. */ export interface Schema$FreshnessOptions { /** - * The duration after which an object should be considered stale. The - * default value is 180 days (in seconds). + * The duration after which an object should be considered stale. The default value is 180 days (in seconds). */ freshnessDuration?: string; /** - * This property indicates the freshness level of the object in the index. - * If set, this property must be a top-level property within the property - * definitions and it must be a timestamp type or date type. Otherwise, the - * Indexing API uses updateTime as the freshness indicator. The maximum - * length is 256 characters. When a property is used to calculate - * fresheness, the value defaults to 2 years from the current time. + * This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate fresheness, the value defaults to 2 years from the current time. */ freshnessProperty?: string; } @@ -747,8 +581,7 @@ export namespace cloudsearch_v1 { } export interface Schema$GSuitePrincipal { /** - * This principal represents all users of the G Suite domain of the - * customer. + * This principal represents all users of the G Suite domain of the customer. */ gsuiteDomain?: boolean; /** @@ -761,22 +594,11 @@ export namespace cloudsearch_v1 { gsuiteUserEmail?: string; } /** - * Used to provide a search operator for html properties. This is optional. - * Search operators let users restrict the query to specific fields relevant - * to the type of item being searched. + * Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ export interface Schema$HtmlOperatorOptions { /** - * Indicates the operator name required in the query in order to isolate the - * html property. For example, if operatorName is *subject* and the - * property's name is *subjectLine*, then queries like - * *subject:&lt;value&gt;* will show results only where the value of - * the property named *subjectLine* matches *&lt;value&gt;*. By - * contrast, a search that uses the same *&lt;value&gt;* without an - * operator will return all items where *&lt;value&gt;* matches the - * value of any html properties or text within the content field for the - * item. The operator name can only contain lowercase letters (a-z). The - * maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:&lt;value&gt;* will show results only where the value of the property named *subjectLine* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } @@ -789,8 +611,7 @@ export namespace cloudsearch_v1 { */ operatorOptions?: Schema$HtmlOperatorOptions; /** - * Indicates the search quality importance of the tokens within the field - * when used for retrieval. Can only be set to DEFAULT or NONE. + * Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE. */ retrievalImportance?: Schema$RetrievalImportance; } @@ -805,15 +626,13 @@ export namespace cloudsearch_v1 { } export interface Schema$IndexItemOptions { /** - * Specifies if the index request should allow gsuite principals that do not - * exist or are deleted in the index request. + * Specifies if the index request should allow gsuite principals that do not exist or are deleted in the index request. */ allowUnknownGsuitePrincipals?: boolean; } export interface Schema$IndexItemRequest { /** - * Name of connector making this call. <br />Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** @@ -831,44 +650,19 @@ export namespace cloudsearch_v1 { mode?: string; } /** - * Used to provide a search operator for integer properties. This is optional. - * Search operators let users restrict the query to specific fields relevant - * to the type of item being searched. + * Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ export interface Schema$IntegerOperatorOptions { /** - * Indicates the operator name required in the query in order to isolate the - * integer property using the greater-than operator. For example, if - * greaterThanOperatorName is *priorityabove* and the property's name is - * *priorityVal*, then queries like *priorityabove:&lt;value&gt;* - * will show results only where the value of the property named - * *priorityVal* is greater than *&lt;value&gt;*. The operator name - * can only contain lowercase letters (a-z). The maximum length is 32 - * characters. + * Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:&lt;value&gt;* will show results only where the value of the property named *priorityVal* is greater than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ greaterThanOperatorName?: string; /** - * Indicates the operator name required in the query in order to isolate the - * integer property using the less-than operator. For example, if - * lessThanOperatorName is *prioritybelow* and the property's name is - * *priorityVal*, then queries like *prioritybelow:&lt;value&gt;* - * will show results only where the value of the property named - * *priorityVal* is less than *&lt;value&gt;*. The operator name can - * only contain lowercase letters (a-z). The maximum length is 32 - * characters. + * Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:&lt;value&gt;* will show results only where the value of the property named *priorityVal* is less than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ lessThanOperatorName?: string; /** - * Indicates the operator name required in the query in order to isolate the - * integer property. For example, if operatorName is *priority* and the - * property's name is *priorityVal*, then queries like - * *priority:&lt;value&gt;* will show results only where the value - * of the property named *priorityVal* matches *&lt;value&gt;*. By - * contrast, a search that uses the same *&lt;value&gt;* without an - * operator will return all items where *&lt;value&gt;* matches the - * value of any String properties or text within the content field for the - * item. The operator name can only contain lowercase letters (a-z). The - * maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:&lt;value&gt;* will show results only where the value of the property named *priorityVal* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } @@ -877,17 +671,11 @@ export namespace cloudsearch_v1 { */ export interface Schema$IntegerPropertyOptions { /** - * The maximum value of the property. The minimum and maximum values for the - * property are used to rank results according to the ordered ranking. - * Indexing requests with values greater than the maximum are accepted and - * ranked with the same weight as items indexed with the maximum value. + * The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value. */ maximumValue?: string; /** - * The minimum value of the property. The minimum and maximum values for the - * property are used to rank results according to the ordered ranking. - * Indexing requests with values less than the minimum are accepted and - * ranked with the same weight as items indexed with the minimum value. + * The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value. */ minimumValue?: string; /** @@ -895,8 +683,7 @@ export namespace cloudsearch_v1 { */ operatorOptions?: Schema$IntegerOperatorOptions; /** - * Used to specify the ordered ranking for the integer. Can only be used if - * isRepeatable is false. + * Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false. */ orderedRanking?: string; } @@ -911,9 +698,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$Interaction { /** - * The time when the user acted on the item. If multiple actions of the - * same type exist for a single user, only the most recent action is - * recorded. + * The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded. */ interactionTime?: string; /** @@ -923,8 +708,7 @@ export namespace cloudsearch_v1 { type?: string; } /** - * Represents a single object that is an item in the search index, such as a - * file, folder, or a database record. + * Represents a single object that is an item in the search index, such as a file, folder, or a database record. */ export interface Schema$Item { /** @@ -944,13 +728,11 @@ export namespace cloudsearch_v1 { */ metadata?: Schema$ItemMetadata; /** - * Name of the Item. Format: datasources/{source_id}/items/{item_id} <br - * />This is a required field. The maximum length is 1536 characters. + * Name of the Item. Format: datasources/{source_id}/items/{item_id} <br />This is a required field. The maximum length is 1536 characters. */ name?: string; /** - * Additional state connector can store for this item. The maximum length is - * 10000 bytes. + * Additional state connector can store for this item. The maximum length is 10000 bytes. */ payload?: string; /** @@ -962,64 +744,36 @@ export namespace cloudsearch_v1 { */ status?: Schema$ItemStatus; /** - * The structured data for the item that should conform to a registered - * object definition in the schema for the data source. + * The structured data for the item that should conform to a registered object definition in the schema for the data source. */ structuredData?: Schema$ItemStructuredData; /** - * Required. The indexing system stores the version from the datasource as a - * byte string and compares the Item version in the index to the version of - * the queued Item using lexical ordering. <br /><br /> Cloud - * Search Indexing won't index or delete any queued item with a version - * value that is less than or equal to the version of the currently indexed - * item. The maximum length for this field is 1024 bytes. + * Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. <br /><br /> Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. */ version?: string; } /** - * Access control list information for the item. For more information see - * https://developers.google.com/cloud-search/docs/guides/index-your-data#acls + * Access control list information for the item. For more information see https://developers.google.com/cloud-search/docs/guides/index-your-data#acls */ export interface Schema$ItemAcl { /** - * Sets the type of access rules to apply when an item inherits its ACL from - * a parent. This should always be set in tandem with the inheritAclFrom - * field. Also, when the inheritAclFrom field is set, this field should be - * set to a valid AclInheritanceType. + * Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. */ aclInheritanceType?: string; /** - * List of principals who are explicitly denied access to the item in search - * results. While principals are denied access by default, use denied - * readers to handle exceptions and override the list allowed readers. The - * maximum number of elements is 100. + * List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. */ deniedReaders?: Schema$Principal[]; /** - * Name of the item to inherit the Access Permission List (ACL) from. Note: - * ACL inheritance *only* provides access permissions to child items and - * does not define structural relationships, nor does it provide convenient - * ways to delete large groups of items. Deleting an ACL parent from the - * index only alters the access permissions of child items that reference - * the parent in the inheritAclFrom field. The item is still in the index, - * but may not visible in search results. By contrast, deletion of a - * container item also deletes all items that reference the container via - * the containerName field. The maximum length for this field is 1536 - * characters. + * Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters. */ inheritAclFrom?: string; /** - * Optional. List of owners for the item. This field has no bearing on - * document access permissions. It does, however, offer a slight ranking - * boosts items where the querying user is an owner. The maximum number of - * elements is 5. + * Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5. */ owners?: Schema$Principal[]; /** - * List of principals who are allowed to see the item in search results. - * Optional if inheriting permissions from another item or if the item is - * not intended to be visible, such as virtual containers. The maximum - * number of elements is 1000. + * List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000. */ readers?: Schema$Principal[]; } @@ -1033,14 +787,11 @@ export namespace cloudsearch_v1 { contentDataRef?: Schema$UploadItemRef; contentFormat?: string; /** - * Hashing info calculated and provided by the API client for content. Can - * be used with the items.push method to calculate modified state. The - * maximum length is 2048 characters. + * Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ hash?: string; /** - * Content that is supplied inlined within the update method. The maximum - * length is 102400 bytes (100 KiB). + * Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB). */ inlineContent?: string; } @@ -1059,17 +810,11 @@ export namespace cloudsearch_v1 { */ export interface Schema$ItemMetadata { /** - * The name of the container for this item. Deletion of the container item - * leads to automatic deletion of this item. Note: ACLs are not inherited - * from a container item. To provide ACL inheritance for an item, use the - * inheritAclFrom field. The maximum length is 1536 characters. + * The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters. */ containerName?: string; /** - * The BCP-47 language code for the item, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The - * maximum length is 32 characters. + * The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters. */ contentLanguage?: string; /** @@ -1077,35 +822,23 @@ export namespace cloudsearch_v1 { */ createTime?: string; /** - * Hashing value provided by the API caller. This can be used with the - * items.push method to calculate modified state. The maximum length is 2048 - * characters. + * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ hash?: string; /** - * A list of interactions for the item. Interactions are used to improve - * Search quality, but are not exposed to end users. The maximum number of - * elements is 1000. + * A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000. */ interactions?: Schema$Interaction[]; /** - * Additional keywords or phrases that should match the item. Used - * internally for user generated content. The maximum number of elements is - * 100. The maximum length is 8192 characters. + * Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters. */ keywords?: string[]; /** - * The original mime-type of ItemContent.content in the source repository. - * The maximum length is 256 characters. + * The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters. */ mimeType?: string; /** - * The type of the item. This should correspond to the name of an object - * definition in the schema registered for the data source. For example, if - * the schema for the data source contains an object definition with name - * 'document', then item indexing requests for objects of that type - * should set objectType to 'document'. The maximum length is 256 - * characters. + * The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters. */ objectType?: string; /** @@ -1113,13 +846,11 @@ export namespace cloudsearch_v1 { */ searchQualityMetadata?: Schema$SearchQualityMetadata; /** - * Link to the source repository serving the data. &#83;earch results - * apply this link to the title. The maximum length is 2048 characters. + * Link to the source repository serving the data. &#83;earch results apply this link to the title. The maximum length is 2048 characters. */ sourceRepositoryUrl?: string; /** - * The title of the item. If given, this will be the displayed title of the - * Search result. The maximum length is 2048 characters. + * The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters. */ title?: string; /** @@ -1149,21 +880,17 @@ export namespace cloudsearch_v1 { */ export interface Schema$ItemStructuredData { /** - * Hashing value provided by the API caller. This can be used with the - * items.push method to calculate modified state. The maximum length is 2048 - * characters. + * Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters. */ hash?: string; /** - * The structured data object that should conform to a registered object - * definition in the schema for the data source. + * The structured data object that should conform to a registered object definition in the schema for the data source. */ object?: Schema$StructuredDataObject; } export interface Schema$ListDataSourceResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; sources?: Schema$DataSource[]; @@ -1171,16 +898,14 @@ export namespace cloudsearch_v1 { export interface Schema$ListItemNamesForUnmappedIdentityResponse { itemNames?: string[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } export interface Schema$ListItemsResponse { items?: Schema$Item[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1193,16 +918,14 @@ export namespace cloudsearch_v1 { } export interface Schema$ListSearchApplicationsResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; searchApplications?: Schema$SearchApplication[]; } export interface Schema$ListUnmappedIdentitiesResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; unmappedIdentities?: Schema$UnmappedIdentity[]; @@ -1262,20 +985,16 @@ export namespace cloudsearch_v1 { */ source?: Schema$Source; /** - * The last modified date for the object in the search result. If not set in - * the item, the value returned here is empty. When `updateTime` is used for - * calculating freshness and is not set, this value defaults to 2 years from - * the current time. + * The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time. */ updateTime?: string; } /** - * A metaline is a list of properties that are displayed along with the search - * result to provide context. + * A metaline is a list of properties that are displayed along with the search result to provide context. */ export interface Schema$Metaline { /** - * The list of displayed properties for the metaline. + * The list of displayed properties for the metaline. The maxiumum number of properties is 5. */ properties?: Schema$DisplayedProperty[]; } @@ -1284,16 +1003,12 @@ export namespace cloudsearch_v1 { */ export interface Schema$Name { /** - * The read-only display name formatted according to the locale specified by - * the viewer's account or the <code>Accept-Language</code> - * HTTP header. + * The read-only display name formatted according to the locale specified by the viewer's account or the <code>Accept-Language</code> HTTP header. */ displayName?: string; } /** - * A typed name-value pair for structured data. The type of the value should - * be the same as the registered type for the `name` property in the object - * definition of `objectType`. + * A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`. */ export interface Schema$NamedProperty { booleanValue?: boolean; @@ -1303,9 +1018,7 @@ export namespace cloudsearch_v1 { htmlValues?: Schema$HtmlValues; integerValues?: Schema$IntegerValues; /** - * The name of the property. This name should correspond to the name of the - * property that was registered for object definition in the schema. The - * maximum allowable length for this property is 256 characters. + * The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters. */ name?: string; objectValues?: Schema$ObjectValues; @@ -1317,13 +1030,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$ObjectDefinition { /** - * Name for the object, which then defines its type. Item indexing requests - * should set the objectType field equal to this value. For example, if - * *name* is *Document*, then indexing requests for items of type Document - * should set objectType equal to *Document*. Each object definition must be - * uniquely named within a schema. The name must start with a letter and can - * only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is - * 256 characters. + * Name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. */ name?: string; /** @@ -1331,8 +1038,7 @@ export namespace cloudsearch_v1 { */ options?: Schema$ObjectOptions; /** - * The property definitions for the object. The maximum number of elements - * is 1000. + * The property definitions for the object. The maximum number of elements is 1000. */ propertyDefinitions?: Schema$PropertyDefinition[]; } @@ -1341,20 +1047,11 @@ export namespace cloudsearch_v1 { */ export interface Schema$ObjectDisplayOptions { /** - * Defines the properties that will be displayed in the metalines of the - * search results. The property values will be displayed in the order given - * here. If a property holds multiple values, all of the values will be - * diplayed before the next properties. For this reason, it is a good - * practice to specify singular properties before repeated properties in - * this list. All of the properties must set is_returnable to true. The - * maximum number of elements is 3. + * Defines the properties that will be displayed in the metalines of the search results. The property values will be displayed in the order given here. If a property holds multiple values, all of the values will be diplayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3. */ metalines?: Schema$Metaline[]; /** - * The user friendly label to display in the search result to inidicate the - * type of the item. This is OPTIONAL; if not given, an object label will - * not be displayed on the context line of the search results. The maximum - * length is 32 characters. + * The user friendly label to display in the search result to inidicate the type of the item. This is OPTIONAL; if not given, an object label will not be displayed on the context line of the search results. The maximum length is 32 characters. */ objectDisplayLabel?: string; } @@ -1363,8 +1060,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$ObjectOptions { /** - * Options that determine how the object is displayed in the Cloud Search - * results page. + * Options that determine how the object is displayed in the Cloud Search results page. */ displayOptions?: Schema$ObjectDisplayOptions; /** @@ -1377,10 +1073,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$ObjectPropertyOptions { /** - * The properties of the sub-object. These properties represent a nested - * object. For example, if this property represents a postal address, the - * subobjectProperties might be named *street*, *city*, and *state*. The - * maximum number of elements is 1000. + * The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000. */ subobjectProperties?: Schema$PropertyDefinition[]; } @@ -1391,14 +1084,11 @@ export namespace cloudsearch_v1 { values?: Schema$StructuredDataObject[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1406,26 +1096,15 @@ export namespace cloudsearch_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -1447,9 +1126,7 @@ export namespace cloudsearch_v1 { */ emailAddresses?: Schema$EmailAddress[]; /** - * The resource name of the person to provide information about. See <a - * href="https://developers.google.com/people/api/rest/v1/people/get"> - * People.get</a> from Google People API. + * The resource name of the person to provide information about. See <a href="https://developers.google.com/people/api/rest/v1/people/get"> People.get</a> from Google People API. */ name?: string; /** @@ -1461,8 +1138,7 @@ export namespace cloudsearch_v1 { */ personNames?: Schema$Name[]; /** - * A person's read-only photo. A picture shown next to the person's - * name to help others recognize the person in search results. + * A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results. */ photos?: Schema$Photo[]; } @@ -1477,8 +1153,7 @@ export namespace cloudsearch_v1 { } export interface Schema$PollItemsRequest { /** - * Name of connector making this call. <br />Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** @@ -1486,13 +1161,11 @@ export namespace cloudsearch_v1 { */ debugOptions?: Schema$DebugOptions; /** - * Maximum number of items to return. <br />The maximum and the - * default value is 1000 + * Maximum number of items to return. <br />The maximum and the default value is 1000 */ limit?: number; /** - * Queue name to fetch items from. If unspecified, PollItems will fetch - * from 'default' queue. The maximum length is 100 characters. + * Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters. */ queue?: string; /** @@ -1502,11 +1175,7 @@ export namespace cloudsearch_v1 { } export interface Schema$PollItemsResponse { /** - * Set of items from the queue available for connector to process. <br - * />These items have the following subset of fields populated: <br - * /> <br />version <br />metadata.hash <br - * />structured_data.hash <br />content.hash <br />payload - * <br />status <br />queue + * Set of items from the queue available for connector to process. <br />These items have the following subset of fields populated: <br /> <br />version <br />metadata.hash <br />structured_data.hash <br />content.hash <br />payload <br />status <br />queue */ items?: Schema$Item[]; } @@ -1515,9 +1184,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$Principal { /** - * This principal is a group identified using an external identity. The name - * field must specify the group resource name with this format: - * identitysources/{source_id}/groups/{ID} + * This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID} */ groupResourceName?: string; /** @@ -1525,9 +1192,7 @@ export namespace cloudsearch_v1 { */ gsuitePrincipal?: Schema$GSuitePrincipal; /** - * This principal is a user identified using an external identity. The name - * field must specify the user resource name with this format: - * identitysources/{source_id}/users/{ID} + * This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID} */ userResourceName?: string; } @@ -1541,8 +1206,7 @@ export namespace cloudsearch_v1 { */ errorMessage?: string; /** - * In case the item fields are invalid, this field contains the details - * about the validation errors. + * In case the item fields are invalid, this field contains the details about the validation errors. */ fieldViolations?: Schema$FieldViolation[]; } @@ -1553,9 +1217,7 @@ export namespace cloudsearch_v1 { booleanPropertyOptions?: Schema$BooleanPropertyOptions; datePropertyOptions?: Schema$DatePropertyOptions; /** - * Options that determine how the property is displayed in the Cloud Search - * results page if it is specified to be displayed in the object's - * display options . + * Options that determine how the property is displayed in the Cloud Search results page if it is specified to be displayed in the object's display options . */ displayOptions?: Schema$PropertyDisplayOptions; doublePropertyOptions?: Schema$DoublePropertyOptions; @@ -1563,47 +1225,23 @@ export namespace cloudsearch_v1 { htmlPropertyOptions?: Schema$HtmlPropertyOptions; integerPropertyOptions?: Schema$IntegerPropertyOptions; /** - * Indicates that the property can be used for generating facets. Cannot be - * true for properties whose type is object. IsReturnable must be true to - * set this option. Only supported for Boolean, Enum, and Text properties. + * Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for Boolean, Enum, and Text properties. */ isFacetable?: boolean; /** - * Indicates that multiple values are allowed for the property. For example, - * a document only has one description but can have multiple comments. - * Cannot be true for properties whose type is a boolean. If set to false, - * properties that contain more than one value will cause the indexing - * request for that item to be rejected. + * Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value will cause the indexing request for that item to be rejected. */ isRepeatable?: boolean; /** - * Indicates that the property identifies data that should be returned in - * search results via the Query API. If set to *true*, indicates that Query - * API users can use matching property fields in results. However, storing - * fields requires more space allocation and uses more bandwidth for search - * queries, which impacts performance over large datasets. Set to *true* - * here only if the field is needed for search results. Cannot be true for - * properties whose type is an object. + * Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object. */ isReturnable?: boolean; /** - * Indicates that the property can be used for sorting. Cannot be true for - * properties that are repeatable. Cannot be true for properties whose type - * is object or user identifier. IsReturnable must be true to set this - * option. Only supported for Boolean, Date, Double, Integer, and Timestamp - * properties. + * Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object or user identifier. IsReturnable must be true to set this option. Only supported for Boolean, Date, Double, Integer, and Timestamp properties. */ isSortable?: boolean; /** - * The name of the property. Item indexing requests sent to the Indexing API - * should set the property name equal to this value. For example, if name is - * *subject_line*, then indexing requests for document items with subject - * fields should set the name for that field equal to *subject_line*. Use - * the name as the identifier for the object property. Once registered as a - * property for an object, you cannot re-use this name for another property - * within that object. The name must start with a letter and can only - * contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 - * characters. + * The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. */ name?: string; objectPropertyOptions?: Schema$ObjectPropertyOptions; @@ -1615,16 +1253,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$PropertyDisplayOptions { /** - * The user friendly label for the property that will be used if the - * property is specified to be displayed in ObjectDisplayOptions. If given, - * the display label will be shown in front of the property values when the - * property is part of the object display options. For example, if the - * property value is '1', the value by itself may not be useful - * context for the user. If the display name given was 'priority', - * then the user will see 'priority : 1' in the search results which - * provides clear conext to search users. This is OPTIONAL; if not given, - * only the property values will be displayed. The maximum length is 32 - * characters. + * The user friendly label for the property that will be used if the property is specified to be displayed in ObjectDisplayOptions. If given, the display label will be shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user will see 'priority : 1' in the search results which provides clear conext to search users. This is OPTIONAL; if not given, only the property values will be displayed. The maximum length is 32 characters. */ displayLabel?: string; } @@ -1633,42 +1262,27 @@ export namespace cloudsearch_v1 { */ export interface Schema$PushItem { /** - * Content hash of the item according to the repository. If specified, this - * is used to determine how to modify this item's status. Setting this - * field and the type field results in argument error. The maximum length is - * 2048 characters. + * Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. */ contentHash?: string; /** - * Metadata hash of the item according to the repository. If specified, this - * is used to determine how to modify this item's status. Setting this - * field and the type field results in argument error. The maximum length is - * 2048 characters. + * Metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. */ metadataHash?: string; /** - * Provides additional document state information for the connector, such as - * an alternate repository ID and other metadata. The maximum length is 8192 - * bytes. + * Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes. */ payload?: string; /** - * Queue to which this item belongs to. The - * <code>default</code> queue is chosen if this field is not - * specified. The maximum length is 512 characters. + * Queue to which this item belongs to. The <code>default</code> queue is chosen if this field is not specified. The maximum length is 512 characters. */ queue?: string; /** - * Populate this field to store Connector or repository error details. This - * information is displayed in the Admin Console. This field may only be - * populated when the Type is REPOSITORY_ERROR. + * Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR. */ repositoryError?: Schema$RepositoryError; /** - * Structured data hash of the item according to the repository. If - * specified, this is used to determine how to modify this item's - * status. Setting this field and the type field results in argument error. - * The maximum length is 2048 characters. + * Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. */ structuredDataHash?: string; /** @@ -1678,8 +1292,7 @@ export namespace cloudsearch_v1 { } export interface Schema$PushItemRequest { /** - * Name of connector making this call. <br />Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** @@ -1694,9 +1307,7 @@ export namespace cloudsearch_v1 { export interface Schema$QueryInterpretation { interpretationType?: string; /** - * The interpretation of the query used in search. For example, query - * "email from john" will be interpreted as "from:john - * source:mail" + * The interpretation of the query used in search. For example, query "email from john" will be interpreted as "from:john source:mail" */ interpretedQuery?: string; } @@ -1705,9 +1316,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$QueryInterpretationOptions { /** - * Flag to disable natural language (NL) interpretation of queries. Default - * is false, Set to true to disable natural language interpretation. NL - * interpretation only applies to predefined datasources. + * Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources. */ disableNlInterpretation?: boolean; } @@ -1716,8 +1325,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$QueryItem { /** - * True if the text was generated by means other than a previous user - * search. + * True if the text was generated by means other than a previous user search. */ isSynthetic?: boolean; } @@ -1730,14 +1338,11 @@ export namespace cloudsearch_v1 { */ displayName?: string; /** - * Potential list of values for the opeatror field. This field is only - * filled when we can safely enumerate all the possible values of this - * operator. + * Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator. */ enumValues?: string[]; /** - * Indicates the operator name that can be used to isolate the property - * using the greater-than operator. + * Indicates the operator name that can be used to isolate the property using the greater-than operator. */ greaterThanOperatorName?: string; /** @@ -1749,8 +1354,7 @@ export namespace cloudsearch_v1 { */ isRepeatable?: boolean; /** - * Will the property associated with this facet be returned as part of - * search results. + * Will the property associated with this facet be returned as part of search results. */ isReturnable?: boolean; /** @@ -1762,8 +1366,7 @@ export namespace cloudsearch_v1 { */ isSuggestable?: boolean; /** - * Indicates the operator name that can be used to isolate the property - * using the less-than operator. + * Indicates the operator name that can be used to isolate the property using the less-than operator. */ lessThanOperatorName?: string; /** @@ -1788,8 +1391,7 @@ export namespace cloudsearch_v1 { */ operators?: Schema$QueryOperator[]; /** - * A short name or alias for the source. This value can be used with the - * 'source' operator. + * A short name or alias for the source. This value can be used with the 'source' operator. */ shortName?: string; /** @@ -1798,8 +1400,7 @@ export namespace cloudsearch_v1 { source?: Schema$Source; } /** - * This field does not contain anything as of now and is just used as an - * indicator that the suggest result was a phrase completion. + * This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion. */ export interface Schema$QuerySuggestion {} /** @@ -1807,8 +1408,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$RepositoryError { /** - * Message that describes the error. The maximum allowable length of the - * message is 8192 characters. + * Message that describes the error. The maximum allowable length of the message is 8192 characters. */ errorMessage?: string; /** @@ -1829,12 +1429,7 @@ export namespace cloudsearch_v1 { */ debugOptions?: Schema$DebugOptions; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For - * translations. When specified, the documents in search results are biased - * towards the specified language. Suggest API does not use this parameter. - * It autocompletes only based on characters in the query. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. */ languageCode?: string; /** @@ -1842,11 +1437,7 @@ export namespace cloudsearch_v1 { */ searchApplicationId?: string; /** - * Current user's time zone id, such as "America/Los_Angeles" - * or "Australia/Sydney". These IDs are defined by [Unicode Common - * Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and - * currently available in the file - * [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + * Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) */ timeZone?: string; } @@ -1888,8 +1479,7 @@ export namespace cloudsearch_v1 { gmailIntelligentRestrict?: Schema$GmailIntelligentRestrict; gmailTimeRestrict?: Schema$GmailTimeRestrict; /** - * The search restrict (e.g. "after:2017-09-11 - * before:2017-09-12"). + * The search restrict (e.g. "after:2017-09-11 before:2017-09-12"). */ searchOperator?: string; } @@ -1946,9 +1536,7 @@ export namespace cloudsearch_v1 { } export interface Schema$RetrievalImportance { /** - * Indicates the ranking importance given to property when it is matched - * during retrieval. Once set, the token importance of a property cannot be - * changed. + * Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed. */ importance?: string; } @@ -1957,31 +1545,24 @@ export namespace cloudsearch_v1 { */ export interface Schema$Schema { /** - * The list of top-level objects for the data source. The maximum number of - * elements is 10. + * The list of top-level objects for the data source. The maximum number of elements is 10. */ objectDefinitions?: Schema$ObjectDefinition[]; /** - * IDs of the Long Running Operations (LROs) currently running for this - * schema. After modifying the schema, wait for operations to complete - * before indexing additional content. + * IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content. */ operationIds?: string[]; } /** - * Scoring configurations for a source while processing a Search or Suggest - * request. + * Scoring configurations for a source while processing a Search or Suggest request. */ export interface Schema$ScoringConfig { /** - * Whether to use freshness as a ranking signal. By default, freshness is - * used as a ranking signal. Note that this setting is not available in the - * Admin UI. + * Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI. */ disableFreshness?: boolean; /** - * Whether to personalize the results. By default, personal signals will be - * used to boost results. + * Whether to personalize the results. By default, personal signals will be used to boost results. */ disablePersonalization?: boolean; } @@ -1990,13 +1571,11 @@ export namespace cloudsearch_v1 { */ export interface Schema$SearchApplication { /** - * Retrictions applied to the configurations. The maximum number of elements - * is 10. + * Retrictions applied to the configurations. The maximum number of elements is 10. */ dataSourceRestrictions?: Schema$DataSourceRestriction[]; /** - * The default fields for returning facet results. The sources specified - * here also have been included in data_source_restrictions above. + * The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above. */ defaultFacetOptions?: Schema$FacetOptions[]; /** @@ -2004,18 +1583,15 @@ export namespace cloudsearch_v1 { */ defaultSortOptions?: Schema$SortOptions; /** - * Display name of the Search Application. The maximum length is 300 - * characters. + * Display name of the Search Application. The maximum length is 300 characters. */ displayName?: string; /** - * Name of the Search Application. <br />Format: - * searchapplications/{application_id}. + * Name of the Search Application. <br />Format: searchapplications/{application_id}. */ name?: string; /** - * IDs of the Long Running Operations (LROs) currently running for this - * schema. Output only field. + * IDs of the Long Running Operations (LROs) currently running for this schema. Output only field. */ operationIds?: string[]; /** @@ -2037,16 +1613,14 @@ export namespace cloudsearch_v1 { */ pageToken?: string; /** - * Specify the full view URL to find the corresponding item. The maximum - * length is 2048 characters. + * Specify the full view URL to find the corresponding item. The maximum length is 2048 characters. */ viewUrl?: string; } export interface Schema$SearchItemsByViewUrlResponse { items?: Schema$Item[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -2055,9 +1629,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$SearchQualityMetadata { /** - * An indication of the quality of the item, used to influence search - * quality. Value should be between 0.0 (lowest quality) and 1.0 (highest - * quality). The default value is 0.0. + * An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0. */ quality?: number; } @@ -2066,20 +1638,16 @@ export namespace cloudsearch_v1 { */ export interface Schema$SearchRequest { /** - * The sources to use for querying. If not specified, all data sources from - * the current search application are used. + * The sources to use for querying. If not specified, all data sources from the current search application are used. */ dataSourceRestrictions?: Schema$DataSourceRestriction[]; facetOptions?: Schema$FacetOptions[]; /** - * Maximum number of search results to return in one page. Valid values are - * between 1 and 100, inclusive. Default value is 10. + * Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. */ pageSize?: number; /** - * The raw query string. See supported search operators in the [Cloud search - * Cheat - * Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/) + * The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/) */ query?: string; /** @@ -2120,8 +1688,7 @@ export namespace cloudsearch_v1 { */ hasMoreResults?: boolean; /** - * Query interpretation result for user query. Empty if query interpretation - * is disabled. + * Query interpretation result for user query. Empty if query interpretation is disabled. */ queryInterpretation?: Schema$QueryInterpretation; /** @@ -2145,8 +1712,7 @@ export namespace cloudsearch_v1 { */ spellResults?: Schema$SpellResult[]; /** - * Structured results for the user query. These results are not counted - * against the page_size. + * Structured results for the user query. These results are not counted against the page_size. */ structuredResults?: Schema$StructuredResult[]; } @@ -2155,9 +1721,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$SearchResult { /** - * If source is clustered, provide list of clustered results. There will - * only be one level of clustered results. If current source is not enabled - * for clustering, this field will be empty. + * If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty. */ clusteredResults?: Schema$SearchResult[]; /** @@ -2177,14 +1741,12 @@ export namespace cloudsearch_v1 { */ title?: string; /** - * The URL of the search result. The URL contains a Google redirect to the - * actual item. + * The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed. */ url?: string; } /** - * Snippet of the search result, which summarizes the content of the resulting - * page. + * Snippet of the search result, which summarizes the content of the resulting page. */ export interface Schema$Snippet { /** @@ -2192,15 +1754,13 @@ export namespace cloudsearch_v1 { */ matchRanges?: Schema$MatchRange[]; /** - * The snippet of the document. The snippet of the document. May contain - * escaped HTML character that should be unescaped prior to rendering. + * The snippet of the document. The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering. */ snippet?: string; } export interface Schema$SortOptions { /** - * Name of the operator corresponding to the field to sort on. The - * corresponding property must be marked as sortable. + * Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable. */ operatorName?: string; /** @@ -2239,34 +1799,23 @@ export namespace cloudsearch_v1 { source?: Schema$Source; } /** - * Set search results crowding limits. Crowding is a situation in which - * multiple results from the same source or host "crowd out" other - * results, diminishing the quality of search for users. To foster better - * search quality and source diversity in search results, you can set a - * condition to reduce repetitive results by source. + * Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. */ export interface Schema$SourceCrowdingConfig { /** - * Use a field to control results crowding. For example, if you want to - * control overly similar results from Gmail topics, use `thread_id`. For - * similar pages from Google Sites, you can use `webspace_id`. When matching - * query results contain the same field value in `GenericMetadata`, crowding - * limits are set on those records. + * Use a field to control results crowding. For example, if you want to control overly similar results from Gmail topics, use `thread_id`. For similar pages from Google Sites, you can use `webspace_id`. When matching query results contain the same field value in `GenericMetadata`, crowding limits are set on those records. */ field?: string; /** - * Maximum number of results allowed from a source. No limits will be set on - * results if this value is less than or equal to 0. + * Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0. */ numResults?: number; /** - * Maximum number of suggestions allowed from a source. No limits will be - * set on results if this value is less than or equal to 0. + * Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0. */ numSuggestions?: number; /** - * Control results by content source. This option limits the total number of - * results from a given source and ignores field-based crowding control. + * Control results by content source. This option limits the total number of results from a given source and ignores field-based crowding control. */ source?: boolean; } @@ -2292,8 +1841,7 @@ export namespace cloudsearch_v1 { source?: Schema$Source; } /** - * Set the scoring configuration. This allows modifying the ranking of results - * for a source. + * Set the scoring configuration. This allows modifying the ranking of results for a source. */ export interface Schema$SourceScoringConfig { /** @@ -2312,8 +1860,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$StartUploadItemRequest { /** - * Name of connector making this call. <br />Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** @@ -2322,40 +1869,7 @@ export namespace cloudsearch_v1 { debugOptions?: Schema$DebugOptions; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -2363,14 +1877,11 @@ export namespace cloudsearch_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2397,15 +1908,11 @@ export namespace cloudsearch_v1 { */ export interface Schema$SuggestRequest { /** - * The sources to use for suggestions. If not specified, all data sources - * from the current search application are used. Suggestions are based on - * Gmail titles. Suggestions from third party sources are not available. + * The sources to use for suggestions. If not specified, all data sources from the current search application are used. Suggestions are based on Gmail titles. Suggestions from third party sources are not available. */ dataSourceRestrictions?: Schema$DataSourceRestriction[]; /** - * Partial query for which autocomplete suggestions will be shown. For - * example, if the query is "sea", then the server might return - * "season", "search", "seagull" and so on. + * Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", "seagull" and so on. */ query?: string; /** @@ -2427,13 +1934,11 @@ export namespace cloudsearch_v1 { */ export interface Schema$SuggestResult { /** - * This is present when the suggestion indicates a person. It contains more - * information about the person - like their email ID, name etc. + * This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc. */ peopleSuggestion?: Schema$PeopleSuggestion; /** - * This field will be present if the suggested query is a word/phrase - * completion. + * This field will be present if the suggested query is a word/phrase completion. */ querySuggestion?: Schema$QuerySuggestion; /** @@ -2441,40 +1946,20 @@ export namespace cloudsearch_v1 { */ source?: Schema$Source; /** - * The suggested query that will be used for search, when the user clicks on - * the suggestion + * The suggested query that will be used for search, when the user clicks on the suggestion */ suggestedQuery?: string; } /** - * Used to provide a search operator for text properties. This is optional. - * Search operators let users restrict the query to specific fields relevant - * to the type of item being searched. + * Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ export interface Schema$TextOperatorOptions { /** - * If true, the text value will be tokenized as one atomic value in operator - * searches and facet matches. For example, if the operator name is - * "genre" and the value is "science-fiction" the query - * restrictions "genre:science" and "genre:fiction" will - * not match the item; "genre:science-fiction" will. Value - * matching is case-sensitive and does not remove special characters. If - * false, the text will be tokenized. For example, if the value is - * "science-fiction" the queries "genre:science" and - * "genre:fiction" will match the item. + * If true, the text value will be tokenized as one atomic value in operator searches and facet matches. For example, if the operator name is "genre" and the value is "science-fiction" the query restrictions "genre:science" and "genre:fiction" will not match the item; "genre:science-fiction" will. Value matching is case-sensitive and does not remove special characters. If false, the text will be tokenized. For example, if the value is "science-fiction" the queries "genre:science" and "genre:fiction" will match the item. */ exactMatchWithOperator?: boolean; /** - * Indicates the operator name required in the query in order to isolate the - * text property. For example, if operatorName is *subject* and the - * property's name is *subjectLine*, then queries like - * *subject:&lt;value&gt;* will show results only where the value of - * the property named *subjectLine* matches *&lt;value&gt;*. By - * contrast, a search that uses the same *&lt;value&gt;* without an - * operator will return all items where *&lt;value&gt;* matches the - * value of any text properties or text within the content field for the - * item. The operator name can only contain lowercase letters (a-z). The - * maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the text property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:&lt;value&gt;* will show results only where the value of the property named *subjectLine* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any text properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } @@ -2487,8 +1972,7 @@ export namespace cloudsearch_v1 { */ operatorOptions?: Schema$TextOperatorOptions; /** - * Indicates the search quality importance of the tokens within the field - * when used for retrieval. + * Indicates the search quality importance of the tokens within the field when used for retrieval. */ retrievalImportance?: Schema$RetrievalImportance; } @@ -2502,42 +1986,19 @@ export namespace cloudsearch_v1 { values?: string[]; } /** - * Used to provide a search operator for timestamp properties. This is - * optional. Search operators let users restrict the query to specific fields - * relevant to the type of item being searched. + * Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. */ export interface Schema$TimestampOperatorOptions { /** - * Indicates the operator name required in the query in order to isolate the - * timestamp property using the greater-than operator. For example, if - * greaterThanOperatorName is *closedafter* and the property's name is - * *closeDate*, then queries like *closedafter:&lt;value&gt;* will - * show results only where the value of the property named *closeDate* is - * later than *&lt;value&gt;*. The operator name can only contain - * lowercase letters (a-z). The maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the timestamp property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:&lt;value&gt;* will show results only where the value of the property named *closeDate* is later than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ greaterThanOperatorName?: string; /** - * Indicates the operator name required in the query in order to isolate the - * timestamp property using the less-than operator. For example, if - * lessThanOperatorName is *closedbefore* and the property's name is - * *closeDate*, then queries like *closedbefore:&lt;value&gt;* will - * show results only where the value of the property named *closeDate* is - * earlier than *&lt;value&gt;*. The operator name can only contain - * lowercase letters (a-z). The maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the timestamp property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:&lt;value&gt;* will show results only where the value of the property named *closeDate* is earlier than *&lt;value&gt;*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ lessThanOperatorName?: string; /** - * Indicates the operator name required in the query in order to isolate the - * timestamp property. For example, if operatorName is *closedon* and the - * property's name is *closeDate*, then queries like - * *closedon:&lt;value&gt;* will show results only where the value - * of the property named *closeDate* matches *&lt;value&gt;*. By - * contrast, a search that uses the same *&lt;value&gt;* without an - * operator will return all items where *&lt;value&gt;* matches the - * value of any String properties or text within the content field for the - * item. The operator name can only contain lowercase letters (a-z). The - * maximum length is 32 characters. + * Indicates the operator name required in the query in order to isolate the timestamp property. For example, if operatorName is *closedon* and the property's name is *closeDate*, then queries like *closedon:&lt;value&gt;* will show results only where the value of the property named *closeDate* matches *&lt;value&gt;*. By contrast, a search that uses the same *&lt;value&gt;* without an operator will return all items where *&lt;value&gt;* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } @@ -2568,8 +2029,7 @@ export namespace cloudsearch_v1 { } export interface Schema$UnreserveItemsRequest { /** - * Name of connector making this call. <br />Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call. <br />Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** @@ -2603,9 +2063,7 @@ export namespace cloudsearch_v1 { validateOnly?: boolean; } /** - * Represents an upload session reference. This reference is created via - * upload method. Updating of item content may refer to this uploaded content - * via contentDataRef. + * Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. */ export interface Schema$UploadItemRef { /** @@ -2626,13 +2084,7 @@ export namespace cloudsearch_v1 { } export interface Schema$ValueFilter { /** - * The `operator_name` applied to the query, such as *price_greater_than*. - * The filter can work against both types of filters defined in the schema - * for your data source: <br/><br/> 1. `operator_name`, where - * the query filters results by the property that matches the value. - * <br/> 2. `greater_than_operator_name` or `less_than_operator_name` - * in your schema. The query filters the results for the property values - * that are greater than or less than the supplied value in the query. + * The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: <br/><br/> 1. `operator_name`, where the query filters results by the property that matches the value. <br/> 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query. */ operatorName?: string; /** @@ -2751,8 +2203,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.debug.datasources.items.searchByViewUrl - * @desc Fetches the item whose viewUrl exactly matches that of the URL - * provided in the request. + * @desc Fetches the item whose viewUrl exactly matches that of the URL provided in the request. * @alias cloudsearch.debug.datasources.items.searchByViewUrl * @memberOf! () * @@ -2843,8 +2294,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -2976,8 +2426,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -2989,8 +2438,7 @@ export namespace cloudsearch_v1 { */ pageToken?: string; /** - * The name of the item, in the following format: - * datasources/{source_id}/items/{ID} + * The name of the item, in the following format: datasources/{source_id}/items/{ID} */ parent?: string; } @@ -3118,8 +2566,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -3135,8 +2582,7 @@ export namespace cloudsearch_v1 { */ pageToken?: string; /** - * The name of the identity source, in the following format: - * identitysources/{source_id}} + * The name of the identity source, in the following format: identitysources/{source_id}} */ parent?: string; /** @@ -3247,8 +2693,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -3260,8 +2705,7 @@ export namespace cloudsearch_v1 { */ pageToken?: string; /** - * The name of the identity source, in the following format: - * identitysources/{source_id} + * The name of the identity source, in the following format: identitysources/{source_id} */ parent?: string; /** @@ -3519,13 +2963,11 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** - * Name of the data source to delete Schema. Format: - * datasources/{source_id} + * Name of the data source to delete Schema. Format: datasources/{source_id} */ name?: string; } @@ -3537,8 +2979,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -3554,8 +2995,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the data source to update Schema. Format: - * datasources/{source_id} + * Name of the data source to update Schema. Format: datasources/{source_id} */ name?: string; @@ -3651,8 +3091,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.deleteQueueItems - * @desc Deletes all items in a queue. This method is useful for deleting - * stale items. + * @desc Deletes all items in a queue. This method is useful for deleting stale items. * @alias cloudsearch.indexing.datasources.items.deleteQueueItems * @memberOf! () * @@ -3800,9 +3239,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.index - * @desc Updates Item ACL, metadata, and content. It will insert the Item if - * it does not exist. This method does not support partial updates. Fields - * with no provided values are cleared out in the Cloud Search index. + * @desc Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. * @alias cloudsearch.indexing.datasources.items.index * @memberOf! () * @@ -3956,15 +3393,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.poll - * @desc Polls for unreserved items from the indexing queue and marks a set - * as reserved, starting with items that have the oldest timestamp from the - * highest priority ItemStatus. The priority order is as follows:
                          - * ERROR
                          MODIFIED
                          NEW_ITEM
                          ACCEPTED
                          Reserving - * items ensures that polling from other threads cannot create overlapping - * sets. After handling the reserved items, the client should put items - * back into the unreserved state, either by calling index, or by calling - * push with the type REQUEUE. Items automatically become available - * (unreserved) after 4 hours even if no update or push method is called. + * @desc Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows:
                          ERROR
                          MODIFIED
                          NEW_ITEM
                          ACCEPTED
                          Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. * @alias cloudsearch.indexing.datasources.items.poll * @memberOf! () * @@ -4112,9 +3541,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.unreserve - * @desc Unreserves all items from a queue, making them all eligible to be - * polled. This method is useful for resetting the indexing queue after a - * connector has been restarted. + * @desc Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. * @alias cloudsearch.indexing.datasources.items.unreserve * @memberOf! () * @@ -4189,9 +3616,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.upload - * @desc Creates an upload session for uploading item content. For items - * smaller than 100 KiB, it's easier to embed the content inline within - * update. + * @desc Creates an upload session for uploading item content. For items smaller than 100 KiB, it's easier to embed the content inline within update. * @alias cloudsearch.indexing.datasources.items.upload * @memberOf! () * @@ -4273,13 +3698,11 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of connector making this call.
                          Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call.
                          Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -4287,18 +3710,11 @@ export namespace cloudsearch_v1 { */ mode?: string; /** - * Required. Name of the item to delete. Format: - * datasources/{source_id}/items/{item_id} + * Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id} */ name?: string; /** - * Required. The incremented version of the item to delete from the index. - * The indexing system stores the version from the datasource as a byte - * string and compares the Item version in the index to the version of the - * queued Item using lexical ordering.

                          Cloud Search Indexing - * won't delete any queued item with a version value that is less than or - * equal to the version of the currently indexed item. The maximum length - * for this field is 1024 bytes. + * Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering.

                          Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. */ version?: string; } @@ -4310,8 +3726,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the Data Source to delete items in a queue. Format: - * datasources/{source_id} + * Name of the Data Source to delete items in a queue. Format: datasources/{source_id} */ name?: string; @@ -4328,18 +3743,15 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of connector making this call.
                          Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call.
                          Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** - * Name of the item to get info. Format: - * datasources/{source_id}/items/{item_id} + * Name of the item to get info. Format: datasources/{source_id}/items/{item_id} */ name?: string; } @@ -4351,8 +3763,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the Item. Format: datasources/{source_id}/items/{item_id}
                          This is a required field. The maximum length is 1536 characters. + * Name of the Item. Format: datasources/{source_id}/items/{item_id}
                          This is a required field. The maximum length is 1536 characters. */ name?: string; @@ -4369,19 +3780,15 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When set to true, the indexing system only populates the following - * fields: name, version, metadata.hash, structured_data.hash, content.hash. - *
                          If this value is false, then all the fields are populated in Item. + * When set to true, the indexing system only populates the following fields: name, version, metadata.hash, structured_data.hash, content.hash.
                          If this value is false, then all the fields are populated in Item. */ brief?: boolean; /** - * Name of connector making this call.
                          Format: - * datasources/{source_id}/connectors/{ID} + * Name of connector making this call.
                          Format: datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -4389,9 +3796,7 @@ export namespace cloudsearch_v1 { */ name?: string; /** - * Maximum number of items to fetch in a request. The max value is 1000 when - * brief is true. The max value is 10 if brief is false.
                          The default - * value is 10 + * Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false.
                          The default value is 10 */ pageSize?: number; /** @@ -4424,9 +3829,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the item to push into the indexing queue.
                          Format: - * datasources/{source_id}/items/{ID}
                          This is a required field. The - * maximum length is 1536 characters. + * Name of the item to push into the indexing queue.
                          Format: datasources/{source_id}/items/{ID}
                          This is a required field. The maximum length is 1536 characters. */ name?: string; @@ -4443,8 +3846,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the Data Source to unreserve all items. Format: - * datasources/{source_id} + * Name of the Data Source to unreserve all items. Format: datasources/{source_id} */ name?: string; @@ -4461,8 +3863,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the Item to start a resumable upload. Format: - * datasources/{source_id}/items/{item_id}. + * Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. */ name?: string; @@ -4480,14 +3881,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.media.upload - * @desc Uploads media for indexing. The upload endpoint supports direct - * and resumable upload protocols and is intended for large items that can - * not be inlined during index requests. To index large content: 1. Call - * upload to begin a session and get the item reference. 1. Upload the - * content using the item reference's resource name. 1. Call index with the - * item reference as the content. For additional information, see - * [Create a content connector using the REST - * API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). + * @desc Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be inlined during index requests. To index large content: 1. Call upload to begin a session and get the item reference. 1. Upload the content using the item reference's resource name. 1. Call index with the item reference as the content. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). * @alias cloudsearch.media.upload * @memberOf! () * @@ -4572,8 +3966,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the media that is being downloaded. See - * ReadRequest.resource_name. + * Name of the media that is being downloaded. See ReadRequest.resource_name. */ resourceName?: string; @@ -4606,9 +3999,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudsearch.operations.get * @memberOf! () * @@ -4699,10 +4090,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.query.search - * @desc The Cloud Search Query API provides the search method, which - * returns the most relevant results from a user query. The results can - * come from G Suite Apps, such as Gmail or Google Drive, or they can come - * from data that you have indexed from a third party. + * @desc The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. * @alias cloudsearch.query.search * @memberOf! () * @@ -4872,8 +4260,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.query.sources.list - * @desc Returns list of sources that user can use for Search and Suggest - * APIs. + * @desc Returns list of sources that user can use for Search and Suggest APIs. * @alias cloudsearch.query.sources.list * @memberOf! () * @@ -4961,17 +4348,11 @@ export namespace cloudsearch_v1 { */ pageToken?: string; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'requestOptions.debugOptions.enableDebugging'?: boolean; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more - * information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For - * translations. When specified, the documents in search results are biased - * towards the specified language. Suggest API does not use this parameter. - * It autocompletes only based on characters in the query. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. */ 'requestOptions.languageCode'?: string; /** @@ -4979,11 +4360,7 @@ export namespace cloudsearch_v1 { */ 'requestOptions.searchApplicationId'?: string; /** - * Current user's time zone id, such as "America/Los_Angeles" or - * "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data - * Repository (CLDR)](http://cldr.unicode.org/) project, and currently - * available in the file - * [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + * Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) */ 'requestOptions.timeZone'?: string; } @@ -5405,8 +4782,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -5422,8 +4798,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -5439,13 +4814,11 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** - * Maximum number of datasources to fetch in a request. The max value is - * 100.
                          The default value is 10 + * Maximum number of datasources to fetch in a request. The max value is 100.
                          The default value is 10 */ pageSize?: number; /** @@ -5461,8 +4834,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the datasource resource. Format: datasources/{source_id}.
                          The name is ignored when creating a datasource. + * Name of the datasource resource. Format: datasources/{source_id}.
                          The name is ignored when creating a datasource. */ name?: string; @@ -5789,8 +5161,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.settings.searchapplications.reset - * @desc Resets a search application to default settings. This will return - * an empty response. + * @desc Resets a search application to default settings. This will return an empty response. * @alias cloudsearch.settings.searchapplications.reset * @memberOf! () * @@ -5959,13 +5330,11 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** - * The name of the search application to be deleted.
                          Format: - * applications/{application_id}. + * The name of the search application to be deleted.
                          Format: applications/{application_id}. */ name?: string; } @@ -5977,13 +5346,11 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** - * Name of the search application.
                          Format: - * applications/{application_id}. + * Name of the search application.
                          Format: applications/{application_id}. */ name?: string; } @@ -5995,8 +5362,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If you are asked by Google to help with debugging, set this field. - * Otherwise, ignore this field. + * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -6004,8 +5370,7 @@ export namespace cloudsearch_v1 { */ pageSize?: number; /** - * The next_page_token value returned from a previous List request, if any. - *
                          The default value is 10 + * The next_page_token value returned from a previous List request, if any.
                          The default value is 10 */ pageToken?: string; } @@ -6017,8 +5382,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the search application to be reset.
                          Format: - * applications/{application_id}. + * The name of the search application to be reset.
                          Format: applications/{application_id}. */ name?: string; @@ -6035,8 +5399,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the Search Application.
                          Format: - * searchapplications/{application_id}. + * Name of the Search Application.
                          Format: searchapplications/{application_id}. */ name?: string; @@ -6056,9 +5419,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.stats.getIndex - * @desc Gets indexed item statistics aggreggated across all data sources. - * This API only returns statistics for previous dates; it doesn't return - * statistics for the current day. + * @desc Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. * @alias cloudsearch.stats.getIndex * @memberOf! () * @@ -6298,8 +5659,7 @@ export namespace cloudsearch_v1 { */ 'fromDate.year'?: number; /** - * The resource id of the data source to retrieve statistics for, in the - * following format: "datasources/{source_id}" + * The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" */ name?: string; /** diff --git a/src/apis/cloudshell/package.json b/src/apis/cloudshell/package.json index 87edc067db7..0d87c02cd7a 100644 --- a/src/apis/cloudshell/package.json +++ b/src/apis/cloudshell/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index 424916675ed..e596e2e35ea 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudshell_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudshell_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudshell_v1 { /** * Cloud Shell API * - * Allows users to start, configure, and connect to interactive shell sessions - * running in the cloud. + * Allows users to start, configure, and connect to interactive shell sessions running in the cloud. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace cloudshell_v1 { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); } @@ -124,59 +122,39 @@ export namespace cloudshell_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A Cloud Shell environment, which is defined as the combination of a Docker - * image specifying what is installed on the environment and a home directory - * containing the user's data that will remain across sessions. Each user - * has a single environment with the ID "default". + * A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID "default". */ export interface Schema$Environment { /** - * Required. Full path to the Docker image used to run this environment, - * e.g. "gcr.io/dev-con/cloud-devshell:latest". + * Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". */ dockerImage?: string; /** - * Output only. The environment's identifier, which is always - * "default". + * Output only. The environment's identifier, which is always "default". */ id?: string; /** - * Output only. Full name of this resource, in the format - * `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is - * the email address of the user to whom this environment belongs, and - * `{environment_id}` is the identifier of this environment. For example, - * `users/someone@example.com/environments/default`. + * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. */ name?: string; /** - * Output only. Public keys associated with the environment. Clients can - * connect to this environment via SSH only if they possess a private key - * corresponding to at least one of these public keys. Keys can be added to - * or removed from the environment using the CreatePublicKey and - * DeletePublicKey methods. + * Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods. */ publicKeys?: Schema$PublicKey[]; /** - * Output only. Host to which clients can connect to initiate SSH sessions - * with the environment. + * Output only. Host to which clients can connect to initiate SSH sessions with the environment. */ sshHost?: string; /** - * Output only. Port to which clients can connect to initiate SSH sessions - * with the environment. + * Output only. Port to which clients can connect to initiate SSH sessions with the environment. */ sshPort?: number; /** - * Output only. Username that clients should use when initiating SSH - * sessions with the environment. + * Output only. Username that clients should use when initiating SSH sessions with the environment. */ sshUsername?: string; /** @@ -198,14 +176,11 @@ export namespace cloudshell_v1 { operations?: Schema$Operation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -213,26 +188,15 @@ export namespace cloudshell_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -249,19 +213,12 @@ export namespace cloudshell_v1 { */ key?: string; /** - * Output only. Full name of this resource, in the format - * `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. - * `{owner_email}` is the email address of the user to whom the key belongs. - * `{environment_id}` is the identifier of the environment to which the key - * grants access. `{key_id}` is the unique identifier of the key. For - * example, - * `users/someone@example.com/environments/default/publicKeys/myKey`. + * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`. */ name?: string; } /** - * Message included in the metadata field of operations returned from - * StartEnvironment. + * Message included in the metadata field of operations returned from StartEnvironment. */ export interface Schema$StartEnvironmentMetadata { /** @@ -270,8 +227,7 @@ export namespace cloudshell_v1 { state?: string; } /** - * Message included in the response field of operations returned from - * StartEnvironment once the operation is complete. + * Message included in the response field of operations returned from StartEnvironment once the operation is complete. */ export interface Schema$StartEnvironmentResponse { /** @@ -280,40 +236,7 @@ export namespace cloudshell_v1 { environment?: Schema$Environment; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -321,14 +244,11 @@ export namespace cloudshell_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -341,15 +261,7 @@ export namespace cloudshell_v1 { /** * cloudshell.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias cloudshell.operations.cancel * @memberOf! () * @@ -419,10 +331,7 @@ export namespace cloudshell_v1 { /** * cloudshell.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias cloudshell.operations.delete * @memberOf! () * @@ -491,9 +400,7 @@ export namespace cloudshell_v1 { /** * cloudshell.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias cloudshell.operations.get * @memberOf! () * @@ -563,15 +470,7 @@ export namespace cloudshell_v1 { /** * cloudshell.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias cloudshell.operations.list * @memberOf! () * diff --git a/src/apis/cloudshell/v1alpha1.ts b/src/apis/cloudshell/v1alpha1.ts index b5859cb8560..4da25df9fff 100644 --- a/src/apis/cloudshell/v1alpha1.ts +++ b/src/apis/cloudshell/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudshell_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudshell_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace cloudshell_v1alpha1 { /** * Cloud Shell API * - * Allows users to start, configure, and connect to interactive shell sessions - * running in the cloud. + * Allows users to start, configure, and connect to interactive shell sessions running in the cloud. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace cloudshell_v1alpha1 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.users = new Resource$Users(this.context); } @@ -128,8 +126,7 @@ export namespace cloudshell_v1alpha1 { */ accessToken?: string; /** - * The time when the credentials expire. If not set, defaults to one hour - * from when the server received the request. + * The time when the credentials expire. If not set, defaults to one hour from when the server received the request. */ expireTime?: string; /** @@ -147,59 +144,39 @@ export namespace cloudshell_v1alpha1 { key?: Schema$PublicKey; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A Cloud Shell environment, which is defined as the combination of a Docker - * image specifying what is installed on the environment and a home directory - * containing the user's data that will remain across sessions. Each user - * has a single environment with the ID "default". + * A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID "default". */ export interface Schema$Environment { /** - * Required. Full path to the Docker image used to run this environment, - * e.g. "gcr.io/dev-con/cloud-devshell:latest". + * Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". */ dockerImage?: string; /** - * Output only. The environment's identifier, which is always - * "default". + * Output only. The environment's identifier, which is always "default". */ id?: string; /** - * Output only. Full name of this resource, in the format - * `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is - * the email address of the user to whom this environment belongs, and - * `{environment_id}` is the identifier of this environment. For example, - * `users/someone@example.com/environments/default`. + * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. */ name?: string; /** - * Output only. Public keys associated with the environment. Clients can - * connect to this environment via SSH only if they possess a private key - * corresponding to at least one of these public keys. Keys can be added to - * or removed from the environment using the CreatePublicKey and - * DeletePublicKey methods. + * Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods. */ publicKeys?: Schema$PublicKey[]; /** - * Output only. Host to which clients can connect to initiate SSH sessions - * with the environment. + * Output only. Host to which clients can connect to initiate SSH sessions with the environment. */ sshHost?: string; /** - * Output only. Port to which clients can connect to initiate SSH sessions - * with the environment. + * Output only. Port to which clients can connect to initiate SSH sessions with the environment. */ sshPort?: number; /** - * Output only. Username that clients should use when initiating SSH - * sessions with the environment. + * Output only. Username that clients should use when initiating SSH sessions with the environment. */ sshUsername?: string; /** @@ -208,14 +185,11 @@ export namespace cloudshell_v1alpha1 { state?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -223,26 +197,15 @@ export namespace cloudshell_v1alpha1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -259,19 +222,12 @@ export namespace cloudshell_v1alpha1 { */ key?: string; /** - * Output only. Full name of this resource, in the format - * `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. - * `{owner_email}` is the email address of the user to whom the key belongs. - * `{environment_id}` is the identifier of the environment to which the key - * grants access. `{key_id}` is the unique identifier of the key. For - * example, - * `users/someone@example.com/environments/default/publicKeys/myKey`. + * Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`. */ name?: string; } /** - * Message included in the metadata field of operations returned from - * StartEnvironment. + * Message included in the metadata field of operations returned from StartEnvironment. */ export interface Schema$StartEnvironmentMetadata { /** @@ -284,16 +240,12 @@ export namespace cloudshell_v1alpha1 { */ export interface Schema$StartEnvironmentRequest { /** - * The initial access token passed to the environment. If this is present - * and valid, the environment will be pre-authenticated with gcloud so that - * the user can run gcloud commands in Cloud Shell without having to log in. - * This code can be updated later by calling AuthorizeEnvironment. + * The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment. */ accessToken?: string; } /** - * Message included in the response field of operations returned from - * StartEnvironment once the operation is complete. + * Message included in the response field of operations returned from StartEnvironment once the operation is complete. */ export interface Schema$StartEnvironmentResponse { /** @@ -302,40 +254,7 @@ export namespace cloudshell_v1alpha1 { environment?: Schema$Environment; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -343,14 +262,11 @@ export namespace cloudshell_v1alpha1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -376,10 +292,7 @@ export namespace cloudshell_v1alpha1 { /** * cloudshell.users.environments.authorize - * @desc Sends OAuth credentials to a running environment on behalf of a - * user. When this completes, the environment will be authorized to run - * various Google Cloud command line tools without requiring the user to - * manually authenticate. + * @desc Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate. * @alias cloudshell.users.environments.authorize * @memberOf! () * @@ -452,8 +365,7 @@ export namespace cloudshell_v1alpha1 { /** * cloudshell.users.environments.get - * @desc Gets an environment. Returns NOT_FOUND if the environment does not - * exist. + * @desc Gets an environment. Returns NOT_FOUND if the environment does not exist. * @alias cloudshell.users.environments.get * @memberOf! () * @@ -597,12 +509,7 @@ export namespace cloudshell_v1alpha1 { /** * cloudshell.users.environments.start - * @desc Starts an existing environment, allowing clients to connect to it. - * The returned operation will contain an instance of - * StartEnvironmentMetadata in its metadata field. Users can wait for the - * environment to start by polling this operation via GetOperation. Once the - * environment has finished starting and is ready to accept connections, the - * operation will contain a StartEnvironmentResponse in its response field. + * @desc Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field. * @alias cloudshell.users.environments.start * @memberOf! () * @@ -684,9 +591,7 @@ export namespace cloudshell_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the resource that should receive the credentials, for example - * `users/me/environments/default` or - * `users/someone@example.com/environments/default`. + * Name of the resource that should receive the credentials, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. */ name?: string; @@ -703,9 +608,7 @@ export namespace cloudshell_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the requested resource, for example - * `users/me/environments/default` or - * `users/someone@example.com/environments/default`. + * Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. */ name?: string; } @@ -717,9 +620,7 @@ export namespace cloudshell_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the resource to be updated, for example - * `users/me/environments/default` or - * `users/someone@example.com/environments/default`. + * Name of the resource to be updated, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. */ name?: string; /** @@ -740,9 +641,7 @@ export namespace cloudshell_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the resource that should be started, for example - * `users/me/environments/default` or - * `users/someone@example.com/environments/default`. + * Name of the resource that should be started, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. */ name?: string; @@ -760,10 +659,7 @@ export namespace cloudshell_v1alpha1 { /** * cloudshell.users.environments.publicKeys.create - * @desc Adds a public SSH key to an environment, allowing clients with the - * corresponding private key to connect to that environment via SSH. If a - * key with the same format and content already exists, this will return the - * existing key. + * @desc Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same format and content already exists, this will return the existing key. * @alias cloudshell.users.environments.publicKeys.create * @memberOf! () * @@ -838,9 +734,7 @@ export namespace cloudshell_v1alpha1 { /** * cloudshell.users.environments.publicKeys.delete - * @desc Removes a public SSH key from an environment. Clients will no - * longer be able to connect to the environment using the corresponding - * private key. + * @desc Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. * @alias cloudshell.users.environments.publicKeys.delete * @memberOf! () * @@ -933,8 +827,7 @@ export namespace cloudshell_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the resource to be deleted, e.g. - * `users/me/environments/default/publicKeys/my-key`. + * Name of the resource to be deleted, e.g. `users/me/environments/default/publicKeys/my-key`. */ name?: string; } diff --git a/src/apis/cloudtasks/package.json b/src/apis/cloudtasks/package.json index 5fc020ea87c..72eae6295e5 100644 --- a/src/apis/cloudtasks/package.json +++ b/src/apis/cloudtasks/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 64086894295..1f58b15d62f 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudtasks_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudtasks_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,161 +108,58 @@ export namespace cloudtasks_v2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * App Engine HTTP request. The message defines the HTTP request that is sent - * to an App Engine app when the task is dispatched. This proto can only be - * used for tasks in a queue which has app_engine_http_queue set. Using - * AppEngineHttpRequest requires - * [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) - * Google IAM permission for the project and the following scope: - * `https://www.googleapis.com/auth/cloud-platform` The task will be - * delivered to the App Engine app which belongs to the same project as the - * queue. For more information, see [How Requests are - * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and how routing is affected by [dispatch - * files](https://cloud.google.com/appengine/docs/python/config/dispatchref). - * Traffic is encrypted during transport and never leaves Google datacenters. - * Because this traffic is carried over a communication mechanism internal to - * Google, you cannot explicitly set the protocol (for example, HTTP or - * HTTPS). The request to the handler, however, will appear to have used the - * HTTP protocol. The AppEngineRouting used to construct the URL that the - * task is delivered to can be set at the queue-level or task-level: * If - * set, app_engine_routing_override is used for all tasks in the queue, - * no matter what the setting is for the task-level app_engine_routing. - * The `url` that the task will be sent to is: * `url =` host `+` - * relative_uri Tasks can be dispatched to secure app handlers, unsecure app - * handlers, and URIs restricted with [`login: - * admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). - * Because tasks are not run as any user, they cannot be dispatched to URIs - * restricted with [`login: - * required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) - * Task dispatches also do not follow redirects. The task attempt has - * succeeded if the app's request handler returns an HTTP response code in - * the range [`200` - `299`]. `503` is considered an App Engine system error - * instead of an application error. Requests returning error `503` will be - * retried regardless of retry configuration and not counted against retry - * counts. Any other response code or a failure to receive a response before - * the deadline is a failed attempt. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_queue set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `503` is considered an App Engine system error instead of an application error. Requests returning error `503` will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt. */ export interface Schema$AppEngineHttpRequest { /** - * Task-level setting for App Engine routing. If set, - * app_engine_routing_override is used for all tasks in the queue, no matter - * what the setting is for the task-level app_engine_routing. + * Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. */ appEngineRouting?: Schema$AppEngineRouting; /** - * HTTP request body. A request body is allowed only if the HTTP method is - * POST or PUT. It is an error to set a body on a task with an incompatible - * HttpMethod. + * HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod. */ body?: string; /** - * HTTP request headers. This map contains the header field names and - * values. Headers can be set when the task is created. Repeated headers are - * not supported but a header value can contain commas. Cloud Tasks sets - * some headers to default values: * `User-Agent`: By default, this header - * is `"AppEngine-Google; (+http://code.google.com/appengine)"`. - * This header can be modified, but Cloud Tasks will append - * `"AppEngine-Google; (+http://code.google.com/appengine)"` to - * the modified `User-Agent`. If the task has a body, Cloud Tasks sets - * the following headers: * `Content-Type`: By default, the `Content-Type` - * header is set to `"application/octet-stream"`. The default - * can be overridden by explicitly setting `Content-Type` to a particular - * media type when the task is created. For example, `Content-Type` can - * be set to `"application/json"`. * `Content-Length`: This is - * computed by Cloud Tasks. This value is output only. It cannot be - * changed. The headers below cannot be set or overridden: * `Host` * - * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some - * headers when the task is dispatched, such as headers containing - * information about the task; see [request - * headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). - * These headers are set only when the task is dispatched, so they are not - * visible when the task is returned in a Cloud Tasks response. Although - * there is no specific limit for the maximum number of headers or the size, - * there is a limit on the maximum size of the Task. For more information, - * see the CreateTask documentation. + * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. */ headers?: {[key: string]: string}; /** - * The HTTP method to use for the request. The default is POST. The - * app's request handler for the task's target URL must be able to - * handle HTTP requests with this http_method, otherwise the task attempt - * will fail with error code 405 (Method Not Allowed). See [Writing a push - * task request - * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) - * and the documentation for the request handlers in the language your app - * is written in e.g. [Python Request - * Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + * The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). */ httpMethod?: string; /** - * The relative URI. The relative URI must begin with "/" and - * must be a valid HTTP relative URI. It can contain a path and query string - * arguments. If the relative URI is empty, then the root path "/" - * will be used. No spaces are allowed, and the maximum length allowed is - * 2083 characters. + * The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ relativeUri?: string; } /** - * App Engine Routing. Defines routing characteristics specific to App Engine - * - service, version, and instance. For more information about services, - * versions, and instances see [An Overview of App - * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), - * [Microservices Architecture on Google App - * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ export interface Schema$AppEngineRouting { /** - * Output only. The host that the task is sent to. The host is constructed - * from the domain name of the app associated with the queue's project - * ID (for example <app-id>.appspot.com), and the service, version, - * and instance. Tasks which were created using the App Engine SDK might - * have a custom domain name. For more information, see [How Requests are - * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). + * Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example <app-id>.appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). */ host?: string; /** - * App instance. By default, the task is sent to an instance which is - * available when the task is attempted. Requests can only be sent to a - * specific instance if [manual scaling is used in App Engine - * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). - * App Engine Flex does not support instances. For more information, see - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ instance?: string; /** - * App service. By default, the task is sent to the service which is the - * default service when the task is attempted. For some queues or tasks - * which were created using the App Engine Task Queue API, host is not - * parsable into service, version, and instance. For example, some tasks - * which were created using the App Engine SDK use a custom domain name; - * custom domains are not parsed by Cloud Tasks. If host is not parsable, - * then service, version, and instance are the empty string. + * App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ service?: string; /** - * App version. By default, the task is sent to the version which is the - * default version when the task is attempted. For some queues or tasks - * which were created using the App Engine Task Queue API, host is not - * parsable into service, version, and instance. For example, some tasks - * which were created using the App Engine SDK use a custom domain name; - * custom domains are not parsed by Cloud Tasks. If host is not parsable, - * then service, version, and instance are the empty string. + * App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ version?: string; } @@ -275,24 +168,19 @@ export namespace cloudtasks_v2 { */ export interface Schema$Attempt { /** - * Output only. The time that this attempt was dispatched. `dispatch_time` - * will be truncated to the nearest microsecond. + * Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. */ dispatchTime?: string; /** - * Output only. The response from the worker for this attempt. If - * `response_time` is unset, then the task has not been attempted or is - * currently running and the `response_status` field is meaningless. + * Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless. */ responseStatus?: Schema$Status; /** - * Output only. The time that this attempt response was received. - * `response_time` will be truncated to the nearest microsecond. + * Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. */ responseTime?: string; /** - * Output only. The time that this attempt was scheduled. `schedule_time` - * will be truncated to the nearest microsecond. + * Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */ scheduleTime?: string; } @@ -301,30 +189,15 @@ export namespace cloudtasks_v2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -333,75 +206,36 @@ export namespace cloudtasks_v2 { */ export interface Schema$CreateTaskRequest { /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; /** - * Required. The task to add. Task names have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. - * The user can optionally specify a task name. If a name is not specified - * then the system will generate a random unique task id, which will be set - * in the task returned in the response. If schedule_time is not set or is - * in the past then Cloud Tasks will set it to the current time. Task - * De-duplication: Explicitly specifying a task ID enables task - * de-duplication. If a task's ID is identical to that of an existing - * task or a task that was deleted or executed recently then the call will - * fail with ALREADY_EXISTS. If the task's queue was created using Cloud - * Tasks, then another task with the same name can't be created for - * ~1hour after the original task was deleted or executed. If the task's - * queue was created using queue.yaml or queue.xml, then another task with - * the same name can't be created for ~9days after the original task was - * deleted or executed. Because there is an extra lookup cost to identify - * duplicate task names, these CreateTask calls have significantly increased - * latency. Using hashed strings for the task id or for the prefix of the - * task id is recommended. Choosing task ids that are sequential or have - * sequential prefixes, for example using a timestamp, causes an increase in - * latency and error rates in all task commands. The infrastructure relies - * on an approximately uniform distribution of task ids to store and serve - * tasks efficiently. + * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ task?: Schema$Task; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -427,10 +261,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$ListQueuesResponse { /** - * A token to retrieve next page of results. To return the next page of - * results, call ListQueues with this value as the page_token. If the - * next_page_token is empty, there are no more results. The page token is - * valid for only 2 hours. + * A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. */ nextPageToken?: string; /** @@ -443,9 +274,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$ListTasksResponse { /** - * A token to retrieve next page of results. To return the next page of - * results, call ListTasks with this value as the page_token. If the - * next_page_token is empty, there are no more results. + * A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. */ nextPageToken?: string; /** @@ -458,13 +287,11 @@ export namespace cloudtasks_v2 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -472,13 +299,11 @@ export namespace cloudtasks_v2 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -487,41 +312,15 @@ export namespace cloudtasks_v2 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -534,123 +333,48 @@ export namespace cloudtasks_v2 { */ export interface Schema$PurgeQueueRequest {} /** - * A queue is a container of related tasks. Queues are configured to manage - * how those tasks are dispatched. Configurable properties include rate - * limits, retry options, queue types, and others. + * A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others. */ export interface Schema$Queue { /** - * Overrides for task-level app_engine_routing. These settings apply only to - * App Engine tasks in this queue. If set, `app_engine_routing_override` is - * used for all App Engine tasks in the queue, no matter what the setting is - * for the task-level app_engine_routing. + * Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. If set, `app_engine_routing_override` is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing. */ appEngineRoutingOverride?: Schema$AppEngineRouting; /** - * Caller-specified and required in CreateQueue, after which it becomes - * output only. The queue name. The queue name must have the following - * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * - * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the queue's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. + * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ name?: string; /** - * Output only. The last time this queue was purged. All tasks that were - * created before this time were purged. A queue can be purged using - * PurgeQueue, the [App Engine Task Queue SDK, or the Cloud - * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). - * Purge time will be truncated to the nearest microsecond. Purge time will - * be unset if the queue has never been purged. + * Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. */ purgeTime?: string; /** - * Rate limits for task dispatches. rate_limits and retry_config are - * related because they both control task attempts. However they control - * task attempts in different ways: * rate_limits controls the total rate - * of dispatches from a queue (i.e. all traffic dispatched from the queue, - * regardless of whether the dispatch is from a first attempt or a retry). - * * retry_config controls what happens to particular a task after its - * first attempt fails. That is, retry_config controls task retries (the - * second attempt, third attempt, etc). The queue's actual dispatch - * rate is the result of: * Number of tasks in the queue * User-specified - * throttling: rate_limits, retry_config, and the queue's state. * - * System throttling due to `429` (Too Many Requests) or `503` (Service - * Unavailable) responses from the worker, high error rates, or to smooth - * sudden large traffic spikes. + * Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. */ rateLimits?: Schema$RateLimits; /** - * Settings that determine the retry behavior. * For tasks created using - * Cloud Tasks: the queue-level retry settings apply to all tasks in the - * queue that were created using Cloud Tasks. Retry settings cannot be set - * on individual tasks. * For tasks created using the App Engine SDK: the - * queue-level retry settings apply to all tasks in the queue which do not - * have retry settings explicitly set on the task and were created by the - * App Engine SDK. See [App Engine - * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + * Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). */ retryConfig?: Schema$RetryConfig; /** - * Output only. The state of the queue. `state` can only be changed by - * called PauseQueue, ResumeQueue, or uploading - * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). - * UpdateQueue cannot be used to change `state`. + * Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */ state?: string; } /** - * Rate limits. This message determines the maximum rate that tasks can be - * dispatched by a queue, regardless of whether the dispatch is a first task - * attempt or a retry. Note: The debugging command, RunTask, will run a task - * even if the queue has reached its RateLimits. + * Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. */ export interface Schema$RateLimits { /** - * Output only. The max burst size. Max burst size limits how fast tasks in - * queue are processed when many tasks are in the queue and the rate is - * high. This field allows the queue to have a high rate so processing - * starts shortly after a task is enqueued, but still limits resource usage - * when many tasks are enqueued in a short period of time. The [token - * bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to - * control the rate of task dispatches. Each queue has a token bucket that - * holds tokens, up to the maximum specified by `max_burst_size`. Each time - * a task is dispatched, a token is removed from the bucket. Tasks will be - * dispatched until the queue's bucket runs out of tokens. The bucket - * will be continuously refilled with new tokens based on - * max_dispatches_per_second. Cloud Tasks will pick the value of - * `max_burst_size` based on the value of max_dispatches_per_second. For - * App Engine queues that were created or updated using `queue.yaml/xml`, - * `max_burst_size` is equal to - * [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). - * Since `max_burst_size` is output only, if UpdateQueue is called on a - * queue created by `queue.yaml/xml`, `max_burst_size` will be reset based - * on the value of max_dispatches_per_second, regardless of whether - * max_dispatches_per_second is updated. + * Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. */ maxBurstSize?: number; /** - * The maximum number of concurrent tasks that Cloud Tasks allows to be - * dispatched for this queue. After this threshold has been reached, Cloud - * Tasks stops dispatching tasks until the number of concurrent requests - * decreases. If unspecified when the queue is created, Cloud Tasks will - * pick the default. The maximum allowed value is 5,000. This field has - * the same meaning as [max_concurrent_requests in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). + * The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). */ maxConcurrentDispatches?: number; /** - * The maximum rate at which tasks are dispatched from this queue. If - * unspecified when the queue is created, Cloud Tasks will pick the default. - * * For App Engine queues, the maximum allowed value is 500. This field - * has the same meaning as [rate in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + * The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). */ maxDispatchesPerSecond?: number; } @@ -659,66 +383,27 @@ export namespace cloudtasks_v2 { */ export interface Schema$ResumeQueueRequest {} /** - * Retry config. These settings determine when a failed task attempt is - * retried. + * Retry config. These settings determine when a failed task attempt is retried. */ export interface Schema$RetryConfig { /** - * Number of attempts per task. Cloud Tasks will attempt the task - * `max_attempts` times (that is, if the first attempt fails, then there - * will be `max_attempts - 1` retries). Must be >= -1. If unspecified - * when the queue is created, Cloud Tasks will pick the default. -1 - * indicates unlimited attempts. This field has the same meaning as - * [task_retry_limit in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxAttempts?: number; /** - * A task will be scheduled for retry between min_backoff and max_backoff - * duration after it fails, if the queue's RetryConfig specifies that - * the task should be retried. If unspecified when the queue is created, - * Cloud Tasks will pick the default. `max_backoff` will be truncated to - * the nearest second. This field has the same meaning as - * [max_backoff_seconds in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxBackoff?: string; /** - * The time between retries will double `max_doublings` times. A task's - * retry interval starts at min_backoff, then doubles `max_doublings` times, - * then increases linearly, and finally retries retries at intervals of - * max_backoff up to max_attempts times. For example, if min_backoff is - * 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will - * first be retried in 10s. The retry interval will double three times, and - * then increase linearly by 2^3 * 10s. Finally, the task will retry at - * intervals of max_backoff until the task has been attempted max_attempts - * times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, - * 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks - * will pick the default. This field has the same meaning as - * [max_doublings in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxDoublings?: number; /** - * If positive, `max_retry_duration` specifies the time limit for retrying a - * failed task, measured from when the task was first attempted. Once - * `max_retry_duration` time has passed *and* the task has been attempted - * max_attempts times, no further attempts will be made and the task will be - * deleted. If zero, then the task age is unlimited. If unspecified when - * the queue is created, Cloud Tasks will pick the default. - * `max_retry_duration` will be truncated to the nearest second. This field - * has the same meaning as [task_age_limit in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxRetryDuration?: string; /** - * A task will be scheduled for retry between min_backoff and max_backoff - * duration after it fails, if the queue's RetryConfig specifies that - * the task should be retried. If unspecified when the queue is created, - * Cloud Tasks will pick the default. `min_backoff` will be truncated to - * the nearest second. This field has the same meaning as - * [min_backoff_seconds in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ minBackoff?: string; } @@ -727,13 +412,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$RunTaskRequest { /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -742,48 +421,12 @@ export namespace cloudtasks_v2 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -791,14 +434,11 @@ export namespace cloudtasks_v2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -807,49 +447,23 @@ export namespace cloudtasks_v2 { */ export interface Schema$Task { /** - * HTTP request that is sent to the App Engine app handler. An App Engine - * task is a task that has AppEngineHttpRequest set. + * HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set. */ appEngineHttpRequest?: Schema$AppEngineHttpRequest; /** - * Output only. The time that the task was created. `create_time` will be - * truncated to the nearest second. + * Output only. The time that the task was created. `create_time` will be truncated to the nearest second. */ createTime?: string; /** - * Output only. The number of attempts dispatched. This count includes - * attempts which have been dispatched but haven't received a response. + * Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. */ dispatchCount?: number; /** - * The deadline for requests sent to the worker. If the worker does not - * respond by this deadline then the request is cancelled and the attempt is - * marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task - * according to the RetryConfig. Note that when the request is cancelled, - * Cloud Tasks will stop listing for the response, but whether the worker - * stops processing depends on the worker. For example, if the worker is - * stuck, it may not react to cancelled requests. The default and maximum - * values depend on the type of request: * For App Engine tasks, 0 - * indicates that the request has the default deadline. The default - * deadline depends on the [scaling - * type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) - * of the service: 10 minutes for standard apps with automatic scaling, 24 - * hours for standard apps with manual and basic scaling, and 60 minutes for - * flex apps. If the request deadline is set, it must be in the interval [15 - * seconds, 24 hours 15 seconds]. Regardless of the task's - * `dispatch_deadline`, the app handler will not run for longer than than - * the service's timeout. We recommend setting the `dispatch_deadline` - * to at most a few seconds more than the app handler's timeout. For - * more information see - * [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). - * `dispatch_deadline` will be truncated to the nearest millisecond. The - * deadline is an approximate deadline. + * The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. */ dispatchDeadline?: string; /** - * Output only. The status of the task's first attempt. Only - * dispatch_time will be set. The other Attempt information is not retained - * by Cloud Tasks. + * Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks. */ firstAttempt?: Schema$Attempt; /** @@ -857,20 +471,7 @@ export namespace cloudtasks_v2 { */ lastAttempt?: Schema$Attempt; /** - * Optionally caller-specified in CreateTask. The task name. The task name - * must have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the task's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. * `TASK_ID` can contain only - * letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). - * The maximum length is 500 characters. + * Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** @@ -878,14 +479,11 @@ export namespace cloudtasks_v2 { */ responseCount?: number; /** - * The time when the task is scheduled to be attempted. For App Engine - * queues, this is when the task will be attempted or retried. - * `schedule_time` will be truncated to the nearest microsecond. + * The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. */ scheduleTime?: string; /** - * Output only. The view specifies which subset of the Task has been - * returned. + * Output only. The view specifies which subset of the Task has been returned. */ view?: string; } @@ -894,10 +492,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -906,8 +501,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1125,14 +719,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.create - * @desc Creates a queue. Queues created with this method allow tasks to - * live for a maximum of 31 days. After a task is 31 days old, the task will - * be deleted regardless of whether it was dispatched or not. WARNING: - * Using this method may have unintended side effects if you are using an - * App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read - * [Overview of Queue Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @alias cloudtasks.projects.locations.queues.create * @memberOf! () * @@ -1205,14 +792,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.delete - * @desc Deletes a queue. This command will delete the queue even if it has - * tasks in it. Note: If you delete a queue, a queue with the same name - * can't be created for 7 days. WARNING: Using this method may have - * unintended side effects if you are using an App Engine `queue.yaml` or - * `queue.xml` file to manage your queues. Read [Overview of Queue - * Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @alias cloudtasks.projects.locations.queues.delete * @memberOf! () * @@ -1350,11 +930,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.getIamPolicy - * @desc Gets the access control policy for a Queue. Returns an empty policy - * if the resource exists and does not have a policy set. Authorization - * requires the following [Google IAM](https://cloud.google.com/iam) - * permission on the specified resource parent: * - * `cloudtasks.queues.getIamPolicy` + * @desc Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` * @alias cloudtasks.projects.locations.queues.getIamPolicy * @memberOf! () * @@ -1504,15 +1080,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.patch - * @desc Updates a queue. This method creates the queue if it does not - * exist and updates the queue if it does exist. Queues created with this - * method allow tasks to live for a maximum of 31 days. After a task is 31 - * days old, the task will be deleted regardless of whether it was - * dispatched or not. WARNING: Using this method may have unintended side - * effects if you are using an App Engine `queue.yaml` or `queue.xml` file - * to manage your queues. Read [Overview of Queue Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @alias cloudtasks.projects.locations.queues.patch * @memberOf! () * @@ -1583,10 +1151,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.pause - * @desc Pauses the queue. If a queue is paused then the system will stop - * dispatching tasks until the queue is resumed via ResumeQueue. Tasks can - * still be added when the queue is paused. A queue is paused if its state - * is PAUSED. + * @desc Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. * @alias cloudtasks.projects.locations.queues.pause * @memberOf! () * @@ -1656,10 +1221,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.purge - * @desc Purges a queue by deleting all of its tasks. All tasks created - * before this method is called are permanently deleted. Purge operations - * can take up to one minute to take effect. Tasks might be dispatched - * before the purge takes effect. A purge is irreversible. + * @desc Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. * @alias cloudtasks.projects.locations.queues.purge * @memberOf! () * @@ -1729,13 +1291,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.resume - * @desc Resume a queue. This method resumes a queue after it has been - * PAUSED or DISABLED. The state of a queue is stored in the queue's state; - * after calling this method it will be set to RUNNING. WARNING: Resuming - * many high-QPS queues at the same time can lead to target overloading. If - * you are resuming high-QPS queues, follow the 500/50/5 pattern described - * in [Managing Cloud Tasks Scaling - * Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). + * @desc Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). * @alias cloudtasks.projects.locations.queues.resume * @memberOf! () * @@ -1805,12 +1361,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.setIamPolicy - * @desc Sets the access control policy for a Queue. Replaces any existing - * policy. Note: The Cloud Console does not check queue-level IAM - * permissions yet. Project-level permissions are required to use the Cloud - * Console. Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission on the specified resource - * parent: * `cloudtasks.queues.setIamPolicy` + * @desc Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` * @alias cloudtasks.projects.locations.queues.setIamPolicy * @memberOf! () * @@ -1883,11 +1434,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.testIamPermissions - * @desc Returns permissions that a caller has on a Queue. If the resource - * does not exist, this will return an empty set of permissions, not a - * NOT_FOUND error. Note: This operation is designed to be used for - * building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias cloudtasks.projects.locations.queues.testIamPermissions * @memberOf! () * @@ -1976,10 +1523,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The location name in which the queue will be created. For - * example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed - * locations can be obtained by calling Cloud Tasks' implementation of - * ListLocations. + * Required. The location name in which the queue will be created. For example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations. */ parent?: string; @@ -1996,8 +1540,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ name?: string; } @@ -2009,8 +1552,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the queue. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The resource name of the queue. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ name?: string; } @@ -2022,8 +1564,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2040,33 +1581,19 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * `filter` can be used to specify a subset of queues. Any Queue field can - * be used as a filter and several operators as supported. For example: `<=, - * <, >=, >, !=, =, :`. The filter syntax is the same as described in - * [Stackdriver's Advanced Logs - * Filters](https://cloud.google.com/logging/docs/view/advanced_filters). - * Sample filter "state: PAUSED". Note that using filters might cause fewer - * queues than the requested page_size to be returned. + * `filter` can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as described in [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters). Sample filter "state: PAUSED". Note that using filters might cause fewer queues than the requested page_size to be returned. */ filter?: string; /** - * Requested page size. The maximum page size is 9800. If unspecified, the - * page size will be the maximum. Fewer queues than requested might be - * returned, even if more queues exist; use the next_page_token in the - * response to determine if more queues exist. + * Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist. */ pageSize?: number; /** - * A token identifying the page of results to return. To request the first - * page results, page_token must be empty. To request the next page of - * results, page_token must be the value of next_page_token returned from - * the previous call to ListQueues method. It is an error to switch the - * value of the filter while iterating through pages. + * A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages. */ pageToken?: string; /** - * Required. The location name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID` + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID` */ parent?: string; } @@ -2078,23 +1605,11 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Caller-specified and required in CreateQueue, after which it becomes - * output only. The queue name. The queue name must have the following - * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * - * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the queue's location. The list - * of available locations can be obtained by calling ListLocations. For - * more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. + * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ name?: string; /** - * A mask used to specify which fields of the queue are being updated. If - * empty, then all fields will be updated. + * A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. */ updateMask?: string; @@ -2111,8 +1626,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -2129,8 +1643,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -2147,8 +1660,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -2165,8 +1677,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2183,8 +1694,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2202,9 +1712,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.create - * @desc Creates a task and adds it to a queue. Tasks cannot be updated - * after creation; there is no UpdateTask command. * For App Engine queues, - * the maximum task size is 100KB. + * @desc Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. * @alias cloudtasks.projects.locations.queues.tasks.create * @memberOf! () * @@ -2277,9 +1785,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.delete - * @desc Deletes a task. A task can be deleted if it is scheduled or - * dispatched. A task cannot be deleted if it has executed successfully or - * permanently failed. + * @desc Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed. * @alias cloudtasks.projects.locations.queues.tasks.delete * @memberOf! () * @@ -2418,10 +1924,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.list - * @desc Lists the tasks in a queue. By default, only the BASIC view is - * retrieved due to performance considerations; response_view controls the - * subset of information which is returned. The tasks may be returned in - * any order. The ordering may change at any time. + * @desc Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. * @alias cloudtasks.projects.locations.queues.tasks.list * @memberOf! () * @@ -2498,19 +2001,7 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.run - * @desc Forces a task to run now. When this method is called, Cloud Tasks - * will dispatch the task, even if the task is already running, the queue - * has reached its RateLimits or is PAUSED. This command is meant to be - * used for manual debugging. For example, RunTask can be used to retry a - * failed task after a fix has been made or to manually force a task to be - * dispatched now. The dispatched task is returned. That is, the task that - * is returned contains the status after the task is dispatched but before - * the task is received by its target. If Cloud Tasks receives a successful - * response from the task's target, then the task will be deleted; otherwise - * the task's schedule_time will be reset to the time that RunTask was - * called plus the retry delay specified in the queue's RetryConfig. RunTask - * returns NOT_FOUND when it is called on a task that has already succeeded - * or permanently failed. + * @desc Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. * @alias cloudtasks.projects.locations.queues.tasks.run * @memberOf! () * @@ -2587,9 +2078,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue - * must already exist. + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */ parent?: string; @@ -2606,8 +2095,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; } @@ -2619,18 +2107,11 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -2642,34 +2123,19 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. Fewer tasks than requested might be returned. The - * maximum page size is 1000. If unspecified, the page size will be the - * maximum. Fewer tasks than requested might be returned, even if more tasks - * exist; use next_page_token in the response to determine if more tasks - * exist. + * Requested page size. Fewer tasks than requested might be returned. The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. */ pageSize?: number; /** - * A token identifying the page of results to return. To request the first - * page results, page_token must be empty. To request the next page of - * results, page_token must be the value of next_page_token returned from - * the previous call to ListTasks method. The page token is valid for only - * 2 hours. + * A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours. */ pageToken?: string; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ parent?: string; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -2681,8 +2147,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index b3aae3985d5..ca6a5c54fd0 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudtasks_v2beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudtasks_v2beta2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace cloudtasks_v2beta2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -123,203 +122,62 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$AcknowledgeTaskRequest { /** - * Required. The task's current schedule time, available in the - * schedule_time returned by LeaseTasks response or RenewLease response. - * This restriction is to ensure that your worker currently holds the lease. + * Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. */ scheduleTime?: string; } /** - * App Engine HTTP request. The message defines the HTTP request that is sent - * to an App Engine app when the task is dispatched. This proto can only be - * used for tasks in a queue which has app_engine_http_target set. Using - * AppEngineHttpRequest requires - * [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) - * Google IAM permission for the project and the following scope: - * `https://www.googleapis.com/auth/cloud-platform` The task will be - * delivered to the App Engine app which belongs to the same project as the - * queue. For more information, see [How Requests are - * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and how routing is affected by [dispatch - * files](https://cloud.google.com/appengine/docs/python/config/dispatchref). - * Traffic is encrypted during transport and never leaves Google datacenters. - * Because this traffic is carried over a communication mechanism internal to - * Google, you cannot explicitly set the protocol (for example, HTTP or - * HTTPS). The request to the handler, however, will appear to have used the - * HTTP protocol. The AppEngineRouting used to construct the URL that the - * task is delivered to can be set at the queue-level or task-level: * If - * set, app_engine_routing_override is used for all tasks in the queue, - * no matter what the setting is for the task-level app_engine_routing. - * The `url` that the task will be sent to is: * `url =` host `+` - * relative_url Tasks can be dispatched to secure app handlers, unsecure app - * handlers, and URIs restricted with [`login: - * admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). - * Because tasks are not run as any user, they cannot be dispatched to URIs - * restricted with [`login: - * required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) - * Task dispatches also do not follow redirects. The task attempt has - * succeeded if the app's request handler returns an HTTP response code in - * the range [`200` - `299`]. `503` is considered an App Engine system error - * instead of an application error. Requests returning error `503` will be - * retried regardless of retry configuration and not counted against retry - * counts. Any other response code or a failure to receive a response before - * the deadline is a failed attempt. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `503` is considered an App Engine system error instead of an application error. Requests returning error `503` will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt. */ export interface Schema$AppEngineHttpRequest { /** - * Task-level setting for App Engine routing. If set, - * app_engine_routing_override is used for all tasks in the queue, no matter - * what the setting is for the task-level app_engine_routing. + * Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. */ appEngineRouting?: Schema$AppEngineRouting; /** - * HTTP request headers. This map contains the header field names and - * values. Headers can be set when the task is created. Repeated headers are - * not supported but a header value can contain commas. Cloud Tasks sets - * some headers to default values: * `User-Agent`: By default, this header - * is `"AppEngine-Google; (+http://code.google.com/appengine)"`. - * This header can be modified, but Cloud Tasks will append - * `"AppEngine-Google; (+http://code.google.com/appengine)"` to - * the modified `User-Agent`. If the task has a payload, Cloud Tasks sets - * the following headers: * `Content-Type`: By default, the `Content-Type` - * header is set to `"application/octet-stream"`. The default - * can be overridden by explicitly setting `Content-Type` to a particular - * media type when the task is created. For example, `Content-Type` can - * be set to `"application/json"`. * `Content-Length`: This is - * computed by Cloud Tasks. This value is output only. It cannot be - * changed. The headers below cannot be set or overridden: * `Host` * - * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some - * headers when the task is dispatched, such as headers containing - * information about the task; see [request - * headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). - * These headers are set only when the task is dispatched, so they are not - * visible when the task is returned in a Cloud Tasks response. Although - * there is no specific limit for the maximum number of headers or the size, - * there is a limit on the maximum size of the Task. For more information, - * see the CreateTask documentation. + * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a payload, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. */ headers?: {[key: string]: string}; /** - * The HTTP method to use for the request. The default is POST. The - * app's request handler for the task's target URL must be able to - * handle HTTP requests with this http_method, otherwise the task attempt - * will fail with error code 405 (Method Not Allowed). See [Writing a push - * task request - * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) - * and the documentation for the request handlers in the language your app - * is written in e.g. [Python Request - * Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + * The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). */ httpMethod?: string; /** - * Payload. The payload will be sent as the HTTP message body. A message - * body, and thus a payload, is allowed only if the HTTP method is POST or - * PUT. It is an error to set a data payload on a task with an incompatible - * HttpMethod. + * Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod. */ payload?: string; /** - * The relative URL. The relative URL must begin with "/" and - * must be a valid HTTP relative URL. It can contain a path and query string - * arguments. If the relative URL is empty, then the root path "/" - * will be used. No spaces are allowed, and the maximum length allowed is - * 2083 characters. + * The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ relativeUrl?: string; } /** - * App Engine HTTP target. The task will be delivered to the App Engine - * application hostname specified by its AppEngineHttpTarget and - * AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains - * how the task's host URL is constructed. Using AppEngineHttpTarget - * requires - * [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) - * Google IAM permission for the project and the following scope: - * `https://www.googleapis.com/auth/cloud-platform` + * App Engine HTTP target. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed. Using AppEngineHttpTarget requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` */ export interface Schema$AppEngineHttpTarget { /** - * Overrides for the task-level app_engine_routing. If set, - * `app_engine_routing_override` is used for all tasks in the queue, no - * matter what the setting is for the task-level app_engine_routing. + * Overrides for the task-level app_engine_routing. If set, `app_engine_routing_override` is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. */ appEngineRoutingOverride?: Schema$AppEngineRouting; } /** - * App Engine Routing. Defines routing characteristics specific to App Engine - * - service, version, and instance. For more information about services, - * versions, and instances see [An Overview of App - * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), - * [Microservices Architecture on Google App - * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ export interface Schema$AppEngineRouting { /** - * Output only. The host that the task is sent to. For more information, - * see [How Requests are - * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). - * The host is constructed as: * `host = - * [application_domain_name]`</br> `| [service] + '.' + - * [application_domain_name]`</br> `| [version] + '.' + - * [application_domain_name]`</br> `| [version_dot_service]+ - * '.' + [application_domain_name]`</br> `| [instance] + - * '.' + [application_domain_name]`</br> `| - * [instance_dot_service] + '.' + - * [application_domain_name]`</br> `| [instance_dot_version] + - * '.' + [application_domain_name]`</br> `| - * [instance_dot_version_dot_service] + '.' + - * [application_domain_name]` * `application_domain_name` = The domain name - * of the app, for example <app-id>.appspot.com, which is associated - * with the queue's project ID. Some tasks which were created using - * the App Engine SDK use a custom domain name. * `service =` service * - * `version =` version * `version_dot_service =` version `+ '.' - * +` service * `instance =` instance * `instance_dot_service =` - * instance `+ '.' +` service * `instance_dot_version =` instance - * `+ '.' +` version * `instance_dot_version_dot_service =` - * instance `+ '.' +` version `+ '.' +` service If - * service is empty, then the task will be sent to the service which is the - * default service when the task is attempted. If version is empty, then - * the task will be sent to the version which is the default version when - * the task is attempted. If instance is empty, then the task will be sent - * to an instance which is available when the task is attempted. If - * service, version, or instance is invalid, then the task will be sent to - * the default version of the default service when the task is attempted. + * Output only. The host that the task is sent to. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]`</br> `| [service] + '.' + [application_domain_name]`</br> `| [version] + '.' + [application_domain_name]`</br> `| [version_dot_service]+ '.' + [application_domain_name]`</br> `| [instance] + '.' + [application_domain_name]`</br> `| [instance_dot_service] + '.' + [application_domain_name]`</br> `| [instance_dot_version] + '.' + [application_domain_name]`</br> `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example <app-id>.appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. */ host?: string; /** - * App instance. By default, the task is sent to an instance which is - * available when the task is attempted. Requests can only be sent to a - * specific instance if [manual scaling is used in App Engine - * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). - * App Engine Flex does not support instances. For more information, see - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ instance?: string; /** - * App service. By default, the task is sent to the service which is the - * default service when the task is attempted. For some queues or tasks - * which were created using the App Engine Task Queue API, host is not - * parsable into service, version, and instance. For example, some tasks - * which were created using the App Engine SDK use a custom domain name; - * custom domains are not parsed by Cloud Tasks. If host is not parsable, - * then service, version, and instance are the empty string. + * App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ service?: string; /** - * App version. By default, the task is sent to the version which is the - * default version when the task is attempted. For some queues or tasks - * which were created using the App Engine Task Queue API, host is not - * parsable into service, version, and instance. For example, some tasks - * which were created using the App Engine SDK use a custom domain name; - * custom domains are not parsed by Cloud Tasks. If host is not parsable, - * then service, version, and instance are the empty string. + * App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ version?: string; } @@ -328,24 +186,19 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$AttemptStatus { /** - * Output only. The time that this attempt was dispatched. `dispatch_time` - * will be truncated to the nearest microsecond. + * Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. */ dispatchTime?: string; /** - * Output only. The response from the target for this attempt. If the task - * has not been attempted or the task is currently running then the response - * status is unset. + * Output only. The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset. */ responseStatus?: Schema$Status; /** - * Output only. The time that this attempt response was received. - * `response_time` will be truncated to the nearest microsecond. + * Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. */ responseTime?: string; /** - * Output only. The time that this attempt was scheduled. `schedule_time` - * will be truncated to the nearest microsecond. + * Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */ scheduleTime?: string; } @@ -354,30 +207,15 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -386,19 +224,11 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$CancelLeaseRequest { /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; /** - * Required. The task's current schedule time, available in the - * schedule_time returned by LeaseTasks response or RenewLease response. - * This restriction is to ensure that your worker currently holds the lease. + * Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. */ scheduleTime?: string; } @@ -407,75 +237,36 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$CreateTaskRequest { /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; /** - * Required. The task to add. Task names have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. - * The user can optionally specify a task name. If a name is not specified - * then the system will generate a random unique task id, which will be set - * in the task returned in the response. If schedule_time is not set or is - * in the past then Cloud Tasks will set it to the current time. Task - * De-duplication: Explicitly specifying a task ID enables task - * de-duplication. If a task's ID is identical to that of an existing - * task or a task that was deleted or completed recently then the call will - * fail with ALREADY_EXISTS. If the task's queue was created using Cloud - * Tasks, then another task with the same name can't be created for - * ~1hour after the original task was deleted or completed. If the - * task's queue was created using queue.yaml or queue.xml, then another - * task with the same name can't be created for ~9days after the - * original task was deleted or completed. Because there is an extra lookup - * cost to identify duplicate task names, these CreateTask calls have - * significantly increased latency. Using hashed strings for the task id or - * for the prefix of the task id is recommended. Choosing task ids that are - * sequential or have sequential prefixes, for example using a timestamp, - * causes an increase in latency and error rates in all task commands. The - * infrastructure relies on an approximately uniform distribution of task - * ids to store and serve tasks efficiently. + * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or completed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or completed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ task?: Schema$Task; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -488,47 +279,19 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$LeaseTasksRequest { /** - * `filter` can be used to specify a subset of tasks to lease. When - * `filter` is set to `tag=<my-tag>` then the response will contain - * only tasks whose tag is equal to `<my-tag>`. `<my-tag>` must - * be less than 500 characters. When `filter` is set to - * `tag_function=oldest_tag()`, only tasks which have the same tag as the - * task with the oldest schedule_time will be returned. Grammar Syntax: * - * `filter = "tag=" tag | "tag_function=" function` * - * `tag = string` * `function = "oldest_tag()"` The - * `oldest_tag()` function returns tasks which have the same tag as the - * oldest task (ordered by schedule time). SDK compatibility: Although the - * SDK allows tags to be either string or - * [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), - * only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't - * UTF-8 encoded can't be used in the filter and the task's tag will - * be displayed as empty in Cloud Tasks. + * `filter` can be used to specify a subset of tasks to lease. When `filter` is set to `tag=<my-tag>` then the response will contain only tasks whose tag is equal to `<my-tag>`. `<my-tag>` must be less than 500 characters. When `filter` is set to `tag_function=oldest_tag()`, only tasks which have the same tag as the task with the oldest schedule_time will be returned. Grammar Syntax: * `filter = "tag=" tag | "tag_function=" function` * `tag = string` * `function = "oldest_tag()"` The `oldest_tag()` function returns tasks which have the same tag as the oldest task (ordered by schedule time). SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the filter and the task's tag will be displayed as empty in Cloud Tasks. */ filter?: string; /** - * After the worker has successfully finished the work associated with the - * task, the worker must call via AcknowledgeTask before the schedule_time. - * Otherwise the task will be returned to a later LeaseTasks call so that - * another worker can retry it. The maximum lease duration is 1 week. - * `lease_duration` will be truncated to the nearest second. + * After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. */ leaseDuration?: string; /** - * The maximum number of tasks to lease. The system will make a best effort - * to return as close to as `max_tasks` as possible. The largest that - * `max_tasks` can be is 1000. The maximum total size of a lease tasks - * response is 32 MB. If the sum of all task sizes requested reaches this - * limit, fewer tasks than requested are returned. + * The maximum number of tasks to lease. The system will make a best effort to return as close to as `max_tasks` as possible. The largest that `max_tasks` can be is 1000. The maximum total size of a lease tasks response is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned. */ maxTasks?: number; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -559,10 +322,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$ListQueuesResponse { /** - * A token to retrieve next page of results. To return the next page of - * results, call ListQueues with this value as the page_token. If the - * next_page_token is empty, there are no more results. The page token is - * valid for only 2 hours. + * A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. */ nextPageToken?: string; /** @@ -575,9 +335,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$ListTasksResponse { /** - * A token to retrieve next page of results. To return the next page of - * results, call ListTasks with this value as the page_token. If the - * next_page_token is empty, there are no more results. + * A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. */ nextPageToken?: string; /** @@ -590,13 +348,11 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -604,13 +360,11 @@ export namespace cloudtasks_v2beta2 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -619,41 +373,15 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -662,9 +390,7 @@ export namespace cloudtasks_v2beta2 { version?: number; } /** - * The pull message contains data that can be used by the caller of LeaseTasks - * to process the task. This proto can only be used for tasks in a queue - * which has pull_target set. + * The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. */ export interface Schema$PullMessage { /** @@ -672,17 +398,7 @@ export namespace cloudtasks_v2beta2 { */ payload?: string; /** - * The task's tag. Tags allow similar tasks to be processed in a batch. - * If you label tasks with a tag, your worker can lease tasks with the same - * tag using filter. For example, if you want to aggregate the events - * associated with a specific user once a day, you could tag tasks with the - * user ID. The task's tag can only be set when the task is created. - * The tag must be less than 500 characters. SDK compatibility: Although - * the SDK allows tags to be either string or - * [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), - * only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't - * UTF-8 encoded, the tag will be empty when the task is returned by Cloud - * Tasks. + * The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. */ tag?: string; } @@ -695,29 +411,15 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$PurgeQueueRequest {} /** - * A queue is a container of related tasks. Queues are configured to manage - * how those tasks are dispatched. Configurable properties include rate - * limits, retry options, target types, and others. + * A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others. */ export interface Schema$Queue { /** - * App Engine HTTP target. An App Engine queue is a queue that has an - * AppEngineHttpTarget. + * App Engine HTTP target. An App Engine queue is a queue that has an AppEngineHttpTarget. */ appEngineHttpTarget?: Schema$AppEngineHttpTarget; /** - * Caller-specified and required in CreateQueue, after which it becomes - * output only. The queue name. The queue name must have the following - * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * - * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the queue's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. + * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ name?: string; /** @@ -725,95 +427,36 @@ export namespace cloudtasks_v2beta2 { */ pullTarget?: Schema$PullTarget; /** - * Output only. The last time this queue was purged. All tasks that were - * created before this time were purged. A queue can be purged using - * PurgeQueue, the [App Engine Task Queue SDK, or the Cloud - * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). - * Purge time will be truncated to the nearest microsecond. Purge time will - * be unset if the queue has never been purged. + * Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. */ purgeTime?: string; /** - * Rate limits for task dispatches. rate_limits and retry_config are - * related because they both control task attempts however they control how - * tasks are attempted in different ways: * rate_limits controls the total - * rate of dispatches from a queue (i.e. all traffic dispatched from the - * queue, regardless of whether the dispatch is from a first attempt or a - * retry). * retry_config controls what happens to particular a task after - * its first attempt fails. That is, retry_config controls task retries - * (the second attempt, third attempt, etc). + * Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts however they control how tasks are attempted in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). */ rateLimits?: Schema$RateLimits; /** - * Settings that determine the retry behavior. * For tasks created using - * Cloud Tasks: the queue-level retry settings apply to all tasks in the - * queue that were created using Cloud Tasks. Retry settings cannot be set - * on individual tasks. * For tasks created using the App Engine SDK: the - * queue-level retry settings apply to all tasks in the queue which do not - * have retry settings explicitly set on the task and were created by the - * App Engine SDK. See [App Engine - * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + * Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). */ retryConfig?: Schema$RetryConfig; /** - * Output only. The state of the queue. `state` can only be changed by - * called PauseQueue, ResumeQueue, or uploading - * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). - * UpdateQueue cannot be used to change `state`. + * Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */ state?: string; } /** - * Rate limits. This message determines the maximum rate that tasks can be - * dispatched by a queue, regardless of whether the dispatch is a first task - * attempt or a retry. Note: The debugging command, RunTask, will run a task - * even if the queue has reached its RateLimits. + * Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. */ export interface Schema$RateLimits { /** - * Output only. The max burst size. Max burst size limits how fast tasks in - * queue are processed when many tasks are in the queue and the rate is - * high. This field allows the queue to have a high rate so processing - * starts shortly after a task is enqueued, but still limits resource usage - * when many tasks are enqueued in a short period of time. The [token - * bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to - * control the rate of task dispatches. Each queue has a token bucket that - * holds tokens, up to the maximum specified by `max_burst_size`. Each time - * a task is dispatched, a token is removed from the bucket. Tasks will be - * dispatched until the queue's bucket runs out of tokens. The bucket - * will be continuously refilled with new tokens based on - * max_tasks_dispatched_per_second. Cloud Tasks will pick the value of - * `max_burst_size` based on the value of max_tasks_dispatched_per_second. - * For App Engine queues that were created or updated using - * `queue.yaml/xml`, `max_burst_size` is equal to - * [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). - * Since `max_burst_size` is output only, if UpdateQueue is called on a - * queue created by `queue.yaml/xml`, `max_burst_size` will be reset based - * on the value of max_tasks_dispatched_per_second, regardless of whether - * max_tasks_dispatched_per_second is updated. + * Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_tasks_dispatched_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_tasks_dispatched_per_second. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_tasks_dispatched_per_second, regardless of whether max_tasks_dispatched_per_second is updated. */ maxBurstSize?: number; /** - * The maximum number of concurrent tasks that Cloud Tasks allows to be - * dispatched for this queue. After this threshold has been reached, Cloud - * Tasks stops dispatching tasks until the number of concurrent requests - * decreases. If unspecified when the queue is created, Cloud Tasks will - * pick the default. The maximum allowed value is 5,000. This field is - * output only for pull queues and always -1, which indicates no limit. No - * other queue types can have `max_concurrent_tasks` set to -1. This field - * has the same meaning as [max_concurrent_requests in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). + * The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). */ maxConcurrentTasks?: number; /** - * The maximum rate at which tasks are dispatched from this queue. If - * unspecified when the queue is created, Cloud Tasks will pick the default. - * * For App Engine queues, the maximum allowed value is 500. * This field - * is output only for pull queues. In addition to the - * `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of - * LeaseTasks requests are allowed per pull queue. This field has the same - * meaning as [rate in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + * The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). */ maxTasksDispatchedPerSecond?: number; } @@ -822,25 +465,15 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$RenewLeaseRequest { /** - * Required. The desired new lease duration, starting from now. The - * maximum lease duration is 1 week. `lease_duration` will be truncated to - * the nearest second. + * Required. The desired new lease duration, starting from now. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. */ leaseDuration?: string; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; /** - * Required. The task's current schedule time, available in the - * schedule_time returned by LeaseTasks response or RenewLease response. - * This restriction is to ensure that your worker currently holds the lease. + * Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease. */ scheduleTime?: string; } @@ -849,63 +482,27 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$ResumeQueueRequest {} /** - * Retry config. These settings determine how a failed task attempt is - * retried. + * Retry config. These settings determine how a failed task attempt is retried. */ export interface Schema$RetryConfig { /** - * The maximum number of attempts for a task. Cloud Tasks will attempt the - * task `max_attempts` times (that is, if the first attempt fails, then - * there will be `max_attempts - 1` retries). Must be > 0. + * The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. */ maxAttempts?: number; /** - * A task will be scheduled for retry between min_backoff and max_backoff - * duration after it fails, if the queue's RetryConfig specifies that - * the task should be retried. If unspecified when the queue is created, - * Cloud Tasks will pick the default. This field is output only for pull - * queues. `max_backoff` will be truncated to the nearest second. This - * field has the same meaning as [max_backoff_seconds in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxBackoff?: string; /** - * The time between retries will double `max_doublings` times. A task's - * retry interval starts at min_backoff, then doubles `max_doublings` times, - * then increases linearly, and finally retries retries at intervals of - * max_backoff up to max_attempts times. For example, if min_backoff is - * 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will - * first be retried in 10s. The retry interval will double three times, and - * then increase linearly by 2^3 * 10s. Finally, the task will retry at - * intervals of max_backoff until the task has been attempted max_attempts - * times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, - * 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks - * will pick the default. This field is output only for pull queues. This - * field has the same meaning as [max_doublings in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxDoublings?: number; /** - * If positive, `max_retry_duration` specifies the time limit for retrying a - * failed task, measured from when the task was first attempted. Once - * `max_retry_duration` time has passed *and* the task has been attempted - * max_attempts times, no further attempts will be made and the task will be - * deleted. If zero, then the task age is unlimited. If unspecified when - * the queue is created, Cloud Tasks will pick the default. This field is - * output only for pull queues. `max_retry_duration` will be truncated to - * the nearest second. This field has the same meaning as [task_age_limit - * in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxRetryDuration?: string; /** - * A task will be scheduled for retry between min_backoff and max_backoff - * duration after it fails, if the queue's RetryConfig specifies that - * the task should be retried. If unspecified when the queue is created, - * Cloud Tasks will pick the default. This field is output only for pull - * queues. `min_backoff` will be truncated to the nearest second. This - * field has the same meaning as [min_backoff_seconds in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ minBackoff?: string; /** @@ -918,13 +515,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$RunTaskRequest { /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -933,48 +524,12 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -982,14 +537,11 @@ export namespace cloudtasks_v2beta2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -998,46 +550,23 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$Task { /** - * App Engine HTTP request that is sent to the task's target. Can be set - * only if app_engine_http_target is set on the queue. An App Engine task - * is a task that has AppEngineHttpRequest set. + * App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set. */ appEngineHttpRequest?: Schema$AppEngineHttpRequest; /** - * Output only. The time that the task was created. `create_time` will be - * truncated to the nearest second. + * Output only. The time that the task was created. `create_time` will be truncated to the nearest second. */ createTime?: string; /** - * Optionally caller-specified in CreateTask. The task name. The task name - * must have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the task's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. * `TASK_ID` can contain only - * letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). - * The maximum length is 500 characters. + * Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** - * LeaseTasks to process the task. Can be set only if pull_target is set on - * the queue. A pull task is a task that has PullMessage set. + * LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. */ pullMessage?: Schema$PullMessage; /** - * The time when the task is scheduled to be attempted. For App Engine - * queues, this is when the task will be attempted or retried. For pull - * queues, this is the time when the task is available to be leased; if a - * task is currently leased, this is the time when the current lease - * expires, that is, the time that the task was leased plus the - * lease_duration. `schedule_time` will be truncated to the nearest - * microsecond. + * The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. */ scheduleTime?: string; /** @@ -1045,8 +574,7 @@ export namespace cloudtasks_v2beta2 { */ status?: Schema$TaskStatus; /** - * Output only. The view specifies which subset of the Task has been - * returned. + * Output only. The view specifies which subset of the Task has been returned. */ view?: string; } @@ -1055,24 +583,19 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$TaskStatus { /** - * Output only. The number of attempts dispatched. This count includes - * attempts which have been dispatched but haven't received a response. + * Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. */ attemptDispatchCount?: number; /** - * Output only. The number of attempts which have received a response. This - * field is not calculated for pull tasks. + * Output only. The number of attempts which have received a response. This field is not calculated for pull tasks. */ attemptResponseCount?: number; /** - * Output only. The status of the task's first attempt. Only - * dispatch_time will be set. The other AttemptStatus information is not - * retained by Cloud Tasks. This field is not calculated for pull tasks. + * Output only. The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks. */ firstAttemptStatus?: Schema$AttemptStatus; /** - * Output only. The status of the task's last attempt. This field is - * not calculated for pull tasks. + * Output only. The status of the task's last attempt. This field is not calculated for pull tasks. */ lastAttemptStatus?: Schema$AttemptStatus; } @@ -1081,10 +604,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1093,8 +613,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1125,14 +644,12 @@ export namespace cloudtasks_v2beta2 { * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1142,8 +659,7 @@ export namespace cloudtasks_v2beta2 { * authorize(function(authClient) { * var request = { * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', // TODO: Update - * placeholder value. + * name: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1165,10 +681,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1248,14 +763,12 @@ export namespace cloudtasks_v2beta2 { * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1281,8 +794,8 @@ export namespace cloudtasks_v2beta2 { * return; * } * for (var i = 0; i < locationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `locationsPage`: console.log(JSON.stringify(locationsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `locationsPage`: + * console.log(JSON.stringify(locationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1300,10 +813,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1432,28 +944,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.create - * @desc Creates a queue. Queues created with this method allow tasks to - * live for a maximum of 31 days. After a task is 31 days old, the task will - * be deleted regardless of whether it was dispatched or not. WARNING: - * Using this method may have unintended side effects if you are using an - * App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read - * [Overview of Queue Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1468,8 +971,7 @@ export namespace cloudtasks_v2beta2 { * // The list of allowed locations can be obtained by calling Cloud * // Tasks' implementation of * // google.cloud.location.Locations.ListLocations. - * parent: 'projects/my-project/locations/my-location', // TODO: Update - * placeholder value. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1478,8 +980,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.create(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1493,10 +997,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1573,28 +1076,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.delete - * @desc Deletes a queue. This command will delete the queue even if it has - * tasks in it. Note: If you delete a queue, a queue with the same name - * can't be created for 7 days. WARNING: Using this method may have - * unintended side effects if you are using an App Engine `queue.yaml` or - * `queue.xml` file to manage your queues. Read [Overview of Queue - * Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1606,8 +1100,7 @@ export namespace cloudtasks_v2beta2 { * // Required. * // The queue name. For example: * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - * name: 'projects/my-project/locations/my-location/queues/my-queue', // - * TODO: Update placeholder value. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1626,10 +1119,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1709,14 +1201,12 @@ export namespace cloudtasks_v2beta2 { * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1728,14 +1218,15 @@ export namespace cloudtasks_v2beta2 { * // Required. * // The resource name of the queue. For example: * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - * name: 'projects/my-project/locations/my-location/queues/my-queue', // - * TODO: Update placeholder value. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.get(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1749,10 +1240,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1825,25 +1315,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.getIamPolicy - * @desc Gets the access control policy for a Queue. Returns an empty policy - * if the resource exists and does not have a policy set. Authorization - * requires the following [Google IAM](https://cloud.google.com/iam) - * permission on the specified resource parent: * - * `cloudtasks.queues.getIamPolicy` + * @desc Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1853,10 +1337,8 @@ export namespace cloudtasks_v2beta2 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: - * 'projects/my-project/locations/my-location/queues/my-queue', // TODO: - * Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1865,8 +1347,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.getIamPolicy(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1880,10 +1364,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1967,14 +1450,12 @@ export namespace cloudtasks_v2beta2 { * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1986,8 +1467,7 @@ export namespace cloudtasks_v2beta2 { * // Required. * // The location name. * // For example: `projects/PROJECT_ID/locations/LOCATION_ID` - * parent: 'projects/my-project/locations/my-location', // TODO: Update - * placeholder value. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -2003,8 +1483,8 @@ export namespace cloudtasks_v2beta2 { * return; * } * for (var i = 0; i < queuesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `queuesPage`: console.log(JSON.stringify(queuesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `queuesPage`: + * console.log(JSON.stringify(queuesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2022,10 +1502,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2106,29 +1585,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.patch - * @desc Updates a queue. This method creates the queue if it does not - * exist and updates the queue if it does exist. Queues created with this - * method allow tasks to live for a maximum of 31 days. After a task is 31 - * days old, the task will be deleted regardless of whether it was - * dispatched or not. WARNING: Using this method may have unintended side - * effects if you are using an App Engine `queue.yaml` or `queue.xml` file - * to manage your queues. Read [Overview of Queue Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2149,20 +1618,20 @@ export namespace cloudtasks_v2beta2 { * // characters. * // Caller-specified and required in CreateQueueRequest, after which * // it becomes output only. - * name: 'projects/my-project/locations/my-location/queues/my-queue', // - * TODO: Update placeholder value. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.patch(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2176,10 +1645,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2254,24 +1722,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.pause - * @desc Pauses the queue. If a queue is paused then the system will stop - * dispatching tasks until the queue is resumed via ResumeQueue. Tasks can - * still be added when the queue is paused. A queue is paused if its state - * is PAUSED. + * @desc Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2283,8 +1746,7 @@ export namespace cloudtasks_v2beta2 { * // Required. * // The queue name. For example: * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` - * name: 'projects/my-project/locations/my-location/queues/my-queue', // - * TODO: Update placeholder value. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2293,8 +1755,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.pause(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.pause(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2308,10 +1772,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2388,24 +1851,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.purge - * @desc Purges a queue by deleting all of its tasks. All tasks created - * before this method is called are permanently deleted. Purge operations - * can take up to one minute to take effect. Tasks might be dispatched - * before the purge takes effect. A purge is irreversible. + * @desc Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2417,8 +1875,7 @@ export namespace cloudtasks_v2beta2 { * // Required. * // The queue name. For example: * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` - * name: 'projects/my-project/locations/my-location/queues/my-queue', // - * TODO: Update placeholder value. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2427,8 +1884,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.purge(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.purge(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2442,10 +1901,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2522,27 +1980,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.resume - * @desc Resume a queue. This method resumes a queue after it has been - * PAUSED or DISABLED. The state of a queue is stored in the queue's state; - * after calling this method it will be set to RUNNING. WARNING: Resuming - * many high-QPS queues at the same time can lead to target overloading. If - * you are resuming high-QPS queues, follow the 500/50/5 pattern described - * in [Managing Cloud Tasks Scaling - * Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). + * @desc Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2554,8 +2004,7 @@ export namespace cloudtasks_v2beta2 { * // Required. * // The queue name. For example: * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` - * name: 'projects/my-project/locations/my-location/queues/my-queue', // - * TODO: Update placeholder value. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2564,8 +2013,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.resume(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.resume(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2579,10 +2030,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2659,26 +2109,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.setIamPolicy - * @desc Sets the access control policy for a Queue. Replaces any existing - * policy. Note: The Cloud Console does not check queue-level IAM - * permissions yet. Project-level permissions are required to use the Cloud - * Console. Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission on the specified resource - * parent: * `cloudtasks.queues.setIamPolicy` + * @desc Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2688,10 +2131,8 @@ export namespace cloudtasks_v2beta2 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: - * 'projects/my-project/locations/my-location/queues/my-queue', // TODO: - * Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2700,8 +2141,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.setIamPolicy(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2715,10 +2158,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2795,25 +2237,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.testIamPermissions - * @desc Returns permissions that a caller has on a Queue. If the resource - * does not exist, this will return an empty set of permissions, not a - * NOT_FOUND error. Note: This operation is designed to be used for - * building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2822,12 +2258,9 @@ export namespace cloudtasks_v2beta2 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: - * 'projects/my-project/locations/my-location/queues/my-queue', // TODO: - * Update placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2836,8 +2269,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.testIamPermissions(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2851,10 +2286,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2947,10 +2381,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The location name in which the queue will be created. For - * example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed - * locations can be obtained by calling Cloud Tasks' implementation of - * ListLocations. + * Required. The location name in which the queue will be created. For example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations. */ parent?: string; @@ -2967,8 +2398,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ name?: string; } @@ -2980,8 +2410,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the queue. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The resource name of the queue. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ name?: string; } @@ -2993,8 +2422,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3011,33 +2439,19 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * `filter` can be used to specify a subset of queues. Any Queue field can - * be used as a filter and several operators as supported. For example: `<=, - * <, >=, >, !=, =, :`. The filter syntax is the same as described in - * [Stackdriver's Advanced Logs - * Filters](https://cloud.google.com/logging/docs/view/advanced_filters). - * Sample filter "app_engine_http_target: *". Note that using filters might - * cause fewer queues than the requested_page size to be returned. + * `filter` can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as described in [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters). Sample filter "app_engine_http_target: *". Note that using filters might cause fewer queues than the requested_page size to be returned. */ filter?: string; /** - * Requested page size. The maximum page size is 9800. If unspecified, the - * page size will be the maximum. Fewer queues than requested might be - * returned, even if more queues exist; use the next_page_token in the - * response to determine if more queues exist. + * Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist. */ pageSize?: number; /** - * A token identifying the page of results to return. To request the first - * page results, page_token must be empty. To request the next page of - * results, page_token must be the value of next_page_token returned from - * the previous call to ListQueues method. It is an error to switch the - * value of the filter while iterating through pages. + * A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages. */ pageToken?: string; /** - * Required. The location name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID` + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID` */ parent?: string; } @@ -3049,23 +2463,11 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Caller-specified and required in CreateQueue, after which it becomes - * output only. The queue name. The queue name must have the following - * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * - * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the queue's location. The list - * of available locations can be obtained by calling ListLocations. For - * more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. + * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ name?: string; /** - * A mask used to specify which fields of the queue are being updated. If - * empty, then all fields will be updated. + * A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. */ updateMask?: string; @@ -3082,8 +2484,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -3100,8 +2501,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -3118,8 +2518,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -3136,8 +2535,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3154,8 +2552,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3173,26 +2570,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.acknowledge - * @desc Acknowledges a pull task. The worker, that is, the entity that - * leased this task must call this method to indicate that the work - * associated with the task has finished. The worker must acknowledge a - * task within the lease_duration or the lease will expire and the task will - * become available to be leased again. After the task is acknowledged, it - * will not be returned by a later LeaseTasks, GetTask, or ListTasks. + * @desc Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3203,11 +2593,8 @@ export namespace cloudtasks_v2beta2 { * var request = { * // Required. * // The task name. For example: - * // - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * name: - * 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', - * // TODO: Update placeholder value. + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3216,8 +2603,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.tasks.acknowledge(request, - * function(err) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.tasks.acknowledge(request, function(err) { + * if (err) { + * console.error(err); + * return; * } * }); * }); @@ -3228,10 +2617,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3308,23 +2696,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.cancelLease - * @desc Cancel a pull task's lease. The worker can use this method to - * cancel a task's lease by setting its schedule_time to now. This will make - * the task available to be leased to the next caller of LeaseTasks. + * @desc Cancel a pull task's lease. The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3335,11 +2719,8 @@ export namespace cloudtasks_v2beta2 { * var request = { * // Required. * // The task name. For example: - * // - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * name: - * 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', - * // TODO: Update placeholder value. + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3348,8 +2729,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.tasks.cancelLease(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.tasks.cancelLease(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3363,10 +2746,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3443,24 +2825,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.create - * @desc Creates a task and adds it to a queue. Tasks cannot be updated - * after creation; there is no UpdateTask command. * For App Engine queues, - * the maximum task size is 100KB. * For pull queues, the maximum task - * size is 1MB. + * @desc Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. * For pull queues, the maximum task size is 1MB. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3473,8 +2850,7 @@ export namespace cloudtasks_v2beta2 { * // The queue name. For example: * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * // The queue must already exist. - * parent: 'projects/my-project/locations/my-location/queues/my-queue', - * // TODO: Update placeholder value. + * parent: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3483,8 +2859,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.tasks.create(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.tasks.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3498,10 +2876,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3578,23 +2955,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.delete - * @desc Deletes a task. A task can be deleted if it is scheduled or - * dispatched. A task cannot be deleted if it has completed successfully or - * permanently failed. + * @desc Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3605,17 +2978,16 @@ export namespace cloudtasks_v2beta2 { * var request = { * // Required. * // The task name. For example: - * // - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * name: - * 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', - * // TODO: Update placeholder value. + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. * * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.tasks.delete(request, - * function(err) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.tasks.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; * } * }); * }); @@ -3626,10 +2998,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3709,14 +3080,12 @@ export namespace cloudtasks_v2beta2 { * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3727,17 +3096,16 @@ export namespace cloudtasks_v2beta2 { * var request = { * // Required. * // The task name. For example: - * // - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * name: - * 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', - * // TODO: Update placeholder value. + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. * * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.tasks.get(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.tasks.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3751,10 +3119,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3828,15 +3195,7 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.lease - * @desc Leases tasks from a pull queue for lease_duration. This method is - * invoked by the worker to obtain a lease. The worker must acknowledge the - * task via AcknowledgeTask after they have performed the work associated - * with the task. The payload is intended to store data that the worker - * needs to perform the work associated with the task. To return the - * payloads in the response, set response_view to FULL. A maximum of 10 qps - * of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is - * returned when this limit is exceeded. RESOURCE_EXHAUSTED is also returned - * when max_tasks_dispatched_per_second is exceeded. + * @desc Leases tasks from a pull queue for lease_duration. This method is invoked by the worker to obtain a lease. The worker must acknowledge the task via AcknowledgeTask after they have performed the work associated with the task. The payload is intended to store data that the worker needs to perform the work associated with the task. To return the payloads in the response, set response_view to FULL. A maximum of 10 qps of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded. RESOURCE_EXHAUSTED is also returned when max_tasks_dispatched_per_second is exceeded. * @alias cloudtasks.projects.locations.queues.tasks.lease * @memberOf! () * @@ -3911,24 +3270,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.list - * @desc Lists the tasks in a queue. By default, only the BASIC view is - * retrieved due to performance considerations; response_view controls the - * subset of information which is returned. The tasks may be returned in - * any order. The ordering may change at any time. + * @desc Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3940,8 +3294,7 @@ export namespace cloudtasks_v2beta2 { * // Required. * // The queue name. For example: * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - * parent: 'projects/my-project/locations/my-location/queues/my-queue', - * // TODO: Update placeholder value. + * parent: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -3963,8 +3316,7 @@ export namespace cloudtasks_v2beta2 { * * if (response.nextPageToken) { * request.pageToken = response.nextPageToken; - * cloudTasks.projects.locations.queues.tasks.list(request, - * handlePage); + * cloudTasks.projects.locations.queues.tasks.list(request, handlePage); * } * }; * @@ -3977,10 +3329,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4061,23 +3412,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.renewLease - * @desc Renew the current lease of a pull task. The worker can use this - * method to extend the lease by a new duration, starting from now. The new - * task lease will be returned in the task's schedule_time. + * @desc Renew the current lease of a pull task. The worker can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in the task's schedule_time. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4088,11 +3435,8 @@ export namespace cloudtasks_v2beta2 { * var request = { * // Required. * // The task name. For example: - * // - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * name: - * 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', - * // TODO: Update placeholder value. + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -4101,8 +3445,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.tasks.renewLease(request, - * function(err, response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.tasks.renewLease(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4116,10 +3462,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4196,33 +3541,19 @@ export namespace cloudtasks_v2beta2 { /** * cloudtasks.projects.locations.queues.tasks.run - * @desc Forces a task to run now. When this method is called, Cloud Tasks - * will dispatch the task, even if the task is already running, the queue - * has reached its RateLimits or is PAUSED. This command is meant to be - * used for manual debugging. For example, RunTask can be used to retry a - * failed task after a fix has been made or to manually force a task to be - * dispatched now. The dispatched task is returned. That is, the task that - * is returned contains the status after the task is dispatched but before - * the task is received by its target. If Cloud Tasks receives a successful - * response from the task's target, then the task will be deleted; otherwise - * the task's schedule_time will be reset to the time that RunTask was - * called plus the retry delay specified in the queue's RetryConfig. RunTask - * returns NOT_FOUND when it is called on a task that has already succeeded - * or permanently failed. RunTask cannot be called on a pull task. + * @desc Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. RunTask cannot be called on a pull task. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Tasks API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtasks - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4233,11 +3564,8 @@ export namespace cloudtasks_v2beta2 { * var request = { * // Required. * // The task name. For example: - * // - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * name: - * 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', - * // TODO: Update placeholder value. + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -4246,8 +3574,10 @@ export namespace cloudtasks_v2beta2 { * auth: authClient, * }; * - * cloudTasks.projects.locations.queues.tasks.run(request, function(err, - * response) { if (err) { console.error(err); return; + * cloudTasks.projects.locations.queues.tasks.run(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4261,10 +3591,9 @@ export namespace cloudtasks_v2beta2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4348,8 +3677,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; @@ -4366,8 +3694,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; @@ -4384,9 +3711,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue - * must already exist. + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */ parent?: string; @@ -4403,8 +3728,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; } @@ -4416,18 +3740,11 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -4439,8 +3756,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ parent?: string; @@ -4457,34 +3773,19 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. Fewer tasks than requested might be returned. The - * maximum page size is 1000. If unspecified, the page size will be the - * maximum. Fewer tasks than requested might be returned, even if more tasks - * exist; use next_page_token in the response to determine if more tasks - * exist. + * Requested page size. Fewer tasks than requested might be returned. The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. */ pageSize?: number; /** - * A token identifying the page of results to return. To request the first - * page results, page_token must be empty. To request the next page of - * results, page_token must be the value of next_page_token returned from - * the previous call to ListTasks method. The page token is valid for only - * 2 hours. + * A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours. */ pageToken?: string; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ parent?: string; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -4496,8 +3797,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; @@ -4514,8 +3814,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index d35d9b1eb9b..46a9b67c942 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudtasks_v2beta3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudtasks_v2beta3 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,179 +108,67 @@ export namespace cloudtasks_v2beta3 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * App Engine HTTP queue. The task will be delivered to the App Engine - * application hostname specified by its AppEngineHttpQueue and - * AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains - * how the task's host URL is constructed. Using AppEngineHttpQueue - * requires - * [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) - * Google IAM permission for the project and the following scope: - * `https://www.googleapis.com/auth/cloud-platform` + * App Engine HTTP queue. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpQueue and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed. Using AppEngineHttpQueue requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` */ export interface Schema$AppEngineHttpQueue { /** - * Overrides for the task-level app_engine_routing. If set, - * `app_engine_routing_override` is used for all tasks in the queue, no - * matter what the setting is for the task-level app_engine_routing. + * Overrides for the task-level app_engine_routing. If set, `app_engine_routing_override` is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. */ appEngineRoutingOverride?: Schema$AppEngineRouting; } /** - * App Engine HTTP request. The message defines the HTTP request that is sent - * to an App Engine app when the task is dispatched. This proto can only be - * used for tasks in a queue which has app_engine_http_queue set. Using - * AppEngineHttpRequest requires - * [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) - * Google IAM permission for the project and the following scope: - * `https://www.googleapis.com/auth/cloud-platform` The task will be - * delivered to the App Engine app which belongs to the same project as the - * queue. For more information, see [How Requests are - * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and how routing is affected by [dispatch - * files](https://cloud.google.com/appengine/docs/python/config/dispatchref). - * Traffic is encrypted during transport and never leaves Google datacenters. - * Because this traffic is carried over a communication mechanism internal to - * Google, you cannot explicitly set the protocol (for example, HTTP or - * HTTPS). The request to the handler, however, will appear to have used the - * HTTP protocol. The AppEngineRouting used to construct the URL that the - * task is delivered to can be set at the queue-level or task-level: * If - * set, app_engine_routing_override is used for all tasks in the queue, - * no matter what the setting is for the task-level app_engine_routing. - * The `url` that the task will be sent to is: * `url =` host `+` - * relative_uri Tasks can be dispatched to secure app handlers, unsecure app - * handlers, and URIs restricted with [`login: - * admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). - * Because tasks are not run as any user, they cannot be dispatched to URIs - * restricted with [`login: - * required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) - * Task dispatches also do not follow redirects. The task attempt has - * succeeded if the app's request handler returns an HTTP response code in - * the range [`200` - `299`]. `503` is considered an App Engine system error - * instead of an application error. Requests returning error `503` will be - * retried regardless of retry configuration and not counted against retry - * counts. Any other response code or a failure to receive a response before - * the deadline is a failed attempt. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_queue set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `503` is considered an App Engine system error instead of an application error. Requests returning error `503` will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt. */ export interface Schema$AppEngineHttpRequest { /** - * Task-level setting for App Engine routing. If set, - * app_engine_routing_override is used for all tasks in the queue, no matter - * what the setting is for the task-level app_engine_routing. + * Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. */ appEngineRouting?: Schema$AppEngineRouting; /** - * HTTP request body. A request body is allowed only if the HTTP method is - * POST or PUT. It is an error to set a body on a task with an incompatible - * HttpMethod. + * HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod. */ body?: string; /** - * HTTP request headers. This map contains the header field names and - * values. Headers can be set when the task is created. Repeated headers are - * not supported but a header value can contain commas. Cloud Tasks sets - * some headers to default values: * `User-Agent`: By default, this header - * is `"AppEngine-Google; (+http://code.google.com/appengine)"`. - * This header can be modified, but Cloud Tasks will append - * `"AppEngine-Google; (+http://code.google.com/appengine)"` to - * the modified `User-Agent`. If the task has a body, Cloud Tasks sets - * the following headers: * `Content-Type`: By default, the `Content-Type` - * header is set to `"application/octet-stream"`. The default - * can be overridden by explicitly setting `Content-Type` to a particular - * media type when the task is created. For example, `Content-Type` can - * be set to `"application/json"`. * `Content-Length`: This is - * computed by Cloud Tasks. This value is output only. It cannot be - * changed. The headers below cannot be set or overridden: * `Host` * - * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some - * headers when the task is dispatched, such as headers containing - * information about the task; see [request - * headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). - * These headers are set only when the task is dispatched, so they are not - * visible when the task is returned in a Cloud Tasks response. Although - * there is no specific limit for the maximum number of headers or the size, - * there is a limit on the maximum size of the Task. For more information, - * see the CreateTask documentation. + * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. */ headers?: {[key: string]: string}; /** - * The HTTP method to use for the request. The default is POST. The - * app's request handler for the task's target URL must be able to - * handle HTTP requests with this http_method, otherwise the task attempt - * will fail with error code 405 (Method Not Allowed). See [Writing a push - * task request - * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) - * and the documentation for the request handlers in the language your app - * is written in e.g. [Python Request - * Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + * The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). */ httpMethod?: string; /** - * The relative URI. The relative URI must begin with "/" and - * must be a valid HTTP relative URI. It can contain a path and query string - * arguments. If the relative URI is empty, then the root path "/" - * will be used. No spaces are allowed, and the maximum length allowed is - * 2083 characters. + * The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */ relativeUri?: string; } /** - * App Engine Routing. Defines routing characteristics specific to App Engine - * - service, version, and instance. For more information about services, - * versions, and instances see [An Overview of App - * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), - * [Microservices Architecture on Google App - * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ export interface Schema$AppEngineRouting { /** - * Output only. The host that the task is sent to. The host is constructed - * from the domain name of the app associated with the queue's project - * ID (for example <app-id>.appspot.com), and the service, version, - * and instance. Tasks which were created using the App Engine SDK might - * have a custom domain name. For more information, see [How Requests are - * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). + * Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example <app-id>.appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). */ host?: string; /** - * App instance. By default, the task is sent to an instance which is - * available when the task is attempted. Requests can only be sent to a - * specific instance if [manual scaling is used in App Engine - * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). - * App Engine Flex does not support instances. For more information, see - * [App Engine Standard request - * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - * and [App Engine Flex request - * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + * App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). */ instance?: string; /** - * App service. By default, the task is sent to the service which is the - * default service when the task is attempted. For some queues or tasks - * which were created using the App Engine Task Queue API, host is not - * parsable into service, version, and instance. For example, some tasks - * which were created using the App Engine SDK use a custom domain name; - * custom domains are not parsed by Cloud Tasks. If host is not parsable, - * then service, version, and instance are the empty string. + * App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ service?: string; /** - * App version. By default, the task is sent to the version which is the - * default version when the task is attempted. For some queues or tasks - * which were created using the App Engine Task Queue API, host is not - * parsable into service, version, and instance. For example, some tasks - * which were created using the App Engine SDK use a custom domain name; - * custom domains are not parsed by Cloud Tasks. If host is not parsable, - * then service, version, and instance are the empty string. + * App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. */ version?: string; } @@ -293,24 +177,19 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Attempt { /** - * Output only. The time that this attempt was dispatched. `dispatch_time` - * will be truncated to the nearest microsecond. + * Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. */ dispatchTime?: string; /** - * Output only. The response from the worker for this attempt. If - * `response_time` is unset, then the task has not been attempted or is - * currently running and the `response_status` field is meaningless. + * Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless. */ responseStatus?: Schema$Status; /** - * Output only. The time that this attempt response was received. - * `response_time` will be truncated to the nearest microsecond. + * Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. */ responseTime?: string; /** - * Output only. The time that this attempt was scheduled. `schedule_time` - * will be truncated to the nearest microsecond. + * Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */ scheduleTime?: string; } @@ -319,30 +198,15 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -351,75 +215,36 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$CreateTaskRequest { /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; /** - * Required. The task to add. Task names have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. - * The user can optionally specify a task name. If a name is not specified - * then the system will generate a random unique task id, which will be set - * in the task returned in the response. If schedule_time is not set or is - * in the past then Cloud Tasks will set it to the current time. Task - * De-duplication: Explicitly specifying a task ID enables task - * de-duplication. If a task's ID is identical to that of an existing - * task or a task that was deleted or executed recently then the call will - * fail with ALREADY_EXISTS. If the task's queue was created using Cloud - * Tasks, then another task with the same name can't be created for - * ~1hour after the original task was deleted or executed. If the task's - * queue was created using queue.yaml or queue.xml, then another task with - * the same name can't be created for ~9days after the original task was - * deleted or executed. Because there is an extra lookup cost to identify - * duplicate task names, these CreateTask calls have significantly increased - * latency. Using hashed strings for the task id or for the prefix of the - * task id is recommended. Choosing task ids that are sequential or have - * sequential prefixes, for example using a timestamp, causes an increase in - * latency and error rates in all task commands. The infrastructure relies - * on an approximately uniform distribution of task ids to store and serve - * tasks efficiently. + * Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. */ task?: Schema$Task; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -445,10 +270,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$ListQueuesResponse { /** - * A token to retrieve next page of results. To return the next page of - * results, call ListQueues with this value as the page_token. If the - * next_page_token is empty, there are no more results. The page token is - * valid for only 2 hours. + * A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours. */ nextPageToken?: string; /** @@ -461,9 +283,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$ListTasksResponse { /** - * A token to retrieve next page of results. To return the next page of - * results, call ListTasks with this value as the page_token. If the - * next_page_token is empty, there are no more results. + * A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. */ nextPageToken?: string; /** @@ -476,13 +296,11 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -490,13 +308,11 @@ export namespace cloudtasks_v2beta3 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -505,41 +321,15 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -552,9 +342,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$PurgeQueueRequest {} /** - * A queue is a container of related tasks. Queues are configured to manage - * how those tasks are dispatched. Configurable properties include rate - * limits, retry options, queue types, and others. + * A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others. */ export interface Schema$Queue { /** @@ -562,110 +350,40 @@ export namespace cloudtasks_v2beta3 { */ appEngineHttpQueue?: Schema$AppEngineHttpQueue; /** - * Caller-specified and required in CreateQueue, after which it becomes - * output only. The queue name. The queue name must have the following - * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * - * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the queue's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. + * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ name?: string; /** - * Output only. The last time this queue was purged. All tasks that were - * created before this time were purged. A queue can be purged using - * PurgeQueue, the [App Engine Task Queue SDK, or the Cloud - * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). - * Purge time will be truncated to the nearest microsecond. Purge time will - * be unset if the queue has never been purged. + * Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. */ purgeTime?: string; /** - * Rate limits for task dispatches. rate_limits and retry_config are - * related because they both control task attempts. However they control - * task attempts in different ways: * rate_limits controls the total rate - * of dispatches from a queue (i.e. all traffic dispatched from the queue, - * regardless of whether the dispatch is from a first attempt or a retry). - * * retry_config controls what happens to particular a task after its - * first attempt fails. That is, retry_config controls task retries (the - * second attempt, third attempt, etc). The queue's actual dispatch - * rate is the result of: * Number of tasks in the queue * User-specified - * throttling: rate_limits, retry_config, and the queue's state. * - * System throttling due to `429` (Too Many Requests) or `503` (Service - * Unavailable) responses from the worker, high error rates, or to smooth - * sudden large traffic spikes. + * Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. */ rateLimits?: Schema$RateLimits; /** - * Settings that determine the retry behavior. * For tasks created using - * Cloud Tasks: the queue-level retry settings apply to all tasks in the - * queue that were created using Cloud Tasks. Retry settings cannot be set - * on individual tasks. * For tasks created using the App Engine SDK: the - * queue-level retry settings apply to all tasks in the queue which do not - * have retry settings explicitly set on the task and were created by the - * App Engine SDK. See [App Engine - * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + * Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). */ retryConfig?: Schema$RetryConfig; /** - * Output only. The state of the queue. `state` can only be changed by - * called PauseQueue, ResumeQueue, or uploading - * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). - * UpdateQueue cannot be used to change `state`. + * Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */ state?: string; } /** - * Rate limits. This message determines the maximum rate that tasks can be - * dispatched by a queue, regardless of whether the dispatch is a first task - * attempt or a retry. Note: The debugging command, RunTask, will run a task - * even if the queue has reached its RateLimits. + * Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. */ export interface Schema$RateLimits { /** - * Output only. The max burst size. Max burst size limits how fast tasks in - * queue are processed when many tasks are in the queue and the rate is - * high. This field allows the queue to have a high rate so processing - * starts shortly after a task is enqueued, but still limits resource usage - * when many tasks are enqueued in a short period of time. The [token - * bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to - * control the rate of task dispatches. Each queue has a token bucket that - * holds tokens, up to the maximum specified by `max_burst_size`. Each time - * a task is dispatched, a token is removed from the bucket. Tasks will be - * dispatched until the queue's bucket runs out of tokens. The bucket - * will be continuously refilled with new tokens based on - * max_dispatches_per_second. Cloud Tasks will pick the value of - * `max_burst_size` based on the value of max_dispatches_per_second. For - * App Engine queues that were created or updated using `queue.yaml/xml`, - * `max_burst_size` is equal to - * [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). - * Since `max_burst_size` is output only, if UpdateQueue is called on a - * queue created by `queue.yaml/xml`, `max_burst_size` will be reset based - * on the value of max_dispatches_per_second, regardless of whether - * max_dispatches_per_second is updated. + * Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. */ maxBurstSize?: number; /** - * The maximum number of concurrent tasks that Cloud Tasks allows to be - * dispatched for this queue. After this threshold has been reached, Cloud - * Tasks stops dispatching tasks until the number of concurrent requests - * decreases. If unspecified when the queue is created, Cloud Tasks will - * pick the default. The maximum allowed value is 5,000. This field has - * the same meaning as [max_concurrent_requests in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). + * The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). */ maxConcurrentDispatches?: number; /** - * The maximum rate at which tasks are dispatched from this queue. If - * unspecified when the queue is created, Cloud Tasks will pick the default. - * * For App Engine queues, the maximum allowed value is 500. This field - * has the same meaning as [rate in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + * The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). */ maxDispatchesPerSecond?: number; } @@ -674,66 +392,27 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$ResumeQueueRequest {} /** - * Retry config. These settings determine when a failed task attempt is - * retried. + * Retry config. These settings determine when a failed task attempt is retried. */ export interface Schema$RetryConfig { /** - * Number of attempts per task. Cloud Tasks will attempt the task - * `max_attempts` times (that is, if the first attempt fails, then there - * will be `max_attempts - 1` retries). Must be >= -1. If unspecified - * when the queue is created, Cloud Tasks will pick the default. -1 - * indicates unlimited attempts. This field has the same meaning as - * [task_retry_limit in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxAttempts?: number; /** - * A task will be scheduled for retry between min_backoff and max_backoff - * duration after it fails, if the queue's RetryConfig specifies that - * the task should be retried. If unspecified when the queue is created, - * Cloud Tasks will pick the default. `max_backoff` will be truncated to - * the nearest second. This field has the same meaning as - * [max_backoff_seconds in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxBackoff?: string; /** - * The time between retries will double `max_doublings` times. A task's - * retry interval starts at min_backoff, then doubles `max_doublings` times, - * then increases linearly, and finally retries retries at intervals of - * max_backoff up to max_attempts times. For example, if min_backoff is - * 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will - * first be retried in 10s. The retry interval will double three times, and - * then increase linearly by 2^3 * 10s. Finally, the task will retry at - * intervals of max_backoff until the task has been attempted max_attempts - * times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, - * 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks - * will pick the default. This field has the same meaning as - * [max_doublings in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxDoublings?: number; /** - * If positive, `max_retry_duration` specifies the time limit for retrying a - * failed task, measured from when the task was first attempted. Once - * `max_retry_duration` time has passed *and* the task has been attempted - * max_attempts times, no further attempts will be made and the task will be - * deleted. If zero, then the task age is unlimited. If unspecified when - * the queue is created, Cloud Tasks will pick the default. - * `max_retry_duration` will be truncated to the nearest second. This field - * has the same meaning as [task_age_limit in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxRetryDuration?: string; /** - * A task will be scheduled for retry between min_backoff and max_backoff - * duration after it fails, if the queue's RetryConfig specifies that - * the task should be retried. If unspecified when the queue is created, - * Cloud Tasks will pick the default. `min_backoff` will be truncated to - * the nearest second. This field has the same meaning as - * [min_backoff_seconds in - * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ minBackoff?: string; } @@ -742,13 +421,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$RunTaskRequest { /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -757,48 +430,12 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -806,14 +443,11 @@ export namespace cloudtasks_v2beta3 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -822,49 +456,23 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Task { /** - * HTTP request that is sent to the App Engine app handler. An App Engine - * task is a task that has AppEngineHttpRequest set. + * HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set. */ appEngineHttpRequest?: Schema$AppEngineHttpRequest; /** - * Output only. The time that the task was created. `create_time` will be - * truncated to the nearest second. + * Output only. The time that the task was created. `create_time` will be truncated to the nearest second. */ createTime?: string; /** - * Output only. The number of attempts dispatched. This count includes - * attempts which have been dispatched but haven't received a response. + * Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. */ dispatchCount?: number; /** - * The deadline for requests sent to the worker. If the worker does not - * respond by this deadline then the request is cancelled and the attempt is - * marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task - * according to the RetryConfig. Note that when the request is cancelled, - * Cloud Tasks will stop listing for the response, but whether the worker - * stops processing depends on the worker. For example, if the worker is - * stuck, it may not react to cancelled requests. The default and maximum - * values depend on the type of request: * For App Engine tasks, 0 - * indicates that the request has the default deadline. The default - * deadline depends on the [scaling - * type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) - * of the service: 10 minutes for standard apps with automatic scaling, 24 - * hours for standard apps with manual and basic scaling, and 60 minutes for - * flex apps. If the request deadline is set, it must be in the interval [15 - * seconds, 24 hours 15 seconds]. Regardless of the task's - * `dispatch_deadline`, the app handler will not run for longer than than - * the service's timeout. We recommend setting the `dispatch_deadline` - * to at most a few seconds more than the app handler's timeout. For - * more information see - * [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). - * `dispatch_deadline` will be truncated to the nearest millisecond. The - * deadline is an approximate deadline. + * The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. */ dispatchDeadline?: string; /** - * Output only. The status of the task's first attempt. Only - * dispatch_time will be set. The other Attempt information is not retained - * by Cloud Tasks. + * Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks. */ firstAttempt?: Schema$Attempt; /** @@ -872,20 +480,7 @@ export namespace cloudtasks_v2beta3 { */ lastAttempt?: Schema$Attempt; /** - * Optionally caller-specified in CreateTask. The task name. The task name - * must have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the task's location. The - * list of available locations can be obtained by calling ListLocations. - * For more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. * `TASK_ID` can contain only - * letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). - * The maximum length is 500 characters. + * Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** @@ -893,14 +488,11 @@ export namespace cloudtasks_v2beta3 { */ responseCount?: number; /** - * The time when the task is scheduled to be attempted. For App Engine - * queues, this is when the task will be attempted or retried. - * `schedule_time` will be truncated to the nearest microsecond. + * The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. */ scheduleTime?: string; /** - * Output only. The view specifies which subset of the Task has been - * returned. + * Output only. The view specifies which subset of the Task has been returned. */ view?: string; } @@ -909,10 +501,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -921,8 +510,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1140,14 +728,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.create - * @desc Creates a queue. Queues created with this method allow tasks to - * live for a maximum of 31 days. After a task is 31 days old, the task will - * be deleted regardless of whether it was dispatched or not. WARNING: - * Using this method may have unintended side effects if you are using an - * App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read - * [Overview of Queue Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @alias cloudtasks.projects.locations.queues.create * @memberOf! () * @@ -1220,14 +801,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.delete - * @desc Deletes a queue. This command will delete the queue even if it has - * tasks in it. Note: If you delete a queue, a queue with the same name - * can't be created for 7 days. WARNING: Using this method may have - * unintended side effects if you are using an App Engine `queue.yaml` or - * `queue.xml` file to manage your queues. Read [Overview of Queue - * Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @alias cloudtasks.projects.locations.queues.delete * @memberOf! () * @@ -1365,11 +939,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.getIamPolicy - * @desc Gets the access control policy for a Queue. Returns an empty policy - * if the resource exists and does not have a policy set. Authorization - * requires the following [Google IAM](https://cloud.google.com/iam) - * permission on the specified resource parent: * - * `cloudtasks.queues.getIamPolicy` + * @desc Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` * @alias cloudtasks.projects.locations.queues.getIamPolicy * @memberOf! () * @@ -1519,15 +1089,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.patch - * @desc Updates a queue. This method creates the queue if it does not - * exist and updates the queue if it does exist. Queues created with this - * method allow tasks to live for a maximum of 31 days. After a task is 31 - * days old, the task will be deleted regardless of whether it was - * dispatched or not. WARNING: Using this method may have unintended side - * effects if you are using an App Engine `queue.yaml` or `queue.xml` file - * to manage your queues. Read [Overview of Queue Management and - * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - * this method. + * @desc Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. * @alias cloudtasks.projects.locations.queues.patch * @memberOf! () * @@ -1598,10 +1160,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.pause - * @desc Pauses the queue. If a queue is paused then the system will stop - * dispatching tasks until the queue is resumed via ResumeQueue. Tasks can - * still be added when the queue is paused. A queue is paused if its state - * is PAUSED. + * @desc Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. * @alias cloudtasks.projects.locations.queues.pause * @memberOf! () * @@ -1674,10 +1233,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.purge - * @desc Purges a queue by deleting all of its tasks. All tasks created - * before this method is called are permanently deleted. Purge operations - * can take up to one minute to take effect. Tasks might be dispatched - * before the purge takes effect. A purge is irreversible. + * @desc Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. * @alias cloudtasks.projects.locations.queues.purge * @memberOf! () * @@ -1750,13 +1306,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.resume - * @desc Resume a queue. This method resumes a queue after it has been - * PAUSED or DISABLED. The state of a queue is stored in the queue's state; - * after calling this method it will be set to RUNNING. WARNING: Resuming - * many high-QPS queues at the same time can lead to target overloading. If - * you are resuming high-QPS queues, follow the 500/50/5 pattern described - * in [Managing Cloud Tasks Scaling - * Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). + * @desc Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). * @alias cloudtasks.projects.locations.queues.resume * @memberOf! () * @@ -1829,12 +1379,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.setIamPolicy - * @desc Sets the access control policy for a Queue. Replaces any existing - * policy. Note: The Cloud Console does not check queue-level IAM - * permissions yet. Project-level permissions are required to use the Cloud - * Console. Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission on the specified resource - * parent: * `cloudtasks.queues.setIamPolicy` + * @desc Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` * @alias cloudtasks.projects.locations.queues.setIamPolicy * @memberOf! () * @@ -1907,11 +1452,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.testIamPermissions - * @desc Returns permissions that a caller has on a Queue. If the resource - * does not exist, this will return an empty set of permissions, not a - * NOT_FOUND error. Note: This operation is designed to be used for - * building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias cloudtasks.projects.locations.queues.testIamPermissions * @memberOf! () * @@ -2000,10 +1541,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The location name in which the queue will be created. For - * example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed - * locations can be obtained by calling Cloud Tasks' implementation of - * ListLocations. + * Required. The location name in which the queue will be created. For example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations. */ parent?: string; @@ -2020,8 +1558,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ name?: string; } @@ -2033,8 +1570,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the queue. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The resource name of the queue. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ name?: string; } @@ -2046,8 +1582,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2064,33 +1599,19 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * `filter` can be used to specify a subset of queues. Any Queue field can - * be used as a filter and several operators as supported. For example: `<=, - * <, >=, >, !=, =, :`. The filter syntax is the same as described in - * [Stackdriver's Advanced Logs - * Filters](https://cloud.google.com/logging/docs/view/advanced_filters). - * Sample filter "state: PAUSED". Note that using filters might cause fewer - * queues than the requested page_size to be returned. + * `filter` can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as described in [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters). Sample filter "state: PAUSED". Note that using filters might cause fewer queues than the requested page_size to be returned. */ filter?: string; /** - * Requested page size. The maximum page size is 9800. If unspecified, the - * page size will be the maximum. Fewer queues than requested might be - * returned, even if more queues exist; use the next_page_token in the - * response to determine if more queues exist. + * Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist. */ pageSize?: number; /** - * A token identifying the page of results to return. To request the first - * page results, page_token must be empty. To request the next page of - * results, page_token must be the value of next_page_token returned from - * the previous call to ListQueues method. It is an error to switch the - * value of the filter while iterating through pages. + * A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages. */ pageToken?: string; /** - * Required. The location name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID` + * Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID` */ parent?: string; } @@ -2102,23 +1623,11 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Caller-specified and required in CreateQueue, after which it becomes - * output only. The queue name. The queue name must have the following - * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * - * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens - * (-), colons (:), or periods (.). For more information, see - * [Identifying - * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) - * * `LOCATION_ID` is the canonical ID for the queue's location. The list - * of available locations can be obtained by calling ListLocations. For - * more information, see https://cloud.google.com/about/locations/. * - * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. + * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. */ name?: string; /** - * A mask used to specify which fields of the queue are being updated. If - * empty, then all fields will be updated. + * A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. */ updateMask?: string; @@ -2135,8 +1644,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -2153,8 +1661,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -2171,8 +1678,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */ name?: string; @@ -2189,8 +1695,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2207,8 +1712,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2226,9 +1730,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.create - * @desc Creates a task and adds it to a queue. Tasks cannot be updated - * after creation; there is no UpdateTask command. * For App Engine queues, - * the maximum task size is 100KB. + * @desc Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. * @alias cloudtasks.projects.locations.queues.tasks.create * @memberOf! () * @@ -2301,9 +1803,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.delete - * @desc Deletes a task. A task can be deleted if it is scheduled or - * dispatched. A task cannot be deleted if it has executed successfully or - * permanently failed. + * @desc Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed. * @alias cloudtasks.projects.locations.queues.tasks.delete * @memberOf! () * @@ -2442,10 +1942,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.list - * @desc Lists the tasks in a queue. By default, only the BASIC view is - * retrieved due to performance considerations; response_view controls the - * subset of information which is returned. The tasks may be returned in - * any order. The ordering may change at any time. + * @desc Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. * @alias cloudtasks.projects.locations.queues.tasks.list * @memberOf! () * @@ -2522,19 +2019,7 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.run - * @desc Forces a task to run now. When this method is called, Cloud Tasks - * will dispatch the task, even if the task is already running, the queue - * has reached its RateLimits or is PAUSED. This command is meant to be - * used for manual debugging. For example, RunTask can be used to retry a - * failed task after a fix has been made or to manually force a task to be - * dispatched now. The dispatched task is returned. That is, the task that - * is returned contains the status after the task is dispatched but before - * the task is received by its target. If Cloud Tasks receives a successful - * response from the task's target, then the task will be deleted; otherwise - * the task's schedule_time will be reset to the time that RunTask was - * called plus the retry delay specified in the queue's RetryConfig. RunTask - * returns NOT_FOUND when it is called on a task that has already succeeded - * or permanently failed. + * @desc Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. * @alias cloudtasks.projects.locations.queues.tasks.run * @memberOf! () * @@ -2614,9 +2099,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue - * must already exist. + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */ parent?: string; @@ -2633,8 +2116,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; } @@ -2646,18 +2128,11 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -2669,34 +2144,19 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. Fewer tasks than requested might be returned. The - * maximum page size is 1000. If unspecified, the page size will be the - * maximum. Fewer tasks than requested might be returned, even if more tasks - * exist; use next_page_token in the response to determine if more tasks - * exist. + * Requested page size. Fewer tasks than requested might be returned. The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. */ pageSize?: number; /** - * A token identifying the page of results to return. To request the first - * page results, page_token must be empty. To request the next page of - * results, page_token must be the value of next_page_token returned from - * the previous call to ListTasks method. The page token is valid for only - * 2 hours. + * A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours. */ pageToken?: string; /** - * Required. The queue name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */ parent?: string; /** - * The response_view specifies which subset of the Task will be returned. By - * default response_view is BASIC; not all information is retrieved by - * default because some data, such as payloads, might be desirable to return - * only when needed because of its large size or because of the sensitivity - * of data that it contains. Authorization for FULL requires - * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - * permission on the Task resource. + * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */ responseView?: string; } @@ -2708,8 +2168,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The task name. For example: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */ name?: string; diff --git a/src/apis/cloudtrace/package.json b/src/apis/cloudtrace/package.json index 01bd6a07abf..5d27d0d820b 100644 --- a/src/apis/cloudtrace/package.json +++ b/src/apis/cloudtrace/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index 26089bbe0f2..c8487d32b47 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudtrace_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudtrace_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,11 +91,7 @@ export namespace cloudtrace_v1 { /** * Stackdriver Trace API * - * Sends application trace data to Stackdriver Trace for viewing. Trace data - * is collected for all App Engine applications by default. Trace data from - * other applications can be provided using this API. This library is used to - * interact with the Trace API directly. If you are looking to instrument your - * application for Stackdriver Trace, we recommend using OpenCensus. + * Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus. * * @example * const {google} = require('googleapis'); @@ -116,18 +108,17 @@ export namespace cloudtrace_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -135,9 +126,7 @@ export namespace cloudtrace_v1 { */ export interface Schema$ListTracesResponse { /** - * If defined, indicates that there are more traces that match the request - * and that this value should be passed to the next request to continue - * retrieving additional traces. + * If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces. */ nextPageToken?: string; /** @@ -146,9 +135,7 @@ export namespace cloudtrace_v1 { traces?: Schema$Trace[]; } /** - * A trace describes how long it takes for an application to perform an - * operation. It consists of a set of spans, each of which represent a single - * timed event within the operation. + * A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation. */ export interface Schema$Trace { /** @@ -160,9 +147,7 @@ export namespace cloudtrace_v1 { */ spans?: Schema$TraceSpan[]; /** - * Globally unique identifier for the trace. This identifier is a 128-bit - * numeric value formatted as a 32-byte hex string. For example, - * `382d4f4c6b7bb2f4a972559d9085001d`. + * Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. */ traceId?: string; } @@ -176,11 +161,7 @@ export namespace cloudtrace_v1 { traces?: Schema$Trace[]; } /** - * A span represents a single timed event within a trace. Spans can be nested - * and form a trace tree. Often, a trace contains a root span that describes - * the end-to-end latency of an operation and, optionally, one or more - * subspans for its suboperations. Spans do not need to be contiguous. There - * may be gaps between spans in a trace. + * A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. */ export interface Schema$TraceSpan { /** @@ -188,36 +169,15 @@ export namespace cloudtrace_v1 { */ endTime?: string; /** - * Distinguishes between spans generated in a particular context. For - * example, two spans with the same name may be distinguished using - * `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated - * with the span. + * Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. */ kind?: string; /** - * Collection of labels associated with the span. Label keys must be less - * than 128 bytes. Label values must be less than 16 kilobytes (10MB for - * `/stacktrace` values). Some predefined label keys exist, or you may - * create your own. When creating your own, we recommend the following - * formats: * `/category/product/key` for agents of well-known products - * (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for - * domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels - * include: * `/agent` * `/component` * `/error/message` * - * `/error/name` * `/http/client_city` * `/http/client_country` * - * `/http/client_protocol` * `/http/client_region` * `/http/host` * - * `/http/method` * `/http/path` * `/http/redirected_url` * - * `/http/request/size` * `/http/response/size` * `/http/route` * - * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * - * `/stacktrace` * `/tid` + * Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace` values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: * `/category/product/key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels include: * `/agent` * `/component` * `/error/message` * `/error/name` * `/http/client_city` * `/http/client_country` * `/http/client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * `/stacktrace` * `/tid` */ labels?: {[key: string]: string}; /** - * Name of the span. Must be less than 128 bytes. The span name is sanitized - * and displayed in the Stackdriver Trace tool in the Google Cloud Platform - * Console. The name may be a method name or some other per-call site name. - * For the same executable and the same call point, a best practice is to - * use a consistent name, which makes it easier to correlate cross-trace - * spans. + * Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. */ name?: string; /** @@ -225,8 +185,7 @@ export namespace cloudtrace_v1 { */ parentSpanId?: string; /** - * Identifier for the span. Must be a 64-bit integer other than 0 and unique - * within a trace. For example, `2205310701640571284`. + * Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. */ spanId?: string; /** @@ -245,25 +204,19 @@ export namespace cloudtrace_v1 { /** * cloudtrace.projects.patchTraces - * @desc Sends new traces to Stackdriver Trace or updates existing traces. - * If the ID of a trace that you send matches that of an existing trace, any - * fields in the existing trace and its spans are overwritten by the - * provided values, and any new fields provided are merged with the existing - * trace data. If the ID does not match, a new trace is created. + * @desc Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Stackdriver Trace API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtrace - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -276,8 +229,7 @@ export namespace cloudtrace_v1 { * projectId: 'my-project-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -298,10 +250,9 @@ export namespace cloudtrace_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -410,14 +361,12 @@ export namespace cloudtrace_v1 { * // 1. If not already done, enable the Stackdriver Trace API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtrace - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -452,10 +401,9 @@ export namespace cloudtrace_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -531,22 +479,19 @@ export namespace cloudtrace_v1 { /** * cloudtrace.projects.traces.list - * @desc Returns of a list of traces that match the specified filter - * conditions. + * @desc Returns of a list of traces that match the specified filter conditions. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Stackdriver Trace API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudtrace - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -572,8 +517,8 @@ export namespace cloudtrace_v1 { * return; * } * for (var i = 0; i < tracesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `tracesPage`: console.log(JSON.stringify(tracesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `tracesPage`: + * console.log(JSON.stringify(tracesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -591,10 +536,9 @@ export namespace cloudtrace_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -702,53 +646,23 @@ export namespace cloudtrace_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * End of the time interval (inclusive) during which the trace data was - * collected from the application. + * End of the time interval (inclusive) during which the trace data was collected from the application. */ endTime?: string; /** - * An optional filter against labels for the request. By default, searches - * use prefix matching. To specify exact match, prepend a plus symbol (`+`) - * to the search term. Multiple terms are ANDed. Syntax: * - * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span - * starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces - * where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: - * Return traces where any span starts with `NAME_PREFIX`. * - * `+span:NAME`: Return traces where any span's name is exactly `NAME`. - * * `latency:DURATION`: Return traces whose overall latency is greater or - * equal to than `DURATION`. Accepted units are nanoseconds (`ns`), - * milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, - * `latency:24ms` returns traces whose overall latency is greater than - * or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces - * containing the specified label key (exact match, case-sensitive) - * regardless of the key:value pair's value (including empty values). * - * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified - * label key (exact match, case-sensitive) whose value starts with - * `VALUE_PREFIX`. Both a key and a value must be specified. * - * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly - * matching the specified text. Both a key and a value must be specified. * - * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: - * Equivalent to `/http/url:VALUE`. + * An optional filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose overall latency is greater than or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with `VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`. */ filter?: string; /** - * Field used to sort the returned traces. Optional. Can be one of the - * following: * `trace_id` * `name` (`name` field of root span in the - * trace) * `duration` (difference between `end_time` and `start_time` - * fields of the root span) * `start` (`start_time` field of the root - * span) Descending order can be specified by appending `desc` to the sort - * field (for example, `name desc`). Only one sort field is permitted. + * Field used to sort the returned traces. Optional. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted. */ orderBy?: string; /** - * Maximum number of traces to return. If not specified or <= 0, the - * implementation selects a reasonable value. The implementation may return - * fewer traces than the requested page size. Optional. + * Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional. */ pageSize?: number; /** - * Token identifying the page of results to return. If provided, use the - * value of the `next_page_token` field from a previous request. Optional. + * Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. Optional. */ pageToken?: string; /** @@ -756,13 +670,11 @@ export namespace cloudtrace_v1 { */ projectId?: string; /** - * Start of the time interval (inclusive) during which the trace data was - * collected from the application. + * Start of the time interval (inclusive) during which the trace data was collected from the application. */ startTime?: string; /** - * Type of data returned for traces in the list. Optional. Default is - * `MINIMAL`. + * Type of data returned for traces in the list. Optional. Default is `MINIMAL`. */ view?: string; } diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 4e9b7d3ac04..2fe4458687a 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace cloudtrace_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace cloudtrace_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,11 +91,7 @@ export namespace cloudtrace_v2 { /** * Stackdriver Trace API * - * Sends application trace data to Stackdriver Trace for viewing. Trace data - * is collected for all App Engine applications by default. Trace data from - * other applications can be provided using this API. This library is used to - * interact with the Trace API directly. If you are looking to instrument your - * application for Stackdriver Trace, we recommend using OpenCensus. + * Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus. * * @example * const {google} = require('googleapis'); @@ -116,7 +108,10 @@ export namespace cloudtrace_v2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -127,13 +122,11 @@ export namespace cloudtrace_v2 { */ export interface Schema$Annotation { /** - * A set of attributes on the annotation. You can have up to 4 attributes - * per Annotation. + * A set of attributes on the annotation. You can have up to 4 attributes per Annotation. */ attributes?: Schema$Attributes; /** - * A user-supplied message describing the event. The maximum length for the - * description is 256 bytes. + * A user-supplied message describing the event. The maximum length for the description is 256 bytes. */ description?: Schema$TruncatableString; } @@ -142,19 +135,11 @@ export namespace cloudtrace_v2 { */ export interface Schema$Attributes { /** - * The set of attributes. Each attribute's key can be up to 128 bytes - * long. The value can be a string up to 256 bytes, a signed 64-bit integer, - * or the Boolean values `true` and `false`. For example: - * "/instance_id": "my-instance" - * "/http/user_agent": "" - * "/http/request_bytes": 300 "abc.com/myattribute": - * true + * The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true */ attributeMap?: {[key: string]: Schema$AttributeValue}; /** - * The number of attributes that were discarded. Attributes can be discarded - * because their keys are too long or because there are too many attributes. - * If this value is 0 then all attributes are valid. + * The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. */ droppedAttributesCount?: number; } @@ -180,29 +165,20 @@ export namespace cloudtrace_v2 { */ export interface Schema$BatchWriteSpansRequest { /** - * A list of new spans. The span names must not match existing spans, or the - * results are undefined. + * A list of new spans. The span names must not match existing spans, or the results are undefined. */ spans?: Schema$Span[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A pointer from the current span to another span in the same trace or in a - * different trace. For example, this can be used in batching operations, - * where a single batch handler processes multiple requests from different - * traces or when the handler receives a request from a different project. + * A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project. */ export interface Schema$Link { /** - * A set of attributes on the link. You have have up to 32 attributes per - * link. + * A set of attributes on the link. You have have up to 32 attributes per link. */ attributes?: Schema$Attributes; /** @@ -219,13 +195,11 @@ export namespace cloudtrace_v2 { type?: string; } /** - * A collection of links, which are references from this span to a span in the - * same or different trace. + * A collection of links, which are references from this span to a span in the same or different trace. */ export interface Schema$Links { /** - * The number of dropped links after the maximum size was enforced. If this - * value is 0, then no links were dropped. + * The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped. */ droppedLinksCount?: number; /** @@ -238,14 +212,11 @@ export namespace cloudtrace_v2 { */ export interface Schema$MessageEvent { /** - * The number of compressed bytes sent or received. If missing assumed to be - * the same size as uncompressed. + * The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed. */ compressedSizeBytes?: string; /** - * An identifier for the MessageEvent's message that can be used to - * match SENT and RECEIVED MessageEvents. It is recommended to be unique - * within a Span. + * An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span. */ id?: string; /** @@ -262,48 +233,32 @@ export namespace cloudtrace_v2 { */ export interface Schema$Module { /** - * A unique identifier for the module, usually a hash of its contents (up to - * 128 bytes). + * A unique identifier for the module, usually a hash of its contents (up to 128 bytes). */ buildId?: Schema$TruncatableString; /** - * For example: main binary, kernel modules, and dynamic libraries such as - * libc.so, sharedlib.so (up to 256 bytes). + * For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes). */ module?: Schema$TruncatableString; } /** - * A span represents a single operation within a trace. Spans can be nested to - * form a trace tree. Often, a trace contains a root span that describes the - * end-to-end latency, and one or more subspans for its sub-operations. A - * trace can also contain multiple root spans, or none at all. Spans do not - * need to be contiguous&mdash;there may be gaps or overlaps between spans - * in a trace. + * A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous&mdash;there may be gaps or overlaps between spans in a trace. */ export interface Schema$Span { /** - * A set of attributes on the span. You can have up to 32 attributes per - * span. + * A set of attributes on the span. You can have up to 32 attributes per span. */ attributes?: Schema$Attributes; /** - * An optional number of child spans that were generated while this span was - * active. If set, allows implementation to detect missing child spans. + * An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. */ childSpanCount?: number; /** - * A description of the span's operation (up to 128 bytes). Stackdriver - * Trace displays the description in the Google Cloud Platform Console. For - * example, the display name can be a qualified method name or a file name - * and a line number where the operation is called. A best practice is to - * use the same display name within an application and at the same call - * point. This makes it easier to correlate spans in different traces. + * A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. */ displayName?: Schema$TruncatableString; /** - * The end time of the span. On the client side, this is the time kept by - * the local machine where the span execution ends. On the server side, this - * is the time when the server application handler stops running. + * The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. */ endTime?: string; /** @@ -311,23 +266,15 @@ export namespace cloudtrace_v2 { */ links?: Schema$Links; /** - * The resource name of the span in the following format: - * projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique - * identifier for a trace within a project; it is a 32-character hexadecimal - * encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span - * within a trace; it is a 16-character hexadecimal encoding of an 8-byte - * array. + * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ name?: string; /** - * The [SPAN_ID] of this span's parent span. If this is a root span, - * then this field must be empty. + * The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. */ parentSpanId?: string; /** - * (Optional) Set this parameter to indicate whether this span is in the - * same process as its parent. If you do not set this parameter, Stackdriver - * Trace is unable to take advantage of this helpful information. + * (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information. */ sameProcessAsParentSpan?: boolean; /** @@ -339,10 +286,7 @@ export namespace cloudtrace_v2 { */ stackTrace?: Schema$StackTrace; /** - * The start time of the span. On the client side, this is the time kept by - * the local machine where the span execution starts. On the server side, - * this is the time when the server's application handler starts - * running. + * The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. */ startTime?: string; /** @@ -350,8 +294,7 @@ export namespace cloudtrace_v2 { */ status?: Schema$Status; /** - * A set of time events. You can have up to 32 annotations and 128 message - * events per span. + * A set of time events. You can have up to 32 annotations and 128 message events per span. */ timeEvents?: Schema$TimeEvents; } @@ -360,18 +303,15 @@ export namespace cloudtrace_v2 { */ export interface Schema$StackFrame { /** - * The column number where the function call appears, if available. This is - * important in JavaScript because of its anonymous functions. + * The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions. */ columnNumber?: string; /** - * The name of the source file where the function call appears (up to 256 - * bytes). + * The name of the source file where the function call appears (up to 256 bytes). */ fileName?: Schema$TruncatableString; /** - * The fully-qualified name that uniquely identifies the function or method - * that is active in this frame (up to 1024 bytes). + * The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes). */ functionName?: Schema$TruncatableString; /** @@ -383,9 +323,7 @@ export namespace cloudtrace_v2 { */ loadModule?: Schema$Module; /** - * An un-mangled function name, if `function_name` is - * [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can - * be fully-qualified (up to 1024 bytes). + * An un-mangled function name, if `function_name` is [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can be fully-qualified (up to 1024 bytes). */ originalFunctionName?: Schema$TruncatableString; /** @@ -398,8 +336,7 @@ export namespace cloudtrace_v2 { */ export interface Schema$StackFrames { /** - * The number of stack frames that were dropped because there were too many - * stack frames. If this value is 0, then no stack frames were dropped. + * The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped. */ droppedFramesCount?: number; /** @@ -416,50 +353,12 @@ export namespace cloudtrace_v2 { */ stackFrames?: Schema$StackFrames; /** - * The hash ID is used to conserve network bandwidth for duplicate stack - * traces within a single trace. Often multiple spans will have identical - * stack traces. The first occurrence of a stack trace should contain both - * the `stackFrame` content and a value in `stackTraceHashId`. Subsequent - * spans within the same request can refer to that stack trace by only - * setting `stackTraceHashId`. + * The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`. */ stackTraceHashId?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -467,14 +366,11 @@ export namespace cloudtrace_v2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -496,19 +392,15 @@ export namespace cloudtrace_v2 { time?: string; } /** - * A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on - * the span, consisting of either user-supplied key:value pairs, or details of - * a message sent/received between Spans. + * A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. */ export interface Schema$TimeEvents { /** - * The number of dropped annotations in all the included time events. If the - * value is 0, then no annotations were dropped. + * The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. */ droppedAnnotationsCount?: number; /** - * The number of dropped message events in all the included time events. If - * the value is 0, then no message events were dropped. + * The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. */ droppedMessageEventsCount?: number; /** @@ -521,17 +413,11 @@ export namespace cloudtrace_v2 { */ export interface Schema$TruncatableString { /** - * The number of bytes removed from the original string. If this value is 0, - * then the string was not shortened. + * The number of bytes removed from the original string. If this value is 0, then the string was not shortened. */ truncatedByteCount?: number; /** - * The shortened string. For example, if the original string is 500 bytes - * long and the limit of the string is 128 bytes, then `value` contains the - * first 128 bytes of the 500-byte string. Truncation always happens on a - * UTF8 character boundary. If there are multi-byte characters in the - * string, then the length of the shortened string might be less than the - * size limit. + * The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. */ value?: string; } @@ -555,8 +441,7 @@ export namespace cloudtrace_v2 { /** * cloudtrace.projects.traces.batchWrite - * @desc Sends new spans to new or existing traces. You cannot update - * existing spans. + * @desc Sends new spans to new or existing traces. You cannot update existing spans. * @alias cloudtrace.projects.traces.batchWrite * @memberOf! () * @@ -636,8 +521,7 @@ export namespace cloudtrace_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the project where the spans belong. The format is - * `projects/[PROJECT_ID]`. + * Required. The name of the project where the spans belong. The format is `projects/[PROJECT_ID]`. */ name?: string; @@ -732,12 +616,7 @@ export namespace cloudtrace_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the span in the following format: - * projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique - * identifier for a trace within a project; it is a 32-character hexadecimal - * encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span - * within a trace; it is a 16-character hexadecimal encoding of an 8-byte - * array. + * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ name?: string; diff --git a/src/apis/commentanalyzer/package.json b/src/apis/commentanalyzer/package.json index c0613821c1a..7f440e91131 100644 --- a/src/apis/commentanalyzer/package.json +++ b/src/apis/commentanalyzer/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/commentanalyzer/v1alpha1.ts b/src/apis/commentanalyzer/v1alpha1.ts index 0cf39b80771..077cb21346b 100644 --- a/src/apis/commentanalyzer/v1alpha1.ts +++ b/src/apis/commentanalyzer/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace commentanalyzer_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace commentanalyzer_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,13 +91,7 @@ export namespace commentanalyzer_v1alpha1 { /** * Perspective Comment Analyzer API * - * The Perspective Comment Analyzer API provides information about the - * potential impact of a comment on a conversation (e.g. it can provide a - * score for the "toxicity" of a comment). Users can leverage the - * "SuggestCommentScore" method to submit corrections to improve - * Perspective over time. Users can set the "doNotStore" flag to - * ensure that all submitted comments are automatically deleted after scores - * are returned. + * The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned. * * @example * const {google} = require('googleapis'); @@ -118,7 +108,10 @@ export namespace commentanalyzer_v1alpha1 { comments: Resource$Comments; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.comments = new Resource$Comments(this.context); } @@ -137,10 +130,7 @@ export namespace commentanalyzer_v1alpha1 { */ comment?: Schema$TextEntry; /** - * Optional identifier associating this AnalyzeCommentRequest with a - * particular client's community. Different communities may have - * different norms and rules. Specifying this value enables us to explore - * building community-specific models for clients. + * Optional identifier associating this AnalyzeCommentRequest with a particular client's community. Different communities may have different norms and rules. Specifying this value enables us to explore building community-specific models for clients. */ communityId?: string; /** @@ -148,45 +138,23 @@ export namespace commentanalyzer_v1alpha1 { */ context?: Schema$Context; /** - * Do not store the comment or context sent in this request. By default, the - * service may store comments/context for debugging purposes. + * Do not store the comment or context sent in this request. By default, the service may store comments/context for debugging purposes. */ doNotStore?: boolean; /** - * The language(s) of the comment and context (if none are specified, the - * language is automatically detected). If multiple languages are specified, - * the text is checked in all of them that are supported. Both ISO and - * BCP-47 language codes are accepted. Current Language Restrictions: * - * Only English text ("en") is supported. If none of the languages - * specified by the caller are supported, an `UNIMPLEMENTED` error is - * returned. + * The language(s) of the comment and context (if none are specified, the language is automatically detected). If multiple languages are specified, the text is checked in all of them that are supported. Both ISO and BCP-47 language codes are accepted. Current Language Restrictions: * Only English text ("en") is supported. If none of the languages specified by the caller are supported, an `UNIMPLEMENTED` error is returned. */ languages?: string[]; /** - * Specification of requested attributes. The AttributeParameters serve as - * configuration for each associated attribute. The map keys are attribute - * names. The following attributes are available: - * "ATTACK_ON_AUTHOR" - Attack on author of original article or - * post. "ATTACK_ON_COMMENTER" - Attack on fellow commenter. - * "ATTACK_ON_PUBLISHER" - Attack on publisher of article/post. - * "INCOHERENT" - Difficult to understand, nonsensical. - * "INFLAMMATORY" - Intending to provoke or inflame. - * "OBSCENE" - Obscene, such as cursing. "OFF_TOPIC" - - * Not related to the original topic. "SPAM" - - * Commercial/advertising spam content. "UNSUBSTANTIAL" - Trivial. + * Specification of requested attributes. The AttributeParameters serve as configuration for each associated attribute. The map keys are attribute names. The following attributes are available: "ATTACK_ON_AUTHOR" - Attack on author of original article or post. "ATTACK_ON_COMMENTER" - Attack on fellow commenter. "ATTACK_ON_PUBLISHER" - Attack on publisher of article/post. "INCOHERENT" - Difficult to understand, nonsensical. "INFLAMMATORY" - Intending to provoke or inflame. "OBSCENE" - Obscene, such as cursing. "OFF_TOPIC" - Not related to the original topic. "SPAM" - Commercial/advertising spam content. "UNSUBSTANTIAL" - Trivial. */ requestedAttributes?: {[key: string]: Schema$AttributeParameters}; /** - * Session ID. Used to join related RPCs into a single session. For example, - * an interactive tool that calls both the AnalyzeComment and - * SuggestCommentScore RPCs should set all invocations of both RPCs to the - * same Session ID, typically a random 64-bit integer. + * Session ID. Used to join related RPCs into a single session. For example, an interactive tool that calls both the AnalyzeComment and SuggestCommentScore RPCs should set all invocations of both RPCs to the same Session ID, typically a random 64-bit integer. */ sessionId?: string; /** - * An advisory parameter that will return span annotations if the model is - * capable of providing scores with sub-comment resolution. This will likely - * increase the size of the returned message. + * An advisory parameter that will return span annotations if the model is capable of providing scores with sub-comment resolution. This will likely increase the size of the returned message. */ spanAnnotations?: boolean; } @@ -195,9 +163,7 @@ export namespace commentanalyzer_v1alpha1 { */ export interface Schema$AnalyzeCommentResponse { /** - * Scores for the requested attributes. The map keys are attribute names - * (same as the requested_attribute field in AnalyzeCommentRequest, for - * example "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc). + * Scores for the requested attributes. The map keys are attribute names (same as the requested_attribute field in AnalyzeCommentRequest, for example "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc). */ attributeScores?: {[key: string]: Schema$AttributeScores}; /** @@ -205,34 +171,24 @@ export namespace commentanalyzer_v1alpha1 { */ clientToken?: string; /** - * Contains the language as detected from the text content. If no language - * was specified in the request, the first (the most likely) language is - * used to select an appropriate model. Sorted in order of likelihood. + * Contains the language as detected from the text content. If no language was specified in the request, the first (the most likely) language is used to select an appropriate model. Sorted in order of likelihood. */ detectedLanguages?: string[]; /** - * The language(s) requested by the client, as specified in the request. If - * the request did not specify any language, this will be empty and the - * detected_languages field will be populated. + * The language(s) requested by the client, as specified in the request. If the request did not specify any language, this will be empty and the detected_languages field will be populated. */ languages?: string[]; } /** - * A type of context specific to a comment left on a single-threaded comment - * message board, where comments are either a top level comment or the child - * of a top level comment. + * A type of context specific to a comment left on a single-threaded comment message board, where comments are either a top level comment or the child of a top level comment. */ export interface Schema$ArticleAndParentComment { /** - * The source content about which the comment was made (article text, - * article summary, video transcript, etc). + * The source content about which the comment was made (article text, article summary, video transcript, etc). */ article?: Schema$TextEntry; /** - * Refers to text that is a direct parent of the source comment, such as in - * a one-deep threaded message board. This field will only be present for - * comments that are replies to other comments and will not be populated for - * direct comments on the article_text. + * Refers to text that is a direct parent of the source comment, such as in a one-deep threaded message board. This field will only be present for comments that are replies to other comments and will not be populated for direct comments on the article_text. */ parentComment?: Schema$TextEntry; } @@ -241,9 +197,7 @@ export namespace commentanalyzer_v1alpha1 { */ export interface Schema$AttributeParameters { /** - * Don't return scores for this attribute that are below this threshold. - * If unset, a default threshold will be applied. A FloatValue wrapper is - * used to distinguish between 0 vs. default/unset. + * Don't return scores for this attribute that are below this threshold. If unset, a default threshold will be applied. A FloatValue wrapper is used to distinguish between 0 vs. default/unset. */ scoreThreshold?: number; /** @@ -252,8 +206,7 @@ export namespace commentanalyzer_v1alpha1 { scoreType?: string; } /** - * This holds score values for a single attribute. It contains both per-span - * scores as well as an overall summary score.. + * This holds score values for a single attribute. It contains both per-span scores as well as an overall summary score.. */ export interface Schema$AttributeScores { /** @@ -266,22 +219,15 @@ export namespace commentanalyzer_v1alpha1 { summaryScore?: Schema$Score; } /** - * Context is typically something that a Comment is referencing or replying to - * (such as an article, or previous comment). Note: Populate only ONE OF the - * following fields. The oneof syntax cannot be used because that would - * require nesting entries inside another message and breaking backwards - * compatibility. The server will return an error if more than one of the - * following fields is present. + * Context is typically something that a Comment is referencing or replying to (such as an article, or previous comment). Note: Populate only ONE OF the following fields. The oneof syntax cannot be used because that would require nesting entries inside another message and breaking backwards compatibility. The server will return an error if more than one of the following fields is present. */ export interface Schema$Context { /** - * Information about the source for which the original comment was made, and - * any parent comment info. + * Information about the source for which the original comment was made, and any parent comment info. */ articleAndParentComment?: Schema$ArticleAndParentComment; /** - * A list of messages. For example, a linear comments section or forum - * thread. + * A list of messages. For example, a linear comments section or forum thread. */ entries?: Schema$TextEntry[]; } @@ -303,12 +249,7 @@ export namespace commentanalyzer_v1alpha1 { */ export interface Schema$SpanScore { /** - * "begin" and "end" describe the span of the original - * text that the attribute score applies to. The values are the UTF-16 - * codepoint range. "end" is exclusive. For example, with the text - * "Hi there", the begin/end pair (0,2) describes the text - * "Hi". If "begin" and "end" are unset, the - * score applies to the full text. + * "begin" and "end" describe the span of the original text that the attribute score applies to. The values are the UTF-16 codepoint range. "end" is exclusive. For example, with the text "Hi there", the begin/end pair (0,2) describes the text "Hi". If "begin" and "end" are unset, the score applies to the full text. */ begin?: number; end?: number; @@ -322,20 +263,7 @@ export namespace commentanalyzer_v1alpha1 { */ export interface Schema$SuggestCommentScoreRequest { /** - * Attribute scores for the comment. The map keys are attribute names, same - * as the requested_attribute field in AnalyzeCommentRequest (for example - * "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc.). This field - * has the same type as the `attribute_scores` field in - * AnalyzeCommentResponse. To specify an overall attribute score for the - * entire comment as a whole, use the `summary_score` field of the mapped - * AttributeScores object. To specify scores on specific subparts of the - * comment, use the `span_scores` field. All SpanScore objects must have - * begin and end fields set. All Score objects must be explicitly set (for - * binary classification, use the score values 0 and 1). If Score objects - * don't include a ScoreType, `PROBABILITY` is assumed. - * `attribute_scores` must not be empty. The mapped AttributeScores objects - * also must not be empty. An `INVALID_ARGUMENT` error is returned for all - * malformed requests. + * Attribute scores for the comment. The map keys are attribute names, same as the requested_attribute field in AnalyzeCommentRequest (for example "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc.). This field has the same type as the `attribute_scores` field in AnalyzeCommentResponse. To specify an overall attribute score for the entire comment as a whole, use the `summary_score` field of the mapped AttributeScores object. To specify scores on specific subparts of the comment, use the `span_scores` field. All SpanScore objects must have begin and end fields set. All Score objects must be explicitly set (for binary classification, use the score values 0 and 1). If Score objects don't include a ScoreType, `PROBABILITY` is assumed. `attribute_scores` must not be empty. The mapped AttributeScores objects also must not be empty. An `INVALID_ARGUMENT` error is returned for all malformed requests. */ attributeScores?: {[key: string]: Schema$AttributeScores}; /** @@ -347,10 +275,7 @@ export namespace commentanalyzer_v1alpha1 { */ comment?: Schema$TextEntry; /** - * Optional identifier associating this comment score suggestion with a - * particular sub-community. Different communities may have different norms - * and rules. Specifying this value enables training community-specific - * models. + * Optional identifier associating this comment score suggestion with a particular sub-community. Different communities may have different norms and rules. Specifying this value enables training community-specific models. */ communityId?: string; /** @@ -358,20 +283,11 @@ export namespace commentanalyzer_v1alpha1 { */ context?: Schema$Context; /** - * The language(s) of the comment and context (if none are specified, the - * language is automatically detected). If multiple languages are specified, - * the text is checked in all of them that are supported. Both ISO and - * BCP-47 language codes are accepted. Current Language Restrictions: * - * Only English text ("en") is supported. If none of the languages - * specified by the caller are supported, an `UNIMPLEMENTED` error is - * returned. + * The language(s) of the comment and context (if none are specified, the language is automatically detected). If multiple languages are specified, the text is checked in all of them that are supported. Both ISO and BCP-47 language codes are accepted. Current Language Restrictions: * Only English text ("en") is supported. If none of the languages specified by the caller are supported, an `UNIMPLEMENTED` error is returned. */ languages?: string[]; /** - * Session ID. Used to join related RPCs into a single session. For example, - * an interactive tool that calls both the AnalyzeComment and - * SuggestCommentScore RPCs should set all invocations of both RPCs to the - * same Session ID, typically a random 64-bit integer. + * Session ID. Used to join related RPCs into a single session. For example, an interactive tool that calls both the AnalyzeComment and SuggestCommentScore RPCs should set all invocations of both RPCs to the same Session ID, typically a random 64-bit integer. */ sessionId?: string; } @@ -414,8 +330,7 @@ export namespace commentanalyzer_v1alpha1 { /** * commentanalyzer.comments.analyze - * @desc Analyzes the provided text and returns scores for requested - * attributes. + * @desc Analyzes the provided text and returns scores for requested attributes. * @alias commentanalyzer.comments.analyze * @memberOf! () * diff --git a/src/apis/composer/package.json b/src/apis/composer/package.json index 1a89a65fa6a..1440d342749 100644 --- a/src/apis/composer/package.json +++ b/src/apis/composer/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index e63ee5e71ec..07ac768e4fb 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace composer_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace composer_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,18 +108,17 @@ export namespace composer_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -139,17 +134,11 @@ export namespace composer_v1 { */ createTime?: string; /** - * Optional. User-defined labels for this environment. The labels map can - * contain no more than 64 entries. Entries of the labels map are UTF8 - * strings that comply with the following restrictions: * Keys must conform - * to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally - * constrained to be <= 128 bytes in size. + * Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */ labels?: {[key: string]: string}; /** - * The resource name of the environment, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; /** @@ -161,9 +150,7 @@ export namespace composer_v1 { */ updateTime?: string; /** - * Output only. The UUID (Universally Unique IDentifier) associated with - * this environment. This value is generated when the environment is - * created. + * Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. */ uuid?: string; } @@ -172,17 +159,11 @@ export namespace composer_v1 { */ export interface Schema$EnvironmentConfig { /** - * Output only. The URI of the Apache Airflow Web UI hosted within this - * environment (see [Airflow web - * interface](/composer/docs/how-to/accessing/airflow-web-interface)). + * Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)). */ airflowUri?: string; /** - * Output only. The Cloud Storage prefix of the DAGs for this environment. - * Although Cloud Storage objects reside in a flat namespace, a hierarchical - * file tree can be simulated using "/"-delimited object name - * prefixes. DAG objects for this environment reside in a simulated - * directory with the given prefix. + * Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix. */ dagGcsPrefix?: string; /** @@ -194,8 +175,7 @@ export namespace composer_v1 { */ nodeConfig?: Schema$NodeConfig; /** - * The number of nodes in the Kubernetes Engine cluster that will be used to - * run this environment. + * The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. */ nodeCount?: number; /** @@ -208,13 +188,11 @@ export namespace composer_v1 { */ export interface Schema$ImageVersion { /** - * The string identifier of the ImageVersion, in the form: - * "composer-x.y.z-airflow-a.b(.c)" + * The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b(.c)" */ imageVersionId?: string; /** - * Whether this is the default ImageVersion used by Composer during - * environment creation if no input ImageVersion is specified. + * Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. */ isDefault?: boolean; /** @@ -262,99 +240,48 @@ export namespace composer_v1 { operations?: Schema$Operation[]; } /** - * The configuration information for the Kubernetes Engine nodes running the - * Apache Airflow software. + * The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. */ export interface Schema$NodeConfig { /** - * Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If - * unspecified, defaults to 100GB. Cannot be updated. + * Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. */ diskSizeGb?: number; /** - * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which - * to deploy the VMs used to run the Apache Airflow software, specified as a - * [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/zones/{zoneId}". This `location` must - * belong to the enclosing environment's project and location. If both - * this field and `nodeConfig.machineType` are specified, - * `nodeConfig.machineType` must belong to this `location`; if both are - * unspecified, the service will pick a zone in the Compute Engine region - * corresponding to the Cloud Composer location, and propagate that choice - * to both fields. If only one field (`location` or - * `nodeConfig.machineType`) is specified, the location information from the - * specified field will be propagated to the unspecified field. + * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which to deploy the VMs used to run the Apache Airflow software, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}". This `location` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`) is specified, the location information from the specified field will be propagated to the unspecified field. */ location?: string; /** - * Optional. The Compute Engine [machine type](/compute/docs/machine-types) - * used for cluster instances, specified as a [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". - * The `machineType` must belong to the enclosing environment's project - * and location. If both this field and `nodeConfig.location` are specified, - * this `machineType` must belong to the `nodeConfig.location`; if both are - * unspecified, the service will pick a zone in the Compute Engine region - * corresponding to the Cloud Composer location, and propagate that choice - * to both fields. If exactly one of this field and `nodeConfig.location` is - * specified, the location information from the specified field will be - * propagated to the unspecified field. If this field is unspecified, the - * `machineTypeId` defaults to "n1-standard-1". + * Optional. The Compute Engine [machine type](/compute/docs/machine-types) used for cluster instances, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The `machineType` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. If this field is unspecified, the `machineTypeId` defaults to "n1-standard-1". */ machineType?: string; /** - * Optional. The Compute Engine network to be used for machine - * communications, specified as a [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/global/networks/{networkId}". [Shared - * VPC](/vpc/docs/shared-vpc) is not currently supported. The network must - * belong to the environment's project. If unspecified, the - * "default" network ID in the environment's project is used. - * If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is - * provided, `nodeConfig.subnetwork` must also be provided. + * Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/global/networks/{networkId}". [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. */ network?: string; /** - * Optional. The set of Google API scopes to be made available on all node - * VMs. If `oauth_scopes` is empty, defaults to - * ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be - * updated. + * Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. */ oauthScopes?: string[]; /** - * Optional. The Google Cloud Platform Service Account to be used by the - * node VMs. If a service account is not specified, the "default" - * Compute Engine service account is used. Cannot be updated. + * Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. */ serviceAccount?: string; /** - * Optional. The Compute Engine subnetwork to be used for machine - * communications, specified as a [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" - * If a subnetwork is provided, `nodeConfig.network` must also be provided, - * and the subnetwork must belong to the enclosing environment's project - * and location. + * Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location. */ subnetwork?: string; /** - * Optional. The list of instance tags applied to all node VMs. Tags are - * used to identify valid sources or targets for network firewalls. Each tag - * within the list must comply with - * [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. + * Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. */ tags?: string[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -362,26 +289,15 @@ export namespace composer_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -394,8 +310,7 @@ export namespace composer_v1 { */ createTime?: string; /** - * Output only. The time when the operation terminated, regardless of its - * success. This field is unset if the operation is still ongoing. + * Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing. */ endTime?: string; /** @@ -403,8 +318,7 @@ export namespace composer_v1 { */ operationType?: string; /** - * Output only. The resource being operated on, as a [relative resource - * name]( /apis/design/resource_names#relative_resource_name). + * Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name). */ resource?: string; /** @@ -417,110 +331,32 @@ export namespace composer_v1 { state?: string; } /** - * Specifies the selection and configuration of software inside the - * environment. + * Specifies the selection and configuration of software inside the environment. */ export interface Schema$SoftwareConfig { /** - * Optional. Apache Airflow configuration properties to override. Property - * keys contain the section and property names, separated by a hyphen, for - * example "core-dags_are_paused_at_creation". Section names must - * not contain hyphens ("-"), opening square brackets - * ("["), or closing square brackets ("]"). The - * property name must not be empty and must not contain an equals sign - * ("=") or semicolon (";"). Section and property names - * must not contain a period ("."). Apache Airflow configuration - * property names must be written in - * [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values - * can contain any character, and can be written in any lower/upper case - * format. Certain Apache Airflow configuration property values are - * [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), - * and cannot be overridden. + * Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), and cannot be overridden. */ airflowConfigOverrides?: {[key: string]: string}; /** - * Optional. Additional environment variables to provide to the Apache - * Airflow scheduler, worker, and webserver processes. Environment variable - * names must match the regular expression `a-zA-Z_*`. They cannot specify - * Apache Airflow software configuration overrides (they cannot match the - * regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot - * match any of the following reserved names: * `AIRFLOW_HOME` * - * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * - * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * - * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` + * Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` */ envVariables?: {[key: string]: string}; /** - * The version of the software running in the environment. This encapsulates - * both the version of Cloud Composer functionality and the version of - * Apache Airflow. It must match the regular expression - * `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. - * When used as input, the server also checks if the provided version is - * supported and denies the request for an unsupported version. The Cloud - * Composer portion of the version is a [semantic - * version](https://semver.org) or `latest`. When the patch version is - * omitted, the current Cloud Composer patch version is selected. When - * `latest` is provided instead of an explicit version number, the server - * replaces `latest` with the current Cloud Composer version and stores that - * version number in the same field. The portion of the image version that - * follows <em>airflow-</em> is an official Apache Airflow - * repository [release - * name](https://github.com/apache/incubator-airflow/releases). See also - * [Version List](/composer/docs/concepts/versioning/composer-versions). + * The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the version is a [semantic version](https://semver.org) or `latest`. When the patch version is omitted, the current Cloud Composer patch version is selected. When `latest` is provided instead of an explicit version number, the server replaces `latest` with the current Cloud Composer version and stores that version number in the same field. The portion of the image version that follows <em>airflow-</em> is an official Apache Airflow repository [release name](https://github.com/apache/incubator-airflow/releases). See also [Version List](/composer/docs/concepts/versioning/composer-versions). */ imageVersion?: string; /** - * Optional. Custom Python Package Index (PyPI) packages to be installed in - * the environment. Keys refer to the lowercase package name such as - * "numpy" and values are the lowercase extras and version - * specifier such as "==1.12.0", "[devel,gcp_api]", or - * "[devel]>=1.8.2, <1.9.2". To specify a package without - * pinning it to a version specifier, use the empty string as the value. + * Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value. */ pypiPackages?: {[key: string]: string}; /** - * Optional. The major version of Python used to run the Apache Airflow - * scheduler, worker, and webserver processes. Can be set to '2' or - * '3'. If not specified, the default is '2'. Cannot be - * updated. + * Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. */ pythonVersion?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -528,14 +364,11 @@ export namespace composer_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -951,8 +784,7 @@ export namespace composer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent must be of the form - * "projects/{projectId}/locations/{locationId}". + * The parent must be of the form "projects/{projectId}/locations/{locationId}". */ parent?: string; @@ -969,8 +801,7 @@ export namespace composer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The environment to delete, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; } @@ -982,8 +813,7 @@ export namespace composer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the environment to get, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; } @@ -1003,8 +833,7 @@ export namespace composer_v1 { */ pageToken?: string; /** - * List environments in the given project and location, in the form: - * "projects/{projectId}/locations/{locationId}" + * List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */ parent?: string; } @@ -1016,85 +845,11 @@ export namespace composer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the environment to update, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; /** - * Required. A comma-separated list of paths, relative to `Environment`, of - * fields to update. For example, to set the version of scikit-learn to - * install in the environment to 0.19.0 and to remove an existing - * installation of numpy, the `updateMask` parameter would include the - * following two `paths` values: - * "config.softwareConfig.pypiPackages.scikit-learn" and - * "config.softwareConfig.pypiPackages.numpy". The included patch - * environment would specify the scikit-learn version as follows: { - * "config":{ "softwareConfig":{ "pypiPackages":{ - * "scikit-learn":"==0.19.0" } } } } Note that - * in the above example, any existing PyPI packages other than scikit-learn - * and numpy will be unaffected. Only one update type may be included in a - * single request's `updateMask`. For example, one cannot update both the - * PyPI packages and labels in the same request. However, it is possible to - * update multiple members of a map field simultaneously in the same - * request. For example, to set the labels "label1" and "label2" while - * clearing "label3" (assuming it already exists), one can provide the paths - * "labels.label1", "labels.label2", and "labels.label3" and populate the - * patch environment as follows: { "labels":{ - * "label1":"new-label1-value" "label2":"new-label2-value" } - * } Note that in the above example, any existing labels that are not - * included in the `updateMask` will be unaffected. It is also possible to - * replace an entire map field by providing the map field's path in the - * `updateMask`. The new value of the field will be that which is provided - * in the patch environment. For example, to delete all pre-existing - * user-specified PyPI packages and install botocore at version 1.7.14, the - * `updateMask` would contain the path "config.softwareConfig.pypiPackages", - * and the patch environment would be the following: { "config":{ - * "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } - * } } **Note:** Only the following fields can be updated:
                          - * - * - * - * - * - * - * - * - * - * - * - *
                          MaskPurpose
                          config.softwareConfig.pypiPackages Replace all custom - * custom PyPI packages. If a replacement package map is not included in - * `environment`, all custom PyPI packages are cleared. It is an error to - * provide both this mask and a mask specifying an individual package.
                          config.softwareConfig.pypiPackages.packagenameUpdate the custom PyPI package packagename, preserving - * other packages. To delete the package, include it in `updateMask`, and - * omit the mapping for it in - * `environment.config.softwareConfig.pypiPackages`. It is an error to - * provide both a mask of this form and the - * "config.softwareConfig.pypiPackages" mask.
                          labels Replace all environment labels. If a replacement - * labels map is not included in `environment`, all labels are cleared. It - * is an error to provide both this mask and a mask specifying one or more - * individual labels.
                          labels.labelName Set the label named - * labelName, while preserving other labels. To delete the - * label, include it in `updateMask` and omit its mapping in - * `environment.labels`. It is an error to provide both a mask of this form - * and the "labels" mask.
                          config.nodeCountHorizontally scale the number of nodes in the environment. An integer - * greater than or equal to 3 must be provided in the `config.nodeCount` - * field.
                          config.softwareConfig.airflowConfigOverrides Replace all - * Apache Airflow config overrides. If a replacement config overrides map - * is not included in `environment`, all config overrides are cleared. It - * is an error to provide both this mask and a mask specifying one or more - * individual config overrides.
                          config.softwareConfig.airflowConfigOverrides.section-name - * Override the Apache Airflow config property - * name in the section named section, preserving - * other properties. To delete the property override, include it in - * `updateMask` and omit its mapping in - * `environment.config.softwareConfig.airflowConfigOverrides`. It is an - * error to provide both a mask of this form and the - * "config.softwareConfig.airflowConfigOverrides" mask.
                          config.softwareConfig.envVariables Replace all environment - * variables. If a replacement environment variable map is not included in - * `environment`, all custom environment variables are cleared. It is an - * error to provide both this mask and a mask specifying one or more - * individual environment variables.
                          + * Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:** Only the following fields can be updated:
                          Mask Purpose
                          config.softwareConfig.pypiPackages Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
                          config.softwareConfig.pypiPackages.packagename Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the "config.softwareConfig.pypiPackages" mask.
                          labels Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
                          labels.labelName Set the label named labelName, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the "labels" mask.
                          config.nodeCount Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field.
                          config.softwareConfig.airflowConfigOverrides Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
                          config.softwareConfig.airflowConfigOverrides.section-name Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the "config.softwareConfig.airflowConfigOverrides" mask.
                          config.softwareConfig.envVariables Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables.
                          */ updateMask?: string; @@ -1210,8 +965,7 @@ export namespace composer_v1 { */ pageToken?: string; /** - * List ImageVersions in the given project and location, in the form: - * "projects/{projectId}/locations/{locationId}" + * List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */ parent?: string; } @@ -1224,10 +978,7 @@ export namespace composer_v1 { /** * composer.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias composer.projects.locations.operations.delete * @memberOf! () * @@ -1296,9 +1047,7 @@ export namespace composer_v1 { /** * composer.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias composer.projects.locations.operations.get * @memberOf! () * @@ -1369,15 +1118,7 @@ export namespace composer_v1 { /** * composer.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias composer.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 1f09d5b689e..50911913ebc 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace composer_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace composer_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,18 +108,17 @@ export namespace composer_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -139,17 +134,11 @@ export namespace composer_v1beta1 { */ createTime?: string; /** - * Optional. User-defined labels for this environment. The labels map can - * contain no more than 64 entries. Entries of the labels map are UTF8 - * strings that comply with the following restrictions: * Keys must conform - * to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally - * constrained to be <= 128 bytes in size. + * Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */ labels?: {[key: string]: string}; /** - * The resource name of the environment, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; /** @@ -161,9 +150,7 @@ export namespace composer_v1beta1 { */ updateTime?: string; /** - * Output only. The UUID (Universally Unique IDentifier) associated with - * this environment. This value is generated when the environment is - * created. + * Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. */ uuid?: string; } @@ -172,17 +159,11 @@ export namespace composer_v1beta1 { */ export interface Schema$EnvironmentConfig { /** - * Output only. The URI of the Apache Airflow Web UI hosted within this - * environment (see [Airflow web - * interface](/composer/docs/how-to/accessing/airflow-web-interface)). + * Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)). */ airflowUri?: string; /** - * Output only. The Cloud Storage prefix of the DAGs for this environment. - * Although Cloud Storage objects reside in a flat namespace, a hierarchical - * file tree can be simulated using "/"-delimited object name - * prefixes. DAG objects for this environment reside in a simulated - * directory with the given prefix. + * Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix. */ dagGcsPrefix?: string; /** @@ -194,8 +175,7 @@ export namespace composer_v1beta1 { */ nodeConfig?: Schema$NodeConfig; /** - * The number of nodes in the Kubernetes Engine cluster that will be used to - * run this environment. + * The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. */ nodeCount?: number; /** @@ -212,13 +192,11 @@ export namespace composer_v1beta1 { */ export interface Schema$ImageVersion { /** - * The string identifier of the ImageVersion, in the form: - * "composer-x.y.z-airflow-a.b(.c)" + * The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b(.c)" */ imageVersionId?: string; /** - * Whether this is the default ImageVersion used by Composer during - * environment creation if no input ImageVersion is specified. + * Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. */ isDefault?: boolean; /** @@ -231,48 +209,23 @@ export namespace composer_v1beta1 { */ export interface Schema$IPAllocationPolicy { /** - * Optional. The IP address range used to allocate IP addresses to pods in - * the cluster. This field is applicable only when `use_ip_aliases` is - * true. Set to blank to have GKE choose a range with the default size. Set - * to /netmask (e.g. `/14`) to have GKE choose a range with a specific - * netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. Specify `cluster_secondary_range_name` or - * `cluster_ipv4_cidr_block` but not both. + * Optional. The IP address range used to allocate IP addresses to pods in the cluster. This field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` but not both. */ clusterIpv4CidrBlock?: string; /** - * Optional. The name of the cluster's secondary range used to allocate - * IP addresses to pods. Specify either `cluster_secondary_range_name` or - * `cluster_ipv4_cidr_block` but not both. This field is applicable only - * when `use_ip_aliases` is true. + * Optional. The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` but not both. This field is applicable only when `use_ip_aliases` is true. */ clusterSecondaryRangeName?: string; /** - * Optional. The IP address range of the services IP addresses in this - * cluster. This field is applicable only when `use_ip_aliases` is true. - * Set to blank to have GKE choose a range with the default size. Set to - * /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. - * Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. Specify `services_secondary_range_name` or - * `services_ipv4_cidr_block` but not both. + * Optional. The IP address range of the services IP addresses in this cluster. This field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. Specify `services_secondary_range_name` or `services_ipv4_cidr_block` but not both. */ servicesIpv4CidrBlock?: string; /** - * Optional. The name of the services' secondary range used to allocate - * IP addresses to the cluster. Specify either - * `services_secondary_range_name` or `services_ipv4_cidr_block` but not - * both. This field is applicable only when `use_ip_aliases` is true. + * Optional. The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either `services_secondary_range_name` or `services_ipv4_cidr_block` but not both. This field is applicable only when `use_ip_aliases` is true. */ servicesSecondaryRangeName?: string; /** - * Optional. Whether or not to enable Alias IPs in the GKE cluster. If - * `true`, a VPC-native cluster is created. + * Optional. Whether or not to enable Alias IPs in the GKE cluster. If `true`, a VPC-native cluster is created. */ useIpAliases?: boolean; } @@ -316,13 +269,11 @@ export namespace composer_v1beta1 { operations?: Schema$Operation[]; } /** - * The configuration information for the Kubernetes Engine nodes running the - * Apache Airflow software. + * The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. */ export interface Schema$NodeConfig { /** - * Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If - * unspecified, defaults to 100GB. Cannot be updated. + * Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. */ diskSizeGb?: number; /** @@ -330,90 +281,40 @@ export namespace composer_v1beta1 { */ ipAllocationPolicy?: Schema$IPAllocationPolicy; /** - * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which - * to deploy the VMs used to run the Apache Airflow software, specified as a - * [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/zones/{zoneId}". This `location` must - * belong to the enclosing environment's project and location. If both - * this field and `nodeConfig.machineType` are specified, - * `nodeConfig.machineType` must belong to this `location`; if both are - * unspecified, the service will pick a zone in the Compute Engine region - * corresponding to the Cloud Composer location, and propagate that choice - * to both fields. If only one field (`location` or - * `nodeConfig.machineType`) is specified, the location information from the - * specified field will be propagated to the unspecified field. + * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which to deploy the VMs used to run the Apache Airflow software, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}". This `location` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`) is specified, the location information from the specified field will be propagated to the unspecified field. */ location?: string; /** - * Optional. The Compute Engine [machine type](/compute/docs/machine-types) - * used for cluster instances, specified as a [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". - * The `machineType` must belong to the enclosing environment's project - * and location. If both this field and `nodeConfig.location` are specified, - * this `machineType` must belong to the `nodeConfig.location`; if both are - * unspecified, the service will pick a zone in the Compute Engine region - * corresponding to the Cloud Composer location, and propagate that choice - * to both fields. If exactly one of this field and `nodeConfig.location` is - * specified, the location information from the specified field will be - * propagated to the unspecified field. If this field is unspecified, the - * `machineTypeId` defaults to "n1-standard-1". + * Optional. The Compute Engine [machine type](/compute/docs/machine-types) used for cluster instances, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The `machineType` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. If this field is unspecified, the `machineTypeId` defaults to "n1-standard-1". */ machineType?: string; /** - * Optional. The Compute Engine network to be used for machine - * communications, specified as a [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/global/networks/{networkId}". If - * unspecified, the default network in the environment's project is - * used. If a [Custom Subnet - * Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, - * `nodeConfig.subnetwork` must also be provided. For [Shared - * VPC](/vpc/docs/shared-vpc) subnetwork requirements, see - * `nodeConfig.subnetwork`. + * Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/global/networks/{networkId}". If unspecified, the default network in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. For [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see `nodeConfig.subnetwork`. */ network?: string; /** - * Optional. The set of Google API scopes to be made available on all node - * VMs. If `oauth_scopes` is empty, defaults to - * ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be - * updated. + * Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. */ oauthScopes?: string[]; /** - * Optional. The Google Cloud Platform Service Account to be used by the - * node VMs. If a service account is not specified, the "default" - * Compute Engine service account is used. Cannot be updated. + * Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. */ serviceAccount?: string; /** - * Optional. The Compute Engine subnetwork to be used for machine - * communications, specified as a [relative resource - * name](/apis/design/resource_names#relative_resource_name). For example: - * "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" - * If a subnetwork is provided, `nodeConfig.network` must also be provided, - * and the subnetwork must belong to the enclosing environment's project - * and location. + * Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location. */ subnetwork?: string; /** - * Optional. The list of instance tags applied to all node VMs. Tags are - * used to identify valid sources or targets for network firewalls. Each tag - * within the list must comply with - * [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. + * Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. */ tags?: string[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -421,26 +322,15 @@ export namespace composer_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -453,8 +343,7 @@ export namespace composer_v1beta1 { */ createTime?: string; /** - * Output only. The time when the operation terminated, regardless of its - * success. This field is unset if the operation is still ongoing. + * Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing. */ endTime?: string; /** @@ -462,8 +351,7 @@ export namespace composer_v1beta1 { */ operationType?: string; /** - * Output only. The resource being operated on, as a [relative resource - * name]( /apis/design/resource_names#relative_resource_name). + * Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name). */ resource?: string; /** @@ -476,146 +364,58 @@ export namespace composer_v1beta1 { state?: string; } /** - * Configuration options for the private GKE cluster in a Cloud Composer - * environment. + * Configuration options for the private GKE cluster in a Cloud Composer environment. */ export interface Schema$PrivateClusterConfig { /** - * Optional. If `true`, access to the public endpoint of the GKE cluster is - * denied. + * Optional. If `true`, access to the public endpoint of the GKE cluster is denied. */ enablePrivateEndpoint?: boolean; /** - * The IP range in CIDR notation to use for the hosted master network. This - * range is used for assigning internal IP addresses to the cluster master - * or set of masters and to the internal load balancer virtual IP. This - * range must not overlap with any other ranges in use within the - * cluster's network. If left blank, the default value of - * '172.16.0.0/28' is used. + * The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used. */ masterIpv4CidrBlock?: string; } /** - * The configuration information for configuring a Private IP Cloud Composer - * environment. + * The configuration information for configuring a Private IP Cloud Composer environment. */ export interface Schema$PrivateEnvironmentConfig { /** - * Optional. If `true`, a Private IP Cloud Composer environment is created. - * If this field is true, `use_ip_aliases` must be true. + * Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is true, `use_ip_aliases` must be true. */ enablePrivateEnvironment?: boolean; /** - * Optional. Configuration for the private GKE cluster for a Private IP - * Cloud Composer environment. + * Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment. */ privateClusterConfig?: Schema$PrivateClusterConfig; } /** - * Specifies the selection and configuration of software inside the - * environment. + * Specifies the selection and configuration of software inside the environment. */ export interface Schema$SoftwareConfig { /** - * Optional. Apache Airflow configuration properties to override. Property - * keys contain the section and property names, separated by a hyphen, for - * example "core-dags_are_paused_at_creation". Section names must - * not contain hyphens ("-"), opening square brackets - * ("["), or closing square brackets ("]"). The - * property name must not be empty and must not contain an equals sign - * ("=") or semicolon (";"). Section and property names - * must not contain a period ("."). Apache Airflow configuration - * property names must be written in - * [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values - * can contain any character, and can be written in any lower/upper case - * format. Certain Apache Airflow configuration property values are - * [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), - * and cannot be overridden. + * Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), and cannot be overridden. */ airflowConfigOverrides?: {[key: string]: string}; /** - * Optional. Additional environment variables to provide to the Apache - * Airflow scheduler, worker, and webserver processes. Environment variable - * names must match the regular expression `a-zA-Z_*`. They cannot specify - * Apache Airflow software configuration overrides (they cannot match the - * regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot - * match any of the following reserved names: * `AIRFLOW_HOME` * - * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * - * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * - * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` + * Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` */ envVariables?: {[key: string]: string}; /** - * The version of the software running in the environment. This encapsulates - * both the version of Cloud Composer functionality and the version of - * Apache Airflow. It must match the regular expression - * `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. - * When used as input, the server also checks if the provided version is - * supported and denies the request for an unsupported version. The Cloud - * Composer portion of the version is a [semantic - * version](https://semver.org) or `latest`. When the patch version is - * omitted, the current Cloud Composer patch version is selected. When - * `latest` is provided instead of an explicit version number, the server - * replaces `latest` with the current Cloud Composer version and stores that - * version number in the same field. The portion of the image version that - * follows <em>airflow-</em> is an official Apache Airflow - * repository [release - * name](https://github.com/apache/incubator-airflow/releases). See also - * [Version List](/composer/docs/concepts/versioning/composer-versions). + * The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the version is a [semantic version](https://semver.org) or `latest`. When the patch version is omitted, the current Cloud Composer patch version is selected. When `latest` is provided instead of an explicit version number, the server replaces `latest` with the current Cloud Composer version and stores that version number in the same field. The portion of the image version that follows <em>airflow-</em> is an official Apache Airflow repository [release name](https://github.com/apache/incubator-airflow/releases). See also [Version List](/composer/docs/concepts/versioning/composer-versions). */ imageVersion?: string; /** - * Optional. Custom Python Package Index (PyPI) packages to be installed in - * the environment. Keys refer to the lowercase package name such as - * "numpy" and values are the lowercase extras and version - * specifier such as "==1.12.0", "[devel,gcp_api]", or - * "[devel]>=1.8.2, <1.9.2". To specify a package without - * pinning it to a version specifier, use the empty string as the value. + * Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value. */ pypiPackages?: {[key: string]: string}; /** - * Optional. The major version of Python used to run the Apache Airflow - * scheduler, worker, and webserver processes. Can be set to '2' or - * '3'. If not specified, the default is '2'. Cannot be - * updated. + * Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. */ pythonVersion?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -623,14 +423,11 @@ export namespace composer_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1046,8 +843,7 @@ export namespace composer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent must be of the form - * "projects/{projectId}/locations/{locationId}". + * The parent must be of the form "projects/{projectId}/locations/{locationId}". */ parent?: string; @@ -1064,8 +860,7 @@ export namespace composer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The environment to delete, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; } @@ -1077,8 +872,7 @@ export namespace composer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the environment to get, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; } @@ -1098,8 +892,7 @@ export namespace composer_v1beta1 { */ pageToken?: string; /** - * List environments in the given project and location, in the form: - * "projects/{projectId}/locations/{locationId}" + * List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */ parent?: string; } @@ -1111,94 +904,11 @@ export namespace composer_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the environment to update, in the form: - * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */ name?: string; /** - * Required. A comma-separated list of paths, relative to `Environment`, of - * fields to update. For example, to set the version of scikit-learn to - * install in the environment to 0.19.0 and to remove an existing - * installation of argparse, the `updateMask` parameter would include the - * following two `paths` values: - * "config.softwareConfig.pypiPackages.scikit-learn" and - * "config.softwareConfig.pypiPackages.argparse". The included patch - * environment would specify the scikit-learn version as follows: { - * "config":{ "softwareConfig":{ "pypiPackages":{ - * "scikit-learn":"==0.19.0" } } } } Note that - * in the above example, any existing PyPI packages other than scikit-learn - * and argparse will be unaffected. Only one update type may be included in - * a single request's `updateMask`. For example, one cannot update both the - * PyPI packages and labels in the same request. However, it is possible to - * update multiple members of a map field simultaneously in the same - * request. For example, to set the labels "label1" and "label2" while - * clearing "label3" (assuming it already exists), one can provide the paths - * "labels.label1", "labels.label2", and "labels.label3" and populate the - * patch environment as follows: { "labels":{ - * "label1":"new-label1-value" "label2":"new-label2-value" } - * } Note that in the above example, any existing labels that are not - * included in the `updateMask` will be unaffected. It is also possible to - * replace an entire map field by providing the map field's path in the - * `updateMask`. The new value of the field will be that which is provided - * in the patch environment. For example, to delete all pre-existing - * user-specified PyPI packages and install botocore at version 1.7.14, the - * `updateMask` would contain the path "config.softwareConfig.pypiPackages", - * and the patch environment would be the following: { "config":{ - * "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } - * } } Note: Only the following fields can be updated: - * - * - * - * - * - * - * - * - * - * - * - * - * - *
                          MaskPurpose
                          config.softwareConfig.pypiPackages Replace all custom - * custom PyPI packages. If a replacement package map is not included in - * `environment`, all custom PyPI packages are cleared. It is an error to - * provide both this mask and a mask specifying an individual package.
                          config.softwareConfig.pypiPackages.packagenameUpdate the custom PyPI package packagename, preserving - * other packages. To delete the package, include it in `updateMask`, and - * omit the mapping for it in - * `environment.config.softwareConfig.pypiPackages`. It is an error to - * provide both a mask of this form and the - * "config.softwareConfig.pypiPackages" mask.
                          labels Replace all environment labels. If a replacement - * labels map is not included in `environment`, all labels are cleared. It - * is an error to provide both this mask and a mask specifying one or more - * individual labels.
                          labels.labelName Set the label named - * labelName, while preserving other labels. To delete the - * label, include it in `updateMask` and omit its mapping in - * `environment.labels`. It is an error to provide both a mask of this form - * and the "labels" mask.
                          config.nodeCountHorizontally scale the number of nodes in the environment. An integer - * greater than or equal to 3 must be provided in the `config.nodeCount` - * field.
                          config.softwareConfig.airflowConfigOverrides Replace all - * Apache Airflow config overrides. If a replacement config overrides map - * is not included in `environment`, all config overrides are cleared. It - * is an error to provide both this mask and a mask specifying one or more - * individual config overrides.
                          config.softwareConfig.airflowConfigOverrides.section-name - * Override the Apache Airflow config property - * name in the section named section, preserving - * other properties. To delete the property override, include it in - * `updateMask` and omit its mapping in - * `environment.config.softwareConfig.airflowConfigOverrides`. It is an - * error to provide both a mask of this form and the - * "config.softwareConfig.airflowConfigOverrides" mask.
                          config.softwareConfig.envVariables Replace all environment - * variables. If a replacement environment variable map is not included in - * `environment`, all custom environment variables are cleared. It is an - * error to provide both this mask and a mask specifying one or more - * individual environment variables.
                          config.softwareConfig.imageVersion Upgrade the version of - * the environment in-place. Refer to `SoftwareConfig.image_version` for - * information on how to format the new image version. Additionally, the - * new image version cannot effect a version downgrade and must match the - * current image version's Composer major version and Airflow major and - * minor versions. Consult the Cloud - * Composer Version List for valid values.
                          + * Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of argparse, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.argparse". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and argparse will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } Note: Only the following fields can be updated:
                          Mask Purpose
                          config.softwareConfig.pypiPackages Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
                          config.softwareConfig.pypiPackages.packagename Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the "config.softwareConfig.pypiPackages" mask.
                          labels Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
                          labels.labelName Set the label named labelName, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the "labels" mask.
                          config.nodeCount Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field.
                          config.softwareConfig.airflowConfigOverrides Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
                          config.softwareConfig.airflowConfigOverrides.section-name Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the "config.softwareConfig.airflowConfigOverrides" mask.
                          config.softwareConfig.envVariables Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables.
                          config.softwareConfig.imageVersion Upgrade the version of the environment in-place. Refer to `SoftwareConfig.image_version` for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade and must match the current image version's Composer major version and Airflow major and minor versions. Consult the Cloud Composer Version List for valid values.
                          */ updateMask?: string; @@ -1314,8 +1024,7 @@ export namespace composer_v1beta1 { */ pageToken?: string; /** - * List ImageVersions in the given project and location, in the form: - * "projects/{projectId}/locations/{locationId}" + * List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */ parent?: string; } @@ -1328,10 +1037,7 @@ export namespace composer_v1beta1 { /** * composer.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias composer.projects.locations.operations.delete * @memberOf! () * @@ -1400,9 +1106,7 @@ export namespace composer_v1beta1 { /** * composer.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias composer.projects.locations.operations.get * @memberOf! () * @@ -1473,15 +1177,7 @@ export namespace composer_v1beta1 { /** * composer.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias composer.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 210fc26eeec..9392c5eccae 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace compute_alpha { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace compute_alpha { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -168,7 +165,10 @@ export namespace compute_alpha { zones: Resource$Zones; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.acceleratorTypes = new Resource$Acceleratortypes(this.context); this.addresses = new Resource$Addresses(this.context); @@ -280,8 +280,7 @@ export namespace compute_alpha { } /** - * A specification of the type and number of accelerator cards attached to the - * instance. + * A specification of the type and number of accelerator cards attached to the instance. */ export interface Schema$AcceleratorConfig { /** @@ -289,17 +288,12 @@ export namespace compute_alpha { */ acceleratorCount?: number; /** - * Full or partial URL of the accelerator type resource to attach to this - * instance. For example: - * projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 - * If you are creating an instance template, specify only the accelerator - * name. See GPUs on Compute Engine for a full list of accelerator types. + * Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. */ acceleratorType?: string; } /** - * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) - * (== resource_for v1.acceleratorTypes ==) + * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -307,8 +301,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * [Output Only] The deprecation status associated with this accelerator - * type. + * [Output Only] The deprecation status associated with this accelerator type. */ deprecated?: Schema$DeprecationStatus; /** @@ -316,13 +309,11 @@ export namespace compute_alpha { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#acceleratorType - * for accelerator types. + * [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. */ kind?: string; /** @@ -342,9 +333,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The name of the zone where the accelerator type resides, - * such as us-central1-a. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -358,17 +347,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$AcceleratorTypesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#acceleratorTypeAggregatedList for aggregated lists of accelerator - * types. + * [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -397,16 +380,11 @@ export namespace compute_alpha { */ items?: Schema$AcceleratorType[]; /** - * [Output Only] Type of resource. Always compute#acceleratorTypeList for - * lists of accelerator types. + * [Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -428,8 +406,7 @@ export namespace compute_alpha { */ acceleratorTypes?: Schema$AcceleratorType[]; /** - * [Output Only] An informational warning that appears when the accelerator - * types list is empty. + * [Output Only] An informational warning that appears when the accelerator types list is empty. */ warning?: { code?: string; @@ -438,36 +415,23 @@ export namespace compute_alpha { }; } /** - * An access configuration attached to an instance's network interface. - * Only one access config per instance is supported. + * An access configuration attached to an instance's network interface. Only one access config per instance is supported. */ export interface Schema$AccessConfig { /** - * [Output Only] Type of the resource. Always compute#accessConfig for - * access configs. + * [Output Only] Type of the resource. Always compute#accessConfig for access configs. */ kind?: string; /** - * The name of this access configuration. The default and recommended name - * is External NAT but you can use any arbitrary string you would like. For - * example, My external IP or Network Access. + * The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. */ name?: string; /** - * An external IP address associated with this instance. Specify an unused - * static external IP address available to the project or leave this field - * undefined to use an IP from a shared ephemeral IP address pool. If you - * specify a static external IP address, it must live in the same region as - * the zone of the instance. + * An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. */ natIP?: string; /** - * This signifies the networking tier used for configuring this access - * configuration and can only take the following values: PREMIUM, STANDARD. - * If an AccessConfig is specified without a valid external IP address, an - * ephemeral IP will be created with this networkTier. If an AccessConfig - * with a valid external IP address is specified, it must match that of the - * networkTier associated with the Address resource owning that IP. + * This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. */ networkTier?: string; /** @@ -475,18 +439,15 @@ export namespace compute_alpha { */ publicDnsName?: string; /** - * The DNS domain name for the public PTR record. This field can only be set - * when the set_public_ptr field is enabled. + * The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. */ publicPtrDomainName?: string; /** - * Specifies whether a public DNS ?A? record should be created for the - * external IP address of this access configuration. + * Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. */ setPublicDns?: boolean; /** - * Specifies whether a public DNS ?PTR? record should be created to map the - * external IP address of the instance to a DNS domain name. + * Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name. */ setPublicPtr?: boolean; /** @@ -495,9 +456,7 @@ export namespace compute_alpha { type?: string; } /** - * A reserved address resource. (== resource_for beta.addresses ==) (== - * resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== - * resource_for v1.globalAddresses ==) + * A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) */ export interface Schema$Address { /** @@ -505,8 +464,7 @@ export namespace compute_alpha { */ address?: string; /** - * The type of address to reserve, either INTERNAL or EXTERNAL. If - * unspecified, defaults to EXTERNAL. + * The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. */ addressType?: string; /** @@ -514,18 +472,15 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The IP Version that will be used by this address. Valid options are IPV4 - * or IPV6. This can only be specified for a global address. + * The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ ipVersion?: string; /** @@ -533,44 +488,23 @@ export namespace compute_alpha { */ kind?: string; /** - * A fingerprint for the labels being applied to this Address, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an Address. + * A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. */ labelFingerprint?: string; /** - * Labels to apply to this Address resource. These can be later modified by - * the setLabels method. Each label key/value must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network in which to reserve the address. This field can - * only be used with INTERNAL type with VPC_PEERING purpose. + * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. */ network?: string; /** - * This signifies the networking tier used for configuring this Address and - * can only take the following values: PREMIUM, STANDARD. Global forwarding - * rules can only be Premium Tier. Regional forwarding rules can be either - * Premium or Standard Tier. Standard Tier addresses applied to regional - * forwarding rules can be used with any external load balancer. Regional - * forwarding rules in Premium Tier can only be used with a Network load - * balancer. If this field is not specified, it is assumed to be PREMIUM. + * This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ networkTier?: string; /** @@ -582,10 +516,7 @@ export namespace compute_alpha { */ purpose?: string; /** - * [Output Only] URL of the region where the regional address resides. This - * field is not applicable to global addresses. You must specify this field - * as part of the HTTP request URL. You cannot set this field in the request - * body. + * [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. */ region?: string; /** @@ -597,18 +528,11 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The status of the address, which can be one of RESERVING, - * RESERVED, or IN_USE. An address that is RESERVING is currently in the - * process of being reserved. A RESERVED address is currently reserved and - * available to use. An IN_USE address is currently being used by another - * resource and is not available. + * [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. */ status?: string; /** - * The URL of the subnetwork in which to reserve the address. If an IP - * address is specified, it must be within the subnetwork's IP range. - * This field can only be used with INTERNAL type with - * GCE_ENDPOINT/DNS_RESOLVER purposes. + * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. */ subnetwork?: string; /** @@ -626,16 +550,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$AddressesScopedList}; /** - * [Output Only] Type of resource. Always compute#addressAggregatedList for - * aggregated lists of addresses. + * [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -657,8 +576,7 @@ export namespace compute_alpha { */ addresses?: Schema$Address[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -679,16 +597,11 @@ export namespace compute_alpha { */ items?: Schema$Address[]; /** - * [Output Only] Type of resource. Always compute#addressList for lists of - * addresses. + * [Output Only] Type of resource. Always compute#addressList for lists of addresses. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -709,17 +622,11 @@ export namespace compute_alpha { */ export interface Schema$AliasIpRange { /** - * The IP CIDR range represented by this alias IP range. This IP CIDR range - * must belong to the specified subnetwork and cannot contain IP addresses - * reserved by system or used by other network interfaces. This range may be - * a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR - * format string (e.g. 10.1.2.0/24). + * The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). */ ipCidrRange?: string; /** - * Optional subnetwork secondary range name specifying the secondary range - * from which to allocate the IP CIDR range for this alias IP range. If left - * unspecified, the primary range of the subnetwork will be used. + * Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. */ subnetworkRangeName?: string; } @@ -729,9 +636,7 @@ export namespace compute_alpha { */ diskSizeGb?: string; /** - * Specifies the disk interface to use for attaching this disk, which is - * either SCSI or NVME. The default is SCSI. For performance characteristics - * of SCSI over NVMe, see Local SSD performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ interface?: string; } @@ -744,14 +649,11 @@ export namespace compute_alpha { */ guestAccelerators?: Schema$AcceleratorConfig[]; /** - * Specifies amount of local ssd to reserve with each instance. The type of - * disk is local-ssd. + * Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. */ localSsds?: Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk[]; /** - * Specifies type of machine (name only) which has fixed number of vCPUs and - * fixed amount of memory. This also includes specifying custom machine type - * following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. + * Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. */ machineType?: string; /** @@ -760,8 +662,7 @@ export namespace compute_alpha { minCpuPlatform?: string; } /** - * This reservation type allows to pre allocate specific instance - * configuration. + * This reservation type allows to pre allocate specific instance configuration. */ export interface Schema$AllocationSpecificSKUReservation { /** @@ -782,79 +683,43 @@ export namespace compute_alpha { */ export interface Schema$AttachedDisk { /** - * Specifies whether the disk will be auto-deleted when the instance is - * deleted (but not when the disk is detached from the instance). + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ autoDelete?: boolean; /** - * Indicates that this is a boot disk. The virtual machine will use the - * first partition of the disk for its root filesystem. + * Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. */ boot?: boolean; /** - * Specifies a unique device name of your choice that is reflected into the - * /dev/disk/by-id/google-* tree of a Linux operating system running within - * the instance. This name can be used to reference the device for mounting, - * resizing, and so on, from within the instance. If not specified, the - * server chooses a default device name to apply to this disk, in the form - * persistent-disk-x, where x is a number assigned by Google Compute Engine. - * This field is only applicable for persistent disks. + * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. */ deviceName?: string; /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If - * you are creating a new disk, this field encrypts the new disk using an - * encryption key that you provide. If you are attaching an existing disk - * that is already encrypted, this field decrypts the disk using the - * customer-supplied encryption key. If you encrypt a disk using a - * customer-supplied key, you must provide the same key again when you - * attempt to use this resource at a later time. For example, you must - * provide the key when you create a snapshot or an image from the disk or - * when you attach the disk to a virtual machine instance. If you do not - * provide an encryption key, then the disk will be encrypted using an - * automatically generated key and you do not need to provide a key to use - * the disk later. Instance templates do not store customer-supplied - * encryption keys, so you cannot use your own keys to encrypt disks in a - * managed instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The size of the disk in base-2 GB. This supersedes disk_size_gb in - * InitializeParams. + * The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. */ diskSizeGb?: string; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] A zero-based index to this disk, where 0 is reserved for - * the boot disk. If you have many disks attached to an instance, each disk - * would have a unique index number. + * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. */ index?: number; /** - * [Input Only] Specifies the parameters for a new disk that will be created - * alongside the new instance. Use initialization parameters to create boot - * disks or local SSDs attached to the new instance. This property is - * mutually exclusive with the source property; you can only define one or - * the other, but not both. + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ initializeParams?: Schema$AttachedDiskInitializeParams; /** - * Specifies the disk interface to use for attaching this disk, which is - * either SCSI or NVME. The default is SCSI. Persistent disks must always - * use SCSI and the request will fail if you attempt to attach a persistent - * disk in any other format than SCSI. Local SSDs can use either NVME or - * SCSI. For performance characteristics of SCSI over NVMe, see Local SSD - * performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ interface?: string; /** - * [Output Only] Type of the resource. Always compute#attachedDisk for - * attached disks. + * [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. */ kind?: string; /** @@ -862,15 +727,11 @@ export namespace compute_alpha { */ licenses?: string[]; /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - * not specified, the default is to attach the disk in READ_WRITE mode. + * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. */ mode?: string; /** - * For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this - * field is set to PRESERVED if the LocalSSD data has been saved to a - * persistent location by customer request. (see the discard_local_ssd - * option on Stop/Suspend). Read-only in the api. + * For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api. */ savedState?: string; /** @@ -878,27 +739,16 @@ export namespace compute_alpha { */ shieldedInstanceInitialState?: Schema$InitialStateConfig; /** - * Specifies a valid partial or full URL to an existing Persistent Disk - * resource. When creating a new instance, one of - * initializeParams.sourceImage or disks.source is required except for local - * SSD. If desired, you can also attach existing non-root persistent disks - * using this property. This field is only applicable for persistent disks. - * Note that for InstanceTemplate, specify the disk name, not the URL for - * the disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. */ source?: string; /** - * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - * specified, the default is PERSISTENT. + * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. */ type?: string; } /** - * [Input Only] Specifies the parameters for a new disk that will be created - * alongside the new instance. Use initialization parameters to create boot - * disks or local SSDs attached to the new instance. This property is - * mutually exclusive with the source property; you can only define one or the - * other, but not both. + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ export interface Schema$AttachedDiskInitializeParams { /** @@ -906,9 +756,7 @@ export namespace compute_alpha { */ description?: string; /** - * Specifies the disk name. If not specified, the default is to use the name - * of the instance. If the disk with the instance name exists already in the - * given zone/region, a new name will be automatically generated. + * Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. */ diskName?: string; /** @@ -916,74 +764,35 @@ export namespace compute_alpha { */ diskSizeGb?: string; /** - * Specifies the disk type to use to create the instance. If not specified, - * the default is pd-standard, specified using the full URL. For example: - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard - * Other values include pd-ssd and local-ssd. If you define this field, you - * can provide either the full or partial URL. For example, the following - * are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - * - projects/project/zones/zone/diskTypes/diskType - - * zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is - * the name of the disk type, not URL. + * Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. */ diskType?: string; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. Guest OS features are applied by - * merging initializeParams.guestOsFeatures and disks.guestOsFeatures + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * Labels to apply to this disk. These can be later modified by the - * disks.setLabels method. This field is only applicable for persistent - * disks. + * Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. */ labels?: {[key: string]: string}; /** - * URLs of the zones where the disk should be replicated to. Only applicable - * for regional resources. + * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ replicaZones?: string[]; /** - * Resource policies applied to this disk for automatic snapshot creations. - * Specified using the full or partial URL. For instance template, specify - * only the resource policy name. + * Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. */ resourcePolicies?: string[]; /** - * The source image to create this disk. When creating a new instance, one - * of initializeParams.sourceImage or disks.source is required except for - * local SSD. To create a disk with one of the public operating system - * images, specify the image by its family name. For example, specify - * family/debian-9 to use the latest Debian 9 image: - * projects/debian-cloud/global/images/family/debian-9 Alternatively, use - * a specific version of a public operating system image: - * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To - * create a disk with a custom image that you created, specify the image - * name in the following format: global/images/my-custom-image You can - * also specify a custom image by its image family, which returns the latest - * version of the image in that family. Replace the image name with - * family/family-name: global/images/family/my-image-family If the source - * image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. Instance - * templates do not store customer-supplied encryption keys, so you cannot - * create disks for instances in a managed instance group if the source - * images are encrypted with your own keys. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The source snapshot to create this disk. When creating a new instance, - * one of initializeParams.sourceSnapshot or disks.source is required except - * for local SSD. To create a disk with a snapshot that you created, - * specify the snapshot name in the following format: - * global/snapshots/my-backup If the source snapshot is deleted later, - * this field will not be set. + * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. */ sourceSnapshot?: string; /** @@ -992,26 +801,7 @@ export namespace compute_alpha { sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { "log_type": - * "ADMIN_READ", } ] }, { "service": - * "fooservice.googleapis.com" "audit_log_configs": [ { - * "log_type": "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy - * enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - * foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE - * logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -1020,25 +810,16 @@ export namespace compute_alpha { auditLogConfigs?: Schema$AuditLogConfig[]; exemptedMembers?: string[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { "log_type": - * "DATA_WRITE", } ] } This enables 'DATA_READ' and - * 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ - * logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of [Binding.members][]. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[]; /** @@ -1051,42 +832,24 @@ export namespace compute_alpha { */ export interface Schema$AuthenticationPolicy { /** - * List of authentication methods that can be used for origin - * authentication. Similar to peers, these will be evaluated in order the - * first valid one will be used to set origin identity. If none of these - * methods pass, the request will be rejected with authentication failed - * error (401). Leave the list empty if origin authentication is not - * required. + * List of authentication methods that can be used for origin authentication. Similar to peers, these will be evaluated in order the first valid one will be used to set origin identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if origin authentication is not required. */ origins?: Schema$OriginAuthenticationMethod[]; /** - * List of authentication methods that can be used for peer authentication. - * They will be evaluated in order the first valid one will be used to set - * peer identity. If none of these methods pass, the request will be - * rejected with authentication failed error (401). Leave the list empty if - * peer authentication is not required. + * List of authentication methods that can be used for peer authentication. They will be evaluated in order the first valid one will be used to set peer identity. If none of these methods pass, the request will be rejected with authentication failed error (401). Leave the list empty if peer authentication is not required. */ peers?: Schema$PeerAuthenticationMethod[]; /** - * Define whether peer or origin identity should be used for principal. - * Default value is USE_PEER. If peer (or origin) identity is not available, - * either because peer/origin authentication is not defined, or failed, - * principal will be left unset. In other words, binding rule does not - * affect the decision to accept or reject request. This field can be set to - * one of the following: USE_PEER: Principal will be set to the identity - * from peer authentication. USE_ORIGIN: Principal will be set to the - * identity from origin authentication. + * Define whether peer or origin identity should be used for principal. Default value is USE_PEER. If peer (or origin) identity is not available, either because peer/origin authentication is not defined, or failed, principal will be left unset. In other words, binding rule does not affect the decision to accept or reject request. This field can be set to one of the following: USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal will be set to the identity from origin authentication. */ principalBinding?: string; /** - * Configures the mechanism to obtain server-side security certificates and - * identity information. + * Configures the mechanism to obtain server-side security certificates and identity information. */ serverTlsContext?: Schema$TlsContext; } /** - * Authorization configuration provides service-level and method-level access - * control for a service. + * Authorization configuration provides service-level and method-level access control for a service. */ export interface Schema$AuthorizationConfig { /** @@ -1104,20 +867,11 @@ export namespace compute_alpha { permissionType?: string; } /** - * Represents an Autoscaler resource. Autoscalers allow you to automatically - * scale virtual machine instances in managed instance groups according to an - * autoscaling policy that you define. For more information, read Autoscaling - * Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for - * v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== - * resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** - * The configuration parameters for the autoscaling algorithm. You can - * define one or more of the policies for an autoscaler: cpuUtilization, - * customMetricUtilizations, and loadBalancingUtilization. If none of these - * are specified, the default will be to autoscale based on cpuUtilization - * to 0.6 or 60%. + * The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. */ autoscalingPolicy?: Schema$AutoscalingPolicy; /** @@ -1125,41 +879,27 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#autoscaler for - * autoscalers. + * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] Target recommended MIG size (number of instances) computed - * by autoscaler. Autoscaler calculates recommended MIG size even when - * autoscaling policy mode is different from ON. This field is empty when - * autoscaler is not connected to the existing managed instance group or - * autoscaler did not generate its prediction. + * [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction. */ recommendedSize?: number; /** - * [Output Only] URL of the region where the instance group resides (for - * autoscalers living in regional scope). + * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). */ region?: string; /** @@ -1175,9 +915,7 @@ export namespace compute_alpha { */ status?: string; /** - * [Output Only] Human-readable details about the current state of the - * autoscaler. Read the documentation for Commonly returned status messages - * for examples of status messages you might encounter. + * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. */ statusDetails?: Schema$AutoscalerStatusDetails[]; /** @@ -1185,8 +923,7 @@ export namespace compute_alpha { */ target?: string; /** - * [Output Only] URL of the zone where the instance group resides (for - * autoscalers living in zonal scope). + * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). */ zone?: string; } @@ -1200,16 +937,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$AutoscalersScopedList}; /** - * [Output Only] Type of resource. Always compute#autoscalerAggregatedList - * for aggregated lists of autoscalers. + * [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1238,16 +970,11 @@ export namespace compute_alpha { */ items?: Schema$Autoscaler[]; /** - * [Output Only] Type of resource. Always compute#autoscalerList for lists - * of autoscalers. + * [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1269,8 +996,7 @@ export namespace compute_alpha { */ autoscalers?: Schema$Autoscaler[]; /** - * [Output Only] Informational warning which replaces the list of - * autoscalers when the list is empty. + * [Output Only] Informational warning which replaces the list of autoscalers when the list is empty. */ warning?: { code?: string; @@ -1293,19 +1019,11 @@ export namespace compute_alpha { */ export interface Schema$AutoscalingPolicy { /** - * The number of seconds that the autoscaler should wait before it starts - * collecting information from a new instance. This prevents the autoscaler - * from collecting information when the instance is initializing, during - * which the collected usage would not be reliable. The default time - * autoscaler waits is 60 seconds. Virtual machine initialization times - * might vary because of numerous factors. We recommend that you test how - * long an instance may take to initialize. To do this, create an instance - * and time the startup process. + * The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. */ coolDownPeriodSec?: number; /** - * Defines the CPU utilization policy that allows the autoscaler to scale - * based on the average CPU utilization of a managed instance group. + * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. */ cpuUtilization?: Schema$AutoscalingPolicyCpuUtilization; /** @@ -1317,15 +1035,11 @@ export namespace compute_alpha { */ loadBalancingUtilization?: Schema$AutoscalingPolicyLoadBalancingUtilization; /** - * The maximum number of instances that the autoscaler can scale up to. This - * is required when creating or updating an autoscaler. The maximum number - * of replicas should not be lower than minimal number of replicas. + * The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. */ maxNumReplicas?: number; /** - * The minimum number of replicas that the autoscaler can scale down to. - * This cannot be less than 0. If not provided, autoscaler will choose a - * default value depending on maximum number of instances allowed. + * The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. */ minNumReplicas?: number; /** @@ -1342,15 +1056,7 @@ export namespace compute_alpha { */ export interface Schema$AutoscalingPolicyCpuUtilization { /** - * The target CPU utilization that the autoscaler should maintain. Must be a - * float value in the range (0, 1]. If not specified, the default is 0.6. If - * the CPU level is below the target utilization, the autoscaler scales down - * the number of instances until it reaches the minimum number of instances - * you specified or until the average CPU of your instances reaches the - * target utilization. If the average CPU is above the target utilization, - * the autoscaler scales up until it reaches the maximum number of instances - * you specified or until the average utilization reaches the target - * utilization. + * The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. */ utilizationTarget?: number; } @@ -1359,64 +1065,23 @@ export namespace compute_alpha { */ export interface Schema$AutoscalingPolicyCustomMetricUtilization { /** - * A filter string, compatible with a Stackdriver Monitoring filter string - * for TimeSeries.list API call. This filter is used to select a specific - * TimeSeries for the purpose of autoscaling and to determine whether the - * metric is exporting per-instance or per-group data. For the filter to be - * valid for autoscaling purposes, the following rules apply: - You can - * only use the AND operator for joining selectors. - You can only use - * direct equality comparison operator (=) without any functions for each - * selector. - You can specify the metric in both the filter string and in - * the metric field. However, if specified in both places, the metric must - * be identical. - The monitored resource type determines what kind of - * values are expected for the metric. If it is a gce_instance, the - * autoscaler expects the metric to include a separate TimeSeries for each - * instance in a group. In such a case, you cannot filter on resource - * labels. If the resource type is any other value, the autoscaler expects - * this metric to contain values that apply to the entire autoscaled - * instance group and resource label filtering can be performed to point - * autoscaler at the correct TimeSeries to scale upon. This is called a - * per-group metric for the purpose of autoscaling. If not specified, the - * type defaults to gce_instance. You should provide a filter that is - * selective enough to pick just one TimeSeries for the autoscaled group or - * for each of the instances (if you are using gce_instance resource type). - * If multiple TimeSeries are returned upon the query execution, the - * autoscaler will sum their respective values to obtain its scaling value. + * A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value. */ filter?: string; /** - * The identifier (type) of the Stackdriver Monitoring metric. The metric - * cannot have negative values. The metric must have a value type of INT64 - * or DOUBLE. + * The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. */ metric?: string; /** - * If scaling is based on a per-group metric value that represents the total - * amount of work to be done or resource usage, set this value to an amount - * assigned for a single instance of the scaled group. Autoscaler will keep - * the number of instances proportional to the value of this metric, the - * metric itself should not change value due to group resizing. A good - * metric to use with the target is for example - * pubsub.googleapis.com/subscription/num_undelivered_messages or a custom - * metric exporting the total number of requests coming to your instances. - * A bad example would be a metric exporting an average or median latency, - * since this value can't include a chunk assignable to a single - * instance, it could be better used with utilization_target instead. + * If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead. */ singleInstanceAssignment?: number; /** - * The target value of the metric that autoscaler should maintain. This must - * be a positive value. A utilization metric scales number of virtual - * machines handling requests to increase or decrease proportionally to the - * metric. For example, a good metric to use as a utilization_target is - * compute.googleapis.com/instance/network/received_bytes_count. The - * autoscaler will work to keep this value constant for each of the - * instances. + * The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances. */ utilizationTarget?: number; /** - * Defines how target utilization value is expressed for a Stackdriver - * Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + * Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. */ utilizationTargetType?: string; } @@ -1425,9 +1090,7 @@ export namespace compute_alpha { */ export interface Schema$AutoscalingPolicyLoadBalancingUtilization { /** - * Fraction of backend capacity utilization (set in HTTP(S) load balancing - * configuration) that autoscaler should maintain. Must be a positive float - * value. If not defined, the default is 0.8. + * Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. */ utilizationTarget?: number; } @@ -1436,11 +1099,7 @@ export namespace compute_alpha { */ export interface Schema$AutoscalingPolicyQueueBasedScaling { /** - * Scaling based on the average number of tasks in the queue per each active - * instance. The autoscaler keeps the average number of tasks per instance - * below this number, based on data collected in the last couple of minutes. - * The autoscaler will also take into account incoming tasks when - * calculating when to scale. + * Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale. */ acceptableBacklogPerInstance?: number; /** @@ -1448,30 +1107,20 @@ export namespace compute_alpha { */ cloudPubSub?: Schema$AutoscalingPolicyQueueBasedScalingCloudPubSub; /** - * The scaling algorithm will also calculate throughput estimates on its - * own; if you explicitly provide this value, the autoscaler will take into - * account your value as well as automatic estimates when deciding how to - * scale. + * The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale. */ singleWorkerThroughputPerSec?: number; } /** - * Configuration parameters for scaling based on Cloud Pub/Sub subscription - * queue. + * Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. */ export interface Schema$AutoscalingPolicyQueueBasedScalingCloudPubSub { /** - * Cloud Pub/Sub subscription used for scaling. Provide the partial URL - * (starting with projects/) or just the subscription name. The subscription - * must be assigned to the topic specified in topicName and must be in a - * pull configuration. The subscription must belong to the same project as - * the Autoscaler. + * Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler. */ subscription?: string; /** - * Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial - * URL (starting with projects/) or just the topic name. The topic must - * belong to the same project as the Autoscaler resource. + * Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource. */ topic?: string; } @@ -1480,100 +1129,51 @@ export namespace compute_alpha { */ export interface Schema$Backend { /** - * Specifies the balancing mode for this backend. For global HTTP(S) or - * TCP/SSL load balancing, the default is UTILIZATION. Valid values are - * UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For - * Internal Load Balancing, the default and only supported mode is - * CONNECTION. + * Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION. */ balancingMode?: string; /** - * A multiplier applied to the group's maximum servicing capacity (based - * on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the - * group will serve up to 100% of its configured capacity (depending on - * balancingMode). A setting of 0 means the group is completely drained, - * offering 0% of its available Capacity. Valid range is [0.0,1.0]. This - * cannot be used for internal load balancing. + * A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing. */ capacityScaler?: number; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * This field designates whether this is a failover backend. More than one - * failover backend can be configured for a given BackendService. + * This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. */ failover?: boolean; /** - * The fully-qualified URL of an Instance Group or Network Endpoint Group - * resource. In case of instance group this defines the list of instances - * that serve traffic. Member virtual machine instances from each instance - * group must live in the same zone as the instance group itself. No two - * backends in a backend service are allowed to use same Instance Group - * resource. For Network Endpoint Groups this defines list of endpoints. - * All endpoints of Network Endpoint Group must be hosted on instances - * located in the same zone as the Network Endpoint Group. Backend service - * can not contain mix of Instance Group and Network Endpoint Group - * backends. Note that you must specify an Instance Group or Network - * Endpoint Group resource using the fully-qualified URL, rather than a - * partial URL. When the BackendService has load balancing scheme INTERNAL, - * the instance group must be within the same region as the BackendService. - * Network Endpoint Groups are not supported for INTERNAL load balancing - * scheme. + * The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend service can not contain mix of Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL. When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme. */ group?: string; /** - * The max number of simultaneous connections for the group. Can be used - * with either CONNECTION or UTILIZATION balancing modes. For CONNECTION - * mode, either maxConnections or maxConnectionsPerInstance must be set. - * This cannot be used for internal load balancing. + * The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. */ maxConnections?: number; /** - * The max number of simultaneous connections that a single backend network - * endpoint can handle. This is used to calculate the capacity of the group. - * Can be used in either CONNECTION or UTILIZATION balancing modes. For - * CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must - * be set. This cannot be used for internal load balancing. + * The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. This cannot be used for internal load balancing. */ maxConnectionsPerEndpoint?: number; /** - * The max number of simultaneous connections that a single backend instance - * can handle. This is used to calculate the capacity of the group. Can be - * used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION - * mode, either maxConnections or maxConnectionsPerInstance must be set. - * This cannot be used for internal load balancing. + * The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. */ maxConnectionsPerInstance?: number; /** - * The max requests per second (RPS) of the group. Can be used with either - * RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE - * mode, either maxRate or maxRatePerInstance must be set. This cannot be - * used for internal load balancing. + * The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ maxRate?: number; /** - * The max requests per second (RPS) that a single backend network endpoint - * can handle. This is used to calculate the capacity of the group. Can be - * used in either balancing mode. For RATE mode, either maxRate or - * maxRatePerEndpoint must be set. This cannot be used for internal load - * balancing. + * The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. This cannot be used for internal load balancing. */ maxRatePerEndpoint?: number; /** - * The max requests per second (RPS) that a single backend instance can - * handle. This is used to calculate the capacity of the group. Can be used - * in either balancing mode. For RATE mode, either maxRate or - * maxRatePerInstance must be set. This cannot be used for internal load - * balancing. + * The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ maxRatePerInstance?: number; /** - * Used when balancingMode is UTILIZATION. This ratio defines the CPU - * utilization target for the group. The default is 0.8. Valid range is - * [0.0, 1.0]. This cannot be used for internal load balancing. + * Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing. */ maxUtilization?: number; } @@ -1594,8 +1194,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** @@ -1611,13 +1210,7 @@ export namespace compute_alpha { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -1634,13 +1227,7 @@ export namespace compute_alpha { */ export interface Schema$BackendBucketCdnPolicy { /** - * Maximum number of seconds the response to a signed URL request will be - * considered fresh. After this time period, the response will be - * revalidated before being served. Defaults to 1hr (3600s). When serving - * responses to signed URL requests, Cloud CDN will internally behave as - * though all responses from this backend had a "Cache-Control: public, - * max-age=[TTL]" header, regardless of any existing Cache-Control - * header. The actual headers served in responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** @@ -1665,11 +1252,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1686,22 +1269,15 @@ export namespace compute_alpha { }; } /** - * A BackendService resource. This resource defines a group of backend virtual - * machines and their serving capacity. (== resource_for v1.backendService ==) - * (== resource_for beta.backendService ==) + * A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) */ export interface Schema$BackendService { /** - * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. - * If set to 0, the cookie is non-persistent and lasts only until the end of - * the browser session (or equivalent). The maximum allowed value for TTL is - * one day. When the load balancing scheme is INTERNAL, this field is not - * used. + * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used. */ affinityCookieTtlSec?: number; /** - * Directs request to an App Engine app. cloudFunctionBackend and backends[] - * must be empty if this is set. + * Directs request to an App Engine app. cloudFunctionBackend and backends[] must be empty if this is set. */ appEngineBackend?: Schema$BackendServiceAppEngineBackend; /** @@ -1713,31 +1289,16 @@ export namespace compute_alpha { */ cdnPolicy?: Schema$BackendServiceCdnPolicy; /** - * Settings controlling the volume of connections to a backend service. This - * field is applicable to either: - A regional backend service with the - * service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme - * set to INTERNAL_MANAGED. - A global backend service with the - * load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * Settings controlling the volume of connections to a backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ circuitBreakers?: Schema$CircuitBreakers; /** - * Directs request to a cloud function. appEngineBackend and backends[] must - * be empty if this is set. + * Directs request to a cloud function. appEngineBackend and backends[] must be empty if this is set. */ cloudFunctionBackend?: Schema$BackendServiceCloudFunctionBackend; connectionDraining?: Schema$ConnectionDraining; /** - * Consistent Hash-based load balancing can be used to provide soft session - * affinity based on HTTP headers, cookies or other properties. This load - * balancing policy is applicable only for HTTP connections. The affinity to - * a particular destination host will be lost when one or more hosts are - * added/removed from the destination service. This field specifies - * parameters that control consistent hashing. This field is only applicable - * when localityLbPolicy is set to MAGLEV or RING_HASH. This field is - * applicable to either: - A regional backend service with the - * service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme - * set to INTERNAL_MANAGED. - A global backend service with the - * load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ consistentHash?: Schema$ConsistentHashLoadBalancerSettings; /** @@ -1749,138 +1310,73 @@ export namespace compute_alpha { */ customRequestHeaders?: string[]; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * If true, enable Cloud CDN for this BackendService. When the load - * balancing scheme is INTERNAL, this field is not used. + * If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used. */ enableCDN?: boolean; failoverPolicy?: Schema$BackendServiceFailoverPolicy; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a BackendService. An up-to-date fingerprint must - * be provided in order to update the BackendService, otherwise the request - * will fail with error 412 conditionNotMet. To see the latest fingerprint, - * make a get() request to retrieve a BackendService. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. */ fingerprint?: string; /** - * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for - * health checking this BackendService. Currently at most one health check - * can be specified, and a health check is required for Compute Engine - * backend services. A health check must not be specified for App Engine - * backend and Cloud Function backend. For internal load balancing, a URL - * to a HealthCheck resource must be specified instead. + * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ healthChecks?: string[]; iap?: Schema$BackendServiceIAP; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#backendService for backend - * services. + * [Output Only] Type of resource. Always compute#backendService for backend services. */ kind?: string; /** - * Indicates whether the backend service will be used with internal or - * external load balancing. A backend service created for one type of load - * balancing cannot be used with the other. Possible values are INTERNAL and - * EXTERNAL. + * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. */ loadBalancingScheme?: string; /** - * The load balancing algorithm used within the scope of the locality. The - * possible values are: - ROUND_ROBIN: This is a simple policy in which - * each healthy backend is selected in round robin order. This is the - * default. - LEAST_REQUEST: An O(1) algorithm which selects two random - * healthy hosts and picks the host which has fewer active requests. - - * RING_HASH: The ring/modulo hash load balancer implements consistent - * hashing to backends. The algorithm has the property that the - * addition/removal of a host from a set of N hosts only affects 1/N of the - * requests. - RANDOM: The load balancer selects a random healthy host. - - * ORIGINAL_DESTINATION: Backend host is selected based on the client - * connection metadata, i.e., connections are opened to the same address as - * the destination address of the incoming connection before the connection - * was redirected to the load balancer. - MAGLEV: used as a drop in - * replacement for the ring hash load balancer. Maglev is not as stable as - * ring hash but has faster table lookup build times and host selection - * times. For more information about Maglev, refer to - * https://ai.google/research/pubs/pub44824 This field is applicable to - * either: - A regional backend service with the service_protocol set to - * HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - * - A global backend service with the load_balancing_scheme set to - * INTERNAL_SELF_MANAGED. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ localityLbPolicy?: string; /** - * This field denotes the logging options for the load balancer traffic - * served by this backend service. If logging is enabled, logs will be - * exported to Stackdriver. + * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. */ logConfig?: Schema$BackendServiceLogConfig; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Settings controlling eviction of unhealthy hosts from the load balancing - * pool. This field is applicable to either: - A regional backend service - * with the service_protocol set to HTTP, HTTPS, or HTTP2, and - * load_balancing_scheme set to INTERNAL_MANAGED. - A global backend - * service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ outlierDetection?: Schema$OutlierDetection; /** - * Deprecated in favor of portName. The TCP port to connect on the backend. - * The default value is 80. This cannot be used for internal load - * balancing. + * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used for internal load balancing. */ port?: number; /** - * Name of backend port. The same name should appear in the instance groups - * referenced by this service. Required when the load balancing scheme is - * EXTERNAL. When the load balancing scheme is INTERNAL, this field is not - * used. + * Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used. */ portName?: string; /** - * The protocol this BackendService uses to communicate with backends. - * Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For - * internal load balancing, the possible values are TCP and UDP, and the - * default is TCP. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP. */ protocol?: string; /** - * [Output Only] URL of the region where the regional backend service - * resides. This field is not applicable to global backend services. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * [Output Only] The resource URL for the security policy associated with - * this backend service. + * [Output Only] The resource URL for the security policy associated with this backend service. */ securityPolicy?: string; /** - * This field specifies the security policy that applies to this backend - * service. This field is applicable to either: - A regional backend - * service with the service_protocol set to HTTP, HTTPS, or HTTP2, and - * load_balancing_scheme set to INTERNAL_MANAGED. - A global backend - * service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * This field specifies the security policy that applies to this backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ securitySettings?: Schema$SecuritySettings; /** @@ -1892,16 +1388,11 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * Type of session affinity to use. The default is NONE. When the load - * balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or - * GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be - * NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the - * protocol is UDP, this field is not used. + * Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used. */ sessionAffinity?: string; /** - * How many seconds to wait for the backend before considering it a failed - * request. Default is 30 seconds. + * How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. */ timeoutSec?: number; } @@ -1922,11 +1413,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1951,13 +1438,11 @@ export namespace compute_alpha { */ appEngineService?: string; /** - * Required. Project ID of the project hosting the app. This is the project - * ID of this project. Reference to another project is not allowed. + * Required. Project ID of the project hosting the app. This is the project ID of this project. Reference to another project is not allowed. */ targetProject?: string; /** - * Optional. Version of App Engine app service. When empty, App Engine will - * do its normal traffic split. + * Optional. Version of App Engine app service. When empty, App Engine will do its normal traffic split. */ version?: string; } @@ -1970,13 +1455,7 @@ export namespace compute_alpha { */ cacheKeyPolicy?: Schema$CacheKeyPolicy; /** - * Maximum number of seconds the response to a signed URL request will be - * considered fresh. After this time period, the response will be - * revalidated before being served. Defaults to 1hr (3600s). When serving - * responses to signed URL requests, Cloud CDN will internally behave as - * though all responses from this backend had a "Cache-Control: public, - * max-age=[TTL]" header, regardless of any existing Cache-Control - * header. The actual headers served in responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** @@ -1989,8 +1468,7 @@ export namespace compute_alpha { */ export interface Schema$BackendServiceCloudFunctionBackend { /** - * Required. A cloud function name. Special value ?*? represents all cloud - * functions in the project. + * Required. A cloud function name. Special value ?*? represents all cloud functions in the project. */ functionName?: string; /** @@ -2000,31 +1478,15 @@ export namespace compute_alpha { } export interface Schema$BackendServiceFailoverPolicy { /** - * On failover or failback, this field indicates whether connection drain - * will be honored. Setting this to true has the following effect: - * connections to the old active pool are not drained. Connections to the - * new active pool use the timeout of 10 min (currently fixed). Setting to - * false has the following effect: both old and new connections will have a - * drain timeout of 10 min. This can be set to true only if the protocol is - * TCP. The default is false. + * On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false. */ disableConnectionDrainOnFailover?: boolean; /** - * This option is used only when no healthy VMs are detected in the primary - * and backup instance groups. When set to true, traffic is dropped. When - * set to false, new connections are sent across all VMs in the primary - * group. The default is false. + * This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false. */ dropTrafficIfUnhealthy?: boolean; /** - * The value of the field must be in [0, 1]. If the ratio of the healthy VMs - * in the primary backend is at or below this number, traffic arriving at - * the load-balanced IP will be directed to the failover backend. In case - * where 'failoverRatio' is not set or all the VMs in the backup - * backend are unhealthy, the traffic will be directed back to the primary - * backend in the "force" mode, where traffic will be spread to - * the healthy VMs with the best effort, or to all VMs when no VM is - * healthy. This field is only used with l4 load balancing. + * The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing. */ failoverRatio?: number; } @@ -2034,13 +1496,11 @@ export namespace compute_alpha { */ annotations?: {[key: string]: string}; /** - * Health state of the backend instances or endpoints in requested instance - * or network endpoint group, determined based on configured health checks. + * Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. */ healthStatus?: Schema$HealthStatus[]; /** - * [Output Only] Type of resource. Always compute#backendServiceGroupHealth - * for the health of backend services. + * [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. */ kind?: string; } @@ -2051,8 +1511,7 @@ export namespace compute_alpha { enabled?: boolean; oauth2ClientId?: string; /** - * [Input Only] OAuth client info required to generate client id to be used - * for IAP. + * [Input Only] OAuth client info required to generate client id to be used for IAP. */ oauth2ClientInfo?: Schema$BackendServiceIAPOAuth2ClientInfo; oauth2ClientSecret?: string; @@ -2067,8 +1526,7 @@ export namespace compute_alpha { */ applicationName?: string; /** - * Name of the client to be generated. Optional - If not provided, the name - * will be autogenerated by the backend. + * Name of the client to be generated. Optional - If not provided, the name will be autogenerated by the backend. */ clientName?: string; /** @@ -2089,16 +1547,11 @@ export namespace compute_alpha { */ items?: Schema$BackendService[]; /** - * [Output Only] Type of resource. Always compute#backendServiceList for - * lists of backend services. + * [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2115,21 +1568,15 @@ export namespace compute_alpha { }; } /** - * The available logging options for the load balancer traffic served by this - * backend service. + * The available logging options for the load balancer traffic served by this backend service. */ export interface Schema$BackendServiceLogConfig { /** - * This field denotes whether to enable logging for the load balancer - * traffic served by this backend service. + * This field denotes whether to enable logging for the load balancer traffic served by this backend service. */ enable?: boolean; /** - * This field can only be specified if logging is enabled for this backend - * service. The value of the field must be in [0, 1]. This configures the - * sampling rate of requests to the load balancer where 1.0 means all logged - * requests are reported and 0.0 means no logged requests are reported. The - * default value is 1.0. + * This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0. */ sampleRate?: number; } @@ -2142,8 +1589,7 @@ export namespace compute_alpha { */ backendServices?: Schema$BackendService[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -2156,44 +1602,27 @@ export namespace compute_alpha { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or without - * a Google account. * `allAuthenticatedUsers`: A special identifier that - * represents anyone who is authenticated with a Google account or a service - * account. * `user:{emailid}`: An email address that represents a specific - * Google account. For example, `alice@gmail.com` . * - * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } export interface Schema$CacheInvalidationRule { /** - * If set, this invalidation rule will only apply to requests with a Host - * header matching host. + * If set, this invalidation rule will only apply to requests with a Host header matching host. */ host?: string; path?: string; } /** - * Message containing what to include in the cache key for a request for Cloud - * CDN. + * Message containing what to include in the cache key for a request for Cloud CDN. */ export interface Schema$CacheKeyPolicy { /** @@ -2205,24 +1634,15 @@ export namespace compute_alpha { */ includeProtocol?: boolean; /** - * If true, include query string parameters in the cache key according to - * query_string_whitelist and query_string_blacklist. If neither is set, the - * entire query string will be included. If false, the query string will be - * excluded from the cache key entirely. + * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. */ includeQueryString?: boolean; /** - * Names of query string parameters to exclude in cache keys. All other - * parameters will be included. Either specify query_string_whitelist or - * query_string_blacklist, not both. '&' and '=' will be - * percent encoded and not treated as delimiters. + * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ queryStringBlacklist?: string[]; /** - * Names of query string parameters to include in cache keys. All other - * parameters will be excluded. Either specify query_string_whitelist or - * query_string_blacklist, not both. '&' and '=' will be - * percent encoded and not treated as delimiters. + * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ queryStringWhitelist?: string[]; } @@ -2231,18 +1651,11 @@ export namespace compute_alpha { */ export interface Schema$CallCredentials { /** - * The access token that is used as call credential for the SDS server. This - * field is used only if callCredentialType is ACCESS_TOKEN. + * The access token that is used as call credential for the SDS server. This field is used only if callCredentialType is ACCESS_TOKEN. */ accessToken?: string; /** - * The type of call credentials to use for GRPC requests to the SDS server. - * This field can be set to one of the following: ACCESS_TOKEN: An access - * token is used as call credentials for the SDS server. GCE_VM: The local - * GCE VM service account credentials are used to access the SDS server. - * JWT_SERVICE_TOKEN: The user provisioned service account credentials are - * used to access the SDS server. FROM_PLUGIN: Custom authenticator - * credentials are used to access the SDS server. + * The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: ACCESS_TOKEN: An access token is used as call credentials for the SDS server. GCE_VM: The local GCE VM service account credentials are used to access the SDS server. JWT_SERVICE_TOKEN: The user provisioned service account credentials are used to access the SDS server. FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. */ callCredentialType?: string; /** @@ -2250,9 +1663,7 @@ export namespace compute_alpha { */ fromPlugin?: Schema$MetadataCredentialsFromPlugin; /** - * This service account credentials are used as call credentials for the SDS - * server. This field is used only if callCredentialType is - * JWT_SERVICE_ACCOUNT. + * This service account credentials are used as call credentials for the SDS server. This field is used only if callCredentialType is JWT_SERVICE_ACCOUNT. */ jwtServiceAccount?: Schema$ServiceAccountJwtAccessCredentials; } @@ -2265,10 +1676,7 @@ export namespace compute_alpha { */ certificates?: Schema$TlsCertificatePaths; /** - * The channel credentials to access the SDS server. This field can be set - * to one of the following: CERTIFICATES: Use TLS certificates to access the - * SDS server. GCE_VM: Use local GCE VM credentials to access the SDS - * server. + * The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. */ channelCredentialType?: string; } @@ -2281,76 +1689,49 @@ export namespace compute_alpha { */ connectTimeout?: Schema$Duration; /** - * The maximum number of connections to the backend cluster. If not - * specified, the default is 1024. + * The maximum number of connections to the backend cluster. If not specified, the default is 1024. */ maxConnections?: number; /** - * The maximum number of pending requests allowed to the backend cluster. If - * not specified, the default is 1024. + * The maximum number of pending requests allowed to the backend cluster. If not specified, the default is 1024. */ maxPendingRequests?: number; /** - * The maximum number of parallel requests that allowed to the backend - * cluster. If not specified, the default is 1024. + * The maximum number of parallel requests that allowed to the backend cluster. If not specified, the default is 1024. */ maxRequests?: number; /** - * Maximum requests for a single backend connection. This parameter is - * respected by both the HTTP/1.1 and HTTP/2 implementations. If not - * specified, there is no limit. Setting this parameter to 1 will - * effectively disable keep alive. + * Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. */ maxRequestsPerConnection?: number; /** - * The maximum number of parallel retries allowed to the backend cluster. If - * not specified, the default is 3. + * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 3. */ maxRetries?: number; } /** - * The client side authentication settings for connection originating from the - * backend service. + * The client side authentication settings for connection originating from the backend service. */ export interface Schema$ClientTlsSettings { /** - * Configures the mechanism to obtain client-side security certificates and - * identity information. This field is only applicable when mode is set to - * MUTUAL. + * Configures the mechanism to obtain client-side security certificates and identity information. This field is only applicable when mode is set to MUTUAL. */ clientTlsContext?: Schema$TlsContext; /** - * Indicates whether connections to this port should be secured using TLS. - * The value of this field determines how TLS is enforced. This can be set - * to one of the following values: DISABLE: Do not setup a TLS connection to - * the backends. SIMPLE: Originate a TLS connection to the backends. MUTUAL: - * Secure connections to the backends using mutual TLS by presenting client - * certificates for authentication. + * Indicates whether connections to this port should be secured using TLS. The value of this field determines how TLS is enforced. This can be set to one of the following values: DISABLE: Do not setup a TLS connection to the backends. SIMPLE: Originate a TLS connection to the backends. MUTUAL: Secure connections to the backends using mutual TLS by presenting client certificates for authentication. */ mode?: string; /** - * SNI string to present to the server during TLS handshake. This field is - * applicable only when mode is SIMPLE or MUTUAL. + * SNI string to present to the server during TLS handshake. This field is applicable only when mode is SIMPLE or MUTUAL. */ sni?: string; /** - * A list of alternate names to verify the subject identity in the - * certificate.If specified, the proxy will verify that the server - * certificate's subject alt name matches one of the specified values. - * This field is applicable only when mode is SIMPLE or MUTUAL. + * A list of alternate names to verify the subject identity in the certificate.If specified, the proxy will verify that the server certificate's subject alt name matches one of the specified values. This field is applicable only when mode is SIMPLE or MUTUAL. */ subjectAltNames?: string[]; } /** - * Represents a Commitment resource. Creating a Commitment resource means that - * you are purchasing a committed use contract with an explicit start and end - * time. You can create commitments based on vCPUs and memory usage and - * receive discounted rates. For full details, read Signing Up for Committed - * Use Discounts. Committed use discounts are subject to Google Cloud - * Platform's Service Specific Terms. By purchasing a committed use - * discount, you agree to these terms. Committed use discounts will not renew, - * so you must purchase a new commitment to continue receiving discounts. (== - * resource_for beta.commitments ==) (== resource_for v1.commitments ==) + * Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments ==) (== resource_for v1.commitments ==) */ export interface Schema$Commitment { /** @@ -2358,8 +1739,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -2367,29 +1747,19 @@ export namespace compute_alpha { */ endTimestamp?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#commitment for - * commitments. + * [Output Only] Type of the resource. Always compute#commitment for commitments. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The plan for this commitment, which determines duration and discount - * rate. The currently supported plans are TWELVE_MONTH (1 year), and - * THIRTY_SIX_MONTH (3 years). + * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ plan?: string; /** @@ -2401,8 +1771,7 @@ export namespace compute_alpha { */ reservations?: Schema$Reservation[]; /** - * A list of commitment amounts for particular resources. Note that VCPU and - * MEMORY resource commitments must occur together. + * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. */ resources?: Schema$ResourceCommitment[]; /** @@ -2418,9 +1787,7 @@ export namespace compute_alpha { */ startTimestamp?: string; /** - * [Output Only] Status of the commitment with regards to eventual - * expiration (each commitment has an end date defined). One of the - * following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. */ status?: string; /** @@ -2428,9 +1795,7 @@ export namespace compute_alpha { */ statusMessage?: string; /** - * The type of commitment, which affects the discount rate and the eligible - * resources. Type MEMORY_OPTIMIZED specifies a commitment that will only - * apply to memory optimized machines. + * The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. */ type?: string; } @@ -2444,16 +1809,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$CommitmentsScopedList}; /** - * [Output Only] Type of resource. Always compute#commitmentAggregatedList - * for aggregated lists of commitments. + * [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2482,16 +1842,11 @@ export namespace compute_alpha { */ items?: Schema$Commitment[]; /** - * [Output Only] Type of resource. Always compute#commitmentList for lists - * of commitments. + * [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2513,8 +1868,7 @@ export namespace compute_alpha { */ commitments?: Schema$Commitment[]; /** - * [Output Only] Informational warning which replaces the list of - * commitments when the list is empty. + * [Output Only] Informational warning which replaces the list of commitments when the list is empty. */ warning?: { code?: string; @@ -2539,8 +1893,7 @@ export namespace compute_alpha { */ svc?: string; /** - * Trusted attributes supplied by any service that owns resources and uses - * the IAM system for access control. + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ sys?: string; /** @@ -2553,8 +1906,7 @@ export namespace compute_alpha { */ export interface Schema$ConnectionDraining { /** - * Time for which instance will be drained (not accept new connections, but - * still work to finish started). + * Time for which instance will be drained (not accept new connections, but still work to finish started). */ drainingTimeoutSec?: number; } @@ -2563,28 +1915,20 @@ export namespace compute_alpha { */ export interface Schema$ConsistentHashLoadBalancerSettings { /** - * Hash is based on HTTP Cookie. This field describes a HTTP cookie that - * will be used as the hash key for the consistent hash load balancer. If - * the cookie is not present, it will be generated. This field is applicable - * if the sessionAffinity is set to HTTP_COOKIE. + * Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. */ httpCookie?: Schema$ConsistentHashLoadBalancerSettingsHttpCookie; /** - * The hash based on the value of the specified header field. This field is - * applicable if the sessionAffinity is set to HEADER_FIELD. + * The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD. */ httpHeaderName?: string; /** - * The minimum number of virtual nodes to use for the hash ring. Defaults to - * 1024. Larger ring sizes result in more granular load distributions. If - * the number of hosts in the load balancing pool is larger than the ring - * size, each host will be assigned a single virtual node. + * The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. */ minimumRingSize?: string; } /** - * The information about the HTTP Cookie on which the hash function is based - * for load balancing policies that use a consistent hash. + * The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. */ export interface Schema$ConsistentHashLoadBalancerSettingsHttpCookie { /** @@ -2601,14 +1945,11 @@ export namespace compute_alpha { ttl?: Schema$Duration; } /** - * The specification for allowing client side cross-origin requests. Please - * see W3C Recommendation for Cross Origin Resource Sharing + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing */ export interface Schema$CorsPolicy { /** - * In response to a preflight request, setting this to true indicates that - * the actual request can include user credentials. This translates to the - * Access-Control-Allow-Credentials header. Default is false. + * In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default is false. */ allowCredentials?: boolean; /** @@ -2620,21 +1961,15 @@ export namespace compute_alpha { */ allowMethods?: string[]; /** - * Specifies the regualar expression patterns that match allowed origins. - * For regular expression grammar please see - * en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it - * matches either allow_origins or allow_origin_regex. + * Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex. */ allowOriginRegexes?: string[]; /** - * Specifies the list of origins that will be allowed to do CORS requests. - * An origin is allowed if it matches either allow_origins or - * allow_origin_regex. + * Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex. */ allowOrigins?: string[]; /** - * If true, specifies the CORS policy is disabled. The default value of - * false, which indicates that the CORS policy is in effect. + * If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. */ disabled?: boolean; /** @@ -2642,8 +1977,7 @@ export namespace compute_alpha { */ exposeHeaders?: string[]; /** - * Specifies how long the results of a preflight request can be cached. This - * translates to the content for the Access-Control-Max-Age header. + * Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. */ maxAge?: number; } @@ -2657,36 +1991,25 @@ export namespace compute_alpha { kmsKeyName?: string; kmsKeyServiceAccount?: string; /** - * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - * base64 to either encrypt or decrypt this resource. + * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. */ rawKey?: string; /** - * Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit - * customer-supplied encryption key to either encrypt or decrypt this - * resource. The key must meet the following requirements before you can - * provide it to Compute Engine: - The key is wrapped using a RSA public - * key certificate provided by Google. - After being wrapped, the key must - * be encoded in RFC 4648 base64 encoding. Gets the RSA public key - * certificate provided by Google at: - * https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + * Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: - The key is wrapped using a RSA public key certificate provided by Google. - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem */ rsaEncryptedKey?: string; /** - * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the - * customer-supplied encryption key that protects this resource. + * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. */ sha256?: string; } export interface Schema$CustomerEncryptionKeyProtectedDisk { /** - * Decrypts data associated with the disk with a customer-supplied - * encryption key. + * Decrypts data associated with the disk with a customer-supplied encryption key. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * Specifies a valid partial or full URL to an existing Persistent Disk - * resource. This field is only applicable for persistent disks. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. */ source?: string; } @@ -2695,43 +2018,28 @@ export namespace compute_alpha { */ export interface Schema$DeprecationStatus { /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to DELETED. This is only informational and - * the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. */ deleted?: string; /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to DEPRECATED. This is only informational - * and the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. */ deprecated?: string; /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to OBSOLETE. This is only informational - * and the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. */ obsolete?: string; /** - * The URL of the suggested replacement for a deprecated resource. The - * suggested replacement resource must be the same kind of resource as the - * deprecated resource. + * The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. */ replacement?: string; /** - * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, - * OBSOLETE, or DELETED. Operations which communicate the end of life date - * for an image, can use ACTIVE. Operations which create a new resource - * using a DEPRECATED resource will return successfully, but with a warning - * indicating the deprecated resource and recommending its replacement. - * Operations which use OBSOLETE or DELETED resources will be rejected and - * result in an error. + * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. */ state?: string; } /** - * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks - * ==) + * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==) */ export interface Schema$Disk { /** @@ -2739,30 +2047,19 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Encrypts the disk using a customer-supplied encryption key. After you - * encrypt a disk with a customer-supplied key, you must provide the same - * key if you use the disk later (e.g. to create a disk snapshot or an - * image, or to attach the disk to a virtual machine). Customer-supplied - * encryption keys do not protect access to metadata of the disk. If you do - * not provide an encryption key when creating the disk, then the disk will - * be encrypted using an automatically generated key and you do not need to - * provide a key to use the disk later. + * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -2770,18 +2067,11 @@ export namespace compute_alpha { */ kind?: string; /** - * A fingerprint for the labels being applied to this disk, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a disk. + * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. */ labelFingerprint?: string; /** - * Labels to apply to this disk. These can be later modified by the - * setLabels method. + * Labels to apply to this disk. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** @@ -2793,8 +2083,7 @@ export namespace compute_alpha { */ lastDetachTimestamp?: string; /** - * Integer license codes indicating which licenses are attached to this - * disk. + * Integer license codes indicating which licenses are attached to this disk. */ licenseCodes?: string[]; /** @@ -2802,18 +2091,11 @@ export namespace compute_alpha { */ licenses?: string[]; /** - * Indicates whether or not the disk can be read/write attached to more than - * one instance. + * Indicates whether or not the disk can be read/write attached to more than one instance. */ multiWriter?: boolean; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -2821,22 +2103,15 @@ export namespace compute_alpha { */ options?: string; /** - * Physical block size of the persistent disk, in bytes. If not present in a - * request, a default value is used. Currently supported sizes are 4096 and - * 16384, other sizes may be added in the future. If an unsupported value is - * requested, the error message will list the supported values for the - * caller's project. + * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. */ physicalBlockSizeBytes?: string; /** - * [Output Only] URL of the region where the disk resides. Only applicable - * for regional resources. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * URLs of the zones where the disk should be replicated to. Only applicable - * for regional resources. + * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ replicaZones?: string[]; /** @@ -2848,78 +2123,39 @@ export namespace compute_alpha { */ selfLink?: string; /** - * Size of the persistent disk, specified in GB. You can specify this field - * when creating a persistent disk using the sourceImage or sourceSnapshot - * parameter, or specify it alone to create an empty persistent disk. If - * you specify this field along with sourceImage or sourceSnapshot, the - * value of sizeGb must not be less than the size of the sourceImage or the - * size of the snapshot. Acceptable values are 1 to 65536, inclusive. + * Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. */ sizeGb?: string; /** - * The source disk used to create this disk. You can provide this as a - * partial or full URL to the resource. For example, the following are valid - * values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + * The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ sourceDisk?: string; /** - * [Output Only] The unique ID of the disk used to create this disk. This - * value identifies the exact disk that was used to create this persistent - * disk. For example, if you created the persistent disk from a disk that - * was later deleted and recreated under the same name, the source disk ID - * would identify the exact version of the disk that was used. + * [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. */ sourceDiskId?: string; /** - * The source image used to create this disk. If the source image is - * deleted, this field will not be set. To create a disk with one of the - * public operating system images, specify the image by its family name. For - * example, specify family/debian-9 to use the latest Debian 9 image: - * projects/debian-cloud/global/images/family/debian-9 Alternatively, use - * a specific version of a public operating system image: - * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To - * create a disk with a custom image that you created, specify the image - * name in the following format: global/images/my-custom-image You can - * also specify a custom image by its image family, which returns the latest - * version of the image in that family. Replace the image name with - * family/family-name: global/images/family/my-image-family + * The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the image used to create this disk. This - * value identifies the exact image that was used to create this persistent - * disk. For example, if you created the persistent disk from an image that - * was later deleted and recreated under the same name, the source image ID - * would identify the exact version of the image that was used. + * [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. */ sourceImageId?: string; /** - * The source snapshot used to create this disk. You can provide this as a - * partial or full URL to the resource. For example, the following are valid - * values: - - * https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - * - projects/project/global/snapshots/snapshot - global/snapshots/snapshot + * The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot */ sourceSnapshot?: string; /** - * The customer-supplied encryption key of the source snapshot. Required if - * the source snapshot is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The unique ID of the snapshot used to create this disk. - * This value identifies the exact snapshot that was used to create this - * persistent disk. For example, if you created the persistent disk from a - * snapshot that was later deleted and recreated under the same name, the - * source snapshot ID would identify the exact version of the snapshot that - * was used. + * [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. */ sourceSnapshotId?: string; /** @@ -2931,20 +2167,15 @@ export namespace compute_alpha { */ storageType?: string; /** - * URL of the disk type resource describing which disk type to use to create - * the disk. Provide this when creating the disk. For example: - * project/zones/zone/diskTypes/pd-standard or pd-ssd + * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd */ type?: string; /** - * [Output Only] Links to the users of the disk (attached instances) in - * form: project/zones/zone/instances/instance + * [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance */ users?: string[]; /** - * [Output Only] URL of the zone where the disk resides. You must specify - * this field as part of the HTTP request URL. It is not settable as a field - * in the request body. + * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -2958,16 +2189,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$DisksScopedList}; /** - * [Output Only] Type of resource. Always compute#diskAggregatedList for - * aggregated lists of persistent disks. + * [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2984,37 +2210,23 @@ export namespace compute_alpha { }; } /** - * A specification of the desired way to instantiate a disk in the instance - * template when its created from a source instance. + * A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. */ export interface Schema$DiskInstantiationConfig { /** - * Specifies whether the disk will be auto-deleted when the instance is - * deleted (but not when the disk is detached from the instance). + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ autoDelete?: boolean; /** - * The custom source image to be used to restore this disk when - * instantiating this instance template. + * The custom source image to be used to restore this disk when instantiating this instance template. */ customImage?: string; /** - * Specifies the device name of the disk to which the configurations apply - * to. + * Specifies the device name of the disk to which the configurations apply to. */ deviceName?: string; /** - * Specifies whether to include the disk and what image to use. Possible - * values are: - source-image: to use the same image that was used to - * create the source instance's corresponding disk. Applicable to the - * boot disk and additional read-write disks. - source-image-family: to use - * the same image family that was used to create the source instance's - * corresponding disk. Applicable to the boot disk and additional read-write - * disks. - custom-image: to use a user-provided image url for disk - * creation. Applicable to the boot disk and additional read-write disks. - - * attach-read-only: to attach a read-only disk. Applicable to read-only - * disks. - do-not-include: to exclude a disk from the template. Applicable - * to additional read-write disks, local SSDs, and read-only disks. + * Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. */ instantiateFrom?: string; } @@ -3031,16 +2243,11 @@ export namespace compute_alpha { */ items?: Schema$Disk[]; /** - * [Output Only] Type of resource. Always compute#diskList for lists of - * disks. + * [Output Only] Type of resource. Always compute#diskList for lists of disks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3058,17 +2265,11 @@ export namespace compute_alpha { } export interface Schema$DiskMoveRequest { /** - * The URL of the destination zone to move the disk. This can be a full or - * partial URL. For example, the following are all valid URLs to a zone: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone - - * projects/project/zones/zone - zones/zone + * The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone */ destinationZone?: string; /** - * The URL of the target disk to move. This can be a full or partial URL. - * For example, the following are all valid URLs to a disk: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + * The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ targetDisk?: string; } @@ -3096,8 +2297,7 @@ export namespace compute_alpha { */ disks?: Schema$Disk[]; /** - * [Output Only] Informational warning which replaces the list of disks when - * the list is empty. + * [Output Only] Informational warning which replaces the list of disks when the list is empty. */ warning?: { code?: string; @@ -3106,8 +2306,7 @@ export namespace compute_alpha { }; } /** - * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for - * v1.diskTypes ==) + * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) */ export interface Schema$DiskType { /** @@ -3127,13 +2326,11 @@ export namespace compute_alpha { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#diskType for disk - * types. + * [Output Only] Type of the resource. Always compute#diskType for disk types. */ kind?: string; /** @@ -3141,9 +2338,7 @@ export namespace compute_alpha { */ name?: string; /** - * [Output Only] URL of the region where the disk type resides. Only - * applicable for regional resources. You must specify this field as part of - * the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -3155,14 +2350,11 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] An optional textual description of the valid disk size, - * such as "10GB-10TB". + * [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". */ validDiskSize?: string; /** - * [Output Only] URL of the zone where the disk type resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -3180,11 +2372,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3213,16 +2401,11 @@ export namespace compute_alpha { */ items?: Schema$DiskType[]; /** - * [Output Only] Type of resource. Always compute#diskTypeList for disk - * types. + * [Output Only] Type of resource. Always compute#diskTypeList for disk types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3244,8 +2427,7 @@ export namespace compute_alpha { */ diskTypes?: Schema$DiskType[]; /** - * [Output Only] Informational warning which replaces the list of disk types - * when the list is empty. + * [Output Only] Informational warning which replaces the list of disk types when the list is empty. */ warning?: { code?: string; @@ -3264,35 +2446,26 @@ export namespace compute_alpha { } export interface Schema$DistributionPolicy { /** - * Zones where the regional managed instance group will create and manage - * instances. + * Zones where the regional managed instance group will create and manage instances. */ zones?: Schema$DistributionPolicyZoneConfiguration[]; } export interface Schema$DistributionPolicyZoneConfiguration { /** - * The URL of the zone. The zone must exist in the region where the managed - * instance group is located. + * The URL of the zone. The zone must exist in the region where the managed instance group is located. */ zone?: string; } /** - * A Duration represents a fixed-length span of time represented as a count of - * seconds and fractions of seconds at nanosecond resolution. It is - * independent of any calendar and concepts like "day" or - * "month". Range is approximately 10,000 years. + * A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. */ export interface Schema$Duration { /** - * Span of time that's a fraction of a second at nanosecond resolution. - * Durations less than one second are represented with a 0 `seconds` field - * and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + * Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. */ nanos?: number; /** - * Span of time at a resolution of a second. Must be from 0 to - * 315,576,000,000 inclusive. Note: these bounds are computed from: 60 - * sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + * Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years */ seconds?: string; } @@ -3328,16 +2501,11 @@ export namespace compute_alpha { */ items?: Schema$ExchangedPeeringRoute[]; /** - * [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList - * for exchanged peering routes lists. + * [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3354,41 +2522,28 @@ export namespace compute_alpha { }; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * External VPN gateway is the on-premises VPN gateway(s) or another cloud - * provider?s VPN gateway that connects to your Google Cloud VPN gateway. To - * create a highly available VPN from Google Cloud to your on-premises side or - * another Cloud provider's VPN gateway, you must create a external VPN - * gateway resource in GCP, which provides the information to GCP about your - * external VPN gateway. + * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. */ export interface Schema$ExternalVpnGateway { /** @@ -3396,13 +2551,11 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -3410,35 +2563,19 @@ export namespace compute_alpha { */ interfaces?: Schema$ExternalVpnGatewayInterface[]; /** - * [Output Only] Type of the resource. Always compute#externalVpnGateway for - * externalVpnGateways. + * [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. */ kind?: string; /** - * A fingerprint for the labels being applied to this ExternalVpnGateway, - * which is essentially a hash of the labels set used for optimistic - * locking. The fingerprint is initially generated by Compute Engine and - * changes after every request to modify or update labels. You must always - * provide an up-to-date fingerprint hash in order to update or change - * labels, otherwise the request will fail with error 412 conditionNotMet. - * To see the latest fingerprint, make a get() request to retrieve an - * ExternalVpnGateway. + * A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. */ labelFingerprint?: string; /** - * Labels to apply to this ExternalVpnGateway resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this ExternalVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -3455,17 +2592,11 @@ export namespace compute_alpha { */ export interface Schema$ExternalVpnGatewayInterface { /** - * The numeric ID of this interface. The allowed input values for this id - * for different redundancy types of external VPN gateway: - * SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 - * FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 + * The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 */ id?: number; /** - * IP address of the interface in the external VPN gateway. Only IPv4 is - * supported. This IP address can be either from your on-premise gateway or - * another Cloud provider?s VPN gateway, it cannot be an IP address from - * Google Compute Engine. + * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. */ ipAddress?: string; } @@ -3483,16 +2614,11 @@ export namespace compute_alpha { */ items?: Schema$ExternalVpnGateway[]; /** - * [Output Only] Type of resource. Always compute#externalVpnGatewayList for - * lists of externalVpnGateways. + * [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3520,8 +2646,7 @@ export namespace compute_alpha { */ export interface Schema$Firewall { /** - * The list of ALLOW rules specified by this firewall. Each rule specifies a - * protocol and port-range tuple that describes a permitted connection. + * The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. */ allowed?: Array<{IPProtocol?: string; ports?: string[]}>; /** @@ -3529,84 +2654,51 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * The list of DENY rules specified by this firewall. Each rule specifies a - * protocol and port-range tuple that describes a denied connection. + * The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. */ denied?: Array<{IPProtocol?: string; ports?: string[]}>; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * If destination ranges are specified, the firewall will apply only to - * traffic that has destination IP address in these ranges. These ranges - * must be expressed in CIDR format. Only IPv4 is supported. + * If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ destinationRanges?: string[]; /** - * Direction of traffic to which this firewall applies; default is INGRESS. - * Note: For INGRESS traffic, it is NOT supported to specify - * destinationRanges; For EGRESS traffic, it is NOT supported to specify - * sourceRanges OR sourceTags. + * Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. */ direction?: string; /** - * Denotes whether the firewall rule is disabled, i.e not applied to the - * network it is associated with. When set to true, the firewall rule is not - * enforced and the network behaves as if it did not exist. If this is - * unspecified, the firewall rule will be enabled. + * Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ disabled?: boolean; /** - * Deprecated in favor of enable in LogConfig. This field denotes whether to - * enable logging for a particular firewall rule. If logging is enabled, - * logs will be exported to Stackdriver. + * Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ enableLogging?: boolean; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#firewall for firewall - * rules. + * [Output Only] Type of the resource. Always compute#firewall for firewall rules. */ kind?: string; /** - * This field denotes the logging options for a particular firewall rule. If - * logging is enabled, logs will be exported to Stackdriver. + * This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ logConfig?: Schema$FirewallLogConfig; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network resource for this firewall rule. If not specified when - * creating a firewall rule, the default network is used: - * global/networks/default If you choose to specify this property, you can - * specify the network as a full or partial URL. For example, the following - * are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - * - projects/myproject/global/networks/my-network - - * global/networks/default + * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string; /** - * Priority for this rule. This is an integer between 0 and 65535, both - * inclusive. When not specified, the value assumed is 1000. Relative - * priorities determine precedence of conflicting rules. Lower value of - * priority implies higher precedence (eg, a rule with priority 0 has higher - * precedence than a rule with priority 1). DENY rules take precedence over - * ALLOW rules having equal priority. + * Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. */ priority?: number; /** @@ -3618,59 +2710,23 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * If source ranges are specified, the firewall will apply only to traffic - * that has source IP address in these ranges. These ranges must be - * expressed in CIDR format. One or both of sourceRanges and sourceTags may - * be set. If both properties are set, the firewall will apply to traffic - * that has source IP address within sourceRanges OR the source IP that - * belongs to a tag listed in the sourceTags property. The connection does - * not need to match both properties for the firewall to apply. Only IPv4 is - * supported. + * If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. */ sourceRanges?: string[]; /** - * If source service accounts are specified, the firewall will apply only to - * traffic originating from an instance with a service account in this list. - * Source service accounts cannot be used to control traffic to an - * instance's external IP address because service accounts are - * associated with an instance, not an IP address. sourceRanges can be set - * at the same time as sourceServiceAccounts. If both are set, the firewall - * will apply to traffic that has source IP address within sourceRanges OR - * the source IP belongs to an instance with service account listed in - * sourceServiceAccount. The connection does not need to match both - * properties for the firewall to apply. sourceServiceAccounts cannot be - * used at the same time as sourceTags or targetTags. + * If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ sourceServiceAccounts?: string[]; /** - * If source tags are specified, the firewall rule applies only to traffic - * with source IPs that match the primary network interfaces of VM instances - * that have the tag and are in the same VPC network. Source tags cannot be - * used to control traffic to an instance's external IP address, it only - * applies to traffic between instances in the same virtual network. Because - * tags are associated with instances, not IP addresses. One or both of - * sourceRanges and sourceTags may be set. If both properties are set, the - * firewall will apply to traffic that has source IP address within - * sourceRanges OR the source IP that belongs to a tag listed in the - * sourceTags property. The connection does not need to match both - * properties for the firewall to apply. + * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. */ sourceTags?: string[]; /** - * A list of service accounts indicating sets of instances located in the - * network that may make network connections as specified in allowed[]. - * targetServiceAccounts cannot be used at the same time as targetTags or - * sourceTags. If neither targetServiceAccounts nor targetTags are - * specified, the firewall rule applies to all instances on the specified - * network. + * A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. */ targetServiceAccounts?: string[]; /** - * A list of tags that controls which instances the firewall rule applies - * to. If targetTags are specified, then the firewall rule applies only to - * instances in the VPC network that have one of those tags. If no - * targetTags are specified, the firewall rule applies to all instances on - * the specified network. + * A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. */ targetTags?: string[]; } @@ -3687,16 +2743,11 @@ export namespace compute_alpha { */ items?: Schema$Firewall[]; /** - * [Output Only] Type of resource. Always compute#firewallList for lists of - * firewalls. + * [Output Only] Type of resource. Always compute#firewallList for lists of firewalls. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3717,14 +2768,11 @@ export namespace compute_alpha { */ export interface Schema$FirewallLogConfig { /** - * This field denotes whether to enable logging for a particular firewall - * rule. + * This field denotes whether to enable logging for a particular firewall rule. */ enable?: boolean; /** - * This field can only be specified for a particular firewall rule if - * logging is enabled for that rule. This field denotes whether to include - * or exclude metadata for firewall logs. + * This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs. */ metadata?: string; } @@ -3733,57 +2781,32 @@ export namespace compute_alpha { */ export interface Schema$FixedOrPercent { /** - * [Output Only] Absolute value of VM instances calculated based on the - * specific mode. - If the value is fixed, then the calculated value is - * equal to the fixed value. - If the value is a percent, then the - * calculated value is percent/100 * targetSize. For example, the calculated - * value of a 80% of a managed instance group with 150 instances would be - * (80/100 * 150) = 120 VM instances. If there is a remainder, the number is - * rounded up. + * [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up. */ calculated?: number; /** - * Specifies a fixed number of VM instances. This must be a positive - * integer. + * Specifies a fixed number of VM instances. This must be a positive integer. */ fixed?: number; /** - * Specifies a percentage of instances between 0 to 100%, inclusive. For - * example, specify 80 for 80%. + * Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. */ percent?: number; } /** - * A ForwardingRule resource. A ForwardingRule resource specifies which pool - * of target virtual machines to forward a packet to if it matches the given - * [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules - * ==) (== resource_for v1.forwardingRules ==) (== resource_for - * beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules - * ==) (== resource_for beta.regionForwardingRules ==) (== resource_for - * v1.regionForwardingRules ==) + * A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** - * This field is used along with the backend_service field for internal load - * balancing or with the target field for internal TargetInstance. If the - * field is set to TRUE, clients can access ILB from all regions. Otherwise - * only allows access from clients in the same region as the internal load - * balancer. + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. */ allowGlobalAccess?: boolean; /** - * This field is used along with the backend_service field for internal load - * balancing or with the target field for internal TargetInstance. This - * field cannot be used with port or portRange fields. When the load - * balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field - * to allow packets addressed to any ports will be forwarded to the backends - * configured with this forwarding rule. + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. */ allPorts?: boolean; /** - * This field is only used for INTERNAL load balancing. For internal load - * balancing, this field identifies the BackendService resource to receive - * the matched traffic. + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. */ backendService?: string; /** @@ -3791,165 +2814,71 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a ForwardingRule. Include the fingerprint in patch - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. To see the latest fingerprint, make a - * get() request to retrieve a ForwardingRule. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The IP address that this forwarding rule is serving on behalf of. - * Addresses are restricted based on the forwarding rule's load - * balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). - * When the load balancing scheme is EXTERNAL, for global forwarding rules, - * the address must be a global IP, and for regional forwarding rules, the - * address must live in the same region as the forwarding rule. If this - * field is empty, an ephemeral IPv4 address from the same scope (global or - * regional) will be assigned. A regional forwarding rule supports IPv4 - * only. A global forwarding rule supports either IPv4 or IPv6. When the - * load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL - * reference to an existing Address resource ( internal regional static IP - * address), with a purpose of GCE_END_POINT and address_type of INTERNAL. - * When the load balancing scheme is INTERNAL, this can only be an RFC 1918 - * IP address belonging to the network/subnet configured for the forwarding - * rule. By default, if this field is empty, an ephemeral internal IP - * address will be automatically allocated from the IP range of the subnet - * or network configured for this forwarding rule. An address can be - * specified either by a literal IP address or a URL reference to an - * existing Address resource. The following examples are all valid: - - * 100.1.2.3 - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address - * - projects/project/regions/region/addresses/address - - * regions/region/addresses/address - global/addresses/address - address + * The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: - 100.1.2.3 - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address - projects/project/regions/region/addresses/address - regions/region/addresses/address - global/addresses/address - address */ IPAddress?: string; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, - * ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only - * TCP and UDP are valid. When the load balancing scheme is - * INTERNAL_SELF_MANAGED, only TCPis valid. + * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. */ IPProtocol?: string; /** - * The IP Version that will be used by this forwarding rule. Valid options - * are IPV4 or IPV6. This can only be specified for an external global - * forwarding rule. + * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. */ ipVersion?: string; /** - * [Output Only] Type of the resource. Always compute#forwardingRule for - * Forwarding Rule resources. + * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. */ kind?: string; /** - * A fingerprint for the labels being applied to this resource, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a - * ForwardingRule. + * A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. */ labelFingerprint?: string; /** - * Labels to apply to this resource. These can be later modified by the - * setLabels method. Each label key/value pair must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * This signifies what the ForwardingRule will be used for and can only take - * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The - * value of INTERNAL means that this will be used for Internal Network Load - * Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this - * will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means - * that this will be used for External Load Balancing (HTTP(S) LB, External - * TCP/UDP LB, SSL Proxy) + * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) */ loadBalancingScheme?: string; /** - * Opaque filter criteria used by Loadbalancer to restrict routing - * configuration to a limited set xDS compliant clients. In their xDS - * requests to Loadbalancer, xDS clients present node metadata. If a match - * takes place, the relevant routing configuration is made available to - * those proxies. For each metadataFilter in this list, if its - * filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels - * must match the corresponding label provided in the metadata. If its - * filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels - * must match with corresponding labels in the provided metadata. - * metadataFilters specified here can be overridden by those specified in - * the UrlMap that this ForwardingRule references. metadataFilters only - * applies to Loadbalancers that have their loadBalancingScheme set to - * INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * This field is not used for external load balancing. For INTERNAL and - * INTERNAL_SELF_MANAGED load balancing, this field identifies the network - * that the load balanced IP should belong to for this Forwarding Rule. If - * this field is not specified, the default network will be used. + * This field is not used for external load balancing. For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. */ network?: string; /** - * This signifies the networking tier used for configuring this load - * balancer and can only take the following values: PREMIUM , STANDARD. For - * regional ForwardingRule, the valid values are PREMIUM and STANDARD. For - * GlobalForwardingRule, the valid value is PREMIUM. If this field is not - * specified, it is assumed to be PREMIUM. If IPAddress is specified, this - * value must be equal to the networkTier of the Address. + * This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. */ networkTier?: string; /** - * This field is used along with the target field for TargetHttpProxy, - * TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, - * TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, - * or SCTP, only packets addressed to ports in the specified range will be - * forwarded to target. Forwarding rules with the same [IPAddress, - * IPProtocol] pair must have disjoint port ranges. Some types of - * forwarding target have constraints on the acceptable ports: - - * TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, - * 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - - * TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, - * 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 + * This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 */ portRange?: string; /** - * This field is used along with the backend_service field for internal load - * balancing. When the load balancing scheme is INTERNAL, a list of ports - * can be configured, for example, ['80'], - * ['8000','9000'] etc. Only packets addressed to these - * ports will be forwarded to the backends configured with this forwarding - * rule. You may specify a maximum of up to 5 ports. + * This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports. */ ports?: string[]; /** - * [Output Only] URL of the region where the regional forwarding rule - * resides. This field is not applicable to global forwarding rules. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -3961,36 +2890,19 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * An optional prefix to the service name for this Forwarding Rule. If - * specified, will be the first label of the fully qualified service name. - * The label must be 1-63 characters long, and comply with RFC1035. - * Specifically, the label must be 1-63 characters long and match the - * regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. This field is only used for internal load balancing. + * An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. */ serviceLabel?: string; /** - * [Output Only] The internal fully qualified service name for this - * Forwarding Rule. This field is only used for internal load balancing. + * [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. */ serviceName?: string; /** - * This field is only used for INTERNAL load balancing. For internal load - * balancing, this field identifies the subnetwork that the load balanced IP - * should belong to for this Forwarding Rule. If the network specified is - * in auto subnet mode, this field is optional. However, if the network is - * in custom subnet mode, a subnetwork must be specified. + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. */ subnetwork?: string; /** - * The URL of the target resource to receive the matched traffic. For - * regional forwarding rules, this target must live in the same region as - * the forwarding rule. For global forwarding rules, this target must be a - * global load balancing resource. The forwarded traffic must be of a type - * appropriate to the target object. For INTERNAL_SELF_MANAGED load - * balancing, only HTTP and HTTPS targets are valid. + * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. */ target?: string; } @@ -4004,16 +2916,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$ForwardingRulesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#forwardingRuleAggregatedList for lists of forwarding rules. + * [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4046,11 +2953,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4075,8 +2978,7 @@ export namespace compute_alpha { */ forwardingRules?: Schema$ForwardingRule[]; /** - * Informational warning which replaces the list of forwarding rules when - * the list is empty. + * Informational warning which replaces the list of forwarding rules when the list is empty. */ warning?: { code?: string; @@ -4098,43 +3000,25 @@ export namespace compute_alpha { } export interface Schema$GlobalSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash when updating or - * changing labels, otherwise the request will fail with error 412 - * conditionNotMet. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** - * A list of labels to apply for this resource. Each label key & value - * must comply with RFC1035. Specifically, the name must be 1-63 characters - * long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which - * means the first character must be a lowercase letter, and all following - * characters must be a dash, lowercase letter, or digit, except the last - * character, which cannot be a dash. For example, - * "webserver-frontend": "images". A label value can - * also be empty (e.g. "my-label": ""). + * A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). */ labels?: {[key: string]: string}; } export interface Schema$GlobalSetPolicyRequest { /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -4160,13 +3044,11 @@ export namespace compute_alpha { */ export interface Schema$GuestAttributes { /** - * [Output Only] Type of the resource. Always compute#guestAttributes for - * guest attributes entry. + * [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. */ kind?: string; /** - * The path to be queried. This can be the default namespace ('/') - * or a nested namespace ('//') or a specified key ('//') + * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') */ queryPath?: string; /** @@ -4214,20 +3096,16 @@ export namespace compute_alpha { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. Read Enabling guest operating system - * features to see a list of available options. + * The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. */ type?: string; } /** - * An HealthCheck resource. This resource defines a template for how - * individual virtual machines should be checked for health, via one of the - * supported protocols. + * An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. */ export interface Schema$HealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -4235,21 +3113,18 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; http2HealthCheck?: Schema$HTTP2HealthCheck; httpHealthCheck?: Schema$HTTPHealthCheck; httpsHealthCheck?: Schema$HTTPSHealthCheck; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -4257,18 +3132,11 @@ export namespace compute_alpha { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] Region where the health check resides. Not applicable to - * global health checks. + * [Output Only] Region where the health check resides. Not applicable to global health checks. */ region?: string; /** @@ -4282,22 +3150,16 @@ export namespace compute_alpha { sslHealthCheck?: Schema$SSLHealthCheck; tcpHealthCheck?: Schema$TCPHealthCheck; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ timeoutSec?: number; /** - * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or - * HTTP2. If not specified, the default is TCP. Exactly one of the - * protocol-specific health check field must be specified, which must match - * type field. + * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. */ type?: string; udpHealthCheck?: Schema$UDPHealthCheck; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -4318,11 +3180,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4339,11 +3197,7 @@ export namespace compute_alpha { }; } /** - * A full or valid partial URL to a health check. For example, the following - * are valid URLs: - - * https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - * - projects/project-id/global/httpHealthChecks/health-check - - * global/httpHealthChecks/health-check + * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ export interface Schema$HealthCheckReference { healthCheck?: string; @@ -4362,11 +3216,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4383,9 +3233,7 @@ export namespace compute_alpha { }; } /** - * A HealthCheckService defines a set of backends on which to perform periodic - * health checks and an endpoint to which to send notification of changes in - * the health status of the backends. + * A HealthCheckService defines a set of backends on which to perform periodic health checks and an endpoint to which to send notification of changes in the health status of the backends. */ export interface Schema$HealthCheckService { /** @@ -4393,68 +3241,39 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * List of URLs to the HealthCheck resources. Must have at least one - * HealthCheck, and not more than 10. HealthCheck resources must have - * portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the - * HealthCheck must be regional and in the same region. For global - * HealthCheckService, HealthCheck must be global. Mix of regional and - * global HealthChecks is not supported. Multiple regional HealthChecks must - * belong to the same region. Regional HealthChecks</code? must belong to - * the same region as zones of NEGs. + * List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs. */ healthChecks?: string[]; /** - * Policy for how the results from multiple health checks for the same - * endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is - * returned for each backend in the health check service. - AND. If any - * backend's health check reports UNHEALTHY, then UNHEALTHY is the - * HealthState of the entire health check service. If all backend's are - * healthy, the HealthState of the health check service is HEALTHY. . + * Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. . */ healthStatusAggregationStrategy?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output only] Type of the resource. Always compute#healthCheckServicefor - * health check services. + * [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. */ kind?: string; /** - * Name of the resource. The name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * List of URLs to the NetworkEndpointGroup resources. Must not have more - * than 100. For regional HealthCheckService, NEGs must be in zones in the - * region of the HealthCheckService. + * List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. */ networkEndpointGroups?: string[]; /** - * List of URLs to the NotificationEndpoint resources. Must not have more - * than 10. A list of endpoints for receiving notifications of change in - * health status. For regional HealthCheckService, NotificationEndpoint must - * be regional and in the same region. For global HealthCheckService, - * NotificationEndpoint must be global. + * List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. */ notificationEndpoints?: string[]; /** - * [Output Only] URL of the region where the health check service resides. - * This field is not applicable to global health check services. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -4476,16 +3295,11 @@ export namespace compute_alpha { */ items?: Schema$HealthCheckService[]; /** - * [Output Only] Type of the resource. Always - * compute#healthCheckServicesList for lists of HealthCheckServices. + * [Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4507,8 +3321,7 @@ export namespace compute_alpha { */ healthChecks?: Schema$HealthCheck[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -4540,90 +3353,66 @@ export namespace compute_alpha { } export interface Schema$HealthStatusForNetworkEndpoint { /** - * URL of the backend service associated with the health state of the - * network endpoint. + * URL of the backend service associated with the health state of the network endpoint. */ backendService?: Schema$BackendServiceReference; /** - * URL of the forwarding rule associated with the health state of the - * network endpoint. + * URL of the forwarding rule associated with the health state of the network endpoint. */ forwardingRule?: Schema$ForwardingRuleReference; /** - * URL of the health check associated with the health state of the network - * endpoint. + * URL of the health check associated with the health state of the network endpoint. */ healthCheck?: Schema$HealthCheckReference; /** - * Health state of the network endpoint determined based on the health - * checks configured. + * Health state of the network endpoint determined based on the health checks configured. */ healthState?: string; } /** - * UrlMaps A host-matching rule for a URL. If matched, will use the named - * PathMatcher to select the BackendService. + * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. */ export interface Schema$HostRule { /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The list of host patterns to match. They must be valid hostnames, except - * * will match any string of ([a-z0-9-.]*). In that case, * must be the - * first character and must be followed in the pattern by either - or .. + * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. */ hosts?: string[]; /** - * The name of the PathMatcher to use to match the path portion of the URL - * if the hostRule matches the URL's host portion. + * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. */ pathMatcher?: string; } export interface Schema$HTTP2HealthCheck { /** - * The value of the host header in the HTTP/2 health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTP2 health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTP/2 health check request. The default value is - * /. + * The request path of the HTTP/2 health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } @@ -4632,20 +3421,16 @@ export namespace compute_alpha { */ export interface Schema$HttpFaultAbort { /** - * The HTTP status code used to abort the request. The value must be between - * 200 and 599 inclusive. + * The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. */ httpStatus?: number; /** - * The percentage of traffic (connections/operations/requests) which will be - * aborted as part of fault injection. The value must be between 0.0 and - * 100.0 inclusive. + * The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. */ percentage?: number; } /** - * Specifies the delay introduced by Loadbalancer before forwarding the - * request to the backend service as part of fault injection. + * Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. */ export interface Schema$HttpFaultDelay { /** @@ -4653,55 +3438,41 @@ export namespace compute_alpha { */ fixedDelay?: Schema$Duration; /** - * The percentage of traffic (connections/operations/requests) on which - * delay will be introduced as part of fault injection. The value must be - * between 0.0 and 100.0 inclusive. + * The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. */ percentage?: number; } /** - * The specification for fault injection introduced into traffic to test the - * resiliency of clients to backend service failure. As part of fault - * injection, when clients send requests to a backend service, delays can be - * introduced by Loadbalancer on a percentage of requests before sending those - * request to the backend service. Similarly requests from clients can be - * aborted by the Loadbalancer for a percentage of requests. + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. */ export interface Schema$HttpFaultInjection { /** - * The specification for how client requests are aborted as part of fault - * injection. + * The specification for how client requests are aborted as part of fault injection. */ abort?: Schema$HttpFaultAbort; /** - * The specification for how client requests are delayed as part of fault - * injection, before being sent to a backend service. + * The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. */ delay?: Schema$HttpFaultDelay; } /** - * The request and response header transformations that take effect before the - * request is passed along to the selected backendService. + * The request and response header transformations that take effect before the request is passed along to the selected backendService. */ export interface Schema$HttpHeaderAction { /** - * Headers to add to a matching request prior to forwarding the request to - * the backendService. + * Headers to add to a matching request prior to forwarding the request to the backendService. */ requestHeadersToAdd?: Schema$HttpHeaderOption[]; /** - * A list of header names for headers that need to be removed from the - * request prior to forwarding the request to the backendService. + * A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. */ requestHeadersToRemove?: string[]; /** - * Headers to add the response prior to sending the response back to the - * client. + * Headers to add the response prior to sending the response back to the client. */ responseHeadersToAdd?: Schema$HttpHeaderOption[]; /** - * A list of header names for headers that need to be removed from the - * response prior to sending the response back to the client. + * A list of header names for headers that need to be removed from the response prior to sending the response back to the client. */ responseHeadersToRemove?: string[]; } @@ -4710,61 +3481,35 @@ export namespace compute_alpha { */ export interface Schema$HttpHeaderMatch { /** - * The value should exactly match contents of exactMatch. Only one of - * exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or - * rangeMatch must be set. + * The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ exactMatch?: string; /** - * The name of the HTTP header to match. For matching against the HTTP - * request's authority, use a headerMatch with the header name - * ":authority". For matching a request's method, use the - * headerName ":method". + * The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". */ headerName?: string; /** - * If set to false, the headerMatch is considered a match if the match - * criteria above are met. If set to true, the headerMatch is considered a - * match if the match criteria above are NOT met. The default setting is - * false. + * If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false. */ invertMatch?: boolean; /** - * The value of the header must start with the contents of prefixMatch. Only - * one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or - * rangeMatch must be set. + * The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ prefixMatch?: string; /** - * A header with the contents of headerName must exist. The match takes - * place whether or not the request's header has a value or not. Only - * one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or - * rangeMatch must be set. + * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ presentMatch?: boolean; /** - * The header value must be an integer and its value must be in the range - * specified in rangeMatch. If the header does not contain an integer, - * number or is empty, the match fails. For example for a range [-5, 0] - - * -3 will match. - 0 will not match. - 0.25 will not match. - - * -3someString will not match. Only one of exactMatch, prefixMatch, - * suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ rangeMatch?: Schema$Int64RangeMatch; /** - * The value of the header must match the regualar expression specified in - * regexMatch. For regular expression grammar, please see: - * en.cppreference.com/w/cpp/regex/ecmascript For matching against a port - * specified in the HTTP request, use a headerMatch with headerName set to - * PORT and a regular expression that satisfies the RFC2616 Host - * header's port specifier. Only one of exactMatch, prefixMatch, - * suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ regexMatch?: string; /** - * The value of the header must end with the contents of suffixMatch. Only - * one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or - * rangeMatch must be set. + * The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ suffixMatch?: string; } @@ -4781,65 +3526,46 @@ export namespace compute_alpha { */ headerValue?: string; /** - * If false, headerValue is appended to any values that already exist for - * the header. If true, headerValue is set for the header, discarding any - * values that were set for that header. The default value is false. + * If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. */ replace?: boolean; } export interface Schema$HTTPHealthCheck { /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value - * is 80. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTP health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTP health check request. The default value is - * /. + * The request path of the HTTP health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } /** - * An HttpHealthCheck resource. This resource defines a template for how - * individual instances should be checked for health, via HTTP. + * An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP. */ export interface Schema$HttpHealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -4847,49 +3573,35 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the public IP on behalf of which this health check - * is performed will be used. + * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ host?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#httpHealthCheck for - * HTTP health checks. + * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The TCP port number for the HTTP health check request. The default value - * is 80. + * The TCP port number for the HTTP health check request. The default value is 80. */ port?: number; /** - * The request path of the HTTP health check request. The default value is - * /. + * The request path of the HTTP health check request. The default value is /. */ requestPath?: string; /** @@ -4901,14 +3613,11 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ timeoutSec?: number; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -4929,11 +3638,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4954,27 +3659,19 @@ export namespace compute_alpha { */ export interface Schema$HttpQueryParameterMatch { /** - * The queryParameterMatch matches if the value of the parameter exactly - * matches the contents of exactMatch. Only one of presentMatch, exactMatch - * and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set. */ exactMatch?: string; /** - * The name of the query parameter to match. The query parameter must exist - * in the request, in the absence of which the request match fails. + * The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. */ name?: string; /** - * Specifies that the queryParameterMatch matches if the request contains - * the query parameter, irrespective of whether the parameter has a value or - * not. Only one of presentMatch, exactMatch and regexMatch must be set. + * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set. */ presentMatch?: boolean; /** - * The queryParameterMatch matches if the value of the parameter matches the - * regular expression specified by regexMatch. For the regular expression - * grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one - * of presentMatch, exactMatch and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set. */ regexMatch?: string; } @@ -4983,46 +3680,27 @@ export namespace compute_alpha { */ export interface Schema$HttpRedirectAction { /** - * The host that will be used in the redirect response instead of the one - * that was supplied in the request. The value must be between 1 and 255 - * characters. + * The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. */ hostRedirect?: string; /** - * If set to true, the URL scheme in the redirected request is set to https. - * If set to false, the URL scheme of the redirected request will remain the - * same as that of the request. This must only be set for UrlMaps used in - * TargetHttpProxys. Setting this true for TargetHttpsProxy is not - * permitted. The default is set to false. + * If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. */ httpsRedirect?: boolean; /** - * The path that will be used in the redirect response instead of the one - * that was supplied in the request. Only one of pathRedirect or - * prefixRedirect must be specified. The value must be between 1 and 1024 - * characters. + * The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters. */ pathRedirect?: string; /** - * The prefix that replaces the prefixMatch specified in the - * HttpRouteRuleMatch, retaining the remaining portion of the URL before - * redirecting the request. + * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. */ prefixRedirect?: string; /** - * The HTTP Status code to use for this RedirectAction. Supported values - * are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and - * corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER - * which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to - * 307. In this case, the request method will be retained. - - * PERMANENT_REDIRECT, which corresponds to 308. In this case, the request - * method will be retained. + * The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. */ redirectResponseCode?: string; /** - * If set to true, any accompanying query portion of the original URL is - * removed prior to redirecting the request. If set to false, the query - * portion of the original URL is retained. The default is set to false. + * If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. */ stripQuery?: boolean; } @@ -5039,51 +3717,21 @@ export namespace compute_alpha { */ perTryTimeout?: Schema$Duration; /** - * Specfies one or more conditions when this retry rule applies. Valid - * values are: - 5xx: Loadbalancer will attempt a retry if the backend - * service responds with any 5xx response code, or if the backend service - * does not respond at all, example: disconnects, reset, read timeout, - * connection failure, and refused streams. - gateway-error: Similar to - * 5xx, but only applies to response codes 502, 503 or 504. - - - * connect-failure: Loadbalancer will retry on failures connecting to - * backend services, for example due to connection timeouts. - - * retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. - * Currently the only retriable error supported is 409. - - * refused-stream:Loadbalancer will retry if the backend service resets the - * stream with a REFUSED_STREAM error code. This reset type indicates that - * it is safe to retry. - cancelledLoadbalancer will retry if the gRPC - * status code in the response header is set to cancelled - - * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the - * response header is set to deadline-exceeded - resource-exhausted: - * Loadbalancer will retry if the gRPC status code in the response header is - * set to resource-exhausted - unavailable: Loadbalancer will retry if the - * gRPC status code in the response header is set to unavailable + * Specfies one or more conditions when this retry rule applies. Valid values are: - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable */ retryConditions?: string[]; } export interface Schema$HttpRouteAction { /** - * The specification for allowing client side cross-origin requests. Please - * see W3C Recommendation for Cross Origin Resource Sharing + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing */ corsPolicy?: Schema$CorsPolicy; /** - * The specification for fault injection introduced into traffic to test the - * resiliency of clients to backend service failure. As part of fault - * injection, when clients send requests to a backend service, delays can be - * introduced by Loadbalancer on a percentage of requests before sending - * those request to the backend service. Similarly requests from clients can - * be aborted by the Loadbalancer for a percentage of requests. timeout and - * retry_policy will be ignored by clients that are configured with a - * fault_injection_policy. + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. */ faultInjectionPolicy?: Schema$HttpFaultInjection; /** - * Specifies the policy on how requests intended for the route's - * backends are shadowed to a separate mirrored backend service. - * Loadbalancer does not wait for responses from the shadow service. Prior - * to sending traffic to the shadow service, the host / authority header is - * suffixed with -shadow. + * Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. */ requestMirrorPolicy?: Schema$RequestMirrorPolicy; /** @@ -5091,173 +3739,105 @@ export namespace compute_alpha { */ retryPolicy?: Schema$HttpRetryPolicy; /** - * Specifies the timeout for the selected route. Timeout is computed from - * the time the request is has been fully processed (i.e. end-of-stream) up - * until the response has been completely processed. Timeout includes all - * retries. If not specified, the default value is 15 seconds. + * Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. */ timeout?: Schema$Duration; /** - * The spec to modify the URL of the request, prior to forwarding the - * request to the matched service + * The spec to modify the URL of the request, prior to forwarding the request to the matched service */ urlRewrite?: Schema$UrlRewrite; /** - * A list of weighted backend services to send traffic to when a route match - * occurs. The weights determine the fraction of traffic that flows to their - * corresponding backend service. If all traffic needs to go to a single - * backend service, there must be one weightedBackendService with weight - * set to a non 0 number. Once a backendService is identified and before - * forwarding the request to the backend service, advanced routing actions - * like Url rewrites and header transformations are applied depending on - * additional settings specified in this HttpRouteAction. + * A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. */ weightedBackendServices?: Schema$WeightedBackendService[]; } /** - * An HttpRouteRule specifies how to match an HTTP request and the - * corresponding routing action that load balancing proxies will perform. + * An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. */ export interface Schema$HttpRouteRule { /** - * Specifies changes to request and response headers that need to take - * effect for the selected backendService. The headerAction specified here - * are applied before the matching pathMatchers[].headerAction and after - * pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction */ headerAction?: Schema$HttpHeaderAction; matchRules?: Schema$HttpRouteRuleMatch[]; /** - * In response to a matching matchRule, the load balancer performs advanced - * routing actions like URL rewrites, header transformations, etc. prior to - * forwarding the request to the selected backend. If routeAction specifies - * any weightedBackendServices, service must not be set. Conversely if - * service is set, routeAction cannot contain any weightedBackendServices. - * Only one of routeAction or urlRedirect must be set. + * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. */ routeAction?: Schema$HttpRouteAction; /** - * When this rule is matched, the request is redirected to a URL specified - * by urlRedirect. If urlRedirect is specified, service or routeAction must - * not be set. + * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. */ urlRedirect?: Schema$HttpRedirectAction; } /** - * HttpRouteRuleMatch specifies a set of criteria for matching requests to an - * HttpRouteRule. All specified criteria must be satisfied for a match to - * occur. + * HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. */ export interface Schema$HttpRouteRuleMatch { /** - * For satifying the matchRule condition, the path of the request must - * exactly match the value specified in fullPathMatch after removing any - * query parameters and anchor that may be part of the original URL. - * FullPathMatch must be between 1 and 1024 characters. Only one of - * prefixMatch, fullPathMatch or regexMatch must be specified. + * For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ fullPathMatch?: string; /** - * Specifies a list of header match criteria, all of which must match - * corresponding headers in the request. + * Specifies a list of header match criteria, all of which must match corresponding headers in the request. */ headerMatches?: Schema$HttpHeaderMatch[]; /** - * Specifies that prefixMatch and fullPathMatch matches are case sensitive. - * The default value is false. caseSensitive must not be used with - * regexMatch. + * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive must not be used with regexMatch. */ ignoreCase?: boolean; /** - * Opaque filter criteria used by Loadbalancer to restrict routing - * configuration to a limited set xDS compliant clients. In their xDS - * requests to Loadbalancer, xDS clients present node metadata. If a match - * takes place, the relevant routing configuration is made available to - * those proxies. For each metadataFilter in this list, if its - * filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels - * must match the corresponding label provided in the metadata. If its - * filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels - * must match with corresponding labels in the provided metadata. - * metadataFilters specified here can be overrides those specified in - * ForwardingRule that refers to this UrlMap. metadataFilters only applies - * to Loadbalancers that have their loadBalancingScheme set to - * INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** - * For satifying the matchRule condition, the request's path must begin - * with the specified prefixMatch. prefixMatch must begin with a /. The - * value must be between 1 and 1024 characters. Only one of prefixMatch, - * fullPathMatch or regexMatch must be specified. + * For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ prefixMatch?: string; /** - * Specifies a list of query parameter match criteria, all of which must - * match corresponding query parameters in the request. + * Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. */ queryParameterMatches?: Schema$HttpQueryParameterMatch[]; /** - * For satifying the matchRule condition, the path of the request must - * satisfy the regular expression specified in regexMatch after removing any - * query parameters and anchor supplied with the original URL. For regular - * expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript - * Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ regexMatch?: string; } export interface Schema$HTTPSHealthCheck { /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTPS health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTPS health check request. The default value is - * /. + * The request path of the HTTPS health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } /** - * An HttpsHealthCheck resource. This resource defines a template for how - * individual instances should be checked for health, via HTTPS. + * An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS. */ export interface Schema$HttpsHealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -5265,24 +3845,19 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the public IP on behalf of which this health check - * is performed will be used. + * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ host?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -5290,23 +3865,15 @@ export namespace compute_alpha { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The TCP port number for the HTTPS health check request. The default value - * is 443. + * The TCP port number for the HTTPS health check request. The default value is 443. */ port?: number; /** - * The request path of the HTTPS health check request. The default value is - * "/". + * The request path of the HTTPS health check request. The default value is "/". */ requestPath?: string; /** @@ -5318,14 +3885,11 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have a greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. */ timeoutSec?: number; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -5346,11 +3910,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5367,13 +3927,11 @@ export namespace compute_alpha { }; } /** - * An Image resource. (== resource_for beta.images ==) (== resource_for - * v1.images ==) + * An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==) */ export interface Schema$Image { /** - * Size of the image tar.gz archive stored in Google Cloud Storage (in - * bytes). + * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ archiveSizeBytes?: string; /** @@ -5385,8 +3943,7 @@ export namespace compute_alpha { */ deprecated?: Schema$DeprecationStatus; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -5394,31 +3951,19 @@ export namespace compute_alpha { */ diskSizeGb?: string; /** - * The name of the image family to which this image belongs. You can create - * disks by specifying an image family instead of a specific image name. The - * image family always returns its latest image that is not deprecated. The - * name of the image family must comply with RFC1035. + * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. */ family?: string; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Encrypts the image using a customer-supplied encryption key. After you - * encrypt an image with a customer-supplied key, you must provide the same - * key if you use the image later (e.g. to create a disk from the image). - * Customer-supplied encryption keys do not protect access to metadata of - * the disk. If you do not provide an encryption key when creating the - * image, then the disk will be encrypted using an automatically generated - * key and you do not need to provide a key to use the image later. + * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. */ imageEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -5426,23 +3971,15 @@ export namespace compute_alpha { */ kind?: string; /** - * A fingerprint for the labels being applied to this image, which is - * essentially a hash of the labels used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an image. + * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. */ labelFingerprint?: string; /** - * Labels to apply to this image. These can be later modified by the - * setLabels method. + * Labels to apply to this image. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** - * Integer license codes indicating which licenses are attached to this - * image. + * Integer license codes indicating which licenses are attached to this image. */ licenseCodes?: string[]; /** @@ -5450,13 +3987,7 @@ export namespace compute_alpha { */ licenses?: string[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -5476,71 +4007,47 @@ export namespace compute_alpha { */ shieldedInstanceInitialState?: Schema$InitialStateConfig; /** - * URL of the source disk used to create this image. This can be a full or - * valid partial URL. You must provide either this property or the - * rawDisk.source property but not both to create an image. For example, the - * following are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ sourceDisk?: string; /** - * The customer-supplied encryption key of the source disk. Required if the - * source disk is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the disk used to create this image. This - * value may be used to determine whether the image was taken from the - * current or a previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. */ sourceDiskId?: string; /** - * URL of the source image used to create this image. This can be a full or - * valid partial URL. You must provide exactly one of: - this property, or - * - the rawDisk.source property, or - the sourceDisk property in order - * to create an image. + * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the image used to create this image. This - * value may be used to determine whether the image was taken from the - * current or a previous instance of a given image name. + * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. */ sourceImageId?: string; /** - * URL of the source snapshot used to create this image. This can be a full - * or valid partial URL. You must provide exactly one of: - this property, - * or - the sourceImage property, or - the rawDisk.source property, or - * - the sourceDisk property in order to create an image. + * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ sourceSnapshot?: string; /** - * The customer-supplied encryption key of the source snapshot. Required if - * the source snapshot is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the snapshot used to create this image. - * This value may be used to determine whether the snapshot was taken from - * the current or a previous instance of a given snapshot name. + * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. */ sourceSnapshotId?: string; /** - * The type of the image used to create this disk. The default and only - * value is RAW + * The type of the image used to create this disk. The default and only value is RAW */ sourceType?: string; /** - * [Output Only] The status of the image. An image can be used to create - * other resources, such as instances, only after the image has been - * successfully created and the status is set to READY. Possible values are - * FAILED, PENDING, or READY. + * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ status?: string; /** @@ -5565,11 +4072,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5586,8 +4089,7 @@ export namespace compute_alpha { }; } /** - * Initial State for shielded instance, these are public keys which are safe - * to store in public + * Initial State for shielded instance, these are public keys which are safe to store in public */ export interface Schema$InitialStateConfig { /** @@ -5608,15 +4110,11 @@ export namespace compute_alpha { pk?: Schema$FileContentBuffer; } /** - * An Instance resource. (== resource_for beta.instances ==) (== resource_for - * v1.instances ==) + * An Instance resource. (== resource_for beta.instances ==) (== resource_for v1.instances ==) */ export interface Schema$Instance { /** - * Allows this instance to send and receive packets with non-matching - * destination or source IPs. This is required if you plan to use this - * instance to forward routes. For more information, see Enabling IP - * Forwarding. + * Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. */ canIpForward?: boolean; /** @@ -5632,13 +4130,11 @@ export namespace compute_alpha { */ deletionProtection?: boolean; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Array of disks associated with this instance. Persistent disks must be - * created before you can assign them. + * Array of disks associated with this instance. Persistent disks must be created before you can assign them. */ disks?: Schema$AttachedDisk[]; /** @@ -5646,102 +4142,56 @@ export namespace compute_alpha { */ displayDevice?: Schema$DisplayDevice; /** - * A list of the type and count of accelerator cards attached to the - * instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators?: Schema$AcceleratorConfig[]; hostname?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Encrypts or decrypts data for an instance with a customer-supplied - * encryption key. If you are creating a new instance, this field encrypts - * the local SSD and in-memory contents of the instance using a key that you - * provide. If you are restarting an instance protected with a - * customer-supplied encryption key, you must provide the correct key in - * order to successfully restart the instance. If you do not provide an - * encryption key when creating the instance, then the local SSD and - * in-memory contents will be encrypted using an automatically generated key - * and you do not need to provide a key to start the instance later. - * Instance templates do not store customer-supplied encryption keys, so you - * cannot use your own keys to encrypt local SSDs and in-memory content in a - * managed instance group. + * Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group. */ instanceEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] Type of the resource. Always compute#instance for - * instances. + * [Output Only] Type of the resource. Always compute#instance for instances. */ kind?: string; /** - * A fingerprint for this request, which is essentially a hash of the - * label's contents and used for optimistic locking. The fingerprint is - * initially generated by Compute Engine and changes after every request to - * modify or update labels. You must always provide an up-to-date - * fingerprint hash in order to update or change labels. To see the latest - * fingerprint, make get() request to the instance. + * A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. */ labelFingerprint?: string; /** - * Labels to apply to this instance. These can be later modified by the - * setLabels method. + * Labels to apply to this instance. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** - * Full or partial URL of the machine type resource to use for this - * instance, in the format: zones/zone/machineTypes/machine-type. This is - * provided by the client when the instance is created. For example, the - * following is a valid partial url to a predefined machine type: - * zones/us-central1-f/machineTypes/n1-standard-1 To create a custom - * machine type, provide a URL to a machine type in the following format, - * where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and - * MEMORY is the total memory for this instance. Memory must be a multiple - * of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): - * zones/zone/machineTypes/custom-CPUS-MEMORY For example: - * zones/us-central1-f/machineTypes/custom-4-5120 For a full list of - * restrictions, read the Specifications for custom machine types. + * Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. */ machineType?: string; /** - * The metadata key/value pairs assigned to this instance. This includes - * custom metadata and predefined keys. + * The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. */ metadata?: Schema$Metadata; /** - * Specifies a minimum CPU platform for the VM instance. Applicable values - * are the friendly names of CPU platforms, such as minCpuPlatform: - * "Intel Haswell" or minCpuPlatform: "Intel Sandy - * Bridge". + * Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". */ minCpuPlatform?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * An array of network configurations for this instance. These specify how - * interfaces are configured to interact with other network services, such - * as connecting to the internet. Multiple interfaces are supported per - * instance. + * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. */ networkInterfaces?: Schema$NetworkInterface[]; /** - * Total amount of preserved state for SUSPENDED instances. Read-only in the - * api. + * Total amount of preserved state for SUSPENDED instances. Read-only in the api. */ preservedStateSizeGb?: string; /** - * The configuration of desired allocations which this Instance could - * consume capacity from. + * The configuration of desired allocations which this Instance could consume capacity from. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -5761,11 +4211,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * A list of service accounts, with their specified scopes, authorized for - * this instance. Only one service account per VM instance is supported. - * Service accounts generate access tokens that can be accessed through the - * metadata server and used to authenticate applications on the instance. - * See Service Accounts for more information. + * A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. */ serviceAccounts?: Schema$ServiceAccount[]; shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; @@ -5781,14 +4227,11 @@ export namespace compute_alpha { */ sourceMachineImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] Whether a VM has been restricted for start because Compute - * Engine has detected suspicious activity. + * [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. */ startRestricted?: boolean; /** - * [Output Only] The status of the instance. One of the following values: - * PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, - * and TERMINATED. + * [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. */ status?: string; /** @@ -5796,17 +4239,11 @@ export namespace compute_alpha { */ statusMessage?: string; /** - * Tags to apply to this instance. Tags are used to identify valid sources - * or targets for network firewalls and are specified by the client during - * instance creation. The tags can be later modified by the setTags method. - * Each tag within the list must comply with RFC1035. Multiple tags can be - * specified via the 'tags.items' field. + * Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. */ tags?: Schema$Tags; /** - * [Output Only] URL of the zone where the instance resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -5820,16 +4257,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$InstancesScopedList}; /** - * [Output Only] Type of resource. Always compute#instanceAggregatedList for - * aggregated lists of Instance resources. + * [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5846,63 +4278,47 @@ export namespace compute_alpha { }; } /** - * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for - * v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== - * resource_for v1.regionInstanceGroups ==) + * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** - * [Output Only] The creation timestamp for this instance group in RFC3339 - * text format. + * [Output Only] The creation timestamp for this instance group in RFC3339 text format. */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The fingerprint of the named ports. The system uses this - * fingerprint to detect conflicts when multiple users change the named - * ports concurrently. + * [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. */ fingerprint?: string; /** - * [Output Only] A unique identifier for this instance group, generated by - * the server. + * [Output Only] A unique identifier for this instance group, generated by the server. */ id?: string; /** - * [Output Only] The resource type, which is always compute#instanceGroup - * for instance groups. + * [Output Only] The resource type, which is always compute#instanceGroup for instance groups. */ kind?: string; /** - * The name of the instance group. The name must be 1-63 characters long, - * and comply with RFC1035. + * The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** - * Assigns a name to a port number. For example: {name: "http", - * port: 80} This allows the system to reference ports by the assigned name - * instead of a port number. Named ports can also contain multiple ports. - * For example: [{name: "http", port: 80},{name: "http", - * port: 8080}] Named ports apply to all instances in this instance group. + * Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. */ namedPorts?: Schema$NamedPort[]; /** - * The URL of the network to which all instances in the instance group - * belong. + * The URL of the network to which all instances in the instance group belong. */ network?: string; /** - * [Output Only] The URL of the region where the instance group is located - * (for regional resources). + * [Output Only] The URL of the region where the instance group is located (for regional resources). */ region?: string; /** - * [Output Only] The URL for this instance group. The server generates this - * URL. + * [Output Only] The URL for this instance group. The server generates this URL. */ selfLink?: string; /** @@ -5914,13 +4330,11 @@ export namespace compute_alpha { */ size?: number; /** - * [Output Only] The URL of the subnetwork to which all instances in the - * instance group belong. + * [Output Only] The URL of the subnetwork to which all instances in the instance group belong. */ subnetwork?: string; /** - * [Output Only] The URL of the zone where the instance group is located - * (for zonal resources). + * [Output Only] The URL of the zone where the instance group is located (for zonal resources). */ zone?: string; } @@ -5934,17 +4348,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$InstanceGroupsScopedList}; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupAggregatedList for aggregated lists of instance - * groups. + * [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5973,16 +4381,11 @@ export namespace compute_alpha { */ items?: Schema$InstanceGroup[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupList for instance group lists. + * [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5999,61 +4402,43 @@ export namespace compute_alpha { }; } /** - * An Instance Group Manager resource. (== resource_for - * beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers - * ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for - * v1.regionInstanceGroupManagers ==) + * An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** - * The autohealing policy for this managed instance group. You can specify - * only one value. + * The autohealing policy for this managed instance group. You can specify only one value. */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must - * be 1-58 characters long. Instances are named by appending a hyphen and a - * random four-character string to the base instance name. The base instance - * name must comply with RFC1035. + * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. */ baseInstanceName?: string; /** - * [Output Only] The creation timestamp for this managed instance group in - * RFC3339 text format. + * [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. */ creationTimestamp?: string; /** - * [Output Only] The list of instance actions and the number of instances in - * this managed instance group that are scheduled for each of those actions. + * [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. */ currentActions?: Schema$InstanceGroupManagerActionsSummary; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Policy specifying intended distribution of instances in regional managed - * instance group. + * Policy specifying intended distribution of instances in regional managed instance group. */ distributionPolicy?: Schema$DistributionPolicy; /** - * The action to perform in case of zone failure. Only one value is - * supported, NO_FAILOVER. The default is NO_FAILOVER. + * The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. */ failoverAction?: string; /** - * Fingerprint of this resource. This field may be used in optimistic - * locking. It will be ignored when inserting an InstanceGroupManager. An - * up-to-date fingerprint must be provided in order to update the - * InstanceGroupManager, otherwise the request will fail with error 412 - * conditionNotMet. To see the latest fingerprint, make a get() request to - * retrieve an InstanceGroupManager. + * Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. */ fingerprint?: string; /** - * [Output Only] A unique identifier for this resource type. The server - * generates this identifier. + * [Output Only] A unique identifier for this resource type. The server generates this identifier. */ id?: string; /** @@ -6061,43 +4446,31 @@ export namespace compute_alpha { */ instanceGroup?: string; /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create all new instances - * in the managed instance group. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ instanceTemplate?: string; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManager for managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. */ kind?: string; /** - * The name of the managed instance group. The name must be 1-63 characters - * long, and comply with RFC1035. + * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** - * Named ports configured for the Instance Groups complementary to this - * Instance Group Manager. + * Named ports configured for the Instance Groups complementary to this Instance Group Manager. */ namedPorts?: Schema$NamedPort[]; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The list of instance actions and the - * number of instances in this managed instance group that are pending for - * each of those actions. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions. */ pendingActions?: Schema$InstanceGroupManagerPendingActionsSummary; /** - * [Output Only] The URL of the region where the managed instance group - * resides (for regional resources). + * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ region?: string; /** - * [Output Only] The URL for this managed instance group. The server defines - * this URL. + * [Output Only] The URL for this managed instance group. The server defines this URL. */ selfLink?: string; /** @@ -6105,11 +4478,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * The service account to be used as credentials for all operations - * performed by the managed instance group on instances. The service - * accounts needs all permissions required to create and delete instances. - * By default, the service account - * {projectNumber}@cloudservices.gserviceaccount.com is used. + * The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. */ serviceAccount?: string; /** @@ -6121,15 +4490,11 @@ export namespace compute_alpha { */ status?: Schema$InstanceGroupManagerStatus; /** - * The URLs for all TargetPool resources to which instances in the - * instanceGroup field are added. The target pools automatically apply to - * all of the instances in the managed instance group. + * The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ targetPools?: string[]; /** - * The target number of running instances for this managed instance group. - * Deleting or abandoning instances reduces this number. Resizing the group - * changes this number. + * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. */ targetSize?: number; /** @@ -6137,78 +4502,49 @@ export namespace compute_alpha { */ updatePolicy?: Schema$InstanceGroupManagerUpdatePolicy; /** - * Specifies the instance templates used by this managed instance group to - * create instances. Each version is defined by an instanceTemplate and a - * name. Every version can appear at most once per instance group. This - * field overrides the top-level instanceTemplate field. Read more about the - * relationships between these fields. Exactly one version must leave the - * targetSize field unset. That version will be applied to all remaining - * instances. For more information, read about canary updates. + * Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. */ versions?: Schema$InstanceGroupManagerVersion[]; /** - * [Output Only] The URL of the zone where the managed instance group is - * located (for zonal resources). + * [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). */ zone?: string; } export interface Schema$InstanceGroupManagerActionsSummary { /** - * [Output Only] The total number of instances in the managed instance group - * that are scheduled to be abandoned. Abandoning an instance removes it - * from the managed instance group without deleting it. + * [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. */ abandoning?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be created or are currently being created. If the group - * fails to create any of these instances, it tries again until it creates - * the instance successfully. If you have disabled creation retries, this - * field will not be populated; instead, the creatingWithoutRetries field - * will be populated. + * [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. */ creating?: number; /** - * [Output Only] The number of instances that the managed instance group - * will attempt to create. The group attempts to create each instance only - * once. If the group fails to create any of these instances, it decreases - * the group's targetSize value accordingly. + * [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. */ creatingWithoutRetries?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be deleted or are currently being deleted. + * [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. */ deleting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are running and have no scheduled actions. + * [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. */ none?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be recreated or are currently being being recreated. - * Recreating an instance deletes the existing root persistent disk and - * creates a new disk from the image that is defined in the instance - * template. + * [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. */ recreating?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are being reconfigured with properties that do not require a restart or a - * recreate action. For example, setting or removing target pools for the - * instance. + * [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. */ refreshing?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be restarted or are currently being restarted. + * [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. */ restarting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are being verified. See the managedInstances[].currentAction property in - * the listManagedInstances method documentation. + * [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. */ verifying?: number; } @@ -6222,17 +4558,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$InstanceGroupManagersScopedList}; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerAggregatedList for an aggregated list of - * managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6254,27 +4584,11 @@ export namespace compute_alpha { */ healthCheck?: string; /** - * The number of seconds that the managed instance group waits before it - * applies autohealing policies to new instances or recently recreated - * instances. This initial delay allows instances to initialize and run - * their startup scripts before the instance group determines that they are - * UNHEALTHY. This prevents the managed instance group from recreating its - * instances prematurely. This value must be from range [0, 3600]. + * The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. */ initialDelaySec?: number; /** - * Maximum number of instances that can be unavailable when autohealing. - * When 'percent' is used, the value is rounded UP. The instance is - * considered available if all of the following conditions are satisfied: 1. - * Instance's status is RUNNING. 2. Instance's currentAction is NONE - * (in particular its liveness health check result was observed to be - * HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing - * action on an instance triggered by IGM. By default, number of - * concurrently autohealed instances is smaller than the managed instance - * group target size. However, if a zonal managed instance group has only - * one instance, or a regional managed instance group has only one instance - * per zone, autohealing will recreate these instances when they become - * unhealthy. + * Maximum number of instances that can be unavailable when autohealing. When 'percent' is used, the value is rounded UP. The instance is considered available if all of the following conditions are satisfied: 1. Instance's status is RUNNING. 2. Instance's currentAction is NONE (in particular its liveness health check result was observed to be HEALTHY at least once as it passed VERIFYING). 3. There is no outgoing action on an instance triggered by IGM. By default, number of concurrently autohealed instances is smaller than the managed instance group target size. However, if a zonal managed instance group has only one instance, or a regional managed instance group has only one instance per zone, autohealing will recreate these instances when they become unhealthy. */ maxUnavailable?: Schema$FixedOrPercent; } @@ -6291,16 +4605,11 @@ export namespace compute_alpha { */ items?: Schema$InstanceGroupManager[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerList for a list of managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6318,42 +4627,25 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupManagerPendingActionsSummary { /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be created. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created. */ creating?: number; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be deleted. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted. */ deleting?: number; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be recreated. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated. */ recreating?: number; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be restarted. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted. */ restarting?: number; } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** - * The URLs of one or more instances to abandon. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -6362,25 +4654,19 @@ export namespace compute_alpha { */ export interface Schema$InstanceGroupManagersApplyUpdatesRequest { /** - * The list of URLs of one or more instances for which we want to apply - * updates on this managed instance group. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The list of URLs of one or more instances for which we want to apply updates on this managed instance group. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; /** - * The maximal action that should be performed on the instances. By default - * REPLACE. This field is deprecated, please use - * most_disruptive_allowed_action. + * The maximal action that should be performed on the instances. By default REPLACE. This field is deprecated, please use most_disruptive_allowed_action. */ maximalAction?: string; /** - * The minimal action that should be perfomed on the instances. By default - * NONE. + * The minimal action that should be perfomed on the instances. By default NONE. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. - * By default REPLACE. + * The most disruptive action that allowed to be performed on the instances. By default REPLACE. */ mostDisruptiveAllowedAction?: string; } @@ -6395,8 +4681,7 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupManagersDeleteInstancesRequest { /** - * The URLs of one or more instances to delete. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -6405,13 +4690,11 @@ export namespace compute_alpha { */ export interface Schema$InstanceGroupManagersDeletePerInstanceConfigsReq { /** - * The list of instances for which we want to delete per-instance configs on - * this managed instance group. + * The list of instances for which we want to delete per-instance configs on this managed instance group. */ instances?: string[]; /** - * The list of instance names for which we want to delete per-instance - * configs on this managed instance group. + * The list of instance names for which we want to delete per-instance configs on this managed instance group. */ names?: string[]; } @@ -6421,11 +4704,7 @@ export namespace compute_alpha { */ managedInstances?: Schema$ManagedInstance[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; } @@ -6435,11 +4714,7 @@ export namespace compute_alpha { */ items?: Schema$PerInstanceConfig[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6456,54 +4731,33 @@ export namespace compute_alpha { */ export interface Schema$InstanceGroupManagersPatchPerInstanceConfigsReq { /** - * The list of per-instance configs to insert or patch on this managed - * instance group. + * The list of per-instance configs to insert or patch on this managed instance group. */ perInstanceConfigs?: Schema$PerInstanceConfig[]; } export interface Schema$InstanceGroupManagersRecreateInstancesRequest { /** - * The URLs of one or more instances to recreate. This can be a full URL or - * a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } export interface Schema$InstanceGroupManagersResizeAdvancedRequest { /** - * If this flag is true, the managed instance group attempts to create all - * instances initiated by this resize request only once. If there is an - * error during creation, the managed instance group does not retry create - * this instance, and we will decrease the targetSize of the request - * instead. If the flag is false, the group attempts to recreate each - * instance continuously until it succeeds. This flag matters only in the - * first attempt of creation of an instance. After an instance is - * successfully created while this flag is enabled, the instance behaves the - * same way as all the other instances created with a regular resize - * request. In particular, if a running instance dies unexpectedly at a - * later time and needs to be recreated, this mode does not affect the - * recreation behavior in that scenario. This flag is applicable only to - * the current resize request. It does not influence other resize requests - * in any way. You can see which instances is being creating in which mode - * by calling the get or listManagedInstances API. + * If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds. This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario. This flag is applicable only to the current resize request. It does not influence other resize requests in any way. You can see which instances is being creating in which mode by calling the get or listManagedInstances API. */ noCreationRetries?: boolean; /** - * The number of running instances that the managed instance group should - * maintain at any given time. The group automatically adds or removes - * instances to maintain the number of instances specified by this - * parameter. + * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. */ targetSize?: number; } export interface Schema$InstanceGroupManagersScopedList { /** - * [Output Only] The list of managed instance groups that are contained in - * the specified project and zone. + * [Output Only] The list of managed instance groups that are contained in the specified project and zone. */ instanceGroupManagers?: Schema$InstanceGroupManager[]; /** - * [Output Only] The warning that replaces the list of managed instance - * groups when the list is empty. + * [Output Only] The warning that replaces the list of managed instance groups when the list is empty. */ warning?: { code?: string; @@ -6516,53 +4770,33 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupManagersSetInstanceTemplateRequest { /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create all new instances - * in the managed instance group. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ instanceTemplate?: string; } export interface Schema$InstanceGroupManagersSetTargetPoolsRequest { /** - * The fingerprint of the target pools information. Use this optional - * property to prevent conflicts when multiple users change the target pools - * settings concurrently. Obtain the fingerprint with the - * instanceGroupManagers.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. + * The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ fingerprint?: string; /** - * The list of target pool URLs that instances in this managed instance - * group belong to. The managed instance group applies these target pools to - * all of the instances in the group. Existing instances and new instances - * in the group all receive these target pool settings. + * The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings. */ targetPools?: string[]; } export interface Schema$InstanceGroupManagerStatus { /** - * [Output Only] A bit indicating whether the managed instance group is in a - * stable state. A stable state means that: none of the instances in the - * managed instance group is currently undergoing any type of change (for - * example, creation, restart, or deletion); no future changes are scheduled - * for instances in the managed instance group; and the managed instance - * group itself is not being modified. + * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ isStable?: boolean; /** - * [Output Only] A status of consistency of Instances' versions with - * their target version specified by version field on Instance Group - * Manager. + * [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. */ versionTarget?: Schema$InstanceGroupManagerStatusVersionTarget; } export interface Schema$InstanceGroupManagerStatusVersionTarget { /** - * [Output Only] A bit indicating whether version target has been reached in - * this managed instance group, i.e. all instances are in their target - * version. Instances' target version are specified by version field on - * Instance Group Manager. + * [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. */ isReached?: boolean; } @@ -6571,88 +4805,49 @@ export namespace compute_alpha { */ export interface Schema$InstanceGroupManagersUpdatePerInstanceConfigsReq { /** - * The list of per-instance configs to insert or patch on this managed - * instance group. + * The list of per-instance configs to insert or patch on this managed instance group. */ perInstanceConfigs?: Schema$PerInstanceConfig[]; } export interface Schema$InstanceGroupManagerUpdatePolicy { instanceRedistributionType?: string; /** - * The maximum number of instances that can be created above the specified - * targetSize during the update process. By default, a fixed value of 1 is - * used. This value can be either a fixed number or a percentage if the - * instance group has 10 or more instances. If you set a percentage, the - * number of instances will be rounded up if necessary. At least one of - * either maxSurge or maxUnavailable must be greater than 0. Learn more - * about maxSurge. + * The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. */ maxSurge?: Schema$FixedOrPercent; /** - * The maximum number of instances that can be unavailable during the update - * process. An instance is considered available if all of the following - * conditions are satisfied: - The instance's status is RUNNING. - - * If there is a health check on the instance group, the instance's - * liveness health check result must be HEALTHY at least once. If there is - * no health check on the group, then the instance only needs to have a - * status of RUNNING to be considered available. By default, a fixed value - * of 1 is used. This value can be either a fixed number or a percentage if - * the instance group has 10 or more instances. If you set a percentage, the - * number of instances will be rounded up if necessary. At least one of - * either maxSurge or maxUnavailable must be greater than 0. Learn more - * about maxUnavailable. + * The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. */ maxUnavailable?: Schema$FixedOrPercent; /** - * Minimal action to be taken on an instance. You can specify either RESTART - * to restart existing instances or REPLACE to delete and create new - * instances from the target template. If you specify a RESTART, the Updater - * will attempt to perform that action only. However, if the Updater - * determines that the minimal action you specify is not enough to perform - * the update, it might perform a more disruptive action. + * Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. */ minimalAction?: string; /** - * Minimum number of seconds to wait for after a newly created instance - * becomes available. This value must be from range [0, 3600]. + * Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. */ minReadySec?: number; /** - * What action should be used to replace instances. See - * minimal_action.REPLACE + * What action should be used to replace instances. See minimal_action.REPLACE */ replacementMethod?: string; type?: string; } export interface Schema$InstanceGroupManagerVersion { /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create new instances in - * the managed instance group until the `targetSize` for this version is - * reached. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. */ instanceTemplate?: string; /** - * Name of the version. Unique among all versions in the scope of this - * managed instance group. + * Name of the version. Unique among all versions in the scope of this managed instance group. */ name?: string; /** - * Tag describing the version. Used to trigger rollout of a target version - * even if instance_template remains unchanged. Deprecated in favor of - * 'name'. + * Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged. Deprecated in favor of 'name'. */ tag?: string; /** - * Specifies the intended number of instances to be created from the - * instanceTemplate. The final number of instances created from the template - * will be equal to: - If expressed as a fixed number, the minimum of - * either targetSize.fixed or instanceGroupManager.targetSize is used. - if - * expressed as a percent, the targetSize would be (targetSize.percent/100 * - * InstanceGroupManager.targetSize) If there is a remainder, the number is - * rounded up. If unset, this version will update any remaining instances - * not updated by another version. Read Starting a canary update for more - * information. + * Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. */ targetSize?: Schema$FixedOrPercent; } @@ -6672,17 +4867,11 @@ export namespace compute_alpha { */ items?: Schema$InstanceWithNamedPorts[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupsListInstances for the list of instances in the - * specified instance group. + * [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6700,9 +4889,7 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupsListInstancesRequest { /** - * A filter for the state of the instances in the instance group. Valid - * options are ALL or RUNNING. If you do not specify this parameter the list - * includes all instances regardless of their state. + * A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. */ instanceState?: string; } @@ -6714,13 +4901,11 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupsScopedList { /** - * [Output Only] The list of instance groups that are contained in this - * scope. + * [Output Only] The list of instance groups that are contained in this scope. */ instanceGroups?: Schema$InstanceGroup[]; /** - * [Output Only] An informational warning that replaces the list of instance - * groups when the list is empty. + * [Output Only] An informational warning that replaces the list of instance groups when the list is empty. */ warning?: { code?: string; @@ -6730,13 +4915,7 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** - * The fingerprint of the named ports information for this instance group. - * Use this optional property to prevent conflicts when multiple users - * change the named ports settings concurrently. Obtain the fingerprint with - * the instanceGroups.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. A request with an incorrect fingerprint - * will fail with error 412 conditionNotMet. + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet. */ fingerprint?: string; /** @@ -6757,16 +4936,11 @@ export namespace compute_alpha { */ items?: Schema$Instance[]; /** - * [Output Only] Type of resource. Always compute#instanceList for lists of - * Instance resources. + * [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6795,16 +4969,11 @@ export namespace compute_alpha { */ items?: Schema$Reference[]; /** - * [Output Only] Type of resource. Always compute#instanceListReferrers for - * lists of Instance referrers. + * [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6822,49 +4991,33 @@ export namespace compute_alpha { } export interface Schema$InstanceMoveRequest { /** - * The URL of the destination zone to move the instance. This can be a full - * or partial URL. For example, the following are all valid URLs to a zone: - * - https://www.googleapis.com/compute/v1/projects/project/zones/zone - - * projects/project/zones/zone - zones/zone + * The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone */ destinationZone?: string; /** - * The URL of the target instance to move. This can be a full or partial - * URL. For example, the following are all valid URLs to an instance: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance - - * zones/zone/instances/instance + * The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ targetInstance?: string; } export interface Schema$InstanceProperties { /** - * Enables instances created based on this template to send packets with - * source IP addresses other than their own and receive packets with - * destination IP addresses other than their own. If these instances will be - * used as an IP gateway or it will be set as the next-hop in a Route - * resource, specify true. If unsure, leave this set to false. See the - * Enable IP forwarding documentation for more information. + * Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. */ canIpForward?: boolean; /** - * An optional text description for the instances that are created from this - * instance template. + * An optional text description for the instances that are created from this instance template. */ description?: string; /** - * An array of disks that are associated with the instances that are created - * from this template. + * An array of disks that are associated with the instances that are created from this template. */ disks?: Schema$AttachedDisk[]; /** - * Display Device properties to enable support for remote display products - * like: Teradici, VNC and TeamViewer + * Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer */ displayDevice?: Schema$DisplayDevice; /** - * A list of guest accelerator cards' type and count to use for - * instances created from the instance template. + * A list of guest accelerator cards' type and count to use for instances created from the instance template. */ guestAccelerators?: Schema$AcceleratorConfig[]; /** @@ -6872,22 +5025,15 @@ export namespace compute_alpha { */ labels?: {[key: string]: string}; /** - * The machine type to use for instances that are created from this - * template. + * The machine type to use for instances that are created from this template. */ machineType?: string; /** - * The metadata key/value pairs to assign to instances that are created from - * this template. These pairs can consist of custom metadata or predefined - * keys. See Project and instance metadata for more information. + * The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. */ metadata?: Schema$Metadata; /** - * Minimum cpu/platform to be used by this instance. The instance may be - * scheduled on the specified or newer cpu/platform. Applicable values are - * the friendly names of CPU platforms, such as minCpuPlatform: "Intel - * Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more - * information, read Specifying a Minimum CPU Platform. + * Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. */ minCpuPlatform?: string; /** @@ -6895,33 +5041,24 @@ export namespace compute_alpha { */ networkInterfaces?: Schema$NetworkInterface[]; /** - * The configuration of desired reservations which this Instance could - * consume capacity from. + * The configuration of desired reservations which this Instance could consume capacity from. */ reservationAffinity?: Schema$ReservationAffinity; /** - * Specifies the scheduling options for the instances that are created from - * this template. + * Specifies the scheduling options for the instances that are created from this template. */ scheduling?: Schema$Scheduling; /** - * A list of service accounts with specified scopes. Access tokens for these - * service accounts are available to the instances that are created from - * this template. Use metadata queries to obtain the access tokens for these - * instances. + * A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. */ serviceAccounts?: Schema$ServiceAccount[]; shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; /** - * Specifies the Shielded VM options for the instances that are created from - * this template. + * Specifies the Shielded VM options for the instances that are created from this template. */ shieldedVmConfig?: Schema$ShieldedVmConfig; /** - * A list of tags to apply to the instances that are created from this - * template. The tags identify valid sources or targets for network - * firewalls. The setTags method can modify this list of tags. Each tag - * within the list must comply with RFC1035. + * A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. */ tags?: Schema$Tags; } @@ -6952,8 +5089,7 @@ export namespace compute_alpha { */ export interface Schema$InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy { /** - * The unique identifier for the security policy. This identifier is defined - * by the server. + * The unique identifier for the security policy. This identifier is defined by the server. */ id?: string; /** @@ -6969,18 +5105,11 @@ export namespace compute_alpha { } export interface Schema$InstancesResumeRequest { /** - * Array of disks associated with this instance that are protected with a - * customer-supplied encryption key. In order to resume the instance, the - * disk url and its corresponding key must be provided. If the disk is not - * protected with a customer-supplied encryption key it should not be - * specified. + * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. */ disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; /** - * Decrypts data associated with an instance that is protected with a - * customer-supplied encryption key. If the instance you are starting is - * protected with a customer-supplied encryption key, the correct key must - * be provided otherwise the instance resume will not succeed. + * Decrypts data associated with an instance that is protected with a customer-supplied encryption key. If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed. */ instanceEncryptionKey?: Schema$CustomerEncryptionKey; } @@ -6990,8 +5119,7 @@ export namespace compute_alpha { */ instances?: Schema$Instance[]; /** - * [Output Only] Informational warning which replaces the list of instances - * when the list is empty. + * [Output Only] Informational warning which replaces the list of instances when the list is empty. */ warning?: { code?: string; @@ -7001,25 +5129,20 @@ export namespace compute_alpha { } export interface Schema$InstancesSetLabelsRequest { /** - * Fingerprint of the previous set of labels for this resource, used to - * prevent conflicts. Provide the latest fingerprint value when making a - * request to add or change labels. + * Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels. */ labelFingerprint?: string; labels?: {[key: string]: string}; } export interface Schema$InstancesSetMachineResourcesRequest { /** - * A list of the type and count of accelerator cards attached to the - * instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators?: Schema$AcceleratorConfig[]; } export interface Schema$InstancesSetMachineTypeRequest { /** - * Full or partial URL of the machine type resource. See Machine Types for a - * full list of machine types. For example: - * zones/us-central1-f/machineTypes/n1-standard-1 + * Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1 */ machineType?: string; } @@ -7041,54 +5164,36 @@ export namespace compute_alpha { } export interface Schema$InstancesStartWithEncryptionKeyRequest { /** - * Array of disks associated with this instance that are protected with a - * customer-supplied encryption key. In order to start the instance, the - * disk url and its corresponding key must be provided. If the disk is not - * protected with a customer-supplied encryption key it should not be - * specified. + * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. */ disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; /** - * Decrypts data associated with an instance that is protected with a - * customer-supplied encryption key. If the instance you are starting is - * protected with a customer-supplied encryption key, the correct key must - * be provided otherwise the instance start will not succeed. + * Decrypts data associated with an instance that is protected with a customer-supplied encryption key. If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed. */ instanceEncryptionKey?: Schema$CustomerEncryptionKey; } /** - * An Instance Template resource. (== resource_for beta.instanceTemplates ==) - * (== resource_for v1.instanceTemplates ==) + * An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** - * [Output Only] The creation timestamp for this instance template in - * RFC3339 text format. + * [Output Only] The creation timestamp for this instance template in RFC3339 text format. */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] A unique identifier for this instance template. The server - * defines this identifier. + * [Output Only] A unique identifier for this instance template. The server defines this identifier. */ id?: string; /** - * [Output Only] The resource type, which is always compute#instanceTemplate - * for instance templates. + * [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. */ kind?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -7096,8 +5201,7 @@ export namespace compute_alpha { */ properties?: Schema$InstanceProperties; /** - * [Output Only] The URL for this instance template. The server defines this - * URL. + * [Output Only] The URL for this instance template. The server defines this URL. */ selfLink?: string; /** @@ -7105,11 +5209,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * The source instance used to create the template. You can provide this as - * a partial or full URL to the resource. For example, the following are - * valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance + * The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance */ sourceInstance?: string; /** @@ -7130,16 +5230,11 @@ export namespace compute_alpha { */ items?: Schema$InstanceTemplate[]; /** - * [Output Only] The resource type, which is always - * compute#instanceTemplatesListResponse for instance template lists. + * [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7170,8 +5265,7 @@ export namespace compute_alpha { status?: string; } /** - * HttpRouteRuleMatch criteria for field values that must stay within the - * specified integer range. + * HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. */ export interface Schema$Int64RangeMatch { /** @@ -7184,22 +5278,15 @@ export namespace compute_alpha { rangeStart?: string; } /** - * Represents an Interconnects resource. The Interconnects resource is a - * dedicated connection between Google's network and your on-premises - * network. For more information, see the Dedicated overview page. (== - * resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) */ export interface Schema$Interconnect { /** - * Administrative status of the interconnect. When this is set to true, the - * Interconnect is functional and can carry traffic. When set to false, no - * packets can be carried over the interconnect and no BGP routes are - * exchanged over it. By default, the status is set to true. + * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. */ adminEnabled?: boolean; /** - * [Output Only] A list of CircuitInfo objects, that describe the individual - * circuits in this LAG. + * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. */ circuitInfos?: Schema$InterconnectCircuitInfo[]; /** @@ -7207,13 +5294,11 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * Customer name, to put in the Letter of Authorization as the party - * authorized to request a crossconnect. + * Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. */ customerName?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -7221,87 +5306,59 @@ export namespace compute_alpha { */ expectedOutages?: Schema$InterconnectOutageNotification[]; /** - * [Output Only] IP address configured on the Google side of the - * Interconnect link. This can be used only for ping tests. + * [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. */ googleIpAddress?: string; /** - * [Output Only] Google reference ID to be used when raising support tickets - * with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ googleReferenceId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] A list of the URLs of all InterconnectAttachments - * configured to use this Interconnect. + * [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. */ interconnectAttachments?: string[]; /** - * Type of interconnect. Note that "IT_PRIVATE" has been - * deprecated in favor of "DEDICATED" + * Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED" */ interconnectType?: string; /** - * [Output Only] Type of the resource. Always compute#interconnect for - * interconnects. + * [Output Only] Type of the resource. Always compute#interconnect for interconnects. */ kind?: string; /** - * A fingerprint for the labels being applied to this Interconnect, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an Interconnect. + * A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. */ labelFingerprint?: string; /** - * Labels to apply to this Interconnect resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Type of link requested. This field indicates speed of each of the links - * in the bundle, not the entire bundle. + * Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. */ linkType?: string; /** - * URL of the InterconnectLocation object that represents where this - * connection is to be provisioned. + * URL of the InterconnectLocation object that represents where this connection is to be provisioned. */ location?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Email address to contact the customer NOC for operations and maintenance - * notifications regarding this Interconnect. If specified, this will be - * used for notifications in addition to all other forms described, such as - * Stackdriver logs alerting and Cloud Notifications. + * Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. */ nocContactEmail?: string; /** - * [Output Only] The current status of whether or not this Interconnect is - * functional. + * [Output Only] The current status of whether or not this Interconnect is functional. */ operationalStatus?: string; /** - * [Output Only] IP address configured on the customer side of the - * Interconnect link. The customer should configure this IP address during - * turnup when prompted by Google NOC. This can be used only for ping tests. + * [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. */ peerIpAddress?: string; /** @@ -7309,8 +5366,7 @@ export namespace compute_alpha { */ provisionedLinkCount?: number; /** - * Target number of physical links in the link bundle, as requested by the - * customer. + * Target number of physical links in the link bundle, as requested by the customer. */ requestedLinkCount?: number; /** @@ -7322,42 +5378,28 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The current state of whether or not this Interconnect is - * functional. + * [Output Only] The current state of whether or not this Interconnect is functional. */ state?: string; } /** - * Represents an InterconnectAttachment (VLAN attachment) resource. For more - * information, see Creating VLAN Attachments. (== resource_for - * beta.interconnectAttachments ==) (== resource_for - * v1.interconnectAttachments ==) + * Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** - * Determines whether this Attachment will carry packets. Not present for - * PARTNER_PROVIDER. + * Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. */ adminEnabled?: boolean; /** - * Provisioned bandwidth capacity for the interconnectAttachment. Can be set - * by the partner to update the customer's provisioned bandwidth. Output - * only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. + * Provisioned bandwidth capacity for the interconnectAttachment. Can be set by the partner to update the customer's provisioned bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. */ bandwidth?: string; /** - * Up to 16 candidate prefixes that can be used to restrict the allocation - * of cloudRouterIpAddress and customerRouterIpAddress for this attachment. - * All prefixes must be within link-local address space (169.254.0.0/16) and - * must be /29 or shorter (/28, /27, etc). Google will attempt to select an - * unused /29 from the supplied candidate prefix(es). The request will fail - * if all possible /29s are in use on Google?s edge. If not supplied, Google - * will randomly select an unused /29 from all of link-local space. + * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ candidateSubnets?: string[]; /** - * [Output Only] IPv4 address + prefix length to be configured on Cloud - * Router Interface for this interconnect attachment. + * [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. */ cloudRouterIpAddress?: string; /** @@ -7365,8 +5407,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * [Output Only] IPv4 address + prefix length to be configured on the - * customer router subinterface for this interconnect attachment. + * [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. */ customerRouterIpAddress?: string; /** @@ -7374,104 +5415,63 @@ export namespace compute_alpha { */ description?: string; /** - * Desired availability domain for the attachment. Only available for type - * PARTNER, at creation time. For improved reliability, customers should - * configure a pair of attachments with one per availability domain. The - * selected availability domain will be provided to the Partner via the - * pairing key so that the provisioned circuit will lie in the specified - * domain. If not specified, the value will default to - * AVAILABILITY_DOMAIN_ANY. + * Desired availability domain for the attachment. Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with one per availability domain. The selected availability domain will be provided to the Partner via the pairing key so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ edgeAvailabilityDomain?: string; /** - * [Output Only] Google reference ID, to be used when raising support - * tickets with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ googleReferenceId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * URL of the underlying Interconnect object that this attachment's - * traffic will traverse through. + * URL of the underlying Interconnect object that this attachment's traffic will traverse through. */ interconnect?: string; /** - * [Output Only] Type of the resource. Always compute#interconnectAttachment - * for interconnect attachments. + * [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. */ kind?: string; /** - * A fingerprint for the labels being applied to this - * InterconnectAttachment, which is essentially a hash of the labels set - * used for optimistic locking. The fingerprint is initially generated by - * Compute Engine and changes after every request to modify or update - * labels. You must always provide an up-to-date fingerprint hash in order - * to update or change labels, otherwise the request will fail with error - * 412 conditionNotMet. To see the latest fingerprint, make a get() request - * to retrieve an InterconnectAttachment. + * A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. */ labelFingerprint?: string; /** - * Labels to apply to this InterconnectAttachment resource. These can be - * later modified by the setLabels method. Each label key/value must comply - * with RFC1035. Label values may be empty. + * Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] The current status of whether or not this interconnect - * attachment is functional. + * [Output Only] The current status of whether or not this interconnect attachment is functional. */ operationalStatus?: string; /** - * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not - * present for DEDICATED]. The opaque identifier of an PARTNER attachment - * used to initiate provisioning with a selected partner. Of the form - * "XXXXX/region/domain" + * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" */ pairingKey?: string; /** - * Optional BGP ASN for the router that should be supplied by a layer 3 - * Partner if they configured BGP on behalf of the customer. Output only for - * PARTNER type, input only for PARTNER_PROVIDER, not available for - * DEDICATED. + * Optional BGP ASN for the router that should be supplied by a layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ partnerAsn?: string; /** - * Informational metadata about Partner attachments from Partners to display - * to customers. Output only for for PARTNER type, mutable for - * PARTNER_PROVIDER, not available for DEDICATED. + * Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. */ partnerMetadata?: Schema$InterconnectAttachmentPartnerMetadata; /** - * [Output Only] Information specific to an InterconnectAttachment. This - * property is populated if the interconnect that this is attached to is of - * type DEDICATED. + * [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED. */ privateInterconnectInfo?: Schema$InterconnectAttachmentPrivateInfo; /** - * [Output Only] URL of the region where the regional interconnect - * attachment resides. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * URL of the Cloud Router to be used for dynamic routing. This router must - * be in the same region as this InterconnectAttachment. The - * InterconnectAttachment will automatically connect the Interconnect to the - * network & region within which the Cloud Router is configured. + * URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. */ router?: string; /** @@ -7488,8 +5488,7 @@ export namespace compute_alpha { state?: string; type?: string; /** - * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only - * specified at creation time. + * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. */ vlanTag8021q?: number; } @@ -7503,17 +5502,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$InterconnectAttachmentsScopedList}; /** - * [Output Only] Type of resource. Always - * compute#interconnectAttachmentAggregatedList for aggregated lists of - * interconnect attachments. + * [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7530,8 +5523,7 @@ export namespace compute_alpha { }; } /** - * Response to the list request, and contains a list of interconnect - * attachments. + * Response to the list request, and contains a list of interconnect attachments. */ export interface Schema$InterconnectAttachmentList { /** @@ -7543,16 +5535,11 @@ export namespace compute_alpha { */ items?: Schema$InterconnectAttachment[]; /** - * [Output Only] Type of resource. Always compute#interconnectAttachmentList - * for lists of interconnect attachments. + * [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7569,37 +5556,28 @@ export namespace compute_alpha { }; } /** - * Informational metadata about Partner attachments from Partners to display - * to customers. These fields are propagated from PARTNER_PROVIDER attachments - * to their corresponding PARTNER attachments. + * Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. */ export interface Schema$InterconnectAttachmentPartnerMetadata { /** - * Plain text name of the Interconnect this attachment is connected to, as - * displayed in the Partner?s portal. For instance "Chicago 1". - * This value may be validated to match approved Partner values. + * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ interconnectName?: string; /** - * Plain text name of the Partner providing this attachment. This value may - * be validated to match approved Partner values. + * Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values. */ partnerName?: string; /** - * URL of the Partner?s portal for this Attachment. Partners may customise - * this to be a deep-link to the specific resource on the Partner portal. - * This value may be validated to match approved Partner values. + * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep-link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string; } /** - * Information for an interconnect attachment when this belongs to an - * interconnect of type DEDICATED. + * Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. */ export interface Schema$InterconnectAttachmentPrivateInfo { /** - * [Output Only] 802.1q encapsulation tag to be used for traffic between - * Google and the customer, going to and from this network and region. + * [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region. */ tag8021q?: number; } @@ -7609,8 +5587,7 @@ export namespace compute_alpha { */ interconnectAttachments?: Schema$InterconnectAttachment[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -7619,9 +5596,7 @@ export namespace compute_alpha { }; } /** - * Describes a single physical circuit between the Customer and Google. - * CircuitInfo objects are created by Google, so all fields are output only. - * Next id: 4 + * Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 */ export interface Schema$InterconnectCircuitInfo { /** @@ -7633,25 +5608,20 @@ export namespace compute_alpha { */ googleCircuitId?: string; /** - * Google-side demarc ID for this circuit. Assigned at circuit turn-up and - * provided by Google to the customer in the LOA. + * Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. */ googleDemarcId?: string; } /** - * Diagnostics information about interconnect, contains detailed and current - * technical information about Google?s side of the connection. + * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. */ export interface Schema$InterconnectDiagnostics { /** - * A list of InterconnectDiagnostics.ARPEntry objects, describing individual - * neighbors currently seen by the Google router in the ARP cache for the - * Interconnect. This will be empty when the Interconnect is not bundled. + * A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled. */ arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; /** - * A list of InterconnectDiagnostics.LinkStatus objects, describing the - * status for each link on the Interconnect. + * A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect. */ links?: Schema$InterconnectDiagnosticsLinkStatus[]; /** @@ -7685,28 +5655,17 @@ export namespace compute_alpha { } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { /** - * The status of the current value when compared to the warning and alarm - * levels for the receiving or transmitting transceiver. Possible states - * include: - OK: The value has not crossed a warning threshold. - - * LOW_WARNING: The value has crossed below the low warning threshold. - - * HIGH_WARNING: The value has crossed above the high warning threshold. - - * LOW_ALARM: The value has crossed below the low alarm threshold. - - * HIGH_ALARM: The value has crossed above the high alarm threshold. + * The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. */ state?: string; /** - * Value of the current receiving or transmitting optical power, read in - * dBm. Take a known good optical value, give it a 10% margin and trigger - * warnings relative to that value. In general, a -7dBm warning and a -11dBm - * alarm are good optical value estimates for most links. + * Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. */ value?: number; } export interface Schema$InterconnectDiagnosticsLinkStatus { /** - * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP - * neighbor entries seen on this link. This will be empty if the link is - * bundled + * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled */ arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; /** @@ -7719,13 +5678,11 @@ export namespace compute_alpha { googleDemarc?: string; lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; /** - * An InterconnectDiagnostics.LinkOpticalPower object, describing the - * current value and status of the received light level. + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. */ receivingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; /** - * An InterconnectDiagnostics.LinkOpticalPower object, describing the - * current value and status of the transmitted light level. + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level. */ transmittingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; } @@ -7742,16 +5699,11 @@ export namespace compute_alpha { */ items?: Schema$Interconnect[]; /** - * [Output Only] Type of resource. Always compute#interconnectList for lists - * of interconnects. + * [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7768,27 +5720,19 @@ export namespace compute_alpha { }; } /** - * Represents an InterconnectLocations resource. The InterconnectLocations - * resource describes the locations where you can connect to Google's - * networks. For more information, see Colocation Facilities. + * Represents an InterconnectLocations resource. The InterconnectLocations resource describes the locations where you can connect to Google's networks. For more information, see Colocation Facilities. */ export interface Schema$InterconnectLocation { /** - * [Output Only] The postal address of the Point of Presence, each line in - * the address is separated by a newline character. + * [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. */ address?: string; /** - * [Output Only] Availability zone for this InterconnectLocation. Within a - * metropolitan area (metro), maintenance will not be simultaneously - * scheduled in more than one availability zone. Example: "zone1" - * or "zone2". + * [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". */ availabilityZone?: string; /** - * [Output Only] Metropolitan area designator that indicates which city an - * interconnect is located. For example: "Chicago, IL", - * "Amsterdam, Netherlands". + * [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". */ city?: string; /** @@ -7808,18 +5752,15 @@ export namespace compute_alpha { */ facilityProvider?: string; /** - * [Output Only] A provider-assigned Identifier for this facility (e.g., - * Ashburn-DC1). + * [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). */ facilityProviderFacilityId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#interconnectLocation - * for interconnect locations. + * [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. */ kind?: string; /** @@ -7827,14 +5768,11 @@ export namespace compute_alpha { */ name?: string; /** - * [Output Only] The peeringdb identifier for this facility (corresponding - * with a netfac type in peeringdb). + * [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). */ peeringdbFacilityId?: string; /** - * [Output Only] A list of InterconnectLocation.RegionInfo objects, that - * describe parameters pertaining to the relation between this - * InterconnectLocation and various Google Cloud regions. + * [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. */ regionInfos?: Schema$InterconnectLocationRegionInfo[]; /** @@ -7846,15 +5784,12 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The status of this InterconnectLocation. If the status is - * AVAILABLE, new Interconnects may be provisioned in this - * InterconnectLocation. Otherwise, no new Interconnects may be provisioned. + * [Output Only] The status of this InterconnectLocation. If the status is AVAILABLE, new Interconnects may be provisioned in this InterconnectLocation. Otherwise, no new Interconnects may be provisioned. */ status?: string; } /** - * Response to the list request, and contains a list of interconnect - * locations. + * Response to the list request, and contains a list of interconnect locations. */ export interface Schema$InterconnectLocationList { /** @@ -7866,16 +5801,11 @@ export namespace compute_alpha { */ items?: Schema$InterconnectLocation[]; /** - * [Output Only] Type of resource. Always compute#interconnectLocationList - * for lists of interconnect locations. + * [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7892,14 +5822,11 @@ export namespace compute_alpha { }; } /** - * Information about any potential InterconnectAttachments between an - * Interconnect at a specific InterconnectLocation, and a specific Cloud - * Region. + * Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. */ export interface Schema$InterconnectLocationRegionInfo { /** - * Expected round-trip time in milliseconds, from this InterconnectLocation - * to a VM in this region. + * Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. */ expectedRttMs?: string; /** @@ -7916,8 +5843,7 @@ export namespace compute_alpha { */ export interface Schema$InterconnectOutageNotification { /** - * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs - * that will be affected. + * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. */ affectedCircuits?: string[]; /** @@ -7929,9 +5855,7 @@ export namespace compute_alpha { */ endTime?: string; /** - * Form this outage is expected to take. Note that the "IT_" - * versions of this enum have been deprecated in favor of the unprefixed - * values. + * Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values. */ issueType?: string; /** @@ -7939,9 +5863,7 @@ export namespace compute_alpha { */ name?: string; /** - * The party that generated this notification. Note that - * "NSRC_GOOGLE" has been deprecated in favor of - * "GOOGLE" + * The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE" */ source?: string; /** @@ -7949,8 +5871,7 @@ export namespace compute_alpha { */ startTime?: string; /** - * State of this notification. Note that the "NS_" versions of - * this enum have been deprecated in favor of the unprefixed values. + * State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values. */ state?: string; } @@ -8006,16 +5927,11 @@ export namespace compute_alpha { */ items?: Schema$InternalIpAddress[]; /** - * [Output Only] Type of resource. Always compute#ipAddressesList for IP - * addresses lists. + * [Output Only] Type of resource. Always compute#ipAddressesList for IP addresses lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8044,16 +5960,11 @@ export namespace compute_alpha { */ items?: Schema$InternalIpOwner[]; /** - * [Output Only] Type of resource. Always compute#ipOwnerList for lists of - * IP owners. + * [Output Only] Type of resource. Always compute#ipOwnerList for lists of IP owners. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8074,16 +5985,11 @@ export namespace compute_alpha { */ export interface Schema$Jwt { /** - * A JWT containing any of these audiences will be accepted. The service - * name will be accepted if audiences is empty. Examples: - * bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * A JWT containing any of these audiences will be accepted. The service name will be accepted if audiences is empty. Examples: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string[]; /** - * Identifies the issuer that issued the JWT, which is usually a URL or an - * email address. Examples: https://securetoken.google.com, - * 1234567-compute@developer.gserviceaccount.com + * Identifies the issuer that issued the JWT, which is usually a URL or an email address. Examples: https://securetoken.google.com, 1234567-compute@developer.gserviceaccount.com */ issuer?: string; /** @@ -8091,22 +5997,11 @@ export namespace compute_alpha { */ jwksPublicKeys?: string; /** - * jwt_headers and jwt_params define where to extract the JWT from an HTTP - * request. If no explicit location is specified, the following default - * locations are tried in order: 1. The Authorization header using the - * Bearer schema. See `here `_. Example: Authorization: Bearer . 2. - * `access_token` query parameter. See `this `_ Multiple JWTs can be - * verified for a request. Each JWT has to be extracted from the locations - * its issuer specified or from the default locations. This field is set if - * JWT is sent in a request header. This field specifies the header name. - * For example, if `header=x-goog-iap-jwt-assertion`, the header format will - * be x-goog-iap-jwt-assertion: . + * jwt_headers and jwt_params define where to extract the JWT from an HTTP request. If no explicit location is specified, the following default locations are tried in order: 1. The Authorization header using the Bearer schema. See `here `_. Example: Authorization: Bearer . 2. `access_token` query parameter. See `this `_ Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations its issuer specified or from the default locations. This field is set if JWT is sent in a request header. This field specifies the header name. For example, if `header=x-goog-iap-jwt-assertion`, the header format will be x-goog-iap-jwt-assertion: . */ jwtHeaders?: Schema$JwtHeader[]; /** - * This field is set if JWT is sent in a query parameter. This field - * specifies the query parameter name. For example, if jwt_params[0] is - * jwt_token, the JWT format in the query parameter is /path?jwt_token=. + * This field is set if JWT is sent in a query parameter. This field specifies the query parameter name. For example, if jwt_params[0] is jwt_token, the JWT format in the query parameter is /path?jwt_token=. */ jwtParams?: string[]; } @@ -8119,9 +6014,7 @@ export namespace compute_alpha { */ name?: string; /** - * The value prefix. The value format is "value_prefix" For - * example, for "Authorization: Bearer ", - * value_prefix="Bearer " with a space at the end. + * The value prefix. The value format is "value_prefix" For example, for "Authorization: Bearer ", value_prefix="Bearer " with a space at the end. */ valuePrefix?: string; } @@ -8130,8 +6023,7 @@ export namespace compute_alpha { */ export interface Schema$License { /** - * [Output Only] Deprecated. This field no longer reflects whether a license - * charges a usage fee. + * [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. */ chargesUseFee?: boolean; /** @@ -8139,13 +6031,11 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -8153,13 +6043,11 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] The unique code used to attach this license to images, - * snapshots, and disks. + * [Output Only] The unique code used to attach this license to images, snapshots, and disks. */ licenseCode?: string; /** - * Name of the resource. The name must be 1-63 characters long and comply - * with RFC1035. + * Name of the resource. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; resourceRequirements?: Schema$LicenseResourceRequirements; @@ -8172,8 +6060,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * If false, licenses will not be copied from the source resource when - * creating an image from a disk, disk from snapshot, or snapshot from disk. + * If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. */ transferable?: boolean; } @@ -8187,8 +6074,7 @@ export namespace compute_alpha { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -8196,13 +6082,11 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] URL and description aliases of Licenses with the same - * License Code. + * [Output Only] URL and description aliases of Licenses with the same License Code. */ licenseAlias?: Schema$LicenseCodeLicenseAlias[]; /** - * [Output Only] Name of the resource. The name is 1-20 characters long and - * must be a valid 64 bit integer. + * [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. */ name?: string; /** @@ -8214,9 +6098,7 @@ export namespace compute_alpha { */ state?: string; /** - * [Output Only] If true, the license will remain attached when creating - * images or snapshots from disks. Otherwise, the license is not - * transferred. + * [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. */ transferable?: boolean; } @@ -8232,13 +6114,11 @@ export namespace compute_alpha { } export interface Schema$LicenseResourceRequirements { /** - * Minimum number of guest cpus required to use the Instance. Enforced at - * Instance creation and Instance start. + * Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. */ minGuestCpuCount?: number; /** - * Minimum memory required to use the Instance. Enforced at Instance - * creation and Instance start. + * Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. */ minMemoryMb?: number; } @@ -8252,11 +6132,7 @@ export namespace compute_alpha { */ items?: Schema$License[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8282,9 +6158,7 @@ export namespace compute_alpha { */ diskSizeGb?: string; /** - * Specifies the desired disk type on the node. This disk type must be a - * local storage type (e.g.: local-ssd). Note that for nodeTemplates, this - * should be the name of the disk type and not its URL. + * Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL. */ diskType?: string; } @@ -8319,22 +6193,7 @@ export namespace compute_alpha { logName?: string; } /** - * Increment a streamz counter with the specified metric and field names. - * Metric names should start with a '/', generally be lowercase-only, - * and end in "_count". Field names should not contain an initial - * slash. The actual exported metric names will have "/iam/policy" - * prepended. Field names correspond to IAM request parameters and field - * values are their respective values. Supported field names: - - * "authority", which is "[token]" if IAMContext.token is - * present, otherwise the value of IAMContext.authority_selector if present, - * and otherwise a representation of IAMContext.principal; or - - * "iam_principal", a representation of IAMContext.principal even if - * a token or authority selector is present; or - "" (empty string), - * resulting in a counter with no fields. Examples: counter { metric: - * "/debug_access_count" field: "iam_principal" } ==> - * increment counter /iam/policy/backend_debug_access_count - * {iam_principal=[value of IAMContext.principal]} At this time we do not - * support multiple field names (though this may be supported in the future). + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). */ export interface Schema$LogConfigCounterOptions { /** @@ -8351,12 +6210,7 @@ export namespace compute_alpha { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. NOTE: - * Logging to Gin in a fail-closed manner is currently unsupported while - * work is being done to satisfy the requirements of go/345. Currently, - * setting LOG_FAIL_CLOSED mode will have no effect, but still exists - * because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ logMode?: string; } @@ -8365,23 +6219,19 @@ export namespace compute_alpha { */ export interface Schema$MachineImage { /** - * [Output Only] The creation timestamp for this machine image in RFC3339 - * text format. + * [Output Only] The creation timestamp for this machine image in RFC3339 text format. */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] A unique identifier for this machine image. The server - * defines this identifier. + * [Output Only] A unique identifier for this machine image. The server defines this identifier. */ id?: string; /** - * [Output Only] The resource type, which is always compute#machineImage for - * machine image. + * [Output Only] The resource type, which is always compute#machineImage for machine image. */ kind?: string; /** @@ -8389,18 +6239,11 @@ export namespace compute_alpha { */ machineImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] The URL for this machine image. The server defines this - * URL. + * [Output Only] The URL for this machine image. The server defines this URL. */ selfLink?: string; /** @@ -8408,11 +6251,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * The source instance used to create the machine image. You can provide - * this as a partial or full URL to the resource. For example, the following - * are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance + * The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance */ sourceInstance?: string; /** @@ -8442,16 +6281,11 @@ export namespace compute_alpha { */ items?: Schema$MachineImage[]; /** - * [Output Only] The resource type, which is always - * compute#machineImagesListResponse for machine image lists. + * [Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8468,8 +6302,7 @@ export namespace compute_alpha { }; } /** - * A Machine Type resource. (== resource_for v1.machineTypes ==) (== - * resource_for beta.machineTypes ==) + * A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) */ export interface Schema$MachineType { /** @@ -8485,23 +6318,19 @@ export namespace compute_alpha { */ description?: string; /** - * [Output Only] The number of virtual CPUs that are available to the - * instance. + * [Output Only] The number of virtual CPUs that are available to the instance. */ guestCpus?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Whether this machine type has a shared CPU. See Shared-core - * machine types for more information. + * [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. */ isSharedCpu?: boolean; /** - * [Output Only] The type of the resource. Always compute#machineType for - * machine types. + * [Output Only] The type of the resource. Always compute#machineType for machine types. */ kind?: string; /** @@ -8513,8 +6342,7 @@ export namespace compute_alpha { */ maximumPersistentDisksSizeGb?: string; /** - * [Output Only] The amount of physical memory available to the instance, - * defined in MB. + * [Output Only] The amount of physical memory available to the instance, defined in MB. */ memoryMb?: number; /** @@ -8530,8 +6358,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The name of the zone where the machine type resides, such - * as us-central1-a. + * [Output Only] The name of the zone where the machine type resides, such as us-central1-a. */ zone?: string; } @@ -8545,16 +6372,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$MachineTypesScopedList}; /** - * [Output Only] Type of resource. Always compute#machineTypeAggregatedList - * for aggregated lists of machine types. + * [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8583,16 +6405,11 @@ export namespace compute_alpha { */ items?: Schema$MachineType[]; /** - * [Output Only] Type of resource. Always compute#machineTypeList for lists - * of machine types. + * [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8614,8 +6431,7 @@ export namespace compute_alpha { */ machineTypes?: Schema$MachineType[]; /** - * [Output Only] An informational warning that appears when the machine - * types list is empty. + * [Output Only] An informational warning that appears when the machine types list is empty. */ warning?: { code?: string; @@ -8628,36 +6444,15 @@ export namespace compute_alpha { */ export interface Schema$ManagedInstance { /** - * [Output Only] The current action that the managed instance group has - * scheduled for the instance. Possible values: - NONE The instance is - * running, and the managed instance group does not have any scheduled - * actions for this instance. - CREATING The managed instance group is - * creating this instance. If the group fails to create this instance, it - * will try again until it is successful. - CREATING_WITHOUT_RETRIES The - * managed instance group is attempting to create this instance only once. - * If the group fails to create this instance, it does not try again and the - * group's targetSize value is decreased instead. - RECREATING The - * managed instance group is recreating this instance. - DELETING The - * managed instance group is permanently deleting this instance. - - * ABANDONING The managed instance group is abandoning this instance. The - * instance will be removed from the instance group and from any target - * pools that are associated with this group. - RESTARTING The managed - * instance group is restarting the instance. - REFRESHING The managed - * instance group is applying configuration changes to the instance without - * stopping it. For example, the group can update the target pool list for - * an instance without stopping that instance. - VERIFYING The managed - * instance group has created the instance and it is in the process of being - * verified. + * [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. */ currentAction?: string; /** - * [Output only] The unique identifier for this resource. This field is - * empty when instance does not exist. + * [Output only] The unique identifier for this resource. This field is empty when instance does not exist. */ id?: string; /** - * [Output Only] The URL of the instance. The URL can exist even if the - * instance has not yet been created. + * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ instance?: string; /** @@ -8665,18 +6460,15 @@ export namespace compute_alpha { */ instanceHealth?: Schema$ManagedInstanceInstanceHealth[]; /** - * [Output Only] The status of the instance. This field is empty when the - * instance does not exist. + * [Output Only] The status of the instance. This field is empty when the instance does not exist. */ instanceStatus?: string; /** - * [Output Only] The intended template of the instance. This field is empty - * when current_action is one of { DELETING, ABANDONING }. + * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. */ instanceTemplate?: string; /** - * [Output Only] Information about the last attempt to create or delete the - * instance. + * [Output Only] Information about the last attempt to create or delete the instance. */ lastAttempt?: Schema$ManagedInstanceLastAttempt; /** @@ -8684,13 +6476,11 @@ export namespace compute_alpha { */ override?: Schema$ManagedInstanceOverride; /** - * [Output Only] Preserved state applied from per-instance config for this - * instance. + * [Output Only] Preserved state applied from per-instance config for this instance. */ preservedStateFromConfig?: Schema$PreservedState; /** - * [Output Only] Preserved state generated based on stateful policy for this - * instance. + * [Output Only] Preserved state generated based on stateful policy for this instance. */ preservedStateFromPolicy?: Schema$PreservedState; /** @@ -8708,8 +6498,7 @@ export namespace compute_alpha { */ detailedHealthState?: string; /** - * [Output Only] The URL for the health check that verifies whether the - * instance is healthy. + * [Output Only] The URL for the health check that verifies whether the instance is healthy. */ healthCheck?: string; /** @@ -8719,8 +6508,7 @@ export namespace compute_alpha { } export interface Schema$ManagedInstanceLastAttempt { /** - * [Output Only] Encountered errors during the last attempt to create or - * delete the instance. + * [Output Only] Encountered errors during the last attempt to create or delete the instance. */ errors?: { errors?: Array<{code?: string; location?: string; message?: string}>; @@ -8731,15 +6519,11 @@ export namespace compute_alpha { */ export interface Schema$ManagedInstanceOverride { /** - * Disk overrides defined for this instance. According to documentation the - * maximum number of disks attached to an instance is 128: - * https://cloud.google.com/compute/docs/disks/ However, compute API defines - * the limit at 140, so this is what we check. + * Disk overrides defined for this instance. According to documentation the maximum number of disks attached to an instance is 128: https://cloud.google.com/compute/docs/disks/ However, compute API defines the limit at 140, so this is what we check. */ disks?: Schema$ManagedInstanceOverrideDiskOverride[]; /** - * Metadata overrides defined for this instance. TODO(b/69785416) validate - * the total length is <9 KB + * Metadata overrides defined for this instance. TODO(b/69785416) validate the total length is <9 KB */ metadata?: Array<{key?: string; value?: string}>; /** @@ -8753,8 +6537,7 @@ export namespace compute_alpha { */ deviceName?: string; /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - * not specified, the default is to attach the disk in READ_WRITE mode. + * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. */ mode?: string; /** @@ -8764,8 +6547,7 @@ export namespace compute_alpha { } export interface Schema$ManagedInstanceVersion { /** - * [Output Only] The intended template of the instance. This field is empty - * when current_action is one of { DELETING, ABANDONING }. + * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. */ instanceTemplate?: string; /** @@ -8778,18 +6560,11 @@ export namespace compute_alpha { */ export interface Schema$Metadata { /** - * Specifies a fingerprint for this request, which is essentially a hash of - * the metadata's contents and used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve the resource. + * Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. */ fingerprint?: string; /** - * Array of key/value pairs. The total size of all keys and values must be - * less than 512 KB. + * Array of key/value pairs. The total size of all keys and values must be less than 512 KB. */ items?: Array<{key?: string; value?: string}>; /** @@ -8806,57 +6581,33 @@ export namespace compute_alpha { */ name?: string; /** - * A text proto that conforms to a Struct type definition interpreted by the - * plugin. + * A text proto that conforms to a Struct type definition interpreted by the plugin. */ structConfig?: string; } /** - * Opaque filter criteria used by loadbalancers to restrict routing - * configuration to a limited set of loadbalancing proxies. Proxies and - * sidecars involved in loadbalancing would typically present metadata to the - * loadbalancers which need to match criteria specified here. If a match takes - * place, the relevant routing configuration is made available to those - * proxies. For each metadataFilter in this list, if its filterMatchCriteria - * is set to MATCH_ANY, at least one of the filterLabels must match the - * corresponding label provided in the metadata. If its filterMatchCriteria is - * set to MATCH_ALL, then all of its filterLabels must match with - * corresponding labels in the provided metadata. An example for using - * metadataFilters would be: if loadbalancing involves Envoys, they will only - * receive routing configuration when values in metadataFilters match values - * supplied in <a - * href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" - * Node metadata of their XDS requests to loadbalancers. + * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. */ export interface Schema$MetadataFilter { /** - * The list of label value pairs that must match labels in the provided - * metadata based on filterMatchCriteria This list must not be empty and - * can have at the most 64 entries. + * The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. */ filterLabels?: Schema$MetadataFilterLabelMatch[]; /** - * Specifies how individual filterLabel matches within the list of - * filterLabels contribute towards the overall metadataFilter match. - * Supported values are: - MATCH_ANY: At least one of the filterLabels - * must have a matching label in the provided metadata. - MATCH_ALL: All - * filterLabels must have matching labels in the provided metadata. + * Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. */ filterMatchCriteria?: string; } /** - * MetadataFilter label name value pairs that are expected to match - * corresponding labels presented as metadata to the loadbalancer. + * MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. */ export interface Schema$MetadataFilterLabelMatch { /** - * Name of metadata label. The name can have a maximum length of 1024 - * characters and must be at least 1 character long. + * Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. */ name?: string; /** - * The value of the label must match the specified value. value can have a - * maximum length of 1024 characters. + * The value of the label must match the specified value. value can have a maximum length of 1024 characters. */ value?: string; } @@ -8865,10 +6616,7 @@ export namespace compute_alpha { */ export interface Schema$MutualTls { /** - * Specifies if the server TLS is configured to be strict or permissive. - * This field can be set to one of the following: STRICT: Client certificate - * must be presented, connection is in TLS. PERMISSIVE: Client certificate - * can be omitted, connection can be either plaintext or TLS. + * Specifies if the server TLS is configured to be strict or permissive. This field can be set to one of the following: STRICT: Client certificate must be presented, connection is in TLS. PERMISSIVE: Client certificate can be omitted, connection can be either plaintext or TLS. */ mode?: string; } @@ -8877,8 +6625,7 @@ export namespace compute_alpha { */ export interface Schema$NamedPort { /** - * The name for this named port. The name must be 1-63 characters long, and - * comply with RFC1035. + * The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** @@ -8887,17 +6634,11 @@ export namespace compute_alpha { port?: number; } /** - * Represents a Network resource. Read Virtual Private Cloud (VPC) Network - * Overview for more information. (== resource_for v1.networks ==) (== - * resource_for beta.networks ==) + * Represents a Network resource. Read Virtual Private Cloud (VPC) Network Overview for more information. (== resource_for v1.networks ==) (== resource_for beta.networks ==) */ export interface Schema$Network { /** - * When set to true, the VPC network is created in "auto" mode. - * When set to false, the VPC network is created in "custom" mode. - * An auto mode VPC network starts with one subnet per region. Each subnet - * has a predetermined range as described in Auto mode VPC network IP - * ranges. + * When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. */ autoCreateSubnetworks?: boolean; /** @@ -8909,25 +6650,19 @@ export namespace compute_alpha { */ crossVmEncryption?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The gateway address for default routing out of the network. - * This value is read only and is selected by GCP. + * [Output Only] The gateway address for default routing out of the network. This value is read only and is selected by GCP. */ gatewayIPv4?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Deprecated in favor of subnet mode networks. The range of internal - * addresses that are legal on this network. This range is a CIDR - * specification, for example: 192.168.0.0/16. Provided by the client when - * the network is created. + * Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. */ IPv4Range?: string; /** @@ -8939,19 +6674,11 @@ export namespace compute_alpha { */ loadBalancerVmEncryption?: string; /** - * The multicast mode for this network. If set to ZONAL, multicast is - * allowed within a zone. If set to DISABLED, multicast is disabled for this - * network. The default is DISABLED. + * The multicast mode for this network. If set to ZONAL, multicast is allowed within a zone. If set to DISABLED, multicast is disabled for this network. The default is DISABLED. */ multicastMode?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -8959,9 +6686,7 @@ export namespace compute_alpha { */ peerings?: Schema$NetworkPeering[]; /** - * The network-level routing configuration for this network. Used by Cloud - * Router to determine what type of network-wide routing behavior to - * enforce. + * The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. */ routingConfig?: Schema$NetworkRoutingConfig; /** @@ -8973,8 +6698,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] Server-defined fully-qualified URLs for all subnetworks in - * this VPC network. + * [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. */ subnetworks?: string[]; } @@ -8987,30 +6711,19 @@ export namespace compute_alpha { */ annotations?: {[key: string]: string}; /** - * Optional fully qualified domain name of network endpoint. This can only - * be specified when NetworkEndpointGroup.network_endpoint_type is - * NON_GCP_FQDN_PORT. + * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. */ fqdn?: string; /** - * The name for a specific VM instance that the IP address belongs to. This - * is required for network endpoints of type GCE_VM_IP_PORT. The instance - * must be in the same zone of network endpoint group. The name must be - * 1-63 characters long, and comply with RFC1035. + * The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035. */ instance?: string; /** - * Optional IPv4 address of network endpoint. The IP address must belong to - * a VM in GCE (either the primary IP or as part of an aliased IP range). If - * the IP address is not specified, then the primary IP address for the VM - * instance in the network that the network endpoint group belongs to will - * be used. + * Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. */ ipAddress?: string; /** - * Optional port number of network endpoint. If not specified and the - * NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the - * defaultPort for the network endpoint group will be used. + * Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used. */ port?: number; } @@ -9027,48 +6740,35 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * The default port used if the port number is not specified in the network - * endpoint. + * The default port used if the port number is not specified in the network endpoint. */ defaultPort?: number; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#networkEndpointGroup - * for network endpoint group. + * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. */ kind?: string; /** - * This field is only valid when the network endpoint group is used for load - * balancing. [Deprecated] This field is deprecated. + * This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated. */ loadBalancer?: Schema$NetworkEndpointGroupLbNetworkEndpointGroup; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network to which all network endpoints in the NEG belong. - * Uses "default" project network if unspecified. + * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. */ network?: string; /** - * Type of network endpoints in this network endpoint group. Currently the - * only supported value is GCE_VM_IP_PORT. + * Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT. */ networkEndpointType?: string; /** @@ -9084,18 +6784,15 @@ export namespace compute_alpha { */ size?: number; /** - * Optional URL of the subnetwork to which all network endpoints in the NEG - * belong. + * Optional URL of the subnetwork to which all network endpoints in the NEG belong. */ subnetwork?: string; /** - * Specify the type of this network endpoint group. Only LOAD_BALANCING is - * valid for now. + * Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now. */ type?: string; /** - * [Output Only] The URL of the zone where the network endpoint group is - * located. + * [Output Only] The URL of the zone where the network endpoint group is located. */ zone?: string; } @@ -9109,17 +6806,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList}; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupAggregatedList for aggregated lists of - * network endpoint groups. + * [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9140,24 +6831,19 @@ export namespace compute_alpha { */ export interface Schema$NetworkEndpointGroupLbNetworkEndpointGroup { /** - * The default port used if the port number is not specified in the network - * endpoint. [Deprecated] This field is deprecated. + * The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. */ defaultPort?: number; /** - * The URL of the network to which all network endpoints in the NEG belong. - * Uses "default" project network if unspecified. [Deprecated] - * This field is deprecated. + * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated. */ network?: string; /** - * Optional URL of the subnetwork to which all network endpoints in the NEG - * belong. [Deprecated] This field is deprecated. + * Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. */ subnetwork?: string; /** - * [Output Only] The URL of the zone where the network endpoint group is - * located. [Deprecated] This field is deprecated. + * [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. */ zone?: string; } @@ -9171,16 +6857,11 @@ export namespace compute_alpha { */ items?: Schema$NetworkEndpointGroup[]; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupList for network endpoint group lists. + * [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9210,15 +6891,11 @@ export namespace compute_alpha { } export interface Schema$NetworkEndpointGroupsListEndpointsRequest { /** - * Optional list of endpoints to query. This is a more efficient but also - * limited version of filter parameter. Endpoints in the filter must have - * ip_address and port fields populated, other fields are not supported. + * Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported. */ endpointFilters?: Schema$NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter[]; /** - * Optional query parameter for showing the health status of each network - * endpoint. Valid options are SKIP or SHOW. If you don't specifiy this - * parameter, the health status of network endpoints will not be provided. + * Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided. */ healthStatus?: string; } @@ -9235,17 +6912,11 @@ export namespace compute_alpha { */ items?: Schema$NetworkEndpointWithHealthStatus[]; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupsListNetworkEndpoints for the list of network - * endpoints in the specified network endpoint group. + * [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9259,13 +6930,11 @@ export namespace compute_alpha { } export interface Schema$NetworkEndpointGroupsScopedList { /** - * [Output Only] The list of network endpoint groups that are contained in - * this scope. + * [Output Only] The list of network endpoint groups that are contained in this scope. */ networkEndpointGroups?: Schema$NetworkEndpointGroup[]; /** - * [Output Only] An informational warning that replaces the list of network - * endpoint groups when the list is empty. + * [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty. */ warning?: { code?: string; @@ -9288,67 +6957,39 @@ export namespace compute_alpha { */ export interface Schema$NetworkInterface { /** - * An array of configurations for this interface. Currently, only one access - * config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs - * specified, then this instance will have no external internet access. + * An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. */ accessConfigs?: Schema$AccessConfig[]; /** - * An array of alias IP ranges for this network interface. Can only be - * specified for network interfaces on subnet-mode networks. + * An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. */ aliasIpRanges?: Schema$AliasIpRange[]; /** - * Fingerprint hash of contents stored in this network interface. This field - * will be ignored when inserting an Instance or adding a NetworkInterface. - * An up-to-date fingerprint must be provided in order to update the - * NetworkInterface, otherwise the request will fail with error 412 - * conditionNotMet. + * Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. */ fingerprint?: string; /** - * [Output Only] An IPv6 internal network address for this network - * interface. + * [Output Only] An IPv6 internal network address for this network interface. */ ipv6Address?: string; /** - * [Output Only] Type of the resource. Always compute#networkInterface for - * network interfaces. + * [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. */ kind?: string; /** - * [Output Only] The name of the network interface, generated by the server. - * For network devices, these are eth0, eth1, etc. + * [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. */ name?: string; /** - * URL of the network resource for this instance. When creating an instance, - * if neither the network nor the subnetwork is specified, the default - * network global/networks/default is used; if the network is not specified - * but the subnetwork is specified, the network is inferred. This field is - * optional when creating a firewall rule. If not specified when creating a - * firewall rule, the default network global/networks/default is used. If - * you specify this property, you can specify the network as a full or - * partial URL. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/global/networks/network - * - projects/project/global/networks/network - global/networks/default + * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ network?: string; /** - * An IPv4 internal network address to assign to the instance for this - * network interface. If not specified by the user, an unused internal IP is - * assigned by the system. + * An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ networkIP?: string; /** - * The URL of the Subnetwork resource for this instance. If the network - * resource is in legacy mode, do not provide this property. If the network - * is in auto subnet mode, providing the subnetwork is optional. If the - * network is in custom subnet mode, then this field should be specified. If - * you specify this property, you can specify the subnetwork as a full or - * partial URL. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - * - regions/region/subnetworks/subnetwork + * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string; } @@ -9365,16 +7006,11 @@ export namespace compute_alpha { */ items?: Schema$Network[]; /** - * [Output Only] Type of resource. Always compute#networkList for lists of - * networks. + * [Output Only] Type of resource. Always compute#networkList for lists of networks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9391,31 +7027,19 @@ export namespace compute_alpha { }; } /** - * A network peering attached to a network resource. The message includes the - * peering name, peer network, peering state, and a flag indicating whether - * Google Compute Engine should automatically create routes for the peering. + * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. */ export interface Schema$NetworkPeering { /** - * Whether Cloud Routers in this network can automatically advertise subnets - * from the peer network. + * Whether Cloud Routers in this network can automatically advertise subnets from the peer network. */ advertisePeerSubnetsViaRouters?: boolean; /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes - * instead. Indicates whether full mesh connectivity is created and managed - * automatically. When it is set to true, Google Compute Engine will - * automatically create and manage the routes between two networks when the - * state is ACTIVE. Otherwise, user needs to create routes manually to route - * packets to peer network. + * This field will be deprecated soon. Prefer using exchange_subnet_routes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. */ autoCreateRoutes?: boolean; /** - * Whether full mesh connectivity is created and managed automatically. When - * it is set to true, Google Compute Engine will automatically create and - * manage the routes between two networks when the peering state is ACTIVE. - * Otherwise, user needs to create routes manually to route packets to peer - * network. + * Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. */ exchangeSubnetRoutes?: boolean; /** @@ -9423,10 +7047,7 @@ export namespace compute_alpha { */ exportCustomRoutes?: boolean; /** - * Whether subnet routes with public IP range are exported. The default - * value is true, all subnet routes are exported. The IPv4 special-use - * ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always - * exported to peers and are not controlled by this field. + * Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. */ exportSubnetRoutesWithPublicIp?: boolean; /** @@ -9434,26 +7055,15 @@ export namespace compute_alpha { */ importCustomRoutes?: boolean; /** - * Whether subnet routes with public IP range are imported. The default - * value is false. The IPv4 special-use ranges - * (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always - * imported from peers and are not controlled by this field. + * Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. */ importSubnetRoutesWithPublicIp?: boolean; /** - * Name of this peering. Provided by the client when the peering is created. - * The name must comply with RFC1035. Specifically, the name must be 1-63 - * characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - * which means the first character must be a lowercase letter, and all the - * following characters must be a dash, lowercase letter, or digit, except - * the last character, which cannot be a dash. + * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the peer network. It can be either full URL or partial URL. - * The peer network may belong to a different project. If the partial URL - * does not contain project, it is assumed that the peer network is in the - * same project as the current network. + * The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ network?: string; /** @@ -9466,37 +7076,25 @@ export namespace compute_alpha { stateDetails?: string; } /** - * A routing configuration attached to a network resource. The message - * includes the list of routers associated with the network, and a flag - * indicating the type of routing behavior to enforce network-wide. + * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. */ export interface Schema$NetworkRoutingConfig { /** - * The network-wide routing mode to use. If set to REGIONAL, this - * network's cloud routers will only advertise routes with subnets of - * this network in the same region as the router. If set to GLOBAL, this - * network's cloud routers will advertise routes with all subnets of - * this network, across regions. + * The network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. */ routingMode?: string; } export interface Schema$NetworksAddPeeringRequest { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes - * in network_peering instead. Whether Google Compute Engine manages the - * routes automatically. + * This field will be deprecated soon. Prefer using exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. */ autoCreateRoutes?: boolean; /** - * This field will be deprecated soon. Prefer using export_custom_routes in - * network_peering instead. Whether to export the custom routes to peer - * network. + * This field will be deprecated soon. Prefer using export_custom_routes in network_peering instead. Whether to export the custom routes to peer network. */ exportCustomRoutes?: boolean; /** - * This field will be deprecated soon. Prefer using import_custom_routes in - * network_peering instead. Whether to import the custom routes from peer - * network. + * This field will be deprecated soon. Prefer using import_custom_routes in network_peering instead. Whether to import the custom routes from peer network. */ importCustomRoutes?: boolean; /** @@ -9504,18 +7102,11 @@ export namespace compute_alpha { */ name?: string; /** - * Network peering parameters. In order to specify route policies for - * peering using import/export custom routes, you will have to fill all - * peering related parameters (name, peer network, exchange_subnet_routes) - * in network_peeringfield. Corresponding fields in - * NetworksAddPeeringRequest will be deprecated soon. + * Network peering parameters. In order to specify route policies for peering using import/export custom routes, you will have to fill all peering related parameters (name, peer network, exchange_subnet_routes) in network_peeringfield. Corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ networkPeering?: Schema$NetworkPeering; /** - * URL of the peer network. It can be either full URL or partial URL. The - * peer network may belong to a different project. If the partial URL does - * not contain project, it is assumed that the peer network is in the same - * project as the current network. + * URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ peerNetwork?: string; } @@ -9534,8 +7125,7 @@ export namespace compute_alpha { */ export interface Schema$NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy { /** - * [Output Only] The unique identifier for the security policy. This - * identifier is defined by the server. + * [Output Only] The unique identifier for the security policy. This identifier is defined by the server. */ id?: string; /** @@ -9553,10 +7143,7 @@ export namespace compute_alpha { networkPeering?: Schema$NetworkPeering; } /** - * A NodeGroup resource. To create a node group, you must first create a node - * templates. To learn more about node groups and sole-tenant nodes, read the - * Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== - * resource_for v1.nodeGroups ==) + * A NodeGroup resource. To create a node group, you must first create a node templates. To learn more about node groups and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) */ export interface Schema$NodeGroup { autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; @@ -9565,29 +7152,20 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeGroup for node - * group. + * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ kind?: string; managedHoldback?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -9608,8 +7186,7 @@ export namespace compute_alpha { size?: number; status?: string; /** - * [Output Only] The name of the zone where the node group resides, such as - * us-central1-a. + * [Output Only] The name of the zone where the node group resides, such as us-central1-a. */ zone?: string; } @@ -9623,16 +7200,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$NodeGroupsScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for - * aggregated lists of node groups. + * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9665,16 +7237,11 @@ export namespace compute_alpha { */ items?: Schema$NodeGroup[]; /** - * [Output Only] Type of resource.Always compute#nodeGroupList for lists of - * node groups. + * [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9732,17 +7299,11 @@ export namespace compute_alpha { */ items?: Schema$NodeGroupNode[]; /** - * [Output Only] The resource type, which is always - * compute.nodeGroupsListNodes for the list of nodes in the specified node - * group. + * [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9764,8 +7325,7 @@ export namespace compute_alpha { */ nodeGroups?: Schema$NodeGroup[]; /** - * [Output Only] An informational warning that appears when the nodeGroup - * list is empty. + * [Output Only] An informational warning that appears when the nodeGroup list is empty. */ warning?: { code?: string; @@ -9778,15 +7338,12 @@ export namespace compute_alpha { } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** - * Full or partial URL of the node template resource to be updated for this - * node group. + * Full or partial URL of the node template resource to be updated for this node group. */ nodeTemplate?: string; } /** - * A Node Template resource. To learn more about node templates and - * sole-tenant nodes, read the Sole-tenant nodes documentation. (== - * resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * A Node Template resource. To learn more about node templates and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) */ export interface Schema$NodeTemplate { /** @@ -9794,34 +7351,24 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; disks?: Schema$LocalDisk[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeTemplate for - * node templates. + * [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Labels to use for node affinity, which will be used in instance - * scheduling. + * Labels to use for node affinity, which will be used in instance scheduling. */ nodeAffinityLabels?: {[key: string]: string}; /** @@ -9829,15 +7376,11 @@ export namespace compute_alpha { */ nodeType?: string; /** - * The flexible properties of the desired node type. Node groups that use - * this node template will create nodes of a type that matches these - * properties. This field is mutually exclusive with the node_type - * property; you can only define one or the other, but not both. + * The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. */ nodeTypeFlexibility?: Schema$NodeTemplateNodeTypeFlexibility; /** - * [Output Only] The name of the region where the node template resides, - * such as us-central1. + * [Output Only] The name of the region where the node template resides, such as us-central1. */ region?: string; /** @@ -9853,8 +7396,7 @@ export namespace compute_alpha { */ serverBinding?: Schema$ServerBinding; /** - * [Output Only] The status of the node template. One of the following - * values: CREATING, READY, and DELETING. + * [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. */ status?: string; /** @@ -9872,16 +7414,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$NodeTemplatesScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList - * for aggregated lists of node templates. + * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9910,16 +7447,11 @@ export namespace compute_alpha { */ items?: Schema$NodeTemplate[]; /** - * [Output Only] Type of resource.Always compute#nodeTemplateList for lists - * of node templates. + * [Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9946,8 +7478,7 @@ export namespace compute_alpha { */ nodeTemplates?: Schema$NodeTemplate[]; /** - * [Output Only] An informational warning that appears when the node - * templates list is empty. + * [Output Only] An informational warning that appears when the node templates list is empty. */ warning?: { code?: string; @@ -9976,18 +7507,15 @@ export namespace compute_alpha { */ description?: string; /** - * [Output Only] The number of virtual CPUs that are available to the node - * type. + * [Output Only] The number of virtual CPUs that are available to the node type. */ guestCpus?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeType for node - * types. + * [Output Only] The type of the resource. Always compute#nodeType for node types. */ kind?: string; /** @@ -9995,8 +7523,7 @@ export namespace compute_alpha { */ localSsdGb?: number; /** - * [Output Only] The amount of physical memory available to the node type, - * defined in MB. + * [Output Only] The amount of physical memory available to the node type, defined in MB. */ memoryMb?: number; /** @@ -10012,8 +7539,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The name of the zone where the node type resides, such as - * us-central1-a. + * [Output Only] The name of the zone where the node type resides, such as us-central1-a. */ zone?: string; } @@ -10027,16 +7553,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$NodeTypesScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for - * aggregated lists of node types. + * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10065,16 +7586,11 @@ export namespace compute_alpha { */ items?: Schema$NodeType[]; /** - * [Output Only] Type of resource.Always compute#nodeTypeList for lists of - * node types. + * [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10096,8 +7612,7 @@ export namespace compute_alpha { */ nodeTypes?: Schema$NodeType[]; /** - * [Output Only] An informational warning that appears when the node types - * list is empty. + * [Output Only] An informational warning that appears when the node types list is empty. */ warning?: { code?: string; @@ -10106,9 +7621,7 @@ export namespace compute_alpha { }; } /** - * A notification endpoint resource defines an endpoint to receive - * notifications when there are status changes detected by the associated - * health check service. + * A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. */ export interface Schema$NotificationEndpoint { /** @@ -10116,40 +7629,27 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Settings of the gRPC notification endpoint including the endpoint URL and - * the retry duration. + * Settings of the gRPC notification endpoint including the endpoint URL and the retry duration. */ grpcSettings?: Schema$NotificationEndpointGrpcSettings; /** - * [Output Only] A unique identifier for this resource type. The server - * generates this identifier. + * [Output Only] A unique identifier for this resource type. The server generates this identifier. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#notificationEndpoint - * for notification endpoints. + * [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] URL of the region where the notification endpoint resides. - * This field applies only to the regional resource. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -10158,30 +7658,23 @@ export namespace compute_alpha { selfLink?: string; } /** - * Represents a gRPC setting that describes one gRPC notification endpoint and - * the retry duration attempting to send notification to this endpoint. + * Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. */ export interface Schema$NotificationEndpointGrpcSettings { /** - * Optional. If specified, this field is used to set the authority header by - * the sender of notifications. See - * https://tools.ietf.org/html/rfc7540#section-8.1.2.3 + * Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 */ authority?: string; /** - * Endpoint to which gRPC notifications are sent. This must be a valid - * gRPCLB DNS name. + * Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name. */ endpoint?: string; /** - * Optional. If specified, this field is used to populate the ?name? field - * in gRPC requests. + * Optional. If specified, this field is used to populate the ?name? field in gRPC requests. */ payloadName?: string; /** - * How much time (in seconds) is spent attempting notification retries until - * a successful response is received. Default is 30s. Limit is 20m (1200s). - * Must be a positive number. + * How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number. */ retryDurationSec?: number; } @@ -10195,16 +7688,11 @@ export namespace compute_alpha { */ items?: Schema$NotificationEndpoint[]; /** - * [Output Only] Type of the resource. Always compute#notificationEndpoint - * for notification endpoints. + * [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10221,16 +7709,11 @@ export namespace compute_alpha { }; } /** - * An Operation resource, used to manage asynchronous API requests. (== - * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations - * ==) (== resource_for v1.regionOperations ==) (== resource_for - * beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== - * resource_for beta.zoneOperations ==) + * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** - * [Output Only] The value of `requestId` if you provided it in the request. - * Not present otherwise. + * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ clientOperationId?: string; /** @@ -10238,46 +7721,37 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * [Output Only] A textual description of the operation, which is set when - * the operation is created. + * [Output Only] A textual description of the operation, which is set when the operation is created. */ description?: string; /** - * [Output Only] The time that this operation was completed. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ endTime?: string; /** - * [Output Only] If errors are generated during processing of the operation, - * this field will be populated. + * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * message that was returned, such as NOT FOUND. + * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ httpErrorMessage?: string; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * status code that was returned. For example, a 404 means the resource was - * not found. + * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ httpErrorStatusCode?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The time that this operation was requested. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ insertTime?: string; /** - * [Output Only] Type of the resource. Always compute#operation for - * Operation resources. + * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ kind?: string; /** @@ -10285,23 +7759,15 @@ export namespace compute_alpha { */ name?: string; /** - * [Output Only] The type of operation, such as insert, update, or delete, - * and so on. + * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ operationType?: string; /** - * [Output Only] An optional progress indicator that ranges from 0 to 100. - * There is no requirement that this be linear or support any granularity of - * operations. This should not be used to guess when the operation will be - * complete. This number should monotonically increase as the operation - * progresses. + * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only - * available when performing regional operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -10313,39 +7779,31 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The time that this operation was started by the server. - * This value is in RFC3339 text format. + * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ startTime?: string; /** - * [Output Only] The status of the operation, which can be one of the - * following: PENDING, RUNNING, or DONE. + * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ status?: string; /** - * [Output Only] An optional textual description of the current status of - * the operation. + * [Output Only] An optional textual description of the current status of the operation. */ statusMessage?: string; /** - * [Output Only] The unique target ID, which identifies a specific - * incarnation of the target resource. + * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ targetId?: string; /** - * [Output Only] The URL of the resource that the operation modifies. For - * operations related to creating a snapshot, this points to the persistent - * disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ targetLink?: string; /** - * [Output Only] User who requested the operation, for example: - * user@example.com. + * [Output Only] User who requested the operation, for example: user@example.com. */ user?: string; /** - * [Output Only] If warning messages are generated during processing of the - * operation, this field will be populated. + * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ warnings?: Array<{ code?: string; @@ -10353,17 +7811,13 @@ export namespace compute_alpha { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only - * available when performing per-zone operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } export interface Schema$OperationAggregatedList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -10371,16 +7825,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$OperationsScopedList}; /** - * [Output Only] Type of resource. Always compute#operationAggregatedList - * for aggregated lists of operations. + * [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10401,8 +7850,7 @@ export namespace compute_alpha { */ export interface Schema$OperationList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -10410,16 +7858,11 @@ export namespace compute_alpha { */ items?: Schema$Operation[]; /** - * [Output Only] Type of resource. Always compute#operations for Operations - * resource. + * [Output Only] Type of resource. Always compute#operations for Operations resource. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10441,8 +7884,7 @@ export namespace compute_alpha { */ operations?: Schema$Operation[]; /** - * [Output Only] Informational warning which replaces the list of operations - * when the list is empty. + * [Output Only] Informational warning which replaces the list of operations when the list is empty. */ warning?: { code?: string; @@ -10456,9 +7898,7 @@ export namespace compute_alpha { */ associations?: Schema$SecurityPolicyAssociation[]; /** - * [Output Only] Type of securityPolicy associations. Always - * compute#organizationSecurityPoliciesListAssociations for lists of - * securityPolicy associations. + * [Output Only] Type of securityPolicy associations. Always compute#organizationSecurityPoliciesListAssociations for lists of securityPolicy associations. */ kind?: string; } @@ -10469,138 +7909,76 @@ export namespace compute_alpha { jwt?: Schema$Jwt; } /** - * Settings controlling eviction of unhealthy hosts from the load balancing - * pool. + * Settings controlling eviction of unhealthy hosts from the load balancing pool. */ export interface Schema$OutlierDetection { /** - * The base time that a host is ejected for. The real time is equal to the - * base time multiplied by the number of times the host has been ejected. - * Defaults to 30000ms or 30s. + * The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. */ baseEjectionTime?: Schema$Duration; /** - * Number of errors before a host is ejected from the connection pool. When - * the backend host is accessed over HTTP, a 5xx return code qualifies as an - * error. Defaults to 5. + * Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. */ consecutiveErrors?: number; /** - * The number of consecutive gateway failures (502, 503, 504 status or - * connection errors that are mapped to one of those status codes) before a - * consecutive gateway failure ejection occurs. Defaults to 5. + * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5. */ consecutiveGatewayFailure?: number; /** - * The percentage chance that a host will be actually ejected when an - * outlier status is detected through consecutive 5xx. This setting can be - * used to disable ejection or to ramp it up slowly. Defaults to 100. + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. */ enforcingConsecutiveErrors?: number; /** - * The percentage chance that a host will be actually ejected when an - * outlier status is detected through consecutive gateway failures. This - * setting can be used to disable ejection or to ramp it up slowly. Defaults - * to 0. + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. */ enforcingConsecutiveGatewayFailure?: number; /** - * The percentage chance that a host will be actually ejected when an - * outlier status is detected through success rate statistics. This setting - * can be used to disable ejection or to ramp it up slowly. Defaults to 100. + * The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. */ enforcingSuccessRate?: number; /** - * Time interval between ejection sweep analysis. This can result in both - * new ejections as well as hosts being returned to service. Defaults to 10 - * seconds. + * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. */ interval?: Schema$Duration; /** - * Maximum percentage of hosts in the load balancing pool for the backend - * service that can be ejected. Defaults to 10%. + * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%. */ maxEjectionPercent?: number; /** - * The number of hosts in a cluster that must have enough request volume to - * detect success rate outliers. If the number of hosts is less than this - * setting, outlier detection via success rate statistics is not performed - * for any host in the cluster. Defaults to 5. + * The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. */ successRateMinimumHosts?: number; /** - * The minimum number of total requests that must be collected in one - * interval (as defined by the interval duration above) to include this host - * in success rate based outlier detection. If the volume is lower than this - * setting, outlier detection via success rate statistics is not performed - * for that host. Defaults to 100. + * The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. */ successRateRequestVolume?: number; /** - * This factor is used to determine the ejection threshold for success rate - * outlier ejection. The ejection threshold is the difference between the - * mean success rate, and the product of this factor and the standard - * deviation of the mean success rate: mean - (stdev * - * success_rate_stdev_factor). This factor is divided by a thousand to get a - * double. That is, if the desired factor is 1.9, the runtime value should - * be 1900. Defaults to 1900. + * This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. */ successRateStdevFactor?: number; } /** - * A matcher for the path portion of the URL. The BackendService from the - * longest-matched rule will serve the URL. If no rule was matched, the - * default service will be used. + * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. */ export interface Schema$PathMatcher { /** - * defaultRouteAction takes effect when none of the pathRules or routeRules - * match. The load balancer performs advanced routing actions like URL - * rewrites, header transformations, etc. prior to forwarding the request to - * the selected backend. If defaultRouteAction specifies any - * weightedBackendServices, defaultService must not be set. Conversely if - * defaultService is set, defaultRouteAction cannot contain any - * weightedBackendServices. Only one of defaultRouteAction or - * defaultUrlRedirect must be set. + * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. */ defaultRouteAction?: Schema$HttpRouteAction; /** - * The full or partial URL to the BackendService resource. This will be used - * if none of the pathRules or routeRules defined by this PathMatcher are - * matched. For example, the following are all valid URLs to a - * BackendService resource: - - * https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - * - compute/v1/projects/project/global/backendServices/backendService - - * global/backendServices/backendService If defaultRouteAction is - * additionally specified, advanced routing actions like URL Rewrites, etc. - * take effect prior to sending the request to the backend. However, if - * defaultService is specified, defaultRouteAction cannot contain any - * weightedBackendServices. Conversely, if defaultRouteAction specifies any - * weightedBackendServices, defaultService must not be specified. Only one - * of defaultService, defaultUrlRedirect or - * defaultRouteAction.weightedBackendService must be set. Authorization - * requires one or more of the following Google IAM permissions on the - * specified resource default_service: - compute.backendBuckets.use - - * compute.backendServices.use + * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use */ defaultService?: string; /** - * When when none of the specified pathRules or routeRules match, the - * request is redirected to a URL specified by defaultUrlRedirect. If - * defaultUrlRedirect is specified, defaultService or defaultRouteAction - * must not be set. + * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. */ defaultUrlRedirect?: Schema$HttpRedirectAction; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Specifies changes to request and response headers that need to take - * effect for the selected backendService. HeaderAction specified here are - * applied after the matching HttpRouteRule HeaderAction and before the - * HeaderAction in the UrlMap + * Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap */ headerAction?: Schema$HttpHeaderAction; /** @@ -10608,60 +7986,32 @@ export namespace compute_alpha { */ name?: string; /** - * The list of path rules. Use this list instead of routeRules when routing - * based on simple path matching is all that's required. The order by - * which path rules are specified does not matter. Matches are always done - * on the longest-path-first basis. For example: a pathRule with a path - * /a/b/c/* will match before /a/b/* irrespective of the order in which - * those paths appear in this list. Only one of pathRules or routeRules must - * be set. + * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. */ pathRules?: Schema$PathRule[]; /** - * The list of ordered HTTP route rules. Use this list instead of pathRules - * when advanced route matching and routing actions are desired. The order - * of specifying routeRules matters: the first rule that matches will cause - * its specified routing action to take effect. Only one of pathRules or - * routeRules must be set. + * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Only one of pathRules or routeRules must be set. */ routeRules?: Schema$HttpRouteRule[]; } /** - * A path-matching rule for a URL. If matched, will use the specified - * BackendService to handle the traffic arriving at this URL. + * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. */ export interface Schema$PathRule { /** - * The list of path patterns to match. Each must start with / and the only - * place a * is allowed is at the end following a /. The string fed to the - * path matcher does not include any text after the first ? or #, and those - * chars are not allowed here. + * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. */ paths?: string[]; /** - * In response to a matching path, the load balancer performs advanced - * routing actions like URL rewrites, header transformations, etc. prior to - * forwarding the request to the selected backend. If routeAction specifies - * any weightedBackendServices, service must not be set. Conversely if - * service is set, routeAction cannot contain any weightedBackendServices. - * Only one of routeAction or urlRedirect must be set. + * In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. */ routeAction?: Schema$HttpRouteAction; /** - * The full or partial URL of the backend service resource to which traffic - * is directed if this rule is matched. If routeAction is additionally - * specified, advanced routing actions like URL Rewrites, etc. take effect - * prior to sending the request to the backend. However, if service is - * specified, routeAction cannot contain any weightedBackendService s. - * Conversely, if routeAction specifies any weightedBackendServices, - * service must not be specified. Only one of urlRedirect, service or - * routeAction.weightedBackendService must be set. + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ service?: string; /** - * When a path pattern is matched, the request is redirected to a URL - * specified by urlRedirect. If urlRedirect is specified, service or - * routeAction must not be set. + * When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. */ urlRedirect?: Schema$HttpRedirectAction; } @@ -10676,33 +8026,20 @@ export namespace compute_alpha { } export interface Schema$PerInstanceConfig { /** - * Fingerprint of this per-instance config. This field may be used in - * optimistic locking. It will be ignored when inserting a per-instance - * config. An up-to-date fingerprint must be provided in order to update an - * existing per-instance config or the field needs to be unset. + * Fingerprint of this per-instance config. This field may be used in optimistic locking. It will be ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. */ fingerprint?: string; /** - * The URL of the instance. Serves as a merge key during - * UpdatePerInstanceConfigs operation, i.e. if per-instance config with the - * same instance URL exists then it will be updated, otherwise a new one - * will be created. + * The URL of the instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same instance URL exists then it will be updated, otherwise a new one will be created. */ instance?: string; /** - * The name of the per-instance config and the corresponding instance. - * Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if - * per-instance config with the same name exists then it will be updated, - * otherwise a new one will be created for the VM instance with the same - * name. An attempt to create a per-instance config for a VM instance that - * either doesn't exist or is not part of the group will result in a - * failure. + * The name of the per-instance config and the corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in a failure. */ name?: string; override?: Schema$ManagedInstanceOverride; /** - * Intended preserved state for the given instance. Does not contain state - * generated based on Stateful Policy. + * Intended preserved state for the given instance. Does not contain state generated based on Stateful Policy. */ preservedState?: Schema$PreservedState; } @@ -10715,8 +8052,7 @@ export namespace compute_alpha { */ constraints?: Schema$PermissionConstraint[]; /** - * Used in Ingress or Egress Gateway cases to specify hosts that the policy - * applies to. Exact match, prefix match, and suffix match are supported. + * Used in Ingress or Egress Gateway cases to specify hosts that the policy applies to. Exact match, prefix match, and suffix match are supported. */ hosts?: string[]; /** @@ -10740,8 +8076,7 @@ export namespace compute_alpha { */ notPorts?: string[]; /** - * HTTP request paths or gRPC methods. Exact match, prefix match, and suffix - * match are supported. + * HTTP request paths or gRPC methods. Exact match, prefix match, and suffix match are supported. */ paths?: string[]; /** @@ -10750,8 +8085,7 @@ export namespace compute_alpha { ports?: string[]; } /** - * Custom constraint that specifies a key and a list of allowed values for - * Istio attributes. + * Custom constraint that specifies a key and a list of allowed values for Istio attributes. */ export interface Schema$PermissionConstraint { /** @@ -10764,23 +8098,7 @@ export namespace compute_alpha { values?: string[]; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML Example** bindings: - - * members: - user:mike@example.com - group:admins@example.com - - * domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com - * role: roles/owner - members: - user:sean@example.com role: roles/viewer For - * a description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -10788,31 +8106,16 @@ export namespace compute_alpha { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; iamOwned?: boolean; /** - * If more than one rule is specified, the rules are applied in the - * following manner: - All matching LOG rules are always applied. - If any - * DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be - * applied if one or more matching rule requires logging. - Otherwise, if - * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging - * will be applied if one or more matching rule requires logging. - - * Otherwise, if no rule applies, permission is denied. + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ rules?: Schema$Rule[]; /** @@ -10831,8 +8134,7 @@ export namespace compute_alpha { */ export interface Schema$PreservedState { /** - * Preserved disks defined for this instance. This map is keyed with the - * device names of the disks. + * Preserved disks defined for this instance. This map is keyed with the device names of the disks. */ disks?: {[key: string]: Schema$PreservedStatePreservedDisk}; /** @@ -10842,21 +8144,15 @@ export namespace compute_alpha { } export interface Schema$PreservedStatePreservedDisk { /** - * These stateful disks will never be deleted during autohealing, update, - * instance recreate operations. This flag is used to configure if the disk - * should be deleted after it is no longer used by the group, e.g. when the - * given instance or the whole MIG is deleted. Note: disks attached in - * READ_ONLY mode cannot be auto-deleted. + * These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. */ autoDelete?: string; /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - * not specified, the default is to attach the disk in READ_WRITE mode. + * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. */ mode?: string; /** - * The URL of the disk resource that is stateful and should be attached to - * the VM instance. + * The URL of the disk resource that is stateful and should be attached to the VM instance. */ source?: string; } @@ -10869,8 +8165,7 @@ export namespace compute_alpha { */ condition?: string; /** - * The groups the principal belongs to. Exact match, prefix match, and - * suffix match are supported. + * The groups the principal belongs to. Exact match, prefix match, and suffix match are supported. */ groups?: string[]; /** @@ -10878,8 +8173,7 @@ export namespace compute_alpha { */ ips?: string[]; /** - * The namespaces. Exact match, prefix match, and suffix match are - * supported. + * The namespaces. Exact match, prefix match, and suffix match are supported. */ namespaces?: string[]; /** @@ -10899,26 +8193,20 @@ export namespace compute_alpha { */ notUsers?: string[]; /** - * A map of Istio attribute to expected values. Exact match, prefix match, - * and suffix match are supported for values. For example, - * `request.headers[version]: ?v1?`. The properties are ANDed together. + * A map of Istio attribute to expected values. Exact match, prefix match, and suffix match are supported for values. For example, `request.headers[version]: ?v1?`. The properties are ANDed together. */ properties?: {[key: string]: string}; /** - * The user names/IDs or service accounts. Exact match, prefix match, and - * suffix match are supported. + * The user names/IDs or service accounts. Exact match, prefix match, and suffix match are supported. */ users?: string[]; } /** - * A Project resource. For an overview of projects, see Cloud Platform - * Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for - * beta.projects ==) + * A Project resource. For an overview of projects, see Cloud Platform Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) */ export interface Schema$Project { /** - * Metadata key/value pairs available to all instances contained in this - * project. See Custom metadata for more information. + * Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. */ commonInstanceMetadata?: Schema$Metadata; /** @@ -10926,14 +8214,11 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * This signifies the default network tier used for configuring resources of - * the project and can only take the following values: PREMIUM, STANDARD. - * Initially the default network tier is PREMIUM. + * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. */ defaultNetworkTier?: string; /** - * [Output Only] Default service account used by VMs running in this - * project. + * [Output Only] Default service account used by VMs running in this project. */ defaultServiceAccount?: string; /** @@ -10945,9 +8230,7 @@ export namespace compute_alpha { */ enabledFeatures?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. This is not the project ID, and is just a unique - * ID used by Compute Engine to identify resources. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. */ id?: string; /** @@ -10955,8 +8238,7 @@ export namespace compute_alpha { */ kind?: string; /** - * The project ID. For example: my-example-project. Use the project ID to - * make requests to Compute Engine. + * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. */ name?: string; /** @@ -10968,13 +8250,11 @@ export namespace compute_alpha { */ selfLink?: string; /** - * The naming prefix for daily usage reports and the Google Cloud Storage - * bucket where they are stored. + * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. */ usageExportLocation?: Schema$UsageExportLocation; /** - * [Output Only] The role this project has in a shared VPC configuration. - * Currently only HOST projects are differentiated. + * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. */ xpnProjectStatus?: string; } @@ -10992,29 +8272,21 @@ export namespace compute_alpha { } export interface Schema$ProjectsGetXpnResources { /** - * [Output Only] Type of resource. Always compute#projectsGetXpnResources - * for lists of service resources (a.k.a service projects) + * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** - * Service resources (a.k.a service projects) attached to this project as - * their shared VPC host. + * Service resources (a.k.a service projects) attached to this project as their shared VPC host. */ resources?: Schema$XpnResourceId[]; } export interface Schema$ProjectsListXpnHostsRequest { /** - * Optional organization ID managed by Cloud Resource Manager, for which to - * list shared VPC host projects. If not specified, the organization will be - * inferred from the project. + * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. */ organization?: string; } @@ -11043,8 +8315,7 @@ export namespace compute_alpha { */ metric?: string; /** - * [Output Only] Owning resource. This is the resource on which this quota - * is applied. + * [Output Only] Owning resource. This is the resource on which this quota is applied. */ owner?: string; /** @@ -11071,13 +8342,11 @@ export namespace compute_alpha { */ export interface Schema$Reference { /** - * [Output Only] Type of the resource. Always compute#reference for - * references. + * [Output Only] Type of the resource. Always compute#reference for references. */ kind?: string; /** - * A description of the reference type with no implied semantics. Possible - * values include: - MEMBER_OF + * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF */ referenceType?: string; /** @@ -11090,8 +8359,7 @@ export namespace compute_alpha { target?: string; } /** - * Region resource. (== resource_for beta.regions ==) (== resource_for - * v1.regions ==) + * Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==) */ export interface Schema$Region { /** @@ -11107,8 +8375,7 @@ export namespace compute_alpha { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -11136,8 +8403,7 @@ export namespace compute_alpha { */ status?: string; /** - * [Output Only] A list of zones available in this region, in the form of - * resource URLs. + * [Output Only] A list of zones available in this region, in the form of resource URLs. */ zones?: string[]; } @@ -11158,11 +8424,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11180,8 +8442,7 @@ export namespace compute_alpha { } export interface Schema$RegionCommitmentsUpdateReservationsRequest { /** - * List of reservations for the capacity move of VMs with accelerators and - * local ssds. + * List of reservations for the capacity move of VMs with accelerators and local ssds. */ reservations?: Schema$Reservation[]; } @@ -11213,16 +8474,11 @@ export namespace compute_alpha { */ items?: Schema$DiskType[]; /** - * [Output Only] Type of resource. Always compute#regionDiskTypeList for - * region disk types. + * [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11255,11 +8511,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11280,13 +8532,11 @@ export namespace compute_alpha { */ export interface Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq { /** - * The list of instances for which we want to delete per-instance configs on - * this managed instance group. + * The list of instances for which we want to delete per-instance configs on this managed instance group. */ instances?: string[]; /** - * The list of instance names for which we want to delete per-instance - * configs on this managed instance group. + * The list of instance names for which we want to delete per-instance configs on this managed instance group. */ names?: string[]; } @@ -11303,17 +8553,11 @@ export namespace compute_alpha { */ items?: Schema$InstanceGroupManager[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerList for a list of managed instance groups - * that exist in th regional scope. + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11334,15 +8578,13 @@ export namespace compute_alpha { */ export interface Schema$RegionInstanceGroupManagerPatchInstanceConfigReq { /** - * The list of per-instance configs to insert or patch on this managed - * instance group. + * The list of per-instance configs to insert or patch on this managed instance group. */ perInstanceConfigs?: Schema$PerInstanceConfig[]; } export interface Schema$RegionInstanceGroupManagersAbandonInstancesRequest { /** - * The URLs of one or more instances to abandon. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -11351,24 +8593,19 @@ export namespace compute_alpha { */ export interface Schema$RegionInstanceGroupManagersApplyUpdatesRequest { /** - * The list of instances for which we want to apply changes on this managed - * instance group. + * The list of instances for which we want to apply changes on this managed instance group. */ instances?: string[]; /** - * The maximal action that should be performed on the instances. By default - * REPLACE. This field is deprecated, please use - * most_disruptive_allowed_action. + * The maximal action that should be performed on the instances. By default REPLACE. This field is deprecated, please use most_disruptive_allowed_action. */ maximalAction?: string; /** - * The minimal action that should be perfomed on the instances. By default - * NONE. + * The minimal action that should be perfomed on the instances. By default NONE. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. - * By default REPLACE. + * The most disruptive action that allowed to be performed on the instances. By default REPLACE. */ mostDisruptiveAllowedAction?: string; } @@ -11383,8 +8620,7 @@ export namespace compute_alpha { } export interface Schema$RegionInstanceGroupManagersDeleteInstancesRequest { /** - * The URLs of one or more instances to delete. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -11394,11 +8630,7 @@ export namespace compute_alpha { */ items?: Schema$PerInstanceConfig[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11416,18 +8648,13 @@ export namespace compute_alpha { */ managedInstances?: Schema$ManagedInstance[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; } export interface Schema$RegionInstanceGroupManagersRecreateRequest { /** - * The URLs of one or more instances to recreate. This can be a full URL or - * a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -11436,22 +8663,17 @@ export namespace compute_alpha { } export interface Schema$RegionInstanceGroupManagersSetTargetPoolsRequest { /** - * Fingerprint of the target pools information, which is a hash of the - * contents. This field is used for optimistic locking when you update the - * target pool entries. This field is optional. + * Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional. */ fingerprint?: string; /** - * The URL of all TargetPool resources to which instances in the - * instanceGroup field are added. The target pools automatically apply to - * all of the instances in the managed instance group. + * The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ targetPools?: string[]; } export interface Schema$RegionInstanceGroupManagersSetTemplateRequest { /** - * URL of the InstanceTemplate resource from which all new instances will be - * created. + * URL of the InstanceTemplate resource from which all new instances will be created. */ instanceTemplate?: string; } @@ -11460,8 +8682,7 @@ export namespace compute_alpha { */ export interface Schema$RegionInstanceGroupManagerUpdateInstanceConfigReq { /** - * The list of per-instance configs to insert or patch on this managed - * instance group. + * The list of per-instance configs to insert or patch on this managed instance group. */ perInstanceConfigs?: Schema$PerInstanceConfig[]; } @@ -11479,11 +8700,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11501,25 +8718,17 @@ export namespace compute_alpha { } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** - * Instances in which state should be returned. Valid options are: - * 'ALL', 'RUNNING'. By default, it lists all instances. + * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. */ instanceState?: string; /** - * Name of port user is interested in. It is optional. If it is set, only - * information about this ports will be returned. If it is not set, all the - * named ports will be returned. Always lists all instances. + * Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. */ portName?: string; } export interface Schema$RegionInstanceGroupsSetNamedPortsRequest { /** - * The fingerprint of the named ports information for this instance group. - * Use this optional property to prevent conflicts when multiple users - * change the named ports settings concurrently. Obtain the fingerprint with - * the instanceGroups.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ fingerprint?: string; /** @@ -11540,16 +8749,11 @@ export namespace compute_alpha { */ items?: Schema$Region[]; /** - * [Output Only] Type of resource. Always compute#regionList for lists of - * regions. + * [Output Only] Type of resource. Always compute#regionList for lists of regions. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11567,12 +8771,7 @@ export namespace compute_alpha { } export interface Schema$RegionSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash in order to update or - * change labels. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** @@ -11582,28 +8781,21 @@ export namespace compute_alpha { } export interface Schema$RegionSetPolicyRequest { /** - * Flatten Policy to create a backwacd compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } export interface Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest { /** - * New set of SslCertificate resources to associate with this - * TargetHttpsProxy resource. Currently exactly one SslCertificate resource - * must be specified. + * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. */ sslCertificates?: string[]; } @@ -11614,10 +8806,7 @@ export namespace compute_alpha { resource?: Schema$UrlMap; } /** - * A policy that specifies how requests intended for the route's backends - * are shadowed to a separate mirrored backend service. Loadbalancer does not - * wait for responses from the shadow service. Prior to sending traffic to the - * shadow service, the host / authority header is suffixed with -shadow. + * A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. */ export interface Schema$RequestMirrorPolicy { /** @@ -11630,8 +8819,7 @@ export namespace compute_alpha { */ export interface Schema$Reservation { /** - * [OutputOnly] Full or partial url for parent commitment for reservations - * which are tied to a commitment. + * [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment. */ commitment?: string; /** @@ -11639,28 +8827,19 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#reservations for - * reservations. + * [Output Only] Type of the resource. Always compute#reservations for reservations. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -11676,21 +8855,16 @@ export namespace compute_alpha { */ specificReservation?: Schema$AllocationSpecificSKUReservation; /** - * Indicates whether the reservation can be consumed by VMs with "any - * reservation" defined. If the field is set, then only VMs that target - * the reservation by name using --reservation-affinity can consume this - * reservation. + * Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation. */ specificReservationRequired?: boolean; /** - * Zone in which the reservation resides, must be provided if reservation is - * created with commitment creation. + * Zone in which the reservation resides, must be provided if reservation is created with commitment creation. */ zone?: string; } /** - * AllocationAffinity is the configuration of desired allocation which this - * instance could take capacity from. + * AllocationAffinity is the configuration of desired allocation which this instance could take capacity from. */ export interface Schema$ReservationAffinity { consumeReservationType?: string; @@ -11720,11 +8894,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11742,8 +8912,7 @@ export namespace compute_alpha { } export interface Schema$ReservationList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -11751,16 +8920,11 @@ export namespace compute_alpha { */ items?: Schema$Reservation[]; /** - * [Output Only] Type of resource.Always compute#reservationsList for - * listsof reservations + * [Output Only] Type of resource.Always compute#reservationsList for listsof reservations */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11778,8 +8942,7 @@ export namespace compute_alpha { } export interface Schema$ReservationsResizeRequest { /** - * Number of allocated resources can be resized with minimum = 1 and maximum - * = 1000. + * Number of allocated resources can be resized with minimum = 1 and maximum = 1000. */ specificSkuCount?: string; } @@ -11789,8 +8952,7 @@ export namespace compute_alpha { */ reservations?: Schema$Reservation[]; /** - * Informational warning which replaces the list of reservations when the - * list is empty. + * Informational warning which replaces the list of reservations when the list is empty. */ warning?: { code?: string; @@ -11799,32 +8961,25 @@ export namespace compute_alpha { }; } /** - * Commitment for a particular resource (a Commitment is composed of one or - * more of these). + * Commitment for a particular resource (a Commitment is composed of one or more of these). */ export interface Schema$ResourceCommitment { /** - * Name of the accelerator type resource. Applicable only when the type is - * ACCELERATOR. + * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. */ acceleratorType?: string; /** - * The amount of the resource purchased (in a type-dependent unit, such as - * bytes). For vCPUs, this can just be an integer. For memory, this must be - * provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of - * memory per every vCPU. + * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. */ amount?: string; /** - * Type of resource for which this commitment applies. Possible values are - * VCPU and MEMORY + * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY */ type?: string; } export interface Schema$ResourceGroupReference { /** - * A URI referencing one of the instance groups or network endpoint groups - * listed in the backend service. + * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. */ group?: string; } @@ -11834,8 +8989,7 @@ export namespace compute_alpha { */ resourcePolicies?: Schema$ResourcePolicy[]; /** - * Informational warning which replaces the list of resourcePolicies when - * the list is empty. + * Informational warning which replaces the list of resourcePolicies when the list is empty. */ warning?: { code?: string; @@ -11854,23 +9008,15 @@ export namespace compute_alpha { */ groupPlacementPolicy?: Schema$ResourcePolicyGroupPlacementPolicy; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#resource_policies for - * resource policies. + * [Output Only] Type of the resource. Always compute#resource_policies for resource policies. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; region?: string; @@ -11913,11 +9059,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11942,20 +9084,16 @@ export namespace compute_alpha { */ daysInCycle?: number; /** - * [Output only] A predetermined duration for the window, automatically - * chosen to be the smallest possible in the given scenario. + * [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. */ duration?: string; /** - * Start time of the window. This must be in UTC format that resolves to one - * of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 - * and 08:00 are valid. + * Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid. */ startTime?: string; } /** - * A GroupPlacementPolicy specifies resource placement configuration. It - * specifies the failure bucket separation as well as network locality + * A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality */ export interface Schema$ResourcePolicyGroupPlacementPolicy { /** @@ -11976,8 +9114,7 @@ export namespace compute_alpha { */ export interface Schema$ResourcePolicyHourlyCycle { /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ duration?: string; /** @@ -11985,16 +9122,14 @@ export namespace compute_alpha { */ hoursInCycle?: number; /** - * Time within the window to start the operations. It must be in format - * "HH:MM", where HH : [00-23] and MM : [00-00] GMT. + * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } export interface Schema$ResourcePolicyList { etag?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -12002,16 +9137,11 @@ export namespace compute_alpha { */ items?: Schema$ResourcePolicy[]; /** - * [Output Only] Type of resource.Always compute#resourcePoliciesList for - * listsof resourcePolicies + * [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12028,9 +9158,7 @@ export namespace compute_alpha { }; } /** - * A snapshot schedule policy specifies when and how frequently snapshots are - * to be created for the target disk. Also specifies how many and how long - * these scheduled snapshots should be retained. + * A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. */ export interface Schema$ResourcePolicySnapshotSchedulePolicy { /** @@ -12038,14 +9166,11 @@ export namespace compute_alpha { */ retentionPolicy?: Schema$ResourcePolicySnapshotSchedulePolicyRetentionPolicy; /** - * A Vm Maintenance Policy specifies what kind of infrastructure maintenance - * we are allowed to perform on this VM and when. Schedule that is applied - * to disks covered by this policy. + * A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy. */ schedule?: Schema$ResourcePolicySnapshotSchedulePolicySchedule; /** - * Properties with which snapshots are created such as labels, encryption - * keys. + * Properties with which snapshots are created such as labels, encryption keys. */ snapshotProperties?: Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties; } @@ -12058,13 +9183,11 @@ export namespace compute_alpha { */ maxRetentionDays?: number; /** - * Specifies the behavior to apply to existing, scheduled snapshots - * snapshots if the policy is changed. + * Specifies the behavior to apply to existing, scheduled snapshots snapshots if the policy is changed. */ onPolicySwitch?: string; /** - * Specifies the behavior to apply to scheduled snapshots when the source - * disk is deleted. + * Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. */ onSourceDiskDelete?: string; } @@ -12077,8 +9200,7 @@ export namespace compute_alpha { weeklySchedule?: Schema$ResourcePolicyWeeklyCycle; } /** - * Specified snapshot properties for scheduled snapshots created by this - * policy. + * Specified snapshot properties for scheduled snapshots created by this policy. */ export interface Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties { /** @@ -12086,13 +9208,11 @@ export namespace compute_alpha { */ guestFlush?: boolean; /** - * Labels to apply to scheduled snapshots. These can be later modified by - * the setLabels method. Label values may be empty. + * Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. */ labels?: {[key: string]: string}; /** - * GCS bucket storage location of the auto snapshot (regional or - * multi-regional). + * GCS bucket storage location of the auto snapshot (regional or multi-regional). */ storageLocations?: string[]; } @@ -12103,8 +9223,7 @@ export namespace compute_alpha { maintenanceWindow?: Schema$ResourcePolicyVmMaintenancePolicyMaintenanceWindow; } /** - * A maintenance window for VMs. When set, we restrict our maintenance - * operations to this window. + * A maintenance window for VMs. When set, we restrict our maintenance operations to this window. */ export interface Schema$ResourcePolicyVmMaintenancePolicyMaintenanceWindow { dailyMaintenanceWindow?: Schema$ResourcePolicyDailyCycle; @@ -12124,31 +9243,16 @@ export namespace compute_alpha { */ day?: string; /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ duration?: string; /** - * Time within the window to start the operations. It must be in format - * "HH:MM", where HH : [00-23] and MM : [00-00] GMT. + * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } /** - * Represents a Route resource. A route specifies how certain packets should - * be handled by the network. Routes are associated with instances by tags and - * the set of routes for a particular instance is called its routing table. - * For each packet leaving an instance, the system searches that - * instance's routing table for a single best matching route. Routes match - * packets by destination IP address, preferring smaller or more specific - * ranges over larger ones. If there is a tie, the system selects the route - * with the smallest priority value. If there is still a tie, it uses the - * layer three and four packet headers to select just one of the remaining - * matching routes. The packet is then forwarded as specified by the nextHop - * field of the winning route - either to another instance destination, an - * instance gateway, or a Google Compute Engine-operated gateway. Packets - * that do not match any route in the sending instance's routing table are - * dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + * Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table. For each packet leaving an instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway. Packets that do not match any route in the sending instance's routing table are dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) */ export interface Schema$Route { /** @@ -12156,33 +9260,23 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The destination range of outgoing packets that this route applies to. - * Only IPv4 is supported. + * The destination range of outgoing packets that this route applies to. Only IPv4 is supported. */ destRange?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of this resource. Always compute#routes for Route - * resources. + * [Output Only] Type of this resource. Always compute#routes for Route resources. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -12190,37 +9284,23 @@ export namespace compute_alpha { */ network?: string; /** - * The URL to a gateway that should handle matching packets. You can only - * specify the internet gateway using a full or partial valid URL: - * projects/<project-id>/global/gateways/default-internet-gateway + * The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway */ nextHopGateway?: string; /** - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that - * should handle matching packets. You can only specify the forwarding rule - * as a partial or full URL. For example, the following are all valid URLs: - * - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - * - regions/region/forwardingRules/forwardingRule Note that this can only - * be used when the destination_range is a public (non-RFC 1918) IP CIDR - * range. + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Note that this can only be used when the destination_range is a public (non-RFC 1918) IP CIDR range. */ nextHopIlb?: string; /** - * The URL to an instance that should handle matching packets. You can - * specify this as a full or partial URL. For example: - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ + * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ nextHopInstance?: string; /** - * [Output Only] The URL to an InterconnectAttachment which is the next hop - * for the route. This field will only be populated for the dynamic routes - * generated by Cloud Router with a linked interconnectAttachment. + * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. */ nextHopInterconnectAttachment?: string; /** - * The network IP address of an instance that should handle matching - * packets. Only IPv4 is supported. + * The network IP address of an instance that should handle matching packets. Only IPv4 is supported. */ nextHopIp?: string; /** @@ -12228,8 +9308,7 @@ export namespace compute_alpha { */ nextHopNetwork?: string; /** - * [Output Only] The network peering name that should handle matching - * packets, which should conform to RFC1035. + * [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. */ nextHopPeering?: string; /** @@ -12237,11 +9316,7 @@ export namespace compute_alpha { */ nextHopVpnTunnel?: string; /** - * The priority of this route. Priority is used to break ties in cases where - * there is more than one matching route of equal prefix length. In the case - * of two routes with equal prefix length, the one with the lowest-numbered - * priority value wins. Default value is 1000. Valid range is 0 through - * 65535. + * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. */ priority?: number; /** @@ -12257,8 +9332,7 @@ export namespace compute_alpha { */ tags?: string[]; /** - * [Output Only] If potential misconfigurations are detected for this route, - * this field will be populated with warning messages. + * [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. */ warnings?: Array<{ code?: string; @@ -12283,11 +9357,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12312,9 +9382,7 @@ export namespace compute_alpha { */ bgp?: Schema$RouterBgp; /** - * BGP information that needs to be configured into the routing stack to - * establish the BGP peering. It must specify peer ASN and either interface - * name, IP, or peer IP. Please refer to RFC4273. + * BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273. */ bgpPeers?: Schema$RouterBgpPeer[]; /** @@ -12322,19 +9390,15 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Router interfaces. Each interface requires either one linked resource - * (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. - * ipRange), or both. + * Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both. */ interfaces?: Schema$RouterInterface[]; /** @@ -12342,13 +9406,7 @@ export namespace compute_alpha { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -12360,9 +9418,7 @@ export namespace compute_alpha { */ network?: string; /** - * [Output Only] URI of the region where the router resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -12404,11 +9460,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12426,19 +9478,11 @@ export namespace compute_alpha { } export interface Schema$RouterBgp { /** - * User-specified list of prefix groups to advertise in custom mode. This - * field can only be populated if advertise_mode is CUSTOM and is advertised - * to all peers of the router. These groups will be advertised in addition - * to any specified prefixes. Leave this field blank to advertise no custom - * groups. + * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. - * This field can only be populated if advertise_mode is CUSTOM and is - * advertised to all peers of the router. These IP ranges will be advertised - * in addition to any specified groups. Leave this field blank to advertise - * no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** @@ -12446,45 +9490,25 @@ export namespace compute_alpha { */ advertiseMode?: string; /** - * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, - * either 16-bit or 32-bit. The value will be fixed for this router - * resource. All VPN tunnels that link to this router will have the same - * local ASN. + * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN. */ asn?: number; /** - * The interval in seconds between BGP keepalive messages that are sent to - * the peer. Hold time is three times the interval at which keepalive - * messages are sent, and the hold time is the maximum number of seconds - * allowed to elapse between successive keepalive messages that BGP receives - * from a peer. BGP will use the smaller of either the local hold time value - * or the peer?s hold time value as the hold time for the BGP connection - * between the two peers. If set, this value must be between 1 and 120. The - * default is 20. + * The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer?s hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 1 and 120. The default is 20. */ keepaliveInterval?: number; } export interface Schema$RouterBgpPeer { /** - * User-specified list of prefix groups to advertise in custom mode. This - * field can only be populated if advertise_mode is CUSTOM and overrides the - * list defined for the router (in Bgp message). These groups will be - * advertised in addition to any specified prefixes. Leave this field blank - * to advertise no custom groups. + * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. - * This field can only be populated if advertise_mode is CUSTOM and - * overrides the list defined for the router (in Bgp message). These IP - * ranges will be advertised in addition to any specified groups. Leave this - * field blank to advertise no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * The priority of routes advertised to this BGP peer. In the case where - * there is more than one matching route of maximum length, the routes with - * lowest priority value win. + * The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win. */ advertisedRoutePriority?: number; /** @@ -12496,10 +9520,7 @@ export namespace compute_alpha { */ bfd?: Schema$RouterBgpPeerBfd; /** - * The status of the BGP peer connection. If set to FALSE, any active - * session with the peer is terminated and all associated routing - * information is removed. If set to TRUE, the peer connection can be - * established with routing information. The default is TRUE. + * The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. */ enable?: string; /** @@ -12507,128 +9528,71 @@ export namespace compute_alpha { */ interfaceName?: string; /** - * IP address of the interface inside Google Cloud Platform. Only IPv4 is - * supported. + * IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. */ ipAddress?: string; /** - * [Output Only] The resource that configures and manages this BGP peer. - * MANAGED_BY_USER is the default value and can be managed by you or other - * users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed - * by Cloud Interconnect, specifically by an InterconnectAttachment of type - * PARTNER. Google will automatically create, update, and delete this type - * of BGP peer when the PARTNER InterconnectAttachment is created, updated, - * or deleted. + * [Output Only] The resource that configures and manages this BGP peer. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** - * Name of this BGP peer. The name must be 1-63 characters long and comply - * with RFC1035. + * Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; /** - * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can - * be different for every tunnel. + * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel. */ peerAsn?: number; /** - * IP address of the BGP interface outside Google cloud. Only IPv4 is - * supported. + * IP address of the BGP interface outside Google cloud. Only IPv4 is supported. */ peerIpAddress?: string; } export interface Schema$RouterBgpPeerBfd { /** - * The minimum interval, in milliseconds, between BFD packets received from - * the peer router. The actual value is negotiated between the two routers - * and is equal to the greater of this value and the transmit interval of - * the other router. If BFD echo mode is enabled on this router and the peer - * router, this value is used to negotiate the interval between BFD echo - * packets transmitted by the peer router. Otherwise, it will be used to - * determine the interval between BFD control packets. If set, this value - * must be between 33 and 30000. The default is 300. + * The minimum interval, in milliseconds, between BFD packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If BFD echo mode is enabled on this router and the peer router, this value is used to negotiate the interval between BFD echo packets transmitted by the peer router. Otherwise, it will be used to determine the interval between BFD control packets. If set, this value must be between 33 and 30000. The default is 300. */ minReceiveInterval?: number; /** - * The minimum interval, in milliseconds, between BFD packets transmitted to - * the peer router. The actual value is negotiated between the two routers - * and is equal to the greater of this value and the corresponding receive - * interval of the other router. If BFD echo mode is enabled on this router - * and the peer router, this value is used to negotiate the interval between - * BFD echo packets transmitted by this router. Otherwise, it will be used - * to determine the interval between BFD control packets. If set, this value - * must be between 33 and 30000. The default is 300. + * The minimum interval, in milliseconds, between BFD packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If BFD echo mode is enabled on this router and the peer router, this value is used to negotiate the interval between BFD echo packets transmitted by this router. Otherwise, it will be used to determine the interval between BFD control packets. If set, this value must be between 33 and 30000. The default is 300. */ minTransmitInterval?: number; /** - * The BFD session initialization mode for this BGP peer. If set to ACTIVE, - * the Cloud Router will initiate the BFD session for this BGP peer. If set - * to PASSIVE, the Cloud Router will wait for the peer router to initiate - * the BFD session for this BGP peer. If set to DISABLED, BFD is disabled - * for this BGP peer. The default is PASSIVE. + * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. */ mode?: string; /** - * The number of consecutive BFD packets that must be missed before BFD - * declares that a peer is unavailable. If set, the value must be a value - * between 2 and 16. The default is 3. + * The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 2 and 16. The default is 3. */ multiplier?: number; /** - * The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD - * echo mode is enabled for this BGP peer. In this mode, if the peer router - * also has BFD echo mode enabled, BFD echo packets will be sent to the - * other router. If the peer router does not have BFD echo mode enabled, - * only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode - * is disabled for this BGP peer. If this router and the peer router have a - * multihop connection, this should be set to CONTROL_ONLY as BFD echo mode - * is only supported on singlehop connections. The default is - * CONTROL_AND_ECHO. + * The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO. */ packetMode?: string; /** - * The minimum interval, in milliseconds, between BFD control packets - * transmitted to and received from the peer router when BFD echo mode is - * enabled on both routers. The actual transmit and receive intervals are - * negotiated between the two routers and are equal to the greater of this - * value and the corresponding interval on the other router. If set, this - * value must be between 1000 and 30000. The default is 5000. + * The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000. */ slowTimerInterval?: number; } export interface Schema$RouterInterface { /** - * IP address and range of the interface. The IP range must be in the - * RFC3927 link-local IP space. The value must be a CIDR-formatted string, - * for example: 169.254.0.1/30. NOTE: Do not truncate the address as it - * represents the IP address of the interface. + * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ ipRange?: string; /** - * URI of the linked interconnect attachment. It must be in the same region - * as the router. Each interface can have at most one linked resource and it - * could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. */ linkedInterconnectAttachment?: string; /** - * URI of the linked VPN tunnel. It must be in the same region as the - * router. Each interface can have at most one linked resource and it could - * either be a VPN Tunnel or an interconnect attachment. + * URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. */ linkedVpnTunnel?: string; /** - * [Output Only] The resource that configures and manages this interface. - * MANAGED_BY_USER is the default value and can be managed by you or other - * users; MANAGED_BY_ATTACHMENT is an interface that is configured and - * managed by Cloud Interconnect, specifically by an InterconnectAttachment - * of type PARTNER. Google will automatically create, update, and delete - * this type of interface when the PARTNER InterconnectAttachment is - * created, updated, or deleted. + * [Output Only] The resource that configures and manages this interface. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** - * Name of this interface entry. The name must be 1-63 characters long and - * comply with RFC1035. + * Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; } @@ -12649,11 +9613,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12670,17 +9630,11 @@ export namespace compute_alpha { }; } /** - * Represents a Nat resource. It enables the VMs within the specified - * subnetworks to access Internet without external IP addresses. It specifies - * a list of subnetworks (and the ranges within) that want to use NAT. - * Customers can also provide the external IPs that would be used for NAT. GCP - * would auto-allocate ephemeral IPs if no external IPs are provided. + * Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided. */ export interface Schema$RouterNat { /** - * A list of URLs of the IP resources to be drained. These IPs must be valid - * static external IPs that have been assigned to the NAT. These IPs should - * be used for updating/patching a NAT only. + * A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only. */ drainNatIps?: string[]; /** @@ -12692,49 +9646,35 @@ export namespace compute_alpha { */ logConfig?: Schema$RouterNatLogConfig; /** - * Minimum number of ports allocated to a VM from this NAT config. If not - * set, a default number of ports is allocated to a VM. This gets rounded up - * to the nearest power of 2. Eg. if the value of this field is 50, at least - * 64 ports will be allocated to a VM. + * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This gets rounded up to the nearest power of 2. Eg. if the value of this field is 50, at least 64 ports will be allocated to a VM. */ minPortsPerVm?: number; /** - * Unique name of this Nat service. The name must be 1-63 characters long - * and comply with RFC1035. + * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; /** - * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should - * be empty. + * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should be empty. */ natIpAllocateOption?: string; /** - * A list of URLs of the IP resources used for this Nat service. These IPs - * must be valid static external IP addresses assigned to the project. - * max_length is subject to change post alpha. + * A list of URLs of the IP resources used for this Nat service. These IPs must be valid static external IP addresses assigned to the project. max_length is subject to change post alpha. */ natIps?: string[]; /** - * Specify the Nat option. If this field contains - * ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, - * then there should not be any other Router.Nat section in any Router for - * this network in this region. + * Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string; /** - * A list of Subnetwork resources whose traffic should be translated by NAT - * Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the - * SubnetworkIpRangeToNatOption above. + * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. */ subnetworks?: Schema$RouterNatSubnetworkToNat[]; /** - * Timeout (in seconds) for TCP established connections. Defaults to 1200s - * if not set. + * Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. */ tcpEstablishedIdleTimeoutSec?: number; /** - * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if - * not set. + * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. */ tcpTransitoryIdleTimeoutSec?: number; /** @@ -12751,8 +9691,7 @@ export namespace compute_alpha { */ enable?: boolean; /** - * Specifies the desired filtering of logs on this NAT. If unspecified, logs - * are exported for all connections handled by this NAT. + * Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. */ filter?: string; } @@ -12765,17 +9704,11 @@ export namespace compute_alpha { */ name?: string; /** - * A list of the secondary ranges of the Subnetwork that are allowed to use - * NAT. This can be populated only if - * "LIST_OF_SECONDARY_IP_RANGES" is one of the values in - * source_ip_ranges_to_nat. + * A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat. */ secondaryIpRangeNames?: string[]; /** - * Specify the options for NAT ranges in the Subnetwork. All usages of - * single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only - * valid option with multiple values is: ["PRIMARY_IP_RANGE", - * "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + * Specify the options for NAT ranges in the Subnetwork. All usages of single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ sourceIpRangesToNat?: string[]; } @@ -12791,8 +9724,7 @@ export namespace compute_alpha { */ routers?: Schema$Router[]; /** - * Informational warning which replaces the list of routers when the list is - * empty. + * Informational warning which replaces the list of routers when the list is empty. */ warning?: { code?: string; @@ -12850,8 +9782,7 @@ export namespace compute_alpha { */ status?: string; /** - * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 - * hours, 59 minutes, 59 seconds + * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds */ uptime?: string; /** @@ -12864,25 +9795,19 @@ export namespace compute_alpha { */ export interface Schema$RouterStatusNatStatus { /** - * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", - * "129.2.16.89"] + * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] */ autoAllocatedNatIps?: string[]; /** - * A list of IPs auto-allocated for NAT that are in drain mode. Example: - * ["1.1.1.1", ?179.12.26.133?]. + * A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. */ drainAutoAllocatedNatIps?: string[]; /** - * A list of IPs user-allocated for NAT that are in drain mode. Example: - * ["1.1.1.1", ?179.12.26.133?]. + * A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. */ drainUserAllocatedNatIps?: string[]; /** - * The number of extra IPs to allocate. This will be greater than 0 only if - * user-specified IPs are NOT enough to allow all configured VMs to use NAT. - * This value is meaningful only when auto-allocation of NAT IPs is *not* - * used. + * The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. */ minExtraNatIpsNeeded?: number; /** @@ -12898,8 +9823,7 @@ export namespace compute_alpha { */ userAllocatedNatIpResources?: string[]; /** - * A list of IPs user-allocated for NAT. They will be raw IP strings like - * "179.12.26.133". + * A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133". */ userAllocatedNatIps?: string[]; } @@ -12919,8 +9843,7 @@ export namespace compute_alpha { */ action?: string; /** - * Additional restrictions that must be met. All conditions must pass for - * the rule to match. + * Additional restrictions that must be met. All conditions must pass for the rule to match. */ conditions?: Schema$Condition[]; /** @@ -12928,25 +9851,19 @@ export namespace compute_alpha { */ description?: string; /** - * If one or more 'in' clauses are specified, the rule matches if - * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ ins?: string[]; /** - * The config returned to callers of tech.iam.IAM.CheckPolicy for any - * entries that match the LOG action. + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ logConfigs?: Schema$LogConfig[]; /** - * If one or more 'not_in' clauses are specified, the rule matches - * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ notIns?: string[]; /** - * A permission is a string of form '..' (e.g., - * 'storage.buckets.list'). A value of '*' matches all - * permissions, and a verb part of '*' (e.g., - * 'storage.buckets.*') matches all verbs. + * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ permissions?: string[]; } @@ -12955,79 +9872,43 @@ export namespace compute_alpha { */ export interface Schema$SavedAttachedDisk { /** - * Specifies whether the disk will be auto-deleted when the instance is - * deleted (but not when the disk is detached from the instance). + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ autoDelete?: boolean; /** - * Indicates that this is a boot disk. The virtual machine will use the - * first partition of the disk for its root filesystem. + * Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. */ boot?: boolean; /** - * Specifies a unique device name of your choice that is reflected into the - * /dev/disk/by-id/google-* tree of a Linux operating system running within - * the instance. This name can be used to reference the device for mounting, - * resizing, and so on, from within the instance. If not specified, the - * server chooses a default device name to apply to this disk, in the form - * persistent-disks-x, where x is a number assigned by Google Compute - * Engine. This field is only applicable for persistent disks. + * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. */ deviceName?: string; /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If - * you are creating a new disk, this field encrypts the new disk using an - * encryption key that you provide. If you are attaching an existing disk - * that is already encrypted, this field decrypts the disk using the - * customer-supplied encryption key. If you encrypt a disk using a - * customer-supplied key, you must provide the same key again when you - * attempt to use this resource at a later time. For example, you must - * provide the key when you create a snapshot or an image from the disk or - * when you attach the disk to a virtual machine instance. If you do not - * provide an encryption key, then the disk will be encrypted using an - * automatically generated key and you do not need to provide a key to use - * the disk later. Machine Images do not store customer-supplied encryption - * keys, so you cannot use your own keys to encrypt disks in a managed - * instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Machine Images do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The size of the disk in base-2 GB. This supersedes disk_size_gb in - * InitializeParams. + * The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. */ diskSizeGb?: string; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] A zero-based index to this disk, where 0 is reserved for - * the boot disk. If you have many disks attached to an instance, each disk - * would have a unique index number. + * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. */ index?: number; /** - * [Input Only] Specifies the parameters for a new disk that will be created - * alongside the new instance. Use initialization parameters to create boot - * disks or local SSDs attached to the new instance. This property is - * mutually exclusive with the source property; you can only define one or - * the other, but not both. + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ initializeParams?: Schema$AttachedDiskInitializeParams; /** - * Specifies the disk interface to use for attaching this disk, which is - * either SCSI or NVME. The default is SCSI. Persistent disks must always - * use SCSI and the request will fail if you attempt to attach a persistent - * disk in any other format than SCSI. Local SSDs can use either NVME or - * SCSI. For performance characteristics of SCSI over NVMe, see Local SSD - * performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ interface?: string; /** - * [Output Only] Type of the resource. Always compute#attachedDisk for - * attached disks. + * [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. */ kind?: string; /** @@ -13035,25 +9916,15 @@ export namespace compute_alpha { */ licenses?: string[]; /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - * not specified, the default is to attach the disk in READ_WRITE mode. + * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. */ mode?: string; /** - * For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this - * field is set to PRESERVED if the LocalSSD data has been saved to a - * persistent location by customer request. (see the discard_local_ssd - * option on Stop/Suspend). Read-only in the api. + * For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api. */ savedState?: string; /** - * Specifies a valid partial or full URL to an existing Persistent Disk - * resource. When creating a new instance, one of - * initializeParams.sourceImage or disks.source is required except for local - * SSD. If desired, you can also attach existing non-root persistent disks - * using this property. This field is only applicable for persistent disks. - * Note that for sourceMachineImage, specify the disk name, not the URL for - * the disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for sourceMachineImage, specify the disk name, not the URL for the disk. */ source?: string; /** @@ -13061,15 +9932,11 @@ export namespace compute_alpha { */ storageBytes?: string; /** - * [Output Only] An indicator whether storageBytes is in a stable state or - * it is being adjusted as a result of shared storage reallocation. This - * status can either be UPDATING, meaning the size of the snapshot is being - * updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. + * [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. */ storageBytesStatus?: string; /** - * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - * specified, the default is PERSISTENT. + * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. */ type?: string; } @@ -13078,24 +9945,15 @@ export namespace compute_alpha { */ export interface Schema$Scheduling { /** - * Specifies whether the instance should be automatically restarted if it is - * terminated by Compute Engine (not terminated by a user). You can only set - * the automatic restart option for standard instances. Preemptible - * instances cannot be automatically restarted. By default, this is set to - * true so an instance is automatically restarted if it is terminated by - * Compute Engine. + * Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. */ automaticRestart?: boolean; /** - * Defines whether the instance is tolerant of higher cpu latency. This can - * only be set during instance creation, or when the instance is not - * currently running. It must not be set if the preemptible option is also - * set. + * Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set. */ latencyTolerant?: boolean; /** - * The minimum number of virtual CPUs this instance will consume when - * running on a sole-tenant node. + * The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. */ minNodeCpus?: number; /** @@ -13103,22 +9961,16 @@ export namespace compute_alpha { */ nodeAffinities?: Schema$SchedulingNodeAffinity[]; /** - * Defines the maintenance behavior for this instance. For standard - * instances, the default behavior is MIGRATE. For preemptible instances, - * the default and only possible behavior is TERMINATE. For more - * information, see Setting Instance Scheduling Options. + * Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. */ onHostMaintenance?: string; /** - * Defines whether the instance is preemptible. This can only be set during - * instance creation, it cannot be set or changed after the instance has - * been created. + * Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. */ preemptible?: boolean; } /** - * Node Affinity: the configuration of desired nodes onto which this Instance - * could be scheduled. + * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. */ export interface Schema$SchedulingNodeAffinity { /** @@ -13150,9 +10002,7 @@ export namespace compute_alpha { wafRules?: Schema$PreconfiguredWafSet; } /** - * A security policy is comprised of one or more rules. It can also be - * associated with one or more 'targets'. (== resource_for - * v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -13164,65 +10014,39 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Specifies a fingerprint for this resource, which is essentially a hash of - * the metadata's contents and used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make get() request to the security policy. + * Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output only] Type of the resource. Always compute#securityPolicyfor - * security policies + * [Output only] Type of the resource. Always compute#securityPolicyfor security policies */ kind?: string; /** - * A fingerprint for the labels being applied to this security policy, which - * is essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels. To see - * the latest fingerprint, make get() request to the security policy. + * A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. */ labelFingerprint?: string; /** - * Labels to apply to this security policy resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this security policy resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * A list of rules that belong to this policy. There must always be a - * default rule (rule with priority 2147483647 and match "*"). If - * no rules are provided when creating a security policy, a default rule - * with action "allow" will be added. + * A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. */ rules?: Schema$SecurityPolicyRule[]; /** - * [Output Only] Total count of all security policy rule tuples. A security - * policy can not exceed a set number of tuples. + * [Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples. */ ruleTupleCount?: number; /** @@ -13234,9 +10058,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * The type indicates the intended use of the security policy. CLOUD_ARMOR - * policies apply to backend services. FIREWALL policies apply to - * organizations. + * The type indicates the intended use of the security policy. CLOUD_ARMOR policies apply to backend services. FIREWALL policies apply to organizations. */ type?: string; } @@ -13264,16 +10086,11 @@ export namespace compute_alpha { */ items?: Schema$SecurityPolicy[]; /** - * [Output Only] Type of resource. Always compute#securityPolicyList for - * listsof securityPolicies + * [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -13289,42 +10106,31 @@ export namespace compute_alpha { securityPolicy?: string; } /** - * Represents a rule that describes one or more match conditions along with - * the action to be taken when traffic matches this condition (allow or deny). + * Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). */ export interface Schema$SecurityPolicyRule { /** - * The Action to preform when the client connection triggers the rule. Can - * currently be either "allow" or "deny()" where valid - * values for status are 403, 404, and 502. + * The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. */ action?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The direction in which this rule applies. This field may only be - * specified when versioned_expr is set to FIREWALL. + * The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL. */ direction?: string; /** - * Denotes whether to enable logging for a particular rule. If logging is - * enabled, logs will be exported to the configured export destination in - * Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you - * cannot enable logging on "goto_next" rules. This field may - * only be specified when the versioned_expr is set to FIREWALL. + * Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL. */ enableLogging?: boolean; /** - * [Output only] Type of the resource. Always compute#securityPolicyRule for - * security policy rules + * [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules */ kind?: string; /** - * A match condition that incoming traffic is evaluated against. If it - * evaluates to true, the corresponding ?action? is enforced. + * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. */ match?: Schema$SecurityPolicyRuleMatcher; /** @@ -13332,64 +10138,46 @@ export namespace compute_alpha { */ preview?: boolean; /** - * An integer indicating the priority of a rule in the list. The priority - * must be a positive value between 0 and 2147483647. Rules are evaluated - * from highest to lowest priority where 0 is the highest priority and - * 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. */ priority?: number; /** - * Must be specified if the action is "rate_based_blacklist" or - * "throttle". Cannot be specified for any other actions. + * Must be specified if the action is "rate_based_blacklist" or "throttle". Cannot be specified for any other actions. */ rateLimitOptions?: Schema$SecurityPolicyRuleRateLimitOptions; /** - * [Output Only] Calculation of the complexity of a single firewall security - * policy rule. + * [Output Only] Calculation of the complexity of a single firewall security policy rule. */ ruleTupleCount?: number; /** - * A list of network resource URLs to which this rule applies. This field - * allows you to control which network?s VMs get this rule. If this field is - * left blank, all VMs within the organization will receive the rule. This - * field may only be specified when versioned_expr is set to FIREWALL. + * A list of network resource URLs to which this rule applies. This field allows you to control which network?s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL. */ targetResources?: string[]; } /** - * Represents a match condition that incoming traffic is evaluated against. - * Exactly one field must be specified. + * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. */ export interface Schema$SecurityPolicyRuleMatcher { /** - * The configuration options available when specifying versioned_expr. This - * field must be specified if versioned_expr is specified and cannot be - * specified if versioned_expr is not specified. + * The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. */ config?: Schema$SecurityPolicyRuleMatcherConfig; /** - * User defined CEVAL expression. A CEVAL expression is used to specify - * match criteria such as origin.ip, source.region_code and contents in the - * request header. + * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. */ expr?: Schema$Expr; /** - * Preconfigured versioned expression. If this field is specified, config - * must also be specified. Available preconfigured expressions along with - * their requirements are: SRC_IPS_V1 - must specify the corresponding - * src_ip_range field in config. + * Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. */ versionedExpr?: string; } export interface Schema$SecurityPolicyRuleMatcherConfig { /** - * CIDR IP address range. This field may only be specified when - * versioned_expr is set to FIREWALL. + * CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL. */ destIpRanges?: string[]; /** - * Pairs of IP protocols and ports that the rule should match. This field - * may only be specified when versioned_expr is set to FIREWALL. + * Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL. */ destPorts?: Schema$SecurityPolicyRuleMatcherConfigDestinationPort[]; /** @@ -13399,48 +10187,29 @@ export namespace compute_alpha { } export interface Schema$SecurityPolicyRuleMatcherConfigDestinationPort { /** - * The IP protocol to which this rule applies. The protocol type is required - * when creating a firewall rule. This value can either be one of the - * following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, - * sctp), or the IP protocol number. + * The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. */ ipProtocol?: string; /** - * An optional list of ports to which this rule applies. This field is only - * applicable for UDP or TCP protocol. Each entry must be either an integer - * or a range. If not specified, this rule applies to connections through - * any port. Example inputs include: ["22"], - * ["80","443"], and ["12345-12349"]. This - * field may only be specified when versioned_expr is set to FIREWALL. + * An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL. */ ports?: string[]; } export interface Schema$SecurityPolicyRuleRateLimitOptions { /** - * Can only be specifed if the action for the rule is - * "rate_based_blacklist" If specified, determines the time (in - * seconds) the traffic will continue to be blocked by the rate limit after - * the rate falls below the threshold. The default value is 0 seconds. + * Can only be specifed if the action for the rule is "rate_based_blacklist" If specified, determines the time (in seconds) the traffic will continue to be blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds. */ blockDuration?: number; /** - * Action to take when requests are under the given threshold. When requests - * are throttled, this is also the action for all requests which are not - * dropped. Valid options are "allow", "fairshare", and - * "drop_overload". + * Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload". */ conformAction?: string; /** - * Determines the key to enforce the threshold_rps limit on. If key is - * "IP", each IP has this limit enforced separately, whereas - * "ALL_IPs" means a single limit is applied to all requests - * matching this rule. + * Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule. */ enforceOnKey?: string; /** - * When a request is denied, returns the HTTP response code specified. Valid - * options are "deny()" where valid values for status are 403, - * 404, 429, and 502. + * When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502. */ exceedAction?: string; /** @@ -13453,9 +10222,7 @@ export namespace compute_alpha { */ export interface Schema$SecuritySettings { /** - * Authentication policy defines what authentication methods can be accepted - * on backends, and if authenticated, which method/certificate will set the - * request principal. + * Authentication policy defines what authentication methods can be accepted on backends, and if authenticated, which method/certificate will set the request principal. */ authenticationPolicy?: Schema$AuthenticationPolicy; /** @@ -13467,8 +10234,7 @@ export namespace compute_alpha { */ clientTlsSettings?: Schema$ClientTlsSettings; /** - * The listener config of the XDS client is generated if the selector - * matches the client. + * The listener config of the XDS client is generated if the selector matches the client. */ serverSettingsSelector?: Schema$ServerSecuritySettingsSelector; } @@ -13481,14 +10247,11 @@ export namespace compute_alpha { */ contents?: string; /** - * [Output Only] Type of the resource. Always compute#serialPortOutput for - * serial port output. + * [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. */ kind?: string; /** - * [Output Only] The position of the next byte of content from the serial - * console output. Use this value in the next request as the start - * parameter. + * [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter. */ next?: string; /** @@ -13496,10 +10259,7 @@ export namespace compute_alpha { */ selfLink?: string; /** - * The starting byte position of the output that was returned. This should - * match the start parameter sent with the request. If the serial console - * output exceeds the size of the buffer, older output will be overwritten - * by newer content and the start values will be mismatched. + * The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched. */ start?: string; } @@ -13507,9 +10267,7 @@ export namespace compute_alpha { type?: string; } /** - * A selector associated with the SecuritySettings. If the labels and port in - * this selector match the Envoy's label and port, the server side - * authentication and authorization settings are applied to the Envoy. + * A selector associated with the SecuritySettings. If the labels and port in this selector match the Envoy's label and port, the server side authentication and authorization settings are applied to the Envoy. */ export interface Schema$ServerSecuritySettingsSelector { /** @@ -13526,21 +10284,15 @@ export namespace compute_alpha { */ export interface Schema$ServerTlsSettings { /** - * Configures the mechanism to obtain security certificates and identity - * information. + * Configures the mechanism to obtain security certificates and identity information. */ proxyTlsContext?: Schema$TlsContext; /** - * A list of alternate names to verify the subject identity in the - * certificate presented by the client. + * A list of alternate names to verify the subject identity in the certificate presented by the client. */ subjectAltNames?: string[]; /** - * Indicates whether connections should be secured using TLS. The value of - * this field determines how TLS is enforced. This field can be set to one - * of the following: - SIMPLE Secure connections with standard TLS - * semantics. - MUTUAL Secure connections to the backends using mutual TLS - * by presenting client certificates for authentication. + * Indicates whether connections should be secured using TLS. The value of this field determines how TLS is enforced. This field can be set to one of the following: - SIMPLE Secure connections with standard TLS semantics. - MUTUAL Secure connections to the backends using mutual TLS by presenting client certificates for authentication. */ tlsMode?: string; } @@ -13596,8 +10348,7 @@ export namespace compute_alpha { */ encryptionKey?: Schema$ShieldedInstanceIdentityEntry; /** - * [Output Only] Type of the resource. Always - * compute#shieldedInstanceIdentity for shielded Instance identity entry. + * [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. */ kind?: string; /** @@ -13619,13 +10370,11 @@ export namespace compute_alpha { ekPub?: string; } /** - * The policy describes the baseline against which Instance boot integrity is - * measured. + * The policy describes the baseline against which Instance boot integrity is measured. */ export interface Schema$ShieldedInstanceIntegrityPolicy { /** - * Updates the integrity policy baseline using the measurements from the VM - * instance's most recent boot. + * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ updateAutoLearnPolicy?: boolean; } @@ -13655,8 +10404,7 @@ export namespace compute_alpha { */ encryptionKey?: Schema$ShieldedVmIdentityEntry; /** - * [Output Only] Type of the resource. Always compute#shieldedVmIdentity for - * shielded VM identity entry. + * [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry. */ kind?: string; /** @@ -13678,13 +10426,11 @@ export namespace compute_alpha { ekPub?: string; } /** - * The policy describes the baseline against which VM instance boot integrity - * is measured. + * The policy describes the baseline against which VM instance boot integrity is measured. */ export interface Schema$ShieldedVmIntegrityPolicy { /** - * Updates the integrity policy baseline using the measurements from the VM - * instance's most recent boot. + * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ updateAutoLearnPolicy?: boolean; } @@ -13693,28 +10439,20 @@ export namespace compute_alpha { */ export interface Schema$SignedUrlKey { /** - * Name of the key. The name must be 1-63 characters long, and comply with - * RFC1035. Specifically, the name must be 1-63 characters long and match - * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. + * Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ keyName?: string; /** - * 128-bit key value used for signing the URL. The key value must be a valid - * RFC 4648 Section 5 base64url encoded string. + * 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. */ keyValue?: string; } /** - * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) - * (== resource_for v1.snapshots ==) + * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) */ export interface Schema$Snapshot { /** - * [Output Only] Set to true if snapshots are automatically by applying - * resource policy on the target disk. + * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. */ autoCreated?: boolean; /** @@ -13722,8 +10460,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -13731,55 +10468,35 @@ export namespace compute_alpha { */ diskSizeGb?: string; /** - * [Output Only] A list of features to enable on the guest operating system. - * Applicable only for bootable images. Read Enabling guest operating - * system features to see a list of available options. + * [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#snapshot for Snapshot - * resources. + * [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. */ kind?: string; /** - * A fingerprint for the labels being applied to this snapshot, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a snapshot. + * A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. */ labelFingerprint?: string; /** - * Labels to apply to this snapshot. These can be later modified by the - * setLabels method. Label values may be empty. + * Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. */ labels?: {[key: string]: string}; /** - * [Output Only] Integer license codes indicating which licenses are - * attached to this snapshot. + * [Output Only] Integer license codes indicating which licenses are attached to this snapshot. */ licenseCodes?: string[]; /** - * [Output Only] A list of public visible licenses that apply to this - * snapshot. This can be because the original image had licenses attached - * (such as a Windows image). + * [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). */ licenses?: string[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -13791,15 +10508,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * Encrypts the snapshot using a customer-supplied encryption key. After - * you encrypt a snapshot using a customer-supplied key, you must provide - * the same key if you use the image later For example, you must provide the - * encryption key when you create a disk from the encrypted snapshot in a - * future request. Customer-supplied encryption keys do not protect access - * to metadata of the disk. If you do not provide an encryption key when - * creating the snapshot, then the snapshot will be encrypted using an - * automatically generated key and you do not need to provide a key to use - * the snapshot later. + * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ snapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -13807,32 +10516,23 @@ export namespace compute_alpha { */ sourceDisk?: string; /** - * The customer-supplied encryption key of the source disk. Required if the - * source disk is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the disk used to create this snapshot. This - * value may be used to determine whether the snapshot was taken from the - * current or a previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. */ sourceDiskId?: string; /** - * [Output Only] The status of the snapshot. This can be CREATING, DELETING, - * FAILED, READY, or UPLOADING. + * [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. */ status?: string; /** - * [Output Only] A size of the storage used by the snapshot. As snapshots - * share storage, this number is expected to change with snapshot - * creation/deletion. + * [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. */ storageBytes?: string; /** - * [Output Only] An indicator whether storageBytes is in a stable state or - * it is being adjusted as a result of shared storage reallocation. This - * status can either be UPDATING, meaning the size of the snapshot is being - * updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. + * [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. */ storageBytesStatus?: string; /** @@ -13857,11 +10557,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -13878,46 +10574,33 @@ export namespace compute_alpha { }; } /** - * A specification of the parameters to use when creating the instance - * template from a source instance. + * A specification of the parameters to use when creating the instance template from a source instance. */ export interface Schema$SourceInstanceParams { /** - * Attached disks configuration. If not provided, defaults are applied: For - * boot disk and any other R/W disks, new custom images will be created from - * each disk. For read-only disks, they will be attached in read-only mode. - * Local SSD disks will be created as blank volumes. + * Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. */ diskConfigs?: Schema$DiskInstantiationConfig[]; } export interface Schema$SourceInstanceProperties { /** - * Enables instances created based on this machine image to send packets - * with source IP addresses other than their own and receive packets with - * destination IP addresses other than their own. If these instances will be - * used as an IP gateway or it will be set as the next-hop in a Route - * resource, specify true. If unsure, leave this set to false. See the - * Enable IP forwarding documentation for more information. + * Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. */ canIpForward?: boolean; /** - * Whether the instance created from the machine image should be protected - * against deletion. + * Whether the instance created from the machine image should be protected against deletion. */ deletionProtection?: boolean; /** - * An optional text description for the instances that are created from this - * machine image. + * An optional text description for the instances that are created from this machine image. */ description?: string; /** - * An array of disks that are associated with the instances that are created - * from this machine image. + * An array of disks that are associated with the instances that are created from this machine image. */ disks?: Schema$SavedAttachedDisk[]; /** - * A list of guest accelerator cards' type and count to use for - * instances created from the machine image. + * A list of guest accelerator cards' type and count to use for instances created from the machine image. */ guestAccelerators?: Schema$AcceleratorConfig[]; /** @@ -13925,22 +10608,15 @@ export namespace compute_alpha { */ labels?: {[key: string]: string}; /** - * The machine type to use for instances that are created from this machine - * image. + * The machine type to use for instances that are created from this machine image. */ machineType?: string; /** - * The metadata key/value pairs to assign to instances that are created from - * this machine image. These pairs can consist of custom metadata or - * predefined keys. See Project and instance metadata for more information. + * The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. */ metadata?: Schema$Metadata; /** - * Minimum cpu/platform to be used by this instance. The instance may be - * scheduled on the specified or newer cpu/platform. Applicable values are - * the friendly names of CPU platforms, such as minCpuPlatform: "Intel - * Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more - * information, read Specifying a Minimum CPU Platform. + * Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. */ minCpuPlatform?: string; /** @@ -13948,36 +10624,24 @@ export namespace compute_alpha { */ networkInterfaces?: Schema$NetworkInterface[]; /** - * Specifies the scheduling options for the instances that are created from - * this machine image. + * Specifies the scheduling options for the instances that are created from this machine image. */ scheduling?: Schema$Scheduling; /** - * A list of service accounts with specified scopes. Access tokens for these - * service accounts are available to the instances that are created from - * this machine image. Use metadata queries to obtain the access tokens for - * these instances. + * A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances. */ serviceAccounts?: Schema$ServiceAccount[]; /** - * A list of tags to apply to the instances that are created from this - * machine image. The tags identify valid sources or targets for network - * firewalls. The setTags method can modify this list of tags. Each tag - * within the list must comply with RFC1035. + * A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. */ tags?: Schema$Tags; } /** - * An SslCertificate resource. This resource provides a mechanism to upload an - * SSL key and certificate to the load balancer to serve secure connections - * from the user. (== resource_for beta.sslCertificates ==) (== resource_for - * v1.sslCertificates ==) + * An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) */ export interface Schema$SslCertificate { /** - * A local certificate file. The certificate must be in PEM format. The - * certificate chain must be no greater than 5 certs long. The chain must - * include at least one intermediate cert. + * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ certificate?: string; /** @@ -13985,8 +10649,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -13994,13 +10657,11 @@ export namespace compute_alpha { */ expireTime?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#sslCertificate for SSL - * certificates. + * [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. */ kind?: string; /** @@ -14008,23 +10669,15 @@ export namespace compute_alpha { */ managed?: Schema$SslCertificateManagedSslCertificate; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * A write-only private key in PEM format. Only insert requests will include - * this field. + * A write-only private key in PEM format. Only insert requests will include this field. */ privateKey?: string; /** - * [Output Only] URL of the region where the regional SSL Certificate - * resides. This field is not applicable to global SSL Certificate. + * [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. */ region?: string; /** @@ -14040,15 +10693,11 @@ export namespace compute_alpha { */ selfManaged?: Schema$SslCertificateSelfManagedSslCertificate; /** - * [Output Only] Domains associated with the certificate via Subject - * Alternative Name. + * [Output Only] Domains associated with the certificate via Subject Alternative Name. */ subjectAlternativeNames?: string[]; /** - * (Optional) Specifies the type of SSL certificate, either - * "SELF_MANAGED" or "MANAGED". If not specified, the - * certificate is self-managed and the fields certificate and private_key - * are used. + * (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. */ type?: string; } @@ -14062,16 +10711,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$SslCertificatesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#sslCertificateAggregatedList for lists of SSL Certificates. + * [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -14104,11 +10748,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -14129,13 +10769,11 @@ export namespace compute_alpha { */ export interface Schema$SslCertificateManagedSslCertificate { /** - * The domains for which a managed SSL certificate will be generated. - * Currently only single-domain certs are supported. + * The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported. */ domains?: string[]; /** - * [Output only] Detailed statuses of the domains specified for managed - * certificate resource. + * [Output only] Detailed statuses of the domains specified for managed certificate resource. */ domainStatus?: {[key: string]: string}; /** @@ -14148,14 +10786,11 @@ export namespace compute_alpha { */ export interface Schema$SslCertificateSelfManagedSslCertificate { /** - * A local certificate file. The certificate must be in PEM format. The - * certificate chain must be no greater than 5 certs long. The chain must - * include at least one intermediate cert. + * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ certificate?: string; /** - * A write-only private key in PEM format. Only insert requests will include - * this field. + * A write-only private key in PEM format. Only insert requests will include this field. */ privateKey?: string; } @@ -14165,8 +10800,7 @@ export namespace compute_alpha { */ sslCertificates?: Schema$SslCertificate[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -14176,42 +10810,27 @@ export namespace compute_alpha { } export interface Schema$SSLHealthCheck { /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, SSL health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The application data to send once the SSL connection has been established - * (default value is empty). If both request and response are empty, the - * connection establishment alone will indicate health. The request data can - * only be ASCII. + * The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ request?: string; /** - * The bytes to match against the beginning of the response data. If left - * empty (the default value), any response will indicate health. The - * response data can only be ASCII. + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ response?: string; } @@ -14225,16 +10844,11 @@ export namespace compute_alpha { */ items?: Schema$SslPolicy[]; /** - * [Output Only] Type of the resource. Always compute#sslPoliciesList for - * lists of sslPolicies. + * [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -14254,10 +10868,7 @@ export namespace compute_alpha { features?: string[]; } /** - * A SSL policy specifies the server-side support for SSL features. This can - * be attached to a TargetHttpsProxy or a TargetSslProxy. This affects - * connections between clients and the HTTPS or SSL proxy load balancer. They - * do not affect the connection between the load balancers and the backends. + * A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends. */ export interface Schema$SslPolicy { /** @@ -14265,14 +10876,11 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * A list of features enabled when the selected profile is CUSTOM. The - - * method returns the set of features that can be specified in this list. - * This field must be empty if the profile is not CUSTOM. + * A list of features enabled when the selected profile is CUSTOM. The - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. */ customFeatures?: string[]; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -14280,44 +10888,27 @@ export namespace compute_alpha { */ enabledFeatures?: string[]; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a SslPolicy. An up-to-date fingerprint must be - * provided in order to update the SslPolicy, otherwise the request will - * fail with error 412 conditionNotMet. To see the latest fingerprint, make - * a get() request to retrieve an SslPolicy. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output only] Type of the resource. Always compute#sslPolicyfor SSL - * policies. + * [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. */ kind?: string; /** - * The minimum version of SSL protocol that can be used by the clients to - * establish a connection with the load balancer. This can be one of - * TLS_1_0, TLS_1_1, TLS_1_2. + * The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. */ minTlsVersion?: string; /** - * Name of the resource. The name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Profile specifies the set of SSL features that can be used by the load - * balancer when negotiating SSL with clients. This can be one of - * COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of - * SSL features to enable must be specified in the customFeatures field. + * Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. */ profile?: string; /** @@ -14329,14 +10920,11 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * Security settings for the proxy. This field is only applicable to a - * global backend service with the loadBalancingScheme set to - * INTERNAL_SELF_MANAGED. + * Security settings for the proxy. This field is only applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ tlsSettings?: Schema$ServerTlsSettings; /** - * [Output Only] If potential misconfigurations are detected for this SSL - * policy, this field will be populated with warning messages. + * [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. */ warnings?: Array<{ code?: string; @@ -14346,8 +10934,7 @@ export namespace compute_alpha { } export interface Schema$SslPolicyReference { /** - * URL of the SSL policy resource. Set this to empty string to clear any - * existing SSL policy associated with the target proxy resource. + * URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. */ sslPolicy?: string; } @@ -14366,8 +10953,7 @@ export namespace compute_alpha { */ export interface Schema$StatefulPolicyPreservedResources { /** - * Disks created on the instances that will be preserved on instance delete, - * resize down, etc. + * Disks created on the instances that will be preserved on instance delete, resize down, etc. */ disks?: Schema$StatefulPolicyPreservedDisk[]; } @@ -14376,45 +10962,26 @@ export namespace compute_alpha { */ export interface Schema$StatefulPolicyPreservedState { /** - * Disks created on the instances that will be preserved on instance delete, - * resize down, etc. This map is keyed with the device names of the disks. + * Disks created on the instances that will be preserved on instance delete, resize down, etc. This map is keyed with the device names of the disks. */ disks?: {[key: string]: Schema$StatefulPolicyPreservedStateDiskDevice}; } export interface Schema$StatefulPolicyPreservedStateDiskDevice { /** - * These stateful disks will never be deleted during autohealing, update or - * VM instance recreate operations. This flag is used to configure if the - * disk should be deleted after it is no longer used by the group, e.g. when - * the given instance or the whole group is deleted. Note: disks attached in - * READ_ONLY mode cannot be auto-deleted. + * These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. */ autoDelete?: string; } /** - * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== - * resource_for v1.subnetworks ==) + * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) */ export interface Schema$Subnetwork { /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * Toggles the aggregation interval for collecting flow logs. Increasing the - * interval time will reduce the amount of generated flow logs for long - * lasting connections. Default is an interval of 5 seconds per connection. + * Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. */ aggregationInterval?: string; /** - * Whether this subnetwork can conflict with static routes. Setting this to - * true allows this subnetwork's primary and secondary ranges to - * conflict with routes that have already been configured on the - * corresponding network. Static routes will take precedence over the - * subnetwork route if the route prefix length is at least as large as the - * subnetwork prefix length. Also, packets destined to IPs within - * subnetwork may contain private/sensitive data and are prevented from - * leaving the virtual network. Setting this field to true will disable this - * feature. The default value is false and applies to all existing - * subnetworks and automatically created subnetworks. This field cannot be - * set to true at resource creation time. + * Whether this subnetwork can conflict with static routes. Setting this to true allows this subnetwork's primary and secondary ranges to conflict with routes that have already been configured on the corresponding network. Static routes will take precedence over the subnetwork route if the route prefix length is at least as large as the subnetwork prefix length. Also, packets destined to IPs within subnetwork may contain private/sensitive data and are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks. This field cannot be set to true at resource creation time. */ allowSubnetCidrRoutesOverlap?: boolean; /** @@ -14422,145 +10989,87 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. This field can be set only at resource creation - * time. + * An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. */ description?: string; /** - * Whether to enable flow logging for this subnetwork. If this field is not - * explicitly set, it will not appear in get listings. If not set the - * default behavior is to disable flow logging. + * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ enableFlowLogs?: boolean; /** - * Deprecated in favor of enable in PrivateIpv6GoogleAccess. Whether the VMs - * in this subnet can directly access Google services via internal IPv6 - * addresses. This field can be both set at resource creation time and - * updated using patch. + * Deprecated in favor of enable in PrivateIpv6GoogleAccess. Whether the VMs in this subnet can directly access Google services via internal IPv6 addresses. This field can be both set at resource creation time and updated using patch. */ enablePrivateV6Access?: boolean; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a Subnetwork. An up-to-date fingerprint must be - * provided in order to update the Subnetwork, otherwise the request will - * fail with error 412 conditionNotMet. To see the latest fingerprint, make - * a get() request to retrieve a Subnetwork. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. */ fingerprint?: string; /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * The value of the field must be in [0, 1]. Set the sampling rate of VPC - * flow logs within the subnetwork where 1.0 means all collected logs are - * reported and 0.0 means no logs are reported. Default is 0.5 which means - * half of all collected logs are reported. + * Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 which means half of all collected logs are reported. */ flowSampling?: number; /** - * [Output Only] The gateway address for default routes to reach destination - * addresses outside this subnetwork. + * [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. */ gatewayAddress?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The range of internal addresses that are owned by this subnetwork. - * Provide this property when you create the subnetwork. For - * example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and - * non-overlapping within a network. Only IPv4 is supported. This field can - * be set only at resource creation time. + * The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. */ ipCidrRange?: string; /** - * [Output Only] The range of internal IPv6 addresses that are owned by this - * subnetwork. + * [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. */ ipv6CidrRange?: string; /** - * [Output Only] Type of the resource. Always compute#subnetwork for - * Subnetwork resources. + * [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. */ kind?: string; /** - * This field denotes the logging options for the load balancer traffic - * served by this backend service. If logging is enabled, logs will be - * exported to Stackdriver. + * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. */ logConfig?: Schema$SubnetworkLogConfig; /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * Configures whether metadata fields should be added to the reported VPC - * flow logs. Default is INCLUDE_ALL_METADATA. + * Can only be specified if VPC flow logging for this subnetwork is enabled. Configures whether metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. */ metadata?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The name must be 1-63 characters long, and comply with - * RFC1035. Specifically, the name must be 1-63 characters long and match - * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network to which this subnetwork belongs, provided by the - * client when initially creating the subnetwork. Only networks that are in - * the distributed mode can have subnetworks. This field can be set only at - * resource creation time. + * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. */ network?: string; /** - * Whether the VMs in this subnet can access Google services without - * assigned external IP addresses. This field can be both set at resource - * creation time and updated using setPrivateIpGoogleAccess. + * Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. */ privateIpGoogleAccess?: boolean; /** - * The private IPv6 google access type for the VMs in this subnet. This is - * an expanded field of enablePrivateV6Access. If both fields are set, - * privateIpv6GoogleAccess will take priority. This field can be both set - * at resource creation time and updated using patch. + * The private IPv6 google access type for the VMs in this subnet. This is an expanded field of enablePrivateV6Access. If both fields are set, privateIpv6GoogleAccess will take priority. This field can be both set at resource creation time and updated using patch. */ privateIpv6GoogleAccess?: string; /** - * The purpose of the resource. This field can be either PRIVATE_RFC_1918 or - * INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to - * INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is - * reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose - * defaults to PRIVATE_RFC_1918. + * The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. */ purpose?: string; /** - * The type of IP CIDR range to associate with this subnetwork. The default - * is RFC_1918. When creating a subnetwork in non-RFC 1918 range, this field - * must be set to NON_RFC_1918. + * The type of IP CIDR range to associate with this subnetwork. The default is RFC_1918. When creating a subnetwork in non-RFC 1918 range, this field must be set to NON_RFC_1918. */ rangeType?: string; /** - * URL of the region where the Subnetwork resides. This field can be set - * only at resource creation time. + * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. */ region?: string; /** - * The role of subnetwork. Currenly, this field is only used when purpose = - * INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. - * An ACTIVE subnetwork is one that is currently being used for Internal - * HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be - * promoted to ACTIVE or is currently draining. This field can be updated - * with a patch request. + * The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. */ role?: string; /** - * An array of configurations for secondary IP ranges for VM instances - * contained in this subnetwork. The primary IP of such VM must belong to - * the primary ipCidrRange of the subnetwork. The alias IPs may belong to - * either primary or secondary ranges. This field can be updated with a - * patch request. + * An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. */ secondaryIpRanges?: Schema$SubnetworkSecondaryRange[]; /** @@ -14572,12 +11081,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The state of the subnetwork, which can be one of READY or - * DRAINING. A subnetwork that is READY is ready to be used. The state of - * DRAINING is only applicable to subnetworks that have the purpose set to - * INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load - * balancer are being drained. A subnetwork that is draining cannot be used - * or modified until it reaches a status of READY. + * [Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY. */ state?: string; } @@ -14591,16 +11095,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$SubnetworksScopedList}; /** - * [Output Only] Type of resource. Always compute#subnetworkAggregatedList - * for aggregated lists of subnetworks. + * [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -14629,16 +11128,11 @@ export namespace compute_alpha { */ items?: Schema$Subnetwork[]; /** - * [Output Only] Type of resource. Always compute#subnetworkList for lists - * of subnetworks. + * [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -14659,30 +11153,19 @@ export namespace compute_alpha { */ export interface Schema$SubnetworkLogConfig { /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * Toggles the aggregation interval for collecting flow logs. Increasing the - * interval time will reduce the amount of generated flow logs for long - * lasting connections. Default is an interval of 5 seconds per connection. + * Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. */ aggregationInterval?: string; /** - * Whether to enable flow logging for this subnetwork. If this field is not - * explicitly set, it will not appear in get listings. If not set the - * default behavior is to disable flow logging. + * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ enable?: boolean; /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * The value of the field must be in [0, 1]. Set the sampling rate of VPC - * flow logs within the subnetwork where 1.0 means all collected logs are - * reported and 0.0 means no logs are reported. Default is 0.5 which means - * half of all collected logs are reported. + * Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 which means half of all collected logs are reported. */ flowSampling?: number; /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * Configures whether metadata fields should be added to the reported VPC - * flow logs. Default is INCLUDE_ALL_METADATA. + * Can only be specified if VPC flow logging for this subnetwork is enabled. Configures whether metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. */ metadata?: string; } @@ -14691,38 +11174,25 @@ export namespace compute_alpha { */ export interface Schema$SubnetworkSecondaryRange { /** - * The range of IP addresses belonging to this subnetwork secondary range. - * Provide this property when you create the subnetwork. Ranges must be - * unique and non-overlapping with all primary and secondary IP ranges - * within a network. Only IPv4 is supported. + * The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. The name must be 1-63 - * characters long, and comply with RFC1035. The name must be unique within - * the subnetwork. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ rangeName?: string; /** - * The type of IP CIDR range to associate with this subnetwork secondary - * range. The default is RFC_1918. When creating a subnetwork in non-RFC - * 1918 range, this field must be set to NON_RFC_1918. + * The type of IP CIDR range to associate with this subnetwork secondary range. The default is RFC_1918. When creating a subnetwork in non-RFC 1918 range, this field must be set to NON_RFC_1918. */ rangeType?: string; } export interface Schema$SubnetworksExpandIpCidrRangeRequest { /** - * The IP (in CIDR format or netmask) of internal addresses that are legal - * on this Subnetwork. This range should be disjoint from other subnetworks - * within this network. This range can only be larger than (i.e. a superset - * of) the range previously defined before the update. + * The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. */ ipCidrRange?: string; /** - * The type of IP CIDR range to associate with this subnetwork. The default - * is RFC_1918. When expanding to a non-RFC 1918 range, this field must be - * be set to NON_RFC_1918. + * The type of IP CIDR range to associate with this subnetwork. The default is RFC_1918. When expanding to a non-RFC 1918 range, this field must be be set to NON_RFC_1918. */ rangeType?: string; } @@ -14732,8 +11202,7 @@ export namespace compute_alpha { */ subnetworks?: Schema$Subnetwork[]; /** - * An informational warning that appears when the list of addresses is - * empty. + * An informational warning that appears when the list of addresses is empty. */ warning?: { code?: string; @@ -14749,17 +11218,11 @@ export namespace compute_alpha { */ export interface Schema$Tags { /** - * Specifies a fingerprint for this request, which is essentially a hash of - * the tags' contents and used for optimistic locking. The fingerprint - * is initially generated by Compute Engine and changes after every request - * to modify or update tags. You must always provide an up-to-date - * fingerprint hash in order to update or change tags. To see the latest - * fingerprint, make get() request to the instance. + * Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. */ fingerprint?: string; /** - * An array of tags. Each tag must be 1-63 characters long, and comply with - * RFC1035. + * An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. */ items?: string[]; } @@ -14769,8 +11232,7 @@ export namespace compute_alpha { */ targetHttpProxies?: Schema$TargetHttpProxy[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -14779,9 +11241,7 @@ export namespace compute_alpha { }; } /** - * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== - * resource_for beta.targetHttpProxies ==) (== resource_for - * v1.targetHttpProxies ==) + * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -14789,39 +11249,27 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetHttpProxy for target - * HTTP proxies. + * [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * This field only applies when the loadBalancingScheme is - * INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address - * specified by the forwarding rule. Default is false. + * This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false. */ proxyBind?: boolean; /** - * [Output Only] URL of the region where the regional Target HTTP Proxy - * resides. This field is not applicable to global Target HTTP Proxies. + * [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. */ region?: string; /** @@ -14833,8 +11281,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * URL to the UrlMap resource that defines the mapping from URL to the - * BackendService. + * URL to the UrlMap resource that defines the mapping from URL to the BackendService. */ urlMap?: string; } @@ -14848,16 +11295,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$TargetHttpProxiesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. + * [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -14886,16 +11328,11 @@ export namespace compute_alpha { */ items?: Schema$TargetHttpProxy[]; /** - * Type of resource. Always compute#targetHttpProxyList for lists of target - * HTTP proxies. + * Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -14917,8 +11354,7 @@ export namespace compute_alpha { */ targetHttpsProxies?: Schema$TargetHttpsProxy[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -14934,16 +11370,12 @@ export namespace compute_alpha { } export interface Schema$TargetHttpsProxiesSetSslCertificatesRequest { /** - * New set of SslCertificate resources to associate with this - * TargetHttpsProxy resource. Currently exactly one SslCertificate resource - * must be specified. + * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. */ sslCertificates?: string[]; } /** - * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== - * resource_for beta.targetHttpsProxies ==) (== resource_for - * v1.targetHttpsProxies ==) + * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -14951,49 +11383,31 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetHttpsProxy for - * target HTTPS proxies. + * [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * This field only applies when the loadBalancingScheme is - * INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address - * specified by the forwarding rule. Default is false. + * This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false. */ proxyBind?: boolean; /** - * Specifies the QUIC override policy for this TargetHttpsProxy resource. - * This determines whether the load balancer will attempt to negotiate QUIC - * with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify - * ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and - * disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC - * policy with no user overrides, which is equivalent to DISABLE. Not - * specifying this field is equivalent to specifying NONE. + * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. */ quicOverride?: string; /** - * [Output Only] URL of the region where the regional TargetHttpsProxy - * resides. This field is not applicable to global TargetHttpsProxies. + * [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. */ region?: string; /** @@ -15005,24 +11419,15 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * URLs to SslCertificate resources that are used to authenticate - * connections between users and the load balancer. At least one SSL - * certificate must be specified. Currently, you may specify up to 15 SSL - * certificates. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** - * URL of SslPolicy resource that will be associated with the - * TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will - * not have any SSL policy configured. + * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. */ sslPolicy?: string; /** - * A fully-qualified or valid partial URL to the UrlMap resource that - * defines the mapping from URL to the BackendService. For example, the - * following are all valid URLs for specifying a URL map: - - * https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - * - projects/project/global/urlMaps/url-map - global/urlMaps/url-map + * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map */ urlMap?: string; } @@ -15036,16 +11441,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$TargetHttpsProxiesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. + * [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15074,16 +11474,11 @@ export namespace compute_alpha { */ items?: Schema$TargetHttpsProxy[]; /** - * Type of resource. Always compute#targetHttpsProxyList for lists of target - * HTTPS proxies. + * Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15100,9 +11495,7 @@ export namespace compute_alpha { }; } /** - * A TargetInstance resource. This resource defines an endpoint instance that - * terminates traffic of certain protocols. (== resource_for - * beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -15110,43 +11503,27 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * A URL to the virtual machine instance that handles traffic for this - * target instance. When creating a target instance, you can provide the - * fully-qualified URL or a valid partial URL to the desired virtual - * machine. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance - - * zones/zone/instances/instance + * A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ instance?: string; /** - * [Output Only] The type of the resource. Always compute#targetInstance for - * target instances. + * [Output Only] The type of the resource. Always compute#targetInstance for target instances. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * NAT option controlling how IPs are NAT'ed to the instance. Currently - * only NO_NAT (default value) is supported. + * NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. */ natPolicy?: string; /** @@ -15158,9 +11535,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] URL of the zone where the target instance resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -15178,11 +11553,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15215,11 +11586,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15241,8 +11608,7 @@ export namespace compute_alpha { */ targetInstances?: Schema$TargetInstance[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -15251,23 +11617,11 @@ export namespace compute_alpha { }; } /** - * A TargetPool resource. This resource defines a pool of instances, an - * associated HttpHealthCheck resource, and the fallback target pool. (== - * resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) */ export interface Schema$TargetPool { /** - * This field is applicable only when the containing target pool is serving - * a forwarding rule as the primary pool, and its failoverRatio field is - * properly set to a value between [0, 1]. backupPool and failoverRatio - * together define the fallback behavior of the primary target pool: if the - * ratio of the healthy instances in the primary pool is at or below - * failoverRatio, traffic arriving at the load-balanced IP will be directed - * to the backup pool. In case where failoverRatio and backupPool are not - * set, or all the instances in the backup pool are unhealthy, the traffic - * will be directed back to the primary pool in the "force" mode, - * where traffic will be spread to the healthy instances with the best - * effort, or to all instances when no instance is healthy. + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ backupPool?: string; /** @@ -15275,56 +11629,31 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * This field is applicable only when the containing target pool is serving - * a forwarding rule as the primary pool (i.e., not as a backup pool to some - * other target pool). The value of the field must be in [0, 1]. If set, - * backupPool must also be set. They together define the fallback behavior - * of the primary target pool: if the ratio of the healthy instances in the - * primary pool is at or below this number, traffic arriving at the - * load-balanced IP will be directed to the backup pool. In case where - * failoverRatio is not set or all the instances in the backup pool are - * unhealthy, the traffic will be directed back to the primary pool in the - * "force" mode, where traffic will be spread to the healthy - * instances with the best effort, or to all instances when no instance is - * healthy. + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ failoverRatio?: number; /** - * The URL of the HttpHealthCheck resource. A member instance in this pool - * is considered healthy if and only if the health checks pass. An empty - * list means all member instances will be considered healthy at all times. - * Only HttpHealthChecks are supported. Only one health check may be - * specified. + * The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. */ healthChecks?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * A list of resource URLs to the virtual machine instances serving this - * pool. They must live in zones contained in the same region as this pool. + * A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. */ instances?: string[]; /** - * [Output Only] Type of the resource. Always compute#targetPool for target - * pools. + * [Output Only] Type of the resource. Always compute#targetPool for target pools. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -15340,13 +11669,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * Session affinity option, must be one of the following values: NONE: - * Connections from the same client IP may go to any instance in the pool. - * CLIENT_IP: Connections from the same client IP will go to the same - * instance in the pool while that instance remains healthy. - * CLIENT_IP_PROTO: Connections from the same client IP with the same IP - * protocol will go to the same instance in the pool while that instance - * remains healthy. + * Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. */ sessionAffinity?: string; } @@ -15360,16 +11683,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$TargetPoolsScopedList}; /** - * [Output Only] Type of resource. Always compute#targetPoolAggregatedList - * for aggregated lists of target pools. + * [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15388,8 +11706,7 @@ export namespace compute_alpha { export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; /** - * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth - * when checking the health of an instance. + * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. */ kind?: string; } @@ -15406,16 +11723,11 @@ export namespace compute_alpha { */ items?: Schema$TargetPool[]; /** - * [Output Only] Type of resource. Always compute#targetPoolList for lists - * of target pools. + * [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15439,21 +11751,13 @@ export namespace compute_alpha { } export interface Schema$TargetPoolsAddInstanceRequest { /** - * A full or partial URL to an instance to add to this target pool. This can - * be a full or partial URL. For example, the following are valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name - * - projects/project-id/zones/zone/instances/instance-name - - * zones/zone/instances/instance-name + * A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name */ instances?: Schema$InstanceReference[]; } export interface Schema$TargetPoolsRemoveHealthCheckRequest { /** - * Health check URL to be removed. This can be a full or valid partial URL. - * For example, the following are valid URLs: - - * https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check - * - projects/project/global/httpHealthChecks/health-check - - * global/httpHealthChecks/health-check + * Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ healthChecks?: Schema$HealthCheckReference[]; } @@ -15469,8 +11773,7 @@ export namespace compute_alpha { */ targetPools?: Schema$TargetPool[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -15489,22 +11792,18 @@ export namespace compute_alpha { } export interface Schema$TargetSslProxiesSetProxyHeaderRequest { /** - * The new type of proxy header to append before sending data to the - * backend. NONE or PROXY_V1 are allowed. + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ proxyHeader?: string; } export interface Schema$TargetSslProxiesSetSslCertificatesRequest { /** - * New set of URLs to SslCertificate resources to associate with this - * TargetSslProxy. Currently exactly one ssl certificate must be specified. + * New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. */ sslCertificates?: string[]; } /** - * A TargetSslProxy resource. This resource defines an SSL proxy. (== - * resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies - * ==) + * A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -15512,33 +11811,23 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#targetSslProxy for - * target SSL proxies. + * [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** @@ -15550,15 +11839,11 @@ export namespace compute_alpha { */ service?: string; /** - * URLs to SslCertificate resources that are used to authenticate - * connections to Backends. At least one SSL certificate must be specified. - * Currently, you may specify up to 15 SSL certificates. + * URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** - * URL of SslPolicy resource that will be associated with the TargetSslProxy - * resource. If not set, the TargetSslProxy resource will not have any SSL - * policy configured. + * URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. */ sslPolicy?: string; } @@ -15579,11 +11864,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15607,15 +11888,12 @@ export namespace compute_alpha { } export interface Schema$TargetTcpProxiesSetProxyHeaderRequest { /** - * The new type of proxy header to append before sending data to the - * backend. NONE or PROXY_V1 are allowed. + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ proxyHeader?: string; } /** - * A TargetTcpProxy resource. This resource defines a TCP proxy. (== - * resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies - * ==) + * A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -15623,33 +11901,23 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#targetTcpProxy for - * target TCP proxies. + * [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** @@ -15678,11 +11946,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15699,8 +11963,7 @@ export namespace compute_alpha { }; } /** - * Represents a Target VPN gateway resource. (== resource_for - * beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN gateway resource. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -15708,62 +11971,39 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] A list of URLs to the ForwardingRule resources. - * ForwardingRules are created using compute.forwardingRules.insert and - * associated with a VPN gateway. + * [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. */ forwardingRules?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * A fingerprint for the labels being applied to this TargetVpnGateway, - * which is essentially a hash of the labels set used for optimistic - * locking. The fingerprint is initially generated by Compute Engine and - * changes after every request to modify or update labels. You must always - * provide an up-to-date fingerprint hash in order to update or change - * labels, otherwise the request will fail with error 412 conditionNotMet. - * To see the latest fingerprint, make a get() request to retrieve a - * TargetVpnGateway. + * A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. */ labelFingerprint?: string; /** - * Labels to apply to this TargetVpnGateway resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this TargetVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network to which this VPN gateway is attached. Provided by the - * client when the VPN gateway is created. + * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ network?: string; /** - * [Output Only] URL of the region where the target VPN gateway resides. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -15771,14 +12011,11 @@ export namespace compute_alpha { */ selfLink?: string; /** - * [Output Only] The status of the VPN gateway, which can be one of the - * following: CREATING, READY, FAILED, or DELETING. + * [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. */ status?: string; /** - * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are - * created using the compute.vpntunnels.insert method and associated with a - * VPN gateway. + * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. */ tunnels?: string[]; } @@ -15792,16 +12029,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$TargetVpnGatewaysScopedList}; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15830,16 +12062,11 @@ export namespace compute_alpha { */ items?: Schema$TargetVpnGateway[]; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -15861,8 +12088,7 @@ export namespace compute_alpha { */ targetVpnGateways?: Schema$TargetVpnGateway[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -15872,42 +12098,27 @@ export namespace compute_alpha { } export interface Schema$TCPHealthCheck { /** - * The TCP port number for the health check request. The default value - * is 80. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, TCP health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The application data to send once the TCP connection has been established - * (default value is empty). If both request and response are empty, the - * connection establishment alone will indicate health. The request data can - * only be ASCII. + * The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ request?: string; /** - * The bytes to match against the beginning of the response data. If left - * empty (the default value), any response will indicate health. The - * response data can only be ASCII. + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ response?: string; } @@ -15919,16 +12130,13 @@ export namespace compute_alpha { } export interface Schema$TestPermissionsRequest { /** - * The set of permissions to check for the 'resource'. Permissions - * with wildcards (such as '*' or 'storage.*') are not - * allowed. + * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ permissions?: string[]; } export interface Schema$TestPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -15937,8 +12145,7 @@ export namespace compute_alpha { */ export interface Schema$TlsCertificateContext { /** - * Specifies the certificate and private key paths. This field is applicable - * only if tlsCertificateSource is set to USE_PATH. + * Specifies the certificate and private key paths. This field is applicable only if tlsCertificateSource is set to USE_PATH. */ certificatePaths?: Schema$TlsCertificatePaths; /** @@ -15946,8 +12153,7 @@ export namespace compute_alpha { */ certificateSource?: string; /** - * Specifies the config to retrieve certificates through SDS. This field is - * applicable only if tlsCertificateSource is set to USE_SDS. + * Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. */ sdsConfig?: Schema$SdsConfig; } @@ -15973,25 +12179,20 @@ export namespace compute_alpha { */ certificateContext?: Schema$TlsCertificateContext; /** - * Defines the mechanism to obtain the Certificate Authority certificate to - * validate the client/server certificate. If omitted, the proxy will not - * validate the server or client certificate. + * Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. If omitted, the proxy will not validate the server or client certificate. */ validationContext?: Schema$TlsValidationContext; } /** - * Defines the mechanism to obtain the Certificate Authority certificate to - * validate the client/server certificate. + * Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. */ export interface Schema$TlsValidationContext { /** - * The path to the file holding the CA certificate to validate the client or - * server certificate. + * The path to the file holding the CA certificate to validate the client or server certificate. */ certificatePath?: string; /** - * Specifies the config to retrieve certificates through SDS. This field is - * applicable only if tlsCertificateSource is set to USE_SDS. + * Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. */ sdsConfig?: Schema$SdsConfig; /** @@ -16001,30 +12202,24 @@ export namespace compute_alpha { } export interface Schema$UDPHealthCheck { /** - * The UDP port number for the health check request. Valid values are 1 - * through 65535. + * The UDP port number for the health check request. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Raw data of request to send in payload of UDP packet. It is an error if - * this is empty. The request data can only be ASCII. + * Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. */ request?: string; /** - * The bytes to match against the beginning of the response data. It is an - * error if this is empty. The response data can only be ASCII. + * The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. */ response?: string; } /** - * A UrlMap resource. This resource defines the mapping from URL to the - * BackendService resource, based on the "longest-match" of the - * URL's host and path. + * A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. */ export interface Schema$UrlMap { /** @@ -16032,51 +12227,27 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * defaultRouteAction takes effect when none of the hostRules match. The - * load balancer performs advanced routing actions like URL rewrites, header - * transformations, etc. prior to forwarding the request to the selected - * backend. If defaultRouteAction specifies any weightedBackendServices, - * defaultService must not be set. Conversely if defaultService is set, - * defaultRouteAction cannot contain any weightedBackendServices. Only one - * of defaultRouteAction or defaultUrlRedirect must be set. + * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. */ defaultRouteAction?: Schema$HttpRouteAction; /** - * The full or partial URL of the defaultService resource to which traffic - * is directed if none of the hostRules match. If defaultRouteAction is - * additionally specified, advanced routing actions like URL Rewrites, etc. - * take effect prior to sending the request to the backend. However, if - * defaultService is specified, defaultRouteAction cannot contain any - * weightedBackendServices. Conversely, if routeAction specifies any - * weightedBackendServices, service must not be specified. Only one of - * defaultService, defaultUrlRedirect or - * defaultRouteAction.weightedBackendService must be set. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. */ defaultService?: string; /** - * When none of the specified hostRules match, the request is redirected to - * a URL specified by defaultUrlRedirect. If defaultUrlRedirect is - * specified, defaultService or defaultRouteAction must not be set. + * When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. */ defaultUrlRedirect?: Schema$HttpRedirectAction; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a UrlMap. An up-to-date fingerprint must be - * provided in order to update the UrlMap, otherwise the request will fail - * with error 412 conditionNotMet. To see the latest fingerprint, make a - * get() request to retrieve a UrlMap. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. */ fingerprint?: string; /** - * Specifies changes to request and response headers that need to take - * effect for the selected backendService. The headerAction specified here - * take effect after headerAction specified under pathMatcher. + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. */ headerAction?: Schema$HttpHeaderAction; /** @@ -16084,8 +12255,7 @@ export namespace compute_alpha { */ hostRules?: Schema$HostRule[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -16093,13 +12263,7 @@ export namespace compute_alpha { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -16107,10 +12271,7 @@ export namespace compute_alpha { */ pathMatchers?: Schema$PathMatcher[]; /** - * [Output Only] URL of the region where the regional URL map resides. This - * field is not applicable to global URL maps. You must specify this field - * as part of the HTTP request URL. It is not settable as a field in the - * request body. + * [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -16118,9 +12279,7 @@ export namespace compute_alpha { */ selfLink?: string; /** - * The list of expected URL mapping tests. Request to update this UrlMap - * will succeed only if all of the test cases pass. You can specify a - * maximum of 100 tests per UrlMap. + * The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. */ tests?: Schema$UrlMapTest[]; } @@ -16141,11 +12300,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16178,11 +12333,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16204,8 +12355,7 @@ export namespace compute_alpha { */ urlMaps?: Schema$UrlMap[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -16227,8 +12377,7 @@ export namespace compute_alpha { */ export interface Schema$UrlMapTest { /** - * The weight to use for the supplied host and path when using advanced - * routing rules that involve traffic splitting. + * The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting. */ backendServiceWeight?: number; /** @@ -16236,8 +12385,7 @@ export namespace compute_alpha { */ description?: string; /** - * The expected URL that should be redirected to for the host and path being - * tested. + * The expected URL that should be redirected to for the host and path being tested. */ expectedUrlRedirect?: string; /** @@ -16259,38 +12407,30 @@ export namespace compute_alpha { export interface Schema$UrlMapValidationResult { loadErrors?: string[]; /** - * Whether the given UrlMap can be successfully loaded. If false, - * 'loadErrors' indicates the reasons. + * Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons. */ loadSucceeded?: boolean; testFailures?: Schema$TestFailure[]; /** - * If successfully loaded, this field indicates whether the test passed. If - * false, 'testFailures's indicate the reason of failure. + * If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure. */ testPassed?: boolean; } /** - * The spec for modifying the path before sending the request to the matched - * backend service. + * The spec for modifying the path before sending the request to the matched backend service. */ export interface Schema$UrlRewrite { /** - * Prior to forwarding the request to the selected service, the - * request's host header is replaced with contents of hostRewrite. The - * value must be between 1 and 255 characters. + * Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters. */ hostRewrite?: string; /** - * Prior to forwarding the request to the selected backend service, the - * matching portion of the request's path is replaced by - * pathPrefixRewrite. The value must be between 1 and 1024 characters. + * Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters. */ pathPrefixRewrite?: string; } /** - * Subnetwork which the current user has compute.subnetworks.use permission - * on. + * Subnetwork which the current user has compute.subnetworks.use permission on. */ export interface Schema$UsableSubnetwork { /** @@ -16312,8 +12452,7 @@ export namespace compute_alpha { } export interface Schema$UsableSubnetworksAggregatedList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -16321,17 +12460,11 @@ export namespace compute_alpha { */ items?: Schema$UsableSubnetwork[]; /** - * [Output Only] Type of resource. Always - * compute#usableSubnetworksAggregatedList for aggregated lists of usable - * subnetworks. + * [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16356,33 +12489,20 @@ export namespace compute_alpha { */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. The name must be 1-63 - * characters long, and comply with RFC1035. The name must be unique within - * the subnetwork. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ rangeName?: string; } /** - * The location in Cloud Storage and naming method of the daily usage report. - * Contains bucket_name and report_name prefix. + * The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. */ export interface Schema$UsageExportLocation { /** - * The name of an existing bucket in Cloud Storage where the usage report - * object is stored. The Google Service Account is granted write access to - * this bucket. This can either be the bucket name by itself, such as - * example-bucket, or the bucket name with gs:// or - * https://storage.googleapis.com/ in front of it, such as - * gs://example-bucket. + * The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. */ bucketName?: string; /** - * An optional prefix for the name of the usage report object stored in - * bucketName. If not supplied, defaults to usage. The report is stored as a - * CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the - * day of the usage according to Pacific Time. If you supply a prefix, it - * should conform to Cloud Storage object naming conventions. + * An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. */ reportNamePrefix?: string; } @@ -16401,34 +12521,23 @@ export namespace compute_alpha { */ export interface Schema$VmEndpointNatMappingsInterfaceNatMappings { /** - * List of all drain IP:port-range mappings assigned to this interface. - * These ranges are inclusive, that is, both the first and the last ports - * can be used for NAT. Example: ["2.2.2.2:12345-12355", - * "1.1.1.1:2234-2234"]. + * List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ drainNatIpPortRanges?: string[]; /** - * A list of all IP:port-range mappings assigned to this interface. These - * ranges are inclusive, that is, both the first and the last ports can be - * used for NAT. Example: ["2.2.2.2:12345-12355", - * "1.1.1.1:2234-2234"]. + * A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ natIpPortRanges?: string[]; /** - * Total number of drain ports across all NAT IPs allocated to this - * interface. It equals to the aggregated port number in the field - * drain_nat_ip_port_ranges. + * Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges. */ numTotalDrainNatPorts?: number; /** - * Total number of ports across all NAT IPs allocated to this interface. It - * equals to the aggregated port number in the field nat_ip_port_ranges. + * Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. */ numTotalNatPorts?: number; /** - * Alias IP range for this interface endpoint. It will be a private (RFC - * 1918) IP range. Examples: "10.33.4.55/32", or - * "192.168.5.0/24". + * Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". */ sourceAliasIpRange?: string; /** @@ -16441,21 +12550,15 @@ export namespace compute_alpha { */ export interface Schema$VmEndpointNatMappingsList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList - * for lists of Nat mappings of VM endpoints. + * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16484,49 +12587,31 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#vpnGateway for VPN - * gateways. + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ kind?: string; /** - * A fingerprint for the labels being applied to this VpnGateway, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an VpnGateway. + * A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an VpnGateway. */ labelFingerprint?: string; /** - * Labels to apply to this VpnGateway resource. These can be later modified - * by the setLabels method. Each label key/value must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network to which this VPN gateway is attached. Provided by the - * client when the VPN gateway is created. + * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ network?: string; /** @@ -16552,16 +12637,11 @@ export namespace compute_alpha { */ items?: {[key: string]: Schema$VpnGatewaysScopedList}; /** - * [Output Only] Type of resource. Always compute#vpnGateway for VPN - * gateways. + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16590,16 +12670,11 @@ export namespace compute_alpha { */ items?: Schema$VpnGateway[]; /** - * [Output Only] Type of resource. Always compute#vpnGateway for VPN - * gateways. + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16624,8 +12699,7 @@ export namespace compute_alpha { */ vpnGateways?: Schema$VpnGateway[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -16640,20 +12714,15 @@ export namespace compute_alpha { vpnConnections?: Schema$VpnGatewayStatusVpnConnection[]; } /** - * Describes the high availability requirement state for the VPN connection - * between this Cloud VPN gateway and a peer gateway. + * Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway. */ export interface Schema$VpnGatewayStatusHighAvailabilityRequirementState { /** - * Indicates the high availability requirement state for the VPN connection. - * Valid values are CONNECTION_REDUNDANCY_MET, - * CONNECTION_REDUNDANCY_NOT_MET. + * Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. */ state?: string; /** - * Indicates the reason why the VPN connection does not meet the high - * availability redundancy criteria/requirement. Valid values is - * INCOMPLETE_TUNNELS_COVERAGE. + * Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. */ unsatisfiedReason?: string; } @@ -16666,8 +12735,7 @@ export namespace compute_alpha { */ localGatewayInterface?: number; /** - * The peer gateway interface this VPN tunnel is connected to, the peer - * gateway could either be an external VPN gateway or GCP VPN gateway. + * The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway. */ peerGatewayInterface?: number; /** @@ -16676,21 +12744,15 @@ export namespace compute_alpha { tunnelUrl?: string; } /** - * A VPN connection contains all VPN tunnels connected from this VpnGateway to - * the same peer gateway. The peer gateway could either be a external VPN - * gateway or GCP VPN gateway. + * A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway. */ export interface Schema$VpnGatewayStatusVpnConnection { /** - * URL reference to the peer external VPN gateways to which the VPN tunnels - * in this VPN connection are connected. This field is mutually exclusive - * with peer_gcp_gateway. + * URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ peerExternalGateway?: string; /** - * URL reference to the peer side VPN gateways to which the VPN tunnels in - * this VPN connection are connected. This field is mutually exclusive with - * peer_gcp_gateway. + * URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ peerGcpGateway?: string; /** @@ -16716,8 +12778,7 @@ export namespace compute_alpha { ipAddress?: string; } /** - * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for - * v1.vpnTunnels ==) + * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -16725,8 +12786,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -16734,14 +12794,11 @@ export namespace compute_alpha { */ detailedStatus?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * IKE protocol version to use when establishing the VPN tunnel with the - * peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version - * is 2. + * IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. */ ikeVersion?: number; /** @@ -16749,56 +12806,31 @@ export namespace compute_alpha { */ kind?: string; /** - * A fingerprint for the labels being applied to this VpnTunnel, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a VpnTunnel. + * A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. */ labelFingerprint?: string; /** - * Labels to apply to this VpnTunnel. These can be later modified by the - * setLabels method. Each label key/value pair must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Local traffic selector to use when establishing the VPN tunnel with the - * peer VPN gateway. The value should be a CIDR formatted string, for - * example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is - * supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. */ localTrafficSelector?: string[]; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the peer side external VPN gateway to which this VPN tunnel is - * connected. Provided by the client when the VPN tunnel is created. This - * field is exclusive with the field peerGcpGateway. + * URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. */ peerExternalGateway?: string; /** - * The interface ID of the external VPN gateway to which this VPN tunnel is - * connected. Provided by the client when the VPN tunnel is created. + * The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. */ peerExternalGatewayInterface?: number; /** - * URL of the peer side HA GCP VPN gateway to which this VPN tunnel is - * connected. Provided by the client when the VPN tunnel is created. This - * field can be used when creating highly available VPN from VPC network to - * VPC network, the field is exclusive with the field peerExternalGateway. - * If provided, the VPN tunnel will automatically use the same - * vpnGatewayInterface ID in the peer GCP VPN gateway. + * URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. */ peerGcpGateway?: string; /** @@ -16806,16 +12838,11 @@ export namespace compute_alpha { */ peerIp?: string; /** - * [Output Only] URL of the region where the VPN tunnel resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * Remote traffic selectors to use when establishing the VPN tunnel with the - * peer VPN gateway. The value should be a CIDR formatted string, for - * example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is - * supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. */ remoteTrafficSelector?: string[]; /** @@ -16827,8 +12854,7 @@ export namespace compute_alpha { */ selfLink?: string; /** - * Shared secret used to set the secure session between the Cloud VPN - * gateway and the peer VPN gateway. + * Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. */ sharedSecret?: string; /** @@ -16836,35 +12862,19 @@ export namespace compute_alpha { */ sharedSecretHash?: string; /** - * [Output Only] The status of the VPN tunnel, which can be one of the - * following: - PROVISIONING: Resource is being allocated for the VPN - * tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related - * configs from the user. Network, TargetVpnGateway, VpnTunnel, - * ForwardingRule, and Route resources are needed to setup the VPN tunnel. - * - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - - * ESTABLISHED: Secure session is successfully established with the peer - * VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - - * AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - - * NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are - * being deallocated for the VPN tunnel. - FAILED: Tunnel creation has - * failed and the tunnel is not ready to be used. + * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. */ status?: string; /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. - * Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. */ targetVpnGateway?: string; /** - * URL of the VPN gateway with which this VPN tunnel is associated. Provided - * by the client when the VPN tunnel is created. This must be used (instead - * of target_vpn_gateway) if a High Availability VPN gateway resource is - * created. + * URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. */ vpnGateway?: string; /** - * The interface ID of the VPN gateway with which this VPN tunnel is - * associated. + * The interface ID of the VPN gateway with which this VPN tunnel is associated. */ vpnGatewayInterface?: number; } @@ -16882,11 +12892,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16919,11 +12925,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -16945,8 +12947,7 @@ export namespace compute_alpha { */ vpnTunnels?: Schema$VpnTunnel[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -16956,10 +12957,7 @@ export namespace compute_alpha { } export interface Schema$WafExpressionSet { /** - * A list of alternate IDs. The format should be: - E.g. XSS-stable Generic - * suffix like "stable" is particularly useful if a policy likes - * to avail newer set of expressions without having to change the policy. A - * given alias name can't be used for more than one entity set. + * A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set. */ aliases?: string[]; /** @@ -16967,50 +12965,30 @@ export namespace compute_alpha { */ expressions?: Schema$WafExpressionSetExpression[]; /** - * Google specified expression set ID. The format should be: - E.g. - * XSS-20170329 + * Google specified expression set ID. The format should be: - E.g. XSS-20170329 */ id?: string; } export interface Schema$WafExpressionSetExpression { /** - * Expression ID should uniquely identify the origin of the expression. E.g. - * owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 - * rule id 973337. The ID could be used to determine the individual attack - * definition that has been detected. It could also be used to exclude it - * from the policy in case of false positive. + * Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. */ id?: string; } /** - * In contrast to a single BackendService in HttpRouteAction to which all - * matching traffic is directed to, WeightedBackendService allows traffic to - * be split across multiple BackendServices. The volume of traffic for each - * BackendService is proportional to the weight specified in each - * WeightedBackendService + * In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService */ export interface Schema$WeightedBackendService { /** - * The full or partial URL to the default BackendService resource. Before - * forwarding the request to backendService, the loadbalancer applies any - * relevant headerActions specified as part of this backendServiceWeight. + * The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight. */ backendService?: string; /** - * Specifies changes to request and response headers that need to take - * effect for the selected backendService. headerAction specified here take - * effect before headerAction in the enclosing HttpRouteRule, PathMatcher - * and UrlMap. + * Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. */ headerAction?: Schema$HttpHeaderAction; /** - * Specifies the fraction of traffic sent to backendService, computed as - * weight / (sum of all weightedBackendService weights in routeAction) . The - * selection of a backend service is determined only for new traffic. Once a - * user's request has been directed to a backendService, subsequent - * requests will be sent to the same backendService as determined by the - * BackendService's session affinity policy. The value must be between 0 - * and 1000 + * Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000 */ weight?: number; } @@ -17024,16 +13002,11 @@ export namespace compute_alpha { */ items?: Schema$Project[]; /** - * [Output Only] Type of resource. Always compute#xpnHostList for lists of - * shared VPC hosts. + * [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -17054,9 +13027,7 @@ export namespace compute_alpha { */ export interface Schema$XpnResourceId { /** - * The ID of the service resource. In the case of projects, this field - * supports project id (e.g., my-project-123) and project number (e.g. - * 12345678). + * The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). */ id?: string; /** @@ -17065,8 +13036,7 @@ export namespace compute_alpha { type?: string; } /** - * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones - * ==) Next ID: 17 + * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==) Next ID: 17 */ export interface Schema$Zone { /** @@ -17086,8 +13056,7 @@ export namespace compute_alpha { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -17128,11 +13097,7 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -17150,12 +13115,7 @@ export namespace compute_alpha { } export interface Schema$ZoneSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash in order to update or - * change labels. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** @@ -17165,20 +13125,15 @@ export namespace compute_alpha { } export interface Schema$ZoneSetPolicyRequest { /** - * Flatten Policy to create a backwacd compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -17354,8 +13309,7 @@ export namespace compute_alpha { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified - * project. + * @desc Retrieves a list of accelerator types available to the specified project. * @alias compute.acceleratorTypes.list * @memberOf! () * @@ -17441,46 +13395,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -17516,46 +13443,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -17806,8 +13706,7 @@ export namespace compute_alpha { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project using the data - * included in the request. + * @desc Creates an address resource in the specified project using the data included in the request. * @alias compute.addresses.insert * @memberOf! () * @@ -17883,8 +13782,7 @@ export namespace compute_alpha { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified - * region. + * @desc Retrieves a list of addresses contained within the specified region. * @alias compute.addresses.list * @memberOf! () * @@ -17962,8 +13860,7 @@ export namespace compute_alpha { /** * compute.addresses.setLabels - * @desc Sets the labels on an Address. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. * @alias compute.addresses.setLabels * @memberOf! () * @@ -18129,46 +14026,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -18195,16 +14065,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -18242,16 +14103,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -18267,46 +14119,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -18334,16 +14159,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -18549,8 +14365,7 @@ export namespace compute_alpha { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available - * autoscalers by making a list() request. + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. * @alias compute.autoscalers.get * @memberOf! () * @@ -18625,8 +14440,7 @@ export namespace compute_alpha { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data - * included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. * @alias compute.autoscalers.insert * @memberOf! () * @@ -18703,8 +14517,7 @@ export namespace compute_alpha { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified - * zone. + * @desc Retrieves a list of autoscalers contained within the specified zone. * @alias compute.autoscalers.list * @memberOf! () * @@ -18782,9 +14595,7 @@ export namespace compute_alpha { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.autoscalers.patch * @memberOf! () * @@ -18943,8 +14754,7 @@ export namespace compute_alpha { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data - * included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. * @alias compute.autoscalers.update * @memberOf! () * @@ -19029,46 +14839,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -19092,16 +14875,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -19140,16 +14914,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -19169,46 +14934,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -19236,16 +14974,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -19299,16 +15028,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -19330,8 +15050,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this - * backend bucket. + * @desc Adds a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -19484,8 +15203,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this - * backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -19562,8 +15280,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of - * available backend buckets by making a list() request. + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. * @alias compute.backendBuckets.get * @memberOf! () * @@ -19638,8 +15355,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.backendBuckets.getIamPolicy * @memberOf! () * @@ -19712,8 +15428,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the - * data included in the request. + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. * @alias compute.backendBuckets.insert * @memberOf! () * @@ -19789,8 +15504,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the - * specified project. + * @desc Retrieves the list of BackendBucket resources available to the specified project. * @alias compute.backendBuckets.list * @memberOf! () * @@ -19868,9 +15582,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included - * in the request. This method supports PATCH semantics and uses the JSON - * merge patch format and processing rules. + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.backendBuckets.patch * @memberOf! () * @@ -19947,8 +15659,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.backendBuckets.setIamPolicy * @memberOf! () * @@ -20102,8 +15813,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included - * in the request. + * @desc Updates the specified BackendBucket resource with the data included in the request. * @alias compute.backendBuckets.update * @memberOf! () * @@ -20187,8 +15897,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendBucket resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendBucket?: string; /** @@ -20196,16 +15905,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -20230,16 +15930,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -20251,8 +15942,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendBucket resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendBucket?: string; /** @@ -20264,16 +15954,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -20321,16 +16002,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -20347,46 +16019,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -20410,16 +16055,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -20486,16 +16122,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -20513,8 +16140,7 @@ export namespace compute_alpha { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this - * backend service. + * @desc Adds a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -20591,8 +16217,7 @@ export namespace compute_alpha { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and - * global, available to the specified project. + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. * @alias compute.backendServices.aggregatedList * @memberOf! () * @@ -20755,8 +16380,7 @@ export namespace compute_alpha { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this - * backend service. + * @desc Deletes a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -20833,8 +16457,7 @@ export namespace compute_alpha { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of - * available backend services. + * @desc Returns the specified BackendService resource. Gets a list of available backend services. * @alias compute.backendServices.get * @memberOf! () * @@ -20992,10 +16615,7 @@ export namespace compute_alpha { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using - * the data included in the request. There are several restrictions and - * guidelines to keep in mind when creating a backend service. Read - * Restrictions and Guidelines for more information. + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. * @alias compute.backendServices.insert * @memberOf! () * @@ -21071,8 +16691,7 @@ export namespace compute_alpha { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the - * specified project. + * @desc Retrieves the list of BackendService resources available to the specified project. * @alias compute.backendServices.list * @memberOf! () * @@ -21150,11 +16769,7 @@ export namespace compute_alpha { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data - * included in the request. There are several restrictions and guidelines to - * keep in mind when updating a backend service. Read Restrictions and - * Guidelines for more information. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.backendServices.patch * @memberOf! () * @@ -21388,10 +17003,7 @@ export namespace compute_alpha { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data - * included in the request. There are several restrictions and guidelines to - * keep in mind when updating a backend service. Read Restrictions and - * Guidelines for more information. + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @alias compute.backendServices.update * @memberOf! () * @@ -21475,8 +17087,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendService?: string; /** @@ -21484,16 +17095,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -21510,46 +17112,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -21573,16 +17148,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -21594,8 +17160,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendService?: string; /** @@ -21607,16 +17172,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -21644,8 +17200,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the queried instance - * belongs. + * Name of the BackendService resource to which the queried instance belongs. */ backendService?: string; /** @@ -21670,16 +17225,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -21696,46 +17242,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -21759,16 +17278,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -21785,8 +17295,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the security policy should - * be set. The name should conform to RFC1035. + * Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. */ backendService?: string; /** @@ -21794,16 +17303,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -21849,16 +17349,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -21876,9 +17367,7 @@ export namespace compute_alpha { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one - * policy which will be applied to this disk for scheduling snapshot - * creation. + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -22114,10 +17603,7 @@ export namespace compute_alpha { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its - * data permanently and is irreversible. However, deleting a disk does not - * delete any snapshots previously made from the disk. You must separately - * delete snapshots. + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.disks.delete * @memberOf! () * @@ -22193,8 +17679,7 @@ export namespace compute_alpha { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available - * persistent disks by making a list() request. + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. * @alias compute.disks.get * @memberOf! () * @@ -22267,8 +17752,7 @@ export namespace compute_alpha { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -22342,11 +17826,7 @@ export namespace compute_alpha { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data - * in the request. You can create a disk with a sourceImage, a - * sourceSnapshot, or create an empty 500 GB data disk by omitting all - * properties. You can also create a disk that is larger than the default - * size by specifying the sizeGb property. + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. * @alias compute.disks.insert * @memberOf! () * @@ -22422,8 +17902,7 @@ export namespace compute_alpha { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified - * zone. + * @desc Retrieves a list of persistent disks contained within the specified zone. * @alias compute.disks.list * @memberOf! () * @@ -22578,8 +18057,7 @@ export namespace compute_alpha { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the - * size of the disk. + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. * @alias compute.disks.resize * @memberOf! () * @@ -22656,8 +18134,7 @@ export namespace compute_alpha { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -22732,8 +18209,7 @@ export namespace compute_alpha { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. * @alias compute.disks.setLabels * @memberOf! () * @@ -22906,16 +18382,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -22936,46 +18403,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23003,16 +18443,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -23040,16 +18471,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -23107,16 +18529,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -23140,46 +18553,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23207,16 +18593,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -23244,16 +18621,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -23302,16 +18670,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -23443,8 +18802,7 @@ export namespace compute_alpha { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk - * types by making a list() request. + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. * @alias compute.diskTypes.get * @memberOf! () * @@ -23602,46 +18960,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23675,46 +19006,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23811,8 +19115,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available - * externalVpnGateways by making a list() request. + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -23887,8 +19190,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the - * data included in the request. + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -23964,8 +19266,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified - * project. + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -24045,8 +19346,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -24217,16 +19517,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -24258,16 +19549,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24284,46 +19566,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -24529,8 +19784,7 @@ export namespace compute_alpha { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data - * included in the request. + * @desc Creates a firewall rule in the specified project using the data included in the request. * @alias compute.firewalls.insert * @memberOf! () * @@ -24604,8 +19858,7 @@ export namespace compute_alpha { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified - * project. + * @desc Retrieves the list of firewall rules available to the specified project. * @alias compute.firewalls.list * @memberOf! () * @@ -24681,9 +19934,7 @@ export namespace compute_alpha { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.firewalls.patch * @memberOf! () * @@ -24839,9 +20090,7 @@ export namespace compute_alpha { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the - * request. The PUT method can only update the following fields of firewall - * rule: allowed, description, sourceRanges, sourceTags, targetTags. + * @desc Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags. * @alias compute.firewalls.update * @memberOf! () * @@ -24931,16 +20180,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -24970,16 +20210,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24995,46 +20226,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -25057,16 +20261,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -25111,16 +20306,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -25378,8 +20564,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and - * region using the data included in the request. + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. * @alias compute.forwardingRules.insert * @memberOf! () * @@ -25456,8 +20641,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the - * specified project and region. + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. * @alias compute.forwardingRules.list * @memberOf! () * @@ -25536,10 +20720,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. Currently, you can only patch the - * network_tier field. + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.forwardingRules.patch * @memberOf! () * @@ -25617,8 +20798,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @alias compute.forwardingRules.setLabels * @memberOf! () * @@ -25696,8 +20876,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of - * the same type as the old target. + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. * @alias compute.forwardingRules.setTarget * @memberOf! () * @@ -25863,46 +21042,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -25930,16 +21082,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -25979,16 +21122,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -26005,46 +21139,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -26076,16 +21183,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -26110,16 +21208,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -26152,16 +21241,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -26280,8 +21360,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available - * addresses by making a list() request. + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. * @alias compute.globalAddresses.get * @memberOf! () * @@ -26354,8 +21433,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project using the data - * included in the request. + * @desc Creates an address resource in the specified project using the data included in the request. * @alias compute.globalAddresses.insert * @memberOf! () * @@ -26507,8 +21585,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.setLabels - * @desc Sets the labels on a GlobalAddress. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. * @alias compute.globalAddresses.setLabels * @memberOf! () * @@ -26679,16 +21756,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -26720,16 +21788,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -26746,46 +21805,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -26920,8 +21952,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of - * available forwarding rules by making a list() request. + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. * @alias compute.globalForwardingRules.get * @memberOf! () * @@ -26996,8 +22027,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project - * using the data included in the request. + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. * @alias compute.globalForwardingRules.insert * @memberOf! () * @@ -27073,8 +22103,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the - * specified project. + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. * @alias compute.globalForwardingRules.list * @memberOf! () * @@ -27152,10 +22181,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. Currently, you can only patch the - * network_tier field. + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.globalForwardingRules.patch * @memberOf! () * @@ -27232,8 +22258,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @alias compute.globalForwardingRules.setLabels * @memberOf! () * @@ -27309,8 +22334,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new - * target should be of the same type as the old target. + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. * @alias compute.globalForwardingRules.setTarget * @memberOf! () * @@ -27482,16 +22506,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -27523,16 +22538,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -27549,46 +22555,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -27612,16 +22591,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -27667,16 +22637,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -27794,8 +22755,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.delete - * @desc Deletes the specified network endpoint group.Note that the NEG - * cannot be deleted if there are backend services referencing it. + * @desc Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. * @alias compute.globalNetworkEndpointGroups.delete * @memberOf! () * @@ -27871,8 +22831,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.detachNetworkEndpoints - * @desc Detach the network endpoint from the specified network endpoint - * group. + * @desc Detach the network endpoint from the specified network endpoint group. * @alias compute.globalNetworkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -27951,8 +22910,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of - * available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.globalNetworkEndpointGroups.get * @memberOf! () * @@ -28029,8 +22987,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the - * parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.globalNetworkEndpointGroups.insert * @memberOf! () * @@ -28106,8 +23063,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in - * the specified project. + * @desc Retrieves the list of network endpoint groups that are located in the specified project. * @alias compute.globalNetworkEndpointGroups.list * @memberOf! () * @@ -28187,8 +23143,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint - * group. + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.globalNetworkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -28297,8 +23252,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are attaching network - * endpoints to. It should comply with RFC1035. + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -28306,16 +23260,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -28332,8 +23277,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group to delete. It should comply with - * RFC1035. + * The name of the network endpoint group to delete. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -28341,16 +23285,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -28362,8 +23297,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are removing network - * endpoints. It should comply with RFC1035. + * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -28371,16 +23305,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -28417,16 +23342,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -28443,46 +23359,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -28498,51 +23387,23 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * The name of the network endpoint group from which you want to generate a - * list of included network endpoints. It should comply with RFC1035. + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -28714,8 +23575,7 @@ export namespace compute_alpha { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of - * operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @alias compute.globalOperations.get * @memberOf! () * @@ -28790,8 +23650,7 @@ export namespace compute_alpha { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified project. + * @desc Retrieves a list of Operation resources contained within the specified project. * @alias compute.globalOperations.list * @memberOf! () * @@ -28868,15 +23727,7 @@ export namespace compute_alpha { /** * compute.globalOperations.wait - * @desc Waits for the specified Operations resource until it is done or - * timeout, and retrieves the specified Operations resource. 1. Immediately - * returns when the operation is already done. 2. Waits for no more than the - * default deadline (2 minutes, subject to change) and then returns the - * current state of the operation, which may be DONE or still in - * progress. 3. Is best-effort: a. The server can wait less than the default - * deadline or zero seconds, in overload situations. b. There is no - * guarantee that the operation is actually done when returns. 4. User - * should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.globalOperations.wait * @memberOf! () * @@ -28958,46 +23809,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -29045,46 +23869,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -29190,8 +23987,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of - * operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @alias compute.globalOrganizationOperations.get * @memberOf! () * @@ -29266,8 +24062,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified organization. + * @desc Retrieves a list of Operation resources contained within the specified organization. * @alias compute.globalOrganizationOperations.list * @memberOf! () * @@ -29344,15 +24139,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.wait - * @desc Waits for the specified Operations resource until it is done or - * timeout, and retrieves the specified Operations resource. 1. Immediately - * returns when the operation is already done. 2. Waits for no more than the - * default deadline (2 minutes, subject to change) and then returns the - * current state of the operation, which may be DONE or still in - * progress. 3. Is best-effort: a. The server can wait less than the default - * deadline or zero seconds, in overload situations. b. There is no - * guarantee that the operation is actually done when returns. 4. User - * should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.globalOrganizationOperations.wait * @memberOf! () * @@ -29466,46 +24253,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -29538,8 +24298,7 @@ export namespace compute_alpha { /** * compute.healthChecks.aggregatedList - * @desc Retrieves the list of all HealthCheck resources, regional and - * global, available to the specified project. + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. * @alias compute.healthChecks.aggregatedList * @memberOf! () * @@ -29700,8 +24459,7 @@ export namespace compute_alpha { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of - * available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @alias compute.healthChecks.get * @memberOf! () * @@ -29775,8 +24533,7 @@ export namespace compute_alpha { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.healthChecks.insert * @memberOf! () * @@ -29851,8 +24608,7 @@ export namespace compute_alpha { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @alias compute.healthChecks.list * @memberOf! () * @@ -29929,9 +24685,7 @@ export namespace compute_alpha { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.healthChecks.patch * @memberOf! () * @@ -30088,8 +24842,7 @@ export namespace compute_alpha { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.healthChecks.update * @memberOf! () * @@ -30173,46 +24926,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -30236,16 +24962,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -30276,16 +24993,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -30302,46 +25010,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -30365,16 +25046,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -30420,16 +25092,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -30523,8 +25186,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of - * available HTTP health checks by making a list() request. + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. * @alias compute.httpHealthChecks.get * @memberOf! () * @@ -30599,8 +25261,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using - * the data included in the request. + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpHealthChecks.insert * @memberOf! () * @@ -30676,8 +25337,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. * @alias compute.httpHealthChecks.list * @memberOf! () * @@ -30755,9 +25415,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using - * the data included in the request. This method supports PATCH semantics - * and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.httpHealthChecks.patch * @memberOf! () * @@ -30914,8 +25572,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using - * the data included in the request. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpHealthChecks.update * @memberOf! () * @@ -31007,16 +25664,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -31048,16 +25696,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31074,46 +25713,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -31137,16 +25749,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31192,16 +25795,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31295,8 +25889,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of - * available HTTPS health checks by making a list() request. + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. * @alias compute.httpsHealthChecks.get * @memberOf! () * @@ -31371,8 +25964,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using - * the data included in the request. + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpsHealthChecks.insert * @memberOf! () * @@ -31448,8 +26040,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. * @alias compute.httpsHealthChecks.list * @memberOf! () * @@ -31529,9 +26120,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using - * the data included in the request. This method supports PATCH semantics - * and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.httpsHealthChecks.patch * @memberOf! () * @@ -31688,8 +26277,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using - * the data included in the request. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpsHealthChecks.update * @memberOf! () * @@ -31781,16 +26369,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -31822,16 +26401,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31848,46 +26418,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -31911,16 +26454,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31966,16 +26500,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -32068,8 +26593,7 @@ export namespace compute_alpha { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body - * is given, clears the deprecation status instead. + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. * @alias compute.images.deprecate * @memberOf! () * @@ -32145,8 +26669,7 @@ export namespace compute_alpha { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by - * making a list() request. + * @desc Returns the specified image. Gets a list of available images by making a list() request. * @alias compute.images.get * @memberOf! () * @@ -32218,8 +26741,7 @@ export namespace compute_alpha { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not - * deprecated. + * @desc Returns the latest image that is part of an image family and is not deprecated. * @alias compute.images.getFromFamily * @memberOf! () * @@ -32292,8 +26814,7 @@ export namespace compute_alpha { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.images.getIamPolicy * @memberOf! () * @@ -32366,8 +26887,7 @@ export namespace compute_alpha { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included - * in the request. + * @desc Creates an image in the specified project using the data included in the request. * @alias compute.images.insert * @memberOf! () * @@ -32442,12 +26962,7 @@ export namespace compute_alpha { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified - * project. Custom images are images you create that belong to your project. - * This method does not get any images that belong to other projects, - * including publicly-available images, like Debian 8. If you want to get a - * list of publicly-available images, use this method to make a request to - * the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.images.list * @memberOf! () * @@ -32523,8 +27038,7 @@ export namespace compute_alpha { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.images.setIamPolicy * @memberOf! () * @@ -32598,8 +27112,7 @@ export namespace compute_alpha { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. * @alias compute.images.setLabels * @memberOf! () * @@ -32768,16 +27281,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -32796,16 +27300,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -32876,16 +27371,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -32901,46 +27387,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -33019,19 +27478,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed - * instance group. Abandoning an instance does not delete the instance, but - * it does remove the instance from any target pools that are applied by the - * managed instance group. This method reduces the targetSize of the managed - * instance group by the number of instances that you abandon. This - * operation is marked as DONE when the action is scheduled even if the - * instances have not yet been removed from the group. You must separately - * verify the status of the abandoning action with the listmanagedinstances - * method. If the group is part of a backend service that has enabled - * connection draining, it can take up to 60 seconds after the connection - * draining duration has elapsed before the VM instance is removed or - * deleted. You can specify a maximum of 1000 instances with this method - * per request. + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.instanceGroupManagers.abandonInstances * @memberOf! () * @@ -33109,8 +27556,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by - * zone. + * @desc Retrieves the list of managed instance groups and groups them by zone. * @alias compute.instanceGroupManagers.aggregatedList * @memberOf! () * @@ -33197,8 +27643,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.applyUpdatesToInstances - * @desc Apply changes to selected instances on the managed instance group. - * This method can be used to apply new overrides and/or new versions. + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. * @alias compute.instanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -33277,12 +27722,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.createInstances - * @desc Creates instances with per-instance configs in this managed - * instance group. Instances are created using the current instance - * template. The create instances operation is marked DONE if the - * createInstances request is successful. The underlying actions take - * additional time. You must separately verify the status of the creating or - * actions with the listmanagedinstances method. + * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @alias compute.instanceGroupManagers.createInstances * @memberOf! () * @@ -33360,9 +27800,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the - * instances in that group. Note that the instance group must not belong to - * a backend service. Read Deleting an instance group for more information. + * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @alias compute.instanceGroupManagers.delete * @memberOf! () * @@ -33439,17 +27877,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group for - * immediate deletion. The instances are also removed from any target pools - * of which they were a member. This method reduces the targetSize of the - * managed instance group by the number of instances that you delete. This - * operation is marked as DONE when the action is scheduled even if the - * instances are still being deleted. You must separately verify the status - * of the deleting action with the listmanagedinstances method. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. You can specify a - * maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.instanceGroupManagers.deleteInstances * @memberOf! () * @@ -33527,8 +27955,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.deletePerInstanceConfigs - * @desc Deletes selected per-instance configs for the managed instance - * group. + * @desc Deletes selected per-instance configs for the managed instance group. * @alias compute.instanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -33607,9 +28034,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance - * group. Gets a list of available managed instance groups by making a - * list() request. + * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. * @alias compute.instanceGroupManagers.get * @memberOf! () * @@ -33687,14 +28112,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, instances in the - * group are created using the specified instance template. This operation - * is marked as DONE when the group is created even if the instances in the - * group have not yet been created. You must separately verify the status of - * the individual instances with the listmanagedinstances method. A managed - * instance group can have up to 1000 VM instances per group. Please contact - * Cloud Support if you need an increase in this limit. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. * @alias compute.instanceGroupManagers.insert * @memberOf! () * @@ -33771,8 +28189,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained - * within the specified project and zone. + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. * @alias compute.instanceGroupManagers.list * @memberOf! () * @@ -33853,12 +28270,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each - * instance in the list has a currentAction, which indicates the action that - * the managed instance group is performing on the instance. For example, if - * the group is still creating an instance, the currentAction is CREATING. - * If a previous action failed, the list displays the errors for that failed - * action. + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. * @alias compute.instanceGroupManagers.listManagedInstances * @memberOf! () * @@ -33962,8 +28374,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listPerInstanceConfigs - * @desc Lists all of the per-instance configs defined for the managed - * instance group. + * @desc Lists all of the per-instance configs defined for the managed instance group. * @alias compute.instanceGroupManagers.listPerInstanceConfigs * @memberOf! () * @@ -34067,13 +28478,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is patched even if the instances in the group are still in the process of - * being patched. You must separately verify the status of the individual - * instances with the listManagedInstances method. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instanceGroupManagers.patch * @memberOf! () * @@ -34151,9 +28556,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.patchPerInstanceConfigs - * @desc Insert or patch (for the ones that already exist) per-instance - * configs for the managed instance group. perInstanceConfig.instance serves - * as a key used to distinguish whether to perform insert or patch. + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.instanceGroupManagers.patchPerInstanceConfigs * @memberOf! () * @@ -34233,16 +28636,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately recreated. The instances are deleted and recreated using the - * current instance template for the managed instance group. This operation - * is marked as DONE when the flag is set even if the instances have not yet - * been recreated. You must separately verify the status of the recreating - * action with the listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. You can specify a maximum of 1000 - * instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.instanceGroupManagers.recreateInstances * @memberOf! () * @@ -34320,21 +28714,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the - * group creates new instances using the current instance template. If you - * decrease the size, the group deletes instances. The resize operation is - * marked DONE when the resize actions are scheduled even if the group has - * not yet added or deleted any instances. You must separately verify the - * status of the creating or deleting actions with the listmanagedinstances - * method. When resizing down, the instance group arbitrarily chooses the - * order in which VMs are deleted. The group takes into account some VM - * attributes when making the selection including: + The status of the VM - * instance. + The health of the VM instance. + The instance template - * version the VM is based on. + For regional managed instance groups, the - * location of the VM instance. This list is subject to change. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @alias compute.instanceGroupManagers.resize * @memberOf! () * @@ -34412,18 +28792,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.resizeAdvanced - * @desc Resizes the managed instance group with advanced configuration - * options like disabling creation retries. This is an extended version of - * the resize method. If you increase the size of the instance group, the - * group creates new instances using the current instance template. If you - * decrease the size, the group deletes instances. The resize operation is - * marked DONE when the resize actions are scheduled even if the group has - * not yet added or deleted any instances. You must separately verify the - * status of the creating, creatingWithoutRetries, or deleting actions with - * the get or listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. + * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @alias compute.instanceGroupManagers.resizeAdvanced * @memberOf! () * @@ -34501,8 +28870,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policies. [Deprecated] This method is - * deprecated. Please use Patch instead. + * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. * @alias compute.instanceGroupManagers.setAutoHealingPolicies * @memberOf! () * @@ -34582,9 +28950,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances - * in this group. The templates for existing instances in the group do not - * change unless you recreate them. + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. * @alias compute.instanceGroupManagers.setInstanceTemplate * @memberOf! () * @@ -34662,12 +29028,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed - * instance group are assigned. The target pools automatically apply to all - * of the instances in the managed instance group. This operation is marked - * DONE when you make the request even if the instances have not yet been - * added to their target pools. The change might take some time to apply to - * all of the instances in the group depending on the size of the group. + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. * @alias compute.instanceGroupManagers.setTargetPools * @memberOf! () * @@ -34826,11 +29187,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.update - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is updated even if the instances in the group have not yet been updated. - * You must separately verify the status of the individual instances with - * the listManagedInstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. * @alias compute.instanceGroupManagers.update * @memberOf! () * @@ -34908,9 +29265,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.updatePerInstanceConfigs - * @desc Insert or update (for the ones that already exist) per-instance - * configs for the managed instance group. perInstanceConfig.instance serves - * as a key used to distinguish whether to perform insert or patch. + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.instanceGroupManagers.updatePerInstanceConfigs * @memberOf! () * @@ -35005,16 +29360,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35035,46 +29381,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -35098,8 +29417,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the zone where the managed instance group is located. Should - * conform to RFC1035. + * The name of the zone where the managed instance group is located. Should conform to RFC1035. */ zone?: string; @@ -35124,20 +29442,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the managed instance group is located. It - * should conform to RFC1035. + * The name of the zone where the managed instance group is located. It should conform to RFC1035. */ zone?: string; @@ -35162,16 +29471,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35195,16 +29495,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35233,8 +29524,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the zone where the managed instance group is located. It - * should conform to RFC1035. + * The name of the zone where the managed instance group is located. It should conform to RFC1035. */ zone?: string; @@ -35275,16 +29565,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35305,46 +29586,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -35364,22 +29618,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -35387,27 +29626,15 @@ export namespace compute_alpha { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -35427,22 +29654,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -35450,27 +29662,15 @@ export namespace compute_alpha { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -35478,8 +29678,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the zone where the managed instance group is located. It - * should conform to RFC1035. + * The name of the zone where the managed instance group is located. It should conform to RFC1035. */ zone?: string; } @@ -35499,16 +29698,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35537,21 +29727,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the managed instance group is located. It - * should conform to RFC1035. + * The name of the zone where the managed instance group is located. It should conform to RFC1035. */ zone?: string; @@ -35576,16 +29756,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35614,23 +29785,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The number of running instances that the managed instance group should - * maintain at any given time. The group automatically adds or removes - * instances to maintain the number of instances specified by this - * parameter. + * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. */ size?: number; /** @@ -35654,16 +29813,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35692,16 +29842,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35730,16 +29871,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35768,16 +29900,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35831,16 +29954,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -35869,21 +29983,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the managed instance group is located. It - * should conform to RFC1035. + * The name of the zone where the managed instance group is located. It should conform to RFC1035. */ zone?: string; @@ -35901,9 +30005,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of - * the instances in the instance group must be in the same - * network/subnetwork. Read Adding instances for more information. + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. * @alias compute.instanceGroups.addInstances * @memberOf! () * @@ -36066,9 +30168,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group - * are not deleted. Note that instance group must not belong to a backend - * service. Read Deleting an instance group for more information. + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. * @alias compute.instanceGroups.delete * @memberOf! () * @@ -36145,8 +30245,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available - * instance groups by making a list() request. + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. * @alias compute.instanceGroups.get * @memberOf! () * @@ -36222,8 +30321,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the - * parameters that are included in the request. + * @desc Creates an instance group in the specified project using the parameters that are included in the request. * @alias compute.instanceGroups.insert * @memberOf! () * @@ -36300,8 +30398,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the - * specified project and zone. + * @desc Retrieves the list of instance groups that are located in the specified project and zone. * @alias compute.instanceGroups.list * @memberOf! () * @@ -36468,11 +30565,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, - * but does not delete those instances. If the group is part of a backend - * service that has enabled connection draining, it can take up to 60 - * seconds after the connection draining duration before the VM instance is - * removed or deleted. + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. * @alias compute.instanceGroups.removeInstances * @memberOf! () * @@ -36724,16 +30817,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36754,46 +30838,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -36817,16 +30874,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36866,16 +30914,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36896,46 +30935,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -36955,51 +30967,23 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The name of the instance group from which you want to generate a list of - * included instances. + * The name of the instance group from which you want to generate a list of included instances. */ instanceGroup?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -37024,8 +31008,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the instance group where the specified instances will be - * removed. + * The name of the instance group where the specified instances will be removed. */ instanceGroup?: string; /** @@ -37033,16 +31016,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37071,16 +31045,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37206,9 +31171,7 @@ export namespace compute_alpha { /** * compute.instances.addResourcePolicies - * @desc Adds existing resource policies to an instance. You can only add - * one policy right now which will be applied to this instance for - * scheduling live migrations. + * @desc Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. * @alias compute.instances.addResourcePolicies * @memberOf! () * @@ -37286,8 +31249,7 @@ export namespace compute_alpha { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project - * across all regions and zones. + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. * @alias compute.instances.aggregatedList * @memberOf! () * @@ -37368,10 +31330,7 @@ export namespace compute_alpha { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first - * create the disk before you can attach it. It is not possible to create - * and attach a disk at the same time. For more information, read Adding a - * persistent disk to your instance. + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @alias compute.instances.attachDisk * @memberOf! () * @@ -37450,8 +31409,7 @@ export namespace compute_alpha { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see - * Stopping or Deleting an Instance. + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. * @alias compute.instances.delete * @memberOf! () * @@ -37690,8 +31648,7 @@ export namespace compute_alpha { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available - * instances by making a list() request. + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. * @alias compute.instances.get * @memberOf! () * @@ -37764,8 +31721,7 @@ export namespace compute_alpha { /** * compute.instances.getEffectiveFirewalls - * @desc Returns effective firewalls applied to an interface of the - * instance. + * @desc Returns effective firewalls applied to an interface of the instance. * @alias compute.instances.getEffectiveFirewalls * @memberOf! () * @@ -37939,8 +31895,7 @@ export namespace compute_alpha { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -38014,8 +31969,7 @@ export namespace compute_alpha { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified - * instance. + * @desc Returns the last 1 MB of serial port output from the specified instance. * @alias compute.instances.getSerialPortOutput * @memberOf! () * @@ -38253,8 +32207,7 @@ export namespace compute_alpha { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the - * data included in the request. + * @desc Creates an instance resource in the specified project using the data included in the request. * @alias compute.instances.insert * @memberOf! () * @@ -38332,8 +32285,7 @@ export namespace compute_alpha { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified - * zone. + * @desc Retrieves the list of instances contained within the specified zone. * @alias compute.instances.list * @memberOf! () * @@ -38411,9 +32363,7 @@ export namespace compute_alpha { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the - * specified zone. For more information, read Viewing Referrers to VM - * Instances. + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. * @alias compute.instances.listReferrers * @memberOf! () * @@ -38577,9 +32527,7 @@ export namespace compute_alpha { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does - * not do a graceful shutdown. For more information, see Resetting an - * instance. + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. * @alias compute.instances.reset * @memberOf! () * @@ -38655,8 +32603,7 @@ export namespace compute_alpha { /** * compute.instances.resume - * @desc Resumes an instance that was suspended using the - * instances().suspend method. + * @desc Resumes an instance that was suspended using the instances().suspend method. * @alias compute.instances.resume * @memberOf! () * @@ -38898,8 +32845,7 @@ export namespace compute_alpha { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -38974,8 +32920,7 @@ export namespace compute_alpha { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. * @alias compute.instances.setLabels * @memberOf! () * @@ -39053,8 +32998,7 @@ export namespace compute_alpha { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped - * instance to the values specified in the request. + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. * @alias compute.instances.setMachineResources * @memberOf! () * @@ -39132,8 +33076,7 @@ export namespace compute_alpha { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type - * specified in the request. + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. * @alias compute.instances.setMachineType * @memberOf! () * @@ -39211,8 +33154,7 @@ export namespace compute_alpha { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in - * the request. + * @desc Sets metadata for the specified instance to the data included in the request. * @alias compute.instances.setMetadata * @memberOf! () * @@ -39290,9 +33232,7 @@ export namespace compute_alpha { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. - * This method can only be called on a stopped instance. For more - * information, read Specifying a Minimum CPU Platform. + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. * @alias compute.instances.setMinCpuPlatform * @memberOf! () * @@ -39448,8 +33388,7 @@ export namespace compute_alpha { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, - * read Changing the service account and access scopes for an instance. + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. * @alias compute.instances.setServiceAccount * @memberOf! () * @@ -39527,10 +33466,7 @@ export namespace compute_alpha { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You - * can only use this method on a running instance. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -39610,9 +33546,7 @@ export namespace compute_alpha { /** * compute.instances.setShieldedVmIntegrityPolicy - * @desc Sets the Shielded VM integrity policy for a VM instance. You can - * only use this method on a running VM instance. This method supports PATCH - * semantics and uses the JSON merge patch format and processing rules. + * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedVmIntegrityPolicy * @memberOf! () * @@ -39692,8 +33626,7 @@ export namespace compute_alpha { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included - * in the request. + * @desc Sets network tags for the specified instance to the data included in the request. * @alias compute.instances.setTags * @memberOf! () * @@ -39849,8 +33782,7 @@ export namespace compute_alpha { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop - * method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @alias compute.instances.start * @memberOf! () * @@ -39926,8 +33858,7 @@ export namespace compute_alpha { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop - * method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @alias compute.instances.startWithEncryptionKey * @memberOf! () * @@ -40007,12 +33938,7 @@ export namespace compute_alpha { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you - * to restart the instance at a later time. Stopped instances do not incur - * VM usage charges while they are stopped. However, resources that the VM - * is using, such as persistent disks and static IP addresses, will continue - * to be charged until they are deleted. For more information, see Stopping - * an instance. + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. * @alias compute.instances.stop * @memberOf! () * @@ -40089,12 +34015,7 @@ export namespace compute_alpha { /** * compute.instances.suspend - * @desc This method suspends a running instance, saving its state to - * persistent storage, and allows you to resume the instance at a later - * time. Suspended instances incur reduced per-minute, virtual machine usage - * charges while they are suspended. Any resources the virtual machine is - * using, such as persistent disks and static IP addresses, will continue to - * be charged until they are deleted. + * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. * @alias compute.instances.suspend * @memberOf! () * @@ -40253,10 +34174,7 @@ export namespace compute_alpha { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network - * interface with the data included in the request. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateAccessConfig * @memberOf! () * @@ -40335,9 +34253,7 @@ export namespace compute_alpha { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this - * method on a stopped VM instance. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -40415,8 +34331,7 @@ export namespace compute_alpha { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH - * semantics. + * @desc Updates an instance's network interface. This method follows PATCH semantics. * @alias compute.instances.updateNetworkInterface * @memberOf! () * @@ -40497,9 +34412,7 @@ export namespace compute_alpha { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only - * use this method on a stopped instance. This method supports PATCH - * semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -40579,9 +34492,7 @@ export namespace compute_alpha { /** * compute.instances.updateShieldedVmConfig - * @desc Updates the Shielded VM config for a VM instance. You can only use - * this method on a stopped VM instance. This method supports PATCH - * semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedVmConfig * @memberOf! () * @@ -40680,16 +34591,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -40718,16 +34620,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -40748,46 +34641,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -40803,8 +34669,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to force attach the disk even if it's currently attached to - * another instance. + * Whether to force attach the disk even if it's currently attached to another instance. */ forceAttach?: boolean; /** @@ -40816,16 +34681,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -40853,16 +34709,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -40894,16 +34741,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -40919,8 +34757,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The device name of the disk to detach. Make a get() request on the - * instance to view currently attached disks and device names. + * The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. */ deviceName?: string; /** @@ -40932,16 +34769,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41060,11 +34888,7 @@ export namespace compute_alpha { */ project?: string; /** - * Returns output starting from a specific byte position. Use this to page - * through output when the output is too large to return in a single - * request. For the initial request, leave this field unspecified. For - * subsequent calls, this field should be set to the next value returned in - * the previous call. + * Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call. */ start?: string; /** @@ -41123,34 +34947,15 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Specifies instance template to create the instance. This field is - * optional. It can be a full or partial URL. For example, the following are - * all valid URLs to an instance template: - - * https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - * - projects/project/global/instanceTemplates/instanceTemplate - - * global/instanceTemplates/instanceTemplate + * Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate */ sourceInstanceTemplate?: string; /** - * Specifies instance machine to create the instance. This field is - * optional. It can be a full or partial URL. For example, the following are - * all valid URLs to an instance template: - - * https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage - * - projects/project/global/global/machineImages/machineImage - - * global/machineImages/machineImage + * Specifies instance machine to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage */ sourceMachineImage?: string; /** @@ -41170,46 +34975,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -41229,51 +35007,23 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * Name of the target instance scoping this request, or '-' if the request - * should span over all instances in the container. + * Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. */ instance?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -41301,16 +35051,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41338,16 +35079,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41370,16 +35102,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41408,16 +35131,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41441,8 +35155,7 @@ export namespace compute_alpha { */ autoDelete?: boolean; /** - * The device name of the disk to modify. Make a get() request on the - * instance to view currently attached disks and device names. + * The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. */ deviceName?: string; /** @@ -41454,16 +35167,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41512,16 +35216,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41550,16 +35245,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41588,16 +35274,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41626,16 +35303,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41664,16 +35332,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41702,16 +35361,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41740,16 +35390,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41778,16 +35419,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41816,16 +35448,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41854,16 +35477,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41911,16 +35525,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41944,16 +35549,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -41973,8 +35569,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true, discard the contents of any attached localSSD partitions. - * Default value is false (== preserve localSSD data). + * If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). */ discardLocalSsd?: boolean; /** @@ -41986,16 +35581,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -42011,8 +35597,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true, discard the contents of any attached localSSD partitions. - * Default value is false (== preserve localSSD data). + * If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). */ discardLocalSsd?: boolean; /** @@ -42024,16 +35609,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -42086,16 +35662,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -42124,16 +35691,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -42166,16 +35724,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -42204,16 +35753,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -42242,16 +35782,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -42273,9 +35804,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance - * template is permanent and cannot be undone. It is not possible to delete - * templates that are already in use by a managed instance group. + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. * @alias compute.instanceTemplates.delete * @memberOf! () * @@ -42351,8 +35880,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available - * instance templates by making a list() request. + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. * @alias compute.instanceTemplates.get * @memberOf! () * @@ -42427,8 +35955,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -42501,11 +36028,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the - * data that is included in the request. If you are creating a new template - * to update an existing instance group, your new instance template must use - * the same network or, if applicable, the same subnetwork as the original - * template. + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. * @alias compute.instanceTemplates.insert * @memberOf! () * @@ -42581,8 +36104,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within - * the specified project. + * @desc Retrieves a list of instance templates that are contained within the specified project. * @alias compute.instanceTemplates.list * @memberOf! () * @@ -42662,8 +36184,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -42832,16 +36353,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -42889,16 +36401,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -42915,46 +36418,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -43263,8 +36739,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.interconnectAttachments.getIamPolicy * @memberOf! () * @@ -43338,8 +36813,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using - * the data included in the request. + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. * @alias compute.interconnectAttachments.insert * @memberOf! () * @@ -43416,8 +36890,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the - * specified region. + * @desc Retrieves the list of interconnect attachments contained within the specified region. * @alias compute.interconnectAttachments.list * @memberOf! () * @@ -43503,9 +36976,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -43583,8 +37054,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.interconnectAttachments.setIamPolicy * @memberOf! () * @@ -43659,8 +37129,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.setLabels - * @desc Sets the labels on an InterconnectAttachment. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnectAttachments.setLabels * @memberOf! () * @@ -43826,46 +37295,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -43893,16 +37335,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -43962,16 +37395,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -43988,46 +37412,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44059,16 +37456,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -44118,16 +37506,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44174,8 +37553,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a - * list of available interconnect locations by making a list() request. + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. * @alias compute.interconnectLocations.get * @memberOf! () * @@ -44252,8 +37630,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the - * specified project. + * @desc Retrieves the list of interconnect locations available to the specified project. * @alias compute.interconnectLocations.list * @memberOf! () * @@ -44436,46 +37813,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44589,8 +37939,7 @@ export namespace compute_alpha { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available - * interconnects by making a list() request. + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. * @alias compute.interconnects.get * @memberOf! () * @@ -44751,8 +38100,7 @@ export namespace compute_alpha { /** * compute.interconnects.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.interconnects.getIamPolicy * @memberOf! () * @@ -44825,8 +38173,7 @@ export namespace compute_alpha { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data - * included in the request. + * @desc Creates a Interconnect in the specified project using the data included in the request. * @alias compute.interconnects.insert * @memberOf! () * @@ -44901,8 +38248,7 @@ export namespace compute_alpha { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified - * project. + * @desc Retrieves the list of interconnect available to the specified project. * @alias compute.interconnects.list * @memberOf! () * @@ -44979,9 +38325,7 @@ export namespace compute_alpha { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnects.patch * @memberOf! () * @@ -45058,8 +38402,7 @@ export namespace compute_alpha { /** * compute.interconnects.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.interconnects.setIamPolicy * @memberOf! () * @@ -45133,8 +38476,7 @@ export namespace compute_alpha { /** * compute.interconnects.setLabels - * @desc Sets the labels on an Interconnect. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnects.setLabels * @memberOf! () * @@ -45305,16 +38647,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -45378,16 +38711,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -45404,46 +38728,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -45467,16 +38764,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -45557,8 +38845,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across - * all projects that have permissions to read the License Code. + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. * @alias compute.licenseCodes.get * @memberOf! () * @@ -45632,8 +38919,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenseCodes.getIamPolicy * @memberOf! () * @@ -45706,8 +38992,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenseCodes.setIamPolicy * @memberOf! () * @@ -46089,8 +39374,7 @@ export namespace compute_alpha { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -46237,12 +39521,7 @@ export namespace compute_alpha { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. - * This method does not get any licenses that belong to other projects, - * including licenses attached to publicly-available images, like Debian 9. - * If you want to get a list of publicly-available licenses, use this method - * to make a request to the respective image project, such as debian-cloud - * or windows-cloud. + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.licenses.list * @memberOf! () * @@ -46320,8 +39599,7 @@ export namespace compute_alpha { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -46489,16 +39767,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -46544,16 +39813,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -46569,46 +39829,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -46667,8 +39900,7 @@ export namespace compute_alpha { /** * compute.machineImages.delete - * @desc Deletes the specified machine image. Deleting a machine image is - * permanent and cannot be undone. + * @desc Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. * @alias compute.machineImages.delete * @memberOf! () * @@ -46744,8 +39976,7 @@ export namespace compute_alpha { /** * compute.machineImages.get - * @desc Returns the specified machine image. Gets a list of available - * machine images by making a list() request. + * @desc Returns the specified machine image. Gets a list of available machine images by making a list() request. * @alias compute.machineImages.get * @memberOf! () * @@ -46820,8 +40051,7 @@ export namespace compute_alpha { /** * compute.machineImages.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.machineImages.getIamPolicy * @memberOf! () * @@ -46894,11 +40124,7 @@ export namespace compute_alpha { /** * compute.machineImages.insert - * @desc Creates a machine image in the specified project using the data - * that is included in the request. If you are creating a new machine image - * to update an existing instance, your new machine image should use the - * same network or, if applicable, the same subnetwork as the original - * instance. + * @desc Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. * @alias compute.machineImages.insert * @memberOf! () * @@ -46974,8 +40200,7 @@ export namespace compute_alpha { /** * compute.machineImages.list - * @desc Retrieves a list of machine images that are contained within the - * specified project. + * @desc Retrieves a list of machine images that are contained within the specified project. * @alias compute.machineImages.list * @memberOf! () * @@ -47052,8 +40277,7 @@ export namespace compute_alpha { /** * compute.machineImages.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.machineImages.setIamPolicy * @memberOf! () * @@ -47222,16 +40446,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -47279,16 +40494,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -47309,46 +40515,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47492,8 +40671,7 @@ export namespace compute_alpha { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available - * machine types by making a list() request. + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. * @alias compute.machineTypes.get * @memberOf! () * @@ -47568,8 +40746,7 @@ export namespace compute_alpha { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified - * project. + * @desc Retrieves a list of machine types available to the specified project. * @alias compute.machineTypes.list * @memberOf! () * @@ -47655,46 +40832,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47729,46 +40879,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47789,8 +40912,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by - * zone. + * @desc Retrieves the list of network endpoint groups and sorts them by zone. * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -47877,8 +40999,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network - * endpoint group. + * @desc Attach a list of network endpoints to the specified network endpoint group. * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -47958,10 +41079,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints - * in the NEG and the VM instances they belong to are not terminated when - * the NEG is deleted. Note that the NEG cannot be deleted if there are - * backend services referencing it. + * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. * @alias compute.networkEndpointGroups.delete * @memberOf! () * @@ -48038,8 +41156,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network - * endpoint group. + * @desc Detach a list of network endpoints from the specified network endpoint group. * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -48119,8 +41236,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of - * available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -48198,8 +41314,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the - * parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -48276,8 +41391,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in - * the specified project and zone. + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -48358,8 +41472,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint - * group. + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -48551,46 +41664,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -48606,8 +41692,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are attaching network - * endpoints to. It should comply with RFC1035. + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -48615,21 +41700,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -48646,8 +41721,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group to delete. It should comply with - * RFC1035. + * The name of the network endpoint group to delete. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -48655,21 +41729,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -48681,8 +41745,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are removing network - * endpoints. It should comply with RFC1035. + * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -48690,21 +41753,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -48729,8 +41782,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -48746,21 +41798,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where you want to create the network endpoint group. - * It should comply with RFC1035. + * The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. */ zone?: string; @@ -48777,46 +41819,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -48824,8 +41839,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -48837,51 +41851,23 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * The name of the network endpoint group from which you want to generate a - * list of included network endpoints. It should comply with RFC1035. + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -48889,8 +41875,7 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -49085,8 +42070,7 @@ export namespace compute_alpha { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by - * making a list() request. + * @desc Returns the specified network. Gets a list of available networks by making a list() request. * @alias compute.networks.get * @memberOf! () * @@ -49250,8 +42234,7 @@ export namespace compute_alpha { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included - * in the request. + * @desc Creates a network in the specified project using the data included in the request. * @alias compute.networks.insert * @memberOf! () * @@ -49656,9 +42639,7 @@ export namespace compute_alpha { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the - * request. Only the following fields can be modified: - * routingConfig.routingMode. + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. * @alias compute.networks.patch * @memberOf! () * @@ -49811,8 +42792,7 @@ export namespace compute_alpha { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet - * mode. + * @desc Switches the network mode from auto subnet mode to custom subnet mode. * @alias compute.networks.switchToCustomMode * @memberOf! () * @@ -49968,10 +42948,7 @@ export namespace compute_alpha { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the - * request Only the following fields can be modified: - * NetworkPeering.export_custom_routes, and - * NetworkPeering.import_custom_routes + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes * @alias compute.networks.updatePeering * @memberOf! () * @@ -50063,16 +43040,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50096,16 +43064,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -50151,16 +43110,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50176,46 +43126,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50231,30 +43154,11 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** @@ -50262,19 +43166,11 @@ export namespace compute_alpha { */ network?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50282,8 +43178,7 @@ export namespace compute_alpha { */ project?: string; /** - * (Optional) types filter separate by comma, valid values are: SUBNETWORK, - * RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. + * (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. */ types?: string; } @@ -50295,22 +43190,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -50318,11 +43198,7 @@ export namespace compute_alpha { */ ipCidrRange?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** @@ -50330,14 +43206,7 @@ export namespace compute_alpha { */ network?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** @@ -50349,8 +43218,7 @@ export namespace compute_alpha { */ ownerTypes?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50378,30 +43246,11 @@ export namespace compute_alpha { */ direction?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** @@ -50409,24 +43258,15 @@ export namespace compute_alpha { */ network?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** - * The response will show routes exchanged over the given peering - * connection. + * The response will show routes exchanged over the given peering connection. */ peeringName?: string; /** @@ -50434,8 +43274,7 @@ export namespace compute_alpha { */ project?: string; /** - * The region of the request. The response will include all subnet routes, - * static routes and dynamic routes in the region. + * The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. */ region?: string; } @@ -50454,16 +43293,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50488,16 +43318,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50522,16 +43343,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -50572,16 +43384,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50677,8 +43480,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use - * nodeGroups.listNodes for more details about each group. + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -50915,9 +43717,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups - * by making a list() request. Note: the "nodes" field should not be used. - * Use nodeGroups.listNodes instead. + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -50992,8 +43792,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -51067,8 +43866,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the - * data included in the request. + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. * @alias compute.nodeGroups.insert * @memberOf! () * @@ -51146,8 +43944,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. - * Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -51385,8 +44182,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -51635,16 +44431,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -51665,46 +44452,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -51728,16 +44488,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -51761,16 +44512,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -51838,16 +44580,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -51867,46 +44600,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -51926,30 +44632,11 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** @@ -51957,19 +44644,11 @@ export namespace compute_alpha { */ nodeGroup?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -51997,16 +44676,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -52060,16 +44730,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -52278,8 +44939,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node - * templates by making a list() request. + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. * @alias compute.nodeTemplates.get * @memberOf! () * @@ -52355,8 +45015,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -52430,8 +45089,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the - * data included in the request. + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -52508,8 +45166,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified - * project. + * @desc Retrieves a list of node templates available to the specified project. * @alias compute.nodeTemplates.list * @memberOf! () * @@ -52588,8 +45245,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -52752,46 +45408,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -52819,16 +45448,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -52888,16 +45508,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -52914,46 +45525,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -53105,8 +45689,7 @@ export namespace compute_alpha { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node - * types by making a list() request. + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. * @alias compute.nodeTypes.get * @memberOf! () * @@ -53264,46 +45847,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -53337,46 +45893,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -53932,8 +46461,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.insert - * @desc Creates a new policy in the specified project using the data - * included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. * @alias compute.organizationSecurityPolicies.insert * @memberOf! () * @@ -54009,8 +46537,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.list - * @desc List all the policies that have been configured for the specified - * project. + * @desc List all the policies that have been configured for the specified project. * @alias compute.organizationSecurityPolicies.list * @memberOf! () * @@ -54088,8 +46615,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.listAssociations - * @desc Lists associations of a specified target, i.e., organization or - * folder. + * @desc Lists associations of a specified target, i.e., organization or folder. * @alias compute.organizationSecurityPolicies.listAssociations * @memberOf! () * @@ -54577,22 +47103,11 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Indicates whether or not to replace it if an association of the - * attachment already exists. This is false by default, in which case an - * error will be returned if an assocation already exists. + * Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an assocation already exists. */ replaceExistingAssociation?: boolean; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54613,16 +47128,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54643,16 +47149,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54672,16 +47169,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54745,16 +47233,7 @@ export namespace compute_alpha { */ parentId?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -54771,46 +47250,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -54826,8 +47278,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The target resource to list associations. It is an organization, or a - * folder. + * The target resource to list associations. It is an organization, or a folder. */ targetResource?: string; } @@ -54843,16 +47294,7 @@ export namespace compute_alpha { */ parentId?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54868,16 +47310,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54902,16 +47335,7 @@ export namespace compute_alpha { */ priority?: number; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54936,16 +47360,7 @@ export namespace compute_alpha { */ name?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54965,16 +47380,7 @@ export namespace compute_alpha { */ priority?: number; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -55065,8 +47471,7 @@ export namespace compute_alpha { /** * compute.projects.disableXpnResource - * @desc Disable a serivce resource (a.k.a service project) associated with - * this host project. + * @desc Disable a serivce resource (a.k.a service project) associated with this host project. * @alias compute.projects.disableXpnResource * @memberOf! () * @@ -55215,9 +47620,7 @@ export namespace compute_alpha { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, - * so that subnets in the host project can be used by instances in the - * service project. + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. * @alias compute.projects.enableXpnResource * @memberOf! () * @@ -55363,8 +47766,7 @@ export namespace compute_alpha { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be - * empty if no link exists. + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. * @alias compute.projects.getXpnHost * @memberOf! () * @@ -55435,8 +47837,7 @@ export namespace compute_alpha { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this - * host project. + * @desc Gets service resources (a.k.a service project) associated with this host project. * @alias compute.projects.getXpnResources * @memberOf! () * @@ -55517,8 +47918,7 @@ export namespace compute_alpha { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an - * organization. + * @desc Lists all shared VPC host projects visible to the user in an organization. * @alias compute.projects.listXpnHosts * @memberOf! () * @@ -55671,8 +48071,7 @@ export namespace compute_alpha { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone - * to another. + * @desc Moves an instance and its attached persistent disks from one zone to another. * @alias compute.projects.moveInstance * @memberOf! () * @@ -55747,8 +48146,7 @@ export namespace compute_alpha { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project - * using the data included in the request. + * @desc Sets metadata common to all instances within the specified project using the data included in the request. * @alias compute.projects.setCommonInstanceMetadata * @memberOf! () * @@ -55826,9 +48224,7 @@ export namespace compute_alpha { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network - * tier is used when an address/forwardingRule/instance is created without - * specifying the network tier field. + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -55906,9 +48302,7 @@ export namespace compute_alpha { /** * compute.projects.setDefaultServiceAccount - * @desc Sets the default service account of the project. The default - * service account is used when a VM instance is created with the service - * account email address set to "default". + * @desc Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". * @alias compute.projects.setDefaultServiceAccount * @memberOf! () * @@ -55986,9 +48380,7 @@ export namespace compute_alpha { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket - * where reports are stored. If you provide an empty request body using this - * method, the usage export feature will be disabled. + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. * @alias compute.projects.setUsageExportBucket * @memberOf! () * @@ -56076,16 +48468,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -56101,16 +48484,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56131,16 +48505,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -56156,16 +48521,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56205,46 +48561,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -56260,46 +48589,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -56324,16 +48626,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56354,16 +48647,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56384,16 +48668,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56414,16 +48689,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56444,16 +48710,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56474,16 +48731,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56654,8 +48902,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data - * included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. * @alias compute.regionAutoscalers.insert * @memberOf! () * @@ -56732,8 +48979,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified - * region. + * @desc Retrieves a list of autoscalers contained within the specified region. * @alias compute.regionAutoscalers.list * @memberOf! () * @@ -56814,9 +49060,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionAutoscalers.patch * @memberOf! () * @@ -56975,8 +49219,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data - * included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. * @alias compute.regionAutoscalers.update * @memberOf! () * @@ -57073,16 +49316,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -57122,16 +49356,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -57148,46 +49373,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -57219,16 +49417,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -57282,16 +49471,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -57462,8 +49642,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional - * BackendService. + * @desc Gets the most recent health check results for this regional BackendService. * @alias compute.regionBackendServices.getHealth * @memberOf! () * @@ -57547,10 +49726,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project - * using the data included in the request. There are several restrictions - * and guidelines to keep in mind when creating a regional backend service. - * Read Restrictions and Guidelines for more information. + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. * @alias compute.regionBackendServices.insert * @memberOf! () * @@ -57627,8 +49803,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available - * to the specified project in the given region. + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. * @alias compute.regionBackendServices.list * @memberOf! () * @@ -57707,12 +49882,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the - * data included in the request. There are several restrictions and - * guidelines to keep in mind when updating a backend service. Read - * Restrictions and Guidelines for more information. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionBackendServices.patch * @memberOf! () * @@ -57871,10 +50041,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the - * data included in the request. There are several restrictions and - * guidelines to keep in mind when updating a backend service. Read - * Restrictions and Guidelines for more information. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @alias compute.regionBackendServices.update * @memberOf! () * @@ -57971,16 +50138,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -58045,16 +50203,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58071,46 +50220,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -58142,16 +50264,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58205,16 +50318,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58314,8 +50418,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available - * commitments by making a list() request. + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. * @alias compute.regionCommitments.get * @memberOf! () * @@ -58391,8 +50494,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data - * included in the request. + * @desc Creates a commitment in the specified project using the data included in the request. * @alias compute.regionCommitments.insert * @memberOf! () * @@ -58469,8 +50571,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified - * region. + * @desc Retrieves a list of commitments contained within the specified region. * @alias compute.regionCommitments.list * @memberOf! () * @@ -58630,8 +50731,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of - * reservations within the commitments. + * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -58716,46 +50816,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -58799,16 +50872,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58825,46 +50889,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -58909,8 +50946,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the commitment of which the reservation's capacities are being - * updated. + * Name of the commitment of which the reservation's capacities are being updated. */ commitment?: string; /** @@ -58922,16 +50958,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58949,9 +50976,7 @@ export namespace compute_alpha { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only - * add one policy which will be applied to this disk for scheduling snapshot - * creation. + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -59108,10 +51133,7 @@ export namespace compute_alpha { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional - * disk removes all the replicas of its data permanently and is - * irreversible. However, deleting a disk does not delete any snapshots - * previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.regionDisks.delete * @memberOf! () * @@ -59261,8 +51283,7 @@ export namespace compute_alpha { /** * compute.regionDisks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.regionDisks.getIamPolicy * @memberOf! () * @@ -59336,8 +51357,7 @@ export namespace compute_alpha { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using - * the data included in the request. + * @desc Creates a persistent regional disk in the specified project using the data included in the request. * @alias compute.regionDisks.insert * @memberOf! () * @@ -59415,8 +51435,7 @@ export namespace compute_alpha { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the - * specified region. + * @desc Retrieves the list of persistent disks contained within the specified region. * @alias compute.regionDisks.list * @memberOf! () * @@ -59650,8 +51669,7 @@ export namespace compute_alpha { /** * compute.regionDisks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.regionDisks.setIamPolicy * @memberOf! () * @@ -59904,16 +51922,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -59946,16 +51955,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -59984,16 +51984,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -60052,16 +52043,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -60081,46 +52063,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -60152,16 +52107,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -60190,16 +52136,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -60249,16 +52186,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -60305,8 +52233,7 @@ export namespace compute_alpha { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available - * disk types by making a list() request. + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -60380,8 +52307,7 @@ export namespace compute_alpha { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified - * project. + * @desc Retrieves a list of regional disk types available to the specified project. * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -60487,46 +52413,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -60624,8 +52523,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of - * available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @alias compute.regionHealthChecks.get * @memberOf! () * @@ -60701,8 +52599,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.insert * @memberOf! () * @@ -60779,8 +52676,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @alias compute.regionHealthChecks.list * @memberOf! () * @@ -60859,9 +52755,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionHealthChecks.patch * @memberOf! () * @@ -61020,8 +52914,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.update * @memberOf! () * @@ -61118,16 +53011,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -61167,16 +53051,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61193,46 +53068,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -61264,16 +53112,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61327,16 +53166,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61507,8 +53337,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.insert - * @desc Creates a regional HealthCheckService resource in the specified - * project and region using the data included in the request. + * @desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. * @alias compute.regionHealthCheckServices.insert * @memberOf! () * @@ -61585,8 +53414,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.list - * @desc Lists all the HealthCheckService resources that have been - * configured for the specified project in the given region. + * @desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region. * @alias compute.regionHealthCheckServices.list * @memberOf! () * @@ -61755,8 +53583,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the HealthCheckService to delete. The name must be 1-63 - * characters long, and comply with RFC1035. + * Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. */ healthCheckService?: string; /** @@ -61768,16 +53595,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -61789,8 +53607,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the HealthCheckService to update. The name must be 1-63 - * characters long, and comply with RFC1035. + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. */ healthCheckService?: string; /** @@ -61818,16 +53635,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61844,46 +53652,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -61929,19 +53710,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the - * managed instance group. Abandoning an instance does not delete the - * instance, but it does remove the instance from any target pools that are - * applied by the managed instance group. This method reduces the targetSize - * of the managed instance group by the number of instances that you - * abandon. This operation is marked as DONE when the action is scheduled - * even if the instances have not yet been removed from the group. You must - * separately verify the status of the abandoning action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.regionInstanceGroupManagers.abandonInstances * @memberOf! () * @@ -62098,12 +53867,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.createInstances - * @desc Creates instances with per-instance configs in this regional - * managed instance group. Instances are created using the current instance - * template. The create instances operation is marked DONE if the - * createInstances request is successful. The underlying actions take - * additional time. You must separately verify the status of the creating or - * actions with the listmanagedinstances method. + * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @alias compute.regionInstanceGroupManagers.createInstances * @memberOf! () * @@ -62181,8 +53945,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the - * instances in that group. + * @desc Deletes the specified managed instance group and all of the instances in that group. * @alias compute.regionInstanceGroupManagers.delete * @memberOf! () * @@ -62259,18 +54022,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately deleted. The instances are also removed from any target pools - * of which they were a member. This method reduces the targetSize of the - * managed instance group by the number of instances that you delete. The - * deleteInstances operation is marked DONE if the deleteInstances request - * is successful. The underlying actions take additional time. You must - * separately verify the status of the deleting action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.regionInstanceGroupManagers.deleteInstances * @memberOf! () * @@ -62348,8 +54100,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.deletePerInstanceConfigs - * @desc Deletes selected per-instance configs for the managed instance - * group. + * @desc Deletes selected per-instance configs for the managed instance group. * @alias compute.regionInstanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -62428,8 +54179,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance - * group. + * @desc Returns all of the details about the specified managed instance group. * @alias compute.regionInstanceGroupManagers.get * @memberOf! () * @@ -62507,13 +54257,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, instances in the - * group are created using the specified instance template. This operation - * is marked as DONE when the group is created even if the instances in the - * group have not yet been created. You must separately verify the status of - * the individual instances with the listmanagedinstances method. A - * regional managed instance group can contain up to 2000 instances. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @alias compute.regionInstanceGroupManagers.insert * @memberOf! () * @@ -62590,8 +54334,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained - * within the specified region. + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @alias compute.regionInstanceGroupManagers.list * @memberOf! () * @@ -62679,9 +54422,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances - * that are scheduled to be created. The list includes any current actions - * that the group has scheduled for its instances. + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. * @alias compute.regionInstanceGroupManagers.listManagedInstances * @memberOf! () * @@ -62785,8 +54526,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listPerInstanceConfigs - * @desc Lists all of the per-instance configs defined for the managed - * instance group. + * @desc Lists all of the per-instance configs defined for the managed instance group. * @alias compute.regionInstanceGroupManagers.listPerInstanceConfigs * @memberOf! () * @@ -62890,13 +54630,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is patched even if the instances in the group are still in the process of - * being patched. You must separately verify the status of the individual - * instances with the listmanagedinstances method. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * @@ -62974,9 +54708,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.patchPerInstanceConfigs - * @desc Insert or patch (for the ones that already exist) per-instance - * configs for the managed instance group. perInstanceConfig.instance serves - * as a key used to distinguish whether to perform insert or patch. + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.regionInstanceGroupManagers.patchPerInstanceConfigs * @memberOf! () * @@ -63056,16 +54788,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately recreated. The instances are deleted and recreated using the - * current instance template for the managed instance group. This operation - * is marked as DONE when the flag is set even if the instances have not yet - * been recreated. You must separately verify the status of the recreating - * action with the listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. You can specify a maximum of 1000 - * instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.regionInstanceGroupManagers.recreateInstances * @memberOf! () * @@ -63143,16 +54866,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you - * increase the size, the group creates new instances using the current - * instance template. If you decrease the size, the group deletes one or - * more instances. The resize operation is marked DONE if the resize - * request is successful. The underlying actions take additional time. You - * must separately verify the status of the creating or deleting actions - * with the listmanagedinstances method. If the group is part of a backend - * service that has enabled connection draining, it can take up to 60 - * seconds after the connection draining duration has elapsed before the VM - * instance is removed or deleted. + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @alias compute.regionInstanceGroupManagers.resize * @memberOf! () * @@ -63230,9 +54944,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policy for the instances in this managed - * instance group. [Deprecated] This method is deprecated. Please use Patch - * instead. + * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. * @alias compute.regionInstanceGroupManagers.setAutoHealingPolicies * @memberOf! () * @@ -63312,8 +55024,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or - * recreating instances in this group. Existing instances are not affected. + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @alias compute.regionInstanceGroupManagers.setInstanceTemplate * @memberOf! () * @@ -63391,8 +55102,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group - * are assigned. Existing instances in the group are not affected. + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @alias compute.regionInstanceGroupManagers.setTargetPools * @memberOf! () * @@ -63551,11 +55261,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.update - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is updated even if the instances in the group have not yet been updated. - * You must separately verify the status of the individual instances with - * the listmanagedinstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. * @alias compute.regionInstanceGroupManagers.update * @memberOf! () * @@ -63633,9 +55339,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.updatePerInstanceConfigs - * @desc Insert or update (for the ones that already exist) per-instance - * configs for the managed instance group. perInstanceConfig.instance serves - * as a key used to distinguish whether to perform insert or patch. + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.regionInstanceGroupManagers.updatePerInstanceConfigs * @memberOf! () * @@ -63734,16 +55438,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63793,20 +55488,11 @@ export namespace compute_alpha { */ project?: string; /** - * The name of the region where the managed instance group is located. It - * should conform to RFC1035. + * The name of the region where the managed instance group is located. It should conform to RFC1035. */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63835,16 +55521,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -63868,16 +55545,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63947,16 +55615,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63973,46 +55632,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -64032,22 +55664,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -64055,27 +55672,15 @@ export namespace compute_alpha { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -64095,22 +55700,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -64118,27 +55708,15 @@ export namespace compute_alpha { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -64170,16 +55748,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64208,16 +55777,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64246,16 +55806,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64284,16 +55835,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -64321,16 +55863,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64359,16 +55892,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64397,16 +55921,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64460,16 +55975,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64498,16 +56004,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -64601,8 +56098,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the - * specified region. + * @desc Retrieves the list of instance group resources contained within the specified region. * @alias compute.regionInstanceGroups.list * @memberOf! () * @@ -64683,10 +56179,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays - * information about the named ports. Depending on the specified options, - * this method can list all instances or only the instances that are - * running. + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. * @alias compute.regionInstanceGroups.listInstances * @memberOf! () * @@ -64962,46 +56455,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -65021,51 +56487,23 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * Name of the regional instance group for which we want to list the - * instances. + * Name of the regional instance group for which we want to list the instances. */ instanceGroup?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -65090,8 +56528,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the regional instance group where the named ports are - * updated. + * The name of the regional instance group where the named ports are updated. */ instanceGroup?: string; /** @@ -65103,16 +56540,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -65232,8 +56660,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.get - * @desc Returns the specified NotificationEndpoint resource in the given - * region. + * @desc Returns the specified NotificationEndpoint resource in the given region. * @alias compute.regionNotificationEndpoints.get * @memberOf! () * @@ -65311,8 +56738,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.insert - * @desc Create a NotificationEndpoint in the specified project in the given - * region using the parameters that are included in the request. + * @desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. * @alias compute.regionNotificationEndpoints.insert * @memberOf! () * @@ -65570,16 +56996,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -65619,16 +57036,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -65645,46 +57053,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -65880,8 +57261,7 @@ export namespace compute_alpha { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified region. + * @desc Retrieves a list of Operation resources contained within the specified region. * @alias compute.regionOperations.list * @memberOf! () * @@ -65960,16 +57340,7 @@ export namespace compute_alpha { /** * compute.regionOperations.wait - * @desc Waits for the specified region-specific Operations resource until - * it is done or timeout, and retrieves the specified Operations - * resource. 1. Immediately returns when the operation is already done. 2. - * Waits for no more than the default deadline (2 minutes, subject to - * change) and then returns the current state of the operation, which may be - * DONE or still in progress. 3. Is best-effort: a. The server can wait less - * than the default deadline or zero seconds, in overload situations. b. - * There is no guarantee that the operation is actually done when - * returns. 4. User should be prepared to retry if the operation is not - * DONE. + * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.regionOperations.wait * @memberOf! () * @@ -66092,46 +57463,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -66172,8 +57516,7 @@ export namespace compute_alpha { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available - * regions by making a list() request. + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. * @alias compute.regions.get * @memberOf! () * @@ -66244,8 +57587,7 @@ export namespace compute_alpha { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified - * project. + * @desc Retrieves the list of region resources available to the specified project. * @alias compute.regions.list * @memberOf! () * @@ -66342,46 +57684,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -66475,9 +57790,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.get - * @desc Returns the specified SslCertificate resource in the specified - * region. Get a list of available SSL certificates by making a list() - * request. + * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. * @alias compute.regionSslCertificates.get * @memberOf! () * @@ -66553,8 +57866,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project and - * region using the data included in the request + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request * @alias compute.regionSslCertificates.insert * @memberOf! () * @@ -66631,8 +57943,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the - * specified project in the specified region. + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. * @alias compute.regionSslCertificates.list * @memberOf! () * @@ -66711,8 +58022,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource and - * region. + * @desc Returns permissions that a caller has on the specified resource and region. * @alias compute.regionSslCertificates.testIamPermissions * @memberOf! () * @@ -66808,16 +58118,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -66861,16 +58162,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66887,46 +58179,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -67049,9 +58314,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified - * region. Gets a list of available target HTTP proxies by making a list() - * request. + * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpProxies.get * @memberOf! () * @@ -67127,8 +58390,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and - * region using the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpProxies.insert * @memberOf! () * @@ -67205,8 +58467,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the - * specified project in the specified region. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpProxies.list * @memberOf! () * @@ -67459,16 +58720,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -67512,16 +58764,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -67538,46 +58781,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -67605,16 +58821,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -67738,9 +58945,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource in the specified - * region. Gets a list of available target HTTP proxies by making a list() - * request. + * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * @@ -67816,8 +59021,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project and - * region using the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * @@ -67894,8 +59098,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the - * specified project in the specified region. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * @@ -68228,16 +59431,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -68281,16 +59475,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -68307,46 +59492,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -68374,21 +59532,11 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource to set an SslCertificates resource - * for. + * Name of the TargetHttpsProxy resource to set an SslCertificates resource for. */ targetHttpsProxy?: string; @@ -68413,16 +59561,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -68546,8 +59685,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL - * maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @alias compute.regionUrlMaps.get * @memberOf! () * @@ -68621,8 +59759,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data - * included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @alias compute.regionUrlMaps.insert * @memberOf! () * @@ -68699,8 +59836,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the - * specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @alias compute.regionUrlMaps.invalidateCache * @memberOf! () * @@ -68778,8 +59914,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified - * project in the specified region. + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. * @alias compute.regionUrlMaps.list * @memberOf! () * @@ -68858,9 +59993,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the - * request. This method supports PATCH semantics and uses JSON merge patch - * format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.regionUrlMaps.patch * @memberOf! () * @@ -69019,8 +60152,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the - * request. + * @desc Updates the specified UrlMap resource with the data included in the request. * @alias compute.regionUrlMaps.update * @memberOf! () * @@ -69098,9 +60230,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of - * the provided UrlMap will be run. Calling this method does NOT create the - * UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @alias compute.regionUrlMaps.validate * @memberOf! () * @@ -69196,8 +60326,7 @@ export namespace compute_alpha { */ region?: string; /** - * begin_interface: MixerMutationRequestBuilder Request ID to support - * idempotency. + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. */ requestId?: string; /** @@ -69241,8 +60370,7 @@ export namespace compute_alpha { */ region?: string; /** - * begin_interface: MixerMutationRequestBuilder Request ID to support - * idempotency. + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. */ requestId?: string; @@ -69267,8 +60395,7 @@ export namespace compute_alpha { */ region?: string; /** - * begin_interface: MixerMutationRequestBuilder Request ID to support - * idempotency. + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. */ requestId?: string; /** @@ -69289,46 +60416,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -69356,8 +60456,7 @@ export namespace compute_alpha { */ region?: string; /** - * begin_interface: MixerMutationRequestBuilder Request ID to support - * idempotency. + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. */ requestId?: string; /** @@ -69411,8 +60510,7 @@ export namespace compute_alpha { */ region?: string; /** - * begin_interface: MixerMutationRequestBuilder Request ID to support - * idempotency. + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. */ requestId?: string; /** @@ -69696,8 +60794,7 @@ export namespace compute_alpha { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -69848,8 +60945,7 @@ export namespace compute_alpha { /** * compute.reservations.list - * @desc A list all the reservations that have been configured for the - * specified project in specified zone. + * @desc A list all the reservations that have been configured for the specified project in specified zone. * @alias compute.reservations.list * @memberOf! () * @@ -69928,8 +61024,7 @@ export namespace compute_alpha { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations - * only) + * @desc Resizes the reservation (applicable to standalone reservations only) * @alias compute.reservations.resize * @memberOf! () * @@ -70007,8 +61102,7 @@ export namespace compute_alpha { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -70171,46 +61265,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -70230,16 +61297,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70302,16 +61360,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70332,46 +61381,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -70395,16 +61417,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70720,8 +61733,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.resourcePolicies.getIamPolicy * @memberOf! () * @@ -70872,8 +61884,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the - * specified project in specified region. + * @desc A list all the resource policies that have been configured for the specified project in specified region. * @alias compute.resourcePolicies.list * @memberOf! () * @@ -70952,8 +61963,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.resourcePolicies.setIamPolicy * @memberOf! () * @@ -71116,46 +62126,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -71179,16 +62162,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -71252,16 +62226,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -71278,46 +62243,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -71545,8 +62483,7 @@ export namespace compute_alpha { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available - * routers by making a list() request. + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. * @alias compute.routers.get * @memberOf! () * @@ -71787,8 +62724,7 @@ export namespace compute_alpha { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using - * the data included in the request. + * @desc Creates a Router resource in the specified project and region using the data included in the request. * @alias compute.routers.insert * @memberOf! () * @@ -71864,8 +62800,7 @@ export namespace compute_alpha { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified - * project. + * @desc Retrieves a list of Router resources available to the specified project. * @alias compute.routers.list * @memberOf! () * @@ -71943,9 +62878,7 @@ export namespace compute_alpha { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the - * request. This method supports PATCH semantics and uses JSON merge patch - * format and processing rules. + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.routers.patch * @memberOf! () * @@ -72022,8 +62955,7 @@ export namespace compute_alpha { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update - * operations. Calling this method does NOT create or update the router. + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. * @alias compute.routers.preview * @memberOf! () * @@ -72184,8 +63116,7 @@ export namespace compute_alpha { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the - * request. + * @desc Updates the specified Router resource with the data included in the request. * @alias compute.routers.update * @memberOf! () * @@ -72269,46 +63200,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -72331,16 +63235,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -72375,52 +63270,23 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Name of the nat service to filter the Nat Mapping information. If it is - * omitted, all nats for this router will be returned. Name should conform - * to RFC1035. + * Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035. */ natName?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -72432,8 +63298,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the Router resource to query for Nat Mapping information of VM - * endpoints. + * Name of the Router resource to query for Nat Mapping information of VM endpoints. */ router?: string; } @@ -72472,16 +63337,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -72497,46 +63353,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -72563,16 +63392,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -72649,16 +63469,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -72755,8 +63566,7 @@ export namespace compute_alpha { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available - * routes by making a list() request. + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. * @alias compute.routes.get * @memberOf! () * @@ -72828,8 +63638,7 @@ export namespace compute_alpha { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data - * included in the request. + * @desc Creates a Route resource in the specified project using the data included in the request. * @alias compute.routes.insert * @memberOf! () * @@ -72903,8 +63712,7 @@ export namespace compute_alpha { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified - * project. + * @desc Retrieves the list of Route resources available to the specified project. * @alias compute.routes.list * @memberOf! () * @@ -73070,16 +63878,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -73113,16 +63912,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -73138,46 +63928,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -73519,8 +64282,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data - * included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. * @alias compute.securityPolicies.insert * @memberOf! () * @@ -73597,8 +64359,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified - * project. + * @desc List all the policies that have been configured for the specified project. * @alias compute.securityPolicies.list * @memberOf! () * @@ -73676,8 +64437,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.listPreconfiguredExpressionSets - * @desc Gets the current list of preconfigured Web Application Firewall - * (WAF) expressions. + * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. * @alias compute.securityPolicies.listPreconfiguredExpressionSets * @memberOf! () * @@ -74012,8 +64772,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.setLabels - * @desc Sets the labels on a security policy. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. * @alias compute.securityPolicies.setLabels * @memberOf! () * @@ -74205,16 +64964,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -74270,16 +65020,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -74300,46 +65041,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -74355,46 +65069,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -74414,16 +65101,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -74536,11 +65214,7 @@ export namespace compute_alpha { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting - * a single snapshot might not necessarily delete all the data on that - * snapshot. If any data on the snapshot that is marked for deletion is - * needed for subsequent snapshots, the data will be moved to the next - * corresponding snapshot. For more information, see Deleting snapshots. + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. * @alias compute.snapshots.delete * @memberOf! () * @@ -74615,8 +65289,7 @@ export namespace compute_alpha { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available - * snapshots by making a list() request. + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. * @alias compute.snapshots.get * @memberOf! () * @@ -74688,8 +65361,7 @@ export namespace compute_alpha { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -74762,8 +65434,7 @@ export namespace compute_alpha { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the - * specified project. + * @desc Retrieves the list of Snapshot resources contained within the specified project. * @alias compute.snapshots.list * @memberOf! () * @@ -74839,8 +65510,7 @@ export namespace compute_alpha { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -74914,8 +65584,7 @@ export namespace compute_alpha { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. * @alias compute.snapshots.setLabels * @memberOf! () * @@ -75081,16 +65750,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -75136,46 +65796,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -75255,8 +65888,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.aggregatedList - * @desc Retrieves the list of all SslCertificate resources, regional and - * global, available to the specified project. + * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. * @alias compute.sslCertificates.aggregatedList * @memberOf! () * @@ -75419,8 +66051,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of - * available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. * @alias compute.sslCertificates.get * @memberOf! () * @@ -75495,8 +66126,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using - * the data included in the request. + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. * @alias compute.sslCertificates.insert * @memberOf! () * @@ -75572,8 +66202,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the - * specified project. + * @desc Retrieves the list of SslCertificate resources available to the specified project. * @alias compute.sslCertificates.list * @memberOf! () * @@ -75738,46 +66367,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -75797,16 +66399,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -75842,16 +66435,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -75868,46 +66452,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -75945,9 +66502,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be - * deleted only if it is not in use by any TargetHttpsProxy or - * TargetSslProxy resources. + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. * @alias compute.sslPolicies.delete * @memberOf! () * @@ -76023,8 +66578,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified - * policy. + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -76098,8 +66652,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available - * SSL policies by making a list() request. + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. * @alias compute.sslPolicies.insert * @memberOf! () * @@ -76174,8 +66727,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the - * specified project. + * @desc Lists all the SSL policies that have been configured for the specified project. * @alias compute.sslPolicies.list * @memberOf! () * @@ -76251,8 +66803,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when - * using custom profile. + * @desc Lists all features that can be specified in the SSL policy when using custom profile. * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -76347,8 +66898,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the - * request. + * @desc Patches the specified SSL policy with the data included in the request. * @alias compute.sslPolicies.patch * @memberOf! () * @@ -76516,21 +67066,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the SSL policy to delete. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; } @@ -76545,8 +67085,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the SSL policy to update. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; } @@ -76562,16 +67101,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -76587,46 +67117,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -76642,46 +67145,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -76701,21 +67177,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the SSL policy to update. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; @@ -76991,8 +67457,7 @@ export namespace compute_alpha { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available - * subnetworks list() request. + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. * @alias compute.subnetworks.get * @memberOf! () * @@ -77067,8 +67532,7 @@ export namespace compute_alpha { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.subnetworks.getIamPolicy * @memberOf! () * @@ -77142,8 +67606,7 @@ export namespace compute_alpha { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data - * included in the request. + * @desc Creates a subnetwork in the specified project using the data included in the request. * @alias compute.subnetworks.insert * @memberOf! () * @@ -77385,10 +67848,7 @@ export namespace compute_alpha { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the - * request. Only certain fields can up updated with a patch request as - * indicated in the field descriptions. You must specify the current - * fingeprint of the subnetwork resource being patched. + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. * @alias compute.subnetworks.patch * @memberOf! () * @@ -77467,8 +67927,7 @@ export namespace compute_alpha { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.subnetworks.setIamPolicy * @memberOf! () * @@ -77543,8 +68002,7 @@ export namespace compute_alpha { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without - * assigning external IP addresses through Private Google Access. + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. * @alias compute.subnetworks.setPrivateIpGoogleAccess * @memberOf! () * @@ -77712,46 +68170,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -77775,16 +68206,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -77808,16 +68230,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -77885,16 +68298,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -77910,46 +68314,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -77969,46 +68346,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -78024,14 +68374,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The drain timeout specifies the upper bound in seconds on the amount of - * time allowed to drain connections from the current ACTIVE subnetwork to - * the current BACKUP subnetwork. The drain timeout is only applicable when - * the following conditions are true: - the subnetwork being patched has - * purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has - * role = BACKUP - the patch request is setting the role to ACTIVE. Note - * that after this patch operation the roles of the ACTIVE and BACKUP - * subnetworks will be swapped. + * The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. */ drainTimeoutSeconds?: number; /** @@ -78043,16 +68386,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -78106,16 +68440,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -78162,8 +68487,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpProxy resources, regional and - * global, available to the specified project. + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpProxies.aggregatedList * @memberOf! () * @@ -78326,8 +68650,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of - * available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.targetHttpProxies.get * @memberOf! () * @@ -78402,8 +68725,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. * @alias compute.targetHttpProxies.insert * @memberOf! () * @@ -78479,8 +68801,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. * @alias compute.targetHttpProxies.list * @memberOf! () * @@ -78722,46 +69043,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -78781,16 +69075,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -78826,16 +69111,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -78852,46 +69128,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -78911,16 +69160,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -78963,8 +69203,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpsProxy resources, regional and - * global, available to the specified project. + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpsProxies.aggregatedList * @memberOf! () * @@ -79127,8 +69366,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of - * available target HTTPS proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. * @alias compute.targetHttpsProxies.get * @memberOf! () * @@ -79203,8 +69441,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. * @alias compute.targetHttpsProxies.insert * @memberOf! () * @@ -79280,8 +69517,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. * @alias compute.targetHttpsProxies.list * @memberOf! () * @@ -79515,10 +69751,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies - * the server-side support for SSL features. This affects connections - * between clients and the HTTPS proxy load balancer. They do not affect the - * connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -79759,46 +69992,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -79818,16 +70024,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -79863,16 +70060,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -79889,46 +70077,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -79948,21 +70109,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource to set the QUIC override policy - * for. The name should conform to RFC1035. + * Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. */ targetHttpsProxy?: string; @@ -79983,21 +70134,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource to set an SslCertificates resource - * for. + * Name of the TargetHttpsProxy resource to set an SslCertificates resource for. */ targetHttpsProxy?: string; @@ -80018,21 +70159,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource whose SSL policy is to be set. The - * name must be 1-63 characters long, and comply with RFC1035. + * Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. */ targetHttpsProxy?: string; @@ -80053,16 +70184,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -80269,8 +70391,7 @@ export namespace compute_alpha { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of - * available target instances by making a list() request. + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. * @alias compute.targetInstances.get * @memberOf! () * @@ -80346,8 +70467,7 @@ export namespace compute_alpha { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone - * using the data included in the request. + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. * @alias compute.targetInstances.insert * @memberOf! () * @@ -80424,8 +70544,7 @@ export namespace compute_alpha { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the - * specified project and zone. + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. * @alias compute.targetInstances.list * @memberOf! () * @@ -80592,46 +70711,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -80651,16 +70743,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -80704,16 +70787,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -80734,46 +70808,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -81134,8 +71181,7 @@ export namespace compute_alpha { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target - * pools by making a list() request. + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. * @alias compute.targetPools.get * @memberOf! () * @@ -81210,8 +71256,7 @@ export namespace compute_alpha { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the - * instance that is referenced by the given target pool. + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. * @alias compute.targetPools.getHealth * @memberOf! () * @@ -81292,8 +71337,7 @@ export namespace compute_alpha { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the - * data included in the request. + * @desc Creates a target pool in the specified project and region using the data included in the request. * @alias compute.targetPools.insert * @memberOf! () * @@ -81370,8 +71414,7 @@ export namespace compute_alpha { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project - * and region. + * @desc Retrieves a list of target pools available to the specified project and region. * @alias compute.targetPools.list * @memberOf! () * @@ -81780,16 +71823,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -81818,16 +71852,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -81848,46 +71873,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -81911,16 +71909,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -81988,16 +71977,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -82013,46 +71993,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -82080,16 +72033,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -82118,16 +72062,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -82160,16 +72095,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -82292,8 +72218,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of - * available target SSL proxies by making a list() request. + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. * @alias compute.targetSslProxies.get * @memberOf! () * @@ -82368,8 +72293,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. * @alias compute.targetSslProxies.insert * @memberOf! () * @@ -82445,8 +72369,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. * @alias compute.targetSslProxies.list * @memberOf! () * @@ -82755,10 +72678,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies - * the server-side support for SSL features. This affects connections - * between clients and the SSL proxy load balancer. They do not affect the - * connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -82926,16 +72846,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -82971,16 +72882,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -82997,46 +72899,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -83056,21 +72931,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose BackendService resource is to - * be set. + * Name of the TargetSslProxy resource whose BackendService resource is to be set. */ targetSslProxy?: string; @@ -83091,16 +72956,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -83125,21 +72981,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose SslCertificate resource is to - * be set. + * Name of the TargetSslProxy resource whose SslCertificate resource is to be set. */ targetSslProxy?: string; @@ -83160,21 +73006,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose SSL policy is to be set. The - * name must be 1-63 characters long, and comply with RFC1035. + * Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. */ targetSslProxy?: string; @@ -83289,8 +73125,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of - * available target TCP proxies by making a list() request. + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. * @alias compute.targetTcpProxies.get * @memberOf! () * @@ -83365,8 +73200,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. * @alias compute.targetTcpProxies.insert * @memberOf! () * @@ -83442,8 +73276,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. * @alias compute.targetTcpProxies.list * @memberOf! () * @@ -83766,16 +73599,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -83811,16 +73635,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -83837,46 +73652,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -83896,21 +73684,11 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetTcpProxy resource whose BackendService resource is to - * be set. + * Name of the TargetTcpProxy resource whose BackendService resource is to be set. */ targetTcpProxy?: string; @@ -83931,16 +73709,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -84147,8 +73916,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available - * target VPN gateways by making a list() request. + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. * @alias compute.targetVpnGateways.get * @memberOf! () * @@ -84224,8 +73992,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region - * using the data included in the request. + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. * @alias compute.targetVpnGateways.insert * @memberOf! () * @@ -84302,8 +74069,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified - * project and region. + * @desc Retrieves a list of target VPN gateways available to the specified project and region. * @alias compute.targetVpnGateways.list * @memberOf! () * @@ -84384,8 +74150,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.setLabels - * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.targetVpnGateways.setLabels * @memberOf! () * @@ -84551,46 +74316,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -84614,16 +74352,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -84667,16 +74396,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -84693,46 +74413,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -84760,16 +74453,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -84816,8 +74500,7 @@ export namespace compute_alpha { /** * compute.urlMaps.aggregatedList - * @desc Retrieves the list of all UrlMap resources, regional and global, - * available to the specified project. + * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. * @alias compute.urlMaps.aggregatedList * @memberOf! () * @@ -84973,8 +74656,7 @@ export namespace compute_alpha { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL - * maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @alias compute.urlMaps.get * @memberOf! () * @@ -85046,8 +74728,7 @@ export namespace compute_alpha { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data - * included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @alias compute.urlMaps.insert * @memberOf! () * @@ -85121,8 +74802,7 @@ export namespace compute_alpha { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the - * specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @alias compute.urlMaps.invalidateCache * @memberOf! () * @@ -85199,8 +74879,7 @@ export namespace compute_alpha { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified - * project. + * @desc Retrieves the list of UrlMap resources available to the specified project. * @alias compute.urlMaps.list * @memberOf! () * @@ -85276,9 +74955,7 @@ export namespace compute_alpha { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.urlMaps.patch * @memberOf! () * @@ -85434,8 +75111,7 @@ export namespace compute_alpha { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the - * request. + * @desc Updates the specified UrlMap resource with the data included in the request. * @alias compute.urlMaps.update * @memberOf! () * @@ -85511,9 +75187,7 @@ export namespace compute_alpha { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of - * the provided UrlMap will be run. Calling this method does NOT create the - * UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @alias compute.urlMaps.validate * @memberOf! () * @@ -85599,46 +75273,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -85657,16 +75304,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -85700,16 +75338,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -85730,16 +75359,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -85759,46 +75379,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -85817,16 +75410,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -85871,16 +75455,7 @@ export namespace compute_alpha { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -86081,8 +75656,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN - * gateways by making a list() request. + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. * @alias compute.vpnGateways.get * @memberOf! () * @@ -86242,8 +75816,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the - * data included in the request. + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. * @alias compute.vpnGateways.insert * @memberOf! () * @@ -86320,8 +75893,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project - * and region. + * @desc Retrieves a list of VPN gateways available to the specified project and region. * @alias compute.vpnGateways.list * @memberOf! () * @@ -86399,8 +75971,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read - * the Labeling Resources documentation. + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -86566,46 +76137,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -86629,16 +76173,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -86701,16 +76236,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -86726,46 +76252,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -86793,16 +76292,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -87008,8 +76498,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available - * VPN tunnels by making a list() request. + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. * @alias compute.vpnTunnels.get * @memberOf! () * @@ -87084,8 +76573,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region - * using the data included in the request. + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. * @alias compute.vpnTunnels.insert * @memberOf! () * @@ -87162,8 +76650,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified - * project and region. + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. * @alias compute.vpnTunnels.list * @memberOf! () * @@ -87241,8 +76728,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.setLabels - * @desc Sets the labels on a VpnTunnel. To learn more about labels, read - * the Labeling Resources documentation. + * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnTunnels.setLabels * @memberOf! () * @@ -87408,46 +76894,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -87471,16 +76930,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -87523,16 +76973,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -87548,46 +76989,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -87615,16 +77029,7 @@ export namespace compute_alpha { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -87821,8 +77226,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified zone. + * @desc Retrieves a list of Operation resources contained within the specified zone. * @alias compute.zoneOperations.list * @memberOf! () * @@ -87901,15 +77305,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.wait - * @desc Waits for the specified zone-specific Operations resource until it - * is done or timeout, and retrieves the specified Operations resource. 1. - * Immediately returns when the operation is already done. 2. Waits for no - * more than the default deadline (2 minutes, subject to change) and then - * returns the current state of the operation, which may be DONE or still in - * progress. 3. Is best-effort: a. The server can wait less than the default - * deadline or zero seconds, in overload situations. b. There is no - * guarantee that the operation is actually done when returns. 4. User - * should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.zoneOperations.wait * @memberOf! () * @@ -88032,46 +77428,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -88112,8 +77481,7 @@ export namespace compute_alpha { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones - * by making a list() request. + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. * @alias compute.zones.get * @memberOf! () * @@ -88184,8 +77552,7 @@ export namespace compute_alpha { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified - * project. + * @desc Retrieves the list of Zone resources available to the specified project. * @alias compute.zones.list * @memberOf! () * @@ -88281,46 +77648,19 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 589f91dfd95..efba5a387bc 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace compute_beta { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace compute_beta { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -157,7 +154,10 @@ export namespace compute_beta { zones: Resource$Zones; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.acceleratorTypes = new Resource$Acceleratortypes(this.context); this.addresses = new Resource$Addresses(this.context); @@ -242,8 +242,7 @@ export namespace compute_beta { } /** - * A specification of the type and number of accelerator cards attached to the - * instance. + * A specification of the type and number of accelerator cards attached to the instance. */ export interface Schema$AcceleratorConfig { /** @@ -251,17 +250,12 @@ export namespace compute_beta { */ acceleratorCount?: number; /** - * Full or partial URL of the accelerator type resource to attach to this - * instance. For example: - * projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 - * If you are creating an instance template, specify only the accelerator - * name. See GPUs on Compute Engine for a full list of accelerator types. + * Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. */ acceleratorType?: string; } /** - * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) - * (== resource_for v1.acceleratorTypes ==) + * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -269,8 +263,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * [Output Only] The deprecation status associated with this accelerator - * type. + * [Output Only] The deprecation status associated with this accelerator type. */ deprecated?: Schema$DeprecationStatus; /** @@ -278,13 +271,11 @@ export namespace compute_beta { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#acceleratorType - * for accelerator types. + * [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. */ kind?: string; /** @@ -300,9 +291,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The name of the zone where the accelerator type resides, - * such as us-central1-a. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -316,17 +305,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$AcceleratorTypesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#acceleratorTypeAggregatedList for aggregated lists of accelerator - * types. + * [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -355,16 +338,11 @@ export namespace compute_beta { */ items?: Schema$AcceleratorType[]; /** - * [Output Only] Type of resource. Always compute#acceleratorTypeList for - * lists of accelerator types. + * [Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -386,8 +364,7 @@ export namespace compute_beta { */ acceleratorTypes?: Schema$AcceleratorType[]; /** - * [Output Only] An informational warning that appears when the accelerator - * types list is empty. + * [Output Only] An informational warning that appears when the accelerator types list is empty. */ warning?: { code?: string; @@ -396,46 +373,31 @@ export namespace compute_beta { }; } /** - * An access configuration attached to an instance's network interface. - * Only one access config per instance is supported. + * An access configuration attached to an instance's network interface. Only one access config per instance is supported. */ export interface Schema$AccessConfig { /** - * [Output Only] Type of the resource. Always compute#accessConfig for - * access configs. + * [Output Only] Type of the resource. Always compute#accessConfig for access configs. */ kind?: string; /** - * The name of this access configuration. The default and recommended name - * is External NAT but you can use any arbitrary string you would like. For - * example, My external IP or Network Access. + * The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. */ name?: string; /** - * An external IP address associated with this instance. Specify an unused - * static external IP address available to the project or leave this field - * undefined to use an IP from a shared ephemeral IP address pool. If you - * specify a static external IP address, it must live in the same region as - * the zone of the instance. + * An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. */ natIP?: string; /** - * This signifies the networking tier used for configuring this access - * configuration and can only take the following values: PREMIUM, STANDARD. - * If an AccessConfig is specified without a valid external IP address, an - * ephemeral IP will be created with this networkTier. If an AccessConfig - * with a valid external IP address is specified, it must match that of the - * networkTier associated with the Address resource owning that IP. + * This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. */ networkTier?: string; /** - * The DNS domain name for the public PTR record. This field can only be set - * when the set_public_ptr field is enabled. + * The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. */ publicPtrDomainName?: string; /** - * Specifies whether a public DNS ?PTR? record should be created to map the - * external IP address of the instance to a DNS domain name. + * Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name. */ setPublicPtr?: boolean; /** @@ -444,9 +406,7 @@ export namespace compute_beta { type?: string; } /** - * A reserved address resource. (== resource_for beta.addresses ==) (== - * resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== - * resource_for v1.globalAddresses ==) + * A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) */ export interface Schema$Address { /** @@ -454,8 +414,7 @@ export namespace compute_beta { */ address?: string; /** - * The type of address to reserve, either INTERNAL or EXTERNAL. If - * unspecified, defaults to EXTERNAL. + * The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. */ addressType?: string; /** @@ -463,18 +422,15 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The IP Version that will be used by this address. Valid options are IPV4 - * or IPV6. This can only be specified for a global address. + * The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ ipVersion?: string; /** @@ -482,44 +438,23 @@ export namespace compute_beta { */ kind?: string; /** - * A fingerprint for the labels being applied to this Address, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an Address. + * A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. */ labelFingerprint?: string; /** - * Labels to apply to this Address resource. These can be later modified by - * the setLabels method. Each label key/value must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network in which to reserve the address. This field can - * only be used with INTERNAL type with VPC_PEERING purpose. + * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. */ network?: string; /** - * This signifies the networking tier used for configuring this Address and - * can only take the following values: PREMIUM, STANDARD. Global forwarding - * rules can only be Premium Tier. Regional forwarding rules can be either - * Premium or Standard Tier. Standard Tier addresses applied to regional - * forwarding rules can be used with any external load balancer. Regional - * forwarding rules in Premium Tier can only be used with a Network load - * balancer. If this field is not specified, it is assumed to be PREMIUM. + * This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ networkTier?: string; /** @@ -531,10 +466,7 @@ export namespace compute_beta { */ purpose?: string; /** - * [Output Only] URL of the region where the regional address resides. This - * field is not applicable to global addresses. You must specify this field - * as part of the HTTP request URL. You cannot set this field in the request - * body. + * [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. */ region?: string; /** @@ -542,18 +474,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The status of the address, which can be one of RESERVING, - * RESERVED, or IN_USE. An address that is RESERVING is currently in the - * process of being reserved. A RESERVED address is currently reserved and - * available to use. An IN_USE address is currently being used by another - * resource and is not available. + * [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. */ status?: string; /** - * The URL of the subnetwork in which to reserve the address. If an IP - * address is specified, it must be within the subnetwork's IP range. - * This field can only be used with INTERNAL type with - * GCE_ENDPOINT/DNS_RESOLVER purposes. + * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. */ subnetwork?: string; /** @@ -571,16 +496,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$AddressesScopedList}; /** - * [Output Only] Type of resource. Always compute#addressAggregatedList for - * aggregated lists of addresses. + * [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -602,8 +522,7 @@ export namespace compute_beta { */ addresses?: Schema$Address[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -624,16 +543,11 @@ export namespace compute_beta { */ items?: Schema$Address[]; /** - * [Output Only] Type of resource. Always compute#addressList for lists of - * addresses. + * [Output Only] Type of resource. Always compute#addressList for lists of addresses. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -654,17 +568,11 @@ export namespace compute_beta { */ export interface Schema$AliasIpRange { /** - * The IP CIDR range represented by this alias IP range. This IP CIDR range - * must belong to the specified subnetwork and cannot contain IP addresses - * reserved by system or used by other network interfaces. This range may be - * a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR - * format string (e.g. 10.1.2.0/24). + * The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). */ ipCidrRange?: string; /** - * Optional subnetwork secondary range name specifying the secondary range - * from which to allocate the IP CIDR range for this alias IP range. If left - * unspecified, the primary range of the subnetwork will be used. + * Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. */ subnetworkRangeName?: string; } @@ -674,9 +582,7 @@ export namespace compute_beta { */ diskSizeGb?: string; /** - * Specifies the disk interface to use for attaching this disk, which is - * either SCSI or NVME. The default is SCSI. For performance characteristics - * of SCSI over NVMe, see Local SSD performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ interface?: string; } @@ -689,14 +595,11 @@ export namespace compute_beta { */ guestAccelerators?: Schema$AcceleratorConfig[]; /** - * Specifies amount of local ssd to reserve with each instance. The type of - * disk is local-ssd. + * Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. */ localSsds?: Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk[]; /** - * Specifies type of machine (name only) which has fixed number of vCPUs and - * fixed amount of memory. This also includes specifying custom machine type - * following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. + * Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. */ machineType?: string; /** @@ -705,8 +608,7 @@ export namespace compute_beta { minCpuPlatform?: string; } /** - * This reservation type allows to pre allocate specific instance - * configuration. + * This reservation type allows to pre allocate specific instance configuration. */ export interface Schema$AllocationSpecificSKUReservation { /** @@ -727,74 +629,39 @@ export namespace compute_beta { */ export interface Schema$AttachedDisk { /** - * Specifies whether the disk will be auto-deleted when the instance is - * deleted (but not when the disk is detached from the instance). + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ autoDelete?: boolean; /** - * Indicates that this is a boot disk. The virtual machine will use the - * first partition of the disk for its root filesystem. + * Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. */ boot?: boolean; /** - * Specifies a unique device name of your choice that is reflected into the - * /dev/disk/by-id/google-* tree of a Linux operating system running within - * the instance. This name can be used to reference the device for mounting, - * resizing, and so on, from within the instance. If not specified, the - * server chooses a default device name to apply to this disk, in the form - * persistent-disk-x, where x is a number assigned by Google Compute Engine. - * This field is only applicable for persistent disks. + * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. */ deviceName?: string; /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If - * you are creating a new disk, this field encrypts the new disk using an - * encryption key that you provide. If you are attaching an existing disk - * that is already encrypted, this field decrypts the disk using the - * customer-supplied encryption key. If you encrypt a disk using a - * customer-supplied key, you must provide the same key again when you - * attempt to use this resource at a later time. For example, you must - * provide the key when you create a snapshot or an image from the disk or - * when you attach the disk to a virtual machine instance. If you do not - * provide an encryption key, then the disk will be encrypted using an - * automatically generated key and you do not need to provide a key to use - * the disk later. Instance templates do not store customer-supplied - * encryption keys, so you cannot use your own keys to encrypt disks in a - * managed instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] A zero-based index to this disk, where 0 is reserved for - * the boot disk. If you have many disks attached to an instance, each disk - * would have a unique index number. + * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. */ index?: number; /** - * [Input Only] Specifies the parameters for a new disk that will be created - * alongside the new instance. Use initialization parameters to create boot - * disks or local SSDs attached to the new instance. This property is - * mutually exclusive with the source property; you can only define one or - * the other, but not both. + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ initializeParams?: Schema$AttachedDiskInitializeParams; /** - * Specifies the disk interface to use for attaching this disk, which is - * either SCSI or NVME. The default is SCSI. Persistent disks must always - * use SCSI and the request will fail if you attempt to attach a persistent - * disk in any other format than SCSI. Local SSDs can use either NVME or - * SCSI. For performance characteristics of SCSI over NVMe, see Local SSD - * performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ interface?: string; /** - * [Output Only] Type of the resource. Always compute#attachedDisk for - * attached disks. + * [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. */ kind?: string; /** @@ -802,32 +669,20 @@ export namespace compute_beta { */ licenses?: string[]; /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - * not specified, the default is to attach the disk in READ_WRITE mode. + * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. */ mode?: string; /** - * Specifies a valid partial or full URL to an existing Persistent Disk - * resource. When creating a new instance, one of - * initializeParams.sourceImage or disks.source is required except for local - * SSD. If desired, you can also attach existing non-root persistent disks - * using this property. This field is only applicable for persistent disks. - * Note that for InstanceTemplate, specify the disk name, not the URL for - * the disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. */ source?: string; /** - * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - * specified, the default is PERSISTENT. + * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. */ type?: string; } /** - * [Input Only] Specifies the parameters for a new disk that will be created - * alongside the new instance. Use initialization parameters to create boot - * disks or local SSDs attached to the new instance. This property is - * mutually exclusive with the source property; you can only define one or the - * other, but not both. + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ export interface Schema$AttachedDiskInitializeParams { /** @@ -835,9 +690,7 @@ export namespace compute_beta { */ description?: string; /** - * Specifies the disk name. If not specified, the default is to use the name - * of the instance. If the disk with the instance name exists already in the - * given zone/region, a new name will be automatically generated. + * Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. */ diskName?: string; /** @@ -845,69 +698,31 @@ export namespace compute_beta { */ diskSizeGb?: string; /** - * Specifies the disk type to use to create the instance. If not specified, - * the default is pd-standard, specified using the full URL. For example: - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard - * Other values include pd-ssd and local-ssd. If you define this field, you - * can provide either the full or partial URL. For example, the following - * are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - * - projects/project/zones/zone/diskTypes/diskType - - * zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is - * the name of the disk type, not URL. + * Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. */ diskType?: string; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. Guest OS features are applied by - * merging initializeParams.guestOsFeatures and disks.guestOsFeatures + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * Labels to apply to this disk. These can be later modified by the - * disks.setLabels method. This field is only applicable for persistent - * disks. + * Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. */ labels?: {[key: string]: string}; /** - * Resource policies applied to this disk for automatic snapshot creations. - * Specified using the full or partial URL. For instance template, specify - * only the resource policy name. + * Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. */ resourcePolicies?: string[]; /** - * The source image to create this disk. When creating a new instance, one - * of initializeParams.sourceImage or disks.source is required except for - * local SSD. To create a disk with one of the public operating system - * images, specify the image by its family name. For example, specify - * family/debian-9 to use the latest Debian 9 image: - * projects/debian-cloud/global/images/family/debian-9 Alternatively, use - * a specific version of a public operating system image: - * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To - * create a disk with a custom image that you created, specify the image - * name in the following format: global/images/my-custom-image You can - * also specify a custom image by its image family, which returns the latest - * version of the image in that family. Replace the image name with - * family/family-name: global/images/family/my-image-family If the source - * image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. Instance - * templates do not store customer-supplied encryption keys, so you cannot - * create disks for instances in a managed instance group if the source - * images are encrypted with your own keys. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The source snapshot to create this disk. When creating a new instance, - * one of initializeParams.sourceSnapshot or disks.source is required except - * for local SSD. To create a disk with a snapshot that you created, - * specify the snapshot name in the following format: - * global/snapshots/my-backup If the source snapshot is deleted later, - * this field will not be set. + * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. */ sourceSnapshot?: string; /** @@ -916,26 +731,7 @@ export namespace compute_beta { sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { "log_type": - * "ADMIN_READ", } ] }, { "service": - * "fooservice.googleapis.com" "audit_log_configs": [ { - * "log_type": "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy - * enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - * foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE - * logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -944,25 +740,16 @@ export namespace compute_beta { auditLogConfigs?: Schema$AuditLogConfig[]; exemptedMembers?: string[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { "log_type": - * "DATA_WRITE", } ] } This enables 'DATA_READ' and - * 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ - * logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of [Binding.members][]. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[]; /** @@ -980,20 +767,11 @@ export namespace compute_beta { permissionType?: string; } /** - * Represents an Autoscaler resource. Autoscalers allow you to automatically - * scale virtual machine instances in managed instance groups according to an - * autoscaling policy that you define. For more information, read Autoscaling - * Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for - * v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== - * resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** - * The configuration parameters for the autoscaling algorithm. You can - * define one or more of the policies for an autoscaler: cpuUtilization, - * customMetricUtilizations, and loadBalancingUtilization. If none of these - * are specified, the default will be to autoscale based on cpuUtilization - * to 0.6 or 60%. + * The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. */ autoscalingPolicy?: Schema$AutoscalingPolicy; /** @@ -1001,33 +779,23 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#autoscaler for - * autoscalers. + * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] URL of the region where the instance group resides (for - * autoscalers living in regional scope). + * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). */ region?: string; /** @@ -1039,9 +807,7 @@ export namespace compute_beta { */ status?: string; /** - * [Output Only] Human-readable details about the current state of the - * autoscaler. Read the documentation for Commonly returned status messages - * for examples of status messages you might encounter. + * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. */ statusDetails?: Schema$AutoscalerStatusDetails[]; /** @@ -1049,8 +815,7 @@ export namespace compute_beta { */ target?: string; /** - * [Output Only] URL of the zone where the instance group resides (for - * autoscalers living in zonal scope). + * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). */ zone?: string; } @@ -1064,16 +829,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$AutoscalersScopedList}; /** - * [Output Only] Type of resource. Always compute#autoscalerAggregatedList - * for aggregated lists of autoscalers. + * [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1102,16 +862,11 @@ export namespace compute_beta { */ items?: Schema$Autoscaler[]; /** - * [Output Only] Type of resource. Always compute#autoscalerList for lists - * of autoscalers. + * [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1133,8 +888,7 @@ export namespace compute_beta { */ autoscalers?: Schema$Autoscaler[]; /** - * [Output Only] Informational warning which replaces the list of - * autoscalers when the list is empty. + * [Output Only] Informational warning which replaces the list of autoscalers when the list is empty. */ warning?: { code?: string; @@ -1157,19 +911,11 @@ export namespace compute_beta { */ export interface Schema$AutoscalingPolicy { /** - * The number of seconds that the autoscaler should wait before it starts - * collecting information from a new instance. This prevents the autoscaler - * from collecting information when the instance is initializing, during - * which the collected usage would not be reliable. The default time - * autoscaler waits is 60 seconds. Virtual machine initialization times - * might vary because of numerous factors. We recommend that you test how - * long an instance may take to initialize. To do this, create an instance - * and time the startup process. + * The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. */ coolDownPeriodSec?: number; /** - * Defines the CPU utilization policy that allows the autoscaler to scale - * based on the average CPU utilization of a managed instance group. + * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. */ cpuUtilization?: Schema$AutoscalingPolicyCpuUtilization; /** @@ -1181,15 +927,11 @@ export namespace compute_beta { */ loadBalancingUtilization?: Schema$AutoscalingPolicyLoadBalancingUtilization; /** - * The maximum number of instances that the autoscaler can scale up to. This - * is required when creating or updating an autoscaler. The maximum number - * of replicas should not be lower than minimal number of replicas. + * The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. */ maxNumReplicas?: number; /** - * The minimum number of replicas that the autoscaler can scale down to. - * This cannot be less than 0. If not provided, autoscaler will choose a - * default value depending on maximum number of instances allowed. + * The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. */ minNumReplicas?: number; } @@ -1198,15 +940,7 @@ export namespace compute_beta { */ export interface Schema$AutoscalingPolicyCpuUtilization { /** - * The target CPU utilization that the autoscaler should maintain. Must be a - * float value in the range (0, 1]. If not specified, the default is 0.6. If - * the CPU level is below the target utilization, the autoscaler scales down - * the number of instances until it reaches the minimum number of instances - * you specified or until the average CPU of your instances reaches the - * target utilization. If the average CPU is above the target utilization, - * the autoscaler scales up until it reaches the maximum number of instances - * you specified or until the average utilization reaches the target - * utilization. + * The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. */ utilizationTarget?: number; } @@ -1215,64 +949,23 @@ export namespace compute_beta { */ export interface Schema$AutoscalingPolicyCustomMetricUtilization { /** - * A filter string, compatible with a Stackdriver Monitoring filter string - * for TimeSeries.list API call. This filter is used to select a specific - * TimeSeries for the purpose of autoscaling and to determine whether the - * metric is exporting per-instance or per-group data. For the filter to be - * valid for autoscaling purposes, the following rules apply: - You can - * only use the AND operator for joining selectors. - You can only use - * direct equality comparison operator (=) without any functions for each - * selector. - You can specify the metric in both the filter string and in - * the metric field. However, if specified in both places, the metric must - * be identical. - The monitored resource type determines what kind of - * values are expected for the metric. If it is a gce_instance, the - * autoscaler expects the metric to include a separate TimeSeries for each - * instance in a group. In such a case, you cannot filter on resource - * labels. If the resource type is any other value, the autoscaler expects - * this metric to contain values that apply to the entire autoscaled - * instance group and resource label filtering can be performed to point - * autoscaler at the correct TimeSeries to scale upon. This is called a - * per-group metric for the purpose of autoscaling. If not specified, the - * type defaults to gce_instance. You should provide a filter that is - * selective enough to pick just one TimeSeries for the autoscaled group or - * for each of the instances (if you are using gce_instance resource type). - * If multiple TimeSeries are returned upon the query execution, the - * autoscaler will sum their respective values to obtain its scaling value. + * A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value. */ filter?: string; /** - * The identifier (type) of the Stackdriver Monitoring metric. The metric - * cannot have negative values. The metric must have a value type of INT64 - * or DOUBLE. + * The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. */ metric?: string; /** - * If scaling is based on a per-group metric value that represents the total - * amount of work to be done or resource usage, set this value to an amount - * assigned for a single instance of the scaled group. Autoscaler will keep - * the number of instances proportional to the value of this metric, the - * metric itself should not change value due to group resizing. A good - * metric to use with the target is for example - * pubsub.googleapis.com/subscription/num_undelivered_messages or a custom - * metric exporting the total number of requests coming to your instances. - * A bad example would be a metric exporting an average or median latency, - * since this value can't include a chunk assignable to a single - * instance, it could be better used with utilization_target instead. + * If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead. */ singleInstanceAssignment?: number; /** - * The target value of the metric that autoscaler should maintain. This must - * be a positive value. A utilization metric scales number of virtual - * machines handling requests to increase or decrease proportionally to the - * metric. For example, a good metric to use as a utilization_target is - * compute.googleapis.com/instance/network/received_bytes_count. The - * autoscaler will work to keep this value constant for each of the - * instances. + * The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances. */ utilizationTarget?: number; /** - * Defines how target utilization value is expressed for a Stackdriver - * Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + * Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. */ utilizationTargetType?: string; } @@ -1281,9 +974,7 @@ export namespace compute_beta { */ export interface Schema$AutoscalingPolicyLoadBalancingUtilization { /** - * Fraction of backend capacity utilization (set in HTTP(S) load balancing - * configuration) that autoscaler should maintain. Must be a positive float - * value. If not defined, the default is 0.8. + * Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. */ utilizationTarget?: number; } @@ -1292,100 +983,51 @@ export namespace compute_beta { */ export interface Schema$Backend { /** - * Specifies the balancing mode for this backend. For global HTTP(S) or - * TCP/SSL load balancing, the default is UTILIZATION. Valid values are - * UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For - * Internal Load Balancing, the default and only supported mode is - * CONNECTION. + * Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION. */ balancingMode?: string; /** - * A multiplier applied to the group's maximum servicing capacity (based - * on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the - * group will serve up to 100% of its configured capacity (depending on - * balancingMode). A setting of 0 means the group is completely drained, - * offering 0% of its available Capacity. Valid range is [0.0,1.0]. This - * cannot be used for internal load balancing. + * A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing. */ capacityScaler?: number; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * This field designates whether this is a failover backend. More than one - * failover backend can be configured for a given BackendService. + * This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. */ failover?: boolean; /** - * The fully-qualified URL of an Instance Group or Network Endpoint Group - * resource. In case of instance group this defines the list of instances - * that serve traffic. Member virtual machine instances from each instance - * group must live in the same zone as the instance group itself. No two - * backends in a backend service are allowed to use same Instance Group - * resource. For Network Endpoint Groups this defines list of endpoints. - * All endpoints of Network Endpoint Group must be hosted on instances - * located in the same zone as the Network Endpoint Group. Backend service - * can not contain mix of Instance Group and Network Endpoint Group - * backends. Note that you must specify an Instance Group or Network - * Endpoint Group resource using the fully-qualified URL, rather than a - * partial URL. When the BackendService has load balancing scheme INTERNAL, - * the instance group must be within the same region as the BackendService. - * Network Endpoint Groups are not supported for INTERNAL load balancing - * scheme. + * The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend service can not contain mix of Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL. When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme. */ group?: string; /** - * The max number of simultaneous connections for the group. Can be used - * with either CONNECTION or UTILIZATION balancing modes. For CONNECTION - * mode, either maxConnections or maxConnectionsPerInstance must be set. - * This cannot be used for internal load balancing. + * The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. */ maxConnections?: number; /** - * The max number of simultaneous connections that a single backend network - * endpoint can handle. This is used to calculate the capacity of the group. - * Can be used in either CONNECTION or UTILIZATION balancing modes. For - * CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must - * be set. This cannot be used for internal load balancing. + * The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. This cannot be used for internal load balancing. */ maxConnectionsPerEndpoint?: number; /** - * The max number of simultaneous connections that a single backend instance - * can handle. This is used to calculate the capacity of the group. Can be - * used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION - * mode, either maxConnections or maxConnectionsPerInstance must be set. - * This cannot be used for internal load balancing. + * The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. */ maxConnectionsPerInstance?: number; /** - * The max requests per second (RPS) of the group. Can be used with either - * RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE - * mode, either maxRate or maxRatePerInstance must be set. This cannot be - * used for internal load balancing. + * The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ maxRate?: number; /** - * The max requests per second (RPS) that a single backend network endpoint - * can handle. This is used to calculate the capacity of the group. Can be - * used in either balancing mode. For RATE mode, either maxRate or - * maxRatePerEndpoint must be set. This cannot be used for internal load - * balancing. + * The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. This cannot be used for internal load balancing. */ maxRatePerEndpoint?: number; /** - * The max requests per second (RPS) that a single backend instance can - * handle. This is used to calculate the capacity of the group. Can be used - * in either balancing mode. For RATE mode, either maxRate or - * maxRatePerInstance must be set. This cannot be used for internal load - * balancing. + * The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ maxRatePerInstance?: number; /** - * Used when balancingMode is UTILIZATION. This ratio defines the CPU - * utilization target for the group. The default is 0.8. Valid range is - * [0.0, 1.0]. This cannot be used for internal load balancing. + * Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing. */ maxUtilization?: number; } @@ -1406,8 +1048,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** @@ -1423,13 +1064,7 @@ export namespace compute_beta { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -1442,13 +1077,7 @@ export namespace compute_beta { */ export interface Schema$BackendBucketCdnPolicy { /** - * Maximum number of seconds the response to a signed URL request will be - * considered fresh. After this time period, the response will be - * revalidated before being served. Defaults to 1hr (3600s). When serving - * responses to signed URL requests, Cloud CDN will internally behave as - * though all responses from this backend had a "Cache-Control: public, - * max-age=[TTL]" header, regardless of any existing Cache-Control - * header. The actual headers served in responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** @@ -1473,11 +1102,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1494,17 +1119,11 @@ export namespace compute_beta { }; } /** - * A BackendService resource. This resource defines a group of backend virtual - * machines and their serving capacity. (== resource_for v1.backendService ==) - * (== resource_for beta.backendService ==) + * A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) */ export interface Schema$BackendService { /** - * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. - * If set to 0, the cookie is non-persistent and lasts only until the end of - * the browser session (or equivalent). The maximum allowed value for TTL is - * one day. When the load balancing scheme is INTERNAL, this field is not - * used. + * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used. */ affinityCookieTtlSec?: number; /** @@ -1525,98 +1144,61 @@ export namespace compute_beta { */ customRequestHeaders?: string[]; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * If true, enable Cloud CDN for this BackendService. When the load - * balancing scheme is INTERNAL, this field is not used. + * If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used. */ enableCDN?: boolean; failoverPolicy?: Schema$BackendServiceFailoverPolicy; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a BackendService. An up-to-date fingerprint must - * be provided in order to update the BackendService, otherwise the request - * will fail with error 412 conditionNotMet. To see the latest fingerprint, - * make a get() request to retrieve a BackendService. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. */ fingerprint?: string; /** - * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for - * health checking this BackendService. Currently at most one health check - * can be specified, and a health check is required for Compute Engine - * backend services. A health check must not be specified for App Engine - * backend and Cloud Function backend. For internal load balancing, a URL - * to a HealthCheck resource must be specified instead. + * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ healthChecks?: string[]; iap?: Schema$BackendServiceIAP; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#backendService for backend - * services. + * [Output Only] Type of resource. Always compute#backendService for backend services. */ kind?: string; /** - * Indicates whether the backend service will be used with internal or - * external load balancing. A backend service created for one type of load - * balancing cannot be used with the other. Possible values are INTERNAL and - * EXTERNAL. + * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. */ loadBalancingScheme?: string; /** - * This field denotes the logging options for the load balancer traffic - * served by this backend service. If logging is enabled, logs will be - * exported to Stackdriver. + * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. */ logConfig?: Schema$BackendServiceLogConfig; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Deprecated in favor of portName. The TCP port to connect on the backend. - * The default value is 80. This cannot be used for internal load - * balancing. + * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used for internal load balancing. */ port?: number; /** - * Name of backend port. The same name should appear in the instance groups - * referenced by this service. Required when the load balancing scheme is - * EXTERNAL. When the load balancing scheme is INTERNAL, this field is not - * used. + * Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used. */ portName?: string; /** - * The protocol this BackendService uses to communicate with backends. - * Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For - * internal load balancing, the possible values are TCP and UDP, and the - * default is TCP. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP. */ protocol?: string; /** - * [Output Only] URL of the region where the regional backend service - * resides. This field is not applicable to global backend services. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * [Output Only] The resource URL for the security policy associated with - * this backend service. + * [Output Only] The resource URL for the security policy associated with this backend service. */ securityPolicy?: string; /** @@ -1624,16 +1206,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * Type of session affinity to use. The default is NONE. When the load - * balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or - * GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be - * NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the - * protocol is UDP, this field is not used. + * Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used. */ sessionAffinity?: string; /** - * How many seconds to wait for the backend before considering it a failed - * request. Default is 30 seconds. + * How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. */ timeoutSec?: number; } @@ -1654,11 +1231,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1683,13 +1256,7 @@ export namespace compute_beta { */ cacheKeyPolicy?: Schema$CacheKeyPolicy; /** - * Maximum number of seconds the response to a signed URL request will be - * considered fresh. After this time period, the response will be - * revalidated before being served. Defaults to 1hr (3600s). When serving - * responses to signed URL requests, Cloud CDN will internally behave as - * though all responses from this backend had a "Cache-Control: public, - * max-age=[TTL]" header, regardless of any existing Cache-Control - * header. The actual headers served in responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** @@ -1699,43 +1266,25 @@ export namespace compute_beta { } export interface Schema$BackendServiceFailoverPolicy { /** - * On failover or failback, this field indicates whether connection drain - * will be honored. Setting this to true has the following effect: - * connections to the old active pool are not drained. Connections to the - * new active pool use the timeout of 10 min (currently fixed). Setting to - * false has the following effect: both old and new connections will have a - * drain timeout of 10 min. This can be set to true only if the protocol is - * TCP. The default is false. + * On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false. */ disableConnectionDrainOnFailover?: boolean; /** - * This option is used only when no healthy VMs are detected in the primary - * and backup instance groups. When set to true, traffic is dropped. When - * set to false, new connections are sent across all VMs in the primary - * group. The default is false. + * This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false. */ dropTrafficIfUnhealthy?: boolean; /** - * The value of the field must be in [0, 1]. If the ratio of the healthy VMs - * in the primary backend is at or below this number, traffic arriving at - * the load-balanced IP will be directed to the failover backend. In case - * where 'failoverRatio' is not set or all the VMs in the backup - * backend are unhealthy, the traffic will be directed back to the primary - * backend in the "force" mode, where traffic will be spread to - * the healthy VMs with the best effort, or to all VMs when no VM is - * healthy. This field is only used with l4 load balancing. + * The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing. */ failoverRatio?: number; } export interface Schema$BackendServiceGroupHealth { /** - * Health state of the backend instances or endpoints in requested instance - * or network endpoint group, determined based on configured health checks. + * Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. */ healthStatus?: Schema$HealthStatus[]; /** - * [Output Only] Type of resource. Always compute#backendServiceGroupHealth - * for the health of backend services. + * [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. */ kind?: string; } @@ -1764,16 +1313,11 @@ export namespace compute_beta { */ items?: Schema$BackendService[]; /** - * [Output Only] Type of resource. Always compute#backendServiceList for - * lists of backend services. + * [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1790,21 +1334,15 @@ export namespace compute_beta { }; } /** - * The available logging options for the load balancer traffic served by this - * backend service. + * The available logging options for the load balancer traffic served by this backend service. */ export interface Schema$BackendServiceLogConfig { /** - * This field denotes whether to enable logging for the load balancer - * traffic served by this backend service. + * This field denotes whether to enable logging for the load balancer traffic served by this backend service. */ enable?: boolean; /** - * This field can only be specified if logging is enabled for this backend - * service. The value of the field must be in [0, 1]. This configures the - * sampling rate of requests to the load balancer where 1.0 means all logged - * requests are reported and 0.0 means no logged requests are reported. The - * default value is 1.0. + * This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0. */ sampleRate?: number; } @@ -1817,8 +1355,7 @@ export namespace compute_beta { */ backendServices?: Schema$BackendService[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -1831,44 +1368,27 @@ export namespace compute_beta { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or without - * a Google account. * `allAuthenticatedUsers`: A special identifier that - * represents anyone who is authenticated with a Google account or a service - * account. * `user:{emailid}`: An email address that represents a specific - * Google account. For example, `alice@gmail.com` . * - * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } export interface Schema$CacheInvalidationRule { /** - * If set, this invalidation rule will only apply to requests with a Host - * header matching host. + * If set, this invalidation rule will only apply to requests with a Host header matching host. */ host?: string; path?: string; } /** - * Message containing what to include in the cache key for a request for Cloud - * CDN. + * Message containing what to include in the cache key for a request for Cloud CDN. */ export interface Schema$CacheKeyPolicy { /** @@ -1880,37 +1400,20 @@ export namespace compute_beta { */ includeProtocol?: boolean; /** - * If true, include query string parameters in the cache key according to - * query_string_whitelist and query_string_blacklist. If neither is set, the - * entire query string will be included. If false, the query string will be - * excluded from the cache key entirely. + * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. */ includeQueryString?: boolean; /** - * Names of query string parameters to exclude in cache keys. All other - * parameters will be included. Either specify query_string_whitelist or - * query_string_blacklist, not both. '&' and '=' will be - * percent encoded and not treated as delimiters. + * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ queryStringBlacklist?: string[]; /** - * Names of query string parameters to include in cache keys. All other - * parameters will be excluded. Either specify query_string_whitelist or - * query_string_blacklist, not both. '&' and '=' will be - * percent encoded and not treated as delimiters. + * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ queryStringWhitelist?: string[]; } /** - * Represents a Commitment resource. Creating a Commitment resource means that - * you are purchasing a committed use contract with an explicit start and end - * time. You can create commitments based on vCPUs and memory usage and - * receive discounted rates. For full details, read Signing Up for Committed - * Use Discounts. Committed use discounts are subject to Google Cloud - * Platform's Service Specific Terms. By purchasing a committed use - * discount, you agree to these terms. Committed use discounts will not renew, - * so you must purchase a new commitment to continue receiving discounts. (== - * resource_for beta.commitments ==) (== resource_for v1.commitments ==) + * Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments ==) (== resource_for v1.commitments ==) */ export interface Schema$Commitment { /** @@ -1918,8 +1421,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -1927,29 +1429,19 @@ export namespace compute_beta { */ endTimestamp?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#commitment for - * commitments. + * [Output Only] Type of the resource. Always compute#commitment for commitments. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The plan for this commitment, which determines duration and discount - * rate. The currently supported plans are TWELVE_MONTH (1 year), and - * THIRTY_SIX_MONTH (3 years). + * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ plan?: string; /** @@ -1961,8 +1453,7 @@ export namespace compute_beta { */ reservations?: Schema$Reservation[]; /** - * A list of commitment amounts for particular resources. Note that VCPU and - * MEMORY resource commitments must occur together. + * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. */ resources?: Schema$ResourceCommitment[]; /** @@ -1974,9 +1465,7 @@ export namespace compute_beta { */ startTimestamp?: string; /** - * [Output Only] Status of the commitment with regards to eventual - * expiration (each commitment has an end date defined). One of the - * following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. */ status?: string; /** @@ -1994,16 +1483,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$CommitmentsScopedList}; /** - * [Output Only] Type of resource. Always compute#commitmentAggregatedList - * for aggregated lists of commitments. + * [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2032,16 +1516,11 @@ export namespace compute_beta { */ items?: Schema$Commitment[]; /** - * [Output Only] Type of resource. Always compute#commitmentList for lists - * of commitments. + * [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2063,8 +1542,7 @@ export namespace compute_beta { */ commitments?: Schema$Commitment[]; /** - * [Output Only] Informational warning which replaces the list of - * commitments when the list is empty. + * [Output Only] Informational warning which replaces the list of commitments when the list is empty. */ warning?: { code?: string; @@ -2089,8 +1567,7 @@ export namespace compute_beta { */ svc?: string; /** - * Trusted attributes supplied by any service that owns resources and uses - * the IAM system for access control. + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ sys?: string; /** @@ -2103,8 +1580,7 @@ export namespace compute_beta { */ export interface Schema$ConnectionDraining { /** - * Time for which instance will be drained (not accept new connections, but - * still work to finish started). + * Time for which instance will be drained (not accept new connections, but still work to finish started). */ drainingTimeoutSec?: number; } @@ -2117,36 +1593,25 @@ export namespace compute_beta { */ kmsKeyName?: string; /** - * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - * base64 to either encrypt or decrypt this resource. + * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. */ rawKey?: string; /** - * Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit - * customer-supplied encryption key to either encrypt or decrypt this - * resource. The key must meet the following requirements before you can - * provide it to Compute Engine: - The key is wrapped using a RSA public - * key certificate provided by Google. - After being wrapped, the key must - * be encoded in RFC 4648 base64 encoding. Gets the RSA public key - * certificate provided by Google at: - * https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + * Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: - The key is wrapped using a RSA public key certificate provided by Google. - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem */ rsaEncryptedKey?: string; /** - * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the - * customer-supplied encryption key that protects this resource. + * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. */ sha256?: string; } export interface Schema$CustomerEncryptionKeyProtectedDisk { /** - * Decrypts data associated with the disk with a customer-supplied - * encryption key. + * Decrypts data associated with the disk with a customer-supplied encryption key. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * Specifies a valid partial or full URL to an existing Persistent Disk - * resource. This field is only applicable for persistent disks. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. */ source?: string; } @@ -2155,43 +1620,28 @@ export namespace compute_beta { */ export interface Schema$DeprecationStatus { /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to DELETED. This is only informational and - * the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. */ deleted?: string; /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to DEPRECATED. This is only informational - * and the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. */ deprecated?: string; /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to OBSOLETE. This is only informational - * and the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. */ obsolete?: string; /** - * The URL of the suggested replacement for a deprecated resource. The - * suggested replacement resource must be the same kind of resource as the - * deprecated resource. + * The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. */ replacement?: string; /** - * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, - * OBSOLETE, or DELETED. Operations which communicate the end of life date - * for an image, can use ACTIVE. Operations which create a new resource - * using a DEPRECATED resource will return successfully, but with a warning - * indicating the deprecated resource and recommending its replacement. - * Operations which use OBSOLETE or DELETED resources will be rejected and - * result in an error. + * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. */ state?: string; } /** - * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks - * ==) + * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==) */ export interface Schema$Disk { /** @@ -2199,30 +1649,19 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Encrypts the disk using a customer-supplied encryption key. After you - * encrypt a disk with a customer-supplied key, you must provide the same - * key if you use the disk later (e.g. to create a disk snapshot or an - * image, or to attach the disk to a virtual machine). Customer-supplied - * encryption keys do not protect access to metadata of the disk. If you do - * not provide an encryption key when creating the disk, then the disk will - * be encrypted using an automatically generated key and you do not need to - * provide a key to use the disk later. + * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -2230,18 +1669,11 @@ export namespace compute_beta { */ kind?: string; /** - * A fingerprint for the labels being applied to this disk, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a disk. + * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. */ labelFingerprint?: string; /** - * Labels to apply to this disk. These can be later modified by the - * setLabels method. + * Labels to apply to this disk. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** @@ -2253,8 +1685,7 @@ export namespace compute_beta { */ lastDetachTimestamp?: string; /** - * Integer license codes indicating which licenses are attached to this - * disk. + * Integer license codes indicating which licenses are attached to this disk. */ licenseCodes?: string[]; /** @@ -2262,13 +1693,7 @@ export namespace compute_beta { */ licenses?: string[]; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -2276,22 +1701,15 @@ export namespace compute_beta { */ options?: string; /** - * Physical block size of the persistent disk, in bytes. If not present in a - * request, a default value is used. Currently supported sizes are 4096 and - * 16384, other sizes may be added in the future. If an unsupported value is - * requested, the error message will list the supported values for the - * caller's project. + * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. */ physicalBlockSizeBytes?: string; /** - * [Output Only] URL of the region where the disk resides. Only applicable - * for regional resources. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * URLs of the zones where the disk should be replicated to. Only applicable - * for regional resources. + * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ replicaZones?: string[]; /** @@ -2303,62 +1721,31 @@ export namespace compute_beta { */ selfLink?: string; /** - * Size of the persistent disk, specified in GB. You can specify this field - * when creating a persistent disk using the sourceImage or sourceSnapshot - * parameter, or specify it alone to create an empty persistent disk. If - * you specify this field along with sourceImage or sourceSnapshot, the - * value of sizeGb must not be less than the size of the sourceImage or the - * size of the snapshot. Acceptable values are 1 to 65536, inclusive. + * Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. */ sizeGb?: string; /** - * The source image used to create this disk. If the source image is - * deleted, this field will not be set. To create a disk with one of the - * public operating system images, specify the image by its family name. For - * example, specify family/debian-9 to use the latest Debian 9 image: - * projects/debian-cloud/global/images/family/debian-9 Alternatively, use - * a specific version of a public operating system image: - * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To - * create a disk with a custom image that you created, specify the image - * name in the following format: global/images/my-custom-image You can - * also specify a custom image by its image family, which returns the latest - * version of the image in that family. Replace the image name with - * family/family-name: global/images/family/my-image-family + * The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the image used to create this disk. This - * value identifies the exact image that was used to create this persistent - * disk. For example, if you created the persistent disk from an image that - * was later deleted and recreated under the same name, the source image ID - * would identify the exact version of the image that was used. + * [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. */ sourceImageId?: string; /** - * The source snapshot used to create this disk. You can provide this as a - * partial or full URL to the resource. For example, the following are valid - * values: - - * https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - * - projects/project/global/snapshots/snapshot - global/snapshots/snapshot + * The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot */ sourceSnapshot?: string; /** - * The customer-supplied encryption key of the source snapshot. Required if - * the source snapshot is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The unique ID of the snapshot used to create this disk. - * This value identifies the exact snapshot that was used to create this - * persistent disk. For example, if you created the persistent disk from a - * snapshot that was later deleted and recreated under the same name, the - * source snapshot ID would identify the exact version of the snapshot that - * was used. + * [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. */ sourceSnapshotId?: string; /** @@ -2370,20 +1757,15 @@ export namespace compute_beta { */ storageType?: string; /** - * URL of the disk type resource describing which disk type to use to create - * the disk. Provide this when creating the disk. For example: - * project/zones/zone/diskTypes/pd-standard or pd-ssd + * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd */ type?: string; /** - * [Output Only] Links to the users of the disk (attached instances) in - * form: project/zones/zone/instances/instance + * [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance */ users?: string[]; /** - * [Output Only] URL of the zone where the disk resides. You must specify - * this field as part of the HTTP request URL. It is not settable as a field - * in the request body. + * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -2397,16 +1779,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$DisksScopedList}; /** - * [Output Only] Type of resource. Always compute#diskAggregatedList for - * aggregated lists of persistent disks. + * [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2423,37 +1800,23 @@ export namespace compute_beta { }; } /** - * A specification of the desired way to instantiate a disk in the instance - * template when its created from a source instance. + * A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. */ export interface Schema$DiskInstantiationConfig { /** - * Specifies whether the disk will be auto-deleted when the instance is - * deleted (but not when the disk is detached from the instance). + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ autoDelete?: boolean; /** - * The custom source image to be used to restore this disk when - * instantiating this instance template. + * The custom source image to be used to restore this disk when instantiating this instance template. */ customImage?: string; /** - * Specifies the device name of the disk to which the configurations apply - * to. + * Specifies the device name of the disk to which the configurations apply to. */ deviceName?: string; /** - * Specifies whether to include the disk and what image to use. Possible - * values are: - source-image: to use the same image that was used to - * create the source instance's corresponding disk. Applicable to the - * boot disk and additional read-write disks. - source-image-family: to use - * the same image family that was used to create the source instance's - * corresponding disk. Applicable to the boot disk and additional read-write - * disks. - custom-image: to use a user-provided image url for disk - * creation. Applicable to the boot disk and additional read-write disks. - - * attach-read-only: to attach a read-only disk. Applicable to read-only - * disks. - do-not-include: to exclude a disk from the template. Applicable - * to additional read-write disks, local SSDs, and read-only disks. + * Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. */ instantiateFrom?: string; } @@ -2470,16 +1833,11 @@ export namespace compute_beta { */ items?: Schema$Disk[]; /** - * [Output Only] Type of resource. Always compute#diskList for lists of - * disks. + * [Output Only] Type of resource. Always compute#diskList for lists of disks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2497,17 +1855,11 @@ export namespace compute_beta { } export interface Schema$DiskMoveRequest { /** - * The URL of the destination zone to move the disk. This can be a full or - * partial URL. For example, the following are all valid URLs to a zone: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone - - * projects/project/zones/zone - zones/zone + * The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone */ destinationZone?: string; /** - * The URL of the target disk to move. This can be a full or partial URL. - * For example, the following are all valid URLs to a disk: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + * The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ targetDisk?: string; } @@ -2535,8 +1887,7 @@ export namespace compute_beta { */ disks?: Schema$Disk[]; /** - * [Output Only] Informational warning which replaces the list of disks when - * the list is empty. + * [Output Only] Informational warning which replaces the list of disks when the list is empty. */ warning?: { code?: string; @@ -2545,8 +1896,7 @@ export namespace compute_beta { }; } /** - * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for - * v1.diskTypes ==) + * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) */ export interface Schema$DiskType { /** @@ -2566,13 +1916,11 @@ export namespace compute_beta { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#diskType for disk - * types. + * [Output Only] Type of the resource. Always compute#diskType for disk types. */ kind?: string; /** @@ -2580,9 +1928,7 @@ export namespace compute_beta { */ name?: string; /** - * [Output Only] URL of the region where the disk type resides. Only - * applicable for regional resources. You must specify this field as part of - * the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -2590,14 +1936,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] An optional textual description of the valid disk size, - * such as "10GB-10TB". + * [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". */ validDiskSize?: string; /** - * [Output Only] URL of the zone where the disk type resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -2615,11 +1958,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2648,16 +1987,11 @@ export namespace compute_beta { */ items?: Schema$DiskType[]; /** - * [Output Only] Type of resource. Always compute#diskTypeList for disk - * types. + * [Output Only] Type of resource. Always compute#diskTypeList for disk types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2679,8 +2013,7 @@ export namespace compute_beta { */ diskTypes?: Schema$DiskType[]; /** - * [Output Only] Informational warning which replaces the list of disk types - * when the list is empty. + * [Output Only] Informational warning which replaces the list of disk types when the list is empty. */ warning?: { code?: string; @@ -2699,15 +2032,13 @@ export namespace compute_beta { } export interface Schema$DistributionPolicy { /** - * Zones where the regional managed instance group will create and manage - * instances. + * Zones where the regional managed instance group will create and manage instances. */ zones?: Schema$DistributionPolicyZoneConfiguration[]; } export interface Schema$DistributionPolicyZoneConfiguration { /** - * The URL of the zone. The zone must exist in the region where the managed - * instance group is located. + * The URL of the zone. The zone must exist in the region where the managed instance group is located. */ zone?: string; } @@ -2743,16 +2074,11 @@ export namespace compute_beta { */ items?: Schema$ExchangedPeeringRoute[]; /** - * [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList - * for exchanged peering routes lists. + * [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2769,41 +2095,28 @@ export namespace compute_beta { }; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * External VPN gateway is the on-premises VPN gateway(s) or another cloud - * provider?s VPN gateway that connects to your Google Cloud VPN gateway. To - * create a highly available VPN from Google Cloud to your on-premises side or - * another Cloud provider's VPN gateway, you must create a external VPN - * gateway resource in GCP, which provides the information to GCP about your - * external VPN gateway. + * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. */ export interface Schema$ExternalVpnGateway { /** @@ -2811,13 +2124,11 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -2825,35 +2136,19 @@ export namespace compute_beta { */ interfaces?: Schema$ExternalVpnGatewayInterface[]; /** - * [Output Only] Type of the resource. Always compute#externalVpnGateway for - * externalVpnGateways. + * [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. */ kind?: string; /** - * A fingerprint for the labels being applied to this ExternalVpnGateway, - * which is essentially a hash of the labels set used for optimistic - * locking. The fingerprint is initially generated by Compute Engine and - * changes after every request to modify or update labels. You must always - * provide an up-to-date fingerprint hash in order to update or change - * labels, otherwise the request will fail with error 412 conditionNotMet. - * To see the latest fingerprint, make a get() request to retrieve an - * ExternalVpnGateway. + * A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. */ labelFingerprint?: string; /** - * Labels to apply to this ExternalVpnGateway resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this ExternalVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -2870,17 +2165,11 @@ export namespace compute_beta { */ export interface Schema$ExternalVpnGatewayInterface { /** - * The numeric ID of this interface. The allowed input values for this id - * for different redundancy types of external VPN gateway: - * SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 - * FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 + * The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 */ id?: number; /** - * IP address of the interface in the external VPN gateway. Only IPv4 is - * supported. This IP address can be either from your on-premise gateway or - * another Cloud provider?s VPN gateway, it cannot be an IP address from - * Google Compute Engine. + * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. */ ipAddress?: string; } @@ -2898,16 +2187,11 @@ export namespace compute_beta { */ items?: Schema$ExternalVpnGateway[]; /** - * [Output Only] Type of resource. Always compute#externalVpnGatewayList for - * lists of externalVpnGateways. + * [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2928,8 +2212,7 @@ export namespace compute_beta { */ export interface Schema$Firewall { /** - * The list of ALLOW rules specified by this firewall. Each rule specifies a - * protocol and port-range tuple that describes a permitted connection. + * The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. */ allowed?: Array<{IPProtocol?: string; ports?: string[]}>; /** @@ -2937,84 +2220,51 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * The list of DENY rules specified by this firewall. Each rule specifies a - * protocol and port-range tuple that describes a denied connection. + * The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. */ denied?: Array<{IPProtocol?: string; ports?: string[]}>; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * If destination ranges are specified, the firewall will apply only to - * traffic that has destination IP address in these ranges. These ranges - * must be expressed in CIDR format. Only IPv4 is supported. + * If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ destinationRanges?: string[]; /** - * Direction of traffic to which this firewall applies; default is INGRESS. - * Note: For INGRESS traffic, it is NOT supported to specify - * destinationRanges; For EGRESS traffic, it is NOT supported to specify - * sourceRanges OR sourceTags. + * Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. */ direction?: string; /** - * Denotes whether the firewall rule is disabled, i.e not applied to the - * network it is associated with. When set to true, the firewall rule is not - * enforced and the network behaves as if it did not exist. If this is - * unspecified, the firewall rule will be enabled. + * Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ disabled?: boolean; /** - * Deprecated in favor of enable in LogConfig. This field denotes whether to - * enable logging for a particular firewall rule. If logging is enabled, - * logs will be exported to Stackdriver. + * Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ enableLogging?: boolean; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#firewall for firewall - * rules. + * [Output Only] Type of the resource. Always compute#firewall for firewall rules. */ kind?: string; /** - * This field denotes the logging options for a particular firewall rule. If - * logging is enabled, logs will be exported to Stackdriver. + * This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ logConfig?: Schema$FirewallLogConfig; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network resource for this firewall rule. If not specified when - * creating a firewall rule, the default network is used: - * global/networks/default If you choose to specify this property, you can - * specify the network as a full or partial URL. For example, the following - * are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - * - projects/myproject/global/networks/my-network - - * global/networks/default + * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string; /** - * Priority for this rule. This is an integer between 0 and 65535, both - * inclusive. When not specified, the value assumed is 1000. Relative - * priorities determine precedence of conflicting rules. Lower value of - * priority implies higher precedence (eg, a rule with priority 0 has higher - * precedence than a rule with priority 1). DENY rules take precedence over - * ALLOW rules having equal priority. + * Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. */ priority?: number; /** @@ -3022,59 +2272,23 @@ export namespace compute_beta { */ selfLink?: string; /** - * If source ranges are specified, the firewall will apply only to traffic - * that has source IP address in these ranges. These ranges must be - * expressed in CIDR format. One or both of sourceRanges and sourceTags may - * be set. If both properties are set, the firewall will apply to traffic - * that has source IP address within sourceRanges OR the source IP that - * belongs to a tag listed in the sourceTags property. The connection does - * not need to match both properties for the firewall to apply. Only IPv4 is - * supported. + * If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. */ sourceRanges?: string[]; /** - * If source service accounts are specified, the firewall will apply only to - * traffic originating from an instance with a service account in this list. - * Source service accounts cannot be used to control traffic to an - * instance's external IP address because service accounts are - * associated with an instance, not an IP address. sourceRanges can be set - * at the same time as sourceServiceAccounts. If both are set, the firewall - * will apply to traffic that has source IP address within sourceRanges OR - * the source IP belongs to an instance with service account listed in - * sourceServiceAccount. The connection does not need to match both - * properties for the firewall to apply. sourceServiceAccounts cannot be - * used at the same time as sourceTags or targetTags. + * If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ sourceServiceAccounts?: string[]; /** - * If source tags are specified, the firewall rule applies only to traffic - * with source IPs that match the primary network interfaces of VM instances - * that have the tag and are in the same VPC network. Source tags cannot be - * used to control traffic to an instance's external IP address, it only - * applies to traffic between instances in the same virtual network. Because - * tags are associated with instances, not IP addresses. One or both of - * sourceRanges and sourceTags may be set. If both properties are set, the - * firewall will apply to traffic that has source IP address within - * sourceRanges OR the source IP that belongs to a tag listed in the - * sourceTags property. The connection does not need to match both - * properties for the firewall to apply. + * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. */ sourceTags?: string[]; /** - * A list of service accounts indicating sets of instances located in the - * network that may make network connections as specified in allowed[]. - * targetServiceAccounts cannot be used at the same time as targetTags or - * sourceTags. If neither targetServiceAccounts nor targetTags are - * specified, the firewall rule applies to all instances on the specified - * network. + * A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. */ targetServiceAccounts?: string[]; /** - * A list of tags that controls which instances the firewall rule applies - * to. If targetTags are specified, then the firewall rule applies only to - * instances in the VPC network that have one of those tags. If no - * targetTags are specified, the firewall rule applies to all instances on - * the specified network. + * A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. */ targetTags?: string[]; } @@ -3091,16 +2305,11 @@ export namespace compute_beta { */ items?: Schema$Firewall[]; /** - * [Output Only] Type of resource. Always compute#firewallList for lists of - * firewalls. + * [Output Only] Type of resource. Always compute#firewallList for lists of firewalls. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3121,8 +2330,7 @@ export namespace compute_beta { */ export interface Schema$FirewallLogConfig { /** - * This field denotes whether to enable logging for a particular firewall - * rule. + * This field denotes whether to enable logging for a particular firewall rule. */ enable?: boolean; } @@ -3131,57 +2339,32 @@ export namespace compute_beta { */ export interface Schema$FixedOrPercent { /** - * [Output Only] Absolute value of VM instances calculated based on the - * specific mode. - If the value is fixed, then the calculated value is - * equal to the fixed value. - If the value is a percent, then the - * calculated value is percent/100 * targetSize. For example, the calculated - * value of a 80% of a managed instance group with 150 instances would be - * (80/100 * 150) = 120 VM instances. If there is a remainder, the number is - * rounded up. + * [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up. */ calculated?: number; /** - * Specifies a fixed number of VM instances. This must be a positive - * integer. + * Specifies a fixed number of VM instances. This must be a positive integer. */ fixed?: number; /** - * Specifies a percentage of instances between 0 to 100%, inclusive. For - * example, specify 80 for 80%. + * Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. */ percent?: number; } /** - * A ForwardingRule resource. A ForwardingRule resource specifies which pool - * of target virtual machines to forward a packet to if it matches the given - * [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules - * ==) (== resource_for v1.forwardingRules ==) (== resource_for - * beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules - * ==) (== resource_for beta.regionForwardingRules ==) (== resource_for - * v1.regionForwardingRules ==) + * A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** - * This field is used along with the backend_service field for internal load - * balancing or with the target field for internal TargetInstance. If the - * field is set to TRUE, clients can access ILB from all regions. Otherwise - * only allows access from clients in the same region as the internal load - * balancer. + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. */ allowGlobalAccess?: boolean; /** - * This field is used along with the backend_service field for internal load - * balancing or with the target field for internal TargetInstance. This - * field cannot be used with port or portRange fields. When the load - * balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field - * to allow packets addressed to any ports will be forwarded to the backends - * configured with this forwarding rule. + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. */ allPorts?: boolean; /** - * This field is only used for INTERNAL load balancing. For internal load - * balancing, this field identifies the BackendService resource to receive - * the matched traffic. + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. */ backendService?: string; /** @@ -3189,149 +2372,67 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a ForwardingRule. Include the fingerprint in patch - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. To see the latest fingerprint, make a - * get() request to retrieve a ForwardingRule. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The IP address that this forwarding rule is serving on behalf of. - * Addresses are restricted based on the forwarding rule's load - * balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). - * When the load balancing scheme is EXTERNAL, for global forwarding rules, - * the address must be a global IP, and for regional forwarding rules, the - * address must live in the same region as the forwarding rule. If this - * field is empty, an ephemeral IPv4 address from the same scope (global or - * regional) will be assigned. A regional forwarding rule supports IPv4 - * only. A global forwarding rule supports either IPv4 or IPv6. When the - * load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL - * reference to an existing Address resource ( internal regional static IP - * address), with a purpose of GCE_END_POINT and address_type of INTERNAL. - * When the load balancing scheme is INTERNAL, this can only be an RFC 1918 - * IP address belonging to the network/subnet configured for the forwarding - * rule. By default, if this field is empty, an ephemeral internal IP - * address will be automatically allocated from the IP range of the subnet - * or network configured for this forwarding rule. An address can be - * specified either by a literal IP address or a URL reference to an - * existing Address resource. The following examples are all valid: - - * 100.1.2.3 - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address - * - projects/project/regions/region/addresses/address - - * regions/region/addresses/address - global/addresses/address - address + * The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: - 100.1.2.3 - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address - projects/project/regions/region/addresses/address - regions/region/addresses/address - global/addresses/address - address */ IPAddress?: string; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, - * ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only - * TCP and UDP are valid. When the load balancing scheme is - * INTERNAL_SELF_MANAGED, only TCPis valid. + * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. */ IPProtocol?: string; /** - * The IP Version that will be used by this forwarding rule. Valid options - * are IPV4 or IPV6. This can only be specified for an external global - * forwarding rule. + * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. */ ipVersion?: string; /** - * [Output Only] Type of the resource. Always compute#forwardingRule for - * Forwarding Rule resources. + * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. */ kind?: string; /** - * A fingerprint for the labels being applied to this resource, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a - * ForwardingRule. + * A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. */ labelFingerprint?: string; /** - * Labels to apply to this resource. These can be later modified by the - * setLabels method. Each label key/value pair must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * This signifies what the ForwardingRule will be used for and can only take - * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The - * value of INTERNAL means that this will be used for Internal Network Load - * Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this - * will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means - * that this will be used for External Load Balancing (HTTP(S) LB, External - * TCP/UDP LB, SSL Proxy) + * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) */ loadBalancingScheme?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * This field is not used for external load balancing. For INTERNAL and - * INTERNAL_SELF_MANAGED load balancing, this field identifies the network - * that the load balanced IP should belong to for this Forwarding Rule. If - * this field is not specified, the default network will be used. + * This field is not used for external load balancing. For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. */ network?: string; /** - * This signifies the networking tier used for configuring this load - * balancer and can only take the following values: PREMIUM , STANDARD. For - * regional ForwardingRule, the valid values are PREMIUM and STANDARD. For - * GlobalForwardingRule, the valid value is PREMIUM. If this field is not - * specified, it is assumed to be PREMIUM. If IPAddress is specified, this - * value must be equal to the networkTier of the Address. + * This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. */ networkTier?: string; /** - * This field is used along with the target field for TargetHttpProxy, - * TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, - * TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, - * or SCTP, only packets addressed to ports in the specified range will be - * forwarded to target. Forwarding rules with the same [IPAddress, - * IPProtocol] pair must have disjoint port ranges. Some types of - * forwarding target have constraints on the acceptable ports: - - * TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, - * 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - - * TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, - * 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 + * This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 */ portRange?: string; /** - * This field is used along with the backend_service field for internal load - * balancing. When the load balancing scheme is INTERNAL, a list of ports - * can be configured, for example, ['80'], - * ['8000','9000'] etc. Only packets addressed to these - * ports will be forwarded to the backends configured with this forwarding - * rule. You may specify a maximum of up to 5 ports. + * This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports. */ ports?: string[]; /** - * [Output Only] URL of the region where the regional forwarding rule - * resides. This field is not applicable to global forwarding rules. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -3339,36 +2440,19 @@ export namespace compute_beta { */ selfLink?: string; /** - * An optional prefix to the service name for this Forwarding Rule. If - * specified, will be the first label of the fully qualified service name. - * The label must be 1-63 characters long, and comply with RFC1035. - * Specifically, the label must be 1-63 characters long and match the - * regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. This field is only used for internal load balancing. + * An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. */ serviceLabel?: string; /** - * [Output Only] The internal fully qualified service name for this - * Forwarding Rule. This field is only used for internal load balancing. + * [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. */ serviceName?: string; /** - * This field is only used for INTERNAL load balancing. For internal load - * balancing, this field identifies the subnetwork that the load balanced IP - * should belong to for this Forwarding Rule. If the network specified is - * in auto subnet mode, this field is optional. However, if the network is - * in custom subnet mode, a subnetwork must be specified. + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. */ subnetwork?: string; /** - * The URL of the target resource to receive the matched traffic. For - * regional forwarding rules, this target must live in the same region as - * the forwarding rule. For global forwarding rules, this target must be a - * global load balancing resource. The forwarded traffic must be of a type - * appropriate to the target object. For INTERNAL_SELF_MANAGED load - * balancing, only HTTP and HTTPS targets are valid. + * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. */ target?: string; } @@ -3382,16 +2466,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$ForwardingRulesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#forwardingRuleAggregatedList for lists of forwarding rules. + * [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3424,11 +2503,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3453,8 +2528,7 @@ export namespace compute_beta { */ forwardingRules?: Schema$ForwardingRule[]; /** - * Informational warning which replaces the list of forwarding rules when - * the list is empty. + * Informational warning which replaces the list of forwarding rules when the list is empty. */ warning?: { code?: string; @@ -3464,43 +2538,25 @@ export namespace compute_beta { } export interface Schema$GlobalSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash when updating or - * changing labels, otherwise the request will fail with error 412 - * conditionNotMet. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** - * A list of labels to apply for this resource. Each label key & value - * must comply with RFC1035. Specifically, the name must be 1-63 characters - * long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which - * means the first character must be a lowercase letter, and all following - * characters must be a dash, lowercase letter, or digit, except the last - * character, which cannot be a dash. For example, - * "webserver-frontend": "images". A label value can - * also be empty (e.g. "my-label": ""). + * A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). */ labels?: {[key: string]: string}; } export interface Schema$GlobalSetPolicyRequest { /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -3509,13 +2565,11 @@ export namespace compute_beta { */ export interface Schema$GuestAttributes { /** - * [Output Only] Type of the resource. Always compute#guestAttributes for - * guest attributes entry. + * [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. */ kind?: string; /** - * The path to be queried. This can be the default namespace ('/') - * or a nested namespace ('//') or a specified key ('//') + * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') */ queryPath?: string; /** @@ -3563,20 +2617,16 @@ export namespace compute_beta { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. Read Enabling guest operating system - * features to see a list of available options. + * The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. */ type?: string; } /** - * An HealthCheck resource. This resource defines a template for how - * individual virtual machines should be checked for health, via one of the - * supported protocols. + * An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. */ export interface Schema$HealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -3584,21 +2634,18 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; http2HealthCheck?: Schema$HTTP2HealthCheck; httpHealthCheck?: Schema$HTTPHealthCheck; httpsHealthCheck?: Schema$HTTPSHealthCheck; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -3606,13 +2653,7 @@ export namespace compute_beta { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -3622,21 +2663,15 @@ export namespace compute_beta { sslHealthCheck?: Schema$SSLHealthCheck; tcpHealthCheck?: Schema$TCPHealthCheck; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ timeoutSec?: number; /** - * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or - * HTTP2. If not specified, the default is TCP. Exactly one of the - * protocol-specific health check field must be specified, which must match - * type field. + * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. */ type?: string; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -3657,11 +2692,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3678,11 +2709,7 @@ export namespace compute_beta { }; } /** - * A full or valid partial URL to a health check. For example, the following - * are valid URLs: - - * https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - * - projects/project-id/global/httpHealthChecks/health-check - - * global/httpHealthChecks/health-check + * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ export interface Schema$HealthCheckReference { healthCheck?: string; @@ -3707,146 +2734,105 @@ export namespace compute_beta { } export interface Schema$HealthStatusForNetworkEndpoint { /** - * URL of the backend service associated with the health state of the - * network endpoint. + * URL of the backend service associated with the health state of the network endpoint. */ backendService?: Schema$BackendServiceReference; /** - * URL of the forwarding rule associated with the health state of the - * network endpoint. + * URL of the forwarding rule associated with the health state of the network endpoint. */ forwardingRule?: Schema$ForwardingRuleReference; /** - * URL of the health check associated with the health state of the network - * endpoint. + * URL of the health check associated with the health state of the network endpoint. */ healthCheck?: Schema$HealthCheckReference; /** - * Health state of the network endpoint determined based on the health - * checks configured. + * Health state of the network endpoint determined based on the health checks configured. */ healthState?: string; } /** - * UrlMaps A host-matching rule for a URL. If matched, will use the named - * PathMatcher to select the BackendService. + * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. */ export interface Schema$HostRule { /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The list of host patterns to match. They must be valid hostnames, except - * * will match any string of ([a-z0-9-.]*). In that case, * must be the - * first character and must be followed in the pattern by either - or .. + * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. */ hosts?: string[]; /** - * The name of the PathMatcher to use to match the path portion of the URL - * if the hostRule matches the URL's host portion. + * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. */ pathMatcher?: string; } export interface Schema$HTTP2HealthCheck { /** - * The value of the host header in the HTTP/2 health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTP2 health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTP/2 health check request. The default value is - * /. + * The request path of the HTTP/2 health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } export interface Schema$HTTPHealthCheck { /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value - * is 80. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTP health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTP health check request. The default value is - * /. + * The request path of the HTTP health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } /** - * An HttpHealthCheck resource. This resource defines a template for how - * individual instances should be checked for health, via HTTP. + * An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP. */ export interface Schema$HttpHealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -3854,49 +2840,35 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the public IP on behalf of which this health check - * is performed will be used. + * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ host?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#httpHealthCheck for - * HTTP health checks. + * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The TCP port number for the HTTP health check request. The default value - * is 80. + * The TCP port number for the HTTP health check request. The default value is 80. */ port?: number; /** - * The request path of the HTTP health check request. The default value is - * /. + * The request path of the HTTP health check request. The default value is /. */ requestPath?: string; /** @@ -3904,14 +2876,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ timeoutSec?: number; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -3932,11 +2901,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3954,57 +2919,40 @@ export namespace compute_beta { } export interface Schema$HTTPSHealthCheck { /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTPS health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTPS health check request. The default value is - * /. + * The request path of the HTTPS health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } /** - * An HttpsHealthCheck resource. This resource defines a template for how - * individual instances should be checked for health, via HTTPS. + * An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS. */ export interface Schema$HttpsHealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -4012,24 +2960,19 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the public IP on behalf of which this health check - * is performed will be used. + * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ host?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -4037,23 +2980,15 @@ export namespace compute_beta { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The TCP port number for the HTTPS health check request. The default value - * is 443. + * The TCP port number for the HTTPS health check request. The default value is 443. */ port?: number; /** - * The request path of the HTTPS health check request. The default value is - * "/". + * The request path of the HTTPS health check request. The default value is "/". */ requestPath?: string; /** @@ -4061,14 +2996,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have a greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. */ timeoutSec?: number; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -4089,11 +3021,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4110,13 +3038,11 @@ export namespace compute_beta { }; } /** - * An Image resource. (== resource_for beta.images ==) (== resource_for - * v1.images ==) + * An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==) */ export interface Schema$Image { /** - * Size of the image tar.gz archive stored in Google Cloud Storage (in - * bytes). + * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ archiveSizeBytes?: string; /** @@ -4128,8 +3054,7 @@ export namespace compute_beta { */ deprecated?: Schema$DeprecationStatus; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -4137,31 +3062,19 @@ export namespace compute_beta { */ diskSizeGb?: string; /** - * The name of the image family to which this image belongs. You can create - * disks by specifying an image family instead of a specific image name. The - * image family always returns its latest image that is not deprecated. The - * name of the image family must comply with RFC1035. + * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. */ family?: string; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Encrypts the image using a customer-supplied encryption key. After you - * encrypt an image with a customer-supplied key, you must provide the same - * key if you use the image later (e.g. to create a disk from the image). - * Customer-supplied encryption keys do not protect access to metadata of - * the disk. If you do not provide an encryption key when creating the - * image, then the disk will be encrypted using an automatically generated - * key and you do not need to provide a key to use the image later. + * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. */ imageEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -4169,23 +3082,15 @@ export namespace compute_beta { */ kind?: string; /** - * A fingerprint for the labels being applied to this image, which is - * essentially a hash of the labels used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an image. + * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. */ labelFingerprint?: string; /** - * Labels to apply to this image. These can be later modified by the - * setLabels method. + * Labels to apply to this image. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** - * Integer license codes indicating which licenses are attached to this - * image. + * Integer license codes indicating which licenses are attached to this image. */ licenseCodes?: string[]; /** @@ -4193,13 +3098,7 @@ export namespace compute_beta { */ licenses?: string[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -4211,71 +3110,47 @@ export namespace compute_beta { */ selfLink?: string; /** - * URL of the source disk used to create this image. This can be a full or - * valid partial URL. You must provide either this property or the - * rawDisk.source property but not both to create an image. For example, the - * following are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ sourceDisk?: string; /** - * The customer-supplied encryption key of the source disk. Required if the - * source disk is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the disk used to create this image. This - * value may be used to determine whether the image was taken from the - * current or a previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. */ sourceDiskId?: string; /** - * URL of the source image used to create this image. This can be a full or - * valid partial URL. You must provide exactly one of: - this property, or - * - the rawDisk.source property, or - the sourceDisk property in order - * to create an image. + * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the image used to create this image. This - * value may be used to determine whether the image was taken from the - * current or a previous instance of a given image name. + * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. */ sourceImageId?: string; /** - * URL of the source snapshot used to create this image. This can be a full - * or valid partial URL. You must provide exactly one of: - this property, - * or - the sourceImage property, or - the rawDisk.source property, or - * - the sourceDisk property in order to create an image. + * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ sourceSnapshot?: string; /** - * The customer-supplied encryption key of the source snapshot. Required if - * the source snapshot is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the snapshot used to create this image. - * This value may be used to determine whether the snapshot was taken from - * the current or a previous instance of a given snapshot name. + * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. */ sourceSnapshotId?: string; /** - * The type of the image used to create this disk. The default and only - * value is RAW + * The type of the image used to create this disk. The default and only value is RAW */ sourceType?: string; /** - * [Output Only] The status of the image. An image can be used to create - * other resources, such as instances, only after the image has been - * successfully created and the status is set to READY. Possible values are - * FAILED, PENDING, or READY. + * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ status?: string; } @@ -4296,11 +3171,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4317,15 +3188,11 @@ export namespace compute_beta { }; } /** - * An Instance resource. (== resource_for beta.instances ==) (== resource_for - * v1.instances ==) + * An Instance resource. (== resource_for beta.instances ==) (== resource_for v1.instances ==) */ export interface Schema$Instance { /** - * Allows this instance to send and receive packets with non-matching - * destination or source IPs. This is required if you plan to use this - * instance to forward routes. For more information, see Enabling IP - * Forwarding. + * Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. */ canIpForward?: boolean; /** @@ -4341,13 +3208,11 @@ export namespace compute_beta { */ deletionProtection?: boolean; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Array of disks associated with this instance. Persistent disks must be - * created before you can assign them. + * Array of disks associated with this instance. Persistent disks must be created before you can assign them. */ disks?: Schema$AttachedDisk[]; /** @@ -4355,82 +3220,48 @@ export namespace compute_beta { */ displayDevice?: Schema$DisplayDevice; /** - * A list of the type and count of accelerator cards attached to the - * instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators?: Schema$AcceleratorConfig[]; hostname?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#instance for - * instances. + * [Output Only] Type of the resource. Always compute#instance for instances. */ kind?: string; /** - * A fingerprint for this request, which is essentially a hash of the - * label's contents and used for optimistic locking. The fingerprint is - * initially generated by Compute Engine and changes after every request to - * modify or update labels. You must always provide an up-to-date - * fingerprint hash in order to update or change labels. To see the latest - * fingerprint, make get() request to the instance. + * A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. */ labelFingerprint?: string; /** - * Labels to apply to this instance. These can be later modified by the - * setLabels method. + * Labels to apply to this instance. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** - * Full or partial URL of the machine type resource to use for this - * instance, in the format: zones/zone/machineTypes/machine-type. This is - * provided by the client when the instance is created. For example, the - * following is a valid partial url to a predefined machine type: - * zones/us-central1-f/machineTypes/n1-standard-1 To create a custom - * machine type, provide a URL to a machine type in the following format, - * where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and - * MEMORY is the total memory for this instance. Memory must be a multiple - * of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): - * zones/zone/machineTypes/custom-CPUS-MEMORY For example: - * zones/us-central1-f/machineTypes/custom-4-5120 For a full list of - * restrictions, read the Specifications for custom machine types. + * Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. */ machineType?: string; /** - * The metadata key/value pairs assigned to this instance. This includes - * custom metadata and predefined keys. + * The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. */ metadata?: Schema$Metadata; /** - * Specifies a minimum CPU platform for the VM instance. Applicable values - * are the friendly names of CPU platforms, such as minCpuPlatform: - * "Intel Haswell" or minCpuPlatform: "Intel Sandy - * Bridge". + * Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". */ minCpuPlatform?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * An array of network configurations for this instance. These specify how - * interfaces are configured to interact with other network services, such - * as connecting to the internet. Multiple interfaces are supported per - * instance. + * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. */ networkInterfaces?: Schema$NetworkInterface[]; /** - * The configuration of desired allocations which this Instance could - * consume capacity from. + * The configuration of desired allocations which this Instance could consume capacity from. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -4442,11 +3273,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * A list of service accounts, with their specified scopes, authorized for - * this instance. Only one service account per VM instance is supported. - * Service accounts generate access tokens that can be accessed through the - * metadata server and used to authenticate applications on the instance. - * See Service Accounts for more information. + * A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. */ serviceAccounts?: Schema$ServiceAccount[]; shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; @@ -4454,14 +3281,11 @@ export namespace compute_beta { shieldedVmConfig?: Schema$ShieldedVmConfig; shieldedVmIntegrityPolicy?: Schema$ShieldedVmIntegrityPolicy; /** - * [Output Only] Whether a VM has been restricted for start because Compute - * Engine has detected suspicious activity. + * [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. */ startRestricted?: boolean; /** - * [Output Only] The status of the instance. One of the following values: - * PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, - * and TERMINATED. + * [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. */ status?: string; /** @@ -4469,17 +3293,11 @@ export namespace compute_beta { */ statusMessage?: string; /** - * Tags to apply to this instance. Tags are used to identify valid sources - * or targets for network firewalls and are specified by the client during - * instance creation. The tags can be later modified by the setTags method. - * Each tag within the list must comply with RFC1035. Multiple tags can be - * specified via the 'tags.items' field. + * Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. */ tags?: Schema$Tags; /** - * [Output Only] URL of the zone where the instance resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -4493,16 +3311,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$InstancesScopedList}; /** - * [Output Only] Type of resource. Always compute#instanceAggregatedList for - * aggregated lists of Instance resources. + * [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4519,63 +3332,47 @@ export namespace compute_beta { }; } /** - * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for - * v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== - * resource_for v1.regionInstanceGroups ==) + * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** - * [Output Only] The creation timestamp for this instance group in RFC3339 - * text format. + * [Output Only] The creation timestamp for this instance group in RFC3339 text format. */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The fingerprint of the named ports. The system uses this - * fingerprint to detect conflicts when multiple users change the named - * ports concurrently. + * [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. */ fingerprint?: string; /** - * [Output Only] A unique identifier for this instance group, generated by - * the server. + * [Output Only] A unique identifier for this instance group, generated by the server. */ id?: string; /** - * [Output Only] The resource type, which is always compute#instanceGroup - * for instance groups. + * [Output Only] The resource type, which is always compute#instanceGroup for instance groups. */ kind?: string; /** - * The name of the instance group. The name must be 1-63 characters long, - * and comply with RFC1035. + * The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** - * Assigns a name to a port number. For example: {name: "http", - * port: 80} This allows the system to reference ports by the assigned name - * instead of a port number. Named ports can also contain multiple ports. - * For example: [{name: "http", port: 80},{name: "http", - * port: 8080}] Named ports apply to all instances in this instance group. + * Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. */ namedPorts?: Schema$NamedPort[]; /** - * The URL of the network to which all instances in the instance group - * belong. + * The URL of the network to which all instances in the instance group belong. */ network?: string; /** - * [Output Only] The URL of the region where the instance group is located - * (for regional resources). + * [Output Only] The URL of the region where the instance group is located (for regional resources). */ region?: string; /** - * [Output Only] The URL for this instance group. The server generates this - * URL. + * [Output Only] The URL for this instance group. The server generates this URL. */ selfLink?: string; /** @@ -4583,13 +3380,11 @@ export namespace compute_beta { */ size?: number; /** - * [Output Only] The URL of the subnetwork to which all instances in the - * instance group belong. + * [Output Only] The URL of the subnetwork to which all instances in the instance group belong. */ subnetwork?: string; /** - * [Output Only] The URL of the zone where the instance group is located - * (for zonal resources). + * [Output Only] The URL of the zone where the instance group is located (for zonal resources). */ zone?: string; } @@ -4603,17 +3398,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$InstanceGroupsScopedList}; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupAggregatedList for aggregated lists of instance - * groups. + * [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4642,16 +3431,11 @@ export namespace compute_beta { */ items?: Schema$InstanceGroup[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupList for instance group lists. + * [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4668,61 +3452,43 @@ export namespace compute_beta { }; } /** - * An Instance Group Manager resource. (== resource_for - * beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers - * ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for - * v1.regionInstanceGroupManagers ==) + * An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** - * The autohealing policy for this managed instance group. You can specify - * only one value. + * The autohealing policy for this managed instance group. You can specify only one value. */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must - * be 1-58 characters long. Instances are named by appending a hyphen and a - * random four-character string to the base instance name. The base instance - * name must comply with RFC1035. + * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. */ baseInstanceName?: string; /** - * [Output Only] The creation timestamp for this managed instance group in - * RFC3339 text format. + * [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. */ creationTimestamp?: string; /** - * [Output Only] The list of instance actions and the number of instances in - * this managed instance group that are scheduled for each of those actions. + * [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. */ currentActions?: Schema$InstanceGroupManagerActionsSummary; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Policy specifying intended distribution of instances in regional managed - * instance group. + * Policy specifying intended distribution of instances in regional managed instance group. */ distributionPolicy?: Schema$DistributionPolicy; /** - * The action to perform in case of zone failure. Only one value is - * supported, NO_FAILOVER. The default is NO_FAILOVER. + * The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. */ failoverAction?: string; /** - * Fingerprint of this resource. This field may be used in optimistic - * locking. It will be ignored when inserting an InstanceGroupManager. An - * up-to-date fingerprint must be provided in order to update the - * InstanceGroupManager, otherwise the request will fail with error 412 - * conditionNotMet. To see the latest fingerprint, make a get() request to - * retrieve an InstanceGroupManager. + * Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. */ fingerprint?: string; /** - * [Output Only] A unique identifier for this resource type. The server - * generates this identifier. + * [Output Only] A unique identifier for this resource type. The server generates this identifier. */ id?: string; /** @@ -4730,51 +3496,35 @@ export namespace compute_beta { */ instanceGroup?: string; /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create all new instances - * in the managed instance group. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ instanceTemplate?: string; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManager for managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. */ kind?: string; /** - * The name of the managed instance group. The name must be 1-63 characters - * long, and comply with RFC1035. + * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** - * Named ports configured for the Instance Groups complementary to this - * Instance Group Manager. + * Named ports configured for the Instance Groups complementary to this Instance Group Manager. */ namedPorts?: Schema$NamedPort[]; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The list of instance actions and the - * number of instances in this managed instance group that are pending for - * each of those actions. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions. */ pendingActions?: Schema$InstanceGroupManagerPendingActionsSummary; /** - * [Output Only] The URL of the region where the managed instance group - * resides (for regional resources). + * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ region?: string; /** - * [Output Only] The URL for this managed instance group. The server defines - * this URL. + * [Output Only] The URL for this managed instance group. The server defines this URL. */ selfLink?: string; /** - * The service account to be used as credentials for all operations - * performed by the managed instance group on instances. The service - * accounts needs all permissions required to create and delete instances. - * By default, the service account - * {projectNumber}@cloudservices.gserviceaccount.com is used. + * The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. */ serviceAccount?: string; /** @@ -4782,15 +3532,11 @@ export namespace compute_beta { */ status?: Schema$InstanceGroupManagerStatus; /** - * The URLs for all TargetPool resources to which instances in the - * instanceGroup field are added. The target pools automatically apply to - * all of the instances in the managed instance group. + * The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ targetPools?: string[]; /** - * The target number of running instances for this managed instance group. - * Deleting or abandoning instances reduces this number. Resizing the group - * changes this number. + * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. */ targetSize?: number; /** @@ -4798,78 +3544,49 @@ export namespace compute_beta { */ updatePolicy?: Schema$InstanceGroupManagerUpdatePolicy; /** - * Specifies the instance templates used by this managed instance group to - * create instances. Each version is defined by an instanceTemplate and a - * name. Every version can appear at most once per instance group. This - * field overrides the top-level instanceTemplate field. Read more about the - * relationships between these fields. Exactly one version must leave the - * targetSize field unset. That version will be applied to all remaining - * instances. For more information, read about canary updates. + * Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. */ versions?: Schema$InstanceGroupManagerVersion[]; /** - * [Output Only] The URL of the zone where the managed instance group is - * located (for zonal resources). + * [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). */ zone?: string; } export interface Schema$InstanceGroupManagerActionsSummary { /** - * [Output Only] The total number of instances in the managed instance group - * that are scheduled to be abandoned. Abandoning an instance removes it - * from the managed instance group without deleting it. + * [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. */ abandoning?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be created or are currently being created. If the group - * fails to create any of these instances, it tries again until it creates - * the instance successfully. If you have disabled creation retries, this - * field will not be populated; instead, the creatingWithoutRetries field - * will be populated. + * [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. */ creating?: number; /** - * [Output Only] The number of instances that the managed instance group - * will attempt to create. The group attempts to create each instance only - * once. If the group fails to create any of these instances, it decreases - * the group's targetSize value accordingly. + * [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. */ creatingWithoutRetries?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be deleted or are currently being deleted. + * [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. */ deleting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are running and have no scheduled actions. + * [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. */ none?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be recreated or are currently being being recreated. - * Recreating an instance deletes the existing root persistent disk and - * creates a new disk from the image that is defined in the instance - * template. + * [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. */ recreating?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are being reconfigured with properties that do not require a restart or a - * recreate action. For example, setting or removing target pools for the - * instance. + * [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. */ refreshing?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be restarted or are currently being restarted. + * [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. */ restarting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are being verified. See the managedInstances[].currentAction property in - * the listManagedInstances method documentation. + * [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. */ verifying?: number; } @@ -4883,17 +3600,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$InstanceGroupManagersScopedList}; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerAggregatedList for an aggregated list of - * managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4915,12 +3626,7 @@ export namespace compute_beta { */ healthCheck?: string; /** - * The number of seconds that the managed instance group waits before it - * applies autohealing policies to new instances or recently recreated - * instances. This initial delay allows instances to initialize and run - * their startup scripts before the instance group determines that they are - * UNHEALTHY. This prevents the managed instance group from recreating its - * instances prematurely. This value must be from range [0, 3600]. + * The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. */ initialDelaySec?: number; } @@ -4937,16 +3643,11 @@ export namespace compute_beta { */ items?: Schema$InstanceGroupManager[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerList for a list of managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4964,42 +3665,25 @@ export namespace compute_beta { } export interface Schema$InstanceGroupManagerPendingActionsSummary { /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be created. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be created. */ creating?: number; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be deleted. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be deleted. */ deleting?: number; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be recreated. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be recreated. */ recreating?: number; /** - * [Deprecated] This field is deprecated and will be removed. Prefer using - * the status field instead. Please contact - * cloud-updater-feedback@google.com to leave feedback if your workload - * relies on this field. [Output Only] The number of instances in the - * managed instance group that are pending to be restarted. + * [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The number of instances in the managed instance group that are pending to be restarted. */ restarting?: number; } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** - * The URLs of one or more instances to abandon. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -5008,26 +3692,21 @@ export namespace compute_beta { */ export interface Schema$InstanceGroupManagersApplyUpdatesRequest { /** - * The list of URLs of one or more instances for which we want to apply - * updates on this managed instance group. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The list of URLs of one or more instances for which we want to apply updates on this managed instance group. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; /** - * The minimal action that should be perfomed on the instances. By default - * NONE. + * The minimal action that should be perfomed on the instances. By default NONE. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. - * By default REPLACE. + * The most disruptive action that allowed to be performed on the instances. By default REPLACE. */ mostDisruptiveAllowedAction?: string; } export interface Schema$InstanceGroupManagersDeleteInstancesRequest { /** - * The URLs of one or more instances to delete. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -5037,57 +3716,33 @@ export namespace compute_beta { */ managedInstances?: Schema$ManagedInstance[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; } export interface Schema$InstanceGroupManagersRecreateInstancesRequest { /** - * The URLs of one or more instances to recreate. This can be a full URL or - * a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } export interface Schema$InstanceGroupManagersResizeAdvancedRequest { /** - * If this flag is true, the managed instance group attempts to create all - * instances initiated by this resize request only once. If there is an - * error during creation, the managed instance group does not retry create - * this instance, and we will decrease the targetSize of the request - * instead. If the flag is false, the group attempts to recreate each - * instance continuously until it succeeds. This flag matters only in the - * first attempt of creation of an instance. After an instance is - * successfully created while this flag is enabled, the instance behaves the - * same way as all the other instances created with a regular resize - * request. In particular, if a running instance dies unexpectedly at a - * later time and needs to be recreated, this mode does not affect the - * recreation behavior in that scenario. This flag is applicable only to - * the current resize request. It does not influence other resize requests - * in any way. You can see which instances is being creating in which mode - * by calling the get or listManagedInstances API. + * If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attempts to recreate each instance continuously until it succeeds. This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario. This flag is applicable only to the current resize request. It does not influence other resize requests in any way. You can see which instances is being creating in which mode by calling the get or listManagedInstances API. */ noCreationRetries?: boolean; /** - * The number of running instances that the managed instance group should - * maintain at any given time. The group automatically adds or removes - * instances to maintain the number of instances specified by this - * parameter. + * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. */ targetSize?: number; } export interface Schema$InstanceGroupManagersScopedList { /** - * [Output Only] The list of managed instance groups that are contained in - * the specified project and zone. + * [Output Only] The list of managed instance groups that are contained in the specified project and zone. */ instanceGroupManagers?: Schema$InstanceGroupManager[]; /** - * [Output Only] The warning that replaces the list of managed instance - * groups when the list is empty. + * [Output Only] The warning that replaces the list of managed instance groups when the list is empty. */ warning?: { code?: string; @@ -5100,122 +3755,67 @@ export namespace compute_beta { } export interface Schema$InstanceGroupManagersSetInstanceTemplateRequest { /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create all new instances - * in the managed instance group. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ instanceTemplate?: string; } export interface Schema$InstanceGroupManagersSetTargetPoolsRequest { /** - * The fingerprint of the target pools information. Use this optional - * property to prevent conflicts when multiple users change the target pools - * settings concurrently. Obtain the fingerprint with the - * instanceGroupManagers.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. + * The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ fingerprint?: string; /** - * The list of target pool URLs that instances in this managed instance - * group belong to. The managed instance group applies these target pools to - * all of the instances in the group. Existing instances and new instances - * in the group all receive these target pool settings. + * The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings. */ targetPools?: string[]; } export interface Schema$InstanceGroupManagerStatus { /** - * [Output Only] A bit indicating whether the managed instance group is in a - * stable state. A stable state means that: none of the instances in the - * managed instance group is currently undergoing any type of change (for - * example, creation, restart, or deletion); no future changes are scheduled - * for instances in the managed instance group; and the managed instance - * group itself is not being modified. + * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ isStable?: boolean; /** - * [Output Only] A status of consistency of Instances' versions with - * their target version specified by version field on Instance Group - * Manager. + * [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. */ versionTarget?: Schema$InstanceGroupManagerStatusVersionTarget; } export interface Schema$InstanceGroupManagerStatusVersionTarget { /** - * [Output Only] A bit indicating whether version target has been reached in - * this managed instance group, i.e. all instances are in their target - * version. Instances' target version are specified by version field on - * Instance Group Manager. + * [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. */ isReached?: boolean; } export interface Schema$InstanceGroupManagerUpdatePolicy { instanceRedistributionType?: string; /** - * The maximum number of instances that can be created above the specified - * targetSize during the update process. By default, a fixed value of 1 is - * used. This value can be either a fixed number or a percentage if the - * instance group has 10 or more instances. If you set a percentage, the - * number of instances will be rounded up if necessary. At least one of - * either maxSurge or maxUnavailable must be greater than 0. Learn more - * about maxSurge. + * The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. */ maxSurge?: Schema$FixedOrPercent; /** - * The maximum number of instances that can be unavailable during the update - * process. An instance is considered available if all of the following - * conditions are satisfied: - The instance's status is RUNNING. - - * If there is a health check on the instance group, the instance's - * liveness health check result must be HEALTHY at least once. If there is - * no health check on the group, then the instance only needs to have a - * status of RUNNING to be considered available. By default, a fixed value - * of 1 is used. This value can be either a fixed number or a percentage if - * the instance group has 10 or more instances. If you set a percentage, the - * number of instances will be rounded up if necessary. At least one of - * either maxSurge or maxUnavailable must be greater than 0. Learn more - * about maxUnavailable. + * The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. */ maxUnavailable?: Schema$FixedOrPercent; /** - * Minimal action to be taken on an instance. You can specify either RESTART - * to restart existing instances or REPLACE to delete and create new - * instances from the target template. If you specify a RESTART, the Updater - * will attempt to perform that action only. However, if the Updater - * determines that the minimal action you specify is not enough to perform - * the update, it might perform a more disruptive action. + * Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. */ minimalAction?: string; /** - * Minimum number of seconds to wait for after a newly created instance - * becomes available. This value must be from range [0, 3600]. + * Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. */ minReadySec?: number; type?: string; } export interface Schema$InstanceGroupManagerVersion { /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create new instances in - * the managed instance group until the `targetSize` for this version is - * reached. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. */ instanceTemplate?: string; /** - * Name of the version. Unique among all versions in the scope of this - * managed instance group. + * Name of the version. Unique among all versions in the scope of this managed instance group. */ name?: string; /** - * Specifies the intended number of instances to be created from the - * instanceTemplate. The final number of instances created from the template - * will be equal to: - If expressed as a fixed number, the minimum of - * either targetSize.fixed or instanceGroupManager.targetSize is used. - if - * expressed as a percent, the targetSize would be (targetSize.percent/100 * - * InstanceGroupManager.targetSize) If there is a remainder, the number is - * rounded up. If unset, this version will update any remaining instances - * not updated by another version. Read Starting a canary update for more - * information. + * Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. */ targetSize?: Schema$FixedOrPercent; } @@ -5235,17 +3835,11 @@ export namespace compute_beta { */ items?: Schema$InstanceWithNamedPorts[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupsListInstances for the list of instances in the - * specified instance group. + * [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5263,9 +3857,7 @@ export namespace compute_beta { } export interface Schema$InstanceGroupsListInstancesRequest { /** - * A filter for the state of the instances in the instance group. Valid - * options are ALL or RUNNING. If you do not specify this parameter the list - * includes all instances regardless of their state. + * A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. */ instanceState?: string; } @@ -5277,13 +3869,11 @@ export namespace compute_beta { } export interface Schema$InstanceGroupsScopedList { /** - * [Output Only] The list of instance groups that are contained in this - * scope. + * [Output Only] The list of instance groups that are contained in this scope. */ instanceGroups?: Schema$InstanceGroup[]; /** - * [Output Only] An informational warning that replaces the list of instance - * groups when the list is empty. + * [Output Only] An informational warning that replaces the list of instance groups when the list is empty. */ warning?: { code?: string; @@ -5293,13 +3883,7 @@ export namespace compute_beta { } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** - * The fingerprint of the named ports information for this instance group. - * Use this optional property to prevent conflicts when multiple users - * change the named ports settings concurrently. Obtain the fingerprint with - * the instanceGroups.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. A request with an incorrect fingerprint - * will fail with error 412 conditionNotMet. + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet. */ fingerprint?: string; /** @@ -5320,16 +3904,11 @@ export namespace compute_beta { */ items?: Schema$Instance[]; /** - * [Output Only] Type of resource. Always compute#instanceList for lists of - * Instance resources. + * [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5358,16 +3937,11 @@ export namespace compute_beta { */ items?: Schema$Reference[]; /** - * [Output Only] Type of resource. Always compute#instanceListReferrers for - * lists of Instance referrers. + * [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5385,49 +3959,33 @@ export namespace compute_beta { } export interface Schema$InstanceMoveRequest { /** - * The URL of the destination zone to move the instance. This can be a full - * or partial URL. For example, the following are all valid URLs to a zone: - * - https://www.googleapis.com/compute/v1/projects/project/zones/zone - - * projects/project/zones/zone - zones/zone + * The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone */ destinationZone?: string; /** - * The URL of the target instance to move. This can be a full or partial - * URL. For example, the following are all valid URLs to an instance: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance - - * zones/zone/instances/instance + * The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ targetInstance?: string; } export interface Schema$InstanceProperties { /** - * Enables instances created based on this template to send packets with - * source IP addresses other than their own and receive packets with - * destination IP addresses other than their own. If these instances will be - * used as an IP gateway or it will be set as the next-hop in a Route - * resource, specify true. If unsure, leave this set to false. See the - * Enable IP forwarding documentation for more information. + * Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. */ canIpForward?: boolean; /** - * An optional text description for the instances that are created from this - * instance template. + * An optional text description for the instances that are created from this instance template. */ description?: string; /** - * An array of disks that are associated with the instances that are created - * from this template. + * An array of disks that are associated with the instances that are created from this template. */ disks?: Schema$AttachedDisk[]; /** - * Display Device properties to enable support for remote display products - * like: Teradici, VNC and TeamViewer + * Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer */ displayDevice?: Schema$DisplayDevice; /** - * A list of guest accelerator cards' type and count to use for - * instances created from the instance template. + * A list of guest accelerator cards' type and count to use for instances created from the instance template. */ guestAccelerators?: Schema$AcceleratorConfig[]; /** @@ -5435,22 +3993,15 @@ export namespace compute_beta { */ labels?: {[key: string]: string}; /** - * The machine type to use for instances that are created from this - * template. + * The machine type to use for instances that are created from this template. */ machineType?: string; /** - * The metadata key/value pairs to assign to instances that are created from - * this template. These pairs can consist of custom metadata or predefined - * keys. See Project and instance metadata for more information. + * The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. */ metadata?: Schema$Metadata; /** - * Minimum cpu/platform to be used by this instance. The instance may be - * scheduled on the specified or newer cpu/platform. Applicable values are - * the friendly names of CPU platforms, such as minCpuPlatform: "Intel - * Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more - * information, read Specifying a Minimum CPU Platform. + * Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. */ minCpuPlatform?: string; /** @@ -5458,33 +4009,24 @@ export namespace compute_beta { */ networkInterfaces?: Schema$NetworkInterface[]; /** - * The configuration of desired reservations which this Instance could - * consume capacity from. + * The configuration of desired reservations which this Instance could consume capacity from. */ reservationAffinity?: Schema$ReservationAffinity; /** - * Specifies the scheduling options for the instances that are created from - * this template. + * Specifies the scheduling options for the instances that are created from this template. */ scheduling?: Schema$Scheduling; /** - * A list of service accounts with specified scopes. Access tokens for these - * service accounts are available to the instances that are created from - * this template. Use metadata queries to obtain the access tokens for these - * instances. + * A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. */ serviceAccounts?: Schema$ServiceAccount[]; shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; /** - * Specifies the Shielded VM options for the instances that are created from - * this template. + * Specifies the Shielded VM options for the instances that are created from this template. */ shieldedVmConfig?: Schema$ShieldedVmConfig; /** - * A list of tags to apply to the instances that are created from this - * template. The tags identify valid sources or targets for network - * firewalls. The setTags method can modify this list of tags. Each tag - * within the list must comply with RFC1035. + * A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. */ tags?: Schema$Tags; } @@ -5496,18 +4038,11 @@ export namespace compute_beta { } export interface Schema$InstancesResumeRequest { /** - * Array of disks associated with this instance that are protected with a - * customer-supplied encryption key. In order to resume the instance, the - * disk url and its corresponding key must be provided. If the disk is not - * protected with a customer-supplied encryption key it should not be - * specified. + * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. */ disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; /** - * Decrypts data associated with an instance that is protected with a - * customer-supplied encryption key. If the instance you are starting is - * protected with a customer-supplied encryption key, the correct key must - * be provided otherwise the instance resume will not succeed. + * Decrypts data associated with an instance that is protected with a customer-supplied encryption key. If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed. */ instanceEncryptionKey?: Schema$CustomerEncryptionKey; } @@ -5517,8 +4052,7 @@ export namespace compute_beta { */ instances?: Schema$Instance[]; /** - * [Output Only] Informational warning which replaces the list of instances - * when the list is empty. + * [Output Only] Informational warning which replaces the list of instances when the list is empty. */ warning?: { code?: string; @@ -5528,25 +4062,20 @@ export namespace compute_beta { } export interface Schema$InstancesSetLabelsRequest { /** - * Fingerprint of the previous set of labels for this resource, used to - * prevent conflicts. Provide the latest fingerprint value when making a - * request to add or change labels. + * Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels. */ labelFingerprint?: string; labels?: {[key: string]: string}; } export interface Schema$InstancesSetMachineResourcesRequest { /** - * A list of the type and count of accelerator cards attached to the - * instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators?: Schema$AcceleratorConfig[]; } export interface Schema$InstancesSetMachineTypeRequest { /** - * Full or partial URL of the machine type resource. See Machine Types for a - * full list of machine types. For example: - * zones/us-central1-f/machineTypes/n1-standard-1 + * Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1 */ machineType?: string; } @@ -5568,47 +4097,32 @@ export namespace compute_beta { } export interface Schema$InstancesStartWithEncryptionKeyRequest { /** - * Array of disks associated with this instance that are protected with a - * customer-supplied encryption key. In order to start the instance, the - * disk url and its corresponding key must be provided. If the disk is not - * protected with a customer-supplied encryption key it should not be - * specified. + * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. */ disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * An Instance Template resource. (== resource_for beta.instanceTemplates ==) - * (== resource_for v1.instanceTemplates ==) + * An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** - * [Output Only] The creation timestamp for this instance template in - * RFC3339 text format. + * [Output Only] The creation timestamp for this instance template in RFC3339 text format. */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] A unique identifier for this instance template. The server - * defines this identifier. + * [Output Only] A unique identifier for this instance template. The server defines this identifier. */ id?: string; /** - * [Output Only] The resource type, which is always compute#instanceTemplate - * for instance templates. + * [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. */ kind?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -5616,16 +4130,11 @@ export namespace compute_beta { */ properties?: Schema$InstanceProperties; /** - * [Output Only] The URL for this instance template. The server defines this - * URL. + * [Output Only] The URL for this instance template. The server defines this URL. */ selfLink?: string; /** - * The source instance used to create the template. You can provide this as - * a partial or full URL to the resource. For example, the following are - * valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance + * The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance */ sourceInstance?: string; /** @@ -5646,16 +4155,11 @@ export namespace compute_beta { */ items?: Schema$InstanceTemplate[]; /** - * [Output Only] The resource type, which is always - * compute#instanceTemplatesListResponse for instance template lists. + * [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5686,22 +4190,15 @@ export namespace compute_beta { status?: string; } /** - * Represents an Interconnects resource. The Interconnects resource is a - * dedicated connection between Google's network and your on-premises - * network. For more information, see the Dedicated overview page. (== - * resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) */ export interface Schema$Interconnect { /** - * Administrative status of the interconnect. When this is set to true, the - * Interconnect is functional and can carry traffic. When set to false, no - * packets can be carried over the interconnect and no BGP routes are - * exchanged over it. By default, the status is set to true. + * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. */ adminEnabled?: boolean; /** - * [Output Only] A list of CircuitInfo objects, that describe the individual - * circuits in this LAG. + * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. */ circuitInfos?: Schema$InterconnectCircuitInfo[]; /** @@ -5709,13 +4206,11 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * Customer name, to put in the Letter of Authorization as the party - * authorized to request a crossconnect. + * Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. */ customerName?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -5723,87 +4218,59 @@ export namespace compute_beta { */ expectedOutages?: Schema$InterconnectOutageNotification[]; /** - * [Output Only] IP address configured on the Google side of the - * Interconnect link. This can be used only for ping tests. + * [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. */ googleIpAddress?: string; /** - * [Output Only] Google reference ID to be used when raising support tickets - * with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ googleReferenceId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] A list of the URLs of all InterconnectAttachments - * configured to use this Interconnect. + * [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. */ interconnectAttachments?: string[]; /** - * Type of interconnect. Note that "IT_PRIVATE" has been - * deprecated in favor of "DEDICATED" + * Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED" */ interconnectType?: string; /** - * [Output Only] Type of the resource. Always compute#interconnect for - * interconnects. + * [Output Only] Type of the resource. Always compute#interconnect for interconnects. */ kind?: string; /** - * A fingerprint for the labels being applied to this Interconnect, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an Interconnect. + * A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. */ labelFingerprint?: string; /** - * Labels to apply to this Interconnect resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Type of link requested. This field indicates speed of each of the links - * in the bundle, not the entire bundle. + * Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. */ linkType?: string; /** - * URL of the InterconnectLocation object that represents where this - * connection is to be provisioned. + * URL of the InterconnectLocation object that represents where this connection is to be provisioned. */ location?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Email address to contact the customer NOC for operations and maintenance - * notifications regarding this Interconnect. If specified, this will be - * used for notifications in addition to all other forms described, such as - * Stackdriver logs alerting and Cloud Notifications. + * Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. */ nocContactEmail?: string; /** - * [Output Only] The current status of whether or not this Interconnect is - * functional. + * [Output Only] The current status of whether or not this Interconnect is functional. */ operationalStatus?: string; /** - * [Output Only] IP address configured on the customer side of the - * Interconnect link. The customer should configure this IP address during - * turnup when prompted by Google NOC. This can be used only for ping tests. + * [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. */ peerIpAddress?: string; /** @@ -5811,8 +4278,7 @@ export namespace compute_beta { */ provisionedLinkCount?: number; /** - * Target number of physical links in the link bundle, as requested by the - * customer. + * Target number of physical links in the link bundle, as requested by the customer. */ requestedLinkCount?: number; /** @@ -5820,42 +4286,28 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The current state of whether or not this Interconnect is - * functional. + * [Output Only] The current state of whether or not this Interconnect is functional. */ state?: string; } /** - * Represents an InterconnectAttachment (VLAN attachment) resource. For more - * information, see Creating VLAN Attachments. (== resource_for - * beta.interconnectAttachments ==) (== resource_for - * v1.interconnectAttachments ==) + * Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** - * Determines whether this Attachment will carry packets. Not present for - * PARTNER_PROVIDER. + * Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. */ adminEnabled?: boolean; /** - * Provisioned bandwidth capacity for the interconnectAttachment. Can be set - * by the partner to update the customer's provisioned bandwidth. Output - * only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. + * Provisioned bandwidth capacity for the interconnectAttachment. Can be set by the partner to update the customer's provisioned bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. */ bandwidth?: string; /** - * Up to 16 candidate prefixes that can be used to restrict the allocation - * of cloudRouterIpAddress and customerRouterIpAddress for this attachment. - * All prefixes must be within link-local address space (169.254.0.0/16) and - * must be /29 or shorter (/28, /27, etc). Google will attempt to select an - * unused /29 from the supplied candidate prefix(es). The request will fail - * if all possible /29s are in use on Google?s edge. If not supplied, Google - * will randomly select an unused /29 from all of link-local space. + * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ candidateSubnets?: string[]; /** - * [Output Only] IPv4 address + prefix length to be configured on Cloud - * Router Interface for this interconnect attachment. + * [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. */ cloudRouterIpAddress?: string; /** @@ -5863,8 +4315,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * [Output Only] IPv4 address + prefix length to be configured on the - * customer router subinterface for this interconnect attachment. + * [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. */ customerRouterIpAddress?: string; /** @@ -5872,104 +4323,63 @@ export namespace compute_beta { */ description?: string; /** - * Desired availability domain for the attachment. Only available for type - * PARTNER, at creation time. For improved reliability, customers should - * configure a pair of attachments with one per availability domain. The - * selected availability domain will be provided to the Partner via the - * pairing key so that the provisioned circuit will lie in the specified - * domain. If not specified, the value will default to - * AVAILABILITY_DOMAIN_ANY. + * Desired availability domain for the attachment. Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with one per availability domain. The selected availability domain will be provided to the Partner via the pairing key so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ edgeAvailabilityDomain?: string; /** - * [Output Only] Google reference ID, to be used when raising support - * tickets with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ googleReferenceId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * URL of the underlying Interconnect object that this attachment's - * traffic will traverse through. + * URL of the underlying Interconnect object that this attachment's traffic will traverse through. */ interconnect?: string; /** - * [Output Only] Type of the resource. Always compute#interconnectAttachment - * for interconnect attachments. + * [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. */ kind?: string; /** - * A fingerprint for the labels being applied to this - * InterconnectAttachment, which is essentially a hash of the labels set - * used for optimistic locking. The fingerprint is initially generated by - * Compute Engine and changes after every request to modify or update - * labels. You must always provide an up-to-date fingerprint hash in order - * to update or change labels, otherwise the request will fail with error - * 412 conditionNotMet. To see the latest fingerprint, make a get() request - * to retrieve an InterconnectAttachment. + * A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. */ labelFingerprint?: string; /** - * Labels to apply to this InterconnectAttachment resource. These can be - * later modified by the setLabels method. Each label key/value must comply - * with RFC1035. Label values may be empty. + * Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] The current status of whether or not this interconnect - * attachment is functional. + * [Output Only] The current status of whether or not this interconnect attachment is functional. */ operationalStatus?: string; /** - * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not - * present for DEDICATED]. The opaque identifier of an PARTNER attachment - * used to initiate provisioning with a selected partner. Of the form - * "XXXXX/region/domain" + * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" */ pairingKey?: string; /** - * Optional BGP ASN for the router that should be supplied by a layer 3 - * Partner if they configured BGP on behalf of the customer. Output only for - * PARTNER type, input only for PARTNER_PROVIDER, not available for - * DEDICATED. + * Optional BGP ASN for the router that should be supplied by a layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ partnerAsn?: string; /** - * Informational metadata about Partner attachments from Partners to display - * to customers. Output only for for PARTNER type, mutable for - * PARTNER_PROVIDER, not available for DEDICATED. + * Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. */ partnerMetadata?: Schema$InterconnectAttachmentPartnerMetadata; /** - * [Output Only] Information specific to an InterconnectAttachment. This - * property is populated if the interconnect that this is attached to is of - * type DEDICATED. + * [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED. */ privateInterconnectInfo?: Schema$InterconnectAttachmentPrivateInfo; /** - * [Output Only] URL of the region where the regional interconnect - * attachment resides. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * URL of the Cloud Router to be used for dynamic routing. This router must - * be in the same region as this InterconnectAttachment. The - * InterconnectAttachment will automatically connect the Interconnect to the - * network & region within which the Cloud Router is configured. + * URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. */ router?: string; /** @@ -5982,8 +4392,7 @@ export namespace compute_beta { state?: string; type?: string; /** - * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only - * specified at creation time. + * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. */ vlanTag8021q?: number; } @@ -5997,17 +4406,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$InterconnectAttachmentsScopedList}; /** - * [Output Only] Type of resource. Always - * compute#interconnectAttachmentAggregatedList for aggregated lists of - * interconnect attachments. + * [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6024,8 +4427,7 @@ export namespace compute_beta { }; } /** - * Response to the list request, and contains a list of interconnect - * attachments. + * Response to the list request, and contains a list of interconnect attachments. */ export interface Schema$InterconnectAttachmentList { /** @@ -6037,16 +4439,11 @@ export namespace compute_beta { */ items?: Schema$InterconnectAttachment[]; /** - * [Output Only] Type of resource. Always compute#interconnectAttachmentList - * for lists of interconnect attachments. + * [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6063,37 +4460,28 @@ export namespace compute_beta { }; } /** - * Informational metadata about Partner attachments from Partners to display - * to customers. These fields are propagated from PARTNER_PROVIDER attachments - * to their corresponding PARTNER attachments. + * Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. */ export interface Schema$InterconnectAttachmentPartnerMetadata { /** - * Plain text name of the Interconnect this attachment is connected to, as - * displayed in the Partner?s portal. For instance "Chicago 1". - * This value may be validated to match approved Partner values. + * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ interconnectName?: string; /** - * Plain text name of the Partner providing this attachment. This value may - * be validated to match approved Partner values. + * Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values. */ partnerName?: string; /** - * URL of the Partner?s portal for this Attachment. Partners may customise - * this to be a deep-link to the specific resource on the Partner portal. - * This value may be validated to match approved Partner values. + * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep-link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string; } /** - * Information for an interconnect attachment when this belongs to an - * interconnect of type DEDICATED. + * Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. */ export interface Schema$InterconnectAttachmentPrivateInfo { /** - * [Output Only] 802.1q encapsulation tag to be used for traffic between - * Google and the customer, going to and from this network and region. + * [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region. */ tag8021q?: number; } @@ -6103,8 +4491,7 @@ export namespace compute_beta { */ interconnectAttachments?: Schema$InterconnectAttachment[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -6113,9 +4500,7 @@ export namespace compute_beta { }; } /** - * Describes a single physical circuit between the Customer and Google. - * CircuitInfo objects are created by Google, so all fields are output only. - * Next id: 4 + * Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 */ export interface Schema$InterconnectCircuitInfo { /** @@ -6127,25 +4512,20 @@ export namespace compute_beta { */ googleCircuitId?: string; /** - * Google-side demarc ID for this circuit. Assigned at circuit turn-up and - * provided by Google to the customer in the LOA. + * Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. */ googleDemarcId?: string; } /** - * Diagnostics information about interconnect, contains detailed and current - * technical information about Google?s side of the connection. + * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. */ export interface Schema$InterconnectDiagnostics { /** - * A list of InterconnectDiagnostics.ARPEntry objects, describing individual - * neighbors currently seen by the Google router in the ARP cache for the - * Interconnect. This will be empty when the Interconnect is not bundled. + * A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled. */ arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; /** - * A list of InterconnectDiagnostics.LinkStatus objects, describing the - * status for each link on the Interconnect. + * A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect. */ links?: Schema$InterconnectDiagnosticsLinkStatus[]; /** @@ -6179,28 +4559,17 @@ export namespace compute_beta { } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { /** - * The status of the current value when compared to the warning and alarm - * levels for the receiving or transmitting transceiver. Possible states - * include: - OK: The value has not crossed a warning threshold. - - * LOW_WARNING: The value has crossed below the low warning threshold. - - * HIGH_WARNING: The value has crossed above the high warning threshold. - - * LOW_ALARM: The value has crossed below the low alarm threshold. - - * HIGH_ALARM: The value has crossed above the high alarm threshold. + * The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. */ state?: string; /** - * Value of the current receiving or transmitting optical power, read in - * dBm. Take a known good optical value, give it a 10% margin and trigger - * warnings relative to that value. In general, a -7dBm warning and a -11dBm - * alarm are good optical value estimates for most links. + * Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. */ value?: number; } export interface Schema$InterconnectDiagnosticsLinkStatus { /** - * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP - * neighbor entries seen on this link. This will be empty if the link is - * bundled + * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled */ arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; /** @@ -6213,13 +4582,11 @@ export namespace compute_beta { googleDemarc?: string; lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; /** - * An InterconnectDiagnostics.LinkOpticalPower object, describing the - * current value and status of the received light level. + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. */ receivingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; /** - * An InterconnectDiagnostics.LinkOpticalPower object, describing the - * current value and status of the transmitted light level. + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level. */ transmittingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; } @@ -6236,16 +4603,11 @@ export namespace compute_beta { */ items?: Schema$Interconnect[]; /** - * [Output Only] Type of resource. Always compute#interconnectList for lists - * of interconnects. + * [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6262,27 +4624,19 @@ export namespace compute_beta { }; } /** - * Represents an InterconnectLocations resource. The InterconnectLocations - * resource describes the locations where you can connect to Google's - * networks. For more information, see Colocation Facilities. + * Represents an InterconnectLocations resource. The InterconnectLocations resource describes the locations where you can connect to Google's networks. For more information, see Colocation Facilities. */ export interface Schema$InterconnectLocation { /** - * [Output Only] The postal address of the Point of Presence, each line in - * the address is separated by a newline character. + * [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. */ address?: string; /** - * [Output Only] Availability zone for this InterconnectLocation. Within a - * metropolitan area (metro), maintenance will not be simultaneously - * scheduled in more than one availability zone. Example: "zone1" - * or "zone2". + * [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". */ availabilityZone?: string; /** - * [Output Only] Metropolitan area designator that indicates which city an - * interconnect is located. For example: "Chicago, IL", - * "Amsterdam, Netherlands". + * [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". */ city?: string; /** @@ -6302,18 +4656,15 @@ export namespace compute_beta { */ facilityProvider?: string; /** - * [Output Only] A provider-assigned Identifier for this facility (e.g., - * Ashburn-DC1). + * [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). */ facilityProviderFacilityId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#interconnectLocation - * for interconnect locations. + * [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. */ kind?: string; /** @@ -6321,14 +4672,11 @@ export namespace compute_beta { */ name?: string; /** - * [Output Only] The peeringdb identifier for this facility (corresponding - * with a netfac type in peeringdb). + * [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). */ peeringdbFacilityId?: string; /** - * [Output Only] A list of InterconnectLocation.RegionInfo objects, that - * describe parameters pertaining to the relation between this - * InterconnectLocation and various Google Cloud regions. + * [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. */ regionInfos?: Schema$InterconnectLocationRegionInfo[]; /** @@ -6336,15 +4684,12 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The status of this InterconnectLocation. If the status is - * AVAILABLE, new Interconnects may be provisioned in this - * InterconnectLocation. Otherwise, no new Interconnects may be provisioned. + * [Output Only] The status of this InterconnectLocation. If the status is AVAILABLE, new Interconnects may be provisioned in this InterconnectLocation. Otherwise, no new Interconnects may be provisioned. */ status?: string; } /** - * Response to the list request, and contains a list of interconnect - * locations. + * Response to the list request, and contains a list of interconnect locations. */ export interface Schema$InterconnectLocationList { /** @@ -6356,16 +4701,11 @@ export namespace compute_beta { */ items?: Schema$InterconnectLocation[]; /** - * [Output Only] Type of resource. Always compute#interconnectLocationList - * for lists of interconnect locations. + * [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6382,14 +4722,11 @@ export namespace compute_beta { }; } /** - * Information about any potential InterconnectAttachments between an - * Interconnect at a specific InterconnectLocation, and a specific Cloud - * Region. + * Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. */ export interface Schema$InterconnectLocationRegionInfo { /** - * Expected round-trip time in milliseconds, from this InterconnectLocation - * to a VM in this region. + * Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. */ expectedRttMs?: string; /** @@ -6406,8 +4743,7 @@ export namespace compute_beta { */ export interface Schema$InterconnectOutageNotification { /** - * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs - * that will be affected. + * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. */ affectedCircuits?: string[]; /** @@ -6419,9 +4755,7 @@ export namespace compute_beta { */ endTime?: string; /** - * Form this outage is expected to take. Note that the "IT_" - * versions of this enum have been deprecated in favor of the unprefixed - * values. + * Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values. */ issueType?: string; /** @@ -6429,9 +4763,7 @@ export namespace compute_beta { */ name?: string; /** - * The party that generated this notification. Note that - * "NSRC_GOOGLE" has been deprecated in favor of - * "GOOGLE" + * The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE" */ source?: string; /** @@ -6439,8 +4771,7 @@ export namespace compute_beta { */ startTime?: string; /** - * State of this notification. Note that the "NS_" versions of - * this enum have been deprecated in favor of the unprefixed values. + * State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values. */ state?: string; } @@ -6455,8 +4786,7 @@ export namespace compute_beta { */ export interface Schema$License { /** - * [Output Only] Deprecated. This field no longer reflects whether a license - * charges a usage fee. + * [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. */ chargesUseFee?: boolean; /** @@ -6464,13 +4794,11 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -6478,13 +4806,11 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] The unique code used to attach this license to images, - * snapshots, and disks. + * [Output Only] The unique code used to attach this license to images, snapshots, and disks. */ licenseCode?: string; /** - * Name of the resource. The name must be 1-63 characters long and comply - * with RFC1035. + * Name of the resource. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; resourceRequirements?: Schema$LicenseResourceRequirements; @@ -6493,8 +4819,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * If false, licenses will not be copied from the source resource when - * creating an image from a disk, disk from snapshot, or snapshot from disk. + * If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. */ transferable?: boolean; } @@ -6508,8 +4833,7 @@ export namespace compute_beta { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -6517,13 +4841,11 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] URL and description aliases of Licenses with the same - * License Code. + * [Output Only] URL and description aliases of Licenses with the same License Code. */ licenseAlias?: Schema$LicenseCodeLicenseAlias[]; /** - * [Output Only] Name of the resource. The name is 1-20 characters long and - * must be a valid 64 bit integer. + * [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. */ name?: string; /** @@ -6535,9 +4857,7 @@ export namespace compute_beta { */ state?: string; /** - * [Output Only] If true, the license will remain attached when creating - * images or snapshots from disks. Otherwise, the license is not - * transferred. + * [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. */ transferable?: boolean; } @@ -6553,13 +4873,11 @@ export namespace compute_beta { } export interface Schema$LicenseResourceRequirements { /** - * Minimum number of guest cpus required to use the Instance. Enforced at - * Instance creation and Instance start. + * Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. */ minGuestCpuCount?: number; /** - * Minimum memory required to use the Instance. Enforced at Instance - * creation and Instance start. + * Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. */ minMemoryMb?: number; } @@ -6573,11 +4891,7 @@ export namespace compute_beta { */ items?: Schema$License[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6624,22 +4938,7 @@ export namespace compute_beta { logName?: string; } /** - * Increment a streamz counter with the specified metric and field names. - * Metric names should start with a '/', generally be lowercase-only, - * and end in "_count". Field names should not contain an initial - * slash. The actual exported metric names will have "/iam/policy" - * prepended. Field names correspond to IAM request parameters and field - * values are their respective values. Supported field names: - - * "authority", which is "[token]" if IAMContext.token is - * present, otherwise the value of IAMContext.authority_selector if present, - * and otherwise a representation of IAMContext.principal; or - - * "iam_principal", a representation of IAMContext.principal even if - * a token or authority selector is present; or - "" (empty string), - * resulting in a counter with no fields. Examples: counter { metric: - * "/debug_access_count" field: "iam_principal" } ==> - * increment counter /iam/policy/backend_debug_access_count - * {iam_principal=[value of IAMContext.principal]} At this time we do not - * support multiple field names (though this may be supported in the future). + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). */ export interface Schema$LogConfigCounterOptions { /** @@ -6656,18 +4955,12 @@ export namespace compute_beta { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. NOTE: - * Logging to Gin in a fail-closed manner is currently unsupported while - * work is being done to satisfy the requirements of go/345. Currently, - * setting LOG_FAIL_CLOSED mode will have no effect, but still exists - * because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ logMode?: string; } /** - * A Machine Type resource. (== resource_for v1.machineTypes ==) (== - * resource_for beta.machineTypes ==) + * A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) */ export interface Schema$MachineType { /** @@ -6683,23 +4976,19 @@ export namespace compute_beta { */ description?: string; /** - * [Output Only] The number of virtual CPUs that are available to the - * instance. + * [Output Only] The number of virtual CPUs that are available to the instance. */ guestCpus?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Whether this machine type has a shared CPU. See Shared-core - * machine types for more information. + * [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. */ isSharedCpu?: boolean; /** - * [Output Only] The type of the resource. Always compute#machineType for - * machine types. + * [Output Only] The type of the resource. Always compute#machineType for machine types. */ kind?: string; /** @@ -6711,8 +5000,7 @@ export namespace compute_beta { */ maximumPersistentDisksSizeGb?: string; /** - * [Output Only] The amount of physical memory available to the instance, - * defined in MB. + * [Output Only] The amount of physical memory available to the instance, defined in MB. */ memoryMb?: number; /** @@ -6724,8 +5012,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The name of the zone where the machine type resides, such - * as us-central1-a. + * [Output Only] The name of the zone where the machine type resides, such as us-central1-a. */ zone?: string; } @@ -6739,16 +5026,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$MachineTypesScopedList}; /** - * [Output Only] Type of resource. Always compute#machineTypeAggregatedList - * for aggregated lists of machine types. + * [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6777,16 +5059,11 @@ export namespace compute_beta { */ items?: Schema$MachineType[]; /** - * [Output Only] Type of resource. Always compute#machineTypeList for lists - * of machine types. + * [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6808,8 +5085,7 @@ export namespace compute_beta { */ machineTypes?: Schema$MachineType[]; /** - * [Output Only] An informational warning that appears when the machine - * types list is empty. + * [Output Only] An informational warning that appears when the machine types list is empty. */ warning?: { code?: string; @@ -6822,46 +5098,23 @@ export namespace compute_beta { */ export interface Schema$ManagedInstance { /** - * [Output Only] The current action that the managed instance group has - * scheduled for the instance. Possible values: - NONE The instance is - * running, and the managed instance group does not have any scheduled - * actions for this instance. - CREATING The managed instance group is - * creating this instance. If the group fails to create this instance, it - * will try again until it is successful. - CREATING_WITHOUT_RETRIES The - * managed instance group is attempting to create this instance only once. - * If the group fails to create this instance, it does not try again and the - * group's targetSize value is decreased instead. - RECREATING The - * managed instance group is recreating this instance. - DELETING The - * managed instance group is permanently deleting this instance. - - * ABANDONING The managed instance group is abandoning this instance. The - * instance will be removed from the instance group and from any target - * pools that are associated with this group. - RESTARTING The managed - * instance group is restarting the instance. - REFRESHING The managed - * instance group is applying configuration changes to the instance without - * stopping it. For example, the group can update the target pool list for - * an instance without stopping that instance. - VERIFYING The managed - * instance group has created the instance and it is in the process of being - * verified. + * [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. */ currentAction?: string; /** - * [Output only] The unique identifier for this resource. This field is - * empty when instance does not exist. + * [Output only] The unique identifier for this resource. This field is empty when instance does not exist. */ id?: string; /** - * [Output Only] The URL of the instance. The URL can exist even if the - * instance has not yet been created. + * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ instance?: string; /** - * [Output Only] The status of the instance. This field is empty when the - * instance does not exist. + * [Output Only] The status of the instance. This field is empty when the instance does not exist. */ instanceStatus?: string; /** - * [Output Only] Information about the last attempt to create or delete the - * instance. + * [Output Only] Information about the last attempt to create or delete the instance. */ lastAttempt?: Schema$ManagedInstanceLastAttempt; /** @@ -6871,8 +5124,7 @@ export namespace compute_beta { } export interface Schema$ManagedInstanceLastAttempt { /** - * [Output Only] Encountered errors during the last attempt to create or - * delete the instance. + * [Output Only] Encountered errors during the last attempt to create or delete the instance. */ errors?: { errors?: Array<{code?: string; location?: string; message?: string}>; @@ -6880,8 +5132,7 @@ export namespace compute_beta { } export interface Schema$ManagedInstanceVersion { /** - * [Output Only] The intended template of the instance. This field is empty - * when current_action is one of { DELETING, ABANDONING }. + * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. */ instanceTemplate?: string; /** @@ -6894,18 +5145,11 @@ export namespace compute_beta { */ export interface Schema$Metadata { /** - * Specifies a fingerprint for this request, which is essentially a hash of - * the metadata's contents and used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve the resource. + * Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. */ fingerprint?: string; /** - * Array of key/value pairs. The total size of all keys and values must be - * less than 512 KB. + * Array of key/value pairs. The total size of all keys and values must be less than 512 KB. */ items?: Array<{key?: string; value?: string}>; /** @@ -6918,8 +5162,7 @@ export namespace compute_beta { */ export interface Schema$NamedPort { /** - * The name for this named port. The name must be 1-63 characters long, and - * comply with RFC1035. + * The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** @@ -6928,17 +5171,11 @@ export namespace compute_beta { port?: number; } /** - * Represents a Network resource. Read Virtual Private Cloud (VPC) Network - * Overview for more information. (== resource_for v1.networks ==) (== - * resource_for beta.networks ==) + * Represents a Network resource. Read Virtual Private Cloud (VPC) Network Overview for more information. (== resource_for v1.networks ==) (== resource_for beta.networks ==) */ export interface Schema$Network { /** - * When set to true, the VPC network is created in "auto" mode. - * When set to false, the VPC network is created in "custom" mode. - * An auto mode VPC network starts with one subnet per region. Each subnet - * has a predetermined range as described in Auto mode VPC network IP - * ranges. + * When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. */ autoCreateSubnetworks?: boolean; /** @@ -6946,25 +5183,19 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The gateway address for default routing out of the network. - * This value is read only and is selected by GCP. + * [Output Only] The gateway address for default routing out of the network. This value is read only and is selected by GCP. */ gatewayIPv4?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Deprecated in favor of subnet mode networks. The range of internal - * addresses that are legal on this network. This range is a CIDR - * specification, for example: 192.168.0.0/16. Provided by the client when - * the network is created. + * Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. */ IPv4Range?: string; /** @@ -6972,13 +5203,7 @@ export namespace compute_beta { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -6986,9 +5211,7 @@ export namespace compute_beta { */ peerings?: Schema$NetworkPeering[]; /** - * The network-level routing configuration for this network. Used by Cloud - * Router to determine what type of network-wide routing behavior to - * enforce. + * The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. */ routingConfig?: Schema$NetworkRoutingConfig; /** @@ -6996,8 +5219,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] Server-defined fully-qualified URLs for all subnetworks in - * this VPC network. + * [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. */ subnetworks?: string[]; } @@ -7006,24 +5228,15 @@ export namespace compute_beta { */ export interface Schema$NetworkEndpoint { /** - * The name for a specific VM instance that the IP address belongs to. This - * is required for network endpoints of type GCE_VM_IP_PORT. The instance - * must be in the same zone of network endpoint group. The name must be - * 1-63 characters long, and comply with RFC1035. + * The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035. */ instance?: string; /** - * Optional IPv4 address of network endpoint. The IP address must belong to - * a VM in GCE (either the primary IP or as part of an aliased IP range). If - * the IP address is not specified, then the primary IP address for the VM - * instance in the network that the network endpoint group belongs to will - * be used. + * Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. */ ipAddress?: string; /** - * Optional port number of network endpoint. If not specified and the - * NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the - * defaultPort for the network endpoint group will be used. + * Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used. */ port?: number; } @@ -7036,48 +5249,35 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * The default port used if the port number is not specified in the network - * endpoint. + * The default port used if the port number is not specified in the network endpoint. */ defaultPort?: number; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#networkEndpointGroup - * for network endpoint group. + * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. */ kind?: string; /** - * This field is only valid when the network endpoint group is used for load - * balancing. [Deprecated] This field is deprecated. + * This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated. */ loadBalancer?: Schema$NetworkEndpointGroupLbNetworkEndpointGroup; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network to which all network endpoints in the NEG belong. - * Uses "default" project network if unspecified. + * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. */ network?: string; /** - * Type of network endpoints in this network endpoint group. Currently the - * only supported value is GCE_VM_IP_PORT. + * Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT. */ networkEndpointType?: string; /** @@ -7089,13 +5289,11 @@ export namespace compute_beta { */ size?: number; /** - * Optional URL of the subnetwork to which all network endpoints in the NEG - * belong. + * Optional URL of the subnetwork to which all network endpoints in the NEG belong. */ subnetwork?: string; /** - * [Output Only] The URL of the zone where the network endpoint group is - * located. + * [Output Only] The URL of the zone where the network endpoint group is located. */ zone?: string; } @@ -7109,17 +5307,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList}; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupAggregatedList for aggregated lists of - * network endpoint groups. + * [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7140,24 +5332,19 @@ export namespace compute_beta { */ export interface Schema$NetworkEndpointGroupLbNetworkEndpointGroup { /** - * The default port used if the port number is not specified in the network - * endpoint. [Deprecated] This field is deprecated. + * The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. */ defaultPort?: number; /** - * The URL of the network to which all network endpoints in the NEG belong. - * Uses "default" project network if unspecified. [Deprecated] - * This field is deprecated. + * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated. */ network?: string; /** - * Optional URL of the subnetwork to which all network endpoints in the NEG - * belong. [Deprecated] This field is deprecated. + * Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. */ subnetwork?: string; /** - * [Output Only] The URL of the zone where the network endpoint group is - * located. [Deprecated] This field is deprecated. + * [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. */ zone?: string; } @@ -7171,16 +5358,11 @@ export namespace compute_beta { */ items?: Schema$NetworkEndpointGroup[]; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupList for network endpoint group lists. + * [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7210,9 +5392,7 @@ export namespace compute_beta { } export interface Schema$NetworkEndpointGroupsListEndpointsRequest { /** - * Optional query parameter for showing the health status of each network - * endpoint. Valid options are SKIP or SHOW. If you don't specifiy this - * parameter, the health status of network endpoints will not be provided. + * Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided. */ healthStatus?: string; } @@ -7226,17 +5406,11 @@ export namespace compute_beta { */ items?: Schema$NetworkEndpointWithHealthStatus[]; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupsListNetworkEndpoints for the list of network - * endpoints in the specified network endpoint group. + * [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7250,13 +5424,11 @@ export namespace compute_beta { } export interface Schema$NetworkEndpointGroupsScopedList { /** - * [Output Only] The list of network endpoint groups that are contained in - * this scope. + * [Output Only] The list of network endpoint groups that are contained in this scope. */ networkEndpointGroups?: Schema$NetworkEndpointGroup[]; /** - * [Output Only] An informational warning that replaces the list of network - * endpoint groups when the list is empty. + * [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty. */ warning?: { code?: string; @@ -7279,62 +5451,35 @@ export namespace compute_beta { */ export interface Schema$NetworkInterface { /** - * An array of configurations for this interface. Currently, only one access - * config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs - * specified, then this instance will have no external internet access. + * An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. */ accessConfigs?: Schema$AccessConfig[]; /** - * An array of alias IP ranges for this network interface. Can only be - * specified for network interfaces on subnet-mode networks. + * An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. */ aliasIpRanges?: Schema$AliasIpRange[]; /** - * Fingerprint hash of contents stored in this network interface. This field - * will be ignored when inserting an Instance or adding a NetworkInterface. - * An up-to-date fingerprint must be provided in order to update the - * NetworkInterface, otherwise the request will fail with error 412 - * conditionNotMet. + * Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. */ fingerprint?: string; /** - * [Output Only] Type of the resource. Always compute#networkInterface for - * network interfaces. + * [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. */ kind?: string; /** - * [Output Only] The name of the network interface, generated by the server. - * For network devices, these are eth0, eth1, etc. + * [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. */ name?: string; /** - * URL of the network resource for this instance. When creating an instance, - * if neither the network nor the subnetwork is specified, the default - * network global/networks/default is used; if the network is not specified - * but the subnetwork is specified, the network is inferred. This field is - * optional when creating a firewall rule. If not specified when creating a - * firewall rule, the default network global/networks/default is used. If - * you specify this property, you can specify the network as a full or - * partial URL. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/global/networks/network - * - projects/project/global/networks/network - global/networks/default + * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ network?: string; /** - * An IPv4 internal network address to assign to the instance for this - * network interface. If not specified by the user, an unused internal IP is - * assigned by the system. + * An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ networkIP?: string; /** - * The URL of the Subnetwork resource for this instance. If the network - * resource is in legacy mode, do not provide this property. If the network - * is in auto subnet mode, providing the subnetwork is optional. If the - * network is in custom subnet mode, then this field should be specified. If - * you specify this property, you can specify the subnetwork as a full or - * partial URL. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - * - regions/region/subnetworks/subnetwork + * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string; } @@ -7351,16 +5496,11 @@ export namespace compute_beta { */ items?: Schema$Network[]; /** - * [Output Only] Type of resource. Always compute#networkList for lists of - * networks. + * [Output Only] Type of resource. Always compute#networkList for lists of networks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7377,26 +5517,15 @@ export namespace compute_beta { }; } /** - * A network peering attached to a network resource. The message includes the - * peering name, peer network, peering state, and a flag indicating whether - * Google Compute Engine should automatically create routes for the peering. + * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. */ export interface Schema$NetworkPeering { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes - * instead. Indicates whether full mesh connectivity is created and managed - * automatically. When it is set to true, Google Compute Engine will - * automatically create and manage the routes between two networks when the - * state is ACTIVE. Otherwise, user needs to create routes manually to route - * packets to peer network. + * This field will be deprecated soon. Prefer using exchange_subnet_routes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. */ autoCreateRoutes?: boolean; /** - * Whether full mesh connectivity is created and managed automatically. When - * it is set to true, Google Compute Engine will automatically create and - * manage the routes between two networks when the peering state is ACTIVE. - * Otherwise, user needs to create routes manually to route packets to peer - * network. + * Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. */ exchangeSubnetRoutes?: boolean; /** @@ -7408,19 +5537,11 @@ export namespace compute_beta { */ importCustomRoutes?: boolean; /** - * Name of this peering. Provided by the client when the peering is created. - * The name must comply with RFC1035. Specifically, the name must be 1-63 - * characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - * which means the first character must be a lowercase letter, and all the - * following characters must be a dash, lowercase letter, or digit, except - * the last character, which cannot be a dash. + * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the peer network. It can be either full URL or partial URL. - * The peer network may belong to a different project. If the partial URL - * does not contain project, it is assumed that the peer network is in the - * same project as the current network. + * The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ network?: string; /** @@ -7433,25 +5554,17 @@ export namespace compute_beta { stateDetails?: string; } /** - * A routing configuration attached to a network resource. The message - * includes the list of routers associated with the network, and a flag - * indicating the type of routing behavior to enforce network-wide. + * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. */ export interface Schema$NetworkRoutingConfig { /** - * The network-wide routing mode to use. If set to REGIONAL, this - * network's cloud routers will only advertise routes with subnets of - * this network in the same region as the router. If set to GLOBAL, this - * network's cloud routers will advertise routes with all subnets of - * this network, across regions. + * The network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. */ routingMode?: string; } export interface Schema$NetworksAddPeeringRequest { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes - * in network_peering instead. Whether Google Compute Engine manages the - * routes automatically. + * This field will be deprecated soon. Prefer using exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. */ autoCreateRoutes?: boolean; /** @@ -7459,18 +5572,11 @@ export namespace compute_beta { */ name?: string; /** - * Network peering parameters. In order to specify route policies for - * peering using import/export custom routes, you will have to fill all - * peering related parameters (name, peer network, exchange_subnet_routes) - * in network_peeringfield. Corresponding fields in - * NetworksAddPeeringRequest will be deprecated soon. + * Network peering parameters. In order to specify route policies for peering using import/export custom routes, you will have to fill all peering related parameters (name, peer network, exchange_subnet_routes) in network_peeringfield. Corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ networkPeering?: Schema$NetworkPeering; /** - * URL of the peer network. It can be either full URL or partial URL. The - * peer network may belong to a different project. If the partial URL does - * not contain project, it is assumed that the peer network is in the same - * project as the current network. + * URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ peerNetwork?: string; } @@ -7484,10 +5590,7 @@ export namespace compute_beta { networkPeering?: Schema$NetworkPeering; } /** - * A NodeGroup resource. To create a node group, you must first create a node - * templates. To learn more about node groups and sole-tenant nodes, read the - * Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== - * resource_for v1.nodeGroups ==) + * A NodeGroup resource. To create a node group, you must first create a node templates. To learn more about node groups and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) */ export interface Schema$NodeGroup { /** @@ -7495,28 +5598,19 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeGroup for node - * group. + * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -7533,8 +5627,7 @@ export namespace compute_beta { size?: number; status?: string; /** - * [Output Only] The name of the zone where the node group resides, such as - * us-central1-a. + * [Output Only] The name of the zone where the node group resides, such as us-central1-a. */ zone?: string; } @@ -7548,16 +5641,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$NodeGroupsScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for - * aggregated lists of node groups. + * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7586,16 +5674,11 @@ export namespace compute_beta { */ items?: Schema$NodeGroup[]; /** - * [Output Only] Type of resource.Always compute#nodeGroupList for lists of - * node groups. + * [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7649,17 +5732,11 @@ export namespace compute_beta { */ items?: Schema$NodeGroupNode[]; /** - * [Output Only] The resource type, which is always - * compute.nodeGroupsListNodes for the list of nodes in the specified node - * group. + * [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7681,8 +5758,7 @@ export namespace compute_beta { */ nodeGroups?: Schema$NodeGroup[]; /** - * [Output Only] An informational warning that appears when the nodeGroup - * list is empty. + * [Output Only] An informational warning that appears when the nodeGroup list is empty. */ warning?: { code?: string; @@ -7692,15 +5768,12 @@ export namespace compute_beta { } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** - * Full or partial URL of the node template resource to be updated for this - * node group. + * Full or partial URL of the node template resource to be updated for this node group. */ nodeTemplate?: string; } /** - * A Node Template resource. To learn more about node templates and - * sole-tenant nodes, read the Sole-tenant nodes documentation. (== - * resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * A Node Template resource. To learn more about node templates and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) */ export interface Schema$NodeTemplate { /** @@ -7708,33 +5781,23 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeTemplate for - * node templates. + * [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Labels to use for node affinity, which will be used in instance - * scheduling. + * Labels to use for node affinity, which will be used in instance scheduling. */ nodeAffinityLabels?: {[key: string]: string}; /** @@ -7742,15 +5805,11 @@ export namespace compute_beta { */ nodeType?: string; /** - * The flexible properties of the desired node type. Node groups that use - * this node template will create nodes of a type that matches these - * properties. This field is mutually exclusive with the node_type - * property; you can only define one or the other, but not both. + * The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. */ nodeTypeFlexibility?: Schema$NodeTemplateNodeTypeFlexibility; /** - * [Output Only] The name of the region where the node template resides, - * such as us-central1. + * [Output Only] The name of the region where the node template resides, such as us-central1. */ region?: string; /** @@ -7762,8 +5821,7 @@ export namespace compute_beta { */ serverBinding?: Schema$ServerBinding; /** - * [Output Only] The status of the node template. One of the following - * values: CREATING, READY, and DELETING. + * [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. */ status?: string; /** @@ -7781,16 +5839,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$NodeTemplatesScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList - * for aggregated lists of node templates. + * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7819,16 +5872,11 @@ export namespace compute_beta { */ items?: Schema$NodeTemplate[]; /** - * [Output Only] Type of resource.Always compute#nodeTemplateList for lists - * of node templates. + * [Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7855,8 +5903,7 @@ export namespace compute_beta { */ nodeTemplates?: Schema$NodeTemplate[]; /** - * [Output Only] An informational warning that appears when the node - * templates list is empty. + * [Output Only] An informational warning that appears when the node templates list is empty. */ warning?: { code?: string; @@ -7885,18 +5932,15 @@ export namespace compute_beta { */ description?: string; /** - * [Output Only] The number of virtual CPUs that are available to the node - * type. + * [Output Only] The number of virtual CPUs that are available to the node type. */ guestCpus?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeType for node - * types. + * [Output Only] The type of the resource. Always compute#nodeType for node types. */ kind?: string; /** @@ -7904,8 +5948,7 @@ export namespace compute_beta { */ localSsdGb?: number; /** - * [Output Only] The amount of physical memory available to the node type, - * defined in MB. + * [Output Only] The amount of physical memory available to the node type, defined in MB. */ memoryMb?: number; /** @@ -7917,8 +5960,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The name of the zone where the node type resides, such as - * us-central1-a. + * [Output Only] The name of the zone where the node type resides, such as us-central1-a. */ zone?: string; } @@ -7932,16 +5974,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$NodeTypesScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for - * aggregated lists of node types. + * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7970,16 +6007,11 @@ export namespace compute_beta { */ items?: Schema$NodeType[]; /** - * [Output Only] Type of resource.Always compute#nodeTypeList for lists of - * node types. + * [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8001,8 +6033,7 @@ export namespace compute_beta { */ nodeTypes?: Schema$NodeType[]; /** - * [Output Only] An informational warning that appears when the node types - * list is empty. + * [Output Only] An informational warning that appears when the node types list is empty. */ warning?: { code?: string; @@ -8011,16 +6042,11 @@ export namespace compute_beta { }; } /** - * An Operation resource, used to manage asynchronous API requests. (== - * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations - * ==) (== resource_for v1.regionOperations ==) (== resource_for - * beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== - * resource_for beta.zoneOperations ==) + * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** - * [Output Only] The value of `requestId` if you provided it in the request. - * Not present otherwise. + * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ clientOperationId?: string; /** @@ -8028,46 +6054,37 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * [Output Only] A textual description of the operation, which is set when - * the operation is created. + * [Output Only] A textual description of the operation, which is set when the operation is created. */ description?: string; /** - * [Output Only] The time that this operation was completed. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ endTime?: string; /** - * [Output Only] If errors are generated during processing of the operation, - * this field will be populated. + * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * message that was returned, such as NOT FOUND. + * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ httpErrorMessage?: string; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * status code that was returned. For example, a 404 means the resource was - * not found. + * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ httpErrorStatusCode?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The time that this operation was requested. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ insertTime?: string; /** - * [Output Only] Type of the resource. Always compute#operation for - * Operation resources. + * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ kind?: string; /** @@ -8075,23 +6092,15 @@ export namespace compute_beta { */ name?: string; /** - * [Output Only] The type of operation, such as insert, update, or delete, - * and so on. + * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ operationType?: string; /** - * [Output Only] An optional progress indicator that ranges from 0 to 100. - * There is no requirement that this be linear or support any granularity of - * operations. This should not be used to guess when the operation will be - * complete. This number should monotonically increase as the operation - * progresses. + * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only - * available when performing regional operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -8099,39 +6108,31 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The time that this operation was started by the server. - * This value is in RFC3339 text format. + * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ startTime?: string; /** - * [Output Only] The status of the operation, which can be one of the - * following: PENDING, RUNNING, or DONE. + * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ status?: string; /** - * [Output Only] An optional textual description of the current status of - * the operation. + * [Output Only] An optional textual description of the current status of the operation. */ statusMessage?: string; /** - * [Output Only] The unique target ID, which identifies a specific - * incarnation of the target resource. + * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ targetId?: string; /** - * [Output Only] The URL of the resource that the operation modifies. For - * operations related to creating a snapshot, this points to the persistent - * disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ targetLink?: string; /** - * [Output Only] User who requested the operation, for example: - * user@example.com. + * [Output Only] User who requested the operation, for example: user@example.com. */ user?: string; /** - * [Output Only] If warning messages are generated during processing of the - * operation, this field will be populated. + * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ warnings?: Array<{ code?: string; @@ -8139,17 +6140,13 @@ export namespace compute_beta { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only - * available when performing per-zone operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } export interface Schema$OperationAggregatedList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -8157,16 +6154,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$OperationsScopedList}; /** - * [Output Only] Type of resource. Always compute#operationAggregatedList - * for aggregated lists of operations. + * [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8187,8 +6179,7 @@ export namespace compute_beta { */ export interface Schema$OperationList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -8196,16 +6187,11 @@ export namespace compute_beta { */ items?: Schema$Operation[]; /** - * [Output Only] Type of resource. Always compute#operations for Operations - * resource. + * [Output Only] Type of resource. Always compute#operations for Operations resource. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8227,8 +6213,7 @@ export namespace compute_beta { */ operations?: Schema$Operation[]; /** - * [Output Only] Informational warning which replaces the list of operations - * when the list is empty. + * [Output Only] Informational warning which replaces the list of operations when the list is empty. */ warning?: { code?: string; @@ -8237,34 +6222,15 @@ export namespace compute_beta { }; } /** - * A matcher for the path portion of the URL. The BackendService from the - * longest-matched rule will serve the URL. If no rule was matched, the - * default service will be used. + * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. */ export interface Schema$PathMatcher { /** - * The full or partial URL to the BackendService resource. This will be used - * if none of the pathRules or routeRules defined by this PathMatcher are - * matched. For example, the following are all valid URLs to a - * BackendService resource: - - * https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - * - compute/v1/projects/project/global/backendServices/backendService - - * global/backendServices/backendService If defaultRouteAction is - * additionally specified, advanced routing actions like URL Rewrites, etc. - * take effect prior to sending the request to the backend. However, if - * defaultService is specified, defaultRouteAction cannot contain any - * weightedBackendServices. Conversely, if defaultRouteAction specifies any - * weightedBackendServices, defaultService must not be specified. Only one - * of defaultService, defaultUrlRedirect or - * defaultRouteAction.weightedBackendService must be set. Authorization - * requires one or more of the following Google IAM permissions on the - * specified resource default_service: - compute.backendBuckets.use - - * compute.backendServices.use + * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use */ defaultService?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -8272,58 +6238,25 @@ export namespace compute_beta { */ name?: string; /** - * The list of path rules. Use this list instead of routeRules when routing - * based on simple path matching is all that's required. The order by - * which path rules are specified does not matter. Matches are always done - * on the longest-path-first basis. For example: a pathRule with a path - * /a/b/c/* will match before /a/b/* irrespective of the order in which - * those paths appear in this list. Only one of pathRules or routeRules must - * be set. + * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. */ pathRules?: Schema$PathRule[]; } /** - * A path-matching rule for a URL. If matched, will use the specified - * BackendService to handle the traffic arriving at this URL. + * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. */ export interface Schema$PathRule { /** - * The list of path patterns to match. Each must start with / and the only - * place a * is allowed is at the end following a /. The string fed to the - * path matcher does not include any text after the first ? or #, and those - * chars are not allowed here. + * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. */ paths?: string[]; /** - * The full or partial URL of the backend service resource to which traffic - * is directed if this rule is matched. If routeAction is additionally - * specified, advanced routing actions like URL Rewrites, etc. take effect - * prior to sending the request to the backend. However, if service is - * specified, routeAction cannot contain any weightedBackendService s. - * Conversely, if routeAction specifies any weightedBackendServices, - * service must not be specified. Only one of urlRedirect, service or - * routeAction.weightedBackendService must be set. + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ service?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML Example** bindings: - - * members: - user:mike@example.com - group:admins@example.com - - * domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com - * role: roles/owner - members: - user:sean@example.com role: roles/viewer For - * a description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -8331,31 +6264,16 @@ export namespace compute_beta { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; iamOwned?: boolean; /** - * If more than one rule is specified, the rules are applied in the - * following manner: - All matching LOG rules are always applied. - If any - * DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be - * applied if one or more matching rule requires logging. - Otherwise, if - * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging - * will be applied if one or more matching rule requires logging. - - * Otherwise, if no rule applies, permission is denied. + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ rules?: Schema$Rule[]; /** @@ -8370,14 +6288,11 @@ export namespace compute_beta { expressionSets?: Schema$WafExpressionSet[]; } /** - * A Project resource. For an overview of projects, see Cloud Platform - * Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for - * beta.projects ==) + * A Project resource. For an overview of projects, see Cloud Platform Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) */ export interface Schema$Project { /** - * Metadata key/value pairs available to all instances contained in this - * project. See Custom metadata for more information. + * Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. */ commonInstanceMetadata?: Schema$Metadata; /** @@ -8385,14 +6300,11 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * This signifies the default network tier used for configuring resources of - * the project and can only take the following values: PREMIUM, STANDARD. - * Initially the default network tier is PREMIUM. + * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. */ defaultNetworkTier?: string; /** - * [Output Only] Default service account used by VMs running in this - * project. + * [Output Only] Default service account used by VMs running in this project. */ defaultServiceAccount?: string; /** @@ -8404,9 +6316,7 @@ export namespace compute_beta { */ enabledFeatures?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. This is not the project ID, and is just a unique - * ID used by Compute Engine to identify resources. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. */ id?: string; /** @@ -8414,8 +6324,7 @@ export namespace compute_beta { */ kind?: string; /** - * The project ID. For example: my-example-project. Use the project ID to - * make requests to Compute Engine. + * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. */ name?: string; /** @@ -8427,13 +6336,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * The naming prefix for daily usage reports and the Google Cloud Storage - * bucket where they are stored. + * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. */ usageExportLocation?: Schema$UsageExportLocation; /** - * [Output Only] The role this project has in a shared VPC configuration. - * Currently only HOST projects are differentiated. + * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. */ xpnProjectStatus?: string; } @@ -8451,29 +6358,21 @@ export namespace compute_beta { } export interface Schema$ProjectsGetXpnResources { /** - * [Output Only] Type of resource. Always compute#projectsGetXpnResources - * for lists of service resources (a.k.a service projects) + * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** - * Service resources (a.k.a service projects) attached to this project as - * their shared VPC host. + * Service resources (a.k.a service projects) attached to this project as their shared VPC host. */ resources?: Schema$XpnResourceId[]; } export interface Schema$ProjectsListXpnHostsRequest { /** - * Optional organization ID managed by Cloud Resource Manager, for which to - * list shared VPC host projects. If not specified, the organization will be - * inferred from the project. + * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. */ organization?: string; } @@ -8496,8 +6395,7 @@ export namespace compute_beta { */ metric?: string; /** - * [Output Only] Owning resource. This is the resource on which this quota - * is applied. + * [Output Only] Owning resource. This is the resource on which this quota is applied. */ owner?: string; /** @@ -8510,13 +6408,11 @@ export namespace compute_beta { */ export interface Schema$Reference { /** - * [Output Only] Type of the resource. Always compute#reference for - * references. + * [Output Only] Type of the resource. Always compute#reference for references. */ kind?: string; /** - * A description of the reference type with no implied semantics. Possible - * values include: - MEMBER_OF + * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF */ referenceType?: string; /** @@ -8529,8 +6425,7 @@ export namespace compute_beta { target?: string; } /** - * Region resource. (== resource_for beta.regions ==) (== resource_for - * v1.regions ==) + * Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==) */ export interface Schema$Region { /** @@ -8546,8 +6441,7 @@ export namespace compute_beta { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -8571,8 +6465,7 @@ export namespace compute_beta { */ status?: string; /** - * [Output Only] A list of zones available in this region, in the form of - * resource URLs. + * [Output Only] A list of zones available in this region, in the form of resource URLs. */ zones?: string[]; } @@ -8593,11 +6486,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8615,8 +6504,7 @@ export namespace compute_beta { } export interface Schema$RegionCommitmentsUpdateReservationsRequest { /** - * List of reservations for the capacity move of VMs with accelerators and - * local ssds. + * List of reservations for the capacity move of VMs with accelerators and local ssds. */ reservations?: Schema$Reservation[]; } @@ -8648,16 +6536,11 @@ export namespace compute_beta { */ items?: Schema$DiskType[]; /** - * [Output Only] Type of resource. Always compute#regionDiskTypeList for - * region disk types. + * [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8690,11 +6573,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8723,17 +6602,11 @@ export namespace compute_beta { */ items?: Schema$InstanceGroupManager[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerList for a list of managed instance groups - * that exist in th regional scope. + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8751,8 +6624,7 @@ export namespace compute_beta { } export interface Schema$RegionInstanceGroupManagersAbandonInstancesRequest { /** - * The URLs of one or more instances to abandon. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -8761,25 +6633,21 @@ export namespace compute_beta { */ export interface Schema$RegionInstanceGroupManagersApplyUpdatesRequest { /** - * The list of instances for which we want to apply changes on this managed - * instance group. + * The list of instances for which we want to apply changes on this managed instance group. */ instances?: string[]; /** - * The minimal action that should be perfomed on the instances. By default - * NONE. + * The minimal action that should be perfomed on the instances. By default NONE. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. - * By default REPLACE. + * The most disruptive action that allowed to be performed on the instances. By default REPLACE. */ mostDisruptiveAllowedAction?: string; } export interface Schema$RegionInstanceGroupManagersDeleteInstancesRequest { /** - * The URLs of one or more instances to delete. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -8789,18 +6657,13 @@ export namespace compute_beta { */ managedInstances?: Schema$ManagedInstance[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; } export interface Schema$RegionInstanceGroupManagersRecreateRequest { /** - * The URLs of one or more instances to recreate. This can be a full URL or - * a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -8809,22 +6672,17 @@ export namespace compute_beta { } export interface Schema$RegionInstanceGroupManagersSetTargetPoolsRequest { /** - * Fingerprint of the target pools information, which is a hash of the - * contents. This field is used for optimistic locking when you update the - * target pool entries. This field is optional. + * Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional. */ fingerprint?: string; /** - * The URL of all TargetPool resources to which instances in the - * instanceGroup field are added. The target pools automatically apply to - * all of the instances in the managed instance group. + * The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ targetPools?: string[]; } export interface Schema$RegionInstanceGroupManagersSetTemplateRequest { /** - * URL of the InstanceTemplate resource from which all new instances will be - * created. + * URL of the InstanceTemplate resource from which all new instances will be created. */ instanceTemplate?: string; } @@ -8842,11 +6700,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8864,25 +6718,17 @@ export namespace compute_beta { } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** - * Instances in which state should be returned. Valid options are: - * 'ALL', 'RUNNING'. By default, it lists all instances. + * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. */ instanceState?: string; /** - * Name of port user is interested in. It is optional. If it is set, only - * information about this ports will be returned. If it is not set, all the - * named ports will be returned. Always lists all instances. + * Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. */ portName?: string; } export interface Schema$RegionInstanceGroupsSetNamedPortsRequest { /** - * The fingerprint of the named ports information for this instance group. - * Use this optional property to prevent conflicts when multiple users - * change the named ports settings concurrently. Obtain the fingerprint with - * the instanceGroups.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ fingerprint?: string; /** @@ -8903,16 +6749,11 @@ export namespace compute_beta { */ items?: Schema$Region[]; /** - * [Output Only] Type of resource. Always compute#regionList for lists of - * regions. + * [Output Only] Type of resource. Always compute#regionList for lists of regions. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8930,12 +6771,7 @@ export namespace compute_beta { } export interface Schema$RegionSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash in order to update or - * change labels. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** @@ -8945,20 +6781,15 @@ export namespace compute_beta { } export interface Schema$RegionSetPolicyRequest { /** - * Flatten Policy to create a backwacd compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -8967,8 +6798,7 @@ export namespace compute_beta { */ export interface Schema$Reservation { /** - * [OutputOnly] Full or partial url for parent commitment for reservations - * which are tied to a commitment. + * [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment. */ commitment?: string; /** @@ -8976,28 +6806,19 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#reservations for - * reservations. + * [Output Only] Type of the resource. Always compute#reservations for reservations. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -9009,21 +6830,16 @@ export namespace compute_beta { */ specificReservation?: Schema$AllocationSpecificSKUReservation; /** - * Indicates whether the reservation can be consumed by VMs with "any - * reservation" defined. If the field is set, then only VMs that target - * the reservation by name using --reservation-affinity can consume this - * reservation. + * Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation. */ specificReservationRequired?: boolean; /** - * Zone in which the reservation resides, must be provided if reservation is - * created with commitment creation. + * Zone in which the reservation resides, must be provided if reservation is created with commitment creation. */ zone?: string; } /** - * AllocationAffinity is the configuration of desired allocation which this - * instance could take capacity from. + * AllocationAffinity is the configuration of desired allocation which this instance could take capacity from. */ export interface Schema$ReservationAffinity { consumeReservationType?: string; @@ -9053,11 +6869,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9075,8 +6887,7 @@ export namespace compute_beta { } export interface Schema$ReservationList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -9084,16 +6895,11 @@ export namespace compute_beta { */ items?: Schema$Reservation[]; /** - * [Output Only] Type of resource.Always compute#reservationsList for - * listsof reservations + * [Output Only] Type of resource.Always compute#reservationsList for listsof reservations */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9111,8 +6917,7 @@ export namespace compute_beta { } export interface Schema$ReservationsResizeRequest { /** - * Number of allocated resources can be resized with minimum = 1 and maximum - * = 1000. + * Number of allocated resources can be resized with minimum = 1 and maximum = 1000. */ specificSkuCount?: string; } @@ -9122,8 +6927,7 @@ export namespace compute_beta { */ reservations?: Schema$Reservation[]; /** - * Informational warning which replaces the list of reservations when the - * list is empty. + * Informational warning which replaces the list of reservations when the list is empty. */ warning?: { code?: string; @@ -9132,32 +6936,25 @@ export namespace compute_beta { }; } /** - * Commitment for a particular resource (a Commitment is composed of one or - * more of these). + * Commitment for a particular resource (a Commitment is composed of one or more of these). */ export interface Schema$ResourceCommitment { /** - * Name of the accelerator type resource. Applicable only when the type is - * ACCELERATOR. + * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. */ acceleratorType?: string; /** - * The amount of the resource purchased (in a type-dependent unit, such as - * bytes). For vCPUs, this can just be an integer. For memory, this must be - * provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of - * memory per every vCPU. + * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. */ amount?: string; /** - * Type of resource for which this commitment applies. Possible values are - * VCPU and MEMORY + * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY */ type?: string; } export interface Schema$ResourceGroupReference { /** - * A URI referencing one of the instance groups or network endpoint groups - * listed in the backend service. + * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. */ group?: string; } @@ -9167,8 +6964,7 @@ export namespace compute_beta { */ resourcePolicies?: Schema$ResourcePolicy[]; /** - * Informational warning which replaces the list of resourcePolicies when - * the list is empty. + * Informational warning which replaces the list of resourcePolicies when the list is empty. */ warning?: { code?: string; @@ -9183,23 +6979,15 @@ export namespace compute_beta { creationTimestamp?: string; description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#resource_policies for - * resource policies. + * [Output Only] Type of the resource. Always compute#resource_policies for resource policies. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; region?: string; @@ -9234,11 +7022,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9263,14 +7047,11 @@ export namespace compute_beta { */ daysInCycle?: number; /** - * [Output only] A predetermined duration for the window, automatically - * chosen to be the smallest possible in the given scenario. + * [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. */ duration?: string; /** - * Start time of the window. This must be in UTC format that resolves to one - * of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 - * and 08:00 are valid. + * Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid. */ startTime?: string; } @@ -9279,8 +7060,7 @@ export namespace compute_beta { */ export interface Schema$ResourcePolicyHourlyCycle { /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ duration?: string; /** @@ -9288,16 +7068,14 @@ export namespace compute_beta { */ hoursInCycle?: number; /** - * Time within the window to start the operations. It must be in format - * "HH:MM", where HH : [00-23] and MM : [00-00] GMT. + * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } export interface Schema$ResourcePolicyList { etag?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -9305,16 +7083,11 @@ export namespace compute_beta { */ items?: Schema$ResourcePolicy[]; /** - * [Output Only] Type of resource.Always compute#resourcePoliciesList for - * listsof resourcePolicies + * [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9331,9 +7104,7 @@ export namespace compute_beta { }; } /** - * A snapshot schedule policy specifies when and how frequently snapshots are - * to be created for the target disk. Also specifies how many and how long - * these scheduled snapshots should be retained. + * A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. */ export interface Schema$ResourcePolicySnapshotSchedulePolicy { /** @@ -9341,14 +7112,11 @@ export namespace compute_beta { */ retentionPolicy?: Schema$ResourcePolicySnapshotSchedulePolicyRetentionPolicy; /** - * A Vm Maintenance Policy specifies what kind of infrastructure maintenance - * we are allowed to perform on this VM and when. Schedule that is applied - * to disks covered by this policy. + * A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy. */ schedule?: Schema$ResourcePolicySnapshotSchedulePolicySchedule; /** - * Properties with which snapshots are created such as labels, encryption - * keys. + * Properties with which snapshots are created such as labels, encryption keys. */ snapshotProperties?: Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties; } @@ -9361,8 +7129,7 @@ export namespace compute_beta { */ maxRetentionDays?: number; /** - * Specifies the behavior to apply to scheduled snapshots when the source - * disk is deleted. + * Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. */ onSourceDiskDelete?: string; } @@ -9375,8 +7142,7 @@ export namespace compute_beta { weeklySchedule?: Schema$ResourcePolicyWeeklyCycle; } /** - * Specified snapshot properties for scheduled snapshots created by this - * policy. + * Specified snapshot properties for scheduled snapshots created by this policy. */ export interface Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties { /** @@ -9384,13 +7150,11 @@ export namespace compute_beta { */ guestFlush?: boolean; /** - * Labels to apply to scheduled snapshots. These can be later modified by - * the setLabels method. Label values may be empty. + * Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. */ labels?: {[key: string]: string}; /** - * GCS bucket storage location of the auto snapshot (regional or - * multi-regional). + * GCS bucket storage location of the auto snapshot (regional or multi-regional). */ storageLocations?: string[]; } @@ -9409,31 +7173,16 @@ export namespace compute_beta { */ day?: string; /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ duration?: string; /** - * Time within the window to start the operations. It must be in format - * "HH:MM", where HH : [00-23] and MM : [00-00] GMT. + * Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } /** - * Represents a Route resource. A route specifies how certain packets should - * be handled by the network. Routes are associated with instances by tags and - * the set of routes for a particular instance is called its routing table. - * For each packet leaving an instance, the system searches that - * instance's routing table for a single best matching route. Routes match - * packets by destination IP address, preferring smaller or more specific - * ranges over larger ones. If there is a tie, the system selects the route - * with the smallest priority value. If there is still a tie, it uses the - * layer three and four packet headers to select just one of the remaining - * matching routes. The packet is then forwarded as specified by the nextHop - * field of the winning route - either to another instance destination, an - * instance gateway, or a Google Compute Engine-operated gateway. Packets - * that do not match any route in the sending instance's routing table are - * dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + * Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table. For each packet leaving an instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway. Packets that do not match any route in the sending instance's routing table are dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) */ export interface Schema$Route { /** @@ -9441,33 +7190,23 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The destination range of outgoing packets that this route applies to. - * Only IPv4 is supported. + * The destination range of outgoing packets that this route applies to. Only IPv4 is supported. */ destRange?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of this resource. Always compute#routes for Route - * resources. + * [Output Only] Type of this resource. Always compute#routes for Route resources. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -9475,37 +7214,23 @@ export namespace compute_beta { */ network?: string; /** - * The URL to a gateway that should handle matching packets. You can only - * specify the internet gateway using a full or partial valid URL: - * projects/<project-id>/global/gateways/default-internet-gateway + * The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway */ nextHopGateway?: string; /** - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that - * should handle matching packets. You can only specify the forwarding rule - * as a partial or full URL. For example, the following are all valid URLs: - * - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - * - regions/region/forwardingRules/forwardingRule Note that this can only - * be used when the destination_range is a public (non-RFC 1918) IP CIDR - * range. + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Note that this can only be used when the destination_range is a public (non-RFC 1918) IP CIDR range. */ nextHopIlb?: string; /** - * The URL to an instance that should handle matching packets. You can - * specify this as a full or partial URL. For example: - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ + * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ nextHopInstance?: string; /** - * [Output Only] The URL to an InterconnectAttachment which is the next hop - * for the route. This field will only be populated for the dynamic routes - * generated by Cloud Router with a linked interconnectAttachment. + * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. */ nextHopInterconnectAttachment?: string; /** - * The network IP address of an instance that should handle matching - * packets. Only IPv4 is supported. + * The network IP address of an instance that should handle matching packets. Only IPv4 is supported. */ nextHopIp?: string; /** @@ -9513,8 +7238,7 @@ export namespace compute_beta { */ nextHopNetwork?: string; /** - * [Output Only] The network peering name that should handle matching - * packets, which should conform to RFC1035. + * [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. */ nextHopPeering?: string; /** @@ -9522,11 +7246,7 @@ export namespace compute_beta { */ nextHopVpnTunnel?: string; /** - * The priority of this route. Priority is used to break ties in cases where - * there is more than one matching route of equal prefix length. In the case - * of two routes with equal prefix length, the one with the lowest-numbered - * priority value wins. Default value is 1000. Valid range is 0 through - * 65535. + * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. */ priority?: number; /** @@ -9538,8 +7258,7 @@ export namespace compute_beta { */ tags?: string[]; /** - * [Output Only] If potential misconfigurations are detected for this route, - * this field will be populated with warning messages. + * [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. */ warnings?: Array<{ code?: string; @@ -9564,11 +7283,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9593,9 +7308,7 @@ export namespace compute_beta { */ bgp?: Schema$RouterBgp; /** - * BGP information that needs to be configured into the routing stack to - * establish the BGP peering. It must specify peer ASN and either interface - * name, IP, or peer IP. Please refer to RFC4273. + * BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273. */ bgpPeers?: Schema$RouterBgpPeer[]; /** @@ -9603,19 +7316,15 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Router interfaces. Each interface requires either one linked resource - * (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. - * ipRange), or both. + * Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both. */ interfaces?: Schema$RouterInterface[]; /** @@ -9623,13 +7332,7 @@ export namespace compute_beta { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -9641,9 +7344,7 @@ export namespace compute_beta { */ network?: string; /** - * [Output Only] URI of the region where the router resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -9681,11 +7382,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9703,19 +7400,11 @@ export namespace compute_beta { } export interface Schema$RouterBgp { /** - * User-specified list of prefix groups to advertise in custom mode. This - * field can only be populated if advertise_mode is CUSTOM and is advertised - * to all peers of the router. These groups will be advertised in addition - * to any specified prefixes. Leave this field blank to advertise no custom - * groups. + * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. - * This field can only be populated if advertise_mode is CUSTOM and is - * advertised to all peers of the router. These IP ranges will be advertised - * in addition to any specified groups. Leave this field blank to advertise - * no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** @@ -9723,34 +7412,21 @@ export namespace compute_beta { */ advertiseMode?: string; /** - * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, - * either 16-bit or 32-bit. The value will be fixed for this router - * resource. All VPN tunnels that link to this router will have the same - * local ASN. + * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN. */ asn?: number; } export interface Schema$RouterBgpPeer { /** - * User-specified list of prefix groups to advertise in custom mode. This - * field can only be populated if advertise_mode is CUSTOM and overrides the - * list defined for the router (in Bgp message). These groups will be - * advertised in addition to any specified prefixes. Leave this field blank - * to advertise no custom groups. + * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. - * This field can only be populated if advertise_mode is CUSTOM and - * overrides the list defined for the router (in Bgp message). These IP - * ranges will be advertised in addition to any specified groups. Leave this - * field blank to advertise no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * The priority of routes advertised to this BGP peer. In the case where - * there is more than one matching route of maximum length, the routes with - * lowest priority value win. + * The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win. */ advertisedRoutePriority?: number; /** @@ -9762,69 +7438,45 @@ export namespace compute_beta { */ interfaceName?: string; /** - * IP address of the interface inside Google Cloud Platform. Only IPv4 is - * supported. + * IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. */ ipAddress?: string; /** - * [Output Only] The resource that configures and manages this BGP peer. - * MANAGED_BY_USER is the default value and can be managed by you or other - * users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed - * by Cloud Interconnect, specifically by an InterconnectAttachment of type - * PARTNER. Google will automatically create, update, and delete this type - * of BGP peer when the PARTNER InterconnectAttachment is created, updated, - * or deleted. + * [Output Only] The resource that configures and manages this BGP peer. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** - * Name of this BGP peer. The name must be 1-63 characters long and comply - * with RFC1035. + * Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; /** - * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can - * be different for every tunnel. + * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel. */ peerAsn?: number; /** - * IP address of the BGP interface outside Google cloud. Only IPv4 is - * supported. + * IP address of the BGP interface outside Google cloud. Only IPv4 is supported. */ peerIpAddress?: string; } export interface Schema$RouterInterface { /** - * IP address and range of the interface. The IP range must be in the - * RFC3927 link-local IP space. The value must be a CIDR-formatted string, - * for example: 169.254.0.1/30. NOTE: Do not truncate the address as it - * represents the IP address of the interface. + * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ ipRange?: string; /** - * URI of the linked interconnect attachment. It must be in the same region - * as the router. Each interface can have at most one linked resource and it - * could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. */ linkedInterconnectAttachment?: string; /** - * URI of the linked VPN tunnel. It must be in the same region as the - * router. Each interface can have at most one linked resource and it could - * either be a VPN Tunnel or an interconnect attachment. + * URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. */ linkedVpnTunnel?: string; /** - * [Output Only] The resource that configures and manages this interface. - * MANAGED_BY_USER is the default value and can be managed by you or other - * users; MANAGED_BY_ATTACHMENT is an interface that is configured and - * managed by Cloud Interconnect, specifically by an InterconnectAttachment - * of type PARTNER. Google will automatically create, update, and delete - * this type of interface when the PARTNER InterconnectAttachment is - * created, updated, or deleted. + * [Output Only] The resource that configures and manages this interface. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** - * Name of this interface entry. The name must be 1-63 characters long and - * comply with RFC1035. + * Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; } @@ -9845,11 +7497,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9866,11 +7514,7 @@ export namespace compute_beta { }; } /** - * Represents a Nat resource. It enables the VMs within the specified - * subnetworks to access Internet without external IP addresses. It specifies - * a list of subnetworks (and the ranges within) that want to use NAT. - * Customers can also provide the external IPs that would be used for NAT. GCP - * would auto-allocate ephemeral IPs if no external IPs are provided. + * Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided. */ export interface Schema$RouterNat { /** @@ -9882,49 +7526,35 @@ export namespace compute_beta { */ logConfig?: Schema$RouterNatLogConfig; /** - * Minimum number of ports allocated to a VM from this NAT config. If not - * set, a default number of ports is allocated to a VM. This gets rounded up - * to the nearest power of 2. Eg. if the value of this field is 50, at least - * 64 ports will be allocated to a VM. + * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This gets rounded up to the nearest power of 2. Eg. if the value of this field is 50, at least 64 ports will be allocated to a VM. */ minPortsPerVm?: number; /** - * Unique name of this Nat service. The name must be 1-63 characters long - * and comply with RFC1035. + * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; /** - * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should - * be empty. + * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should be empty. */ natIpAllocateOption?: string; /** - * A list of URLs of the IP resources used for this Nat service. These IPs - * must be valid static external IP addresses assigned to the project. - * max_length is subject to change post alpha. + * A list of URLs of the IP resources used for this Nat service. These IPs must be valid static external IP addresses assigned to the project. max_length is subject to change post alpha. */ natIps?: string[]; /** - * Specify the Nat option. If this field contains - * ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, - * then there should not be any other Router.Nat section in any Router for - * this network in this region. + * Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string; /** - * A list of Subnetwork resources whose traffic should be translated by NAT - * Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the - * SubnetworkIpRangeToNatOption above. + * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. */ subnetworks?: Schema$RouterNatSubnetworkToNat[]; /** - * Timeout (in seconds) for TCP established connections. Defaults to 1200s - * if not set. + * Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. */ tcpEstablishedIdleTimeoutSec?: number; /** - * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if - * not set. + * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. */ tcpTransitoryIdleTimeoutSec?: number; /** @@ -9941,8 +7571,7 @@ export namespace compute_beta { */ enable?: boolean; /** - * Specifies the desired filtering of logs on this NAT. If unspecified, logs - * are exported for all connections handled by this NAT. + * Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. */ filter?: string; } @@ -9955,17 +7584,11 @@ export namespace compute_beta { */ name?: string; /** - * A list of the secondary ranges of the Subnetwork that are allowed to use - * NAT. This can be populated only if - * "LIST_OF_SECONDARY_IP_RANGES" is one of the values in - * source_ip_ranges_to_nat. + * A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat. */ secondaryIpRangeNames?: string[]; /** - * Specify the options for NAT ranges in the Subnetwork. All usages of - * single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only - * valid option with multiple values is: ["PRIMARY_IP_RANGE", - * "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + * Specify the options for NAT ranges in the Subnetwork. All usages of single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ sourceIpRangesToNat?: string[]; } @@ -9981,8 +7604,7 @@ export namespace compute_beta { */ routers?: Schema$Router[]; /** - * Informational warning which replaces the list of routers when the list is - * empty. + * Informational warning which replaces the list of routers when the list is empty. */ warning?: { code?: string; @@ -10040,8 +7662,7 @@ export namespace compute_beta { */ status?: string; /** - * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 - * hours, 59 minutes, 59 seconds + * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds */ uptime?: string; /** @@ -10054,15 +7675,11 @@ export namespace compute_beta { */ export interface Schema$RouterStatusNatStatus { /** - * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", - * "129.2.16.89"] + * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] */ autoAllocatedNatIps?: string[]; /** - * The number of extra IPs to allocate. This will be greater than 0 only if - * user-specified IPs are NOT enough to allow all configured VMs to use NAT. - * This value is meaningful only when auto-allocation of NAT IPs is *not* - * used. + * The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. */ minExtraNatIpsNeeded?: number; /** @@ -10078,8 +7695,7 @@ export namespace compute_beta { */ userAllocatedNatIpResources?: string[]; /** - * A list of IPs user-allocated for NAT. They will be raw IP strings like - * "179.12.26.133". + * A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133". */ userAllocatedNatIps?: string[]; } @@ -10099,8 +7715,7 @@ export namespace compute_beta { */ action?: string; /** - * Additional restrictions that must be met. All conditions must pass for - * the rule to match. + * Additional restrictions that must be met. All conditions must pass for the rule to match. */ conditions?: Schema$Condition[]; /** @@ -10108,25 +7723,19 @@ export namespace compute_beta { */ description?: string; /** - * If one or more 'in' clauses are specified, the rule matches if - * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ ins?: string[]; /** - * The config returned to callers of tech.iam.IAM.CheckPolicy for any - * entries that match the LOG action. + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ logConfigs?: Schema$LogConfig[]; /** - * If one or more 'not_in' clauses are specified, the rule matches - * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ notIns?: string[]; /** - * A permission is a string of form '..' (e.g., - * 'storage.buckets.list'). A value of '*' matches all - * permissions, and a verb part of '*' (e.g., - * 'storage.buckets.*') matches all verbs. + * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ permissions?: string[]; } @@ -10135,12 +7744,7 @@ export namespace compute_beta { */ export interface Schema$Scheduling { /** - * Specifies whether the instance should be automatically restarted if it is - * terminated by Compute Engine (not terminated by a user). You can only set - * the automatic restart option for standard instances. Preemptible - * instances cannot be automatically restarted. By default, this is set to - * true so an instance is automatically restarted if it is terminated by - * Compute Engine. + * Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. */ automaticRestart?: boolean; /** @@ -10148,22 +7752,16 @@ export namespace compute_beta { */ nodeAffinities?: Schema$SchedulingNodeAffinity[]; /** - * Defines the maintenance behavior for this instance. For standard - * instances, the default behavior is MIGRATE. For preemptible instances, - * the default and only possible behavior is TERMINATE. For more - * information, see Setting Instance Scheduling Options. + * Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. */ onHostMaintenance?: string; /** - * Defines whether the instance is preemptible. This can only be set during - * instance creation, it cannot be set or changed after the instance has - * been created. + * Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. */ preemptible?: boolean; } /** - * Node Affinity: the configuration of desired nodes onto which this Instance - * could be scheduled. + * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. */ export interface Schema$SchedulingNodeAffinity { /** @@ -10186,9 +7784,7 @@ export namespace compute_beta { wafRules?: Schema$PreconfiguredWafSet; } /** - * A security policy is comprised of one or more rules. It can also be - * associated with one or more 'targets'. (== resource_for - * v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -10196,60 +7792,35 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Specifies a fingerprint for this resource, which is essentially a hash of - * the metadata's contents and used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make get() request to the security policy. + * Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output only] Type of the resource. Always compute#securityPolicyfor - * security policies + * [Output only] Type of the resource. Always compute#securityPolicyfor security policies */ kind?: string; /** - * A fingerprint for the labels being applied to this security policy, which - * is essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels. To see - * the latest fingerprint, make get() request to the security policy. + * A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. */ labelFingerprint?: string; /** - * Labels to apply to this security policy resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this security policy resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * A list of rules that belong to this policy. There must always be a - * default rule (rule with priority 2147483647 and match "*"). If - * no rules are provided when creating a security policy, a default rule - * with action "allow" will be added. + * A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. */ rules?: Schema$SecurityPolicyRule[]; /** @@ -10267,16 +7838,11 @@ export namespace compute_beta { */ items?: Schema$SecurityPolicy[]; /** - * [Output Only] Type of resource. Always compute#securityPolicyList for - * listsof securityPolicies + * [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10292,29 +7858,23 @@ export namespace compute_beta { securityPolicy?: string; } /** - * Represents a rule that describes one or more match conditions along with - * the action to be taken when traffic matches this condition (allow or deny). + * Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). */ export interface Schema$SecurityPolicyRule { /** - * The Action to preform when the client connection triggers the rule. Can - * currently be either "allow" or "deny()" where valid - * values for status are 403, 404, and 502. + * The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. */ action?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output only] Type of the resource. Always compute#securityPolicyRule for - * security policy rules + * [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules */ kind?: string; /** - * A match condition that incoming traffic is evaluated against. If it - * evaluates to true, the corresponding ?action? is enforced. + * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. */ match?: Schema$SecurityPolicyRuleMatcher; /** @@ -10322,35 +7882,24 @@ export namespace compute_beta { */ preview?: boolean; /** - * An integer indicating the priority of a rule in the list. The priority - * must be a positive value between 0 and 2147483647. Rules are evaluated - * from highest to lowest priority where 0 is the highest priority and - * 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. */ priority?: number; } /** - * Represents a match condition that incoming traffic is evaluated against. - * Exactly one field must be specified. + * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. */ export interface Schema$SecurityPolicyRuleMatcher { /** - * The configuration options available when specifying versioned_expr. This - * field must be specified if versioned_expr is specified and cannot be - * specified if versioned_expr is not specified. + * The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. */ config?: Schema$SecurityPolicyRuleMatcherConfig; /** - * User defined CEVAL expression. A CEVAL expression is used to specify - * match criteria such as origin.ip, source.region_code and contents in the - * request header. + * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. */ expr?: Schema$Expr; /** - * Preconfigured versioned expression. If this field is specified, config - * must also be specified. Available preconfigured expressions along with - * their requirements are: SRC_IPS_V1 - must specify the corresponding - * src_ip_range field in config. + * Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. */ versionedExpr?: string; } @@ -10369,14 +7918,11 @@ export namespace compute_beta { */ contents?: string; /** - * [Output Only] Type of the resource. Always compute#serialPortOutput for - * serial port output. + * [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. */ kind?: string; /** - * [Output Only] The position of the next byte of content from the serial - * console output. Use this value in the next request as the start - * parameter. + * [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter. */ next?: string; /** @@ -10384,10 +7930,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * The starting byte position of the output that was returned. This should - * match the start parameter sent with the request. If the serial console - * output exceeds the size of the buffer, older output will be overwritten - * by newer content and the start values will be mismatched. + * The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched. */ start?: string; } @@ -10433,8 +7976,7 @@ export namespace compute_beta { */ encryptionKey?: Schema$ShieldedInstanceIdentityEntry; /** - * [Output Only] Type of the resource. Always - * compute#shieldedInstanceIdentity for shielded Instance identity entry. + * [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. */ kind?: string; /** @@ -10456,13 +7998,11 @@ export namespace compute_beta { ekPub?: string; } /** - * The policy describes the baseline against which Instance boot integrity is - * measured. + * The policy describes the baseline against which Instance boot integrity is measured. */ export interface Schema$ShieldedInstanceIntegrityPolicy { /** - * Updates the integrity policy baseline using the measurements from the VM - * instance's most recent boot. + * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ updateAutoLearnPolicy?: boolean; } @@ -10492,8 +8032,7 @@ export namespace compute_beta { */ encryptionKey?: Schema$ShieldedVmIdentityEntry; /** - * [Output Only] Type of the resource. Always compute#shieldedVmIdentity for - * shielded VM identity entry. + * [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry. */ kind?: string; /** @@ -10515,13 +8054,11 @@ export namespace compute_beta { ekPub?: string; } /** - * The policy describes the baseline against which VM instance boot integrity - * is measured. + * The policy describes the baseline against which VM instance boot integrity is measured. */ export interface Schema$ShieldedVmIntegrityPolicy { /** - * Updates the integrity policy baseline using the measurements from the VM - * instance's most recent boot. + * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ updateAutoLearnPolicy?: boolean; } @@ -10530,28 +8067,20 @@ export namespace compute_beta { */ export interface Schema$SignedUrlKey { /** - * Name of the key. The name must be 1-63 characters long, and comply with - * RFC1035. Specifically, the name must be 1-63 characters long and match - * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. + * Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ keyName?: string; /** - * 128-bit key value used for signing the URL. The key value must be a valid - * RFC 4648 Section 5 base64url encoded string. + * 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. */ keyValue?: string; } /** - * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) - * (== resource_for v1.snapshots ==) + * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) */ export interface Schema$Snapshot { /** - * [Output Only] Set to true if snapshots are automatically by applying - * resource policy on the target disk. + * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. */ autoCreated?: boolean; /** @@ -10559,8 +8088,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -10568,49 +8096,31 @@ export namespace compute_beta { */ diskSizeGb?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#snapshot for Snapshot - * resources. + * [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. */ kind?: string; /** - * A fingerprint for the labels being applied to this snapshot, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a snapshot. + * A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. */ labelFingerprint?: string; /** - * Labels to apply to this snapshot. These can be later modified by the - * setLabels method. Label values may be empty. + * Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. */ labels?: {[key: string]: string}; /** - * [Output Only] Integer license codes indicating which licenses are - * attached to this snapshot. + * [Output Only] Integer license codes indicating which licenses are attached to this snapshot. */ licenseCodes?: string[]; /** - * [Output Only] A list of public visible licenses that apply to this - * snapshot. This can be because the original image had licenses attached - * (such as a Windows image). + * [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). */ licenses?: string[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -10618,15 +8128,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * Encrypts the snapshot using a customer-supplied encryption key. After - * you encrypt a snapshot using a customer-supplied key, you must provide - * the same key if you use the image later For example, you must provide the - * encryption key when you create a disk from the encrypted snapshot in a - * future request. Customer-supplied encryption keys do not protect access - * to metadata of the disk. If you do not provide an encryption key when - * creating the snapshot, then the snapshot will be encrypted using an - * automatically generated key and you do not need to provide a key to use - * the snapshot later. + * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ snapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -10634,32 +8136,23 @@ export namespace compute_beta { */ sourceDisk?: string; /** - * The customer-supplied encryption key of the source disk. Required if the - * source disk is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the disk used to create this snapshot. This - * value may be used to determine whether the snapshot was taken from the - * current or a previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. */ sourceDiskId?: string; /** - * [Output Only] The status of the snapshot. This can be CREATING, DELETING, - * FAILED, READY, or UPLOADING. + * [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. */ status?: string; /** - * [Output Only] A size of the storage used by the snapshot. As snapshots - * share storage, this number is expected to change with snapshot - * creation/deletion. + * [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. */ storageBytes?: string; /** - * [Output Only] An indicator whether storageBytes is in a stable state or - * it is being adjusted as a result of shared storage reallocation. This - * status can either be UPDATING, meaning the size of the snapshot is being - * updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. + * [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. */ storageBytesStatus?: string; /** @@ -10684,11 +8177,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10705,29 +8194,20 @@ export namespace compute_beta { }; } /** - * A specification of the parameters to use when creating the instance - * template from a source instance. + * A specification of the parameters to use when creating the instance template from a source instance. */ export interface Schema$SourceInstanceParams { /** - * Attached disks configuration. If not provided, defaults are applied: For - * boot disk and any other R/W disks, new custom images will be created from - * each disk. For read-only disks, they will be attached in read-only mode. - * Local SSD disks will be created as blank volumes. + * Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. */ diskConfigs?: Schema$DiskInstantiationConfig[]; } /** - * An SslCertificate resource. This resource provides a mechanism to upload an - * SSL key and certificate to the load balancer to serve secure connections - * from the user. (== resource_for beta.sslCertificates ==) (== resource_for - * v1.sslCertificates ==) + * An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) */ export interface Schema$SslCertificate { /** - * A local certificate file. The certificate must be in PEM format. The - * certificate chain must be no greater than 5 certs long. The chain must - * include at least one intermediate cert. + * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ certificate?: string; /** @@ -10735,8 +8215,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -10744,13 +8223,11 @@ export namespace compute_beta { */ expireTime?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#sslCertificate for SSL - * certificates. + * [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. */ kind?: string; /** @@ -10758,18 +8235,11 @@ export namespace compute_beta { */ managed?: Schema$SslCertificateManagedSslCertificate; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * A write-only private key in PEM format. Only insert requests will include - * this field. + * A write-only private key in PEM format. Only insert requests will include this field. */ privateKey?: string; /** @@ -10781,15 +8251,11 @@ export namespace compute_beta { */ selfManaged?: Schema$SslCertificateSelfManagedSslCertificate; /** - * [Output Only] Domains associated with the certificate via Subject - * Alternative Name. + * [Output Only] Domains associated with the certificate via Subject Alternative Name. */ subjectAlternativeNames?: string[]; /** - * (Optional) Specifies the type of SSL certificate, either - * "SELF_MANAGED" or "MANAGED". If not specified, the - * certificate is self-managed and the fields certificate and private_key - * are used. + * (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. */ type?: string; } @@ -10810,11 +8276,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10835,13 +8297,11 @@ export namespace compute_beta { */ export interface Schema$SslCertificateManagedSslCertificate { /** - * The domains for which a managed SSL certificate will be generated. - * Currently only single-domain certs are supported. + * The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported. */ domains?: string[]; /** - * [Output only] Detailed statuses of the domains specified for managed - * certificate resource. + * [Output only] Detailed statuses of the domains specified for managed certificate resource. */ domainStatus?: {[key: string]: string}; /** @@ -10854,55 +8314,37 @@ export namespace compute_beta { */ export interface Schema$SslCertificateSelfManagedSslCertificate { /** - * A local certificate file. The certificate must be in PEM format. The - * certificate chain must be no greater than 5 certs long. The chain must - * include at least one intermediate cert. + * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ certificate?: string; /** - * A write-only private key in PEM format. Only insert requests will include - * this field. + * A write-only private key in PEM format. Only insert requests will include this field. */ privateKey?: string; } export interface Schema$SSLHealthCheck { /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, SSL health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The application data to send once the SSL connection has been established - * (default value is empty). If both request and response are empty, the - * connection establishment alone will indicate health. The request data can - * only be ASCII. + * The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ request?: string; /** - * The bytes to match against the beginning of the response data. If left - * empty (the default value), any response will indicate health. The - * response data can only be ASCII. + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ response?: string; } @@ -10916,16 +8358,11 @@ export namespace compute_beta { */ items?: Schema$SslPolicy[]; /** - * [Output Only] Type of the resource. Always compute#sslPoliciesList for - * lists of sslPolicies. + * [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10945,10 +8382,7 @@ export namespace compute_beta { features?: string[]; } /** - * A SSL policy specifies the server-side support for SSL features. This can - * be attached to a TargetHttpsProxy or a TargetSslProxy. This affects - * connections between clients and the HTTPS or SSL proxy load balancer. They - * do not affect the connection between the load balancers and the backends. + * A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends. */ export interface Schema$SslPolicy { /** @@ -10956,14 +8390,11 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * A list of features enabled when the selected profile is CUSTOM. The - - * method returns the set of features that can be specified in this list. - * This field must be empty if the profile is not CUSTOM. + * A list of features enabled when the selected profile is CUSTOM. The - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. */ customFeatures?: string[]; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -10971,44 +8402,27 @@ export namespace compute_beta { */ enabledFeatures?: string[]; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a SslPolicy. An up-to-date fingerprint must be - * provided in order to update the SslPolicy, otherwise the request will - * fail with error 412 conditionNotMet. To see the latest fingerprint, make - * a get() request to retrieve an SslPolicy. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output only] Type of the resource. Always compute#sslPolicyfor SSL - * policies. + * [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. */ kind?: string; /** - * The minimum version of SSL protocol that can be used by the clients to - * establish a connection with the load balancer. This can be one of - * TLS_1_0, TLS_1_1, TLS_1_2. + * The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. */ minTlsVersion?: string; /** - * Name of the resource. The name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Profile specifies the set of SSL features that can be used by the load - * balancer when negotiating SSL with clients. This can be one of - * COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of - * SSL features to enable must be specified in the customFeatures field. + * Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. */ profile?: string; /** @@ -11016,8 +8430,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] If potential misconfigurations are detected for this SSL - * policy, this field will be populated with warning messages. + * [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. */ warnings?: Array<{ code?: string; @@ -11027,28 +8440,16 @@ export namespace compute_beta { } export interface Schema$SslPolicyReference { /** - * URL of the SSL policy resource. Set this to empty string to clear any - * existing SSL policy associated with the target proxy resource. + * URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. */ sslPolicy?: string; } /** - * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== - * resource_for v1.subnetworks ==) + * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) */ export interface Schema$Subnetwork { /** - * Whether this subnetwork can conflict with static routes. Setting this to - * true allows this subnetwork's primary and secondary ranges to - * conflict with routes that have already been configured on the - * corresponding network. Static routes will take precedence over the - * subnetwork route if the route prefix length is at least as large as the - * subnetwork prefix length. Also, packets destined to IPs within - * subnetwork may contain private/sensitive data and are prevented from - * leaving the virtual network. Setting this field to true will disable this - * feature. The default value is false and applies to all existing - * subnetworks and automatically created subnetworks. This field cannot be - * set to true at resource creation time. + * Whether this subnetwork can conflict with static routes. Setting this to true allows this subnetwork's primary and secondary ranges to conflict with routes that have already been configured on the corresponding network. Static routes will take precedence over the subnetwork route if the route prefix length is at least as large as the subnetwork prefix length. Also, packets destined to IPs within subnetwork may contain private/sensitive data and are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks. This field cannot be set to true at resource creation time. */ allowSubnetCidrRoutesOverlap?: boolean; /** @@ -11056,89 +8457,55 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. This field can be set only at resource creation - * time. + * An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. */ description?: string; /** - * Whether to enable flow logging for this subnetwork. If this field is not - * explicitly set, it will not appear in get listings. If not set the - * default behavior is to disable flow logging. + * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ enableFlowLogs?: boolean; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a Subnetwork. An up-to-date fingerprint must be - * provided in order to update the Subnetwork, otherwise the request will - * fail with error 412 conditionNotMet. To see the latest fingerprint, make - * a get() request to retrieve a Subnetwork. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. */ fingerprint?: string; /** - * [Output Only] The gateway address for default routes to reach destination - * addresses outside this subnetwork. + * [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. */ gatewayAddress?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The range of internal addresses that are owned by this subnetwork. - * Provide this property when you create the subnetwork. For - * example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and - * non-overlapping within a network. Only IPv4 is supported. This field can - * be set only at resource creation time. + * The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. */ ipCidrRange?: string; /** - * [Output Only] Type of the resource. Always compute#subnetwork for - * Subnetwork resources. + * [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. */ kind?: string; /** - * This field denotes the logging options for the load balancer traffic - * served by this backend service. If logging is enabled, logs will be - * exported to Stackdriver. + * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. */ logConfig?: Schema$SubnetworkLogConfig; /** - * The name of the resource, provided by the client when initially creating - * the resource. The name must be 1-63 characters long, and comply with - * RFC1035. Specifically, the name must be 1-63 characters long and match - * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network to which this subnetwork belongs, provided by the - * client when initially creating the subnetwork. Only networks that are in - * the distributed mode can have subnetworks. This field can be set only at - * resource creation time. + * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. */ network?: string; /** - * Whether the VMs in this subnet can access Google services without - * assigned external IP addresses. This field can be both set at resource - * creation time and updated using setPrivateIpGoogleAccess. + * Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. */ privateIpGoogleAccess?: boolean; /** - * URL of the region where the Subnetwork resides. This field can be set - * only at resource creation time. + * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. */ region?: string; /** - * An array of configurations for secondary IP ranges for VM instances - * contained in this subnetwork. The primary IP of such VM must belong to - * the primary ipCidrRange of the subnetwork. The alias IPs may belong to - * either primary or secondary ranges. This field can be updated with a - * patch request. + * An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. */ secondaryIpRanges?: Schema$SubnetworkSecondaryRange[]; /** @@ -11156,16 +8523,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$SubnetworksScopedList}; /** - * [Output Only] Type of resource. Always compute#subnetworkAggregatedList - * for aggregated lists of subnetworks. + * [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11194,16 +8556,11 @@ export namespace compute_beta { */ items?: Schema$Subnetwork[]; /** - * [Output Only] Type of resource. Always compute#subnetworkList for lists - * of subnetworks. + * [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11224,30 +8581,19 @@ export namespace compute_beta { */ export interface Schema$SubnetworkLogConfig { /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * Toggles the aggregation interval for collecting flow logs. Increasing the - * interval time will reduce the amount of generated flow logs for long - * lasting connections. Default is an interval of 5 seconds per connection. + * Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection. */ aggregationInterval?: string; /** - * Whether to enable flow logging for this subnetwork. If this field is not - * explicitly set, it will not appear in get listings. If not set the - * default behavior is to disable flow logging. + * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ enable?: boolean; /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * The value of the field must be in [0, 1]. Set the sampling rate of VPC - * flow logs within the subnetwork where 1.0 means all collected logs are - * reported and 0.0 means no logs are reported. Default is 0.5 which means - * half of all collected logs are reported. + * Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 which means half of all collected logs are reported. */ flowSampling?: number; /** - * Can only be specified if VPC flow logging for this subnetwork is enabled. - * Configures whether metadata fields should be added to the reported VPC - * flow logs. Default is INCLUDE_ALL_METADATA. + * Can only be specified if VPC flow logging for this subnetwork is enabled. Configures whether metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. */ metadata?: string; } @@ -11256,26 +8602,17 @@ export namespace compute_beta { */ export interface Schema$SubnetworkSecondaryRange { /** - * The range of IP addresses belonging to this subnetwork secondary range. - * Provide this property when you create the subnetwork. Ranges must be - * unique and non-overlapping with all primary and secondary IP ranges - * within a network. Only IPv4 is supported. + * The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. The name must be 1-63 - * characters long, and comply with RFC1035. The name must be unique within - * the subnetwork. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ rangeName?: string; } export interface Schema$SubnetworksExpandIpCidrRangeRequest { /** - * The IP (in CIDR format or netmask) of internal addresses that are legal - * on this Subnetwork. This range should be disjoint from other subnetworks - * within this network. This range can only be larger than (i.e. a superset - * of) the range previously defined before the update. + * The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. */ ipCidrRange?: string; } @@ -11285,8 +8622,7 @@ export namespace compute_beta { */ subnetworks?: Schema$Subnetwork[]; /** - * An informational warning that appears when the list of addresses is - * empty. + * An informational warning that appears when the list of addresses is empty. */ warning?: { code?: string; @@ -11302,24 +8638,16 @@ export namespace compute_beta { */ export interface Schema$Tags { /** - * Specifies a fingerprint for this request, which is essentially a hash of - * the tags' contents and used for optimistic locking. The fingerprint - * is initially generated by Compute Engine and changes after every request - * to modify or update tags. You must always provide an up-to-date - * fingerprint hash in order to update or change tags. To see the latest - * fingerprint, make get() request to the instance. + * Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. */ fingerprint?: string; /** - * An array of tags. Each tag must be 1-63 characters long, and comply with - * RFC1035. + * An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. */ items?: string[]; } /** - * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== - * resource_for beta.targetHttpProxies ==) (== resource_for - * v1.targetHttpProxies ==) + * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -11327,28 +8655,19 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetHttpProxy for target - * HTTP proxies. + * [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -11356,8 +8675,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * URL to the UrlMap resource that defines the mapping from URL to the - * BackendService. + * URL to the UrlMap resource that defines the mapping from URL to the BackendService. */ urlMap?: string; } @@ -11374,16 +8692,11 @@ export namespace compute_beta { */ items?: Schema$TargetHttpProxy[]; /** - * Type of resource. Always compute#targetHttpProxyList for lists of target - * HTTP proxies. + * Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11407,16 +8720,12 @@ export namespace compute_beta { } export interface Schema$TargetHttpsProxiesSetSslCertificatesRequest { /** - * New set of SslCertificate resources to associate with this - * TargetHttpsProxy resource. Currently exactly one SslCertificate resource - * must be specified. + * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. */ sslCertificates?: string[]; } /** - * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== - * resource_for beta.targetHttpsProxies ==) (== resource_for - * v1.targetHttpsProxies ==) + * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -11424,38 +8733,23 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetHttpsProxy for - * target HTTPS proxies. + * [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the QUIC override policy for this TargetHttpsProxy resource. - * This determines whether the load balancer will attempt to negotiate QUIC - * with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify - * ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and - * disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC - * policy with no user overrides, which is equivalent to DISABLE. Not - * specifying this field is equivalent to specifying NONE. + * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. */ quicOverride?: string; /** @@ -11463,24 +8757,15 @@ export namespace compute_beta { */ selfLink?: string; /** - * URLs to SslCertificate resources that are used to authenticate - * connections between users and the load balancer. At least one SSL - * certificate must be specified. Currently, you may specify up to 15 SSL - * certificates. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** - * URL of SslPolicy resource that will be associated with the - * TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will - * not have any SSL policy configured. + * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. */ sslPolicy?: string; /** - * A fully-qualified or valid partial URL to the UrlMap resource that - * defines the mapping from URL to the BackendService. For example, the - * following are all valid URLs for specifying a URL map: - - * https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - * - projects/project/global/urlMaps/url-map - global/urlMaps/url-map + * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map */ urlMap?: string; } @@ -11497,16 +8782,11 @@ export namespace compute_beta { */ items?: Schema$TargetHttpsProxy[]; /** - * Type of resource. Always compute#targetHttpsProxyList for lists of target - * HTTPS proxies. + * Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11523,9 +8803,7 @@ export namespace compute_beta { }; } /** - * A TargetInstance resource. This resource defines an endpoint instance that - * terminates traffic of certain protocols. (== resource_for - * beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -11533,43 +8811,27 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * A URL to the virtual machine instance that handles traffic for this - * target instance. When creating a target instance, you can provide the - * fully-qualified URL or a valid partial URL to the desired virtual - * machine. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance - - * zones/zone/instances/instance + * A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ instance?: string; /** - * [Output Only] The type of the resource. Always compute#targetInstance for - * target instances. + * [Output Only] The type of the resource. Always compute#targetInstance for target instances. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * NAT option controlling how IPs are NAT'ed to the instance. Currently - * only NO_NAT (default value) is supported. + * NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. */ natPolicy?: string; /** @@ -11577,9 +8839,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] URL of the zone where the target instance resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -11597,11 +8857,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11634,11 +8890,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11660,8 +8912,7 @@ export namespace compute_beta { */ targetInstances?: Schema$TargetInstance[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -11670,23 +8921,11 @@ export namespace compute_beta { }; } /** - * A TargetPool resource. This resource defines a pool of instances, an - * associated HttpHealthCheck resource, and the fallback target pool. (== - * resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) */ export interface Schema$TargetPool { /** - * This field is applicable only when the containing target pool is serving - * a forwarding rule as the primary pool, and its failoverRatio field is - * properly set to a value between [0, 1]. backupPool and failoverRatio - * together define the fallback behavior of the primary target pool: if the - * ratio of the healthy instances in the primary pool is at or below - * failoverRatio, traffic arriving at the load-balanced IP will be directed - * to the backup pool. In case where failoverRatio and backupPool are not - * set, or all the instances in the backup pool are unhealthy, the traffic - * will be directed back to the primary pool in the "force" mode, - * where traffic will be spread to the healthy instances with the best - * effort, or to all instances when no instance is healthy. + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ backupPool?: string; /** @@ -11694,56 +8933,31 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * This field is applicable only when the containing target pool is serving - * a forwarding rule as the primary pool (i.e., not as a backup pool to some - * other target pool). The value of the field must be in [0, 1]. If set, - * backupPool must also be set. They together define the fallback behavior - * of the primary target pool: if the ratio of the healthy instances in the - * primary pool is at or below this number, traffic arriving at the - * load-balanced IP will be directed to the backup pool. In case where - * failoverRatio is not set or all the instances in the backup pool are - * unhealthy, the traffic will be directed back to the primary pool in the - * "force" mode, where traffic will be spread to the healthy - * instances with the best effort, or to all instances when no instance is - * healthy. + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ failoverRatio?: number; /** - * The URL of the HttpHealthCheck resource. A member instance in this pool - * is considered healthy if and only if the health checks pass. An empty - * list means all member instances will be considered healthy at all times. - * Only HttpHealthChecks are supported. Only one health check may be - * specified. + * The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. */ healthChecks?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * A list of resource URLs to the virtual machine instances serving this - * pool. They must live in zones contained in the same region as this pool. + * A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. */ instances?: string[]; /** - * [Output Only] Type of the resource. Always compute#targetPool for target - * pools. + * [Output Only] Type of the resource. Always compute#targetPool for target pools. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -11755,13 +8969,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * Session affinity option, must be one of the following values: NONE: - * Connections from the same client IP may go to any instance in the pool. - * CLIENT_IP: Connections from the same client IP will go to the same - * instance in the pool while that instance remains healthy. - * CLIENT_IP_PROTO: Connections from the same client IP with the same IP - * protocol will go to the same instance in the pool while that instance - * remains healthy. + * Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. */ sessionAffinity?: string; } @@ -11775,16 +8983,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$TargetPoolsScopedList}; /** - * [Output Only] Type of resource. Always compute#targetPoolAggregatedList - * for aggregated lists of target pools. + * [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11803,8 +9006,7 @@ export namespace compute_beta { export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; /** - * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth - * when checking the health of an instance. + * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. */ kind?: string; } @@ -11821,16 +9023,11 @@ export namespace compute_beta { */ items?: Schema$TargetPool[]; /** - * [Output Only] Type of resource. Always compute#targetPoolList for lists - * of target pools. + * [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11854,21 +9051,13 @@ export namespace compute_beta { } export interface Schema$TargetPoolsAddInstanceRequest { /** - * A full or partial URL to an instance to add to this target pool. This can - * be a full or partial URL. For example, the following are valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name - * - projects/project-id/zones/zone/instances/instance-name - - * zones/zone/instances/instance-name + * A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name */ instances?: Schema$InstanceReference[]; } export interface Schema$TargetPoolsRemoveHealthCheckRequest { /** - * Health check URL to be removed. This can be a full or valid partial URL. - * For example, the following are valid URLs: - - * https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check - * - projects/project/global/httpHealthChecks/health-check - - * global/httpHealthChecks/health-check + * Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ healthChecks?: Schema$HealthCheckReference[]; } @@ -11884,8 +9073,7 @@ export namespace compute_beta { */ targetPools?: Schema$TargetPool[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -11904,22 +9092,18 @@ export namespace compute_beta { } export interface Schema$TargetSslProxiesSetProxyHeaderRequest { /** - * The new type of proxy header to append before sending data to the - * backend. NONE or PROXY_V1 are allowed. + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ proxyHeader?: string; } export interface Schema$TargetSslProxiesSetSslCertificatesRequest { /** - * New set of URLs to SslCertificate resources to associate with this - * TargetSslProxy. Currently exactly one ssl certificate must be specified. + * New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. */ sslCertificates?: string[]; } /** - * A TargetSslProxy resource. This resource defines an SSL proxy. (== - * resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies - * ==) + * A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -11927,33 +9111,23 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#targetSslProxy for - * target SSL proxies. + * [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** @@ -11965,15 +9139,11 @@ export namespace compute_beta { */ service?: string; /** - * URLs to SslCertificate resources that are used to authenticate - * connections to Backends. At least one SSL certificate must be specified. - * Currently, you may specify up to 15 SSL certificates. + * URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** - * URL of SslPolicy resource that will be associated with the TargetSslProxy - * resource. If not set, the TargetSslProxy resource will not have any SSL - * policy configured. + * URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. */ sslPolicy?: string; } @@ -11994,11 +9164,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12022,15 +9188,12 @@ export namespace compute_beta { } export interface Schema$TargetTcpProxiesSetProxyHeaderRequest { /** - * The new type of proxy header to append before sending data to the - * backend. NONE or PROXY_V1 are allowed. + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ proxyHeader?: string; } /** - * A TargetTcpProxy resource. This resource defines a TCP proxy. (== - * resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies - * ==) + * A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -12038,33 +9201,23 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#targetTcpProxy for - * target TCP proxies. + * [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** @@ -12093,11 +9246,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12114,8 +9263,7 @@ export namespace compute_beta { }; } /** - * Represents a Target VPN gateway resource. (== resource_for - * beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN gateway resource. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -12123,62 +9271,39 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] A list of URLs to the ForwardingRule resources. - * ForwardingRules are created using compute.forwardingRules.insert and - * associated with a VPN gateway. + * [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. */ forwardingRules?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * A fingerprint for the labels being applied to this TargetVpnGateway, - * which is essentially a hash of the labels set used for optimistic - * locking. The fingerprint is initially generated by Compute Engine and - * changes after every request to modify or update labels. You must always - * provide an up-to-date fingerprint hash in order to update or change - * labels, otherwise the request will fail with error 412 conditionNotMet. - * To see the latest fingerprint, make a get() request to retrieve a - * TargetVpnGateway. + * A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. */ labelFingerprint?: string; /** - * Labels to apply to this TargetVpnGateway resource. These can be later - * modified by the setLabels method. Each label key/value must comply with - * RFC1035. Label values may be empty. + * Labels to apply to this TargetVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network to which this VPN gateway is attached. Provided by the - * client when the VPN gateway is created. + * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ network?: string; /** - * [Output Only] URL of the region where the target VPN gateway resides. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -12186,14 +9311,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The status of the VPN gateway, which can be one of the - * following: CREATING, READY, FAILED, or DELETING. + * [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. */ status?: string; /** - * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are - * created using the compute.vpntunnels.insert method and associated with a - * VPN gateway. + * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. */ tunnels?: string[]; } @@ -12207,16 +9329,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$TargetVpnGatewaysScopedList}; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12245,16 +9362,11 @@ export namespace compute_beta { */ items?: Schema$TargetVpnGateway[]; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12276,8 +9388,7 @@ export namespace compute_beta { */ targetVpnGateways?: Schema$TargetVpnGateway[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -12287,42 +9398,27 @@ export namespace compute_beta { } export interface Schema$TCPHealthCheck { /** - * The TCP port number for the health check request. The default value - * is 80. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, TCP health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The application data to send once the TCP connection has been established - * (default value is empty). If both request and response are empty, the - * connection establishment alone will indicate health. The request data can - * only be ASCII. + * The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ request?: string; /** - * The bytes to match against the beginning of the response data. If left - * empty (the default value), any response will indicate health. The - * response data can only be ASCII. + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ response?: string; } @@ -12334,23 +9430,18 @@ export namespace compute_beta { } export interface Schema$TestPermissionsRequest { /** - * The set of permissions to check for the 'resource'. Permissions - * with wildcards (such as '*' or 'storage.*') are not - * allowed. + * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ permissions?: string[]; } export interface Schema$TestPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * A UrlMap resource. This resource defines the mapping from URL to the - * BackendService resource, based on the "longest-match" of the - * URL's host and path. + * A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. */ export interface Schema$UrlMap { /** @@ -12358,29 +9449,15 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * The full or partial URL of the defaultService resource to which traffic - * is directed if none of the hostRules match. If defaultRouteAction is - * additionally specified, advanced routing actions like URL Rewrites, etc. - * take effect prior to sending the request to the backend. However, if - * defaultService is specified, defaultRouteAction cannot contain any - * weightedBackendServices. Conversely, if routeAction specifies any - * weightedBackendServices, service must not be specified. Only one of - * defaultService, defaultUrlRedirect or - * defaultRouteAction.weightedBackendService must be set. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. */ defaultService?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a UrlMap. An up-to-date fingerprint must be - * provided in order to update the UrlMap, otherwise the request will fail - * with error 412 conditionNotMet. To see the latest fingerprint, make a - * get() request to retrieve a UrlMap. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. */ fingerprint?: string; /** @@ -12388,8 +9465,7 @@ export namespace compute_beta { */ hostRules?: Schema$HostRule[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -12397,13 +9473,7 @@ export namespace compute_beta { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -12415,9 +9485,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * The list of expected URL mapping tests. Request to update this UrlMap - * will succeed only if all of the test cases pass. You can specify a - * maximum of 100 tests per UrlMap. + * The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. */ tests?: Schema$UrlMapTest[]; } @@ -12438,11 +9506,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12497,20 +9561,17 @@ export namespace compute_beta { export interface Schema$UrlMapValidationResult { loadErrors?: string[]; /** - * Whether the given UrlMap can be successfully loaded. If false, - * 'loadErrors' indicates the reasons. + * Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons. */ loadSucceeded?: boolean; testFailures?: Schema$TestFailure[]; /** - * If successfully loaded, this field indicates whether the test passed. If - * false, 'testFailures's indicate the reason of failure. + * If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure. */ testPassed?: boolean; } /** - * Subnetwork which the current user has compute.subnetworks.use permission - * on. + * Subnetwork which the current user has compute.subnetworks.use permission on. */ export interface Schema$UsableSubnetwork { /** @@ -12532,8 +9593,7 @@ export namespace compute_beta { } export interface Schema$UsableSubnetworksAggregatedList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -12541,17 +9601,11 @@ export namespace compute_beta { */ items?: Schema$UsableSubnetwork[]; /** - * [Output Only] Type of resource. Always - * compute#usableSubnetworksAggregatedList for aggregated lists of usable - * subnetworks. + * [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12576,33 +9630,20 @@ export namespace compute_beta { */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. The name must be 1-63 - * characters long, and comply with RFC1035. The name must be unique within - * the subnetwork. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ rangeName?: string; } /** - * The location in Cloud Storage and naming method of the daily usage report. - * Contains bucket_name and report_name prefix. + * The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. */ export interface Schema$UsageExportLocation { /** - * The name of an existing bucket in Cloud Storage where the usage report - * object is stored. The Google Service Account is granted write access to - * this bucket. This can either be the bucket name by itself, such as - * example-bucket, or the bucket name with gs:// or - * https://storage.googleapis.com/ in front of it, such as - * gs://example-bucket. + * The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. */ bucketName?: string; /** - * An optional prefix for the name of the usage report object stored in - * bucketName. If not supplied, defaults to usage. The report is stored as a - * CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the - * day of the usage according to Pacific Time. If you supply a prefix, it - * should conform to Cloud Storage object naming conventions. + * An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. */ reportNamePrefix?: string; } @@ -12621,21 +9662,15 @@ export namespace compute_beta { */ export interface Schema$VmEndpointNatMappingsInterfaceNatMappings { /** - * A list of all IP:port-range mappings assigned to this interface. These - * ranges are inclusive, that is, both the first and the last ports can be - * used for NAT. Example: ["2.2.2.2:12345-12355", - * "1.1.1.1:2234-2234"]. + * A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ natIpPortRanges?: string[]; /** - * Total number of ports across all NAT IPs allocated to this interface. It - * equals to the aggregated port number in the field nat_ip_port_ranges. + * Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. */ numTotalNatPorts?: number; /** - * Alias IP range for this interface endpoint. It will be a private (RFC - * 1918) IP range. Examples: "10.33.4.55/32", or - * "192.168.5.0/24". + * Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". */ sourceAliasIpRange?: string; /** @@ -12648,21 +9683,15 @@ export namespace compute_beta { */ export interface Schema$VmEndpointNatMappingsList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList - * for lists of Nat mappings of VM endpoints. + * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12691,49 +9720,31 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#vpnGateway for VPN - * gateways. + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ kind?: string; /** - * A fingerprint for the labels being applied to this VpnGateway, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an VpnGateway. + * A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an VpnGateway. */ labelFingerprint?: string; /** - * Labels to apply to this VpnGateway resource. These can be later modified - * by the setLabels method. Each label key/value must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network to which this VPN gateway is attached. Provided by the - * client when the VPN gateway is created. + * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ network?: string; /** @@ -12759,16 +9770,11 @@ export namespace compute_beta { */ items?: {[key: string]: Schema$VpnGatewaysScopedList}; /** - * [Output Only] Type of resource. Always compute#vpnGateway for VPN - * gateways. + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12797,16 +9803,11 @@ export namespace compute_beta { */ items?: Schema$VpnGateway[]; /** - * [Output Only] Type of resource. Always compute#vpnGateway for VPN - * gateways. + * [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -12831,8 +9832,7 @@ export namespace compute_beta { */ vpnGateways?: Schema$VpnGateway[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -12847,20 +9847,15 @@ export namespace compute_beta { vpnConnections?: Schema$VpnGatewayStatusVpnConnection[]; } /** - * Describes the high availability requirement state for the VPN connection - * between this Cloud VPN gateway and a peer gateway. + * Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway. */ export interface Schema$VpnGatewayStatusHighAvailabilityRequirementState { /** - * Indicates the high availability requirement state for the VPN connection. - * Valid values are CONNECTION_REDUNDANCY_MET, - * CONNECTION_REDUNDANCY_NOT_MET. + * Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. */ state?: string; /** - * Indicates the reason why the VPN connection does not meet the high - * availability redundancy criteria/requirement. Valid values is - * INCOMPLETE_TUNNELS_COVERAGE. + * Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. */ unsatisfiedReason?: string; } @@ -12873,8 +9868,7 @@ export namespace compute_beta { */ localGatewayInterface?: number; /** - * The peer gateway interface this VPN tunnel is connected to, the peer - * gateway could either be an external VPN gateway or GCP VPN gateway. + * The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway. */ peerGatewayInterface?: number; /** @@ -12883,21 +9877,15 @@ export namespace compute_beta { tunnelUrl?: string; } /** - * A VPN connection contains all VPN tunnels connected from this VpnGateway to - * the same peer gateway. The peer gateway could either be a external VPN - * gateway or GCP VPN gateway. + * A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway. */ export interface Schema$VpnGatewayStatusVpnConnection { /** - * URL reference to the peer external VPN gateways to which the VPN tunnels - * in this VPN connection are connected. This field is mutually exclusive - * with peer_gcp_gateway. + * URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ peerExternalGateway?: string; /** - * URL reference to the peer side VPN gateways to which the VPN tunnels in - * this VPN connection are connected. This field is mutually exclusive with - * peer_gcp_gateway. + * URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. */ peerGcpGateway?: string; /** @@ -12923,8 +9911,7 @@ export namespace compute_beta { ipAddress?: string; } /** - * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for - * v1.vpnTunnels ==) + * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -12932,8 +9919,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -12941,14 +9927,11 @@ export namespace compute_beta { */ detailedStatus?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * IKE protocol version to use when establishing the VPN tunnel with the - * peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version - * is 2. + * IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. */ ikeVersion?: number; /** @@ -12956,56 +9939,31 @@ export namespace compute_beta { */ kind?: string; /** - * A fingerprint for the labels being applied to this VpnTunnel, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a VpnTunnel. + * A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. */ labelFingerprint?: string; /** - * Labels to apply to this VpnTunnel. These can be later modified by the - * setLabels method. Each label key/value pair must comply with RFC1035. - * Label values may be empty. + * Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. */ labels?: {[key: string]: string}; /** - * Local traffic selector to use when establishing the VPN tunnel with the - * peer VPN gateway. The value should be a CIDR formatted string, for - * example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is - * supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. */ localTrafficSelector?: string[]; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the peer side external VPN gateway to which this VPN tunnel is - * connected. Provided by the client when the VPN tunnel is created. This - * field is exclusive with the field peerGcpGateway. + * URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. */ peerExternalGateway?: string; /** - * The interface ID of the external VPN gateway to which this VPN tunnel is - * connected. Provided by the client when the VPN tunnel is created. + * The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. */ peerExternalGatewayInterface?: number; /** - * URL of the peer side HA GCP VPN gateway to which this VPN tunnel is - * connected. Provided by the client when the VPN tunnel is created. This - * field can be used when creating highly available VPN from VPC network to - * VPC network, the field is exclusive with the field peerExternalGateway. - * If provided, the VPN tunnel will automatically use the same - * vpnGatewayInterface ID in the peer GCP VPN gateway. + * URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. */ peerGcpGateway?: string; /** @@ -13013,16 +9971,11 @@ export namespace compute_beta { */ peerIp?: string; /** - * [Output Only] URL of the region where the VPN tunnel resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * Remote traffic selectors to use when establishing the VPN tunnel with the - * peer VPN gateway. The value should be a CIDR formatted string, for - * example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is - * supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. */ remoteTrafficSelector?: string[]; /** @@ -13034,8 +9987,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * Shared secret used to set the secure session between the Cloud VPN - * gateway and the peer VPN gateway. + * Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. */ sharedSecret?: string; /** @@ -13043,35 +9995,19 @@ export namespace compute_beta { */ sharedSecretHash?: string; /** - * [Output Only] The status of the VPN tunnel, which can be one of the - * following: - PROVISIONING: Resource is being allocated for the VPN - * tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related - * configs from the user. Network, TargetVpnGateway, VpnTunnel, - * ForwardingRule, and Route resources are needed to setup the VPN tunnel. - * - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - - * ESTABLISHED: Secure session is successfully established with the peer - * VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - - * AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - - * NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are - * being deallocated for the VPN tunnel. - FAILED: Tunnel creation has - * failed and the tunnel is not ready to be used. + * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. */ status?: string; /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. - * Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. */ targetVpnGateway?: string; /** - * URL of the VPN gateway with which this VPN tunnel is associated. Provided - * by the client when the VPN tunnel is created. This must be used (instead - * of target_vpn_gateway) if a High Availability VPN gateway resource is - * created. + * URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. */ vpnGateway?: string; /** - * The interface ID of the VPN gateway with which this VPN tunnel is - * associated. + * The interface ID of the VPN gateway with which this VPN tunnel is associated. */ vpnGatewayInterface?: number; } @@ -13089,11 +10025,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -13126,11 +10058,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -13152,8 +10080,7 @@ export namespace compute_beta { */ vpnTunnels?: Schema$VpnTunnel[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -13163,10 +10090,7 @@ export namespace compute_beta { } export interface Schema$WafExpressionSet { /** - * A list of alternate IDs. The format should be: - E.g. XSS-stable Generic - * suffix like "stable" is particularly useful if a policy likes - * to avail newer set of expressions without having to change the policy. A - * given alias name can't be used for more than one entity set. + * A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set. */ aliases?: string[]; /** @@ -13174,18 +10098,13 @@ export namespace compute_beta { */ expressions?: Schema$WafExpressionSetExpression[]; /** - * Google specified expression set ID. The format should be: - E.g. - * XSS-20170329 + * Google specified expression set ID. The format should be: - E.g. XSS-20170329 */ id?: string; } export interface Schema$WafExpressionSetExpression { /** - * Expression ID should uniquely identify the origin of the expression. E.g. - * owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 - * rule id 973337. The ID could be used to determine the individual attack - * definition that has been detected. It could also be used to exclude it - * from the policy in case of false positive. + * Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. */ id?: string; } @@ -13199,16 +10118,11 @@ export namespace compute_beta { */ items?: Schema$Project[]; /** - * [Output Only] Type of resource. Always compute#xpnHostList for lists of - * shared VPC hosts. + * [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -13229,9 +10143,7 @@ export namespace compute_beta { */ export interface Schema$XpnResourceId { /** - * The ID of the service resource. In the case of projects, this field - * supports project id (e.g., my-project-123) and project number (e.g. - * 12345678). + * The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). */ id?: string; /** @@ -13240,8 +10152,7 @@ export namespace compute_beta { type?: string; } /** - * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones - * ==) Next ID: 17 + * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==) Next ID: 17 */ export interface Schema$Zone { /** @@ -13261,8 +10172,7 @@ export namespace compute_beta { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -13303,11 +10213,7 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -13325,12 +10231,7 @@ export namespace compute_beta { } export interface Schema$ZoneSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash in order to update or - * change labels. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** @@ -13340,20 +10241,15 @@ export namespace compute_beta { } export interface Schema$ZoneSetPolicyRequest { /** - * Flatten Policy to create a backwacd compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -13373,14 +10269,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13407,8 +10301,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -13426,10 +10319,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13527,14 +10419,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13550,8 +10440,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // Name of the accelerator type to return. - * acceleratorType: 'my-accelerator-type', // TODO: Update placeholder - * value. + * acceleratorType: 'my-accelerator-type', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -13573,10 +10462,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13656,22 +10544,19 @@ export namespace compute_beta { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified - * project. + * @desc Retrieves a list of accelerator types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13719,10 +10604,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13812,46 +10696,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -13887,46 +10744,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -13954,14 +10784,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13988,8 +10816,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -14007,10 +10834,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14102,14 +10928,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14147,10 +10971,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14237,14 +11060,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14282,10 +11103,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14362,22 +11182,19 @@ export namespace compute_beta { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project using the data - * included in the request. + * @desc Creates an address resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14416,10 +11233,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14499,22 +11315,19 @@ export namespace compute_beta { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified - * region. + * @desc Retrieves a list of addresses contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14562,10 +11375,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14647,22 +11459,19 @@ export namespace compute_beta { /** * compute.addresses.setLabels - * @desc Sets the labels on an Address. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14704,10 +11513,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14796,14 +11604,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14845,10 +11651,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14940,46 +11745,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -15006,16 +11784,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -15053,16 +11822,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -15078,46 +11838,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -15145,16 +11878,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -15208,14 +11932,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15242,8 +11964,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -15261,10 +11982,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15357,14 +12077,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15402,10 +12120,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15486,22 +12203,19 @@ export namespace compute_beta { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available - * autoscalers by making a list() request. + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15539,10 +12253,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15621,22 +12334,19 @@ export namespace compute_beta { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data - * included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15675,10 +12385,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15759,22 +12468,19 @@ export namespace compute_beta { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified - * zone. + * @desc Retrieves a list of autoscalers contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15822,10 +12528,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15907,23 +12612,19 @@ export namespace compute_beta { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15939,8 +12640,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -15964,10 +12664,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16056,14 +12755,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16088,8 +12785,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.autoscalers.testIamPermissions(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.autoscalers.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -16103,10 +12802,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16191,22 +12889,19 @@ export namespace compute_beta { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data - * included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16222,8 +12917,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -16247,10 +12941,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16339,46 +13032,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -16402,16 +13068,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -16450,16 +13107,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -16479,46 +13127,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -16546,16 +13167,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -16609,16 +13221,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -16640,8 +13243,7 @@ export namespace compute_beta { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this - * backend bucket. + * @desc Adds a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -16725,14 +13327,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16745,8 +13345,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to delete. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -16768,10 +13367,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16851,8 +13449,7 @@ export namespace compute_beta { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this - * backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -16929,22 +13526,19 @@ export namespace compute_beta { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of - * available backend buckets by making a list() request. + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16957,8 +13551,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to return. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -16980,10 +13573,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17062,22 +13654,19 @@ export namespace compute_beta { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the - * data included in the request. + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17113,10 +13702,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17195,22 +13783,19 @@ export namespace compute_beta { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the - * specified project. + * @desc Retrieves the list of BackendBucket resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17255,10 +13840,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17339,23 +13923,19 @@ export namespace compute_beta { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included - * in the request. This method supports PATCH semantics and uses the JSON - * merge patch format and processing rules. + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17368,12 +13948,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to patch. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -17397,10 +13975,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17481,22 +14058,19 @@ export namespace compute_beta { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included - * in the request. + * @desc Updates the specified BackendBucket resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17509,12 +14083,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to update. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -17538,10 +14110,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17629,8 +14200,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendBucket resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendBucket?: string; /** @@ -17638,16 +14208,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17672,16 +14233,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -17693,8 +14245,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendBucket resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendBucket?: string; /** @@ -17706,16 +14257,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -17747,16 +14289,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17773,46 +14306,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -17836,16 +14342,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17870,16 +14367,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17897,8 +14385,7 @@ export namespace compute_beta { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this - * backend service. + * @desc Adds a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -17975,22 +14462,19 @@ export namespace compute_beta { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and - * global, available to the specified project. + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18017,8 +14501,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -18036,10 +14519,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18137,14 +14619,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18157,8 +14637,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to delete. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -18180,10 +14659,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18263,8 +14741,7 @@ export namespace compute_beta { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this - * backend service. + * @desc Deletes a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -18341,22 +14818,19 @@ export namespace compute_beta { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of - * available backend services. + * @desc Returns the specified BackendService resource. Gets a list of available backend services. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18369,8 +14843,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to return. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -18392,10 +14865,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18481,14 +14953,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18499,9 +14969,8 @@ export namespace compute_beta { * var request = { * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the BackendService resource to which the queried instance - * belongs. backendService: 'my-backend-service', // TODO: Update - * placeholder value. + * // Name of the BackendService resource to which the queried instance belongs. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -18527,10 +14996,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18617,24 +15085,19 @@ export namespace compute_beta { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using - * the data included in the request. There are several restrictions and - * guidelines to keep in mind when creating a backend service. Read - * Restrictions and Guidelines for more information. + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18670,10 +15133,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18753,22 +15215,19 @@ export namespace compute_beta { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the - * specified project. + * @desc Retrieves the list of BackendService resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18813,10 +15272,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18898,25 +15356,19 @@ export namespace compute_beta { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data - * included in the request. There are several restrictions and guidelines to - * keep in mind when updating a backend service. Read Restrictions and - * Guidelines for more information. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18929,12 +15381,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to patch. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -18958,10 +15408,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19049,14 +15498,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19068,11 +15515,9 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the BackendService resource to which the security policy - * should be set. The name should + * // Name of the BackendService resource to which the security policy should be set. The name should * // conform to RFC1035. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -19081,8 +15526,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.backendServices.setSecurityPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.backendServices.setSecurityPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -19096,10 +15543,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19187,14 +15633,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19216,8 +15660,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.backendServices.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.backendServices.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -19231,10 +15677,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19318,24 +15763,19 @@ export namespace compute_beta { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data - * included in the request. There are several restrictions and guidelines to - * keep in mind when updating a backend service. Read Restrictions and - * Guidelines for more information. + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19348,12 +15788,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to update. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -19377,10 +15815,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19468,8 +15905,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendService?: string; /** @@ -19477,16 +15913,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -19503,46 +15930,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -19566,16 +15966,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -19587,8 +15978,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendService?: string; /** @@ -19600,16 +15990,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -19637,8 +16018,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the queried instance - * belongs. + * Name of the BackendService resource to which the queried instance belongs. */ backendService?: string; /** @@ -19663,16 +16043,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -19689,46 +16060,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -19752,16 +16096,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -19778,8 +16113,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the security policy should - * be set. The name should conform to RFC1035. + * Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. */ backendService?: string; /** @@ -19787,16 +16121,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -19842,16 +16167,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -19869,9 +16185,7 @@ export namespace compute_beta { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one - * policy which will be applied to this disk for scheduling snapshot - * creation. + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -19956,14 +16270,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19990,8 +16302,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -20009,10 +16320,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20102,14 +16412,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20151,10 +16459,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20237,24 +16544,19 @@ export namespace compute_beta { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its - * data permanently and is irreversible. However, deleting a disk does not - * delete any snapshots previously made from the disk. You must separately - * delete snapshots. + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20292,10 +16594,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20375,22 +16676,19 @@ export namespace compute_beta { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available - * persistent disks by making a list() request. + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20428,10 +16726,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20508,8 +16805,7 @@ export namespace compute_beta { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -20583,25 +16879,19 @@ export namespace compute_beta { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data - * in the request. You can create a disk with a sourceImage, a - * sourceSnapshot, or create an empty 500 GB data disk by omitting all - * properties. You can also create a disk that is larger than the default - * size by specifying the sizeGb property. + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20640,10 +16930,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20723,22 +17012,19 @@ export namespace compute_beta { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified - * zone. + * @desc Retrieves a list of persistent disks contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20786,10 +17072,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20948,22 +17233,19 @@ export namespace compute_beta { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the - * size of the disk. + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21005,10 +17287,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21089,8 +17370,7 @@ export namespace compute_beta { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -21165,22 +17445,19 @@ export namespace compute_beta { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21222,10 +17499,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21313,14 +17589,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21362,10 +17636,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21465,16 +17738,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -21495,46 +17759,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -21562,16 +17799,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -21599,16 +17827,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -21666,16 +17885,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -21699,46 +17909,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -21766,16 +17949,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -21803,16 +17977,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -21861,16 +18026,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -21928,14 +18084,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21962,8 +18116,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -21981,10 +18134,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22069,22 +18221,19 @@ export namespace compute_beta { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk - * types by making a list() request. + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22122,10 +18271,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22209,14 +18357,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22264,10 +18410,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22356,46 +18501,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -22429,46 +18547,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -22565,8 +18656,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available - * externalVpnGateways by making a list() request. + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -22641,8 +18731,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the - * data included in the request. + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -22718,8 +18807,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified - * project. + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -22799,8 +18887,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -22971,16 +19058,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -23012,16 +19090,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -23038,46 +19107,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23143,14 +19185,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23185,10 +19225,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23274,14 +19313,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23316,10 +19353,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23395,22 +19431,19 @@ export namespace compute_beta { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data - * included in the request. + * @desc Creates a firewall rule in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23446,10 +19479,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23527,22 +19559,19 @@ export namespace compute_beta { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified - * project. + * @desc Retrieves the list of firewall rules available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23587,10 +19616,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23670,23 +19698,19 @@ export namespace compute_beta { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23702,8 +19726,7 @@ export namespace compute_beta { * firewall: 'my-firewall', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -23727,10 +19750,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23817,14 +19839,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23863,10 +19883,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23950,23 +19969,19 @@ export namespace compute_beta { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the - * request. The PUT method can only update the following fields of firewall - * rule: allowed, description, sourceRanges, sourceTags, targetTags. + * @desc Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23982,8 +19997,7 @@ export namespace compute_beta { * firewall: 'my-firewall', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -24007,10 +20021,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24104,16 +20117,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -24143,16 +20147,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24168,46 +20163,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -24230,16 +20198,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24284,16 +20243,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24318,14 +20268,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24352,8 +20300,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -24371,10 +20318,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24472,14 +20418,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24495,8 +20439,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to delete. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -24518,10 +20461,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24609,14 +20551,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24632,8 +20572,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to return. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -24655,10 +20594,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24738,22 +20676,19 @@ export namespace compute_beta { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and - * region using the data included in the request. + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24792,10 +20727,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24876,22 +20810,19 @@ export namespace compute_beta { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the - * specified project and region. + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24939,10 +20870,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25025,10 +20955,7 @@ export namespace compute_beta { /** * compute.forwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. Currently, you can only patch the - * network_tier field. + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.forwardingRules.patch * @memberOf! () * @@ -25106,22 +21033,19 @@ export namespace compute_beta { /** * compute.forwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25163,10 +21087,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25248,22 +21171,19 @@ export namespace compute_beta { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of - * the same type as the old target. + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25279,8 +21199,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource in which target is to be set. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -25306,10 +21225,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25398,14 +21316,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25430,8 +21346,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.forwardingRules.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.forwardingRules.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -25445,10 +21363,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25540,46 +21457,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -25607,16 +21497,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -25656,16 +21537,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -25682,46 +21554,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -25753,16 +21598,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -25787,16 +21623,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -25829,16 +21656,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -25888,14 +21706,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25930,10 +21746,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26013,22 +21828,19 @@ export namespace compute_beta { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available - * addresses by making a list() request. + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26063,10 +21875,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26143,22 +21954,19 @@ export namespace compute_beta { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project using the data - * included in the request. + * @desc Creates an address resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26194,10 +22002,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26283,14 +22090,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26335,10 +22140,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26419,22 +22223,19 @@ export namespace compute_beta { /** * compute.globalAddresses.setLabels - * @desc Sets the labels on a GlobalAddress. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26473,10 +22274,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26563,14 +22363,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26592,8 +22390,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.globalAddresses.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.globalAddresses.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -26607,10 +22407,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26709,16 +22508,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -26750,16 +22540,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -26776,46 +22557,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -26881,14 +22635,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26901,8 +22653,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to delete. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -26924,10 +22675,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27007,22 +22757,19 @@ export namespace compute_beta { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of - * available forwarding rules by making a list() request. + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27035,8 +22782,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to return. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -27058,10 +22804,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27140,22 +22885,19 @@ export namespace compute_beta { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project - * using the data included in the request. + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27191,10 +22933,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27274,22 +23015,19 @@ export namespace compute_beta { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the - * specified project. + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27334,10 +23072,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27419,10 +23156,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. Currently, you can only patch the - * network_tier field. + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.globalForwardingRules.patch * @memberOf! () * @@ -27499,22 +23233,19 @@ export namespace compute_beta { /** * compute.globalForwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27536,8 +23267,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.globalForwardingRules.setLabels(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.globalForwardingRules.setLabels(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -27551,10 +23284,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27634,22 +23366,19 @@ export namespace compute_beta { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new - * target should be of the same type as the old target. + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27662,8 +23391,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource in which target is to be set. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -27672,8 +23400,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.globalForwardingRules.setTarget(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.globalForwardingRules.setTarget(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -27687,10 +23417,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27778,14 +23507,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27807,8 +23534,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.globalForwardingRules.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.globalForwardingRules.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -27822,10 +23551,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27924,16 +23652,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -27965,16 +23684,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -27991,46 +23701,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -28054,16 +23737,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -28109,16 +23783,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -28164,14 +23829,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28198,8 +23861,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -28217,10 +23879,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28312,14 +23973,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28351,10 +24010,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28431,22 +24089,19 @@ export namespace compute_beta { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of - * operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28481,10 +24136,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28563,22 +24217,19 @@ export namespace compute_beta { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified project. + * @desc Retrieves a list of Operation resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28623,10 +24274,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28714,46 +24364,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -28801,46 +24424,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -28864,14 +24460,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28906,10 +24500,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28989,22 +24582,19 @@ export namespace compute_beta { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of - * available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29039,10 +24629,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29120,22 +24709,19 @@ export namespace compute_beta { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29171,10 +24757,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29253,22 +24838,19 @@ export namespace compute_beta { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29313,10 +24895,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29397,23 +24978,19 @@ export namespace compute_beta { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29429,8 +25006,7 @@ export namespace compute_beta { * healthCheck: 'my-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -29454,10 +25030,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29545,14 +25120,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29574,8 +25147,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.healthChecks.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.healthChecks.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -29589,10 +25164,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29676,22 +25250,19 @@ export namespace compute_beta { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29707,8 +25278,7 @@ export namespace compute_beta { * healthCheck: 'my-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -29732,10 +25302,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29831,16 +25400,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -29871,16 +25431,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -29897,46 +25448,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -29960,16 +25484,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -30015,16 +25530,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -30049,14 +25555,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30069,8 +25573,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to delete. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -30092,10 +25595,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30175,22 +25677,19 @@ export namespace compute_beta { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of - * available HTTP health checks by making a list() request. + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30203,8 +25702,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to return. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -30226,10 +25724,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30308,22 +25805,19 @@ export namespace compute_beta { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using - * the data included in the request. + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30359,10 +25853,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30442,22 +25935,19 @@ export namespace compute_beta { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30502,10 +25992,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30587,23 +26076,19 @@ export namespace compute_beta { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using - * the data included in the request. This method supports PATCH semantics - * and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30616,12 +26101,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to patch. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -30645,10 +26128,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30736,14 +26218,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30765,8 +26245,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.httpHealthChecks.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.httpHealthChecks.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -30780,10 +26262,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30867,22 +26348,19 @@ export namespace compute_beta { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using - * the data included in the request. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30895,12 +26373,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to update. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -30924,10 +26400,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31023,16 +26498,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -31064,16 +26530,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31090,46 +26547,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -31153,16 +26583,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31208,16 +26629,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -31242,14 +26654,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31262,8 +26672,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to delete. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -31285,10 +26694,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31368,22 +26776,19 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of - * available HTTPS health checks by making a list() request. + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31396,8 +26801,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to return. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -31419,10 +26823,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31501,22 +26904,19 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using - * the data included in the request. + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31552,10 +26952,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31635,22 +27034,19 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31695,10 +27091,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31782,23 +27177,19 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using - * the data included in the request. This method supports PATCH semantics - * and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31811,12 +27202,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to patch. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -31840,10 +27229,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31931,14 +27319,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31960,8 +27346,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.httpsHealthChecks.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.httpsHealthChecks.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -31975,10 +27363,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32062,22 +27449,19 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using - * the data included in the request. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32090,12 +27474,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to update. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -32119,10 +27501,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32218,16 +27599,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -32259,16 +27631,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -32285,46 +27648,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -32348,16 +27684,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -32403,16 +27730,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -32437,14 +27755,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32479,10 +27795,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32560,22 +27875,19 @@ export namespace compute_beta { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body - * is given, clears the deprecation status instead. + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32614,10 +27926,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32697,22 +28008,19 @@ export namespace compute_beta { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by - * making a list() request. + * @desc Returns the specified image. Gets a list of available images by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32747,10 +28055,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32825,22 +28132,19 @@ export namespace compute_beta { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not - * deprecated. + * @desc Returns the latest image that is part of an image family and is not deprecated. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32875,10 +28179,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32955,8 +28258,7 @@ export namespace compute_beta { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.images.getIamPolicy * @memberOf! () * @@ -33029,22 +28331,19 @@ export namespace compute_beta { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included - * in the request. + * @desc Creates an image in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33080,10 +28379,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33162,26 +28460,19 @@ export namespace compute_beta { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified - * project. Custom images are images you create that belong to your project. - * This method does not get any images that belong to other projects, - * including publicly-available images, like Debian 8. If you want to get a - * list of publicly-available images, use this method to make a request to - * the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33226,10 +28517,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33309,8 +28599,7 @@ export namespace compute_beta { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.images.setIamPolicy * @memberOf! () * @@ -33384,22 +28673,19 @@ export namespace compute_beta { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33438,10 +28724,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33527,14 +28812,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33573,10 +28856,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33674,16 +28956,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -33702,16 +28975,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -33782,16 +29046,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -33807,46 +29062,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -33925,33 +29153,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed - * instance group. Abandoning an instance does not delete the instance, but - * it does remove the instance from any target pools that are applied by the - * managed instance group. This method reduces the targetSize of the managed - * instance group by the number of instances that you abandon. This - * operation is marked as DONE when the action is scheduled even if the - * instances have not yet been removed from the group. You must separately - * verify the status of the abandoning action with the listmanagedinstances - * method. If the group is part of a backend service that has enabled - * connection draining, it can take up to 60 seconds after the connection - * draining duration has elapsed before the VM instance is removed or - * deleted. You can specify a maximum of 1000 instances with this method - * per request. + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33967,8 +29181,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -33977,8 +29190,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.abandonInstances(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.abandonInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -33992,10 +29207,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34077,22 +29291,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by - * zone. + * @desc Retrieves the list of managed instance groups and groups them by zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34119,8 +29330,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -34138,10 +29348,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34232,8 +29441,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.applyUpdatesToInstances - * @desc Apply changes to selected instances on the managed instance group. - * This method can be used to apply new overrides and/or new versions. + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. * @alias compute.instanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -34312,23 +29520,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the - * instances in that group. Note that the instance group must not belong to - * a backend service. Read Deleting an instance group for more information. + * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34344,8 +29548,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -34367,10 +29570,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34451,31 +29653,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group for - * immediate deletion. The instances are also removed from any target pools - * of which they were a member. This method reduces the targetSize of the - * managed instance group by the number of instances that you delete. This - * operation is marked as DONE when the action is scheduled even if the - * instances are still being deleted. You must separately verify the status - * of the deleting action with the listmanagedinstances method. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. You can specify a - * maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34491,8 +29681,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -34501,8 +29690,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.deleteInstances(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.deleteInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -34516,10 +29707,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34601,23 +29791,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance - * group. Gets a list of available managed instance groups by making a - * list() request. + * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34633,8 +29819,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -34656,10 +29841,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34741,28 +29925,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, instances in the - * group are created using the specified instance template. This operation - * is marked as DONE when the group is created even if the instances in the - * group have not yet been created. You must separately verify the status of - * the individual instances with the listmanagedinstances method. A managed - * instance group can have up to 1000 VM instances per group. Please contact - * Cloud Support if you need an increase in this limit. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34774,8 +29949,8 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // The name of the zone where you want to create the managed instance - * group. zone: 'my-zone', // TODO: Update placeholder value. + * // The name of the zone where you want to create the managed instance group. + * zone: 'my-zone', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -34801,10 +29976,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34885,22 +30059,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained - * within the specified project and zone. + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34948,10 +30119,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35036,26 +30206,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each - * instance in the list has a currentAction, which indicates the action that - * the managed instance group is performing on the instance. For example, if - * the group is still creating an instance, the currentAction is CREATING. - * If a previous action failed, the list displays the errors for that failed - * action. + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35071,8 +30234,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -35088,20 +30250,17 @@ export namespace compute_beta { * return; * } * for (var i = 0; i < managedInstancesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `managedInstancesPage`: + * // TODO: Change code below to process each resource in `managedInstancesPage`: * console.log(JSON.stringify(managedInstancesPage[i], null, 2)); * } * * if (response.nextPageToken) { * request.pageToken = response.nextPageToken; - * compute.instanceGroupManagers.listManagedInstances(request, - * handlePage); + * compute.instanceGroupManagers.listManagedInstances(request, handlePage); * } * }; * - * compute.instanceGroupManagers.listManagedInstances(request, - * handlePage); + * compute.instanceGroupManagers.listManagedInstances(request, handlePage); * }); * * function authorize(callback) { @@ -35110,10 +30269,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35221,27 +30379,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is patched even if the instances in the group are still in the process of - * being patched. You must separately verify the status of the individual - * instances with the listManagedInstances method. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35253,16 +30403,14 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // The name of the zone where you want to create the managed instance - * group. zone: 'my-zone', // TODO: Update placeholder value. + * // The name of the zone where you want to create the managed instance group. + * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group manager. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -35286,10 +30434,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35371,30 +30518,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately recreated. The instances are deleted and recreated using the - * current instance template for the managed instance group. This operation - * is marked as DONE when the flag is set even if the instances have not yet - * been recreated. You must separately verify the status of the recreating - * action with the listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. You can specify a maximum of 1000 - * instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35410,8 +30546,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -35420,8 +30555,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.recreateInstances(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.recreateInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -35435,10 +30572,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35520,35 +30656,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the - * group creates new instances using the current instance template. If you - * decrease the size, the group deletes instances. The resize operation is - * marked DONE when the resize actions are scheduled even if the group has - * not yet added or deleted any instances. You must separately verify the - * status of the creating or deleting actions with the listmanagedinstances - * method. When resizing down, the instance group arbitrarily chooses the - * order in which VMs are deleted. The group takes into account some VM - * attributes when making the selection including: + The status of the VM - * instance. + The health of the VM instance. + The instance template - * version the VM is based on. + For regional managed instance groups, the - * location of the VM instance. This list is subject to change. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35564,13 +30684,10 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * // The number of running instances that the managed instance group - * should maintain at any given time. - * // The group automatically adds or removes instances to maintain the - * number of instances specified by + * // The number of running instances that the managed instance group should maintain at any given time. + * // The group automatically adds or removes instances to maintain the number of instances specified by * // this parameter. * size: 0, // TODO: Update placeholder value. * @@ -35594,10 +30711,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35679,32 +30795,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.resizeAdvanced - * @desc Resizes the managed instance group with advanced configuration - * options like disabling creation retries. This is an extended version of - * the resize method. If you increase the size of the instance group, the - * group creates new instances using the current instance template. If you - * decrease the size, the group deletes instances. The resize operation is - * marked DONE when the resize actions are scheduled even if the group has - * not yet added or deleted any instances. You must separately verify the - * status of the creating, creatingWithoutRetries, or deleting actions with - * the get or listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. + * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35720,8 +30823,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -35730,8 +30832,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.resizeAdvanced(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.resizeAdvanced(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -35745,10 +30849,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35830,22 +30933,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policies. [Deprecated] This method is - * deprecated. Please use Patch instead. + * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35861,8 +30961,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group manager. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -35871,8 +30970,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.setAutoHealingPolicies(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.setAutoHealingPolicies(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -35886,10 +30987,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35973,23 +31073,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances - * in this group. The templates for existing instances in the group do not - * change unless you recreate them. + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -36005,8 +31101,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -36015,8 +31110,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.setInstanceTemplate(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.setInstanceTemplate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -36030,10 +31127,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36115,26 +31211,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed - * instance group are assigned. The target pools automatically apply to all - * of the instances in the managed instance group. This operation is marked - * DONE when you make the request even if the instances have not yet been - * added to their target pools. The change might take some time to apply to - * all of the instances in the group depending on the size of the group. + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -36150,8 +31239,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -36160,8 +31248,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.setTargetPools(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.setTargetPools(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -36175,10 +31265,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36267,14 +31356,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -36299,8 +31386,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroupManagers.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -36314,10 +31403,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36402,25 +31490,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.update - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is updated even if the instances in the group have not yet been updated. - * You must separately verify the status of the individual instances with - * the listManagedInstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -36432,16 +31514,14 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // The name of the zone where you want to create the managed instance - * group. zone: 'my-zone', // TODO: Update placeholder value. + * // The name of the zone where you want to create the managed instance group. + * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group manager. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -36465,10 +31545,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36565,16 +31644,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36595,46 +31665,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -36658,8 +31701,7 @@ export namespace compute_beta { */ project?: string; /** - * The name of the zone where the managed instance group is located. Should - * conform to RFC1035. + * The name of the zone where the managed instance group is located. Should conform to RFC1035. */ zone?: string; @@ -36684,16 +31726,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36717,16 +31750,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36771,16 +31795,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36801,46 +31816,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -36860,22 +31848,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -36883,27 +31856,15 @@ export namespace compute_beta { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -36931,16 +31892,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36969,16 +31921,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37007,23 +31950,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The number of running instances that the managed instance group should - * maintain at any given time. The group automatically adds or removes - * instances to maintain the number of instances specified by this - * parameter. + * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. */ size?: number; /** @@ -37047,16 +31978,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37085,16 +32007,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37123,16 +32036,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37161,16 +32065,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37224,16 +32119,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37255,23 +32141,19 @@ export namespace compute_beta { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of - * the instances in the instance group must be in the same - * network/subnetwork. Read Adding instances for more information. + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -37287,8 +32169,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group where you are adding instances. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -37314,10 +32195,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -37406,14 +32286,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -37440,8 +32318,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -37459,10 +32336,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -37551,23 +32427,19 @@ export namespace compute_beta { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group - * are not deleted. Note that instance group must not belong to a backend - * service. Read Deleting an instance group for more information. + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -37583,8 +32455,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group to delete. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -37606,10 +32477,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -37690,22 +32560,19 @@ export namespace compute_beta { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available - * instance groups by making a list() request. + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -37721,8 +32588,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -37744,10 +32610,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -37827,22 +32692,19 @@ export namespace compute_beta { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the - * parameters that are included in the request. + * @desc Creates an instance group in the specified project using the parameters that are included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -37881,10 +32743,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -37965,22 +32826,19 @@ export namespace compute_beta { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the - * specified project and zone. + * @desc Retrieves the list of instance groups that are located in the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38028,10 +32886,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38121,14 +32978,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38143,9 +32998,8 @@ export namespace compute_beta { * // The name of the zone where the instance group is located. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the instance group from which you want to generate a - * list of included instances. instanceGroup: 'my-instance-group', // TODO: - * Update placeholder value. + * // The name of the instance group from which you want to generate a list of included instances. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -38184,10 +33038,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38279,25 +33132,19 @@ export namespace compute_beta { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, - * but does not delete those instances. If the group is part of a backend - * service that has enabled connection draining, it can take up to 60 - * seconds after the connection draining duration before the VM instance is - * removed or deleted. + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38312,9 +33159,8 @@ export namespace compute_beta { * // The name of the zone where the instance group is located. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the instance group where the specified instances will - * be removed. instanceGroup: 'my-instance-group', // TODO: Update - * placeholder value. + * // The name of the instance group where the specified instances will be removed. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -38323,8 +33169,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroups.removeInstances(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.instanceGroups.removeInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -38338,10 +33186,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38430,14 +33277,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38453,8 +33298,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group where the named ports are updated. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -38480,10 +33324,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38572,14 +33415,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38604,8 +33445,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceGroups.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroups.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -38619,10 +33462,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38722,16 +33564,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -38752,46 +33585,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -38815,16 +33621,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -38864,16 +33661,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -38894,46 +33682,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -38953,51 +33714,23 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The name of the instance group from which you want to generate a list of - * included instances. + * The name of the instance group from which you want to generate a list of included instances. */ instanceGroup?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -39022,8 +33755,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the instance group where the specified instances will be - * removed. + * The name of the instance group where the specified instances will be removed. */ instanceGroup?: string; /** @@ -39031,16 +33763,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -39069,16 +33792,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -39132,14 +33846,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39184,10 +33896,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39270,22 +33981,19 @@ export namespace compute_beta { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project - * across all regions and zones. + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39312,8 +34020,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -39331,10 +34038,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39419,24 +34125,19 @@ export namespace compute_beta { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first - * create the disk before you can attach it. It is not possible to create - * and attach a disk at the same time. For more information, read Adding a - * persistent disk to your instance. + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39478,10 +34179,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39564,22 +34264,19 @@ export namespace compute_beta { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see - * Stopping or Deleting an Instance. + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39617,10 +34314,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39707,14 +34403,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39758,10 +34452,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39857,14 +34550,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39905,10 +34596,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39990,22 +34680,19 @@ export namespace compute_beta { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available - * instances by making a list() request. + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40043,10 +34730,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40203,8 +34889,7 @@ export namespace compute_beta { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -40278,22 +34963,19 @@ export namespace compute_beta { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified - * instance. + * @desc Returns the last 1 MB of serial port output from the specified instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40314,8 +34996,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instances.getSerialPortOutput(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.instances.getSerialPortOutput(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -40329,10 +35013,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40574,22 +35257,19 @@ export namespace compute_beta { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the - * data included in the request. + * @desc Creates an instance resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40628,10 +35308,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40712,22 +35391,19 @@ export namespace compute_beta { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified - * zone. + * @desc Retrieves the list of instances contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40775,10 +35451,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40860,23 +35535,19 @@ export namespace compute_beta { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the - * specified zone. For more information, read Viewing Referrers to VM - * Instances. + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40891,8 +35562,7 @@ export namespace compute_beta { * // The name of the zone for this request. * zone: 'my-zone', // TODO: Update placeholder value. * - * // Name of the target instance scoping this request, or '-' if the - * request should span over all + * // Name of the target instance scoping this request, or '-' if the request should span over all * // instances in the container. * instance: 'my-instance', // TODO: Update placeholder value. * @@ -40929,10 +35599,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41020,23 +35689,19 @@ export namespace compute_beta { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does - * not do a graceful shutdown. For more information, see Resetting an - * instance. + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41074,10 +35739,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41157,8 +35821,7 @@ export namespace compute_beta { /** * compute.instances.resume - * @desc Resumes an instance that was suspended using the - * instances().suspend method. + * @desc Resumes an instance that was suspended using the instances().suspend method. * @alias compute.instances.resume * @memberOf! () * @@ -41242,14 +35905,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41270,8 +35931,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instances.setDeletionProtection(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instances.setDeletionProtection(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -41285,10 +35948,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41379,14 +36041,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41430,10 +36090,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41522,8 +36181,7 @@ export namespace compute_beta { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -41598,22 +36256,19 @@ export namespace compute_beta { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41655,10 +36310,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41740,22 +36394,19 @@ export namespace compute_beta { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped - * instance to the values specified in the request. + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41780,8 +36431,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instances.setMachineResources(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.instances.setMachineResources(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -41795,10 +36448,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41880,22 +36532,19 @@ export namespace compute_beta { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type - * specified in the request. + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41937,10 +36586,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42022,22 +36670,19 @@ export namespace compute_beta { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in - * the request. + * @desc Sets metadata for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42079,10 +36724,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42164,23 +36808,19 @@ export namespace compute_beta { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. - * This method can only be called on a stopped instance. For more - * information, read Specifying a Minimum CPU Platform. + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42222,10 +36862,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42314,14 +36953,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42363,10 +37000,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42448,22 +37084,19 @@ export namespace compute_beta { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, - * read Changing the service account and access scopes for an instance. + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42505,10 +37138,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42590,10 +37222,7 @@ export namespace compute_beta { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You - * can only use this method on a running instance. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -42673,9 +37302,7 @@ export namespace compute_beta { /** * compute.instances.setShieldedVmIntegrityPolicy - * @desc Sets the Shielded VM integrity policy for a VM instance. You can - * only use this method on a running VM instance. This method supports PATCH - * semantics and uses the JSON merge patch format and processing rules. + * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedVmIntegrityPolicy * @memberOf! () * @@ -42755,22 +37382,19 @@ export namespace compute_beta { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included - * in the request. + * @desc Sets network tags for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42812,10 +37436,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42975,22 +37598,19 @@ export namespace compute_beta { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop - * method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -43028,10 +37648,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -43111,22 +37730,19 @@ export namespace compute_beta { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop - * method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -43151,8 +37767,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instances.startWithEncryptionKey(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instances.startWithEncryptionKey(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -43166,10 +37784,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -43253,26 +37870,19 @@ export namespace compute_beta { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you - * to restart the instance at a later time. Stopped instances do not incur - * VM usage charges while they are stopped. However, resources that the VM - * is using, such as persistent disks and static IP addresses, will continue - * to be charged until they are deleted. For more information, see Stopping - * an instance. + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -43310,10 +37920,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -43393,12 +38002,7 @@ export namespace compute_beta { /** * compute.instances.suspend - * @desc This method suspends a running instance, saving its state to - * persistent storage, and allows you to resume the instance at a later - * time. Suspended instances incur reduced per-minute, virtual machine usage - * charges while they are suspended. Any resources the virtual machine is - * using, such as persistent disks and static IP addresses, will continue to - * be charged until they are deleted. + * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. * @alias compute.instances.suspend * @memberOf! () * @@ -43483,14 +38087,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -43532,10 +38134,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -43620,24 +38221,19 @@ export namespace compute_beta { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network - * interface with the data included in the request. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -43655,8 +38251,8 @@ export namespace compute_beta { * // The instance name for this request. * instance: 'my-instance', // TODO: Update placeholder value. * - * // The name of the network interface where the access config is - * attached. networkInterface: '', // TODO: Update placeholder value. + * // The name of the network interface where the access config is attached. + * networkInterface: '', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -43682,10 +38278,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -43768,9 +38363,7 @@ export namespace compute_beta { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this - * method on a stopped VM instance. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -43848,22 +38441,19 @@ export namespace compute_beta { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH - * semantics. + * @desc Updates an instance's network interface. This method follows PATCH semantics. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -43885,16 +38475,17 @@ export namespace compute_beta { * networkInterface: '', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * * auth: authClient, * }; * - * compute.instances.updateNetworkInterface(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instances.updateNetworkInterface(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -43908,10 +38499,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -43996,9 +38586,7 @@ export namespace compute_beta { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only - * use this method on a stopped instance. This method supports PATCH - * semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -44078,9 +38666,7 @@ export namespace compute_beta { /** * compute.instances.updateShieldedVmConfig - * @desc Updates the Shielded VM config for a VM instance. You can only use - * this method on a stopped VM instance. This method supports PATCH - * semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedVmConfig * @memberOf! () * @@ -44179,16 +38765,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44209,46 +38786,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44264,8 +38814,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to force attach the disk even if it's currently attached to - * another instance. + * Whether to force attach the disk even if it's currently attached to another instance. */ forceAttach?: boolean; /** @@ -44277,16 +38826,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44314,16 +38854,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44355,16 +38886,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44380,8 +38902,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The device name of the disk to detach. Make a get() request on the - * instance to view currently attached disks and device names. + * The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. */ deviceName?: string; /** @@ -44393,16 +38914,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44497,11 +39009,7 @@ export namespace compute_beta { */ project?: string; /** - * Returns output starting from a specific byte position. Use this to page - * through output when the output is too large to return in a single - * request. For the initial request, leave this field unspecified. For - * subsequent calls, this field should be set to the next value returned in - * the previous call. + * Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call. */ start?: string; /** @@ -44560,25 +39068,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Specifies instance template to create the instance. This field is - * optional. It can be a full or partial URL. For example, the following are - * all valid URLs to an instance template: - - * https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - * - projects/project/global/instanceTemplates/instanceTemplate - - * global/instanceTemplates/instanceTemplate + * Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate */ sourceInstanceTemplate?: string; /** @@ -44598,46 +39092,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44657,51 +39124,23 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * Name of the target instance scoping this request, or '-' if the request - * should span over all instances in the container. + * Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. */ instance?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44728,16 +39167,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44760,16 +39190,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44798,16 +39219,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44831,8 +39243,7 @@ export namespace compute_beta { */ autoDelete?: boolean; /** - * The device name of the disk to modify. Make a get() request on the - * instance to view currently attached disks and device names. + * The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. */ deviceName?: string; /** @@ -44844,16 +39255,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44902,16 +39304,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44940,16 +39333,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -44978,16 +39362,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45016,16 +39391,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45054,16 +39420,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45092,16 +39449,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45130,16 +39478,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45168,16 +39507,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45206,16 +39536,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45244,16 +39565,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45301,16 +39613,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45334,16 +39637,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45371,16 +39665,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45396,8 +39681,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true, discard the contents of any attached localSSD partitions. - * Default value is false (== preserve localSSD data). + * If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). */ discardLocalSsd?: boolean; /** @@ -45409,16 +39693,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45471,16 +39746,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45509,16 +39775,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45551,16 +39808,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45589,16 +39837,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45627,16 +39866,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -45658,23 +39888,19 @@ export namespace compute_beta { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance - * template is permanent and cannot be undone. It is not possible to delete - * templates that are already in use by a managed instance group. + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -45687,8 +39913,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // The name of the instance template to delete. - * instanceTemplate: 'my-instance-template', // TODO: Update - * placeholder value. + * instanceTemplate: 'my-instance-template', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -45710,10 +39935,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -45793,22 +40017,19 @@ export namespace compute_beta { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available - * instance templates by making a list() request. + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -45821,8 +40042,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // The name of the instance template. - * instanceTemplate: 'my-instance-template', // TODO: Update - * placeholder value. + * instanceTemplate: 'my-instance-template', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -45844,10 +40064,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -45926,8 +40145,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -46000,25 +40218,19 @@ export namespace compute_beta { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the - * data that is included in the request. If you are creating a new template - * to update an existing instance group, your new instance template must use - * the same network or, if applicable, the same subnetwork as the original - * template. + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -46054,10 +40266,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -46137,22 +40348,19 @@ export namespace compute_beta { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within - * the specified project. + * @desc Retrieves a list of instance templates that are contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -46197,10 +40405,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -46284,8 +40491,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -46366,14 +40572,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -46395,8 +40599,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.instanceTemplates.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceTemplates.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -46410,10 +40616,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -46512,16 +40717,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -46569,16 +40765,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -46595,46 +40782,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -46700,14 +40860,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -46734,14 +40892,12 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { * request.pageToken = response.nextPageToken; - * compute.interconnectAttachments.aggregatedList(request, - * handlePage); + * compute.interconnectAttachments.aggregatedList(request, handlePage); * } * }; * @@ -46754,10 +40910,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -46863,14 +41018,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -46886,14 +41039,15 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the interconnect attachment to delete. - * interconnectAttachment: 'my-interconnect-attachment', // TODO: - * Update placeholder value. + * interconnectAttachment: 'my-interconnect-attachment', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.interconnectAttachments.delete(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.interconnectAttachments.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -46907,10 +41061,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -46998,14 +41151,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -47021,8 +41172,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the interconnect attachment to return. - * interconnectAttachment: 'my-interconnect-attachment', // TODO: - * Update placeholder value. + * interconnectAttachment: 'my-interconnect-attachment', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -47044,10 +41194,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -47129,22 +41278,19 @@ export namespace compute_beta { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using - * the data included in the request. + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -47166,8 +41312,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.interconnectAttachments.insert(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.interconnectAttachments.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -47181,10 +41329,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -47265,22 +41412,19 @@ export namespace compute_beta { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the - * specified region. + * @desc Retrieves the list of interconnect attachments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -47328,10 +41472,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -47421,9 +41564,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -47501,8 +41642,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.setLabels - * @desc Sets the labels on an InterconnectAttachment. To learn more about - * labels, read the Labeling Resources documentation. + * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnectAttachments.setLabels * @memberOf! () * @@ -47587,14 +41727,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -47619,8 +41757,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.interconnectAttachments.testIamPermissions(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.interconnectAttachments.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -47634,10 +41774,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -47729,46 +41868,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47796,16 +41908,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -47845,16 +41948,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -47871,46 +41965,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47942,16 +42009,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -47976,16 +42034,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -48032,22 +42081,19 @@ export namespace compute_beta { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a - * list of available interconnect locations by making a list() request. + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48060,8 +42106,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the interconnect location to return. - * interconnectLocation: 'my-interconnect-location', // TODO: Update - * placeholder value. + * interconnectLocation: 'my-interconnect-location', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -48083,10 +42128,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48167,22 +42211,19 @@ export namespace compute_beta { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the - * specified project. + * @desc Retrieves the list of interconnect locations available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48227,10 +42268,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48337,46 +42377,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -48400,14 +42413,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48442,10 +42453,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48525,22 +42535,19 @@ export namespace compute_beta { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available - * interconnects by making a list() request. + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48575,10 +42582,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48743,22 +42749,19 @@ export namespace compute_beta { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data - * included in the request. + * @desc Creates a Interconnect in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48794,10 +42797,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48876,22 +42878,19 @@ export namespace compute_beta { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified - * project. + * @desc Retrieves the list of interconnect available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48936,10 +42935,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49020,23 +43018,19 @@ export namespace compute_beta { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49052,8 +43046,7 @@ export namespace compute_beta { * interconnect: 'my-interconnect', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -49077,10 +43070,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49161,8 +43153,7 @@ export namespace compute_beta { /** * compute.interconnects.setLabels - * @desc Sets the labels on an Interconnect. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnects.setLabels * @memberOf! () * @@ -49245,14 +43236,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49274,8 +43263,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.interconnects.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.interconnects.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -49289,10 +43280,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49391,16 +43381,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -49448,16 +43429,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -49474,46 +43446,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -49537,16 +43482,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -49606,8 +43542,7 @@ export namespace compute_beta { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across - * all projects that have permissions to read the License Code. + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. * @alias compute.licenseCodes.get * @memberOf! () * @@ -49786,14 +43721,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49828,10 +43761,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49907,8 +43839,7 @@ export namespace compute_beta { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -50055,12 +43986,7 @@ export namespace compute_beta { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. - * This method does not get any licenses that belong to other projects, - * including licenses attached to publicly-available images, like Debian 9. - * If you want to get a list of publicly-available licenses, use this method - * to make a request to the respective image project, such as debian-cloud - * or windows-cloud. + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.licenses.list * @memberOf! () * @@ -50138,8 +44064,7 @@ export namespace compute_beta { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -50227,16 +44152,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -50282,16 +44198,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50307,46 +44214,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50391,14 +44271,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50425,8 +44303,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -50444,10 +44321,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50536,22 +44412,19 @@ export namespace compute_beta { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available - * machine types by making a list() request. + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50589,10 +44462,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50671,22 +44543,19 @@ export namespace compute_beta { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified - * project. + * @desc Retrieves a list of machine types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50734,10 +44603,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50827,46 +44695,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50901,46 +44742,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50961,8 +44775,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by - * zone. + * @desc Retrieves the list of network endpoint groups and sorts them by zone. * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -51049,8 +44862,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network - * endpoint group. + * @desc Attach a list of network endpoints to the specified network endpoint group. * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -51130,10 +44942,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints - * in the NEG and the VM instances they belong to are not terminated when - * the NEG is deleted. Note that the NEG cannot be deleted if there are - * backend services referencing it. + * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. * @alias compute.networkEndpointGroups.delete * @memberOf! () * @@ -51210,8 +45019,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network - * endpoint group. + * @desc Detach a list of network endpoints from the specified network endpoint group. * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -51291,8 +45099,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of - * available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -51370,8 +45177,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the - * parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -51448,8 +45254,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in - * the specified project and zone. + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -51530,8 +45335,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint - * group. + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -51723,46 +45527,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -51778,8 +45555,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are attaching network - * endpoints to. It should comply with RFC1035. + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -51787,21 +45563,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -51818,8 +45584,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group to delete. It should comply with - * RFC1035. + * The name of the network endpoint group to delete. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -51827,21 +45592,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -51853,8 +45608,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are removing network - * endpoints. It should comply with RFC1035. + * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -51862,21 +45616,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -51901,8 +45645,7 @@ export namespace compute_beta { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -51918,21 +45661,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where you want to create the network endpoint group. - * It should comply with RFC1035. + * The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. */ zone?: string; @@ -51949,46 +45682,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -51996,8 +45702,7 @@ export namespace compute_beta { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -52009,51 +45714,23 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * The name of the network endpoint group from which you want to generate a - * list of included network endpoints. It should comply with RFC1035. + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -52061,8 +45738,7 @@ export namespace compute_beta { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -52112,14 +45788,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52158,10 +45832,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52249,14 +45922,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52291,10 +45962,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52373,22 +46043,19 @@ export namespace compute_beta { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by - * making a list() request. + * @desc Returns the specified network. Gets a list of available networks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52423,10 +46090,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52502,22 +46168,19 @@ export namespace compute_beta { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included - * in the request. + * @desc Creates a network in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52553,10 +46216,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52641,14 +46303,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52693,10 +46353,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52865,23 +46524,19 @@ export namespace compute_beta { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the - * request. Only the following fields can be modified: - * routingConfig.routingMode. + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52897,8 +46552,7 @@ export namespace compute_beta { * network: 'my-network', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -52922,10 +46576,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -53012,14 +46665,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -53058,10 +46709,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -53142,22 +46792,19 @@ export namespace compute_beta { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet - * mode. + * @desc Switches the network mode from auto subnet mode to custom subnet mode. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -53192,10 +46839,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -53282,14 +46928,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -53328,10 +46972,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -53415,10 +47058,7 @@ export namespace compute_beta { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the - * request Only the following fields can be modified: - * NetworkPeering.export_custom_routes, and - * NetworkPeering.import_custom_routes + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes * @alias compute.networks.updatePeering * @memberOf! () * @@ -53510,16 +47150,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -53543,16 +47174,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -53582,16 +47204,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -53607,46 +47220,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -53666,30 +47252,11 @@ export namespace compute_beta { */ direction?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** @@ -53697,24 +47264,15 @@ export namespace compute_beta { */ network?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** - * The response will show routes exchanged over the given peering - * connection. + * The response will show routes exchanged over the given peering connection. */ peeringName?: string; /** @@ -53722,8 +47280,7 @@ export namespace compute_beta { */ project?: string; /** - * The region of the request. The response will include all subnet routes, - * static routes and dynamic routes in the region. + * The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. */ region?: string; } @@ -53742,16 +47299,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -53776,16 +47324,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -53810,16 +47349,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -53860,16 +47390,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -53965,8 +47486,7 @@ export namespace compute_beta { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use - * nodeGroups.listNodes for more details about each group. + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -54202,9 +47722,7 @@ export namespace compute_beta { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups - * by making a list() request. Note: the "nodes" field should not be used. - * Use nodeGroups.listNodes instead. + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -54279,8 +47797,7 @@ export namespace compute_beta { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -54354,8 +47871,7 @@ export namespace compute_beta { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the - * data included in the request. + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. * @alias compute.nodeGroups.insert * @memberOf! () * @@ -54433,8 +47949,7 @@ export namespace compute_beta { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. - * Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -54592,8 +48107,7 @@ export namespace compute_beta { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -54842,16 +48356,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54872,46 +48377,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -54935,16 +48413,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54968,16 +48437,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -55045,16 +48505,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -55074,46 +48525,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -55133,30 +48557,11 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** @@ -55164,19 +48569,11 @@ export namespace compute_beta { */ nodeGroup?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -55229,16 +48626,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -55447,8 +48835,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node - * templates by making a list() request. + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. * @alias compute.nodeTemplates.get * @memberOf! () * @@ -55524,8 +48911,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -55599,8 +48985,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the - * data included in the request. + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -55677,8 +49062,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified - * project. + * @desc Retrieves a list of node templates available to the specified project. * @alias compute.nodeTemplates.list * @memberOf! () * @@ -55757,8 +49141,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -55921,46 +49304,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -55988,16 +49344,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -56057,16 +49404,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56083,46 +49421,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -56274,8 +49585,7 @@ export namespace compute_beta { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node - * types by making a list() request. + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. * @alias compute.nodeTypes.get * @memberOf! () * @@ -56433,46 +49743,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -56506,46 +49789,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -56573,14 +49829,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -56612,10 +49866,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -56693,22 +49946,19 @@ export namespace compute_beta { /** * compute.projects.disableXpnResource - * @desc Disable a serivce resource (a.k.a service project) associated with - * this host project. + * @desc Disable a serivce resource (a.k.a service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -56744,10 +49994,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -56833,14 +50082,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -56872,10 +50119,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -56953,23 +50199,19 @@ export namespace compute_beta { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, - * so that subnets in the host project can be used by instances in the - * service project. + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57005,10 +50247,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57094,14 +50335,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57133,10 +50372,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57211,22 +50449,19 @@ export namespace compute_beta { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be - * empty if no link exists. + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57258,10 +50493,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57336,22 +50570,19 @@ export namespace compute_beta { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this - * host project. + * @desc Gets service resources (a.k.a service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57377,8 +50608,8 @@ export namespace compute_beta { * return; * } * for (var i = 0; i < resourcesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `resourcesPage`: console.log(JSON.stringify(resourcesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `resourcesPage`: + * console.log(JSON.stringify(resourcesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -57396,10 +50627,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57484,22 +50714,19 @@ export namespace compute_beta { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an - * organization. + * @desc Lists all shared VPC host projects visible to the user in an organization. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57548,10 +50775,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57640,14 +50866,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57683,10 +50907,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57765,22 +50988,19 @@ export namespace compute_beta { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone - * to another. + * @desc Moves an instance and its attached persistent disks from one zone to another. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57816,10 +51036,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57898,22 +51117,19 @@ export namespace compute_beta { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project - * using the data included in the request. + * @desc Sets metadata common to all instances within the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57932,8 +51148,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.projects.setCommonInstanceMetadata(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.projects.setCommonInstanceMetadata(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -57947,10 +51165,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58032,9 +51249,7 @@ export namespace compute_beta { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network - * tier is used when an address/forwardingRule/instance is created without - * specifying the network tier field. + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -58111,23 +51326,19 @@ export namespace compute_beta { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket - * where reports are stored. If you provide an empty request body using this - * method, the usage export feature will be disabled. + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58146,8 +51357,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.projects.setUsageExportBucket(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.projects.setUsageExportBucket(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -58161,10 +51374,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58256,16 +51468,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -58281,16 +51484,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58311,16 +51505,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -58336,16 +51521,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58385,46 +51561,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -58440,46 +51589,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -58504,16 +51626,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58534,16 +51647,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58564,16 +51668,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58594,16 +51689,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58624,16 +51710,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -58658,14 +51735,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58703,10 +51778,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58794,14 +51868,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58839,10 +51911,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58922,22 +51993,19 @@ export namespace compute_beta { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data - * included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58976,10 +52044,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59060,22 +52127,19 @@ export namespace compute_beta { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified - * region. + * @desc Retrieves a list of autoscalers contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59123,10 +52187,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59211,23 +52274,19 @@ export namespace compute_beta { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59243,8 +52302,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -59268,10 +52326,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59360,14 +52417,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59392,8 +52447,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionAutoscalers.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionAutoscalers.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -59407,10 +52464,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59495,22 +52551,19 @@ export namespace compute_beta { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data - * included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59526,8 +52579,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -59551,10 +52603,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59655,16 +52706,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -59704,16 +52746,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -59730,46 +52763,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -59801,16 +52807,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -59864,16 +52861,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -59898,14 +52886,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59921,8 +52907,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to delete. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -59944,10 +52929,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60035,14 +53019,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60058,8 +53040,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to return. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -60081,10 +53062,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60164,22 +53144,19 @@ export namespace compute_beta { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional - * BackendService. + * @desc Gets the most recent health check results for this regional BackendService. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60193,9 +53170,8 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the BackendService resource to which the queried instance - * belongs. backendService: 'my-backend-service', // TODO: Update - * placeholder value. + * // Name of the BackendService resource to which the queried instance belongs. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -60204,8 +53180,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionBackendServices.getHealth(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionBackendServices.getHealth(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -60219,10 +53197,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60310,24 +53287,19 @@ export namespace compute_beta { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project - * using the data included in the request. There are several restrictions - * and guidelines to keep in mind when creating a regional backend service. - * Read Restrictions and Guidelines for more information. + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60366,10 +53338,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60450,22 +53421,19 @@ export namespace compute_beta { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available - * to the specified project in the given region. + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60513,10 +53481,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60599,26 +53566,19 @@ export namespace compute_beta { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the - * data included in the request. There are several restrictions and - * guidelines to keep in mind when updating a backend service. Read - * Restrictions and Guidelines for more information. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60634,12 +53594,10 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to patch. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -60663,10 +53621,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60755,14 +53712,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60787,8 +53742,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionBackendServices.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionBackendServices.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -60802,10 +53759,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60890,24 +53846,19 @@ export namespace compute_beta { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the - * data included in the request. There are several restrictions and - * guidelines to keep in mind when updating a backend service. Read - * Restrictions and Guidelines for more information. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60923,12 +53874,10 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to update. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -60952,10 +53901,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -61056,16 +54004,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -61130,16 +54069,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61156,46 +54086,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -61227,16 +54130,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61290,16 +54184,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61324,14 +54209,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -61358,8 +54241,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -61377,10 +54259,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -61466,22 +54347,19 @@ export namespace compute_beta { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available - * commitments by making a list() request. + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -61519,10 +54397,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -61602,22 +54479,19 @@ export namespace compute_beta { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data - * included in the request. + * @desc Creates a commitment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -61656,10 +54530,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -61740,22 +54613,19 @@ export namespace compute_beta { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified - * region. + * @desc Retrieves a list of commitments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -61803,10 +54673,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -61889,8 +54758,7 @@ export namespace compute_beta { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of - * reservations within the commitments. + * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -61975,46 +54843,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -62058,16 +54899,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -62084,46 +54916,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -62143,8 +54948,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the commitment of which the reservation's capacities are being - * updated. + * Name of the commitment of which the reservation's capacities are being updated. */ commitment?: string; /** @@ -62156,16 +54960,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -62183,9 +54978,7 @@ export namespace compute_beta { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only - * add one policy which will be applied to this disk for scheduling snapshot - * creation. + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -62341,10 +55134,7 @@ export namespace compute_beta { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional - * disk removes all the replicas of its data permanently and is - * irreversible. However, deleting a disk does not delete any snapshots - * previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.regionDisks.delete * @memberOf! () * @@ -62494,8 +55284,7 @@ export namespace compute_beta { /** * compute.regionDisks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.regionDisks.getIamPolicy * @memberOf! () * @@ -62569,8 +55358,7 @@ export namespace compute_beta { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using - * the data included in the request. + * @desc Creates a persistent regional disk in the specified project using the data included in the request. * @alias compute.regionDisks.insert * @memberOf! () * @@ -62648,8 +55436,7 @@ export namespace compute_beta { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the - * specified region. + * @desc Retrieves the list of persistent disks contained within the specified region. * @alias compute.regionDisks.list * @memberOf! () * @@ -62883,8 +55670,7 @@ export namespace compute_beta { /** * compute.regionDisks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.regionDisks.setIamPolicy * @memberOf! () * @@ -63137,16 +55923,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63175,16 +55952,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63213,16 +55981,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -63281,16 +56040,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -63310,46 +56060,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -63381,16 +56104,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63419,16 +56133,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63478,16 +56183,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -63534,8 +56230,7 @@ export namespace compute_beta { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available - * disk types by making a list() request. + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -63609,8 +56304,7 @@ export namespace compute_beta { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified - * project. + * @desc Retrieves a list of regional disk types available to the specified project. * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -63716,46 +56410,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -63776,33 +56443,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the - * managed instance group. Abandoning an instance does not delete the - * instance, but it does remove the instance from any target pools that are - * applied by the managed instance group. This method reduces the targetSize - * of the managed instance group by the number of instances that you - * abandon. This operation is marked as DONE when the action is scheduled - * even if the instances have not yet been removed from the group. You must - * separately verify the status of the abandoning action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -63818,8 +56471,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -63828,8 +56480,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.abandonInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.abandonInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -63843,10 +56497,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64007,22 +56660,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the - * instances in that group. + * @desc Deletes the specified managed instance group and all of the instances in that group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64038,14 +56688,15 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.delete(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -64059,10 +56710,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64143,32 +56793,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately deleted. The instances are also removed from any target pools - * of which they were a member. This method reduces the targetSize of the - * managed instance group by the number of instances that you delete. The - * deleteInstances operation is marked DONE if the deleteInstances request - * is successful. The underlying actions take additional time. You must - * separately verify the status of the deleting action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64184,8 +56821,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -64194,8 +56830,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.deleteInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.deleteInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -64209,10 +56847,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64294,22 +56931,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance - * group. + * @desc Returns all of the details about the specified managed instance group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64325,14 +56959,15 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group to return. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.get(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -64346,10 +56981,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64431,27 +57065,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, instances in the - * group are created using the specified instance template. This operation - * is marked as DONE when the group is created even if the instances in the - * group have not yet been created. You must separately verify the status of - * the individual instances with the listmanagedinstances method. A - * regional managed instance group can contain up to 2000 instances. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64473,8 +57099,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.insert(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -64488,10 +57116,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64572,22 +57199,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained - * within the specified region. + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64635,10 +57259,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64730,23 +57353,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances - * that are scheduled to be created. The list includes any current actions - * that the group has scheduled for its instances. + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64762,8 +57381,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -64779,20 +57397,17 @@ export namespace compute_beta { * return; * } * for (var i = 0; i < managedInstancesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `managedInstancesPage`: + * // TODO: Change code below to process each resource in `managedInstancesPage`: * console.log(JSON.stringify(managedInstancesPage[i], null, 2)); * } * * if (response.nextPageToken) { * request.pageToken = response.nextPageToken; - * compute.regionInstanceGroupManagers.listManagedInstances(request, - * handlePage); + * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); * } * }; * - * compute.regionInstanceGroupManagers.listManagedInstances(request, - * handlePage); + * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); * }); * * function authorize(callback) { @@ -64801,10 +57416,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64912,27 +57526,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is patched even if the instances in the group are still in the process of - * being patched. You must separately verify the status of the individual - * instances with the listmanagedinstances method. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64948,20 +57554,20 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // The name of the instance group manager. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.patch(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -64975,10 +57581,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65060,30 +57665,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately recreated. The instances are deleted and recreated using the - * current instance template for the managed instance group. This operation - * is marked as DONE when the flag is set even if the instances have not yet - * been recreated. You must separately verify the status of the recreating - * action with the listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. You can specify a maximum of 1000 - * instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65099,8 +57693,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -65109,8 +57702,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.recreateInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.recreateInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65124,10 +57719,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65209,30 +57803,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you - * increase the size, the group creates new instances using the current - * instance template. If you decrease the size, the group deletes one or - * more instances. The resize operation is marked DONE if the resize - * request is successful. The underlying actions take additional time. You - * must separately verify the status of the creating or deleting actions - * with the listmanagedinstances method. If the group is part of a backend - * service that has enabled connection draining, it can take up to 60 - * seconds after the connection draining duration has elapsed before the VM - * instance is removed or deleted. + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65248,17 +57831,18 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * // Number of instances that should exist in this instance group - * manager. size: 0, // TODO: Update placeholder value. + * // Number of instances that should exist in this instance group manager. + * size: 0, // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.resize(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.resize(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65272,10 +57856,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65357,23 +57940,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policy for the instances in this managed - * instance group. [Deprecated] This method is deprecated. Please use Patch - * instead. + * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65389,8 +57968,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -65399,8 +57977,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setAutoHealingPolicies(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.setAutoHealingPolicies(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65414,10 +57994,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65501,22 +58080,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or - * recreating instances in this group. Existing instances are not affected. + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65532,8 +58108,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -65542,8 +58117,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setInstanceTemplate(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.setInstanceTemplate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65557,10 +58134,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65642,22 +58218,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group - * are assigned. Existing instances in the group are not affected. + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65673,8 +58246,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -65683,8 +58255,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setTargetPools(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.setTargetPools(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65698,10 +58272,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65790,14 +58363,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65822,8 +58393,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.testIamPermissions(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65837,10 +58410,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65925,25 +58497,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.update - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is updated even if the instances in the group have not yet been updated. - * You must separately verify the status of the individual instances with - * the listmanagedinstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65959,20 +58525,20 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // The name of the instance group manager. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.update(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65986,10 +58552,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66090,16 +58655,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66153,16 +58709,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -66186,16 +58733,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66240,16 +58778,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66266,46 +58795,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -66325,22 +58827,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -66348,27 +58835,15 @@ export namespace compute_beta { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -66400,16 +58875,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66438,16 +58904,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66476,16 +58933,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -66513,16 +58961,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66551,16 +58990,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66589,16 +59019,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66652,16 +59073,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66686,14 +59098,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66709,8 +59119,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the instance group resource to return. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -66732,10 +59141,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66815,22 +59223,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the - * specified region. + * @desc Retrieves the list of instance group resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66878,10 +59283,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66966,24 +59370,19 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays - * information about the named ports. Depending on the specified options, - * this method can list all instances or only the instances that are - * running. + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66998,9 +59397,8 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the regional instance group for which we want to list the - * instances. instanceGroup: 'my-instance-group', // TODO: Update - * placeholder value. + * // Name of the regional instance group for which we want to list the instances. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -67039,10 +59437,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67143,14 +59540,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67165,9 +59560,8 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // The name of the regional instance group where the named ports are - * updated. instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * // The name of the regional instance group where the named ports are updated. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -67176,8 +59570,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroups.setNamedPorts(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroups.setNamedPorts(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -67191,10 +59587,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67283,14 +59678,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67315,8 +59708,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroups.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroups.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -67330,10 +59725,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67445,46 +59839,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -67504,51 +59871,23 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * Name of the regional instance group for which we want to list the - * instances. + * Name of the regional instance group for which we want to list the instances. */ instanceGroup?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -67573,8 +59912,7 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the regional instance group where the named ports are - * updated. + * The name of the regional instance group where the named ports are updated. */ instanceGroup?: string; /** @@ -67586,16 +59924,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -67645,14 +59974,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67687,10 +60014,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67775,14 +60101,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67820,10 +60144,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67903,22 +60226,19 @@ export namespace compute_beta { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified region. + * @desc Retrieves a list of Operation resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67966,10 +60286,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68099,46 +60418,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -68159,22 +60451,19 @@ export namespace compute_beta { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available - * regions by making a list() request. + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -68209,10 +60498,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68287,22 +60575,19 @@ export namespace compute_beta { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified - * project. + * @desc Retrieves the list of region resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -68347,10 +60632,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68452,46 +60736,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -68745,8 +61002,7 @@ export namespace compute_beta { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -68897,8 +61153,7 @@ export namespace compute_beta { /** * compute.reservations.list - * @desc A list all the reservations that have been configured for the - * specified project in specified zone. + * @desc A list all the reservations that have been configured for the specified project in specified zone. * @alias compute.reservations.list * @memberOf! () * @@ -68977,8 +61232,7 @@ export namespace compute_beta { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations - * only) + * @desc Resizes the reservation (applicable to standalone reservations only) * @alias compute.reservations.resize * @memberOf! () * @@ -69056,8 +61310,7 @@ export namespace compute_beta { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -69220,46 +61473,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -69279,16 +61505,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -69351,16 +61568,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -69381,46 +61589,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -69444,16 +61625,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -69846,8 +62018,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the - * specified project in specified region. + * @desc A list all the resource policies that have been configured for the specified project in specified region. * @alias compute.resourcePolicies.list * @memberOf! () * @@ -70014,46 +62185,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -70077,16 +62221,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70130,16 +62265,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -70156,46 +62282,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -70248,14 +62347,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70282,8 +62379,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -70301,10 +62397,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70396,14 +62491,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70441,10 +62534,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70524,22 +62616,19 @@ export namespace compute_beta { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available - * routers by making a list() request. + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70577,10 +62666,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70751,14 +62839,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70796,10 +62882,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70883,22 +62968,19 @@ export namespace compute_beta { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using - * the data included in the request. + * @desc Creates a Router resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70937,10 +63019,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71020,22 +63101,19 @@ export namespace compute_beta { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified - * project. + * @desc Retrieves a list of Router resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71083,10 +63161,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71168,23 +63245,19 @@ export namespace compute_beta { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the - * request. This method supports PATCH semantics and uses JSON merge patch - * format and processing rules. + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71203,8 +63276,7 @@ export namespace compute_beta { * router: 'my-router', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -71228,10 +63300,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71312,22 +63383,19 @@ export namespace compute_beta { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update - * operations. Calling this method does NOT create or update the router. + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71369,10 +63437,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71463,14 +63530,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71512,10 +63577,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71600,22 +63664,19 @@ export namespace compute_beta { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the - * request. + * @desc Updates the specified Router resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71634,8 +63695,7 @@ export namespace compute_beta { * router: 'my-router', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -71659,10 +63719,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71750,46 +63809,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -71812,16 +63844,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -71856,46 +63879,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -71907,8 +63903,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the Router resource to query for Nat Mapping information of VM - * endpoints. + * Name of the Router resource to query for Nat Mapping information of VM endpoints. */ router?: string; } @@ -71947,16 +63942,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -71972,46 +63958,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -72038,16 +63997,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -72124,16 +64074,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -72162,14 +64103,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72204,10 +64143,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72285,22 +64223,19 @@ export namespace compute_beta { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available - * routes by making a list() request. + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72335,10 +64270,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72413,22 +64347,19 @@ export namespace compute_beta { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data - * included in the request. + * @desc Creates a Route resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72464,10 +64395,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72545,22 +64475,19 @@ export namespace compute_beta { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified - * project. + * @desc Retrieves the list of Route resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72605,10 +64532,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72695,14 +64621,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72741,10 +64665,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72838,16 +64761,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -72881,16 +64795,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -72906,46 +64811,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -73067,14 +64945,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73087,8 +64963,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the security policy to delete. - * securityPolicy: 'my-security-policy', // TODO: Update placeholder - * value. + * securityPolicy: 'my-security-policy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -73110,10 +64985,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73200,14 +65074,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73220,8 +65092,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the security policy to get. - * securityPolicy: 'my-security-policy', // TODO: Update placeholder - * value. + * securityPolicy: 'my-security-policy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -73243,10 +65114,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73401,22 +65271,19 @@ export namespace compute_beta { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data - * included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73452,10 +65319,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73536,22 +65402,19 @@ export namespace compute_beta { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified - * project. + * @desc List all the policies that have been configured for the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73596,10 +65459,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73681,8 +65543,7 @@ export namespace compute_beta { /** * compute.securityPolicies.listPreconfiguredExpressionSets - * @desc Gets the current list of preconfigured Web Application Firewall - * (WAF) expressions. + * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. * @alias compute.securityPolicies.listPreconfiguredExpressionSets * @memberOf! () * @@ -73793,14 +65654,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73813,12 +65672,10 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the security policy to update. - * securityPolicy: 'my-security-policy', // TODO: Update placeholder - * value. + * securityPolicy: 'my-security-policy', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -73842,10 +65699,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74080,8 +65936,7 @@ export namespace compute_beta { /** * compute.securityPolicies.setLabels - * @desc Sets the labels on a security policy. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. * @alias compute.securityPolicies.setLabels * @memberOf! () * @@ -74164,14 +66019,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74193,8 +66046,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.securityPolicies.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.securityPolicies.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -74208,10 +66063,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74331,16 +66185,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -74396,16 +66241,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -74426,46 +66262,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -74481,46 +66290,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -74540,16 +66322,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -74662,25 +66435,19 @@ export namespace compute_beta { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting - * a single snapshot might not necessarily delete all the data on that - * snapshot. If any data on the snapshot that is marked for deletion is - * needed for subsequent snapshots, the data will be moved to the next - * corresponding snapshot. For more information, see Deleting snapshots. + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74715,10 +66482,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74797,22 +66563,19 @@ export namespace compute_beta { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available - * snapshots by making a list() request. + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74847,10 +66610,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74926,8 +66688,7 @@ export namespace compute_beta { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -75000,22 +66761,19 @@ export namespace compute_beta { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the - * specified project. + * @desc Retrieves the list of Snapshot resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75060,10 +66818,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75143,8 +66900,7 @@ export namespace compute_beta { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -75218,22 +66974,19 @@ export namespace compute_beta { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75272,10 +67025,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75362,14 +67114,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75408,10 +67158,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75505,16 +67254,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -75560,46 +67300,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -75686,14 +67399,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75706,8 +67417,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the SslCertificate resource to delete. - * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder - * value. + * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -75729,10 +67439,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75812,22 +67521,19 @@ export namespace compute_beta { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of - * available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75840,8 +67546,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the SslCertificate resource to return. - * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder - * value. + * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -75863,10 +67568,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75945,22 +67649,19 @@ export namespace compute_beta { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using - * the data included in the request. + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75996,10 +67697,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76079,22 +67779,19 @@ export namespace compute_beta { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the - * specified project. + * @desc Retrieves the list of SslCertificate resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -76139,10 +67836,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76231,14 +67927,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -76260,8 +67954,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.sslCertificates.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.sslCertificates.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -76275,10 +67971,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76373,16 +68068,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -76418,16 +68104,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -76444,46 +68121,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -76521,9 +68171,7 @@ export namespace compute_beta { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be - * deleted only if it is not in use by any TargetHttpsProxy or - * TargetSslProxy resources. + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. * @alias compute.sslPolicies.delete * @memberOf! () * @@ -76599,8 +68247,7 @@ export namespace compute_beta { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified - * policy. + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -76674,8 +68321,7 @@ export namespace compute_beta { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available - * SSL policies by making a list() request. + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. * @alias compute.sslPolicies.insert * @memberOf! () * @@ -76750,8 +68396,7 @@ export namespace compute_beta { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the - * specified project. + * @desc Lists all the SSL policies that have been configured for the specified project. * @alias compute.sslPolicies.list * @memberOf! () * @@ -76827,8 +68472,7 @@ export namespace compute_beta { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when - * using custom profile. + * @desc Lists all features that can be specified in the SSL policy when using custom profile. * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -76923,8 +68567,7 @@ export namespace compute_beta { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the - * request. + * @desc Patches the specified SSL policy with the data included in the request. * @alias compute.sslPolicies.patch * @memberOf! () * @@ -77092,21 +68735,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the SSL policy to delete. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; } @@ -77121,8 +68754,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the SSL policy to update. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; } @@ -77138,16 +68770,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -77163,46 +68786,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -77218,46 +68814,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -77277,21 +68846,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the SSL policy to update. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; @@ -77337,14 +68896,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -77371,8 +68928,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -77390,10 +68946,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -77486,14 +69041,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -77531,10 +69084,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -77622,14 +69174,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -77654,8 +69204,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.subnetworks.expandIpCidrRange(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.subnetworks.expandIpCidrRange(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -77669,10 +69221,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -77754,22 +69305,19 @@ export namespace compute_beta { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available - * subnetworks list() request. + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -77807,10 +69355,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -77889,22 +69436,19 @@ export namespace compute_beta { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -77942,10 +69486,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -78023,22 +69566,19 @@ export namespace compute_beta { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data - * included in the request. + * @desc Creates a subnetwork in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -78077,10 +69617,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -78168,14 +69707,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -78223,10 +69760,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -78395,24 +69931,19 @@ export namespace compute_beta { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the - * request. Only certain fields can up updated with a patch request as - * indicated in the field descriptions. You must specify the current - * fingeprint of the subnetwork resource being patched. + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -78431,8 +69962,7 @@ export namespace compute_beta { * subnetwork: 'my-subnetwork', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -78456,10 +69986,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -78541,22 +70070,19 @@ export namespace compute_beta { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -78598,10 +70124,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -78680,22 +70205,19 @@ export namespace compute_beta { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without - * assigning external IP addresses through Private Google Access. + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -78720,8 +70242,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.subnetworks.setPrivateIpGoogleAccess(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.subnetworks.setPrivateIpGoogleAccess(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -78735,10 +70259,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -78829,14 +70352,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -78861,8 +70382,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.subnetworks.testIamPermissions(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.subnetworks.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -78876,10 +70399,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -78971,46 +70493,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -79034,16 +70529,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -79067,16 +70553,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -79144,16 +70621,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -79169,46 +70637,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -79228,46 +70669,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -79291,16 +70705,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -79354,16 +70759,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -79417,14 +70813,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -79437,8 +70831,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpProxy resource to delete. - * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder - * value. + * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -79460,10 +70853,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -79543,22 +70935,19 @@ export namespace compute_beta { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of - * available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -79571,8 +70960,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpProxy resource to return. - * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder - * value. + * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -79594,10 +70982,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -79676,22 +71063,19 @@ export namespace compute_beta { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -79727,10 +71111,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -79810,22 +71193,19 @@ export namespace compute_beta { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -79870,10 +71250,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -79962,14 +71341,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -79982,8 +71359,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpProxy to set a URL map for. - * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder - * value. + * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -80009,10 +71385,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -80100,14 +71475,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -80129,8 +71502,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetHttpProxies.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetHttpProxies.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -80144,10 +71519,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -80242,16 +71616,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -80287,16 +71652,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -80313,46 +71669,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -80372,16 +71701,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -80431,14 +71751,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -80451,8 +71769,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpsProxy resource to delete. - * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -80474,10 +71791,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -80557,22 +71873,19 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of - * available target HTTPS proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -80585,8 +71898,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpsProxy resource to return. - * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -80608,10 +71920,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -80690,22 +72001,19 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -80741,10 +72049,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -80824,22 +72131,19 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -80884,10 +72188,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -81055,14 +72358,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -81074,9 +72375,8 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetHttpsProxy resource to set an SslCertificates - * resource for. targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -81085,8 +72385,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetHttpsProxies.setSslCertificates(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetHttpsProxies.setSslCertificates(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -81100,10 +72402,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -81184,10 +72485,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies - * the server-side support for SSL features. This affects connections - * between clients and the HTTPS proxy load balancer. They do not affect the - * connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -81271,14 +72569,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -81291,8 +72587,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpsProxy resource whose URL map is to be set. - * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -81318,10 +72613,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -81409,14 +72703,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -81438,8 +72730,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetHttpsProxies.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetHttpsProxies.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -81453,10 +72747,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -81551,16 +72844,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -81596,16 +72880,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -81622,46 +72897,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -81681,21 +72929,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource to set the QUIC override policy - * for. The name should conform to RFC1035. + * Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. */ targetHttpsProxy?: string; @@ -81716,21 +72954,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource to set an SslCertificates resource - * for. + * Name of the TargetHttpsProxy resource to set an SslCertificates resource for. */ targetHttpsProxy?: string; @@ -81751,21 +72979,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource whose SSL policy is to be set. The - * name must be 1-63 characters long, and comply with RFC1035. + * Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. */ targetHttpsProxy?: string; @@ -81786,16 +73004,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -81845,14 +73054,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -81879,8 +73086,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -81898,10 +73104,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -81999,14 +73204,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -82022,8 +73225,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // Name of the TargetInstance resource to delete. - * targetInstance: 'my-target-instance', // TODO: Update placeholder - * value. + * targetInstance: 'my-target-instance', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -82045,10 +73247,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -82129,22 +73330,19 @@ export namespace compute_beta { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of - * available target instances by making a list() request. + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -82160,8 +73358,7 @@ export namespace compute_beta { * zone: 'my-zone', // TODO: Update placeholder value. * * // Name of the TargetInstance resource to return. - * targetInstance: 'my-target-instance', // TODO: Update placeholder - * value. + * targetInstance: 'my-target-instance', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -82183,10 +73380,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -82266,22 +73462,19 @@ export namespace compute_beta { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone - * using the data included in the request. + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -82320,10 +73513,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -82404,22 +73596,19 @@ export namespace compute_beta { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the - * specified project and zone. + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -82467,10 +73656,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -82560,14 +73748,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -82592,8 +73778,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetInstances.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetInstances.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -82607,10 +73795,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -82702,46 +73889,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -82761,16 +73921,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -82814,16 +73965,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -82844,46 +73986,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -82936,14 +74051,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -82985,10 +74098,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -83077,14 +74189,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -83126,10 +74236,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -83218,14 +74327,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -83252,8 +74359,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -83271,10 +74377,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -83367,14 +74472,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -83412,10 +74515,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -83496,22 +74598,19 @@ export namespace compute_beta { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target - * pools by making a list() request. + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -83549,10 +74648,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -83631,22 +74729,19 @@ export namespace compute_beta { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the - * instance that is referenced by the given target pool. + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -83661,9 +74756,8 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the TargetPool resource to which the queried instance - * belongs. targetPool: 'my-target-pool', // TODO: Update placeholder - * value. + * // Name of the TargetPool resource to which the queried instance belongs. + * targetPool: 'my-target-pool', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -83689,10 +74783,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -83777,22 +74870,19 @@ export namespace compute_beta { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the - * data included in the request. + * @desc Creates a target pool in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -83831,10 +74921,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -83915,22 +75004,19 @@ export namespace compute_beta { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project - * and region. + * @desc Retrieves a list of target pools available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -83978,10 +75064,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -84070,14 +75155,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -84102,8 +75185,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetPools.removeHealthCheck(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.targetPools.removeHealthCheck(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -84117,10 +75202,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -84209,14 +75293,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -84258,10 +75340,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -84350,14 +75431,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -84399,10 +75478,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -84492,14 +75570,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -84524,8 +75600,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetPools.testIamPermissions(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.targetPools.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -84539,10 +75617,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -84642,16 +75719,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -84680,16 +75748,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -84710,46 +75769,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -84773,16 +75805,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -84850,16 +75873,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -84875,46 +75889,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -84942,16 +75929,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -84980,16 +75958,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -85022,16 +75991,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -85085,14 +76045,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -85105,8 +76063,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetSslProxy resource to delete. - * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder - * value. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -85128,10 +76085,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -85211,22 +76167,19 @@ export namespace compute_beta { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of - * available target SSL proxies by making a list() request. + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -85239,8 +76192,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetSslProxy resource to return. - * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder - * value. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -85262,10 +76214,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -85344,22 +76295,19 @@ export namespace compute_beta { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -85395,10 +76343,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -85478,22 +76425,19 @@ export namespace compute_beta { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -85538,10 +76482,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -85630,14 +76573,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -85649,9 +76590,8 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetSslProxy resource whose BackendService resource - * is to be set. targetSslProxy: 'my-target-ssl-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetSslProxy resource whose BackendService resource is to be set. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -85660,8 +76600,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetSslProxies.setBackendService(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetSslProxies.setBackendService(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -85675,10 +76617,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -85766,14 +76707,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -85785,9 +76724,8 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetSslProxy resource whose ProxyHeader is to be - * set. targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder - * value. + * // Name of the TargetSslProxy resource whose ProxyHeader is to be set. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -85796,8 +76734,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetSslProxies.setProxyHeader(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetSslProxies.setProxyHeader(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -85811,10 +76751,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -85902,14 +76841,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -85921,9 +76858,8 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetSslProxy resource whose SslCertificate resource - * is to be set. targetSslProxy: 'my-target-ssl-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetSslProxy resource whose SslCertificate resource is to be set. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -85932,8 +76868,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetSslProxies.setSslCertificates(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetSslProxies.setSslCertificates(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -85947,10 +76885,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -86031,10 +76968,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies - * the server-side support for SSL features. This affects connections - * between clients and the SSL proxy load balancer. They do not affect the - * connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -86118,14 +77052,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -86147,8 +77079,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetSslProxies.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetSslProxies.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -86162,10 +77096,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -86260,16 +77193,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -86305,16 +77229,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -86331,46 +77246,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -86390,21 +77278,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose BackendService resource is to - * be set. + * Name of the TargetSslProxy resource whose BackendService resource is to be set. */ targetSslProxy?: string; @@ -86425,16 +77303,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -86459,21 +77328,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose SslCertificate resource is to - * be set. + * Name of the TargetSslProxy resource whose SslCertificate resource is to be set. */ targetSslProxy?: string; @@ -86494,21 +77353,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose SSL policy is to be set. The - * name must be 1-63 characters long, and comply with RFC1035. + * Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. */ targetSslProxy?: string; @@ -86554,14 +77403,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -86574,8 +77421,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetTcpProxy resource to delete. - * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder - * value. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -86597,10 +77443,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -86680,22 +77525,19 @@ export namespace compute_beta { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of - * available target TCP proxies by making a list() request. + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -86708,8 +77550,7 @@ export namespace compute_beta { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetTcpProxy resource to return. - * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder - * value. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -86731,10 +77572,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -86813,22 +77653,19 @@ export namespace compute_beta { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -86864,10 +77701,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -86947,22 +77783,19 @@ export namespace compute_beta { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -87007,10 +77840,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -87099,14 +77931,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -87118,9 +77948,8 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetTcpProxy resource whose BackendService resource - * is to be set. targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetTcpProxy resource whose BackendService resource is to be set. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -87129,8 +77958,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetTcpProxies.setBackendService(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetTcpProxies.setBackendService(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -87144,10 +77975,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -87235,14 +78065,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -87254,9 +78082,8 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetTcpProxy resource whose ProxyHeader is to be - * set. targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder - * value. + * // Name of the TargetTcpProxy resource whose ProxyHeader is to be set. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -87265,8 +78092,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetTcpProxies.setProxyHeader(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetTcpProxies.setProxyHeader(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -87280,10 +78109,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -87375,16 +78203,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -87420,16 +78239,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -87446,46 +78256,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -87505,21 +78288,11 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetTcpProxy resource whose BackendService resource is to - * be set. + * Name of the TargetTcpProxy resource whose BackendService resource is to be set. */ targetTcpProxy?: string; @@ -87540,16 +78313,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -87578,14 +78342,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -87612,8 +78374,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -87631,10 +78392,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -87732,14 +78492,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -87755,8 +78513,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the target VPN gateway to delete. - * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update - * placeholder value. + * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -87778,10 +78535,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -87862,22 +78618,19 @@ export namespace compute_beta { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available - * target VPN gateways by making a list() request. + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -87893,8 +78646,7 @@ export namespace compute_beta { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the target VPN gateway to return. - * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update - * placeholder value. + * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -87916,10 +78668,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -87999,22 +78750,19 @@ export namespace compute_beta { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region - * using the data included in the request. + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -88053,10 +78801,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -88137,22 +78884,19 @@ export namespace compute_beta { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified - * project and region. + * @desc Retrieves a list of target VPN gateways available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -88200,10 +78944,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -88288,8 +79031,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.setLabels - * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, - * read the Labeling Resources documentation. + * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.targetVpnGateways.setLabels * @memberOf! () * @@ -88374,14 +79116,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -88406,8 +79146,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.targetVpnGateways.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetVpnGateways.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -88421,10 +79163,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -88516,46 +79257,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -88579,16 +79293,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -88632,16 +79337,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -88658,46 +79354,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -88725,16 +79394,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -88788,14 +79448,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -88830,10 +79488,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -88912,22 +79569,19 @@ export namespace compute_beta { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL - * maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -88962,10 +79616,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -89041,22 +79694,19 @@ export namespace compute_beta { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data - * included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -89092,10 +79742,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -89173,22 +79822,19 @@ export namespace compute_beta { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the - * specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -89227,10 +79873,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -89311,22 +79956,19 @@ export namespace compute_beta { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified - * project. + * @desc Retrieves the list of UrlMap resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -89371,10 +80013,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -89454,23 +80095,19 @@ export namespace compute_beta { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -89486,8 +80123,7 @@ export namespace compute_beta { * urlMap: 'my-url-map', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -89511,10 +80147,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -89601,14 +80236,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -89647,10 +80280,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -89734,22 +80366,19 @@ export namespace compute_beta { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the - * request. + * @desc Updates the specified UrlMap resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -89765,8 +80394,7 @@ export namespace compute_beta { * urlMap: 'my-url-map', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -89790,10 +80418,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -89873,23 +80500,19 @@ export namespace compute_beta { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of - * the provided UrlMap will be run. Calling this method does NOT create the - * UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -89928,10 +80551,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -90024,16 +80646,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -90067,16 +80680,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -90097,16 +80701,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -90126,46 +80721,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -90184,16 +80752,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -90238,16 +80797,7 @@ export namespace compute_beta { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -90448,8 +80998,7 @@ export namespace compute_beta { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN - * gateways by making a list() request. + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. * @alias compute.vpnGateways.get * @memberOf! () * @@ -90609,8 +81158,7 @@ export namespace compute_beta { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the - * data included in the request. + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. * @alias compute.vpnGateways.insert * @memberOf! () * @@ -90687,8 +81235,7 @@ export namespace compute_beta { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project - * and region. + * @desc Retrieves a list of VPN gateways available to the specified project and region. * @alias compute.vpnGateways.list * @memberOf! () * @@ -90766,8 +81313,7 @@ export namespace compute_beta { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read - * the Labeling Resources documentation. + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -90852,46 +81398,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -90915,16 +81434,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -90987,16 +81497,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -91012,46 +81513,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -91079,16 +81553,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -91117,14 +81582,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -91151,8 +81614,7 @@ export namespace compute_beta { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -91170,10 +81632,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -91265,14 +81726,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -91310,10 +81769,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -91394,22 +81852,19 @@ export namespace compute_beta { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available - * VPN tunnels by making a list() request. + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -91447,10 +81902,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -91529,22 +81983,19 @@ export namespace compute_beta { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region - * using the data included in the request. + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -91583,10 +82034,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -91667,22 +82117,19 @@ export namespace compute_beta { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified - * project and region. + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -91730,10 +82177,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -91815,8 +82261,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.setLabels - * @desc Sets the labels on a VpnTunnel. To learn more about labels, read - * the Labeling Resources documentation. + * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnTunnels.setLabels * @memberOf! () * @@ -91901,14 +82346,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -91933,8 +82376,10 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.vpnTunnels.testIamPermissions(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.vpnTunnels.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -91948,10 +82393,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -92043,46 +82487,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -92106,16 +82523,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -92158,16 +82566,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -92183,46 +82582,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -92250,16 +82622,7 @@ export namespace compute_beta { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -92313,14 +82676,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -92355,10 +82716,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -92443,14 +82803,12 @@ export namespace compute_beta { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -92488,10 +82846,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -92571,22 +82928,19 @@ export namespace compute_beta { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified zone. + * @desc Retrieves a list of Operation resources contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -92634,10 +82988,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -92767,46 +83120,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -92827,22 +83153,19 @@ export namespace compute_beta { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones - * by making a list() request. + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -92877,10 +83200,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -92955,22 +83277,19 @@ export namespace compute_beta { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified - * project. + * @desc Retrieves the list of Zone resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -93015,10 +83334,9 @@ export namespace compute_beta { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -93118,46 +83436,19 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** diff --git a/src/apis/compute/package.json b/src/apis/compute/package.json index 811c90deea0..4db544b1de3 100644 --- a/src/apis/compute/package.json +++ b/src/apis/compute/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index f2b89b82f0c..0302f8757a0 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace compute_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace compute_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -153,7 +150,10 @@ export namespace compute_v1 { zones: Resource$Zones; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.acceleratorTypes = new Resource$Acceleratortypes(this.context); this.addresses = new Resource$Addresses(this.context); @@ -234,8 +234,7 @@ export namespace compute_v1 { } /** - * A specification of the type and number of accelerator cards attached to the - * instance. + * A specification of the type and number of accelerator cards attached to the instance. */ export interface Schema$AcceleratorConfig { /** @@ -243,17 +242,12 @@ export namespace compute_v1 { */ acceleratorCount?: number; /** - * Full or partial URL of the accelerator type resource to attach to this - * instance. For example: - * projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 - * If you are creating an instance template, specify only the accelerator - * name. See GPUs on Compute Engine for a full list of accelerator types. + * Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. */ acceleratorType?: string; } /** - * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) - * (== resource_for v1.acceleratorTypes ==) + * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -261,8 +255,7 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * [Output Only] The deprecation status associated with this accelerator - * type. + * [Output Only] The deprecation status associated with this accelerator type. */ deprecated?: Schema$DeprecationStatus; /** @@ -270,13 +263,11 @@ export namespace compute_v1 { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#acceleratorType - * for accelerator types. + * [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. */ kind?: string; /** @@ -292,9 +283,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The name of the zone where the accelerator type resides, - * such as us-central1-a. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -308,17 +297,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$AcceleratorTypesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#acceleratorTypeAggregatedList for aggregated lists of accelerator - * types. + * [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -347,16 +330,11 @@ export namespace compute_v1 { */ items?: Schema$AcceleratorType[]; /** - * [Output Only] Type of resource. Always compute#acceleratorTypeList for - * lists of accelerator types. + * [Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -378,8 +356,7 @@ export namespace compute_v1 { */ acceleratorTypes?: Schema$AcceleratorType[]; /** - * [Output Only] An informational warning that appears when the accelerator - * types list is empty. + * [Output Only] An informational warning that appears when the accelerator types list is empty. */ warning?: { code?: string; @@ -388,46 +365,31 @@ export namespace compute_v1 { }; } /** - * An access configuration attached to an instance's network interface. - * Only one access config per instance is supported. + * An access configuration attached to an instance's network interface. Only one access config per instance is supported. */ export interface Schema$AccessConfig { /** - * [Output Only] Type of the resource. Always compute#accessConfig for - * access configs. + * [Output Only] Type of the resource. Always compute#accessConfig for access configs. */ kind?: string; /** - * The name of this access configuration. The default and recommended name - * is External NAT but you can use any arbitrary string you would like. For - * example, My external IP or Network Access. + * The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. */ name?: string; /** - * An external IP address associated with this instance. Specify an unused - * static external IP address available to the project or leave this field - * undefined to use an IP from a shared ephemeral IP address pool. If you - * specify a static external IP address, it must live in the same region as - * the zone of the instance. + * An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. */ natIP?: string; /** - * This signifies the networking tier used for configuring this access - * configuration and can only take the following values: PREMIUM, STANDARD. - * If an AccessConfig is specified without a valid external IP address, an - * ephemeral IP will be created with this networkTier. If an AccessConfig - * with a valid external IP address is specified, it must match that of the - * networkTier associated with the Address resource owning that IP. + * This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. */ networkTier?: string; /** - * The DNS domain name for the public PTR record. This field can only be set - * when the set_public_ptr field is enabled. + * The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. */ publicPtrDomainName?: string; /** - * Specifies whether a public DNS ?PTR? record should be created to map the - * external IP address of the instance to a DNS domain name. + * Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name. */ setPublicPtr?: boolean; /** @@ -436,9 +398,7 @@ export namespace compute_v1 { type?: string; } /** - * A reserved address resource. (== resource_for beta.addresses ==) (== - * resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== - * resource_for v1.globalAddresses ==) + * A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) */ export interface Schema$Address { /** @@ -446,8 +406,7 @@ export namespace compute_v1 { */ address?: string; /** - * The type of address to reserve, either INTERNAL or EXTERNAL. If - * unspecified, defaults to EXTERNAL. + * The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. */ addressType?: string; /** @@ -455,18 +414,15 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The IP Version that will be used by this address. Valid options are IPV4 - * or IPV6. This can only be specified for a global address. + * The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ ipVersion?: string; /** @@ -474,28 +430,15 @@ export namespace compute_v1 { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network in which to reserve the address. This field can - * only be used with INTERNAL type with VPC_PEERING purpose. + * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. */ network?: string; /** - * This signifies the networking tier used for configuring this Address and - * can only take the following values: PREMIUM, STANDARD. Global forwarding - * rules can only be Premium Tier. Regional forwarding rules can be either - * Premium or Standard Tier. Standard Tier addresses applied to regional - * forwarding rules can be used with any external load balancer. Regional - * forwarding rules in Premium Tier can only be used with a Network load - * balancer. If this field is not specified, it is assumed to be PREMIUM. + * This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ networkTier?: string; /** @@ -507,10 +450,7 @@ export namespace compute_v1 { */ purpose?: string; /** - * [Output Only] URL of the region where the regional address resides. This - * field is not applicable to global addresses. You must specify this field - * as part of the HTTP request URL. You cannot set this field in the request - * body. + * [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. */ region?: string; /** @@ -518,18 +458,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The status of the address, which can be one of RESERVING, - * RESERVED, or IN_USE. An address that is RESERVING is currently in the - * process of being reserved. A RESERVED address is currently reserved and - * available to use. An IN_USE address is currently being used by another - * resource and is not available. + * [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. */ status?: string; /** - * The URL of the subnetwork in which to reserve the address. If an IP - * address is specified, it must be within the subnetwork's IP range. - * This field can only be used with INTERNAL type with - * GCE_ENDPOINT/DNS_RESOLVER purposes. + * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. */ subnetwork?: string; /** @@ -547,16 +480,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$AddressesScopedList}; /** - * [Output Only] Type of resource. Always compute#addressAggregatedList for - * aggregated lists of addresses. + * [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -578,8 +506,7 @@ export namespace compute_v1 { */ addresses?: Schema$Address[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -600,16 +527,11 @@ export namespace compute_v1 { */ items?: Schema$Address[]; /** - * [Output Only] Type of resource. Always compute#addressList for lists of - * addresses. + * [Output Only] Type of resource. Always compute#addressList for lists of addresses. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -630,17 +552,11 @@ export namespace compute_v1 { */ export interface Schema$AliasIpRange { /** - * The IP CIDR range represented by this alias IP range. This IP CIDR range - * must belong to the specified subnetwork and cannot contain IP addresses - * reserved by system or used by other network interfaces. This range may be - * a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR - * format string (e.g. 10.1.2.0/24). + * The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). */ ipCidrRange?: string; /** - * Optional subnetwork secondary range name specifying the secondary range - * from which to allocate the IP CIDR range for this alias IP range. If left - * unspecified, the primary range of the subnetwork will be used. + * Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. */ subnetworkRangeName?: string; } @@ -649,74 +565,39 @@ export namespace compute_v1 { */ export interface Schema$AttachedDisk { /** - * Specifies whether the disk will be auto-deleted when the instance is - * deleted (but not when the disk is detached from the instance). + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ autoDelete?: boolean; /** - * Indicates that this is a boot disk. The virtual machine will use the - * first partition of the disk for its root filesystem. + * Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. */ boot?: boolean; /** - * Specifies a unique device name of your choice that is reflected into the - * /dev/disk/by-id/google-* tree of a Linux operating system running within - * the instance. This name can be used to reference the device for mounting, - * resizing, and so on, from within the instance. If not specified, the - * server chooses a default device name to apply to this disk, in the form - * persistent-disk-x, where x is a number assigned by Google Compute Engine. - * This field is only applicable for persistent disks. + * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. */ deviceName?: string; /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If - * you are creating a new disk, this field encrypts the new disk using an - * encryption key that you provide. If you are attaching an existing disk - * that is already encrypted, this field decrypts the disk using the - * customer-supplied encryption key. If you encrypt a disk using a - * customer-supplied key, you must provide the same key again when you - * attempt to use this resource at a later time. For example, you must - * provide the key when you create a snapshot or an image from the disk or - * when you attach the disk to a virtual machine instance. If you do not - * provide an encryption key, then the disk will be encrypted using an - * automatically generated key and you do not need to provide a key to use - * the disk later. Instance templates do not store customer-supplied - * encryption keys, so you cannot use your own keys to encrypt disks in a - * managed instance group. + * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] A zero-based index to this disk, where 0 is reserved for - * the boot disk. If you have many disks attached to an instance, each disk - * would have a unique index number. + * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. */ index?: number; /** - * [Input Only] Specifies the parameters for a new disk that will be created - * alongside the new instance. Use initialization parameters to create boot - * disks or local SSDs attached to the new instance. This property is - * mutually exclusive with the source property; you can only define one or - * the other, but not both. + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ initializeParams?: Schema$AttachedDiskInitializeParams; /** - * Specifies the disk interface to use for attaching this disk, which is - * either SCSI or NVME. The default is SCSI. Persistent disks must always - * use SCSI and the request will fail if you attempt to attach a persistent - * disk in any other format than SCSI. Local SSDs can use either NVME or - * SCSI. For performance characteristics of SCSI over NVMe, see Local SSD - * performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. */ interface?: string; /** - * [Output Only] Type of the resource. Always compute#attachedDisk for - * attached disks. + * [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. */ kind?: string; /** @@ -724,32 +605,20 @@ export namespace compute_v1 { */ licenses?: string[]; /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If - * not specified, the default is to attach the disk in READ_WRITE mode. + * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. */ mode?: string; /** - * Specifies a valid partial or full URL to an existing Persistent Disk - * resource. When creating a new instance, one of - * initializeParams.sourceImage or disks.source is required except for local - * SSD. If desired, you can also attach existing non-root persistent disks - * using this property. This field is only applicable for persistent disks. - * Note that for InstanceTemplate, specify the disk name, not the URL for - * the disk. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. */ source?: string; /** - * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - * specified, the default is PERSISTENT. + * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. */ type?: string; } /** - * [Input Only] Specifies the parameters for a new disk that will be created - * alongside the new instance. Use initialization parameters to create boot - * disks or local SSDs attached to the new instance. This property is - * mutually exclusive with the source property; you can only define one or the - * other, but not both. + * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. */ export interface Schema$AttachedDiskInitializeParams { /** @@ -757,9 +626,7 @@ export namespace compute_v1 { */ description?: string; /** - * Specifies the disk name. If not specified, the default is to use the name - * of the instance. If the disk with the instance name exists already in the - * given zone/region, a new name will be automatically generated. + * Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. */ diskName?: string; /** @@ -767,71 +634,24 @@ export namespace compute_v1 { */ diskSizeGb?: string; /** - * Specifies the disk type to use to create the instance. If not specified, - * the default is pd-standard, specified using the full URL. For example: - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard - * Other values include pd-ssd and local-ssd. If you define this field, you - * can provide either the full or partial URL. For example, the following - * are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - * - projects/project/zones/zone/diskTypes/diskType - - * zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is - * the name of the disk type, not URL. + * Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. */ diskType?: string; /** - * Labels to apply to this disk. These can be later modified by the - * disks.setLabels method. This field is only applicable for persistent - * disks. + * Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. */ labels?: {[key: string]: string}; /** - * The source image to create this disk. When creating a new instance, one - * of initializeParams.sourceImage or disks.source is required except for - * local SSD. To create a disk with one of the public operating system - * images, specify the image by its family name. For example, specify - * family/debian-9 to use the latest Debian 9 image: - * projects/debian-cloud/global/images/family/debian-9 Alternatively, use - * a specific version of a public operating system image: - * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To - * create a disk with a custom image that you created, specify the image - * name in the following format: global/images/my-custom-image You can - * also specify a custom image by its image family, which returns the latest - * version of the image in that family. Replace the image name with - * family/family-name: global/images/family/my-image-family If the source - * image is deleted later, this field will not be set. + * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. Instance - * templates do not store customer-supplied encryption keys, so you cannot - * create disks for instances in a managed instance group if the source - * images are encrypted with your own keys. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { "log_type": - * "ADMIN_READ", } ] }, { "service": - * "fooservice.googleapis.com" "audit_log_configs": [ { - * "log_type": "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy - * enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - * foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE - * logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -840,25 +660,16 @@ export namespace compute_v1 { auditLogConfigs?: Schema$AuditLogConfig[]; exemptedMembers?: string[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { "log_type": - * "DATA_WRITE", } ] } This enables 'DATA_READ' and - * 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ - * logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of [Binding.members][]. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[]; /** @@ -876,20 +687,11 @@ export namespace compute_v1 { permissionType?: string; } /** - * Represents an Autoscaler resource. Autoscalers allow you to automatically - * scale virtual machine instances in managed instance groups according to an - * autoscaling policy that you define. For more information, read Autoscaling - * Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for - * v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== - * resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** - * The configuration parameters for the autoscaling algorithm. You can - * define one or more of the policies for an autoscaler: cpuUtilization, - * customMetricUtilizations, and loadBalancingUtilization. If none of these - * are specified, the default will be to autoscale based on cpuUtilization - * to 0.6 or 60%. + * The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. */ autoscalingPolicy?: Schema$AutoscalingPolicy; /** @@ -897,33 +699,23 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#autoscaler for - * autoscalers. + * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] URL of the region where the instance group resides (for - * autoscalers living in regional scope). + * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). */ region?: string; /** @@ -935,9 +727,7 @@ export namespace compute_v1 { */ status?: string; /** - * [Output Only] Human-readable details about the current state of the - * autoscaler. Read the documentation for Commonly returned status messages - * for examples of status messages you might encounter. + * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. */ statusDetails?: Schema$AutoscalerStatusDetails[]; /** @@ -945,8 +735,7 @@ export namespace compute_v1 { */ target?: string; /** - * [Output Only] URL of the zone where the instance group resides (for - * autoscalers living in zonal scope). + * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). */ zone?: string; } @@ -960,16 +749,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$AutoscalersScopedList}; /** - * [Output Only] Type of resource. Always compute#autoscalerAggregatedList - * for aggregated lists of autoscalers. + * [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -998,16 +782,11 @@ export namespace compute_v1 { */ items?: Schema$Autoscaler[]; /** - * [Output Only] Type of resource. Always compute#autoscalerList for lists - * of autoscalers. + * [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1029,8 +808,7 @@ export namespace compute_v1 { */ autoscalers?: Schema$Autoscaler[]; /** - * [Output Only] Informational warning which replaces the list of - * autoscalers when the list is empty. + * [Output Only] Informational warning which replaces the list of autoscalers when the list is empty. */ warning?: { code?: string; @@ -1053,19 +831,11 @@ export namespace compute_v1 { */ export interface Schema$AutoscalingPolicy { /** - * The number of seconds that the autoscaler should wait before it starts - * collecting information from a new instance. This prevents the autoscaler - * from collecting information when the instance is initializing, during - * which the collected usage would not be reliable. The default time - * autoscaler waits is 60 seconds. Virtual machine initialization times - * might vary because of numerous factors. We recommend that you test how - * long an instance may take to initialize. To do this, create an instance - * and time the startup process. + * The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. */ coolDownPeriodSec?: number; /** - * Defines the CPU utilization policy that allows the autoscaler to scale - * based on the average CPU utilization of a managed instance group. + * Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. */ cpuUtilization?: Schema$AutoscalingPolicyCpuUtilization; /** @@ -1077,15 +847,11 @@ export namespace compute_v1 { */ loadBalancingUtilization?: Schema$AutoscalingPolicyLoadBalancingUtilization; /** - * The maximum number of instances that the autoscaler can scale up to. This - * is required when creating or updating an autoscaler. The maximum number - * of replicas should not be lower than minimal number of replicas. + * The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. */ maxNumReplicas?: number; /** - * The minimum number of replicas that the autoscaler can scale down to. - * This cannot be less than 0. If not provided, autoscaler will choose a - * default value depending on maximum number of instances allowed. + * The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. */ minNumReplicas?: number; } @@ -1094,15 +860,7 @@ export namespace compute_v1 { */ export interface Schema$AutoscalingPolicyCpuUtilization { /** - * The target CPU utilization that the autoscaler should maintain. Must be a - * float value in the range (0, 1]. If not specified, the default is 0.6. If - * the CPU level is below the target utilization, the autoscaler scales down - * the number of instances until it reaches the minimum number of instances - * you specified or until the average CPU of your instances reaches the - * target utilization. If the average CPU is above the target utilization, - * the autoscaler scales up until it reaches the maximum number of instances - * you specified or until the average utilization reaches the target - * utilization. + * The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. */ utilizationTarget?: number; } @@ -1111,24 +869,15 @@ export namespace compute_v1 { */ export interface Schema$AutoscalingPolicyCustomMetricUtilization { /** - * The identifier (type) of the Stackdriver Monitoring metric. The metric - * cannot have negative values. The metric must have a value type of INT64 - * or DOUBLE. + * The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. */ metric?: string; /** - * The target value of the metric that autoscaler should maintain. This must - * be a positive value. A utilization metric scales number of virtual - * machines handling requests to increase or decrease proportionally to the - * metric. For example, a good metric to use as a utilization_target is - * compute.googleapis.com/instance/network/received_bytes_count. The - * autoscaler will work to keep this value constant for each of the - * instances. + * The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances. */ utilizationTarget?: number; /** - * Defines how target utilization value is expressed for a Stackdriver - * Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + * Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. */ utilizationTargetType?: string; } @@ -1137,9 +886,7 @@ export namespace compute_v1 { */ export interface Schema$AutoscalingPolicyLoadBalancingUtilization { /** - * Fraction of backend capacity utilization (set in HTTP(S) load balancing - * configuration) that autoscaler should maintain. Must be a positive float - * value. If not defined, the default is 0.8. + * Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. */ utilizationTarget?: number; } @@ -1148,95 +895,47 @@ export namespace compute_v1 { */ export interface Schema$Backend { /** - * Specifies the balancing mode for this backend. For global HTTP(S) or - * TCP/SSL load balancing, the default is UTILIZATION. Valid values are - * UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For - * Internal Load Balancing, the default and only supported mode is - * CONNECTION. + * Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION. */ balancingMode?: string; /** - * A multiplier applied to the group's maximum servicing capacity (based - * on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the - * group will serve up to 100% of its configured capacity (depending on - * balancingMode). A setting of 0 means the group is completely drained, - * offering 0% of its available Capacity. Valid range is [0.0,1.0]. This - * cannot be used for internal load balancing. + * A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing. */ capacityScaler?: number; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The fully-qualified URL of an Instance Group or Network Endpoint Group - * resource. In case of instance group this defines the list of instances - * that serve traffic. Member virtual machine instances from each instance - * group must live in the same zone as the instance group itself. No two - * backends in a backend service are allowed to use same Instance Group - * resource. For Network Endpoint Groups this defines list of endpoints. - * All endpoints of Network Endpoint Group must be hosted on instances - * located in the same zone as the Network Endpoint Group. Backend service - * can not contain mix of Instance Group and Network Endpoint Group - * backends. Note that you must specify an Instance Group or Network - * Endpoint Group resource using the fully-qualified URL, rather than a - * partial URL. When the BackendService has load balancing scheme INTERNAL, - * the instance group must be within the same region as the BackendService. - * Network Endpoint Groups are not supported for INTERNAL load balancing - * scheme. + * The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend service can not contain mix of Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL. When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme. */ group?: string; /** - * The max number of simultaneous connections for the group. Can be used - * with either CONNECTION or UTILIZATION balancing modes. For CONNECTION - * mode, either maxConnections or maxConnectionsPerInstance must be set. - * This cannot be used for internal load balancing. + * The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. */ maxConnections?: number; /** - * The max number of simultaneous connections that a single backend network - * endpoint can handle. This is used to calculate the capacity of the group. - * Can be used in either CONNECTION or UTILIZATION balancing modes. For - * CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must - * be set. This cannot be used for internal load balancing. + * The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. This cannot be used for internal load balancing. */ maxConnectionsPerEndpoint?: number; /** - * The max number of simultaneous connections that a single backend instance - * can handle. This is used to calculate the capacity of the group. Can be - * used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION - * mode, either maxConnections or maxConnectionsPerInstance must be set. - * This cannot be used for internal load balancing. + * The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. */ maxConnectionsPerInstance?: number; /** - * The max requests per second (RPS) of the group. Can be used with either - * RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE - * mode, either maxRate or maxRatePerInstance must be set. This cannot be - * used for internal load balancing. + * The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ maxRate?: number; /** - * The max requests per second (RPS) that a single backend network endpoint - * can handle. This is used to calculate the capacity of the group. Can be - * used in either balancing mode. For RATE mode, either maxRate or - * maxRatePerEndpoint must be set. This cannot be used for internal load - * balancing. + * The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. This cannot be used for internal load balancing. */ maxRatePerEndpoint?: number; /** - * The max requests per second (RPS) that a single backend instance can - * handle. This is used to calculate the capacity of the group. Can be used - * in either balancing mode. For RATE mode, either maxRate or - * maxRatePerInstance must be set. This cannot be used for internal load - * balancing. + * The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. */ maxRatePerInstance?: number; /** - * Used when balancingMode is UTILIZATION. This ratio defines the CPU - * utilization target for the group. The default is 0.8. Valid range is - * [0.0, 1.0]. This cannot be used for internal load balancing. + * Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing. */ maxUtilization?: number; } @@ -1257,8 +956,7 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** @@ -1274,13 +972,7 @@ export namespace compute_v1 { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -1293,13 +985,7 @@ export namespace compute_v1 { */ export interface Schema$BackendBucketCdnPolicy { /** - * Maximum number of seconds the response to a signed URL request will be - * considered fresh. After this time period, the response will be - * revalidated before being served. Defaults to 1hr (3600s). When serving - * responses to signed URL requests, Cloud CDN will internally behave as - * though all responses from this backend had a "Cache-Control: public, - * max-age=[TTL]" header, regardless of any existing Cache-Control - * header. The actual headers served in responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** @@ -1324,11 +1010,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1345,17 +1027,11 @@ export namespace compute_v1 { }; } /** - * A BackendService resource. This resource defines a group of backend virtual - * machines and their serving capacity. (== resource_for v1.backendService ==) - * (== resource_for beta.backendService ==) + * A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) */ export interface Schema$BackendService { /** - * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. - * If set to 0, the cookie is non-persistent and lasts only until the end of - * the browser session (or equivalent). The maximum allowed value for TTL is - * one day. When the load balancing scheme is INTERNAL, this field is not - * used. + * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used. */ affinityCookieTtlSec?: number; /** @@ -1376,91 +1052,56 @@ export namespace compute_v1 { */ customRequestHeaders?: string[]; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * If true, enable Cloud CDN for this BackendService. When the load - * balancing scheme is INTERNAL, this field is not used. + * If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used. */ enableCDN?: boolean; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a BackendService. An up-to-date fingerprint must - * be provided in order to update the BackendService, otherwise the request - * will fail with error 412 conditionNotMet. To see the latest fingerprint, - * make a get() request to retrieve a BackendService. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. */ fingerprint?: string; /** - * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for - * health checking this BackendService. Currently at most one health check - * can be specified, and a health check is required for Compute Engine - * backend services. A health check must not be specified for App Engine - * backend and Cloud Function backend. For internal load balancing, a URL - * to a HealthCheck resource must be specified instead. + * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ healthChecks?: string[]; iap?: Schema$BackendServiceIAP; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#backendService for backend - * services. + * [Output Only] Type of resource. Always compute#backendService for backend services. */ kind?: string; /** - * Indicates whether the backend service will be used with internal or - * external load balancing. A backend service created for one type of load - * balancing cannot be used with the other. Possible values are INTERNAL and - * EXTERNAL. + * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. */ loadBalancingScheme?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Deprecated in favor of portName. The TCP port to connect on the backend. - * The default value is 80. This cannot be used for internal load - * balancing. + * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used for internal load balancing. */ port?: number; /** - * Name of backend port. The same name should appear in the instance groups - * referenced by this service. Required when the load balancing scheme is - * EXTERNAL. When the load balancing scheme is INTERNAL, this field is not - * used. + * Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used. */ portName?: string; /** - * The protocol this BackendService uses to communicate with backends. - * Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For - * internal load balancing, the possible values are TCP and UDP, and the - * default is TCP. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP. */ protocol?: string; /** - * [Output Only] URL of the region where the regional backend service - * resides. This field is not applicable to global backend services. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * [Output Only] The resource URL for the security policy associated with - * this backend service. + * [Output Only] The resource URL for the security policy associated with this backend service. */ securityPolicy?: string; /** @@ -1468,16 +1109,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Type of session affinity to use. The default is NONE. When the load - * balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or - * GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be - * NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the - * protocol is UDP, this field is not used. + * Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used. */ sessionAffinity?: string; /** - * How many seconds to wait for the backend before considering it a failed - * request. Default is 30 seconds. + * How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. */ timeoutSec?: number; } @@ -1498,11 +1134,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1527,13 +1159,7 @@ export namespace compute_v1 { */ cacheKeyPolicy?: Schema$CacheKeyPolicy; /** - * Maximum number of seconds the response to a signed URL request will be - * considered fresh. After this time period, the response will be - * revalidated before being served. Defaults to 1hr (3600s). When serving - * responses to signed URL requests, Cloud CDN will internally behave as - * though all responses from this backend had a "Cache-Control: public, - * max-age=[TTL]" header, regardless of any existing Cache-Control - * header. The actual headers served in responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** @@ -1543,13 +1169,11 @@ export namespace compute_v1 { } export interface Schema$BackendServiceGroupHealth { /** - * Health state of the backend instances or endpoints in requested instance - * or network endpoint group, determined based on configured health checks. + * Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. */ healthStatus?: Schema$HealthStatus[]; /** - * [Output Only] Type of resource. Always compute#backendServiceGroupHealth - * for the health of backend services. + * [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. */ kind?: string; } @@ -1578,16 +1202,11 @@ export namespace compute_v1 { */ items?: Schema$BackendService[]; /** - * [Output Only] Type of resource. Always compute#backendServiceList for - * lists of backend services. + * [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1612,8 +1231,7 @@ export namespace compute_v1 { */ backendServices?: Schema$BackendService[]; /** - * Informational warning which replaces the list of backend services when - * the list is empty. + * Informational warning which replaces the list of backend services when the list is empty. */ warning?: { code?: string; @@ -1626,44 +1244,27 @@ export namespace compute_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or without - * a Google account. * `allAuthenticatedUsers`: A special identifier that - * represents anyone who is authenticated with a Google account or a service - * account. * `user:{emailid}`: An email address that represents a specific - * Google account. For example, `alice@gmail.com` . * - * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } export interface Schema$CacheInvalidationRule { /** - * If set, this invalidation rule will only apply to requests with a Host - * header matching host. + * If set, this invalidation rule will only apply to requests with a Host header matching host. */ host?: string; path?: string; } /** - * Message containing what to include in the cache key for a request for Cloud - * CDN. + * Message containing what to include in the cache key for a request for Cloud CDN. */ export interface Schema$CacheKeyPolicy { /** @@ -1675,37 +1276,20 @@ export namespace compute_v1 { */ includeProtocol?: boolean; /** - * If true, include query string parameters in the cache key according to - * query_string_whitelist and query_string_blacklist. If neither is set, the - * entire query string will be included. If false, the query string will be - * excluded from the cache key entirely. + * If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. */ includeQueryString?: boolean; /** - * Names of query string parameters to exclude in cache keys. All other - * parameters will be included. Either specify query_string_whitelist or - * query_string_blacklist, not both. '&' and '=' will be - * percent encoded and not treated as delimiters. + * Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ queryStringBlacklist?: string[]; /** - * Names of query string parameters to include in cache keys. All other - * parameters will be excluded. Either specify query_string_whitelist or - * query_string_blacklist, not both. '&' and '=' will be - * percent encoded and not treated as delimiters. + * Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. */ queryStringWhitelist?: string[]; } /** - * Represents a Commitment resource. Creating a Commitment resource means that - * you are purchasing a committed use contract with an explicit start and end - * time. You can create commitments based on vCPUs and memory usage and - * receive discounted rates. For full details, read Signing Up for Committed - * Use Discounts. Committed use discounts are subject to Google Cloud - * Platform's Service Specific Terms. By purchasing a committed use - * discount, you agree to these terms. Committed use discounts will not renew, - * so you must purchase a new commitment to continue receiving discounts. (== - * resource_for beta.commitments ==) (== resource_for v1.commitments ==) + * Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments ==) (== resource_for v1.commitments ==) */ export interface Schema$Commitment { /** @@ -1713,8 +1297,7 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -1722,29 +1305,19 @@ export namespace compute_v1 { */ endTimestamp?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#commitment for - * commitments. + * [Output Only] Type of the resource. Always compute#commitment for commitments. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The plan for this commitment, which determines duration and discount - * rate. The currently supported plans are TWELVE_MONTH (1 year), and - * THIRTY_SIX_MONTH (3 years). + * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ plan?: string; /** @@ -1752,8 +1325,7 @@ export namespace compute_v1 { */ region?: string; /** - * A list of commitment amounts for particular resources. Note that VCPU and - * MEMORY resource commitments must occur together. + * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. */ resources?: Schema$ResourceCommitment[]; /** @@ -1765,9 +1337,7 @@ export namespace compute_v1 { */ startTimestamp?: string; /** - * [Output Only] Status of the commitment with regards to eventual - * expiration (each commitment has an end date defined). One of the - * following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. */ status?: string; /** @@ -1785,16 +1355,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$CommitmentsScopedList}; /** - * [Output Only] Type of resource. Always compute#commitmentAggregatedList - * for aggregated lists of commitments. + * [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1823,16 +1388,11 @@ export namespace compute_v1 { */ items?: Schema$Commitment[]; /** - * [Output Only] Type of resource. Always compute#commitmentList for lists - * of commitments. + * [Output Only] Type of resource. Always compute#commitmentList for lists of commitments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -1854,8 +1414,7 @@ export namespace compute_v1 { */ commitments?: Schema$Commitment[]; /** - * [Output Only] Informational warning which replaces the list of - * commitments when the list is empty. + * [Output Only] Informational warning which replaces the list of commitments when the list is empty. */ warning?: { code?: string; @@ -1880,8 +1439,7 @@ export namespace compute_v1 { */ svc?: string; /** - * Trusted attributes supplied by any service that owns resources and uses - * the IAM system for access control. + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ sys?: string; /** @@ -1894,8 +1452,7 @@ export namespace compute_v1 { */ export interface Schema$ConnectionDraining { /** - * Time for which instance will be drained (not accept new connections, but - * still work to finish started). + * Time for which instance will be drained (not accept new connections, but still work to finish started). */ drainingTimeoutSec?: number; } @@ -1908,25 +1465,21 @@ export namespace compute_v1 { */ kmsKeyName?: string; /** - * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - * base64 to either encrypt or decrypt this resource. + * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. */ rawKey?: string; /** - * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the - * customer-supplied encryption key that protects this resource. + * [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. */ sha256?: string; } export interface Schema$CustomerEncryptionKeyProtectedDisk { /** - * Decrypts data associated with the disk with a customer-supplied - * encryption key. + * Decrypts data associated with the disk with a customer-supplied encryption key. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * Specifies a valid partial or full URL to an existing Persistent Disk - * resource. This field is only applicable for persistent disks. + * Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. */ source?: string; } @@ -1935,43 +1488,28 @@ export namespace compute_v1 { */ export interface Schema$DeprecationStatus { /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to DELETED. This is only informational and - * the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. */ deleted?: string; /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to DEPRECATED. This is only informational - * and the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. */ deprecated?: string; /** - * An optional RFC3339 timestamp on or after which the state of this - * resource is intended to change to OBSOLETE. This is only informational - * and the status will not change unless the client explicitly changes it. + * An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. */ obsolete?: string; /** - * The URL of the suggested replacement for a deprecated resource. The - * suggested replacement resource must be the same kind of resource as the - * deprecated resource. + * The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. */ replacement?: string; /** - * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, - * OBSOLETE, or DELETED. Operations which communicate the end of life date - * for an image, can use ACTIVE. Operations which create a new resource - * using a DEPRECATED resource will return successfully, but with a warning - * indicating the deprecated resource and recommending its replacement. - * Operations which use OBSOLETE or DELETED resources will be rejected and - * result in an error. + * The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. */ state?: string; } /** - * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks - * ==) + * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==) */ export interface Schema$Disk { /** @@ -1979,30 +1517,19 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Encrypts the disk using a customer-supplied encryption key. After you - * encrypt a disk with a customer-supplied key, you must provide the same - * key if you use the disk later (e.g. to create a disk snapshot or an - * image, or to attach the disk to a virtual machine). Customer-supplied - * encryption keys do not protect access to metadata of the disk. If you do - * not provide an encryption key when creating the disk, then the disk will - * be encrypted using an automatically generated key and you do not need to - * provide a key to use the disk later. + * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -2010,18 +1537,11 @@ export namespace compute_v1 { */ kind?: string; /** - * A fingerprint for the labels being applied to this disk, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a disk. + * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. */ labelFingerprint?: string; /** - * Labels to apply to this disk. These can be later modified by the - * setLabels method. + * Labels to apply to this disk. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** @@ -2033,8 +1553,7 @@ export namespace compute_v1 { */ lastDetachTimestamp?: string; /** - * Integer license codes indicating which licenses are attached to this - * disk. + * Integer license codes indicating which licenses are attached to this disk. */ licenseCodes?: string[]; /** @@ -2042,13 +1561,7 @@ export namespace compute_v1 { */ licenses?: string[]; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -2056,22 +1569,15 @@ export namespace compute_v1 { */ options?: string; /** - * Physical block size of the persistent disk, in bytes. If not present in a - * request, a default value is used. Currently supported sizes are 4096 and - * 16384, other sizes may be added in the future. If an unsupported value is - * requested, the error message will list the supported values for the - * caller's project. + * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. */ physicalBlockSizeBytes?: string; /** - * [Output Only] URL of the region where the disk resides. Only applicable - * for regional resources. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * URLs of the zones where the disk should be replicated to. Only applicable - * for regional resources. + * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ replicaZones?: string[]; /** @@ -2079,62 +1585,31 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Size of the persistent disk, specified in GB. You can specify this field - * when creating a persistent disk using the sourceImage or sourceSnapshot - * parameter, or specify it alone to create an empty persistent disk. If - * you specify this field along with sourceImage or sourceSnapshot, the - * value of sizeGb must not be less than the size of the sourceImage or the - * size of the snapshot. Acceptable values are 1 to 65536, inclusive. + * Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. */ sizeGb?: string; /** - * The source image used to create this disk. If the source image is - * deleted, this field will not be set. To create a disk with one of the - * public operating system images, specify the image by its family name. For - * example, specify family/debian-9 to use the latest Debian 9 image: - * projects/debian-cloud/global/images/family/debian-9 Alternatively, use - * a specific version of a public operating system image: - * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To - * create a disk with a custom image that you created, specify the image - * name in the following format: global/images/my-custom-image You can - * also specify a custom image by its image family, which returns the latest - * version of the image in that family. Replace the image name with - * family/family-name: global/images/family/my-image-family + * The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the image used to create this disk. This - * value identifies the exact image that was used to create this persistent - * disk. For example, if you created the persistent disk from an image that - * was later deleted and recreated under the same name, the source image ID - * would identify the exact version of the image that was used. + * [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. */ sourceImageId?: string; /** - * The source snapshot used to create this disk. You can provide this as a - * partial or full URL to the resource. For example, the following are valid - * values: - - * https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - * - projects/project/global/snapshots/snapshot - global/snapshots/snapshot + * The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot */ sourceSnapshot?: string; /** - * The customer-supplied encryption key of the source snapshot. Required if - * the source snapshot is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The unique ID of the snapshot used to create this disk. - * This value identifies the exact snapshot that was used to create this - * persistent disk. For example, if you created the persistent disk from a - * snapshot that was later deleted and recreated under the same name, the - * source snapshot ID would identify the exact version of the snapshot that - * was used. + * [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. */ sourceSnapshotId?: string; /** @@ -2142,20 +1617,15 @@ export namespace compute_v1 { */ status?: string; /** - * URL of the disk type resource describing which disk type to use to create - * the disk. Provide this when creating the disk. For example: - * project/zones/zone/diskTypes/pd-standard or pd-ssd + * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd */ type?: string; /** - * [Output Only] Links to the users of the disk (attached instances) in - * form: project/zones/zone/instances/instance + * [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance */ users?: string[]; /** - * [Output Only] URL of the zone where the disk resides. You must specify - * this field as part of the HTTP request URL. It is not settable as a field - * in the request body. + * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -2169,16 +1639,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$DisksScopedList}; /** - * [Output Only] Type of resource. Always compute#diskAggregatedList for - * aggregated lists of persistent disks. + * [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2195,37 +1660,23 @@ export namespace compute_v1 { }; } /** - * A specification of the desired way to instantiate a disk in the instance - * template when its created from a source instance. + * A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. */ export interface Schema$DiskInstantiationConfig { /** - * Specifies whether the disk will be auto-deleted when the instance is - * deleted (but not when the disk is detached from the instance). + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ autoDelete?: boolean; /** - * The custom source image to be used to restore this disk when - * instantiating this instance template. + * The custom source image to be used to restore this disk when instantiating this instance template. */ customImage?: string; /** - * Specifies the device name of the disk to which the configurations apply - * to. + * Specifies the device name of the disk to which the configurations apply to. */ deviceName?: string; /** - * Specifies whether to include the disk and what image to use. Possible - * values are: - source-image: to use the same image that was used to - * create the source instance's corresponding disk. Applicable to the - * boot disk and additional read-write disks. - source-image-family: to use - * the same image family that was used to create the source instance's - * corresponding disk. Applicable to the boot disk and additional read-write - * disks. - custom-image: to use a user-provided image url for disk - * creation. Applicable to the boot disk and additional read-write disks. - - * attach-read-only: to attach a read-only disk. Applicable to read-only - * disks. - do-not-include: to exclude a disk from the template. Applicable - * to additional read-write disks, local SSDs, and read-only disks. + * Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. */ instantiateFrom?: string; } @@ -2242,16 +1693,11 @@ export namespace compute_v1 { */ items?: Schema$Disk[]; /** - * [Output Only] Type of resource. Always compute#diskList for lists of - * disks. + * [Output Only] Type of resource. Always compute#diskList for lists of disks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2269,17 +1715,11 @@ export namespace compute_v1 { } export interface Schema$DiskMoveRequest { /** - * The URL of the destination zone to move the disk. This can be a full or - * partial URL. For example, the following are all valid URLs to a zone: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone - - * projects/project/zones/zone - zones/zone + * The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone */ destinationZone?: string; /** - * The URL of the target disk to move. This can be a full or partial URL. - * For example, the following are all valid URLs to a disk: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + * The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ targetDisk?: string; } @@ -2295,8 +1735,7 @@ export namespace compute_v1 { */ disks?: Schema$Disk[]; /** - * [Output Only] Informational warning which replaces the list of disks when - * the list is empty. + * [Output Only] Informational warning which replaces the list of disks when the list is empty. */ warning?: { code?: string; @@ -2305,8 +1744,7 @@ export namespace compute_v1 { }; } /** - * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for - * v1.diskTypes ==) + * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) */ export interface Schema$DiskType { /** @@ -2326,13 +1764,11 @@ export namespace compute_v1 { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#diskType for disk - * types. + * [Output Only] Type of the resource. Always compute#diskType for disk types. */ kind?: string; /** @@ -2340,9 +1776,7 @@ export namespace compute_v1 { */ name?: string; /** - * [Output Only] URL of the region where the disk type resides. Only - * applicable for regional resources. You must specify this field as part of - * the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -2350,14 +1784,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] An optional textual description of the valid disk size, - * such as "10GB-10TB". + * [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". */ validDiskSize?: string; /** - * [Output Only] URL of the zone where the disk type resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -2375,11 +1806,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2408,16 +1835,11 @@ export namespace compute_v1 { */ items?: Schema$DiskType[]; /** - * [Output Only] Type of resource. Always compute#diskTypeList for disk - * types. + * [Output Only] Type of resource. Always compute#diskTypeList for disk types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2439,8 +1861,7 @@ export namespace compute_v1 { */ diskTypes?: Schema$DiskType[]; /** - * [Output Only] Informational warning which replaces the list of disk types - * when the list is empty. + * [Output Only] Informational warning which replaces the list of disk types when the list is empty. */ warning?: { code?: string; @@ -2450,44 +1871,34 @@ export namespace compute_v1 { } export interface Schema$DistributionPolicy { /** - * Zones where the regional managed instance group will create and manage - * instances. + * Zones where the regional managed instance group will create and manage instances. */ zones?: Schema$DistributionPolicyZoneConfiguration[]; } export interface Schema$DistributionPolicyZoneConfiguration { /** - * The URL of the zone. The zone must exist in the region where the managed - * instance group is located. + * The URL of the zone. The zone must exist in the region where the managed instance group is located. */ zone?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -2496,8 +1907,7 @@ export namespace compute_v1 { */ export interface Schema$Firewall { /** - * The list of ALLOW rules specified by this firewall. Each rule specifies a - * protocol and port-range tuple that describes a permitted connection. + * The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. */ allowed?: Array<{IPProtocol?: string; ports?: string[]}>; /** @@ -2505,78 +1915,47 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * The list of DENY rules specified by this firewall. Each rule specifies a - * protocol and port-range tuple that describes a denied connection. + * The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. */ denied?: Array<{IPProtocol?: string; ports?: string[]}>; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * If destination ranges are specified, the firewall will apply only to - * traffic that has destination IP address in these ranges. These ranges - * must be expressed in CIDR format. Only IPv4 is supported. + * If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ destinationRanges?: string[]; /** - * Direction of traffic to which this firewall applies; default is INGRESS. - * Note: For INGRESS traffic, it is NOT supported to specify - * destinationRanges; For EGRESS traffic, it is NOT supported to specify - * sourceRanges OR sourceTags. + * Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. */ direction?: string; /** - * Denotes whether the firewall rule is disabled, i.e not applied to the - * network it is associated with. When set to true, the firewall rule is not - * enforced and the network behaves as if it did not exist. If this is - * unspecified, the firewall rule will be enabled. + * Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ disabled?: boolean; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#firewall for firewall - * rules. + * [Output Only] Type of the resource. Always compute#firewall for firewall rules. */ kind?: string; /** - * This field denotes the logging options for a particular firewall rule. If - * logging is enabled, logs will be exported to Stackdriver. + * This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. */ logConfig?: Schema$FirewallLogConfig; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network resource for this firewall rule. If not specified when - * creating a firewall rule, the default network is used: - * global/networks/default If you choose to specify this property, you can - * specify the network as a full or partial URL. For example, the following - * are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - * - projects/myproject/global/networks/my-network - - * global/networks/default + * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string; /** - * Priority for this rule. This is an integer between 0 and 65535, both - * inclusive. When not specified, the value assumed is 1000. Relative - * priorities determine precedence of conflicting rules. Lower value of - * priority implies higher precedence (eg, a rule with priority 0 has higher - * precedence than a rule with priority 1). DENY rules take precedence over - * ALLOW rules having equal priority. + * Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. */ priority?: number; /** @@ -2584,59 +1963,23 @@ export namespace compute_v1 { */ selfLink?: string; /** - * If source ranges are specified, the firewall will apply only to traffic - * that has source IP address in these ranges. These ranges must be - * expressed in CIDR format. One or both of sourceRanges and sourceTags may - * be set. If both properties are set, the firewall will apply to traffic - * that has source IP address within sourceRanges OR the source IP that - * belongs to a tag listed in the sourceTags property. The connection does - * not need to match both properties for the firewall to apply. Only IPv4 is - * supported. + * If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. */ sourceRanges?: string[]; /** - * If source service accounts are specified, the firewall will apply only to - * traffic originating from an instance with a service account in this list. - * Source service accounts cannot be used to control traffic to an - * instance's external IP address because service accounts are - * associated with an instance, not an IP address. sourceRanges can be set - * at the same time as sourceServiceAccounts. If both are set, the firewall - * will apply to traffic that has source IP address within sourceRanges OR - * the source IP belongs to an instance with service account listed in - * sourceServiceAccount. The connection does not need to match both - * properties for the firewall to apply. sourceServiceAccounts cannot be - * used at the same time as sourceTags or targetTags. + * If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ sourceServiceAccounts?: string[]; /** - * If source tags are specified, the firewall rule applies only to traffic - * with source IPs that match the primary network interfaces of VM instances - * that have the tag and are in the same VPC network. Source tags cannot be - * used to control traffic to an instance's external IP address, it only - * applies to traffic between instances in the same virtual network. Because - * tags are associated with instances, not IP addresses. One or both of - * sourceRanges and sourceTags may be set. If both properties are set, the - * firewall will apply to traffic that has source IP address within - * sourceRanges OR the source IP that belongs to a tag listed in the - * sourceTags property. The connection does not need to match both - * properties for the firewall to apply. + * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. */ sourceTags?: string[]; /** - * A list of service accounts indicating sets of instances located in the - * network that may make network connections as specified in allowed[]. - * targetServiceAccounts cannot be used at the same time as targetTags or - * sourceTags. If neither targetServiceAccounts nor targetTags are - * specified, the firewall rule applies to all instances on the specified - * network. + * A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. */ targetServiceAccounts?: string[]; /** - * A list of tags that controls which instances the firewall rule applies - * to. If targetTags are specified, then the firewall rule applies only to - * instances in the VPC network that have one of those tags. If no - * targetTags are specified, the firewall rule applies to all instances on - * the specified network. + * A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. */ targetTags?: string[]; } @@ -2653,16 +1996,11 @@ export namespace compute_v1 { */ items?: Schema$Firewall[]; /** - * [Output Only] Type of resource. Always compute#firewallList for lists of - * firewalls. + * [Output Only] Type of resource. Always compute#firewallList for lists of firewalls. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2683,8 +2021,7 @@ export namespace compute_v1 { */ export interface Schema$FirewallLogConfig { /** - * This field denotes whether to enable logging for a particular firewall - * rule. + * This field denotes whether to enable logging for a particular firewall rule. */ enable?: boolean; } @@ -2693,49 +2030,28 @@ export namespace compute_v1 { */ export interface Schema$FixedOrPercent { /** - * [Output Only] Absolute value of VM instances calculated based on the - * specific mode. - If the value is fixed, then the calculated value is - * equal to the fixed value. - If the value is a percent, then the - * calculated value is percent/100 * targetSize. For example, the calculated - * value of a 80% of a managed instance group with 150 instances would be - * (80/100 * 150) = 120 VM instances. If there is a remainder, the number is - * rounded up. + * [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up. */ calculated?: number; /** - * Specifies a fixed number of VM instances. This must be a positive - * integer. + * Specifies a fixed number of VM instances. This must be a positive integer. */ fixed?: number; /** - * Specifies a percentage of instances between 0 to 100%, inclusive. For - * example, specify 80 for 80%. + * Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. */ percent?: number; } /** - * A ForwardingRule resource. A ForwardingRule resource specifies which pool - * of target virtual machines to forward a packet to if it matches the given - * [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules - * ==) (== resource_for v1.forwardingRules ==) (== resource_for - * beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules - * ==) (== resource_for beta.regionForwardingRules ==) (== resource_for - * v1.regionForwardingRules ==) + * A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** - * This field is used along with the backend_service field for internal load - * balancing or with the target field for internal TargetInstance. This - * field cannot be used with port or portRange fields. When the load - * balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field - * to allow packets addressed to any ports will be forwarded to the backends - * configured with this forwarding rule. + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. */ allPorts?: boolean; /** - * This field is only used for INTERNAL load balancing. For internal load - * balancing, this field identifies the BackendService resource to receive - * the matched traffic. + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. */ backendService?: string; /** @@ -2743,123 +2059,55 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The IP address that this forwarding rule is serving on behalf of. - * Addresses are restricted based on the forwarding rule's load - * balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). - * When the load balancing scheme is EXTERNAL, for global forwarding rules, - * the address must be a global IP, and for regional forwarding rules, the - * address must live in the same region as the forwarding rule. If this - * field is empty, an ephemeral IPv4 address from the same scope (global or - * regional) will be assigned. A regional forwarding rule supports IPv4 - * only. A global forwarding rule supports either IPv4 or IPv6. When the - * load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL - * reference to an existing Address resource ( internal regional static IP - * address), with a purpose of GCE_END_POINT and address_type of INTERNAL. - * When the load balancing scheme is INTERNAL, this can only be an RFC 1918 - * IP address belonging to the network/subnet configured for the forwarding - * rule. By default, if this field is empty, an ephemeral internal IP - * address will be automatically allocated from the IP range of the subnet - * or network configured for this forwarding rule. An address can be - * specified either by a literal IP address or a URL reference to an - * existing Address resource. The following examples are all valid: - - * 100.1.2.3 - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address - * - projects/project/regions/region/addresses/address - - * regions/region/addresses/address - global/addresses/address - address + * The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: - 100.1.2.3 - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address - projects/project/regions/region/addresses/address - regions/region/addresses/address - global/addresses/address - address */ IPAddress?: string; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, - * ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only - * TCP and UDP are valid. When the load balancing scheme is - * INTERNAL_SELF_MANAGED, only TCPis valid. + * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. */ IPProtocol?: string; /** - * The IP Version that will be used by this forwarding rule. Valid options - * are IPV4 or IPV6. This can only be specified for an external global - * forwarding rule. + * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. */ ipVersion?: string; /** - * [Output Only] Type of the resource. Always compute#forwardingRule for - * Forwarding Rule resources. + * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. */ kind?: string; /** - * This signifies what the ForwardingRule will be used for and can only take - * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The - * value of INTERNAL means that this will be used for Internal Network Load - * Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this - * will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means - * that this will be used for External Load Balancing (HTTP(S) LB, External - * TCP/UDP LB, SSL Proxy) + * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) */ loadBalancingScheme?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * This field is not used for external load balancing. For INTERNAL and - * INTERNAL_SELF_MANAGED load balancing, this field identifies the network - * that the load balanced IP should belong to for this Forwarding Rule. If - * this field is not specified, the default network will be used. + * This field is not used for external load balancing. For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. */ network?: string; /** - * This signifies the networking tier used for configuring this load - * balancer and can only take the following values: PREMIUM , STANDARD. For - * regional ForwardingRule, the valid values are PREMIUM and STANDARD. For - * GlobalForwardingRule, the valid value is PREMIUM. If this field is not - * specified, it is assumed to be PREMIUM. If IPAddress is specified, this - * value must be equal to the networkTier of the Address. + * This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. */ networkTier?: string; /** - * This field is used along with the target field for TargetHttpProxy, - * TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, - * TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, - * or SCTP, only packets addressed to ports in the specified range will be - * forwarded to target. Forwarding rules with the same [IPAddress, - * IPProtocol] pair must have disjoint port ranges. Some types of - * forwarding target have constraints on the acceptable ports: - - * TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, - * 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - - * TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, - * 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 + * This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 */ portRange?: string; /** - * This field is used along with the backend_service field for internal load - * balancing. When the load balancing scheme is INTERNAL, a list of ports - * can be configured, for example, ['80'], - * ['8000','9000'] etc. Only packets addressed to these - * ports will be forwarded to the backends configured with this forwarding - * rule. You may specify a maximum of up to 5 ports. + * This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports. */ ports?: string[]; /** - * [Output Only] URL of the region where the regional forwarding rule - * resides. This field is not applicable to global forwarding rules. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -2867,36 +2115,19 @@ export namespace compute_v1 { */ selfLink?: string; /** - * An optional prefix to the service name for this Forwarding Rule. If - * specified, will be the first label of the fully qualified service name. - * The label must be 1-63 characters long, and comply with RFC1035. - * Specifically, the label must be 1-63 characters long and match the - * regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. This field is only used for internal load balancing. + * An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. */ serviceLabel?: string; /** - * [Output Only] The internal fully qualified service name for this - * Forwarding Rule. This field is only used for internal load balancing. + * [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. */ serviceName?: string; /** - * This field is only used for INTERNAL load balancing. For internal load - * balancing, this field identifies the subnetwork that the load balanced IP - * should belong to for this Forwarding Rule. If the network specified is - * in auto subnet mode, this field is optional. However, if the network is - * in custom subnet mode, a subnetwork must be specified. + * This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. */ subnetwork?: string; /** - * The URL of the target resource to receive the matched traffic. For - * regional forwarding rules, this target must live in the same region as - * the forwarding rule. For global forwarding rules, this target must be a - * global load balancing resource. The forwarded traffic must be of a type - * appropriate to the target object. For INTERNAL_SELF_MANAGED load - * balancing, only HTTP and HTTPS targets are valid. + * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. */ target?: string; } @@ -2910,16 +2141,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$ForwardingRulesScopedList}; /** - * [Output Only] Type of resource. Always - * compute#forwardingRuleAggregatedList for lists of forwarding rules. + * [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2952,11 +2178,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -2981,8 +2203,7 @@ export namespace compute_v1 { */ forwardingRules?: Schema$ForwardingRule[]; /** - * Informational warning which replaces the list of forwarding rules when - * the list is empty. + * Informational warning which replaces the list of forwarding rules when the list is empty. */ warning?: { code?: string; @@ -2992,43 +2213,25 @@ export namespace compute_v1 { } export interface Schema$GlobalSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash when updating or - * changing labels, otherwise the request will fail with error 412 - * conditionNotMet. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** - * A list of labels to apply for this resource. Each label key & value - * must comply with RFC1035. Specifically, the name must be 1-63 characters - * long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which - * means the first character must be a lowercase letter, and all following - * characters must be a dash, lowercase letter, or digit, except the last - * character, which cannot be a dash. For example, - * "webserver-frontend": "images". A label value can - * also be empty (e.g. "my-label": ""). + * A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). */ labels?: {[key: string]: string}; } export interface Schema$GlobalSetPolicyRequest { /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -3037,20 +2240,16 @@ export namespace compute_v1 { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. Read Enabling guest operating system - * features to see a list of available options. + * The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. */ type?: string; } /** - * An HealthCheck resource. This resource defines a template for how - * individual virtual machines should be checked for health, via one of the - * supported protocols. + * An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. */ export interface Schema$HealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -3058,21 +2257,18 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; http2HealthCheck?: Schema$HTTP2HealthCheck; httpHealthCheck?: Schema$HTTPHealthCheck; httpsHealthCheck?: Schema$HTTPSHealthCheck; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -3080,13 +2276,7 @@ export namespace compute_v1 { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -3096,21 +2286,15 @@ export namespace compute_v1 { sslHealthCheck?: Schema$SSLHealthCheck; tcpHealthCheck?: Schema$TCPHealthCheck; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ timeoutSec?: number; /** - * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or - * HTTP2. If not specified, the default is TCP. Exactly one of the - * protocol-specific health check field must be specified, which must match - * type field. + * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field. */ type?: string; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -3131,11 +2315,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3152,11 +2332,7 @@ export namespace compute_v1 { }; } /** - * A full or valid partial URL to a health check. For example, the following - * are valid URLs: - - * https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - * - projects/project-id/global/httpHealthChecks/health-check - - * global/httpHealthChecks/health-check + * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ export interface Schema$HealthCheckReference { healthCheck?: string; @@ -3181,146 +2357,105 @@ export namespace compute_v1 { } export interface Schema$HealthStatusForNetworkEndpoint { /** - * URL of the backend service associated with the health state of the - * network endpoint. + * URL of the backend service associated with the health state of the network endpoint. */ backendService?: Schema$BackendServiceReference; /** - * URL of the forwarding rule associated with the health state of the - * network endpoint. + * URL of the forwarding rule associated with the health state of the network endpoint. */ forwardingRule?: Schema$ForwardingRuleReference; /** - * URL of the health check associated with the health state of the network - * endpoint. + * URL of the health check associated with the health state of the network endpoint. */ healthCheck?: Schema$HealthCheckReference; /** - * Health state of the network endpoint determined based on the health - * checks configured. + * Health state of the network endpoint determined based on the health checks configured. */ healthState?: string; } /** - * UrlMaps A host-matching rule for a URL. If matched, will use the named - * PathMatcher to select the BackendService. + * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. */ export interface Schema$HostRule { /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The list of host patterns to match. They must be valid hostnames, except - * * will match any string of ([a-z0-9-.]*). In that case, * must be the - * first character and must be followed in the pattern by either - or .. + * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. */ hosts?: string[]; /** - * The name of the PathMatcher to use to match the path portion of the URL - * if the hostRule matches the URL's host portion. + * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. */ pathMatcher?: string; } export interface Schema$HTTP2HealthCheck { /** - * The value of the host header in the HTTP/2 health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTP2 health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTP/2 health check request. The default value is - * /. + * The request path of the HTTP/2 health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } export interface Schema$HTTPHealthCheck { /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value - * is 80. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTP health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTP health check request. The default value is - * /. + * The request path of the HTTP health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } /** - * An HttpHealthCheck resource. This resource defines a template for how - * individual instances should be checked for health, via HTTP. + * An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP. */ export interface Schema$HttpHealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -3328,49 +2463,35 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the public IP on behalf of which this health check - * is performed will be used. + * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ host?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#httpHealthCheck for - * HTTP health checks. + * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The TCP port number for the HTTP health check request. The default value - * is 80. + * The TCP port number for the HTTP health check request. The default value is 80. */ port?: number; /** - * The request path of the HTTP health check request. The default value is - * /. + * The request path of the HTTP health check request. The default value is /. */ requestPath?: string; /** @@ -3378,14 +2499,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. */ timeoutSec?: number; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -3406,11 +2524,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3428,57 +2542,40 @@ export namespace compute_v1 { } export interface Schema$HTTPSHealthCheck { /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. + * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. */ host?: string; /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTPS health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The request path of the HTTPS health check request. The default value is - * /. + * The request path of the HTTPS health check request. The default value is /. */ requestPath?: string; /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. */ response?: string; } /** - * An HttpsHealthCheck resource. This resource defines a template for how - * individual instances should be checked for health, via HTTPS. + * An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS. */ export interface Schema$HttpsHealthCheck { /** - * How often (in seconds) to send a health check. The default value is 5 - * seconds. + * How often (in seconds) to send a health check. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -3486,24 +2583,19 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * A so-far unhealthy instance will be marked healthy after this many - * consecutive successes. The default value is 2. + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ healthyThreshold?: number; /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the public IP on behalf of which this health check - * is performed will be used. + * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. */ host?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -3511,23 +2603,15 @@ export namespace compute_v1 { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The TCP port number for the HTTPS health check request. The default value - * is 443. + * The TCP port number for the HTTPS health check request. The default value is 443. */ port?: number; /** - * The request path of the HTTPS health check request. The default value is - * "/". + * The request path of the HTTPS health check request. The default value is "/". */ requestPath?: string; /** @@ -3535,14 +2619,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * How long (in seconds) to wait before claiming failure. The default value - * is 5 seconds. It is invalid for timeoutSec to have a greater value than - * checkIntervalSec. + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. */ timeoutSec?: number; /** - * A so-far healthy instance will be marked unhealthy after this many - * consecutive failures. The default value is 2. + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. */ unhealthyThreshold?: number; } @@ -3563,11 +2644,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3584,13 +2661,11 @@ export namespace compute_v1 { }; } /** - * An Image resource. (== resource_for beta.images ==) (== resource_for - * v1.images ==) + * An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==) */ export interface Schema$Image { /** - * Size of the image tar.gz archive stored in Google Cloud Storage (in - * bytes). + * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ archiveSizeBytes?: string; /** @@ -3602,8 +2677,7 @@ export namespace compute_v1 { */ deprecated?: Schema$DeprecationStatus; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -3611,31 +2685,19 @@ export namespace compute_v1 { */ diskSizeGb?: string; /** - * The name of the image family to which this image belongs. You can create - * disks by specifying an image family instead of a specific image name. The - * image family always returns its latest image that is not deprecated. The - * name of the image family must comply with RFC1035. + * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. */ family?: string; /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Encrypts the image using a customer-supplied encryption key. After you - * encrypt an image with a customer-supplied key, you must provide the same - * key if you use the image later (e.g. to create a disk from the image). - * Customer-supplied encryption keys do not protect access to metadata of - * the disk. If you do not provide an encryption key when creating the - * image, then the disk will be encrypted using an automatically generated - * key and you do not need to provide a key to use the image later. + * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. */ imageEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -3643,23 +2705,15 @@ export namespace compute_v1 { */ kind?: string; /** - * A fingerprint for the labels being applied to this image, which is - * essentially a hash of the labels used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve an image. + * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. */ labelFingerprint?: string; /** - * Labels to apply to this image. These can be later modified by the - * setLabels method. + * Labels to apply to this image. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** - * Integer license codes indicating which licenses are attached to this - * image. + * Integer license codes indicating which licenses are attached to this image. */ licenseCodes?: string[]; /** @@ -3667,13 +2721,7 @@ export namespace compute_v1 { */ licenses?: string[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -3685,71 +2733,47 @@ export namespace compute_v1 { */ selfLink?: string; /** - * URL of the source disk used to create this image. This can be a full or - * valid partial URL. You must provide either this property or the - * rawDisk.source property but not both to create an image. For example, the - * following are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk */ sourceDisk?: string; /** - * The customer-supplied encryption key of the source disk. Required if the - * source disk is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the disk used to create this image. This - * value may be used to determine whether the image was taken from the - * current or a previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. */ sourceDiskId?: string; /** - * URL of the source image used to create this image. This can be a full or - * valid partial URL. You must provide exactly one of: - this property, or - * - the rawDisk.source property, or - the sourceDisk property in order - * to create an image. + * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ sourceImage?: string; /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the image used to create this image. This - * value may be used to determine whether the image was taken from the - * current or a previous instance of a given image name. + * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. */ sourceImageId?: string; /** - * URL of the source snapshot used to create this image. This can be a full - * or valid partial URL. You must provide exactly one of: - this property, - * or - the sourceImage property, or - the rawDisk.source property, or - * - the sourceDisk property in order to create an image. + * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. */ sourceSnapshot?: string; /** - * The customer-supplied encryption key of the source snapshot. Required if - * the source snapshot is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the snapshot used to create this image. - * This value may be used to determine whether the snapshot was taken from - * the current or a previous instance of a given snapshot name. + * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. */ sourceSnapshotId?: string; /** - * The type of the image used to create this disk. The default and only - * value is RAW + * The type of the image used to create this disk. The default and only value is RAW */ sourceType?: string; /** - * [Output Only] The status of the image. An image can be used to create - * other resources, such as instances, only after the image has been - * successfully created and the status is set to READY. Possible values are - * FAILED, PENDING, or READY. + * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ status?: string; } @@ -3770,11 +2794,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3791,15 +2811,11 @@ export namespace compute_v1 { }; } /** - * An Instance resource. (== resource_for beta.instances ==) (== resource_for - * v1.instances ==) + * An Instance resource. (== resource_for beta.instances ==) (== resource_for v1.instances ==) */ export interface Schema$Instance { /** - * Allows this instance to send and receive packets with non-matching - * destination or source IPs. This is required if you plan to use this - * instance to forward routes. For more information, see Enabling IP - * Forwarding. + * Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. */ canIpForward?: boolean; /** @@ -3815,87 +2831,52 @@ export namespace compute_v1 { */ deletionProtection?: boolean; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Array of disks associated with this instance. Persistent disks must be - * created before you can assign them. + * Array of disks associated with this instance. Persistent disks must be created before you can assign them. */ disks?: Schema$AttachedDisk[]; /** - * A list of the type and count of accelerator cards attached to the - * instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators?: Schema$AcceleratorConfig[]; hostname?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#instance for - * instances. + * [Output Only] Type of the resource. Always compute#instance for instances. */ kind?: string; /** - * A fingerprint for this request, which is essentially a hash of the - * label's contents and used for optimistic locking. The fingerprint is - * initially generated by Compute Engine and changes after every request to - * modify or update labels. You must always provide an up-to-date - * fingerprint hash in order to update or change labels. To see the latest - * fingerprint, make get() request to the instance. + * A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. */ labelFingerprint?: string; /** - * Labels to apply to this instance. These can be later modified by the - * setLabels method. + * Labels to apply to this instance. These can be later modified by the setLabels method. */ labels?: {[key: string]: string}; /** - * Full or partial URL of the machine type resource to use for this - * instance, in the format: zones/zone/machineTypes/machine-type. This is - * provided by the client when the instance is created. For example, the - * following is a valid partial url to a predefined machine type: - * zones/us-central1-f/machineTypes/n1-standard-1 To create a custom - * machine type, provide a URL to a machine type in the following format, - * where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and - * MEMORY is the total memory for this instance. Memory must be a multiple - * of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): - * zones/zone/machineTypes/custom-CPUS-MEMORY For example: - * zones/us-central1-f/machineTypes/custom-4-5120 For a full list of - * restrictions, read the Specifications for custom machine types. + * Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. */ machineType?: string; /** - * The metadata key/value pairs assigned to this instance. This includes - * custom metadata and predefined keys. + * The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. */ metadata?: Schema$Metadata; /** - * Specifies a minimum CPU platform for the VM instance. Applicable values - * are the friendly names of CPU platforms, such as minCpuPlatform: - * "Intel Haswell" or minCpuPlatform: "Intel Sandy - * Bridge". + * Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". */ minCpuPlatform?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * An array of network configurations for this instance. These specify how - * interfaces are configured to interact with other network services, such - * as connecting to the internet. Multiple interfaces are supported per - * instance. + * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. */ networkInterfaces?: Schema$NetworkInterface[]; /** @@ -3907,24 +2888,17 @@ export namespace compute_v1 { */ selfLink?: string; /** - * A list of service accounts, with their specified scopes, authorized for - * this instance. Only one service account per VM instance is supported. - * Service accounts generate access tokens that can be accessed through the - * metadata server and used to authenticate applications on the instance. - * See Service Accounts for more information. + * A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. */ serviceAccounts?: Schema$ServiceAccount[]; shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; shieldedInstanceIntegrityPolicy?: Schema$ShieldedInstanceIntegrityPolicy; /** - * [Output Only] Whether a VM has been restricted for start because Compute - * Engine has detected suspicious activity. + * [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. */ startRestricted?: boolean; /** - * [Output Only] The status of the instance. One of the following values: - * PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, - * and TERMINATED. + * [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. */ status?: string; /** @@ -3932,17 +2906,11 @@ export namespace compute_v1 { */ statusMessage?: string; /** - * Tags to apply to this instance. Tags are used to identify valid sources - * or targets for network firewalls and are specified by the client during - * instance creation. The tags can be later modified by the setTags method. - * Each tag within the list must comply with RFC1035. Multiple tags can be - * specified via the 'tags.items' field. + * Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. */ tags?: Schema$Tags; /** - * [Output Only] URL of the zone where the instance resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -3956,16 +2924,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$InstancesScopedList}; /** - * [Output Only] Type of resource. Always compute#instanceAggregatedList for - * aggregated lists of Instance resources. + * [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -3982,63 +2945,47 @@ export namespace compute_v1 { }; } /** - * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for - * v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== - * resource_for v1.regionInstanceGroups ==) + * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** - * [Output Only] The creation timestamp for this instance group in RFC3339 - * text format. + * [Output Only] The creation timestamp for this instance group in RFC3339 text format. */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The fingerprint of the named ports. The system uses this - * fingerprint to detect conflicts when multiple users change the named - * ports concurrently. + * [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. */ fingerprint?: string; /** - * [Output Only] A unique identifier for this instance group, generated by - * the server. + * [Output Only] A unique identifier for this instance group, generated by the server. */ id?: string; /** - * [Output Only] The resource type, which is always compute#instanceGroup - * for instance groups. + * [Output Only] The resource type, which is always compute#instanceGroup for instance groups. */ kind?: string; /** - * The name of the instance group. The name must be 1-63 characters long, - * and comply with RFC1035. + * The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** - * Assigns a name to a port number. For example: {name: "http", - * port: 80} This allows the system to reference ports by the assigned name - * instead of a port number. Named ports can also contain multiple ports. - * For example: [{name: "http", port: 80},{name: "http", - * port: 8080}] Named ports apply to all instances in this instance group. + * Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. */ namedPorts?: Schema$NamedPort[]; /** - * The URL of the network to which all instances in the instance group - * belong. + * The URL of the network to which all instances in the instance group belong. */ network?: string; /** - * [Output Only] The URL of the region where the instance group is located - * (for regional resources). + * [Output Only] The URL of the region where the instance group is located (for regional resources). */ region?: string; /** - * [Output Only] The URL for this instance group. The server generates this - * URL. + * [Output Only] The URL for this instance group. The server generates this URL. */ selfLink?: string; /** @@ -4046,13 +2993,11 @@ export namespace compute_v1 { */ size?: number; /** - * [Output Only] The URL of the subnetwork to which all instances in the - * instance group belong. + * [Output Only] The URL of the subnetwork to which all instances in the instance group belong. */ subnetwork?: string; /** - * [Output Only] The URL of the zone where the instance group is located - * (for zonal resources). + * [Output Only] The URL of the zone where the instance group is located (for zonal resources). */ zone?: string; } @@ -4066,17 +3011,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$InstanceGroupsScopedList}; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupAggregatedList for aggregated lists of instance - * groups. + * [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4105,16 +3044,11 @@ export namespace compute_v1 { */ items?: Schema$InstanceGroup[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupList for instance group lists. + * [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4131,56 +3065,39 @@ export namespace compute_v1 { }; } /** - * An Instance Group Manager resource. (== resource_for - * beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers - * ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for - * v1.regionInstanceGroupManagers ==) + * An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** - * The autohealing policy for this managed instance group. You can specify - * only one value. + * The autohealing policy for this managed instance group. You can specify only one value. */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must - * be 1-58 characters long. Instances are named by appending a hyphen and a - * random four-character string to the base instance name. The base instance - * name must comply with RFC1035. + * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. */ baseInstanceName?: string; /** - * [Output Only] The creation timestamp for this managed instance group in - * RFC3339 text format. + * [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. */ creationTimestamp?: string; /** - * [Output Only] The list of instance actions and the number of instances in - * this managed instance group that are scheduled for each of those actions. + * [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. */ currentActions?: Schema$InstanceGroupManagerActionsSummary; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Policy specifying intended distribution of instances in regional managed - * instance group. + * Policy specifying intended distribution of instances in regional managed instance group. */ distributionPolicy?: Schema$DistributionPolicy; /** - * Fingerprint of this resource. This field may be used in optimistic - * locking. It will be ignored when inserting an InstanceGroupManager. An - * up-to-date fingerprint must be provided in order to update the - * InstanceGroupManager, otherwise the request will fail with error 412 - * conditionNotMet. To see the latest fingerprint, make a get() request to - * retrieve an InstanceGroupManager. + * Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. */ fingerprint?: string; /** - * [Output Only] A unique identifier for this resource type. The server - * generates this identifier. + * [Output Only] A unique identifier for this resource type. The server generates this identifier. */ id?: string; /** @@ -4188,34 +3105,27 @@ export namespace compute_v1 { */ instanceGroup?: string; /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create all new instances - * in the managed instance group. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ instanceTemplate?: string; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManager for managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. */ kind?: string; /** - * The name of the managed instance group. The name must be 1-63 characters - * long, and comply with RFC1035. + * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** - * Named ports configured for the Instance Groups complementary to this - * Instance Group Manager. + * Named ports configured for the Instance Groups complementary to this Instance Group Manager. */ namedPorts?: Schema$NamedPort[]; /** - * [Output Only] The URL of the region where the managed instance group - * resides (for regional resources). + * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ region?: string; /** - * [Output Only] The URL for this managed instance group. The server defines - * this URL. + * [Output Only] The URL for this managed instance group. The server defines this URL. */ selfLink?: string; /** @@ -4223,15 +3133,11 @@ export namespace compute_v1 { */ status?: Schema$InstanceGroupManagerStatus; /** - * The URLs for all TargetPool resources to which instances in the - * instanceGroup field are added. The target pools automatically apply to - * all of the instances in the managed instance group. + * The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ targetPools?: string[]; /** - * The target number of running instances for this managed instance group. - * Deleting or abandoning instances reduces this number. Resizing the group - * changes this number. + * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. */ targetSize?: number; /** @@ -4239,78 +3145,49 @@ export namespace compute_v1 { */ updatePolicy?: Schema$InstanceGroupManagerUpdatePolicy; /** - * Specifies the instance templates used by this managed instance group to - * create instances. Each version is defined by an instanceTemplate and a - * name. Every version can appear at most once per instance group. This - * field overrides the top-level instanceTemplate field. Read more about the - * relationships between these fields. Exactly one version must leave the - * targetSize field unset. That version will be applied to all remaining - * instances. For more information, read about canary updates. + * Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. */ versions?: Schema$InstanceGroupManagerVersion[]; /** - * [Output Only] The URL of the zone where the managed instance group is - * located (for zonal resources). + * [Output Only] The URL of the zone where the managed instance group is located (for zonal resources). */ zone?: string; } export interface Schema$InstanceGroupManagerActionsSummary { /** - * [Output Only] The total number of instances in the managed instance group - * that are scheduled to be abandoned. Abandoning an instance removes it - * from the managed instance group without deleting it. + * [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. */ abandoning?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be created or are currently being created. If the group - * fails to create any of these instances, it tries again until it creates - * the instance successfully. If you have disabled creation retries, this - * field will not be populated; instead, the creatingWithoutRetries field - * will be populated. + * [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. */ creating?: number; /** - * [Output Only] The number of instances that the managed instance group - * will attempt to create. The group attempts to create each instance only - * once. If the group fails to create any of these instances, it decreases - * the group's targetSize value accordingly. + * [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. */ creatingWithoutRetries?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be deleted or are currently being deleted. + * [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. */ deleting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are running and have no scheduled actions. + * [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. */ none?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be recreated or are currently being being recreated. - * Recreating an instance deletes the existing root persistent disk and - * creates a new disk from the image that is defined in the instance - * template. + * [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. */ recreating?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are being reconfigured with properties that do not require a restart or a - * recreate action. For example, setting or removing target pools for the - * instance. + * [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. */ refreshing?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are scheduled to be restarted or are currently being restarted. + * [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. */ restarting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are being verified. See the managedInstances[].currentAction property in - * the listManagedInstances method documentation. + * [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation. */ verifying?: number; } @@ -4324,17 +3201,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$InstanceGroupManagersScopedList}; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerAggregatedList for an aggregated list of - * managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4356,12 +3227,7 @@ export namespace compute_v1 { */ healthCheck?: string; /** - * The number of seconds that the managed instance group waits before it - * applies autohealing policies to new instances or recently recreated - * instances. This initial delay allows instances to initialize and run - * their startup scripts before the instance group determines that they are - * UNHEALTHY. This prevents the managed instance group from recreating its - * instances prematurely. This value must be from range [0, 3600]. + * The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600]. */ initialDelaySec?: number; } @@ -4378,16 +3244,11 @@ export namespace compute_v1 { */ items?: Schema$InstanceGroupManager[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerList for a list of managed instance groups. + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4405,15 +3266,13 @@ export namespace compute_v1 { } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** - * The URLs of one or more instances to abandon. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } export interface Schema$InstanceGroupManagersDeleteInstancesRequest { /** - * The URLs of one or more instances to delete. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -4425,20 +3284,17 @@ export namespace compute_v1 { } export interface Schema$InstanceGroupManagersRecreateInstancesRequest { /** - * The URLs of one or more instances to recreate. This can be a full URL or - * a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } export interface Schema$InstanceGroupManagersScopedList { /** - * [Output Only] The list of managed instance groups that are contained in - * the specified project and zone. + * [Output Only] The list of managed instance groups that are contained in the specified project and zone. */ instanceGroupManagers?: Schema$InstanceGroupManager[]; /** - * [Output Only] The warning that replaces the list of managed instance - * groups when the list is empty. + * [Output Only] The warning that replaces the list of managed instance groups when the list is empty. */ warning?: { code?: string; @@ -4448,101 +3304,52 @@ export namespace compute_v1 { } export interface Schema$InstanceGroupManagersSetInstanceTemplateRequest { /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create all new instances - * in the managed instance group. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. */ instanceTemplate?: string; } export interface Schema$InstanceGroupManagersSetTargetPoolsRequest { /** - * The fingerprint of the target pools information. Use this optional - * property to prevent conflicts when multiple users change the target pools - * settings concurrently. Obtain the fingerprint with the - * instanceGroupManagers.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. + * The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ fingerprint?: string; /** - * The list of target pool URLs that instances in this managed instance - * group belong to. The managed instance group applies these target pools to - * all of the instances in the group. Existing instances and new instances - * in the group all receive these target pool settings. + * The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings. */ targetPools?: string[]; } export interface Schema$InstanceGroupManagerStatus { /** - * [Output Only] A bit indicating whether the managed instance group is in a - * stable state. A stable state means that: none of the instances in the - * managed instance group is currently undergoing any type of change (for - * example, creation, restart, or deletion); no future changes are scheduled - * for instances in the managed instance group; and the managed instance - * group itself is not being modified. + * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ isStable?: boolean; } export interface Schema$InstanceGroupManagerUpdatePolicy { /** - * The maximum number of instances that can be created above the specified - * targetSize during the update process. By default, a fixed value of 1 is - * used. This value can be either a fixed number or a percentage if the - * instance group has 10 or more instances. If you set a percentage, the - * number of instances will be rounded up if necessary. At least one of - * either maxSurge or maxUnavailable must be greater than 0. Learn more - * about maxSurge. + * The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. */ maxSurge?: Schema$FixedOrPercent; /** - * The maximum number of instances that can be unavailable during the update - * process. An instance is considered available if all of the following - * conditions are satisfied: - The instance's status is RUNNING. - - * If there is a health check on the instance group, the instance's - * liveness health check result must be HEALTHY at least once. If there is - * no health check on the group, then the instance only needs to have a - * status of RUNNING to be considered available. By default, a fixed value - * of 1 is used. This value can be either a fixed number or a percentage if - * the instance group has 10 or more instances. If you set a percentage, the - * number of instances will be rounded up if necessary. At least one of - * either maxSurge or maxUnavailable must be greater than 0. Learn more - * about maxUnavailable. + * The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. */ maxUnavailable?: Schema$FixedOrPercent; /** - * Minimal action to be taken on an instance. You can specify either RESTART - * to restart existing instances or REPLACE to delete and create new - * instances from the target template. If you specify a RESTART, the Updater - * will attempt to perform that action only. However, if the Updater - * determines that the minimal action you specify is not enough to perform - * the update, it might perform a more disruptive action. + * Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. */ minimalAction?: string; type?: string; } export interface Schema$InstanceGroupManagerVersion { /** - * The URL of the instance template that is specified for this managed - * instance group. The group uses this template to create new instances in - * the managed instance group until the `targetSize` for this version is - * reached. + * The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. */ instanceTemplate?: string; /** - * Name of the version. Unique among all versions in the scope of this - * managed instance group. + * Name of the version. Unique among all versions in the scope of this managed instance group. */ name?: string; /** - * Specifies the intended number of instances to be created from the - * instanceTemplate. The final number of instances created from the template - * will be equal to: - If expressed as a fixed number, the minimum of - * either targetSize.fixed or instanceGroupManager.targetSize is used. - if - * expressed as a percent, the targetSize would be (targetSize.percent/100 * - * InstanceGroupManager.targetSize) If there is a remainder, the number is - * rounded up. If unset, this version will update any remaining instances - * not updated by another version. Read Starting a canary update for more - * information. + * Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. */ targetSize?: Schema$FixedOrPercent; } @@ -4562,17 +3369,11 @@ export namespace compute_v1 { */ items?: Schema$InstanceWithNamedPorts[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupsListInstances for the list of instances in the - * specified instance group. + * [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4590,9 +3391,7 @@ export namespace compute_v1 { } export interface Schema$InstanceGroupsListInstancesRequest { /** - * A filter for the state of the instances in the instance group. Valid - * options are ALL or RUNNING. If you do not specify this parameter the list - * includes all instances regardless of their state. + * A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. */ instanceState?: string; } @@ -4604,13 +3403,11 @@ export namespace compute_v1 { } export interface Schema$InstanceGroupsScopedList { /** - * [Output Only] The list of instance groups that are contained in this - * scope. + * [Output Only] The list of instance groups that are contained in this scope. */ instanceGroups?: Schema$InstanceGroup[]; /** - * [Output Only] An informational warning that replaces the list of instance - * groups when the list is empty. + * [Output Only] An informational warning that replaces the list of instance groups when the list is empty. */ warning?: { code?: string; @@ -4620,13 +3417,7 @@ export namespace compute_v1 { } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** - * The fingerprint of the named ports information for this instance group. - * Use this optional property to prevent conflicts when multiple users - * change the named ports settings concurrently. Obtain the fingerprint with - * the instanceGroups.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. A request with an incorrect fingerprint - * will fail with error 412 conditionNotMet. + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet. */ fingerprint?: string; /** @@ -4647,16 +3438,11 @@ export namespace compute_v1 { */ items?: Schema$Instance[]; /** - * [Output Only] Type of resource. Always compute#instanceList for lists of - * Instance resources. + * [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4685,16 +3471,11 @@ export namespace compute_v1 { */ items?: Schema$Reference[]; /** - * [Output Only] Type of resource. Always compute#instanceListReferrers for - * lists of Instance referrers. + * [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4712,44 +3493,29 @@ export namespace compute_v1 { } export interface Schema$InstanceMoveRequest { /** - * The URL of the destination zone to move the instance. This can be a full - * or partial URL. For example, the following are all valid URLs to a zone: - * - https://www.googleapis.com/compute/v1/projects/project/zones/zone - - * projects/project/zones/zone - zones/zone + * The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone */ destinationZone?: string; /** - * The URL of the target instance to move. This can be a full or partial - * URL. For example, the following are all valid URLs to an instance: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance - - * zones/zone/instances/instance + * The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ targetInstance?: string; } export interface Schema$InstanceProperties { /** - * Enables instances created based on this template to send packets with - * source IP addresses other than their own and receive packets with - * destination IP addresses other than their own. If these instances will be - * used as an IP gateway or it will be set as the next-hop in a Route - * resource, specify true. If unsure, leave this set to false. See the - * Enable IP forwarding documentation for more information. + * Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. */ canIpForward?: boolean; /** - * An optional text description for the instances that are created from this - * instance template. + * An optional text description for the instances that are created from this instance template. */ description?: string; /** - * An array of disks that are associated with the instances that are created - * from this template. + * An array of disks that are associated with the instances that are created from this template. */ disks?: Schema$AttachedDisk[]; /** - * A list of guest accelerator cards' type and count to use for - * instances created from the instance template. + * A list of guest accelerator cards' type and count to use for instances created from the instance template. */ guestAccelerators?: Schema$AcceleratorConfig[]; /** @@ -4757,22 +3523,15 @@ export namespace compute_v1 { */ labels?: {[key: string]: string}; /** - * The machine type to use for instances that are created from this - * template. + * The machine type to use for instances that are created from this template. */ machineType?: string; /** - * The metadata key/value pairs to assign to instances that are created from - * this template. These pairs can consist of custom metadata or predefined - * keys. See Project and instance metadata for more information. + * The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. */ metadata?: Schema$Metadata; /** - * Minimum cpu/platform to be used by this instance. The instance may be - * scheduled on the specified or newer cpu/platform. Applicable values are - * the friendly names of CPU platforms, such as minCpuPlatform: "Intel - * Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more - * information, read Specifying a Minimum CPU Platform. + * Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. */ minCpuPlatform?: string; /** @@ -4780,23 +3539,16 @@ export namespace compute_v1 { */ networkInterfaces?: Schema$NetworkInterface[]; /** - * Specifies the scheduling options for the instances that are created from - * this template. + * Specifies the scheduling options for the instances that are created from this template. */ scheduling?: Schema$Scheduling; /** - * A list of service accounts with specified scopes. Access tokens for these - * service accounts are available to the instances that are created from - * this template. Use metadata queries to obtain the access tokens for these - * instances. + * A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. */ serviceAccounts?: Schema$ServiceAccount[]; shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; /** - * A list of tags to apply to the instances that are created from this - * template. The tags identify valid sources or targets for network - * firewalls. The setTags method can modify this list of tags. Each tag - * within the list must comply with RFC1035. + * A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. */ tags?: Schema$Tags; } @@ -4812,8 +3564,7 @@ export namespace compute_v1 { */ instances?: Schema$Instance[]; /** - * [Output Only] Informational warning which replaces the list of instances - * when the list is empty. + * [Output Only] Informational warning which replaces the list of instances when the list is empty. */ warning?: { code?: string; @@ -4823,25 +3574,20 @@ export namespace compute_v1 { } export interface Schema$InstancesSetLabelsRequest { /** - * Fingerprint of the previous set of labels for this resource, used to - * prevent conflicts. Provide the latest fingerprint value when making a - * request to add or change labels. + * Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels. */ labelFingerprint?: string; labels?: {[key: string]: string}; } export interface Schema$InstancesSetMachineResourcesRequest { /** - * A list of the type and count of accelerator cards attached to the - * instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators?: Schema$AcceleratorConfig[]; } export interface Schema$InstancesSetMachineTypeRequest { /** - * Full or partial URL of the machine type resource. See Machine Types for a - * full list of machine types. For example: - * zones/us-central1-f/machineTypes/n1-standard-1 + * Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1 */ machineType?: string; } @@ -4863,47 +3609,32 @@ export namespace compute_v1 { } export interface Schema$InstancesStartWithEncryptionKeyRequest { /** - * Array of disks associated with this instance that are protected with a - * customer-supplied encryption key. In order to start the instance, the - * disk url and its corresponding key must be provided. If the disk is not - * protected with a customer-supplied encryption key it should not be - * specified. + * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. */ disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * An Instance Template resource. (== resource_for beta.instanceTemplates ==) - * (== resource_for v1.instanceTemplates ==) + * An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** - * [Output Only] The creation timestamp for this instance template in - * RFC3339 text format. + * [Output Only] The creation timestamp for this instance template in RFC3339 text format. */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] A unique identifier for this instance template. The server - * defines this identifier. + * [Output Only] A unique identifier for this instance template. The server defines this identifier. */ id?: string; /** - * [Output Only] The resource type, which is always compute#instanceTemplate - * for instance templates. + * [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. */ kind?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -4911,16 +3642,11 @@ export namespace compute_v1 { */ properties?: Schema$InstanceProperties; /** - * [Output Only] The URL for this instance template. The server defines this - * URL. + * [Output Only] The URL for this instance template. The server defines this URL. */ selfLink?: string; /** - * The source instance used to create the template. You can provide this as - * a partial or full URL to the resource. For example, the following are - * valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance + * The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance */ sourceInstance?: string; /** @@ -4941,16 +3667,11 @@ export namespace compute_v1 { */ items?: Schema$InstanceTemplate[]; /** - * [Output Only] The resource type, which is always - * compute#instanceTemplatesListResponse for instance template lists. + * [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -4981,22 +3702,15 @@ export namespace compute_v1 { status?: string; } /** - * Represents an Interconnects resource. The Interconnects resource is a - * dedicated connection between Google's network and your on-premises - * network. For more information, see the Dedicated overview page. (== - * resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) */ export interface Schema$Interconnect { /** - * Administrative status of the interconnect. When this is set to true, the - * Interconnect is functional and can carry traffic. When set to false, no - * packets can be carried over the interconnect and no BGP routes are - * exchanged over it. By default, the status is set to true. + * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. */ adminEnabled?: boolean; /** - * [Output Only] A list of CircuitInfo objects, that describe the individual - * circuits in this LAG. + * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. */ circuitInfos?: Schema$InterconnectCircuitInfo[]; /** @@ -5004,13 +3718,11 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * Customer name, to put in the Letter of Authorization as the party - * authorized to request a crossconnect. + * Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. */ customerName?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -5018,71 +3730,51 @@ export namespace compute_v1 { */ expectedOutages?: Schema$InterconnectOutageNotification[]; /** - * [Output Only] IP address configured on the Google side of the - * Interconnect link. This can be used only for ping tests. + * [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. */ googleIpAddress?: string; /** - * [Output Only] Google reference ID to be used when raising support tickets - * with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ googleReferenceId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] A list of the URLs of all InterconnectAttachments - * configured to use this Interconnect. + * [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. */ interconnectAttachments?: string[]; /** - * Type of interconnect. Note that "IT_PRIVATE" has been - * deprecated in favor of "DEDICATED" + * Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED" */ interconnectType?: string; /** - * [Output Only] Type of the resource. Always compute#interconnect for - * interconnects. + * [Output Only] Type of the resource. Always compute#interconnect for interconnects. */ kind?: string; /** - * Type of link requested. This field indicates speed of each of the links - * in the bundle, not the entire bundle. + * Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. */ linkType?: string; /** - * URL of the InterconnectLocation object that represents where this - * connection is to be provisioned. + * URL of the InterconnectLocation object that represents where this connection is to be provisioned. */ location?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Email address to contact the customer NOC for operations and maintenance - * notifications regarding this Interconnect. If specified, this will be - * used for notifications in addition to all other forms described, such as - * Stackdriver logs alerting and Cloud Notifications. + * Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. */ nocContactEmail?: string; /** - * [Output Only] The current status of whether or not this Interconnect is - * functional. + * [Output Only] The current status of whether or not this Interconnect is functional. */ operationalStatus?: string; /** - * [Output Only] IP address configured on the customer side of the - * Interconnect link. The customer should configure this IP address during - * turnup when prompted by Google NOC. This can be used only for ping tests. + * [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. */ peerIpAddress?: string; /** @@ -5090,8 +3782,7 @@ export namespace compute_v1 { */ provisionedLinkCount?: number; /** - * Target number of physical links in the link bundle, as requested by the - * customer. + * Target number of physical links in the link bundle, as requested by the customer. */ requestedLinkCount?: number; /** @@ -5099,42 +3790,28 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The current state of whether or not this Interconnect is - * functional. + * [Output Only] The current state of whether or not this Interconnect is functional. */ state?: string; } /** - * Represents an InterconnectAttachment (VLAN attachment) resource. For more - * information, see Creating VLAN Attachments. (== resource_for - * beta.interconnectAttachments ==) (== resource_for - * v1.interconnectAttachments ==) + * Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** - * Determines whether this Attachment will carry packets. Not present for - * PARTNER_PROVIDER. + * Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. */ adminEnabled?: boolean; /** - * Provisioned bandwidth capacity for the interconnectAttachment. Can be set - * by the partner to update the customer's provisioned bandwidth. Output - * only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. + * Provisioned bandwidth capacity for the interconnectAttachment. Can be set by the partner to update the customer's provisioned bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. */ bandwidth?: string; /** - * Up to 16 candidate prefixes that can be used to restrict the allocation - * of cloudRouterIpAddress and customerRouterIpAddress for this attachment. - * All prefixes must be within link-local address space (169.254.0.0/16) and - * must be /29 or shorter (/28, /27, etc). Google will attempt to select an - * unused /29 from the supplied candidate prefix(es). The request will fail - * if all possible /29s are in use on Google?s edge. If not supplied, Google - * will randomly select an unused /29 from all of link-local space. + * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ candidateSubnets?: string[]; /** - * [Output Only] IPv4 address + prefix length to be configured on Cloud - * Router Interface for this interconnect attachment. + * [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. */ cloudRouterIpAddress?: string; /** @@ -5142,8 +3819,7 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * [Output Only] IPv4 address + prefix length to be configured on the - * customer router subinterface for this interconnect attachment. + * [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. */ customerRouterIpAddress?: string; /** @@ -5151,87 +3827,55 @@ export namespace compute_v1 { */ description?: string; /** - * Desired availability domain for the attachment. Only available for type - * PARTNER, at creation time. For improved reliability, customers should - * configure a pair of attachments with one per availability domain. The - * selected availability domain will be provided to the Partner via the - * pairing key so that the provisioned circuit will lie in the specified - * domain. If not specified, the value will default to - * AVAILABILITY_DOMAIN_ANY. + * Desired availability domain for the attachment. Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with one per availability domain. The selected availability domain will be provided to the Partner via the pairing key so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ edgeAvailabilityDomain?: string; /** - * [Output Only] Google reference ID, to be used when raising support - * tickets with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. */ googleReferenceId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * URL of the underlying Interconnect object that this attachment's - * traffic will traverse through. + * URL of the underlying Interconnect object that this attachment's traffic will traverse through. */ interconnect?: string; /** - * [Output Only] Type of the resource. Always compute#interconnectAttachment - * for interconnect attachments. + * [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * [Output Only] The current status of whether or not this interconnect - * attachment is functional. + * [Output Only] The current status of whether or not this interconnect attachment is functional. */ operationalStatus?: string; /** - * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not - * present for DEDICATED]. The opaque identifier of an PARTNER attachment - * used to initiate provisioning with a selected partner. Of the form - * "XXXXX/region/domain" + * [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" */ pairingKey?: string; /** - * Optional BGP ASN for the router that should be supplied by a layer 3 - * Partner if they configured BGP on behalf of the customer. Output only for - * PARTNER type, input only for PARTNER_PROVIDER, not available for - * DEDICATED. + * Optional BGP ASN for the router that should be supplied by a layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ partnerAsn?: string; /** - * Informational metadata about Partner attachments from Partners to display - * to customers. Output only for for PARTNER type, mutable for - * PARTNER_PROVIDER, not available for DEDICATED. + * Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. */ partnerMetadata?: Schema$InterconnectAttachmentPartnerMetadata; /** - * [Output Only] Information specific to an InterconnectAttachment. This - * property is populated if the interconnect that this is attached to is of - * type DEDICATED. + * [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED. */ privateInterconnectInfo?: Schema$InterconnectAttachmentPrivateInfo; /** - * [Output Only] URL of the region where the regional interconnect - * attachment resides. You must specify this field as part of the HTTP - * request URL. It is not settable as a field in the request body. + * [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * URL of the Cloud Router to be used for dynamic routing. This router must - * be in the same region as this InterconnectAttachment. The - * InterconnectAttachment will automatically connect the Interconnect to the - * network & region within which the Cloud Router is configured. + * URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. */ router?: string; /** @@ -5244,8 +3888,7 @@ export namespace compute_v1 { state?: string; type?: string; /** - * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only - * specified at creation time. + * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. */ vlanTag8021q?: number; } @@ -5259,17 +3902,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$InterconnectAttachmentsScopedList}; /** - * [Output Only] Type of resource. Always - * compute#interconnectAttachmentAggregatedList for aggregated lists of - * interconnect attachments. + * [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5286,8 +3923,7 @@ export namespace compute_v1 { }; } /** - * Response to the list request, and contains a list of interconnect - * attachments. + * Response to the list request, and contains a list of interconnect attachments. */ export interface Schema$InterconnectAttachmentList { /** @@ -5299,16 +3935,11 @@ export namespace compute_v1 { */ items?: Schema$InterconnectAttachment[]; /** - * [Output Only] Type of resource. Always compute#interconnectAttachmentList - * for lists of interconnect attachments. + * [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5325,37 +3956,28 @@ export namespace compute_v1 { }; } /** - * Informational metadata about Partner attachments from Partners to display - * to customers. These fields are propagated from PARTNER_PROVIDER attachments - * to their corresponding PARTNER attachments. + * Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. */ export interface Schema$InterconnectAttachmentPartnerMetadata { /** - * Plain text name of the Interconnect this attachment is connected to, as - * displayed in the Partner?s portal. For instance "Chicago 1". - * This value may be validated to match approved Partner values. + * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ interconnectName?: string; /** - * Plain text name of the Partner providing this attachment. This value may - * be validated to match approved Partner values. + * Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values. */ partnerName?: string; /** - * URL of the Partner?s portal for this Attachment. Partners may customise - * this to be a deep-link to the specific resource on the Partner portal. - * This value may be validated to match approved Partner values. + * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep-link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string; } /** - * Information for an interconnect attachment when this belongs to an - * interconnect of type DEDICATED. + * Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. */ export interface Schema$InterconnectAttachmentPrivateInfo { /** - * [Output Only] 802.1q encapsulation tag to be used for traffic between - * Google and the customer, going to and from this network and region. + * [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region. */ tag8021q?: number; } @@ -5365,8 +3987,7 @@ export namespace compute_v1 { */ interconnectAttachments?: Schema$InterconnectAttachment[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -5375,9 +3996,7 @@ export namespace compute_v1 { }; } /** - * Describes a single physical circuit between the Customer and Google. - * CircuitInfo objects are created by Google, so all fields are output only. - * Next id: 4 + * Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 */ export interface Schema$InterconnectCircuitInfo { /** @@ -5389,25 +4008,20 @@ export namespace compute_v1 { */ googleCircuitId?: string; /** - * Google-side demarc ID for this circuit. Assigned at circuit turn-up and - * provided by Google to the customer in the LOA. + * Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. */ googleDemarcId?: string; } /** - * Diagnostics information about interconnect, contains detailed and current - * technical information about Google?s side of the connection. + * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. */ export interface Schema$InterconnectDiagnostics { /** - * A list of InterconnectDiagnostics.ARPEntry objects, describing individual - * neighbors currently seen by the Google router in the ARP cache for the - * Interconnect. This will be empty when the Interconnect is not bundled. + * A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled. */ arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; /** - * A list of InterconnectDiagnostics.LinkStatus objects, describing the - * status for each link on the Interconnect. + * A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect. */ links?: Schema$InterconnectDiagnosticsLinkStatus[]; /** @@ -5441,28 +4055,17 @@ export namespace compute_v1 { } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { /** - * The status of the current value when compared to the warning and alarm - * levels for the receiving or transmitting transceiver. Possible states - * include: - OK: The value has not crossed a warning threshold. - - * LOW_WARNING: The value has crossed below the low warning threshold. - - * HIGH_WARNING: The value has crossed above the high warning threshold. - - * LOW_ALARM: The value has crossed below the low alarm threshold. - - * HIGH_ALARM: The value has crossed above the high alarm threshold. + * The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. */ state?: string; /** - * Value of the current receiving or transmitting optical power, read in - * dBm. Take a known good optical value, give it a 10% margin and trigger - * warnings relative to that value. In general, a -7dBm warning and a -11dBm - * alarm are good optical value estimates for most links. + * Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. */ value?: number; } export interface Schema$InterconnectDiagnosticsLinkStatus { /** - * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP - * neighbor entries seen on this link. This will be empty if the link is - * bundled + * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled */ arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; /** @@ -5475,13 +4078,11 @@ export namespace compute_v1 { googleDemarc?: string; lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; /** - * An InterconnectDiagnostics.LinkOpticalPower object, describing the - * current value and status of the received light level. + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. */ receivingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; /** - * An InterconnectDiagnostics.LinkOpticalPower object, describing the - * current value and status of the transmitted light level. + * An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level. */ transmittingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; } @@ -5498,16 +4099,11 @@ export namespace compute_v1 { */ items?: Schema$Interconnect[]; /** - * [Output Only] Type of resource. Always compute#interconnectList for lists - * of interconnects. + * [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5524,27 +4120,19 @@ export namespace compute_v1 { }; } /** - * Represents an InterconnectLocations resource. The InterconnectLocations - * resource describes the locations where you can connect to Google's - * networks. For more information, see Colocation Facilities. + * Represents an InterconnectLocations resource. The InterconnectLocations resource describes the locations where you can connect to Google's networks. For more information, see Colocation Facilities. */ export interface Schema$InterconnectLocation { /** - * [Output Only] The postal address of the Point of Presence, each line in - * the address is separated by a newline character. + * [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. */ address?: string; /** - * [Output Only] Availability zone for this InterconnectLocation. Within a - * metropolitan area (metro), maintenance will not be simultaneously - * scheduled in more than one availability zone. Example: "zone1" - * or "zone2". + * [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". */ availabilityZone?: string; /** - * [Output Only] Metropolitan area designator that indicates which city an - * interconnect is located. For example: "Chicago, IL", - * "Amsterdam, Netherlands". + * [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". */ city?: string; /** @@ -5564,18 +4152,15 @@ export namespace compute_v1 { */ facilityProvider?: string; /** - * [Output Only] A provider-assigned Identifier for this facility (e.g., - * Ashburn-DC1). + * [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). */ facilityProviderFacilityId?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#interconnectLocation - * for interconnect locations. + * [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. */ kind?: string; /** @@ -5583,14 +4168,11 @@ export namespace compute_v1 { */ name?: string; /** - * [Output Only] The peeringdb identifier for this facility (corresponding - * with a netfac type in peeringdb). + * [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). */ peeringdbFacilityId?: string; /** - * [Output Only] A list of InterconnectLocation.RegionInfo objects, that - * describe parameters pertaining to the relation between this - * InterconnectLocation and various Google Cloud regions. + * [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. */ regionInfos?: Schema$InterconnectLocationRegionInfo[]; /** @@ -5598,15 +4180,12 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The status of this InterconnectLocation. If the status is - * AVAILABLE, new Interconnects may be provisioned in this - * InterconnectLocation. Otherwise, no new Interconnects may be provisioned. + * [Output Only] The status of this InterconnectLocation. If the status is AVAILABLE, new Interconnects may be provisioned in this InterconnectLocation. Otherwise, no new Interconnects may be provisioned. */ status?: string; } /** - * Response to the list request, and contains a list of interconnect - * locations. + * Response to the list request, and contains a list of interconnect locations. */ export interface Schema$InterconnectLocationList { /** @@ -5618,16 +4197,11 @@ export namespace compute_v1 { */ items?: Schema$InterconnectLocation[]; /** - * [Output Only] Type of resource. Always compute#interconnectLocationList - * for lists of interconnect locations. + * [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5644,14 +4218,11 @@ export namespace compute_v1 { }; } /** - * Information about any potential InterconnectAttachments between an - * Interconnect at a specific InterconnectLocation, and a specific Cloud - * Region. + * Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. */ export interface Schema$InterconnectLocationRegionInfo { /** - * Expected round-trip time in milliseconds, from this InterconnectLocation - * to a VM in this region. + * Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. */ expectedRttMs?: string; /** @@ -5668,8 +4239,7 @@ export namespace compute_v1 { */ export interface Schema$InterconnectOutageNotification { /** - * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs - * that will be affected. + * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. */ affectedCircuits?: string[]; /** @@ -5681,9 +4251,7 @@ export namespace compute_v1 { */ endTime?: string; /** - * Form this outage is expected to take. Note that the "IT_" - * versions of this enum have been deprecated in favor of the unprefixed - * values. + * Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values. */ issueType?: string; /** @@ -5691,9 +4259,7 @@ export namespace compute_v1 { */ name?: string; /** - * The party that generated this notification. Note that - * "NSRC_GOOGLE" has been deprecated in favor of - * "GOOGLE" + * The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE" */ source?: string; /** @@ -5701,8 +4267,7 @@ export namespace compute_v1 { */ startTime?: string; /** - * State of this notification. Note that the "NS_" versions of - * this enum have been deprecated in favor of the unprefixed values. + * State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values. */ state?: string; } @@ -5717,8 +4282,7 @@ export namespace compute_v1 { */ export interface Schema$License { /** - * [Output Only] Deprecated. This field no longer reflects whether a license - * charges a usage fee. + * [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. */ chargesUseFee?: boolean; /** @@ -5726,13 +4290,11 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -5740,13 +4302,11 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] The unique code used to attach this license to images, - * snapshots, and disks. + * [Output Only] The unique code used to attach this license to images, snapshots, and disks. */ licenseCode?: string; /** - * Name of the resource. The name must be 1-63 characters long and comply - * with RFC1035. + * Name of the resource. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; resourceRequirements?: Schema$LicenseResourceRequirements; @@ -5755,8 +4315,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * If false, licenses will not be copied from the source resource when - * creating an image from a disk, disk from snapshot, or snapshot from disk. + * If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. */ transferable?: boolean; } @@ -5770,8 +4329,7 @@ export namespace compute_v1 { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -5779,13 +4337,11 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] URL and description aliases of Licenses with the same - * License Code. + * [Output Only] URL and description aliases of Licenses with the same License Code. */ licenseAlias?: Schema$LicenseCodeLicenseAlias[]; /** - * [Output Only] Name of the resource. The name is 1-20 characters long and - * must be a valid 64 bit integer. + * [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. */ name?: string; /** @@ -5797,9 +4353,7 @@ export namespace compute_v1 { */ state?: string; /** - * [Output Only] If true, the license will remain attached when creating - * images or snapshots from disks. Otherwise, the license is not - * transferred. + * [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. */ transferable?: boolean; } @@ -5815,13 +4369,11 @@ export namespace compute_v1 { } export interface Schema$LicenseResourceRequirements { /** - * Minimum number of guest cpus required to use the Instance. Enforced at - * Instance creation and Instance start. + * Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. */ minGuestCpuCount?: number; /** - * Minimum memory required to use the Instance. Enforced at Instance - * creation and Instance start. + * Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. */ minMemoryMb?: number; } @@ -5835,11 +4387,7 @@ export namespace compute_v1 { */ items?: Schema$License[]; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -5886,22 +4434,7 @@ export namespace compute_v1 { logName?: string; } /** - * Increment a streamz counter with the specified metric and field names. - * Metric names should start with a '/', generally be lowercase-only, - * and end in "_count". Field names should not contain an initial - * slash. The actual exported metric names will have "/iam/policy" - * prepended. Field names correspond to IAM request parameters and field - * values are their respective values. Supported field names: - - * "authority", which is "[token]" if IAMContext.token is - * present, otherwise the value of IAMContext.authority_selector if present, - * and otherwise a representation of IAMContext.principal; or - - * "iam_principal", a representation of IAMContext.principal even if - * a token or authority selector is present; or - "" (empty string), - * resulting in a counter with no fields. Examples: counter { metric: - * "/debug_access_count" field: "iam_principal" } ==> - * increment counter /iam/policy/backend_debug_access_count - * {iam_principal=[value of IAMContext.principal]} At this time we do not - * support multiple field names (though this may be supported in the future). + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). */ export interface Schema$LogConfigCounterOptions { /** @@ -5918,18 +4451,12 @@ export namespace compute_v1 { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. NOTE: - * Logging to Gin in a fail-closed manner is currently unsupported while - * work is being done to satisfy the requirements of go/345. Currently, - * setting LOG_FAIL_CLOSED mode will have no effect, but still exists - * because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ logMode?: string; } /** - * A Machine Type resource. (== resource_for v1.machineTypes ==) (== - * resource_for beta.machineTypes ==) + * A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) */ export interface Schema$MachineType { /** @@ -5945,28 +4472,23 @@ export namespace compute_v1 { */ description?: string; /** - * [Output Only] The number of virtual CPUs that are available to the - * instance. + * [Output Only] The number of virtual CPUs that are available to the instance. */ guestCpus?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Deprecated] This property is deprecated and will never be populated with - * any relevant values. + * [Deprecated] This property is deprecated and will never be populated with any relevant values. */ imageSpaceGb?: number; /** - * [Output Only] Whether this machine type has a shared CPU. See Shared-core - * machine types for more information. + * [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. */ isSharedCpu?: boolean; /** - * [Output Only] The type of the resource. Always compute#machineType for - * machine types. + * [Output Only] The type of the resource. Always compute#machineType for machine types. */ kind?: string; /** @@ -5978,8 +4500,7 @@ export namespace compute_v1 { */ maximumPersistentDisksSizeGb?: string; /** - * [Output Only] The amount of physical memory available to the instance, - * defined in MB. + * [Output Only] The amount of physical memory available to the instance, defined in MB. */ memoryMb?: number; /** @@ -5995,8 +4516,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The name of the zone where the machine type resides, such - * as us-central1-a. + * [Output Only] The name of the zone where the machine type resides, such as us-central1-a. */ zone?: string; } @@ -6010,16 +4530,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$MachineTypesScopedList}; /** - * [Output Only] Type of resource. Always compute#machineTypeAggregatedList - * for aggregated lists of machine types. + * [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6048,16 +4563,11 @@ export namespace compute_v1 { */ items?: Schema$MachineType[]; /** - * [Output Only] Type of resource. Always compute#machineTypeList for lists - * of machine types. + * [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6079,8 +4589,7 @@ export namespace compute_v1 { */ machineTypes?: Schema$MachineType[]; /** - * [Output Only] An informational warning that appears when the machine - * types list is empty. + * [Output Only] An informational warning that appears when the machine types list is empty. */ warning?: { code?: string; @@ -6093,46 +4602,23 @@ export namespace compute_v1 { */ export interface Schema$ManagedInstance { /** - * [Output Only] The current action that the managed instance group has - * scheduled for the instance. Possible values: - NONE The instance is - * running, and the managed instance group does not have any scheduled - * actions for this instance. - CREATING The managed instance group is - * creating this instance. If the group fails to create this instance, it - * will try again until it is successful. - CREATING_WITHOUT_RETRIES The - * managed instance group is attempting to create this instance only once. - * If the group fails to create this instance, it does not try again and the - * group's targetSize value is decreased instead. - RECREATING The - * managed instance group is recreating this instance. - DELETING The - * managed instance group is permanently deleting this instance. - - * ABANDONING The managed instance group is abandoning this instance. The - * instance will be removed from the instance group and from any target - * pools that are associated with this group. - RESTARTING The managed - * instance group is restarting the instance. - REFRESHING The managed - * instance group is applying configuration changes to the instance without - * stopping it. For example, the group can update the target pool list for - * an instance without stopping that instance. - VERIFYING The managed - * instance group has created the instance and it is in the process of being - * verified. + * [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. */ currentAction?: string; /** - * [Output only] The unique identifier for this resource. This field is - * empty when instance does not exist. + * [Output only] The unique identifier for this resource. This field is empty when instance does not exist. */ id?: string; /** - * [Output Only] The URL of the instance. The URL can exist even if the - * instance has not yet been created. + * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ instance?: string; /** - * [Output Only] The status of the instance. This field is empty when the - * instance does not exist. + * [Output Only] The status of the instance. This field is empty when the instance does not exist. */ instanceStatus?: string; /** - * [Output Only] Information about the last attempt to create or delete the - * instance. + * [Output Only] Information about the last attempt to create or delete the instance. */ lastAttempt?: Schema$ManagedInstanceLastAttempt; /** @@ -6142,8 +4628,7 @@ export namespace compute_v1 { } export interface Schema$ManagedInstanceLastAttempt { /** - * [Output Only] Encountered errors during the last attempt to create or - * delete the instance. + * [Output Only] Encountered errors during the last attempt to create or delete the instance. */ errors?: { errors?: Array<{code?: string; location?: string; message?: string}>; @@ -6151,8 +4636,7 @@ export namespace compute_v1 { } export interface Schema$ManagedInstanceVersion { /** - * [Output Only] The intended template of the instance. This field is empty - * when current_action is one of { DELETING, ABANDONING }. + * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. */ instanceTemplate?: string; /** @@ -6165,18 +4649,11 @@ export namespace compute_v1 { */ export interface Schema$Metadata { /** - * Specifies a fingerprint for this request, which is essentially a hash of - * the metadata's contents and used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve the resource. + * Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. */ fingerprint?: string; /** - * Array of key/value pairs. The total size of all keys and values must be - * less than 512 KB. + * Array of key/value pairs. The total size of all keys and values must be less than 512 KB. */ items?: Array<{key?: string; value?: string}>; /** @@ -6189,8 +4666,7 @@ export namespace compute_v1 { */ export interface Schema$NamedPort { /** - * The name for this named port. The name must be 1-63 characters long, and - * comply with RFC1035. + * The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. */ name?: string; /** @@ -6199,17 +4675,11 @@ export namespace compute_v1 { port?: number; } /** - * Represents a Network resource. Read Virtual Private Cloud (VPC) Network - * Overview for more information. (== resource_for v1.networks ==) (== - * resource_for beta.networks ==) + * Represents a Network resource. Read Virtual Private Cloud (VPC) Network Overview for more information. (== resource_for v1.networks ==) (== resource_for beta.networks ==) */ export interface Schema$Network { /** - * When set to true, the VPC network is created in "auto" mode. - * When set to false, the VPC network is created in "custom" mode. - * An auto mode VPC network starts with one subnet per region. Each subnet - * has a predetermined range as described in Auto mode VPC network IP - * ranges. + * When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. */ autoCreateSubnetworks?: boolean; /** @@ -6217,25 +4687,19 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The gateway address for default routing out of the network. - * This value is read only and is selected by GCP. + * [Output Only] The gateway address for default routing out of the network. This value is read only and is selected by GCP. */ gatewayIPv4?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Deprecated in favor of subnet mode networks. The range of internal - * addresses that are legal on this network. This range is a CIDR - * specification, for example: 192.168.0.0/16. Provided by the client when - * the network is created. + * Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. */ IPv4Range?: string; /** @@ -6243,13 +4707,7 @@ export namespace compute_v1 { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -6257,9 +4715,7 @@ export namespace compute_v1 { */ peerings?: Schema$NetworkPeering[]; /** - * The network-level routing configuration for this network. Used by Cloud - * Router to determine what type of network-wide routing behavior to - * enforce. + * The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. */ routingConfig?: Schema$NetworkRoutingConfig; /** @@ -6267,8 +4723,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] Server-defined fully-qualified URLs for all subnetworks in - * this VPC network. + * [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. */ subnetworks?: string[]; } @@ -6277,24 +4732,15 @@ export namespace compute_v1 { */ export interface Schema$NetworkEndpoint { /** - * The name for a specific VM instance that the IP address belongs to. This - * is required for network endpoints of type GCE_VM_IP_PORT. The instance - * must be in the same zone of network endpoint group. The name must be - * 1-63 characters long, and comply with RFC1035. + * The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035. */ instance?: string; /** - * Optional IPv4 address of network endpoint. The IP address must belong to - * a VM in GCE (either the primary IP or as part of an aliased IP range). If - * the IP address is not specified, then the primary IP address for the VM - * instance in the network that the network endpoint group belongs to will - * be used. + * Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. */ ipAddress?: string; /** - * Optional port number of network endpoint. If not specified and the - * NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the - * defaultPort for the network endpoint group will be used. + * Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used. */ port?: number; } @@ -6307,43 +4753,31 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * The default port used if the port number is not specified in the network - * endpoint. + * The default port used if the port number is not specified in the network endpoint. */ defaultPort?: number; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#networkEndpointGroup - * for network endpoint group. + * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. */ kind?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network to which all network endpoints in the NEG belong. - * Uses "default" project network if unspecified. + * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. */ network?: string; /** - * Type of network endpoints in this network endpoint group. Currently the - * only supported value is GCE_VM_IP_PORT. + * Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT. */ networkEndpointType?: string; /** @@ -6355,13 +4789,11 @@ export namespace compute_v1 { */ size?: number; /** - * Optional URL of the subnetwork to which all network endpoints in the NEG - * belong. + * Optional URL of the subnetwork to which all network endpoints in the NEG belong. */ subnetwork?: string; /** - * [Output Only] The URL of the zone where the network endpoint group is - * located. + * [Output Only] The URL of the zone where the network endpoint group is located. */ zone?: string; } @@ -6375,17 +4807,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList}; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupAggregatedList for aggregated lists of - * network endpoint groups. + * [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6411,16 +4837,11 @@ export namespace compute_v1 { */ items?: Schema$NetworkEndpointGroup[]; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupList for network endpoint group lists. + * [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6450,9 +4871,7 @@ export namespace compute_v1 { } export interface Schema$NetworkEndpointGroupsListEndpointsRequest { /** - * Optional query parameter for showing the health status of each network - * endpoint. Valid options are SKIP or SHOW. If you don't specifiy this - * parameter, the health status of network endpoints will not be provided. + * Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided. */ healthStatus?: string; } @@ -6466,17 +4885,11 @@ export namespace compute_v1 { */ items?: Schema$NetworkEndpointWithHealthStatus[]; /** - * [Output Only] The resource type, which is always - * compute#networkEndpointGroupsListNetworkEndpoints for the list of network - * endpoints in the specified network endpoint group. + * [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6490,13 +4903,11 @@ export namespace compute_v1 { } export interface Schema$NetworkEndpointGroupsScopedList { /** - * [Output Only] The list of network endpoint groups that are contained in - * this scope. + * [Output Only] The list of network endpoint groups that are contained in this scope. */ networkEndpointGroups?: Schema$NetworkEndpointGroup[]; /** - * [Output Only] An informational warning that replaces the list of network - * endpoint groups when the list is empty. + * [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty. */ warning?: { code?: string; @@ -6519,62 +4930,35 @@ export namespace compute_v1 { */ export interface Schema$NetworkInterface { /** - * An array of configurations for this interface. Currently, only one access - * config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs - * specified, then this instance will have no external internet access. + * An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. */ accessConfigs?: Schema$AccessConfig[]; /** - * An array of alias IP ranges for this network interface. Can only be - * specified for network interfaces on subnet-mode networks. + * An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. */ aliasIpRanges?: Schema$AliasIpRange[]; /** - * Fingerprint hash of contents stored in this network interface. This field - * will be ignored when inserting an Instance or adding a NetworkInterface. - * An up-to-date fingerprint must be provided in order to update the - * NetworkInterface, otherwise the request will fail with error 412 - * conditionNotMet. + * Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. */ fingerprint?: string; /** - * [Output Only] Type of the resource. Always compute#networkInterface for - * network interfaces. + * [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. */ kind?: string; /** - * [Output Only] The name of the network interface, generated by the server. - * For network devices, these are eth0, eth1, etc. + * [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. */ name?: string; /** - * URL of the network resource for this instance. When creating an instance, - * if neither the network nor the subnetwork is specified, the default - * network global/networks/default is used; if the network is not specified - * but the subnetwork is specified, the network is inferred. This field is - * optional when creating a firewall rule. If not specified when creating a - * firewall rule, the default network global/networks/default is used. If - * you specify this property, you can specify the network as a full or - * partial URL. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/global/networks/network - * - projects/project/global/networks/network - global/networks/default + * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ network?: string; /** - * An IPv4 internal network address to assign to the instance for this - * network interface. If not specified by the user, an unused internal IP is - * assigned by the system. + * An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ networkIP?: string; /** - * The URL of the Subnetwork resource for this instance. If the network - * resource is in legacy mode, do not provide this property. If the network - * is in auto subnet mode, providing the subnetwork is optional. If the - * network is in custom subnet mode, then this field should be specified. If - * you specify this property, you can specify the subnetwork as a full or - * partial URL. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - * - regions/region/subnetworks/subnetwork + * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string; } @@ -6591,16 +4975,11 @@ export namespace compute_v1 { */ items?: Schema$Network[]; /** - * [Output Only] Type of resource. Always compute#networkList for lists of - * networks. + * [Output Only] Type of resource. Always compute#networkList for lists of networks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6617,42 +4996,23 @@ export namespace compute_v1 { }; } /** - * A network peering attached to a network resource. The message includes the - * peering name, peer network, peering state, and a flag indicating whether - * Google Compute Engine should automatically create routes for the peering. + * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. */ export interface Schema$NetworkPeering { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes - * instead. Indicates whether full mesh connectivity is created and managed - * automatically. When it is set to true, Google Compute Engine will - * automatically create and manage the routes between two networks when the - * state is ACTIVE. Otherwise, user needs to create routes manually to route - * packets to peer network. + * This field will be deprecated soon. Prefer using exchange_subnet_routes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. */ autoCreateRoutes?: boolean; /** - * Whether full mesh connectivity is created and managed automatically. When - * it is set to true, Google Compute Engine will automatically create and - * manage the routes between two networks when the peering state is ACTIVE. - * Otherwise, user needs to create routes manually to route packets to peer - * network. + * Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. */ exchangeSubnetRoutes?: boolean; /** - * Name of this peering. Provided by the client when the peering is created. - * The name must comply with RFC1035. Specifically, the name must be 1-63 - * characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - * which means the first character must be a lowercase letter, and all the - * following characters must be a dash, lowercase letter, or digit, except - * the last character, which cannot be a dash. + * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the peer network. It can be either full URL or partial URL. - * The peer network may belong to a different project. If the partial URL - * does not contain project, it is assumed that the peer network is in the - * same project as the current network. + * The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ network?: string; /** @@ -6665,25 +5025,17 @@ export namespace compute_v1 { stateDetails?: string; } /** - * A routing configuration attached to a network resource. The message - * includes the list of routers associated with the network, and a flag - * indicating the type of routing behavior to enforce network-wide. + * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. */ export interface Schema$NetworkRoutingConfig { /** - * The network-wide routing mode to use. If set to REGIONAL, this - * network's cloud routers will only advertise routes with subnets of - * this network in the same region as the router. If set to GLOBAL, this - * network's cloud routers will advertise routes with all subnets of - * this network, across regions. + * The network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. */ routingMode?: string; } export interface Schema$NetworksAddPeeringRequest { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes - * in network_peering instead. Whether Google Compute Engine manages the - * routes automatically. + * This field will be deprecated soon. Prefer using exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. */ autoCreateRoutes?: boolean; /** @@ -6691,18 +5043,11 @@ export namespace compute_v1 { */ name?: string; /** - * Network peering parameters. In order to specify route policies for - * peering using import/export custom routes, you will have to fill all - * peering related parameters (name, peer network, exchange_subnet_routes) - * in network_peeringfield. Corresponding fields in - * NetworksAddPeeringRequest will be deprecated soon. + * Network peering parameters. In order to specify route policies for peering using import/export custom routes, you will have to fill all peering related parameters (name, peer network, exchange_subnet_routes) in network_peeringfield. Corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ networkPeering?: Schema$NetworkPeering; /** - * URL of the peer network. It can be either full URL or partial URL. The - * peer network may belong to a different project. If the partial URL does - * not contain project, it is assumed that the peer network is in the same - * project as the current network. + * URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. */ peerNetwork?: string; } @@ -6713,10 +5058,7 @@ export namespace compute_v1 { name?: string; } /** - * A NodeGroup resource. To create a node group, you must first create a node - * templates. To learn more about node groups and sole-tenant nodes, read the - * Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== - * resource_for v1.nodeGroups ==) + * A NodeGroup resource. To create a node group, you must first create a node templates. To learn more about node groups and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) */ export interface Schema$NodeGroup { /** @@ -6724,28 +5066,19 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeGroup for node - * group. + * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -6762,8 +5095,7 @@ export namespace compute_v1 { size?: number; status?: string; /** - * [Output Only] The name of the zone where the node group resides, such as - * us-central1-a. + * [Output Only] The name of the zone where the node group resides, such as us-central1-a. */ zone?: string; } @@ -6777,16 +5109,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$NodeGroupsScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for - * aggregated lists of node groups. + * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6815,16 +5142,11 @@ export namespace compute_v1 { */ items?: Schema$NodeGroup[]; /** - * [Output Only] Type of resource.Always compute#nodeGroupList for lists of - * node groups. + * [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6874,17 +5196,11 @@ export namespace compute_v1 { */ items?: Schema$NodeGroupNode[]; /** - * [Output Only] The resource type, which is always - * compute.nodeGroupsListNodes for the list of nodes in the specified node - * group. + * [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -6906,8 +5222,7 @@ export namespace compute_v1 { */ nodeGroups?: Schema$NodeGroup[]; /** - * [Output Only] An informational warning that appears when the nodeGroup - * list is empty. + * [Output Only] An informational warning that appears when the nodeGroup list is empty. */ warning?: { code?: string; @@ -6917,15 +5232,12 @@ export namespace compute_v1 { } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** - * Full or partial URL of the node template resource to be updated for this - * node group. + * Full or partial URL of the node template resource to be updated for this node group. */ nodeTemplate?: string; } /** - * A Node Template resource. To learn more about node templates and - * sole-tenant nodes, read the Sole-tenant nodes documentation. (== - * resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * A Node Template resource. To learn more about node templates and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) */ export interface Schema$NodeTemplate { /** @@ -6933,33 +5245,23 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeTemplate for - * node templates. + * [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Labels to use for node affinity, which will be used in instance - * scheduling. + * Labels to use for node affinity, which will be used in instance scheduling. */ nodeAffinityLabels?: {[key: string]: string}; /** @@ -6967,15 +5269,11 @@ export namespace compute_v1 { */ nodeType?: string; /** - * The flexible properties of the desired node type. Node groups that use - * this node template will create nodes of a type that matches these - * properties. This field is mutually exclusive with the node_type - * property; you can only define one or the other, but not both. + * The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. */ nodeTypeFlexibility?: Schema$NodeTemplateNodeTypeFlexibility; /** - * [Output Only] The name of the region where the node template resides, - * such as us-central1. + * [Output Only] The name of the region where the node template resides, such as us-central1. */ region?: string; /** @@ -6983,8 +5281,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The status of the node template. One of the following - * values: CREATING, READY, and DELETING. + * [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. */ status?: string; /** @@ -7002,16 +5299,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$NodeTemplatesScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList - * for aggregated lists of node templates. + * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7040,16 +5332,11 @@ export namespace compute_v1 { */ items?: Schema$NodeTemplate[]; /** - * [Output Only] Type of resource.Always compute#nodeTemplateList for lists - * of node templates. + * [Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7076,8 +5363,7 @@ export namespace compute_v1 { */ nodeTemplates?: Schema$NodeTemplate[]; /** - * [Output Only] An informational warning that appears when the node - * templates list is empty. + * [Output Only] An informational warning that appears when the node templates list is empty. */ warning?: { code?: string; @@ -7106,18 +5392,15 @@ export namespace compute_v1 { */ description?: string; /** - * [Output Only] The number of virtual CPUs that are available to the node - * type. + * [Output Only] The number of virtual CPUs that are available to the node type. */ guestCpus?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The type of the resource. Always compute#nodeType for node - * types. + * [Output Only] The type of the resource. Always compute#nodeType for node types. */ kind?: string; /** @@ -7125,8 +5408,7 @@ export namespace compute_v1 { */ localSsdGb?: number; /** - * [Output Only] The amount of physical memory available to the node type, - * defined in MB. + * [Output Only] The amount of physical memory available to the node type, defined in MB. */ memoryMb?: number; /** @@ -7138,8 +5420,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The name of the zone where the node type resides, such as - * us-central1-a. + * [Output Only] The name of the zone where the node type resides, such as us-central1-a. */ zone?: string; } @@ -7153,16 +5434,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$NodeTypesScopedList}; /** - * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for - * aggregated lists of node types. + * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7191,16 +5467,11 @@ export namespace compute_v1 { */ items?: Schema$NodeType[]; /** - * [Output Only] Type of resource.Always compute#nodeTypeList for lists of - * node types. + * [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7222,8 +5493,7 @@ export namespace compute_v1 { */ nodeTypes?: Schema$NodeType[]; /** - * [Output Only] An informational warning that appears when the node types - * list is empty. + * [Output Only] An informational warning that appears when the node types list is empty. */ warning?: { code?: string; @@ -7232,16 +5502,11 @@ export namespace compute_v1 { }; } /** - * An Operation resource, used to manage asynchronous API requests. (== - * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations - * ==) (== resource_for v1.regionOperations ==) (== resource_for - * beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== - * resource_for beta.zoneOperations ==) + * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** - * [Output Only] The value of `requestId` if you provided it in the request. - * Not present otherwise. + * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ clientOperationId?: string; /** @@ -7249,46 +5514,37 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * [Output Only] A textual description of the operation, which is set when - * the operation is created. + * [Output Only] A textual description of the operation, which is set when the operation is created. */ description?: string; /** - * [Output Only] The time that this operation was completed. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ endTime?: string; /** - * [Output Only] If errors are generated during processing of the operation, - * this field will be populated. + * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * message that was returned, such as NOT FOUND. + * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ httpErrorMessage?: string; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * status code that was returned. For example, a 404 means the resource was - * not found. + * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ httpErrorStatusCode?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The time that this operation was requested. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ insertTime?: string; /** - * [Output Only] Type of the resource. Always compute#operation for - * Operation resources. + * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ kind?: string; /** @@ -7296,23 +5552,15 @@ export namespace compute_v1 { */ name?: string; /** - * [Output Only] The type of operation, such as insert, update, or delete, - * and so on. + * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ operationType?: string; /** - * [Output Only] An optional progress indicator that ranges from 0 to 100. - * There is no requirement that this be linear or support any granularity of - * operations. This should not be used to guess when the operation will be - * complete. This number should monotonically increase as the operation - * progresses. + * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only - * available when performing regional operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -7320,39 +5568,31 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The time that this operation was started by the server. - * This value is in RFC3339 text format. + * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ startTime?: string; /** - * [Output Only] The status of the operation, which can be one of the - * following: PENDING, RUNNING, or DONE. + * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ status?: string; /** - * [Output Only] An optional textual description of the current status of - * the operation. + * [Output Only] An optional textual description of the current status of the operation. */ statusMessage?: string; /** - * [Output Only] The unique target ID, which identifies a specific - * incarnation of the target resource. + * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ targetId?: string; /** - * [Output Only] The URL of the resource that the operation modifies. For - * operations related to creating a snapshot, this points to the persistent - * disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ targetLink?: string; /** - * [Output Only] User who requested the operation, for example: - * user@example.com. + * [Output Only] User who requested the operation, for example: user@example.com. */ user?: string; /** - * [Output Only] If warning messages are generated during processing of the - * operation, this field will be populated. + * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ warnings?: Array<{ code?: string; @@ -7360,17 +5600,13 @@ export namespace compute_v1 { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only - * available when performing per-zone operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } export interface Schema$OperationAggregatedList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -7378,16 +5614,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$OperationsScopedList}; /** - * [Output Only] Type of resource. Always compute#operationAggregatedList - * for aggregated lists of operations. + * [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7408,8 +5639,7 @@ export namespace compute_v1 { */ export interface Schema$OperationList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -7417,16 +5647,11 @@ export namespace compute_v1 { */ items?: Schema$Operation[]; /** - * [Output Only] Type of resource. Always compute#operations for Operations - * resource. + * [Output Only] Type of resource. Always compute#operations for Operations resource. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7448,8 +5673,7 @@ export namespace compute_v1 { */ operations?: Schema$Operation[]; /** - * [Output Only] Informational warning which replaces the list of operations - * when the list is empty. + * [Output Only] Informational warning which replaces the list of operations when the list is empty. */ warning?: { code?: string; @@ -7458,34 +5682,15 @@ export namespace compute_v1 { }; } /** - * A matcher for the path portion of the URL. The BackendService from the - * longest-matched rule will serve the URL. If no rule was matched, the - * default service will be used. + * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. */ export interface Schema$PathMatcher { /** - * The full or partial URL to the BackendService resource. This will be used - * if none of the pathRules or routeRules defined by this PathMatcher are - * matched. For example, the following are all valid URLs to a - * BackendService resource: - - * https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - * - compute/v1/projects/project/global/backendServices/backendService - - * global/backendServices/backendService If defaultRouteAction is - * additionally specified, advanced routing actions like URL Rewrites, etc. - * take effect prior to sending the request to the backend. However, if - * defaultService is specified, defaultRouteAction cannot contain any - * weightedBackendServices. Conversely, if defaultRouteAction specifies any - * weightedBackendServices, defaultService must not be specified. Only one - * of defaultService, defaultUrlRedirect or - * defaultRouteAction.weightedBackendService must be set. Authorization - * requires one or more of the following Google IAM permissions on the - * specified resource default_service: - compute.backendBuckets.use - - * compute.backendServices.use + * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use */ defaultService?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -7493,58 +5698,25 @@ export namespace compute_v1 { */ name?: string; /** - * The list of path rules. Use this list instead of routeRules when routing - * based on simple path matching is all that's required. The order by - * which path rules are specified does not matter. Matches are always done - * on the longest-path-first basis. For example: a pathRule with a path - * /a/b/c/* will match before /a/b/* irrespective of the order in which - * those paths appear in this list. Only one of pathRules or routeRules must - * be set. + * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. */ pathRules?: Schema$PathRule[]; } /** - * A path-matching rule for a URL. If matched, will use the specified - * BackendService to handle the traffic arriving at this URL. + * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. */ export interface Schema$PathRule { /** - * The list of path patterns to match. Each must start with / and the only - * place a * is allowed is at the end following a /. The string fed to the - * path matcher does not include any text after the first ? or #, and those - * chars are not allowed here. + * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. */ paths?: string[]; /** - * The full or partial URL of the backend service resource to which traffic - * is directed if this rule is matched. If routeAction is additionally - * specified, advanced routing actions like URL Rewrites, etc. take effect - * prior to sending the request to the backend. However, if service is - * specified, routeAction cannot contain any weightedBackendService s. - * Conversely, if routeAction specifies any weightedBackendServices, - * service must not be specified. Only one of urlRedirect, service or - * routeAction.weightedBackendService must be set. + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ service?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML Example** bindings: - - * members: - user:mike@example.com - group:admins@example.com - - * domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com - * role: roles/owner - members: - user:sean@example.com role: roles/viewer For - * a description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -7552,31 +5724,16 @@ export namespace compute_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; iamOwned?: boolean; /** - * If more than one rule is specified, the rules are applied in the - * following manner: - All matching LOG rules are always applied. - If any - * DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be - * applied if one or more matching rule requires logging. - Otherwise, if - * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging - * will be applied if one or more matching rule requires logging. - - * Otherwise, if no rule applies, permission is denied. + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ rules?: Schema$Rule[]; /** @@ -7585,14 +5742,11 @@ export namespace compute_v1 { version?: number; } /** - * A Project resource. For an overview of projects, see Cloud Platform - * Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for - * beta.projects ==) + * A Project resource. For an overview of projects, see Cloud Platform Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) */ export interface Schema$Project { /** - * Metadata key/value pairs available to all instances contained in this - * project. See Custom metadata for more information. + * Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. */ commonInstanceMetadata?: Schema$Metadata; /** @@ -7600,14 +5754,11 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * This signifies the default network tier used for configuring resources of - * the project and can only take the following values: PREMIUM, STANDARD. - * Initially the default network tier is PREMIUM. + * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. */ defaultNetworkTier?: string; /** - * [Output Only] Default service account used by VMs running in this - * project. + * [Output Only] Default service account used by VMs running in this project. */ defaultServiceAccount?: string; /** @@ -7619,9 +5770,7 @@ export namespace compute_v1 { */ enabledFeatures?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. This is not the project ID, and is just a unique - * ID used by Compute Engine to identify resources. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. */ id?: string; /** @@ -7629,8 +5778,7 @@ export namespace compute_v1 { */ kind?: string; /** - * The project ID. For example: my-example-project. Use the project ID to - * make requests to Compute Engine. + * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. */ name?: string; /** @@ -7642,13 +5790,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * The naming prefix for daily usage reports and the Google Cloud Storage - * bucket where they are stored. + * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. */ usageExportLocation?: Schema$UsageExportLocation; /** - * [Output Only] The role this project has in a shared VPC configuration. - * Currently only HOST projects are differentiated. + * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. */ xpnProjectStatus?: string; } @@ -7666,29 +5812,21 @@ export namespace compute_v1 { } export interface Schema$ProjectsGetXpnResources { /** - * [Output Only] Type of resource. Always compute#projectsGetXpnResources - * for lists of service resources (a.k.a service projects) + * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** - * Service resources (a.k.a service projects) attached to this project as - * their shared VPC host. + * Service resources (a.k.a service projects) attached to this project as their shared VPC host. */ resources?: Schema$XpnResourceId[]; } export interface Schema$ProjectsListXpnHostsRequest { /** - * Optional organization ID managed by Cloud Resource Manager, for which to - * list shared VPC host projects. If not specified, the organization will be - * inferred from the project. + * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. */ organization?: string; } @@ -7711,8 +5849,7 @@ export namespace compute_v1 { */ metric?: string; /** - * [Output Only] Owning resource. This is the resource on which this quota - * is applied. + * [Output Only] Owning resource. This is the resource on which this quota is applied. */ owner?: string; /** @@ -7725,13 +5862,11 @@ export namespace compute_v1 { */ export interface Schema$Reference { /** - * [Output Only] Type of the resource. Always compute#reference for - * references. + * [Output Only] Type of the resource. Always compute#reference for references. */ kind?: string; /** - * A description of the reference type with no implied semantics. Possible - * values include: - MEMBER_OF + * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF */ referenceType?: string; /** @@ -7744,8 +5879,7 @@ export namespace compute_v1 { target?: string; } /** - * Region resource. (== resource_for beta.regions ==) (== resource_for - * v1.regions ==) + * Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==) */ export interface Schema$Region { /** @@ -7761,8 +5895,7 @@ export namespace compute_v1 { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -7786,8 +5919,7 @@ export namespace compute_v1 { */ status?: string; /** - * [Output Only] A list of zones available in this region, in the form of - * resource URLs. + * [Output Only] A list of zones available in this region, in the form of resource URLs. */ zones?: string[]; } @@ -7808,11 +5940,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7844,16 +5972,11 @@ export namespace compute_v1 { */ items?: Schema$DiskType[]; /** - * [Output Only] Type of resource. Always compute#regionDiskTypeList for - * region disk types. + * [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7886,11 +6009,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7919,17 +6038,11 @@ export namespace compute_v1 { */ items?: Schema$InstanceGroupManager[]; /** - * [Output Only] The resource type, which is always - * compute#instanceGroupManagerList for a list of managed instance groups - * that exist in th regional scope. + * [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -7947,15 +6060,13 @@ export namespace compute_v1 { } export interface Schema$RegionInstanceGroupManagersAbandonInstancesRequest { /** - * The URLs of one or more instances to abandon. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } export interface Schema$RegionInstanceGroupManagersDeleteInstancesRequest { /** - * The URLs of one or more instances to delete. This can be a full URL or a - * partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } @@ -7967,29 +6078,23 @@ export namespace compute_v1 { } export interface Schema$RegionInstanceGroupManagersRecreateRequest { /** - * The URLs of one or more instances to recreate. This can be a full URL or - * a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; } export interface Schema$RegionInstanceGroupManagersSetTargetPoolsRequest { /** - * Fingerprint of the target pools information, which is a hash of the - * contents. This field is used for optimistic locking when you update the - * target pool entries. This field is optional. + * Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional. */ fingerprint?: string; /** - * The URL of all TargetPool resources to which instances in the - * instanceGroup field are added. The target pools automatically apply to - * all of the instances in the managed instance group. + * The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. */ targetPools?: string[]; } export interface Schema$RegionInstanceGroupManagersSetTemplateRequest { /** - * URL of the InstanceTemplate resource from which all new instances will be - * created. + * URL of the InstanceTemplate resource from which all new instances will be created. */ instanceTemplate?: string; } @@ -8007,11 +6112,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8029,25 +6130,17 @@ export namespace compute_v1 { } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** - * Instances in which state should be returned. Valid options are: - * 'ALL', 'RUNNING'. By default, it lists all instances. + * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. */ instanceState?: string; /** - * Name of port user is interested in. It is optional. If it is set, only - * information about this ports will be returned. If it is not set, all the - * named ports will be returned. Always lists all instances. + * Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. */ portName?: string; } export interface Schema$RegionInstanceGroupsSetNamedPortsRequest { /** - * The fingerprint of the named ports information for this instance group. - * Use this optional property to prevent conflicts when multiple users - * change the named ports settings concurrently. Obtain the fingerprint with - * the instanceGroups.get method. Then, include the fingerprint in your - * request to ensure that you do not overwrite changes that were applied - * from another concurrent request. + * The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. */ fingerprint?: string; /** @@ -8068,16 +6161,11 @@ export namespace compute_v1 { */ items?: Schema$Region[]; /** - * [Output Only] Type of resource. Always compute#regionList for lists of - * regions. + * [Output Only] Type of resource. Always compute#regionList for lists of regions. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8095,12 +6183,7 @@ export namespace compute_v1 { } export interface Schema$RegionSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash in order to update or - * change labels. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** @@ -8110,63 +6193,39 @@ export namespace compute_v1 { } export interface Schema$RegionSetPolicyRequest { /** - * Flatten Policy to create a backwacd compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } /** - * Commitment for a particular resource (a Commitment is composed of one or - * more of these). + * Commitment for a particular resource (a Commitment is composed of one or more of these). */ export interface Schema$ResourceCommitment { /** - * The amount of the resource purchased (in a type-dependent unit, such as - * bytes). For vCPUs, this can just be an integer. For memory, this must be - * provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of - * memory per every vCPU. + * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. */ amount?: string; /** - * Type of resource for which this commitment applies. Possible values are - * VCPU and MEMORY + * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY */ type?: string; } export interface Schema$ResourceGroupReference { /** - * A URI referencing one of the instance groups or network endpoint groups - * listed in the backend service. + * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. */ group?: string; } /** - * Represents a Route resource. A route specifies how certain packets should - * be handled by the network. Routes are associated with instances by tags and - * the set of routes for a particular instance is called its routing table. - * For each packet leaving an instance, the system searches that - * instance's routing table for a single best matching route. Routes match - * packets by destination IP address, preferring smaller or more specific - * ranges over larger ones. If there is a tie, the system selects the route - * with the smallest priority value. If there is still a tie, it uses the - * layer three and four packet headers to select just one of the remaining - * matching routes. The packet is then forwarded as specified by the nextHop - * field of the winning route - either to another instance destination, an - * instance gateway, or a Google Compute Engine-operated gateway. Packets - * that do not match any route in the sending instance's routing table are - * dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + * Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table. For each packet leaving an instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway. Packets that do not match any route in the sending instance's routing table are dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) */ export interface Schema$Route { /** @@ -8174,33 +6233,23 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * The destination range of outgoing packets that this route applies to. - * Only IPv4 is supported. + * The destination range of outgoing packets that this route applies to. Only IPv4 is supported. */ destRange?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of this resource. Always compute#routes for Route - * resources. + * [Output Only] Type of this resource. Always compute#routes for Route resources. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -8208,20 +6257,15 @@ export namespace compute_v1 { */ network?: string; /** - * The URL to a gateway that should handle matching packets. You can only - * specify the internet gateway using a full or partial valid URL: - * projects/<project-id>/global/gateways/default-internet-gateway + * The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway */ nextHopGateway?: string; /** - * The URL to an instance that should handle matching packets. You can - * specify this as a full or partial URL. For example: - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ + * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ nextHopInstance?: string; /** - * The network IP address of an instance that should handle matching - * packets. Only IPv4 is supported. + * The network IP address of an instance that should handle matching packets. Only IPv4 is supported. */ nextHopIp?: string; /** @@ -8229,8 +6273,7 @@ export namespace compute_v1 { */ nextHopNetwork?: string; /** - * [Output Only] The network peering name that should handle matching - * packets, which should conform to RFC1035. + * [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. */ nextHopPeering?: string; /** @@ -8238,11 +6281,7 @@ export namespace compute_v1 { */ nextHopVpnTunnel?: string; /** - * The priority of this route. Priority is used to break ties in cases where - * there is more than one matching route of equal prefix length. In the case - * of two routes with equal prefix length, the one with the lowest-numbered - * priority value wins. Default value is 1000. Valid range is 0 through - * 65535. + * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. */ priority?: number; /** @@ -8254,8 +6293,7 @@ export namespace compute_v1 { */ tags?: string[]; /** - * [Output Only] If potential misconfigurations are detected for this route, - * this field will be populated with warning messages. + * [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. */ warnings?: Array<{ code?: string; @@ -8280,11 +6318,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8309,9 +6343,7 @@ export namespace compute_v1 { */ bgp?: Schema$RouterBgp; /** - * BGP information that needs to be configured into the routing stack to - * establish the BGP peering. It must specify peer ASN and either interface - * name, IP, or peer IP. Please refer to RFC4273. + * BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273. */ bgpPeers?: Schema$RouterBgpPeer[]; /** @@ -8319,19 +6351,15 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * Router interfaces. Each interface requires either one linked resource - * (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. - * ipRange), or both. + * Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both. */ interfaces?: Schema$RouterInterface[]; /** @@ -8339,13 +6367,7 @@ export namespace compute_v1 { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -8357,9 +6379,7 @@ export namespace compute_v1 { */ network?: string; /** - * [Output Only] URI of the region where the router resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -8397,11 +6417,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8419,19 +6435,11 @@ export namespace compute_v1 { } export interface Schema$RouterBgp { /** - * User-specified list of prefix groups to advertise in custom mode. This - * field can only be populated if advertise_mode is CUSTOM and is advertised - * to all peers of the router. These groups will be advertised in addition - * to any specified prefixes. Leave this field blank to advertise no custom - * groups. + * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. - * This field can only be populated if advertise_mode is CUSTOM and is - * advertised to all peers of the router. These IP ranges will be advertised - * in addition to any specified groups. Leave this field blank to advertise - * no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** @@ -8439,34 +6447,21 @@ export namespace compute_v1 { */ advertiseMode?: string; /** - * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, - * either 16-bit or 32-bit. The value will be fixed for this router - * resource. All VPN tunnels that link to this router will have the same - * local ASN. + * Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN. */ asn?: number; } export interface Schema$RouterBgpPeer { /** - * User-specified list of prefix groups to advertise in custom mode. This - * field can only be populated if advertise_mode is CUSTOM and overrides the - * list defined for the router (in Bgp message). These groups will be - * advertised in addition to any specified prefixes. Leave this field blank - * to advertise no custom groups. + * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. - * This field can only be populated if advertise_mode is CUSTOM and - * overrides the list defined for the router (in Bgp message). These IP - * ranges will be advertised in addition to any specified groups. Leave this - * field blank to advertise no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * The priority of routes advertised to this BGP peer. In the case where - * there is more than one matching route of maximum length, the routes with - * lowest priority value win. + * The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win. */ advertisedRoutePriority?: number; /** @@ -8478,69 +6473,45 @@ export namespace compute_v1 { */ interfaceName?: string; /** - * IP address of the interface inside Google Cloud Platform. Only IPv4 is - * supported. + * IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. */ ipAddress?: string; /** - * [Output Only] The resource that configures and manages this BGP peer. - * MANAGED_BY_USER is the default value and can be managed by you or other - * users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed - * by Cloud Interconnect, specifically by an InterconnectAttachment of type - * PARTNER. Google will automatically create, update, and delete this type - * of BGP peer when the PARTNER InterconnectAttachment is created, updated, - * or deleted. + * [Output Only] The resource that configures and manages this BGP peer. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** - * Name of this BGP peer. The name must be 1-63 characters long and comply - * with RFC1035. + * Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; /** - * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can - * be different for every tunnel. + * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel. */ peerAsn?: number; /** - * IP address of the BGP interface outside Google cloud. Only IPv4 is - * supported. + * IP address of the BGP interface outside Google cloud. Only IPv4 is supported. */ peerIpAddress?: string; } export interface Schema$RouterInterface { /** - * IP address and range of the interface. The IP range must be in the - * RFC3927 link-local IP space. The value must be a CIDR-formatted string, - * for example: 169.254.0.1/30. NOTE: Do not truncate the address as it - * represents the IP address of the interface. + * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ ipRange?: string; /** - * URI of the linked interconnect attachment. It must be in the same region - * as the router. Each interface can have at most one linked resource and it - * could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. */ linkedInterconnectAttachment?: string; /** - * URI of the linked VPN tunnel. It must be in the same region as the - * router. Each interface can have at most one linked resource and it could - * either be a VPN Tunnel or an interconnect attachment. + * URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. */ linkedVpnTunnel?: string; /** - * [Output Only] The resource that configures and manages this interface. - * MANAGED_BY_USER is the default value and can be managed by you or other - * users; MANAGED_BY_ATTACHMENT is an interface that is configured and - * managed by Cloud Interconnect, specifically by an InterconnectAttachment - * of type PARTNER. Google will automatically create, update, and delete - * this type of interface when the PARTNER InterconnectAttachment is - * created, updated, or deleted. + * [Output Only] The resource that configures and manages this interface. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** - * Name of this interface entry. The name must be 1-63 characters long and - * comply with RFC1035. + * Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; } @@ -8561,11 +6532,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8582,11 +6549,7 @@ export namespace compute_v1 { }; } /** - * Represents a Nat resource. It enables the VMs within the specified - * subnetworks to access Internet without external IP addresses. It specifies - * a list of subnetworks (and the ranges within) that want to use NAT. - * Customers can also provide the external IPs that would be used for NAT. GCP - * would auto-allocate ephemeral IPs if no external IPs are provided. + * Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided. */ export interface Schema$RouterNat { /** @@ -8594,49 +6557,35 @@ export namespace compute_v1 { */ icmpIdleTimeoutSec?: number; /** - * Minimum number of ports allocated to a VM from this NAT config. If not - * set, a default number of ports is allocated to a VM. This gets rounded up - * to the nearest power of 2. Eg. if the value of this field is 50, at least - * 64 ports will be allocated to a VM. + * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This gets rounded up to the nearest power of 2. Eg. if the value of this field is 50, at least 64 ports will be allocated to a VM. */ minPortsPerVm?: number; /** - * Unique name of this Nat service. The name must be 1-63 characters long - * and comply with RFC1035. + * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. */ name?: string; /** - * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should - * be empty. + * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should be empty. */ natIpAllocateOption?: string; /** - * A list of URLs of the IP resources used for this Nat service. These IPs - * must be valid static external IP addresses assigned to the project. - * max_length is subject to change post alpha. + * A list of URLs of the IP resources used for this Nat service. These IPs must be valid static external IP addresses assigned to the project. max_length is subject to change post alpha. */ natIps?: string[]; /** - * Specify the Nat option. If this field contains - * ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, - * then there should not be any other Router.Nat section in any Router for - * this network in this region. + * Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string; /** - * A list of Subnetwork resources whose traffic should be translated by NAT - * Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the - * SubnetworkIpRangeToNatOption above. + * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. */ subnetworks?: Schema$RouterNatSubnetworkToNat[]; /** - * Timeout (in seconds) for TCP established connections. Defaults to 1200s - * if not set. + * Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. */ tcpEstablishedIdleTimeoutSec?: number; /** - * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if - * not set. + * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. */ tcpTransitoryIdleTimeoutSec?: number; /** @@ -8653,17 +6602,11 @@ export namespace compute_v1 { */ name?: string; /** - * A list of the secondary ranges of the Subnetwork that are allowed to use - * NAT. This can be populated only if - * "LIST_OF_SECONDARY_IP_RANGES" is one of the values in - * source_ip_ranges_to_nat. + * A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat. */ secondaryIpRangeNames?: string[]; /** - * Specify the options for NAT ranges in the Subnetwork. All usages of - * single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only - * valid option with multiple values is: ["PRIMARY_IP_RANGE", - * "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + * Specify the options for NAT ranges in the Subnetwork. All usages of single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ sourceIpRangesToNat?: string[]; } @@ -8679,8 +6622,7 @@ export namespace compute_v1 { */ routers?: Schema$Router[]; /** - * Informational warning which replaces the list of routers when the list is - * empty. + * Informational warning which replaces the list of routers when the list is empty. */ warning?: { code?: string; @@ -8738,8 +6680,7 @@ export namespace compute_v1 { */ status?: string; /** - * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 - * hours, 59 minutes, 59 seconds + * Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds */ uptime?: string; /** @@ -8752,15 +6693,11 @@ export namespace compute_v1 { */ export interface Schema$RouterStatusNatStatus { /** - * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", - * "129.2.16.89"] + * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] */ autoAllocatedNatIps?: string[]; /** - * The number of extra IPs to allocate. This will be greater than 0 only if - * user-specified IPs are NOT enough to allow all configured VMs to use NAT. - * This value is meaningful only when auto-allocation of NAT IPs is *not* - * used. + * The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. */ minExtraNatIpsNeeded?: number; /** @@ -8776,8 +6713,7 @@ export namespace compute_v1 { */ userAllocatedNatIpResources?: string[]; /** - * A list of IPs user-allocated for NAT. They will be raw IP strings like - * "179.12.26.133". + * A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133". */ userAllocatedNatIps?: string[]; } @@ -8797,8 +6733,7 @@ export namespace compute_v1 { */ action?: string; /** - * Additional restrictions that must be met. All conditions must pass for - * the rule to match. + * Additional restrictions that must be met. All conditions must pass for the rule to match. */ conditions?: Schema$Condition[]; /** @@ -8806,25 +6741,19 @@ export namespace compute_v1 { */ description?: string; /** - * If one or more 'in' clauses are specified, the rule matches if - * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ ins?: string[]; /** - * The config returned to callers of tech.iam.IAM.CheckPolicy for any - * entries that match the LOG action. + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ logConfigs?: Schema$LogConfig[]; /** - * If one or more 'not_in' clauses are specified, the rule matches - * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ notIns?: string[]; /** - * A permission is a string of form '..' (e.g., - * 'storage.buckets.list'). A value of '*' matches all - * permissions, and a verb part of '*' (e.g., - * 'storage.buckets.*') matches all verbs. + * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ permissions?: string[]; } @@ -8833,12 +6762,7 @@ export namespace compute_v1 { */ export interface Schema$Scheduling { /** - * Specifies whether the instance should be automatically restarted if it is - * terminated by Compute Engine (not terminated by a user). You can only set - * the automatic restart option for standard instances. Preemptible - * instances cannot be automatically restarted. By default, this is set to - * true so an instance is automatically restarted if it is terminated by - * Compute Engine. + * Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. */ automaticRestart?: boolean; /** @@ -8846,22 +6770,16 @@ export namespace compute_v1 { */ nodeAffinities?: Schema$SchedulingNodeAffinity[]; /** - * Defines the maintenance behavior for this instance. For standard - * instances, the default behavior is MIGRATE. For preemptible instances, - * the default and only possible behavior is TERMINATE. For more - * information, see Setting Instance Scheduling Options. + * Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. */ onHostMaintenance?: string; /** - * Defines whether the instance is preemptible. This can only be set during - * instance creation, it cannot be set or changed after the instance has - * been created. + * Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. */ preemptible?: boolean; } /** - * Node Affinity: the configuration of desired nodes onto which this Instance - * could be scheduled. + * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. */ export interface Schema$SchedulingNodeAffinity { /** @@ -8878,9 +6796,7 @@ export namespace compute_v1 { values?: string[]; } /** - * A security policy is comprised of one or more rules. It can also be - * associated with one or more 'targets'. (== resource_for - * v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -8888,45 +6804,27 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Specifies a fingerprint for this resource, which is essentially a hash of - * the metadata's contents and used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make get() request to the security policy. + * Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output only] Type of the resource. Always compute#securityPolicyfor - * security policies + * [Output only] Type of the resource. Always compute#securityPolicyfor security policies */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * A list of rules that belong to this policy. There must always be a - * default rule (rule with priority 2147483647 and match "*"). If - * no rules are provided when creating a security policy, a default rule - * with action "allow" will be added. + * A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. */ rules?: Schema$SecurityPolicyRule[]; /** @@ -8944,16 +6842,11 @@ export namespace compute_v1 { */ items?: Schema$SecurityPolicy[]; /** - * [Output Only] Type of resource. Always compute#securityPolicyList for - * listsof securityPolicies + * [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -8969,29 +6862,23 @@ export namespace compute_v1 { securityPolicy?: string; } /** - * Represents a rule that describes one or more match conditions along with - * the action to be taken when traffic matches this condition (allow or deny). + * Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). */ export interface Schema$SecurityPolicyRule { /** - * The Action to preform when the client connection triggers the rule. Can - * currently be either "allow" or "deny()" where valid - * values for status are 403, 404, and 502. + * The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. */ action?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output only] Type of the resource. Always compute#securityPolicyRule for - * security policy rules + * [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules */ kind?: string; /** - * A match condition that incoming traffic is evaluated against. If it - * evaluates to true, the corresponding ?action? is enforced. + * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. */ match?: Schema$SecurityPolicyRuleMatcher; /** @@ -8999,29 +6886,20 @@ export namespace compute_v1 { */ preview?: boolean; /** - * An integer indicating the priority of a rule in the list. The priority - * must be a positive value between 0 and 2147483647. Rules are evaluated - * from highest to lowest priority where 0 is the highest priority and - * 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. */ priority?: number; } /** - * Represents a match condition that incoming traffic is evaluated against. - * Exactly one field must be specified. + * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. */ export interface Schema$SecurityPolicyRuleMatcher { /** - * The configuration options available when specifying versioned_expr. This - * field must be specified if versioned_expr is specified and cannot be - * specified if versioned_expr is not specified. + * The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. */ config?: Schema$SecurityPolicyRuleMatcherConfig; /** - * Preconfigured versioned expression. If this field is specified, config - * must also be specified. Available preconfigured expressions along with - * their requirements are: SRC_IPS_V1 - must specify the corresponding - * src_ip_range field in config. + * Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. */ versionedExpr?: string; } @@ -9040,14 +6918,11 @@ export namespace compute_v1 { */ contents?: string; /** - * [Output Only] Type of the resource. Always compute#serialPortOutput for - * serial port output. + * [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. */ kind?: string; /** - * [Output Only] The position of the next byte of content from the serial - * console output. Use this value in the next request as the start - * parameter. + * [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter. */ next?: string; /** @@ -9055,10 +6930,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * The starting byte position of the output that was returned. This should - * match the start parameter sent with the request. If the serial console - * output exceeds the size of the buffer, older output will be overwritten - * by newer content and the start values will be mismatched. + * The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched. */ start?: string; } @@ -9101,8 +6973,7 @@ export namespace compute_v1 { */ encryptionKey?: Schema$ShieldedInstanceIdentityEntry; /** - * [Output Only] Type of the resource. Always - * compute#shieldedInstanceIdentity for shielded Instance identity entry. + * [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. */ kind?: string; /** @@ -9124,13 +6995,11 @@ export namespace compute_v1 { ekPub?: string; } /** - * The policy describes the baseline against which Instance boot integrity is - * measured. + * The policy describes the baseline against which Instance boot integrity is measured. */ export interface Schema$ShieldedInstanceIntegrityPolicy { /** - * Updates the integrity policy baseline using the measurements from the VM - * instance's most recent boot. + * Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. */ updateAutoLearnPolicy?: boolean; } @@ -9139,23 +7008,16 @@ export namespace compute_v1 { */ export interface Schema$SignedUrlKey { /** - * Name of the key. The name must be 1-63 characters long, and comply with - * RFC1035. Specifically, the name must be 1-63 characters long and match - * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. + * Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ keyName?: string; /** - * 128-bit key value used for signing the URL. The key value must be a valid - * RFC 4648 Section 5 base64url encoded string. + * 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. */ keyValue?: string; } /** - * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) - * (== resource_for v1.snapshots ==) + * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) */ export interface Schema$Snapshot { /** @@ -9163,8 +7025,7 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -9172,49 +7033,31 @@ export namespace compute_v1 { */ diskSizeGb?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#snapshot for Snapshot - * resources. + * [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. */ kind?: string; /** - * A fingerprint for the labels being applied to this snapshot, which is - * essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve a snapshot. + * A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. */ labelFingerprint?: string; /** - * Labels to apply to this snapshot. These can be later modified by the - * setLabels method. Label values may be empty. + * Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. */ labels?: {[key: string]: string}; /** - * [Output Only] Integer license codes indicating which licenses are - * attached to this snapshot. + * [Output Only] Integer license codes indicating which licenses are attached to this snapshot. */ licenseCodes?: string[]; /** - * [Output Only] A list of public visible licenses that apply to this - * snapshot. This can be because the original image had licenses attached - * (such as a Windows image). + * [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). */ licenses?: string[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -9222,15 +7065,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Encrypts the snapshot using a customer-supplied encryption key. After - * you encrypt a snapshot using a customer-supplied key, you must provide - * the same key if you use the image later For example, you must provide the - * encryption key when you create a disk from the encrypted snapshot in a - * future request. Customer-supplied encryption keys do not protect access - * to metadata of the disk. If you do not provide an encryption key when - * creating the snapshot, then the snapshot will be encrypted using an - * automatically generated key and you do not need to provide a key to use - * the snapshot later. + * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ snapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -9238,32 +7073,23 @@ export namespace compute_v1 { */ sourceDisk?: string; /** - * The customer-supplied encryption key of the source disk. Required if the - * source disk is protected by a customer-supplied encryption key. + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The ID value of the disk used to create this snapshot. This - * value may be used to determine whether the snapshot was taken from the - * current or a previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. */ sourceDiskId?: string; /** - * [Output Only] The status of the snapshot. This can be CREATING, DELETING, - * FAILED, READY, or UPLOADING. + * [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. */ status?: string; /** - * [Output Only] A size of the storage used by the snapshot. As snapshots - * share storage, this number is expected to change with snapshot - * creation/deletion. + * [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. */ storageBytes?: string; /** - * [Output Only] An indicator whether storageBytes is in a stable state or - * it is being adjusted as a result of shared storage reallocation. This - * status can either be UPDATING, meaning the size of the snapshot is being - * updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. + * [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. */ storageBytesStatus?: string; /** @@ -9288,11 +7114,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9309,29 +7131,20 @@ export namespace compute_v1 { }; } /** - * A specification of the parameters to use when creating the instance - * template from a source instance. + * A specification of the parameters to use when creating the instance template from a source instance. */ export interface Schema$SourceInstanceParams { /** - * Attached disks configuration. If not provided, defaults are applied: For - * boot disk and any other R/W disks, new custom images will be created from - * each disk. For read-only disks, they will be attached in read-only mode. - * Local SSD disks will be created as blank volumes. + * Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. */ diskConfigs?: Schema$DiskInstantiationConfig[]; } /** - * An SslCertificate resource. This resource provides a mechanism to upload an - * SSL key and certificate to the load balancer to serve secure connections - * from the user. (== resource_for beta.sslCertificates ==) (== resource_for - * v1.sslCertificates ==) + * An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) */ export interface Schema$SslCertificate { /** - * A local certificate file. The certificate must be in PEM format. The - * certificate chain must be no greater than 5 certs long. The chain must - * include at least one intermediate cert. + * A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. */ certificate?: string; /** @@ -9339,33 +7152,23 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#sslCertificate for SSL - * certificates. + * [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * A write-only private key in PEM format. Only insert requests will include - * this field. + * A write-only private key in PEM format. Only insert requests will include this field. */ privateKey?: string; /** @@ -9390,11 +7193,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9412,42 +7211,27 @@ export namespace compute_v1 { } export interface Schema$SSLHealthCheck { /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, SSL health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, SSL health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The application data to send once the SSL connection has been established - * (default value is empty). If both request and response are empty, the - * connection establishment alone will indicate health. The request data can - * only be ASCII. + * The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ request?: string; /** - * The bytes to match against the beginning of the response data. If left - * empty (the default value), any response will indicate health. The - * response data can only be ASCII. + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ response?: string; } @@ -9461,16 +7245,11 @@ export namespace compute_v1 { */ items?: Schema$SslPolicy[]; /** - * [Output Only] Type of the resource. Always compute#sslPoliciesList for - * lists of sslPolicies. + * [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9490,10 +7269,7 @@ export namespace compute_v1 { features?: string[]; } /** - * A SSL policy specifies the server-side support for SSL features. This can - * be attached to a TargetHttpsProxy or a TargetSslProxy. This affects - * connections between clients and the HTTPS or SSL proxy load balancer. They - * do not affect the connection between the load balancers and the backends. + * A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends. */ export interface Schema$SslPolicy { /** @@ -9501,14 +7277,11 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * A list of features enabled when the selected profile is CUSTOM. The - - * method returns the set of features that can be specified in this list. - * This field must be empty if the profile is not CUSTOM. + * A list of features enabled when the selected profile is CUSTOM. The - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. */ customFeatures?: string[]; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -9516,44 +7289,27 @@ export namespace compute_v1 { */ enabledFeatures?: string[]; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a SslPolicy. An up-to-date fingerprint must be - * provided in order to update the SslPolicy, otherwise the request will - * fail with error 412 conditionNotMet. To see the latest fingerprint, make - * a get() request to retrieve an SslPolicy. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. */ fingerprint?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output only] Type of the resource. Always compute#sslPolicyfor SSL - * policies. + * [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. */ kind?: string; /** - * The minimum version of SSL protocol that can be used by the clients to - * establish a connection with the load balancer. This can be one of - * TLS_1_0, TLS_1_1, TLS_1_2. + * The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. */ minTlsVersion?: string; /** - * Name of the resource. The name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and - * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the - * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last character, - * which cannot be a dash. + * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Profile specifies the set of SSL features that can be used by the load - * balancer when negotiating SSL with clients. This can be one of - * COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of - * SSL features to enable must be specified in the customFeatures field. + * Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. */ profile?: string; /** @@ -9561,8 +7317,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] If potential misconfigurations are detected for this SSL - * policy, this field will be populated with warning messages. + * [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. */ warnings?: Array<{ code?: string; @@ -9572,14 +7327,12 @@ export namespace compute_v1 { } export interface Schema$SslPolicyReference { /** - * URL of the SSL policy resource. Set this to empty string to clear any - * existing SSL policy associated with the target proxy resource. + * URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. */ sslPolicy?: string; } /** - * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== - * resource_for v1.subnetworks ==) + * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) */ export interface Schema$Subnetwork { /** @@ -9587,83 +7340,51 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. This field can be set only at resource creation - * time. + * An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. */ description?: string; /** - * Whether to enable flow logging for this subnetwork. If this field is not - * explicitly set, it will not appear in get listings. If not set the - * default behavior is to disable flow logging. + * Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. */ enableFlowLogs?: boolean; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a Subnetwork. An up-to-date fingerprint must be - * provided in order to update the Subnetwork, otherwise the request will - * fail with error 412 conditionNotMet. To see the latest fingerprint, make - * a get() request to retrieve a Subnetwork. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. */ fingerprint?: string; /** - * [Output Only] The gateway address for default routes to reach destination - * addresses outside this subnetwork. + * [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. */ gatewayAddress?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * The range of internal addresses that are owned by this subnetwork. - * Provide this property when you create the subnetwork. For - * example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and - * non-overlapping within a network. Only IPv4 is supported. This field can - * be set only at resource creation time. + * The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. */ ipCidrRange?: string; /** - * [Output Only] Type of the resource. Always compute#subnetwork for - * Subnetwork resources. + * [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. */ kind?: string; /** - * The name of the resource, provided by the client when initially creating - * the resource. The name must be 1-63 characters long, and comply with - * RFC1035. Specifically, the name must be 1-63 characters long and match - * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. + * The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * The URL of the network to which this subnetwork belongs, provided by the - * client when initially creating the subnetwork. Only networks that are in - * the distributed mode can have subnetworks. This field can be set only at - * resource creation time. + * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. */ network?: string; /** - * Whether the VMs in this subnet can access Google services without - * assigned external IP addresses. This field can be both set at resource - * creation time and updated using setPrivateIpGoogleAccess. + * Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. */ privateIpGoogleAccess?: boolean; /** - * URL of the region where the Subnetwork resides. This field can be set - * only at resource creation time. + * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. */ region?: string; /** - * An array of configurations for secondary IP ranges for VM instances - * contained in this subnetwork. The primary IP of such VM must belong to - * the primary ipCidrRange of the subnetwork. The alias IPs may belong to - * either primary or secondary ranges. This field can be updated with a - * patch request. + * An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. */ secondaryIpRanges?: Schema$SubnetworkSecondaryRange[]; /** @@ -9681,16 +7402,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$SubnetworksScopedList}; /** - * [Output Only] Type of resource. Always compute#subnetworkAggregatedList - * for aggregated lists of subnetworks. + * [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9719,16 +7435,11 @@ export namespace compute_v1 { */ items?: Schema$Subnetwork[]; /** - * [Output Only] Type of resource. Always compute#subnetworkList for lists - * of subnetworks. + * [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9749,26 +7460,17 @@ export namespace compute_v1 { */ export interface Schema$SubnetworkSecondaryRange { /** - * The range of IP addresses belonging to this subnetwork secondary range. - * Provide this property when you create the subnetwork. Ranges must be - * unique and non-overlapping with all primary and secondary IP ranges - * within a network. Only IPv4 is supported. + * The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. The name must be 1-63 - * characters long, and comply with RFC1035. The name must be unique within - * the subnetwork. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ rangeName?: string; } export interface Schema$SubnetworksExpandIpCidrRangeRequest { /** - * The IP (in CIDR format or netmask) of internal addresses that are legal - * on this Subnetwork. This range should be disjoint from other subnetworks - * within this network. This range can only be larger than (i.e. a superset - * of) the range previously defined before the update. + * The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. */ ipCidrRange?: string; } @@ -9778,8 +7480,7 @@ export namespace compute_v1 { */ subnetworks?: Schema$Subnetwork[]; /** - * An informational warning that appears when the list of addresses is - * empty. + * An informational warning that appears when the list of addresses is empty. */ warning?: { code?: string; @@ -9795,24 +7496,16 @@ export namespace compute_v1 { */ export interface Schema$Tags { /** - * Specifies a fingerprint for this request, which is essentially a hash of - * the tags' contents and used for optimistic locking. The fingerprint - * is initially generated by Compute Engine and changes after every request - * to modify or update tags. You must always provide an up-to-date - * fingerprint hash in order to update or change tags. To see the latest - * fingerprint, make get() request to the instance. + * Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. */ fingerprint?: string; /** - * An array of tags. Each tag must be 1-63 characters long, and comply with - * RFC1035. + * An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. */ items?: string[]; } /** - * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== - * resource_for beta.targetHttpProxies ==) (== resource_for - * v1.targetHttpProxies ==) + * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -9820,28 +7513,19 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetHttpProxy for target - * HTTP proxies. + * [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -9849,8 +7533,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * URL to the UrlMap resource that defines the mapping from URL to the - * BackendService. + * URL to the UrlMap resource that defines the mapping from URL to the BackendService. */ urlMap?: string; } @@ -9867,16 +7550,11 @@ export namespace compute_v1 { */ items?: Schema$TargetHttpProxy[]; /** - * Type of resource. Always compute#targetHttpProxyList for lists of target - * HTTP proxies. + * Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -9900,16 +7578,12 @@ export namespace compute_v1 { } export interface Schema$TargetHttpsProxiesSetSslCertificatesRequest { /** - * New set of SslCertificate resources to associate with this - * TargetHttpsProxy resource. Currently exactly one SslCertificate resource - * must be specified. + * New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified. */ sslCertificates?: string[]; } /** - * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== - * resource_for beta.targetHttpsProxies ==) (== resource_for - * v1.targetHttpsProxies ==) + * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -9917,38 +7591,23 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetHttpsProxy for - * target HTTPS proxies. + * [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the QUIC override policy for this TargetHttpsProxy resource. - * This determines whether the load balancer will attempt to negotiate QUIC - * with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify - * ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and - * disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC - * policy with no user overrides, which is equivalent to DISABLE. Not - * specifying this field is equivalent to specifying NONE. + * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. */ quicOverride?: string; /** @@ -9956,24 +7615,15 @@ export namespace compute_v1 { */ selfLink?: string; /** - * URLs to SslCertificate resources that are used to authenticate - * connections between users and the load balancer. At least one SSL - * certificate must be specified. Currently, you may specify up to 15 SSL - * certificates. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** - * URL of SslPolicy resource that will be associated with the - * TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will - * not have any SSL policy configured. + * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. */ sslPolicy?: string; /** - * A fully-qualified or valid partial URL to the UrlMap resource that - * defines the mapping from URL to the BackendService. For example, the - * following are all valid URLs for specifying a URL map: - - * https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - * - projects/project/global/urlMaps/url-map - global/urlMaps/url-map + * A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map */ urlMap?: string; } @@ -9990,16 +7640,11 @@ export namespace compute_v1 { */ items?: Schema$TargetHttpsProxy[]; /** - * Type of resource. Always compute#targetHttpsProxyList for lists of target - * HTTPS proxies. + * Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10016,9 +7661,7 @@ export namespace compute_v1 { }; } /** - * A TargetInstance resource. This resource defines an endpoint instance that - * terminates traffic of certain protocols. (== resource_for - * beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -10026,43 +7669,27 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * A URL to the virtual machine instance that handles traffic for this - * target instance. When creating a target instance, you can provide the - * fully-qualified URL or a valid partial URL to the desired virtual - * machine. For example, the following are all valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - * - projects/project/zones/zone/instances/instance - - * zones/zone/instances/instance + * A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance */ instance?: string; /** - * [Output Only] The type of the resource. Always compute#targetInstance for - * target instances. + * [Output Only] The type of the resource. Always compute#targetInstance for target instances. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * NAT option controlling how IPs are NAT'ed to the instance. Currently - * only NO_NAT (default value) is supported. + * NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. */ natPolicy?: string; /** @@ -10070,9 +7697,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] URL of the zone where the target instance resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } @@ -10090,11 +7715,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10127,11 +7748,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10153,8 +7770,7 @@ export namespace compute_v1 { */ targetInstances?: Schema$TargetInstance[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -10163,23 +7779,11 @@ export namespace compute_v1 { }; } /** - * A TargetPool resource. This resource defines a pool of instances, an - * associated HttpHealthCheck resource, and the fallback target pool. (== - * resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) */ export interface Schema$TargetPool { /** - * This field is applicable only when the containing target pool is serving - * a forwarding rule as the primary pool, and its failoverRatio field is - * properly set to a value between [0, 1]. backupPool and failoverRatio - * together define the fallback behavior of the primary target pool: if the - * ratio of the healthy instances in the primary pool is at or below - * failoverRatio, traffic arriving at the load-balanced IP will be directed - * to the backup pool. In case where failoverRatio and backupPool are not - * set, or all the instances in the backup pool are unhealthy, the traffic - * will be directed back to the primary pool in the "force" mode, - * where traffic will be spread to the healthy instances with the best - * effort, or to all instances when no instance is healthy. + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ backupPool?: string; /** @@ -10187,56 +7791,31 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * This field is applicable only when the containing target pool is serving - * a forwarding rule as the primary pool (i.e., not as a backup pool to some - * other target pool). The value of the field must be in [0, 1]. If set, - * backupPool must also be set. They together define the fallback behavior - * of the primary target pool: if the ratio of the healthy instances in the - * primary pool is at or below this number, traffic arriving at the - * load-balanced IP will be directed to the backup pool. In case where - * failoverRatio is not set or all the instances in the backup pool are - * unhealthy, the traffic will be directed back to the primary pool in the - * "force" mode, where traffic will be spread to the healthy - * instances with the best effort, or to all instances when no instance is - * healthy. + * This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. */ failoverRatio?: number; /** - * The URL of the HttpHealthCheck resource. A member instance in this pool - * is considered healthy if and only if the health checks pass. An empty - * list means all member instances will be considered healthy at all times. - * Only HttpHealthChecks are supported. Only one health check may be - * specified. + * The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified. */ healthChecks?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * A list of resource URLs to the virtual machine instances serving this - * pool. They must live in zones contained in the same region as this pool. + * A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. */ instances?: string[]; /** - * [Output Only] Type of the resource. Always compute#targetPool for target - * pools. + * [Output Only] Type of the resource. Always compute#targetPool for target pools. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -10248,13 +7827,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Session affinity option, must be one of the following values: NONE: - * Connections from the same client IP may go to any instance in the pool. - * CLIENT_IP: Connections from the same client IP will go to the same - * instance in the pool while that instance remains healthy. - * CLIENT_IP_PROTO: Connections from the same client IP with the same IP - * protocol will go to the same instance in the pool while that instance - * remains healthy. + * Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. */ sessionAffinity?: string; } @@ -10268,16 +7841,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$TargetPoolsScopedList}; /** - * [Output Only] Type of resource. Always compute#targetPoolAggregatedList - * for aggregated lists of target pools. + * [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10296,8 +7864,7 @@ export namespace compute_v1 { export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; /** - * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth - * when checking the health of an instance. + * [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. */ kind?: string; } @@ -10314,16 +7881,11 @@ export namespace compute_v1 { */ items?: Schema$TargetPool[]; /** - * [Output Only] Type of resource. Always compute#targetPoolList for lists - * of target pools. + * [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10347,21 +7909,13 @@ export namespace compute_v1 { } export interface Schema$TargetPoolsAddInstanceRequest { /** - * A full or partial URL to an instance to add to this target pool. This can - * be a full or partial URL. For example, the following are valid URLs: - - * https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name - * - projects/project-id/zones/zone/instances/instance-name - - * zones/zone/instances/instance-name + * A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name */ instances?: Schema$InstanceReference[]; } export interface Schema$TargetPoolsRemoveHealthCheckRequest { /** - * Health check URL to be removed. This can be a full or valid partial URL. - * For example, the following are valid URLs: - - * https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check - * - projects/project/global/httpHealthChecks/health-check - - * global/httpHealthChecks/health-check + * Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ healthChecks?: Schema$HealthCheckReference[]; } @@ -10377,8 +7931,7 @@ export namespace compute_v1 { */ targetPools?: Schema$TargetPool[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -10397,22 +7950,18 @@ export namespace compute_v1 { } export interface Schema$TargetSslProxiesSetProxyHeaderRequest { /** - * The new type of proxy header to append before sending data to the - * backend. NONE or PROXY_V1 are allowed. + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ proxyHeader?: string; } export interface Schema$TargetSslProxiesSetSslCertificatesRequest { /** - * New set of URLs to SslCertificate resources to associate with this - * TargetSslProxy. Currently exactly one ssl certificate must be specified. + * New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. */ sslCertificates?: string[]; } /** - * A TargetSslProxy resource. This resource defines an SSL proxy. (== - * resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies - * ==) + * A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -10420,33 +7969,23 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#targetSslProxy for - * target SSL proxies. + * [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** @@ -10458,15 +7997,11 @@ export namespace compute_v1 { */ service?: string; /** - * URLs to SslCertificate resources that are used to authenticate - * connections to Backends. At least one SSL certificate must be specified. - * Currently, you may specify up to 15 SSL certificates. + * URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** - * URL of SslPolicy resource that will be associated with the TargetSslProxy - * resource. If not set, the TargetSslProxy resource will not have any SSL - * policy configured. + * URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. */ sslPolicy?: string; } @@ -10487,11 +8022,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10515,15 +8046,12 @@ export namespace compute_v1 { } export interface Schema$TargetTcpProxiesSetProxyHeaderRequest { /** - * The new type of proxy header to append before sending data to the - * backend. NONE or PROXY_V1 are allowed. + * The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. */ proxyHeader?: string; } /** - * A TargetTcpProxy resource. This resource defines a TCP proxy. (== - * resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies - * ==) + * A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -10531,33 +8059,23 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of the resource. Always compute#targetTcpProxy for - * target TCP proxies. + * [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** @@ -10586,11 +8104,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10607,8 +8121,7 @@ export namespace compute_v1 { }; } /** - * Represents a Target VPN gateway resource. (== resource_for - * beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN gateway resource. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -10616,45 +8129,31 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * [Output Only] A list of URLs to the ForwardingRule resources. - * ForwardingRules are created using compute.forwardingRules.insert and - * associated with a VPN gateway. + * [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. */ forwardingRules?: string[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * URL of the network to which this VPN gateway is attached. Provided by the - * client when the VPN gateway is created. + * URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. */ network?: string; /** - * [Output Only] URL of the region where the target VPN gateway resides. You - * must specify this field as part of the HTTP request URL. It is not - * settable as a field in the request body. + * [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -10662,14 +8161,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The status of the VPN gateway, which can be one of the - * following: CREATING, READY, FAILED, or DELETING. + * [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. */ status?: string; /** - * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are - * created using the compute.vpntunnels.insert method and associated with a - * VPN gateway. + * [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. */ tunnels?: string[]; } @@ -10683,16 +8179,11 @@ export namespace compute_v1 { */ items?: {[key: string]: Schema$TargetVpnGatewaysScopedList}; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10721,16 +8212,11 @@ export namespace compute_v1 { */ items?: Schema$TargetVpnGateway[]; /** - * [Output Only] Type of resource. Always compute#targetVpnGateway for - * target VPN gateways. + * [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10752,8 +8238,7 @@ export namespace compute_v1 { */ targetVpnGateways?: Schema$TargetVpnGateway[]; /** - * [Output Only] Informational warning which replaces the list of addresses - * when the list is empty. + * [Output Only] Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -10763,42 +8248,27 @@ export namespace compute_v1 { } export interface Schema$TCPHealthCheck { /** - * The TCP port number for the health check request. The default value - * is 80. Valid values are 1 through 65535. + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. */ port?: number; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. */ portName?: string; /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, TCP health check follows - * behavior specified in port and portName fields. + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. */ portSpecification?: string; /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. */ proxyHeader?: string; /** - * The application data to send once the TCP connection has been established - * (default value is empty). If both request and response are empty, the - * connection establishment alone will indicate health. The request data can - * only be ASCII. + * The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII. */ request?: string; /** - * The bytes to match against the beginning of the response data. If left - * empty (the default value), any response will indicate health. The - * response data can only be ASCII. + * The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII. */ response?: string; } @@ -10810,23 +8280,18 @@ export namespace compute_v1 { } export interface Schema$TestPermissionsRequest { /** - * The set of permissions to check for the 'resource'. Permissions - * with wildcards (such as '*' or 'storage.*') are not - * allowed. + * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ permissions?: string[]; } export interface Schema$TestPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * A UrlMap resource. This resource defines the mapping from URL to the - * BackendService resource, based on the "longest-match" of the - * URL's host and path. + * A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. */ export interface Schema$UrlMap { /** @@ -10834,29 +8299,15 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * The full or partial URL of the defaultService resource to which traffic - * is directed if none of the hostRules match. If defaultRouteAction is - * additionally specified, advanced routing actions like URL Rewrites, etc. - * take effect prior to sending the request to the backend. However, if - * defaultService is specified, defaultRouteAction cannot contain any - * weightedBackendServices. Conversely, if routeAction specifies any - * weightedBackendServices, service must not be specified. Only one of - * defaultService, defaultUrlRedirect or - * defaultRouteAction.weightedBackendService must be set. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. */ defaultService?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** - * Fingerprint of this resource. A hash of the contents stored in this - * object. This field is used in optimistic locking. This field will be - * ignored when inserting a UrlMap. An up-to-date fingerprint must be - * provided in order to update the UrlMap, otherwise the request will fail - * with error 412 conditionNotMet. To see the latest fingerprint, make a - * get() request to retrieve a UrlMap. + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. */ fingerprint?: string; /** @@ -10864,8 +8315,7 @@ export namespace compute_v1 { */ hostRules?: Schema$HostRule[]; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -10873,13 +8323,7 @@ export namespace compute_v1 { */ kind?: string; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -10891,9 +8335,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * The list of expected URL mapping tests. Request to update this UrlMap - * will succeed only if all of the test cases pass. You can specify a - * maximum of 100 tests per UrlMap. + * The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. */ tests?: Schema$UrlMapTest[]; } @@ -10914,11 +8356,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -10973,20 +8411,17 @@ export namespace compute_v1 { export interface Schema$UrlMapValidationResult { loadErrors?: string[]; /** - * Whether the given UrlMap can be successfully loaded. If false, - * 'loadErrors' indicates the reasons. + * Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons. */ loadSucceeded?: boolean; testFailures?: Schema$TestFailure[]; /** - * If successfully loaded, this field indicates whether the test passed. If - * false, 'testFailures's indicate the reason of failure. + * If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure. */ testPassed?: boolean; } /** - * Subnetwork which the current user has compute.subnetworks.use permission - * on. + * Subnetwork which the current user has compute.subnetworks.use permission on. */ export interface Schema$UsableSubnetwork { /** @@ -11008,8 +8443,7 @@ export namespace compute_v1 { } export interface Schema$UsableSubnetworksAggregatedList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -11017,17 +8451,11 @@ export namespace compute_v1 { */ items?: Schema$UsableSubnetwork[]; /** - * [Output Only] Type of resource. Always - * compute#usableSubnetworksAggregatedList for aggregated lists of usable - * subnetworks. + * [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11052,33 +8480,20 @@ export namespace compute_v1 { */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. The name must be 1-63 - * characters long, and comply with RFC1035. The name must be unique within - * the subnetwork. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork. */ rangeName?: string; } /** - * The location in Cloud Storage and naming method of the daily usage report. - * Contains bucket_name and report_name prefix. + * The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. */ export interface Schema$UsageExportLocation { /** - * The name of an existing bucket in Cloud Storage where the usage report - * object is stored. The Google Service Account is granted write access to - * this bucket. This can either be the bucket name by itself, such as - * example-bucket, or the bucket name with gs:// or - * https://storage.googleapis.com/ in front of it, such as - * gs://example-bucket. + * The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. */ bucketName?: string; /** - * An optional prefix for the name of the usage report object stored in - * bucketName. If not supplied, defaults to usage. The report is stored as a - * CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the - * day of the usage according to Pacific Time. If you supply a prefix, it - * should conform to Cloud Storage object naming conventions. + * An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. */ reportNamePrefix?: string; } @@ -11097,21 +8512,15 @@ export namespace compute_v1 { */ export interface Schema$VmEndpointNatMappingsInterfaceNatMappings { /** - * A list of all IP:port-range mappings assigned to this interface. These - * ranges are inclusive, that is, both the first and the last ports can be - * used for NAT. Example: ["2.2.2.2:12345-12355", - * "1.1.1.1:2234-2234"]. + * A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ natIpPortRanges?: string[]; /** - * Total number of ports across all NAT IPs allocated to this interface. It - * equals to the aggregated port number in the field nat_ip_port_ranges. + * Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. */ numTotalNatPorts?: number; /** - * Alias IP range for this interface endpoint. It will be a private (RFC - * 1918) IP range. Examples: "10.33.4.55/32", or - * "192.168.5.0/24". + * Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24". */ sourceAliasIpRange?: string; /** @@ -11124,21 +8533,15 @@ export namespace compute_v1 { */ export interface Schema$VmEndpointNatMappingsList { /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList - * for lists of Nat mappings of VM endpoints. + * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11159,8 +8562,7 @@ export namespace compute_v1 { }; } /** - * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for - * v1.vpnTunnels ==) + * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -11168,8 +8570,7 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string; /** @@ -11177,14 +8578,11 @@ export namespace compute_v1 { */ detailedStatus?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * IKE protocol version to use when establishing the VPN tunnel with the - * peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version - * is 2. + * IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. */ ikeVersion?: number; /** @@ -11192,20 +8590,11 @@ export namespace compute_v1 { */ kind?: string; /** - * Local traffic selector to use when establishing the VPN tunnel with the - * peer VPN gateway. The value should be a CIDR formatted string, for - * example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is - * supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. */ localTrafficSelector?: string[]; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -11213,16 +8602,11 @@ export namespace compute_v1 { */ peerIp?: string; /** - * [Output Only] URL of the region where the VPN tunnel resides. You must - * specify this field as part of the HTTP request URL. It is not settable as - * a field in the request body. + * [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** - * Remote traffic selectors to use when establishing the VPN tunnel with the - * peer VPN gateway. The value should be a CIDR formatted string, for - * example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is - * supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. */ remoteTrafficSelector?: string[]; /** @@ -11234,8 +8618,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Shared secret used to set the secure session between the Cloud VPN - * gateway and the peer VPN gateway. + * Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. */ sharedSecret?: string; /** @@ -11243,23 +8626,11 @@ export namespace compute_v1 { */ sharedSecretHash?: string; /** - * [Output Only] The status of the VPN tunnel, which can be one of the - * following: - PROVISIONING: Resource is being allocated for the VPN - * tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related - * configs from the user. Network, TargetVpnGateway, VpnTunnel, - * ForwardingRule, and Route resources are needed to setup the VPN tunnel. - * - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - - * ESTABLISHED: Secure session is successfully established with the peer - * VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - - * AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - - * NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are - * being deallocated for the VPN tunnel. - FAILED: Tunnel creation has - * failed and the tunnel is not ready to be used. + * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. */ status?: string; /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. - * Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. */ targetVpnGateway?: string; } @@ -11277,11 +8648,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11314,11 +8681,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11340,8 +8703,7 @@ export namespace compute_v1 { */ vpnTunnels?: Schema$VpnTunnel[]; /** - * Informational warning which replaces the list of addresses when the list - * is empty. + * Informational warning which replaces the list of addresses when the list is empty. */ warning?: { code?: string; @@ -11359,16 +8721,11 @@ export namespace compute_v1 { */ items?: Schema$Project[]; /** - * [Output Only] Type of resource. Always compute#xpnHostList for lists of - * shared VPC hosts. + * [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11389,9 +8746,7 @@ export namespace compute_v1 { */ export interface Schema$XpnResourceId { /** - * The ID of the service resource. In the case of projects, this field - * supports project id (e.g., my-project-123) and project number (e.g. - * 12345678). + * The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). */ id?: string; /** @@ -11400,8 +8755,7 @@ export namespace compute_v1 { type?: string; } /** - * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones - * ==) Next ID: 17 + * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==) Next ID: 17 */ export interface Schema$Zone { /** @@ -11421,8 +8775,7 @@ export namespace compute_v1 { */ description?: string; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** @@ -11463,11 +8816,7 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */ nextPageToken?: string; /** @@ -11485,12 +8834,7 @@ export namespace compute_v1 { } export interface Schema$ZoneSetLabelsRequest { /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Compute - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash in order to update or - * change labels. Make a get() request to the resource to get the latest - * fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** @@ -11500,20 +8844,15 @@ export namespace compute_v1 { } export interface Schema$ZoneSetPolicyRequest { /** - * Flatten Policy to create a backwacd compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -11533,14 +8872,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -11567,8 +8904,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -11586,10 +8922,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -11687,14 +9022,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -11710,8 +9043,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // Name of the accelerator type to return. - * acceleratorType: 'my-accelerator-type', // TODO: Update placeholder - * value. + * acceleratorType: 'my-accelerator-type', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -11733,10 +9065,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -11816,22 +9147,19 @@ export namespace compute_v1 { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified - * project. + * @desc Retrieves a list of accelerator types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -11879,10 +9207,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -11972,46 +9299,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -12047,46 +9347,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -12114,14 +9387,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -12148,8 +9419,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -12167,10 +9437,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -12262,14 +9531,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -12307,10 +9574,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -12397,14 +9663,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -12442,10 +9706,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -12522,22 +9785,19 @@ export namespace compute_v1 { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project using the data - * included in the request. + * @desc Creates an address resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -12576,10 +9836,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -12659,22 +9918,19 @@ export namespace compute_v1 { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified - * region. + * @desc Retrieves a list of addresses contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -12722,10 +9978,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -12814,46 +10069,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -12880,16 +10108,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -12927,16 +10146,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -12952,46 +10162,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -13019,14 +10202,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13053,8 +10234,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -13072,10 +10252,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13167,14 +10346,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13212,10 +10389,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13296,22 +10472,19 @@ export namespace compute_v1 { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available - * autoscalers by making a list() request. + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13349,10 +10522,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13431,22 +10603,19 @@ export namespace compute_v1 { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data - * included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13485,10 +10654,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13569,22 +10737,19 @@ export namespace compute_v1 { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified - * zone. + * @desc Retrieves a list of autoscalers contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13632,10 +10797,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13717,23 +10881,19 @@ export namespace compute_v1 { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13749,8 +10909,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -13774,10 +10933,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -13859,22 +11017,19 @@ export namespace compute_v1 { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data - * included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -13890,8 +11045,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -13915,10 +11069,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14007,46 +11160,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -14070,16 +11196,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -14118,16 +11235,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -14147,46 +11255,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -14214,16 +11295,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -14252,16 +11324,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -14283,8 +11346,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this - * backend bucket. + * @desc Adds a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -14368,14 +11430,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14388,8 +11448,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to delete. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -14411,10 +11470,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14494,8 +11552,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this - * backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -14572,22 +11629,19 @@ export namespace compute_v1 { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of - * available backend buckets by making a list() request. + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14600,8 +11654,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to return. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -14623,10 +11676,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14705,22 +11757,19 @@ export namespace compute_v1 { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the - * data included in the request. + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14756,10 +11805,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14838,22 +11886,19 @@ export namespace compute_v1 { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the - * specified project. + * @desc Retrieves the list of BackendBucket resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -14898,10 +11943,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -14982,23 +12026,19 @@ export namespace compute_v1 { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included - * in the request. This method supports PATCH semantics and uses the JSON - * merge patch format and processing rules. + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15011,12 +12051,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to patch. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -15040,10 +12078,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15124,22 +12161,19 @@ export namespace compute_v1 { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included - * in the request. + * @desc Updates the specified BackendBucket resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15152,12 +12186,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendBucket resource to update. - * backendBucket: 'my-backend-bucket', // TODO: Update placeholder - * value. + * backendBucket: 'my-backend-bucket', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -15181,10 +12213,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15272,8 +12303,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendBucket resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendBucket?: string; /** @@ -15281,16 +12311,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -15315,16 +12336,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -15336,8 +12348,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendBucket resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendBucket?: string; /** @@ -15349,16 +12360,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -15390,16 +12392,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -15416,46 +12409,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -15479,16 +12445,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -15513,16 +12470,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -15540,8 +12488,7 @@ export namespace compute_v1 { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this - * backend service. + * @desc Adds a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -15618,22 +12565,19 @@ export namespace compute_v1 { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and - * global, available to the specified project. + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15660,8 +12604,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -15679,10 +12622,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15780,14 +12722,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -15800,8 +12740,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to delete. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -15823,10 +12762,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -15906,8 +12844,7 @@ export namespace compute_v1 { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this - * backend service. + * @desc Deletes a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -15984,22 +12921,19 @@ export namespace compute_v1 { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of - * available backend services. + * @desc Returns the specified BackendService resource. Gets a list of available backend services. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16012,8 +12946,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to return. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -16035,10 +12968,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16124,14 +13056,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16142,9 +13072,8 @@ export namespace compute_v1 { * var request = { * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the BackendService resource to which the queried instance - * belongs. backendService: 'my-backend-service', // TODO: Update - * placeholder value. + * // Name of the BackendService resource to which the queried instance belongs. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -16170,10 +13099,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16260,24 +13188,19 @@ export namespace compute_v1 { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using - * the data included in the request. There are several restrictions and - * guidelines to keep in mind when creating a backend service. Read - * Restrictions and Guidelines for more information. + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16313,10 +13236,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16395,22 +13317,19 @@ export namespace compute_v1 { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the - * specified project. + * @desc Retrieves the list of BackendService resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16455,10 +13374,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16539,25 +13457,19 @@ export namespace compute_v1 { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data - * included in the request. There are several restrictions and guidelines to - * keep in mind when updating a backend service. Read Restrictions and - * Guidelines for more information. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16570,12 +13482,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to patch. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -16599,10 +13509,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16760,24 +13669,19 @@ export namespace compute_v1 { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data - * included in the request. There are several restrictions and guidelines to - * keep in mind when updating a backend service. Read Restrictions and - * Guidelines for more information. + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -16790,12 +13694,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the BackendService resource to update. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -16819,10 +13721,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -16910,8 +13811,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendService?: string; /** @@ -16919,16 +13819,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -16945,46 +13836,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -17008,16 +13872,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -17029,8 +13884,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the Signed URL Key should be - * added. The name should conform to RFC1035. + * Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. */ backendService?: string; /** @@ -17042,16 +13896,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -17079,8 +13924,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the queried instance - * belongs. + * Name of the BackendService resource to which the queried instance belongs. */ backendService?: string; /** @@ -17105,16 +13949,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17131,46 +13966,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -17194,16 +14002,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17220,8 +14019,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the BackendService resource to which the security policy should - * be set. The name should conform to RFC1035. + * Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. */ backendService?: string; /** @@ -17229,16 +14027,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17263,16 +14052,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -17297,14 +14077,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17331,8 +14109,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -17350,10 +14127,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17443,14 +14219,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17492,10 +14266,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17578,24 +14351,19 @@ export namespace compute_v1 { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its - * data permanently and is irreversible. However, deleting a disk does not - * delete any snapshots previously made from the disk. You must separately - * delete snapshots. + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17633,10 +14401,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17716,22 +14483,19 @@ export namespace compute_v1 { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available - * persistent disks by making a list() request. + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17769,10 +14533,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -17849,8 +14612,7 @@ export namespace compute_v1 { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -17924,25 +14686,19 @@ export namespace compute_v1 { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data - * in the request. You can create a disk with a sourceImage, a - * sourceSnapshot, or create an empty 500 GB data disk by omitting all - * properties. You can also create a disk that is larger than the default - * size by specifying the sizeGb property. + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -17981,10 +14737,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18064,22 +14819,19 @@ export namespace compute_v1 { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified - * zone. + * @desc Retrieves a list of persistent disks contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18127,10 +14879,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18209,22 +14960,19 @@ export namespace compute_v1 { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the - * size of the disk. + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18266,10 +15014,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18350,8 +15097,7 @@ export namespace compute_v1 { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -18426,22 +15172,19 @@ export namespace compute_v1 { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -18483,10 +15226,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -18655,46 +15397,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -18722,16 +15437,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -18759,16 +15465,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -18826,16 +15523,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -18859,46 +15547,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -18925,16 +15586,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -18983,16 +15635,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -19050,14 +15693,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19084,8 +15725,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -19103,10 +15743,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19191,22 +15830,19 @@ export namespace compute_v1 { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk - * types by making a list() request. + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19244,10 +15880,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19331,14 +15966,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19386,10 +16019,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19477,46 +16109,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -19550,46 +16155,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -19617,14 +16195,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19659,10 +16235,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19748,14 +16323,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19790,10 +16363,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -19869,22 +16441,19 @@ export namespace compute_v1 { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data - * included in the request. + * @desc Creates a firewall rule in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -19920,10 +16489,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20001,22 +16569,19 @@ export namespace compute_v1 { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified - * project. + * @desc Retrieves the list of firewall rules available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20061,10 +16626,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20144,23 +16708,19 @@ export namespace compute_v1 { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20176,8 +16736,7 @@ export namespace compute_v1 { * firewall: 'my-firewall', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -20201,10 +16760,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20284,23 +16842,19 @@ export namespace compute_v1 { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the - * request. The PUT method can only update the following fields of firewall - * rule: allowed, description, sourceRanges, sourceTags, targetTags. + * @desc Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20316,8 +16870,7 @@ export namespace compute_v1 { * firewall: 'my-firewall', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -20341,10 +16894,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20438,16 +16990,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -20477,16 +17020,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -20502,46 +17036,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -20564,16 +17071,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -20597,16 +17095,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -20631,14 +17120,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20665,8 +17152,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -20684,10 +17170,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20785,14 +17270,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20808,8 +17291,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to delete. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -20831,10 +17313,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -20922,14 +17403,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -20945,8 +17424,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to return. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -20968,10 +17446,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21051,22 +17528,19 @@ export namespace compute_v1 { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and - * region using the data included in the request. + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21105,10 +17579,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21189,22 +17662,19 @@ export namespace compute_v1 { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the - * specified project and region. + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21252,10 +17722,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21338,22 +17807,19 @@ export namespace compute_v1 { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of - * the same type as the old target. + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21369,8 +17835,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource in which target is to be set. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -21396,10 +17861,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21488,46 +17952,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -21555,16 +17992,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -21604,16 +18032,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -21630,46 +18049,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -21701,16 +18093,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -21735,14 +18118,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21777,10 +18158,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21860,22 +18240,19 @@ export namespace compute_v1 { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available - * addresses by making a list() request. + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -21910,10 +18287,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -21990,22 +18366,19 @@ export namespace compute_v1 { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project using the data - * included in the request. + * @desc Creates an address resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22041,10 +18414,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22130,14 +18502,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22182,10 +18552,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22281,16 +18650,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -22322,16 +18682,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -22348,46 +18699,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -22411,14 +18735,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22431,8 +18753,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to delete. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -22454,10 +18775,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22537,22 +18857,19 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of - * available forwarding rules by making a list() request. + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22565,8 +18882,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource to return. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -22588,10 +18904,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22670,22 +18985,19 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project - * using the data included in the request. + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22721,10 +19033,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22803,22 +19114,19 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the - * specified project. + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22863,10 +19171,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -22947,22 +19254,19 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new - * target should be of the same type as the old target. + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -22975,8 +19279,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the ForwardingRule resource in which target is to be set. - * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder - * value. + * forwardingRule: 'my-forwarding-rule', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -22985,8 +19288,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.globalForwardingRules.setTarget(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.globalForwardingRules.setTarget(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -23000,10 +19305,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23099,16 +19403,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -23140,16 +19435,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -23166,46 +19452,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23229,16 +19488,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -23263,14 +19513,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23297,8 +19545,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -23316,10 +19563,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23411,14 +19657,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23450,10 +19694,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23530,22 +19773,19 @@ export namespace compute_v1 { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of - * operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23580,10 +19820,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23662,22 +19901,19 @@ export namespace compute_v1 { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified project. + * @desc Retrieves a list of Operation resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -23722,10 +19958,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -23813,46 +20048,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23900,46 +20108,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -23963,14 +20144,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24005,10 +20184,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24088,22 +20266,19 @@ export namespace compute_v1 { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of - * available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24138,10 +20313,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24219,22 +20393,19 @@ export namespace compute_v1 { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24270,10 +20441,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24352,22 +20522,19 @@ export namespace compute_v1 { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24412,10 +20579,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24496,23 +20662,19 @@ export namespace compute_v1 { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. This method supports PATCH semantics and - * uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24528,8 +20690,7 @@ export namespace compute_v1 { * healthCheck: 'my-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -24553,10 +20714,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24637,22 +20797,19 @@ export namespace compute_v1 { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the - * data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -24668,8 +20825,7 @@ export namespace compute_v1 { * healthCheck: 'my-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -24693,10 +20849,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -24792,16 +20947,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -24832,16 +20978,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24858,46 +20995,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -24921,16 +21031,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24955,16 +21056,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -24989,14 +21081,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25009,8 +21099,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to delete. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -25032,10 +21121,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25115,22 +21203,19 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of - * available HTTP health checks by making a list() request. + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25143,8 +21228,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to return. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -25166,10 +21250,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25248,22 +21331,19 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using - * the data included in the request. + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25299,10 +21379,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25381,22 +21460,19 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25441,10 +21517,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25525,23 +21600,19 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using - * the data included in the request. This method supports PATCH semantics - * and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25554,12 +21625,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to patch. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -25583,10 +21652,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25667,22 +21735,19 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using - * the data included in the request. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -25695,12 +21760,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpHealthCheck resource to update. - * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder - * value. + * httpHealthCheck: 'my-http-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -25724,10 +21787,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -25823,16 +21885,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -25864,16 +21917,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -25890,46 +21934,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -25953,16 +21970,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -25987,16 +21995,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -26021,14 +22020,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26041,8 +22038,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to delete. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -26064,10 +22060,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26147,22 +22142,19 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of - * available HTTPS health checks by making a list() request. + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26175,8 +22167,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to return. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -26198,10 +22189,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26280,22 +22270,19 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using - * the data included in the request. + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26331,10 +22318,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26414,22 +22400,19 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the - * specified project. + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26474,10 +22457,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26561,23 +22543,19 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using - * the data included in the request. This method supports PATCH semantics - * and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26590,12 +22568,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to patch. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -26619,10 +22595,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26703,22 +22678,19 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using - * the data included in the request. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -26731,12 +22703,10 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the HttpsHealthCheck resource to update. - * httpsHealthCheck: 'my-https-health-check', // TODO: Update - * placeholder value. + * httpsHealthCheck: 'my-https-health-check', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -26760,10 +22730,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -26859,16 +22828,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -26900,16 +22860,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -26926,46 +22877,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -26989,16 +22913,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -27023,16 +22938,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -27057,14 +22963,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27099,10 +23003,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27180,22 +23083,19 @@ export namespace compute_v1 { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body - * is given, clears the deprecation status instead. + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27234,10 +23134,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27317,22 +23216,19 @@ export namespace compute_v1 { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by - * making a list() request. + * @desc Returns the specified image. Gets a list of available images by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27367,10 +23263,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27445,22 +23340,19 @@ export namespace compute_v1 { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not - * deprecated. + * @desc Returns the latest image that is part of an image family and is not deprecated. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27495,10 +23387,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27575,8 +23466,7 @@ export namespace compute_v1 { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.images.getIamPolicy * @memberOf! () * @@ -27649,22 +23539,19 @@ export namespace compute_v1 { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included - * in the request. + * @desc Creates an image in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27700,10 +23587,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27782,26 +23668,19 @@ export namespace compute_v1 { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified - * project. Custom images are images you create that belong to your project. - * This method does not get any images that belong to other projects, - * including publicly-available images, like Debian 8. If you want to get a - * list of publicly-available images, use this method to make a request to - * the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -27846,10 +23725,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -27929,8 +23807,7 @@ export namespace compute_v1 { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.images.setIamPolicy * @memberOf! () * @@ -28004,22 +23881,19 @@ export namespace compute_v1 { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28058,10 +23932,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28234,16 +24107,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -28262,16 +24126,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -28342,16 +24197,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -28367,46 +24213,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -28485,33 +24304,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed - * instance group. Abandoning an instance does not delete the instance, but - * it does remove the instance from any target pools that are applied by the - * managed instance group. This method reduces the targetSize of the managed - * instance group by the number of instances that you abandon. This - * operation is marked as DONE when the action is scheduled even if the - * instances have not yet been removed from the group. You must separately - * verify the status of the abandoning action with the listmanagedinstances - * method. If the group is part of a backend service that has enabled - * connection draining, it can take up to 60 seconds after the connection - * draining duration has elapsed before the VM instance is removed or - * deleted. You can specify a maximum of 1000 instances with this method - * per request. + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28527,8 +24332,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -28537,8 +24341,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instanceGroupManagers.abandonInstances(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.abandonInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -28552,10 +24358,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28637,22 +24442,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by - * zone. + * @desc Retrieves the list of managed instance groups and groups them by zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28679,8 +24481,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -28698,10 +24499,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28792,23 +24592,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the - * instances in that group. Note that the instance group must not belong to - * a backend service. Read Deleting an instance group for more information. + * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28824,8 +24620,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -28847,10 +24642,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -28931,31 +24725,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group for - * immediate deletion. The instances are also removed from any target pools - * of which they were a member. This method reduces the targetSize of the - * managed instance group by the number of instances that you delete. This - * operation is marked as DONE when the action is scheduled even if the - * instances are still being deleted. You must separately verify the status - * of the deleting action with the listmanagedinstances method. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. You can specify a - * maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -28971,8 +24753,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -28981,8 +24762,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instanceGroupManagers.deleteInstances(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.deleteInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -28996,10 +24779,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29081,23 +24863,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance - * group. Gets a list of available managed instance groups by making a - * list() request. + * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29113,8 +24891,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -29136,10 +24913,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29221,28 +24997,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, instances in the - * group are created using the specified instance template. This operation - * is marked as DONE when the group is created even if the instances in the - * group have not yet been created. You must separately verify the status of - * the individual instances with the listmanagedinstances method. A managed - * instance group can have up to 1000 VM instances per group. Please contact - * Cloud Support if you need an increase in this limit. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29254,8 +25021,8 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // The name of the zone where you want to create the managed instance - * group. zone: 'my-zone', // TODO: Update placeholder value. + * // The name of the zone where you want to create the managed instance group. + * zone: 'my-zone', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -29281,10 +25048,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29365,22 +25131,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained - * within the specified project and zone. + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29428,10 +25191,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29516,26 +25278,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each - * instance in the list has a currentAction, which indicates the action that - * the managed instance group is performing on the instance. For example, if - * the group is still creating an instance, the currentAction is CREATING. - * If a previous action failed, the list displays the errors for that failed - * action. + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29551,14 +25306,15 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.instanceGroupManagers.listManagedInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.listManagedInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -29572,10 +25328,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29683,13 +25438,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is patched even if the instances in the group are still in the process of - * being patched. You must separately verify the status of the individual - * instances with the listManagedInstances method. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instanceGroupManagers.patch * @memberOf! () * @@ -29767,30 +25516,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately recreated. The instances are deleted and recreated using the - * current instance template for the managed instance group. This operation - * is marked as DONE when the flag is set even if the instances have not yet - * been recreated. You must separately verify the status of the recreating - * action with the listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. You can specify a maximum of 1000 - * instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29806,8 +25544,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -29816,8 +25553,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instanceGroupManagers.recreateInstances(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.recreateInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -29831,10 +25570,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -29916,35 +25654,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the - * group creates new instances using the current instance template. If you - * decrease the size, the group deletes instances. The resize operation is - * marked DONE when the resize actions are scheduled even if the group has - * not yet added or deleted any instances. You must separately verify the - * status of the creating or deleting actions with the listmanagedinstances - * method. When resizing down, the instance group arbitrarily chooses the - * order in which VMs are deleted. The group takes into account some VM - * attributes when making the selection including: + The status of the VM - * instance. + The health of the VM instance. + The instance template - * version the VM is based on. + For regional managed instance groups, the - * location of the VM instance. This list is subject to change. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -29960,13 +25682,10 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * // The number of running instances that the managed instance group - * should maintain at any given time. - * // The group automatically adds or removes instances to maintain the - * number of instances specified by + * // The number of running instances that the managed instance group should maintain at any given time. + * // The group automatically adds or removes instances to maintain the number of instances specified by * // this parameter. * size: 0, // TODO: Update placeholder value. * @@ -29990,10 +25709,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30075,23 +25793,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances - * in this group. The templates for existing instances in the group do not - * change unless you recreate them. + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30107,8 +25821,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -30117,8 +25830,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instanceGroupManagers.setInstanceTemplate(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.setInstanceTemplate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -30132,10 +25847,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30217,26 +25931,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed - * instance group are assigned. The target pools automatically apply to all - * of the instances in the managed instance group. This operation is marked - * DONE when you make the request even if the instances have not yet been - * added to their target pools. The change might take some time to apply to - * all of the instances in the group depending on the size of the group. + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30252,8 +25959,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -30262,8 +25968,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instanceGroupManagers.setTargetPools(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instanceGroupManagers.setTargetPools(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -30277,10 +25985,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -30377,16 +26084,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30407,46 +26105,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -30470,16 +26141,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30503,16 +26165,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30557,16 +26210,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30587,46 +26231,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -30646,22 +26263,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -30669,27 +26271,15 @@ export namespace compute_v1 { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -30717,16 +26307,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30755,16 +26336,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30793,23 +26365,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The number of running instances that the managed instance group should - * maintain at any given time. The group automatically adds or removes - * instances to maintain the number of instances specified by this - * parameter. + * The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. */ size?: number; /** @@ -30833,16 +26393,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30871,16 +26422,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -30902,23 +26444,19 @@ export namespace compute_v1 { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of - * the instances in the instance group must be in the same - * network/subnetwork. Read Adding instances for more information. + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -30934,8 +26472,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group where you are adding instances. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -30961,10 +26498,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31053,14 +26589,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31087,8 +26621,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -31106,10 +26639,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31198,23 +26730,19 @@ export namespace compute_v1 { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group - * are not deleted. Note that instance group must not belong to a backend - * service. Read Deleting an instance group for more information. + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31230,8 +26758,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group to delete. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -31253,10 +26780,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31337,22 +26863,19 @@ export namespace compute_v1 { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available - * instance groups by making a list() request. + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31368,8 +26891,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -31391,10 +26913,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31474,22 +26995,19 @@ export namespace compute_v1 { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the - * parameters that are included in the request. + * @desc Creates an instance group in the specified project using the parameters that are included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31528,10 +27046,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31612,22 +27129,19 @@ export namespace compute_v1 { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the - * specified project and zone. + * @desc Retrieves the list of instance groups that are located in the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31675,10 +27189,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31768,14 +27281,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31790,9 +27301,8 @@ export namespace compute_v1 { * // The name of the zone where the instance group is located. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the instance group from which you want to generate a - * list of included instances. instanceGroup: 'my-instance-group', // TODO: - * Update placeholder value. + * // The name of the instance group from which you want to generate a list of included instances. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -31831,10 +27341,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -31926,25 +27435,19 @@ export namespace compute_v1 { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, - * but does not delete those instances. If the group is part of a backend - * service that has enabled connection draining, it can take up to 60 - * seconds after the connection draining duration before the VM instance is - * removed or deleted. + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -31959,9 +27462,8 @@ export namespace compute_v1 { * // The name of the zone where the instance group is located. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the instance group where the specified instances will - * be removed. instanceGroup: 'my-instance-group', // TODO: Update - * placeholder value. + * // The name of the instance group where the specified instances will be removed. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -31970,8 +27472,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instanceGroups.removeInstances(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.instanceGroups.removeInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -31985,10 +27489,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32077,14 +27580,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32100,8 +27601,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // The name of the instance group where the named ports are updated. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -32127,10 +27627,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32227,16 +27726,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -32257,46 +27747,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -32320,16 +27783,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -32369,16 +27823,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -32399,46 +27844,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -32458,51 +27876,23 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The name of the instance group from which you want to generate a list of - * included instances. + * The name of the instance group from which you want to generate a list of included instances. */ instanceGroup?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -32527,8 +27917,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the instance group where the specified instances will be - * removed. + * The name of the instance group where the specified instances will be removed. */ instanceGroup?: string; /** @@ -32536,16 +27925,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -32574,16 +27954,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -32612,14 +27983,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32664,10 +28033,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32750,22 +28118,19 @@ export namespace compute_v1 { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project - * across all regions and zones. + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32792,8 +28157,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -32811,10 +28175,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -32899,24 +28262,19 @@ export namespace compute_v1 { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first - * create the disk before you can attach it. It is not possible to create - * and attach a disk at the same time. For more information, read Adding a - * persistent disk to your instance. + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -32958,10 +28316,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33044,22 +28401,19 @@ export namespace compute_v1 { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see - * Stopping or Deleting an Instance. + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33097,10 +28451,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33187,14 +28540,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33238,10 +28589,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33337,14 +28687,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33385,10 +28733,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33470,22 +28817,19 @@ export namespace compute_v1 { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available - * instances by making a list() request. + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33523,10 +28867,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33603,8 +28946,7 @@ export namespace compute_v1 { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -33678,22 +29020,19 @@ export namespace compute_v1 { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified - * instance. + * @desc Returns the last 1 MB of serial port output from the specified instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33714,8 +29053,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instances.getSerialPortOutput(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.instances.getSerialPortOutput(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -33729,10 +29070,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -33896,22 +29236,19 @@ export namespace compute_v1 { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the - * data included in the request. + * @desc Creates an instance resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -33950,10 +29287,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34033,22 +29369,19 @@ export namespace compute_v1 { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified - * zone. + * @desc Retrieves the list of instances contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34096,10 +29429,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34180,9 +29512,7 @@ export namespace compute_v1 { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the - * specified zone. For more information, read Viewing Referrers to VM - * Instances. + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. * @alias compute.instances.listReferrers * @memberOf! () * @@ -34266,23 +29596,19 @@ export namespace compute_v1 { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does - * not do a graceful shutdown. For more information, see Resetting an - * instance. + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34320,10 +29646,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34410,14 +29735,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34438,8 +29761,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instances.setDeletionProtection(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instances.setDeletionProtection(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -34453,10 +29778,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34547,14 +29871,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34598,10 +29920,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34690,8 +30011,7 @@ export namespace compute_v1 { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -34766,22 +30086,19 @@ export namespace compute_v1 { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34823,10 +30140,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -34908,22 +30224,19 @@ export namespace compute_v1 { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped - * instance to the values specified in the request. + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -34948,8 +30261,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instances.setMachineResources(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.instances.setMachineResources(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -34963,10 +30278,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35048,22 +30362,19 @@ export namespace compute_v1 { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type - * specified in the request. + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35105,10 +30416,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35190,22 +30500,19 @@ export namespace compute_v1 { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in - * the request. + * @desc Sets metadata for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35247,10 +30554,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35332,23 +30638,19 @@ export namespace compute_v1 { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. - * This method can only be called on a stopped instance. For more - * information, read Specifying a Minimum CPU Platform. + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35390,10 +30692,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35482,14 +30783,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35531,10 +30830,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35616,22 +30914,19 @@ export namespace compute_v1 { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, - * read Changing the service account and access scopes for an instance. + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35673,10 +30968,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -35758,10 +31052,7 @@ export namespace compute_v1 { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You - * can only use this method on a running instance. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -35841,22 +31132,19 @@ export namespace compute_v1 { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included - * in the request. + * @desc Sets network tags for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -35898,10 +31186,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36061,22 +31348,19 @@ export namespace compute_v1 { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop - * method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -36114,10 +31398,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36197,22 +31480,19 @@ export namespace compute_v1 { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop - * method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -36237,8 +31517,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.instances.startWithEncryptionKey(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.instances.startWithEncryptionKey(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -36252,10 +31534,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36339,26 +31620,19 @@ export namespace compute_v1 { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you - * to restart the instance at a later time. Stopped instances do not incur - * VM usage charges while they are stopped. However, resources that the VM - * is using, such as persistent disks and static IP addresses, will continue - * to be charged until they are deleted. For more information, see Stopping - * an instance. + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -36396,10 +31670,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -36560,10 +31833,7 @@ export namespace compute_v1 { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network - * interface with the data included in the request. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateAccessConfig * @memberOf! () * @@ -36642,8 +31912,7 @@ export namespace compute_v1 { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH - * semantics. + * @desc Updates an instance's network interface. This method follows PATCH semantics. * @alias compute.instances.updateNetworkInterface * @memberOf! () * @@ -36724,9 +31993,7 @@ export namespace compute_v1 { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only - * use this method on a stopped instance. This method supports PATCH - * semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -36825,16 +32092,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36855,46 +32113,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -36910,8 +32141,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to force attach the disk even if it's currently attached to - * another instance. + * Whether to force attach the disk even if it's currently attached to another instance. */ forceAttach?: boolean; /** @@ -36923,16 +32153,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -36960,16 +32181,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37001,16 +32213,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37026,8 +32229,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The device name of the disk to detach. Make a get() request on the - * instance to view currently attached disks and device names. + * The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. */ deviceName?: string; /** @@ -37039,16 +32241,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37115,11 +32308,7 @@ export namespace compute_v1 { */ project?: string; /** - * Returns output starting from a specific byte position. Use this to page - * through output when the output is too large to return in a single - * request. For the initial request, leave this field unspecified. For - * subsequent calls, this field should be set to the next value returned in - * the previous call. + * Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call. */ start?: string; /** @@ -37158,25 +32347,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Specifies instance template to create the instance. This field is - * optional. It can be a full or partial URL. For example, the following are - * all valid URLs to an instance template: - - * https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - * - projects/project/global/instanceTemplates/instanceTemplate - - * global/instanceTemplates/instanceTemplate + * Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate */ sourceInstanceTemplate?: string; /** @@ -37196,46 +32371,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -37255,51 +32403,23 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * Name of the target instance scoping this request, or '-' if the request - * should span over all instances in the container. + * Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. */ instance?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -37326,16 +32446,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37359,16 +32470,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37392,8 +32494,7 @@ export namespace compute_v1 { */ autoDelete?: boolean; /** - * The device name of the disk to modify. Make a get() request on the - * instance to view currently attached disks and device names. + * The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. */ deviceName?: string; /** @@ -37405,16 +32506,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37463,16 +32555,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37501,16 +32584,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37539,16 +32613,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37577,16 +32642,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37615,16 +32671,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37653,16 +32700,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37691,16 +32729,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37729,16 +32758,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37767,16 +32787,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37824,16 +32835,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37857,16 +32859,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37894,16 +32887,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37956,16 +32940,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -37998,16 +32973,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -38036,16 +33002,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -38067,23 +33024,19 @@ export namespace compute_v1 { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance - * template is permanent and cannot be undone. It is not possible to delete - * templates that are already in use by a managed instance group. + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38096,8 +33049,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // The name of the instance template to delete. - * instanceTemplate: 'my-instance-template', // TODO: Update - * placeholder value. + * instanceTemplate: 'my-instance-template', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -38119,10 +33071,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38202,22 +33153,19 @@ export namespace compute_v1 { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available - * instance templates by making a list() request. + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38230,8 +33178,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // The name of the instance template. - * instanceTemplate: 'my-instance-template', // TODO: Update - * placeholder value. + * instanceTemplate: 'my-instance-template', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -38253,10 +33200,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38335,8 +33281,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -38409,25 +33354,19 @@ export namespace compute_v1 { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the - * data that is included in the request. If you are creating a new template - * to update an existing instance group, your new instance template must use - * the same network or, if applicable, the same subnetwork as the original - * template. + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38463,10 +33402,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38546,22 +33484,19 @@ export namespace compute_v1 { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within - * the specified project. + * @desc Retrieves a list of instance templates that are contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -38606,10 +33541,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -38693,8 +33627,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -38863,16 +33796,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -38920,16 +33844,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -38946,46 +33861,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -39051,14 +33939,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39085,14 +33971,12 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { * request.pageToken = response.nextPageToken; - * compute.interconnectAttachments.aggregatedList(request, - * handlePage); + * compute.interconnectAttachments.aggregatedList(request, handlePage); * } * }; * @@ -39105,10 +33989,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39214,14 +34097,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39237,14 +34118,15 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the interconnect attachment to delete. - * interconnectAttachment: 'my-interconnect-attachment', // TODO: - * Update placeholder value. + * interconnectAttachment: 'my-interconnect-attachment', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.interconnectAttachments.delete(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.interconnectAttachments.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -39258,10 +34140,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39349,14 +34230,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39372,8 +34251,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the interconnect attachment to return. - * interconnectAttachment: 'my-interconnect-attachment', // TODO: - * Update placeholder value. + * interconnectAttachment: 'my-interconnect-attachment', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -39395,10 +34273,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39480,22 +34357,19 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using - * the data included in the request. + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39517,8 +34391,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.interconnectAttachments.insert(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.interconnectAttachments.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -39532,10 +34408,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39616,22 +34491,19 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the - * specified region. + * @desc Retrieves the list of interconnect attachments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -39679,10 +34551,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -39772,9 +34643,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -39859,46 +34728,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -39926,16 +34768,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -39975,16 +34808,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -40001,46 +34825,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -40072,16 +34869,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -40099,22 +34887,19 @@ export namespace compute_v1 { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a - * list of available interconnect locations by making a list() request. + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40127,8 +34912,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the interconnect location to return. - * interconnectLocation: 'my-interconnect-location', // TODO: Update - * placeholder value. + * interconnectLocation: 'my-interconnect-location', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -40150,10 +34934,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40234,22 +35017,19 @@ export namespace compute_v1 { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the - * specified project. + * @desc Retrieves the list of interconnect locations available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40294,10 +35074,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40404,46 +35183,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -40467,14 +35219,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40509,10 +35259,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40592,22 +35341,19 @@ export namespace compute_v1 { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available - * interconnects by making a list() request. + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40642,10 +35388,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40810,22 +35555,19 @@ export namespace compute_v1 { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data - * included in the request. + * @desc Creates a Interconnect in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -40861,10 +35603,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -40943,22 +35684,19 @@ export namespace compute_v1 { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified - * project. + * @desc Retrieves the list of interconnect available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41003,10 +35741,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41087,23 +35824,19 @@ export namespace compute_v1 { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41119,8 +35852,7 @@ export namespace compute_v1 { * interconnect: 'my-interconnect', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -41144,10 +35876,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41243,16 +35974,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -41300,16 +36022,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -41326,46 +36039,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -41389,16 +36075,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -41416,8 +36093,7 @@ export namespace compute_v1 { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across - * all projects that have permissions to read the License Code. + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. * @alias compute.licenseCodes.get * @memberOf! () * @@ -41697,14 +36373,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -41739,10 +36413,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -41818,8 +36491,7 @@ export namespace compute_v1 { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -41966,12 +36638,7 @@ export namespace compute_v1 { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. - * This method does not get any licenses that belong to other projects, - * including licenses attached to publicly-available images, like Debian 9. - * If you want to get a list of publicly-available licenses, use this method - * to make a request to the respective image project, such as debian-cloud - * or windows-cloud. + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.licenses.list * @memberOf! () * @@ -42049,8 +36716,7 @@ export namespace compute_v1 { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -42218,16 +36884,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -42273,16 +36930,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -42298,46 +36946,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -42403,14 +37024,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42437,8 +37056,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -42456,10 +37074,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42547,22 +37164,19 @@ export namespace compute_v1 { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available - * machine types by making a list() request. + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42600,10 +37214,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42682,22 +37295,19 @@ export namespace compute_v1 { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified - * project. + * @desc Retrieves a list of machine types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -42745,10 +37355,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -42838,46 +37447,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -42912,46 +37494,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -42972,8 +37527,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by - * zone. + * @desc Retrieves the list of network endpoint groups and sorts them by zone. * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -43060,8 +37614,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network - * endpoint group. + * @desc Attach a list of network endpoints to the specified network endpoint group. * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -43141,10 +37694,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints - * in the NEG and the VM instances they belong to are not terminated when - * the NEG is deleted. Note that the NEG cannot be deleted if there are - * backend services referencing it. + * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. * @alias compute.networkEndpointGroups.delete * @memberOf! () * @@ -43221,8 +37771,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network - * endpoint group. + * @desc Detach a list of network endpoints from the specified network endpoint group. * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -43302,8 +37851,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of - * available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -43381,8 +37929,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the - * parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -43459,8 +38006,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in - * the specified project and zone. + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -43541,8 +38087,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint - * group. + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -43734,46 +38279,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -43789,8 +38307,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are attaching network - * endpoints to. It should comply with RFC1035. + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -43798,21 +38315,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -43829,8 +38336,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group to delete. It should comply with - * RFC1035. + * The name of the network endpoint group to delete. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -43838,21 +38344,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -43864,8 +38360,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the network endpoint group where you are removing network - * endpoints. It should comply with RFC1035. + * The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** @@ -43873,21 +38368,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -43912,8 +38397,7 @@ export namespace compute_v1 { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -43929,21 +38413,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * The name of the zone where you want to create the network endpoint group. - * It should comply with RFC1035. + * The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. */ zone?: string; @@ -43960,46 +38434,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44007,8 +38454,7 @@ export namespace compute_v1 { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; } @@ -44020,51 +38466,23 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * The name of the network endpoint group from which you want to generate a - * list of included network endpoints. It should comply with RFC1035. + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. */ networkEndpointGroup?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44072,8 +38490,7 @@ export namespace compute_v1 { */ project?: string; /** - * The name of the zone where the network endpoint group is located. It - * should comply with RFC1035. + * The name of the zone where the network endpoint group is located. It should comply with RFC1035. */ zone?: string; @@ -44123,14 +38540,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -44169,10 +38584,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -44260,14 +38674,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -44302,10 +38714,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -44384,22 +38795,19 @@ export namespace compute_v1 { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by - * making a list() request. + * @desc Returns the specified network. Gets a list of available networks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -44434,10 +38842,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -44513,22 +38920,19 @@ export namespace compute_v1 { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included - * in the request. + * @desc Creates a network in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -44564,10 +38968,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -44652,14 +39055,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -44704,10 +39105,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -44787,23 +39187,19 @@ export namespace compute_v1 { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the - * request. Only the following fields can be modified: - * routingConfig.routingMode. + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -44819,8 +39215,7 @@ export namespace compute_v1 { * network: 'my-network', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -44844,10 +39239,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -44934,14 +39328,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -44980,10 +39372,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -45064,22 +39455,19 @@ export namespace compute_v1 { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet - * mode. + * @desc Switches the network mode from auto subnet mode to custom subnet mode. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -45114,10 +39502,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -45212,16 +39599,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -45245,16 +39623,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -45284,16 +39653,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -45309,46 +39669,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -45371,16 +39704,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -45405,16 +39729,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -45439,16 +39754,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -45539,8 +39845,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use - * nodeGroups.listNodes for more details about each group. + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -45776,9 +40081,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups - * by making a list() request. Note: the "nodes" field should not be used. - * Use nodeGroups.listNodes instead. + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -45853,8 +40156,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -45928,8 +40230,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the - * data included in the request. + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. * @alias compute.nodeGroups.insert * @memberOf! () * @@ -46006,8 +40307,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. - * Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -46164,8 +40464,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -46414,16 +40713,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -46444,46 +40734,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -46507,16 +40770,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -46540,16 +40794,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -46617,16 +40862,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -46646,46 +40882,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -46705,30 +40914,11 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** @@ -46736,19 +40926,11 @@ export namespace compute_v1 { */ nodeGroup?: string; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -46801,16 +40983,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -47019,8 +41192,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node - * templates by making a list() request. + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. * @alias compute.nodeTemplates.get * @memberOf! () * @@ -47096,8 +41268,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -47171,8 +41342,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the - * data included in the request. + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -47249,8 +41419,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified - * project. + * @desc Retrieves a list of node templates available to the specified project. * @alias compute.nodeTemplates.list * @memberOf! () * @@ -47329,8 +41498,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -47493,46 +41661,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47560,16 +41701,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -47629,16 +41761,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -47655,46 +41778,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47846,8 +41942,7 @@ export namespace compute_v1 { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node - * types by making a list() request. + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. * @alias compute.nodeTypes.get * @memberOf! () * @@ -48004,46 +42099,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -48077,46 +42145,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -48144,14 +42185,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48183,10 +42222,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48264,22 +42302,19 @@ export namespace compute_v1 { /** * compute.projects.disableXpnResource - * @desc Disable a serivce resource (a.k.a service project) associated with - * this host project. + * @desc Disable a serivce resource (a.k.a service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48315,10 +42350,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48404,14 +42438,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48443,10 +42475,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48524,23 +42555,19 @@ export namespace compute_v1 { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, - * so that subnets in the host project can be used by instances in the - * service project. + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48576,10 +42603,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48665,14 +42691,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48704,10 +42728,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48782,22 +42805,19 @@ export namespace compute_v1 { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be - * empty if no link exists. + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48829,10 +42849,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -48907,22 +42926,19 @@ export namespace compute_v1 { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this - * host project. + * @desc Gets service resources (a.k.a service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -48948,8 +42964,8 @@ export namespace compute_v1 { * return; * } * for (var i = 0; i < resourcesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `resourcesPage`: console.log(JSON.stringify(resourcesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `resourcesPage`: + * console.log(JSON.stringify(resourcesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -48967,10 +42983,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49055,22 +43070,19 @@ export namespace compute_v1 { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an - * organization. + * @desc Lists all shared VPC host projects visible to the user in an organization. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49119,10 +43131,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49211,14 +43222,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49254,10 +43263,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49337,22 +43345,19 @@ export namespace compute_v1 { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone - * to another. + * @desc Moves an instance and its attached persistent disks from one zone to another. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49388,10 +43393,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49470,22 +43474,19 @@ export namespace compute_v1 { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project - * using the data included in the request. + * @desc Sets metadata common to all instances within the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49504,8 +43505,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.projects.setCommonInstanceMetadata(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.projects.setCommonInstanceMetadata(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -49519,10 +43522,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49604,9 +43606,7 @@ export namespace compute_v1 { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network - * tier is used when an address/forwardingRule/instance is created without - * specifying the network tier field. + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -49683,23 +43683,19 @@ export namespace compute_v1 { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket - * where reports are stored. If you provide an empty request body using this - * method, the usage export feature will be disabled. + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -49718,8 +43714,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.projects.setUsageExportBucket(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.projects.setUsageExportBucket(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -49733,10 +43731,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -49828,16 +43825,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -49853,16 +43841,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -49883,16 +43862,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -49908,16 +43878,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -49957,46 +43918,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50012,46 +43946,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50076,16 +43983,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50106,16 +44004,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50136,16 +44025,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50166,16 +44046,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50196,16 +44067,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -50230,14 +44092,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50275,10 +44135,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50366,14 +44225,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50411,10 +44268,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50494,22 +44350,19 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data - * included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50548,10 +44401,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50632,22 +44484,19 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified - * region. + * @desc Retrieves a list of autoscalers contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50695,10 +44544,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50783,23 +44631,19 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data - * included in the request. This method supports PATCH semantics and uses - * the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50815,8 +44659,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -50840,10 +44683,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -50925,22 +44767,19 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data - * included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -50956,8 +44795,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -50981,10 +44819,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -51085,16 +44922,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -51134,16 +44962,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -51160,46 +44979,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -51231,16 +45023,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -51269,16 +45052,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -51303,14 +45077,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -51326,8 +45098,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to delete. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -51349,10 +45120,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -51440,14 +45210,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -51463,8 +45231,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to return. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -51486,10 +45253,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -51569,22 +45335,19 @@ export namespace compute_v1 { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional - * BackendService. + * @desc Gets the most recent health check results for this regional BackendService. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -51598,9 +45361,8 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the BackendService resource to which the queried instance - * belongs. backendService: 'my-backend-service', // TODO: Update - * placeholder value. + * // Name of the BackendService resource to which the queried instance belongs. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -51609,8 +45371,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionBackendServices.getHealth(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionBackendServices.getHealth(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -51624,10 +45388,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -51715,24 +45478,19 @@ export namespace compute_v1 { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project - * using the data included in the request. There are several restrictions - * and guidelines to keep in mind when creating a regional backend service. - * Read Restrictions and Guidelines for more information. + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -51771,10 +45529,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -51855,22 +45612,19 @@ export namespace compute_v1 { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available - * to the specified project in the given region. + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -51918,10 +45672,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52004,26 +45757,19 @@ export namespace compute_v1 { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the - * data included in the request. There are several restrictions and - * guidelines to keep in mind when updating a backend service. Read - * Restrictions and Guidelines for more information. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52039,12 +45785,10 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to patch. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -52068,10 +45812,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52153,24 +45896,19 @@ export namespace compute_v1 { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the - * data included in the request. There are several restrictions and - * guidelines to keep in mind when updating a backend service. Read - * Restrictions and Guidelines for more information. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52186,12 +45924,10 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the BackendService resource to update. - * backendService: 'my-backend-service', // TODO: Update placeholder - * value. + * backendService: 'my-backend-service', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -52215,10 +45951,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52319,16 +46054,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -52393,16 +46119,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -52419,46 +46136,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -52490,16 +46180,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -52528,16 +46209,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -52562,14 +46234,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52596,8 +46266,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -52615,10 +46284,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52703,22 +46371,19 @@ export namespace compute_v1 { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available - * commitments by making a list() request. + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52756,10 +46421,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52839,22 +46503,19 @@ export namespace compute_v1 { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data - * included in the request. + * @desc Creates a commitment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -52893,10 +46554,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -52977,22 +46637,19 @@ export namespace compute_v1 { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified - * region. + * @desc Retrieves a list of commitments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -53040,10 +46697,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -53133,46 +46789,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -53216,16 +46845,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -53242,46 +46862,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -53380,10 +46973,7 @@ export namespace compute_v1 { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional - * disk removes all the replicas of its data permanently and is - * irreversible. However, deleting a disk does not delete any snapshots - * previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.regionDisks.delete * @memberOf! () * @@ -53533,8 +47123,7 @@ export namespace compute_v1 { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using - * the data included in the request. + * @desc Creates a persistent regional disk in the specified project using the data included in the request. * @alias compute.regionDisks.insert * @memberOf! () * @@ -53611,8 +47200,7 @@ export namespace compute_v1 { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the - * specified region. + * @desc Retrieves the list of persistent disks contained within the specified region. * @alias compute.regionDisks.list * @memberOf! () * @@ -53943,16 +47531,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -53981,16 +47560,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -54029,16 +47599,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54058,46 +47619,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -54129,16 +47663,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -54163,16 +47688,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -54219,8 +47735,7 @@ export namespace compute_v1 { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available - * disk types by making a list() request. + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -54294,8 +47809,7 @@ export namespace compute_v1 { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified - * project. + * @desc Retrieves a list of regional disk types available to the specified project. * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -54401,46 +47915,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -54461,33 +47948,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the - * managed instance group. Abandoning an instance does not delete the - * instance, but it does remove the instance from any target pools that are - * applied by the managed instance group. This method reduces the targetSize - * of the managed instance group by the number of instances that you - * abandon. This operation is marked as DONE when the action is scheduled - * even if the instances have not yet been removed from the group. You must - * separately verify the status of the abandoning action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -54503,8 +47976,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -54513,8 +47985,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.abandonInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.abandonInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -54528,10 +48002,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -54613,22 +48086,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the - * instances in that group. + * @desc Deletes the specified managed instance group and all of the instances in that group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -54644,14 +48114,15 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.delete(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -54665,10 +48136,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -54749,32 +48219,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately deleted. The instances are also removed from any target pools - * of which they were a member. This method reduces the targetSize of the - * managed instance group by the number of instances that you delete. The - * deleteInstances operation is marked DONE if the deleteInstances request - * is successful. The underlying actions take additional time. You must - * separately verify the status of the deleting action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -54790,8 +48247,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -54800,8 +48256,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.deleteInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.deleteInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -54815,10 +48273,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -54900,22 +48357,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance - * group. + * @desc Returns all of the details about the specified managed instance group. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -54931,14 +48385,15 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group to return. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.get(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -54952,10 +48407,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -55037,27 +48491,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, instances in the - * group are created using the specified instance template. This operation - * is marked as DONE when the group is created even if the instances in the - * group have not yet been created. You must separately verify the status of - * the individual instances with the listmanagedinstances method. A - * regional managed instance group can contain up to 2000 instances. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -55079,8 +48525,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.insert(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -55094,10 +48542,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -55178,22 +48625,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained - * within the specified region. + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -55241,10 +48685,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -55336,23 +48779,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances - * that are scheduled to be created. The list includes any current actions - * that the group has scheduled for its instances. + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -55368,14 +48807,15 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.listManagedInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.listManagedInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -55389,10 +48829,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -55500,13 +48939,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you - * specify in the request. This operation is marked as DONE when the group - * is patched even if the instances in the group are still in the process of - * being patched. You must separately verify the status of the individual - * instances with the listmanagedinstances method. This method supports - * PATCH semantics and uses the JSON merge patch format and processing - * rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * @@ -55584,30 +49017,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be - * immediately recreated. The instances are deleted and recreated using the - * current instance template for the managed instance group. This operation - * is marked as DONE when the flag is set even if the instances have not yet - * been recreated. You must separately verify the status of the recreating - * action with the listmanagedinstances method. If the group is part of a - * backend service that has enabled connection draining, it can take up to - * 60 seconds after the connection draining duration has elapsed before the - * VM instance is removed or deleted. You can specify a maximum of 1000 - * instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -55623,8 +49045,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -55633,8 +49054,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.recreateInstances(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.recreateInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -55648,10 +49071,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -55733,30 +49155,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you - * increase the size, the group creates new instances using the current - * instance template. If you decrease the size, the group deletes one or - * more instances. The resize operation is marked DONE if the resize - * request is successful. The underlying actions take additional time. You - * must separately verify the status of the creating or deleting actions - * with the listmanagedinstances method. If the group is part of a backend - * service that has enabled connection draining, it can take up to 60 - * seconds after the connection draining duration has elapsed before the VM - * instance is removed or deleted. + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -55772,17 +49183,18 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * // Number of instances that should exist in this instance group - * manager. size: 0, // TODO: Update placeholder value. + * // Number of instances that should exist in this instance group manager. + * size: 0, // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.resize(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.resize(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -55796,10 +49208,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -55881,22 +49292,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or - * recreating instances in this group. Existing instances are not affected. + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -55912,8 +49320,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // The name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -55922,8 +49329,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setInstanceTemplate(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.setInstanceTemplate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -55937,10 +49346,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -56022,22 +49430,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group - * are assigned. Existing instances in the group are not affected. + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -56053,8 +49458,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update - * placeholder value. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -56063,8 +49467,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setTargetPools(request, - * function(err, response) { if (err) { console.error(err); return; + * compute.regionInstanceGroupManagers.setTargetPools(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -56078,10 +49484,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -56182,16 +49587,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56220,16 +49616,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -56253,16 +49640,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56307,16 +49685,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56333,46 +49702,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -56392,22 +49734,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -56415,27 +49742,15 @@ export namespace compute_v1 { */ instanceGroupManager?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ order_by?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -56467,16 +49782,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56505,16 +49811,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56543,16 +49840,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -56580,16 +49868,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56618,16 +49897,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -56652,14 +49922,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -56675,8 +49943,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the instance group resource to return. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -56698,10 +49965,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -56781,22 +50047,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the - * specified region. + * @desc Retrieves the list of instance group resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -56844,10 +50107,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -56932,24 +50194,19 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays - * information about the named ports. Depending on the specified options, - * this method can list all instances or only the instances that are - * running. + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -56964,9 +50221,8 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the regional instance group for which we want to list the - * instances. instanceGroup: 'my-instance-group', // TODO: Update - * placeholder value. + * // Name of the regional instance group for which we want to list the instances. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -57005,10 +50261,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57109,14 +50364,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57131,9 +50384,8 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // The name of the regional instance group where the named ports are - * updated. instanceGroup: 'my-instance-group', // TODO: Update placeholder - * value. + * // The name of the regional instance group where the named ports are updated. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -57142,8 +50394,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.regionInstanceGroups.setNamedPorts(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.regionInstanceGroups.setNamedPorts(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -57157,10 +50411,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57269,46 +50522,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -57328,51 +50554,23 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * Name of the regional instance group for which we want to list the - * instances. + * Name of the regional instance group for which we want to list the instances. */ instanceGroup?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -57397,8 +50595,7 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the regional instance group where the named ports are - * updated. + * The name of the regional instance group where the named ports are updated. */ instanceGroup?: string; /** @@ -57410,16 +50607,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -57444,14 +50632,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57486,10 +50672,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57574,14 +50759,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57619,10 +50802,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57702,22 +50884,19 @@ export namespace compute_v1 { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified region. + * @desc Retrieves a list of Operation resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -57765,10 +50944,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -57898,46 +51076,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -57958,22 +51109,19 @@ export namespace compute_v1 { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available - * regions by making a list() request. + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58008,10 +51156,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58086,22 +51233,19 @@ export namespace compute_v1 { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified - * project. + * @desc Retrieves the list of region resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58146,10 +51290,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58251,46 +51394,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -58314,14 +51430,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58348,8 +51462,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -58367,10 +51480,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58462,14 +51574,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58507,10 +51617,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58590,22 +51699,19 @@ export namespace compute_v1 { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available - * routers by making a list() request. + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58643,10 +51749,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58817,14 +51922,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -58862,10 +51965,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -58949,22 +52051,19 @@ export namespace compute_v1 { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using - * the data included in the request. + * @desc Creates a Router resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59003,10 +52102,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59086,22 +52184,19 @@ export namespace compute_v1 { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified - * project. + * @desc Retrieves a list of Router resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59149,10 +52244,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59234,23 +52328,19 @@ export namespace compute_v1 { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the - * request. This method supports PATCH semantics and uses JSON merge patch - * format and processing rules. + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59269,8 +52359,7 @@ export namespace compute_v1 { * router: 'my-router', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -59294,10 +52383,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59378,22 +52466,19 @@ export namespace compute_v1 { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update - * operations. Calling this method does NOT create or update the router. + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59435,10 +52520,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59522,22 +52606,19 @@ export namespace compute_v1 { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the - * request. + * @desc Updates the specified Router resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -59556,8 +52637,7 @@ export namespace compute_v1 { * router: 'my-router', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -59581,10 +52661,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -59672,46 +52751,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -59734,16 +52786,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -59778,46 +52821,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -59829,8 +52845,7 @@ export namespace compute_v1 { */ region?: string; /** - * Name of the Router resource to query for Nat Mapping information of VM - * endpoints. + * Name of the Router resource to query for Nat Mapping information of VM endpoints. */ router?: string; } @@ -59869,16 +52884,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -59894,46 +52900,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -59960,16 +52939,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -60021,16 +52991,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -60059,14 +53020,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60101,10 +53060,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60182,22 +53140,19 @@ export namespace compute_v1 { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available - * routes by making a list() request. + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60232,10 +53187,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60310,22 +53264,19 @@ export namespace compute_v1 { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data - * included in the request. + * @desc Creates a Route resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60361,10 +53312,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60442,22 +53392,19 @@ export namespace compute_v1 { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified - * project. + * @desc Retrieves the list of Route resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -60502,10 +53449,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -60595,16 +53541,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -60638,16 +53575,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -60663,46 +53591,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -61022,8 +53923,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data - * included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. * @alias compute.securityPolicies.insert * @memberOf! () * @@ -61098,8 +53998,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified - * project. + * @desc List all the policies that have been configured for the specified project. * @alias compute.securityPolicies.list * @memberOf! () * @@ -61438,16 +54337,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -61503,16 +54393,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -61529,46 +54410,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -61588,16 +54442,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -61664,25 +54509,19 @@ export namespace compute_v1 { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting - * a single snapshot might not necessarily delete all the data on that - * snapshot. If any data on the snapshot that is marked for deletion is - * needed for subsequent snapshots, the data will be moved to the next - * corresponding snapshot. For more information, see Deleting snapshots. + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -61717,10 +54556,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -61799,22 +54637,19 @@ export namespace compute_v1 { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available - * snapshots by making a list() request. + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -61849,10 +54684,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -61928,8 +54762,7 @@ export namespace compute_v1 { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -62002,22 +54835,19 @@ export namespace compute_v1 { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the - * specified project. + * @desc Retrieves the list of Snapshot resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -62062,10 +54892,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -62145,8 +54974,7 @@ export namespace compute_v1 { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -62220,22 +55048,19 @@ export namespace compute_v1 { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the - * Labeling Resources documentation. + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -62274,10 +55099,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -62447,16 +55271,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -62502,46 +55317,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -62628,14 +55416,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -62648,8 +55434,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the SslCertificate resource to delete. - * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder - * value. + * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -62671,10 +55456,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -62754,22 +55538,19 @@ export namespace compute_v1 { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of - * available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -62782,8 +55563,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the SslCertificate resource to return. - * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder - * value. + * sslCertificate: 'my-ssl-certificate', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -62805,10 +55585,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -62887,22 +55666,19 @@ export namespace compute_v1 { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using - * the data included in the request. + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -62938,10 +55714,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -63020,22 +55795,19 @@ export namespace compute_v1 { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the - * specified project. + * @desc Retrieves the list of SslCertificate resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -63080,10 +55852,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -63175,16 +55946,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -63220,16 +55982,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63246,46 +55999,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -63302,9 +56028,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be - * deleted only if it is not in use by any TargetHttpsProxy or - * TargetSslProxy resources. + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. * @alias compute.sslPolicies.delete * @memberOf! () * @@ -63380,8 +56104,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified - * policy. + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -63455,8 +56178,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available - * SSL policies by making a list() request. + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. * @alias compute.sslPolicies.insert * @memberOf! () * @@ -63531,8 +56253,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the - * specified project. + * @desc Lists all the SSL policies that have been configured for the specified project. * @alias compute.sslPolicies.list * @memberOf! () * @@ -63608,8 +56329,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when - * using custom profile. + * @desc Lists all features that can be specified in the SSL policy when using custom profile. * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -63704,8 +56424,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the - * request. + * @desc Patches the specified SSL policy with the data included in the request. * @alias compute.sslPolicies.patch * @memberOf! () * @@ -63793,21 +56512,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the SSL policy to delete. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; } @@ -63822,8 +56531,7 @@ export namespace compute_v1 { */ project?: string; /** - * Name of the SSL policy to update. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; } @@ -63839,16 +56547,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -63864,46 +56563,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -63919,46 +56591,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -63978,21 +56623,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the SSL policy to update. The name must be 1-63 characters long, - * and comply with RFC1035. + * Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. */ sslPolicy?: string; @@ -64017,14 +56652,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64051,8 +56684,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -64070,10 +56702,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64165,14 +56796,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64210,10 +56839,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64301,14 +56929,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64333,8 +56959,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.subnetworks.expandIpCidrRange(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.subnetworks.expandIpCidrRange(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -64348,10 +56976,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64433,22 +57060,19 @@ export namespace compute_v1 { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available - * subnetworks list() request. + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64486,10 +57110,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64568,8 +57191,7 @@ export namespace compute_v1 { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.subnetworks.getIamPolicy * @memberOf! () * @@ -64643,22 +57265,19 @@ export namespace compute_v1 { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data - * included in the request. + * @desc Creates a subnetwork in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64697,10 +57316,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -64788,14 +57406,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -64843,10 +57459,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65015,10 +57630,7 @@ export namespace compute_v1 { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the - * request. Only certain fields can up updated with a patch request as - * indicated in the field descriptions. You must specify the current - * fingeprint of the subnetwork resource being patched. + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. * @alias compute.subnetworks.patch * @memberOf! () * @@ -65096,8 +57708,7 @@ export namespace compute_v1 { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.subnetworks.setIamPolicy * @memberOf! () * @@ -65172,22 +57783,19 @@ export namespace compute_v1 { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without - * assigning external IP addresses through Private Google Access. + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65212,8 +57820,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.subnetworks.setPrivateIpGoogleAccess(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.subnetworks.setPrivateIpGoogleAccess(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -65227,10 +57837,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65402,46 +58011,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -65465,16 +58047,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -65498,16 +58071,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -65575,16 +58139,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -65600,46 +58155,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -65659,46 +58187,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -65722,16 +58223,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -65785,16 +58277,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -65848,14 +58331,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -65868,8 +58349,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpProxy resource to delete. - * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder - * value. + * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -65891,10 +58371,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -65974,22 +58453,19 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of - * available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66002,8 +58478,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpProxy resource to return. - * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder - * value. + * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -66025,10 +58500,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66107,22 +58581,19 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66158,10 +58629,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66241,22 +58711,19 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66301,10 +58768,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66393,14 +58859,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66413,8 +58877,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpProxy to set a URL map for. - * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder - * value. + * targetHttpProxy: 'my-target-http-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -66440,10 +58903,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66535,16 +58997,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -66580,16 +59033,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -66606,46 +59050,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -66665,16 +59082,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -66703,14 +59111,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66723,8 +59129,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpsProxy resource to delete. - * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -66746,10 +59151,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66829,22 +59233,19 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of - * available target HTTPS proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -66857,8 +59258,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpsProxy resource to return. - * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -66880,10 +59280,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -66962,22 +59361,19 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67013,10 +59409,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67096,22 +59491,19 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67156,10 +59548,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67327,14 +59718,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67346,9 +59735,8 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetHttpsProxy resource to set an SslCertificates - * resource for. targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -67357,8 +59745,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.targetHttpsProxies.setSslCertificates(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetHttpsProxies.setSslCertificates(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -67372,10 +59762,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67456,10 +59845,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies - * the server-side support for SSL features. This affects connections - * between clients and the HTTPS proxy load balancer. They do not affect the - * connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -67543,14 +59929,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67563,8 +59947,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetHttpsProxy resource whose URL map is to be set. - * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update - * placeholder value. + * targetHttpsProxy: 'my-target-https-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -67590,10 +59973,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -67685,16 +60067,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -67730,16 +60103,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -67756,46 +60120,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -67815,21 +60152,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource to set the QUIC override policy - * for. The name should conform to RFC1035. + * Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. */ targetHttpsProxy?: string; @@ -67850,21 +60177,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource to set an SslCertificates resource - * for. + * Name of the TargetHttpsProxy resource to set an SslCertificates resource for. */ targetHttpsProxy?: string; @@ -67885,21 +60202,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetHttpsProxy resource whose SSL policy is to be set. The - * name must be 1-63 characters long, and comply with RFC1035. + * Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. */ targetHttpsProxy?: string; @@ -67920,16 +60227,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -67958,14 +60256,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -67992,8 +60288,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -68011,10 +60306,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68112,14 +60406,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -68135,8 +60427,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // Name of the TargetInstance resource to delete. - * targetInstance: 'my-target-instance', // TODO: Update placeholder - * value. + * targetInstance: 'my-target-instance', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -68158,10 +60449,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68242,22 +60532,19 @@ export namespace compute_v1 { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of - * available target instances by making a list() request. + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -68273,8 +60560,7 @@ export namespace compute_v1 { * zone: 'my-zone', // TODO: Update placeholder value. * * // Name of the TargetInstance resource to return. - * targetInstance: 'my-target-instance', // TODO: Update placeholder - * value. + * targetInstance: 'my-target-instance', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -68296,10 +60582,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68379,22 +60664,19 @@ export namespace compute_v1 { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone - * using the data included in the request. + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -68433,10 +60715,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68517,22 +60798,19 @@ export namespace compute_v1 { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the - * specified project and zone. + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -68580,10 +60858,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -68673,46 +60950,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -68732,16 +60982,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -68785,16 +61026,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -68815,46 +61047,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -68882,14 +61087,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -68931,10 +61134,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -69023,14 +61225,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -69072,10 +61272,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -69164,14 +61363,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -69198,8 +61395,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -69217,10 +61413,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -69312,14 +61507,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -69357,10 +61550,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -69441,22 +61633,19 @@ export namespace compute_v1 { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target - * pools by making a list() request. + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -69494,10 +61683,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -69576,22 +61764,19 @@ export namespace compute_v1 { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the - * instance that is referenced by the given target pool. + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -69606,9 +61791,8 @@ export namespace compute_v1 { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the TargetPool resource to which the queried instance - * belongs. targetPool: 'my-target-pool', // TODO: Update placeholder - * value. + * // Name of the TargetPool resource to which the queried instance belongs. + * targetPool: 'my-target-pool', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -69634,10 +61818,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -69722,22 +61905,19 @@ export namespace compute_v1 { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the - * data included in the request. + * @desc Creates a target pool in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -69776,10 +61956,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -69860,22 +62039,19 @@ export namespace compute_v1 { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project - * and region. + * @desc Retrieves a list of target pools available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -69923,10 +62099,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70015,14 +62190,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70047,8 +62220,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.targetPools.removeHealthCheck(request, function(err, response) - * { if (err) { console.error(err); return; + * compute.targetPools.removeHealthCheck(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -70062,10 +62237,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70154,14 +62328,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70203,10 +62375,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70295,14 +62466,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70344,10 +62513,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70445,16 +62613,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70483,16 +62642,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70513,46 +62663,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -70576,16 +62699,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70653,16 +62767,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -70678,46 +62783,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -70745,16 +62823,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70783,16 +62852,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70825,16 +62885,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -70863,14 +62914,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -70883,8 +62932,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetSslProxy resource to delete. - * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder - * value. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -70906,10 +62954,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -70989,22 +63036,19 @@ export namespace compute_v1 { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of - * available target SSL proxies by making a list() request. + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71017,8 +63061,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetSslProxy resource to return. - * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder - * value. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -71040,10 +63083,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71122,22 +63164,19 @@ export namespace compute_v1 { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71173,10 +63212,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71255,22 +63293,19 @@ export namespace compute_v1 { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71315,10 +63350,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71406,14 +63440,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71425,9 +63457,8 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetSslProxy resource whose BackendService resource - * is to be set. targetSslProxy: 'my-target-ssl-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetSslProxy resource whose BackendService resource is to be set. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -71436,8 +63467,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.targetSslProxies.setBackendService(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetSslProxies.setBackendService(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -71451,10 +63484,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71542,14 +63574,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71561,9 +63591,8 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetSslProxy resource whose ProxyHeader is to be - * set. targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder - * value. + * // Name of the TargetSslProxy resource whose ProxyHeader is to be set. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -71572,8 +63601,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.targetSslProxies.setProxyHeader(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetSslProxies.setProxyHeader(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -71587,10 +63618,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71678,14 +63708,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -71697,9 +63725,8 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetSslProxy resource whose SslCertificate resource - * is to be set. targetSslProxy: 'my-target-ssl-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetSslProxy resource whose SslCertificate resource is to be set. + * targetSslProxy: 'my-target-ssl-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -71708,8 +63735,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.targetSslProxies.setSslCertificates(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetSslProxies.setSslCertificates(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -71723,10 +63752,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -71807,10 +63835,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies - * the server-side support for SSL features. This affects connections - * between clients and the SSL proxy load balancer. They do not affect the - * connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -71898,16 +63923,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -71943,16 +63959,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -71969,46 +63976,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -72028,21 +64008,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose BackendService resource is to - * be set. + * Name of the TargetSslProxy resource whose BackendService resource is to be set. */ targetSslProxy?: string; @@ -72063,16 +64033,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -72097,21 +64058,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose SslCertificate resource is to - * be set. + * Name of the TargetSslProxy resource whose SslCertificate resource is to be set. */ targetSslProxy?: string; @@ -72132,21 +64083,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetSslProxy resource whose SSL policy is to be set. The - * name must be 1-63 characters long, and comply with RFC1035. + * Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. */ targetSslProxy?: string; @@ -72171,14 +64112,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72191,8 +64130,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetTcpProxy resource to delete. - * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder - * value. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -72214,10 +64152,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72297,22 +64234,19 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of - * available target TCP proxies by making a list() request. + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72325,8 +64259,7 @@ export namespace compute_v1 { * project: 'my-project', // TODO: Update placeholder value. * * // Name of the TargetTcpProxy resource to return. - * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder - * value. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -72348,10 +64281,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72430,22 +64362,19 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using - * the data included in the request. + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72481,10 +64410,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72563,22 +64491,19 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the - * specified project. + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72623,10 +64548,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72714,14 +64638,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72733,9 +64655,8 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetTcpProxy resource whose BackendService resource - * is to be set. targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update - * placeholder value. + * // Name of the TargetTcpProxy resource whose BackendService resource is to be set. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -72744,8 +64665,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.targetTcpProxies.setBackendService(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetTcpProxies.setBackendService(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -72759,10 +64682,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72850,14 +64772,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -72869,9 +64789,8 @@ export namespace compute_v1 { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Name of the TargetTcpProxy resource whose ProxyHeader is to be - * set. targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder - * value. + * // Name of the TargetTcpProxy resource whose ProxyHeader is to be set. + * targetTcpProxy: 'my-target-tcp-proxy', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -72880,8 +64799,10 @@ export namespace compute_v1 { * auth: authClient, * }; * - * compute.targetTcpProxies.setProxyHeader(request, function(err, - * response) { if (err) { console.error(err); return; + * compute.targetTcpProxies.setProxyHeader(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -72895,10 +64816,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -72990,16 +64910,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -73035,16 +64946,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -73061,46 +64963,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -73120,21 +64995,11 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Name of the TargetTcpProxy resource whose BackendService resource is to - * be set. + * Name of the TargetTcpProxy resource whose BackendService resource is to be set. */ targetTcpProxy?: string; @@ -73155,16 +65020,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -73193,14 +65049,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73227,8 +65081,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -73246,10 +65099,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73347,14 +65199,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73370,8 +65220,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the target VPN gateway to delete. - * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update - * placeholder value. + * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -73393,10 +65242,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73477,22 +65325,19 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available - * target VPN gateways by making a list() request. + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73508,8 +65353,7 @@ export namespace compute_v1 { * region: 'my-region', // TODO: Update placeholder value. * * // Name of the target VPN gateway to return. - * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update - * placeholder value. + * targetVpnGateway: 'my-target-vpn-gateway', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -73531,10 +65375,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73614,22 +65457,19 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region - * using the data included in the request. + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73668,10 +65508,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73752,22 +65591,19 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified - * project and region. + * @desc Retrieves a list of target VPN gateways available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -73815,10 +65651,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -73910,46 +65745,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -73973,16 +65781,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -74026,16 +65825,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -74052,46 +65842,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -74119,14 +65882,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74161,10 +65922,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74242,22 +66002,19 @@ export namespace compute_v1 { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL - * maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74292,10 +66049,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74370,22 +66126,19 @@ export namespace compute_v1 { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data - * included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74421,10 +66174,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74502,22 +66254,19 @@ export namespace compute_v1 { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the - * specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74556,10 +66305,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74640,22 +66388,19 @@ export namespace compute_v1 { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified - * project. + * @desc Retrieves the list of UrlMap resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74700,10 +66445,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74783,23 +66527,19 @@ export namespace compute_v1 { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the - * request. This method supports PATCH semantics and uses the JSON merge - * patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74815,8 +66555,7 @@ export namespace compute_v1 { * urlMap: 'my-url-map', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -74840,10 +66579,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -74922,22 +66660,19 @@ export namespace compute_v1 { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the - * request. + * @desc Updates the specified UrlMap resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -74953,8 +66688,7 @@ export namespace compute_v1 { * urlMap: 'my-url-map', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -74978,10 +66712,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75060,23 +66793,19 @@ export namespace compute_v1 { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of - * the provided UrlMap will be run. Calling this method does NOT create the - * UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75115,10 +66844,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75211,16 +66939,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -75254,16 +66973,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -75284,16 +66994,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -75313,46 +67014,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -75371,16 +67045,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -75404,16 +67069,7 @@ export namespace compute_v1 { */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -75462,14 +67118,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75496,8 +67150,7 @@ export namespace compute_v1 { * } * Object.keys(itemsPage).forEach(function(name) { * // TODO: Change code below to process each `name` property: - * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, - * 2)); + * console.log(name + ': ' + JSON.stringify(itemsPage[name], null, 2)); * }); * * if (response.nextPageToken) { @@ -75515,10 +67168,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75610,14 +67262,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75655,10 +67305,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75739,22 +67388,19 @@ export namespace compute_v1 { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available - * VPN tunnels by making a list() request. + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75792,10 +67438,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -75874,22 +67519,19 @@ export namespace compute_v1 { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region - * using the data included in the request. + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -75928,10 +67570,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76012,22 +67653,19 @@ export namespace compute_v1 { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified - * project and region. + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -76075,10 +67713,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76167,46 +67804,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -76230,16 +67840,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -76282,16 +67883,7 @@ export namespace compute_v1 { */ region?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -76307,46 +67899,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -76374,14 +67939,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -76416,10 +67979,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76504,14 +68066,12 @@ export namespace compute_v1 { * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -76549,10 +68109,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76632,22 +68191,19 @@ export namespace compute_v1 { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the - * specified zone. + * @desc Retrieves a list of Operation resources contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -76695,10 +68251,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -76827,46 +68382,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -76887,22 +68415,19 @@ export namespace compute_v1 { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones - * by making a list() request. + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -76937,10 +68462,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -77015,22 +68539,19 @@ export namespace compute_v1 { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified - * project. + * @desc Retrieves the list of Zone resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Compute Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -77075,10 +68596,9 @@ export namespace compute_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -77178,46 +68698,19 @@ export namespace compute_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** diff --git a/src/apis/container/package.json b/src/apis/container/package.json index 0187ab8f2b3..5b8f61c4d24 100644 --- a/src/apis/container/package.json +++ b/src/apis/container/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 37758941374..6bf7cb2f1e0 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace container_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace container_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace container_v1 { /** * Kubernetes Engine API * - * Builds and manages container-based applications, powered by the open source - * Kubernetes technology. + * Builds and manages container-based applications, powered by the open source Kubernetes technology. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace container_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -128,25 +126,20 @@ export namespace container_v1 { */ acceleratorCount?: string; /** - * The accelerator type resource name. List of supported accelerators - * [here](/compute/docs/gpus/#Introduction) + * The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus/#Introduction) */ acceleratorType?: string; } /** - * Configuration for the addons that can be automatically spun up in the - * cluster, enabling additional functionality. + * Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. */ export interface Schema$AddonsConfig { /** - * Configuration for the horizontal pod autoscaling feature, which increases - * or decreases the number of replica pods a replication controller has - * based on the resource usage of the existing pods. + * Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. */ horizontalPodAutoscaling?: Schema$HorizontalPodAutoscaling; /** - * Configuration for the HTTP (L7) load balancing controller addon, which - * makes it easy to set up HTTP load balancers for services in a cluster. + * Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. */ httpLoadBalancing?: Schema$HttpLoadBalancing; /** @@ -154,26 +147,20 @@ export namespace container_v1 { */ kubernetesDashboard?: Schema$KubernetesDashboard; /** - * Configuration for NetworkPolicy. This only tracks whether the addon is - * enabled or not on the Master, it does not track whether network policy is - * enabled for the nodes. + * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ networkPolicyConfig?: Schema$NetworkPolicyConfig; } /** - * AutoUpgradeOptions defines the set of options for the user to control how - * the Auto Upgrades will proceed. + * AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. */ export interface Schema$AutoUpgradeOptions { /** - * [Output only] This field is set when upgrades are about to commence with - * the approximate start time for the upgrades, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ autoUpgradeStartTime?: string; /** - * [Output only] This field is set when upgrades are about to commence with - * the description of the upgrade. + * [Output only] This field is set when upgrades are about to commence with the description of the upgrade. */ description?: string; } @@ -182,25 +169,19 @@ export namespace container_v1 { */ export interface Schema$CancelOperationRequest { /** - * The name (project, location, operation id) of the operation to cancel. - * Specified in the format 'projects/x/locations/x/operations/*'. + * The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/*'. */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the operation resides. - * This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -235,10 +216,7 @@ export namespace container_v1 { */ addonsConfig?: Schema$AddonsConfig; /** - * The IP address range of the container pods in this cluster, in - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically - * chosen or specify a `/14` block in `10.0.0.0/8`. + * The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`. */ clusterIpv4Cidr?: string; /** @@ -246,8 +224,7 @@ export namespace container_v1 { */ conditions?: Schema$StatusCondition[]; /** - * [Output only] The time the cluster was created, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ createTime?: string; /** @@ -255,22 +232,15 @@ export namespace container_v1 { */ currentMasterVersion?: string; /** - * [Output only] The number of nodes currently in the cluster. Deprecated. - * Call Kubernetes API directly to retrieve node information. + * [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. */ currentNodeCount?: number; /** - * [Output only] Deprecated, use - * [NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) - * instead. The current version of the node software components. If they are - * currently at multiple versions because they're in the process of - * being upgraded, this reflects the minimum version of all nodes. + * [Output only] Deprecated, use [NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string; /** - * The default constraint on the maximum number of pods that can be run - * simultaneously on a node in the node pool of this cluster. Only honored - * if cluster created with IP Alias support. + * The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support. */ defaultMaxPodsConstraint?: Schema$MaxPodsConstraint; /** @@ -278,11 +248,7 @@ export namespace container_v1 { */ description?: string; /** - * Kubernetes alpha features are enabled on this cluster. This includes - * alpha API groups (e.g. v1alpha1) and features that may not be production - * ready in the kubernetes version of the master and nodes. The cluster has - * no SLA for uptime and master/node upgrades are disabled. Alpha enabled - * clusters are automatically deleted thirty days after creation. + * Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. */ enableKubernetesAlpha?: boolean; /** @@ -290,41 +256,19 @@ export namespace container_v1 { */ enableTpu?: boolean; /** - * [Output only] The IP address of this cluster's master endpoint. The - * endpoint can be accessed from the internet at - * `https://username:password@endpoint/`. See the `masterAuth` property of - * this resource for username and password information. + * [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. */ endpoint?: string; /** - * [Output only] The time the cluster will be automatically deleted in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ expireTime?: string; /** - * The initial Kubernetes version for this cluster. Valid versions are - * those found in validMasterVersions returned by getServerConfig. The - * version can be upgraded over time; such upgrades are reflected in - * currentMasterVersion and currentNodeVersion. Users may specify either - * explicit versions offered by Kubernetes Engine or version aliases, which - * have the following behavior: - "latest": picks the highest - * valid Kubernetes version - "1.X": picks the highest valid - * patch+gke.N patch in the 1.X version - "1.X.Y": picks the - * highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": - * picks an explicit Kubernetes version - "","-": picks - * the default Kubernetes version + * The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version */ initialClusterVersion?: string; /** - * The number of nodes to create in this cluster. You must ensure that your - * Compute Engine <a - * href="/compute/docs/resource-quotas">resource - * quota</a> is sufficient for this number of instances. You must also - * have available firewall and routes quota. For requests, this field should - * only be used in lieu of a "node_pool" object, since this - * configuration (along with the "node_config") will be used to - * create a "NodePool" object with an auto-generated name. Do not - * use this and a node_pool at the same time. + * The number of nodes to create in this cluster. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. */ initialNodeCount?: number; /** @@ -344,22 +288,15 @@ export namespace container_v1 { */ legacyAbac?: Schema$LegacyAbac; /** - * [Output only] The name of the Google Compute Engine - * [zone](/compute/docs/regions-zones/regions-zones#available) or - * [region](/compute/docs/regions-zones/regions-zones#available) in which - * the cluster resides. + * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string; /** - * The list of Google Compute Engine [zones](/compute/docs/zones#available) - * in which the cluster's nodes should be located. + * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. */ locations?: string[]; /** - * The logging service the cluster should use to write logs. Currently - * available options: * `logging.googleapis.com` - the Google Cloud Logging - * service. * `none` - no logs will be exported from the cluster. * if left - * as an empty string,`logging.googleapis.com` will be used. + * The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. */ loggingService?: string; /** @@ -367,11 +304,7 @@ export namespace container_v1 { */ maintenancePolicy?: Schema$MaintenancePolicy; /** - * The authentication information for accessing the master endpoint. If - * unspecified, the defaults are used: For clusters before v1.12, if - * master_auth is unspecified, `username` will be set to "admin", - * a random password will be generated, and a client certificate will be - * issued. + * The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. */ masterAuth?: Schema$MasterAuth; /** @@ -379,25 +312,15 @@ export namespace container_v1 { */ masterAuthorizedNetworksConfig?: Schema$MasterAuthorizedNetworksConfig; /** - * The monitoring service the cluster should use to write metrics. Currently - * available options: * `monitoring.googleapis.com` - the Google Cloud - * Monitoring service. * `none` - no metrics will be exported from the - * cluster. * if left as an empty string, `monitoring.googleapis.com` will - * be used. + * The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used. */ monitoringService?: string; /** - * The name of this cluster. The name must be unique within this project and - * zone, and can be up to 40 characters with the following restrictions: * - * Lowercase letters, numbers, and hyphens only. * Must start with a letter. - * * Must end with a number or a letter. + * The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. */ name?: string; /** - * The name of the Google Compute Engine - * [network](/compute/docs/networks-and-firewalls#networks) to which the - * cluster is connected. If left unspecified, the `default` network will be - * used. + * The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. */ network?: string; /** @@ -409,26 +332,15 @@ export namespace container_v1 { */ networkPolicy?: Schema$NetworkPolicy; /** - * Parameters used in creating the cluster's nodes. See `nodeConfig` for - * the description of its properties. For requests, this field should only - * be used in lieu of a "node_pool" object, since this - * configuration (along with the "initial_node_count") will be - * used to create a "NodePool" object with an auto-generated name. - * Do not use this and a node_pool at the same time. For responses, this - * field will be populated with the node configuration of the first node - * pool. If unspecified, the defaults are used. + * Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead. */ nodeConfig?: Schema$NodeConfig; /** - * [Output only] The size of the address space on each node for hosting - * containers. This is provisioned from within the `container_ipv4_cidr` - * range. + * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. */ nodeIpv4CidrSize?: number; /** - * The node pools associated with this cluster. This field should not be set - * if "node_config" or "initial_node_count" are - * specified. + * The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. */ nodePools?: Schema$NodePool[]; /** @@ -436,8 +348,7 @@ export namespace container_v1 { */ privateClusterConfig?: Schema$PrivateClusterConfig; /** - * The resource labels for the cluster to use to annotate any related Google - * Compute Engine resources. + * The resource labels for the cluster to use to annotate any related Google Compute Engine resources. */ resourceLabels?: {[key: string]: string}; /** @@ -445,11 +356,7 @@ export namespace container_v1 { */ selfLink?: string; /** - * [Output only] The IP address range of the Kubernetes services in this - * cluster, in - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the - * last `/16` from the container CIDR. + * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ servicesIpv4Cidr?: string; /** @@ -457,33 +364,24 @@ export namespace container_v1 { */ status?: string; /** - * [Output only] Additional information about the current status of this - * cluster, if available. + * [Output only] Additional information about the current status of this cluster, if available. */ statusMessage?: string; /** - * The name of the Google Compute Engine - * [subnetwork](/compute/docs/subnetworks) to which the cluster is - * connected. + * The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected. */ subnetwork?: string; /** - * [Output only] The IP address range of the Cloud TPUs in this cluster, in - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `1.2.3.4/29`). + * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string; /** - * [Output only] The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field is deprecated, use location instead. + * [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ zone?: string; } /** - * ClusterUpdate describes an update to the cluster. Exactly one update can be - * applied to a cluster with each request, so at most one field can be - * provided. + * ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. */ export interface Schema$ClusterUpdate { /** @@ -491,17 +389,11 @@ export namespace container_v1 { */ desiredAddonsConfig?: Schema$AddonsConfig; /** - * The desired image type for the node pool. NOTE: Set the - * "desired_node_pool" field as well. + * The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. */ desiredImageType?: string; /** - * The desired list of Google Compute Engine - * [zones](/compute/docs/zones#available) in which the cluster's nodes - * should be located. Changing the locations a cluster is in will result in - * nodes being either created or removed from the cluster, depending on - * whether locations are being added or removed. This list must always - * include the cluster's primary zone. + * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ desiredLocations?: string[]; /** @@ -509,75 +401,44 @@ export namespace container_v1 { */ desiredMasterAuthorizedNetworksConfig?: Schema$MasterAuthorizedNetworksConfig; /** - * The Kubernetes version to change the master to. Users may specify either - * explicit versions offered by Kubernetes Engine or version aliases, which - * have the following behavior: - "latest": picks the highest - * valid Kubernetes version - "1.X": picks the highest valid - * patch+gke.N patch in the 1.X version - "1.X.Y": picks the - * highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": - * picks an explicit Kubernetes version - "-": picks the default - * Kubernetes version + * The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version */ desiredMasterVersion?: string; /** - * The monitoring service the cluster should use to write metrics. Currently - * available options: * "monitoring.googleapis.com" - the Google - * Cloud Monitoring service * "none" - no metrics will be exported - * from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ desiredMonitoringService?: string; /** - * Autoscaler configuration for the node pool specified in - * desired_node_pool_id. If there is only one pool in the cluster and - * desired_node_pool_id is not provided then the change applies to that - * single node pool. + * Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. */ desiredNodePoolAutoscaling?: Schema$NodePoolAutoscaling; /** - * The node pool to be upgraded. This field is mandatory if - * "desired_node_version", "desired_image_family" or - * "desired_node_pool_autoscaling" is specified and there is more - * than one node pool on the cluster. + * The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. */ desiredNodePoolId?: string; /** - * The Kubernetes version to change the nodes to (typically an upgrade). - * Users may specify either explicit versions offered by Kubernetes Engine - * or version aliases, which have the following behavior: - - * "latest": picks the highest valid Kubernetes version - - * "1.X": picks the highest valid patch+gke.N patch in the 1.X - * version - "1.X.Y": picks the highest valid gke.N patch in - * the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes - * version - "-": picks the Kubernetes master version + * The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version */ desiredNodeVersion?: string; } /** - * CompleteIPRotationRequest moves the cluster master back into single-IP - * mode. + * CompleteIPRotationRequest moves the cluster master back into single-IP mode. */ export interface Schema$CompleteIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster id) of the cluster to complete IP - * rotation. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -586,25 +447,19 @@ export namespace container_v1 { */ export interface Schema$CreateClusterRequest { /** - * A [cluster - * resource](/container-engine/reference/rest/v1/projects.zones.clusters) + * A [cluster resource](/container-engine/reference/rest/v1/projects.zones.clusters) */ cluster?: Schema$Cluster; /** - * The parent (project and location) where the cluster will be created. - * Specified in the format 'projects/x/locations/*'. + * The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/*'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -613,8 +468,7 @@ export namespace container_v1 { */ export interface Schema$CreateNodePoolRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** @@ -622,21 +476,15 @@ export namespace container_v1 { */ nodePool?: Schema$NodePool; /** - * The parent (project, location, cluster id) where the node pool will be - * created. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/*'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -645,41 +493,29 @@ export namespace container_v1 { */ export interface Schema$DailyMaintenanceWindow { /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. Duration will be in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format - * "PTnHnMnS". + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". */ duration?: string; /** - * Time within the maintenance window to start the maintenance operations. - * Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) - * format "HH:MM”, where HH : [00-23] and MM : [00-59] GMT. + * Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM”, where HH : [00-23] and MM : [00-59] GMT. */ startTime?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc - * 7517 + * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 */ export interface Schema$GetJSONWebKeysResponse { /** - * The public component of the keys used by the cluster to sign token - * requests. + * The public component of the keys used by the cluster to sign token requests. */ keys?: Schema$Jwk[]; } /** - * GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See - * the OpenID Connect Discovery 1.0 specification for details. + * GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details. */ export interface Schema$GetOpenIDConfigResponse { /** @@ -712,28 +548,20 @@ export namespace container_v1 { subject_types_supported?: string[]; } /** - * Configuration options for the horizontal pod autoscaling feature, which - * increases or decreases the number of replica pods a replication controller - * has based on the resource usage of the existing pods. + * Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. */ export interface Schema$HorizontalPodAutoscaling { /** - * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. - * When enabled, it ensures that a Heapster pod is running in the cluster, - * which is also used by the Cloud Monitoring service. + * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service. */ disabled?: boolean; } /** - * Configuration options for the HTTP (L7) load balancing controller addon, - * which makes it easy to set up HTTP load balancers for services in a - * cluster. + * Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. */ export interface Schema$HttpLoadBalancing { /** - * Whether the HTTP Load Balancing controller is enabled in the cluster. - * When enabled, it runs a small pod in the cluster that manages the load - * balancers. + * Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. */ disabled?: boolean; } @@ -746,28 +574,15 @@ export namespace container_v1 { */ clusterIpv4Cidr?: string; /** - * The IP address range for the cluster pod IPs. If this field is set, then - * `cluster.cluster_ipv4_cidr` must be left blank. This field is only - * applicable when `use_ip_aliases` is true. Set to blank to have a range - * chosen with the default size. Set to /netmask (e.g. `/14`) to have a - * range chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ clusterIpv4CidrBlock?: string; /** - * The name of the secondary range to be used for the cluster CIDR block. - * The secondary range will be used for pod IP addresses. This must be an - * existing secondary range associated with the cluster subnetwork. This - * field is only applicable with use_ip_aliases is true and - * create_subnetwork is false. + * The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. */ clusterSecondaryRangeName?: string; /** - * Whether a new subnetwork will be created automatically for the cluster. - * This field is only applicable when `use_ip_aliases` is true. + * Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. */ createSubnetwork?: boolean; /** @@ -775,14 +590,7 @@ export namespace container_v1 { */ nodeIpv4Cidr?: string; /** - * The IP address range of the instance IPs in this cluster. This is - * applicable only if `create_subnetwork` is true. Set to blank to have a - * range chosen with the default size. Set to /netmask (e.g. `/14`) to have - * a range chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ nodeIpv4CidrBlock?: string; /** @@ -790,41 +598,19 @@ export namespace container_v1 { */ servicesIpv4Cidr?: string; /** - * The IP address range of the services IPs in this cluster. If blank, a - * range will be automatically chosen with the default size. This field is - * only applicable when `use_ip_aliases` is true. Set to blank to have a - * range chosen with the default size. Set to /netmask (e.g. `/14`) to have - * a range chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ servicesIpv4CidrBlock?: string; /** - * The name of the secondary range to be used as for the services CIDR - * block. The secondary range will be used for service ClusterIPs. This - * must be an existing secondary range associated with the cluster - * subnetwork. This field is only applicable with use_ip_aliases is true - * and create_subnetwork is false. + * The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. */ servicesSecondaryRangeName?: string; /** - * A custom subnetwork name to be used if `create_subnetwork` is true. If - * this field is empty, then an automatic name will be chosen for the new - * subnetwork. + * A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. */ subnetworkName?: string; /** - * The IP address range of the Cloud TPUs in this cluster. If unspecified, a - * range will be automatically chosen with the default size. This field is - * only applicable when `use_ip_aliases` is true. If unspecified, the range - * will use the default size. Set to /netmask (e.g. `/14`) to have a range - * chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ tpuIpv4CidrBlock?: string; /** @@ -883,15 +669,11 @@ export namespace container_v1 { disabled?: boolean; } /** - * Configuration for the legacy Attribute Based Access Control authorization - * mode. + * Configuration for the legacy Attribute Based Access Control authorization mode. */ export interface Schema$LegacyAbac { /** - * Whether the ABAC authorizer is enabled for this cluster. When enabled, - * identities in the system, including service accounts, nodes, and - * controllers, will have statically granted permissions beyond those - * provided by the RBAC configuration or IAM. + * Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. */ enabled?: boolean; } @@ -900,13 +682,11 @@ export namespace container_v1 { */ export interface Schema$ListClustersResponse { /** - * A list of clusters in the project in the specified zone, or across all - * ones. + * A list of clusters in the project in the specified zone, or across all ones. */ clusters?: Schema$Cluster[]; /** - * If any zones are listed here, the list of clusters returned may be - * missing those zones. + * If any zones are listed here, the list of clusters returned may be missing those zones. */ missingZones?: string[]; } @@ -924,8 +704,7 @@ export namespace container_v1 { */ export interface Schema$ListOperationsResponse { /** - * If any zones are listed here, the list of operations returned may be - * missing the operations from those zones. + * If any zones are listed here, the list of operations returned may be missing the operations from those zones. */ missingZones?: string[]; /** @@ -934,15 +713,11 @@ export namespace container_v1 { operations?: Schema$Operation[]; } /** - * ListUsableSubnetworksResponse is the response of - * ListUsableSubnetworksRequest. + * ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. */ export interface Schema$ListUsableSubnetworksResponse { /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `page_size`, use the - * `next_page_token` as a value for the query parameter `page_token` in the - * next request. The value will become empty when there are no more pages. + * This token allows you to get the next page of results for list requests. If the number of results is larger than `page_size`, use the `next_page_token` as a value for the query parameter `page_token` in the next request. The value will become empty when there are no more pages. */ nextPageToken?: string; /** @@ -951,8 +726,7 @@ export namespace container_v1 { subnetworks?: Schema$UsableSubnetwork[]; } /** - * MaintenancePolicy defines the maintenance policy to be used for the - * cluster. + * MaintenancePolicy defines the maintenance policy to be used for the cluster. */ export interface Schema$MaintenancePolicy { /** @@ -961,8 +735,7 @@ export namespace container_v1 { window?: Schema$MaintenanceWindow; } /** - * MaintenanceWindow defines the maintenance window to be used for the - * cluster. + * MaintenanceWindow defines the maintenance window to be used for the cluster. */ export interface Schema$MaintenanceWindow { /** @@ -971,56 +744,40 @@ export namespace container_v1 { dailyMaintenanceWindow?: Schema$DailyMaintenanceWindow; } /** - * The authentication information for accessing the master endpoint. - * Authentication can be done using HTTP basic auth or using client - * certificates. + * The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. */ export interface Schema$MasterAuth { /** - * [Output only] Base64-encoded public certificate used by clients to - * authenticate to the cluster endpoint. + * [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. */ clientCertificate?: string; /** - * Configuration for client certificate authentication on the cluster. For - * clusters before v1.12, if no configuration is specified, a client - * certificate is issued. + * Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. */ clientCertificateConfig?: Schema$ClientCertificateConfig; /** - * [Output only] Base64-encoded private key used by clients to authenticate - * to the cluster endpoint. + * [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. */ clientKey?: string; /** - * [Output only] Base64-encoded public certificate that is the root of trust - * for the cluster. + * [Output only] Base64-encoded public certificate that is the root of trust for the cluster. */ clusterCaCertificate?: string; /** - * The password to use for HTTP basic authentication to the master endpoint. - * Because the master endpoint is open to the Internet, you should create a - * strong password. If a password is provided for cluster creation, - * username must be non-empty. + * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. */ password?: string; /** - * The username to use for HTTP basic authentication to the master endpoint. - * For clusters v1.6.0 and later, basic authentication can be disabled by - * leaving username unspecified (or setting it to the empty string). + * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). */ username?: string; } /** - * Configuration options for the master authorized networks feature. Enabled - * master authorized networks will disallow all external traffic to access - * Kubernetes master through HTTPS except traffic from the given CIDR blocks, - * Google Compute Engine Public IPs and Google Prod IPs. + * Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. */ export interface Schema$MasterAuthorizedNetworksConfig { /** - * cidr_blocks define up to 10 external networks that could access - * Kubernetes master through HTTPS. + * cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. */ cidrBlocks?: Schema$CidrBlock[]; /** @@ -1042,22 +799,16 @@ export namespace container_v1 { */ export interface Schema$NetworkConfig { /** - * Output only. The relative name of the Google Compute Engine - * network(/compute/docs/networks-and-firewalls#networks) to which the - * cluster is connected. Example: - * projects/my-project/global/networks/my-network + * Output only. The relative name of the Google Compute Engine network(/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network */ network?: string; /** - * Output only. The relative name of the Google Compute Engine - * [subnetwork](/compute/docs/vpc) to which the cluster is connected. - * Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + * Output only. The relative name of the Google Compute Engine [subnetwork](/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ subnetwork?: string; } /** - * Configuration options for the NetworkPolicy feature. - * https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ + * Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ */ export interface Schema$NetworkPolicy { /** @@ -1070,9 +821,7 @@ export namespace container_v1 { provider?: string; } /** - * Configuration for NetworkPolicy. This only tracks whether the addon is - * enabled or not on the Master, it does not track whether network policy is - * enabled for the nodes. + * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ export interface Schema$NetworkPolicyConfig { /** @@ -1085,136 +834,72 @@ export namespace container_v1 { */ export interface Schema$NodeConfig { /** - * A list of hardware accelerators to be attached to each node. See - * https://cloud.google.com/compute/docs/gpus for more information about - * support for GPUs. + * A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. */ accelerators?: Schema$AcceleratorConfig[]; /** - * Size of the disk attached to each node, specified in GB. The smallest - * allowed disk size is 10GB. If unspecified, the default disk size is - * 100GB. + * Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. */ diskSizeGb?: number; /** - * Type of the disk attached to each node (e.g. 'pd-standard' or - * 'pd-ssd') If unspecified, the default disk type is - * 'pd-standard' + * Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard' */ diskType?: string; /** - * The image type to use for this node. Note that for a given image type, - * the latest version of it will be used. + * The image type to use for this node. Note that for a given image type, the latest version of it will be used. */ imageType?: string; /** - * The map of Kubernetes labels (key/value pairs) to be applied to each - * node. These will added in addition to any default label(s) that - * Kubernetes may apply to the node. In case of conflict in label keys, the - * applied set may differ depending on the Kubernetes version -- it's - * best to assume the behavior is undefined and conflicts should be avoided. - * For more information, including usage and the valid values, see: - * https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ + * The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ */ labels?: {[key: string]: string}; /** - * The number of local SSD disks to be attached to the node. The limit for - * this value is dependant upon the maximum number of disks available on a - * machine per zone. See: - * https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits - * for more information. + * The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information. */ localSsdCount?: number; /** - * The name of a Google Compute Engine [machine - * type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If - * unspecified, the default machine type is `n1-standard-1`. + * The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`. */ machineType?: string; /** - * The metadata key/value pairs assigned to instances in the cluster. Keys - * must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in - * length. These are reflected as part of a URL in the metadata server. - * Additionally, to avoid ambiguity, keys must not conflict with any other - * metadata keys for the project or be one of the reserved keys: - * "cluster-location" "cluster-name" - * "cluster-uid" "configure-sh" - * "containerd-configure-sh" "enable-os-login" - * "gci-update-strategy" "gci-ensure-gke-docker" - * "instance-template" "kube-env" - * "startup-script" "user-data" Values are free-form - * strings, and only have meaning as interpreted by the image running in the - * instance. The only restriction placed on them is that each value's - * size must be less than or equal to 32 KB. The total size of all keys and - * values must be less than 512 KB. + * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. */ metadata?: {[key: string]: string}; /** - * Minimum CPU platform to be used by this instance. The instance may be - * scheduled on the specified or newer CPU platform. Applicable values are - * the friendly names of CPU platforms, such as <code>minCpuPlatform: - * &quot;Intel Haswell&quot;</code> or - * <code>minCpuPlatform: &quot;Intel Sandy - * Bridge&quot;</code>. For more information, read [how to specify - * min CPU - * platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) */ minCpuPlatform?: string; /** - * The set of Google API scopes to be made available on all of the node VMs - * under the "default" service account. The following scopes are - * recommended, but not required, and by default are not included: * - * `https://www.googleapis.com/auth/compute` is required for mounting - * persistent storage on your nodes. * - * `https://www.googleapis.com/auth/devstorage.read_only` is required for - * communicating with **gcr.io** (the [Google Container - * Registry](/container-registry/)). If unspecified, no scopes are added, - * unless Cloud Logging or Cloud Monitoring are enabled, in which case their - * required scopes will be added. + * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. */ oauthScopes?: string[]; /** - * Whether the nodes are created as preemptible VM instances. See: - * https://cloud.google.com/compute/docs/instances/preemptible for more - * information about preemptible VM instances. + * Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. */ preemptible?: boolean; /** - * The Google Cloud Platform Service Account to be used by the node VMs. If - * no Service Account is specified, the "default" service account - * is used. + * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. */ serviceAccount?: string; /** - * The list of instance tags applied to all nodes. Tags are used to identify - * valid sources or targets for network firewalls and are specified by the - * client during cluster or node pool creation. Each tag within the list - * must comply with RFC1035. + * The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. */ tags?: string[]; /** - * List of kubernetes taints to be applied to each node. For more - * information, including usage and the valid values, see: - * https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + * List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ */ taints?: Schema$NodeTaint[]; } /** - * NodeManagement defines the set of node management services turned on for - * the node pool. + * NodeManagement defines the set of node management services turned on for the node pool. */ export interface Schema$NodeManagement { /** - * A flag that specifies whether the node auto-repair is enabled for the - * node pool. If enabled, the nodes in this node pool will be monitored and, - * if they fail health checks too many times, an automatic repair action - * will be triggered. + * A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. */ autoRepair?: boolean; /** - * A flag that specifies whether node auto-upgrade is enabled for the node - * pool. If enabled, node auto-upgrade helps keep the nodes in your node - * pool up to date with the latest release version of Kubernetes. + * A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. */ autoUpgrade?: boolean; /** @@ -1223,17 +908,11 @@ export namespace container_v1 { upgradeOptions?: Schema$AutoUpgradeOptions; } /** - * NodePool contains the name and configuration for a cluster's node pool. - * Node pools are a set of nodes (i.e. VM's), with a common configuration - * and specification, under the control of the cluster master. They may have a - * set of Kubernetes labels applied to them, which may be used to reference - * them during pod scheduling. They may also be resized up or down, to - * accommodate the workload. + * NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. */ export interface Schema$NodePool { /** - * Autoscaler configuration for this NodePool. Autoscaler is enabled only if - * a valid configuration is present. + * Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. */ autoscaling?: Schema$NodePoolAutoscaling; /** @@ -1245,16 +924,11 @@ export namespace container_v1 { */ config?: Schema$NodeConfig; /** - * The initial node count for the pool. You must ensure that your Compute - * Engine <a href="/compute/docs/resource-quotas">resource - * quota</a> is sufficient for this number of instances. You must also - * have available firewall and routes quota. + * The initial node count for the pool. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. */ initialNodeCount?: number; /** - * [Output only] The resource URLs of the [managed instance - * groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) - * associated with this node pool. + * [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. */ instanceGroupUrls?: string[]; /** @@ -1262,14 +936,17 @@ export namespace container_v1 { */ management?: Schema$NodeManagement; /** - * The constraint on the maximum number of pods that can be run - * simultaneously on a node in the node pool. + * The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. */ maxPodsConstraint?: Schema$MaxPodsConstraint; /** * The name of the node pool. */ name?: string; + /** + * [Output only] The pod CIDR block size per node in this node pool. + */ + podIpv4CidrSize?: number; /** * [Output only] Server-defined URL for the resource. */ @@ -1279,8 +956,7 @@ export namespace container_v1 { */ status?: string; /** - * [Output only] Additional information about the current status of this - * node pool instance, if available. + * [Output only] Additional information about the current status of this node pool instance, if available. */ statusMessage?: string; /** @@ -1289,8 +965,7 @@ export namespace container_v1 { version?: string; } /** - * NodePoolAutoscaling contains information required by cluster autoscaler to - * adjust the size of the node pool to the current cluster usage. + * NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. */ export interface Schema$NodePoolAutoscaling { /** @@ -1298,22 +973,16 @@ export namespace container_v1 { */ enabled?: boolean; /** - * Maximum number of nodes in the NodePool. Must be >= min_node_count. - * There has to enough quota to scale up the cluster. + * Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster. */ maxNodeCount?: number; /** - * Minimum number of nodes in the NodePool. Must be >= 1 and <= - * max_node_count. + * Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. */ minNodeCount?: number; } /** - * Kubernetes taint is comprised of three fields: key, value, and effect. - * Effect can only be one of three types: NoSchedule, PreferNoSchedule or - * NoExecute. For more information, including usage and the valid values, - * see: - * https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + * Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ */ export interface Schema$NodeTaint { /** @@ -1330,8 +999,7 @@ export namespace container_v1 { value?: string; } /** - * This operation resource represents operations that may have happened or are - * happening on the cluster. All fields are output only. + * This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. */ export interface Schema$Operation { /** @@ -1343,15 +1011,11 @@ export namespace container_v1 { */ detail?: string; /** - * [Output only] The time the operation completed, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ endTime?: string; /** - * [Output only] The name of the Google Compute Engine - * [zone](/compute/docs/regions-zones/regions-zones#available) or - * [region](/compute/docs/regions-zones/regions-zones#available) in which - * the cluster resides. + * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string; /** @@ -1371,8 +1035,7 @@ export namespace container_v1 { */ selfLink?: string; /** - * [Output only] The time the operation started, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ startTime?: string; /** @@ -1388,9 +1051,7 @@ export namespace container_v1 { */ targetLink?: string; /** - * The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the operation is taking - * place. This field is deprecated, use location instead. + * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ zone?: string; } @@ -1399,66 +1060,48 @@ export namespace container_v1 { */ export interface Schema$PrivateClusterConfig { /** - * Whether the master's internal IP address is used as the cluster - * endpoint. + * Whether the master's internal IP address is used as the cluster endpoint. */ enablePrivateEndpoint?: boolean; /** - * Whether nodes have internal IP addresses only. If enabled, all nodes are - * given only RFC 1918 private addresses and communicate with the master via - * private networking. + * Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. */ enablePrivateNodes?: boolean; /** - * The IP range in CIDR notation to use for the hosted master network. This - * range will be used for assigning internal IP addresses to the master or - * set of masters, as well as the ILB VIP. This range must not overlap with - * any other ranges in use within the cluster's network. + * The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network. */ masterIpv4CidrBlock?: string; /** - * Output only. The internal IP address of this cluster's master - * endpoint. + * Output only. The internal IP address of this cluster's master endpoint. */ privateEndpoint?: string; /** - * Output only. The external IP address of this cluster's master - * endpoint. + * Output only. The external IP address of this cluster's master endpoint. */ publicEndpoint?: string; } /** - * RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed - * NodePool upgrade. This will be an no-op if the last upgrade successfully - * completed. + * RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. */ export interface Schema$RollbackNodePoolUpgradeRequest { /** - * Deprecated. The name of the cluster to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node poll to - * rollback upgrade. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1492,62 +1135,44 @@ export namespace container_v1 { */ export interface Schema$SetAddonsConfigRequest { /** - * The desired configurations for the various addons available to run in the - * cluster. + * The desired configurations for the various addons available to run in the cluster. */ addonsConfig?: Schema$AddonsConfig; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to set addons. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * SetLabelsRequest sets the Google Cloud Platform labels on a Google - * Container Engine cluster, which will in turn set them for Google Compute - * Engine resources used by that cluster + * SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster */ export interface Schema$SetLabelsRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Kubernetes - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash when updating or - * changing labels. Make a <code>get()</code> request to the - * resource to get the latest fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a <code>get()</code> request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** - * The name (project, location, cluster id) of the cluster to set labels. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -1555,20 +1180,16 @@ export namespace container_v1 { */ resourceLabels?: {[key: string]: string}; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * SetLegacyAbacRequest enables or disables the ABAC authorization mechanism - * for a cluster. + * SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. */ export interface Schema$SetLegacyAbacRequest { /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -1576,21 +1197,15 @@ export namespace container_v1 { */ enabled?: boolean; /** - * The name (project, location, cluster id) of the cluster to set legacy - * abac. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1599,34 +1214,23 @@ export namespace container_v1 { */ export interface Schema$SetLocationsRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The desired list of Google Compute Engine - * [zones](/compute/docs/zones#available) in which the cluster's nodes - * should be located. Changing the locations a cluster is in will result in - * nodes being either created or removed from the cluster, depending on - * whether locations are being added or removed. This list must always - * include the cluster's primary zone. + * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ locations?: string[]; /** - * The name (project, location, cluster) of the cluster to set locations. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1635,32 +1239,23 @@ export namespace container_v1 { */ export interface Schema$SetLoggingServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The logging service the cluster should use to write metrics. Currently - * available options: * "logging.googleapis.com" - the Google - * Cloud Logging service * "none" - no metrics will be exported - * from the cluster + * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no metrics will be exported from the cluster */ loggingService?: string; /** - * The name (project, location, cluster) of the cluster to set logging. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1673,24 +1268,19 @@ export namespace container_v1 { */ clusterId?: string; /** - * The maintenance policy to be set for the cluster. An empty field clears - * the existing maintenance policy. + * The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. */ maintenancePolicy?: Schema$MaintenancePolicy; /** - * The name (project, location, cluster id) of the cluster to set - * maintenance policy. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). + * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string; /** - * The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. + * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string; } @@ -1703,19 +1293,15 @@ export namespace container_v1 { */ action?: string; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to set auth. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -1723,9 +1309,7 @@ export namespace container_v1 { */ update?: Schema$MasterAuth; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1734,32 +1318,23 @@ export namespace container_v1 { */ export interface Schema$SetMonitoringServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The monitoring service the cluster should use to write metrics. Currently - * available options: * "monitoring.googleapis.com" - the Google - * Cloud Monitoring service * "none" - no metrics will be exported - * from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ monitoringService?: string; /** - * The name (project, location, cluster) of the cluster to set monitoring. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1768,14 +1343,11 @@ export namespace container_v1 { */ export interface Schema$SetNetworkPolicyRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster id) of the cluster to set networking - * policy. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** @@ -1783,15 +1355,11 @@ export namespace container_v1 { */ networkPolicy?: Schema$NetworkPolicy; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1804,42 +1372,32 @@ export namespace container_v1 { */ autoscaling?: Schema$NodePoolAutoscaling; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool) of the node pool to set - * autoscaler settings. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * SetNodePoolManagementRequest sets the node management properties of a node - * pool. + * SetNodePoolManagementRequest sets the node management properties of a node pool. */ export interface Schema$SetNodePoolManagementRequest { /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -1847,26 +1405,19 @@ export namespace container_v1 { */ management?: Schema$NodeManagement; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set management properties. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1875,14 +1426,11 @@ export namespace container_v1 { */ export interface Schema$SetNodePoolSizeRequest { /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set size. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** @@ -1890,43 +1438,32 @@ export namespace container_v1 { */ nodeCount?: number; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * StartIPRotationRequest creates a new IP for the cluster and then performs a - * node upgrade on each node pool to point to the new IP. + * StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. */ export interface Schema$StartIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster id) of the cluster to start IP - * rotation. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -1934,15 +1471,12 @@ export namespace container_v1 { */ rotateCredentials?: boolean; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * StatusCondition describes why a cluster or a node pool has a certain status - * (e.g., ERROR or DEGRADED). + * StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). */ export interface Schema$StatusCondition { /** @@ -1959,19 +1493,15 @@ export namespace container_v1 { */ export interface Schema$UpdateClusterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -1979,9 +1509,7 @@ export namespace container_v1 { */ update?: Schema$ClusterUpdate; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1990,36 +1518,23 @@ export namespace container_v1 { */ export interface Schema$UpdateMasterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The Kubernetes version to change the master to. Users may specify either - * explicit versions offered by Kubernetes Engine or version aliases, which - * have the following behavior: - "latest": picks the highest - * valid Kubernetes version - "1.X": picks the highest valid - * patch+gke.N patch in the 1.X version - "1.X.Y": picks the - * highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": - * picks an explicit Kubernetes version - "-": picks the default - * Kubernetes version + * The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version */ masterVersion?: string; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2028,8 +1543,7 @@ export namespace container_v1 { */ export interface Schema$UpdateNodePoolRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -2037,43 +1551,28 @@ export namespace container_v1 { */ imageType?: string; /** - * The name (project, location, cluster, node pool) of the node pool to - * update. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * The Kubernetes version to change the nodes to (typically an upgrade). - * Users may specify either explicit versions offered by Kubernetes Engine - * or version aliases, which have the following behavior: - - * "latest": picks the highest valid Kubernetes version - - * "1.X": picks the highest valid patch+gke.N patch in the 1.X - * version - "1.X.Y": picks the highest valid gke.N patch in - * the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes - * version - "-": picks the Kubernetes master version + * The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version */ nodeVersion?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * UsableSubnetwork resource returns the subnetwork name, its associated - * network and the primary CIDR range. + * UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range. */ export interface Schema$UsableSubnetwork { /** @@ -2089,15 +1588,11 @@ export namespace container_v1 { */ secondaryIpRanges?: Schema$UsableSubnetworkSecondaryRange[]; /** - * A human readable status message representing the reasons for cases where - * the caller cannot use the secondary ranges under the subnet. For example - * if the secondary_ip_ranges is empty due to a permission issue, an - * insufficient permission message will be given by status_message. + * A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message. */ statusMessage?: string; /** - * Subnetwork Name. Example: - * projects/my-project/regions/us-central1/subnetworks/my-subnet + * Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ subnetwork?: string; } @@ -2110,13 +1605,11 @@ export namespace container_v1 { */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. */ rangeName?: string; /** - * This field is to determine the status of the secondary range - * programmably. + * This field is to determine the status of the secondary range programmably. */ status?: string; } @@ -2153,8 +1646,7 @@ export namespace container_v1 { /** * container.projects.aggregated.usableSubnetworks.list - * @desc Lists subnetworks that are usable for creating clusters in a - * project. + * @desc Lists subnetworks that are usable for creating clusters in a project. * @alias container.projects.aggregated.usableSubnetworks.list * @memberOf! () * @@ -2246,27 +1738,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Filtering currently only supports equality on the networkProjectId and - * must be in the form: "networkProjectId=[PROJECTID]", where - * `networkProjectId` is the project which owns the listed subnetworks. This - * defaults to the parent project ID. + * Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` is the project which owns the listed subnetworks. This defaults to the parent project ID. */ filter?: string; /** - * The max number of results per page that should be returned. If the number - * of available results is larger than `page_size`, a `next_page_token` is - * returned which can be used to get the next page of results in subsequent - * requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * The max number of results per page that should be returned. If the number of available results is larger than `page_size`, a `next_page_token` is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ pageSize?: number; /** - * Specifies a page token to use. Set this to the nextPageToken returned by - * previous list requests to get the next page of results. + * Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results. */ pageToken?: string; /** - * The parent project where subnetworks are usable. Specified in the format - * 'projects/x'. + * The parent project where subnetworks are usable. Specified in the format 'projects/x'. */ parent?: string; } @@ -2285,8 +1769,7 @@ export namespace container_v1 { /** * container.projects.locations.getServerConfig - * @desc Returns configuration info about the Google Kubernetes Engine - * service. + * @desc Returns configuration info about the Google Kubernetes Engine service. * @alias container.projects.locations.getServerConfig * @memberOf! () * @@ -2369,20 +1852,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project and location) of the server config to get, specified in - * the format 'projects/x/locations/x'. + * The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2478,15 +1956,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.create - * @desc Creates a cluster, consisting of the specified number and type of - * Google Compute Engine instances. By default, the cluster is created in - * the project's [default - * network](/compute/docs/networks-and-firewalls#networks). One firewall is - * added for the cluster. After cluster creation, the Kubelet creates routes - * for each node to allow the containers on that node to communicate with - * all other instances in the cluster. Finally, an entry is added to the - * project's global metadata indicating which CIDR range the cluster is - * using. + * @desc Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @alias container.projects.locations.clusters.create * @memberOf! () * @@ -2561,11 +2031,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.delete - * @desc Deletes the cluster, including the Kubernetes endpoint and all - * worker nodes. Firewalls and routes that were configured during cluster - * creation are also deleted. Other Google Compute Engine resources that - * might be in use by the cluster, such as load balancer resources, are not - * deleted if they weren't present when the cluster was initially created. + * @desc Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. * @alias container.projects.locations.clusters.delete * @memberOf! () * @@ -2711,9 +2177,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.getJwks - * @desc Gets the public component of the cluster signing keys in JSON Web - * Key format. This API is not yet intended for general use, and is not - * available for all clusters. + * @desc Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters. * @alias container.projects.locations.clusters.getJwks * @memberOf! () * @@ -2788,8 +2252,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.list - * @desc Lists all clusters owned by a project in either the specified zone - * or all zones. + * @desc Lists all clusters owned by a project in either the specified zone or all zones. * @alias container.projects.locations.clusters.list * @memberOf! () * @@ -3244,9 +2707,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setMasterAuth - * @desc Sets master auth materials. Currently supports changing the admin - * password or a specific cluster, either via password generation or - * explicitly setting the password. + * @desc Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. * @alias container.projects.locations.clusters.setMasterAuth * @memberOf! () * @@ -3775,8 +3236,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to complete IP - * rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -3793,8 +3253,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the cluster will be created. - * Specified in the format 'projects/x/locations/x'. + * The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/x'. */ parent?: string; @@ -3811,25 +3270,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to delete. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -3841,25 +3294,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to retrieve. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -3871,8 +3318,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The cluster (project, location, cluster id) to get keys for. Specified in - * the format 'projects/x/locations/x/clusters/x'. + * The cluster (project, location, cluster id) to get keys for. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; } @@ -3884,22 +3330,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the clusters will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides, or - * "-" for all zones. This field has been deprecated and replaced by the - * parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -3911,8 +3350,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set addons. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -3929,8 +3367,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set legacy - * abac. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -3947,8 +3384,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set locations. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -3965,8 +3401,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set logging. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -3983,9 +3418,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set - * maintenance policy. Specified in the format - * 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4002,8 +3435,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set auth. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4020,8 +3452,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set monitoring. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4038,8 +3469,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set networking - * policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4056,8 +3486,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set labels. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4074,8 +3503,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to start IP - * rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4092,8 +3520,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4110,8 +3537,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4431,8 +3857,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.rollback - * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This - * makes no changes if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. * @alias container.projects.locations.clusters.nodePools.rollback * @memberOf! () * @@ -4811,8 +4236,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project, location, cluster id) where the node pool will be - * created. Specified in the format 'projects/x/locations/x/clusters/x'. + * The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; @@ -4829,31 +4253,23 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * delete. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4865,31 +4281,23 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * get. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4901,25 +4309,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * The parent (project, location, cluster id) where the node pools will be - * listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -4931,9 +4333,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool id) of the node poll to - * rollback upgrade. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -4950,9 +4350,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool) of the node pool to set - * autoscaler settings. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -4969,9 +4367,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set management properties. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -4988,9 +4384,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set size. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -5007,9 +4401,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool) of the node pool to - * update. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -5027,13 +4419,8 @@ export namespace container_v1 { /** * container.projects.locations.clusters.well-known.getOpenid-configuration - * @desc Gets the OIDC discovery document for the cluster. See the [OpenID - * Connect Discovery 1.0 - * specification](https://openid.net/specs/openid-connect-discovery-1_0.html) - * for details. This API is not yet intended for general use, and is not - * available for all clusters. - * @alias - * container.projects.locations.clusters.well-known.getOpenid-configuration + * @desc Gets the OIDC discovery document for the cluster. See the [OpenID Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) for details. This API is not yet intended for general use, and is not available for all clusters. + * @alias container.projects.locations.clusters.well-known.getOpenid-configuration * @memberOf! () * * @param {object} params Parameters for request @@ -5116,8 +4503,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The cluster (project, location, cluster id) to get the discovery document - * for. Specified in the format 'projects/x/locations/x/clusters/x'. + * The cluster (project, location, cluster id) to get the discovery document for. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; } @@ -5359,8 +4745,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, operation id) of the operation to cancel. - * Specified in the format 'projects/x/locations/x/operations/x'. + * The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/x'. */ name?: string; @@ -5377,25 +4762,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, operation id) of the operation to get. - * Specified in the format 'projects/x/locations/x/operations/x'. + * The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5407,22 +4786,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the operations will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for, or `-` - * for all zones. This field has been deprecated and replaced by the parent - * field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -5439,22 +4811,19 @@ export namespace container_v1 { /** * container.projects.zones.getServerconfig - * @desc Returns configuration info about the Google Kubernetes Engine - * service. + * @desc Returns configuration info about the Google Kubernetes Engine service. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5467,16 +4836,17 @@ export namespace container_v1 { * // number](https://support.google.com/cloud/answer/6158840). * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) + * // The name of the Google Compute Engine [zone](/compute/docs/zones#available) * // to return operations for. * zone: 'my-zone', // TODO: Update placeholder value. * * auth: authClient, * }; * - * container.projects.zones.getServerconfig(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.getServerconfig(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5490,10 +4860,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5579,20 +4948,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project and location) of the server config to get, specified in - * the format 'projects/x/locations/x'. + * The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5616,14 +4980,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5651,8 +5013,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.addons(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.addons(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5666,10 +5030,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5757,14 +5120,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5774,8 +5135,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -5793,8 +5153,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.completeIpRotation(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.completeIpRotation(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5808,10 +5170,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5892,29 +5253,19 @@ export namespace container_v1 { /** * container.projects.zones.clusters.create - * @desc Creates a cluster, consisting of the specified number and type of - * Google Compute Engine instances. By default, the cluster is created in - * the project's [default - * network](/compute/docs/networks-and-firewalls#networks). One firewall is - * added for the cluster. After cluster creation, the Kubelet creates routes - * for each node to allow the containers on that node to communicate with - * all other instances in the cluster. Finally, an entry is added to the - * project's global metadata indicating which CIDR range the cluster is - * using. + * @desc Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5939,8 +5290,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.create(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5954,10 +5307,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6036,25 +5388,19 @@ export namespace container_v1 { /** * container.projects.zones.clusters.delete - * @desc Deletes the cluster, including the Kubernetes endpoint and all - * worker nodes. Firewalls and routes that were configured during cluster - * creation are also deleted. Other Google Compute Engine resources that - * might be in use by the cluster, such as load balancer resources, are not - * deleted if they weren't present when the cluster was initially created. + * @desc Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6078,8 +5424,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.delete(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6093,10 +5441,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6184,14 +5531,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6215,8 +5560,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.get(request, function(err, response) - * { if (err) { console.error(err); return; + * container.projects.zones.clusters.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6230,10 +5577,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6319,14 +5665,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6354,8 +5698,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.legacyAbac(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.legacyAbac(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6369,10 +5715,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6453,22 +5798,19 @@ export namespace container_v1 { /** * container.projects.zones.clusters.list - * @desc Lists all clusters owned by a project in either the specified zone - * or all zones. + * @desc Lists all clusters owned by a project in either the specified zone or all zones. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6489,8 +5831,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.list(request, function(err, response) - * { if (err) { console.error(err); return; + * container.projects.zones.clusters.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6504,10 +5848,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6595,14 +5938,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6630,8 +5971,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.locations(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.locations(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6645,10 +5988,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6736,14 +6078,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6771,8 +6111,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.logging(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.logging(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6786,10 +6128,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6877,14 +6218,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6912,8 +6251,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.master(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.master(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6927,10 +6268,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7018,14 +6358,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7053,8 +6391,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.monitoring(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.monitoring(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -7068,10 +6408,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7159,14 +6498,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7176,8 +6513,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -7195,8 +6531,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.resourceLabels(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.resourceLabels(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -7210,10 +6548,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7301,14 +6638,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7336,8 +6671,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.setMaintenancePolicy(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.setMaintenancePolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -7351,10 +6688,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7437,23 +6773,19 @@ export namespace container_v1 { /** * container.projects.zones.clusters.setMasterAuth - * @desc Sets master auth materials. Currently supports changing the admin - * password or a specific cluster, either via password generation or - * explicitly setting the password. + * @desc Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7481,8 +6813,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.setMasterAuth(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.setMasterAuth(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -7496,10 +6830,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7587,14 +6920,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7604,8 +6935,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -7623,8 +6953,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.setNetworkPolicy(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.setNetworkPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -7638,10 +6970,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7729,14 +7060,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7746,8 +7075,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -7765,8 +7093,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.startIpRotation(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.startIpRotation(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -7780,10 +7110,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7871,14 +7200,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7900,16 +7227,17 @@ export namespace container_v1 { * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * * auth: authClient, * }; * - * container.projects.zones.clusters.update(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -7923,10 +7251,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -8014,20 +7341,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8044,20 +7366,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8074,15 +7391,11 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -8099,25 +7412,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to delete. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8129,25 +7436,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to retrieve. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8159,20 +7460,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8189,22 +7485,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the clusters will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides, or - * "-" for all zones. This field has been deprecated and replaced by the - * parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -8216,20 +7505,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8246,20 +7530,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8276,20 +7555,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8306,20 +7580,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8336,20 +7605,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8370,13 +7634,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). + * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string; /** - * The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. + * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string; @@ -8393,20 +7655,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8423,20 +7680,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8453,20 +7705,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8483,20 +7730,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8521,14 +7763,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -8559,8 +7799,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.autoscaling(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.autoscaling(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -8574,10 +7816,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -8666,14 +7907,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -8683,8 +7922,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -8702,8 +7940,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.create(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -8717,10 +7957,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -8808,14 +8047,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -8825,8 +8062,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -8843,8 +8079,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.delete(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -8858,10 +8096,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -8950,14 +8187,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -8967,8 +8202,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -8985,8 +8219,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.get(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -9000,10 +8236,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -9090,14 +8325,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -9107,8 +8340,7 @@ export namespace container_v1 { * authorize(function(authClient) { * var request = { * // The Google Developers Console [project ID or project - * // - * number](https://developers.google.com/console/help/new/#projectnumber). + * // number](https://developers.google.com/console/help/new/#projectnumber). * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine @@ -9122,8 +8354,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.list(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -9137,10 +8371,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -9223,22 +8456,19 @@ export namespace container_v1 { /** * container.projects.zones.clusters.nodePools.rollback - * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This - * makes no changes if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -9269,8 +8499,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.rollback(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.rollback(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -9284,10 +8516,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -9376,14 +8607,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -9414,8 +8643,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.setManagement(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.setManagement(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -9429,10 +8660,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -9521,14 +8751,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -9559,8 +8787,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.setSize(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.setSize(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -9574,10 +8804,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -9666,14 +8895,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -9704,8 +8931,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.clusters.nodePools.update(request, - * function(err, response) { if (err) { console.error(err); return; + * container.projects.zones.clusters.nodePools.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -9719,10 +8948,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -9811,25 +9039,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9846,20 +9068,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -9876,31 +9093,23 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * delete. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -9912,31 +9121,23 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * get. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -9948,25 +9149,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * The parent (project, location, cluster id) where the node pools will be - * listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -9978,25 +9173,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -10013,25 +9202,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -10048,25 +9231,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -10083,25 +9260,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -10126,14 +9297,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -10147,8 +9316,8 @@ export namespace container_v1 { * projectId: 'my-project-id', // TODO: Update placeholder value. * * // The name of the Google Compute Engine - * // [zone](/compute/docs/zones#available) in which the operation - * resides. zone: 'my-zone', // TODO: Update placeholder value. + * // [zone](/compute/docs/zones#available) in which the operation resides. + * zone: 'my-zone', // TODO: Update placeholder value. * * // The server-assigned `name` of the operation. * operationId: 'my-operation-id', // TODO: Update placeholder value. @@ -10174,10 +9343,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -10263,14 +9431,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -10294,8 +9460,10 @@ export namespace container_v1 { * auth: authClient, * }; * - * container.projects.zones.operations.get(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -10309,10 +9477,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -10400,14 +9567,12 @@ export namespace container_v1 { * // 1. If not already done, enable the Google Container Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -10420,16 +9585,17 @@ export namespace container_v1 { * // number](https://support.google.com/cloud/answer/6158840). * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) + * // The name of the Google Compute Engine [zone](/compute/docs/zones#available) * // to return operations for, or `-` for all zones. * zone: 'my-zone', // TODO: Update placeholder value. * * auth: authClient, * }; * - * container.projects.zones.operations.list(request, function(err, - * response) { if (err) { console.error(err); return; + * container.projects.zones.operations.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -10443,10 +9609,9 @@ export namespace container_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -10534,20 +9699,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the operation resides. - * This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -10564,25 +9724,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, operation id) of the operation to get. - * Specified in the format 'projects/x/locations/x/operations/x'. + * The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -10594,22 +9748,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the operations will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for, or `-` - * for all zones. This field has been deprecated and replaced by the parent - * field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index a4951acd49a..91f7d58387a 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace container_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace container_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace container_v1beta1 { /** * Kubernetes Engine API * - * Builds and manages container-based applications, powered by the open source - * Kubernetes technology. + * Builds and manages container-based applications, powered by the open source Kubernetes technology. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace container_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -128,36 +126,28 @@ export namespace container_v1beta1 { */ acceleratorCount?: string; /** - * The accelerator type resource name. List of supported accelerators - * [here](/compute/docs/gpus/#Introduction) + * The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus/#Introduction) */ acceleratorType?: string; } /** - * Configuration for the addons that can be automatically spun up in the - * cluster, enabling additional functionality. + * Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. */ export interface Schema$AddonsConfig { /** - * Configuration for the Cloud Run addon. The `IstioConfig` addon must be - * enabled in order to enable Cloud Run addon. This option can only be - * enabled at cluster creation time. + * Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time. */ cloudRunConfig?: Schema$CloudRunConfig; /** - * Configuration for the horizontal pod autoscaling feature, which increases - * or decreases the number of replica pods a replication controller has - * based on the resource usage of the existing pods. + * Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. */ horizontalPodAutoscaling?: Schema$HorizontalPodAutoscaling; /** - * Configuration for the HTTP (L7) load balancing controller addon, which - * makes it easy to set up HTTP load balancers for services in a cluster. + * Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. */ httpLoadBalancing?: Schema$HttpLoadBalancing; /** - * Configuration for Istio, an open platform to connect, manage, and secure - * microservices. + * Configuration for Istio, an open platform to connect, manage, and secure microservices. */ istioConfig?: Schema$IstioConfig; /** @@ -165,9 +155,7 @@ export namespace container_v1beta1 { */ kubernetesDashboard?: Schema$KubernetesDashboard; /** - * Configuration for NetworkPolicy. This only tracks whether the addon is - * enabled or not on the Master, it does not track whether network policy is - * enabled for the nodes. + * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ networkPolicyConfig?: Schema$NetworkPolicyConfig; } @@ -176,30 +164,37 @@ export namespace container_v1beta1 { */ export interface Schema$AuthenticatorGroupsConfig { /** - * Whether this cluster should return group membership lookups during - * authentication using a group of security groups. + * Whether this cluster should return group membership lookups during authentication using a group of security groups. */ enabled?: boolean; /** - * The name of the security group-of-groups to be used. Only relevant if - * enabled = true. + * The name of the security group-of-groups to be used. Only relevant if enabled = true. */ securityGroup?: string; } /** - * AutoUpgradeOptions defines the set of options for the user to control how - * the Auto Upgrades will proceed. + * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. + */ + export interface Schema$AutoprovisioningNodePoolDefaults { + /** + * Scopes that are used by NAP when creating node pools. If oauth_scopes are specified, service_account should be empty. + */ + oauthScopes?: string[]; + /** + * The Google Cloud Platform Service Account to be used by the node VMs. If service_account is specified, scopes should be empty. + */ + serviceAccount?: string; + } + /** + * AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. */ export interface Schema$AutoUpgradeOptions { /** - * [Output only] This field is set when upgrades are about to commence with - * the approximate start time for the upgrades, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ autoUpgradeStartTime?: string; /** - * [Output only] This field is set when upgrades are about to commence with - * the description of the upgrade. + * [Output only] This field is set when upgrades are about to commence with the description of the upgrade. */ description?: string; } @@ -217,8 +212,7 @@ export namespace container_v1beta1 { */ export interface Schema$BinaryAuthorization { /** - * Enable Binary Authorization for this cluster. If enabled, all container - * images will be validated by Google Binauthz. + * Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binauthz. */ enabled?: boolean; } @@ -227,25 +221,19 @@ export namespace container_v1beta1 { */ export interface Schema$CancelOperationRequest { /** - * The name (project, location, operation id) of the operation to cancel. - * Specified in the format 'projects/x/locations/x/operations/*'. + * The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/*'. */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the operation resides. - * This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -301,10 +289,7 @@ export namespace container_v1beta1 { */ binaryAuthorization?: Schema$BinaryAuthorization; /** - * The IP address range of the container pods in this cluster, in - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically - * chosen or specify a `/14` block in `10.0.0.0/8`. + * The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`. */ clusterIpv4Cidr?: string; /** @@ -312,8 +297,7 @@ export namespace container_v1beta1 { */ conditions?: Schema$StatusCondition[]; /** - * [Output only] The time the cluster was created, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ createTime?: string; /** @@ -321,16 +305,11 @@ export namespace container_v1beta1 { */ currentMasterVersion?: string; /** - * [Output only] The number of nodes currently in the cluster. Deprecated. - * Call Kubernetes API directly to retrieve node information. + * [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. */ currentNodeCount?: number; /** - * [Output only] Deprecated, use - * [NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) - * instead. The current version of the node software components. If they are - * currently at multiple versions because they're in the process of - * being upgraded, this reflects the minimum version of all nodes. + * [Output only] Deprecated, use [NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string; /** @@ -338,9 +317,7 @@ export namespace container_v1beta1 { */ databaseEncryption?: Schema$DatabaseEncryption; /** - * The default constraint on the maximum number of pods that can be run - * simultaneously on a node in the node pool of this cluster. Only honored - * if cluster created with IP Alias support. + * The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support. */ defaultMaxPodsConstraint?: Schema$MaxPodsConstraint; /** @@ -348,11 +325,7 @@ export namespace container_v1beta1 { */ description?: string; /** - * Kubernetes alpha features are enabled on this cluster. This includes - * alpha API groups (e.g. v1beta1) and features that may not be production - * ready in the kubernetes version of the master and nodes. The cluster has - * no SLA for uptime and master/node upgrades are disabled. Alpha enabled - * clusters are automatically deleted thirty days after creation. + * Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. */ enableKubernetesAlpha?: boolean; /** @@ -360,41 +333,19 @@ export namespace container_v1beta1 { */ enableTpu?: boolean; /** - * [Output only] The IP address of this cluster's master endpoint. The - * endpoint can be accessed from the internet at - * `https://username:password@endpoint/`. See the `masterAuth` property of - * this resource for username and password information. + * [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. */ endpoint?: string; /** - * [Output only] The time the cluster will be automatically deleted in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ expireTime?: string; /** - * The initial Kubernetes version for this cluster. Valid versions are - * those found in validMasterVersions returned by getServerConfig. The - * version can be upgraded over time; such upgrades are reflected in - * currentMasterVersion and currentNodeVersion. Users may specify either - * explicit versions offered by Kubernetes Engine or version aliases, which - * have the following behavior: - "latest": picks the highest - * valid Kubernetes version - "1.X": picks the highest valid - * patch+gke.N patch in the 1.X version - "1.X.Y": picks the - * highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": - * picks an explicit Kubernetes version - "","-": picks - * the default Kubernetes version + * The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version */ initialClusterVersion?: string; /** - * The number of nodes to create in this cluster. You must ensure that your - * Compute Engine <a - * href="/compute/docs/resource-quotas">resource - * quota</a> is sufficient for this number of instances. You must also - * have available firewall and routes quota. For requests, this field should - * only be used in lieu of a "node_pool" object, since this - * configuration (along with the "node_config") will be used to - * create a "NodePool" object with an auto-generated name. Do not - * use this and a node_pool at the same time. + * The number of nodes to create in this cluster. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. */ initialNodeCount?: number; /** @@ -414,22 +365,15 @@ export namespace container_v1beta1 { */ legacyAbac?: Schema$LegacyAbac; /** - * [Output only] The name of the Google Compute Engine - * [zone](/compute/docs/regions-zones/regions-zones#available) or - * [region](/compute/docs/regions-zones/regions-zones#available) in which - * the cluster resides. + * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string; /** - * The list of Google Compute Engine [zones](/compute/docs/zones#available) - * in which the cluster's nodes should be located. + * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. */ locations?: string[]; /** - * The logging service the cluster should use to write logs. Currently - * available options: * `logging.googleapis.com` - the Google Cloud Logging - * service. * `none` - no logs will be exported from the cluster. * if left - * as an empty string,`logging.googleapis.com` will be used. + * The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. */ loggingService?: string; /** @@ -437,11 +381,7 @@ export namespace container_v1beta1 { */ maintenancePolicy?: Schema$MaintenancePolicy; /** - * The authentication information for accessing the master endpoint. If - * unspecified, the defaults are used: For clusters before v1.12, if - * master_auth is unspecified, `username` will be set to "admin", - * a random password will be generated, and a client certificate will be - * issued. + * The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. */ masterAuth?: Schema$MasterAuth; /** @@ -449,32 +389,19 @@ export namespace container_v1beta1 { */ masterAuthorizedNetworksConfig?: Schema$MasterAuthorizedNetworksConfig; /** - * The IP prefix in CIDR notation to use for the hosted master network. This - * prefix will be used for assigning private IP addresses to the master or - * set of masters, as well as the ILB VIP. This field is deprecated, use - * private_cluster_config.master_ipv4_cidr_block instead. + * The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. */ masterIpv4CidrBlock?: string; /** - * The monitoring service the cluster should use to write metrics. Currently - * available options: * `monitoring.googleapis.com` - the Google Cloud - * Monitoring service. * `none` - no metrics will be exported from the - * cluster. * if left as an empty string, `monitoring.googleapis.com` will - * be used. + * The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used. */ monitoringService?: string; /** - * The name of this cluster. The name must be unique within this project and - * zone, and can be up to 40 characters with the following restrictions: * - * Lowercase letters, numbers, and hyphens only. * Must start with a letter. - * * Must end with a number or a letter. + * The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. */ name?: string; /** - * The name of the Google Compute Engine - * [network](/compute/docs/networks-and-firewalls#networks) to which the - * cluster is connected. If left unspecified, the `default` network will be - * used. On output this shows the network ID instead of the name. + * The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. */ network?: string; /** @@ -486,26 +413,15 @@ export namespace container_v1beta1 { */ networkPolicy?: Schema$NetworkPolicy; /** - * Parameters used in creating the cluster's nodes. See `nodeConfig` for - * the description of its properties. For requests, this field should only - * be used in lieu of a "node_pool" object, since this - * configuration (along with the "initial_node_count") will be - * used to create a "NodePool" object with an auto-generated name. - * Do not use this and a node_pool at the same time. For responses, this - * field will be populated with the node configuration of the first node - * pool. If unspecified, the defaults are used. + * Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead. */ nodeConfig?: Schema$NodeConfig; /** - * [Output only] The size of the address space on each node for hosting - * containers. This is provisioned from within the `container_ipv4_cidr` - * range. + * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. */ nodeIpv4CidrSize?: number; /** - * The node pools associated with this cluster. This field should not be set - * if "node_config" or "initial_node_count" are - * specified. + * The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. */ nodePools?: Schema$NodePool[]; /** @@ -513,10 +429,7 @@ export namespace container_v1beta1 { */ podSecurityPolicyConfig?: Schema$PodSecurityPolicyConfig; /** - * If this is a private cluster setup. Private clusters are clusters that, - * by default have no external IP addresses on the nodes and where nodes and - * the master communicate over private IP addresses. This field is - * deprecated, use private_cluster_config.enable_private_nodes instead. + * If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead. */ privateCluster?: boolean; /** @@ -524,13 +437,11 @@ export namespace container_v1beta1 { */ privateClusterConfig?: Schema$PrivateClusterConfig; /** - * The resource labels for the cluster to use to annotate any related Google - * Compute Engine resources. + * The resource labels for the cluster to use to annotate any related Google Compute Engine resources. */ resourceLabels?: {[key: string]: string}; /** - * Configuration for exporting resource usages. Resource usage export is - * disabled when this config unspecified. + * Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified. */ resourceUsageExportConfig?: Schema$ResourceUsageExportConfig; /** @@ -538,11 +449,7 @@ export namespace container_v1beta1 { */ selfLink?: string; /** - * [Output only] The IP address range of the Kubernetes services in this - * cluster, in - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the - * last `/16` from the container CIDR. + * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ servicesIpv4Cidr?: string; /** @@ -550,20 +457,15 @@ export namespace container_v1beta1 { */ status?: string; /** - * [Output only] Additional information about the current status of this - * cluster, if available. + * [Output only] Additional information about the current status of this cluster, if available. */ statusMessage?: string; /** - * The name of the Google Compute Engine - * [subnetwork](/compute/docs/subnetworks) to which the cluster is - * connected. On output this shows the subnetwork ID instead of the name. + * The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. */ subnetwork?: string; /** - * [Output only] The IP address range of the Cloud TPUs in this cluster, in - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `1.2.3.4/29`). + * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string; /** @@ -571,32 +473,29 @@ export namespace container_v1beta1 { */ verticalPodAutoscaling?: Schema$VerticalPodAutoscaling; /** - * [Output only] The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field is deprecated, use location instead. + * [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ zone?: string; } /** - * ClusterAutoscaling contains global, per-cluster information required by - * Cluster Autoscaler to automatically adjust the size of the cluster and - * create/delete node pools based on the current needs. + * ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. */ export interface Schema$ClusterAutoscaling { + /** + * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. + */ + autoprovisioningNodePoolDefaults?: Schema$AutoprovisioningNodePoolDefaults; /** * Enables automatic node pool creation and deletion. */ enableNodeAutoprovisioning?: boolean; /** - * Contains global constraints regarding minimum and maximum amount of - * resources in the cluster. + * Contains global constraints regarding minimum and maximum amount of resources in the cluster. */ resourceLimits?: Schema$ResourceLimit[]; } /** - * ClusterUpdate describes an update to the cluster. Exactly one update can be - * applied to a cluster with each request, so at most one field can be - * provided. + * ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. */ export interface Schema$ClusterUpdate { /** @@ -616,8 +515,7 @@ export namespace container_v1beta1 { */ desiredDatabaseEncryption?: Schema$DatabaseEncryption; /** - * The desired image type for the node pool. NOTE: Set the - * "desired_node_pool" field as well. + * The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. */ desiredImageType?: string; /** @@ -625,21 +523,11 @@ export namespace container_v1beta1 { */ desiredIntraNodeVisibilityConfig?: Schema$IntraNodeVisibilityConfig; /** - * The desired list of Google Compute Engine - * [zones](/compute/docs/zones#available) in which the cluster's nodes - * should be located. Changing the locations a cluster is in will result in - * nodes being either created or removed from the cluster, depending on - * whether locations are being added or removed. This list must always - * include the cluster's primary zone. + * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ desiredLocations?: string[]; /** - * The logging service the cluster should use to write metrics. Currently - * available options: * "logging.googleapis.com/kubernetes" - the - * Google Cloud Logging service with Kubernetes-native resource model in - * Stackdriver * "logging.googleapis.com" - the Google Cloud - * Logging service * "none" - no logs will be exported from the - * cluster + * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster */ desiredLoggingService?: string; /** @@ -647,48 +535,23 @@ export namespace container_v1beta1 { */ desiredMasterAuthorizedNetworksConfig?: Schema$MasterAuthorizedNetworksConfig; /** - * The Kubernetes version to change the master to. The only valid value is - * the latest supported version. Users may specify either explicit versions - * offered by Kubernetes Engine or version aliases, which have the following - * behavior: - "latest": picks the highest valid Kubernetes - * version - "1.X": picks the highest valid patch+gke.N patch in - * the 1.X version - "1.X.Y": picks the highest valid gke.N patch - * in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit - * Kubernetes version - "-": picks the default Kubernetes version + * The Kubernetes version to change the master to. The only valid value is the latest supported version. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version */ desiredMasterVersion?: string; /** - * The monitoring service the cluster should use to write metrics. Currently - * available options: * "monitoring.googleapis.com/kubernetes" - - * the Google Cloud Monitoring service with Kubernetes-native resource model - * in Stackdriver * "monitoring.googleapis.com" - the Google Cloud - * Monitoring service * "none" - no metrics will be exported from - * the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ desiredMonitoringService?: string; /** - * Autoscaler configuration for the node pool specified in - * desired_node_pool_id. If there is only one pool in the cluster and - * desired_node_pool_id is not provided then the change applies to that - * single node pool. + * Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. */ desiredNodePoolAutoscaling?: Schema$NodePoolAutoscaling; /** - * The node pool to be upgraded. This field is mandatory if - * "desired_node_version", "desired_image_family" or - * "desired_node_pool_autoscaling" is specified and there is more - * than one node pool on the cluster. + * The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. */ desiredNodePoolId?: string; /** - * The Kubernetes version to change the nodes to (typically an upgrade). - * Users may specify either explicit versions offered by Kubernetes Engine - * or version aliases, which have the following behavior: - - * "latest": picks the highest valid Kubernetes version - - * "1.X": picks the highest valid patch+gke.N patch in the 1.X - * version - "1.X.Y": picks the highest valid gke.N patch in - * the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes - * version - "-": picks the Kubernetes master version + * The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version */ desiredNodeVersion?: string; /** @@ -705,31 +568,23 @@ export namespace container_v1beta1 { desiredVerticalPodAutoscaling?: Schema$VerticalPodAutoscaling; } /** - * CompleteIPRotationRequest moves the cluster master back into single-IP - * mode. + * CompleteIPRotationRequest moves the cluster master back into single-IP mode. */ export interface Schema$CompleteIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster id) of the cluster to complete IP - * rotation. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -738,25 +593,19 @@ export namespace container_v1beta1 { */ export interface Schema$CreateClusterRequest { /** - * A [cluster - * resource](/container-engine/reference/rest/v1beta1/projects.zones.clusters) + * A [cluster resource](/container-engine/reference/rest/v1beta1/projects.zones.clusters) */ cluster?: Schema$Cluster; /** - * The parent (project and location) where the cluster will be created. - * Specified in the format 'projects/x/locations/*'. + * The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/*'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -765,8 +614,7 @@ export namespace container_v1beta1 { */ export interface Schema$CreateNodePoolRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** @@ -774,21 +622,15 @@ export namespace container_v1beta1 { */ nodePool?: Schema$NodePool; /** - * The parent (project, location, cluster id) where the node pool will be - * created. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/*'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -797,14 +639,11 @@ export namespace container_v1beta1 { */ export interface Schema$DailyMaintenanceWindow { /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. + * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ duration?: string; /** - * Time within the maintenance window to start the maintenance operations. - * It must be in format "HH:MM”, where HH : [00-23] and MM : [00-59] - * GMT. + * Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM”, where HH : [00-23] and MM : [00-59] GMT. */ startTime?: string; } @@ -813,8 +652,7 @@ export namespace container_v1beta1 { */ export interface Schema$DatabaseEncryption { /** - * Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. - * projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key + * Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key */ keyName?: string; /** @@ -823,27 +661,20 @@ export namespace container_v1beta1 { state?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc - * 7517 + * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 */ export interface Schema$GetJSONWebKeysResponse { /** - * The public component of the keys used by the cluster to sign token - * requests. + * The public component of the keys used by the cluster to sign token requests. */ keys?: Schema$Jwk[]; } /** - * GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See - * the OpenID Connect Discovery 1.0 specification for details. + * GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details. */ export interface Schema$GetOpenIDConfigResponse { /** @@ -876,34 +707,25 @@ export namespace container_v1beta1 { subject_types_supported?: string[]; } /** - * Configuration options for the horizontal pod autoscaling feature, which - * increases or decreases the number of replica pods a replication controller - * has based on the resource usage of the existing pods. + * Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. */ export interface Schema$HorizontalPodAutoscaling { /** - * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. - * When enabled, it ensures that a Heapster pod is running in the cluster, - * which is also used by the Cloud Monitoring service. + * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service. */ disabled?: boolean; } /** - * Configuration options for the HTTP (L7) load balancing controller addon, - * which makes it easy to set up HTTP load balancers for services in a - * cluster. + * Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. */ export interface Schema$HttpLoadBalancing { /** - * Whether the HTTP Load Balancing controller is enabled in the cluster. - * When enabled, it runs a small pod in the cluster that manages the load - * balancers. + * Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. */ disabled?: boolean; } /** - * IntraNodeVisibilityConfig contains the desired config of the intra-node - * visibility on this cluster. + * IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. */ export interface Schema$IntraNodeVisibilityConfig { /** @@ -916,16 +738,7 @@ export namespace container_v1beta1 { */ export interface Schema$IPAllocationPolicy { /** - * If true, allow allocation of cluster CIDR ranges that overlap with - * certain kinds of network routes. By default we do not allow cluster CIDR - * ranges to intersect with any user declared routes. With - * allow_route_overlap == true, we allow overlapping with CIDR ranges that - * are larger than the cluster CIDR range. If this field is set to true, - * then cluster and services CIDRs must be fully-specified (e.g. - * `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is - * true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be - * fully-specified. 2) When `use_ip_aliases` is false, - * `cluster.cluster_ipv4_cidr` muse be fully-specified. + * If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. */ allowRouteOverlap?: boolean; /** @@ -933,28 +746,15 @@ export namespace container_v1beta1 { */ clusterIpv4Cidr?: string; /** - * The IP address range for the cluster pod IPs. If this field is set, then - * `cluster.cluster_ipv4_cidr` must be left blank. This field is only - * applicable when `use_ip_aliases` is true. Set to blank to have a range - * chosen with the default size. Set to /netmask (e.g. `/14`) to have a - * range chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ clusterIpv4CidrBlock?: string; /** - * The name of the secondary range to be used for the cluster CIDR block. - * The secondary range will be used for pod IP addresses. This must be an - * existing secondary range associated with the cluster subnetwork. This - * field is only applicable with use_ip_aliases and create_subnetwork is - * false. + * The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. */ clusterSecondaryRangeName?: string; /** - * Whether a new subnetwork will be created automatically for the cluster. - * This field is only applicable when `use_ip_aliases` is true. + * Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. */ createSubnetwork?: boolean; /** @@ -962,14 +762,7 @@ export namespace container_v1beta1 { */ nodeIpv4Cidr?: string; /** - * The IP address range of the instance IPs in this cluster. This is - * applicable only if `create_subnetwork` is true. Set to blank to have a - * range chosen with the default size. Set to /netmask (e.g. `/14`) to have - * a range chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ nodeIpv4CidrBlock?: string; /** @@ -977,41 +770,19 @@ export namespace container_v1beta1 { */ servicesIpv4Cidr?: string; /** - * The IP address range of the services IPs in this cluster. If blank, a - * range will be automatically chosen with the default size. This field is - * only applicable when `use_ip_aliases` is true. Set to blank to have a - * range chosen with the default size. Set to /netmask (e.g. `/14`) to have - * a range chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ servicesIpv4CidrBlock?: string; /** - * The name of the secondary range to be used as for the services CIDR - * block. The secondary range will be used for service ClusterIPs. This - * must be an existing secondary range associated with the cluster - * subnetwork. This field is only applicable with use_ip_aliases and - * create_subnetwork is false. + * The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. */ servicesSecondaryRangeName?: string; /** - * A custom subnetwork name to be used if `create_subnetwork` is true. If - * this field is empty, then an automatic name will be chosen for the new - * subnetwork. + * A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. */ subnetworkName?: string; /** - * The IP address range of the Cloud TPUs in this cluster. If unspecified, a - * range will be automatically chosen with the default size. This field is - * only applicable when `use_ip_aliases` is true. If unspecified, the range - * will use the default size. Set to /netmask (e.g. `/14`) to have a range - * chosen with a specific netmask. Set to a - * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - * to use. + * The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */ tpuIpv4CidrBlock?: string; /** @@ -1083,15 +854,11 @@ export namespace container_v1beta1 { disabled?: boolean; } /** - * Configuration for the legacy Attribute Based Access Control authorization - * mode. + * Configuration for the legacy Attribute Based Access Control authorization mode. */ export interface Schema$LegacyAbac { /** - * Whether the ABAC authorizer is enabled for this cluster. When enabled, - * identities in the system, including service accounts, nodes, and - * controllers, will have statically granted permissions beyond those - * provided by the RBAC configuration or IAM. + * Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. */ enabled?: boolean; } @@ -1100,19 +867,16 @@ export namespace container_v1beta1 { */ export interface Schema$ListClustersResponse { /** - * A list of clusters in the project in the specified zone, or across all - * ones. + * A list of clusters in the project in the specified zone, or across all ones. */ clusters?: Schema$Cluster[]; /** - * If any zones are listed here, the list of clusters returned may be - * missing those zones. + * If any zones are listed here, the list of clusters returned may be missing those zones. */ missingZones?: string[]; } /** - * ListLocationsResponse returns the list of all GKE locations and their - * recommendation state. + * ListLocationsResponse returns the list of all GKE locations and their recommendation state. */ export interface Schema$ListLocationsResponse { /** @@ -1120,10 +884,7 @@ export namespace container_v1beta1 { */ locations?: Schema$Location[]; /** - * Only return ListLocationsResponse that occur after the page_token. This - * value should be populated from the ListLocationsResponse.next_page_token - * if that response token was set (which happens when listing more Locations - * than fit in a single ListLocationsResponse). + * Only return ListLocationsResponse that occur after the page_token. This value should be populated from the ListLocationsResponse.next_page_token if that response token was set (which happens when listing more Locations than fit in a single ListLocationsResponse). */ nextPageToken?: string; } @@ -1141,8 +902,7 @@ export namespace container_v1beta1 { */ export interface Schema$ListOperationsResponse { /** - * If any zones are listed here, the list of operations returned may be - * missing the operations from those zones. + * If any zones are listed here, the list of operations returned may be missing the operations from those zones. */ missingZones?: string[]; /** @@ -1151,15 +911,11 @@ export namespace container_v1beta1 { operations?: Schema$Operation[]; } /** - * ListUsableSubnetworksResponse is the response of - * ListUsableSubnetworksRequest. + * ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. */ export interface Schema$ListUsableSubnetworksResponse { /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `page_size`, use the - * `next_page_token` as a value for the query parameter `page_token` in the - * next request. The value will become empty when there are no more pages. + * This token allows you to get the next page of results for list requests. If the number of results is larger than `page_size`, use the `next_page_token` as a value for the query parameter `page_token` in the next request. The value will become empty when there are no more pages. */ nextPageToken?: string; /** @@ -1168,13 +924,11 @@ export namespace container_v1beta1 { subnetworks?: Schema$UsableSubnetwork[]; } /** - * Location returns the location name, and if the location is recommended for - * GKE cluster scheduling. + * Location returns the location name, and if the location is recommended for GKE cluster scheduling. */ export interface Schema$Location { /** - * Contains the name of the resource requested. Specified in the format - * 'projects/x/locations/*'. + * Contains the name of the resource requested. Specified in the format 'projects/x/locations/*'. */ name?: string; /** @@ -1187,8 +941,7 @@ export namespace container_v1beta1 { type?: string; } /** - * MaintenancePolicy defines the maintenance policy to be used for the - * cluster. + * MaintenancePolicy defines the maintenance policy to be used for the cluster. */ export interface Schema$MaintenancePolicy { /** @@ -1197,8 +950,7 @@ export namespace container_v1beta1 { window?: Schema$MaintenanceWindow; } /** - * MaintenanceWindow defines the maintenance window to be used for the - * cluster. + * MaintenanceWindow defines the maintenance window to be used for the cluster. */ export interface Schema$MaintenanceWindow { /** @@ -1207,56 +959,40 @@ export namespace container_v1beta1 { dailyMaintenanceWindow?: Schema$DailyMaintenanceWindow; } /** - * The authentication information for accessing the master endpoint. - * Authentication can be done using HTTP basic auth or using client - * certificates. + * The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. */ export interface Schema$MasterAuth { /** - * [Output only] Base64-encoded public certificate used by clients to - * authenticate to the cluster endpoint. + * [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. */ clientCertificate?: string; /** - * Configuration for client certificate authentication on the cluster. For - * clusters before v1.12, if no configuration is specified, a client - * certificate is issued. + * Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. */ clientCertificateConfig?: Schema$ClientCertificateConfig; /** - * [Output only] Base64-encoded private key used by clients to authenticate - * to the cluster endpoint. + * [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. */ clientKey?: string; /** - * [Output only] Base64-encoded public certificate that is the root of trust - * for the cluster. + * [Output only] Base64-encoded public certificate that is the root of trust for the cluster. */ clusterCaCertificate?: string; /** - * The password to use for HTTP basic authentication to the master endpoint. - * Because the master endpoint is open to the Internet, you should create a - * strong password. If a password is provided for cluster creation, - * username must be non-empty. + * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. */ password?: string; /** - * The username to use for HTTP basic authentication to the master endpoint. - * For clusters v1.6.0 and later, basic authentication can be disabled by - * leaving username unspecified (or setting it to the empty string). + * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). */ username?: string; } /** - * Configuration options for the master authorized networks feature. Enabled - * master authorized networks will disallow all external traffic to access - * Kubernetes master through HTTPS except traffic from the given CIDR blocks, - * Google Compute Engine Public IPs and Google Prod IPs. + * Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. */ export interface Schema$MasterAuthorizedNetworksConfig { /** - * cidr_blocks define up to 10 external networks that could access - * Kubernetes master through HTTPS. + * cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. */ cidrBlocks?: Schema$CidrBlock[]; /** @@ -1286,8 +1022,7 @@ export namespace container_v1beta1 { */ intValue?: string; /** - * Metric name, required. e.g., "nodes total", "percent - * done" + * Metric name, required. e.g., "nodes total", "percent done" */ name?: string; /** @@ -1300,27 +1035,20 @@ export namespace container_v1beta1 { */ export interface Schema$NetworkConfig { /** - * Whether Intra-node visibility is enabled for this cluster. This makes - * same node pod to pod traffic visible for VPC network. + * Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. */ enableIntraNodeVisibility?: boolean; /** - * Output only. The relative name of the Google Compute Engine - * network(/compute/docs/networks-and-firewalls#networks) to which the - * cluster is connected. Example: - * projects/my-project/global/networks/my-network + * Output only. The relative name of the Google Compute Engine network(/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network */ network?: string; /** - * Output only. The relative name of the Google Compute Engine - * [subnetwork](/compute/docs/vpc) to which the cluster is connected. - * Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + * Output only. The relative name of the Google Compute Engine [subnetwork](/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ subnetwork?: string; } /** - * Configuration options for the NetworkPolicy feature. - * https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ + * Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ */ export interface Schema$NetworkPolicy { /** @@ -1333,9 +1061,7 @@ export namespace container_v1beta1 { provider?: string; } /** - * Configuration for NetworkPolicy. This only tracks whether the addon is - * enabled or not on the Master, it does not track whether network policy is - * enabled for the nodes. + * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ export interface Schema$NetworkPolicyConfig { /** @@ -1348,98 +1074,47 @@ export namespace container_v1beta1 { */ export interface Schema$NodeConfig { /** - * A list of hardware accelerators to be attached to each node. See - * https://cloud.google.com/compute/docs/gpus for more information about - * support for GPUs. + * A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. */ accelerators?: Schema$AcceleratorConfig[]; /** - * Size of the disk attached to each node, specified in GB. The smallest - * allowed disk size is 10GB. If unspecified, the default disk size is - * 100GB. + * Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. */ diskSizeGb?: number; /** - * Type of the disk attached to each node (e.g. 'pd-standard' or - * 'pd-ssd') If unspecified, the default disk type is - * 'pd-standard' + * Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard' */ diskType?: string; /** - * The image type to use for this node. Note that for a given image type, - * the latest version of it will be used. + * The image type to use for this node. Note that for a given image type, the latest version of it will be used. */ imageType?: string; /** - * The map of Kubernetes labels (key/value pairs) to be applied to each - * node. These will added in addition to any default label(s) that - * Kubernetes may apply to the node. In case of conflict in label keys, the - * applied set may differ depending on the Kubernetes version -- it's - * best to assume the behavior is undefined and conflicts should be avoided. - * For more information, including usage and the valid values, see: - * https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ + * The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ */ labels?: {[key: string]: string}; /** - * The number of local SSD disks to be attached to the node. The limit for - * this value is dependant upon the maximum number of disks available on a - * machine per zone. See: - * https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits - * for more information. + * The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information. */ localSsdCount?: number; /** - * The name of a Google Compute Engine [machine - * type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If - * unspecified, the default machine type is `n1-standard-1`. + * The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`. */ machineType?: string; /** - * The metadata key/value pairs assigned to instances in the cluster. Keys - * must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in - * length. These are reflected as part of a URL in the metadata server. - * Additionally, to avoid ambiguity, keys must not conflict with any other - * metadata keys for the project or be one of the reserved keys: - * "cluster-location" "cluster-name" - * "cluster-uid" "configure-sh" - * "containerd-configure-sh" "enable-oslogin" - * "gci-ensure-gke-docker" "gci-update-strategy" - * "instance-template" "kube-env" - * "startup-script" "user-data" Values are free-form - * strings, and only have meaning as interpreted by the image running in the - * instance. The only restriction placed on them is that each value's - * size must be less than or equal to 32 KB. The total size of all keys and - * values must be less than 512 KB. + * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-oslogin" "gci-ensure-gke-docker" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. */ metadata?: {[key: string]: string}; /** - * Minimum CPU platform to be used by this instance. The instance may be - * scheduled on the specified or newer CPU platform. Applicable values are - * the friendly names of CPU platforms, such as <code>minCpuPlatform: - * &quot;Intel Haswell&quot;</code> or - * <code>minCpuPlatform: &quot;Intel Sandy - * Bridge&quot;</code>. For more information, read [how to specify - * min CPU - * platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) */ minCpuPlatform?: string; /** - * The set of Google API scopes to be made available on all of the node VMs - * under the "default" service account. The following scopes are - * recommended, but not required, and by default are not included: * - * `https://www.googleapis.com/auth/compute` is required for mounting - * persistent storage on your nodes. * - * `https://www.googleapis.com/auth/devstorage.read_only` is required for - * communicating with **gcr.io** (the [Google Container - * Registry](/container-registry/)). If unspecified, no scopes are added, - * unless Cloud Logging or Cloud Monitoring are enabled, in which case their - * required scopes will be added. + * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. */ oauthScopes?: string[]; /** - * Whether the nodes are created as preemptible VM instances. See: - * https://cloud.google.com/compute/docs/instances/preemptible for more - * inforamtion about preemptible VM instances. + * Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. */ preemptible?: boolean; /** @@ -1447,22 +1122,15 @@ export namespace container_v1beta1 { */ sandboxConfig?: Schema$SandboxConfig; /** - * The Google Cloud Platform Service Account to be used by the node VMs. If - * no Service Account is specified, the "default" service account - * is used. + * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. */ serviceAccount?: string; /** - * The list of instance tags applied to all nodes. Tags are used to identify - * valid sources or targets for network firewalls and are specified by the - * client during cluster or node pool creation. Each tag within the list - * must comply with RFC1035. + * The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. */ tags?: string[]; /** - * List of kubernetes taints to be applied to each node. For more - * information, including usage and the valid values, see: - * https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + * List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ */ taints?: Schema$NodeTaint[]; /** @@ -1471,8 +1139,7 @@ export namespace container_v1beta1 { workloadMetadataConfig?: Schema$WorkloadMetadataConfig; } /** - * NodeManagement defines the set of node management services turned on for - * the node pool. + * NodeManagement defines the set of node management services turned on for the node pool. */ export interface Schema$NodeManagement { /** @@ -1489,17 +1156,11 @@ export namespace container_v1beta1 { upgradeOptions?: Schema$AutoUpgradeOptions; } /** - * NodePool contains the name and configuration for a cluster's node pool. - * Node pools are a set of nodes (i.e. VM's), with a common configuration - * and specification, under the control of the cluster master. They may have a - * set of Kubernetes labels applied to them, which may be used to reference - * them during pod scheduling. They may also be resized up or down, to - * accommodate the workload. + * NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. */ export interface Schema$NodePool { /** - * Autoscaler configuration for this NodePool. Autoscaler is enabled only if - * a valid configuration is present. + * Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. */ autoscaling?: Schema$NodePoolAutoscaling; /** @@ -1511,16 +1172,11 @@ export namespace container_v1beta1 { */ config?: Schema$NodeConfig; /** - * The initial node count for the pool. You must ensure that your Compute - * Engine <a href="/compute/docs/resource-quotas">resource - * quota</a> is sufficient for this number of instances. You must also - * have available firewall and routes quota. + * The initial node count for the pool. You must ensure that your Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> is sufficient for this number of instances. You must also have available firewall and routes quota. */ initialNodeCount?: number; /** - * [Output only] The resource URLs of the [managed instance - * groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) - * associated with this node pool. + * [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. */ instanceGroupUrls?: string[]; /** @@ -1528,14 +1184,17 @@ export namespace container_v1beta1 { */ management?: Schema$NodeManagement; /** - * The constraint on the maximum number of pods that can be run - * simultaneously on a node in the node pool. + * The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. */ maxPodsConstraint?: Schema$MaxPodsConstraint; /** * The name of the node pool. */ name?: string; + /** + * [Output only] The pod CIDR block size per node in this node pool. + */ + podIpv4CidrSize?: number; /** * [Output only] Server-defined URL for the resource. */ @@ -1545,8 +1204,7 @@ export namespace container_v1beta1 { */ status?: string; /** - * [Output only] Additional information about the current status of this - * node pool instance, if available. + * [Output only] Additional information about the current status of this node pool instance, if available. */ statusMessage?: string; /** @@ -1555,8 +1213,7 @@ export namespace container_v1beta1 { version?: string; } /** - * NodePoolAutoscaling contains information required by cluster autoscaler to - * adjust the size of the node pool to the current cluster usage. + * NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. */ export interface Schema$NodePoolAutoscaling { /** @@ -1568,22 +1225,16 @@ export namespace container_v1beta1 { */ enabled?: boolean; /** - * Maximum number of nodes in the NodePool. Must be >= min_node_count. - * There has to enough quota to scale up the cluster. + * Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster. */ maxNodeCount?: number; /** - * Minimum number of nodes in the NodePool. Must be >= 1 and <= - * max_node_count. + * Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. */ minNodeCount?: number; } /** - * Kubernetes taint is comprised of three fields: key, value, and effect. - * Effect can only be one of three types: NoSchedule, PreferNoSchedule or - * NoExecute. For more information, including usage and the valid values, - * see: - * https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + * Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ */ export interface Schema$NodeTaint { /** @@ -1600,8 +1251,7 @@ export namespace container_v1beta1 { value?: string; } /** - * This operation resource represents operations that may have happened or are - * happening on the cluster. All fields are output only. + * This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. */ export interface Schema$Operation { /** @@ -1613,15 +1263,11 @@ export namespace container_v1beta1 { */ detail?: string; /** - * [Output only] The time the operation completed, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ endTime?: string; /** - * [Output only] The name of the Google Compute Engine - * [zone](/compute/docs/regions-zones/regions-zones#available) or - * [region](/compute/docs/regions-zones/regions-zones#available) in which - * the cluster resides. + * [Output only] The name of the Google Compute Engine [zone](/compute/docs/regions-zones/regions-zones#available) or [region](/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string; /** @@ -1645,8 +1291,7 @@ export namespace container_v1beta1 { */ selfLink?: string; /** - * [Output only] The time the operation started, in - * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ startTime?: string; /** @@ -1662,9 +1307,7 @@ export namespace container_v1beta1 { */ targetLink?: string; /** - * The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the operation is taking - * place. This field is deprecated, use location instead. + * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ zone?: string; } @@ -1673,16 +1316,11 @@ export namespace container_v1beta1 { */ export interface Schema$OperationProgress { /** - * Progress metric bundle, for example: metrics: [{name: "nodes - * done", int_value: 15}, {name: "nodes - * total", int_value: 32}] or metrics: [{name: - * "progress", double_value: 0.56}, {name: - * "progress scale", double_value: 1.0}] + * Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] */ metrics?: Schema$Metric[]; /** - * A non-parameterized string describing an operation stage. Unset for - * single-stage operations. + * A non-parameterized string describing an operation stage. Unset for single-stage operations. */ name?: string; /** @@ -1699,8 +1337,7 @@ export namespace container_v1beta1 { */ export interface Schema$PodSecurityPolicyConfig { /** - * Enable the PodSecurityPolicy controller for this cluster. If enabled, - * pods must be valid under a PodSecurityPolicy to be created. + * Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created. */ enabled?: boolean; } @@ -1709,37 +1346,28 @@ export namespace container_v1beta1 { */ export interface Schema$PrivateClusterConfig { /** - * Whether the master's internal IP address is used as the cluster - * endpoint. + * Whether the master's internal IP address is used as the cluster endpoint. */ enablePrivateEndpoint?: boolean; /** - * Whether nodes have internal IP addresses only. If enabled, all nodes are - * given only RFC 1918 private addresses and communicate with the master via - * private networking. + * Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. */ enablePrivateNodes?: boolean; /** - * The IP range in CIDR notation to use for the hosted master network. This - * range will be used for assigning internal IP addresses to the master or - * set of masters, as well as the ILB VIP. This range must not overlap with - * any other ranges in use within the cluster's network. + * The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network. */ masterIpv4CidrBlock?: string; /** - * Output only. The internal IP address of this cluster's master - * endpoint. + * Output only. The internal IP address of this cluster's master endpoint. */ privateEndpoint?: string; /** - * Output only. The external IP address of this cluster's master - * endpoint. + * Output only. The external IP address of this cluster's master endpoint. */ publicEndpoint?: string; } /** - * Contains information about amount of some resource in the cluster. For - * memory, value should be in GB. + * Contains information about amount of some resource in the cluster. For memory, value should be in GB. */ export interface Schema$ResourceLimit { /** @@ -1764,43 +1392,32 @@ export namespace container_v1beta1 { */ bigqueryDestination?: Schema$BigQueryDestination; /** - * Whether to enable network egress metering for this cluster. If enabled, a - * daemonset will be created in the cluster to meter network egress traffic. + * Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. */ enableNetworkEgressMetering?: boolean; } /** - * RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed - * NodePool upgrade. This will be an no-op if the last upgrade successfully - * completed. + * RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. */ export interface Schema$RollbackNodePoolUpgradeRequest { /** - * Deprecated. The name of the cluster to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node poll to - * rollback upgrade. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1843,62 +1460,44 @@ export namespace container_v1beta1 { */ export interface Schema$SetAddonsConfigRequest { /** - * The desired configurations for the various addons available to run in the - * cluster. + * The desired configurations for the various addons available to run in the cluster. */ addonsConfig?: Schema$AddonsConfig; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to set addons. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * SetLabelsRequest sets the Google Cloud Platform labels on a Google - * Container Engine cluster, which will in turn set them for Google Compute - * Engine resources used by that cluster + * SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster */ export interface Schema$SetLabelsRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The fingerprint of the previous set of labels for this resource, used to - * detect conflicts. The fingerprint is initially generated by Kubernetes - * Engine and changes after every request to modify or update labels. You - * must always provide an up-to-date fingerprint hash when updating or - * changing labels. Make a <code>get()</code> request to the - * resource to get the latest fingerprint. + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a <code>get()</code> request to the resource to get the latest fingerprint. */ labelFingerprint?: string; /** - * The name (project, location, cluster id) of the cluster to set labels. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -1906,20 +1505,16 @@ export namespace container_v1beta1 { */ resourceLabels?: {[key: string]: string}; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * SetLegacyAbacRequest enables or disables the ABAC authorization mechanism - * for a cluster. + * SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. */ export interface Schema$SetLegacyAbacRequest { /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -1927,21 +1522,15 @@ export namespace container_v1beta1 { */ enabled?: boolean; /** - * The name (project, location, cluster id) of the cluster to set legacy - * abac. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1950,34 +1539,23 @@ export namespace container_v1beta1 { */ export interface Schema$SetLocationsRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The desired list of Google Compute Engine - * [zones](/compute/docs/zones#available) in which the cluster's nodes - * should be located. Changing the locations a cluster is in will result in - * nodes being either created or removed from the cluster, depending on - * whether locations are being added or removed. This list must always - * include the cluster's primary zone. + * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ locations?: string[]; /** - * The name (project, location, cluster) of the cluster to set locations. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -1986,32 +1564,23 @@ export namespace container_v1beta1 { */ export interface Schema$SetLoggingServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The logging service the cluster should use to write metrics. Currently - * available options: * "logging.googleapis.com" - the Google - * Cloud Logging service * "none" - no metrics will be exported - * from the cluster + * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no metrics will be exported from the cluster */ loggingService?: string; /** - * The name (project, location, cluster) of the cluster to set logging. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2024,24 +1593,19 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * The maintenance policy to be set for the cluster. An empty field clears - * the existing maintenance policy. + * The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. */ maintenancePolicy?: Schema$MaintenancePolicy; /** - * The name (project, location, cluster id) of the cluster to set - * maintenance policy. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). + * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string; /** - * The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. + * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string; } @@ -2054,19 +1618,15 @@ export namespace container_v1beta1 { */ action?: string; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to set auth. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -2074,9 +1634,7 @@ export namespace container_v1beta1 { */ update?: Schema$MasterAuth; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2085,32 +1643,23 @@ export namespace container_v1beta1 { */ export interface Schema$SetMonitoringServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The monitoring service the cluster should use to write metrics. Currently - * available options: * "monitoring.googleapis.com" - the Google - * Cloud Monitoring service * "none" - no metrics will be exported - * from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ monitoringService?: string; /** - * The name (project, location, cluster) of the cluster to set monitoring. - * Specified in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2119,14 +1668,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetNetworkPolicyRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster id) of the cluster to set networking - * policy. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** @@ -2134,15 +1680,11 @@ export namespace container_v1beta1 { */ networkPolicy?: Schema$NetworkPolicy; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2155,42 +1697,32 @@ export namespace container_v1beta1 { */ autoscaling?: Schema$NodePoolAutoscaling; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool) of the node pool to set - * autoscaler settings. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * SetNodePoolManagementRequest sets the node management properties of a node - * pool. + * SetNodePoolManagementRequest sets the node management properties of a node pool. */ export interface Schema$SetNodePoolManagementRequest { /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -2198,26 +1730,19 @@ export namespace container_v1beta1 { */ management?: Schema$NodeManagement; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set management properties. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2226,14 +1751,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetNodePoolSizeRequest { /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set size. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** @@ -2241,43 +1763,32 @@ export namespace container_v1beta1 { */ nodeCount?: number; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * StartIPRotationRequest creates a new IP for the cluster and then performs a - * node upgrade on each node pool to point to the new IP. + * StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. */ export interface Schema$StartIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster id) of the cluster to start IP - * rotation. Specified in the format - * 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -2285,15 +1796,12 @@ export namespace container_v1beta1 { */ rotateCredentials?: boolean; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * StatusCondition describes why a cluster or a node pool has a certain status - * (e.g., ERROR or DEGRADED). + * StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). */ export interface Schema$StatusCondition { /** @@ -2310,19 +1818,15 @@ export namespace container_v1beta1 { */ export interface Schema$UpdateClusterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** @@ -2330,9 +1834,7 @@ export namespace container_v1beta1 { */ update?: Schema$ClusterUpdate; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2341,36 +1843,23 @@ export namespace container_v1beta1 { */ export interface Schema$UpdateMasterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The Kubernetes version to change the master to. Users may specify either - * explicit versions offered by Kubernetes Engine or version aliases, which - * have the following behavior: - "latest": picks the highest - * valid Kubernetes version - "1.X": picks the highest valid - * patch+gke.N patch in the 1.X version - "1.X.Y": picks the - * highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": - * picks an explicit Kubernetes version - "-": picks the default - * Kubernetes version + * The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version */ masterVersion?: string; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/*'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/*'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2379,8 +1868,7 @@ export namespace container_v1beta1 { */ export interface Schema$UpdateNodePoolRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -2388,43 +1876,28 @@ export namespace container_v1beta1 { */ imageType?: string; /** - * The name (project, location, cluster, node pool) of the node pool to - * update. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ name?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * The Kubernetes version to change the nodes to (typically an upgrade). - * Users may specify either explicit versions offered by Kubernetes Engine - * or version aliases, which have the following behavior: - - * "latest": picks the highest valid Kubernetes version - - * "1.X": picks the highest valid patch+gke.N patch in the 1.X - * version - "1.X.Y": picks the highest valid gke.N patch in - * the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes - * version - "-": picks the Kubernetes master version + * The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version */ nodeVersion?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } /** - * UsableSubnetwork resource returns the subnetwork name, its associated - * network and the primary CIDR range. + * UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range. */ export interface Schema$UsableSubnetwork { /** @@ -2440,15 +1913,11 @@ export namespace container_v1beta1 { */ secondaryIpRanges?: Schema$UsableSubnetworkSecondaryRange[]; /** - * A human readable status message representing the reasons for cases where - * the caller cannot use the secondary ranges under the subnet. For example - * if the secondary_ip_ranges is empty due to a permission issue, an - * insufficient permission message will be given by status_message. + * A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message. */ statusMessage?: string; /** - * Subnetwork Name. Example: - * projects/my-project/regions/us-central1/subnetworks/my-subnet + * Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ subnetwork?: string; } @@ -2461,20 +1930,16 @@ export namespace container_v1beta1 { */ ipCidrRange?: string; /** - * The name associated with this subnetwork secondary range, used when - * adding an alias IP range to a VM instance. + * The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. */ rangeName?: string; /** - * This field is to determine the status of the secondary range - * programmably. + * This field is to determine the status of the secondary range programmably. */ status?: string; } /** - * VerticalPodAutoscaling contains global, per-cluster information required by - * Vertical Pod Autoscaler to automatically adjust the resources of pods - * controlled by it. + * VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. */ export interface Schema$VerticalPodAutoscaling { /** @@ -2483,13 +1948,11 @@ export namespace container_v1beta1 { enabled?: boolean; } /** - * WorkloadMetadataConfig defines the metadata configuration to expose to - * workloads on the node pool. + * WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. */ export interface Schema$WorkloadMetadataConfig { /** - * NodeMetadata is the configuration for how to expose metadata to the - * workloads running on the node. + * NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. */ nodeMetadata?: string; } @@ -2526,8 +1989,7 @@ export namespace container_v1beta1 { /** * container.projects.aggregated.usableSubnetworks.list - * @desc Lists subnetworks that can be used for creating clusters in a - * project. + * @desc Lists subnetworks that can be used for creating clusters in a project. * @alias container.projects.aggregated.usableSubnetworks.list * @memberOf! () * @@ -2619,27 +2081,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Filtering currently only supports equality on the networkProjectId and - * must be in the form: "networkProjectId=[PROJECTID]", where - * `networkProjectId` is the project which owns the listed subnetworks. This - * defaults to the parent project ID. + * Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` is the project which owns the listed subnetworks. This defaults to the parent project ID. */ filter?: string; /** - * The max number of results per page that should be returned. If the number - * of available results is larger than `page_size`, a `next_page_token` is - * returned which can be used to get the next page of results in subsequent - * requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * The max number of results per page that should be returned. If the number of available results is larger than `page_size`, a `next_page_token` is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ pageSize?: number; /** - * Specifies a page token to use. Set this to the nextPageToken returned by - * previous list requests to get the next page of results. + * Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results. */ pageToken?: string; /** - * The parent project where subnetworks are usable. Specified in the format - * 'projects/x'. + * The parent project where subnetworks are usable. Specified in the format 'projects/x'. */ parent?: string; } @@ -2658,8 +2112,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.getServerConfig - * @desc Returns configuration info about the Google Kubernetes Engine - * service. + * @desc Returns configuration info about the Google Kubernetes Engine service. * @alias container.projects.locations.getServerConfig * @memberOf! () * @@ -2818,20 +2271,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project and location) of the server config to get, specified in - * the format 'projects/x/locations/x'. + * The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2843,8 +2291,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Contains the name of the resource requested. Specified in the format - * 'projects/x'. + * Contains the name of the resource requested. Specified in the format 'projects/x'. */ parent?: string; } @@ -2940,15 +2387,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.create - * @desc Creates a cluster, consisting of the specified number and type of - * Google Compute Engine instances. By default, the cluster is created in - * the project's [default - * network](/compute/docs/networks-and-firewalls#networks). One firewall is - * added for the cluster. After cluster creation, the Kubelet creates routes - * for each node to allow the containers on that node to communicate with - * all other instances in the cluster. Finally, an entry is added to the - * project's global metadata indicating which CIDR range the cluster is - * using. + * @desc Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @alias container.projects.locations.clusters.create * @memberOf! () * @@ -3023,11 +2462,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.delete - * @desc Deletes the cluster, including the Kubernetes endpoint and all - * worker nodes. Firewalls and routes that were configured during cluster - * creation are also deleted. Other Google Compute Engine resources that - * might be in use by the cluster, such as load balancer resources, are not - * deleted if they weren't present when the cluster was initially created. + * @desc Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. * @alias container.projects.locations.clusters.delete * @memberOf! () * @@ -3173,9 +2608,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.getJwks - * @desc Gets the public component of the cluster signing keys in JSON Web - * Key format. This API is not yet intended for general use, and is not - * available for all clusters. + * @desc Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters. * @alias container.projects.locations.clusters.getJwks * @memberOf! () * @@ -3253,8 +2686,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.list - * @desc Lists all clusters owned by a project in either the specified zone - * or all zones. + * @desc Lists all clusters owned by a project in either the specified zone or all zones. * @alias container.projects.locations.clusters.list * @memberOf! () * @@ -3709,9 +3141,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.setMasterAuth - * @desc Sets master auth materials. Currently supports changing the admin - * password or a specific cluster, either via password generation or - * explicitly setting the password. + * @desc Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. * @alias container.projects.locations.clusters.setMasterAuth * @memberOf! () * @@ -4240,8 +3670,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to complete IP - * rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4258,8 +3687,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the cluster will be created. - * Specified in the format 'projects/x/locations/x'. + * The parent (project and location) where the cluster will be created. Specified in the format 'projects/x/locations/x'. */ parent?: string; @@ -4276,25 +3704,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to delete. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4306,25 +3728,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to retrieve. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4336,8 +3752,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The cluster (project, location, cluster id) to get keys for. Specified in - * the format 'projects/x/locations/x/clusters/x'. + * The cluster (project, location, cluster id) to get keys for. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; } @@ -4349,22 +3764,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the clusters will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides, or - * "-" for all zones. This field has been deprecated and replaced by the - * parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -4376,8 +3784,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set addons. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4394,8 +3801,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set legacy - * abac. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4412,8 +3818,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set locations. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4430,8 +3835,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set logging. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4448,9 +3852,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set - * maintenance policy. Specified in the format - * 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4467,8 +3869,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set auth. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4485,8 +3886,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to set monitoring. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4503,8 +3903,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set networking - * policy. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4521,8 +3920,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to set labels. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4539,8 +3937,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster id) of the cluster to start IP - * rotation. Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4557,8 +3954,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4575,8 +3971,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster) of the cluster to update. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; @@ -4896,8 +4291,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.nodePools.rollback - * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This - * makes no changes if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. * @alias container.projects.locations.clusters.nodePools.rollback * @memberOf! () * @@ -5276,8 +4670,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project, location, cluster id) where the node pool will be - * created. Specified in the format 'projects/x/locations/x/clusters/x'. + * The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; @@ -5294,31 +4687,23 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * delete. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5330,31 +4715,23 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * get. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5366,25 +4743,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * The parent (project, location, cluster id) where the node pools will be - * listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -5396,9 +4767,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool id) of the node poll to - * rollback upgrade. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -5415,9 +4784,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool) of the node pool to set - * autoscaler settings. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -5434,9 +4801,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set management properties. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -5453,9 +4818,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool id) of the node pool to - * set size. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -5472,9 +4835,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, cluster, node pool) of the node pool to - * update. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; @@ -5492,13 +4853,8 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.well-known.getOpenid-configuration - * @desc Gets the OIDC discovery document for the cluster. See the [OpenID - * Connect Discovery 1.0 - * specification](https://openid.net/specs/openid-connect-discovery-1_0.html) - * for details. This API is not yet intended for general use, and is not - * available for all clusters. - * @alias - * container.projects.locations.clusters.well-known.getOpenid-configuration + * @desc Gets the OIDC discovery document for the cluster. See the [OpenID Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) for details. This API is not yet intended for general use, and is not available for all clusters. + * @alias container.projects.locations.clusters.well-known.getOpenid-configuration * @memberOf! () * * @param {object} params Parameters for request @@ -5581,8 +4937,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The cluster (project, location, cluster id) to get the discovery document - * for. Specified in the format 'projects/x/locations/x/clusters/x'. + * The cluster (project, location, cluster id) to get the discovery document for. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; } @@ -5742,8 +5097,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.operations.list - * @desc Lists all operations in a project in the specified zone or all - * zones. + * @desc Lists all operations in a project in the specified zone or all zones. * @alias container.projects.locations.operations.list * @memberOf! () * @@ -5828,8 +5182,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, operation id) of the operation to cancel. - * Specified in the format 'projects/x/locations/x/operations/x'. + * The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/x/locations/x/operations/x'. */ name?: string; @@ -5846,25 +5199,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, operation id) of the operation to get. - * Specified in the format 'projects/x/locations/x/operations/x'. + * The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5876,22 +5223,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the operations will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for, or `-` - * for all zones. This field has been deprecated and replaced by the parent - * field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -5908,8 +5248,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.getServerconfig - * @desc Returns configuration info about the Google Kubernetes Engine - * service. + * @desc Returns configuration info about the Google Kubernetes Engine service. * @alias container.projects.zones.getServerconfig * @memberOf! () * @@ -5992,20 +5331,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project and location) of the server config to get, specified in - * the format 'projects/x/locations/x'. + * The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -6176,15 +5510,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.create - * @desc Creates a cluster, consisting of the specified number and type of - * Google Compute Engine instances. By default, the cluster is created in - * the project's [default - * network](/compute/docs/networks-and-firewalls#networks). One firewall is - * added for the cluster. After cluster creation, the Kubelet creates routes - * for each node to allow the containers on that node to communicate with - * all other instances in the cluster. Finally, an entry is added to the - * project's global metadata indicating which CIDR range the cluster is - * using. + * @desc Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @alias container.projects.zones.clusters.create * @memberOf! () * @@ -6259,11 +5585,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.delete - * @desc Deletes the cluster, including the Kubernetes endpoint and all - * worker nodes. Firewalls and routes that were configured during cluster - * creation are also deleted. Other Google Compute Engine resources that - * might be in use by the cluster, such as load balancer resources, are not - * deleted if they weren't present when the cluster was initially created. + * @desc Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. * @alias container.projects.zones.clusters.delete * @memberOf! () * @@ -6492,8 +5814,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.list - * @desc Lists all clusters owned by a project in either the specified zone - * or all zones. + * @desc Lists all clusters owned by a project in either the specified zone or all zones. * @alias container.projects.zones.clusters.list * @memberOf! () * @@ -7034,9 +6355,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.setMasterAuth - * @desc Sets master auth materials. Currently supports changing the admin - * password or a specific cluster, either via password generation or - * explicitly setting the password. + * @desc Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. * @alias container.projects.zones.clusters.setMasterAuth * @memberOf! () * @@ -7351,20 +6670,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7381,20 +6695,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7411,15 +6720,11 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -7436,25 +6741,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to delete. Specified - * in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -7466,25 +6765,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster) of the cluster to retrieve. - * Specified in the format 'projects/x/locations/x/clusters/x'. + * The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -7496,20 +6789,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7526,22 +6814,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the clusters will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides, or - * "-" for all zones. This field has been deprecated and replaced by the - * parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -7553,20 +6834,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7583,20 +6859,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7613,20 +6884,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7643,20 +6909,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7673,20 +6934,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7707,13 +6963,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). + * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string; /** - * The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. + * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string; @@ -7730,20 +6984,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7760,20 +7009,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7790,20 +7034,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7820,20 +7059,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8239,8 +7473,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.nodePools.rollback - * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This - * makes no changes if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. * @alias container.projects.zones.clusters.nodePools.rollback * @memberOf! () * @@ -8559,25 +7792,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8594,20 +7821,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -8624,31 +7846,23 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * delete. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8660,31 +7874,23 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * The name (project, location, cluster, node pool id) of the node pool to - * get. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and - * replaced by the name field. + * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8696,25 +7902,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and - * replaced by the parent field. + * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * The parent (project, location, cluster id) where the node pools will be - * listed. Specified in the format 'projects/x/locations/x/clusters/x'. + * The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://developers.google.com/console/help/new/#projectnumber). - * This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -8726,25 +7926,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to rollback. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8761,25 +7955,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8796,25 +7984,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8831,25 +8013,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been - * deprecated and replaced by the name field. + * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9019,8 +8195,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.operations.list - * @desc Lists all operations in a project in the specified zone or all - * zones. + * @desc Lists all operations in a project in the specified zone or all zones. * @alias container.projects.zones.operations.list * @memberOf! () * @@ -9104,20 +8279,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the operation resides. - * This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9134,25 +8304,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name (project, location, operation id) of the operation to get. - * Specified in the format 'projects/x/locations/x/operations/x'. + * The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has - * been deprecated and replaced by the name field. + * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) in which the cluster resides. This - * field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -9164,22 +8328,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent (project and location) where the operations will be listed. - * Specified in the format 'projects/x/locations/x'. Location "-" matches - * all zones and all regions. + * The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project - * number](https://support.google.com/cloud/answer/6158840). This field has - * been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine - * [zone](/compute/docs/zones#available) to return operations for, or `-` - * for all zones. This field has been deprecated and replaced by the parent - * field. + * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } diff --git a/src/apis/containeranalysis/package.json b/src/apis/containeranalysis/package.json index 1c1ed44fc11..0797748b730 100644 --- a/src/apis/containeranalysis/package.json +++ b/src/apis/containeranalysis/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 06da0378905..ef9e3564d93 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace containeranalysis_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace containeranalysis_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace containeranalysis_v1alpha1 { /** * Container Analysis API * - * An implementation of the Grafeas API, which stores, and enables querying - * and retrieval of critical metadata about all of your software artifacts. + * An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace containeranalysis_v1alpha1 { providers: Resource$Providers; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); this.providers = new Resource$Providers(this.context); @@ -126,99 +124,45 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$Artifact { /** - * Hash or checksum value of a binary, or Docker Registry 2.0 digest of a - * container. + * Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. */ checksum?: string; /** - * Artifact ID, if any; for container images, this will be a URL by digest - * like gcr.io/projectID/imagename@sha256:123456 + * Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 */ id?: string; /** - * Name of the artifact. This may be the path to a binary or jar file, or in - * the case of a container build, the name used to push the container image - * to Google Container Registry, as presented to `docker push`. This field - * is deprecated in favor of the plural `names` field; it continues to exist - * here to allow existing BuildProvenance serialized to json in - * google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes - * to deserialize back into proto. + * Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. */ name?: string; /** - * Related artifact names. This may be the path to a binary or jar file, or - * in the case of a container build, the name used to push the container - * image to Google Container Registry, as presented to `docker push`. Note - * that a single Artifact ID can have multiple names, for example if two - * tags are applied to one image. + * Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. */ names?: string[]; } /** - * Occurrence that represents a single "attestation". The - * authenticity of an Attestation can be verified using the attached - * signature. If the verifier trusts the public key of the signer, then - * verifying the signature is sufficient to establish trust. In this - * circumstance, the AttestationAuthority to which this Attestation is - * attached is primarily useful for look-up (how to find this Attestation if - * you already know the Authority and artifact to be verified) and intent - * (which authority was this attestation intended to sign for). + * Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). */ export interface Schema$Attestation { pgpSignedAttestation?: Schema$PgpSignedAttestation; } /** - * Note kind that represents a logical attestation "role" or - * "authority". For example, an organization might have one - * `AttestationAuthority` for "QA" and one for "build". - * This Note is intended to act strictly as a grouping mechanism for the - * attached Occurrences (Attestations). This grouping mechanism also provides - * a security boundary, since IAM ACLs gate the ability for a principle to - * attach an Occurrence to a given Note. It also provides a single point of - * lookup to find all attached Attestation Occurrences, even if they don't - * all live in the same project. + * Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. */ export interface Schema$AttestationAuthority { hint?: Schema$AttestationAuthorityHint; } /** - * This submessage provides human-readable hints about the purpose of the - * AttestationAuthority. Because the name of a Note acts as its resource - * reference, it is important to disambiguate the canonical name of the Note - * (which might be a UUID for security purposes) from "readable" - * names more suitable for debug output. Note that these hints should NOT be - * used to look up AttestationAuthorities in security sensitive contexts, such - * as when looking up Attestations to verify. + * This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. */ export interface Schema$AttestationAuthorityHint { /** - * The human readable name of this Attestation Authority, for example - * "qa". + * The human readable name of this Attestation Authority, for example "qa". */ humanReadableName?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -226,25 +170,16 @@ export namespace containeranalysis_v1alpha1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -253,10 +188,7 @@ export namespace containeranalysis_v1alpha1 { logType?: string; } /** - * Basis describes the base image portion (Note) of the DockerImage - * relationship. Linked occurrences are derived from this or an equivalent - * image via: FROM <Basis.resource_url> Or an equivalent reference, - * e.g. a tag of the resource_url. + * Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM <Basis.resource_url> Or an equivalent reference, e.g. a tag of the resource_url. */ export interface Schema$Basis { /** @@ -264,8 +196,7 @@ export namespace containeranalysis_v1alpha1 { */ fingerprint?: Schema$Fingerprint; /** - * The resource_url for the resource representing the basis of associated - * occurrence images. + * The resource_url for the resource representing the basis of associated occurrence images. */ resourceUrl?: string; } @@ -274,30 +205,15 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -310,21 +226,12 @@ export namespace containeranalysis_v1alpha1 { */ provenance?: Schema$BuildProvenance; /** - * Serialized JSON representation of the provenance, used in generating the - * `BuildSignature` in the corresponding Result. After verifying the - * signature, `provenance_bytes` can be unmarshalled and compared to the - * provenance to confirm that it is unchanged. A base64-encoded string - * representation of the provenance bytes is used for the signature in order - * to interoperate with openssl which expects this format for signature - * verification. The serialized form is captured both to avoid ambiguity in - * how the provenance is marshalled to json as well to prevent - * incompatibilities with future changes. + * Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. */ provenanceBytes?: string; } /** - * Provenance of a build. Contains all information needed to verify the full - * details about the build from source to completion. + * Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. */ export interface Schema$BuildProvenance { /** @@ -332,8 +239,7 @@ export namespace containeranalysis_v1alpha1 { */ builderVersion?: string; /** - * Special options applied to this build. This is a catch-all field where - * build providers can enter any desired additional details. + * Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. */ buildOptions?: {[key: string]: string}; /** @@ -349,9 +255,7 @@ export namespace containeranalysis_v1alpha1 { */ createTime?: string; /** - * E-mail address of the user who initiated this build. Note that this was - * the user's e-mail address at the time the build was initiated; this - * address may not represent the same end-user for all time. + * E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. */ creator?: string; /** @@ -379,8 +283,7 @@ export namespace containeranalysis_v1alpha1 { */ startTime?: string; /** - * Trigger identifier if the build was triggered automatically; empty if - * not. + * Trigger identifier if the build was triggered automatically; empty if not. */ triggerId?: string; } @@ -389,28 +292,15 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$BuildSignature { /** - * An Id for the key used to sign. This could be either an Id for the key - * stored in `public_key` (such as the Id or fingerprint for a PGP key, or - * the CN for a cert), or a reference to an external key (such as a - * reference to a key in Cloud Key Management Service). + * An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service). */ keyId?: string; /** - * The type of the key, either stored in `public_key` or referenced in - * `key_id` + * The type of the key, either stored in `public_key` or referenced in `key_id` */ keyType?: string; /** - * Public key of the builder which can be used to verify that the related - * findings are valid and unchanged. If `key_type` is empty, this defaults - * to PEM encoded public keys. This field may be empty if `key_id` - * references an external key. For Cloud Build based signatures, this is a - * PEM encoded public key. To verify the Cloud Build signature, place the - * contents of this field into a file (public.pem). The signature field is - * base64-decoded into its binary representation in signature.bin, and the - * provenance bytes from `BuildDetails` are base64-decoded into a binary - * representation in signed.bin. OpenSSL can then verify the signature: - * `openssl sha256 -verify public.pem -signature signature.bin signed.bin` + * Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin` */ publicKey?: string; /** @@ -419,8 +309,7 @@ export namespace containeranalysis_v1alpha1 { signature?: string; } /** - * Note holding the version of the provider's builder and the signature of - * the provenance message in linked BuildDetails. + * Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. */ export interface Schema$BuildType { /** @@ -428,8 +317,7 @@ export namespace containeranalysis_v1alpha1 { */ builderVersion?: string; /** - * Signature of the build in Occurrences pointing to the Note containing - * this `BuilderDetails`. + * Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. */ signature?: Schema$BuildSignature; } @@ -442,8 +330,7 @@ export namespace containeranalysis_v1alpha1 { */ args?: string[]; /** - * Working directory (relative to project source root) used when running - * this Command. + * Working directory (relative to project source root) used when running this Command. */ dir?: string; /** @@ -451,13 +338,11 @@ export namespace containeranalysis_v1alpha1 { */ env?: string[]; /** - * Optional unique identifier for this Command, used in wait_for to - * reference this Command as a dependency. + * Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. */ id?: string; /** - * Name of the command, as presented on the command line, or if the command - * is packaged as a Docker container, as presented to `docker pull`. + * Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. */ name?: string; /** @@ -508,8 +393,7 @@ export namespace containeranalysis_v1alpha1 { */ platform?: string; /** - * Output only. Resource URI for the artifact being deployed taken from the - * deployable field with the same name. + * Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. */ resourceUri?: string[]; /** @@ -522,19 +406,15 @@ export namespace containeranalysis_v1alpha1 { userEmail?: string; } /** - * Derived describes the derived image portion (Occurrence) of the DockerImage - * relationship. This image would be produced from a Dockerfile with FROM - * <DockerImage.Basis in attached Note>. + * Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM <DockerImage.Basis in attached Note>. */ export interface Schema$Derived { /** - * Output only. This contains the base image URL for the derived image - * occurrence. + * Output only. This contains the base image URL for the derived image occurrence. */ baseResourceUrl?: string; /** - * Output only. The number of layers by which this image differs from the - * associated image basis. + * Output only. The number of layers by which this image differs from the associated image basis. */ distance?: number; /** @@ -542,23 +422,16 @@ export namespace containeranalysis_v1alpha1 { */ fingerprint?: Schema$Fingerprint; /** - * This contains layer-specific metadata, if populated it has length - * "distance" and is ordered with [distance] being the layer - * immediately following the base image and [1] being the final layer. + * This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. */ layerInfo?: Schema$Layer[]; } /** - * Identifies all occurrences of this vulnerability in the package for a - * specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 - * for versions 2.1 - 2.2 + * Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 */ export interface Schema$Detail { /** - * The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in - * which the vulnerability manifests. Examples include distro or storage - * location for vulnerable jar. This field can be used as a filter in list - * requests. + * The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. */ cpeUri?: string; /** @@ -570,13 +443,11 @@ export namespace containeranalysis_v1alpha1 { */ fixedLocation?: Schema$VulnerabilityLocation; /** - * Whether this Detail is obsolete. Occurrences are expected not to point to - * obsolete details. + * Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. */ isObsolete?: boolean; /** - * The max version of the package in which the vulnerability exists. This - * field can be used as a filter in list requests. + * The max version of the package in which the vulnerability exists. This field can be used as a filter in list requests. */ maxAffectedVersion?: Schema$Version; /** @@ -584,13 +455,11 @@ export namespace containeranalysis_v1alpha1 { */ minAffectedVersion?: Schema$Version; /** - * The name of the package where the vulnerability was found. This field can - * be used as a filter in list requests. + * The name of the package where the vulnerability was found. This field can be used as a filter in list requests. */ package?: string; /** - * The type of package; whether native or non native(ruby gems, node.js - * packages etc) + * The type of package; whether native or non native(ruby gems, node.js packages etc) */ packageType?: string; /** @@ -607,9 +476,7 @@ export namespace containeranalysis_v1alpha1 { */ analysisStatus?: string; /** - * When an error is encountered this will contain a LocalizedMessage under - * details to show to the user. The LocalizedMessage output only and - * populated by the API. + * When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. */ analysisStatusError?: Schema$Status; /** @@ -617,18 +484,12 @@ export namespace containeranalysis_v1alpha1 { */ continuousAnalysis?: string; /** - * Output only. An operation that indicates the status of the current scan. - * This field is deprecated, do not use. + * Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. */ operation?: Schema$Operation; } /** - * A note that indicates a type of analysis a provider would perform. This - * note exists in a provider's project. A `Discovery` occurrence is - * created in a consumer's project at the start of analysis. The - * occurrence's operation will indicate the status of the analysis. - * Absence of an occurrence linked to this note for a resource indicates that - * analysis hasn't started. + * A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. */ export interface Schema$Discovery { /** @@ -637,18 +498,15 @@ export namespace containeranalysis_v1alpha1 { analysisKind?: string; } /** - * This represents a particular channel of distribution for a given package. - * e.g. Debian's jessie-backports dpkg mirror + * This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror */ export interface Schema$Distribution { /** - * The CPU architecture for which packages in this distribution channel were - * built + * The CPU architecture for which packages in this distribution channel were built */ architecture?: string; /** - * The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) - * denoting the package manager version distributing a package. + * The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ cpeUri?: string; /** @@ -656,8 +514,7 @@ export namespace containeranalysis_v1alpha1 { */ description?: string; /** - * The latest available version of this package in this distribution - * channel. + * The latest available version of this package in this distribution channel. */ latestVersion?: Schema$Version; /** @@ -670,45 +527,32 @@ export namespace containeranalysis_v1alpha1 { url?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Container message for hashes of byte content of files, used in Source - * messages to verify integrity of source input to the build. + * Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. */ export interface Schema$FileHashes { /** @@ -721,8 +565,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$Fingerprint { /** - * The layer-id of the final layer in the Docker image's v1 - * representation. This field can be used as a filter in list requests. + * The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. */ v1Name?: string; /** @@ -730,10 +573,7 @@ export namespace containeranalysis_v1alpha1 { */ v2Blob?: string[]; /** - * Output only. The name of the image's v2 blobs computed via: [bottom] - * := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) - * Only the name of the final blob is kept. This field can be used as a - * filter in list requests. + * Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. */ v2Name?: string; } @@ -742,8 +582,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$GetIamPolicyRequest {} /** - * A summary of how many vulnz occurrences there are per severity type. counts - * by groups, or if we should have different summary messages like this. + * A summary of how many vulnz occurrences there are per severity type. counts by groups, or if we should have different summary messages like this. */ export interface Schema$GetVulnzOccurrencesSummaryResponse { /** @@ -765,8 +604,7 @@ export namespace containeranalysis_v1alpha1 { name?: string; } /** - * A CloudRepoSourceContext denotes a particular revision in a Google Cloud - * Source Repo. + * A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. */ export interface Schema$GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext { /** @@ -791,9 +629,7 @@ export namespace containeranalysis_v1alpha1 { */ aliasContext?: Schema$GoogleDevtoolsContaineranalysisV1alpha1AliasContext; /** - * The full project name within the host. Projects may be nested, so - * "project/subproject" is a valid project name. The "repo - * name" is the hostURI/project. + * The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. */ gerritProject?: string; /** @@ -806,8 +642,7 @@ export namespace containeranalysis_v1alpha1 { revisionId?: string; } /** - * A GitSourceContext denotes a particular revision in a third party Git - * repository (e.g., GitHub). + * A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). */ export interface Schema$GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext { /** @@ -820,8 +655,7 @@ export namespace containeranalysis_v1alpha1 { url?: string; } /** - * Metadata for all operations used and required for all operations that - * created by Container Analysis Providers + * Metadata for all operations used and required for all operations that created by Container Analysis Providers */ export interface Schema$GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata { /** @@ -834,8 +668,7 @@ export namespace containeranalysis_v1alpha1 { endTime?: string; } /** - * Selects a repo using a Google Cloud Platform project ID (e.g., - * winged-cargo-31) and a repo name within that project. + * Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. */ export interface Schema$GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId { /** @@ -861,8 +694,7 @@ export namespace containeranalysis_v1alpha1 { uid?: string; } /** - * A SourceContext is a reference to a tree of files. A SourceContext together - * with a path point to a unique revision of a single file or directory. + * A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. */ export interface Schema$GoogleDevtoolsContaineranalysisV1alpha1SourceContext { /** @@ -896,13 +728,11 @@ export namespace containeranalysis_v1alpha1 { value?: string; } /** - * This represents how a particular software package may be installed on a - * system. + * This represents how a particular software package may be installed on a system. */ export interface Schema$Installation { /** - * All of the places within the filesystem versions of this package have - * been found. + * All of the places within the filesystem versions of this package have been found. */ location?: Schema$Location[]; /** @@ -941,9 +771,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$ListNotesResponse { /** - * The next pagination token in the list response. It should be used as - * page_token for the following request. An empty value means no more - * result. + * The next pagination token in the list response. It should be used as page_token for the following request. An empty value means no more result. */ nextPageToken?: string; /** @@ -956,9 +784,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$ListOccurrencesResponse { /** - * The next pagination token in the list response. It should be used as - * `page_token` for the following request. An empty value means no more - * results. + * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ nextPageToken?: string; /** @@ -980,13 +806,11 @@ export namespace containeranalysis_v1alpha1 { scanConfigs?: Schema$ScanConfig[]; } /** - * An occurrence of a particular package installation found within a - * system's filesystem. e.g. glibc was found in /var/lib/dpkg/status + * An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status */ export interface Schema$Location { /** - * The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) - * denoting the package manager version distributing a package. + * The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ cpeUri?: string; /** @@ -1015,8 +839,7 @@ export namespace containeranalysis_v1alpha1 { */ buildType?: Schema$BuildType; /** - * Output only. The time this note was created. This field can be used as a - * filter in list requests. + * Output only. The time this note was created. This field can be used as a filter in list requests. */ createTime?: string; /** @@ -1032,8 +855,7 @@ export namespace containeranalysis_v1alpha1 { */ expirationTime?: string; /** - * Output only. This explicitly denotes which kind of note is specified. - * This field can be used as a filter in list requests. + * Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. */ kind?: string; /** @@ -1041,8 +863,7 @@ export namespace containeranalysis_v1alpha1 { */ longDescription?: string; /** - * The name of the note in the form - * "providers/{provider_id}/notes/{NOTE_ID}" + * The name of the note in the form "providers/{provider_id}/notes/{NOTE_ID}" */ name?: string; /** @@ -1058,8 +879,7 @@ export namespace containeranalysis_v1alpha1 { */ shortDescription?: string; /** - * Output only. The time this note was last updated. This field can be used - * as a filter in list requests. + * Output only. The time this note was last updated. This field can be used as a filter in list requests. */ updateTime?: string; /** @@ -1088,8 +908,7 @@ export namespace containeranalysis_v1alpha1 { */ deployment?: Schema$Deployment; /** - * Describes how this resource derives from the basis in the associated - * note. + * Describes how this resource derives from the basis in the associated note. */ derivedImage?: Schema$Derived; /** @@ -1101,19 +920,15 @@ export namespace containeranalysis_v1alpha1 { */ installation?: Schema$Installation; /** - * Output only. This explicitly denotes which of the `Occurrence` details - * are specified. This field can be used as a filter in list requests. + * Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. */ kind?: string; /** - * Output only. The name of the `Occurrence` in the form - * "projects/{project_id}/occurrences/{OCCURRENCE_ID}" + * Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" */ name?: string; /** - * An analysis note associated with this image, in the form - * "providers/{provider_id}/notes/{NOTE_ID}" This field can be - * used as a filter in list requests. + * An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. */ noteName?: string; /** @@ -1125,9 +940,7 @@ export namespace containeranalysis_v1alpha1 { */ resource?: Schema$Resource; /** - * The unique URL of the image or the container for which the `Occurrence` - * applies. For example, https://gcr.io/project/image@sha256:foo This field - * can be used as a filter in list requests. + * The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. */ resourceUrl?: string; /** @@ -1140,14 +953,11 @@ export namespace containeranalysis_v1alpha1 { vulnerabilityDetails?: Schema$VulnerabilityDetails; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1155,33 +965,20 @@ export namespace containeranalysis_v1alpha1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * This represents a particular package that is distributed over various - * channels. e.g. glibc (aka libc6) is distributed by many, at various - * versions. + * This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. */ export interface Schema$Package { /** @@ -1194,8 +991,7 @@ export namespace containeranalysis_v1alpha1 { name?: string; } /** - * This message wraps a location affected by a vulnerability and its - * associated fix (if one is available). + * This message wraps a location affected by a vulnerability and its associated fix (if one is available). */ export interface Schema$PackageIssue { /** @@ -1209,66 +1005,24 @@ export namespace containeranalysis_v1alpha1 { severityName?: string; } /** - * An attestation wrapper with a PGP-compatible signature. This message only - * supports `ATTACHED` signatures, where the payload that is signed is - * included alongside the signature itself in the same file. + * An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. */ export interface Schema$PgpSignedAttestation { /** - * Type (for example schema) of the attestation payload that was signed. The - * verifier must ensure that the provided type is one that the verifier - * supports, and that the attestation payload is a valid instantiation of - * that type (for example by validating a JSON schema). + * Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). */ contentType?: string; /** - * The cryptographic fingerprint of the key used to generate the signature, - * as output by, e.g. `gpg --list-keys`. This should be the version 4, full - * 160-bit fingerprint, expressed as a 40 character hexadecimal string. See - * https://tools.ietf.org/html/rfc4880#section-12.2 for details. - * Implementations may choose to acknowledge "LONG", - * "SHORT", or other abbreviated key IDs, but only the full - * fingerprint is guaranteed to work. In gpg, the full fingerprint can be - * retrieved from the `fpr` field returned when calling --list-keys with - * --with-colons. For example: ``` gpg --with-colons --with-fingerprint - * --force-v4-certs \ --list-keys attester@example.com - * tru::1:1513631572:0:3:1:5 pub:...<SNIP>... - * fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the - * fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. + * The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...<SNIP>... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. */ pgpKeyId?: string; /** - * The raw content of the signature, as output by GNU Privacy Guard (GPG) or - * equivalent. Since this message only supports attached signatures, the - * payload that was signed must be attached. While the signature format - * supported is dependent on the verification implementation, currently only - * ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than - * `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor - * --output=signature.gpg payload.json` will create the signature content - * expected in this field in `signature.gpg` for the `payload.json` - * attestation payload. + * The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. */ signature?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -1276,20 +1030,11 @@ export namespace containeranalysis_v1alpha1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1311,8 +1056,7 @@ export namespace containeranalysis_v1alpha1 { url?: string; } /** - * RepoSource describes the location of the source in a Google Cloud Source - * Repository. + * RepoSource describes the location of the source in a Google Cloud Source Repository. */ export interface Schema$RepoSource { /** @@ -1345,13 +1089,11 @@ export namespace containeranalysis_v1alpha1 { */ contentHash?: Schema$Hash; /** - * The name of the resource. E.g., the name of a Docker image - - * "Debian". + * The name of the resource. E.g., the name of a Docker image - "Debian". */ name?: string; /** - * The unique URI of the resource. E.g., - * "https://gcr.io/project/image@sha256:foo" for a Docker image. + * The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. */ uri?: string; } @@ -1372,8 +1114,7 @@ export namespace containeranalysis_v1alpha1 { */ enabled?: boolean; /** - * Output only. The name of the ScanConfig in the form - * “projects/{project_id}/scanConfigs/{scan_config_id}". + * Output only. The name of the ScanConfig in the form “projects/{project_id}/scanConfigs/{scan_config_id}". */ name?: string; /** @@ -1386,17 +1127,11 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -1418,15 +1153,11 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$Source { /** - * If provided, some of the source code used for the build may be found in - * these locations, in the case where the source repository had multiple - * remotes or submodules. This list will not include the context specified - * in the context field. + * If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. */ additionalContexts?: Schema$GoogleDevtoolsContaineranalysisV1alpha1SourceContext[]; /** - * If provided, the input binary artifacts for the build came from this - * location. + * If provided, the input binary artifacts for the build came from this location. */ artifactStorageSource?: Schema$StorageSource; /** @@ -1434,12 +1165,7 @@ export namespace containeranalysis_v1alpha1 { */ context?: Schema$GoogleDevtoolsContaineranalysisV1alpha1SourceContext; /** - * Hash(es) of the build source, which can be used to verify that the - * original source integrity was maintained in the build. The keys to this - * map are file paths used as build source and the values contain the hash - * values for those files. If the build source came in a single package - * such as a gzipped tarfile (.tar.gz), the FileHash will be for the single - * path to that file. + * Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes}; /** @@ -1447,46 +1173,12 @@ export namespace containeranalysis_v1alpha1 { */ repoSource?: Schema$RepoSource; /** - * If provided, get the source from this location in in Google Cloud - * Storage. + * If provided, get the source from this location in in Google Cloud Storage. */ storageSource?: Schema$StorageSource; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1494,26 +1186,20 @@ export namespace containeranalysis_v1alpha1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * StorageSource describes the location of the source in an archive file in - * Google Cloud Storage. + * StorageSource describes the location of the source in an archive file in Google Cloud Storage. */ export interface Schema$StorageSource { /** - * Google Cloud Storage bucket containing source (see [Bucket Name - * Requirements] - * (https://cloud.google.com/storage/docs/bucket-naming#requirements)). + * Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ bucket?: string; /** @@ -1530,10 +1216,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1542,8 +1225,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1561,11 +1243,7 @@ export namespace containeranalysis_v1alpha1 { updateMask?: string; } /** - * Version contains structured information about the version of the package. - * For a discussion of this in Debian/Ubuntu: - * http://serverfault.com/questions/604541/debian-packages-version-convention - * For a discussion of this in Redhat/Fedora/Centos: - * http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ + * Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ */ export interface Schema$Version { /** @@ -1573,8 +1251,7 @@ export namespace containeranalysis_v1alpha1 { */ epoch?: number; /** - * Distinguish between sentinel MIN/MAX versions and normal versions. If - * kind is not NORMAL, then the other fields are ignored. + * Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. */ kind?: string; /** @@ -1587,25 +1264,19 @@ export namespace containeranalysis_v1alpha1 { revision?: string; } /** - * Used by Occurrence to point to where the vulnerability exists and how to - * fix it. + * Used by Occurrence to point to where the vulnerability exists and how to fix it. */ export interface Schema$VulnerabilityDetails { /** - * Output only. The CVSS score of this vulnerability. CVSS score is on a - * scale of 0-10 where 0 indicates low severity and 10 indicates high - * severity. + * Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. */ cvssScore?: number; /** - * The distro assigned severity for this vulnerability when that is - * available and note provider assigned severity when distro has not yet - * assigned a severity for this vulnerability. + * The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. */ effectiveSeverity?: string; /** - * The set of affected locations and their fixes (if available) within the - * associated resource. + * The set of affected locations and their fixes (if available) within the associated resource. */ packageIssue?: Schema$PackageIssue[]; /** @@ -1613,8 +1284,7 @@ export namespace containeranalysis_v1alpha1 { */ severity?: string; /** - * The type of package; whether native or non native(ruby gems, node.js - * packages etc) + * The type of package; whether native or non native(ruby gems, node.js packages etc) */ type?: string; } @@ -1623,9 +1293,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$VulnerabilityLocation { /** - * The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) - * format. Examples include distro or storage location for vulnerable jar. - * This field can be used as a filter in list requests. + * The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. */ cpeUri?: string; /** @@ -1633,8 +1301,7 @@ export namespace containeranalysis_v1alpha1 { */ package?: string; /** - * The version of the package being described. This field can be used as a - * filter in list requests. + * The version of the package being described. This field can be used as a filter in list requests. */ version?: Schema$Version; } @@ -1647,9 +1314,7 @@ export namespace containeranalysis_v1alpha1 { */ cvssScore?: number; /** - * All information about the package to specifically identify this - * vulnerability. One entry per (version range and cpe_uri) the package - * vulnerability has manifested in. + * All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in. */ details?: Schema$Detail[]; /** @@ -1899,17 +1564,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.notes.getIamPolicy - * @desc Gets the access control policy for a note or an `Occurrence` - * resource. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a note or occurrence, respectively. Attempting to call this method on - * a resource without the required permission will result in a - * `PERMISSION_DENIED` error. Attempting to call this method on a - * non-existent resource will result in a `NOT_FOUND` error if the user has - * list permission on the project, or a `PERMISSION_DENIED` error otherwise. - * The resource takes the following formats: - * `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and - * projects/{PROJECT_ID}/notes/{NOTE_ID} for notes + * @desc Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes * @alias containeranalysis.projects.notes.getIamPolicy * @memberOf! () * @@ -2134,18 +1789,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.notes.setIamPolicy - * @desc Sets the access control policy on the specified `Note` or - * `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a `Note` or an `Occurrence`, respectively. Attempting to call this - * method without these permissions will result in a ` `PERMISSION_DENIED` - * error. Attempting to call this method on a non-existent resource will - * result in a `NOT_FOUND` error if the user has - * `containeranalysis.notes.list` permission on a `Note` or - * `containeranalysis.occurrences.list` on an `Occurrence`, or a - * `PERMISSION_DENIED` error otherwise. The resource takes the following - * formats: `projects/{projectid}/occurrences/{occurrenceid}` for - * occurrences and projects/{projectid}/notes/{noteid} for notes + * @desc Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes * @alias containeranalysis.projects.notes.setIamPolicy * @memberOf! () * @@ -2219,15 +1863,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.notes.testIamPermissions - * @desc Returns the permissions that a caller has on the specified note or - * occurrence resource. Requires list permission on the project (for - * example, "storage.objects.list" on the containing bucket for testing - * permission of an object). Attempting to call this method on a - * non-existent resource will result in a `NOT_FOUND` error if the user has - * list permission on the project, or a `PERMISSION_DENIED` error otherwise. - * The resource takes the following formats: - * `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and - * `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` + * @desc Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` * @alias containeranalysis.projects.notes.testIamPermissions * @memberOf! () * @@ -2317,8 +1953,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project. Should be of the form "providers/{provider_id}". - * @Deprecated + * The name of the project. Should be of the form "providers/{provider_id}". @Deprecated */ name?: string; /** @@ -2343,8 +1978,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of - * "providers/{provider_id}/notes/{NOTE_ID}" + * The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" */ name?: string; } @@ -2356,8 +1990,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of - * "providers/{provider_id}/notes/{NOTE_ID}" + * The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" */ name?: string; } @@ -2369,8 +2002,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2391,8 +2023,7 @@ export namespace containeranalysis_v1alpha1 { */ filter?: string; /** - * The name field will contain the project Id for example: - * "providers/{provider_id} @Deprecated + * The name field will contain the project Id for example: "providers/{provider_id} @Deprecated */ name?: string; /** @@ -2416,8 +2047,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note. Should be of the form - * "projects/{provider_id}/notes/{note_id}". + * The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}". */ name?: string; /** @@ -2438,8 +2068,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2456,8 +2085,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2475,9 +2103,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.notes.occurrences.list - * @desc Lists `Occurrences` referencing the specified `Note`. Use this - * method to get all occurrences referencing your `Note` across all your - * customer projects. + * @desc Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects. * @alias containeranalysis.projects.notes.occurrences.list * @memberOf! () * @@ -2573,8 +2199,7 @@ export namespace containeranalysis_v1alpha1 { */ filter?: string; /** - * The name field will contain the note name for example: - * "provider/{provider_id}/notes/{note_id}" + * The name field will contain the note name for example: "provider/{provider_id}/notes/{note_id}" */ name?: string; /** @@ -2595,8 +2220,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.occurrences.create - * @desc Creates a new `Occurrence`. Use this method to create `Occurrences` - * for a resource. + * @desc Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource. * @alias containeranalysis.projects.occurrences.create * @memberOf! () * @@ -2673,8 +2297,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.occurrences.delete - * @desc Deletes the given `Occurrence` from the system. Use this when an - * `Occurrence` is no longer applicable for the given resource. + * @desc Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource. * @alias containeranalysis.projects.occurrences.delete * @memberOf! () * @@ -2816,17 +2439,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.occurrences.getIamPolicy - * @desc Gets the access control policy for a note or an `Occurrence` - * resource. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a note or occurrence, respectively. Attempting to call this method on - * a resource without the required permission will result in a - * `PERMISSION_DENIED` error. Attempting to call this method on a - * non-existent resource will result in a `NOT_FOUND` error if the user has - * list permission on the project, or a `PERMISSION_DENIED` error otherwise. - * The resource takes the following formats: - * `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and - * projects/{PROJECT_ID}/notes/{NOTE_ID} for notes + * @desc Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes * @alias containeranalysis.projects.occurrences.getIamPolicy * @memberOf! () * @@ -3057,8 +2670,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.occurrences.list - * @desc Lists active `Occurrences` for a given project matching the - * filters. + * @desc Lists active `Occurrences` for a given project matching the filters. * @alias containeranalysis.projects.occurrences.list * @memberOf! () * @@ -3214,18 +2826,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.occurrences.setIamPolicy - * @desc Sets the access control policy on the specified `Note` or - * `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a `Note` or an `Occurrence`, respectively. Attempting to call this - * method without these permissions will result in a ` `PERMISSION_DENIED` - * error. Attempting to call this method on a non-existent resource will - * result in a `NOT_FOUND` error if the user has - * `containeranalysis.notes.list` permission on a `Note` or - * `containeranalysis.occurrences.list` on an `Occurrence`, or a - * `PERMISSION_DENIED` error otherwise. The resource takes the following - * formats: `projects/{projectid}/occurrences/{occurrenceid}` for - * occurrences and projects/{projectid}/notes/{noteid} for notes + * @desc Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes * @alias containeranalysis.projects.occurrences.setIamPolicy * @memberOf! () * @@ -3299,15 +2900,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.occurrences.testIamPermissions - * @desc Returns the permissions that a caller has on the specified note or - * occurrence resource. Requires list permission on the project (for - * example, "storage.objects.list" on the containing bucket for testing - * permission of an object). Attempting to call this method on a - * non-existent resource will result in a `NOT_FOUND` error if the user has - * list permission on the project, or a `PERMISSION_DENIED` error otherwise. - * The resource takes the following formats: - * `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and - * `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` + * @desc Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` * @alias containeranalysis.projects.occurrences.testIamPermissions * @memberOf! () * @@ -3397,8 +2990,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project. Should be of the form "projects/{project_id}". - * @Deprecated + * The name of the project. Should be of the form "projects/{project_id}". @Deprecated */ name?: string; /** @@ -3419,8 +3011,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of - * "projects/{project_id}/occurrences/{OCCURRENCE_ID}" + * The name of the occurrence in the form of "projects/{project_id}/occurrences/{OCCURRENCE_ID}" */ name?: string; } @@ -3432,8 +3023,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence of the form - * "projects/{project_id}/occurrences/{OCCURRENCE_ID}" + * The name of the occurrence of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" */ name?: string; } @@ -3445,8 +3035,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3463,8 +3052,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form - * "projects/{project_id}/occurrences/{OCCURRENCE_ID}" + * The name of the occurrence in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" */ name?: string; } @@ -3500,8 +3088,7 @@ export namespace containeranalysis_v1alpha1 { */ kind?: string; /** - * The name field contains the project Id. For example: - * "projects/{project_id} @Deprecated + * The name field contains the project Id. For example: "projects/{project_id} @Deprecated */ name?: string; /** @@ -3525,8 +3112,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence. Should be of the form - * "projects/{project_id}/occurrences/{OCCURRENCE_ID}". + * The name of the occurrence. Should be of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}". */ name?: string; /** @@ -3547,8 +3133,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3565,8 +3150,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3660,9 +3244,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.projects.operations.patch - * @desc Updates an existing operation returns an error if operation does - * not exist. The only valid operations are to update mark the done bit - * change the result. + * @desc Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result. * @alias containeranalysis.projects.operations.patch * @memberOf! () * @@ -3759,8 +3341,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the Operation. Should be of the form - * "projects/{provider_id}/operations/{operation_id}". + * The name of the Operation. Should be of the form "projects/{provider_id}/operations/{operation_id}". */ name?: string; @@ -4011,8 +3592,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the ScanConfig in the form - * projects/{project_id}/scanConfigs/{scan_config_id} + * The name of the ScanConfig in the form projects/{project_id}/scanConfigs/{scan_config_id} */ name?: string; } @@ -4048,8 +3628,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The scan config to update of the form - * projects/{project_id}/scanConfigs/{scan_config_id}. + * The scan config to update of the form projects/{project_id}/scanConfigs/{scan_config_id}. */ name?: string; /** @@ -4298,17 +3877,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.providers.notes.getIamPolicy - * @desc Gets the access control policy for a note or an `Occurrence` - * resource. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a note or occurrence, respectively. Attempting to call this method on - * a resource without the required permission will result in a - * `PERMISSION_DENIED` error. Attempting to call this method on a - * non-existent resource will result in a `NOT_FOUND` error if the user has - * list permission on the project, or a `PERMISSION_DENIED` error otherwise. - * The resource takes the following formats: - * `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and - * projects/{PROJECT_ID}/notes/{NOTE_ID} for notes + * @desc Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes * @alias containeranalysis.providers.notes.getIamPolicy * @memberOf! () * @@ -4533,18 +4102,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.providers.notes.setIamPolicy - * @desc Sets the access control policy on the specified `Note` or - * `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a `Note` or an `Occurrence`, respectively. Attempting to call this - * method without these permissions will result in a ` `PERMISSION_DENIED` - * error. Attempting to call this method on a non-existent resource will - * result in a `NOT_FOUND` error if the user has - * `containeranalysis.notes.list` permission on a `Note` or - * `containeranalysis.occurrences.list` on an `Occurrence`, or a - * `PERMISSION_DENIED` error otherwise. The resource takes the following - * formats: `projects/{projectid}/occurrences/{occurrenceid}` for - * occurrences and projects/{projectid}/notes/{noteid} for notes + * @desc Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes * @alias containeranalysis.providers.notes.setIamPolicy * @memberOf! () * @@ -4618,15 +4176,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.providers.notes.testIamPermissions - * @desc Returns the permissions that a caller has on the specified note or - * occurrence resource. Requires list permission on the project (for - * example, "storage.objects.list" on the containing bucket for testing - * permission of an object). Attempting to call this method on a - * non-existent resource will result in a `NOT_FOUND` error if the user has - * list permission on the project, or a `PERMISSION_DENIED` error otherwise. - * The resource takes the following formats: - * `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and - * `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` + * @desc Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` * @alias containeranalysis.providers.notes.testIamPermissions * @memberOf! () * @@ -4716,8 +4266,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project. Should be of the form "providers/{provider_id}". - * @Deprecated + * The name of the project. Should be of the form "providers/{provider_id}". @Deprecated */ name?: string; /** @@ -4742,8 +4291,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of - * "providers/{provider_id}/notes/{NOTE_ID}" + * The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" */ name?: string; } @@ -4755,8 +4303,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of - * "providers/{provider_id}/notes/{NOTE_ID}" + * The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" */ name?: string; } @@ -4768,8 +4315,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4790,8 +4336,7 @@ export namespace containeranalysis_v1alpha1 { */ filter?: string; /** - * The name field will contain the project Id for example: - * "providers/{provider_id} @Deprecated + * The name field will contain the project Id for example: "providers/{provider_id} @Deprecated */ name?: string; /** @@ -4815,8 +4360,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note. Should be of the form - * "projects/{provider_id}/notes/{note_id}". + * The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}". */ name?: string; /** @@ -4837,8 +4381,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4855,8 +4398,7 @@ export namespace containeranalysis_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4874,9 +4416,7 @@ export namespace containeranalysis_v1alpha1 { /** * containeranalysis.providers.notes.occurrences.list - * @desc Lists `Occurrences` referencing the specified `Note`. Use this - * method to get all occurrences referencing your `Note` across all your - * customer projects. + * @desc Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects. * @alias containeranalysis.providers.notes.occurrences.list * @memberOf! () * @@ -4972,8 +4512,7 @@ export namespace containeranalysis_v1alpha1 { */ filter?: string; /** - * The name field will contain the note name for example: - * "provider/{provider_id}/notes/{note_id}" + * The name field will contain the note name for example: "provider/{provider_id}/notes/{note_id}" */ name?: string; /** diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index eb101450120..df04c7d3ed7 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace containeranalysis_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace containeranalysis_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace containeranalysis_v1beta1 { /** * Container Analysis API * - * An implementation of the Grafeas API, which stores, and enables querying - * and retrieval of critical metadata about all of your software artifacts. + * An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace containeranalysis_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -137,33 +135,20 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$Artifact { /** - * Hash or checksum value of a binary, or Docker Registry 2.0 digest of a - * container. + * Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. */ checksum?: string; /** - * Artifact ID, if any; for container images, this will be a URL by digest - * like `gcr.io/projectID/imagename@sha256:123456`. + * Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`. */ id?: string; /** - * Related artifact names. This may be the path to a binary or jar file, or - * in the case of a container build, the name used to push the container - * image to Google Container Registry, as presented to `docker push`. Note - * that a single Artifact ID can have multiple names, for example if two - * tags are applied to one image. + * Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. */ names?: string[]; } /** - * Occurrence that represents a single "attestation". The - * authenticity of an attestation can be verified using the attached - * signature. If the verifier trusts the public key of the signer, then - * verifying the signature is sufficient to establish trust. In this - * circumstance, the authority to which this attestation is attached is - * primarily useful for look-up (how to find this attestation if you already - * know the authority and artifact to be verified) and intent (which authority - * was this attestation intended to sign for). + * Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). */ export interface Schema$Attestation { genericSignedAttestation?: Schema$GenericSignedAttestation; @@ -173,27 +158,7 @@ export namespace containeranalysis_v1beta1 { pgpSignedAttestation?: Schema$PgpSignedAttestation; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -201,25 +166,16 @@ export namespace containeranalysis_v1beta1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -228,15 +184,7 @@ export namespace containeranalysis_v1beta1 { logType?: string; } /** - * Note kind that represents a logical attestation "role" or - * "authority". For example, an organization might have one - * `Authority` for "QA" and one for "build". This note is - * intended to act strictly as a grouping mechanism for the attached - * occurrences (Attestations). This grouping mechanism also provides a - * security boundary, since IAM ACLs gate the ability for a principle to - * attach an occurrence to a given note. It also provides a single point of - * lookup to find all attached attestation occurrences, even if they don't - * all live in the same project. + * Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. */ export interface Schema$Authority { /** @@ -245,10 +193,7 @@ export namespace containeranalysis_v1beta1 { hint?: Schema$Hint; } /** - * Basis describes the base image portion (Note) of the DockerImage - * relationship. Linked occurrences are derived from this or an equivalent - * image via: FROM <Basis.resource_url> Or an equivalent reference, - * e.g. a tag of the resource_url. + * Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM <Basis.resource_url> Or an equivalent reference, e.g. a tag of the resource_url. */ export interface Schema$Basis { /** @@ -256,8 +201,7 @@ export namespace containeranalysis_v1beta1 { */ fingerprint?: Schema$Fingerprint; /** - * Required. Immutable. The resource_url for the resource representing the - * basis of associated occurrence images. + * Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. */ resourceUrl?: string; } @@ -302,36 +246,20 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Note holding the version of the provider's builder and the signature of - * the provenance message in the build details occurrence. + * Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. */ export interface Schema$Build { /** @@ -339,14 +267,12 @@ export namespace containeranalysis_v1beta1 { */ builderVersion?: string; /** - * Signature of the build in occurrences pointing to this build note - * containing build details. + * Signature of the build in occurrences pointing to this build note containing build details. */ signature?: Schema$BuildSignature; } /** - * Provenance of a build. Contains all information needed to verify the full - * details about the build from source to completion. + * Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. */ export interface Schema$BuildProvenance { /** @@ -354,8 +280,7 @@ export namespace containeranalysis_v1beta1 { */ builderVersion?: string; /** - * Special options applied to this build. This is a catch-all field where - * build providers can enter any desired additional details. + * Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. */ buildOptions?: {[key: string]: string}; /** @@ -371,9 +296,7 @@ export namespace containeranalysis_v1beta1 { */ createTime?: string; /** - * E-mail address of the user who initiated this build. Note that this was - * the user's e-mail address at the time the build was initiated; this - * address may not represent the same end-user for all time. + * E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. */ creator?: string; /** @@ -401,8 +324,7 @@ export namespace containeranalysis_v1beta1 { */ startTime?: string; /** - * Trigger identifier if the build was triggered automatically; empty if - * not. + * Trigger identifier if the build was triggered automatically; empty if not. */ triggerId?: string; } @@ -411,39 +333,24 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$BuildSignature { /** - * An ID for the key used to sign. This could be either an ID for the key - * stored in `public_key` (such as the ID or fingerprint for a PGP key, or - * the CN for a cert), or a reference to an external key (such as a - * reference to a key in Cloud Key Management Service). + * An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service). */ keyId?: string; /** - * The type of the key, either stored in `public_key` or referenced in - * `key_id`. + * The type of the key, either stored in `public_key` or referenced in `key_id`. */ keyType?: string; /** - * Public key of the builder which can be used to verify that the related - * findings are valid and unchanged. If `key_type` is empty, this defaults - * to PEM encoded public keys. This field may be empty if `key_id` - * references an external key. For Cloud Build based signatures, this is a - * PEM encoded public key. To verify the Cloud Build signature, place the - * contents of this field into a file (public.pem). The signature field is - * base64-decoded into its binary representation in signature.bin, and the - * provenance bytes from `BuildDetails` are base64-decoded into a binary - * representation in signed.bin. OpenSSL can then verify the signature: - * `openssl sha256 -verify public.pem -signature signature.bin signed.bin` + * Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin` */ publicKey?: string; /** - * Required. Signature of the related `BuildProvenance`. In JSON, this is - * base-64 encoded. + * Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. */ signature?: string; } /** - * A CloudRepoSourceContext denotes a particular revision in a Google Cloud - * Source Repo. + * A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. */ export interface Schema$CloudRepoSourceContext { /** @@ -468,8 +375,7 @@ export namespace containeranalysis_v1beta1 { */ args?: string[]; /** - * Working directory (relative to project source root) used when running - * this command. + * Working directory (relative to project source root) used when running this command. */ dir?: string; /** @@ -477,14 +383,11 @@ export namespace containeranalysis_v1beta1 { */ env?: string[]; /** - * Optional unique identifier for this command, used in wait_for to - * reference this command as a dependency. + * Optional unique identifier for this command, used in wait_for to reference this command as a dependency. */ id?: string; /** - * Required. Name of the command, as presented on the command line, or if - * the command is packaged as a Docker container, as presented to `docker - * pull`. + * Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. */ name?: string; /** @@ -492,6 +395,28 @@ export namespace containeranalysis_v1beta1 { */ waitFor?: string[]; } + /** + * Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document + */ + export interface Schema$CVSSv3 { + attackComplexity?: string; + /** + * Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + */ + attackVector?: string; + availabilityImpact?: string; + /** + * The base score is a function of the base metric scores. + */ + baseScore?: number; + confidentialityImpact?: string; + exploitabilityScore?: number; + impactScore?: number; + integrityImpact?: string; + privilegesRequired?: string; + scope?: string; + userInteraction?: string; + } /** * An artifact that can be deployed in some runtime. */ @@ -522,8 +447,7 @@ export namespace containeranalysis_v1beta1 { */ platform?: string; /** - * Output only. Resource URI for the artifact being deployed taken from the - * deployable field with the same name. + * Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. */ resourceUri?: string[]; /** @@ -536,19 +460,15 @@ export namespace containeranalysis_v1beta1 { userEmail?: string; } /** - * Derived describes the derived image portion (Occurrence) of the DockerImage - * relationship. This image would be produced from a Dockerfile with FROM - * <DockerImage.Basis in attached Note>. + * Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM <DockerImage.Basis in attached Note>. */ export interface Schema$Derived { /** - * Output only. This contains the base image URL for the derived image - * occurrence. + * Output only. This contains the base image URL for the derived image occurrence. */ baseResourceUrl?: string; /** - * Output only. The number of layers by which this image differs from the - * associated image basis. + * Output only. The number of layers by which this image differs from the associated image basis. */ distance?: number; /** @@ -556,23 +476,16 @@ export namespace containeranalysis_v1beta1 { */ fingerprint?: Schema$Fingerprint; /** - * This contains layer-specific metadata, if populated it has length - * "distance" and is ordered with [distance] being the layer - * immediately following the base image and [1] being the final layer. + * This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. */ layerInfo?: Schema$Layer[]; } /** - * Identifies all appearances of this vulnerability in the package for a - * specific distro/location. For example: glibc in - * cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 + * Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 */ export interface Schema$Detail { /** - * Required. The CPE URI in [cpe - * format](https://cpe.mitre.org/specification/) in which the vulnerability - * manifests. Examples include distro or storage location for vulnerable - * jar. + * Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. */ cpeUri?: string; /** @@ -584,8 +497,7 @@ export namespace containeranalysis_v1beta1 { */ fixedLocation?: Schema$VulnerabilityLocation; /** - * Whether this detail is obsolete. Occurrences are expected not to point to - * obsolete details. + * Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. */ isObsolete?: boolean; /** @@ -601,8 +513,7 @@ export namespace containeranalysis_v1beta1 { */ package?: string; /** - * The type of package; whether native or non native(ruby gems, node.js - * packages etc). + * The type of package; whether native or non native(ruby gems, node.js packages etc). */ packageType?: string; /** @@ -628,9 +539,7 @@ export namespace containeranalysis_v1beta1 { */ analysisStatus?: string; /** - * When an error is encountered this will contain a LocalizedMessage under - * details to show to the user. The LocalizedMessage is output only and - * populated by the API. + * When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. */ analysisStatusError?: Schema$Status; /** @@ -638,37 +547,29 @@ export namespace containeranalysis_v1beta1 { */ continuousAnalysis?: string; /** - * The last time continuous analysis was done for this resource. Deprecated, - * do not use. + * The last time continuous analysis was done for this resource. Deprecated, do not use. */ lastAnalysisTime?: string; } /** - * A note that indicates a type of analysis a provider would perform. This - * note exists in a provider's project. A `Discovery` occurrence is - * created in a consumer's project at the start of analysis. + * A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. */ export interface Schema$Discovery { /** - * Required. Immutable. The kind of analysis that is handled by this - * discovery. + * Required. Immutable. The kind of analysis that is handled by this discovery. */ analysisKind?: string; } /** - * This represents a particular channel of distribution for a given package. - * E.g., Debian's jessie-backports dpkg mirror. + * This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. */ export interface Schema$Distribution { /** - * The CPU architecture for which packages in this distribution channel were - * built. + * The CPU architecture for which packages in this distribution channel were built. */ architecture?: string; /** - * Required. The cpe_uri in [CPE - * format](https://cpe.mitre.org/specification/) denoting the package - * manager version distributing a package. + * Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ cpeUri?: string; /** @@ -676,8 +577,7 @@ export namespace containeranalysis_v1beta1 { */ description?: string; /** - * The latest available version of this package in this distribution - * channel. + * The latest available version of this package in this distribution channel. */ latestVersion?: Schema$Version; /** @@ -690,45 +590,32 @@ export namespace containeranalysis_v1beta1 { url?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Container message for hashes of byte content of files, used in source - * messages to verify integrity of source input to the build. + * Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build. */ export interface Schema$FileHashes { /** @@ -741,8 +628,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$Fingerprint { /** - * Required. The layer ID of the final layer in the Docker image's v1 - * representation. + * Required. The layer ID of the final layer in the Docker image's v1 representation. */ v1Name?: string; /** @@ -750,9 +636,7 @@ export namespace containeranalysis_v1beta1 { */ v2Blob?: string[]; /** - * Output only. The name of the image's v2 blobs computed via: [bottom] - * := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) - * Only the name of the final blob is kept. + * Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. */ v2Name?: string; } @@ -769,8 +653,7 @@ export namespace containeranalysis_v1beta1 { */ resource?: Schema$Resource; /** - * The severity for this count. SEVERITY_UNSPECIFIED indicates total across - * all severities. + * The severity for this count. SEVERITY_UNSPECIFIED indicates total across all severities. */ severity?: string; /** @@ -779,30 +662,19 @@ export namespace containeranalysis_v1beta1 { totalCount?: string; } /** - * An attestation wrapper that uses the Grafeas `Signature` message. This - * attestation must define the `serialized_payload` that the `signatures` - * verify and any metadata necessary to interpret that plaintext. The - * signatures should always be over the `serialized_payload` bytestring. + * An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring. */ export interface Schema$GenericSignedAttestation { /** - * Type (for example schema) of the attestation payload that was signed. The - * verifier must ensure that the provided type is one that the verifier - * supports, and that the attestation payload is a valid instantiation of - * that type (for example by validating a JSON schema). + * Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). */ contentType?: string; /** - * The serialized payload that is verified by one or more `signatures`. The - * encoding and semantic meaning of this payload must match what is set in - * `content_type`. + * The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`. */ serializedPayload?: string; /** - * One or more signatures over `serialized_payload`. Verifier - * implementations should consider this attestation message verified if at - * least one `signature` verifies `serialized_payload`. See `Signature` in - * common.proto for more details on signature structure and verification. + * One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification. */ signatures?: Schema$Signature[]; } @@ -815,9 +687,7 @@ export namespace containeranalysis_v1beta1 { */ aliasContext?: Schema$AliasContext; /** - * The full project name within the host. Projects may be nested, so - * "project/subproject" is a valid project name. The "repo - * name" is the hostURI/project. + * The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. */ gerritProject?: string; /** @@ -834,8 +704,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$GetIamPolicyRequest {} /** - * A GitSourceContext denotes a particular revision in a third party Git - * repository (e.g., GitHub). + * A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). */ export interface Schema$GitSourceContext { /** @@ -848,8 +717,7 @@ export namespace containeranalysis_v1beta1 { url?: string; } /** - * Metadata for all operations used and required for all operations that - * created by Container Analysis Providers + * Metadata for all operations used and required for all operations that created by Container Analysis Providers */ export interface Schema$GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata { /** @@ -870,15 +738,7 @@ export namespace containeranalysis_v1beta1 { */ provenance?: Schema$BuildProvenance; /** - * Serialized JSON representation of the provenance, used in generating the - * build signature in the corresponding build note. After verifying the - * signature, `provenance_bytes` can be unmarshalled and compared to the - * provenance to confirm that it is unchanged. A base64-encoded string - * representation of the provenance bytes is used for the signature in order - * to interoperate with openssl which expects this format for signature - * verification. The serialized form is captured both to avoid ambiguity in - * how the provenance is marshalled to json as well to prevent - * incompatibilities with future changes. + * Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. */ provenanceBytes?: string; } @@ -923,15 +783,11 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$GrafeasV1beta1VulnerabilityDetails { /** - * Output only. The CVSS score of this vulnerability. CVSS score is on a - * scale of 0-10 where 0 indicates low severity and 10 indicates high - * severity. + * Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. */ cvssScore?: number; /** - * The distro assigned severity for this vulnerability when it is available, - * and note provider assigned severity when distro has not yet assigned a - * severity for this vulnerability. + * The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. */ effectiveSeverity?: string; /** @@ -939,8 +795,7 @@ export namespace containeranalysis_v1beta1 { */ longDescription?: string; /** - * Required. The set of affected locations and their fixes (if available) - * within the associated resource. + * Required. The set of affected locations and their fixes (if available) within the associated resource. */ packageIssue?: Schema$PackageIssue[]; /** @@ -956,8 +811,7 @@ export namespace containeranalysis_v1beta1 { */ shortDescription?: string; /** - * The type of package; whether native or non native(ruby gems, node.js - * packages etc) + * The type of package; whether native or non native(ruby gems, node.js packages etc) */ type?: string; } @@ -975,29 +829,20 @@ export namespace containeranalysis_v1beta1 { value?: string; } /** - * This submessage provides human-readable hints about the purpose of the - * authority. Because the name of a note acts as its resource reference, it is - * important to disambiguate the canonical name of the Note (which might be a - * UUID for security purposes) from "readable" names more suitable - * for debug output. Note that these hints should not be used to look up - * authorities in security sensitive contexts, such as when looking up - * attestations to verify. + * This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. */ export interface Schema$Hint { /** - * Required. The human readable name of this attestation authority, for - * example "qa". + * Required. The human readable name of this attestation authority, for example "qa". */ humanReadableName?: string; } /** - * This represents how a particular software package may be installed on a - * system. + * This represents how a particular software package may be installed on a system. */ export interface Schema$Installation { /** - * Required. All of the places within the filesystem versions of this - * package have been found. + * Required. All of the places within the filesystem versions of this package have been found. */ location?: Schema$Location[]; /** @@ -1011,8 +856,7 @@ export namespace containeranalysis_v1beta1 { */ name?: string; /** - * A link to the KB in the Windows update catalog - - * https://www.catalog.update.microsoft.com/ + * A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ */ url?: string; } @@ -1025,8 +869,7 @@ export namespace containeranalysis_v1beta1 { */ arguments?: string; /** - * Required. The recovered Dockerfile directive used to construct this - * layer. + * Required. The recovered Dockerfile directive used to construct this layer. */ directive?: string; } @@ -1048,9 +891,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$ListNotesResponse { /** - * The next pagination token in the list response. It should be used as - * `page_token` for the following request. An empty value means no more - * results. + * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ nextPageToken?: string; /** @@ -1063,9 +904,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$ListOccurrencesResponse { /** - * The next pagination token in the list response. It should be used as - * `page_token` for the following request. An empty value means no more - * results. + * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ nextPageToken?: string; /** @@ -1078,9 +917,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$ListScanConfigsResponse { /** - * The next pagination token in the list response. It should be used as - * `page_token` for the following request. An empty value means no more - * results. + * The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. */ nextPageToken?: string; /** @@ -1089,14 +926,11 @@ export namespace containeranalysis_v1beta1 { scanConfigs?: Schema$ScanConfig[]; } /** - * An occurrence of a particular package installation found within a - * system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. + * An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. */ export interface Schema$Location { /** - * Required. The CPE URI in [CPE - * format](https://cpe.mitre.org/specification/) denoting the package - * manager version distributing a package. + * Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. */ cpeUri?: string; /** @@ -1125,8 +959,7 @@ export namespace containeranalysis_v1beta1 { */ build?: Schema$Build; /** - * Output only. The time this note was created. This field can be used as a - * filter in list requests. + * Output only. The time this note was created. This field can be used as a filter in list requests. */ createTime?: string; /** @@ -1142,8 +975,7 @@ export namespace containeranalysis_v1beta1 { */ expirationTime?: string; /** - * Output only. The type of analysis. This field can be used as a filter in - * list requests. + * Output only. The type of analysis. This field can be used as a filter in list requests. */ kind?: string; /** @@ -1151,8 +983,7 @@ export namespace containeranalysis_v1beta1 { */ longDescription?: string; /** - * Output only. The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; /** @@ -1172,8 +1003,7 @@ export namespace containeranalysis_v1beta1 { */ shortDescription?: string; /** - * Output only. The time this note was last updated. This field can be used - * as a filter in list requests. + * Output only. The time this note was last updated. This field can be used as a filter in list requests. */ updateTime?: string; /** @@ -1202,8 +1032,7 @@ export namespace containeranalysis_v1beta1 { */ deployment?: Schema$GrafeasV1beta1DeploymentDetails; /** - * Describes how this resource derives from the basis in the associated - * note. + * Describes how this resource derives from the basis in the associated note. */ derivedImage?: Schema$GrafeasV1beta1ImageDetails; /** @@ -1215,19 +1044,15 @@ export namespace containeranalysis_v1beta1 { */ installation?: Schema$GrafeasV1beta1PackageDetails; /** - * Output only. This explicitly denotes which of the occurrence details are - * specified. This field can be used as a filter in list requests. + * Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. */ kind?: string; /** - * Output only. The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; /** - * Required. Immutable. The analysis note associated with this occurrence, - * in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can - * be used as a filter in list requests. + * Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. */ noteName?: string; /** @@ -1248,9 +1073,7 @@ export namespace containeranalysis_v1beta1 { vulnerability?: Schema$GrafeasV1beta1VulnerabilityDetails; } /** - * This represents a particular package that is distributed over various - * channels. E.g., glibc (aka libc6) is distributed by many, at various - * versions. + * This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. */ export interface Schema$Package { /** @@ -1263,8 +1086,7 @@ export namespace containeranalysis_v1beta1 { name?: string; } /** - * This message wraps a location affected by a vulnerability and its - * associated fix (if one is available). + * This message wraps a location affected by a vulnerability and its associated fix (if one is available). */ export interface Schema$PackageIssue { /** @@ -1276,72 +1098,29 @@ export namespace containeranalysis_v1beta1 { */ fixedLocation?: Schema$VulnerabilityLocation; /** - * Deprecated, use Details.effective_severity instead The severity (e.g., - * distro assigned severity) for this vulnerability. + * Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability. */ severityName?: string; } /** - * An attestation wrapper with a PGP-compatible signature. This message only - * supports `ATTACHED` signatures, where the payload that is signed is - * included alongside the signature itself in the same file. + * An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. */ export interface Schema$PgpSignedAttestation { /** - * Type (for example schema) of the attestation payload that was signed. The - * verifier must ensure that the provided type is one that the verifier - * supports, and that the attestation payload is a valid instantiation of - * that type (for example by validating a JSON schema). + * Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). */ contentType?: string; /** - * The cryptographic fingerprint of the key used to generate the signature, - * as output by, e.g. `gpg --list-keys`. This should be the version 4, full - * 160-bit fingerprint, expressed as a 40 character hexidecimal string. See - * https://tools.ietf.org/html/rfc4880#section-12.2 for details. - * Implementations may choose to acknowledge "LONG", - * "SHORT", or other abbreviated key IDs, but only the full - * fingerprint is guaranteed to work. In gpg, the full fingerprint can be - * retrieved from the `fpr` field returned when calling --list-keys with - * --with-colons. For example: ``` gpg --with-colons --with-fingerprint - * --force-v4-certs \ --list-keys attester@example.com - * tru::1:1513631572:0:3:1:5 pub:...<SNIP>... - * fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the - * fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. + * The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexidecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...<SNIP>... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. */ pgpKeyId?: string; /** - * Required. The raw content of the signature, as output by GNU Privacy - * Guard (GPG) or equivalent. Since this message only supports attached - * signatures, the payload that was signed must be attached. While the - * signature format supported is dependent on the verification - * implementation, currently only ASCII-armored (`--armor` to gpg), - * non-clearsigned (`--sign` rather than `--clearsign` to gpg) are - * supported. Concretely, `gpg --sign --armor --output=signature.gpg - * payload.json` will create the signature content expected in this field in - * `signature.gpg` for the `payload.json` attestation payload. + * Required. The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. */ signature?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -1349,20 +1128,11 @@ export namespace containeranalysis_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1371,8 +1141,7 @@ export namespace containeranalysis_v1beta1 { version?: number; } /** - * Selects a repo using a Google Cloud Platform project ID (e.g., - * winged-cargo-31) and a repo name within that project. + * Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. */ export interface Schema$ProjectRepoId { /** @@ -1419,20 +1188,16 @@ export namespace containeranalysis_v1beta1 { */ contentHash?: Schema$Hash; /** - * The name of the resource. For example, the name of a Docker image - - * "Debian". + * The name of the resource. For example, the name of a Docker image - "Debian". */ name?: string; /** - * Required. The unique URI of the resource. For example, - * `https://gcr.io/project/image@sha256:foo` for a Docker image. + * Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image. */ uri?: string; } /** - * A scan configuration specifies whether Cloud components in a project have a - * particular type of analysis being run. For example, it can configure - * whether vulnerability scanning is being done on Docker images or not. + * A scan configuration specifies whether Cloud components in a project have a particular type of analysis being run. For example, it can configure whether vulnerability scanning is being done on Docker images or not. */ export interface Schema$ScanConfig { /** @@ -1440,8 +1205,7 @@ export namespace containeranalysis_v1beta1 { */ createTime?: string; /** - * Output only. A human-readable description of what the scan configuration - * does. + * Output only. A human-readable description of what the scan configuration does. */ description?: string; /** @@ -1449,8 +1213,7 @@ export namespace containeranalysis_v1beta1 { */ enabled?: boolean; /** - * Output only. The name of the scan configuration in the form of - * `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. + * Output only. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. */ name?: string; /** @@ -1463,62 +1226,24 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * Verifiers (e.g. Kritis implementations) MUST verify signatures with respect - * to the trust anchors defined in policy (e.g. a Kritis policy). Typically - * this means that the verifier has been configured with a map from - * `public_key_id` to public key material (and any required parameters, e.g. - * signing algorithm). In particular, verification implementations MUST NOT - * treat the signature `public_key_id` as anything more than a key lookup - * hint. The `public_key_id` DOES NOT validate or authenticate a public key; - * it only provides a mechanism for quickly selecting a public key ALREADY - * CONFIGURED on the verifier through a trusted channel. Verification - * implementations MUST reject signatures in any of the following - * circumstances: * The `public_key_id` is not recognized by the verifier. - * * The public key that `public_key_id` refers to does not verify the - * signature with respect to the payload. The `signature` contents SHOULD NOT - * be "attached" (where the payload is included with the serialized - * `signature` bytes). Verifiers MUST ignore any "attached" payload - * and only verify signatures with respect to explicitly provided payload - * (e.g. a `payload` field on the proto message that holds this Signature, or - * the canonical serialization of the proto message that holds this - * signature). + * Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be "attached" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any "attached" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature). */ export interface Schema$Signature { /** - * The identifier for the public key that verifies this signature. * The - * `public_key_id` is required. * The `public_key_id` MUST be an RFC3986 - * conformant URI. * When possible, the `public_key_id` SHOULD be an - * immutable reference, such as a cryptographic digest. Examples of - * valid `public_key_id`s: OpenPGP V4 public key fingerprint: * - * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See - * https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more - * details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo - * (digest of the DER serialization): * - * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * - * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" + * The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` MUST be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" */ publicKeyId?: string; /** - * The content of the signature, an opaque bytestring. The payload that this - * signature verifies MUST be unambiguously provided with the Signature - * during verification. A wrapper message might provide the payload - * explicitly. Alternatively, a message might have a canonical serialization - * that can always be unambiguously computed to derive the payload. + * The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload. */ signature?: string; } @@ -1527,15 +1252,11 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$Source { /** - * If provided, some of the source code used for the build may be found in - * these locations, in the case where the source repository had multiple - * remotes or submodules. This list will not include the context specified - * in the context field. + * If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. */ additionalContexts?: Schema$SourceContext[]; /** - * If provided, the input binary artifacts for the build came from this - * location. + * If provided, the input binary artifacts for the build came from this location. */ artifactStorageSourceUri?: string; /** @@ -1543,18 +1264,12 @@ export namespace containeranalysis_v1beta1 { */ context?: Schema$SourceContext; /** - * Hash(es) of the build source, which can be used to verify that the - * original source integrity was maintained in the build. The keys to this - * map are file paths used as build source and the values contain the hash - * values for those files. If the build source came in a single package - * such as a gzipped tarfile (.tar.gz), the FileHash will be for the single - * path to that file. + * Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes}; } /** - * A SourceContext is a reference to a tree of files. A SourceContext together - * with a path point to a unique revision of a single file or directory. + * A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. */ export interface Schema$SourceContext { /** @@ -1575,40 +1290,7 @@ export namespace containeranalysis_v1beta1 { labels?: {[key: string]: string}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1616,14 +1298,11 @@ export namespace containeranalysis_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1632,10 +1311,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1644,8 +1320,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1658,13 +1333,11 @@ export namespace containeranalysis_v1beta1 { */ epoch?: number; /** - * Required. Distinguishes between sentinel MIN/MAX versions and normal - * versions. + * Required. Distinguishes between sentinel MIN/MAX versions and normal versions. */ kind?: string; /** - * Required only when version kind is NORMAL. The main part of the version - * name. + * Required only when version kind is NORMAL. The main part of the version name. */ name?: string; /** @@ -1681,9 +1354,11 @@ export namespace containeranalysis_v1beta1 { */ cvssScore?: number; /** - * All information about the package to specifically identify this - * vulnerability. One entry per (version range and cpe_uri) the package - * vulnerability has manifested in. + * The full description of the CVSSv3. + */ + cvssV3?: Schema$CVSSv3; + /** + * All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in. */ details?: Schema$Detail[]; /** @@ -1691,10 +1366,7 @@ export namespace containeranalysis_v1beta1 { */ severity?: string; /** - * Windows details get their own format because the information format and - * model don't match a normal detail. Specifically Windows updates are - * done as patches, thus Windows vulnerabilities really are a missing - * package, rather than a package being at an incorrect version. + * Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. */ windowsDetails?: Schema$WindowsDetail[]; } @@ -1703,9 +1375,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$VulnerabilityLocation { /** - * Required. The CPE URI in [cpe - * format](https://cpe.mitre.org/specification/) format. Examples include - * distro or storage location for vulnerable jar. + * Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. */ cpeUri?: string; /** @@ -1718,8 +1388,7 @@ export namespace containeranalysis_v1beta1 { version?: Schema$Version; } /** - * A summary of how many vulnerability occurrences there are per resource and - * severity type. + * A summary of how many vulnerability occurrences there are per resource and severity type. */ export interface Schema$VulnerabilityOccurrencesSummary { /** @@ -1729,10 +1398,7 @@ export namespace containeranalysis_v1beta1 { } export interface Schema$WindowsDetail { /** - * Required. The CPE URI in [cpe - * format](https://cpe.mitre.org/specification/) in which the vulnerability - * manifests. Examples include distro or storage location for vulnerable - * jar. + * Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. */ cpeUri?: string; /** @@ -1740,10 +1406,7 @@ export namespace containeranalysis_v1beta1 { */ description?: string; /** - * Required. The names of the KBs which have hotfixes to mitigate this - * vulnerability. Note that there may be multiple hotfixes (and thus - * multiple KBs) that mitigate a given vulnerability. Currently any listed - * kb's presence is considered a fix. + * Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. */ fixingKbs?: Schema$KnowledgeBase[]; /** @@ -2070,12 +1733,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.notes.getIamPolicy - * @desc Gets the access control policy for a note or an occurrence - * resource. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a note or occurrence, respectively. The resource takes the format - * `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * @desc Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. * @alias containeranalysis.projects.notes.getIamPolicy * @memberOf! () * @@ -2299,12 +1957,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.notes.setIamPolicy - * @desc Sets the access control policy on the specified note or occurrence. - * Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a note or an occurrence, respectively. The resource takes the format - * `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * @desc Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. * @alias containeranalysis.projects.notes.setIamPolicy * @memberOf! () * @@ -2378,11 +2031,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.notes.testIamPermissions - * @desc Returns the permissions that a caller has on the specified note or - * occurrence. Requires list permission on the project (for example, - * `containeranalysis.notes.list`). The resource takes the format - * `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * @desc Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. * @alias containeranalysis.projects.notes.testIamPermissions * @memberOf! () * @@ -2472,8 +2121,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under - * which the notes are to be created. + * The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. */ parent?: string; @@ -2494,8 +2142,7 @@ export namespace containeranalysis_v1beta1 { */ noteId?: string; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under - * which the note is to be created. + * The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. */ parent?: string; @@ -2512,8 +2159,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; } @@ -2525,8 +2171,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; } @@ -2538,8 +2183,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2560,8 +2204,7 @@ export namespace containeranalysis_v1beta1 { */ filter?: string; /** - * Number of notes to return in the list. Must be positive. Max allowed page - * size is 1000. If not specified, page size defaults to 20. + * Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. */ pageSize?: number; /** @@ -2569,8 +2212,7 @@ export namespace containeranalysis_v1beta1 { */ pageToken?: string; /** - * The name of the project to list notes for in the form of - * `projects/[PROJECT_ID]`. + * The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -2582,8 +2224,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; /** @@ -2604,8 +2245,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2622,8 +2262,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2641,9 +2280,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.notes.occurrences.list - * @desc Lists occurrences referencing the specified note. Provider projects - * can use this method to get all occurrences across consumer projects - * referencing the specified note. + * @desc Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. * @alias containeranalysis.projects.notes.occurrences.list * @memberOf! () * @@ -2739,8 +2376,7 @@ export namespace containeranalysis_v1beta1 { */ filter?: string; /** - * The name of the note to list occurrences for in the form of - * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; /** @@ -2921,9 +2557,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.occurrences.delete - * @desc Deletes the specified occurrence. For example, use this method to - * delete an occurrence when the occurrence is no longer applicable for the - * given resource. + * @desc Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource. * @alias containeranalysis.projects.occurrences.delete * @memberOf! () * @@ -3065,12 +2699,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.occurrences.getIamPolicy - * @desc Gets the access control policy for a note or an occurrence - * resource. Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a note or occurrence, respectively. The resource takes the format - * `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * @desc Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. * @alias containeranalysis.projects.occurrences.getIamPolicy * @memberOf! () * @@ -3144,9 +2773,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.occurrences.getNotes - * @desc Gets the note attached to the specified occurrence. Consumer - * projects can use this method to get a note that belongs to a provider - * project. + * @desc Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project. * @alias containeranalysis.projects.occurrences.getNotes * @memberOf! () * @@ -3457,12 +3084,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.occurrences.setIamPolicy - * @desc Sets the access control policy on the specified note or occurrence. - * Requires `containeranalysis.notes.setIamPolicy` or - * `containeranalysis.occurrences.setIamPolicy` permission if the resource - * is a note or an occurrence, respectively. The resource takes the format - * `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * @desc Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. * @alias containeranalysis.projects.occurrences.setIamPolicy * @memberOf! () * @@ -3536,11 +3158,7 @@ export namespace containeranalysis_v1beta1 { /** * containeranalysis.projects.occurrences.testIamPermissions - * @desc Returns the permissions that a caller has on the specified note or - * occurrence. Requires list permission on the project (for example, - * `containeranalysis.notes.list`). The resource takes the format - * `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * @desc Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. * @alias containeranalysis.projects.occurrences.testIamPermissions * @memberOf! () * @@ -3630,8 +3248,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under - * which the occurrences are to be created. + * The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. */ parent?: string; @@ -3648,8 +3265,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under - * which the occurrence is to be created. + * The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. */ parent?: string; @@ -3666,8 +3282,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; } @@ -3679,8 +3294,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; } @@ -3692,8 +3306,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3710,8 +3323,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; } @@ -3727,8 +3339,7 @@ export namespace containeranalysis_v1beta1 { */ filter?: string; /** - * The name of the project to get a vulnerability summary for in the form of - * `projects/[PROJECT_ID]`. + * The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -3744,8 +3355,7 @@ export namespace containeranalysis_v1beta1 { */ filter?: string; /** - * Number of occurrences to return in the list. Must be positive. Max - * allowed page size is 1000. If not specified, page size defaults to 20. + * Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. */ pageSize?: number; /** @@ -3753,8 +3363,7 @@ export namespace containeranalysis_v1beta1 { */ pageToken?: string; /** - * The name of the project to list occurrences for in the form of - * `projects/[PROJECT_ID]`. + * The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -3766,8 +3375,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of - * `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; /** @@ -3788,8 +3396,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3806,8 +3413,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4057,8 +3663,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the scan configuration in the form of - * `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. + * The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. */ name?: string; } @@ -4082,8 +3687,7 @@ export namespace containeranalysis_v1beta1 { */ pageToken?: string; /** - * The name of the project to list scan configurations for in the form of - * `projects/[PROJECT_ID]`. + * The name of the project to list scan configurations for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -4095,8 +3699,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the scan configuration in the form of - * `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. + * The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. */ name?: string; diff --git a/src/apis/content/index.ts b/src/apis/content/index.ts index 37a65ff5ad6..bbc35b5bcb0 100644 --- a/src/apis/content/index.ts +++ b/src/apis/content/index.ts @@ -14,9 +14,8 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; - -import {content_v2} from './v2'; import {content_v2_1} from './v2.1'; +import {content_v2} from './v2'; export const VERSIONS = { 'v2.1': content_v2_1.Content, diff --git a/src/apis/content/package.json b/src/apis/content/package.json index ea6297c4c42..2c357bc12b6 100644 --- a/src/apis/content/package.json +++ b/src/apis/content/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 26da48e4005..843bb8a8858 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace content_v2_1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace content_v2_1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace content_v2_1 { /** * Content API for Shopping * - * Manages product items, inventory, and Merchant Center accounts for Google - * Shopping. + * Manages product items, inventory, and Merchant Center accounts for Google Shopping. * * @example * const {google} = require('googleapis'); @@ -110,7 +106,10 @@ export namespace content_v2_1 { shippingsettings: Resource$Shippingsettings; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.accountstatuses = new Resource$Accountstatuses(this.context); @@ -131,17 +130,11 @@ export namespace content_v2_1 { } /** - * Account data. After the creation of a new account it may take a few minutes - * before it is fully operational. The methods delete, insert, patch, and - * update require the admin role. + * Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role. */ export interface Schema$Account { /** - * List of linked Ads accounts that are active or pending approval. To - * create a new link request, add a new link with status active to the list. - * It will remain in a pending state until approved or rejected either in - * the Ads interface or through the AdWords API. To delete an active link, - * or to cancel a link request, remove it from the list. + * List of linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. */ adsLinks?: Schema$AccountAdsLink[]; /** @@ -153,8 +146,7 @@ export namespace content_v2_1 { */ businessInformation?: Schema$AccountBusinessInformation; /** - * The GMB account which is linked or in the process of being linked with - * the Merchant Center account. + * The GMB account which is linked or in the process of being linked with the Merchant Center account. */ googleMyBusinessLink?: Schema$AccountGoogleMyBusinessLink; /** @@ -162,8 +154,7 @@ export namespace content_v2_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#account". + * Identifies what kind of resource this is. Value: the fixed string "content#account". */ kind?: string; /** @@ -175,8 +166,7 @@ export namespace content_v2_1 { */ sellerId?: string; /** - * Users with access to the account. Every account (except for subaccounts) - * must have at least one admin user. + * Users with access to the account. Every account (except for subaccounts) must have at least one admin user. */ users?: Schema$AccountUser[]; /** @@ -184,11 +174,7 @@ export namespace content_v2_1 { */ websiteUrl?: string; /** - * List of linked YouTube channels that are active or pending approval. To - * create a new link request, add a new link with status active to the list. - * It will remain in a pending state until approved or rejected in the YT - * Creator Studio interface. To delete an active link, or to cancel a link - * request, remove it from the list. + * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. */ youtubeChannelLinks?: Schema$AccountYouTubeChannelLink[]; } @@ -198,8 +184,7 @@ export namespace content_v2_1 { */ country?: string; /** - * City, town or commune. May also include dependent localities or - * sublocalities (e.g. neighborhoods or suburbs). + * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ locality?: string; /** @@ -207,9 +192,7 @@ export namespace content_v2_1 { */ postalCode?: string; /** - * Top-level administrative subdivision of the country. For example, a state - * like California ("CA") or a province like Quebec - * ("QC"). + * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ region?: string; /** @@ -223,16 +206,7 @@ export namespace content_v2_1 { */ adsId?: string; /** - * Status of the link between this Merchant Center account and the Ads - * account. Upon retrieval, it represents the actual status of the link and - * can be either active if it was approved in Google Ads or pending if - * it's pending approval. Upon insertion, it represents the intended - * status of the link. Re-uploading a link with status active when it's - * still pending or with status pending when it's already active will - * have no effect: the status will remain unchanged. Re-uploading a link - * with deprecated status inactive is equivalent to not submitting the link - * at all and will delete the link if it was active or cancel the link - * request if it was pending. + * Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google Ads or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ status?: string; } @@ -266,21 +240,17 @@ export namespace content_v2_1 { } export interface Schema$AccountGoogleMyBusinessLink { /** - * The GMB email address of which a specific account within a GMB account. A - * sample account within a GMB account could be a business account with set - * of locations, managed under the GMB account. + * The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. */ gmbEmail?: string; /** - * Status of the link between this Merchant Center account and the GMB - * account. + * Status of the link between this Merchant Center account and the GMB account. */ status?: string; } export interface Schema$AccountIdentifier { /** - * The aggregator ID, set for aggregators and subaccounts (in that case, it - * represents the aggregator of the subaccount). + * The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount). */ aggregatorId?: string; /** @@ -290,22 +260,17 @@ export namespace content_v2_1 { } export interface Schema$AccountsAuthInfoResponse { /** - * The account identifiers corresponding to the authenticated user. - For an - * individual account: only the merchant ID is defined - For an aggregator: - * only the aggregator ID is defined - For a subaccount of an MCA: both the - * merchant ID and the aggregator ID are defined. + * The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. */ accountIdentifiers?: Schema$AccountIdentifier[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsAuthInfoResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse". */ kind?: string; } export interface Schema$AccountsClaimWebsiteResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsClaimWebsiteResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse". */ kind?: string; } @@ -320,8 +285,7 @@ export namespace content_v2_1 { */ export interface Schema$AccountsCustomBatchRequestEntry { /** - * The account to create or update. Only defined if the method is insert or - * update. + * The account to create or update. Only defined if the method is insert or update. */ account?: Schema$Account; /** @@ -333,8 +297,7 @@ export namespace content_v2_1 { */ batchId?: number; /** - * Whether the account should be deleted if the account has offers. Only - * applicable if the method is delete. + * Whether the account should be deleted if the account has offers. Only applicable if the method is delete. */ force?: boolean; /** @@ -350,15 +313,13 @@ export namespace content_v2_1 { */ method?: string; /** - * Only applicable if the method is claimwebsite. Indicates whether or not - * to take the claim from another account in case there is a conflict. + * Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict. */ overwrite?: boolean; } export interface Schema$AccountsCustomBatchRequestEntryLinkRequest { /** - * Action to perform for this link. The "request" action is only - * available to select merchants. + * Action to perform for this link. The "request" action is only available to select merchants. */ action?: string; /** @@ -376,8 +337,7 @@ export namespace content_v2_1 { */ entries?: Schema$AccountsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse". */ kind?: string; } @@ -386,8 +346,7 @@ export namespace content_v2_1 { */ export interface Schema$AccountsCustomBatchResponseEntry { /** - * The retrieved, created, or updated account. Not defined if the method was - * delete, claimwebsite or link. + * The retrieved, created, or updated account. Not defined if the method was delete, claimwebsite or link. */ account?: Schema$Account; /** @@ -399,15 +358,13 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry". */ kind?: string; } export interface Schema$AccountsLinkRequest { /** - * Action to perform for this link. The "request" action is only - * available to select merchants. + * Action to perform for this link. The "request" action is only available to select merchants. */ action?: string; /** @@ -421,15 +378,13 @@ export namespace content_v2_1 { } export interface Schema$AccountsLinkResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsLinkResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse". */ kind?: string; } export interface Schema$AccountsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse". */ kind?: string; /** @@ -439,8 +394,7 @@ export namespace content_v2_1 { resources?: Schema$Account[]; } /** - * The status of an account, i.e., information about its products, which is - * computed offline and not returned immediately at insertion time. + * The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. */ export interface Schema$AccountStatus { /** @@ -452,13 +406,11 @@ export namespace content_v2_1 { */ accountLevelIssues?: Schema$AccountStatusAccountLevelIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountStatus". + * Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". */ kind?: string; /** - * List of product-related data by channel, destination, and country. Data - * in this field may be delayed by up to 30 minutes. + * List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. */ products?: Schema$AccountStatusProducts[]; /** @@ -515,8 +467,7 @@ export namespace content_v2_1 { */ batchId?: number; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** @@ -534,8 +485,7 @@ export namespace content_v2_1 { */ entries?: Schema$AccountstatusesCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountstatusesCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse". */ kind?: string; } @@ -544,8 +494,7 @@ export namespace content_v2_1 { */ export interface Schema$AccountstatusesCustomBatchResponseEntry { /** - * The requested account status. Defined if and only if the request was - * successful. + * The requested account status. Defined if and only if the request was successful. */ accountStatus?: Schema$AccountStatus; /** @@ -559,8 +508,7 @@ export namespace content_v2_1 { } export interface Schema$AccountstatusesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountstatusesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse". */ kind?: string; /** @@ -652,13 +600,11 @@ export namespace content_v2_1 { */ accountId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountTax". + * Identifies what kind of resource this is. Value: the fixed string "content#accountTax". */ kind?: string; /** - * Tax rules. Updating the tax rules will enable US taxes (not reversible). - * Defining no rules is equivalent to not charging tax at all. + * Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all. */ rules?: Schema$AccountTaxTaxRule[]; } @@ -696,8 +642,7 @@ export namespace content_v2_1 { */ entries?: Schema$AccounttaxCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accounttaxCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse". */ kind?: string; } @@ -718,15 +663,13 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accounttaxCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry". */ kind?: string; } export interface Schema$AccounttaxListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accounttaxListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse". */ kind?: string; /** @@ -744,13 +687,11 @@ export namespace content_v2_1 { */ country?: string; /** - * State (or province) is which the tax is applicable, described by its - * location ID (also called criteria ID). + * State (or province) is which the tax is applicable, described by its location ID (also called criteria ID). */ locationId?: string; /** - * Explicit tax rate in percent, represented as a floating point number - * without the percentage character. Must not be negative. + * Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative. */ ratePercent?: string; /** @@ -758,8 +699,7 @@ export namespace content_v2_1 { */ shippingTaxed?: boolean; /** - * Whether the tax rate is taken from a global tax table or specified - * explicitly. + * Whether the tax rate is taken from a global tax table or specified explicitly. */ useGlobalRate?: boolean; } @@ -791,23 +731,13 @@ export namespace content_v2_1 { */ channelId?: string; /** - * Status of the link between this Merchant Center account and the YouTube - * channel. Upon retrieval, it represents the actual status of the link and - * can be either active if it was approved in YT Creator Studio or pending - * if it's pending approval. Upon insertion, it represents the intended - * status of the link. Re-uploading a link with status active when it's - * still pending or with status pending when it's already active will - * have no effect: the status will remain unchanged. Re-uploading a link - * with deprecated status inactive is equivalent to not submitting the link - * at all and will delete the link if it was active or cancel the link - * request if it was pending. + * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ status?: string; } export interface Schema$Amount { /** - * [required] The pre-tax or post-tax price depending on the location of the - * order. + * [required] The pre-tax or post-tax price depending on the location of the order. */ priceAmount?: Schema$Price; /** @@ -817,23 +747,15 @@ export namespace content_v2_1 { } export interface Schema$CarrierRate { /** - * Carrier service, such as "UPS" or "Fedex". The list - * of supported carriers can be retrieved via the getSupportedCarriers - * method. Required. + * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. */ carrierName?: string; /** - * Carrier service, such as "ground" or "2 days". The - * list of supported services for a carrier can be retrieved via the - * getSupportedCarriers method. Required. + * Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. */ carrierService?: string; /** - * Additive shipping rate modifier. Can be negative. For example { - * "value": "1", "currency" : "USD" - * } adds $1 to the rate, { "value": "-3", - * "currency" : "USD" } removes $3 from the rate. - * Optional. + * Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional. */ flatAdjustment?: Schema$Price; /** @@ -845,16 +767,13 @@ export namespace content_v2_1 { */ originPostalCode?: string; /** - * Multiplicative shipping rate modifier as a number in decimal notation. - * Can be negative. For example "5.4" increases the rate by 5.4%, - * "-3" decreases the rate by 3%. Optional. + * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional. */ percentageAdjustment?: string; } export interface Schema$CarriersCarrier { /** - * The CLDR country code of the carrier (e.g., "US"). Always - * present. + * The CLDR country code of the carrier (e.g., "US"). Always present. */ country?: string; /** @@ -862,20 +781,17 @@ export namespace content_v2_1 { */ name?: string; /** - * A list of supported services (e.g., "ground") for that carrier. - * Contains at least one service. + * A list of supported services (e.g., "ground") for that carrier. Contains at least one service. */ services?: string[]; } export interface Schema$CustomAttribute { /** - * Subattributes within this attribute group. Exactly one of value or - * groupValues must be provided. + * Subattributes within this attribute group. Exactly one of value or groupValues must be provided. */ groupValues?: Schema$CustomAttribute[]; /** - * The name of the attribute. Underscores will be replaced by spaces upon - * insertion. + * The name of the attribute. Underscores will be replaced by spaces upon insertion. */ name?: string; /** @@ -889,19 +805,15 @@ export namespace content_v2_1 { } export interface Schema$CutoffTime { /** - * Hour of the cutoff time until which an order has to be placed to be - * processed in the same day. Required. + * Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ hour?: number; /** - * Minute of the cutoff time until which an order has to be placed to be - * processed in the same day. Required. + * Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ minute?: number; /** - * Timezone identifier for the cutoff time. A list of identifiers can be - * found in the AdWords API documentation. E.g. "Europe/Zurich". - * Required. + * Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ timezone?: string; } @@ -910,13 +822,11 @@ export namespace content_v2_1 { */ export interface Schema$Datafeed { /** - * The two-letter ISO 639-1 language in which the attributes are defined in - * the data feed. + * The two-letter ISO 639-1 language in which the attributes are defined in the data feed. */ attributeLanguage?: string; /** - * The type of data feed. For product inventory feeds, only feeds for local - * stores, not online stores, are supported. + * The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. */ contentType?: string; /** @@ -936,8 +846,7 @@ export namespace content_v2_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeed". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeed". */ kind?: string; /** @@ -950,10 +859,7 @@ export namespace content_v2_1 { targets?: Schema$DatafeedTarget[]; } /** - * The required fields vary based on the frequency of fetching. For a monthly - * fetch schedule, day_of_month and hour are required. For a weekly fetch - * schedule, weekday and hour are required. For a daily fetch schedule, only - * hour is required. + * The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. */ export interface Schema$DatafeedFetchSchedule { /** @@ -961,10 +867,7 @@ export namespace content_v2_1 { */ dayOfMonth?: number; /** - * The URL where the feed file can be fetched. Google Merchant Center will - * support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP - * protocols, so the value will need to be a valid link using one of those - * four protocols. + * The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. */ fetchUrl?: string; /** @@ -984,8 +887,7 @@ export namespace content_v2_1 { */ paused?: boolean; /** - * Time zone used for schedule. UTC by default. E.g., - * "America/Los_Angeles". + * Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". */ timeZone?: string; /** @@ -999,19 +901,15 @@ export namespace content_v2_1 { } export interface Schema$DatafeedFormat { /** - * Delimiter for the separation of values in a delimiter-separated values - * feed. If not specified, the delimiter will be auto-detected. Ignored for - * non-DSV data feeds. + * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. */ columnDelimiter?: string; /** - * Character encoding scheme of the data feed. If not specified, the - * encoding will be auto-detected. + * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. */ fileEncoding?: string; /** - * Specifies how double quotes are interpreted. If not specified, the mode - * will be auto-detected. Ignored for non-DSV data feeds. + * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. */ quotingMode?: string; } @@ -1049,8 +947,7 @@ export namespace content_v2_1 { */ entries?: Schema$DatafeedsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse". */ kind?: string; } @@ -1063,8 +960,7 @@ export namespace content_v2_1 { */ batchId?: number; /** - * The requested data feed. Defined if and only if the request was - * successful. + * The requested data feed. Defined if and only if the request was successful. */ datafeed?: Schema$Datafeed; /** @@ -1074,15 +970,13 @@ export namespace content_v2_1 { } export interface Schema$DatafeedsFetchNowResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedsFetchNowResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse". */ kind?: string; } export interface Schema$DatafeedsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse". */ kind?: string; /** @@ -1092,13 +986,11 @@ export namespace content_v2_1 { resources?: Schema$Datafeed[]; } /** - * The status of a datafeed, i.e., the result of the last retrieval of the - * datafeed computed asynchronously when the feed processing is finished. + * The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. */ export interface Schema$DatafeedStatus { /** - * The country for which the status is reported, represented as a CLDR - * territory code. + * The country for which the status is reported, represented as a CLDR territory code. */ country?: string; /** @@ -1118,8 +1010,7 @@ export namespace content_v2_1 { */ itemsValid?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedStatus". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". */ kind?: string; /** @@ -1175,9 +1066,7 @@ export namespace content_v2_1 { */ batchId?: number; /** - * The country for which to get the datafeed status. If this parameter is - * provided then language must also be provided. Note that for multi-target - * datafeeds this parameter is required. + * The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required. */ country?: string; /** @@ -1185,9 +1074,7 @@ export namespace content_v2_1 { */ datafeedId?: string; /** - * The language for which to get the datafeed status. If this parameter is - * provided then country must also be provided. Note that for multi-target - * datafeeds this parameter is required. + * The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required. */ language?: string; /** @@ -1202,8 +1089,7 @@ export namespace content_v2_1 { */ entries?: Schema$DatafeedstatusesCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedstatusesCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse". */ kind?: string; } @@ -1216,8 +1102,7 @@ export namespace content_v2_1 { */ batchId?: number; /** - * The requested data feed status. Defined if and only if the request was - * successful. + * The requested data feed status. Defined if and only if the request was successful. */ datafeedStatus?: Schema$DatafeedStatus; /** @@ -1227,8 +1112,7 @@ export namespace content_v2_1 { } export interface Schema$DatafeedstatusesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedstatusesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse". */ kind?: string; /** @@ -1256,65 +1140,49 @@ export namespace content_v2_1 { } export interface Schema$DatafeedTarget { /** - * The country where the items in the feed will be included in the search - * index, represented as a CLDR territory code. + * The country where the items in the feed will be included in the search index, represented as a CLDR territory code. */ country?: string; /** - * The list of destinations to exclude for this target (corresponds to - * unchecked check boxes in Merchant Center). + * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). */ excludedDestinations?: string[]; /** - * The list of destinations to include for this target (corresponds to - * checked check boxes in Merchant Center). Default destinations are always - * included unless provided in the excluded_destination field. + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field. */ includedDestinations?: string[]; /** - * The two-letter ISO 639-1 language of the items in the feed. Must be a - * valid language for targets[].country. + * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. */ language?: string; } export interface Schema$DeliveryTime { /** - * Business days cutoff time definition. If not configured the cutoff time - * will be defaulted to 8AM PST. + * Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST. */ cutoffTime?: Schema$CutoffTime; /** - * Holiday cutoff definitions. If configured, they specify order cutoff - * times for holiday-specific shipping. + * Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping. */ holidayCutoffs?: Schema$HolidayCutoff[]; /** - * Maximum number of business days spent before an order is shipped. 0 means - * same day shipped, 1 means next day shipped. Must be greater than or equal - * to minHandlingTimeInDays. + * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays. */ maxHandlingTimeInDays?: number; /** - * Maximum number of business days that is spent in transit. 0 means same - * day delivery, 1 means next day delivery. Must be greater than or equal to - * minTransitTimeInDays. + * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. */ maxTransitTimeInDays?: number; /** - * Minimum number of business days spent before an order is shipped. 0 means - * same day shipped, 1 means next day shipped. + * Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. */ minHandlingTimeInDays?: number; /** - * Minimum number of business days that is spent in transit. 0 means same - * day delivery, 1 means next day delivery. Either - * {min,max}transitTimeInDays or transitTimeTable must be set, but not both. + * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both. */ minTransitTimeInDays?: number; /** - * Transit time table, number of business days spent in transit based on row - * and column dimensions. Either {min,max}transitTimeInDays or - * transitTimeTable can be set, but not both. + * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both. */ transitTimeTable?: Schema$TransitTable; } @@ -1381,71 +1249,41 @@ export namespace content_v2_1 { type?: string; } /** - * A non-empty list of row or column headers for a table. Exactly one of - * prices, weights, numItems, postalCodeGroupNames, or location must be set. + * A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. */ export interface Schema$Headers { /** - * A list of location ID sets. Must be non-empty. Can only be set if all - * other fields are not set. + * A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. */ locations?: Schema$LocationIdSet[]; /** - * A list of inclusive number of items upper bounds. The last value can be - * "infinity". For example ["10", "50", - * "infinity"] represents the headers "<= 10 items", - * " 50 items". Must be non-empty. Can only be set if all other - * fields are not set. + * A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. */ numberOfItems?: string[]; /** - * A list of postal group names. The last value can be "all other - * locations". Example: ["zone 1", "zone 2", - * "all other locations"]. The referred postal code groups must - * match the delivery country of the service. Must be non-empty. Can only be - * set if all other fields are not set. + * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. */ postalCodeGroupNames?: string[]; /** - * A list of inclusive order price upper bounds. The last price's value - * can be "infinity". For example [{"value": - * "10", "currency": "USD"}, - * {"value": "500", "currency": - * "USD"}, {"value": "infinity", - * "currency": "USD"}] represents the headers - * "<= $10", " $500". All prices within a service - * must have the same currency. Must be non-empty. Can only be set if all - * other fields are not set. + * A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. */ prices?: Schema$Price[]; /** - * A list of inclusive order weight upper bounds. The last weight's - * value can be "infinity". For example [{"value": - * "10", "unit": "kg"}, {"value": - * "50", "unit": "kg"}, {"value": - * "infinity", "unit": "kg"}] represents the - * headers "<= 10kg", " 50kg". All weights within a - * service must have the same unit. Must be non-empty. Can only be set if - * all other fields are not set. + * A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set. */ weights?: Schema$Weight[]; } export interface Schema$HolidayCutoff { /** - * Date of the order deadline, in ISO 8601 format. E.g. - * "2016-11-29" for 29th November 2016. Required. + * Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required. */ deadlineDate?: string; /** - * Hour of the day on the deadline date until which the order has to be - * placed to qualify for the delivery guarantee. Possible values are: 0 - * (midnight), 1, ..., 12 (noon), 13, ..., 23. Required. + * Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required. */ deadlineHour?: number; /** - * Timezone identifier for the deadline hour. A list of identifiers can be - * found in the AdWords API documentation. E.g. "Europe/Zurich". - * Required. + * Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ deadlineTimezone?: string; /** @@ -1453,40 +1291,29 @@ export namespace content_v2_1 { */ holidayId?: string; /** - * Date on which the deadline will become visible to consumers in ISO 8601 - * format. E.g. "2016-10-31" for 31st October 2016. Required. + * Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required. */ visibleFromDate?: string; } export interface Schema$HolidaysHoliday { /** - * The CLDR territory code of the country in which the holiday is available. - * E.g. "US", "DE", "GB". A holiday cutoff can - * only be configured in a shipping settings service with matching delivery - * country. Always present. + * The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present. */ countryCode?: string; /** - * Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for - * Christmas 2016. Always present. + * Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present. */ date?: string; /** - * Date on which the order has to arrive at the customer's, in ISO 8601 - * format. E.g. "2016-12-24" for 24th December 2016. Always - * present. + * Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present. */ deliveryGuaranteeDate?: string; /** - * Hour of the day in the delivery location's timezone on the guaranteed - * delivery date by which the order has to arrive at the customer's. - * Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always - * present. + * Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present. */ deliveryGuaranteeHour?: string; /** - * Unique identifier for the holiday to be used when configuring holiday - * cutoffs. Always present. + * Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present. */ id?: string; /** @@ -1603,13 +1430,11 @@ export namespace content_v2_1 { posExternalAccountId?: string; } /** - * Local Inventory ads (LIA) settings. All methods except listposdataproviders - * require the admin role. + * Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. */ export interface Schema$LiaSettings { /** - * The ID of the account to which these LIA settings belong. Ignored upon - * update, always present in get request responses. + * The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. */ accountId?: string; /** @@ -1617,8 +1442,7 @@ export namespace content_v2_1 { */ countrySettings?: Schema$LiaCountrySettings[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liaSettings". + * Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". */ kind?: string; } @@ -1638,13 +1462,11 @@ export namespace content_v2_1 { */ batchId?: number; /** - * Inventory validation contact email. Required only for - * SetInventoryValidationContact. + * Inventory validation contact email. Required only for SetInventoryValidationContact. */ contactEmail?: string; /** - * Inventory validation contact name. Required only for - * SetInventoryValidationContact. + * Inventory validation contact name. Required only for SetInventoryValidationContact. */ contactName?: string; /** @@ -1679,8 +1501,7 @@ export namespace content_v2_1 { */ entries?: Schema$LiasettingsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse". */ kind?: string; } @@ -1698,8 +1519,7 @@ export namespace content_v2_1 { */ gmbAccounts?: Schema$GmbAccounts; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry". */ kind?: string; /** @@ -1721,15 +1541,13 @@ export namespace content_v2_1 { */ gmbAccounts?: Schema$GmbAccountsGmbAccount[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsGetAccessibleGmbAccountsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse". */ kind?: string; } export interface Schema$LiasettingsListPosDataProvidersResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsListPosDataProvidersResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse". */ kind?: string; /** @@ -1739,8 +1557,7 @@ export namespace content_v2_1 { } export interface Schema$LiasettingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse". */ kind?: string; /** @@ -1751,43 +1568,37 @@ export namespace content_v2_1 { } export interface Schema$LiasettingsRequestGmbAccessResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsRequestGmbAccessResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse". */ kind?: string; } export interface Schema$LiasettingsRequestInventoryVerificationResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsRequestInventoryVerificationResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse". */ kind?: string; } export interface Schema$LiasettingsSetInventoryVerificationContactResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsSetInventoryVerificationContactResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse". */ kind?: string; } export interface Schema$LiasettingsSetPosDataProviderResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsSetPosDataProviderResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse". */ kind?: string; } export interface Schema$LocationIdSet { /** - * A non-empty list of location IDs. They must all be of the same location - * type (e.g., state). + * A non-empty list of location IDs. They must all be of the same location type (e.g., state). */ locationIds?: string[]; } export interface Schema$LoyaltyPoints { /** - * Name of loyalty points program. It is recommended to limit the name to 12 - * full-width characters or 24 Roman characters. + * Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. */ name?: string; /** @@ -1795,9 +1606,7 @@ export namespace content_v2_1 { */ pointsValue?: string; /** - * The ratio of a point when converted to currency. Google assumes currency - * based on Merchant Center settings. If ratio is left out, it defaults - * to 1.0. + * The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. */ ratio?: number; } @@ -1842,8 +1651,7 @@ export namespace content_v2_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#order". + * Identifies what kind of resource this is. Value: the fixed string "content#order". */ kind?: string; /** @@ -1856,15 +1664,11 @@ export namespace content_v2_1 { */ merchantOrderId?: string; /** - * The net amount for the order (price part). For example, if an order was - * originally for $100 and a refund was issued for $20, the net amount will - * be $80. + * The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80. */ netPriceAmount?: Schema$Price; /** - * The net amount for the order (tax part). Note that in certain cases due - * to taxable base adjustment netTaxAmount might not match to a sum of tax - * field across all lineItems and refunds. + * The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment netTaxAmount might not match to a sum of tax field across all lineItems and refunds. */ netTaxAmount?: Schema$Price; /** @@ -1910,9 +1714,7 @@ export namespace content_v2_1 { */ country?: string; /** - * Strings representing the lines of the printed label for mailing the - * order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, - * CA, 94043 United States + * Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States */ fullAddress?: string[]; /** @@ -1920,8 +1722,7 @@ export namespace content_v2_1 { */ isPostOfficeBox?: boolean; /** - * City, town or commune. May also include dependent localities or - * sublocalities (e.g. neighborhoods or suburbs). + * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ locality?: string; /** @@ -1933,9 +1734,7 @@ export namespace content_v2_1 { */ recipientName?: string; /** - * Top-level administrative subdivision of the country. For example, a state - * like California ("CA") or a province like Quebec - * ("QC"). + * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ region?: string; /** @@ -1957,10 +1756,7 @@ export namespace content_v2_1 { */ quantity?: number; /** - * The reason for the cancellation. Orders that are cancelled with a - * noInventory reason will lead to the removal of the product from Shopping - * Actions until you make an update to that product. This will not affect - * your Shopping ads. + * The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. */ reason?: string; /** @@ -1974,26 +1770,21 @@ export namespace content_v2_1 { */ fullName?: string; /** - * Customer's marketing preferences. + * Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order. */ marketingRightsInfo?: Schema$OrderCustomerMarketingRightsInfo; } export interface Schema$OrderCustomerMarketingRightsInfo { /** - * Last known user selection regarding marketing preferences. In certain - * cases this selection might not be known, so this field would be empty. + * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in. */ explicitMarketingPreference?: string; /** - * Timestamp when last time marketing preference was updated. Could be - * empty, if user wasn't offered a selection yet. + * Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. */ lastUpdatedTimestamp?: string; /** - * Email address that can be used for marketing purposes. The field may be - * empty even if explicitMarketingPreference is 'granted'. This - * happens when retrieving an old order from the customer who deleted their - * account. + * Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account. */ marketingEmailAddress?: string; } @@ -2021,14 +1812,11 @@ export namespace content_v2_1 { */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * [required] The ID of the operation, unique across all operations for a - * given order. + * [required] The ID of the operation, unique across all operations for a given order. */ operationId?: string; /** - * [required] ID of the shipment group. It is assigned by the merchant in - * the shipLineItems method and is used to group multiple line items that - * have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string; } @@ -2038,8 +1826,7 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderinvoicesCreateChargeInvoiceResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse". */ kind?: string; } @@ -2049,19 +1836,15 @@ export namespace content_v2_1 { */ invoiceId?: string; /** - * [required] The ID of the operation, unique across all operations for a - * given order. + * [required] The ID of the operation, unique across all operations for a given order. */ operationId?: string; /** - * Option to create a refund-only invoice. Exactly one of refundOnlyOption - * or returnOption must be provided. + * Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided. */ refundOnlyOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; /** - * Option to create an invoice for a refund and mark all items within the - * invoice as returned. Exactly one of refundOnlyOption or returnOption must - * be provided. + * Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of refundOnlyOption or returnOption must be provided. */ returnOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; /** @@ -2075,8 +1858,7 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderinvoicesCreateRefundInvoiceResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse". */ kind?: string; } @@ -2114,14 +1896,11 @@ export namespace content_v2_1 { */ id?: string; /** - * Total price for the line item. For example, if two items for $10 are - * purchased, the total price will be $20. + * Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20. */ price?: Schema$Price; /** - * Product data as seen by customer from the time of the order placement. - * Note that certain attributes values (e.g. title or gtin) might be - * reformatted and no longer match values submitted via product feed. + * Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed. */ product?: Schema$OrderLineItemProduct; /** @@ -2161,9 +1940,7 @@ export namespace content_v2_1 { */ shippingDetails?: Schema$OrderLineItemShippingDetails; /** - * Total tax amount for the line item. For example, if two items are - * purchased, and each have a cost tax of $2, the total tax amount will be - * $4. + * Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4. */ tax?: Schema$Price; } @@ -2225,9 +2002,7 @@ export namespace content_v2_1 { */ title?: string; /** - * Variant attributes for the item. These are dimensions of the product, - * such as color, gender, material, pattern, and size. You can find a - * comprehensive list of variant attributes here. + * Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here. */ variantAttributes?: Schema$OrderLineItemProductVariantAttribute[]; } @@ -2281,8 +2056,7 @@ export namespace content_v2_1 { } export interface Schema$OrderLineItemShippingDetailsMethod { /** - * The carrier for the shipping. Optional. See shipments[].carrier for a - * list of acceptable values. + * The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values. */ carrier?: string; /** @@ -2300,20 +2074,17 @@ export namespace content_v2_1 { } export interface Schema$OrderMerchantProvidedAnnotation { /** - * Key for additional merchant provided (as key-value pairs) annotation - * about the line item. + * Key for additional merchant provided (as key-value pairs) annotation about the line item. */ key?: string; /** - * Value for additional merchant provided (as key-value pairs) annotation - * about the line item. + * Value for additional merchant provided (as key-value pairs) annotation about the line item. */ value?: string; } export interface Schema$OrderPromotion { /** - * Items which this promotion may be applied to. If empty, there are no - * restrictions on applicable items and quantity. + * Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. */ applicableItems?: Schema$OrderPromotionItem[]; /** @@ -2325,13 +2096,11 @@ export namespace content_v2_1 { */ funder?: string; /** - * This field is used to identify promotions within merchants' own - * systems. + * This field is used to identify promotions within merchants' own systems. */ merchantPromotionId?: string; /** - * Estimated discount applied to price. Amount is pre-tax or post-tax - * depending on location of order. + * Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order. */ priceValue?: Schema$Price; /** @@ -2416,8 +2185,7 @@ export namespace content_v2_1 { */ disbursements?: Schema$OrderReportDisbursement[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderreportsListDisbursementsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse". */ kind?: string; /** @@ -2427,8 +2195,7 @@ export namespace content_v2_1 { } export interface Schema$OrderreportsListTransactionsResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderreportsListTransactionsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse". */ kind?: string; /** @@ -2502,8 +2269,7 @@ export namespace content_v2_1 { } export interface Schema$OrderreturnsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderreturnsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse". */ kind?: string; /** @@ -2524,22 +2290,19 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersAcknowledgeResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse". */ kind?: string; } export interface Schema$OrdersAdvanceTestOrderResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersAdvanceTestOrderResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse". */ kind?: string; } export interface Schema$OrdersCancelLineItemRequest { /** - * The ID of the line item to cancel. Either lineItemId or productId is - * required. + * The ID of the line item to cancel. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -2547,8 +2310,7 @@ export namespace content_v2_1 { */ operationId?: string; /** - * The ID of the product to cancel. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -2570,8 +2332,7 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse". */ kind?: string; } @@ -2595,8 +2356,7 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse". */ kind?: string; } @@ -2608,23 +2368,17 @@ export namespace content_v2_1 { } export interface Schema$OrdersCancelTestOrderByCustomerResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelTestOrderByCustomerResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse". */ kind?: string; } export interface Schema$OrdersCreateTestOrderRequest { /** - * The CLDR territory code of the country of the test order to create. - * Affects the currency and addresses of orders created via template_name, - * or the addresses of orders created via test_order. Acceptable values - * are: - "US" - "FR" Defaults to US. + * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order. Acceptable values are: - "US" - "FR" Defaults to US. */ country?: string; /** - * The test order template to use. Specify as an alternative to testOrder as - * a shortcut for retrieving a template and then creating an order using - * that template. + * The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. */ templateName?: string; /** @@ -2634,8 +2388,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersCreateTestOrderResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCreateTestOrderResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse". */ kind?: string; /** @@ -2651,8 +2404,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersCreateTestReturnResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCreateTestReturnResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse". */ kind?: string; /** @@ -2672,13 +2424,11 @@ export namespace content_v2_1 { } export interface Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { /** - * The carrier handling the shipment. See shipments[].carrier in the Orders - * resource representation for a list of acceptable values. + * The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ carrier?: string; /** - * The ID of the shipment. This is assigned by the merchant and is unique to - * each shipment. + * The ID of the shipment. This is assigned by the merchant and is unique to each shipment. */ shipmentId?: string; /** @@ -2688,8 +2438,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersGetByMerchantOrderIdResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersGetByMerchantOrderIdResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse". */ kind?: string; /** @@ -2699,8 +2448,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersGetTestOrderTemplateResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersGetTestOrderTemplateResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse". */ kind?: string; /** @@ -2710,14 +2458,7 @@ export namespace content_v2_1 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - - * "gsx" - "ups" - "usps" - - * "fedex" - "dhl" - "ecourier" - - * "cxt" - "google" - "ontrac" - - * "emsy" - "ont" - "deliv" - - * "dynamex" - "lasership" - "mpx" - - * "uds" Acceptable values for FR are: - - * "colissimo" - "chronopost" + * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" Acceptable values for FR are: - "colissimo" - "chronopost" */ carrier?: string; /** @@ -2725,8 +2466,7 @@ export namespace content_v2_1 { */ creationDate?: string; /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Present only if status is delivered + * Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered */ deliveryDate?: string; /** @@ -2748,13 +2488,11 @@ export namespace content_v2_1 { } export interface Schema$OrderShipmentLineItemShipment { /** - * The ID of the line item that is shipped. Either lineItemId or productId - * is required. + * The ID of the line item that is shipped. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to ship. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -2764,8 +2502,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersInStoreRefundLineItemRequest { /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -2773,13 +2510,11 @@ export namespace content_v2_1 { */ operationId?: string; /** - * The amount to be refunded. This may be pre-tax or post-tax depending on - * the location of the order. Required. + * The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required. */ priceAmount?: Schema$Price; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -2805,15 +2540,13 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersInStoreRefundLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse". */ kind?: string; } export interface Schema$OrdersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse". */ kind?: string; /** @@ -2824,8 +2557,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersRejectReturnLineItemRequest { /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -2833,8 +2565,7 @@ export namespace content_v2_1 { */ operationId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -2856,15 +2587,13 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersRejectReturnLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse". */ kind?: string; } export interface Schema$OrdersReturnRefundLineItemRequest { /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -2872,13 +2601,11 @@ export namespace content_v2_1 { */ operationId?: string; /** - * The amount to be refunded. This may be pre-tax or post-tax depending on - * the location of the order. If omitted, refundless return is assumed. + * The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed. */ priceAmount?: Schema$Price; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -2894,8 +2621,7 @@ export namespace content_v2_1 { */ reasonText?: string; /** - * The amount of tax to be refunded. Optional, but if filled, then - * priceAmount must be set. Calculated automatically if not provided. + * The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided. */ taxAmount?: Schema$Price; } @@ -2905,16 +2631,14 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersReturnRefundLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse". */ kind?: string; } export interface Schema$OrdersSetLineItemMetadataRequest { annotations?: Schema$OrderMerchantProvidedAnnotation[]; /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. + * The ID of the line item to set metadata. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -2922,8 +2646,7 @@ export namespace content_v2_1 { */ operationId?: string; /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. + * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; } @@ -2933,8 +2656,7 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersSetLineItemMetadataResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse". */ kind?: string; } @@ -2948,13 +2670,11 @@ export namespace content_v2_1 { */ operationId?: string; /** - * ID of the shipment group. Required for orders that use the orderinvoices - * service. + * ID of the shipment group. Required for orders that use the orderinvoices service. */ shipmentGroupId?: string; /** - * Shipment information. This field is repeated because a single line item - * can be shipped in several packages (and have several tracking IDs). + * Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs). */ shipmentInfos?: Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[]; } @@ -2964,21 +2684,17 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersShipLineItemsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse". */ kind?: string; } export interface Schema$OrdersUpdateLineItemShippingDetailsRequest { /** - * Updated delivery by date, in ISO 8601 format. If not specified only ship - * by date is updated. Provided date should be within 1 year timeframe and - * can not be a date in the past. + * Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ deliverByDate?: string; /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. + * The ID of the line item to set metadata. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -2986,14 +2702,11 @@ export namespace content_v2_1 { */ operationId?: string; /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. + * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** - * Updated ship by date, in ISO 8601 format. If not specified only deliver - * by date is updated. Provided date should be within 1 year timeframe and - * can not be a date in the past. + * Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ shipByDate?: string; } @@ -3003,15 +2716,13 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateLineItemShippingDetailsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse". */ kind?: string; } export interface Schema$OrdersUpdateMerchantOrderIdRequest { /** - * The merchant order id to be assigned to the order. Must be unique per - * merchant. + * The merchant order id to be assigned to the order. Must be unique per merchant. */ merchantOrderId?: string; /** @@ -3025,21 +2736,17 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateMerchantOrderIdResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse". */ kind?: string; } export interface Schema$OrdersUpdateShipmentRequest { /** - * The carrier handling the shipment. Not updated if missing. See - * shipments[].carrier in the Orders resource representation for a list of - * acceptable values. + * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ carrier?: string; /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Optional and can be provided only if status is delivered. + * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. */ deliveryDate?: string; /** @@ -3065,8 +2772,7 @@ export namespace content_v2_1 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateShipmentResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse". */ kind?: string; } @@ -3113,8 +2819,7 @@ export namespace content_v2_1 { */ entries?: Schema$PosCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse". */ kind?: string; } @@ -3132,8 +2837,7 @@ export namespace content_v2_1 { */ inventory?: Schema$PosInventory; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry". */ kind?: string; /** @@ -3186,8 +2890,7 @@ export namespace content_v2_1 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posInventory". + * Identifies what kind of resource this is. Value: the fixed string "content#posInventory". */ kind?: string; /** @@ -3199,8 +2902,7 @@ export namespace content_v2_1 { */ quantity?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -3234,8 +2936,7 @@ export namespace content_v2_1 { */ quantity?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -3261,8 +2962,7 @@ export namespace content_v2_1 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posInventoryResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse". */ kind?: string; /** @@ -3274,8 +2974,7 @@ export namespace content_v2_1 { */ quantity?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -3289,8 +2988,7 @@ export namespace content_v2_1 { } export interface Schema$PosListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posListResponse". */ kind?: string; resources?: Schema$PosStore[]; @@ -3312,8 +3010,7 @@ export namespace content_v2_1 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posSale". + * Identifies what kind of resource this is. Value: the fixed string "content#posSale". */ kind?: string; /** @@ -3321,8 +3018,7 @@ export namespace content_v2_1 { */ price?: Schema$Price; /** - * The relative change of the available quantity. Negative for items - * returned. + * The relative change of the available quantity. Negative for items returned. */ quantity?: string; /** @@ -3330,8 +3026,7 @@ export namespace content_v2_1 { */ saleId?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -3361,8 +3056,7 @@ export namespace content_v2_1 { */ price?: Schema$Price; /** - * The relative change of the available quantity. Negative for items - * returned. + * The relative change of the available quantity. Negative for items returned. */ quantity?: string; /** @@ -3370,8 +3064,7 @@ export namespace content_v2_1 { */ saleId?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -3397,8 +3090,7 @@ export namespace content_v2_1 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posSaleResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse". */ kind?: string; /** @@ -3406,8 +3098,7 @@ export namespace content_v2_1 { */ price?: Schema$Price; /** - * The relative change of the available quantity. Negative for items - * returned. + * The relative change of the available quantity. Negative for items returned. */ quantity?: string; /** @@ -3415,8 +3106,7 @@ export namespace content_v2_1 { */ saleId?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -3433,8 +3123,7 @@ export namespace content_v2_1 { */ export interface Schema$PosStore { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posStore". + * Identifies what kind of resource this is. Value: the fixed string "content#posStore". */ kind?: string; /** @@ -3448,8 +3137,7 @@ export namespace content_v2_1 { } export interface Schema$PostalCodeGroup { /** - * The CLDR territory code of the country the postal code group applies to. - * Required. + * The CLDR territory code of the country the postal code group applies to. Required. */ country?: string; /** @@ -3463,19 +3151,11 @@ export namespace content_v2_1 { } export interface Schema$PostalCodeRange { /** - * A postal code or a pattern of the form prefix* denoting the inclusive - * lower bound of the range defining the area. Examples values: - * "94108", "9410*", "9*". Required. + * A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required. */ postalCodeRangeBegin?: string; /** - * A postal code or a pattern of the form prefix* denoting the inclusive - * upper bound of the range defining the area. It must have the same length - * as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then - * postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is - * a pattern then postalCodeRangeEnd must be a pattern with the same prefix - * length. Optional: if not set, then the area is defined as being all the - * postal codes matching postalCodeRangeBegin. + * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. */ postalCodeRangeEnd?: string; } @@ -3490,8 +3170,7 @@ export namespace content_v2_1 { value?: string; } /** - * Product data. After inserting, updating, or deleting a product, it may take - * several minutes before changes take effect. + * Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. */ export interface Schema$Product { /** @@ -3499,8 +3178,7 @@ export namespace content_v2_1 { */ additionalImageLinks?: string[]; /** - * Used to group items in an arbitrary way. Only for CPA%, discouraged - * otherwise. + * Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. */ adsGrouping?: string; /** @@ -3508,8 +3186,7 @@ export namespace content_v2_1 { */ adsLabels?: string[]; /** - * Allows advertisers to override the item URL when the product is shown - * within the context of Product Ads. + * Allows advertisers to override the item URL when the product is shown within the context of Product Ads. */ adsRedirect?: string; /** @@ -3525,8 +3202,7 @@ export namespace content_v2_1 { */ availability?: string; /** - * The day a pre-ordered product becomes available for delivery, in ISO 8601 - * format. + * The day a pre-ordered product becomes available for delivery, in ISO 8601 format. */ availabilityDate?: string; /** @@ -3554,11 +3230,7 @@ export namespace content_v2_1 { */ costOfGoodsSold?: Schema$Price; /** - * A list of custom (merchant-provided) attributes. It can also be used for - * submitting any attribute of the feed specification in its generic form - * (e.g., { "name": "size type", "value": - * "regular" }). This is useful for submitting attributes not - * explicitly exposed by the API. + * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. */ customAttributes?: Schema$CustomAttribute[]; /** @@ -3590,8 +3262,7 @@ export namespace content_v2_1 { */ displayAdsId?: string; /** - * URL directly to your item's landing page for dynamic remarketing - * campaigns. + * URL directly to your item's landing page for dynamic remarketing campaigns. */ displayAdsLink?: string; /** @@ -3611,15 +3282,11 @@ export namespace content_v2_1 { */ energyEfficiencyClass?: string; /** - * The list of destinations to exclude for this target (corresponds to - * unchecked check boxes in Merchant Center). + * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). */ excludedDestinations?: string[]; /** - * Date on which the item should expire, as specified upon insertion, in ISO - * 8601 format. The actual expiration date in Google Shopping is exposed in - * productstatuses as googleExpirationDate and might be earlier if - * expirationDate is too far in the future. + * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. */ expirationDate?: string; /** @@ -3635,16 +3302,11 @@ export namespace content_v2_1 { */ gtin?: string; /** - * The REST ID of the product. Content API methods that operate on products - * take this as their productId parameter. The REST ID for a product is of - * the form channel:contentLanguage:targetCountry:offerId. + * The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. */ id?: string; /** - * False when the item does not have unique product identifiers appropriate - * to its category, such as GTIN, MPN, and brand. Required according to the - * Unique Product Identifier Rules for all target countries except for - * Canada. + * False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada. */ identifierExists?: boolean; /** @@ -3652,9 +3314,7 @@ export namespace content_v2_1 { */ imageLink?: string; /** - * The list of destinations to include for this target (corresponds to - * checked check boxes in Merchant Center). Default destinations are always - * included unless provided in the excluded_destination field. + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field. */ includedDestinations?: string[]; /** @@ -3662,8 +3322,7 @@ export namespace content_v2_1 { */ installment?: Schema$Installment; /** - * Whether the item is a merchant-defined bundle. A bundle is a custom - * grouping of different products sold by a merchant for a single price. + * Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. */ isBundle?: boolean; /** @@ -3671,8 +3330,7 @@ export namespace content_v2_1 { */ itemGroupId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#product". + * Identifies what kind of resource this is. Value: the fixed string "content#product". */ kind?: string; /** @@ -3716,11 +3374,7 @@ export namespace content_v2_1 { */ multipack?: string; /** - * A unique identifier for the item. Leading and trailing whitespaces are - * stripped and multiple whitespaces are replaced by a single whitespace - * upon submission. Only valid unicode characters are accepted. See the - * products feed specification for details. Note: Content API methods that - * operate on products take the REST ID of the product, not this identifier. + * A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. Note: Content API methods that operate on products take the REST ID of the product, not this identifier. */ offerId?: string; /** @@ -3732,7 +3386,7 @@ export namespace content_v2_1 { */ price?: Schema$Price; /** - * Categories of the item (formatted as in products feed specification). + * Categories of the item (formatted as in products data specification). */ productTypes?: string[]; /** @@ -3744,13 +3398,11 @@ export namespace content_v2_1 { */ salePrice?: Schema$Price; /** - * Date range during which the item is on sale (see products feed - * specification). + * Date range during which the item is on sale (see products data specification). */ salePriceEffectiveDate?: string; /** - * The quantity of the product that is available for selling on Google. - * Supported only for online products. + * The quantity of the product that is available for selling on Google. Supported only for online products. */ sellOnGoogleQuantity?: string; /** @@ -3762,8 +3414,7 @@ export namespace content_v2_1 { */ shippingHeight?: Schema$ProductShippingDimension; /** - * The shipping label of the product, used to group product in account-level - * shipping rules. + * The shipping label of the product, used to group product in account-level shipping rules. */ shippingLabel?: string; /** @@ -3798,6 +3449,10 @@ export namespace content_v2_1 { * The CLDR territory code for the item. */ targetCountry?: string; + /** + * The tax category of the product, used to configure detailed tax nexus in account-level tax settings. + */ + taxCategory?: string; /** * Tax information. */ @@ -3806,6 +3461,10 @@ export namespace content_v2_1 { * Title of the item. */ title?: string; + /** + * The transit time label of the product, used to group product in account-level transit time tables. + */ + transitTimeLabel?: string; /** * The preference of the denominator of the unit price. */ @@ -3853,8 +3512,7 @@ export namespace content_v2_1 { */ product?: Schema$Product; /** - * The ID of the product to get or delete. Only defined if the method is get - * or delete. + * The ID of the product to get or delete. Only defined if the method is get or delete. */ productId?: string; } @@ -3864,8 +3522,7 @@ export namespace content_v2_1 { */ entries?: Schema$ProductsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse". */ kind?: string; } @@ -3882,13 +3539,11 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry". */ kind?: string; /** - * The inserted product. Only defined if the method is insert and if the - * request was successful. + * The inserted product. Only defined if the method is insert and if the request was successful. */ product?: Schema$Product; } @@ -3898,19 +3553,15 @@ export namespace content_v2_1 { */ country?: string; /** - * The location where the shipping is applicable, represented by a location - * group name. + * The location where the shipping is applicable, represented by a location group name. */ locationGroupName?: string; /** - * The numeric ID of a location that the shipping rate applies to as defined - * in the AdWords API. + * The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. */ locationId?: string; /** - * The postal code range that the shipping rate applies to, represented by a - * postal code, a postal code prefix followed by a * wildcard, a range - * between two postal codes or two postal code prefixes of equal length. + * The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length. */ postalCode?: string; /** @@ -3932,8 +3583,7 @@ export namespace content_v2_1 { */ unit?: string; /** - * The dimension of the product used to calculate the shipping cost of the - * item. + * The dimension of the product used to calculate the shipping cost of the item. */ value?: number; } @@ -3943,15 +3593,13 @@ export namespace content_v2_1 { */ unit?: string; /** - * The weight of the product used to calculate the shipping cost of the - * item. + * The weight of the product used to calculate the shipping cost of the item. */ value?: number; } export interface Schema$ProductsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse". */ kind?: string; /** @@ -3961,8 +3609,7 @@ export namespace content_v2_1 { resources?: Schema$Product[]; } /** - * The status of a product, i.e., information about a product computed - * asynchronously. + * The status of a product, i.e., information about a product computed asynchronously. */ export interface Schema$ProductStatus { /** @@ -3982,8 +3629,7 @@ export namespace content_v2_1 { */ itemLevelIssues?: Schema$ProductStatusItemLevelIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productStatus". + * Identifies what kind of resource this is. Value: the fixed string "content#productStatus". */ kind?: string; /** @@ -4025,8 +3671,7 @@ export namespace content_v2_1 { */ batchId?: number; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; includeAttributes?: boolean; @@ -4046,8 +3691,7 @@ export namespace content_v2_1 { */ entries?: Schema$ProductstatusesCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productstatusesCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse". */ kind?: string; } @@ -4064,8 +3708,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productstatusesCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry". */ kind?: string; /** @@ -4075,8 +3718,7 @@ export namespace content_v2_1 { } export interface Schema$ProductstatusesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productstatusesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse". */ kind?: string; /** @@ -4121,20 +3763,15 @@ export namespace content_v2_1 { } export interface Schema$ProductTax { /** - * The country within which the item is taxed, specified as a CLDR territory - * code. + * The country within which the item is taxed, specified as a CLDR territory code. */ country?: string; /** - * The numeric ID of a location that the tax rate applies to as defined in - * the AdWords API. + * The numeric ID of a location that the tax rate applies to as defined in the AdWords API. */ locationId?: string; /** - * The postal code range that the tax rate applies to, represented by a ZIP - * code, a ZIP code prefix using * wildcard, a range between two ZIP codes - * or two ZIP code prefixes of equal length. Examples: 94114, 94*, - * 94002-95460, 94*-95*. + * The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*. */ postalCode?: string; /** @@ -4172,35 +3809,27 @@ export namespace content_v2_1 { } export interface Schema$RateGroup { /** - * A list of shipping labels defining the products to which this rate group - * applies to. This is a disjunction: only one of the labels has to match - * for the rate group to apply. May only be empty for the last rate group of - * a service. Required. + * A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required. */ applicableShippingLabels?: string[]; /** - * A list of carrier rates that can be referred to by mainTable or - * singleValue. + * A list of carrier rates that can be referred to by mainTable or singleValue. */ carrierRates?: Schema$CarrierRate[]; /** - * A table defining the rate group, when singleValue is not expressive - * enough. Can only be set if singleValue is not set. + * A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set. */ mainTable?: Schema$Table; /** - * Name of the rate group. Optional. If set has to be unique within shipping - * service. + * Name of the rate group. Optional. If set has to be unique within shipping service. */ name?: string; /** - * The value of the rate group (e.g. flat rate $10). Can only be set if - * mainTable and subtables are not set. + * The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set. */ singleValue?: Schema$Value; /** - * A list of subtables referred to by mainTable. Can only be set if - * mainTable is set. + * A list of subtables referred to by mainTable. Can only be set if mainTable is set. */ subtables?: Schema$Table[]; } @@ -4209,8 +3838,7 @@ export namespace content_v2_1 { reasonCode?: string; } /** - * Regional inventory resource. contains the regional name and all attributes - * which are overridden for the specified region. + * Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region. */ export interface Schema$RegionalInventory { /** @@ -4218,13 +3846,11 @@ export namespace content_v2_1 { */ availability?: string; /** - * A list of custom (merchant-provided) attributes. It can also be used for - * submitting any attribute of the feed specification in its generic form. + * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form. */ customAttributes?: Schema$CustomAttribute[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#regionalInventory". + * Identifies what kind of resource this is. Value: the fixed string "content#regionalInventory". */ kind?: string; /** @@ -4236,14 +3862,11 @@ export namespace content_v2_1 { */ regionId?: string; /** - * The sale price of the product. Mandatory if sale_price_effective_date is - * defined. + * The sale price of the product. Mandatory if sale_price_effective_date is defined. */ salePrice?: Schema$Price; /** - * A date range represented by a pair of ISO 8601 dates separated by a - * space, comma, or slash. Both dates might be specified as 'null' - * if undecided. + * A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. */ salePriceEffectiveDate?: string; } @@ -4281,8 +3904,7 @@ export namespace content_v2_1 { */ entries?: Schema$RegionalinventoryCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#regionalinventoryCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponse". */ kind?: string; } @@ -4299,8 +3921,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#regionalinventoryCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponseEntry". */ kind?: string; /** @@ -4319,9 +3940,7 @@ export namespace content_v2_1 { } export interface Schema$Row { /** - * The list of cells that constitute the row. Must have the same length as - * columnHeaders for two-dimensional tables, a length of 1 for - * one-dimensional tables. Required. + * The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required. */ cells?: Schema$Value[]; } @@ -4331,18 +3950,15 @@ export namespace content_v2_1 { */ active?: boolean; /** - * The CLDR code of the currency to which this service applies. Must match - * that of the prices in rate groups. + * The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. */ currency?: string; /** - * The CLDR territory code of the country to which the service applies. - * Required. + * The CLDR territory code of the country to which the service applies. Required. */ deliveryCountry?: string; /** - * Time spent in various aspects from order to the delivery of the product. - * Required. + * Time spent in various aspects from order to the delivery of the product. Required. */ deliveryTime?: Schema$DeliveryTime; /** @@ -4350,20 +3966,15 @@ export namespace content_v2_1 { */ eligibility?: string; /** - * Minimum order value for this service. If set, indicates that customers - * will have to spend at least this amount. All prices within a service must - * have the same currency. + * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. */ minimumOrderValue?: Schema$Price; /** - * Free-form name of the service. Must be unique within target account. - * Required. + * Free-form name of the service. Must be unique within target account. Required. */ name?: string; /** - * Shipping rate group definitions. Only the last one is allowed to have an - * empty applicableShippingLabels, which means "everything else". - * The other applicableShippingLabels must not overlap. + * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. */ rateGroups?: Schema$RateGroup[]; } @@ -4377,9 +3988,7 @@ export namespace content_v2_1 { */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * [required] ID of the shipment group. It is assigned by the merchant in - * the shipLineItems method and is used to group multiple line items that - * have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string; } @@ -4389,15 +3998,11 @@ export namespace content_v2_1 { */ lineItemId?: string; /** - * ID of the product. This is the REST ID used in the products service. - * Either lineItemId or productId must be set. + * ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set. */ productId?: string; /** - * [required] The shipment unit ID is assigned by the merchant and defines - * individual quantities within a line item. The same ID can be assigned to - * units that are the same while units that differ must be assigned a - * different ID (for example: free or promotional units). + * [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units). */ shipmentUnitIds?: string[]; /** @@ -4410,18 +4015,15 @@ export namespace content_v2_1 { trackingNumber?: string; } /** - * The merchant account's shipping settings. All methods except - * getsupportedcarriers and getsupportedholidays require the admin role. + * The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. */ export interface Schema$ShippingSettings { /** - * The ID of the account to which these account shipping settings belong. - * Ignored upon update, always present in get request responses. + * The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses. */ accountId?: string; /** - * A list of postal code groups that can be referred to in services. - * Optional. + * A list of postal code groups that can be referred to in services. Optional. */ postalCodeGroups?: Schema$PostalCodeGroup[]; /** @@ -4453,8 +4055,7 @@ export namespace content_v2_1 { merchantId?: string; method?: string; /** - * The account shipping settings to update. Only defined if the method is - * update. + * The account shipping settings to update. Only defined if the method is update. */ shippingSettings?: Schema$ShippingSettings; } @@ -4464,8 +4065,7 @@ export namespace content_v2_1 { */ entries?: Schema$ShippingsettingsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse". */ kind?: string; } @@ -4482,8 +4082,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry". */ kind?: string; /** @@ -4497,8 +4096,7 @@ export namespace content_v2_1 { */ carriers?: Schema$CarriersCarrier[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsGetSupportedCarriersResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse". */ kind?: string; } @@ -4508,15 +4106,13 @@ export namespace content_v2_1 { */ holidays?: Schema$HolidaysHoliday[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsGetSupportedHolidaysResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse". */ kind?: string; } export interface Schema$ShippingsettingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse". */ kind?: string; /** @@ -4527,8 +4123,7 @@ export namespace content_v2_1 { } export interface Schema$Table { /** - * Headers of the table's columns. Optional: if not set then the table - * has only one dimension. + * Headers of the table's columns. Optional: if not set then the table has only one dimension. */ columnHeaders?: Schema$Headers; /** @@ -4540,8 +4135,7 @@ export namespace content_v2_1 { */ rowHeaders?: Schema$Headers; /** - * The list of rows that constitute the table. Must have the same length as - * rowHeaders. Required. + * The list of rows that constitute the table. Must have the same length as rowHeaders. Required. */ rows?: Schema$Row[]; } @@ -4551,8 +4145,7 @@ export namespace content_v2_1 { */ enableOrderinvoices?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#testOrder". + * Identifies what kind of resource this is. Value: the fixed string "content#testOrder". */ kind?: string; /** @@ -4560,8 +4153,7 @@ export namespace content_v2_1 { */ lineItems?: Schema$TestOrderLineItem[]; /** - * Determines if test order must be pulled by merchant or pushed to merchant - * via push integration. + * Determines if test order must be pulled by merchant or pushed to merchant via push integration. */ notificationMode?: string; /** @@ -4581,9 +4173,7 @@ export namespace content_v2_1 { */ promotions?: Schema$OrderPromotion[]; /** - * The price of shipping for all items. Shipping tax is automatically - * calculated for MFL orders. For non-MFL orders, tax settings from Merchant - * Center are applied. Note that shipping is not taxed in certain states. + * The price of shipping for all items. Shipping tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states. */ shippingCost?: Schema$Price; /** @@ -4643,9 +4233,7 @@ export namespace content_v2_1 { */ offerId?: string; /** - * The price for the product. Tax is automatically calculated for MFL - * orders. For non-MFL orders, tax settings from Merchant Center are - * applied. + * The price for the product. Tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied. */ price?: Schema$Price; /** @@ -4663,17 +4251,12 @@ export namespace content_v2_1 { } export interface Schema$TransitTable { /** - * A list of postal group names. The last value can be "all other - * locations". Example: ["zone 1", "zone 2", - * "all other locations"]. The referred postal code groups must - * match the delivery country of the service. + * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. */ postalCodeGroupNames?: string[]; rows?: Schema$TransitTableTransitTimeRow[]; /** - * A list of transit time labels. The last value can be "all other - * labels". Example: ["food", "electronics", - * "all other labels"]. + * A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"]. */ transitTimeLabels?: string[]; } @@ -4686,8 +4269,7 @@ export namespace content_v2_1 { */ maxTransitTimeInDays?: number; /** - * Transit time range (min-max) in business days. 0 means same day delivery, - * 1 means next day delivery. + * Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery. */ minTransitTimeInDays?: number; } @@ -4697,8 +4279,7 @@ export namespace content_v2_1 { */ additionalCharges?: Schema$UnitInvoiceAdditionalCharge[]; /** - * [required] Pre-tax or post-tax price of the unit depending on the - * locality of the order. + * [required] Pre-tax or post-tax price of the unit depending on the locality of the order. */ unitPrice?: Schema$Price; /** @@ -4722,8 +4303,7 @@ export namespace content_v2_1 { */ taxAmount?: Schema$Price; /** - * Optional name of the tax type. This should only be provided if taxType is - * otherFeeTax. + * Optional name of the tax type. This should only be provided if taxType is otherFeeTax. */ taxName?: string; /** @@ -4732,14 +4312,11 @@ export namespace content_v2_1 { taxType?: string; } /** - * The single value of a rate group or the value of a rate group table's - * cell. Exactly one of noShipping, flatRate, pricePercentage, - * carrierRateName, subtableName must be set. + * The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. */ export interface Schema$Value { /** - * The name of a carrier rate referring to a carrier rate defined in the - * same rate group. Can only be set if all other fields are not set. + * The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. */ carrierRateName?: string; /** @@ -4747,18 +4324,15 @@ export namespace content_v2_1 { */ flatRate?: Schema$Price; /** - * If true, then the product can't ship. Must be true when set, can only - * be set if all other fields are not set. + * If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set. */ noShipping?: boolean; /** - * A percentage of the price represented as a number in decimal notation - * (e.g., "5.4"). Can only be set if all other fields are not set. + * A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set. */ pricePercentage?: string; /** - * The name of a subtable. Can only be set in table cells (i.e., not for - * single values), and only if all other fields are not set. + * The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set. */ subtableName?: string; } @@ -4943,8 +4517,7 @@ export namespace content_v2_1 { /** * content.accounts.custombatch - * @desc Retrieves, inserts, updates, and deletes multiple Merchant Center - * (sub-)accounts in a single request. + * @desc Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. * @alias content.accounts.custombatch * @memberOf! () * @@ -5240,8 +4813,7 @@ export namespace content_v2_1 { /** * content.accounts.link - * @desc Performs an action on a link between a Merchant Center account and - * another account. + * @desc Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId. * @alias content.accounts.link * @memberOf! () * @@ -5484,15 +5056,11 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; /** - * Only available to selected merchants. When set to True, this flag removes - * any existing claim on the requested website by another account and - * replaces it with a claim from this account. + * Only available to selected merchants. When set to True, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account. */ overwrite?: boolean; } @@ -5523,8 +5091,7 @@ export namespace content_v2_1 { */ force?: boolean; /** - * The ID of the managing account. This must be a multi-client account, and - * accountId must be the ID of a sub-account of this account. + * The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -5539,9 +5106,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -5572,9 +5137,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -5590,8 +5153,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of accounts to return in the response, used for - * paging. + * The maximum number of accounts to return in the response, used for paging. */ maxResults?: number; /** @@ -5614,9 +5176,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -5634,8 +5194,7 @@ export namespace content_v2_1 { /** * content.accountstatuses.custombatch - * @desc Retrieves multiple Merchant Center account statuses in a single - * request. + * @desc Retrieves multiple Merchant Center account statuses in a single request. * @alias content.accountstatuses.custombatch * @memberOf! () * @@ -5718,8 +5277,7 @@ export namespace content_v2_1 { /** * content.accountstatuses.get - * @desc Retrieves the status of a Merchant Center account. No - * itemLevelIssues are returned for multi-client accounts. + * @desc Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. * @alias content.accountstatuses.get * @memberOf! () * @@ -5794,8 +5352,7 @@ export namespace content_v2_1 { /** * content.accountstatuses.list - * @desc Lists the statuses of the sub-accounts in your Merchant Center - * account. + * @desc Lists the statuses of the sub-accounts in your Merchant Center account. * @alias content.accountstatuses.list * @memberOf! () * @@ -5901,14 +5458,11 @@ export namespace content_v2_1 { */ accountId?: string; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -5920,13 +5474,11 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * The maximum number of account statuses to return in the response, used - * for paging. + * The maximum number of account statuses to return in the response, used for paging. */ maxResults?: number; /** @@ -5947,8 +5499,7 @@ export namespace content_v2_1 { /** * content.accounttax.custombatch - * @desc Retrieves and updates tax settings of multiple accounts in a single - * request. + * @desc Retrieves and updates tax settings of multiple accounts in a single request. * @alias content.accounttax.custombatch * @memberOf! () * @@ -6104,8 +5655,7 @@ export namespace content_v2_1 { /** * content.accounttax.list - * @desc Lists the tax settings of the sub-accounts in your Merchant Center - * account. + * @desc Lists the tax settings of the sub-accounts in your Merchant Center account. * @alias content.accounttax.list * @memberOf! () * @@ -6279,9 +5829,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -6292,8 +5840,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of tax settings to return in the response, used for - * paging. + * The maximum number of tax settings to return in the response, used for paging. */ maxResults?: number; /** @@ -6317,9 +5864,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -6337,8 +5882,7 @@ export namespace content_v2_1 { /** * content.datafeeds.custombatch - * @desc Deletes, fetches, gets, inserts and updates multiple datafeeds in a - * single request. + * @desc Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request. * @alias content.datafeeds.custombatch * @memberOf! () * @@ -6574,8 +6118,7 @@ export namespace content_v2_1 { /** * content.datafeeds.get - * @desc Retrieves a datafeed configuration from your Merchant Center - * account. + * @desc Retrieves a datafeed configuration from your Merchant Center account. * @alias content.datafeeds.get * @memberOf! () * @@ -6646,8 +6189,7 @@ export namespace content_v2_1 { /** * content.datafeeds.insert - * @desc Registers a datafeed configuration with your Merchant Center - * account. + * @desc Registers a datafeed configuration with your Merchant Center account. * @alias content.datafeeds.insert * @memberOf! () * @@ -6719,8 +6261,7 @@ export namespace content_v2_1 { /** * content.datafeeds.list - * @desc Lists the configurations for datafeeds in your Merchant Center - * account. + * @desc Lists the configurations for datafeeds in your Merchant Center account. * @alias content.datafeeds.list * @memberOf! () * @@ -6891,8 +6432,7 @@ export namespace content_v2_1 { */ datafeedId?: string; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -6908,8 +6448,7 @@ export namespace content_v2_1 { */ datafeedId?: string; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -6924,8 +6463,7 @@ export namespace content_v2_1 { */ datafeedId?: string; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -6936,8 +6474,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; @@ -6953,13 +6490,11 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of products to return in the response, used for - * paging. + * The maximum number of products to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the datafeeds. This account cannot be - * a multi-client account. + * The ID of the account that manages the datafeeds. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -6978,8 +6513,7 @@ export namespace content_v2_1 { */ datafeedId?: string; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; @@ -6997,8 +6531,7 @@ export namespace content_v2_1 { /** * content.datafeedstatuses.custombatch - * @desc Gets multiple Merchant Center datafeed statuses in a single - * request. + * @desc Gets multiple Merchant Center datafeed statuses in a single request. * @alias content.datafeedstatuses.custombatch * @memberOf! () * @@ -7083,8 +6616,7 @@ export namespace content_v2_1 { /** * content.datafeedstatuses.get - * @desc Retrieves the status of a datafeed from your Merchant Center - * account. + * @desc Retrieves the status of a datafeed from your Merchant Center account. * @alias content.datafeedstatuses.get * @memberOf! () * @@ -7161,8 +6693,7 @@ export namespace content_v2_1 { /** * content.datafeedstatuses.list - * @desc Lists the statuses of the datafeeds in your Merchant Center - * account. + * @desc Lists the statuses of the datafeeds in your Merchant Center account. * @alias content.datafeedstatuses.list * @memberOf! () * @@ -7265,10 +6796,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The country for which to get the datafeed status. If this parameter is - * provided then language must also be provided. Note that this parameter is - * required for feeds targeting multiple countries and languages, since a - * feed may have a different status for each target. + * The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target. */ country?: string; /** @@ -7276,15 +6804,11 @@ export namespace content_v2_1 { */ datafeedId?: string; /** - * The language for which to get the datafeed status. If this parameter is - * provided then country must also be provided. Note that this parameter is - * required for feeds targeting multiple countries and languages, since a - * feed may have a different status for each target. + * The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target. */ language?: string; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -7296,13 +6820,11 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of products to return in the response, used for - * paging. + * The maximum number of products to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the datafeeds. This account cannot be - * a multi-client account. + * The ID of the account that manages the datafeeds. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -7319,8 +6841,7 @@ export namespace content_v2_1 { /** * content.liasettings.custombatch - * @desc Retrieves and/or updates the LIA settings of multiple accounts in a - * single request. + * @desc Retrieves and/or updates the LIA settings of multiple accounts in a single request. * @alias content.liasettings.custombatch * @memberOf! () * @@ -7576,8 +7097,7 @@ export namespace content_v2_1 { /** * content.liasettings.list - * @desc Lists the LIA settings of the sub-accounts in your Merchant Center - * account. + * @desc Lists the LIA settings of the sub-accounts in your Merchant Center account. * @alias content.liasettings.list * @memberOf! () * @@ -7654,8 +7174,7 @@ export namespace content_v2_1 { /** * content.liasettings.listposdataproviders - * @desc Retrieves the list of POS data providers that have active settings - * for the all eiligible countries. + * @desc Retrieves the list of POS data providers that have active settings for the all eiligible countries. * @alias content.liasettings.listposdataproviders * @memberOf! () * @@ -8233,9 +7752,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -8247,14 +7764,11 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account for which to retrieve accessible Google My Business - * accounts. + * The ID of the account for which to retrieve accessible Google My Business accounts. */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -8265,8 +7779,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of LIA settings to return in the response, used for - * paging. + * The maximum number of LIA settings to return in the response, used for paging. */ maxResults?: number; /** @@ -8301,9 +7814,7 @@ export namespace content_v2_1 { */ gmbEmail?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -8315,8 +7826,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ accountId?: string; /** @@ -8324,9 +7834,7 @@ export namespace content_v2_1 { */ country?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -8338,8 +7846,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ accountId?: string; /** @@ -8359,9 +7866,7 @@ export namespace content_v2_1 { */ language?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -8373,8 +7878,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account for which to retrieve accessible Google My Business - * accounts. + * The ID of the account for which to retrieve accessible Google My Business accounts. */ accountId?: string; /** @@ -8382,9 +7886,7 @@ export namespace content_v2_1 { */ country?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; /** @@ -8408,9 +7910,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -8428,8 +7928,7 @@ export namespace content_v2_1 { /** * content.orderinvoices.createchargeinvoice - * @desc Creates a charge invoice for a shipment group, and triggers a - * charge capture for non-facilitated payment orders. + * @desc Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders. * @alias content.orderinvoices.createchargeinvoice * @memberOf! () * @@ -8522,11 +8021,7 @@ export namespace content_v2_1 { /** * content.orderinvoices.createrefundinvoice - * @desc Creates a refund invoice for one or more shipment groups, and - * triggers a refund for non-facilitated payment orders. This can only be - * used for line items that have previously been charged using - * createChargeInvoice. All amounts (except for the summary) are incremental - * with respect to the previous invoice. + * @desc Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice. * @alias content.orderinvoices.createrefundinvoice * @memberOf! () * @@ -8626,8 +8121,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -8648,8 +8142,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -8671,8 +8164,7 @@ export namespace content_v2_1 { /** * content.orderreports.listdisbursements - * @desc Retrieves a report for disbursements from your Merchant Center - * account. + * @desc Retrieves a report for disbursements from your Merchant Center account. * @alias content.orderreports.listdisbursements * @memberOf! () * @@ -8766,8 +8258,7 @@ export namespace content_v2_1 { /** * content.orderreports.listtransactions - * @desc Retrieves a list of transactions for a disbursement from your - * Merchant Center account. + * @desc Retrieves a list of transactions for a disbursement from your Merchant Center account. * @alias content.orderreports.listtransactions * @memberOf! () * @@ -8874,8 +8365,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The last date which disbursements occurred. In ISO 8601 format. Default: - * current date. + * The last date which disbursements occurred. In ISO 8601 format. Default: current date. */ disbursementEndDate?: string; /** @@ -8883,13 +8373,11 @@ export namespace content_v2_1 { */ disbursementStartDate?: string; /** - * The maximum number of disbursements to return in the response, used for - * paging. + * The maximum number of disbursements to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -8909,13 +8397,11 @@ export namespace content_v2_1 { */ disbursementId?: string; /** - * The maximum number of disbursements to return in the response, used for - * paging. + * The maximum number of disbursements to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -8923,8 +8409,7 @@ export namespace content_v2_1 { */ pageToken?: string; /** - * The last date in which transaction occurred. In ISO 8601 format. Default: - * current date. + * The last date in which transaction occurred. In ISO 8601 format. Default: current date. */ transactionEndDate?: string; /** @@ -9101,8 +8586,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -9118,24 +8602,19 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Obtains order returns created before this date (inclusively), in ISO 8601 - * format. + * Obtains order returns created before this date (inclusively), in ISO 8601 format. */ createdEndDate?: string; /** - * Obtains order returns created after this date (inclusively), in ISO 8601 - * format. + * Obtains order returns created after this date (inclusively), in ISO 8601 format. */ createdStartDate?: string; /** - * The maximum number of order returns to return in the response, used for - * paging. The default value is 25 returns per page, and the maximum allowed - * value is 250 returns per page. + * The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -9239,8 +8718,7 @@ export namespace content_v2_1 { /** * content.orders.advancetestorder - * @desc Sandbox only. Moves a test order from state "inProgress" to state - * "pendingShipment". + * @desc Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". * @alias content.orders.advancetestorder * @memberOf! () * @@ -9485,8 +8963,7 @@ export namespace content_v2_1 { /** * content.orders.canceltestorderbycustomer - * @desc Sandbox only. Cancels a test order for customer-initiated - * cancellation. + * @desc Sandbox only. Cancels a test order for customer-initiated cancellation. * @alias content.orders.canceltestorderbycustomer * @memberOf! () * @@ -9902,8 +9379,7 @@ export namespace content_v2_1 { /** * content.orders.gettestordertemplate - * @desc Sandbox only. Retrieves an order template that can be used to - * quickly create a new order in sandbox. + * @desc Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. * @alias content.orders.gettestordertemplate * @memberOf! () * @@ -9988,15 +9464,7 @@ export namespace content_v2_1 { /** * content.orders.instorerefundlineitem - * @desc Notifies that item return and refund was handled directly by - * merchant outside of Google payments processing (e.g. cash refund done in - * store). Note: We recommend calling the returnrefundlineitem method to - * refund in-store returns. We will issue the refund directly to the - * customer. This helps to prevent possible differences arising between - * merchant and Google transaction records. We also recommend having the - * point of sale system communicate with Google to ensure that customers do - * not receive a double refund by first refunding via Google then via an - * in-store return. + * @desc Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return. * @alias content.orders.instorerefundlineitem * @memberOf! () * @@ -10248,8 +9716,7 @@ export namespace content_v2_1 { /** * content.orders.returnrefundlineitem - * @desc Returns and refunds a line item. Note that this method can only be - * called on fully shipped orders. + * @desc Returns and refunds a line item. Note that this method can only be called on fully shipped orders. * @alias content.orders.returnrefundlineitem * @memberOf! () * @@ -10334,11 +9801,7 @@ export namespace content_v2_1 { /** * content.orders.setlineitemmetadata - * @desc Sets (or overrides if it already exists) merchant provided - * annotations in the form of key-value pairs. A common use case would be to - * supply us with additional structured information about a line item that - * cannot be provided via other methods. Submitted key-value pairs can be - * retrieved as part of the orders resource. + * @desc Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. * @alias content.orders.setlineitemmetadata * @memberOf! () * @@ -10786,8 +10249,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10808,8 +10270,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10824,8 +10285,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10846,8 +10306,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10868,8 +10327,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10890,8 +10348,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that should manage the order. This cannot be a - * multi-client account. + * The ID of the account that should manage the order. This cannot be a multi-client account. */ merchantId?: string; @@ -10908,8 +10365,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10929,8 +10385,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10946,8 +10401,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10967,8 +10421,7 @@ export namespace content_v2_1 { */ country?: string; /** - * The ID of the account that should manage the order. This cannot be a - * multi-client account. + * The ID of the account that should manage the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10984,8 +10437,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11005,32 +10457,19 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Obtains orders that match the acknowledgement status. When set to true, - * obtains orders that have been acknowledged. When false, obtains orders - * that have not been acknowledged. We recommend using this filter set to - * false, in conjunction with the acknowledge call, such that only - * un-acknowledged orders are returned. + * Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned. */ acknowledged?: boolean; /** - * The maximum number of orders to return in the response, used for paging. - * The default value is 25 orders per page, and the maximum allowed value is - * 250 orders per page. Known issue: All List calls will return all Orders - * without limit regardless of the value of this field. + * The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** - * The ordering of the returned list. The only supported value are - * placedDate desc and placedDate asc for now, which returns orders sorted - * by placement date. "placedDate desc" stands for listing orders by - * placement date, from oldest to most recent. "placedDate asc" stands for - * listing orders by placement date, from most recent to oldest. In future - * releases we'll support other sorting criteria. + * The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. */ orderBy?: string; /** @@ -11046,11 +10485,7 @@ export namespace content_v2_1 { */ placedDateStart?: string; /** - * Obtains orders that match any of the specified statuses. Multiple values - * can be specified with comma separation. Additionally, please note that - * active is a shortcut for pendingShipment and partiallyShipped, and - * completed is a shortcut for shipped , partiallyDelivered, delivered, - * partiallyReturned, returned, and canceled. + * Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. */ statuses?: string[]; } @@ -11062,8 +10497,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11084,8 +10518,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11106,8 +10539,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11128,8 +10560,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11150,8 +10581,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11172,8 +10602,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11194,8 +10623,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11872,8 +11300,7 @@ export namespace content_v2_1 { /** * content.products.custombatch - * @desc Retrieves, inserts, and deletes multiple products in a single - * request. + * @desc Retrieves, inserts, and deletes multiple products in a single request. * @alias content.products.custombatch * @memberOf! () * @@ -12096,9 +11523,7 @@ export namespace content_v2_1 { /** * content.products.insert - * @desc Uploads a product to your Merchant Center account. If an item with - * the same channel, contentLanguage, offerId, and targetCountry already - * exists, this method updates that entry. + * @desc Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. * @alias content.products.insert * @memberOf! () * @@ -12265,8 +11690,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -12281,8 +11705,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -12297,8 +11720,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; @@ -12314,13 +11736,11 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of products to return in the response, used for - * paging. + * The maximum number of products to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that contains the products. This account cannot be - * a multi-client account. + * The ID of the account that contains the products. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -12597,13 +12017,11 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -12619,18 +12037,15 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * The maximum number of product statuses to return in the response, used - * for paging. + * The maximum number of product statuses to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that contains the products. This account cannot be - * a multi-client account. + * The ID of the account that contains the products. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -12647,8 +12062,7 @@ export namespace content_v2_1 { /** * content.regionalinventory.custombatch - * @desc Updates regional inventory for multiple products or regions in a - * single request. + * @desc Updates regional inventory for multiple products or regions in a single request. * @alias content.regionalinventory.custombatch * @memberOf! () * @@ -12739,9 +12153,7 @@ export namespace content_v2_1 { /** * content.regionalinventory.insert - * @desc Update the regional inventory of a product in your Merchant Center - * account. If a regional inventory with the same region ID already exists, - * this method updates that entry. + * @desc Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry. * @alias content.regionalinventory.insert * @memberOf! () * @@ -12836,8 +12248,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -12859,8 +12270,7 @@ export namespace content_v2_1 { /** * content.shippingsettings.custombatch - * @desc Retrieves and updates the shipping settings of multiple accounts in - * a single request. + * @desc Retrieves and updates the shipping settings of multiple accounts in a single request. * @alias content.shippingsettings.custombatch * @memberOf! () * @@ -13216,8 +12626,7 @@ export namespace content_v2_1 { /** * content.shippingsettings.list - * @desc Lists the shipping settings of the sub-accounts in your Merchant - * Center account. + * @desc Lists the shipping settings of the sub-accounts in your Merchant Center account. * @alias content.shippingsettings.list * @memberOf! () * @@ -13400,9 +12809,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -13438,8 +12845,7 @@ export namespace content_v2_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of shipping settings to return in the response, used - * for paging. + * The maximum number of shipping settings to return in the response, used for paging. */ maxResults?: number; /** @@ -13463,9 +12869,7 @@ export namespace content_v2_1 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 39e740ec6fb..1ffdbcb607b 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace content_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace content_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace content_v2 { /** * Content API for Shopping * - * Manages product items, inventory, and Merchant Center accounts for Google - * Shopping. + * Manages product items, inventory, and Merchant Center accounts for Google Shopping. * * @example * const {google} = require('googleapis'); @@ -111,7 +107,10 @@ export namespace content_v2 { shippingsettings: Resource$Shippingsettings; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.accountstatuses = new Resource$Accountstatuses(this.context); @@ -133,9 +132,7 @@ export namespace content_v2 { } /** - * Account data. After the creation of a new account it may take a few minutes - * before it is fully operational. The methods delete, insert, patch, and - * update require the admin role. + * Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role. */ export interface Schema$Account { /** @@ -143,11 +140,7 @@ export namespace content_v2 { */ adultContent?: boolean; /** - * List of linked AdWords accounts that are active or pending approval. To - * create a new link request, add a new link with status active to the list. - * It will remain in a pending state until approved or rejected either in - * the AdWords interface or through the AdWords API. To delete an active - * link, or to cancel a link request, remove it from the list. + * List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. */ adwordsLinks?: Schema$AccountAdwordsLink[]; /** @@ -155,8 +148,7 @@ export namespace content_v2 { */ businessInformation?: Schema$AccountBusinessInformation; /** - * The GMB account which is linked or in the process of being linked with - * the Merchant Center account. + * The GMB account which is linked or in the process of being linked with the Merchant Center account. */ googleMyBusinessLink?: Schema$AccountGoogleMyBusinessLink; /** @@ -164,8 +156,7 @@ export namespace content_v2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#account". + * Identifies what kind of resource this is. Value: the fixed string "content#account". */ kind?: string; /** @@ -173,8 +164,7 @@ export namespace content_v2 { */ name?: string; /** - * [DEPRECATED] This field is never returned and will be ignored if - * provided. + * [DEPRECATED] This field is never returned and will be ignored if provided. */ reviewsUrl?: string; /** @@ -182,8 +172,7 @@ export namespace content_v2 { */ sellerId?: string; /** - * Users with access to the account. Every account (except for subaccounts) - * must have at least one admin user. + * Users with access to the account. Every account (except for subaccounts) must have at least one admin user. */ users?: Schema$AccountUser[]; /** @@ -191,11 +180,7 @@ export namespace content_v2 { */ websiteUrl?: string; /** - * List of linked YouTube channels that are active or pending approval. To - * create a new link request, add a new link with status active to the list. - * It will remain in a pending state until approved or rejected in the YT - * Creator Studio interface. To delete an active link, or to cancel a link - * request, remove it from the list. + * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. */ youtubeChannelLinks?: Schema$AccountYouTubeChannelLink[]; } @@ -205,8 +190,7 @@ export namespace content_v2 { */ country?: string; /** - * City, town or commune. May also include dependent localities or - * sublocalities (e.g. neighborhoods or suburbs). + * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ locality?: string; /** @@ -214,9 +198,7 @@ export namespace content_v2 { */ postalCode?: string; /** - * Top-level administrative subdivision of the country. For example, a state - * like California ("CA") or a province like Quebec - * ("QC"). + * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ region?: string; /** @@ -230,16 +212,7 @@ export namespace content_v2 { */ adwordsId?: string; /** - * Status of the link between this Merchant Center account and the AdWords - * account. Upon retrieval, it represents the actual status of the link and - * can be either active if it was approved in Google AdWords or pending if - * it's pending approval. Upon insertion, it represents the intended - * status of the link. Re-uploading a link with status active when it's - * still pending or with status pending when it's already active will - * have no effect: the status will remain unchanged. Re-uploading a link - * with deprecated status inactive is equivalent to not submitting the link - * at all and will delete the link if it was active or cancel the link - * request if it was pending. + * Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ status?: string; } @@ -273,21 +246,17 @@ export namespace content_v2 { } export interface Schema$AccountGoogleMyBusinessLink { /** - * The GMB email address of which a specific account within a GMB account. A - * sample account within a GMB account could be a business account with set - * of locations, managed under the GMB account. + * The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. */ gmbEmail?: string; /** - * Status of the link between this Merchant Center account and the GMB - * account. + * Status of the link between this Merchant Center account and the GMB account. */ status?: string; } export interface Schema$AccountIdentifier { /** - * The aggregator ID, set for aggregators and subaccounts (in that case, it - * represents the aggregator of the subaccount). + * The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount). */ aggregatorId?: string; /** @@ -297,22 +266,17 @@ export namespace content_v2 { } export interface Schema$AccountsAuthInfoResponse { /** - * The account identifiers corresponding to the authenticated user. - For an - * individual account: only the merchant ID is defined - For an aggregator: - * only the aggregator ID is defined - For a subaccount of an MCA: both the - * merchant ID and the aggregator ID are defined. + * The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. */ accountIdentifiers?: Schema$AccountIdentifier[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsAuthInfoResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse". */ kind?: string; } export interface Schema$AccountsClaimWebsiteResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsClaimWebsiteResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse". */ kind?: string; } @@ -327,8 +291,7 @@ export namespace content_v2 { */ export interface Schema$AccountsCustomBatchRequestEntry { /** - * The account to create or update. Only defined if the method is insert or - * update. + * The account to create or update. Only defined if the method is insert or update. */ account?: Schema$Account; /** @@ -340,8 +303,7 @@ export namespace content_v2 { */ batchId?: number; /** - * Whether the account should be deleted if the account has offers. Only - * applicable if the method is delete. + * Whether the account should be deleted if the account has offers. Only applicable if the method is delete. */ force?: boolean; /** @@ -357,15 +319,13 @@ export namespace content_v2 { */ method?: string; /** - * Only applicable if the method is claimwebsite. Indicates whether or not - * to take the claim from another account in case there is a conflict. + * Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict. */ overwrite?: boolean; } export interface Schema$AccountsCustomBatchRequestEntryLinkRequest { /** - * Action to perform for this link. The "request" action is only - * available to select merchants. + * Action to perform for this link. The "request" action is only available to select merchants. */ action?: string; /** @@ -383,8 +343,7 @@ export namespace content_v2 { */ entries?: Schema$AccountsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse". */ kind?: string; } @@ -393,8 +352,7 @@ export namespace content_v2 { */ export interface Schema$AccountsCustomBatchResponseEntry { /** - * The retrieved, created, or updated account. Not defined if the method was - * delete, claimwebsite or link. + * The retrieved, created, or updated account. Not defined if the method was delete, claimwebsite or link. */ account?: Schema$Account; /** @@ -406,8 +364,7 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry". */ kind?: string; /** @@ -417,8 +374,7 @@ export namespace content_v2 { } export interface Schema$AccountsLinkRequest { /** - * Action to perform for this link. The "request" action is only - * available to select merchants. + * Action to perform for this link. The "request" action is only available to select merchants. */ action?: string; /** @@ -432,15 +388,13 @@ export namespace content_v2 { } export interface Schema$AccountsLinkResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsLinkResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse". */ kind?: string; } export interface Schema$AccountsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse". */ kind?: string; /** @@ -450,8 +404,7 @@ export namespace content_v2 { resources?: Schema$Account[]; } /** - * The status of an account, i.e., information about its products, which is - * computed offline and not returned immediately at insertion time. + * The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. */ export interface Schema$AccountStatus { /** @@ -467,13 +420,11 @@ export namespace content_v2 { */ dataQualityIssues?: Schema$AccountStatusDataQualityIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountStatus". + * Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". */ kind?: string; /** - * List of product-related data by channel, destination, and country. Data - * in this field may be delayed by up to 30 minutes. + * List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. */ products?: Schema$AccountStatusProducts[]; /** @@ -543,8 +494,7 @@ export namespace content_v2 { */ batchId?: number; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** @@ -562,8 +512,7 @@ export namespace content_v2 { */ entries?: Schema$AccountstatusesCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountstatusesCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse". */ kind?: string; } @@ -572,8 +521,7 @@ export namespace content_v2 { */ export interface Schema$AccountstatusesCustomBatchResponseEntry { /** - * The requested account status. Defined if and only if the request was - * successful. + * The requested account status. Defined if and only if the request was successful. */ accountStatus?: Schema$AccountStatus; /** @@ -587,8 +535,7 @@ export namespace content_v2 { } export interface Schema$AccountstatusesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountstatusesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse". */ kind?: string; /** @@ -687,13 +634,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accountTax". + * Identifies what kind of resource this is. Value: the fixed string "content#accountTax". */ kind?: string; /** - * Tax rules. Updating the tax rules will enable US taxes (not reversible). - * Defining no rules is equivalent to not charging tax at all. + * Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all. */ rules?: Schema$AccountTaxTaxRule[]; } @@ -731,8 +676,7 @@ export namespace content_v2 { */ entries?: Schema$AccounttaxCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accounttaxCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse". */ kind?: string; } @@ -753,15 +697,13 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accounttaxCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry". */ kind?: string; } export interface Schema$AccounttaxListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#accounttaxListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse". */ kind?: string; /** @@ -779,13 +721,11 @@ export namespace content_v2 { */ country?: string; /** - * State (or province) is which the tax is applicable, described by its - * location ID (also called criteria ID). + * State (or province) is which the tax is applicable, described by its location ID (also called criteria ID). */ locationId?: string; /** - * Explicit tax rate in percent, represented as a floating point number - * without the percentage character. Must not be negative. + * Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative. */ ratePercent?: string; /** @@ -793,8 +733,7 @@ export namespace content_v2 { */ shippingTaxed?: boolean; /** - * Whether the tax rate is taken from a global tax table or specified - * explicitly. + * Whether the tax rate is taken from a global tax table or specified explicitly. */ useGlobalRate?: boolean; } @@ -826,16 +765,7 @@ export namespace content_v2 { */ channelId?: string; /** - * Status of the link between this Merchant Center account and the YouTube - * channel. Upon retrieval, it represents the actual status of the link and - * can be either active if it was approved in YT Creator Studio or pending - * if it's pending approval. Upon insertion, it represents the intended - * status of the link. Re-uploading a link with status active when it's - * still pending or with status pending when it's already active will - * have no effect: the status will remain unchanged. Re-uploading a link - * with deprecated status inactive is equivalent to not submitting the link - * at all and will delete the link if it was active or cancel the link - * request if it was pending. + * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ status?: string; } @@ -851,23 +781,15 @@ export namespace content_v2 { } export interface Schema$CarrierRate { /** - * Carrier service, such as "UPS" or "Fedex". The list - * of supported carriers can be retrieved via the getSupportedCarriers - * method. Required. + * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. */ carrierName?: string; /** - * Carrier service, such as "ground" or "2 days". The - * list of supported services for a carrier can be retrieved via the - * getSupportedCarriers method. Required. + * Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. */ carrierService?: string; /** - * Additive shipping rate modifier. Can be negative. For example { - * "value": "1", "currency" : "USD" - * } adds $1 to the rate, { "value": "-3", - * "currency" : "USD" } removes $3 from the rate. - * Optional. + * Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional. */ flatAdjustment?: Schema$Price; /** @@ -879,16 +801,13 @@ export namespace content_v2 { */ originPostalCode?: string; /** - * Multiplicative shipping rate modifier as a number in decimal notation. - * Can be negative. For example "5.4" increases the rate by 5.4%, - * "-3" decreases the rate by 3%. Optional. + * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional. */ percentageAdjustment?: string; } export interface Schema$CarriersCarrier { /** - * The CLDR country code of the carrier (e.g., "US"). Always - * present. + * The CLDR country code of the carrier (e.g., "US"). Always present. */ country?: string; /** @@ -896,15 +815,13 @@ export namespace content_v2 { */ name?: string; /** - * A list of supported services (e.g., "ground") for that carrier. - * Contains at least one service. + * A list of supported services (e.g., "ground") for that carrier. Contains at least one service. */ services?: string[]; } export interface Schema$CustomAttribute { /** - * The name of the attribute. Underscores will be replaced by spaces upon - * insertion. + * The name of the attribute. Underscores will be replaced by spaces upon insertion. */ name?: string; /** @@ -912,8 +829,7 @@ export namespace content_v2 { */ type?: string; /** - * Free-form unit of the attribute. Unit can only be used for values of type - * int, float, or price. + * Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. */ unit?: string; /** @@ -931,26 +847,21 @@ export namespace content_v2 { */ attributes?: Schema$CustomAttribute[]; /** - * The name of the group. Underscores will be replaced by spaces upon - * insertion. + * The name of the group. Underscores will be replaced by spaces upon insertion. */ name?: string; } export interface Schema$CutoffTime { /** - * Hour of the cutoff time until which an order has to be placed to be - * processed in the same day. Required. + * Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ hour?: number; /** - * Minute of the cutoff time until which an order has to be placed to be - * processed in the same day. Required. + * Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required. */ minute?: number; /** - * Timezone identifier for the cutoff time. A list of identifiers can be - * found in the AdWords API documentation. E.g. "Europe/Zurich". - * Required. + * Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ timezone?: string; } @@ -959,19 +870,15 @@ export namespace content_v2 { */ export interface Schema$Datafeed { /** - * The two-letter ISO 639-1 language in which the attributes are defined in - * the data feed. + * The two-letter ISO 639-1 language in which the attributes are defined in the data feed. */ attributeLanguage?: string; /** - * [DEPRECATED] Please use targets[].language instead. The two-letter ISO - * 639-1 language of the items in the feed. Must be a valid language for - * targetCountry. + * [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. */ contentLanguage?: string; /** - * The type of data feed. For product inventory feeds, only feeds for local - * stores, not online stores, are supported. + * The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. */ contentType?: string; /** @@ -991,14 +898,11 @@ export namespace content_v2 { */ id?: string; /** - * [DEPRECATED] Please use targets[].includedDestinations instead. The list - * of intended destinations (corresponds to checked check boxes in Merchant - * Center). + * [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center). */ intendedDestinations?: string[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeed". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeed". */ kind?: string; /** @@ -1006,9 +910,7 @@ export namespace content_v2 { */ name?: string; /** - * [DEPRECATED] Please use targets[].country instead. The country where the - * items in the feed will be included in the search index, represented as a - * CLDR territory code. + * [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code. */ targetCountry?: string; /** @@ -1017,10 +919,7 @@ export namespace content_v2 { targets?: Schema$DatafeedTarget[]; } /** - * The required fields vary based on the frequency of fetching. For a monthly - * fetch schedule, day_of_month and hour are required. For a weekly fetch - * schedule, weekday and hour are required. For a daily fetch schedule, only - * hour is required. + * The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. */ export interface Schema$DatafeedFetchSchedule { /** @@ -1028,10 +927,7 @@ export namespace content_v2 { */ dayOfMonth?: number; /** - * The URL where the feed file can be fetched. Google Merchant Center will - * support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP - * protocols, so the value will need to be a valid link using one of those - * four protocols. + * The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. */ fetchUrl?: string; /** @@ -1051,8 +947,7 @@ export namespace content_v2 { */ paused?: boolean; /** - * Time zone used for schedule. UTC by default. E.g., - * "America/Los_Angeles". + * Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". */ timeZone?: string; /** @@ -1066,19 +961,15 @@ export namespace content_v2 { } export interface Schema$DatafeedFormat { /** - * Delimiter for the separation of values in a delimiter-separated values - * feed. If not specified, the delimiter will be auto-detected. Ignored for - * non-DSV data feeds. + * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. */ columnDelimiter?: string; /** - * Character encoding scheme of the data feed. If not specified, the - * encoding will be auto-detected. + * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. */ fileEncoding?: string; /** - * Specifies how double quotes are interpreted. If not specified, the mode - * will be auto-detected. Ignored for non-DSV data feeds. + * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. */ quotingMode?: string; } @@ -1116,8 +1007,7 @@ export namespace content_v2 { */ entries?: Schema$DatafeedsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse". */ kind?: string; } @@ -1130,8 +1020,7 @@ export namespace content_v2 { */ batchId?: number; /** - * The requested data feed. Defined if and only if the request was - * successful. + * The requested data feed. Defined if and only if the request was successful. */ datafeed?: Schema$Datafeed; /** @@ -1141,15 +1030,13 @@ export namespace content_v2 { } export interface Schema$DatafeedsFetchNowResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedsFetchNowResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse". */ kind?: string; } export interface Schema$DatafeedsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse". */ kind?: string; /** @@ -1159,13 +1046,11 @@ export namespace content_v2 { resources?: Schema$Datafeed[]; } /** - * The status of a datafeed, i.e., the result of the last retrieval of the - * datafeed computed asynchronously when the feed processing is finished. + * The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. */ export interface Schema$DatafeedStatus { /** - * The country for which the status is reported, represented as a CLDR - * territory code. + * The country for which the status is reported, represented as a CLDR territory code. */ country?: string; /** @@ -1185,8 +1070,7 @@ export namespace content_v2 { */ itemsValid?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedStatus". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". */ kind?: string; /** @@ -1242,9 +1126,7 @@ export namespace content_v2 { */ batchId?: number; /** - * The country for which to get the datafeed status. If this parameter is - * provided then language must also be provided. Note that for multi-target - * datafeeds this parameter is required. + * The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required. */ country?: string; /** @@ -1252,9 +1134,7 @@ export namespace content_v2 { */ datafeedId?: string; /** - * The language for which to get the datafeed status. If this parameter is - * provided then country must also be provided. Note that for multi-target - * datafeeds this parameter is required. + * The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required. */ language?: string; /** @@ -1269,8 +1149,7 @@ export namespace content_v2 { */ entries?: Schema$DatafeedstatusesCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedstatusesCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse". */ kind?: string; } @@ -1283,8 +1162,7 @@ export namespace content_v2 { */ batchId?: number; /** - * The requested data feed status. Defined if and only if the request was - * successful. + * The requested data feed status. Defined if and only if the request was successful. */ datafeedStatus?: Schema$DatafeedStatus; /** @@ -1294,8 +1172,7 @@ export namespace content_v2 { } export interface Schema$DatafeedstatusesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#datafeedstatusesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse". */ kind?: string; /** @@ -1323,65 +1200,49 @@ export namespace content_v2 { } export interface Schema$DatafeedTarget { /** - * The country where the items in the feed will be included in the search - * index, represented as a CLDR territory code. + * The country where the items in the feed will be included in the search index, represented as a CLDR territory code. */ country?: string; /** - * The list of destinations to exclude for this target (corresponds to - * unchecked check boxes in Merchant Center). + * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). */ excludedDestinations?: string[]; /** - * The list of destinations to include for this target (corresponds to - * checked check boxes in Merchant Center). Default destinations are always - * included unless provided in the excluded_destination field. + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field. */ includedDestinations?: string[]; /** - * The two-letter ISO 639-1 language of the items in the feed. Must be a - * valid language for targets[].country. + * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. */ language?: string; } export interface Schema$DeliveryTime { /** - * Business days cutoff time definition. If not configured the cutoff time - * will be defaulted to 8AM PST. + * Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST. */ cutoffTime?: Schema$CutoffTime; /** - * Holiday cutoff definitions. If configured, they specify order cutoff - * times for holiday-specific shipping. + * Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping. */ holidayCutoffs?: Schema$HolidayCutoff[]; /** - * Maximum number of business days spent before an order is shipped. 0 means - * same day shipped, 1 means next day shipped. Must be greater than or equal - * to minHandlingTimeInDays. + * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays. */ maxHandlingTimeInDays?: number; /** - * Maximum number of business days that is spent in transit. 0 means same - * day delivery, 1 means next day delivery. Must be greater than or equal to - * minTransitTimeInDays. + * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. */ maxTransitTimeInDays?: number; /** - * Minimum number of business days spent before an order is shipped. 0 means - * same day shipped, 1 means next day shipped. + * Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. */ minHandlingTimeInDays?: number; /** - * Minimum number of business days that is spent in transit. 0 means same - * day delivery, 1 means next day delivery. Either - * {min,max}transitTimeInDays or transitTimeTable must be set, but not both. + * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both. */ minTransitTimeInDays?: number; /** - * Transit time table, number of business days spent in transit based on row - * and column dimensions. Either {min,max}transitTimeInDays or - * transitTimeTable can be set, but not both. + * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both. */ transitTimeTable?: Schema$TransitTable; } @@ -1448,71 +1309,41 @@ export namespace content_v2 { type?: string; } /** - * A non-empty list of row or column headers for a table. Exactly one of - * prices, weights, numItems, postalCodeGroupNames, or location must be set. + * A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. */ export interface Schema$Headers { /** - * A list of location ID sets. Must be non-empty. Can only be set if all - * other fields are not set. + * A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. */ locations?: Schema$LocationIdSet[]; /** - * A list of inclusive number of items upper bounds. The last value can be - * "infinity". For example ["10", "50", - * "infinity"] represents the headers "<= 10 items", - * " 50 items". Must be non-empty. Can only be set if all other - * fields are not set. + * A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. */ numberOfItems?: string[]; /** - * A list of postal group names. The last value can be "all other - * locations". Example: ["zone 1", "zone 2", - * "all other locations"]. The referred postal code groups must - * match the delivery country of the service. Must be non-empty. Can only be - * set if all other fields are not set. + * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. */ postalCodeGroupNames?: string[]; /** - * A list of inclusive order price upper bounds. The last price's value - * can be "infinity". For example [{"value": - * "10", "currency": "USD"}, - * {"value": "500", "currency": - * "USD"}, {"value": "infinity", - * "currency": "USD"}] represents the headers - * "<= $10", " $500". All prices within a service - * must have the same currency. Must be non-empty. Can only be set if all - * other fields are not set. + * A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. */ prices?: Schema$Price[]; /** - * A list of inclusive order weight upper bounds. The last weight's - * value can be "infinity". For example [{"value": - * "10", "unit": "kg"}, {"value": - * "50", "unit": "kg"}, {"value": - * "infinity", "unit": "kg"}] represents the - * headers "<= 10kg", " 50kg". All weights within a - * service must have the same unit. Must be non-empty. Can only be set if - * all other fields are not set. + * A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set. */ weights?: Schema$Weight[]; } export interface Schema$HolidayCutoff { /** - * Date of the order deadline, in ISO 8601 format. E.g. - * "2016-11-29" for 29th November 2016. Required. + * Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required. */ deadlineDate?: string; /** - * Hour of the day on the deadline date until which the order has to be - * placed to qualify for the delivery guarantee. Possible values are: 0 - * (midnight), 1, ..., 12 (noon), 13, ..., 23. Required. + * Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required. */ deadlineHour?: number; /** - * Timezone identifier for the deadline hour. A list of identifiers can be - * found in the AdWords API documentation. E.g. "Europe/Zurich". - * Required. + * Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. */ deadlineTimezone?: string; /** @@ -1520,40 +1351,29 @@ export namespace content_v2 { */ holidayId?: string; /** - * Date on which the deadline will become visible to consumers in ISO 8601 - * format. E.g. "2016-10-31" for 31st October 2016. Required. + * Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required. */ visibleFromDate?: string; } export interface Schema$HolidaysHoliday { /** - * The CLDR territory code of the country in which the holiday is available. - * E.g. "US", "DE", "GB". A holiday cutoff can - * only be configured in a shipping settings service with matching delivery - * country. Always present. + * The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present. */ countryCode?: string; /** - * Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for - * Christmas 2016. Always present. + * Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present. */ date?: string; /** - * Date on which the order has to arrive at the customer's, in ISO 8601 - * format. E.g. "2016-12-24" for 24th December 2016. Always - * present. + * Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present. */ deliveryGuaranteeDate?: string; /** - * Hour of the day in the delivery location's timezone on the guaranteed - * delivery date by which the order has to arrive at the customer's. - * Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always - * present. + * Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present. */ deliveryGuaranteeHour?: string; /** - * Unique identifier for the holiday to be used when configuring holiday - * cutoffs. Always present. + * Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present. */ id?: string; /** @@ -1577,28 +1397,23 @@ export namespace content_v2 { */ availability?: string; /** - * Custom label 0 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel0?: string; /** - * Custom label 1 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel1?: string; /** - * Custom label 2 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel2?: string; /** - * Custom label 3 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel3?: string; /** - * Custom label 3 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel4?: string; /** @@ -1610,8 +1425,7 @@ export namespace content_v2 { */ instoreProductLocation?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#inventory". + * Identifies what kind of resource this is. Value: the fixed string "content#inventory". */ kind?: string; /** @@ -1619,11 +1433,7 @@ export namespace content_v2 { */ loyaltyPoints?: Schema$LoyaltyPoints; /** - * Store pickup information. Only supported for local inventory. Not setting - * pickup means "don't update" while setting it to the empty - * value ({} in JSON) means "delete". Otherwise, pickupMethod and - * pickupSla must be set together, unless pickupMethod is "not - * supported". + * Store pickup information. Only supported for local inventory. Not setting pickup means "don't update" while setting it to the empty value ({} in JSON) means "delete". Otherwise, pickupMethod and pickupSla must be set together, unless pickupMethod is "not supported". */ pickup?: Schema$InventoryPickup; /** @@ -1631,24 +1441,19 @@ export namespace content_v2 { */ price?: Schema$Price; /** - * The quantity of the product. Must be equal to or greater than zero. - * Supported only for local products. + * The quantity of the product. Must be equal to or greater than zero. Supported only for local products. */ quantity?: number; /** - * The sale price of the product. Mandatory if sale_price_effective_date is - * defined. + * The sale price of the product. Mandatory if sale_price_effective_date is defined. */ salePrice?: Schema$Price; /** - * A date range represented by a pair of ISO 8601 dates separated by a - * space, comma, or slash. Both dates might be specified as 'null' - * if undecided. + * A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. */ salePriceEffectiveDate?: string; /** - * The quantity of the product that is available for selling on Google. - * Supported only for online products. + * The quantity of the product that is available for selling on Google. Supported only for online products. */ sellOnGoogleQuantity?: number; } @@ -1679,8 +1484,7 @@ export namespace content_v2 { */ productId?: string; /** - * The code of the store for which to update price and availability. Use - * online to update price and availability of an online product. + * The code of the store for which to update price and availability. Use online to update price and availability of an online product. */ storeCode?: string; } @@ -1690,8 +1494,7 @@ export namespace content_v2 { */ entries?: Schema$InventoryCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#inventoryCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse". */ kind?: string; } @@ -1708,23 +1511,17 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#inventoryCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponseEntry". */ kind?: string; } export interface Schema$InventoryPickup { /** - * Whether store pickup is available for this offer and whether the pickup - * option should be shown as buy, reserve, or not supported. Only supported - * for local inventory. Unless the value is "not supported", must - * be submitted together with pickupSla. + * Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with pickupSla. */ pickupMethod?: string; /** - * The expected date that an order will be ready for pickup, relative to - * when the order is placed. Only supported for local inventory. Must be - * submitted together with pickupMethod. + * The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with pickupMethod. */ pickupSla?: string; } @@ -1734,28 +1531,23 @@ export namespace content_v2 { */ availability?: string; /** - * Custom label 0 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel0?: string; /** - * Custom label 1 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel1?: string; /** - * Custom label 2 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel2?: string; /** - * Custom label 3 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel3?: string; /** - * Custom label 3 for custom grouping of items in a Shopping campaign. Only - * supported for online products. + * Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. */ customLabel4?: string; /** @@ -1771,11 +1563,7 @@ export namespace content_v2 { */ loyaltyPoints?: Schema$LoyaltyPoints; /** - * Store pickup information. Only supported for local inventory. Not setting - * pickup means "don't update" while setting it to the empty - * value ({} in JSON) means "delete". Otherwise, pickupMethod and - * pickupSla must be set together, unless pickupMethod is "not - * supported". + * Store pickup information. Only supported for local inventory. Not setting pickup means "don't update" while setting it to the empty value ({} in JSON) means "delete". Otherwise, pickupMethod and pickupSla must be set together, unless pickupMethod is "not supported". */ pickup?: Schema$InventoryPickup; /** @@ -1783,31 +1571,25 @@ export namespace content_v2 { */ price?: Schema$Price; /** - * The quantity of the product. Must be equal to or greater than zero. - * Supported only for local products. + * The quantity of the product. Must be equal to or greater than zero. Supported only for local products. */ quantity?: number; /** - * The sale price of the product. Mandatory if sale_price_effective_date is - * defined. + * The sale price of the product. Mandatory if sale_price_effective_date is defined. */ salePrice?: Schema$Price; /** - * A date range represented by a pair of ISO 8601 dates separated by a - * space, comma, or slash. Both dates might be specified as 'null' - * if undecided. + * A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. */ salePriceEffectiveDate?: string; /** - * The quantity of the product that is available for selling on Google. - * Supported only for online products. + * The quantity of the product that is available for selling on Google. Supported only for online products. */ sellOnGoogleQuantity?: number; } export interface Schema$InventorySetResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#inventorySetResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse". */ kind?: string; } @@ -1926,13 +1708,11 @@ export namespace content_v2 { posExternalAccountId?: string; } /** - * Local Inventory ads (LIA) settings. All methods except listposdataproviders - * require the admin role. + * Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. */ export interface Schema$LiaSettings { /** - * The ID of the account to which these LIA settings belong. Ignored upon - * update, always present in get request responses. + * The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses. */ accountId?: string; /** @@ -1940,8 +1720,7 @@ export namespace content_v2 { */ countrySettings?: Schema$LiaCountrySettings[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liaSettings". + * Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". */ kind?: string; } @@ -1961,13 +1740,11 @@ export namespace content_v2 { */ batchId?: number; /** - * Inventory validation contact email. Required only for - * SetInventoryValidationContact. + * Inventory validation contact email. Required only for SetInventoryValidationContact. */ contactEmail?: string; /** - * Inventory validation contact name. Required only for - * SetInventoryValidationContact. + * Inventory validation contact name. Required only for SetInventoryValidationContact. */ contactName?: string; /** @@ -2002,8 +1779,7 @@ export namespace content_v2 { */ entries?: Schema$LiasettingsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse". */ kind?: string; } @@ -2021,8 +1797,7 @@ export namespace content_v2 { */ gmbAccounts?: Schema$GmbAccounts; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry". */ kind?: string; /** @@ -2044,15 +1819,13 @@ export namespace content_v2 { */ gmbAccounts?: Schema$GmbAccountsGmbAccount[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsGetAccessibleGmbAccountsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse". */ kind?: string; } export interface Schema$LiasettingsListPosDataProvidersResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsListPosDataProvidersResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse". */ kind?: string; /** @@ -2062,8 +1835,7 @@ export namespace content_v2 { } export interface Schema$LiasettingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse". */ kind?: string; /** @@ -2074,43 +1846,37 @@ export namespace content_v2 { } export interface Schema$LiasettingsRequestGmbAccessResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsRequestGmbAccessResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse". */ kind?: string; } export interface Schema$LiasettingsRequestInventoryVerificationResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsRequestInventoryVerificationResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse". */ kind?: string; } export interface Schema$LiasettingsSetInventoryVerificationContactResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsSetInventoryVerificationContactResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse". */ kind?: string; } export interface Schema$LiasettingsSetPosDataProviderResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#liasettingsSetPosDataProviderResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse". */ kind?: string; } export interface Schema$LocationIdSet { /** - * A non-empty list of location IDs. They must all be of the same location - * type (e.g., state). + * A non-empty list of location IDs. They must all be of the same location type (e.g., state). */ locationIds?: string[]; } export interface Schema$LoyaltyPoints { /** - * Name of loyalty points program. It is recommended to limit the name to 12 - * full-width characters or 24 Roman characters. + * Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. */ name?: string; /** @@ -2118,9 +1884,7 @@ export namespace content_v2 { */ pointsValue?: string; /** - * The ratio of a point when converted to currency. Google assumes currency - * based on Merchant Center settings. If ratio is left out, it defaults - * to 1.0. + * The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. */ ratio?: number; } @@ -2165,8 +1929,7 @@ export namespace content_v2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#order". + * Identifies what kind of resource this is. Value: the fixed string "content#order". */ kind?: string; /** @@ -2179,9 +1942,7 @@ export namespace content_v2 { */ merchantOrderId?: string; /** - * The net amount for the order. For example, if an order was originally for - * a grand total of $100 and a refund was issued for $20, the net amount - * will be $80. + * The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80. */ netAmount?: Schema$Price; /** @@ -2197,8 +1958,7 @@ export namespace content_v2 { */ placedDate?: string; /** - * The details of the merchant provided promotions applied to the order. - * More details about the program are here. + * The details of the merchant provided promotions applied to the order. More details about the program are here. */ promotions?: Schema$OrderLegacyPromotion[]; /** @@ -2236,9 +1996,7 @@ export namespace content_v2 { */ country?: string; /** - * Strings representing the lines of the printed label for mailing the - * order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, - * CA, 94043 United States + * Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States */ fullAddress?: string[]; /** @@ -2246,8 +2004,7 @@ export namespace content_v2 { */ isPostOfficeBox?: boolean; /** - * City, town or commune. May also include dependent localities or - * sublocalities (e.g. neighborhoods or suburbs). + * City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). */ locality?: string; /** @@ -2259,9 +2016,7 @@ export namespace content_v2 { */ recipientName?: string; /** - * Top-level administrative subdivision of the country. For example, a state - * like California ("CA") or a province like Quebec - * ("QC"). + * Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). */ region?: string; /** @@ -2283,10 +2038,7 @@ export namespace content_v2 { */ quantity?: number; /** - * The reason for the cancellation. Orders that are cancelled with a - * noInventory reason will lead to the removal of the product from Shopping - * Actions until you make an update to that product. This will not affect - * your Shopping ads. + * The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. */ reason?: string; /** @@ -2308,26 +2060,21 @@ export namespace content_v2 { */ fullName?: string; /** - * Customer's marketing preferences. + * Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order. */ marketingRightsInfo?: Schema$OrderCustomerMarketingRightsInfo; } export interface Schema$OrderCustomerMarketingRightsInfo { /** - * Last known user selection regarding marketing preferences. In certain - * cases this selection might not be known, so this field would be empty. + * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in. */ explicitMarketingPreference?: string; /** - * Timestamp when last time marketing preference was updated. Could be - * empty, if user wasn't offered a selection yet. + * Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. */ lastUpdatedTimestamp?: string; /** - * Email address that can be used for marketing purposes. The field may be - * empty even if explicitMarketingPreference is 'granted'. This - * happens when retrieving an old order from the customer who deleted their - * account. + * Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account. */ marketingEmailAddress?: string; } @@ -2355,14 +2102,11 @@ export namespace content_v2 { */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * [required] The ID of the operation, unique across all operations for a - * given order. + * [required] The ID of the operation, unique across all operations for a given order. */ operationId?: string; /** - * [required] ID of the shipment group. It is assigned by the merchant in - * the shipLineItems method and is used to group multiple line items that - * have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string; } @@ -2372,8 +2116,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderinvoicesCreateChargeInvoiceResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse". */ kind?: string; } @@ -2383,19 +2126,15 @@ export namespace content_v2 { */ invoiceId?: string; /** - * [required] The ID of the operation, unique across all operations for a - * given order. + * [required] The ID of the operation, unique across all operations for a given order. */ operationId?: string; /** - * Option to create a refund-only invoice. Exactly one of refundOnlyOption - * or returnOption must be provided. + * Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided. */ refundOnlyOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; /** - * Option to create an invoice for a refund and mark all items within the - * invoice as returned. Exactly one of refundOnlyOption or returnOption must - * be provided. + * Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of refundOnlyOption or returnOption must be provided. */ returnOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; /** @@ -2409,8 +2148,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderinvoicesCreateRefundInvoiceResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse". */ kind?: string; } @@ -2437,18 +2175,11 @@ export namespace content_v2 { export interface Schema$OrderLegacyPromotion { benefits?: Schema$OrderLegacyPromotionBenefit[]; /** - * The date and time frame when the promotion is active and ready for - * validation review. Note that the promotion live time may be delayed for a - * few hours due to the validation review. Start date and end date are - * separated by a forward slash (/). The start date is specified by the - * format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when - * the sale starts (in Greenwich Mean Time, GMT), followed by an expression - * of the time zone for the sale. The end date is in the same format. + * The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format. */ effectiveDates?: string; /** - * Optional. The text code that corresponds to the promotion when applied on - * the retailer?s website. + * Optional. The text code that corresponds to the promotion when applied on the retailer?s website. */ genericRedemptionCode?: string; /** @@ -2460,8 +2191,7 @@ export namespace content_v2 { */ longTitle?: string; /** - * Whether the promotion is applicable to all products or only specific - * products. + * Whether the promotion is applicable to all products or only specific products. */ productApplicability?: string; /** @@ -2475,13 +2205,11 @@ export namespace content_v2 { */ discount?: Schema$Price; /** - * The OfferId(s) that were purchased in this order and map to this specific - * benefit of the promotion. + * The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. */ offerIds?: string[]; /** - * Further describes the benefit of the promotion. Note that we will expand - * on this enumeration as we support new promotion sub-types. + * Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. */ subType?: string; /** @@ -2489,8 +2217,7 @@ export namespace content_v2 { */ taxImpact?: Schema$Price; /** - * Describes whether the promotion applies to products (e.g. 20% off) or to - * shipping (e.g. Free Shipping). + * Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). */ type?: string; } @@ -2508,14 +2235,11 @@ export namespace content_v2 { */ id?: string; /** - * Total price for the line item. For example, if two items for $10 are - * purchased, the total price will be $20. + * Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20. */ price?: Schema$Price; /** - * Product data as seen by customer from the time of the order placement. - * Note that certain attributes values (e.g. title or gtin) might be - * reformatted and no longer match values submitted via product feed. + * Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed. */ product?: Schema$OrderLineItemProduct; /** @@ -2555,9 +2279,7 @@ export namespace content_v2 { */ shippingDetails?: Schema$OrderLineItemShippingDetails; /** - * Total tax amount for the line item. For example, if two items are - * purchased, and each have a cost tax of $2, the total tax amount will be - * $4. + * Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4. */ tax?: Schema$Price; } @@ -2623,9 +2345,7 @@ export namespace content_v2 { */ title?: string; /** - * Variant attributes for the item. These are dimensions of the product, - * such as color, gender, material, pattern, and size. You can find a - * comprehensive list of variant attributes here. + * Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here. */ variantAttributes?: Schema$OrderLineItemProductVariantAttribute[]; } @@ -2679,8 +2399,7 @@ export namespace content_v2 { } export interface Schema$OrderLineItemShippingDetailsMethod { /** - * The carrier for the shipping. Optional. See shipments[].carrier for a - * list of acceptable values. + * The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values. */ carrier?: string; /** @@ -2698,13 +2417,11 @@ export namespace content_v2 { } export interface Schema$OrderMerchantProvidedAnnotation { /** - * Key for additional merchant provided (as key-value pairs) annotation - * about the line item. + * Key for additional merchant provided (as key-value pairs) annotation about the line item. */ key?: string; /** - * Value for additional merchant provided (as key-value pairs) annotation - * about the line item. + * Value for additional merchant provided (as key-value pairs) annotation about the line item. */ value?: string; } @@ -2730,9 +2447,7 @@ export namespace content_v2 { */ phoneNumber?: string; /** - * The type of instrument. Acceptable values are: - "AMEX" - - * "DISCOVER" - "JCB" - "MASTERCARD" - - * "UNIONPAY" - "VISA" - "" + * The type of instrument. Acceptable values are: - "AMEX" - "DISCOVER" - "JCB" - "MASTERCARD" - "UNIONPAY" - "VISA" - "" */ type?: string; } @@ -2752,8 +2467,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyAuthApprovedResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthApprovedResponse". */ kind?: string; } @@ -2769,8 +2483,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyAuthDeclinedResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthDeclinedResponse". */ kind?: string; } @@ -2794,8 +2507,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyChargeResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyChargeResponse". */ kind?: string; } @@ -2819,8 +2531,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyRefundResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyRefundResponse". */ kind?: string; } @@ -2877,8 +2588,7 @@ export namespace content_v2 { */ disbursements?: Schema$OrderReportDisbursement[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderreportsListDisbursementsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse". */ kind?: string; /** @@ -2888,8 +2598,7 @@ export namespace content_v2 { } export interface Schema$OrderreportsListTransactionsResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderreportsListTransactionsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse". */ kind?: string; /** @@ -2967,8 +2676,7 @@ export namespace content_v2 { } export interface Schema$OrderreturnsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderreturnsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse". */ kind?: string; /** @@ -2989,15 +2697,13 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersAcknowledgeResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse". */ kind?: string; } export interface Schema$OrdersAdvanceTestOrderResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersAdvanceTestOrderResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse". */ kind?: string; } @@ -3007,20 +2713,15 @@ export namespace content_v2 { */ amount?: Schema$Price; /** - * Amount to refund for the cancelation. Optional. If not set, Google will - * calculate the default based on the price and tax of the items involved. - * The amount must not be larger than the net amount left on the order. + * Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order. */ amountPretax?: Schema$Price; /** - * Tax amount that corresponds to cancellation amount in amountPretax. - * Optional, but if filled, then amountPretax must be set. Calculated - * automatically if not provided. + * Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. */ amountTax?: Schema$Price; /** - * The ID of the line item to cancel. Either lineItemId or productId is - * required. + * The ID of the line item to cancel. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -3028,8 +2729,7 @@ export namespace content_v2 { */ operationId?: string; /** - * The ID of the product to cancel. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3051,8 +2751,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse". */ kind?: string; } @@ -3076,8 +2775,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse". */ kind?: string; } @@ -3089,23 +2787,17 @@ export namespace content_v2 { } export interface Schema$OrdersCancelTestOrderByCustomerResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelTestOrderByCustomerResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse". */ kind?: string; } export interface Schema$OrdersCreateTestOrderRequest { /** - * The CLDR territory code of the country of the test order to create. - * Affects the currency and addresses of orders created via template_name, - * or the addresses of orders created via test_order. Acceptable values - * are: - "US" - "FR" Defaults to US. + * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order. Acceptable values are: - "US" - "FR" Defaults to US. */ country?: string; /** - * The test order template to use. Specify as an alternative to testOrder as - * a shortcut for retrieving a template and then creating an order using - * that template. + * The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. */ templateName?: string; /** @@ -3115,8 +2807,7 @@ export namespace content_v2 { } export interface Schema$OrdersCreateTestOrderResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCreateTestOrderResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse". */ kind?: string; /** @@ -3132,8 +2823,7 @@ export namespace content_v2 { } export interface Schema$OrdersCreateTestReturnResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCreateTestReturnResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse". */ kind?: string; /** @@ -3169,8 +2859,7 @@ export namespace content_v2 { */ merchantId?: string; /** - * The merchant order ID. Required for updateMerchantOrderId and - * getByMerchantOrderId methods. + * The merchant order ID. Required for updateMerchantOrderId and getByMerchantOrderId methods. */ merchantOrderId?: string; /** @@ -3178,13 +2867,11 @@ export namespace content_v2 { */ method?: string; /** - * The ID of the operation. Unique across all operations for a given order. - * Required for all methods beside get and getByMerchantOrderId. + * The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId. */ operationId?: string; /** - * The ID of the order. Required for all methods beside - * getByMerchantOrderId. + * The ID of the order. Required for all methods beside getByMerchantOrderId. */ orderId?: string; /** @@ -3236,25 +2923,19 @@ export namespace content_v2 { */ amount?: Schema$Price; /** - * Amount to refund for the cancelation. Optional. If not set, Google will - * calculate the default based on the price and tax of the items involved. - * The amount must not be larger than the net amount left on the order. + * Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order. */ amountPretax?: Schema$Price; /** - * Tax amount that corresponds to cancellation amount in amountPretax. - * Optional, but if filled, then amountPretax must be set. Calculated - * automatically if not provided. + * Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. */ amountTax?: Schema$Price; /** - * The ID of the line item to cancel. Either lineItemId or productId is - * required. + * The ID of the line item to cancel. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to cancel. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3290,13 +2971,11 @@ export namespace content_v2 { */ amountTax?: Schema$Price; /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3318,14 +2997,11 @@ export namespace content_v2 { */ amount?: Schema$Price; /** - * The amount that is refunded. Either amount or amountPretax should be - * filled. + * The amount that is refunded. Either amount or amountPretax should be filled. */ amountPretax?: Schema$Price; /** - * Tax amount that corresponds to refund amount in amountPretax. Optional, - * but if filled, amountPretax must be set. Calculated automatically if not - * provided. + * Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided. */ amountTax?: Schema$Price; /** @@ -3339,13 +3015,11 @@ export namespace content_v2 { } export interface Schema$OrdersCustomBatchRequestEntryRejectReturnLineItem { /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3363,13 +3037,11 @@ export namespace content_v2 { } export interface Schema$OrdersCustomBatchRequestEntryReturnLineItem { /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3387,24 +3059,19 @@ export namespace content_v2 { } export interface Schema$OrdersCustomBatchRequestEntryReturnRefundLineItem { /** - * The amount that is refunded. If omitted, refundless return is assumed - * (same as calling returnLineItem method). + * The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). */ amountPretax?: Schema$Price; /** - * Tax amount that corresponds to refund amount in amountPretax. Optional, - * but if filled, then amountPretax must be set. Calculated automatically if - * not provided. + * Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. */ amountTax?: Schema$Price; /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3423,21 +3090,17 @@ export namespace content_v2 { export interface Schema$OrdersCustomBatchRequestEntrySetLineItemMetadata { annotations?: Schema$OrderMerchantProvidedAnnotation[]; /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. + * The ID of the line item to set metadata. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. + * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; } export interface Schema$OrdersCustomBatchRequestEntryShipLineItems { /** - * Deprecated. Please use shipmentInfo instead. The carrier handling the - * shipment. See shipments[].carrier in the Orders resource representation - * for a list of acceptable values. + * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ carrier?: string; /** @@ -3445,8 +3108,7 @@ export namespace content_v2 { */ lineItems?: Schema$OrderShipmentLineItemShipment[]; /** - * ID of the shipment group. Required for orders that use the orderinvoices - * service. + * ID of the shipment group. Required for orders that use the orderinvoices service. */ shipmentGroupId?: string; /** @@ -3454,25 +3116,21 @@ export namespace content_v2 { */ shipmentId?: string; /** - * Shipment information. This field is repeated because a single line item - * can be shipped in several packages (and have several tracking IDs). + * Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs). */ shipmentInfos?: Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[]; /** - * Deprecated. Please use shipmentInfo instead. The tracking ID for the - * shipment. + * Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment. */ trackingId?: string; } export interface Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { /** - * The carrier handling the shipment. See shipments[].carrier in the Orders - * resource representation for a list of acceptable values. + * The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ carrier?: string; /** - * The ID of the shipment. This is assigned by the merchant and is unique to - * each shipment. + * The ID of the shipment. This is assigned by the merchant and is unique to each shipment. */ shipmentId?: string; /** @@ -3482,38 +3140,29 @@ export namespace content_v2 { } export interface Schema$OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails { /** - * Updated delivery by date, in ISO 8601 format. If not specified only ship - * by date is updated. Provided date should be within 1 year timeframe and - * can not be a date in the past. + * Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ deliverByDate?: string; /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. + * The ID of the line item to set metadata. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. + * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** - * Updated ship by date, in ISO 8601 format. If not specified only deliver - * by date is updated. Provided date should be within 1 year timeframe and - * can not be a date in the past. + * Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ shipByDate?: string; } export interface Schema$OrdersCustomBatchRequestEntryUpdateShipment { /** - * The carrier handling the shipment. Not updated if missing. See - * shipments[].carrier in the Orders resource representation for a list of - * acceptable values. + * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ carrier?: string; /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Optional and can be provided only if status is delivered. + * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. */ deliveryDate?: string; /** @@ -3535,8 +3184,7 @@ export namespace content_v2 { */ entries?: Schema$OrdersCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse". */ kind?: string; } @@ -3550,26 +3198,21 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * The status of the execution. Only defined if - the request was - * successful; and - the method is not get, getByMerchantOrderId, or one of - * the test methods. + * The status of the execution. Only defined if - the request was successful; and - the method is not get, getByMerchantOrderId, or one of the test methods. */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry". */ kind?: string; /** - * The retrieved order. Only defined if the method is get and if the request - * was successful. + * The retrieved order. Only defined if the method is get and if the request was successful. */ order?: Schema$Order; } export interface Schema$OrdersGetByMerchantOrderIdResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersGetByMerchantOrderIdResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse". */ kind?: string; /** @@ -3579,8 +3222,7 @@ export namespace content_v2 { } export interface Schema$OrdersGetTestOrderTemplateResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersGetTestOrderTemplateResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse". */ kind?: string; /** @@ -3590,14 +3232,7 @@ export namespace content_v2 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - - * "gsx" - "ups" - "usps" - - * "fedex" - "dhl" - "ecourier" - - * "cxt" - "google" - "ontrac" - - * "emsy" - "ont" - "deliv" - - * "dynamex" - "lasership" - "mpx" - - * "uds" Acceptable values for FR are: - - * "colissimo" - "chronopost" + * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" Acceptable values for FR are: - "colissimo" - "chronopost" */ carrier?: string; /** @@ -3605,8 +3240,7 @@ export namespace content_v2 { */ creationDate?: string; /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Present only if status is delivered + * Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered */ deliveryDate?: string; /** @@ -3628,13 +3262,11 @@ export namespace content_v2 { } export interface Schema$OrderShipmentLineItemShipment { /** - * The ID of the line item that is shipped. Either lineItemId or productId - * is required. + * The ID of the line item that is shipped. Either lineItemId or productId is required. */ lineItemId?: string; /** - * The ID of the product to ship. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3652,8 +3284,7 @@ export namespace content_v2 { */ amountTax?: Schema$Price; /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -3661,8 +3292,7 @@ export namespace content_v2 { */ operationId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3684,15 +3314,13 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersInStoreRefundLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse". */ kind?: string; } export interface Schema$OrdersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse". */ kind?: string; /** @@ -3707,14 +3335,11 @@ export namespace content_v2 { */ amount?: Schema$Price; /** - * The amount that is refunded. Either amount or amountPretax should be - * filled. + * The amount that is refunded. Either amount or amountPretax should be filled. */ amountPretax?: Schema$Price; /** - * Tax amount that corresponds to refund amount in amountPretax. Optional, - * but if filled, amountPretax must be set. Calculated automatically if not - * provided. + * Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided. */ amountTax?: Schema$Price; /** @@ -3736,15 +3361,13 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersRefundResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse". */ kind?: string; } export interface Schema$OrdersRejectReturnLineItemRequest { /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -3752,8 +3375,7 @@ export namespace content_v2 { */ operationId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3775,15 +3397,13 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersRejectReturnLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse". */ kind?: string; } export interface Schema$OrdersReturnLineItemRequest { /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -3791,8 +3411,7 @@ export namespace content_v2 { */ operationId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3814,26 +3433,21 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersReturnLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse". */ kind?: string; } export interface Schema$OrdersReturnRefundLineItemRequest { /** - * The amount that is refunded. If omitted, refundless return is assumed - * (same as calling returnLineItem method). + * The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). */ amountPretax?: Schema$Price; /** - * Tax amount that corresponds to refund amount in amountPretax. Optional, - * but if filled, then amountPretax must be set. Calculated automatically if - * not provided. + * Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. */ amountTax?: Schema$Price; /** - * The ID of the line item to return. Either lineItemId or productId is - * required. + * The ID of the line item to return. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -3841,8 +3455,7 @@ export namespace content_v2 { */ operationId?: string; /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. + * The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** @@ -3864,16 +3477,14 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersReturnRefundLineItemResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse". */ kind?: string; } export interface Schema$OrdersSetLineItemMetadataRequest { annotations?: Schema$OrderMerchantProvidedAnnotation[]; /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. + * The ID of the line item to set metadata. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -3881,8 +3492,7 @@ export namespace content_v2 { */ operationId?: string; /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. + * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; } @@ -3892,16 +3502,13 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersSetLineItemMetadataResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse". */ kind?: string; } export interface Schema$OrdersShipLineItemsRequest { /** - * Deprecated. Please use shipmentInfo instead. The carrier handling the - * shipment. See shipments[].carrier in the Orders resource representation - * for a list of acceptable values. + * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ carrier?: string; /** @@ -3913,8 +3520,7 @@ export namespace content_v2 { */ operationId?: string; /** - * ID of the shipment group. Required for orders that use the orderinvoices - * service. + * ID of the shipment group. Required for orders that use the orderinvoices service. */ shipmentGroupId?: string; /** @@ -3922,13 +3528,11 @@ export namespace content_v2 { */ shipmentId?: string; /** - * Shipment information. This field is repeated because a single line item - * can be shipped in several packages (and have several tracking IDs). + * Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs). */ shipmentInfos?: Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[]; /** - * Deprecated. Please use shipmentInfo instead. The tracking ID for the - * shipment. + * Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment. */ trackingId?: string; } @@ -3938,21 +3542,17 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersShipLineItemsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse". */ kind?: string; } export interface Schema$OrdersUpdateLineItemShippingDetailsRequest { /** - * Updated delivery by date, in ISO 8601 format. If not specified only ship - * by date is updated. Provided date should be within 1 year timeframe and - * can not be a date in the past. + * Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ deliverByDate?: string; /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. + * The ID of the line item to set metadata. Either lineItemId or productId is required. */ lineItemId?: string; /** @@ -3960,14 +3560,11 @@ export namespace content_v2 { */ operationId?: string; /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. + * The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. */ productId?: string; /** - * Updated ship by date, in ISO 8601 format. If not specified only deliver - * by date is updated. Provided date should be within 1 year timeframe and - * can not be a date in the past. + * Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past. */ shipByDate?: string; } @@ -3977,15 +3574,13 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateLineItemShippingDetailsResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse". */ kind?: string; } export interface Schema$OrdersUpdateMerchantOrderIdRequest { /** - * The merchant order id to be assigned to the order. Must be unique per - * merchant. + * The merchant order id to be assigned to the order. Must be unique per merchant. */ merchantOrderId?: string; /** @@ -3999,21 +3594,17 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateMerchantOrderIdResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse". */ kind?: string; } export interface Schema$OrdersUpdateShipmentRequest { /** - * The carrier handling the shipment. Not updated if missing. See - * shipments[].carrier in the Orders resource representation for a list of - * acceptable values. + * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. */ carrier?: string; /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Optional and can be provided only if status is delivered. + * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. */ deliveryDate?: string; /** @@ -4039,8 +3630,7 @@ export namespace content_v2 { */ executionStatus?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateShipmentResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse". */ kind?: string; } @@ -4087,8 +3677,7 @@ export namespace content_v2 { */ entries?: Schema$PosCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse". */ kind?: string; } @@ -4106,8 +3695,7 @@ export namespace content_v2 { */ inventory?: Schema$PosInventory; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry". */ kind?: string; /** @@ -4160,8 +3748,7 @@ export namespace content_v2 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posInventory". + * Identifies what kind of resource this is. Value: the fixed string "content#posInventory". */ kind?: string; /** @@ -4173,8 +3760,7 @@ export namespace content_v2 { */ quantity?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -4208,8 +3794,7 @@ export namespace content_v2 { */ quantity?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -4235,8 +3820,7 @@ export namespace content_v2 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posInventoryResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse". */ kind?: string; /** @@ -4248,8 +3832,7 @@ export namespace content_v2 { */ quantity?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -4263,8 +3846,7 @@ export namespace content_v2 { } export interface Schema$PosListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posListResponse". */ kind?: string; resources?: Schema$PosStore[]; @@ -4286,8 +3868,7 @@ export namespace content_v2 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posSale". + * Identifies what kind of resource this is. Value: the fixed string "content#posSale". */ kind?: string; /** @@ -4295,8 +3876,7 @@ export namespace content_v2 { */ price?: Schema$Price; /** - * The relative change of the available quantity. Negative for items - * returned. + * The relative change of the available quantity. Negative for items returned. */ quantity?: string; /** @@ -4304,8 +3884,7 @@ export namespace content_v2 { */ saleId?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -4335,8 +3914,7 @@ export namespace content_v2 { */ price?: Schema$Price; /** - * The relative change of the available quantity. Negative for items - * returned. + * The relative change of the available quantity. Negative for items returned. */ quantity?: string; /** @@ -4344,8 +3922,7 @@ export namespace content_v2 { */ saleId?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -4371,8 +3948,7 @@ export namespace content_v2 { */ itemId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posSaleResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse". */ kind?: string; /** @@ -4380,8 +3956,7 @@ export namespace content_v2 { */ price?: Schema$Price; /** - * The relative change of the available quantity. Negative for items - * returned. + * The relative change of the available quantity. Negative for items returned. */ quantity?: string; /** @@ -4389,8 +3964,7 @@ export namespace content_v2 { */ saleId?: string; /** - * The identifier of the merchant's store. Either a storeCode inserted - * via the API or the code of the store in Google My Business. + * The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. */ storeCode?: string; /** @@ -4407,8 +3981,7 @@ export namespace content_v2 { */ export interface Schema$PosStore { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#posStore". + * Identifies what kind of resource this is. Value: the fixed string "content#posStore". */ kind?: string; /** @@ -4422,8 +3995,7 @@ export namespace content_v2 { } export interface Schema$PostalCodeGroup { /** - * The CLDR territory code of the country the postal code group applies to. - * Required. + * The CLDR territory code of the country the postal code group applies to. Required. */ country?: string; /** @@ -4437,19 +4009,11 @@ export namespace content_v2 { } export interface Schema$PostalCodeRange { /** - * A postal code or a pattern of the form prefix* denoting the inclusive - * lower bound of the range defining the area. Examples values: - * "94108", "9410*", "9*". Required. + * A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required. */ postalCodeRangeBegin?: string; /** - * A postal code or a pattern of the form prefix* denoting the inclusive - * upper bound of the range defining the area. It must have the same length - * as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then - * postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is - * a pattern then postalCodeRangeEnd must be a pattern with the same prefix - * length. Optional: if not set, then the area is defined as being all the - * postal codes matching postalCodeRangeBegin. + * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. */ postalCodeRangeEnd?: string; } @@ -4464,8 +4028,7 @@ export namespace content_v2 { value?: string; } /** - * Product data. After inserting, updating, or deleting a product, it may take - * several minutes before changes take effect. + * Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. */ export interface Schema$Product { /** @@ -4473,8 +4036,7 @@ export namespace content_v2 { */ additionalImageLinks?: string[]; /** - * Additional categories of the item (formatted as in products feed - * specification). + * Additional categories of the item (formatted as in products data specification). */ additionalProductTypes?: string[]; /** @@ -4482,8 +4044,7 @@ export namespace content_v2 { */ adult?: boolean; /** - * Used to group items in an arbitrary way. Only for CPA%, discouraged - * otherwise. + * Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. */ adwordsGrouping?: string; /** @@ -4491,8 +4052,7 @@ export namespace content_v2 { */ adwordsLabels?: string[]; /** - * Allows advertisers to override the item URL when the product is shown - * within the context of Product Ads. + * Allows advertisers to override the item URL when the product is shown within the context of Product Ads. */ adwordsRedirect?: string; /** @@ -4508,8 +4068,7 @@ export namespace content_v2 { */ availability?: string; /** - * The day a pre-ordered product becomes available for delivery, in ISO 8601 - * format. + * The day a pre-ordered product becomes available for delivery, in ISO 8601 format. */ availabilityDate?: string; /** @@ -4537,11 +4096,7 @@ export namespace content_v2 { */ costOfGoodsSold?: Schema$Price; /** - * A list of custom (merchant-provided) attributes. It can also be used for - * submitting any attribute of the feed specification in its generic form - * (e.g., { "name": "size type", "value": - * "regular" }). This is useful for submitting attributes not - * explicitly exposed by the API. + * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. */ customAttributes?: Schema$CustomAttribute[]; /** @@ -4581,8 +4136,7 @@ export namespace content_v2 { */ displayAdsId?: string; /** - * URL directly to your item's landing page for dynamic remarketing - * campaigns. + * URL directly to your item's landing page for dynamic remarketing campaigns. */ displayAdsLink?: string; /** @@ -4602,10 +4156,7 @@ export namespace content_v2 { */ energyEfficiencyClass?: string; /** - * Date on which the item should expire, as specified upon insertion, in ISO - * 8601 format. The actual expiration date in Google Shopping is exposed in - * productstatuses as googleExpirationDate and might be earlier if - * expirationDate is too far in the future. + * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. */ expirationDate?: string; /** @@ -4621,16 +4172,11 @@ export namespace content_v2 { */ gtin?: string; /** - * The REST ID of the product. Content API methods that operate on products - * take this as their productId parameter. The REST ID for a product is of - * the form channel:contentLanguage:targetCountry:offerId. + * The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. */ id?: string; /** - * False when the item does not have unique product identifiers appropriate - * to its category, such as GTIN, MPN, and brand. Required according to the - * Unique Product Identifier Rules for all target countries except for - * Canada. + * False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada. */ identifierExists?: boolean; /** @@ -4642,8 +4188,7 @@ export namespace content_v2 { */ installment?: Schema$Installment; /** - * Whether the item is a merchant-defined bundle. A bundle is a custom - * grouping of different products sold by a merchant for a single price. + * Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. */ isBundle?: boolean; /** @@ -4651,8 +4196,7 @@ export namespace content_v2 { */ itemGroupId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#product". + * Identifies what kind of resource this is. Value: the fixed string "content#product". */ kind?: string; /** @@ -4696,11 +4240,7 @@ export namespace content_v2 { */ multipack?: string; /** - * A unique identifier for the item. Leading and trailing whitespaces are - * stripped and multiple whitespaces are replaced by a single whitespace - * upon submission. Only valid unicode characters are accepted. See the - * products feed specification for details. Note: Content API methods that - * operate on products take the REST ID of the product, not this identifier. + * A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. Note: Content API methods that operate on products take the REST ID of the product, not this identifier. */ offerId?: string; /** @@ -4716,7 +4256,7 @@ export namespace content_v2 { */ price?: Schema$Price; /** - * Your category of the item (formatted as in products feed specification). + * Your category of the item (formatted as in products data specification). */ productType?: string; /** @@ -4728,13 +4268,11 @@ export namespace content_v2 { */ salePrice?: Schema$Price; /** - * Date range during which the item is on sale (see products feed - * specification). + * Date range during which the item is on sale (see products data specification). */ salePriceEffectiveDate?: string; /** - * The quantity of the product that is available for selling on Google. - * Supported only for online products. + * The quantity of the product that is available for selling on Google. Supported only for online products. */ sellOnGoogleQuantity?: string; /** @@ -4746,8 +4284,7 @@ export namespace content_v2 { */ shippingHeight?: Schema$ProductShippingDimension; /** - * The shipping label of the product, used to group product in account-level - * shipping rules. + * The shipping label of the product, used to group product in account-level shipping rules. */ shippingLabel?: string; /** @@ -4799,8 +4336,7 @@ export namespace content_v2 { */ unitPricingMeasure?: Schema$ProductUnitPricingMeasure; /** - * Deprecated. The read-only list of intended destinations which passed - * validation. + * Deprecated. The read-only list of intended destinations which passed validation. */ validatedDestinations?: string[]; /** @@ -4870,8 +4406,7 @@ export namespace content_v2 { */ product?: Schema$Product; /** - * The ID of the product to get or delete. Only defined if the method is get - * or delete. + * The ID of the product to get or delete. Only defined if the method is get or delete. */ productId?: string; } @@ -4881,8 +4416,7 @@ export namespace content_v2 { */ entries?: Schema$ProductsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse". */ kind?: string; } @@ -4899,13 +4433,11 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry". */ kind?: string; /** - * The inserted product. Only defined if the method is insert and if the - * request was successful. + * The inserted product. Only defined if the method is insert and if the request was successful. */ product?: Schema$Product; } @@ -4915,19 +4447,15 @@ export namespace content_v2 { */ country?: string; /** - * The location where the shipping is applicable, represented by a location - * group name. + * The location where the shipping is applicable, represented by a location group name. */ locationGroupName?: string; /** - * The numeric ID of a location that the shipping rate applies to as defined - * in the AdWords API. + * The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. */ locationId?: string; /** - * The postal code range that the shipping rate applies to, represented by a - * postal code, a postal code prefix followed by a * wildcard, a range - * between two postal codes or two postal code prefixes of equal length. + * The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length. */ postalCode?: string; /** @@ -4949,8 +4477,7 @@ export namespace content_v2 { */ unit?: string; /** - * The dimension of the product used to calculate the shipping cost of the - * item. + * The dimension of the product used to calculate the shipping cost of the item. */ value?: number; } @@ -4960,15 +4487,13 @@ export namespace content_v2 { */ unit?: string; /** - * The weight of the product used to calculate the shipping cost of the - * item. + * The weight of the product used to calculate the shipping cost of the item. */ value?: number; } export interface Schema$ProductsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse". */ kind?: string; /** @@ -4978,8 +4503,7 @@ export namespace content_v2 { resources?: Schema$Product[]; } /** - * The status of a product, i.e., information about a product computed - * asynchronously. + * The status of a product, i.e., information about a product computed asynchronously. */ export interface Schema$ProductStatus { /** @@ -5003,8 +4527,7 @@ export namespace content_v2 { */ itemLevelIssues?: Schema$ProductStatusItemLevelIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productStatus". + * Identifies what kind of resource this is. Value: the fixed string "content#productStatus". */ kind?: string; /** @@ -5053,8 +4576,7 @@ export namespace content_v2 { */ destination?: string; /** - * Provided for backward compatibility only. Always set to - * "required". + * Provided for backward compatibility only. Always set to "required". */ intention?: string; } @@ -5073,8 +4595,7 @@ export namespace content_v2 { */ batchId?: number; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; includeAttributes?: boolean; @@ -5094,8 +4615,7 @@ export namespace content_v2 { */ entries?: Schema$ProductstatusesCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productstatusesCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse". */ kind?: string; } @@ -5112,8 +4632,7 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productstatusesCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry". */ kind?: string; /** @@ -5123,8 +4642,7 @@ export namespace content_v2 { } export interface Schema$ProductstatusesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#productstatusesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse". */ kind?: string; /** @@ -5169,20 +4687,15 @@ export namespace content_v2 { } export interface Schema$ProductTax { /** - * The country within which the item is taxed, specified as a CLDR territory - * code. + * The country within which the item is taxed, specified as a CLDR territory code. */ country?: string; /** - * The numeric ID of a location that the tax rate applies to as defined in - * the AdWords API. + * The numeric ID of a location that the tax rate applies to as defined in the AdWords API. */ locationId?: string; /** - * The postal code range that the tax rate applies to, represented by a ZIP - * code, a ZIP code prefix using * wildcard, a range between two ZIP codes - * or two ZIP code prefixes of equal length. Examples: 94114, 94*, - * 94002-95460, 94*-95*. + * The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*. */ postalCode?: string; /** @@ -5220,8 +4733,7 @@ export namespace content_v2 { } export interface Schema$Promotion { /** - * [required] Amount of the promotion. The values here are the promotion - * applied to the unit price pretax and to the total of the tax amounts. + * [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts. */ promotionAmount?: Schema$Amount; /** @@ -5231,35 +4743,27 @@ export namespace content_v2 { } export interface Schema$RateGroup { /** - * A list of shipping labels defining the products to which this rate group - * applies to. This is a disjunction: only one of the labels has to match - * for the rate group to apply. May only be empty for the last rate group of - * a service. Required. + * A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required. */ applicableShippingLabels?: string[]; /** - * A list of carrier rates that can be referred to by mainTable or - * singleValue. + * A list of carrier rates that can be referred to by mainTable or singleValue. */ carrierRates?: Schema$CarrierRate[]; /** - * A table defining the rate group, when singleValue is not expressive - * enough. Can only be set if singleValue is not set. + * A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set. */ mainTable?: Schema$Table; /** - * Name of the rate group. Optional. If set has to be unique within shipping - * service. + * Name of the rate group. Optional. If set has to be unique within shipping service. */ name?: string; /** - * The value of the rate group (e.g. flat rate $10). Can only be set if - * mainTable and subtables are not set. + * The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set. */ singleValue?: Schema$Value; /** - * A list of subtables referred to by mainTable. Can only be set if - * mainTable is set. + * A list of subtables referred to by mainTable. Can only be set if mainTable is set. */ subtables?: Schema$Table[]; } @@ -5278,9 +4782,7 @@ export namespace content_v2 { } export interface Schema$Row { /** - * The list of cells that constitute the row. Must have the same length as - * columnHeaders for two-dimensional tables, a length of 1 for - * one-dimensional tables. Required. + * The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required. */ cells?: Schema$Value[]; } @@ -5290,18 +4792,15 @@ export namespace content_v2 { */ active?: boolean; /** - * The CLDR code of the currency to which this service applies. Must match - * that of the prices in rate groups. + * The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. */ currency?: string; /** - * The CLDR territory code of the country to which the service applies. - * Required. + * The CLDR territory code of the country to which the service applies. Required. */ deliveryCountry?: string; /** - * Time spent in various aspects from order to the delivery of the product. - * Required. + * Time spent in various aspects from order to the delivery of the product. Required. */ deliveryTime?: Schema$DeliveryTime; /** @@ -5309,20 +4808,15 @@ export namespace content_v2 { */ eligibility?: string; /** - * Minimum order value for this service. If set, indicates that customers - * will have to spend at least this amount. All prices within a service must - * have the same currency. + * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. */ minimumOrderValue?: Schema$Price; /** - * Free-form name of the service. Must be unique within target account. - * Required. + * Free-form name of the service. Must be unique within target account. Required. */ name?: string; /** - * Shipping rate group definitions. Only the last one is allowed to have an - * empty applicableShippingLabels, which means "everything else". - * The other applicableShippingLabels must not overlap. + * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. */ rateGroups?: Schema$RateGroup[]; } @@ -5336,9 +4830,7 @@ export namespace content_v2 { */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * [required] ID of the shipment group. It is assigned by the merchant in - * the shipLineItems method and is used to group multiple line items that - * have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string; } @@ -5348,15 +4840,11 @@ export namespace content_v2 { */ lineItemId?: string; /** - * ID of the product. This is the REST ID used in the products service. - * Either lineItemId or productId must be set. + * ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set. */ productId?: string; /** - * [required] The shipment unit ID is assigned by the merchant and defines - * individual quantities within a line item. The same ID can be assigned to - * units that are the same while units that differ must be assigned a - * different ID (for example: free or promotional units). + * [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units). */ shipmentUnitIds?: string[]; /** @@ -5369,18 +4857,15 @@ export namespace content_v2 { trackingNumber?: string; } /** - * The merchant account's shipping settings. All methods except - * getsupportedcarriers and getsupportedholidays require the admin role. + * The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. */ export interface Schema$ShippingSettings { /** - * The ID of the account to which these account shipping settings belong. - * Ignored upon update, always present in get request responses. + * The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses. */ accountId?: string; /** - * A list of postal code groups that can be referred to in services. - * Optional. + * A list of postal code groups that can be referred to in services. Optional. */ postalCodeGroups?: Schema$PostalCodeGroup[]; /** @@ -5412,8 +4897,7 @@ export namespace content_v2 { merchantId?: string; method?: string; /** - * The account shipping settings to update. Only defined if the method is - * update. + * The account shipping settings to update. Only defined if the method is update. */ shippingSettings?: Schema$ShippingSettings; } @@ -5423,8 +4907,7 @@ export namespace content_v2 { */ entries?: Schema$ShippingsettingsCustomBatchResponseEntry[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsCustomBatchResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse". */ kind?: string; } @@ -5441,8 +4924,7 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry". */ kind?: string; /** @@ -5456,8 +4938,7 @@ export namespace content_v2 { */ carriers?: Schema$CarriersCarrier[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsGetSupportedCarriersResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse". */ kind?: string; } @@ -5467,15 +4948,13 @@ export namespace content_v2 { */ holidays?: Schema$HolidaysHoliday[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsGetSupportedHolidaysResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse". */ kind?: string; } export interface Schema$ShippingsettingsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#shippingsettingsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse". */ kind?: string; /** @@ -5486,8 +4965,7 @@ export namespace content_v2 { } export interface Schema$Table { /** - * Headers of the table's columns. Optional: if not set then the table - * has only one dimension. + * Headers of the table's columns. Optional: if not set then the table has only one dimension. */ columnHeaders?: Schema$Headers; /** @@ -5499,8 +4977,7 @@ export namespace content_v2 { */ rowHeaders?: Schema$Headers; /** - * The list of rows that constitute the table. Must have the same length as - * rowHeaders. Required. + * The list of rows that constitute the table. Must have the same length as rowHeaders. Required. */ rows?: Schema$Row[]; } @@ -5514,8 +4991,7 @@ export namespace content_v2 { */ enableOrderinvoices?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#testOrder". + * Identifies what kind of resource this is. Value: the fixed string "content#testOrder". */ kind?: string; /** @@ -5523,8 +4999,7 @@ export namespace content_v2 { */ lineItems?: Schema$TestOrderLineItem[]; /** - * Determines if test order must be pulled by merchant or pushed to merchant - * via push integration. + * Determines if test order must be pulled by merchant or pushed to merchant via push integration. */ notificationMode?: string; /** @@ -5540,9 +5015,7 @@ export namespace content_v2 { */ promotions?: Schema$OrderLegacyPromotion[]; /** - * The price of shipping for all items. Shipping tax is automatically - * calculated for MFL orders. For non-MFL orders, tax settings from Merchant - * Center are applied. Note that shipping is not taxed in certain states. + * The price of shipping for all items. Shipping tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states. */ shippingCost?: Schema$Price; /** @@ -5574,13 +5047,11 @@ export namespace content_v2 { } export interface Schema$TestOrderCustomerMarketingRightsInfo { /** - * Last know user use selection regards marketing preferences. In certain - * cases selection might not be known, so this field would be empty. + * Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. */ explicitMarketingPreference?: string; /** - * Timestamp when last time marketing preference was updated. Could be - * empty, if user wasn't offered a selection yet. + * Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. */ lastUpdatedTimestamp?: string; } @@ -5644,9 +5115,7 @@ export namespace content_v2 { */ offerId?: string; /** - * The price for the product. Tax is automatically calculated for MFL - * orders. For non-MFL orders, tax settings from Merchant Center are - * applied. + * The price for the product. Tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied. */ price?: Schema$Price; /** @@ -5680,24 +5149,18 @@ export namespace content_v2 { */ predefinedBillingAddress?: string; /** - * The type of instrument. Note that real orders might have different values - * than the four values accepted by createTestOrder. + * The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder. */ type?: string; } export interface Schema$TransitTable { /** - * A list of postal group names. The last value can be "all other - * locations". Example: ["zone 1", "zone 2", - * "all other locations"]. The referred postal code groups must - * match the delivery country of the service. + * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. */ postalCodeGroupNames?: string[]; rows?: Schema$TransitTableTransitTimeRow[]; /** - * A list of transit time labels. The last value can be "all other - * labels". Example: ["food", "electronics", - * "all other labels"]. + * A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"]. */ transitTimeLabels?: string[]; } @@ -5710,8 +5173,7 @@ export namespace content_v2 { */ maxTransitTimeInDays?: number; /** - * Transit time range (min-max) in business days. 0 means same day delivery, - * 1 means next day delivery. + * Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery. */ minTransitTimeInDays?: number; } @@ -5753,8 +5215,7 @@ export namespace content_v2 { */ taxAmount?: Schema$Price; /** - * Optional name of the tax type. This should only be provided if taxType is - * otherFeeTax. + * Optional name of the tax type. This should only be provided if taxType is otherFeeTax. */ taxName?: string; /** @@ -5763,14 +5224,11 @@ export namespace content_v2 { taxType?: string; } /** - * The single value of a rate group or the value of a rate group table's - * cell. Exactly one of noShipping, flatRate, pricePercentage, - * carrierRateName, subtableName must be set. + * The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. */ export interface Schema$Value { /** - * The name of a carrier rate referring to a carrier rate defined in the - * same rate group. Can only be set if all other fields are not set. + * The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. */ carrierRateName?: string; /** @@ -5778,18 +5236,15 @@ export namespace content_v2 { */ flatRate?: Schema$Price; /** - * If true, then the product can't ship. Must be true when set, can only - * be set if all other fields are not set. + * If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set. */ noShipping?: boolean; /** - * A percentage of the price represented as a number in decimal notation - * (e.g., "5.4"). Can only be set if all other fields are not set. + * A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set. */ pricePercentage?: string; /** - * The name of a subtable. Can only be set in table cells (i.e., not for - * single values), and only if all other fields are not set. + * The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set. */ subtableName?: string; } @@ -5974,8 +5429,7 @@ export namespace content_v2 { /** * content.accounts.custombatch - * @desc Retrieves, inserts, updates, and deletes multiple Merchant Center - * (sub-)accounts in a single request. + * @desc Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. * @alias content.accounts.custombatch * @memberOf! () * @@ -6274,8 +5728,7 @@ export namespace content_v2 { /** * content.accounts.link - * @desc Performs an action on a link between a Merchant Center account and - * another account. + * @desc Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId. * @alias content.accounts.link * @memberOf! () * @@ -6428,8 +5881,7 @@ export namespace content_v2 { /** * content.accounts.patch - * @desc Updates a Merchant Center account. This method supports patch - * semantics. + * @desc Updates a Merchant Center account. This method supports patch semantics. * @alias content.accounts.patch * @memberOf! () * @@ -6593,15 +6045,11 @@ export namespace content_v2 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; /** - * Only available to selected merchants. When set to True, this flag removes - * any existing claim on the requested website by another account and - * replaces it with a claim from this account. + * Only available to selected merchants. When set to True, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account. */ overwrite?: boolean; } @@ -6613,9 +6061,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -6635,9 +6081,7 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** @@ -6645,8 +6089,7 @@ export namespace content_v2 { */ force?: boolean; /** - * The ID of the managing account. This must be a multi-client account, and - * accountId must be the ID of a sub-account of this account. + * The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -6661,9 +6104,7 @@ export namespace content_v2 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -6674,9 +6115,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** @@ -6700,9 +6139,7 @@ export namespace content_v2 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -6718,8 +6155,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of accounts to return in the response, used for - * paging. + * The maximum number of accounts to return in the response, used for paging. */ maxResults?: number; /** @@ -6742,15 +6178,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -6770,15 +6202,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -6796,8 +6224,7 @@ export namespace content_v2 { /** * content.accountstatuses.custombatch - * @desc Retrieves multiple Merchant Center account statuses in a single - * request. + * @desc Retrieves multiple Merchant Center account statuses in a single request. * @alias content.accountstatuses.custombatch * @memberOf! () * @@ -6880,8 +6307,7 @@ export namespace content_v2 { /** * content.accountstatuses.get - * @desc Retrieves the status of a Merchant Center account. No - * itemLevelIssues are returned for multi-client accounts. + * @desc Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. * @alias content.accountstatuses.get * @memberOf! () * @@ -6956,8 +6382,7 @@ export namespace content_v2 { /** * content.accountstatuses.list - * @desc Lists the statuses of the sub-accounts in your Merchant Center - * account. + * @desc Lists the statuses of the sub-accounts in your Merchant Center account. * @alias content.accountstatuses.list * @memberOf! () * @@ -7064,14 +6489,11 @@ export namespace content_v2 { */ accountId?: string; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -7083,13 +6505,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * The maximum number of account statuses to return in the response, used - * for paging. + * The maximum number of account statuses to return in the response, used for paging. */ maxResults?: number; /** @@ -7110,8 +6530,7 @@ export namespace content_v2 { /** * content.accounttax.custombatch - * @desc Retrieves and updates tax settings of multiple accounts in a single - * request. + * @desc Retrieves and updates tax settings of multiple accounts in a single request. * @alias content.accounttax.custombatch * @memberOf! () * @@ -7268,8 +6687,7 @@ export namespace content_v2 { /** * content.accounttax.list - * @desc Lists the tax settings of the sub-accounts in your Merchant Center - * account. + * @desc Lists the tax settings of the sub-accounts in your Merchant Center account. * @alias content.accounttax.list * @memberOf! () * @@ -7346,8 +6764,7 @@ export namespace content_v2 { /** * content.accounttax.patch - * @desc Updates the tax settings of the account. This method supports patch - * semantics. + * @desc Updates the tax settings of the account. This method supports patch semantics. * @alias content.accounttax.patch * @memberOf! () * @@ -7505,9 +6922,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -7527,9 +6942,7 @@ export namespace content_v2 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -7540,8 +6953,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of tax settings to return in the response, used for - * paging. + * The maximum number of tax settings to return in the response, used for paging. */ maxResults?: number; /** @@ -7564,15 +6976,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -7593,15 +7001,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -7619,8 +7023,7 @@ export namespace content_v2 { /** * content.datafeeds.custombatch - * @desc Deletes, fetches, gets, inserts and updates multiple datafeeds in a - * single request. + * @desc Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request. * @alias content.datafeeds.custombatch * @memberOf! () * @@ -7859,8 +7262,7 @@ export namespace content_v2 { /** * content.datafeeds.get - * @desc Retrieves a datafeed configuration from your Merchant Center - * account. + * @desc Retrieves a datafeed configuration from your Merchant Center account. * @alias content.datafeeds.get * @memberOf! () * @@ -7931,8 +7333,7 @@ export namespace content_v2 { /** * content.datafeeds.insert - * @desc Registers a datafeed configuration with your Merchant Center - * account. + * @desc Registers a datafeed configuration with your Merchant Center account. * @alias content.datafeeds.insert * @memberOf! () * @@ -8005,8 +7406,7 @@ export namespace content_v2 { /** * content.datafeeds.list - * @desc Lists the configurations for datafeeds in your Merchant Center - * account. + * @desc Lists the configurations for datafeeds in your Merchant Center account. * @alias content.datafeeds.list * @memberOf! () * @@ -8083,8 +7483,7 @@ export namespace content_v2 { /** * content.datafeeds.patch - * @desc Updates a datafeed configuration of your Merchant Center account. - * This method supports patch semantics. + * @desc Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics. * @alias content.datafeeds.patch * @memberOf! () * @@ -8237,9 +7636,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -8259,14 +7656,11 @@ export namespace content_v2 { */ datafeedId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -8282,14 +7676,11 @@ export namespace content_v2 { */ datafeedId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -8304,8 +7695,7 @@ export namespace content_v2 { */ datafeedId?: string; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -8316,14 +7706,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; @@ -8339,13 +7726,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of products to return in the response, used for - * paging. + * The maximum number of products to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the datafeeds. This account cannot be - * a multi-client account. + * The ID of the account that manages the datafeeds. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -8364,14 +7749,11 @@ export namespace content_v2 { */ datafeedId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; @@ -8391,14 +7773,11 @@ export namespace content_v2 { */ datafeedId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; @@ -8416,8 +7795,7 @@ export namespace content_v2 { /** * content.datafeedstatuses.custombatch - * @desc Gets multiple Merchant Center datafeed statuses in a single - * request. + * @desc Gets multiple Merchant Center datafeed statuses in a single request. * @alias content.datafeedstatuses.custombatch * @memberOf! () * @@ -8502,8 +7880,7 @@ export namespace content_v2 { /** * content.datafeedstatuses.get - * @desc Retrieves the status of a datafeed from your Merchant Center - * account. + * @desc Retrieves the status of a datafeed from your Merchant Center account. * @alias content.datafeedstatuses.get * @memberOf! () * @@ -8579,8 +7956,7 @@ export namespace content_v2 { /** * content.datafeedstatuses.list - * @desc Lists the statuses of the datafeeds in your Merchant Center - * account. + * @desc Lists the statuses of the datafeeds in your Merchant Center account. * @alias content.datafeedstatuses.list * @memberOf! () * @@ -8683,10 +8059,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The country for which to get the datafeed status. If this parameter is - * provided then language must also be provided. Note that this parameter is - * required for feeds targeting multiple countries and languages, since a - * feed may have a different status for each target. + * The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target. */ country?: string; /** @@ -8694,15 +8067,11 @@ export namespace content_v2 { */ datafeedId?: string; /** - * The language for which to get the datafeed status. If this parameter is - * provided then country must also be provided. Note that this parameter is - * required for feeds targeting multiple countries and languages, since a - * feed may have a different status for each target. + * The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target. */ language?: string; /** - * The ID of the account that manages the datafeed. This account cannot be a - * multi-client account. + * The ID of the account that manages the datafeed. This account cannot be a multi-client account. */ merchantId?: string; } @@ -8714,13 +8083,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of products to return in the response, used for - * paging. + * The maximum number of products to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the datafeeds. This account cannot be - * a multi-client account. + * The ID of the account that manages the datafeeds. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -8737,9 +8104,7 @@ export namespace content_v2 { /** * content.inventory.custombatch - * @desc Updates price and availability for multiple products or stores in a - * single request. This operation does not update the expiration date of the - * products. + * @desc Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. * @alias content.inventory.custombatch * @memberOf! () * @@ -8823,8 +8188,7 @@ export namespace content_v2 { /** * content.inventory.set - * @desc Updates price and availability of a product in your Merchant Center - * account. + * @desc Updates price and availability of a product in your Merchant Center account. * @alias content.inventory.set * @memberOf! () * @@ -8910,9 +8274,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -8928,14 +8290,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -8943,8 +8302,7 @@ export namespace content_v2 { */ productId?: string; /** - * The code of the store for which to update price and availability. Use - * online to update price and availability of an online product. + * The code of the store for which to update price and availability. Use online to update price and availability of an online product. */ storeCode?: string; @@ -8962,8 +8320,7 @@ export namespace content_v2 { /** * content.liasettings.custombatch - * @desc Retrieves and/or updates the LIA settings of multiple accounts in a - * single request. + * @desc Retrieves and/or updates the LIA settings of multiple accounts in a single request. * @alias content.liasettings.custombatch * @memberOf! () * @@ -9220,8 +8577,7 @@ export namespace content_v2 { /** * content.liasettings.list - * @desc Lists the LIA settings of the sub-accounts in your Merchant Center - * account. + * @desc Lists the LIA settings of the sub-accounts in your Merchant Center account. * @alias content.liasettings.list * @memberOf! () * @@ -9298,8 +8654,7 @@ export namespace content_v2 { /** * content.liasettings.listposdataproviders - * @desc Retrieves the list of POS data providers that have active settings - * for the all eiligible countries. + * @desc Retrieves the list of POS data providers that have active settings for the all eiligible countries. * @alias content.liasettings.listposdataproviders * @memberOf! () * @@ -9389,8 +8744,7 @@ export namespace content_v2 { /** * content.liasettings.patch - * @desc Updates the LIA settings of the account. This method supports patch - * semantics. + * @desc Updates the LIA settings of the account. This method supports patch semantics. * @alias content.liasettings.patch * @memberOf! () * @@ -9941,9 +9295,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -9963,9 +9315,7 @@ export namespace content_v2 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -9977,14 +9327,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account for which to retrieve accessible Google My Business - * accounts. + * The ID of the account for which to retrieve accessible Google My Business accounts. */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -9995,8 +9342,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of LIA settings to return in the response, used for - * paging. + * The maximum number of LIA settings to return in the response, used for paging. */ maxResults?: number; /** @@ -10027,15 +9373,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -10060,9 +9402,7 @@ export namespace content_v2 { */ gmbEmail?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -10074,8 +9414,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ accountId?: string; /** @@ -10083,9 +9422,7 @@ export namespace content_v2 { */ country?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -10097,8 +9434,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ accountId?: string; /** @@ -10118,9 +9454,7 @@ export namespace content_v2 { */ language?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -10132,8 +9466,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account for which to retrieve accessible Google My Business - * accounts. + * The ID of the account for which to retrieve accessible Google My Business accounts. */ accountId?: string; /** @@ -10141,9 +9474,7 @@ export namespace content_v2 { */ country?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; /** @@ -10167,15 +9498,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -10193,8 +9520,7 @@ export namespace content_v2 { /** * content.orderinvoices.createchargeinvoice - * @desc Creates a charge invoice for a shipment group, and triggers a - * charge capture for non-facilitated payment orders. + * @desc Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders. * @alias content.orderinvoices.createchargeinvoice * @memberOf! () * @@ -10287,11 +9613,7 @@ export namespace content_v2 { /** * content.orderinvoices.createrefundinvoice - * @desc Creates a refund invoice for one or more shipment groups, and - * triggers a refund for non-facilitated payment orders. This can only be - * used for line items that have previously been charged using - * createChargeInvoice. All amounts (except for the summary) are incremental - * with respect to the previous invoice. + * @desc Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice. * @alias content.orderinvoices.createrefundinvoice * @memberOf! () * @@ -10391,8 +9713,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10413,8 +9734,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10436,8 +9756,7 @@ export namespace content_v2 { /** * content.orderpayments.notifyauthapproved - * @desc Notify about successfully authorizing user's payment method for a - * given amount. + * @desc Notify about successfully authorizing user's payment method for a given amount. * @alias content.orderpayments.notifyauthapproved * @memberOf! () * @@ -10800,8 +10119,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10822,8 +10140,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10844,8 +10161,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10866,8 +10182,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -10889,8 +10204,7 @@ export namespace content_v2 { /** * content.orderreports.listdisbursements - * @desc Retrieves a report for disbursements from your Merchant Center - * account. + * @desc Retrieves a report for disbursements from your Merchant Center account. * @alias content.orderreports.listdisbursements * @memberOf! () * @@ -10984,8 +10298,7 @@ export namespace content_v2 { /** * content.orderreports.listtransactions - * @desc Retrieves a list of transactions for a disbursement from your - * Merchant Center account. + * @desc Retrieves a list of transactions for a disbursement from your Merchant Center account. * @alias content.orderreports.listtransactions * @memberOf! () * @@ -11092,8 +10405,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The last date which disbursements occurred. In ISO 8601 format. Default: - * current date. + * The last date which disbursements occurred. In ISO 8601 format. Default: current date. */ disbursementEndDate?: string; /** @@ -11101,13 +10413,11 @@ export namespace content_v2 { */ disbursementStartDate?: string; /** - * The maximum number of disbursements to return in the response, used for - * paging. + * The maximum number of disbursements to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11127,13 +10437,11 @@ export namespace content_v2 { */ disbursementId?: string; /** - * The maximum number of disbursements to return in the response, used for - * paging. + * The maximum number of disbursements to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11141,8 +10449,7 @@ export namespace content_v2 { */ pageToken?: string; /** - * The last date in which transaction occurred. In ISO 8601 format. Default: - * current date. + * The last date in which transaction occurred. In ISO 8601 format. Default: current date. */ transactionEndDate?: string; /** @@ -11319,8 +10626,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11336,24 +10642,19 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Obtains order returns created before this date (inclusively), in ISO 8601 - * format. + * Obtains order returns created before this date (inclusively), in ISO 8601 format. */ createdEndDate?: string; /** - * Obtains order returns created after this date (inclusively), in ISO 8601 - * format. + * Obtains order returns created after this date (inclusively), in ISO 8601 format. */ createdStartDate?: string; /** - * The maximum number of order returns to return in the response, used for - * paging. The default value is 25 returns per page, and the maximum allowed - * value is 250 returns per page. + * The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -11456,8 +10757,7 @@ export namespace content_v2 { /** * content.orders.advancetestorder - * @desc Sandbox only. Moves a test order from state "inProgress" to state - * "pendingShipment". + * @desc Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". * @alias content.orders.advancetestorder * @memberOf! () * @@ -11701,8 +11001,7 @@ export namespace content_v2 { /** * content.orders.canceltestorderbycustomer - * @desc Sandbox only. Cancels a test order for customer-initiated - * cancellation. + * @desc Sandbox only. Cancels a test order for customer-initiated cancellation. * @alias content.orders.canceltestorderbycustomer * @memberOf! () * @@ -12199,8 +11498,7 @@ export namespace content_v2 { /** * content.orders.gettestordertemplate - * @desc Sandbox only. Retrieves an order template that can be used to - * quickly create a new order in sandbox. + * @desc Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. * @alias content.orders.gettestordertemplate * @memberOf! () * @@ -12285,15 +11583,7 @@ export namespace content_v2 { /** * content.orders.instorerefundlineitem - * @desc Notifies that item return and refund was handled directly by - * merchant outside of Google payments processing (e.g. cash refund done in - * store). Note: We recommend calling the returnrefundlineitem method to - * refund in-store returns. We will issue the refund directly to the - * customer. This helps to prevent possible differences arising between - * merchant and Google transaction records. We also recommend having the - * point of sale system communicate with Google to ensure that customers do - * not receive a double refund by first refunding via Google then via an - * in-store return. + * @desc Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return. * @alias content.orders.instorerefundlineitem * @memberOf! () * @@ -12706,8 +11996,7 @@ export namespace content_v2 { /** * content.orders.returnrefundlineitem - * @desc Returns and refunds a line item. Note that this method can only be - * called on fully shipped orders. + * @desc Returns and refunds a line item. Note that this method can only be called on fully shipped orders. * @alias content.orders.returnrefundlineitem * @memberOf! () * @@ -12792,11 +12081,7 @@ export namespace content_v2 { /** * content.orders.setlineitemmetadata - * @desc Sets (or overrides if it already exists) merchant provided - * annotations in the form of key-value pairs. A common use case would be to - * supply us with additional structured information about a line item that - * cannot be provided via other methods. Submitted key-value pairs can be - * retrieved as part of the orders resource. + * @desc Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. * @alias content.orders.setlineitemmetadata * @memberOf! () * @@ -13244,8 +12529,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13266,8 +12550,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13282,8 +12565,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13304,8 +12586,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13326,8 +12607,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13348,8 +12628,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that should manage the order. This cannot be a - * multi-client account. + * The ID of the account that should manage the order. This cannot be a multi-client account. */ merchantId?: string; @@ -13366,8 +12645,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13399,8 +12677,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13416,8 +12693,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13437,8 +12713,7 @@ export namespace content_v2 { */ country?: string; /** - * The ID of the account that should manage the order. This cannot be a - * multi-client account. + * The ID of the account that should manage the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13454,8 +12729,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13475,32 +12749,19 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Obtains orders that match the acknowledgement status. When set to true, - * obtains orders that have been acknowledged. When false, obtains orders - * that have not been acknowledged. We recommend using this filter set to - * false, in conjunction with the acknowledge call, such that only - * un-acknowledged orders are returned. + * Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned. */ acknowledged?: boolean; /** - * The maximum number of orders to return in the response, used for paging. - * The default value is 25 orders per page, and the maximum allowed value is - * 250 orders per page. Known issue: All List calls will return all Orders - * without limit regardless of the value of this field. + * The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field. */ maxResults?: number; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** - * The ordering of the returned list. The only supported value are - * placedDate desc and placedDate asc for now, which returns orders sorted - * by placement date. "placedDate desc" stands for listing orders by - * placement date, from oldest to most recent. "placedDate asc" stands for - * listing orders by placement date, from most recent to oldest. In future - * releases we'll support other sorting criteria. + * The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. */ orderBy?: string; /** @@ -13516,11 +12777,7 @@ export namespace content_v2 { */ placedDateStart?: string; /** - * Obtains orders that match any of the specified statuses. Multiple values - * can be specified with comma separation. Additionally, please note that - * active is a shortcut for pendingShipment and partiallyShipped, and - * completed is a shortcut for shipped , partiallyDelivered, delivered, - * partiallyReturned, returned, and canceled. + * Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. */ statuses?: string[]; } @@ -13531,8 +12788,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13553,8 +12809,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13575,8 +12830,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13597,8 +12851,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13619,8 +12872,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13641,8 +12893,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13663,8 +12914,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13685,8 +12935,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -13707,8 +12956,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. + * The ID of the account that manages the order. This cannot be a multi-client account. */ merchantId?: string; /** @@ -14262,9 +13510,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -14280,9 +13526,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** @@ -14324,9 +13568,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** @@ -14350,9 +13592,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** @@ -14391,9 +13631,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** @@ -14419,8 +13657,7 @@ export namespace content_v2 { /** * content.products.custombatch - * @desc Retrieves, inserts, and deletes multiple products in a single - * request. + * @desc Retrieves, inserts, and deletes multiple products in a single request. * @alias content.products.custombatch * @memberOf! () * @@ -14645,9 +13882,7 @@ export namespace content_v2 { /** * content.products.insert - * @desc Uploads a product to your Merchant Center account. If an item with - * the same channel, contentLanguage, offerId, and targetCountry already - * exists, this method updates that entry. + * @desc Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. * @alias content.products.insert * @memberOf! () * @@ -14805,9 +14040,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -14823,14 +14056,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -14845,8 +14075,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -14861,14 +14090,11 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; @@ -14884,19 +14110,15 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to include the invalid inserted items in the result of the list - * request. By default the invalid items are not shown (the default value is - * false). + * Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false). */ includeInvalidInsertedItems?: boolean; /** - * The maximum number of products to return in the response, used for - * paging. + * The maximum number of products to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that contains the products. This account cannot be - * a multi-client account. + * The ID of the account that contains the products. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -15166,8 +14388,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to include full product data in the results of this request. The - * default value is false. + * Flag to include full product data in the results of this request. The default value is false. */ includeAttributes?: boolean; @@ -15184,18 +14405,15 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * Flag to include full product data in the result of this get request. The - * default value is false. + * Flag to include full product data in the result of this get request. The default value is false. */ includeAttributes?: boolean; /** - * The ID of the account that contains the product. This account cannot be a - * multi-client account. + * The ID of the account that contains the product. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -15211,29 +14429,23 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set, only issues for the specified destinations are returned, - * otherwise only issues for the Shopping destination. + * If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. */ destinations?: string[]; /** - * Flag to include full product data in the results of the list request. The - * default value is false. + * Flag to include full product data in the results of the list request. The default value is false. */ includeAttributes?: boolean; /** - * Flag to include the invalid inserted items in the result of the list - * request. By default the invalid items are not shown (the default value is - * false). + * Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false). */ includeInvalidInsertedItems?: boolean; /** - * The maximum number of product statuses to return in the response, used - * for paging. + * The maximum number of product statuses to return in the response, used for paging. */ maxResults?: number; /** - * The ID of the account that contains the products. This account cannot be - * a multi-client account. + * The ID of the account that contains the products. This account cannot be a multi-client account. */ merchantId?: string; /** @@ -15250,8 +14462,7 @@ export namespace content_v2 { /** * content.shippingsettings.custombatch - * @desc Retrieves and updates the shipping settings of multiple accounts in - * a single request. + * @desc Retrieves and updates the shipping settings of multiple accounts in a single request. * @alias content.shippingsettings.custombatch * @memberOf! () * @@ -15607,8 +14818,7 @@ export namespace content_v2 { /** * content.shippingsettings.list - * @desc Lists the shipping settings of the sub-accounts in your Merchant - * Center account. + * @desc Lists the shipping settings of the sub-accounts in your Merchant Center account. * @alias content.shippingsettings.list * @memberOf! () * @@ -15692,8 +14902,7 @@ export namespace content_v2 { /** * content.shippingsettings.patch - * @desc Updates the shipping settings of the account. This method supports - * patch semantics. + * @desc Updates the shipping settings of the account. This method supports patch semantics. * @alias content.shippingsettings.patch * @memberOf! () * @@ -15852,9 +15061,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; @@ -15875,9 +15082,7 @@ export namespace content_v2 { */ accountId?: string; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; } @@ -15913,8 +15118,7 @@ export namespace content_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of shipping settings to return in the response, used - * for paging. + * The maximum number of shipping settings to return in the response, used for paging. */ maxResults?: number; /** @@ -15938,15 +15142,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; @@ -15967,15 +15167,11 @@ export namespace content_v2 { */ accountId?: string; /** - * Flag to simulate a request like in a live environment. If set to true, - * dry-run mode checks the validity of the request and returns errors (if - * any). + * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). */ dryRun?: boolean; /** - * The ID of the managing account. If this parameter is not the same as - * accountId, then this account must be a multi-client account and accountId - * must be the ID of a sub-account of this account. + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. */ merchantId?: string; diff --git a/src/apis/customsearch/package.json b/src/apis/customsearch/package.json index 7f5e7ab473f..d13bb130e5c 100644 --- a/src/apis/customsearch/package.json +++ b/src/apis/customsearch/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index 0d0aa0c845a..7d307bf0e4f 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace customsearch_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace customsearch_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace customsearch_v1 { cse: Resource$Cse; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.cse = new Resource$Cse(this.context); } @@ -213,8 +213,7 @@ export namespace customsearch_v1 { /** * search.cse.list - * @desc Returns metadata about the search performed, metadata about the - * custom search engine used for the search, and the search results. + * @desc Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. * @alias search.cse.list * @memberOf! () * @@ -338,13 +337,11 @@ export namespace customsearch_v1 { */ exactTerms?: string; /** - * Identifies a word or phrase that should not appear in any documents in - * the search results + * Identifies a word or phrase that should not appear in any documents in the search results */ excludeTerms?: string; /** - * Returns images of a specified type. Some of the allowed values are: bmp, - * gif, png, jpg, svg, pdf, ... + * Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... */ fileType?: string; /** @@ -360,8 +357,7 @@ export namespace customsearch_v1 { */ googlehost?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append - * it to query + * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query */ highRange?: string; /** @@ -373,33 +369,27 @@ export namespace customsearch_v1 { */ hq?: string; /** - * Returns black and white, grayscale, or color images: mono, gray, and - * color. + * Returns black and white, grayscale, or color images: mono, gray, and color. */ imgColorType?: string; /** - * Returns images of a specific dominant color: red, orange, yellow, green, - * teal, blue, purple, pink, white, gray, black and brown. + * Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. */ imgDominantColor?: string; /** - * Returns images of a specified size, where size can be one of: icon, - * small, medium, large, xlarge, xxlarge, and huge. + * Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. */ imgSize?: string; /** - * Returns images of a type, which can be one of: clipart, face, lineart, - * news, and photo. + * Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. */ imgType?: string; /** - * Specifies that all search results should contain a link to a particular - * URL + * Specifies that all search results should contain a link to a particular URL */ linkSite?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append - * it to query + * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query */ lowRange?: string; /** @@ -411,9 +401,7 @@ export namespace customsearch_v1 { */ num?: number; /** - * Provides additional search terms to check for in a document, where each - * document in the search results must contain at least one of the - * additional search terms + * Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms */ orTerms?: string; /** @@ -421,14 +409,11 @@ export namespace customsearch_v1 { */ q?: string; /** - * Specifies that all search results should be pages that are related to the - * specified URL + * Specifies that all search results should be pages that are related to the specified URL */ relatedSite?: string; /** - * Filters based on licensing. Supported values include: cc_publicdomain, - * cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and - * combinations of these. + * Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. */ rights?: string; /** @@ -444,8 +429,7 @@ export namespace customsearch_v1 { */ siteSearch?: string; /** - * Controls whether to include or exclude results from the site named in the - * as_sitesearch parameter + * Controls whether to include or exclude results from the site named in the as_sitesearch parameter */ siteSearchFilter?: string; /** @@ -466,9 +450,7 @@ export namespace customsearch_v1 { /** * search.cse.siterestrict.list - * @desc Returns metadata about the search performed, metadata about the - * custom search engine used for the search, and the search results. Uses a - * small set of url patterns. + * @desc Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns. * @alias search.cse.siterestrict.list * @memberOf! () * @@ -597,13 +579,11 @@ export namespace customsearch_v1 { */ exactTerms?: string; /** - * Identifies a word or phrase that should not appear in any documents in - * the search results + * Identifies a word or phrase that should not appear in any documents in the search results */ excludeTerms?: string; /** - * Returns images of a specified type. Some of the allowed values are: bmp, - * gif, png, jpg, svg, pdf, ... + * Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... */ fileType?: string; /** @@ -619,8 +599,7 @@ export namespace customsearch_v1 { */ googlehost?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append - * it to query + * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query */ highRange?: string; /** @@ -632,33 +611,27 @@ export namespace customsearch_v1 { */ hq?: string; /** - * Returns black and white, grayscale, or color images: mono, gray, and - * color. + * Returns black and white, grayscale, or color images: mono, gray, and color. */ imgColorType?: string; /** - * Returns images of a specific dominant color: red, orange, yellow, green, - * teal, blue, purple, pink, white, gray, black and brown. + * Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. */ imgDominantColor?: string; /** - * Returns images of a specified size, where size can be one of: icon, - * small, medium, large, xlarge, xxlarge, and huge. + * Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. */ imgSize?: string; /** - * Returns images of a type, which can be one of: clipart, face, lineart, - * news, and photo. + * Returns images of a type, which can be one of: clipart, face, lineart, news, and photo. */ imgType?: string; /** - * Specifies that all search results should contain a link to a particular - * URL + * Specifies that all search results should contain a link to a particular URL */ linkSite?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append - * it to query + * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query */ lowRange?: string; /** @@ -670,9 +643,7 @@ export namespace customsearch_v1 { */ num?: number; /** - * Provides additional search terms to check for in a document, where each - * document in the search results must contain at least one of the - * additional search terms + * Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms */ orTerms?: string; /** @@ -680,14 +651,11 @@ export namespace customsearch_v1 { */ q?: string; /** - * Specifies that all search results should be pages that are related to the - * specified URL + * Specifies that all search results should be pages that are related to the specified URL */ relatedSite?: string; /** - * Filters based on licensing. Supported values include: cc_publicdomain, - * cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and - * combinations of these. + * Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. */ rights?: string; /** @@ -703,8 +671,7 @@ export namespace customsearch_v1 { */ siteSearch?: string; /** - * Controls whether to include or exclude results from the site named in the - * as_sitesearch parameter + * Controls whether to include or exclude results from the site named in the as_sitesearch parameter */ siteSearchFilter?: string; /** diff --git a/src/apis/dataflow/package.json b/src/apis/dataflow/package.json index 1abb8a95cb9..720cdc617c7 100644 --- a/src/apis/dataflow/package.json +++ b/src/apis/dataflow/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index d3fbabb779c..807b35f7593 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace dataflow_v1b3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace dataflow_v1b3 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,15 +108,17 @@ export namespace dataflow_v1b3 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * Obsolete in favor of ApproximateReportedProgress and - * ApproximateSplitRequest. + * Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. */ export interface Schema$ApproximateProgress { /** @@ -141,17 +139,11 @@ export namespace dataflow_v1b3 { */ export interface Schema$ApproximateReportedProgress { /** - * Total amount of parallelism in the portion of input of this task that has - * already been consumed and is no longer active. In the first two examples - * above (see remaining_parallelism), the value should be 29 or 2 - * respectively. The sum of remaining_parallelism and consumed_parallelism - * should equal the total amount of parallelism in this work item. If - * specified, must be finite. + * Total amount of parallelism in the portion of input of this task that has already been consumed and is no longer active. In the first two examples above (see remaining_parallelism), the value should be 29 or 2 respectively. The sum of remaining_parallelism and consumed_parallelism should equal the total amount of parallelism in this work item. If specified, must be finite. */ consumedParallelism?: Schema$ReportedParallelism; /** - * Completion as fraction of the input consumed, from 0.0 (beginning, - * nothing consumed), to 1.0 (end of the input, entire input consumed). + * Completion as fraction of the input consumed, from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed). */ fractionConsumed?: number; /** @@ -159,41 +151,20 @@ export namespace dataflow_v1b3 { */ position?: Schema$Position; /** - * Total amount of parallelism in the input of this task that remains, (i.e. - * can be delegated to this task and any new tasks via dynamic splitting). - * Always at least 1 for non-finished work items and 0 for finished. - * "Amount of parallelism" refers to how many non-empty parts of - * the input can be read in parallel. This does not necessarily equal number - * of records. An input that can be read in parallel down to the individual - * records is called "perfectly splittable". An example of - * non-perfectly parallelizable input is a block-compressed file format - * where a block of records has to be read as a whole, but different blocks - * can be read in parallel. Examples: * If we are processing record #30 - * (starting at 1) out of 50 in a perfectly splittable 50-record input, - * this value should be 21 (20 remaining + 1 current). * If we are reading - * through block 3 in a block-compressed file consisting of 5 blocks, this - * value should be 3 (since blocks 4 and 5 can be processed in parallel by - * new tasks via dynamic splitting and the current task remains processing - * block 3). * If we are reading through the last block in a - * block-compressed file, or reading or processing the last record in a - * perfectly splittable input, this value should be 1, because apart from - * the current task, no additional remainder can be split off. + * Total amount of parallelism in the input of this task that remains, (i.e. can be delegated to this task and any new tasks via dynamic splitting). Always at least 1 for non-finished work items and 0 for finished. "Amount of parallelism" refers to how many non-empty parts of the input can be read in parallel. This does not necessarily equal number of records. An input that can be read in parallel down to the individual records is called "perfectly splittable". An example of non-perfectly parallelizable input is a block-compressed file format where a block of records has to be read as a whole, but different blocks can be read in parallel. Examples: * If we are processing record #30 (starting at 1) out of 50 in a perfectly splittable 50-record input, this value should be 21 (20 remaining + 1 current). * If we are reading through block 3 in a block-compressed file consisting of 5 blocks, this value should be 3 (since blocks 4 and 5 can be processed in parallel by new tasks via dynamic splitting and the current task remains processing block 3). * If we are reading through the last block in a block-compressed file, or reading or processing the last record in a perfectly splittable input, this value should be 1, because apart from the current task, no additional remainder can be split off. */ remainingParallelism?: Schema$ReportedParallelism; } /** - * A suggestion by the service to the worker to dynamically split the - * WorkItem. + * A suggestion by the service to the worker to dynamically split the WorkItem. */ export interface Schema$ApproximateSplitRequest { /** - * A fraction at which to split the work item, from 0.0 (beginning of the - * input) to 1.0 (end of the input). + * A fraction at which to split the work item, from 0.0 (beginning of the input) to 1.0 (end of the input). */ fractionConsumed?: number; /** - * The fraction of the remainder of work to split the work item at, from 0.0 - * (split at the current position) to 1.0 (end of the input). + * The fraction of the remainder of work to split the work item at, from 0.0 (split at the current position) to 1.0 (end of the input). */ fractionOfRemainder?: number; /** @@ -202,8 +173,7 @@ export namespace dataflow_v1b3 { position?: Schema$Position; } /** - * A structured message reporting an autoscaling decision made by the Dataflow - * service. + * A structured message reporting an autoscaling decision made by the Dataflow service. */ export interface Schema$AutoscalingEvent { /** @@ -211,9 +181,7 @@ export namespace dataflow_v1b3 { */ currentNumWorkers?: string; /** - * A message describing why the system decided to adjust the current number - * of workers, why it failed, or why the system decided to not make any - * changes to the number of workers. + * A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers. */ description?: Schema$StructuredMessage; /** @@ -225,13 +193,11 @@ export namespace dataflow_v1b3 { */ targetNumWorkers?: string; /** - * The time this event was emitted to indicate a new target or current - * num_workers value. + * The time this event was emitted to indicate a new target or current num_workers value. */ time?: string; /** - * A short and friendly name for the worker pool this event refers to, - * populated from the value of PoolStageRelation::user_pool_name. + * A short and friendly name for the worker pool this event refers to, populated from the value of PoolStageRelation::user_pool_name. */ workerPool?: string; } @@ -287,8 +253,7 @@ export namespace dataflow_v1b3 { tableId?: string; } /** - * Description of an interstitial value between transforms in an execution - * stage. + * Description of an interstitial value between transforms in an execution stage. */ export interface Schema$ComponentSource { /** @@ -296,8 +261,7 @@ export namespace dataflow_v1b3 { */ name?: string; /** - * User name for the original user transform or collection with which this - * source is most closely associated. + * User name for the original user transform or collection with which this source is most closely associated. */ originalTransformOrCollection?: string; /** @@ -314,8 +278,7 @@ export namespace dataflow_v1b3 { */ name?: string; /** - * User name for the original user transform with which this transform is - * most closely associated. + * User name for the original user transform with which this transform is most closely associated. */ originalTransform?: string; /** @@ -353,9 +316,7 @@ export namespace dataflow_v1b3 { systemStageName?: string; } /** - * A position that encapsulates an inner position and an index for the inner - * position. A ConcatPosition can be used by a reader of a source that - * encapsulates a set of other sources. + * A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. */ export interface Schema$ConcatPosition { /** @@ -389,8 +350,7 @@ export namespace dataflow_v1b3 { standardUnits?: string; } /** - * Identifies a counter within a per-job namespace. Counters whose structured - * names are the same get merged into a single value for the job. + * Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job. */ export interface Schema$CounterStructuredName { /** @@ -402,16 +362,11 @@ export namespace dataflow_v1b3 { */ executionStepName?: string; /** - * Index of an input collection that's being read from/written to as a - * side input. The index identifies a step's side inputs starting by 1 - * (e.g. the first side input has input_index 1, the third has input_index - * 3). Side inputs are identified by a pair of (original_step_name, - * input_index). This field helps uniquely identify them. + * Index of an input collection that's being read from/written to as a side input. The index identifies a step's side inputs starting by 1 (e.g. the first side input has input_index 1, the third has input_index 3). Side inputs are identified by a pair of (original_step_name, input_index). This field helps uniquely identify them. */ inputIndex?: number; /** - * Counter name. Not necessarily globally-unique, but unique within the - * context of the other fields. Required. + * Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required. */ name?: string; /** @@ -419,18 +374,15 @@ export namespace dataflow_v1b3 { */ origin?: string; /** - * The step name requesting an operation, such as GBK. I.e. the ParDo - * causing a read/write from shuffle to occur, or a read from side inputs. + * The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs. */ originalRequestingStepName?: string; /** - * System generated name of the original step in the user's graph, - * before optimization. + * System generated name of the original step in the user's graph, before optimization. */ originalStepName?: string; /** - * A string containing a more specific namespace of the counter's - * origin. + * A string containing a more specific namespace of the counter's origin. */ originNamespace?: string; /** @@ -443,8 +395,7 @@ export namespace dataflow_v1b3 { workerId?: string; } /** - * A single message which encapsulates structured name and metadata for a - * given counter. + * A single message which encapsulates structured name and metadata for a given counter. */ export interface Schema$CounterStructuredNameAndMetadata { /** @@ -465,9 +416,7 @@ export namespace dataflow_v1b3 { */ boolean?: boolean; /** - * True if this counter is reported as the total cumulative aggregate value - * accumulated since the worker started working on this WorkItem. By default - * this is false, indicating that this counter is reported as a delta. + * True if this counter is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this counter is reported as a delta. */ cumulative?: boolean; /** @@ -511,8 +460,7 @@ export namespace dataflow_v1b3 { */ nameAndKind?: Schema$NameAndKind; /** - * The service-generated short identifier for this counter. The short_id - * -> (name, metadata) mapping is constant for the lifetime of a job. + * The service-generated short identifier for this counter. The short_id -> (name, metadata) mapping is constant for the lifetime of a job. */ shortId?: string; /** @@ -529,8 +477,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$CPUTime { /** - * Average CPU utilization rate (% non-idle cpu / second) since previous - * sample. + * Average CPU utilization rate (% non-idle cpu / second) since previous sample. */ rate?: number; /** @@ -538,8 +485,7 @@ export namespace dataflow_v1b3 { */ timestamp?: string; /** - * Total active CPU time across all cores (ie., non-idle) in milliseconds - * since start-up. + * Total active CPU time across all cores (ie., non-idle) in milliseconds since start-up. */ totalMs?: string; } @@ -552,8 +498,7 @@ export namespace dataflow_v1b3 { */ environment?: Schema$RuntimeEnvironment; /** - * Required. A Cloud Storage path to the template from which to create the - * job. Must be a valid Cloud Storage URL, beginning with `gs://`. + * Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`. */ gcsPath?: string; /** @@ -561,9 +506,7 @@ export namespace dataflow_v1b3 { */ jobName?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - * which to direct the request. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. */ location?: string; /** @@ -585,16 +528,11 @@ export namespace dataflow_v1b3 { */ export interface Schema$DataDiskAssignment { /** - * Mounted data disks. The order is important a data disk's 0-based - * index in this list defines which persistent directory the disk is mounted - * to, for example the list of { - * "myproject-1014-104817-4c2-harness-0-disk-0" }, { - * "myproject-1014-104817-4c2-harness-0-disk-1" }. + * Mounted data disks. The order is important a data disk's 0-based index in this list defines which persistent directory the disk is mounted to, for example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" }, { "myproject-1014-104817-4c2-harness-0-disk-1" }. */ dataDisks?: string[]; /** - * VM instance name the data disks mounted to, for example - * "myproject-1014-104817-4c2-harness-0". + * VM instance name the data disks mounted to, for example "myproject-1014-104817-4c2-harness-0". */ vmInstance?: string; } @@ -612,10 +550,11 @@ export namespace dataflow_v1b3 { projectId?: string; } /** - * Specification of one of the bundles produced as a result of splitting a - * Source (e.g. when executing a SourceSplitRequest, or when splitting an - * active task using WorkItemStatus.dynamic_source_split), relative to the - * source being split. + * Response from deleting a snapshot. + */ + export interface Schema$DeleteSnapshotResponse {} + /** + * Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. */ export interface Schema$DerivedSource { /** @@ -632,20 +571,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$Disk { /** - * Disk storage type, as defined by Google Compute Engine. This must be a - * disk type appropriate to the project and zone in which the workers will - * run. If unknown or unspecified, the service will attempt to choose a - * reasonable default. For example, the standard persistent disk type is a - * resource name typically ending in "pd-standard". If SSD - * persistent disks are available, the resource name typically ends with - * "pd-ssd". The actual valid values are defined the Google - * Compute Engine API, not by the Cloud Dataflow API; consult the Google - * Compute Engine documentation for more information about determining the - * set of available disk types for a particular project and zone. Google - * Compute Engine Disk types are local to a particular project in a - * particular zone, and so the resource name will typically look something - * like this: - * compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard + * Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Cloud Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard */ diskType?: string; /** @@ -653,8 +579,7 @@ export namespace dataflow_v1b3 { */ mountPoint?: string; /** - * Size of disk in GB. If zero or unspecified, the service will attempt to - * choose a reasonable default. + * Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. */ sizeGb?: number; } @@ -683,8 +608,7 @@ export namespace dataflow_v1b3 { */ javaClassValue?: string; /** - * The key identifying the display data. This is intended to be used as a - * label for the display data when viewed in a dax monitoring system. + * The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system. */ key?: string; /** @@ -692,18 +616,11 @@ export namespace dataflow_v1b3 { */ label?: string; /** - * The namespace for the key. This is usually a class name or programming - * language namespace (i.e. python module) which defines the display data. - * This allows a dax monitoring system to specially handle the data and - * perform custom rendering. + * The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering. */ namespace?: string; /** - * A possible additional shorter value to display. For example a - * java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn - * as the short_str_value and com.mypackage.MyDoFn as the java_class_name - * value. short_str_value can be displayed and java_class_name_value will be - * displayed as a tooltip. + * A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip. */ shortStrValue?: string; /** @@ -740,8 +657,7 @@ export namespace dataflow_v1b3 { */ min?: Schema$SplitInt64; /** - * Use an int64 since we'd prefer the added precision. If overflow is a - * common problem we can detect it and use an additional int64 or a double. + * Use an int64 since we'd prefer the added precision. If overflow is a common problem we can detect it and use an additional int64 or a double. */ sum?: Schema$SplitInt64; /** @@ -750,19 +666,15 @@ export namespace dataflow_v1b3 { sumOfSquares?: number; } /** - * When a task splits using WorkItemStatus.dynamic_source_split, this message - * describes the two parts of the split relative to the description of the - * current task's input. + * When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input. */ export interface Schema$DynamicSourceSplit { /** - * Primary part (continued to be processed by worker). Specified relative to - * the previously-current source. Becomes current. + * Primary part (continued to be processed by worker). Specified relative to the previously-current source. Becomes current. */ primary?: Schema$DerivedSource; /** - * Residual part (returned to the pool of work). Specified relative to the - * previously-current source. + * Residual part (returned to the pool of work). Specified relative to the previously-current source. */ residual?: Schema$DerivedSource; } @@ -771,16 +683,11 @@ export namespace dataflow_v1b3 { */ export interface Schema$Environment { /** - * The type of cluster manager API to use. If unknown or unspecified, the - * service will attempt to choose a reasonable default. This should be in - * the form of the API service name, e.g. - * "compute.googleapis.com". + * The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com". */ clusterManagerApiService?: string; /** - * The dataset for the current project where various workflow related tables - * are stored. The supported resource type is: Google BigQuery: - * bigquery.googleapis.com/{dataset} + * The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} */ dataset?: string; /** @@ -796,10 +703,7 @@ export namespace dataflow_v1b3 { */ internalExperiments?: {[key: string]: any}; /** - * The Cloud Dataflow SDK pipeline options specified by the user. These - * options are passed through the service and are used to recreate the SDK - * pipeline options on the worker in a language agnostic and platform - * independent way. + * The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way. */ sdkPipelineOptions?: {[key: string]: any}; /** @@ -807,20 +711,11 @@ export namespace dataflow_v1b3 { */ serviceAccountEmail?: string; /** - * If set, contains the Cloud KMS key identifier used to encrypt data at - * rest, AKA a Customer Managed Encryption Key (CMEK). Format: - * projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY + * If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY */ serviceKmsKeyName?: string; /** - * The prefix of the resources the system should use for temporary storage. - * The system will append the suffix "/temp-{JOBNAME} to this resource - * prefix, where {JOBNAME} is the value of the job_name field. The - * resulting bucket and object prefix is used as the prefix of the resources - * used to store temporary data needed during the job execution. NOTE: This - * will override the value in taskrunner_settings. The supported resource - * type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} - * bucket.storage.googleapis.com/{object} + * The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ tempStoragePrefix?: string; /** @@ -828,13 +723,11 @@ export namespace dataflow_v1b3 { */ userAgent?: {[key: string]: any}; /** - * A structure describing which components and their versions of the service - * are required in order to run the job. + * A structure describing which components and their versions of the service are required in order to run the job. */ version?: {[key: string]: any}; /** - * The worker pools. At least one "harness" worker pool must be - * specified in order for the job to have workers. + * The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. */ workerPools?: Schema$WorkerPool[]; } @@ -856,9 +749,7 @@ export namespace dataflow_v1b3 { executionStageState?: string; } /** - * Description of the composing transforms, names/ids, and input/outputs of a - * stage of execution. Some composing transforms and sources may have been - * generated by the Dataflow service during execution planning. + * Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. */ export interface Schema$ExecutionStageSummary { /** @@ -891,15 +782,11 @@ export namespace dataflow_v1b3 { outputSource?: Schema$StageSource[]; } /** - * Indicates which [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed - * to respond to a request for data. + * Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data. */ export interface Schema$FailedLocation { /** - * The name of the [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * failed to respond. + * The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. */ name?: string; } @@ -913,8 +800,7 @@ export namespace dataflow_v1b3 { filePattern?: string; } /** - * An instruction that copies its inputs (zero or more) to its (single) - * output. + * An instruction that copies its inputs (zero or more) to its (single) output. */ export interface Schema$FlattenInstruction { /** @@ -953,9 +839,7 @@ export namespace dataflow_v1b3 { */ componentId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -977,42 +861,29 @@ export namespace dataflow_v1b3 { */ export interface Schema$GetTemplateResponse { /** - * The template metadata describing the template name, available parameters, - * etc. + * The template metadata describing the template name, available parameters, etc. */ metadata?: Schema$TemplateMetadata; /** - * The status of the get template request. Any problems with the request - * will be indicated in the error_details. + * The status of the get template request. Any problems with the request will be indicated in the error_details. */ status?: Schema$Status; } /** - * Histogram of value counts for a distribution. Buckets have an inclusive - * lower bound and exclusive upper bound and use "1,2,5 bucketing": - * The first bucket range is from [0,1) and all subsequent bucket boundaries - * are powers of ten multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, - * 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... Negative values are not - * supported. + * Histogram of value counts for a distribution. Buckets have an inclusive lower bound and exclusive upper bound and use "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... Negative values are not supported. */ export interface Schema$Histogram { /** - * Counts of values in each bucket. For efficiency, prefix and trailing - * buckets with count = 0 are elided. Buckets can store the full range of - * values of an unsigned long, with ULLONG_MAX falling into the 59th bucket - * with range [1e19, 2e19). + * Counts of values in each bucket. For efficiency, prefix and trailing buckets with count = 0 are elided. Buckets can store the full range of values of an unsigned long, with ULLONG_MAX falling into the 59th bucket with range [1e19, 2e19). */ bucketCounts?: string[]; /** - * Starting index of first stored bucket. The non-inclusive upper-bound of - * the ith bucket is given by: pow(10,(i-first_bucket_offset)/3) * - * (1,2,5)[(i-first_bucket_offset)%3] + * Starting index of first stored bucket. The non-inclusive upper-bound of the ith bucket is given by: pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3] */ firstBucketOffset?: number; } /** - * An input of an instruction, as a reference to an output of a producer - * instruction. + * An input of an instruction, as a reference to an output of a producer instruction. */ export interface Schema$InstructionInput { /** @@ -1020,9 +891,7 @@ export namespace dataflow_v1b3 { */ outputNum?: number; /** - * The index (origin zero) of the parallel instruction that produces the - * output to be consumed by this input. This index is relative to the list - * of instructions in this input's instruction's containing MapTask. + * The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask. */ producerInstructionIndex?: number; } @@ -1039,19 +908,15 @@ export namespace dataflow_v1b3 { */ name?: string; /** - * For system-generated byte and mean byte metrics, certain instructions - * should only report the key size. + * For system-generated byte and mean byte metrics, certain instructions should only report the key size. */ onlyCountKeyBytes?: boolean; /** - * For system-generated byte and mean byte metrics, certain instructions - * should only report the value size. + * For system-generated byte and mean byte metrics, certain instructions should only report the value size. */ onlyCountValueBytes?: boolean; /** - * System-defined name for this output in the original workflow graph. - * Outputs that do not contribute to an original instruction do not set - * this. + * System-defined name for this output in the original workflow graph. Outputs that do not contribute to an original instruction do not set this. */ originalName?: string; /** @@ -1099,32 +964,19 @@ export namespace dataflow_v1b3 { */ export interface Schema$Job { /** - * The client's unique identifier of the job, re-used across retried - * attempts. If this field is set, the service will ensure its uniqueness. - * The request to create a job will fail if the service has knowledge of a - * previously submitted job with the same client's ID and job name. The - * caller may use this field to ensure idempotence of job creation across - * retried attempts to create a job. By default, the field is empty and, in - * that case, the service ignores it. + * The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. */ clientRequestId?: string; /** - * If this is specified, the job's initial state is populated from the - * given snapshot. + * If this is specified, the job's initial state is populated from the given snapshot. */ createdFromSnapshotId?: string; /** - * The timestamp when the job was initially created. Immutable and set by - * the Cloud Dataflow service. + * The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. */ createTime?: string; /** - * The current state of the job. Jobs are created in the - * `JOB_STATE_STOPPED` state unless otherwise specified. A job in the - * `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. - * After a job has reached a terminal state, no further state updates may be - * made. This field may be mutated by the Cloud Dataflow service; callers - * cannot mutate it. + * The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. */ currentState?: string; /** @@ -1140,45 +992,27 @@ export namespace dataflow_v1b3 { */ executionInfo?: Schema$JobExecutionInfo; /** - * The unique ID of this job. This field is set by the Cloud Dataflow - * service when the Job is created, and is immutable for the life of the - * job. + * The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job. */ id?: string; /** - * This field is populated by the Dataflow service to support filtering jobs - * by the metadata values provided here. Populated for ListJobs and all - * GetJob views SUMMARY and higher. + * This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher. */ jobMetadata?: Schema$JobMetadata; /** - * User-defined labels for this job. The labels map can contain no more - * than 64 entries. Entries of the labels map are UTF8 strings that comply - * with the following restrictions: * Keys must conform to regexp: - * \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally - * constrained to be <= 128 bytes in size. + * User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */ labels?: {[key: string]: string}; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** - * The user-specified Cloud Dataflow job name. Only one Job with a given - * name may exist in a project at any given time. If a caller attempts to - * create a Job with the same name as an already-existing Job, the attempt - * returns the existing Job. The name must match the regular expression - * `[a-z]([-a-z0-9]{0,38}[a-z0-9])?` + * The user-specified Cloud Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?` */ name?: string; /** - * Preliminary field: The format of this data may change at any time. A - * description of the user pipeline and stages through which it is executed. - * Created by Cloud Dataflow service. Only retrieved with - * JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. + * Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. */ pipelineDescription?: Schema$PipelineDescription; /** @@ -1186,43 +1020,27 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * If another job is an update of this job (and thus, this job is in - * `JOB_STATE_UPDATED`), this field contains the ID of that job. + * If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. */ replacedByJobId?: string; /** - * If this job is an update of an existing job, this field is the job ID of - * the job it replaced. When sending a `CreateJobRequest`, you can update a - * job by specifying it here. The job named here is stopped, and its - * intermediate state is transferred to this job. + * If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. */ replaceJobId?: string; /** - * The job's requested state. `UpdateJob` may be used to switch between - * the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting - * requested_state. `UpdateJob` may also be used to directly set a - * job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, - * irrevocably terminating the job if it has not already reached a terminal - * state. + * The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. */ requestedState?: string; /** - * This field may be mutated by the Cloud Dataflow service; callers cannot - * mutate it. + * This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. */ stageStates?: Schema$ExecutionStageState[]; /** - * The timestamp when the job was started (transitioned to - * JOB_STATE_PENDING). Flexible resource scheduling jobs are started with - * some delay after job creation, so start_time is unset before start and is - * updated when the job is started by the Cloud Dataflow service. For other - * jobs, start_time always equals to create_time and is immutable and set by - * the Cloud Dataflow service. + * The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. */ startTime?: string; /** - * Exactly one of step or steps_location should be specified. The top-level - * steps that constitute the entire job. + * Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. */ steps?: Schema$Step[]; /** @@ -1230,17 +1048,11 @@ export namespace dataflow_v1b3 { */ stepsLocation?: string; /** - * A set of files the system should be aware of that are used for temporary - * storage. These temporary files will be removed on job completion. No - * duplicates are allowed. No file patterns are supported. The supported - * files are: Google Cloud Storage: - * storage.googleapis.com/{bucket}/{object} - * bucket.storage.googleapis.com/{object} + * A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ tempFiles?: string[]; /** - * The map of transform name prefixes of the job to be replaced to the - * corresponding name prefixes of the new job. + * The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */ transformNameMapping?: {[key: string]: string}; /** @@ -1249,8 +1061,7 @@ export namespace dataflow_v1b3 { type?: string; } /** - * Additional information about how a Cloud Dataflow job will be executed that - * isn't contained in the submitted job. + * Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. */ export interface Schema$JobExecutionInfo { /** @@ -1259,13 +1070,11 @@ export namespace dataflow_v1b3 { stages?: {[key: string]: Schema$JobExecutionStageInfo}; } /** - * Contains information about how a particular google.dataflow.v1beta3.Step - * will be executed. + * Contains information about how a particular google.dataflow.v1beta3.Step will be executed. */ export interface Schema$JobExecutionStageInfo { /** - * The steps associated with the execution stage. Note that stages may have - * several steps, and that a given step might be run by more than one stage. + * The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. */ stepName?: string[]; } @@ -1291,8 +1100,7 @@ export namespace dataflow_v1b3 { time?: string; } /** - * Metadata available primarily for filtering jobs. Will be included in the - * ListJob response and Job SUMMARY view. + * Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. */ export interface Schema$JobMetadata { /** @@ -1325,11 +1133,7 @@ export namespace dataflow_v1b3 { spannerDetails?: Schema$SpannerIODetails[]; } /** - * JobMetrics contains a collection of metrics describing the detailed - * progress of a Dataflow job. Metrics correspond to user-defined and - * system-defined metrics in the job. This resource captures only the most - * recent values of each metric; time-series data can be queried for them - * (under the same metric names) from Cloud Monitoring. + * JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring. */ export interface Schema$JobMetrics { /** @@ -1342,16 +1146,11 @@ export namespace dataflow_v1b3 { metricTime?: string; } /** - * Data disk assignment information for a specific key-range of a sharded - * computation. Currently we only support UTF-8 character splits to simplify - * encoding into JSON. + * Data disk assignment information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON. */ export interface Schema$KeyRangeDataDiskAssignment { /** - * The name of the data disk where data for this range is stored. This name - * is local to the Google Cloud Platform project and uniquely identifies the - * disk within that project, for example - * "myproject-1014-104817-4c2-harness-0-disk-1". + * The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". */ dataDisk?: string; /** @@ -1364,26 +1163,19 @@ export namespace dataflow_v1b3 { start?: string; } /** - * Location information for a specific key-range of a sharded computation. - * Currently we only support UTF-8 character splits to simplify encoding into - * JSON. + * Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON. */ export interface Schema$KeyRangeLocation { /** - * The name of the data disk where data for this range is stored. This name - * is local to the Google Cloud Platform project and uniquely identifies the - * disk within that project, for example - * "myproject-1014-104817-4c2-harness-0-disk-1". + * The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". */ dataDisk?: string; /** - * The physical location of this range assignment to be used for streaming - * computation cross-worker message delivery. + * The physical location of this range assignment to be used for streaming computation cross-worker message delivery. */ deliveryEndpoint?: string; /** - * DEPRECATED. The location of the persistent state for this range, as a - * persistent directory in the worker local filesystem. + * DEPRECATED. The location of the persistent state for this range, as a persistent directory in the worker local filesystem. */ deprecatedPersistentDirectory?: string; /** @@ -1417,8 +1209,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$LaunchTemplateResponse { /** - * The job that was launched, if the request was not a dry run and the job - * was successfully launched. + * The job that was launched, if the request was not a dry run and the job was successfully launched. */ job?: Schema$Job; } @@ -1431,9 +1222,7 @@ export namespace dataflow_v1b3 { */ currentWorkerTime?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the WorkItem's job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. */ location?: string; /** @@ -1445,13 +1234,11 @@ export namespace dataflow_v1b3 { */ unifiedWorkerRequest?: {[key: string]: any}; /** - * Worker capabilities. WorkItems might be limited to workers with specific - * capabilities. + * Worker capabilities. WorkItems might be limited to workers with specific capabilities. */ workerCapabilities?: string[]; /** - * Identifies the worker leasing work -- typically the ID of the virtual - * machine running the worker. + * Identifies the worker leasing work -- typically the ID of the virtual machine running the worker. */ workerId?: string; /** @@ -1490,14 +1277,11 @@ export namespace dataflow_v1b3 { nextPageToken?: string; } /** - * Response to a request to list Cloud Dataflow jobs. This may be a partial - * response, depending on the page size in the ListJobsRequest. + * Response to a request to list Cloud Dataflow jobs. This may be a partial response, depending on the page size in the ListJobsRequest. */ export interface Schema$ListJobsResponse { /** - * Zero or more messages describing the [regional endpoints] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * failed to respond. + * Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. */ failedLocation?: Schema$FailedLocation[]; /** @@ -1510,15 +1294,20 @@ export namespace dataflow_v1b3 { nextPageToken?: string; } /** - * MapTask consists of an ordered set of instructions, each of which describes - * one particular low-level operation for the worker to perform in order to - * accomplish the MapTask's WorkItem. Each instruction must appear in the - * list before any instructions which depends on its output. + * List of snapshots. + */ + export interface Schema$ListSnapshotsResponse { + /** + * Returned snapshots. + */ + snapshots?: Schema$Snapshot[]; + } + /** + * MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem. Each instruction must appear in the list before any instructions which depends on its output. */ export interface Schema$MapTask { /** - * Counter prefix that can be used to prefix counters. Not currently used in - * Dataflow. + * Counter prefix that can be used to prefix counters. Not currently used in Dataflow. */ counterPrefix?: string; /** @@ -1526,8 +1315,7 @@ export namespace dataflow_v1b3 { */ instructions?: Schema$ParallelInstruction[]; /** - * System-defined name of the stage containing this MapTask. Unique across - * the workflow. + * System-defined name of the stage containing this MapTask. Unique across the workflow. */ stageName?: string; /** @@ -1536,13 +1324,11 @@ export namespace dataflow_v1b3 { systemName?: string; } /** - * The metric short id is returned to the user alongside an offset into - * ReportWorkItemStatusRequest + * The metric short id is returned to the user alongside an offset into ReportWorkItemStatusRequest */ export interface Schema$MetricShortId { /** - * The index of the corresponding metric in the ReportWorkItemStatusRequest. - * Required. + * The index of the corresponding metric in the ReportWorkItemStatusRequest. Required. */ metricIndex?: number; /** @@ -1555,12 +1341,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$MetricStructuredName { /** - * Zero or more labeled fields which identify the part of the job this - * metric is associated with, such as the name of a step or collection. For - * example, built-in counters associated with steps will have - * context['step'] = <step-name>. Counters associated with - * PCollections in the SDK will have context['pcollection'] = - * <pcollection-name>. + * Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = <step-name>. Counters associated with PCollections in the SDK will have context['pcollection'] = <pcollection-name>. */ context?: {[key: string]: string}; /** @@ -1568,9 +1349,7 @@ export namespace dataflow_v1b3 { */ name?: string; /** - * Origin (namespace) of metric name. May be blank for user-define metrics; - * will be "dataflow" for metrics defined by the Dataflow service - * or SDK. + * Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK. */ origin?: string; } @@ -1579,10 +1358,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$MetricUpdate { /** - * True if this metric is reported as the total cumulative aggregate value - * accumulated since the worker started working on this WorkItem. By default - * this is false, indicating that this metric is reported as a delta that is - * not associated with any WorkItem. + * True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem. */ cumulative?: boolean; /** @@ -1590,9 +1366,7 @@ export namespace dataflow_v1b3 { */ distribution?: any; /** - * A struct value describing properties of a Gauge. Metrics of gauge type - * show the value of a metric across time, and is aggregated based on the - * newest value. + * A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value. */ gauge?: any; /** @@ -1600,26 +1374,15 @@ export namespace dataflow_v1b3 { */ internal?: any; /** - * Metric aggregation kind. The possible metric aggregation kinds are - * "Sum", "Max", "Min", "Mean", - * "Set", "And", "Or", and - * "Distribution". The specified aggregation kind is - * case-insensitive. If omitted, this is not an aggregated value but - * instead a single metric sample value. + * Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value. */ kind?: string; /** - * Worker-computed aggregate value for the "Mean" aggregation - * kind. This holds the count of the aggregated values and is used in - * combination with mean_sum above to obtain the actual mean aggregate - * value. The only possible value type is Long. + * Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long. */ meanCount?: any; /** - * Worker-computed aggregate value for the "Mean" aggregation - * kind. This holds the sum of the aggregated values and is used in - * combination with mean_count below to obtain the actual mean aggregate - * value. The only possible value types are Long and Double. + * Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double. */ meanSum?: any; /** @@ -1627,22 +1390,15 @@ export namespace dataflow_v1b3 { */ name?: Schema$MetricStructuredName; /** - * Worker-computed aggregate value for aggregation kinds "Sum", - * "Max", "Min", "And", and "Or". - * The possible value types are Long, Double, and Boolean. + * Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean. */ scalar?: any; /** - * Worker-computed aggregate value for the "Set" aggregation kind. - * The only possible value type is a list of Values whose type can be Long, - * Double, or String, according to the metric's type. All Values in the - * list must be of the same type. + * Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type. */ set?: any; /** - * Timestamp associated with the metric value. Optional when workers are - * reporting work progress; it will be filled in responses from the metrics - * API. + * Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API. */ updateTime?: string; } @@ -1651,9 +1407,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$MountedDataDisk { /** - * The name of the data disk. This name is local to the Google Cloud - * Platform project and uniquely identifies the disk within that project, - * for example "myproject-1014-104817-4c2-harness-0-disk-1". + * The name of the data disk. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". */ dataDisk?: string; } @@ -1662,8 +1416,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$MultiOutputInfo { /** - * The id of the tag the user code will emit to this output by; this should - * correspond to the tag of some SideInputInfo. + * The id of the tag the user code will emit to this output by; this should correspond to the tag of some SideInputInfo. */ tag?: string; } @@ -1681,19 +1434,11 @@ export namespace dataflow_v1b3 { name?: string; } /** - * The packages that must be installed in order for a worker to run the steps - * of the Cloud Dataflow job that will be assigned to its worker pool. This - * is the mechanism by which the Cloud Dataflow SDK causes code to be loaded - * onto the workers. For example, the Cloud Dataflow Java SDK might use this - * to install jars containing the user's code and all of the various - * dependencies (libraries, data files, etc.) required in order for that code - * to run. + * The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run. */ export interface Schema$Package { /** - * The resource to read the package from. The supported resource type is: - * Google Cloud Storage: storage.googleapis.com/{bucket} - * bucket.storage.googleapis.com/ + * The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/ */ location?: string; /** @@ -1781,8 +1526,7 @@ export namespace dataflow_v1b3 { regexes?: string[]; } /** - * An instruction that does a ParDo operation. Takes one main input and zero - * or more side inputs, and produces zero or more outputs. Runs user code. + * An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code. */ export interface Schema$ParDoInstruction { /** @@ -1819,13 +1563,11 @@ export namespace dataflow_v1b3 { */ inputElementCodec?: {[key: string]: any}; /** - * If this instruction includes a combining function this is the name of the - * intermediate store between the GBK and the CombineValues. + * If this instruction includes a combining function this is the name of the intermediate store between the GBK and the CombineValues. */ originalCombineValuesInputStoreName?: string; /** - * If this instruction includes a combining function, this is the name of - * the CombineValues instruction lifted into this instruction. + * If this instruction includes a combining function, this is the name of the CombineValues instruction lifted into this instruction. */ originalCombineValuesStepName?: string; /** @@ -1838,9 +1580,7 @@ export namespace dataflow_v1b3 { valueCombiningFn?: {[key: string]: any}; } /** - * A descriptive representation of submitted pipeline as well as the executed - * form. This data is provided by the Dataflow service for ease of - * visualizing the pipeline and interpreting Dataflow provided metrics. + * A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. */ export interface Schema$PipelineDescription { /** @@ -1852,15 +1592,12 @@ export namespace dataflow_v1b3 { */ executionPipelineStage?: Schema$ExecutionStageSummary[]; /** - * Description of each transform in the pipeline and collections between - * them. + * Description of each transform in the pipeline and collections between them. */ originalPipelineTransform?: Schema$TransformSummary[]; } /** - * Position defines a position within a collection of data. The value can be - * either the end position, a key (used with ordered collections), a byte - * offset, or a record index. + * Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. */ export interface Schema$Position { /** @@ -1872,8 +1609,7 @@ export namespace dataflow_v1b3 { */ concatPosition?: Schema$ConcatPosition; /** - * Position is past all other positions. Also useful for the end position of - * an unbounded range. + * Position is past all other positions. Also useful for the end position of an unbounded range. */ end?: boolean; /** @@ -1885,8 +1621,7 @@ export namespace dataflow_v1b3 { */ recordIndex?: string; /** - * CloudPosition is a base64 encoded BatchShufflePosition (with FIXED - * sharding). + * CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). */ shufflePosition?: string; } @@ -1904,8 +1639,7 @@ export namespace dataflow_v1b3 { topic?: string; } /** - * Identifies a pubsub location to use for transferring data into or out of a - * streaming Dataflow job. + * Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. */ export interface Schema$PubsubLocation { /** @@ -1913,28 +1647,23 @@ export namespace dataflow_v1b3 { */ dropLateData?: boolean; /** - * If set, contains a pubsub label from which to extract record ids. If left - * empty, record deduplication will be strictly best effort. + * If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort. */ idLabel?: string; /** - * A pubsub subscription, in the form of - * "pubsub.googleapis.com/subscriptions/<project-id>/<subscription-name>" + * A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/<project-id>/<subscription-name>" */ subscription?: string; /** - * If set, contains a pubsub label from which to extract record timestamps. - * If left empty, record timestamps will be generated upon arrival. + * If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival. */ timestampLabel?: string; /** - * A pubsub topic, in the form of - * "pubsub.googleapis.com/topics/<project-id>/<topic-name>" + * A pubsub topic, in the form of "pubsub.googleapis.com/topics/<project-id>/<topic-name>" */ topic?: string; /** - * If set, specifies the pubsub subscription that will be used for tracking - * custom time timestamps for watermark estimation. + * If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation. */ trackingSubscription?: string; /** @@ -1952,16 +1681,11 @@ export namespace dataflow_v1b3 { source?: Schema$Source; } /** - * Represents the level of parallelism in a WorkItem's input, reported by - * the worker. + * Represents the level of parallelism in a WorkItem's input, reported by the worker. */ export interface Schema$ReportedParallelism { /** - * Specifies whether the parallelism is infinite. If true, "value" - * is ignored. Infinite parallelism means the service will assume that the - * work item can always be split into more non-empty work items by dynamic - * splitting. This is a work-around for lack of support for infinity by the - * current JSON-based Java RPC stack. + * Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack. */ isInfinite?: boolean; /** @@ -1978,9 +1702,7 @@ export namespace dataflow_v1b3 { */ currentWorkerTime?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the WorkItem's job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. */ location?: string; /** @@ -1988,16 +1710,11 @@ export namespace dataflow_v1b3 { */ unifiedWorkerRequest?: {[key: string]: any}; /** - * The ID of the worker reporting the WorkItem status. If this does not - * match the ID of the worker which the Dataflow service believes currently - * has the lease on the WorkItem, the report will be dropped (with an error - * response). + * The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service believes currently has the lease on the WorkItem, the report will be dropped (with an error response). */ workerId?: string; /** - * The order is unimportant, except that the order of the - * WorkItemServiceState messages in the ReportWorkItemStatusResponse - * corresponds to the order of WorkItemStatus messages here. + * The order is unimportant, except that the order of the WorkItemServiceState messages in the ReportWorkItemStatusResponse corresponds to the order of WorkItemStatus messages here. */ workItemStatuses?: Schema$WorkItemStatus[]; } @@ -2010,17 +1727,12 @@ export namespace dataflow_v1b3 { */ unifiedWorkerResponse?: {[key: string]: any}; /** - * A set of messages indicating the service-side state for each WorkItem - * whose status was reported, in the same order as the WorkItemStatus - * messages in the ReportWorkItemStatusRequest which resulting in this - * response. + * A set of messages indicating the service-side state for each WorkItem whose status was reported, in the same order as the WorkItemStatus messages in the ReportWorkItemStatusRequest which resulting in this response. */ workItemServiceStates?: Schema$WorkItemServiceState[]; } /** - * Worker metrics exported from workers. This contains resource utilization - * metrics accumulated from a variety of sources. For more information, see - * go/df-resource-signals. + * Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more information, see go/df-resource-signals. */ export interface Schema$ResourceUtilizationReport { /** @@ -2041,27 +1753,23 @@ export namespace dataflow_v1b3 { */ additionalExperiments?: string[]; /** - * Additional user labels attached to the job. + * Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. */ additionalUserLabels?: {[key: string]: string}; /** - * Whether to bypass the safety checks for the job's temporary - * directory. Use with caution. + * Whether to bypass the safety checks for the job's temporary directory. Use with caution. */ bypassTempDirValidation?: boolean; /** - * The machine type to use for the job. Defaults to the value from the - * template if not specified. + * The machine type to use for the job. Defaults to the value from the template if not specified. */ machineType?: string; /** - * The maximum number of Google Compute Engine instances to be made - * available to your pipeline during execution, from 1 to 1000. + * The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. */ maxWorkers?: number; /** - * Network to which VMs will be assigned. If empty or unspecified, the - * service will use the network "default". + * Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */ network?: string; /** @@ -2073,19 +1781,15 @@ export namespace dataflow_v1b3 { */ serviceAccountEmail?: string; /** - * Subnetwork to which VMs will be assigned, if desired. Expected to be of - * the form "regions/REGION/subnetworks/SUBNETWORK". + * Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". */ subnetwork?: string; /** - * The Cloud Storage path to use for temporary files. Must be a valid Cloud - * Storage URL, beginning with `gs://`. + * The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */ tempLocation?: string; /** - * The Compute Engine [availability - * zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - * for launching worker instances to run your pipeline. + * The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. */ zone?: string; } @@ -2119,9 +1823,7 @@ export namespace dataflow_v1b3 { */ data?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -2138,9 +1840,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$SendWorkerMessagesRequest { /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job. */ location?: string; /** @@ -2174,8 +1874,7 @@ export namespace dataflow_v1b3 { */ outputInfos?: Schema$SeqMapTaskOutputInfo[]; /** - * System-defined name of the stage containing the SeqDo operation. Unique - * across the workflow. + * System-defined name of the stage containing the SeqDo operation. Unique across the workflow. */ stageName?: string; /** @@ -2222,15 +1921,11 @@ export namespace dataflow_v1b3 { */ kind?: {[key: string]: any}; /** - * The source(s) to read element(s) from to get the value of this side - * input. If more than one source, then the elements are taken from the - * sources, in the specified order if order matters. At least one source is - * required. + * The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required. */ sources?: Schema$Source[]; /** - * The id of the tag the user code will access this side input by; this - * should correspond to the tag of some MultiOutputInfo. + * The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo. */ tag?: string; } @@ -2267,6 +1962,10 @@ export namespace dataflow_v1b3 { * The job this snapshot was created from. */ sourceJobId?: string; + /** + * State of the snapshot. + */ + state?: string; /** * The time after which this snapshot will be automatically deleted. */ @@ -2290,13 +1989,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$Source { /** - * While splitting, sources may specify the produced bundles as differences - * against another source, in order to save backend-side memory and allow - * bigger jobs. For details, see SourceSplitRequest. To support this use - * case, the full set of parameters of the source is logically obtained by - * taking the latest explicitly specified value of each parameter in the - * order: base_specs (later items win), spec (overrides anything in - * base_specs). + * While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). */ baseSpecs?: Array<{[key: string]: any}>; /** @@ -2304,26 +1997,11 @@ export namespace dataflow_v1b3 { */ codec?: {[key: string]: any}; /** - * Setting this value to true hints to the framework that the source - * doesn't need splitting, and using SourceSplitRequest on it would - * yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set - * this to true when splitting a single file into a set of byte ranges of - * appropriate size, and set this to false when splitting a filepattern into - * individual files. However, for efficiency, a file splitter may decide to - * produce file subranges directly from the filepattern to avoid a splitting - * round-trip. See SourceSplitRequest for an overview of the splitting - * process. This field is meaningful only in the Source objects populated - * by the user (e.g. when filling in a DerivedSource). Source objects - * supplied by the framework to the user don't have this field - * populated. + * Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. */ doesNotNeedSplitting?: boolean; /** - * Optionally, metadata for this source can be supplied right away, avoiding - * a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This - * field is meaningful only in the Source objects populated by the user - * (e.g. when filling in a DerivedSource). Source objects supplied by the - * framework to the user don't have this field populated. + * Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. */ metadata?: Schema$SourceMetadata; /** @@ -2371,30 +2049,24 @@ export namespace dataflow_v1b3 { metadata?: Schema$SourceMetadata; } /** - * Metadata about a Source useful for automatically optimizing and tuning the - * pipeline, etc. + * Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. */ export interface Schema$SourceMetadata { /** - * An estimate of the total size (in bytes) of the data that would be read - * from this source. This estimate is in terms of external storage size, - * before any decompression or other processing done by the reader. + * An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. */ estimatedSizeBytes?: string; /** - * Specifies that the size of this source is known to be infinite (this is a - * streaming source). + * Specifies that the size of this source is known to be infinite (this is a streaming source). */ infinite?: boolean; /** - * Whether this source is known to produce key/value pairs with the - * (encoded) keys in lexicographically sorted order. + * Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. */ producesSortedKeys?: boolean; } /** - * A work item that represents the different operations that can be performed - * on a user-defined Source specification. + * A work item that represents the different operations that can be performed on a user-defined Source specification. */ export interface Schema$SourceOperationRequest { /** @@ -2406,8 +2078,7 @@ export namespace dataflow_v1b3 { */ name?: string; /** - * System-defined name for the Read instruction for this source in the - * original workflow graph. + * System-defined name for the Read instruction for this source in the original workflow graph. */ originalName?: string; /** @@ -2415,20 +2086,16 @@ export namespace dataflow_v1b3 { */ split?: Schema$SourceSplitRequest; /** - * System-defined name of the stage containing the source operation. Unique - * across the workflow. + * System-defined name of the stage containing the source operation. Unique across the workflow. */ stageName?: string; /** - * System-defined name of the Read instruction for this source. Unique - * across the workflow. + * System-defined name of the Read instruction for this source. Unique across the workflow. */ systemName?: string; } /** - * The result of a SourceOperationRequest, specified in - * ReportWorkItemStatusRequest.source_operation when the work item is - * completed. + * The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed. */ export interface Schema$SourceOperationResponse { /** @@ -2441,13 +2108,11 @@ export namespace dataflow_v1b3 { split?: Schema$SourceSplitResponse; } /** - * Hints for splitting a Source into bundles (parts for parallel processing) - * using SourceSplitRequest. + * Hints for splitting a Source into bundles (parts for parallel processing) using SourceSplitRequest. */ export interface Schema$SourceSplitOptions { /** - * The source should be split into a set of bundles where the estimated size - * of each is approximately this many bytes. + * The source should be split into a set of bundles where the estimated size of each is approximately this many bytes. */ desiredBundleSizeBytes?: string; /** @@ -2456,17 +2121,7 @@ export namespace dataflow_v1b3 { desiredShardSizeBytes?: string; } /** - * Represents the operation to split a high-level Source specification into - * bundles (parts for parallel processing). At a high level, splitting of a - * source into bundles happens as follows: SourceSplitRequest is applied to - * the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further - * splitting happens and the source is used "as is". Otherwise, - * splitting is applied recursively to each produced DerivedSource. As an - * optimization, for any Source, if its does_not_need_splitting is true, the - * framework assumes that splitting this source would return - * SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a - * SourceSplitRequest. This applies both to the initial source being split and - * to bundles produced from it. + * Represents the operation to split a high-level Source specification into bundles (parts for parallel processing). At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used "as is". Otherwise, splitting is applied recursively to each produced DerivedSource. As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it. */ export interface Schema$SourceSplitRequest { /** @@ -2483,17 +2138,11 @@ export namespace dataflow_v1b3 { */ export interface Schema$SourceSplitResponse { /** - * If outcome is SPLITTING_HAPPENED, then this is a list of bundles into - * which the source was split. Otherwise this field is ignored. This list - * can be empty, which means the source represents an empty input. + * If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which the source was split. Otherwise this field is ignored. This list can be empty, which means the source represents an empty input. */ bundles?: Schema$DerivedSource[]; /** - * Indicates whether splitting happened and produced a list of bundles. If - * this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed - * "as is" without splitting. "bundles" is ignored in - * this case. If this is SPLITTING_HAPPENED, then "bundles" - * contains a list of bundles into which the source was split. + * Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" without splitting. "bundles" is ignored in this case. If this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the source was split. */ outcome?: string; /** @@ -2532,8 +2181,7 @@ export namespace dataflow_v1b3 { projectId?: string; } /** - * A representation of an int64, n, that is immune to precision loss when - * encoded in JSON. + * A representation of an int64, n, that is immune to precision loss when encoded in JSON. */ export interface Schema$SplitInt64 { /** @@ -2554,8 +2202,7 @@ export namespace dataflow_v1b3 { */ name?: string; /** - * User name for the original user transform or collection with which this - * source is most closely associated. + * User name for the original user transform or collection with which this source is most closely associated. */ originalTransformOrCollection?: string; /** @@ -2581,40 +2228,7 @@ export namespace dataflow_v1b3 { stateFamily?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -2622,30 +2236,16 @@ export namespace dataflow_v1b3 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Defines a particular step within a Cloud Dataflow job. A job consists of - * multiple steps, each of which performs some specific operation as part of - * the overall job. Data is typically passed from one step to another as part - * of the job. Here's an example of a sequence of steps which together - * implement a Map-Reduce job: * Read a collection of data from some - * source, parsing the collection's elements. * Validate the - * elements. * Apply a user-defined function to map each element to some - * value and extract an element-specific key value. * Group elements - * with the same key into a single element with that key, transforming a - * multiply-keyed collection into a uniquely-keyed collection. * Write - * the elements out to some data sink. Note that the Cloud Dataflow service - * may be used to run many different types of jobs, not just Map-Reduce. + * Defines a particular step within a Cloud Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce. */ export interface Schema$Step { /** @@ -2653,14 +2253,11 @@ export namespace dataflow_v1b3 { */ kind?: string; /** - * The name that identifies the step. This must be unique for each step with - * respect to all other steps in the Cloud Dataflow job. + * The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job. */ name?: string; /** - * Named properties associated with the step. Each kind of predefined step - * has its own required set of properties. Must be provided on Create. Only - * retrieved with JOB_VIEW_ALL. + * Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL. */ properties?: {[key: string]: any}; } @@ -2698,14 +2295,12 @@ export namespace dataflow_v1b3 { */ systemName?: string; /** - * Map from user name of stateful transforms in this stage to their state - * family. + * Map from user name of stateful transforms in this stage to their state family. */ transformUserNameToStateFamily?: {[key: string]: string}; } /** - * Describes full or partial data disk assignment information of the - * computation ranges. + * Describes full or partial data disk assignment information of the computation ranges. */ export interface Schema$StreamingComputationRanges { /** @@ -2718,8 +2313,7 @@ export namespace dataflow_v1b3 { rangeAssignments?: Schema$KeyRangeDataDiskAssignment[]; } /** - * A task which describes what action should be performed for the specified - * streaming computation ranges. + * A task which describes what action should be performed for the specified streaming computation ranges. */ export interface Schema$StreamingComputationTask { /** @@ -2752,15 +2346,11 @@ export namespace dataflow_v1b3 { */ userStepToStateFamilyNameMap?: {[key: string]: string}; /** - * If present, the worker must use this endpoint to communicate with - * Windmill Service dispatchers, otherwise the worker must continue to use - * whatever endpoint it had been using. + * If present, the worker must use this endpoint to communicate with Windmill Service dispatchers, otherwise the worker must continue to use whatever endpoint it had been using. */ windmillServiceEndpoint?: string; /** - * If present, the worker must use this port to communicate with Windmill - * Service dispatchers. Only applicable when windmill_service_endpoint is - * specified. + * If present, the worker must use this port to communicate with Windmill Service dispatchers. Only applicable when windmill_service_endpoint is specified. */ windmillServicePort?: string; } @@ -2773,8 +2363,7 @@ export namespace dataflow_v1b3 { */ drain?: boolean; /** - * The TCP port on which the worker should listen for messages from other - * streaming computation workers. + * The TCP port on which the worker should listen for messages from other streaming computation workers. */ receiveWorkPort?: number; /** @@ -2786,8 +2375,7 @@ export namespace dataflow_v1b3 { */ streamingComputationTopology?: Schema$TopologyConfig; /** - * The TCP port used by the worker to communicate with the Dataflow worker - * harness. + * The TCP port used by the worker to communicate with the Dataflow worker harness. */ workerHarnessPort?: number; } @@ -2805,8 +2393,7 @@ export namespace dataflow_v1b3 { tag?: string; } /** - * Identifies the location of a streaming computation stage, for - * stage-to-stage communication. + * Identifies the location of a streaming computation stage, for stage-to-stage communication. */ export interface Schema$StreamingStageLocation { /** @@ -2815,8 +2402,7 @@ export namespace dataflow_v1b3 { streamId?: string; } /** - * Describes a stream of data, either as input to be processed or as output of - * a streaming Dataflow job. + * Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job. */ export interface Schema$StreamLocation { /** @@ -2832,8 +2418,7 @@ export namespace dataflow_v1b3 { */ sideInputLocation?: Schema$StreamingSideInputLocation; /** - * The stream is part of another computation within the current streaming - * Dataflow job. + * The stream is part of another computation within the current streaming Dataflow job. */ streamingStageLocation?: Schema$StreamingStageLocation; } @@ -2847,14 +2432,11 @@ export namespace dataflow_v1b3 { elements?: string[]; } /** - * A rich message format, including a human readable string, a key for - * identifying the message, and structured data associated with the message - * for programmatic consumption. + * A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption. */ export interface Schema$StructuredMessage { /** - * Identifier for this message type. Used by external systems to - * internationalize or personalize message. + * Identifier for this message type. Used by external systems to internationalize or personalize message. */ messageKey?: string; /** @@ -2879,12 +2461,7 @@ export namespace dataflow_v1b3 { */ baseTaskDir?: string; /** - * The base URL for the taskrunner to use when accessing Google Cloud APIs. - * When workers access Google Cloud APIs, they logically do so via relative - * URLs. If this field is specified, it supplies the base URL to use for - * resolving these relative URLs. The normative algorithm used is defined - * by RFC 1808, "Relative Uniform Resource Locators". If not - * specified, the default value is "http://www.googleapis.com/" + * The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" */ baseUrl?: string; /** @@ -2912,20 +2489,15 @@ export namespace dataflow_v1b3 { */ logDir?: string; /** - * Whether to send taskrunner log info to Google Compute Engine VM serial - * console. + * Whether to send taskrunner log info to Google Compute Engine VM serial console. */ logToSerialconsole?: boolean; /** - * Indicates where to put logs. If this is not specified, the logs will not - * be uploaded. The supported resource type is: Google Cloud Storage: - * storage.googleapis.com/{bucket}/{object} - * bucket.storage.googleapis.com/{object} + * Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ logUploadLocation?: string; /** - * The OAuth2 scopes to be requested by the taskrunner in order to access - * the Cloud Dataflow API. + * The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. */ oauthScopes?: string[]; /** @@ -2937,20 +2509,15 @@ export namespace dataflow_v1b3 { */ streamingWorkerMainClass?: string; /** - * The UNIX group ID on the worker VM to use for tasks launched by - * taskrunner; e.g. "wheel". + * The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". */ taskGroup?: string; /** - * The UNIX user ID on the worker VM to use for tasks launched by - * taskrunner; e.g. "root". + * The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". */ taskUser?: string; /** - * The prefix of the resources the taskrunner should use for temporary - * storage. The supported resource type is: Google Cloud Storage: - * storage.googleapis.com/{bucket}/{object} - * bucket.storage.googleapis.com/{object} + * The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ tempStoragePrefix?: string; /** @@ -2980,8 +2547,7 @@ export namespace dataflow_v1b3 { parameters?: Schema$ParameterMetadata[]; } /** - * Global topology of the streaming Dataflow job, including all computations - * and their sharded locations. + * Global topology of the streaming Dataflow job, including all computations and their sharded locations. */ export interface Schema$TopologyConfig { /** @@ -3035,26 +2601,36 @@ export namespace dataflow_v1b3 { outputCollectionName?: string[]; } /** - * WorkerHealthReport contains information about the health of a worker. The - * VM should be identified by the labels attached to the WorkerMessage that - * this health ping belongs to. + * Response to the validation request. + */ + export interface Schema$ValidateResponse { + /** + * Will be empty if validation succeeds. + */ + errorMessage?: string; + } + /** + * WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. */ export interface Schema$WorkerHealthReport { /** - * The pods running on the worker. See: - * http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod - * This field is used by the worker to send the status of the indvidual - * containers running on each worker. + * A message describing any unusual health reports. + */ + msg?: string; + /** + * The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod This field is used by the worker to send the status of the indvidual containers running on each worker. */ pods?: Array<{[key: string]: any}>; /** - * The interval at which the worker is sending health reports. The default - * value of 0 should be interpreted as the field is not being explicitly set - * by the worker. + * The interval at which the worker is sending health reports. The default value of 0 should be interpreted as the field is not being explicitly set by the worker. */ reportInterval?: string; /** - * Whether the VM is healthy. + * Whether the VM is in a permanently broken state. Broken VMs should be abandoned or deleted ASAP to avoid assigning or completing any work. + */ + vmIsBroken?: boolean; + /** + * Whether the VM is currently healthy. */ vmIsHealthy?: boolean; /** @@ -3063,28 +2639,20 @@ export namespace dataflow_v1b3 { vmStartupTime?: string; } /** - * WorkerHealthReportResponse contains information returned to the worker in - * response to a health ping. + * WorkerHealthReportResponse contains information returned to the worker in response to a health ping. */ export interface Schema$WorkerHealthReportResponse { /** - * A positive value indicates the worker should change its reporting - * interval to the specified value. The default value of zero means no - * change in report rate is requested by the server. + * A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server. */ reportInterval?: string; } /** - * A report of an event in a worker's lifecycle. The proto contains one - * event, because the worker is expected to asynchronously send each message - * immediately after the event. Due to this asynchrony, messages may arrive - * out of order (or missing), and it is up to the consumer to interpret. The - * timestamp of the event is in the enclosing WorkerMessage proto. + * A report of an event in a worker's lifecycle. The proto contains one event, because the worker is expected to asynchronously send each message immediately after the event. Due to this asynchrony, messages may arrive out of order (or missing), and it is up to the consumer to interpret. The timestamp of the event is in the enclosing WorkerMessage proto. */ export interface Schema$WorkerLifecycleEvent { /** - * The start time of this container. All events will report this so that - * events can be grouped together across container/VM restarts. + * The start time of this container. All events will report this so that events can be grouped together across container/VM restarts. */ containerStartTime?: string; /** @@ -3092,8 +2660,7 @@ export namespace dataflow_v1b3 { */ event?: string; /** - * Other stats that can accompany an event. E.g. { - * "downloaded_bytes" : "123456" } + * Other stats that can accompany an event. E.g. { "downloaded_bytes" : "123456" } */ metadata?: {[key: string]: string}; } @@ -3102,14 +2669,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$WorkerMessage { /** - * Labels are used to group WorkerMessages. For example, a worker_message - * about a particular container might have the labels: { "JOB_ID": - * "2015-04-22", "WORKER_ID": - * "wordcount-vm-2015…" "CONTAINER_TYPE": - * "worker", "CONTAINER_ID": "ac1234def"} - * Label tags typically correspond to Label enum values. However, for ease - * of development other strings can be used as tags. LABEL_UNSPECIFIED - * should not be used here. + * Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here. */ labels?: {[key: string]: string}; /** @@ -3138,44 +2698,20 @@ export namespace dataflow_v1b3 { workerShutdownNotice?: Schema$WorkerShutdownNotice; } /** - * A message code is used to report status and error messages to the service. - * The message codes are intended to be machine readable. The service will - * take care of translating these into user understandable messages if - * necessary. Example use cases: 1. Worker processes reporting successful - * startup. 2. Worker processes reporting specific errors (e.g. package - * staging failure). + * A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure). */ export interface Schema$WorkerMessageCode { /** - * The code is a string intended for consumption by a machine that - * identifies the type of message being sent. Examples: 1. - * "HARNESS_STARTED" might be used to indicate the worker harness - * has started. 2. "GCS_DOWNLOAD_ERROR" might be used to - * indicate an error downloading a GCS file as part of the boot process - * of one of the worker containers. This is a string and not an enum to - * make it easy to add new codes without waiting for an API change. + * The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a GCS file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change. */ code?: string; /** - * Parameters contains specific information about the code. This is a - * struct to allow parameters of different types. Examples: 1. For a - * "HARNESS_STARTED" message parameters might provide the name of - * the worker and additional data like timing information. 2. For a - * "GCS_DOWNLOAD_ERROR" parameters might contain fields listing - * the GCS objects being downloaded and fields containing errors. In - * general complex data structures should be avoided. If a worker needs to - * send a specific and complicated data structure then please consider - * defining a new proto and adding it to the data oneof in - * WorkerMessageResponse. Conventions: Parameters should only be used for - * information that isn't typically passed as a label. hostname and - * other worker identifiers should almost always be passed as labels since - * they will be included on most messages. + * Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages. */ parameters?: {[key: string]: any}; } /** - * A worker_message response allows the server to pass information to the - * sender. + * A worker_message response allows the server to pass information to the sender. */ export interface Schema$WorkerMessageResponse { /** @@ -3192,11 +2728,7 @@ export namespace dataflow_v1b3 { workerShutdownNoticeResponse?: Schema$WorkerShutdownNoticeResponse; } /** - * Describes one particular pool of Cloud Dataflow workers to be instantiated - * by the Cloud Dataflow service in order to perform the computations required - * by a job. Note that a workflow job may use multiple pools, in order to - * match the various computational requirements of the various stages of the - * job. + * Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job. */ export interface Schema$WorkerPool { /** @@ -3208,14 +2740,11 @@ export namespace dataflow_v1b3 { */ dataDisks?: Schema$Disk[]; /** - * The default package set to install. This allows the service to select a - * default set of packages which are useful to worker harnesses written in a - * particular language. + * The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. */ defaultPackageSet?: string; /** - * Size of root disk for VMs, in GB. If zero or unspecified, the service - * will attempt to choose a reasonable default. + * Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. */ diskSizeGb?: number; /** @@ -3223,8 +2752,7 @@ export namespace dataflow_v1b3 { */ diskSourceImage?: string; /** - * Type of root disk for VMs. If empty or unspecified, the service will - * attempt to choose a reasonable default. + * Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. */ diskType?: string; /** @@ -3232,13 +2760,11 @@ export namespace dataflow_v1b3 { */ ipConfiguration?: string; /** - * The kind of the worker pool; currently only `harness` and `shuffle` are - * supported. + * The kind of the worker pool; currently only `harness` and `shuffle` are supported. */ kind?: string; /** - * Machine type (e.g. "n1-standard-1"). If empty or unspecified, - * the service will attempt to choose a reasonable default. + * Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. */ machineType?: string; /** @@ -3246,26 +2772,19 @@ export namespace dataflow_v1b3 { */ metadata?: {[key: string]: string}; /** - * Network to which VMs will be assigned. If empty or unspecified, the - * service will use the network "default". + * Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */ network?: string; /** - * The number of threads per worker harness. If empty or unspecified, the - * service will choose a number of threads (according to the number of cores - * on the selected machine type for batch, or 1 by convention for - * streaming). + * The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming). */ numThreadsPerWorker?: number; /** - * Number of Google Compute Engine workers in this pool needed to execute - * the job. If zero or unspecified, the service will attempt to choose a - * reasonable default. + * Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. */ numWorkers?: number; /** - * The action to take on host maintenance, as defined by the Google Compute - * Engine API. + * The action to take on host maintenance, as defined by the Google Compute Engine API. */ onHostMaintenance?: string; /** @@ -3277,38 +2796,23 @@ export namespace dataflow_v1b3 { */ poolArgs?: {[key: string]: any}; /** - * Subnetwork to which VMs will be assigned, if desired. Expected to be of - * the form "regions/REGION/subnetworks/SUBNETWORK". + * Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". */ subnetwork?: string; /** - * Settings passed through to Google Compute Engine workers when using the - * standard Dataflow task runner. Users should ignore this field. + * Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. */ taskrunnerSettings?: Schema$TaskRunnerSettings; /** - * Sets the policy for determining when to turndown worker pool. Allowed - * values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and - * `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down - * regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means - * workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the - * workers are never torn down. If the workers are not torn down by the - * service, they will continue to run and use Google Compute Engine VM - * resources in the user's project until they are explicitly terminated - * by the user. Because of this, Google recommends using the - * `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. - * If unknown or unspecified, the service will attempt to choose a - * reasonable default. + * Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. */ teardownPolicy?: string; /** - * Required. Docker container image that executes the Cloud Dataflow worker - * harness, residing in Google Container Registry. + * Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. */ workerHarnessContainerImage?: string; /** - * Zone to run the worker pools in. If empty or unspecified, the service - * will attempt to choose a reasonable default. + * Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. */ zone?: string; } @@ -3317,12 +2821,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$WorkerSettings { /** - * The base URL for accessing Google Cloud APIs. When workers access Google - * Cloud APIs, they logically do so via relative URLs. If this field is - * specified, it supplies the base URL to use for resolving these relative - * URLs. The normative algorithm used is defined by RFC 1808, - * "Relative Uniform Resource Locators". If not specified, the - * default value is "http://www.googleapis.com/" + * The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" */ baseUrl?: string; /** @@ -3330,20 +2829,15 @@ export namespace dataflow_v1b3 { */ reportingEnabled?: boolean; /** - * The Cloud Dataflow service path relative to the root URL, for example, - * "dataflow/v1b3/projects". + * The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". */ servicePath?: string; /** - * The Shuffle service path relative to the root URL, for example, - * "shuffle/v1beta1". + * The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". */ shuffleServicePath?: string; /** - * The prefix of the resources the system should use for temporary storage. - * The supported resource type is: Google Cloud Storage: - * storage.googleapis.com/{bucket}/{object} - * bucket.storage.googleapis.com/{object} + * The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */ tempStoragePrefix?: string; /** @@ -3352,16 +2846,11 @@ export namespace dataflow_v1b3 { workerId?: string; } /** - * Shutdown notification from workers. This is to be sent by the shutdown - * script of the worker VM so that the backend knows that the VM is being shut - * down. + * Shutdown notification from workers. This is to be sent by the shutdown script of the worker VM so that the backend knows that the VM is being shut down. */ export interface Schema$WorkerShutdownNotice { /** - * The reason for the worker shutdown. Current possible values are: - * "UNKNOWN": shutdown reason is unknown. "PREEMPTION": - * shutdown reason is preemption. Other possible reasons may be added in the - * future. + * The reason for the worker shutdown. Current possible values are: "UNKNOWN": shutdown reason is unknown. "PREEMPTION": shutdown reason is preemption. Other possible reasons may be added in the future. */ reason?: string; } @@ -3370,8 +2859,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$WorkerShutdownNoticeResponse {} /** - * WorkItem represents basic information about a WorkItem to be executed in - * the cloud. + * WorkItem represents basic information about a WorkItem to be executed in the cloud. */ export interface Schema$WorkItem { /** @@ -3399,8 +2887,7 @@ export namespace dataflow_v1b3 { */ mapTask?: Schema$MapTask; /** - * Any required packages that need to be fetched in order to execute this - * WorkItem. + * Any required packages that need to be fetched in order to execute this WorkItem. */ packages?: Schema$Package[]; /** @@ -3437,13 +2924,11 @@ export namespace dataflow_v1b3 { streamingSetupTask?: Schema$StreamingSetupTask; } /** - * The Dataflow service's idea of the current state of a WorkItem being - * processed by a worker. + * The Dataflow service's idea of the current state of a WorkItem being processed by a worker. */ export interface Schema$WorkItemServiceState { /** - * Other data returned by the service, specific to the particular worker - * harness. + * Other data returned by the service, specific to the particular worker harness. */ harnessData?: {[key: string]: any}; /** @@ -3451,17 +2936,11 @@ export namespace dataflow_v1b3 { */ leaseExpireTime?: string; /** - * The short ids that workers should use in subsequent metric updates. - * Workers should strive to use short ids whenever possible, but it is ok to - * request the short_id again if a worker lost track of it (e.g. if the - * worker is recovering from a crash). NOTE: it is possible that the - * response may have short ids for a subset of the metrics. + * The short ids that workers should use in subsequent metric updates. Workers should strive to use short ids whenever possible, but it is ok to request the short_id again if a worker lost track of it (e.g. if the worker is recovering from a crash). NOTE: it is possible that the response may have short ids for a subset of the metrics. */ metricShortId?: Schema$MetricShortId[]; /** - * The index value to use for the next report sent by the worker. Note: If - * the report call fails for whatever reason, the worker should reuse this - * index for subsequent report attempts. + * The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts. */ nextReportIndex?: string; /** @@ -3469,8 +2948,7 @@ export namespace dataflow_v1b3 { */ reportStatusInterval?: string; /** - * The progress point in the WorkItem where the Dataflow service suggests - * that the worker truncate the task. + * The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task. */ splitRequest?: Schema$ApproximateSplitRequest; /** @@ -3499,9 +2977,7 @@ export namespace dataflow_v1b3 { */ dynamicSourceSplit?: Schema$DynamicSourceSplit; /** - * Specifies errors which occurred during processing. If errors are - * provided, and completed = true, then the WorkItem is considered to have - * failed. + * Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed. */ errors?: Schema$Status[]; /** @@ -3517,16 +2993,7 @@ export namespace dataflow_v1b3 { */ reportedProgress?: Schema$ApproximateReportedProgress; /** - * The report index. When a WorkItem is leased, the lease will contain an - * initial report index. When a WorkItem's status is reported to the - * system, the report should be sent with that report index, and the - * response will contain the index the worker should use for the next - * report. Reports received with unexpected index values will be rejected - * by the service. In order to preserve idempotency, the worker should not - * alter the contents of a report, even if the worker must submit the same - * report multiple times before getting back a response. The worker should - * not submit a subsequent report until the response for the previous report - * had been received from the service. + * The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service. */ reportIndex?: string; /** @@ -3538,36 +3005,11 @@ export namespace dataflow_v1b3 { */ sourceFork?: Schema$SourceFork; /** - * If the work item represented a SourceOperationRequest, and the work is - * completed, contains the result of the operation. + * If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation. */ sourceOperationResponse?: Schema$SourceOperationResponse; /** - * A worker may split an active map task in two parts, "primary" - * and "residual", continuing to process the primary part and - * returning the residual part into the pool of available work. This event - * is called a "dynamic split" and is critical to the dynamic work - * rebalancing feature. The two obtained sub-tasks are called - * "parts" of the split. The parts, if concatenated, must - * represent the same input as would be read by the current task if the - * split did not happen. The exact way in which the original task is - * decomposed into the two parts is specified either as a position - * demarcating them (stop_position), or explicitly as two DerivedSources, if - * this task consumes a user-defined source type (dynamic_source_split). The - * "current" task is adjusted as a result of the split: after a - * task with range [A, B) sends a stop_position update at C, its range is - * considered to be [A, C), e.g.: * Progress should be interpreted relative - * to the new range, e.g. "75% completed" means "75% of [A, - * C) completed" * The worker should interpret proposed_stop_position - * relative to the new range, e.g. "split at 68%" should be - * interpreted as "split at 68% of [A, C)". * If the worker - * chooses to split again using stop_position, only stop_positions in [A, - * C) will be accepted. * Etc. dynamic_source_split has similar semantics: - * e.g., if a task with source S splits using dynamic_source_split into {P, - * R} (where P and R must be together equivalent to S), then subsequent - * progress and proposed_stop_position should be interpreted relative to P, - * and in a potential subsequent dynamic_source_split into {P', R'}, - * P' and R' must be together equivalent to P, etc. + * A worker may split an active map task in two parts, "primary" and "residual", continuing to process the primary part and returning the residual part into the pool of available work. This event is called a "dynamic split" and is critical to the dynamic work rebalancing feature. The two obtained sub-tasks are called "parts" of the split. The parts, if concatenated, must represent the same input as would be read by the current task if the split did not happen. The exact way in which the original task is decomposed into the two parts is specified either as a position demarcating them (stop_position), or explicitly as two DerivedSources, if this task consumes a user-defined source type (dynamic_source_split). The "current" task is adjusted as a result of the split: after a task with range [A, B) sends a stop_position update at C, its range is considered to be [A, C), e.g.: * Progress should be interpreted relative to the new range, e.g. "75% completed" means "75% of [A, C) completed" * The worker should interpret proposed_stop_position relative to the new range, e.g. "split at 68%" should be interpreted as "split at 68% of [A, C)". * If the worker chooses to split again using stop_position, only stop_positions in [A, C) will be accepted. * Etc. dynamic_source_split has similar semantics: e.g., if a task with source S splits using dynamic_source_split into {P, R} (where P and R must be together equivalent to S), then subsequent progress and proposed_stop_position should be interpreted relative to P, and in a potential subsequent dynamic_source_split into {P', R'}, P' and R' must be together equivalent to P, etc. */ stopPosition?: Schema$Position; /** @@ -3597,14 +3039,96 @@ export namespace dataflow_v1b3 { context: APIRequestContext; jobs: Resource$Projects$Jobs; locations: Resource$Projects$Locations; + snapshots: Resource$Projects$Snapshots; templates: Resource$Projects$Templates; constructor(context: APIRequestContext) { this.context = context; this.jobs = new Resource$Projects$Jobs(this.context); this.locations = new Resource$Projects$Locations(this.context); + this.snapshots = new Resource$Projects$Snapshots(this.context); this.templates = new Resource$Projects$Templates(this.context); } + /** + * dataflow.projects.deleteSnapshots + * @desc Deletes a snapshot. + * @alias dataflow.projects.deleteSnapshots + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.location The location that contains this snapshot. + * @param {string} params.projectId The ID of the Cloud Platform project that the snapshot belongs to. + * @param {string=} params.snapshotId The ID of the snapshot. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteSnapshots( + params?: Params$Resource$Projects$Deletesnapshots, + options?: MethodOptions + ): GaxiosPromise; + deleteSnapshots( + params: Params$Resource$Projects$Deletesnapshots, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteSnapshots( + params: Params$Resource$Projects$Deletesnapshots, + callback: BodyResponseCallback + ): void; + deleteSnapshots( + callback: BodyResponseCallback + ): void; + deleteSnapshots( + paramsOrCallback?: + | Params$Resource$Projects$Deletesnapshots + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Deletesnapshots; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Deletesnapshots; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1b3/projects/{projectId}/snapshots').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['projectId'], + pathParams: ['projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * dataflow.projects.workerMessages * @desc Send a worker_message to the service. @@ -3687,6 +3211,26 @@ export namespace dataflow_v1b3 { } } + export interface Params$Resource$Projects$Deletesnapshots + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The location that contains this snapshot. + */ + location?: string; + /** + * The ID of the Cloud Platform project that the snapshot belongs to. + */ + projectId?: string; + /** + * The ID of the snapshot. + */ + snapshotId?: string; + } export interface Params$Resource$Projects$Workermessages extends StandardParameters { /** @@ -3797,11 +3341,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.jobs.create - * @desc Creates a Cloud Dataflow job. To create a job, we recommend using - * `projects.locations.jobs.create` with a [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.create` is not recommended, as your job will always - * start in `us-central1`. + * @desc Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. * @alias dataflow.projects.jobs.create * @memberOf! () * @@ -3877,12 +3417,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.jobs.get - * @desc Gets the state of the specified Cloud Dataflow job. To get the - * state of a job, we recommend using `projects.locations.jobs.get` with a - * [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.get` is not recommended, as you can only get the - * state of jobs that are running in `us-central1`. + * @desc Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. * @alias dataflow.projects.jobs.get * @memberOf! () * @@ -3957,12 +3492,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.jobs.getMetrics - * @desc Request the job status. To request the status of a job, we - * recommend using `projects.locations.jobs.getMetrics` with a [regional - * endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.getMetrics` is not recommended, as you can only - * request the status of jobs that are running in `us-central1`. + * @desc Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. * @alias dataflow.projects.jobs.getMetrics * @memberOf! () * @@ -4038,13 +3568,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.jobs.list - * @desc List the jobs of a project. To list the jobs of a project in a - * region, we recommend using `projects.locations.jobs.get` with a [regional - * endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To - * list the all jobs across all regions, use `projects.jobs.aggregated`. - * Using `projects.jobs.list` is not recommended, as you can only get the - * list of jobs that are running in `us-central1`. + * @desc List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`. * @alias dataflow.projects.jobs.list * @memberOf! () * @@ -4196,12 +3720,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.jobs.update - * @desc Updates the state of an existing Cloud Dataflow job. To update the - * state of an existing job, we recommend using - * `projects.locations.jobs.update` with a [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.update` is not recommended, as you can only update - * the state of jobs that are running in `us-central1`. + * @desc Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. * @alias dataflow.projects.jobs.update * @memberOf! () * @@ -4287,20 +3806,15 @@ export namespace dataflow_v1b3 { */ filter?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** - * If there are many jobs, limit response to at most this many. The actual - * number of jobs returned will be the lesser of max_responses and an - * unspecified server-defined limit. + * If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. */ pageSize?: number; /** - * Set this to the 'next_page_token' field of a previous response to request - * additional results in a long list. + * Set this to the 'next_page_token' field of a previous response to request additional results in a long list. */ pageToken?: string; /** @@ -4308,8 +3822,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * Level of information requested in response. Default is - * `JOB_VIEW_SUMMARY`. + * Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. */ view?: string; } @@ -4321,9 +3834,7 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** @@ -4356,9 +3867,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** @@ -4382,9 +3891,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -4392,8 +3899,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * Return only metric data that has changed since this time. Default is to - * return all information about all metrics for the job. + * Return only metric data that has changed since this time. Default is to return all information about all metrics for the job. */ startTime?: string; } @@ -4409,20 +3915,15 @@ export namespace dataflow_v1b3 { */ filter?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** - * If there are many jobs, limit response to at most this many. The actual - * number of jobs returned will be the lesser of max_responses and an - * unspecified server-defined limit. + * If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. */ pageSize?: number; /** - * Set this to the 'next_page_token' field of a previous response to request - * additional results in a long list. + * Set this to the 'next_page_token' field of a previous response to request additional results in a long list. */ pageToken?: string; /** @@ -4430,8 +3931,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * Level of information requested in response. Default is - * `JOB_VIEW_SUMMARY`. + * Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. */ view?: string; } @@ -4468,9 +3968,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** @@ -4702,12 +4200,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.jobs.messages.list - * @desc Request the job status. To request the status of a job, we - * recommend using `projects.locations.jobs.messages.list` with a [regional - * endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.messages.list` is not recommended, as you can only - * request the status of jobs that are running in `us-central1`. + * @desc Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`. * @alias dataflow.projects.jobs.messages.list * @memberOf! () * @@ -4796,8 +4289,7 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Return only messages with timestamps < end_time. The default is now (i.e. - * return up to the latest messages available). + * Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available). */ endTime?: string; /** @@ -4805,9 +4297,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -4815,14 +4305,11 @@ export namespace dataflow_v1b3 { */ minimumImportance?: string; /** - * If specified, determines the maximum number of messages to return. If - * unspecified, the service may choose an appropriate default, or may return - * an arbitrarily large number of results. + * If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results. */ pageSize?: number; /** - * If supplied, this should be the value of next_page_token returned by an - * earlier call. This will cause the next page of results to be returned. + * If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned. */ pageToken?: string; /** @@ -4830,8 +4317,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * If specified, return only messages with timestamps >= start_time. The - * default is the job creation time (i.e. beginning of messages). + * If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages). */ startTime?: string; } @@ -5052,10 +4538,14 @@ export namespace dataflow_v1b3 { export class Resource$Projects$Locations { context: APIRequestContext; jobs: Resource$Projects$Locations$Jobs; + snapshots: Resource$Projects$Locations$Snapshots; + sql: Resource$Projects$Locations$Sql; templates: Resource$Projects$Locations$Templates; constructor(context: APIRequestContext) { this.context = context; this.jobs = new Resource$Projects$Locations$Jobs(this.context); + this.snapshots = new Resource$Projects$Locations$Snapshots(this.context); + this.sql = new Resource$Projects$Locations$Sql(this.context); this.templates = new Resource$Projects$Locations$Templates(this.context); } @@ -5151,9 +4641,7 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job. */ location?: string; /** @@ -5185,11 +4673,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.locations.jobs.create - * @desc Creates a Cloud Dataflow job. To create a job, we recommend using - * `projects.locations.jobs.create` with a [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.create` is not recommended, as your job will always - * start in `us-central1`. + * @desc Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. * @alias dataflow.projects.locations.jobs.create * @memberOf! () * @@ -5264,12 +4748,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.locations.jobs.get - * @desc Gets the state of the specified Cloud Dataflow job. To get the - * state of a job, we recommend using `projects.locations.jobs.get` with a - * [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.get` is not recommended, as you can only get the - * state of jobs that are running in `us-central1`. + * @desc Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. * @alias dataflow.projects.locations.jobs.get * @memberOf! () * @@ -5344,12 +4823,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.locations.jobs.getMetrics - * @desc Request the job status. To request the status of a job, we - * recommend using `projects.locations.jobs.getMetrics` with a [regional - * endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.getMetrics` is not recommended, as you can only - * request the status of jobs that are running in `us-central1`. + * @desc Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. * @alias dataflow.projects.locations.jobs.getMetrics * @memberOf! () * @@ -5426,13 +4900,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.locations.jobs.list - * @desc List the jobs of a project. To list the jobs of a project in a - * region, we recommend using `projects.locations.jobs.get` with a [regional - * endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To - * list the all jobs across all regions, use `projects.jobs.aggregated`. - * Using `projects.jobs.list` is not recommended, as you can only get the - * list of jobs that are running in `us-central1`. + * @desc List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`. * @alias dataflow.projects.locations.jobs.list * @memberOf! () * @@ -5585,12 +5053,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.locations.jobs.update - * @desc Updates the state of an existing Cloud Dataflow job. To update the - * state of an existing job, we recommend using - * `projects.locations.jobs.update` with a [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.update` is not recommended, as you can only update - * the state of jobs that are running in `us-central1`. + * @desc Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. * @alias dataflow.projects.locations.jobs.update * @memberOf! () * @@ -5672,9 +5135,7 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** @@ -5707,9 +5168,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** @@ -5733,9 +5192,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -5743,8 +5200,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * Return only metric data that has changed since this time. Default is to - * return all information about all metrics for the job. + * Return only metric data that has changed since this time. Default is to return all information about all metrics for the job. */ startTime?: string; } @@ -5760,20 +5216,15 @@ export namespace dataflow_v1b3 { */ filter?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** - * If there are many jobs, limit response to at most this many. The actual - * number of jobs returned will be the lesser of max_responses and an - * unspecified server-defined limit. + * If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. */ pageSize?: number; /** - * Set this to the 'next_page_token' field of a previous response to request - * additional results in a long list. + * Set this to the 'next_page_token' field of a previous response to request additional results in a long list. */ pageToken?: string; /** @@ -5781,8 +5232,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * Level of information requested in response. Default is - * `JOB_VIEW_SUMMARY`. + * Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. */ view?: string; } @@ -5823,9 +5273,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains this job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */ location?: string; /** @@ -6020,9 +5468,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -6047,9 +5493,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -6071,12 +5515,7 @@ export namespace dataflow_v1b3 { /** * dataflow.projects.locations.jobs.messages.list - * @desc Request the job status. To request the status of a job, we - * recommend using `projects.locations.jobs.messages.list` with a [regional - * endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). - * Using `projects.jobs.messages.list` is not recommended, as you can only - * request the status of jobs that are running in `us-central1`. + * @desc Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.messages.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.messages.list` is not recommended, as you can only request the status of jobs that are running in `us-central1`. * @alias dataflow.projects.locations.jobs.messages.list * @memberOf! () * @@ -6166,8 +5605,7 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Return only messages with timestamps < end_time. The default is now (i.e. - * return up to the latest messages available). + * Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available). */ endTime?: string; /** @@ -6175,9 +5613,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the job specified by job_id. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. */ location?: string; /** @@ -6185,14 +5621,11 @@ export namespace dataflow_v1b3 { */ minimumImportance?: string; /** - * If specified, determines the maximum number of messages to return. If - * unspecified, the service may choose an appropriate default, or may return - * an arbitrarily large number of results. + * If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results. */ pageSize?: number; /** - * If supplied, this should be the value of next_page_token returned by an - * earlier call. This will cause the next page of results to be returned. + * If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned. */ pageToken?: string; /** @@ -6200,8 +5633,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * If specified, return only messages with timestamps >= start_time. The - * default is the job creation time (i.e. beginning of messages). + * If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages). */ startTime?: string; } @@ -6390,9 +5822,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the WorkItem's job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. */ location?: string; /** @@ -6417,9 +5847,7 @@ export namespace dataflow_v1b3 { */ jobId?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - * contains the WorkItem's job. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. */ location?: string; /** @@ -6433,54 +5861,58 @@ export namespace dataflow_v1b3 { requestBody?: Schema$ReportWorkItemStatusRequest; } - export class Resource$Projects$Locations$Templates { + export class Resource$Projects$Locations$Snapshots { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * dataflow.projects.locations.templates.create - * @desc Creates a Cloud Dataflow job from a template. - * @alias dataflow.projects.locations.templates.create + * dataflow.projects.locations.snapshots.delete + * @desc Deletes a snapshot. + * @alias dataflow.projects.locations.snapshots.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. - * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. - * @param {().CreateJobFromTemplateRequest} params.resource Request body data + * @param {string} params.location The location that contains this snapshot. + * @param {string} params.projectId The ID of the Cloud Platform project that the snapshot belongs to. + * @param {string} params.snapshotId The ID of the snapshot. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params?: Params$Resource$Projects$Locations$Templates$Create, + delete( + params?: Params$Resource$Projects$Locations$Snapshots$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Templates$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Snapshots$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Templates$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Snapshots$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Templates$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Snapshots$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Templates$Create; + {}) as Params$Resource$Projects$Locations$Snapshots$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Templates$Create; + params = {} as Params$Resource$Projects$Locations$Snapshots$Delete; options = {}; } @@ -6495,69 +5927,66 @@ export namespace dataflow_v1b3 { { url: ( rootUrl + - '/v1b3/projects/{projectId}/locations/{location}/templates' + '/v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), params, - requiredParams: ['projectId', 'location'], - pathParams: ['location', 'projectId'], + requiredParams: ['projectId', 'location', 'snapshotId'], + pathParams: ['location', 'projectId', 'snapshotId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataflow.projects.locations.templates.get - * @desc Get the template associated with a template. - * @alias dataflow.projects.locations.templates.get + * dataflow.projects.locations.snapshots.get + * @desc Gets information about a snapshot. + * @alias dataflow.projects.locations.snapshots.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. - * @param {string} params.location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. - * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. - * @param {string=} params.view The view to retrieve. Defaults to METADATA_ONLY. + * @param {string} params.location The location that contains this snapshot. + * @param {string} params.projectId The ID of the Cloud Platform project that the snapshot belongs to. + * @param {string} params.snapshotId The ID of the snapshot. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Templates$Get, + params?: Params$Resource$Projects$Locations$Snapshots$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Templates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Snapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Templates$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Snapshots$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Templates$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Snapshots$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Templates$Get; + {}) as Params$Resource$Projects$Locations$Snapshots$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Templates$Get; + params = {} as Params$Resource$Projects$Locations$Snapshots$Get; options = {}; } @@ -6572,74 +6001,69 @@ export namespace dataflow_v1b3 { { url: ( rootUrl + - '/v1b3/projects/{projectId}/locations/{location}/templates:get' + '/v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId', 'location'], - pathParams: ['location', 'projectId'], + requiredParams: ['projectId', 'location', 'snapshotId'], + pathParams: ['location', 'projectId', 'snapshotId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataflow.projects.locations.templates.launch - * @desc Launch a template. - * @alias dataflow.projects.locations.templates.launch + * dataflow.projects.locations.snapshots.list + * @desc Lists snapshots. + * @alias dataflow.projects.locations.snapshots.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dynamicTemplate.gcsPath Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object. - * @param {string=} params.dynamicTemplate.stagingLocation Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`. - * @param {string=} params.gcsPath A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. - * @param {string} params.location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. - * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. - * @param {boolean=} params.validateOnly If true, the request is validated but not actually executed. Defaults to false. - * @param {().LaunchTemplateParameters} params.resource Request body data + * @param {string} params.location The location to list snapshots in. + * @param {string} params.projectId The project ID to list snapshots for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - launch( - params?: Params$Resource$Projects$Locations$Templates$Launch, + list( + params?: Params$Resource$Projects$Locations$Snapshots$List, options?: MethodOptions - ): GaxiosPromise; - launch( - params: Params$Resource$Projects$Locations$Templates$Launch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Snapshots$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - launch( - params: Params$Resource$Projects$Locations$Templates$Launch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Snapshots$List, + callback: BodyResponseCallback ): void; - launch(callback: BodyResponseCallback): void; - launch( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Templates$Launch - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Snapshots$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Templates$Launch; + {}) as Params$Resource$Projects$Locations$Snapshots$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Templates$Launch; + params = {} as Params$Resource$Projects$Locations$Snapshots$List; options = {}; } @@ -6654,9 +6078,9 @@ export namespace dataflow_v1b3 { { url: ( rootUrl + - '/v1b3/projects/{projectId}/locations/{location}/templates:launch' + '/v1b3/projects/{projectId}/locations/{location}/snapshots' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), @@ -6666,14 +6090,14 @@ export namespace dataflow_v1b3 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Templates$Create + export interface Params$Resource$Projects$Locations$Snapshots$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -6681,22 +6105,19 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - * which to direct the request. + * The location that contains this snapshot. */ location?: string; /** - * Required. The ID of the Cloud Platform project that the job belongs to. + * The ID of the Cloud Platform project that the snapshot belongs to. */ projectId?: string; - /** - * Request body metadata + * The ID of the snapshot. */ - requestBody?: Schema$CreateJobFromTemplateRequest; + snapshotId?: string; } - export interface Params$Resource$Projects$Locations$Templates$Get + export interface Params$Resource$Projects$Locations$Snapshots$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -6704,26 +6125,19 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A Cloud Storage path to the template from which to create the - * job. Must be valid Cloud Storage URL, beginning with 'gs://'. - */ - gcsPath?: string; - /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - * which to direct the request. + * The location that contains this snapshot. */ location?: string; /** - * Required. The ID of the Cloud Platform project that the job belongs to. + * The ID of the Cloud Platform project that the snapshot belongs to. */ projectId?: string; /** - * The view to retrieve. Defaults to METADATA_ONLY. + * The ID of the snapshot. */ - view?: string; + snapshotId?: string; } - export interface Params$Resource$Projects$Locations$Templates$Launch + export interface Params$Resource$Projects$Locations$Snapshots$List extends StandardParameters { /** * Auth client or API Key for the request @@ -6731,40 +6145,634 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Path to dynamic template spec file on GCS. The file must be a Json - * serialized DynamicTemplateFieSpec object. - */ - 'dynamicTemplate.gcsPath'?: string; - /** - * Cloud Storage path for staging dependencies. Must be a valid Cloud - * Storage URL, beginning with `gs://`. - */ - 'dynamicTemplate.stagingLocation'?: string; - /** - * A Cloud Storage path to the template from which to create the job. Must - * be valid Cloud Storage URL, beginning with 'gs://'. - */ - gcsPath?: string; - /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - * which to direct the request. + * The location to list snapshots in. */ location?: string; /** - * Required. The ID of the Cloud Platform project that the job belongs to. + * The project ID to list snapshots for. */ projectId?: string; - /** - * If true, the request is validated but not actually executed. Defaults to - * false. - */ - validateOnly?: boolean; + } + + export class Resource$Projects$Locations$Sql { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Request body metadata + * dataflow.projects.locations.sql.validate + * @desc Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the given query parses correctly, and if able to look up schema information from DataCatalog, will validate that the query analyzes properly as well. + * @alias dataflow.projects.locations.sql.validate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. + * @param {string=} params.query The sql query to validate. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object */ - requestBody?: Schema$LaunchTemplateParameters; + validate( + params?: Params$Resource$Projects$Locations$Sql$Validate, + options?: MethodOptions + ): GaxiosPromise; + validate( + params: Params$Resource$Projects$Locations$Sql$Validate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validate( + params: Params$Resource$Projects$Locations$Sql$Validate, + callback: BodyResponseCallback + ): void; + validate(callback: BodyResponseCallback): void; + validate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sql$Validate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sql$Validate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Sql$Validate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1b3/projects/{projectId}/locations/{location}/sql:validate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'location'], + pathParams: ['location', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Sql$Validate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + */ + location?: string; + /** + * Required. The ID of the Cloud Platform project that the job belongs to. + */ + projectId?: string; + /** + * The sql query to validate. + */ + query?: string; + } + + export class Resource$Projects$Locations$Templates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataflow.projects.locations.templates.create + * @desc Creates a Cloud Dataflow job from a template. + * @alias dataflow.projects.locations.templates.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. + * @param {().CreateJobFromTemplateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Templates$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Templates$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Templates$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Templates$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Templates$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Templates$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1b3/projects/{projectId}/locations/{location}/templates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['projectId', 'location'], + pathParams: ['location', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataflow.projects.locations.templates.get + * @desc Get the template associated with a template. + * @alias dataflow.projects.locations.templates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * @param {string} params.location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. + * @param {string=} params.view The view to retrieve. Defaults to METADATA_ONLY. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Templates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Templates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Templates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Templates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Templates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Templates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1b3/projects/{projectId}/locations/{location}/templates:get' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'location'], + pathParams: ['location', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataflow.projects.locations.templates.launch + * @desc Launch a template. + * @alias dataflow.projects.locations.templates.launch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.dynamicTemplate.gcsPath Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object. + * @param {string=} params.dynamicTemplate.stagingLocation Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`. + * @param {string=} params.gcsPath A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * @param {string} params.location The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. + * @param {boolean=} params.validateOnly If true, the request is validated but not actually executed. Defaults to false. + * @param {().LaunchTemplateParameters} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + launch( + params?: Params$Resource$Projects$Locations$Templates$Launch, + options?: MethodOptions + ): GaxiosPromise; + launch( + params: Params$Resource$Projects$Locations$Templates$Launch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + launch( + params: Params$Resource$Projects$Locations$Templates$Launch, + callback: BodyResponseCallback + ): void; + launch(callback: BodyResponseCallback): void; + launch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Templates$Launch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Templates$Launch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Templates$Launch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1b3/projects/{projectId}/locations/{location}/templates:launch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['projectId', 'location'], + pathParams: ['location', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Templates$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + */ + location?: string; + /** + * Required. The ID of the Cloud Platform project that the job belongs to. + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateJobFromTemplateRequest; + } + export interface Params$Resource$Projects$Locations$Templates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + */ + gcsPath?: string; + /** + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + */ + location?: string; + /** + * Required. The ID of the Cloud Platform project that the job belongs to. + */ + projectId?: string; + /** + * The view to retrieve. Defaults to METADATA_ONLY. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Templates$Launch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object. + */ + 'dynamicTemplate.gcsPath'?: string; + /** + * Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`. + */ + 'dynamicTemplate.stagingLocation'?: string; + /** + * A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + */ + gcsPath?: string; + /** + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. + */ + location?: string; + /** + * Required. The ID of the Cloud Platform project that the job belongs to. + */ + projectId?: string; + /** + * If true, the request is validated but not actually executed. Defaults to false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$LaunchTemplateParameters; + } + + export class Resource$Projects$Snapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataflow.projects.snapshots.get + * @desc Gets information about a snapshot. + * @alias dataflow.projects.snapshots.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.location The location that contains this snapshot. + * @param {string} params.projectId The ID of the Cloud Platform project that the snapshot belongs to. + * @param {string} params.snapshotId The ID of the snapshot. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Snapshots$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Snapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Snapshots$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Snapshots$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Snapshots$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Snapshots$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1b3/projects/{projectId}/snapshots/{snapshotId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'snapshotId'], + pathParams: ['projectId', 'snapshotId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataflow.projects.snapshots.list + * @desc Lists snapshots. + * @alias dataflow.projects.snapshots.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.location The location to list snapshots in. + * @param {string} params.projectId The project ID to list snapshots for. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Snapshots$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Snapshots$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Snapshots$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Snapshots$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Snapshots$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Snapshots$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1b3/projects/{projectId}/snapshots').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId'], + pathParams: ['projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Snapshots$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The location that contains this snapshot. + */ + location?: string; + /** + * The ID of the Cloud Platform project that the snapshot belongs to. + */ + projectId?: string; + /** + * The ID of the snapshot. + */ + snapshotId?: string; + } + export interface Params$Resource$Projects$Snapshots$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The location to list snapshots in. + */ + location?: string; + /** + * The project ID to list snapshots for. + */ + projectId?: string; } export class Resource$Projects$Templates { @@ -7030,14 +7038,11 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A Cloud Storage path to the template from which to create the - * job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. */ gcsPath?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - * which to direct the request. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. */ location?: string; /** @@ -7057,24 +7062,19 @@ export namespace dataflow_v1b3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Path to dynamic template spec file on GCS. The file must be a Json - * serialized DynamicTemplateFieSpec object. + * Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object. */ 'dynamicTemplate.gcsPath'?: string; /** - * Cloud Storage path for staging dependencies. Must be a valid Cloud - * Storage URL, beginning with `gs://`. + * Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`. */ 'dynamicTemplate.stagingLocation'?: string; /** - * A Cloud Storage path to the template from which to create the job. Must - * be valid Cloud Storage URL, beginning with 'gs://'. + * A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. */ gcsPath?: string; /** - * The [regional endpoint] - * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - * which to direct the request. + * The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. */ location?: string; /** @@ -7082,8 +7082,7 @@ export namespace dataflow_v1b3 { */ projectId?: string; /** - * If true, the request is validated but not actually executed. Defaults to - * false. + * If true, the request is validated but not actually executed. Defaults to false. */ validateOnly?: boolean; diff --git a/src/apis/datafusion/README.md b/src/apis/datafusion/README.md new file mode 100644 index 00000000000..3d749061a91 --- /dev/null +++ b/src/apis/datafusion/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# datafusion + +> Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure. + +## Installation + +```sh +$ npm install googleapis +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). + +## Building a browser bundle + +This library can be used in a browser. To prepare a single file bundle, clone the +[repository](https://github.com/googleapis/google-api-nodejs-client) and run + +```sh +$ cd src/apis/datafusion +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/datafusion.min.js`. Use it from your HTML file: + +```html + + +``` + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/master/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/datafusion/index.ts b/src/apis/datafusion/index.ts new file mode 100644 index 00000000000..f55674e9c55 --- /dev/null +++ b/src/apis/datafusion/index.ts @@ -0,0 +1,35 @@ +// Copyright 2019 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {datafusion_v1beta1} from './v1beta1'; + +export const VERSIONS = { + v1beta1: datafusion_v1beta1.Datafusion, +}; + +export function datafusion(version: 'v1beta1'): datafusion_v1beta1.Datafusion; +export function datafusion( + options: datafusion_v1beta1.Options +): datafusion_v1beta1.Datafusion; +export function datafusion( + this: GoogleConfigurable, + versionOrOptions: 'v1beta1' | datafusion_v1beta1.Options +) { + return getAPI('datafusion', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/datafusion/package.json b/src/apis/datafusion/package.json new file mode 100644 index 00000000000..2b4e08ac0ce --- /dev/null +++ b/src/apis/datafusion/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/datafusion", + "version": "0.1.0", + "description": "datafusion", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=8.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "docs": "typedoc --out docs/", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^2.0.0" + }, + "devDependencies": { + "gts": "^1.0.0", + "null-loader": "^1.0.0", + "ts-loader": "^6.0.0", + "typedoc": "^0.14.0", + "typescript": "~3.4.0", + "webpack": "^4.28.4", + "webpack-cli": "^3.2.1" + } +} diff --git a/src/apis/datafusion/tsconfig.json b/src/apis/datafusion/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/datafusion/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts new file mode 100644 index 00000000000..7bb1bd24dc3 --- /dev/null +++ b/src/apis/datafusion/v1beta1.ts @@ -0,0 +1,2110 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace datafusion_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Data Fusion API + * + * Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure. + * + * @example + * const {google} = require('googleapis'); + * const datafusion = google.datafusion('v1beta1'); + * + * @namespace datafusion + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Datafusion + */ + export class Datafusion { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + exemptedMembers?: string[]; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + service?: string; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[]; + /** + * The log type that this config enables. + */ + logType?: string; + } + /** + * Authorization-related information used by Cloud Audit Logging. + */ + export interface Schema$AuthorizationLoggingOptions { + /** + * The type of the permission that was checked. + */ + permissionType?: string; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[]; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * Write a Cloud Audit log + */ + export interface Schema$CloudAuditOptions { + /** + * Information used by the Cloud Audit Logging pipeline. + */ + authorizationLoggingOptions?: Schema$AuthorizationLoggingOptions; + /** + * The log_name to populate in the Cloud Audit Record. + */ + logName?: string; + } + /** + * A condition to be met. + */ + export interface Schema$Condition { + /** + * Trusted attributes supplied by the IAM system. + */ + iam?: string; + /** + * An operator to apply the subject with. + */ + op?: string; + /** + * Trusted attributes discharged by the service. + */ + svc?: string; + /** + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. + */ + sys?: string; + /** + * The objects of the condition. + */ + values?: string[]; + } + /** + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). + */ + export interface Schema$CounterOptions { + /** + * The field value to attribute. + */ + field?: string; + /** + * The metric to update. + */ + metric?: string; + } + /** + * Write a Data Access (Gin) log + */ + export interface Schema$DataAccessOptions { + /** + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. + */ + logMode?: string; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string; + } + /** + * Represents a Data Fusion instance. + */ + export interface Schema$Instance { + /** + * Output only. The time the instance was created. + */ + createTime?: string; + /** + * An optional description of this instance. + */ + description?: string; + /** + * Display name for an instance. + */ + displayName?: string; + /** + * Option to enable Stackdriver Logging. + */ + enableStackdriverLogging?: boolean; + /** + * Option to enable Stackdriver Monitoring. + */ + enableStackdriverMonitoring?: boolean; + /** + * The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels. + */ + labels?: {[key: string]: string}; + /** + * Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. + */ + name?: string; + /** + * Network configuration options. These are required when a private Data Fusion instance is to be created. + */ + networkConfig?: Schema$NetworkConfig; + /** + * Map of additional options used to configure the behavior of Data Fusion instance. + */ + options?: {[key: string]: string}; + /** + * Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. + */ + privateInstance?: boolean; + /** + * Output only. Service account which will be used to access resources in the customer project." + */ + serviceAccount?: string; + /** + * Output only. Endpoint on which the Data Fusion UI and REST APIs are accessible. + */ + serviceEndpoint?: string; + /** + * Output only. The current state of this Data Fusion instance. + */ + state?: string; + /** + * Output only. Additional information about the current state of this Data Fusion instance if available. + */ + stateMessage?: string; + /** + * Required. Instance type. + */ + type?: string; + /** + * Output only. The time the instance was last updated. + */ + updateTime?: string; + /** + * Output only. Current version of the Data Fusion. + */ + version?: string; + /** + * Name of the zone in which the Data Fusion instance will be created. + */ + zone?: string; + } + /** + * Response message for the list instance request. + */ + export interface Schema$ListInstancesResponse { + /** + * Represents a list of Data Fusion instances. + */ + instances?: Schema$Instance[]; + /** + * Token to retrieve the next page of results or empty if there are no more results in the list. + */ + nextPageToken?: string; + /** + * Locations that could not be reached. + */ + unreachable?: string[]; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents Google Cloud Platform location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + */ + labels?: {[key: string]: string}; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any}; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string; + } + /** + * Specifies what kind of log the caller must write + */ + export interface Schema$LogConfig { + /** + * Cloud audit options. + */ + cloudAudit?: Schema$CloudAuditOptions; + /** + * Counter options. + */ + counter?: Schema$CounterOptions; + /** + * Data access options. + */ + dataAccess?: Schema$DataAccessOptions; + } + /** + * Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. + */ + export interface Schema$NetworkConfig { + /** + * The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network. + */ + ipAllocation?: string; + /** + * Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. + */ + network?: string; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any}; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any}; + } + /** + * Represents the metadata of a long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * API version used to start the operation. + */ + apiVersion?: string; + /** + * The time the operation was created. + */ + createTime?: string; + /** + * The time the operation finished running. + */ + endTime?: string; + /** + * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean; + /** + * Human-readable status of the operation if any. + */ + statusDetail?: string; + /** + * Server-defined resource path for the target of the operation. + */ + target?: string; + /** + * Name of the verb executed by the operation. + */ + verb?: string; + } + /** + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. + */ + etag?: string; + iamOwned?: boolean; + /** + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. + */ + rules?: Schema$Rule[]; + /** + * Deprecated. + */ + version?: number; + } + /** + * Request message for restarting a Data Fusion instance. + */ + export interface Schema$RestartInstanceRequest {} + /** + * A rule to be applied in a Policy. + */ + export interface Schema$Rule { + /** + * Required + */ + action?: string; + /** + * Additional restrictions that must be met. All conditions must pass for the rule to match. + */ + conditions?: Schema$Condition[]; + /** + * Human-readable description of the rule. + */ + description?: string; + /** + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + */ + in?: string[]; + /** + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. + */ + logConfig?: Schema$LogConfig[]; + /** + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries can be found at in the Local IAM documentation (see go/local-iam#features). + */ + notIn?: string[]; + /** + * A permission is a string of form '<service>.<resource type>.<verb>' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. + */ + permissions?: string[]; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. + */ + policy?: Schema$Policy; + /** + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + */ + updateMask?: string; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}>; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[]; + } + /** + * Request message for upgrading a Data Fusion instance. To change the instance properties, instance update should be used. + */ + export interface Schema$UpgradeInstanceRequest {} + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + instances: Resource$Projects$Locations$Instances; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.instances = new Resource$Projects$Locations$Instances(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * datafusion.projects.locations.get + * @desc Gets information about a location. + * @alias datafusion.projects.locations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name for the location. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias datafusion.projects.locations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * datafusion.projects.locations.instances.create + * @desc Creates a new Data Fusion instance in the specified project and location. + * @alias datafusion.projects.locations.instances.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.instanceId The name of the instance to create. + * @param {string} params.parent The instance's project and location in the format projects/{project}/locations/{location}. + * @param {().Instance} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Instances$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Instances$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Instances$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/instances').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.delete + * @desc Deletes a single Date Fusion instance. + * @alias datafusion.projects.locations.instances.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Instances$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Instances$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Instances$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.get + * @desc Gets details of a single Data Fusion instance. + * @alias datafusion.projects.locations.instances.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Instances$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Instances$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Instances$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @alias datafusion.projects.locations.instances.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Locations$Instances$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Instances$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Instances$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.list + * @desc Lists Data Fusion instances in the specified project and location. + * @alias datafusion.projects.locations.instances.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter List filter. + * @param {string=} params.orderBy Sort results. Supported values are "name", "name desc", or "" (unsorted). + * @param {integer=} params.pageSize The maximum number of items to return. + * @param {string=} params.pageToken The next_page_token value to use if there are additional results to retrieve for this list request. + * @param {string} params.parent The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as '-' (wildcard), then all regions available to the project are queried, and the results are aggregated. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Instances$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Instances$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Instances$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/instances').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.patch + * @desc Updates a single Data Fusion instance. + * @alias datafusion.projects.locations.instances.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. + * @param {string=} params.updateMask Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels and options currently) will be overwritten. + * @param {().Instance} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Locations$Instances$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Instances$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Instances$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.restart + * @desc Restart a single Data Fusion instance. At the end of an operation instance is fully restarted. + * @alias datafusion.projects.locations.instances.restart + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance} + * @param {().RestartInstanceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + restart( + params?: Params$Resource$Projects$Locations$Instances$Restart, + options?: MethodOptions + ): GaxiosPromise; + restart( + params: Params$Resource$Projects$Locations$Instances$Restart, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restart( + params: Params$Resource$Projects$Locations$Instances$Restart, + callback: BodyResponseCallback + ): void; + restart(callback: BodyResponseCallback): void; + restart( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Restart + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Restart; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Restart; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:restart').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias datafusion.projects.locations.instances.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Instances$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Instances$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Instances$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias datafusion.projects.locations.instances.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Instances$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Instances$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Instances$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.instances.upgrade + * @desc Upgrade a single Data Fusion instance. At the end of an operation instance is fully upgraded. + * @alias datafusion.projects.locations.instances.upgrade + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Data Fusion instance which need to be upgraded in the form of projects/{project}/locations/{location}/instances/{instance} Instance will be upgraded with the latest stable version of the Data Fusion. + * @param {().UpgradeInstanceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + upgrade( + params?: Params$Resource$Projects$Locations$Instances$Upgrade, + options?: MethodOptions + ): GaxiosPromise; + upgrade( + params: Params$Resource$Projects$Locations$Instances$Upgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Instances$Upgrade, + callback: BodyResponseCallback + ): void; + upgrade(callback: BodyResponseCallback): void; + upgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Upgrade + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Upgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Upgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:upgrade').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Instances$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance to create. + */ + instanceId?: string; + /** + * The instance's project and location in the format projects/{project}/locations/{location}. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Instance; + } + export interface Params$Resource$Projects$Locations$Instances$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Instances$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Instances$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Instances$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * List filter. + */ + filter?: string; + /** + * Sort results. Supported values are "name", "name desc", or "" (unsorted). + */ + orderBy?: string; + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value to use if there are additional results to retrieve for this list request. + */ + pageToken?: string; + /** + * The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as '-' (wildcard), then all regions available to the project are queried, and the results are aggregated. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Instances$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. + */ + name?: string; + /** + * Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels and options currently) will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Instance; + } + export interface Params$Resource$Projects$Locations$Instances$Restart + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestartInstanceRequest; + } + export interface Params$Resource$Projects$Locations$Instances$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Instances$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Locations$Instances$Upgrade + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Data Fusion instance which need to be upgraded in the form of projects/{project}/locations/{location}/instances/{instance} Instance will be upgraded with the latest stable version of the Data Fusion. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpgradeInstanceRequest; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * datafusion.projects.locations.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @alias datafusion.projects.locations.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {().CancelOperationRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.operations.delete + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @alias datafusion.projects.locations.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @alias datafusion.projects.locations.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datafusion.projects.locations.operations.list + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @alias datafusion.projects.locations.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datafusion.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } +} diff --git a/src/apis/datafusion/webpack.config.js b/src/apis/datafusion/webpack.config.js new file mode 100644 index 00000000000..05569ca5773 --- /dev/null +++ b/src/apis/datafusion/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Datafusion', + filename: 'datafusion.min.js', + path: path.resolve(__dirname, 'dist'), + }, + node: { + child_process: 'empty', + fs: 'empty', + crypto: 'empty', + }, + module: { + rules: [ + { + test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + use: 'null-loader', + }, + { + test: /node_modules\/https-proxy-agent\//, + use: 'null-loader', + }, + { + test: /node_modules\/gcp-metadata\//, + use: 'null-loader', + }, + { + test: /node_modules\/gtoken\//, + use: 'null-loader', + }, + { + test: /node_modules\/pkginfo\//, + use: 'null-loader', + }, + { + test: /node_modules\/semver\//, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/dataproc/package.json b/src/apis/dataproc/package.json index aaf2dd33148..a941cc2f95c 100644 --- a/src/apis/dataproc/package.json +++ b/src/apis/dataproc/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 88cc47160e8..8d6105e3b66 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace dataproc_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace dataproc_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,30 +108,25 @@ export namespace dataproc_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * Specifies the type and number of accelerator cards attached to the - * instances of an instance. See GPUs on Compute Engine. + * Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine. */ export interface Schema$AcceleratorConfig { /** - * The number of the accelerator cards of this type exposed to this - * instance. + * The number of the accelerator cards of this type exposed to this instance. */ acceleratorCount?: number; /** - * Full URL, partial URI, or short name of the accelerator type resource to - * expose to this instance. See Compute Engine AcceleratorTypes.Examples: - * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 - * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 - * nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc - * Auto Zone Placement feature, you must use the short name of the - * accelerator type resource, for example, nvidia-tesla-k80. + * Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples: https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80. */ acceleratorTypeUri?: string; } @@ -144,30 +135,15 @@ export namespace dataproc_v1 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * members can have the following values: allUsers: A special identifier - * that represents anyone who is on the internet; with or without a Google - * account. allAuthenticatedUsers: A special identifier that represents - * anyone who is authenticated with a Google account or a service account. - * user:{emailid}: An email address that represents a specific Google - * account. For example, alice@gmail.com . serviceAccount:{emailid}: An - * email address that represents a service account. For example, - * my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email - * address that represents a Google group. For example, admins@example.com. - * domain:{domain}: The G Suite domain (primary) that represents all the - * users of that domain. For example, google.com or example.com. + * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. */ members?: string[]; /** - * Role that is assigned to members. For example, roles/viewer, - * roles/editor, or roles/owner. + * Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. */ role?: string; } @@ -176,43 +152,31 @@ export namespace dataproc_v1 { */ export interface Schema$CancelJobRequest {} /** - * Describes the identifying information, config, and status of a cluster of - * Compute Engine instances. + * Describes the identifying information, config, and status of a cluster of Compute Engine instances. */ export interface Schema$Cluster { /** - * Required. The cluster name. Cluster names within a project must be - * unique. Names of deleted clusters can be reused. + * Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused. */ clusterName?: string; /** - * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc - * generates this value when it creates the cluster. + * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster. */ clusterUuid?: string; /** - * Required. The cluster config. Note that Cloud Dataproc may set default - * values, and values may change when clusters are updated. + * Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated. */ config?: Schema$ClusterConfig; /** - * Optional. The labels to associate with this cluster. Label keys must - * contain 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, - * if present, must contain 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be - * associated with a cluster. + * Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. */ labels?: {[key: string]: string}; /** - * Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: - * This report is available for testing purposes only. It may be changed - * before final release. + * Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ metrics?: Schema$ClusterMetrics; /** - * Required. The Google Cloud Platform project ID that the cluster belongs - * to. + * Required. The Google Cloud Platform project ID that the cluster belongs to. */ projectId?: string; /** @@ -229,13 +193,7 @@ export namespace dataproc_v1 { */ export interface Schema$ClusterConfig { /** - * Optional. A Google Cloud Storage bucket used to stage job dependencies, - * config files, and job driver console output. If you do not specify a - * staging bucket, Cloud Dataproc will determine a Cloud Storage location - * (US, ASIA, or EU) for your cluster's staging bucket according to the - * Google Compute Engine zone where your cluster is deployed, and then - * create and manage this project-level, per-location bucket (see Cloud - * Dataproc staging bucket). + * Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket). */ configBucket?: string; /** @@ -243,29 +201,19 @@ export namespace dataproc_v1 { */ encryptionConfig?: Schema$EncryptionConfig; /** - * Optional. The shared Compute Engine config settings for all instances in - * a cluster. + * Optional. The shared Compute Engine config settings for all instances in a cluster. */ gceClusterConfig?: Schema$GceClusterConfig; /** - * Optional. Commands to execute on each node after config is completed. By - * default, executables are run on master and all worker nodes. You can test - * a node's role metadata to run an executable on a master or worker - * node, as shown below using curl (you can also use wget): ROLE=$(curl -H - * Metadata-Flavor:Google - * http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if - * [[ "${ROLE}" == 'Master' ]]; then ... master specific - * actions ... else ... worker specific actions ... fi + * Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi */ initializationActions?: Schema$NodeInitializationAction[]; /** - * Optional. The Compute Engine config settings for the master instance in a - * cluster. + * Optional. The Compute Engine config settings for the master instance in a cluster. */ masterConfig?: Schema$InstanceGroupConfig; /** - * Optional. The Compute Engine config settings for additional worker - * instances in a cluster. + * Optional. The Compute Engine config settings for additional worker instances in a cluster. */ secondaryWorkerConfig?: Schema$InstanceGroupConfig; /** @@ -273,15 +221,12 @@ export namespace dataproc_v1 { */ softwareConfig?: Schema$SoftwareConfig; /** - * Optional. The Compute Engine config settings for worker instances in a - * cluster. + * Optional. The Compute Engine config settings for worker instances in a cluster. */ workerConfig?: Schema$InstanceGroupConfig; } /** - * Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: - * This report is available for testing purposes only. It may be changed - * before final release. + * Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ export interface Schema$ClusterMetrics { /** @@ -377,9 +322,7 @@ export namespace dataproc_v1 { */ clusterLabels?: {[key: string]: string}; /** - * Optional. The zone where workflow process executes. This parameter does - * not affect the selection of the cluster.If unspecified, the zone of the - * first cluster matching the selector is used. + * Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used. */ zone?: string; } @@ -400,8 +343,7 @@ export namespace dataproc_v1 { */ stateStartTime?: string; /** - * Output only. Additional state information that includes status reported - * by the agent. + * Output only. Additional state information that includes status reported by the agent. */ substate?: string; } @@ -414,8 +356,7 @@ export namespace dataproc_v1 { */ export interface Schema$DiagnoseClusterResults { /** - * Output only. The Cloud Storage URI of the diagnostic output. The output - * report is a plain text file with a summary of collected diagnostics. + * Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics. */ outputUri?: string; } @@ -428,26 +369,16 @@ export namespace dataproc_v1 { */ bootDiskSizeGb?: number; /** - * Optional. Type of the boot disk (default is "pd-standard"). - * Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or - * "pd-standard" (Persistent Disk Hard Disk Drive). + * Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). */ bootDiskType?: string; /** - * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs - * are not attached, the boot disk is used to store runtime logs and HDFS - * (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one - * or more SSDs are attached, this runtime bulk data is spread across them, - * and the boot disk contains only basic config and installed binaries. + * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries. */ numLocalSsds?: number; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** @@ -455,100 +386,57 @@ export namespace dataproc_v1 { */ export interface Schema$EncryptionConfig { /** - * Optional. The Cloud KMS key name to use for PD disk encryption for all - * instances in the cluster. + * Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster. */ gcePdKmsKeyName?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax.The application context of the containing message determines which - * well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Common config settings for resources of Compute Engine cluster instances, - * applicable to all instances in the cluster. + * Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. */ export interface Schema$GceClusterConfig { /** - * Optional. If true, all instances in the cluster will only have internal - * IP addresses. By default, clusters are not restricted to internal IP - * addresses, and will have ephemeral external IP addresses assigned to each - * instance. This internal_ip_only restriction can only be enabled for - * subnetwork enabled networks, and all off-cluster dependencies must be - * configured to be accessible without external IP addresses. + * Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses. */ internalIpOnly?: boolean; /** - * The Compute Engine metadata entries to add to all instances (see Project - * and instance metadata - * (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). + * The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). */ metadata?: {[key: string]: string}; /** - * Optional. The Compute Engine network to be used for machine - * communications. Cannot be specified with subnetwork_uri. If neither - * network_uri nor subnetwork_uri is specified, the "default" - * network of the project is used, if it exists. Cannot be a "Custom - * Subnet Network" (see Using Subnetworks for more information).A full - * URL, partial URI, or short name are valid. Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default - * projects/[project_id]/regions/global/default default + * Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default projects/[project_id]/regions/global/default default */ networkUri?: string; /** - * Optional. The service account of the instances. Defaults to the default - * Compute Engine service account. Custom service accounts need permissions - * equivalent to the following IAM roles: roles/logging.logWriter - * roles/storage.objectAdmin(see - * https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts - * for more information). Example: - * [account_id]@[project_id].iam.gserviceaccount.com + * Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles: roles/logging.logWriter roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com */ serviceAccount?: string; /** - * Optional. The URIs of service account scopes to be included in Compute - * Engine instances. The following base set of scopes is always included: - * https://www.googleapis.com/auth/cloud.useraccounts.readonly - * https://www.googleapis.com/auth/devstorage.read_write - * https://www.googleapis.com/auth/logging.writeIf no scopes are specified, - * the following defaults are also provided: - * https://www.googleapis.com/auth/bigquery - * https://www.googleapis.com/auth/bigtable.admin.table - * https://www.googleapis.com/auth/bigtable.data - * https://www.googleapis.com/auth/devstorage.full_control + * Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control */ serviceAccountScopes?: string[]; /** - * Optional. The Compute Engine subnetwork to be used for machine - * communications. Cannot be specified with network_uri.A full URL, partial - * URI, or short name are valid. Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0 - * projects/[project_id]/regions/us-east1/sub0 sub0 + * Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0 sub0 */ subnetworkUri?: string; /** @@ -556,14 +444,7 @@ export namespace dataproc_v1 { */ tags?: string[]; /** - * Optional. The zone where the Compute Engine cluster will be located. On a - * create request, it is required in the "global" region. If - * omitted in a non-global Cloud Dataproc region, the service will pick a - * zone in the corresponding Compute Engine region. On a get request, zone - * will always be present.A full URL, partial URI, or short name are valid. - * Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] - * projects/[project_id]/zones/[zone] us-central1-f + * Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f */ zoneUri?: string; } @@ -572,33 +453,23 @@ export namespace dataproc_v1 { */ export interface Schema$GetIamPolicyRequest {} /** - * A Cloud Dataproc job for running Apache Hadoop MapReduce - * (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) - * jobs on Apache Hadoop YARN - * (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). + * A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). */ export interface Schema$HadoopJob { /** - * Optional. HCFS URIs of archives to be extracted in the working directory - * of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, - * .tgz, or .zip. + * Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip. */ archiveUris?: string[]; /** - * Optional. The arguments to pass to the driver. Do not include arguments, - * such as -libjars or -Dfoo=bar, that can be set as job properties, since a - * collision may occur that causes an incorrect job submission. + * Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ args?: string[]; /** - * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied - * to the working directory of Hadoop drivers and distributed tasks. Useful - * for naively parallel tasks. + * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** - * Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and - * tasks. + * Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. */ jarFileUris?: string[]; /** @@ -606,46 +477,32 @@ export namespace dataproc_v1 { */ loggingConfig?: Schema$LoggingConfig; /** - * The name of the driver's main class. The jar file containing the - * class must be in the default CLASSPATH or specified in jar_file_uris. + * The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris. */ mainClass?: string; /** - * The HCFS URI of the jar file containing the main class. Examples: - * 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' - * 'hdfs:/tmp/test-samples/custom-wordcount.jar' - * 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' + * The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' */ mainJarFileUri?: string; /** - * Optional. A mapping of property names to values, used to configure - * Hadoop. Properties that conflict with values set by the Cloud Dataproc - * API may be overwritten. Can include properties set in - * /etc/hadoop/conf/*-site and classes in user code. + * Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. */ properties?: {[key: string]: string}; } /** - * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) - * queries on YARN. + * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. */ export interface Schema$HiveJob { /** - * Optional. Whether to continue executing queries if a query fails. The - * default value is false. Setting to true can be useful when executing - * independent parallel queries. + * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ continueOnFailure?: boolean; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive - * server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. + * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. */ jarFileUris?: string[]; /** - * Optional. A mapping of property names and values, used to configure Hive. - * Properties that conflict with values set by the Cloud Dataproc API may be - * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, - * /etc/hive/conf/hive-site.xml, and classes in user code. + * Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. */ properties?: {[key: string]: string}; /** @@ -657,20 +514,16 @@ export namespace dataproc_v1 { */ queryList?: Schema$QueryList; /** - * Optional. Mapping of query variable names to values (equivalent to the - * Hive command: SET name="value";). + * Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). */ scriptVariables?: {[key: string]: string}; } /** - * Optional. The config settings for Compute Engine resources in an instance - * group, such as a master or worker group. + * Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. */ export interface Schema$InstanceGroupConfig { /** - * Optional. The Compute Engine accelerator configuration for these - * instances.Beta Feature: This feature is still under development. It may - * be changed before final release. + * Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release. */ accelerators?: Schema$AcceleratorConfig[]; /** @@ -678,38 +531,27 @@ export namespace dataproc_v1 { */ diskConfig?: Schema$DiskConfig; /** - * Optional. The Compute Engine image resource used for cluster instances. - * It can be specified or may be inferred from SoftwareConfig.image_version. + * Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version. */ imageUri?: string; /** - * Output only. The list of instance names. Cloud Dataproc derives the names - * from cluster_name, num_instances, and the instance group. + * Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group. */ instanceNames?: string[]; /** - * Optional. Specifies that this instance group contains preemptible - * instances. + * Optional. Specifies that this instance group contains preemptible instances. */ isPreemptible?: boolean; /** - * Optional. The Compute Engine machine type used for cluster instances.A - * full URL, partial URI, or short name are valid. Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 - * projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 - * n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc - * Auto Zone Placement feature, you must use the short name of the machine - * type resource, for example, n1-standard-2. + * Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2. */ machineTypeUri?: string; /** - * Output only. The config for Compute Engine Instance Group Manager that - * manages this group. This is only used for preemptible instance groups. + * Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups. */ managedGroupConfig?: Schema$ManagedGroupConfig; /** - * Optional. The number of VM instances in the instance group. For master - * instance groups, must be set to 1. + * Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1. */ numInstances?: number; } @@ -718,24 +560,15 @@ export namespace dataproc_v1 { */ export interface Schema$InstantiateWorkflowTemplateRequest { /** - * Optional. Map from parameter names to values that should be used for - * those parameters. Values may not exceed 100 characters. + * Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters. */ parameters?: {[key: string]: string}; /** - * Optional. A tag that prevents multiple concurrent workflow instances with - * the same tag from running. This mitigates risk of concurrent instances - * started due to retries.It is recommended to always set this value to a - * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The - * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), - * and hyphens (-). The maximum length is 40 characters. + * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; /** - * Optional. The version of workflow template to instantiate. If specified, - * the workflow will be instantiated only if the current version of the - * workflow template has the supplied version.This option cannot be used to - * instantiate a previous version of workflow template. + * Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template. */ version?: number; } @@ -744,14 +577,11 @@ export namespace dataproc_v1 { */ export interface Schema$Job { /** - * Output only. If present, the location of miscellaneous control files - * which may be used as part of job setup and handling. If not present, - * control files may be placed in the same location as driver_output_uri. + * Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. */ driverControlFilesUri?: string; /** - * Output only. A URI pointing to the location of the stdout of the - * job's driver program. + * Output only. A URI pointing to the location of the stdout of the job's driver program. */ driverOutputResourceUri?: string; /** @@ -763,18 +593,11 @@ export namespace dataproc_v1 { */ hiveJob?: Schema$HiveJob; /** - * Output only. A UUID that uniquely identifies a job within the project - * over time. This is in contrast to a user-settable reference.job_id that - * may be reused over time. + * Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. */ jobUuid?: string; /** - * Optional. The labels to associate with this job. Label keys must contain - * 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, - * if present, must contain 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be - * associated with a job. + * Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. */ labels?: {[key: string]: string}; /** @@ -790,10 +613,7 @@ export namespace dataproc_v1 { */ pysparkJob?: Schema$PySparkJob; /** - * Optional. The fully qualified reference to the job, which can be used to - * obtain the equivalent REST path of the job resource. If this property is - * not specified when a job is created, the server generates a - * <code>job_id</code>. + * Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. */ reference?: Schema$JobReference; /** @@ -809,9 +629,7 @@ export namespace dataproc_v1 { */ sparkSqlJob?: Schema$SparkSqlJob; /** - * Output only. The job status. Additional application-specific status - * information may be contained in the <code>type_job</code> and - * <code>yarn_applications</code> fields. + * Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. */ status?: Schema$JobStatus; /** @@ -819,9 +637,7 @@ export namespace dataproc_v1 { */ statusHistory?: Schema$JobStatus[]; /** - * Output only. The collection of YARN applications spun up by this job.Beta - * Feature: This report is available for testing purposes only. It may be - * changed before final release. + * Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ yarnApplications?: Schema$YarnApplication[]; } @@ -834,8 +650,7 @@ export namespace dataproc_v1 { */ clusterName?: string; /** - * Output only. A cluster UUID generated by the Cloud Dataproc service when - * the job is submitted. + * Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. */ clusterUuid?: string; } @@ -844,15 +659,11 @@ export namespace dataproc_v1 { */ export interface Schema$JobReference { /** - * Optional. The job ID, which must be unique within the project.The ID must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or - * hyphens (-). The maximum length is 100 characters.If not specified by the - * caller, the job ID will be provided by the server. + * Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server. */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; } @@ -861,10 +672,7 @@ export namespace dataproc_v1 { */ export interface Schema$JobScheduling { /** - * Optional. Maximum number of times per hour a driver may be restarted as a - * result of driver terminating with non-zero code before job is reported - * failed.A job may be reported as thrashing if driver exits with non-zero - * code 4 times within 10 minute window.Maximum value is 10. + * Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. */ maxFailuresPerHour?: number; } @@ -873,8 +681,7 @@ export namespace dataproc_v1 { */ export interface Schema$JobStatus { /** - * Output only. Optional job state details, such as an error description if - * the state is <code>ERROR</code>. + * Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. */ details?: string; /** @@ -886,8 +693,7 @@ export namespace dataproc_v1 { */ stateStartTime?: string; /** - * Output only. Additional state information, which includes status reported - * by the agent. + * Output only. Additional state information, which includes status reported by the agent. */ substate?: string; } @@ -900,9 +706,7 @@ export namespace dataproc_v1 { */ clusters?: Schema$Cluster[]; /** - * Output only. This token is included in the response if there are more - * results to fetch. To fetch additional results, provide this value as the - * page_token in a subsequent ListClustersRequest. + * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest. */ nextPageToken?: string; } @@ -915,9 +719,7 @@ export namespace dataproc_v1 { */ jobs?: Schema$Job[]; /** - * Optional. This token is included in the response if there are more - * results to fetch. To fetch additional results, provide this value as the - * page_token in a subsequent <code>ListJobsRequest</code>. + * Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListJobsRequest</code>. */ nextPageToken?: string; } @@ -939,10 +741,7 @@ export namespace dataproc_v1 { */ export interface Schema$ListWorkflowTemplatesResponse { /** - * Output only. This token is included in the response if there are more - * results to fetch. To fetch additional results, provide this value as the - * page_token in a subsequent - * <code>ListWorkflowTemplatesRequest</code>. + * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListWorkflowTemplatesRequest</code>. */ nextPageToken?: string; /** @@ -955,10 +754,7 @@ export namespace dataproc_v1 { */ export interface Schema$LoggingConfig { /** - * The per-package log levels for the driver. This may include - * "root" package name to configure rootLogger. Examples: - * 'com.google = FATAL', 'root = INFO', 'org.apache = - * DEBUG' + * The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' */ driverLogLevels?: {[key: string]: string}; } @@ -967,11 +763,7 @@ export namespace dataproc_v1 { */ export interface Schema$ManagedCluster { /** - * Required. The cluster name prefix. A unique cluster name will be formed - * by appending a random suffix.The name must contain only lower-case - * letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. - * Cannot begin or end with hyphen. Must consist of between 2 and 35 - * characters. + * Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters. */ clusterName?: string; /** @@ -979,12 +771,7 @@ export namespace dataproc_v1 { */ config?: Schema$ClusterConfig; /** - * Optional. The labels to associate with this cluster.Label keys must be - * between 1 and 63 characters long, and must conform to the following PCRE - * regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and - * 63 characters long, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be - * associated with a given cluster. + * Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. */ labels?: {[key: string]: string}; } @@ -997,14 +784,12 @@ export namespace dataproc_v1 { */ instanceGroupManagerName?: string; /** - * Output only. The name of the Instance Template used for the Managed - * Instance Group. + * Output only. The name of the Instance Template used for the Managed Instance Group. */ instanceTemplateName?: string; } /** - * Specifies an executable to run on a fully configured node and a timeout - * period for executable completion. + * Specifies an executable to run on a fully configured node and a timeout period for executable completion. */ export interface Schema$NodeInitializationAction { /** @@ -1012,22 +797,16 @@ export namespace dataproc_v1 { */ executableFile?: string; /** - * Optional. Amount of time executable has to complete. Default is 10 - * minutes. Cluster creation fails with an explanatory error message (the - * name of the executable that caused the error and the exceeded timeout - * period) if the executable is not completed at end of the timeout period. + * Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period. */ executionTimeout?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is false, it means the operation is still in progress. If - * true, the operation is completed, and either error or response is - * available. + * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ done?: boolean; /** @@ -1035,26 +814,15 @@ export namespace dataproc_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the name - * should have the format of operations/some/unique/name. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as Delete, the response is - * google.protobuf.Empty. If the original method is standard - * Get/Create/Update, the response should be the resource. For other - * methods, the response should have the type XxxResponse, where Xxx is the - * original method name. For example, if the original method name is - * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. + * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ response?: {[key: string]: any}; } @@ -1071,12 +839,7 @@ export namespace dataproc_v1 { */ hiveJob?: Schema$HiveJob; /** - * Optional. The labels to associate with this job.Label keys must be - * between 1 and 63 characters long, and must conform to the following - * regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and - * 63 characters long, and must conform to the following regular expression: - * \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a - * given job. + * Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job. */ labels?: {[key: string]: string}; /** @@ -1084,8 +847,7 @@ export namespace dataproc_v1 { */ pigJob?: Schema$PigJob; /** - * Optional. The optional list of prerequisite job step_ids. If not - * specified, the job will start at the beginning of workflow. + * Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. */ prerequisiteStepIds?: string[]; /** @@ -1105,12 +867,7 @@ export namespace dataproc_v1 { */ sparkSqlJob?: Schema$SparkSqlJob; /** - * Required. The step id. The id must be unique among all jobs within the - * template.The step id is used as prefix for job id, as job - * goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field - * from other steps.The id must contain only letters (a-z, A-Z), numbers - * (0-9), underscores (_), and hyphens (-). Cannot begin or end with - * underscore or hyphen. Must consist of between 3 and 50 characters. + * Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. */ stepId?: string; } @@ -1128,19 +885,15 @@ export namespace dataproc_v1 { values?: Schema$ValueValidation; } /** - * A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) - * queries on YARN. + * A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. */ export interface Schema$PigJob { /** - * Optional. Whether to continue executing queries if a query fails. The - * default value is false. Setting to true can be useful when executing - * independent parallel queries. + * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ continueOnFailure?: boolean; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig - * Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. + * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. */ jarFileUris?: string[]; /** @@ -1148,10 +901,7 @@ export namespace dataproc_v1 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Pig. - * Properties that conflict with values set by the Cloud Dataproc API may be - * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, - * /etc/pig/conf/pig.properties, and classes in user code. + * Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. */ properties?: {[key: string]: string}; /** @@ -1163,47 +913,20 @@ export namespace dataproc_v1 { */ queryList?: Schema$QueryList; /** - * Optional. Mapping of query variable names to values (equivalent to the - * Pig command: name=[value]). + * Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). */ scriptVariables?: {[key: string]: string}; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources.A Policy - * consists of a list of bindings. A binding binds a list of members to a - * role, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A role is a named list of permissions - * defined by IAM.JSON Example { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] - * }, { "role": "roles/viewer", - * "members": ["user:sean@example.com"] } ] } YAML - * Example bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - * - members: - user:sean@example.com role: roles/viewer For a description - * of IAM and its features, see the IAM developer's guide - * (https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of members to a role. bindings with no members will - * result in an error. + * Associates a list of members to a role. bindings with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * etag is used for optimistic concurrency control as a way to help prevent - * simultaneous updates of a policy from overwriting each other. It is - * strongly suggested that systems make use of the etag in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An etag is returned in the response to getIamPolicy, and - * systems are expected to put that etag in the request to setIamPolicy to - * ensure that their change will be applied to the same version of the - * policy.If no etag is provided in the call to setIamPolicy, then the - * existing policy is overwritten blindly. + * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1212,30 +935,23 @@ export namespace dataproc_v1 { version?: number; } /** - * A Cloud Dataproc job for running Apache PySpark - * (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) - * applications on YARN. + * A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. */ export interface Schema$PySparkJob { /** - * Optional. HCFS URIs of archives to be extracted in the working directory - * of .jar, .tar, .tar.gz, .tgz, and .zip. + * Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. */ archiveUris?: string[]; /** - * Optional. The arguments to pass to the driver. Do not include arguments, - * such as --conf, that can be set as job properties, since a collision may - * occur that causes an incorrect job submission. + * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ args?: string[]; /** - * Optional. HCFS URIs of files to be copied to the working directory of - * Python drivers and distributed tasks. Useful for naively parallel tasks. + * Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python - * driver and tasks. + * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. */ jarFileUris?: string[]; /** @@ -1243,20 +959,15 @@ export namespace dataproc_v1 { */ loggingConfig?: Schema$LoggingConfig; /** - * Required. The HCFS URI of the main Python file to use as the driver. Must - * be a .py file. + * Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. */ mainPythonFileUri?: string; /** - * Optional. A mapping of property names to values, used to configure - * PySpark. Properties that conflict with values set by the Cloud Dataproc - * API may be overwritten. Can include properties set in - * /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string}; /** - * Optional. HCFS file URIs of Python files to pass to the PySpark - * framework. Supported file types: .py, .egg, and .zip. + * Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. */ pythonFileUris?: string[]; } @@ -1265,13 +976,7 @@ export namespace dataproc_v1 { */ export interface Schema$QueryList { /** - * Required. The queries to execute. You do not need to terminate a query - * with a semicolon. Multiple queries can be specified in one string by - * separating each with a semicolon. Here is an example of an Cloud Dataproc - * API snippet that uses a QueryList to specify a HiveJob: - * "hiveJob": { "queryList": { "queries": [ - * "query1", "query2", "query3;query4", - * ] } } + * Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } */ queries?: string[]; } @@ -1280,9 +985,7 @@ export namespace dataproc_v1 { */ export interface Schema$RegexValidation { /** - * Required. RE2 regular expressions used to validate the parameter's - * value. The value must match the regex in its entirety (substring matches - * are not sufficient). + * Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient). */ regexes?: string[]; } @@ -1291,10 +994,7 @@ export namespace dataproc_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the resource. The size of - * the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } @@ -1303,11 +1003,7 @@ export namespace dataproc_v1 { */ export interface Schema$SoftwareConfig { /** - * Optional. The version of software inside the cluster. It must be one of - * the supported Cloud Dataproc Versions, such as "1.2" (including - * a subminor version, such as "1.2.29"), or the - * "preview" version. If unspecified, it defaults to the latest - * version. + * Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version. */ imageVersion?: string; /** @@ -1315,41 +1011,28 @@ export namespace dataproc_v1 { */ optionalComponents?: string[]; /** - * Optional. The properties to set on daemon config files.Property keys are - * specified in prefix:property format, for example core:hadoop.tmp.dir. The - * following are supported prefixes and their mappings: capacity-scheduler: - * capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml - * hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: - * pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more - * information, see Cluster properties. + * Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more information, see Cluster properties. */ properties?: {[key: string]: string}; } /** - * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) - * applications on YARN. + * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. */ export interface Schema$SparkJob { /** - * Optional. HCFS URIs of archives to be extracted in the working directory - * of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, - * .tgz, and .zip. + * Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. */ archiveUris?: string[]; /** - * Optional. The arguments to pass to the driver. Do not include arguments, - * such as --conf, that can be set as job properties, since a collision may - * occur that causes an incorrect job submission. + * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ args?: string[]; /** - * Optional. HCFS URIs of files to be copied to the working directory of - * Spark drivers and distributed tasks. Useful for naively parallel tasks. + * Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark - * driver and tasks. + * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. */ jarFileUris?: string[]; /** @@ -1357,8 +1040,7 @@ export namespace dataproc_v1 { */ loggingConfig?: Schema$LoggingConfig; /** - * The name of the driver's main class. The jar file that contains the - * class must be in the default CLASSPATH or specified in jar_file_uris. + * The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. */ mainClass?: string; /** @@ -1366,16 +1048,12 @@ export namespace dataproc_v1 { */ mainJarFileUri?: string; /** - * Optional. A mapping of property names to values, used to configure Spark. - * Properties that conflict with values set by the Cloud Dataproc API may be - * overwritten. Can include properties set in - * /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string}; } /** - * A Cloud Dataproc job for running Apache Spark SQL - * (http://spark.apache.org/sql/) queries. + * A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. */ export interface Schema$SparkSqlJob { /** @@ -1387,9 +1065,7 @@ export namespace dataproc_v1 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Spark - * SQL's SparkConf. Properties that conflict with values set by the - * Cloud Dataproc API may be overwritten. + * Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. */ properties?: {[key: string]: string}; /** @@ -1401,45 +1077,12 @@ export namespace dataproc_v1 { */ queryList?: Schema$QueryList; /** - * Optional. Mapping of query variable names to values (equivalent to the - * Spark SQL command: SET name="value";). + * Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). */ scriptVariables?: {[key: string]: string}; } /** - * The Status type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by gRPC (https://github.com/grpc). The error model is designed to be: - * Simple to use and understand for most users Flexible enough to meet - * unexpected needsOverviewThe Status message contains three pieces of data: - * error code, error message, and error details. The error code should be an - * enum value of google.rpc.Code, but it may accept additional error codes if - * needed. The error message should be a developer-facing English message that - * helps developers understand and resolve the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may - * contain arbitrary information about the error. There is a predefined set of - * error detail types in the package google.rpc that can be used for common - * error conditions.Language mappingThe Status message is the logical - * representation of the error model, but it is not necessarily the actual - * wire format. When the Status message is exposed in different client - * libraries and different wire protocols, it can be mapped differently. For - * example, it will likely be mapped to some exceptions in Java, but more - * likely mapped to some error codes in C.Other usesThe error model and the - * Status message can be used in a variety of environments, either with or - * without APIs, to provide a consistent developer experience across different - * environments.Example uses of this error model include: Partial errors. If a - * service needs to return partial errors to the client, it may embed the - * Status in the normal response to indicate the partial errors. Workflow - * errors. A typical workflow has multiple steps. Each step may have a Status - * message for error reporting. Batch operations. If a client uses batch - * request and batch response, the Status message should be used directly - * inside batch response, one for each error sub-response. Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the Status message. Logging. If some API errors are stored in logs, - * the message Status could be used directly after any stripping needed for - * security/privacy reasons. + * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1447,14 +1090,11 @@ export namespace dataproc_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1467,67 +1107,24 @@ export namespace dataproc_v1 { */ job?: Schema$Job; /** - * Optional. A unique id used to identify the request. If the server - * receives two SubmitJobRequest requests with the same id, then the second - * request will be ignored and the first Job created and stored in the - * backend is returned.It is recommended to always set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; } /** - * A configurable parameter that replaces one or more fields in the template. - * Parameterizable fields: - Labels - File uris - Job properties - Job - * arguments - Script variables - Main class (in HadoopJob and SparkJob) - - * Zone (in ClusterSelector) + * A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector) */ export interface Schema$TemplateParameter { /** - * Optional. Brief description of the parameter. Must not exceed 1024 - * characters. + * Optional. Brief description of the parameter. Must not exceed 1024 characters. */ description?: string; /** - * Required. Paths to all fields that the parameter replaces. A field is - * allowed to appear in at most one parameter's list of field paths.A - * field path is similar in syntax to a google.protobuf.FieldMask. For - * example, a field path that references the zone field of a workflow - * template's cluster selector would be specified as - * placement.clusterSelector.zone.Also, field paths can reference fields - * using the following syntax: Values in maps can be referenced by key: - * labels'key' placement.clusterSelector.clusterLabels'key' - * placement.managedCluster.labels'key' - * placement.clusterSelector.clusterLabels'key' - * jobs'step-id'.labels'key' Jobs in the jobs list can be - * referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri - * jobs'step-id'.hiveJob.queryFileUri - * jobs'step-id'.pySparkJob.mainPythonFileUri - * jobs'step-id'.hadoopJob.jarFileUris0 - * jobs'step-id'.hadoopJob.archiveUris0 - * jobs'step-id'.hadoopJob.fileUris0 - * jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields - * can be referenced by a zero-based index: - * jobs'step-id'.sparkJob.args0 Other examples: - * jobs'step-id'.hadoopJob.properties'key' - * jobs'step-id'.hadoopJob.args0 - * jobs'step-id'.hiveJob.scriptVariables'key' - * jobs'step-id'.hadoopJob.mainJarFileUri - * placement.clusterSelector.zoneIt may not be possible to parameterize maps - * and repeated fields in their entirety since only individual map values - * and individual items in repeated fields can be referenced. For example, - * the following field paths are invalid: - * placement.clusterSelector.clusterLabels - * jobs'step-id'.sparkJob.args + * Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args */ fields?: string[]; /** - * Required. Parameter name. The parameter name is used as the key, and - * paired with the parameter value, which are passed to the template when - * the template is instantiated. The name must contain only capital letters - * (A-Z), numbers (0-9), and underscores (_), and must not start with a - * number. The maximum length is 40 characters. + * Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters. */ name?: string; /** @@ -1540,10 +1137,7 @@ export namespace dataproc_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the resource. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see IAM Overview - * (https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1552,8 +1146,7 @@ export namespace dataproc_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of TestPermissionsRequest.permissions that the caller is - * allowed. + * A subset of TestPermissionsRequest.permissions that the caller is allowed. */ permissions?: string[]; } @@ -1620,8 +1213,7 @@ export namespace dataproc_v1 { */ template?: string; /** - * Output only. The version of template at the time of workflow - * instantiation. + * Output only. The version of template at the time of workflow instantiation. */ version?: number; } @@ -1659,9 +1251,7 @@ export namespace dataproc_v1 { */ createTime?: string; /** - * Required. The template id.The id must contain only letters (a-z, A-Z), - * numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with - * underscore or hyphen. Must consist of between 3 and 50 characters. + * Required. The template id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. */ id?: string; /** @@ -1669,25 +1259,15 @@ export namespace dataproc_v1 { */ jobs?: Schema$OrderedJob[]; /** - * Optional. The labels to associate with this template. These labels will - * be propagated to all jobs and clusters created by the workflow - * instance.Label keys must contain 1 to 63 characters, and must conform to - * RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be - * empty, but, if present, must contain 1 to 63 characters, and must conform - * to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels - * can be associated with a template. + * Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. */ labels?: {[key: string]: string}; /** - * Output only. The "resource name" of the template, as described - * in https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. Template parameters whose values are substituted into the - * template. Values for parameters must be provided when the template is - * instantiated. + * Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. */ parameters?: Schema$TemplateParameter[]; /** @@ -1699,25 +1279,16 @@ export namespace dataproc_v1 { */ updateTime?: string; /** - * Optional. Used to perform a consistent read-modify-write.This field - * should be left blank for a CreateWorkflowTemplate request. It is required - * for an UpdateWorkflowTemplate request, and must match the current server - * version. A typical update template flow would fetch the current template - * with a GetWorkflowTemplate request, which will return the current - * template with the version field filled in with the current server - * version. The user updates other fields in the template, then returns it - * as part of the UpdateWorkflowTemplate request. + * Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. */ version?: number; } /** - * Specifies workflow execution target.Either managed_cluster or - * cluster_selector is required. + * Specifies workflow execution target.Either managed_cluster or cluster_selector is required. */ export interface Schema$WorkflowTemplatePlacement { /** - * Optional. A selector that chooses target cluster for jobs based on - * metadata.The selector is evaluated at the time each job is submitted. + * Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted. */ clusterSelector?: Schema$ClusterSelector; /** @@ -1726,10 +1297,7 @@ export namespace dataproc_v1 { managedCluster?: Schema$ManagedCluster; } /** - * A YARN application created by a job. Application information is a subset of - * <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta - * Feature: This report is available for testing purposes only. It may be - * changed before final release. + * A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ export interface Schema$YarnApplication { /** @@ -1745,10 +1313,7 @@ export namespace dataproc_v1 { */ state?: string; /** - * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or - * TimelineServer that provides application-specific information. The URL - * uses the internal hostname, and requires a proxy server for resolution - * and, possibly, access. + * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. */ trackingUrl?: string; } @@ -1766,64 +1331,66 @@ export namespace dataproc_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + autoscalingPolicies: Resource$Projects$Locations$Autoscalingpolicies; workflowTemplates: Resource$Projects$Locations$Workflowtemplates; constructor(context: APIRequestContext) { this.context = context; + this.autoscalingPolicies = new Resource$Projects$Locations$Autoscalingpolicies( + this.context + ); this.workflowTemplates = new Resource$Projects$Locations$Workflowtemplates( this.context ); } } - export class Resource$Projects$Locations$Workflowtemplates { + export class Resource$Projects$Locations$Autoscalingpolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * dataproc.projects.locations.workflowTemplates.create - * @desc Creates new workflow template. - * @alias dataproc.projects.locations.workflowTemplates.create + * dataproc.projects.locations.autoscalingPolicies.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @alias dataproc.projects.locations.autoscalingPolicies.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} - * @param {().WorkflowTemplate} params.resource Request body data + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Create, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Workflowtemplates$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Workflowtemplates$Create, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Create; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Create; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy; options = {}; } @@ -1836,7 +1403,7 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/workflowTemplates').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -1845,59 +1412,58 @@ export namespace dataproc_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataproc.projects.locations.workflowTemplates.delete - * @desc Deletes a workflow template. It does not cancel in-progress - * workflows. - * @alias dataproc.projects.locations.workflowTemplates.delete + * dataproc.projects.locations.autoscalingPolicies.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias dataproc.projects.locations.autoscalingPolicies.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * @param {integer=} params.version Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy; options = {}; } @@ -1910,67 +1476,73 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * dataproc.projects.locations.workflowTemplates.get - * @desc Retrieves the latest workflow template.Can retrieve previously - * instantiated template by specifying optional version parameter. - * @alias dataproc.projects.locations.workflowTemplates.get + * dataproc.projects.locations.autoscalingPolicies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias dataproc.projects.locations.autoscalingPolicies.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Workflowtemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Workflowtemplates$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Get - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Get; + {}) as Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Get; + params = {} as Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions; options = {}; } @@ -1983,48 +1555,329 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * dataproc.projects.locations.workflowTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. - * @alias dataproc.projects.locations.workflowTemplates.getIamPolicy + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Autoscalingpolicies$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Workflowtemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataproc.projects.locations.workflowTemplates.create + * @desc Creates new workflow template. + * @alias dataproc.projects.locations.workflowTemplates.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} + * @param {().WorkflowTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Workflowtemplates$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workflowtemplates$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workflowTemplates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.delete + * @desc Deletes a workflow template. It does not cancel in-progress workflows. + * @alias dataproc.projects.locations.workflowTemplates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * @param {integer=} params.version Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.get + * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. + * @alias dataproc.projects.locations.workflowTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Workflowtemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workflowtemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @alias dataproc.projects.locations.workflowTemplates.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy(callback: BodyResponseCallback): void; @@ -2076,13 +1929,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.instantiate - * @desc Instantiates a template and begins execution.The returned Operation - * can be used to track execution of workflow by polling operations.get. The - * Operation will complete when entire workflow is finished.The running - * workflow can be aborted via operations.cancel. This will cause any - * inflight jobs to be cancelled and workflow-owned clusters to be - * deleted.The Operation.metadata will be WorkflowMetadata.On successful - * completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.locations.workflowTemplates.instantiate * @memberOf! () * @@ -2157,15 +2004,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.instantiateInline - * @desc Instantiates a template and begins execution.This method is - * equivalent to executing the sequence CreateWorkflowTemplate, - * InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned - * Operation can be used to track execution of workflow by polling - * operations.get. The Operation will complete when entire workflow is - * finished.The running workflow can be aborted via operations.cancel. This - * will cause any inflight jobs to be cancelled and workflow-owned clusters - * to be deleted.The Operation.metadata will be WorkflowMetadata.On - * successful completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.locations.workflowTemplates.instantiateInline * @memberOf! () * @@ -2312,22 +2151,525 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias dataproc.projects.locations.workflowTemplates.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias dataproc.projects.locations.workflowTemplates.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dataproc.projects.locations.workflowTemplates.update + * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. + * @alias dataproc.projects.locations.workflowTemplates.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * @param {().WorkflowTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Projects$Locations$Workflowtemplates$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Workflowtemplates$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Workflowtemplates$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workflowtemplates$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workflowtemplates$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Workflowtemplates$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowTemplate; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + */ + name?: string; + /** + * Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. + */ + version?: number; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + */ + name?: string; + /** + * Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. + */ + version?: number; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstantiateWorkflowTemplateRequest; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} + */ + parent?: string; + /** + * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowTemplate; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of results to return in each response. + */ + pageSize?: number; + /** + * Optional. The page token, returned by a previous call, to request the next page of results. + */ + pageToken?: string; + /** + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Locations$Workflowtemplates$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowTemplate; + } + + export class Resource$Projects$Regions { + context: APIRequestContext; + autoscalingPolicies: Resource$Projects$Regions$Autoscalingpolicies; + clusters: Resource$Projects$Regions$Clusters; + jobs: Resource$Projects$Regions$Jobs; + operations: Resource$Projects$Regions$Operations; + workflowTemplates: Resource$Projects$Regions$Workflowtemplates; + constructor(context: APIRequestContext) { + this.context = context; + this.autoscalingPolicies = new Resource$Projects$Regions$Autoscalingpolicies( + this.context + ); + this.clusters = new Resource$Projects$Regions$Clusters(this.context); + this.jobs = new Resource$Projects$Regions$Jobs(this.context); + this.operations = new Resource$Projects$Regions$Operations(this.context); + this.workflowTemplates = new Resource$Projects$Regions$Workflowtemplates( + this.context + ); + } + } + + export class Resource$Projects$Regions$Autoscalingpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataproc.projects.regions.autoscalingPolicies.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @alias dataproc.projects.regions.autoscalingPolicies.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * dataproc.projects.locations.workflowTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias dataproc.projects.locations.workflowTemplates.setIamPolicy + * dataproc.projects.regions.autoscalingPolicies.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias dataproc.projects.regions.autoscalingPolicies.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -2338,33 +2680,33 @@ export namespace dataproc_v1 { * @return {object} Request object */ setIamPolicy( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy(callback: BodyResponseCallback): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + | Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy; options = {}; } @@ -2398,13 +2740,9 @@ export namespace dataproc_v1 { } /** - * dataproc.projects.locations.workflowTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias dataproc.projects.locations.workflowTemplates.testIamPermissions + * dataproc.projects.regions.autoscalingPolicies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias dataproc.projects.regions.autoscalingPolicies.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -2415,18 +2753,18 @@ export namespace dataproc_v1 { * @return {object} Request object */ testIamPermissions( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + params?: Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, + params: Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -2434,7 +2772,7 @@ export namespace dataproc_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + | Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -2442,12 +2780,12 @@ export namespace dataproc_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + {}) as Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions; + params = {} as Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions; options = {}; } @@ -2482,141 +2820,9 @@ export namespace dataproc_v1 { return createAPIRequest(parameters); } } - - /** - * dataproc.projects.locations.workflowTemplates.update - * @desc Updates (replaces) workflow template. The updated template must - * contain version that matches the current server version. - * @alias dataproc.projects.locations.workflowTemplates.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * @param {().WorkflowTemplate} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Projects$Locations$Workflowtemplates$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Projects$Locations$Workflowtemplates$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Projects$Locations$Workflowtemplates$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Workflowtemplates$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workflowtemplates$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workflowtemplates$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Workflowtemplates$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$WorkflowTemplate; - } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - */ - name?: string; - /** - * Optional. The version of workflow template to delete. If specified, will - * only delete the template if the current server version matches specified - * version. - */ - version?: number; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - */ - name?: string; - /** - * Optional. The version of workflow template to retrieve. Only previously - * instatiated versions can be retrieved.If unspecified, retrieves the - * current version. - */ - version?: number; - } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -2624,8 +2830,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2634,77 +2839,7 @@ export namespace dataproc_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InstantiateWorkflowTemplateRequest; - } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The "resource name" of the workflow template region, as - * described in https://cloud.google.com/apis/design/resource_names of the - * form projects/{project_id}/regions/{region} - */ - parent?: string; - /** - * Optional. A tag that prevents multiple concurrent workflow instances with - * the same tag from running. This mitigates risk of concurrent instances - * started due to retries.It is recommended to always set this value to a - * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The - * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), - * and hyphens (-). The maximum length is 40 characters. - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$WorkflowTemplate; - } - export interface Params$Resource$Projects$Locations$Workflowtemplates$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The maximum number of results to return in each response. - */ - pageSize?: number; - /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. - */ - pageToken?: string; - /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -2712,8 +2847,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2722,7 +2856,7 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + export interface Params$Resource$Projects$Regions$Autoscalingpolicies$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request @@ -2730,8 +2864,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2740,42 +2873,6 @@ export namespace dataproc_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Output only. The "resource name" of the template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$WorkflowTemplate; - } - - export class Resource$Projects$Regions { - context: APIRequestContext; - clusters: Resource$Projects$Regions$Clusters; - jobs: Resource$Projects$Regions$Jobs; - operations: Resource$Projects$Regions$Operations; - workflowTemplates: Resource$Projects$Regions$Workflowtemplates; - constructor(context: APIRequestContext) { - this.context = context; - this.clusters = new Resource$Projects$Regions$Clusters(this.context); - this.jobs = new Resource$Projects$Regions$Jobs(this.context); - this.operations = new Resource$Projects$Regions$Operations(this.context); - this.workflowTemplates = new Resource$Projects$Regions$Workflowtemplates( - this.context - ); - } - } export class Resource$Projects$Regions$Clusters { context: APIRequestContext; @@ -2792,14 +2889,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2808,12 +2903,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the - * cluster belongs to. projectId: 'my-project-id', // TODO: Update - * placeholder value. + * // Required. The ID of the Google Cloud Platform project that the cluster belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2822,8 +2916,10 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.regions.clusters.create(request, function(err, - * response) { if (err) { console.error(err); return; + * dataproc.projects.regions.clusters.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2837,10 +2933,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2927,14 +3022,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2943,12 +3036,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the - * cluster belongs to. projectId: 'my-project-id', // TODO: Update - * placeholder value. + * // Required. The ID of the Google Cloud Platform project that the cluster belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The cluster name. * clusterName: 'my-cluster-name', // TODO: Update placeholder value. @@ -2956,8 +3048,10 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.regions.clusters.delete(request, function(err, - * response) { if (err) { console.error(err); return; + * dataproc.projects.regions.clusters.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2971,10 +3065,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3056,22 +3149,19 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.clusters.diagnose - * @desc Gets cluster diagnostic information. After the operation completes, - * the Operation.response field contains DiagnoseClusterOutputLocation. + * @desc Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3080,12 +3170,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the - * cluster belongs to. projectId: 'my-project-id', // TODO: Update - * placeholder value. + * // Required. The ID of the Google Cloud Platform project that the cluster belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The cluster name. * clusterName: 'my-cluster-name', // TODO: Update placeholder value. @@ -3097,8 +3186,10 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.regions.clusters.diagnose(request, function(err, - * response) { if (err) { console.error(err); return; + * dataproc.projects.regions.clusters.diagnose(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3112,10 +3203,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3203,14 +3293,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3219,12 +3307,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the - * cluster belongs to. projectId: 'my-project-id', // TODO: Update - * placeholder value. + * // Required. The ID of the Google Cloud Platform project that the cluster belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The cluster name. * clusterName: 'my-cluster-name', // TODO: Update placeholder value. @@ -3232,8 +3319,10 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.regions.clusters.get(request, function(err, response) - * { if (err) { console.error(err); return; + * dataproc.projects.regions.clusters.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3247,10 +3336,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3328,8 +3416,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.clusters.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.clusters.getIamPolicy * @memberOf! () * @@ -3409,14 +3496,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3425,12 +3510,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the - * cluster belongs to. projectId: 'my-project-id', // TODO: Update - * placeholder value. + * // Required. The ID of the Google Cloud Platform project that the cluster belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -3446,8 +3530,8 @@ export namespace dataproc_v1 { * return; * } * for (var i = 0; i < clustersPage.length; i++) { - * // TODO: Change code below to process each resource in - * `clustersPage`: console.log(JSON.stringify(clustersPage[i], null, 2)); + * // TODO: Change code below to process each resource in `clustersPage`: + * console.log(JSON.stringify(clustersPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -3465,10 +3549,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3558,14 +3641,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3574,27 +3655,27 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project the cluster - * belongs to. projectId: 'my-project-id', // TODO: Update placeholder - * value. + * // Required. The ID of the Google Cloud Platform project the cluster belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The cluster name. * clusterName: 'my-cluster-name', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * * auth: authClient, * }; * - * dataproc.projects.regions.clusters.patch(request, function(err, - * response) { if (err) { console.error(err); return; + * dataproc.projects.regions.clusters.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3608,10 +3689,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3695,8 +3775,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.clusters.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.clusters.setIamPolicy * @memberOf! () * @@ -3769,11 +3848,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.clusters.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.clusters.testIamPermissions * @memberOf! () * @@ -3862,8 +3937,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -3871,14 +3945,7 @@ export namespace dataproc_v1 { */ region?: string; /** - * Optional. A unique id used to identify the request. If the server - * receives two CreateClusterRequest requests with the same id, then the - * second request will be ignored and the first google.longrunning.Operation - * created and stored in the backend is returned.It is recommended to always - * set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; @@ -3899,13 +3966,11 @@ export namespace dataproc_v1 { */ clusterName?: string; /** - * Optional. Specifying the cluster_uuid means the RPC should fail (with - * error NOT_FOUND) if cluster with specified UUID does not exist. + * Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist. */ clusterUuid?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -3913,14 +3978,7 @@ export namespace dataproc_v1 { */ region?: string; /** - * Optional. A unique id used to identify the request. If the server - * receives two DeleteClusterRequest requests with the same id, then the - * second request will be ignored and the first google.longrunning.Operation - * created and stored in the backend is returned.It is recommended to always - * set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; } @@ -3936,8 +3994,7 @@ export namespace dataproc_v1 { */ clusterName?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -3962,8 +4019,7 @@ export namespace dataproc_v1 { */ clusterName?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -3979,8 +4035,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3997,18 +4052,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. A filter constraining the clusters to list. Filters are - * case-sensitive and have the following syntax:field = value AND field = - * value ...where field is one of status.state, clusterName, or - * labels.[KEY], and [KEY] is a label key. value can be * to match all - * values. status.state can be one of the following: ACTIVE, INACTIVE, - * CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the - * CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING - * and ERROR states. clusterName is the name of the cluster provided at - * creation time. Only the logical AND operator is supported; - * space-separated items are treated as having an implicit AND - * operator.Example filter:status.state = ACTIVE AND clusterName = mycluster - * AND labels.env = staging AND labels.starred = * + * Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * */ filter?: string; /** @@ -4020,8 +4064,7 @@ export namespace dataproc_v1 { */ pageToken?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -4041,18 +4084,11 @@ export namespace dataproc_v1 { */ clusterName?: string; /** - * Optional. Timeout for graceful YARN decomissioning. Graceful - * decommissioning allows removing nodes from the cluster without - * interrupting jobs in progress. Timeout specifies how long to wait for - * jobs in progress to finish before forcefully removing nodes (and - * potentially interrupting jobs). Default timeout is 0 (for forceful - * decommission), and the maximum allowed timeout is 1 day.Only supported on - * Dataproc image versions 1.2 and higher. + * Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher. */ gracefulDecommissionTimeout?: string; /** - * Required. The ID of the Google Cloud Platform project the cluster belongs - * to. + * Required. The ID of the Google Cloud Platform project the cluster belongs to. */ projectId?: string; /** @@ -4060,35 +4096,11 @@ export namespace dataproc_v1 { */ region?: string; /** - * Optional. A unique id used to identify the request. If the server - * receives two UpdateClusterRequest requests with the same id, then the - * second request will be ignored and the first google.longrunning.Operation - * created and stored in the backend is returned.It is recommended to always - * set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; /** - * Required. Specifies the path, relative to Cluster, of the field to - * update. For example, to change the number of workers in a cluster to 5, - * the update_mask parameter would be specified as - * config.worker_config.num_instances, and the PATCH request body would - * specify the new value, as follows: { "config":{ "workerConfig":{ - * "numInstances":"5" } } } Similarly, to change the number of - * preemptible workers in a cluster to 5, the update_mask parameter would be - * config.secondary_worker_config.num_instances, and the PATCH request body - * would be set as follows: { "config":{ "secondaryWorkerConfig":{ - * "numInstances":"5" } } } Note: Currently, only the - * following fields can be updated: - * - * - * - * - * - * - *
                          Mask Purpose
                          labels Update labels
                          config.worker_config.num_instancesResize primary worker group
                          config.secondary_worker_config.num_instancesResize secondary worker group
                          + * Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:
                          Mask Purpose
                          labels Update labels
                          config.worker_config.num_instances Resize primary worker group
                          config.secondary_worker_config.num_instances Resize secondary worker group
                          */ updateMask?: string; @@ -4105,8 +4117,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4123,8 +4134,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4142,23 +4152,19 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.cancel - * @desc Starts a job cancellation request. To access the job resource after - * cancellation, call regions/{region}/jobs.list or - * regions/{region}/jobs.get. + * @desc Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4167,12 +4173,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the job - * belongs to. projectId: 'my-project-id', // TODO: Update placeholder - * value. + * // Required. The ID of the Google Cloud Platform project that the job belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The job ID. * jobId: 'my-job-id', // TODO: Update placeholder value. @@ -4184,8 +4189,10 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.regions.jobs.cancel(request, function(err, response) - * { if (err) { console.error(err); return; + * dataproc.projects.regions.jobs.cancel(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4199,10 +4206,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4281,22 +4287,19 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.delete - * @desc Deletes the job from the project. If the job is active, the delete - * fails, and the response returns FAILED_PRECONDITION. + * @desc Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4305,12 +4308,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the job - * belongs to. projectId: 'my-project-id', // TODO: Update placeholder - * value. + * // Required. The ID of the Google Cloud Platform project that the job belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The job ID. * jobId: 'my-job-id', // TODO: Update placeholder value. @@ -4332,10 +4334,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4419,14 +4420,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4435,12 +4434,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the job - * belongs to. projectId: 'my-project-id', // TODO: Update placeholder - * value. + * // Required. The ID of the Google Cloud Platform project that the job belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The job ID. * jobId: 'my-job-id', // TODO: Update placeholder value. @@ -4465,10 +4463,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4545,8 +4542,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.jobs.getIamPolicy * @memberOf! () * @@ -4626,14 +4622,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4642,12 +4636,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the job - * belongs to. projectId: 'my-project-id', // TODO: Update placeholder - * value. + * // Required. The ID of the Google Cloud Platform project that the job belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -4682,10 +4675,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4775,14 +4767,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4791,19 +4781,17 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the job - * belongs to. projectId: 'my-project-id', // TODO: Update placeholder - * value. + * // Required. The ID of the Google Cloud Platform project that the job belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * // Required. The job ID. * jobId: 'my-job-id', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -4827,10 +4815,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4909,8 +4896,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.jobs.setIamPolicy * @memberOf! () * @@ -4990,14 +4976,12 @@ export namespace dataproc_v1 { * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5006,12 +4990,11 @@ export namespace dataproc_v1 { * * authorize(function(authClient) { * var request = { - * // Required. The ID of the Google Cloud Platform project that the job - * belongs to. projectId: 'my-project-id', // TODO: Update placeholder - * value. + * // Required. The ID of the Google Cloud Platform project that the job belongs to. + * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // Required. The Cloud Dataproc region in which to handle the - * request. region: 'my-region', // TODO: Update placeholder value. + * // Required. The Cloud Dataproc region in which to handle the request. + * region: 'my-region', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -5020,8 +5003,10 @@ export namespace dataproc_v1 { * auth: authClient, * }; * - * dataproc.projects.regions.jobs.submit(request, function(err, response) - * { if (err) { console.error(err); return; + * dataproc.projects.regions.jobs.submit(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5035,10 +5020,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5115,11 +5099,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.jobs.testIamPermissions * @memberOf! () * @@ -5212,8 +5192,7 @@ export namespace dataproc_v1 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -5238,8 +5217,7 @@ export namespace dataproc_v1 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -5259,8 +5237,7 @@ export namespace dataproc_v1 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -5276,8 +5253,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -5294,24 +5270,15 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. If set, the returned jobs list includes only jobs that were - * submitted to the named cluster. + * Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. */ clusterName?: string; /** - * Optional. A filter constraining the jobs to list. Filters are - * case-sensitive and have the following syntax:field = value AND field = - * value ...where field is status.state or labels.[KEY], and [KEY] is a - * label key. value can be * to match all values. status.state can be either - * ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; - * space-separated items are treated as having an implicit AND - * operator.Example filter:status.state = ACTIVE AND labels.env = staging - * AND labels.starred = * + * Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = * */ filter?: string; /** - * Optional. Specifies enumerated categories of jobs to list. (default = - * match ALL jobs).If filter is provided, jobStateMatcher will be ignored. + * Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored. */ jobStateMatcher?: string; /** @@ -5319,13 +5286,11 @@ export namespace dataproc_v1 { */ pageSize?: number; /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. + * Optional. The page token, returned by a previous call, to request the next page of results. */ pageToken?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -5345,8 +5310,7 @@ export namespace dataproc_v1 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -5354,12 +5318,7 @@ export namespace dataproc_v1 { */ region?: string; /** - * Required. Specifies the path, relative to Job, of the field - * to update. For example, to update the labels of a Job the - * update_mask parameter would be specified as - * labels, and the PATCH request body would specify the new - * value. Note: Currently, labels is the only - * field that can be updated. + * Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. Note: Currently, labels is the only field that can be updated. */ updateMask?: string; @@ -5376,8 +5335,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -5394,8 +5352,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -5416,8 +5373,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -5435,29 +5391,19 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or - * other methods to check whether the cancellation succeeded or whether the - * operation completed despite cancellation. On successful cancellation, the - * operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to Code.CANCELLED. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5467,9 +5413,7 @@ export namespace dataproc_v1 { * authorize(function(authClient) { * var request = { * // The name of the operation resource to be cancelled. - * name: - * 'projects/my-project/regions/my-region/operations/my-operation', // - * TODO: Update placeholder value. + * name: 'projects/my-project/regions/my-region/operations/my-operation', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -5488,10 +5432,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5564,24 +5507,19 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns google.rpc.Code.UNIMPLEMENTED. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5591,9 +5529,7 @@ export namespace dataproc_v1 { * authorize(function(authClient) { * var request = { * // The name of the operation resource to be deleted. - * name: - * 'projects/my-project/regions/my-region/operations/my-operation', // - * TODO: Update placeholder value. + * name: 'projects/my-project/regions/my-region/operations/my-operation', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -5612,10 +5548,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5688,23 +5623,19 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5714,15 +5645,15 @@ export namespace dataproc_v1 { * authorize(function(authClient) { * var request = { * // The name of the operation resource. - * name: - * 'projects/my-project/regions/my-region/operations/my-operation', // - * TODO: Update placeholder value. + * name: 'projects/my-project/regions/my-region/operations/my-operation', // TODO: Update placeholder value. * * auth: authClient, * }; * - * dataproc.projects.regions.operations.get(request, function(err, - * response) { if (err) { console.error(err); return; + * dataproc.projects.regions.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5736,10 +5667,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5814,8 +5744,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.operations.getIamPolicy * @memberOf! () * @@ -5888,29 +5817,19 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: - * the name binding allows API services to override the binding to use - * different resource name schemes, such as users/x/operations. To override - * the binding, API services can add a binding such as - * "/v1/{name=users/x}/operations" to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5920,8 +5839,7 @@ export namespace dataproc_v1 { * authorize(function(authClient) { * var request = { * // The name of the operation's parent resource. - * name: 'projects/my-project/regions/my-region/operations', // TODO: - * Update placeholder value. + * name: 'projects/my-project/regions/my-region/operations', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -5937,9 +5855,8 @@ export namespace dataproc_v1 { * return; * } * for (var i = 0; i < operationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `operationsPage`: console.log(JSON.stringify(operationsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -5957,10 +5874,9 @@ export namespace dataproc_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6040,8 +5956,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.operations.setIamPolicy * @memberOf! () * @@ -6114,11 +6029,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.operations.testIamPermissions * @memberOf! () * @@ -6243,8 +6154,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6285,8 +6195,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6303,8 +6212,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6397,8 +6305,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.delete - * @desc Deletes a workflow template. It does not cancel in-progress - * workflows. + * @desc Deletes a workflow template. It does not cancel in-progress workflows. * @alias dataproc.projects.regions.workflowTemplates.delete * @memberOf! () * @@ -6468,8 +6375,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.get - * @desc Retrieves the latest workflow template.Can retrieve previously - * instantiated template by specifying optional version parameter. + * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. * @alias dataproc.projects.regions.workflowTemplates.get * @memberOf! () * @@ -6541,8 +6447,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.workflowTemplates.getIamPolicy * @memberOf! () * @@ -6615,13 +6520,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.instantiate - * @desc Instantiates a template and begins execution.The returned Operation - * can be used to track execution of workflow by polling operations.get. The - * Operation will complete when entire workflow is finished.The running - * workflow can be aborted via operations.cancel. This will cause any - * inflight jobs to be cancelled and workflow-owned clusters to be - * deleted.The Operation.metadata will be WorkflowMetadata.On successful - * completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.regions.workflowTemplates.instantiate * @memberOf! () * @@ -6696,15 +6595,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.instantiateInline - * @desc Instantiates a template and begins execution.This method is - * equivalent to executing the sequence CreateWorkflowTemplate, - * InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned - * Operation can be used to track execution of workflow by polling - * operations.get. The Operation will complete when entire workflow is - * finished.The running workflow can be aborted via operations.cancel. This - * will cause any inflight jobs to be cancelled and workflow-owned clusters - * to be deleted.The Operation.metadata will be WorkflowMetadata.On - * successful completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.regions.workflowTemplates.instantiateInline * @memberOf! () * @@ -6864,8 +6755,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.workflowTemplates.setIamPolicy * @memberOf! () * @@ -6938,11 +6828,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.workflowTemplates.testIamPermissions * @memberOf! () * @@ -7024,8 +6910,7 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.update - * @desc Updates (replaces) workflow template. The updated template must - * contain version that matches the current server version. + * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. * @alias dataproc.projects.regions.workflowTemplates.update * @memberOf! () * @@ -7104,9 +6989,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; @@ -7123,15 +7006,11 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. The version of workflow template to delete. If specified, will - * only delete the template if the current server version matches specified - * version. + * Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. */ version?: number; } @@ -7143,15 +7022,11 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. The version of workflow template to retrieve. Only previously - * instatiated versions can be retrieved.If unspecified, retrieves the - * current version. + * Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. */ version?: number; } @@ -7163,8 +7038,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -7181,9 +7055,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; @@ -7200,18 +7072,11 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template region, as - * described in https://cloud.google.com/apis/design/resource_names of the - * form projects/{project_id}/regions/{region} + * Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; /** - * Optional. A tag that prevents multiple concurrent workflow instances with - * the same tag from running. This mitigates risk of concurrent instances - * started due to retries.It is recommended to always set this value to a - * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The - * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), - * and hyphens (-). The maximum length is 40 characters. + * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; @@ -7232,14 +7097,11 @@ export namespace dataproc_v1 { */ pageSize?: number; /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. + * Optional. The page token, returned by a previous call, to request the next page of results. */ pageToken?: string; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; } @@ -7251,8 +7113,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -7269,8 +7130,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -7287,9 +7147,7 @@ export namespace dataproc_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The "resource name" of the template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index d653cfebc78..ceada8e8771 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace dataproc_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace dataproc_v1beta2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,31 +108,25 @@ export namespace dataproc_v1beta2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * Specifies the type and number of accelerator cards attached to the - * instances of an instance group (see GPUs on Compute Engine). + * Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine). */ export interface Schema$AcceleratorConfig { /** - * The number of the accelerator cards of this type exposed to this - * instance. + * The number of the accelerator cards of this type exposed to this instance. */ acceleratorCount?: number; /** - * Full URL, partial URI, or short name of the accelerator type resource to - * expose to this instance. See Compute Engine AcceleratorTypesExamples * - * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 - * * - * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 - * * nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud - * Dataproc Auto Zone Placement feature, you must use the short name of the - * accelerator type resource, for example, nvidia-tesla-k80. + * Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypesExamples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80. */ acceleratorTypeUri?: string; } @@ -145,11 +135,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$AutoscalingConfig { /** - * Optional. The autoscaling policy used by the cluster.Only resource names - * including projectid and location (region) are valid. Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] - * projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note - * that the policy must be in the same project and Cloud Dataproc region. + * Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Cloud Dataproc region. */ policyUri?: string; } @@ -159,20 +145,15 @@ export namespace dataproc_v1beta2 { export interface Schema$AutoscalingPolicy { basicAlgorithm?: Schema$BasicAutoscalingAlgorithm; /** - * Required. The policy id.The id must contain only letters (a-z, A-Z), - * numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with - * underscore or hyphen. Must consist of between 3 and 50 characters. + * Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. */ id?: string; /** - * Output only. The "resource name" of the policy, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. + * Output only. The "resource name" of the policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. */ name?: string; /** - * Optional. Describes how the autoscaler will operate for secondary - * workers. + * Optional. Describes how the autoscaler will operate for secondary workers. */ secondaryWorkerConfig?: Schema$InstanceGroupAutoscalingPolicyConfig; /** @@ -185,9 +166,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$BasicAutoscalingAlgorithm { /** - * Optional. Duration between scaling events. A scaling period starts after - * the update operation from the previous event has completed.Bounds: 2m, - * 1d. Default: 2m. + * Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m. */ cooldownPeriod?: string; /** @@ -200,45 +179,23 @@ export namespace dataproc_v1beta2 { */ export interface Schema$BasicYarnAutoscalingConfig { /** - * Required. Timeout for YARN graceful decommissioning of Node Managers. - * Specifies the duration to wait for jobs to complete before forcefully - * removing workers (and potentially interrupting jobs). Only applicable to - * downscaling operations.Bounds: 0s, 1d. + * Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d. */ gracefulDecommissionTimeout?: string; /** - * Required. Fraction of average pending memory in the last cooldown period - * for which to remove workers. A scale-down factor of 1 will result in - * scaling down so that there is no available memory remaining after the - * update (more aggressive scaling). A scale-down factor of 0 disables - * removing workers, which can be beneficial for autoscaling a single - * job.Bounds: 0.0, 1.0. + * Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0. */ scaleDownFactor?: number; /** - * Optional. Minimum scale-down threshold as a fraction of total cluster - * size before scaling occurs. For example, in a 20-worker cluster, a - * threshold of 0.1 means the autoscaler must recommend at least a 2 worker - * scale-down for the cluster to scale. A threshold of 0 means the - * autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. - * Default: 0.0. + * Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0. */ scaleDownMinWorkerFraction?: number; /** - * Required. Fraction of average pending memory in the last cooldown period - * for which to add workers. A scale-up factor of 1.0 will result in scaling - * up so that there is no pending memory remaining after the update (more - * aggressive scaling). A scale-up factor closer to 0 will result in a - * smaller magnitude of scaling up (less aggressive scaling).Bounds: - * 0.0, 1.0. + * Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0. */ scaleUpFactor?: number; /** - * Optional. Minimum scale-up threshold as a fraction of total cluster size - * before scaling occurs. For example, in a 20-worker cluster, a threshold - * of 0.1 means the autoscaler must recommend at least a 2-worker scale-up - * for the cluster to scale. A threshold of 0 means the autoscaler will - * scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0. + * Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0. */ scaleUpMinWorkerFraction?: number; } @@ -247,30 +204,15 @@ export namespace dataproc_v1beta2 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * members can have the following values: allUsers: A special identifier - * that represents anyone who is on the internet; with or without a Google - * account. allAuthenticatedUsers: A special identifier that represents - * anyone who is authenticated with a Google account or a service account. - * user:{emailid}: An email address that represents a specific Google - * account. For example, alice@gmail.com . serviceAccount:{emailid}: An - * email address that represents a service account. For example, - * my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email - * address that represents a Google group. For example, admins@example.com. - * domain:{domain}: The G Suite domain (primary) that represents all the - * users of that domain. For example, google.com or example.com. + * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. */ members?: string[]; /** - * Role that is assigned to members. For example, roles/viewer, - * roles/editor, or roles/owner. + * Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. */ role?: string; } @@ -279,43 +221,31 @@ export namespace dataproc_v1beta2 { */ export interface Schema$CancelJobRequest {} /** - * Describes the identifying information, config, and status of a cluster of - * Compute Engine instances. + * Describes the identifying information, config, and status of a cluster of Compute Engine instances. */ export interface Schema$Cluster { /** - * Required. The cluster name. Cluster names within a project must be - * unique. Names of deleted clusters can be reused. + * Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused. */ clusterName?: string; /** - * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc - * generates this value when it creates the cluster. + * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster. */ clusterUuid?: string; /** - * Required. The cluster config. Note that Cloud Dataproc may set default - * values, and values may change when clusters are updated. + * Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated. */ config?: Schema$ClusterConfig; /** - * Optional. The labels to associate with this cluster. Label keys must - * contain 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, - * if present, must contain 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be - * associated with a cluster. + * Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. */ labels?: {[key: string]: string}; /** - * Output only. Contains cluster daemon metrics such as HDFS and YARN - * stats.Beta Feature: This report is available for testing purposes only. - * It may be changed before final release. + * Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ metrics?: Schema$ClusterMetrics; /** - * Required. The Google Cloud Platform project ID that the cluster belongs - * to. + * Required. The Google Cloud Platform project ID that the cluster belongs to. */ projectId?: string; /** @@ -332,18 +262,11 @@ export namespace dataproc_v1beta2 { */ export interface Schema$ClusterConfig { /** - * Optional. Autoscaling config for the policy associated with the cluster. - * Cluster does not autoscale if this field is unset. + * Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset. */ autoscalingConfig?: Schema$AutoscalingConfig; /** - * Optional. A Google Cloud Storage bucket used to stage job dependencies, - * config files, and job driver console output. If you do not specify a - * staging bucket, Cloud Dataproc will determine a Cloud Storage location - * (US, ASIA, or EU) for your cluster's staging bucket according to the - * Google Compute Engine zone where your cluster is deployed, and then - * create and manage this project-level, per-location bucket (see Cloud - * Dataproc staging bucket). + * Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket). */ configBucket?: string; /** @@ -355,19 +278,11 @@ export namespace dataproc_v1beta2 { */ endpointConfig?: Schema$EndpointConfig; /** - * Optional. The shared Compute Engine config settings for all instances in - * a cluster. + * Optional. The shared Compute Engine config settings for all instances in a cluster. */ gceClusterConfig?: Schema$GceClusterConfig; /** - * Optional. Commands to execute on each node after config is completed. By - * default, executables are run on master and all worker nodes. You can test - * a node's <code>role</code> metadata to run an executable - * on a master or worker node, as shown below using curl (you can also use - * wget): ROLE=$(curl -H Metadata-Flavor:Google - * http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role) - * if [[ "${ROLE}" == 'Master' ]]; then ... master - * specific actions ... else ... worker specific actions ... fi + * Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi */ initializationActions?: Schema$NodeInitializationAction[]; /** @@ -375,13 +290,11 @@ export namespace dataproc_v1beta2 { */ lifecycleConfig?: Schema$LifecycleConfig; /** - * Optional. The Compute Engine config settings for the master instance in a - * cluster. + * Optional. The Compute Engine config settings for the master instance in a cluster. */ masterConfig?: Schema$InstanceGroupConfig; /** - * Optional. The Compute Engine config settings for additional worker - * instances in a cluster. + * Optional. The Compute Engine config settings for additional worker instances in a cluster. */ secondaryWorkerConfig?: Schema$InstanceGroupConfig; /** @@ -393,15 +306,12 @@ export namespace dataproc_v1beta2 { */ softwareConfig?: Schema$SoftwareConfig; /** - * Optional. The Compute Engine config settings for worker instances in a - * cluster. + * Optional. The Compute Engine config settings for worker instances in a cluster. */ workerConfig?: Schema$InstanceGroupConfig; } /** - * Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: - * This report is available for testing purposes only. It may be changed - * before final release. + * Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ export interface Schema$ClusterMetrics { /** @@ -497,9 +407,7 @@ export namespace dataproc_v1beta2 { */ clusterLabels?: {[key: string]: string}; /** - * Optional. The zone where workflow process executes. This parameter does - * not affect the selection of the cluster.If unspecified, the zone of the - * first cluster matching the selector is used. + * Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used. */ zone?: string; } @@ -520,8 +428,7 @@ export namespace dataproc_v1beta2 { */ stateStartTime?: string; /** - * Output only. Additional state information that includes status reported - * by the agent. + * Output only. Additional state information that includes status reported by the agent. */ substate?: string; } @@ -534,8 +441,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$DiagnoseClusterResults { /** - * Output only. The Cloud Storage URI of the diagnostic output. The output - * report is a plain text file with a summary of collected diagnostics. + * Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics. */ outputUri?: string; } @@ -548,26 +454,16 @@ export namespace dataproc_v1beta2 { */ bootDiskSizeGb?: number; /** - * Optional. Type of the boot disk (default is "pd-standard"). - * Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or - * "pd-standard" (Persistent Disk Hard Disk Drive). + * Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). */ bootDiskType?: string; /** - * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs - * are not attached, the boot disk is used to store runtime logs and HDFS - * (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one - * or more SSDs are attached, this runtime bulk data is spread across them, - * and the boot disk contains only basic config and installed binaries. + * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries. */ numLocalSsds?: number; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** @@ -575,8 +471,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$EncryptionConfig { /** - * Optional. The Cloud KMS key name to use for PD disk encryption for all - * instances in the cluster. + * Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster. */ gcePdKmsKeyName?: string; } @@ -585,74 +480,49 @@ export namespace dataproc_v1beta2 { */ export interface Schema$EndpointConfig { /** - * Optional. If true, enable http access to specific ports on the cluster - * from external sources. Defaults to false. + * Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false. */ enableHttpPortAccess?: boolean; /** - * Output only. The map of port descriptions to URLs. Will only be populated - * if enable_http_port_access is true. + * Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true. */ httpPorts?: {[key: string]: string}; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax.The application context of the containing message determines which - * well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Common config settings for resources of Compute Engine cluster instances, - * applicable to all instances in the cluster. + * Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. */ export interface Schema$GceClusterConfig { /** - * Optional. If true, all instances in the cluster will only have internal - * IP addresses. By default, clusters are not restricted to internal IP - * addresses, and will have ephemeral external IP addresses assigned to each - * instance. This internal_ip_only restriction can only be enabled for - * subnetwork enabled networks, and all off-cluster dependencies must be - * configured to be accessible without external IP addresses. + * Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses. */ internalIpOnly?: boolean; /** - * The Compute Engine metadata entries to add to all instances (see Project - * and instance metadata - * (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). + * The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). */ metadata?: {[key: string]: string}; /** - * Optional. The Compute Engine network to be used for machine - * communications. Cannot be specified with subnetwork_uri. If neither - * network_uri nor subnetwork_uri is specified, the "default" - * network of the project is used, if it exists. Cannot be a "Custom - * Subnet Network" (see Using Subnetworks for more information).A full - * URL, partial URI, or short name are valid. Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default - * projects/[project_id]/regions/global/default default + * Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default projects/[project_id]/regions/global/default default */ networkUri?: string; /** @@ -660,34 +530,15 @@ export namespace dataproc_v1beta2 { */ reservationAffinity?: Schema$ReservationAffinity; /** - * Optional. The service account of the instances. Defaults to the default - * Compute Engine service account. Custom service accounts need permissions - * equivalent to the following IAM roles: roles/logging.logWriter - * roles/storage.objectAdmin(see - * https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts - * for more information). Example: - * [account_id]@[project_id].iam.gserviceaccount.com + * Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles: roles/logging.logWriter roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com */ serviceAccount?: string; /** - * Optional. The URIs of service account scopes to be included in Compute - * Engine instances. The following base set of scopes is always included: - * https://www.googleapis.com/auth/cloud.useraccounts.readonly - * https://www.googleapis.com/auth/devstorage.read_write - * https://www.googleapis.com/auth/logging.writeIf no scopes are specified, - * the following defaults are also provided: - * https://www.googleapis.com/auth/bigquery - * https://www.googleapis.com/auth/bigtable.admin.table - * https://www.googleapis.com/auth/bigtable.data - * https://www.googleapis.com/auth/devstorage.full_control + * Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control */ serviceAccountScopes?: string[]; /** - * Optional. The Compute Engine subnetwork to be used for machine - * communications. Cannot be specified with network_uri.A full URL, partial - * URI, or short name are valid. Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0 - * projects/[project_id]/regions/us-east1/sub0 sub0 + * Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0 sub0 */ subnetworkUri?: string; /** @@ -695,14 +546,7 @@ export namespace dataproc_v1beta2 { */ tags?: string[]; /** - * Optional. The zone where the Compute Engine cluster will be located. On a - * create request, it is required in the "global" region. If - * omitted in a non-global Cloud Dataproc region, the service will pick a - * zone in the corresponding Compute Engine region. On a get request, zone - * will always be present.A full URL, partial URI, or short name are valid. - * Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] - * projects/[project_id]/zones/[zone] us-central1-f + * Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f */ zoneUri?: string; } @@ -711,33 +555,23 @@ export namespace dataproc_v1beta2 { */ export interface Schema$GetIamPolicyRequest {} /** - * A Cloud Dataproc job for running Apache Hadoop MapReduce - * (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) - * jobs on Apache Hadoop YARN - * (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). + * A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). */ export interface Schema$HadoopJob { /** - * Optional. HCFS URIs of archives to be extracted in the working directory - * of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, - * .tgz, or .zip. + * Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip. */ archiveUris?: string[]; /** - * Optional. The arguments to pass to the driver. Do not include arguments, - * such as -libjars or -Dfoo=bar, that can be set as job properties, since a - * collision may occur that causes an incorrect job submission. + * Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ args?: string[]; /** - * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied - * to the working directory of Hadoop drivers and distributed tasks. Useful - * for naively parallel tasks. + * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** - * Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and - * tasks. + * Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. */ jarFileUris?: string[]; /** @@ -745,46 +579,32 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * The name of the driver's main class. The jar file containing the - * class must be in the default CLASSPATH or specified in jar_file_uris. + * The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris. */ mainClass?: string; /** - * The HCFS URI of the jar file containing the main class. Examples: - * 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' - * 'hdfs:/tmp/test-samples/custom-wordcount.jar' - * 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' + * The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' */ mainJarFileUri?: string; /** - * Optional. A mapping of property names to values, used to configure - * Hadoop. Properties that conflict with values set by the Cloud Dataproc - * API may be overwritten. Can include properties set in - * /etc/hadoop/conf/*-site and classes in user code. + * Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. */ properties?: {[key: string]: string}; } /** - * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) - * queries on YARN. + * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. */ export interface Schema$HiveJob { /** - * Optional. Whether to continue executing queries if a query fails. The - * default value is false. Setting to true can be useful when executing - * independent parallel queries. + * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ continueOnFailure?: boolean; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive - * server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. + * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. */ jarFileUris?: string[]; /** - * Optional. A mapping of property names and values, used to configure Hive. - * Properties that conflict with values set by the Cloud Dataproc API may be - * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, - * /etc/hive/conf/hive-site.xml, and classes in user code. + * Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. */ properties?: {[key: string]: string}; /** @@ -796,41 +616,33 @@ export namespace dataproc_v1beta2 { */ queryList?: Schema$QueryList; /** - * Optional. Mapping of query variable names to values (equivalent to the - * Hive command: SET name="value";). + * Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). */ scriptVariables?: {[key: string]: string}; } /** - * Configuration for the size bounds of an instance group, including its - * proportional size to other groups. + * Configuration for the size bounds of an instance group, including its proportional size to other groups. */ export interface Schema$InstanceGroupAutoscalingPolicyConfig { /** - * Optional. Maximum number of instances for this group. Required for - * primary workers. Note that by default, clusters will not use secondary - * workers. Required for secondary workers if the minimum secondary - * instances is set.Primary workers - Bounds: [min_instances, ). Required. - * Secondary workers - Bounds: [min_instances, ). Default: 0. + * Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0. */ maxInstances?: number; /** - * Optional. Minimum number of instances for this group.Primary workers - - * Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, - * max_instances. Default: 0. + * Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0. */ minInstances?: number; + /** + * Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers. + */ weight?: number; } /** - * Optional. The config settings for Compute Engine resources in an instance - * group, such as a master or worker group. + * Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. */ export interface Schema$InstanceGroupConfig { /** - * Optional. The Compute Engine accelerator configuration for these - * instances.Beta Feature: This feature is still under development. It may - * be changed before final release. + * Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release. */ accelerators?: Schema$AcceleratorConfig[]; /** @@ -838,43 +650,31 @@ export namespace dataproc_v1beta2 { */ diskConfig?: Schema$DiskConfig; /** - * Optional. The Compute Engine image resource used for cluster instances. - * It can be specified or may be inferred from SoftwareConfig.image_version. + * Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version. */ imageUri?: string; /** - * Output only. The list of instance names. Cloud Dataproc derives the names - * from cluster_name, num_instances, and the instance group. + * Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group. */ instanceNames?: string[]; /** - * Optional. Specifies that this instance group contains preemptible - * instances. + * Optional. Specifies that this instance group contains preemptible instances. */ isPreemptible?: boolean; /** - * Optional. The Compute Engine machine type used for cluster instances.A - * full URL, partial URI, or short name are valid. Examples: - * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 - * projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 - * n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc - * Auto Zone Placement feature, you must use the short name of the machine - * type resource, for example, n1-standard-2. + * Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2. */ machineTypeUri?: string; /** - * Output only. The config for Compute Engine Instance Group Manager that - * manages this group. This is only used for preemptible instance groups. + * Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups. */ managedGroupConfig?: Schema$ManagedGroupConfig; /** - * Optional. Specifies the minimum cpu platform for the Instance Group. See - * Cloud Dataproc&rarr;Minimum CPU Platform. + * Optional. Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc&rarr;Minimum CPU Platform. */ minCpuPlatform?: string; /** - * Optional. The number of VM instances in the instance group. For master - * instance groups, must be set to 1. + * Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1. */ numInstances?: number; } @@ -887,24 +687,15 @@ export namespace dataproc_v1beta2 { */ instanceId?: string; /** - * Optional. Map from parameter names to values that should be used for - * those parameters. Values may not exceed 100 characters. + * Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters. */ parameters?: {[key: string]: string}; /** - * Optional. A tag that prevents multiple concurrent workflow instances with - * the same tag from running. This mitigates risk of concurrent instances - * started due to retries.It is recommended to always set this value to a - * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The - * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), - * and hyphens (-). The maximum length is 40 characters. + * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; /** - * Optional. The version of workflow template to instantiate. If specified, - * the workflow will be instantiated only if the current version of the - * workflow template has the supplied version.This option cannot be used to - * instantiate a previous version of workflow template. + * Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template. */ version?: number; } @@ -913,14 +704,11 @@ export namespace dataproc_v1beta2 { */ export interface Schema$Job { /** - * Output only. If present, the location of miscellaneous control files - * which may be used as part of job setup and handling. If not present, - * control files may be placed in the same location as driver_output_uri. + * Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. */ driverControlFilesUri?: string; /** - * Output only. A URI pointing to the location of the stdout of the - * job's driver program. + * Output only. A URI pointing to the location of the stdout of the job's driver program. */ driverOutputResourceUri?: string; /** @@ -932,18 +720,11 @@ export namespace dataproc_v1beta2 { */ hiveJob?: Schema$HiveJob; /** - * Output only. A UUID that uniquely identifies a job within the project - * over time. This is in contrast to a user-settable reference.job_id that - * may be reused over time. + * Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. */ jobUuid?: string; /** - * Optional. The labels to associate with this job. Label keys must contain - * 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, - * if present, must contain 1 to 63 characters, and must conform to RFC 1035 - * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be - * associated with a job. + * Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. */ labels?: {[key: string]: string}; /** @@ -963,10 +744,7 @@ export namespace dataproc_v1beta2 { */ pysparkJob?: Schema$PySparkJob; /** - * Optional. The fully qualified reference to the job, which can be used to - * obtain the equivalent REST path of the job resource. If this property is - * not specified when a job is created, the server generates a - * <code>job_id</code>. + * Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. */ reference?: Schema$JobReference; /** @@ -986,9 +764,7 @@ export namespace dataproc_v1beta2 { */ sparkSqlJob?: Schema$SparkSqlJob; /** - * Output only. The job status. Additional application-specific status - * information may be contained in the <code>type_job</code> and - * <code>yarn_applications</code> fields. + * Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. */ status?: Schema$JobStatus; /** @@ -996,15 +772,11 @@ export namespace dataproc_v1beta2 { */ statusHistory?: Schema$JobStatus[]; /** - * Output only. The email address of the user submitting the job. For jobs - * submitted on the cluster, the address is - * <code>username@hostname</code>. + * Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. */ submittedBy?: string; /** - * Output only. The collection of YARN applications spun up by this job.Beta - * Feature: This report is available for testing purposes only. It may be - * changed before final release. + * Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ yarnApplications?: Schema$YarnApplication[]; } @@ -1017,8 +789,7 @@ export namespace dataproc_v1beta2 { */ clusterName?: string; /** - * Output only. A cluster UUID generated by the Cloud Dataproc service when - * the job is submitted. + * Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. */ clusterUuid?: string; } @@ -1027,15 +798,11 @@ export namespace dataproc_v1beta2 { */ export interface Schema$JobReference { /** - * Optional. The job ID, which must be unique within the project.The ID must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or - * hyphens (-). The maximum length is 100 characters.If not specified by the - * caller, the job ID will be provided by the server. + * Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server. */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; } @@ -1044,10 +811,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$JobScheduling { /** - * Optional. Maximum number of times per hour a driver may be restarted as a - * result of driver terminating with non-zero code before job is reported - * failed.A job may be reported as thrashing if driver exits with non-zero - * code 4 times within 10 minute window.Maximum value is 10. + * Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. */ maxFailuresPerHour?: number; } @@ -1056,8 +820,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$JobStatus { /** - * Output only. Optional job state details, such as an error description if - * the state is <code>ERROR</code>. + * Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. */ details?: string; /** @@ -1069,8 +832,7 @@ export namespace dataproc_v1beta2 { */ stateStartTime?: string; /** - * Output only. Additional state information, which includes status reported - * by the agent. + * Output only. Additional state information, which includes status reported by the agent. */ substate?: string; } @@ -1079,24 +841,19 @@ export namespace dataproc_v1beta2 { */ export interface Schema$KerberosConfig { /** - * Optional. The admin server (IP or hostname) for the remote trusted realm - * in a cross realm trust relationship. + * Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */ crossRealmTrustAdminServer?: string; /** - * Optional. The KDC (IP or hostname) for the remote trusted realm in a - * cross realm trust relationship. + * Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */ crossRealmTrustKdc?: string; /** - * Optional. The remote realm the Dataproc on-cluster KDC will trust, should - * the user enable cross realm trust. + * Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust. */ crossRealmTrustRealm?: string; /** - * Optional. The GCS uri of a KMS encrypted file containing the shared - * password between the on-cluster Kerberos realm and the remote trusted - * realm, in a cross realm trust relationship. + * Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship. */ crossRealmTrustSharedPasswordUri?: string; /** @@ -1104,25 +861,19 @@ export namespace dataproc_v1beta2 { */ enableKerberos?: boolean; /** - * Optional. The GCS uri of a KMS encrypted file containing the master key - * of the KDC database. + * Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database. */ kdcDbKeyUri?: string; /** - * Optional. The GCS uri of a KMS encrypted file containing the password to - * the user provided key. For the self-signed certificate, this password is - * generated by Dataproc. + * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc. */ keyPasswordUri?: string; /** - * Optional. The GCS uri of a KMS encrypted file containing the password to - * the user provided keystore. For the self-signed certificate, this - * password is generated by Dataproc. + * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc. */ keystorePasswordUri?: string; /** - * Optional. The GCS uri of the keystore file used for SSL encryption. If - * not provided, Dataproc will provide a self-signed certificate. + * Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. */ keystoreUri?: string; /** @@ -1130,24 +881,19 @@ export namespace dataproc_v1beta2 { */ kmsKeyUri?: string; /** - * Required. The GCS uri of a KMS encrypted file containing the root - * principal password. + * Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password. */ rootPrincipalPasswordUri?: string; /** - * Optional. The lifetime of the ticket granting ticket, in hours. If not - * specified, or user specifies 0, then default value 10 will be used. + * Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used. */ tgtLifetimeHours?: number; /** - * Optional. The GCS uri of a KMS encrypted file containing the password to - * the user provided truststore. For the self-signed certificate, this - * password is generated by Dataproc. + * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc. */ truststorePasswordUri?: string; /** - * Optional. The GCS uri of the truststore file used for SSL encryption. If - * not provided, Dataproc will provide a self-signed certificate. + * Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. */ truststoreUri?: string; } @@ -1160,16 +906,11 @@ export namespace dataproc_v1beta2 { */ autoDeleteTime?: string; /** - * Optional. The lifetime duration of cluster. The cluster will be - * auto-deleted at the end of this period. Valid range: 10m, 14d.Example: - * "1d", to delete the cluster 1 day after its creation.. + * Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Valid range: 10m, 14d.Example: "1d", to delete the cluster 1 day after its creation.. */ autoDeleteTtl?: string; /** - * Optional. The duration to keep the cluster alive while idling. Passing - * this threshold will cause the cluster to be deleted. Valid range: 10m, - * 14d.Example: "10m", the minimum value, to delete the cluster - * when it has had no jobs running for 10 minutes. + * Optional. The duration to keep the cluster alive while idling. Passing this threshold will cause the cluster to be deleted. Valid range: 10m, 14d.Example: "10m", the minimum value, to delete the cluster when it has had no jobs running for 10 minutes. */ idleDeleteTtl?: string; } @@ -1178,8 +919,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$ListAutoscalingPoliciesResponse { /** - * Output only. This token is included in the response if there are more - * results to fetch. + * Output only. This token is included in the response if there are more results to fetch. */ nextPageToken?: string; /** @@ -1196,9 +936,7 @@ export namespace dataproc_v1beta2 { */ clusters?: Schema$Cluster[]; /** - * Output only. This token is included in the response if there are more - * results to fetch. To fetch additional results, provide this value as the - * page_token in a subsequent <code>ListClustersRequest</code>. + * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListClustersRequest</code>. */ nextPageToken?: string; } @@ -1211,9 +949,7 @@ export namespace dataproc_v1beta2 { */ jobs?: Schema$Job[]; /** - * Optional. This token is included in the response if there are more - * results to fetch. To fetch additional results, provide this value as the - * page_token in a subsequent <code>ListJobsRequest</code>. + * Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListJobsRequest</code>. */ nextPageToken?: string; } @@ -1235,10 +971,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$ListWorkflowTemplatesResponse { /** - * Output only. This token is included in the response if there are more - * results to fetch. To fetch additional results, provide this value as the - * page_token in a subsequent - * <code>ListWorkflowTemplatesRequest</code>. + * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListWorkflowTemplatesRequest</code>. */ nextPageToken?: string; /** @@ -1251,10 +984,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$LoggingConfig { /** - * The per-package log levels for the driver. This may include - * "root" package name to configure rootLogger. Examples: - * 'com.google = FATAL', 'root = INFO', 'org.apache = - * DEBUG' + * The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' */ driverLogLevels?: {[key: string]: string}; } @@ -1263,11 +993,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$ManagedCluster { /** - * Required. The cluster name prefix. A unique cluster name will be formed - * by appending a random suffix.The name must contain only lower-case - * letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. - * Cannot begin or end with hyphen. Must consist of between 2 and 35 - * characters. + * Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters. */ clusterName?: string; /** @@ -1275,12 +1001,7 @@ export namespace dataproc_v1beta2 { */ config?: Schema$ClusterConfig; /** - * Optional. The labels to associate with this cluster.Label keys must be - * between 1 and 63 characters long, and must conform to the following PCRE - * regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and - * 63 characters long, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be - * associated with a given cluster. + * Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. */ labels?: {[key: string]: string}; } @@ -1293,14 +1014,12 @@ export namespace dataproc_v1beta2 { */ instanceGroupManagerName?: string; /** - * Output only. The name of the Instance Template used for the Managed - * Instance Group. + * Output only. The name of the Instance Template used for the Managed Instance Group. */ instanceTemplateName?: string; } /** - * Specifies an executable to run on a fully configured node and a timeout - * period for executable completion. + * Specifies an executable to run on a fully configured node and a timeout period for executable completion. */ export interface Schema$NodeInitializationAction { /** @@ -1308,22 +1027,16 @@ export namespace dataproc_v1beta2 { */ executableFile?: string; /** - * Optional. Amount of time executable has to complete. Default is 10 - * minutes. Cluster creation fails with an explanatory error message (the - * name of the executable that caused the error and the exceeded timeout - * period) if the executable is not completed at end of the timeout period. + * Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period. */ executionTimeout?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is false, it means the operation is still in progress. If - * true, the operation is completed, and either error or response is - * available. + * If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */ done?: boolean; /** @@ -1331,26 +1044,15 @@ export namespace dataproc_v1beta2 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the name - * should have the format of operations/some/unique/name. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as Delete, the response is - * google.protobuf.Empty. If the original method is standard - * Get/Create/Update, the response should be the resource. For other - * methods, the response should have the type XxxResponse, where Xxx is the - * original method name. For example, if the original method name is - * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. + * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ response?: {[key: string]: any}; } @@ -1367,12 +1069,7 @@ export namespace dataproc_v1beta2 { */ hiveJob?: Schema$HiveJob; /** - * Optional. The labels to associate with this job.Label keys must be - * between 1 and 63 characters long, and must conform to the following - * regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and - * 63 characters long, and must conform to the following regular expression: - * \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a - * given job. + * Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job. */ labels?: {[key: string]: string}; /** @@ -1380,8 +1077,7 @@ export namespace dataproc_v1beta2 { */ pigJob?: Schema$PigJob; /** - * Optional. The optional list of prerequisite job step_ids. If not - * specified, the job will start at the beginning of workflow. + * Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. */ prerequisiteStepIds?: string[]; /** @@ -1401,12 +1097,7 @@ export namespace dataproc_v1beta2 { */ sparkSqlJob?: Schema$SparkSqlJob; /** - * Required. The step id. The id must be unique among all jobs within the - * template.The step id is used as prefix for job id, as job - * goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field - * from other steps.The id must contain only letters (a-z, A-Z), numbers - * (0-9), underscores (_), and hyphens (-). Cannot begin or end with - * underscore or hyphen. Must consist of between 3 and 50 characters. + * Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. */ stepId?: string; } @@ -1424,19 +1115,15 @@ export namespace dataproc_v1beta2 { values?: Schema$ValueValidation; } /** - * A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) - * queries on YARN. + * A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. */ export interface Schema$PigJob { /** - * Optional. Whether to continue executing queries if a query fails. The - * default value is false. Setting to true can be useful when executing - * independent parallel queries. + * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ continueOnFailure?: boolean; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig - * Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. + * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. */ jarFileUris?: string[]; /** @@ -1444,10 +1131,7 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Pig. - * Properties that conflict with values set by the Cloud Dataproc API may be - * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, - * /etc/pig/conf/pig.properties, and classes in user code. + * Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. */ properties?: {[key: string]: string}; /** @@ -1459,47 +1143,20 @@ export namespace dataproc_v1beta2 { */ queryList?: Schema$QueryList; /** - * Optional. Mapping of query variable names to values (equivalent to the - * Pig command: name=[value]). + * Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). */ scriptVariables?: {[key: string]: string}; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources.A Policy - * consists of a list of bindings. A binding binds a list of members to a - * role, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A role is a named list of permissions - * defined by IAM.JSON Example { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] - * }, { "role": "roles/viewer", - * "members": ["user:sean@example.com"] } ] } YAML - * Example bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - * - members: - user:sean@example.com role: roles/viewer For a description - * of IAM and its features, see the IAM developer's guide - * (https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of members to a role. bindings with no members will - * result in an error. + * Associates a list of members to a role. bindings with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * etag is used for optimistic concurrency control as a way to help prevent - * simultaneous updates of a policy from overwriting each other. It is - * strongly suggested that systems make use of the etag in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An etag is returned in the response to getIamPolicy, and - * systems are expected to put that etag in the request to setIamPolicy to - * ensure that their change will be applied to the same version of the - * policy.If no etag is provided in the call to setIamPolicy, then the - * existing policy is overwritten blindly. + * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1516,9 +1173,7 @@ export namespace dataproc_v1beta2 { */ clientTags?: string[]; /** - * Optional. Whether to continue executing queries if a query fails. The - * default value is false. Setting to true can be useful when executing - * independent parallel queries. + * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. */ continueOnFailure?: boolean; /** @@ -1526,15 +1181,11 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. The format in which query output will be displayed. See the - * Presto documentation for supported output formats + * Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats */ outputFormat?: string; /** - * Optional. A mapping of property names to values. Used to set Presto - * session properties - * (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to - * using the --session flag in the Presto CLI + * Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI */ properties?: {[key: string]: string}; /** @@ -1547,30 +1198,23 @@ export namespace dataproc_v1beta2 { queryList?: Schema$QueryList; } /** - * A Cloud Dataproc job for running Apache PySpark - * (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) - * applications on YARN. + * A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. */ export interface Schema$PySparkJob { /** - * Optional. HCFS URIs of archives to be extracted in the working directory - * of .jar, .tar, .tar.gz, .tgz, and .zip. + * Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. */ archiveUris?: string[]; /** - * Optional. The arguments to pass to the driver. Do not include arguments, - * such as --conf, that can be set as job properties, since a collision may - * occur that causes an incorrect job submission. + * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ args?: string[]; /** - * Optional. HCFS URIs of files to be copied to the working directory of - * Python drivers and distributed tasks. Useful for naively parallel tasks. + * Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python - * driver and tasks. + * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. */ jarFileUris?: string[]; /** @@ -1578,20 +1222,15 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * Required. The HCFS URI of the main Python file to use as the driver. Must - * be a .py file. + * Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. */ mainPythonFileUri?: string; /** - * Optional. A mapping of property names to values, used to configure - * PySpark. Properties that conflict with values set by the Cloud Dataproc - * API may be overwritten. Can include properties set in - * /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string}; /** - * Optional. HCFS file URIs of Python files to pass to the PySpark - * framework. Supported file types: .py, .egg, and .zip. + * Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. */ pythonFileUris?: string[]; } @@ -1600,13 +1239,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$QueryList { /** - * Required. The queries to execute. You do not need to terminate a query - * with a semicolon. Multiple queries can be specified in one string by - * separating each with a semicolon. Here is an example of an Cloud Dataproc - * API snippet that uses a QueryList to specify a HiveJob: - * "hiveJob": { "queryList": { "queries": [ - * "query1", "query2", "query3;query4", - * ] } } + * Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } */ queries?: string[]; } @@ -1615,9 +1248,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$RegexValidation { /** - * Required. RE2 regular expressions used to validate the parameter's - * value. The value must match the regex in its entirety (substring matches - * are not sufficient). + * Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient). */ regexes?: string[]; } @@ -1652,10 +1283,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the resource. The size of - * the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } @@ -1664,11 +1292,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$SoftwareConfig { /** - * Optional. The version of software inside the cluster. It must be one of - * the supported Cloud Dataproc Versions, such as "1.2" (including - * a subminor version, such as "1.2.29"), or the - * "preview" version. If unspecified, it defaults to the latest - * version. + * Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version. */ imageVersion?: string; /** @@ -1676,41 +1300,28 @@ export namespace dataproc_v1beta2 { */ optionalComponents?: string[]; /** - * Optional. The properties to set on daemon config files.Property keys are - * specified in prefix:property format, for example core:hadoop.tmp.dir. The - * following are supported prefixes and their mappings: capacity-scheduler: - * capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml - * hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: - * pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more - * information, see Cluster properties. + * Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more information, see Cluster properties. */ properties?: {[key: string]: string}; } /** - * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) - * applications on YARN. + * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. */ export interface Schema$SparkJob { /** - * Optional. HCFS URIs of archives to be extracted in the working directory - * of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, - * .tgz, and .zip. + * Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. */ archiveUris?: string[]; /** - * Optional. The arguments to pass to the driver. Do not include arguments, - * such as --conf, that can be set as job properties, since a collision may - * occur that causes an incorrect job submission. + * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ args?: string[]; /** - * Optional. HCFS URIs of files to be copied to the working directory of - * Spark drivers and distributed tasks. Useful for naively parallel tasks. + * Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** - * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark - * driver and tasks. + * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. */ jarFileUris?: string[]; /** @@ -1718,8 +1329,7 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * The name of the driver's main class. The jar file that contains the - * class must be in the default CLASSPATH or specified in jar_file_uris. + * The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. */ mainClass?: string; /** @@ -1727,33 +1337,24 @@ export namespace dataproc_v1beta2 { */ mainJarFileUri?: string; /** - * Optional. A mapping of property names to values, used to configure Spark. - * Properties that conflict with values set by the Cloud Dataproc API may be - * overwritten. Can include properties set in - * /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string}; } /** - * A Cloud Dataproc job for running Apache SparkR - * (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. + * A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. */ export interface Schema$SparkRJob { /** - * Optional. HCFS URIs of archives to be extracted in the working directory - * of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, - * .tgz, and .zip. + * Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. */ archiveUris?: string[]; /** - * Optional. The arguments to pass to the driver. Do not include arguments, - * such as --conf, that can be set as job properties, since a collision may - * occur that causes an incorrect job submission. + * Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. */ args?: string[]; /** - * Optional. HCFS URIs of files to be copied to the working directory of R - * drivers and distributed tasks. Useful for naively parallel tasks. + * Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** @@ -1761,21 +1362,16 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * Required. The HCFS URI of the main R file to use as the driver. Must be a - * .R file. + * Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. */ mainRFileUri?: string; /** - * Optional. A mapping of property names to values, used to configure - * SparkR. Properties that conflict with values set by the Cloud Dataproc - * API may be overwritten. Can include properties set in - * /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string}; } /** - * A Cloud Dataproc job for running Apache Spark SQL - * (http://spark.apache.org/sql/) queries. + * A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. */ export interface Schema$SparkSqlJob { /** @@ -1787,9 +1383,7 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Spark - * SQL's SparkConf. Properties that conflict with values set by the - * Cloud Dataproc API may be overwritten. + * Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. */ properties?: {[key: string]: string}; /** @@ -1801,45 +1395,12 @@ export namespace dataproc_v1beta2 { */ queryList?: Schema$QueryList; /** - * Optional. Mapping of query variable names to values (equivalent to the - * Spark SQL command: SET name="value";). + * Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). */ scriptVariables?: {[key: string]: string}; } /** - * The Status type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by gRPC (https://github.com/grpc). The error model is designed to be: - * Simple to use and understand for most users Flexible enough to meet - * unexpected needsOverviewThe Status message contains three pieces of data: - * error code, error message, and error details. The error code should be an - * enum value of google.rpc.Code, but it may accept additional error codes if - * needed. The error message should be a developer-facing English message that - * helps developers understand and resolve the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may - * contain arbitrary information about the error. There is a predefined set of - * error detail types in the package google.rpc that can be used for common - * error conditions.Language mappingThe Status message is the logical - * representation of the error model, but it is not necessarily the actual - * wire format. When the Status message is exposed in different client - * libraries and different wire protocols, it can be mapped differently. For - * example, it will likely be mapped to some exceptions in Java, but more - * likely mapped to some error codes in C.Other usesThe error model and the - * Status message can be used in a variety of environments, either with or - * without APIs, to provide a consistent developer experience across different - * environments.Example uses of this error model include: Partial errors. If a - * service needs to return partial errors to the client, it may embed the - * Status in the normal response to indicate the partial errors. Workflow - * errors. A typical workflow has multiple steps. Each step may have a Status - * message for error reporting. Batch operations. If a client uses batch - * request and batch response, the Status message should be used directly - * inside batch response, one for each error sub-response. Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the Status message. Logging. If some API errors are stored in logs, - * the message Status could be used directly after any stripping needed for - * security/privacy reasons. + * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1847,14 +1408,11 @@ export namespace dataproc_v1beta2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1867,67 +1425,24 @@ export namespace dataproc_v1beta2 { */ job?: Schema$Job; /** - * Optional. A unique id used to identify the request. If the server - * receives two SubmitJobRequest requests with the same id, then the second - * request will be ignored and the first Job created and stored in the - * backend is returned.It is recommended to always set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; } /** - * A configurable parameter that replaces one or more fields in the template. - * Parameterizable fields: - Labels - File uris - Job properties - Job - * arguments - Script variables - Main class (in HadoopJob and SparkJob) - - * Zone (in ClusterSelector) + * A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector) */ export interface Schema$TemplateParameter { /** - * Optional. Brief description of the parameter. Must not exceed 1024 - * characters. + * Optional. Brief description of the parameter. Must not exceed 1024 characters. */ description?: string; /** - * Required. Paths to all fields that the parameter replaces. A field is - * allowed to appear in at most one parameter's list of field paths.A - * field path is similar in syntax to a google.protobuf.FieldMask. For - * example, a field path that references the zone field of a workflow - * template's cluster selector would be specified as - * placement.clusterSelector.zone.Also, field paths can reference fields - * using the following syntax: Values in maps can be referenced by key: - * labels'key' placement.clusterSelector.clusterLabels'key' - * placement.managedCluster.labels'key' - * placement.clusterSelector.clusterLabels'key' - * jobs'step-id'.labels'key' Jobs in the jobs list can be - * referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri - * jobs'step-id'.hiveJob.queryFileUri - * jobs'step-id'.pySparkJob.mainPythonFileUri - * jobs'step-id'.hadoopJob.jarFileUris0 - * jobs'step-id'.hadoopJob.archiveUris0 - * jobs'step-id'.hadoopJob.fileUris0 - * jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields - * can be referenced by a zero-based index: - * jobs'step-id'.sparkJob.args0 Other examples: - * jobs'step-id'.hadoopJob.properties'key' - * jobs'step-id'.hadoopJob.args0 - * jobs'step-id'.hiveJob.scriptVariables'key' - * jobs'step-id'.hadoopJob.mainJarFileUri - * placement.clusterSelector.zoneIt may not be possible to parameterize maps - * and repeated fields in their entirety since only individual map values - * and individual items in repeated fields can be referenced. For example, - * the following field paths are invalid: - * placement.clusterSelector.clusterLabels - * jobs'step-id'.sparkJob.args + * Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args */ fields?: string[]; /** - * Required. Parameter name. The parameter name is used as the key, and - * paired with the parameter value, which are passed to the template when - * the template is instantiated. The name must contain only capital letters - * (A-Z), numbers (0-9), and underscores (_), and must not start with a - * number. The maximum length is 40 characters. + * Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters. */ name?: string; /** @@ -1940,10 +1455,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the resource. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see IAM Overview - * (https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1952,8 +1464,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of TestPermissionsRequest.permissions that the caller is - * allowed. + * A subset of TestPermissionsRequest.permissions that the caller is allowed. */ permissions?: string[]; } @@ -2020,8 +1531,7 @@ export namespace dataproc_v1beta2 { */ template?: string; /** - * Output only. The version of template at the time of workflow - * instantiation. + * Output only. The version of template at the time of workflow instantiation. */ version?: number; } @@ -2059,9 +1569,7 @@ export namespace dataproc_v1beta2 { */ createTime?: string; /** - * Required. The template id.The id must contain only letters (a-z, A-Z), - * numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with - * underscore or hyphen. Must consist of between 3 and 50 characters.. + * Required. The template id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.. */ id?: string; /** @@ -2069,25 +1577,15 @@ export namespace dataproc_v1beta2 { */ jobs?: Schema$OrderedJob[]; /** - * Optional. The labels to associate with this template. These labels will - * be propagated to all jobs and clusters created by the workflow - * instance.Label keys must contain 1 to 63 characters, and must conform to - * RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be - * empty, but, if present, must contain 1 to 63 characters, and must conform - * to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels - * can be associated with a template. + * Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. */ labels?: {[key: string]: string}; /** - * Output only. The "resource name" of the template, as described - * in https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. Template parameters whose values are substituted into the - * template. Values for parameters must be provided when the template is - * instantiated. + * Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. */ parameters?: Schema$TemplateParameter[]; /** @@ -2099,25 +1597,16 @@ export namespace dataproc_v1beta2 { */ updateTime?: string; /** - * Optional. Used to perform a consistent read-modify-write.This field - * should be left blank for a CreateWorkflowTemplate request. It is required - * for an UpdateWorkflowTemplate request, and must match the current server - * version. A typical update template flow would fetch the current template - * with a GetWorkflowTemplate request, which will return the current - * template with the version field filled in with the current server - * version. The user updates other fields in the template, then returns it - * as part of the UpdateWorkflowTemplate request. + * Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. */ version?: number; } /** - * Specifies workflow execution target.Either managed_cluster or - * cluster_selector is required. + * Specifies workflow execution target.Either managed_cluster or cluster_selector is required. */ export interface Schema$WorkflowTemplatePlacement { /** - * Optional. A selector that chooses target cluster for jobs based on - * metadata.The selector is evaluated at the time each job is submitted. + * Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted. */ clusterSelector?: Schema$ClusterSelector; /** @@ -2126,10 +1615,7 @@ export namespace dataproc_v1beta2 { managedCluster?: Schema$ManagedCluster; } /** - * A YARN application created by a job. Application information is a subset of - * <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta - * Feature: This report is available for testing purposes only. It may be - * changed before final release. + * A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ export interface Schema$YarnApplication { /** @@ -2145,10 +1631,7 @@ export namespace dataproc_v1beta2 { */ state?: string; /** - * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or - * TimelineServer that provides application-specific information. The URL - * uses the internal hostname, and requires a proxy server for resolution - * and, possibly, access. + * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. */ trackingUrl?: string; } @@ -2262,8 +1745,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.autoscalingPolicies.delete - * @desc Deletes an autoscaling policy. It is an error to delete an - * autoscaling policy that is in use by one or more clusters. + * @desc Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. * @alias dataproc.projects.locations.autoscalingPolicies.delete * @memberOf! () * @@ -2403,8 +1885,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.autoscalingPolicies.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.locations.autoscalingPolicies.getIamPolicy * @memberOf! () * @@ -2561,8 +2042,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.autoscalingPolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.locations.autoscalingPolicies.setIamPolicy * @memberOf! () * @@ -2635,11 +2115,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.autoscalingPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.locations.autoscalingPolicies.testIamPermissions * @memberOf! () * @@ -2721,8 +2197,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.autoscalingPolicies.update - * @desc Updates (replaces) autoscaling policy.Disabled check for - * update_mask, because all updates will be full replacements. + * @desc Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. * @alias dataproc.projects.locations.autoscalingPolicies.update * @memberOf! () * @@ -2801,9 +2276,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}. + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}. */ parent?: string; @@ -2820,9 +2293,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the autoscaling policy, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. */ name?: string; } @@ -2834,9 +2305,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the autoscaling policy, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. */ name?: string; } @@ -2848,8 +2317,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2865,14 +2333,11 @@ export namespace dataproc_v1beta2 { */ pageSize?: number; /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. + * Optional. The page token, returned by a previous call, to request the next page of results. */ pageToken?: string; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; } @@ -2884,8 +2349,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2902,8 +2366,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2920,9 +2383,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The "resource name" of the policy, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. + * Output only. The "resource name" of the policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. */ name?: string; @@ -3015,8 +2476,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.delete - * @desc Deletes a workflow template. It does not cancel in-progress - * workflows. + * @desc Deletes a workflow template. It does not cancel in-progress workflows. * @alias dataproc.projects.locations.workflowTemplates.delete * @memberOf! () * @@ -3086,8 +2546,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.get - * @desc Retrieves the latest workflow template.Can retrieve previously - * instantiated template by specifying optional version parameter. + * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. * @alias dataproc.projects.locations.workflowTemplates.get * @memberOf! () * @@ -3159,8 +2618,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.locations.workflowTemplates.getIamPolicy * @memberOf! () * @@ -3232,13 +2690,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.instantiate - * @desc Instantiates a template and begins execution.The returned Operation - * can be used to track execution of workflow by polling operations.get. The - * Operation will complete when entire workflow is finished.The running - * workflow can be aborted via operations.cancel. This will cause any - * inflight jobs to be cancelled and workflow-owned clusters to be - * deleted.The Operation.metadata will be WorkflowMetadata.On successful - * completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.locations.workflowTemplates.instantiate * @memberOf! () * @@ -3313,15 +2765,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.instantiateInline - * @desc Instantiates a template and begins execution.This method is - * equivalent to executing the sequence CreateWorkflowTemplate, - * InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned - * Operation can be used to track execution of workflow by polling - * operations.get. The Operation will complete when entire workflow is - * finished.The running workflow can be aborted via operations.cancel. This - * will cause any inflight jobs to be cancelled and workflow-owned clusters - * to be deleted.The Operation.metadata will be WorkflowMetadata.On - * successful completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.locations.workflowTemplates.instantiateInline * @memberOf! () * @@ -3482,8 +2926,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.locations.workflowTemplates.setIamPolicy * @memberOf! () * @@ -3556,11 +2999,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.locations.workflowTemplates.testIamPermissions * @memberOf! () * @@ -3642,8 +3081,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.locations.workflowTemplates.update - * @desc Updates (replaces) workflow template. The updated template must - * contain version that matches the current server version. + * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. * @alias dataproc.projects.locations.workflowTemplates.update * @memberOf! () * @@ -3722,9 +3160,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; @@ -3741,15 +3177,11 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. The version of workflow template to delete. If specified, will - * only delete the template if the current server version matches specified - * version. + * Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. */ version?: number; } @@ -3761,15 +3193,11 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. The version of workflow template to retrieve. Only previously - * instatiated versions can be retrieved.If unspecified, retrieves the - * current version. + * Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. */ version?: number; } @@ -3781,8 +3209,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -3794,9 +3221,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; @@ -3817,18 +3242,11 @@ export namespace dataproc_v1beta2 { */ instanceId?: string; /** - * Required. The "resource name" of the workflow template region, as - * described in https://cloud.google.com/apis/design/resource_names of the - * form projects/{project_id}/regions/{region} + * Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; /** - * Optional. A tag that prevents multiple concurrent workflow instances with - * the same tag from running. This mitigates risk of concurrent instances - * started due to retries.It is recommended to always set this value to a - * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The - * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), - * and hyphens (-). The maximum length is 40 characters. + * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; @@ -3849,14 +3267,11 @@ export namespace dataproc_v1beta2 { */ pageSize?: number; /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. + * Optional. The page token, returned by a previous call, to request the next page of results. */ pageToken?: string; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; } @@ -3868,8 +3283,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3886,8 +3300,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3904,9 +3317,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The "resource name" of the template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; @@ -4020,8 +3431,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.autoscalingPolicies.delete - * @desc Deletes an autoscaling policy. It is an error to delete an - * autoscaling policy that is in use by one or more clusters. + * @desc Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. * @alias dataproc.projects.regions.autoscalingPolicies.delete * @memberOf! () * @@ -4161,14 +3571,12 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.autoscalingPolicies.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.autoscalingPolicies.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {().GetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4217,7 +3625,7 @@ export namespace dataproc_v1beta2 { /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -4320,8 +3728,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.autoscalingPolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.autoscalingPolicies.setIamPolicy * @memberOf! () * @@ -4394,11 +3801,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.autoscalingPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.autoscalingPolicies.testIamPermissions * @memberOf! () * @@ -4480,8 +3883,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.autoscalingPolicies.update - * @desc Updates (replaces) autoscaling policy.Disabled check for - * update_mask, because all updates will be full replacements. + * @desc Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. * @alias dataproc.projects.regions.autoscalingPolicies.update * @memberOf! () * @@ -4560,9 +3962,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}. + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}. */ parent?: string; @@ -4579,9 +3979,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the autoscaling policy, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. */ name?: string; } @@ -4593,9 +3991,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the autoscaling policy, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. + * Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. */ name?: string; } @@ -4607,15 +4003,9 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GetIamPolicyRequest; } export interface Params$Resource$Projects$Regions$Autoscalingpolicies$List extends StandardParameters { @@ -4629,14 +4019,11 @@ export namespace dataproc_v1beta2 { */ pageSize?: number; /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. + * Optional. The page token, returned by a previous call, to request the next page of results. */ pageToken?: string; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; } @@ -4648,8 +4035,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4666,8 +4052,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4684,9 +4069,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The "resource name" of the policy, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. + * Output only. The "resource name" of the policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}. */ name?: string; @@ -4859,8 +4242,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.clusters.diagnose - * @desc Gets cluster diagnostic information. After the operation completes, - * the Operation.response field contains DiagnoseClusterOutputLocation. + * @desc Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation. * @alias dataproc.projects.regions.clusters.diagnose * @memberOf! () * @@ -5011,8 +4393,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.clusters.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.clusters.getIamPolicy * @memberOf! () * @@ -5244,8 +4625,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.clusters.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.clusters.setIamPolicy * @memberOf! () * @@ -5318,11 +4698,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.clusters.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.clusters.testIamPermissions * @memberOf! () * @@ -5411,8 +4787,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -5420,14 +4795,7 @@ export namespace dataproc_v1beta2 { */ region?: string; /** - * Optional. A unique id used to identify the request. If the server - * receives two CreateClusterRequest requests with the same id, then the - * second request will be ignored and the first google.longrunning.Operation - * created and stored in the backend is returned.It is recommended to always - * set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; @@ -5448,13 +4816,11 @@ export namespace dataproc_v1beta2 { */ clusterName?: string; /** - * Optional. Specifying the cluster_uuid means the RPC should fail (with - * error NOT_FOUND) if cluster with specified UUID does not exist. + * Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist. */ clusterUuid?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -5462,14 +4828,7 @@ export namespace dataproc_v1beta2 { */ region?: string; /** - * Optional. A unique id used to identify the request. If the server - * receives two DeleteClusterRequest requests with the same id, then the - * second request will be ignored and the first google.longrunning.Operation - * created and stored in the backend is returned.It is recommended to always - * set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; } @@ -5485,8 +4844,7 @@ export namespace dataproc_v1beta2 { */ clusterName?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -5511,8 +4869,7 @@ export namespace dataproc_v1beta2 { */ clusterName?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -5528,8 +4885,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -5541,18 +4897,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. A filter constraining the clusters to list. Filters are - * case-sensitive and have the following syntax:field = value AND field = - * value ...where field is one of status.state, clusterName, or - * labels.[KEY], and [KEY] is a label key. value can be * to match all - * values. status.state can be one of the following: ACTIVE, INACTIVE, - * CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the - * CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING - * and ERROR states. clusterName is the name of the cluster provided at - * creation time. Only the logical AND operator is supported; - * space-separated items are treated as having an implicit AND - * operator.Example filter:status.state = ACTIVE AND clusterName = mycluster - * AND labels.env = staging AND labels.starred = * + * Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * */ filter?: string; /** @@ -5564,8 +4909,7 @@ export namespace dataproc_v1beta2 { */ pageToken?: string; /** - * Required. The ID of the Google Cloud Platform project that the cluster - * belongs to. + * Required. The ID of the Google Cloud Platform project that the cluster belongs to. */ projectId?: string; /** @@ -5585,18 +4929,11 @@ export namespace dataproc_v1beta2 { */ clusterName?: string; /** - * Optional. Timeout for graceful YARN decomissioning. Graceful - * decommissioning allows removing nodes from the cluster without - * interrupting jobs in progress. Timeout specifies how long to wait for - * jobs in progress to finish before forcefully removing nodes (and - * potentially interrupting jobs). Default timeout is 0 (for forceful - * decommission), and the maximum allowed timeout is 1 day.Only supported on - * Dataproc image versions 1.2 and higher. + * Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher. */ gracefulDecommissionTimeout?: string; /** - * Required. The ID of the Google Cloud Platform project the cluster belongs - * to. + * Required. The ID of the Google Cloud Platform project the cluster belongs to. */ projectId?: string; /** @@ -5604,42 +4941,11 @@ export namespace dataproc_v1beta2 { */ region?: string; /** - * Optional. A unique id used to identify the request. If the server - * receives two UpdateClusterRequest requests with the same id, then the - * second request will be ignored and the first google.longrunning.Operation - * created and stored in the backend is returned.It is recommended to always - * set this value to a UUID - * (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must - * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and - * hyphens (-). The maximum length is 40 characters. + * Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; /** - * Required. Specifies the path, relative to Cluster, of the field to - * update. For example, to change the number of workers in a cluster to 5, - * the update_mask parameter would be specified as - * config.worker_config.num_instances, and the PATCH request body would - * specify the new value, as follows: { "config":{ "workerConfig":{ - * "numInstances":"5" } } } Similarly, to change the number of - * preemptible workers in a cluster to 5, the update_mask parameter would be - * config.secondary_worker_config.num_instances, and the PATCH request body - * would be set as follows: { "config":{ "secondaryWorkerConfig":{ - * "numInstances":"5" } } } Note: currently only the - * following fields can be updated: - * - * - * - * - * - * - * - *
                          MaskPurpose
                          labelsUpdates labels
                          config.worker_config.num_instancesResize primary worker - * group
                          config.secondary_worker_config.num_instancesResize secondary - * worker group
                          config.lifecycle_config.auto_delete_ttlReset MAX TTL - * duration
                          config.lifecycle_config.auto_delete_timeUpdate MAX TTL - * deletion timestamp
                          config.lifecycle_config.idle_delete_ttlUpdate Idle TTL - * duration
                          config.autoscaling_config.policy_uriUse, stop using, or - * change autoscaling policies
                          + * Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: currently only the following fields can be updated:
                          MaskPurpose
                          labelsUpdates labels
                          config.worker_config.num_instancesResize primary worker group
                          config.secondary_worker_config.num_instancesResize secondary worker group
                          config.lifecycle_config.auto_delete_ttlReset MAX TTL duration
                          config.lifecycle_config.auto_delete_timeUpdate MAX TTL deletion timestamp
                          config.lifecycle_config.idle_delete_ttlUpdate Idle TTL duration
                          config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies
                          */ updateMask?: string; @@ -5656,8 +4962,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -5674,8 +4979,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -5693,9 +4997,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.jobs.cancel - * @desc Starts a job cancellation request. To access the job resource after - * cancellation, call regions/{region}/jobs.list or - * regions/{region}/jobs.get. + * @desc Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get. * @alias dataproc.projects.regions.jobs.cancel * @memberOf! () * @@ -5770,8 +5072,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.jobs.delete - * @desc Deletes the job from the project. If the job is active, the delete - * fails, and the response returns FAILED_PRECONDITION. + * @desc Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. * @alias dataproc.projects.regions.jobs.delete * @memberOf! () * @@ -5919,8 +5220,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.jobs.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.jobs.getIamPolicy * @memberOf! () * @@ -6147,8 +5447,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.jobs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.jobs.setIamPolicy * @memberOf! () * @@ -6295,11 +5594,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.jobs.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.jobs.testIamPermissions * @memberOf! () * @@ -6392,8 +5687,7 @@ export namespace dataproc_v1beta2 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -6418,8 +5712,7 @@ export namespace dataproc_v1beta2 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -6439,8 +5732,7 @@ export namespace dataproc_v1beta2 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -6456,8 +5748,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -6469,24 +5760,15 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. If set, the returned jobs list includes only jobs that were - * submitted to the named cluster. + * Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. */ clusterName?: string; /** - * Optional. A filter constraining the jobs to list. Filters are - * case-sensitive and have the following syntax:field = value AND field = - * value ...where field is status.state or labels.[KEY], and [KEY] is a - * label key. value can be * to match all values. status.state can be either - * ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; - * space-separated items are treated as having an implicit AND - * operator.Example filter:status.state = ACTIVE AND labels.env = staging - * AND labels.starred = * + * Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = * */ filter?: string; /** - * Optional. Specifies enumerated categories of jobs to list. (default = - * match ALL jobs).If filter is provided, jobStateMatcher will be ignored. + * Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored. */ jobStateMatcher?: string; /** @@ -6494,13 +5776,11 @@ export namespace dataproc_v1beta2 { */ pageSize?: number; /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. + * Optional. The page token, returned by a previous call, to request the next page of results. */ pageToken?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -6520,8 +5800,7 @@ export namespace dataproc_v1beta2 { */ jobId?: string; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -6529,12 +5808,7 @@ export namespace dataproc_v1beta2 { */ region?: string; /** - * Required. Specifies the path, relative to Job, of the field - * to update. For example, to update the labels of a Job the - * update_mask parameter would be specified as - * labels, and the PATCH request body would specify the new - * value. Note: Currently, labels is the only - * field that can be updated. + * Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. Note: Currently, labels is the only field that can be updated. */ updateMask?: string; @@ -6551,8 +5825,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6569,8 +5842,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The ID of the Google Cloud Platform project that the job - * belongs to. + * Required. The ID of the Google Cloud Platform project that the job belongs to. */ projectId?: string; /** @@ -6591,8 +5863,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6610,15 +5881,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or - * other methods to check whether the cancellation succeeded or whether the - * operation completed despite cancellation. On successful cancellation, the - * operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to Code.CANCELLED. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. * @alias dataproc.projects.regions.operations.cancel * @memberOf! () * @@ -6690,10 +5953,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns google.rpc.Code.UNIMPLEMENTED. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. * @alias dataproc.projects.regions.operations.delete * @memberOf! () * @@ -6762,9 +6022,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias dataproc.projects.regions.operations.get * @memberOf! () * @@ -6835,8 +6093,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.operations.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.operations.getIamPolicy * @memberOf! () * @@ -6908,15 +6165,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: - * the name binding allows API services to override the binding to use - * different resource name schemes, such as users/x/operations. To override - * the binding, API services can add a binding such as - * "/v1/{name=users/x}/operations" to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias dataproc.projects.regions.operations.list * @memberOf! () * @@ -6992,8 +6241,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.operations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.operations.setIamPolicy * @memberOf! () * @@ -7066,11 +6314,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.operations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.operations.testIamPermissions * @memberOf! () * @@ -7195,8 +6439,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -7232,8 +6475,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -7250,8 +6492,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -7344,8 +6585,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.delete - * @desc Deletes a workflow template. It does not cancel in-progress - * workflows. + * @desc Deletes a workflow template. It does not cancel in-progress workflows. * @alias dataproc.projects.regions.workflowTemplates.delete * @memberOf! () * @@ -7415,8 +6655,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.get - * @desc Retrieves the latest workflow template.Can retrieve previously - * instantiated template by specifying optional version parameter. + * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. * @alias dataproc.projects.regions.workflowTemplates.get * @memberOf! () * @@ -7488,8 +6727,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.workflowTemplates.getIamPolicy * @memberOf! () * @@ -7561,13 +6799,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.instantiate - * @desc Instantiates a template and begins execution.The returned Operation - * can be used to track execution of workflow by polling operations.get. The - * Operation will complete when entire workflow is finished.The running - * workflow can be aborted via operations.cancel. This will cause any - * inflight jobs to be cancelled and workflow-owned clusters to be - * deleted.The Operation.metadata will be WorkflowMetadata.On successful - * completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.regions.workflowTemplates.instantiate * @memberOf! () * @@ -7642,15 +6874,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.instantiateInline - * @desc Instantiates a template and begins execution.This method is - * equivalent to executing the sequence CreateWorkflowTemplate, - * InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned - * Operation can be used to track execution of workflow by polling - * operations.get. The Operation will complete when entire workflow is - * finished.The running workflow can be aborted via operations.cancel. This - * will cause any inflight jobs to be cancelled and workflow-owned clusters - * to be deleted.The Operation.metadata will be WorkflowMetadata.On - * successful completion, Operation.response will be Empty. + * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. * @alias dataproc.projects.regions.workflowTemplates.instantiateInline * @memberOf! () * @@ -7811,8 +7035,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias dataproc.projects.regions.workflowTemplates.setIamPolicy * @memberOf! () * @@ -7885,11 +7108,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error.Note: This operation is designed to be - * used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias dataproc.projects.regions.workflowTemplates.testIamPermissions * @memberOf! () * @@ -7971,8 +7190,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.workflowTemplates.update - * @desc Updates (replaces) workflow template. The updated template must - * contain version that matches the current server version. + * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. * @alias dataproc.projects.regions.workflowTemplates.update * @memberOf! () * @@ -8051,9 +7269,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; @@ -8070,15 +7286,11 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. The version of workflow template to delete. If specified, will - * only delete the template if the current server version matches specified - * version. + * Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. */ version?: number; } @@ -8090,15 +7302,11 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** - * Optional. The version of workflow template to retrieve. Only previously - * instatiated versions can be retrieved.If unspecified, retrieves the - * current version. + * Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. */ version?: number; } @@ -8110,8 +7318,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -8123,9 +7330,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The "resource name" of the workflow template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; @@ -8146,18 +7351,11 @@ export namespace dataproc_v1beta2 { */ instanceId?: string; /** - * Required. The "resource name" of the workflow template region, as - * described in https://cloud.google.com/apis/design/resource_names of the - * form projects/{project_id}/regions/{region} + * Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; /** - * Optional. A tag that prevents multiple concurrent workflow instances with - * the same tag from running. This mitigates risk of concurrent instances - * started due to retries.It is recommended to always set this value to a - * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The - * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), - * and hyphens (-). The maximum length is 40 characters. + * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ requestId?: string; @@ -8178,14 +7376,11 @@ export namespace dataproc_v1beta2 { */ pageSize?: number; /** - * Optional. The page token, returned by a previous call, to request the - * next page of results. + * Optional. The page token, returned by a previous call, to request the next page of results. */ pageToken?: string; /** - * Required. The "resource name" of the region, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region} + * Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} */ parent?: string; } @@ -8197,8 +7392,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -8215,8 +7409,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -8233,9 +7426,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The "resource name" of the template, as described in - * https://cloud.google.com/apis/design/resource_names of the form - * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; diff --git a/src/apis/datastore/package.json b/src/apis/datastore/package.json index 1fc5dbfaeed..e663237cec9 100644 --- a/src/apis/datastore/package.json +++ b/src/apis/datastore/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index 4858105c0b3..d8744b28dbc 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace datastore_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace datastore_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace datastore_v1 { /** * Cloud Datastore API * - * Accesses the schemaless NoSQL database to provide fully managed, robust, - * scalable storage for your application. + * Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace datastore_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,8 +122,7 @@ export namespace datastore_v1 { */ export interface Schema$AllocateIdsRequest { /** - * A list of keys with incomplete key paths for which to allocate IDs. No - * key may be reserved/read-only. + * A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only. */ keys?: Schema$Key[]; } @@ -134,8 +131,7 @@ export namespace datastore_v1 { */ export interface Schema$AllocateIdsResponse { /** - * The keys specified in the request (in the same order), each with its key - * path completed with a newly allocated ID. + * The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID. */ keys?: Schema$Key[]; } @@ -144,8 +140,7 @@ export namespace datastore_v1 { */ export interface Schema$ArrayValue { /** - * Values in the array. The order of values in an array is preserved as long - * as all values have identical settings for 'exclude_from_indexes'. + * Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. */ values?: Schema$Value[]; } @@ -176,19 +171,11 @@ export namespace datastore_v1 { */ mode?: string; /** - * The mutations to perform. When mode is `TRANSACTIONAL`, mutations - * affecting a single entity are applied in order. The following sequences - * of mutations affecting a single entity are not permitted in a single - * `Commit` request: - `insert` followed by `insert` - `update` followed by - * `insert` - `upsert` followed by `insert` - `delete` followed by `update` - * When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single - * entity. + * The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity. */ mutations?: Schema$Mutation[]; /** - * The identifier of the transaction associated with the commit. A - * transaction identifier is returned by a call to - * Datastore.BeginTransaction. + * The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ transaction?: string; } @@ -197,13 +184,11 @@ export namespace datastore_v1 { */ export interface Schema$CommitResponse { /** - * The number of index entries updated during the commit, or zero if none - * were updated. + * The number of index entries updated during the commit, or zero if none were updated. */ indexUpdates?: number; /** - * The result of performing the mutations. The i-th mutation result - * corresponds to the i-th mutation in the request. + * The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request. */ mutationResults?: Schema$MutationResult[]; } @@ -221,31 +206,19 @@ export namespace datastore_v1 { op?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A Datastore data object. An entity is limited to 1 megabyte when stored. - * That _roughly_ corresponds to a limit of 1 megabyte for the serialized form - * of this message. + * A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. */ export interface Schema$Entity { /** - * The entity's key. An entity must have a key, unless otherwise - * documented (for example, an entity in `Value.entity_value` may have no - * key). An entity's kind is its key path's last element's kind, - * or null if it has no key. + * The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. */ key?: Schema$Key; /** - * The entity's properties. The map's keys are property names. A - * property name matching regex `__.*__` is reserved. A reserved property - * name is forbidden in certain documented contexts. The name must not - * contain more than 500 characters. The name cannot be `""`. + * The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. */ properties?: {[key: string]: Schema$Value}; } @@ -254,8 +227,7 @@ export namespace datastore_v1 { */ export interface Schema$EntityResult { /** - * A cursor that points to the position after the result entity. Set only - * when the `EntityResult` is part of a `QueryResultBatch` message. + * A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message. */ cursor?: string; /** @@ -263,11 +235,7 @@ export namespace datastore_v1 { */ entity?: Schema$Entity; /** - * The version of the entity, a strictly positive number that monotonically - * increases with changes to the entity. This field is set for `FULL` - * entity results. For missing entities in `LookupResponse`, this is the - * version of the snapshot that was used to look up the entity, and it is - * always set except for eventually consistent reads. + * The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. */ version?: string; } @@ -293,13 +261,11 @@ export namespace datastore_v1 { */ endTime?: string; /** - * The client-assigned labels which were provided when the operation was - * created. May also include additional labels. + * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ labels?: {[key: string]: string}; /** - * The type of the operation. Can be used as a filter in - * ListOperationsRequest. + * The type of the operation. Can be used as a filter in ListOperationsRequest. */ operationType?: string; /** @@ -312,16 +278,7 @@ export namespace datastore_v1 { state?: string; } /** - * Identifies a subset of entities in a project. This is specified as - * combinations of kinds and namespaces (either or both of which may be all, - * as described in the following examples). Example usage: Entire project: - * kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: - * kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar - * only in the default namespace: kinds=['Foo', 'Bar'], - * namespace_ids=[''] Kinds Foo and Bar in both the default and Baz - * namespaces: kinds=['Foo', 'Bar'], - * namespace_ids=['', 'Baz'] The entire Baz namespace: - * kinds=[], namespace_ids=['Baz'] + * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] */ export interface Schema$GoogleDatastoreAdminV1beta1EntityFilter { /** @@ -329,11 +286,7 @@ export namespace datastore_v1 { */ kinds?: string[]; /** - * An empty list represents all namespaces. This is the preferred usage for - * projects that don't use namespaces. An empty string element - * represents the default namespace. This should be used if the project has - * data in non-default namespaces, but doesn't want to include them. - * Each namespace in this list must be unique. + * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ namespaceIds?: string[]; } @@ -350,11 +303,7 @@ export namespace datastore_v1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter; /** - * Location for the export metadata and data files. This will be the same - * value as the - * google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix - * field. The final output location is provided in - * google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. */ outputUrlPrefix?: string; /** @@ -367,15 +316,11 @@ export namespace datastore_v1 { progressEntities?: Schema$GoogleDatastoreAdminV1beta1Progress; } /** - * The response for - * google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + * The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. */ export interface Schema$GoogleDatastoreAdminV1beta1ExportEntitiesResponse { /** - * Location of the output metadata file. This can be used to begin an import - * into Cloud Datastore (this project or another project). See - * google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only - * present if the operation completed successfully. + * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ outputUrl?: string; } @@ -392,9 +337,7 @@ export namespace datastore_v1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter; /** - * The location of the import metadata file. This will be the same value as - * the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url - * field. + * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. */ inputUrl?: string; /** @@ -411,13 +354,11 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1beta1Progress { /** - * The amount of work that has been completed. Note that this may be greater - * than work_estimated. + * The amount of work that has been completed. Note that this may be greater than work_estimated. */ workCompleted?: string; /** - * An estimate of how much work needs to be performed. May be zero if the - * work estimate is unavailable. + * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ workEstimated?: string; } @@ -430,13 +371,11 @@ export namespace datastore_v1 { */ endTime?: string; /** - * The client-assigned labels which were provided when the operation was - * created. May also include additional labels. + * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ labels?: {[key: string]: string}; /** - * The type of the operation. Can be used as a filter in - * ListOperationsRequest. + * The type of the operation. Can be used as a filter in ListOperationsRequest. */ operationType?: string; /** @@ -449,16 +388,7 @@ export namespace datastore_v1 { state?: string; } /** - * Identifies a subset of entities in a project. This is specified as - * combinations of kinds and namespaces (either or both of which may be all, - * as described in the following examples). Example usage: Entire project: - * kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: - * kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar - * only in the default namespace: kinds=['Foo', 'Bar'], - * namespace_ids=[''] Kinds Foo and Bar in both the default and Baz - * namespaces: kinds=['Foo', 'Bar'], - * namespace_ids=['', 'Baz'] The entire Baz namespace: - * kinds=[], namespace_ids=['Baz'] + * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] */ export interface Schema$GoogleDatastoreAdminV1EntityFilter { /** @@ -466,11 +396,7 @@ export namespace datastore_v1 { */ kinds?: string[]; /** - * An empty list represents all namespaces. This is the preferred usage for - * projects that don't use namespaces. An empty string element - * represents the default namespace. This should be used if the project has - * data in non-default namespaces, but doesn't want to include them. - * Each namespace in this list must be unique. + * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ namespaceIds?: string[]; } @@ -487,11 +413,7 @@ export namespace datastore_v1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * Location for the export metadata and data files. This will be the same - * value as the - * google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. - * The final output location is provided in - * google.datastore.admin.v1.ExportEntitiesResponse.output_url. + * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ outputUrlPrefix?: string; /** @@ -516,20 +438,7 @@ export namespace datastore_v1 { */ labels?: {[key: string]: string}; /** - * Location for the export metadata and data files. The full resource URL - * of the external storage location. Currently, only Google Cloud Storage is - * supported. So output_url_prefix should be of the form: - * `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of - * the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud - * Storage namespace path (this is not a Cloud Datastore namespace). For - * more information about Cloud Storage namespace paths, see [Object name - * considerations](https://cloud.google.com/storage/docs/naming#object-considerations). - * The resulting files will be nested deeper than the specified URL prefix. - * The final output URL will be provided in the - * google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That - * value should be used for subsequent ImportEntities operations. By - * nesting the data files deeper, the same Cloud Storage bucket can be used - * in multiple ExportEntities operations without conflict. + * Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict. */ outputUrlPrefix?: string; } @@ -538,10 +447,7 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1ExportEntitiesResponse { /** - * Location of the output metadata file. This can be used to begin an import - * into Cloud Datastore (this project or another project). See - * google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present - * if the operation completed successfully. + * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ outputUrl?: string; } @@ -558,8 +464,7 @@ export namespace datastore_v1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * The location of the import metadata file. This will be the same value as - * the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. + * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. */ inputUrl?: string; /** @@ -576,24 +481,11 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1ImportEntitiesRequest { /** - * Optionally specify which kinds/namespaces are to be imported. If - * provided, the list must be a subset of the EntityFilter used in creating - * the export, otherwise a FAILED_PRECONDITION error will be returned. If no - * filter is specified then all entities from the export are imported. + * Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported. */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * The full resource URL of the external storage location. Currently, only - * Google Cloud Storage is supported. So input_url should be of the form: - * `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where - * `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` - * is an optional Cloud Storage namespace path (this is not a Cloud - * Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata - * file written by the ExportEntities operation. For more information about - * Cloud Storage namespace paths, see [Object name - * considerations](https://cloud.google.com/storage/docs/naming#object-considerations). - * For more information, see - * google.datastore.admin.v1.ExportEntitiesResponse.output_url. + * The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ inputUrl?: string; /** @@ -606,8 +498,7 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1Index { /** - * The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. - * Required. + * The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. Required. */ ancestor?: string; /** @@ -623,8 +514,7 @@ export namespace datastore_v1 { */ projectId?: string; /** - * An ordered sequence of property names and their index attributes. - * Required. + * An ordered sequence of property names and their index attributes. Required. */ properties?: Schema$GoogleDatastoreAdminV1IndexedProperty[]; /** @@ -637,8 +527,7 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1IndexedProperty { /** - * The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. - * Required. + * The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. Required. */ direction?: string; /** @@ -681,13 +570,11 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1Progress { /** - * The amount of work that has been completed. Note that this may be greater - * than work_estimated. + * The amount of work that has been completed. Note that this may be greater than work_estimated. */ workCompleted?: string; /** - * An estimate of how much work needs to be performed. May be zero if the - * work estimate is unavailable. + * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ workEstimated?: string; } @@ -705,14 +592,11 @@ export namespace datastore_v1 { operations?: Schema$GoogleLongrunningOperation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -720,58 +604,36 @@ export namespace datastore_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A [GQL - * query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + * A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). */ export interface Schema$GqlQuery { /** - * When false, the query string must not contain any literals and instead - * must bind all values. For example, `SELECT * FROM Kind WHERE a = - * 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE - * a = @value` is. + * When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is. */ allowLiterals?: boolean; /** - * For each non-reserved named binding site in the query string, there must - * be a named parameter with that name, but not necessarily the inverse. Key - * must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not - * be `""`. + * For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `""`. */ namedBindings?: {[key: string]: Schema$GqlQueryParameter}; /** - * Numbered binding site @1 references the first numbered parameter, - * effectively using 1-based indexing, rather than the usual 0. For each - * binding site numbered i in `query_string`, there must be an i-th numbered - * parameter. The inverse must also be true. + * Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true. */ positionalBindings?: Schema$GqlQueryParameter[]; /** - * A string of the format described - * [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + * A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). */ queryString?: string; } @@ -789,31 +651,15 @@ export namespace datastore_v1 { value?: Schema$Value; } /** - * A unique identifier for an entity. If a key's partition ID or any of - * its path kinds or names are reserved/read-only, the key is - * reserved/read-only. A reserved/read-only key is forbidden in certain - * documented contexts. + * A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. */ export interface Schema$Key { /** - * Entities are partitioned into subsets, currently identified by a project - * ID and namespace ID. Queries are scoped to a single partition. + * Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. */ partitionId?: Schema$PartitionId; /** - * The entity path. An entity path consists of one or more elements composed - * of a kind and a string or numerical identifier, which identify entities. - * The first element identifies a _root entity_, the second element - * identifies a _child_ of the root entity, the third element identifies a - * child of the second entity, and so forth. The entities identified by all - * prefixes of the path are called the element's _ancestors_. An entity - * path is always fully complete: *all* of the entity's ancestors are - * required to be in the path along with the entity identifier itself. The - * only exception is that in some documented cases, the identifier in the - * last path element (for the entity) itself may be omitted. For example, - * the last path element of the key of `Mutation.insert` may have no - * identifier. A path can never be empty, and a path can have at most 100 - * elements. + * The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. */ path?: Schema$PathElement[]; } @@ -827,11 +673,7 @@ export namespace datastore_v1 { name?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -861,21 +703,15 @@ export namespace datastore_v1 { */ export interface Schema$LookupResponse { /** - * A list of keys that were not looked up due to resource constraints. The - * order of results in this field is undefined and has no relation to the - * order of the keys in the input. + * A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input. */ deferred?: Schema$Key[]; /** - * Entities found as `ResultType.FULL` entities. The order of results in - * this field is undefined and has no relation to the order of the keys in - * the input. + * Entities found as `ResultType.FULL` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input. */ found?: Schema$EntityResult[]; /** - * Entities not found as `ResultType.KEY_ONLY` entities. The order of - * results in this field is undefined and has no relation to the order of - * the keys in the input. + * Entities not found as `ResultType.KEY_ONLY` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input. */ missing?: Schema$EntityResult[]; } @@ -884,28 +720,23 @@ export namespace datastore_v1 { */ export interface Schema$Mutation { /** - * The version of the entity that this mutation is being applied to. If this - * does not match the current version on the server, the mutation conflicts. + * The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. */ baseVersion?: string; /** - * The key of the entity to delete. The entity may or may not already exist. - * Must have a complete key path and must not be reserved/read-only. + * The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. */ delete?: Schema$Key; /** - * The entity to insert. The entity must not already exist. The entity - * key's final path element may be incomplete. + * The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */ insert?: Schema$Entity; /** - * The entity to update. The entity must already exist. Must have a complete - * key path. + * The entity to update. The entity must already exist. Must have a complete key path. */ update?: Schema$Entity; /** - * The entity to upsert. The entity may or may not already exist. The entity - * key's final path element may be incomplete. + * The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete. */ upsert?: Schema$Entity; } @@ -914,35 +745,20 @@ export namespace datastore_v1 { */ export interface Schema$MutationResult { /** - * Whether a conflict was detected for this mutation. Always false when a - * conflict detection strategy field is not set in the mutation. + * Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation. */ conflictDetected?: boolean; /** - * The automatically allocated key. Set only when the mutation allocated a - * key. + * The automatically allocated key. Set only when the mutation allocated a key. */ key?: Schema$Key; /** - * The version of the entity on the server after processing the mutation. If - * the mutation doesn't change anything on the server, then the version - * will be the version of the current entity or, if no entity is present, a - * version that is strictly greater than the version of any previous entity - * and less than the version of any possible future entity. + * The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity. */ version?: string; } /** - * A partition ID identifies a grouping of entities. The grouping is always by - * project and namespace, however the namespace ID may be empty. A partition - * ID contains several dimensions: project ID and namespace ID. Partition - * dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must - * have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any - * dimension matches regex `__.*__`, the partition is reserved/read-only. A - * reserved/read-only partition ID is forbidden in certain documented - * contexts. Foreign partition IDs (in which the project ID does not match - * the context project ID ) are discouraged. Reads and writes of foreign - * partition IDs may fail if the project is not in an active state. + * A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. */ export interface Schema$PartitionId { /** @@ -955,26 +771,19 @@ export namespace datastore_v1 { projectId?: string; } /** - * A (kind, ID/name) pair used to construct a key path. If either name or ID - * is set, the element is complete. If neither is set, the element is - * incomplete. + * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. */ export interface Schema$PathElement { /** - * The auto-allocated ID of the entity. Never equal to zero. Values less - * than zero are discouraged and may not be supported in the future. + * The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. */ id?: string; /** - * The kind of the entity. A kind matching regex `__.*__` is - * reserved/read-only. A kind must not contain more than 1500 bytes when - * UTF-8 encoded. Cannot be `""`. + * The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ kind?: string; /** - * The name of the entity. A name matching regex `__.*__` is - * reserved/read-only. A name must not be more than 1500 bytes when UTF-8 - * encoded. Cannot be `""`. + * The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ name?: string; } @@ -1022,8 +831,7 @@ export namespace datastore_v1 { */ export interface Schema$PropertyReference { /** - * The name of the property. If name includes "."s, it may be - * interpreted as a property name path. + * The name of the property. If name includes "."s, it may be interpreted as a property name path. */ name?: string; } @@ -1032,15 +840,11 @@ export namespace datastore_v1 { */ export interface Schema$Query { /** - * The properties to make distinct. The query results will contain the first - * result for each distinct combination of values for the given properties - * (if empty, all results are returned). + * The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). */ distinctOn?: Schema$PropertyReference[]; /** - * An ending point for the query results. Query cursors are returned in - * query result batches and [can only be used to limit the same - * query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). + * An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ endCursor?: string; /** @@ -1048,19 +852,15 @@ export namespace datastore_v1 { */ filter?: Schema$Filter; /** - * The kinds to query (if empty, returns entities of all kinds). Currently - * at most 1 kind may be specified. + * The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. */ kind?: Schema$KindExpression[]; /** - * The maximum number of results to return. Applies after all other - * constraints. Optional. Unspecified is interpreted as no limit. Must be - * >= 0 if specified. + * The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. */ limit?: number; /** - * The number of results to skip. Applies before limit, but after all other - * constraints. Optional. Must be >= 0 if specified. + * The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified. */ offset?: number; /** @@ -1072,9 +872,7 @@ export namespace datastore_v1 { */ projection?: Schema$Projection[]; /** - * A starting point for the query results. Query cursors are returned in - * query result batches and [can only be used to continue the same - * query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). + * A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ startCursor?: string; } @@ -1099,8 +897,7 @@ export namespace datastore_v1 { */ moreResults?: string; /** - * A cursor that points to the position after the last skipped result. Will - * be set when `skipped_results` != 0. + * A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0. */ skippedCursor?: string; /** @@ -1108,14 +905,7 @@ export namespace datastore_v1 { */ skippedResults?: number; /** - * The version number of the snapshot this batch was returned from. This - * applies to the range of results from the query's `start_cursor` (or - * the beginning of the query if no cursor was given) to this batch's - * `end_cursor` (not the query's `end_cursor`). In a single - * transaction, subsequent query result batches for the same query can have - * a greater snapshot version number. Each batch's snapshot version is - * valid for all preceding batches. The value will be zero for eventually - * consistent queries. + * The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries. */ snapshotVersion?: string; } @@ -1128,13 +918,11 @@ export namespace datastore_v1 { */ export interface Schema$ReadOptions { /** - * The non-transactional read consistency to use. Cannot be set to `STRONG` - * for global queries. + * The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries. */ readConsistency?: string; /** - * The identifier of the transaction in which to read. A transaction - * identifier is returned by a call to Datastore.BeginTransaction. + * The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ transaction?: string; } @@ -1156,8 +944,7 @@ export namespace datastore_v1 { */ databaseId?: string; /** - * A list of keys with complete key paths whose numeric IDs should not be - * auto-allocated. + * A list of keys with complete key paths whose numeric IDs should not be auto-allocated. */ keys?: Schema$Key[]; } @@ -1170,8 +957,7 @@ export namespace datastore_v1 { */ export interface Schema$RollbackRequest { /** - * The transaction identifier, returned by a call to - * Datastore.BeginTransaction. + * The transaction identifier, returned by a call to Datastore.BeginTransaction. */ transaction?: string; } @@ -1188,9 +974,7 @@ export namespace datastore_v1 { */ gqlQuery?: Schema$GqlQuery; /** - * Entities are partitioned into subsets, identified by a partition ID. - * Queries are scoped to a single partition. This partition ID is normalized - * with the standard default context partition ID. + * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ partitionId?: Schema$PartitionId; /** @@ -1216,40 +1000,7 @@ export namespace datastore_v1 { query?: Schema$Query; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1257,21 +1008,16 @@ export namespace datastore_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Options for beginning a new transaction. Transactions can be created - * explicitly with calls to Datastore.BeginTransaction or implicitly by - * setting ReadOptions.new_transaction in read requests. + * Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. */ export interface Schema$TransactionOptions { /** @@ -1284,20 +1030,15 @@ export namespace datastore_v1 { readWrite?: Schema$ReadWrite; } /** - * A message that can hold any of the supported value types and associated - * metadata. + * A message that can hold any of the supported value types and associated metadata. */ export interface Schema$Value { /** - * An array value. Cannot contain another array value. A `Value` instance - * that sets field `array_value` must not set fields `meaning` or - * `exclude_from_indexes`. + * An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. */ arrayValue?: Schema$ArrayValue; /** - * A blob value. May have at most 1,000,000 bytes. When - * `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON - * requests, must be base64-encoded. + * A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. */ blobValue?: string; /** @@ -1309,13 +1050,11 @@ export namespace datastore_v1 { */ doubleValue?: number; /** - * An entity value. - May have no key. - May have a key with an incomplete - * key path. - May have a reserved/read-only key. + * An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. */ entityValue?: Schema$Entity; /** - * If the value should be excluded from all indexes including those defined - * explicitly. + * If the value should be excluded from all indexes including those defined explicitly. */ excludeFromIndexes?: boolean; /** @@ -1339,14 +1078,11 @@ export namespace datastore_v1 { */ nullValue?: string; /** - * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is - * indexed) , may have at most 1500 bytes. Otherwise, may be set to at least - * 1,000,000 bytes. + * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes. */ stringValue?: string; /** - * A timestamp value. When stored in the Datastore, precise only to - * microseconds; any additional precision is rounded down. + * A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. */ timestampValue?: string; } @@ -1363,8 +1099,7 @@ export namespace datastore_v1 { /** * datastore.projects.allocateIds - * @desc Allocates IDs for the given keys, which is useful for referencing - * an entity before it is inserted. + * @desc Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted. * @alias datastore.projects.allocateIds * @memberOf! () * @@ -1519,8 +1254,7 @@ export namespace datastore_v1 { /** * datastore.projects.commit - * @desc Commits a transaction, optionally creating, deleting or modifying - * some entities. + * @desc Commits a transaction, optionally creating, deleting or modifying some entities. * @alias datastore.projects.commit * @memberOf! () * @@ -1594,14 +1328,7 @@ export namespace datastore_v1 { /** * datastore.projects.export - * @desc Exports a copy of all or a subset of entities from Google Cloud - * Datastore to another storage system, such as Google Cloud Storage. Recent - * updates to entities may not be reflected in the export. The export occurs - * in the background and its progress can be monitored and managed via the - * Operation resource that is created. The output of an export may only be - * used once the associated operation is done. If an export operation is - * cancelled before completion it may leave partial data behind in Google - * Cloud Storage. + * @desc Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. * @alias datastore.projects.export * @memberOf! () * @@ -1682,11 +1409,7 @@ export namespace datastore_v1 { /** * datastore.projects.import - * @desc Imports entities into Google Cloud Datastore. Existing entities with - * the same key are overwritten. The import occurs in the background and its - * progress can be monitored and managed via the Operation resource that is - * created. If an ImportEntities operation is cancelled, it is possible that a - * subset of the data has already been imported to Cloud Datastore. + * @desc Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore. * @alias datastore.projects.import * @memberOf! () * @@ -1841,8 +1564,7 @@ export namespace datastore_v1 { /** * datastore.projects.reserveIds - * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud - * Datastore. + * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. * @alias datastore.projects.reserveIds * @memberOf! () * @@ -2305,9 +2027,7 @@ export namespace datastore_v1 { /** * datastore.projects.indexes.list - * @desc Lists the indexes that match the specified filters. Datastore uses - * an eventually consistent query to fetch the list of indexes and may - * occasionally return stale results. + * @desc Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results. * @alias datastore.projects.indexes.list * @memberOf! () * @@ -2434,8 +2154,7 @@ export namespace datastore_v1 { */ filter?: string; /** - * The maximum number of items to return. If zero, then all results will be - * returned. + * The maximum number of items to return. If zero, then all results will be returned. */ pageSize?: number; /** @@ -2456,15 +2175,7 @@ export namespace datastore_v1 { /** * datastore.projects.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias datastore.projects.operations.cancel * @memberOf! () * @@ -2533,10 +2244,7 @@ export namespace datastore_v1 { /** * datastore.projects.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias datastore.projects.operations.delete * @memberOf! () * @@ -2605,9 +2313,7 @@ export namespace datastore_v1 { /** * datastore.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias datastore.projects.operations.get * @memberOf! () * @@ -2685,15 +2391,7 @@ export namespace datastore_v1 { /** * datastore.projects.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias datastore.projects.operations.list * @memberOf! () * diff --git a/src/apis/datastore/v1beta1.ts b/src/apis/datastore/v1beta1.ts index a88d9bd6af2..c3482905651 100644 --- a/src/apis/datastore/v1beta1.ts +++ b/src/apis/datastore/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace datastore_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace datastore_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace datastore_v1beta1 { /** * Cloud Datastore API * - * Accesses the schemaless NoSQL database to provide fully managed, robust, - * scalable storage for your application. + * Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace datastore_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -128,13 +126,11 @@ export namespace datastore_v1beta1 { */ endTime?: string; /** - * The client-assigned labels which were provided when the operation was - * created. May also include additional labels. + * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ labels?: {[key: string]: string}; /** - * The type of the operation. Can be used as a filter in - * ListOperationsRequest. + * The type of the operation. Can be used as a filter in ListOperationsRequest. */ operationType?: string; /** @@ -147,16 +143,7 @@ export namespace datastore_v1beta1 { state?: string; } /** - * Identifies a subset of entities in a project. This is specified as - * combinations of kinds and namespaces (either or both of which may be all, - * as described in the following examples). Example usage: Entire project: - * kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: - * kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar - * only in the default namespace: kinds=['Foo', 'Bar'], - * namespace_ids=[''] Kinds Foo and Bar in both the default and Baz - * namespaces: kinds=['Foo', 'Bar'], - * namespace_ids=['', 'Baz'] The entire Baz namespace: - * kinds=[], namespace_ids=['Baz'] + * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] */ export interface Schema$GoogleDatastoreAdminV1beta1EntityFilter { /** @@ -164,11 +151,7 @@ export namespace datastore_v1beta1 { */ kinds?: string[]; /** - * An empty list represents all namespaces. This is the preferred usage for - * projects that don't use namespaces. An empty string element - * represents the default namespace. This should be used if the project has - * data in non-default namespaces, but doesn't want to include them. - * Each namespace in this list must be unique. + * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ namespaceIds?: string[]; } @@ -185,11 +168,7 @@ export namespace datastore_v1beta1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter; /** - * Location for the export metadata and data files. This will be the same - * value as the - * google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix - * field. The final output location is provided in - * google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. */ outputUrlPrefix?: string; /** @@ -202,8 +181,7 @@ export namespace datastore_v1beta1 { progressEntities?: Schema$GoogleDatastoreAdminV1beta1Progress; } /** - * The request for - * google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + * The request for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. */ export interface Schema$GoogleDatastoreAdminV1beta1ExportEntitiesRequest { /** @@ -215,33 +193,16 @@ export namespace datastore_v1beta1 { */ labels?: {[key: string]: string}; /** - * Location for the export metadata and data files. The full resource URL - * of the external storage location. Currently, only Google Cloud Storage is - * supported. So output_url_prefix should be of the form: - * `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of - * the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud - * Storage namespace path (this is not a Cloud Datastore namespace). For - * more information about Cloud Storage namespace paths, see [Object name - * considerations](https://cloud.google.com/storage/docs/naming#object-considerations). - * The resulting files will be nested deeper than the specified URL prefix. - * The final output URL will be provided in the - * google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. - * That value should be used for subsequent ImportEntities operations. By - * nesting the data files deeper, the same Cloud Storage bucket can be used - * in multiple ExportEntities operations without conflict. + * Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict. */ outputUrlPrefix?: string; } /** - * The response for - * google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + * The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. */ export interface Schema$GoogleDatastoreAdminV1beta1ExportEntitiesResponse { /** - * Location of the output metadata file. This can be used to begin an import - * into Cloud Datastore (this project or another project). See - * google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only - * present if the operation completed successfully. + * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ outputUrl?: string; } @@ -258,9 +219,7 @@ export namespace datastore_v1beta1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter; /** - * The location of the import metadata file. This will be the same value as - * the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url - * field. + * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. */ inputUrl?: string; /** @@ -273,29 +232,15 @@ export namespace datastore_v1beta1 { progressEntities?: Schema$GoogleDatastoreAdminV1beta1Progress; } /** - * The request for - * google.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities. + * The request for google.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities. */ export interface Schema$GoogleDatastoreAdminV1beta1ImportEntitiesRequest { /** - * Optionally specify which kinds/namespaces are to be imported. If - * provided, the list must be a subset of the EntityFilter used in creating - * the export, otherwise a FAILED_PRECONDITION error will be returned. If no - * filter is specified then all entities from the export are imported. + * Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported. */ entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter; /** - * The full resource URL of the external storage location. Currently, only - * Google Cloud Storage is supported. So input_url should be of the form: - * `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where - * `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` - * is an optional Cloud Storage namespace path (this is not a Cloud - * Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata - * file written by the ExportEntities operation. For more information about - * Cloud Storage namespace paths, see [Object name - * considerations](https://cloud.google.com/storage/docs/naming#object-considerations). - * For more information, see - * google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + * The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). For more information, see google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. */ inputUrl?: string; /** @@ -308,13 +253,11 @@ export namespace datastore_v1beta1 { */ export interface Schema$GoogleDatastoreAdminV1beta1Progress { /** - * The amount of work that has been completed. Note that this may be greater - * than work_estimated. + * The amount of work that has been completed. Note that this may be greater than work_estimated. */ workCompleted?: string; /** - * An estimate of how much work needs to be performed. May be zero if the - * work estimate is unavailable. + * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ workEstimated?: string; } @@ -327,13 +270,11 @@ export namespace datastore_v1beta1 { */ endTime?: string; /** - * The client-assigned labels which were provided when the operation was - * created. May also include additional labels. + * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ labels?: {[key: string]: string}; /** - * The type of the operation. Can be used as a filter in - * ListOperationsRequest. + * The type of the operation. Can be used as a filter in ListOperationsRequest. */ operationType?: string; /** @@ -346,16 +287,7 @@ export namespace datastore_v1beta1 { state?: string; } /** - * Identifies a subset of entities in a project. This is specified as - * combinations of kinds and namespaces (either or both of which may be all, - * as described in the following examples). Example usage: Entire project: - * kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: - * kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar - * only in the default namespace: kinds=['Foo', 'Bar'], - * namespace_ids=[''] Kinds Foo and Bar in both the default and Baz - * namespaces: kinds=['Foo', 'Bar'], - * namespace_ids=['', 'Baz'] The entire Baz namespace: - * kinds=[], namespace_ids=['Baz'] + * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] */ export interface Schema$GoogleDatastoreAdminV1EntityFilter { /** @@ -363,11 +295,7 @@ export namespace datastore_v1beta1 { */ kinds?: string[]; /** - * An empty list represents all namespaces. This is the preferred usage for - * projects that don't use namespaces. An empty string element - * represents the default namespace. This should be used if the project has - * data in non-default namespaces, but doesn't want to include them. - * Each namespace in this list must be unique. + * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ namespaceIds?: string[]; } @@ -384,11 +312,7 @@ export namespace datastore_v1beta1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * Location for the export metadata and data files. This will be the same - * value as the - * google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. - * The final output location is provided in - * google.datastore.admin.v1.ExportEntitiesResponse.output_url. + * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ outputUrlPrefix?: string; /** @@ -405,10 +329,7 @@ export namespace datastore_v1beta1 { */ export interface Schema$GoogleDatastoreAdminV1ExportEntitiesResponse { /** - * Location of the output metadata file. This can be used to begin an import - * into Cloud Datastore (this project or another project). See - * google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present - * if the operation completed successfully. + * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ outputUrl?: string; } @@ -425,8 +346,7 @@ export namespace datastore_v1beta1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * The location of the import metadata file. This will be the same value as - * the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. + * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. */ inputUrl?: string; /** @@ -460,25 +380,20 @@ export namespace datastore_v1beta1 { */ export interface Schema$GoogleDatastoreAdminV1Progress { /** - * The amount of work that has been completed. Note that this may be greater - * than work_estimated. + * The amount of work that has been completed. Note that this may be greater than work_estimated. */ workCompleted?: string; /** - * An estimate of how much work needs to be performed. May be zero if the - * work estimate is unavailable. + * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ workEstimated?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -486,64 +401,20 @@ export namespace datastore_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -551,14 +422,11 @@ export namespace datastore_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -571,14 +439,7 @@ export namespace datastore_v1beta1 { /** * datastore.projects.export - * @desc Exports a copy of all or a subset of entities from Google Cloud - * Datastore to another storage system, such as Google Cloud Storage. Recent - * updates to entities may not be reflected in the export. The export occurs - * in the background and its progress can be monitored and managed via the - * Operation resource that is created. The output of an export may only be - * used once the associated operation is done. If an export operation is - * cancelled before completion it may leave partial data behind in Google - * Cloud Storage. + * @desc Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. * @alias datastore.projects.export * @memberOf! () * @@ -659,11 +520,7 @@ export namespace datastore_v1beta1 { /** * datastore.projects.import - * @desc Imports entities into Google Cloud Datastore. Existing entities with - * the same key are overwritten. The import occurs in the background and its - * progress can be monitored and managed via the Operation resource that is - * created. If an ImportEntities operation is cancelled, it is possible that a - * subset of the data has already been imported to Cloud Datastore. + * @desc Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore. * @alias datastore.projects.import * @memberOf! () * diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index 576046b1956..0a1fe2beee7 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace datastore_v1beta3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace datastore_v1beta3 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace datastore_v1beta3 { /** * Cloud Datastore API * - * Accesses the schemaless NoSQL database to provide fully managed, robust, - * scalable storage for your application. + * Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace datastore_v1beta3 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,8 +122,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$AllocateIdsRequest { /** - * A list of keys with incomplete key paths for which to allocate IDs. No - * key may be reserved/read-only. + * A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only. */ keys?: Schema$Key[]; } @@ -134,8 +131,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$AllocateIdsResponse { /** - * The keys specified in the request (in the same order), each with its key - * path completed with a newly allocated ID. + * The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID. */ keys?: Schema$Key[]; } @@ -144,8 +140,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$ArrayValue { /** - * Values in the array. The order of values in an array is preserved as long - * as all values have identical settings for 'exclude_from_indexes'. + * Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. */ values?: Schema$Value[]; } @@ -176,19 +171,11 @@ export namespace datastore_v1beta3 { */ mode?: string; /** - * The mutations to perform. When mode is `TRANSACTIONAL`, mutations - * affecting a single entity are applied in order. The following sequences - * of mutations affecting a single entity are not permitted in a single - * `Commit` request: - `insert` followed by `insert` - `update` followed by - * `insert` - `upsert` followed by `insert` - `delete` followed by `update` - * When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single - * entity. + * The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity. */ mutations?: Schema$Mutation[]; /** - * The identifier of the transaction associated with the commit. A - * transaction identifier is returned by a call to - * Datastore.BeginTransaction. + * The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ transaction?: string; } @@ -197,13 +184,11 @@ export namespace datastore_v1beta3 { */ export interface Schema$CommitResponse { /** - * The number of index entries updated during the commit, or zero if none - * were updated. + * The number of index entries updated during the commit, or zero if none were updated. */ indexUpdates?: number; /** - * The result of performing the mutations. The i-th mutation result - * corresponds to the i-th mutation in the request. + * The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request. */ mutationResults?: Schema$MutationResult[]; } @@ -221,23 +206,15 @@ export namespace datastore_v1beta3 { op?: string; } /** - * A Datastore data object. An entity is limited to 1 megabyte when stored. - * That _roughly_ corresponds to a limit of 1 megabyte for the serialized form - * of this message. + * A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. */ export interface Schema$Entity { /** - * The entity's key. An entity must have a key, unless otherwise - * documented (for example, an entity in `Value.entity_value` may have no - * key). An entity's kind is its key path's last element's kind, - * or null if it has no key. + * The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. */ key?: Schema$Key; /** - * The entity's properties. The map's keys are property names. A - * property name matching regex `__.*__` is reserved. A reserved property - * name is forbidden in certain documented contexts. The name must not - * contain more than 500 characters. The name cannot be `""`. + * The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. */ properties?: {[key: string]: Schema$Value}; } @@ -246,8 +223,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$EntityResult { /** - * A cursor that points to the position after the result entity. Set only - * when the `EntityResult` is part of a `QueryResultBatch` message. + * A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message. */ cursor?: string; /** @@ -255,11 +231,7 @@ export namespace datastore_v1beta3 { */ entity?: Schema$Entity; /** - * The version of the entity, a strictly positive number that monotonically - * increases with changes to the entity. This field is set for `FULL` - * entity results. For missing entities in `LookupResponse`, this is the - * version of the snapshot that was used to look up the entity, and it is - * always set except for eventually consistent reads. + * The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. */ version?: string; } @@ -285,13 +257,11 @@ export namespace datastore_v1beta3 { */ endTime?: string; /** - * The client-assigned labels which were provided when the operation was - * created. May also include additional labels. + * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ labels?: {[key: string]: string}; /** - * The type of the operation. Can be used as a filter in - * ListOperationsRequest. + * The type of the operation. Can be used as a filter in ListOperationsRequest. */ operationType?: string; /** @@ -304,16 +274,7 @@ export namespace datastore_v1beta3 { state?: string; } /** - * Identifies a subset of entities in a project. This is specified as - * combinations of kinds and namespaces (either or both of which may be all, - * as described in the following examples). Example usage: Entire project: - * kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: - * kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar - * only in the default namespace: kinds=['Foo', 'Bar'], - * namespace_ids=[''] Kinds Foo and Bar in both the default and Baz - * namespaces: kinds=['Foo', 'Bar'], - * namespace_ids=['', 'Baz'] The entire Baz namespace: - * kinds=[], namespace_ids=['Baz'] + * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] */ export interface Schema$GoogleDatastoreAdminV1beta1EntityFilter { /** @@ -321,11 +282,7 @@ export namespace datastore_v1beta3 { */ kinds?: string[]; /** - * An empty list represents all namespaces. This is the preferred usage for - * projects that don't use namespaces. An empty string element - * represents the default namespace. This should be used if the project has - * data in non-default namespaces, but doesn't want to include them. - * Each namespace in this list must be unique. + * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ namespaceIds?: string[]; } @@ -342,11 +299,7 @@ export namespace datastore_v1beta3 { */ entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter; /** - * Location for the export metadata and data files. This will be the same - * value as the - * google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix - * field. The final output location is provided in - * google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. */ outputUrlPrefix?: string; /** @@ -359,15 +312,11 @@ export namespace datastore_v1beta3 { progressEntities?: Schema$GoogleDatastoreAdminV1beta1Progress; } /** - * The response for - * google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + * The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. */ export interface Schema$GoogleDatastoreAdminV1beta1ExportEntitiesResponse { /** - * Location of the output metadata file. This can be used to begin an import - * into Cloud Datastore (this project or another project). See - * google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only - * present if the operation completed successfully. + * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ outputUrl?: string; } @@ -384,9 +333,7 @@ export namespace datastore_v1beta3 { */ entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter; /** - * The location of the import metadata file. This will be the same value as - * the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url - * field. + * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. */ inputUrl?: string; /** @@ -403,13 +350,11 @@ export namespace datastore_v1beta3 { */ export interface Schema$GoogleDatastoreAdminV1beta1Progress { /** - * The amount of work that has been completed. Note that this may be greater - * than work_estimated. + * The amount of work that has been completed. Note that this may be greater than work_estimated. */ workCompleted?: string; /** - * An estimate of how much work needs to be performed. May be zero if the - * work estimate is unavailable. + * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ workEstimated?: string; } @@ -422,13 +367,11 @@ export namespace datastore_v1beta3 { */ endTime?: string; /** - * The client-assigned labels which were provided when the operation was - * created. May also include additional labels. + * The client-assigned labels which were provided when the operation was created. May also include additional labels. */ labels?: {[key: string]: string}; /** - * The type of the operation. Can be used as a filter in - * ListOperationsRequest. + * The type of the operation. Can be used as a filter in ListOperationsRequest. */ operationType?: string; /** @@ -441,16 +384,7 @@ export namespace datastore_v1beta3 { state?: string; } /** - * Identifies a subset of entities in a project. This is specified as - * combinations of kinds and namespaces (either or both of which may be all, - * as described in the following examples). Example usage: Entire project: - * kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: - * kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar - * only in the default namespace: kinds=['Foo', 'Bar'], - * namespace_ids=[''] Kinds Foo and Bar in both the default and Baz - * namespaces: kinds=['Foo', 'Bar'], - * namespace_ids=['', 'Baz'] The entire Baz namespace: - * kinds=[], namespace_ids=['Baz'] + * Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz'] */ export interface Schema$GoogleDatastoreAdminV1EntityFilter { /** @@ -458,11 +392,7 @@ export namespace datastore_v1beta3 { */ kinds?: string[]; /** - * An empty list represents all namespaces. This is the preferred usage for - * projects that don't use namespaces. An empty string element - * represents the default namespace. This should be used if the project has - * data in non-default namespaces, but doesn't want to include them. - * Each namespace in this list must be unique. + * An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */ namespaceIds?: string[]; } @@ -479,11 +409,7 @@ export namespace datastore_v1beta3 { */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * Location for the export metadata and data files. This will be the same - * value as the - * google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. - * The final output location is provided in - * google.datastore.admin.v1.ExportEntitiesResponse.output_url. + * Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ outputUrlPrefix?: string; /** @@ -500,10 +426,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$GoogleDatastoreAdminV1ExportEntitiesResponse { /** - * Location of the output metadata file. This can be used to begin an import - * into Cloud Datastore (this project or another project). See - * google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present - * if the operation completed successfully. + * Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. */ outputUrl?: string; } @@ -520,8 +443,7 @@ export namespace datastore_v1beta3 { */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * The location of the import metadata file. This will be the same value as - * the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. + * The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. */ inputUrl?: string; /** @@ -555,45 +477,32 @@ export namespace datastore_v1beta3 { */ export interface Schema$GoogleDatastoreAdminV1Progress { /** - * The amount of work that has been completed. Note that this may be greater - * than work_estimated. + * The amount of work that has been completed. Note that this may be greater than work_estimated. */ workCompleted?: string; /** - * An estimate of how much work needs to be performed. May be zero if the - * work estimate is unavailable. + * An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable. */ workEstimated?: string; } /** - * A [GQL - * query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + * A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). */ export interface Schema$GqlQuery { /** - * When false, the query string must not contain any literals and instead - * must bind all values. For example, `SELECT * FROM Kind WHERE a = - * 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE - * a = @value` is. + * When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is. */ allowLiterals?: boolean; /** - * For each non-reserved named binding site in the query string, there must - * be a named parameter with that name, but not necessarily the inverse. Key - * must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not - * be `""`. + * For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `""`. */ namedBindings?: {[key: string]: Schema$GqlQueryParameter}; /** - * Numbered binding site @1 references the first numbered parameter, - * effectively using 1-based indexing, rather than the usual 0. For each - * binding site numbered i in `query_string`, there must be an i-th numbered - * parameter. The inverse must also be true. + * Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true. */ positionalBindings?: Schema$GqlQueryParameter[]; /** - * A string of the format described - * [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + * A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). */ queryString?: string; } @@ -611,31 +520,15 @@ export namespace datastore_v1beta3 { value?: Schema$Value; } /** - * A unique identifier for an entity. If a key's partition ID or any of - * its path kinds or names are reserved/read-only, the key is - * reserved/read-only. A reserved/read-only key is forbidden in certain - * documented contexts. + * A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. */ export interface Schema$Key { /** - * Entities are partitioned into subsets, currently identified by a project - * ID and namespace ID. Queries are scoped to a single partition. + * Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. */ partitionId?: Schema$PartitionId; /** - * The entity path. An entity path consists of one or more elements composed - * of a kind and a string or numerical identifier, which identify entities. - * The first element identifies a _root entity_, the second element - * identifies a _child_ of the root entity, the third element identifies a - * child of the second entity, and so forth. The entities identified by all - * prefixes of the path are called the element's _ancestors_. An entity - * path is always fully complete: *all* of the entity's ancestors are - * required to be in the path along with the entity identifier itself. The - * only exception is that in some documented cases, the identifier in the - * last path element (for the entity) itself may be omitted. For example, - * the last path element of the key of `Mutation.insert` may have no - * identifier. A path can never be empty, and a path can have at most 100 - * elements. + * The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. */ path?: Schema$PathElement[]; } @@ -649,11 +542,7 @@ export namespace datastore_v1beta3 { name?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -683,21 +572,15 @@ export namespace datastore_v1beta3 { */ export interface Schema$LookupResponse { /** - * A list of keys that were not looked up due to resource constraints. The - * order of results in this field is undefined and has no relation to the - * order of the keys in the input. + * A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input. */ deferred?: Schema$Key[]; /** - * Entities found as `ResultType.FULL` entities. The order of results in - * this field is undefined and has no relation to the order of the keys in - * the input. + * Entities found as `ResultType.FULL` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input. */ found?: Schema$EntityResult[]; /** - * Entities not found as `ResultType.KEY_ONLY` entities. The order of - * results in this field is undefined and has no relation to the order of - * the keys in the input. + * Entities not found as `ResultType.KEY_ONLY` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input. */ missing?: Schema$EntityResult[]; } @@ -706,28 +589,23 @@ export namespace datastore_v1beta3 { */ export interface Schema$Mutation { /** - * The version of the entity that this mutation is being applied to. If this - * does not match the current version on the server, the mutation conflicts. + * The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. */ baseVersion?: string; /** - * The key of the entity to delete. The entity may or may not already exist. - * Must have a complete key path and must not be reserved/read-only. + * The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. */ delete?: Schema$Key; /** - * The entity to insert. The entity must not already exist. The entity - * key's final path element may be incomplete. + * The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */ insert?: Schema$Entity; /** - * The entity to update. The entity must already exist. Must have a complete - * key path. + * The entity to update. The entity must already exist. Must have a complete key path. */ update?: Schema$Entity; /** - * The entity to upsert. The entity may or may not already exist. The entity - * key's final path element may be incomplete. + * The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete. */ upsert?: Schema$Entity; } @@ -736,35 +614,20 @@ export namespace datastore_v1beta3 { */ export interface Schema$MutationResult { /** - * Whether a conflict was detected for this mutation. Always false when a - * conflict detection strategy field is not set in the mutation. + * Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation. */ conflictDetected?: boolean; /** - * The automatically allocated key. Set only when the mutation allocated a - * key. + * The automatically allocated key. Set only when the mutation allocated a key. */ key?: Schema$Key; /** - * The version of the entity on the server after processing the mutation. If - * the mutation doesn't change anything on the server, then the version - * will be the version of the current entity or, if no entity is present, a - * version that is strictly greater than the version of any previous entity - * and less than the version of any possible future entity. + * The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity. */ version?: string; } /** - * A partition ID identifies a grouping of entities. The grouping is always by - * project and namespace, however the namespace ID may be empty. A partition - * ID contains several dimensions: project ID and namespace ID. Partition - * dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must - * have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any - * dimension matches regex `__.*__`, the partition is reserved/read-only. A - * reserved/read-only partition ID is forbidden in certain documented - * contexts. Foreign partition IDs (in which the project ID does not match - * the context project ID ) are discouraged. Reads and writes of foreign - * partition IDs may fail if the project is not in an active state. + * A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. */ export interface Schema$PartitionId { /** @@ -777,26 +640,19 @@ export namespace datastore_v1beta3 { projectId?: string; } /** - * A (kind, ID/name) pair used to construct a key path. If either name or ID - * is set, the element is complete. If neither is set, the element is - * incomplete. + * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. */ export interface Schema$PathElement { /** - * The auto-allocated ID of the entity. Never equal to zero. Values less - * than zero are discouraged and may not be supported in the future. + * The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. */ id?: string; /** - * The kind of the entity. A kind matching regex `__.*__` is - * reserved/read-only. A kind must not contain more than 1500 bytes when - * UTF-8 encoded. Cannot be `""`. + * The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ kind?: string; /** - * The name of the entity. A name matching regex `__.*__` is - * reserved/read-only. A name must not be more than 1500 bytes when UTF-8 - * encoded. Cannot be `""`. + * The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ name?: string; } @@ -844,8 +700,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$PropertyReference { /** - * The name of the property. If name includes "."s, it may be - * interpreted as a property name path. + * The name of the property. If name includes "."s, it may be interpreted as a property name path. */ name?: string; } @@ -854,15 +709,11 @@ export namespace datastore_v1beta3 { */ export interface Schema$Query { /** - * The properties to make distinct. The query results will contain the first - * result for each distinct combination of values for the given properties - * (if empty, all results are returned). + * The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). */ distinctOn?: Schema$PropertyReference[]; /** - * An ending point for the query results. Query cursors are returned in - * query result batches and [can only be used to limit the same - * query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). + * An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ endCursor?: string; /** @@ -870,19 +721,15 @@ export namespace datastore_v1beta3 { */ filter?: Schema$Filter; /** - * The kinds to query (if empty, returns entities of all kinds). Currently - * at most 1 kind may be specified. + * The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. */ kind?: Schema$KindExpression[]; /** - * The maximum number of results to return. Applies after all other - * constraints. Optional. Unspecified is interpreted as no limit. Must be - * >= 0 if specified. + * The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. */ limit?: number; /** - * The number of results to skip. Applies before limit, but after all other - * constraints. Optional. Must be >= 0 if specified. + * The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified. */ offset?: number; /** @@ -894,9 +741,7 @@ export namespace datastore_v1beta3 { */ projection?: Schema$Projection[]; /** - * A starting point for the query results. Query cursors are returned in - * query result batches and [can only be used to continue the same - * query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). + * A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */ startCursor?: string; } @@ -921,8 +766,7 @@ export namespace datastore_v1beta3 { */ moreResults?: string; /** - * A cursor that points to the position after the last skipped result. Will - * be set when `skipped_results` != 0. + * A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0. */ skippedCursor?: string; /** @@ -930,14 +774,7 @@ export namespace datastore_v1beta3 { */ skippedResults?: number; /** - * The version number of the snapshot this batch was returned from. This - * applies to the range of results from the query's `start_cursor` (or - * the beginning of the query if no cursor was given) to this batch's - * `end_cursor` (not the query's `end_cursor`). In a single - * transaction, subsequent query result batches for the same query can have - * a greater snapshot version number. Each batch's snapshot version is - * valid for all preceding batches. The value will be zero for eventually - * consistent queries. + * The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries. */ snapshotVersion?: string; } @@ -950,13 +787,11 @@ export namespace datastore_v1beta3 { */ export interface Schema$ReadOptions { /** - * The non-transactional read consistency to use. Cannot be set to `STRONG` - * for global queries. + * The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries. */ readConsistency?: string; /** - * The identifier of the transaction in which to read. A transaction - * identifier is returned by a call to Datastore.BeginTransaction. + * The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. */ transaction?: string; } @@ -978,8 +813,7 @@ export namespace datastore_v1beta3 { */ databaseId?: string; /** - * A list of keys with complete key paths whose numeric IDs should not be - * auto-allocated. + * A list of keys with complete key paths whose numeric IDs should not be auto-allocated. */ keys?: Schema$Key[]; } @@ -992,8 +826,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$RollbackRequest { /** - * The transaction identifier, returned by a call to - * Datastore.BeginTransaction. + * The transaction identifier, returned by a call to Datastore.BeginTransaction. */ transaction?: string; } @@ -1010,9 +843,7 @@ export namespace datastore_v1beta3 { */ gqlQuery?: Schema$GqlQuery; /** - * Entities are partitioned into subsets, identified by a partition ID. - * Queries are scoped to a single partition. This partition ID is normalized - * with the standard default context partition ID. + * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ partitionId?: Schema$PartitionId; /** @@ -1038,9 +869,7 @@ export namespace datastore_v1beta3 { query?: Schema$Query; } /** - * Options for beginning a new transaction. Transactions can be created - * explicitly with calls to Datastore.BeginTransaction or implicitly by - * setting ReadOptions.new_transaction in read requests. + * Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. */ export interface Schema$TransactionOptions { /** @@ -1053,20 +882,15 @@ export namespace datastore_v1beta3 { readWrite?: Schema$ReadWrite; } /** - * A message that can hold any of the supported value types and associated - * metadata. + * A message that can hold any of the supported value types and associated metadata. */ export interface Schema$Value { /** - * An array value. Cannot contain another array value. A `Value` instance - * that sets field `array_value` must not set fields `meaning` or - * `exclude_from_indexes`. + * An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. */ arrayValue?: Schema$ArrayValue; /** - * A blob value. May have at most 1,000,000 bytes. When - * `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON - * requests, must be base64-encoded. + * A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. */ blobValue?: string; /** @@ -1078,13 +902,11 @@ export namespace datastore_v1beta3 { */ doubleValue?: number; /** - * An entity value. - May have no key. - May have a key with an incomplete - * key path. - May have a reserved/read-only key. + * An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. */ entityValue?: Schema$Entity; /** - * If the value should be excluded from all indexes including those defined - * explicitly. + * If the value should be excluded from all indexes including those defined explicitly. */ excludeFromIndexes?: boolean; /** @@ -1108,14 +930,11 @@ export namespace datastore_v1beta3 { */ nullValue?: string; /** - * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is - * indexed) , may have at most 1500 bytes. Otherwise, may be set to at least - * 1,000,000 bytes. + * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes. */ stringValue?: string; /** - * A timestamp value. When stored in the Datastore, precise only to - * microseconds; any additional precision is rounded down. + * A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. */ timestampValue?: string; } @@ -1128,8 +947,7 @@ export namespace datastore_v1beta3 { /** * datastore.projects.allocateIds - * @desc Allocates IDs for the given keys, which is useful for referencing - * an entity before it is inserted. + * @desc Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted. * @alias datastore.projects.allocateIds * @memberOf! () * @@ -1283,8 +1101,7 @@ export namespace datastore_v1beta3 { /** * datastore.projects.commit - * @desc Commits a transaction, optionally creating, deleting or modifying - * some entities. + * @desc Commits a transaction, optionally creating, deleting or modifying some entities. * @alias datastore.projects.commit * @memberOf! () * @@ -1432,8 +1249,7 @@ export namespace datastore_v1beta3 { /** * datastore.projects.reserveIds - * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud - * Datastore. + * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. * @alias datastore.projects.reserveIds * @memberOf! () * diff --git a/src/apis/deploymentmanager/alpha.ts b/src/apis/deploymentmanager/alpha.ts index d758ba9ed24..86dea763525 100644 --- a/src/apis/deploymentmanager/alpha.ts +++ b/src/apis/deploymentmanager/alpha.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace deploymentmanager_alpha { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace deploymentmanager_alpha { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace deploymentmanager_alpha { /** * Google Cloud Deployment Manager Alpha API * - * The Deployment Manager API allows users to declaratively configure, deploy - * and run complex solutions on the Google Cloud Platform. + * The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform. * * @example * const {google} = require('googleapis'); @@ -102,7 +98,10 @@ export namespace deploymentmanager_alpha { types: Resource$Types; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.compositeTypes = new Resource$Compositetypes(this.context); this.deployments = new Resource$Deployments(this.context); @@ -123,33 +122,12 @@ export namespace deploymentmanager_alpha { */ methodMatch?: string; /** - * Deployment manager will poll instances for this API resource setting a - * RUNNING state, and blocking until polling conditions tell whether the - * resource is completed or failed. + * Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. */ pollingOptions?: Schema$PollingOptions; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { "log_type": - * "ADMIN_READ", } ] }, { "service": - * "fooservice.googleapis.com" "audit_log_configs": [ { - * "log_type": "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy - * enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - * foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE - * logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -158,25 +136,16 @@ export namespace deploymentmanager_alpha { auditLogConfigs?: Schema$AuditLogConfig[]; exemptedMembers?: string[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { "log_type": - * "DATA_WRITE", } ] } This enables 'DATA_READ' and - * 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ - * logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of [Binding.members][]. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[]; /** @@ -205,37 +174,20 @@ export namespace deploymentmanager_alpha { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or without - * a Google account. * `allAuthenticatedUsers`: A special identifier that - * represents anyone who is authenticated with a Google account or a service - * account. * `user:{emailid}`: An email address that represents a specific - * Google account. For example, `alice@gmail.com` . * - * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: A Google Apps - * domain name that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * CollectionOverride allows resource handling overrides for specific - * resources within a BaseType + * CollectionOverride allows resource handling overrides for specific resources within a BaseType */ export interface Schema$CollectionOverride { /** @@ -256,8 +208,7 @@ export namespace deploymentmanager_alpha { */ export interface Schema$CompositeType { /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; id?: string; @@ -266,22 +217,15 @@ export namespace deploymentmanager_alpha { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$CompositeTypeLabelEntry[]; /** - * Name of the composite type, must follow the expression: - * [a-z]([-a-z0-9_.]{0,61}[a-z0-9])?. + * Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]{0,61}[a-z0-9])?. */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this composite type. + * Output only. The Operation that most recently ran, or is currently running, on this composite type. */ operation?: Schema$Operation; /** @@ -303,8 +247,7 @@ export namespace deploymentmanager_alpha { */ export interface Schema$CompositeTypesListResponse { /** - * Output only. A list of resource composite types supported by Deployment - * Manager. + * Output only. A list of resource composite types supported by Deployment Manager. */ compositeTypes?: Schema$CompositeType[]; /** @@ -329,8 +272,7 @@ export namespace deploymentmanager_alpha { */ svc?: string; /** - * Trusted attributes supplied by any service that owns resources and uses - * the IAM system for access control. + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ sys?: string; /** @@ -338,8 +280,7 @@ export namespace deploymentmanager_alpha { */ value?: string; /** - * The objects of the condition. This is mutually exclusive with - * 'value'. + * The objects of the condition. This is mutually exclusive with 'value'. */ values?: string[]; } @@ -371,8 +312,7 @@ export namespace deploymentmanager_alpha { options?: Schema$Options; } /** - * The credential used by Deployment Manager and TypeProvider. Only one of the - * options is permitted. + * The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. */ export interface Schema$Credential { /** @@ -384,8 +324,7 @@ export namespace deploymentmanager_alpha { */ serviceAccount?: Schema$ServiceAccount; /** - * Specify to use the project default credential, only supported by - * Deployment. + * Specify to use the project default credential, only supported by Deployment. */ useProjectDefault?: boolean; } @@ -399,14 +338,7 @@ export namespace deploymentmanager_alpha { */ description?: string; /** - * Provides a fingerprint to use in requests to modify a deployment, such as - * update(), stop(), and cancelPreview() requests. A fingerprint is a - * randomly generated value that must be provided with update(), stop(), and - * cancelPreview() requests to perform optimistic locking. This ensures - * optimistic concurrency so that only one request happens at a time. The - * fingerprint is initially generated by Deployment Manager and changes - * after every request to modify data. To get the latest fingerprint value, - * perform a get() request to a deployment. + * Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. */ fingerprint?: string; id?: string; @@ -415,37 +347,23 @@ export namespace deploymentmanager_alpha { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$DeploymentLabelEntry[]; /** - * Output only. URL of the manifest representing the last manifest that was - * successfully deployed. + * Output only. URL of the manifest representing the last manifest that was successfully deployed. */ manifest?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this deployment. + * Output only. The Operation that most recently ran, or is currently running, on this deployment. */ operation?: Schema$Operation; /** - * Output only. Map of outputs from the last manifest that deployed - * successfully. + * Output only. Map of outputs from the last manifest that deployed successfully. */ outputs?: Schema$DeploymentOutputsEntry[]; /** @@ -453,13 +371,11 @@ export namespace deploymentmanager_alpha { */ selfLink?: string; /** - * [Input Only] The parameters that define your deployment, including the - * deployment configuration and relevant templates. + * [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. */ target?: Schema$TargetConfiguration; /** - * Output only. If Deployment Manager is currently updating or previewing an - * update to this deployment, the updated configuration appears here. + * Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. */ update?: Schema$DeploymentUpdate; /** @@ -477,21 +393,12 @@ export namespace deploymentmanager_alpha { } export interface Schema$DeploymentsCancelPreviewRequest { /** - * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a - * randomly generated value that must be provided in cancelPreview() - * requests to perform optimistic locking. This ensures optimistic - * concurrency so that the deployment does not have conflicting requests - * (e.g. if someone attempts to make a new update request while another user - * attempts to cancel a preview, this would prevent one of the requests). - * The fingerprint is initially generated by Deployment Manager and changes - * after every request to modify a deployment. To get the latest fingerprint - * value, perform a get() request on the deployment. + * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ fingerprint?: string; } /** - * A response containing a partial list of deployments and a page token used - * to build the next request if the request has been truncated. + * A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. */ export interface Schema$DeploymentsListResponse { /** @@ -505,41 +412,25 @@ export namespace deploymentmanager_alpha { } export interface Schema$DeploymentsStopRequest { /** - * Specifies a fingerprint for stop() requests. A fingerprint is a randomly - * generated value that must be provided in stop() requests to perform - * optimistic locking. This ensures optimistic concurrency so that the - * deployment does not have conflicting requests (e.g. if someone attempts - * to make a new update request while another user attempts to stop an - * ongoing update request, this would prevent a collision). The fingerprint - * is initially generated by Deployment Manager and changes after every - * request to modify a deployment. To get the latest fingerprint value, - * perform a get() request on the deployment. + * Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ fingerprint?: string; } export interface Schema$DeploymentUpdate { /** - * Output only. The user-provided default credential to use when deploying - * this preview. + * Output only. The user-provided default credential to use when deploying this preview. */ credential?: Schema$Credential; /** - * Output only. An optional user-provided description of the deployment - * after the current update has been applied. + * Output only. An optional user-provided description of the deployment after the current update has been applied. */ description?: string; /** - * Output only. Map of labels; provided by the client when the resource is - * created or updated. Specifically: Label keys must be between 1 and 63 - * characters long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$DeploymentUpdateLabelEntry[]; /** - * Output only. URL of the manifest representing the update configuration of - * this deployment. + * Output only. URL of the manifest representing the update configuration of this deployment. */ manifest?: string; } @@ -549,8 +440,7 @@ export namespace deploymentmanager_alpha { } export interface Schema$Diagnostic { /** - * JsonPath expression on the resource that if non empty, indicates that - * this field needs to be extracted as a diagnostic. + * JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. */ field?: string; /** @@ -559,50 +449,37 @@ export namespace deploymentmanager_alpha { level?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } export interface Schema$GlobalSetPolicyRequest { /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -617,8 +494,7 @@ export namespace deploymentmanager_alpha { name?: string; } /** - * InputMapping creates a 'virtual' property that will be injected - * into the properties before sending the request to the underlying API. + * InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. */ export interface Schema$InputMapping { /** @@ -669,22 +545,7 @@ export namespace deploymentmanager_alpha { logName?: string; } /** - * Increment a streamz counter with the specified metric and field names. - * Metric names should start with a '/', generally be lowercase-only, - * and end in "_count". Field names should not contain an initial - * slash. The actual exported metric names will have "/iam/policy" - * prepended. Field names correspond to IAM request parameters and field - * values are their respective values. Supported field names: - - * "authority", which is "[token]" if IAMContext.token is - * present, otherwise the value of IAMContext.authority_selector if present, - * and otherwise a representation of IAMContext.principal; or - - * "iam_principal", a representation of IAMContext.principal even if - * a token or authority selector is present; or - "" (empty string), - * resulting in a counter with no fields. Examples: counter { metric: - * "/debug_access_count" field: "iam_principal" } ==> - * increment counter /iam/policy/backend_debug_access_count - * {iam_principal=[value of IAMContext.principal]} At this time we do not - * support multiple field names (though this may be supported in the future). + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). */ export interface Schema$LogConfigCounterOptions { /** @@ -701,12 +562,7 @@ export namespace deploymentmanager_alpha { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. NOTE: - * Logging to Gin in a fail-closed manner is currently unsupported while - * work is being done to satisfy the requirements of go/345. Currently, - * setting LOG_FAIL_CLOSED mode will have no effect, but still exists - * because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ logMode?: string; } @@ -716,8 +572,7 @@ export namespace deploymentmanager_alpha { */ config?: Schema$ConfigFile; /** - * Output only. The fully-expanded configuration file, including any - * templates and references. + * Output only. The fully-expanded configuration file, including any templates and references. */ expandedConfig?: string; id?: string; @@ -743,8 +598,7 @@ export namespace deploymentmanager_alpha { selfLink?: string; } /** - * A response containing a partial list of manifests and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated. */ export interface Schema$ManifestsListResponse { /** @@ -757,18 +611,15 @@ export namespace deploymentmanager_alpha { nextPageToken?: string; } /** - * Deployment Manager will call these methods during the events of - * creation/deletion/update/get/setIamPolicy + * Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy */ export interface Schema$MethodMap { /** - * The action identifier for the create method to be used for this - * collection + * The action identifier for the create method to be used for this collection */ create?: string; /** - * The action identifier for the delete method to be used for this - * collection + * The action identifier for the delete method to be used for this collection */ delete?: string; /** @@ -776,27 +627,20 @@ export namespace deploymentmanager_alpha { */ get?: string; /** - * The action identifier for the setIamPolicy method to be used for this - * collection + * The action identifier for the setIamPolicy method to be used for this collection */ setIamPolicy?: string; /** - * The action identifier for the update method to be used for this - * collection + * The action identifier for the update method to be used for this collection */ update?: string; } /** - * An Operation resource, used to manage asynchronous API requests. (== - * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations - * ==) (== resource_for v1.regionOperations ==) (== resource_for - * beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== - * resource_for beta.zoneOperations ==) + * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** - * [Output Only] The value of `requestId` if you provided it in the request. - * Not present otherwise. + * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ clientOperationId?: string; /** @@ -804,46 +648,37 @@ export namespace deploymentmanager_alpha { */ creationTimestamp?: string; /** - * [Output Only] A textual description of the operation, which is set when - * the operation is created. + * [Output Only] A textual description of the operation, which is set when the operation is created. */ description?: string; /** - * [Output Only] The time that this operation was completed. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ endTime?: string; /** - * [Output Only] If errors are generated during processing of the operation, - * this field will be populated. + * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * message that was returned, such as NOT FOUND. + * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ httpErrorMessage?: string; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * status code that was returned. For example, a 404 means the resource was - * not found. + * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ httpErrorStatusCode?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The time that this operation was requested. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ insertTime?: string; /** - * [Output Only] Type of the resource. Always compute#operation for - * Operation resources. + * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ kind?: string; /** @@ -851,23 +686,15 @@ export namespace deploymentmanager_alpha { */ name?: string; /** - * [Output Only] The type of operation, such as insert, update, or delete, - * and so on. + * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ operationType?: string; /** - * [Output Only] An optional progress indicator that ranges from 0 to 100. - * There is no requirement that this be linear or support any granularity of - * operations. This should not be used to guess when the operation will be - * complete. This number should monotonically increase as the operation - * progresses. + * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only - * available when performing regional operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -875,39 +702,31 @@ export namespace deploymentmanager_alpha { */ selfLink?: string; /** - * [Output Only] The time that this operation was started by the server. - * This value is in RFC3339 text format. + * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ startTime?: string; /** - * [Output Only] The status of the operation, which can be one of the - * following: PENDING, RUNNING, or DONE. + * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ status?: string; /** - * [Output Only] An optional textual description of the current status of - * the operation. + * [Output Only] An optional textual description of the current status of the operation. */ statusMessage?: string; /** - * [Output Only] The unique target ID, which identifies a specific - * incarnation of the target resource. + * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ targetId?: string; /** - * [Output Only] The URL of the resource that the operation modifies. For - * operations related to creating a snapshot, this points to the persistent - * disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ targetLink?: string; /** - * [Output Only] User who requested the operation, for example: - * user@example.com. + * [Output Only] User who requested the operation, for example: user@example.com. */ user?: string; /** - * [Output Only] If warning messages are generated during processing of the - * operation, this field will be populated. + * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ warnings?: Array<{ code?: string; @@ -915,16 +734,12 @@ export namespace deploymentmanager_alpha { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only - * available when performing per-zone operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } /** - * A response containing a partial list of operations and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of operations and a page token used to build the next request if the request has been truncated. */ export interface Schema$OperationsListResponse { /** @@ -949,9 +764,7 @@ export namespace deploymentmanager_alpha { */ inputMappings?: Schema$InputMapping[]; /** - * The json path to the field in the resource JSON body into which the - * resource name should be mapped. Leaving this empty indicates that there - * should be no mapping performed. + * The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. */ nameProperty?: string; /** @@ -960,23 +773,7 @@ export namespace deploymentmanager_alpha { validationOptions?: Schema$ValidationOptions; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML Example** bindings: - - * members: - user:mike@example.com - group:admins@example.com - - * domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com - * role: roles/owner - members: - user:sean@example.com role: roles/viewer For - * a description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -984,31 +781,16 @@ export namespace deploymentmanager_alpha { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; iamOwned?: boolean; /** - * If more than one rule is specified, the rules are applied in the - * following manner: - All matching LOG rules are always applied. - If any - * DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be - * applied if one or more matching rule requires logging. - Otherwise, if - * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging - * will be applied if one or more matching rule requires logging. - - * Otherwise, if no rule applies, permission is denied. + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ rules?: Schema$Rule[]; /** @@ -1018,8 +800,7 @@ export namespace deploymentmanager_alpha { } export interface Schema$PollingOptions { /** - * An array of diagnostics to be collected by Deployment Manager, these - * diagnostics will be displayed to the user. + * An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. */ diagnostics?: Schema$Diagnostic[]; /** @@ -1035,8 +816,7 @@ export namespace deploymentmanager_alpha { */ pollingLink?: string; /** - * JsonPath expression, after polling is completed, indicates where to fetch - * the resource. + * JsonPath expression, after polling is completed, indicates where to fetch the resource. */ targetLink?: string; } @@ -1046,8 +826,7 @@ export namespace deploymentmanager_alpha { */ accessControl?: Schema$ResourceAccessControl; /** - * Output only. The evaluated properties of the resource with references - * expanded. Returned as serialized YAML. + * Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. */ finalProperties?: string; id?: string; @@ -1056,13 +835,11 @@ export namespace deploymentmanager_alpha { */ insertTime?: string; /** - * Output only. The last used credential that successfully created/updated - * the resource. + * Output only. The last used credential that successfully created/updated the resource. */ lastUsedCredential?: Schema$Credential; /** - * Output only. URL of the manifest representing the current configuration - * of this resource. + * Output only. URL of the manifest representing the current configuration of this resource. */ manifest?: string; /** @@ -1070,23 +847,19 @@ export namespace deploymentmanager_alpha { */ name?: string; /** - * Output only. The current properties of the resource before any references - * have been filled in. Returned as serialized YAML. + * Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. */ properties?: string; /** - * Output only. In case this is an action, it will show the runtimePolicies - * on which this action will run in the deployment + * Output only. In case this is an action, it will show the runtimePolicies on which this action will run in the deployment */ runtimePolicies?: string[]; /** - * Output only. The type of the resource, for example compute.v1.instance, - * or cloudfunctions.v1beta1.function. + * Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. */ type?: string; /** - * Output only. If Deployment Manager is currently updating or previewing an - * update to this resource, the updated configuration appears here. + * Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. */ update?: Schema$ResourceUpdate; /** @@ -1098,8 +871,7 @@ export namespace deploymentmanager_alpha { */ url?: string; /** - * Output only. If warning messages are generated during processing of this - * resource, this field will be populated. + * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; @@ -1117,8 +889,7 @@ export namespace deploymentmanager_alpha { gcpIamPolicy?: string; } /** - * A response containing a partial list of resources and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of resources and a page token used to build the next request if the request has been truncated. */ export interface Schema$ResourcesListResponse { /** @@ -1132,25 +903,21 @@ export namespace deploymentmanager_alpha { } export interface Schema$ResourceUpdate { /** - * The Access Control Policy to set on this resource after updating the - * resource itself. + * The Access Control Policy to set on this resource after updating the resource itself. */ accessControl?: Schema$ResourceAccessControl; /** - * Output only. The credential that will be used creating/updating this - * resource. + * Output only. The credential that will be used creating/updating this resource. */ credential?: Schema$Credential; /** - * Output only. If errors are generated during update of the resource, this - * field will be populated. + * Output only. If errors are generated during update of the resource, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * Output only. The expanded properties of the resource with reference - * values expanded. Returned as serialized YAML. + * Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. */ finalProperties?: string; /** @@ -1158,18 +925,15 @@ export namespace deploymentmanager_alpha { */ intent?: string; /** - * Output only. URL of the manifest representing the update configuration of - * this resource. + * Output only. URL of the manifest representing the update configuration of this resource. */ manifest?: string; /** - * Output only. The set of updated properties for this resource, before - * references are expanded. Returned as serialized YAML. + * Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. */ properties?: string; /** - * Output only. In case this is an action, it will show the runtimePolicies - * that this action will have after updating the deployment. + * Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment. */ runtimePolicies?: string[]; /** @@ -1177,8 +941,7 @@ export namespace deploymentmanager_alpha { */ state?: string; /** - * Output only. If warning messages are generated during processing of this - * resource, this field will be populated. + * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; @@ -1195,8 +958,7 @@ export namespace deploymentmanager_alpha { */ action?: string; /** - * Additional restrictions that must be met. All conditions must pass for - * the rule to match. + * Additional restrictions that must be met. All conditions must pass for the rule to match. */ conditions?: Schema$Condition[]; /** @@ -1204,25 +966,19 @@ export namespace deploymentmanager_alpha { */ description?: string; /** - * If one or more 'in' clauses are specified, the rule matches if - * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ ins?: string[]; /** - * The config returned to callers of tech.iam.IAM.CheckPolicy for any - * entries that match the LOG action. + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ logConfigs?: Schema$LogConfig[]; /** - * If one or more 'not_in' clauses are specified, the rule matches - * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ notIns?: string[]; /** - * A permission is a string of form '..' (e.g., - * 'storage.buckets.list'). A value of '*' matches all - * permissions, and a verb part of '*' (e.g., - * 'storage.buckets.*') matches all verbs. + * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ permissions?: string[]; } @@ -1231,8 +987,7 @@ export namespace deploymentmanager_alpha { */ export interface Schema$ServiceAccount { /** - * The IAM service account email address like - * test@myproject.iam.gserviceaccount.com + * The IAM service account email address like test@myproject.iam.gserviceaccount.com */ email?: string; } @@ -1242,9 +997,7 @@ export namespace deploymentmanager_alpha { */ config?: Schema$ConfigFile; /** - * Specifies any files to import for this configuration. This can be used to - * import templates or other files. For example, you might import a text - * file in order to use the file in a template. + * Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. */ imports?: Schema$ImportFile[]; } @@ -1275,16 +1028,13 @@ export namespace deploymentmanager_alpha { } export interface Schema$TestPermissionsRequest { /** - * The set of permissions to check for the 'resource'. Permissions - * with wildcards (such as '*' or 'storage.*') are not - * allowed. + * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ permissions?: string[]; } export interface Schema$TestPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1297,8 +1047,7 @@ export namespace deploymentmanager_alpha { */ configurableService?: Schema$ConfigurableService; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; id?: string; @@ -1307,12 +1056,7 @@ export namespace deploymentmanager_alpha { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$TypeLabelEntry[]; /** @@ -1320,8 +1064,7 @@ export namespace deploymentmanager_alpha { */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this type. + * Output only. The Operation that most recently ran, or is currently running, on this type. */ operation?: Schema$Operation; /** @@ -1330,8 +1073,7 @@ export namespace deploymentmanager_alpha { selfLink?: string; } /** - * Type Information. Contains detailed information about a composite type, - * base type, or base type with specific collection. + * Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. */ export interface Schema$TypeInfo { /** @@ -1339,13 +1081,11 @@ export namespace deploymentmanager_alpha { */ description?: string; /** - * For swagger 2.0 externalDocs field will be used. For swagger 1.2 this - * field will be empty. + * For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. */ documentationLink?: string; /** - * Output only. Type of the output. Always deploymentManager#TypeInfo for - * TypeInfo. + * Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. */ kind?: string; /** @@ -1353,8 +1093,7 @@ export namespace deploymentmanager_alpha { */ name?: string; /** - * For base types with a collection, we return a schema and documentation - * link For template types, we return only a schema + * For base types with a collection, we return a schema and documentation link For template types, we return only a schema */ schema?: Schema$TypeInfoSchemaInfo; /** @@ -1368,14 +1107,11 @@ export namespace deploymentmanager_alpha { } export interface Schema$TypeInfoSchemaInfo { /** - * The properties that this composite type or base type collection accept as - * input, represented as a json blob, format is: JSON Schema Draft V4 + * The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4 */ input?: string; /** - * The properties that this composite type or base type collection exposes - * as output, these properties can be used for references, represented as - * json blob, format is: JSON Schema Draft V4 + * The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4 */ output?: string; } @@ -1396,8 +1132,7 @@ export namespace deploymentmanager_alpha { */ credential?: Schema$Credential; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** @@ -1413,27 +1148,15 @@ export namespace deploymentmanager_alpha { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$TypeProviderLabelEntry[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this type provider. + * Output only. The Operation that most recently ran, or is currently running, on this type provider. */ operation?: Schema$Operation; /** @@ -1458,8 +1181,7 @@ export namespace deploymentmanager_alpha { */ nextPageToken?: string; /** - * Output only. A list of resource type providers supported by Deployment - * Manager. + * Output only. A list of resource type providers supported by Deployment Manager. */ typeProviders?: Schema$TypeProvider[]; } @@ -1491,8 +1213,7 @@ export namespace deploymentmanager_alpha { */ export interface Schema$ValidationOptions { /** - * Customize how deployment manager will validate the resource against - * schema errors. + * Customize how deployment manager will validate the resource against schema errors. */ schemaValidation?: string; /** @@ -2027,46 +1748,19 @@ export namespace deploymentmanager_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -2125,8 +1819,7 @@ export namespace deploymentmanager_alpha { /** * deploymentmanager.deployments.cancelPreview - * @desc Cancels and removes the preview currently associated with the - * deployment. + * @desc Cancels and removes the preview currently associated with the deployment. * @alias deploymentmanager.deployments.cancelPreview * @memberOf! () * @@ -2352,8 +2045,7 @@ export namespace deploymentmanager_alpha { /** * deploymentmanager.deployments.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias deploymentmanager.deployments.getIamPolicy * @memberOf! () * @@ -2426,8 +2118,7 @@ export namespace deploymentmanager_alpha { /** * deploymentmanager.deployments.insert - * @desc Creates a deployment and all of the resources described by the - * deployment manifest. + * @desc Creates a deployment and all of the resources described by the deployment manifest. * @alias deploymentmanager.deployments.insert * @memberOf! () * @@ -2583,8 +2274,7 @@ export namespace deploymentmanager_alpha { /** * deploymentmanager.deployments.patch - * @desc Updates a deployment and all of the resources described by the - * deployment manifest. This method supports patch semantics. + * @desc Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics. * @alias deploymentmanager.deployments.patch * @memberOf! () * @@ -2663,8 +2353,7 @@ export namespace deploymentmanager_alpha { /** * deploymentmanager.deployments.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias deploymentmanager.deployments.setIamPolicy * @memberOf! () * @@ -2738,8 +2427,7 @@ export namespace deploymentmanager_alpha { /** * deploymentmanager.deployments.stop - * @desc Stops an ongoing operation. This does not roll back any work that - * has already been completed, but prevents any new work from being started. + * @desc Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started. * @alias deploymentmanager.deployments.stop * @memberOf! () * @@ -2894,8 +2582,7 @@ export namespace deploymentmanager_alpha { /** * deploymentmanager.deployments.update - * @desc Updates a deployment and all of the resources described by the - * deployment manifest. + * @desc Updates a deployment and all of the resources described by the deployment manifest. * @alias deploymentmanager.deployments.update * @memberOf! () * @@ -3057,13 +2744,7 @@ export namespace deploymentmanager_alpha { */ createPolicy?: string; /** - * If set to true, creates a deployment and creates "shell" resources but - * does not actually instantiate these resources. This allows you to preview - * what your deployment looks like. After previewing a deployment, you can - * deploy your resources by making a request with the update() method or you - * can use the cancelPreview() method to cancel the preview altogether. Note - * that the deployment will still exist after you cancel the preview and you - * must separately delete this deployment if you want to remove it. + * If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -3083,46 +2764,19 @@ export namespace deploymentmanager_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3150,16 +2804,7 @@ export namespace deploymentmanager_alpha { */ deployment?: string; /** - * If set to true, updates the deployment and creates and updates the - * "shell" resources but does not actually alter or instantiate these - * resources. This allows you to preview what your deployment will look - * like. You can use this intent to preview how an update would affect your - * deployment. You must provide a target.config with a configuration if this - * is set to true. After previewing a deployment, you can deploy your - * resources by making a request with the update() or you can - * cancelPreview() to remove the preview altogether. Note that the - * deployment will still exist after you cancel the preview and you must - * separately delete this deployment if you want to remove it. + * If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -3254,16 +2899,7 @@ export namespace deploymentmanager_alpha { */ deployment?: string; /** - * If set to true, updates the deployment and creates and updates the - * "shell" resources but does not actually alter or instantiate these - * resources. This allows you to preview what your deployment will look - * like. You can use this intent to preview how an update would affect your - * deployment. You must provide a target.config with a configuration if this - * is set to true. After previewing a deployment, you can deploy your - * resources by making a request with the update() or you can - * cancelPreview() to remove the preview altogether. Note that the - * deployment will still exist after you cancel the preview and you must - * separately delete this deployment if you want to remove it. + * If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -3467,46 +3103,19 @@ export namespace deploymentmanager_alpha { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3697,46 +3306,19 @@ export namespace deploymentmanager_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3935,46 +3517,19 @@ export namespace deploymentmanager_alpha { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -4691,46 +4246,19 @@ export namespace deploymentmanager_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -4746,46 +4274,19 @@ export namespace deploymentmanager_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -5347,46 +4848,19 @@ export namespace deploymentmanager_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** diff --git a/src/apis/deploymentmanager/package.json b/src/apis/deploymentmanager/package.json index a66dec4a1be..eba4b68ebd1 100644 --- a/src/apis/deploymentmanager/package.json +++ b/src/apis/deploymentmanager/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/deploymentmanager/v2.ts b/src/apis/deploymentmanager/v2.ts index 6f60baceafb..eff277ece12 100644 --- a/src/apis/deploymentmanager/v2.ts +++ b/src/apis/deploymentmanager/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace deploymentmanager_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace deploymentmanager_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace deploymentmanager_v2 { /** * Google Cloud Deployment Manager API * - * Declares, configures, and deploys complex solutions on Google Cloud - * Platform. + * Declares, configures, and deploys complex solutions on Google Cloud Platform. * * @example * const {google} = require('googleapis'); @@ -100,7 +96,10 @@ export namespace deploymentmanager_v2 { types: Resource$Types; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.deployments = new Resource$Deployments(this.context); this.manifests = new Resource$Manifests(this.context); @@ -111,26 +110,7 @@ export namespace deploymentmanager_v2 { } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { "log_type": - * "ADMIN_READ", } ] }, { "service": - * "fooservice.googleapis.com" "audit_log_configs": [ { - * "log_type": "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy - * enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - * foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE - * logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -139,25 +119,16 @@ export namespace deploymentmanager_v2 { auditLogConfigs?: Schema$AuditLogConfig[]; exemptedMembers?: string[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { "log_type": - * "DATA_WRITE", } ] } This enables 'DATA_READ' and - * 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ - * logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of [Binding.members][]. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[]; /** @@ -179,31 +150,15 @@ export namespace deploymentmanager_v2 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or without - * a Google account. * `allAuthenticatedUsers`: A special identifier that - * represents anyone who is authenticated with a Google account or a service - * account. * `user:{emailid}`: An email address that represents a specific - * Google account. For example, `alice@gmail.com` . * - * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: A Google Apps - * domain name that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -224,8 +179,7 @@ export namespace deploymentmanager_v2 { */ svc?: string; /** - * Trusted attributes supplied by any service that owns resources and uses - * the IAM system for access control. + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ sys?: string; /** @@ -233,8 +187,7 @@ export namespace deploymentmanager_v2 { */ value?: string; /** - * The objects of the condition. This is mutually exclusive with - * 'value'. + * The objects of the condition. This is mutually exclusive with 'value'. */ values?: string[]; } @@ -250,14 +203,7 @@ export namespace deploymentmanager_v2 { */ description?: string; /** - * Provides a fingerprint to use in requests to modify a deployment, such as - * update(), stop(), and cancelPreview() requests. A fingerprint is a - * randomly generated value that must be provided with update(), stop(), and - * cancelPreview() requests to perform optimistic locking. This ensures - * optimistic concurrency so that only one request happens at a time. The - * fingerprint is initially generated by Deployment Manager and changes - * after every request to modify data. To get the latest fingerprint value, - * perform a get() request to a deployment. + * Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. */ fingerprint?: string; id?: string; @@ -266,32 +212,19 @@ export namespace deploymentmanager_v2 { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$DeploymentLabelEntry[]; /** - * Output only. URL of the manifest representing the last manifest that was - * successfully deployed. + * Output only. URL of the manifest representing the last manifest that was successfully deployed. */ manifest?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this deployment. + * Output only. The Operation that most recently ran, or is currently running, on this deployment. */ operation?: Schema$Operation; /** @@ -299,13 +232,11 @@ export namespace deploymentmanager_v2 { */ selfLink?: string; /** - * [Input Only] The parameters that define your deployment, including the - * deployment configuration and relevant templates. + * [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. */ target?: Schema$TargetConfiguration; /** - * Output only. If Deployment Manager is currently updating or previewing an - * update to this deployment, the updated configuration appears here. + * Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. */ update?: Schema$DeploymentUpdate; /** @@ -319,21 +250,12 @@ export namespace deploymentmanager_v2 { } export interface Schema$DeploymentsCancelPreviewRequest { /** - * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a - * randomly generated value that must be provided in cancelPreview() - * requests to perform optimistic locking. This ensures optimistic - * concurrency so that the deployment does not have conflicting requests - * (e.g. if someone attempts to make a new update request while another user - * attempts to cancel a preview, this would prevent one of the requests). - * The fingerprint is initially generated by Deployment Manager and changes - * after every request to modify a deployment. To get the latest fingerprint - * value, perform a get() request on the deployment. + * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ fingerprint?: string; } /** - * A response containing a partial list of deployments and a page token used - * to build the next request if the request has been truncated. + * A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. */ export interface Schema$DeploymentsListResponse { /** @@ -347,36 +269,21 @@ export namespace deploymentmanager_v2 { } export interface Schema$DeploymentsStopRequest { /** - * Specifies a fingerprint for stop() requests. A fingerprint is a randomly - * generated value that must be provided in stop() requests to perform - * optimistic locking. This ensures optimistic concurrency so that the - * deployment does not have conflicting requests (e.g. if someone attempts - * to make a new update request while another user attempts to stop an - * ongoing update request, this would prevent a collision). The fingerprint - * is initially generated by Deployment Manager and changes after every - * request to modify a deployment. To get the latest fingerprint value, - * perform a get() request on the deployment. + * Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ fingerprint?: string; } export interface Schema$DeploymentUpdate { /** - * Output only. An optional user-provided description of the deployment - * after the current update has been applied. + * Output only. An optional user-provided description of the deployment after the current update has been applied. */ description?: string; /** - * Output only. Map of labels; provided by the client when the resource is - * created or updated. Specifically: Label keys must be between 1 and 63 - * characters long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$DeploymentUpdateLabelEntry[]; /** - * Output only. URL of the manifest representing the update configuration of - * this deployment. + * Output only. URL of the manifest representing the update configuration of this deployment. */ manifest?: string; } @@ -385,50 +292,37 @@ export namespace deploymentmanager_v2 { value?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } export interface Schema$GlobalSetPolicyRequest { /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -473,22 +367,7 @@ export namespace deploymentmanager_v2 { logName?: string; } /** - * Increment a streamz counter with the specified metric and field names. - * Metric names should start with a '/', generally be lowercase-only, - * and end in "_count". Field names should not contain an initial - * slash. The actual exported metric names will have "/iam/policy" - * prepended. Field names correspond to IAM request parameters and field - * values are their respective values. Supported field names: - - * "authority", which is "[token]" if IAMContext.token is - * present, otherwise the value of IAMContext.authority_selector if present, - * and otherwise a representation of IAMContext.principal; or - - * "iam_principal", a representation of IAMContext.principal even if - * a token or authority selector is present; or - "" (empty string), - * resulting in a counter with no fields. Examples: counter { metric: - * "/debug_access_count" field: "iam_principal" } ==> - * increment counter /iam/policy/backend_debug_access_count - * {iam_principal=[value of IAMContext.principal]} At this time we do not - * support multiple field names (though this may be supported in the future). + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). */ export interface Schema$LogConfigCounterOptions { /** @@ -505,12 +384,7 @@ export namespace deploymentmanager_v2 { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. NOTE: - * Logging to Gin in a fail-closed manner is currently unsupported while - * work is being done to satisfy the requirements of go/345. Currently, - * setting LOG_FAIL_CLOSED mode will have no effect, but still exists - * because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ logMode?: string; } @@ -520,8 +394,7 @@ export namespace deploymentmanager_v2 { */ config?: Schema$ConfigFile; /** - * Output only. The fully-expanded configuration file, including any - * templates and references. + * Output only. The fully-expanded configuration file, including any templates and references. */ expandedConfig?: string; id?: string; @@ -547,8 +420,7 @@ export namespace deploymentmanager_v2 { selfLink?: string; } /** - * A response containing a partial list of manifests and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated. */ export interface Schema$ManifestsListResponse { /** @@ -561,16 +433,11 @@ export namespace deploymentmanager_v2 { nextPageToken?: string; } /** - * An Operation resource, used to manage asynchronous API requests. (== - * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations - * ==) (== resource_for v1.regionOperations ==) (== resource_for - * beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== - * resource_for beta.zoneOperations ==) + * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** - * [Output Only] The value of `requestId` if you provided it in the request. - * Not present otherwise. + * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ clientOperationId?: string; /** @@ -578,46 +445,37 @@ export namespace deploymentmanager_v2 { */ creationTimestamp?: string; /** - * [Output Only] A textual description of the operation, which is set when - * the operation is created. + * [Output Only] A textual description of the operation, which is set when the operation is created. */ description?: string; /** - * [Output Only] The time that this operation was completed. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ endTime?: string; /** - * [Output Only] If errors are generated during processing of the operation, - * this field will be populated. + * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * message that was returned, such as NOT FOUND. + * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ httpErrorMessage?: string; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * status code that was returned. For example, a 404 means the resource was - * not found. + * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ httpErrorStatusCode?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The time that this operation was requested. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ insertTime?: string; /** - * [Output Only] Type of the resource. Always compute#operation for - * Operation resources. + * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ kind?: string; /** @@ -625,23 +483,15 @@ export namespace deploymentmanager_v2 { */ name?: string; /** - * [Output Only] The type of operation, such as insert, update, or delete, - * and so on. + * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ operationType?: string; /** - * [Output Only] An optional progress indicator that ranges from 0 to 100. - * There is no requirement that this be linear or support any granularity of - * operations. This should not be used to guess when the operation will be - * complete. This number should monotonically increase as the operation - * progresses. + * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only - * available when performing regional operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -649,39 +499,31 @@ export namespace deploymentmanager_v2 { */ selfLink?: string; /** - * [Output Only] The time that this operation was started by the server. - * This value is in RFC3339 text format. + * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ startTime?: string; /** - * [Output Only] The status of the operation, which can be one of the - * following: PENDING, RUNNING, or DONE. + * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ status?: string; /** - * [Output Only] An optional textual description of the current status of - * the operation. + * [Output Only] An optional textual description of the current status of the operation. */ statusMessage?: string; /** - * [Output Only] The unique target ID, which identifies a specific - * incarnation of the target resource. + * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ targetId?: string; /** - * [Output Only] The URL of the resource that the operation modifies. For - * operations related to creating a snapshot, this points to the persistent - * disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ targetLink?: string; /** - * [Output Only] User who requested the operation, for example: - * user@example.com. + * [Output Only] User who requested the operation, for example: user@example.com. */ user?: string; /** - * [Output Only] If warning messages are generated during processing of the - * operation, this field will be populated. + * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ warnings?: Array<{ code?: string; @@ -689,16 +531,12 @@ export namespace deploymentmanager_v2 { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only - * available when performing per-zone operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } /** - * A response containing a partial list of operations and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of operations and a page token used to build the next request if the request has been truncated. */ export interface Schema$OperationsListResponse { /** @@ -711,23 +549,7 @@ export namespace deploymentmanager_v2 { operations?: Schema$Operation[]; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML Example** bindings: - - * members: - user:mike@example.com - group:admins@example.com - - * domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com - * role: roles/owner - members: - user:sean@example.com role: roles/viewer For - * a description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -735,31 +557,16 @@ export namespace deploymentmanager_v2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; iamOwned?: boolean; /** - * If more than one rule is specified, the rules are applied in the - * following manner: - All matching LOG rules are always applied. - If any - * DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be - * applied if one or more matching rule requires logging. - Otherwise, if - * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging - * will be applied if one or more matching rule requires logging. - - * Otherwise, if no rule applies, permission is denied. + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ rules?: Schema$Rule[]; /** @@ -773,8 +580,7 @@ export namespace deploymentmanager_v2 { */ accessControl?: Schema$ResourceAccessControl; /** - * Output only. The evaluated properties of the resource with references - * expanded. Returned as serialized YAML. + * Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. */ finalProperties?: string; id?: string; @@ -783,8 +589,7 @@ export namespace deploymentmanager_v2 { */ insertTime?: string; /** - * Output only. URL of the manifest representing the current configuration - * of this resource. + * Output only. URL of the manifest representing the current configuration of this resource. */ manifest?: string; /** @@ -792,18 +597,15 @@ export namespace deploymentmanager_v2 { */ name?: string; /** - * Output only. The current properties of the resource before any references - * have been filled in. Returned as serialized YAML. + * Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. */ properties?: string; /** - * Output only. The type of the resource, for example compute.v1.instance, - * or cloudfunctions.v1beta1.function. + * Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. */ type?: string; /** - * Output only. If Deployment Manager is currently updating or previewing an - * update to this resource, the updated configuration appears here. + * Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. */ update?: Schema$ResourceUpdate; /** @@ -815,8 +617,7 @@ export namespace deploymentmanager_v2 { */ url?: string; /** - * Output only. If warning messages are generated during processing of this - * resource, this field will be populated. + * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; @@ -834,8 +635,7 @@ export namespace deploymentmanager_v2 { gcpIamPolicy?: string; } /** - * A response containing a partial list of resources and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of resources and a page token used to build the next request if the request has been truncated. */ export interface Schema$ResourcesListResponse { /** @@ -849,20 +649,17 @@ export namespace deploymentmanager_v2 { } export interface Schema$ResourceUpdate { /** - * The Access Control Policy to set on this resource after updating the - * resource itself. + * The Access Control Policy to set on this resource after updating the resource itself. */ accessControl?: Schema$ResourceAccessControl; /** - * Output only. If errors are generated during update of the resource, this - * field will be populated. + * Output only. If errors are generated during update of the resource, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * Output only. The expanded properties of the resource with reference - * values expanded. Returned as serialized YAML. + * Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. */ finalProperties?: string; /** @@ -870,13 +667,11 @@ export namespace deploymentmanager_v2 { */ intent?: string; /** - * Output only. URL of the manifest representing the update configuration of - * this resource. + * Output only. URL of the manifest representing the update configuration of this resource. */ manifest?: string; /** - * Output only. The set of updated properties for this resource, before - * references are expanded. Returned as serialized YAML. + * Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. */ properties?: string; /** @@ -884,8 +679,7 @@ export namespace deploymentmanager_v2 { */ state?: string; /** - * Output only. If warning messages are generated during processing of this - * resource, this field will be populated. + * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; @@ -902,8 +696,7 @@ export namespace deploymentmanager_v2 { */ action?: string; /** - * Additional restrictions that must be met. All conditions must pass for - * the rule to match. + * Additional restrictions that must be met. All conditions must pass for the rule to match. */ conditions?: Schema$Condition[]; /** @@ -911,25 +704,19 @@ export namespace deploymentmanager_v2 { */ description?: string; /** - * If one or more 'in' clauses are specified, the rule matches if - * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ ins?: string[]; /** - * The config returned to callers of tech.iam.IAM.CheckPolicy for any - * entries that match the LOG action. + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ logConfigs?: Schema$LogConfig[]; /** - * If one or more 'not_in' clauses are specified, the rule matches - * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ notIns?: string[]; /** - * A permission is a string of form '..' (e.g., - * 'storage.buckets.list'). A value of '*' matches all - * permissions, and a verb part of '*' (e.g., - * 'storage.buckets.*') matches all verbs. + * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ permissions?: string[]; } @@ -939,24 +726,19 @@ export namespace deploymentmanager_v2 { */ config?: Schema$ConfigFile; /** - * Specifies any files to import for this configuration. This can be used to - * import templates or other files. For example, you might import a text - * file in order to use the file in a template. + * Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. */ imports?: Schema$ImportFile[]; } export interface Schema$TestPermissionsRequest { /** - * The set of permissions to check for the 'resource'. Permissions - * with wildcards (such as '*' or 'storage.*') are not - * allowed. + * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ permissions?: string[]; } export interface Schema$TestPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -974,8 +756,7 @@ export namespace deploymentmanager_v2 { */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this type. + * Output only. The Operation that most recently ran, or is currently running, on this type. */ operation?: Schema$Operation; /** @@ -1005,22 +786,19 @@ export namespace deploymentmanager_v2 { /** * deploymentmanager.deployments.cancelPreview - * @desc Cancels and removes the preview currently associated with the - * deployment. + * @desc Cancels and removes the preview currently associated with the deployment. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1042,8 +820,10 @@ export namespace deploymentmanager_v2 { * auth: authClient, * }; * - * deploymentManager.deployments.cancelPreview(request, function(err, - * response) { if (err) { console.error(err); return; + * deploymentManager.deployments.cancelPreview(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1057,10 +837,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1147,14 +926,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1189,10 +966,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1279,14 +1055,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1321,10 +1095,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1402,22 +1175,19 @@ export namespace deploymentmanager_v2 { /** * deploymentmanager.deployments.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1435,8 +1205,10 @@ export namespace deploymentmanager_v2 { * auth: authClient, * }; * - * deploymentManager.deployments.getIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * deploymentManager.deployments.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1450,10 +1222,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1530,22 +1301,19 @@ export namespace deploymentmanager_v2 { /** * deploymentmanager.deployments.insert - * @desc Creates a deployment and all of the resources described by the - * deployment manifest. + * @desc Creates a deployment and all of the resources described by the deployment manifest. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1581,10 +1349,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1672,14 +1439,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1705,9 +1470,8 @@ export namespace deploymentmanager_v2 { * return; * } * for (var i = 0; i < deploymentsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `deploymentsPage`: console.log(JSON.stringify(deploymentsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `deploymentsPage`: + * console.log(JSON.stringify(deploymentsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1725,10 +1489,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1811,22 +1574,19 @@ export namespace deploymentmanager_v2 { /** * deploymentmanager.deployments.patch - * @desc Updates a deployment and all of the resources described by the - * deployment manifest. This method supports patch semantics. + * @desc Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1842,8 +1602,7 @@ export namespace deploymentmanager_v2 { * deployment: 'my-deployment', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -1867,10 +1626,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1953,22 +1711,19 @@ export namespace deploymentmanager_v2 { /** * deploymentmanager.deployments.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1990,8 +1745,10 @@ export namespace deploymentmanager_v2 { * auth: authClient, * }; * - * deploymentManager.deployments.setIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * deploymentManager.deployments.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2005,10 +1762,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2086,22 +1842,19 @@ export namespace deploymentmanager_v2 { /** * deploymentmanager.deployments.stop - * @desc Stops an ongoing operation. This does not roll back any work that - * has already been completed, but prevents any new work from being started. + * @desc Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2140,10 +1893,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2229,14 +1981,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2258,8 +2008,10 @@ export namespace deploymentmanager_v2 { * auth: authClient, * }; * - * deploymentManager.deployments.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * deploymentManager.deployments.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2273,10 +2025,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2360,22 +2111,19 @@ export namespace deploymentmanager_v2 { /** * deploymentmanager.deployments.update - * @desc Updates a deployment and all of the resources described by the - * deployment manifest. + * @desc Updates a deployment and all of the resources described by the deployment manifest. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2391,8 +2139,7 @@ export namespace deploymentmanager_v2 { * deployment: 'my-deployment', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -2416,10 +2163,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2585,13 +2331,7 @@ export namespace deploymentmanager_v2 { */ createPolicy?: string; /** - * If set to true, creates a deployment and creates "shell" resources but - * does not actually instantiate these resources. This allows you to preview - * what your deployment looks like. After previewing a deployment, you can - * deploy your resources by making a request with the update() method or you - * can use the cancelPreview() method to cancel the preview altogether. Note - * that the deployment will still exist after you cancel the preview and you - * must separately delete this deployment if you want to remove it. + * If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -2611,46 +2351,19 @@ export namespace deploymentmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -2678,16 +2391,7 @@ export namespace deploymentmanager_v2 { */ deployment?: string; /** - * If set to true, updates the deployment and creates and updates the - * "shell" resources but does not actually alter or instantiate these - * resources. This allows you to preview what your deployment will look - * like. You can use this intent to preview how an update would affect your - * deployment. You must provide a target.config with a configuration if this - * is set to true. After previewing a deployment, you can deploy your - * resources by making a request with the update() or you can - * cancelPreview() to remove the preview altogether. Note that the - * deployment will still exist after you cancel the preview and you must - * separately delete this deployment if you want to remove it. + * If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -2782,16 +2486,7 @@ export namespace deploymentmanager_v2 { */ deployment?: string; /** - * If set to true, updates the deployment and creates and updates the - * "shell" resources but does not actually alter or instantiate these - * resources. This allows you to preview what your deployment will look - * like. You can use this intent to preview how an update would affect your - * deployment. You must provide a target.config with a configuration if this - * is set to true. After previewing a deployment, you can deploy your - * resources by making a request with the update() or you can - * cancelPreview() to remove the preview altogether. Note that the - * deployment will still exist after you cancel the preview and you must - * separately delete this deployment if you want to remove it. + * If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -2820,14 +2515,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2865,10 +2558,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2952,14 +2644,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2988,8 +2678,8 @@ export namespace deploymentmanager_v2 { * return; * } * for (var i = 0; i < manifestsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `manifestsPage`: console.log(JSON.stringify(manifestsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `manifestsPage`: + * console.log(JSON.stringify(manifestsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -3007,10 +2697,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3123,46 +2812,19 @@ export namespace deploymentmanager_v2 { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3186,14 +2848,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3228,10 +2888,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3316,14 +2975,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3349,9 +3006,8 @@ export namespace deploymentmanager_v2 { * return; * } * for (var i = 0; i < operationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `operationsPage`: console.log(JSON.stringify(operationsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -3369,10 +3025,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3476,46 +3131,19 @@ export namespace deploymentmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3539,14 +3167,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3584,10 +3210,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3671,14 +3296,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3707,8 +3330,8 @@ export namespace deploymentmanager_v2 { * return; * } * for (var i = 0; i < resourcesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `resourcesPage`: console.log(JSON.stringify(resourcesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `resourcesPage`: + * console.log(JSON.stringify(resourcesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -3726,10 +3349,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3842,46 +3464,19 @@ export namespace deploymentmanager_v2 { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3905,14 +3500,12 @@ export namespace deploymentmanager_v2 { * // 1. If not already done, enable the Google Cloud Deployment Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/deploymentmanager - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3957,10 +3550,9 @@ export namespace deploymentmanager_v2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4046,46 +3638,19 @@ export namespace deploymentmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** diff --git a/src/apis/deploymentmanager/v2beta.ts b/src/apis/deploymentmanager/v2beta.ts index 24f0eaaa956..a7a4c7b17cb 100644 --- a/src/apis/deploymentmanager/v2beta.ts +++ b/src/apis/deploymentmanager/v2beta.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace deploymentmanager_v2beta { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace deploymentmanager_v2beta { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace deploymentmanager_v2beta { /** * Google Cloud Deployment Manager API V2Beta Methods * - * The Deployment Manager API allows users to declaratively configure, deploy - * and run complex solutions on the Google Cloud Platform. + * The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform. * * @example * const {google} = require('googleapis'); @@ -102,7 +98,10 @@ export namespace deploymentmanager_v2beta { types: Resource$Types; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.compositeTypes = new Resource$Compositetypes(this.context); this.deployments = new Resource$Deployments(this.context); @@ -123,33 +122,12 @@ export namespace deploymentmanager_v2beta { */ methodMatch?: string; /** - * Deployment manager will poll instances for this API resource setting a - * RUNNING state, and blocking until polling conditions tell whether the - * resource is completed or failed. + * Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. */ pollingOptions?: Schema$PollingOptions; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { "log_type": - * "ADMIN_READ", } ] }, { "service": - * "fooservice.googleapis.com" "audit_log_configs": [ { - * "log_type": "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy - * enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - * foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE - * logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -158,25 +136,16 @@ export namespace deploymentmanager_v2beta { auditLogConfigs?: Schema$AuditLogConfig[]; exemptedMembers?: string[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { "log_type": - * "DATA_WRITE", } ] } This enables 'DATA_READ' and - * 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ - * logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of [Binding.members][]. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[]; /** @@ -226,37 +195,20 @@ export namespace deploymentmanager_v2beta { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or without - * a Google account. * `allAuthenticatedUsers`: A special identifier that - * represents anyone who is authenticated with a Google account or a service - * account. * `user:{emailid}`: An email address that represents a specific - * Google account. For example, `alice@gmail.com` . * - * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: A Google Apps - * domain name that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * CollectionOverride allows resource handling overrides for specific - * resources within a BaseType + * CollectionOverride allows resource handling overrides for specific resources within a BaseType */ export interface Schema$CollectionOverride { /** @@ -273,8 +225,7 @@ export namespace deploymentmanager_v2beta { */ export interface Schema$CompositeType { /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; id?: string; @@ -283,22 +234,15 @@ export namespace deploymentmanager_v2beta { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$CompositeTypeLabelEntry[]; /** - * Name of the composite type, must follow the expression: - * [a-z]([-a-z0-9_.]{0,61}[a-z0-9])?. + * Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]{0,61}[a-z0-9])?. */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this composite type. + * Output only. The Operation that most recently ran, or is currently running, on this composite type. */ operation?: Schema$Operation; /** @@ -320,8 +264,7 @@ export namespace deploymentmanager_v2beta { */ export interface Schema$CompositeTypesListResponse { /** - * Output only. A list of resource composite types supported by Deployment - * Manager. + * Output only. A list of resource composite types supported by Deployment Manager. */ compositeTypes?: Schema$CompositeType[]; /** @@ -346,8 +289,7 @@ export namespace deploymentmanager_v2beta { */ svc?: string; /** - * Trusted attributes supplied by any service that owns resources and uses - * the IAM system for access control. + * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ sys?: string; /** @@ -355,8 +297,7 @@ export namespace deploymentmanager_v2beta { */ value?: string; /** - * The objects of the condition. This is mutually exclusive with - * 'value'. + * The objects of the condition. This is mutually exclusive with 'value'. */ values?: string[]; } @@ -367,8 +308,7 @@ export namespace deploymentmanager_v2beta { content?: string; } /** - * The credential used by Deployment Manager and TypeProvider. Only one of the - * options is permitted. + * The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. */ export interface Schema$Credential { /** @@ -380,8 +320,7 @@ export namespace deploymentmanager_v2beta { */ serviceAccount?: Schema$ServiceAccount; /** - * Specify to use the project default credential, only supported by - * Deployment. + * Specify to use the project default credential, only supported by Deployment. */ useProjectDefault?: boolean; } @@ -391,14 +330,7 @@ export namespace deploymentmanager_v2beta { */ description?: string; /** - * Provides a fingerprint to use in requests to modify a deployment, such as - * update(), stop(), and cancelPreview() requests. A fingerprint is a - * randomly generated value that must be provided with update(), stop(), and - * cancelPreview() requests to perform optimistic locking. This ensures - * optimistic concurrency so that only one request happens at a time. The - * fingerprint is initially generated by Deployment Manager and changes - * after every request to modify data. To get the latest fingerprint value, - * perform a get() request to a deployment. + * Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. */ fingerprint?: string; id?: string; @@ -407,32 +339,19 @@ export namespace deploymentmanager_v2beta { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$DeploymentLabelEntry[]; /** - * Output only. URL of the manifest representing the last manifest that was - * successfully deployed. + * Output only. URL of the manifest representing the last manifest that was successfully deployed. */ manifest?: string; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this deployment. + * Output only. The Operation that most recently ran, or is currently running, on this deployment. */ operation?: Schema$Operation; /** @@ -440,13 +359,11 @@ export namespace deploymentmanager_v2beta { */ selfLink?: string; /** - * [Input Only] The parameters that define your deployment, including the - * deployment configuration and relevant templates. + * [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. */ target?: Schema$TargetConfiguration; /** - * Output only. If Deployment Manager is currently updating or previewing an - * update to this deployment, the updated configuration appears here. + * Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. */ update?: Schema$DeploymentUpdate; /** @@ -460,21 +377,12 @@ export namespace deploymentmanager_v2beta { } export interface Schema$DeploymentsCancelPreviewRequest { /** - * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a - * randomly generated value that must be provided in cancelPreview() - * requests to perform optimistic locking. This ensures optimistic - * concurrency so that the deployment does not have conflicting requests - * (e.g. if someone attempts to make a new update request while another user - * attempts to cancel a preview, this would prevent one of the requests). - * The fingerprint is initially generated by Deployment Manager and changes - * after every request to modify a deployment. To get the latest fingerprint - * value, perform a get() request on the deployment. + * Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ fingerprint?: string; } /** - * A response containing a partial list of deployments and a page token used - * to build the next request if the request has been truncated. + * A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. */ export interface Schema$DeploymentsListResponse { /** @@ -488,36 +396,21 @@ export namespace deploymentmanager_v2beta { } export interface Schema$DeploymentsStopRequest { /** - * Specifies a fingerprint for stop() requests. A fingerprint is a randomly - * generated value that must be provided in stop() requests to perform - * optimistic locking. This ensures optimistic concurrency so that the - * deployment does not have conflicting requests (e.g. if someone attempts - * to make a new update request while another user attempts to stop an - * ongoing update request, this would prevent a collision). The fingerprint - * is initially generated by Deployment Manager and changes after every - * request to modify a deployment. To get the latest fingerprint value, - * perform a get() request on the deployment. + * Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. */ fingerprint?: string; } export interface Schema$DeploymentUpdate { /** - * Output only. An optional user-provided description of the deployment - * after the current update has been applied. + * Output only. An optional user-provided description of the deployment after the current update has been applied. */ description?: string; /** - * Output only. Map of labels; provided by the client when the resource is - * created or updated. Specifically: Label keys must be between 1 and 63 - * characters long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$DeploymentUpdateLabelEntry[]; /** - * Output only. URL of the manifest representing the update configuration of - * this deployment. + * Output only. URL of the manifest representing the update configuration of this deployment. */ manifest?: string; } @@ -527,8 +420,7 @@ export namespace deploymentmanager_v2beta { } export interface Schema$Diagnostic { /** - * JsonPath expression on the resource that if non empty, indicates that - * this field needs to be extracted as a diagnostic. + * JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. */ field?: string; /** @@ -537,50 +429,37 @@ export namespace deploymentmanager_v2beta { level?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } export interface Schema$GlobalSetPolicyRequest { /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify bindings. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. */ bindings?: Schema$Binding[]; /** - * Flatten Policy to create a backward compatible wire-format. Deprecated. - * Use 'policy' to specify the etag. + * Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. */ etag?: string; /** - * REQUIRED: The complete policy to be applied to the 'resource'. - * The size of the policy is limited to a few 10s of KB. An empty policy is - * in general a valid policy but certain services (like Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. */ policy?: Schema$Policy; } @@ -595,8 +474,7 @@ export namespace deploymentmanager_v2beta { name?: string; } /** - * InputMapping creates a 'virtual' property that will be injected - * into the properties before sending the request to the underlying API. + * InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. */ export interface Schema$InputMapping { /** @@ -647,22 +525,7 @@ export namespace deploymentmanager_v2beta { logName?: string; } /** - * Increment a streamz counter with the specified metric and field names. - * Metric names should start with a '/', generally be lowercase-only, - * and end in "_count". Field names should not contain an initial - * slash. The actual exported metric names will have "/iam/policy" - * prepended. Field names correspond to IAM request parameters and field - * values are their respective values. Supported field names: - - * "authority", which is "[token]" if IAMContext.token is - * present, otherwise the value of IAMContext.authority_selector if present, - * and otherwise a representation of IAMContext.principal; or - - * "iam_principal", a representation of IAMContext.principal even if - * a token or authority selector is present; or - "" (empty string), - * resulting in a counter with no fields. Examples: counter { metric: - * "/debug_access_count" field: "iam_principal" } ==> - * increment counter /iam/policy/backend_debug_access_count - * {iam_principal=[value of IAMContext.principal]} At this time we do not - * support multiple field names (though this may be supported in the future). + * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). */ export interface Schema$LogConfigCounterOptions { /** @@ -679,12 +542,7 @@ export namespace deploymentmanager_v2beta { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. NOTE: - * Logging to Gin in a fail-closed manner is currently unsupported while - * work is being done to satisfy the requirements of go/345. Currently, - * setting LOG_FAIL_CLOSED mode will have no effect, but still exists - * because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ logMode?: string; } @@ -694,8 +552,7 @@ export namespace deploymentmanager_v2beta { */ config?: Schema$ConfigFile; /** - * Output only. The fully-expanded configuration file, including any - * templates and references. + * Output only. The fully-expanded configuration file, including any templates and references. */ expandedConfig?: string; id?: string; @@ -721,8 +578,7 @@ export namespace deploymentmanager_v2beta { selfLink?: string; } /** - * A response containing a partial list of manifests and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated. */ export interface Schema$ManifestsListResponse { /** @@ -735,16 +591,11 @@ export namespace deploymentmanager_v2beta { nextPageToken?: string; } /** - * An Operation resource, used to manage asynchronous API requests. (== - * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations - * ==) (== resource_for v1.regionOperations ==) (== resource_for - * beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== - * resource_for beta.zoneOperations ==) + * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** - * [Output Only] The value of `requestId` if you provided it in the request. - * Not present otherwise. + * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ clientOperationId?: string; /** @@ -752,46 +603,37 @@ export namespace deploymentmanager_v2beta { */ creationTimestamp?: string; /** - * [Output Only] A textual description of the operation, which is set when - * the operation is created. + * [Output Only] A textual description of the operation, which is set when the operation is created. */ description?: string; /** - * [Output Only] The time that this operation was completed. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ endTime?: string; /** - * [Output Only] If errors are generated during processing of the operation, - * this field will be populated. + * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * message that was returned, such as NOT FOUND. + * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ httpErrorMessage?: string; /** - * [Output Only] If the operation fails, this field contains the HTTP error - * status code that was returned. For example, a 404 means the resource was - * not found. + * [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. */ httpErrorStatusCode?: number; /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** - * [Output Only] The time that this operation was requested. This value is - * in RFC3339 text format. + * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ insertTime?: string; /** - * [Output Only] Type of the resource. Always compute#operation for - * Operation resources. + * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ kind?: string; /** @@ -799,23 +641,15 @@ export namespace deploymentmanager_v2beta { */ name?: string; /** - * [Output Only] The type of operation, such as insert, update, or delete, - * and so on. + * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ operationType?: string; /** - * [Output Only] An optional progress indicator that ranges from 0 to 100. - * There is no requirement that this be linear or support any granularity of - * operations. This should not be used to guess when the operation will be - * complete. This number should monotonically increase as the operation - * progresses. + * [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only - * available when performing regional operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** @@ -823,39 +657,31 @@ export namespace deploymentmanager_v2beta { */ selfLink?: string; /** - * [Output Only] The time that this operation was started by the server. - * This value is in RFC3339 text format. + * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ startTime?: string; /** - * [Output Only] The status of the operation, which can be one of the - * following: PENDING, RUNNING, or DONE. + * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ status?: string; /** - * [Output Only] An optional textual description of the current status of - * the operation. + * [Output Only] An optional textual description of the current status of the operation. */ statusMessage?: string; /** - * [Output Only] The unique target ID, which identifies a specific - * incarnation of the target resource. + * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ targetId?: string; /** - * [Output Only] The URL of the resource that the operation modifies. For - * operations related to creating a snapshot, this points to the persistent - * disk that the snapshot was created from. + * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ targetLink?: string; /** - * [Output Only] User who requested the operation, for example: - * user@example.com. + * [Output Only] User who requested the operation, for example: user@example.com. */ user?: string; /** - * [Output Only] If warning messages are generated during processing of the - * operation, this field will be populated. + * [Output Only] If warning messages are generated during processing of the operation, this field will be populated. */ warnings?: Array<{ code?: string; @@ -863,16 +689,12 @@ export namespace deploymentmanager_v2beta { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only - * available when performing per-zone operations. You must specify this - * field as part of the HTTP request URL. It is not settable as a field in - * the request body. + * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } /** - * A response containing a partial list of operations and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of operations and a page token used to build the next request if the request has been truncated. */ export interface Schema$OperationsListResponse { /** @@ -901,34 +723,12 @@ export namespace deploymentmanager_v2beta { */ validationOptions?: Schema$ValidationOptions; /** - * Additional properties block described as a jsonSchema, these properties - * will never be part of the json payload, but they can be consumed by - * InputMappings, this must be a valid json schema draft-04. The properties - * specified here will be decouple in a different section. This schema will - * be merged to the schema validation, and properties here will be extracted - * From the payload and consumed explicitly by InputMappings. ex: field1: - * type: string field2: type: number + * Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number */ virtualProperties?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML Example** bindings: - - * members: - user:mike@example.com - group:admins@example.com - - * domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com - * role: roles/owner - members: - user:sean@example.com role: roles/viewer For - * a description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -936,31 +736,16 @@ export namespace deploymentmanager_v2beta { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; iamOwned?: boolean; /** - * If more than one rule is specified, the rules are applied in the - * following manner: - All matching LOG rules are always applied. - If any - * DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be - * applied if one or more matching rule requires logging. - Otherwise, if - * any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging - * will be applied if one or more matching rule requires logging. - - * Otherwise, if no rule applies, permission is denied. + * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ rules?: Schema$Rule[]; /** @@ -970,8 +755,7 @@ export namespace deploymentmanager_v2beta { } export interface Schema$PollingOptions { /** - * An array of diagnostics to be collected by Deployment Manager, these - * diagnostics will be displayed to the user. + * An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. */ diagnostics?: Schema$Diagnostic[]; /** @@ -987,8 +771,7 @@ export namespace deploymentmanager_v2beta { */ pollingLink?: string; /** - * JsonPath expression, after polling is completed, indicates where to fetch - * the resource. + * JsonPath expression, after polling is completed, indicates where to fetch the resource. */ targetLink?: string; } @@ -998,8 +781,7 @@ export namespace deploymentmanager_v2beta { */ accessControl?: Schema$ResourceAccessControl; /** - * Output only. The evaluated properties of the resource with references - * expanded. Returned as serialized YAML. + * Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. */ finalProperties?: string; id?: string; @@ -1008,8 +790,7 @@ export namespace deploymentmanager_v2beta { */ insertTime?: string; /** - * Output only. URL of the manifest representing the current configuration - * of this resource. + * Output only. URL of the manifest representing the current configuration of this resource. */ manifest?: string; /** @@ -1017,18 +798,15 @@ export namespace deploymentmanager_v2beta { */ name?: string; /** - * Output only. The current properties of the resource before any references - * have been filled in. Returned as serialized YAML. + * Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. */ properties?: string; /** - * Output only. The type of the resource, for example compute.v1.instance, - * or cloudfunctions.v1beta1.function. + * Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. */ type?: string; /** - * Output only. If Deployment Manager is currently updating or previewing an - * update to this resource, the updated configuration appears here. + * Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. */ update?: Schema$ResourceUpdate; /** @@ -1040,8 +818,7 @@ export namespace deploymentmanager_v2beta { */ url?: string; /** - * Output only. If warning messages are generated during processing of this - * resource, this field will be populated. + * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; @@ -1059,8 +836,7 @@ export namespace deploymentmanager_v2beta { gcpIamPolicy?: string; } /** - * A response containing a partial list of resources and a page token used to - * build the next request if the request has been truncated. + * A response containing a partial list of resources and a page token used to build the next request if the request has been truncated. */ export interface Schema$ResourcesListResponse { /** @@ -1074,20 +850,17 @@ export namespace deploymentmanager_v2beta { } export interface Schema$ResourceUpdate { /** - * The Access Control Policy to set on this resource after updating the - * resource itself. + * The Access Control Policy to set on this resource after updating the resource itself. */ accessControl?: Schema$ResourceAccessControl; /** - * Output only. If errors are generated during update of the resource, this - * field will be populated. + * Output only. If errors are generated during update of the resource, this field will be populated. */ error?: { errors?: Array<{code?: string; location?: string; message?: string}>; }; /** - * Output only. The expanded properties of the resource with reference - * values expanded. Returned as serialized YAML. + * Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. */ finalProperties?: string; /** @@ -1095,13 +868,11 @@ export namespace deploymentmanager_v2beta { */ intent?: string; /** - * Output only. URL of the manifest representing the update configuration of - * this resource. + * Output only. URL of the manifest representing the update configuration of this resource. */ manifest?: string; /** - * Output only. The set of updated properties for this resource, before - * references are expanded. Returned as serialized YAML. + * Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. */ properties?: string; /** @@ -1109,8 +880,7 @@ export namespace deploymentmanager_v2beta { */ state?: string; /** - * Output only. If warning messages are generated during processing of this - * resource, this field will be populated. + * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; @@ -1127,8 +897,7 @@ export namespace deploymentmanager_v2beta { */ action?: string; /** - * Additional restrictions that must be met. All conditions must pass for - * the rule to match. + * Additional restrictions that must be met. All conditions must pass for the rule to match. */ conditions?: Schema$Condition[]; /** @@ -1136,25 +905,19 @@ export namespace deploymentmanager_v2beta { */ description?: string; /** - * If one or more 'in' clauses are specified, the rule matches if - * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ ins?: string[]; /** - * The config returned to callers of tech.iam.IAM.CheckPolicy for any - * entries that match the LOG action. + * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ logConfigs?: Schema$LogConfig[]; /** - * If one or more 'not_in' clauses are specified, the rule matches - * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ notIns?: string[]; /** - * A permission is a string of form '..' (e.g., - * 'storage.buckets.list'). A value of '*' matches all - * permissions, and a verb part of '*' (e.g., - * 'storage.buckets.*') matches all verbs. + * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ permissions?: string[]; } @@ -1163,8 +926,7 @@ export namespace deploymentmanager_v2beta { */ export interface Schema$ServiceAccount { /** - * The IAM service account email address like - * test@myproject.iam.gserviceaccount.com + * The IAM service account email address like test@myproject.iam.gserviceaccount.com */ email?: string; } @@ -1174,9 +936,7 @@ export namespace deploymentmanager_v2beta { */ config?: Schema$ConfigFile; /** - * Specifies any files to import for this configuration. This can be used to - * import templates or other files. For example, you might import a text - * file in order to use the file in a template. + * Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. */ imports?: Schema$ImportFile[]; } @@ -1207,16 +967,13 @@ export namespace deploymentmanager_v2beta { } export interface Schema$TestPermissionsRequest { /** - * The set of permissions to check for the 'resource'. Permissions - * with wildcards (such as '*' or 'storage.*') are not - * allowed. + * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ permissions?: string[]; } export interface Schema$TestPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1229,8 +986,7 @@ export namespace deploymentmanager_v2beta { */ base?: Schema$BaseType; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; id?: string; @@ -1239,12 +995,7 @@ export namespace deploymentmanager_v2beta { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$TypeLabelEntry[]; /** @@ -1252,8 +1003,7 @@ export namespace deploymentmanager_v2beta { */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this type. + * Output only. The Operation that most recently ran, or is currently running, on this type. */ operation?: Schema$Operation; /** @@ -1262,8 +1012,7 @@ export namespace deploymentmanager_v2beta { selfLink?: string; } /** - * Type Information. Contains detailed information about a composite type, - * base type, or base type with specific collection. + * Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. */ export interface Schema$TypeInfo { /** @@ -1271,13 +1020,11 @@ export namespace deploymentmanager_v2beta { */ description?: string; /** - * For swagger 2.0 externalDocs field will be used. For swagger 1.2 this - * field will be empty. + * For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. */ documentationLink?: string; /** - * Output only. Type of the output. Always deploymentManager#TypeInfo for - * TypeInfo. + * Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. */ kind?: string; /** @@ -1285,8 +1032,7 @@ export namespace deploymentmanager_v2beta { */ name?: string; /** - * For base types with a collection, we return a schema and documentation - * link For template types, we return only a schema + * For base types with a collection, we return a schema and documentation link For template types, we return only a schema */ schema?: Schema$TypeInfoSchemaInfo; /** @@ -1300,14 +1046,11 @@ export namespace deploymentmanager_v2beta { } export interface Schema$TypeInfoSchemaInfo { /** - * The properties that this composite type or base type collection accept as - * input, represented as a json blob, format is: JSON Schema Draft V4 + * The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4 */ input?: string; /** - * The properties that this composite type or base type collection exposes - * as output, these properties can be used for references, represented as - * json blob, format is: JSON Schema Draft V4 + * The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4 */ output?: string; } @@ -1328,8 +1071,7 @@ export namespace deploymentmanager_v2beta { */ credential?: Schema$Credential; /** - * An optional textual description of the resource; provided by the client - * when the resource is created. + * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** @@ -1345,27 +1087,15 @@ export namespace deploymentmanager_v2beta { */ insertTime?: string; /** - * Map of labels; provided by the client when the resource is created or - * updated. Specifically: Label keys must be between 1 and 63 characters - * long and must conform to the following regular expression: - * [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * ([a-z]([-a-z0-9]*[a-z0-9])?)? + * Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? */ labels?: Schema$TypeProviderLabelEntry[]; /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** - * Output only. The Operation that most recently ran, or is currently - * running, on this type provider. + * Output only. The Operation that most recently ran, or is currently running, on this type provider. */ operation?: Schema$Operation; /** @@ -1390,8 +1120,7 @@ export namespace deploymentmanager_v2beta { */ nextPageToken?: string; /** - * Output only. A list of resource type providers supported by Deployment - * Manager. + * Output only. A list of resource type providers supported by Deployment Manager. */ typeProviders?: Schema$TypeProvider[]; } @@ -1423,8 +1152,7 @@ export namespace deploymentmanager_v2beta { */ export interface Schema$ValidationOptions { /** - * Customize how deployment manager will validate the resource against - * schema errors. + * Customize how deployment manager will validate the resource against schema errors. */ schemaValidation?: string; /** @@ -1959,46 +1687,19 @@ export namespace deploymentmanager_v2beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -2057,8 +1758,7 @@ export namespace deploymentmanager_v2beta { /** * deploymentmanager.deployments.cancelPreview - * @desc Cancels and removes the preview currently associated with the - * deployment. + * @desc Cancels and removes the preview currently associated with the deployment. * @alias deploymentmanager.deployments.cancelPreview * @memberOf! () * @@ -2284,8 +1984,7 @@ export namespace deploymentmanager_v2beta { /** * deploymentmanager.deployments.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias deploymentmanager.deployments.getIamPolicy * @memberOf! () * @@ -2358,8 +2057,7 @@ export namespace deploymentmanager_v2beta { /** * deploymentmanager.deployments.insert - * @desc Creates a deployment and all of the resources described by the - * deployment manifest. + * @desc Creates a deployment and all of the resources described by the deployment manifest. * @alias deploymentmanager.deployments.insert * @memberOf! () * @@ -2515,8 +2213,7 @@ export namespace deploymentmanager_v2beta { /** * deploymentmanager.deployments.patch - * @desc Updates a deployment and all of the resources described by the - * deployment manifest. This method supports patch semantics. + * @desc Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics. * @alias deploymentmanager.deployments.patch * @memberOf! () * @@ -2595,8 +2292,7 @@ export namespace deploymentmanager_v2beta { /** * deploymentmanager.deployments.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias deploymentmanager.deployments.setIamPolicy * @memberOf! () * @@ -2670,8 +2366,7 @@ export namespace deploymentmanager_v2beta { /** * deploymentmanager.deployments.stop - * @desc Stops an ongoing operation. This does not roll back any work that - * has already been completed, but prevents any new work from being started. + * @desc Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started. * @alias deploymentmanager.deployments.stop * @memberOf! () * @@ -2826,8 +2521,7 @@ export namespace deploymentmanager_v2beta { /** * deploymentmanager.deployments.update - * @desc Updates a deployment and all of the resources described by the - * deployment manifest. + * @desc Updates a deployment and all of the resources described by the deployment manifest. * @alias deploymentmanager.deployments.update * @memberOf! () * @@ -2989,13 +2683,7 @@ export namespace deploymentmanager_v2beta { */ createPolicy?: string; /** - * If set to true, creates a deployment and creates "shell" resources but - * does not actually instantiate these resources. This allows you to preview - * what your deployment looks like. After previewing a deployment, you can - * deploy your resources by making a request with the update() method or you - * can use the cancelPreview() method to cancel the preview altogether. Note - * that the deployment will still exist after you cancel the preview and you - * must separately delete this deployment if you want to remove it. + * If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -3015,46 +2703,19 @@ export namespace deploymentmanager_v2beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3082,16 +2743,7 @@ export namespace deploymentmanager_v2beta { */ deployment?: string; /** - * If set to true, updates the deployment and creates and updates the - * "shell" resources but does not actually alter or instantiate these - * resources. This allows you to preview what your deployment will look - * like. You can use this intent to preview how an update would affect your - * deployment. You must provide a target.config with a configuration if this - * is set to true. After previewing a deployment, you can deploy your - * resources by making a request with the update() or you can - * cancelPreview() to remove the preview altogether. Note that the - * deployment will still exist after you cancel the preview and you must - * separately delete this deployment if you want to remove it. + * If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -3186,16 +2838,7 @@ export namespace deploymentmanager_v2beta { */ deployment?: string; /** - * If set to true, updates the deployment and creates and updates the - * "shell" resources but does not actually alter or instantiate these - * resources. This allows you to preview what your deployment will look - * like. You can use this intent to preview how an update would affect your - * deployment. You must provide a target.config with a configuration if this - * is set to true. After previewing a deployment, you can deploy your - * resources by making a request with the update() or you can - * cancelPreview() to remove the preview altogether. Note that the - * deployment will still exist after you cancel the preview and you must - * separately delete this deployment if you want to remove it. + * If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. */ preview?: boolean; /** @@ -3399,46 +3042,19 @@ export namespace deploymentmanager_v2beta { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3629,46 +3245,19 @@ export namespace deploymentmanager_v2beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -3867,46 +3456,19 @@ export namespace deploymentmanager_v2beta { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -4623,46 +4185,19 @@ export namespace deploymentmanager_v2beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -4678,46 +4213,19 @@ export namespace deploymentmanager_v2beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -4863,46 +4371,19 @@ export namespace deploymentmanager_v2beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ maxResults?: number; /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. */ orderBy?: string; /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ pageToken?: string; /** diff --git a/src/apis/dfareporting/package.json b/src/apis/dfareporting/package.json index 373949f2552..f8b81e9ebe8 100644 --- a/src/apis/dfareporting/package.json +++ b/src/apis/dfareporting/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/dfareporting/v3.1.ts b/src/apis/dfareporting/v3.1.ts index 26cc2345fce..908616271b1 100644 --- a/src/apis/dfareporting/v3.1.ts +++ b/src/apis/dfareporting/v3.1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace dfareporting_v3_1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace dfareporting_v3_1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -155,7 +152,10 @@ export namespace dfareporting_v3_1 { videoFormats: Resource$Videoformats; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries( this.context @@ -256,8 +256,7 @@ export namespace dfareporting_v3_1 { */ accountPermissionIds?: string[]; /** - * Profile for this account. This is a read-only field that can be left - * blank. + * Profile for this account. This is a read-only field that can be left blank. */ accountProfile?: string; /** @@ -269,8 +268,7 @@ export namespace dfareporting_v3_1 { */ activeAdsLimitTier?: string; /** - * Whether to serve creatives with Active View tags. If disabled, - * viewability data will not be available for any impressions. + * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. */ activeViewOptOut?: boolean; /** @@ -282,26 +280,7 @@ export namespace dfareporting_v3_1 { */ countryId?: string; /** - * ID of currency associated with this account. This is a required field. - * Acceptable values are: - "1" for USD - "2" for GBP - * - "3" for ESP - "4" for SEK - "5" for CAD - * - "6" for JPY - "7" for DEM - "8" for AUD - * - "9" for FRF - "10" for ITL - "11" for - * DKK - "12" for NOK - "13" for FIM - "14" - * for ZAR - "15" for IEP - "16" for NLG - - * "17" for EUR - "18" for KRW - "19" for - * TWD - "20" for SGD - "21" for CNY - "22" - * for HKD - "23" for NZD - "24" for MYR - - * "25" for BRL - "26" for PTE - "27" for - * MXP - "28" for CLP - "29" for TRY - "30" - * for ARS - "31" for PEN - "32" for ILS - - * "33" for CHF - "34" for VEF - "35" for - * COP - "36" for GTQ - "37" for PLN - "39" - * for INR - "40" for THB - "41" for IDR - - * "42" for CZK - "43" for RON - "44" for - * HUF - "45" for RUB - "46" for AED - "47" - * for BGN - "48" for HRK - "49" for MXN - - * "50" for NGN + * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ currencyId?: string; /** @@ -317,34 +296,23 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#account". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". */ kind?: string; /** - * Locale of this account. Acceptable values are: - "cs" (Czech) - * - "de" (German) - "en" (English) - - * "en-GB" (English United Kingdom) - "es" (Spanish) - - * "fr" (French) - "it" (Italian) - "ja" - * (Japanese) - "ko" (Korean) - "pl" (Polish) - - * "pt-BR" (Portuguese Brazil) - "ru" (Russian) - - * "sv" (Swedish) - "tr" (Turkish) - "zh-CN" - * (Chinese Simplified) - "zh-TW" (Chinese Traditional) + * Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) */ locale?: string; /** - * Maximum image size allowed for this account, in kilobytes. Value must be - * greater than or equal to 1. + * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. */ maximumImageSize?: string; /** - * Name of this account. This is a required field, and must be less than 128 - * characters long and be globally unique. + * Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. */ name?: string; /** - * Whether campaigns created in this account will be enabled for Nielsen OCR - * reach ratings by default. + * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. */ nielsenOcrEnabled?: boolean; /** @@ -356,8 +324,7 @@ export namespace dfareporting_v3_1 { */ shareReportsWithTwitter?: boolean; /** - * File size limit in kilobytes of Rich Media teaser creatives. Acceptable - * values are 1 to 10240, inclusive. + * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. */ teaserSizeLimit?: string; } @@ -382,21 +349,16 @@ export namespace dfareporting_v3_1 { */ availableAds?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountActiveAdSummary". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". */ kind?: string; } /** - * AccountPermissions contains information about a particular account - * permission. Some features of Campaign Manager require an account permission - * to be present in the account. + * AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account. */ export interface Schema$AccountPermission { /** - * Account profiles associated with this account permission. Possible - * values are: - "ACCOUNT_PROFILE_BASIC" - - * "ACCOUNT_PROFILE_STANDARD" + * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" */ accountProfiles?: string[]; /** @@ -404,8 +366,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermission". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". */ kind?: string; /** @@ -422,8 +383,7 @@ export namespace dfareporting_v3_1 { permissionGroupId?: string; } /** - * AccountPermissionGroups contains a mapping of permission group IDs to - * names. A permission group is a grouping of account permissions. + * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. */ export interface Schema$AccountPermissionGroup { /** @@ -431,8 +391,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". */ kind?: string; /** @@ -449,8 +408,7 @@ export namespace dfareporting_v3_1 { */ accountPermissionGroups?: Schema$AccountPermissionGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". */ kind?: string; } @@ -463,8 +421,7 @@ export namespace dfareporting_v3_1 { */ accountPermissions?: Schema$AccountPermission[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". */ kind?: string; } @@ -477,8 +434,7 @@ export namespace dfareporting_v3_1 { */ accounts?: Schema$Account[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". */ kind?: string; /** @@ -487,19 +443,15 @@ export namespace dfareporting_v3_1 { nextPageToken?: string; } /** - * AccountUserProfiles contains properties of a Campaign Manager user profile. - * This resource is specifically for managing user profiles, whereas - * UserProfiles is for accessing the API. + * AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API. */ export interface Schema$AccountUserProfile { /** - * Account ID of the user profile. This is a read-only field that can be - * left blank. + * Account ID of the user profile. This is a read-only field that can be left blank. */ accountId?: string; /** - * Whether this user profile is active. This defaults to false, and must be - * set true on insert for the user profile to be usable. + * Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. */ active?: boolean; /** @@ -515,9 +467,7 @@ export namespace dfareporting_v3_1 { */ comments?: string; /** - * Email of the user profile. The email addresss must be linked to a Google - * Account. This field is required on insertion and is read-only after - * insertion. + * Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. */ email?: string; /** @@ -525,26 +475,15 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfile". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". */ kind?: string; /** - * Locale of the user profile. This is a required field. Acceptable values - * are: - "cs" (Czech) - "de" (German) - - * "en" (English) - "en-GB" (English United Kingdom) - - * "es" (Spanish) - "fr" (French) - "it" - * (Italian) - "ja" (Japanese) - "ko" (Korean) - - * "pl" (Polish) - "pt-BR" (Portuguese Brazil) - - * "ru" (Russian) - "sv" (Swedish) - "tr" - * (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" - * (Chinese Traditional) + * Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) */ locale?: string; /** - * Name of the user profile. This is a required field. Must be less than 64 - * characters long, must be globally unique, and cannot contain whitespace - * or any of the following characters: "&;"#%,". + * Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,". */ name?: string; /** @@ -552,8 +491,7 @@ export namespace dfareporting_v3_1 { */ siteFilter?: Schema$ObjectFilter; /** - * Subaccount ID of the user profile. This is a read-only field that can be - * left blank. + * Subaccount ID of the user profile. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -561,8 +499,7 @@ export namespace dfareporting_v3_1 { */ traffickerType?: string; /** - * User type of the user profile. This is a read-only field that can be left - * blank. + * User type of the user profile. This is a read-only field that can be left blank. */ userAccessType?: string; /** @@ -583,8 +520,7 @@ export namespace dfareporting_v3_1 { */ accountUserProfiles?: Schema$AccountUserProfile[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfilesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". */ kind?: string; /** @@ -597,8 +533,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Activities { /** - * List of activity filters. The dimension values need to be all either of - * type "dfa:activity" or "dfa:activityGroup". + * List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". */ filters?: Schema$DimensionValue[]; /** @@ -627,8 +562,7 @@ export namespace dfareporting_v3_1 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -636,8 +570,7 @@ export namespace dfareporting_v3_1 { */ archived?: boolean; /** - * Audience segment ID that is being targeted for this ad. Applicable when - * type is AD_SERVING_STANDARD_AD. + * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. */ audienceSegmentId?: string; /** @@ -645,18 +578,15 @@ export namespace dfareporting_v3_1 { */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * Click-through URL for this ad. This is a required field on insertion. - * Applicable when type is AD_SERVING_CLICK_TRACKER. + * Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Click-through URL suffix properties for this ad. Applies to the URL in - * the ad or (if overriding ad properties) the URL in the creative. + * Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative. */ clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; /** @@ -664,14 +594,7 @@ export namespace dfareporting_v3_1 { */ comments?: string; /** - * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. - * DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are only used for existing default - * ads. New mobile placements must be assigned DISPLAY or - * DISPLAY_INTERSTITIAL and default ads created for those placements will be - * limited to those compatibility types. IN_STREAM_VIDEO refers to rendering - * in-stream video ads developed with the VAST standard. + * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -679,22 +602,15 @@ export namespace dfareporting_v3_1 { */ createInfo?: Schema$LastModifiedInfo; /** - * Creative group assignments for this ad. Applicable when type is - * AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number - * is allowed for a maximum of two assignments. + * Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments. */ creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; /** - * Creative rotation for this ad. Applicable when type is - * AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. - * When type is AD_SERVING_DEFAULT_AD, this field should have exactly one - * creativeAssignment. + * Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment. */ creativeRotation?: Schema$CreativeRotation; /** - * Time and day targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ dayPartTargeting?: Schema$DayPartTargeting; /** @@ -702,21 +618,15 @@ export namespace dfareporting_v3_1 { */ defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; /** - * Delivery schedule information for this ad. Applicable when type is - * AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with - * subfields priority and impressionRatio are required on insertion when - * type is AD_SERVING_STANDARD_AD. + * Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD. */ deliverySchedule?: Schema$DeliverySchedule; /** - * Whether this ad is a dynamic click tracker. Applicable when type is - * AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is - * read-only after insert. + * Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. */ dynamicClickTracker?: boolean; /** - * Date and time that this ad should stop serving. Must be later than the - * start time. This is a required field on insertion. + * Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. */ endTime?: string; /** @@ -724,9 +634,7 @@ export namespace dfareporting_v3_1 { */ eventTagOverrides?: Schema$EventTagOverride[]; /** - * Geographical targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ geoTargeting?: Schema$GeoTargeting; /** @@ -734,35 +642,27 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the ID of this ad. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this ad. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Key-value targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ad". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". */ kind?: string; /** - * Language targeting information for this ad. This field must be left blank - * if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ languageTargeting?: Schema$LanguageTargeting; /** - * Information about the most recent modification of this ad. This is a - * read-only field. + * Information about the most recent modification of this ad. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this ad. This is a required field and must be less than 256 - * characters long. + * Name of this ad. This is a required field and must be less than 256 characters long. */ name?: string; /** @@ -770,9 +670,7 @@ export namespace dfareporting_v3_1 { */ placementAssignments?: Schema$PlacementAssignment[]; /** - * Remarketing list targeting expression for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. + * Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ remarketingListExpression?: Schema$ListTargetingExpression; /** @@ -780,44 +678,31 @@ export namespace dfareporting_v3_1 { */ size?: Schema$Size; /** - * Whether this ad is ssl compliant. This is a read-only field that is - * auto-generated when the ad is inserted or updated. + * Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslCompliant?: boolean; /** - * Whether this ad requires ssl. This is a read-only field that is - * auto-generated when the ad is inserted or updated. + * Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslRequired?: boolean; /** - * Date and time that this ad should start serving. If creating an ad, this - * field must be a time in the future. This is a required field on - * insertion. + * Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion. */ startTime?: string; /** - * Subaccount ID of this ad. This is a read-only field that can be left - * blank. + * Subaccount ID of this ad. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Targeting template ID, used to apply preconfigured targeting information - * to this ad. This cannot be set while any of dayPartTargeting, - * geoTargeting, keyValueTargetingExpression, languageTargeting, - * remarketingListExpression, or technologyTargeting are set. Applicable - * when type is AD_SERVING_STANDARD_AD. + * Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. */ targetingTemplateId?: string; /** - * Technology platform targeting information for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. + * Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ technologyTargeting?: Schema$TechnologyTargeting; /** - * Type of ad. This is a required field on insertion. Note that default ads - * (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative - * resource). + * Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). */ type?: string; } @@ -826,27 +711,19 @@ export namespace dfareporting_v3_1 { */ export interface Schema$AdBlockingConfiguration { /** - * Click-through URL used by brand-neutral ads. This is a required field - * when overrideClickThroughUrl is set to true. + * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. */ clickThroughUrl?: string; /** - * ID of a creative bundle to use for this campaign. If set, brand-neutral - * ads will select creatives from this bundle. Otherwise, a default - * transparent pixel will be used. + * ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. */ creativeBundleId?: string; /** - * Whether this campaign has enabled ad blocking. When true, ad blocking is - * enabled for placements in the campaign, but this may be overridden by - * site and placement settings. When false, ad blocking is disabled for all - * placements under the campaign, regardless of site and placement settings. + * Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. */ enabled?: boolean; /** - * Whether the brand-neutral ad's click-through URL comes from the - * campaign's creative bundle or the override URL. Must be set to true - * if ad blocking is enabled and no creative bundle is configured. + * Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. */ overrideClickThroughUrl?: boolean; } @@ -859,8 +736,7 @@ export namespace dfareporting_v3_1 { */ ads?: Schema$Ad[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#adsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". */ kind?: string; /** @@ -877,11 +753,7 @@ export namespace dfareporting_v3_1 { */ comment?: string; /** - * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop, mobile devices or in mobile apps for regular - * or interstitial ads respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in - * in-stream video ads developed with the VAST standard. + * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -889,8 +761,7 @@ export namespace dfareporting_v3_1 { */ height?: string; /** - * ID of the placement from an external platform that is linked to this ad - * slot. + * ID of the placement from an external platform that is linked to this ad slot. */ linkedPlacementId?: string; /** @@ -915,24 +786,19 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Advertiser { /** - * Account ID of this advertiser.This is a read-only field that can be left - * blank. + * Account ID of this advertiser.This is a read-only field that can be left blank. */ accountId?: string; /** - * ID of the advertiser group this advertiser belongs to. You can group - * advertisers for reporting purposes, allowing you to see aggregated - * information for all advertisers in each group. + * ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. */ advertiserGroupId?: string; /** - * Suffix added to click-through URL of ad creative associations under this - * advertiser. Must be less than 129 characters long. + * Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. */ clickThroughUrlSuffix?: string; /** - * ID of the click-through event tag to apply by default to the landing - * pages of this advertiser's campaigns. + * ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. */ defaultClickThroughEventTagId?: string; /** @@ -940,20 +806,11 @@ export namespace dfareporting_v3_1 { */ defaultEmail?: string; /** - * Floodlight configuration ID of this advertiser. The floodlight - * configuration ID will be created automatically, so on insert this field - * should be left blank. This field can be set to another advertiser's - * floodlight configuration ID in order to share that advertiser's - * floodlight configuration with this advertiser, so long as: - This - * advertiser's original floodlight configuration is not already - * associated with floodlight activities or floodlight activity groups. - - * This advertiser's original floodlight configuration is not already - * shared with another advertiser. + * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** @@ -961,27 +818,19 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the ID of this advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiser". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". */ kind?: string; /** - * Name of this advertiser. This is a required field and must be less than - * 256 characters long and unique among advertisers of the same account. + * Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. */ name?: string; /** - * Original floodlight configuration before any sharing occurred. Set the - * floodlightConfigurationId of this advertiser to - * originalFloodlightConfigurationId to unshare the advertiser's current - * floodlight configuration. You cannot unshare an advertiser's - * floodlight configuration if the shared configuration has activities - * associated with any campaign or placement. + * Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. */ originalFloodlightConfigurationId?: string; /** @@ -989,8 +838,7 @@ export namespace dfareporting_v3_1 { */ status?: string; /** - * Subaccount ID of this advertiser.This is a read-only field that can be - * left blank. + * Subaccount ID of this advertiser.This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -999,13 +847,11 @@ export namespace dfareporting_v3_1 { suspended?: boolean; } /** - * Groups advertisers together so that reports can be generated for the entire - * group at once. + * Groups advertisers together so that reports can be generated for the entire group at once. */ export interface Schema$AdvertiserGroup { /** - * Account ID of this advertiser group. This is a read-only field that can - * be left blank. + * Account ID of this advertiser group. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1013,14 +859,11 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". */ kind?: string; /** - * Name of this advertiser group. This is a required field and must be less - * than 256 characters long and unique among advertiser groups of the same - * account. + * Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. */ name?: string; } @@ -1033,8 +876,7 @@ export namespace dfareporting_v3_1 { */ advertiserGroups?: Schema$AdvertiserGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". */ kind?: string; /** @@ -1047,8 +889,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$AdvertiserLandingPagesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserLandingPagesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". */ kind?: string; /** @@ -1069,8 +910,7 @@ export namespace dfareporting_v3_1 { */ advertisers?: Schema$Advertiser[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertisersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". */ kind?: string; /** @@ -1083,9 +923,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$AudienceSegment { /** - * Weight allocated to this segment. The weight assigned will be understood - * in proportion to the weights assigned to other segments in the same - * segment group. Acceptable values are 1 to 1000, inclusive. + * Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. */ allocation?: number; /** @@ -1093,8 +931,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Name of this audience segment. This is a required field and must be less - * than 65 characters long. + * Name of this audience segment. This is a required field and must be less than 65 characters long. */ name?: string; } @@ -1103,18 +940,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$AudienceSegmentGroup { /** - * Audience segments assigned to this group. The number of segments must be - * between 2 and 100. + * Audience segments assigned to this group. The number of segments must be between 2 and 100. */ audienceSegments?: Schema$AudienceSegment[]; /** - * ID of this audience segment group. This is a read-only, auto-generated - * field. + * ID of this audience segment group. This is a read-only, auto-generated field. */ id?: string; /** - * Name of this audience segment group. This is a required field and must be - * less than 65 characters long. + * Name of this audience segment group. This is a required field and must be less than 65 characters long. */ name?: string; } @@ -1123,8 +957,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Browser { /** - * ID referring to this grouping of browser and version numbers. This is the - * ID used for targeting. + * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. */ browserVersionId?: string; /** @@ -1132,30 +965,15 @@ export namespace dfareporting_v3_1 { */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browser". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". */ kind?: string; /** - * Major version number (leftmost number) of this browser. For example, for - * Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) - * may be used to target any version number, and a question mark (?) may be - * used to target cases where the version number cannot be identified. For - * example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so - * on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets - * cases where the ad server knows the browser is Firefox but can't tell - * which version it is. + * Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. */ majorVersion?: string; /** - * Minor version number (number after first dot on left) of this browser. - * For example, for Chrome 5.0.375.86 beta, this field should be set to 0. - * An asterisk (*) may be used to target any version number, and a question - * mark (?) may be used to target cases where the version number cannot be - * identified. For example, Chrome *.* targets any version of Chrome: - * 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but - * not 4.0. Firefox ?.? targets cases where the ad server knows the browser - * is Firefox but can't tell which version it is. + * Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. */ minorVersion?: string; /** @@ -1172,8 +990,7 @@ export namespace dfareporting_v3_1 { */ browsers?: Schema$Browser[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browsersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". */ kind?: string; } @@ -1182,8 +999,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Campaign { /** - * Account ID of this campaign. This is a read-only field that can be left - * blank. + * Account ID of this campaign. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1203,8 +1019,7 @@ export namespace dfareporting_v3_1 { */ advertiserId?: string; /** - * Dimension value for the advertiser ID of this campaign. This is a - * read-only, auto-generated field. + * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -1212,13 +1027,11 @@ export namespace dfareporting_v3_1 { */ archived?: boolean; /** - * Audience segment groups assigned to this campaign. Cannot have more than - * 300 segment groups. + * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. */ audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; /** - * Billing invoice code included in the Campaign Manager client billing - * invoices associated with the campaign. + * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. */ billingInvoiceCode?: string; /** @@ -1226,13 +1039,11 @@ export namespace dfareporting_v3_1 { */ clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; /** - * Arbitrary comments about this campaign. Must be less than 256 characters - * long. + * Arbitrary comments about this campaign. Must be less than 256 characters long. */ comment?: string; /** - * Information about the creation of this campaign. This is a read-only - * field. + * Information about the creation of this campaign. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** @@ -1252,18 +1063,11 @@ export namespace dfareporting_v3_1 { */ defaultLandingPageId?: string; /** - * Date on which the campaign will stop running. On insert, the end date - * must be today or a future date. The end date must be later than or be the - * same as the start date. If, for example, you set 6/25/2015 as both the - * start and end dates, the effective campaign run date is just that day - * only, 6/25/2015. The hours, minutes, and seconds of the end date should - * not be set, as doing so will result in an error. This is a required - * field. + * Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field. */ endDate?: string; /** - * Overrides that can be used to activate or deactivate advertiser event - * tags. + * Overrides that can be used to activate or deactivate advertiser event tags. */ eventTagOverrides?: Schema$EventTagOverride[]; /** @@ -1275,18 +1079,15 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the ID of this campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaign". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". */ kind?: string; /** - * Information about the most recent modification of this campaign. This is - * a read-only field. + * Information about the most recent modification of this campaign. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** @@ -1294,8 +1095,7 @@ export namespace dfareporting_v3_1 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Name of this campaign. This is a required field and must be less than 256 - * characters long and unique among campaigns of the same advertiser. + * Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. */ name?: string; /** @@ -1303,14 +1103,11 @@ export namespace dfareporting_v3_1 { */ nielsenOcrEnabled?: boolean; /** - * Date on which the campaign starts running. The start date can be any - * date. The hours, minutes, and seconds of the start date should not be - * set, as doing so will result in an error. This is a required field. + * Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field. */ startDate?: string; /** - * Subaccount ID of this campaign. This is a read-only field that can be - * left blank. + * Subaccount ID of this campaign. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -1323,13 +1120,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CampaignCreativeAssociation { /** - * ID of the creative associated with the campaign. This is a required - * field. + * ID of the creative associated with the campaign. This is a required field. */ creativeId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociation". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". */ kind?: string; } @@ -1342,8 +1137,7 @@ export namespace dfareporting_v3_1 { */ campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociationsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". */ kind?: string; /** @@ -1360,8 +1154,7 @@ export namespace dfareporting_v3_1 { */ campaigns?: Schema$Campaign[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". */ kind?: string; /** @@ -1394,8 +1187,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLog". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". */ kind?: string; /** @@ -1403,8 +1195,7 @@ export namespace dfareporting_v3_1 { */ newValue?: string; /** - * ID of the object of this change log. The object could be a campaign, - * placement, ad, or other type. + * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. */ objectId?: string; /** @@ -1420,9 +1211,7 @@ export namespace dfareporting_v3_1 { */ subaccountId?: string; /** - * Transaction ID of this change log. When a single API call results in many - * changes, each change will have a separate ID in the change log but will - * share the same transactionId. + * Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. */ transactionId?: string; /** @@ -1443,8 +1232,7 @@ export namespace dfareporting_v3_1 { */ changeLogs?: Schema$ChangeLog[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLogsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". */ kind?: string; /** @@ -1461,8 +1249,7 @@ export namespace dfareporting_v3_1 { */ cities?: Schema$City[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#citiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". */ kind?: string; } @@ -1479,13 +1266,11 @@ export namespace dfareporting_v3_1 { */ countryDartId?: string; /** - * DART ID of this city. This is the ID used for targeting and generating - * reports. + * DART ID of this city. This is the ID used for targeting and generating reports. */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#city". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". */ kind?: string; /** @@ -1514,20 +1299,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ClickTag { /** - * Parameter value for the specified click tag. This field contains a - * click-through url. + * Parameter value for the specified click tag. This field contains a click-through url. */ clickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * Advertiser event name associated with the click tag. This field is used - * by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. + * Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ eventName?: string; /** - * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY - * creative assets, this field must match the value of the creative - * asset's creativeAssetId.name field. + * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. */ name?: string; } @@ -1536,18 +1316,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ClickThroughUrl { /** - * Read-only convenience field representing the actual URL that will be used - * for this click-through. The URL is computed as follows: - If - * defaultLandingPage is enabled then the campaign's default landing - * page URL is assigned to this field. - If defaultLandingPage is not - * enabled and a landingPageId is specified then that landing page's URL - * is assigned to this field. - If neither of the above cases apply, then - * the customClickThroughUrl is assigned to this field. + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. */ computedClickThroughUrl?: string; /** - * Custom click-through URL. Applicable if the defaultLandingPage field is - * set to false and the landingPageId field is left unset. + * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. */ customClickThroughUrl?: string; /** @@ -1555,8 +1328,7 @@ export namespace dfareporting_v3_1 { */ defaultLandingPage?: boolean; /** - * ID of the landing page for the click-through URL. Applicable if the - * defaultLandingPage field is set to false. + * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. */ landingPageId?: string; } @@ -1565,13 +1337,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ClickThroughUrlSuffixProperties { /** - * Click-through URL suffix to apply to all ads in this entity's scope. - * Must be less than 128 characters long. + * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. */ clickThroughUrlSuffix?: string; /** - * Whether this entity should override the inherited click-through URL - * suffix with its own defined value. + * Whether this entity should override the inherited click-through URL suffix with its own defined value. */ overrideInheritedSuffix?: boolean; } @@ -1597,8 +1367,7 @@ export namespace dfareporting_v3_1 { */ companionsDisabled?: boolean; /** - * Whitelist of companion sizes to be served to this placement. Set this - * list to null or empty to serve all companion sizes. + * Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. */ enabledSizes?: Schema$Size[]; /** @@ -1606,8 +1375,7 @@ export namespace dfareporting_v3_1 { */ imageOnly?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#companionSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". */ kind?: string; } @@ -1616,13 +1384,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CompatibleFields { /** - * Contains items that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". + * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "FLOODLIGHT". + * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". */ floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; /** @@ -1630,25 +1396,20 @@ export namespace dfareporting_v3_1 { */ kind?: string; /** - * Contains items that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". + * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "REACH". + * Contains items that are compatible to be selected for a report of type "REACH". */ reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "STANDARD". + * Contains items that are compatible to be selected for a report of type "STANDARD". */ reportCompatibleFields?: Schema$ReportCompatibleFields; } /** - * Contains information about an internet connection type that can be targeted - * by ads. Clients can use the connection type to target mobile vs. broadband - * users. + * Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. */ export interface Schema$ConnectionType { /** @@ -1656,8 +1417,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionType". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". */ kind?: string; /** @@ -1674,8 +1434,7 @@ export namespace dfareporting_v3_1 { */ connectionTypes?: Schema$ConnectionType[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionTypesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". */ kind?: string; } @@ -1688,8 +1447,7 @@ export namespace dfareporting_v3_1 { */ contentCategories?: Schema$ContentCategory[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategoriesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". */ kind?: string; /** @@ -1698,13 +1456,11 @@ export namespace dfareporting_v3_1 { nextPageToken?: string; } /** - * Organizes placements according to the contents of their associated - * webpages. + * Organizes placements according to the contents of their associated webpages. */ export interface Schema$ContentCategory { /** - * Account ID of this content category. This is a read-only field that can - * be left blank. + * Account ID of this content category. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1712,20 +1468,16 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategory". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". */ kind?: string; /** - * Name of this content category. This is a required field and must be less - * than 256 characters long and unique among content categories of the same - * account. + * Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. */ name?: string; } /** - * A Conversion represents when a user successfully performs a desired action - * after seeing an ad. + * A Conversion represents when a user successfully performs a desired action after seeing an ad. */ export interface Schema$Conversion { /** @@ -1737,22 +1489,11 @@ export namespace dfareporting_v3_1 { */ customVariables?: Schema$CustomFloodlightVariable[]; /** - * The alphanumeric encrypted user ID. When set, encryptionInfo should also - * be specified. This field is mutually exclusive with - * encryptedUserIdCandidates[], mobileDeviceId and gclid. This or - * encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required - * field. + * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. */ encryptedUserId?: string; /** - * A list of the alphanumeric encrypted user IDs. Any user ID with exposure - * prior to the conversion timestamp will be used in the inserted - * conversion. If no such user ID is found then the conversion will be - * rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo - * should also be specified. This field may only be used when calling - * batchinsert; it is not supported by batchupdate. This field is mutually - * exclusive with encryptedUserId, mobileDeviceId and gclid. This or - * encryptedUserId or mobileDeviceId or gclid is a required field. + * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. */ encryptedUserIdCandidates?: string[]; /** @@ -1764,33 +1505,23 @@ export namespace dfareporting_v3_1 { */ floodlightConfigurationId?: string; /** - * The Google click ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or - * encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a - * required field. + * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. */ gclid?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversion". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". */ kind?: string; /** - * Whether Limit Ad Tracking is enabled. When set to true, the conversion - * will be used for reporting but not targeting. This will prevent - * remarketing. + * Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. */ limitAdTracking?: boolean; /** - * The mobile device ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and gclid. This or - * encryptedUserId or encryptedUserIdCandidates[] or gclid is a required - * field. + * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. */ mobileDeviceId?: string; /** - * The ordinal of the conversion. Use this field to control how conversions - * of the same user and day are de-duplicated. This is a required field. + * The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. */ ordinal?: string; /** @@ -1798,8 +1529,7 @@ export namespace dfareporting_v3_1 { */ quantity?: string; /** - * The timestamp of conversion, in Unix epoch micros. This is a required - * field. + * The timestamp of conversion, in Unix epoch micros. This is a required field. */ timestampMicros?: string; /** @@ -1808,8 +1538,7 @@ export namespace dfareporting_v3_1 { value?: number; } /** - * The error code and description for a conversion that failed to insert or - * update. + * The error code and description for a conversion that failed to insert or update. */ export interface Schema$ConversionError { /** @@ -1817,8 +1546,7 @@ export namespace dfareporting_v3_1 { */ code?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionError". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". */ kind?: string; /** @@ -1835,14 +1563,11 @@ export namespace dfareporting_v3_1 { */ conversions?: Schema$Conversion[]; /** - * Describes how encryptedUserId or encryptedUserIdCandidates[] is - * encrypted. This is a required field if encryptedUserId or - * encryptedUserIdCandidates[] is used. + * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. */ encryptionInfo?: Schema$EncryptionInfo; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertRequest". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". */ kind?: string; } @@ -1855,13 +1580,11 @@ export namespace dfareporting_v3_1 { */ hasFailures?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". */ kind?: string; /** - * The insert status of each conversion. Statuses are returned in the same - * order that conversions are inserted. + * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. */ status?: Schema$ConversionStatus[]; } @@ -1874,13 +1597,11 @@ export namespace dfareporting_v3_1 { */ conversions?: Schema$Conversion[]; /** - * Describes how encryptedUserId is encrypted. This is a required field if - * encryptedUserId is used. + * Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. */ encryptionInfo?: Schema$EncryptionInfo; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateRequest". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". */ kind?: string; } @@ -1893,19 +1614,16 @@ export namespace dfareporting_v3_1 { */ hasFailures?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". */ kind?: string; /** - * The update status of each conversion. Statuses are returned in the same - * order that conversions are updated. + * The update status of each conversion. Statuses are returned in the same order that conversions are updated. */ status?: Schema$ConversionStatus[]; } /** - * The original conversion that was inserted or updated and whether there were - * any errors. + * The original conversion that was inserted or updated and whether there were any errors. */ export interface Schema$ConversionStatus { /** @@ -1917,8 +1635,7 @@ export namespace dfareporting_v3_1 { */ errors?: Schema$ConversionError[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionStatus". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". */ kind?: string; } @@ -1931,8 +1648,7 @@ export namespace dfareporting_v3_1 { */ countries?: Schema$Country[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#countriesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". */ kind?: string; } @@ -1945,13 +1661,11 @@ export namespace dfareporting_v3_1 { */ countryCode?: string; /** - * DART ID of this country. This is the ID used for targeting and generating - * reports. + * DART ID of this country. This is the ID used for targeting and generating reports. */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#country". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". */ kind?: string; /** @@ -1968,9 +1682,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Creative { /** - * Account ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. + * Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. */ accountId?: string; /** @@ -1978,27 +1690,19 @@ export namespace dfareporting_v3_1 { */ active?: boolean; /** - * Ad parameters user for VPAID creative. This is a read-only field. - * Applicable to the following creative types: all VPAID. + * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. */ adParameters?: string; /** - * Keywords for a Rich Media creative. Keywords let you customize the - * creative settings of a Rich Media ad running on your site without having - * to contact the advertiser. You can use keywords to dynamically change the - * look or functionality of a creative. Applicable to the following creative - * types: all RICH_MEDIA, and all VPAID. + * Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ adTagKeys?: string[]; /** - * Advertiser ID of this creative. This is a required field. Applicable to - * all creative types. + * Advertiser ID of this creative. This is a required field. Applicable to all creative types. */ advertiserId?: string; /** - * Whether script access is allowed for this creative. This is a read-only - * and deprecated field which will automatically be set to true on update. - * Applicable to the following creative types: FLASH_INPAGE. + * Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. */ allowScriptAccess?: boolean; /** @@ -2006,125 +1710,67 @@ export namespace dfareporting_v3_1 { */ archived?: boolean; /** - * Type of artwork used for the creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. + * Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ artworkType?: string; /** - * Source application where creative was authored. Presently, only DBM - * authored creatives will have this field set. Applicable to all creative - * types. + * Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. */ authoringSource?: string; /** - * Authoring tool for HTML5 banner creatives. This is a read-only field. - * Applicable to the following creative types: HTML5_BANNER. + * Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ authoringTool?: string; /** - * Whether images are automatically advanced for image gallery creatives. - * Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. */ autoAdvanceImages?: boolean; /** - * The 6-character HTML color code, beginning with #, for the background of - * the window area where the Flash file is displayed. Default is white. - * Applicable to the following creative types: FLASH_INPAGE. + * The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. */ backgroundColor?: string; /** - * Click-through URL for backup image. Applicable to ENHANCED_BANNER when - * the primary asset type is not HTML_IMAGE. + * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. */ backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * List of feature dependencies that will cause a backup image to be served - * if the browser that serves the ad does not support them. Feature - * dependencies are features that a browser must be able to support in order - * to render your HTML5 creative asset correctly. This field is initially - * auto-generated to contain all features detected by Campaign Manager for - * all the assets of this creative and can then be modified by the client. - * To reset this field, copy over all the creativeAssets' detected - * features. Applicable to the following creative types: HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageFeatures?: string[]; /** - * Reporting label used for HTML5 banner backup image. Applicable to the - * following creative types: DISPLAY when the primary asset type is not - * HTML_IMAGE. + * Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageReportingLabel?: string; /** - * Target window for backup image. Applicable to the following creative - * types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. + * Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageTargetWindow?: Schema$TargetWindow; /** - * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER - * creatives, this is a subset of detected click tags for the assets - * associated with this creative. After creating a flash asset, detected - * click tags will be returned in the creativeAssetMetadata. When inserting - * the creative, populate the creative clickTags field using the - * creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY - * creatives, there should be exactly one entry in this list for each image - * creative asset. A click tag is matched with a corresponding creative - * asset by matching the clickTag.name field with the - * creativeAsset.assetIdentifier.name field. Applicable to the following - * creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ clickTags?: Schema$ClickTag[]; /** - * Industry standard ID assigned to creative for reach and frequency. - * Applicable to INSTREAM_VIDEO_REDIRECT creatives. + * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. */ commercialId?: string; /** - * List of companion creatives assigned to an in-Stream video creative. - * Acceptable values include IDs of existing flash and image creatives. - * Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO - * and all INSTREAM_VIDEO with dynamicAssetSelection set to false. + * List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. */ companionCreatives?: string[]; /** - * Compatibilities associated with this creative. This is a read-only field. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. - * Only pre-existing creatives may have these compatibilities since new - * creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL - * instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads - * developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in - * in-stream audio ads developed with the VAST standard. Applicable to all - * creative types. Acceptable values are: - "APP" - - * "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - - * "IN_STREAM_AUDIO" - "DISPLAY" - - * "DISPLAY_INTERSTITIAL" + * Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" */ compatibility?: string[]; /** - * Whether Flash assets associated with the creative need to be - * automatically converted to HTML5. This flag is enabled by default and - * users can choose to disable it if they don't want the system to - * generate and use HTML5 asset for this creative. Applicable to the - * following creative type: FLASH_INPAGE. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. + * Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ convertFlashToHtml5?: boolean; /** - * List of counter events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. + * List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. */ counterCustomEvents?: Schema$CreativeCustomEvent[]; /** - * Assets associated with a creative. Applicable to all but the following - * creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and - * REDIRECT + * Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT */ creativeAssets?: Schema$CreativeAsset[]; /** @@ -2132,251 +1778,163 @@ export namespace dfareporting_v3_1 { */ creativeAssetSelection?: Schema$CreativeAssetSelection; /** - * Creative field assignments for this creative. Applicable to all creative - * types. + * Creative field assignments for this creative. Applicable to all creative types. */ creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; /** - * Custom key-values for a Rich Media creative. Key-values let you customize - * the creative settings of a Rich Media ad running on your site without - * having to contact the advertiser. You can use key-values to dynamically - * change the look or functionality of a creative. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. + * Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ customKeyValues?: string[]; /** - * Set this to true to enable the use of rules to target individual assets - * in this creative. When set to true creativeAssetSelection must be set. - * This also controls asset-level companions. When this is true, companion - * creatives should be assigned to creative assets. Learn more. Applicable - * to INSTREAM_VIDEO creatives. + * Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. */ dynamicAssetSelection?: boolean; /** - * List of exit events configured for the creative. For DISPLAY and - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags, For DISPLAY, an event is also created from the - * backupImageReportingLabel. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. + * List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ exitCustomEvents?: Schema$CreativeCustomEvent[]; /** - * OpenWindow FSCommand of this creative. This lets the SWF file communicate - * with either Flash Player or the program hosting Flash Player, such as a - * web browser. This is only triggered if allowScriptAccess field is true. - * Applicable to the following creative types: FLASH_INPAGE. + * OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE. */ fsCommand?: Schema$FsCommand; /** - * HTML code for the creative. This is a required field when applicable. - * This field is ignored if htmlCodeLocked is true. Applicable to the - * following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and - * all RICH_MEDIA. + * HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. */ htmlCode?: string; /** - * Whether HTML code is generated by Campaign Manager or manually entered. - * Set to true to ignore changes to htmlCode. Applicable to the following - * creative types: FLASH_INPAGE and HTML5_BANNER. + * Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. */ htmlCodeLocked?: boolean; /** - * ID of this creative. This is a read-only, auto-generated field. - * Applicable to all creative types. + * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. */ id?: string; /** - * Dimension value for the ID of this creative. This is a read-only field. - * Applicable to all creative types. + * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creative". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". */ kind?: string; /** - * Creative last modification information. This is a read-only field. - * Applicable to all creative types. + * Creative last modification information. This is a read-only field. Applicable to all creative types. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Latest Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. + * Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ latestTraffickedCreativeId?: string; /** - * Description of the audio or video ad. Applicable to the following - * creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. + * Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. */ mediaDescription?: string; /** - * Creative audio or video duration in seconds. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO, - * INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. + * Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. */ mediaDuration?: number; /** - * Name of the creative. This is a required field and must be less than 256 - * characters long. Applicable to all creative types. + * Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. */ name?: string; /** - * Override CSS value for rich media creatives. Applicable to the following - * creative types: all RICH_MEDIA. + * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. */ overrideCss?: string; /** - * The asset ID of the polite load image asset. Applicable to the creative - * type: DISPLAY. + * The asset ID of the polite load image asset. Applicable to the creative type: DISPLAY. */ politeLoadAssetId?: string; /** - * Amount of time to play the video before counting a view. Applicable to - * the following creative types: all INSTREAM_VIDEO. + * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. */ progressOffset?: Schema$VideoOffset; /** - * URL of hosted image or hosted video or another ad tag. For - * INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect - * URL. The standard for a VAST (Video Ad Serving Template) ad response - * allows for a redirect link to another VAST 2.0 or 3.0 call. This is a - * required field when applicable. Applicable to the following creative - * types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, - * INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + * URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT */ redirectUrl?: string; /** - * ID of current rendering version. This is a read-only field. Applicable to - * all creative types. + * ID of current rendering version. This is a read-only field. Applicable to all creative types. */ renderingId?: string; /** - * Dimension value for the rendering ID of this creative. This is a - * read-only field. Applicable to all creative types. + * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. */ renderingIdDimensionValue?: Schema$DimensionValue; /** - * The minimum required Flash plugin version for this creative. For - * example, 11.2.202.235. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. + * The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ requiredFlashPluginVersion?: string; /** - * The internal Flash version for this creative as calculated by Studio. - * This is a read-only field. Applicable to the following creative types: - * FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when - * the primary asset type is not HTML_IMAGE. + * The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ requiredFlashVersion?: number; /** - * Size associated with this creative. When inserting or updating a creative - * either the size ID field or size width and height fields can be used. - * This is a required field when applicable; however for IMAGE, FLASH_INPAGE - * creatives, and for DISPLAY creatives with a primary asset of type - * HTML_IMAGE, if left blank, this field will be automatically set using the - * actual size of the associated image assets. Applicable to the following - * creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, - * HTML5_BANNER, IMAGE, and all RICH_MEDIA. + * Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. */ size?: Schema$Size; /** - * Amount of time to play the video before the skip button appears. - * Applicable to the following creative types: all INSTREAM_VIDEO. + * Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO. */ skipOffset?: Schema$VideoOffset; /** - * Whether the user can choose to skip the creative. Applicable to the - * following creative types: all INSTREAM_VIDEO and all VPAID. + * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. */ skippable?: boolean; /** - * Whether the creative is SSL-compliant. This is a read-only field. - * Applicable to all creative types. + * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. */ sslCompliant?: boolean; /** - * Whether creative should be treated as SSL compliant even if the system - * scan shows it's not. Applicable to all creative types. + * Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. */ sslOverride?: boolean; /** - * Studio advertiser ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. + * Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioAdvertiserId?: string; /** - * Studio creative ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. + * Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioCreativeId?: string; /** - * Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. + * Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioTraffickedCreativeId?: string; /** - * Subaccount ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. + * Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. */ subaccountId?: string; /** - * Third-party URL used to record backup image impressions. Applicable to - * the following creative types: all RICH_MEDIA. + * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. */ thirdPartyBackupImageImpressionsUrl?: string; /** - * Third-party URL used to record rich media impressions. Applicable to the - * following creative types: all RICH_MEDIA. + * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. */ thirdPartyRichMediaImpressionsUrl?: string; /** - * Third-party URLs for tracking in-stream creative events. Applicable to - * the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and - * all VPAID. + * Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. */ thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; /** - * List of timer events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset is not HTML_IMAGE. + * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. */ timerCustomEvents?: Schema$CreativeCustomEvent[]; /** - * Combined size of all creative assets. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. + * Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ totalFileSize?: string; /** - * Type of this creative. This is a required field. Applicable to all - * creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only - * used for existing creatives. New creatives should use DISPLAY as a - * replacement for these types. + * Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. */ type?: string; /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. */ universalAdId?: Schema$UniversalAdId; /** - * The version number helps you keep track of multiple versions of your - * creative in your reports. The version number will always be - * auto-generated during insert operations to start at 1. For tracking - * creatives the version cannot be incremented and will always remain at 1. - * For all other creative types the version can be incremented only by 1 - * during update operations. In addition, the version will be automatically - * incremented by 1 when undergoing Rich Media creative merging. Applicable - * to all creative types. + * The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. */ version?: number; } @@ -2385,155 +1943,107 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeAsset { /** - * Whether ActionScript3 is enabled for the flash asset. This is a read-only - * field. Applicable to the following creative type: FLASH_INPAGE. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ actionScript3?: boolean; /** - * Whether the video or audio asset is active. This is a read-only field for - * VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative - * types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + * Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ active?: boolean; /** - * Possible alignments for an asset. This is a read-only field. Applicable - * to the following creative types: - * RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. + * Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. */ alignment?: string; /** - * Artwork type of rich media creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ artworkType?: string; /** - * Identifier of this asset. This is the same identifier returned during - * creative asset insert operation. This is a required field. Applicable to - * all but the following creative types: all REDIRECT and TRACKING_TEXT. + * Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ assetIdentifier?: Schema$CreativeAssetId; /** - * Exit event configured for the backup image. Applicable to the following - * creative types: all RICH_MEDIA. + * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. */ backupImageExit?: Schema$CreativeCustomEvent; /** - * Detected bit-rate for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ bitRate?: number; /** - * Rich media child asset type. This is a read-only field. Applicable to the - * following creative types: all VPAID. + * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. */ childAssetType?: string; /** - * Size of an asset when collapsed. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID. Additionally, - * applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or - * ASSET_DISPLAY_TYPE_PEEL_DOWN. + * Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. */ collapsedSize?: Schema$Size; /** - * List of companion creatives assigned to an in-stream video creative - * asset. Acceptable values include IDs of existing flash and image - * creatives. Applicable to INSTREAM_VIDEO creative type with - * dynamicAssetSelection set to true. + * List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. */ companionCreativeIds?: string[]; /** - * Custom start time in seconds for making the asset visible. Applicable to - * the following creative types: all RICH_MEDIA. Value must be greater than - * or equal to 0. + * Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. */ customStartTimeValue?: number; /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. Applicable to the following - * creative types: HTML5_BANNER. Applicable to DISPLAY when the primary - * asset type is not HTML_IMAGE. + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ detectedFeatures?: string[]; /** - * Type of rich media asset. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA. + * Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ displayType?: string; /** - * Duration in seconds for which an asset will be displayed. Applicable to - * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and - * VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. + * Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. */ duration?: number; /** - * Duration type for which an asset will be displayed. Applicable to the - * following creative types: all RICH_MEDIA. + * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. */ durationType?: string; /** - * Detected expanded dimension for video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + * Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ expandedDimension?: Schema$Size; /** - * File size associated with this creative asset. This is a read-only field. - * Applicable to all but the following creative types: all REDIRECT and - * TRACKING_TEXT. + * File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ fileSize?: string; /** - * Flash version of the asset. This is a read-only field. Applicable to the - * following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ flashVersion?: number; /** - * Whether to hide Flash objects flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. + * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ hideFlashObjects?: boolean; /** - * Whether to hide selection boxes flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. + * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ hideSelectionBoxes?: boolean; /** - * Whether the asset is horizontally locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ horizontallyLocked?: boolean; /** - * Numeric ID of this creative asset. This is a required field and should - * not be modified. Applicable to all but the following creative types: all - * REDIRECT and TRACKING_TEXT. + * Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ id?: string; /** - * Dimension value for the ID of the asset. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the asset. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Detected duration for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ mediaDuration?: number; /** - * Detected MIME type for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ mimeType?: string; /** - * Offset position for an asset in collapsed mode. This is a read-only - * field. Applicable to the following creative types: all RICH_MEDIA and all - * VPAID. Additionally, only applicable to assets whose displayType is - * ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + * Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. */ offset?: Schema$OffsetPosition; /** @@ -2541,133 +2051,75 @@ export namespace dfareporting_v3_1 { */ orientation?: string; /** - * Whether the backup asset is original or changed by the user in Campaign - * Manager. Applicable to the following creative types: all RICH_MEDIA. + * Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. */ originalBackup?: boolean; /** - * Offset position for an asset. Applicable to the following creative types: - * all RICH_MEDIA. + * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. */ position?: Schema$OffsetPosition; /** - * Offset left unit for an asset. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA. + * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ positionLeftUnit?: string; /** - * Offset top unit for an asset. This is a read-only field if the asset - * displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following - * creative types: all RICH_MEDIA. + * Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. */ positionTopUnit?: string; /** - * Progressive URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. + * Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ progressiveServingUrl?: string; /** - * Whether the asset pushes down other content. Applicable to the following - * creative types: all RICH_MEDIA. Additionally, only applicable when the - * asset offsets are 0, the collapsedSize.width matches size.width, and the - * collapsedSize.height is less than size.height. + * Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. */ pushdown?: boolean; /** - * Pushdown duration in seconds for an asset. Applicable to the following - * creative types: all RICH_MEDIA.Additionally, only applicable when the - * asset pushdown field is true, the offsets are 0, the collapsedSize.width - * matches size.width, and the collapsedSize.height is less than - * size.height. Acceptable values are 0 to 9.99, inclusive. + * Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. */ pushdownDuration?: number; /** - * Role of the asset in relation to creative. Applicable to all but the - * following creative types: all REDIRECT and TRACKING_TEXT. This is a - * required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, - * IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple - * primary assets), and all VPAID creatives. BACKUP_IMAGE applies to - * FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - * ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. - * OTHER refers to assets from sources other than Campaign Manager, such as - * Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID - * creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign - * Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO - * creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign - * Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and - * VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign - * Manager representation of child asset videos from Studio, and is - * applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or - * removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, - * PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked - * active serve as backup in case the VPAID creative cannot be served. Only - * PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or - * VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by - * the user in Campaign Manager and is applicable to INSTREAM_AUDIO - * creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign - * Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO - * creatives. + * Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. */ role?: string; /** - * Size associated with this creative asset. This is a required field when - * applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, - * this field will be automatically set using the actual size of the - * associated image asset. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all - * RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not - * HTML_IMAGE. + * Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ size?: Schema$Size; /** - * Whether the asset is SSL-compliant. This is a read-only field. Applicable - * to all but the following creative types: all REDIRECT and TRACKING_TEXT. + * Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ sslCompliant?: boolean; /** - * Initial wait time type before making the asset visible. Applicable to the - * following creative types: all RICH_MEDIA. + * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. */ startTimeType?: string; /** - * Streaming URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. + * Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ streamingServingUrl?: string; /** - * Whether the asset is transparent. Applicable to the following creative - * types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + * Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. */ transparency?: boolean; /** - * Whether the asset is vertically locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ verticallyLocked?: boolean; /** - * Window mode options for flash assets. Applicable to the following - * creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, - * RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and - * RICH_MEDIA_INPAGE_FLOATING. + * Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. */ windowMode?: string; /** - * zIndex value of an asset. Applicable to the following creative types: all - * RICH_MEDIA.Additionally, only applicable to assets whose displayType is - * NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or - * ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to - * 999999999, inclusive. + * zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. */ zIndex?: number; /** - * File name of zip file. This is a read-only field. Applicable to the - * following creative types: HTML5_BANNER. + * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ zipFilename?: string; /** - * Size of zip file. This is a read-only field. Applicable to the following - * creative types: HTML5_BANNER. + * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ zipFilesize?: string; } @@ -2676,22 +2128,16 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeAssetId { /** - * Name of the creative asset. This is a required field while inserting an - * asset. After insertion, this assetIdentifier is used to identify the - * uploaded asset. Characters in the name must be alphanumeric or one of the - * following: ".-_ ". Spaces are allowed. + * Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. */ name?: string; /** - * Type of asset to upload. This is a required field. FLASH and IMAGE are no - * longer supported for new uploads. All image assets should use HTML_IMAGE. + * Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. */ type?: string; } /** - * CreativeAssets contains properties of a creative asset file which will be - * uploaded or has already been uploaded. Refer to the creative sample code - * for how to upload assets and insert a creative. + * CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative. */ export interface Schema$CreativeAssetMetadata { /** @@ -2699,15 +2145,11 @@ export namespace dfareporting_v3_1 { */ assetIdentifier?: Schema$CreativeAssetId; /** - * List of detected click tags for assets. This is a read-only - * auto-generated field. + * List of detected click tags for assets. This is a read-only auto-generated field. */ clickTags?: Schema$ClickTag[]; /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. */ detectedFeatures?: string[]; /** @@ -2715,50 +2157,28 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the numeric ID of the asset. This is a read-only, - * auto-generated field. + * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeAssetMetadata". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". */ kind?: string; /** - * Rules validated during code generation that generated a warning. This is - * a read-only, auto-generated field. Possible values are: - - * "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - - * "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - - * "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - - * "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - - * "CLICK_TAG_NON_TOP_LEVEL" - - * "COMPONENT_UNSUPPORTED_DCM" - - * "ENABLER_UNSUPPORTED_METHOD_DCM" - - * "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - - * "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - - * "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - * - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - - * "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - - * "PRIMARY_HTML_MISSING" - "SVG_INVALID" - - * "ZIP_INVALID" + * Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID" */ warnedValidationRules?: string[]; } /** - * Encapsulates the list of rules for asset selection and a default asset in - * case none of the rules match. Applicable to INSTREAM_VIDEO creatives. + * Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$CreativeAssetSelection { /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative, and will be served if none of the rules match. This is a - * required field. + * A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field. */ defaultAssetId?: string; /** - * Rules determine which asset will be served to a viewer. Rules will be - * evaluated in the order in which they are stored in this list. This list - * must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. + * Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. */ rules?: Schema$Rule[]; } @@ -2767,15 +2187,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeAssignment { /** - * Whether this creative assignment is active. When true, the creative will - * be included in the ad's rotation. + * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. */ active?: boolean; /** - * Whether applicable event tags should fire when this creative assignment - * is rendered. If this value is unset when the ad is inserted or updated, - * it will default to true for all creative types EXCEPT for - * INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + * Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. */ applyEventTags?: boolean; /** @@ -2783,14 +2199,11 @@ export namespace dfareporting_v3_1 { */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Companion creative overrides for this creative assignment. Applicable to - * video ads. + * Companion creative overrides for this creative assignment. Applicable to video ads. */ companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; /** - * Creative group assignments for this creative assignment. Only one - * assignment per creative group number is allowed for a maximum of two - * assignments. + * Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. */ creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; /** @@ -2798,33 +2211,23 @@ export namespace dfareporting_v3_1 { */ creativeId?: string; /** - * Dimension value for the ID of the creative. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the creative. This is a read-only, auto-generated field. */ creativeIdDimensionValue?: Schema$DimensionValue; /** - * Date and time that the assigned creative should stop serving. Must be - * later than the start time. + * Date and time that the assigned creative should stop serving. Must be later than the start time. */ endTime?: string; /** - * Rich media exit overrides for this creative assignment. Applicable when - * the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - * - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - - * RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - - * RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - - * RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR + * Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR */ richMediaExitOverrides?: Schema$RichMediaExitOverride[]; /** - * Sequence number of the creative assignment, applicable when the rotation - * type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to - * 65535, inclusive. + * Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. */ sequence?: number; /** - * Whether the creative to be assigned is SSL-compliant. This is a read-only - * field that is auto-generated when the ad is inserted or updated. + * Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslCompliant?: boolean; /** @@ -2832,8 +2235,7 @@ export namespace dfareporting_v3_1 { */ startTime?: string; /** - * Weight of the creative assignment, applicable when the rotation type is - * CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. + * Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. */ weight?: number; } @@ -2842,16 +2244,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeClickThroughUrl { /** - * Read-only convenience field representing the actual URL that will be used - * for this click-through. The URL is computed as follows: - If - * landingPageId is specified then that landing page's URL is assigned - * to this field. - Otherwise, the customClickThroughUrl is assigned to this - * field. + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. */ computedClickThroughUrl?: string; /** - * Custom click-through URL. Applicable if the landingPageId field is left - * unset. + * Custom click-through URL. Applicable if the landingPageId field is left unset. */ customClickThroughUrl?: string; /** @@ -2864,8 +2261,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeCustomEvent { /** - * Unique ID of this event used by Reporting and Data Transfer. This is a - * read-only field. + * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. */ advertiserCustomEventId?: string; /** @@ -2877,9 +2273,7 @@ export namespace dfareporting_v3_1 { */ advertiserCustomEventType?: string; /** - * Artwork label column, used to link events in Campaign Manager back to - * events in Studio. This is a required field and should not be modified - * after insertion. + * Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. */ artworkLabel?: string; /** @@ -2887,18 +2281,15 @@ export namespace dfareporting_v3_1 { */ artworkType?: string; /** - * Exit click-through URL for the event. This field is used only for exit - * events. + * Exit click-through URL for the event. This field is used only for exit events. */ exitClickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * ID of this event. This is a required field and should not be modified - * after insertion. + * ID of this event. This is a required field and should not be modified after insertion. */ id?: string; /** - * Properties for rich media popup windows. This field is used only for exit - * events. + * Properties for rich media popup windows. This field is used only for exit events. */ popupWindowProperties?: Schema$PopupWindowProperties; /** @@ -2906,8 +2297,7 @@ export namespace dfareporting_v3_1 { */ targetType?: string; /** - * Video reporting ID, used to differentiate multiple videos in a single - * creative. This is a read-only field. + * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. */ videoReportingId?: string; } @@ -2916,18 +2306,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeField { /** - * Account ID of this creative field. This is a read-only field that can be - * left blank. + * Account ID of this creative field. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this creative field. This is a required field on - * insertion. + * Advertiser ID of this creative field. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -2935,19 +2322,15 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeField". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". */ kind?: string; /** - * Name of this creative field. This is a required field and must be less - * than 256 characters long and unique among creative fields of the same - * advertiser. + * Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. */ name?: string; /** - * Subaccount ID of this creative field. This is a read-only field that can - * be left blank. + * Subaccount ID of this creative field. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -2973,8 +2356,7 @@ export namespace dfareporting_v3_1 { */ creativeFields?: Schema$CreativeField[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". */ kind?: string; /** @@ -2987,18 +2369,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeFieldValue { /** - * ID of this creative field value. This is a read-only, auto-generated - * field. + * ID of this creative field value. This is a read-only, auto-generated field. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValue". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". */ kind?: string; /** - * Value of this creative field value. It needs to be less than 256 - * characters in length and unique per creative field. + * Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. */ value?: string; } @@ -3011,8 +2390,7 @@ export namespace dfareporting_v3_1 { */ creativeFieldValues?: Schema$CreativeFieldValue[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValuesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". */ kind?: string; /** @@ -3025,25 +2403,19 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeGroup { /** - * Account ID of this creative group. This is a read-only field that can be - * left blank. + * Account ID of this creative group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this creative group. This is a required field on - * insertion. + * Advertiser ID of this creative group. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Subgroup of the creative group. Assign your creative groups to a subgroup - * in order to filter or manage them more easily. This field is required on - * insertion and is read-only after insertion. Acceptable values are 1 to 2, - * inclusive. + * Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. */ groupNumber?: number; /** @@ -3051,19 +2423,15 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". */ kind?: string; /** - * Name of this creative group. This is a required field and must be less - * than 256 characters long and unique among creative groups of the same - * advertiser. + * Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. */ name?: string; /** - * Subaccount ID of this creative group. This is a read-only field that can - * be left blank. + * Subaccount ID of this creative group. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -3089,8 +2457,7 @@ export namespace dfareporting_v3_1 { */ creativeGroups?: Schema$CreativeGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". */ kind?: string; /** @@ -3103,14 +2470,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeOptimizationConfiguration { /** - * ID of this creative optimization config. This field is auto-generated - * when the campaign is inserted or updated. It can be null for existing - * campaigns. + * ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. */ id?: string; /** - * Name of this creative optimization config. This is a required field and - * must be less than 129 characters long. + * Name of this creative optimization config. This is a required field and must be less than 129 characters long. */ name?: string; /** @@ -3131,20 +2495,15 @@ export namespace dfareporting_v3_1 { */ creativeAssignments?: Schema$CreativeAssignment[]; /** - * Creative optimization configuration that is used by this ad. It should - * refer to one of the existing optimization configurations in the ad's - * campaign. If it is unset or set to 0, then the campaign's default - * optimization configuration will be used for this ad. + * Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad. */ creativeOptimizationConfigurationId?: string; /** - * Type of creative rotation. Can be used to specify whether to use - * sequential or random rotation. + * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. */ type?: string; /** - * Strategy for calculating weights. Used with - * CREATIVE_ROTATION_TYPE_RANDOM. + * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */ weightCalculationStrategy?: string; } @@ -3153,13 +2512,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CreativeSettings { /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. + * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. */ iFrameFooter?: string; /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. + * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. */ iFrameHeader?: string; } @@ -3172,8 +2529,7 @@ export namespace dfareporting_v3_1 { */ creatives?: Schema$Creative[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". */ kind?: string; /** @@ -3182,33 +2538,27 @@ export namespace dfareporting_v3_1 { nextPageToken?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". + * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ export interface Schema$CrossDimensionReachReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "breakdown" section of the report. + * Dimensions which are compatible to be selected in the "breakdown" section of the report. */ breakdown?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#crossDimensionReachReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected in the - * "overlapMetricNames" section of the report. + * Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. */ overlapMetrics?: Schema$Metric[]; } @@ -3217,18 +2567,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CustomFloodlightVariable { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#customFloodlightVariable". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". */ kind?: string; /** - * The type of custom floodlight variable to supply a value for. These map - * to the "u[1-20]=" in the tags. + * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. */ type?: string; /** - * The value of the custom floodlight variable. The length of string must - * not exceed 50 characters. + * The value of the custom floodlight variable. The length of string must not exceed 50 characters. */ value?: string; } @@ -3237,13 +2584,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$CustomRichMediaEvents { /** - * List of custom rich media event IDs. Dimension values must be all of type - * dfa:richMediaEventTypeIdAndName. + * List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. */ filteredEventIds?: Schema$DimensionValue[]; /** - * The kind of resource this is, in this case - * dfareporting#customRichMediaEvents. + * The kind of resource this is, in this case dfareporting#customRichMediaEvents. */ kind?: string; } @@ -3252,8 +2597,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$DateRange { /** - * The end date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". + * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ endDate?: string; /** @@ -3265,8 +2609,7 @@ export namespace dfareporting_v3_1 { */ relativeDateRange?: string; /** - * The start date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". + * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ startDate?: string; } @@ -3275,25 +2618,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$DayPartTargeting { /** - * Days of the week when the ad will serve. Acceptable values are: - - * "SUNDAY" - "MONDAY" - "TUESDAY" - - * "WEDNESDAY" - "THURSDAY" - "FRIDAY" - - * "SATURDAY" + * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" */ daysOfWeek?: string[]; /** - * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and - * 23 is 11 PM to midnight. Can be specified with days of week, in which - * case the ad would serve during these hours on the specified days. For - * example if Monday, Wednesday, Friday are the days of week specified and - * 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve - * Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values - * are 0 to 23, inclusive. + * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. */ hoursOfDay?: number[]; /** - * Whether or not to use the user's local time. If false, the - * America/New York time zone applies. + * Whether or not to use the user's local time. If false, the America/New York time zone applies. */ userLocalTime?: boolean; } @@ -3306,13 +2639,11 @@ export namespace dfareporting_v3_1 { */ appUrl?: string; /** - * The fallback URL. This URL will be served to users who do not have the - * mobile app installed. + * The fallback URL. This URL will be served to users who do not have the mobile app installed. */ fallbackUrl?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#deepLink". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". */ kind?: string; /** @@ -3320,25 +2651,20 @@ export namespace dfareporting_v3_1 { */ mobileApp?: Schema$MobileApp; /** - * Ads served to users on these remarketing lists will use this deep link. - * Applicable when mobileApp.directory is APPLE_APP_STORE. + * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. */ remarketingListIds?: string[]; } /** - * Properties of inheriting and overriding the default click-through event - * tag. A campaign may override the event tag defined at the advertiser level, - * and an ad may also override the campaign's setting further. + * Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. */ export interface Schema$DefaultClickThroughEventTagProperties { /** - * ID of the click-through event tag to apply to all ads in this - * entity's scope. + * ID of the click-through event tag to apply to all ads in this entity's scope. */ defaultClickThroughEventTagId?: string; /** - * Whether this entity should override the inherited default click-through - * event tag with its own defined value. + * Whether this entity should override the inherited default click-through event tag with its own defined value. */ overrideInheritedEventTag?: boolean; } @@ -3347,27 +2673,19 @@ export namespace dfareporting_v3_1 { */ export interface Schema$DeliverySchedule { /** - * Limit on the number of times an individual user can be served the ad - * within a specified period of time. + * Limit on the number of times an individual user can be served the ad within a specified period of time. */ frequencyCap?: Schema$FrequencyCap; /** - * Whether or not hard cutoff is enabled. If true, the ad will not serve - * after the end date and time. Otherwise the ad will continue to be served - * until it has reached its delivery goals. + * Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals. */ hardCutoff?: boolean; /** - * Impression ratio for this ad. This ratio determines how often each ad is - * served relative to the others. For example, if ad A has an impression - * ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager - * will serve ad B three times as often as ad A. Acceptable values are 1 to - * 10, inclusive. + * Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive. */ impressionRatio?: string; /** - * Serving priority of an ad, with respect to other ads. The lower the - * priority number, the greater the priority with which it is served. + * Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served. */ priority?: string; } @@ -3447,12 +2765,7 @@ export namespace dfareporting_v3_1 { */ kind?: string; /** - * Determines how the 'value' field is matched when filtering. If - * not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, - * '*' is allowed as a placeholder for variable length character - * sequences, and it can be escaped with a backslash. Note, only paid search - * dimensions ('dfa:paidSearch*') allow a matchType other than - * EXACT. + * Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. */ matchType?: string; /** @@ -3477,10 +2790,7 @@ export namespace dfareporting_v3_1 { */ kind?: string; /** - * Continuation token used to page through dimension values. To retrieve the - * next page of results, set the next request's "pageToken" to - * the value of this field. The page token is only valid for a limited - * amount of time and should not be persisted. + * Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -3493,8 +2803,7 @@ export namespace dfareporting_v3_1 { */ dimensionName?: string; /** - * The end date of the date range for which to retrieve dimension values. A - * string of the format "yyyy-MM-dd". + * The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". */ endDate?: string; /** @@ -3502,20 +2811,16 @@ export namespace dfareporting_v3_1 { */ filters?: Schema$DimensionFilter[]; /** - * The kind of request this is, in this case - * dfareporting#dimensionValueRequest. + * The kind of request this is, in this case dfareporting#dimensionValueRequest. */ kind?: string; /** - * The start date of the date range for which to retrieve dimension values. - * A string of the format "yyyy-MM-dd". + * The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". */ startDate?: string; } /** - * DirectorySites contains properties of a website from the Site Directory. - * Sites need to be added to an account via the Sites resource before they can - * be assigned to a placement. + * DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement. */ export interface Schema$DirectorySite { /** @@ -3531,26 +2836,7 @@ export namespace dfareporting_v3_1 { */ countryId?: string; /** - * Currency ID of this directory site. This is a read-only field. Possible - * values are: - "1" for USD - "2" for GBP - - * "3" for ESP - "4" for SEK - "5" for CAD - * - "6" for JPY - "7" for DEM - "8" for AUD - * - "9" for FRF - "10" for ITL - "11" for - * DKK - "12" for NOK - "13" for FIM - "14" - * for ZAR - "15" for IEP - "16" for NLG - - * "17" for EUR - "18" for KRW - "19" for - * TWD - "20" for SGD - "21" for CNY - "22" - * for HKD - "23" for NZD - "24" for MYR - - * "25" for BRL - "26" for PTE - "27" for - * MXP - "28" for CLP - "29" for TRY - "30" - * for ARS - "31" for PEN - "32" for ILS - - * "33" for CHF - "34" for VEF - "35" for - * COP - "36" for GTQ - "37" for PLN - "39" - * for INR - "40" for THB - "41" for IDR - - * "42" for CZK - "43" for RON - "44" for - * HUF - "45" for RUB - "46" for AED - "47" - * for BGN - "48" for HRK - "49" for MXN - - * "50" for NGN + * Currency ID of this directory site. This is a read-only field. Possible values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ currencyId?: string; /** @@ -3562,26 +2848,19 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the ID of this directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Tag types for regular placements. Acceptable values are: - - * "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - - * "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" + * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" */ inpageTagFormats?: string[]; /** - * Tag types for interstitial placements. Acceptable values are: - - * "IFRAME_JAVASCRIPT_INTERSTITIAL" - - * "INTERNAL_REDIRECT_INTERSTITIAL" - - * "JAVASCRIPT_INTERSTITIAL" + * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" */ interstitialTagFormats?: string[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySite". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". */ kind?: string; /** @@ -3618,13 +2897,11 @@ export namespace dfareporting_v3_1 { */ firstName?: string; /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. + * ID of this directory site contact. This is a read-only, auto-generated field. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContact". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact". */ kind?: string; /** @@ -3653,14 +2930,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$DirectorySiteContactAssignment { /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. + * ID of this directory site contact. This is a read-only, auto-generated field. */ contactId?: string; /** - * Visibility of this directory site contact assignment. When set to PUBLIC - * this contact assignment is visible to all account and agency users; when - * set to PRIVATE it is visible only to the site. + * Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site. */ visibility?: string; } @@ -3673,8 +2947,7 @@ export namespace dfareporting_v3_1 { */ directorySiteContacts?: Schema$DirectorySiteContact[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContactsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse". */ kind?: string; /** @@ -3707,13 +2980,11 @@ export namespace dfareporting_v3_1 { */ nielsenOcrOptOut?: boolean; /** - * Whether this directory site has disabled generation of Verification ins - * tags. + * Whether this directory site has disabled generation of Verification ins tags. */ verificationTagOptOut?: boolean; /** - * Whether this directory site has disabled active view for in-stream video - * creatives. This is a read-only field. + * Whether this directory site has disabled active view for in-stream video creatives. This is a read-only field. */ videoActiveViewOptOut?: boolean; } @@ -3726,8 +2997,7 @@ export namespace dfareporting_v3_1 { */ directorySites?: Schema$DirectorySite[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySitesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". */ kind?: string; /** @@ -3736,23 +3006,15 @@ export namespace dfareporting_v3_1 { nextPageToken?: string; } /** - * Contains properties of a dynamic targeting key. Dynamic targeting keys are - * unique, user-friendly labels, created at the advertiser level in DCM, that - * can be assigned to ads, creatives, and placements and used for targeting - * with Studio dynamic creatives. Use these labels instead of numeric Campaign - * Manager IDs (such as placement IDs) to save time and avoid errors in your - * dynamic feeds. + * Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds. */ export interface Schema$DynamicTargetingKey { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKey". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". */ kind?: string; /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. */ name?: string; /** @@ -3760,8 +3022,7 @@ export namespace dfareporting_v3_1 { */ objectId?: string; /** - * Type of the object of this dynamic targeting key. This is a required - * field. + * Type of the object of this dynamic targeting key. This is a required field. */ objectType?: string; } @@ -3774,8 +3035,7 @@ export namespace dfareporting_v3_1 { */ dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKeysListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". */ kind?: string; } @@ -3784,23 +3044,19 @@ export namespace dfareporting_v3_1 { */ export interface Schema$EncryptionInfo { /** - * The encryption entity ID. This should match the encryption configuration - * for ad serving or Data Transfer. + * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. */ encryptionEntityId?: string; /** - * The encryption entity type. This should match the encryption - * configuration for ad serving or Data Transfer. + * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. */ encryptionEntityType?: string; /** - * Describes whether the encrypted cookie was received from ad serving (the - * %m macro) or from Data Transfer. + * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. */ encryptionSource?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#encryptionInfo". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */ kind?: string; } @@ -3809,40 +3065,31 @@ export namespace dfareporting_v3_1 { */ export interface Schema$EventTag { /** - * Account ID of this event tag. This is a read-only field that can be left - * blank. + * Account ID of this event tag. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this event tag. This field or the campaignId field is - * required on insertion. + * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Campaign ID of this event tag. This field or the advertiserId field is - * required on insertion. + * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * Whether this event tag should be automatically enabled for all of the - * advertiser's campaigns and ads. + * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. */ enabledByDefault?: boolean; /** - * Whether to remove this event tag from ads that are trafficked through - * Display & Video 360 to Ad Exchange. This may be useful if the event - * tag uses a pixel that is unapproved for Ad Exchange bids on one or more - * networks, such as the Google Display Network. + * Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. */ excludeFromAdxRequests?: boolean; /** @@ -3850,24 +3097,19 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTag". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". */ kind?: string; /** - * Name of this event tag. This is a required field and must be less than - * 256 characters long. + * Name of this event tag. This is a required field and must be less than 256 characters long. */ name?: string; /** - * Site filter type for this event tag. If no type is specified then the - * event tag will be applied to all sites. + * Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. */ siteFilterType?: string; /** - * Filter list of site IDs associated with this event tag. The - * siteFilterType determines whether this is a whitelist or blacklist - * filter. + * Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter. */ siteIds?: string[]; /** @@ -3875,31 +3117,23 @@ export namespace dfareporting_v3_1 { */ sslCompliant?: boolean; /** - * Status of this event tag. Must be ENABLED for this event tag to fire. - * This is a required field. + * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. */ status?: string; /** - * Subaccount ID of this event tag. This is a read-only field that can be - * left blank. + * Subaccount ID of this event tag. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Event tag type. Can be used to specify whether to use a third-party - * pixel, a third-party JavaScript URL, or a third-party click-through URL - * for either impression or click tracking. This is a required field. + * Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. */ type?: string; /** - * Payload URL for this event tag. The URL on a click-through event tag - * should have a landing page URL appended to the end of it. This field is - * required on insertion. + * Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. */ url?: string; /** - * Number of times the landing page URL should be URL-escaped before being - * appended to the click-through event tag URL. Only applies to - * click-through event tags as specified by the event tag type. + * Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. */ urlEscapeLevels?: number; } @@ -3925,20 +3159,16 @@ export namespace dfareporting_v3_1 { */ eventTags?: Schema$EventTag[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTagsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". */ kind?: string; } /** - * Represents a File resource. A file contains the metadata for a report run. - * It shows the status of the run and holds the URLs to the generated report - * data if the run is finished and the status is "REPORT_AVAILABLE". + * Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE". */ export interface Schema$File { /** - * The date range for which the file has report data. The date range will - * always be the absolute date range for which the report is run. + * The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. */ dateRange?: Schema$DateRange; /** @@ -3950,8 +3180,7 @@ export namespace dfareporting_v3_1 { */ fileName?: string; /** - * The output format of the report. Only available once the file is - * available. + * The output format of the report. Only available once the file is available. */ format?: string; /** @@ -3963,8 +3192,7 @@ export namespace dfareporting_v3_1 { */ kind?: string; /** - * The timestamp in milliseconds since epoch when this file was last - * modified. + * The timestamp in milliseconds since epoch when this file was last modified. */ lastModifiedTime?: string; /** @@ -3997,10 +3225,7 @@ export namespace dfareporting_v3_1 { */ kind?: string; /** - * Continuation token used to page through files. To retrieve the next page - * of results, set the next request's "pageToken" to the value - * of this field. The page token is only valid for a limited amount of time - * and should not be persisted. + * Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -4030,19 +3255,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$FloodlightActivitiesGenerateTagResponse { /** - * Generated tag for this Floodlight activity. For global site tags, this is - * the event snippet. + * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. */ floodlightActivityTag?: string; /** - * The global snippet section of a global site tag. The global site tag sets - * new cookies on your domain, which will store a unique identifier for a - * user or the ad click that brought the user to your site. Learn more. + * The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. */ globalSiteTagGlobalSnippet?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesGenerateTagResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". */ kind?: string; } @@ -4055,8 +3276,7 @@ export namespace dfareporting_v3_1 { */ floodlightActivities?: Schema$FloodlightActivity[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". */ kind?: string; /** @@ -4069,30 +3289,23 @@ export namespace dfareporting_v3_1 { */ export interface Schema$FloodlightActivity { /** - * Account ID of this floodlight activity. This is a read-only field that - * can be left blank. + * Account ID of this floodlight activity. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this floodlight activity. If this field is left blank, - * the value will be copied over either from the activity group's - * advertiser or the existing activity's advertiser. + * Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Code type used for cache busting in the generated tag. Applicable only - * when floodlightActivityGroupType is COUNTER and countingMethod is - * STANDARD_COUNTING or UNIQUE_COUNTING. + * Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. */ cacheBustingType?: string; /** - * Counting method for conversions for this floodlight activity. This is a - * required field. + * Counting method for conversions for this floodlight activity. This is a required field. */ countingMethod?: string; /** @@ -4100,45 +3313,35 @@ export namespace dfareporting_v3_1 { */ defaultTags?: Schema$FloodlightActivityDynamicTag[]; /** - * URL where this tag will be deployed. If specified, must be less than 256 - * characters long. + * URL where this tag will be deployed. If specified, must be less than 256 characters long. */ expectedUrl?: string; /** - * Floodlight activity group ID of this floodlight activity. This is a - * required field. + * Floodlight activity group ID of this floodlight activity. This is a required field. */ floodlightActivityGroupId?: string; /** - * Name of the associated floodlight activity group. This is a read-only - * field. + * Name of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupName?: string; /** - * Tag string of the associated floodlight activity group. This is a - * read-only field. + * Tag string of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupTagString?: string; /** - * Type of the associated floodlight activity group. This is a read-only - * field. + * Type of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupType?: string; /** - * Floodlight configuration ID of this floodlight activity. If this field is - * left blank, the value will be copied over either from the activity - * group's floodlight configuration or from the existing activity's - * floodlight configuration. + * Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** - * The type of Floodlight tag this activity will generate. This is a - * required field. + * The type of Floodlight tag this activity will generate. This is a required field. */ floodlightTagType?: string; /** @@ -4146,23 +3349,19 @@ export namespace dfareporting_v3_1 { */ hidden?: boolean; /** - * ID of this floodlight activity. This is a read-only, auto-generated - * field. + * ID of this floodlight activity. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight activity. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivity". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". */ kind?: string; /** - * Name of this floodlight activity. This is a required field. Must be less - * than 129 characters long and cannot contain quotes. + * Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. */ name?: string; /** @@ -4178,8 +3377,7 @@ export namespace dfareporting_v3_1 { */ secure?: boolean; /** - * Whether the floodlight activity is SSL-compliant. This is a read-only - * field, its value detected by the system from the floodlight tags. + * Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. */ sslCompliant?: boolean; /** @@ -4187,28 +3385,19 @@ export namespace dfareporting_v3_1 { */ sslRequired?: boolean; /** - * Subaccount ID of this floodlight activity. This is a read-only field that - * can be left blank. + * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Tag format type for the floodlight activity. If left blank, the tag - * format will default to HTML. + * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. */ tagFormat?: string; /** - * Value of the cat= parameter in the floodlight tag, which the ad servers - * use to identify the activity. This is optional: if empty, a new tag - * string will be generated for you. This string must be 1 to 8 characters - * long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag - * string must also be unique among activities of the same activity group. - * This field is read-only after insertion. + * Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. */ tagString?: string; /** - * List of the user-defined variables used by this conversion tag. These map - * to the "u[1-100]=" in the tags. Each of these can have a user - * defined type. Acceptable values are U1 to U100, inclusive. + * List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. */ userDefinedVariableTypes?: string[]; } @@ -4234,70 +3423,51 @@ export namespace dfareporting_v3_1 { */ export interface Schema$FloodlightActivityGroup { /** - * Account ID of this floodlight activity group. This is a read-only field - * that can be left blank. + * Account ID of this floodlight activity group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this floodlight activity group. If this field is left - * blank, the value will be copied over either from the floodlight - * configuration's advertiser or from the existing activity group's - * advertiser. + * Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Floodlight configuration ID of this floodlight activity group. This is a - * required field. + * Floodlight configuration ID of this floodlight activity group. This is a required field. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** - * ID of this floodlight activity group. This is a read-only, auto-generated - * field. + * ID of this floodlight activity group. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight activity group. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". */ kind?: string; /** - * Name of this floodlight activity group. This is a required field. Must be - * less than 65 characters long and cannot contain quotes. + * Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. */ name?: string; /** - * Subaccount ID of this floodlight activity group. This is a read-only - * field that can be left blank. + * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Value of the type= parameter in the floodlight tag, which the ad servers - * use to identify the activity group that the activity belongs to. This is - * optional: if empty, a new tag string will be generated for you. This - * string must be 1 to 8 characters long, with valid characters being - * [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among - * activity groups of the same floodlight configuration. This field is - * read-only after insertion. + * Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. */ tagString?: string; /** - * Type of the floodlight activity group. This is a required field that is - * read-only after insertion. + * Type of the floodlight activity group. This is a required field that is read-only after insertion. */ type?: string; } @@ -4310,8 +3480,7 @@ export namespace dfareporting_v3_1 { */ floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". */ kind?: string; /** @@ -4328,9 +3497,7 @@ export namespace dfareporting_v3_1 { */ clickThrough?: boolean; /** - * Directory site ID of this dynamic tag. This is a write-only field that - * can be used as an alternative to the siteId field. When this resource is - * retrieved, only the siteId field will be populated. + * Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. */ directorySiteId?: string; /** @@ -4342,8 +3509,7 @@ export namespace dfareporting_v3_1 { */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** @@ -4356,8 +3522,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$FloodlightConfiguration { /** - * Account ID of this floodlight configuration. This is a read-only field - * that can be left blank. + * Account ID of this floodlight configuration. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -4365,8 +3530,7 @@ export namespace dfareporting_v3_1 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -4374,24 +3538,19 @@ export namespace dfareporting_v3_1 { */ analyticsDataSharingEnabled?: boolean; /** - * Whether the exposure-to-conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. + * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ exposureToConversionEnabled?: boolean; /** - * Day that will be counted as the first day of the week in reports. This is - * a required field. + * Day that will be counted as the first day of the week in reports. This is a required field. */ firstDayOfWeek?: string; /** - * ID of this floodlight configuration. This is a read-only, auto-generated - * field. + * ID of this floodlight configuration. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -4399,8 +3558,7 @@ export namespace dfareporting_v3_1 { */ inAppAttributionTrackingEnabled?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfiguration". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". */ kind?: string; /** @@ -4416,8 +3574,7 @@ export namespace dfareporting_v3_1 { */ omnitureSettings?: Schema$OmnitureSettings; /** - * Subaccount ID of this floodlight configuration. This is a read-only field - * that can be left blank. + * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -4442,34 +3599,28 @@ export namespace dfareporting_v3_1 { */ floodlightConfigurations?: Schema$FloodlightConfiguration[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfigurationsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". */ kind?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "FlOODLIGHT". + * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". */ export interface Schema$FloodlightReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#floodlightReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; } @@ -4478,13 +3629,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$FrequencyCap { /** - * Duration of time, in seconds, for this frequency cap. The maximum - * duration is 90 days. Acceptable values are 1 to 7776000, inclusive. + * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. */ duration?: string; /** - * Number of times an individual user can be served the ad within the - * specified duration. Acceptable values are 1 to 15, inclusive. + * Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. */ impressions?: string; } @@ -4493,8 +3642,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$FsCommand { /** - * Distance from the left of the browser.Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. + * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ left?: number; /** @@ -4502,8 +3650,7 @@ export namespace dfareporting_v3_1 { */ positionOption?: string; /** - * Distance from the top of the browser. Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. + * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ top?: number; /** @@ -4520,44 +3667,27 @@ export namespace dfareporting_v3_1 { */ export interface Schema$GeoTargeting { /** - * Cities to be targeted. For each city only dartId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a city, do not target or exclude the country of the city, and - * do not target the metro or region of the city. + * Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. */ cities?: Schema$City[]; /** - * Countries to be targeted or excluded from targeting, depending on the - * setting of the excludeCountries field. For each country only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting or excluding a country, do not target - * regions, cities, metros, or postal codes in the same country. + * Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. */ countries?: Schema$Country[]; /** - * Whether or not to exclude the countries in the countries field from - * targeting. If false, the countries field refers to countries which will - * be targeted by the ad. + * Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. */ excludeCountries?: boolean; /** - * Metros to be targeted. For each metro only dmaId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a metro, do not target or exclude the country of the metro. + * Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. */ metros?: Schema$Metro[]; /** - * Postal codes to be targeted. For each postal code only id is required. - * The other fields are populated automatically when the ad is inserted or - * updated. If targeting a postal code, do not target or exclude the country - * of the postal code. + * Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. */ postalCodes?: Schema$PostalCode[]; /** - * Regions to be targeted. For each region only dartId is required. The - * other fields are populated automatically when the ad is inserted or - * updated. If targeting a region, do not target or exclude the country of - * the region. + * Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. */ regions?: Schema$Region[]; } @@ -4570,10 +3700,7 @@ export namespace dfareporting_v3_1 { */ accountId?: string; /** - * Ad slots of this inventory item. If this inventory item represents a - * standalone placement, there will be exactly one ad slot. If this - * inventory item represents a placement group, there will be more than one - * ad slot, each representing one child placement in that placement group. + * Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group. */ adSlots?: Schema$AdSlot[]; /** @@ -4601,8 +3728,7 @@ export namespace dfareporting_v3_1 { */ inPlan?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItem". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". */ kind?: string; /** @@ -4610,9 +3736,7 @@ export namespace dfareporting_v3_1 { */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this inventory item. For standalone inventory items, this is the - * same name as that of its only ad slot. For group inventory items, this - * can differ from the name of any of its ad slots. + * Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots. */ name?: string; /** @@ -4661,8 +3785,7 @@ export namespace dfareporting_v3_1 { */ inventoryItems?: Schema$InventoryItem[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItemsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". */ kind?: string; /** @@ -4680,8 +3803,7 @@ export namespace dfareporting_v3_1 { expression?: string; } /** - * Contains information about where a user's browser is taken after the - * user clicks an ad. + * Contains information about where a user's browser is taken after the user clicks an ad. */ export interface Schema$LandingPage { /** @@ -4701,13 +3823,11 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#landingPage". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". */ kind?: string; /** - * Name of this landing page. This is a required field. It must be less than - * 256 characters long. + * Name of this landing page. This is a required field. It must be less than 256 characters long. */ name?: string; /** @@ -4720,19 +3840,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Language { /** - * Language ID of this language. This is the ID used for targeting and - * generating reports. + * Language ID of this language. This is the ID used for targeting and generating reports. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#language". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". */ kind?: string; /** - * Format of language code is an ISO 639 two-letter language code optionally - * followed by an underscore followed by an ISO 3166 code. Examples are - * "en" for English or "zh_CN" for Simplified Chinese. + * Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. */ languageCode?: string; /** @@ -4745,8 +3861,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$LanguagesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#languagesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". */ kind?: string; /** @@ -4759,9 +3874,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$LanguageTargeting { /** - * Languages that this ad targets. For each language only languageId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. + * Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. */ languages?: Schema$Language[]; } @@ -4775,13 +3888,11 @@ export namespace dfareporting_v3_1 { time?: string; } /** - * A group clause made up of list population terms representing constraints - * joined by ORs. + * A group clause made up of list population terms representing constraints joined by ORs. */ export interface Schema$ListPopulationClause { /** - * Terms of this list population clause. Each clause is made up of list - * population terms representing constraints and are joined by ORs. + * Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. */ terms?: Schema$ListPopulationTerm[]; } @@ -4790,19 +3901,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ListPopulationRule { /** - * Floodlight activity ID associated with this rule. This field can be left - * blank. + * Floodlight activity ID associated with this rule. This field can be left blank. */ floodlightActivityId?: string; /** - * Name of floodlight activity associated with this rule. This is a - * read-only, auto-generated field. + * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. */ floodlightActivityName?: string; /** - * Clauses that make up this list population rule. Clauses are joined by - * ANDs, and the clauses themselves are made up of list population terms - * which are joined by ORs. + * Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. */ listPopulationClauses?: Schema$ListPopulationClause[]; } @@ -4811,52 +3918,35 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ListPopulationTerm { /** - * Will be true if the term should check if the user is in the list and - * false if the term should check if the user is not in the list. This field - * is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by - * default. + * Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. */ contains?: boolean; /** - * Whether to negate the comparison result of this term during rule - * evaluation. This field is only relevant when type is left unset or set to - * CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ negation?: boolean; /** - * Comparison operator of this term. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ operator?: string; /** - * ID of the list in question. This field is only relevant when type is set - * to LIST_MEMBERSHIP_TERM. + * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. */ remarketingListId?: string; /** - * List population term type determines the applicable fields in this - * object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, - * variableFriendlyName, operator, value, and negation are applicable. If - * set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are - * applicable. If set to REFERRER_TERM then operator, value, and negation - * are applicable. + * List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. */ type?: string; /** - * Literal to compare the variable to. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ value?: string; /** - * Friendly name of this term's variable. This is a read-only, - * auto-generated field. This field is only relevant when type is left unset - * or set to CUSTOM_VARIABLE_TERM. + * Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. */ variableFriendlyName?: string; /** - * Name of the variable (U1, U2, etc.) being compared in this term. This - * field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or - * REFERRER_TERM. + * Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ variableName?: string; } @@ -4874,19 +3964,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$LookbackConfiguration { /** - * Lookback window, in days, from the last time a given user clicked on one - * of your ads. If you enter 0, clicks will not be considered as triggering - * events for floodlight tracking. If you leave this field blank, the - * default value for your account will be used. Acceptable values are 0 to - * 90, inclusive. + * Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. */ clickDuration?: number; /** - * Lookback window, in days, from the last time a given user viewed one of - * your ads. If you enter 0, impressions will not be considered as - * triggering events for floodlight tracking. If you leave this field blank, - * the default value for your account will be used. Acceptable values are 0 - * to 90, inclusive. + * Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. */ postImpressionActivitiesDuration?: number; } @@ -4920,13 +4002,11 @@ export namespace dfareporting_v3_1 { */ dartId?: string; /** - * DMA ID of this metro region. This is the ID used for targeting and - * generating reports, and is equivalent to metro_code. + * DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. */ dmaId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metro". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". */ kind?: string; /** @@ -4943,8 +4023,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$MetrosListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metrosListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". */ kind?: string; /** @@ -4965,8 +4044,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileApp". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". */ kind?: string; /** @@ -4983,8 +4061,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$MobileAppsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileAppsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". */ kind?: string; /** @@ -5013,8 +4090,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarrier". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". */ kind?: string; /** @@ -5027,8 +4103,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$MobileCarriersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarriersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". */ kind?: string; /** @@ -5041,19 +4116,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ObjectFilter { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#objectFilter". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". */ kind?: string; /** - * Applicable when status is ASSIGNED. The user has access to objects with - * these object IDs. + * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. */ objectIds?: string[]; /** - * Status of the filter. NONE means the user has access to none of the - * objects. ALL means the user has access to all objects. ASSIGNED means the - * user has access to the objects with IDs in the objectIds list. + * Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list. */ status?: string; } @@ -5075,13 +4146,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$OmnitureSettings { /** - * Whether placement cost data will be sent to Omniture. This property can - * be enabled only if omnitureIntegrationEnabled is true. + * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. */ omnitureCostDataEnabled?: boolean; /** - * Whether Omniture integration is enabled. This property can be enabled - * only when the "Advanced Ad Serving" account setting is enabled. + * Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. */ omnitureIntegrationEnabled?: boolean; } @@ -5098,8 +4167,7 @@ export namespace dfareporting_v3_1 { */ desktop?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystem". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". */ kind?: string; /** @@ -5116,8 +4184,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$OperatingSystemsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". */ kind?: string; /** @@ -5126,8 +4193,7 @@ export namespace dfareporting_v3_1 { operatingSystems?: Schema$OperatingSystem[]; } /** - * Contains information about a particular version of an operating system that - * can be targeted by ads. + * Contains information about a particular version of an operating system that can be targeted by ads. */ export interface Schema$OperatingSystemVersion { /** @@ -5135,8 +4201,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersion". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". */ kind?: string; /** @@ -5144,8 +4209,7 @@ export namespace dfareporting_v3_1 { */ majorVersion?: string; /** - * Minor version (number after the first dot) of this operating system - * version. + * Minor version (number after the first dot) of this operating system version. */ minorVersion?: string; /** @@ -5162,8 +4226,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$OperatingSystemVersionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". */ kind?: string; /** @@ -5176,19 +4239,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$OptimizationActivity { /** - * Floodlight activity ID of this optimization activity. This is a required - * field. + * Floodlight activity ID of this optimization activity. This is a required field. */ floodlightActivityId?: string; /** - * Dimension value for the ID of the floodlight activity. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. */ floodlightActivityIdDimensionValue?: Schema$DimensionValue; /** - * Weight associated with this optimization. The weight assigned will be - * understood in proportion to the weights assigned to the other - * optimization activities. Value must be greater than or equal to 1. + * Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. */ weight?: number; } @@ -5229,8 +4288,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#order". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". */ kind?: string; /** @@ -5283,9 +4341,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$OrderContact { /** - * Free-form information about this contact. It could be any information - * related to this contact in addition to type, title, name, and signature - * user profile ID. + * Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID. */ contactInfo?: string; /** @@ -5301,8 +4357,7 @@ export namespace dfareporting_v3_1 { */ contactType?: string; /** - * ID of the user profile containing the signature that will be embedded - * into order documents. + * ID of the user profile containing the signature that will be embedded into order documents. */ signatureUserProfileId?: string; } @@ -5319,9 +4374,7 @@ export namespace dfareporting_v3_1 { */ advertiserId?: string; /** - * The amended order document ID of this order document. An order document - * can be created by optionally amending another order document so that the - * change history can be preserved. + * The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. */ amendedOrderDocumentId?: string; /** @@ -5345,8 +4398,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocument". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". */ kind?: string; /** @@ -5387,8 +4439,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$OrderDocumentsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocumentsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". */ kind?: string; /** @@ -5405,8 +4456,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$OrdersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ordersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". */ kind?: string; /** @@ -5419,33 +4469,27 @@ export namespace dfareporting_v3_1 { orders?: Schema$Order[]; } /** - * Represents fields that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". + * Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ export interface Schema$PathToConversionReportCompatibleFields { /** - * Conversion dimensions which are compatible to be selected in the - * "conversionDimensions" section of the report. + * Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. */ conversionDimensions?: Schema$Dimension[]; /** - * Custom floodlight variables which are compatible to be selected in the - * "customFloodlightVariables" section of the report. + * Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. */ customFloodlightVariables?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#pathToConversionReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Per-interaction dimensions which are compatible to be selected in the - * "perInteractionDimensions" section of the report. + * Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. */ perInteractionDimensions?: Schema$Dimension[]; } @@ -5458,9 +4502,7 @@ export namespace dfareporting_v3_1 { */ accountId?: string; /** - * Whether this placement opts out of ad blocking. When true, ad blocking is - * disabled for this placement. When false, the campaign and site settings - * take effect. + * Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. */ adBlockingOptOut?: boolean; /** @@ -5468,8 +4510,7 @@ export namespace dfareporting_v3_1 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -5477,13 +4518,11 @@ export namespace dfareporting_v3_1 { */ archived?: boolean; /** - * Campaign ID of this placement. This field is a required field on - * insertion. + * Campaign ID of this placement. This field is a required field on insertion. */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** @@ -5491,13 +4530,7 @@ export namespace dfareporting_v3_1 { */ comment?: string; /** - * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering on desktop, on mobile devices or in mobile apps for regular or - * interstitial ads respectively. APP and APP_INTERSTITIAL are no longer - * allowed for new placement insertions. Instead, use DISPLAY or - * DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream - * video ads developed with the VAST standard. This field is required on - * insertion. + * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. */ compatibility?: string; /** @@ -5505,19 +4538,15 @@ export namespace dfareporting_v3_1 { */ contentCategoryId?: string; /** - * Information about the creation of this placement. This is a read-only - * field. + * Information about the creation of this placement. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** - * Directory site ID of this placement. On insert, you must set either this - * field or the siteId field to specify the site associated with this - * placement. This is a required field that is read-only after insertion. + * Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -5529,8 +4558,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the ID of this placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this placement. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -5538,13 +4566,11 @@ export namespace dfareporting_v3_1 { */ keyName?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placement". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". */ kind?: string; /** - * Information about the most recent modification of this placement. This is - * a read-only field. + * Information about the most recent modification of this placement. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** @@ -5552,18 +4578,15 @@ export namespace dfareporting_v3_1 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Name of this placement.This is a required field and must be less than 256 - * characters long. + * Name of this placement.This is a required field and must be less than 256 characters long. */ name?: string; /** - * Whether payment was approved for this placement. This is a read-only - * field relevant only to publisher-paid placements. + * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. */ paymentApproved?: boolean; /** - * Payment source for this placement. This is a required field that is - * read-only after insertion. + * Payment source for this placement. This is a required field that is read-only after insertion. */ paymentSource?: string; /** @@ -5571,8 +4594,7 @@ export namespace dfareporting_v3_1 { */ placementGroupId?: string; /** - * Dimension value for the ID of the placement group. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. */ placementGroupIdDimensionValue?: Schema$DimensionValue; /** @@ -5580,17 +4602,11 @@ export namespace dfareporting_v3_1 { */ placementStrategyId?: string; /** - * Pricing schedule of this placement. This field is required on insertion, - * specifically subfields startDate, endDate and pricingType. + * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. */ pricingSchedule?: Schema$PricingSchedule; /** - * Whether this placement is the primary placement of a roadblock (placement - * group). You cannot change this field from true to false. Setting this - * field to true will automatically set the primary field on the original - * primary placement of the roadblock to false, and it will automatically - * set the roadblock's primaryPlacementId field to the ID of this - * placement. + * Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. */ primary?: boolean; /** @@ -5598,21 +4614,15 @@ export namespace dfareporting_v3_1 { */ publisherUpdateInfo?: Schema$LastModifiedInfo; /** - * Site ID associated with this placement. On insert, you must set either - * this field or the directorySiteId field to specify the site associated - * with this placement. This is a required field that is read-only after - * insertion. + * Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** - * Size associated with this placement. When inserting or updating a - * placement, only the size ID field is used. This field is required on - * insertion. + * Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. */ size?: Schema$Size; /** @@ -5628,22 +4638,7 @@ export namespace dfareporting_v3_1 { */ subaccountId?: string; /** - * Tag formats to generate for this placement. This field is required on - * insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - - * "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_IFRAME_ILAYER" - - * "PLACEMENT_TAG_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - - * "PLACEMENT_TAG_CLICK_COMMANDS" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - - * "PLACEMENT_TAG_TRACKING" - - * "PLACEMENT_TAG_TRACKING_IFRAME" - - * "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + * Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" */ tagFormats?: string[]; /** @@ -5651,26 +4646,15 @@ export namespace dfareporting_v3_1 { */ tagSetting?: Schema$TagSetting; /** - * Whether Verification and ActiveView are disabled for in-stream video - * creatives for this placement. The same setting videoActiveViewOptOut - * exists on the site level -- the opt out occurs if either of these - * settings are true. These settings are distinct from - * DirectorySites.settings.activeViewOptOut or - * Sites.siteSettings.activeViewOptOut which only apply to display ads. - * However, Accounts.activeViewOptOut opts out both video traffic, as well - * as display ads, from Verification and ActiveView. + * Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. */ videoActiveViewOptOut?: boolean; /** - * A collection of settings which affect video creatives served through this - * placement. Applicable to placements with IN_STREAM_VIDEO compatibility. + * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. */ videoSettings?: Schema$VideoSettings; /** - * VPAID adapter setting for this placement. Controls which VPAID format the - * measurement adapter will use for in-stream video creatives assigned to - * this placement. Note: Flash is no longer supported. This field now - * defaults to HTML5 when the following values are provided: FLASH, BOTH. + * VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. */ vpaidAdapterChoice?: string; } @@ -5679,8 +4663,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlacementAssignment { /** - * Whether this placement assignment is active. When true, the placement - * will be included in the ad's rotation. + * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. */ active?: boolean; /** @@ -5688,13 +4671,11 @@ export namespace dfareporting_v3_1 { */ placementId?: string; /** - * Dimension value for the ID of the placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the placement. This is a read-only, auto-generated field. */ placementIdDimensionValue?: Schema$DimensionValue; /** - * Whether the placement to be assigned requires SSL. This is a read-only - * field that is auto-generated when the ad is inserted or updated. + * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslRequired?: boolean; } @@ -5703,18 +4684,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlacementGroup { /** - * Account ID of this placement group. This is a read-only field that can be - * left blank. + * Account ID of this placement group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this placement group. This is a required field on - * insertion. + * Advertiser ID of this placement group. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -5726,13 +4704,11 @@ export namespace dfareporting_v3_1 { */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * IDs of placements which are assigned to this placement group. This is a - * read-only, auto-generated field. + * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. */ childPlacementIds?: string[]; /** @@ -5744,20 +4720,15 @@ export namespace dfareporting_v3_1 { */ contentCategoryId?: string; /** - * Information about the creation of this placement group. This is a - * read-only field. + * Information about the creation of this placement group. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** - * Directory site ID associated with this placement group. On insert, you - * must set either this field or the site_id field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. + * Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -5769,32 +4740,23 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the ID of this placement group. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". */ kind?: string; /** - * Information about the most recent modification of this placement group. - * This is a read-only field. + * Information about the most recent modification of this placement group. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this placement group. This is a required field and must be less - * than 256 characters long. + * Name of this placement group. This is a required field and must be less than 256 characters long. */ name?: string; /** - * Type of this placement group. A package is a simple group of placements - * that acts as a single pricing point for a group of tags. A roadblock is a - * group of placements that not only acts as a single pricing point, but - * also assumes that all the tags in it will be served at the same time. A - * roadblock requires one of its assigned placements to be marked as primary - * for reporting. This field is required on insertion. + * Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. */ placementGroupType?: string; /** @@ -5802,36 +4764,27 @@ export namespace dfareporting_v3_1 { */ placementStrategyId?: string; /** - * Pricing schedule of this placement group. This field is required on - * insertion. + * Pricing schedule of this placement group. This field is required on insertion. */ pricingSchedule?: Schema$PricingSchedule; /** - * ID of the primary placement, used to calculate the media cost of a - * roadblock (placement group). Modifying this field will automatically - * modify the primary field on all affected roadblock child placements. + * ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. */ primaryPlacementId?: string; /** - * Dimension value for the ID of the primary placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. */ primaryPlacementIdDimensionValue?: Schema$DimensionValue; /** - * Site ID associated with this placement group. On insert, you must set - * either this field or the directorySiteId field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. + * Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** - * Subaccount ID of this placement group. This is a read-only field that can - * be left blank. + * Subaccount ID of this placement group. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -5840,8 +4793,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlacementGroupsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". */ kind?: string; /** @@ -5858,8 +4810,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlacementsGenerateTagsResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsGenerateTagsResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". */ kind?: string; /** @@ -5872,8 +4823,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlacementsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". */ kind?: string; /** @@ -5890,8 +4840,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlacementStrategiesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". */ kind?: string; /** @@ -5908,8 +4857,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlacementStrategy { /** - * Account ID of this placement strategy.This is a read-only field that can - * be left blank. + * Account ID of this placement strategy.This is a read-only field that can be left blank. */ accountId?: string; /** @@ -5917,14 +4865,11 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategy". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". */ kind?: string; /** - * Name of this placement strategy. This is a required field. It must be - * less than 256 characters long and unique among placement strategies of - * the same account. + * Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. */ name?: string; } @@ -5950,8 +4895,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformType". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". */ kind?: string; /** @@ -5964,8 +4908,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PlatformTypesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformTypesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". */ kind?: string; /** @@ -5978,13 +4921,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PopupWindowProperties { /** - * Popup dimension for a creative. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID + * Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID */ dimension?: Schema$Size; /** - * Upper-left corner coordinates of the popup window. Applicable if - * positionType is COORDINATES. + * Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES. */ offset?: Schema$OffsetPosition; /** @@ -6037,8 +4978,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCode". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". */ kind?: string; } @@ -6047,8 +4987,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PostalCodesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCodesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". */ kind?: string; /** @@ -6069,20 +5008,11 @@ export namespace dfareporting_v3_1 { */ endDate?: string; /** - * Flights of this inventory item. A flight (a.k.a. pricing period) - * represents the inventory item pricing information for a specific period - * of time. + * Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. */ flights?: Schema$Flight[]; /** - * Group type of this inventory item if it represents a placement group. Is - * null otherwise. There are two type of placement groups: - * PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory - * items that acts as a single pricing point for a group of tags. - * PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items - * that not only acts as a single pricing point, but also assumes that all - * the tags in it will be served at the same time. A roadblock requires one - * of its assigned inventory items to be marked as primary. + * Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary. */ groupType?: string; /** @@ -6107,22 +5037,15 @@ export namespace dfareporting_v3_1 { */ disregardOverdelivery?: boolean; /** - * Placement end date. This date must be later than, or the same day as, the - * placement start date, but not later than the campaign end date. If, for - * example, you set 6/25/2015 as both the start and end dates, the effective - * placement date is just that day only, 6/25/2015. The hours, minutes, and - * seconds of the end date should not be set, as doing so will result in an - * error. This field is required on insertion. + * Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion. */ endDate?: string; /** - * Whether this placement is flighted. If true, pricing periods will be - * computed automatically. + * Whether this placement is flighted. If true, pricing periods will be computed automatically. */ flighted?: boolean; /** - * Floodlight activity ID associated with this placement. This field should - * be set when placement pricing type is set to PRICING_TYPE_CPA. + * Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. */ floodlightActivityId?: string; /** @@ -6134,15 +5057,11 @@ export namespace dfareporting_v3_1 { */ pricingType?: string; /** - * Placement start date. This date must be later than, or the same day as, - * the campaign start date. The hours, minutes, and seconds of the start - * date should not be set, as doing so will result in an error. This field - * is required on insertion. + * Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion. */ startDate?: string; /** - * Testing start date of this placement. The hours, minutes, and seconds of - * the start date should not be set, as doing so will result in an error. + * Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. */ testingStartDate?: string; } @@ -6151,13 +5070,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$PricingSchedulePricingPeriod { /** - * Pricing period end date. This date must be later than, or the same day - * as, the pricing period start date, but not later than the placement end - * date. The period end date can be the same date as the period start date. - * If, for example, you set 6/25/2015 as both the start and end dates, the - * effective pricing period date is just that day only, 6/25/2015. The - * hours, minutes, and seconds of the end date should not be set, as doing - * so will result in an error. + * Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. */ endDate?: string; /** @@ -6165,19 +5078,15 @@ export namespace dfareporting_v3_1 { */ pricingComment?: string; /** - * Rate or cost of this pricing period in nanos (i.e., multipled by - * 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. + * Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. */ rateOrCostNanos?: string; /** - * Pricing period start date. This date must be later than, or the same day - * as, the placement start date. The hours, minutes, and seconds of the - * start date should not be set, as doing so will result in an error. + * Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. */ startDate?: string; /** - * Units of this pricing period. Acceptable values are 0 to 10000000000, - * inclusive. + * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. */ units?: string; } @@ -6202,10 +5111,7 @@ export namespace dfareporting_v3_1 { */ audienceGender?: string; /** - * Budget of this project in the currency specified by the current account. - * The value stored in this field represents only the non-fractional amount. - * For example, for USD, the smallest value that can be represented by this - * field is 1 US dollar. + * Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. */ budget?: string; /** @@ -6225,8 +5131,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#project". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". */ kind?: string; /** @@ -6283,8 +5188,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ProjectsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#projectsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". */ kind?: string; /** @@ -6297,38 +5201,31 @@ export namespace dfareporting_v3_1 { projects?: Schema$Project[]; } /** - * Represents fields that are compatible to be selected for a report of type - * "REACH". + * Represents fields that are compatible to be selected for a report of type "REACH". */ export interface Schema$ReachReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#reachReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */ pivotedActivityMetrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected in the - * "reachByFrequencyMetricNames" section of the report. + * Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. */ reachByFrequencyMetrics?: Schema$Metric[]; } @@ -6366,8 +5263,7 @@ export namespace dfareporting_v3_1 { */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#region". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". */ kind?: string; /** @@ -6384,8 +5280,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$RegionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#regionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". */ kind?: string; /** @@ -6394,18 +5289,11 @@ export namespace dfareporting_v3_1 { regions?: Schema$Region[]; } /** - * Contains properties of a remarketing list. Remarketing enables you to - * create lists of users who have performed specific actions on a site, then - * target ads to members of those lists. This resource can be used to manage - * remarketing lists that are owned by your advertisers. To see all - * remarketing lists that are visible to your advertisers, including those - * that are shared to your advertiser or account, use the - * TargetableRemarketingLists resource. + * Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. */ export interface Schema$RemarketingList { /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ accountId?: string; /** @@ -6413,13 +5301,11 @@ export namespace dfareporting_v3_1 { */ active?: boolean; /** - * Dimension value for the advertiser ID that owns this remarketing list. - * This is a required field. + * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -6431,13 +5317,11 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingList". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". */ kind?: string; /** - * Number of days that a user should remain in the remarketing list without - * an impression. Acceptable values are 1 to 540, inclusive. + * Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. */ lifeSpan?: string; /** @@ -6453,26 +5337,20 @@ export namespace dfareporting_v3_1 { */ listSource?: string; /** - * Name of the remarketing list. This is a required field. Must be no - * greater than 128 characters long. + * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. */ name?: string; /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ subaccountId?: string; } /** - * Contains properties of a remarketing list's sharing information. - * Sharing allows other accounts or advertisers to target to your remarketing - * lists. This resource can be used to manage remarketing list sharing to - * other accounts and advertisers. + * Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers. */ export interface Schema$RemarketingListShare { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListShare". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". */ kind?: string; /** @@ -6493,8 +5371,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$RemarketingListsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". */ kind?: string; /** @@ -6526,8 +5403,7 @@ export namespace dfareporting_v3_1 { metricNames?: string[]; }; /** - * The report criteria for a report of type - * "CROSS_DIMENSION_REACH". + * The report criteria for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachCriteria?: { breakdown?: Schema$SortedDimension[]; @@ -6572,11 +5448,7 @@ export namespace dfareporting_v3_1 { }; }; /** - * The output format of the report. If not specified, default format is - * "CSV". Note that the actual format in the completed report file - * might differ if for instance the report's size exceeds the - * format's capabilities. "CSV" will then be the fallback - * format. + * The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. */ format?: string; /** @@ -6588,8 +5460,7 @@ export namespace dfareporting_v3_1 { */ kind?: string; /** - * The timestamp (in milliseconds since epoch) of when this report was last - * modified. + * The timestamp (in milliseconds since epoch) of when this report was last modified. */ lastModifiedTime?: string; /** @@ -6638,9 +5509,7 @@ export namespace dfareporting_v3_1 { reachByFrequencyMetricNames?: string[]; }; /** - * The report's schedule. Can only be set if the report's - * 'dateRange' is a relative date range and the relative date range - * is not "TODAY". + * The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". */ schedule?: { active?: boolean; @@ -6661,33 +5530,27 @@ export namespace dfareporting_v3_1 { type?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "STANDARD". + * Represents fields that are compatible to be selected for a report of type "STANDARD". */ export interface Schema$ReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#reportCompatibleFields. + * The kind of resource this is, in this case dfareporting#reportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */ pivotedActivityMetrics?: Schema$Metric[]; } @@ -6708,10 +5571,7 @@ export namespace dfareporting_v3_1 { */ kind?: string; /** - * Continuation token used to page through reports. To retrieve the next - * page of results, set the next request's "pageToken" to the - * value of this field. The page token is only valid for a limited amount of - * time and should not be persisted. + * Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -6720,9 +5580,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$ReportsConfiguration { /** - * Whether the exposure to conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. + * Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ exposureToConversionEnabled?: boolean; /** @@ -6730,18 +5588,7 @@ export namespace dfareporting_v3_1 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Report generation time zone ID of this account. This is a required field - * that can only be changed by a superuser. Acceptable values are: - - * "1" for "America/New_York" - "2" for - * "Europe/London" - "3" for "Europe/Paris" - * - "4" for "Africa/Johannesburg" - "5" for - * "Asia/Jerusalem" - "6" for "Asia/Shanghai" - * - "7" for "Asia/Hong_Kong" - "8" for - * "Asia/Tokyo" - "9" for "Australia/Sydney" - * - "10" for "Asia/Dubai" - "11" for - * "America/Los_Angeles" - "12" for - * "Pacific/Auckland" - "13" for - * "America/Sao_Paulo" + * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" */ reportGenerationTimeZoneId?: string; } @@ -6750,13 +5597,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$RichMediaExitOverride { /** - * Click-through URL of this rich media exit override. Applicable if the - * enabled field is set to true. + * Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Whether to use the clickThroughUrl. If false, the creative-level exit - * will be used. + * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. */ enabled?: boolean; /** @@ -6765,13 +5610,11 @@ export namespace dfareporting_v3_1 { exitId?: string; } /** - * A rule associates an asset with a targeting template for asset-level - * targeting. Applicable to INSTREAM_VIDEO creatives. + * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$Rule { /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative. This is a required field. + * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. */ assetId?: string; /** @@ -6779,9 +5622,7 @@ export namespace dfareporting_v3_1 { */ name?: string; /** - * A targeting template ID. The targeting from the targeting template will - * be used to determine whether this asset should be served. This is a - * required field. + * A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field. */ targetingTemplateId?: string; } @@ -6790,8 +5631,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Site { /** - * Account ID of this site. This is a read-only field that can be left - * blank. + * Account ID of this site. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -6799,13 +5639,11 @@ export namespace dfareporting_v3_1 { */ approved?: boolean; /** - * Directory site associated with this site. This is a required field that - * is read-only after insertion. + * Directory site associated with this site. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -6813,8 +5651,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Dimension value for the ID of this site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this site. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -6822,16 +5659,11 @@ export namespace dfareporting_v3_1 { */ keyName?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#site". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". */ kind?: string; /** - * Name of this site.This is a required field. Must be less than 128 - * characters long. If this site is under a subaccount, the name must be - * unique among sites of the same subaccount. Otherwise, this site is a - * top-level site, and the name must be unique among top-level sites of the - * same account. + * Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. */ name?: string; /** @@ -6843,8 +5675,7 @@ export namespace dfareporting_v3_1 { */ siteSettings?: Schema$SiteSettings; /** - * Subaccount ID of this site. This is a read-only field that can be left - * blank. + * Subaccount ID of this site. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -6894,10 +5725,7 @@ export namespace dfareporting_v3_1 { */ activeViewOptOut?: boolean; /** - * Whether this site opts out of ad blocking. When true, ad blocking is - * disabled for all placements under the site, regardless of the individual - * placement settings. When false, the campaign and placement settings take - * effect. + * Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. */ adBlockingOptOut?: boolean; /** @@ -6917,22 +5745,11 @@ export namespace dfareporting_v3_1 { */ tagSetting?: Schema$TagSetting; /** - * Whether Verification and ActiveView for in-stream video creatives are - * disabled by default for new placements created under this site. This - * value will be used to populate the placement.videoActiveViewOptOut field, - * when no value is specified for the new placement. + * Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. */ videoActiveViewOptOutTemplate?: boolean; /** - * Default VPAID adapter setting for new placements created under this site. - * This value will be used to populate the placements.vpaidAdapterChoice - * field, when no value is specified for the new placement. Controls which - * VPAID format the measurement adapter will use for in-stream video - * creatives assigned to the placement. The publisher's specifications - * will typically determine this setting. For VPAID creatives, the adapter - * format will match the VPAID format (HTML5 VPAID creatives use the HTML5 - * adapter). Note: Flash is no longer supported. This field now defaults to - * HTML5 when the following values are provided: FLASH, BOTH. + * Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. */ vpaidAdapterChoiceTemplate?: string; } @@ -6941,8 +5758,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$SitesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sitesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". */ kind?: string; /** @@ -6955,8 +5771,7 @@ export namespace dfareporting_v3_1 { sites?: Schema$Site[]; } /** - * Represents the dimensions of ads, placements, creatives, or creative - * assets. + * Represents the dimensions of ads, placements, creatives, or creative assets. */ export interface Schema$Size { /** @@ -6972,8 +5787,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#size". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". */ kind?: string; /** @@ -6986,8 +5800,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$SizesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sizesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". */ kind?: string; /** @@ -7000,18 +5813,15 @@ export namespace dfareporting_v3_1 { */ export interface Schema$SkippableSetting { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#skippableSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". */ kind?: string; /** - * Amount of time to play videos served to this placement before counting a - * view. Applicable when skippable is true. + * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. */ progressOffset?: Schema$VideoOffset; /** - * Amount of time to play videos served to this placement before the skip - * button should appear. Applicable when skippable is true. + * Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. */ skipOffset?: Schema$VideoOffset; /** @@ -7041,8 +5851,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$Subaccount { /** - * ID of the account that contains this subaccount. This is a read-only - * field that can be left blank. + * ID of the account that contains this subaccount. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -7054,13 +5863,11 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccount". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". */ kind?: string; /** - * Name of this subaccount. This is a required field. Must be less than 128 - * characters long and be unique among subaccounts of the same account. + * Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. */ name?: string; } @@ -7069,8 +5876,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$SubaccountsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". */ kind?: string; /** @@ -7087,8 +5893,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$TagData { /** - * Ad associated with this placement tag. Applicable only when format is - * PLACEMENT_TAG_TRACKING. + * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ adId?: string; /** @@ -7096,8 +5901,7 @@ export namespace dfareporting_v3_1 { */ clickTag?: string; /** - * Creative associated with this placement tag. Applicable only when format - * is PLACEMENT_TAG_TRACKING. + * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ creativeId?: string; /** @@ -7114,15 +5918,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$TagSetting { /** - * Additional key-values to be included in tags. Each key-value pair must be - * of the form key=value, and pairs must be separated by a semicolon (;). - * Keys and values must not contain commas. For example, id=2;color=red is a - * valid value for this field. + * Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. */ additionalKeyValues?: string; /** - * Whether static landing page URLs should be included in the tags. This - * setting applies only to placements. + * Whether static landing page URLs should be included in the tags. This setting applies only to placements. */ includeClickThroughUrls?: boolean; /** @@ -7130,10 +5930,7 @@ export namespace dfareporting_v3_1 { */ includeClickTracking?: boolean; /** - * Option specifying how keywords are embedded in ad tags. This setting can - * be used to specify whether keyword placeholders are inserted in placement - * tags for this site. Publishers can then add keywords to those - * placeholders. + * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. */ keywordOption?: string; } @@ -7151,19 +5948,11 @@ export namespace dfareporting_v3_1 { imageTagEnabled?: boolean; } /** - * Contains properties of a targetable remarketing list. Remarketing enables - * you to create lists of users who have performed specific actions on a site, - * then target ads to members of those lists. This resource is a read-only - * view of a remarketing list to be used to faciliate targeting ads to - * specific lists. Remarketing lists that are owned by your advertisers and - * those that are shared to your advertisers or account are accessible via - * this resource. To manage remarketing lists that are owned by your - * advertisers, use the RemarketingLists resource. + * Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource. */ export interface Schema$TargetableRemarketingList { /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ accountId?: string; /** @@ -7171,8 +5960,7 @@ export namespace dfareporting_v3_1 { */ active?: boolean; /** - * Dimension value for the advertiser ID that owns this targetable - * remarketing list. + * Dimension value for the advertiser ID that owns this targetable remarketing list. */ advertiserId?: string; /** @@ -7188,13 +5976,11 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingList". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". */ kind?: string; /** - * Number of days that a user should remain in the targetable remarketing - * list without an impression. + * Number of days that a user should remain in the targetable remarketing list without an impression. */ lifeSpan?: string; /** @@ -7206,13 +5992,11 @@ export namespace dfareporting_v3_1 { */ listSource?: string; /** - * Name of the targetable remarketing list. Is no greater than 128 - * characters long. + * Name of the targetable remarketing list. Is no greater than 128 characters long. */ name?: string; /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ subaccountId?: string; } @@ -7221,8 +6005,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$TargetableRemarketingListsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingListsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". */ kind?: string; /** @@ -7235,23 +6018,19 @@ export namespace dfareporting_v3_1 { targetableRemarketingLists?: Schema$TargetableRemarketingList[]; } /** - * Contains properties of a targeting template. A targeting template - * encapsulates targeting information which can be reused across multiple ads. + * Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. */ export interface Schema$TargetingTemplate { /** - * Account ID of this targeting template. This field, if left unset, will be - * auto-generated on insert and is read-only after insert. + * Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. */ accountId?: string; /** - * Advertiser ID of this targeting template. This is a required field on - * insert and is read-only after insert. + * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -7271,8 +6050,7 @@ export namespace dfareporting_v3_1 { */ keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplate". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". */ kind?: string; /** @@ -7284,13 +6062,11 @@ export namespace dfareporting_v3_1 { */ listTargetingExpression?: Schema$ListTargetingExpression; /** - * Name of this targeting template. This field is required. It must be less - * than 256 characters long and unique within an advertiser. + * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. */ name?: string; /** - * Subaccount ID of this targeting template. This field, if left unset, will - * be auto-generated on insert and is read-only after insert. + * Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. */ subaccountId?: string; /** @@ -7303,8 +6079,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$TargetingTemplatesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplatesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". */ kind?: string; /** @@ -7325,8 +6100,7 @@ export namespace dfareporting_v3_1 { */ customHtml?: string; /** - * Type of browser window for which the backup image of the flash creative - * can be displayed. + * Type of browser window for which the backup image of the flash creative can be displayed. */ targetWindowOption?: string; } @@ -7335,45 +6109,27 @@ export namespace dfareporting_v3_1 { */ export interface Schema$TechnologyTargeting { /** - * Browsers that this ad targets. For each browser either set - * browserVersionId or dartId along with the version numbers. If both are - * specified, only browserVersionId will be used. The other fields are - * populated automatically when the ad is inserted or updated. + * Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. */ browsers?: Schema$Browser[]; /** - * Connection types that this ad targets. For each connection type only id - * is required. The other fields are populated automatically when the ad is - * inserted or updated. + * Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. */ connectionTypes?: Schema$ConnectionType[]; /** - * Mobile carriers that this ad targets. For each mobile carrier only id is - * required, and the other fields are populated automatically when the ad is - * inserted or updated. If targeting a mobile carrier, do not set targeting - * for any zip codes. + * Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. */ mobileCarriers?: Schema$MobileCarrier[]; /** - * Operating systems that this ad targets. To target specific versions, use - * operatingSystemVersions. For each operating system only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system, do not set - * targeting for operating system versions for the same operating system. + * Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. */ operatingSystems?: Schema$OperatingSystem[]; /** - * Operating system versions that this ad targets. To target all versions, - * use operatingSystems. For each operating system version, only id is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system version, do not set - * targeting for the corresponding operating system in operatingSystems. + * Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. */ operatingSystemVersions?: Schema$OperatingSystemVersion[]; /** - * Platform types that this ad targets. For example, desktop, mobile, or - * tablet. For each platform type, only id is required, and the other fields - * are populated automatically when the ad is inserted or updated. + * Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. */ platformTypes?: Schema$PlatformType[]; } @@ -7386,8 +6142,7 @@ export namespace dfareporting_v3_1 { */ name?: string; /** - * Value of the third-party authentication token. This is a read-only, - * auto-generated field. + * Value of the third-party authentication token. This is a read-only, auto-generated field. */ value?: string; } @@ -7409,19 +6164,16 @@ export namespace dfareporting_v3_1 { */ export interface Schema$TranscodeSetting { /** - * Whitelist of video formats to be served to this placement. Set this list - * to null or empty to serve all video formats. + * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. */ enabledVideoFormats?: number[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#transcodeSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". */ kind?: string; } /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. */ export interface Schema$UniversalAdId { /** @@ -7429,9 +6181,7 @@ export namespace dfareporting_v3_1 { */ registry?: string; /** - * ID value for this creative. Only alphanumeric characters and the - * following symbols are valid: "_/\-". Maximum length is 64 - * characters. Read only when registry is DCM. + * ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. */ value?: string; } @@ -7444,9 +6194,7 @@ export namespace dfareporting_v3_1 { */ dataType?: string; /** - * User-friendly name for the variable which will appear in reports. This is - * a required field, must be less than 64 characters long, and cannot - * contain the following characters: ""<>". + * User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>". */ reportName?: string; /** @@ -7513,14 +6261,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$UserRole { /** - * Account ID of this user role. This is a read-only field that can be left - * blank. + * Account ID of this user role. This is a read-only field that can be left blank. */ accountId?: string; /** - * Whether this is a default user role. Default user roles are created by - * the system for the account/subaccount and cannot be modified or deleted. - * Each default user role comes with a basic set of preassigned permissions. + * Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. */ defaultUserRole?: boolean; /** @@ -7528,21 +6273,15 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRole". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". */ kind?: string; /** - * Name of this user role. This is a required field. Must be less than 256 - * characters long. If this user role is under a subaccount, the name must - * be unique among sites of the same subaccount. Otherwise, this user role - * is a top-level user role, and the name must be unique among top-level - * user roles of the same account. + * Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. */ name?: string; /** - * ID of the user role that this user role is based on or copied from. This - * is a required field. + * ID of the user role that this user role is based on or copied from. This is a required field. */ parentUserRoleId?: string; /** @@ -7550,8 +6289,7 @@ export namespace dfareporting_v3_1 { */ permissions?: Schema$UserRolePermission[]; /** - * Subaccount ID of this user role. This is a read-only field that can be - * left blank. + * Subaccount ID of this user role. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -7568,8 +6306,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermission". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". */ kind?: string; /** @@ -7590,8 +6327,7 @@ export namespace dfareporting_v3_1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". */ kind?: string; /** @@ -7604,8 +6340,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$UserRolePermissionGroupsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". */ kind?: string; /** @@ -7618,8 +6353,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$UserRolePermissionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". */ kind?: string; /** @@ -7632,8 +6366,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$UserRolesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". */ kind?: string; /** @@ -7658,8 +6391,7 @@ export namespace dfareporting_v3_1 { */ id?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormat". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". */ kind?: string; /** @@ -7676,8 +6408,7 @@ export namespace dfareporting_v3_1 { */ export interface Schema$VideoFormatsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormatsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". */ kind?: string; /** @@ -7690,13 +6421,11 @@ export namespace dfareporting_v3_1 { */ export interface Schema$VideoOffset { /** - * Duration, as a percentage of video duration. Do not set when - * offsetSeconds is set. Acceptable values are 0 to 100, inclusive. + * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. */ offsetPercentage?: number; /** - * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable - * values are 0 to 86399, inclusive. + * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. */ offsetSeconds?: number; } @@ -7705,30 +6434,23 @@ export namespace dfareporting_v3_1 { */ export interface Schema$VideoSettings { /** - * Settings for the companion creatives of video creatives served to this - * placement. + * Settings for the companion creatives of video creatives served to this placement. */ companionSettings?: Schema$CompanionSetting; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoSettings". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". */ kind?: string; /** - * Orientation of a video placement. If this value is set, placement will - * return assets matching the specified orientation. + * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. */ orientation?: string; /** - * Settings for the skippability of video creatives served to this - * placement. If this object is provided, the creative-level skippable - * settings will be overridden. + * Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. */ skippableSettings?: Schema$SkippableSetting; /** - * Settings for the transcodes of video creatives served to this placement. - * If this object is provided, the creative-level transcode settings will be - * overridden. + * Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden. */ transcodeSettings?: Schema$TranscodeSetting; } @@ -8306,8 +7028,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accounts.list - * @desc Retrieves the list of accounts, possibly filtered. This method - * supports paging. + * @desc Retrieves the list of accounts, possibly filtered. This method supports paging. * @alias dfareporting.accounts.list * @memberOf! () * @@ -8552,8 +7273,7 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only active accounts. Don't set this field to select both active - * and non-active accounts. + * Select only active accounts. Don't set this field to select both active and non-active accounts. */ active?: boolean; /** @@ -8573,12 +7293,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "account*2015" will return objects with names like "account - * June 2015", "account April 2015", or simply "account 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "account" will match - * objects with name "my account", "account 2015", or simply "account". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". */ searchString?: string; /** @@ -8785,8 +7500,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountUserProfiles.list - * @desc Retrieves a list of account user profiles, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging. * @alias dfareporting.accountUserProfiles.list * @memberOf! () * @@ -8878,8 +7592,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountUserProfiles.patch - * @desc Updates an existing account user profile. This method supports - * patch semantics. + * @desc Updates an existing account user profile. This method supports patch semantics. * @alias dfareporting.accountUserProfiles.patch * @memberOf! () * @@ -9090,13 +7803,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name, ID or email. Wildcards (*) are - * allowed. For example, "user profile*2015" will return objects with names - * like "user profile June 2015", "user profile April 2015", or simply "user - * profile 2015". Most of the searches also add wildcards implicitly at the - * start and the end of the search string. For example, a search string of - * "user profile" will match objects with name "my user profile", "user - * profile 2015", or simply "user profile". + * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". */ searchString?: string; /** @@ -9305,8 +8012,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.ads.list - * @desc Retrieves a list of ads, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of ads, possibly filtered. This method supports paging. * @alias dfareporting.ads.list * @memberOf! () * @@ -9601,12 +8307,7 @@ export namespace dfareporting_v3_1 { */ campaignIds?: string[]; /** - * Select default ads with the specified compatibility. Applicable when type - * is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop or on mobile devices for regular or - * interstitial ads, respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an - * in-stream video ads developed with the VAST standard. + * Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -9618,9 +8319,7 @@ export namespace dfareporting_v3_1 { */ creativeOptimizationConfigurationIds?: string[]; /** - * Select only dynamic click trackers. Applicable when type is - * AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If - * false, select static click trackers. Leave unset to select both. + * Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. */ dynamicClickTracker?: boolean; /** @@ -9652,17 +8351,11 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Select only ads whose list targeting expression use these remarketing - * list IDs. + * Select only ads whose list targeting expression use these remarketing list IDs. */ remarketingListIds?: string[]; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "ad*2015" will return objects with names like "ad June - * 2015", "ad April 2015", or simply "ad 2015". Most of the searches also - * add wildcards implicitly at the start and the end of the search string. - * For example, a search string of "ad" will match objects with name "my - * ad", "ad 2015", or simply "ad". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". */ searchString?: string; /** @@ -9958,8 +8651,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.list - * @desc Retrieves a list of advertiser groups, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging. * @alias dfareporting.advertiserGroups.list * @memberOf! () * @@ -10048,8 +8740,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.patch - * @desc Updates an existing advertiser group. This method supports patch - * semantics. + * @desc Updates an existing advertiser group. This method supports patch semantics. * @alias dfareporting.advertiserGroups.patch * @memberOf! () * @@ -10272,13 +8963,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser group June 2015", "advertiser group April 2015", or simply - * "advertiser group 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "advertisergroup" will match objects with name "my - * advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". */ searchString?: string; /** @@ -10579,8 +9264,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserLandingPages.patch - * @desc Updates an existing landing page. This method supports patch - * semantics. + * @desc Updates an existing landing page. This method supports patch semantics. * @alias dfareporting.advertiserLandingPages.patch * @memberOf! () * @@ -10775,8 +9459,7 @@ export namespace dfareporting_v3_1 { */ advertiserIds?: string[]; /** - * Select only archived landing pages. Don't set this field to select both - * archived and non-archived landing pages. + * Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. */ archived?: boolean; /** @@ -10796,13 +9479,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for landing pages by name or ID. Wildcards (*) are - * allowed. For example, "landingpage*2017" will return landing pages with - * names like "landingpage July 2017", "landingpage March 2017", or simply - * "landingpage 2017". Most of the searches also add wildcards implicitly at - * the start and the end of the search string. For example, a search string - * of "landingpage" will match campaigns with name "my landingpage", - * "landingpage 2015", or simply "landingpage". + * Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". */ searchString?: string; /** @@ -11014,8 +9691,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertisers.list - * @desc Retrieves a list of advertisers, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of advertisers, possibly filtered. This method supports paging. * @alias dfareporting.advertisers.list * @memberOf! () * @@ -11102,8 +9778,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertisers.patch - * @desc Updates an existing advertiser. This method supports patch - * semantics. + * @desc Updates an existing advertiser. This method supports patch semantics. * @alias dfareporting.advertisers.patch * @memberOf! () * @@ -11312,8 +9987,7 @@ export namespace dfareporting_v3_1 { */ maxResults?: number; /** - * Select only advertisers which use another advertiser's floodlight - * configuration. + * Select only advertisers which use another advertiser's floodlight configuration. */ onlyParent?: boolean; /** @@ -11325,13 +9999,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser June 2015", "advertiser April 2015", or simply "advertiser - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "advertiser" will match objects with name "my advertiser", "advertiser - * 2015", or simply "advertiser". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". */ searchString?: string; /** @@ -11491,9 +10159,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaignCreativeAssociations.insert - * @desc Associates a creative with the specified campaign. This method - * creates a default ad with dimensions matching the creative in the - * campaign if such a default ad does not exist already. + * @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. * @alias dfareporting.campaignCreativeAssociations.insert * @memberOf! () * @@ -11576,8 +10242,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaignCreativeAssociations.list - * @desc Retrieves the list of creative IDs associated with the specified - * campaign. This method supports paging. + * @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. * @alias dfareporting.campaignCreativeAssociations.list * @memberOf! () * @@ -11872,8 +10537,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaigns.list - * @desc Retrieves a list of campaigns, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of campaigns, possibly filtered. This method supports paging. * @alias dfareporting.campaigns.list * @memberOf! () * @@ -12140,8 +10804,7 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only campaigns whose advertisers belong to these advertiser - * groups. + * Select only campaigns whose advertisers belong to these advertiser groups. */ advertiserGroupIds?: string[]; /** @@ -12149,8 +10812,7 @@ export namespace dfareporting_v3_1 { */ advertiserIds?: string[]; /** - * Select only archived campaigns. Don't set this field to select both - * archived and non-archived campaigns. + * Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. */ archived?: boolean; /** @@ -12182,13 +10844,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. - * For example, "campaign*2015" will return campaigns with names like - * "campaign June 2015", "campaign April 2015", or simply "campaign 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "campaign" will - * match campaigns with name "my campaign", "campaign 2015", or simply - * "campaign". + * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". */ searchString?: string; /** @@ -12436,12 +11092,7 @@ export namespace dfareporting_v3_1 { */ ids?: string[]; /** - * Select only change logs whose change time is before the specified - * maxChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. + * Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. */ maxChangeTime?: string; /** @@ -12449,12 +11100,7 @@ export namespace dfareporting_v3_1 { */ maxResults?: number; /** - * Select only change logs whose change time is before the specified - * minChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. + * Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. */ minChangeTime?: string; /** @@ -12474,8 +11120,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Select only change logs whose object ID, user name, old or new values - * match the search string. + * Select only change logs whose object ID, user name, old or new values match the search string. */ searchString?: string; /** @@ -13018,8 +11663,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.list - * @desc Retrieves a list of content categories, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of content categories, possibly filtered. This method supports paging. * @alias dfareporting.contentCategories.list * @memberOf! () * @@ -13108,8 +11752,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.patch - * @desc Updates an existing content category. This method supports patch - * semantics. + * @desc Updates an existing content category. This method supports patch semantics. * @alias dfareporting.contentCategories.patch * @memberOf! () * @@ -13332,13 +11975,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "contentcategory*2015" will return objects with names like - * "contentcategory June 2015", "contentcategory April 2015", or simply - * "contentcategory 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "contentcategory" will match objects with name "my - * contentcategory", "contentcategory 2015", or simply "contentcategory". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". */ searchString?: string; /** @@ -14139,8 +12776,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.list - * @desc Retrieves a list of creative fields, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creative fields, possibly filtered. This method supports paging. * @alias dfareporting.creativeFields.list * @memberOf! () * @@ -14228,8 +12864,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.patch - * @desc Updates an existing creative field. This method supports patch - * semantics. + * @desc Updates an existing creative field. This method supports patch semantics. * @alias dfareporting.creativeFields.patch * @memberOf! () * @@ -14456,13 +13091,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for creative fields by name or ID. Wildcards (*) are - * allowed. For example, "creativefield*2015" will return creative fields - * with names like "creativefield June 2015", "creativefield April 2015", or - * simply "creativefield 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativefield" will match creative fields with the name - * "my creativefield", "creativefield 2015", or simply "creativefield". + * Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". */ searchString?: string; /** @@ -14747,8 +13376,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.list - * @desc Retrieves a list of creative field values, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of creative field values, possibly filtered. This method supports paging. * @alias dfareporting.creativeFieldValues.list * @memberOf! () * @@ -14838,8 +13466,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.patch - * @desc Updates an existing creative field value. This method supports - * patch semantics. + * @desc Updates an existing creative field value. This method supports patch semantics. * @alias dfareporting.creativeFieldValues.patch * @memberOf! () * @@ -15080,8 +13707,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for creative field values by their values. Wildcards - * (e.g. *) are not allowed. + * Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. */ searchString?: string; /** @@ -15298,8 +13924,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeGroups.list - * @desc Retrieves a list of creative groups, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creative groups, possibly filtered. This method supports paging. * @alias dfareporting.creativeGroups.list * @memberOf! () * @@ -15388,8 +14013,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeGroups.patch - * @desc Updates an existing creative group. This method supports patch - * semantics. + * @desc Updates an existing creative group. This method supports patch semantics. * @alias dfareporting.creativeGroups.patch * @memberOf! () * @@ -15604,13 +14228,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for creative groups by name or ID. Wildcards (*) are - * allowed. For example, "creativegroup*2015" will return creative groups - * with names like "creativegroup June 2015", "creativegroup April 2015", or - * simply "creativegroup 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativegroup" will match creative groups with the name - * "my creativegroup", "creativegroup 2015", or simply "creativegroup". + * Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". */ searchString?: string; /** @@ -15812,8 +14430,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creatives.list - * @desc Retrieves a list of creatives, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creatives, possibly filtered. This method supports paging. * @alias dfareporting.creatives.list * @memberOf! () * @@ -16083,8 +14700,7 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only active creatives. Leave blank to select active and inactive - * creatives. + * Select only active creatives. Leave blank to select active and inactive creatives. */ active?: boolean; /** @@ -16092,8 +14708,7 @@ export namespace dfareporting_v3_1 { */ advertiserId?: string; /** - * Select only archived creatives. Leave blank to select archived and - * unarchived creatives. + * Select only archived creatives. Leave blank to select archived and unarchived creatives. */ archived?: boolean; /** @@ -16129,13 +14744,7 @@ export namespace dfareporting_v3_1 { */ renderingIds?: string[]; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "creative*2015" will return objects with names like - * "creative June 2015", "creative April 2015", or simply "creative 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "creative" will - * match objects with name "my creative", "creative 2015", or simply - * "creative". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". */ searchString?: string; /** @@ -16391,8 +15000,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.directorySiteContacts.list - * @desc Retrieves a list of directory site contacts, possibly filtered. - * This method supports paging. + * @desc Retrieves a list of directory site contacts, possibly filtered. This method supports paging. * @alias dfareporting.directorySiteContacts.list * @memberOf! () * @@ -16505,8 +15113,7 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only directory site contacts with these directory site IDs. This - * is a required field. + * Select only directory site contacts with these directory site IDs. This is a required field. */ directorySiteIds?: string[]; /** @@ -16526,14 +15133,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name, ID or email. Wildcards (*) are - * allowed. For example, "directory site contact*2015" will return objects - * with names like "directory site contact June 2015", "directory site - * contact April 2015", or simply "directory site contact 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "directory site contact" - * will match objects with name "my directory site contact", "directory site - * contact 2015", or simply "directory site contact". + * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". */ searchString?: string; /** @@ -16704,8 +15304,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.directorySites.list - * @desc Retrieves a list of directory sites, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of directory sites, possibly filtered. This method supports paging. * @alias dfareporting.directorySites.list * @memberOf! () * @@ -16839,23 +15438,19 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInStreamVideoPlacements?: boolean; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInterstitialPlacements?: boolean; /** - * Select only directory sites that accept publisher paid placements. This - * field can be left blank. + * Select only directory sites that accept publisher paid placements. This field can be left blank. */ acceptsPublisherPaidPlacements?: boolean; /** - * Select only active directory sites. Leave blank to retrieve both active - * and inactive directory sites. + * Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. */ active?: boolean; /** @@ -16887,13 +15482,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name, ID or URL. Wildcards (*) are - * allowed. For example, "directory site*2015" will return objects with - * names like "directory site June 2015", "directory site April 2015", or - * simply "directory site 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "directory site" will match objects with name "my - * directory site", "directory site 2015" or simply, "directory site". + * Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". */ searchString?: string; /** @@ -16989,11 +15578,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.dynamicTargetingKeys.insert - * @desc Inserts a new dynamic targeting key. Keys must be created at the - * advertiser level before being assigned to the advertiser's ads, - * creatives, or placements. There is a maximum of 1000 keys per advertiser, - * out of which a maximum of 20 keys can be assigned per ad, creative, or - * placement. + * @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. * @alias dfareporting.dynamicTargetingKeys.insert * @memberOf! () * @@ -17162,9 +15747,7 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. */ name?: string; /** @@ -17172,8 +15755,7 @@ export namespace dfareporting_v3_1 { */ objectId?: string; /** - * Type of the object of this dynamic targeting key. This is a required - * field. + * Type of the object of this dynamic targeting key. This is a required field. */ objectType?: string; /** @@ -17534,8 +16116,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.eventTags.patch - * @desc Updates an existing event tag. This method supports patch - * semantics. + * @desc Updates an existing event tag. This method supports patch semantics. * @alias dfareporting.eventTags.patch * @memberOf! () * @@ -17742,29 +16323,15 @@ export namespace dfareporting_v3_1 { */ campaignId?: string; /** - * Examine only the specified campaign or advertiser's event tags for - * matching selector criteria. When set to false, the parent advertiser and - * parent campaign of the specified ad or campaign is examined as well. In - * addition, when set to false, the status field is examined as well, along - * with the enabledByDefault field. This parameter can not be set to true - * when adId is specified as ads do not define their own even tags. + * Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. */ definitionsOnly?: boolean; /** - * Select only enabled event tags. What is considered enabled or disabled - * depends on the definitionsOnly parameter. When definitionsOnly is set to - * true, only the specified advertiser or campaign's event tags' - * enabledByDefault field is examined. When definitionsOnly is set to false, - * the specified ad or specified campaign's parent advertiser's or parent - * campaign's event tags' enabledByDefault and status fields are examined as - * well. + * Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. */ enabled?: boolean; /** - * Select only event tags with the specified event tag types. Event tag - * types can be used to specify whether to use a third-party pixel, a - * third-party JavaScript URL, or a third-party click-through URL for either - * impression or click tracking. + * Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. */ eventTagTypes?: string[]; /** @@ -17776,13 +16343,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "eventtag*2015" will return objects with names like - * "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "eventtag" will - * match objects with name "my eventtag", "eventtag 2015", or simply - * "eventtag". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". */ searchString?: string; /** @@ -17839,8 +16400,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.files.get - * @desc Retrieves a report file by its report ID and file ID. This method - * supports media download. + * @desc Retrieves a report file by its report ID and file ID. This method supports media download. * @alias dfareporting.files.get * @memberOf! () * @@ -18355,8 +16915,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.list - * @desc Retrieves a list of floodlight activities, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging. * @alias dfareporting.floodlightActivities.list * @memberOf! () * @@ -18452,8 +17011,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.patch - * @desc Updates an existing floodlight activity. This method supports patch - * semantics. + * @desc Updates an existing floodlight activity. This method supports patch semantics. * @alias dfareporting.floodlightActivities.patch * @memberOf! () * @@ -18676,41 +17234,31 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only floodlight activities for the specified advertiser ID. Must - * specify either ids, advertiserId, or floodlightConfigurationId for a - * non-empty result. + * Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ advertiserId?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group IDs. + * Select only floodlight activities with the specified floodlight activity group IDs. */ floodlightActivityGroupIds?: string[]; /** - * Select only floodlight activities with the specified floodlight activity - * group name. + * Select only floodlight activities with the specified floodlight activity group name. */ floodlightActivityGroupName?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group tag string. + * Select only floodlight activities with the specified floodlight activity group tag string. */ floodlightActivityGroupTagString?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group type. + * Select only floodlight activities with the specified floodlight activity group type. */ floodlightActivityGroupType?: string; /** - * Select only floodlight activities for the specified floodlight - * configuration ID. Must specify either ids, advertiserId, or - * floodlightConfigurationId for a non-empty result. + * Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ floodlightConfigurationId?: string; /** - * Select only floodlight activities with the specified IDs. Must specify - * either ids, advertiserId, or floodlightConfigurationId for a non-empty - * result. + * Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ ids?: string[]; /** @@ -18726,14 +17274,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivity*2015" will return objects with names - * like "floodlightactivity June 2015", "floodlightactivity April 2015", or - * simply "floodlightactivity 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "floodlightactivity" will match objects with name "my - * floodlightactivity activity", "floodlightactivity 2015", or simply - * "floodlightactivity". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". */ searchString?: string; /** @@ -18952,8 +17493,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivityGroups.list - * @desc Retrieves a list of floodlight activity groups, possibly filtered. - * This method supports paging. + * @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. * @alias dfareporting.floodlightActivityGroups.list * @memberOf! () * @@ -19053,8 +17593,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivityGroups.patch - * @desc Updates an existing floodlight activity group. This method supports - * patch semantics. + * @desc Updates an existing floodlight activity group. This method supports patch semantics. * @alias dfareporting.floodlightActivityGroups.patch * @memberOf! () * @@ -19251,21 +17790,15 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only floodlight activity groups with the specified advertiser ID. - * Must specify either advertiserId or floodlightConfigurationId for a - * non-empty result. + * Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. */ advertiserId?: string; /** - * Select only floodlight activity groups with the specified floodlight - * configuration ID. Must specify either advertiserId, or - * floodlightConfigurationId for a non-empty result. + * Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. */ floodlightConfigurationId?: string; /** - * Select only floodlight activity groups with the specified IDs. Must - * specify either advertiserId or floodlightConfigurationId for a non-empty - * result. + * Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. */ ids?: string[]; /** @@ -19281,14 +17814,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivitygroup*2015" will return objects with - * names like "floodlightactivitygroup June 2015", "floodlightactivitygroup - * April 2015", or simply "floodlightactivitygroup 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "floodlightactivitygroup" - * will match objects with name "my floodlightactivitygroup activity", - * "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". */ searchString?: string; /** @@ -19300,8 +17826,7 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; /** - * Select only floodlight activity groups with the specified floodlight - * activity group type. + * Select only floodlight activity groups with the specified floodlight activity group type. */ type?: string; } @@ -19521,8 +18046,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightConfigurations.patch - * @desc Updates an existing floodlight configuration. This method supports - * patch semantics. + * @desc Updates an existing floodlight configuration. This method supports patch semantics. * @alias dfareporting.floodlightConfigurations.patch * @memberOf! () * @@ -19702,8 +18226,7 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set of IDs of floodlight configurations to retrieve. Required field; - * otherwise an empty list will be returned. + * Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. */ ids?: string[]; /** @@ -19834,8 +18357,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.inventoryItems.list - * @desc Retrieves a list of inventory items, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of inventory items, possibly filtered. This method supports paging. * @alias dfareporting.inventoryItems.list * @memberOf! () * @@ -20384,12 +18906,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "app*2015" will return objects with names like "app Jan - * 2018", "app Jan 2018", or simply "app 2018". Most of the searches also - * add wildcards implicitly at the start and the end of the search string. - * For example, a search string of "app" will match objects with name "my - * app", "app 2018", or simply "app". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". */ searchString?: string; } @@ -21062,8 +19579,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.orderDocuments.list - * @desc Retrieves a list of order documents, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of order documents, possibly filtered. This method supports paging. * @alias dfareporting.orderDocuments.list * @memberOf! () * @@ -21209,13 +19725,7 @@ export namespace dfareporting_v3_1 { */ projectId?: string; /** - * Allows searching for order documents by name or ID. Wildcards (*) are - * allowed. For example, "orderdocument*2015" will return order documents - * with names like "orderdocument June 2015", "orderdocument April 2015", or - * simply "orderdocument 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "orderdocument" will match order documents with name "my - * orderdocument", "orderdocument 2015", or simply "orderdocument". + * Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". */ searchString?: string; /** @@ -21313,8 +19823,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.orders.list - * @desc Retrieves a list of orders, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of orders, possibly filtered. This method supports paging. * @alias dfareporting.orders.list * @memberOf! () * @@ -21440,12 +19949,7 @@ export namespace dfareporting_v3_1 { */ projectId?: string; /** - * Allows searching for orders by name or ID. Wildcards (*) are allowed. For - * example, "order*2015" will return orders with names like "order June - * 2015", "order April 2015", or simply "order 2015". Most of the searches - * also add wildcards implicitly at the start and the end of the search - * string. For example, a search string of "order" will match orders with - * name "my order", "order 2015", or simply "order". + * Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". */ searchString?: string; /** @@ -21620,8 +20124,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementGroups.list - * @desc Retrieves a list of placement groups, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of placement groups, possibly filtered. This method supports paging. * @alias dfareporting.placementGroups.list * @memberOf! () * @@ -21721,8 +20224,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementGroups.patch - * @desc Updates an existing placement group. This method supports patch - * semantics. + * @desc Updates an existing placement group. This method supports patch semantics. * @alias dfareporting.placementGroups.patch * @memberOf! () * @@ -21917,8 +20419,7 @@ export namespace dfareporting_v3_1 { */ advertiserIds?: string[]; /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. + * Select only archived placements. Don't set this field to select both archived and non-archived placements. */ archived?: boolean; /** @@ -21926,13 +20427,11 @@ export namespace dfareporting_v3_1 { */ campaignIds?: string[]; /** - * Select only placement groups that are associated with these content - * categories. + * Select only placement groups that are associated with these content categories. */ contentCategoryIds?: string[]; /** - * Select only placement groups that are associated with these directory - * sites. + * Select only placement groups that are associated with these directory sites. */ directorySiteIds?: string[]; /** @@ -21940,8 +20439,7 @@ export namespace dfareporting_v3_1 { */ ids?: string[]; /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". */ maxEndDate?: string; /** @@ -21949,20 +20447,15 @@ export namespace dfareporting_v3_1 { */ maxResults?: number; /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". */ maxStartDate?: string; /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". */ minEndDate?: string; /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". */ minStartDate?: string; /** @@ -21970,17 +20463,11 @@ export namespace dfareporting_v3_1 { */ pageToken?: string; /** - * Select only placement groups belonging with this group type. A package is - * a simple group of placements that acts as a single pricing point for a - * group of tags. A roadblock is a group of placements that not only acts as - * a single pricing point but also assumes that all the tags in it will be - * served at the same time. A roadblock requires one of its assigned - * placements to be marked as primary for reporting. + * Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. */ placementGroupType?: string; /** - * Select only placement groups that are associated with these placement - * strategies. + * Select only placement groups that are associated with these placement strategies. */ placementStrategyIds?: string[]; /** @@ -21992,13 +20479,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for placement groups by name or ID. Wildcards (*) are - * allowed. For example, "placement*2015" will return placement groups with - * names like "placement group June 2015", "placement group May 2015", or - * simply "placements 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementgroup" will match placement groups with name - * "my placementgroup", "placementgroup 2015", or simply "placementgroup". + * Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". */ searchString?: string; /** @@ -22295,8 +20776,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.list - * @desc Retrieves a list of placements, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of placements, possibly filtered. This method supports paging. * @alias dfareporting.placements.list * @memberOf! () * @@ -22392,8 +20872,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.patch - * @desc Updates an existing placement. This method supports patch - * semantics. + * @desc Updates an existing placement. This method supports patch semantics. * @alias dfareporting.placements.patch * @memberOf! () * @@ -22560,8 +21039,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Tag formats to generate for these placements. Note: - * PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + * Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. */ tagFormats?: string[]; } @@ -22608,8 +21086,7 @@ export namespace dfareporting_v3_1 { */ advertiserIds?: string[]; /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. + * Select only archived placements. Don't set this field to select both archived and non-archived placements. */ archived?: boolean; /** @@ -22617,11 +21094,7 @@ export namespace dfareporting_v3_1 { */ campaignIds?: string[]; /** - * Select only placements that are associated with these compatibilities. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices for regular or interstitial ads respectively. APP and - * APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers - * to rendering in in-stream video ads developed with the VAST standard. + * Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. */ compatibilities?: string[]; /** @@ -22641,8 +21114,7 @@ export namespace dfareporting_v3_1 { */ ids?: string[]; /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". */ maxEndDate?: string; /** @@ -22650,20 +21122,15 @@ export namespace dfareporting_v3_1 { */ maxResults?: number; /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". */ maxStartDate?: string; /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". */ minEndDate?: string; /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". */ minStartDate?: string; /** @@ -22675,8 +21142,7 @@ export namespace dfareporting_v3_1 { */ paymentSource?: string; /** - * Select only placements that are associated with these placement - * strategies. + * Select only placements that are associated with these placement strategies. */ placementStrategyIds?: string[]; /** @@ -22688,13 +21154,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for placements by name or ID. Wildcards (*) are allowed. - * For example, "placement*2015" will return placements with names like - * "placement June 2015", "placement May 2015", or simply "placements 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "placement" - * will match placements with name "my placement", "placement 2015", or - * simply "placement". + * Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". */ searchString?: string; /** @@ -22983,8 +21443,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.list - * @desc Retrieves a list of placement strategies, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging. * @alias dfareporting.placementStrategies.list * @memberOf! () * @@ -23073,8 +21532,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.patch - * @desc Updates an existing placement strategy. This method supports patch - * semantics. + * @desc Updates an existing placement strategy. This method supports patch semantics. * @alias dfareporting.placementStrategies.patch * @memberOf! () * @@ -23297,14 +21755,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "placementstrategy*2015" will return objects with names like - * "placementstrategy June 2015", "placementstrategy April 2015", or simply - * "placementstrategy 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementstrategy" will match objects with name "my - * placementstrategy", "placementstrategy 2015", or simply - * "placementstrategy". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". */ searchString?: string; /** @@ -23810,8 +22261,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.projects.list - * @desc Retrieves a list of projects, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of projects, possibly filtered. This method supports paging. * @alias dfareporting.projects.list * @memberOf! () * @@ -23933,12 +22383,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for projects by name or ID. Wildcards (*) are allowed. - * For example, "project*2015" will return projects with names like "project - * June 2015", "project April 2015", or simply "project 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "project" will match - * projects with name "my project", "project 2015", or simply "project". + * Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". */ searchString?: string; /** @@ -24200,8 +22645,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingLists.list - * @desc Retrieves a list of remarketing lists, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging. * @alias dfareporting.remarketingLists.list * @memberOf! () * @@ -24292,8 +22736,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingLists.patch - * @desc Updates an existing remarketing list. This method supports patch - * semantics. + * @desc Updates an existing remarketing list. This method supports patch semantics. * @alias dfareporting.remarketingLists.patch * @memberOf! () * @@ -24500,13 +22943,7 @@ export namespace dfareporting_v3_1 { */ maxResults?: number; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". */ name?: string; /** @@ -24650,8 +23087,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingListShares.patch - * @desc Updates an existing remarketing list share. This method supports - * patch semantics. + * @desc Updates an existing remarketing list share. This method supports patch semantics. * @alias dfareporting.remarketingListShares.patch * @memberOf! () * @@ -25529,9 +23965,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.compatibleFields.query - * @desc Returns the fields that are compatible to be selected in the - * respective sections of a report criteria, given the fields already - * selected in the input report and user permissions. + * @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. * @alias dfareporting.reports.compatibleFields.query * @memberOf! () * @@ -25984,8 +24418,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sites.list - * @desc Retrieves a list of sites, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of sites, possibly filtered. This method supports paging. * @alias dfareporting.sites.list * @memberOf! () * @@ -26252,13 +24685,11 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInStreamVideoPlacements?: boolean; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInterstitialPlacements?: boolean; /** @@ -26298,12 +24729,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name, ID or keyName. Wildcards (*) are - * allowed. For example, "site*2015" will return objects with names like - * "site June 2015", "site April 2015", or simply "site 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "site" will match objects - * with name "my site", "site 2015", or simply "site". + * Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". */ searchString?: string; /** @@ -26510,10 +24936,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sizes.list - * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are - * globally unique and may include values not currently in use by your - * account. Due to this, the list of sizes returned by this method may - * differ from the list seen in the Trafficking UI. + * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. * @alias dfareporting.sizes.list * @memberOf! () * @@ -26804,8 +25227,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.subaccounts.list - * @desc Gets a list of subaccounts, possibly filtered. This method supports - * paging. + * @desc Gets a list of subaccounts, possibly filtered. This method supports paging. * @alias dfareporting.subaccounts.list * @memberOf! () * @@ -26886,8 +25308,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.subaccounts.patch - * @desc Updates an existing subaccount. This method supports patch - * semantics. + * @desc Updates an existing subaccount. This method supports patch semantics. * @alias dfareporting.subaccounts.patch * @memberOf! () * @@ -27092,13 +25513,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "subaccount*2015" will return objects with names like - * "subaccount June 2015", "subaccount April 2015", or simply "subaccount - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "subaccount" will match objects with name "my subaccount", "subaccount - * 2015", or simply "subaccount". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". */ searchString?: string; /** @@ -27237,8 +25652,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetableRemarketingLists.list - * @desc Retrieves a list of targetable remarketing lists, possibly - * filtered. This method supports paging. + * @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. * @alias dfareporting.targetableRemarketingLists.list * @memberOf! () * @@ -27371,13 +25785,7 @@ export namespace dfareporting_v3_1 { */ maxResults?: number; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". */ name?: string; /** @@ -27556,8 +25964,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetingTemplates.list - * @desc Retrieves a list of targeting templates, optionally filtered. This - * method supports paging. + * @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging. * @alias dfareporting.targetingTemplates.list * @memberOf! () * @@ -27647,8 +26054,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetingTemplates.patch - * @desc Updates an existing targeting template. This method supports patch - * semantics. + * @desc Updates an existing targeting template. This method supports patch semantics. * @alias dfareporting.targetingTemplates.patch * @memberOf! () * @@ -27859,13 +26265,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "template*2015" will return objects with names like - * "template June 2015", "template April 2015", or simply "template 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "template" will - * match objects with name "my template", "template 2015", or simply - * "template". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". */ searchString?: string; /** @@ -28713,8 +27113,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.list - * @desc Retrieves a list of user roles, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of user roles, possibly filtered. This method supports paging. * @alias dfareporting.userRoles.list * @memberOf! () * @@ -28796,8 +27195,7 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.patch - * @desc Updates an existing user role. This method supports patch - * semantics. + * @desc Updates an existing user role. This method supports patch semantics. * @alias dfareporting.userRoles.patch * @memberOf! () * @@ -28992,8 +27390,7 @@ export namespace dfareporting_v3_1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only account level user roles not associated with any specific - * subaccount. + * Select only account level user roles not associated with any specific subaccount. */ accountUserRoleOnly?: boolean; /** @@ -29013,13 +27410,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "userrole*2015" will return objects with names like - * "userrole June 2015", "userrole April 2015", or simply "userrole 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "userrole" will - * match objects with name "my userrole", "userrole 2015", or simply - * "userrole". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". */ searchString?: string; /** diff --git a/src/apis/dfareporting/v3.2.ts b/src/apis/dfareporting/v3.2.ts index ca4d0386c4d..4ce9d00c5c3 100644 --- a/src/apis/dfareporting/v3.2.ts +++ b/src/apis/dfareporting/v3.2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace dfareporting_v3_2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace dfareporting_v3_2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -155,7 +152,10 @@ export namespace dfareporting_v3_2 { videoFormats: Resource$Videoformats; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries( this.context @@ -256,8 +256,7 @@ export namespace dfareporting_v3_2 { */ accountPermissionIds?: string[]; /** - * Profile for this account. This is a read-only field that can be left - * blank. + * Profile for this account. This is a read-only field that can be left blank. */ accountProfile?: string; /** @@ -269,8 +268,7 @@ export namespace dfareporting_v3_2 { */ activeAdsLimitTier?: string; /** - * Whether to serve creatives with Active View tags. If disabled, - * viewability data will not be available for any impressions. + * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. */ activeViewOptOut?: boolean; /** @@ -282,26 +280,7 @@ export namespace dfareporting_v3_2 { */ countryId?: string; /** - * ID of currency associated with this account. This is a required field. - * Acceptable values are: - "1" for USD - "2" for GBP - * - "3" for ESP - "4" for SEK - "5" for CAD - * - "6" for JPY - "7" for DEM - "8" for AUD - * - "9" for FRF - "10" for ITL - "11" for - * DKK - "12" for NOK - "13" for FIM - "14" - * for ZAR - "15" for IEP - "16" for NLG - - * "17" for EUR - "18" for KRW - "19" for - * TWD - "20" for SGD - "21" for CNY - "22" - * for HKD - "23" for NZD - "24" for MYR - - * "25" for BRL - "26" for PTE - "27" for - * MXP - "28" for CLP - "29" for TRY - "30" - * for ARS - "31" for PEN - "32" for ILS - - * "33" for CHF - "34" for VEF - "35" for - * COP - "36" for GTQ - "37" for PLN - "39" - * for INR - "40" for THB - "41" for IDR - - * "42" for CZK - "43" for RON - "44" for - * HUF - "45" for RUB - "46" for AED - "47" - * for BGN - "48" for HRK - "49" for MXN - - * "50" for NGN + * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ currencyId?: string; /** @@ -317,34 +296,23 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#account". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". */ kind?: string; /** - * Locale of this account. Acceptable values are: - "cs" (Czech) - * - "de" (German) - "en" (English) - - * "en-GB" (English United Kingdom) - "es" (Spanish) - - * "fr" (French) - "it" (Italian) - "ja" - * (Japanese) - "ko" (Korean) - "pl" (Polish) - - * "pt-BR" (Portuguese Brazil) - "ru" (Russian) - - * "sv" (Swedish) - "tr" (Turkish) - "zh-CN" - * (Chinese Simplified) - "zh-TW" (Chinese Traditional) + * Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) */ locale?: string; /** - * Maximum image size allowed for this account, in kilobytes. Value must be - * greater than or equal to 1. + * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. */ maximumImageSize?: string; /** - * Name of this account. This is a required field, and must be less than 128 - * characters long and be globally unique. + * Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. */ name?: string; /** - * Whether campaigns created in this account will be enabled for Nielsen OCR - * reach ratings by default. + * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. */ nielsenOcrEnabled?: boolean; /** @@ -356,8 +324,7 @@ export namespace dfareporting_v3_2 { */ shareReportsWithTwitter?: boolean; /** - * File size limit in kilobytes of Rich Media teaser creatives. Acceptable - * values are 1 to 10240, inclusive. + * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. */ teaserSizeLimit?: string; } @@ -382,21 +349,16 @@ export namespace dfareporting_v3_2 { */ availableAds?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountActiveAdSummary". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". */ kind?: string; } /** - * AccountPermissions contains information about a particular account - * permission. Some features of Campaign Manager require an account permission - * to be present in the account. + * AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account. */ export interface Schema$AccountPermission { /** - * Account profiles associated with this account permission. Possible - * values are: - "ACCOUNT_PROFILE_BASIC" - - * "ACCOUNT_PROFILE_STANDARD" + * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" */ accountProfiles?: string[]; /** @@ -404,8 +366,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermission". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". */ kind?: string; /** @@ -422,8 +383,7 @@ export namespace dfareporting_v3_2 { permissionGroupId?: string; } /** - * AccountPermissionGroups contains a mapping of permission group IDs to - * names. A permission group is a grouping of account permissions. + * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. */ export interface Schema$AccountPermissionGroup { /** @@ -431,8 +391,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". */ kind?: string; /** @@ -449,8 +408,7 @@ export namespace dfareporting_v3_2 { */ accountPermissionGroups?: Schema$AccountPermissionGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". */ kind?: string; } @@ -463,8 +421,7 @@ export namespace dfareporting_v3_2 { */ accountPermissions?: Schema$AccountPermission[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". */ kind?: string; } @@ -477,8 +434,7 @@ export namespace dfareporting_v3_2 { */ accounts?: Schema$Account[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". */ kind?: string; /** @@ -487,19 +443,15 @@ export namespace dfareporting_v3_2 { nextPageToken?: string; } /** - * AccountUserProfiles contains properties of a Campaign Manager user profile. - * This resource is specifically for managing user profiles, whereas - * UserProfiles is for accessing the API. + * AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API. */ export interface Schema$AccountUserProfile { /** - * Account ID of the user profile. This is a read-only field that can be - * left blank. + * Account ID of the user profile. This is a read-only field that can be left blank. */ accountId?: string; /** - * Whether this user profile is active. This defaults to false, and must be - * set true on insert for the user profile to be usable. + * Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. */ active?: boolean; /** @@ -515,9 +467,7 @@ export namespace dfareporting_v3_2 { */ comments?: string; /** - * Email of the user profile. The email addresss must be linked to a Google - * Account. This field is required on insertion and is read-only after - * insertion. + * Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. */ email?: string; /** @@ -525,26 +475,15 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfile". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". */ kind?: string; /** - * Locale of the user profile. This is a required field. Acceptable values - * are: - "cs" (Czech) - "de" (German) - - * "en" (English) - "en-GB" (English United Kingdom) - - * "es" (Spanish) - "fr" (French) - "it" - * (Italian) - "ja" (Japanese) - "ko" (Korean) - - * "pl" (Polish) - "pt-BR" (Portuguese Brazil) - - * "ru" (Russian) - "sv" (Swedish) - "tr" - * (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" - * (Chinese Traditional) + * Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) */ locale?: string; /** - * Name of the user profile. This is a required field. Must be less than 64 - * characters long, must be globally unique, and cannot contain whitespace - * or any of the following characters: "&;"#%,". + * Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,". */ name?: string; /** @@ -552,8 +491,7 @@ export namespace dfareporting_v3_2 { */ siteFilter?: Schema$ObjectFilter; /** - * Subaccount ID of the user profile. This is a read-only field that can be - * left blank. + * Subaccount ID of the user profile. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -561,8 +499,7 @@ export namespace dfareporting_v3_2 { */ traffickerType?: string; /** - * User type of the user profile. This is a read-only field that can be left - * blank. + * User type of the user profile. This is a read-only field that can be left blank. */ userAccessType?: string; /** @@ -583,8 +520,7 @@ export namespace dfareporting_v3_2 { */ accountUserProfiles?: Schema$AccountUserProfile[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfilesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". */ kind?: string; /** @@ -597,8 +533,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Activities { /** - * List of activity filters. The dimension values need to be all either of - * type "dfa:activity" or "dfa:activityGroup". + * List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". */ filters?: Schema$DimensionValue[]; /** @@ -627,8 +562,7 @@ export namespace dfareporting_v3_2 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -636,8 +570,7 @@ export namespace dfareporting_v3_2 { */ archived?: boolean; /** - * Audience segment ID that is being targeted for this ad. Applicable when - * type is AD_SERVING_STANDARD_AD. + * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. */ audienceSegmentId?: string; /** @@ -645,18 +578,15 @@ export namespace dfareporting_v3_2 { */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * Click-through URL for this ad. This is a required field on insertion. - * Applicable when type is AD_SERVING_CLICK_TRACKER. + * Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Click-through URL suffix properties for this ad. Applies to the URL in - * the ad or (if overriding ad properties) the URL in the creative. + * Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative. */ clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; /** @@ -664,14 +594,7 @@ export namespace dfareporting_v3_2 { */ comments?: string; /** - * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. - * DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are only used for existing default - * ads. New mobile placements must be assigned DISPLAY or - * DISPLAY_INTERSTITIAL and default ads created for those placements will be - * limited to those compatibility types. IN_STREAM_VIDEO refers to rendering - * in-stream video ads developed with the VAST standard. + * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -679,22 +602,15 @@ export namespace dfareporting_v3_2 { */ createInfo?: Schema$LastModifiedInfo; /** - * Creative group assignments for this ad. Applicable when type is - * AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number - * is allowed for a maximum of two assignments. + * Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments. */ creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; /** - * Creative rotation for this ad. Applicable when type is - * AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. - * When type is AD_SERVING_DEFAULT_AD, this field should have exactly one - * creativeAssignment. + * Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment. */ creativeRotation?: Schema$CreativeRotation; /** - * Time and day targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ dayPartTargeting?: Schema$DayPartTargeting; /** @@ -702,21 +618,15 @@ export namespace dfareporting_v3_2 { */ defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; /** - * Delivery schedule information for this ad. Applicable when type is - * AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with - * subfields priority and impressionRatio are required on insertion when - * type is AD_SERVING_STANDARD_AD. + * Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD. */ deliverySchedule?: Schema$DeliverySchedule; /** - * Whether this ad is a dynamic click tracker. Applicable when type is - * AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is - * read-only after insert. + * Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. */ dynamicClickTracker?: boolean; /** - * Date and time that this ad should stop serving. Must be later than the - * start time. This is a required field on insertion. + * Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. */ endTime?: string; /** @@ -724,9 +634,7 @@ export namespace dfareporting_v3_2 { */ eventTagOverrides?: Schema$EventTagOverride[]; /** - * Geographical targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ geoTargeting?: Schema$GeoTargeting; /** @@ -734,35 +642,27 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the ID of this ad. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this ad. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Key-value targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ad". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". */ kind?: string; /** - * Language targeting information for this ad. This field must be left blank - * if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ languageTargeting?: Schema$LanguageTargeting; /** - * Information about the most recent modification of this ad. This is a - * read-only field. + * Information about the most recent modification of this ad. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this ad. This is a required field and must be less than 256 - * characters long. + * Name of this ad. This is a required field and must be less than 256 characters long. */ name?: string; /** @@ -770,9 +670,7 @@ export namespace dfareporting_v3_2 { */ placementAssignments?: Schema$PlacementAssignment[]; /** - * Remarketing list targeting expression for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. + * Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ remarketingListExpression?: Schema$ListTargetingExpression; /** @@ -780,44 +678,31 @@ export namespace dfareporting_v3_2 { */ size?: Schema$Size; /** - * Whether this ad is ssl compliant. This is a read-only field that is - * auto-generated when the ad is inserted or updated. + * Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslCompliant?: boolean; /** - * Whether this ad requires ssl. This is a read-only field that is - * auto-generated when the ad is inserted or updated. + * Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslRequired?: boolean; /** - * Date and time that this ad should start serving. If creating an ad, this - * field must be a time in the future. This is a required field on - * insertion. + * Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion. */ startTime?: string; /** - * Subaccount ID of this ad. This is a read-only field that can be left - * blank. + * Subaccount ID of this ad. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Targeting template ID, used to apply preconfigured targeting information - * to this ad. This cannot be set while any of dayPartTargeting, - * geoTargeting, keyValueTargetingExpression, languageTargeting, - * remarketingListExpression, or technologyTargeting are set. Applicable - * when type is AD_SERVING_STANDARD_AD. + * Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. */ targetingTemplateId?: string; /** - * Technology platform targeting information for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. + * Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ technologyTargeting?: Schema$TechnologyTargeting; /** - * Type of ad. This is a required field on insertion. Note that default ads - * (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative - * resource). + * Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). */ type?: string; } @@ -826,27 +711,19 @@ export namespace dfareporting_v3_2 { */ export interface Schema$AdBlockingConfiguration { /** - * Click-through URL used by brand-neutral ads. This is a required field - * when overrideClickThroughUrl is set to true. + * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. */ clickThroughUrl?: string; /** - * ID of a creative bundle to use for this campaign. If set, brand-neutral - * ads will select creatives from this bundle. Otherwise, a default - * transparent pixel will be used. + * ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. */ creativeBundleId?: string; /** - * Whether this campaign has enabled ad blocking. When true, ad blocking is - * enabled for placements in the campaign, but this may be overridden by - * site and placement settings. When false, ad blocking is disabled for all - * placements under the campaign, regardless of site and placement settings. + * Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. */ enabled?: boolean; /** - * Whether the brand-neutral ad's click-through URL comes from the - * campaign's creative bundle or the override URL. Must be set to true - * if ad blocking is enabled and no creative bundle is configured. + * Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. */ overrideClickThroughUrl?: boolean; } @@ -859,8 +736,7 @@ export namespace dfareporting_v3_2 { */ ads?: Schema$Ad[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#adsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". */ kind?: string; /** @@ -877,11 +753,7 @@ export namespace dfareporting_v3_2 { */ comment?: string; /** - * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop, mobile devices or in mobile apps for regular - * or interstitial ads respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in - * in-stream video ads developed with the VAST standard. + * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -889,8 +761,7 @@ export namespace dfareporting_v3_2 { */ height?: string; /** - * ID of the placement from an external platform that is linked to this ad - * slot. + * ID of the placement from an external platform that is linked to this ad slot. */ linkedPlacementId?: string; /** @@ -915,24 +786,19 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Advertiser { /** - * Account ID of this advertiser.This is a read-only field that can be left - * blank. + * Account ID of this advertiser.This is a read-only field that can be left blank. */ accountId?: string; /** - * ID of the advertiser group this advertiser belongs to. You can group - * advertisers for reporting purposes, allowing you to see aggregated - * information for all advertisers in each group. + * ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. */ advertiserGroupId?: string; /** - * Suffix added to click-through URL of ad creative associations under this - * advertiser. Must be less than 129 characters long. + * Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. */ clickThroughUrlSuffix?: string; /** - * ID of the click-through event tag to apply by default to the landing - * pages of this advertiser's campaigns. + * ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. */ defaultClickThroughEventTagId?: string; /** @@ -940,20 +806,11 @@ export namespace dfareporting_v3_2 { */ defaultEmail?: string; /** - * Floodlight configuration ID of this advertiser. The floodlight - * configuration ID will be created automatically, so on insert this field - * should be left blank. This field can be set to another advertiser's - * floodlight configuration ID in order to share that advertiser's - * floodlight configuration with this advertiser, so long as: - This - * advertiser's original floodlight configuration is not already - * associated with floodlight activities or floodlight activity groups. - - * This advertiser's original floodlight configuration is not already - * shared with another advertiser. + * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** @@ -961,27 +818,19 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the ID of this advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiser". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". */ kind?: string; /** - * Name of this advertiser. This is a required field and must be less than - * 256 characters long and unique among advertisers of the same account. + * Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. */ name?: string; /** - * Original floodlight configuration before any sharing occurred. Set the - * floodlightConfigurationId of this advertiser to - * originalFloodlightConfigurationId to unshare the advertiser's current - * floodlight configuration. You cannot unshare an advertiser's - * floodlight configuration if the shared configuration has activities - * associated with any campaign or placement. + * Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. */ originalFloodlightConfigurationId?: string; /** @@ -989,8 +838,7 @@ export namespace dfareporting_v3_2 { */ status?: string; /** - * Subaccount ID of this advertiser.This is a read-only field that can be - * left blank. + * Subaccount ID of this advertiser.This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -999,13 +847,11 @@ export namespace dfareporting_v3_2 { suspended?: boolean; } /** - * Groups advertisers together so that reports can be generated for the entire - * group at once. + * Groups advertisers together so that reports can be generated for the entire group at once. */ export interface Schema$AdvertiserGroup { /** - * Account ID of this advertiser group. This is a read-only field that can - * be left blank. + * Account ID of this advertiser group. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1013,14 +859,11 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". */ kind?: string; /** - * Name of this advertiser group. This is a required field and must be less - * than 256 characters long and unique among advertiser groups of the same - * account. + * Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. */ name?: string; } @@ -1033,8 +876,7 @@ export namespace dfareporting_v3_2 { */ advertiserGroups?: Schema$AdvertiserGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". */ kind?: string; /** @@ -1047,8 +889,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$AdvertiserLandingPagesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserLandingPagesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". */ kind?: string; /** @@ -1069,8 +910,7 @@ export namespace dfareporting_v3_2 { */ advertisers?: Schema$Advertiser[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertisersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". */ kind?: string; /** @@ -1083,9 +923,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$AudienceSegment { /** - * Weight allocated to this segment. The weight assigned will be understood - * in proportion to the weights assigned to other segments in the same - * segment group. Acceptable values are 1 to 1000, inclusive. + * Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. */ allocation?: number; /** @@ -1093,8 +931,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Name of this audience segment. This is a required field and must be less - * than 65 characters long. + * Name of this audience segment. This is a required field and must be less than 65 characters long. */ name?: string; } @@ -1103,18 +940,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$AudienceSegmentGroup { /** - * Audience segments assigned to this group. The number of segments must be - * between 2 and 100. + * Audience segments assigned to this group. The number of segments must be between 2 and 100. */ audienceSegments?: Schema$AudienceSegment[]; /** - * ID of this audience segment group. This is a read-only, auto-generated - * field. + * ID of this audience segment group. This is a read-only, auto-generated field. */ id?: string; /** - * Name of this audience segment group. This is a required field and must be - * less than 65 characters long. + * Name of this audience segment group. This is a required field and must be less than 65 characters long. */ name?: string; } @@ -1123,8 +957,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Browser { /** - * ID referring to this grouping of browser and version numbers. This is the - * ID used for targeting. + * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. */ browserVersionId?: string; /** @@ -1132,30 +965,15 @@ export namespace dfareporting_v3_2 { */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browser". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". */ kind?: string; /** - * Major version number (leftmost number) of this browser. For example, for - * Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) - * may be used to target any version number, and a question mark (?) may be - * used to target cases where the version number cannot be identified. For - * example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so - * on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets - * cases where the ad server knows the browser is Firefox but can't tell - * which version it is. + * Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. */ majorVersion?: string; /** - * Minor version number (number after first dot on left) of this browser. - * For example, for Chrome 5.0.375.86 beta, this field should be set to 0. - * An asterisk (*) may be used to target any version number, and a question - * mark (?) may be used to target cases where the version number cannot be - * identified. For example, Chrome *.* targets any version of Chrome: - * 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but - * not 4.0. Firefox ?.? targets cases where the ad server knows the browser - * is Firefox but can't tell which version it is. + * Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. */ minorVersion?: string; /** @@ -1172,8 +990,7 @@ export namespace dfareporting_v3_2 { */ browsers?: Schema$Browser[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browsersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". */ kind?: string; } @@ -1182,8 +999,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Campaign { /** - * Account ID of this campaign. This is a read-only field that can be left - * blank. + * Account ID of this campaign. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1203,8 +1019,7 @@ export namespace dfareporting_v3_2 { */ advertiserId?: string; /** - * Dimension value for the advertiser ID of this campaign. This is a - * read-only, auto-generated field. + * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -1212,13 +1027,11 @@ export namespace dfareporting_v3_2 { */ archived?: boolean; /** - * Audience segment groups assigned to this campaign. Cannot have more than - * 300 segment groups. + * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. */ audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; /** - * Billing invoice code included in the Campaign Manager client billing - * invoices associated with the campaign. + * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. */ billingInvoiceCode?: string; /** @@ -1226,13 +1039,11 @@ export namespace dfareporting_v3_2 { */ clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; /** - * Arbitrary comments about this campaign. Must be less than 256 characters - * long. + * Arbitrary comments about this campaign. Must be less than 256 characters long. */ comment?: string; /** - * Information about the creation of this campaign. This is a read-only - * field. + * Information about the creation of this campaign. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** @@ -1252,18 +1063,11 @@ export namespace dfareporting_v3_2 { */ defaultLandingPageId?: string; /** - * Date on which the campaign will stop running. On insert, the end date - * must be today or a future date. The end date must be later than or be the - * same as the start date. If, for example, you set 6/25/2015 as both the - * start and end dates, the effective campaign run date is just that day - * only, 6/25/2015. The hours, minutes, and seconds of the end date should - * not be set, as doing so will result in an error. This is a required - * field. + * Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field. */ endDate?: string; /** - * Overrides that can be used to activate or deactivate advertiser event - * tags. + * Overrides that can be used to activate or deactivate advertiser event tags. */ eventTagOverrides?: Schema$EventTagOverride[]; /** @@ -1275,18 +1079,15 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the ID of this campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaign". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". */ kind?: string; /** - * Information about the most recent modification of this campaign. This is - * a read-only field. + * Information about the most recent modification of this campaign. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** @@ -1294,8 +1095,7 @@ export namespace dfareporting_v3_2 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Name of this campaign. This is a required field and must be less than 256 - * characters long and unique among campaigns of the same advertiser. + * Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. */ name?: string; /** @@ -1303,14 +1103,11 @@ export namespace dfareporting_v3_2 { */ nielsenOcrEnabled?: boolean; /** - * Date on which the campaign starts running. The start date can be any - * date. The hours, minutes, and seconds of the start date should not be - * set, as doing so will result in an error. This is a required field. + * Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field. */ startDate?: string; /** - * Subaccount ID of this campaign. This is a read-only field that can be - * left blank. + * Subaccount ID of this campaign. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -1323,13 +1120,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CampaignCreativeAssociation { /** - * ID of the creative associated with the campaign. This is a required - * field. + * ID of the creative associated with the campaign. This is a required field. */ creativeId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociation". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". */ kind?: string; } @@ -1342,8 +1137,7 @@ export namespace dfareporting_v3_2 { */ campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociationsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". */ kind?: string; /** @@ -1360,8 +1154,7 @@ export namespace dfareporting_v3_2 { */ campaigns?: Schema$Campaign[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". */ kind?: string; /** @@ -1394,8 +1187,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLog". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". */ kind?: string; /** @@ -1403,8 +1195,7 @@ export namespace dfareporting_v3_2 { */ newValue?: string; /** - * ID of the object of this change log. The object could be a campaign, - * placement, ad, or other type. + * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. */ objectId?: string; /** @@ -1420,9 +1211,7 @@ export namespace dfareporting_v3_2 { */ subaccountId?: string; /** - * Transaction ID of this change log. When a single API call results in many - * changes, each change will have a separate ID in the change log but will - * share the same transactionId. + * Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. */ transactionId?: string; /** @@ -1443,8 +1232,7 @@ export namespace dfareporting_v3_2 { */ changeLogs?: Schema$ChangeLog[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLogsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". */ kind?: string; /** @@ -1461,8 +1249,7 @@ export namespace dfareporting_v3_2 { */ cities?: Schema$City[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#citiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". */ kind?: string; } @@ -1479,13 +1266,11 @@ export namespace dfareporting_v3_2 { */ countryDartId?: string; /** - * DART ID of this city. This is the ID used for targeting and generating - * reports. + * DART ID of this city. This is the ID used for targeting and generating reports. */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#city". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". */ kind?: string; /** @@ -1514,20 +1299,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ClickTag { /** - * Parameter value for the specified click tag. This field contains a - * click-through url. + * Parameter value for the specified click tag. This field contains a click-through url. */ clickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * Advertiser event name associated with the click tag. This field is used - * by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. + * Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ eventName?: string; /** - * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY - * creative assets, this field must match the value of the creative - * asset's creativeAssetId.name field. + * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. */ name?: string; } @@ -1536,18 +1316,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ClickThroughUrl { /** - * Read-only convenience field representing the actual URL that will be used - * for this click-through. The URL is computed as follows: - If - * defaultLandingPage is enabled then the campaign's default landing - * page URL is assigned to this field. - If defaultLandingPage is not - * enabled and a landingPageId is specified then that landing page's URL - * is assigned to this field. - If neither of the above cases apply, then - * the customClickThroughUrl is assigned to this field. + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. */ computedClickThroughUrl?: string; /** - * Custom click-through URL. Applicable if the defaultLandingPage field is - * set to false and the landingPageId field is left unset. + * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. */ customClickThroughUrl?: string; /** @@ -1555,8 +1328,7 @@ export namespace dfareporting_v3_2 { */ defaultLandingPage?: boolean; /** - * ID of the landing page for the click-through URL. Applicable if the - * defaultLandingPage field is set to false. + * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. */ landingPageId?: string; } @@ -1565,13 +1337,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ClickThroughUrlSuffixProperties { /** - * Click-through URL suffix to apply to all ads in this entity's scope. - * Must be less than 128 characters long. + * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. */ clickThroughUrlSuffix?: string; /** - * Whether this entity should override the inherited click-through URL - * suffix with its own defined value. + * Whether this entity should override the inherited click-through URL suffix with its own defined value. */ overrideInheritedSuffix?: boolean; } @@ -1597,8 +1367,7 @@ export namespace dfareporting_v3_2 { */ companionsDisabled?: boolean; /** - * Whitelist of companion sizes to be served to this placement. Set this - * list to null or empty to serve all companion sizes. + * Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. */ enabledSizes?: Schema$Size[]; /** @@ -1606,8 +1375,7 @@ export namespace dfareporting_v3_2 { */ imageOnly?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#companionSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". */ kind?: string; } @@ -1616,13 +1384,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CompatibleFields { /** - * Contains items that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". + * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "FLOODLIGHT". + * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". */ floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; /** @@ -1630,25 +1396,20 @@ export namespace dfareporting_v3_2 { */ kind?: string; /** - * Contains items that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". + * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "REACH". + * Contains items that are compatible to be selected for a report of type "REACH". */ reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "STANDARD". + * Contains items that are compatible to be selected for a report of type "STANDARD". */ reportCompatibleFields?: Schema$ReportCompatibleFields; } /** - * Contains information about an internet connection type that can be targeted - * by ads. Clients can use the connection type to target mobile vs. broadband - * users. + * Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. */ export interface Schema$ConnectionType { /** @@ -1656,8 +1417,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionType". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". */ kind?: string; /** @@ -1674,8 +1434,7 @@ export namespace dfareporting_v3_2 { */ connectionTypes?: Schema$ConnectionType[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionTypesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". */ kind?: string; } @@ -1688,8 +1447,7 @@ export namespace dfareporting_v3_2 { */ contentCategories?: Schema$ContentCategory[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategoriesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". */ kind?: string; /** @@ -1698,13 +1456,11 @@ export namespace dfareporting_v3_2 { nextPageToken?: string; } /** - * Organizes placements according to the contents of their associated - * webpages. + * Organizes placements according to the contents of their associated webpages. */ export interface Schema$ContentCategory { /** - * Account ID of this content category. This is a read-only field that can - * be left blank. + * Account ID of this content category. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1712,25 +1468,20 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategory". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". */ kind?: string; /** - * Name of this content category. This is a required field and must be less - * than 256 characters long and unique among content categories of the same - * account. + * Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. */ name?: string; } /** - * A Conversion represents when a user successfully performs a desired action - * after seeing an ad. + * A Conversion represents when a user successfully performs a desired action after seeing an ad. */ export interface Schema$Conversion { /** - * Whether this particular request may come from a user under the age of 13, - * under COPPA compliance. + * Whether this particular request may come from a user under the age of 13, under COPPA compliance. */ childDirectedTreatment?: boolean; /** @@ -1738,22 +1489,11 @@ export namespace dfareporting_v3_2 { */ customVariables?: Schema$CustomFloodlightVariable[]; /** - * The alphanumeric encrypted user ID. When set, encryptionInfo should also - * be specified. This field is mutually exclusive with - * encryptedUserIdCandidates[], mobileDeviceId and gclid. This or - * encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required - * field. + * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. */ encryptedUserId?: string; /** - * A list of the alphanumeric encrypted user IDs. Any user ID with exposure - * prior to the conversion timestamp will be used in the inserted - * conversion. If no such user ID is found then the conversion will be - * rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo - * should also be specified. This field may only be used when calling - * batchinsert; it is not supported by batchupdate. This field is mutually - * exclusive with encryptedUserId, mobileDeviceId and gclid. This or - * encryptedUserId or mobileDeviceId or gclid is a required field. + * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. */ encryptedUserIdCandidates?: string[]; /** @@ -1765,28 +1505,19 @@ export namespace dfareporting_v3_2 { */ floodlightConfigurationId?: string; /** - * The Google click ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or - * encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a - * required field. + * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. */ gclid?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversion". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". */ kind?: string; /** - * Whether Limit Ad Tracking is enabled. When set to true, the conversion - * will be used for reporting but not targeting. This will prevent - * remarketing. + * Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. */ limitAdTracking?: boolean; /** - * The mobile device ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and gclid. This or - * encryptedUserId or encryptedUserIdCandidates[] or gclid is a required - * field. + * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. */ mobileDeviceId?: string; /** @@ -1794,8 +1525,7 @@ export namespace dfareporting_v3_2 { */ nonPersonalizedAd?: boolean; /** - * The ordinal of the conversion. Use this field to control how conversions - * of the same user and day are de-duplicated. This is a required field. + * The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. */ ordinal?: string; /** @@ -1803,14 +1533,11 @@ export namespace dfareporting_v3_2 { */ quantity?: string; /** - * The timestamp of conversion, in Unix epoch micros. This is a required - * field. + * The timestamp of conversion, in Unix epoch micros. This is a required field. */ timestampMicros?: string; /** - * Whether this particular request may come from a user under the age of 16 - * (may differ by country), under compliance with the European Union's - * General Data Protection Regulation (GDPR). + * Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). */ treatmentForUnderage?: boolean; /** @@ -1819,8 +1546,7 @@ export namespace dfareporting_v3_2 { value?: number; } /** - * The error code and description for a conversion that failed to insert or - * update. + * The error code and description for a conversion that failed to insert or update. */ export interface Schema$ConversionError { /** @@ -1828,8 +1554,7 @@ export namespace dfareporting_v3_2 { */ code?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionError". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". */ kind?: string; /** @@ -1846,14 +1571,11 @@ export namespace dfareporting_v3_2 { */ conversions?: Schema$Conversion[]; /** - * Describes how encryptedUserId or encryptedUserIdCandidates[] is - * encrypted. This is a required field if encryptedUserId or - * encryptedUserIdCandidates[] is used. + * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. */ encryptionInfo?: Schema$EncryptionInfo; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertRequest". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". */ kind?: string; } @@ -1866,13 +1588,11 @@ export namespace dfareporting_v3_2 { */ hasFailures?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". */ kind?: string; /** - * The insert status of each conversion. Statuses are returned in the same - * order that conversions are inserted. + * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. */ status?: Schema$ConversionStatus[]; } @@ -1885,13 +1605,11 @@ export namespace dfareporting_v3_2 { */ conversions?: Schema$Conversion[]; /** - * Describes how encryptedUserId is encrypted. This is a required field if - * encryptedUserId is used. + * Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. */ encryptionInfo?: Schema$EncryptionInfo; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateRequest". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". */ kind?: string; } @@ -1904,19 +1622,16 @@ export namespace dfareporting_v3_2 { */ hasFailures?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". */ kind?: string; /** - * The update status of each conversion. Statuses are returned in the same - * order that conversions are updated. + * The update status of each conversion. Statuses are returned in the same order that conversions are updated. */ status?: Schema$ConversionStatus[]; } /** - * The original conversion that was inserted or updated and whether there were - * any errors. + * The original conversion that was inserted or updated and whether there were any errors. */ export interface Schema$ConversionStatus { /** @@ -1928,8 +1643,7 @@ export namespace dfareporting_v3_2 { */ errors?: Schema$ConversionError[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionStatus". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". */ kind?: string; } @@ -1942,8 +1656,7 @@ export namespace dfareporting_v3_2 { */ countries?: Schema$Country[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#countriesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". */ kind?: string; } @@ -1956,13 +1669,11 @@ export namespace dfareporting_v3_2 { */ countryCode?: string; /** - * DART ID of this country. This is the ID used for targeting and generating - * reports. + * DART ID of this country. This is the ID used for targeting and generating reports. */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#country". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". */ kind?: string; /** @@ -1979,9 +1690,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Creative { /** - * Account ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. + * Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. */ accountId?: string; /** @@ -1989,34 +1698,23 @@ export namespace dfareporting_v3_2 { */ active?: boolean; /** - * Additional sizes associated with a responsive creative. When inserting or - * updating a creative either the size ID field or size width and height - * fields can be used. Applicable to DISPLAY creatives when the primary - * asset type is HTML_IMAGE. + * Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. */ additionalSizes?: Schema$Size[]; /** - * Ad parameters user for VPAID creative. This is a read-only field. - * Applicable to the following creative types: all VPAID. + * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. */ adParameters?: string; /** - * Keywords for a Rich Media creative. Keywords let you customize the - * creative settings of a Rich Media ad running on your site without having - * to contact the advertiser. You can use keywords to dynamically change the - * look or functionality of a creative. Applicable to the following creative - * types: all RICH_MEDIA, and all VPAID. + * Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ adTagKeys?: string[]; /** - * Advertiser ID of this creative. This is a required field. Applicable to - * all creative types. + * Advertiser ID of this creative. This is a required field. Applicable to all creative types. */ advertiserId?: string; /** - * Whether script access is allowed for this creative. This is a read-only - * and deprecated field which will automatically be set to true on update. - * Applicable to the following creative types: FLASH_INPAGE. + * Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. */ allowScriptAccess?: boolean; /** @@ -2024,125 +1722,67 @@ export namespace dfareporting_v3_2 { */ archived?: boolean; /** - * Type of artwork used for the creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. + * Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ artworkType?: string; /** - * Source application where creative was authored. Presently, only DBM - * authored creatives will have this field set. Applicable to all creative - * types. + * Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. */ authoringSource?: string; /** - * Authoring tool for HTML5 banner creatives. This is a read-only field. - * Applicable to the following creative types: HTML5_BANNER. + * Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ authoringTool?: string; /** - * Whether images are automatically advanced for image gallery creatives. - * Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. */ autoAdvanceImages?: boolean; /** - * The 6-character HTML color code, beginning with #, for the background of - * the window area where the Flash file is displayed. Default is white. - * Applicable to the following creative types: FLASH_INPAGE. + * The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. */ backgroundColor?: string; /** - * Click-through URL for backup image. Applicable to ENHANCED_BANNER when - * the primary asset type is not HTML_IMAGE. + * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. */ backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * List of feature dependencies that will cause a backup image to be served - * if the browser that serves the ad does not support them. Feature - * dependencies are features that a browser must be able to support in order - * to render your HTML5 creative asset correctly. This field is initially - * auto-generated to contain all features detected by Campaign Manager for - * all the assets of this creative and can then be modified by the client. - * To reset this field, copy over all the creativeAssets' detected - * features. Applicable to the following creative types: HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageFeatures?: string[]; /** - * Reporting label used for HTML5 banner backup image. Applicable to the - * following creative types: DISPLAY when the primary asset type is not - * HTML_IMAGE. + * Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageReportingLabel?: string; /** - * Target window for backup image. Applicable to the following creative - * types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. + * Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageTargetWindow?: Schema$TargetWindow; /** - * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER - * creatives, this is a subset of detected click tags for the assets - * associated with this creative. After creating a flash asset, detected - * click tags will be returned in the creativeAssetMetadata. When inserting - * the creative, populate the creative clickTags field using the - * creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY - * creatives, there should be exactly one entry in this list for each image - * creative asset. A click tag is matched with a corresponding creative - * asset by matching the clickTag.name field with the - * creativeAsset.assetIdentifier.name field. Applicable to the following - * creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ clickTags?: Schema$ClickTag[]; /** - * Industry standard ID assigned to creative for reach and frequency. - * Applicable to INSTREAM_VIDEO_REDIRECT creatives. + * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. */ commercialId?: string; /** - * List of companion creatives assigned to an in-Stream video creative. - * Acceptable values include IDs of existing flash and image creatives. - * Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO - * and all INSTREAM_VIDEO with dynamicAssetSelection set to false. + * List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. */ companionCreatives?: string[]; /** - * Compatibilities associated with this creative. This is a read-only field. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. - * Only pre-existing creatives may have these compatibilities since new - * creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL - * instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads - * developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in - * in-stream audio ads developed with the VAST standard. Applicable to all - * creative types. Acceptable values are: - "APP" - - * "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - - * "IN_STREAM_AUDIO" - "DISPLAY" - - * "DISPLAY_INTERSTITIAL" + * Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" */ compatibility?: string[]; /** - * Whether Flash assets associated with the creative need to be - * automatically converted to HTML5. This flag is enabled by default and - * users can choose to disable it if they don't want the system to - * generate and use HTML5 asset for this creative. Applicable to the - * following creative type: FLASH_INPAGE. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. + * Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ convertFlashToHtml5?: boolean; /** - * List of counter events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. + * List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. */ counterCustomEvents?: Schema$CreativeCustomEvent[]; /** - * Assets associated with a creative. Applicable to all but the following - * creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and - * REDIRECT + * Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT */ creativeAssets?: Schema$CreativeAsset[]; /** @@ -2150,251 +1790,163 @@ export namespace dfareporting_v3_2 { */ creativeAssetSelection?: Schema$CreativeAssetSelection; /** - * Creative field assignments for this creative. Applicable to all creative - * types. + * Creative field assignments for this creative. Applicable to all creative types. */ creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; /** - * Custom key-values for a Rich Media creative. Key-values let you customize - * the creative settings of a Rich Media ad running on your site without - * having to contact the advertiser. You can use key-values to dynamically - * change the look or functionality of a creative. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. + * Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ customKeyValues?: string[]; /** - * Set this to true to enable the use of rules to target individual assets - * in this creative. When set to true creativeAssetSelection must be set. - * This also controls asset-level companions. When this is true, companion - * creatives should be assigned to creative assets. Learn more. Applicable - * to INSTREAM_VIDEO creatives. + * Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. */ dynamicAssetSelection?: boolean; /** - * List of exit events configured for the creative. For DISPLAY and - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags, For DISPLAY, an event is also created from the - * backupImageReportingLabel. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. + * List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ exitCustomEvents?: Schema$CreativeCustomEvent[]; /** - * OpenWindow FSCommand of this creative. This lets the SWF file communicate - * with either Flash Player or the program hosting Flash Player, such as a - * web browser. This is only triggered if allowScriptAccess field is true. - * Applicable to the following creative types: FLASH_INPAGE. + * OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE. */ fsCommand?: Schema$FsCommand; /** - * HTML code for the creative. This is a required field when applicable. - * This field is ignored if htmlCodeLocked is true. Applicable to the - * following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and - * all RICH_MEDIA. + * HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. */ htmlCode?: string; /** - * Whether HTML code is generated by Campaign Manager or manually entered. - * Set to true to ignore changes to htmlCode. Applicable to the following - * creative types: FLASH_INPAGE and HTML5_BANNER. + * Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. */ htmlCodeLocked?: boolean; /** - * ID of this creative. This is a read-only, auto-generated field. - * Applicable to all creative types. + * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. */ id?: string; /** - * Dimension value for the ID of this creative. This is a read-only field. - * Applicable to all creative types. + * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creative". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". */ kind?: string; /** - * Creative last modification information. This is a read-only field. - * Applicable to all creative types. + * Creative last modification information. This is a read-only field. Applicable to all creative types. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Latest Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. + * Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ latestTraffickedCreativeId?: string; /** - * Description of the audio or video ad. Applicable to the following - * creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. + * Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. */ mediaDescription?: string; /** - * Creative audio or video duration in seconds. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO, - * INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. + * Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. */ mediaDuration?: number; /** - * Name of the creative. This is a required field and must be less than 256 - * characters long. Applicable to all creative types. + * Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. */ name?: string; /** - * Override CSS value for rich media creatives. Applicable to the following - * creative types: all RICH_MEDIA. + * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. */ overrideCss?: string; /** - * The asset ID of the polite load image asset. Applicable to the creative - * type: DISPLAY. + * The asset ID of the polite load image asset. Applicable to the creative type: DISPLAY. */ politeLoadAssetId?: string; /** - * Amount of time to play the video before counting a view. Applicable to - * the following creative types: all INSTREAM_VIDEO. + * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. */ progressOffset?: Schema$VideoOffset; /** - * URL of hosted image or hosted video or another ad tag. For - * INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect - * URL. The standard for a VAST (Video Ad Serving Template) ad response - * allows for a redirect link to another VAST 2.0 or 3.0 call. This is a - * required field when applicable. Applicable to the following creative - * types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, - * INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + * URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT */ redirectUrl?: string; /** - * ID of current rendering version. This is a read-only field. Applicable to - * all creative types. + * ID of current rendering version. This is a read-only field. Applicable to all creative types. */ renderingId?: string; /** - * Dimension value for the rendering ID of this creative. This is a - * read-only field. Applicable to all creative types. + * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. */ renderingIdDimensionValue?: Schema$DimensionValue; /** - * The minimum required Flash plugin version for this creative. For - * example, 11.2.202.235. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. + * The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ requiredFlashPluginVersion?: string; /** - * The internal Flash version for this creative as calculated by Studio. - * This is a read-only field. Applicable to the following creative types: - * FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when - * the primary asset type is not HTML_IMAGE. + * The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ requiredFlashVersion?: number; /** - * Size associated with this creative. When inserting or updating a creative - * either the size ID field or size width and height fields can be used. - * This is a required field when applicable; however for IMAGE, FLASH_INPAGE - * creatives, and for DISPLAY creatives with a primary asset of type - * HTML_IMAGE, if left blank, this field will be automatically set using the - * actual size of the associated image assets. Applicable to the following - * creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, - * HTML5_BANNER, IMAGE, and all RICH_MEDIA. + * Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. */ size?: Schema$Size; /** - * Amount of time to play the video before the skip button appears. - * Applicable to the following creative types: all INSTREAM_VIDEO. + * Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO. */ skipOffset?: Schema$VideoOffset; /** - * Whether the user can choose to skip the creative. Applicable to the - * following creative types: all INSTREAM_VIDEO and all VPAID. + * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. */ skippable?: boolean; /** - * Whether the creative is SSL-compliant. This is a read-only field. - * Applicable to all creative types. + * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. */ sslCompliant?: boolean; /** - * Whether creative should be treated as SSL compliant even if the system - * scan shows it's not. Applicable to all creative types. + * Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. */ sslOverride?: boolean; /** - * Studio advertiser ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. + * Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioAdvertiserId?: string; /** - * Studio creative ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. + * Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioCreativeId?: string; /** - * Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. + * Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioTraffickedCreativeId?: string; /** - * Subaccount ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. + * Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. */ subaccountId?: string; /** - * Third-party URL used to record backup image impressions. Applicable to - * the following creative types: all RICH_MEDIA. + * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. */ thirdPartyBackupImageImpressionsUrl?: string; /** - * Third-party URL used to record rich media impressions. Applicable to the - * following creative types: all RICH_MEDIA. + * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. */ thirdPartyRichMediaImpressionsUrl?: string; /** - * Third-party URLs for tracking in-stream creative events. Applicable to - * the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and - * all VPAID. + * Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. */ thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; /** - * List of timer events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset is not HTML_IMAGE. + * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. */ timerCustomEvents?: Schema$CreativeCustomEvent[]; /** - * Combined size of all creative assets. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. + * Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ totalFileSize?: string; /** - * Type of this creative. This is a required field. Applicable to all - * creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only - * used for existing creatives. New creatives should use DISPLAY as a - * replacement for these types. + * Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. */ type?: string; /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. */ universalAdId?: Schema$UniversalAdId; /** - * The version number helps you keep track of multiple versions of your - * creative in your reports. The version number will always be - * auto-generated during insert operations to start at 1. For tracking - * creatives the version cannot be incremented and will always remain at 1. - * For all other creative types the version can be incremented only by 1 - * during update operations. In addition, the version will be automatically - * incremented by 1 when undergoing Rich Media creative merging. Applicable - * to all creative types. + * The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. */ version?: number; } @@ -2403,161 +1955,111 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeAsset { /** - * Whether ActionScript3 is enabled for the flash asset. This is a read-only - * field. Applicable to the following creative type: FLASH_INPAGE. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ actionScript3?: boolean; /** - * Whether the video or audio asset is active. This is a read-only field for - * VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative - * types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + * Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ active?: boolean; /** - * Additional sizes associated with this creative asset. HTML5 asset - * generated by compatible software such as GWD will be able to support more - * sizes this creative asset can render. + * Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. */ additionalSizes?: Schema$Size[]; /** - * Possible alignments for an asset. This is a read-only field. Applicable - * to the following creative types: - * RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. + * Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. */ alignment?: string; /** - * Artwork type of rich media creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ artworkType?: string; /** - * Identifier of this asset. This is the same identifier returned during - * creative asset insert operation. This is a required field. Applicable to - * all but the following creative types: all REDIRECT and TRACKING_TEXT. + * Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ assetIdentifier?: Schema$CreativeAssetId; /** - * Exit event configured for the backup image. Applicable to the following - * creative types: all RICH_MEDIA. + * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. */ backupImageExit?: Schema$CreativeCustomEvent; /** - * Detected bit-rate for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ bitRate?: number; /** - * Rich media child asset type. This is a read-only field. Applicable to the - * following creative types: all VPAID. + * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. */ childAssetType?: string; /** - * Size of an asset when collapsed. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID. Additionally, - * applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or - * ASSET_DISPLAY_TYPE_PEEL_DOWN. + * Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. */ collapsedSize?: Schema$Size; /** - * List of companion creatives assigned to an in-stream video creative - * asset. Acceptable values include IDs of existing flash and image - * creatives. Applicable to INSTREAM_VIDEO creative type with - * dynamicAssetSelection set to true. + * List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. */ companionCreativeIds?: string[]; /** - * Custom start time in seconds for making the asset visible. Applicable to - * the following creative types: all RICH_MEDIA. Value must be greater than - * or equal to 0. + * Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. */ customStartTimeValue?: number; /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. Applicable to the following - * creative types: HTML5_BANNER. Applicable to DISPLAY when the primary - * asset type is not HTML_IMAGE. + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ detectedFeatures?: string[]; /** - * Type of rich media asset. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA. + * Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ displayType?: string; /** - * Duration in seconds for which an asset will be displayed. Applicable to - * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and - * VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. + * Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. */ duration?: number; /** - * Duration type for which an asset will be displayed. Applicable to the - * following creative types: all RICH_MEDIA. + * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. */ durationType?: string; /** - * Detected expanded dimension for video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + * Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ expandedDimension?: Schema$Size; /** - * File size associated with this creative asset. This is a read-only field. - * Applicable to all but the following creative types: all REDIRECT and - * TRACKING_TEXT. + * File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ fileSize?: string; /** - * Flash version of the asset. This is a read-only field. Applicable to the - * following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ flashVersion?: number; /** - * Whether to hide Flash objects flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. + * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ hideFlashObjects?: boolean; /** - * Whether to hide selection boxes flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. + * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ hideSelectionBoxes?: boolean; /** - * Whether the asset is horizontally locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ horizontallyLocked?: boolean; /** - * Numeric ID of this creative asset. This is a required field and should - * not be modified. Applicable to all but the following creative types: all - * REDIRECT and TRACKING_TEXT. + * Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ id?: string; /** - * Dimension value for the ID of the asset. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the asset. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Detected duration for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ mediaDuration?: number; /** - * Detected MIME type for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ mimeType?: string; /** - * Offset position for an asset in collapsed mode. This is a read-only - * field. Applicable to the following creative types: all RICH_MEDIA and all - * VPAID. Additionally, only applicable to assets whose displayType is - * ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + * Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. */ offset?: Schema$OffsetPosition; /** @@ -2565,133 +2067,75 @@ export namespace dfareporting_v3_2 { */ orientation?: string; /** - * Whether the backup asset is original or changed by the user in Campaign - * Manager. Applicable to the following creative types: all RICH_MEDIA. + * Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. */ originalBackup?: boolean; /** - * Offset position for an asset. Applicable to the following creative types: - * all RICH_MEDIA. + * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. */ position?: Schema$OffsetPosition; /** - * Offset left unit for an asset. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA. + * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ positionLeftUnit?: string; /** - * Offset top unit for an asset. This is a read-only field if the asset - * displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following - * creative types: all RICH_MEDIA. + * Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. */ positionTopUnit?: string; /** - * Progressive URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. + * Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ progressiveServingUrl?: string; /** - * Whether the asset pushes down other content. Applicable to the following - * creative types: all RICH_MEDIA. Additionally, only applicable when the - * asset offsets are 0, the collapsedSize.width matches size.width, and the - * collapsedSize.height is less than size.height. + * Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. */ pushdown?: boolean; /** - * Pushdown duration in seconds for an asset. Applicable to the following - * creative types: all RICH_MEDIA.Additionally, only applicable when the - * asset pushdown field is true, the offsets are 0, the collapsedSize.width - * matches size.width, and the collapsedSize.height is less than - * size.height. Acceptable values are 0 to 9.99, inclusive. + * Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. */ pushdownDuration?: number; /** - * Role of the asset in relation to creative. Applicable to all but the - * following creative types: all REDIRECT and TRACKING_TEXT. This is a - * required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, - * IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple - * primary assets), and all VPAID creatives. BACKUP_IMAGE applies to - * FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - * ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. - * OTHER refers to assets from sources other than Campaign Manager, such as - * Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID - * creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign - * Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO - * creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign - * Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and - * VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign - * Manager representation of child asset videos from Studio, and is - * applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or - * removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, - * PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked - * active serve as backup in case the VPAID creative cannot be served. Only - * PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or - * VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by - * the user in Campaign Manager and is applicable to INSTREAM_AUDIO - * creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign - * Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO - * creatives. + * Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. */ role?: string; /** - * Size associated with this creative asset. This is a required field when - * applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, - * this field will be automatically set using the actual size of the - * associated image asset. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all - * RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not - * HTML_IMAGE. + * Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ size?: Schema$Size; /** - * Whether the asset is SSL-compliant. This is a read-only field. Applicable - * to all but the following creative types: all REDIRECT and TRACKING_TEXT. + * Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ sslCompliant?: boolean; /** - * Initial wait time type before making the asset visible. Applicable to the - * following creative types: all RICH_MEDIA. + * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. */ startTimeType?: string; /** - * Streaming URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. + * Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ streamingServingUrl?: string; /** - * Whether the asset is transparent. Applicable to the following creative - * types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + * Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. */ transparency?: boolean; /** - * Whether the asset is vertically locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ verticallyLocked?: boolean; /** - * Window mode options for flash assets. Applicable to the following - * creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, - * RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and - * RICH_MEDIA_INPAGE_FLOATING. + * Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. */ windowMode?: string; /** - * zIndex value of an asset. Applicable to the following creative types: all - * RICH_MEDIA.Additionally, only applicable to assets whose displayType is - * NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or - * ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to - * 999999999, inclusive. + * zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. */ zIndex?: number; /** - * File name of zip file. This is a read-only field. Applicable to the - * following creative types: HTML5_BANNER. + * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ zipFilename?: string; /** - * Size of zip file. This is a read-only field. Applicable to the following - * creative types: HTML5_BANNER. + * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ zipFilesize?: string; } @@ -2700,22 +2144,16 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeAssetId { /** - * Name of the creative asset. This is a required field while inserting an - * asset. After insertion, this assetIdentifier is used to identify the - * uploaded asset. Characters in the name must be alphanumeric or one of the - * following: ".-_ ". Spaces are allowed. + * Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. */ name?: string; /** - * Type of asset to upload. This is a required field. FLASH and IMAGE are no - * longer supported for new uploads. All image assets should use HTML_IMAGE. + * Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. */ type?: string; } /** - * CreativeAssets contains properties of a creative asset file which will be - * uploaded or has already been uploaded. Refer to the creative sample code - * for how to upload assets and insert a creative. + * CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative. */ export interface Schema$CreativeAssetMetadata { /** @@ -2723,15 +2161,11 @@ export namespace dfareporting_v3_2 { */ assetIdentifier?: Schema$CreativeAssetId; /** - * List of detected click tags for assets. This is a read-only - * auto-generated field. + * List of detected click tags for assets. This is a read-only auto-generated field. */ clickTags?: Schema$ClickTag[]; /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. */ detectedFeatures?: string[]; /** @@ -2739,50 +2173,28 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the numeric ID of the asset. This is a read-only, - * auto-generated field. + * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeAssetMetadata". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". */ kind?: string; /** - * Rules validated during code generation that generated a warning. This is - * a read-only, auto-generated field. Possible values are: - - * "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - - * "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - - * "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - - * "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - - * "CLICK_TAG_NON_TOP_LEVEL" - - * "COMPONENT_UNSUPPORTED_DCM" - - * "ENABLER_UNSUPPORTED_METHOD_DCM" - - * "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - - * "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - - * "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - * - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - - * "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - - * "PRIMARY_HTML_MISSING" - "SVG_INVALID" - - * "ZIP_INVALID" + * Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID" */ warnedValidationRules?: string[]; } /** - * Encapsulates the list of rules for asset selection and a default asset in - * case none of the rules match. Applicable to INSTREAM_VIDEO creatives. + * Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$CreativeAssetSelection { /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative, and will be served if none of the rules match. This is a - * required field. + * A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field. */ defaultAssetId?: string; /** - * Rules determine which asset will be served to a viewer. Rules will be - * evaluated in the order in which they are stored in this list. This list - * must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. + * Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. */ rules?: Schema$Rule[]; } @@ -2791,15 +2203,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeAssignment { /** - * Whether this creative assignment is active. When true, the creative will - * be included in the ad's rotation. + * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. */ active?: boolean; /** - * Whether applicable event tags should fire when this creative assignment - * is rendered. If this value is unset when the ad is inserted or updated, - * it will default to true for all creative types EXCEPT for - * INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + * Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. */ applyEventTags?: boolean; /** @@ -2807,14 +2215,11 @@ export namespace dfareporting_v3_2 { */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Companion creative overrides for this creative assignment. Applicable to - * video ads. + * Companion creative overrides for this creative assignment. Applicable to video ads. */ companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; /** - * Creative group assignments for this creative assignment. Only one - * assignment per creative group number is allowed for a maximum of two - * assignments. + * Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. */ creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; /** @@ -2822,33 +2227,23 @@ export namespace dfareporting_v3_2 { */ creativeId?: string; /** - * Dimension value for the ID of the creative. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the creative. This is a read-only, auto-generated field. */ creativeIdDimensionValue?: Schema$DimensionValue; /** - * Date and time that the assigned creative should stop serving. Must be - * later than the start time. + * Date and time that the assigned creative should stop serving. Must be later than the start time. */ endTime?: string; /** - * Rich media exit overrides for this creative assignment. Applicable when - * the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - * - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - - * RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - - * RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - - * RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR + * Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR */ richMediaExitOverrides?: Schema$RichMediaExitOverride[]; /** - * Sequence number of the creative assignment, applicable when the rotation - * type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to - * 65535, inclusive. + * Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. */ sequence?: number; /** - * Whether the creative to be assigned is SSL-compliant. This is a read-only - * field that is auto-generated when the ad is inserted or updated. + * Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslCompliant?: boolean; /** @@ -2856,8 +2251,7 @@ export namespace dfareporting_v3_2 { */ startTime?: string; /** - * Weight of the creative assignment, applicable when the rotation type is - * CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. + * Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. */ weight?: number; } @@ -2866,16 +2260,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeClickThroughUrl { /** - * Read-only convenience field representing the actual URL that will be used - * for this click-through. The URL is computed as follows: - If - * landingPageId is specified then that landing page's URL is assigned - * to this field. - Otherwise, the customClickThroughUrl is assigned to this - * field. + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. */ computedClickThroughUrl?: string; /** - * Custom click-through URL. Applicable if the landingPageId field is left - * unset. + * Custom click-through URL. Applicable if the landingPageId field is left unset. */ customClickThroughUrl?: string; /** @@ -2888,8 +2277,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeCustomEvent { /** - * Unique ID of this event used by Reporting and Data Transfer. This is a - * read-only field. + * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. */ advertiserCustomEventId?: string; /** @@ -2901,9 +2289,7 @@ export namespace dfareporting_v3_2 { */ advertiserCustomEventType?: string; /** - * Artwork label column, used to link events in Campaign Manager back to - * events in Studio. This is a required field and should not be modified - * after insertion. + * Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. */ artworkLabel?: string; /** @@ -2911,18 +2297,15 @@ export namespace dfareporting_v3_2 { */ artworkType?: string; /** - * Exit click-through URL for the event. This field is used only for exit - * events. + * Exit click-through URL for the event. This field is used only for exit events. */ exitClickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * ID of this event. This is a required field and should not be modified - * after insertion. + * ID of this event. This is a required field and should not be modified after insertion. */ id?: string; /** - * Properties for rich media popup windows. This field is used only for exit - * events. + * Properties for rich media popup windows. This field is used only for exit events. */ popupWindowProperties?: Schema$PopupWindowProperties; /** @@ -2930,8 +2313,7 @@ export namespace dfareporting_v3_2 { */ targetType?: string; /** - * Video reporting ID, used to differentiate multiple videos in a single - * creative. This is a read-only field. + * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. */ videoReportingId?: string; } @@ -2940,18 +2322,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeField { /** - * Account ID of this creative field. This is a read-only field that can be - * left blank. + * Account ID of this creative field. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this creative field. This is a required field on - * insertion. + * Advertiser ID of this creative field. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -2959,19 +2338,15 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeField". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". */ kind?: string; /** - * Name of this creative field. This is a required field and must be less - * than 256 characters long and unique among creative fields of the same - * advertiser. + * Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. */ name?: string; /** - * Subaccount ID of this creative field. This is a read-only field that can - * be left blank. + * Subaccount ID of this creative field. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -2997,8 +2372,7 @@ export namespace dfareporting_v3_2 { */ creativeFields?: Schema$CreativeField[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". */ kind?: string; /** @@ -3011,18 +2385,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeFieldValue { /** - * ID of this creative field value. This is a read-only, auto-generated - * field. + * ID of this creative field value. This is a read-only, auto-generated field. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValue". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". */ kind?: string; /** - * Value of this creative field value. It needs to be less than 256 - * characters in length and unique per creative field. + * Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. */ value?: string; } @@ -3035,8 +2406,7 @@ export namespace dfareporting_v3_2 { */ creativeFieldValues?: Schema$CreativeFieldValue[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValuesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". */ kind?: string; /** @@ -3049,25 +2419,19 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeGroup { /** - * Account ID of this creative group. This is a read-only field that can be - * left blank. + * Account ID of this creative group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this creative group. This is a required field on - * insertion. + * Advertiser ID of this creative group. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Subgroup of the creative group. Assign your creative groups to a subgroup - * in order to filter or manage them more easily. This field is required on - * insertion and is read-only after insertion. Acceptable values are 1 to 2, - * inclusive. + * Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. */ groupNumber?: number; /** @@ -3075,19 +2439,15 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". */ kind?: string; /** - * Name of this creative group. This is a required field and must be less - * than 256 characters long and unique among creative groups of the same - * advertiser. + * Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. */ name?: string; /** - * Subaccount ID of this creative group. This is a read-only field that can - * be left blank. + * Subaccount ID of this creative group. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -3113,8 +2473,7 @@ export namespace dfareporting_v3_2 { */ creativeGroups?: Schema$CreativeGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". */ kind?: string; /** @@ -3127,14 +2486,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeOptimizationConfiguration { /** - * ID of this creative optimization config. This field is auto-generated - * when the campaign is inserted or updated. It can be null for existing - * campaigns. + * ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. */ id?: string; /** - * Name of this creative optimization config. This is a required field and - * must be less than 129 characters long. + * Name of this creative optimization config. This is a required field and must be less than 129 characters long. */ name?: string; /** @@ -3155,20 +2511,15 @@ export namespace dfareporting_v3_2 { */ creativeAssignments?: Schema$CreativeAssignment[]; /** - * Creative optimization configuration that is used by this ad. It should - * refer to one of the existing optimization configurations in the ad's - * campaign. If it is unset or set to 0, then the campaign's default - * optimization configuration will be used for this ad. + * Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad. */ creativeOptimizationConfigurationId?: string; /** - * Type of creative rotation. Can be used to specify whether to use - * sequential or random rotation. + * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. */ type?: string; /** - * Strategy for calculating weights. Used with - * CREATIVE_ROTATION_TYPE_RANDOM. + * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */ weightCalculationStrategy?: string; } @@ -3177,13 +2528,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CreativeSettings { /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. + * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. */ iFrameFooter?: string; /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. + * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. */ iFrameHeader?: string; } @@ -3196,8 +2545,7 @@ export namespace dfareporting_v3_2 { */ creatives?: Schema$Creative[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". */ kind?: string; /** @@ -3206,33 +2554,27 @@ export namespace dfareporting_v3_2 { nextPageToken?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". + * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ export interface Schema$CrossDimensionReachReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "breakdown" section of the report. + * Dimensions which are compatible to be selected in the "breakdown" section of the report. */ breakdown?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#crossDimensionReachReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected in the - * "overlapMetricNames" section of the report. + * Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. */ overlapMetrics?: Schema$Metric[]; } @@ -3241,18 +2583,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CustomFloodlightVariable { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#customFloodlightVariable". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". */ kind?: string; /** - * The type of custom floodlight variable to supply a value for. These map - * to the "u[1-20]=" in the tags. + * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. */ type?: string; /** - * The value of the custom floodlight variable. The length of string must - * not exceed 50 characters. + * The value of the custom floodlight variable. The length of string must not exceed 50 characters. */ value?: string; } @@ -3261,13 +2600,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$CustomRichMediaEvents { /** - * List of custom rich media event IDs. Dimension values must be all of type - * dfa:richMediaEventTypeIdAndName. + * List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. */ filteredEventIds?: Schema$DimensionValue[]; /** - * The kind of resource this is, in this case - * dfareporting#customRichMediaEvents. + * The kind of resource this is, in this case dfareporting#customRichMediaEvents. */ kind?: string; } @@ -3276,8 +2613,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$DateRange { /** - * The end date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". + * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ endDate?: string; /** @@ -3289,8 +2625,7 @@ export namespace dfareporting_v3_2 { */ relativeDateRange?: string; /** - * The start date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". + * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ startDate?: string; } @@ -3299,25 +2634,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$DayPartTargeting { /** - * Days of the week when the ad will serve. Acceptable values are: - - * "SUNDAY" - "MONDAY" - "TUESDAY" - - * "WEDNESDAY" - "THURSDAY" - "FRIDAY" - - * "SATURDAY" + * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" */ daysOfWeek?: string[]; /** - * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and - * 23 is 11 PM to midnight. Can be specified with days of week, in which - * case the ad would serve during these hours on the specified days. For - * example if Monday, Wednesday, Friday are the days of week specified and - * 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve - * Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values - * are 0 to 23, inclusive. + * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. */ hoursOfDay?: number[]; /** - * Whether or not to use the user's local time. If false, the - * America/New York time zone applies. + * Whether or not to use the user's local time. If false, the America/New York time zone applies. */ userLocalTime?: boolean; } @@ -3330,13 +2655,11 @@ export namespace dfareporting_v3_2 { */ appUrl?: string; /** - * The fallback URL. This URL will be served to users who do not have the - * mobile app installed. + * The fallback URL. This URL will be served to users who do not have the mobile app installed. */ fallbackUrl?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#deepLink". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". */ kind?: string; /** @@ -3344,25 +2667,20 @@ export namespace dfareporting_v3_2 { */ mobileApp?: Schema$MobileApp; /** - * Ads served to users on these remarketing lists will use this deep link. - * Applicable when mobileApp.directory is APPLE_APP_STORE. + * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. */ remarketingListIds?: string[]; } /** - * Properties of inheriting and overriding the default click-through event - * tag. A campaign may override the event tag defined at the advertiser level, - * and an ad may also override the campaign's setting further. + * Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. */ export interface Schema$DefaultClickThroughEventTagProperties { /** - * ID of the click-through event tag to apply to all ads in this - * entity's scope. + * ID of the click-through event tag to apply to all ads in this entity's scope. */ defaultClickThroughEventTagId?: string; /** - * Whether this entity should override the inherited default click-through - * event tag with its own defined value. + * Whether this entity should override the inherited default click-through event tag with its own defined value. */ overrideInheritedEventTag?: boolean; } @@ -3371,27 +2689,19 @@ export namespace dfareporting_v3_2 { */ export interface Schema$DeliverySchedule { /** - * Limit on the number of times an individual user can be served the ad - * within a specified period of time. + * Limit on the number of times an individual user can be served the ad within a specified period of time. */ frequencyCap?: Schema$FrequencyCap; /** - * Whether or not hard cutoff is enabled. If true, the ad will not serve - * after the end date and time. Otherwise the ad will continue to be served - * until it has reached its delivery goals. + * Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals. */ hardCutoff?: boolean; /** - * Impression ratio for this ad. This ratio determines how often each ad is - * served relative to the others. For example, if ad A has an impression - * ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager - * will serve ad B three times as often as ad A. Acceptable values are 1 to - * 10, inclusive. + * Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive. */ impressionRatio?: string; /** - * Serving priority of an ad, with respect to other ads. The lower the - * priority number, the greater the priority with which it is served. + * Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served. */ priority?: string; } @@ -3471,12 +2781,7 @@ export namespace dfareporting_v3_2 { */ kind?: string; /** - * Determines how the 'value' field is matched when filtering. If - * not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, - * '*' is allowed as a placeholder for variable length character - * sequences, and it can be escaped with a backslash. Note, only paid search - * dimensions ('dfa:paidSearch*') allow a matchType other than - * EXACT. + * Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. */ matchType?: string; /** @@ -3501,10 +2806,7 @@ export namespace dfareporting_v3_2 { */ kind?: string; /** - * Continuation token used to page through dimension values. To retrieve the - * next page of results, set the next request's "pageToken" to - * the value of this field. The page token is only valid for a limited - * amount of time and should not be persisted. + * Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -3517,8 +2819,7 @@ export namespace dfareporting_v3_2 { */ dimensionName?: string; /** - * The end date of the date range for which to retrieve dimension values. A - * string of the format "yyyy-MM-dd". + * The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". */ endDate?: string; /** @@ -3526,20 +2827,16 @@ export namespace dfareporting_v3_2 { */ filters?: Schema$DimensionFilter[]; /** - * The kind of request this is, in this case - * dfareporting#dimensionValueRequest. + * The kind of request this is, in this case dfareporting#dimensionValueRequest. */ kind?: string; /** - * The start date of the date range for which to retrieve dimension values. - * A string of the format "yyyy-MM-dd". + * The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". */ startDate?: string; } /** - * DirectorySites contains properties of a website from the Site Directory. - * Sites need to be added to an account via the Sites resource before they can - * be assigned to a placement. + * DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement. */ export interface Schema$DirectorySite { /** @@ -3555,26 +2852,7 @@ export namespace dfareporting_v3_2 { */ countryId?: string; /** - * Currency ID of this directory site. This is a read-only field. Possible - * values are: - "1" for USD - "2" for GBP - - * "3" for ESP - "4" for SEK - "5" for CAD - * - "6" for JPY - "7" for DEM - "8" for AUD - * - "9" for FRF - "10" for ITL - "11" for - * DKK - "12" for NOK - "13" for FIM - "14" - * for ZAR - "15" for IEP - "16" for NLG - - * "17" for EUR - "18" for KRW - "19" for - * TWD - "20" for SGD - "21" for CNY - "22" - * for HKD - "23" for NZD - "24" for MYR - - * "25" for BRL - "26" for PTE - "27" for - * MXP - "28" for CLP - "29" for TRY - "30" - * for ARS - "31" for PEN - "32" for ILS - - * "33" for CHF - "34" for VEF - "35" for - * COP - "36" for GTQ - "37" for PLN - "39" - * for INR - "40" for THB - "41" for IDR - - * "42" for CZK - "43" for RON - "44" for - * HUF - "45" for RUB - "46" for AED - "47" - * for BGN - "48" for HRK - "49" for MXN - - * "50" for NGN + * Currency ID of this directory site. This is a read-only field. Possible values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ currencyId?: string; /** @@ -3586,26 +2864,19 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the ID of this directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Tag types for regular placements. Acceptable values are: - - * "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - - * "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" + * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" */ inpageTagFormats?: string[]; /** - * Tag types for interstitial placements. Acceptable values are: - - * "IFRAME_JAVASCRIPT_INTERSTITIAL" - - * "INTERNAL_REDIRECT_INTERSTITIAL" - - * "JAVASCRIPT_INTERSTITIAL" + * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" */ interstitialTagFormats?: string[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySite". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". */ kind?: string; /** @@ -3642,13 +2913,11 @@ export namespace dfareporting_v3_2 { */ firstName?: string; /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. + * ID of this directory site contact. This is a read-only, auto-generated field. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContact". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact". */ kind?: string; /** @@ -3677,14 +2946,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$DirectorySiteContactAssignment { /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. + * ID of this directory site contact. This is a read-only, auto-generated field. */ contactId?: string; /** - * Visibility of this directory site contact assignment. When set to PUBLIC - * this contact assignment is visible to all account and agency users; when - * set to PRIVATE it is visible only to the site. + * Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site. */ visibility?: string; } @@ -3697,8 +2963,7 @@ export namespace dfareporting_v3_2 { */ directorySiteContacts?: Schema$DirectorySiteContact[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContactsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse". */ kind?: string; /** @@ -3731,13 +2996,11 @@ export namespace dfareporting_v3_2 { */ nielsenOcrOptOut?: boolean; /** - * Whether this directory site has disabled generation of Verification ins - * tags. + * Whether this directory site has disabled generation of Verification ins tags. */ verificationTagOptOut?: boolean; /** - * Whether this directory site has disabled active view for in-stream video - * creatives. This is a read-only field. + * Whether this directory site has disabled active view for in-stream video creatives. This is a read-only field. */ videoActiveViewOptOut?: boolean; } @@ -3750,8 +3013,7 @@ export namespace dfareporting_v3_2 { */ directorySites?: Schema$DirectorySite[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySitesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". */ kind?: string; /** @@ -3760,23 +3022,15 @@ export namespace dfareporting_v3_2 { nextPageToken?: string; } /** - * Contains properties of a dynamic targeting key. Dynamic targeting keys are - * unique, user-friendly labels, created at the advertiser level in DCM, that - * can be assigned to ads, creatives, and placements and used for targeting - * with Studio dynamic creatives. Use these labels instead of numeric Campaign - * Manager IDs (such as placement IDs) to save time and avoid errors in your - * dynamic feeds. + * Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds. */ export interface Schema$DynamicTargetingKey { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKey". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". */ kind?: string; /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. */ name?: string; /** @@ -3784,8 +3038,7 @@ export namespace dfareporting_v3_2 { */ objectId?: string; /** - * Type of the object of this dynamic targeting key. This is a required - * field. + * Type of the object of this dynamic targeting key. This is a required field. */ objectType?: string; } @@ -3798,8 +3051,7 @@ export namespace dfareporting_v3_2 { */ dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKeysListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". */ kind?: string; } @@ -3808,23 +3060,19 @@ export namespace dfareporting_v3_2 { */ export interface Schema$EncryptionInfo { /** - * The encryption entity ID. This should match the encryption configuration - * for ad serving or Data Transfer. + * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. */ encryptionEntityId?: string; /** - * The encryption entity type. This should match the encryption - * configuration for ad serving or Data Transfer. + * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. */ encryptionEntityType?: string; /** - * Describes whether the encrypted cookie was received from ad serving (the - * %m macro) or from Data Transfer. + * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. */ encryptionSource?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#encryptionInfo". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */ kind?: string; } @@ -3833,40 +3081,31 @@ export namespace dfareporting_v3_2 { */ export interface Schema$EventTag { /** - * Account ID of this event tag. This is a read-only field that can be left - * blank. + * Account ID of this event tag. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this event tag. This field or the campaignId field is - * required on insertion. + * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Campaign ID of this event tag. This field or the advertiserId field is - * required on insertion. + * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * Whether this event tag should be automatically enabled for all of the - * advertiser's campaigns and ads. + * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. */ enabledByDefault?: boolean; /** - * Whether to remove this event tag from ads that are trafficked through - * Display & Video 360 to Ad Exchange. This may be useful if the event - * tag uses a pixel that is unapproved for Ad Exchange bids on one or more - * networks, such as the Google Display Network. + * Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. */ excludeFromAdxRequests?: boolean; /** @@ -3874,24 +3113,19 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTag". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". */ kind?: string; /** - * Name of this event tag. This is a required field and must be less than - * 256 characters long. + * Name of this event tag. This is a required field and must be less than 256 characters long. */ name?: string; /** - * Site filter type for this event tag. If no type is specified then the - * event tag will be applied to all sites. + * Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. */ siteFilterType?: string; /** - * Filter list of site IDs associated with this event tag. The - * siteFilterType determines whether this is a whitelist or blacklist - * filter. + * Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter. */ siteIds?: string[]; /** @@ -3899,31 +3133,23 @@ export namespace dfareporting_v3_2 { */ sslCompliant?: boolean; /** - * Status of this event tag. Must be ENABLED for this event tag to fire. - * This is a required field. + * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. */ status?: string; /** - * Subaccount ID of this event tag. This is a read-only field that can be - * left blank. + * Subaccount ID of this event tag. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Event tag type. Can be used to specify whether to use a third-party - * pixel, a third-party JavaScript URL, or a third-party click-through URL - * for either impression or click tracking. This is a required field. + * Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. */ type?: string; /** - * Payload URL for this event tag. The URL on a click-through event tag - * should have a landing page URL appended to the end of it. This field is - * required on insertion. + * Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. */ url?: string; /** - * Number of times the landing page URL should be URL-escaped before being - * appended to the click-through event tag URL. Only applies to - * click-through event tags as specified by the event tag type. + * Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. */ urlEscapeLevels?: number; } @@ -3949,20 +3175,16 @@ export namespace dfareporting_v3_2 { */ eventTags?: Schema$EventTag[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTagsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". */ kind?: string; } /** - * Represents a File resource. A file contains the metadata for a report run. - * It shows the status of the run and holds the URLs to the generated report - * data if the run is finished and the status is "REPORT_AVAILABLE". + * Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE". */ export interface Schema$File { /** - * The date range for which the file has report data. The date range will - * always be the absolute date range for which the report is run. + * The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. */ dateRange?: Schema$DateRange; /** @@ -3974,8 +3196,7 @@ export namespace dfareporting_v3_2 { */ fileName?: string; /** - * The output format of the report. Only available once the file is - * available. + * The output format of the report. Only available once the file is available. */ format?: string; /** @@ -3987,8 +3208,7 @@ export namespace dfareporting_v3_2 { */ kind?: string; /** - * The timestamp in milliseconds since epoch when this file was last - * modified. + * The timestamp in milliseconds since epoch when this file was last modified. */ lastModifiedTime?: string; /** @@ -4021,10 +3241,7 @@ export namespace dfareporting_v3_2 { */ kind?: string; /** - * Continuation token used to page through files. To retrieve the next page - * of results, set the next request's "pageToken" to the value - * of this field. The page token is only valid for a limited amount of time - * and should not be persisted. + * Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -4054,19 +3271,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$FloodlightActivitiesGenerateTagResponse { /** - * Generated tag for this Floodlight activity. For global site tags, this is - * the event snippet. + * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. */ floodlightActivityTag?: string; /** - * The global snippet section of a global site tag. The global site tag sets - * new cookies on your domain, which will store a unique identifier for a - * user or the ad click that brought the user to your site. Learn more. + * The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. */ globalSiteTagGlobalSnippet?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesGenerateTagResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". */ kind?: string; } @@ -4079,8 +3292,7 @@ export namespace dfareporting_v3_2 { */ floodlightActivities?: Schema$FloodlightActivity[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". */ kind?: string; /** @@ -4093,30 +3305,23 @@ export namespace dfareporting_v3_2 { */ export interface Schema$FloodlightActivity { /** - * Account ID of this floodlight activity. This is a read-only field that - * can be left blank. + * Account ID of this floodlight activity. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this floodlight activity. If this field is left blank, - * the value will be copied over either from the activity group's - * advertiser or the existing activity's advertiser. + * Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Code type used for cache busting in the generated tag. Applicable only - * when floodlightActivityGroupType is COUNTER and countingMethod is - * STANDARD_COUNTING or UNIQUE_COUNTING. + * Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. */ cacheBustingType?: string; /** - * Counting method for conversions for this floodlight activity. This is a - * required field. + * Counting method for conversions for this floodlight activity. This is a required field. */ countingMethod?: string; /** @@ -4124,45 +3329,35 @@ export namespace dfareporting_v3_2 { */ defaultTags?: Schema$FloodlightActivityDynamicTag[]; /** - * URL where this tag will be deployed. If specified, must be less than 256 - * characters long. + * URL where this tag will be deployed. If specified, must be less than 256 characters long. */ expectedUrl?: string; /** - * Floodlight activity group ID of this floodlight activity. This is a - * required field. + * Floodlight activity group ID of this floodlight activity. This is a required field. */ floodlightActivityGroupId?: string; /** - * Name of the associated floodlight activity group. This is a read-only - * field. + * Name of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupName?: string; /** - * Tag string of the associated floodlight activity group. This is a - * read-only field. + * Tag string of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupTagString?: string; /** - * Type of the associated floodlight activity group. This is a read-only - * field. + * Type of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupType?: string; /** - * Floodlight configuration ID of this floodlight activity. If this field is - * left blank, the value will be copied over either from the activity - * group's floodlight configuration or from the existing activity's - * floodlight configuration. + * Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** - * The type of Floodlight tag this activity will generate. This is a - * required field. + * The type of Floodlight tag this activity will generate. This is a required field. */ floodlightTagType?: string; /** @@ -4170,23 +3365,19 @@ export namespace dfareporting_v3_2 { */ hidden?: boolean; /** - * ID of this floodlight activity. This is a read-only, auto-generated - * field. + * ID of this floodlight activity. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight activity. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivity". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". */ kind?: string; /** - * Name of this floodlight activity. This is a required field. Must be less - * than 129 characters long and cannot contain quotes. + * Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. */ name?: string; /** @@ -4202,8 +3393,7 @@ export namespace dfareporting_v3_2 { */ secure?: boolean; /** - * Whether the floodlight activity is SSL-compliant. This is a read-only - * field, its value detected by the system from the floodlight tags. + * Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. */ sslCompliant?: boolean; /** @@ -4211,28 +3401,19 @@ export namespace dfareporting_v3_2 { */ sslRequired?: boolean; /** - * Subaccount ID of this floodlight activity. This is a read-only field that - * can be left blank. + * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Tag format type for the floodlight activity. If left blank, the tag - * format will default to HTML. + * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. */ tagFormat?: string; /** - * Value of the cat= parameter in the floodlight tag, which the ad servers - * use to identify the activity. This is optional: if empty, a new tag - * string will be generated for you. This string must be 1 to 8 characters - * long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag - * string must also be unique among activities of the same activity group. - * This field is read-only after insertion. + * Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. */ tagString?: string; /** - * List of the user-defined variables used by this conversion tag. These map - * to the "u[1-100]=" in the tags. Each of these can have a user - * defined type. Acceptable values are U1 to U100, inclusive. + * List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. */ userDefinedVariableTypes?: string[]; } @@ -4258,70 +3439,51 @@ export namespace dfareporting_v3_2 { */ export interface Schema$FloodlightActivityGroup { /** - * Account ID of this floodlight activity group. This is a read-only field - * that can be left blank. + * Account ID of this floodlight activity group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this floodlight activity group. If this field is left - * blank, the value will be copied over either from the floodlight - * configuration's advertiser or from the existing activity group's - * advertiser. + * Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Floodlight configuration ID of this floodlight activity group. This is a - * required field. + * Floodlight configuration ID of this floodlight activity group. This is a required field. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** - * ID of this floodlight activity group. This is a read-only, auto-generated - * field. + * ID of this floodlight activity group. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight activity group. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". */ kind?: string; /** - * Name of this floodlight activity group. This is a required field. Must be - * less than 65 characters long and cannot contain quotes. + * Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. */ name?: string; /** - * Subaccount ID of this floodlight activity group. This is a read-only - * field that can be left blank. + * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Value of the type= parameter in the floodlight tag, which the ad servers - * use to identify the activity group that the activity belongs to. This is - * optional: if empty, a new tag string will be generated for you. This - * string must be 1 to 8 characters long, with valid characters being - * [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among - * activity groups of the same floodlight configuration. This field is - * read-only after insertion. + * Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. */ tagString?: string; /** - * Type of the floodlight activity group. This is a required field that is - * read-only after insertion. + * Type of the floodlight activity group. This is a required field that is read-only after insertion. */ type?: string; } @@ -4334,8 +3496,7 @@ export namespace dfareporting_v3_2 { */ floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". */ kind?: string; /** @@ -4352,9 +3513,7 @@ export namespace dfareporting_v3_2 { */ clickThrough?: boolean; /** - * Directory site ID of this dynamic tag. This is a write-only field that - * can be used as an alternative to the siteId field. When this resource is - * retrieved, only the siteId field will be populated. + * Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. */ directorySiteId?: string; /** @@ -4366,8 +3525,7 @@ export namespace dfareporting_v3_2 { */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** @@ -4380,8 +3538,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$FloodlightConfiguration { /** - * Account ID of this floodlight configuration. This is a read-only field - * that can be left blank. + * Account ID of this floodlight configuration. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -4389,8 +3546,7 @@ export namespace dfareporting_v3_2 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -4398,24 +3554,19 @@ export namespace dfareporting_v3_2 { */ analyticsDataSharingEnabled?: boolean; /** - * Whether the exposure-to-conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. + * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ exposureToConversionEnabled?: boolean; /** - * Day that will be counted as the first day of the week in reports. This is - * a required field. + * Day that will be counted as the first day of the week in reports. This is a required field. */ firstDayOfWeek?: string; /** - * ID of this floodlight configuration. This is a read-only, auto-generated - * field. + * ID of this floodlight configuration. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -4423,8 +3574,7 @@ export namespace dfareporting_v3_2 { */ inAppAttributionTrackingEnabled?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfiguration". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". */ kind?: string; /** @@ -4440,8 +3590,7 @@ export namespace dfareporting_v3_2 { */ omnitureSettings?: Schema$OmnitureSettings; /** - * Subaccount ID of this floodlight configuration. This is a read-only field - * that can be left blank. + * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -4466,34 +3615,28 @@ export namespace dfareporting_v3_2 { */ floodlightConfigurations?: Schema$FloodlightConfiguration[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfigurationsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". */ kind?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "FlOODLIGHT". + * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". */ export interface Schema$FloodlightReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#floodlightReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; } @@ -4502,13 +3645,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$FrequencyCap { /** - * Duration of time, in seconds, for this frequency cap. The maximum - * duration is 90 days. Acceptable values are 1 to 7776000, inclusive. + * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. */ duration?: string; /** - * Number of times an individual user can be served the ad within the - * specified duration. Acceptable values are 1 to 15, inclusive. + * Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. */ impressions?: string; } @@ -4517,8 +3658,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$FsCommand { /** - * Distance from the left of the browser.Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. + * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ left?: number; /** @@ -4526,8 +3666,7 @@ export namespace dfareporting_v3_2 { */ positionOption?: string; /** - * Distance from the top of the browser. Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. + * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ top?: number; /** @@ -4544,44 +3683,27 @@ export namespace dfareporting_v3_2 { */ export interface Schema$GeoTargeting { /** - * Cities to be targeted. For each city only dartId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a city, do not target or exclude the country of the city, and - * do not target the metro or region of the city. + * Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. */ cities?: Schema$City[]; /** - * Countries to be targeted or excluded from targeting, depending on the - * setting of the excludeCountries field. For each country only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting or excluding a country, do not target - * regions, cities, metros, or postal codes in the same country. + * Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. */ countries?: Schema$Country[]; /** - * Whether or not to exclude the countries in the countries field from - * targeting. If false, the countries field refers to countries which will - * be targeted by the ad. + * Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. */ excludeCountries?: boolean; /** - * Metros to be targeted. For each metro only dmaId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a metro, do not target or exclude the country of the metro. + * Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. */ metros?: Schema$Metro[]; /** - * Postal codes to be targeted. For each postal code only id is required. - * The other fields are populated automatically when the ad is inserted or - * updated. If targeting a postal code, do not target or exclude the country - * of the postal code. + * Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. */ postalCodes?: Schema$PostalCode[]; /** - * Regions to be targeted. For each region only dartId is required. The - * other fields are populated automatically when the ad is inserted or - * updated. If targeting a region, do not target or exclude the country of - * the region. + * Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. */ regions?: Schema$Region[]; } @@ -4594,10 +3716,7 @@ export namespace dfareporting_v3_2 { */ accountId?: string; /** - * Ad slots of this inventory item. If this inventory item represents a - * standalone placement, there will be exactly one ad slot. If this - * inventory item represents a placement group, there will be more than one - * ad slot, each representing one child placement in that placement group. + * Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group. */ adSlots?: Schema$AdSlot[]; /** @@ -4625,8 +3744,7 @@ export namespace dfareporting_v3_2 { */ inPlan?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItem". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". */ kind?: string; /** @@ -4634,9 +3752,7 @@ export namespace dfareporting_v3_2 { */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this inventory item. For standalone inventory items, this is the - * same name as that of its only ad slot. For group inventory items, this - * can differ from the name of any of its ad slots. + * Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots. */ name?: string; /** @@ -4685,8 +3801,7 @@ export namespace dfareporting_v3_2 { */ inventoryItems?: Schema$InventoryItem[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItemsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". */ kind?: string; /** @@ -4704,8 +3819,7 @@ export namespace dfareporting_v3_2 { expression?: string; } /** - * Contains information about where a user's browser is taken after the - * user clicks an ad. + * Contains information about where a user's browser is taken after the user clicks an ad. */ export interface Schema$LandingPage { /** @@ -4725,13 +3839,11 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#landingPage". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". */ kind?: string; /** - * Name of this landing page. This is a required field. It must be less than - * 256 characters long. + * Name of this landing page. This is a required field. It must be less than 256 characters long. */ name?: string; /** @@ -4744,19 +3856,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Language { /** - * Language ID of this language. This is the ID used for targeting and - * generating reports. + * Language ID of this language. This is the ID used for targeting and generating reports. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#language". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". */ kind?: string; /** - * Format of language code is an ISO 639 two-letter language code optionally - * followed by an underscore followed by an ISO 3166 code. Examples are - * "en" for English or "zh_CN" for Simplified Chinese. + * Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. */ languageCode?: string; /** @@ -4769,8 +3877,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$LanguagesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#languagesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". */ kind?: string; /** @@ -4783,9 +3890,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$LanguageTargeting { /** - * Languages that this ad targets. For each language only languageId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. + * Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. */ languages?: Schema$Language[]; } @@ -4799,13 +3904,11 @@ export namespace dfareporting_v3_2 { time?: string; } /** - * A group clause made up of list population terms representing constraints - * joined by ORs. + * A group clause made up of list population terms representing constraints joined by ORs. */ export interface Schema$ListPopulationClause { /** - * Terms of this list population clause. Each clause is made up of list - * population terms representing constraints and are joined by ORs. + * Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. */ terms?: Schema$ListPopulationTerm[]; } @@ -4814,19 +3917,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ListPopulationRule { /** - * Floodlight activity ID associated with this rule. This field can be left - * blank. + * Floodlight activity ID associated with this rule. This field can be left blank. */ floodlightActivityId?: string; /** - * Name of floodlight activity associated with this rule. This is a - * read-only, auto-generated field. + * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. */ floodlightActivityName?: string; /** - * Clauses that make up this list population rule. Clauses are joined by - * ANDs, and the clauses themselves are made up of list population terms - * which are joined by ORs. + * Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. */ listPopulationClauses?: Schema$ListPopulationClause[]; } @@ -4835,52 +3934,35 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ListPopulationTerm { /** - * Will be true if the term should check if the user is in the list and - * false if the term should check if the user is not in the list. This field - * is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by - * default. + * Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. */ contains?: boolean; /** - * Whether to negate the comparison result of this term during rule - * evaluation. This field is only relevant when type is left unset or set to - * CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ negation?: boolean; /** - * Comparison operator of this term. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ operator?: string; /** - * ID of the list in question. This field is only relevant when type is set - * to LIST_MEMBERSHIP_TERM. + * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. */ remarketingListId?: string; /** - * List population term type determines the applicable fields in this - * object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, - * variableFriendlyName, operator, value, and negation are applicable. If - * set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are - * applicable. If set to REFERRER_TERM then operator, value, and negation - * are applicable. + * List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. */ type?: string; /** - * Literal to compare the variable to. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ value?: string; /** - * Friendly name of this term's variable. This is a read-only, - * auto-generated field. This field is only relevant when type is left unset - * or set to CUSTOM_VARIABLE_TERM. + * Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. */ variableFriendlyName?: string; /** - * Name of the variable (U1, U2, etc.) being compared in this term. This - * field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or - * REFERRER_TERM. + * Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ variableName?: string; } @@ -4898,19 +3980,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$LookbackConfiguration { /** - * Lookback window, in days, from the last time a given user clicked on one - * of your ads. If you enter 0, clicks will not be considered as triggering - * events for floodlight tracking. If you leave this field blank, the - * default value for your account will be used. Acceptable values are 0 to - * 90, inclusive. + * Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. */ clickDuration?: number; /** - * Lookback window, in days, from the last time a given user viewed one of - * your ads. If you enter 0, impressions will not be considered as - * triggering events for floodlight tracking. If you leave this field blank, - * the default value for your account will be used. Acceptable values are 0 - * to 90, inclusive. + * Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. */ postImpressionActivitiesDuration?: number; } @@ -4944,13 +4018,11 @@ export namespace dfareporting_v3_2 { */ dartId?: string; /** - * DMA ID of this metro region. This is the ID used for targeting and - * generating reports, and is equivalent to metro_code. + * DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. */ dmaId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metro". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". */ kind?: string; /** @@ -4967,8 +4039,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$MetrosListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metrosListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". */ kind?: string; /** @@ -4989,8 +4060,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileApp". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". */ kind?: string; /** @@ -5007,8 +4077,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$MobileAppsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileAppsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". */ kind?: string; /** @@ -5037,8 +4106,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarrier". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". */ kind?: string; /** @@ -5051,8 +4119,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$MobileCarriersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarriersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". */ kind?: string; /** @@ -5065,19 +4132,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ObjectFilter { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#objectFilter". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". */ kind?: string; /** - * Applicable when status is ASSIGNED. The user has access to objects with - * these object IDs. + * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. */ objectIds?: string[]; /** - * Status of the filter. NONE means the user has access to none of the - * objects. ALL means the user has access to all objects. ASSIGNED means the - * user has access to the objects with IDs in the objectIds list. + * Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list. */ status?: string; } @@ -5099,13 +4162,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$OmnitureSettings { /** - * Whether placement cost data will be sent to Omniture. This property can - * be enabled only if omnitureIntegrationEnabled is true. + * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. */ omnitureCostDataEnabled?: boolean; /** - * Whether Omniture integration is enabled. This property can be enabled - * only when the "Advanced Ad Serving" account setting is enabled. + * Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. */ omnitureIntegrationEnabled?: boolean; } @@ -5122,8 +4183,7 @@ export namespace dfareporting_v3_2 { */ desktop?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystem". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". */ kind?: string; /** @@ -5140,8 +4200,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$OperatingSystemsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". */ kind?: string; /** @@ -5150,8 +4209,7 @@ export namespace dfareporting_v3_2 { operatingSystems?: Schema$OperatingSystem[]; } /** - * Contains information about a particular version of an operating system that - * can be targeted by ads. + * Contains information about a particular version of an operating system that can be targeted by ads. */ export interface Schema$OperatingSystemVersion { /** @@ -5159,8 +4217,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersion". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". */ kind?: string; /** @@ -5168,8 +4225,7 @@ export namespace dfareporting_v3_2 { */ majorVersion?: string; /** - * Minor version (number after the first dot) of this operating system - * version. + * Minor version (number after the first dot) of this operating system version. */ minorVersion?: string; /** @@ -5186,8 +4242,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$OperatingSystemVersionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". */ kind?: string; /** @@ -5200,19 +4255,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$OptimizationActivity { /** - * Floodlight activity ID of this optimization activity. This is a required - * field. + * Floodlight activity ID of this optimization activity. This is a required field. */ floodlightActivityId?: string; /** - * Dimension value for the ID of the floodlight activity. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. */ floodlightActivityIdDimensionValue?: Schema$DimensionValue; /** - * Weight associated with this optimization. The weight assigned will be - * understood in proportion to the weights assigned to the other - * optimization activities. Value must be greater than or equal to 1. + * Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. */ weight?: number; } @@ -5253,8 +4304,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#order". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". */ kind?: string; /** @@ -5307,9 +4357,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$OrderContact { /** - * Free-form information about this contact. It could be any information - * related to this contact in addition to type, title, name, and signature - * user profile ID. + * Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID. */ contactInfo?: string; /** @@ -5325,8 +4373,7 @@ export namespace dfareporting_v3_2 { */ contactType?: string; /** - * ID of the user profile containing the signature that will be embedded - * into order documents. + * ID of the user profile containing the signature that will be embedded into order documents. */ signatureUserProfileId?: string; } @@ -5343,9 +4390,7 @@ export namespace dfareporting_v3_2 { */ advertiserId?: string; /** - * The amended order document ID of this order document. An order document - * can be created by optionally amending another order document so that the - * change history can be preserved. + * The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. */ amendedOrderDocumentId?: string; /** @@ -5369,8 +4414,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocument". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". */ kind?: string; /** @@ -5411,8 +4455,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$OrderDocumentsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocumentsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". */ kind?: string; /** @@ -5429,8 +4472,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$OrdersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ordersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". */ kind?: string; /** @@ -5443,33 +4485,27 @@ export namespace dfareporting_v3_2 { orders?: Schema$Order[]; } /** - * Represents fields that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". + * Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ export interface Schema$PathToConversionReportCompatibleFields { /** - * Conversion dimensions which are compatible to be selected in the - * "conversionDimensions" section of the report. + * Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. */ conversionDimensions?: Schema$Dimension[]; /** - * Custom floodlight variables which are compatible to be selected in the - * "customFloodlightVariables" section of the report. + * Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. */ customFloodlightVariables?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#pathToConversionReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Per-interaction dimensions which are compatible to be selected in the - * "perInteractionDimensions" section of the report. + * Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. */ perInteractionDimensions?: Schema$Dimension[]; } @@ -5482,14 +4518,11 @@ export namespace dfareporting_v3_2 { */ accountId?: string; /** - * Whether this placement opts out of ad blocking. When true, ad blocking is - * disabled for this placement. When false, the campaign and site settings - * take effect. + * Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. */ adBlockingOptOut?: boolean; /** - * Additional sizes associated with this placement. When inserting or - * updating a placement, only the size ID field is used. + * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. */ additionalSizes?: Schema$Size[]; /** @@ -5497,8 +4530,7 @@ export namespace dfareporting_v3_2 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -5506,13 +4538,11 @@ export namespace dfareporting_v3_2 { */ archived?: boolean; /** - * Campaign ID of this placement. This field is a required field on - * insertion. + * Campaign ID of this placement. This field is a required field on insertion. */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** @@ -5520,13 +4550,7 @@ export namespace dfareporting_v3_2 { */ comment?: string; /** - * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering on desktop, on mobile devices or in mobile apps for regular or - * interstitial ads respectively. APP and APP_INTERSTITIAL are no longer - * allowed for new placement insertions. Instead, use DISPLAY or - * DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream - * video ads developed with the VAST standard. This field is required on - * insertion. + * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. */ compatibility?: string; /** @@ -5534,19 +4558,15 @@ export namespace dfareporting_v3_2 { */ contentCategoryId?: string; /** - * Information about the creation of this placement. This is a read-only - * field. + * Information about the creation of this placement. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** - * Directory site ID of this placement. On insert, you must set either this - * field or the siteId field to specify the site associated with this - * placement. This is a required field that is read-only after insertion. + * Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -5558,8 +4578,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the ID of this placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this placement. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -5567,13 +4586,11 @@ export namespace dfareporting_v3_2 { */ keyName?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placement". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". */ kind?: string; /** - * Information about the most recent modification of this placement. This is - * a read-only field. + * Information about the most recent modification of this placement. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** @@ -5581,18 +4598,15 @@ export namespace dfareporting_v3_2 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Name of this placement.This is a required field and must be less than 256 - * characters long. + * Name of this placement.This is a required field and must be less than 256 characters long. */ name?: string; /** - * Whether payment was approved for this placement. This is a read-only - * field relevant only to publisher-paid placements. + * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. */ paymentApproved?: boolean; /** - * Payment source for this placement. This is a required field that is - * read-only after insertion. + * Payment source for this placement. This is a required field that is read-only after insertion. */ paymentSource?: string; /** @@ -5600,8 +4614,7 @@ export namespace dfareporting_v3_2 { */ placementGroupId?: string; /** - * Dimension value for the ID of the placement group. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. */ placementGroupIdDimensionValue?: Schema$DimensionValue; /** @@ -5609,17 +4622,11 @@ export namespace dfareporting_v3_2 { */ placementStrategyId?: string; /** - * Pricing schedule of this placement. This field is required on insertion, - * specifically subfields startDate, endDate and pricingType. + * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. */ pricingSchedule?: Schema$PricingSchedule; /** - * Whether this placement is the primary placement of a roadblock (placement - * group). You cannot change this field from true to false. Setting this - * field to true will automatically set the primary field on the original - * primary placement of the roadblock to false, and it will automatically - * set the roadblock's primaryPlacementId field to the ID of this - * placement. + * Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. */ primary?: boolean; /** @@ -5627,21 +4634,15 @@ export namespace dfareporting_v3_2 { */ publisherUpdateInfo?: Schema$LastModifiedInfo; /** - * Site ID associated with this placement. On insert, you must set either - * this field or the directorySiteId field to specify the site associated - * with this placement. This is a required field that is read-only after - * insertion. + * Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** - * Size associated with this placement. When inserting or updating a - * placement, only the size ID field is used. This field is required on - * insertion. + * Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. */ size?: Schema$Size; /** @@ -5657,22 +4658,7 @@ export namespace dfareporting_v3_2 { */ subaccountId?: string; /** - * Tag formats to generate for this placement. This field is required on - * insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - - * "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_IFRAME_ILAYER" - - * "PLACEMENT_TAG_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - - * "PLACEMENT_TAG_CLICK_COMMANDS" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - - * "PLACEMENT_TAG_TRACKING" - - * "PLACEMENT_TAG_TRACKING_IFRAME" - - * "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + * Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" */ tagFormats?: string[]; /** @@ -5680,26 +4666,15 @@ export namespace dfareporting_v3_2 { */ tagSetting?: Schema$TagSetting; /** - * Whether Verification and ActiveView are disabled for in-stream video - * creatives for this placement. The same setting videoActiveViewOptOut - * exists on the site level -- the opt out occurs if either of these - * settings are true. These settings are distinct from - * DirectorySites.settings.activeViewOptOut or - * Sites.siteSettings.activeViewOptOut which only apply to display ads. - * However, Accounts.activeViewOptOut opts out both video traffic, as well - * as display ads, from Verification and ActiveView. + * Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. */ videoActiveViewOptOut?: boolean; /** - * A collection of settings which affect video creatives served through this - * placement. Applicable to placements with IN_STREAM_VIDEO compatibility. + * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. */ videoSettings?: Schema$VideoSettings; /** - * VPAID adapter setting for this placement. Controls which VPAID format the - * measurement adapter will use for in-stream video creatives assigned to - * this placement. Note: Flash is no longer supported. This field now - * defaults to HTML5 when the following values are provided: FLASH, BOTH. + * VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. */ vpaidAdapterChoice?: string; } @@ -5708,8 +4683,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlacementAssignment { /** - * Whether this placement assignment is active. When true, the placement - * will be included in the ad's rotation. + * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. */ active?: boolean; /** @@ -5717,13 +4691,11 @@ export namespace dfareporting_v3_2 { */ placementId?: string; /** - * Dimension value for the ID of the placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the placement. This is a read-only, auto-generated field. */ placementIdDimensionValue?: Schema$DimensionValue; /** - * Whether the placement to be assigned requires SSL. This is a read-only - * field that is auto-generated when the ad is inserted or updated. + * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslRequired?: boolean; } @@ -5732,18 +4704,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlacementGroup { /** - * Account ID of this placement group. This is a read-only field that can be - * left blank. + * Account ID of this placement group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this placement group. This is a required field on - * insertion. + * Advertiser ID of this placement group. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -5755,13 +4724,11 @@ export namespace dfareporting_v3_2 { */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * IDs of placements which are assigned to this placement group. This is a - * read-only, auto-generated field. + * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. */ childPlacementIds?: string[]; /** @@ -5773,20 +4740,15 @@ export namespace dfareporting_v3_2 { */ contentCategoryId?: string; /** - * Information about the creation of this placement group. This is a - * read-only field. + * Information about the creation of this placement group. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** - * Directory site ID associated with this placement group. On insert, you - * must set either this field or the site_id field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. + * Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -5798,32 +4760,23 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the ID of this placement group. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". */ kind?: string; /** - * Information about the most recent modification of this placement group. - * This is a read-only field. + * Information about the most recent modification of this placement group. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this placement group. This is a required field and must be less - * than 256 characters long. + * Name of this placement group. This is a required field and must be less than 256 characters long. */ name?: string; /** - * Type of this placement group. A package is a simple group of placements - * that acts as a single pricing point for a group of tags. A roadblock is a - * group of placements that not only acts as a single pricing point, but - * also assumes that all the tags in it will be served at the same time. A - * roadblock requires one of its assigned placements to be marked as primary - * for reporting. This field is required on insertion. + * Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. */ placementGroupType?: string; /** @@ -5831,36 +4784,27 @@ export namespace dfareporting_v3_2 { */ placementStrategyId?: string; /** - * Pricing schedule of this placement group. This field is required on - * insertion. + * Pricing schedule of this placement group. This field is required on insertion. */ pricingSchedule?: Schema$PricingSchedule; /** - * ID of the primary placement, used to calculate the media cost of a - * roadblock (placement group). Modifying this field will automatically - * modify the primary field on all affected roadblock child placements. + * ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. */ primaryPlacementId?: string; /** - * Dimension value for the ID of the primary placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. */ primaryPlacementIdDimensionValue?: Schema$DimensionValue; /** - * Site ID associated with this placement group. On insert, you must set - * either this field or the directorySiteId field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. + * Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** - * Subaccount ID of this placement group. This is a read-only field that can - * be left blank. + * Subaccount ID of this placement group. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -5869,8 +4813,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlacementGroupsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". */ kind?: string; /** @@ -5887,8 +4830,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlacementsGenerateTagsResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsGenerateTagsResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". */ kind?: string; /** @@ -5901,8 +4843,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlacementsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". */ kind?: string; /** @@ -5919,8 +4860,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlacementStrategiesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". */ kind?: string; /** @@ -5937,8 +4877,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlacementStrategy { /** - * Account ID of this placement strategy.This is a read-only field that can - * be left blank. + * Account ID of this placement strategy.This is a read-only field that can be left blank. */ accountId?: string; /** @@ -5946,14 +4885,11 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategy". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". */ kind?: string; /** - * Name of this placement strategy. This is a required field. It must be - * less than 256 characters long and unique among placement strategies of - * the same account. + * Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. */ name?: string; } @@ -5979,8 +4915,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformType". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". */ kind?: string; /** @@ -5993,8 +4928,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PlatformTypesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformTypesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". */ kind?: string; /** @@ -6007,13 +4941,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PopupWindowProperties { /** - * Popup dimension for a creative. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID + * Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID */ dimension?: Schema$Size; /** - * Upper-left corner coordinates of the popup window. Applicable if - * positionType is COORDINATES. + * Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES. */ offset?: Schema$OffsetPosition; /** @@ -6066,8 +4998,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCode". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". */ kind?: string; } @@ -6076,8 +5007,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PostalCodesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCodesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". */ kind?: string; /** @@ -6098,20 +5028,11 @@ export namespace dfareporting_v3_2 { */ endDate?: string; /** - * Flights of this inventory item. A flight (a.k.a. pricing period) - * represents the inventory item pricing information for a specific period - * of time. + * Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. */ flights?: Schema$Flight[]; /** - * Group type of this inventory item if it represents a placement group. Is - * null otherwise. There are two type of placement groups: - * PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory - * items that acts as a single pricing point for a group of tags. - * PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items - * that not only acts as a single pricing point, but also assumes that all - * the tags in it will be served at the same time. A roadblock requires one - * of its assigned inventory items to be marked as primary. + * Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary. */ groupType?: string; /** @@ -6136,22 +5057,15 @@ export namespace dfareporting_v3_2 { */ disregardOverdelivery?: boolean; /** - * Placement end date. This date must be later than, or the same day as, the - * placement start date, but not later than the campaign end date. If, for - * example, you set 6/25/2015 as both the start and end dates, the effective - * placement date is just that day only, 6/25/2015. The hours, minutes, and - * seconds of the end date should not be set, as doing so will result in an - * error. This field is required on insertion. + * Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion. */ endDate?: string; /** - * Whether this placement is flighted. If true, pricing periods will be - * computed automatically. + * Whether this placement is flighted. If true, pricing periods will be computed automatically. */ flighted?: boolean; /** - * Floodlight activity ID associated with this placement. This field should - * be set when placement pricing type is set to PRICING_TYPE_CPA. + * Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. */ floodlightActivityId?: string; /** @@ -6163,15 +5077,11 @@ export namespace dfareporting_v3_2 { */ pricingType?: string; /** - * Placement start date. This date must be later than, or the same day as, - * the campaign start date. The hours, minutes, and seconds of the start - * date should not be set, as doing so will result in an error. This field - * is required on insertion. + * Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion. */ startDate?: string; /** - * Testing start date of this placement. The hours, minutes, and seconds of - * the start date should not be set, as doing so will result in an error. + * Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. */ testingStartDate?: string; } @@ -6180,13 +5090,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$PricingSchedulePricingPeriod { /** - * Pricing period end date. This date must be later than, or the same day - * as, the pricing period start date, but not later than the placement end - * date. The period end date can be the same date as the period start date. - * If, for example, you set 6/25/2015 as both the start and end dates, the - * effective pricing period date is just that day only, 6/25/2015. The - * hours, minutes, and seconds of the end date should not be set, as doing - * so will result in an error. + * Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. */ endDate?: string; /** @@ -6194,19 +5098,15 @@ export namespace dfareporting_v3_2 { */ pricingComment?: string; /** - * Rate or cost of this pricing period in nanos (i.e., multipled by - * 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. + * Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. */ rateOrCostNanos?: string; /** - * Pricing period start date. This date must be later than, or the same day - * as, the placement start date. The hours, minutes, and seconds of the - * start date should not be set, as doing so will result in an error. + * Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. */ startDate?: string; /** - * Units of this pricing period. Acceptable values are 0 to 10000000000, - * inclusive. + * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. */ units?: string; } @@ -6231,10 +5131,7 @@ export namespace dfareporting_v3_2 { */ audienceGender?: string; /** - * Budget of this project in the currency specified by the current account. - * The value stored in this field represents only the non-fractional amount. - * For example, for USD, the smallest value that can be represented by this - * field is 1 US dollar. + * Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. */ budget?: string; /** @@ -6254,8 +5151,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#project". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". */ kind?: string; /** @@ -6312,8 +5208,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ProjectsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#projectsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". */ kind?: string; /** @@ -6326,38 +5221,31 @@ export namespace dfareporting_v3_2 { projects?: Schema$Project[]; } /** - * Represents fields that are compatible to be selected for a report of type - * "REACH". + * Represents fields that are compatible to be selected for a report of type "REACH". */ export interface Schema$ReachReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#reachReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */ pivotedActivityMetrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected in the - * "reachByFrequencyMetricNames" section of the report. + * Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. */ reachByFrequencyMetrics?: Schema$Metric[]; } @@ -6395,8 +5283,7 @@ export namespace dfareporting_v3_2 { */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#region". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". */ kind?: string; /** @@ -6413,8 +5300,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$RegionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#regionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". */ kind?: string; /** @@ -6423,18 +5309,11 @@ export namespace dfareporting_v3_2 { regions?: Schema$Region[]; } /** - * Contains properties of a remarketing list. Remarketing enables you to - * create lists of users who have performed specific actions on a site, then - * target ads to members of those lists. This resource can be used to manage - * remarketing lists that are owned by your advertisers. To see all - * remarketing lists that are visible to your advertisers, including those - * that are shared to your advertiser or account, use the - * TargetableRemarketingLists resource. + * Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. */ export interface Schema$RemarketingList { /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ accountId?: string; /** @@ -6442,13 +5321,11 @@ export namespace dfareporting_v3_2 { */ active?: boolean; /** - * Dimension value for the advertiser ID that owns this remarketing list. - * This is a required field. + * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -6460,13 +5337,11 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingList". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". */ kind?: string; /** - * Number of days that a user should remain in the remarketing list without - * an impression. Acceptable values are 1 to 540, inclusive. + * Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. */ lifeSpan?: string; /** @@ -6482,26 +5357,20 @@ export namespace dfareporting_v3_2 { */ listSource?: string; /** - * Name of the remarketing list. This is a required field. Must be no - * greater than 128 characters long. + * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. */ name?: string; /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ subaccountId?: string; } /** - * Contains properties of a remarketing list's sharing information. - * Sharing allows other accounts or advertisers to target to your remarketing - * lists. This resource can be used to manage remarketing list sharing to - * other accounts and advertisers. + * Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers. */ export interface Schema$RemarketingListShare { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListShare". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". */ kind?: string; /** @@ -6522,8 +5391,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$RemarketingListsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". */ kind?: string; /** @@ -6555,8 +5423,7 @@ export namespace dfareporting_v3_2 { metricNames?: string[]; }; /** - * The report criteria for a report of type - * "CROSS_DIMENSION_REACH". + * The report criteria for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachCriteria?: { breakdown?: Schema$SortedDimension[]; @@ -6601,11 +5468,7 @@ export namespace dfareporting_v3_2 { }; }; /** - * The output format of the report. If not specified, default format is - * "CSV". Note that the actual format in the completed report file - * might differ if for instance the report's size exceeds the - * format's capabilities. "CSV" will then be the fallback - * format. + * The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. */ format?: string; /** @@ -6617,8 +5480,7 @@ export namespace dfareporting_v3_2 { */ kind?: string; /** - * The timestamp (in milliseconds since epoch) of when this report was last - * modified. + * The timestamp (in milliseconds since epoch) of when this report was last modified. */ lastModifiedTime?: string; /** @@ -6667,9 +5529,7 @@ export namespace dfareporting_v3_2 { reachByFrequencyMetricNames?: string[]; }; /** - * The report's schedule. Can only be set if the report's - * 'dateRange' is a relative date range and the relative date range - * is not "TODAY". + * The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". */ schedule?: { active?: boolean; @@ -6690,33 +5550,27 @@ export namespace dfareporting_v3_2 { type?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "STANDARD". + * Represents fields that are compatible to be selected for a report of type "STANDARD". */ export interface Schema$ReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#reportCompatibleFields. + * The kind of resource this is, in this case dfareporting#reportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */ pivotedActivityMetrics?: Schema$Metric[]; } @@ -6737,10 +5591,7 @@ export namespace dfareporting_v3_2 { */ kind?: string; /** - * Continuation token used to page through reports. To retrieve the next - * page of results, set the next request's "pageToken" to the - * value of this field. The page token is only valid for a limited amount of - * time and should not be persisted. + * Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -6749,9 +5600,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$ReportsConfiguration { /** - * Whether the exposure to conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. + * Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ exposureToConversionEnabled?: boolean; /** @@ -6759,18 +5608,7 @@ export namespace dfareporting_v3_2 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Report generation time zone ID of this account. This is a required field - * that can only be changed by a superuser. Acceptable values are: - - * "1" for "America/New_York" - "2" for - * "Europe/London" - "3" for "Europe/Paris" - * - "4" for "Africa/Johannesburg" - "5" for - * "Asia/Jerusalem" - "6" for "Asia/Shanghai" - * - "7" for "Asia/Hong_Kong" - "8" for - * "Asia/Tokyo" - "9" for "Australia/Sydney" - * - "10" for "Asia/Dubai" - "11" for - * "America/Los_Angeles" - "12" for - * "Pacific/Auckland" - "13" for - * "America/Sao_Paulo" + * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" */ reportGenerationTimeZoneId?: string; } @@ -6779,13 +5617,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$RichMediaExitOverride { /** - * Click-through URL of this rich media exit override. Applicable if the - * enabled field is set to true. + * Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Whether to use the clickThroughUrl. If false, the creative-level exit - * will be used. + * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. */ enabled?: boolean; /** @@ -6794,13 +5630,11 @@ export namespace dfareporting_v3_2 { exitId?: string; } /** - * A rule associates an asset with a targeting template for asset-level - * targeting. Applicable to INSTREAM_VIDEO creatives. + * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$Rule { /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative. This is a required field. + * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. */ assetId?: string; /** @@ -6808,9 +5642,7 @@ export namespace dfareporting_v3_2 { */ name?: string; /** - * A targeting template ID. The targeting from the targeting template will - * be used to determine whether this asset should be served. This is a - * required field. + * A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field. */ targetingTemplateId?: string; } @@ -6819,8 +5651,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Site { /** - * Account ID of this site. This is a read-only field that can be left - * blank. + * Account ID of this site. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -6828,13 +5659,11 @@ export namespace dfareporting_v3_2 { */ approved?: boolean; /** - * Directory site associated with this site. This is a required field that - * is read-only after insertion. + * Directory site associated with this site. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -6842,8 +5671,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Dimension value for the ID of this site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this site. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -6851,16 +5679,11 @@ export namespace dfareporting_v3_2 { */ keyName?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#site". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". */ kind?: string; /** - * Name of this site.This is a required field. Must be less than 128 - * characters long. If this site is under a subaccount, the name must be - * unique among sites of the same subaccount. Otherwise, this site is a - * top-level site, and the name must be unique among top-level sites of the - * same account. + * Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. */ name?: string; /** @@ -6872,8 +5695,7 @@ export namespace dfareporting_v3_2 { */ siteSettings?: Schema$SiteSettings; /** - * Subaccount ID of this site. This is a read-only field that can be left - * blank. + * Subaccount ID of this site. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -6923,10 +5745,7 @@ export namespace dfareporting_v3_2 { */ activeViewOptOut?: boolean; /** - * Whether this site opts out of ad blocking. When true, ad blocking is - * disabled for all placements under the site, regardless of the individual - * placement settings. When false, the campaign and placement settings take - * effect. + * Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. */ adBlockingOptOut?: boolean; /** @@ -6946,22 +5765,11 @@ export namespace dfareporting_v3_2 { */ tagSetting?: Schema$TagSetting; /** - * Whether Verification and ActiveView for in-stream video creatives are - * disabled by default for new placements created under this site. This - * value will be used to populate the placement.videoActiveViewOptOut field, - * when no value is specified for the new placement. + * Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. */ videoActiveViewOptOutTemplate?: boolean; /** - * Default VPAID adapter setting for new placements created under this site. - * This value will be used to populate the placements.vpaidAdapterChoice - * field, when no value is specified for the new placement. Controls which - * VPAID format the measurement adapter will use for in-stream video - * creatives assigned to the placement. The publisher's specifications - * will typically determine this setting. For VPAID creatives, the adapter - * format will match the VPAID format (HTML5 VPAID creatives use the HTML5 - * adapter). Note: Flash is no longer supported. This field now defaults to - * HTML5 when the following values are provided: FLASH, BOTH. + * Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. */ vpaidAdapterChoiceTemplate?: string; } @@ -6970,8 +5778,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$SitesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sitesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". */ kind?: string; /** @@ -6984,8 +5791,7 @@ export namespace dfareporting_v3_2 { sites?: Schema$Site[]; } /** - * Represents the dimensions of ads, placements, creatives, or creative - * assets. + * Represents the dimensions of ads, placements, creatives, or creative assets. */ export interface Schema$Size { /** @@ -7001,8 +5807,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#size". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". */ kind?: string; /** @@ -7015,8 +5820,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$SizesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sizesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". */ kind?: string; /** @@ -7029,18 +5833,15 @@ export namespace dfareporting_v3_2 { */ export interface Schema$SkippableSetting { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#skippableSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". */ kind?: string; /** - * Amount of time to play videos served to this placement before counting a - * view. Applicable when skippable is true. + * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. */ progressOffset?: Schema$VideoOffset; /** - * Amount of time to play videos served to this placement before the skip - * button should appear. Applicable when skippable is true. + * Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. */ skipOffset?: Schema$VideoOffset; /** @@ -7070,8 +5871,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$Subaccount { /** - * ID of the account that contains this subaccount. This is a read-only - * field that can be left blank. + * ID of the account that contains this subaccount. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -7083,13 +5883,11 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccount". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". */ kind?: string; /** - * Name of this subaccount. This is a required field. Must be less than 128 - * characters long and be unique among subaccounts of the same account. + * Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. */ name?: string; } @@ -7098,8 +5896,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$SubaccountsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". */ kind?: string; /** @@ -7116,8 +5913,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$TagData { /** - * Ad associated with this placement tag. Applicable only when format is - * PLACEMENT_TAG_TRACKING. + * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ adId?: string; /** @@ -7125,8 +5921,7 @@ export namespace dfareporting_v3_2 { */ clickTag?: string; /** - * Creative associated with this placement tag. Applicable only when format - * is PLACEMENT_TAG_TRACKING. + * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ creativeId?: string; /** @@ -7143,15 +5938,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$TagSetting { /** - * Additional key-values to be included in tags. Each key-value pair must be - * of the form key=value, and pairs must be separated by a semicolon (;). - * Keys and values must not contain commas. For example, id=2;color=red is a - * valid value for this field. + * Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. */ additionalKeyValues?: string; /** - * Whether static landing page URLs should be included in the tags. This - * setting applies only to placements. + * Whether static landing page URLs should be included in the tags. This setting applies only to placements. */ includeClickThroughUrls?: boolean; /** @@ -7159,10 +5950,7 @@ export namespace dfareporting_v3_2 { */ includeClickTracking?: boolean; /** - * Option specifying how keywords are embedded in ad tags. This setting can - * be used to specify whether keyword placeholders are inserted in placement - * tags for this site. Publishers can then add keywords to those - * placeholders. + * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. */ keywordOption?: string; } @@ -7180,19 +5968,11 @@ export namespace dfareporting_v3_2 { imageTagEnabled?: boolean; } /** - * Contains properties of a targetable remarketing list. Remarketing enables - * you to create lists of users who have performed specific actions on a site, - * then target ads to members of those lists. This resource is a read-only - * view of a remarketing list to be used to faciliate targeting ads to - * specific lists. Remarketing lists that are owned by your advertisers and - * those that are shared to your advertisers or account are accessible via - * this resource. To manage remarketing lists that are owned by your - * advertisers, use the RemarketingLists resource. + * Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource. */ export interface Schema$TargetableRemarketingList { /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ accountId?: string; /** @@ -7200,8 +5980,7 @@ export namespace dfareporting_v3_2 { */ active?: boolean; /** - * Dimension value for the advertiser ID that owns this targetable - * remarketing list. + * Dimension value for the advertiser ID that owns this targetable remarketing list. */ advertiserId?: string; /** @@ -7217,13 +5996,11 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingList". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". */ kind?: string; /** - * Number of days that a user should remain in the targetable remarketing - * list without an impression. + * Number of days that a user should remain in the targetable remarketing list without an impression. */ lifeSpan?: string; /** @@ -7235,13 +6012,11 @@ export namespace dfareporting_v3_2 { */ listSource?: string; /** - * Name of the targetable remarketing list. Is no greater than 128 - * characters long. + * Name of the targetable remarketing list. Is no greater than 128 characters long. */ name?: string; /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ subaccountId?: string; } @@ -7250,8 +6025,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$TargetableRemarketingListsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingListsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". */ kind?: string; /** @@ -7264,23 +6038,19 @@ export namespace dfareporting_v3_2 { targetableRemarketingLists?: Schema$TargetableRemarketingList[]; } /** - * Contains properties of a targeting template. A targeting template - * encapsulates targeting information which can be reused across multiple ads. + * Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. */ export interface Schema$TargetingTemplate { /** - * Account ID of this targeting template. This field, if left unset, will be - * auto-generated on insert and is read-only after insert. + * Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. */ accountId?: string; /** - * Advertiser ID of this targeting template. This is a required field on - * insert and is read-only after insert. + * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -7300,8 +6070,7 @@ export namespace dfareporting_v3_2 { */ keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplate". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". */ kind?: string; /** @@ -7313,13 +6082,11 @@ export namespace dfareporting_v3_2 { */ listTargetingExpression?: Schema$ListTargetingExpression; /** - * Name of this targeting template. This field is required. It must be less - * than 256 characters long and unique within an advertiser. + * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. */ name?: string; /** - * Subaccount ID of this targeting template. This field, if left unset, will - * be auto-generated on insert and is read-only after insert. + * Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. */ subaccountId?: string; /** @@ -7332,8 +6099,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$TargetingTemplatesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplatesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". */ kind?: string; /** @@ -7354,8 +6120,7 @@ export namespace dfareporting_v3_2 { */ customHtml?: string; /** - * Type of browser window for which the backup image of the flash creative - * can be displayed. + * Type of browser window for which the backup image of the flash creative can be displayed. */ targetWindowOption?: string; } @@ -7364,45 +6129,27 @@ export namespace dfareporting_v3_2 { */ export interface Schema$TechnologyTargeting { /** - * Browsers that this ad targets. For each browser either set - * browserVersionId or dartId along with the version numbers. If both are - * specified, only browserVersionId will be used. The other fields are - * populated automatically when the ad is inserted or updated. + * Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. */ browsers?: Schema$Browser[]; /** - * Connection types that this ad targets. For each connection type only id - * is required. The other fields are populated automatically when the ad is - * inserted or updated. + * Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. */ connectionTypes?: Schema$ConnectionType[]; /** - * Mobile carriers that this ad targets. For each mobile carrier only id is - * required, and the other fields are populated automatically when the ad is - * inserted or updated. If targeting a mobile carrier, do not set targeting - * for any zip codes. + * Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. */ mobileCarriers?: Schema$MobileCarrier[]; /** - * Operating systems that this ad targets. To target specific versions, use - * operatingSystemVersions. For each operating system only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system, do not set - * targeting for operating system versions for the same operating system. + * Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. */ operatingSystems?: Schema$OperatingSystem[]; /** - * Operating system versions that this ad targets. To target all versions, - * use operatingSystems. For each operating system version, only id is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system version, do not set - * targeting for the corresponding operating system in operatingSystems. + * Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. */ operatingSystemVersions?: Schema$OperatingSystemVersion[]; /** - * Platform types that this ad targets. For example, desktop, mobile, or - * tablet. For each platform type, only id is required, and the other fields - * are populated automatically when the ad is inserted or updated. + * Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. */ platformTypes?: Schema$PlatformType[]; } @@ -7415,8 +6162,7 @@ export namespace dfareporting_v3_2 { */ name?: string; /** - * Value of the third-party authentication token. This is a read-only, - * auto-generated field. + * Value of the third-party authentication token. This is a read-only, auto-generated field. */ value?: string; } @@ -7438,19 +6184,16 @@ export namespace dfareporting_v3_2 { */ export interface Schema$TranscodeSetting { /** - * Whitelist of video formats to be served to this placement. Set this list - * to null or empty to serve all video formats. + * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. */ enabledVideoFormats?: number[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#transcodeSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". */ kind?: string; } /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. */ export interface Schema$UniversalAdId { /** @@ -7458,9 +6201,7 @@ export namespace dfareporting_v3_2 { */ registry?: string; /** - * ID value for this creative. Only alphanumeric characters and the - * following symbols are valid: "_/\-". Maximum length is 64 - * characters. Read only when registry is DCM. + * ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. */ value?: string; } @@ -7473,9 +6214,7 @@ export namespace dfareporting_v3_2 { */ dataType?: string; /** - * User-friendly name for the variable which will appear in reports. This is - * a required field, must be less than 64 characters long, and cannot - * contain the following characters: ""<>". + * User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>". */ reportName?: string; /** @@ -7542,14 +6281,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$UserRole { /** - * Account ID of this user role. This is a read-only field that can be left - * blank. + * Account ID of this user role. This is a read-only field that can be left blank. */ accountId?: string; /** - * Whether this is a default user role. Default user roles are created by - * the system for the account/subaccount and cannot be modified or deleted. - * Each default user role comes with a basic set of preassigned permissions. + * Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. */ defaultUserRole?: boolean; /** @@ -7557,21 +6293,15 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRole". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". */ kind?: string; /** - * Name of this user role. This is a required field. Must be less than 256 - * characters long. If this user role is under a subaccount, the name must - * be unique among sites of the same subaccount. Otherwise, this user role - * is a top-level user role, and the name must be unique among top-level - * user roles of the same account. + * Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. */ name?: string; /** - * ID of the user role that this user role is based on or copied from. This - * is a required field. + * ID of the user role that this user role is based on or copied from. This is a required field. */ parentUserRoleId?: string; /** @@ -7579,8 +6309,7 @@ export namespace dfareporting_v3_2 { */ permissions?: Schema$UserRolePermission[]; /** - * Subaccount ID of this user role. This is a read-only field that can be - * left blank. + * Subaccount ID of this user role. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -7597,8 +6326,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermission". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". */ kind?: string; /** @@ -7619,8 +6347,7 @@ export namespace dfareporting_v3_2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". */ kind?: string; /** @@ -7633,8 +6360,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$UserRolePermissionGroupsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". */ kind?: string; /** @@ -7647,8 +6373,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$UserRolePermissionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". */ kind?: string; /** @@ -7661,8 +6386,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$UserRolesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". */ kind?: string; /** @@ -7687,8 +6411,7 @@ export namespace dfareporting_v3_2 { */ id?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormat". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". */ kind?: string; /** @@ -7705,8 +6428,7 @@ export namespace dfareporting_v3_2 { */ export interface Schema$VideoFormatsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormatsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". */ kind?: string; /** @@ -7719,13 +6441,11 @@ export namespace dfareporting_v3_2 { */ export interface Schema$VideoOffset { /** - * Duration, as a percentage of video duration. Do not set when - * offsetSeconds is set. Acceptable values are 0 to 100, inclusive. + * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. */ offsetPercentage?: number; /** - * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable - * values are 0 to 86399, inclusive. + * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. */ offsetSeconds?: number; } @@ -7734,30 +6454,23 @@ export namespace dfareporting_v3_2 { */ export interface Schema$VideoSettings { /** - * Settings for the companion creatives of video creatives served to this - * placement. + * Settings for the companion creatives of video creatives served to this placement. */ companionSettings?: Schema$CompanionSetting; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoSettings". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". */ kind?: string; /** - * Orientation of a video placement. If this value is set, placement will - * return assets matching the specified orientation. + * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. */ orientation?: string; /** - * Settings for the skippability of video creatives served to this - * placement. If this object is provided, the creative-level skippable - * settings will be overridden. + * Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. */ skippableSettings?: Schema$SkippableSetting; /** - * Settings for the transcodes of video creatives served to this placement. - * If this object is provided, the creative-level transcode settings will be - * overridden. + * Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden. */ transcodeSettings?: Schema$TranscodeSetting; } @@ -8335,8 +7048,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.accounts.list - * @desc Retrieves the list of accounts, possibly filtered. This method - * supports paging. + * @desc Retrieves the list of accounts, possibly filtered. This method supports paging. * @alias dfareporting.accounts.list * @memberOf! () * @@ -8581,8 +7293,7 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only active accounts. Don't set this field to select both active - * and non-active accounts. + * Select only active accounts. Don't set this field to select both active and non-active accounts. */ active?: boolean; /** @@ -8602,12 +7313,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "account*2015" will return objects with names like "account - * June 2015", "account April 2015", or simply "account 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "account" will match - * objects with name "my account", "account 2015", or simply "account". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". */ searchString?: string; /** @@ -8814,8 +7520,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.accountUserProfiles.list - * @desc Retrieves a list of account user profiles, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging. * @alias dfareporting.accountUserProfiles.list * @memberOf! () * @@ -8907,8 +7612,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.accountUserProfiles.patch - * @desc Updates an existing account user profile. This method supports - * patch semantics. + * @desc Updates an existing account user profile. This method supports patch semantics. * @alias dfareporting.accountUserProfiles.patch * @memberOf! () * @@ -9119,13 +7823,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name, ID or email. Wildcards (*) are - * allowed. For example, "user profile*2015" will return objects with names - * like "user profile June 2015", "user profile April 2015", or simply "user - * profile 2015". Most of the searches also add wildcards implicitly at the - * start and the end of the search string. For example, a search string of - * "user profile" will match objects with name "my user profile", "user - * profile 2015", or simply "user profile". + * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". */ searchString?: string; /** @@ -9334,8 +8032,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.ads.list - * @desc Retrieves a list of ads, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of ads, possibly filtered. This method supports paging. * @alias dfareporting.ads.list * @memberOf! () * @@ -9630,12 +8327,7 @@ export namespace dfareporting_v3_2 { */ campaignIds?: string[]; /** - * Select default ads with the specified compatibility. Applicable when type - * is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop or on mobile devices for regular or - * interstitial ads, respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an - * in-stream video ads developed with the VAST standard. + * Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -9647,9 +8339,7 @@ export namespace dfareporting_v3_2 { */ creativeOptimizationConfigurationIds?: string[]; /** - * Select only dynamic click trackers. Applicable when type is - * AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If - * false, select static click trackers. Leave unset to select both. + * Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. */ dynamicClickTracker?: boolean; /** @@ -9681,17 +8371,11 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Select only ads whose list targeting expression use these remarketing - * list IDs. + * Select only ads whose list targeting expression use these remarketing list IDs. */ remarketingListIds?: string[]; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "ad*2015" will return objects with names like "ad June - * 2015", "ad April 2015", or simply "ad 2015". Most of the searches also - * add wildcards implicitly at the start and the end of the search string. - * For example, a search string of "ad" will match objects with name "my - * ad", "ad 2015", or simply "ad". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". */ searchString?: string; /** @@ -9987,8 +8671,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.advertiserGroups.list - * @desc Retrieves a list of advertiser groups, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging. * @alias dfareporting.advertiserGroups.list * @memberOf! () * @@ -10077,8 +8760,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.advertiserGroups.patch - * @desc Updates an existing advertiser group. This method supports patch - * semantics. + * @desc Updates an existing advertiser group. This method supports patch semantics. * @alias dfareporting.advertiserGroups.patch * @memberOf! () * @@ -10301,13 +8983,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser group June 2015", "advertiser group April 2015", or simply - * "advertiser group 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "advertisergroup" will match objects with name "my - * advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". */ searchString?: string; /** @@ -10609,8 +9285,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.advertiserLandingPages.patch - * @desc Updates an existing landing page. This method supports patch - * semantics. + * @desc Updates an existing landing page. This method supports patch semantics. * @alias dfareporting.advertiserLandingPages.patch * @memberOf! () * @@ -10805,8 +9480,7 @@ export namespace dfareporting_v3_2 { */ advertiserIds?: string[]; /** - * Select only archived landing pages. Don't set this field to select both - * archived and non-archived landing pages. + * Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. */ archived?: boolean; /** @@ -10830,13 +9504,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for landing pages by name or ID. Wildcards (*) are - * allowed. For example, "landingpage*2017" will return landing pages with - * names like "landingpage July 2017", "landingpage March 2017", or simply - * "landingpage 2017". Most of the searches also add wildcards implicitly at - * the start and the end of the search string. For example, a search string - * of "landingpage" will match campaigns with name "my landingpage", - * "landingpage 2015", or simply "landingpage". + * Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". */ searchString?: string; /** @@ -11048,8 +9716,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.advertisers.list - * @desc Retrieves a list of advertisers, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of advertisers, possibly filtered. This method supports paging. * @alias dfareporting.advertisers.list * @memberOf! () * @@ -11136,8 +9803,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.advertisers.patch - * @desc Updates an existing advertiser. This method supports patch - * semantics. + * @desc Updates an existing advertiser. This method supports patch semantics. * @alias dfareporting.advertisers.patch * @memberOf! () * @@ -11346,8 +10012,7 @@ export namespace dfareporting_v3_2 { */ maxResults?: number; /** - * Select only advertisers which use another advertiser's floodlight - * configuration. + * Select only advertisers which use another advertiser's floodlight configuration. */ onlyParent?: boolean; /** @@ -11359,13 +10024,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser June 2015", "advertiser April 2015", or simply "advertiser - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "advertiser" will match objects with name "my advertiser", "advertiser - * 2015", or simply "advertiser". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". */ searchString?: string; /** @@ -11525,9 +10184,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.campaignCreativeAssociations.insert - * @desc Associates a creative with the specified campaign. This method - * creates a default ad with dimensions matching the creative in the - * campaign if such a default ad does not exist already. + * @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. * @alias dfareporting.campaignCreativeAssociations.insert * @memberOf! () * @@ -11610,8 +10267,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.campaignCreativeAssociations.list - * @desc Retrieves the list of creative IDs associated with the specified - * campaign. This method supports paging. + * @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. * @alias dfareporting.campaignCreativeAssociations.list * @memberOf! () * @@ -11906,8 +10562,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.campaigns.list - * @desc Retrieves a list of campaigns, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of campaigns, possibly filtered. This method supports paging. * @alias dfareporting.campaigns.list * @memberOf! () * @@ -12174,8 +10829,7 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only campaigns whose advertisers belong to these advertiser - * groups. + * Select only campaigns whose advertisers belong to these advertiser groups. */ advertiserGroupIds?: string[]; /** @@ -12183,8 +10837,7 @@ export namespace dfareporting_v3_2 { */ advertiserIds?: string[]; /** - * Select only archived campaigns. Don't set this field to select both - * archived and non-archived campaigns. + * Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. */ archived?: boolean; /** @@ -12216,13 +10869,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. - * For example, "campaign*2015" will return campaigns with names like - * "campaign June 2015", "campaign April 2015", or simply "campaign 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "campaign" will - * match campaigns with name "my campaign", "campaign 2015", or simply - * "campaign". + * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". */ searchString?: string; /** @@ -12470,12 +11117,7 @@ export namespace dfareporting_v3_2 { */ ids?: string[]; /** - * Select only change logs whose change time is before the specified - * maxChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. + * Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. */ maxChangeTime?: string; /** @@ -12483,12 +11125,7 @@ export namespace dfareporting_v3_2 { */ maxResults?: number; /** - * Select only change logs whose change time is before the specified - * minChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. + * Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. */ minChangeTime?: string; /** @@ -12508,8 +11145,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Select only change logs whose object ID, user name, old or new values - * match the search string. + * Select only change logs whose object ID, user name, old or new values match the search string. */ searchString?: string; /** @@ -13052,8 +11688,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.contentCategories.list - * @desc Retrieves a list of content categories, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of content categories, possibly filtered. This method supports paging. * @alias dfareporting.contentCategories.list * @memberOf! () * @@ -13142,8 +11777,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.contentCategories.patch - * @desc Updates an existing content category. This method supports patch - * semantics. + * @desc Updates an existing content category. This method supports patch semantics. * @alias dfareporting.contentCategories.patch * @memberOf! () * @@ -13366,13 +12000,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "contentcategory*2015" will return objects with names like - * "contentcategory June 2015", "contentcategory April 2015", or simply - * "contentcategory 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "contentcategory" will match objects with name "my - * contentcategory", "contentcategory 2015", or simply "contentcategory". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". */ searchString?: string; /** @@ -14173,8 +12801,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.creativeFields.list - * @desc Retrieves a list of creative fields, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creative fields, possibly filtered. This method supports paging. * @alias dfareporting.creativeFields.list * @memberOf! () * @@ -14262,8 +12889,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.creativeFields.patch - * @desc Updates an existing creative field. This method supports patch - * semantics. + * @desc Updates an existing creative field. This method supports patch semantics. * @alias dfareporting.creativeFields.patch * @memberOf! () * @@ -14490,13 +13116,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for creative fields by name or ID. Wildcards (*) are - * allowed. For example, "creativefield*2015" will return creative fields - * with names like "creativefield June 2015", "creativefield April 2015", or - * simply "creativefield 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativefield" will match creative fields with the name - * "my creativefield", "creativefield 2015", or simply "creativefield". + * Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". */ searchString?: string; /** @@ -14781,8 +13401,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.creativeFieldValues.list - * @desc Retrieves a list of creative field values, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of creative field values, possibly filtered. This method supports paging. * @alias dfareporting.creativeFieldValues.list * @memberOf! () * @@ -14872,8 +13491,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.creativeFieldValues.patch - * @desc Updates an existing creative field value. This method supports - * patch semantics. + * @desc Updates an existing creative field value. This method supports patch semantics. * @alias dfareporting.creativeFieldValues.patch * @memberOf! () * @@ -15114,8 +13732,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for creative field values by their values. Wildcards - * (e.g. *) are not allowed. + * Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. */ searchString?: string; /** @@ -15332,8 +13949,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.creativeGroups.list - * @desc Retrieves a list of creative groups, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creative groups, possibly filtered. This method supports paging. * @alias dfareporting.creativeGroups.list * @memberOf! () * @@ -15422,8 +14038,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.creativeGroups.patch - * @desc Updates an existing creative group. This method supports patch - * semantics. + * @desc Updates an existing creative group. This method supports patch semantics. * @alias dfareporting.creativeGroups.patch * @memberOf! () * @@ -15638,13 +14253,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for creative groups by name or ID. Wildcards (*) are - * allowed. For example, "creativegroup*2015" will return creative groups - * with names like "creativegroup June 2015", "creativegroup April 2015", or - * simply "creativegroup 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativegroup" will match creative groups with the name - * "my creativegroup", "creativegroup 2015", or simply "creativegroup". + * Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". */ searchString?: string; /** @@ -15846,8 +14455,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.creatives.list - * @desc Retrieves a list of creatives, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creatives, possibly filtered. This method supports paging. * @alias dfareporting.creatives.list * @memberOf! () * @@ -16117,8 +14725,7 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only active creatives. Leave blank to select active and inactive - * creatives. + * Select only active creatives. Leave blank to select active and inactive creatives. */ active?: boolean; /** @@ -16126,8 +14733,7 @@ export namespace dfareporting_v3_2 { */ advertiserId?: string; /** - * Select only archived creatives. Leave blank to select archived and - * unarchived creatives. + * Select only archived creatives. Leave blank to select archived and unarchived creatives. */ archived?: boolean; /** @@ -16163,13 +14769,7 @@ export namespace dfareporting_v3_2 { */ renderingIds?: string[]; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "creative*2015" will return objects with names like - * "creative June 2015", "creative April 2015", or simply "creative 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "creative" will - * match objects with name "my creative", "creative 2015", or simply - * "creative". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". */ searchString?: string; /** @@ -16425,8 +15025,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.directorySiteContacts.list - * @desc Retrieves a list of directory site contacts, possibly filtered. - * This method supports paging. + * @desc Retrieves a list of directory site contacts, possibly filtered. This method supports paging. * @alias dfareporting.directorySiteContacts.list * @memberOf! () * @@ -16539,8 +15138,7 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only directory site contacts with these directory site IDs. This - * is a required field. + * Select only directory site contacts with these directory site IDs. This is a required field. */ directorySiteIds?: string[]; /** @@ -16560,14 +15158,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name, ID or email. Wildcards (*) are - * allowed. For example, "directory site contact*2015" will return objects - * with names like "directory site contact June 2015", "directory site - * contact April 2015", or simply "directory site contact 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "directory site contact" - * will match objects with name "my directory site contact", "directory site - * contact 2015", or simply "directory site contact". + * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". */ searchString?: string; /** @@ -16738,8 +15329,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.directorySites.list - * @desc Retrieves a list of directory sites, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of directory sites, possibly filtered. This method supports paging. * @alias dfareporting.directorySites.list * @memberOf! () * @@ -16873,23 +15463,19 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInStreamVideoPlacements?: boolean; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInterstitialPlacements?: boolean; /** - * Select only directory sites that accept publisher paid placements. This - * field can be left blank. + * Select only directory sites that accept publisher paid placements. This field can be left blank. */ acceptsPublisherPaidPlacements?: boolean; /** - * Select only active directory sites. Leave blank to retrieve both active - * and inactive directory sites. + * Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. */ active?: boolean; /** @@ -16921,13 +15507,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name, ID or URL. Wildcards (*) are - * allowed. For example, "directory site*2015" will return objects with - * names like "directory site June 2015", "directory site April 2015", or - * simply "directory site 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "directory site" will match objects with name "my - * directory site", "directory site 2015" or simply, "directory site". + * Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". */ searchString?: string; /** @@ -17023,11 +15603,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.dynamicTargetingKeys.insert - * @desc Inserts a new dynamic targeting key. Keys must be created at the - * advertiser level before being assigned to the advertiser's ads, - * creatives, or placements. There is a maximum of 1000 keys per advertiser, - * out of which a maximum of 20 keys can be assigned per ad, creative, or - * placement. + * @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. * @alias dfareporting.dynamicTargetingKeys.insert * @memberOf! () * @@ -17196,9 +15772,7 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. */ name?: string; /** @@ -17206,8 +15780,7 @@ export namespace dfareporting_v3_2 { */ objectId?: string; /** - * Type of the object of this dynamic targeting key. This is a required - * field. + * Type of the object of this dynamic targeting key. This is a required field. */ objectType?: string; /** @@ -17568,8 +16141,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.eventTags.patch - * @desc Updates an existing event tag. This method supports patch - * semantics. + * @desc Updates an existing event tag. This method supports patch semantics. * @alias dfareporting.eventTags.patch * @memberOf! () * @@ -17776,29 +16348,15 @@ export namespace dfareporting_v3_2 { */ campaignId?: string; /** - * Examine only the specified campaign or advertiser's event tags for - * matching selector criteria. When set to false, the parent advertiser and - * parent campaign of the specified ad or campaign is examined as well. In - * addition, when set to false, the status field is examined as well, along - * with the enabledByDefault field. This parameter can not be set to true - * when adId is specified as ads do not define their own even tags. + * Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. */ definitionsOnly?: boolean; /** - * Select only enabled event tags. What is considered enabled or disabled - * depends on the definitionsOnly parameter. When definitionsOnly is set to - * true, only the specified advertiser or campaign's event tags' - * enabledByDefault field is examined. When definitionsOnly is set to false, - * the specified ad or specified campaign's parent advertiser's or parent - * campaign's event tags' enabledByDefault and status fields are examined as - * well. + * Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. */ enabled?: boolean; /** - * Select only event tags with the specified event tag types. Event tag - * types can be used to specify whether to use a third-party pixel, a - * third-party JavaScript URL, or a third-party click-through URL for either - * impression or click tracking. + * Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. */ eventTagTypes?: string[]; /** @@ -17810,13 +16368,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "eventtag*2015" will return objects with names like - * "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "eventtag" will - * match objects with name "my eventtag", "eventtag 2015", or simply - * "eventtag". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". */ searchString?: string; /** @@ -17873,8 +16425,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.files.get - * @desc Retrieves a report file by its report ID and file ID. This method - * supports media download. + * @desc Retrieves a report file by its report ID and file ID. This method supports media download. * @alias dfareporting.files.get * @memberOf! () * @@ -18389,8 +16940,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.floodlightActivities.list - * @desc Retrieves a list of floodlight activities, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging. * @alias dfareporting.floodlightActivities.list * @memberOf! () * @@ -18486,8 +17036,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.floodlightActivities.patch - * @desc Updates an existing floodlight activity. This method supports patch - * semantics. + * @desc Updates an existing floodlight activity. This method supports patch semantics. * @alias dfareporting.floodlightActivities.patch * @memberOf! () * @@ -18710,41 +17259,31 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only floodlight activities for the specified advertiser ID. Must - * specify either ids, advertiserId, or floodlightConfigurationId for a - * non-empty result. + * Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ advertiserId?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group IDs. + * Select only floodlight activities with the specified floodlight activity group IDs. */ floodlightActivityGroupIds?: string[]; /** - * Select only floodlight activities with the specified floodlight activity - * group name. + * Select only floodlight activities with the specified floodlight activity group name. */ floodlightActivityGroupName?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group tag string. + * Select only floodlight activities with the specified floodlight activity group tag string. */ floodlightActivityGroupTagString?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group type. + * Select only floodlight activities with the specified floodlight activity group type. */ floodlightActivityGroupType?: string; /** - * Select only floodlight activities for the specified floodlight - * configuration ID. Must specify either ids, advertiserId, or - * floodlightConfigurationId for a non-empty result. + * Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ floodlightConfigurationId?: string; /** - * Select only floodlight activities with the specified IDs. Must specify - * either ids, advertiserId, or floodlightConfigurationId for a non-empty - * result. + * Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ ids?: string[]; /** @@ -18760,14 +17299,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivity*2015" will return objects with names - * like "floodlightactivity June 2015", "floodlightactivity April 2015", or - * simply "floodlightactivity 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "floodlightactivity" will match objects with name "my - * floodlightactivity activity", "floodlightactivity 2015", or simply - * "floodlightactivity". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". */ searchString?: string; /** @@ -18986,8 +17518,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.floodlightActivityGroups.list - * @desc Retrieves a list of floodlight activity groups, possibly filtered. - * This method supports paging. + * @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. * @alias dfareporting.floodlightActivityGroups.list * @memberOf! () * @@ -19087,8 +17618,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.floodlightActivityGroups.patch - * @desc Updates an existing floodlight activity group. This method supports - * patch semantics. + * @desc Updates an existing floodlight activity group. This method supports patch semantics. * @alias dfareporting.floodlightActivityGroups.patch * @memberOf! () * @@ -19285,21 +17815,15 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only floodlight activity groups with the specified advertiser ID. - * Must specify either advertiserId or floodlightConfigurationId for a - * non-empty result. + * Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. */ advertiserId?: string; /** - * Select only floodlight activity groups with the specified floodlight - * configuration ID. Must specify either advertiserId, or - * floodlightConfigurationId for a non-empty result. + * Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. */ floodlightConfigurationId?: string; /** - * Select only floodlight activity groups with the specified IDs. Must - * specify either advertiserId or floodlightConfigurationId for a non-empty - * result. + * Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. */ ids?: string[]; /** @@ -19315,14 +17839,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivitygroup*2015" will return objects with - * names like "floodlightactivitygroup June 2015", "floodlightactivitygroup - * April 2015", or simply "floodlightactivitygroup 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "floodlightactivitygroup" - * will match objects with name "my floodlightactivitygroup activity", - * "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". */ searchString?: string; /** @@ -19334,8 +17851,7 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; /** - * Select only floodlight activity groups with the specified floodlight - * activity group type. + * Select only floodlight activity groups with the specified floodlight activity group type. */ type?: string; } @@ -19555,8 +18071,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.floodlightConfigurations.patch - * @desc Updates an existing floodlight configuration. This method supports - * patch semantics. + * @desc Updates an existing floodlight configuration. This method supports patch semantics. * @alias dfareporting.floodlightConfigurations.patch * @memberOf! () * @@ -19736,8 +18251,7 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set of IDs of floodlight configurations to retrieve. Required field; - * otherwise an empty list will be returned. + * Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. */ ids?: string[]; /** @@ -19868,8 +18382,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.inventoryItems.list - * @desc Retrieves a list of inventory items, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of inventory items, possibly filtered. This method supports paging. * @alias dfareporting.inventoryItems.list * @memberOf! () * @@ -20418,12 +18931,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "app*2015" will return objects with names like "app Jan - * 2018", "app Jan 2018", or simply "app 2018". Most of the searches also - * add wildcards implicitly at the start and the end of the search string. - * For example, a search string of "app" will match objects with name "my - * app", "app 2018", or simply "app". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". */ searchString?: string; } @@ -21096,8 +19604,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.orderDocuments.list - * @desc Retrieves a list of order documents, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of order documents, possibly filtered. This method supports paging. * @alias dfareporting.orderDocuments.list * @memberOf! () * @@ -21243,13 +19750,7 @@ export namespace dfareporting_v3_2 { */ projectId?: string; /** - * Allows searching for order documents by name or ID. Wildcards (*) are - * allowed. For example, "orderdocument*2015" will return order documents - * with names like "orderdocument June 2015", "orderdocument April 2015", or - * simply "orderdocument 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "orderdocument" will match order documents with name "my - * orderdocument", "orderdocument 2015", or simply "orderdocument". + * Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". */ searchString?: string; /** @@ -21347,8 +19848,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.orders.list - * @desc Retrieves a list of orders, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of orders, possibly filtered. This method supports paging. * @alias dfareporting.orders.list * @memberOf! () * @@ -21474,12 +19974,7 @@ export namespace dfareporting_v3_2 { */ projectId?: string; /** - * Allows searching for orders by name or ID. Wildcards (*) are allowed. For - * example, "order*2015" will return orders with names like "order June - * 2015", "order April 2015", or simply "order 2015". Most of the searches - * also add wildcards implicitly at the start and the end of the search - * string. For example, a search string of "order" will match orders with - * name "my order", "order 2015", or simply "order". + * Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". */ searchString?: string; /** @@ -21654,8 +20149,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.placementGroups.list - * @desc Retrieves a list of placement groups, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of placement groups, possibly filtered. This method supports paging. * @alias dfareporting.placementGroups.list * @memberOf! () * @@ -21755,8 +20249,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.placementGroups.patch - * @desc Updates an existing placement group. This method supports patch - * semantics. + * @desc Updates an existing placement group. This method supports patch semantics. * @alias dfareporting.placementGroups.patch * @memberOf! () * @@ -21951,8 +20444,7 @@ export namespace dfareporting_v3_2 { */ advertiserIds?: string[]; /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. + * Select only archived placements. Don't set this field to select both archived and non-archived placements. */ archived?: boolean; /** @@ -21960,13 +20452,11 @@ export namespace dfareporting_v3_2 { */ campaignIds?: string[]; /** - * Select only placement groups that are associated with these content - * categories. + * Select only placement groups that are associated with these content categories. */ contentCategoryIds?: string[]; /** - * Select only placement groups that are associated with these directory - * sites. + * Select only placement groups that are associated with these directory sites. */ directorySiteIds?: string[]; /** @@ -21974,8 +20464,7 @@ export namespace dfareporting_v3_2 { */ ids?: string[]; /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". */ maxEndDate?: string; /** @@ -21983,20 +20472,15 @@ export namespace dfareporting_v3_2 { */ maxResults?: number; /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". */ maxStartDate?: string; /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". */ minEndDate?: string; /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". */ minStartDate?: string; /** @@ -22004,17 +20488,11 @@ export namespace dfareporting_v3_2 { */ pageToken?: string; /** - * Select only placement groups belonging with this group type. A package is - * a simple group of placements that acts as a single pricing point for a - * group of tags. A roadblock is a group of placements that not only acts as - * a single pricing point but also assumes that all the tags in it will be - * served at the same time. A roadblock requires one of its assigned - * placements to be marked as primary for reporting. + * Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. */ placementGroupType?: string; /** - * Select only placement groups that are associated with these placement - * strategies. + * Select only placement groups that are associated with these placement strategies. */ placementStrategyIds?: string[]; /** @@ -22026,13 +20504,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for placement groups by name or ID. Wildcards (*) are - * allowed. For example, "placement*2015" will return placement groups with - * names like "placement group June 2015", "placement group May 2015", or - * simply "placements 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementgroup" will match placement groups with name - * "my placementgroup", "placementgroup 2015", or simply "placementgroup". + * Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". */ searchString?: string; /** @@ -22329,8 +20801,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.placements.list - * @desc Retrieves a list of placements, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of placements, possibly filtered. This method supports paging. * @alias dfareporting.placements.list * @memberOf! () * @@ -22426,8 +20897,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.placements.patch - * @desc Updates an existing placement. This method supports patch - * semantics. + * @desc Updates an existing placement. This method supports patch semantics. * @alias dfareporting.placements.patch * @memberOf! () * @@ -22594,8 +21064,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Tag formats to generate for these placements. Note: - * PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + * Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. */ tagFormats?: string[]; } @@ -22642,8 +21111,7 @@ export namespace dfareporting_v3_2 { */ advertiserIds?: string[]; /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. + * Select only archived placements. Don't set this field to select both archived and non-archived placements. */ archived?: boolean; /** @@ -22651,11 +21119,7 @@ export namespace dfareporting_v3_2 { */ campaignIds?: string[]; /** - * Select only placements that are associated with these compatibilities. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices for regular or interstitial ads respectively. APP and - * APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers - * to rendering in in-stream video ads developed with the VAST standard. + * Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. */ compatibilities?: string[]; /** @@ -22675,8 +21139,7 @@ export namespace dfareporting_v3_2 { */ ids?: string[]; /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". */ maxEndDate?: string; /** @@ -22684,20 +21147,15 @@ export namespace dfareporting_v3_2 { */ maxResults?: number; /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". */ maxStartDate?: string; /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". */ minEndDate?: string; /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". */ minStartDate?: string; /** @@ -22709,8 +21167,7 @@ export namespace dfareporting_v3_2 { */ paymentSource?: string; /** - * Select only placements that are associated with these placement - * strategies. + * Select only placements that are associated with these placement strategies. */ placementStrategyIds?: string[]; /** @@ -22722,13 +21179,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for placements by name or ID. Wildcards (*) are allowed. - * For example, "placement*2015" will return placements with names like - * "placement June 2015", "placement May 2015", or simply "placements 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "placement" - * will match placements with name "my placement", "placement 2015", or - * simply "placement". + * Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". */ searchString?: string; /** @@ -23017,8 +21468,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.placementStrategies.list - * @desc Retrieves a list of placement strategies, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging. * @alias dfareporting.placementStrategies.list * @memberOf! () * @@ -23107,8 +21557,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.placementStrategies.patch - * @desc Updates an existing placement strategy. This method supports patch - * semantics. + * @desc Updates an existing placement strategy. This method supports patch semantics. * @alias dfareporting.placementStrategies.patch * @memberOf! () * @@ -23331,14 +21780,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "placementstrategy*2015" will return objects with names like - * "placementstrategy June 2015", "placementstrategy April 2015", or simply - * "placementstrategy 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementstrategy" will match objects with name "my - * placementstrategy", "placementstrategy 2015", or simply - * "placementstrategy". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". */ searchString?: string; /** @@ -23844,8 +22286,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.projects.list - * @desc Retrieves a list of projects, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of projects, possibly filtered. This method supports paging. * @alias dfareporting.projects.list * @memberOf! () * @@ -23967,12 +22408,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for projects by name or ID. Wildcards (*) are allowed. - * For example, "project*2015" will return projects with names like "project - * June 2015", "project April 2015", or simply "project 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "project" will match - * projects with name "my project", "project 2015", or simply "project". + * Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". */ searchString?: string; /** @@ -24234,8 +22670,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.remarketingLists.list - * @desc Retrieves a list of remarketing lists, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging. * @alias dfareporting.remarketingLists.list * @memberOf! () * @@ -24326,8 +22761,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.remarketingLists.patch - * @desc Updates an existing remarketing list. This method supports patch - * semantics. + * @desc Updates an existing remarketing list. This method supports patch semantics. * @alias dfareporting.remarketingLists.patch * @memberOf! () * @@ -24534,13 +22968,7 @@ export namespace dfareporting_v3_2 { */ maxResults?: number; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". */ name?: string; /** @@ -24684,8 +23112,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.remarketingListShares.patch - * @desc Updates an existing remarketing list share. This method supports - * patch semantics. + * @desc Updates an existing remarketing list share. This method supports patch semantics. * @alias dfareporting.remarketingListShares.patch * @memberOf! () * @@ -25563,9 +23990,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.reports.compatibleFields.query - * @desc Returns the fields that are compatible to be selected in the - * respective sections of a report criteria, given the fields already - * selected in the input report and user permissions. + * @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. * @alias dfareporting.reports.compatibleFields.query * @memberOf! () * @@ -26018,8 +24443,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.sites.list - * @desc Retrieves a list of sites, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of sites, possibly filtered. This method supports paging. * @alias dfareporting.sites.list * @memberOf! () * @@ -26286,13 +24710,11 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInStreamVideoPlacements?: boolean; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInterstitialPlacements?: boolean; /** @@ -26332,12 +24754,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name, ID or keyName. Wildcards (*) are - * allowed. For example, "site*2015" will return objects with names like - * "site June 2015", "site April 2015", or simply "site 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "site" will match objects - * with name "my site", "site 2015", or simply "site". + * Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". */ searchString?: string; /** @@ -26544,10 +24961,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.sizes.list - * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are - * globally unique and may include values not currently in use by your - * account. Due to this, the list of sizes returned by this method may - * differ from the list seen in the Trafficking UI. + * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. * @alias dfareporting.sizes.list * @memberOf! () * @@ -26838,8 +25252,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.subaccounts.list - * @desc Gets a list of subaccounts, possibly filtered. This method supports - * paging. + * @desc Gets a list of subaccounts, possibly filtered. This method supports paging. * @alias dfareporting.subaccounts.list * @memberOf! () * @@ -26920,8 +25333,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.subaccounts.patch - * @desc Updates an existing subaccount. This method supports patch - * semantics. + * @desc Updates an existing subaccount. This method supports patch semantics. * @alias dfareporting.subaccounts.patch * @memberOf! () * @@ -27126,13 +25538,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "subaccount*2015" will return objects with names like - * "subaccount June 2015", "subaccount April 2015", or simply "subaccount - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "subaccount" will match objects with name "my subaccount", "subaccount - * 2015", or simply "subaccount". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". */ searchString?: string; /** @@ -27271,8 +25677,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.targetableRemarketingLists.list - * @desc Retrieves a list of targetable remarketing lists, possibly - * filtered. This method supports paging. + * @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. * @alias dfareporting.targetableRemarketingLists.list * @memberOf! () * @@ -27405,13 +25810,7 @@ export namespace dfareporting_v3_2 { */ maxResults?: number; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". */ name?: string; /** @@ -27590,8 +25989,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.targetingTemplates.list - * @desc Retrieves a list of targeting templates, optionally filtered. This - * method supports paging. + * @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging. * @alias dfareporting.targetingTemplates.list * @memberOf! () * @@ -27681,8 +26079,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.targetingTemplates.patch - * @desc Updates an existing targeting template. This method supports patch - * semantics. + * @desc Updates an existing targeting template. This method supports patch semantics. * @alias dfareporting.targetingTemplates.patch * @memberOf! () * @@ -27893,13 +26290,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "template*2015" will return objects with names like - * "template June 2015", "template April 2015", or simply "template 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "template" will - * match objects with name "my template", "template 2015", or simply - * "template". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". */ searchString?: string; /** @@ -28747,8 +27138,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.userRoles.list - * @desc Retrieves a list of user roles, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of user roles, possibly filtered. This method supports paging. * @alias dfareporting.userRoles.list * @memberOf! () * @@ -28830,8 +27220,7 @@ export namespace dfareporting_v3_2 { /** * dfareporting.userRoles.patch - * @desc Updates an existing user role. This method supports patch - * semantics. + * @desc Updates an existing user role. This method supports patch semantics. * @alias dfareporting.userRoles.patch * @memberOf! () * @@ -29026,8 +27415,7 @@ export namespace dfareporting_v3_2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only account level user roles not associated with any specific - * subaccount. + * Select only account level user roles not associated with any specific subaccount. */ accountUserRoleOnly?: boolean; /** @@ -29047,13 +27435,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "userrole*2015" will return objects with names like - * "userrole June 2015", "userrole April 2015", or simply "userrole 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "userrole" will - * match objects with name "my userrole", "userrole 2015", or simply - * "userrole". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". */ searchString?: string; /** diff --git a/src/apis/dfareporting/v3.3.ts b/src/apis/dfareporting/v3.3.ts index b7bc4ac0af8..44934d8ce2d 100644 --- a/src/apis/dfareporting/v3.3.ts +++ b/src/apis/dfareporting/v3.3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace dfareporting_v3_3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace dfareporting_v3_3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -154,7 +151,10 @@ export namespace dfareporting_v3_3 { videoFormats: Resource$Videoformats; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries( this.context @@ -252,8 +252,7 @@ export namespace dfareporting_v3_3 { */ accountPermissionIds?: string[]; /** - * Profile for this account. This is a read-only field that can be left - * blank. + * Profile for this account. This is a read-only field that can be left blank. */ accountProfile?: string; /** @@ -265,8 +264,7 @@ export namespace dfareporting_v3_3 { */ activeAdsLimitTier?: string; /** - * Whether to serve creatives with Active View tags. If disabled, - * viewability data will not be available for any impressions. + * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. */ activeViewOptOut?: boolean; /** @@ -278,26 +276,7 @@ export namespace dfareporting_v3_3 { */ countryId?: string; /** - * ID of currency associated with this account. This is a required field. - * Acceptable values are: - "1" for USD - "2" for GBP - * - "3" for ESP - "4" for SEK - "5" for CAD - * - "6" for JPY - "7" for DEM - "8" for AUD - * - "9" for FRF - "10" for ITL - "11" for - * DKK - "12" for NOK - "13" for FIM - "14" - * for ZAR - "15" for IEP - "16" for NLG - - * "17" for EUR - "18" for KRW - "19" for - * TWD - "20" for SGD - "21" for CNY - "22" - * for HKD - "23" for NZD - "24" for MYR - - * "25" for BRL - "26" for PTE - "27" for - * MXP - "28" for CLP - "29" for TRY - "30" - * for ARS - "31" for PEN - "32" for ILS - - * "33" for CHF - "34" for VEF - "35" for - * COP - "36" for GTQ - "37" for PLN - "39" - * for INR - "40" for THB - "41" for IDR - - * "42" for CZK - "43" for RON - "44" for - * HUF - "45" for RUB - "46" for AED - "47" - * for BGN - "48" for HRK - "49" for MXN - - * "50" for NGN + * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN */ currencyId?: string; /** @@ -313,34 +292,23 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#account". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". */ kind?: string; /** - * Locale of this account. Acceptable values are: - "cs" (Czech) - * - "de" (German) - "en" (English) - - * "en-GB" (English United Kingdom) - "es" (Spanish) - - * "fr" (French) - "it" (Italian) - "ja" - * (Japanese) - "ko" (Korean) - "pl" (Polish) - - * "pt-BR" (Portuguese Brazil) - "ru" (Russian) - - * "sv" (Swedish) - "tr" (Turkish) - "zh-CN" - * (Chinese Simplified) - "zh-TW" (Chinese Traditional) + * Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) */ locale?: string; /** - * Maximum image size allowed for this account, in kilobytes. Value must be - * greater than or equal to 1. + * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. */ maximumImageSize?: string; /** - * Name of this account. This is a required field, and must be less than 128 - * characters long and be globally unique. + * Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. */ name?: string; /** - * Whether campaigns created in this account will be enabled for Nielsen OCR - * reach ratings by default. + * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. */ nielsenOcrEnabled?: boolean; /** @@ -352,8 +320,7 @@ export namespace dfareporting_v3_3 { */ shareReportsWithTwitter?: boolean; /** - * File size limit in kilobytes of Rich Media teaser creatives. Acceptable - * values are 1 to 10240, inclusive. + * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. */ teaserSizeLimit?: string; } @@ -378,21 +345,16 @@ export namespace dfareporting_v3_3 { */ availableAds?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountActiveAdSummary". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". */ kind?: string; } /** - * AccountPermissions contains information about a particular account - * permission. Some features of Campaign Manager require an account permission - * to be present in the account. + * AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account. */ export interface Schema$AccountPermission { /** - * Account profiles associated with this account permission. Possible - * values are: - "ACCOUNT_PROFILE_BASIC" - - * "ACCOUNT_PROFILE_STANDARD" + * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" */ accountProfiles?: string[]; /** @@ -400,8 +362,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermission". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". */ kind?: string; /** @@ -418,8 +379,7 @@ export namespace dfareporting_v3_3 { permissionGroupId?: string; } /** - * AccountPermissionGroups contains a mapping of permission group IDs to - * names. A permission group is a grouping of account permissions. + * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. */ export interface Schema$AccountPermissionGroup { /** @@ -427,8 +387,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". */ kind?: string; /** @@ -445,8 +404,7 @@ export namespace dfareporting_v3_3 { */ accountPermissionGroups?: Schema$AccountPermissionGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". */ kind?: string; } @@ -459,8 +417,7 @@ export namespace dfareporting_v3_3 { */ accountPermissions?: Schema$AccountPermission[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". */ kind?: string; } @@ -473,8 +430,7 @@ export namespace dfareporting_v3_3 { */ accounts?: Schema$Account[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". */ kind?: string; /** @@ -483,19 +439,15 @@ export namespace dfareporting_v3_3 { nextPageToken?: string; } /** - * AccountUserProfiles contains properties of a Campaign Manager user profile. - * This resource is specifically for managing user profiles, whereas - * UserProfiles is for accessing the API. + * AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API. */ export interface Schema$AccountUserProfile { /** - * Account ID of the user profile. This is a read-only field that can be - * left blank. + * Account ID of the user profile. This is a read-only field that can be left blank. */ accountId?: string; /** - * Whether this user profile is active. This defaults to false, and must be - * set true on insert for the user profile to be usable. + * Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. */ active?: boolean; /** @@ -511,9 +463,7 @@ export namespace dfareporting_v3_3 { */ comments?: string; /** - * Email of the user profile. The email addresss must be linked to a Google - * Account. This field is required on insertion and is read-only after - * insertion. + * Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. */ email?: string; /** @@ -521,26 +471,15 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfile". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". */ kind?: string; /** - * Locale of the user profile. This is a required field. Acceptable values - * are: - "cs" (Czech) - "de" (German) - - * "en" (English) - "en-GB" (English United Kingdom) - - * "es" (Spanish) - "fr" (French) - "it" - * (Italian) - "ja" (Japanese) - "ko" (Korean) - - * "pl" (Polish) - "pt-BR" (Portuguese Brazil) - - * "ru" (Russian) - "sv" (Swedish) - "tr" - * (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" - * (Chinese Traditional) + * Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) */ locale?: string; /** - * Name of the user profile. This is a required field. Must be less than 64 - * characters long, must be globally unique, and cannot contain whitespace - * or any of the following characters: "&;"#%,". + * Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,". */ name?: string; /** @@ -548,8 +487,7 @@ export namespace dfareporting_v3_3 { */ siteFilter?: Schema$ObjectFilter; /** - * Subaccount ID of the user profile. This is a read-only field that can be - * left blank. + * Subaccount ID of the user profile. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -557,8 +495,7 @@ export namespace dfareporting_v3_3 { */ traffickerType?: string; /** - * User type of the user profile. This is a read-only field that can be left - * blank. + * User type of the user profile. This is a read-only field that can be left blank. */ userAccessType?: string; /** @@ -579,8 +516,7 @@ export namespace dfareporting_v3_3 { */ accountUserProfiles?: Schema$AccountUserProfile[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfilesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". */ kind?: string; /** @@ -593,8 +529,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Activities { /** - * List of activity filters. The dimension values need to be all either of - * type "dfa:activity" or "dfa:activityGroup". + * List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". */ filters?: Schema$DimensionValue[]; /** @@ -623,8 +558,7 @@ export namespace dfareporting_v3_3 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -632,8 +566,7 @@ export namespace dfareporting_v3_3 { */ archived?: boolean; /** - * Audience segment ID that is being targeted for this ad. Applicable when - * type is AD_SERVING_STANDARD_AD. + * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. */ audienceSegmentId?: string; /** @@ -641,18 +574,15 @@ export namespace dfareporting_v3_3 { */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * Click-through URL for this ad. This is a required field on insertion. - * Applicable when type is AD_SERVING_CLICK_TRACKER. + * Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Click-through URL suffix properties for this ad. Applies to the URL in - * the ad or (if overriding ad properties) the URL in the creative. + * Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative. */ clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; /** @@ -660,14 +590,7 @@ export namespace dfareporting_v3_3 { */ comments?: string; /** - * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. - * DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are only used for existing default - * ads. New mobile placements must be assigned DISPLAY or - * DISPLAY_INTERSTITIAL and default ads created for those placements will be - * limited to those compatibility types. IN_STREAM_VIDEO refers to rendering - * in-stream video ads developed with the VAST standard. + * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -675,22 +598,15 @@ export namespace dfareporting_v3_3 { */ createInfo?: Schema$LastModifiedInfo; /** - * Creative group assignments for this ad. Applicable when type is - * AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number - * is allowed for a maximum of two assignments. + * Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments. */ creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; /** - * Creative rotation for this ad. Applicable when type is - * AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. - * When type is AD_SERVING_DEFAULT_AD, this field should have exactly one - * creativeAssignment. + * Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment. */ creativeRotation?: Schema$CreativeRotation; /** - * Time and day targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ dayPartTargeting?: Schema$DayPartTargeting; /** @@ -698,21 +614,15 @@ export namespace dfareporting_v3_3 { */ defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; /** - * Delivery schedule information for this ad. Applicable when type is - * AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with - * subfields priority and impressionRatio are required on insertion when - * type is AD_SERVING_STANDARD_AD. + * Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD. */ deliverySchedule?: Schema$DeliverySchedule; /** - * Whether this ad is a dynamic click tracker. Applicable when type is - * AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is - * read-only after insert. + * Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. */ dynamicClickTracker?: boolean; /** - * Date and time that this ad should stop serving. Must be later than the - * start time. This is a required field on insertion. + * Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. */ endTime?: string; /** @@ -720,9 +630,7 @@ export namespace dfareporting_v3_3 { */ eventTagOverrides?: Schema$EventTagOverride[]; /** - * Geographical targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ geoTargeting?: Schema$GeoTargeting; /** @@ -730,35 +638,27 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the ID of this ad. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this ad. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Key-value targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ad". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". */ kind?: string; /** - * Language targeting information for this ad. This field must be left blank - * if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. + * Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ languageTargeting?: Schema$LanguageTargeting; /** - * Information about the most recent modification of this ad. This is a - * read-only field. + * Information about the most recent modification of this ad. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this ad. This is a required field and must be less than 256 - * characters long. + * Name of this ad. This is a required field and must be less than 256 characters long. */ name?: string; /** @@ -766,9 +666,7 @@ export namespace dfareporting_v3_3 { */ placementAssignments?: Schema$PlacementAssignment[]; /** - * Remarketing list targeting expression for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. + * Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ remarketingListExpression?: Schema$ListTargetingExpression; /** @@ -776,44 +674,31 @@ export namespace dfareporting_v3_3 { */ size?: Schema$Size; /** - * Whether this ad is ssl compliant. This is a read-only field that is - * auto-generated when the ad is inserted or updated. + * Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslCompliant?: boolean; /** - * Whether this ad requires ssl. This is a read-only field that is - * auto-generated when the ad is inserted or updated. + * Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslRequired?: boolean; /** - * Date and time that this ad should start serving. If creating an ad, this - * field must be a time in the future. This is a required field on - * insertion. + * Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion. */ startTime?: string; /** - * Subaccount ID of this ad. This is a read-only field that can be left - * blank. + * Subaccount ID of this ad. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Targeting template ID, used to apply preconfigured targeting information - * to this ad. This cannot be set while any of dayPartTargeting, - * geoTargeting, keyValueTargetingExpression, languageTargeting, - * remarketingListExpression, or technologyTargeting are set. Applicable - * when type is AD_SERVING_STANDARD_AD. + * Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. */ targetingTemplateId?: string; /** - * Technology platform targeting information for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. + * Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. */ technologyTargeting?: Schema$TechnologyTargeting; /** - * Type of ad. This is a required field on insertion. Note that default ads - * (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative - * resource). + * Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). */ type?: string; } @@ -822,27 +707,19 @@ export namespace dfareporting_v3_3 { */ export interface Schema$AdBlockingConfiguration { /** - * Click-through URL used by brand-neutral ads. This is a required field - * when overrideClickThroughUrl is set to true. + * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. */ clickThroughUrl?: string; /** - * ID of a creative bundle to use for this campaign. If set, brand-neutral - * ads will select creatives from this bundle. Otherwise, a default - * transparent pixel will be used. + * ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. */ creativeBundleId?: string; /** - * Whether this campaign has enabled ad blocking. When true, ad blocking is - * enabled for placements in the campaign, but this may be overridden by - * site and placement settings. When false, ad blocking is disabled for all - * placements under the campaign, regardless of site and placement settings. + * Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. */ enabled?: boolean; /** - * Whether the brand-neutral ad's click-through URL comes from the - * campaign's creative bundle or the override URL. Must be set to true - * if ad blocking is enabled and no creative bundle is configured. + * Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. */ overrideClickThroughUrl?: boolean; } @@ -855,8 +732,7 @@ export namespace dfareporting_v3_3 { */ ads?: Schema$Ad[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#adsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". */ kind?: string; /** @@ -873,11 +749,7 @@ export namespace dfareporting_v3_3 { */ comment?: string; /** - * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop, mobile devices or in mobile apps for regular - * or interstitial ads respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in - * in-stream video ads developed with the VAST standard. + * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -885,8 +757,7 @@ export namespace dfareporting_v3_3 { */ height?: string; /** - * ID of the placement from an external platform that is linked to this ad - * slot. + * ID of the placement from an external platform that is linked to this ad slot. */ linkedPlacementId?: string; /** @@ -911,24 +782,19 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Advertiser { /** - * Account ID of this advertiser.This is a read-only field that can be left - * blank. + * Account ID of this advertiser.This is a read-only field that can be left blank. */ accountId?: string; /** - * ID of the advertiser group this advertiser belongs to. You can group - * advertisers for reporting purposes, allowing you to see aggregated - * information for all advertisers in each group. + * ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. */ advertiserGroupId?: string; /** - * Suffix added to click-through URL of ad creative associations under this - * advertiser. Must be less than 129 characters long. + * Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. */ clickThroughUrlSuffix?: string; /** - * ID of the click-through event tag to apply by default to the landing - * pages of this advertiser's campaigns. + * ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. */ defaultClickThroughEventTagId?: string; /** @@ -936,20 +802,11 @@ export namespace dfareporting_v3_3 { */ defaultEmail?: string; /** - * Floodlight configuration ID of this advertiser. The floodlight - * configuration ID will be created automatically, so on insert this field - * should be left blank. This field can be set to another advertiser's - * floodlight configuration ID in order to share that advertiser's - * floodlight configuration with this advertiser, so long as: - This - * advertiser's original floodlight configuration is not already - * associated with floodlight activities or floodlight activity groups. - - * This advertiser's original floodlight configuration is not already - * shared with another advertiser. + * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** @@ -957,27 +814,19 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the ID of this advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiser". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". */ kind?: string; /** - * Name of this advertiser. This is a required field and must be less than - * 256 characters long and unique among advertisers of the same account. + * Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. */ name?: string; /** - * Original floodlight configuration before any sharing occurred. Set the - * floodlightConfigurationId of this advertiser to - * originalFloodlightConfigurationId to unshare the advertiser's current - * floodlight configuration. You cannot unshare an advertiser's - * floodlight configuration if the shared configuration has activities - * associated with any campaign or placement. + * Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. */ originalFloodlightConfigurationId?: string; /** @@ -985,8 +834,7 @@ export namespace dfareporting_v3_3 { */ status?: string; /** - * Subaccount ID of this advertiser.This is a read-only field that can be - * left blank. + * Subaccount ID of this advertiser.This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -995,13 +843,11 @@ export namespace dfareporting_v3_3 { suspended?: boolean; } /** - * Groups advertisers together so that reports can be generated for the entire - * group at once. + * Groups advertisers together so that reports can be generated for the entire group at once. */ export interface Schema$AdvertiserGroup { /** - * Account ID of this advertiser group. This is a read-only field that can - * be left blank. + * Account ID of this advertiser group. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1009,14 +855,11 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". */ kind?: string; /** - * Name of this advertiser group. This is a required field and must be less - * than 256 characters long and unique among advertiser groups of the same - * account. + * Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. */ name?: string; } @@ -1029,8 +872,7 @@ export namespace dfareporting_v3_3 { */ advertiserGroups?: Schema$AdvertiserGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". */ kind?: string; /** @@ -1043,8 +885,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$AdvertiserLandingPagesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserLandingPagesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". */ kind?: string; /** @@ -1065,8 +906,7 @@ export namespace dfareporting_v3_3 { */ advertisers?: Schema$Advertiser[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertisersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". */ kind?: string; /** @@ -1079,9 +919,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$AudienceSegment { /** - * Weight allocated to this segment. The weight assigned will be understood - * in proportion to the weights assigned to other segments in the same - * segment group. Acceptable values are 1 to 1000, inclusive. + * Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. */ allocation?: number; /** @@ -1089,8 +927,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Name of this audience segment. This is a required field and must be less - * than 65 characters long. + * Name of this audience segment. This is a required field and must be less than 65 characters long. */ name?: string; } @@ -1099,18 +936,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$AudienceSegmentGroup { /** - * Audience segments assigned to this group. The number of segments must be - * between 2 and 100. + * Audience segments assigned to this group. The number of segments must be between 2 and 100. */ audienceSegments?: Schema$AudienceSegment[]; /** - * ID of this audience segment group. This is a read-only, auto-generated - * field. + * ID of this audience segment group. This is a read-only, auto-generated field. */ id?: string; /** - * Name of this audience segment group. This is a required field and must be - * less than 65 characters long. + * Name of this audience segment group. This is a required field and must be less than 65 characters long. */ name?: string; } @@ -1119,8 +953,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Browser { /** - * ID referring to this grouping of browser and version numbers. This is the - * ID used for targeting. + * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. */ browserVersionId?: string; /** @@ -1128,30 +961,15 @@ export namespace dfareporting_v3_3 { */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browser". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". */ kind?: string; /** - * Major version number (leftmost number) of this browser. For example, for - * Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) - * may be used to target any version number, and a question mark (?) may be - * used to target cases where the version number cannot be identified. For - * example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so - * on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets - * cases where the ad server knows the browser is Firefox but can't tell - * which version it is. + * Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. */ majorVersion?: string; /** - * Minor version number (number after first dot on left) of this browser. - * For example, for Chrome 5.0.375.86 beta, this field should be set to 0. - * An asterisk (*) may be used to target any version number, and a question - * mark (?) may be used to target cases where the version number cannot be - * identified. For example, Chrome *.* targets any version of Chrome: - * 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but - * not 4.0. Firefox ?.? targets cases where the ad server knows the browser - * is Firefox but can't tell which version it is. + * Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. */ minorVersion?: string; /** @@ -1168,8 +986,7 @@ export namespace dfareporting_v3_3 { */ browsers?: Schema$Browser[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browsersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". */ kind?: string; } @@ -1178,8 +995,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Campaign { /** - * Account ID of this campaign. This is a read-only field that can be left - * blank. + * Account ID of this campaign. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1199,8 +1015,7 @@ export namespace dfareporting_v3_3 { */ advertiserId?: string; /** - * Dimension value for the advertiser ID of this campaign. This is a - * read-only, auto-generated field. + * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -1208,13 +1023,11 @@ export namespace dfareporting_v3_3 { */ archived?: boolean; /** - * Audience segment groups assigned to this campaign. Cannot have more than - * 300 segment groups. + * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. */ audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; /** - * Billing invoice code included in the Campaign Manager client billing - * invoices associated with the campaign. + * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. */ billingInvoiceCode?: string; /** @@ -1222,13 +1035,11 @@ export namespace dfareporting_v3_3 { */ clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; /** - * Arbitrary comments about this campaign. Must be less than 256 characters - * long. + * Arbitrary comments about this campaign. Must be less than 256 characters long. */ comment?: string; /** - * Information about the creation of this campaign. This is a read-only - * field. + * Information about the creation of this campaign. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** @@ -1248,18 +1059,11 @@ export namespace dfareporting_v3_3 { */ defaultLandingPageId?: string; /** - * Date on which the campaign will stop running. On insert, the end date - * must be today or a future date. The end date must be later than or be the - * same as the start date. If, for example, you set 6/25/2015 as both the - * start and end dates, the effective campaign run date is just that day - * only, 6/25/2015. The hours, minutes, and seconds of the end date should - * not be set, as doing so will result in an error. This is a required - * field. + * Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field. */ endDate?: string; /** - * Overrides that can be used to activate or deactivate advertiser event - * tags. + * Overrides that can be used to activate or deactivate advertiser event tags. */ eventTagOverrides?: Schema$EventTagOverride[]; /** @@ -1271,23 +1075,19 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the ID of this campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaign". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". */ kind?: string; /** - * Information about the most recent modification of this campaign. This is - * a read-only field. + * Information about the most recent modification of this campaign. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this campaign. This is a required field and must be less than 256 - * characters long and unique among campaigns of the same advertiser. + * Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. */ name?: string; /** @@ -1295,14 +1095,11 @@ export namespace dfareporting_v3_3 { */ nielsenOcrEnabled?: boolean; /** - * Date on which the campaign starts running. The start date can be any - * date. The hours, minutes, and seconds of the start date should not be - * set, as doing so will result in an error. This is a required field. + * Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field. */ startDate?: string; /** - * Subaccount ID of this campaign. This is a read-only field that can be - * left blank. + * Subaccount ID of this campaign. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -1315,13 +1112,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CampaignCreativeAssociation { /** - * ID of the creative associated with the campaign. This is a required - * field. + * ID of the creative associated with the campaign. This is a required field. */ creativeId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociation". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". */ kind?: string; } @@ -1334,8 +1129,7 @@ export namespace dfareporting_v3_3 { */ campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociationsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". */ kind?: string; /** @@ -1352,8 +1146,7 @@ export namespace dfareporting_v3_3 { */ campaigns?: Schema$Campaign[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". */ kind?: string; /** @@ -1386,8 +1179,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLog". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". */ kind?: string; /** @@ -1395,8 +1187,7 @@ export namespace dfareporting_v3_3 { */ newValue?: string; /** - * ID of the object of this change log. The object could be a campaign, - * placement, ad, or other type. + * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. */ objectId?: string; /** @@ -1412,9 +1203,7 @@ export namespace dfareporting_v3_3 { */ subaccountId?: string; /** - * Transaction ID of this change log. When a single API call results in many - * changes, each change will have a separate ID in the change log but will - * share the same transactionId. + * Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. */ transactionId?: string; /** @@ -1435,8 +1224,7 @@ export namespace dfareporting_v3_3 { */ changeLogs?: Schema$ChangeLog[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLogsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". */ kind?: string; /** @@ -1453,8 +1241,7 @@ export namespace dfareporting_v3_3 { */ cities?: Schema$City[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#citiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". */ kind?: string; } @@ -1471,13 +1258,11 @@ export namespace dfareporting_v3_3 { */ countryDartId?: string; /** - * DART ID of this city. This is the ID used for targeting and generating - * reports. + * DART ID of this city. This is the ID used for targeting and generating reports. */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#city". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". */ kind?: string; /** @@ -1506,20 +1291,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ClickTag { /** - * Parameter value for the specified click tag. This field contains a - * click-through url. + * Parameter value for the specified click tag. This field contains a click-through url. */ clickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * Advertiser event name associated with the click tag. This field is used - * by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. + * Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ eventName?: string; /** - * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY - * creative assets, this field must match the value of the creative - * asset's creativeAssetId.name field. + * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. */ name?: string; } @@ -1528,18 +1308,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ClickThroughUrl { /** - * Read-only convenience field representing the actual URL that will be used - * for this click-through. The URL is computed as follows: - If - * defaultLandingPage is enabled then the campaign's default landing - * page URL is assigned to this field. - If defaultLandingPage is not - * enabled and a landingPageId is specified then that landing page's URL - * is assigned to this field. - If neither of the above cases apply, then - * the customClickThroughUrl is assigned to this field. + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. */ computedClickThroughUrl?: string; /** - * Custom click-through URL. Applicable if the defaultLandingPage field is - * set to false and the landingPageId field is left unset. + * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. */ customClickThroughUrl?: string; /** @@ -1547,8 +1320,7 @@ export namespace dfareporting_v3_3 { */ defaultLandingPage?: boolean; /** - * ID of the landing page for the click-through URL. Applicable if the - * defaultLandingPage field is set to false. + * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. */ landingPageId?: string; } @@ -1557,13 +1329,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ClickThroughUrlSuffixProperties { /** - * Click-through URL suffix to apply to all ads in this entity's scope. - * Must be less than 128 characters long. + * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. */ clickThroughUrlSuffix?: string; /** - * Whether this entity should override the inherited click-through URL - * suffix with its own defined value. + * Whether this entity should override the inherited click-through URL suffix with its own defined value. */ overrideInheritedSuffix?: boolean; } @@ -1589,8 +1359,7 @@ export namespace dfareporting_v3_3 { */ companionsDisabled?: boolean; /** - * Whitelist of companion sizes to be served to this placement. Set this - * list to null or empty to serve all companion sizes. + * Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. */ enabledSizes?: Schema$Size[]; /** @@ -1598,8 +1367,7 @@ export namespace dfareporting_v3_3 { */ imageOnly?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#companionSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". */ kind?: string; } @@ -1608,13 +1376,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CompatibleFields { /** - * Contains items that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". + * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "FLOODLIGHT". + * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". */ floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; /** @@ -1622,25 +1388,20 @@ export namespace dfareporting_v3_3 { */ kind?: string; /** - * Contains items that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". + * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "REACH". + * Contains items that are compatible to be selected for a report of type "REACH". */ reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; /** - * Contains items that are compatible to be selected for a report of type - * "STANDARD". + * Contains items that are compatible to be selected for a report of type "STANDARD". */ reportCompatibleFields?: Schema$ReportCompatibleFields; } /** - * Contains information about an internet connection type that can be targeted - * by ads. Clients can use the connection type to target mobile vs. broadband - * users. + * Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. */ export interface Schema$ConnectionType { /** @@ -1648,8 +1409,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionType". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". */ kind?: string; /** @@ -1666,8 +1426,7 @@ export namespace dfareporting_v3_3 { */ connectionTypes?: Schema$ConnectionType[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionTypesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". */ kind?: string; } @@ -1680,8 +1439,7 @@ export namespace dfareporting_v3_3 { */ contentCategories?: Schema$ContentCategory[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategoriesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". */ kind?: string; /** @@ -1690,13 +1448,11 @@ export namespace dfareporting_v3_3 { nextPageToken?: string; } /** - * Organizes placements according to the contents of their associated - * webpages. + * Organizes placements according to the contents of their associated webpages. */ export interface Schema$ContentCategory { /** - * Account ID of this content category. This is a read-only field that can - * be left blank. + * Account ID of this content category. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -1704,25 +1460,20 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategory". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". */ kind?: string; /** - * Name of this content category. This is a required field and must be less - * than 256 characters long and unique among content categories of the same - * account. + * Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. */ name?: string; } /** - * A Conversion represents when a user successfully performs a desired action - * after seeing an ad. + * A Conversion represents when a user successfully performs a desired action after seeing an ad. */ export interface Schema$Conversion { /** - * Whether this particular request may come from a user under the age of 13, - * under COPPA compliance. + * Whether this particular request may come from a user under the age of 13, under COPPA compliance. */ childDirectedTreatment?: boolean; /** @@ -1730,22 +1481,11 @@ export namespace dfareporting_v3_3 { */ customVariables?: Schema$CustomFloodlightVariable[]; /** - * The alphanumeric encrypted user ID. When set, encryptionInfo should also - * be specified. This field is mutually exclusive with - * encryptedUserIdCandidates[], mobileDeviceId and gclid. This or - * encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required - * field. + * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. */ encryptedUserId?: string; /** - * A list of the alphanumeric encrypted user IDs. Any user ID with exposure - * prior to the conversion timestamp will be used in the inserted - * conversion. If no such user ID is found then the conversion will be - * rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo - * should also be specified. This field may only be used when calling - * batchinsert; it is not supported by batchupdate. This field is mutually - * exclusive with encryptedUserId, mobileDeviceId and gclid. This or - * encryptedUserId or mobileDeviceId or gclid is a required field. + * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. */ encryptedUserIdCandidates?: string[]; /** @@ -1757,28 +1497,19 @@ export namespace dfareporting_v3_3 { */ floodlightConfigurationId?: string; /** - * The Google click ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or - * encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a - * required field. + * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. */ gclid?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversion". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". */ kind?: string; /** - * Whether Limit Ad Tracking is enabled. When set to true, the conversion - * will be used for reporting but not targeting. This will prevent - * remarketing. + * Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. */ limitAdTracking?: boolean; /** - * The mobile device ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and gclid. This or - * encryptedUserId or encryptedUserIdCandidates[] or gclid is a required - * field. + * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. */ mobileDeviceId?: string; /** @@ -1786,8 +1517,7 @@ export namespace dfareporting_v3_3 { */ nonPersonalizedAd?: boolean; /** - * The ordinal of the conversion. Use this field to control how conversions - * of the same user and day are de-duplicated. This is a required field. + * The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. */ ordinal?: string; /** @@ -1795,14 +1525,11 @@ export namespace dfareporting_v3_3 { */ quantity?: string; /** - * The timestamp of conversion, in Unix epoch micros. This is a required - * field. + * The timestamp of conversion, in Unix epoch micros. This is a required field. */ timestampMicros?: string; /** - * Whether this particular request may come from a user under the age of 16 - * (may differ by country), under compliance with the European Union's - * General Data Protection Regulation (GDPR). + * Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). */ treatmentForUnderage?: boolean; /** @@ -1811,8 +1538,7 @@ export namespace dfareporting_v3_3 { value?: number; } /** - * The error code and description for a conversion that failed to insert or - * update. + * The error code and description for a conversion that failed to insert or update. */ export interface Schema$ConversionError { /** @@ -1820,8 +1546,7 @@ export namespace dfareporting_v3_3 { */ code?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionError". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". */ kind?: string; /** @@ -1838,14 +1563,11 @@ export namespace dfareporting_v3_3 { */ conversions?: Schema$Conversion[]; /** - * Describes how encryptedUserId or encryptedUserIdCandidates[] is - * encrypted. This is a required field if encryptedUserId or - * encryptedUserIdCandidates[] is used. + * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. */ encryptionInfo?: Schema$EncryptionInfo; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertRequest". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". */ kind?: string; } @@ -1858,13 +1580,11 @@ export namespace dfareporting_v3_3 { */ hasFailures?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". */ kind?: string; /** - * The insert status of each conversion. Statuses are returned in the same - * order that conversions are inserted. + * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. */ status?: Schema$ConversionStatus[]; } @@ -1877,13 +1597,11 @@ export namespace dfareporting_v3_3 { */ conversions?: Schema$Conversion[]; /** - * Describes how encryptedUserId is encrypted. This is a required field if - * encryptedUserId is used. + * Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. */ encryptionInfo?: Schema$EncryptionInfo; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateRequest". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". */ kind?: string; } @@ -1896,19 +1614,16 @@ export namespace dfareporting_v3_3 { */ hasFailures?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". */ kind?: string; /** - * The update status of each conversion. Statuses are returned in the same - * order that conversions are updated. + * The update status of each conversion. Statuses are returned in the same order that conversions are updated. */ status?: Schema$ConversionStatus[]; } /** - * The original conversion that was inserted or updated and whether there were - * any errors. + * The original conversion that was inserted or updated and whether there were any errors. */ export interface Schema$ConversionStatus { /** @@ -1920,8 +1635,7 @@ export namespace dfareporting_v3_3 { */ errors?: Schema$ConversionError[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionStatus". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". */ kind?: string; } @@ -1934,8 +1648,7 @@ export namespace dfareporting_v3_3 { */ countries?: Schema$Country[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#countriesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". */ kind?: string; } @@ -1948,13 +1661,11 @@ export namespace dfareporting_v3_3 { */ countryCode?: string; /** - * DART ID of this country. This is the ID used for targeting and generating - * reports. + * DART ID of this country. This is the ID used for targeting and generating reports. */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#country". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". */ kind?: string; /** @@ -1971,9 +1682,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Creative { /** - * Account ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. + * Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. */ accountId?: string; /** @@ -1981,34 +1690,23 @@ export namespace dfareporting_v3_3 { */ active?: boolean; /** - * Additional sizes associated with a responsive creative. When inserting or - * updating a creative either the size ID field or size width and height - * fields can be used. Applicable to DISPLAY creatives when the primary - * asset type is HTML_IMAGE. + * Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. */ additionalSizes?: Schema$Size[]; /** - * Ad parameters user for VPAID creative. This is a read-only field. - * Applicable to the following creative types: all VPAID. + * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. */ adParameters?: string; /** - * Keywords for a Rich Media creative. Keywords let you customize the - * creative settings of a Rich Media ad running on your site without having - * to contact the advertiser. You can use keywords to dynamically change the - * look or functionality of a creative. Applicable to the following creative - * types: all RICH_MEDIA, and all VPAID. + * Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ adTagKeys?: string[]; /** - * Advertiser ID of this creative. This is a required field. Applicable to - * all creative types. + * Advertiser ID of this creative. This is a required field. Applicable to all creative types. */ advertiserId?: string; /** - * Whether script access is allowed for this creative. This is a read-only - * and deprecated field which will automatically be set to true on update. - * Applicable to the following creative types: FLASH_INPAGE. + * Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. */ allowScriptAccess?: boolean; /** @@ -2016,125 +1714,67 @@ export namespace dfareporting_v3_3 { */ archived?: boolean; /** - * Type of artwork used for the creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. + * Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ artworkType?: string; /** - * Source application where creative was authored. Presently, only DBM - * authored creatives will have this field set. Applicable to all creative - * types. + * Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. */ authoringSource?: string; /** - * Authoring tool for HTML5 banner creatives. This is a read-only field. - * Applicable to the following creative types: HTML5_BANNER. + * Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ authoringTool?: string; /** - * Whether images are automatically advanced for image gallery creatives. - * Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. */ autoAdvanceImages?: boolean; /** - * The 6-character HTML color code, beginning with #, for the background of - * the window area where the Flash file is displayed. Default is white. - * Applicable to the following creative types: FLASH_INPAGE. + * The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. */ backgroundColor?: string; /** - * Click-through URL for backup image. Applicable to ENHANCED_BANNER when - * the primary asset type is not HTML_IMAGE. + * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. */ backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * List of feature dependencies that will cause a backup image to be served - * if the browser that serves the ad does not support them. Feature - * dependencies are features that a browser must be able to support in order - * to render your HTML5 creative asset correctly. This field is initially - * auto-generated to contain all features detected by Campaign Manager for - * all the assets of this creative and can then be modified by the client. - * To reset this field, copy over all the creativeAssets' detected - * features. Applicable to the following creative types: HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageFeatures?: string[]; /** - * Reporting label used for HTML5 banner backup image. Applicable to the - * following creative types: DISPLAY when the primary asset type is not - * HTML_IMAGE. + * Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageReportingLabel?: string; /** - * Target window for backup image. Applicable to the following creative - * types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. + * Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ backupImageTargetWindow?: Schema$TargetWindow; /** - * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER - * creatives, this is a subset of detected click tags for the assets - * associated with this creative. After creating a flash asset, detected - * click tags will be returned in the creativeAssetMetadata. When inserting - * the creative, populate the creative clickTags field using the - * creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY - * creatives, there should be exactly one entry in this list for each image - * creative asset. A click tag is matched with a corresponding creative - * asset by matching the clickTag.name field with the - * creativeAsset.assetIdentifier.name field. Applicable to the following - * creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ clickTags?: Schema$ClickTag[]; /** - * Industry standard ID assigned to creative for reach and frequency. - * Applicable to INSTREAM_VIDEO_REDIRECT creatives. + * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. */ commercialId?: string; /** - * List of companion creatives assigned to an in-Stream video creative. - * Acceptable values include IDs of existing flash and image creatives. - * Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO - * and all INSTREAM_VIDEO with dynamicAssetSelection set to false. + * List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. */ companionCreatives?: string[]; /** - * Compatibilities associated with this creative. This is a read-only field. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. - * Only pre-existing creatives may have these compatibilities since new - * creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL - * instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads - * developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in - * in-stream audio ads developed with the VAST standard. Applicable to all - * creative types. Acceptable values are: - "APP" - - * "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - - * "IN_STREAM_AUDIO" - "DISPLAY" - - * "DISPLAY_INTERSTITIAL" + * Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" */ compatibility?: string[]; /** - * Whether Flash assets associated with the creative need to be - * automatically converted to HTML5. This flag is enabled by default and - * users can choose to disable it if they don't want the system to - * generate and use HTML5 asset for this creative. Applicable to the - * following creative type: FLASH_INPAGE. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. + * Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ convertFlashToHtml5?: boolean; /** - * List of counter events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. + * List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. */ counterCustomEvents?: Schema$CreativeCustomEvent[]; /** - * Assets associated with a creative. Applicable to all but the following - * creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and - * REDIRECT + * Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT */ creativeAssets?: Schema$CreativeAsset[]; /** @@ -2142,246 +1782,159 @@ export namespace dfareporting_v3_3 { */ creativeAssetSelection?: Schema$CreativeAssetSelection; /** - * Creative field assignments for this creative. Applicable to all creative - * types. + * Creative field assignments for this creative. Applicable to all creative types. */ creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; /** - * Custom key-values for a Rich Media creative. Key-values let you customize - * the creative settings of a Rich Media ad running on your site without - * having to contact the advertiser. You can use key-values to dynamically - * change the look or functionality of a creative. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. + * Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ customKeyValues?: string[]; /** - * Set this to true to enable the use of rules to target individual assets - * in this creative. When set to true creativeAssetSelection must be set. - * This also controls asset-level companions. When this is true, companion - * creatives should be assigned to creative assets. Learn more. Applicable - * to INSTREAM_VIDEO creatives. + * Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. */ dynamicAssetSelection?: boolean; /** - * List of exit events configured for the creative. For DISPLAY and - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags, For DISPLAY, an event is also created from the - * backupImageReportingLabel. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. + * List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ exitCustomEvents?: Schema$CreativeCustomEvent[]; /** - * OpenWindow FSCommand of this creative. This lets the SWF file communicate - * with either Flash Player or the program hosting Flash Player, such as a - * web browser. This is only triggered if allowScriptAccess field is true. - * Applicable to the following creative types: FLASH_INPAGE. + * OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE. */ fsCommand?: Schema$FsCommand; /** - * HTML code for the creative. This is a required field when applicable. - * This field is ignored if htmlCodeLocked is true. Applicable to the - * following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and - * all RICH_MEDIA. + * HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. */ htmlCode?: string; /** - * Whether HTML code is generated by Campaign Manager or manually entered. - * Set to true to ignore changes to htmlCode. Applicable to the following - * creative types: FLASH_INPAGE and HTML5_BANNER. + * Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. */ htmlCodeLocked?: boolean; /** - * ID of this creative. This is a read-only, auto-generated field. - * Applicable to all creative types. + * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. */ id?: string; /** - * Dimension value for the ID of this creative. This is a read-only field. - * Applicable to all creative types. + * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creative". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". */ kind?: string; /** - * Creative last modification information. This is a read-only field. - * Applicable to all creative types. + * Creative last modification information. This is a read-only field. Applicable to all creative types. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Latest Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. + * Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ latestTraffickedCreativeId?: string; /** - * Description of the audio or video ad. Applicable to the following - * creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. + * Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. */ mediaDescription?: string; /** - * Creative audio or video duration in seconds. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO, - * INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. + * Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. */ mediaDuration?: number; /** - * Name of the creative. This is a required field and must be less than 256 - * characters long. Applicable to all creative types. + * Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. */ name?: string; /** - * Override CSS value for rich media creatives. Applicable to the following - * creative types: all RICH_MEDIA. + * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. */ overrideCss?: string; /** - * Amount of time to play the video before counting a view. Applicable to - * the following creative types: all INSTREAM_VIDEO. + * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. */ progressOffset?: Schema$VideoOffset; /** - * URL of hosted image or hosted video or another ad tag. For - * INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect - * URL. The standard for a VAST (Video Ad Serving Template) ad response - * allows for a redirect link to another VAST 2.0 or 3.0 call. This is a - * required field when applicable. Applicable to the following creative - * types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, - * INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + * URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT */ redirectUrl?: string; /** - * ID of current rendering version. This is a read-only field. Applicable to - * all creative types. + * ID of current rendering version. This is a read-only field. Applicable to all creative types. */ renderingId?: string; /** - * Dimension value for the rendering ID of this creative. This is a - * read-only field. Applicable to all creative types. + * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. */ renderingIdDimensionValue?: Schema$DimensionValue; /** - * The minimum required Flash plugin version for this creative. For - * example, 11.2.202.235. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. + * The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ requiredFlashPluginVersion?: string; /** - * The internal Flash version for this creative as calculated by Studio. - * This is a read-only field. Applicable to the following creative types: - * FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when - * the primary asset type is not HTML_IMAGE. + * The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ requiredFlashVersion?: number; /** - * Size associated with this creative. When inserting or updating a creative - * either the size ID field or size width and height fields can be used. - * This is a required field when applicable; however for IMAGE, FLASH_INPAGE - * creatives, and for DISPLAY creatives with a primary asset of type - * HTML_IMAGE, if left blank, this field will be automatically set using the - * actual size of the associated image assets. Applicable to the following - * creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, - * HTML5_BANNER, IMAGE, and all RICH_MEDIA. + * Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. */ size?: Schema$Size; /** - * Amount of time to play the video before the skip button appears. - * Applicable to the following creative types: all INSTREAM_VIDEO. + * Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO. */ skipOffset?: Schema$VideoOffset; /** - * Whether the user can choose to skip the creative. Applicable to the - * following creative types: all INSTREAM_VIDEO and all VPAID. + * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. */ skippable?: boolean; /** - * Whether the creative is SSL-compliant. This is a read-only field. - * Applicable to all creative types. + * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. */ sslCompliant?: boolean; /** - * Whether creative should be treated as SSL compliant even if the system - * scan shows it's not. Applicable to all creative types. + * Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. */ sslOverride?: boolean; /** - * Studio advertiser ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. + * Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioAdvertiserId?: string; /** - * Studio creative ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. + * Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioCreativeId?: string; /** - * Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. + * Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ studioTraffickedCreativeId?: string; /** - * Subaccount ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. + * Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. */ subaccountId?: string; /** - * Third-party URL used to record backup image impressions. Applicable to - * the following creative types: all RICH_MEDIA. + * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. */ thirdPartyBackupImageImpressionsUrl?: string; /** - * Third-party URL used to record rich media impressions. Applicable to the - * following creative types: all RICH_MEDIA. + * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. */ thirdPartyRichMediaImpressionsUrl?: string; /** - * Third-party URLs for tracking in-stream creative events. Applicable to - * the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and - * all VPAID. + * Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. */ thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; /** - * List of timer events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset is not HTML_IMAGE. + * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. */ timerCustomEvents?: Schema$CreativeCustomEvent[]; /** - * Combined size of all creative assets. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. + * Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ totalFileSize?: string; /** - * Type of this creative. This is a required field. Applicable to all - * creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only - * used for existing creatives. New creatives should use DISPLAY as a - * replacement for these types. + * Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. */ type?: string; /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. */ universalAdId?: Schema$UniversalAdId; /** - * The version number helps you keep track of multiple versions of your - * creative in your reports. The version number will always be - * auto-generated during insert operations to start at 1. For tracking - * creatives the version cannot be incremented and will always remain at 1. - * For all other creative types the version can be incremented only by 1 - * during update operations. In addition, the version will be automatically - * incremented by 1 when undergoing Rich Media creative merging. Applicable - * to all creative types. + * The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. */ version?: number; } @@ -2390,179 +1943,123 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeAsset { /** - * Whether ActionScript3 is enabled for the flash asset. This is a read-only - * field. Applicable to the following creative type: FLASH_INPAGE. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ actionScript3?: boolean; /** - * Whether the video or audio asset is active. This is a read-only field for - * VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative - * types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + * Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ active?: boolean; /** - * Additional sizes associated with this creative asset. HTML5 asset - * generated by compatible software such as GWD will be able to support more - * sizes this creative asset can render. + * Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. */ additionalSizes?: Schema$Size[]; /** - * Possible alignments for an asset. This is a read-only field. Applicable - * to the following creative types: - * RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. + * Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. */ alignment?: string; /** - * Artwork type of rich media creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ artworkType?: string; /** - * Identifier of this asset. This is the same identifier returned during - * creative asset insert operation. This is a required field. Applicable to - * all but the following creative types: all REDIRECT and TRACKING_TEXT. + * Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ assetIdentifier?: Schema$CreativeAssetId; /** - * Audio stream bit rate in kbps. This is a read-only field. Applicable to - * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all - * VPAID. + * Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ audioBitRate?: number; /** - * Audio sample bit rate in hertz. This is a read-only field. Applicable to - * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all - * VPAID. + * Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ audioSampleRate?: number; /** - * Exit event configured for the backup image. Applicable to the following - * creative types: all RICH_MEDIA. + * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. */ backupImageExit?: Schema$CreativeCustomEvent; /** - * Detected bit-rate for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ bitRate?: number; /** - * Rich media child asset type. This is a read-only field. Applicable to the - * following creative types: all VPAID. + * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. */ childAssetType?: string; /** - * Size of an asset when collapsed. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID. Additionally, - * applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or - * ASSET_DISPLAY_TYPE_PEEL_DOWN. + * Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. */ collapsedSize?: Schema$Size; /** - * List of companion creatives assigned to an in-stream video creative - * asset. Acceptable values include IDs of existing flash and image - * creatives. Applicable to INSTREAM_VIDEO creative type with - * dynamicAssetSelection set to true. + * List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. */ companionCreativeIds?: string[]; /** - * Custom start time in seconds for making the asset visible. Applicable to - * the following creative types: all RICH_MEDIA. Value must be greater than - * or equal to 0. + * Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. */ customStartTimeValue?: number; /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. Applicable to the following - * creative types: HTML5_BANNER. Applicable to DISPLAY when the primary - * asset type is not HTML_IMAGE. + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ detectedFeatures?: string[]; /** - * Type of rich media asset. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA. + * Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ displayType?: string; /** - * Duration in seconds for which an asset will be displayed. Applicable to - * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and - * VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. + * Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. */ duration?: number; /** - * Duration type for which an asset will be displayed. Applicable to the - * following creative types: all RICH_MEDIA. + * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. */ durationType?: string; /** - * Detected expanded dimension for video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + * Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ expandedDimension?: Schema$Size; /** - * File size associated with this creative asset. This is a read-only field. - * Applicable to all but the following creative types: all REDIRECT and - * TRACKING_TEXT. + * File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ fileSize?: string; /** - * Flash version of the asset. This is a read-only field. Applicable to the - * following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ flashVersion?: number; /** - * Video frame rate for video asset in frames per second. This is a - * read-only field. Applicable to the following creative types: - * INSTREAM_VIDEO and all VPAID. + * Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ frameRate?: number; /** - * Whether to hide Flash objects flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. + * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ hideFlashObjects?: boolean; /** - * Whether to hide selection boxes flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. + * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. */ hideSelectionBoxes?: boolean; /** - * Whether the asset is horizontally locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ horizontallyLocked?: boolean; /** - * Numeric ID of this creative asset. This is a required field and should - * not be modified. Applicable to all but the following creative types: all - * REDIRECT and TRACKING_TEXT. + * Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ id?: string; /** - * Dimension value for the ID of the asset. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the asset. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Detected duration for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ mediaDuration?: number; /** - * Detected MIME type for audio or video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_AUDIO, - * INSTREAM_VIDEO and all VPAID. + * Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. */ mimeType?: string; /** - * Offset position for an asset in collapsed mode. This is a read-only - * field. Applicable to the following creative types: all RICH_MEDIA and all - * VPAID. Additionally, only applicable to assets whose displayType is - * ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + * Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. */ offset?: Schema$OffsetPosition; /** @@ -2570,8 +2067,7 @@ export namespace dfareporting_v3_3 { */ orientation?: string; /** - * Whether the backup asset is original or changed by the user in Campaign - * Manager. Applicable to the following creative types: all RICH_MEDIA. + * Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. */ originalBackup?: boolean; /** @@ -2579,128 +2075,71 @@ export namespace dfareporting_v3_3 { */ politeLoad?: boolean; /** - * Offset position for an asset. Applicable to the following creative types: - * all RICH_MEDIA. + * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. */ position?: Schema$OffsetPosition; /** - * Offset left unit for an asset. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA. + * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ positionLeftUnit?: string; /** - * Offset top unit for an asset. This is a read-only field if the asset - * displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following - * creative types: all RICH_MEDIA. + * Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. */ positionTopUnit?: string; /** - * Progressive URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. + * Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ progressiveServingUrl?: string; /** - * Whether the asset pushes down other content. Applicable to the following - * creative types: all RICH_MEDIA. Additionally, only applicable when the - * asset offsets are 0, the collapsedSize.width matches size.width, and the - * collapsedSize.height is less than size.height. + * Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. */ pushdown?: boolean; /** - * Pushdown duration in seconds for an asset. Applicable to the following - * creative types: all RICH_MEDIA.Additionally, only applicable when the - * asset pushdown field is true, the offsets are 0, the collapsedSize.width - * matches size.width, and the collapsedSize.height is less than - * size.height. Acceptable values are 0 to 9.99, inclusive. + * Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. */ pushdownDuration?: number; /** - * Role of the asset in relation to creative. Applicable to all but the - * following creative types: all REDIRECT and TRACKING_TEXT. This is a - * required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, - * IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple - * primary assets), and all VPAID creatives. BACKUP_IMAGE applies to - * FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - * ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. - * OTHER refers to assets from sources other than Campaign Manager, such as - * Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID - * creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign - * Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO - * creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign - * Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and - * VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign - * Manager representation of child asset videos from Studio, and is - * applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or - * removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, - * PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked - * active serve as backup in case the VPAID creative cannot be served. Only - * PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or - * VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by - * the user in Campaign Manager and is applicable to INSTREAM_AUDIO - * creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign - * Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO - * creatives. + * Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. */ role?: string; /** - * Size associated with this creative asset. This is a required field when - * applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, - * this field will be automatically set using the actual size of the - * associated image asset. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all - * RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not - * HTML_IMAGE. + * Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ size?: Schema$Size; /** - * Whether the asset is SSL-compliant. This is a read-only field. Applicable - * to all but the following creative types: all REDIRECT and TRACKING_TEXT. + * Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ sslCompliant?: boolean; /** - * Initial wait time type before making the asset visible. Applicable to the - * following creative types: all RICH_MEDIA. + * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. */ startTimeType?: string; /** - * Streaming URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. + * Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ streamingServingUrl?: string; /** - * Whether the asset is transparent. Applicable to the following creative - * types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + * Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. */ transparency?: boolean; /** - * Whether the asset is vertically locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. + * Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. */ verticallyLocked?: boolean; /** - * Window mode options for flash assets. Applicable to the following - * creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, - * RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and - * RICH_MEDIA_INPAGE_FLOATING. + * Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. */ windowMode?: string; /** - * zIndex value of an asset. Applicable to the following creative types: all - * RICH_MEDIA.Additionally, only applicable to assets whose displayType is - * NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or - * ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to - * 999999999, inclusive. + * zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. */ zIndex?: number; /** - * File name of zip file. This is a read-only field. Applicable to the - * following creative types: HTML5_BANNER. + * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ zipFilename?: string; /** - * Size of zip file. This is a read-only field. Applicable to the following - * creative types: HTML5_BANNER. + * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. */ zipFilesize?: string; } @@ -2709,22 +2148,16 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeAssetId { /** - * Name of the creative asset. This is a required field while inserting an - * asset. After insertion, this assetIdentifier is used to identify the - * uploaded asset. Characters in the name must be alphanumeric or one of the - * following: ".-_ ". Spaces are allowed. + * Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. */ name?: string; /** - * Type of asset to upload. This is a required field. FLASH and IMAGE are no - * longer supported for new uploads. All image assets should use HTML_IMAGE. + * Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. */ type?: string; } /** - * CreativeAssets contains properties of a creative asset file which will be - * uploaded or has already been uploaded. Refer to the creative sample code - * for how to upload assets and insert a creative. + * CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative. */ export interface Schema$CreativeAssetMetadata { /** @@ -2732,15 +2165,11 @@ export namespace dfareporting_v3_3 { */ assetIdentifier?: Schema$CreativeAssetId; /** - * List of detected click tags for assets. This is a read-only - * auto-generated field. + * List of detected click tags for assets. This is a read-only auto-generated field. */ clickTags?: Schema$ClickTag[]; /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. */ detectedFeatures?: string[]; /** @@ -2748,50 +2177,28 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the numeric ID of the asset. This is a read-only, - * auto-generated field. + * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeAssetMetadata". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". */ kind?: string; /** - * Rules validated during code generation that generated a warning. This is - * a read-only, auto-generated field. Possible values are: - - * "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - - * "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - - * "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - - * "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - - * "CLICK_TAG_NON_TOP_LEVEL" - - * "COMPONENT_UNSUPPORTED_DCM" - - * "ENABLER_UNSUPPORTED_METHOD_DCM" - - * "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - - * "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - - * "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - * - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - - * "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - - * "PRIMARY_HTML_MISSING" - "SVG_INVALID" - - * "ZIP_INVALID" + * Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID" */ warnedValidationRules?: string[]; } /** - * Encapsulates the list of rules for asset selection and a default asset in - * case none of the rules match. Applicable to INSTREAM_VIDEO creatives. + * Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$CreativeAssetSelection { /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative, and will be served if none of the rules match. This is a - * required field. + * A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field. */ defaultAssetId?: string; /** - * Rules determine which asset will be served to a viewer. Rules will be - * evaluated in the order in which they are stored in this list. This list - * must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. + * Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. */ rules?: Schema$Rule[]; } @@ -2800,15 +2207,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeAssignment { /** - * Whether this creative assignment is active. When true, the creative will - * be included in the ad's rotation. + * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. */ active?: boolean; /** - * Whether applicable event tags should fire when this creative assignment - * is rendered. If this value is unset when the ad is inserted or updated, - * it will default to true for all creative types EXCEPT for - * INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + * Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. */ applyEventTags?: boolean; /** @@ -2816,14 +2219,11 @@ export namespace dfareporting_v3_3 { */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Companion creative overrides for this creative assignment. Applicable to - * video ads. + * Companion creative overrides for this creative assignment. Applicable to video ads. */ companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; /** - * Creative group assignments for this creative assignment. Only one - * assignment per creative group number is allowed for a maximum of two - * assignments. + * Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. */ creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; /** @@ -2831,33 +2231,23 @@ export namespace dfareporting_v3_3 { */ creativeId?: string; /** - * Dimension value for the ID of the creative. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the creative. This is a read-only, auto-generated field. */ creativeIdDimensionValue?: Schema$DimensionValue; /** - * Date and time that the assigned creative should stop serving. Must be - * later than the start time. + * Date and time that the assigned creative should stop serving. Must be later than the start time. */ endTime?: string; /** - * Rich media exit overrides for this creative assignment. Applicable when - * the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - * - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - - * RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - - * RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - - * RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR + * Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR */ richMediaExitOverrides?: Schema$RichMediaExitOverride[]; /** - * Sequence number of the creative assignment, applicable when the rotation - * type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to - * 65535, inclusive. + * Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. */ sequence?: number; /** - * Whether the creative to be assigned is SSL-compliant. This is a read-only - * field that is auto-generated when the ad is inserted or updated. + * Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslCompliant?: boolean; /** @@ -2865,8 +2255,7 @@ export namespace dfareporting_v3_3 { */ startTime?: string; /** - * Weight of the creative assignment, applicable when the rotation type is - * CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. + * Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. */ weight?: number; } @@ -2875,16 +2264,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeClickThroughUrl { /** - * Read-only convenience field representing the actual URL that will be used - * for this click-through. The URL is computed as follows: - If - * landingPageId is specified then that landing page's URL is assigned - * to this field. - Otherwise, the customClickThroughUrl is assigned to this - * field. + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. */ computedClickThroughUrl?: string; /** - * Custom click-through URL. Applicable if the landingPageId field is left - * unset. + * Custom click-through URL. Applicable if the landingPageId field is left unset. */ customClickThroughUrl?: string; /** @@ -2897,8 +2281,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeCustomEvent { /** - * Unique ID of this event used by Reporting and Data Transfer. This is a - * read-only field. + * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. */ advertiserCustomEventId?: string; /** @@ -2910,9 +2293,7 @@ export namespace dfareporting_v3_3 { */ advertiserCustomEventType?: string; /** - * Artwork label column, used to link events in Campaign Manager back to - * events in Studio. This is a required field and should not be modified - * after insertion. + * Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. */ artworkLabel?: string; /** @@ -2920,18 +2301,15 @@ export namespace dfareporting_v3_3 { */ artworkType?: string; /** - * Exit click-through URL for the event. This field is used only for exit - * events. + * Exit click-through URL for the event. This field is used only for exit events. */ exitClickThroughUrl?: Schema$CreativeClickThroughUrl; /** - * ID of this event. This is a required field and should not be modified - * after insertion. + * ID of this event. This is a required field and should not be modified after insertion. */ id?: string; /** - * Properties for rich media popup windows. This field is used only for exit - * events. + * Properties for rich media popup windows. This field is used only for exit events. */ popupWindowProperties?: Schema$PopupWindowProperties; /** @@ -2939,8 +2317,7 @@ export namespace dfareporting_v3_3 { */ targetType?: string; /** - * Video reporting ID, used to differentiate multiple videos in a single - * creative. This is a read-only field. + * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. */ videoReportingId?: string; } @@ -2949,18 +2326,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeField { /** - * Account ID of this creative field. This is a read-only field that can be - * left blank. + * Account ID of this creative field. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this creative field. This is a required field on - * insertion. + * Advertiser ID of this creative field. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -2968,19 +2342,15 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeField". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". */ kind?: string; /** - * Name of this creative field. This is a required field and must be less - * than 256 characters long and unique among creative fields of the same - * advertiser. + * Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. */ name?: string; /** - * Subaccount ID of this creative field. This is a read-only field that can - * be left blank. + * Subaccount ID of this creative field. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -3006,8 +2376,7 @@ export namespace dfareporting_v3_3 { */ creativeFields?: Schema$CreativeField[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". */ kind?: string; /** @@ -3020,18 +2389,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeFieldValue { /** - * ID of this creative field value. This is a read-only, auto-generated - * field. + * ID of this creative field value. This is a read-only, auto-generated field. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValue". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". */ kind?: string; /** - * Value of this creative field value. It needs to be less than 256 - * characters in length and unique per creative field. + * Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. */ value?: string; } @@ -3044,8 +2410,7 @@ export namespace dfareporting_v3_3 { */ creativeFieldValues?: Schema$CreativeFieldValue[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValuesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". */ kind?: string; /** @@ -3058,25 +2423,19 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeGroup { /** - * Account ID of this creative group. This is a read-only field that can be - * left blank. + * Account ID of this creative group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this creative group. This is a required field on - * insertion. + * Advertiser ID of this creative group. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Subgroup of the creative group. Assign your creative groups to a subgroup - * in order to filter or manage them more easily. This field is required on - * insertion and is read-only after insertion. Acceptable values are 1 to 2, - * inclusive. + * Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. */ groupNumber?: number; /** @@ -3084,19 +2443,15 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". */ kind?: string; /** - * Name of this creative group. This is a required field and must be less - * than 256 characters long and unique among creative groups of the same - * advertiser. + * Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. */ name?: string; /** - * Subaccount ID of this creative group. This is a read-only field that can - * be left blank. + * Subaccount ID of this creative group. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -3122,8 +2477,7 @@ export namespace dfareporting_v3_3 { */ creativeGroups?: Schema$CreativeGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". */ kind?: string; /** @@ -3136,14 +2490,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CreativeOptimizationConfiguration { /** - * ID of this creative optimization config. This field is auto-generated - * when the campaign is inserted or updated. It can be null for existing - * campaigns. + * ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. */ id?: string; /** - * Name of this creative optimization config. This is a required field and - * must be less than 129 characters long. + * Name of this creative optimization config. This is a required field and must be less than 129 characters long. */ name?: string; /** @@ -3164,20 +2515,15 @@ export namespace dfareporting_v3_3 { */ creativeAssignments?: Schema$CreativeAssignment[]; /** - * Creative optimization configuration that is used by this ad. It should - * refer to one of the existing optimization configurations in the ad's - * campaign. If it is unset or set to 0, then the campaign's default - * optimization configuration will be used for this ad. + * Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad. */ creativeOptimizationConfigurationId?: string; /** - * Type of creative rotation. Can be used to specify whether to use - * sequential or random rotation. + * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. */ type?: string; /** - * Strategy for calculating weights. Used with - * CREATIVE_ROTATION_TYPE_RANDOM. + * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */ weightCalculationStrategy?: string; } @@ -3190,8 +2536,7 @@ export namespace dfareporting_v3_3 { */ creatives?: Schema$Creative[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". */ kind?: string; /** @@ -3200,33 +2545,27 @@ export namespace dfareporting_v3_3 { nextPageToken?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". + * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ export interface Schema$CrossDimensionReachReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "breakdown" section of the report. + * Dimensions which are compatible to be selected in the "breakdown" section of the report. */ breakdown?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#crossDimensionReachReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected in the - * "overlapMetricNames" section of the report. + * Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. */ overlapMetrics?: Schema$Metric[]; } @@ -3235,18 +2574,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CustomFloodlightVariable { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#customFloodlightVariable". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". */ kind?: string; /** - * The type of custom floodlight variable to supply a value for. These map - * to the "u[1-20]=" in the tags. + * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. */ type?: string; /** - * The value of the custom floodlight variable. The length of string must - * not exceed 50 characters. + * The value of the custom floodlight variable. The length of string must not exceed 50 characters. */ value?: string; } @@ -3255,13 +2591,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$CustomRichMediaEvents { /** - * List of custom rich media event IDs. Dimension values must be all of type - * dfa:richMediaEventTypeIdAndName. + * List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. */ filteredEventIds?: Schema$DimensionValue[]; /** - * The kind of resource this is, in this case - * dfareporting#customRichMediaEvents. + * The kind of resource this is, in this case dfareporting#customRichMediaEvents. */ kind?: string; } @@ -3283,8 +2617,7 @@ export namespace dfareporting_v3_3 { name?: string; } /** - * The attributes, like playtime and percent onscreen, that define the Custom - * Viewability Metric. + * The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. */ export interface Schema$CustomViewabilityMetricConfiguration { /** @@ -3292,20 +2625,15 @@ export namespace dfareporting_v3_3 { */ audible?: boolean; /** - * The time in milliseconds the video must play for the Custom Viewability - * Metric to count an impression. If both this and timePercent are - * specified, the earlier of the two will be used. + * The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used. */ timeMillis?: number; /** - * The percentage of video that must play for the Custom Viewability Metric - * to count an impression. If both this and timeMillis are specified, the - * earlier of the two will be used. + * The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used. */ timePercent?: number; /** - * The percentage of video that must be on screen for the Custom Viewability - * Metric to count an impression. + * The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. */ viewabilityPercent?: number; } @@ -3314,8 +2642,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$DateRange { /** - * The end date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". + * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ endDate?: string; /** @@ -3327,8 +2654,7 @@ export namespace dfareporting_v3_3 { */ relativeDateRange?: string; /** - * The start date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". + * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". */ startDate?: string; } @@ -3337,25 +2663,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$DayPartTargeting { /** - * Days of the week when the ad will serve. Acceptable values are: - - * "SUNDAY" - "MONDAY" - "TUESDAY" - - * "WEDNESDAY" - "THURSDAY" - "FRIDAY" - - * "SATURDAY" + * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" */ daysOfWeek?: string[]; /** - * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and - * 23 is 11 PM to midnight. Can be specified with days of week, in which - * case the ad would serve during these hours on the specified days. For - * example if Monday, Wednesday, Friday are the days of week specified and - * 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve - * Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values - * are 0 to 23, inclusive. + * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. */ hoursOfDay?: number[]; /** - * Whether or not to use the user's local time. If false, the - * America/New York time zone applies. + * Whether or not to use the user's local time. If false, the America/New York time zone applies. */ userLocalTime?: boolean; } @@ -3368,13 +2684,11 @@ export namespace dfareporting_v3_3 { */ appUrl?: string; /** - * The fallback URL. This URL will be served to users who do not have the - * mobile app installed. + * The fallback URL. This URL will be served to users who do not have the mobile app installed. */ fallbackUrl?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#deepLink". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". */ kind?: string; /** @@ -3382,25 +2696,20 @@ export namespace dfareporting_v3_3 { */ mobileApp?: Schema$MobileApp; /** - * Ads served to users on these remarketing lists will use this deep link. - * Applicable when mobileApp.directory is APPLE_APP_STORE. + * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. */ remarketingListIds?: string[]; } /** - * Properties of inheriting and overriding the default click-through event - * tag. A campaign may override the event tag defined at the advertiser level, - * and an ad may also override the campaign's setting further. + * Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. */ export interface Schema$DefaultClickThroughEventTagProperties { /** - * ID of the click-through event tag to apply to all ads in this - * entity's scope. + * ID of the click-through event tag to apply to all ads in this entity's scope. */ defaultClickThroughEventTagId?: string; /** - * Whether this entity should override the inherited default click-through - * event tag with its own defined value. + * Whether this entity should override the inherited default click-through event tag with its own defined value. */ overrideInheritedEventTag?: boolean; } @@ -3409,27 +2718,19 @@ export namespace dfareporting_v3_3 { */ export interface Schema$DeliverySchedule { /** - * Limit on the number of times an individual user can be served the ad - * within a specified period of time. + * Limit on the number of times an individual user can be served the ad within a specified period of time. */ frequencyCap?: Schema$FrequencyCap; /** - * Whether or not hard cutoff is enabled. If true, the ad will not serve - * after the end date and time. Otherwise the ad will continue to be served - * until it has reached its delivery goals. + * Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals. */ hardCutoff?: boolean; /** - * Impression ratio for this ad. This ratio determines how often each ad is - * served relative to the others. For example, if ad A has an impression - * ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager - * will serve ad B three times as often as ad A. Acceptable values are 1 to - * 10, inclusive. + * Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive. */ impressionRatio?: string; /** - * Serving priority of an ad, with respect to other ads. The lower the - * priority number, the greater the priority with which it is served. + * Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served. */ priority?: string; } @@ -3509,12 +2810,7 @@ export namespace dfareporting_v3_3 { */ kind?: string; /** - * Determines how the 'value' field is matched when filtering. If - * not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, - * '*' is allowed as a placeholder for variable length character - * sequences, and it can be escaped with a backslash. Note, only paid search - * dimensions ('dfa:paidSearch*') allow a matchType other than - * EXACT. + * Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. */ matchType?: string; /** @@ -3539,10 +2835,7 @@ export namespace dfareporting_v3_3 { */ kind?: string; /** - * Continuation token used to page through dimension values. To retrieve the - * next page of results, set the next request's "pageToken" to - * the value of this field. The page token is only valid for a limited - * amount of time and should not be persisted. + * Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -3555,8 +2848,7 @@ export namespace dfareporting_v3_3 { */ dimensionName?: string; /** - * The end date of the date range for which to retrieve dimension values. A - * string of the format "yyyy-MM-dd". + * The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". */ endDate?: string; /** @@ -3564,20 +2856,16 @@ export namespace dfareporting_v3_3 { */ filters?: Schema$DimensionFilter[]; /** - * The kind of request this is, in this case - * dfareporting#dimensionValueRequest. + * The kind of request this is, in this case dfareporting#dimensionValueRequest. */ kind?: string; /** - * The start date of the date range for which to retrieve dimension values. - * A string of the format "yyyy-MM-dd". + * The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". */ startDate?: string; } /** - * DirectorySites contains properties of a website from the Site Directory. - * Sites need to be added to an account via the Sites resource before they can - * be assigned to a placement. + * DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement. */ export interface Schema$DirectorySite { /** @@ -3589,26 +2877,19 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the ID of this directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Tag types for regular placements. Acceptable values are: - - * "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - - * "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" + * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" */ inpageTagFormats?: string[]; /** - * Tag types for interstitial placements. Acceptable values are: - - * "IFRAME_JAVASCRIPT_INTERSTITIAL" - - * "INTERNAL_REDIRECT_INTERSTITIAL" - - * "JAVASCRIPT_INTERSTITIAL" + * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" */ interstitialTagFormats?: string[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySite". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". */ kind?: string; /** @@ -3654,8 +2935,7 @@ export namespace dfareporting_v3_3 { */ directorySites?: Schema$DirectorySite[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySitesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". */ kind?: string; /** @@ -3664,23 +2944,15 @@ export namespace dfareporting_v3_3 { nextPageToken?: string; } /** - * Contains properties of a dynamic targeting key. Dynamic targeting keys are - * unique, user-friendly labels, created at the advertiser level in DCM, that - * can be assigned to ads, creatives, and placements and used for targeting - * with Studio dynamic creatives. Use these labels instead of numeric Campaign - * Manager IDs (such as placement IDs) to save time and avoid errors in your - * dynamic feeds. + * Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds. */ export interface Schema$DynamicTargetingKey { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKey". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". */ kind?: string; /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. */ name?: string; /** @@ -3688,8 +2960,7 @@ export namespace dfareporting_v3_3 { */ objectId?: string; /** - * Type of the object of this dynamic targeting key. This is a required - * field. + * Type of the object of this dynamic targeting key. This is a required field. */ objectType?: string; } @@ -3702,8 +2973,7 @@ export namespace dfareporting_v3_3 { */ dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKeysListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". */ kind?: string; } @@ -3712,23 +2982,19 @@ export namespace dfareporting_v3_3 { */ export interface Schema$EncryptionInfo { /** - * The encryption entity ID. This should match the encryption configuration - * for ad serving or Data Transfer. + * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. */ encryptionEntityId?: string; /** - * The encryption entity type. This should match the encryption - * configuration for ad serving or Data Transfer. + * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. */ encryptionEntityType?: string; /** - * Describes whether the encrypted cookie was received from ad serving (the - * %m macro) or from Data Transfer. + * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. */ encryptionSource?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#encryptionInfo". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */ kind?: string; } @@ -3737,40 +3003,31 @@ export namespace dfareporting_v3_3 { */ export interface Schema$EventTag { /** - * Account ID of this event tag. This is a read-only field that can be left - * blank. + * Account ID of this event tag. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this event tag. This field or the campaignId field is - * required on insertion. + * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Campaign ID of this event tag. This field or the advertiserId field is - * required on insertion. + * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * Whether this event tag should be automatically enabled for all of the - * advertiser's campaigns and ads. + * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. */ enabledByDefault?: boolean; /** - * Whether to remove this event tag from ads that are trafficked through - * Display & Video 360 to Ad Exchange. This may be useful if the event - * tag uses a pixel that is unapproved for Ad Exchange bids on one or more - * networks, such as the Google Display Network. + * Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. */ excludeFromAdxRequests?: boolean; /** @@ -3778,24 +3035,19 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTag". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". */ kind?: string; /** - * Name of this event tag. This is a required field and must be less than - * 256 characters long. + * Name of this event tag. This is a required field and must be less than 256 characters long. */ name?: string; /** - * Site filter type for this event tag. If no type is specified then the - * event tag will be applied to all sites. + * Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. */ siteFilterType?: string; /** - * Filter list of site IDs associated with this event tag. The - * siteFilterType determines whether this is a whitelist or blacklist - * filter. + * Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter. */ siteIds?: string[]; /** @@ -3803,31 +3055,23 @@ export namespace dfareporting_v3_3 { */ sslCompliant?: boolean; /** - * Status of this event tag. Must be ENABLED for this event tag to fire. - * This is a required field. + * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. */ status?: string; /** - * Subaccount ID of this event tag. This is a read-only field that can be - * left blank. + * Subaccount ID of this event tag. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Event tag type. Can be used to specify whether to use a third-party - * pixel, a third-party JavaScript URL, or a third-party click-through URL - * for either impression or click tracking. This is a required field. + * Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. */ type?: string; /** - * Payload URL for this event tag. The URL on a click-through event tag - * should have a landing page URL appended to the end of it. This field is - * required on insertion. + * Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. */ url?: string; /** - * Number of times the landing page URL should be URL-escaped before being - * appended to the click-through event tag URL. Only applies to - * click-through event tags as specified by the event tag type. + * Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. */ urlEscapeLevels?: number; } @@ -3853,20 +3097,16 @@ export namespace dfareporting_v3_3 { */ eventTags?: Schema$EventTag[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTagsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". */ kind?: string; } /** - * Represents a File resource. A file contains the metadata for a report run. - * It shows the status of the run and holds the URLs to the generated report - * data if the run is finished and the status is "REPORT_AVAILABLE". + * Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE". */ export interface Schema$File { /** - * The date range for which the file has report data. The date range will - * always be the absolute date range for which the report is run. + * The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. */ dateRange?: Schema$DateRange; /** @@ -3878,8 +3118,7 @@ export namespace dfareporting_v3_3 { */ fileName?: string; /** - * The output format of the report. Only available once the file is - * available. + * The output format of the report. Only available once the file is available. */ format?: string; /** @@ -3891,8 +3130,7 @@ export namespace dfareporting_v3_3 { */ kind?: string; /** - * The timestamp in milliseconds since epoch when this file was last - * modified. + * The timestamp in milliseconds since epoch when this file was last modified. */ lastModifiedTime?: string; /** @@ -3925,10 +3163,7 @@ export namespace dfareporting_v3_3 { */ kind?: string; /** - * Continuation token used to page through files. To retrieve the next page - * of results, set the next request's "pageToken" to the value - * of this field. The page token is only valid for a limited amount of time - * and should not be persisted. + * Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -3958,19 +3193,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$FloodlightActivitiesGenerateTagResponse { /** - * Generated tag for this Floodlight activity. For global site tags, this is - * the event snippet. + * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. */ floodlightActivityTag?: string; /** - * The global snippet section of a global site tag. The global site tag sets - * new cookies on your domain, which will store a unique identifier for a - * user or the ad click that brought the user to your site. Learn more. + * The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. */ globalSiteTagGlobalSnippet?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesGenerateTagResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". */ kind?: string; } @@ -3983,8 +3214,7 @@ export namespace dfareporting_v3_3 { */ floodlightActivities?: Schema$FloodlightActivity[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". */ kind?: string; /** @@ -3997,30 +3227,23 @@ export namespace dfareporting_v3_3 { */ export interface Schema$FloodlightActivity { /** - * Account ID of this floodlight activity. This is a read-only field that - * can be left blank. + * Account ID of this floodlight activity. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this floodlight activity. If this field is left blank, - * the value will be copied over either from the activity group's - * advertiser or the existing activity's advertiser. + * Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Code type used for cache busting in the generated tag. Applicable only - * when floodlightActivityGroupType is COUNTER and countingMethod is - * STANDARD_COUNTING or UNIQUE_COUNTING. + * Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. */ cacheBustingType?: string; /** - * Counting method for conversions for this floodlight activity. This is a - * required field. + * Counting method for conversions for this floodlight activity. This is a required field. */ countingMethod?: string; /** @@ -4028,45 +3251,35 @@ export namespace dfareporting_v3_3 { */ defaultTags?: Schema$FloodlightActivityDynamicTag[]; /** - * URL where this tag will be deployed. If specified, must be less than 256 - * characters long. + * URL where this tag will be deployed. If specified, must be less than 256 characters long. */ expectedUrl?: string; /** - * Floodlight activity group ID of this floodlight activity. This is a - * required field. + * Floodlight activity group ID of this floodlight activity. This is a required field. */ floodlightActivityGroupId?: string; /** - * Name of the associated floodlight activity group. This is a read-only - * field. + * Name of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupName?: string; /** - * Tag string of the associated floodlight activity group. This is a - * read-only field. + * Tag string of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupTagString?: string; /** - * Type of the associated floodlight activity group. This is a read-only - * field. + * Type of the associated floodlight activity group. This is a read-only field. */ floodlightActivityGroupType?: string; /** - * Floodlight configuration ID of this floodlight activity. If this field is - * left blank, the value will be copied over either from the activity - * group's floodlight configuration or from the existing activity's - * floodlight configuration. + * Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** - * The type of Floodlight tag this activity will generate. This is a - * required field. + * The type of Floodlight tag this activity will generate. This is a required field. */ floodlightTagType?: string; /** @@ -4074,23 +3287,19 @@ export namespace dfareporting_v3_3 { */ hidden?: boolean; /** - * ID of this floodlight activity. This is a read-only, auto-generated - * field. + * ID of this floodlight activity. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight activity. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivity". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". */ kind?: string; /** - * Name of this floodlight activity. This is a required field. Must be less - * than 129 characters long and cannot contain quotes. + * Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. */ name?: string; /** @@ -4106,8 +3315,7 @@ export namespace dfareporting_v3_3 { */ secure?: boolean; /** - * Whether the floodlight activity is SSL-compliant. This is a read-only - * field, its value detected by the system from the floodlight tags. + * Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. */ sslCompliant?: boolean; /** @@ -4115,28 +3323,19 @@ export namespace dfareporting_v3_3 { */ sslRequired?: boolean; /** - * Subaccount ID of this floodlight activity. This is a read-only field that - * can be left blank. + * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Tag format type for the floodlight activity. If left blank, the tag - * format will default to HTML. + * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. */ tagFormat?: string; /** - * Value of the cat= parameter in the floodlight tag, which the ad servers - * use to identify the activity. This is optional: if empty, a new tag - * string will be generated for you. This string must be 1 to 8 characters - * long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag - * string must also be unique among activities of the same activity group. - * This field is read-only after insertion. + * Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. */ tagString?: string; /** - * List of the user-defined variables used by this conversion tag. These map - * to the "u[1-100]=" in the tags. Each of these can have a user - * defined type. Acceptable values are U1 to U100, inclusive. + * List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. */ userDefinedVariableTypes?: string[]; } @@ -4162,70 +3361,51 @@ export namespace dfareporting_v3_3 { */ export interface Schema$FloodlightActivityGroup { /** - * Account ID of this floodlight activity group. This is a read-only field - * that can be left blank. + * Account ID of this floodlight activity group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this floodlight activity group. If this field is left - * blank, the value will be copied over either from the floodlight - * configuration's advertiser or from the existing activity group's - * advertiser. + * Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** - * Floodlight configuration ID of this floodlight activity group. This is a - * required field. + * Floodlight configuration ID of this floodlight activity group. This is a required field. */ floodlightConfigurationId?: string; /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; /** - * ID of this floodlight activity group. This is a read-only, auto-generated - * field. + * ID of this floodlight activity group. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight activity group. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". */ kind?: string; /** - * Name of this floodlight activity group. This is a required field. Must be - * less than 65 characters long and cannot contain quotes. + * Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. */ name?: string; /** - * Subaccount ID of this floodlight activity group. This is a read-only - * field that can be left blank. + * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Value of the type= parameter in the floodlight tag, which the ad servers - * use to identify the activity group that the activity belongs to. This is - * optional: if empty, a new tag string will be generated for you. This - * string must be 1 to 8 characters long, with valid characters being - * [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among - * activity groups of the same floodlight configuration. This field is - * read-only after insertion. + * Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. */ tagString?: string; /** - * Type of the floodlight activity group. This is a required field that is - * read-only after insertion. + * Type of the floodlight activity group. This is a required field that is read-only after insertion. */ type?: string; } @@ -4238,8 +3418,7 @@ export namespace dfareporting_v3_3 { */ floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". */ kind?: string; /** @@ -4256,9 +3435,7 @@ export namespace dfareporting_v3_3 { */ clickThrough?: boolean; /** - * Directory site ID of this dynamic tag. This is a write-only field that - * can be used as an alternative to the siteId field. When this resource is - * retrieved, only the siteId field will be populated. + * Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. */ directorySiteId?: string; /** @@ -4270,8 +3447,7 @@ export namespace dfareporting_v3_3 { */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** @@ -4284,8 +3460,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$FloodlightConfiguration { /** - * Account ID of this floodlight configuration. This is a read-only field - * that can be left blank. + * Account ID of this floodlight configuration. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -4293,8 +3468,7 @@ export namespace dfareporting_v3_3 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -4306,24 +3480,19 @@ export namespace dfareporting_v3_3 { */ customViewabilityMetric?: Schema$CustomViewabilityMetric; /** - * Whether the exposure-to-conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. + * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ exposureToConversionEnabled?: boolean; /** - * Day that will be counted as the first day of the week in reports. This is - * a required field. + * Day that will be counted as the first day of the week in reports. This is a required field. */ firstDayOfWeek?: string; /** - * ID of this floodlight configuration. This is a read-only, auto-generated - * field. + * ID of this floodlight configuration. This is a read-only, auto-generated field. */ id?: string; /** - * Dimension value for the ID of this floodlight configuration. This is a - * read-only, auto-generated field. + * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -4331,8 +3500,7 @@ export namespace dfareporting_v3_3 { */ inAppAttributionTrackingEnabled?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfiguration". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". */ kind?: string; /** @@ -4348,8 +3516,7 @@ export namespace dfareporting_v3_3 { */ omnitureSettings?: Schema$OmnitureSettings; /** - * Subaccount ID of this floodlight configuration. This is a read-only field - * that can be left blank. + * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. */ subaccountId?: string; /** @@ -4374,34 +3541,28 @@ export namespace dfareporting_v3_3 { */ floodlightConfigurations?: Schema$FloodlightConfiguration[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfigurationsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". */ kind?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "FlOODLIGHT". + * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". */ export interface Schema$FloodlightReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#floodlightReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; } @@ -4410,13 +3571,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$FrequencyCap { /** - * Duration of time, in seconds, for this frequency cap. The maximum - * duration is 90 days. Acceptable values are 1 to 7776000, inclusive. + * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. */ duration?: string; /** - * Number of times an individual user can be served the ad within the - * specified duration. Acceptable values are 1 to 15, inclusive. + * Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. */ impressions?: string; } @@ -4425,8 +3584,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$FsCommand { /** - * Distance from the left of the browser.Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. + * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ left?: number; /** @@ -4434,8 +3592,7 @@ export namespace dfareporting_v3_3 { */ positionOption?: string; /** - * Distance from the top of the browser. Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. + * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. */ top?: number; /** @@ -4452,44 +3609,27 @@ export namespace dfareporting_v3_3 { */ export interface Schema$GeoTargeting { /** - * Cities to be targeted. For each city only dartId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a city, do not target or exclude the country of the city, and - * do not target the metro or region of the city. + * Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. */ cities?: Schema$City[]; /** - * Countries to be targeted or excluded from targeting, depending on the - * setting of the excludeCountries field. For each country only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting or excluding a country, do not target - * regions, cities, metros, or postal codes in the same country. + * Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. */ countries?: Schema$Country[]; /** - * Whether or not to exclude the countries in the countries field from - * targeting. If false, the countries field refers to countries which will - * be targeted by the ad. + * Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. */ excludeCountries?: boolean; /** - * Metros to be targeted. For each metro only dmaId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a metro, do not target or exclude the country of the metro. + * Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. */ metros?: Schema$Metro[]; /** - * Postal codes to be targeted. For each postal code only id is required. - * The other fields are populated automatically when the ad is inserted or - * updated. If targeting a postal code, do not target or exclude the country - * of the postal code. + * Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. */ postalCodes?: Schema$PostalCode[]; /** - * Regions to be targeted. For each region only dartId is required. The - * other fields are populated automatically when the ad is inserted or - * updated. If targeting a region, do not target or exclude the country of - * the region. + * Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. */ regions?: Schema$Region[]; } @@ -4502,10 +3642,7 @@ export namespace dfareporting_v3_3 { */ accountId?: string; /** - * Ad slots of this inventory item. If this inventory item represents a - * standalone placement, there will be exactly one ad slot. If this - * inventory item represents a placement group, there will be more than one - * ad slot, each representing one child placement in that placement group. + * Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group. */ adSlots?: Schema$AdSlot[]; /** @@ -4533,8 +3670,7 @@ export namespace dfareporting_v3_3 { */ inPlan?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItem". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". */ kind?: string; /** @@ -4542,9 +3678,7 @@ export namespace dfareporting_v3_3 { */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this inventory item. For standalone inventory items, this is the - * same name as that of its only ad slot. For group inventory items, this - * can differ from the name of any of its ad slots. + * Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots. */ name?: string; /** @@ -4593,8 +3727,7 @@ export namespace dfareporting_v3_3 { */ inventoryItems?: Schema$InventoryItem[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItemsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". */ kind?: string; /** @@ -4612,8 +3745,7 @@ export namespace dfareporting_v3_3 { expression?: string; } /** - * Contains information about where a user's browser is taken after the - * user clicks an ad. + * Contains information about where a user's browser is taken after the user clicks an ad. */ export interface Schema$LandingPage { /** @@ -4633,13 +3765,11 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#landingPage". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". */ kind?: string; /** - * Name of this landing page. This is a required field. It must be less than - * 256 characters long. + * Name of this landing page. This is a required field. It must be less than 256 characters long. */ name?: string; /** @@ -4652,19 +3782,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Language { /** - * Language ID of this language. This is the ID used for targeting and - * generating reports. + * Language ID of this language. This is the ID used for targeting and generating reports. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#language". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". */ kind?: string; /** - * Format of language code is an ISO 639 two-letter language code optionally - * followed by an underscore followed by an ISO 3166 code. Examples are - * "en" for English or "zh_CN" for Simplified Chinese. + * Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. */ languageCode?: string; /** @@ -4677,8 +3803,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$LanguagesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#languagesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". */ kind?: string; /** @@ -4691,9 +3816,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$LanguageTargeting { /** - * Languages that this ad targets. For each language only languageId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. + * Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. */ languages?: Schema$Language[]; } @@ -4707,13 +3830,11 @@ export namespace dfareporting_v3_3 { time?: string; } /** - * A group clause made up of list population terms representing constraints - * joined by ORs. + * A group clause made up of list population terms representing constraints joined by ORs. */ export interface Schema$ListPopulationClause { /** - * Terms of this list population clause. Each clause is made up of list - * population terms representing constraints and are joined by ORs. + * Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. */ terms?: Schema$ListPopulationTerm[]; } @@ -4722,19 +3843,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ListPopulationRule { /** - * Floodlight activity ID associated with this rule. This field can be left - * blank. + * Floodlight activity ID associated with this rule. This field can be left blank. */ floodlightActivityId?: string; /** - * Name of floodlight activity associated with this rule. This is a - * read-only, auto-generated field. + * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. */ floodlightActivityName?: string; /** - * Clauses that make up this list population rule. Clauses are joined by - * ANDs, and the clauses themselves are made up of list population terms - * which are joined by ORs. + * Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. */ listPopulationClauses?: Schema$ListPopulationClause[]; } @@ -4743,52 +3860,35 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ListPopulationTerm { /** - * Will be true if the term should check if the user is in the list and - * false if the term should check if the user is not in the list. This field - * is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by - * default. + * Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. */ contains?: boolean; /** - * Whether to negate the comparison result of this term during rule - * evaluation. This field is only relevant when type is left unset or set to - * CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ negation?: boolean; /** - * Comparison operator of this term. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ operator?: string; /** - * ID of the list in question. This field is only relevant when type is set - * to LIST_MEMBERSHIP_TERM. + * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. */ remarketingListId?: string; /** - * List population term type determines the applicable fields in this - * object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, - * variableFriendlyName, operator, value, and negation are applicable. If - * set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are - * applicable. If set to REFERRER_TERM then operator, value, and negation - * are applicable. + * List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. */ type?: string; /** - * Literal to compare the variable to. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + * Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ value?: string; /** - * Friendly name of this term's variable. This is a read-only, - * auto-generated field. This field is only relevant when type is left unset - * or set to CUSTOM_VARIABLE_TERM. + * Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. */ variableFriendlyName?: string; /** - * Name of the variable (U1, U2, etc.) being compared in this term. This - * field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or - * REFERRER_TERM. + * Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ variableName?: string; } @@ -4806,19 +3906,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$LookbackConfiguration { /** - * Lookback window, in days, from the last time a given user clicked on one - * of your ads. If you enter 0, clicks will not be considered as triggering - * events for floodlight tracking. If you leave this field blank, the - * default value for your account will be used. Acceptable values are 0 to - * 90, inclusive. + * Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. */ clickDuration?: number; /** - * Lookback window, in days, from the last time a given user viewed one of - * your ads. If you enter 0, impressions will not be considered as - * triggering events for floodlight tracking. If you leave this field blank, - * the default value for your account will be used. Acceptable values are 0 - * to 90, inclusive. + * Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. */ postImpressionActivitiesDuration?: number; } @@ -4852,13 +3944,11 @@ export namespace dfareporting_v3_3 { */ dartId?: string; /** - * DMA ID of this metro region. This is the ID used for targeting and - * generating reports, and is equivalent to metro_code. + * DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. */ dmaId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metro". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". */ kind?: string; /** @@ -4875,8 +3965,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$MetrosListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metrosListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". */ kind?: string; /** @@ -4897,8 +3986,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileApp". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". */ kind?: string; /** @@ -4915,8 +4003,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$MobileAppsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileAppsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". */ kind?: string; /** @@ -4945,8 +4032,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarrier". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". */ kind?: string; /** @@ -4959,8 +4045,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$MobileCarriersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarriersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". */ kind?: string; /** @@ -4973,19 +4058,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ObjectFilter { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#objectFilter". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". */ kind?: string; /** - * Applicable when status is ASSIGNED. The user has access to objects with - * these object IDs. + * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. */ objectIds?: string[]; /** - * Status of the filter. NONE means the user has access to none of the - * objects. ALL means the user has access to all objects. ASSIGNED means the - * user has access to the objects with IDs in the objectIds list. + * Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list. */ status?: string; } @@ -5007,13 +4088,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$OmnitureSettings { /** - * Whether placement cost data will be sent to Omniture. This property can - * be enabled only if omnitureIntegrationEnabled is true. + * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. */ omnitureCostDataEnabled?: boolean; /** - * Whether Omniture integration is enabled. This property can be enabled - * only when the "Advanced Ad Serving" account setting is enabled. + * Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. */ omnitureIntegrationEnabled?: boolean; } @@ -5030,8 +4109,7 @@ export namespace dfareporting_v3_3 { */ desktop?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystem". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". */ kind?: string; /** @@ -5048,8 +4126,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$OperatingSystemsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". */ kind?: string; /** @@ -5058,8 +4135,7 @@ export namespace dfareporting_v3_3 { operatingSystems?: Schema$OperatingSystem[]; } /** - * Contains information about a particular version of an operating system that - * can be targeted by ads. + * Contains information about a particular version of an operating system that can be targeted by ads. */ export interface Schema$OperatingSystemVersion { /** @@ -5067,8 +4143,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersion". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". */ kind?: string; /** @@ -5076,8 +4151,7 @@ export namespace dfareporting_v3_3 { */ majorVersion?: string; /** - * Minor version (number after the first dot) of this operating system - * version. + * Minor version (number after the first dot) of this operating system version. */ minorVersion?: string; /** @@ -5094,8 +4168,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$OperatingSystemVersionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". */ kind?: string; /** @@ -5108,19 +4181,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$OptimizationActivity { /** - * Floodlight activity ID of this optimization activity. This is a required - * field. + * Floodlight activity ID of this optimization activity. This is a required field. */ floodlightActivityId?: string; /** - * Dimension value for the ID of the floodlight activity. This is a - * read-only, auto-generated field. + * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. */ floodlightActivityIdDimensionValue?: Schema$DimensionValue; /** - * Weight associated with this optimization. The weight assigned will be - * understood in proportion to the weights assigned to the other - * optimization activities. Value must be greater than or equal to 1. + * Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. */ weight?: number; } @@ -5161,8 +4230,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#order". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". */ kind?: string; /** @@ -5215,9 +4283,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$OrderContact { /** - * Free-form information about this contact. It could be any information - * related to this contact in addition to type, title, name, and signature - * user profile ID. + * Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID. */ contactInfo?: string; /** @@ -5233,8 +4299,7 @@ export namespace dfareporting_v3_3 { */ contactType?: string; /** - * ID of the user profile containing the signature that will be embedded - * into order documents. + * ID of the user profile containing the signature that will be embedded into order documents. */ signatureUserProfileId?: string; } @@ -5251,9 +4316,7 @@ export namespace dfareporting_v3_3 { */ advertiserId?: string; /** - * The amended order document ID of this order document. An order document - * can be created by optionally amending another order document so that the - * change history can be preserved. + * The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. */ amendedOrderDocumentId?: string; /** @@ -5277,8 +4340,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocument". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". */ kind?: string; /** @@ -5319,8 +4381,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$OrderDocumentsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocumentsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". */ kind?: string; /** @@ -5337,8 +4398,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$OrdersListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ordersListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". */ kind?: string; /** @@ -5351,33 +4411,27 @@ export namespace dfareporting_v3_3 { orders?: Schema$Order[]; } /** - * Represents fields that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". + * Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */ export interface Schema$PathToConversionReportCompatibleFields { /** - * Conversion dimensions which are compatible to be selected in the - * "conversionDimensions" section of the report. + * Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. */ conversionDimensions?: Schema$Dimension[]; /** - * Custom floodlight variables which are compatible to be selected in the - * "customFloodlightVariables" section of the report. + * Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. */ customFloodlightVariables?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#pathToConversionReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Per-interaction dimensions which are compatible to be selected in the - * "perInteractionDimensions" section of the report. + * Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. */ perInteractionDimensions?: Schema$Dimension[]; } @@ -5390,14 +4444,11 @@ export namespace dfareporting_v3_3 { */ accountId?: string; /** - * Whether this placement opts out of ad blocking. When true, ad blocking is - * disabled for this placement. When false, the campaign and site settings - * take effect. + * Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. */ adBlockingOptOut?: boolean; /** - * Additional sizes associated with this placement. When inserting or - * updating a placement, only the size ID field is used. + * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. */ additionalSizes?: Schema$Size[]; /** @@ -5405,8 +4456,7 @@ export namespace dfareporting_v3_3 { */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -5414,13 +4464,11 @@ export namespace dfareporting_v3_3 { */ archived?: boolean; /** - * Campaign ID of this placement. This field is a required field on - * insertion. + * Campaign ID of this placement. This field is a required field on insertion. */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** @@ -5428,13 +4476,7 @@ export namespace dfareporting_v3_3 { */ comment?: string; /** - * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering on desktop, on mobile devices or in mobile apps for regular or - * interstitial ads respectively. APP and APP_INTERSTITIAL are no longer - * allowed for new placement insertions. Instead, use DISPLAY or - * DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream - * video ads developed with the VAST standard. This field is required on - * insertion. + * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. */ compatibility?: string; /** @@ -5442,19 +4484,15 @@ export namespace dfareporting_v3_3 { */ contentCategoryId?: string; /** - * Information about the creation of this placement. This is a read-only - * field. + * Information about the creation of this placement. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** - * Directory site ID of this placement. On insert, you must set either this - * field or the siteId field to specify the site associated with this - * placement. This is a required field that is read-only after insertion. + * Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -5466,8 +4504,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the ID of this placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this placement. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -5475,13 +4512,11 @@ export namespace dfareporting_v3_3 { */ keyName?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placement". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". */ kind?: string; /** - * Information about the most recent modification of this placement. This is - * a read-only field. + * Information about the most recent modification of this placement. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** @@ -5489,18 +4524,15 @@ export namespace dfareporting_v3_3 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Name of this placement.This is a required field and must be less than 256 - * characters long. + * Name of this placement.This is a required field and must be less than 256 characters long. */ name?: string; /** - * Whether payment was approved for this placement. This is a read-only - * field relevant only to publisher-paid placements. + * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. */ paymentApproved?: boolean; /** - * Payment source for this placement. This is a required field that is - * read-only after insertion. + * Payment source for this placement. This is a required field that is read-only after insertion. */ paymentSource?: string; /** @@ -5508,8 +4540,7 @@ export namespace dfareporting_v3_3 { */ placementGroupId?: string; /** - * Dimension value for the ID of the placement group. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. */ placementGroupIdDimensionValue?: Schema$DimensionValue; /** @@ -5517,17 +4548,11 @@ export namespace dfareporting_v3_3 { */ placementStrategyId?: string; /** - * Pricing schedule of this placement. This field is required on insertion, - * specifically subfields startDate, endDate and pricingType. + * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. */ pricingSchedule?: Schema$PricingSchedule; /** - * Whether this placement is the primary placement of a roadblock (placement - * group). You cannot change this field from true to false. Setting this - * field to true will automatically set the primary field on the original - * primary placement of the roadblock to false, and it will automatically - * set the roadblock's primaryPlacementId field to the ID of this - * placement. + * Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. */ primary?: boolean; /** @@ -5535,21 +4560,15 @@ export namespace dfareporting_v3_3 { */ publisherUpdateInfo?: Schema$LastModifiedInfo; /** - * Site ID associated with this placement. On insert, you must set either - * this field or the directorySiteId field to specify the site associated - * with this placement. This is a required field that is read-only after - * insertion. + * Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** - * Size associated with this placement. When inserting or updating a - * placement, only the size ID field is used. This field is required on - * insertion. + * Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. */ size?: Schema$Size; /** @@ -5565,22 +4584,7 @@ export namespace dfareporting_v3_3 { */ subaccountId?: string; /** - * Tag formats to generate for this placement. This field is required on - * insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - - * "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_IFRAME_ILAYER" - - * "PLACEMENT_TAG_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - - * "PLACEMENT_TAG_CLICK_COMMANDS" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - - * "PLACEMENT_TAG_TRACKING" - - * "PLACEMENT_TAG_TRACKING_IFRAME" - - * "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + * Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" */ tagFormats?: string[]; /** @@ -5588,26 +4592,15 @@ export namespace dfareporting_v3_3 { */ tagSetting?: Schema$TagSetting; /** - * Whether Verification and ActiveView are disabled for in-stream video - * creatives for this placement. The same setting videoActiveViewOptOut - * exists on the site level -- the opt out occurs if either of these - * settings are true. These settings are distinct from - * DirectorySites.settings.activeViewOptOut or - * Sites.siteSettings.activeViewOptOut which only apply to display ads. - * However, Accounts.activeViewOptOut opts out both video traffic, as well - * as display ads, from Verification and ActiveView. + * Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. */ videoActiveViewOptOut?: boolean; /** - * A collection of settings which affect video creatives served through this - * placement. Applicable to placements with IN_STREAM_VIDEO compatibility. + * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. */ videoSettings?: Schema$VideoSettings; /** - * VPAID adapter setting for this placement. Controls which VPAID format the - * measurement adapter will use for in-stream video creatives assigned to - * this placement. Note: Flash is no longer supported. This field now - * defaults to HTML5 when the following values are provided: FLASH, BOTH. + * VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. */ vpaidAdapterChoice?: string; } @@ -5616,8 +4609,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlacementAssignment { /** - * Whether this placement assignment is active. When true, the placement - * will be included in the ad's rotation. + * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. */ active?: boolean; /** @@ -5625,13 +4617,11 @@ export namespace dfareporting_v3_3 { */ placementId?: string; /** - * Dimension value for the ID of the placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the placement. This is a read-only, auto-generated field. */ placementIdDimensionValue?: Schema$DimensionValue; /** - * Whether the placement to be assigned requires SSL. This is a read-only - * field that is auto-generated when the ad is inserted or updated. + * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated. */ sslRequired?: boolean; } @@ -5640,18 +4630,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlacementGroup { /** - * Account ID of this placement group. This is a read-only field that can be - * left blank. + * Account ID of this placement group. This is a read-only field that can be left blank. */ accountId?: string; /** - * Advertiser ID of this placement group. This is a required field on - * insertion. + * Advertiser ID of this placement group. This is a required field on insertion. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -5663,13 +4650,11 @@ export namespace dfareporting_v3_3 { */ campaignId?: string; /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. */ campaignIdDimensionValue?: Schema$DimensionValue; /** - * IDs of placements which are assigned to this placement group. This is a - * read-only, auto-generated field. + * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. */ childPlacementIds?: string[]; /** @@ -5681,20 +4666,15 @@ export namespace dfareporting_v3_3 { */ contentCategoryId?: string; /** - * Information about the creation of this placement group. This is a - * read-only field. + * Information about the creation of this placement group. This is a read-only field. */ createInfo?: Schema$LastModifiedInfo; /** - * Directory site ID associated with this placement group. On insert, you - * must set either this field or the site_id field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. + * Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -5706,32 +4686,23 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the ID of this placement group. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". */ kind?: string; /** - * Information about the most recent modification of this placement group. - * This is a read-only field. + * Information about the most recent modification of this placement group. This is a read-only field. */ lastModifiedInfo?: Schema$LastModifiedInfo; /** - * Name of this placement group. This is a required field and must be less - * than 256 characters long. + * Name of this placement group. This is a required field and must be less than 256 characters long. */ name?: string; /** - * Type of this placement group. A package is a simple group of placements - * that acts as a single pricing point for a group of tags. A roadblock is a - * group of placements that not only acts as a single pricing point, but - * also assumes that all the tags in it will be served at the same time. A - * roadblock requires one of its assigned placements to be marked as primary - * for reporting. This field is required on insertion. + * Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. */ placementGroupType?: string; /** @@ -5739,36 +4710,27 @@ export namespace dfareporting_v3_3 { */ placementStrategyId?: string; /** - * Pricing schedule of this placement group. This field is required on - * insertion. + * Pricing schedule of this placement group. This field is required on insertion. */ pricingSchedule?: Schema$PricingSchedule; /** - * ID of the primary placement, used to calculate the media cost of a - * roadblock (placement group). Modifying this field will automatically - * modify the primary field on all affected roadblock child placements. + * ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. */ primaryPlacementId?: string; /** - * Dimension value for the ID of the primary placement. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. */ primaryPlacementIdDimensionValue?: Schema$DimensionValue; /** - * Site ID associated with this placement group. On insert, you must set - * either this field or the directorySiteId field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. + * Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. */ siteId?: string; /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the site. This is a read-only, auto-generated field. */ siteIdDimensionValue?: Schema$DimensionValue; /** - * Subaccount ID of this placement group. This is a read-only field that can - * be left blank. + * Subaccount ID of this placement group. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -5777,8 +4739,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlacementGroupsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". */ kind?: string; /** @@ -5795,8 +4756,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlacementsGenerateTagsResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsGenerateTagsResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". */ kind?: string; /** @@ -5809,8 +4769,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlacementsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". */ kind?: string; /** @@ -5827,8 +4786,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlacementStrategiesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategiesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". */ kind?: string; /** @@ -5845,8 +4803,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlacementStrategy { /** - * Account ID of this placement strategy.This is a read-only field that can - * be left blank. + * Account ID of this placement strategy.This is a read-only field that can be left blank. */ accountId?: string; /** @@ -5854,14 +4811,11 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategy". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". */ kind?: string; /** - * Name of this placement strategy. This is a required field. It must be - * less than 256 characters long and unique among placement strategies of - * the same account. + * Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. */ name?: string; } @@ -5887,8 +4841,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformType". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". */ kind?: string; /** @@ -5901,8 +4854,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PlatformTypesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformTypesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". */ kind?: string; /** @@ -5915,13 +4867,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PopupWindowProperties { /** - * Popup dimension for a creative. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID + * Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID */ dimension?: Schema$Size; /** - * Upper-left corner coordinates of the popup window. Applicable if - * positionType is COORDINATES. + * Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES. */ offset?: Schema$OffsetPosition; /** @@ -5974,8 +4924,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCode". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". */ kind?: string; } @@ -5984,8 +4933,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PostalCodesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCodesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". */ kind?: string; /** @@ -6006,20 +4954,11 @@ export namespace dfareporting_v3_3 { */ endDate?: string; /** - * Flights of this inventory item. A flight (a.k.a. pricing period) - * represents the inventory item pricing information for a specific period - * of time. + * Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. */ flights?: Schema$Flight[]; /** - * Group type of this inventory item if it represents a placement group. Is - * null otherwise. There are two type of placement groups: - * PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory - * items that acts as a single pricing point for a group of tags. - * PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items - * that not only acts as a single pricing point, but also assumes that all - * the tags in it will be served at the same time. A roadblock requires one - * of its assigned inventory items to be marked as primary. + * Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary. */ groupType?: string; /** @@ -6044,22 +4983,15 @@ export namespace dfareporting_v3_3 { */ disregardOverdelivery?: boolean; /** - * Placement end date. This date must be later than, or the same day as, the - * placement start date, but not later than the campaign end date. If, for - * example, you set 6/25/2015 as both the start and end dates, the effective - * placement date is just that day only, 6/25/2015. The hours, minutes, and - * seconds of the end date should not be set, as doing so will result in an - * error. This field is required on insertion. + * Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion. */ endDate?: string; /** - * Whether this placement is flighted. If true, pricing periods will be - * computed automatically. + * Whether this placement is flighted. If true, pricing periods will be computed automatically. */ flighted?: boolean; /** - * Floodlight activity ID associated with this placement. This field should - * be set when placement pricing type is set to PRICING_TYPE_CPA. + * Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. */ floodlightActivityId?: string; /** @@ -6071,15 +5003,11 @@ export namespace dfareporting_v3_3 { */ pricingType?: string; /** - * Placement start date. This date must be later than, or the same day as, - * the campaign start date. The hours, minutes, and seconds of the start - * date should not be set, as doing so will result in an error. This field - * is required on insertion. + * Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion. */ startDate?: string; /** - * Testing start date of this placement. The hours, minutes, and seconds of - * the start date should not be set, as doing so will result in an error. + * Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. */ testingStartDate?: string; } @@ -6088,13 +5016,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$PricingSchedulePricingPeriod { /** - * Pricing period end date. This date must be later than, or the same day - * as, the pricing period start date, but not later than the placement end - * date. The period end date can be the same date as the period start date. - * If, for example, you set 6/25/2015 as both the start and end dates, the - * effective pricing period date is just that day only, 6/25/2015. The - * hours, minutes, and seconds of the end date should not be set, as doing - * so will result in an error. + * Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. */ endDate?: string; /** @@ -6102,19 +5024,15 @@ export namespace dfareporting_v3_3 { */ pricingComment?: string; /** - * Rate or cost of this pricing period in nanos (i.e., multipled by - * 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. + * Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. */ rateOrCostNanos?: string; /** - * Pricing period start date. This date must be later than, or the same day - * as, the placement start date. The hours, minutes, and seconds of the - * start date should not be set, as doing so will result in an error. + * Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. */ startDate?: string; /** - * Units of this pricing period. Acceptable values are 0 to 10000000000, - * inclusive. + * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. */ units?: string; } @@ -6139,10 +5057,7 @@ export namespace dfareporting_v3_3 { */ audienceGender?: string; /** - * Budget of this project in the currency specified by the current account. - * The value stored in this field represents only the non-fractional amount. - * For example, for USD, the smallest value that can be represented by this - * field is 1 US dollar. + * Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. */ budget?: string; /** @@ -6162,8 +5077,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#project". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". */ kind?: string; /** @@ -6220,8 +5134,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ProjectsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#projectsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". */ kind?: string; /** @@ -6234,38 +5147,31 @@ export namespace dfareporting_v3_3 { projects?: Schema$Project[]; } /** - * Represents fields that are compatible to be selected for a report of type - * "REACH". + * Represents fields that are compatible to be selected for a report of type "REACH". */ export interface Schema$ReachReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#reachReportCompatibleFields. + * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */ pivotedActivityMetrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected in the - * "reachByFrequencyMetricNames" section of the report. + * Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. */ reachByFrequencyMetrics?: Schema$Metric[]; } @@ -6303,8 +5209,7 @@ export namespace dfareporting_v3_3 { */ dartId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#region". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". */ kind?: string; /** @@ -6321,8 +5226,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$RegionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#regionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". */ kind?: string; /** @@ -6331,18 +5235,11 @@ export namespace dfareporting_v3_3 { regions?: Schema$Region[]; } /** - * Contains properties of a remarketing list. Remarketing enables you to - * create lists of users who have performed specific actions on a site, then - * target ads to members of those lists. This resource can be used to manage - * remarketing lists that are owned by your advertisers. To see all - * remarketing lists that are visible to your advertisers, including those - * that are shared to your advertiser or account, use the - * TargetableRemarketingLists resource. + * Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. */ export interface Schema$RemarketingList { /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ accountId?: string; /** @@ -6350,13 +5247,11 @@ export namespace dfareporting_v3_3 { */ active?: boolean; /** - * Dimension value for the advertiser ID that owns this remarketing list. - * This is a required field. + * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -6368,13 +5263,11 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingList". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". */ kind?: string; /** - * Number of days that a user should remain in the remarketing list without - * an impression. Acceptable values are 1 to 540, inclusive. + * Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. */ lifeSpan?: string; /** @@ -6390,26 +5283,20 @@ export namespace dfareporting_v3_3 { */ listSource?: string; /** - * Name of the remarketing list. This is a required field. Must be no - * greater than 128 characters long. + * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. */ name?: string; /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ subaccountId?: string; } /** - * Contains properties of a remarketing list's sharing information. - * Sharing allows other accounts or advertisers to target to your remarketing - * lists. This resource can be used to manage remarketing list sharing to - * other accounts and advertisers. + * Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers. */ export interface Schema$RemarketingListShare { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListShare". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". */ kind?: string; /** @@ -6430,8 +5317,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$RemarketingListsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". */ kind?: string; /** @@ -6463,8 +5349,7 @@ export namespace dfareporting_v3_3 { metricNames?: string[]; }; /** - * The report criteria for a report of type - * "CROSS_DIMENSION_REACH". + * The report criteria for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachCriteria?: { breakdown?: Schema$SortedDimension[]; @@ -6509,11 +5394,7 @@ export namespace dfareporting_v3_3 { }; }; /** - * The output format of the report. If not specified, default format is - * "CSV". Note that the actual format in the completed report file - * might differ if for instance the report's size exceeds the - * format's capabilities. "CSV" will then be the fallback - * format. + * The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. */ format?: string; /** @@ -6525,8 +5406,7 @@ export namespace dfareporting_v3_3 { */ kind?: string; /** - * The timestamp (in milliseconds since epoch) of when this report was last - * modified. + * The timestamp (in milliseconds since epoch) of when this report was last modified. */ lastModifiedTime?: string; /** @@ -6575,9 +5455,7 @@ export namespace dfareporting_v3_3 { reachByFrequencyMetricNames?: string[]; }; /** - * The report's schedule. Can only be set if the report's - * 'dateRange' is a relative date range and the relative date range - * is not "TODAY". + * The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". */ schedule?: { active?: boolean; @@ -6598,33 +5476,27 @@ export namespace dfareporting_v3_3 { type?: string; } /** - * Represents fields that are compatible to be selected for a report of type - * "STANDARD". + * Represents fields that are compatible to be selected for a report of type "STANDARD". */ export interface Schema$ReportCompatibleFields { /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */ dimensionFilters?: Schema$Dimension[]; /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. + * Dimensions which are compatible to be selected in the "dimensions" section of the report. */ dimensions?: Schema$Dimension[]; /** - * The kind of resource this is, in this case - * dfareporting#reportCompatibleFields. + * The kind of resource this is, in this case dfareporting#reportCompatibleFields. */ kind?: string; /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. + * Metrics which are compatible to be selected in the "metricNames" section of the report. */ metrics?: Schema$Metric[]; /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */ pivotedActivityMetrics?: Schema$Metric[]; } @@ -6645,10 +5517,7 @@ export namespace dfareporting_v3_3 { */ kind?: string; /** - * Continuation token used to page through reports. To retrieve the next - * page of results, set the next request's "pageToken" to the - * value of this field. The page token is only valid for a limited amount of - * time and should not be persisted. + * Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. */ nextPageToken?: string; } @@ -6657,9 +5526,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$ReportsConfiguration { /** - * Whether the exposure to conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. + * Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. */ exposureToConversionEnabled?: boolean; /** @@ -6667,18 +5534,7 @@ export namespace dfareporting_v3_3 { */ lookbackConfiguration?: Schema$LookbackConfiguration; /** - * Report generation time zone ID of this account. This is a required field - * that can only be changed by a superuser. Acceptable values are: - - * "1" for "America/New_York" - "2" for - * "Europe/London" - "3" for "Europe/Paris" - * - "4" for "Africa/Johannesburg" - "5" for - * "Asia/Jerusalem" - "6" for "Asia/Shanghai" - * - "7" for "Asia/Hong_Kong" - "8" for - * "Asia/Tokyo" - "9" for "Australia/Sydney" - * - "10" for "Asia/Dubai" - "11" for - * "America/Los_Angeles" - "12" for - * "Pacific/Auckland" - "13" for - * "America/Sao_Paulo" + * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" */ reportGenerationTimeZoneId?: string; } @@ -6687,13 +5543,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$RichMediaExitOverride { /** - * Click-through URL of this rich media exit override. Applicable if the - * enabled field is set to true. + * Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. */ clickThroughUrl?: Schema$ClickThroughUrl; /** - * Whether to use the clickThroughUrl. If false, the creative-level exit - * will be used. + * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. */ enabled?: boolean; /** @@ -6702,13 +5556,11 @@ export namespace dfareporting_v3_3 { exitId?: string; } /** - * A rule associates an asset with a targeting template for asset-level - * targeting. Applicable to INSTREAM_VIDEO creatives. + * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$Rule { /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative. This is a required field. + * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. */ assetId?: string; /** @@ -6716,9 +5568,7 @@ export namespace dfareporting_v3_3 { */ name?: string; /** - * A targeting template ID. The targeting from the targeting template will - * be used to determine whether this asset should be served. This is a - * required field. + * A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field. */ targetingTemplateId?: string; } @@ -6727,8 +5577,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Site { /** - * Account ID of this site. This is a read-only field that can be left - * blank. + * Account ID of this site. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -6736,13 +5585,11 @@ export namespace dfareporting_v3_3 { */ approved?: boolean; /** - * Directory site associated with this site. This is a required field that - * is read-only after insertion. + * Directory site associated with this site. This is a required field that is read-only after insertion. */ directorySiteId?: string; /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. */ directorySiteIdDimensionValue?: Schema$DimensionValue; /** @@ -6750,8 +5597,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Dimension value for the ID of this site. This is a read-only, - * auto-generated field. + * Dimension value for the ID of this site. This is a read-only, auto-generated field. */ idDimensionValue?: Schema$DimensionValue; /** @@ -6759,16 +5605,11 @@ export namespace dfareporting_v3_3 { */ keyName?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#site". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". */ kind?: string; /** - * Name of this site.This is a required field. Must be less than 128 - * characters long. If this site is under a subaccount, the name must be - * unique among sites of the same subaccount. Otherwise, this site is a - * top-level site, and the name must be unique among top-level sites of the - * same account. + * Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. */ name?: string; /** @@ -6780,14 +5621,11 @@ export namespace dfareporting_v3_3 { */ siteSettings?: Schema$SiteSettings; /** - * Subaccount ID of this site. This is a read-only field that can be left - * blank. + * Subaccount ID of this site. This is a read-only field that can be left blank. */ subaccountId?: string; /** - * Default video settings for new placements created under this site. This - * value will be used to populate the placements.videoSettings field, when - * no value is specified for the new placement. + * Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. */ videoSettings?: Schema$SiteVideoSettings; } @@ -6800,8 +5638,7 @@ export namespace dfareporting_v3_3 { */ companionsDisabled?: boolean; /** - * Whitelist of companion sizes to be served via this site template. Set - * this list to null or empty to serve all companion sizes. + * Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. */ enabledSizes?: Schema$Size[]; /** @@ -6809,8 +5646,7 @@ export namespace dfareporting_v3_3 { */ imageOnly?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#siteCompanionSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". */ kind?: string; } @@ -6860,10 +5696,7 @@ export namespace dfareporting_v3_3 { */ activeViewOptOut?: boolean; /** - * Whether this site opts out of ad blocking. When true, ad blocking is - * disabled for all placements under the site, regardless of the individual - * placement settings. When false, the campaign and placement settings take - * effect. + * Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. */ adBlockingOptOut?: boolean; /** @@ -6875,22 +5708,11 @@ export namespace dfareporting_v3_3 { */ tagSetting?: Schema$TagSetting; /** - * Whether Verification and ActiveView for in-stream video creatives are - * disabled by default for new placements created under this site. This - * value will be used to populate the placement.videoActiveViewOptOut field, - * when no value is specified for the new placement. + * Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. */ videoActiveViewOptOutTemplate?: boolean; /** - * Default VPAID adapter setting for new placements created under this site. - * This value will be used to populate the placements.vpaidAdapterChoice - * field, when no value is specified for the new placement. Controls which - * VPAID format the measurement adapter will use for in-stream video - * creatives assigned to the placement. The publisher's specifications - * will typically determine this setting. For VPAID creatives, the adapter - * format will match the VPAID format (HTML5 VPAID creatives use the HTML5 - * adapter). Note: Flash is no longer supported. This field now defaults to - * HTML5 when the following values are provided: FLASH, BOTH. + * Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. */ vpaidAdapterChoiceTemplate?: string; } @@ -6899,23 +5721,19 @@ export namespace dfareporting_v3_3 { */ export interface Schema$SiteSkippableSetting { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#siteSkippableSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". */ kind?: string; /** - * Amount of time to play videos served to this site template before - * counting a view. Applicable when skippable is true. + * Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. */ progressOffset?: Schema$VideoOffset; /** - * Amount of time to play videos served to this site before the skip button - * should appear. Applicable when skippable is true. + * Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. */ skipOffset?: Schema$VideoOffset; /** - * Whether the user can skip creatives served to this site. This will act as - * default for new placements created under this site. + * Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. */ skippable?: boolean; } @@ -6924,8 +5742,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$SitesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sitesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". */ kind?: string; /** @@ -6942,13 +5759,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$SiteTranscodeSetting { /** - * Whitelist of video formats to be served to this site template. Set this - * list to null or empty to serve all video formats. + * Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. */ enabledVideoFormats?: number[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#siteTranscodeSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". */ kind?: string; } @@ -6957,34 +5772,28 @@ export namespace dfareporting_v3_3 { */ export interface Schema$SiteVideoSettings { /** - * Settings for the companion creatives of video creatives served to this - * site. + * Settings for the companion creatives of video creatives served to this site. */ companionSettings?: Schema$SiteCompanionSetting; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#siteVideoSettings". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". */ kind?: string; /** - * Orientation of a site template used for video. This will act as default - * for new placements created under this site. + * Orientation of a site template used for video. This will act as default for new placements created under this site. */ orientation?: string; /** - * Settings for the skippability of video creatives served to this site. - * This will act as default for new placements created under this site. + * Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. */ skippableSettings?: Schema$SiteSkippableSetting; /** - * Settings for the transcodes of video creatives served to this site. This - * will act as default for new placements created under this site. + * Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. */ transcodeSettings?: Schema$SiteTranscodeSetting; } /** - * Represents the dimensions of ads, placements, creatives, or creative - * assets. + * Represents the dimensions of ads, placements, creatives, or creative assets. */ export interface Schema$Size { /** @@ -7000,8 +5809,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#size". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". */ kind?: string; /** @@ -7014,8 +5822,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$SizesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sizesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". */ kind?: string; /** @@ -7028,18 +5835,15 @@ export namespace dfareporting_v3_3 { */ export interface Schema$SkippableSetting { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#skippableSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". */ kind?: string; /** - * Amount of time to play videos served to this placement before counting a - * view. Applicable when skippable is true. + * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. */ progressOffset?: Schema$VideoOffset; /** - * Amount of time to play videos served to this placement before the skip - * button should appear. Applicable when skippable is true. + * Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. */ skipOffset?: Schema$VideoOffset; /** @@ -7069,8 +5873,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$Subaccount { /** - * ID of the account that contains this subaccount. This is a read-only - * field that can be left blank. + * ID of the account that contains this subaccount. This is a read-only field that can be left blank. */ accountId?: string; /** @@ -7082,13 +5885,11 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccount". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". */ kind?: string; /** - * Name of this subaccount. This is a required field. Must be less than 128 - * characters long and be unique among subaccounts of the same account. + * Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. */ name?: string; } @@ -7097,8 +5898,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$SubaccountsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccountsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". */ kind?: string; /** @@ -7115,8 +5915,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$TagData { /** - * Ad associated with this placement tag. Applicable only when format is - * PLACEMENT_TAG_TRACKING. + * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ adId?: string; /** @@ -7124,8 +5923,7 @@ export namespace dfareporting_v3_3 { */ clickTag?: string; /** - * Creative associated with this placement tag. Applicable only when format - * is PLACEMENT_TAG_TRACKING. + * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. */ creativeId?: string; /** @@ -7142,15 +5940,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$TagSetting { /** - * Additional key-values to be included in tags. Each key-value pair must be - * of the form key=value, and pairs must be separated by a semicolon (;). - * Keys and values must not contain commas. For example, id=2;color=red is a - * valid value for this field. + * Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. */ additionalKeyValues?: string; /** - * Whether static landing page URLs should be included in the tags. This - * setting applies only to placements. + * Whether static landing page URLs should be included in the tags. This setting applies only to placements. */ includeClickThroughUrls?: boolean; /** @@ -7158,10 +5952,7 @@ export namespace dfareporting_v3_3 { */ includeClickTracking?: boolean; /** - * Option specifying how keywords are embedded in ad tags. This setting can - * be used to specify whether keyword placeholders are inserted in placement - * tags for this site. Publishers can then add keywords to those - * placeholders. + * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. */ keywordOption?: string; } @@ -7179,19 +5970,11 @@ export namespace dfareporting_v3_3 { imageTagEnabled?: boolean; } /** - * Contains properties of a targetable remarketing list. Remarketing enables - * you to create lists of users who have performed specific actions on a site, - * then target ads to members of those lists. This resource is a read-only - * view of a remarketing list to be used to faciliate targeting ads to - * specific lists. Remarketing lists that are owned by your advertisers and - * those that are shared to your advertisers or account are accessible via - * this resource. To manage remarketing lists that are owned by your - * advertisers, use the RemarketingLists resource. + * Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource. */ export interface Schema$TargetableRemarketingList { /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ accountId?: string; /** @@ -7199,8 +5982,7 @@ export namespace dfareporting_v3_3 { */ active?: boolean; /** - * Dimension value for the advertiser ID that owns this targetable - * remarketing list. + * Dimension value for the advertiser ID that owns this targetable remarketing list. */ advertiserId?: string; /** @@ -7216,13 +5998,11 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingList". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". */ kind?: string; /** - * Number of days that a user should remain in the targetable remarketing - * list without an impression. + * Number of days that a user should remain in the targetable remarketing list without an impression. */ lifeSpan?: string; /** @@ -7234,13 +6014,11 @@ export namespace dfareporting_v3_3 { */ listSource?: string; /** - * Name of the targetable remarketing list. Is no greater than 128 - * characters long. + * Name of the targetable remarketing list. Is no greater than 128 characters long. */ name?: string; /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. */ subaccountId?: string; } @@ -7249,8 +6027,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$TargetableRemarketingListsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingListsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". */ kind?: string; /** @@ -7263,23 +6040,19 @@ export namespace dfareporting_v3_3 { targetableRemarketingLists?: Schema$TargetableRemarketingList[]; } /** - * Contains properties of a targeting template. A targeting template - * encapsulates targeting information which can be reused across multiple ads. + * Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. */ export interface Schema$TargetingTemplate { /** - * Account ID of this targeting template. This field, if left unset, will be - * auto-generated on insert and is read-only after insert. + * Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. */ accountId?: string; /** - * Advertiser ID of this targeting template. This is a required field on - * insert and is read-only after insert. + * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. */ advertiserId?: string; /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. */ advertiserIdDimensionValue?: Schema$DimensionValue; /** @@ -7299,8 +6072,7 @@ export namespace dfareporting_v3_3 { */ keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplate". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". */ kind?: string; /** @@ -7312,13 +6084,11 @@ export namespace dfareporting_v3_3 { */ listTargetingExpression?: Schema$ListTargetingExpression; /** - * Name of this targeting template. This field is required. It must be less - * than 256 characters long and unique within an advertiser. + * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. */ name?: string; /** - * Subaccount ID of this targeting template. This field, if left unset, will - * be auto-generated on insert and is read-only after insert. + * Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. */ subaccountId?: string; /** @@ -7331,8 +6101,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$TargetingTemplatesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplatesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". */ kind?: string; /** @@ -7353,8 +6122,7 @@ export namespace dfareporting_v3_3 { */ customHtml?: string; /** - * Type of browser window for which the backup image of the flash creative - * can be displayed. + * Type of browser window for which the backup image of the flash creative can be displayed. */ targetWindowOption?: string; } @@ -7363,45 +6131,27 @@ export namespace dfareporting_v3_3 { */ export interface Schema$TechnologyTargeting { /** - * Browsers that this ad targets. For each browser either set - * browserVersionId or dartId along with the version numbers. If both are - * specified, only browserVersionId will be used. The other fields are - * populated automatically when the ad is inserted or updated. + * Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. */ browsers?: Schema$Browser[]; /** - * Connection types that this ad targets. For each connection type only id - * is required. The other fields are populated automatically when the ad is - * inserted or updated. + * Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. */ connectionTypes?: Schema$ConnectionType[]; /** - * Mobile carriers that this ad targets. For each mobile carrier only id is - * required, and the other fields are populated automatically when the ad is - * inserted or updated. If targeting a mobile carrier, do not set targeting - * for any zip codes. + * Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. */ mobileCarriers?: Schema$MobileCarrier[]; /** - * Operating systems that this ad targets. To target specific versions, use - * operatingSystemVersions. For each operating system only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system, do not set - * targeting for operating system versions for the same operating system. + * Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. */ operatingSystems?: Schema$OperatingSystem[]; /** - * Operating system versions that this ad targets. To target all versions, - * use operatingSystems. For each operating system version, only id is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system version, do not set - * targeting for the corresponding operating system in operatingSystems. + * Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. */ operatingSystemVersions?: Schema$OperatingSystemVersion[]; /** - * Platform types that this ad targets. For example, desktop, mobile, or - * tablet. For each platform type, only id is required, and the other fields - * are populated automatically when the ad is inserted or updated. + * Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. */ platformTypes?: Schema$PlatformType[]; } @@ -7414,8 +6164,7 @@ export namespace dfareporting_v3_3 { */ name?: string; /** - * Value of the third-party authentication token. This is a read-only, - * auto-generated field. + * Value of the third-party authentication token. This is a read-only, auto-generated field. */ value?: string; } @@ -7437,19 +6186,16 @@ export namespace dfareporting_v3_3 { */ export interface Schema$TranscodeSetting { /** - * Whitelist of video formats to be served to this placement. Set this list - * to null or empty to serve all video formats. + * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. */ enabledVideoFormats?: number[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#transcodeSetting". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". */ kind?: string; } /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. */ export interface Schema$UniversalAdId { /** @@ -7457,9 +6203,7 @@ export namespace dfareporting_v3_3 { */ registry?: string; /** - * ID value for this creative. Only alphanumeric characters and the - * following symbols are valid: "_/\-". Maximum length is 64 - * characters. Read only when registry is DCM. + * ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. */ value?: string; } @@ -7472,9 +6216,7 @@ export namespace dfareporting_v3_3 { */ dataType?: string; /** - * User-friendly name for the variable which will appear in reports. This is - * a required field, must be less than 64 characters long, and cannot - * contain the following characters: ""<>". + * User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>". */ reportName?: string; /** @@ -7541,14 +6283,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$UserRole { /** - * Account ID of this user role. This is a read-only field that can be left - * blank. + * Account ID of this user role. This is a read-only field that can be left blank. */ accountId?: string; /** - * Whether this is a default user role. Default user roles are created by - * the system for the account/subaccount and cannot be modified or deleted. - * Each default user role comes with a basic set of preassigned permissions. + * Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. */ defaultUserRole?: boolean; /** @@ -7556,21 +6295,15 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRole". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". */ kind?: string; /** - * Name of this user role. This is a required field. Must be less than 256 - * characters long. If this user role is under a subaccount, the name must - * be unique among sites of the same subaccount. Otherwise, this user role - * is a top-level user role, and the name must be unique among top-level - * user roles of the same account. + * Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. */ name?: string; /** - * ID of the user role that this user role is based on or copied from. This - * is a required field. + * ID of the user role that this user role is based on or copied from. This is a required field. */ parentUserRoleId?: string; /** @@ -7578,8 +6311,7 @@ export namespace dfareporting_v3_3 { */ permissions?: Schema$UserRolePermission[]; /** - * Subaccount ID of this user role. This is a read-only field that can be - * left blank. + * Subaccount ID of this user role. This is a read-only field that can be left blank. */ subaccountId?: string; } @@ -7596,8 +6328,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermission". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". */ kind?: string; /** @@ -7618,8 +6349,7 @@ export namespace dfareporting_v3_3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroup". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". */ kind?: string; /** @@ -7632,8 +6362,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$UserRolePermissionGroupsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroupsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". */ kind?: string; /** @@ -7646,8 +6375,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$UserRolePermissionsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". */ kind?: string; /** @@ -7660,8 +6388,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$UserRolesListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolesListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". */ kind?: string; /** @@ -7686,8 +6413,7 @@ export namespace dfareporting_v3_3 { */ id?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormat". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". */ kind?: string; /** @@ -7704,8 +6430,7 @@ export namespace dfareporting_v3_3 { */ export interface Schema$VideoFormatsListResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormatsListResponse". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". */ kind?: string; /** @@ -7718,13 +6443,11 @@ export namespace dfareporting_v3_3 { */ export interface Schema$VideoOffset { /** - * Duration, as a percentage of video duration. Do not set when - * offsetSeconds is set. Acceptable values are 0 to 100, inclusive. + * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. */ offsetPercentage?: number; /** - * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable - * values are 0 to 86399, inclusive. + * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. */ offsetSeconds?: number; } @@ -7733,30 +6456,23 @@ export namespace dfareporting_v3_3 { */ export interface Schema$VideoSettings { /** - * Settings for the companion creatives of video creatives served to this - * placement. + * Settings for the companion creatives of video creatives served to this placement. */ companionSettings?: Schema$CompanionSetting; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoSettings". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". */ kind?: string; /** - * Orientation of a video placement. If this value is set, placement will - * return assets matching the specified orientation. + * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. */ orientation?: string; /** - * Settings for the skippability of video creatives served to this - * placement. If this object is provided, the creative-level skippable - * settings will be overridden. + * Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. */ skippableSettings?: Schema$SkippableSetting; /** - * Settings for the transcodes of video creatives served to this placement. - * If this object is provided, the creative-level transcode settings will be - * overridden. + * Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden. */ transcodeSettings?: Schema$TranscodeSetting; } @@ -8334,8 +7050,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.accounts.list - * @desc Retrieves the list of accounts, possibly filtered. This method - * supports paging. + * @desc Retrieves the list of accounts, possibly filtered. This method supports paging. * @alias dfareporting.accounts.list * @memberOf! () * @@ -8580,8 +7295,7 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only active accounts. Don't set this field to select both active - * and non-active accounts. + * Select only active accounts. Don't set this field to select both active and non-active accounts. */ active?: boolean; /** @@ -8601,12 +7315,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "account*2015" will return objects with names like "account - * June 2015", "account April 2015", or simply "account 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "account" will match - * objects with name "my account", "account 2015", or simply "account". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". */ searchString?: string; /** @@ -8813,8 +7522,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.accountUserProfiles.list - * @desc Retrieves a list of account user profiles, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging. * @alias dfareporting.accountUserProfiles.list * @memberOf! () * @@ -8906,8 +7614,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.accountUserProfiles.patch - * @desc Updates an existing account user profile. This method supports - * patch semantics. + * @desc Updates an existing account user profile. This method supports patch semantics. * @alias dfareporting.accountUserProfiles.patch * @memberOf! () * @@ -9118,13 +7825,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name, ID or email. Wildcards (*) are - * allowed. For example, "user profile*2015" will return objects with names - * like "user profile June 2015", "user profile April 2015", or simply "user - * profile 2015". Most of the searches also add wildcards implicitly at the - * start and the end of the search string. For example, a search string of - * "user profile" will match objects with name "my user profile", "user - * profile 2015", or simply "user profile". + * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". */ searchString?: string; /** @@ -9333,8 +8034,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.ads.list - * @desc Retrieves a list of ads, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of ads, possibly filtered. This method supports paging. * @alias dfareporting.ads.list * @memberOf! () * @@ -9629,12 +8329,7 @@ export namespace dfareporting_v3_3 { */ campaignIds?: string[]; /** - * Select default ads with the specified compatibility. Applicable when type - * is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop or on mobile devices for regular or - * interstitial ads, respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an - * in-stream video ads developed with the VAST standard. + * Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. */ compatibility?: string; /** @@ -9646,9 +8341,7 @@ export namespace dfareporting_v3_3 { */ creativeOptimizationConfigurationIds?: string[]; /** - * Select only dynamic click trackers. Applicable when type is - * AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If - * false, select static click trackers. Leave unset to select both. + * Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. */ dynamicClickTracker?: boolean; /** @@ -9680,17 +8373,11 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Select only ads whose list targeting expression use these remarketing - * list IDs. + * Select only ads whose list targeting expression use these remarketing list IDs. */ remarketingListIds?: string[]; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "ad*2015" will return objects with names like "ad June - * 2015", "ad April 2015", or simply "ad 2015". Most of the searches also - * add wildcards implicitly at the start and the end of the search string. - * For example, a search string of "ad" will match objects with name "my - * ad", "ad 2015", or simply "ad". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". */ searchString?: string; /** @@ -9986,8 +8673,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.advertiserGroups.list - * @desc Retrieves a list of advertiser groups, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging. * @alias dfareporting.advertiserGroups.list * @memberOf! () * @@ -10076,8 +8762,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.advertiserGroups.patch - * @desc Updates an existing advertiser group. This method supports patch - * semantics. + * @desc Updates an existing advertiser group. This method supports patch semantics. * @alias dfareporting.advertiserGroups.patch * @memberOf! () * @@ -10300,13 +8985,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser group June 2015", "advertiser group April 2015", or simply - * "advertiser group 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "advertisergroup" will match objects with name "my - * advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". */ searchString?: string; /** @@ -10608,8 +9287,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.advertiserLandingPages.patch - * @desc Updates an existing landing page. This method supports patch - * semantics. + * @desc Updates an existing landing page. This method supports patch semantics. * @alias dfareporting.advertiserLandingPages.patch * @memberOf! () * @@ -10804,8 +9482,7 @@ export namespace dfareporting_v3_3 { */ advertiserIds?: string[]; /** - * Select only archived landing pages. Don't set this field to select both - * archived and non-archived landing pages. + * Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. */ archived?: boolean; /** @@ -10829,13 +9506,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for landing pages by name or ID. Wildcards (*) are - * allowed. For example, "landingpage*2017" will return landing pages with - * names like "landingpage July 2017", "landingpage March 2017", or simply - * "landingpage 2017". Most of the searches also add wildcards implicitly at - * the start and the end of the search string. For example, a search string - * of "landingpage" will match campaigns with name "my landingpage", - * "landingpage 2015", or simply "landingpage". + * Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". */ searchString?: string; /** @@ -11047,8 +9718,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.advertisers.list - * @desc Retrieves a list of advertisers, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of advertisers, possibly filtered. This method supports paging. * @alias dfareporting.advertisers.list * @memberOf! () * @@ -11135,8 +9805,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.advertisers.patch - * @desc Updates an existing advertiser. This method supports patch - * semantics. + * @desc Updates an existing advertiser. This method supports patch semantics. * @alias dfareporting.advertisers.patch * @memberOf! () * @@ -11345,8 +10014,7 @@ export namespace dfareporting_v3_3 { */ maxResults?: number; /** - * Select only advertisers which use another advertiser's floodlight - * configuration. + * Select only advertisers which use another advertiser's floodlight configuration. */ onlyParent?: boolean; /** @@ -11358,13 +10026,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser June 2015", "advertiser April 2015", or simply "advertiser - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "advertiser" will match objects with name "my advertiser", "advertiser - * 2015", or simply "advertiser". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". */ searchString?: string; /** @@ -11524,9 +10186,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.campaignCreativeAssociations.insert - * @desc Associates a creative with the specified campaign. This method - * creates a default ad with dimensions matching the creative in the - * campaign if such a default ad does not exist already. + * @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. * @alias dfareporting.campaignCreativeAssociations.insert * @memberOf! () * @@ -11609,8 +10269,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.campaignCreativeAssociations.list - * @desc Retrieves the list of creative IDs associated with the specified - * campaign. This method supports paging. + * @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. * @alias dfareporting.campaignCreativeAssociations.list * @memberOf! () * @@ -11905,8 +10564,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.campaigns.list - * @desc Retrieves a list of campaigns, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of campaigns, possibly filtered. This method supports paging. * @alias dfareporting.campaigns.list * @memberOf! () * @@ -12173,8 +10831,7 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only campaigns whose advertisers belong to these advertiser - * groups. + * Select only campaigns whose advertisers belong to these advertiser groups. */ advertiserGroupIds?: string[]; /** @@ -12182,8 +10839,7 @@ export namespace dfareporting_v3_3 { */ advertiserIds?: string[]; /** - * Select only archived campaigns. Don't set this field to select both - * archived and non-archived campaigns. + * Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. */ archived?: boolean; /** @@ -12215,13 +10871,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. - * For example, "campaign*2015" will return campaigns with names like - * "campaign June 2015", "campaign April 2015", or simply "campaign 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "campaign" will - * match campaigns with name "my campaign", "campaign 2015", or simply - * "campaign". + * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". */ searchString?: string; /** @@ -12469,12 +11119,7 @@ export namespace dfareporting_v3_3 { */ ids?: string[]; /** - * Select only change logs whose change time is before the specified - * maxChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. + * Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. */ maxChangeTime?: string; /** @@ -12482,12 +11127,7 @@ export namespace dfareporting_v3_3 { */ maxResults?: number; /** - * Select only change logs whose change time is before the specified - * minChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. + * Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. */ minChangeTime?: string; /** @@ -12507,8 +11147,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Select only change logs whose object ID, user name, old or new values - * match the search string. + * Select only change logs whose object ID, user name, old or new values match the search string. */ searchString?: string; /** @@ -13051,8 +11690,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.contentCategories.list - * @desc Retrieves a list of content categories, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of content categories, possibly filtered. This method supports paging. * @alias dfareporting.contentCategories.list * @memberOf! () * @@ -13141,8 +11779,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.contentCategories.patch - * @desc Updates an existing content category. This method supports patch - * semantics. + * @desc Updates an existing content category. This method supports patch semantics. * @alias dfareporting.contentCategories.patch * @memberOf! () * @@ -13365,13 +12002,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "contentcategory*2015" will return objects with names like - * "contentcategory June 2015", "contentcategory April 2015", or simply - * "contentcategory 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "contentcategory" will match objects with name "my - * contentcategory", "contentcategory 2015", or simply "contentcategory". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". */ searchString?: string; /** @@ -14172,8 +12803,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.creativeFields.list - * @desc Retrieves a list of creative fields, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creative fields, possibly filtered. This method supports paging. * @alias dfareporting.creativeFields.list * @memberOf! () * @@ -14261,8 +12891,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.creativeFields.patch - * @desc Updates an existing creative field. This method supports patch - * semantics. + * @desc Updates an existing creative field. This method supports patch semantics. * @alias dfareporting.creativeFields.patch * @memberOf! () * @@ -14489,13 +13118,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for creative fields by name or ID. Wildcards (*) are - * allowed. For example, "creativefield*2015" will return creative fields - * with names like "creativefield June 2015", "creativefield April 2015", or - * simply "creativefield 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativefield" will match creative fields with the name - * "my creativefield", "creativefield 2015", or simply "creativefield". + * Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". */ searchString?: string; /** @@ -14780,8 +13403,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.creativeFieldValues.list - * @desc Retrieves a list of creative field values, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of creative field values, possibly filtered. This method supports paging. * @alias dfareporting.creativeFieldValues.list * @memberOf! () * @@ -14871,8 +13493,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.creativeFieldValues.patch - * @desc Updates an existing creative field value. This method supports - * patch semantics. + * @desc Updates an existing creative field value. This method supports patch semantics. * @alias dfareporting.creativeFieldValues.patch * @memberOf! () * @@ -15113,8 +13734,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for creative field values by their values. Wildcards - * (e.g. *) are not allowed. + * Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. */ searchString?: string; /** @@ -15331,8 +13951,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.creativeGroups.list - * @desc Retrieves a list of creative groups, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creative groups, possibly filtered. This method supports paging. * @alias dfareporting.creativeGroups.list * @memberOf! () * @@ -15421,8 +14040,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.creativeGroups.patch - * @desc Updates an existing creative group. This method supports patch - * semantics. + * @desc Updates an existing creative group. This method supports patch semantics. * @alias dfareporting.creativeGroups.patch * @memberOf! () * @@ -15637,13 +14255,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for creative groups by name or ID. Wildcards (*) are - * allowed. For example, "creativegroup*2015" will return creative groups - * with names like "creativegroup June 2015", "creativegroup April 2015", or - * simply "creativegroup 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativegroup" will match creative groups with the name - * "my creativegroup", "creativegroup 2015", or simply "creativegroup". + * Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". */ searchString?: string; /** @@ -15845,8 +14457,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.creatives.list - * @desc Retrieves a list of creatives, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of creatives, possibly filtered. This method supports paging. * @alias dfareporting.creatives.list * @memberOf! () * @@ -16116,8 +14727,7 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only active creatives. Leave blank to select active and inactive - * creatives. + * Select only active creatives. Leave blank to select active and inactive creatives. */ active?: boolean; /** @@ -16125,8 +14735,7 @@ export namespace dfareporting_v3_3 { */ advertiserId?: string; /** - * Select only archived creatives. Leave blank to select archived and - * unarchived creatives. + * Select only archived creatives. Leave blank to select archived and unarchived creatives. */ archived?: boolean; /** @@ -16162,13 +14771,7 @@ export namespace dfareporting_v3_3 { */ renderingIds?: string[]; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "creative*2015" will return objects with names like - * "creative June 2015", "creative April 2015", or simply "creative 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "creative" will - * match objects with name "my creative", "creative 2015", or simply - * "creative". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". */ searchString?: string; /** @@ -16497,8 +15100,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.directorySites.list - * @desc Retrieves a list of directory sites, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of directory sites, possibly filtered. This method supports paging. * @alias dfareporting.directorySites.list * @memberOf! () * @@ -16630,23 +15232,19 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInStreamVideoPlacements?: boolean; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInterstitialPlacements?: boolean; /** - * Select only directory sites that accept publisher paid placements. This - * field can be left blank. + * Select only directory sites that accept publisher paid placements. This field can be left blank. */ acceptsPublisherPaidPlacements?: boolean; /** - * Select only active directory sites. Leave blank to retrieve both active - * and inactive directory sites. + * Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. */ active?: boolean; /** @@ -16670,13 +15268,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name, ID or URL. Wildcards (*) are - * allowed. For example, "directory site*2015" will return objects with - * names like "directory site June 2015", "directory site April 2015", or - * simply "directory site 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "directory site" will match objects with name "my - * directory site", "directory site 2015" or simply, "directory site". + * Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". */ searchString?: string; /** @@ -16772,11 +15364,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.dynamicTargetingKeys.insert - * @desc Inserts a new dynamic targeting key. Keys must be created at the - * advertiser level before being assigned to the advertiser's ads, - * creatives, or placements. There is a maximum of 1000 keys per advertiser, - * out of which a maximum of 20 keys can be assigned per ad, creative, or - * placement. + * @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. * @alias dfareporting.dynamicTargetingKeys.insert * @memberOf! () * @@ -16945,9 +15533,7 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. */ name?: string; /** @@ -16955,8 +15541,7 @@ export namespace dfareporting_v3_3 { */ objectId?: string; /** - * Type of the object of this dynamic targeting key. This is a required - * field. + * Type of the object of this dynamic targeting key. This is a required field. */ objectType?: string; /** @@ -17317,8 +15902,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.eventTags.patch - * @desc Updates an existing event tag. This method supports patch - * semantics. + * @desc Updates an existing event tag. This method supports patch semantics. * @alias dfareporting.eventTags.patch * @memberOf! () * @@ -17525,29 +16109,15 @@ export namespace dfareporting_v3_3 { */ campaignId?: string; /** - * Examine only the specified campaign or advertiser's event tags for - * matching selector criteria. When set to false, the parent advertiser and - * parent campaign of the specified ad or campaign is examined as well. In - * addition, when set to false, the status field is examined as well, along - * with the enabledByDefault field. This parameter can not be set to true - * when adId is specified as ads do not define their own even tags. + * Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. */ definitionsOnly?: boolean; /** - * Select only enabled event tags. What is considered enabled or disabled - * depends on the definitionsOnly parameter. When definitionsOnly is set to - * true, only the specified advertiser or campaign's event tags' - * enabledByDefault field is examined. When definitionsOnly is set to false, - * the specified ad or specified campaign's parent advertiser's or parent - * campaign's event tags' enabledByDefault and status fields are examined as - * well. + * Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. */ enabled?: boolean; /** - * Select only event tags with the specified event tag types. Event tag - * types can be used to specify whether to use a third-party pixel, a - * third-party JavaScript URL, or a third-party click-through URL for either - * impression or click tracking. + * Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. */ eventTagTypes?: string[]; /** @@ -17559,13 +16129,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "eventtag*2015" will return objects with names like - * "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "eventtag" will - * match objects with name "my eventtag", "eventtag 2015", or simply - * "eventtag". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". */ searchString?: string; /** @@ -17622,8 +16186,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.files.get - * @desc Retrieves a report file by its report ID and file ID. This method - * supports media download. + * @desc Retrieves a report file by its report ID and file ID. This method supports media download. * @alias dfareporting.files.get * @memberOf! () * @@ -18138,8 +16701,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.floodlightActivities.list - * @desc Retrieves a list of floodlight activities, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging. * @alias dfareporting.floodlightActivities.list * @memberOf! () * @@ -18235,8 +16797,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.floodlightActivities.patch - * @desc Updates an existing floodlight activity. This method supports patch - * semantics. + * @desc Updates an existing floodlight activity. This method supports patch semantics. * @alias dfareporting.floodlightActivities.patch * @memberOf! () * @@ -18459,41 +17020,31 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only floodlight activities for the specified advertiser ID. Must - * specify either ids, advertiserId, or floodlightConfigurationId for a - * non-empty result. + * Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ advertiserId?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group IDs. + * Select only floodlight activities with the specified floodlight activity group IDs. */ floodlightActivityGroupIds?: string[]; /** - * Select only floodlight activities with the specified floodlight activity - * group name. + * Select only floodlight activities with the specified floodlight activity group name. */ floodlightActivityGroupName?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group tag string. + * Select only floodlight activities with the specified floodlight activity group tag string. */ floodlightActivityGroupTagString?: string; /** - * Select only floodlight activities with the specified floodlight activity - * group type. + * Select only floodlight activities with the specified floodlight activity group type. */ floodlightActivityGroupType?: string; /** - * Select only floodlight activities for the specified floodlight - * configuration ID. Must specify either ids, advertiserId, or - * floodlightConfigurationId for a non-empty result. + * Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ floodlightConfigurationId?: string; /** - * Select only floodlight activities with the specified IDs. Must specify - * either ids, advertiserId, or floodlightConfigurationId for a non-empty - * result. + * Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. */ ids?: string[]; /** @@ -18509,14 +17060,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivity*2015" will return objects with names - * like "floodlightactivity June 2015", "floodlightactivity April 2015", or - * simply "floodlightactivity 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "floodlightactivity" will match objects with name "my - * floodlightactivity activity", "floodlightactivity 2015", or simply - * "floodlightactivity". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". */ searchString?: string; /** @@ -18735,8 +17279,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.floodlightActivityGroups.list - * @desc Retrieves a list of floodlight activity groups, possibly filtered. - * This method supports paging. + * @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. * @alias dfareporting.floodlightActivityGroups.list * @memberOf! () * @@ -18836,8 +17379,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.floodlightActivityGroups.patch - * @desc Updates an existing floodlight activity group. This method supports - * patch semantics. + * @desc Updates an existing floodlight activity group. This method supports patch semantics. * @alias dfareporting.floodlightActivityGroups.patch * @memberOf! () * @@ -19034,21 +17576,15 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only floodlight activity groups with the specified advertiser ID. - * Must specify either advertiserId or floodlightConfigurationId for a - * non-empty result. + * Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. */ advertiserId?: string; /** - * Select only floodlight activity groups with the specified floodlight - * configuration ID. Must specify either advertiserId, or - * floodlightConfigurationId for a non-empty result. + * Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. */ floodlightConfigurationId?: string; /** - * Select only floodlight activity groups with the specified IDs. Must - * specify either advertiserId or floodlightConfigurationId for a non-empty - * result. + * Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. */ ids?: string[]; /** @@ -19064,14 +17600,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivitygroup*2015" will return objects with - * names like "floodlightactivitygroup June 2015", "floodlightactivitygroup - * April 2015", or simply "floodlightactivitygroup 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "floodlightactivitygroup" - * will match objects with name "my floodlightactivitygroup activity", - * "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". */ searchString?: string; /** @@ -19083,8 +17612,7 @@ export namespace dfareporting_v3_3 { */ sortOrder?: string; /** - * Select only floodlight activity groups with the specified floodlight - * activity group type. + * Select only floodlight activity groups with the specified floodlight activity group type. */ type?: string; } @@ -19304,8 +17832,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.floodlightConfigurations.patch - * @desc Updates an existing floodlight configuration. This method supports - * patch semantics. + * @desc Updates an existing floodlight configuration. This method supports patch semantics. * @alias dfareporting.floodlightConfigurations.patch * @memberOf! () * @@ -19485,8 +18012,7 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set of IDs of floodlight configurations to retrieve. Required field; - * otherwise an empty list will be returned. + * Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. */ ids?: string[]; /** @@ -19617,8 +18143,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.inventoryItems.list - * @desc Retrieves a list of inventory items, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of inventory items, possibly filtered. This method supports paging. * @alias dfareporting.inventoryItems.list * @memberOf! () * @@ -20167,12 +18692,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "app*2015" will return objects with names like "app Jan - * 2018", "app Jan 2018", or simply "app 2018". Most of the searches also - * add wildcards implicitly at the start and the end of the search string. - * For example, a search string of "app" will match objects with name "my - * app", "app 2018", or simply "app". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". */ searchString?: string; } @@ -20845,8 +19365,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.orderDocuments.list - * @desc Retrieves a list of order documents, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of order documents, possibly filtered. This method supports paging. * @alias dfareporting.orderDocuments.list * @memberOf! () * @@ -20992,13 +19511,7 @@ export namespace dfareporting_v3_3 { */ projectId?: string; /** - * Allows searching for order documents by name or ID. Wildcards (*) are - * allowed. For example, "orderdocument*2015" will return order documents - * with names like "orderdocument June 2015", "orderdocument April 2015", or - * simply "orderdocument 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "orderdocument" will match order documents with name "my - * orderdocument", "orderdocument 2015", or simply "orderdocument". + * Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". */ searchString?: string; /** @@ -21096,8 +19609,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.orders.list - * @desc Retrieves a list of orders, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of orders, possibly filtered. This method supports paging. * @alias dfareporting.orders.list * @memberOf! () * @@ -21223,12 +19735,7 @@ export namespace dfareporting_v3_3 { */ projectId?: string; /** - * Allows searching for orders by name or ID. Wildcards (*) are allowed. For - * example, "order*2015" will return orders with names like "order June - * 2015", "order April 2015", or simply "order 2015". Most of the searches - * also add wildcards implicitly at the start and the end of the search - * string. For example, a search string of "order" will match orders with - * name "my order", "order 2015", or simply "order". + * Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". */ searchString?: string; /** @@ -21403,8 +19910,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.placementGroups.list - * @desc Retrieves a list of placement groups, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of placement groups, possibly filtered. This method supports paging. * @alias dfareporting.placementGroups.list * @memberOf! () * @@ -21504,8 +20010,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.placementGroups.patch - * @desc Updates an existing placement group. This method supports patch - * semantics. + * @desc Updates an existing placement group. This method supports patch semantics. * @alias dfareporting.placementGroups.patch * @memberOf! () * @@ -21700,8 +20205,7 @@ export namespace dfareporting_v3_3 { */ advertiserIds?: string[]; /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. + * Select only archived placements. Don't set this field to select both archived and non-archived placements. */ archived?: boolean; /** @@ -21709,13 +20213,11 @@ export namespace dfareporting_v3_3 { */ campaignIds?: string[]; /** - * Select only placement groups that are associated with these content - * categories. + * Select only placement groups that are associated with these content categories. */ contentCategoryIds?: string[]; /** - * Select only placement groups that are associated with these directory - * sites. + * Select only placement groups that are associated with these directory sites. */ directorySiteIds?: string[]; /** @@ -21723,8 +20225,7 @@ export namespace dfareporting_v3_3 { */ ids?: string[]; /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". */ maxEndDate?: string; /** @@ -21732,20 +20233,15 @@ export namespace dfareporting_v3_3 { */ maxResults?: number; /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". */ maxStartDate?: string; /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". */ minEndDate?: string; /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". */ minStartDate?: string; /** @@ -21753,17 +20249,11 @@ export namespace dfareporting_v3_3 { */ pageToken?: string; /** - * Select only placement groups belonging with this group type. A package is - * a simple group of placements that acts as a single pricing point for a - * group of tags. A roadblock is a group of placements that not only acts as - * a single pricing point but also assumes that all the tags in it will be - * served at the same time. A roadblock requires one of its assigned - * placements to be marked as primary for reporting. + * Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. */ placementGroupType?: string; /** - * Select only placement groups that are associated with these placement - * strategies. + * Select only placement groups that are associated with these placement strategies. */ placementStrategyIds?: string[]; /** @@ -21775,13 +20265,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for placement groups by name or ID. Wildcards (*) are - * allowed. For example, "placement*2015" will return placement groups with - * names like "placement group June 2015", "placement group May 2015", or - * simply "placements 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementgroup" will match placement groups with name - * "my placementgroup", "placementgroup 2015", or simply "placementgroup". + * Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". */ searchString?: string; /** @@ -22078,8 +20562,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.placements.list - * @desc Retrieves a list of placements, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of placements, possibly filtered. This method supports paging. * @alias dfareporting.placements.list * @memberOf! () * @@ -22175,8 +20658,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.placements.patch - * @desc Updates an existing placement. This method supports patch - * semantics. + * @desc Updates an existing placement. This method supports patch semantics. * @alias dfareporting.placements.patch * @memberOf! () * @@ -22343,8 +20825,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Tag formats to generate for these placements. Note: - * PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + * Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. */ tagFormats?: string[]; } @@ -22391,8 +20872,7 @@ export namespace dfareporting_v3_3 { */ advertiserIds?: string[]; /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. + * Select only archived placements. Don't set this field to select both archived and non-archived placements. */ archived?: boolean; /** @@ -22400,11 +20880,7 @@ export namespace dfareporting_v3_3 { */ campaignIds?: string[]; /** - * Select only placements that are associated with these compatibilities. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices for regular or interstitial ads respectively. APP and - * APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers - * to rendering in in-stream video ads developed with the VAST standard. + * Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. */ compatibilities?: string[]; /** @@ -22424,8 +20900,7 @@ export namespace dfareporting_v3_3 { */ ids?: string[]; /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". */ maxEndDate?: string; /** @@ -22433,20 +20908,15 @@ export namespace dfareporting_v3_3 { */ maxResults?: number; /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". */ maxStartDate?: string; /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". */ minEndDate?: string; /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". */ minStartDate?: string; /** @@ -22458,8 +20928,7 @@ export namespace dfareporting_v3_3 { */ paymentSource?: string; /** - * Select only placements that are associated with these placement - * strategies. + * Select only placements that are associated with these placement strategies. */ placementStrategyIds?: string[]; /** @@ -22471,13 +20940,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for placements by name or ID. Wildcards (*) are allowed. - * For example, "placement*2015" will return placements with names like - * "placement June 2015", "placement May 2015", or simply "placements 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "placement" - * will match placements with name "my placement", "placement 2015", or - * simply "placement". + * Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". */ searchString?: string; /** @@ -22766,8 +21229,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.placementStrategies.list - * @desc Retrieves a list of placement strategies, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging. * @alias dfareporting.placementStrategies.list * @memberOf! () * @@ -22856,8 +21318,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.placementStrategies.patch - * @desc Updates an existing placement strategy. This method supports patch - * semantics. + * @desc Updates an existing placement strategy. This method supports patch semantics. * @alias dfareporting.placementStrategies.patch * @memberOf! () * @@ -23080,14 +21541,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "placementstrategy*2015" will return objects with names like - * "placementstrategy June 2015", "placementstrategy April 2015", or simply - * "placementstrategy 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementstrategy" will match objects with name "my - * placementstrategy", "placementstrategy 2015", or simply - * "placementstrategy". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". */ searchString?: string; /** @@ -23593,8 +22047,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.projects.list - * @desc Retrieves a list of projects, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of projects, possibly filtered. This method supports paging. * @alias dfareporting.projects.list * @memberOf! () * @@ -23716,12 +22169,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for projects by name or ID. Wildcards (*) are allowed. - * For example, "project*2015" will return projects with names like "project - * June 2015", "project April 2015", or simply "project 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "project" will match - * projects with name "my project", "project 2015", or simply "project". + * Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". */ searchString?: string; /** @@ -23983,8 +22431,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.remarketingLists.list - * @desc Retrieves a list of remarketing lists, possibly filtered. This - * method supports paging. + * @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging. * @alias dfareporting.remarketingLists.list * @memberOf! () * @@ -24075,8 +22522,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.remarketingLists.patch - * @desc Updates an existing remarketing list. This method supports patch - * semantics. + * @desc Updates an existing remarketing list. This method supports patch semantics. * @alias dfareporting.remarketingLists.patch * @memberOf! () * @@ -24283,13 +22729,7 @@ export namespace dfareporting_v3_3 { */ maxResults?: number; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". */ name?: string; /** @@ -24433,8 +22873,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.remarketingListShares.patch - * @desc Updates an existing remarketing list share. This method supports - * patch semantics. + * @desc Updates an existing remarketing list share. This method supports patch semantics. * @alias dfareporting.remarketingListShares.patch * @memberOf! () * @@ -25312,9 +23751,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.reports.compatibleFields.query - * @desc Returns the fields that are compatible to be selected in the - * respective sections of a report criteria, given the fields already - * selected in the input report and user permissions. + * @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. * @alias dfareporting.reports.compatibleFields.query * @memberOf! () * @@ -25767,8 +24204,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.sites.list - * @desc Retrieves a list of sites, possibly filtered. This method supports - * paging. + * @desc Retrieves a list of sites, possibly filtered. This method supports paging. * @alias dfareporting.sites.list * @memberOf! () * @@ -26035,13 +24471,11 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInStreamVideoPlacements?: boolean; /** - * This search filter is no longer supported and will have no effect on the - * results returned. + * This search filter is no longer supported and will have no effect on the results returned. */ acceptsInterstitialPlacements?: boolean; /** @@ -26081,12 +24515,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name, ID or keyName. Wildcards (*) are - * allowed. For example, "site*2015" will return objects with names like - * "site June 2015", "site April 2015", or simply "site 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "site" will match objects - * with name "my site", "site 2015", or simply "site". + * Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". */ searchString?: string; /** @@ -26293,10 +24722,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.sizes.list - * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are - * globally unique and may include values not currently in use by your - * account. Due to this, the list of sizes returned by this method may - * differ from the list seen in the Trafficking UI. + * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. * @alias dfareporting.sizes.list * @memberOf! () * @@ -26587,8 +25013,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.subaccounts.list - * @desc Gets a list of subaccounts, possibly filtered. This method supports - * paging. + * @desc Gets a list of subaccounts, possibly filtered. This method supports paging. * @alias dfareporting.subaccounts.list * @memberOf! () * @@ -26669,8 +25094,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.subaccounts.patch - * @desc Updates an existing subaccount. This method supports patch - * semantics. + * @desc Updates an existing subaccount. This method supports patch semantics. * @alias dfareporting.subaccounts.patch * @memberOf! () * @@ -26875,13 +25299,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "subaccount*2015" will return objects with names like - * "subaccount June 2015", "subaccount April 2015", or simply "subaccount - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "subaccount" will match objects with name "my subaccount", "subaccount - * 2015", or simply "subaccount". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". */ searchString?: string; /** @@ -27020,8 +25438,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.targetableRemarketingLists.list - * @desc Retrieves a list of targetable remarketing lists, possibly - * filtered. This method supports paging. + * @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. * @alias dfareporting.targetableRemarketingLists.list * @memberOf! () * @@ -27154,13 +25571,7 @@ export namespace dfareporting_v3_3 { */ maxResults?: number; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". */ name?: string; /** @@ -27339,8 +25750,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.targetingTemplates.list - * @desc Retrieves a list of targeting templates, optionally filtered. This - * method supports paging. + * @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging. * @alias dfareporting.targetingTemplates.list * @memberOf! () * @@ -27430,8 +25840,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.targetingTemplates.patch - * @desc Updates an existing targeting template. This method supports patch - * semantics. + * @desc Updates an existing targeting template. This method supports patch semantics. * @alias dfareporting.targetingTemplates.patch * @memberOf! () * @@ -27642,13 +26051,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "template*2015" will return objects with names like - * "template June 2015", "template April 2015", or simply "template 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "template" will - * match objects with name "my template", "template 2015", or simply - * "template". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". */ searchString?: string; /** @@ -28496,8 +26899,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.userRoles.list - * @desc Retrieves a list of user roles, possibly filtered. This method - * supports paging. + * @desc Retrieves a list of user roles, possibly filtered. This method supports paging. * @alias dfareporting.userRoles.list * @memberOf! () * @@ -28579,8 +26981,7 @@ export namespace dfareporting_v3_3 { /** * dfareporting.userRoles.patch - * @desc Updates an existing user role. This method supports patch - * semantics. + * @desc Updates an existing user role. This method supports patch semantics. * @alias dfareporting.userRoles.patch * @memberOf! () * @@ -28775,8 +27176,7 @@ export namespace dfareporting_v3_3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Select only account level user roles not associated with any specific - * subaccount. + * Select only account level user roles not associated with any specific subaccount. */ accountUserRoleOnly?: boolean; /** @@ -28796,13 +27196,7 @@ export namespace dfareporting_v3_3 { */ profileId?: string; /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "userrole*2015" will return objects with names like - * "userrole June 2015", "userrole April 2015", or simply "userrole 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "userrole" will - * match objects with name "my userrole", "userrole 2015", or simply - * "userrole". + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". */ searchString?: string; /** diff --git a/src/apis/dialogflow/package.json b/src/apis/dialogflow/package.json index 4cf435cc3e3..bc54a77afbe 100644 --- a/src/apis/dialogflow/package.json +++ b/src/apis/dialogflow/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 8f43ea8a2d0..220bba4ca2b 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace dialogflow_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace dialogflow_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace dialogflow_v2 { /** * Dialogflow API * - * Builds conversational interfaces (for example, chatbots, and voice-powered - * apps and devices). + * Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace dialogflow_v2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,33 +122,19 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2Agent { /** - * Optional. The URI of the agent's avatar. Avatars are used throughout - * the Dialogflow console and in the self-hosted [Web - * Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo) - * integration. + * Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo) integration. */ avatarUri?: string; /** - * Optional. To filter out false positive results and still get variety in - * matched natural language inputs for your agent, you can tune the machine - * learning classification threshold. If the returned score value is less - * than the threshold value, then a fallback intent will be triggered or, if - * there are no fallback intents defined, no intent will be triggered. The - * score values range from 0.0 (completely uncertain) to 1.0 (completely - * certain). If set to 0.0, the default of 0.3 is used. + * Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. */ classificationThreshold?: number; /** - * Required. The default language of the agent as a language tag. See - * [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. This field cannot - * be set by the `Update` method. + * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. */ defaultLanguageCode?: string; /** - * Optional. The description of this agent. The maximum length is 500 - * characters. If exceeded, the request is rejected. + * Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. */ description?: string; /** @@ -166,19 +150,15 @@ export namespace dialogflow_v2 { */ matchMode?: string; /** - * Required. The project of this agent. Format: `projects/<Project - * ID>`. + * Required. The project of this agent. Format: `projects/<Project ID>`. */ parent?: string; /** - * Optional. The list of all languages supported by this agent (except for - * the `default_language_code`). + * Optional. The list of all languages supported by this agent (except for the `default_language_code`). */ supportedLanguageCodes?: string[]; /** - * Required. The time zone of this agent from the [time zone - * database](https://www.iana.org/time-zones), e.g., America/New_York, - * Europe/Paris. + * Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. */ timeZone?: string; } @@ -191,11 +171,7 @@ export namespace dialogflow_v2 { */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not - * specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; } @@ -204,17 +180,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2BatchDeleteEntitiesRequest { /** - * Required. The canonical `values` of the entities to delete. Note that - * these are not fully-qualified names, i.e. they don't start with - * `projects/<Project ID>`. + * Required. The canonical `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/<Project ID>`. */ entityValues?: string[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not - * specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; } @@ -223,8 +193,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest { /** - * Required. The names entity types to delete. All names must point to the - * same agent as `parent`. + * Required. The names entity types to delete. All names must point to the same agent as `parent`. */ entityTypeNames?: string[]; } @@ -233,8 +202,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2BatchDeleteIntentsRequest { /** - * Required. The collection of intents to delete. Only intent `name` must be - * filled in. + * Required. The collection of intents to delete. Only intent `name` must be filled in. */ intents?: Schema$GoogleCloudDialogflowV2Intent[]; } @@ -247,11 +215,7 @@ export namespace dialogflow_v2 { */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not - * specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -268,18 +232,11 @@ export namespace dialogflow_v2 { */ entityTypeBatchInline?: Schema$GoogleCloudDialogflowV2EntityTypeBatch; /** - * The URI to a Google Cloud Storage file containing entity types to update - * or create. The file format can either be a serialized proto (of - * EntityBatch type) or a JSON object. Note: The URI must start with - * "gs://". + * The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://". */ entityTypeBatchUri?: string; /** - * Optional. The language of entity synonyms defined in `entity_types`. If - * not specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entity_types`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -305,9 +262,7 @@ export namespace dialogflow_v2 { */ intentBatchInline?: Schema$GoogleCloudDialogflowV2IntentBatch; /** - * The URI to a Google Cloud Storage file containing intents to update or - * create. The file format can either be a serialized proto (of IntentBatch - * type) or JSON object. Note: The URI must start with "gs://". + * The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://". */ intentBatchUri?: string; /** @@ -315,12 +270,7 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages - * defined in `intents`. If not specified, the agent's default language - * is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intents`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -360,41 +310,24 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1Context { /** - * Optional. The number of conversational query requests after which the - * context expires. If set to `0` (the default) the context expires - * immediately. Contexts expire automatically after 20 minutes if there are - * no matching queries. + * Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. */ lifespanCount?: number; /** - * Required. The unique identifier of the context. Format: - * `projects/<Project ID>/agent/sessions/<Session - * ID>/contexts/<Context ID>`, or `projects/<Project - * ID>/agent/environments/<Environment ID>/users/<User - * ID>/sessions/<Session ID>/contexts/<Context ID>`. The - * `Context ID` is always converted to lowercase, may only contain - * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If - * `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' - * user. + * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; /** - * Optional. The collection of parameters associated with this context. - * Refer to [this - * doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) - * for syntax. + * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax. */ parameters?: {[key: string]: any}; } /** - * Represents an entity type. Entity types serve as a tool for extracting - * parameter values from natural language queries. + * Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. */ export interface Schema$GoogleCloudDialogflowV2beta1EntityType { /** - * Optional. Indicates whether the entity type can be automatically - * expanded. + * Optional. Indicates whether the entity type can be automatically expanded. */ autoExpansionMode?: string; /** @@ -402,8 +335,7 @@ export namespace dialogflow_v2 { */ displayName?: string; /** - * Optional. The collection of entity entries associated with the entity - * type. + * Optional. The collection of entity entries associated with the entity type. */ entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[]; /** @@ -411,10 +343,7 @@ export namespace dialogflow_v2 { */ kind?: string; /** - * The unique identifier of the entity type. Required for - * EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - * methods. Format: `projects/<Project - * ID>/agent/entityTypes/<Entity Type ID>`. + * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. */ name?: string; } @@ -423,36 +352,20 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity { /** - * Required. A collection of value synonyms. For example, if the entity type - * is *vegetable*, and `value` is *scallions*, a synonym could be *green - * onions*. For `KIND_LIST` entity types: * This collection must contain - * exactly one synonym equal to `value`. + * Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. */ synonyms?: string[]; /** - * Required. The primary value associated with this entity entry. For - * example, if the entity type is *vegetable*, the value could be - * *scallions*. For `KIND_MAP` entity types: * A canonical value to be - * used in place of synonyms. For `KIND_LIST` entity types: * A string - * that can contain references to other entity types (with or without - * aliases). + * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). */ value?: string; } /** - * Events allow for matching intents by event name instead of the natural - * language input. For instance, input `<event: { name: - * "welcome_event", parameters: { name: "Sam" } }>` can - * trigger a personalized welcome response. The parameter `name` may be used - * by the agent in the response: `"Hello #welcome_event.name! What can I - * do for you today?"`. + * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ export interface Schema$GoogleCloudDialogflowV2beta1EventInput { /** - * Required. The language of this query. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** @@ -469,38 +382,24 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentResponse { /** - * The exported agent. Example for how to export an agent to a zip file via - * a command line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary '{}' \ | grep agentContent | sed - * -e 's/.*"agentContent": - * "\([^"]*\)".x/\1/' \ | base64 --decode > - * &lt;agent zip file&gt;</pre> + * The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre> */ agentContent?: string; /** - * The URI to a file containing the exported agent. This field is populated - * only if `agent_uri` is specified in `ExportAgentRequest`. + * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`. */ agentUri?: string; } /** - * Represents an intent. Intents convert a number of user expressions or - * patterns into an action. An action is an extraction of a user command or - * sentence semantics. + * Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2beta1Intent { /** - * Optional. The name of the action associated with the intent. Note: The - * action name must not contain whitespaces. + * Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. */ action?: string; /** - * Optional. The list of platforms for which the first response will be - * taken from among the messages assigned to the DEFAULT_PLATFORM. + * Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM. */ defaultResponsePlatforms?: string[]; /** @@ -508,27 +407,19 @@ export namespace dialogflow_v2 { */ displayName?: string; /** - * Optional. Indicates that this intent ends an interaction. Some - * integrations (e.g., Actions on Google or Dialogflow phone gateway) use - * this information to close interaction with an end user. Default is false. + * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. */ endInteraction?: boolean; /** - * Optional. The collection of event names that trigger the intent. If the - * collection of input contexts is not empty, all of the contexts must be - * present in the active user session for an event to trigger this intent. + * Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. */ events?: string[]; /** - * Read-only. Information about all followup intents that have this intent - * as a direct or indirect parent. We populate this field only in the - * output. + * Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. */ followupIntentInfo?: Schema$GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo[]; /** - * Optional. The list of context names required for this intent to be - * triggered. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ inputContextNames?: string[]; /** @@ -536,41 +427,23 @@ export namespace dialogflow_v2 { */ isFallback?: boolean; /** - * Optional. The collection of rich messages corresponding to the `Response` - * field in the Dialogflow console. + * Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. */ messages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * Optional. Indicates whether Machine Learning is disabled for the intent. - * Note: If `ml_disabled` setting is set to true, then this intent is not - * taken into account during inference in `ML ONLY` match mode. Also, - * auto-markup in the UI is turned off. + * Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. */ mlDisabled?: boolean; /** - * Optional. Indicates whether Machine Learning is enabled for the intent. - * Note: If `ml_enabled` setting is set to false, then this intent is not - * taken into account during inference in `ML ONLY` match mode. Also, - * auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` - * field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either - * not set or false, then the default value is determined as follows: - - * Before April 15th, 2018 the default is: ml_enabled = false / - * ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled - * = true / ml_disabled = false. + * Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false. */ mlEnabled?: boolean; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent - * and Intents.BatchUpdateIntents methods. Format: `projects/<Project - * ID>/agent/intents/<Intent ID>`. + * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ name?: string; /** - * Optional. The collection of contexts that are activated when the intent - * is matched. Context messages in this collection should not set the - * parameters field. Setting the `lifespan_count` to 0 will reset the - * context when the intent is matched. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** @@ -578,30 +451,19 @@ export namespace dialogflow_v2 { */ parameters?: Schema$GoogleCloudDialogflowV2beta1IntentParameter[]; /** - * Read-only after creation. The unique identifier of the parent intent in - * the chain of followup intents. You can set this field when creating an - * intent, for example with CreateIntent or BatchUpdateIntents, in order to - * make this intent a followup intent. It identifies the parent followup - * intent. Format: `projects/<Project ID>/agent/intents/<Intent - * ID>`. + * Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; /** - * Optional. The priority of this intent. Higher numbers represent higher - * priorities. If this is zero or unspecified, we use the default priority - * 500000. Negative numbers mean that the intent is disabled. + * Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** - * Optional. Indicates whether to delete all contexts in the current session - * when this intent is matched. + * Optional. Indicates whether to delete all contexts in the current session when this intent is matched. */ resetContexts?: boolean; /** - * Read-only. The unique identifier of the root intent in the chain of - * followup intents. It identifies the correct followup intents chain for - * this intent. We populate this field only in the output. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ rootFollowupIntentName?: string; /** @@ -618,13 +480,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo { /** - * The unique identifier of the followup intent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ followupIntentName?: string; /** - * The unique identifier of the followup intent's parent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; } @@ -657,9 +517,7 @@ export namespace dialogflow_v2 { */ listSelect?: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelect; /** - * Returns a response containing a custom, platform-specific payload. See - * the Intent.Message.Platform type for a description of the structure that - * may be required for your platform. + * Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. */ payload?: {[key: string]: any}; /** @@ -811,8 +669,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageImage { /** - * A text description of the image to be used for accessibility, e.g., - * screen readers. Required if image_uri is set for CarouselSelect. + * A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect. */ accessibilityText?: string; /** @@ -821,8 +678,7 @@ export namespace dialogflow_v2 { imageUri?: string; } /** - * The suggestion chip message that allows the user to jump out to the app or - * website associated with this agent. + * The suggestion chip message that allows the user to jump out to the app or website associated with this agent. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion { /** @@ -830,8 +686,7 @@ export namespace dialogflow_v2 { */ destinationName?: string; /** - * Required. The URI of the app or site to open when the user taps the - * suggestion chip. + * Required. The URI of the app or site to open when the user taps the suggestion chip. */ uri?: string; } @@ -887,13 +742,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo { /** - * Required. A unique key that will be sent back to the agent if this - * response is given. + * Required. A unique key that will be sent back to the agent if this response is given. */ key?: string; /** - * Optional. A list of synonyms that can also be used to trigger this item - * in dialog. + * Optional. A list of synonyms that can also be used to trigger this item in dialog. */ synonyms?: string[]; } @@ -906,22 +759,16 @@ export namespace dialogflow_v2 { */ displayText?: string; /** - * One of text_to_speech or ssml must be provided. Structured spoken - * response to the user in the SSML format. Mutually exclusive with - * text_to_speech. + * One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. */ ssml?: string; /** - * One of text_to_speech or ssml must be provided. The plain text of the - * speech output. Mutually exclusive with ssml. + * One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. */ textToSpeech?: string; } /** - * The collection of simple response candidates. This message in - * `QueryResult.fulfillment_messages` and - * `WebhookResponse.fulfillment_messages` should contain only one - * `SimpleResponse`. + * The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses { /** @@ -930,8 +777,7 @@ export namespace dialogflow_v2 { simpleResponses?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse[]; } /** - * The suggestion chip message that the user can tap to quickly post a reply - * to the conversation. + * The suggestion chip message that the user can tap to quickly post a reply to the conversation. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestion { /** @@ -953,30 +799,16 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio { /** - * Required. URI to a Google Cloud Storage object containing the audio to - * play, e.g., "gs://bucket/object". The object must contain a - * single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. - * This object must be readable by the `service-<Project - * Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account - * where <Project Number> is the number of the Telephony Gateway - * project (usually the same as the Dialogflow agent project). If the Google - * Cloud Storage bucket is in the Telephony Gateway project, this permission - * is added by default when enabling the Dialogflow V2 API. For audio from - * other sources, consider using the `TelephonySynthesizeSpeech` message - * with SSML. + * Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-<Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where <Project Number> is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML. */ audioUri?: string; } /** - * Synthesizes speech and plays back the synthesized audio to the caller in - * Telephony Gateway. Telephony Gateway takes the synthesizer settings from - * `DetectIntentResponse.output_audio_config` which can either be set at - * request-level or can come from the agent-level synthesizer config. + * Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech { /** - * The SSML to be synthesized. For more information, see - * [SSML](https://developers.google.com/actions/reference/ssml). + * The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml). */ ssml?: string; /** @@ -989,9 +821,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall { /** - * Required. The phone number to transfer the call to in [E.164 - * format](https://en.wikipedia.org/wiki/E.164). We currently only allow - * transferring to US numbers (+1xxxyyyzzzz). + * Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz). */ phoneNumber?: string; } @@ -1009,9 +839,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentParameter { /** - * Optional. The default value to use when the `value` yields an empty - * result. Default values can be extracted from contexts by using the - * following syntax: `#context_name.parameter_name`. + * Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. */ defaultValue?: string; /** @@ -1019,9 +847,7 @@ export namespace dialogflow_v2 { */ displayName?: string; /** - * Optional. The name of the entity type, prefixed with `@`, that describes - * values of the parameter. If the parameter is required, this must be - * provided. + * Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided. */ entityTypeDisplayName?: string; /** @@ -1029,8 +855,7 @@ export namespace dialogflow_v2 { */ isList?: boolean; /** - * Optional. Indicates whether the parameter is required. That is, whether - * the intent cannot be completed without collecting the parameter value. + * Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. */ mandatory?: boolean; /** @@ -1038,15 +863,11 @@ export namespace dialogflow_v2 { */ name?: string; /** - * Optional. The collection of prompts that the agent can present to the - * user in order to collect value for the parameter. + * Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter. */ prompts?: string[]; /** - * Optional. The definition of the parameter value. It can be: - a constant - * string, - a parameter value defined as `$parameter_name`, - an original - * parameter value defined as `$parameter_name.original`, - a parameter - * value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string; } @@ -1059,24 +880,11 @@ export namespace dialogflow_v2 { */ name?: string; /** - * Required. The ordered list of training phrase parts. The parts are - * concatenated in order to form the training phrase. Note: The API does - * not automatically annotate training phrases like the Dialogflow Console - * does. Note: Do not forget to include whitespace at part boundaries, so - * the training phrase is well formatted when the parts are concatenated. If - * the training phrase does not need to be annotated with parameters, you - * just need a single part with only the Part.text field set. If you want - * to annotate the training phrase, you must create multiple parts, where - * the fields of each part are populated in one of two ways: - `Part.text` - * is set to a part of the phrase that has no parameters. - `Part.text` is - * set to a part of the phrase that you want to annotate, and the - * `entity_type`, `alias`, and `user_defined` fields are all set. + * Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set. */ parts?: Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart[]; /** - * Optional. Indicates how many times this example was added to the intent. - * Each time a developer adds an existing sample by editing an intent or - * training, this counter is increased. + * Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. */ timesAddedCount?: number; /** @@ -1089,14 +897,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart { /** - * Optional. The parameter name for the value extracted from the annotated - * part of the example. This field is required for annotated parts of the - * training phrase. + * Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. */ alias?: string; /** - * Optional. The entity type name prefixed with `@`. This field is required - * for annotated parts of the training phrase. + * Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase. */ entityType?: string; /** @@ -1104,10 +909,7 @@ export namespace dialogflow_v2 { */ text?: string; /** - * Optional. Indicates whether the text was manually annotated. This field - * is set to true when the Dialogflow Console is used to manually annotate - * the part. When creating an annotated part with the API, you must set this - * to true. + * Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. */ userDefined?: boolean; } @@ -1125,38 +927,23 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer { /** - * The piece of text from the `source` knowledge base document that answers - * this conversational query. + * The piece of text from the `source` knowledge base document that answers this conversational query. */ answer?: string; /** - * The corresponding FAQ question if the answer was extracted from a FAQ - * Document, empty otherwise. + * The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise. */ faqQuestion?: string; /** - * The system's confidence score that this Knowledge answer is a good - * match for this conversational query. The range is from 0.0 (completely - * uncertain) to 1.0 (completely certain). Note: The confidence score is - * likely to vary somewhat (possibly even for identical requests), as the - * underlying model is under constant improvement. It may be deprecated in - * the future. We recommend using `match_confidence_level` which should be - * generally more stable. + * The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using `match_confidence_level` which should be generally more stable. */ matchConfidence?: number; /** - * The system's confidence level that this knowledge answer is a good - * match for this conversational query. NOTE: The confidence level for a - * given `<query, answer>` pair may change without notice, as it - * depends on models that are constantly being improved. However, it will - * change less frequently than the confidence score below, and should be - * preferred for referencing the quality of an answer. + * The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `<query, answer>` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer. */ matchConfidenceLevel?: string; /** - * Indicates which Knowledge Document this answer was extracted from. - * Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base - * ID>/documents/<Document ID>`. + * Indicates which Knowledge Document this answer was extracted from. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. */ source?: string; } @@ -1170,30 +957,19 @@ export namespace dialogflow_v2 { state?: string; } /** - * Represents the contents of the original request that was passed to the - * `[Streaming]DetectIntent` call. + * Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call. */ export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest { /** - * Optional. This field is set to the value of the `QueryParameters.payload` - * field passed in the request. Some integrations that query a Dialogflow - * agent may provide additional information in the payload. In particular - * for the Telephony Gateway this field has the form: <pre>{ - * "telephony": { "caller_id": - * "+18558363987" } }</pre> Note: The caller ID field - * (`caller_id`) will be redacted for Standard Edition agents and populated - * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) - * for Enterprise Edition agents. + * Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. */ payload?: {[key: string]: any}; /** - * The source of this request, e.g., `google`, `facebook`, `slack`. It is - * set by Dialogflow-owned servers. + * The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers. */ source?: string; /** - * Optional. The version of the protocol used for this request. This field - * is AoG-specific. + * Optional. The version of the protocol used for this request. This field is AoG-specific. */ version?: string; } @@ -1206,16 +982,11 @@ export namespace dialogflow_v2 { */ action?: string; /** - * This field is set to: - `false` if the matched intent has required - * parameters and not all of the required parameter values have been - * collected. - `true` if all required parameter values have been collected, - * or if the matched intent doesn't contain any required parameters. + * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. */ allRequiredParamsPresent?: boolean; /** - * The free-form diagnostic info. For example, this field could contain - * webhook call latency. The string keys of the Struct's fields map can - * change without notice. + * The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. */ diagnosticInfo?: {[key: string]: any}; /** @@ -1223,39 +994,27 @@ export namespace dialogflow_v2 { */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * The text to be pronounced to the user or shown on the screen. Note: This - * is a legacy field, `fulfillment_messages` should be preferred. + * The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. */ fulfillmentText?: string; /** - * The intent that matched the conversational query. Some, not all fields - * are filled in this message, including but not limited to: `name`, - * `display_name` and `webhook_state`. + * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`. */ intent?: Schema$GoogleCloudDialogflowV2beta1Intent; /** - * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). If there are `multiple - * knowledge_answers` messages, this value is set to the greatest - * `knowledgeAnswers.match_confidence` value in the list. + * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** - * The result from Knowledge Connector (if any), ordered by decreasing - * `KnowledgeAnswers.match_confidence`. + * The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`. */ knowledgeAnswers?: Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswers; /** - * The language that was triggered during intent detection. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. + * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. */ languageCode?: string; /** - * The collection of output contexts. If applicable, - * `output_contexts.parameters` contains entries with name `<parameter - * name>.original` containing the original parameter values before the - * query. + * The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** @@ -1263,60 +1022,41 @@ export namespace dialogflow_v2 { */ parameters?: {[key: string]: any}; /** - * The original conversational query text: - If natural language text was - * provided as input, `query_text` contains a copy of the input. - If - * natural language speech audio was provided as input, `query_text` - * contains the speech recognition result. If speech recognizer produced - * multiple alternatives, a particular one is picked. - If an event was - * provided as input, `query_text` is not set. + * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set. */ queryText?: string; /** - * The sentiment analysis result, which depends on the - * `sentiment_analysis_request_config` specified in the request. + * The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. */ sentimentAnalysisResult?: Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisResult; /** - * The Speech recognition confidence between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. The default of 0.0 is a sentinel value indicating that - * confidence was not set. This field is not guaranteed to be accurate or - * set. In particular this field isn't set for StreamingDetectIntent - * since the streaming endpoint has separate confidence estimates per - * portion of the audio in StreamingRecognitionResult. + * The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. */ speechRecognitionConfidence?: number; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `payload` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response. */ webhookPayload?: {[key: string]: any}; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `source` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response. */ webhookSource?: string; } /** - * The sentiment, such as positive/negative feeling or association, for a unit - * of analysis, such as the query text. + * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. */ export interface Schema$GoogleCloudDialogflowV2beta1Sentiment { /** - * A non-negative number in the [0, +inf) range, which represents the - * absolute magnitude of sentiment, regardless of score (positive or - * negative). + * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */ magnitude?: number; /** - * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - * sentiment). + * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ score?: number; } /** - * The result of sentiment analysis as configured by - * `sentiment_analysis_request_config`. + * The result of sentiment analysis as configured by `sentiment_analysis_request_config`. */ export interface Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisResult { /** @@ -1333,26 +1073,19 @@ export namespace dialogflow_v2 { */ alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; /** - * Optional. The contents of the original request that was passed to - * `[Streaming]DetectIntent` call. + * Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call. */ originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest; /** - * The result of the conversational query or event processing. Contains the - * same value as `[Streaming]DetectIntentResponse.query_result`. + * The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`. */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; /** - * The unique identifier of the response. Contains the same value as - * `[Streaming]DetectIntentResponse.response_id`. + * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. */ responseId?: string; /** - * The unique identifier of detectIntent request session. Can be used to - * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`, or - * `projects/<Project ID>/agent/environments/<Environment - * ID>/users/<User ID>/sessions/<Session ID>`. + * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -1361,43 +1094,27 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse { /** - * Optional. Indicates that this intent ends an interaction. Some - * integrations (e.g., Actions on Google or Dialogflow phone gateway) use - * this information to close interaction with an end user. Default is false. + * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. */ endInteraction?: boolean; /** - * Optional. Makes the platform immediately invoke another `DetectIntent` - * call internally with the specified event as input. + * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. */ followupEventInput?: Schema$GoogleCloudDialogflowV2beta1EventInput; /** - * Optional. The collection of rich messages to present to the user. This - * value is passed directly to `QueryResult.fulfillment_messages`. + * Optional. The collection of rich messages to present to the user. This value is passed directly to `QueryResult.fulfillment_messages`. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed - * directly to `QueryResult.fulfillment_text`. + * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. */ fulfillmentText?: string; /** - * Optional. The collection of output contexts. This value is passed - * directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_payload`. - * See the related `fulfillment_messages[i].payload field`, which may be - * used as an alternative to this field. This field can be used for Actions - * on Google responses. It should have a structure similar to the JSON - * message shown here. For more information, see [Actions on Google Webhook - * Format](https://developers.google.com/actions/dialogflow/webhook) - * <pre>{ "google": { "expectUserResponse": - * true, "richResponse": { "items": [ { - * "simpleResponse": { "textToSpeech": - * "this is a simple response" } } ] } - * } }</pre> + * Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre> */ payload?: {[key: string]: any}; /** @@ -1410,25 +1127,15 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2Context { /** - * Optional. The number of conversational query requests after which the - * context expires. If set to `0` (the default) the context expires - * immediately. Contexts expire automatically after 20 minutes if there are - * no matching queries. + * Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. */ lifespanCount?: number; /** - * Required. The unique identifier of the context. Format: - * `projects/<Project ID>/agent/sessions/<Session - * ID>/contexts/<Context ID>`. The `Context ID` is always - * converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and - * may be at most 250 bytes long. + * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. */ name?: string; /** - * Optional. The collection of parameters associated with this context. - * Refer to [this - * doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) - * for syntax. + * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax. */ parameters?: {[key: string]: any}; } @@ -1437,22 +1144,15 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2DetectIntentRequest { /** - * Optional. The natural language speech audio to be processed. This field - * should be populated iff `query_input` is set to an input audio config. A - * single request can contain up to 1 minute of speech audio data. + * Optional. The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data. */ inputAudio?: string; /** - * Optional. Instructs the speech synthesizer how to generate the output - * audio. If this field is not set and agent-level speech synthesizer is not - * configured, no output audio is generated. + * Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated. */ outputAudioConfig?: Schema$GoogleCloudDialogflowV2OutputAudioConfig; /** - * Required. The input specification. It can be set to: 1. an audio config - * which instructs the speech recognizer how to process the speech audio, 2. - * a conversational query in the form of text, or 3. an event that - * specifies which intent to trigger. + * Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. */ queryInput?: Schema$GoogleCloudDialogflowV2QueryInput; /** @@ -1465,12 +1165,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2DetectIntentResponse { /** - * The audio data bytes encoded as specified in the request. Note: The - * output audio is generated based on the values of default platform text - * responses found in the `query_result.fulfillment_messages` field. If - * multiple default text responses exist, they will be concatenated when - * generating audio. If no default platform text responses exist, the - * generated audio content will be empty. + * The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.fulfillment_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. */ outputAudio?: string; /** @@ -1478,13 +1173,11 @@ export namespace dialogflow_v2 { */ outputAudioConfig?: Schema$GoogleCloudDialogflowV2OutputAudioConfig; /** - * The selected results of the conversational query or event processing. See - * `alternative_query_results` for additional potential results. + * The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results. */ queryResult?: Schema$GoogleCloudDialogflowV2QueryResult; /** - * The unique identifier of the response. It can be used to locate a - * response in the training example set or for reporting issues. + * The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. */ responseId?: string; /** @@ -1493,13 +1186,11 @@ export namespace dialogflow_v2 { webhookStatus?: Schema$GoogleRpcStatus; } /** - * Represents an entity type. Entity types serve as a tool for extracting - * parameter values from natural language queries. + * Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. */ export interface Schema$GoogleCloudDialogflowV2EntityType { /** - * Optional. Indicates whether the entity type can be automatically - * expanded. + * Optional. Indicates whether the entity type can be automatically expanded. */ autoExpansionMode?: string; /** @@ -1507,8 +1198,7 @@ export namespace dialogflow_v2 { */ displayName?: string; /** - * Optional. The collection of entity entries associated with the entity - * type. + * Optional. The collection of entity entries associated with the entity type. */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** @@ -1516,10 +1206,7 @@ export namespace dialogflow_v2 { */ kind?: string; /** - * The unique identifier of the entity type. Required for - * EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - * methods. Format: `projects/<Project - * ID>/agent/entityTypes/<Entity Type ID>`. + * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. */ name?: string; } @@ -1537,36 +1224,20 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2EntityTypeEntity { /** - * Required. A collection of value synonyms. For example, if the entity type - * is *vegetable*, and `value` is *scallions*, a synonym could be *green - * onions*. For `KIND_LIST` entity types: * This collection must contain - * exactly one synonym equal to `value`. + * Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. */ synonyms?: string[]; /** - * Required. The primary value associated with this entity entry. For - * example, if the entity type is *vegetable*, the value could be - * *scallions*. For `KIND_MAP` entity types: * A canonical value to be - * used in place of synonyms. For `KIND_LIST` entity types: * A string - * that can contain references to other entity types (with or without - * aliases). + * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). */ value?: string; } /** - * Events allow for matching intents by event name instead of the natural - * language input. For instance, input `<event: { name: - * "welcome_event", parameters: { name: "Sam" } }>` can - * trigger a personalized welcome response. The parameter `name` may be used - * by the agent in the response: `"Hello #welcome_event.name! What can I - * do for you today?"`. + * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ export interface Schema$GoogleCloudDialogflowV2EventInput { /** - * Required. The language of this query. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** @@ -1583,11 +1254,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ExportAgentRequest { /** - * Optional. The [Google Cloud - * Storage](https://cloud.google.com/storage/docs/) URI to export the agent - * to. The format of this URI must be - * `gs://<bucket-name>/<object-name>`. If left unspecified, the - * serialized agent is returned inline. + * Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline. */ agentUri?: string; } @@ -1596,21 +1263,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ExportAgentResponse { /** - * The exported agent. Example for how to export an agent to a zip file via - * a command line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary '{}' \ | grep agentContent | sed - * -e 's/.*"agentContent": - * "\([^"]*\)".x/\1/' \ | base64 --decode > - * &lt;agent zip file&gt;</pre> + * The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre> */ agentContent?: string; /** - * The URI to a file containing the exported agent. This field is populated - * only if `agent_uri` is specified in `ExportAgentRequest`. + * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`. */ agentUri?: string; } @@ -1619,20 +1276,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ImportAgentRequest { /** - * The agent to import. Example for how to import an agent via the command - * line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:import\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary "{ 'agentContent': - * '$(cat &lt;agent zip file&gt; | base64 -w 0)' - * }"</pre> + * The agent to import. Example for how to import an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:import\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre> */ agentContent?: string; /** - * The URI to a Google Cloud Storage file containing the agent to import. - * Note: The URI must start with "gs://". + * The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://". */ agentUri?: string; } @@ -1645,42 +1293,32 @@ export namespace dialogflow_v2 { */ audioEncoding?: string; /** - * Required. The language of the supplied audio. Dialogflow does not do - * translations. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** - * Optional. The collection of phrase hints which are used to boost accuracy - * of speech recognition. Refer to [Cloud Speech API - * documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) - * for more details. + * Optional. Which variant of the Speech model to use. + */ + modelVariant?: string; + /** + * Optional. The collection of phrase hints which are used to boost accuracy of speech recognition. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. */ phraseHints?: string[]; /** - * Required. Sample rate (in Hertz) of the audio content sent in the query. - * Refer to [Cloud Speech API - * documentation](https://cloud.google.com/speech-to-text/docs/basics) for - * more details. + * Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. */ sampleRateHertz?: number; } /** - * Represents an intent. Intents convert a number of user expressions or - * patterns into an action. An action is an extraction of a user command or - * sentence semantics. + * Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2Intent { /** - * Optional. The name of the action associated with the intent. Note: The - * action name must not contain whitespaces. + * Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. */ action?: string; /** - * Optional. The list of platforms for which the first response will be - * taken from among the messages assigned to the DEFAULT_PLATFORM. + * Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM. */ defaultResponsePlatforms?: string[]; /** @@ -1688,21 +1326,15 @@ export namespace dialogflow_v2 { */ displayName?: string; /** - * Optional. The collection of event names that trigger the intent. If the - * collection of input contexts is not empty, all of the contexts must be - * present in the active user session for an event to trigger this intent. + * Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. */ events?: string[]; /** - * Read-only. Information about all followup intents that have this intent - * as a direct or indirect parent. We populate this field only in the - * output. + * Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. */ followupIntentInfo?: Schema$GoogleCloudDialogflowV2IntentFollowupIntentInfo[]; /** - * Optional. The list of context names required for this intent to be - * triggered. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ inputContextNames?: string[]; /** @@ -1710,29 +1342,19 @@ export namespace dialogflow_v2 { */ isFallback?: boolean; /** - * Optional. The collection of rich messages corresponding to the `Response` - * field in the Dialogflow console. + * Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. */ messages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * Optional. Indicates whether Machine Learning is disabled for the intent. - * Note: If `ml_diabled` setting is set to true, then this intent is not - * taken into account during inference in `ML ONLY` match mode. Also, - * auto-markup in the UI is turned off. + * Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_diabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. */ mlDisabled?: boolean; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent - * and Intents.BatchUpdateIntents methods. Format: `projects/<Project - * ID>/agent/intents/<Intent ID>`. + * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ name?: string; /** - * Optional. The collection of contexts that are activated when the intent - * is matched. Context messages in this collection should not set the - * parameters field. Setting the `lifespan_count` to 0 will reset the - * context when the intent is matched. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** @@ -1740,30 +1362,19 @@ export namespace dialogflow_v2 { */ parameters?: Schema$GoogleCloudDialogflowV2IntentParameter[]; /** - * Read-only after creation. The unique identifier of the parent intent in - * the chain of followup intents. You can set this field when creating an - * intent, for example with CreateIntent or BatchUpdateIntents, in order to - * make this intent a followup intent. It identifies the parent followup - * intent. Format: `projects/<Project ID>/agent/intents/<Intent - * ID>`. + * Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; /** - * Optional. The priority of this intent. Higher numbers represent higher - * priorities. If this is zero or unspecified, we use the default priority - * 500000. Negative numbers mean that the intent is disabled. + * Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** - * Optional. Indicates whether to delete all contexts in the current session - * when this intent is matched. + * Optional. Indicates whether to delete all contexts in the current session when this intent is matched. */ resetContexts?: boolean; /** - * Read-only. The unique identifier of the root intent in the chain of - * followup intents. It identifies the correct followup intents chain for - * this intent. We populate this field only in the output. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ rootFollowupIntentName?: string; /** @@ -1789,13 +1400,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2IntentFollowupIntentInfo { /** - * The unique identifier of the followup intent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ followupIntentName?: string; /** - * The unique identifier of the followup intent's parent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; } @@ -1828,9 +1437,7 @@ export namespace dialogflow_v2 { */ listSelect?: Schema$GoogleCloudDialogflowV2IntentMessageListSelect; /** - * Returns a response containing a custom, platform-specific payload. See - * the Intent.Message.Platform type for a description of the structure that - * may be required for your platform. + * Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. */ payload?: {[key: string]: any}; /** @@ -1970,8 +1577,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2IntentMessageImage { /** - * Optional. A text description of the image to be used for accessibility, - * e.g., screen readers. + * Optional. A text description of the image to be used for accessibility, e.g., screen readers. */ accessibilityText?: string; /** @@ -1980,8 +1586,7 @@ export namespace dialogflow_v2 { imageUri?: string; } /** - * The suggestion chip message that allows the user to jump out to the app or - * website associated with this agent. + * The suggestion chip message that allows the user to jump out to the app or website associated with this agent. */ export interface Schema$GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion { /** @@ -1989,8 +1594,7 @@ export namespace dialogflow_v2 { */ destinationName?: string; /** - * Required. The URI of the app or site to open when the user taps the - * suggestion chip. + * Required. The URI of the app or site to open when the user taps the suggestion chip. */ uri?: string; } @@ -2046,13 +1650,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2IntentMessageSelectItemInfo { /** - * Required. A unique key that will be sent back to the agent if this - * response is given. + * Required. A unique key that will be sent back to the agent if this response is given. */ key?: string; /** - * Optional. A list of synonyms that can also be used to trigger this item - * in dialog. + * Optional. A list of synonyms that can also be used to trigger this item in dialog. */ synonyms?: string[]; } @@ -2065,22 +1667,16 @@ export namespace dialogflow_v2 { */ displayText?: string; /** - * One of text_to_speech or ssml must be provided. Structured spoken - * response to the user in the SSML format. Mutually exclusive with - * text_to_speech. + * One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. */ ssml?: string; /** - * One of text_to_speech or ssml must be provided. The plain text of the - * speech output. Mutually exclusive with ssml. + * One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. */ textToSpeech?: string; } /** - * The collection of simple response candidates. This message in - * `QueryResult.fulfillment_messages` and - * `WebhookResponse.fulfillment_messages` should contain only one - * `SimpleResponse`. + * The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. */ export interface Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponses { /** @@ -2089,8 +1685,7 @@ export namespace dialogflow_v2 { simpleResponses?: Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponse[]; } /** - * The suggestion chip message that the user can tap to quickly post a reply - * to the conversation. + * The suggestion chip message that the user can tap to quickly post a reply to the conversation. */ export interface Schema$GoogleCloudDialogflowV2IntentMessageSuggestion { /** @@ -2121,9 +1716,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2IntentParameter { /** - * Optional. The default value to use when the `value` yields an empty - * result. Default values can be extracted from contexts by using the - * following syntax: `#context_name.parameter_name`. + * Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. */ defaultValue?: string; /** @@ -2131,9 +1724,7 @@ export namespace dialogflow_v2 { */ displayName?: string; /** - * Optional. The name of the entity type, prefixed with `@`, that describes - * values of the parameter. If the parameter is required, this must be - * provided. + * Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided. */ entityTypeDisplayName?: string; /** @@ -2141,8 +1732,7 @@ export namespace dialogflow_v2 { */ isList?: boolean; /** - * Optional. Indicates whether the parameter is required. That is, whether - * the intent cannot be completed without collecting the parameter value. + * Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. */ mandatory?: boolean; /** @@ -2150,15 +1740,11 @@ export namespace dialogflow_v2 { */ name?: string; /** - * Optional. The collection of prompts that the agent can present to the - * user in order to collect value for the parameter. + * Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter. */ prompts?: string[]; /** - * Optional. The definition of the parameter value. It can be: - a constant - * string, - a parameter value defined as `$parameter_name`, - an original - * parameter value defined as `$parameter_name.original`, - a parameter - * value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string; } @@ -2171,24 +1757,11 @@ export namespace dialogflow_v2 { */ name?: string; /** - * Required. The ordered list of training phrase parts. The parts are - * concatenated in order to form the training phrase. Note: The API does - * not automatically annotate training phrases like the Dialogflow Console - * does. Note: Do not forget to include whitespace at part boundaries, so - * the training phrase is well formatted when the parts are concatenated. If - * the training phrase does not need to be annotated with parameters, you - * just need a single part with only the Part.text field set. If you want - * to annotate the training phrase, you must create multiple parts, where - * the fields of each part are populated in one of two ways: - `Part.text` - * is set to a part of the phrase that has no parameters. - `Part.text` is - * set to a part of the phrase that you want to annotate, and the - * `entity_type`, `alias`, and `user_defined` fields are all set. + * Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set. */ parts?: Schema$GoogleCloudDialogflowV2IntentTrainingPhrasePart[]; /** - * Optional. Indicates how many times this example was added to the intent. - * Each time a developer adds an existing sample by editing an intent or - * training, this counter is increased. + * Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. */ timesAddedCount?: number; /** @@ -2201,14 +1774,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2IntentTrainingPhrasePart { /** - * Optional. The parameter name for the value extracted from the annotated - * part of the example. This field is required for annotated parts of the - * training phrase. + * Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. */ alias?: string; /** - * Optional. The entity type name prefixed with `@`. This field is required - * for annotated parts of the training phrase. + * Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase. */ entityType?: string; /** @@ -2216,10 +1786,7 @@ export namespace dialogflow_v2 { */ text?: string; /** - * Optional. Indicates whether the text was manually annotated. This field - * is set to true when the Dialogflow Console is used to manually annotate - * the part. When creating an annotated part with the API, you must set this - * to true. + * Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. */ userDefined?: boolean; } @@ -2228,13 +1795,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ListContextsResponse { /** - * The list of contexts. There will be a maximum number of items returned - * based on the page_size field in the request. + * The list of contexts. There will be a maximum number of items returned based on the page_size field in the request. */ contexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -2243,13 +1808,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ListEntityTypesResponse { /** - * The list of agent entity types. There will be a maximum number of items - * returned based on the page_size field in the request. + * The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request. */ entityTypes?: Schema$GoogleCloudDialogflowV2EntityType[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -2258,13 +1821,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ListIntentsResponse { /** - * The list of agent intents. There will be a maximum number of items - * returned based on the page_size field in the request. + * The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request. */ intents?: Schema$GoogleCloudDialogflowV2Intent[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -2273,46 +1834,33 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ListSessionEntityTypesResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** - * The list of session entity types. There will be a maximum number of items - * returned based on the page_size field in the request. + * The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; } /** - * Represents the contents of the original request that was passed to the - * `[Streaming]DetectIntent` call. + * Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call. */ export interface Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest { /** - * Optional. This field is set to the value of the `QueryParameters.payload` - * field passed in the request. Some integrations that query a Dialogflow - * agent may provide additional information in the payload. In particular - * for the Telephony Gateway this field has the form: <pre>{ - * "telephony": { "caller_id": - * "+18558363987" } }</pre> Note: The caller ID field - * (`caller_id`) will be redacted for Standard Edition agents and populated - * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) - * for Enterprise Edition agents. + * Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. */ payload?: {[key: string]: any}; /** - * The source of this request, e.g., `google`, `facebook`, `slack`. It is - * set by Dialogflow-owned servers. + * The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers. */ source?: string; /** - * Optional. The version of the protocol used for this request. This field - * is AoG-specific. + * Optional. The version of the protocol used for this request. This field is AoG-specific. */ version?: string; } /** - * Instructs the speech synthesizer how to generate the output audio content. + * Instructs the speech synthesizer on how to generate the output audio content. */ export interface Schema$GoogleCloudDialogflowV2OutputAudioConfig { /** @@ -2320,11 +1868,7 @@ export namespace dialogflow_v2 { */ audioEncoding?: string; /** - * Optional. The synthesis sample rate (in hertz) for this audio. If not - * provided, then the synthesizer will use the default sample rate based on - * the audio encoding. If this is different from the voice's natural - * sample rate, then the synthesizer will honor this request by converting - * to the desired sample rate (which might result in worse audio quality). + * Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). */ sampleRateHertz?: number; /** @@ -2333,10 +1877,7 @@ export namespace dialogflow_v2 { synthesizeSpeechConfig?: Schema$GoogleCloudDialogflowV2SynthesizeSpeechConfig; } /** - * Represents the query input. It can contain either: 1. An audio config - * which instructs the speech recognizer how to process the speech audio. - * 2. A conversational query in the form of text,. 3. An event that - * specifies which intent to trigger. + * Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text,. 3. An event that specifies which intent to trigger. */ export interface Schema$GoogleCloudDialogflowV2QueryInput { /** @@ -2357,8 +1898,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2QueryParameters { /** - * Optional. The collection of contexts to be activated before this query is - * executed. + * Optional. The collection of contexts to be activated before this query is executed. */ contexts?: Schema$GoogleCloudDialogflowV2Context[]; /** @@ -2366,31 +1906,23 @@ export namespace dialogflow_v2 { */ geoLocation?: Schema$GoogleTypeLatLng; /** - * Optional. This field can be used to pass custom data into the webhook - * associated with the agent. Arbitrary JSON objects are supported. + * Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. */ payload?: {[key: string]: any}; /** - * Optional. Specifies whether to delete all contexts in the current session - * before the new ones are activated. + * Optional. Specifies whether to delete all contexts in the current session before the new ones are activated. */ resetContexts?: boolean; /** - * Optional. Configures the type of sentiment analysis to perform. If not - * provided, sentiment analysis is not performed. + * Optional. Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. */ sentimentAnalysisRequestConfig?: Schema$GoogleCloudDialogflowV2SentimentAnalysisRequestConfig; /** - * Optional. Additional session entity types to replace or extend developer - * entity types with. The entity synonyms apply to all languages and persist - * for the session of this query. + * Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; /** - * Optional. The time zone of this conversational query from the [time zone - * database](https://www.iana.org/time-zones), e.g., America/New_York, - * Europe/Paris. If not provided, the time zone specified in agent settings - * is used. + * Optional. The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used. */ timeZone?: string; } @@ -2403,16 +1935,11 @@ export namespace dialogflow_v2 { */ action?: string; /** - * This field is set to: - `false` if the matched intent has required - * parameters and not all of the required parameter values have been - * collected. - `true` if all required parameter values have been collected, - * or if the matched intent doesn't contain any required parameters. + * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. */ allRequiredParamsPresent?: boolean; /** - * The free-form diagnostic info. For example, this field could contain - * webhook call latency. The string keys of the Struct's fields map can - * change without notice. + * The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. */ diagnosticInfo?: {[key: string]: any}; /** @@ -2420,34 +1947,23 @@ export namespace dialogflow_v2 { */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * The text to be pronounced to the user or shown on the screen. Note: This - * is a legacy field, `fulfillment_messages` should be preferred. + * The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. */ fulfillmentText?: string; /** - * The intent that matched the conversational query. Some, not all fields - * are filled in this message, including but not limited to: `name`, - * `display_name` and `webhook_state`. + * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`. */ intent?: Schema$GoogleCloudDialogflowV2Intent; /** - * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). If there are `multiple - * knowledge_answers` messages, this value is set to the greatest - * `knowledgeAnswers.match_confidence` value in the list. + * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** - * The language that was triggered during intent detection. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. + * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. */ languageCode?: string; /** - * The collection of output contexts. If applicable, - * `output_contexts.parameters` contains entries with name `<parameter - * name>.original` containing the original parameter values before the - * query. + * The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** @@ -2455,37 +1971,23 @@ export namespace dialogflow_v2 { */ parameters?: {[key: string]: any}; /** - * The original conversational query text: - If natural language text was - * provided as input, `query_text` contains a copy of the input. - If - * natural language speech audio was provided as input, `query_text` - * contains the speech recognition result. If speech recognizer produced - * multiple alternatives, a particular one is picked. - If an event was - * provided as input, `query_text` is not set. + * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set. */ queryText?: string; /** - * The sentiment analysis result, which depends on the - * `sentiment_analysis_request_config` specified in the request. + * The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. */ sentimentAnalysisResult?: Schema$GoogleCloudDialogflowV2SentimentAnalysisResult; /** - * The Speech recognition confidence between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. The default of 0.0 is a sentinel value indicating that - * confidence was not set. This field is not guaranteed to be accurate or - * set. In particular this field isn't set for StreamingDetectIntent - * since the streaming endpoint has separate confidence estimates per - * portion of the audio in StreamingRecognitionResult. + * The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. */ speechRecognitionConfidence?: number; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `payload` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response. */ webhookPayload?: {[key: string]: any}; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `source` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response. */ webhookSource?: string; } @@ -2494,20 +1996,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2RestoreAgentRequest { /** - * The agent to restore. Example for how to restore an agent via the - * command line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:restore\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary "{ 'agentContent': - * '$(cat &lt;agent zip file&gt; | base64 -w 0)' - * }"</pre> + * The agent to restore. Example for how to restore an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:restore\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre> */ agentContent?: string; /** - * The URI to a Google Cloud Storage file containing the agent to restore. - * Note: The URI must start with "gs://". + * The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://". */ agentUri?: string; } @@ -2516,30 +2009,24 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2SearchAgentsResponse { /** - * The list of agents. There will be a maximum number of items returned - * based on the page_size field in the request. + * The list of agents. There will be a maximum number of items returned based on the page_size field in the request. */ agents?: Schema$GoogleCloudDialogflowV2Agent[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } /** - * The sentiment, such as positive/negative feeling or association, for a unit - * of analysis, such as the query text. + * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. */ export interface Schema$GoogleCloudDialogflowV2Sentiment { /** - * A non-negative number in the [0, +inf) range, which represents the - * absolute magnitude of sentiment, regardless of score (positive or - * negative). + * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */ magnitude?: number; /** - * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - * sentiment). + * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ score?: number; } @@ -2548,15 +2035,12 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2SentimentAnalysisRequestConfig { /** - * Optional. Instructs the service to perform sentiment analysis on - * `query_text`. If not provided, sentiment analysis is not performed on - * `query_text`. + * Optional. Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`. */ analyzeQueryTextSentiment?: boolean; } /** - * The result of sentiment analysis as configured by - * `sentiment_analysis_request_config`. + * The result of sentiment analysis as configured by `sentiment_analysis_request_config`. */ export interface Schema$GoogleCloudDialogflowV2SentimentAnalysisResult { /** @@ -2565,28 +2049,19 @@ export namespace dialogflow_v2 { queryTextSentiment?: Schema$GoogleCloudDialogflowV2Sentiment; } /** - * Represents a session entity type. Extends or replaces a developer entity - * type at the user session level (we refer to the entity types defined at the - * agent level as "developer entity types"). Note: session entity - * types apply to all queries, regardless of the language. + * Represents a session entity type. Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as "developer entity types"). Note: session entity types apply to all queries, regardless of the language. */ export interface Schema$GoogleCloudDialogflowV2SessionEntityType { /** - * Required. The collection of entities associated with this session entity - * type. + * Required. The collection of entities associated with this session entity type. */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** - * Required. Indicates whether the additional data should override or - * supplement the developer entity type definition. + * Required. Indicates whether the additional data should override or supplement the developer entity type definition. */ entityOverrideMode?: string; /** - * Required. The unique identifier of this session entity type. Format: - * `projects/<Project ID>/agent/sessions/<Session - * ID>/entityTypes/<Entity Type Display Name>`. `<Entity Type - * Display Name>` must be the display name of an existing entity type in - * the same agent that will be overridden or supplemented. + * Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. */ name?: string; } @@ -2595,22 +2070,15 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2SynthesizeSpeechConfig { /** - * Optional. An identifier which selects 'audio effects' profiles - * that are applied on (post synthesized) text to speech. Effects are - * applied on top of each other in the order they are given. + * Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. */ effectsProfileId?: string[]; /** - * Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase - * 20 semitones from the original pitch. -20 means decrease 20 semitones - * from the original pitch. + * Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number; /** - * Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the - * normal native speed supported by the specific voice. 2.0 is twice as - * fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 - * speed. Any other values < 0.25 or > 4.0 will return an error. + * Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ speakingRate?: number; /** @@ -2618,14 +2086,7 @@ export namespace dialogflow_v2 { */ voice?: Schema$GoogleCloudDialogflowV2VoiceSelectionParams; /** - * Optional. Volume gain (in dB) of the normal native volume supported by - * the specific voice, in the range [-96.0, 16.0]. If unset, or set to a - * value of 0.0 (dB), will play at normal native signal amplitude. A value - * of -6.0 (dB) will play at approximately half the amplitude of the normal - * native signal amplitude. A value of +6.0 (dB) will play at approximately - * twice the amplitude of the normal native signal amplitude. We strongly - * recommend not to exceed +10 (dB) as there's usually no effective - * increase in loudness for any value greater than that. + * Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ volumeGainDb?: number; } @@ -2634,15 +2095,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2TextInput { /** - * Required. The language of this conversational query. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** - * Required. The UTF-8 encoded natural language text to be processed. Text - * length must not exceed 256 characters. + * Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. */ text?: string; } @@ -2655,17 +2112,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2VoiceSelectionParams { /** - * Optional. The name of the voice. If not set, the service will choose a - * voice based on the other parameters such as language_code and gender. + * Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and gender. */ name?: string; /** - * Optional. The preferred gender of the voice. If not set, the service will - * choose a voice based on the other parameters such as language_code and - * name. Note that this is only a preference, not requirement. If a voice of - * the appropriate gender is not available, the synthesizer should - * substitute a voice with a different gender rather than failing the - * request. + * Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ ssmlGender?: string; } @@ -2674,26 +2125,19 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2WebhookRequest { /** - * Optional. The contents of the original request that was passed to - * `[Streaming]DetectIntent` call. + * Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call. */ originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest; /** - * The result of the conversational query or event processing. Contains the - * same value as `[Streaming]DetectIntentResponse.query_result`. + * The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`. */ queryResult?: Schema$GoogleCloudDialogflowV2QueryResult; /** - * The unique identifier of the response. Contains the same value as - * `[Streaming]DetectIntentResponse.response_id`. + * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. */ responseId?: string; /** - * The unique identifier of detectIntent request session. Can be used to - * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`, or - * `projects/<Project ID>/agent/environments/<Environment - * ID>/users/<User ID>/sessions/<Session ID>`. + * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -2702,37 +2146,23 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2WebhookResponse { /** - * Optional. Makes the platform immediately invoke another `DetectIntent` - * call internally with the specified event as input. + * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. */ followupEventInput?: Schema$GoogleCloudDialogflowV2EventInput; /** - * Optional. The collection of rich messages to present to the user. This - * value is passed directly to `QueryResult.fulfillment_messages`. + * Optional. The collection of rich messages to present to the user. This value is passed directly to `QueryResult.fulfillment_messages`. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed - * directly to `QueryResult.fulfillment_text`. + * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. */ fulfillmentText?: string; /** - * Optional. The collection of output contexts. This value is passed - * directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_payload`. - * See the related `fulfillment_messages[i].payload field`, which may be - * used as an alternative to this field. This field can be used for Actions - * on Google responses. It should have a structure similar to the JSON - * message shown here. For more information, see [Actions on Google Webhook - * Format](https://developers.google.com/actions/dialogflow/webhook) - * <pre>{ "google": { "expectUserResponse": - * true, "richResponse": { "items": [ { - * "simpleResponse": { "textToSpeech": - * "this is a simple response" } } ] } - * } }</pre> + * Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre> */ payload?: {[key: string]: any}; /** @@ -2741,14 +2171,11 @@ export namespace dialogflow_v2 { source?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2756,72 +2183,24 @@ export namespace dialogflow_v2 { */ error?: Schema$GoogleRpcStatus; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobufEmpty {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpcStatus { /** @@ -2829,23 +2208,16 @@ export namespace dialogflow_v2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$GoogleTypeLatLng { /** @@ -2960,8 +2332,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to fetch is associated with. Format: - * `projects/`. + * Required. The project that the agent to fetch is associated with. Format: `projects/`. */ parent?: string; } @@ -2980,8 +2351,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.export - * @desc Exports the specified agent to a ZIP file. Operation + * @desc Exports the specified agent to a ZIP file. Operation * @alias dialogflow.projects.agent.export * @memberOf! () * @@ -3063,10 +2433,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.import - * @desc Imports the specified agent from a ZIP file. Uploads new intents and - * entity types without deleting the existing ones. Intents and entity types - * with the same name are replaced with the new versions from - * ImportAgentRequest. Operation + * @desc Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation * @alias dialogflow.projects.agent.import * @memberOf! () * @@ -3230,11 +2597,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.search - * @desc Returns the list of agents. Since there is at most one - * conversational agent per project, this method is useful primarily for - * listing all agents across projects the caller has access to. One can - * achieve that with a wildcard project collection id "-". Refer to [List - * Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). + * @desc Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). * @alias dialogflow.projects.agent.search * @memberOf! () * @@ -3335,8 +2698,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.train - * @desc Trains the specified agent. Operation + * @desc Trains the specified agent. Operation * @alias dialogflow.projects.agent.train * @memberOf! () * @@ -3425,8 +2787,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to export is associated with. - * Format: `projects/`. + * Required. The project that the agent to export is associated with. Format: `projects/`. */ parent?: string; @@ -3443,8 +2804,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to import is associated with. - * Format: `projects/`. + * Required. The project that the agent to import is associated with. Format: `projects/`. */ parent?: string; @@ -3461,8 +2821,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to restore is associated with. - * Format: `projects/`. + * Required. The project that the agent to restore is associated with. Format: `projects/`. */ parent?: string; @@ -3479,18 +2838,15 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The project to list agents from. Format: `projects/`. + * Required. The project to list agents from. Format: `projects/`. */ parent?: string; } @@ -3502,8 +2858,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to train is associated with. Format: - * `projects/`. + * Required. The project that the agent to train is associated with. Format: `projects/`. */ parent?: string; @@ -3525,8 +2880,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.entityTypes.batchDelete - * @desc Deletes entity types in the specified agent. Operation + * @desc Deletes entity types in the specified agent. Operation * @alias dialogflow.projects.agent.entityTypes.batchDelete * @memberOf! () * @@ -3608,8 +2962,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.entityTypes.batchUpdate - * @desc Updates/Creates multiple entity types in the specified agent. - * Operation + * @desc Updates/Creates multiple entity types in the specified agent. Operation * @alias dialogflow.projects.agent.entityTypes.batchUpdate * @memberOf! () * @@ -4120,8 +3473,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to delete all entities types for. Format: - * `projects//agent`. + * Required. The name of the agent to delete all entities types for. Format: `projects//agent`. */ parent?: string; @@ -4138,8 +3490,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to update or create entity types in. - * Format: `projects//agent`. + * Required. The name of the agent to update or create entity types in. Format: `projects//agent`. */ parent?: string; @@ -4156,16 +3507,11 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language of entity synonyms defined in `entity_type`. If - * not specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The agent to create a entity type for. Format: - * `projects//agent`. + * Required. The agent to create a entity type for. Format: `projects//agent`. */ parent?: string; @@ -4182,8 +3528,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to delete. Format: - * `projects//agent/entityTypes/`. + * Required. The name of the entity type to delete. Format: `projects//agent/entityTypes/`. */ name?: string; } @@ -4195,16 +3540,11 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language to retrieve entity synonyms for. If not specified, - * the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The name of the entity type. Format: `projects//agent/entityTypes/`. + * Required. The name of the entity type. Format: `projects//agent/entityTypes/`. */ name?: string; } @@ -4216,26 +3556,19 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language to list entity synonyms for. If not specified, the - * agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The agent to list all entity types from. Format: - * `projects//agent`. + * Required. The agent to list all entity types from. Format: `projects//agent`. */ parent?: string; } @@ -4247,18 +3580,11 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language of entity synonyms defined in `entity_type`. If - * not specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * The unique identifier of the entity type. Required for - * EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - * methods. Format: `projects//agent/entityTypes/`. + * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`. */ name?: string; /** @@ -4280,8 +3606,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.entityTypes.entities.batchCreate - * @desc Creates multiple new entities in the specified entity type. - * Operation + * @desc Creates multiple new entities in the specified entity type. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchCreate * @memberOf! () * @@ -4363,8 +3688,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.entityTypes.entities.batchDelete - * @desc Deletes entities in the specified entity type. Operation - * + * @desc Deletes entities in the specified entity type. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchDelete * @memberOf! () * @@ -4446,10 +3770,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.entityTypes.entities.batchUpdate - * @desc Updates or creates multiple entities in the specified entity type. - * This method does not affect entities in the entity type that aren't - * explicitly specified in the request. Operation + * @desc Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchUpdate * @memberOf! () * @@ -4538,8 +3859,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to create entities in. Format: - * `projects//agent/entityTypes/`. + * Required. The name of the entity type to create entities in. Format: `projects//agent/entityTypes/`. */ parent?: string; @@ -4556,8 +3876,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to delete entries for. Format: - * `projects//agent/entityTypes/`. + * Required. The name of the entity type to delete entries for. Format: `projects//agent/entityTypes/`. */ parent?: string; @@ -4574,8 +3893,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to update or create entities in. - * Format: `projects//agent/entityTypes/`. + * Required. The name of the entity type to update or create entities in. Format: `projects//agent/entityTypes/`. */ parent?: string; @@ -4593,8 +3911,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.intents.batchDelete - * @desc Deletes intents in the specified agent. Operation + * @desc Deletes intents in the specified agent. Operation * @alias dialogflow.projects.agent.intents.batchDelete * @memberOf! () * @@ -4676,8 +3993,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.intents.batchUpdate - * @desc Updates/Creates multiple intents in the specified agent. Operation - * + * @desc Updates/Creates multiple intents in the specified agent. Operation * @alias dialogflow.projects.agent.intents.batchUpdate * @memberOf! () * @@ -4845,8 +4161,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.intents.delete - * @desc Deletes the specified intent and its direct or indirect followup - * intents. + * @desc Deletes the specified intent and its direct or indirect followup intents. * @alias dialogflow.projects.agent.intents.delete * @memberOf! () * @@ -5191,8 +4506,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to delete all entities types for. Format: - * `projects//agent`. + * Required. The name of the agent to delete all entities types for. Format: `projects//agent`. */ parent?: string; @@ -5209,8 +4523,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to update or create intents in. Format: - * `projects//agent`. + * Required. The name of the agent to update or create intents in. Format: `projects//agent`. */ parent?: string; @@ -5231,17 +4544,11 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages - * defined in `intent`. If not specified, the agent's default language is - * used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The agent to create a intent for. Format: `projects//agent`. + * Required. The agent to create a intent for. Format: `projects//agent`. */ parent?: string; @@ -5258,9 +4565,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the intent to delete. If this intent has direct or - * indirect followup intents, we also delete them. Format: - * `projects//agent/intents/`. + * Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: `projects//agent/intents/`. */ name?: string; } @@ -5276,17 +4581,11 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language to retrieve training phrases, parameters and rich - * messages for. If not specified, the agent's default language is used. - * [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The name of the intent. Format: `projects//agent/intents/`. + * Required. The name of the intent. Format: `projects//agent/intents/`. */ name?: string; } @@ -5302,27 +4601,19 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language to list training phrases, parameters and rich - * messages for. If not specified, the agent's default language is used. - * [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The agent to list all intents from. Format: `projects//agent`. + * Required. The agent to list all intents from. Format: `projects//agent`. */ parent?: string; } @@ -5338,18 +4629,11 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages - * defined in `intent`. If not specified, the agent's default language is - * used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent - * and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. + * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. */ name?: string; /** @@ -5455,10 +4739,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.detectIntent - * @desc Processes a natural language query and returns structured, - * actionable data as a result. This method is not idempotent, because it - * may cause contexts and session entity types to be updated, which in turn - * might affect results of future queries. + * @desc Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. * @alias dialogflow.projects.agent.sessions.detectIntent * @memberOf! () * @@ -5565,8 +4846,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session to delete all contexts from. Format: - * `projects//agent/sessions/`. + * Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/`. */ parent?: string; } @@ -5578,11 +4858,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session this query is sent to. Format: - * `projects//agent/sessions/`. It's up to the API - * caller to choose an appropriate session ID. It can be a random number or - * some type of user identifier (preferably hashed). The length of the - * session ID must not exceed 36 bytes. + * Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes. */ session?: string; @@ -5600,8 +4876,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.contexts.create - * @desc Creates a context. If the specified context already exists, - * overrides the context. + * @desc Creates a context. If the specified context already exists, overrides the context. * @alias dialogflow.projects.agent.sessions.contexts.create * @memberOf! () * @@ -6026,8 +5301,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The session to create a context for. Format: `projects//agent/sessions/`. + * Required. The session to create a context for. Format: `projects//agent/sessions/`. */ parent?: string; @@ -6044,8 +5318,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/`. + * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/`. */ name?: string; } @@ -6057,8 +5330,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the context. Format: `projects//agent/sessions//contexts/`. + * Required. The name of the context. Format: `projects//agent/sessions//contexts/`. */ name?: string; } @@ -6070,18 +5342,15 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The session to list all contexts from. Format: - * `projects//agent/sessions/`. + * Required. The session to list all contexts from. Format: `projects//agent/sessions/`. */ parent?: string; } @@ -6093,10 +5362,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The unique identifier of the context. Format: - * `projects//agent/sessions//contexts/`. The `Context ID` is always converted to lowercase, may only - * contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. + * Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. */ name?: string; /** @@ -6118,8 +5384,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.entityTypes.create - * @desc Creates a session entity type. If the specified session entity - * type already exists, overrides the session entity type. + * @desc Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. * @alias dialogflow.projects.agent.sessions.entityTypes.create * @memberOf! () * @@ -6370,8 +5635,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.entityTypes.list - * @desc Returns the list of all session entity types in the specified - * session. + * @desc Returns the list of all session entity types in the specified session. * @alias dialogflow.projects.agent.sessions.entityTypes.list * @memberOf! () * @@ -6570,8 +5834,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The session to create a session entity type for. Format: - * `projects//agent/sessions/`. + * Required. The session to create a session entity type for. Format: `projects//agent/sessions/`. */ parent?: string; @@ -6588,9 +5851,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to delete. Format: - * `projects//agent/sessions//entityTypes/`. + * Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/`. */ name?: string; } @@ -6602,8 +5863,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/`. + * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/`. */ name?: string; } @@ -6615,18 +5875,15 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The session to list all session entity types from. Format: - * `projects//agent/sessions/`. + * Required. The session to list all session entity types from. Format: `projects//agent/sessions/`. */ parent?: string; } @@ -6638,11 +5895,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The unique identifier of this session entity type. Format: - * `projects//agent/sessions//entityTypes/`. `` must be the display - * name of an existing entity type in the same agent that will be overridden - * or supplemented. + * Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. */ name?: string; /** @@ -6664,9 +5917,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias dialogflow.projects.operations.get * @memberOf! () * diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index b310d1317ba..f2160a782db 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace dialogflow_v2beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace dialogflow_v2beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace dialogflow_v2beta1 { /** * Dialogflow API * - * Builds conversational interfaces (for example, chatbots, and voice-powered - * apps and devices). + * Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace dialogflow_v2beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -142,33 +140,19 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1Agent { /** - * Optional. The URI of the agent's avatar. Avatars are used throughout - * the Dialogflow console and in the self-hosted [Web - * Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo) - * integration. + * Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo) integration. */ avatarUri?: string; /** - * Optional. To filter out false positive results and still get variety in - * matched natural language inputs for your agent, you can tune the machine - * learning classification threshold. If the returned score value is less - * than the threshold value, then a fallback intent will be triggered or, if - * there are no fallback intents defined, no intent will be triggered. The - * score values range from 0.0 (completely uncertain) to 1.0 (completely - * certain). If set to 0.0, the default of 0.3 is used. + * Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. */ classificationThreshold?: number; /** - * Required. The default language of the agent as a language tag. See - * [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. This field cannot - * be set by the `Update` method. + * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. */ defaultLanguageCode?: string; /** - * Optional. The description of this agent. The maximum length is 500 - * characters. If exceeded, the request is rejected. + * Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. */ description?: string; /** @@ -184,19 +168,15 @@ export namespace dialogflow_v2beta1 { */ matchMode?: string; /** - * Required. The project of this agent. Format: `projects/<Project - * ID>`. + * Required. The project of this agent. Format: `projects/<Project ID>`. */ parent?: string; /** - * Optional. The list of all languages supported by this agent (except for - * the `default_language_code`). + * Optional. The list of all languages supported by this agent (except for the `default_language_code`). */ supportedLanguageCodes?: string[]; /** - * Required. The time zone of this agent from the [time zone - * database](https://www.iana.org/time-zones), e.g., America/New_York, - * Europe/Paris. + * Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. */ timeZone?: string; } @@ -209,11 +189,7 @@ export namespace dialogflow_v2beta1 { */ entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not - * specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; } @@ -222,17 +198,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest { /** - * Required. The canonical `values` of the entities to delete. Note that - * these are not fully-qualified names, i.e. they don't start with - * `projects/<Project ID>`. + * Required. The canonical `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/<Project ID>`. */ entityValues?: string[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not - * specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; } @@ -241,8 +211,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest { /** - * Required. The names entity types to delete. All names must point to the - * same agent as `parent`. + * Required. The names entity types to delete. All names must point to the same agent as `parent`. */ entityTypeNames?: string[]; } @@ -251,8 +220,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest { /** - * Required. The collection of intents to delete. Only intent `name` must be - * filled in. + * Required. The collection of intents to delete. Only intent `name` must be filled in. */ intents?: Schema$GoogleCloudDialogflowV2beta1Intent[]; } @@ -265,11 +233,7 @@ export namespace dialogflow_v2beta1 { */ entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not - * specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -286,18 +250,11 @@ export namespace dialogflow_v2beta1 { */ entityTypeBatchInline?: Schema$GoogleCloudDialogflowV2beta1EntityTypeBatch; /** - * The URI to a Google Cloud Storage file containing entity types to update - * or create. The file format can either be a serialized proto (of - * EntityBatch type) or a JSON object. Note: The URI must start with - * "gs://". + * The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://". */ entityTypeBatchUri?: string; /** - * Optional. The language of entity synonyms defined in `entity_types`. If - * not specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entity_types`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -323,9 +280,7 @@ export namespace dialogflow_v2beta1 { */ intentBatchInline?: Schema$GoogleCloudDialogflowV2beta1IntentBatch; /** - * The URI to a Google Cloud Storage file containing intents to update or - * create. The file format can either be a serialized proto (of IntentBatch - * type) or JSON object. Note: The URI must start with "gs://". + * The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://". */ intentBatchUri?: string; /** @@ -333,12 +288,7 @@ export namespace dialogflow_v2beta1 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages - * defined in `intents`. If not specified, the agent's default language - * is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intents`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -360,30 +310,15 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1Context { /** - * Optional. The number of conversational query requests after which the - * context expires. If set to `0` (the default) the context expires - * immediately. Contexts expire automatically after 20 minutes if there are - * no matching queries. + * Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. */ lifespanCount?: number; /** - * Required. The unique identifier of the context. Format: - * `projects/<Project ID>/agent/sessions/<Session - * ID>/contexts/<Context ID>`, or `projects/<Project - * ID>/agent/environments/<Environment ID>/users/<User - * ID>/sessions/<Session ID>/contexts/<Context ID>`. The - * `Context ID` is always converted to lowercase, may only contain - * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If - * `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' - * user. + * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; /** - * Optional. The collection of parameters associated with this context. - * Refer to [this - * doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) - * for syntax. + * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax. */ parameters?: {[key: string]: any}; } @@ -392,22 +327,15 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1DetectIntentRequest { /** - * Optional. The natural language speech audio to be processed. This field - * should be populated iff `query_input` is set to an input audio config. A - * single request can contain up to 1 minute of speech audio data. + * Optional. The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data. */ inputAudio?: string; /** - * Optional. Instructs the speech synthesizer how to generate the output - * audio. If this field is not set and agent-level speech synthesizer is not - * configured, no output audio is generated. + * Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated. */ outputAudioConfig?: Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig; /** - * Required. The input specification. It can be set to: 1. an audio config - * which instructs the speech recognizer how to process the speech audio, 2. - * a conversational query in the form of text, or 3. an event that - * specifies which intent to trigger. + * Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. */ queryInput?: Schema$GoogleCloudDialogflowV2beta1QueryInput; /** @@ -420,39 +348,23 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse { /** - * If Knowledge Connectors are enabled, there could be more than one result - * returned for a given query or event, and this field will contain all - * results except for the top one, which is captured in query_result. The - * alternative results are ordered by decreasing - * `QueryResult.intent_detection_confidence`. If Knowledge Connectors are - * disabled, this field will be empty until multiple responses for regular - * intents are supported, at which point those additional results will be - * surfaced here. + * If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing `QueryResult.intent_detection_confidence`. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here. */ alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; /** - * The audio data bytes encoded as specified in the request. Note: The - * output audio is generated based on the values of default platform text - * responses found in the `query_result.fulfillment_messages` field. If - * multiple default text responses exist, they will be concatenated when - * generating audio. If no default platform text responses exist, the - * generated audio content will be empty. + * The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.fulfillment_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. */ outputAudio?: string; /** - * Instructs the speech synthesizer how to generate the output audio. This - * field is populated from the agent-level speech synthesizer configuration, - * if enabled. + * Instructs the speech synthesizer how to generate the output audio. This field is populated from the agent-level speech synthesizer configuration, if enabled. */ outputAudioConfig?: Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig; /** - * The selected results of the conversational query or event processing. See - * `alternative_query_results` for additional potential results. + * The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results. */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; /** - * The unique identifier of the response. It can be used to locate a - * response in the training example set or for reporting issues. + * The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. */ responseId?: string; /** @@ -461,30 +373,19 @@ export namespace dialogflow_v2beta1 { webhookStatus?: Schema$GoogleRpcStatus; } /** - * A document resource. Note: resource - * `projects.agent.knowledgeBases.documents` is deprecated, please use - * `projects.knowledgeBases.documents` instead. + * A document resource. Note: resource `projects.agent.knowledgeBases.documents` is deprecated, please use `projects.knowledgeBases.documents` instead. */ export interface Schema$GoogleCloudDialogflowV2beta1Document { /** - * The raw content of the document. This field is only permitted for - * EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process - * of being deprecated, please use raw_content instead. + * The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead. */ content?: string; /** - * The URI where the file content is located. For documents stored in - * Google Cloud Storage, these URIs must have the form - * `gs://<bucket-name>/<object-name>`. NOTE: External URLs must - * correspond to public webpages, i.e., they must be indexed by Google - * Search. In particular, URLs for showing documents in Google Cloud Storage - * (i.e. the URL in your browser) are not supported. Instead use the `gs://` - * format URI described above. + * The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form `gs://<bucket-name>/<object-name>`. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the `gs://` format URI described above. */ contentUri?: string; /** - * Required. The display name of the document. The name must be 1024 bytes - * or less; otherwise, the creation request fails. + * Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails. */ displayName?: string; /** @@ -496,26 +397,20 @@ export namespace dialogflow_v2beta1 { */ mimeType?: string; /** - * The document resource name. The name must be empty when creating a - * document. Format: `projects/<Project - * ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document - * ID>`. + * The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. */ name?: string; /** - * The raw content of the document. This field is only permitted for - * EXTRACTIVE_QA and FAQ knowledge types. + * The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. */ rawContent?: string; } /** - * Represents an entity type. Entity types serve as a tool for extracting - * parameter values from natural language queries. + * Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. */ export interface Schema$GoogleCloudDialogflowV2beta1EntityType { /** - * Optional. Indicates whether the entity type can be automatically - * expanded. + * Optional. Indicates whether the entity type can be automatically expanded. */ autoExpansionMode?: string; /** @@ -523,8 +418,7 @@ export namespace dialogflow_v2beta1 { */ displayName?: string; /** - * Optional. The collection of entity entries associated with the entity - * type. + * Optional. The collection of entity entries associated with the entity type. */ entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[]; /** @@ -532,10 +426,7 @@ export namespace dialogflow_v2beta1 { */ kind?: string; /** - * The unique identifier of the entity type. Required for - * EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - * methods. Format: `projects/<Project - * ID>/agent/entityTypes/<Entity Type ID>`. + * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. */ name?: string; } @@ -553,36 +444,20 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity { /** - * Required. A collection of value synonyms. For example, if the entity type - * is *vegetable*, and `value` is *scallions*, a synonym could be *green - * onions*. For `KIND_LIST` entity types: * This collection must contain - * exactly one synonym equal to `value`. + * Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. */ synonyms?: string[]; /** - * Required. The primary value associated with this entity entry. For - * example, if the entity type is *vegetable*, the value could be - * *scallions*. For `KIND_MAP` entity types: * A canonical value to be - * used in place of synonyms. For `KIND_LIST` entity types: * A string - * that can contain references to other entity types (with or without - * aliases). + * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). */ value?: string; } /** - * Events allow for matching intents by event name instead of the natural - * language input. For instance, input `<event: { name: - * "welcome_event", parameters: { name: "Sam" } }>` can - * trigger a personalized welcome response. The parameter `name` may be used - * by the agent in the response: `"Hello #welcome_event.name! What can I - * do for you today?"`. + * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ export interface Schema$GoogleCloudDialogflowV2beta1EventInput { /** - * Required. The language of this query. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** @@ -599,11 +474,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentRequest { /** - * Optional. The [Google Cloud - * Storage](https://cloud.google.com/storage/docs/) URI to export the agent - * to. The format of this URI must be - * `gs://<bucket-name>/<object-name>`. If left unspecified, the - * serialized agent is returned inline. + * Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline. */ agentUri?: string; } @@ -612,21 +483,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentResponse { /** - * The exported agent. Example for how to export an agent to a zip file via - * a command line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary '{}' \ | grep agentContent | sed - * -e 's/.*"agentContent": - * "\([^"]*\)".x/\1/' \ | base64 --decode > - * &lt;agent zip file&gt;</pre> + * The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre> */ agentContent?: string; /** - * The URI to a file containing the exported agent. This field is populated - * only if `agent_uri` is specified in `ExportAgentRequest`. + * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`. */ agentUri?: string; } @@ -635,25 +496,16 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ImportAgentRequest { /** - * The agent to import. Example for how to import an agent via the command - * line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:import\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary "{ 'agentContent': - * '$(cat &lt;agent zip file&gt; | base64 -w 0)' - * }"</pre> + * The agent to import. Example for how to import an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:import\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre> */ agentContent?: string; /** - * The URI to a Google Cloud Storage file containing the agent to import. - * Note: The URI must start with "gs://". + * The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://". */ agentUri?: string; } /** - * Instructs the speech recognizer how to process the audio content. + * Instructs the speech recognizer on how to process the audio content. */ export interface Schema$GoogleCloudDialogflowV2beta1InputAudioConfig { /** @@ -661,54 +513,36 @@ export namespace dialogflow_v2beta1 { */ audioEncoding?: string; /** - * Required. The language of the supplied audio. Dialogflow does not do - * translations. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** - * Optional. Which Speech model to select for the given request. Select the - * model best suited to your domain to get best results. If a model is not - * explicitly specified, then we auto-select a model based on the parameters - * in the InputAudioConfig. If enhanced speech model is enabled for the - * agent and an enhanced version of the specified model for the language - * does not exist, then the speech is recognized using the standard version - * of the specified model. Refer to [Cloud Speech API - * documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) - * for more details. + * Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. */ model?: string; /** - * Optional. The collection of phrase hints which are used to boost accuracy - * of speech recognition. Refer to [Cloud Speech API - * documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) - * for more details. + * Optional. Which variant of the Speech model to use. + */ + modelVariant?: string; + /** + * Optional. The collection of phrase hints which are used to boost accuracy of speech recognition. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. */ phraseHints?: string[]; /** - * Required. Sample rate (in Hertz) of the audio content sent in the query. - * Refer to [Cloud Speech API - * documentation](https://cloud.google.com/speech-to-text/docs/basics) for - * more details. + * Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. */ sampleRateHertz?: number; } /** - * Represents an intent. Intents convert a number of user expressions or - * patterns into an action. An action is an extraction of a user command or - * sentence semantics. + * Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2beta1Intent { /** - * Optional. The name of the action associated with the intent. Note: The - * action name must not contain whitespaces. + * Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. */ action?: string; /** - * Optional. The list of platforms for which the first response will be - * taken from among the messages assigned to the DEFAULT_PLATFORM. + * Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM. */ defaultResponsePlatforms?: string[]; /** @@ -716,27 +550,19 @@ export namespace dialogflow_v2beta1 { */ displayName?: string; /** - * Optional. Indicates that this intent ends an interaction. Some - * integrations (e.g., Actions on Google or Dialogflow phone gateway) use - * this information to close interaction with an end user. Default is false. + * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. */ endInteraction?: boolean; /** - * Optional. The collection of event names that trigger the intent. If the - * collection of input contexts is not empty, all of the contexts must be - * present in the active user session for an event to trigger this intent. + * Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. */ events?: string[]; /** - * Read-only. Information about all followup intents that have this intent - * as a direct or indirect parent. We populate this field only in the - * output. + * Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. */ followupIntentInfo?: Schema$GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo[]; /** - * Optional. The list of context names required for this intent to be - * triggered. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ inputContextNames?: string[]; /** @@ -744,41 +570,23 @@ export namespace dialogflow_v2beta1 { */ isFallback?: boolean; /** - * Optional. The collection of rich messages corresponding to the `Response` - * field in the Dialogflow console. + * Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. */ messages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * Optional. Indicates whether Machine Learning is disabled for the intent. - * Note: If `ml_disabled` setting is set to true, then this intent is not - * taken into account during inference in `ML ONLY` match mode. Also, - * auto-markup in the UI is turned off. + * Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. */ mlDisabled?: boolean; /** - * Optional. Indicates whether Machine Learning is enabled for the intent. - * Note: If `ml_enabled` setting is set to false, then this intent is not - * taken into account during inference in `ML ONLY` match mode. Also, - * auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` - * field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either - * not set or false, then the default value is determined as follows: - - * Before April 15th, 2018 the default is: ml_enabled = false / - * ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled - * = true / ml_disabled = false. + * Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false. */ mlEnabled?: boolean; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent - * and Intents.BatchUpdateIntents methods. Format: `projects/<Project - * ID>/agent/intents/<Intent ID>`. + * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ name?: string; /** - * Optional. The collection of contexts that are activated when the intent - * is matched. Context messages in this collection should not set the - * parameters field. Setting the `lifespan_count` to 0 will reset the - * context when the intent is matched. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** @@ -786,30 +594,19 @@ export namespace dialogflow_v2beta1 { */ parameters?: Schema$GoogleCloudDialogflowV2beta1IntentParameter[]; /** - * Read-only after creation. The unique identifier of the parent intent in - * the chain of followup intents. You can set this field when creating an - * intent, for example with CreateIntent or BatchUpdateIntents, in order to - * make this intent a followup intent. It identifies the parent followup - * intent. Format: `projects/<Project ID>/agent/intents/<Intent - * ID>`. + * Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; /** - * Optional. The priority of this intent. Higher numbers represent higher - * priorities. If this is zero or unspecified, we use the default priority - * 500000. Negative numbers mean that the intent is disabled. + * Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** - * Optional. Indicates whether to delete all contexts in the current session - * when this intent is matched. + * Optional. Indicates whether to delete all contexts in the current session when this intent is matched. */ resetContexts?: boolean; /** - * Read-only. The unique identifier of the root intent in the chain of - * followup intents. It identifies the correct followup intents chain for - * this intent. We populate this field only in the output. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ rootFollowupIntentName?: string; /** @@ -835,13 +632,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo { /** - * The unique identifier of the followup intent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ followupIntentName?: string; /** - * The unique identifier of the followup intent's parent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; } @@ -874,9 +669,7 @@ export namespace dialogflow_v2beta1 { */ listSelect?: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelect; /** - * Returns a response containing a custom, platform-specific payload. See - * the Intent.Message.Platform type for a description of the structure that - * may be required for your platform. + * Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. */ payload?: {[key: string]: any}; /** @@ -1028,8 +821,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageImage { /** - * A text description of the image to be used for accessibility, e.g., - * screen readers. Required if image_uri is set for CarouselSelect. + * A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect. */ accessibilityText?: string; /** @@ -1038,8 +830,7 @@ export namespace dialogflow_v2beta1 { imageUri?: string; } /** - * The suggestion chip message that allows the user to jump out to the app or - * website associated with this agent. + * The suggestion chip message that allows the user to jump out to the app or website associated with this agent. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion { /** @@ -1047,8 +838,7 @@ export namespace dialogflow_v2beta1 { */ destinationName?: string; /** - * Required. The URI of the app or site to open when the user taps the - * suggestion chip. + * Required. The URI of the app or site to open when the user taps the suggestion chip. */ uri?: string; } @@ -1104,13 +894,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo { /** - * Required. A unique key that will be sent back to the agent if this - * response is given. + * Required. A unique key that will be sent back to the agent if this response is given. */ key?: string; /** - * Optional. A list of synonyms that can also be used to trigger this item - * in dialog. + * Optional. A list of synonyms that can also be used to trigger this item in dialog. */ synonyms?: string[]; } @@ -1123,22 +911,16 @@ export namespace dialogflow_v2beta1 { */ displayText?: string; /** - * One of text_to_speech or ssml must be provided. Structured spoken - * response to the user in the SSML format. Mutually exclusive with - * text_to_speech. + * One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. */ ssml?: string; /** - * One of text_to_speech or ssml must be provided. The plain text of the - * speech output. Mutually exclusive with ssml. + * One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. */ textToSpeech?: string; } /** - * The collection of simple response candidates. This message in - * `QueryResult.fulfillment_messages` and - * `WebhookResponse.fulfillment_messages` should contain only one - * `SimpleResponse`. + * The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses { /** @@ -1147,8 +929,7 @@ export namespace dialogflow_v2beta1 { simpleResponses?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse[]; } /** - * The suggestion chip message that the user can tap to quickly post a reply - * to the conversation. + * The suggestion chip message that the user can tap to quickly post a reply to the conversation. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestion { /** @@ -1170,30 +951,16 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio { /** - * Required. URI to a Google Cloud Storage object containing the audio to - * play, e.g., "gs://bucket/object". The object must contain a - * single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. - * This object must be readable by the `service-<Project - * Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account - * where <Project Number> is the number of the Telephony Gateway - * project (usually the same as the Dialogflow agent project). If the Google - * Cloud Storage bucket is in the Telephony Gateway project, this permission - * is added by default when enabling the Dialogflow V2 API. For audio from - * other sources, consider using the `TelephonySynthesizeSpeech` message - * with SSML. + * Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-<Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where <Project Number> is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML. */ audioUri?: string; } /** - * Synthesizes speech and plays back the synthesized audio to the caller in - * Telephony Gateway. Telephony Gateway takes the synthesizer settings from - * `DetectIntentResponse.output_audio_config` which can either be set at - * request-level or can come from the agent-level synthesizer config. + * Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech { /** - * The SSML to be synthesized. For more information, see - * [SSML](https://developers.google.com/actions/reference/ssml). + * The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml). */ ssml?: string; /** @@ -1206,9 +973,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall { /** - * Required. The phone number to transfer the call to in [E.164 - * format](https://en.wikipedia.org/wiki/E.164). We currently only allow - * transferring to US numbers (+1xxxyyyzzzz). + * Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz). */ phoneNumber?: string; } @@ -1226,9 +991,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentParameter { /** - * Optional. The default value to use when the `value` yields an empty - * result. Default values can be extracted from contexts by using the - * following syntax: `#context_name.parameter_name`. + * Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. */ defaultValue?: string; /** @@ -1236,9 +999,7 @@ export namespace dialogflow_v2beta1 { */ displayName?: string; /** - * Optional. The name of the entity type, prefixed with `@`, that describes - * values of the parameter. If the parameter is required, this must be - * provided. + * Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided. */ entityTypeDisplayName?: string; /** @@ -1246,8 +1007,7 @@ export namespace dialogflow_v2beta1 { */ isList?: boolean; /** - * Optional. Indicates whether the parameter is required. That is, whether - * the intent cannot be completed without collecting the parameter value. + * Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. */ mandatory?: boolean; /** @@ -1255,15 +1015,11 @@ export namespace dialogflow_v2beta1 { */ name?: string; /** - * Optional. The collection of prompts that the agent can present to the - * user in order to collect value for the parameter. + * Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter. */ prompts?: string[]; /** - * Optional. The definition of the parameter value. It can be: - a constant - * string, - a parameter value defined as `$parameter_name`, - an original - * parameter value defined as `$parameter_name.original`, - a parameter - * value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string; } @@ -1276,24 +1032,11 @@ export namespace dialogflow_v2beta1 { */ name?: string; /** - * Required. The ordered list of training phrase parts. The parts are - * concatenated in order to form the training phrase. Note: The API does - * not automatically annotate training phrases like the Dialogflow Console - * does. Note: Do not forget to include whitespace at part boundaries, so - * the training phrase is well formatted when the parts are concatenated. If - * the training phrase does not need to be annotated with parameters, you - * just need a single part with only the Part.text field set. If you want - * to annotate the training phrase, you must create multiple parts, where - * the fields of each part are populated in one of two ways: - `Part.text` - * is set to a part of the phrase that has no parameters. - `Part.text` is - * set to a part of the phrase that you want to annotate, and the - * `entity_type`, `alias`, and `user_defined` fields are all set. + * Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set. */ parts?: Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart[]; /** - * Optional. Indicates how many times this example was added to the intent. - * Each time a developer adds an existing sample by editing an intent or - * training, this counter is increased. + * Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. */ timesAddedCount?: number; /** @@ -1306,14 +1049,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart { /** - * Optional. The parameter name for the value extracted from the annotated - * part of the example. This field is required for annotated parts of the - * training phrase. + * Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. */ alias?: string; /** - * Optional. The entity type name prefixed with `@`. This field is required - * for annotated parts of the training phrase. + * Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase. */ entityType?: string; /** @@ -1321,10 +1061,7 @@ export namespace dialogflow_v2beta1 { */ text?: string; /** - * Optional. Indicates whether the text was manually annotated. This field - * is set to true when the Dialogflow Console is used to manually annotate - * the part. When creating an annotated part with the API, you must set this - * to true. + * Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. */ userDefined?: boolean; } @@ -1342,56 +1079,36 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer { /** - * The piece of text from the `source` knowledge base document that answers - * this conversational query. + * The piece of text from the `source` knowledge base document that answers this conversational query. */ answer?: string; /** - * The corresponding FAQ question if the answer was extracted from a FAQ - * Document, empty otherwise. + * The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise. */ faqQuestion?: string; /** - * The system's confidence score that this Knowledge answer is a good - * match for this conversational query. The range is from 0.0 (completely - * uncertain) to 1.0 (completely certain). Note: The confidence score is - * likely to vary somewhat (possibly even for identical requests), as the - * underlying model is under constant improvement. It may be deprecated in - * the future. We recommend using `match_confidence_level` which should be - * generally more stable. + * The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using `match_confidence_level` which should be generally more stable. */ matchConfidence?: number; /** - * The system's confidence level that this knowledge answer is a good - * match for this conversational query. NOTE: The confidence level for a - * given `<query, answer>` pair may change without notice, as it - * depends on models that are constantly being improved. However, it will - * change less frequently than the confidence score below, and should be - * preferred for referencing the quality of an answer. + * The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `<query, answer>` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer. */ matchConfidenceLevel?: string; /** - * Indicates which Knowledge Document this answer was extracted from. - * Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base - * ID>/documents/<Document ID>`. + * Indicates which Knowledge Document this answer was extracted from. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. */ source?: string; } /** - * Represents knowledge base resource. Note: resource - * `projects.agent.knowledgeBases` is deprecated, please use - * `projects.knowledgeBases` instead. + * Represents knowledge base resource. Note: resource `projects.agent.knowledgeBases` is deprecated, please use `projects.knowledgeBases` instead. */ export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeBase { /** - * Required. The display name of the knowledge base. The name must be 1024 - * bytes or less; otherwise, the creation request fails. + * Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails. */ displayName?: string; /** - * The knowledge base resource name. The name must be empty when creating a - * knowledge base. Format: `projects/<Project - * ID>/knowledgeBases/<Knowledge Base ID>`. + * The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. */ name?: string; } @@ -1409,13 +1126,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ListContextsResponse { /** - * The list of contexts. There will be a maximum number of items returned - * based on the page_size field in the request. + * The list of contexts. There will be a maximum number of items returned based on the page_size field in the request. */ contexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1428,8 +1143,7 @@ export namespace dialogflow_v2beta1 { */ documents?: Schema$GoogleCloudDialogflowV2beta1Document[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1438,13 +1152,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ListEntityTypesResponse { /** - * The list of agent entity types. There will be a maximum number of items - * returned based on the page_size field in the request. + * The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request. */ entityTypes?: Schema$GoogleCloudDialogflowV2beta1EntityType[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1453,13 +1165,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ListIntentsResponse { /** - * The list of agent intents. There will be a maximum number of items - * returned based on the page_size field in the request. + * The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request. */ intents?: Schema$GoogleCloudDialogflowV2beta1Intent[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1472,8 +1182,7 @@ export namespace dialogflow_v2beta1 { */ knowledgeBases?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1482,41 +1191,28 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** - * The list of session entity types. There will be a maximum number of items - * returned based on the page_size field in the request. + * The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[]; } /** - * Represents the contents of the original request that was passed to the - * `[Streaming]DetectIntent` call. + * Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call. */ export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest { /** - * Optional. This field is set to the value of the `QueryParameters.payload` - * field passed in the request. Some integrations that query a Dialogflow - * agent may provide additional information in the payload. In particular - * for the Telephony Gateway this field has the form: <pre>{ - * "telephony": { "caller_id": - * "+18558363987" } }</pre> Note: The caller ID field - * (`caller_id`) will be redacted for Standard Edition agents and populated - * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) - * for Enterprise Edition agents. + * Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. */ payload?: {[key: string]: any}; /** - * The source of this request, e.g., `google`, `facebook`, `slack`. It is - * set by Dialogflow-owned servers. + * The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers. */ source?: string; /** - * Optional. The version of the protocol used for this request. This field - * is AoG-specific. + * Optional. The version of the protocol used for this request. This field is AoG-specific. */ version?: string; } @@ -1529,11 +1225,7 @@ export namespace dialogflow_v2beta1 { */ audioEncoding?: string; /** - * Optional. The synthesis sample rate (in hertz) for this audio. If not - * provided, then the synthesizer will use the default sample rate based on - * the audio encoding. If this is different from the voice's natural - * sample rate, then the synthesizer will honor this request by converting - * to the desired sample rate (which might result in worse audio quality). + * Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). */ sampleRateHertz?: number; /** @@ -1542,10 +1234,7 @@ export namespace dialogflow_v2beta1 { synthesizeSpeechConfig?: Schema$GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig; } /** - * Represents the query input. It can contain either: 1. An audio config - * which instructs the speech recognizer how to process the speech audio. - * 2. A conversational query in the form of text,. 3. An event that - * specifies which intent to trigger. + * Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text,. 3. An event that specifies which intent to trigger. */ export interface Schema$GoogleCloudDialogflowV2beta1QueryInput { /** @@ -1566,8 +1255,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1QueryParameters { /** - * Optional. The collection of contexts to be activated before this query is - * executed. + * Optional. The collection of contexts to be activated before this query is executed. */ contexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** @@ -1575,38 +1263,27 @@ export namespace dialogflow_v2beta1 { */ geoLocation?: Schema$GoogleTypeLatLng; /** - * Optional. KnowledgeBases to get alternative results from. If not set, the - * KnowledgeBases enabled in the agent (through UI) will be used. Format: - * `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. + * Optional. KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. */ knowledgeBaseNames?: string[]; /** - * Optional. This field can be used to pass custom data into the webhook - * associated with the agent. Arbitrary JSON objects are supported. + * Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. */ payload?: {[key: string]: any}; /** - * Optional. Specifies whether to delete all contexts in the current session - * before the new ones are activated. + * Optional. Specifies whether to delete all contexts in the current session before the new ones are activated. */ resetContexts?: boolean; /** - * Optional. Configures the type of sentiment analysis to perform. If not - * provided, sentiment analysis is not performed. Note: Sentiment Analysis - * is only currently available for Enterprise Edition agents. + * Optional. Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Enterprise Edition agents. */ sentimentAnalysisRequestConfig?: Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig; /** - * Optional. Additional session entity types to replace or extend developer - * entity types with. The entity synonyms apply to all languages and persist - * for the session of this query. + * Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[]; /** - * Optional. The time zone of this conversational query from the [time zone - * database](https://www.iana.org/time-zones), e.g., America/New_York, - * Europe/Paris. If not provided, the time zone specified in agent settings - * is used. + * Optional. The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used. */ timeZone?: string; } @@ -1619,16 +1296,11 @@ export namespace dialogflow_v2beta1 { */ action?: string; /** - * This field is set to: - `false` if the matched intent has required - * parameters and not all of the required parameter values have been - * collected. - `true` if all required parameter values have been collected, - * or if the matched intent doesn't contain any required parameters. + * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. */ allRequiredParamsPresent?: boolean; /** - * The free-form diagnostic info. For example, this field could contain - * webhook call latency. The string keys of the Struct's fields map can - * change without notice. + * The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. */ diagnosticInfo?: {[key: string]: any}; /** @@ -1636,39 +1308,27 @@ export namespace dialogflow_v2beta1 { */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * The text to be pronounced to the user or shown on the screen. Note: This - * is a legacy field, `fulfillment_messages` should be preferred. + * The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. */ fulfillmentText?: string; /** - * The intent that matched the conversational query. Some, not all fields - * are filled in this message, including but not limited to: `name`, - * `display_name` and `webhook_state`. + * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`. */ intent?: Schema$GoogleCloudDialogflowV2beta1Intent; /** - * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). If there are `multiple - * knowledge_answers` messages, this value is set to the greatest - * `knowledgeAnswers.match_confidence` value in the list. + * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** - * The result from Knowledge Connector (if any), ordered by decreasing - * `KnowledgeAnswers.match_confidence`. + * The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`. */ knowledgeAnswers?: Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswers; /** - * The language that was triggered during intent detection. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. + * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. */ languageCode?: string; /** - * The collection of output contexts. If applicable, - * `output_contexts.parameters` contains entries with name `<parameter - * name>.original` containing the original parameter values before the - * query. + * The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** @@ -1676,37 +1336,23 @@ export namespace dialogflow_v2beta1 { */ parameters?: {[key: string]: any}; /** - * The original conversational query text: - If natural language text was - * provided as input, `query_text` contains a copy of the input. - If - * natural language speech audio was provided as input, `query_text` - * contains the speech recognition result. If speech recognizer produced - * multiple alternatives, a particular one is picked. - If an event was - * provided as input, `query_text` is not set. + * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set. */ queryText?: string; /** - * The sentiment analysis result, which depends on the - * `sentiment_analysis_request_config` specified in the request. + * The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. */ sentimentAnalysisResult?: Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisResult; /** - * The Speech recognition confidence between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. The default of 0.0 is a sentinel value indicating that - * confidence was not set. This field is not guaranteed to be accurate or - * set. In particular this field isn't set for StreamingDetectIntent - * since the streaming endpoint has separate confidence estimates per - * portion of the audio in StreamingRecognitionResult. + * The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. */ speechRecognitionConfidence?: number; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `payload` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response. */ webhookPayload?: {[key: string]: any}; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `source` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response. */ webhookSource?: string; } @@ -1719,20 +1365,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1RestoreAgentRequest { /** - * The agent to restore. Example for how to restore an agent via the - * command line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:restore\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary "{ 'agentContent': - * '$(cat &lt;agent zip file&gt; | base64 -w 0)' - * }"</pre> + * The agent to restore. Example for how to restore an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:restore\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre> */ agentContent?: string; /** - * The URI to a Google Cloud Storage file containing the agent to restore. - * Note: The URI must start with "gs://". + * The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://". */ agentUri?: string; } @@ -1741,30 +1378,24 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1SearchAgentsResponse { /** - * The list of agents. There will be a maximum number of items returned - * based on the page_size field in the request. + * The list of agents. There will be a maximum number of items returned based on the page_size field in the request. */ agents?: Schema$GoogleCloudDialogflowV2beta1Agent[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } /** - * The sentiment, such as positive/negative feeling or association, for a unit - * of analysis, such as the query text. + * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. */ export interface Schema$GoogleCloudDialogflowV2beta1Sentiment { /** - * A non-negative number in the [0, +inf) range, which represents the - * absolute magnitude of sentiment, regardless of score (positive or - * negative). + * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */ magnitude?: number; /** - * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - * sentiment). + * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ score?: number; } @@ -1773,15 +1404,12 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig { /** - * Optional. Instructs the service to perform sentiment analysis on - * `query_text`. If not provided, sentiment analysis is not performed on - * `query_text`. + * Optional. Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`. */ analyzeQueryTextSentiment?: boolean; } /** - * The result of sentiment analysis as configured by - * `sentiment_analysis_request_config`. + * The result of sentiment analysis as configured by `sentiment_analysis_request_config`. */ export interface Schema$GoogleCloudDialogflowV2beta1SentimentAnalysisResult { /** @@ -1790,33 +1418,19 @@ export namespace dialogflow_v2beta1 { queryTextSentiment?: Schema$GoogleCloudDialogflowV2beta1Sentiment; } /** - * Represents a session entity type. Extends or replaces a developer entity - * type at the user session level (we refer to the entity types defined at the - * agent level as "developer entity types"). Note: session entity - * types apply to all queries, regardless of the language. + * Represents a session entity type. Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as "developer entity types"). Note: session entity types apply to all queries, regardless of the language. */ export interface Schema$GoogleCloudDialogflowV2beta1SessionEntityType { /** - * Required. The collection of entities associated with this session entity - * type. + * Required. The collection of entities associated with this session entity type. */ entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[]; /** - * Required. Indicates whether the additional data should override or - * supplement the developer entity type definition. + * Required. Indicates whether the additional data should override or supplement the developer entity type definition. */ entityOverrideMode?: string; /** - * Required. The unique identifier of this session entity type. Format: - * `projects/<Project ID>/agent/sessions/<Session - * ID>/entityTypes/<Entity Type Display Name>`, or - * `projects/<Project ID>/agent/environments/<Environment - * ID>/users/<User ID>/sessions/<Session - * ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` - * is not specified, we assume default 'draft' environment. If `User - * ID` is not specified, we assume default '-' user. `<Entity - * Type Display Name>` must be the display name of an existing entity - * type in the same agent that will be overridden or supplemented. + * Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. */ name?: string; } @@ -1825,22 +1439,15 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig { /** - * Optional. An identifier which selects 'audio effects' profiles - * that are applied on (post synthesized) text to speech. Effects are - * applied on top of each other in the order they are given. + * Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. */ effectsProfileId?: string[]; /** - * Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase - * 20 semitones from the original pitch. -20 means decrease 20 semitones - * from the original pitch. + * Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number; /** - * Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the - * normal native speed supported by the specific voice. 2.0 is twice as - * fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 - * speed. Any other values < 0.25 or > 4.0 will return an error. + * Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ speakingRate?: number; /** @@ -1848,14 +1455,7 @@ export namespace dialogflow_v2beta1 { */ voice?: Schema$GoogleCloudDialogflowV2beta1VoiceSelectionParams; /** - * Optional. Volume gain (in dB) of the normal native volume supported by - * the specific voice, in the range [-96.0, 16.0]. If unset, or set to a - * value of 0.0 (dB), will play at normal native signal amplitude. A value - * of -6.0 (dB) will play at approximately half the amplitude of the normal - * native signal amplitude. A value of +6.0 (dB) will play at approximately - * twice the amplitude of the normal native signal amplitude. We strongly - * recommend not to exceed +10 (dB) as there's usually no effective - * increase in loudness for any value greater than that. + * Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ volumeGainDb?: number; } @@ -1864,15 +1464,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1TextInput { /** - * Required. The language of this conversational query. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** - * Required. The UTF-8 encoded natural language text to be processed. Text - * length must not exceed 256 characters. + * Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. */ text?: string; } @@ -1885,17 +1481,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1VoiceSelectionParams { /** - * Optional. The name of the voice. If not set, the service will choose a - * voice based on the other parameters such as language_code and gender. + * Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and gender. */ name?: string; /** - * Optional. The preferred gender of the voice. If not set, the service will - * choose a voice based on the other parameters such as language_code and - * name. Note that this is only a preference, not requirement. If a voice of - * the appropriate gender is not available, the synthesizer should - * substitute a voice with a different gender rather than failing the - * request. + * Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ ssmlGender?: string; } @@ -1908,26 +1498,19 @@ export namespace dialogflow_v2beta1 { */ alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; /** - * Optional. The contents of the original request that was passed to - * `[Streaming]DetectIntent` call. + * Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call. */ originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest; /** - * The result of the conversational query or event processing. Contains the - * same value as `[Streaming]DetectIntentResponse.query_result`. + * The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`. */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; /** - * The unique identifier of the response. Contains the same value as - * `[Streaming]DetectIntentResponse.response_id`. + * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. */ responseId?: string; /** - * The unique identifier of detectIntent request session. Can be used to - * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`, or - * `projects/<Project ID>/agent/environments/<Environment - * ID>/users/<User ID>/sessions/<Session ID>`. + * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -1936,43 +1519,27 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse { /** - * Optional. Indicates that this intent ends an interaction. Some - * integrations (e.g., Actions on Google or Dialogflow phone gateway) use - * this information to close interaction with an end user. Default is false. + * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. */ endInteraction?: boolean; /** - * Optional. Makes the platform immediately invoke another `DetectIntent` - * call internally with the specified event as input. + * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. */ followupEventInput?: Schema$GoogleCloudDialogflowV2beta1EventInput; /** - * Optional. The collection of rich messages to present to the user. This - * value is passed directly to `QueryResult.fulfillment_messages`. + * Optional. The collection of rich messages to present to the user. This value is passed directly to `QueryResult.fulfillment_messages`. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed - * directly to `QueryResult.fulfillment_text`. + * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. */ fulfillmentText?: string; /** - * Optional. The collection of output contexts. This value is passed - * directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_payload`. - * See the related `fulfillment_messages[i].payload field`, which may be - * used as an alternative to this field. This field can be used for Actions - * on Google responses. It should have a structure similar to the JSON - * message shown here. For more information, see [Actions on Google Webhook - * Format](https://developers.google.com/actions/dialogflow/webhook) - * <pre>{ "google": { "expectUserResponse": - * true, "richResponse": { "items": [ { - * "simpleResponse": { "textToSpeech": - * "this is a simple response" } } ] } - * } }</pre> + * Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre> */ payload?: {[key: string]: any}; /** @@ -1985,36 +1552,24 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2Context { /** - * Optional. The number of conversational query requests after which the - * context expires. If set to `0` (the default) the context expires - * immediately. Contexts expire automatically after 20 minutes if there are - * no matching queries. + * Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. */ lifespanCount?: number; /** - * Required. The unique identifier of the context. Format: - * `projects/<Project ID>/agent/sessions/<Session - * ID>/contexts/<Context ID>`. The `Context ID` is always - * converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and - * may be at most 250 bytes long. + * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. */ name?: string; /** - * Optional. The collection of parameters associated with this context. - * Refer to [this - * doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) - * for syntax. + * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax. */ parameters?: {[key: string]: any}; } /** - * Represents an entity type. Entity types serve as a tool for extracting - * parameter values from natural language queries. + * Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. */ export interface Schema$GoogleCloudDialogflowV2EntityType { /** - * Optional. Indicates whether the entity type can be automatically - * expanded. + * Optional. Indicates whether the entity type can be automatically expanded. */ autoExpansionMode?: string; /** @@ -2022,8 +1577,7 @@ export namespace dialogflow_v2beta1 { */ displayName?: string; /** - * Optional. The collection of entity entries associated with the entity - * type. + * Optional. The collection of entity entries associated with the entity type. */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** @@ -2031,10 +1585,7 @@ export namespace dialogflow_v2beta1 { */ kind?: string; /** - * The unique identifier of the entity type. Required for - * EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - * methods. Format: `projects/<Project - * ID>/agent/entityTypes/<Entity Type ID>`. + * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. */ name?: string; } @@ -2043,36 +1594,20 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2EntityTypeEntity { /** - * Required. A collection of value synonyms. For example, if the entity type - * is *vegetable*, and `value` is *scallions*, a synonym could be *green - * onions*. For `KIND_LIST` entity types: * This collection must contain - * exactly one synonym equal to `value`. + * Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. */ synonyms?: string[]; /** - * Required. The primary value associated with this entity entry. For - * example, if the entity type is *vegetable*, the value could be - * *scallions*. For `KIND_MAP` entity types: * A canonical value to be - * used in place of synonyms. For `KIND_LIST` entity types: * A string - * that can contain references to other entity types (with or without - * aliases). + * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). */ value?: string; } /** - * Events allow for matching intents by event name instead of the natural - * language input. For instance, input `<event: { name: - * "welcome_event", parameters: { name: "Sam" } }>` can - * trigger a personalized welcome response. The parameter `name` may be used - * by the agent in the response: `"Hello #welcome_event.name! What can I - * do for you today?"`. + * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ export interface Schema$GoogleCloudDialogflowV2EventInput { /** - * Required. The language of this query. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. Note that queries - * in the same session do not necessarily need to specify the same language. + * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ languageCode?: string; /** @@ -2089,38 +1624,24 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2ExportAgentResponse { /** - * The exported agent. Example for how to export an agent to a zip file via - * a command line: <pre>curl \ - * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ - * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * application-default print-access-token) \ -H 'Accept: - * application/json' \ -H 'Content-Type: application/json' \ - * --compressed \ --data-binary '{}' \ | grep agentContent | sed - * -e 's/.*"agentContent": - * "\([^"]*\)".x/\1/' \ | base64 --decode > - * &lt;agent zip file&gt;</pre> + * The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre> */ agentContent?: string; /** - * The URI to a file containing the exported agent. This field is populated - * only if `agent_uri` is specified in `ExportAgentRequest`. + * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`. */ agentUri?: string; } /** - * Represents an intent. Intents convert a number of user expressions or - * patterns into an action. An action is an extraction of a user command or - * sentence semantics. + * Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2Intent { /** - * Optional. The name of the action associated with the intent. Note: The - * action name must not contain whitespaces. + * Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. */ action?: string; /** - * Optional. The list of platforms for which the first response will be - * taken from among the messages assigned to the DEFAULT_PLATFORM. + * Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM. */ defaultResponsePlatforms?: string[]; /** @@ -2128,21 +1649,15 @@ export namespace dialogflow_v2beta1 { */ displayName?: string; /** - * Optional. The collection of event names that trigger the intent. If the - * collection of input contexts is not empty, all of the contexts must be - * present in the active user session for an event to trigger this intent. + * Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. */ events?: string[]; /** - * Read-only. Information about all followup intents that have this intent - * as a direct or indirect parent. We populate this field only in the - * output. + * Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. */ followupIntentInfo?: Schema$GoogleCloudDialogflowV2IntentFollowupIntentInfo[]; /** - * Optional. The list of context names required for this intent to be - * triggered. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ inputContextNames?: string[]; /** @@ -2150,29 +1665,19 @@ export namespace dialogflow_v2beta1 { */ isFallback?: boolean; /** - * Optional. The collection of rich messages corresponding to the `Response` - * field in the Dialogflow console. + * Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. */ messages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * Optional. Indicates whether Machine Learning is disabled for the intent. - * Note: If `ml_diabled` setting is set to true, then this intent is not - * taken into account during inference in `ML ONLY` match mode. Also, - * auto-markup in the UI is turned off. + * Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_diabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. */ mlDisabled?: boolean; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent - * and Intents.BatchUpdateIntents methods. Format: `projects/<Project - * ID>/agent/intents/<Intent ID>`. + * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ name?: string; /** - * Optional. The collection of contexts that are activated when the intent - * is matched. Context messages in this collection should not set the - * parameters field. Setting the `lifespan_count` to 0 will reset the - * context when the intent is matched. Format: `projects/<Project - * ID>/agent/sessions/-/contexts/<Context ID>`. + * Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** @@ -2180,30 +1685,19 @@ export namespace dialogflow_v2beta1 { */ parameters?: Schema$GoogleCloudDialogflowV2IntentParameter[]; /** - * Read-only after creation. The unique identifier of the parent intent in - * the chain of followup intents. You can set this field when creating an - * intent, for example with CreateIntent or BatchUpdateIntents, in order to - * make this intent a followup intent. It identifies the parent followup - * intent. Format: `projects/<Project ID>/agent/intents/<Intent - * ID>`. + * Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; /** - * Optional. The priority of this intent. Higher numbers represent higher - * priorities. If this is zero or unspecified, we use the default priority - * 500000. Negative numbers mean that the intent is disabled. + * Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** - * Optional. Indicates whether to delete all contexts in the current session - * when this intent is matched. + * Optional. Indicates whether to delete all contexts in the current session when this intent is matched. */ resetContexts?: boolean; /** - * Read-only. The unique identifier of the root intent in the chain of - * followup intents. It identifies the correct followup intents chain for - * this intent. We populate this field only in the output. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ rootFollowupIntentName?: string; /** @@ -2220,13 +1714,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2IntentFollowupIntentInfo { /** - * The unique identifier of the followup intent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ followupIntentName?: string; /** - * The unique identifier of the followup intent's parent. Format: - * `projects/<Project ID>/agent/intents/<Intent ID>`. + * The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ parentFollowupIntentName?: string; } @@ -2259,9 +1751,7 @@ export namespace dialogflow_v2beta1 { */ listSelect?: Schema$GoogleCloudDialogflowV2IntentMessageListSelect; /** - * Returns a response containing a custom, platform-specific payload. See - * the Intent.Message.Platform type for a description of the structure that - * may be required for your platform. + * Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. */ payload?: {[key: string]: any}; /** @@ -2401,8 +1891,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2IntentMessageImage { /** - * Optional. A text description of the image to be used for accessibility, - * e.g., screen readers. + * Optional. A text description of the image to be used for accessibility, e.g., screen readers. */ accessibilityText?: string; /** @@ -2411,8 +1900,7 @@ export namespace dialogflow_v2beta1 { imageUri?: string; } /** - * The suggestion chip message that allows the user to jump out to the app or - * website associated with this agent. + * The suggestion chip message that allows the user to jump out to the app or website associated with this agent. */ export interface Schema$GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion { /** @@ -2420,8 +1908,7 @@ export namespace dialogflow_v2beta1 { */ destinationName?: string; /** - * Required. The URI of the app or site to open when the user taps the - * suggestion chip. + * Required. The URI of the app or site to open when the user taps the suggestion chip. */ uri?: string; } @@ -2477,13 +1964,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2IntentMessageSelectItemInfo { /** - * Required. A unique key that will be sent back to the agent if this - * response is given. + * Required. A unique key that will be sent back to the agent if this response is given. */ key?: string; /** - * Optional. A list of synonyms that can also be used to trigger this item - * in dialog. + * Optional. A list of synonyms that can also be used to trigger this item in dialog. */ synonyms?: string[]; } @@ -2496,22 +1981,16 @@ export namespace dialogflow_v2beta1 { */ displayText?: string; /** - * One of text_to_speech or ssml must be provided. Structured spoken - * response to the user in the SSML format. Mutually exclusive with - * text_to_speech. + * One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. */ ssml?: string; /** - * One of text_to_speech or ssml must be provided. The plain text of the - * speech output. Mutually exclusive with ssml. + * One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. */ textToSpeech?: string; } /** - * The collection of simple response candidates. This message in - * `QueryResult.fulfillment_messages` and - * `WebhookResponse.fulfillment_messages` should contain only one - * `SimpleResponse`. + * The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. */ export interface Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponses { /** @@ -2520,8 +1999,7 @@ export namespace dialogflow_v2beta1 { simpleResponses?: Schema$GoogleCloudDialogflowV2IntentMessageSimpleResponse[]; } /** - * The suggestion chip message that the user can tap to quickly post a reply - * to the conversation. + * The suggestion chip message that the user can tap to quickly post a reply to the conversation. */ export interface Schema$GoogleCloudDialogflowV2IntentMessageSuggestion { /** @@ -2552,9 +2030,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2IntentParameter { /** - * Optional. The default value to use when the `value` yields an empty - * result. Default values can be extracted from contexts by using the - * following syntax: `#context_name.parameter_name`. + * Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. */ defaultValue?: string; /** @@ -2562,9 +2038,7 @@ export namespace dialogflow_v2beta1 { */ displayName?: string; /** - * Optional. The name of the entity type, prefixed with `@`, that describes - * values of the parameter. If the parameter is required, this must be - * provided. + * Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided. */ entityTypeDisplayName?: string; /** @@ -2572,8 +2046,7 @@ export namespace dialogflow_v2beta1 { */ isList?: boolean; /** - * Optional. Indicates whether the parameter is required. That is, whether - * the intent cannot be completed without collecting the parameter value. + * Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. */ mandatory?: boolean; /** @@ -2581,15 +2054,11 @@ export namespace dialogflow_v2beta1 { */ name?: string; /** - * Optional. The collection of prompts that the agent can present to the - * user in order to collect value for the parameter. + * Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter. */ prompts?: string[]; /** - * Optional. The definition of the parameter value. It can be: - a constant - * string, - a parameter value defined as `$parameter_name`, - an original - * parameter value defined as `$parameter_name.original`, - a parameter - * value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string; } @@ -2602,24 +2071,11 @@ export namespace dialogflow_v2beta1 { */ name?: string; /** - * Required. The ordered list of training phrase parts. The parts are - * concatenated in order to form the training phrase. Note: The API does - * not automatically annotate training phrases like the Dialogflow Console - * does. Note: Do not forget to include whitespace at part boundaries, so - * the training phrase is well formatted when the parts are concatenated. If - * the training phrase does not need to be annotated with parameters, you - * just need a single part with only the Part.text field set. If you want - * to annotate the training phrase, you must create multiple parts, where - * the fields of each part are populated in one of two ways: - `Part.text` - * is set to a part of the phrase that has no parameters. - `Part.text` is - * set to a part of the phrase that you want to annotate, and the - * `entity_type`, `alias`, and `user_defined` fields are all set. + * Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set. */ parts?: Schema$GoogleCloudDialogflowV2IntentTrainingPhrasePart[]; /** - * Optional. Indicates how many times this example was added to the intent. - * Each time a developer adds an existing sample by editing an intent or - * training, this counter is increased. + * Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. */ timesAddedCount?: number; /** @@ -2632,14 +2088,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2IntentTrainingPhrasePart { /** - * Optional. The parameter name for the value extracted from the annotated - * part of the example. This field is required for annotated parts of the - * training phrase. + * Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. */ alias?: string; /** - * Optional. The entity type name prefixed with `@`. This field is required - * for annotated parts of the training phrase. + * Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase. */ entityType?: string; /** @@ -2647,38 +2100,24 @@ export namespace dialogflow_v2beta1 { */ text?: string; /** - * Optional. Indicates whether the text was manually annotated. This field - * is set to true when the Dialogflow Console is used to manually annotate - * the part. When creating an annotated part with the API, you must set this - * to true. + * Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. */ userDefined?: boolean; } /** - * Represents the contents of the original request that was passed to the - * `[Streaming]DetectIntent` call. + * Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call. */ export interface Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest { /** - * Optional. This field is set to the value of the `QueryParameters.payload` - * field passed in the request. Some integrations that query a Dialogflow - * agent may provide additional information in the payload. In particular - * for the Telephony Gateway this field has the form: <pre>{ - * "telephony": { "caller_id": - * "+18558363987" } }</pre> Note: The caller ID field - * (`caller_id`) will be redacted for Standard Edition agents and populated - * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) - * for Enterprise Edition agents. + * Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. */ payload?: {[key: string]: any}; /** - * The source of this request, e.g., `google`, `facebook`, `slack`. It is - * set by Dialogflow-owned servers. + * The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers. */ source?: string; /** - * Optional. The version of the protocol used for this request. This field - * is AoG-specific. + * Optional. The version of the protocol used for this request. This field is AoG-specific. */ version?: string; } @@ -2691,16 +2130,11 @@ export namespace dialogflow_v2beta1 { */ action?: string; /** - * This field is set to: - `false` if the matched intent has required - * parameters and not all of the required parameter values have been - * collected. - `true` if all required parameter values have been collected, - * or if the matched intent doesn't contain any required parameters. + * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. */ allRequiredParamsPresent?: boolean; /** - * The free-form diagnostic info. For example, this field could contain - * webhook call latency. The string keys of the Struct's fields map can - * change without notice. + * The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. */ diagnosticInfo?: {[key: string]: any}; /** @@ -2708,34 +2142,23 @@ export namespace dialogflow_v2beta1 { */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * The text to be pronounced to the user or shown on the screen. Note: This - * is a legacy field, `fulfillment_messages` should be preferred. + * The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. */ fulfillmentText?: string; /** - * The intent that matched the conversational query. Some, not all fields - * are filled in this message, including but not limited to: `name`, - * `display_name` and `webhook_state`. + * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`. */ intent?: Schema$GoogleCloudDialogflowV2Intent; /** - * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). If there are `multiple - * knowledge_answers` messages, this value is set to the greatest - * `knowledgeAnswers.match_confidence` value in the list. + * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** - * The language that was triggered during intent detection. See [Language - * Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * for a list of the currently supported language codes. + * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. */ languageCode?: string; /** - * The collection of output contexts. If applicable, - * `output_contexts.parameters` contains entries with name `<parameter - * name>.original` containing the original parameter values before the - * query. + * The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** @@ -2743,60 +2166,41 @@ export namespace dialogflow_v2beta1 { */ parameters?: {[key: string]: any}; /** - * The original conversational query text: - If natural language text was - * provided as input, `query_text` contains a copy of the input. - If - * natural language speech audio was provided as input, `query_text` - * contains the speech recognition result. If speech recognizer produced - * multiple alternatives, a particular one is picked. - If an event was - * provided as input, `query_text` is not set. + * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set. */ queryText?: string; /** - * The sentiment analysis result, which depends on the - * `sentiment_analysis_request_config` specified in the request. + * The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. */ sentimentAnalysisResult?: Schema$GoogleCloudDialogflowV2SentimentAnalysisResult; /** - * The Speech recognition confidence between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. The default of 0.0 is a sentinel value indicating that - * confidence was not set. This field is not guaranteed to be accurate or - * set. In particular this field isn't set for StreamingDetectIntent - * since the streaming endpoint has separate confidence estimates per - * portion of the audio in StreamingRecognitionResult. + * The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. */ speechRecognitionConfidence?: number; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `payload` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response. */ webhookPayload?: {[key: string]: any}; /** - * If the query was fulfilled by a webhook call, this field is set to the - * value of the `source` field returned in the webhook response. + * If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response. */ webhookSource?: string; } /** - * The sentiment, such as positive/negative feeling or association, for a unit - * of analysis, such as the query text. + * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. */ export interface Schema$GoogleCloudDialogflowV2Sentiment { /** - * A non-negative number in the [0, +inf) range, which represents the - * absolute magnitude of sentiment, regardless of score (positive or - * negative). + * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */ magnitude?: number; /** - * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - * sentiment). + * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ score?: number; } /** - * The result of sentiment analysis as configured by - * `sentiment_analysis_request_config`. + * The result of sentiment analysis as configured by `sentiment_analysis_request_config`. */ export interface Schema$GoogleCloudDialogflowV2SentimentAnalysisResult { /** @@ -2809,26 +2213,19 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2WebhookRequest { /** - * Optional. The contents of the original request that was passed to - * `[Streaming]DetectIntent` call. + * Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call. */ originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest; /** - * The result of the conversational query or event processing. Contains the - * same value as `[Streaming]DetectIntentResponse.query_result`. + * The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`. */ queryResult?: Schema$GoogleCloudDialogflowV2QueryResult; /** - * The unique identifier of the response. Contains the same value as - * `[Streaming]DetectIntentResponse.response_id`. + * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. */ responseId?: string; /** - * The unique identifier of detectIntent request session. Can be used to - * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`, or - * `projects/<Project ID>/agent/environments/<Environment - * ID>/users/<User ID>/sessions/<Session ID>`. + * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -2837,37 +2234,23 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2WebhookResponse { /** - * Optional. Makes the platform immediately invoke another `DetectIntent` - * call internally with the specified event as input. + * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. */ followupEventInput?: Schema$GoogleCloudDialogflowV2EventInput; /** - * Optional. The collection of rich messages to present to the user. This - * value is passed directly to `QueryResult.fulfillment_messages`. + * Optional. The collection of rich messages to present to the user. This value is passed directly to `QueryResult.fulfillment_messages`. */ fulfillmentMessages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * Optional. The text to be shown on the screen. This value is passed - * directly to `QueryResult.fulfillment_text`. + * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. */ fulfillmentText?: string; /** - * Optional. The collection of output contexts. This value is passed - * directly to `QueryResult.output_contexts`. + * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * Optional. This value is passed directly to `QueryResult.webhook_payload`. - * See the related `fulfillment_messages[i].payload field`, which may be - * used as an alternative to this field. This field can be used for Actions - * on Google responses. It should have a structure similar to the JSON - * message shown here. For more information, see [Actions on Google Webhook - * Format](https://developers.google.com/actions/dialogflow/webhook) - * <pre>{ "google": { "expectUserResponse": - * true, "richResponse": { "items": [ { - * "simpleResponse": { "textToSpeech": - * "this is a simple response" } } ] } - * } }</pre> + * Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre> */ payload?: {[key: string]: any}; /** @@ -2876,14 +2259,11 @@ export namespace dialogflow_v2beta1 { source?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2891,72 +2271,24 @@ export namespace dialogflow_v2beta1 { */ error?: Schema$GoogleRpcStatus; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobufEmpty {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpcStatus { /** @@ -2964,23 +2296,16 @@ export namespace dialogflow_v2beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$GoogleTypeLatLng { /** @@ -3097,8 +2422,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to fetch is associated with. Format: - * `projects/`. + * Required. The project that the agent to fetch is associated with. Format: `projects/`. */ parent?: string; } @@ -3125,8 +2449,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.export - * @desc Exports the specified agent to a ZIP file. Operation + * @desc Exports the specified agent to a ZIP file. Operation * @alias dialogflow.projects.agent.export * @memberOf! () * @@ -3208,10 +2531,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.import - * @desc Imports the specified agent from a ZIP file. Uploads new intents and - * entity types without deleting the existing ones. Intents and entity types - * with the same name are replaced with the new versions from - * ImportAgentRequest. Operation + * @desc Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation * @alias dialogflow.projects.agent.import * @memberOf! () * @@ -3375,11 +2695,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.search - * @desc Returns the list of agents. Since there is at most one - * conversational agent per project, this method is useful primarily for - * listing all agents across projects the caller has access to. One can - * achieve that with a wildcard project collection id "-". Refer to [List - * Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). + * @desc Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). * @alias dialogflow.projects.agent.search * @memberOf! () * @@ -3479,8 +2795,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.train - * @desc Trains the specified agent. Operation + * @desc Trains the specified agent. Operation * @alias dialogflow.projects.agent.train * @memberOf! () * @@ -3569,8 +2884,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to export is associated with. - * Format: `projects/`. + * Required. The project that the agent to export is associated with. Format: `projects/`. */ parent?: string; @@ -3587,8 +2901,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to import is associated with. - * Format: `projects/`. + * Required. The project that the agent to import is associated with. Format: `projects/`. */ parent?: string; @@ -3605,8 +2918,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to restore is associated with. - * Format: `projects/`. + * Required. The project that the agent to restore is associated with. Format: `projects/`. */ parent?: string; @@ -3623,18 +2935,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The project to list agents from. Format: `projects/`. + * Required. The project to list agents from. Format: `projects/`. */ parent?: string; } @@ -3646,8 +2955,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project that the agent to train is associated with. Format: - * `projects/`. + * Required. The project that the agent to train is associated with. Format: `projects/`. */ parent?: string; @@ -3669,8 +2977,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.entityTypes.batchDelete - * @desc Deletes entity types in the specified agent. Operation + * @desc Deletes entity types in the specified agent. Operation * @alias dialogflow.projects.agent.entityTypes.batchDelete * @memberOf! () * @@ -3751,8 +3058,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.entityTypes.batchUpdate - * @desc Updates/Creates multiple entity types in the specified agent. - * Operation + * @desc Updates/Creates multiple entity types in the specified agent. Operation * @alias dialogflow.projects.agent.entityTypes.batchUpdate * @memberOf! () * @@ -4287,8 +3593,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to delete all entities types for. Format: - * `projects//agent`. + * Required. The name of the agent to delete all entities types for. Format: `projects//agent`. */ parent?: string; @@ -4305,8 +3610,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to update or create entity types in. - * Format: `projects//agent`. + * Required. The name of the agent to update or create entity types in. Format: `projects//agent`. */ parent?: string; @@ -4323,16 +3627,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language of entity synonyms defined in `entity_type`. If - * not specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The agent to create a entity type for. Format: - * `projects//agent`. + * Required. The agent to create a entity type for. Format: `projects//agent`. */ parent?: string; @@ -4349,8 +3648,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to delete. Format: - * `projects//agent/entityTypes/`. + * Required. The name of the entity type to delete. Format: `projects//agent/entityTypes/`. */ name?: string; } @@ -4362,16 +3660,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language to retrieve entity synonyms for. If not specified, - * the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The name of the entity type. Format: `projects//agent/entityTypes/`. + * Required. The name of the entity type. Format: `projects//agent/entityTypes/`. */ name?: string; } @@ -4383,26 +3676,19 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language to list entity synonyms for. If not specified, the - * agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The agent to list all entity types from. Format: - * `projects//agent`. + * Required. The agent to list all entity types from. Format: `projects//agent`. */ parent?: string; } @@ -4414,18 +3700,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language of entity synonyms defined in `entity_type`. If - * not specified, the agent's default language is used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * The unique identifier of the entity type. Required for - * EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - * methods. Format: `projects//agent/entityTypes/`. + * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`. */ name?: string; /** @@ -4447,8 +3726,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.entityTypes.entities.batchCreate - * @desc Creates multiple new entities in the specified entity type. - * Operation + * @desc Creates multiple new entities in the specified entity type. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchCreate * @memberOf! () * @@ -4530,8 +3808,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.entityTypes.entities.batchDelete - * @desc Deletes entities in the specified entity type. Operation - * + * @desc Deletes entities in the specified entity type. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchDelete * @memberOf! () * @@ -4613,10 +3890,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.entityTypes.entities.batchUpdate - * @desc Updates or creates multiple entities in the specified entity type. - * This method does not affect entities in the entity type that aren't - * explicitly specified in the request. Operation + * @desc Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchUpdate * @memberOf! () * @@ -4705,8 +3979,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to create entities in. Format: - * `projects//agent/entityTypes/`. + * Required. The name of the entity type to create entities in. Format: `projects//agent/entityTypes/`. */ parent?: string; @@ -4723,8 +3996,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to delete entries for. Format: - * `projects//agent/entityTypes/`. + * Required. The name of the entity type to delete entries for. Format: `projects//agent/entityTypes/`. */ parent?: string; @@ -4741,8 +4013,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to update or create entities in. - * Format: `projects//agent/entityTypes/`. + * Required. The name of the entity type to update or create entities in. Format: `projects//agent/entityTypes/`. */ parent?: string; @@ -4789,8 +4060,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.deleteContexts * @desc Deletes all active contexts in the specified session. - * @alias - * dialogflow.projects.agent.environments.users.sessions.deleteContexts + * @alias dialogflow.projects.agent.environments.users.sessions.deleteContexts * @memberOf! () * * @param {object} params Parameters for request @@ -4865,10 +4135,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.detectIntent - * @desc Processes a natural language query and returns structured, - * actionable data as a result. This method is not idempotent, because it - * may cause contexts and session entity types to be updated, which in turn - * might affect results of future queries. + * @desc Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. * @alias dialogflow.projects.agent.environments.users.sessions.detectIntent * @memberOf! () * @@ -4974,11 +4241,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session to delete all contexts from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. + * Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -4990,15 +4253,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session this query is sent to. Format: - * `projects//agent/sessions/`, or - * `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we - * assume default 'draft' environment. If `User ID` is not specified, we are - * using "-". It’s up to the API caller to choose an appropriate `Session - * ID` and `User Id`. They can be a random numbers or some type of user and - * session identifiers (preferably hashed). The length of the `Session ID` - * and `User ID` must not exceed 36 characters. + * Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. */ session?: string; @@ -5016,10 +4271,8 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.contexts.create - * @desc Creates a context. If the specified context already exists, - * overrides the context. - * @alias - * dialogflow.projects.agent.environments.users.sessions.contexts.create + * @desc Creates a context. If the specified context already exists, overrides the context. + * @alias dialogflow.projects.agent.environments.users.sessions.contexts.create * @memberOf! () * * @param {object} params Parameters for request @@ -5105,8 +4358,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.contexts.delete * @desc Deletes the specified context. - * @alias - * dialogflow.projects.agent.environments.users.sessions.contexts.delete + * @alias dialogflow.projects.agent.environments.users.sessions.contexts.delete * @memberOf! () * * @param {object} params Parameters for request @@ -5259,8 +4511,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.contexts.list * @desc Returns the list of all contexts in the specified session. - * @alias - * dialogflow.projects.agent.environments.users.sessions.contexts.list + * @alias dialogflow.projects.agent.environments.users.sessions.contexts.list * @memberOf! () * * @param {object} params Parameters for request @@ -5360,8 +4611,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.contexts.patch * @desc Updates the specified context. - * @alias - * dialogflow.projects.agent.environments.users.sessions.contexts.patch + * @alias dialogflow.projects.agent.environments.users.sessions.contexts.patch * @memberOf! () * * @param {object} params Parameters for request @@ -5451,11 +4701,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. + * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; @@ -5472,12 +4718,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or - * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - * not specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -5489,12 +4730,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or - * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - * not specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -5506,21 +4742,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The session to list all contexts from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. + * Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -5532,14 +4762,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The unique identifier of the context. Format: - * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The - * `Context ID` is always converted to lowercase, may only contain - * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If - * `Environment ID` is not specified, we assume default 'draft' environment. - * If `User ID` is not specified, we assume default '-' user. + * Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; /** @@ -5561,10 +4784,8 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.entityTypes.create - * @desc Creates a session entity type. If the specified session entity - * type already exists, overrides the session entity type. - * @alias - * dialogflow.projects.agent.environments.users.sessions.entityTypes.create + * @desc Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. + * @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.create * @memberOf! () * * @param {object} params Parameters for request @@ -5664,8 +4885,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.entityTypes.delete * @desc Deletes the specified session entity type. - * @alias - * dialogflow.projects.agent.environments.users.sessions.entityTypes.delete + * @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.delete * @memberOf! () * * @param {object} params Parameters for request @@ -5736,8 +4956,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.entityTypes.get * @desc Retrieves the specified session entity type. - * @alias - * dialogflow.projects.agent.environments.users.sessions.entityTypes.get + * @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.get * @memberOf! () * * @param {object} params Parameters for request @@ -5832,10 +5051,8 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.entityTypes.list - * @desc Returns the list of all session entity types in the specified - * session. - * @alias - * dialogflow.projects.agent.environments.users.sessions.entityTypes.list + * @desc Returns the list of all session entity types in the specified session. + * @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.list * @memberOf! () * * @param {object} params Parameters for request @@ -5937,8 +5154,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.environments.users.sessions.entityTypes.patch * @desc Updates the specified session entity type. - * @alias - * dialogflow.projects.agent.environments.users.sessions.entityTypes.patch + * @alias dialogflow.projects.agent.environments.users.sessions.entityTypes.patch * @memberOf! () * * @param {object} params Parameters for request @@ -6042,12 +5258,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The session to create a session entity type for. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. If `Environment ID` is not specified, we assume - * default 'draft' environment. If `User ID` is not specified, we assume - * default '-' user. + * Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; @@ -6064,13 +5275,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to delete. Format: - * `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -6082,12 +5287,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` - * or `projects//agent/environments//users//sessions//entityTypes/`. If - * `Environment ID` is not specified, we assume default 'draft' environment. - * If `User ID` is not specified, we assume default '-' user. + * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -6099,22 +5299,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The session to list all session entity types from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. If `Environment ID` is not specified, we assume - * default 'draft' environment. If `User ID` is not specified, we assume - * default '-' user. + * Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -6126,15 +5319,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The unique identifier of this session entity type. Format: - * `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. `` must - * be the display name of an existing entity type in the same agent that - * will be overridden or supplemented. + * Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. */ name?: string; /** @@ -6156,8 +5341,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.intents.batchDelete - * @desc Deletes intents in the specified agent. Operation + * @desc Deletes intents in the specified agent. Operation * @alias dialogflow.projects.agent.intents.batchDelete * @memberOf! () * @@ -6239,8 +5423,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.intents.batchUpdate - * @desc Updates/Creates multiple intents in the specified agent. Operation - * + * @desc Updates/Creates multiple intents in the specified agent. Operation * @alias dialogflow.projects.agent.intents.batchUpdate * @memberOf! () * @@ -6408,8 +5591,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.intents.delete - * @desc Deletes the specified intent and its direct or indirect followup - * intents. + * @desc Deletes the specified intent and its direct or indirect followup intents. * @alias dialogflow.projects.agent.intents.delete * @memberOf! () * @@ -6755,8 +5937,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to delete all entities types for. Format: - * `projects//agent`. + * Required. The name of the agent to delete all entities types for. Format: `projects//agent`. */ parent?: string; @@ -6773,8 +5954,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the agent to update or create intents in. Format: - * `projects//agent`. + * Required. The name of the agent to update or create intents in. Format: `projects//agent`. */ parent?: string; @@ -6795,17 +5975,11 @@ export namespace dialogflow_v2beta1 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages - * defined in `intent`. If not specified, the agent's default language is - * used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The agent to create a intent for. Format: `projects//agent`. + * Required. The agent to create a intent for. Format: `projects//agent`. */ parent?: string; @@ -6822,9 +5996,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the intent to delete. If this intent has direct or - * indirect followup intents, we also delete them. Format: - * `projects//agent/intents/`. + * Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: `projects//agent/intents/`. */ name?: string; } @@ -6840,17 +6012,11 @@ export namespace dialogflow_v2beta1 { */ intentView?: string; /** - * Optional. The language to retrieve training phrases, parameters and rich - * messages for. If not specified, the agent's default language is used. - * [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Required. The name of the intent. Format: `projects//agent/intents/`. + * Required. The name of the intent. Format: `projects//agent/intents/`. */ name?: string; } @@ -6866,27 +6032,19 @@ export namespace dialogflow_v2beta1 { */ intentView?: string; /** - * Optional. The language to list training phrases, parameters and rich - * messages for. If not specified, the agent's default language is used. - * [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The agent to list all intents from. Format: `projects//agent`. + * Required. The agent to list all intents from. Format: `projects//agent`. */ parent?: string; } @@ -6902,18 +6060,11 @@ export namespace dialogflow_v2beta1 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages - * defined in `intent`. If not specified, the agent's default language is - * used. [Many - * languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) - * are supported. Note: languages must be enabled in the agent before they - * can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** - * The unique identifier of this intent. Required for Intents.UpdateIntent - * and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. + * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. */ name?: string; /** @@ -7408,8 +6559,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project to create a knowledge base for. Format: - * `projects/`. + * Required. The project to create a knowledge base for. Format: `projects/`. */ parent?: string; @@ -7426,13 +6576,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Force deletes the knowledge base. When set to true, any - * documents in the knowledge base are also deleted. + * Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted. */ force?: boolean; /** - * Required. The name of the knowledge base to delete. Format: - * `projects//knowledgeBases/`. + * Required. The name of the knowledge base to delete. Format: `projects//knowledgeBases/`. */ name?: string; } @@ -7444,8 +6592,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the knowledge base to retrieve. Format - * `projects//knowledgeBases/`. + * Required. The name of the knowledge base to retrieve. Format `projects//knowledgeBases/`. */ name?: string; } @@ -7457,18 +6604,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 10 and at most 100. + * Optional. The maximum number of items to return in a single page. By default 10 and at most 100. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The project to list of knowledge bases for. Format: - * `projects/`. + * Required. The project to list of knowledge bases for. Format: `projects/`. */ parent?: string; } @@ -7480,15 +6624,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The knowledge base resource name. The name must be empty when creating a - * knowledge base. Format: `projects//knowledgeBases/`. + * The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//knowledgeBases/`. */ name?: string; /** - * Optional. Not specified means `update all`. Currently, only - * `display_name` can be updated, an InvalidArgument will be returned for - * attempting to update other fields. + * Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. */ updateMask?: string; @@ -7506,8 +6646,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.knowledgeBases.documents.create - * @desc Creates a new document. Operation + * @desc Creates a new document. Operation * @alias dialogflow.projects.agent.knowledgeBases.documents.create * @memberOf! () * @@ -7589,8 +6728,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.knowledgeBases.documents.delete - * @desc Deletes the specified document. Operation + * @desc Deletes the specified document. Operation * @alias dialogflow.projects.agent.knowledgeBases.documents.delete * @memberOf! () * @@ -7856,8 +6994,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.knowledgeBases.documents.patch - * @desc Updates the specified document. Operation + * @desc Updates the specified document. Operation * @alias dialogflow.projects.agent.knowledgeBases.documents.patch * @memberOf! () * @@ -7937,12 +7074,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.knowledgeBases.documents.reload - * @desc Reloads the specified document from its specified source, - * content_uri or content. The previously loaded content of the document - * will be deleted. Note: Even when the content of the document has not - * changed, there still may be side effects because of internal - * implementation changes. Operation + * @desc Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Operation * @alias dialogflow.projects.agent.knowledgeBases.documents.reload * @memberOf! () * @@ -8031,8 +7163,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The knoweldge base to create a document for. Format: - * `projects//knowledgeBases/`. + * Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. */ parent?: string; @@ -8049,8 +7180,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. + * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. */ name?: string; } @@ -8062,8 +7192,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. + * Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. */ name?: string; } @@ -8075,18 +7204,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 10 and at most 100. + * Optional. The maximum number of items to return in a single page. By default 10 and at most 100. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The knowledge base to list all documents for. Format: - * `projects//knowledgeBases/`. + * Required. The knowledge base to list all documents for. Format: `projects//knowledgeBases/`. */ parent?: string; } @@ -8098,15 +7224,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The document resource name. The name must be empty when creating a - * document. Format: `projects//knowledgeBases//documents/`. + * The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. */ name?: string; /** - * Optional. Not specified means `update all`. Currently, only - * `display_name` can be updated, an InvalidArgument will be returned for - * attempting to update other fields. + * Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. */ updateMask?: string; @@ -8123,8 +7245,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * The name of the document to reload. Format: `projects//knowledgeBases//documents/` */ name?: string; @@ -8226,10 +7347,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.sessions.detectIntent - * @desc Processes a natural language query and returns structured, - * actionable data as a result. This method is not idempotent, because it - * may cause contexts and session entity types to be updated, which in turn - * might affect results of future queries. + * @desc Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. * @alias dialogflow.projects.agent.sessions.detectIntent * @memberOf! () * @@ -8335,11 +7453,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session to delete all contexts from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. + * Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -8351,15 +7465,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session this query is sent to. Format: - * `projects//agent/sessions/`, or - * `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we - * assume default 'draft' environment. If `User ID` is not specified, we are - * using "-". It’s up to the API caller to choose an appropriate `Session - * ID` and `User Id`. They can be a random numbers or some type of user and - * session identifiers (preferably hashed). The length of the `Session ID` - * and `User ID` must not exceed 36 characters. + * Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. */ session?: string; @@ -8377,8 +7483,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.sessions.contexts.create - * @desc Creates a context. If the specified context already exists, - * overrides the context. + * @desc Creates a context. If the specified context already exists, overrides the context. * @alias dialogflow.projects.agent.sessions.contexts.create * @memberOf! () * @@ -8808,11 +7913,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. + * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; @@ -8829,12 +7930,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or - * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - * not specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -8846,12 +7942,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or - * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - * not specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -8863,21 +7954,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The session to list all contexts from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. + * Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -8889,14 +7974,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The unique identifier of the context. Format: - * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The - * `Context ID` is always converted to lowercase, may only contain - * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If - * `Environment ID` is not specified, we assume default 'draft' environment. - * If `User ID` is not specified, we assume default '-' user. + * Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; /** @@ -8918,8 +7996,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.sessions.entityTypes.create - * @desc Creates a session entity type. If the specified session entity - * type already exists, overrides the session entity type. + * @desc Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. * @alias dialogflow.projects.agent.sessions.entityTypes.create * @memberOf! () * @@ -9186,8 +8263,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.agent.sessions.entityTypes.list - * @desc Returns the list of all session entity types in the specified - * session. + * @desc Returns the list of all session entity types in the specified session. * @alias dialogflow.projects.agent.sessions.entityTypes.list * @memberOf! () * @@ -9394,12 +8470,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The session to create a session entity type for. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. If `Environment ID` is not specified, we assume - * default 'draft' environment. If `User ID` is not specified, we assume - * default '-' user. + * Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; @@ -9416,13 +8487,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entity type to delete. Format: - * `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -9434,12 +8499,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` - * or `projects//agent/environments//users//sessions//entityTypes/`. If - * `Environment ID` is not specified, we assume default 'draft' environment. - * If `User ID` is not specified, we assume default '-' user. + * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -9451,22 +8511,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The session to list all session entity types from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. If `Environment ID` is not specified, we assume - * default 'draft' environment. If `User ID` is not specified, we assume - * default '-' user. + * Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -9478,15 +8531,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The unique identifier of this session entity type. Format: - * `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. `` must - * be the display name of an existing entity type in the same agent that - * will be overridden or supplemented. + * Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. */ name?: string; /** @@ -9981,8 +9026,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project to create a knowledge base for. Format: - * `projects/`. + * Required. The project to create a knowledge base for. Format: `projects/`. */ parent?: string; @@ -9999,13 +9043,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Force deletes the knowledge base. When set to true, any - * documents in the knowledge base are also deleted. + * Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted. */ force?: boolean; /** - * Required. The name of the knowledge base to delete. Format: - * `projects//knowledgeBases/`. + * Required. The name of the knowledge base to delete. Format: `projects//knowledgeBases/`. */ name?: string; } @@ -10017,8 +9059,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the knowledge base to retrieve. Format - * `projects//knowledgeBases/`. + * Required. The name of the knowledge base to retrieve. Format `projects//knowledgeBases/`. */ name?: string; } @@ -10030,18 +9071,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 10 and at most 100. + * Optional. The maximum number of items to return in a single page. By default 10 and at most 100. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The project to list of knowledge bases for. Format: - * `projects/`. + * Required. The project to list of knowledge bases for. Format: `projects/`. */ parent?: string; } @@ -10053,15 +9091,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The knowledge base resource name. The name must be empty when creating a - * knowledge base. Format: `projects//knowledgeBases/`. + * The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//knowledgeBases/`. */ name?: string; /** - * Optional. Not specified means `update all`. Currently, only - * `display_name` can be updated, an InvalidArgument will be returned for - * attempting to update other fields. + * Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. */ updateMask?: string; @@ -10079,8 +9113,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.knowledgeBases.documents.create - * @desc Creates a new document. Operation + * @desc Creates a new document. Operation * @alias dialogflow.projects.knowledgeBases.documents.create * @memberOf! () * @@ -10162,8 +9195,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.knowledgeBases.documents.delete - * @desc Deletes the specified document. Operation + * @desc Deletes the specified document. Operation * @alias dialogflow.projects.knowledgeBases.documents.delete * @memberOf! () * @@ -10429,8 +9461,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.knowledgeBases.documents.patch - * @desc Updates the specified document. Operation + * @desc Updates the specified document. Operation * @alias dialogflow.projects.knowledgeBases.documents.patch * @memberOf! () * @@ -10510,12 +9541,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.knowledgeBases.documents.reload - * @desc Reloads the specified document from its specified source, - * content_uri or content. The previously loaded content of the document - * will be deleted. Note: Even when the content of the document has not - * changed, there still may be side effects because of internal - * implementation changes. Operation + * @desc Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Operation * @alias dialogflow.projects.knowledgeBases.documents.reload * @memberOf! () * @@ -10604,8 +9630,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The knoweldge base to create a document for. Format: - * `projects//knowledgeBases/`. + * Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. */ parent?: string; @@ -10622,8 +9647,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. + * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. */ name?: string; } @@ -10635,8 +9659,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. + * Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. */ name?: string; } @@ -10648,18 +9671,15 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. By - * default 10 and at most 100. + * Optional. The maximum number of items to return in a single page. By default 10 and at most 100. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list - * request. + * Optional. The next_page_token value returned from a previous list request. */ pageToken?: string; /** - * Required. The knowledge base to list all documents for. Format: - * `projects//knowledgeBases/`. + * Required. The knowledge base to list all documents for. Format: `projects//knowledgeBases/`. */ parent?: string; } @@ -10671,15 +9691,11 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The document resource name. The name must be empty when creating a - * document. Format: `projects//knowledgeBases//documents/`. + * The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. */ name?: string; /** - * Optional. Not specified means `update all`. Currently, only - * `display_name` can be updated, an InvalidArgument will be returned for - * attempting to update other fields. + * Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. */ updateMask?: string; @@ -10696,8 +9712,7 @@ export namespace dialogflow_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * The name of the document to reload. Format: `projects//knowledgeBases//documents/` */ name?: string; @@ -10715,9 +9730,7 @@ export namespace dialogflow_v2beta1 { /** * dialogflow.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias dialogflow.projects.operations.get * @memberOf! () * diff --git a/src/apis/digitalassetlinks/package.json b/src/apis/digitalassetlinks/package.json index 0be7bdbb5f2..946d8ab707d 100644 --- a/src/apis/digitalassetlinks/package.json +++ b/src/apis/digitalassetlinks/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/digitalassetlinks/v1.ts b/src/apis/digitalassetlinks/v1.ts index 0b8545ed617..d22810ca620 100644 --- a/src/apis/digitalassetlinks/v1.ts +++ b/src/apis/digitalassetlinks/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace digitalassetlinks_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace digitalassetlinks_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace digitalassetlinks_v1 { /** * Digital Asset Links API * - * Discovers relationships between online assets such as websites or mobile - * apps. + * Discovers relationships between online assets such as websites or mobile apps. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace digitalassetlinks_v1 { statements: Resource$Statements; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.assetlinks = new Resource$Assetlinks(this.context); this.statements = new Resource$Statements(this.context); @@ -126,31 +124,16 @@ export namespace digitalassetlinks_v1 { */ export interface Schema$AndroidAppAsset { /** - * Because there is no global enforcement of package name uniqueness, we - * also require a signing certificate, which in combination with the package - * name uniquely identifies an app. Some apps' signing keys are - * rotated, so they may be signed by different keys over time. We treat - * these as distinct assets, since we use (package name, cert) as the unique - * ID. This should not normally pose any problems as both versions of the - * app will make the same or similar statements. Other assets making - * statements about the app will have to be updated when a key is rotated, - * however. (Note that the syntaxes for publishing and querying for - * statements contain syntactic sugar to easily let you specify apps that - * are known by multiple certificates.) REQUIRED + * Because there is no global enforcement of package name uniqueness, we also require a signing certificate, which in combination with the package name uniquely identifies an app. Some apps' signing keys are rotated, so they may be signed by different keys over time. We treat these as distinct assets, since we use (package name, cert) as the unique ID. This should not normally pose any problems as both versions of the app will make the same or similar statements. Other assets making statements about the app will have to be updated when a key is rotated, however. (Note that the syntaxes for publishing and querying for statements contain syntactic sugar to easily let you specify apps that are known by multiple certificates.) REQUIRED */ certificate?: Schema$CertificateInfo; /** - * Android App assets are naturally identified by their Java package name. - * For example, the Google Maps app uses the package name - * `com.google.android.apps.maps`. REQUIRED + * Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED */ packageName?: string; } /** - * Uniquely identifies an asset. A digital asset is an identifiable and - * addressable online entity that typically provides some service or content. - * Examples of assets are websites, Android apps, Twitter feeds, and Plus - * Pages. + * Uniquely identifies an asset. A digital asset is an identifiable and addressable online entity that typically provides some service or content. Examples of assets are websites, Android apps, Twitter feeds, and Plus Pages. */ export interface Schema$Asset { /** @@ -167,20 +150,7 @@ export namespace digitalassetlinks_v1 { */ export interface Schema$CertificateInfo { /** - * The uppercase SHA-265 fingerprint of the certificate. From the PEM - * certificate, it can be acquired like this: $ keytool -printcert - * -file $CERTFILE | grep SHA256: SHA256: - * 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - * 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 - * -in $CERTFILE -noout -fingerprint -sha256 SHA256 - * Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - * 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the - * contents of this field would be `14:6D:E9:83:C5:73: - * 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - * 44:E5`. If these tools are not available to you, you can convert the PEM - * certificate into the DER format, compute the SHA-256 hash of that string - * and represent the result as a hexstring (that is, uppercase hexadecimal - * representations of each octet, separated by colons). + * The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). */ sha256Fingerprint?: string; } @@ -189,13 +159,7 @@ export namespace digitalassetlinks_v1 { */ export interface Schema$CheckResponse { /** - * Human-readable message containing information intended to help end users - * understand, reproduce and debug the result. The message will be in - * English and we are currently not planning to offer any translations. - * Please note that no guarantees are made about the contents or format of - * this string. Any aspect of it may be subject to change without notice. - * You should not attempt to programmatically parse this data. For - * programmatic access, use the error_code field below. + * Human-readable message containing information intended to help end users understand, reproduce and debug the result. The message will be in English and we are currently not planning to offer any translations. Please note that no guarantees are made about the contents or format of this string. Any aspect of it may be subject to change without notice. You should not attempt to programmatically parse this data. For programmatic access, use the error_code field below. */ debugString?: string; /** @@ -203,13 +167,11 @@ export namespace digitalassetlinks_v1 { */ errorCode?: string[]; /** - * Set to true if the assets specified in the request are linked by the - * relation specified in the request. + * Set to true if the assets specified in the request are linked by the relation specified in the request. */ linked?: boolean; /** - * From serving time, how much longer the response should be considered - * valid barring further updates. REQUIRED + * From serving time, how much longer the response should be considered valid barring further updates. REQUIRED */ maxAge?: string; } @@ -218,13 +180,7 @@ export namespace digitalassetlinks_v1 { */ export interface Schema$ListResponse { /** - * Human-readable message containing information intended to help end users - * understand, reproduce and debug the result. The message will be in - * English and we are currently not planning to offer any translations. - * Please note that no guarantees are made about the contents or format of - * this string. Any aspect of it may be subject to change without notice. - * You should not attempt to programmatically parse this data. For - * programmatic access, use the error_code field below. + * Human-readable message containing information intended to help end users understand, reproduce and debug the result. The message will be in English and we are currently not planning to offer any translations. Please note that no guarantees are made about the contents or format of this string. Any aspect of it may be subject to change without notice. You should not attempt to programmatically parse this data. For programmatic access, use the error_code field below. */ debugString?: string; /** @@ -232,8 +188,7 @@ export namespace digitalassetlinks_v1 { */ errorCode?: string[]; /** - * From serving time, how much longer the response should be considered - * valid barring further updates. REQUIRED + * From serving time, how much longer the response should be considered valid barring further updates. REQUIRED */ maxAge?: string; /** @@ -242,25 +197,11 @@ export namespace digitalassetlinks_v1 { statements?: Schema$Statement[]; } /** - * Describes a reliable statement that has been made about the relationship - * between a source asset and a target asset. Statements are always made by - * the source asset, either directly or by delegating to a statement list that - * is stored elsewhere. For more detailed definitions of statements and - * assets, please refer to our [API documentation landing - * page](/digital-asset-links/v1/getting-started). + * Describes a reliable statement that has been made about the relationship between a source asset and a target asset. Statements are always made by the source asset, either directly or by delegating to a statement list that is stored elsewhere. For more detailed definitions of statements and assets, please refer to our [API documentation landing page](/digital-asset-links/v1/getting-started). */ export interface Schema$Statement { /** - * The relation identifies the use of the statement as intended by the - * source asset's owner (that is, the person or entity who issued the - * statement). Every complete statement has a relation. We identify - * relations with strings of the format `<kind>/<detail>`, where - * `<kind>` must be one of a set of pre-defined purpose categories, - * and `<detail>` is a free-form lowercase alphanumeric string that - * describes the specific use case of the statement. Refer to [our API - * documentation](/digital-asset-links/v1/relation-strings) for the current - * list of supported relations. Example: - * `delegate_permission/common.handle_all_urls` REQUIRED + * The relation identifies the use of the statement as intended by the source asset's owner (that is, the person or entity who issued the statement). Every complete statement has a relation. We identify relations with strings of the format `<kind>/<detail>`, where `<kind>` must be one of a set of pre-defined purpose categories, and `<detail>` is a free-form lowercase alphanumeric string that describes the specific use case of the statement. Refer to [our API documentation](/digital-asset-links/v1/relation-strings) for the current list of supported relations. Example: `delegate_permission/common.handle_all_urls` REQUIRED */ relation?: string; /** @@ -277,24 +218,7 @@ export namespace digitalassetlinks_v1 { */ export interface Schema$WebAsset { /** - * Web assets are identified by a URL that contains only the scheme, - * hostname and port parts. The format is - * http[s]://<hostname>[:<port>] Hostnames must be fully - * qualified: they must end in a single period ("`.`"). Only the - * schemes "http" and "https" are currently allowed. - * Port numbers are given as a decimal number, and they must be omitted if - * the standard port numbers are used: 80 for http and 443 for https. We - * call this limited URL the "site". All URLs that share the same - * scheme, hostname and port are considered to be a part of the site and - * thus belong to the web asset. Example: the asset with the site - * `https://www.google.com` contains all these URLs: * - * `https://www.google.com/` * `https://www.google.com:443/` * - * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * - * `https://www.google.com/foo#bar` * - * `https://user@password:www.google.com/` But it does not contain these - * URLs: * `http://www.google.com/` (wrong scheme) * - * `https://google.com/` (hostname does not match) * - * `https://www.google.com:444/` (port does not match) REQUIRED + * Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://<hostname>[:<port>] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED */ site?: string; } @@ -307,25 +231,7 @@ export namespace digitalassetlinks_v1 { /** * digitalassetlinks.assetlinks.check - * @desc Determines whether the specified (directional) relationship exists - * between the specified source and target assets. The relation describes - * the intent of the link between the two assets as claimed by the source - * asset. An example for such relationships is the delegation of privileges - * or permissions. This command is most often used by infrastructure - * systems to check preconditions for an action. For example, a client may - * want to know if it is OK to send a web URL to a particular mobile app - * instead. The client can check for the relevant asset link from the - * website to the mobile app to decide if the operation should be allowed. - * A note about security: if you specify a secure asset as the source, such - * as an HTTPS website or an Android app, the API will ensure that any - * statements used to generate the response have been made in a secure way - * by the owner of that asset. Conversely, if the source asset is an - * insecure HTTP website (that is, the URL starts with `http://` instead of - * `https://`), the API cannot verify its statements securely, and it is not - * possible to ensure that the website's statements have not been altered by - * a third party. For more information, see the [Digital Asset Links - * technical design - * specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). + * @desc Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). * @alias digitalassetlinks.assetlinks.check * @memberOf! () * @@ -411,103 +317,31 @@ export namespace digitalassetlinks_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Query string for the relation. We identify relations with strings of the - * format `/`, where `` must be one of a set of - * pre-defined purpose categories, and `` is a free-form lowercase - * alphanumeric string that describes the specific use case of the - * statement. Refer to [our API - * documentation](/digital-asset-links/v1/relation-strings) for the current - * list of supported relations. For a query to match an asset link, both - * the query's and the asset link's relation strings must match exactly. - * Example: A query with relation - * `delegate_permission/common.handle_all_urls` matches an asset link with - * relation `delegate_permission/common.handle_all_urls`. + * Query string for the relation. We identify relations with strings of the format `/`, where `` must be one of a set of pre-defined purpose categories, and `` is a free-form lowercase alphanumeric string that describes the specific use case of the statement. Refer to [our API documentation](/digital-asset-links/v1/relation-strings) for the current list of supported relations. For a query to match an asset link, both the query's and the asset link's relation strings must match exactly. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`. */ relation?: string; /** - * The uppercase SHA-265 fingerprint of the certificate. From the PEM - * certificate, it can be acquired like this: $ keytool -printcert - * -file $CERTFILE | grep SHA256: SHA256: - * 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - * 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 - * -in $CERTFILE -noout -fingerprint -sha256 SHA256 - * Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - * 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the - * contents of this field would be `14:6D:E9:83:C5:73: - * 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - * 44:E5`. If these tools are not available to you, you can convert the PEM - * certificate into the DER format, compute the SHA-256 hash of that string - * and represent the result as a hexstring (that is, uppercase hexadecimal - * representations of each octet, separated by colons). + * The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). */ 'source.androidApp.certificate.sha256Fingerprint'?: string; /** - * Android App assets are naturally identified by their Java package name. - * For example, the Google Maps app uses the package name - * `com.google.android.apps.maps`. REQUIRED + * Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED */ 'source.androidApp.packageName'?: string; /** - * Web assets are identified by a URL that contains only the scheme, - * hostname and port parts. The format is http[s]://[:] - * Hostnames must be fully qualified: they must end in a single period - * ("`.`"). Only the schemes "http" and "https" are currently allowed. Port - * numbers are given as a decimal number, and they must be omitted if the - * standard port numbers are used: 80 for http and 443 for https. We call - * this limited URL the "site". All URLs that share the same scheme, - * hostname and port are considered to be a part of the site and thus belong - * to the web asset. Example: the asset with the site - * `https://www.google.com` contains all these URLs: * - * `https://www.google.com/` * `https://www.google.com:443/` * - * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * - * `https://www.google.com/foo#bar` * - * `https://user@password:www.google.com/` But it does not contain these - * URLs: * `http://www.google.com/` (wrong scheme) * - * `https://google.com/` (hostname does not match) * - * `https://www.google.com:444/` (port does not match) REQUIRED + * Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://[:] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED */ 'source.web.site'?: string; /** - * The uppercase SHA-265 fingerprint of the certificate. From the PEM - * certificate, it can be acquired like this: $ keytool -printcert - * -file $CERTFILE | grep SHA256: SHA256: - * 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - * 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 - * -in $CERTFILE -noout -fingerprint -sha256 SHA256 - * Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - * 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the - * contents of this field would be `14:6D:E9:83:C5:73: - * 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - * 44:E5`. If these tools are not available to you, you can convert the PEM - * certificate into the DER format, compute the SHA-256 hash of that string - * and represent the result as a hexstring (that is, uppercase hexadecimal - * representations of each octet, separated by colons). + * The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). */ 'target.androidApp.certificate.sha256Fingerprint'?: string; /** - * Android App assets are naturally identified by their Java package name. - * For example, the Google Maps app uses the package name - * `com.google.android.apps.maps`. REQUIRED + * Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED */ 'target.androidApp.packageName'?: string; /** - * Web assets are identified by a URL that contains only the scheme, - * hostname and port parts. The format is http[s]://[:] - * Hostnames must be fully qualified: they must end in a single period - * ("`.`"). Only the schemes "http" and "https" are currently allowed. Port - * numbers are given as a decimal number, and they must be omitted if the - * standard port numbers are used: 80 for http and 443 for https. We call - * this limited URL the "site". All URLs that share the same scheme, - * hostname and port are considered to be a part of the site and thus belong - * to the web asset. Example: the asset with the site - * `https://www.google.com` contains all these URLs: * - * `https://www.google.com/` * `https://www.google.com:443/` * - * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * - * `https://www.google.com/foo#bar` * - * `https://user@password:www.google.com/` But it does not contain these - * URLs: * `http://www.google.com/` (wrong scheme) * - * `https://google.com/` (hostname does not match) * - * `https://www.google.com:444/` (port does not match) REQUIRED + * Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://[:] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED */ 'target.web.site'?: string; } @@ -520,20 +354,7 @@ export namespace digitalassetlinks_v1 { /** * digitalassetlinks.statements.list - * @desc Retrieves a list of all statements from a given source that match - * the specified target and statement string. The API guarantees that all - * statements with secure source assets, such as HTTPS websites or Android - * apps, have been made in a secure way by the owner of those assets, as - * described in the [Digital Asset Links technical design - * specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). - * Specifically, you should consider that for insecure websites (that is, - * where the URL starts with `http://` instead of `https://`), this - * guarantee cannot be made. The `List` command is most useful in cases - * where the API client wants to know all the ways in which two assets are - * related, or enumerate all the relationships from a particular source - * asset. Example: a feature that helps users navigate to related items. - * When a mobile app is running on a device, the feature would make it easy - * to navigate to the corresponding web site or Google+ profile. + * @desc Retrieves a list of all statements from a given source that match the specified target and statement string. The API guarantees that all statements with secure source assets, such as HTTPS websites or Android apps, have been made in a secure way by the owner of those assets, as described in the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). Specifically, you should consider that for insecure websites (that is, where the URL starts with `http://` instead of `https://`), this guarantee cannot be made. The `List` command is most useful in cases where the API client wants to know all the ways in which two assets are related, or enumerate all the relationships from a particular source asset. Example: a feature that helps users navigate to related items. When a mobile app is running on a device, the feature would make it easy to navigate to the corresponding web site or Google+ profile. * @alias digitalassetlinks.statements.list * @memberOf! () * @@ -616,57 +437,19 @@ export namespace digitalassetlinks_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Use only associations that match the specified relation. See the - * [`Statement`](#Statement) message for a detailed definition of relation - * strings. For a query to match a statement, one of the following must be - * true: * both the query's and the statement's relation strings match - * exactly, or * the query's relation string is empty or missing. - * Example: A query with relation - * `delegate_permission/common.handle_all_urls` matches an asset link with - * relation `delegate_permission/common.handle_all_urls`. + * Use only associations that match the specified relation. See the [`Statement`](#Statement) message for a detailed definition of relation strings. For a query to match a statement, one of the following must be true: * both the query's and the statement's relation strings match exactly, or * the query's relation string is empty or missing. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`. */ relation?: string; /** - * The uppercase SHA-265 fingerprint of the certificate. From the PEM - * certificate, it can be acquired like this: $ keytool -printcert - * -file $CERTFILE | grep SHA256: SHA256: - * 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - * 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 - * -in $CERTFILE -noout -fingerprint -sha256 SHA256 - * Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - * 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the - * contents of this field would be `14:6D:E9:83:C5:73: - * 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - * 44:E5`. If these tools are not available to you, you can convert the PEM - * certificate into the DER format, compute the SHA-256 hash of that string - * and represent the result as a hexstring (that is, uppercase hexadecimal - * representations of each octet, separated by colons). + * The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). */ 'source.androidApp.certificate.sha256Fingerprint'?: string; /** - * Android App assets are naturally identified by their Java package name. - * For example, the Google Maps app uses the package name - * `com.google.android.apps.maps`. REQUIRED + * Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED */ 'source.androidApp.packageName'?: string; /** - * Web assets are identified by a URL that contains only the scheme, - * hostname and port parts. The format is http[s]://[:] - * Hostnames must be fully qualified: they must end in a single period - * ("`.`"). Only the schemes "http" and "https" are currently allowed. Port - * numbers are given as a decimal number, and they must be omitted if the - * standard port numbers are used: 80 for http and 443 for https. We call - * this limited URL the "site". All URLs that share the same scheme, - * hostname and port are considered to be a part of the site and thus belong - * to the web asset. Example: the asset with the site - * `https://www.google.com` contains all these URLs: * - * `https://www.google.com/` * `https://www.google.com:443/` * - * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * - * `https://www.google.com/foo#bar` * - * `https://user@password:www.google.com/` But it does not contain these - * URLs: * `http://www.google.com/` (wrong scheme) * - * `https://google.com/` (hostname does not match) * - * `https://www.google.com:444/` (port does not match) REQUIRED + * Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://[:] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED */ 'source.web.site'?: string; } diff --git a/src/apis/discovery/package.json b/src/apis/discovery/package.json index dcf7c9f6eae..9194e42ffcf 100644 --- a/src/apis/discovery/package.json +++ b/src/apis/discovery/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/discovery/v1.ts b/src/apis/discovery/v1.ts index 1564e409a48..dd9dc1c0c5c 100644 --- a/src/apis/discovery/v1.ts +++ b/src/apis/discovery/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace discovery_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace discovery_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace discovery_v1 { /** * API Discovery Service * - * Provides information about other Google APIs, such as what APIs are - * available, the resource, and method details for each API. + * Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API. * * @example * const {google} = require('googleapis'); @@ -96,7 +92,10 @@ export namespace discovery_v1 { apis: Resource$Apis; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.apis = new Resource$Apis(this.context); } @@ -131,13 +130,11 @@ export namespace discovery_v1 { } export interface Schema$JsonSchema { /** - * A reference to another schema. The value of this property is the - * "id" of another schema. + * A reference to another schema. The value of this property is the "id" of another schema. */ $ref?: string; /** - * If this is a schema for an object, this property is the schema for any - * additional properties with dynamic keys on this object. + * If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. */ additionalProperties?: Schema$JsonSchema; /** @@ -157,14 +154,11 @@ export namespace discovery_v1 { */ enum?: string[]; /** - * The descriptions for the enums. Each position maps to the corresponding - * value in the "enum" array. + * The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. */ enumDescriptions?: string[]; /** - * An additional regular expression or key that helps constrain the value. - * For more details see: - * http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 + * An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 */ format?: string; /** @@ -172,8 +166,7 @@ export namespace discovery_v1 { */ id?: string; /** - * If this is a schema for an array, this property is the schema for each - * element in the array. + * If this is a schema for an array, this property is the schema for each element in the array. */ items?: Schema$JsonSchema; /** @@ -189,20 +182,15 @@ export namespace discovery_v1 { */ minimum?: string; /** - * The regular expression this parameter must conform to. Uses Java 6 regex - * format: - * http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html + * The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html */ pattern?: string; /** - * If this is a schema for an object, list the schema for each property of - * this object. + * If this is a schema for an object, list the schema for each property of this object. */ properties?: {[key: string]: Schema$JsonSchema}; /** - * The value is read-only, generated by the service. The value cannot be - * modified by the client. If the value is included in a POST, PUT, or PATCH - * request, it is ignored by the service. + * The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. */ readOnly?: boolean; /** @@ -214,14 +202,11 @@ export namespace discovery_v1 { */ required?: boolean; /** - * The value type for this schema. A list of values can be found here: - * http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 + * The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 */ type?: string; /** - * In a variant data type, the value of one property is used to determine - * how to interpret the entire entity. Its value must exist in a map of - * descriminant values to schema names. + * In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. */ variant?: { discriminant?: string; @@ -246,8 +231,7 @@ export namespace discovery_v1 { */ batchPath?: string; /** - * Indicates how the API name should be capitalized and split into various - * parts. Useful for generating pretty class names. + * Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. */ canonicalName?: string; /** @@ -299,9 +283,7 @@ export namespace discovery_v1 { */ name?: string; /** - * The domain of the owner of this API. Together with the ownerName and a - * packagePath values, this can be used to generate a library for this API - * which would have a unique fully qualified name. + * The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. */ ownerDomain?: string; /** @@ -356,8 +338,7 @@ export namespace discovery_v1 { */ description?: string; /** - * Whether this method requires an ETag to be specified. The ETag is sent as - * an HTTP If-Match or If-None-Match header. + * Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. */ etagRequired?: boolean; /** @@ -365,8 +346,7 @@ export namespace discovery_v1 { */ httpMethod?: string; /** - * A unique ID for this method. This property can be used to match methods - * between different versions of Discovery. + * A unique ID for this method. This property can be used to match methods between different versions of Discovery. */ id?: string; /** @@ -381,9 +361,7 @@ export namespace discovery_v1 { }; }; /** - * Ordered list of required parameters, serves as a hint to clients on how - * to structure their method signatures. The array is ordered such that the - * "most-significant" parameter appears first. + * Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first. */ parameterOrder?: string[]; /** @@ -391,8 +369,7 @@ export namespace discovery_v1 { */ parameters?: {[key: string]: Schema$JsonSchema}; /** - * The URI path of this REST method. Should be used in conjunction with the - * basePath property at the api-level. + * The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. */ path?: string; /** @@ -420,9 +397,7 @@ export namespace discovery_v1 { */ supportsSubscription?: boolean; /** - * Indicates that downloads from this method should use the download service - * URL (i.e. "/download"). Only applies if the method supports - * media download. + * Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download. */ useMediaDownloadService?: boolean; } diff --git a/src/apis/dlp/package.json b/src/apis/dlp/package.json index c470747e2a2..a69cdf5c3f3 100644 --- a/src/apis/dlp/package.json +++ b/src/apis/dlp/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 9da4062f06a..90d8deef264 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace dlp_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace dlp_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace dlp_v2 { /** * Cloud Data Loss Prevention (DLP) API * - * Provides methods for detection, risk analysis, and de-identification of - * privacy-sensitive fragments in text, images, and Google Cloud Platform - * storage repositories. + * Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories. * * @example * const {google} = require('googleapis'); @@ -116,7 +110,10 @@ export namespace dlp_v2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.infoTypes = new Resource$Infotypes(this.context); this.organizations = new Resource$Organizations(this.context); @@ -125,13 +122,11 @@ export namespace dlp_v2 { } /** - * A task to execute on the completion of a job. See - * https://cloud.google.com/dlp/docs/concepts-actions to learn more. + * A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more. */ export interface Schema$GooglePrivacyDlpV2Action { /** - * Enable email notification to project owners and editors on job's - * completion/failure. + * Enable email notification to project owners and editors on job's completion/failure. */ jobNotificationEmails?: Schema$GooglePrivacyDlpV2JobNotificationEmails; /** @@ -171,12 +166,7 @@ export namespace dlp_v2 { requestedSourceTable?: Schema$GooglePrivacyDlpV2BigQueryTable; } /** - * An auxiliary table contains statistical information on the relative - * frequency of different quasi-identifiers values. It has one or several - * quasi-identifiers columns, and one column that indicates the relative - * frequency of each quasi-identifier tuple. If a tuple is present in the data - * but not in the auxiliary table, the corresponding relative frequency is - * assumed to be zero (and thus, the tuple is highly reidentifiable). + * An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable). */ export interface Schema$GooglePrivacyDlpV2AuxiliaryTable { /** @@ -184,9 +174,7 @@ export namespace dlp_v2 { */ quasiIds?: Schema$GooglePrivacyDlpV2QuasiIdField[]; /** - * The relative frequency column must contain a floating-point number - * between 0 and 1 (inclusive). Null values are assumed to be zero. - * [required] + * The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required] */ relativeFrequency?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -212,8 +200,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2BigQueryKey { /** - * Absolute number of the row from the beginning of the table at the time of - * scanning. + * Absolute number of the row from the beginning of the table at the time of scanning. */ rowNumber?: string; /** @@ -226,28 +213,19 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2BigQueryOptions { /** - * References to fields excluded from scanning. This allows you to skip - * inspection of entire columns which you know have no findings. + * References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. */ excludedFields?: Schema$GooglePrivacyDlpV2FieldId[]; /** - * References to fields uniquely identifying rows within the table. Nested - * fields in the format, like `person.birthdate.year`, are allowed. + * References to fields uniquely identifying rows within the table. Nested fields in the format, like `person.birthdate.year`, are allowed. */ identifyingFields?: Schema$GooglePrivacyDlpV2FieldId[]; /** - * Max number of rows to scan. If the table has more rows than this value, - * the rest of the rows are omitted. If not set, or if set to 0, all rows - * will be scanned. Only one of rows_limit and rows_limit_percent can be - * specified. Cannot be used in conjunction with TimespanConfig. + * Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. */ rowsLimit?: string; /** - * Max percentage of rows to scan. The rest are omitted. The number of rows - * scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 - * and 100 means no limit. Defaults to 0. Only one of rows_limit and - * rows_limit_percent can be specified. Cannot be used in conjunction with - * TimespanConfig. + * Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. */ rowsLimitPercent?: number; sampleMethod?: string; @@ -257,11 +235,7 @@ export namespace dlp_v2 { tableReference?: Schema$GooglePrivacyDlpV2BigQueryTable; } /** - * Message defining the location of a BigQuery table. A table is uniquely - * identified by its project_id, dataset_id, and table_name. Within a query a - * table is often referenced with a string in the format of: - * `<project_id>:<dataset_id>.<table_id>` or - * `<project_id>.<dataset_id>.<table_id>`. + * Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `<project_id>:<dataset_id>.<table_id>` or `<project_id>.<dataset_id>.<table_id>`. */ export interface Schema$GooglePrivacyDlpV2BigQueryTable { /** @@ -269,8 +243,7 @@ export namespace dlp_v2 { */ datasetId?: string; /** - * The Google Cloud Platform project ID of the project containing the table. - * If omitted, project ID is inferred from the API call. + * The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. */ projectId?: string; /** @@ -308,25 +281,16 @@ export namespace dlp_v2 { */ max?: Schema$GooglePrivacyDlpV2Value; /** - * Lower bound of the range, inclusive. Type should be the same as max if - * used. + * Lower bound of the range, inclusive. Type should be the same as max if used. */ min?: Schema$GooglePrivacyDlpV2Value; /** - * Replacement value for this bucket. If not provided the default behavior - * will be to hyphenate the min-max range. + * Replacement value for this bucket. If not provided the default behavior will be to hyphenate the min-max range. */ replacementValue?: Schema$GooglePrivacyDlpV2Value; } /** - * Generalization function that buckets values based on ranges. The ranges and - * replacement values are dynamically provided by the user for custom - * behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This - * can be used on data of type: number, long, string, timestamp. If the bound - * `Value` type differs from the type of data being transformed, we will first - * attempt converting the type of the data to be transformed to match the type - * of the bound before comparing. See - * https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. + * Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. */ export interface Schema$GooglePrivacyDlpV2BucketingConfig { /** @@ -352,14 +316,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CancelDlpJobRequest {} /** - * Compute numerical stats over an individual column, including number of - * distinct values and value count distribution. + * Compute numerical stats over an individual column, including number of distinct values and value count distribution. */ export interface Schema$GooglePrivacyDlpV2CategoricalStatsConfig { /** - * Field to compute categorical stats on. All column types are supported - * except for arrays and structs. However, it may be more informative to use - * NumericalStats when the field type is supported, depending on the data. + * Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data. */ field?: Schema$GooglePrivacyDlpV2FieldId; } @@ -373,8 +334,7 @@ export namespace dlp_v2 { */ bucketValueCount?: string; /** - * Sample of value frequencies in this bucket. The total number of values - * returned per bucket is capped at 20. + * Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20. */ bucketValues?: Schema$GooglePrivacyDlpV2ValueFrequency[]; /** @@ -396,45 +356,28 @@ export namespace dlp_v2 { valueFrequencyHistogramBuckets?: Schema$GooglePrivacyDlpV2CategoricalStatsHistogramBucket[]; } /** - * Partially mask a string by replacing a given number of characters with a - * fixed character. Masking can start from the beginning or end of the string. - * This can be used on data of any type (numbers, longs, and so on) and when - * de-identifying structured data we'll attempt to preserve the original - * data's type. (This allows you to take a long like 123 and modify it to - * a string like **3. + * Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. This can be used on data of any type (numbers, longs, and so on) and when de-identifying structured data we'll attempt to preserve the original data's type. (This allows you to take a long like 123 and modify it to a string like **3. */ export interface Schema$GooglePrivacyDlpV2CharacterMaskConfig { /** - * When masking a string, items in this list will be skipped when replacing. - * For example, if your string is 555-555-5555 and you ask us to skip `-` - * and mask 5 chars with * we would produce ***-*55-5555. + * When masking a string, items in this list will be skipped when replacing. For example, if your string is 555-555-5555 and you ask us to skip `-` and mask 5 chars with * we would produce ***-*55-5555. */ charactersToIgnore?: Schema$GooglePrivacyDlpV2CharsToIgnore[]; /** - * Character to mask the sensitive values&mdash;for example, - * "*" for an alphabetic string such as name, or "0" for - * a numeric string such as ZIP code or credit card number. String must have - * length 1. If not supplied, we will default to "*" for strings, - * 0 for digits. + * Character to mask the sensitive values&mdash;for example, "*" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "*" for strings, 0 for digits. */ maskingCharacter?: string; /** - * Number of characters to mask. If not set, all matching chars will be - * masked. Skipped characters do not count towards this tally. + * Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally. */ numberToMask?: number; /** - * Mask characters in reverse order. For example, if `masking_character` is - * '0', number_to_mask is 14, and `reverse_order` is false, then - * 1234-5678-9012-3456 -> 00000000000000-3456 If `masking_character` is - * '*', `number_to_mask` is 3, and `reverse_order` is true, then - * 12345 -> 12*** + * Mask characters in reverse order. For example, if `masking_character` is '0', number_to_mask is 14, and `reverse_order` is false, then 1234-5678-9012-3456 -> 00000000000000-3456 If `masking_character` is '*', `number_to_mask` is 3, and `reverse_order` is true, then 12345 -> 12*** */ reverseOrder?: boolean; } /** - * Characters to skip when doing deidentification of a value. These will be - * left alone and skipped. + * Characters to skip when doing deidentification of a value. These will be left alone and skipped. */ export interface Schema$GooglePrivacyDlpV2CharsToIgnore { charactersToSkip?: string; @@ -445,28 +388,20 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CloudStorageFileSet { /** - * The url, in the format `gs://<bucket>/<path>`. Trailing - * wildcard in the path is allowed. + * The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed. */ url?: string; } /** - * Options defining a file or a set of files within a Google Cloud Storage - * bucket. + * Options defining a file or a set of files within a Google Cloud Storage bucket. */ export interface Schema$GooglePrivacyDlpV2CloudStorageOptions { /** - * Max number of bytes to scan from a file. If a scanned file's size is - * bigger than this value then the rest of the bytes are omitted. Only one - * of bytes_limit_per_file and bytes_limit_per_file_percent can be - * specified. + * Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. */ bytesLimitPerFile?: string; /** - * Max percentage of bytes to scan from a file. The rest are omitted. The - * number of bytes scanned is rounded down. Must be between 0 and 100, - * inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of - * bytes_limit_per_file and bytes_limit_per_file_percent can be specified. + * Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. */ bytesLimitPerFilePercent?: number; /** @@ -474,15 +409,11 @@ export namespace dlp_v2 { */ fileSet?: Schema$GooglePrivacyDlpV2FileSet; /** - * Limits the number of files to scan to this percentage of the input - * FileSet. Number of files scanned is rounded down. Must be between 0 and - * 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. + * Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. */ filesLimitPercent?: number; /** - * List of file type groups to include in the scan. If empty, all files are - * scanned and available data format processors are applied. In addition, - * the binary content of the selected files is always scanned as well. + * List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. */ fileTypes?: string[]; sampleMethod?: string; @@ -492,35 +423,12 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CloudStoragePath { /** - * A url representing a file or path (no wildcards) in Cloud Storage. - * Example: gs://[BUCKET_NAME]/dictionary.txt + * A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt */ path?: string; } /** - * Message representing a set of files in a Cloud Storage bucket. Regular - * expressions are used to allow fine-grained control over which files in the - * bucket to include. Included files are those that match at least one item - * in `include_regex` and do not match any items in `exclude_regex`. Note that - * a file that matches items from both lists will _not_ be included. For a - * match to occur, the entire file path (i.e., everything in the url after the - * bucket name) must match the regular expression. For example, given the - * input `{bucket_name: "mybucket", include_regex: - * ["directory1/.*"], exclude_regex: - * ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` - * will be included * `gs://mybucket/directory1/directory2/myfile` will be - * included (`.*` matches across `/`) * - * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the - * full path doesn't match any items in `include_regex`) * - * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path - * matches an item in `exclude_regex`) If `include_regex` is left empty, it - * will match all files by default (this is equivalent to setting - * `include_regex: [".*"]`). Some other common use cases: * - * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` - * will include all files in `mybucket` except for .pdf files * `{bucket_name: - * "mybucket", include_regex: ["directory/[^/]+"]}` will - * include all files directly under `gs://mybucket/directory/`, without - * matching across `/` + * Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` */ export interface Schema$GooglePrivacyDlpV2CloudStorageRegexFileSet { /** @@ -528,21 +436,11 @@ export namespace dlp_v2 { */ bucketName?: string; /** - * A list of regular expressions matching file paths to exclude. All files - * in the bucket that match at least one of these regular expressions will - * be excluded from the scan. Regular expressions use RE2 - * [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found - * under the google/re2 repository on GitHub. + * A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. */ excludeRegex?: string[]; /** - * A list of regular expressions matching file paths to include. All files - * in the bucket that match at least one of these regular expressions will - * be included in the set of files, except for those that also match an item - * in `exclude_regex`. Leaving this field empty will match all files by - * default (this is equivalent to including `.*` in the list). Regular - * expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); - * a guide can be found under the google/re2 repository on GitHub. + * A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. */ includeRegex?: string[]; } @@ -564,18 +462,7 @@ export namespace dlp_v2 { red?: number; } /** - * The field type of `value` and `field` do not need to match to be considered - * equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO - * attempt to compare even with incompatible types, but all other comparisons - * are invalid with incompatible types. A `value` of type: - `string` can be - * compared against all other types - `boolean` can only be compared against - * other booleans - `integer` can be compared against doubles or a string if - * the string value can be parsed as an integer. - `double` can be compared - * against integers or a string if the string can be parsed as a double. - - * `Timestamp` can be compared against strings in RFC 3339 date string format. - * - `TimeOfDay` can be compared against timestamps and strings in the format - * of 'HH:mm:ss'. If we fail to compare do to type mismatch, a - * warning will be given and the condition will evaluate to false. + * The field type of `value` and `field` do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A `value` of type: - `string` can be compared against all other types - `boolean` can only be compared against other booleans - `integer` can be compared against doubles or a string if the string value can be parsed as an integer. - `double` can be compared against integers or a string if the string can be parsed as a double. - `Timestamp` can be compared against strings in RFC 3339 date string format. - `TimeOfDay` can be compared against timestamps and strings in the format of 'HH:mm:ss'. If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false. */ export interface Schema$GooglePrivacyDlpV2Condition { /** @@ -606,9 +493,7 @@ export namespace dlp_v2 { */ byteItem?: Schema$GooglePrivacyDlpV2ByteContentItem; /** - * Structured content for inspection. See - * https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to - * learn more. + * Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. */ table?: Schema$GooglePrivacyDlpV2Table; /** @@ -621,26 +506,15 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ContentLocation { /** - * Name of the container where the finding is located. The top level name is - * the source file name or table name. Names of some common storage - * containers are formatted as follows: * BigQuery tables: - * `<project_id>:<dataset_id>.<table_id>` * Cloud Storage - * files: `gs://<bucket>/<path>` * Datastore namespace: - * <namespace> Nested names could be absent if the embedded object - * has no string identifier (for an example an image contained within a - * document). + * Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `<project_id>:<dataset_id>.<table_id>` * Cloud Storage files: `gs://<bucket>/<path>` * Datastore namespace: <namespace> Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document). */ containerName?: string; /** - * Findings container modification timestamp, if applicable. For Google - * Cloud Storage contains last file modification timestamp. For BigQuery - * table contains last_modified_time property. For Datastore - not - * populated. + * Findings container modification timestamp, if applicable. For Google Cloud Storage contains last file modification timestamp. For BigQuery table contains last_modified_time property. For Datastore - not populated. */ containerTimestamp?: string; /** - * Findings container version, if available ("generation" for - * Google Cloud Storage). + * Findings container version, if available ("generation" for Google Cloud Storage). */ containerVersion?: string; /** @@ -665,24 +539,17 @@ export namespace dlp_v2 { */ deidentifyTemplate?: Schema$GooglePrivacyDlpV2DeidentifyTemplate; /** - * The template id can contain uppercase and lowercase letters, numbers, and - * hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. - * The maximum length is 100 characters. Can be empty to allow the system to - * generate one. + * The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. */ templateId?: string; } /** - * Request message for CreateDlpJobRequest. Used to initiate long running jobs - * such as calculating risk metrics or inspecting Google Cloud Storage. + * Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage. */ export interface Schema$GooglePrivacyDlpV2CreateDlpJobRequest { inspectJob?: Schema$GooglePrivacyDlpV2InspectJobConfig; /** - * The job id can contain uppercase and lowercase letters, numbers, and - * hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. - * The maximum length is 100 characters. Can be empty to allow the system to - * generate one. + * The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. */ jobId?: string; riskJob?: Schema$GooglePrivacyDlpV2RiskAnalysisJobConfig; @@ -696,10 +563,7 @@ export namespace dlp_v2 { */ inspectTemplate?: Schema$GooglePrivacyDlpV2InspectTemplate; /** - * The template id can contain uppercase and lowercase letters, numbers, and - * hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. - * The maximum length is 100 characters. Can be empty to allow the system to - * generate one. + * The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. */ templateId?: string; } @@ -712,10 +576,7 @@ export namespace dlp_v2 { */ jobTrigger?: Schema$GooglePrivacyDlpV2JobTrigger; /** - * The trigger id can contain uppercase and lowercase letters, numbers, and - * hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. - * The maximum length is 100 characters. Can be empty to allow the system to - * generate one. + * The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. */ triggerId?: string; } @@ -728,33 +589,16 @@ export namespace dlp_v2 { */ config?: Schema$GooglePrivacyDlpV2StoredInfoTypeConfig; /** - * The storedInfoType ID can contain uppercase and lowercase letters, - * numbers, and hyphens; that is, it must match the regular expression: - * `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to - * allow the system to generate one. + * The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. */ storedInfoTypeId?: string; } /** - * Pseudonymization method that generates deterministic encryption for the - * given input. Outputs a base64 encoded representation of the encrypted - * output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297. + * Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297. */ export interface Schema$GooglePrivacyDlpV2CryptoDeterministicConfig { /** - * Optional. A context may be used for higher security and maintaining - * referential integrity such that the same identifier in two different - * contexts will be given a distinct surrogate. The context is appended to - * plaintext value being encrypted. On decryption the provided context is - * validated against the value used during encryption. If a context was - * provided during encryption, same context must be provided during - * decryption as well. If the context is not set, plaintext would be used - * as is for encryption. If the context is set but: 1. there is no record - * present when transforming a given value or 2. the field is not present - * when transforming a given value, plaintext would be used as is for - * encryption. Note that case (1) is expected when an - * `InfoTypeTransformation` is applied to both structured and non-structured - * `ContentItem`s. + * Optional. A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. */ context?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -762,37 +606,12 @@ export namespace dlp_v2 { */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * The custom info type to annotate the surrogate with. This annotation will - * be applied to the surrogate by prefixing it with the name of the custom - * info type followed by the number of characters comprising the surrogate. - * The following scheme defines the format: <info type - * name>(<surrogate character count>):<surrogate> For - * example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' - * and the surrogate is 'abc', the full replacement value will be: - * 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the - * surrogate when inspecting content using the custom info type - * 'Surrogate'. This facilitates reversal of the surrogate when it - * occurs in free text. In order for inspection to work properly, the name - * of this info type must not occur naturally anywhere in your data; - * otherwise, inspection may either - reverse a surrogate that does not - * correspond to an actual identifier - be unable to parse the surrogate and - * result in an error Therefore, choose your custom info type name - * carefully after considering what your data looks like. One way to select - * a name that has a high chance of yielding reliable detection is to - * include one or more unicode characters that are highly improbable to - * exist in your data. For example, assuming your data is entered from a - * regular ASCII keyboard, the symbol with the hex code point 29DD might be - * used like so: ⧝MY_TOKEN_TYPE + * The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: <info type name>(<surrogate character count>):<surrogate> For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE */ surrogateInfoType?: Schema$GooglePrivacyDlpV2InfoType; } /** - * Pseudonymization method that generates surrogates via cryptographic - * hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs - * a base64 encoded representation of the hashed output (for example, - * L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and - * integer values can be hashed. See - * https://cloud.google.com/dlp/docs/pseudonymization to learn more. + * Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. */ export interface Schema$GooglePrivacyDlpV2CryptoHashConfig { /** @@ -801,10 +620,7 @@ export namespace dlp_v2 { cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; } /** - * This is a data encryption key (DEK) (as opposed to a key encryption key - * (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an - * appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker - * cannot unwrap the data crypto key. + * This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot unwrap the data crypto key. */ export interface Schema$GooglePrivacyDlpV2CryptoKey { kmsWrapped?: Schema$GooglePrivacyDlpV2KmsWrappedCryptoKey; @@ -812,34 +628,12 @@ export namespace dlp_v2 { unwrapped?: Schema$GooglePrivacyDlpV2UnwrappedCryptoKey; } /** - * Replaces an identifier with a surrogate using Format Preserving Encryption - * (FPE) with the FFX mode of operation; however when used in the - * `ReidentifyContent` API method, it serves the opposite function by - * reversing the surrogate back into the original identifier. The identifier - * must be encoded as ASCII. For a given crypto key and context, the same - * identifier will be replaced with the same surrogate. Identifiers must be at - * least two characters long. In the case that the identifier is the empty - * string, it will be skipped. See - * https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We - * recommend using CryptoDeterministicConfig for all use cases which do not - * require preserving the input alphabet space and size, plus warrant - * referential integrity. + * Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. */ export interface Schema$GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig { commonAlphabet?: string; /** - * The 'tweak', a context may be used for higher security since the - * same identifier in two different contexts won't be given the same - * surrogate. If the context is not set, a default tweak will be used. If - * the context is set but: 1. there is no record present when transforming - * a given value or 1. the field is not present when transforming a given - * value, a default tweak will be used. Note that case (1) is expected - * when an `InfoTypeTransformation` is applied to both structured and - * non-structured `ContentItem`s. Currently, the referenced field may be of - * value type integer or string. The tweak is constructed as a sequence of - * bytes in big endian byte order such that: - a 64 bit integer is encoded - * followed by a single byte of value 1 - a string is encoded in UTF-8 - * format followed by a single byte of value 2 + * The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 */ context?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -847,11 +641,7 @@ export namespace dlp_v2 { */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * This is supported by mapping these to the alphanumeric characters that - * the FFX mode natively supports. This happens before/after - * encryption/decryption. Each character listed must appear only once. - * Number of characters must be in the range [2, 62]. This must be encoded - * as ASCII. The order of characters does not matter. + * This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 62]. This must be encoded as ASCII. The order of characters does not matter. */ customAlphabet?: string; /** @@ -859,38 +649,16 @@ export namespace dlp_v2 { */ radix?: number; /** - * The custom infoType to annotate the surrogate with. This annotation will - * be applied to the surrogate by prefixing it with the name of the custom - * infoType followed by the number of characters comprising the surrogate. - * The following scheme defines the format: - * info_type_name(surrogate_character_count):surrogate For example, if the - * name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate - * is 'abc', the full replacement value will be: - * 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the - * surrogate when inspecting content using the custom infoType - * [`SurrogateType`](/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). - * This facilitates reversal of the surrogate when it occurs in free text. - * In order for inspection to work properly, the name of this infoType must - * not occur naturally anywhere in your data; otherwise, inspection may find - * a surrogate that does not correspond to an actual identifier. Therefore, - * choose your custom infoType name carefully after considering what your - * data looks like. One way to select a name that has a high chance of - * yielding reliable detection is to include one or more unicode characters - * that are highly improbable to exist in your data. For example, assuming - * your data is entered from a regular ASCII keyboard, the symbol with the - * hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE + * The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE */ surrogateInfoType?: Schema$GooglePrivacyDlpV2InfoType; } /** - * Custom information type provided by the user. Used to find domain-specific - * sensitive information configurable to the data in question. + * Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. */ export interface Schema$GooglePrivacyDlpV2CustomInfoType { /** - * Set of detection rules to apply to all findings of this CustomInfoType. - * Rules are applied in order that they are specified. Not supported for the - * `surrogate_type` CustomInfoType. + * Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type` CustomInfoType. */ detectionRules?: Schema$GooglePrivacyDlpV2DetectionRule[]; /** @@ -898,23 +666,15 @@ export namespace dlp_v2 { */ dictionary?: Schema$GooglePrivacyDlpV2Dictionary; /** - * If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding - * to be returned. It still can be used for rules matching. + * If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. */ exclusionType?: string; /** - * CustomInfoType can either be a new infoType, or an extension of built-in - * infoType, when the name matches one of existing infoTypes and that - * infoType is specified in `InspectContent.info_types` field. Specifying - * the latter adds findings to the one detected by the system. If built-in - * info type is not specified in `InspectContent.info_types` list then the - * name is treated as a custom info type. + * CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; /** - * Likelihood to return for this CustomInfoType. This base value can be - * altered by a detection rule if the finding meets the criteria specified - * by the rule. Defaults to `VERY_LIKELY` if not specified. + * Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. */ likelihood?: string; /** @@ -922,13 +682,11 @@ export namespace dlp_v2 { */ regex?: Schema$GooglePrivacyDlpV2Regex; /** - * Load an existing `StoredInfoType` resource for use in - * `InspectDataSource`. Not currently supported in `InspectContent`. + * Load an existing `StoredInfoType` resource for use in `InspectDataSource`. Not currently supported in `InspectContent`. */ storedType?: Schema$GooglePrivacyDlpV2StoredType; /** - * Message for detecting output from deidentification transformations that - * support reversing. + * Message for detecting output from deidentification transformations that support reversing. */ surrogateType?: Schema$GooglePrivacyDlpV2SurrogateType; } @@ -950,38 +708,28 @@ export namespace dlp_v2 { */ kind?: Schema$GooglePrivacyDlpV2KindExpression; /** - * A partition ID identifies a grouping of entities. The grouping is always - * by project and namespace, however the namespace ID may be empty. + * A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. */ partitionId?: Schema$GooglePrivacyDlpV2PartitionId; } /** - * Shifts dates by random number of days, with option to be consistent for the - * same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting - * to learn more. + * Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more. */ export interface Schema$GooglePrivacyDlpV2DateShiftConfig { /** - * Points to the field that contains the context, for example, an entity id. - * If set, must also set method. If set, shift will be consistent for the - * given context. + * Points to the field that contains the context, for example, an entity id. If set, must also set method. If set, shift will be consistent for the given context. */ context?: Schema$GooglePrivacyDlpV2FieldId; /** - * Causes the shift to be computed based on this key and the context. This - * results in the same shift for the same context and crypto_key. + * Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * For example, -5 means shift date to at most 5 days back in the past. - * [Required] + * For example, -5 means shift date to at most 5 days back in the past. [Required] */ lowerBoundDays?: number; /** - * Range of shift in days. Actual shift will be selected at random within - * this range (inclusive ends). Negative means shift to earlier in time. - * Must not be more than 365250 days (1000 years) each direction. For - * example, 3 means shift date to at most 3 days into the future. [Required] + * Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. [Required] */ upperBoundDays?: number; } @@ -990,8 +738,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DateTime { /** - * One or more of the following must be set. All fields are optional, but - * when set must be valid date or time values. + * One or more of the following must be set. All fields are optional, but when set must be valid date or time values. */ date?: Schema$GoogleTypeDate; dayOfWeek?: string; @@ -1003,14 +750,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DeidentifyConfig { /** - * Treat the dataset as free-form text and apply the same free text - * transformation everywhere. + * Treat the dataset as free-form text and apply the same free text transformation everywhere. */ infoTypeTransformations?: Schema$GooglePrivacyDlpV2InfoTypeTransformations; /** - * Treat the dataset as structured. Transformations can be applied to - * specific locations within structured datasets, such as transforming a - * column within a table. + * Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table. */ recordTransformations?: Schema$GooglePrivacyDlpV2RecordTransformations; } @@ -1019,30 +763,19 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DeidentifyContentRequest { /** - * Configuration for the de-identification of the content item. Items - * specified here will override the template referenced by the - * deidentify_template_name argument. + * Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument. */ deidentifyConfig?: Schema$GooglePrivacyDlpV2DeidentifyConfig; /** - * Optional template to use. Any configuration directly specified in - * deidentify_config will override those set in the template. Singular - * fields that are set in this request will replace their corresponding - * fields in the template. Repeated fields are appended. Singular - * sub-messages and groups are recursively merged. + * Optional template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ deidentifyTemplateName?: string; /** - * Configuration for the inspector. Items specified here will override the - * template referenced by the inspect_template_name argument. + * Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument. */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * Optional template to use. Any configuration directly specified in - * inspect_config will override those set in the template. Singular fields - * that are set in this request will replace their corresponding fields in - * the template. Repeated fields are appended. Singular sub-messages and - * groups are recursively merged. + * Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ inspectTemplateName?: string; /** @@ -1064,8 +797,7 @@ export namespace dlp_v2 { overview?: Schema$GooglePrivacyDlpV2TransformationOverview; } /** - * The DeidentifyTemplates contains instructions on how to deidentify content. - * See https://cloud.google.com/dlp/docs/concepts-templates to learn more. + * The DeidentifyTemplates contains instructions on how to deidentify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. */ export interface Schema$GooglePrivacyDlpV2DeidentifyTemplate { /** @@ -1085,9 +817,7 @@ export namespace dlp_v2 { */ displayName?: string; /** - * The template name. Output only. The template will have one of the - * following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` - * OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` + * The template name. Output only. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` */ name?: string; /** @@ -1096,36 +826,24 @@ export namespace dlp_v2 { updateTime?: string; } /** - * δ-presence metric, used to estimate how likely it is for an attacker to - * figure out that one given individual appears in a de-identified dataset. - * Similarly to the k-map metric, we cannot compute δ-presence exactly without - * knowing the attack dataset, so we use a statistical model instead. + * δ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead. */ export interface Schema$GooglePrivacyDlpV2DeltaPresenceEstimationConfig { /** - * Several auxiliary tables can be used in the analysis. Each custom_tag - * used to tag a quasi-identifiers field must appear in exactly one field of - * one auxiliary table. + * Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table. */ auxiliaryTables?: Schema$GooglePrivacyDlpV2StatisticalTable[]; /** - * Fields considered to be quasi-identifiers. No two fields can have the - * same tag. [required] + * Fields considered to be quasi-identifiers. No two fields can have the same tag. [required] */ quasiIds?: Schema$GooglePrivacyDlpV2QuasiId[]; /** - * ISO 3166-1 alpha-2 region code to use in the statistical modeling. - * Required if no column is tagged with a region-specific InfoType (like - * US_ZIP_5) or a region code. + * ISO 3166-1 alpha-2 region code to use in the statistical modeling. Required if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code. */ regionCode?: string; } /** - * A DeltaPresenceEstimationHistogramBucket message with the following values: - * min_probability: 0.1 max_probability: 0.2 frequency: 42 means that - * there are 42 records for which δ is in [0.1, 0.2). An important particular - * case is when min_probability = max_probability = 1: then, every individual - * who shares this quasi-identifier combination is in the dataset. + * A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. */ export interface Schema$GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket { /** @@ -1137,8 +855,7 @@ export namespace dlp_v2 { */ bucketValueCount?: string; /** - * Sample of quasi-identifier tuple values in this bucket. The total number - * of classes returned per bucket is capped at 20. + * Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20. */ bucketValues?: Schema$GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues[]; /** @@ -1155,14 +872,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues { /** - * The estimated probability that a given individual sharing these - * quasi-identifier values is in the dataset. This value, typically called - * δ, is the ratio between the number of records in the dataset with these - * quasi-identifier values, and the total number of individuals (inside - * *and* outside the dataset) with these quasi-identifier values. For - * example, if there are 15 individuals in the dataset who share the same - * quasi-identifier values, and an estimated 100 people in the entire - * population with these values, then δ is 0.15. + * The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called δ, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside *and* outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then δ is 0.15. */ estimatedProbability?: number; /** @@ -1171,25 +881,16 @@ export namespace dlp_v2 { quasiIdsValues?: Schema$GooglePrivacyDlpV2Value[]; } /** - * Result of the δ-presence computation. Note that these results are an - * estimation, not exact values. + * Result of the δ-presence computation. Note that these results are an estimation, not exact values. */ export interface Schema$GooglePrivacyDlpV2DeltaPresenceEstimationResult { /** - * The intervals [min_probability, max_probability) do not overlap. If a - * value doesn't correspond to any such interval, the associated - * frequency is zero. For example, the following records: {min_probability: - * 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, - * max_probability: 0.3, frequency: 42} {min_probability: 0.3, - * max_probability: 0.4, frequency: 99} mean that there are no record with - * an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. + * The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. */ deltaPresenceEstimationHistogram?: Schema$GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket[]; } /** - * Rule for modifying a CustomInfoType to alter behavior under certain - * circumstances, depending on the specific details of the rule. Not supported - * for the `surrogate_type` custom info type. + * Rule for modifying a CustomInfoType to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom info type. */ export interface Schema$GooglePrivacyDlpV2DetectionRule { /** @@ -1198,32 +899,11 @@ export namespace dlp_v2 { hotwordRule?: Schema$GooglePrivacyDlpV2HotwordRule; } /** - * Custom information type based on a dictionary of words or phrases. This can - * be used to match sensitive information specific to the data, such as a list - * of employee IDs or job titles. Dictionary words are case-insensitive and - * all characters other than letters and digits in the unicode [Basic - * Multilingual - * Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) - * will be replaced with whitespace when scanning for matches, so the - * dictionary phrase "Sam Johnson" will match all three phrases - * "sam johnson", "Sam, Johnson", and "Sam - * (Johnson)". Additionally, the characters surrounding any match must be - * of a different type than the adjacent characters within the word, so - * letters must be next to non-letters and digits next to non-digits. For - * example, the dictionary word "jen" will match the first three - * letters of the text "jen123" but will return no matches for - * "jennifer". Dictionary words containing a large number of - * characters that are not letters or digits may result in unexpected findings - * because such characters are treated as whitespace. The - * [limits](https://cloud.google.com/dlp/limits) page contains details about - * the size limits of dictionaries. For dictionaries that do not fit within - * these constraints, consider using `LargeCustomDictionaryConfig` in the - * `StoredInfoType` API. + * Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. */ export interface Schema$GooglePrivacyDlpV2Dictionary { /** - * Newline-delimited file of words in Cloud Storage. Only a single file is - * accepted. + * Newline-delimited file of words in Cloud Storage. Only a single file is accepted. */ cloudStoragePath?: Schema$GooglePrivacyDlpV2CloudStoragePath; /** @@ -1252,8 +932,7 @@ export namespace dlp_v2 { */ inspectDetails?: Schema$GooglePrivacyDlpV2InspectDataSourceDetails; /** - * If created by a job trigger, the resource name of the trigger that - * instantiated the job. + * If created by a job trigger, the resource name of the trigger that instantiated the job. */ jobTriggerName?: string; /** @@ -1282,17 +961,12 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DocumentLocation { /** - * Offset of the line, from the beginning of the file, where the finding is - * located. + * Offset of the line, from the beginning of the file, where the finding is located. */ fileOffset?: string; } /** - * An entity in a dataset is a field or set of fields that correspond to a - * single person. For example, in medical records the `EntityId` might be a - * patient identifier, or for financial records it might be an account - * identifier. This message is used when generalizations or analysis must take - * into account that multiple rows correspond to the same entity. + * An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the `EntityId` might be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity. */ export interface Schema$GooglePrivacyDlpV2EntityId { /** @@ -1301,8 +975,7 @@ export namespace dlp_v2 { field?: Schema$GooglePrivacyDlpV2FieldId; } /** - * Details information about an error encountered during job execution or the - * results of an unsuccessful activation of the JobTrigger. Output only field. + * Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field. */ export interface Schema$GooglePrivacyDlpV2Error { details?: Schema$GoogleRpcStatus; @@ -1316,20 +989,12 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ExcludeInfoTypes { /** - * InfoType list in ExclusionRule rule drops a finding when it overlaps or - * contained within with a finding of an infoType from this list. For - * example, for `InspectionRuleSet.info_types` containing - * "PHONE_NUMBER"` and `exclusion_rule` containing - * `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone - * number findings are dropped if they overlap with EMAIL_ADDRESS finding. - * That leads to "555-222-2222@example.org" to generate only a - * single finding, namely email address. + * InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; } /** - * The rule that specifies conditions when findings of infoTypes specified in - * `InspectionRuleSet` are removed from results. + * The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. */ export interface Schema$GooglePrivacyDlpV2ExclusionRule { /** @@ -1355,8 +1020,7 @@ export namespace dlp_v2 { export interface Schema$GooglePrivacyDlpV2Expressions { conditions?: Schema$GooglePrivacyDlpV2Conditions; /** - * The operator to apply to the result of conditions. Default and currently - * only supported value is `AND`. + * The operator to apply to the result of conditions. Default and currently only supported value is `AND`. */ logicalOperator?: string; } @@ -1374,12 +1038,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2FieldTransformation { /** - * Only apply the transformation if the condition evaluates to true for the - * given `RecordCondition`. The conditions are allowed to reference fields - * that are not used in the actual transformation. [optional] Example Use - * Cases: - Apply a different bucket transformation to an age column if the - * zip code column for the same record is within a specific range. - Redact - * a field if the date of birth field is greater than 85. + * Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. [optional] Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85. */ condition?: Schema$GooglePrivacyDlpV2RecordCondition; /** @@ -1387,8 +1046,7 @@ export namespace dlp_v2 { */ fields?: Schema$GooglePrivacyDlpV2FieldId[]; /** - * Treat the contents of the field as free text, and selectively transform - * content that matches an `InfoType`. + * Treat the contents of the field as free text, and selectively transform content that matches an `InfoType`. */ infoTypeTransformations?: Schema$GooglePrivacyDlpV2InfoTypeTransformations; /** @@ -1401,19 +1059,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2FileSet { /** - * The regex-filtered set of files to scan. Exactly one of `url` or - * `regex_file_set` must be set. + * The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. */ regexFileSet?: Schema$GooglePrivacyDlpV2CloudStorageRegexFileSet; /** - * The Cloud Storage url of the file(s) to scan, in the format - * `gs://<bucket>/<path>`. Trailing wildcard in the path is - * allowed. If the url ends in a trailing slash, the bucket or directory - * represented by the url will be scanned non-recursively (content in - * sub-directories will not be scanned). This means that `gs://mybucket/` is - * equivalent to `gs://mybucket/x, and `gs://mybucket/directory/` is - * equivalent to `gs://mybucket/directory/x. Exactly one of `url` or - * `regex_file_set` must be set. + * The Cloud Storage url of the file(s) to scan, in the format `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/x, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/x. Exactly one of `url` or `regex_file_set` must be set. */ url?: string; } @@ -1426,8 +1076,7 @@ export namespace dlp_v2 { */ createTime?: string; /** - * The type of content that might have been found. Provided if - * `excluded_types` is false. + * The type of content that might have been found. Provided if `excluded_types` is false. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; /** @@ -1439,16 +1088,11 @@ export namespace dlp_v2 { */ location?: Schema$GooglePrivacyDlpV2Location; /** - * The content that was found. Even if the content is not textual, it may be - * converted to a textual representation here. Provided if `include_quote` - * is true and the finding is less than or equal to 4096 bytes long. If the - * finding exceeds 4096 bytes in length, the quote may be omitted. + * The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if `include_quote` is true and the finding is less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes in length, the quote may be omitted. */ quote?: string; /** - * Contains data parsed from quotes. Only populated if include_quote was set - * to true and a supported infoType was requested. Currently supported - * infoTypes: DATE, DATE_OF_BIRTH and TIME. + * Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME. */ quoteInfo?: Schema$GooglePrivacyDlpV2QuoteInfo; } @@ -1458,58 +1102,33 @@ export namespace dlp_v2 { */ maxFindingsPerInfoType?: Schema$GooglePrivacyDlpV2InfoTypeLimit[]; /** - * Max number of findings that will be returned for each item scanned. When - * set within `InspectDataSourceRequest`, the maximum returned is 2000 - * regardless if this is set higher. When set within - * `InspectContentRequest`, this field is ignored. + * Max number of findings that will be returned for each item scanned. When set within `InspectDataSourceRequest`, the maximum returned is 2000 regardless if this is set higher. When set within `InspectContentRequest`, this field is ignored. */ maxFindingsPerItem?: number; /** - * Max number of findings that will be returned per request/job. When set - * within `InspectContentRequest`, the maximum returned is 2000 regardless - * if this is set higher. + * Max number of findings that will be returned per request/job. When set within `InspectContentRequest`, the maximum returned is 2000 regardless if this is set higher. */ maxFindingsPerRequest?: number; } /** - * Buckets values based on fixed size ranges. The Bucketing transformation can - * provide all of this functionality, but requires more configuration. This - * message is provided as a convenience to the user for simple bucketing - * strategies. The transformed value will be a hyphenated string of - * <lower_bound>-<upper_bound>, i.e if lower_bound = 10 and - * upper_bound = 20 all values that are within this bucket will be replaced - * with "10-20". This can be used on data of type: double, long. If - * the bound Value type differs from the type of data being transformed, we - * will first attempt converting the type of the data to be transformed to - * match the type of the bound before comparing. See - * https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. + * Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of <lower_bound>-<upper_bound>, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. */ export interface Schema$GooglePrivacyDlpV2FixedSizeBucketingConfig { /** - * Size of each bucket (except for minimum and maximum buckets). So if - * `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the - * following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, - * 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required]. + * Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required]. */ bucketSize?: number; /** - * Lower bound value of buckets. All values less than `lower_bound` are - * grouped together into a single bucket; for example if `lower_bound` = 10, - * then all values less than 10 are replaced with the value “-10”. - * [Required]. + * Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value “-10”. [Required]. */ lowerBound?: Schema$GooglePrivacyDlpV2Value; /** - * Upper bound value of buckets. All values greater than upper_bound are - * grouped together into a single bucket; for example if `upper_bound` = 89, - * then all values greater than 89 are replaced with the value “89+”. - * [Required]. + * Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if `upper_bound` = 89, then all values greater than 89 are replaced with the value “89+”. [Required]. */ upperBound?: Schema$GooglePrivacyDlpV2Value; } /** - * The rule that adjusts the likelihood of findings within a certain proximity - * of hotwords. + * The rule that adjusts the likelihood of findings within a certain proximity of hotwords. */ export interface Schema$GooglePrivacyDlpV2HotwordRule { /** @@ -1521,14 +1140,7 @@ export namespace dlp_v2 { */ likelihoodAdjustment?: Schema$GooglePrivacyDlpV2LikelihoodAdjustment; /** - * Proximity of the finding within which the entire hotword must reside. The - * total length of the window cannot exceed 1000 characters. Note that the - * finding itself will be included in the window, so that hotwords may be - * used to match substrings of the finding itself. For example, the - * certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could - * be adjusted upwards if the area code is known to be the local area code - * of a company office using the hotword regex "\(xxx\)", where - * "xxx" is the area code in question. + * Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. */ proximity?: Schema$GooglePrivacyDlpV2Proximity; } @@ -1537,8 +1149,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ImageLocation { /** - * Bounding boxes locating the pixels within the image containing the - * finding. + * Bounding boxes locating the pixels within the image containing the finding. */ boundingBoxes?: Schema$GooglePrivacyDlpV2BoundingBox[]; } @@ -1547,20 +1158,15 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ImageRedactionConfig { /** - * Only one per info_type should be provided per request. If not specified, - * and redact_all_text is false, the DLP API will redact all text that it - * matches against all info_types that are found, but not specified in - * another ImageRedactionConfig. + * Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; /** - * If true, all text found in the image, regardless whether it matches an - * info_type, is redacted. Only one should be provided. + * If true, all text found in the image, regardless whether it matches an info_type, is redacted. Only one should be provided. */ redactAllText?: boolean; /** - * The color to use when redacting content from an image. If not specified, - * the default is black. + * The color to use when redacting content from an image. If not specified, the default is black. */ redactionColor?: Schema$GooglePrivacyDlpV2Color; } @@ -1569,11 +1175,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InfoType { /** - * Name of the information type. Either a name of your choosing when - * creating a CustomInfoType, or one of the names listed at - * https://cloud.google.com/dlp/docs/infotypes-reference when specifying a - * built-in type. InfoType names should conform to the pattern - * [a-zA-Z0-9_]{1,64}. + * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. InfoType names should conform to the pattern [a-zA-Z0-9_]{1,64}. */ name?: string; } @@ -1582,8 +1184,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InfoTypeDescription { /** - * Description of the infotype. Translated when language is provided in the - * request. + * Description of the infotype. Translated when language is provided in the request. */ description?: string; /** @@ -1600,15 +1201,11 @@ export namespace dlp_v2 { supportedBy?: string[]; } /** - * Max findings configuration per infoType, per content item or long running - * DlpJob. + * Max findings configuration per infoType, per content item or long running DlpJob. */ export interface Schema$GooglePrivacyDlpV2InfoTypeLimit { /** - * Type of information the findings limit applies to. Only one limit per - * info_type should be provided. If InfoTypeLimit does not have an - * info_type, the DLP API applies the limit against all info_types that are - * found but not specified in another InfoTypeLimit. + * Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; /** @@ -1630,14 +1227,11 @@ export namespace dlp_v2 { infoType?: Schema$GooglePrivacyDlpV2InfoType; } /** - * A transformation to apply to text that is identified as a specific - * info_type. + * A transformation to apply to text that is identified as a specific info_type. */ export interface Schema$GooglePrivacyDlpV2InfoTypeTransformation { /** - * InfoTypes to apply the transformation to. An empty list will cause this - * transformation to apply to all findings that correspond to infoTypes that - * were requested in `InspectConfig`. + * InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; /** @@ -1646,31 +1240,24 @@ export namespace dlp_v2 { primitiveTransformation?: Schema$GooglePrivacyDlpV2PrimitiveTransformation; } /** - * A type of transformation that will scan unstructured text and apply various - * `PrimitiveTransformation`s to each finding, where the transformation is - * applied to only values that were identified as a specific info_type. + * A type of transformation that will scan unstructured text and apply various `PrimitiveTransformation`s to each finding, where the transformation is applied to only values that were identified as a specific info_type. */ export interface Schema$GooglePrivacyDlpV2InfoTypeTransformations { /** - * Transformation for each infoType. Cannot specify more than one for a - * given infoType. [required] + * Transformation for each infoType. Cannot specify more than one for a given infoType. [required] */ transformations?: Schema$GooglePrivacyDlpV2InfoTypeTransformation[]; } /** - * Configuration description of the scanning process. When used with - * redactContent only info_types and min_likelihood are currently used. + * Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. */ export interface Schema$GooglePrivacyDlpV2InspectConfig { /** - * List of options defining data content to scan. If empty, text, images, - * and other content will be included. + * List of options defining data content to scan. If empty, text, images, and other content will be included. */ contentOptions?: string[]; /** - * CustomInfoTypes provided by the user. See - * https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn - * more. + * CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. */ customInfoTypes?: Schema$GooglePrivacyDlpV2CustomInfoType[]; /** @@ -1678,33 +1265,20 @@ export namespace dlp_v2 { */ excludeInfoTypes?: boolean; /** - * When true, a contextual quote from the data that triggered a finding is - * included in the response; see Finding.quote. + * When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. */ includeQuote?: boolean; /** - * Restricts what info_types to look for. The values must correspond to - * InfoType values returned by ListInfoTypes or listed at - * https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes - * or CustomInfoTypes are specified in a request, the system may - * automatically choose what detectors to run. By default this may be all - * types, but may change over time as detectors are updated. The special - * InfoType name "ALL_BASIC" can be used to trigger all detectors, - * but may change over time as new InfoTypes are added. If you need precise - * control and predictability as to what detectors are run you should - * specify specific InfoTypes listed in the reference. + * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. The special InfoType name "ALL_BASIC" can be used to trigger all detectors, but may change over time as new InfoTypes are added. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; limits?: Schema$GooglePrivacyDlpV2FindingLimits; /** - * Only returns findings equal or above this threshold. The default is - * POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more. + * Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more. */ minLikelihood?: string; /** - * Set of rules to apply to the findings for this InspectConfig. Exclusion - * rules, contained in the set are executed in the end, other rules are - * executed in the order they are specified for each info type. + * Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. */ ruleSet?: Schema$GooglePrivacyDlpV2InspectionRuleSet[]; } @@ -1713,16 +1287,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InspectContentRequest { /** - * Configuration for the inspector. What specified here will override the - * template referenced by the inspect_template_name argument. + * Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument. */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * Optional template to use. Any configuration directly specified in - * inspect_config will override those set in the template. Singular fields - * that are set in this request will replace their corresponding fields in - * the template. Repeated fields are appended. Singular sub-messages and - * groups are recursively merged. + * Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ inspectTemplateName?: string; /** @@ -1753,8 +1322,7 @@ export namespace dlp_v2 { result?: Schema$GooglePrivacyDlpV2Result; } /** - * A single inspection rule to be applied to infoTypes, specified in - * `InspectionRuleSet`. + * A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`. */ export interface Schema$GooglePrivacyDlpV2InspectionRule { /** @@ -1767,9 +1335,7 @@ export namespace dlp_v2 { hotwordRule?: Schema$GooglePrivacyDlpV2HotwordRule; } /** - * Rule set for modifying a set of infoTypes to alter behavior under certain - * circumstances, depending on the specific details of the rules within the - * set. + * Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. */ export interface Schema$GooglePrivacyDlpV2InspectionRuleSet { /** @@ -1783,8 +1349,7 @@ export namespace dlp_v2 { } export interface Schema$GooglePrivacyDlpV2InspectJobConfig { /** - * Actions to execute at the completion of the job. Are executed in the - * order provided. + * Actions to execute at the completion of the job. */ actions?: Schema$GooglePrivacyDlpV2Action[]; /** @@ -1792,9 +1357,7 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * If provided, will be used as the default for all values in InspectConfig. - * `inspect_config` will be merged into the values persisted as part of the - * template. + * If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template. */ inspectTemplateName?: string; /** @@ -1811,20 +1374,12 @@ export namespace dlp_v2 { */ findings?: Schema$GooglePrivacyDlpV2Finding[]; /** - * If true, then this item might have more findings than were returned, and - * the findings returned are an arbitrary subset of all findings. The - * findings list might be truncated because the input items were too large, - * or because the server reached the maximum amount of resources allowed for - * a single API call. For best results, divide the input into smaller - * batches. + * If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches. */ findingsTruncated?: boolean; } /** - * The inspectTemplate contains a configuration (set of types of sensitive - * data to be detected) to be used anywhere you otherwise would normally - * specify InspectConfig. See - * https://cloud.google.com/dlp/docs/concepts-templates to learn more. + * The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more. */ export interface Schema$GooglePrivacyDlpV2InspectTemplate { /** @@ -1844,9 +1399,7 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * The template name. Output only. The template will have one of the - * following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR - * `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID` + * The template name. Output only. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID` */ name?: string; /** @@ -1855,13 +1408,11 @@ export namespace dlp_v2 { updateTime?: string; } /** - * Enable email notification to project owners and editors on jobs's - * completion/failure. + * Enable email notification to project owners and editors on jobs's completion/failure. */ export interface Schema$GooglePrivacyDlpV2JobNotificationEmails {} /** - * Contains a configuration to make dlp api calls on a repeating basis. See - * https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. + * Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. */ export interface Schema$GooglePrivacyDlpV2JobTrigger { /** @@ -1877,10 +1428,7 @@ export namespace dlp_v2 { */ displayName?: string; /** - * A stream of errors encountered when the trigger was activated. Repeated - * errors may result in the JobTrigger automatically being paused. Will - * return the last 100 errors. Whenever the JobTrigger is modified this list - * will be cleared. Output only field. + * A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. Output only field. */ errors?: Schema$GooglePrivacyDlpV2Error[]; inspectJob?: Schema$GooglePrivacyDlpV2InspectJobConfig; @@ -1889,9 +1437,7 @@ export namespace dlp_v2 { */ lastRunTime?: string; /** - * Unique resource name for the triggeredJob, assigned by the service when - * the triggeredJob is created, for example - * `projects/dlp-test-project/triggeredJobs/53234423`. + * Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/triggeredJobs/53234423`. */ name?: string; /** @@ -1899,9 +1445,7 @@ export namespace dlp_v2 { */ status?: string; /** - * A list of triggers which will be OR'ed together. Only one in the list - * needs to trigger for a job to be started. The list may contain only a - * single Schedule trigger and must have at least one object. + * A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. */ triggers?: Schema$GooglePrivacyDlpV2Trigger[]; /** @@ -1914,22 +1458,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2KAnonymityConfig { /** - * Optional message indicating that multiple rows might be associated to a - * single individual. If the same entity_id is associated to multiple - * quasi-identifier tuples over distinct rows, we consider the entire - * collection of tuples as the composite quasi-identifier. This collection - * is a multiset: the order in which the different tuples appear in the - * dataset is ignored, but their frequency is taken into account. Important - * note: a maximum of 1000 rows can be associated to a single entity ID. If - * more rows are associated with the same entity ID, some might be ignored. + * Optional message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored. */ entityId?: Schema$GooglePrivacyDlpV2EntityId; /** - * Set of fields to compute k-anonymity over. When multiple fields are - * specified, they are considered a single composite key. Structs and - * repeated data types are not supported; however, nested fields are - * supported so long as they are not structs themselves or nested within a - * repeated field. + * Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field. */ quasiIds?: Schema$GooglePrivacyDlpV2FieldId[]; } @@ -1938,14 +1471,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2KAnonymityEquivalenceClass { /** - * Size of the equivalence class, for example number of rows with the above - * set of values. + * Size of the equivalence class, for example number of rows with the above set of values. */ equivalenceClassSize?: string; /** - * Set of values defining the equivalence class. One value per - * quasi-identifier column in the original KAnonymity metric message. The - * order is always the same as the original request. + * Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request. */ quasiIdsValues?: Schema$GooglePrivacyDlpV2Value[]; } @@ -1959,8 +1489,7 @@ export namespace dlp_v2 { */ bucketValueCount?: string; /** - * Sample of equivalence classes in this bucket. The total number of classes - * returned per bucket is capped at 20. + * Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20. */ bucketValues?: Schema$GooglePrivacyDlpV2KAnonymityEquivalenceClass[]; /** @@ -1982,25 +1511,15 @@ export namespace dlp_v2 { equivalenceClassHistogramBuckets?: Schema$GooglePrivacyDlpV2KAnonymityHistogramBucket[]; } /** - * A unique identifier for a Datastore entity. If a key's partition ID or - * any of its path kinds or names are reserved/read-only, the key is - * reserved/read-only. A reserved/read-only key is forbidden in certain - * documented contexts. + * A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. */ export interface Schema$GooglePrivacyDlpV2Key { /** - * Entities are partitioned into subsets, currently identified by a project - * ID and namespace ID. Queries are scoped to a single partition. + * Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. */ partitionId?: Schema$GooglePrivacyDlpV2PartitionId; /** - * The entity path. An entity path consists of one or more elements composed - * of a kind and a string or numerical identifier, which identify entities. - * The first element identifies a _root entity_, the second element - * identifies a _child_ of the root entity, the third element identifies a - * child of the second entity, and so forth. The entities identified by all - * prefixes of the path are called the element's _ancestors_. A path - * can never be empty, and a path can have at most 100 elements. + * The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. A path can never be empty, and a path can have at most 100 elements. */ path?: Schema$GooglePrivacyDlpV2PathElement[]; } @@ -2014,40 +1533,24 @@ export namespace dlp_v2 { name?: string; } /** - * Reidentifiability metric. This corresponds to a risk model similar to what - * is called "journalist risk" in the literature, except the attack - * dataset is statistically modeled instead of being perfectly known. This can - * be done using publicly available data (like the US Census), or using a - * custom statistical model (indicated as one or several BigQuery tables), or - * by extrapolating from the distribution of values in the input dataset. A - * column with a semantic tag attached. + * Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset. A column with a semantic tag attached. */ export interface Schema$GooglePrivacyDlpV2KMapEstimationConfig { /** - * Several auxiliary tables can be used in the analysis. Each custom_tag - * used to tag a quasi-identifiers column must appear in exactly one column - * of one auxiliary table. + * Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table. */ auxiliaryTables?: Schema$GooglePrivacyDlpV2AuxiliaryTable[]; /** - * Fields considered to be quasi-identifiers. No two columns can have the - * same tag. [required] + * Fields considered to be quasi-identifiers. No two columns can have the same tag. [required] */ quasiIds?: Schema$GooglePrivacyDlpV2TaggedField[]; /** - * ISO 3166-1 alpha-2 region code to use in the statistical modeling. - * Required if no column is tagged with a region-specific InfoType (like - * US_ZIP_5) or a region code. + * ISO 3166-1 alpha-2 region code to use in the statistical modeling. Required if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code. */ regionCode?: string; } /** - * A KMapEstimationHistogramBucket message with the following values: - * min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 - * records whose quasi-identifier values correspond to 3, 4 or 5 people in the - * overlying population. An important particular case is when min_anonymity = - * max_anonymity = 1: the frequency field then corresponds to the number of - * uniquely identifiable records. + * A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. */ export interface Schema$GooglePrivacyDlpV2KMapEstimationHistogramBucket { /** @@ -2059,8 +1562,7 @@ export namespace dlp_v2 { */ bucketValueCount?: string; /** - * Sample of quasi-identifier tuple values in this bucket. The total number - * of classes returned per bucket is capped at 20. + * Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20. */ bucketValues?: Schema$GooglePrivacyDlpV2KMapEstimationQuasiIdValues[]; /** @@ -2086,26 +1588,16 @@ export namespace dlp_v2 { quasiIdsValues?: Schema$GooglePrivacyDlpV2Value[]; } /** - * Result of the reidentifiability analysis. Note that these results are an - * estimation, not exact values. + * Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. */ export interface Schema$GooglePrivacyDlpV2KMapEstimationResult { /** - * The intervals [min_anonymity, max_anonymity] do not overlap. If a value - * doesn't correspond to any such interval, the associated frequency is - * zero. For example, the following records: {min_anonymity: 1, - * max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, - * frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} - * mean that there are no record with an estimated anonymity of 4, 5, or - * larger than 10. + * The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. */ kMapEstimationHistogram?: Schema$GooglePrivacyDlpV2KMapEstimationHistogramBucket[]; } /** - * Include to use an existing data crypto key wrapped by KMS. The wrapped key - * must be a 128/192/256 bit key. Authorization requires the following IAM - * permissions when sending a request to perform a crypto transformation using - * a kms-wrapped crypto key: dlp.kms.encrypt + * Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128/192/256 bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a kms-wrapped crypto key: dlp.kms.encrypt */ export interface Schema$GooglePrivacyDlpV2KmsWrappedCryptoKey { /** @@ -2118,12 +1610,7 @@ export namespace dlp_v2 { wrappedKey?: string; } /** - * Configuration for a custom dictionary created from a data source of any - * size up to the maximum size defined in the - * [limits](https://cloud.google.com/dlp/limits) page. The artifacts of - * dictionary creation are stored in the specified Google Cloud Storage - * location. Consider using `CustomInfoType.Dictionary` for smaller - * dictionaries that satisfy the size requirements. + * Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. */ export interface Schema$GooglePrivacyDlpV2LargeCustomDictionaryConfig { /** @@ -2135,10 +1622,7 @@ export namespace dlp_v2 { */ cloudStorageFileSet?: Schema$GooglePrivacyDlpV2CloudStorageFileSet; /** - * Location to store dictionary artifacts in Google Cloud Storage. These - * files will only be accessible by project owners and the DLP API. If any - * of these artifacts are modified, the dictionary is considered invalid and - * can no longer be used. + * Location to store dictionary artifacts in Google Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used. */ outputPath?: Schema$GooglePrivacyDlpV2CloudStoragePath; } @@ -2147,9 +1631,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2LDiversityConfig { /** - * Set of quasi-identifiers indicating how equivalence classes are defined - * for the l-diversity computation. When multiple fields are specified, they - * are considered a single composite key. + * Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key. */ quasiIds?: Schema$GooglePrivacyDlpV2FieldId[]; /** @@ -2170,8 +1652,7 @@ export namespace dlp_v2 { */ numDistinctSensitiveValues?: string; /** - * Quasi-identifier values defining the k-anonymity equivalence class. The - * order is always the same as the original request. + * Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request. */ quasiIdsValues?: Schema$GooglePrivacyDlpV2Value[]; /** @@ -2189,18 +1670,15 @@ export namespace dlp_v2 { */ bucketValueCount?: string; /** - * Sample of equivalence classes in this bucket. The total number of classes - * returned per bucket is capped at 20. + * Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20. */ bucketValues?: Schema$GooglePrivacyDlpV2LDiversityEquivalenceClass[]; /** - * Lower bound on the sensitive value frequencies of the equivalence classes - * in this bucket. + * Lower bound on the sensitive value frequencies of the equivalence classes in this bucket. */ sensitiveValueFrequencyLowerBound?: string; /** - * Upper bound on the sensitive value frequencies of the equivalence classes - * in this bucket. + * Upper bound on the sensitive value frequencies of the equivalence classes in this bucket. */ sensitiveValueFrequencyUpperBound?: string; } @@ -2214,8 +1692,7 @@ export namespace dlp_v2 { sensitiveValueFrequencyHistogramBuckets?: Schema$GooglePrivacyDlpV2LDiversityHistogramBucket[]; } /** - * Message for specifying an adjustment to the likelihood of a finding as part - * of a detection rule. + * Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. */ export interface Schema$GooglePrivacyDlpV2LikelihoodAdjustment { /** @@ -2223,13 +1700,7 @@ export namespace dlp_v2 { */ fixedLikelihood?: string; /** - * Increase or decrease the likelihood by the specified number of levels. - * For example, if a finding would be `POSSIBLE` without the detection rule - * and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a - * value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop - * below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment - * of 1 followed by an adjustment of -1 when base likelihood is - * `VERY_LIKELY` will result in a final likelihood of `LIKELY`. + * Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. */ relativeLikelihood?: number; } @@ -2238,13 +1709,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ListDeidentifyTemplatesResponse { /** - * List of deidentify templates, up to page_size in - * ListDeidentifyTemplatesRequest. + * List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest. */ deidentifyTemplates?: Schema$GooglePrivacyDlpV2DeidentifyTemplate[]; /** - * If the next page is available then the next page token to be used in - * following ListDeidentifyTemplates request. + * If the next page is available then the next page token to be used in following ListDeidentifyTemplates request. */ nextPageToken?: string; } @@ -2279,8 +1748,7 @@ export namespace dlp_v2 { */ inspectTemplates?: Schema$GooglePrivacyDlpV2InspectTemplate[]; /** - * If the next page is available then the next page token to be used in - * following ListInspectTemplates request. + * If the next page is available then the next page token to be used in following ListInspectTemplates request. */ nextPageToken?: string; } @@ -2293,8 +1761,7 @@ export namespace dlp_v2 { */ jobTriggers?: Schema$GooglePrivacyDlpV2JobTrigger[]; /** - * If the next page is available then the next page token to be used in - * following ListJobTriggers request. + * If the next page is available then the next page token to be used in following ListJobTriggers request. */ nextPageToken?: string; } @@ -2303,8 +1770,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ListStoredInfoTypesResponse { /** - * If the next page is available then the next page token to be used in - * following ListStoredInfoTypes request. + * If the next page is available then the next page token to be used in following ListStoredInfoTypes request. */ nextPageToken?: string; /** @@ -2317,31 +1783,24 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Location { /** - * Zero-based byte offsets delimiting the finding. These are relative to the - * finding's containing element. Note that when the content is not - * textual, this references the UTF-8 encoded textual representation of the - * content. Omitted if content is an image. + * Zero-based byte offsets delimiting the finding. These are relative to the finding's containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Omitted if content is an image. */ byteRange?: Schema$GooglePrivacyDlpV2Range; /** - * Unicode character offsets delimiting the finding. These are relative to - * the finding's containing element. Provided when the content is text. + * Unicode character offsets delimiting the finding. These are relative to the finding's containing element. Provided when the content is text. */ codepointRange?: Schema$GooglePrivacyDlpV2Range; /** - * List of nested objects pointing to the precise location of the finding - * within the file or record. + * List of nested objects pointing to the precise location of the finding within the file or record. */ contentLocations?: Schema$GooglePrivacyDlpV2ContentLocation[]; } /** - * Compute numerical stats over an individual column, including min, max, and - * quantiles. + * Compute numerical stats over an individual column, including min, max, and quantiles. */ export interface Schema$GooglePrivacyDlpV2NumericalStatsConfig { /** - * Field to compute numerical stats on. Supported types are integer, float, - * date, datetime, timestamp, time. + * Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time. */ field?: Schema$GooglePrivacyDlpV2FieldId; } @@ -2358,8 +1817,7 @@ export namespace dlp_v2 { */ minValue?: Schema$GooglePrivacyDlpV2Value; /** - * List of 99 values that partition the set of field values into 100 equal - * sized buckets. + * List of 99 values that partition the set of field values into 100 equal sized buckets. */ quantileValues?: Schema$GooglePrivacyDlpV2Value[]; } @@ -2368,36 +1826,16 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2OutputStorageConfig { /** - * Schema used for writing the findings for Inspect jobs. This field is only - * used for Inspect and must be unspecified for Risk jobs. Columns are - * derived from the `Finding` object. If appending to an existing table, any - * columns from the predefined schema that are missing will be added. No - * columns in the existing table will be deleted. If unspecified, then all - * available columns will be used for a new table or an (existing) table - * with no schema, and no changes will be made to an existing table that has - * a schema. + * Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. */ outputSchema?: string; /** - * Store findings in an existing table or a new table in an existing - * dataset. If table_id is not set a new one will be generated for you with - * the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific - * timezone will be used for generating the date details. For Inspect, each - * column in an existing output table must have the same name, type, and - * mode of a field in the `Finding` object. For Risk, an existing output - * table should be the output of a previous Risk analysis job run on the - * same source table, with the same privacy metric and quasi-identifiers. - * Risk jobs that analyze the same table but compute a different privacy - * metric, or use different sets of quasi-identifiers, cannot store their - * results in the same table. + * Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. */ table?: Schema$GooglePrivacyDlpV2BigQueryTable; } /** - * Datastore partition ID. A partition ID identifies a grouping of entities. - * The grouping is always by project and namespace, however the namespace ID - * may be empty. A partition ID contains several dimensions: project ID and - * namespace ID. + * Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. */ export interface Schema$GooglePrivacyDlpV2PartitionId { /** @@ -2410,26 +1848,19 @@ export namespace dlp_v2 { projectId?: string; } /** - * A (kind, ID/name) pair used to construct a key path. If either name or ID - * is set, the element is complete. If neither is set, the element is - * incomplete. + * A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. */ export interface Schema$GooglePrivacyDlpV2PathElement { /** - * The auto-allocated ID of the entity. Never equal to zero. Values less - * than zero are discouraged and may not be supported in the future. + * The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. */ id?: string; /** - * The kind of the entity. A kind matching regex `__.*__` is - * reserved/read-only. A kind must not contain more than 1500 bytes when - * UTF-8 encoded. Cannot be `""`. + * The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ kind?: string; /** - * The name of the entity. A name matching regex `__.*__` is - * reserved/read-only. A name must not be more than 1500 bytes when UTF-8 - * encoded. Cannot be `""`. + * The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. */ name?: string; } @@ -2474,26 +1905,15 @@ export namespace dlp_v2 { windowBefore?: number; } /** - * Publish the result summary of a DlpJob to the Cloud Security Command Center - * (CSCC Alpha). This action is only available for projects which are parts of - * an organization and whitelisted for the alpha Cloud Security Command - * Center. The action will publish count of finding instances and their info - * types. The summary of findings will be persisted in CSCC and are governed - * by CSCC service-specific policy, see - * https://cloud.google.com/terms/service-terms Only a single instance of this - * action can be specified. Compatible with: Inspect + * Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect */ export interface Schema$GooglePrivacyDlpV2PublishSummaryToCscc {} /** - * Publish the results of a DlpJob to a pub sub channel. Compatible with: - * Inspect, Risk + * Publish the results of a DlpJob to a pub sub channel. Compatible with: Inspect, Risk */ export interface Schema$GooglePrivacyDlpV2PublishToPubSub { /** - * Cloud Pub/Sub topic to send notifications to. The topic must have given - * publishing access rights to the DLP API service account executing the - * long running DlpJob sending the notifications. Format is - * projects/{project}/topics/{topic}. + * Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. */ topic?: string; } @@ -2502,9 +1922,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2QuasiId { /** - * A column can be tagged with a custom tag. In this case, the user must - * indicate an auxiliary table that contains statistical information on the - * possible values of this column (below). + * A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below). */ customTag?: string; /** @@ -2512,30 +1930,23 @@ export namespace dlp_v2 { */ field?: Schema$GooglePrivacyDlpV2FieldId; /** - * If no semantic tag is indicated, we infer the statistical model from the - * distribution of values in the input data + * If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data */ inferred?: Schema$GoogleProtobufEmpty; /** - * A column can be tagged with a InfoType to use the relevant public dataset - * as a statistical model of population, if available. We currently support - * US ZIP codes, region codes, ages and genders. To programmatically obtain - * the list of supported InfoTypes, use ListInfoTypes with the - * supported_by=RISK_ANALYSIS filter. + * A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; } /** - * A quasi-identifier column has a custom_tag, used to know which column in - * the data corresponds to which column in the statistical model. + * A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model. */ export interface Schema$GooglePrivacyDlpV2QuasiIdentifierField { customTag?: string; field?: Schema$GooglePrivacyDlpV2FieldId; } /** - * A quasi-identifier column has a custom_tag, used to know which column in - * the data corresponds to which column in the statistical model. + * A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model. */ export interface Schema$GooglePrivacyDlpV2QuasiIdField { customTag?: string; @@ -2564,8 +1975,7 @@ export namespace dlp_v2 { start?: string; } /** - * A condition for determining whether a transformation should be applied to a - * field. + * A condition for determining whether a transformation should be applied to a field. */ export interface Schema$GooglePrivacyDlpV2RecordCondition { /** @@ -2580,8 +1990,7 @@ export namespace dlp_v2 { bigQueryKey?: Schema$GooglePrivacyDlpV2BigQueryKey; datastoreKey?: Schema$GooglePrivacyDlpV2DatastoreKey; /** - * Values of identifying columns in the given row. Order of values matches - * the order of field identifiers specified in the scanning request. + * Values of identifying columns in the given row. Order of values matches the order of field identifiers specified in the scanning request. */ idValues?: string[]; } @@ -2603,19 +2012,16 @@ export namespace dlp_v2 { tableLocation?: Schema$GooglePrivacyDlpV2TableLocation; } /** - * Configuration to suppress records whose suppression conditions evaluate to - * true. + * Configuration to suppress records whose suppression conditions evaluate to true. */ export interface Schema$GooglePrivacyDlpV2RecordSuppression { /** - * A condition that when it evaluates to true will result in the record - * being evaluated to be suppressed from the transformed content. + * A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content. */ condition?: Schema$GooglePrivacyDlpV2RecordCondition; } /** - * A type of transformation that is applied over structured data such as a - * table. + * A type of transformation that is applied over structured data such as a table. */ export interface Schema$GooglePrivacyDlpV2RecordTransformations { /** @@ -2623,20 +2029,16 @@ export namespace dlp_v2 { */ fieldTransformations?: Schema$GooglePrivacyDlpV2FieldTransformation[]; /** - * Configuration defining which records get suppressed entirely. Records - * that match any suppression rule are omitted from the output [optional]. + * Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output [optional]. */ recordSuppressions?: Schema$GooglePrivacyDlpV2RecordSuppression[]; } /** - * Redact a given value. For example, if used with an `InfoTypeTransformation` - * transforming PHONE_NUMBER, and input 'My phone number is - * 206-555-0123', the output would be 'My phone number is '. + * Redact a given value. For example, if used with an `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '. */ export interface Schema$GooglePrivacyDlpV2RedactConfig {} /** - * Request to search for potentially sensitive info in an image and redact it - * by covering it with a colored rectangle. + * Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle. */ export interface Schema$GooglePrivacyDlpV2RedactImageRequest { /** @@ -2648,8 +2050,7 @@ export namespace dlp_v2 { */ imageRedactionConfigs?: Schema$GooglePrivacyDlpV2ImageRedactionConfig[]; /** - * Whether the response should include findings along with the redacted - * image. + * Whether the response should include findings along with the redacted image. */ includeFindings?: boolean; /** @@ -2662,9 +2063,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2RedactImageResponse { /** - * If an image was being inspected and the InspectConfig's include_quote - * was set to true, then this field will include all text, if any, that was - * found in the image. + * If an image was being inspected and the InspectConfig's include_quote was set to true, then this field will include all text, if any, that was found in the image. */ extractedText?: string; /** @@ -2681,14 +2080,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Regex { /** - * The index of the submatch to extract as findings. When not specified, the - * entire match is returned. No more than 3 may be included. + * The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. */ groupIndexes?: number[]; /** - * Pattern defining the regular expression. Its syntax - * (https://github.com/google/re2/wiki/Syntax) can be found under the - * google/re2 repository on GitHub. + * Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. */ pattern?: string; } @@ -2701,11 +2097,7 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * Optional template to use. Any configuration directly specified in - * `inspect_config` will override those set in the template. Singular fields - * that are set in this request will replace their corresponding fields in - * the template. Repeated fields are appended. Singular sub-messages and - * groups are recursively merged. + * Optional template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ inspectTemplateName?: string; /** @@ -2713,22 +2105,11 @@ export namespace dlp_v2 { */ item?: Schema$GooglePrivacyDlpV2ContentItem; /** - * Configuration for the re-identification of the content item. This field - * shares the same proto message type that is used for de-identification, - * however its usage here is for the reversal of the previous - * de-identification. Re-identification is performed by examining the - * transformations used to de-identify the items and executing the reverse. - * This requires that only reversible transformations be provided here. The - * reversible transformations are: - `CryptoReplaceFfxFpeConfig` + * Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoReplaceFfxFpeConfig` */ reidentifyConfig?: Schema$GooglePrivacyDlpV2DeidentifyConfig; /** - * Optional template to use. References an instance of `DeidentifyTemplate`. - * Any configuration directly specified in `reidentify_config` or - * `inspect_config` will override those set in the template. Singular fields - * that are set in this request will replace their corresponding fields in - * the template. Repeated fields are appended. Singular sub-messages and - * groups are recursively merged. + * Optional template to use. References an instance of `DeidentifyTemplate`. Any configuration directly specified in `reidentify_config` or `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ reidentifyTemplateName?: string; } @@ -2761,8 +2142,7 @@ export namespace dlp_v2 { export interface Schema$GooglePrivacyDlpV2RequestedOptions { jobConfig?: Schema$GooglePrivacyDlpV2InspectJobConfig; /** - * If run with an InspectTemplate, a snapshot of its state at the time of - * this run. + * If run with an InspectTemplate, a snapshot of its state at the time of this run. */ snapshotInspectTemplate?: Schema$GooglePrivacyDlpV2InspectTemplate; } @@ -2771,8 +2151,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Result { /** - * Statistics of how many instances of each info type were found during - * inspect job. + * Statistics of how many instances of each info type were found during inspect job. */ infoTypeStats?: Schema$GooglePrivacyDlpV2InfoTypeStats[]; /** @@ -2785,13 +2164,11 @@ export namespace dlp_v2 { totalEstimatedBytes?: string; } /** - * Configuration for a risk analysis job. See - * https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more. + * Configuration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more. */ export interface Schema$GooglePrivacyDlpV2RiskAnalysisJobConfig { /** - * Actions to execute at the completion of the job. Are executed in the - * order provided. + * Actions to execute at the completion of the job. Are executed in the order provided. */ actions?: Schema$GooglePrivacyDlpV2Action[]; /** @@ -2807,9 +2184,7 @@ export namespace dlp_v2 { values?: Schema$GooglePrivacyDlpV2Value[]; } /** - * If set, the detailed findings will be persisted to the specified - * OutputStorageConfig. Only a single instance of this action can be - * specified. Compatible with: Inspect, Risk + * If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk */ export interface Schema$GooglePrivacyDlpV2SaveFindings { outputConfig?: Schema$GooglePrivacyDlpV2OutputStorageConfig; @@ -2819,21 +2194,12 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Schedule { /** - * With this option a job is started a regular periodic basis. For example: - * every day (86400 seconds). A scheduled start time will be skipped if the - * previous execution has not ended when its scheduled time occurs. This - * value must be set to a time duration greater than or equal to 1 day and - * can be no longer than 60 days. + * With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days. */ recurrencePeriodDuration?: string; } /** - * An auxiliary table containing statistical information on the relative - * frequency of different quasi-identifiers values. It has one or several - * quasi-identifiers columns, and one column that indicates the relative - * frequency of each quasi-identifier tuple. If a tuple is present in the data - * but not in the auxiliary table, the corresponding relative frequency is - * assumed to be zero (and thus, the tuple is highly reidentifiable). + * An auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable). */ export interface Schema$GooglePrivacyDlpV2StatisticalTable { /** @@ -2841,9 +2207,7 @@ export namespace dlp_v2 { */ quasiIds?: Schema$GooglePrivacyDlpV2QuasiIdentifierField[]; /** - * The relative frequency column must contain a floating-point number - * between 0 and 1 (inclusive). Null values are assumed to be zero. - * [required] + * The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required] */ relativeFrequency?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -2870,8 +2234,7 @@ export namespace dlp_v2 { timespanConfig?: Schema$GooglePrivacyDlpV2TimespanConfig; } /** - * StoredInfoType resource message that contains information about the current - * version and any pending updates. + * StoredInfoType resource message that contains information about the current version and any pending updates. */ export interface Schema$GooglePrivacyDlpV2StoredInfoType { /** @@ -2883,8 +2246,7 @@ export namespace dlp_v2 { */ name?: string; /** - * Pending versions of the stored info type. Empty if no versions are - * pending. + * Pending versions of the stored info type. Empty if no versions are pending. */ pendingVersions?: Schema$GooglePrivacyDlpV2StoredInfoTypeVersion[]; } @@ -2906,8 +2268,7 @@ export namespace dlp_v2 { largeCustomDictionary?: Schema$GooglePrivacyDlpV2LargeCustomDictionaryConfig; } /** - * Version of a StoredInfoType, including the configuration used to build it, - * create timestamp, and current state. + * Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. */ export interface Schema$GooglePrivacyDlpV2StoredInfoTypeVersion { /** @@ -2915,27 +2276,15 @@ export namespace dlp_v2 { */ config?: Schema$GooglePrivacyDlpV2StoredInfoTypeConfig; /** - * Create timestamp of the version. Read-only, determined by the system when - * the version is created. + * Create timestamp of the version. Read-only, determined by the system when the version is created. */ createTime?: string; /** - * Errors that occurred when creating this storedInfoType version, or - * anomalies detected in the storedInfoType data that render it unusable. - * Only the five most recent errors will be displayed, with the most recent - * error appearing first. <p>For example, some of the data for stored - * custom dictionaries is put in the user's Google Cloud Storage bucket, - * and if this data is modified or deleted by the user or another system, - * the dictionary becomes invalid. <p>If any errors occur, fix the - * problem indicated by the error message and use the UpdateStoredInfoType - * API method to create another version of the storedInfoType to continue - * using it, reusing the same `config` if it was not the source of the - * error. + * Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. <p>For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. <p>If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same `config` if it was not the source of the error. */ errors?: Schema$GooglePrivacyDlpV2Error[]; /** - * Stored info type version state. Read-only, updated by the system during - * dictionary creation. + * Stored info type version state. Read-only, updated by the system during dictionary creation. */ state?: string; } @@ -2944,44 +2293,31 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2StoredType { /** - * Timestamp indicating when the version of the `StoredInfoType` used for - * inspection was created. Output-only field, populated by the system. + * Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. */ createTime?: string; /** - * Resource name of the requested `StoredInfoType`, for example - * `organizations/433245324/storedInfoTypes/432452342` or - * `projects/project-id/storedInfoTypes/432452342`. + * Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. */ name?: string; } /** - * A collection that informs the user the number of times a particular - * `TransformationResultCode` and error details occurred. + * A collection that informs the user the number of times a particular `TransformationResultCode` and error details occurred. */ export interface Schema$GooglePrivacyDlpV2SummaryResult { code?: string; count?: string; /** - * A place for warnings or errors to show up if a transformation didn't - * work as expected. + * A place for warnings or errors to show up if a transformation didn't work as expected. */ details?: string; } /** - * Message for detecting output from deidentification transformations such as - * [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). - * These types of transformations are those that perform pseudonymization, - * thereby producing a "surrogate" as output. This should be used in - * conjunction with a field on the transformation such as - * `surrogate_info_type`. This CustomInfoType does not support the use of - * `detection_rules`. + * Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. */ export interface Schema$GooglePrivacyDlpV2SurrogateType {} /** - * Structured content to inspect. Up to 50,000 `Value`s per request allowed. - * See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to - * learn more. + * Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. */ export interface Schema$GooglePrivacyDlpV2Table { headers?: Schema$GooglePrivacyDlpV2FieldId[]; @@ -2998,9 +2334,7 @@ export namespace dlp_v2 { } export interface Schema$GooglePrivacyDlpV2TaggedField { /** - * A column can be tagged with a custom tag. In this case, the user must - * indicate an auxiliary table that contains statistical information on the - * possible values of this column (below). + * A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below). */ customTag?: string; /** @@ -3008,41 +2342,30 @@ export namespace dlp_v2 { */ field?: Schema$GooglePrivacyDlpV2FieldId; /** - * If no semantic tag is indicated, we infer the statistical model from the - * distribution of values in the input data + * If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data */ inferred?: Schema$GoogleProtobufEmpty; /** - * A column can be tagged with a InfoType to use the relevant public dataset - * as a statistical model of population, if available. We currently support - * US ZIP codes, region codes, ages and genders. To programmatically obtain - * the list of supported InfoTypes, use ListInfoTypes with the - * supported_by=RISK_ANALYSIS filter. + * A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; } /** - * For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a - * portion of the value. + * For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a portion of the value. */ export interface Schema$GooglePrivacyDlpV2TimePartConfig { partToExtract?: string; } /** - * Configuration of the timespan of the items to include in scanning. - * Currently only supported when inspecting Google Cloud Storage and BigQuery. + * Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Google Cloud Storage and BigQuery. */ export interface Schema$GooglePrivacyDlpV2TimespanConfig { /** - * When the job is started by a JobTrigger we will automatically figure out - * a valid start_time to avoid scanning files that have not been modified - * since the last time the JobTrigger executed. This will be based on the - * time of the execution of the last run of the JobTrigger. + * When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger. */ enableAutoPopulationOfTimespanConfig?: boolean; /** - * Exclude files or rows newer than this value. If set to zero, no upper - * time limit is applied. + * Exclude files or rows newer than this value. If set to zero, no upper time limit is applied. */ endTime?: string; /** @@ -3050,20 +2373,13 @@ export namespace dlp_v2 { */ startTime?: string; /** - * Specification of the field containing the timestamp of scanned items. - * Used for data sources like Datastore or BigQuery. If not specified for - * BigQuery, table last modification timestamp is checked against given time - * span. The valid data types of the timestamp field are: for BigQuery - - * timestamp, date, datetime; for Datastore - timestamp. Datastore entity - * will be scanned if the timestamp property does not exist or its value is - * empty or invalid. + * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore or BigQuery. If not specified for BigQuery, table last modification timestamp is checked against given time span. The valid data types of the timestamp field are: for BigQuery - timestamp, date, datetime; for Datastore - timestamp. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid. */ timestampField?: Schema$GooglePrivacyDlpV2FieldId; } export interface Schema$GooglePrivacyDlpV2TimeZone { /** - * Set only if the offset can be determined. Positive for time ahead of UTC. - * E.g. For "UTC-9", this value is -540. + * Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For "UTC-9", this value is -540. */ offsetMinutes?: number; } @@ -3081,8 +2397,7 @@ export namespace dlp_v2 { transformedBytes?: string; } /** - * Summary of a single transformation. Only one of 'transformation', - * 'field_transformation', or 'record_suppress' will be set. + * Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set. */ export interface Schema$GooglePrivacyDlpV2TransformationSummary { /** @@ -3090,9 +2405,7 @@ export namespace dlp_v2 { */ field?: Schema$GooglePrivacyDlpV2FieldId; /** - * The field transformation that was applied. If multiple field - * transformations are requested for a single field, this list will contain - * all of them; otherwise, only one is supplied. + * The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied. */ fieldTransformations?: Schema$GooglePrivacyDlpV2FieldTransformation[]; /** @@ -3114,17 +2427,11 @@ export namespace dlp_v2 { transformedBytes?: string; } /** - * Use this to have a random data crypto key generated. It will be discarded - * after the request finishes. + * Use this to have a random data crypto key generated. It will be discarded after the request finishes. */ export interface Schema$GooglePrivacyDlpV2TransientCryptoKey { /** - * Name of the key. [required] This is an arbitrary string used to - * differentiate different keys. A unique key is generated per name: two - * separate `TransientCryptoKey` protos share the same generated key if - * their names are the same. When the data crypto key is generated, this - * name is not used in any way (repeating the api call will result in a - * different key being generated). + * Name of the key. [required] This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate `TransientCryptoKey` protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated). */ name?: string; } @@ -3138,8 +2445,7 @@ export namespace dlp_v2 { schedule?: Schema$GooglePrivacyDlpV2Schedule; } /** - * Using raw keys is prone to security risks due to accidentally leaking the - * key. Choose another type of key if possible. + * Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible. */ export interface Schema$GooglePrivacyDlpV2UnwrappedCryptoKey { /** @@ -3191,9 +2497,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2UpdateStoredInfoTypeRequest { /** - * Updated configuration for the storedInfoType. If not provided, a new - * version of the storedInfoType will be created with the existing - * configuration. + * Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. */ config?: Schema$GooglePrivacyDlpV2StoredInfoTypeConfig; /** @@ -3202,12 +2506,7 @@ export namespace dlp_v2 { updateMask?: string; } /** - * Set of primitive values supported by the system. Note that for the purposes - * of inspection or transformation, the number of bytes considered to comprise - * a 'Value' is based on its representation as a UTF-8 encoded string. - * For example, if 'integer_value' is set to 123456789, the number of - * bytes would be counted as 9, even though an int64 only holds up to 8 bytes - * of data. + * Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. */ export interface Schema$GooglePrivacyDlpV2Value { booleanValue?: boolean; @@ -3237,55 +2536,16 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2WordList { /** - * Words or phrases defining the dictionary. The dictionary must contain at - * least one phrase and every phrase must contain at least 2 characters that - * are letters or digits. [required] + * Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] */ words?: string[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobufEmpty {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpcStatus { /** @@ -3293,55 +2553,37 @@ export namespace dlp_v2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$GoogleTypeDate { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } /** - * Represents a time of day. The date and time zone are either not significant - * or are specified elsewhere. An API may choose to allow leap seconds. - * Related types are google.type.Date and `google.protobuf.Timestamp`. + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ export interface Schema$GoogleTypeTimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - * to allow the value "24:00:00" for scenarios like business - * closing time. + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number; /** @@ -3353,8 +2595,7 @@ export namespace dlp_v2 { */ nanos?: number; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may - * allow the value 60 if it allows leap-seconds. + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number; } @@ -3367,9 +2608,7 @@ export namespace dlp_v2 { /** * dlp.infoTypes.list - * @desc Returns a list of the sensitive information types that the DLP API - * supports. See https://cloud.google.com/dlp/docs/infotypes-reference to - * learn more. + * @desc Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more. * @alias dlp.infoTypes.list * @memberOf! () * @@ -3463,14 +2702,11 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional filter to only return infoTypes supported by certain parts of - * the API. Defaults to supported_by=INSPECT. + * Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. */ filter?: string; /** - * Optional BCP-47 language code for localized infoType friendly names. If - * omitted, or if localized strings are not available, en-US strings will be - * returned. + * Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. */ languageCode?: string; } @@ -3502,9 +2738,7 @@ export namespace dlp_v2 { /** * dlp.organizations.deidentifyTemplates.create - * @desc Creates a DeidentifyTemplate for re-using frequently used - * configuration for de-identifying content, images, and storage. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.organizations.deidentifyTemplates.create * @memberOf! () * @@ -3596,8 +2830,7 @@ export namespace dlp_v2 { /** * dlp.organizations.deidentifyTemplates.delete - * @desc Deletes a DeidentifyTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.organizations.deidentifyTemplates.delete * @memberOf! () * @@ -3668,8 +2901,7 @@ export namespace dlp_v2 { /** * dlp.organizations.deidentifyTemplates.get - * @desc Gets a DeidentifyTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.organizations.deidentifyTemplates.get * @memberOf! () * @@ -3757,8 +2989,7 @@ export namespace dlp_v2 { /** * dlp.organizations.deidentifyTemplates.list - * @desc Lists DeidentifyTemplates. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.organizations.deidentifyTemplates.list * @memberOf! () * @@ -3859,8 +3090,7 @@ export namespace dlp_v2 { /** * dlp.organizations.deidentifyTemplates.patch - * @desc Updates the DeidentifyTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.organizations.deidentifyTemplates.patch * @memberOf! () * @@ -3956,8 +3186,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; @@ -3974,9 +3203,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and deidentify template to be deleted, - * for example `organizations/433245324/deidentifyTemplates/432452342` or - * projects/project-id/deidentifyTemplates/432452342. + * Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. */ name?: string; } @@ -3988,9 +3215,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and deidentify template to be read, for - * example `organizations/433245324/deidentifyTemplates/432452342` or - * projects/project-id/deidentifyTemplates/432452342. + * Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. */ name?: string; } @@ -4002,29 +3227,19 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional comma separated list of fields to order by, followed by `asc` or - * `desc` postfix. This list is case-insensitive, default sorting order is - * ascending, redundant space characters are insignificant. Example: `name - * asc,update_time, create_time desc` Supported fields are: - - * `create_time`: corresponds to time the template was created. - - * `update_time`: corresponds to time the template was last updated. - - * `name`: corresponds to template's name. - `display_name`: corresponds to - * template's display name. + * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server - * returns a page of max size 100. + * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to - * `ListDeidentifyTemplates`. + * Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. */ pageToken?: string; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; } @@ -4036,9 +3251,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of organization and deidentify template to be updated, for - * example `organizations/433245324/deidentifyTemplates/432452342` or - * projects/project-id/deidentifyTemplates/432452342. + * Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. */ name?: string; @@ -4056,9 +3269,7 @@ export namespace dlp_v2 { /** * dlp.organizations.inspectTemplates.create - * @desc Creates an InspectTemplate for re-using frequently used - * configuration for inspecting content, images, and storage. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.organizations.inspectTemplates.create * @memberOf! () * @@ -4142,8 +3353,7 @@ export namespace dlp_v2 { /** * dlp.organizations.inspectTemplates.delete - * @desc Deletes an InspectTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.organizations.inspectTemplates.delete * @memberOf! () * @@ -4214,8 +3424,7 @@ export namespace dlp_v2 { /** * dlp.organizations.inspectTemplates.get - * @desc Gets an InspectTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.organizations.inspectTemplates.get * @memberOf! () * @@ -4295,8 +3504,7 @@ export namespace dlp_v2 { /** * dlp.organizations.inspectTemplates.list - * @desc Lists InspectTemplates. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.organizations.inspectTemplates.list * @memberOf! () * @@ -4398,8 +3606,7 @@ export namespace dlp_v2 { /** * dlp.organizations.inspectTemplates.patch - * @desc Updates the InspectTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.organizations.inspectTemplates.patch * @memberOf! () * @@ -4487,8 +3694,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; @@ -4505,9 +3711,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and inspectTemplate to be deleted, for - * example `organizations/433245324/inspectTemplates/432452342` or - * projects/project-id/inspectTemplates/432452342. + * Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. */ name?: string; } @@ -4519,9 +3723,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and inspectTemplate to be read, for - * example `organizations/433245324/inspectTemplates/432452342` or - * projects/project-id/inspectTemplates/432452342. + * Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. */ name?: string; } @@ -4533,29 +3735,19 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional comma separated list of fields to order by, followed by `asc` or - * `desc` postfix. This list is case-insensitive, default sorting order is - * ascending, redundant space characters are insignificant. Example: `name - * asc,update_time, create_time desc` Supported fields are: - - * `create_time`: corresponds to time the template was created. - - * `update_time`: corresponds to time the template was last updated. - - * `name`: corresponds to template's name. - `display_name`: corresponds to - * template's display name. + * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server - * returns a page of max size 100. + * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to - * `ListInspectTemplates`. + * Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. */ pageToken?: string; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; } @@ -4567,9 +3759,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of organization and inspectTemplate to be updated, for - * example `organizations/433245324/inspectTemplates/432452342` or - * projects/project-id/inspectTemplates/432452342. + * Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. */ name?: string; @@ -4587,9 +3777,7 @@ export namespace dlp_v2 { /** * dlp.organizations.storedInfoTypes.create - * @desc Creates a pre-built stored infoType to be used for inspection. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.organizations.storedInfoTypes.create * @memberOf! () * @@ -4673,9 +3861,7 @@ export namespace dlp_v2 { /** * dlp.organizations.storedInfoTypes.delete - * @desc Deletes a stored infoType. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.organizations.storedInfoTypes.delete * @memberOf! () * @@ -4746,9 +3932,7 @@ export namespace dlp_v2 { /** * dlp.organizations.storedInfoTypes.get - * @desc Gets a stored infoType. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.organizations.storedInfoTypes.get * @memberOf! () * @@ -4828,9 +4012,7 @@ export namespace dlp_v2 { /** * dlp.organizations.storedInfoTypes.list - * @desc Lists stored infoTypes. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.organizations.storedInfoTypes.list * @memberOf! () * @@ -4932,10 +4114,7 @@ export namespace dlp_v2 { /** * dlp.organizations.storedInfoTypes.patch - * @desc Updates the stored infoType by creating a new version. The existing - * version will continue to be used until the new version is ready. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.organizations.storedInfoTypes.patch * @memberOf! () * @@ -5023,8 +4202,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; @@ -5041,9 +4219,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and storedInfoType to be deleted, for - * example `organizations/433245324/storedInfoTypes/432452342` or - * projects/project-id/storedInfoTypes/432452342. + * Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. */ name?: string; } @@ -5055,9 +4231,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and storedInfoType to be read, for - * example `organizations/433245324/storedInfoTypes/432452342` or - * projects/project-id/storedInfoTypes/432452342. + * Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. */ name?: string; } @@ -5069,29 +4243,19 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional comma separated list of fields to order by, followed by `asc` or - * `desc` postfix. This list is case-insensitive, default sorting order is - * ascending, redundant space characters are insignificant. Example: `name - * asc, display_name, create_time desc` Supported fields are: - - * `create_time`: corresponds to time the most recent version of the - * resource was created. - `state`: corresponds to the state of the - * resource. - `name`: corresponds to resource name. - `display_name`: - * corresponds to info type's display name. + * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server - * returns a page of max size 100. + * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to - * `ListStoredInfoTypes`. + * Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. */ pageToken?: string; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; } @@ -5103,9 +4267,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of organization and storedInfoType to be updated, for - * example `organizations/433245324/storedInfoTypes/432452342` or - * projects/project-id/storedInfoTypes/432452342. + * Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. */ name?: string; @@ -5150,13 +4312,7 @@ export namespace dlp_v2 { /** * dlp.projects.content.deidentify - * @desc De-identifies potentially sensitive info from a ContentItem. This - * method has limits on input size and output size. See - * https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn - * more. When no InfoTypes or CustomInfoTypes are specified in this - * request, the system will automatically choose what detectors to run. By - * default this may be all types, but may change over time as detectors are - * updated. + * @desc De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @alias dlp.projects.content.deidentify * @memberOf! () * @@ -5256,13 +4412,7 @@ export namespace dlp_v2 { /** * dlp.projects.content.inspect - * @desc Finds potentially sensitive info in content. This method has limits - * on input size, processing time, and output size. When no InfoTypes or - * CustomInfoTypes are specified in this request, the system will - * automatically choose what detectors to run. By default this may be all - * types, but may change over time as detectors are updated. For how to - * guides, see https://cloud.google.com/dlp/docs/inspecting-images and - * https://cloud.google.com/dlp/docs/inspecting-text, + * @desc Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, * @alias dlp.projects.content.inspect * @memberOf! () * @@ -5354,9 +4504,7 @@ export namespace dlp_v2 { /** * dlp.projects.content.reidentify - * @desc Re-identifies content that has been de-identified. See - * https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example - * to learn more. + * @desc Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. * @alias dlp.projects.content.reidentify * @memberOf! () * @@ -5515,9 +4663,7 @@ export namespace dlp_v2 { /** * dlp.projects.deidentifyTemplates.create - * @desc Creates a DeidentifyTemplate for re-using frequently used - * configuration for de-identifying content, images, and storage. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.projects.deidentifyTemplates.create * @memberOf! () * @@ -5609,8 +4755,7 @@ export namespace dlp_v2 { /** * dlp.projects.deidentifyTemplates.delete - * @desc Deletes a DeidentifyTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.projects.deidentifyTemplates.delete * @memberOf! () * @@ -5681,8 +4826,7 @@ export namespace dlp_v2 { /** * dlp.projects.deidentifyTemplates.get - * @desc Gets a DeidentifyTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.projects.deidentifyTemplates.get * @memberOf! () * @@ -5770,8 +4914,7 @@ export namespace dlp_v2 { /** * dlp.projects.deidentifyTemplates.list - * @desc Lists DeidentifyTemplates. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.projects.deidentifyTemplates.list * @memberOf! () * @@ -5872,8 +5015,7 @@ export namespace dlp_v2 { /** * dlp.projects.deidentifyTemplates.patch - * @desc Updates the DeidentifyTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. + * @desc Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. * @alias dlp.projects.deidentifyTemplates.patch * @memberOf! () * @@ -5969,8 +5111,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; @@ -5987,9 +5128,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and deidentify template to be deleted, - * for example `organizations/433245324/deidentifyTemplates/432452342` or - * projects/project-id/deidentifyTemplates/432452342. + * Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. */ name?: string; } @@ -6001,9 +5140,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and deidentify template to be read, for - * example `organizations/433245324/deidentifyTemplates/432452342` or - * projects/project-id/deidentifyTemplates/432452342. + * Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. */ name?: string; } @@ -6015,29 +5152,19 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional comma separated list of fields to order by, followed by `asc` or - * `desc` postfix. This list is case-insensitive, default sorting order is - * ascending, redundant space characters are insignificant. Example: `name - * asc,update_time, create_time desc` Supported fields are: - - * `create_time`: corresponds to time the template was created. - - * `update_time`: corresponds to time the template was last updated. - - * `name`: corresponds to template's name. - `display_name`: corresponds to - * template's display name. + * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server - * returns a page of max size 100. + * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to - * `ListDeidentifyTemplates`. + * Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. */ pageToken?: string; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; } @@ -6049,9 +5176,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of organization and deidentify template to be updated, for - * example `organizations/433245324/deidentifyTemplates/432452342` or - * projects/project-id/deidentifyTemplates/432452342. + * Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. */ name?: string; @@ -6069,10 +5194,7 @@ export namespace dlp_v2 { /** * dlp.projects.dlpJobs.cancel - * @desc Starts asynchronous cancellation on a long-running DlpJob. The - * server makes a best effort to cancel the DlpJob, but success is not - * guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and - * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * @desc Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * @alias dlp.projects.dlpJobs.cancel * @memberOf! () * @@ -6144,12 +5266,7 @@ export namespace dlp_v2 { /** * dlp.projects.dlpJobs.create - * @desc Creates a new job to inspect storage or calculate risk metrics. See - * https://cloud.google.com/dlp/docs/inspecting-storage and - * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. - * When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the - * system will automatically choose what detectors to run. By default this - * may be all types, but may change over time as detectors are updated. + * @desc Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @alias dlp.projects.dlpJobs.create * @memberOf! () * @@ -6228,11 +5345,7 @@ export namespace dlp_v2 { /** * dlp.projects.dlpJobs.delete - * @desc Deletes a long-running DlpJob. This method indicates that the - * client is no longer interested in the DlpJob result. The job will be - * cancelled if possible. See - * https://cloud.google.com/dlp/docs/inspecting-storage and - * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * @desc Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * @alias dlp.projects.dlpJobs.delete * @memberOf! () * @@ -6303,9 +5416,7 @@ export namespace dlp_v2 { /** * dlp.projects.dlpJobs.get - * @desc Gets the latest state of a long-running DlpJob. See - * https://cloud.google.com/dlp/docs/inspecting-storage and - * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * @desc Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * @alias dlp.projects.dlpJobs.get * @memberOf! () * @@ -6378,9 +5489,7 @@ export namespace dlp_v2 { /** * dlp.projects.dlpJobs.list - * @desc Lists DlpJobs that match the specified filter in the request. See - * https://cloud.google.com/dlp/docs/inspecting-storage and - * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * @desc Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * @alias dlp.projects.dlpJobs.list * @memberOf! () * @@ -6541,30 +5650,11 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are - * made up of one or more restrictions. * Restrictions can be combined by - * `AND` or `OR` logical operators. A sequence of restrictions implicitly - * uses `AND`. * A restriction has the form of ` `. - * * Supported fields/values for inspect jobs: - `state` - - * PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - - * DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name - * of the trigger that created job. * Supported fields for risk analysis - * jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED * The operator - * must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND - * state = done * inspected_storage = cloud_storage OR inspected_storage = - * bigquery * inspected_storage = cloud_storage AND (state = done OR state = - * canceled) The length of this field should be no more than 500 - * characters. + * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) The length of this field should be no more than 500 characters. */ filter?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or - * `desc` postfix. This list is case-insensitive, default sorting order is - * ascending, redundant space characters are insignificant. Example: `name - * asc, end_time asc, create_time desc` Supported fields are: - - * `create_time`: corresponds to time the job was created. - `end_time`: - * corresponds to time the job ended. - `name`: corresponds to job's name. - - * `state`: corresponds to `state` + * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -6593,13 +5683,7 @@ export namespace dlp_v2 { /** * dlp.projects.image.redact - * @desc Redacts potentially sensitive info from an image. This method has - * limits on input size, processing time, and output size. See - * https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to - * learn more. When no InfoTypes or CustomInfoTypes are specified in this - * request, the system will automatically choose what detectors to run. By - * default this may be all types, but may change over time as detectors are - * updated. + * @desc Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. * @alias dlp.projects.image.redact * @memberOf! () * @@ -6716,9 +5800,7 @@ export namespace dlp_v2 { /** * dlp.projects.inspectTemplates.create - * @desc Creates an InspectTemplate for re-using frequently used - * configuration for inspecting content, images, and storage. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.projects.inspectTemplates.create * @memberOf! () * @@ -6802,8 +5884,7 @@ export namespace dlp_v2 { /** * dlp.projects.inspectTemplates.delete - * @desc Deletes an InspectTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.projects.inspectTemplates.delete * @memberOf! () * @@ -6874,8 +5955,7 @@ export namespace dlp_v2 { /** * dlp.projects.inspectTemplates.get - * @desc Gets an InspectTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.projects.inspectTemplates.get * @memberOf! () * @@ -6955,8 +6035,7 @@ export namespace dlp_v2 { /** * dlp.projects.inspectTemplates.list - * @desc Lists InspectTemplates. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.projects.inspectTemplates.list * @memberOf! () * @@ -7058,8 +6137,7 @@ export namespace dlp_v2 { /** * dlp.projects.inspectTemplates.patch - * @desc Updates the InspectTemplate. See - * https://cloud.google.com/dlp/docs/creating-templates to learn more. + * @desc Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. * @alias dlp.projects.inspectTemplates.patch * @memberOf! () * @@ -7147,8 +6225,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; @@ -7165,9 +6242,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and inspectTemplate to be deleted, for - * example `organizations/433245324/inspectTemplates/432452342` or - * projects/project-id/inspectTemplates/432452342. + * Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. */ name?: string; } @@ -7179,9 +6254,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and inspectTemplate to be read, for - * example `organizations/433245324/inspectTemplates/432452342` or - * projects/project-id/inspectTemplates/432452342. + * Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. */ name?: string; } @@ -7193,29 +6266,19 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional comma separated list of fields to order by, followed by `asc` or - * `desc` postfix. This list is case-insensitive, default sorting order is - * ascending, redundant space characters are insignificant. Example: `name - * asc,update_time, create_time desc` Supported fields are: - - * `create_time`: corresponds to time the template was created. - - * `update_time`: corresponds to time the template was last updated. - - * `name`: corresponds to template's name. - `display_name`: corresponds to - * template's display name. + * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server - * returns a page of max size 100. + * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to - * `ListInspectTemplates`. + * Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. */ pageToken?: string; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; } @@ -7227,9 +6290,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of organization and inspectTemplate to be updated, for - * example `organizations/433245324/inspectTemplates/432452342` or - * projects/project-id/inspectTemplates/432452342. + * Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. */ name?: string; @@ -7247,8 +6308,7 @@ export namespace dlp_v2 { /** * dlp.projects.jobTriggers.activate - * @desc Activate a job trigger. Causes the immediate execute of a trigger - * instead of waiting on the trigger event to occur. + * @desc Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur. * @alias dlp.projects.jobTriggers.activate * @memberOf! () * @@ -7327,9 +6387,7 @@ export namespace dlp_v2 { /** * dlp.projects.jobTriggers.create - * @desc Creates a job trigger to run DLP actions such as scanning storage - * for sensitive information on a set schedule. See - * https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * @desc Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. * @alias dlp.projects.jobTriggers.create * @memberOf! () * @@ -7413,8 +6471,7 @@ export namespace dlp_v2 { /** * dlp.projects.jobTriggers.delete - * @desc Deletes a job trigger. See - * https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * @desc Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. * @alias dlp.projects.jobTriggers.delete * @memberOf! () * @@ -7485,8 +6542,7 @@ export namespace dlp_v2 { /** * dlp.projects.jobTriggers.get - * @desc Gets a job trigger. See - * https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * @desc Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. * @alias dlp.projects.jobTriggers.get * @memberOf! () * @@ -7566,8 +6622,7 @@ export namespace dlp_v2 { /** * dlp.projects.jobTriggers.list - * @desc Lists job triggers. See - * https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * @desc Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. * @alias dlp.projects.jobTriggers.list * @memberOf! () * @@ -7668,8 +6723,7 @@ export namespace dlp_v2 { /** * dlp.projects.jobTriggers.patch - * @desc Updates a job trigger. See - * https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. + * @desc Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. * @alias dlp.projects.jobTriggers.patch * @memberOf! () * @@ -7757,8 +6811,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the trigger to activate, for example - * `projects/dlp-test-project/jobTriggers/53234423`. + * Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`. */ name?: string; @@ -7792,8 +6845,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the project and the triggeredJob, for example - * `projects/dlp-test-project/jobTriggers/53234423`. + * Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. */ name?: string; } @@ -7805,8 +6857,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the project and the triggeredJob, for example - * `projects/dlp-test-project/jobTriggers/53234423`. + * Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. */ name?: string; } @@ -7818,34 +6869,11 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are - * made up of one or more restrictions. * Restrictions can be combined by - * `AND` or `OR` logical operators. A sequence of restrictions implicitly - * uses `AND`. * A restriction has the form of ` `. - * * Supported fields/values for inspect jobs: - `status` - - * HEALTHY|PAUSED|CANCELLED - `inspected_storage` - - * DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 - * formatted timestamp, surrounded by quotation marks. Nanoseconds are - * ignored. - 'error_count' - Number of errors that have occurred while - * running. * The operator must be `=` or `!=` for status and - * inspected_storage. Examples: * inspected_storage = cloud_storage AND - * status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage - * = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR - * state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The - * length of this field should be no more than 500 characters. + * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** - * Optional comma separated list of triggeredJob fields to order by, - * followed by `asc` or `desc` postfix. This list is case-insensitive, - * default sorting order is ascending, redundant space characters are - * insignificant. Example: `name asc,update_time, create_time desc` - * Supported fields are: - `create_time`: corresponds to time the - * JobTrigger was created. - `update_time`: corresponds to time the - * JobTrigger was last updated. - `last_run_time`: corresponds to the last - * time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - - * `display_name`: corresponds to JobTrigger's display name. - `status`: - * corresponds to JobTrigger's status. + * Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -7853,8 +6881,7 @@ export namespace dlp_v2 { */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to - * ListJobTriggers. `order_by` field must not change for subsequent calls. + * Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. */ pageToken?: string; /** @@ -7870,8 +6897,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the project and the triggeredJob, for example - * `projects/dlp-test-project/jobTriggers/53234423`. + * Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. */ name?: string; @@ -7889,9 +6915,7 @@ export namespace dlp_v2 { /** * dlp.projects.storedInfoTypes.create - * @desc Creates a pre-built stored infoType to be used for inspection. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.projects.storedInfoTypes.create * @memberOf! () * @@ -7975,9 +6999,7 @@ export namespace dlp_v2 { /** * dlp.projects.storedInfoTypes.delete - * @desc Deletes a stored infoType. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.projects.storedInfoTypes.delete * @memberOf! () * @@ -8048,9 +7070,7 @@ export namespace dlp_v2 { /** * dlp.projects.storedInfoTypes.get - * @desc Gets a stored infoType. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.projects.storedInfoTypes.get * @memberOf! () * @@ -8130,9 +7150,7 @@ export namespace dlp_v2 { /** * dlp.projects.storedInfoTypes.list - * @desc Lists stored infoTypes. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.projects.storedInfoTypes.list * @memberOf! () * @@ -8234,10 +7252,7 @@ export namespace dlp_v2 { /** * dlp.projects.storedInfoTypes.patch - * @desc Updates the stored infoType by creating a new version. The existing - * version will continue to be used until the new version is ready. See - * https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn - * more. + * @desc Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. * @alias dlp.projects.storedInfoTypes.patch * @memberOf! () * @@ -8325,8 +7340,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; @@ -8343,9 +7357,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and storedInfoType to be deleted, for - * example `organizations/433245324/storedInfoTypes/432452342` or - * projects/project-id/storedInfoTypes/432452342. + * Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. */ name?: string; } @@ -8357,9 +7369,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the organization and storedInfoType to be read, for - * example `organizations/433245324/storedInfoTypes/432452342` or - * projects/project-id/storedInfoTypes/432452342. + * Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. */ name?: string; } @@ -8371,29 +7381,19 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional comma separated list of fields to order by, followed by `asc` or - * `desc` postfix. This list is case-insensitive, default sorting order is - * ascending, redundant space characters are insignificant. Example: `name - * asc, display_name, create_time desc` Supported fields are: - - * `create_time`: corresponds to time the most recent version of the - * resource was created. - `state`: corresponds to the state of the - * resource. - `name`: corresponds to resource name. - `display_name`: - * corresponds to info type's display name. + * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server - * returns a page of max size 100. + * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to - * `ListStoredInfoTypes`. + * Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. */ pageToken?: string; /** - * The parent resource name, for example projects/my-project-id or - * organizations/my-org-id. + * The parent resource name, for example projects/my-project-id or organizations/my-org-id. */ parent?: string; } @@ -8405,9 +7405,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of organization and storedInfoType to be updated, for - * example `organizations/433245324/storedInfoTypes/432452342` or - * projects/project-id/storedInfoTypes/432452342. + * Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. */ name?: string; diff --git a/src/apis/dns/package.json b/src/apis/dns/package.json index f61d9e2004e..23813f3715c 100644 --- a/src/apis/dns/package.json +++ b/src/apis/dns/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 84c5fea3162..4b948c25a19 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace dns_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace dns_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -100,7 +97,10 @@ export namespace dns_v1 { resourceRecordSets: Resource$Resourcerecordsets; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.changes = new Resource$Changes(this.context); this.dnsKeys = new Resource$Dnskeys(this.context); @@ -114,13 +114,7 @@ export namespace dns_v1 { } /** - * A Change represents a set of ResourceRecordSet additions and deletions - * applied atomically to a ManagedZone. ResourceRecordSets within a - * ManagedZone are modified by creating a new Change element in the Changes - * collection. In turn the Changes collection also records the past - * modifications to the ResourceRecordSets in a ManagedZone. The current state - * of the ManagedZone is the sum effect of applying all Change elements in the - * Changes collection in sequence. + * A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. */ export interface Schema$Change { /** @@ -140,25 +134,20 @@ export namespace dns_v1 { */ isServing?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#change". + * Identifies what kind of resource this is. Value: the fixed string "dns#change". */ kind?: string; /** - * The time that this operation was started by the server (output only). - * This is in RFC3339 text format. + * The time that this operation was started by the server (output only). This is in RFC3339 text format. */ startTime?: string; /** - * Status of the operation (output only). A status of "done" means - * that the request to update the authoritative servers has been sent, but - * the servers might not be updated yet. + * Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ status?: string; } /** - * The response to a request to enumerate Changes to a ResourceRecordSets - * collection. + * The response to a request to enumerate Changes to a ResourceRecordSets collection. */ export interface Schema$ChangesListResponse { /** @@ -171,15 +160,7 @@ export namespace dns_v1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a "snapshot" of - * collections larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ nextPageToken?: string; } @@ -188,25 +169,19 @@ export namespace dns_v1 { */ export interface Schema$DnsKey { /** - * String mnemonic specifying the DNSSEC algorithm of this key. Immutable - * after creation time. + * String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. */ algorithm?: string; /** - * The time that this resource was created in the control plane. This is in - * RFC3339 text format. Output only. + * The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. */ creationTime?: string; /** - * A mutable string of at most 1024 characters associated with this resource - * for the user's convenience. Has no effect on the resource's - * function. + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. */ description?: string; /** - * Cryptographic hashes of the DNSKEY resource record associated with this - * DnsKey. These digests are needed to construct a DS record that points at - * this DNS key. Output only. + * Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. */ digests?: Schema$DnsKeyDigest[]; /** @@ -214,9 +189,7 @@ export namespace dns_v1 { */ id?: string; /** - * Active keys will be used to sign subsequent changes to the ManagedZone. - * Inactive keys will still be present as DNSKEY Resource Records for the - * use of resolvers validating existing signatures. + * Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. */ isActive?: boolean; /** @@ -224,18 +197,11 @@ export namespace dns_v1 { */ keyLength?: number; /** - * The key tag is a non-cryptographic hash of the a DNSKEY resource record - * associated with this DnsKey. The key tag can be used to identify a DNSKEY - * more quickly (but it is not a unique identifier). In particular, the key - * tag is used in a parent zone's DS record to point at the DNSKEY in - * this child ManagedZone. The key tag is a number in the range [0, 65535] - * and the algorithm to calculate it is specified in RFC4034 Appendix B. - * Output only. + * The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. */ keyTag?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#dnsKey". + * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". */ kind?: string; /** @@ -243,18 +209,13 @@ export namespace dns_v1 { */ publicKey?: string; /** - * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type - * KEY_SIGNING have the Secure Entry Point flag set and, when active, will - * be used to sign only resource record sets of type DNSKEY. Otherwise, the - * Secure Entry Point flag will be cleared and this key will be used to sign - * only resource record sets of other types. Immutable after creation time. + * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. */ type?: string; } export interface Schema$DnsKeyDigest { /** - * The base-16 encoded bytes of this digest. Suitable for use in a DS - * resource record. + * The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. */ digest?: string; /** @@ -276,21 +237,12 @@ export namespace dns_v1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a "snapshot" of - * collections larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ nextPageToken?: string; } /** - * Parameters for DnsKey key generation. Used for generating initial keys for - * a new ManagedZone and as default when adding a new DnsKey. + * Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. */ export interface Schema$DnsKeySpec { /** @@ -302,34 +254,24 @@ export namespace dns_v1 { */ keyLength?: number; /** - * Specifies whether this is a key signing key (KSK) or a zone signing key - * (ZSK). Key signing keys have the Secure Entry Point flag set and, when - * active, will only be used to sign resource record sets of type DNSKEY. - * Zone signing keys do not have the Secure Entry Point flag set and will be - * used to sign all other types of resource record sets. + * Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. */ keyType?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#dnsKeySpec". + * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". */ kind?: string; } /** - * A zone is a subtree of the DNS namespace under one administrative - * responsibility. A ManagedZone is a resource that represents a DNS zone - * hosted by the Cloud DNS service. + * A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. */ export interface Schema$ManagedZone { /** - * The time that this resource was created on the server. This is in RFC3339 - * text format. Output only. + * The time that this resource was created on the server. This is in RFC3339 text format. Output only. */ creationTime?: string; /** - * A mutable string of at most 1024 characters associated with this resource - * for the user's convenience. Has no effect on the managed zone's - * function. + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. */ description?: string; /** @@ -345,8 +287,7 @@ export namespace dns_v1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZone". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". */ kind?: string; /** @@ -354,47 +295,37 @@ export namespace dns_v1 { */ labels?: {[key: string]: string}; /** - * User assigned name for this resource. Must be unique within the project. - * The name must be 1-63 characters long, must begin with a letter, end with - * a letter or digit, and only contain lowercase letters, digits or dashes. + * User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. */ name?: string; /** - * Delegate your managed_zone to these virtual name servers; defined by the - * server (output only) + * Delegate your managed_zone to these virtual name servers; defined by the server (output only) */ nameServers?: string[]; /** - * Optionally specifies the NameServerSet for this ManagedZone. A - * NameServerSet is a set of DNS name servers that all host the same - * ManagedZones. Most users will leave this field unset. + * Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. */ nameServerSet?: string; /** - * For privately visible zones, the set of Virtual Private Cloud resources - * that the zone is visible from. + * For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. */ privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; /** - * The zone's visibility: public zones are exposed to the Internet, - * while private zones are visible only to Virtual Private Cloud resources. + * The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. */ visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for - * this ManagedZone. Output only while state is not OFF. + * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZoneDnsSecConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". */ kind?: string; /** - * Specifies the mechanism used to provide authenticated denial-of-existence - * responses. Output only while state is not OFF. + * Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. */ nonExistence?: string; /** @@ -409,15 +340,7 @@ export namespace dns_v1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your page token. In this - * way you can retrieve the complete contents of even very large collections - * one page at a time. However, if the contents of the collection change - * between the first and last paginated list request, the set of all - * elements returned will be an inconsistent view of the collection. There - * is no way to retrieve a consistent snapshot of a collection larger than - * the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; /** @@ -427,8 +350,7 @@ export namespace dns_v1 { } export interface Schema$ManagedZonePrivateVisibilityConfig { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePrivateVisibilityConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". */ kind?: string; /** @@ -438,14 +360,11 @@ export namespace dns_v1 { } export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePrivateVisibilityConfigNetwork". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". */ kind?: string; /** - * The fully qualified URL of the VPC network to bind to. This should be - * formatted like - * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ networkUrl?: string; } @@ -460,23 +379,12 @@ export namespace dns_v1 { */ managedZones?: Schema$ManagedZone[]; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your page token. In this - * way you can retrieve the complete contents of even very large collections - * one page at a time. However, if the contents of the collection change - * between the first and last paginated list request, the set of all - * elements returned will be an inconsistent view of the collection. There - * is no way to retrieve a consistent snapshot of a collection larger than - * the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; } /** - * An operation represents a successful mutation performed on a Cloud DNS - * resource. Operations provide: - An audit log of server resource mutations. - * - A way to recover/retry API calls in the case where the response is never - * received by the caller. Use the caller specified client_operation_id. + * An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. */ export interface Schema$Operation { /** @@ -484,38 +392,27 @@ export namespace dns_v1 { */ dnsKeyContext?: Schema$OperationDnsKeyContext; /** - * Unique identifier for the resource. This is the client_operation_id if - * the client specified it when the mutation was initiated, otherwise, it is - * generated by the server. The name must be 1-63 characters long and match - * the regular expression [-a-z0-9]? (output only) + * Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#operation". + * Identifies what kind of resource this is. Value: the fixed string "dns#operation". */ kind?: string; /** - * The time that this operation was started by the server. This is in - * RFC3339 text format (output only). + * The time that this operation was started by the server. This is in RFC3339 text format (output only). */ startTime?: string; /** - * Status of the operation. Can be one of the following: "PENDING" - * or "DONE" (output only). A status of "DONE" means - * that the request to update the authoritative servers has been sent, but - * the servers might not be updated yet. + * Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ status?: string; /** - * Type of the operation. Operations include insert, update, and delete - * (output only). + * Type of the operation. Operations include insert, update, and delete (output only). */ type?: string; /** - * User who requested the operation, for example: user@example.com. - * cloud-dns-system for operations automatically done by the system. (output - * only) + * User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) */ user?: string; /** @@ -544,9 +441,7 @@ export namespace dns_v1 { oldValue?: Schema$ManagedZone; } /** - * A project resource. The project is a top level container for resources - * including Cloud DNS ManagedZones. Projects can be created only in the APIs - * console. + * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. */ export interface Schema$Project { /** @@ -554,13 +449,11 @@ export namespace dns_v1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#project". + * Identifies what kind of resource this is. Value: the fixed string "dns#project". */ kind?: string; /** - * Unique numeric identifier for the resource; defined by the server (output - * only). + * Unique numeric identifier for the resource; defined by the server (output only). */ number?: string; /** @@ -577,8 +470,7 @@ export namespace dns_v1 { */ dnsKeysPerManagedZone?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#quota". + * Identifies what kind of resource this is. Value: the fixed string "dns#quota". */ kind?: string; /** @@ -586,13 +478,11 @@ export namespace dns_v1 { */ managedZones?: number; /** - * Maximum allowed number of managed zones which can be attached to a - * network. + * Maximum allowed number of managed zones which can be attached to a network. */ managedZonesPerNetwork?: number; /** - * Maximum allowed number of networks to which a privately scoped zone can - * be attached. + * Maximum allowed number of networks to which a privately scoped zone can be attached. */ networksPerManagedZone?: number; /** @@ -600,13 +490,11 @@ export namespace dns_v1 { */ resourceRecordsPerRrset?: number; /** - * Maximum allowed number of ResourceRecordSets to add per - * ChangesCreateRequest. + * Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. */ rrsetAdditionsPerChange?: number; /** - * Maximum allowed number of ResourceRecordSets to delete per - * ChangesCreateRequest. + * Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest. */ rrsetDeletionsPerChange?: number; /** @@ -614,8 +502,7 @@ export namespace dns_v1 { */ rrsetsPerManagedZone?: number; /** - * Maximum allowed size for total rrdata in one ChangesCreateRequest in - * bytes. + * Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. */ totalRrdataSizePerChange?: number; /** @@ -628,8 +515,7 @@ export namespace dns_v1 { */ export interface Schema$ResourceRecordSet { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#resourceRecordSet". + * Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet". */ kind?: string; /** @@ -637,8 +523,7 @@ export namespace dns_v1 { */ name?: string; /** - * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see - * examples. + * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. */ rrdatas?: string[]; /** @@ -650,8 +535,7 @@ export namespace dns_v1 { */ ttl?: number; /** - * The identifier of a supported record type. See the list of Supported DNS - * record types. + * The identifier of a supported record type. See the list of Supported DNS record types. */ type?: string; } @@ -662,15 +546,7 @@ export namespace dns_v1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a consistent snapshot of a - * collection larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; /** @@ -683,9 +559,7 @@ export namespace dns_v1 { */ export interface Schema$ResponseHeader { /** - * For mutating operation requests that completed successfully. This is the - * client_operation_id if the client specified it, otherwise it is generated - * by the server (output only). + * For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). */ operationId?: string; } @@ -705,14 +579,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -724,9 +596,8 @@ export namespace dns_v1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -752,10 +623,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -840,14 +710,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -859,13 +727,11 @@ export namespace dns_v1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * - * // The identifier of the requested change, from a previous - * ResourceRecordSetsChangeResponse. changeId: 'my-change-id', // TODO: - * Update placeholder value. + * // The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. + * changeId: 'my-change-id', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -887,10 +753,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -975,14 +840,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -994,9 +857,8 @@ export namespace dns_v1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1012,8 +874,8 @@ export namespace dns_v1 { * return; * } * for (var i = 0; i < changesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `changesPage`: console.log(JSON.stringify(changesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `changesPage`: + * console.log(JSON.stringify(changesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1031,10 +893,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1122,14 +983,11 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1149,19 +1007,15 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The identifier of the requested change, from a previous - * ResourceRecordSetsChangeResponse. + * The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. */ changeId?: string; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1176,18 +1030,15 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1370,15 +1221,11 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * An optional comma-separated list of digest types to compute and display - * for key signing keys. If omitted, the recommended digest type will be - * computed and displayed. + * An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. */ digestType?: string; /** @@ -1386,8 +1233,7 @@ export namespace dns_v1 { */ dnsKeyId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1402,24 +1248,19 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional comma-separated list of digest types to compute and display - * for key signing keys. If omitted, the recommended digest type will be - * computed and displayed. + * An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. */ digestType?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1607,9 +1448,7 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -1637,13 +1476,11 @@ export namespace dns_v1 { */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1671,14 +1508,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1714,10 +1549,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1804,14 +1638,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1823,9 +1655,8 @@ export namespace dns_v1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1844,10 +1675,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1931,14 +1761,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1950,9 +1778,8 @@ export namespace dns_v1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1974,10 +1801,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2062,14 +1888,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2095,9 +1919,8 @@ export namespace dns_v1 { * return; * } * for (var i = 0; i < managedZonesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `managedZonesPage`: console.log(JSON.stringify(managedZonesPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `managedZonesPage`: + * console.log(JSON.stringify(managedZonesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2115,10 +1938,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2360,9 +2182,7 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2383,14 +2203,11 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2405,14 +2222,11 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2432,13 +2246,11 @@ export namespace dns_v1 { */ dnsName?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -2454,14 +2266,11 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2482,14 +2291,11 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2518,14 +2324,12 @@ export namespace dns_v1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2557,10 +2361,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2642,9 +2445,7 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2661,22 +2462,19 @@ export namespace dns_v1 { /** * dns.resourceRecordSets.list - * @desc Enumerate ResourceRecordSets that have been created but not yet - * deleted. + * @desc Enumerate ResourceRecordSets that have been created but not yet deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2688,9 +2486,8 @@ export namespace dns_v1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -2706,8 +2503,8 @@ export namespace dns_v1 { * return; * } * for (var i = 0; i < rrsetsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `rrsetsPage`: console.log(JSON.stringify(rrsetsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `rrsetsPage`: + * console.log(JSON.stringify(rrsetsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2725,10 +2522,9 @@ export namespace dns_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2827,23 +2623,19 @@ export namespace dns_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Restricts the list to return only records with this fully qualified - * domain name. + * Restricts the list to return only records with this fully qualified domain name. */ name?: string; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -2851,8 +2643,7 @@ export namespace dns_v1 { */ project?: string; /** - * Restricts the list to return only records of this type. If present, the - * "name" parameter must also be present. + * Restricts the list to return only records of this type. If present, the "name" parameter must also be present. */ type?: string; } diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 252776e0dba..7917c61470c 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace dns_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace dns_v1beta2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -101,7 +98,10 @@ export namespace dns_v1beta2 { resourceRecordSets: Resource$Resourcerecordsets; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.changes = new Resource$Changes(this.context); this.dnsKeys = new Resource$Dnskeys(this.context); @@ -116,13 +116,7 @@ export namespace dns_v1beta2 { } /** - * A Change represents a set of ResourceRecordSet additions and deletions - * applied atomically to a ManagedZone. ResourceRecordSets within a - * ManagedZone are modified by creating a new Change element in the Changes - * collection. In turn the Changes collection also records the past - * modifications to the ResourceRecordSets in a ManagedZone. The current state - * of the ManagedZone is the sum effect of applying all Change elements in the - * Changes collection in sequence. + * A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. */ export interface Schema$Change { /** @@ -142,25 +136,20 @@ export namespace dns_v1beta2 { */ isServing?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#change". + * Identifies what kind of resource this is. Value: the fixed string "dns#change". */ kind?: string; /** - * The time that this operation was started by the server (output only). - * This is in RFC3339 text format. + * The time that this operation was started by the server (output only). This is in RFC3339 text format. */ startTime?: string; /** - * Status of the operation (output only). A status of "done" means - * that the request to update the authoritative servers has been sent, but - * the servers might not be updated yet. + * Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ status?: string; } /** - * The response to a request to enumerate Changes to a ResourceRecordSets - * collection. + * The response to a request to enumerate Changes to a ResourceRecordSets collection. */ export interface Schema$ChangesListResponse { /** @@ -173,15 +162,7 @@ export namespace dns_v1beta2 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a "snapshot" of - * collections larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ nextPageToken?: string; } @@ -190,25 +171,19 @@ export namespace dns_v1beta2 { */ export interface Schema$DnsKey { /** - * String mnemonic specifying the DNSSEC algorithm of this key. Immutable - * after creation time. + * String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. */ algorithm?: string; /** - * The time that this resource was created in the control plane. This is in - * RFC3339 text format. Output only. + * The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. */ creationTime?: string; /** - * A mutable string of at most 1024 characters associated with this resource - * for the user's convenience. Has no effect on the resource's - * function. + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. */ description?: string; /** - * Cryptographic hashes of the DNSKEY resource record associated with this - * DnsKey. These digests are needed to construct a DS record that points at - * this DNS key. Output only. + * Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. */ digests?: Schema$DnsKeyDigest[]; /** @@ -216,9 +191,7 @@ export namespace dns_v1beta2 { */ id?: string; /** - * Active keys will be used to sign subsequent changes to the ManagedZone. - * Inactive keys will still be present as DNSKEY Resource Records for the - * use of resolvers validating existing signatures. + * Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. */ isActive?: boolean; /** @@ -226,18 +199,11 @@ export namespace dns_v1beta2 { */ keyLength?: number; /** - * The key tag is a non-cryptographic hash of the a DNSKEY resource record - * associated with this DnsKey. The key tag can be used to identify a DNSKEY - * more quickly (but it is not a unique identifier). In particular, the key - * tag is used in a parent zone's DS record to point at the DNSKEY in - * this child ManagedZone. The key tag is a number in the range [0, 65535] - * and the algorithm to calculate it is specified in RFC4034 Appendix B. - * Output only. + * The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. */ keyTag?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#dnsKey". + * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". */ kind?: string; /** @@ -245,18 +211,13 @@ export namespace dns_v1beta2 { */ publicKey?: string; /** - * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type - * KEY_SIGNING have the Secure Entry Point flag set and, when active, will - * be used to sign only resource record sets of type DNSKEY. Otherwise, the - * Secure Entry Point flag will be cleared and this key will be used to sign - * only resource record sets of other types. Immutable after creation time. + * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. */ type?: string; } export interface Schema$DnsKeyDigest { /** - * The base-16 encoded bytes of this digest. Suitable for use in a DS - * resource record. + * The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. */ digest?: string; /** @@ -278,21 +239,12 @@ export namespace dns_v1beta2 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a "snapshot" of - * collections larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ nextPageToken?: string; } /** - * Parameters for DnsKey key generation. Used for generating initial keys for - * a new ManagedZone and as default when adding a new DnsKey. + * Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. */ export interface Schema$DnsKeySpec { /** @@ -304,34 +256,24 @@ export namespace dns_v1beta2 { */ keyLength?: number; /** - * Specifies whether this is a key signing key (KSK) or a zone signing key - * (ZSK). Key signing keys have the Secure Entry Point flag set and, when - * active, will only be used to sign resource record sets of type DNSKEY. - * Zone signing keys do not have the Secure Entry Point flag set and will be - * used to sign all other types of resource record sets. + * Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. */ keyType?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#dnsKeySpec". + * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". */ kind?: string; } /** - * A zone is a subtree of the DNS namespace under one administrative - * responsibility. A ManagedZone is a resource that represents a DNS zone - * hosted by the Cloud DNS service. + * A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. */ export interface Schema$ManagedZone { /** - * The time that this resource was created on the server. This is in RFC3339 - * text format. Output only. + * The time that this resource was created on the server. This is in RFC3339 text format. Output only. */ creationTime?: string; /** - * A mutable string of at most 1024 characters associated with this resource - * for the user's convenience. Has no effect on the managed zone's - * function. + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. */ description?: string; /** @@ -343,9 +285,7 @@ export namespace dns_v1beta2 { */ dnssecConfig?: Schema$ManagedZoneDnsSecConfig; /** - * The presence for this field indicates that outbound forwarding is enabled - * for this zone. The value of this field contains the set of destinations - * to forward to. + * The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. */ forwardingConfig?: Schema$ManagedZoneForwardingConfig; /** @@ -353,8 +293,7 @@ export namespace dns_v1beta2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZone". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". */ kind?: string; /** @@ -362,52 +301,41 @@ export namespace dns_v1beta2 { */ labels?: {[key: string]: string}; /** - * User assigned name for this resource. Must be unique within the project. - * The name must be 1-63 characters long, must begin with a letter, end with - * a letter or digit, and only contain lowercase letters, digits or dashes. + * User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. */ name?: string; /** - * Delegate your managed_zone to these virtual name servers; defined by the - * server (output only) + * Delegate your managed_zone to these virtual name servers; defined by the server (output only) */ nameServers?: string[]; /** - * Optionally specifies the NameServerSet for this ManagedZone. A - * NameServerSet is a set of DNS name servers that all host the same - * ManagedZones. Most users will leave this field unset. + * Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. */ nameServerSet?: string; /** - * The presence of this field indicates that DNS Peering is enabled for this - * zone. The value of this field contains the network to peer with. + * The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. */ peeringConfig?: Schema$ManagedZonePeeringConfig; /** - * For privately visible zones, the set of Virtual Private Cloud resources - * that the zone is visible from. + * For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. */ privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; /** - * The zone's visibility: public zones are exposed to the Internet, - * while private zones are visible only to Virtual Private Cloud resources. + * The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. */ visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for - * this ManagedZone. Output only while state is not OFF. + * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZoneDnsSecConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". */ kind?: string; /** - * Specifies the mechanism used to provide authenticated denial-of-existence - * responses. Output only while state is not OFF. + * Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. */ nonExistence?: string; /** @@ -417,13 +345,11 @@ export namespace dns_v1beta2 { } export interface Schema$ManagedZoneForwardingConfig { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZoneForwardingConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfig". */ kind?: string; /** - * List of target name servers to forward to. Cloud DNS will select the best - * available name server if more than one target is given. + * List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. */ targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[]; } @@ -433,8 +359,7 @@ export namespace dns_v1beta2 { */ ipv4Address?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZoneForwardingConfigNameServerTarget". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneForwardingConfigNameServerTarget". */ kind?: string; } @@ -445,15 +370,7 @@ export namespace dns_v1beta2 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your page token. In this - * way you can retrieve the complete contents of even very large collections - * one page at a time. However, if the contents of the collection change - * between the first and last paginated list request, the set of all - * elements returned will be an inconsistent view of the collection. There - * is no way to retrieve a consistent snapshot of a collection larger than - * the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; /** @@ -463,8 +380,7 @@ export namespace dns_v1beta2 { } export interface Schema$ManagedZonePeeringConfig { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePeeringConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". */ kind?: string; /** @@ -474,29 +390,21 @@ export namespace dns_v1beta2 { } export interface Schema$ManagedZonePeeringConfigTargetNetwork { /** - * If this zone has been deactivated due to a problem with the network it - * targeted, the time at which it was deactivated. The zone can be - * deactivated if, for instance, the network it targeted was deleted. If the - * targeted network is still present, this will be the empty string. This is - * in RFC3339 text format. Output only. + * If this zone has been deactivated due to a problem with the network it targeted, the time at which it was deactivated. The zone can be deactivated if, for instance, the network it targeted was deleted. If the targeted network is still present, this will be the empty string. This is in RFC3339 text format. Output only. */ deactivateTime?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePeeringConfigTargetNetwork". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". */ kind?: string; /** - * The fully qualified URL of the VPC network to forward queries to. This - * should be formatted like - * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + * The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ networkUrl?: string; } export interface Schema$ManagedZonePrivateVisibilityConfig { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePrivateVisibilityConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". */ kind?: string; /** @@ -506,14 +414,11 @@ export namespace dns_v1beta2 { } export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePrivateVisibilityConfigNetwork". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". */ kind?: string; /** - * The fully qualified URL of the VPC network to bind to. This should be - * formatted like - * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ networkUrl?: string; } @@ -528,23 +433,12 @@ export namespace dns_v1beta2 { */ managedZones?: Schema$ManagedZone[]; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your page token. In this - * way you can retrieve the complete contents of even very large collections - * one page at a time. However, if the contents of the collection change - * between the first and last paginated list request, the set of all - * elements returned will be an inconsistent view of the collection. There - * is no way to retrieve a consistent snapshot of a collection larger than - * the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; } /** - * An operation represents a successful mutation performed on a Cloud DNS - * resource. Operations provide: - An audit log of server resource mutations. - * - A way to recover/retry API calls in the case where the response is never - * received by the caller. Use the caller specified client_operation_id. + * An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. */ export interface Schema$Operation { /** @@ -552,38 +446,27 @@ export namespace dns_v1beta2 { */ dnsKeyContext?: Schema$OperationDnsKeyContext; /** - * Unique identifier for the resource. This is the client_operation_id if - * the client specified it when the mutation was initiated, otherwise, it is - * generated by the server. The name must be 1-63 characters long and match - * the regular expression [-a-z0-9]? (output only) + * Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#operation". + * Identifies what kind of resource this is. Value: the fixed string "dns#operation". */ kind?: string; /** - * The time that this operation was started by the server. This is in - * RFC3339 text format (output only). + * The time that this operation was started by the server. This is in RFC3339 text format (output only). */ startTime?: string; /** - * Status of the operation. Can be one of the following: "PENDING" - * or "DONE" (output only). A status of "DONE" means - * that the request to update the authoritative servers has been sent, but - * the servers might not be updated yet. + * Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ status?: string; /** - * Type of the operation. Operations include insert, update, and delete - * (output only). + * Type of the operation. Operations include insert, update, and delete (output only). */ type?: string; /** - * User who requested the operation, for example: user@example.com. - * cloud-dns-system for operations automatically done by the system. (output - * only) + * User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) */ user?: string; /** @@ -618,15 +501,7 @@ export namespace dns_v1beta2 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your page token. In this - * way you can retrieve the complete contents of even very large collections - * one page at a time. However, if the contents of the collection change - * between the first and last paginated list request, the set of all - * elements returned will be an inconsistent view of the collection. There - * is no way to retrieve a consistent snapshot of a collection larger than - * the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; /** @@ -643,33 +518,23 @@ export namespace dns_v1beta2 { policy?: Schema$Policy; } /** - * A policy is a collection of DNS rules applied to one or more Virtual - * Private Cloud resources. + * A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. */ export interface Schema$Policy { /** - * Sets an alternative name server for the associated networks. When - * specified, all DNS queries are forwarded to a name server that you - * choose. Names such as .internal are not available when an alternative - * name server is specified. + * Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. */ alternativeNameServerConfig?: Schema$PolicyAlternativeNameServerConfig; /** - * A mutable string of at most 1024 characters associated with this resource - * for the user's convenience. Has no effect on the policy's - * function. + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. */ description?: string; /** - * Allows networks bound to this policy to receive DNS queries sent by VMs - * or applications over VPN connections. When enabled, a virtual IP address - * will be allocated from each of the sub-networks that are bound to this - * policy. + * Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy. */ enableInboundForwarding?: boolean; /** - * Controls whether logging is enabled for the networks bound to this - * policy. Defaults to no logging if not set. + * Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. */ enableLogging?: boolean; /** @@ -677,8 +542,7 @@ export namespace dns_v1beta2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#policy". + * Identifies what kind of resource this is. Value: the fixed string "dns#policy". */ kind?: string; /** @@ -686,22 +550,17 @@ export namespace dns_v1beta2 { */ name?: string; /** - * List of network names specifying networks to which this policy is - * applied. + * List of network names specifying networks to which this policy is applied. */ networks?: Schema$PolicyNetwork[]; } export interface Schema$PolicyAlternativeNameServerConfig { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#policyAlternativeNameServerConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig". */ kind?: string; /** - * Sets an alternative name server for the associated networks. When - * specified, all DNS queries are forwarded to a name server that you - * choose. Names such as .internal are not available when an alternative - * name server is specified. + * Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. */ targetNameServers?: Schema$PolicyAlternativeNameServerConfigTargetNameServer[]; } @@ -711,28 +570,22 @@ export namespace dns_v1beta2 { */ ipv4Address?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#policyAlternativeNameServerConfigTargetNameServer". + * Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer". */ kind?: string; } export interface Schema$PolicyNetwork { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#policyNetwork". + * Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork". */ kind?: string; /** - * The fully qualified URL of the VPC network to bind to. This should be - * formatted like - * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ networkUrl?: string; } /** - * A project resource. The project is a top level container for resources - * including Cloud DNS ManagedZones. Projects can be created only in the APIs - * console. + * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. */ export interface Schema$Project { /** @@ -740,13 +593,11 @@ export namespace dns_v1beta2 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#project". + * Identifies what kind of resource this is. Value: the fixed string "dns#project". */ kind?: string; /** - * Unique numeric identifier for the resource; defined by the server (output - * only). + * Unique numeric identifier for the resource; defined by the server (output only). */ number?: string; /** @@ -763,8 +614,7 @@ export namespace dns_v1beta2 { */ dnsKeysPerManagedZone?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#quota". + * Identifies what kind of resource this is. Value: the fixed string "dns#quota". */ kind?: string; /** @@ -772,13 +622,11 @@ export namespace dns_v1beta2 { */ managedZones?: number; /** - * Maximum allowed number of managed zones which can be attached to a - * network. + * Maximum allowed number of managed zones which can be attached to a network. */ managedZonesPerNetwork?: number; /** - * Maximum allowed number of networks to which a privately scoped zone can - * be attached. + * Maximum allowed number of networks to which a privately scoped zone can be attached. */ networksPerManagedZone?: number; /** @@ -794,13 +642,11 @@ export namespace dns_v1beta2 { */ resourceRecordsPerRrset?: number; /** - * Maximum allowed number of ResourceRecordSets to add per - * ChangesCreateRequest. + * Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. */ rrsetAdditionsPerChange?: number; /** - * Maximum allowed number of ResourceRecordSets to delete per - * ChangesCreateRequest. + * Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest. */ rrsetDeletionsPerChange?: number; /** @@ -808,8 +654,7 @@ export namespace dns_v1beta2 { */ rrsetsPerManagedZone?: number; /** - * Maximum allowed number of target name servers per managed forwarding - * zone. + * Maximum allowed number of target name servers per managed forwarding zone. */ targetNameServersPerManagedZone?: number; /** @@ -817,8 +662,7 @@ export namespace dns_v1beta2 { */ targetNameServersPerPolicy?: number; /** - * Maximum allowed size for total rrdata in one ChangesCreateRequest in - * bytes. + * Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. */ totalRrdataSizePerChange?: number; /** @@ -831,8 +675,7 @@ export namespace dns_v1beta2 { */ export interface Schema$ResourceRecordSet { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#resourceRecordSet". + * Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet". */ kind?: string; /** @@ -840,8 +683,7 @@ export namespace dns_v1beta2 { */ name?: string; /** - * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see - * examples. + * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. */ rrdatas?: string[]; /** @@ -853,8 +695,7 @@ export namespace dns_v1beta2 { */ ttl?: number; /** - * The identifier of a supported record type. See the list of Supported DNS - * record types. + * The identifier of a supported record type. See the list of Supported DNS record types. */ type?: string; } @@ -865,15 +706,7 @@ export namespace dns_v1beta2 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a consistent snapshot of a - * collection larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; /** @@ -886,9 +719,7 @@ export namespace dns_v1beta2 { */ export interface Schema$ResponseHeader { /** - * For mutating operation requests that completed successfully. This is the - * client_operation_id if the client specified it, otherwise it is generated - * by the server (output only). + * For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). */ operationId?: string; } @@ -1133,14 +964,11 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1160,19 +988,15 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The identifier of the requested change, from a previous - * ResourceRecordSetsChangeResponse. + * The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. */ changeId?: string; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1187,18 +1011,15 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1381,15 +1202,11 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * An optional comma-separated list of digest types to compute and display - * for key signing keys. If omitted, the recommended digest type will be - * computed and displayed. + * An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. */ digestType?: string; /** @@ -1397,8 +1214,7 @@ export namespace dns_v1beta2 { */ dnsKeyId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1413,24 +1229,19 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional comma-separated list of digest types to compute and display - * for key signing keys. If omitted, the recommended digest type will be - * computed and displayed. + * An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. */ digestType?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1618,9 +1429,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -1648,13 +1457,11 @@ export namespace dns_v1beta2 { */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -2138,9 +1945,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2161,14 +1966,11 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2183,14 +1985,11 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2210,13 +2009,11 @@ export namespace dns_v1beta2 { */ dnsName?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -2232,14 +2029,11 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2260,14 +2054,11 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2362,8 +2153,7 @@ export namespace dns_v1beta2 { /** * dns.policies.delete - * @desc Delete a previously created Policy. Will fail if the policy is - * still being referenced by a network. + * @desc Delete a previously created Policy. Will fail if the policy is still being referenced by a network. * @alias dns.policies.delete * @memberOf! () * @@ -2744,9 +2534,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2766,9 +2554,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2787,9 +2573,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2808,13 +2592,11 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -2829,9 +2611,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2855,9 +2635,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2961,9 +2739,7 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2980,8 +2756,7 @@ export namespace dns_v1beta2 { /** * dns.resourceRecordSets.list - * @desc Enumerate ResourceRecordSets that have been created but not yet - * deleted. + * @desc Enumerate ResourceRecordSets that have been created but not yet deleted. * @alias dns.resourceRecordSets.list * @memberOf! () * @@ -3076,23 +2851,19 @@ export namespace dns_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Restricts the list to return only records with this fully qualified - * domain name. + * Restricts the list to return only records with this fully qualified domain name. */ name?: string; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -3100,8 +2871,7 @@ export namespace dns_v1beta2 { */ project?: string; /** - * Restricts the list to return only records of this type. If present, the - * "name" parameter must also be present. + * Restricts the list to return only records of this type. If present, the "name" parameter must also be present. */ type?: string; } diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index 8b982f78167..b681d2ae397 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace dns_v2beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace dns_v2beta1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -100,7 +97,10 @@ export namespace dns_v2beta1 { resourceRecordSets: Resource$Resourcerecordsets; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.changes = new Resource$Changes(this.context); this.dnsKeys = new Resource$Dnskeys(this.context); @@ -114,13 +114,7 @@ export namespace dns_v2beta1 { } /** - * A Change represents a set of ResourceRecordSet additions and deletions - * applied atomically to a ManagedZone. ResourceRecordSets within a - * ManagedZone are modified by creating a new Change element in the Changes - * collection. In turn the Changes collection also records the past - * modifications to the ResourceRecordSets in a ManagedZone. The current state - * of the ManagedZone is the sum effect of applying all Change elements in the - * Changes collection in sequence. + * A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. */ export interface Schema$Change { /** @@ -140,25 +134,20 @@ export namespace dns_v2beta1 { */ isServing?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#change". + * Identifies what kind of resource this is. Value: the fixed string "dns#change". */ kind?: string; /** - * The time that this operation was started by the server (output only). - * This is in RFC3339 text format. + * The time that this operation was started by the server (output only). This is in RFC3339 text format. */ startTime?: string; /** - * Status of the operation (output only). A status of "done" means - * that the request to update the authoritative servers has been sent, but - * the servers might not be updated yet. + * Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ status?: string; } /** - * The response to a request to enumerate Changes to a ResourceRecordSets - * collection. + * The response to a request to enumerate Changes to a ResourceRecordSets collection. */ export interface Schema$ChangesListResponse { /** @@ -171,15 +160,7 @@ export namespace dns_v2beta1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a "snapshot" of - * collections larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ nextPageToken?: string; } @@ -188,25 +169,19 @@ export namespace dns_v2beta1 { */ export interface Schema$DnsKey { /** - * String mnemonic specifying the DNSSEC algorithm of this key. Immutable - * after creation time. + * String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. */ algorithm?: string; /** - * The time that this resource was created in the control plane. This is in - * RFC3339 text format. Output only. + * The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. */ creationTime?: string; /** - * A mutable string of at most 1024 characters associated with this resource - * for the user's convenience. Has no effect on the resource's - * function. + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. */ description?: string; /** - * Cryptographic hashes of the DNSKEY resource record associated with this - * DnsKey. These digests are needed to construct a DS record that points at - * this DNS key. Output only. + * Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. */ digests?: Schema$DnsKeyDigest[]; /** @@ -214,9 +189,7 @@ export namespace dns_v2beta1 { */ id?: string; /** - * Active keys will be used to sign subsequent changes to the ManagedZone. - * Inactive keys will still be present as DNSKEY Resource Records for the - * use of resolvers validating existing signatures. + * Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures. */ isActive?: boolean; /** @@ -224,18 +197,11 @@ export namespace dns_v2beta1 { */ keyLength?: number; /** - * The key tag is a non-cryptographic hash of the a DNSKEY resource record - * associated with this DnsKey. The key tag can be used to identify a DNSKEY - * more quickly (but it is not a unique identifier). In particular, the key - * tag is used in a parent zone's DS record to point at the DNSKEY in - * this child ManagedZone. The key tag is a number in the range [0, 65535] - * and the algorithm to calculate it is specified in RFC4034 Appendix B. - * Output only. + * The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. */ keyTag?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#dnsKey". + * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". */ kind?: string; /** @@ -243,18 +209,13 @@ export namespace dns_v2beta1 { */ publicKey?: string; /** - * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type - * KEY_SIGNING have the Secure Entry Point flag set and, when active, will - * be used to sign only resource record sets of type DNSKEY. Otherwise, the - * Secure Entry Point flag will be cleared and this key will be used to sign - * only resource record sets of other types. Immutable after creation time. + * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time. */ type?: string; } export interface Schema$DnsKeyDigest { /** - * The base-16 encoded bytes of this digest. Suitable for use in a DS - * resource record. + * The base-16 encoded bytes of this digest. Suitable for use in a DS resource record. */ digest?: string; /** @@ -276,21 +237,12 @@ export namespace dns_v2beta1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a "snapshot" of - * collections larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. */ nextPageToken?: string; } /** - * Parameters for DnsKey key generation. Used for generating initial keys for - * a new ManagedZone and as default when adding a new DnsKey. + * Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey. */ export interface Schema$DnsKeySpec { /** @@ -302,34 +254,24 @@ export namespace dns_v2beta1 { */ keyLength?: number; /** - * Specifies whether this is a key signing key (KSK) or a zone signing key - * (ZSK). Key signing keys have the Secure Entry Point flag set and, when - * active, will only be used to sign resource record sets of type DNSKEY. - * Zone signing keys do not have the Secure Entry Point flag set and will be - * used to sign all other types of resource record sets. + * Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. */ keyType?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#dnsKeySpec". + * Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec". */ kind?: string; } /** - * A zone is a subtree of the DNS namespace under one administrative - * responsibility. A ManagedZone is a resource that represents a DNS zone - * hosted by the Cloud DNS service. + * A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. */ export interface Schema$ManagedZone { /** - * The time that this resource was created on the server. This is in RFC3339 - * text format. Output only. + * The time that this resource was created on the server. This is in RFC3339 text format. Output only. */ creationTime?: string; /** - * A mutable string of at most 1024 characters associated with this resource - * for the user's convenience. Has no effect on the managed zone's - * function. + * A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. */ description?: string; /** @@ -345,8 +287,7 @@ export namespace dns_v2beta1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZone". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZone". */ kind?: string; /** @@ -354,47 +295,37 @@ export namespace dns_v2beta1 { */ labels?: {[key: string]: string}; /** - * User assigned name for this resource. Must be unique within the project. - * The name must be 1-63 characters long, must begin with a letter, end with - * a letter or digit, and only contain lowercase letters, digits or dashes. + * User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. */ name?: string; /** - * Delegate your managed_zone to these virtual name servers; defined by the - * server (output only) + * Delegate your managed_zone to these virtual name servers; defined by the server (output only) */ nameServers?: string[]; /** - * Optionally specifies the NameServerSet for this ManagedZone. A - * NameServerSet is a set of DNS name servers that all host the same - * ManagedZones. Most users will leave this field unset. + * Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. */ nameServerSet?: string; /** - * For privately visible zones, the set of Virtual Private Cloud resources - * that the zone is visible from. + * For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. */ privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; /** - * The zone's visibility: public zones are exposed to the Internet, - * while private zones are visible only to Virtual Private Cloud resources. + * The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. */ visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for - * this ManagedZone. Output only while state is not OFF. + * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZoneDnsSecConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig". */ kind?: string; /** - * Specifies the mechanism used to provide authenticated denial-of-existence - * responses. Output only while state is not OFF. + * Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. */ nonExistence?: string; /** @@ -409,15 +340,7 @@ export namespace dns_v2beta1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your page token. In this - * way you can retrieve the complete contents of even very large collections - * one page at a time. However, if the contents of the collection change - * between the first and last paginated list request, the set of all - * elements returned will be an inconsistent view of the collection. There - * is no way to retrieve a consistent snapshot of a collection larger than - * the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; /** @@ -427,8 +350,7 @@ export namespace dns_v2beta1 { } export interface Schema$ManagedZonePrivateVisibilityConfig { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePrivateVisibilityConfig". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". */ kind?: string; /** @@ -438,14 +360,11 @@ export namespace dns_v2beta1 { } export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#managedZonePrivateVisibilityConfigNetwork". + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfigNetwork". */ kind?: string; /** - * The fully qualified URL of the VPC network to bind to. This should be - * formatted like - * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} */ networkUrl?: string; } @@ -460,23 +379,12 @@ export namespace dns_v2beta1 { */ managedZones?: Schema$ManagedZone[]; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your page token. In this - * way you can retrieve the complete contents of even very large collections - * one page at a time. However, if the contents of the collection change - * between the first and last paginated list request, the set of all - * elements returned will be an inconsistent view of the collection. There - * is no way to retrieve a consistent snapshot of a collection larger than - * the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; } /** - * An operation represents a successful mutation performed on a Cloud DNS - * resource. Operations provide: - An audit log of server resource mutations. - * - A way to recover/retry API calls in the case where the response is never - * received by the caller. Use the caller specified client_operation_id. + * An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. */ export interface Schema$Operation { /** @@ -484,38 +392,27 @@ export namespace dns_v2beta1 { */ dnsKeyContext?: Schema$OperationDnsKeyContext; /** - * Unique identifier for the resource. This is the client_operation_id if - * the client specified it when the mutation was initiated, otherwise, it is - * generated by the server. The name must be 1-63 characters long and match - * the regular expression [-a-z0-9]? (output only) + * Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#operation". + * Identifies what kind of resource this is. Value: the fixed string "dns#operation". */ kind?: string; /** - * The time that this operation was started by the server. This is in - * RFC3339 text format (output only). + * The time that this operation was started by the server. This is in RFC3339 text format (output only). */ startTime?: string; /** - * Status of the operation. Can be one of the following: "PENDING" - * or "DONE" (output only). A status of "DONE" means - * that the request to update the authoritative servers has been sent, but - * the servers might not be updated yet. + * Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. */ status?: string; /** - * Type of the operation. Operations include insert, update, and delete - * (output only). + * Type of the operation. Operations include insert, update, and delete (output only). */ type?: string; /** - * User who requested the operation, for example: user@example.com. - * cloud-dns-system for operations automatically done by the system. (output - * only) + * User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) */ user?: string; /** @@ -544,9 +441,7 @@ export namespace dns_v2beta1 { oldValue?: Schema$ManagedZone; } /** - * A project resource. The project is a top level container for resources - * including Cloud DNS ManagedZones. Projects can be created only in the APIs - * console. + * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. */ export interface Schema$Project { /** @@ -554,13 +449,11 @@ export namespace dns_v2beta1 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#project". + * Identifies what kind of resource this is. Value: the fixed string "dns#project". */ kind?: string; /** - * Unique numeric identifier for the resource; defined by the server (output - * only). + * Unique numeric identifier for the resource; defined by the server (output only). */ number?: string; /** @@ -577,8 +470,7 @@ export namespace dns_v2beta1 { */ dnsKeysPerManagedZone?: number; /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#quota". + * Identifies what kind of resource this is. Value: the fixed string "dns#quota". */ kind?: string; /** @@ -586,13 +478,11 @@ export namespace dns_v2beta1 { */ managedZones?: number; /** - * Maximum allowed number of managed zones which can be attached to a - * network. + * Maximum allowed number of managed zones which can be attached to a network. */ managedZonesPerNetwork?: number; /** - * Maximum allowed number of networks to which a privately scoped zone can - * be attached. + * Maximum allowed number of networks to which a privately scoped zone can be attached. */ networksPerManagedZone?: number; /** @@ -600,13 +490,11 @@ export namespace dns_v2beta1 { */ resourceRecordsPerRrset?: number; /** - * Maximum allowed number of ResourceRecordSets to add per - * ChangesCreateRequest. + * Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. */ rrsetAdditionsPerChange?: number; /** - * Maximum allowed number of ResourceRecordSets to delete per - * ChangesCreateRequest. + * Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest. */ rrsetDeletionsPerChange?: number; /** @@ -614,8 +502,7 @@ export namespace dns_v2beta1 { */ rrsetsPerManagedZone?: number; /** - * Maximum allowed size for total rrdata in one ChangesCreateRequest in - * bytes. + * Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. */ totalRrdataSizePerChange?: number; /** @@ -628,8 +515,7 @@ export namespace dns_v2beta1 { */ export interface Schema$ResourceRecordSet { /** - * Identifies what kind of resource this is. Value: the fixed string - * "dns#resourceRecordSet". + * Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet". */ kind?: string; /** @@ -637,8 +523,7 @@ export namespace dns_v2beta1 { */ name?: string; /** - * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see - * examples. + * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. */ rrdatas?: string[]; /** @@ -650,8 +535,7 @@ export namespace dns_v2beta1 { */ ttl?: number; /** - * The identifier of a supported record type. See the list of Supported DNS - * record types. + * The identifier of a supported record type. See the list of Supported DNS record types. */ type?: string; } @@ -662,15 +546,7 @@ export namespace dns_v2beta1 { */ kind?: string; /** - * The presence of this field indicates that there exist more results - * following your last page of results in pagination order. To fetch them, - * make another list request using this value as your pagination token. In - * this way you can retrieve the complete contents of even very large - * collections one page at a time. However, if the contents of the - * collection change between the first and last paginated list request, the - * set of all elements returned will be an inconsistent view of the - * collection. There is no way to retrieve a consistent snapshot of a - * collection larger than the maximum page size. + * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size. */ nextPageToken?: string; /** @@ -683,9 +559,7 @@ export namespace dns_v2beta1 { */ export interface Schema$ResponseHeader { /** - * For mutating operation requests that completed successfully. This is the - * client_operation_id if the client specified it, otherwise it is generated - * by the server (output only). + * For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). */ operationId?: string; } @@ -705,14 +579,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -724,9 +596,8 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -752,10 +623,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -807,7 +677,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -840,14 +710,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -859,13 +727,11 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * - * // The identifier of the requested change, from a previous - * ResourceRecordSetsChangeResponse. changeId: 'my-change-id', // TODO: - * Update placeholder value. + * // The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. + * changeId: 'my-change-id', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -887,10 +753,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -942,7 +807,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -975,14 +840,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -994,9 +857,8 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1012,8 +874,8 @@ export namespace dns_v2beta1 { * return; * } * for (var i = 0; i < changesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `changesPage`: console.log(JSON.stringify(changesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `changesPage`: + * console.log(JSON.stringify(changesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1031,10 +893,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1090,7 +951,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1122,14 +983,11 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1149,19 +1007,15 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The identifier of the requested change, from a previous - * ResourceRecordSetsChangeResponse. + * The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. */ changeId?: string; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1176,18 +1030,15 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1219,14 +1070,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1238,9 +1087,8 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * // The identifier of the requested DnsKey. * dnsKeyId: 'my-dns-key-id', // TODO: Update placeholder value. @@ -1265,10 +1113,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1321,7 +1168,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1354,14 +1201,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1373,9 +1218,8 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1391,8 +1235,8 @@ export namespace dns_v2beta1 { * return; * } * for (var i = 0; i < dnsKeysPage.length; i++) { - * // TODO: Change code below to process each resource in - * `dnsKeysPage`: console.log(JSON.stringify(dnsKeysPage[i], null, 2)); + * // TODO: Change code below to process each resource in `dnsKeysPage`: + * console.log(JSON.stringify(dnsKeysPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1410,10 +1254,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1468,7 +1311,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1500,15 +1343,11 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * An optional comma-separated list of digest types to compute and display - * for key signing keys. If omitted, the recommended digest type will be - * computed and displayed. + * An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. */ digestType?: string; /** @@ -1516,8 +1355,7 @@ export namespace dns_v2beta1 { */ dnsKeyId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -1532,24 +1370,19 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional comma-separated list of digest types to compute and display - * for key signing keys. If omitted, the recommended digest type will be - * computed and displayed. + * An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. */ digestType?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1573,14 +1406,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1618,10 +1449,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1676,7 +1506,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1709,14 +1539,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1745,9 +1573,8 @@ export namespace dns_v2beta1 { * return; * } * for (var i = 0; i < operationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `operationsPage`: console.log(JSON.stringify(operationsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1765,10 +1592,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1828,7 +1654,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1866,9 +1692,7 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -1896,13 +1720,11 @@ export namespace dns_v2beta1 { */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -1930,14 +1752,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1973,10 +1793,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2030,7 +1849,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2062,14 +1881,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2081,9 +1898,8 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -2105,10 +1921,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2160,7 +1975,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2193,14 +2008,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2212,9 +2025,8 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -2236,10 +2048,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2292,7 +2103,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2325,14 +2136,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2358,9 +2167,8 @@ export namespace dns_v2beta1 { * return; * } * for (var i = 0; i < managedZonesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `managedZonesPage`: console.log(JSON.stringify(managedZonesPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `managedZonesPage`: + * console.log(JSON.stringify(managedZonesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2378,10 +2186,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2438,7 +2245,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2470,14 +2277,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2489,13 +2294,11 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -2519,10 +2322,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2577,7 +2379,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2610,14 +2412,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2629,13 +2429,11 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -2659,10 +2457,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2717,7 +2514,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2750,9 +2547,7 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -2773,14 +2568,11 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2795,14 +2587,11 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2822,13 +2611,11 @@ export namespace dns_v2beta1 { */ dnsName?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -2844,14 +2631,11 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2872,14 +2656,11 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** @@ -2908,14 +2689,12 @@ export namespace dns_v2beta1 { * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2947,10 +2726,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3000,7 +2778,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3032,9 +2810,7 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * For mutating operation requests only. An optional identifier specified by - * the client. Must be unique for operation resources in the Operations - * collection. + * For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. */ clientOperationId?: string; /** @@ -3051,22 +2827,19 @@ export namespace dns_v2beta1 { /** * dns.resourceRecordSets.list - * @desc Enumerate ResourceRecordSets that have been created but not yet - * deleted. + * @desc Enumerate ResourceRecordSets that have been created but not yet deleted. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud DNS API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dns - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3078,9 +2851,8 @@ export namespace dns_v2beta1 { * // Identifies the project addressed by this request. * project: 'my-project', // TODO: Update placeholder value. * - * // Identifies the managed zone addressed by this request. Can be the - * managed zone name or id. managedZone: 'my-managed-zone', // TODO: Update - * placeholder value. + * // Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * managedZone: 'my-managed-zone', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -3096,8 +2868,8 @@ export namespace dns_v2beta1 { * return; * } * for (var i = 0; i < rrsetsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `rrsetsPage`: console.log(JSON.stringify(rrsetsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `rrsetsPage`: + * console.log(JSON.stringify(rrsetsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -3115,10 +2887,9 @@ export namespace dns_v2beta1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3179,7 +2950,7 @@ export namespace dns_v2beta1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3217,23 +2988,19 @@ export namespace dns_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the managed zone addressed by this request. Can be the managed - * zone name or id. + * Identifies the managed zone addressed by this request. Can be the managed zone name or id. */ managedZone?: string; /** - * Optional. Maximum number of results to be returned. If unspecified, the - * server will decide how many results to return. + * Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. */ maxResults?: number; /** - * Restricts the list to return only records with this fully qualified - * domain name. + * Restricts the list to return only records with this fully qualified domain name. */ name?: string; /** - * Optional. A tag returned by a previous list request that was truncated. - * Use this parameter to continue a previous list request. + * Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. */ pageToken?: string; /** @@ -3241,8 +3008,7 @@ export namespace dns_v2beta1 { */ project?: string; /** - * Restricts the list to return only records of this type. If present, the - * "name" parameter must also be present. + * Restricts the list to return only records of this type. If present, the "name" parameter must also be present. */ type?: string; } diff --git a/src/apis/docs/package.json b/src/apis/docs/package.json index 58d67d68ea6..83131643608 100644 --- a/src/apis/docs/package.json +++ b/src/apis/docs/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 4ee6538b7d2..ceada3521ce 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace docs_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace docs_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,31 +108,29 @@ export namespace docs_v1 { documents: Resource$Documents; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.documents = new Resource$Documents(this.context); } } /** - * A ParagraphElement representing a spot in the text that is dynamically - * replaced with content that can change over time, like a page number. + * A ParagraphElement representing a spot in the text that is dynamically replaced with content that can change over time, like a page number. */ export interface Schema$AutoText { /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. An AutoText may have multiple insertion IDs - * if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. An AutoText may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** - * The suggested text style changes to this AutoText, keyed by suggestion - * ID. + * The suggested text style changes to this AutoText, keyed by suggestion ID. */ suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; /** @@ -158,14 +152,11 @@ export namespace docs_v1 { color?: Schema$OptionalColor; } /** - * A mask that indicates which of the fields on the base Background have been - * changed in this suggestion. For any field set to true, the Backgound has a - * new suggested value. + * A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. */ export interface Schema$BackgroundSuggestionState { /** - * Indicates whether the current background color has been modified in this - * suggestion. + * Indicates whether the current background color has been modified in this suggestion. */ backgroundColorSuggested?: boolean; } @@ -191,8 +182,7 @@ export namespace docs_v1 { */ documentId?: string; /** - * The reply of the updates. This maps 1:1 with the updates, although - * replies to some requests may be empty. + * The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */ replies?: Schema$Response[]; /** @@ -201,13 +191,11 @@ export namespace docs_v1 { writeControl?: Schema$WriteControl; } /** - * The document body. The body typically contains the full document contents - * except for headers, footers and footnotes. + * The document body. The body typically contains the full document contents except for headers, footers and footnotes. */ export interface Schema$Body { /** - * The contents of the body. The indexes for the body's content begin - * at zero. + * The contents of the body. The indexes for the body's content begin at zero. */ content?: Schema$StructuralElement[]; } @@ -229,9 +217,7 @@ export namespace docs_v1 { textStyle?: Schema$TextStyle; } /** - * A mask that indicates which of the fields on the base Bullet have been - * changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$BulletSuggestionState { /** @@ -243,8 +229,7 @@ export namespace docs_v1 { */ nestingLevelSuggested?: boolean; /** - * A mask that indicates which of the fields in text style have been changed - * in this suggestion. + * A mask that indicates which of the fields in text style have been changed in this suggestion. */ textStyleSuggestionState?: Schema$TextStyleSuggestionState; } @@ -258,30 +243,23 @@ export namespace docs_v1 { rgbColor?: Schema$RgbColor; } /** - * A ParagraphElement representing a column break. A column break makes the - * subsequent text start at the top of the next column. + * A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. */ export interface Schema$ColumnBreak { /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A ColumnBreak may have multiple insertion - * IDs if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** - * The suggested text style changes to this ColumnBreak, keyed by suggestion - * ID. + * The suggested text style changes to this ColumnBreak, keyed by suggestion ID. */ suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; /** - * The text style of this ColumnBreak. Similar to text content, like text - * runs and footnote references, the text style of a column break can affect - * content layout as well as the styling of text inserted adjacent to it. + * The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted adjacent to it. */ textStyle?: Schema$TextStyle; } @@ -290,9 +268,7 @@ export namespace docs_v1 { */ export interface Schema$CreateNamedRangeRequest { /** - * The name of the NamedRange. Names do not need to be unique. Names must - * be at least 1 character and no more than 256 characters, measured in - * UTF-16 code units. + * The name of the NamedRange. Names do not need to be unique. Names must be at least 1 character and no more than 256 characters, measured in UTF-16 code units. */ name?: string; /** @@ -310,14 +286,7 @@ export namespace docs_v1 { namedRangeId?: string; } /** - * Creates bullets for all of the paragraphs that overlap with the given - * range. The nesting level of each paragraph will be determined by counting - * leading tabs in front of each paragraph. To avoid excess space between the - * bullet and the corresponding paragraph, these leading tabs are removed by - * this request. This may change the indices of parts of the text. If the - * paragraph immediately before paragraphs being updated is in a list with a - * matching preset, the paragraphs being updated are added to that preceding - * list. + * Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. */ export interface Schema$CreateParagraphBulletsRequest { /** @@ -330,50 +299,32 @@ export namespace docs_v1 { range?: Schema$Range; } /** - * The crop properties of an image. The crop rectangle is represented using - * fractional offsets from the original content's four edges. - If the - * offset is in the interval (0, 1), the corresponding edge of crop rectangle - * is positioned inside of the image's original bounding rectangle. - If - * the offset is negative or greater than 1, the corresponding edge of crop - * rectangle is positioned outside of the image's original bounding - * rectangle. - If all offsets and rotation angle are 0, the image is not - * cropped. + * The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's four edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. */ export interface Schema$CropProperties { /** - * The clockwise rotation angle of the crop rectangle around its center, in - * radians. Rotation is applied after the offsets. + * The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. */ angle?: number; /** - * The offset specifies how far inwards the bottom edge of the crop - * rectangle is from the bottom edge of the original content as a fraction - * of the original content's height. + * The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. */ offsetBottom?: number; /** - * The offset specifies how far inwards the left edge of the crop rectangle - * is from the left edge of the original content as a fraction of the - * original content's width. + * The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. */ offsetLeft?: number; /** - * The offset specifies how far inwards the right edge of the crop rectangle - * is from the right edge of the original content as a fraction of the - * original content's width. + * The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. */ offsetRight?: number; /** - * The offset specifies how far inwards the top edge of the crop rectangle - * is from the top edge of the original content as a fraction of the - * original content's height. + * The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. */ offsetTop?: number; } /** - * A mask that indicates which of the fields on the base CropProperties have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$CropPropertiesSuggestionState { /** @@ -402,19 +353,7 @@ export namespace docs_v1 { */ export interface Schema$DeleteContentRangeRequest { /** - * The range of content to delete. Deleting text that crosses a paragraph - * boundary may result in changes to paragraph styles, lists, positioned - * objects and bookmarks as the two paragraphs are merged. Attempting to - * delete certain ranges can result in an invalid document structure in - * which case a 400 bad request error is returned. Some examples of invalid - * delete requests include: * Deleting one code unit of a surrogate pair. * - * Deleting the last newline character of a Body, Header, Footer, - * Footnote, TableCell or TableOfContents. * Deleting the start or end of a - * Table, TableOfContents or Equation without deleting the entire element. - * * Deleting the newline character before a Table, TableOfContents or - * SectionBreak without deleting the element. * Deleting individual rows - * or cells of a table. Deleting the content within a table cell is - * allowed. + * The range of content to delete. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles, lists, positioned objects and bookmarks as the two paragraphs are merged. Attempting to delete certain ranges can result in an invalid document structure in which case a 400 bad request error is returned. Some examples of invalid delete requests include: * Deleting one code unit of a surrogate pair. * Deleting the last newline character of a Body, Header, Footer, Footnote, TableCell or TableOfContents. * Deleting the start or end of a Table, TableOfContents or Equation without deleting the entire element. * Deleting the newline character before a Table, TableOfContents or SectionBreak without deleting the element. * Deleting individual rows or cells of a table. Deleting the content within a table cell is allowed. */ range?: Schema$Range; } @@ -423,8 +362,7 @@ export namespace docs_v1 { */ export interface Schema$DeleteNamedRangeRequest { /** - * The name of the range(s) to delete. All named ranges with the given name - * will be deleted. + * The name of the range(s) to delete. All named ranges with the given name will be deleted. */ name?: string; /** @@ -433,9 +371,7 @@ export namespace docs_v1 { namedRangeId?: string; } /** - * Deletes bullets from all of the paragraphs that overlap with the given - * range. The nesting level of each paragraph will be visually preserved by - * adding indent to the start of the corresponding paragraph. + * Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. */ export interface Schema$DeleteParagraphBulletsRequest { /** @@ -457,11 +393,7 @@ export namespace docs_v1 { */ export interface Schema$DeleteTableColumnRequest { /** - * The reference table cell location from which the column will be deleted. - * The column this cell spans will be deleted. If this is a merged cell that - * spans multiple columns, all columns that the cell spans will be deleted. - * If no columns remain in the table after this deletion, the whole table is - * deleted. + * The reference table cell location from which the column will be deleted. The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. */ tableCellLocation?: Schema$TableCellLocation; } @@ -470,10 +402,7 @@ export namespace docs_v1 { */ export interface Schema$DeleteTableRowRequest { /** - * The reference table cell location from which the row will be deleted. The - * row this cell spans will be deleted. If this is a merged cell that spans - * multiple rows, all rows that the cell spans will be deleted. If no rows - * remain in the table after this deletion, the whole table is deleted. + * The reference table cell location from which the row will be deleted. The row this cell spans will be deleted. If this is a merged cell that spans multiple rows, all rows that the cell spans will be deleted. If no rows remain in the table after this deletion, the whole table is deleted. */ tableCellLocation?: Schema$TableCellLocation; } @@ -539,34 +468,21 @@ export namespace docs_v1 { */ positionedObjects?: {[key: string]: Schema$PositionedObject}; /** - * The revision ID of the document. Can be used in update requests to - * specify which revision of a document to apply updates to and how the - * request should behave if the document has been edited since that - * revision. Only populated if the user has edit access to the document. The - * format of the revision ID may change over time, so it should be treated - * opaquely. A returned revision ID is only guaranteed to be valid for 24 - * hours after it has been returned and cannot be shared across users. If - * the revision ID is unchanged between calls, then the document has not - * changed. Conversely, a changed ID (for the same document and user) - * usually means the document has been updated; however, a changed ID can - * also be due to internal factors such as ID format changes. + * The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */ revisionId?: string; /** - * The suggested changes to the style of the document, keyed by suggestion - * ID. + * The suggested changes to the style of the document, keyed by suggestion ID. */ suggestedDocumentStyleChanges?: { [key: string]: Schema$SuggestedDocumentStyle; }; /** - * The suggested changes to the named styles of the document, keyed by - * suggestion ID. + * The suggested changes to the named styles of the document, keyed by suggestion ID. */ suggestedNamedStylesChanges?: {[key: string]: Schema$SuggestedNamedStyles}; /** - * The suggestions view mode applied to the document. Note: When editing a - * document, changes must be based on a document with SUGGESTIONS_INLINE. + * The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. */ suggestionsViewMode?: string; /** @@ -591,33 +507,19 @@ export namespace docs_v1 { */ defaultHeaderId?: string; /** - * The ID of the footer used only for even pages. The value of - * use_even_page_header_footer determines whether to use the - * default_footer_id or this value for the footer on even pages. If not set, - * there is no even page footer. + * The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there is no even page footer. */ evenPageFooterId?: string; /** - * The ID of the header used only for even pages. The value of - * use_even_page_header_footer determines whether to use the - * default_header_id or this value for the header on even pages. If not set, - * there is no even page header. + * The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there is no even page header. */ evenPageHeaderId?: string; /** - * The ID of the footer used only for the first page. If not set then a - * unique footer for the first page does not exist. The value of - * use_first_page_header_footer determines whether to use the - * default_footer_id or this value for the footer on the first page. If not - * set, there is no first page footer. + * The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there is no first page footer. */ firstPageFooterId?: string; /** - * The ID of the header used only for the first page. If not set then a - * unique header for the first page does not exist. The value of - * use_first_page_header_footer determines whether to use the - * default_header_id or this value for the header on the first page. If not - * set, there is no first page header. + * The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there is no first page header. */ firstPageHeaderId?: string; /** @@ -645,25 +547,20 @@ export namespace docs_v1 { */ pageSize?: Schema$Size; /** - * Indicates whether to use the even page header / footer IDs for the even - * pages. + * Indicates whether to use the even page header / footer IDs for the even pages. */ useEvenPageHeaderFooter?: boolean; /** - * Indicates whether to use the first page header / footer IDs for the first - * page. + * Indicates whether to use the first page header / footer IDs for the first page. */ useFirstPageHeaderFooter?: boolean; } /** - * A mask that indicates which of the fields on the base DocumentStyle have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$DocumentStyleSuggestionState { /** - * A mask that indicates which of the fields in background have been changed - * in this suggestion. + * A mask that indicates which of the fields in background have been changed in this suggestion. */ backgroundSuggestionState?: Schema$BackgroundSuggestionState; /** @@ -711,8 +608,7 @@ export namespace docs_v1 { */ pageNumberStartSuggested?: boolean; /** - * A mask that indicates which of the fields in size have been changed in - * this suggestion. + * A mask that indicates which of the fields in size have been changed in this suggestion. */ pageSizeSuggestionState?: Schema$SizeSuggestionState; /** @@ -720,8 +616,7 @@ export namespace docs_v1 { */ useEvenPageHeaderFooterSuggested?: boolean; /** - * Indicates if there was a suggested change to - * use_first_page_header_footer. + * Indicates if there was a suggested change to use_first_page_header_footer. */ useFirstPageHeaderFooterSuggested?: boolean; } @@ -730,9 +625,7 @@ export namespace docs_v1 { */ export interface Schema$EmbeddedDrawingProperties {} /** - * A mask that indicates which of the fields on the base - * EmbeddedDrawingProperties have been changed in this suggestion. For any - * field set to true, there is a new suggested value. + * A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$EmbeddedDrawingPropertiesSuggestionState {} /** @@ -740,8 +633,7 @@ export namespace docs_v1 { */ export interface Schema$EmbeddedObject { /** - * The description of the embedded object. The `title` and `description` are - * both combined to display alt text. + * The description of the embedded object. The `title` and `description` are both combined to display alt text. */ description?: string; /** @@ -757,9 +649,7 @@ export namespace docs_v1 { */ imageProperties?: Schema$ImageProperties; /** - * A reference to the external linked source content. For example, it - * contains a reference to the source Sheets chart when the embedded object - * is a linked chart. If unset, then the embedded object is not linked. + * A reference to the external linked source content. For example, it contains a reference to the source Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. */ linkedContentReference?: Schema$LinkedContentReference; /** @@ -783,8 +673,7 @@ export namespace docs_v1 { */ size?: Schema$Size; /** - * The title of the embedded object. The `title` and `description` are both - * combined to display alt text. + * The title of the embedded object. The `title` and `description` are both combined to display alt text. */ title?: string; } @@ -810,9 +699,7 @@ export namespace docs_v1 { width?: Schema$Dimension; } /** - * A mask that indicates which of the fields on the base EmbeddedObjectBorder - * have been changed in this suggestion. For any field set to true, there is a - * new suggested value. + * A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$EmbeddedObjectBorderSuggestionState { /** @@ -833,9 +720,7 @@ export namespace docs_v1 { widthSuggested?: boolean; } /** - * A mask that indicates which of the fields on the base EmbeddedObject have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$EmbeddedObjectSuggestionState { /** @@ -843,23 +728,19 @@ export namespace docs_v1 { */ descriptionSuggested?: boolean; /** - * A mask that indicates which of the fields in embedded_drawing_properties - * have been changed in this suggestion. + * A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. */ embeddedDrawingPropertiesSuggestionState?: Schema$EmbeddedDrawingPropertiesSuggestionState; /** - * A mask that indicates which of the fields in embedded_object_border have - * been changed in this suggestion. + * A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. */ embeddedObjectBorderSuggestionState?: Schema$EmbeddedObjectBorderSuggestionState; /** - * A mask that indicates which of the fields in image_properties have been - * changed in this suggestion. + * A mask that indicates which of the fields in image_properties have been changed in this suggestion. */ imagePropertiesSuggestionState?: Schema$ImagePropertiesSuggestionState; /** - * A mask that indicates which of the fields in linked_content_reference - * have been changed in this suggestion. + * A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. */ linkedContentReferenceSuggestionState?: Schema$LinkedContentReferenceSuggestionState; /** @@ -879,8 +760,7 @@ export namespace docs_v1 { */ marginTopSuggested?: boolean; /** - * A mask that indicates which of the fields in size have been changed in - * this suggestion. + * A mask that indicates which of the fields in size have been changed in this suggestion. */ sizeSuggestionState?: Schema$SizeSuggestionState; /** @@ -889,13 +769,11 @@ export namespace docs_v1 { titleSuggested?: boolean; } /** - * Location at the end of a body, header, footer or footnote. The location is - * immediately before the last newline in the document segment. + * Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. */ export interface Schema$EndOfSegmentLocation { /** - * The ID of the header, footer or footnote the location is in. An empty - * segment ID signifies the document's body. + * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */ segmentId?: string; } @@ -904,14 +782,11 @@ export namespace docs_v1 { */ export interface Schema$Equation { /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A Equation may have multiple insertion IDs - * if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. A Equation may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; } @@ -920,8 +795,7 @@ export namespace docs_v1 { */ export interface Schema$Footer { /** - * The contents of the footer. The indexes for a footer's content begin - * at zero. + * The contents of the footer. The indexes for a footer's content begin at zero. */ content?: Schema$StructuralElement[]; /** @@ -934,8 +808,7 @@ export namespace docs_v1 { */ export interface Schema$Footnote { /** - * The contents of the footnote. The indexes for a footnote's content - * begin at zero. + * The contents of the footnote. The indexes for a footnote's content begin at zero. */ content?: Schema$StructuralElement[]; /** @@ -944,14 +817,11 @@ export namespace docs_v1 { footnoteId?: string; } /** - * A ParagraphElement representing a footnote reference. A footnote reference - * is the inline content rendered with a number and is used to identify the - * footnote. + * A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. */ export interface Schema$FootnoteReference { /** - * The ID of the footnote that contains the content of this footnote - * reference. + * The ID of the footnote that contains the content of this footnote reference. */ footnoteId?: string; /** @@ -959,19 +829,15 @@ export namespace docs_v1 { */ footnoteNumber?: string; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A FootnoteReference may have multiple - * insertion IDs if it is a nested suggested change. If empty, then this is - * not a suggested insertion. + * The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** - * The suggested text style changes to this FootnoteReference, keyed by - * suggestion ID. + * The suggested text style changes to this FootnoteReference, keyed by suggestion ID. */ suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; /** @@ -984,8 +850,7 @@ export namespace docs_v1 { */ export interface Schema$Header { /** - * The contents of the header. The indexes for a header's content begin - * at zero. + * The contents of the header. The indexes for a header's content begin at zero. */ content?: Schema$StructuralElement[]; /** @@ -998,26 +863,19 @@ export namespace docs_v1 { */ export interface Schema$HorizontalRule { /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A HorizontalRule may have multiple insertion - * IDs if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** - * The suggested text style changes to this HorizontalRule, keyed by - * suggestion ID. + * The suggested text style changes to this HorizontalRule, keyed by suggestion ID. */ suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; /** - * The text style of this HorizontalRule. Similar to text content, like - * text runs and footnote references, the text style of a horizontal rule - * can affect content layout as well as the styling of text inserted - * adjacent to it. + * The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted adjacent to it. */ textStyle?: Schema$TextStyle; } @@ -1030,42 +888,32 @@ export namespace docs_v1 { */ angle?: number; /** - * The brightness effect of the image. The value should be in the interval - * [-1.0, 1.0], where 0 means no effect. + * The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. */ brightness?: number; /** - * A URI to the image with a default lifetime of 30 minutes. This URI is - * tagged with the account of the requester. Anyone with the URI effectively - * accesses the image as the original requester. Access to the image may be - * lost if the document's sharing settings change. + * A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. */ contentUri?: string; /** - * The contrast effect of the image. The value should be in the interval - * [-1.0, 1.0], where 0 means no effect. + * The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. */ contrast?: number; /** - * The crop properties of the image. After cropping, the image will be - * stretched to fit in its container. + * The crop properties of the image. After cropping, the image will be stretched to fit in its container. */ cropProperties?: Schema$CropProperties; /** - * The source URI is the URI used to insert the image. The source URI can be - * empty. + * The source URI is the URI used to insert the image. The source URI can be empty. */ sourceUri?: string; /** - * The transparency effect of the image. The value should be in the interval - * [0.0, 1.0], where 0 means no effect and 1 means completely transparent. + * The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. */ transparency?: number; } /** - * A mask that indicates which of the fields on the base ImageProperties have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$ImagePropertiesSuggestionState { /** @@ -1085,8 +933,7 @@ export namespace docs_v1 { */ contrastSuggested?: boolean; /** - * A mask that indicates which of the fields in crop_properties have been - * changed in this suggestion. + * A mask that indicates which of the fields in crop_properties have been changed in this suggestion. */ cropPropertiesSuggestionState?: Schema$CropPropertiesSuggestionState; /** @@ -1099,8 +946,7 @@ export namespace docs_v1 { transparencySuggested?: boolean; } /** - * An object that appears inline with text. An InlineObject contains an - * EmbeddedObject such as an image. + * An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. */ export interface Schema$InlineObject { /** @@ -1112,20 +958,17 @@ export namespace docs_v1 { */ objectId?: string; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested changes to the inline object properties, keyed by - * suggestion ID. + * The suggested changes to the inline object properties, keyed by suggestion ID. */ suggestedInlineObjectPropertiesChanges?: { [key: string]: Schema$SuggestedInlineObjectProperties; }; /** - * The suggested insertion ID. If empty, then this is not a suggested - * insertion. + * The suggested insertion ID. If empty, then this is not a suggested insertion. */ suggestedInsertionId?: string; } @@ -1138,26 +981,19 @@ export namespace docs_v1 { */ inlineObjectId?: string; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. An InlineObjectElement may have multiple - * insertion IDs if it is a nested suggested change. If empty, then this is - * not a suggested insertion. + * The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** - * The suggested text style changes to this InlineObject, keyed by - * suggestion ID. + * The suggested text style changes to this InlineObject, keyed by suggestion ID. */ suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; /** - * The text style of this InlineObjectElement. Similar to text content, - * like text runs and footnote references, the text style of an inline - * object element can affect content layout as well as the styling of text - * inserted adjacent to it. + * The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted adjacent to it. */ textStyle?: Schema$TextStyle; } @@ -1171,14 +1007,11 @@ export namespace docs_v1 { embeddedObject?: Schema$EmbeddedObject; } /** - * A mask that indicates which of the fields on the base - * InlineObjectProperties have been changed in this suggestion. For any field - * set to true, there is a new suggested value. + * A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$InlineObjectPropertiesSuggestionState { /** - * A mask that indicates which of the fields in embedded_object have been - * changed in this suggestion. + * A mask that indicates which of the fields in embedded_object have been changed in this suggestion. */ embeddedObjectSuggestionState?: Schema$EmbeddedObjectSuggestionState; } @@ -1187,36 +1020,19 @@ export namespace docs_v1 { */ export interface Schema$InsertInlineImageRequest { /** - * Inserts the text at the end of a header, footer or the document body. - * Inline images cannot be inserted inside a footnote. + * Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote. */ endOfSegmentLocation?: Schema$EndOfSegmentLocation; /** - * Inserts the image at a specific index in the document. The image must be - * inserted inside the bounds of an existing Paragraph. For instance, it - * cannot be inserted at a table's start index (i.e. between the table - * and its preceding paragraph). Inline images cannot be inserted inside a - * footnote or equation. + * Inserts the image at a specific index in the document. The image must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Inline images cannot be inserted inside a footnote or equation. */ location?: Schema$Location; /** - * The size that the image should appear as in the document. This property - * is optional and the final size of the image in the document is determined - * by the following rules: * If neither width nor height is specified, then - * a default size of the image is calculated based on its resolution. * If - * one dimension is specified then the other dimension is calculated to - * preserve the aspect ratio of the image. * If both width and height are - * specified, the image is scaled to fit within the provided dimensions - * while maintaining its aspect ratio. + * The size that the image should appear as in the document. This property is optional and the final size of the image in the document is determined by the following rules: * If neither width nor height is specified, then a default size of the image is calculated based on its resolution. * If one dimension is specified then the other dimension is calculated to preserve the aspect ratio of the image. * If both width and height are specified, the image is scaled to fit within the provided dimensions while maintaining its aspect ratio. */ objectSize?: Schema$Size; /** - * The image URI. The image is fetched once at insertion time and a copy is - * stored for display inside the document. Images must be less than 50MB in - * size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or - * GIF format. The provided URI can be at most 2 kB in length. The URI - * itself is saved with the image, and exposed via the - * ImageProperties.content_uri field. + * The image URI. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI can be at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field. */ uri?: string; } @@ -1243,25 +1059,29 @@ export namespace docs_v1 { */ export interface Schema$InsertPageBreakRequest { /** - * Inserts the page break at the end of the document body. Page breaks - * cannot be inserted inside a footnote, header or footer. Since page breaks - * can only be inserted inside the body, the segment ID field must be empty. + * Inserts the page break at the end of the document body. Page breaks cannot be inserted inside a footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. */ endOfSegmentLocation?: Schema$EndOfSegmentLocation; /** - * Inserts the page break at a specific index in the document. The page - * break must be inserted inside the bounds of an existing Paragraph. For - * instance, it cannot be inserted at a table's start index (i.e. - * between the table and its preceding paragraph). Page breaks cannot be - * inserted inside a table, equation, footnote, header or footer. Since page - * breaks can only be inserted inside the body, the segment ID field must be - * empty. + * Inserts the page break at a specific index in the document. The page break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Page breaks cannot be inserted inside a table, equation, footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. */ location?: Schema$Location; } /** - * Inserts a table at the specified location. A newline character will be - * inserted before the inserted table. + * Inserts an empty column into a table. + */ + export interface Schema$InsertTableColumnRequest { + /** + * Whether to insert new column to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left. + */ + insertRight?: boolean; + /** + * The reference table cell location from which columns will be inserted. A new column will be inserted to the left (or right) of the column where the reference cell is. If the reference cell is a merged cell, a new column will be inserted to the left (or right) of the merged cell. + */ + tableCellLocation?: Schema$TableCellLocation; + } + /** + * Inserts a table at the specified location. A newline character will be inserted before the inserted table. */ export interface Schema$InsertTableRequest { /** @@ -1269,19 +1089,11 @@ export namespace docs_v1 { */ columns?: number; /** - * Inserts the table at the end of the given header, footer or document - * body. A newline character will be inserted before the inserted table. - * Tables cannot be inserted inside a footnote. + * Inserts the table at the end of the given header, footer or document body. A newline character will be inserted before the inserted table. Tables cannot be inserted inside a footnote. */ endOfSegmentLocation?: Schema$EndOfSegmentLocation; /** - * Inserts the table at a specific model index. A newline character will be - * inserted before the inserted table, therefore the table start index will - * be at the specified location index + 1. The table must be inserted - * inside the bounds of an existing Paragraph. For instance, it cannot be - * inserted at a table's start index (i.e. between an existing table and - * its preceding paragraph). Tables cannot be inserted inside a footnote or - * equation. + * Inserts the table at a specific model index. A newline character will be inserted before the inserted table, therefore the table start index will be at the specified location index + 1. The table must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph). Tables cannot be inserted inside a footnote or equation. */ location?: Schema$Location; /** @@ -1294,15 +1106,11 @@ export namespace docs_v1 { */ export interface Schema$InsertTableRowRequest { /** - * Whether to insert new row below the reference cell location. - `True`: - * insert below the cell. - `False`: insert above the cell. + * Whether to insert new row below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell. */ insertBelow?: boolean; /** - * The reference table cell location from which rows will be inserted. A - * new row will be inserted above (or below) the row where the reference - * cell is. If the reference cell is a merged cell, a new row will be - * inserted above (or below) the merged cell. + * The reference table cell location from which rows will be inserted. A new row will be inserted above (or below) the row where the reference cell is. If the reference cell is a merged cell, a new row will be inserted above (or below) the merged cell. */ tableCellLocation?: Schema$TableCellLocation; } @@ -1311,29 +1119,15 @@ export namespace docs_v1 { */ export interface Schema$InsertTextRequest { /** - * Inserts the text at the end of a header, footer, footnote or the document - * body. + * Inserts the text at the end of a header, footer, footnote or the document body. */ endOfSegmentLocation?: Schema$EndOfSegmentLocation; /** - * Inserts the text at a specific index in the document. Text must be - * inserted inside the bounds of an existing Paragraph. For instance, text - * cannot be inserted at a table's start index (i.e. between the table - * and its preceding paragraph). The text must be inserted in the preceding - * paragraph. + * Inserts the text at a specific index in the document. Text must be inserted inside the bounds of an existing Paragraph. For instance, text cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The text must be inserted in the preceding paragraph. */ location?: Schema$Location; /** - * The text to be inserted. Inserting a newline character will implicitly - * create a new Paragraph at that index. The paragraph style of the new - * paragraph will be copied from the paragraph at the current insertion - * index, including lists and bullets. Text styles for inserted text will - * be determined automatically, generally preserving the styling of - * neighboring text. In most cases, the text style for the inserted text - * will match the text immediately before the insertion index. Some control - * characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode - * Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be - * stripped out of the inserted text. + * The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. */ text?: string; } @@ -1364,21 +1158,16 @@ export namespace docs_v1 { sheetsChartReference?: Schema$SheetsChartReference; } /** - * A mask that indicates which of the fields on the base - * LinkedContentReference have been changed in this suggestion. For any field - * set to true, there is a new suggested value. + * A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$LinkedContentReferenceSuggestionState { /** - * A mask that indicates which of the fields in sheets_chart_reference have - * been changed in this suggestion. + * A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. */ sheetsChartReferenceSuggestionState?: Schema$SheetsChartReferenceSuggestionState; } /** - * A List represents the list attributes for a group of paragraphs that all - * belong to the same list. A paragraph that is part of a list has a reference - * to the list's ID in its bullet. + * A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that is part of a list has a reference to the list's ID in its bullet. */ export interface Schema$List { /** @@ -1386,13 +1175,11 @@ export namespace docs_v1 { */ listProperties?: Schema$ListProperties; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this list. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this list. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion ID. If empty, then this is not a suggested - * insertion. + * The suggested insertion ID. If empty, then this is not a suggested insertion. */ suggestedInsertionId?: string; /** @@ -1403,30 +1190,20 @@ export namespace docs_v1 { }; } /** - * The properties of a list which describe the look and feel of bullets - * belonging to paragraphs associated with a list. + * The properties of a list which describe the look and feel of bullets belonging to paragraphs associated with a list. */ export interface Schema$ListProperties { /** - * Describes the properties of the bullets at the associated level. A list - * has at most nine levels of nesting with nesting level 0 corresponding to - * the top-most level and nesting level 8 corresponding to the most nested - * level. The nesting levels are returned in ascending order with the least - * nested returned first. + * Describes the properties of the bullets at the associated level. A list has at most nine levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. */ nestingLevels?: Schema$NestingLevel[]; } /** - * A mask that indicates which of the fields on the base ListProperties have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$ListPropertiesSuggestionState { /** - * A mask that indicates which of the fields on the corresponding - * NestingLevel in nesting_levels have been changed in this suggestion. The - * nesting level suggestion states are returned in ascending order of the - * nesting level with the least nested returned first. + * A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. */ nestingLevelsSuggestionStates?: Schema$NestingLevelSuggestionState[]; } @@ -1435,26 +1212,16 @@ export namespace docs_v1 { */ export interface Schema$Location { /** - * The zero-based index, in UTF-16 code units. The index is relative to the - * beginning of the segment specified by segment_id. + * The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. */ index?: number; /** - * The ID of the header, footer or footnote the location is in. An empty - * segment ID signifies the document's body. + * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */ segmentId?: string; } /** - * A collection of Ranges with the same named range ID. Named ranges allow - * developers to associate parts of a document with an arbitrary user-defined - * label so their contents can be programmatically read or edited at a later - * time. A document can contain multiple named ranges with the same name, but - * every named range has a unique ID. A named range is created with a single - * Range, and content inserted inside a named range generally expands that - * range. However, certain document changes can cause the range to be split - * into multiple ranges. Named ranges are not private. All applications and - * collaborators that have access to the document can see its named ranges. + * A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited at a later time. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. */ export interface Schema$NamedRange { /** @@ -1471,8 +1238,7 @@ export namespace docs_v1 { ranges?: Schema$Range[]; } /** - * A collection of all the NamedRanges in the document that share a given - * name. + * A collection of all the NamedRanges in the document that share a given name. */ export interface Schema$NamedRanges { /** @@ -1485,9 +1251,7 @@ export namespace docs_v1 { namedRanges?: Schema$NamedRange[]; } /** - * A named style. Paragraphs in the document can inherit their TextStyle and - * ParagraphStyle from this named style when they have the same named style - * type. + * A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. */ export interface Schema$NamedStyle { /** @@ -1504,13 +1268,11 @@ export namespace docs_v1 { textStyle?: Schema$TextStyle; } /** - * The named styles. Paragraphs in the document can inherit their TextStyle - * and ParagraphStyle from these named styles. + * The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. */ export interface Schema$NamedStyles { /** - * The named styles. There is an entry for each of the possible named style - * types. + * The named styles. There is an entry for each of the possible named style types. */ styles?: Schema$NamedStyle[]; } @@ -1519,10 +1281,7 @@ export namespace docs_v1 { */ export interface Schema$NamedStylesSuggestionState { /** - * A mask that indicates which of the fields on the corresponding NamedStyle - * in styles have been changed in this suggestion. The order of these named - * style suggestion states match the order of the corresponding named style - * within the named styles suggestion. + * A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states match the order of the corresponding named style within the named styles suggestion. */ stylesSuggestionStates?: Schema$NamedStyleSuggestionState[]; } @@ -1531,92 +1290,48 @@ export namespace docs_v1 { */ export interface Schema$NamedStyleSuggestionState { /** - * The named style type that this suggestion state corresponds to. This - * field is provided as a convenience for matching the - * NamedStyleSuggestionState with its corresponding NamedStyle. + * The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. */ namedStyleType?: string; /** - * A mask that indicates which of the fields in paragraph style have been - * changed in this suggestion. + * A mask that indicates which of the fields in paragraph style have been changed in this suggestion. */ paragraphStyleSuggestionState?: Schema$ParagraphStyleSuggestionState; /** - * A mask that indicates which of the fields in text style have been changed - * in this suggestion. + * A mask that indicates which of the fields in text style have been changed in this suggestion. */ textStyleSuggestionState?: Schema$TextStyleSuggestionState; } /** - * Contains properties describing the look and feel of a list bullet at a - * given level of nesting. + * Contains properties describing the look and feel of a list bullet at a given level of nesting. */ export interface Schema$NestingLevel { /** - * The alignment of the bullet within the space allotted for rendering the - * bullet. + * The alignment of the bullet within the space allotted for rendering the bullet. */ bulletAlignment?: string; /** - * The format string used by bullets at this level of nesting. The glyph - * format contains one or more placeholders, and these placeholder are - * replaced with the appropriate values depending on the glyph_type or - * glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. - * Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph - * format follows the pattern - * `<prefix>%[nesting_level]<suffix>`. Note that the prefix and - * suffix are optional and can be arbitrary strings. For example, the glyph - * format `%0.` indicates that the rendered glyph will replace the - * placeholder with the corresponding glyph for nesting level 0 followed by - * a period as the suffix. So a list with a glyph type of UPPER_ALPHA and - * glyph format `%0.` at nesting level 0 will result in a list with rendered - * glyphs <p>`A.` <p>`B.` <p>`C.` The glyph format can - * contain placeholders for the current nesting level as well as - * placeholders for parent nesting levels. For example, a list can have a - * glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` - * at nesting level 1. Assuming both nesting levels have DECIMAL glyph - * types, this would result in a list with rendered glyphs <p>`1.` - * <p>`2.` <p>` 2.1.` <p>` 2.2.` <p>`3.` For - * nesting levels that are ordered, the string that replaces a placeholder - * in the glyph format for a particular paragraph depends on the - * paragraph's order within the list. + * The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholder are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `<prefix>%[nesting_level]<suffix>`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs <p>`A.` <p>`B.` <p>`C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs <p>`1.` <p>`2.` <p>` 2.1.` <p>` 2.2.` <p>`3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. */ glyphFormat?: string; /** - * A custom glyph symbol used by bullets when paragraphs at this level of - * nesting are unordered. The glyph symbol replaces placeholders within the - * glyph_format. For example, if the glyph_symbol is the solid circle - * corresponding to Unicode U+25cf code point and the glyph_format is `%0`, - * the rendered glyph would be the solid circle. + * A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. */ glyphSymbol?: string; /** - * The type of glyph used by bullets when paragraphs at this level of - * nesting are ordered. The glyph type determines the type of glyph used to - * replace placeholders within the glyph_format when paragraphs at this - * level of nesting are ordered. For example, if the nesting level is 0, the - * glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered - * glyph would replace the placeholder `%0` in the glyph format with a - * number corresponding to list item's order within the list. + * The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. */ glyphType?: string; /** - * The amount of indentation for the first line of paragraphs at this level - * of nesting. + * The amount of indentation for the first line of paragraphs at this level of nesting. */ indentFirstLine?: Schema$Dimension; /** - * The amount of indentation for paragraphs at this level of nesting. - * Applied to the side that corresponds to the start of the text, based on - * the paragraph's content direction. + * The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. */ indentStart?: Schema$Dimension; /** - * The number of the first list item at this nesting level. A value of 0 is - * treated as a value of 1 for lettered lists and roman numeraled lists, - * i.e. for values of both 0 and 1, lettered and roman numeraled lists will - * begin at `a` and `i` respectively. This value is ignored for nesting - * levels with unordered glyphs. + * The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and roman numeraled lists, i.e. for values of both 0 and 1, lettered and roman numeraled lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. */ startNumber?: number; /** @@ -1625,9 +1340,7 @@ export namespace docs_v1 { textStyle?: Schema$TextStyle; } /** - * A mask that indicates which of the fields on the base NestingLevel have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$NestingLevelSuggestionState { /** @@ -1659,8 +1372,7 @@ export namespace docs_v1 { */ startNumberSuggested?: boolean; /** - * A mask that indicates which of the fields in text style have been changed - * in this suggestion. + * A mask that indicates which of the fields in text style have been changed in this suggestion. */ textStyleSuggestionState?: Schema$TextStyleSuggestionState; } @@ -1678,47 +1390,37 @@ export namespace docs_v1 { */ export interface Schema$OptionalColor { /** - * If set, this will be used as an opaque color. If unset, this represents a - * transparent color. + * If set, this will be used as an opaque color. If unset, this represents a transparent color. */ color?: Schema$Color; } /** - * A ParagraphElement representing a page break. A page break makes the - * subsequent text start at the top of the next page. + * A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. */ export interface Schema$PageBreak { /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A PageBreak may have multiple insertion IDs - * if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** - * The suggested text style changes to this PageBreak, keyed by suggestion - * ID. + * The suggested text style changes to this PageBreak, keyed by suggestion ID. */ suggestedTextStyleChanges?: {[key: string]: Schema$SuggestedTextStyle}; /** - * The text style of this PageBreak. Similar to text content, like text - * runs and footnote references, the text style of a page break can affect - * content layout as well as the styling of text inserted adjacent to it. + * The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted adjacent to it. */ textStyle?: Schema$TextStyle; } /** - * A StructuralElement representing a paragraph. A paragraph is a range of - * content that is terminated with a newline character. + * A StructuralElement representing a paragraph. A paragraph is a range of content that is terminated with a newline character. */ export interface Schema$Paragraph { /** - * The bullet for this paragraph. If not present, the paragraph does not - * belong to a list. + * The bullet for this paragraph. If not present, the paragraph does not belong to a list. */ bullet?: Schema$Bullet; /** @@ -1738,15 +1440,13 @@ export namespace docs_v1 { */ suggestedBulletChanges?: {[key: string]: Schema$SuggestedBullet}; /** - * The suggested paragraph style changes to this paragraph, keyed by - * suggestion ID. + * The suggested paragraph style changes to this paragraph, keyed by suggestion ID. */ suggestedParagraphStyleChanges?: { [key: string]: Schema$SuggestedParagraphStyle; }; /** - * The IDs of the positioned objects that are suggested to be attached to - * this paragraph, keyed by suggestion ID. + * The IDs of the positioned objects that are suggested to be attached to this paragraph, keyed by suggestion ID. */ suggestedPositionedObjectIds?: {[key: string]: Schema$ObjectReferences}; } @@ -1784,8 +1484,7 @@ export namespace docs_v1 { */ columnBreak?: Schema$ColumnBreak; /** - * The zero-base end index of this paragraph element, exclusive, in UTF-16 - * code units. + * The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. */ endIndex?: number; /** @@ -1809,8 +1508,7 @@ export namespace docs_v1 { */ pageBreak?: Schema$PageBreak; /** - * The zero-based start index of this paragraph element, in UTF-16 code - * units. + * The zero-based start index of this paragraph element, in UTF-16 code units. */ startIndex?: number; /** @@ -1819,17 +1517,7 @@ export namespace docs_v1 { textRun?: Schema$TextRun; } /** - * Styles that apply to a whole paragraph. Inherited paragraph styles are - * represented as unset fields in this message. A paragraph style's parent - * depends on where the paragraph style is defined: * The ParagraphStyle on - * a Paragraph inherits from the paragraph's corresponding named style - * type. * The ParagraphStyle on a named style inherits from the normal - * text named style. * The ParagraphStyle of the normal text named style - * inherits from the default paragraph style in the Docs editor. * The - * ParagraphStyle on a Paragraph element that is contained in a table may - * inherit its paragraph style from the table style. If the paragraph - * style does not inherit from a parent, unsetting fields will revert the - * style to a value matching the defaults in the Docs editor. + * Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that is contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. */ export interface Schema$ParagraphStyle { /** @@ -1837,112 +1525,75 @@ export namespace docs_v1 { */ alignment?: string; /** - * Whether to avoid widows and orphans for the paragraph. If unset, the - * value is inherited from the parent. + * Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. */ avoidWidowAndOrphan?: boolean; /** - * The border between this paragraph and the next and previous paragraphs. - * If unset, the value is inherited from the parent. The between border is - * rendered when the adjacent paragraph has the same border and indent - * properties. Paragraph borders cannot be partially updated. When making - * changes to a paragraph border the new border must be specified in its - * entirety. + * The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety. */ borderBetween?: Schema$ParagraphBorder; /** - * The border at the bottom of this paragraph. If unset, the value is - * inherited from the parent. The bottom border is rendered when the - * paragraph below has different border and indent properties. Paragraph - * borders cannot be partially updated. When making changes to a paragraph - * border the new border must be specified in its entirety. + * The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety. */ borderBottom?: Schema$ParagraphBorder; /** - * The border to the left of this paragraph. If unset, the value is - * inherited from the parent. Paragraph borders cannot be partially - * updated. When making changes to a paragraph border the new border must be - * specified in its entirety. + * The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety. */ borderLeft?: Schema$ParagraphBorder; /** - * The border to the right of this paragraph. If unset, the value is - * inherited from the parent. Paragraph borders cannot be partially - * updated. When making changes to a paragraph border the new border must be - * specified in its entirety. + * The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety. */ borderRight?: Schema$ParagraphBorder; /** - * The border at the top of this paragraph. If unset, the value is inherited - * from the parent. The top border is rendered when the paragraph above has - * different border and indent properties. Paragraph borders cannot be - * partially updated. When making changes to a paragraph border the new - * border must be specified in its entirety. + * The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety. */ borderTop?: Schema$ParagraphBorder; /** - * The text direction of this paragraph. If unset, the value defaults to - * LEFT_TO_RIGHT since paragraph direction is not inherited. + * The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. */ direction?: string; /** - * The heading ID of the paragraph. If empty, then this paragraph is not a - * heading. This property is read-only. + * The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. */ headingId?: string; /** - * The amount of indentation for the paragraph on the side that corresponds - * to the end of the text, based on the current paragraph direction. If - * unset, the value is inherited from the parent. + * The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. */ indentEnd?: Schema$Dimension; /** - * The amount of indentation for the first line of the paragraph. If unset, - * the value is inherited from the parent. + * The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. */ indentFirstLine?: Schema$Dimension; /** - * The amount of indentation for the paragraph on the side that corresponds - * to the start of the text, based on the current paragraph direction. If - * unset, the value is inherited from the parent. + * The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. */ indentStart?: Schema$Dimension; /** - * Whether all lines of the paragraph should be laid out on the same page or - * column if possible. If unset, the value is inherited from the parent. + * Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. */ keepLinesTogether?: boolean; /** - * Whether at least a part of this paragraph should be laid out on the same - * page or column as the next paragraph if possible. If unset, the value is - * inherited from the parent. + * Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. */ keepWithNext?: boolean; /** - * The amount of space between lines, as a percentage of normal, where - * normal is represented as 100.0. If unset, the value is inherited from the - * parent. + * The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. */ lineSpacing?: number; /** - * The named style type of the paragraph. Since updating the named style - * type affects other properties within ParagraphStyle, the named style type - * is applied before the other properties are updated. + * The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. */ namedStyleType?: string; /** - * The shading of the paragraph. If unset, the value is inherited from the - * parent. + * The shading of the paragraph. If unset, the value is inherited from the parent. */ shading?: Schema$Shading; /** - * The amount of extra space above the paragraph. If unset, the value is - * inherited from the parent. + * The amount of extra space above the paragraph. If unset, the value is inherited from the parent. */ spaceAbove?: Schema$Dimension; /** - * The amount of extra space below the paragraph. If unset, the value is - * inherited from the parent. + * The amount of extra space below the paragraph. If unset, the value is inherited from the parent. */ spaceBelow?: Schema$Dimension; /** @@ -1950,15 +1601,12 @@ export namespace docs_v1 { */ spacingMode?: string; /** - * A list of the tab stops for this paragraph. The list of tab stops is not - * inherited. This property is read-only. + * A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. */ tabStops?: Schema$TabStop[]; } /** - * A mask that indicates which of the fields on the base ParagraphStyle have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$ParagraphStyleSuggestionState { /** @@ -2026,8 +1674,7 @@ export namespace docs_v1 { */ namedStyleTypeSuggested?: boolean; /** - * A mask that indicates which of the fields in shading have been changed in - * this suggestion. + * A mask that indicates which of the fields in shading have been changed in this suggestion. */ shadingSuggestionState?: Schema$ShadingSuggestionState; /** @@ -2044,9 +1691,7 @@ export namespace docs_v1 { spacingModeSuggested?: boolean; } /** - * An object that is tethered to a Paragraph and positioned relative to the - * beginning of the paragraph. A PositionedObject contains an EmbeddedObject - * such as an image. + * An object that is tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. */ export interface Schema$PositionedObject { /** @@ -2058,26 +1703,22 @@ export namespace docs_v1 { */ positionedObjectProperties?: Schema$PositionedObjectProperties; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion ID. If empty, then this is not a suggested - * insertion. + * The suggested insertion ID. If empty, then this is not a suggested insertion. */ suggestedInsertionId?: string; /** - * The suggested changes to the positioned object properties, keyed by - * suggestion ID. + * The suggested changes to the positioned object properties, keyed by suggestion ID. */ suggestedPositionedObjectPropertiesChanges?: { [key: string]: Schema$SuggestedPositionedObjectProperties; }; } /** - * The positioning of a PositionedObject. The positioned object is positioned - * relative to the beginning of the Paragraph it is tethered to. + * The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it is tethered to. */ export interface Schema$PositionedObjectPositioning { /** @@ -2085,24 +1726,16 @@ export namespace docs_v1 { */ layout?: string; /** - * The offset of the left edge of the positioned object relative to the - * beginning of the Paragraph it is tethered to. The exact positioning of - * the object can depend on other content in the document and the - * document's styling. + * The offset of the left edge of the positioned object relative to the beginning of the Paragraph it is tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. */ leftOffset?: Schema$Dimension; /** - * The offset of the top edge of the positioned object relative to the - * beginning of the Paragraph it is tethered to. The exact positioning of - * the object can depend on other content in the document and the - * document's styling. + * The offset of the top edge of the positioned object relative to the beginning of the Paragraph it is tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. */ topOffset?: Schema$Dimension; } /** - * A mask that indicates which of the fields on the base - * PositionedObjectPositioning have been changed in this suggestion. For any - * field set to true, there is a new suggested value. + * A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$PositionedObjectPositioningSuggestionState { /** @@ -2127,25 +1760,20 @@ export namespace docs_v1 { */ embeddedObject?: Schema$EmbeddedObject; /** - * The positioning of this positioned object relative to the newline of the - * Paragraph that references this positioned object. + * The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. */ positioning?: Schema$PositionedObjectPositioning; } /** - * A mask that indicates which of the fields on the base - * PositionedObjectProperties have been changed in this suggestion. For any - * field set to true, there is a new suggested value. + * A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$PositionedObjectPropertiesSuggestionState { /** - * A mask that indicates which of the fields in embedded_object have been - * changed in this suggestion. + * A mask that indicates which of the fields in embedded_object have been changed in this suggestion. */ embeddedObjectSuggestionState?: Schema$EmbeddedObjectSuggestionState; /** - * A mask that indicates which of the fields in positioning have been - * changed in this suggestion. + * A mask that indicates which of the fields in positioning have been changed in this suggestion. */ positioningSuggestionState?: Schema$PositionedObjectPositioningSuggestionState; } @@ -2154,21 +1782,15 @@ export namespace docs_v1 { */ export interface Schema$Range { /** - * The zero-based end index of this range, exclusive, in UTF-16 code units. - * In all current uses, an end index must be provided. This field is an - * Int32Value in order to accommodate future use cases with open-ended - * ranges. + * The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */ endIndex?: number; /** - * The ID of the header, footer or footnote that this range is contained in. - * An empty segment ID signifies the document's body. + * The ID of the header, footer or footnote that this range is contained in. An empty segment ID signifies the document's body. */ segmentId?: string; /** - * The zero-based start index of this range, in UTF-16 code units. In all - * current uses, a start index must be provided. This field is an Int32Value - * in order to accommodate future use cases with open-ended ranges. + * The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */ startIndex?: number; } @@ -2242,6 +1864,10 @@ export namespace docs_v1 { * Inserts a table at the specified location. */ insertTable?: Schema$InsertTableRequest; + /** + * Inserts an empty column into a table. + */ + insertTableColumn?: Schema$InsertTableColumnRequest; /** * Inserts an empty row into a table. */ @@ -2258,6 +1884,14 @@ export namespace docs_v1 { * Updates the paragraph style at the specified range. */ updateParagraphStyle?: Schema$UpdateParagraphStyleRequest; + /** + * Updates the properties of columns in a table. + */ + updateTableColumnProperties?: Schema$UpdateTableColumnPropertiesRequest; + /** + * Updates the row style in a table. + */ + updateTableRowStyle?: Schema$UpdateTableRowStyleRequest; /** * Updates the text style at the specified range. */ @@ -2302,10 +1936,7 @@ export namespace docs_v1 { red?: number; } /** - * A StructuralElement representing a section break. A section is a range of - * content which has the same SectionStyle. A section break represents the - * start of a new section, and the section style applies to the section after - * the section break. The document body always begins with a section break. + * A StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. */ export interface Schema$SectionBreak { /** @@ -2313,14 +1944,11 @@ export namespace docs_v1 { */ sectionStyle?: Schema$SectionStyle; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A SectionBreak may have multiple insertion - * IDs if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; } @@ -2342,18 +1970,15 @@ export namespace docs_v1 { */ export interface Schema$SectionStyle { /** - * The section's columns properties. If empty, the section contains one - * column with the default properties in the Docs editor. + * The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. */ columnProperties?: Schema$SectionColumnProperties[]; /** - * The style of column separators. This style can be set even when there is - * one column in the section. + * The style of column separators. This style can be set even when there is one column in the section. */ columnSeparatorStyle?: string; /** - * The content direction of this section. If unset, the value defaults to - * LEFT_TO_RIGHT. + * The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. */ contentDirection?: string; } @@ -2367,9 +1992,7 @@ export namespace docs_v1 { backgroundColor?: Schema$OptionalColor; } /** - * A mask that indicates which of the fields on the base Shading have been - * changed in this suggested change. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there is a new suggested value. */ export interface Schema$ShadingSuggestionState { /** @@ -2382,8 +2005,7 @@ export namespace docs_v1 { */ export interface Schema$SheetsChartReference { /** - * The ID of the specific chart in the Google Sheets spreadsheet that is - * embedded. + * The ID of the specific chart in the Google Sheets spreadsheet that is embedded. */ chartId?: number; /** @@ -2392,9 +2014,7 @@ export namespace docs_v1 { spreadsheetId?: string; } /** - * A mask that indicates which of the fields on the base SheetsChartReference - * have been changed in this suggestion. For any field set to true, there is a - * new suggested value. + * A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$SheetsChartReferenceSuggestionState { /** @@ -2420,9 +2040,7 @@ export namespace docs_v1 { width?: Schema$Dimension; } /** - * A mask that indicates which of the fields on the base Size have been - * changed in this suggestion. For any field set to true, the Size has a new - * suggested value. + * A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. */ export interface Schema$SizeSuggestionState { /** @@ -2435,13 +2053,11 @@ export namespace docs_v1 { widthSuggested?: boolean; } /** - * A StructuralElement describes content that provides structure to the - * document. + * A StructuralElement describes content that provides structure to the document. */ export interface Schema$StructuralElement { /** - * The zero-based end index of this structural element, exclusive, in UTF-16 - * code units. + * The zero-based end index of this structural element, exclusive, in UTF-16 code units. */ endIndex?: number; /** @@ -2453,8 +2069,7 @@ export namespace docs_v1 { */ sectionBreak?: Schema$SectionBreak; /** - * The zero-based start index of this structural element, in UTF-16 code - * units. + * The zero-based start index of this structural element, in UTF-16 code units. */ startIndex?: number; /** @@ -2471,8 +2086,7 @@ export namespace docs_v1 { */ export interface Schema$SubstringMatchCriteria { /** - * Indicates whether the search should respect case: - `True`: the search - * is case sensitive. - `False`: the search is case insensitive. + * Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive. */ matchCase?: boolean; /** @@ -2485,14 +2099,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedBullet { /** - * A Bullet that only includes the changes made in this suggestion. This can - * be used along with the bullet_suggestion_state to see which fields have - * changed and their new values. + * A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. */ bullet?: Schema$Bullet; /** - * A mask that indicates which of the fields on the base Bullet have been - * changed in this suggestion. + * A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. */ bulletSuggestionState?: Schema$BulletSuggestionState; } @@ -2501,14 +2112,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedDocumentStyle { /** - * A DocumentStyle that only includes the changes made in this suggestion. - * This can be used along with the document_style_suggestion_state to see - * which fields have changed and their new values. + * A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. */ documentStyle?: Schema$DocumentStyle; /** - * A mask that indicates which of the fields on the base DocumentStyle have - * been changed in this suggestion. + * A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. */ documentStyleSuggestionState?: Schema$DocumentStyleSuggestionState; } @@ -2517,15 +2125,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedInlineObjectProperties { /** - * An InlineObjectProperties that only includes the changes made in this - * suggestion. This can be used along with the - * inline_object_properties_suggestion_state to see which fields have - * changed and their new values. + * An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. */ inlineObjectProperties?: Schema$InlineObjectProperties; /** - * A mask that indicates which of the fields on the base - * InlineObjectProperties have been changed in this suggestion. + * A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. */ inlineObjectPropertiesSuggestionState?: Schema$InlineObjectPropertiesSuggestionState; } @@ -2534,14 +2138,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedListProperties { /** - * A ListProperties that only includes the changes made in this suggestion. - * This can be used along with the list_properties_suggestion_state to see - * which fields have changed and their new values. + * A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. */ listProperties?: Schema$ListProperties; /** - * A mask that indicates which of the fields on the base ListProperties have - * been changed in this suggestion. + * A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. */ listPropertiesSuggestionState?: Schema$ListPropertiesSuggestionState; } @@ -2550,14 +2151,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedNamedStyles { /** - * A NamedStyles that only includes the changes made in this suggestion. - * This can be used along with the named_styles_suggestion_state to see - * which fields have changed and their new values. + * A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. */ namedStyles?: Schema$NamedStyles; /** - * A mask that indicates which of the fields on the base NamedStyles have - * been changed in this suggestion. + * A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. */ namedStylesSuggestionState?: Schema$NamedStylesSuggestionState; } @@ -2566,14 +2164,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedParagraphStyle { /** - * A ParagraphStyle that only includes the changes made in this suggestion. - * This can be used along with the paragraph_suggestion_state to see which - * fields have changed and their new values. + * A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_suggestion_state to see which fields have changed and their new values. */ paragraphStyle?: Schema$ParagraphStyle; /** - * A mask that indicates which of the fields on the base ParagraphStyle have - * been changed in this suggestion. + * A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. */ paragraphStyleSuggestionState?: Schema$ParagraphStyleSuggestionState; } @@ -2582,15 +2177,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedPositionedObjectProperties { /** - * A PositionedObjectProperties that only includes the changes made in this - * suggestion. This can be used along with the - * positioned_object_properties_suggestion_state to see which fields have - * changed and their new values. + * A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. */ positionedObjectProperties?: Schema$PositionedObjectProperties; /** - * A mask that indicates which of the fields on the base - * PositionedObjectProperties have been changed in this suggestion. + * A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. */ positionedObjectPropertiesSuggestionState?: Schema$PositionedObjectPropertiesSuggestionState; } @@ -2599,14 +2190,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedTableCellStyle { /** - * A TableCellStyle that only includes the changes made in this suggestion. - * This can be used along with the table_cell_style_suggestion_state to see - * which fields have changed and their new values. + * A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. */ tableCellStyle?: Schema$TableCellStyle; /** - * A mask that indicates which of the fields on the base TableCellStyle have - * been changed in this suggestion. + * A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. */ tableCellStyleSuggestionState?: Schema$TableCellStyleSuggestionState; } @@ -2615,14 +2203,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedTableRowStyle { /** - * A TableRowStyle that only includes the changes made in this suggestion. - * This can be used along with the table_row_style_suggestion_state to see - * which fields have changed and their new values. + * A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. */ tableRowStyle?: Schema$TableRowStyle; /** - * A mask that indicates which of the fields on the base TableRowStyle have - * been changed in this suggestion. + * A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. */ tableRowStyleSuggestionState?: Schema$TableRowStyleSuggestionState; } @@ -2631,14 +2216,11 @@ export namespace docs_v1 { */ export interface Schema$SuggestedTextStyle { /** - * A TextStyle that only includes the changes made in this suggestion. This - * can be used along with the text_style_suggestion_state to see which - * fields have changed and their new values. + * A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. */ textStyle?: Schema$TextStyle; /** - * A mask that indicates which of the fields on the base TextStyle have been - * changed in this suggestion. + * A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. */ textStyleSuggestionState?: Schema$TextStyleSuggestionState; } @@ -2647,8 +2229,7 @@ export namespace docs_v1 { */ export interface Schema$Table { /** - * Number of columns in the table. It is possible for a table to be - * non-rectangular, so some rows may have a different number of cells. + * Number of columns in the table. It is possible for a table to be non-rectangular, so some rows may have a different number of cells. */ columns?: number; /** @@ -2656,14 +2237,11 @@ export namespace docs_v1 { */ rows?: number; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A Table may have multiple insertion IDs if - * it is a nested suggested change. If empty, then this is not a suggested - * insertion. + * The suggested insertion IDs. A Table may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** @@ -2692,14 +2270,11 @@ export namespace docs_v1 { */ startIndex?: number; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A TableCell may have multiple insertion IDs - * if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. A TableCell may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** @@ -2714,8 +2289,7 @@ export namespace docs_v1 { tableCellStyle?: Schema$TableCellStyle; } /** - * A border around a table cell. Table cell borders cannot be transparent. To - * hide a table cell border, make its width 0. + * A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. */ export interface Schema$TableCellBorder { /** @@ -2736,13 +2310,11 @@ export namespace docs_v1 { */ export interface Schema$TableCellLocation { /** - * The zero-based column index. For example, the second column in the table - * has a column index of 1. + * The zero-based column index. For example, the second column in the table has a column index of 1. */ columnIndex?: number; /** - * The zero-based row index. For example, the second row in the table has a - * row index of 1. + * The zero-based row index. For example, the second row in the table has a row index of 1. */ rowIndex?: number; /** @@ -2751,9 +2323,7 @@ export namespace docs_v1 { tableStartLocation?: Schema$Location; } /** - * The style of a TableCell. Inherited table cell styles are represented as - * unset fields in this message. A table cell style can inherit from the - * table's style. + * The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. */ export interface Schema$TableCellStyle { /** @@ -2781,8 +2351,7 @@ export namespace docs_v1 { */ columnSpan?: number; /** - * The alignment of the content in the table cell. The default alignment - * matches the alignment for newly created table cells in the Docs editor. + * The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. */ contentAlignment?: string; /** @@ -2807,9 +2376,7 @@ export namespace docs_v1 { rowSpan?: number; } /** - * A mask that indicates which of the fields on the base TableCellStyle have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$TableCellStyleSuggestionState { /** @@ -2866,8 +2433,7 @@ export namespace docs_v1 { */ export interface Schema$TableColumnProperties { /** - * The width of the column. Set when the column's `width_type` is - * FIXED_WIDTH. + * The width of the column. Set when the column's `width_type` is FIXED_WIDTH. */ width?: Schema$Dimension; /** @@ -2884,14 +2450,11 @@ export namespace docs_v1 { */ content?: Schema$StructuralElement[]; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A TableOfContents may have multiple - * insertion IDs if it is a nested suggested change. If empty, then this is - * not a suggested insertion. + * The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; } @@ -2908,14 +2471,11 @@ export namespace docs_v1 { */ startIndex?: number; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A TableRow may have multiple insertion IDs - * if it is a nested suggested change. If empty, then this is not a - * suggested insertion. + * The suggested insertion IDs. A TableRow may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** @@ -2925,9 +2485,7 @@ export namespace docs_v1 { [key: string]: Schema$SuggestedTableRowStyle; }; /** - * The contents and style of each cell in this row. It is possible for a - * table to be non-rectangular, so some rows may have a different number of - * cells than other rows in the same table. + * The contents and style of each cell in this row. It is possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. */ tableCells?: Schema$TableCell[]; /** @@ -2940,16 +2498,12 @@ export namespace docs_v1 { */ export interface Schema$TableRowStyle { /** - * The minimum height of the row. The row will be rendered in the Docs - * editor at a height equal to or greater than this value in order to show - * all the content in the row's cells. + * The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. */ minRowHeight?: Schema$Dimension; } /** - * A mask that indicates which of the fields on the base TableRowStyle have - * been changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$TableRowStyleSuggestionState { /** @@ -2962,9 +2516,7 @@ export namespace docs_v1 { */ export interface Schema$TableStyle { /** - * The properties of each column. Note that in Docs, tables contain rows - * and rows contain cells, similar to HTML. So the properties for a row can - * be found on the row's table_row_style. + * The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. */ tableColumnProperties?: Schema$TableColumnProperties[]; } @@ -2982,24 +2534,19 @@ export namespace docs_v1 { offset?: Schema$Dimension; } /** - * A ParagraphElement that represents a run of text that all has the same - * styling. + * A ParagraphElement that represents a run of text that all has the same styling. */ export interface Schema$TextRun { /** - * The text of this run. Any non-text elements in the run are replaced with - * the Unicode character U+E907. + * The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. */ content?: string; /** - * The suggested deletion IDs. If empty, then there are no suggested - * deletions of this content. + * The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */ suggestedDeletionIds?: string[]; /** - * The suggested insertion IDs. A TextRun may have multiple insertion IDs if - * it is a nested suggested change. If empty, then this is not a suggested - * insertion. + * The suggested insertion IDs. A TextRun may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */ suggestedInsertionIds?: string[]; /** @@ -3012,29 +2559,15 @@ export namespace docs_v1 { textStyle?: Schema$TextStyle; } /** - * Represents the styling that can be applied to text. Inherited text styles - * are represented as unset fields in this message. A text style's parent - * depends on where the text style is defined: * The TextStyle of text in a - * Paragraph inherits from the paragraph's corresponding named style - * type. * The TextStyle on a named style inherits from the normal text - * named style. * The TextStyle of the normal text named style inherits from - * the default text style in the Docs editor. * The TextStyle on a Paragraph - * element that is contained in a table may inherit its text style from - * the table style. If the text style does not inherit from a parent, - * unsetting fields will revert the style to a value matching the defaults in - * the Docs editor. + * Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that is contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. */ export interface Schema$TextStyle { /** - * The background color of the text. If set, the color is either an RGB - * color or transparent, depending on the `color` field. + * The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. */ backgroundColor?: Schema$OptionalColor; /** - * The text's vertical offset from its normal position. Text with - * `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered - * in a smaller font size, computed based on the `font_size` field. The - * `font_size` itself is not affected by changes in this field. + * The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. */ baselineOffset?: string; /** @@ -3046,8 +2579,7 @@ export namespace docs_v1 { */ fontSize?: Schema$Dimension; /** - * The foreground color of the text. If set, the color is either an RGB - * color or transparent, depending on the `color` field. + * The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. */ foregroundColor?: Schema$OptionalColor; /** @@ -3055,22 +2587,7 @@ export namespace docs_v1 { */ italic?: boolean; /** - * The hyperlink destination of the text. If unset, there is no link. Links - * are not inherited from parent text. Changing the link in an update - * request causes some other changes to the text style of the range: * When - * setting a link, the text foreground color will be updated to the default - * link color and the text will be underlined. If these fields are modified - * in the same request, those values will be used instead of the link - * defaults. * Setting a link on a text range that overlaps with an existing - * link will also update the existing link to point to the new URL. * - * Links are not settable on newline characters. As a result, setting a link - * on a text range that crosses a paragraph boundary, such as - * `"ABCx/123"`, will separate the newline character(s) into - * their own text runs. The link will be applied separately to the runs - * before and after the newline. * Removing a link will update the text - * style of the range to match the style of the preceding text (or the - * default text styles if the preceding text is another link) unless - * different styles are being set in the same request. + * The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABCx/123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. */ link?: Schema$Link; /** @@ -3086,20 +2603,12 @@ export namespace docs_v1 { */ underline?: boolean; /** - * The font family and rendered weight of the text. If an update request - * specifies values for both `weighted_font_family` and `bold`, the - * `weighted_font_family` is applied first, then `bold`. If - * `weighted_font_family#weight` is not set, it defaults to `400`. If - * `weighted_font_family` is set, then `weighted_font_family#font_family` - * must also be set with a non-empty value. Otherwise, a 400 bad request - * error is returned. + * The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. */ weightedFontFamily?: Schema$WeightedFontFamily; } /** - * A mask that indicates which of the fields on the base TextStyle have been - * changed in this suggestion. For any field set to true, there is a new - * suggested value. + * A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there is a new suggested value. */ export interface Schema$TextStyleSuggestionState { /** @@ -3152,18 +2661,11 @@ export namespace docs_v1 { */ export interface Schema$UpdateParagraphStyleRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `paragraph_style` is implied and should not be specified. For - * example, to update the paragraph style's alignment property, set - * `fields` to `"alignment"`. To reset a property to its default - * value, include its field name in the field mask but leave the field - * itself unset. + * The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** - * The styles to set on the paragraphs. Certain paragraph style changes may - * cause other changes in order to mirror the behavior of the Docs editor. - * See the documentation of ParagraphStyle for more information. + * The styles to set on the paragraphs. Certain paragraph style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of ParagraphStyle for more information. */ paragraphStyle?: Schema$ParagraphStyle; /** @@ -3171,32 +2673,62 @@ export namespace docs_v1 { */ range?: Schema$Range; } + /** + * Updates the TableColumnProperties of columns in a table. + */ + export interface Schema$UpdateTableColumnPropertiesRequest { + /** + * The list of zero-based column indices whose property should be updated. If no indices are specified, all columns will be updated. + */ + columnIndices?: number[]; + /** + * The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `"width"`. + */ + fields?: string; + /** + * The table column properties to update. If the value of `table_column_properties#width` is less than 5 points (5/72 inch), a 400 bad request error is returned. + */ + tableColumnProperties?: Schema$TableColumnProperties; + /** + * The location where the table starts in the document. + */ + tableStartLocation?: Schema$Location; + } + /** + * Updates the TableRowStyle of rows in a table. + */ + export interface Schema$UpdateTableRowStyleRequest { + /** + * The fields that should be updated. At least one field must be specified. The root `tableRowStyle` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `"min_row_height"`. + */ + fields?: string; + /** + * The list of zero-based row indices whose style should be updated. If no indices are specified, all rows will be updated. + */ + rowIndices?: number[]; + /** + * The styles to be set on the rows. + */ + tableRowStyle?: Schema$TableRowStyle; + /** + * The location where the table starts in the document. + */ + tableStartLocation?: Schema$Location; + } /** * Update the styling of text. */ export interface Schema$UpdateTextStyleRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `text_style` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. For - * example, to update the text style to bold, set `fields` to - * `"bold"`. To reset a property to its default value, include - * its field name in the field mask but leave the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `text_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `"bold"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** - * The range of text to style. The range may be extended to include - * adjacent newlines. If the range fully contains a paragraph belonging to - * a list, the paragraph's bullet is also updated with the matching text - * style. + * The range of text to style. The range may be extended to include adjacent newlines. If the range fully contains a paragraph belonging to a list, the paragraph's bullet is also updated with the matching text style. */ range?: Schema$Range; /** - * The styles to set on the text. If the value for a particular style - * matches that of the parent, that style will be set to inherit. Certain - * text style changes may cause other changes in order to to mirror the - * behavior of the Docs editor. See the documentation of TextStyle for more - * information. + * The styles to set on the text. If the value for a particular style matches that of the parent, that style will be set to inherit. Certain text style changes may cause other changes in order to to mirror the behavior of the Docs editor. See the documentation of TextStyle for more information. */ textStyle?: Schema$TextStyle; } @@ -3205,26 +2737,11 @@ export namespace docs_v1 { */ export interface Schema$WeightedFontFamily { /** - * The font family of the text. The font family can be any font from the - * Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If - * the font name is unrecognized, the text is rendered in `Arial`. + * The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. */ fontFamily?: string; /** - * The weight of the font. This field can have any value that is a multiple - * of `100` between `100` and `900`, inclusive. This range corresponds to - * the numerical values described in the CSS 2.1 Specification, - * [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), - * with non-numerical values disallowed. The default value is `400` - * ("normal"). The font weight makes up just one component of the - * rendered font weight. The rendered weight is determined by a combination - * of the `weight` and the text style's resolved `bold` value, after - * accounting for inheritance: * If the text is bold and the weight is less - * than `400`, the rendered weight is 400. * If the text is bold and the - * weight is greater than or equal to `400` but is less than `700`, the - * rendered weight is `700`. * If the weight is greater than or equal to - * `700`, the rendered weight is equal to the weight. * If the text is not - * bold, the rendered weight is equal to the weight. + * The weight of the font. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. The rendered weight is determined by a combination of the `weight` and the text style's resolved `bold` value, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. */ weight?: number; } @@ -3233,29 +2750,11 @@ export namespace docs_v1 { */ export interface Schema$WriteControl { /** - * The revision ID of the document that the write request will be applied - * to. If this is not the latest revision of the document, the request will - * not be processed and will return a 400 bad request error. When a - * required revision ID is returned in a response, it indicates the revision - * ID of the document after the request was applied. + * The revision ID of the document that the write request will be applied to. If this is not the latest revision of the document, the request will not be processed and will return a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied. */ requiredRevisionId?: string; /** - * The target revision ID of the document that the write request will be - * applied to. If collaborator changes have occurred after the document was - * read using the API, the changes produced by this write request will be - * transformed against the collaborator changes. This results in a new - * revision of the document which incorporates both the changes in the - * request and the collaborator changes, and the Docs server will resolve - * conflicting changes. When using `target_revision_id`, the API client can - * be thought of as another collaborator of the document. The target - * revision ID may only be used to write to recent versions of a document. - * If the target revision is too far behind the latest revision, the request - * will not be processed and will return a 400 bad request error and the - * request should be retried after reading the latest version of the - * document. In most cases a `revision_id` will remain valid for use as a - * target revision for several minutes after it is read, but for - * frequently-edited documents this window may be shorter. + * The target revision ID of the document that the write request will be applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request will be transformed against the collaborator changes. This results in a new revision of the document which incorporates both the changes in the request and the collaborator changes, and the Docs server will resolve conflicting changes. When using `target_revision_id`, the API client can be thought of as another collaborator of the document. The target revision ID may only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request will not be processed and will return a 400 bad request error and the request should be retried after reading the latest version of the document. In most cases a `revision_id` will remain valid for use as a target revision for several minutes after it is read, but for frequently-edited documents this window may be shorter. */ targetRevisionId?: string; } @@ -3268,20 +2767,7 @@ export namespace docs_v1 { /** * docs.documents.batchUpdate - * @desc Applies one or more updates to the document. Each request is - * validated before being applied. If any request is not valid, then the - * entire request will fail and nothing will be applied. Some requests have - * replies to give you some information about how they are applied. Other - * requests do not need to return information; these each return an empty - * reply. The order of replies matches that of the requests. For example, - * suppose you call batchUpdate with four updates, and only the third one - * returns information. The response would have two empty replies, the reply - * to the third request, and another empty reply, in that order. Because - * other users may be editing the document, the document might not exactly - * reflect your changes: your changes may be altered with respect to - * collaborator changes. If there are no collaborators, the document should - * reflect your changes. In any case, the updates in your request are - * guaranteed to be applied together atomically. + * @desc Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. * @alias docs.documents.batchUpdate * @memberOf! () * @@ -3363,9 +2849,7 @@ export namespace docs_v1 { /** * docs.documents.create - * @desc Creates a blank document using the title given in the request. - * Other fields in the request, including any provided content, are ignored. - * Returns the created document. + * @desc Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document. * @alias docs.documents.create * @memberOf! () * @@ -3543,9 +3027,7 @@ export namespace docs_v1 { */ documentId?: string; /** - * The suggestions view mode to apply to the document. This allows viewing - * the document with all suggestions inline, accepted or rejected. If one is - * not specified, DEFAULT_FOR_CURRENT_ACCESS is used. + * The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used. */ suggestionsViewMode?: string; } diff --git a/src/apis/doubleclickbidmanager/package.json b/src/apis/doubleclickbidmanager/package.json index 15b9059a627..3ae03596e55 100644 --- a/src/apis/doubleclickbidmanager/package.json +++ b/src/apis/doubleclickbidmanager/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/doubleclickbidmanager/v1.ts b/src/apis/doubleclickbidmanager/v1.ts index cba54a062de..55785bcfa90 100644 --- a/src/apis/doubleclickbidmanager/v1.ts +++ b/src/apis/doubleclickbidmanager/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace doubleclickbidmanager_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace doubleclickbidmanager_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -98,7 +95,10 @@ export namespace doubleclickbidmanager_v1 { sdf: Resource$Sdf; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.lineitems = new Resource$Lineitems(this.context); this.queries = new Resource$Queries(this.context); @@ -112,13 +112,11 @@ export namespace doubleclickbidmanager_v1 { */ export interface Schema$DownloadLineItemsRequest { /** - * File specification (column names, types, order) in which the line items - * will be returned. Default to EWF. + * File specification (column names, types, order) in which the line items will be returned. Default to EWF. */ fileSpec?: string; /** - * Ids of the specified filter type used to filter line items to fetch. If - * omitted, all the line items will be returned. + * Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned. */ filterIds?: string[]; /** @@ -135,35 +133,28 @@ export namespace doubleclickbidmanager_v1 { */ export interface Schema$DownloadLineItemsResponse { /** - * Retrieved line items in CSV format. For more information about file - * formats, see Entity Write File Format. + * Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format. */ lineItems?: string; } /** - * Request to fetch stored inventory sources, campaigns, insertion orders, - * line items, TrueView ad groups and ads. + * Request to fetch stored inventory sources, campaigns, insertion orders, line items, TrueView ad groups and ads. */ export interface Schema$DownloadRequest { /** - * File types that will be returned. Acceptable values are: - - * "AD" - "AD_GROUP" - "CAMPAIGN" - - * "INSERTION_ORDER" - "LINE_ITEM" - - * "INVENTORY_SOURCE" + * File types that will be returned. If INVENTORY_SOURCE is requested, no other file types may be requested. Acceptable values are: - "AD" - "AD_GROUP" - "CAMPAIGN" - "INSERTION_ORDER" - "INVENTORY_SOURCE" - "LINE_ITEM" */ fileTypes?: string[]; /** - * The IDs of the specified filter type. This is used to filter entities to - * fetch. At least one ID must be specified. + * The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified. */ filterIds?: string[]; /** - * Filter type used to filter entities to fetch. + * Filter type used to filter entities to fetch. PARTNER_ID and INVENTORY_SOURCE_ID may only be used when downloading inventory sources. */ filterType?: string; /** - * SDF Version (column names, types, order) in which the entities will be - * returned. Default to 3.1. + * SDF Version (column names, types, order) in which the entities will be returned. Default to 3.1. */ version?: string; } @@ -211,8 +202,7 @@ export namespace doubleclickbidmanager_v1 { */ export interface Schema$ListQueriesResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "doubleclickbidmanager#listQueriesResponse". + * Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse". */ kind?: string; /** @@ -225,8 +215,7 @@ export namespace doubleclickbidmanager_v1 { */ export interface Schema$ListReportsResponse { /** - * Identifies what kind of resource this is. Value: the fixed string - * "doubleclickbidmanager#listReportsResponse". + * Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listReportsResponse". */ kind?: string; /** @@ -247,7 +236,7 @@ export namespace doubleclickbidmanager_v1 { */ groupBys?: string[]; /** - * Whether to include data from Invite Media. + * Deprecated. This field is no longer in use. */ includeInviteData?: boolean; /** @@ -264,8 +253,7 @@ export namespace doubleclickbidmanager_v1 { */ export interface Schema$Query { /** - * Identifies what kind of resource this is. Value: the fixed string - * "doubleclickbidmanager#query". + * Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". */ kind?: string; /** @@ -281,15 +269,11 @@ export namespace doubleclickbidmanager_v1 { */ queryId?: string; /** - * The ending time for the data that is shown in the report. Note, - * reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and - * ignored otherwise. + * The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise. */ reportDataEndTimeMs?: string; /** - * The starting time for the data that is shown in the report. Note, - * reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES - * and ignored otherwise. + * The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise. */ reportDataStartTimeMs?: string; /** @@ -297,8 +281,7 @@ export namespace doubleclickbidmanager_v1 { */ schedule?: Schema$QuerySchedule; /** - * Canonical timezone code for report data time. Defaults to - * America/New_York. + * Canonical timezone code for report data time. Defaults to America/New_York. */ timezoneCode?: string; } @@ -315,8 +298,7 @@ export namespace doubleclickbidmanager_v1 { */ format?: string; /** - * The path to the location in Google Cloud Storage where the latest report - * is stored. + * The path to the location in Google Cloud Storage where the latest report is stored. */ googleCloudStoragePathForLatestReport?: string; /** @@ -328,11 +310,7 @@ export namespace doubleclickbidmanager_v1 { */ latestReportRunTimeMs?: string; /** - * Locale of the generated reports. Valid values are cs CZECH de GERMAN en - * ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH - * pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN - * CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list - * above will generate reports in English. + * Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English. */ locale?: string; /** @@ -344,13 +322,11 @@ export namespace doubleclickbidmanager_v1 { */ running?: boolean; /** - * Whether to send an email notification when a report is ready. Default to - * false. + * Whether to send an email notification when a report is ready. Default to false. */ sendNotification?: boolean; /** - * List of email addresses which are sent email notifications when the - * report is finished. Separate from sendNotification. + * List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. */ shareEmailAddress?: string[]; /** @@ -371,14 +347,11 @@ export namespace doubleclickbidmanager_v1 { */ frequency?: string; /** - * Time of day at which a new report will be generated, represented as - * minutes past midnight. Range is 0 to 1439. Only applies to scheduled - * reports. + * Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports. */ nextRunMinuteOfDay?: number; /** - * Canonical timezone code for report generation time. Defaults to - * America/New_York. + * Canonical timezone code for report generation time. Defaults to America/New_York. */ nextRunTimezoneCode?: string; } @@ -426,8 +399,7 @@ export namespace doubleclickbidmanager_v1 { */ export interface Schema$ReportMetadata { /** - * The path to the location in Google Cloud Storage where the report is - * stored. + * The path to the location in Google Cloud Storage where the report is stored. */ googleCloudStoragePath?: string; /** @@ -502,20 +474,15 @@ export namespace doubleclickbidmanager_v1 { */ dataRange?: string; /** - * The ending time for the data that is shown in the report. Note, - * reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored - * otherwise. + * The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise. */ reportDataEndTimeMs?: string; /** - * The starting time for the data that is shown in the report. Note, - * reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and - * ignored otherwise. + * The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise. */ reportDataStartTimeMs?: string; /** - * Canonical timezone code for report data time. Defaults to - * America/New_York. + * Canonical timezone code for report data time. Defaults to America/New_York. */ timezoneCode?: string; } @@ -524,8 +491,7 @@ export namespace doubleclickbidmanager_v1 { */ export interface Schema$UploadLineItemsRequest { /** - * Set to true to get upload status without actually persisting the line - * items. + * Set to true to get upload status without actually persisting the line items. */ dryRun?: boolean; /** @@ -533,8 +499,7 @@ export namespace doubleclickbidmanager_v1 { */ format?: string; /** - * Line items in CSV to upload. Refer to Entity Write File Format for more - * information on file format. + * Line items in CSV to upload. Refer to Entity Write File Format for more information on file format. */ lineItems?: string; } @@ -569,8 +534,7 @@ export namespace doubleclickbidmanager_v1 { /** * doubleclickbidmanager.lineitems.downloadlineitems - * @desc Retrieves line items in CSV format. TrueView line items are not - * supported. + * @desc Retrieves line items in CSV format. TrueView line items are not supported. * @alias doubleclickbidmanager.lineitems.downloadlineitems * @memberOf! () * @@ -650,8 +614,7 @@ export namespace doubleclickbidmanager_v1 { /** * doubleclickbidmanager.lineitems.uploadlineitems - * @desc Uploads line items in CSV format. TrueView line items are not - * supported. + * @desc Uploads line items in CSV format. TrueView line items are not supported. * @alias doubleclickbidmanager.lineitems.uploadlineitems * @memberOf! () * diff --git a/src/apis/doubleclicksearch/package.json b/src/apis/doubleclicksearch/package.json index cf2a53507a2..af370e6c5c6 100644 --- a/src/apis/doubleclicksearch/package.json +++ b/src/apis/doubleclicksearch/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/doubleclicksearch/v2.ts b/src/apis/doubleclicksearch/v2.ts index fe2f03a9a09..5ffcf4f7183 100644 --- a/src/apis/doubleclicksearch/v2.ts +++ b/src/apis/doubleclicksearch/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace doubleclicksearch_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace doubleclicksearch_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace doubleclicksearch_v2 { /** * DoubleClick Search API * - * Reports and modifies your advertising data in DoubleClick Search (for - * example, campaigns, ad groups, keywords, and conversions). + * Reports and modifies your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions). * * @example * const {google} = require('googleapis'); @@ -98,7 +94,10 @@ export namespace doubleclicksearch_v2 { savedColumns: Resource$Savedcolumns; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.conversion = new Resource$Conversion(this.context); this.reports = new Resource$Reports(this.context); @@ -119,23 +118,19 @@ export namespace doubleclicksearch_v2 { */ agencyId?: string; /** - * The time by which all conversions have been uploaded, in epoch millis - * UTC. + * The time by which all conversions have been uploaded, in epoch millis UTC. */ availabilityTimestamp?: string; /** - * The numeric segmentation identifier (for example, DoubleClick Search - * Floodlight activity ID). + * The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). */ segmentationId?: string; /** - * The friendly segmentation identifier (for example, DoubleClick Search - * Floodlight activity name). + * The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). */ segmentationName?: string; /** - * The segmentation type that this availability is for (its default value is - * FLOODLIGHT). + * The segmentation type that this availability is for (its default value is FLOODLIGHT). */ segmentationType?: string; } @@ -160,8 +155,7 @@ export namespace doubleclicksearch_v2 { */ agencyId?: string; /** - * Available to advertisers only after contacting DoubleClick Search - * customer support. + * Available to advertisers only after contacting DoubleClick Search customer support. */ attributionModel?: string; /** @@ -169,9 +163,7 @@ export namespace doubleclicksearch_v2 { */ campaignId?: string; /** - * Sales channel for the product. Acceptable values are: - - * "local": a physical store - "online": an online - * store + * Sales channel for the product. Acceptable values are: - "local": a physical store - "online": an online store */ channel?: string; /** @@ -179,12 +171,7 @@ export namespace doubleclicksearch_v2 { */ clickId?: string; /** - * For offline conversions, advertisers provide this ID. Advertisers can - * specify any ID that is meaningful to them. Each conversion in a request - * must specify a unique ID, and the combination of ID and timestamp must be - * unique amongst all conversions within the advertiser. For online - * conversions, DS copies the dsConversionId or floodlightOrderId into this - * property depending on the advertiser's Floodlight instructions. + * For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. */ conversionId?: string; /** @@ -196,8 +183,7 @@ export namespace doubleclicksearch_v2 { */ conversionTimestamp?: string; /** - * Available to advertisers only after contacting DoubleClick Search - * customer support. + * Available to advertisers only after contacting DoubleClick Search customer support. */ countMillis?: string; /** @@ -205,13 +191,11 @@ export namespace doubleclicksearch_v2 { */ criterionId?: string; /** - * The currency code for the conversion's revenue. Should be in ISO 4217 - * alphabetic (3-char) format. + * The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. */ currencyCode?: string; /** - * Custom dimensions for the conversion, which can be used to filter data in - * a report. + * Custom dimensions for the conversion, which can be used to filter data in a report. */ customDimension?: Schema$CustomDimension[]; /** @@ -235,13 +219,11 @@ export namespace doubleclicksearch_v2 { */ floodlightOrderId?: string; /** - * ID that DS generates and uses to uniquely identify the inventory account - * that contains the product. + * ID that DS generates and uses to uniquely identify the inventory account that contains the product. */ inventoryAccountId?: string; /** - * The country registered for the Merchant Center feed that contains the - * product. Use an ISO 3166 code to specify a country. + * The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. */ productCountry?: string; /** @@ -253,8 +235,7 @@ export namespace doubleclicksearch_v2 { */ productId?: string; /** - * The language registered for the Merchant Center feed that contains the - * product. Use an ISO 639 code to specify a language. + * The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. */ productLanguage?: string; /** @@ -262,20 +243,15 @@ export namespace doubleclicksearch_v2 { */ quantityMillis?: string; /** - * The revenue amount of this TRANSACTION conversion, in micros (value - * multiplied by 1000000, no decimal). For example, to specify a revenue - * value of "10" enter "10000000" (10 million) in your - * request. + * The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request. */ revenueMicros?: string; /** - * The numeric segmentation identifier (for example, DoubleClick Search - * Floodlight activity ID). + * The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). */ segmentationId?: string; /** - * The friendly segmentation identifier (for example, DoubleClick Search - * Floodlight activity name). + * The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). */ segmentationName?: string; /** @@ -283,21 +259,15 @@ export namespace doubleclicksearch_v2 { */ segmentationType?: string; /** - * The state of the conversion, that is, either ACTIVE or REMOVED. Note: - * state DELETED is deprecated. + * The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. */ state?: string; /** - * The ID of the local store for which the product was advertised. - * Applicable only when the channel is "local". + * The ID of the local store for which the product was advertised. Applicable only when the channel is "local". */ storeId?: string; /** - * The type of the conversion, that is, either ACTION or TRANSACTION. An - * ACTION conversion is an action by the user that has no monetarily - * quantifiable value, while a TRANSACTION conversion is an action that does - * have a monetarily quantifiable value. Examples are email list signups - * (ACTION) versus ecommerce purchases (TRANSACTION). + * The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION). */ type?: string; } @@ -310,8 +280,7 @@ export namespace doubleclicksearch_v2 { */ conversion?: Schema$Conversion[]; /** - * Identifies this as a ConversionList resource. Value: the fixed string - * doubleclicksearch#conversionList. + * Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. */ kind?: string; } @@ -342,14 +311,11 @@ export namespace doubleclicksearch_v2 { value?: number; } /** - * A DoubleClick Search report. This object contains the report request, some - * report metadata such as currency code, and the generated report rows or - * report files. + * A DoubleClick Search report. This object contains the report request, some report metadata such as currency code, and the generated report rows or report files. */ export interface Schema$Report { /** - * Asynchronous report only. Contains a list of generated report files once - * the report has succesfully completed. + * Asynchronous report only. Contains a list of generated report files once the report has succesfully completed. */ files?: Array<{byteCount?: string; url?: string}>; /** @@ -357,18 +323,15 @@ export namespace doubleclicksearch_v2 { */ id?: string; /** - * Asynchronous report only. True if and only if the report has completed - * successfully and the report files are ready to be downloaded. + * Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded. */ isReportReady?: boolean; /** - * Identifies this as a Report resource. Value: the fixed string - * doubleclicksearch#report. + * Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report. */ kind?: string; /** - * The request that created the report. Optional fields not specified in the - * original request are filled with default values. + * The request that created the report. Optional fields not specified in the original request are filled with default values. */ request?: Schema$ReportRequest; /** @@ -380,15 +343,11 @@ export namespace doubleclicksearch_v2 { */ rows?: Schema$ReportRow[]; /** - * The currency code of all monetary values produced in the report, - * including values that are set by users (e.g., keyword bid settings) and - * metrics (e.g., cost and revenue). The currency code of a report is - * determined by the statisticsCurrency field of the report request. + * The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g., cost and revenue). The currency code of a report is determined by the statisticsCurrency field of the report request. */ statisticsCurrencyCode?: string; /** - * If all statistics of the report are sourced from the same time zone, this - * would be it. Otherwise the field is unset. + * If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset. */ statisticsTimeZone?: string; } @@ -401,62 +360,39 @@ export namespace doubleclicksearch_v2 { */ columnName?: string; /** - * Segments a report by a custom dimension. The report must be scoped to an - * advertiser or lower, and the custom dimension must already be set up in - * DoubleClick Search. The custom dimension name, which appears in - * DoubleClick Search, is case sensitive. If used in a conversion report, - * returns the value of the specified custom dimension for the given - * conversion, if set. This column does not segment the conversion report. + * Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report. */ customDimensionName?: string; /** - * Name of a custom metric to include in the report. The report must be - * scoped to an advertiser or lower, and the custom metric must already be - * set up in DoubleClick Search. The custom metric name, which appears in - * DoubleClick Search, is case sensitive. + * Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. */ customMetricName?: string; /** - * Inclusive day in YYYY-MM-DD format. When provided, this overrides the - * overall time range of the report for this column only. Must be provided - * together with startDate. + * Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. */ endDate?: string; /** - * Synchronous report only. Set to true to group by this column. Defaults to - * false. + * Synchronous report only. Set to true to group by this column. Defaults to false. */ groupByColumn?: boolean; /** - * Text used to identify this column in the report output; defaults to - * columnName or savedColumnName when not specified. This can be used to - * prevent collisions between DoubleClick Search columns and saved columns - * with the same name. + * Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. */ headerText?: string; /** - * The platform that is used to provide data for the custom dimension. - * Acceptable values are "floodlight". + * The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". */ platformSource?: string; /** - * Returns metrics only for a specific type of product activity. Accepted - * values are: - "sold": returns metrics only for products that - * were sold - "advertised": returns metrics only for products - * that were advertised in a Shopping campaign, and that might or might not - * have been sold + * Returns metrics only for a specific type of product activity. Accepted values are: - "sold": returns metrics only for products that were sold - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold */ productReportPerspective?: string; /** - * Name of a saved column to include in the report. The report must be - * scoped at advertiser or lower, and this saved column must already be - * created in the DoubleClick Search UI. + * Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. */ savedColumnName?: string; /** - * Inclusive date in YYYY-MM-DD format. When provided, this overrides the - * overall time range of the report for this column only. Must be provided - * together with endDate. + * Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. */ startDate?: string; } @@ -465,22 +401,15 @@ export namespace doubleclicksearch_v2 { */ export interface Schema$ReportRequest { /** - * The columns to include in the report. This includes both DoubleClick - * Search columns and saved columns. For DoubleClick Search columns, only - * the columnName parameter is required. For saved columns only the - * savedColumnName parameter is required. Both columnName and - * savedColumnName cannot be set in the same stanza. The maximum number of - * columns per request is 300. + * The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza. The maximum number of columns per request is 300. */ columns?: Schema$ReportApiColumnSpec[]; /** - * Format that the report should be returned in. Currently csv or tsv is - * supported. + * Format that the report should be returned in. Currently csv or tsv is supported. */ downloadFormat?: string; /** - * A list of filters to be applied to the report. The maximum number of - * filters per request is 300. + * A list of filters to be applied to the report. The maximum number of filters per request is 300. */ filters?: Array<{ column?: Schema$ReportApiColumnSpec; @@ -488,31 +417,23 @@ export namespace doubleclicksearch_v2 { values?: any[]; }>; /** - * Determines if removed entities should be included in the report. Defaults - * to false. Deprecated, please use includeRemovedEntities instead. + * Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead. */ includeDeletedEntities?: boolean; /** - * Determines if removed entities should be included in the report. Defaults - * to false. + * Determines if removed entities should be included in the report. Defaults to false. */ includeRemovedEntities?: boolean; /** - * Asynchronous report only. The maximum number of rows per report file. A - * large report is split into many files based on this field. Acceptable - * values are 1000000 to 100000000, inclusive. + * Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive. */ maxRowsPerFile?: number; /** - * Synchronous report only. A list of columns and directions defining - * sorting to be performed on the report rows. The maximum number of - * orderings per request is 300. + * Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows. The maximum number of orderings per request is 300. */ orderBy?: Array<{column?: Schema$ReportApiColumnSpec; sortOrder?: string}>; /** - * The reportScope is a set of IDs that are used to determine which subset - * of entities will be returned in the report. The full lineage of IDs from - * the lowest scoped level desired up through agency is required. + * The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required. */ reportScope?: { adGroupId?: string; @@ -524,34 +445,23 @@ export namespace doubleclicksearch_v2 { keywordId?: string; }; /** - * Determines the type of rows that are returned in the report. For example, - * if you specify reportType: keyword, each row in the report will contain - * data about a keyword. See the Types of Reports reference for the columns - * that are available for each type. + * Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type. */ reportType?: string; /** - * Synchronous report only. The maximum number of rows to return; additional - * rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults - * to 10000. + * Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000. */ rowCount?: number; /** - * Synchronous report only. Zero-based index of the first row to return. - * Acceptable values are 0 to 50000, inclusive. Defaults to 0. + * Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0. */ startRow?: number; /** - * Specifies the currency in which monetary will be returned. Possible - * values are: usd, agency (valid if the report is scoped to agency or - * lower), advertiser (valid if the report is scoped to * advertiser or - * lower), or account (valid if the report is scoped to engine account or - * lower). + * Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower). */ statisticsCurrency?: string; /** - * If metrics are requested in a report, this argument will be used to - * restrict the metrics to a specific time range. + * If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range. */ timeRange?: { changedAttributesSinceTimestamp?: string; @@ -560,8 +470,7 @@ export namespace doubleclicksearch_v2 { startDate?: string; }; /** - * If true, the report would only be created if all the requested stat data - * are sourced from a single timezone. Defaults to false. + * If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false. */ verifySingleTimeZone?: boolean; } @@ -574,8 +483,7 @@ export namespace doubleclicksearch_v2 { */ export interface Schema$SavedColumn { /** - * Identifies this as a SavedColumn resource. Value: the fixed string - * doubleclicksearch#savedColumn. + * Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn. */ kind?: string; /** @@ -588,10 +496,7 @@ export namespace doubleclicksearch_v2 { type?: string; } /** - * A list of saved columns. Advertisers create saved columns to report on - * Floodlight activities, Google Analytics goals, or custom KPIs. To request - * reports with saved columns, you'll need the saved column names that are - * available from this list. + * A list of saved columns. Advertisers create saved columns to report on Floodlight activities, Google Analytics goals, or custom KPIs. To request reports with saved columns, you'll need the saved column names that are available from this list. */ export interface Schema$SavedColumnList { /** @@ -599,8 +504,7 @@ export namespace doubleclicksearch_v2 { */ items?: Schema$SavedColumn[]; /** - * Identifies this as a SavedColumnList resource. Value: the fixed string - * doubleclicksearch#savedColumnList. + * Identifies this as a SavedColumnList resource. Value: the fixed string doubleclicksearch#savedColumnList. */ kind?: string; } @@ -631,8 +535,7 @@ export namespace doubleclicksearch_v2 { /** * doubleclicksearch.conversion.get - * @desc Retrieves a list of conversions from a DoubleClick Search engine - * account. + * @desc Retrieves a list of conversions from a DoubleClick Search engine account. * @alias doubleclicksearch.conversion.get * @memberOf! () * @@ -797,8 +700,7 @@ export namespace doubleclicksearch_v2 { /** * doubleclicksearch.conversion.patch - * @desc Updates a batch of conversions in DoubleClick Search. This method - * supports patch semantics. + * @desc Updates a batch of conversions in DoubleClick Search. This method supports patch semantics. * @alias doubleclicksearch.conversion.patch * @memberOf! () * @@ -960,8 +862,7 @@ export namespace doubleclicksearch_v2 { /** * doubleclicksearch.conversion.updateAvailability - * @desc Updates the availabilities of a batch of floodlight activities in - * DoubleClick Search. + * @desc Updates the availabilities of a batch of floodlight activities in DoubleClick Search. * @alias doubleclicksearch.conversion.updateAvailability * @memberOf! () * @@ -1071,8 +972,7 @@ export namespace doubleclicksearch_v2 { */ criterionId?: string; /** - * Last date (inclusive) on which to retrieve conversions. Format is - * yyyymmdd. + * Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */ endDate?: number; /** @@ -1084,8 +984,7 @@ export namespace doubleclicksearch_v2 { */ rowCount?: number; /** - * First date (inclusive) on which to retrieve conversions. Format is - * yyyymmdd. + * First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */ startDate?: number; /** @@ -1120,8 +1019,7 @@ export namespace doubleclicksearch_v2 { */ agencyId?: string; /** - * Last date (inclusive) on which to retrieve conversions. Format is - * yyyymmdd. + * Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */ endDate?: number; /** @@ -1133,8 +1031,7 @@ export namespace doubleclicksearch_v2 { */ rowCount?: number; /** - * First date (inclusive) on which to retrieve conversions. Format is - * yyyymmdd. + * First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */ startDate?: number; /** diff --git a/src/apis/drive/package.json b/src/apis/drive/package.json index 2c787ab0b7c..fe668a88e79 100644 --- a/src/apis/drive/package.json +++ b/src/apis/drive/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index bed45653a03..4f5494fa138 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace drive_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace drive_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace drive_v2 { /** * Drive API * - * Manages files in Drive including uploading, downloading, searching, - * detecting changes, and updating sharing permissions. + * Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions. * * @example * const {google} = require('googleapis'); @@ -110,7 +106,10 @@ export namespace drive_v2 { teamdrives: Resource$Teamdrives; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.about = new Resource$About(this.context); this.apps = new Resource$Apps(this.context); @@ -135,8 +134,7 @@ export namespace drive_v2 { */ export interface Schema$About { /** - * Information about supported additional roles per file type. The most - * specific type takes precedence. + * Information about supported additional roles per file type. The most specific type takes precedence. */ additionalRoleInfo?: Array<{ roleSets?: Array<{additionalRoles?: string[]; primaryRole?: string}>; @@ -151,8 +149,7 @@ export namespace drive_v2 { */ canCreateTeamDrives?: boolean; /** - * The domain sharing policy for the current user. Possible values are: - - * allowed - allowedWithWarning - incomingOnly - disallowed + * The domain sharing policy for the current user. Possible values are: - allowed - allowedWithWarning - incomingOnly - disallowed */ domainSharingPolicy?: string; /** @@ -184,8 +181,7 @@ export namespace drive_v2 { */ importFormats?: Array<{source?: string; targets?: string[]}>; /** - * A boolean indicating whether the authenticated app is installed by the - * authenticated user. + * A boolean indicating whether the authenticated app is installed by the authenticated user. */ isCurrentAppInstalled?: boolean; /** @@ -193,9 +189,7 @@ export namespace drive_v2 { */ kind?: string; /** - * The user's language or locale code, as defined by BCP 47, with some - * extensions from Unicode's LDML format - * (http://www.unicode.org/reports/tr35/). + * The user's language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/). */ languageCode?: string; /** @@ -203,8 +197,7 @@ export namespace drive_v2 { */ largestChangeId?: string; /** - * List of max upload sizes for each file type. The most specific type takes - * precedence. + * List of max upload sizes for each file type. The most specific type takes precedence. */ maxUploadSizes?: Array<{size?: string; type?: string}>; /** @@ -236,8 +229,7 @@ export namespace drive_v2 { */ quotaBytesUsedInTrash?: string; /** - * The type of the user's storage quota. Possible values are: - - * LIMITED - UNLIMITED + * The type of the user's storage quota. Possible values are: - LIMITED - UNLIMITED */ quotaType?: string; /** @@ -266,9 +258,7 @@ export namespace drive_v2 { user?: Schema$User; } /** - * The apps resource provides a list of the apps that a user has installed, - * with information about each app's supported MIME types, file - * extensions, and other details. + * The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details. */ export interface Schema$App { /** @@ -276,9 +266,7 @@ export namespace drive_v2 { */ authorized?: boolean; /** - * The template url to create a new file with this app in a given folder. - * The template will contain {folderId} to be replaced by the folder to - * create the new file in. + * The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in. */ createInFolderTemplate?: string; /** @@ -286,8 +274,7 @@ export namespace drive_v2 { */ createUrl?: string; /** - * Whether the app has drive-wide scope. An app with drive-wide scope can - * access all files in the user's drive. + * Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive. */ hasDriveWideScope?: boolean; /** @@ -315,14 +302,11 @@ export namespace drive_v2 { */ name?: string; /** - * The type of object this app creates (e.g. Chart). If empty, the app name - * should be used instead. + * The type of object this app creates (e.g. Chart). If empty, the app name should be used instead. */ objectType?: string; /** - * The template url for opening files with this app. The template will - * contain {ids} and/or {exportIds} to be replaced by the actual file ids. - * See Open Files for the full documentation. + * The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation. */ openUrlTemplate?: string; /** @@ -370,19 +354,16 @@ export namespace drive_v2 { */ supportsOfflineCreate?: boolean; /** - * Whether the app is selected as the default handler for the types it - * supports. + * Whether the app is selected as the default handler for the types it supports. */ useByDefault?: boolean; } /** - * A list of third-party applications which the user has installed or given - * access to Google Drive. + * A list of third-party applications which the user has installed or given access to Google Drive. */ export interface Schema$AppList { /** - * List of app IDs that the user has specified to use by default. The list - * is in reverse-priority order (lowest to highest). + * List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest). */ defaultAppIds?: string[]; /** @@ -411,14 +392,11 @@ export namespace drive_v2 { */ changeType?: string; /** - * Whether the file or shared drive has been removed from this list of - * changes, for example by deletion or loss of access. + * Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. */ deleted?: boolean; /** - * The updated state of the shared drive. Present if the changeType is - * drive, the user is still a member of the shared drive, and the shared - * drive has not been deleted. + * The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. */ drive?: Schema$Drive; /** @@ -426,8 +404,7 @@ export namespace drive_v2 { */ driveId?: string; /** - * The updated state of the file. Present if the type is file and the file - * has not been removed from this list of changes. + * The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. */ file?: Schema$File; /** @@ -472,8 +449,7 @@ export namespace drive_v2 { */ etag?: string; /** - * The list of changes. If nextPageToken is populated, then this list may be - * incomplete and an additional page of results should be fetched. + * The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ items?: Schema$Change[]; /** @@ -485,8 +461,7 @@ export namespace drive_v2 { */ largestChangeId?: string; /** - * The starting page token for future changes. This will be present only if - * the end of the current changes list has been reached. + * The starting page token for future changes. This will be present only if the end of the current changes list has been reached. */ newStartPageToken?: string; /** @@ -494,10 +469,7 @@ export namespace drive_v2 { */ nextLink?: string; /** - * The page token for the next page of changes. This will be absent if the - * end of the changes list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** @@ -514,8 +486,7 @@ export namespace drive_v2 { */ address?: string; /** - * Date and time of notification channel expiration, expressed as a Unix - * timestamp, in milliseconds. Optional. + * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ expiration?: string; /** @@ -523,8 +494,7 @@ export namespace drive_v2 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a - * resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". */ kind?: string; /** @@ -536,8 +506,7 @@ export namespace drive_v2 { */ payload?: boolean; /** - * An opaque ID that identifies the resource being watched on this channel. - * Stable across different API versions. + * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ resourceId?: string; /** @@ -545,8 +514,7 @@ export namespace drive_v2 { */ resourceUri?: string; /** - * An arbitrary string delivered to the target address with each - * notification delivered over this channel. Optional. + * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ token?: string; /** @@ -563,8 +531,7 @@ export namespace drive_v2 { */ etag?: string; /** - * The list of children. If nextPageToken is populated, then this list may - * be incomplete and an additional page of results should be fetched. + * The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ items?: Schema$ChildReference[]; /** @@ -576,10 +543,7 @@ export namespace drive_v2 { */ nextLink?: string; /** - * The page token for the next page of children. This will be absent if the - * end of the children list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of children. This will be absent if the end of the children list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** @@ -613,9 +577,7 @@ export namespace drive_v2 { */ export interface Schema$Comment { /** - * A region of the document represented as a JSON string. See anchor - * documentation for details on how to define and interpret anchor - * properties. + * A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. */ anchor?: string; /** @@ -627,9 +589,7 @@ export namespace drive_v2 { */ commentId?: string; /** - * The plain text content used to create this comment. This is not HTML safe - * and should only be used as a starting point to make edits to a - * comment's content. + * The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. */ content?: string; /** @@ -641,9 +601,7 @@ export namespace drive_v2 { */ createdDate?: string; /** - * Whether this comment has been deleted. If a comment has been deleted the - * content will be cleared and this will only represent a comment that once - * existed. + * Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. */ deleted?: boolean; /** @@ -675,10 +633,7 @@ export namespace drive_v2 { */ selfLink?: string; /** - * The status of this comment. Status can be changed by posting a reply to a - * comment with the desired status. - "open" - The comment is - * still open. - "resolved" - The comment has been resolved by - * one of its replies. + * The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - "open" - The comment is still open. - "resolved" - The comment has been resolved by one of its replies. */ status?: string; } @@ -687,8 +642,7 @@ export namespace drive_v2 { */ export interface Schema$CommentList { /** - * The list of comments. If nextPageToken is populated, then this list may - * be incomplete and an additional page of results should be fetched. + * The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ items?: Schema$Comment[]; /** @@ -700,10 +654,7 @@ export namespace drive_v2 { */ nextLink?: string; /** - * The page token for the next page of comments. This will be absent if the - * end of the comments list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** @@ -720,10 +671,7 @@ export namespace drive_v2 { */ author?: Schema$User; /** - * The plain text content used to create this reply. This is not HTML safe - * and should only be used as a starting point to make edits to a - * reply's content. This field is required on inserts if no verb is - * specified (resolve/reopen). + * The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). */ content?: string; /** @@ -731,9 +679,7 @@ export namespace drive_v2 { */ createdDate?: string; /** - * Whether this reply has been deleted. If a reply has been deleted the - * content will be cleared and this will only represent a reply that once - * existed. + * Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. */ deleted?: boolean; /** @@ -753,10 +699,7 @@ export namespace drive_v2 { */ replyId?: string; /** - * The action this reply performed to the parent comment. When creating a - * new reply this is the action to be perform to the parent comment. - * Possible values are: - "resolve" - To resolve a comment. - - * "reopen" - To reopen (un-resolve) a comment. + * The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - "resolve" - To resolve a comment. - "reopen" - To reopen (un-resolve) a comment. */ verb?: string; } @@ -765,8 +708,7 @@ export namespace drive_v2 { */ export interface Schema$CommentReplyList { /** - * The list of replies. If nextPageToken is populated, then this list may be - * incomplete and an additional page of results should be fetched. + * The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ items?: Schema$CommentReply[]; /** @@ -778,10 +720,7 @@ export namespace drive_v2 { */ nextLink?: string; /** - * The page token for the next page of replies. This will be absent if the - * end of the replies list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** @@ -794,10 +733,7 @@ export namespace drive_v2 { */ export interface Schema$Drive { /** - * An image file and cropping parameters from which a background image for - * this shared drive is set. This is a write only field; it can only be set - * on drive.drives.update requests that don't set themeId. When - * specified, all fields of the backgroundImageFile must be set. + * An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. */ backgroundImageFile?: { id?: string; @@ -833,8 +769,7 @@ export namespace drive_v2 { canTrashChildren?: boolean; }; /** - * The color of this shared drive as an RGB hex string. It can only be set - * on a drive.drives.update request that does not set themeId. + * The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. */ colorRgb?: string; /** @@ -846,8 +781,7 @@ export namespace drive_v2 { */ hidden?: boolean; /** - * The ID of this shared drive which is also the ID of the top level folder - * of this shared drive. + * The ID of this shared drive which is also the ID of the top level folder of this shared drive. */ id?: string; /** @@ -859,8 +793,7 @@ export namespace drive_v2 { */ name?: string; /** - * A set of restrictions that apply to this shared drive or items inside - * this shared drive. + * A set of restrictions that apply to this shared drive or items inside this shared drive. */ restrictions?: { adminManagedRestrictions?: boolean; @@ -869,12 +802,7 @@ export namespace drive_v2 { driveMembersOnly?: boolean; }; /** - * The ID of the theme from which the background image and color will be - * set. The set of possible driveThemes can be retrieved from a - * drive.about.get response. When not specified on a drive.drives.insert - * request, a random theme is chosen from which the background image and - * color are set. This is a write-only field; it can only be set on requests - * that don't set colorRgb or backgroundImageFile. + * The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ themeId?: string; } @@ -883,8 +811,7 @@ export namespace drive_v2 { */ export interface Schema$DriveList { /** - * The list of shared drives. If nextPageToken is populated, then this list - * may be incomplete and an additional page of results should be fetched. + * The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ items?: Schema$Drive[]; /** @@ -892,10 +819,7 @@ export namespace drive_v2 { */ kind?: string; /** - * The page token for the next page of shared drives. This will be absent if - * the end of the list has been reached. If the token is rejected for any - * reason, it should be discarded, and pagination should be restarted from - * the first page of results. + * The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; } @@ -920,8 +844,7 @@ export namespace drive_v2 { */ canReadRevisions?: boolean; /** - * Capabilities the current user has on this file. Each capability - * corresponds to a fine-grained action that a user may take. + * Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. */ capabilities?: { canAddChildren?: boolean; @@ -959,8 +882,7 @@ export namespace drive_v2 { */ copyable?: boolean; /** - * Whether the options to copy, print, or download this file, should be - * disabled for readers and commenters. + * Whether the options to copy, print, or download this file, should be disabled for readers and commenters. */ copyRequiresWriterPermission?: boolean; /** @@ -968,8 +890,7 @@ export namespace drive_v2 { */ createdDate?: string; /** - * A link to open this file with the user's default app for this file. - * Only populated when the drive.apps.readonly scope is used. + * A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. */ defaultOpenWithLink?: string; /** @@ -977,14 +898,11 @@ export namespace drive_v2 { */ description?: string; /** - * Short lived download URL for the file. This field is only populated for - * files with content stored in Google Drive; it is not populated for Google - * Docs or shortcut files. + * Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ downloadUrl?: string; /** - * ID of the shared drive the file resides in. Only populated for items in - * shared drives. + * ID of the shared drive the file resides in. Only populated for items in shared drives. */ driveId?: string; /** @@ -1000,8 +918,7 @@ export namespace drive_v2 { */ etag?: string; /** - * Whether this file has been explicitly trashed, as opposed to recursively - * trashed. + * Whether this file has been explicitly trashed, as opposed to recursively trashed. */ explicitlyTrashed?: boolean; /** @@ -1009,50 +926,31 @@ export namespace drive_v2 { */ exportLinks?: {[key: string]: string}; /** - * The final component of fullFileExtension with trailing text that does not - * appear to be part of the extension removed. This field is only populated - * for files with content stored in Google Drive; it is not populated for - * Google Docs or shortcut files. + * The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ fileExtension?: string; /** - * The size of the file in bytes. This field is only populated for files - * with content stored in Google Drive; it is not populated for Google Docs - * or shortcut files. + * The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ fileSize?: string; /** - * Folder color as an RGB hex string if the file is a folder. The list of - * supported colors is available in the folderColorPalette field of the - * About resource. If an unsupported color is specified, it will be changed - * to the closest color in the palette. Not populated for items in shared - * drives. + * Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. */ folderColorRgb?: string; /** - * The full file extension; extracted from the title. May contain multiple - * concatenated extensions, such as "tar.gz". Removing an - * extension from the title does not clear this field; however, changing the - * extension on the title does update this field. This field is only - * populated for files with content stored in Google Drive; it is not - * populated for Google Docs or shortcut files. + * The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ fullFileExtension?: string; /** - * Whether any users are granted file access directly on this file. This - * field is only populated for items in shared drives. + * Whether any users are granted file access directly on this file. This field is only populated for items in shared drives. */ hasAugmentedPermissions?: boolean; /** - * Whether this file has a thumbnail. This does not indicate whether the - * requesting app has access to the thumbnail. To check access, look for the - * presence of the thumbnailLink field. + * Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. */ hasThumbnail?: boolean; /** - * The ID of the file's head revision. This field is only populated for - * files with content stored in Google Drive; it is not populated for Google - * Docs or shortcut files. + * The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ headRevisionId?: string; /** @@ -1064,9 +962,7 @@ export namespace drive_v2 { */ id?: string; /** - * Metadata about image media. This will only be present for image types, - * and its contents will depend on what can be parsed from the image - * content. + * Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. */ imageMediaMetadata?: { aperture?: number; @@ -1123,8 +1019,7 @@ export namespace drive_v2 { */ lastModifyingUserName?: string; /** - * Last time this file was viewed by the user (formatted RFC 3339 - * timestamp). + * Last time this file was viewed by the user (formatted RFC 3339 timestamp). */ lastViewedByMeDate?: string; /** @@ -1132,49 +1027,35 @@ export namespace drive_v2 { */ markedViewedByMeDate?: string; /** - * An MD5 checksum for the content of this file. This field is only - * populated for files with content stored in Google Drive; it is not - * populated for Google Docs or shortcut files. + * An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. */ md5Checksum?: string; /** - * The MIME type of the file. This is only mutable on update when uploading - * new content. This field can be left blank, and the mimetype will be - * determined from the uploaded content's MIME type. + * The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. */ mimeType?: string; /** - * Last time this file was modified by the user (formatted RFC 3339 - * timestamp). Note that setting modifiedDate will also update the - * modifiedByMe date for the user which set the date. + * Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. */ modifiedByMeDate?: string; /** - * Last time this file was modified by anyone (formatted RFC 3339 - * timestamp). This is only mutable on update when the setModifiedDate - * parameter is set. + * Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. */ modifiedDate?: string; /** - * A map of the id of each of the user's apps to a link to open this - * file with that app. Only populated when the drive.apps.readonly scope is - * used. + * A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. */ openWithLinks?: {[key: string]: string}; /** - * The original filename of the uploaded content if available, or else the - * original value of the title field. This is only available for files with - * binary content in Google Drive. + * The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. */ originalFilename?: string; /** - * Whether the file is owned by the current user. Not populated for items in - * shared drives. + * Whether the file is owned by the current user. Not populated for items in shared drives. */ ownedByMe?: boolean; /** - * Name(s) of the owner(s) of this file. Not populated for items in shared - * drives. + * Name(s) of the owner(s) of this file. Not populated for items in shared drives. */ ownerNames?: string[]; /** @@ -1182,12 +1063,7 @@ export namespace drive_v2 { */ owners?: Schema$User[]; /** - * Collection of parent folders which contain this file. If not specified as - * part of an insert request, the file will be placed directly in the - * user's My Drive folder. If not specified as part of a copy request, - * the file will inherit any discoverable parents of the source file. Update - * requests can also use the addParents and removeParents parameters to - * modify the parents list. + * Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. */ parents?: Schema$ParentReference[]; /** @@ -1195,8 +1071,7 @@ export namespace drive_v2 { */ permissionIds?: string[]; /** - * The list of permissions for users with access to this file. Not populated - * for items in shared drives. + * The list of permissions for users with access to this file. Not populated for items in shared drives. */ permissions?: Schema$Permission[]; /** @@ -1216,13 +1091,11 @@ export namespace drive_v2 { */ shareable?: boolean; /** - * Whether the file has been shared. Not populated for items in shared - * drives. + * Whether the file has been shared. Not populated for items in shared drives. */ shared?: boolean; /** - * Time at which this file was shared with the user (formatted RFC 3339 - * timestamp). + * Time at which this file was shared with the user (formatted RFC 3339 timestamp). */ sharedWithMeDate?: string; /** @@ -1230,8 +1103,7 @@ export namespace drive_v2 { */ sharingUser?: Schema$User; /** - * The list of spaces which contain the file. Supported values are - * 'drive', 'appDataFolder' and 'photos'. + * The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string[]; /** @@ -1239,14 +1111,11 @@ export namespace drive_v2 { */ teamDriveId?: string; /** - * A thumbnail for the file. This will only be used if a standard thumbnail - * cannot be generated. + * A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. */ thumbnail?: {image?: string; mimeType?: string}; /** - * A short-lived link to the file's thumbnail. Typically lasts on the - * order of hours. Only populated when the requesting app can access the - * file's content. + * A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. */ thumbnailLink?: string; /** @@ -1254,19 +1123,15 @@ export namespace drive_v2 { */ thumbnailVersion?: string; /** - * The title of this file. Note that for immutable items such as the top - * level folders of shared drives, My Drive root folder, and Application - * Data folder the title is constant. + * The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. */ title?: string; /** - * The time that the item was trashed (formatted RFC 3339 timestamp). Only - * populated for items in shared drives. + * The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. */ trashedDate?: string; /** - * If the file has been explicitly trashed, the user who trashed it. Only - * populated for items in shared drives. + * If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. */ trashingUser?: Schema$User; /** @@ -1274,9 +1139,7 @@ export namespace drive_v2 { */ userPermission?: Schema$Permission; /** - * A monotonically increasing version number for the file. This reflects - * every change made to the file on the server, even those not visible to - * the requesting user. + * A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. */ version?: string; /** @@ -1288,19 +1151,15 @@ export namespace drive_v2 { width?: number; }; /** - * A link for downloading the content of the file in a browser using cookie - * based authentication. In cases where the content is shared publicly, the - * content can be downloaded without any credentials. + * A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. */ webContentLink?: string; /** - * A link only available on public folders for viewing their static web - * assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + * A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. */ webViewLink?: string; /** - * Whether writers can share the document with other users. Not populated - * for items in shared drives. + * Whether writers can share the document with other users. Not populated for items in shared drives. */ writersCanShare?: boolean; } @@ -1313,17 +1172,11 @@ export namespace drive_v2 { */ etag?: string; /** - * Whether the search process was incomplete. If true, then some search - * results may be missing, since all documents were not searched. This may - * occur when searching multiple drives with the "allDrives" - * corpora, but all corpora could not be searched. When this happens, it is - * suggested that clients narrow their query by choosing a different corpus - * such as "default" or "drive". + * Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive". */ incompleteSearch?: boolean; /** - * The list of files. If nextPageToken is populated, then this list may be - * incomplete and an additional page of results should be fetched. + * The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ items?: Schema$File[]; /** @@ -1335,10 +1188,7 @@ export namespace drive_v2 { */ nextLink?: string; /** - * The page token for the next page of files. This will be absent if the end - * of the files list has been reached. If the token is rejected for any - * reason, it should be discarded, and pagination should be restarted from - * the first page of results. + * The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** @@ -1414,8 +1264,7 @@ export namespace drive_v2 { */ export interface Schema$Permission { /** - * Additional roles for this user. Only commenter is currently allowed, - * though more may be supported in the future. + * Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. */ additionalRoles?: string[]; /** @@ -1423,20 +1272,15 @@ export namespace drive_v2 { */ authKey?: string; /** - * Whether the account associated with this permission has been deleted. - * This field only pertains to user and group permissions. + * Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. */ deleted?: boolean; /** - * The domain name of the entity this permission refers to. This is an - * output-only field which is present when the permission type is user, - * group or domain. + * The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. */ domain?: string; /** - * The email address of the user or group this permission refers to. This is - * an output-only field which is present when the permission type is user or - * group. + * The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. */ emailAddress?: string; /** @@ -1444,19 +1288,11 @@ export namespace drive_v2 { */ etag?: string; /** - * The time at which this permission will expire (RFC 3339 date-time). - * Expiration dates have the following restrictions: - They can only be - * set on user and group permissions - The date must be in the future - - * The date cannot be more than a year in the future - The date can only be - * set on drive.permissions.update or drive.permissions.patch requests + * The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests */ expirationDate?: string; /** - * The ID of the user this permission refers to, and identical to the - * permissionId in the About and Files resources. When making a - * drive.permissions.insert request, exactly one of the id or value fields - * must be specified unless the permission type is anyone, in which case - * both id and value are ignored. + * The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. */ id?: string; /** @@ -1468,9 +1304,7 @@ export namespace drive_v2 { */ name?: string; /** - * Details of whether the permissions on this shared drive item are - * inherited or directly on this item. This is an output-only field which is - * present only for shared drive items. + * Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. */ permissionDetails?: Array<{ additionalRoles?: string[]; @@ -1484,9 +1318,7 @@ export namespace drive_v2 { */ photoLink?: string; /** - * The primary role for this user. While new values may be supported in the - * future, the following are currently allowed: - owner - organizer - - * fileOrganizer - writer - reader + * The primary role for this user. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - reader */ role?: string; /** @@ -1504,16 +1336,11 @@ export namespace drive_v2 { teamDrivePermissionType?: string; }>; /** - * The account type. Allowed values are: - user - group - domain - - * anyone + * The account type. Allowed values are: - user - group - domain - anyone */ type?: string; /** - * The email address or domain name for the entity. This is used during - * inserts and is not populated in responses. When making a - * drive.permissions.insert request, exactly one of the id or value fields - * must be specified unless the permission type is anyone, in which case - * both id and value are ignored. + * The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. */ value?: string; /** @@ -1551,10 +1378,7 @@ export namespace drive_v2 { */ kind?: string; /** - * The page token for the next page of permissions. This field will be - * absent if the end of the permissions list has been reached. If the token - * is rejected for any reason, it should be discarded, and pagination should - * be restarted from the first page of results. + * The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** @@ -1563,11 +1387,7 @@ export namespace drive_v2 { selfLink?: string; } /** - * A key-value pair attached to a file that is either public or private to an - * application. The following limits apply to file properties: - Maximum of - * 100 properties total per file - Maximum of 30 private properties per app - - * Maximum of 30 public properties - Maximum of 124 bytes size limit on (key + - * value) string in UTF-8 encoding for a single property. + * A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: - Maximum of 100 properties total per file - Maximum of 30 private properties per app - Maximum of 30 public properties - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. */ export interface Schema$Property { /** @@ -1591,14 +1411,12 @@ export namespace drive_v2 { */ value?: string; /** - * The visibility of this property. Allowed values are PRIVATE and PUBLIC. - * (Default: PRIVATE) + * The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) */ visibility?: string; } /** - * A collection of properties, key-value pairs that are either public or - * private to an application. + * A collection of properties, key-value pairs that are either public or private to an application. */ export interface Schema$PropertyList { /** @@ -1623,8 +1441,7 @@ export namespace drive_v2 { */ export interface Schema$Revision { /** - * Short term download URL for the file. This will only be populated on - * files with content stored in Drive. + * Short term download URL for the file. This will only be populated on files with content stored in Drive. */ downloadUrl?: string; /** @@ -1636,8 +1453,7 @@ export namespace drive_v2 { */ exportLinks?: {[key: string]: string}; /** - * The size of the revision in bytes. This will only be populated on files - * with content stored in Drive. + * The size of the revision in bytes. This will only be populated on files with content stored in Drive. */ fileSize?: string; /** @@ -1657,8 +1473,7 @@ export namespace drive_v2 { */ lastModifyingUserName?: string; /** - * An MD5 checksum for the content of this revision. This will only be - * populated on files with content stored in Drive. + * An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive. */ md5Checksum?: string; /** @@ -1670,26 +1485,19 @@ export namespace drive_v2 { */ modifiedDate?: string; /** - * The original filename when this revision was created. This will only be - * populated on files with content stored in Drive. + * The original filename when this revision was created. This will only be populated on files with content stored in Drive. */ originalFilename?: string; /** - * Whether this revision is pinned to prevent automatic purging. This will - * only be populated and can only be modified on files with content stored - * in Drive which are not Google Docs. Revisions can also be pinned when - * they are created through the drive.files.insert/update/copy by using the - * pinned query parameter. + * Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. */ pinned?: boolean; /** - * Whether subsequent revisions will be automatically republished. This is - * only populated and can only be modified for Google Docs. + * Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs. */ publishAuto?: boolean; /** - * Whether this revision is published. This is only populated and can only - * be modified for Google Docs. + * Whether this revision is published. This is only populated and can only be modified for Google Docs. */ published?: boolean; /** @@ -1697,8 +1505,7 @@ export namespace drive_v2 { */ publishedLink?: string; /** - * Whether this revision is published outside the domain. This is only - * populated and can only be modified for Google Docs. + * Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs. */ publishedOutsideDomain?: boolean; /** @@ -1715,8 +1522,7 @@ export namespace drive_v2 { */ etag?: string; /** - * The list of revisions. If nextPageToken is populated, then this list may - * be incomplete and an additional page of results should be fetched. + * The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ items?: Schema$Revision[]; /** @@ -1724,10 +1530,7 @@ export namespace drive_v2 { */ kind?: string; /** - * The page token for the next page of revisions. This field will be absent - * if the end of the revisions list has been reached. If the token is - * rejected for any reason, it should be discarded and pagination should be - * restarted from the first page of results. + * The page token for the next page of revisions. This field will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** @@ -1737,8 +1540,7 @@ export namespace drive_v2 { } export interface Schema$StartPageToken { /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#startPageToken". + * Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken". */ kind?: string; /** @@ -1747,14 +1549,11 @@ export namespace drive_v2 { startPageToken?: string; } /** - * Representation of a Team Drive. + * Deprecated: use the drive collection instead. */ export interface Schema$TeamDrive { /** - * An image file and cropping parameters from which a background image for - * this Team Drive is set. This is a write only field; it can only be set on - * drive.teamdrives.update requests that don't set themeId. When - * specified, all fields of the backgroundImageFile must be set. + * An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. */ backgroundImageFile?: { id?: string; @@ -1791,8 +1590,7 @@ export namespace drive_v2 { canTrashChildren?: boolean; }; /** - * The color of this Team Drive as an RGB hex string. It can only be set on - * a drive.teamdrives.update request that does not set themeId. + * The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. */ colorRgb?: string; /** @@ -1800,8 +1598,7 @@ export namespace drive_v2 { */ createdDate?: string; /** - * The ID of this Team Drive which is also the ID of the top level folder of - * this Team Drive. + * The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. */ id?: string; /** @@ -1813,8 +1610,7 @@ export namespace drive_v2 { */ name?: string; /** - * A set of restrictions that apply to this Team Drive or items inside this - * Team Drive. + * A set of restrictions that apply to this Team Drive or items inside this Team Drive. */ restrictions?: { adminManagedRestrictions?: boolean; @@ -1823,12 +1619,7 @@ export namespace drive_v2 { teamMembersOnly?: boolean; }; /** - * The ID of the theme from which the background image and color will be - * set. The set of possible teamDriveThemes can be retrieved from a - * drive.about.get response. When not specified on a drive.teamdrives.insert - * request, a random theme is chosen from which the background image and - * color are set. This is a write-only field; it can only be set on requests - * that don't set colorRgb or backgroundImageFile. + * The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ themeId?: string; } @@ -1862,8 +1653,7 @@ export namespace drive_v2 { */ emailAddress?: string; /** - * Whether this user is the same as the authenticated user for whom the - * request was made. + * Whether this user is the same as the authenticated user for whom the request was made. */ isAuthenticatedUser?: boolean; /** @@ -1888,8 +1678,7 @@ export namespace drive_v2 { /** * drive.about.get - * @desc Gets the information about the current user along with Drive API - * settings + * @desc Gets the information about the current user along with Drive API settings * @alias drive.about.get * @memberOf! () * @@ -1965,10 +1754,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to count changes outside the My Drive hierarchy. When set to - * false, changes to files such as those in the Application Data folder or - * shared files which have not been added to My Drive will be omitted from - * the maxChangeIdCount. + * Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount. */ includeSubscribed?: boolean; /** @@ -1976,8 +1762,7 @@ export namespace drive_v2 { */ maxChangeIdCount?: string; /** - * Change ID to start counting from when calculating number of remaining - * change IDs + * Change ID to start counting from when calculating number of remaining change IDs */ startChangeId?: string; } @@ -2148,23 +1933,15 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A comma-separated list of file extensions for open with filtering. All - * apps within the given app query scope which can open any of the given - * file extensions will be included in the response. If appFilterMimeTypes - * are provided as well, the result is a union of the two resulting app - * lists. + * A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists. */ appFilterExtensions?: string; /** - * A comma-separated list of MIME types for open with filtering. All apps - * within the given app query scope which can open any of the given MIME - * types will be included in the response. If appFilterExtensions are - * provided as well, the result is a union of the two resulting app lists. + * A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists. */ appFilterMimeTypes?: string; /** - * A language or locale code, as defined by BCP 47, with some extensions - * from Unicode's LDML format (http://www.unicode.org/reports/tr35/). + * A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/). */ languageCode?: string; } @@ -2177,15 +1954,14 @@ export namespace drive_v2 { /** * drive.changes.get - * @desc Deprecated - Use changes.getStartPageToken and changes.list to - * retrieve recent changes. + * @desc Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes. * @alias drive.changes.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.changeId The ID of the change. * @param {string=} params.driveId The shared drive from which the change will be returned. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2259,7 +2035,7 @@ export namespace drive_v2 { * * @param {object=} params Parameters for request * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2340,14 +2116,14 @@ export namespace drive_v2 { * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. * @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. - * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults Maximum number of changes to return. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. * @param {string=} params.startChangeId Deprecated - use pageToken instead. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2422,14 +2198,14 @@ export namespace drive_v2 { * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. * @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. - * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults Maximum number of changes to return. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. * @param {string=} params.startChangeId Deprecated - use pageToken instead. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {().Channel} params.resource Request body data @@ -2512,8 +2288,7 @@ export namespace drive_v2 { */ driveId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -2533,13 +2308,11 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the shared drive for which the starting pageToken for listing - * future changes from that shared drive will be returned. + * The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. */ driveId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -2558,33 +2331,23 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the - * change IDs will be reflective of the shared drive; use the combined drive - * ID and change ID as an identifier. + * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** - * Whether changes should include the file resource if the file is still - * accessible by the user at the time of the request, even when a file was - * removed from the list of changes and there will be no further change - * entries for this file. + * Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. */ includeCorpusRemovals?: boolean; /** - * Whether to include changes indicating that items have been removed from - * the list of changes, for example by deletion or loss of access. + * Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. */ includeDeleted?: boolean; /** - * Whether both My Drive and shared drive items should be included in - * results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. */ includeItemsFromAllDrives?: boolean; /** - * Whether to include changes outside the My Drive hierarchy in the result. - * When set to false, changes to files such as those in the Application Data - * folder or shared files which have not been added to My Drive will be - * omitted from the result. + * Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. */ includeSubscribed?: boolean; /** @@ -2596,14 +2359,11 @@ export namespace drive_v2 { */ maxResults?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response - * or to the response from the getStartPageToken method. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. */ pageToken?: string; /** - * A comma-separated list of spaces to query. Supported values are 'drive', - * 'appDataFolder' and 'photos'. + * A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string; /** @@ -2611,8 +2371,7 @@ export namespace drive_v2 { */ startChangeId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -2631,33 +2390,23 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the - * change IDs will be reflective of the shared drive; use the combined drive - * ID and change ID as an identifier. + * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** - * Whether changes should include the file resource if the file is still - * accessible by the user at the time of the request, even when a file was - * removed from the list of changes and there will be no further change - * entries for this file. + * Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. */ includeCorpusRemovals?: boolean; /** - * Whether to include changes indicating that items have been removed from - * the list of changes, for example by deletion or loss of access. + * Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. */ includeDeleted?: boolean; /** - * Whether both My Drive and shared drive items should be included in - * results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. */ includeItemsFromAllDrives?: boolean; /** - * Whether to include changes outside the My Drive hierarchy in the result. - * When set to false, changes to files such as those in the Application Data - * folder or shared files which have not been added to My Drive will be - * omitted from the result. + * Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. */ includeSubscribed?: boolean; /** @@ -2669,14 +2418,11 @@ export namespace drive_v2 { */ maxResults?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response - * or to the response from the getStartPageToken method. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. */ pageToken?: string; /** - * A comma-separated list of spaces to query. Supported values are 'drive', - * 'appDataFolder' and 'photos'. + * A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string; /** @@ -2684,8 +2430,7 @@ export namespace drive_v2 { */ startChangeId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -2951,7 +2696,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.folderId The ID of the folder. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {().ChildReference} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3138,8 +2883,7 @@ export namespace drive_v2 { */ folderId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -3167,13 +2911,7 @@ export namespace drive_v2 { */ maxResults?: number; /** - * A comma-separated list of sort keys. Valid keys are 'createdDate', - * 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', - * 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. - * Each key sorts ascending by default, but may be reversed with the 'desc' - * modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please - * note that there is a current limitation for users with approximately one - * million files in which the requested sort order is ignored. + * A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. */ orderBy?: string; /** @@ -3659,8 +3397,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * If set, this will succeed when retrieving a deleted comment, and will - * include any deleted replies. + * If set, this will succeed when retrieving a deleted comment, and will include any deleted replies. */ includeDeleted?: boolean; } @@ -3691,24 +3428,19 @@ export namespace drive_v2 { */ fileId?: string; /** - * If set, all comments and replies, including deleted comments and replies - * (with content stripped) will be returned. + * If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned. */ includeDeleted?: boolean; /** - * The maximum number of discussions to include in the response, used for - * paging. + * The maximum number of discussions to include in the response, used for paging. */ maxResults?: number; /** - * The continuation token, used to page through large result sets. To get - * the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** - * Only discussions that were updated after this timestamp will be returned. - * Formatted as an RFC 3339 timestamp. + * Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp. */ updatedMin?: string; } @@ -3761,8 +3493,7 @@ export namespace drive_v2 { /** * drive.drives.delete - * @desc Permanently deletes a shared drive for which the user is an - * organizer. The shared drive cannot contain any untrashed items. + * @desc Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. * @alias drive.drives.delete * @memberOf! () * @@ -4283,9 +4014,7 @@ export namespace drive_v2 { */ driveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -4307,11 +4036,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An ID, such as a random UUID, which uniquely identifies this user's - * request for idempotent creation of a shared drive. A repeated request by - * the same user and with the same request ID will avoid creating duplicates - * by attempting to create the same shared drive. If the shared drive - * already exists a 409 error will be returned. + * An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. */ requestId?: string; @@ -4339,9 +4064,7 @@ export namespace drive_v2 { */ q?: string; /** - * Issue the request as a domain administrator; if set to true, then all - * shared drives of the domain in which the requester is an administrator - * are returned. + * Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned. */ useDomainAdminAccess?: boolean; } @@ -4367,9 +4090,7 @@ export namespace drive_v2 { */ driveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -4397,7 +4118,7 @@ export namespace drive_v2 { * @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. * @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes. * @param {boolean=} params.pinned Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.timedTextLanguage The language of the timed text. * @param {string=} params.timedTextTrackName The timed text track name. @@ -4468,15 +4189,13 @@ export namespace drive_v2 { /** * drive.files.delete - * @desc Permanently deletes a file by ID. Skips the trash. The currently - * authenticated user must own the file or be an organizer on the parent for - * shared drive files. + * @desc Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files. * @alias drive.files.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file to delete. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4613,9 +4332,7 @@ export namespace drive_v2 { /** * drive.files.export - * @desc Exports a Google Doc to the requested MIME type and returns the - * exported content. Please note that the exported content is limited to - * 10MB. + * @desc Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB. * @alias drive.files.export * @memberOf! () * @@ -4687,8 +4404,7 @@ export namespace drive_v2 { /** * drive.files.generateIds - * @desc Generates a set of file IDs which can be provided in insert - * requests. + * @desc Generates a set of file IDs which can be provided in insert requests. * @alias drive.files.generateIds * @memberOf! () * @@ -4772,7 +4488,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file in question. * @param {string=} params.projection This parameter is deprecated and has no function. * @param {string=} params.revisionId Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.updateViewedDate Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4849,7 +4565,7 @@ export namespace drive_v2 { * @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. * @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes. * @param {boolean=} params.pinned Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.timedTextLanguage The language of the timed text. * @param {string=} params.timedTextTrackName The timed text track name. @@ -4933,7 +4649,7 @@ export namespace drive_v2 { * @param {string=} params.corpora Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency. * @param {string=} params.corpus The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead. * @param {string=} params.driveId ID of the shared drive to search. - * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. * @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. @@ -4941,7 +4657,7 @@ export namespace drive_v2 { * @param {string=} params.projection This parameter is deprecated and has no function. * @param {string=} params.q Query string for searching files. * @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5006,8 +4722,7 @@ export namespace drive_v2 { /** * drive.files.patch - * @desc Updates file metadata and/or content. This method supports patch - * semantics. + * @desc Updates file metadata and/or content. This method supports patch semantics. * @alias drive.files.patch * @memberOf! () * @@ -5022,7 +4737,7 @@ export namespace drive_v2 { * @param {boolean=} params.pinned Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. * @param {string=} params.removeParents Comma-separated list of parent IDs to remove. * @param {boolean=} params.setModifiedDate Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.timedTextLanguage The language of the timed text. * @param {string=} params.timedTextTrackName The timed text track name. @@ -5100,7 +4815,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file to update. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5167,15 +4882,13 @@ export namespace drive_v2 { /** * drive.files.trash - * @desc Moves a file to the trash. The currently authenticated user must - * own the file or be at least a fileOrganizer on the parent for shared - * drive files. + * @desc Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. * @alias drive.files.trash * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file to trash. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5248,7 +4961,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file to untrash. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5330,7 +5043,7 @@ export namespace drive_v2 { * @param {boolean=} params.pinned Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. * @param {string=} params.removeParents Comma-separated list of parent IDs to remove. * @param {boolean=} params.setModifiedDate Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.timedTextLanguage The language of the timed text. * @param {string=} params.timedTextTrackName The timed text track name. @@ -5418,7 +5131,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file in question. * @param {string=} params.projection This parameter is deprecated and has no function. * @param {string=} params.revisionId Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.updateViewedDate Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. * @param {().Channel} params.resource Request body data @@ -5505,18 +5218,15 @@ export namespace drive_v2 { */ ocr?: boolean; /** - * If ocr is true, hints at the language to use. Valid values are BCP 47 - * codes. + * If ocr is true, hints at the language to use. Valid values are BCP 47 codes. */ ocrLanguage?: string; /** - * Whether to pin the head revision of the new copy. A file can have a - * maximum of 200 pinned revisions. + * Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. */ pinned?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5532,8 +5242,7 @@ export namespace drive_v2 { */ timedTextTrackName?: string; /** - * The visibility of the new file. This parameter is only relevant when the - * source is not a native Google Doc and convert=false. + * The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false. */ visibility?: string; @@ -5553,8 +5262,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5595,8 +5303,7 @@ export namespace drive_v2 { */ maxResults?: number; /** - * The space in which the IDs can be used to create new files. Supported - * values are 'drive' and 'appDataFolder'. + * The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. */ space?: string; } @@ -5607,8 +5314,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the user is acknowledging the risk of downloading known malware - * or other abusive files. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. */ acknowledgeAbuse?: boolean; /** @@ -5620,13 +5326,11 @@ export namespace drive_v2 { */ projection?: string; /** - * Specifies the Revision ID that should be downloaded. Ignored unless - * alt=media is specified. + * Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. */ revisionId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5634,8 +5338,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Deprecated: Use files.update with modifiedDateBehavior=noChange, - * updateViewedDate=true and an empty request body. + * Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. */ updateViewedDate?: boolean; } @@ -5654,18 +5357,15 @@ export namespace drive_v2 { */ ocr?: boolean; /** - * If ocr is true, hints at the language to use. Valid values are BCP 47 - * codes. + * If ocr is true, hints at the language to use. Valid values are BCP 47 codes. */ ocrLanguage?: string; /** - * Whether to pin the head revision of the uploaded file. A file can have a - * maximum of 200 pinned revisions. + * Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. */ pinned?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5685,8 +5385,7 @@ export namespace drive_v2 { */ useContentAsIndexableText?: boolean; /** - * The visibility of the new file. This parameter is only relevant when - * convert=false. + * The visibility of the new file. This parameter is only relevant when convert=false. */ visibility?: string; @@ -5717,14 +5416,11 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Bodies of items (files/documents) to which the query applies. Supported - * bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' - * or 'drive' to 'allDrives' for efficiency. + * Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency. */ corpora?: string; /** - * The body of items (files/documents) to which the query applies. - * Deprecated: use 'corpora' instead. + * The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead. */ corpus?: string; /** @@ -5732,8 +5428,7 @@ export namespace drive_v2 { */ driveId?: string; /** - * Whether both My Drive and shared drive items should be included in - * results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. */ includeItemsFromAllDrives?: boolean; /** @@ -5741,20 +5436,11 @@ export namespace drive_v2 { */ includeTeamDriveItems?: boolean; /** - * The maximum number of files to return per page. Partial or empty result - * pages are possible even before the end of the files list has been - * reached. + * The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. */ maxResults?: number; /** - * A comma-separated list of sort keys. Valid keys are 'createdDate', - * 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', - * 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and - * 'title_natural'. Each key sorts ascending by default, but may be reversed - * with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate - * desc,title. Please note that there is a current limitation for users with - * approximately one million files in which the requested sort order is - * ignored. + * A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. */ orderBy?: string; /** @@ -5770,13 +5456,11 @@ export namespace drive_v2 { */ q?: string; /** - * A comma-separated list of spaces to query. Supported values are 'drive', - * 'appDataFolder' and 'photos'. + * A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5807,18 +5491,11 @@ export namespace drive_v2 { */ fileId?: string; /** - * Determines the behavior in which modifiedDate is updated. This overrides - * setModifiedDate. + * Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. */ modifiedDateBehavior?: string; /** - * Whether a blob upload should create a new revision. If false, the blob - * data in the current head revision is replaced. If true or not set, a new - * blob is created as head revision, and previous unpinned revisions are - * preserved for a short period of time. Pinned revisions are stored - * indefinitely, using additional storage quota, up to a maximum of 200 - * revisions. For details on how revisions are retained, see the Drive Help - * Center. + * Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. */ newRevision?: boolean; /** @@ -5826,13 +5503,11 @@ export namespace drive_v2 { */ ocr?: boolean; /** - * If ocr is true, hints at the language to use. Valid values are BCP 47 - * codes. + * If ocr is true, hints at the language to use. Valid values are BCP 47 codes. */ ocrLanguage?: string; /** - * Whether to pin the new revision. A file can have a maximum of 200 pinned - * revisions. + * Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. */ pinned?: boolean; /** @@ -5840,16 +5515,11 @@ export namespace drive_v2 { */ removeParents?: string; /** - * Whether to set the modified date using the value supplied in the request - * body. Setting this field to true is equivalent to - * modifiedDateBehavior=fromBodyOrNow, and false is equivalent to - * modifiedDateBehavior=now. To prevent any changes to the modified date set - * modifiedDateBehavior=noChange. + * Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. */ setModifiedDate?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5889,8 +5559,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5909,8 +5578,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5929,8 +5597,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -5957,18 +5624,11 @@ export namespace drive_v2 { */ fileId?: string; /** - * Determines the behavior in which modifiedDate is updated. This overrides - * setModifiedDate. + * Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. */ modifiedDateBehavior?: string; /** - * Whether a blob upload should create a new revision. If false, the blob - * data in the current head revision is replaced. If true or not set, a new - * blob is created as head revision, and previous unpinned revisions are - * preserved for a short period of time. Pinned revisions are stored - * indefinitely, using additional storage quota, up to a maximum of 200 - * revisions. For details on how revisions are retained, see the Drive Help - * Center. + * Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. */ newRevision?: boolean; /** @@ -5976,13 +5636,11 @@ export namespace drive_v2 { */ ocr?: boolean; /** - * If ocr is true, hints at the language to use. Valid values are BCP 47 - * codes. + * If ocr is true, hints at the language to use. Valid values are BCP 47 codes. */ ocrLanguage?: string; /** - * Whether to pin the new revision. A file can have a maximum of 200 pinned - * revisions. + * Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. */ pinned?: boolean; /** @@ -5990,16 +5648,11 @@ export namespace drive_v2 { */ removeParents?: string; /** - * Whether to set the modified date using the value supplied in the request - * body. Setting this field to true is equivalent to - * modifiedDateBehavior=fromBodyOrNow, and false is equivalent to - * modifiedDateBehavior=now. To prevent any changes to the modified date set - * modifiedDateBehavior=noChange. + * Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. */ setModifiedDate?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -6050,8 +5703,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the user is acknowledging the risk of downloading known malware - * or other abusive files. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. */ acknowledgeAbuse?: boolean; /** @@ -6063,13 +5715,11 @@ export namespace drive_v2 { */ projection?: string; /** - * Specifies the Revision ID that should be downloaded. Ignored unless - * alt=media is specified. + * Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. */ revisionId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -6077,8 +5727,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Deprecated: Use files.update with modifiedDateBehavior=noChange, - * updateViewedDate=true and an empty request body. + * Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. */ updateViewedDate?: boolean; @@ -6246,7 +5895,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {().ParentReference} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6429,8 +6078,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -6470,7 +6118,7 @@ export namespace drive_v2 { * @param {object} params Parameters for request * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6545,7 +6193,7 @@ export namespace drive_v2 { * @param {object} params Parameters for request * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6696,7 +6344,7 @@ export namespace drive_v2 { * @param {string=} params.emailMessage A plain text custom message to include in notification emails. * @param {string} params.fileId The ID for the file or shared drive. * @param {boolean=} params.sendNotificationEmails Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {().Permission} params.resource Request body data @@ -6776,7 +6424,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file or shared drive. * @param {integer=} params.maxResults The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6854,7 +6502,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. * @param {boolean=} params.removeExpiration Whether to remove the expiration date. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. @@ -6934,7 +6582,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. * @param {boolean=} params.removeExpiration Whether to remove the expiration date. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. @@ -7021,8 +6669,7 @@ export namespace drive_v2 { */ permissionId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -7030,10 +6677,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -7052,8 +6696,7 @@ export namespace drive_v2 { */ permissionId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -7061,10 +6704,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -7096,13 +6736,11 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether to send notification emails when sharing to users or groups. This - * parameter is ignored and an email is sent if the role is owner. + * Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner. */ sendNotificationEmails?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -7110,10 +6748,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -7133,20 +6768,15 @@ export namespace drive_v2 { */ fileId?: string; /** - * The maximum number of permissions to return per page. When not set for - * files in a shared drive, at most 100 results will be returned. When not - * set for files that are not in a shared drive, the entire list will be - * returned. + * The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. */ maxResults?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. */ pageToken?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -7154,10 +6784,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -7181,8 +6808,7 @@ export namespace drive_v2 { */ removeExpiration?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -7190,15 +6816,11 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Whether changing a role to 'owner' downgrades the current owners to - * writers. Does nothing if the specified role is not 'owner'. + * Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. */ transferOwnership?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -7227,8 +6849,7 @@ export namespace drive_v2 { */ removeExpiration?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -7236,15 +6857,11 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Whether changing a role to 'owner' downgrades the current owners to - * writers. Does nothing if the specified role is not 'owner'. + * Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. */ transferOwnership?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -7781,8 +7398,7 @@ export namespace drive_v2 { */ propertyKey?: string; /** - * The visibility of the property. Allowed values are PRIVATE and PUBLIC. - * (Default: PRIVATE) + * The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) */ visibility?: string; @@ -7807,8 +7423,7 @@ export namespace drive_v2 { */ propertyKey?: string; /** - * The visibility of the property. Allowed values are PRIVATE and PUBLIC. - * (Default: PRIVATE) + * The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) */ visibility?: string; @@ -7826,8 +7441,7 @@ export namespace drive_v2 { /** * drive.realtime.get - * @desc Exports the contents of the Realtime API data model associated with - * this file as JSON. + * @desc Exports the contents of the Realtime API data model associated with this file as JSON. * @alias drive.realtime.get * @memberOf! () * @@ -7899,8 +7513,7 @@ export namespace drive_v2 { /** * drive.realtime.update - * @desc Overwrites the Realtime API data model associated with this file - * with the provided JSON data model. + * @desc Overwrites the Realtime API data model associated with this file with the provided JSON data model. * @alias drive.realtime.update * @memberOf! () * @@ -7988,9 +7601,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * The revision of the Realtime API data model to export. Revisions start at - * 1 (the initial empty data model) and are incremented with each change. If - * this parameter is excluded, the most recent data model will be returned. + * The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned. */ revision?: number; } @@ -8001,11 +7612,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The revision of the model to diff the uploaded model against. If set, the - * uploaded model is diffed against the provided revision and those - * differences are merged with any changes made to the model after the - * provided revision. If not set, the uploaded model replaces the current - * model on the server. + * The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server. */ baseRevision?: string; /** @@ -8564,19 +8171,15 @@ export namespace drive_v2 { */ fileId?: string; /** - * If set, all replies, including deleted replies (with content stripped) - * will be returned. + * If set, all replies, including deleted replies (with content stripped) will be returned. */ includeDeleted?: boolean; /** - * The maximum number of replies to include in the response, used for - * paging. + * The maximum number of replies to include in the response, used for paging. */ maxResults?: number; /** - * The continuation token, used to page through large result sets. To get - * the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -8637,10 +8240,7 @@ export namespace drive_v2 { /** * drive.revisions.delete - * @desc Permanently deletes a file version. You can only delete revisions - * for files with binary content, like images or videos. Revisions for other - * files, like Google Docs or Sheets, and the last remaining file version - * can't be deleted. + * @desc Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. * @alias drive.revisions.delete * @memberOf! () * @@ -9045,8 +8645,7 @@ export namespace drive_v2 { */ maxResults?: number; /** - * Page token for revisions. To get the next page of results, set this - * parameter to the value of "nextPageToken" from the previous response. + * Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -9494,9 +9093,7 @@ export namespace drive_v2 { */ teamDriveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the Team Drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. */ useDomainAdminAccess?: boolean; } @@ -9508,11 +9105,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An ID, such as a random UUID, which uniquely identifies this user's - * request for idempotent creation of a Team Drive. A repeated request by - * the same user and with the same request ID will avoid creating duplicates - * by attempting to create the same Team Drive. If the Team Drive already - * exists a 409 error will be returned. + * An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned. */ requestId?: string; @@ -9540,9 +9133,7 @@ export namespace drive_v2 { */ q?: string; /** - * Issue the request as a domain administrator; if set to true, then all - * Team Drives of the domain in which the requester is an administrator are - * returned. + * Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned. */ useDomainAdminAccess?: boolean; } @@ -9558,9 +9149,7 @@ export namespace drive_v2 { */ teamDriveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the Team Drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. */ useDomainAdminAccess?: boolean; diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 1851add0fdf..88849b9b852 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace drive_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace drive_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace drive_v3 { /** * Drive API * - * Manages files in Drive including uploading, downloading, searching, - * detecting changes, and updating sharing permissions. + * Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions. * * @example * const {google} = require('googleapis'); @@ -105,7 +101,10 @@ export namespace drive_v3 { teamdrives: Resource$Teamdrives; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.about = new Resource$About(this.context); this.changes = new Resource$Changes(this.context); @@ -157,8 +156,7 @@ export namespace drive_v3 { */ importFormats?: {[key: string]: string[]}; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#about". + * Identifies what kind of resource this is. Value: the fixed string "drive#about". */ kind?: string; /** @@ -170,8 +168,7 @@ export namespace drive_v3 { */ maxUploadSize?: string; /** - * The user's storage quota limits and usage. All fields are measured in - * bytes. + * The user's storage quota limits and usage. All fields are measured in bytes. */ storageQuota?: { limit?: string; @@ -201,9 +198,7 @@ export namespace drive_v3 { */ changeType?: string; /** - * The updated state of the shared drive. Present if the changeType is - * drive, the user is still a member of the shared drive, and the shared - * drive has not been deleted. + * The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. */ drive?: Schema$Drive; /** @@ -211,8 +206,7 @@ export namespace drive_v3 { */ driveId?: string; /** - * The updated state of the file. Present if the type is file and the file - * has not been removed from this list of changes. + * The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. */ file?: Schema$File; /** @@ -220,13 +214,11 @@ export namespace drive_v3 { */ fileId?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#change". + * Identifies what kind of resource this is. Value: the fixed string "drive#change". */ kind?: string; /** - * Whether the file or shared drive has been removed from this list of - * changes, for example by deletion or loss of access. + * Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. */ removed?: boolean; /** @@ -251,25 +243,19 @@ export namespace drive_v3 { */ export interface Schema$ChangeList { /** - * The list of changes. If nextPageToken is populated, then this list may be - * incomplete and an additional page of results should be fetched. + * The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ changes?: Schema$Change[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#changeList". + * Identifies what kind of resource this is. Value: the fixed string "drive#changeList". */ kind?: string; /** - * The starting page token for future changes. This will be present only if - * the end of the current changes list has been reached. + * The starting page token for future changes. This will be present only if the end of the current changes list has been reached. */ newStartPageToken?: string; /** - * The page token for the next page of changes. This will be absent if the - * end of the changes list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; } @@ -282,8 +268,7 @@ export namespace drive_v3 { */ address?: string; /** - * Date and time of notification channel expiration, expressed as a Unix - * timestamp, in milliseconds. Optional. + * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ expiration?: string; /** @@ -291,8 +276,7 @@ export namespace drive_v3 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a - * resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". */ kind?: string; /** @@ -304,8 +288,7 @@ export namespace drive_v3 { */ payload?: boolean; /** - * An opaque ID that identifies the resource being watched on this channel. - * Stable across different API versions. + * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ resourceId?: string; /** @@ -313,8 +296,7 @@ export namespace drive_v3 { */ resourceUri?: string; /** - * An arbitrary string delivered to the target address with each - * notification delivered over this channel. Optional. + * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ token?: string; /** @@ -327,9 +309,7 @@ export namespace drive_v3 { */ export interface Schema$Comment { /** - * A region of the document represented as a JSON string. See anchor - * documentation for details on how to define and interpret anchor - * properties. + * A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. */ anchor?: string; /** @@ -337,8 +317,7 @@ export namespace drive_v3 { */ author?: Schema$User; /** - * The plain text content of the comment. This field is used for setting the - * content, while htmlContent should be displayed. + * The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed. */ content?: string; /** @@ -358,19 +337,15 @@ export namespace drive_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#comment". + * Identifies what kind of resource this is. Value: the fixed string "drive#comment". */ kind?: string; /** - * The last time the comment or any of its replies was modified (RFC 3339 - * date-time). + * The last time the comment or any of its replies was modified (RFC 3339 date-time). */ modifiedTime?: string; /** - * The file content to which the comment refers, typically within the anchor - * region. For a text file, for example, this would be the text at the - * location of the comment. + * The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. */ quotedFileContent?: {mimeType?: string; value?: string}; /** @@ -387,20 +362,15 @@ export namespace drive_v3 { */ export interface Schema$CommentList { /** - * The list of comments. If nextPageToken is populated, then this list may - * be incomplete and an additional page of results should be fetched. + * The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ comments?: Schema$Comment[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#commentList". + * Identifies what kind of resource this is. Value: the fixed string "drive#commentList". */ kind?: string; /** - * The page token for the next page of comments. This will be absent if the - * end of the comments list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; } @@ -409,10 +379,7 @@ export namespace drive_v3 { */ export interface Schema$Drive { /** - * An image file and cropping parameters from which a background image for - * this shared drive is set. This is a write only field; it can only be set - * on drive.drives.update requests that don't set themeId. When - * specified, all fields of the backgroundImageFile must be set. + * An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. */ backgroundImageFile?: { id?: string; @@ -448,8 +415,7 @@ export namespace drive_v3 { canTrashChildren?: boolean; }; /** - * The color of this shared drive as an RGB hex string. It can only be set - * on a drive.drives.update request that does not set themeId. + * The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. */ colorRgb?: string; /** @@ -461,13 +427,11 @@ export namespace drive_v3 { */ hidden?: boolean; /** - * The ID of this shared drive which is also the ID of the top level folder - * of this shared drive. + * The ID of this shared drive which is also the ID of the top level folder of this shared drive. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#drive". + * Identifies what kind of resource this is. Value: the fixed string "drive#drive". */ kind?: string; /** @@ -475,8 +439,7 @@ export namespace drive_v3 { */ name?: string; /** - * A set of restrictions that apply to this shared drive or items inside - * this shared drive. + * A set of restrictions that apply to this shared drive or items inside this shared drive. */ restrictions?: { adminManagedRestrictions?: boolean; @@ -485,12 +448,7 @@ export namespace drive_v3 { driveMembersOnly?: boolean; }; /** - * The ID of the theme from which the background image and color will be - * set. The set of possible driveThemes can be retrieved from a - * drive.about.get response. When not specified on a drive.drives.create - * request, a random theme is chosen from which the background image and - * color are set. This is a write-only field; it can only be set on requests - * that don't set colorRgb or backgroundImageFile. + * The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ themeId?: string; } @@ -499,20 +457,15 @@ export namespace drive_v3 { */ export interface Schema$DriveList { /** - * The list of shared drives. If nextPageToken is populated, then this list - * may be incomplete and an additional page of results should be fetched. + * The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ drives?: Schema$Drive[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#driveList". + * Identifies what kind of resource this is. Value: the fixed string "drive#driveList". */ kind?: string; /** - * The page token for the next page of shared drives. This will be absent if - * the end of the list has been reached. If the token is rejected for any - * reason, it should be discarded, and pagination should be restarted from - * the first page of results. + * The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; } @@ -521,14 +474,11 @@ export namespace drive_v3 { */ export interface Schema$File { /** - * A collection of arbitrary key-value pairs which are private to the - * requesting app. Entries with null values are cleared in update and copy - * requests. + * A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests. */ appProperties?: {[key: string]: string}; /** - * Capabilities the current user has on this file. Each capability - * corresponds to a fine-grained action that a user may take. + * Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. */ capabilities?: { canAddChildren?: boolean; @@ -562,16 +512,14 @@ export namespace drive_v3 { canUntrash?: boolean; }; /** - * Additional information about the content of the file. These fields are - * never populated in responses. + * Additional information about the content of the file. These fields are never populated in responses. */ contentHints?: { indexableText?: string; thumbnail?: {image?: string; mimeType?: string}; }; /** - * Whether the options to copy, print, or download this file, should be - * disabled for readers and commenters. + * Whether the options to copy, print, or download this file, should be disabled for readers and commenters. */ copyRequiresWriterPermission?: boolean; /** @@ -583,13 +531,11 @@ export namespace drive_v3 { */ description?: string; /** - * ID of the shared drive the file resides in. Only populated for items in - * shared drives. + * ID of the shared drive the file resides in. Only populated for items in shared drives. */ driveId?: string; /** - * Whether the file has been explicitly trashed, as opposed to recursively - * trashed from a parent folder. + * Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder. */ explicitlyTrashed?: boolean; /** @@ -597,39 +543,27 @@ export namespace drive_v3 { */ exportLinks?: {[key: string]: string}; /** - * The final component of fullFileExtension. This is only available for - * files with binary content in Google Drive. + * The final component of fullFileExtension. This is only available for files with binary content in Google Drive. */ fileExtension?: string; /** - * The color for a folder as an RGB hex string. The supported colors are - * published in the folderColorPalette field of the About resource. If an - * unsupported color is specified, the closest color in the palette will be - * used instead. + * The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead. */ folderColorRgb?: string; /** - * The full file extension extracted from the name field. May contain - * multiple concatenated extensions, such as "tar.gz". This is - * only available for files with binary content in Google Drive. This is - * automatically updated when the name field changes, however it is not - * cleared if the new name does not contain a valid extension. + * The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension. */ fullFileExtension?: string; /** - * Whether any users are granted file access directly on this file. This - * field is only populated for shared drive files. + * Whether any users are granted file access directly on this file. This field is only populated for shared drive files. */ hasAugmentedPermissions?: boolean; /** - * Whether this file has a thumbnail. This does not indicate whether the - * requesting app has access to the thumbnail. To check access, look for the - * presence of the thumbnailLink field. + * Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. */ hasThumbnail?: boolean; /** - * The ID of the file's head revision. This is currently only available - * for files with binary content in Google Drive. + * The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. */ headRevisionId?: string; /** @@ -671,8 +605,7 @@ export namespace drive_v3 { */ isAppAuthorized?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#file". + * Identifies what kind of resource this is. Value: the fixed string "drive#file". */ kind?: string; /** @@ -680,17 +613,11 @@ export namespace drive_v3 { */ lastModifyingUser?: Schema$User; /** - * The MD5 checksum for the content of the file. This is only applicable to - * files with binary content in Google Drive. + * The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. */ md5Checksum?: string; /** - * The MIME type of the file. Google Drive will attempt to automatically - * detect an appropriate value from uploaded content if no value is - * provided. The value cannot be changed unless a new revision is uploaded. - * If a file is created with a Google Doc MIME type, the uploaded content - * will be imported if possible. The supported import formats are published - * in the About resource. + * The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource. */ mimeType?: string; /** @@ -702,21 +629,15 @@ export namespace drive_v3 { */ modifiedByMeTime?: string; /** - * The last time the file was modified by anyone (RFC 3339 date-time). Note - * that setting modifiedTime will also update modifiedByMeTime for the user. + * The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. */ modifiedTime?: string; /** - * The name of the file. This is not necessarily unique within a folder. - * Note that for immutable items such as the top level folders of shared - * drives, My Drive root folder, and Application Data folder the name is - * constant. + * The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. */ name?: string; /** - * The original filename of the uploaded content if available, or else the - * original value of the name field. This is only available for files with - * binary content in Google Drive. + * The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive. */ originalFilename?: string; /** @@ -724,17 +645,11 @@ export namespace drive_v3 { */ ownedByMe?: boolean; /** - * The owners of the file. Currently, only certain legacy files may have - * more than one owner. Not populated for items in shared drives. + * The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives. */ owners?: Schema$User[]; /** - * The IDs of the parent folders which contain the file. If not specified as - * part of a create request, the file will be placed directly in the - * user's My Drive folder. If not specified as part of a copy request, - * the file will inherit any discoverable parents of the source file. Update - * requests must use the addParents and removeParents parameters to modify - * the parents list. + * The IDs of the parent folders which contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list. */ parents?: string[]; /** @@ -742,29 +657,23 @@ export namespace drive_v3 { */ permissionIds?: string[]; /** - * The full list of permissions for the file. This is only available if the - * requesting user can share the file. Not populated for items in shared - * drives. + * The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. */ permissions?: Schema$Permission[]; /** - * A collection of arbitrary key-value pairs which are visible to all apps. - * Entries with null values are cleared in update and copy requests. + * A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests. */ properties?: {[key: string]: string}; /** - * The number of storage quota bytes used by the file. This includes the - * head revision as well as previous revisions with keepForever enabled. + * The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled. */ quotaBytesUsed?: string; /** - * Whether the file has been shared. Not populated for items in shared - * drives. + * Whether the file has been shared. Not populated for items in shared drives. */ shared?: boolean; /** - * The time at which the file was shared with the user, if applicable (RFC - * 3339 date-time). + * The time at which the file was shared with the user, if applicable (RFC 3339 date-time). */ sharedWithMeTime?: string; /** @@ -772,13 +681,11 @@ export namespace drive_v3 { */ sharingUser?: Schema$User; /** - * The size of the file's content in bytes. This is only applicable to - * files with binary content in Google Drive. + * The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive. */ size?: string; /** - * The list of spaces which contain the file. The currently supported values - * are 'drive', 'appDataFolder' and 'photos'. + * The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string[]; /** @@ -790,9 +697,7 @@ export namespace drive_v3 { */ teamDriveId?: string; /** - * A short-lived link to the file's thumbnail, if available. Typically - * lasts on the order of hours. Only populated when the requesting app can - * access the file's content. + * A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. */ thumbnailLink?: string; /** @@ -800,30 +705,23 @@ export namespace drive_v3 { */ thumbnailVersion?: string; /** - * Whether the file has been trashed, either explicitly or from a trashed - * parent folder. Only the owner may trash a file, and other users cannot - * see files in the owner's trash. + * Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. */ trashed?: boolean; /** - * The time that the item was trashed (RFC 3339 date-time). Only populated - * for items in shared drives. + * The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. */ trashedTime?: string; /** - * If the file has been explicitly trashed, the user who trashed it. Only - * populated for items in shared drives. + * If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. */ trashingUser?: Schema$User; /** - * A monotonically increasing version number for the file. This reflects - * every change made to the file on the server, even those not visible to - * the user. + * A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user. */ version?: string; /** - * Additional metadata about video media. This may not be available - * immediately upon upload. + * Additional metadata about video media. This may not be available immediately upon upload. */ videoMediaMetadata?: { durationMillis?: string; @@ -843,18 +741,15 @@ export namespace drive_v3 { */ viewersCanCopyContent?: boolean; /** - * A link for downloading the content of the file in a browser. This is only - * available for files with binary content in Google Drive. + * A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. */ webContentLink?: string; /** - * A link for opening the file in a relevant Google editor or viewer in a - * browser. + * A link for opening the file in a relevant Google editor or viewer in a browser. */ webViewLink?: string; /** - * Whether users with only writer permission can modify the file's - * permissions. Not populated for items in shared drives. + * Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. */ writersCanShare?: boolean; } @@ -863,29 +758,19 @@ export namespace drive_v3 { */ export interface Schema$FileList { /** - * The list of files. If nextPageToken is populated, then this list may be - * incomplete and an additional page of results should be fetched. + * The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ files?: Schema$File[]; /** - * Whether the search process was incomplete. If true, then some search - * results may be missing, since all documents were not searched. This may - * occur when searching multiple drives with the "allDrives" - * corpora, but all corpora could not be searched. When this happens, it is - * suggested that clients narrow their query by choosing a different corpus - * such as "user" or "drive". + * Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "user" or "drive". */ incompleteSearch?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#fileList". + * Identifies what kind of resource this is. Value: the fixed string "drive#fileList". */ kind?: string; /** - * The page token for the next page of files. This will be absent if the end - * of the files list has been reached. If the token is rejected for any - * reason, it should be discarded, and pagination should be restarted from - * the first page of results. + * The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; } @@ -898,8 +783,7 @@ export namespace drive_v3 { */ ids?: string[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#generatedIds". + * Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds". */ kind?: string; /** @@ -908,18 +792,15 @@ export namespace drive_v3 { space?: string; } /** - * A permission for a file. A permission grants a user, group, domain or the - * world access to a file or a folder hierarchy. + * A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy. */ export interface Schema$Permission { /** - * Whether the permission allows the file to be discovered through search. - * This is only applicable for permissions of type domain or anyone. + * Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. */ allowFileDiscovery?: boolean; /** - * Whether the account associated with this permission has been deleted. - * This field only pertains to user and group permissions. + * Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. */ deleted?: boolean; /** @@ -935,26 +816,19 @@ export namespace drive_v3 { */ emailAddress?: string; /** - * The time at which this permission will expire (RFC 3339 date-time). - * Expiration times have the following restrictions: - They can only be - * set on user and group permissions - The time must be in the future - - * The time cannot be more than a year in the future + * The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future */ expirationTime?: string; /** - * The ID of this permission. This is a unique identifier for the grantee, - * and is published in User resources as permissionId. + * The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#permission". + * Identifies what kind of resource this is. Value: the fixed string "drive#permission". */ kind?: string; /** - * Details of whether the permissions on this shared drive item are - * inherited or directly on this item. This is an output-only field which is - * present only for shared drive items. + * Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. */ permissionDetails?: Array<{ inherited?: boolean; @@ -967,9 +841,7 @@ export namespace drive_v3 { */ photoLink?: string; /** - * The role granted by this permission. While new values may be supported in - * the future, the following are currently allowed: - owner - organizer - * - fileOrganizer - writer - commenter - reader + * The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader */ role?: string; /** @@ -982,8 +854,7 @@ export namespace drive_v3 { teamDrivePermissionType?: string; }>; /** - * The type of the grantee. Valid values are: - user - group - domain - - * anyone + * The type of the grantee. Valid values are: - user - group - domain - anyone */ type?: string; } @@ -992,20 +863,15 @@ export namespace drive_v3 { */ export interface Schema$PermissionList { /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#permissionList". + * Identifies what kind of resource this is. Value: the fixed string "drive#permissionList". */ kind?: string; /** - * The page token for the next page of permissions. This field will be - * absent if the end of the permissions list has been reached. If the token - * is rejected for any reason, it should be discarded, and pagination should - * be restarted from the first page of results. + * The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** - * The list of permissions. If nextPageToken is populated, then this list - * may be incomplete and an additional page of results should be fetched. + * The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ permissions?: Schema$Permission[]; } @@ -1014,8 +880,7 @@ export namespace drive_v3 { */ export interface Schema$Reply { /** - * The action the reply performed to the parent comment. Valid values are: - * - resolve - reopen + * The action the reply performed to the parent comment. Valid values are: - resolve - reopen */ action?: string; /** @@ -1023,9 +888,7 @@ export namespace drive_v3 { */ author?: Schema$User; /** - * The plain text content of the reply. This field is used for setting the - * content, while htmlContent should be displayed. This is required on - * creates if no action is specified. + * The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified. */ content?: string; /** @@ -1045,8 +908,7 @@ export namespace drive_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#reply". + * Identifies what kind of resource this is. Value: the fixed string "drive#reply". */ kind?: string; /** @@ -1059,20 +921,15 @@ export namespace drive_v3 { */ export interface Schema$ReplyList { /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#replyList". + * Identifies what kind of resource this is. Value: the fixed string "drive#replyList". */ kind?: string; /** - * The page token for the next page of replies. This will be absent if the - * end of the replies list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** - * The list of replies. If nextPageToken is populated, then this list may be - * incomplete and an additional page of results should be fetched. + * The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ replies?: Schema$Reply[]; } @@ -1089,16 +946,11 @@ export namespace drive_v3 { */ id?: string; /** - * Whether to keep this revision forever, even if it is no longer the head - * revision. If not set, the revision will be automatically purged 30 days - * after newer content is uploaded. This can be set on a maximum of 200 - * revisions for a file. This field is only applicable to files with binary - * content in Drive. + * Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive. */ keepForever?: boolean; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#revision". + * Identifies what kind of resource this is. Value: the fixed string "drive#revision". */ kind?: string; /** @@ -1106,8 +958,7 @@ export namespace drive_v3 { */ lastModifyingUser?: Schema$User; /** - * The MD5 checksum of the revision's content. This is only applicable - * to files with binary content in Drive. + * The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive. */ md5Checksum?: string; /** @@ -1119,28 +970,23 @@ export namespace drive_v3 { */ modifiedTime?: string; /** - * The original filename used to create this revision. This is only - * applicable to files with binary content in Drive. + * The original filename used to create this revision. This is only applicable to files with binary content in Drive. */ originalFilename?: string; /** - * Whether subsequent revisions will be automatically republished. This is - * only applicable to Google Docs. + * Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs. */ publishAuto?: boolean; /** - * Whether this revision is published. This is only applicable to Google - * Docs. + * Whether this revision is published. This is only applicable to Google Docs. */ published?: boolean; /** - * Whether this revision is published outside the domain. This is only - * applicable to Google Docs. + * Whether this revision is published outside the domain. This is only applicable to Google Docs. */ publishedOutsideDomain?: boolean; /** - * The size of the revision's content in bytes. This is only applicable - * to files with binary content in Drive. + * The size of the revision's content in bytes. This is only applicable to files with binary content in Drive. */ size?: string; } @@ -1149,27 +995,21 @@ export namespace drive_v3 { */ export interface Schema$RevisionList { /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#revisionList". + * Identifies what kind of resource this is. Value: the fixed string "drive#revisionList". */ kind?: string; /** - * The page token for the next page of revisions. This will be absent if the - * end of the revisions list has been reached. If the token is rejected for - * any reason, it should be discarded, and pagination should be restarted - * from the first page of results. + * The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** - * The list of revisions. If nextPageToken is populated, then this list may - * be incomplete and an additional page of results should be fetched. + * The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ revisions?: Schema$Revision[]; } export interface Schema$StartPageToken { /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#startPageToken". + * Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken". */ kind?: string; /** @@ -1178,14 +1018,11 @@ export namespace drive_v3 { startPageToken?: string; } /** - * Representation of a Team Drive. + * Deprecated: use the drive collection instead. */ export interface Schema$TeamDrive { /** - * An image file and cropping parameters from which a background image for - * this Team Drive is set. This is a write only field; it can only be set on - * drive.teamdrives.update requests that don't set themeId. When - * specified, all fields of the backgroundImageFile must be set. + * An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. */ backgroundImageFile?: { id?: string; @@ -1222,8 +1059,7 @@ export namespace drive_v3 { canTrashChildren?: boolean; }; /** - * The color of this Team Drive as an RGB hex string. It can only be set on - * a drive.teamdrives.update request that does not set themeId. + * The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. */ colorRgb?: string; /** @@ -1231,13 +1067,11 @@ export namespace drive_v3 { */ createdTime?: string; /** - * The ID of this Team Drive which is also the ID of the top level folder of - * this Team Drive. + * The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#teamDrive". + * Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive". */ kind?: string; /** @@ -1245,8 +1079,7 @@ export namespace drive_v3 { */ name?: string; /** - * A set of restrictions that apply to this Team Drive or items inside this - * Team Drive. + * A set of restrictions that apply to this Team Drive or items inside this Team Drive. */ restrictions?: { adminManagedRestrictions?: boolean; @@ -1255,12 +1088,7 @@ export namespace drive_v3 { teamMembersOnly?: boolean; }; /** - * The ID of the theme from which the background image and color will be - * set. The set of possible teamDriveThemes can be retrieved from a - * drive.about.get response. When not specified on a drive.teamdrives.create - * request, a random theme is chosen from which the background image and - * color are set. This is a write-only field; it can only be set on requests - * that don't set colorRgb or backgroundImageFile. + * The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. */ themeId?: string; } @@ -1269,20 +1097,15 @@ export namespace drive_v3 { */ export interface Schema$TeamDriveList { /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#teamDriveList". + * Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList". */ kind?: string; /** - * The page token for the next page of Team Drives. This will be absent if - * the end of the Team Drives list has been reached. If the token is - * rejected for any reason, it should be discarded, and pagination should be - * restarted from the first page of results. + * The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */ nextPageToken?: string; /** - * The list of Team Drives. If nextPageToken is populated, then this list - * may be incomplete and an additional page of results should be fetched. + * The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */ teamDrives?: Schema$TeamDrive[]; } @@ -1295,14 +1118,11 @@ export namespace drive_v3 { */ displayName?: string; /** - * The email address of the user. This may not be present in certain - * contexts if the user has not made their email address visible to the - * requester. + * The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. */ emailAddress?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "drive#user". + * Identifies what kind of resource this is. Value: the fixed string "drive#user". */ kind?: string; /** @@ -1327,8 +1147,7 @@ export namespace drive_v3 { /** * drive.about.get - * @desc Gets information about the user, the user's Drive, and system - * capabilities. + * @desc Gets information about the user, the user's Drive, and system capabilities. * @alias drive.about.get * @memberOf! () * @@ -1415,7 +1234,7 @@ export namespace drive_v3 { * * @param {object=} params Parameters for request * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1495,14 +1314,14 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. - * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. * @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.pageSize The maximum number of changes to return per page. * @param {string} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {boolean=} params.restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. * @param {string=} params.spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1576,14 +1395,14 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. - * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. * @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.pageSize The maximum number of changes to return per page. * @param {string} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {boolean=} params.restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. * @param {string=} params.spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {().Channel} params.resource Request body data @@ -1659,13 +1478,11 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the shared drive for which the starting pageToken for listing - * future changes from that shared drive will be returned. + * The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. */ driveId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -1684,26 +1501,19 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the - * change IDs will be reflective of the shared drive; use the combined drive - * ID and change ID as an identifier. + * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** - * Whether changes should include the file resource if the file is still - * accessible by the user at the time of the request, even when a file was - * removed from the list of changes and there will be no further change - * entries for this file. + * Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. */ includeCorpusRemovals?: boolean; /** - * Whether both My Drive and shared drive items should be included in - * results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. */ includeItemsFromAllDrives?: boolean; /** - * Whether to include changes indicating that items have been removed from - * the list of changes, for example by deletion or loss of access. + * Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. */ includeRemoved?: boolean; /** @@ -1715,25 +1525,19 @@ export namespace drive_v3 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response - * or to the response from the getStartPageToken method. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. */ pageToken?: string; /** - * Whether to restrict the results to changes inside the My Drive hierarchy. - * This omits changes to files such as those in the Application Data folder - * or shared files which have not been added to My Drive. + * Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. */ restrictToMyDrive?: boolean; /** - * A comma-separated list of spaces to query within the user corpus. - * Supported values are 'drive', 'appDataFolder' and 'photos'. + * A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -1752,26 +1556,19 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the - * change IDs will be reflective of the shared drive; use the combined drive - * ID and change ID as an identifier. + * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** - * Whether changes should include the file resource if the file is still - * accessible by the user at the time of the request, even when a file was - * removed from the list of changes and there will be no further change - * entries for this file. + * Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. */ includeCorpusRemovals?: boolean; /** - * Whether both My Drive and shared drive items should be included in - * results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. */ includeItemsFromAllDrives?: boolean; /** - * Whether to include changes indicating that items have been removed from - * the list of changes, for example by deletion or loss of access. + * Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. */ includeRemoved?: boolean; /** @@ -1783,25 +1580,19 @@ export namespace drive_v3 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response - * or to the response from the getStartPageToken method. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. */ pageToken?: string; /** - * Whether to restrict the results to changes inside the My Drive hierarchy. - * This omits changes to files such as those in the Application Data folder - * or shared files which have not been added to My Drive. + * Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. */ restrictToMyDrive?: boolean; /** - * A comma-separated list of spaces to query within the user corpus. - * Supported values are 'drive', 'appDataFolder' and 'photos'. + * A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -2326,8 +2117,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to return deleted comments. Deleted comments will not include - * their original content. + * Whether to return deleted comments. Deleted comments will not include their original content. */ includeDeleted?: boolean; } @@ -2342,8 +2132,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to include deleted comments. Deleted comments will not include - * their original content. + * Whether to include deleted comments. Deleted comments will not include their original content. */ includeDeleted?: boolean; /** @@ -2351,13 +2140,11 @@ export namespace drive_v3 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. */ pageToken?: string; /** - * The minimum value of 'modifiedTime' for the result comments (RFC 3339 - * date-time). + * The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). */ startModifiedTime?: string; } @@ -2459,8 +2246,7 @@ export namespace drive_v3 { /** * drive.drives.delete - * @desc Permanently deletes a shared drive for which the user is an - * organizer. The shared drive cannot contain any untrashed items. + * @desc Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. * @alias drive.drives.delete * @memberOf! () * @@ -2897,11 +2683,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An ID, such as a random UUID, which uniquely identifies this user's - * request for idempotent creation of a shared drive. A repeated request by - * the same user and with the same request ID will avoid creating duplicates - * by attempting to create the same shared drive. If the shared drive - * already exists a 409 error will be returned. + * An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. */ requestId?: string; @@ -2932,9 +2714,7 @@ export namespace drive_v3 { */ driveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -2968,9 +2748,7 @@ export namespace drive_v3 { */ q?: string; /** - * Issue the request as a domain administrator; if set to true, then all - * shared drives of the domain in which the requester is an administrator - * are returned. + * Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned. */ useDomainAdminAccess?: boolean; } @@ -2996,9 +2774,7 @@ export namespace drive_v3 { */ driveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -3016,8 +2792,7 @@ export namespace drive_v3 { /** * drive.files.copy - * @desc Creates a copy of a file and applies any requested updates with - * patch semantics. + * @desc Creates a copy of a file and applies any requested updates with patch semantics. * @alias drive.files.copy * @memberOf! () * @@ -3026,7 +2801,7 @@ export namespace drive_v3 { * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {().File} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3102,7 +2877,7 @@ export namespace drive_v3 { * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useContentAsIndexableText Whether to use the uploaded content as indexable text. * @param {object} params.resource Media resource metadata @@ -3175,16 +2950,13 @@ export namespace drive_v3 { /** * drive.files.delete - * @desc Permanently deletes a file owned by the user without moving it to - * the trash. If the file belongs to a shared drive the user must be an - * organizer on the parent. If the target is a folder, all descendants owned - * by the user are also deleted. + * @desc Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted. * @alias drive.files.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3321,9 +3093,7 @@ export namespace drive_v3 { /** * drive.files.export - * @desc Exports a Google Doc to the requested MIME type and returns the - * exported content. Please note that the exported content is limited to - * 10MB. + * @desc Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB. * @alias drive.files.export * @memberOf! () * @@ -3395,8 +3165,7 @@ export namespace drive_v3 { /** * drive.files.generateIds - * @desc Generates a set of file IDs which can be provided in create - * requests. + * @desc Generates a set of file IDs which can be provided in create requests. * @alias drive.files.generateIds * @memberOf! () * @@ -3478,7 +3247,7 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3553,14 +3322,14 @@ export namespace drive_v3 { * @param {string=} params.corpora Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. * @param {string=} params.corpus The source of files to list. Deprecated: use 'corpora' instead. * @param {string=} params.driveId ID of the shared drive to search. - * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. * @param {integer=} params.pageSize The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. * @param {string=} params.q A query for filtering the file results. See the "Search for Files" guide for supported syntax. * @param {string=} params.spaces A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3635,7 +3404,7 @@ export namespace drive_v3 { * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). * @param {string=} params.removeParents A comma-separated list of parent IDs to remove. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useContentAsIndexableText Whether to use the uploaded content as indexable text. * @param {object} params.resource Media resource metadata @@ -3718,7 +3487,7 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {().Channel} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3796,15 +3565,11 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to ignore the domain's default visibility settings for the - * created file. Domain administrators can choose to make all uploaded files - * visible to the domain by default; this parameter bypasses that behavior - * for the request. Permissions are still inherited from parent folders. + * Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. */ ignoreDefaultVisibility?: boolean; /** - * Whether to set the 'keepForever' field in the new head revision. This is - * only applicable to files with binary content in Google Drive. + * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. */ keepRevisionForever?: boolean; /** @@ -3812,8 +3577,7 @@ export namespace drive_v3 { */ ocrLanguage?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -3833,15 +3597,11 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether to ignore the domain's default visibility settings for the - * created file. Domain administrators can choose to make all uploaded files - * visible to the domain by default; this parameter bypasses that behavior - * for the request. Permissions are still inherited from parent folders. + * Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. */ ignoreDefaultVisibility?: boolean; /** - * Whether to set the 'keepForever' field in the new head revision. This is - * only applicable to files with binary content in Google Drive. + * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. */ keepRevisionForever?: boolean; /** @@ -3849,8 +3609,7 @@ export namespace drive_v3 { */ ocrLanguage?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -3893,8 +3652,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -3935,8 +3693,7 @@ export namespace drive_v3 { */ count?: number; /** - * The space in which the IDs can be used to create new files. Supported - * values are 'drive' and 'appDataFolder'. + * The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. */ space?: string; } @@ -3947,8 +3704,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the user is acknowledging the risk of downloading known malware - * or other abusive files. This is only applicable when alt=media. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. */ acknowledgeAbuse?: boolean; /** @@ -3956,8 +3712,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -3972,9 +3727,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Bodies of items (files/documents) to which the query applies. Supported - * bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or - * 'drive' to 'allDrives' for efficiency. + * Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. */ corpora?: string; /** @@ -3986,8 +3739,7 @@ export namespace drive_v3 { */ driveId?: string; /** - * Whether both My Drive and shared drive items should be included in - * results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. */ includeItemsFromAllDrives?: boolean; /** @@ -3995,40 +3747,27 @@ export namespace drive_v3 { */ includeTeamDriveItems?: boolean; /** - * A comma-separated list of sort keys. Valid keys are 'createdTime', - * 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', - * 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and - * 'viewedByMeTime'. Each key sorts ascending by default, but may be - * reversed with the 'desc' modifier. Example usage: - * ?orderBy=folder,modifiedTime desc,name. Please note that there is a - * current limitation for users with approximately one million files in - * which the requested sort order is ignored. + * A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. */ orderBy?: string; /** - * The maximum number of files to return per page. Partial or empty result - * pages are possible even before the end of the files list has been - * reached. + * The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. */ pageToken?: string; /** - * A query for filtering the file results. See the "Search for Files" guide - * for supported syntax. + * A query for filtering the file results. See the "Search for Files" guide for supported syntax. */ q?: string; /** - * A comma-separated list of spaces to query within the corpus. Supported - * values are 'drive', 'appDataFolder' and 'photos'. + * A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. */ spaces?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4055,8 +3794,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to set the 'keepForever' field in the new head revision. This is - * only applicable to files with binary content in Google Drive. + * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. */ keepRevisionForever?: boolean; /** @@ -4068,8 +3806,7 @@ export namespace drive_v3 { */ removeParents?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4108,8 +3845,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the user is acknowledging the risk of downloading known malware - * or other abusive files. This is only applicable when alt=media. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. */ acknowledgeAbuse?: boolean; /** @@ -4117,8 +3853,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4148,7 +3883,7 @@ export namespace drive_v3 { * @param {string=} params.emailMessage A plain text custom message to include in the notification email. * @param {string} params.fileId The ID of the file or shared drive. * @param {boolean=} params.sendNotificationEmail Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. @@ -4228,7 +3963,7 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file or shared drive. * @param {string} params.permissionId The ID of the permission. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4303,7 +4038,7 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file. * @param {string} params.permissionId The ID of the permission. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4380,7 +4115,7 @@ export namespace drive_v3 { * @param {string} params.fileId The ID of the file or shared drive. * @param {integer=} params.pageSize The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4458,7 +4193,7 @@ export namespace drive_v3 { * @param {string} params.fileId The ID of the file or shared drive. * @param {string} params.permissionId The ID of the permission. * @param {boolean=} params.removeExpiration Whether to remove the expiration date. - * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. @@ -4545,14 +4280,11 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to send a notification email when sharing to users or groups. - * This defaults to true for users and groups, and is not allowed for other - * requests. It must not be disabled for ownership transfers. + * Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. */ sendNotificationEmail?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4560,16 +4292,11 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Whether to transfer ownership to the specified user and downgrade the - * current owner to a writer. This parameter is required as an - * acknowledgement of the side effect. + * Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. */ transferOwnership?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -4594,8 +4321,7 @@ export namespace drive_v3 { */ permissionId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4603,10 +4329,7 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -4625,8 +4348,7 @@ export namespace drive_v3 { */ permissionId?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4634,10 +4356,7 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -4652,20 +4371,15 @@ export namespace drive_v3 { */ fileId?: string; /** - * The maximum number of permissions to return per page. When not set for - * files in a shared drive, at most 100 results will be returned. When not - * set for files that are not in a shared drive, the entire list will be - * returned. + * The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. */ pageToken?: string; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4673,10 +4387,7 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -4700,8 +4411,7 @@ export namespace drive_v3 { */ removeExpiration?: boolean; /** - * Whether the requesting application supports both My Drives and shared - * drives. + * Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. */ supportsAllDrives?: boolean; /** @@ -4709,16 +4419,11 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Whether to transfer ownership to the specified user and downgrade the - * current owner to a writer. This parameter is required as an - * acknowledgement of the side effect. + * Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. */ transferOwnership?: boolean; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if the file ID parameter refers to a - * shared drive and the requester is an administrator of the domain to which - * the shared drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -5158,8 +4863,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to return deleted replies. Deleted replies will not include their - * original content. + * Whether to return deleted replies. Deleted replies will not include their original content. */ includeDeleted?: boolean; /** @@ -5182,8 +4886,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to include deleted replies. Deleted replies will not include - * their original content. + * Whether to include deleted replies. Deleted replies will not include their original content. */ includeDeleted?: boolean; /** @@ -5191,8 +4894,7 @@ export namespace drive_v3 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. */ pageToken?: string; } @@ -5229,10 +4931,7 @@ export namespace drive_v3 { /** * drive.revisions.delete - * @desc Permanently deletes a file version. You can only delete revisions - * for files with binary content in Google Drive, like images or videos. - * Revisions for other files, like Google Docs or Sheets, and the last - * remaining file version can't be deleted. + * @desc Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. * @alias drive.revisions.delete * @memberOf! () * @@ -5543,8 +5242,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the user is acknowledging the risk of downloading known malware - * or other abusive files. This is only applicable when alt=media. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. */ acknowledgeAbuse?: boolean; /** @@ -5571,8 +5269,7 @@ export namespace drive_v3 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of 'nextPageToken' from the previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. */ pageToken?: string; } @@ -5985,11 +5682,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An ID, such as a random UUID, which uniquely identifies this user's - * request for idempotent creation of a Team Drive. A repeated request by - * the same user and with the same request ID will avoid creating duplicates - * by attempting to create the same Team Drive. If the Team Drive already - * exists a 409 error will be returned. + * An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned. */ requestId?: string; @@ -6021,9 +5714,7 @@ export namespace drive_v3 { */ teamDriveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the Team Drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. */ useDomainAdminAccess?: boolean; } @@ -6046,9 +5737,7 @@ export namespace drive_v3 { */ q?: string; /** - * Issue the request as a domain administrator; if set to true, then all - * Team Drives of the domain in which the requester is an administrator are - * returned. + * Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned. */ useDomainAdminAccess?: boolean; } @@ -6064,9 +5753,7 @@ export namespace drive_v3 { */ teamDriveId?: string; /** - * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the Team Drive belongs. + * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. */ useDomainAdminAccess?: boolean; diff --git a/src/apis/driveactivity/package.json b/src/apis/driveactivity/package.json index 8a83a22d899..f5337404acb 100644 --- a/src/apis/driveactivity/package.json +++ b/src/apis/driveactivity/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/driveactivity/v2.ts b/src/apis/driveactivity/v2.ts index 660d4e3a87c..4ec572e631e 100644 --- a/src/apis/driveactivity/v2.ts +++ b/src/apis/driveactivity/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace driveactivity_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace driveactivity_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace driveactivity_v2 { activity: Resource$Activity; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.activity = new Resource$Activity(this.context); } @@ -123,8 +122,7 @@ export namespace driveactivity_v2 { */ export interface Schema$Action { /** - * The actor responsible for this action (or empty if all actors are - * responsible). + * The actor responsible for this action (or empty if all actors are responsible). */ actor?: Schema$Actor; /** @@ -132,9 +130,7 @@ export namespace driveactivity_v2 { */ detail?: Schema$ActionDetail; /** - * The target this action affects (or empty if affecting all targets). This - * represents the state of the target immediately after this action - * occurred. + * The target this action affects (or empty if affecting all targets). This represents the state of the target immediately after this action occurred. */ target?: Schema$Target; /** @@ -225,8 +221,7 @@ export namespace driveactivity_v2 { */ export interface Schema$Administrator {} /** - * Empty message representing an anonymous user or indicating the - * authenticated user should be anonymized. + * Empty message representing an anonymous user or indicating the authenticated user should be anonymized. */ export interface Schema$AnonymousUser {} /** @@ -273,11 +268,7 @@ export namespace driveactivity_v2 { suggestion?: Schema$Suggestion; } /** - * How the individual activities are consolidated. A set of activities may be - * consolidated into one combined activity if they are related in some way, - * such as one actor performing the same action on multiple targets, or - * multiple actors performing the same action on a single target. The strategy - * defines the rules for which activities are related. + * How the individual activities are consolidated. A set of activities may be consolidated into one combined activity if they are related in some way, such as one actor performing the same action on multiple targets, or multiple actors performing the same action on a single target. The strategy defines the rules for which activities are related. */ export interface Schema$ConsolidationStrategy { /** @@ -303,18 +294,15 @@ export namespace driveactivity_v2 { */ export interface Schema$Create { /** - * If present, indicates the object was created by copying an existing Drive - * object. + * If present, indicates the object was created by copying an existing Drive object. */ copy?: Schema$Copy; /** - * If present, indicates the object was newly created (e.g. as a blank - * document), not derived from a Drive object or external object. + * If present, indicates the object was newly created (e.g. as a blank document), not derived from a Drive object or external object. */ new?: Schema$New; /** - * If present, indicates the object originated externally and was uploaded - * to Drive. + * If present, indicates the object originated externally and was uploaded to Drive. */ upload?: Schema$Upload; } @@ -358,9 +346,7 @@ export namespace driveactivity_v2 { */ export interface Schema$Drive { /** - * The resource name of the shared drive. The format is - * "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific - * collection ID for this resource name. + * The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection ID for this resource name. */ name?: string; /** @@ -373,12 +359,7 @@ export namespace driveactivity_v2 { title?: string; } /** - * A single Drive activity comprising one or more Actions by one or more - * Actors on one or more Targets. Some Action groupings occur spontaneously, - * such as moving an item into a shared folder triggering a permission change. - * Other groupings of related Actions, such as multiple Actors editing one - * item or moving multiple files into a new folder, are controlled by the - * selection of a ConsolidationStrategy in the QueryDriveActivityRequest. + * A single Drive activity comprising one or more Actions by one or more Actors on one or more Targets. Some Action groupings occur spontaneously, such as moving an item into a shared folder triggering a permission change. Other groupings of related Actions, such as multiple Actors editing one item or moving multiple files into a new folder, are controlled by the selection of a ConsolidationStrategy in the QueryDriveActivityRequest. */ export interface Schema$DriveActivity { /** @@ -390,15 +371,11 @@ export namespace driveactivity_v2 { */ actors?: Schema$Actor[]; /** - * Key information about the primary action for this activity. This is - * either representative, or the most important, of all actions in the - * activity, according to the ConsolidationStrategy in the request. + * Key information about the primary action for this activity. This is either representative, or the most important, of all actions in the activity, according to the ConsolidationStrategy in the request. */ primaryActionDetail?: Schema$ActionDetail; /** - * All Drive objects this activity is about (e.g. file, folder, Team Drive). - * This represents the state of the target immediately after the actions - * occurred. + * All Google Drive objects this activity is about (e.g. file, folder, drive). This represents the state of the target immediately after the actions occurred. */ targets?: Schema$Target[]; /** @@ -444,8 +421,7 @@ export namespace driveactivity_v2 { */ folder?: Schema$Folder; /** - * The MIME type of the Drive item. See - * https://developers.google.com/drive/v3/web/mime-types. + * The MIME type of the Drive item. See https://developers.google.com/drive/v3/web/mime-types. */ mimeType?: string; /** @@ -495,9 +471,7 @@ export namespace driveactivity_v2 { */ export interface Schema$DriveReference { /** - * The resource name of the shared drive. The format is - * "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific - * collection ID for this resource name. + * The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection ID for this resource name. */ name?: string; /** @@ -518,21 +492,15 @@ export namespace driveactivity_v2 { */ export interface Schema$FileComment { /** - * The comment in the discussion thread. This identifier is an opaque string - * compatible with the Drive API; see - * https://developers.google.com/drive/v3/reference/comments/get + * The comment in the discussion thread. This identifier is an opaque string compatible with the Drive API; see https://developers.google.com/drive/v3/reference/comments/get */ legacyCommentId?: string; /** - * The discussion thread to which the comment was added. This identifier is - * an opaque string compatible with the Drive API and references the first - * comment in a discussion; see - * https://developers.google.com/drive/v3/reference/comments/get + * The discussion thread to which the comment was added. This identifier is an opaque string compatible with the Drive API and references the first comment in a discussion; see https://developers.google.com/drive/v3/reference/comments/get */ legacyDiscussionId?: string; /** - * The link to the discussion thread containing this comment, for example, - * "https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID". + * The link to the discussion thread containing this comment, for example, "https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID". */ linkToDiscussion?: string; /** @@ -563,8 +531,7 @@ export namespace driveactivity_v2 { title?: string; } /** - * Information about an impersonation, where an admin acts on behalf of an end - * user. Information about the acting admin is not currently available. + * Information about an impersonation, where an admin acts on behalf of an end user. Information about the acting admin is not currently available. */ export interface Schema$Impersonation { /** @@ -581,18 +548,12 @@ export namespace driveactivity_v2 { */ isCurrentUser?: boolean; /** - * The identifier for this user that can be used with the People API to get - * more information. The format is "people/ACCOUNT_ID". See - * https://developers.google.com/people/. + * The identifier for this user that can be used with the People API to get more information. The format is "people/ACCOUNT_ID". See https://developers.google.com/people/. */ personName?: string; } /** - * A strategy which consolidates activities using the grouping rules from the - * legacy V1 Activity API. Similar actions occurring within a window of time - * can be grouped across multiple targets (such as moving a set of files at - * once) or multiple actors (such as several users editing the same item). - * Grouping rules for this strategy are specific to each type of action. + * A strategy which consolidates activities using the grouping rules from the legacy V1 Activity API. Similar actions occurring within a window of time can be grouped across multiple targets (such as moving a set of files at once) or multiple actors (such as several users editing the same item). Grouping rules for this strategy are specific to each type of action. */ export interface Schema$Legacy {} /** @@ -642,8 +603,7 @@ export namespace driveactivity_v2 { */ export interface Schema$Permission { /** - * If true, the item can be discovered (e.g. in the user's "Shared - * with me" collection) without needing a link to the item. + * If true, the item can be discovered (e.g. in the user's "Shared with me" collection) without needing a link to the item. */ allowDiscovery?: boolean; /** @@ -659,10 +619,7 @@ export namespace driveactivity_v2 { */ group?: Schema$Group; /** - * Indicates the <a - * href="/drive/web/manage-sharing#roles">Google Drive - * permissions role</a>. The role determines a user's ability to - * read, write, and comment on items. + * Indicates the <a href="/drive/web/manage-sharing#roles">Google Drive permissions role</a>. The role determines a user's ability to read, write, and comment on items. */ role?: string; /** @@ -697,45 +654,27 @@ export namespace driveactivity_v2 { */ export interface Schema$QueryDriveActivityRequest { /** - * Return activities for this Drive folder and all children and descendants. - * The format is "items/ITEM_ID". + * Return activities for this Drive folder and all children and descendants. The format is "items/ITEM_ID". */ ancestorName?: string; /** - * Details on how to consolidate related actions that make up the activity. - * If not set, then related actions will not be consolidated. + * Details on how to consolidate related actions that make up the activity. If not set, then related actions will not be consolidated. */ consolidationStrategy?: Schema$ConsolidationStrategy; /** - * The filtering for items returned from this query request. The format of - * the filter string is a sequence of expressions, joined by an optional - * "AND", where each expression is of the form "field - * operator value". Supported fields: - <tt>time</tt>: - * Uses numerical operators on date values either in terms of - * milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples: - - * <tt>time > 1452409200000 AND time <= 1492812924310</tt> - * - <tt>time >= "2016-01-10T01:02:03-05:00"</tt> - * - <tt>detail.action_detail_case</tt>: Uses the - * "has" operator (:) and either a singular value or a list of - * allowed action types enclosed in parentheses. Examples: - - * <tt>detail.action_detail_case: RENAME</tt> - - * <tt>detail.action_detail_case:(CREATE UPLOAD)</tt> - - * <tt>-detail.action_detail_case:MOVE</tt> + * The filtering for items returned from this query request. The format of the filter string is a sequence of expressions, joined by an optional "AND", where each expression is of the form "field operator value". Supported fields: - <tt>time</tt>: Uses numerical operators on date values either in terms of milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples: - <tt>time > 1452409200000 AND time <= 1492812924310</tt> - <tt>time >= "2016-01-10T01:02:03-05:00"</tt> - <tt>detail.action_detail_case</tt>: Uses the "has" operator (:) and either a singular value or a list of allowed action types enclosed in parentheses. Examples: - <tt>detail.action_detail_case: RENAME</tt> - <tt>detail.action_detail_case:(CREATE UPLOAD)</tt> - <tt>-detail.action_detail_case:MOVE</tt> */ filter?: string; /** - * Return activities for this Drive item. The format is - * "items/ITEM_ID". + * Return activities for this Drive item. The format is "items/ITEM_ID". */ itemName?: string; /** - * The requested number of activity to return. If not set, a default value - * will be used. + * The requested number of activity to return. If not set, a default value will be used. */ pageSize?: number; /** - * The next_page_token value returned from a previous QueryDriveActivity - * request, if any. + * The next_page_token value returned from a previous QueryDriveActivity request, if any. */ pageToken?: string; } @@ -748,8 +687,7 @@ export namespace driveactivity_v2 { */ activities?: Schema$DriveActivity[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } diff --git a/src/apis/factchecktools/package.json b/src/apis/factchecktools/package.json index f8ea505a0ec..804ac615dc7 100644 --- a/src/apis/factchecktools/package.json +++ b/src/apis/factchecktools/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/factchecktools/v1alpha1.ts b/src/apis/factchecktools/v1alpha1.ts index 2fbc2d50080..1df5516ec03 100644 --- a/src/apis/factchecktools/v1alpha1.ts +++ b/src/apis/factchecktools/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace factchecktools_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace factchecktools_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace factchecktools_v1alpha1 { pages: Resource$Pages; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.claims = new Resource$Claims(this.context); this.pages = new Resource$Pages(this.context); @@ -125,8 +124,7 @@ export namespace factchecktools_v1alpha1 { */ export interface Schema$GoogleFactcheckingFactchecktoolsV1alpha1Claim { /** - * A person or organization stating the claim. For instance, "John - * Doe". + * A person or organization stating the claim. For instance, "John Doe". */ claimant?: string; /** @@ -138,8 +136,7 @@ export namespace factchecktools_v1alpha1 { */ claimReview?: Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimReview[]; /** - * The claim text. For instance, "Crime has doubled in the last 2 - * years." + * The claim text. For instance, "Crime has doubled in the last 2 years." */ text?: string; } @@ -156,9 +153,7 @@ export namespace factchecktools_v1alpha1 { */ jobTitle?: string; /** - * A person or organization stating the claim. For instance, "John - * Doe".<br> Corresponds to - * `ClaimReview.itemReviewed.author.name`. + * A person or organization stating the claim. For instance, "John Doe".<br> Corresponds to `ClaimReview.itemReviewed.author.name`. */ name?: string; /** @@ -171,8 +166,7 @@ export namespace factchecktools_v1alpha1 { */ export interface Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimRating { /** - * For numeric ratings, the best value possible in the scale from worst to - * best.<br> Corresponds to `ClaimReview.reviewRating.bestRating`. + * For numeric ratings, the best value possible in the scale from worst to best.<br> Corresponds to `ClaimReview.reviewRating.bestRating`. */ bestRating?: number; /** @@ -180,20 +174,15 @@ export namespace factchecktools_v1alpha1 { */ imageUrl?: string; /** - * A numeric rating of this claim, in the range worstRating — bestRating - * inclusive.<br> Corresponds to - * `ClaimReview.reviewRating.ratingValue`. + * A numeric rating of this claim, in the range worstRating — bestRating inclusive.<br> Corresponds to `ClaimReview.reviewRating.ratingValue`. */ ratingValue?: number; /** - * The truthfulness rating as a human-readible short word or - * phrase.<br> Corresponds to - * `ClaimReview.reviewRating.alternateName`. + * The truthfulness rating as a human-readible short word or phrase.<br> Corresponds to `ClaimReview.reviewRating.alternateName`. */ textualRating?: string; /** - * For numeric ratings, the worst value possible in the scale from worst to - * best.<br> Corresponds to `ClaimReview.reviewRating.worstRating`. + * For numeric ratings, the worst value possible in the scale from worst to best.<br> Corresponds to `ClaimReview.reviewRating.worstRating`. */ worstRating?: number; } @@ -202,8 +191,7 @@ export namespace factchecktools_v1alpha1 { */ export interface Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimReview { /** - * The language this review was written in. For instance, "en" or - * "de". + * The language this review was written in. For instance, "en" or "de". */ languageCode?: string; /** @@ -236,21 +224,16 @@ export namespace factchecktools_v1alpha1 { */ imageUrl?: string; /** - * Name of the organization that is publishing the fact check.<br> - * Corresponds to `ClaimReview.author.name`. + * Name of the organization that is publishing the fact check.<br> Corresponds to `ClaimReview.author.name`. */ name?: string; } /** - * Fields for an individual `ClaimReview` element. Except for sub-messages - * that group fields together, each of these fields correspond those in - * https://schema.org/ClaimReview. We list the precise mapping for each field. + * Fields for an individual `ClaimReview` element. Except for sub-messages that group fields together, each of these fields correspond those in https://schema.org/ClaimReview. We list the precise mapping for each field. */ export interface Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkup { /** - * A list of links to works in which this claim appears, aside from the one - * specified in `claim_first_appearance`.<br> Corresponds to - * `ClaimReview.itemReviewed[@type=Claim].appearance.url`. + * A list of links to works in which this claim appears, aside from the one specified in `claim_first_appearance`.<br> Corresponds to `ClaimReview.itemReviewed[@type=Claim].appearance.url`. */ claimAppearances?: string[]; /** @@ -258,23 +241,19 @@ export namespace factchecktools_v1alpha1 { */ claimAuthor?: Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimAuthor; /** - * The date when the claim was made or entered public discourse.<br> - * Corresponds to `ClaimReview.itemReviewed.datePublished`. + * The date when the claim was made or entered public discourse.<br> Corresponds to `ClaimReview.itemReviewed.datePublished`. */ claimDate?: string; /** - * A link to a work in which this claim first appears.<br> Corresponds - * to `ClaimReview.itemReviewed[@type=Claim].firstAppearance.url`. + * A link to a work in which this claim first appears.<br> Corresponds to `ClaimReview.itemReviewed[@type=Claim].firstAppearance.url`. */ claimFirstAppearance?: string; /** - * The location where this claim was made.<br> Corresponds to - * `ClaimReview.itemReviewed.name`. + * The location where this claim was made.<br> Corresponds to `ClaimReview.itemReviewed.name`. */ claimLocation?: string; /** - * A short summary of the claim being evaluated.<br> Corresponds to - * `ClaimReview.claimReviewed`. + * A short summary of the claim being evaluated.<br> Corresponds to `ClaimReview.claimReviewed`. */ claimReviewed?: string; /** @@ -282,10 +261,7 @@ export namespace factchecktools_v1alpha1 { */ rating?: Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimRating; /** - * This field is optional, and will default to the page URL. We provide this - * field to allow you the override the default value, but the only permitted - * override is the page URL plus an optional anchor link ("page - * jump").<br> Corresponds to `ClaimReview.url` + * This field is optional, and will default to the page URL. We provide this field to allow you the override the default value, but the only permitted override is the page URL plus an optional anchor link ("page jump").<br> Corresponds to `ClaimReview.url` */ url?: string; } @@ -294,40 +270,27 @@ export namespace factchecktools_v1alpha1 { */ export interface Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage { /** - * Info about the author of this claim review. Similar to the above, - * semantically these are page-level fields, and each `ClaimReview` on this - * page will contain the same values. + * Info about the author of this claim review. Similar to the above, semantically these are page-level fields, and each `ClaimReview` on this page will contain the same values. */ claimReviewAuthor?: Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewAuthor; /** - * A list of individual claim reviews for this page. Each item in the list - * corresponds to one `ClaimReview` element. + * A list of individual claim reviews for this page. Each item in the list corresponds to one `ClaimReview` element. */ claimReviewMarkups?: Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkup[]; /** - * The name of this `ClaimReview` markup page resource, in the form of - * `pages/{page_id}`. Except for update requests, this field is output-only - * and should not be set by the user. + * The name of this `ClaimReview` markup page resource, in the form of `pages/{page_id}`. Except for update requests, this field is output-only and should not be set by the user. */ name?: string; /** - * The URL of the page associated with this `ClaimReview` markup. While - * every individual `ClaimReview` has its own URL field, semantically this - * is a page-level field, and each `ClaimReview` on this page will use this - * value unless individually overridden.<br> Corresponds to - * `ClaimReview.url` + * The URL of the page associated with this `ClaimReview` markup. While every individual `ClaimReview` has its own URL field, semantically this is a page-level field, and each `ClaimReview` on this page will use this value unless individually overridden.<br> Corresponds to `ClaimReview.url` */ pageUrl?: string; /** - * The date when the fact check was published. Similar to the URL, - * semantically this is a page-level field, and each `ClaimReview` on this - * page will contain the same value.<br> Corresponds to - * `ClaimReview.datePublished` + * The date when the fact check was published. Similar to the URL, semantically this is a page-level field, and each `ClaimReview` on this page will contain the same value.<br> Corresponds to `ClaimReview.datePublished` */ publishDate?: string; /** - * The version ID for this markup. Except for update requests, this field is - * output-only and should not be set by the user. + * The version ID for this markup. Except for update requests, this field is output-only and should not be set by the user. */ versionId?: string; } @@ -340,9 +303,7 @@ export namespace factchecktools_v1alpha1 { */ claims?: Schema$GoogleFactcheckingFactchecktoolsV1alpha1Claim[]; /** - * The next pagination token in the Search response. It should be used as - * the `page_token` for the following request. An empty value means no more - * results. + * The next pagination token in the Search response. It should be used as the `page_token` for the following request. An empty value means no more results. */ nextPageToken?: string; } @@ -355,9 +316,7 @@ export namespace factchecktools_v1alpha1 { */ claimReviewMarkupPages?: Schema$GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage[]; /** - * The next pagination token in the Search response. It should be used as - * the `page_token` for the following request. An empty value means no more - * results. + * The next pagination token in the Search response. It should be used as the `page_token` for the following request. An empty value means no more results. */ nextPageToken?: string; } @@ -366,23 +325,16 @@ export namespace factchecktools_v1alpha1 { */ export interface Schema$GoogleFactcheckingFactchecktoolsV1alpha1Publisher { /** - * The name of this publisher. For instance, "Awesome Fact - * Checks". + * The name of this publisher. For instance, "Awesome Fact Checks". */ name?: string; /** - * Host-level site name, without the protocol or "www" prefix. For - * instance, "awesomefactchecks.com". This value of this field is - * based purely on the claim review URL. + * Host-level site name, without the protocol or "www" prefix. For instance, "awesomefactchecks.com". This value of this field is based purely on the claim review URL. */ site?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobufEmpty {} @@ -506,38 +458,27 @@ export namespace factchecktools_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". Can be used to - * restrict results by language, though we do not currently consider the - * region. + * The BCP-47 language code, such as "en-US" or "sr-Latn". Can be used to restrict results by language, though we do not currently consider the region. */ languageCode?: string; /** - * The maximum age of the returned search results, in days. Age is - * determined by either claim date or review date, whichever is newer. + * The maximum age of the returned search results, in days. Age is determined by either claim date or review date, whichever is newer. */ maxAgeDays?: number; /** - * An integer that specifies the current offset (that is, starting result - * location) in search results. This field is only considered if - * `page_token` is unset. For example, 0 means to return results starting - * from the first matching result, and 10 means to return from the 11th - * result. + * An integer that specifies the current offset (that is, starting result location) in search results. This field is only considered if `page_token` is unset. For example, 0 means to return results starting from the first matching result, and 10 means to return from the 11th result. */ offset?: number; /** - * The pagination size. We will return up to that many results. Defaults to - * 10 if not set. + * The pagination size. We will return up to that many results. Defaults to 10 if not set. */ pageSize?: number; /** - * The pagination token. You may provide the `next_page_token` returned from - * a previous List request, if any, in order to get the next page. All other - * fields must have the same values as in the previous request. + * The pagination token. You may provide the `next_page_token` returned from a previous List request, if any, in order to get the next page. All other fields must have the same values as in the previous request. */ pageToken?: string; /** - * Textual query string. Required unless `review_publisher_site_filter` is - * specified. + * Textual query string. Required unless `review_publisher_site_filter` is specified. */ query?: string; /** @@ -819,8 +760,7 @@ export namespace factchecktools_v1alpha1 { /** * factchecktools.pages.list - * @desc List the `ClaimReview` markup pages for a specific URL or for an - * organization. + * @desc List the `ClaimReview` markup pages for a specific URL or for an organization. * @alias factchecktools.pages.list * @memberOf! () * @@ -921,10 +861,7 @@ export namespace factchecktools_v1alpha1 { /** * factchecktools.pages.update - * @desc Update for all `ClaimReview` markup on a page Note that this is a - * full update. To retain the existing `ClaimReview` markup on a page, first - * perform a Get operation, then modify the returned markup, and finally - * call Update with the entire `ClaimReview` markup as the body. + * @desc Update for all `ClaimReview` markup on a page Note that this is a full update. To retain the existing `ClaimReview` markup on a page, first perform a Get operation, then modify the returned markup, and finally call Update with the entire `ClaimReview` markup as the body. * @alias factchecktools.pages.update * @memberOf! () * @@ -1061,34 +998,23 @@ export namespace factchecktools_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An integer that specifies the current offset (that is, starting result - * location) in search results. This field is only considered if - * `page_token` is unset, and if the request is not for a specific URL. For - * example, 0 means to return results starting from the first matching - * result, and 10 means to return from the 11th result. + * An integer that specifies the current offset (that is, starting result location) in search results. This field is only considered if `page_token` is unset, and if the request is not for a specific URL. For example, 0 means to return results starting from the first matching result, and 10 means to return from the 11th result. */ offset?: number; /** - * The organization for which we want to fetch markups for. For instance, - * "site.com". Cannot be specified along with an URL. + * The organization for which we want to fetch markups for. For instance, "site.com". Cannot be specified along with an URL. */ organization?: string; /** - * The pagination size. We will return up to that many results. Defaults to - * 10 if not set. Has no effect if a URL is requested. + * The pagination size. We will return up to that many results. Defaults to 10 if not set. Has no effect if a URL is requested. */ pageSize?: number; /** - * The pagination token. You may provide the `next_page_token` returned from - * a previous List request, if any, in order to get the next page. All other - * fields must have the same values as in the previous request. + * The pagination token. You may provide the `next_page_token` returned from a previous List request, if any, in order to get the next page. All other fields must have the same values as in the previous request. */ pageToken?: string; /** - * The URL from which to get `ClaimReview` markup. There will be at most one - * result. If markup is associated with a more canonical version of the URL - * provided, we will return that URL instead. Cannot be specified along with - * an organization. + * The URL from which to get `ClaimReview` markup. There will be at most one result. If markup is associated with a more canonical version of the URL provided, we will return that URL instead. Cannot be specified along with an organization. */ url?: string; } @@ -1099,9 +1025,7 @@ export namespace factchecktools_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of this `ClaimReview` markup page resource, in the form of - * `pages/{page_id}`. Except for update requests, this field is output-only - * and should not be set by the user. + * The name of this `ClaimReview` markup page resource, in the form of `pages/{page_id}`. Except for update requests, this field is output-only and should not be set by the user. */ name?: string; diff --git a/src/apis/file/package.json b/src/apis/file/package.json index 3f6faab4e8e..510531d4d81 100644 --- a/src/apis/file/package.json +++ b/src/apis/file/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 40bb507ff7b..246dbe93840 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace file_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace file_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace file_v1 { /** * Cloud Filestore API * - * The Cloud Filestore API is used for creating and managing cloud file - * servers. + * The Cloud Filestore API is used for creating and managing cloud file servers. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace file_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,11 +122,7 @@ export namespace file_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -136,8 +130,7 @@ export namespace file_v1 { */ export interface Schema$FileShareConfig { /** - * File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as - * 1024^3 bytes. + * File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. */ capacityGb?: string; /** @@ -146,36 +139,7 @@ export namespace file_v1 { name?: string; } /** - * Instance represents the interface for SLM services to actuate the state of - * control plane resources. Example Instance in JSON, where - * consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: - * { "name": - * "projects/snapchat/locations/us-east1/instances/prod-instance", - * "create_time": { "seconds": 1526406431, }, - * "labels": { "env": "prod", - * "foo": "bar" }, "state": READY, - * "software_version": "cloud-sql-09-28-2018", - * "maintenance_policy_names": { "UpdatePolicy": - * "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", - * } "rollout_metadata": { - * "projects/cloud-sql/locations/global/rolloutTypes/software_update": - * { "release": - * "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", - * "rollout": - * "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", - * } - * "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": - * { "release": - * "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", - * "rollout": - * "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", - * } } "tenant_project_id": "cloud-sql-test-tenant", - * "producer_metadata": { "cloud-sql-tier": - * "basic", "cloud-sql-instance-size": "1G", - * }, "provisioned_resources": [ { "resource-type": - * "compute-instance", "resource-url": - * "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", - * } ], } ``` + * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_version": "cloud-sql-09-28-2018", "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", } "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], } ``` */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** @@ -183,64 +147,45 @@ export namespace file_v1 { */ createTime?: string; /** - * Optional. Resource labels to represent user provided metadata. Each label - * is a key-value pair, where both the key and the value are arbitrary - * strings provided by the user. + * Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user. */ labels?: {[key: string]: string}; /** - * The MaintenancePolicies that have been attached to the instance. The key - * must be of the type name of the oneof policy name defined in - * MaintenancePolicy, and the referenced policy must define the same policy - * type. For complete details of MaintenancePolicy, please refer to - * //depot/google3/google/cloud/saasaccelerator/maintenancepolicy/api/v1/maintenance_policy_resources.proto + * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to //depot/google3/google/cloud/saasaccelerator/maintenancepolicy/api/v1/maintenance_policy_resources.proto */ maintenancePolicyNames?: {[key: string]: string}; /** - * Unique name of the resource. It uses the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + * Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` */ name?: string; /** - * Output only. Custom string attributes used primarily to expose - * producer-specific information in monitoring dashboards. See - * go/get-instance-metadata. + * Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata. */ producerMetadata?: {[key: string]: string}; /** - * Output only. The list of data plane resources provisioned for this - * instance, e.g. compute VMs. See go/get-instance-metadata. + * Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata. */ provisionedResources?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource[]; /** - * The map between RolloutType and the corresponding RolloutMetadata. This - * is only mutated by rollout service. For actuation implementation, this - * information is pass-through for Rollout management. Producer shall not - * modify by itself. For update of a single entry in this map, the update - * field mask shall follow this sementics: go/advanced-field-masks + * The map between RolloutType and the corresponding RolloutMetadata. This is only mutated by rollout service. For actuation implementation, this information is pass-through for Rollout management. Producer shall not modify by itself. For update of a single entry in this map, the update field mask shall follow this sementics: go/advanced-field-masks */ rolloutMetadata?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; }; /** - * Output only. SLO metadata for instance classification in the Standardized - * dataplane SLO platform. See go/cloud-ssa-standard-slo for feature - * description. + * Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. */ sloMetadata?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata; /** - * Software versions that are used to deploy this instance. This can be - * mutated by rollout services. + * Software versions that are used to deploy this instance. This can be mutated by rollout services. */ softwareVersions?: {[key: string]: string}; /** - * Output only. Current lifecycle state of the resource (e.g. if it's - * being created or ready to use). + * Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use). */ state?: string; /** - * Output only. ID of the associated GCP tenant project. See - * go/get-instance-metadata. + * Output only. ID of the associated GCP tenant project. See go/get-instance-metadata. */ tenantProjectId?: string; /** @@ -257,13 +202,11 @@ export namespace file_v1 { */ rescheduled?: boolean; /** - * The scheduled end time for the maintenance window during which update can - * be performed on the instance. + * The scheduled end time for the maintenance window during which update can be performed on the instance. */ scheduledEndTime?: string; /** - * The scheduled start time for the maintenance window during which update - * can be performed on the instance. + * The scheduled start time for the maintenance window during which update can be performed on the instance. */ scheduledStartTime?: string; /** @@ -276,17 +219,11 @@ export namespace file_v1 { */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource { /** - * Type of the resource. This can be either a GCP resource or a custom one - * (e.g. another cloud provider's VM). For GCP compute resources use - * singular form of the names listed in GCP compute API documentation - * (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with - * 'compute-', for example: 'compute-instance', - * 'compute-disk', 'compute-autoscaler'. + * Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'. */ resourceType?: string; /** - * URL identifying the resource, e.g. - * "https://www.googleapis.com/compute/v1/projects/...)". + * URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)". */ resourceUrl?: string; } @@ -312,13 +249,7 @@ export namespace file_v1 { */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { /** - * Exclusion duration. No restrictions on the possible values. When an - * ongoing operation is taking longer than initially expected, an existing - * entry in the exclusion list can be updated by extending the duration. - * This is supported by the subsystem exporting eligibility data as long as - * such extension is committed at least 10 minutes before the original - * exclusion expiration - otherwise it is possible that there will be - * "gaps" in the exclusion application in the exported timeseries. + * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. */ exclusionDuration?: string; /** @@ -326,41 +257,24 @@ export namespace file_v1 { */ exclusionStartTime?: string; /** - * Human-readable reason for the exclusion. This should be a static string - * (e.g. "Disruptive update in progress") and should not contain - * dynamically generated data (e.g. instance name). Can be left empty. + * Human-readable reason for the exclusion. This should be a static string (e.g. "Disruptive update in progress") and should not contain dynamically generated data (e.g. instance name). Can be left empty. */ reason?: string; /** - * Name of an SLI/SLO that this exclusion applies to. Can be left empty, - * signaling that the instance should be excluded from all SLI/SLOs defined - * in the service SLO configuration. + * Name of an SLI/SLO that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLI/SLOs defined in the service SLO configuration. */ sloName?: string; } /** - * SloMetadata contains resources required for proper SLO classification of - * the instance. + * SloMetadata contains resources required for proper SLO classification of the instance. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { /** - * List of SLO exclusion windows. When multiple entries in the list match - * (matching the exclusion time-window against current time point) the - * exclusion reason used in the first matching entry will be published. It - * is not needed to include expired exclusion in this list, as only the - * currently applicable exclusions are taken into account by the eligibility - * exporting subsystem (the historical state of exclusions will be reflected - * in the historically produced timeseries regardless of the current state). - * This field can be used to mark the instance as temporary ineligible for - * the purpose of SLO calculation. For permanent instance SLO exclusion, a - * dedicated tier name can be used that does not have targets specified in - * the service SLO configuration. + * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, a dedicated tier name can be used that does not have targets specified in the service SLO configuration. */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; /** - * Name of the SLO tier the Instance belongs to. This name will be expected - * to match the tiers specified in the service SLO configuration. Field is - * mandatory and must not be empty. + * Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. */ tier?: string; } @@ -377,13 +291,11 @@ export namespace file_v1 { */ description?: string; /** - * Server-specified ETag for the instance resource to prevent simultaneous - * updates from overwriting each other. + * Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. */ etag?: string; /** - * File system shares on the instance. For this version, only a single file - * share is supported. + * File system shares on the instance. For this version, only a single file share is supported. */ fileShares?: Schema$FileShareConfig[]; /** @@ -391,13 +303,11 @@ export namespace file_v1 { */ labels?: {[key: string]: string}; /** - * Output only. The resource name of the instance, in the format - * projects/{project_id}/locations/{location_id}/instances/{instance_id}. + * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. */ name?: string; /** - * VPC networks to which the instance is connected. For this version, only a - * single network is supported. + * VPC networks to which the instance is connected. For this version, only a single network is supported. */ networks?: Schema$NetworkConfig[]; /** @@ -405,8 +315,7 @@ export namespace file_v1 { */ state?: string; /** - * Output only. Additional information about the instance state, if - * available. + * Output only. Additional information about the instance state, if available. */ statusMessage?: string; /** @@ -419,17 +328,11 @@ export namespace file_v1 { */ export interface Schema$ListInstancesResponse { /** - * A list of instances in the project for the specified location. If the - * {location} value in the request is "-", the response contains a - * list of instances from all locations. If any location is unreachable, the - * response will only return instances in reachable locations and the - * "unreachable" field will be populated with a list of - * unreachable locations. + * A list of instances in the project for the specified location. If the {location} value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. */ instances?: Schema$Instance[]; /** - * The token you can use to retrieve the next page of results. Not returned - * if there are no more results in the list. + * The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. */ nextPageToken?: string; /** @@ -468,13 +371,11 @@ export namespace file_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -482,13 +383,11 @@ export namespace file_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -497,41 +396,28 @@ export namespace file_v1 { */ export interface Schema$NetworkConfig { /** - * Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet - * 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block - * 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}. + * Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}. */ ipAddresses?: string[]; /** - * Internet protocol versions for which the instance has IP addresses - * assigned. For this version, only MODE_IPV4 is supported. + * Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. */ modes?: string[]; /** - * The name of the Google Compute Engine [VPC - * network](/compute/docs/networks-and-firewalls#networks) to which the - * instance is connected. + * The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. */ network?: string; /** - * A /29 CIDR block in one of the [internal IP address - * ranges](https://www.arin.net/knowledge/address_filters.html) that - * identifies the range of IP addresses reserved for this instance. For - * example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't - * overlap with either existing subnets or assigned IP address ranges for - * other Cloud Filestore instances in the selected VPC network. + * A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. */ reservedIpRange?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -539,26 +425,15 @@ export namespace file_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -571,10 +446,7 @@ export namespace file_v1 { */ apiVersion?: string; /** - * [Output only] Identifies whether the user has requested cancellation of - * the operation. Operations that have successfully been cancelled have - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ cancelRequested?: boolean; /** @@ -590,8 +462,7 @@ export namespace file_v1 { */ statusDetail?: string; /** - * [Output only] Server-defined resource path for the target of the - * operation. + * [Output only] Server-defined resource path for the target of the operation. */ target?: string; /** @@ -600,40 +471,7 @@ export namespace file_v1 { verb?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -641,14 +479,11 @@ export namespace file_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1084,8 +919,7 @@ export namespace file_v1 { /** * file.projects.locations.instances.list - * @desc Lists all instances in a project for either a specified location or - * for all locations. + * @desc Lists all instances in a project for either a specified location or for all locations. * @alias file.projects.locations.instances.list * @memberOf! () * @@ -1245,14 +1079,11 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the instance to create. The name must be unique for the - * specified project and location. + * The name of the instance to create. The name must be unique for the specified project and location. */ instanceId?: string; /** - * The instance's project and location, in the format - * projects/{project_id}/locations/{location}. In Cloud Filestore, locations - * map to GCP zones, for example **us-west1-b**. + * The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. */ parent?: string; @@ -1269,8 +1100,7 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format - * projects/{project_id}/locations/{location}/instances/{instance_id} + * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} */ name?: string; } @@ -1282,8 +1112,7 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format - * projects/{project_id}/locations/{location}/instances/{instance_id}. + * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. */ name?: string; } @@ -1307,16 +1136,11 @@ export namespace file_v1 { */ pageSize?: number; /** - * The next_page_token value to use if there are additional results to - * retrieve for this list request. + * The next_page_token value to use if there are additional results to retrieve for this list request. */ pageToken?: string; /** - * The project and location for which to retrieve instance information, in - * the format projects/{project_id}/locations/{location}. In Cloud - * Filestore, locations map to GCP zones, for example **us-west1-b**. To - * retrieve instance information for all locations, use "-" for the - * {location} value. + * The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. */ parent?: string; } @@ -1328,14 +1152,11 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the instance, in the format - * projects/{project_id}/locations/{location_id}/instances/{instance_id}. + * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. */ name?: string; /** - * Mask of fields to update. At least one path must be supplied in this - * field. The elements of the repeated paths field may only include these - * fields: "description" + * Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: "description" */ updateMask?: string; @@ -1353,15 +1174,7 @@ export namespace file_v1 { /** * file.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias file.projects.locations.operations.cancel * @memberOf! () * @@ -1431,10 +1244,7 @@ export namespace file_v1 { /** * file.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias file.projects.locations.operations.delete * @memberOf! () * @@ -1503,9 +1313,7 @@ export namespace file_v1 { /** * file.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias file.projects.locations.operations.get * @memberOf! () * @@ -1576,15 +1384,7 @@ export namespace file_v1 { /** * file.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias file.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 23053b4e883..fa96fb05192 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace file_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace file_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace file_v1beta1 { /** * Cloud Filestore API * - * The Cloud Filestore API is used for creating and managing cloud file - * servers. + * The Cloud Filestore API is used for creating and managing cloud file servers. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace file_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,11 +122,7 @@ export namespace file_v1beta1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -136,8 +130,7 @@ export namespace file_v1beta1 { */ export interface Schema$FileShareConfig { /** - * File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as - * 1024^3 bytes. + * File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. */ capacityGb?: string; /** @@ -146,36 +139,7 @@ export namespace file_v1beta1 { name?: string; } /** - * Instance represents the interface for SLM services to actuate the state of - * control plane resources. Example Instance in JSON, where - * consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: - * { "name": - * "projects/snapchat/locations/us-east1/instances/prod-instance", - * "create_time": { "seconds": 1526406431, }, - * "labels": { "env": "prod", - * "foo": "bar" }, "state": READY, - * "software_version": "cloud-sql-09-28-2018", - * "maintenance_policy_names": { "UpdatePolicy": - * "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", - * } "rollout_metadata": { - * "projects/cloud-sql/locations/global/rolloutTypes/software_update": - * { "release": - * "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", - * "rollout": - * "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", - * } - * "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": - * { "release": - * "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", - * "rollout": - * "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", - * } } "tenant_project_id": "cloud-sql-test-tenant", - * "producer_metadata": { "cloud-sql-tier": - * "basic", "cloud-sql-instance-size": "1G", - * }, "provisioned_resources": [ { "resource-type": - * "compute-instance", "resource-url": - * "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", - * } ], } ``` + * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_version": "cloud-sql-09-28-2018", "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", } "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], } ``` */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** @@ -183,64 +147,45 @@ export namespace file_v1beta1 { */ createTime?: string; /** - * Optional. Resource labels to represent user provided metadata. Each label - * is a key-value pair, where both the key and the value are arbitrary - * strings provided by the user. + * Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user. */ labels?: {[key: string]: string}; /** - * The MaintenancePolicies that have been attached to the instance. The key - * must be of the type name of the oneof policy name defined in - * MaintenancePolicy, and the referenced policy must define the same policy - * type. For complete details of MaintenancePolicy, please refer to - * //depot/google3/google/cloud/saasaccelerator/maintenancepolicy/api/v1/maintenance_policy_resources.proto + * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to //depot/google3/google/cloud/saasaccelerator/maintenancepolicy/api/v1/maintenance_policy_resources.proto */ maintenancePolicyNames?: {[key: string]: string}; /** - * Unique name of the resource. It uses the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + * Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` */ name?: string; /** - * Output only. Custom string attributes used primarily to expose - * producer-specific information in monitoring dashboards. See - * go/get-instance-metadata. + * Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata. */ producerMetadata?: {[key: string]: string}; /** - * Output only. The list of data plane resources provisioned for this - * instance, e.g. compute VMs. See go/get-instance-metadata. + * Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata. */ provisionedResources?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource[]; /** - * The map between RolloutType and the corresponding RolloutMetadata. This - * is only mutated by rollout service. For actuation implementation, this - * information is pass-through for Rollout management. Producer shall not - * modify by itself. For update of a single entry in this map, the update - * field mask shall follow this sementics: go/advanced-field-masks + * The map between RolloutType and the corresponding RolloutMetadata. This is only mutated by rollout service. For actuation implementation, this information is pass-through for Rollout management. Producer shall not modify by itself. For update of a single entry in this map, the update field mask shall follow this sementics: go/advanced-field-masks */ rolloutMetadata?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; }; /** - * Output only. SLO metadata for instance classification in the Standardized - * dataplane SLO platform. See go/cloud-ssa-standard-slo for feature - * description. + * Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. */ sloMetadata?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata; /** - * Software versions that are used to deploy this instance. This can be - * mutated by rollout services. + * Software versions that are used to deploy this instance. This can be mutated by rollout services. */ softwareVersions?: {[key: string]: string}; /** - * Output only. Current lifecycle state of the resource (e.g. if it's - * being created or ready to use). + * Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use). */ state?: string; /** - * Output only. ID of the associated GCP tenant project. See - * go/get-instance-metadata. + * Output only. ID of the associated GCP tenant project. See go/get-instance-metadata. */ tenantProjectId?: string; /** @@ -257,13 +202,11 @@ export namespace file_v1beta1 { */ rescheduled?: boolean; /** - * The scheduled end time for the maintenance window during which update can - * be performed on the instance. + * The scheduled end time for the maintenance window during which update can be performed on the instance. */ scheduledEndTime?: string; /** - * The scheduled start time for the maintenance window during which update - * can be performed on the instance. + * The scheduled start time for the maintenance window during which update can be performed on the instance. */ scheduledStartTime?: string; /** @@ -276,17 +219,11 @@ export namespace file_v1beta1 { */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource { /** - * Type of the resource. This can be either a GCP resource or a custom one - * (e.g. another cloud provider's VM). For GCP compute resources use - * singular form of the names listed in GCP compute API documentation - * (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with - * 'compute-', for example: 'compute-instance', - * 'compute-disk', 'compute-autoscaler'. + * Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'. */ resourceType?: string; /** - * URL identifying the resource, e.g. - * "https://www.googleapis.com/compute/v1/projects/...)". + * URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)". */ resourceUrl?: string; } @@ -312,13 +249,7 @@ export namespace file_v1beta1 { */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { /** - * Exclusion duration. No restrictions on the possible values. When an - * ongoing operation is taking longer than initially expected, an existing - * entry in the exclusion list can be updated by extending the duration. - * This is supported by the subsystem exporting eligibility data as long as - * such extension is committed at least 10 minutes before the original - * exclusion expiration - otherwise it is possible that there will be - * "gaps" in the exclusion application in the exported timeseries. + * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. */ exclusionDuration?: string; /** @@ -326,41 +257,24 @@ export namespace file_v1beta1 { */ exclusionStartTime?: string; /** - * Human-readable reason for the exclusion. This should be a static string - * (e.g. "Disruptive update in progress") and should not contain - * dynamically generated data (e.g. instance name). Can be left empty. + * Human-readable reason for the exclusion. This should be a static string (e.g. "Disruptive update in progress") and should not contain dynamically generated data (e.g. instance name). Can be left empty. */ reason?: string; /** - * Name of an SLI/SLO that this exclusion applies to. Can be left empty, - * signaling that the instance should be excluded from all SLI/SLOs defined - * in the service SLO configuration. + * Name of an SLI/SLO that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLI/SLOs defined in the service SLO configuration. */ sloName?: string; } /** - * SloMetadata contains resources required for proper SLO classification of - * the instance. + * SloMetadata contains resources required for proper SLO classification of the instance. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { /** - * List of SLO exclusion windows. When multiple entries in the list match - * (matching the exclusion time-window against current time point) the - * exclusion reason used in the first matching entry will be published. It - * is not needed to include expired exclusion in this list, as only the - * currently applicable exclusions are taken into account by the eligibility - * exporting subsystem (the historical state of exclusions will be reflected - * in the historically produced timeseries regardless of the current state). - * This field can be used to mark the instance as temporary ineligible for - * the purpose of SLO calculation. For permanent instance SLO exclusion, a - * dedicated tier name can be used that does not have targets specified in - * the service SLO configuration. + * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, a dedicated tier name can be used that does not have targets specified in the service SLO configuration. */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; /** - * Name of the SLO tier the Instance belongs to. This name will be expected - * to match the tiers specified in the service SLO configuration. Field is - * mandatory and must not be empty. + * Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. */ tier?: string; } @@ -377,13 +291,11 @@ export namespace file_v1beta1 { */ description?: string; /** - * Server-specified ETag for the instance resource to prevent simultaneous - * updates from overwriting each other. + * Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. */ etag?: string; /** - * File system shares on the instance. For this version, only a single file - * share is supported. + * File system shares on the instance. For this version, only a single file share is supported. */ fileShares?: Schema$FileShareConfig[]; /** @@ -391,13 +303,11 @@ export namespace file_v1beta1 { */ labels?: {[key: string]: string}; /** - * Output only. The resource name of the instance, in the format - * projects/{project_id}/locations/{location_id}/instances/{instance_id}. + * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. */ name?: string; /** - * VPC networks to which the instance is connected. For this version, only a - * single network is supported. + * VPC networks to which the instance is connected. For this version, only a single network is supported. */ networks?: Schema$NetworkConfig[]; /** @@ -405,8 +315,7 @@ export namespace file_v1beta1 { */ state?: string; /** - * Output only. Additional information about the instance state, if - * available. + * Output only. Additional information about the instance state, if available. */ statusMessage?: string; /** @@ -419,17 +328,11 @@ export namespace file_v1beta1 { */ export interface Schema$ListInstancesResponse { /** - * A list of instances in the project for the specified location. If the - * {location} value in the request is "-", the response contains a - * list of instances from all locations. If any location is unreachable, the - * response will only return instances in reachable locations and the - * "unreachable" field will be populated with a list of - * unreachable locations. + * A list of instances in the project for the specified location. If the {location} value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. */ instances?: Schema$Instance[]; /** - * The token you can use to retrieve the next page of results. Not returned - * if there are no more results in the list. + * The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. */ nextPageToken?: string; /** @@ -468,13 +371,11 @@ export namespace file_v1beta1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -482,13 +383,11 @@ export namespace file_v1beta1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -497,41 +396,28 @@ export namespace file_v1beta1 { */ export interface Schema$NetworkConfig { /** - * Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet - * 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block - * 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}. + * Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}. */ ipAddresses?: string[]; /** - * Internet protocol versions for which the instance has IP addresses - * assigned. For this version, only MODE_IPV4 is supported. + * Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. */ modes?: string[]; /** - * The name of the Google Compute Engine [VPC - * network](/compute/docs/networks-and-firewalls#networks) to which the - * instance is connected. + * The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. */ network?: string; /** - * A /29 CIDR block in one of the [internal IP address - * ranges](https://www.arin.net/knowledge/address_filters.html) that - * identifies the range of IP addresses reserved for this instance. For - * example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't - * overlap with either existing subnets or assigned IP address ranges for - * other Cloud Filestore instances in the selected VPC network. + * A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. */ reservedIpRange?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -539,26 +425,15 @@ export namespace file_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -571,10 +446,7 @@ export namespace file_v1beta1 { */ apiVersion?: string; /** - * [Output only] Identifies whether the user has requested cancellation of - * the operation. Operations that have successfully been cancelled have - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ cancelRequested?: boolean; /** @@ -590,8 +462,7 @@ export namespace file_v1beta1 { */ statusDetail?: string; /** - * [Output only] Server-defined resource path for the target of the - * operation. + * [Output only] Server-defined resource path for the target of the operation. */ target?: string; /** @@ -600,40 +471,7 @@ export namespace file_v1beta1 { verb?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -641,14 +479,11 @@ export namespace file_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1084,8 +919,7 @@ export namespace file_v1beta1 { /** * file.projects.locations.instances.list - * @desc Lists all instances in a project for either a specified location or - * for all locations. + * @desc Lists all instances in a project for either a specified location or for all locations. * @alias file.projects.locations.instances.list * @memberOf! () * @@ -1245,14 +1079,11 @@ export namespace file_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the instance to create. The name must be unique for the - * specified project and location. + * The name of the instance to create. The name must be unique for the specified project and location. */ instanceId?: string; /** - * The instance's project and location, in the format - * projects/{project_id}/locations/{location}. In Cloud Filestore, locations - * map to GCP zones, for example **us-west1-b**. + * The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. */ parent?: string; @@ -1269,8 +1100,7 @@ export namespace file_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format - * projects/{project_id}/locations/{location}/instances/{instance_id} + * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} */ name?: string; } @@ -1282,8 +1112,7 @@ export namespace file_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format - * projects/{project_id}/locations/{location}/instances/{instance_id}. + * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. */ name?: string; } @@ -1307,16 +1136,11 @@ export namespace file_v1beta1 { */ pageSize?: number; /** - * The next_page_token value to use if there are additional results to - * retrieve for this list request. + * The next_page_token value to use if there are additional results to retrieve for this list request. */ pageToken?: string; /** - * The project and location for which to retrieve instance information, in - * the format projects/{project_id}/locations/{location}. In Cloud - * Filestore, locations map to GCP zones, for example **us-west1-b**. To - * retrieve instance information for all locations, use "-" for the - * {location} value. + * The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. */ parent?: string; } @@ -1328,14 +1152,11 @@ export namespace file_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the instance, in the format - * projects/{project_id}/locations/{location_id}/instances/{instance_id}. + * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. */ name?: string; /** - * Mask of fields to update. At least one path must be supplied in this - * field. The elements of the repeated paths field may only include these - * fields: "description" + * Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: "description" */ updateMask?: string; @@ -1353,15 +1174,7 @@ export namespace file_v1beta1 { /** * file.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias file.projects.locations.operations.cancel * @memberOf! () * @@ -1434,10 +1247,7 @@ export namespace file_v1beta1 { /** * file.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias file.projects.locations.operations.delete * @memberOf! () * @@ -1506,9 +1316,7 @@ export namespace file_v1beta1 { /** * file.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias file.projects.locations.operations.get * @memberOf! () * @@ -1579,15 +1387,7 @@ export namespace file_v1beta1 { /** * file.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias file.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/firebasedynamiclinks/package.json b/src/apis/firebasedynamiclinks/package.json index c1d42aea1c5..2ba1e684695 100644 --- a/src/apis/firebasedynamiclinks/package.json +++ b/src/apis/firebasedynamiclinks/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/firebasedynamiclinks/v1.ts b/src/apis/firebasedynamiclinks/v1.ts index 63126308d13..49a6b71abe2 100644 --- a/src/apis/firebasedynamiclinks/v1.ts +++ b/src/apis/firebasedynamiclinks/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace firebasedynamiclinks_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace firebasedynamiclinks_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace firebasedynamiclinks_v1 { v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.managedShortLinks = new Resource$Managedshortlinks(this.context); this.shortLinks = new Resource$Shortlinks(this.context); @@ -148,8 +147,7 @@ export namespace firebasedynamiclinks_v1 { */ androidLink?: string; /** - * Minimum version code for the Android app. If the installed app’s version - * code is lower, then the user is taken to the Play Store. + * Minimum version code for the Android app. If the installed app’s version code is lower, then the user is taken to the Play Store. */ androidMinPackageVersionCode?: string; /** @@ -162,28 +160,19 @@ export namespace firebasedynamiclinks_v1 { */ export interface Schema$CreateManagedShortLinkRequest { /** - * Information about the Dynamic Link to be shortened. [Learn - * more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). + * Information about the Dynamic Link to be shortened. [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). */ dynamicLinkInfo?: Schema$DynamicLinkInfo; /** - * Full long Dynamic Link URL with desired query parameters specified. For - * example, - * "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", - * [Learn - * more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). + * Full long Dynamic Link URL with desired query parameters specified. For example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). */ longDynamicLink?: string; /** - * Link name to associate with the link. It's used for marketer to - * identify manually-created links in the Firebase console - * (https://console.firebase.google.com/). Links must be named to be - * tracked. + * Link name to associate with the link. It's used for marketer to identify manually-created links in the Firebase console (https://console.firebase.google.com/). Links must be named to be tracked. */ name?: string; /** - * Google SDK version. Version takes the form - * "$major.$minor.$patch" + * Google SDK version. Version takes the form "$major.$minor.$patch" */ sdkVersion?: string; /** @@ -213,21 +202,15 @@ export namespace firebasedynamiclinks_v1 { */ export interface Schema$CreateShortDynamicLinkRequest { /** - * Information about the Dynamic Link to be shortened. [Learn - * more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). + * Information about the Dynamic Link to be shortened. [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). */ dynamicLinkInfo?: Schema$DynamicLinkInfo; /** - * Full long Dynamic Link URL with desired query parameters specified. For - * example, - * "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", - * [Learn - * more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). + * Full long Dynamic Link URL with desired query parameters specified. For example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). */ longDynamicLink?: string; /** - * Google SDK version. Version takes the form - * "$major.$minor.$patch" + * Google SDK version. Version takes the form "$major.$minor.$patch" */ sdkVersion?: string; /** @@ -274,14 +257,11 @@ export namespace firebasedynamiclinks_v1 { */ languageCode?: string; /** - * Device language code setting obtained by executing JavaScript code in - * WebView. + * Device language code setting obtained by executing JavaScript code in WebView. */ languageCodeFromWebview?: string; /** - * Device language code raw setting. iOS does returns language code in - * different format than iOS WebView. For example WebView returns en_US, but - * iOS returns en-US. Field below will return raw value returned by iOS. + * Device language code raw setting. iOS does returns language code in different format than iOS WebView. For example WebView returns en_US, but iOS returns en-US. Field below will return raw value returned by iOS. */ languageCodeRaw?: string; /** @@ -319,45 +299,31 @@ export namespace firebasedynamiclinks_v1 { */ export interface Schema$DynamicLinkInfo { /** - * Parameters used for tracking. See all tracking parameters in the - * [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). + * Parameters used for tracking. See all tracking parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). */ analyticsInfo?: Schema$AnalyticsInfo; /** - * Android related information. See Android related parameters in the - * [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). + * Android related information. See Android related parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). */ androidInfo?: Schema$AndroidInfo; /** - * Desktop related information. See desktop related parameters in the - * [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). + * Desktop related information. See desktop related parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). */ desktopInfo?: Schema$DesktopInfo; /** - * E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps - * More examples can be found in description of getNormalizedUriPrefix in - * j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to - * dynamic_link_domain is this field is missing + * E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing */ domainUriPrefix?: string; /** - * Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl [Learn - * more](https://firebase.google.com/docs/dynamic-links/android/receive) on - * how to set up Dynamic Link domain associated with your Firebase project. - * Required if missing domain_uri_prefix. + * Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl [Learn more](https://firebase.google.com/docs/dynamic-links/android/receive) on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix. */ dynamicLinkDomain?: string; /** - * iOS related information. See iOS related parameters in the - * [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). + * iOS related information. See iOS related parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). */ iosInfo?: Schema$IosInfo; /** - * The link your app will open, You can specify any URL your app can handle. - * This link must be a well-formatted URL, be properly URL-encoded, and use - * the HTTP or HTTPS scheme. See 'link' parameters in the - * [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). - * Required. + * The link your app will open, You can specify any URL your app can handle. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or HTTPS scheme. See 'link' parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). Required. */ link?: string; /** @@ -365,8 +331,7 @@ export namespace firebasedynamiclinks_v1 { */ navigationInfo?: Schema$NavigationInfo; /** - * Parameters for social meta tag params. Used to set meta tag data for link - * previews on social sites. + * Parameters for social meta tag params. Used to set meta tag data for link previews on social sites. */ socialMetaTagInfo?: Schema$SocialMetaTagInfo; } @@ -397,14 +362,11 @@ export namespace firebasedynamiclinks_v1 { warningMessage?: string; } /** - * Request for iSDK to execute strong match flow for post-install attribution. - * This is meant for iOS requests only. Requests from other platforms will not - * be honored. + * Request for iSDK to execute strong match flow for post-install attribution. This is meant for iOS requests only. Requests from other platforms will not be honored. */ export interface Schema$GetIosPostInstallAttributionRequest { /** - * App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). - * This is a client signal for a more accurate weak match. + * App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match. */ appInstallationTime?: string; /** @@ -420,36 +382,28 @@ export namespace firebasedynamiclinks_v1 { */ iosVersion?: string; /** - * App post install attribution retrieval information. Disambiguates - * mechanism (iSDK or developer invoked) to retrieve payload from clicked - * link. + * App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link. */ retrievalMethod?: string; /** - * Google SDK version. Version takes the form - * "$major.$minor.$patch" + * Google SDK version. Version takes the form "$major.$minor.$patch" */ sdkVersion?: string; /** - * Possible unique matched link that server need to check before performing - * fingerprint match. If passed link is short server need to expand the - * link. If link is long server need to vslidate the link. + * Possible unique matched link that server need to check before performing fingerprint match. If passed link is short server need to expand the link. If link is long server need to vslidate the link. */ uniqueMatchLinkToCheck?: string; /** - * Strong match page information. Disambiguates between default UI and - * custom page to present when strong match succeeds/fails to find cookie. + * Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie. */ visualStyle?: string; } /** - * Response for iSDK to execute strong match flow for post-install - * attribution. + * Response for iSDK to execute strong match flow for post-install attribution. */ export interface Schema$GetIosPostInstallAttributionResponse { /** - * The minimum version for app, specified by dev through ?imv= parameter. - * Return to iSDK to allow app to evaluate if current version meets this. + * The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this. */ appMinimumVersion?: string; /** @@ -457,45 +411,31 @@ export namespace firebasedynamiclinks_v1 { */ attributionConfidence?: string; /** - * The deep-link attributed post-install via one of several techniques - * (fingerprint, copy unique). + * The deep-link attributed post-install via one of several techniques (fingerprint, copy unique). */ deepLink?: string; /** - * User-agent specific custom-scheme URIs for iSDK to open. This will be set - * according to the user-agent tha the click was originally made in. There - * is no Safari-equivalent custom-scheme open URLs. ie: - * googlechrome://www.example.com ie: - * firefox://open-url?url=http://www.example.com ie: - * opera-http://example.com + * User-agent specific custom-scheme URIs for iSDK to open. This will be set according to the user-agent tha the click was originally made in. There is no Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com */ externalBrowserDestinationLink?: string; /** - * The link to navigate to update the app if min version is not met. This is - * either (in order): 1) fallback link (from ?ifl= parameter, if specified - * by developer) or 2) AppStore URL (from ?isi= parameter, if specified), or - * 3) the payload link (from required link= parameter). + * The link to navigate to update the app if min version is not met. This is either (in order): 1) fallback link (from ?ifl= parameter, if specified by developer) or 2) AppStore URL (from ?isi= parameter, if specified), or 3) the payload link (from required link= parameter). */ fallbackLink?: string; /** - * Invitation ID attributed post-install via one of several techniques - * (fingerprint, copy unique). + * Invitation ID attributed post-install via one of several techniques (fingerprint, copy unique). */ invitationId?: string; /** - * Instruction for iSDK to attemmpt to perform strong match. For instance, - * if browser does not support/allow cookie or outside of support browsers, - * this will be false. + * Instruction for iSDK to attemmpt to perform strong match. For instance, if browser does not support/allow cookie or outside of support browsers, this will be false. */ isStrongMatchExecutable?: boolean; /** - * Describes why match failed, ie: "discarded due to low - * confidence". This message will be publicly visible. + * Describes why match failed, ie: "discarded due to low confidence". This message will be publicly visible. */ matchMessage?: string; /** - * Entire FDL (short or long) attributed post-install via one of several - * techniques (fingerprint, copy unique). + * Entire FDL (short or long) attributed post-install via one of several techniques (fingerprint, copy unique). */ requestedLink?: string; /** @@ -503,17 +443,17 @@ export namespace firebasedynamiclinks_v1 { */ requestIpVersion?: string; /** - * The entire FDL, expanded from a short link. It is the same as the - * requested_link, if it is long. Parameters from this should not be used - * directly (ie: server can default utm_[campaign|medium|source] to a value - * when requested_link lack them, server determine the best fallback_link - * when requested_link specifies >1 fallback links). + * The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. Parameters from this should not be used directly (ie: server can default utm_[campaign|medium|source] to a value when requested_link lack them, server determine the best fallback_link when requested_link specifies >1 fallback links). */ resolvedLink?: string; /** * Scion campaign value to be propagated by iSDK to Scion at post-install. */ utmCampaign?: string; + /** + * Scion content value to be propagated by iSDK to Scion at app-reopen. + */ + utmContent?: string; /** * Scion medium value to be propagated by iSDK to Scion at post-install. */ @@ -522,10 +462,13 @@ export namespace firebasedynamiclinks_v1 { * Scion source value to be propagated by iSDK to Scion at post-install. */ utmSource?: string; + /** + * Scion term value to be propagated by iSDK to Scion at app-reopen. + */ + utmTerm?: string; } /** - * Request for iSDK to get reopen attribution for app universal link open - * deeplinking. This endpoint is meant for only iOS requests. + * Request for iSDK to get reopen attribution for app universal link open deeplinking. This endpoint is meant for only iOS requests. */ export interface Schema$GetIosReopenAttributionRequest { /** @@ -533,26 +476,20 @@ export namespace firebasedynamiclinks_v1 { */ bundleId?: string; /** - * FDL link to be verified from an app universal link open. The FDL link can - * be one of: 1) short FDL. e.g. <app_code>.page.link/<ddl_id>, - * or 2) long FDL. e.g. <app_code>.page.link/?{query params}, or 3) - * Invite FDL. e.g. <app_code>.page.link/i/<invite_id_or_alias> + * FDL link to be verified from an app universal link open. The FDL link can be one of: 1) short FDL. e.g. <app_code>.page.link/<ddl_id>, or 2) long FDL. e.g. <app_code>.page.link/?{query params}, or 3) Invite FDL. e.g. <app_code>.page.link/i/<invite_id_or_alias> */ requestedLink?: string; /** - * Google SDK version. Version takes the form - * "$major.$minor.$patch" + * Google SDK version. Version takes the form "$major.$minor.$patch" */ sdkVersion?: string; } /** - * Response for iSDK to get reopen attribution for app universal link open - * deeplinking. This endpoint is meant for only iOS requests. + * Response for iSDK to get reopen attribution for app universal link open deeplinking. This endpoint is meant for only iOS requests. */ export interface Schema$GetIosReopenAttributionResponse { /** - * The deep-link attributed the app universal link open. For both regular - * FDL links and invite FDL links. + * The deep-link attributed the app universal link open. For both regular FDL links and invite FDL links. */ deepLink?: string; /** @@ -560,19 +497,21 @@ export namespace firebasedynamiclinks_v1 { */ invitationId?: string; /** - * FDL input value of the "&imv=" parameter, minimum app - * version to be returned to Google Firebase SDK running on iOS-9. + * FDL input value of the "&imv=" parameter, minimum app version to be returned to Google Firebase SDK running on iOS-9. */ iosMinAppVersion?: string; /** - * The entire FDL, expanded from a short link. It is the same as the - * requested_link, if it is long. + * The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. */ resolvedLink?: string; /** * Scion campaign value to be propagated by iSDK to Scion at app-reopen. */ utmCampaign?: string; + /** + * Scion content value to be propagated by iSDK to Scion at app-reopen. + */ + utmContent?: string; /** * Scion medium value to be propagated by iSDK to Scion at app-reopen. */ @@ -581,37 +520,33 @@ export namespace firebasedynamiclinks_v1 { * Scion source value to be propagated by iSDK to Scion at app-reopen. */ utmSource?: string; + /** + * Scion term value to be propagated by iSDK to Scion at app-reopen. + */ + utmTerm?: string; } /** - * Parameters for Google Play Campaign Measurements. [Learn - * more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params) + * Parameters for Google Play Campaign Measurements. [Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params) */ export interface Schema$GooglePlayAnalytics { /** - * [AdWords autotagging - * parameter](https://support.google.com/analytics/answer/1033981?hl=en); - * used to measure Google AdWords ads. This value is generated dynamically - * and should never be modified. + * [AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en); used to measure Google AdWords ads. This value is generated dynamically and should never be modified. */ gclid?: string; /** - * Campaign name; used for keyword analysis to identify a specific product - * promotion or strategic campaign. + * Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign. */ utmCampaign?: string; /** - * Campaign content; used for A/B testing and content-targeted ads to - * differentiate ads or links that point to the same URL. + * Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL. */ utmContent?: string; /** - * Campaign medium; used to identify a medium such as email or - * cost-per-click. + * Campaign medium; used to identify a medium such as email or cost-per-click. */ utmMedium?: string; /** - * Campaign source; used to identify a search engine, newsletter, or other - * source. + * Campaign source; used to identify a search engine, newsletter, or other source. */ utmSource?: string; /** @@ -632,9 +567,7 @@ export namespace firebasedynamiclinks_v1 { */ iosBundleId?: string; /** - * Custom (destination) scheme to use for iOS. By default, we’ll use the - * bundle ID as the custom scheme. Developer can override this behavior - * using this param. + * Custom (destination) scheme to use for iOS. By default, we’ll use the bundle ID as the custom scheme. Developer can override this behavior using this param. */ iosCustomScheme?: string; /** @@ -663,8 +596,7 @@ export namespace firebasedynamiclinks_v1 { */ at?: string; /** - * Campaign text that developers can optionally add to any link in order to - * track sales from a specific marketing campaign. + * Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign. */ ct?: string; /** @@ -672,8 +604,7 @@ export namespace firebasedynamiclinks_v1 { */ mt?: string; /** - * Provider token that enables analytics for Dynamic Links from within - * iTunes Connect. + * Provider token that enables analytics for Dynamic Links from within iTunes Connect. */ pt?: string; } @@ -694,8 +625,7 @@ export namespace firebasedynamiclinks_v1 { */ info?: Schema$DynamicLinkInfo; /** - * Short durable link url, for example, - * "https://sample.app.goo.gl/xyz123". Required. + * Short durable link url, for example, "https://sample.app.goo.gl/xyz123". Required. */ link?: string; /** @@ -712,14 +642,12 @@ export namespace firebasedynamiclinks_v1 { */ export interface Schema$NavigationInfo { /** - * If this option is on, FDL click will be forced to redirect rather than - * show an interstitial page. + * If this option is on, FDL click will be forced to redirect rather than show an interstitial page. */ enableForcedRedirect?: boolean; } /** - * Parameters for social meta tag params. Used to set meta tag data for link - * previews on social sites. + * Parameters for social meta tag params. Used to set meta tag data for link previews on social sites. */ export interface Schema$SocialMetaTagInfo { /** @@ -757,15 +685,7 @@ export namespace firebasedynamiclinks_v1 { /** * firebasedynamiclinks.managedShortLinks.create - * @desc Creates a managed short Dynamic Link given either a valid long - * Dynamic Link or details such as Dynamic Link domain, Android and iOS app - * information. The created short Dynamic Link will not expire. This - * differs from CreateShortDynamicLink in the following ways: - The - * request will also contain a name for the link (non unique name for - * the front end). - The response must be authenticated with an auth token - * (generated with the admin service account). - The link will appear - * in the FDL list of links in the console front end. The Dynamic Link - * domain in the request must be owned by requester's Firebase project. + * @desc Creates a managed short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire. This differs from CreateShortDynamicLink in the following ways: - The request will also contain a name for the link (non unique name for the front end). - The response must be authenticated with an auth token (generated with the admin service account). - The link will appear in the FDL list of links in the console front end. The Dynamic Link domain in the request must be owned by requester's Firebase project. * @alias firebasedynamiclinks.managedShortLinks.create * @memberOf! () * @@ -869,12 +789,7 @@ export namespace firebasedynamiclinks_v1 { /** * firebasedynamiclinks.shortLinks.create - * @desc Creates a short Dynamic Link given either a valid long Dynamic Link - * or details such as Dynamic Link domain, Android and iOS app information. - * The created short Dynamic Link will not expire. Repeated calls with the - * same long Dynamic Link or Dynamic Link information will produce the same - * short Dynamic Link. The Dynamic Link domain in the request must be owned - * by requester's Firebase project. + * @desc Creates a short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire. Repeated calls with the same long Dynamic Link or Dynamic Link information will produce the same short Dynamic Link. The Dynamic Link domain in the request must be owned by requester's Firebase project. * @alias firebasedynamiclinks.shortLinks.create * @memberOf! () * @@ -975,9 +890,7 @@ export namespace firebasedynamiclinks_v1 { /** * firebasedynamiclinks.getLinkStats - * @desc Fetches analytics stats of a short Dynamic Link for a given - * duration. Metrics include number of clicks, redirects, installs, app - * first opens, and app reopens. + * @desc Fetches analytics stats of a short Dynamic Link for a given duration. Metrics include number of clicks, redirects, installs, app first opens, and app reopens. * @alias firebasedynamiclinks.getLinkStats * @memberOf! () * diff --git a/src/apis/firebasehosting/package.json b/src/apis/firebasehosting/package.json index d79d1399bd5..bf3510d610b 100644 --- a/src/apis/firebasehosting/package.json +++ b/src/apis/firebasehosting/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index e0fa8caf45b..7c95f3351a1 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace firebasehosting_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace firebasehosting_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace firebasehosting_v1beta1 { /** * Firebase Hosting API * - * The Firebase Hosting REST API enables programmatic and customizable - * deployments to your Firebase-hosted sites. Use this REST API to deploy new - * or updated hosting configurations and content files. + * The Firebase Hosting REST API enables programmatic and customizable deployments to your Firebase-hosted sites. Use this REST API to deploy new or updated hosting configurations and content files. * * @example * const {google} = require('googleapis'); @@ -114,15 +108,17 @@ export namespace firebasehosting_v1beta1 { sites: Resource$Sites; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.sites = new Resource$Sites(this.context); } } /** - * Contains metadata about the user who performed an action, such as creating - * a release or finalizing a version. + * Contains metadata about the user who performed an action, such as creating a release or finalizing a version. */ export interface Schema$ActingUser { /** @@ -130,8 +126,7 @@ export namespace firebasehosting_v1beta1 { */ email?: string; /** - * A profile image URL for the user. May not be present if the user has - * changed their email address or deleted their account. + * A profile image URL for the user. May not be present if the user has changed their email address or deleted their account. */ imageUrl?: string; } @@ -144,8 +139,7 @@ export namespace firebasehosting_v1beta1 { */ domainName?: string; /** - * The value that must be present as a TXT record on the domain name to - * satisfy the challenge. + * The value that must be present as a TXT record on the domain name to satisfy the challenge. */ token?: string; } @@ -154,27 +148,20 @@ export namespace firebasehosting_v1beta1 { */ export interface Schema$CertHttpChallenge { /** - * The URL path on which to serve the specified token to satisfy the - * certificate challenge. + * The URL path on which to serve the specified token to satisfy the certificate challenge. */ path?: string; /** - * The token to serve at the specified URL path to satisfy the certificate - * challenge. + * The token to serve at the specified URL path to satisfy the certificate challenge. */ token?: string; } /** - * A configured rewrite that directs requests to a Cloud Run service. If the - * Cloud Run service does not exist when setting or updating your Firebase - * Hosting configuration, then the request fails. Any errors from the Cloud - * Run service are passed to the end user (for example, if you delete a - * service, any requests directed to that service receive a `404` error). + * A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). */ export interface Schema$CloudRunRewrite { /** - * Optional. User-provided region where the Cloud Run service is - * hosted.<br> Defaults to `us-central1` if not supplied. + * Optional. User-provided region where the Cloud Run service is hosted.<br> Defaults to `us-central1` if not supplied. */ region?: string; /** @@ -195,8 +182,7 @@ export namespace firebasehosting_v1beta1 { */ domainRedirect?: Schema$DomainRedirect; /** - * Output only. Information about the provisioning of certificates and the - * health of the DNS resolution for the domain. + * Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain. */ provisioning?: Schema$DomainProvisioning; /** @@ -217,8 +203,7 @@ export namespace firebasehosting_v1beta1 { */ export interface Schema$DomainProvisioning { /** - * The TXT records (for the certificate challenge) that were found at the - * last DNS fetch. + * The TXT records (for the certificate challenge) that were found at the last DNS fetch. */ certChallengeDiscoveredTxt?: string[]; /** @@ -230,8 +215,7 @@ export namespace firebasehosting_v1beta1 { */ certChallengeHttp?: Schema$CertHttpChallenge; /** - * The certificate provisioning status; updated when Firebase Hosting - * provisions an SSL certificate for the domain. + * The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. */ certStatus?: string; /** @@ -252,9 +236,7 @@ export namespace firebasehosting_v1beta1 { expectedIps?: string[]; } /** - * Defines the behavior of a domain-level redirect. Domain redirects preserve - * the path of the redirect but replace the requested domain with the one - * specified in the redirect configuration. + * Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. */ export interface Schema$DomainRedirect { /** @@ -267,22 +249,15 @@ export namespace firebasehosting_v1beta1 { type?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A [`header`](/docs/hosting/full-config#headers) defines custom headers to - * add to a response should the request URL path match the pattern. + * A [`header`](/docs/hosting/full-config#headers) defines custom headers to add to a response should the request URL path match the pattern. */ export interface Schema$Header { /** - * Required. The user-supplied [glob - * pattern](/docs/hosting/full-config#glob_pattern_matching) to match - * against the request URL path. + * Required. The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. */ glob?: string; /** @@ -302,10 +277,7 @@ export namespace firebasehosting_v1beta1 { } export interface Schema$ListReleasesResponse { /** - * If there are additional releases remaining beyond the ones in this - * response, then supply this token in the next - * [`list`](../sites.versions.files/list) call to continue with the next set - * of releases. + * If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases. */ nextPageToken?: string; /** @@ -325,70 +297,47 @@ export namespace firebasehosting_v1beta1 { } export interface Schema$PopulateVersionFilesRequest { /** - * A set of file paths to the hashes corresponding to assets that should be - * added to the version. Note that a file path to an empty hash will remove - * the path from the version. Calculate a hash by Gzipping the file then - * taking the SHA256 hash of the newly compressed file. + * A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file. */ files?: {[key: string]: string}; } export interface Schema$PopulateVersionFilesResponse { /** - * The content hashes of the specified files that need to be uploaded to the - * specified endpoint. + * The content hashes of the specified files that need to be uploaded to the specified endpoint. */ uploadRequiredHashes?: string[]; /** - * The URL to which the files should be uploaded, in the format: - * <br>"https://upload-firebasehosting.googleapis.com/upload/sites/<var>site-name</var>/versions/<var>versionID</var>/files". - * <br>Perform a multipart `POST` of the Gzipped file contents to the - * URL using a forward slash and the hash of the file appended to the end. + * The URL to which the files should be uploaded, in the format: <br>"https://upload-firebasehosting.googleapis.com/upload/sites/<var>site-name</var>/versions/<var>versionID</var>/files". <br>Perform a multipart `POST` of the Gzipped file contents to the URL using a forward slash and the hash of the file appended to the end. */ uploadUrl?: string; } /** - * A [`redirect`](/docs/hosting/full-config#redirects) represents the - * configuration for returning an HTTP redirect response given a matching - * request URL path. + * A [`redirect`](/docs/hosting/full-config#redirects) represents the configuration for returning an HTTP redirect response given a matching request URL path. */ export interface Schema$Redirect { /** - * Required. The user-supplied [glob - * pattern](/docs/hosting/full-config#glob_pattern_matching) to match - * against the request URL path. + * Required. The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. */ glob?: string; /** - * Required. The value to put in the HTTP location header of the response. - * <br>The location can contain capture group values from the pattern - * using a `:` prefix to identify the segment and an optional `*` to capture - * the rest of the URL. For example: <code>"glob": - * "/:capture*", <br>"statusCode": 301, - * <br>"location": - * "https://example.com/foo/:capture"</code> + * Required. The value to put in the HTTP location header of the response. <br>The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: <code>"glob": "/:capture*", <br>"statusCode": 301, <br>"location": "https://example.com/foo/:capture"</code> */ location?: string; /** - * Required. The status HTTP code to return in the response. It must be a - * valid 3xx status code. + * Required. The status HTTP code to return in the response. It must be a valid 3xx status code. */ statusCode?: number; } /** - * A `Release` is a particular [collection of configurations and - * files](sites.versions) that is set to be public at a particular time. + * A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. */ export interface Schema$Release { /** - * The deploy description when the release was created. The value can be up - * to 512&nbsp;characters. + * The deploy description when the release was created. The value can be up to 512&nbsp;characters. */ message?: string; /** - * Output only. The unique identifier for the release, in the format: - * <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code> - * This name is provided in the response body when you call the - * [`CreateRelease`](sites.releases/create) endpoint. + * Output only. The unique identifier for the release, in the format: <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code> This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint. */ name?: string; /** @@ -400,8 +349,7 @@ export namespace firebasehosting_v1beta1 { */ releaseUser?: Schema$ActingUser; /** - * Explains the reason for the release. <br>Specify a value for this - * field only when creating a `SITE_DISABLE` type release. + * Explains the reason for the release. <br>Specify a value for this field only when creating a `SITE_DISABLE` type release. */ type?: string; /** @@ -410,10 +358,7 @@ export namespace firebasehosting_v1beta1 { version?: Schema$Version; } /** - * A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal - * content rewrite on the version. If the pattern matches, the request will be - * handled as if it were to the destination path specified in the - * configuration. + * A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal content rewrite on the version. If the pattern matches, the request will be handled as if it were to the destination path specified in the configuration. */ export interface Schema$Rewrite { /** @@ -421,14 +366,11 @@ export namespace firebasehosting_v1beta1 { */ dynamicLinks?: boolean; /** - * The function to proxy requests to. Must match the exported function name - * exactly. + * The function to proxy requests to. Must match the exported function name exactly. */ function?: string; /** - * Required. The user-supplied [glob - * pattern](/docs/hosting/full-config#glob_pattern_matching) to match - * against the request URL path. + * Required. The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. */ glob?: string; /** @@ -441,10 +383,7 @@ export namespace firebasehosting_v1beta1 { run?: Schema$CloudRunRewrite; } /** - * The configuration for how incoming requests to a site should be routed and - * processed before serving content. The patterns are matched and applied - * according to a specific [priority - * order](/docs/hosting/full-config#hosting_priority_order). + * The configuration for how incoming requests to a site should be routed and processed before serving content. The patterns are matched and applied according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). */ export interface Schema$ServingConfig { /** @@ -456,18 +395,15 @@ export namespace firebasehosting_v1beta1 { */ cleanUrls?: boolean; /** - * A list of custom response headers that are added to the content if the - * request URL path matches the glob. + * A list of custom response headers that are added to the content if the request URL path matches the glob. */ headers?: Schema$Header[]; /** - * A list of globs that will cause the response to redirect to another - * location. + * A list of globs that will cause the response to redirect to another location. */ redirects?: Schema$Redirect[]; /** - * A list of rewrites that will act as if the service were given the - * destination URL. + * A list of rewrites that will act as if the service were given the destination URL. */ rewrites?: Schema$Rewrite[]; /** @@ -476,27 +412,20 @@ export namespace firebasehosting_v1beta1 { trailingSlashBehavior?: string; } /** - * A `SiteConfig` contains metadata associated with a specific site that - * controls Firebase Hosting serving behavior + * A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior */ export interface Schema$SiteConfig { /** - * The number of FINALIZED versions that will be held for a site before - * automatic deletion. When a new version is deployed, content for versions - * in storage in excess of this number will be deleted, and will no longer - * be billed for storage usage. Oldest versions will be deleted first; sites - * are created with an unlimited number of max_versions by default. + * The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default. */ maxVersions?: string; } /** - * A `Version` is the collection of configuration and [static - * files](sites.versions.files) that determine how a site is displayed. + * A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. */ export interface Schema$Version { /** - * The configuration for the behavior of the site. This configuration exists - * in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file. + * The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file. */ config?: Schema$ServingConfig; /** @@ -516,8 +445,7 @@ export namespace firebasehosting_v1beta1 { */ deleteUser?: Schema$ActingUser; /** - * Output only. The total number of files associated with the version. - * <br>This value is calculated after a version is `FINALIZED`. + * Output only. The total number of files associated with the version. <br>This value is calculated after a version is `FINALIZED`. */ fileCount?: string; /** @@ -533,28 +461,15 @@ export namespace firebasehosting_v1beta1 { */ labels?: {[key: string]: string}; /** - * The unique identifier for a version, in the format: - * <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> - * This name is provided in the response body when you call the - * [`CreateVersion`](../sites.versions/create) endpoint. + * The unique identifier for a version, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint. */ name?: string; /** - * The deploy status of a version. <br> <br>For a successful - * deploy, call the [`CreateVersion`](sites.versions/create) endpoint to - * make a new version (`CREATED` status), [upload all desired - * files](sites.versions/populateFiles) to the version, then - * [update](sites.versions/patch) the version to the `FINALIZED` status. - * <br> <br>Note that if you leave the version in the `CREATED` - * state for more than 12&nbsp;hours, the system will automatically mark - * the version as `ABANDONED`. <br> <br>You can also change the - * status of a version to `DELETED` by calling the - * [`DeleteVersion`](sites.versions/delete) endpoint. + * The deploy status of a version. <br> <br>For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. <br> <br>Note that if you leave the version in the `CREATED` state for more than 12&nbsp;hours, the system will automatically mark the version as `ABANDONED`. <br> <br>You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint. */ status?: string; /** - * Output only. The total stored bytesize of the version. <br>This - * value is calculated after a version is `FINALIZED`. + * Output only. The total stored bytesize of the version. <br>This value is calculated after a version is `FINALIZED`. */ versionBytes?: string; } @@ -571,9 +486,7 @@ export namespace firebasehosting_v1beta1 { */ path?: string; /** - * Output only. The current status of a particular file in the specified - * version. <br>The value will be either `pending upload` or - * `uploaded`. + * Output only. The current status of a particular file in the specified version. <br>The value will be either `pending upload` or `uploaded`. */ status?: string; } @@ -743,8 +656,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The site for which to get the SiteConfig, in the format: - * sites/site-name/config + * Required. The site for which to get the SiteConfig, in the format: sites/site-name/config */ name?: string; } @@ -756,15 +668,11 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The site for which to update the SiteConfig, in the format: - * sites/site-name/config + * Required. The site for which to update the SiteConfig, in the format: sites/site-name/config */ name?: string; /** - * A set of field names from your [site configuration](../sites.SiteConfig) - * that you want to update.
                          A field will be overwritten if, and only if, - * it's in the mask.
                          If a mask is not provided then a default mask of - * only [`max_versions`](../sites.SiteConfig.max_versions) will be used. + * A set of field names from your [site configuration](../sites.SiteConfig) that you want to update.
                          A field will be overwritten if, and only if, it's in the mask.
                          If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used. */ updateMask?: string; @@ -1073,8 +981,7 @@ export namespace firebasehosting_v1beta1 { /** * firebasehosting.sites.domains.update - * @desc Updates the specified domain mapping, creating the mapping as if it - * does not exist. + * @desc Updates the specified domain mapping, creating the mapping as if it does not exist. * @alias firebasehosting.sites.domains.update * @memberOf! () * @@ -1152,8 +1059,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent to create the domain association for, in the format: - * sites/site-name + * Required. The parent to create the domain association for, in the format: sites/site-name */ parent?: string; @@ -1202,8 +1108,7 @@ export namespace firebasehosting_v1beta1 { */ pageToken?: string; /** - * Required. The parent for which to list domains, in the format: - * sites/site-name + * Required. The parent for which to list domains, in the format: sites/site-name */ parent?: string; } @@ -1215,8 +1120,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the domain association to update or create, if an - * association doesn't already exist. + * Required. The name of the domain association to update or create, if an association doesn't already exist. */ name?: string; @@ -1234,8 +1138,7 @@ export namespace firebasehosting_v1beta1 { /** * firebasehosting.sites.releases.create - * @desc Creates a new release which makes the content of the specified - * version actively display on the site. + * @desc Creates a new release which makes the content of the specified version actively display on the site. * @alias firebasehosting.sites.releases.create * @memberOf! () * @@ -1396,17 +1299,11 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The site that the release belongs to, in the format: - * sites/site-name + * The site that the release belongs to, in the format: sites/site-name */ parent?: string; /** - * The unique identifier for a version, in the format: - * /sites/site-name/versions/versionID - * The site-name in this version identifier must match the - * site-name in the `parent` parameter.

                          This query - * parameter must be empty if the `type` field in the request body is - * `SITE_DISABLE`. + * The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

                          This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. */ versionName?: string; @@ -1431,8 +1328,7 @@ export namespace firebasehosting_v1beta1 { */ pageToken?: string; /** - * Required. The parent for which to list files, in the format: - * sites/site-name + * Required. The parent for which to list files, in the format: sites/site-name */ parent?: string; } @@ -1593,12 +1489,7 @@ export namespace firebasehosting_v1beta1 { /** * firebasehosting.sites.versions.patch - * @desc Updates the specified metadata for a version. Note that this method - * will fail with `FAILED_PRECONDITION` in the event of an invalid state - * transition. The only valid transition for a version is currently from a - * `CREATED` status to a `FINALIZED` status. Use - * [`DeleteVersion`](../sites.versions/delete) to set the status of a - * version to `DELETED`. + * @desc Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`. * @alias firebasehosting.sites.versions.patch * @memberOf! () * @@ -1762,18 +1653,15 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent to create the version for, in the format: - * sites/site-name + * Required. The parent to create the version for, in the format: sites/site-name */ parent?: string; /** - * The self-reported size of the version. This value is used for a - * pre-emptive quota check for legacy version uploads. + * The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads. */ sizeBytes?: string; /** - * A unique id for the new version. This is only specified for legacy - * version creations. + * A unique id for the new version. This is only specified for legacy version creations. */ versionId?: string; @@ -1790,8 +1678,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the version to be deleted, in the format: - * sites/site-name/versions/versionID + * Required. The name of the version to be deleted, in the format: sites/site-name/versions/versionID */ name?: string; } @@ -1803,17 +1690,11 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique identifier for a version, in the format: - * sites/site-name/versions/versionID - * This name is provided in the response body when you call the - * [`CreateVersion`](../sites.versions/create) endpoint. + * The unique identifier for a version, in the format: sites/site-name/versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint. */ name?: string; /** - * A set of field names from your [version](../sites.versions) that you want - * to update.
                          A field will be overwritten if, and only if, it's in the - * mask.
                          If a mask is not provided then a default mask of only - * [`status`](../sites.versions#Version.FIELDS.status) will be used. + * A set of field names from your [version](../sites.versions) that you want to update.
                          A field will be overwritten if, and only if, it's in the mask.
                          If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used. */ updateMask?: string; @@ -1830,8 +1711,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The version to add files to, in the format: - * sites/site-name/versions/versionID + * Required. The version to add files to, in the format: sites/site-name/versions/versionID */ parent?: string; @@ -1940,14 +1820,11 @@ export namespace firebasehosting_v1beta1 { */ pageSize?: number; /** - * The next_page_token from a previous request, if provided. This will be - * the encoded version of a - * firebase.hosting.proto.metadata.ListFilesPageToken. + * The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken. */ pageToken?: string; /** - * Required. The parent to list files for, in the format: - * sites/site-name/versions/versionID + * Required. The parent to list files for, in the format: sites/site-name/versions/versionID */ parent?: string; /** diff --git a/src/apis/firebaserules/package.json b/src/apis/firebaserules/package.json index aeb83141da8..b92aa30fb5a 100644 --- a/src/apis/firebaserules/package.json +++ b/src/apis/firebaserules/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/firebaserules/v1.ts b/src/apis/firebaserules/v1.ts index b5f7b080808..2b5fb466092 100644 --- a/src/apis/firebaserules/v1.ts +++ b/src/apis/firebaserules/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace firebaserules_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace firebaserules_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace firebaserules_v1 { /** * Firebase Rules API * - * Creates and manages rules that determine when a Firebase Rules-enabled - * service should permit a request. + * Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace firebaserules_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -133,11 +131,7 @@ export namespace firebaserules_v1 { exactValue?: any; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -158,8 +152,7 @@ export namespace firebaserules_v1 { name?: string; } /** - * Represents a service-defined function call that was invoked during test - * execution. + * Represents a service-defined function call that was invoked during test execution. */ export interface Schema$FunctionCall { /** @@ -172,24 +165,15 @@ export namespace firebaserules_v1 { function?: string; } /** - * Mock function definition. Mocks must refer to a function declared by the - * target service. The type of the function args and result will be inferred - * at test time. If either the arg or result values are not compatible with - * function type declaration, the request will be considered invalid. More - * than one `FunctionMock` may be provided for a given function name so long - * as the `Arg` matchers are distinct. There may be only one function for a - * given overload where all `Arg` values are `Arg.any_value`. + * Mock function definition. Mocks must refer to a function declared by the target service. The type of the function args and result will be inferred at test time. If either the arg or result values are not compatible with function type declaration, the request will be considered invalid. More than one `FunctionMock` may be provided for a given function name so long as the `Arg` matchers are distinct. There may be only one function for a given overload where all `Arg` values are `Arg.any_value`. */ export interface Schema$FunctionMock { /** - * The list of `Arg` values to match. The order in which the arguments are - * provided is the order in which they must appear in the function - * invocation. + * The list of `Arg` values to match. The order in which the arguments are provided is the order in which they must appear in the function invocation. */ args?: Schema$Arg[]; /** - * The name of the function. The function name must match one provided by a - * service declaration. + * The name of the function. The function name must match one provided by a service declaration. */ function?: string; /** @@ -218,9 +202,7 @@ export namespace firebaserules_v1 { */ rulesetName?: string; /** - * Optional, indicates the freshness of the result. The response is - * guaranteed to be the latest within an interval up to the sync_time - * (inclusive). + * Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive). */ syncTime?: string; /** @@ -250,8 +232,7 @@ export namespace firebaserules_v1 { */ export interface Schema$ListReleasesResponse { /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; /** @@ -264,8 +245,7 @@ export namespace firebaserules_v1 { */ export interface Schema$ListRulesetsResponse { /** - * The pagination token to retrieve the next page of results. If the value - * is empty, no further results remain. + * The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */ nextPageToken?: string; /** @@ -274,8 +254,7 @@ export namespace firebaserules_v1 { rulesets?: Schema$Ruleset[]; } /** - * `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a - * `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. + * `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. */ export interface Schema$Release { /** @@ -283,27 +262,11 @@ export namespace firebaserules_v1 { */ createTime?: string; /** - * Resource name for the `Release`. `Release` names may be structured - * `app1/prod/v2` or flat `app1_prod_v2` which affords developers a great - * deal of flexibility in mapping the name to the style that best fits their - * existing development practices. For example, a name could refer to an - * environment, an app, a version, or some combination of three. In the - * table below, for the project name `projects/foo`, the following relative - * release paths show how flat and structured names might be chosen to match - * a desired development / deployment strategy. Use Case | Flat Name | - * Structured Name -------------|---------------------|---------------- - * Environments | releases/qa | releases/qa Apps | - * releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa - * | releases/app1/v2/qa The delimiter between the release name path - * elements can be almost anything and it should work equally well with the - * release name list filter, but in many ways the structured paths provide a - * clearer picture of the relationship between `Release` instances. Format: - * `projects/{project_id}/releases/{release_id}` + * Resource name for the `Release`. `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2` which affords developers a great deal of flexibility in mapping the name to the style that best fits their existing development practices. For example, a name could refer to an environment, an app, a version, or some combination of three. In the table below, for the project name `projects/foo`, the following relative release paths show how flat and structured names might be chosen to match a desired development / deployment strategy. Use Case | Flat Name | Structured Name -------------|---------------------|---------------- Environments | releases/qa | releases/qa Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa | releases/app1/v2/qa The delimiter between the release name path elements can be almost anything and it should work equally well with the release name list filter, but in many ways the structured paths provide a clearer picture of the relationship between `Release` instances. Format: `projects/{project_id}/releases/{release_id}` */ name?: string; /** - * Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must - * exist the `Release` to be created. + * Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. */ rulesetName?: string; /** @@ -320,14 +283,12 @@ export namespace firebaserules_v1 { */ undefined?: Schema$Empty; /** - * The result is an actual value. The type of the value must match that of - * the type declared by the service. + * The result is an actual value. The type of the value must match that of the type declared by the service. */ value?: any; } /** - * `Ruleset` is an immutable copy of `Source` with a globally unique - * identifier and a creation time. + * `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time. */ export interface Schema$Ruleset { /** @@ -335,8 +296,7 @@ export namespace firebaserules_v1 { */ createTime?: string; /** - * Name of the `Ruleset`. The ruleset_id is auto generated by the service. - * Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only. + * Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only. */ name?: string; /** @@ -354,8 +314,7 @@ export namespace firebaserules_v1 { files?: Schema$File[]; } /** - * Position in the `Source` content including its line, column number, and an - * index of the `File` in the `Source` message. Used for debug purposes. + * Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes. */ export interface Schema$SourcePosition { /** @@ -372,13 +331,7 @@ export namespace firebaserules_v1 { line?: number; } /** - * `TestCase` messages provide the request context and an expectation as to - * whether the given context will be allowed or denied. Test cases may specify - * the `request`, `resource`, and `function_mocks` to mock a function call to - * a service-provided function. The `request` object represents context - * present at request-time. The `resource` is the value of the target - * resource as it appears in persistent storage before the request is - * executed. + * `TestCase` messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the `request`, `resource`, and `function_mocks` to mock a function call to a service-provided function. The `request` object represents context present at request-time. The `resource` is the value of the target resource as it appears in persistent storage before the request is executed. */ export interface Schema$TestCase { /** @@ -386,57 +339,32 @@ export namespace firebaserules_v1 { */ expectation?: string; /** - * Optional function mocks for service-defined functions. If not set, any - * service defined function is expected to return an error, which may or may - * not influence the test outcome. + * Optional function mocks for service-defined functions. If not set, any service defined function is expected to return an error, which may or may not influence the test outcome. */ functionMocks?: Schema$FunctionMock[]; /** - * Request context. The exact format of the request context is - * service-dependent. See the appropriate service documentation for - * information about the supported fields and types on the request. - * Minimally, all services support the following fields and types: Request - * field | Type ---------------|----------------- auth.uid | `string` - * auth.token | `map<string, string>` headers | - * `map<string, string>` method | `string` params | - * `map<string, string>` path | `string` time | - * `google.protobuf.Timestamp` If the request value is not well-formed for - * the service, the request will be rejected as an invalid argument. + * Request context. The exact format of the request context is service-dependent. See the appropriate service documentation for information about the supported fields and types on the request. Minimally, all services support the following fields and types: Request field | Type ---------------|----------------- auth.uid | `string` auth.token | `map<string, string>` headers | `map<string, string>` method | `string` params | `map<string, string>` path | `string` time | `google.protobuf.Timestamp` If the request value is not well-formed for the service, the request will be rejected as an invalid argument. */ request?: any; /** - * Optional resource value as it appears in persistent storage before the - * request is fulfilled. The resource type depends on the `request.path` - * value. + * Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the `request.path` value. */ resource?: any; } /** - * Test result message containing the state of the test as well as a - * description and source position for test failures. + * Test result message containing the state of the test as well as a description and source position for test failures. */ export interface Schema$TestResult { /** - * Debug messages related to test execution issues encountered during - * evaluation. Debug messages may be related to too many or too few - * invocations of function mocks or to runtime errors that occur during - * evaluation. For example: ```Unable to read variable [name: - * "resource"]``` + * Debug messages related to test execution issues encountered during evaluation. Debug messages may be related to too many or too few invocations of function mocks or to runtime errors that occur during evaluation. For example: ```Unable to read variable [name: "resource"]``` */ debugMessages?: string[]; /** - * Position in the `Source` or `Ruleset` where the principle runtime error - * occurs. Evaluation of an expression may result in an error. Rules are - * deny by default, so a `DENY` expectation when an error is generated is - * valid. When there is a `DENY` with an error, the `SourcePosition` is - * returned. E.g. `error_position { line: 19 column: 37 }` + * Position in the `Source` or `Ruleset` where the principle runtime error occurs. Evaluation of an expression may result in an error. Rules are deny by default, so a `DENY` expectation when an error is generated is valid. When there is a `DENY` with an error, the `SourcePosition` is returned. E.g. `error_position { line: 19 column: 37 }` */ errorPosition?: Schema$SourcePosition; /** - * The set of function calls made to service-defined methods. Function - * calls are included in the order in which they are encountered during - * evaluation, are provided for both mocked and unmocked functions, and - * included on the response regardless of the test `state`. + * The set of function calls made to service-defined methods. Function calls are included in the order in which they are encountered during evaluation, are provided for both mocked and unmocked functions, and included on the response regardless of the test `state`. */ functionCalls?: Schema$FunctionCall[]; /** @@ -444,11 +372,7 @@ export namespace firebaserules_v1 { */ state?: string; /** - * The set of visited permission expressions for a given test. This returns - * the positions and evaluation results of all visited permission - * expressions which were relevant to the test case, e.g. ``` match /path { - * allow read if: <expr> } ``` For a detailed report of the - * intermediate evaluation states, see the `expression_reports` field + * The set of visited permission expressions for a given test. This returns the positions and evaluation results of all visited permission expressions which were relevant to the test case, e.g. ``` match /path { allow read if: <expr> } ``` For a detailed report of the intermediate evaluation states, see the `expression_reports` field */ visitedExpressions?: Schema$VisitedExpression[]; } @@ -457,8 +381,7 @@ export namespace firebaserules_v1 { */ export interface Schema$TestRulesetRequest { /** - * Optional `Source` to be checked for correctness. This field must not be - * set when the resource name refers to a `Ruleset`. + * Optional `Source` to be checked for correctness. This field must not be set when the resource name refers to a `Ruleset`. */ source?: Schema$Source; /** @@ -471,22 +394,16 @@ export namespace firebaserules_v1 { */ export interface Schema$TestRulesetResponse { /** - * Syntactic and semantic `Source` issues of varying severity. Issues of - * `ERROR` severity will prevent tests from executing. + * Syntactic and semantic `Source` issues of varying severity. Issues of `ERROR` severity will prevent tests from executing. */ issues?: Schema$Issue[]; /** - * The set of test results given the test cases in the `TestSuite`. The - * results will appear in the same order as the test cases appear in the - * `TestSuite`. + * The set of test results given the test cases in the `TestSuite`. The results will appear in the same order as the test cases appear in the `TestSuite`. */ testResults?: Schema$TestResult[]; } /** - * `TestSuite` is a collection of `TestCase` instances that validate the - * logical correctness of a `Ruleset`. The `TestSuite` may be referenced - * in-line within a `TestRuleset` invocation or as part of a `Release` object - * as a pre-release check. + * `TestSuite` is a collection of `TestCase` instances that validate the logical correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a `TestRuleset` invocation or as part of a `Release` object as a pre-release check. */ export interface Schema$TestSuite { /** @@ -533,19 +450,7 @@ export namespace firebaserules_v1 { /** * firebaserules.projects.test - * @desc Test `Source` for syntactic and semantic correctness. Issues - * present, if any, will be returned to the caller with a description, - * severity, and source location. The test method may be executed with - * `Source` or a `Ruleset` name. Passing `Source` is useful for unit testing - * new rules. Passing a `Ruleset` name is useful for regression testing an - * existing rule. The following is an example of `Source` that permits - * users to upload images to a bucket bearing their user id and matching the - * correct metadata: _*Example*_ // Users are allowed to subscribe and - * unsubscribe to the blog. service firebase.storage { match - * /users/{userId}/images/{imageName} { allow write: if userId == - * request.auth.uid && (imageName.matches('*.png$') || - * imageName.matches('*.jpg$')) && - * resource.mimeType.matches('^image/') } } + * @desc Test `Source` for syntactic and semantic correctness. Issues present, if any, will be returned to the caller with a description, severity, and source location. The test method may be executed with `Source` or a `Ruleset` name. Passing `Source` is useful for unit testing new rules. Passing a `Ruleset` name is useful for regression testing an existing rule. The following is an example of `Source` that permits users to upload images to a bucket bearing their user id and matching the correct metadata: _*Example*_ // Users are allowed to subscribe and unsubscribe to the blog. service firebase.storage { match /users/{userId}/images/{imageName} { allow write: if userId == request.auth.uid && (imageName.matches('*.png$') || imageName.matches('*.jpg$')) && resource.mimeType.matches('^image/') } } * @alias firebaserules.projects.test * @memberOf! () * @@ -623,11 +528,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Tests may either provide `source` or a `Ruleset` resource name. For - * tests against `source`, the resource name must refer to the project: - * Format: `projects/{project_id}` For tests against a `Ruleset`, this must - * be the `Ruleset` resource name: Format: - * `projects/{project_id}/rulesets/{ruleset_id}` + * Tests may either provide `source` or a `Ruleset` resource name. For tests against `source`, the resource name must refer to the project: Format: `projects/{project_id}` For tests against a `Ruleset`, this must be the `Ruleset` resource name: Format: `projects/{project_id}/rulesets/{ruleset_id}` */ name?: string; @@ -645,21 +546,7 @@ export namespace firebaserules_v1 { /** * firebaserules.projects.releases.create - * @desc Create a `Release`. Release names should reflect the developer's - * deployment practices. For example, the release name may include the - * environment name, application name, application version, or any other - * name meaningful to the developer. Once a `Release` refers to a `Ruleset`, - * the rules can be enforced by Firebase Rules-enabled services. More than - * one `Release` may be 'live' concurrently. Consider the following three - * `Release` names for `projects/foo` and the `Ruleset` to which they refer. - * Release Name | Ruleset Name - * --------------------------------|------------- projects/foo/releases/prod - * | projects/foo/rulesets/uuid123 projects/foo/releases/prod/beta | - * projects/foo/rulesets/uuid123 projects/foo/releases/prod/v23 | - * projects/foo/rulesets/uuid456 The table reflects the `Ruleset` rollout - * in progress. The `prod` and `prod/beta` releases refer to the same - * `Ruleset`. However, `prod/v23` refers to a new `Ruleset`. The `Ruleset` - * reference for a `Release` may be updated using the UpdateRelease method. + * @desc Create a `Release`. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a `Release` refers to a `Ruleset`, the rules can be enforced by Firebase Rules-enabled services. More than one `Release` may be 'live' concurrently. Consider the following three `Release` names for `projects/foo` and the `Ruleset` to which they refer. Release Name | Ruleset Name --------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid123 projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123 projects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456 The table reflects the `Ruleset` rollout in progress. The `prod` and `prod/beta` releases refer to the same `Ruleset`. However, `prod/v23` refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be updated using the UpdateRelease method. * @alias firebaserules.projects.releases.create * @memberOf! () * @@ -958,9 +845,7 @@ export namespace firebaserules_v1 { /** * firebaserules.projects.releases.list - * @desc List the `Release` values for a project. This list may optionally - * be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any - * combination thereof. + * @desc List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof. * @alias firebaserules.projects.releases.list * @memberOf! () * @@ -1040,9 +925,7 @@ export namespace firebaserules_v1 { /** * firebaserules.projects.releases.patch - * @desc Update a `Release` via PATCH. Only updates to the `ruleset_name` - * and `test_suite_name` fields will be honored. `Release` rename is not - * supported. To create a `Release` use the CreateRelease method. + * @desc Update a `Release` via PATCH. Only updates to the `ruleset_name` and `test_suite_name` fields will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method. * @alias firebaserules.projects.releases.patch * @memberOf! () * @@ -1120,8 +1003,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for the project which owns this `Release`. Format: - * `projects/{project_id}` + * Resource name for the project which owns this `Release`. Format: `projects/{project_id}` */ name?: string; @@ -1138,8 +1020,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for the `Release` to delete. Format: - * `projects/{project_id}/releases/{release_id}` + * Resource name for the `Release` to delete. Format: `projects/{project_id}/releases/{release_id}` */ name?: string; } @@ -1151,8 +1032,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the `Release`. Format: - * `projects/{project_id}/releases/{release_id}` + * Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}` */ name?: string; } @@ -1164,13 +1044,11 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The requested runtime executable version. Defaults to - * FIREBASE_RULES_EXECUTABLE_V1. + * The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1. */ executableVersion?: string; /** - * Resource name of the `Release`. Format: - * `projects/{project_id}/releases/{release_id}` + * Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}` */ name?: string; } @@ -1182,24 +1060,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * `Release` filter. The list method supports filters with restrictions on - * the `Release.name`, `Release.ruleset_name`, and - * `Release.test_suite_name`. Example 1: A filter of 'name=prod*' might - * return `Release`s with names within 'projects/foo' prefixed with 'prod': - * Name | Ruleset Name - * ------------------------------|------------- projects/foo/releases/prod - * | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v1 | - * projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v2 | - * projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* - * ruleset_name=uuid1234` would return only `Release` instances for - * 'projects/foo' with names prefixed with 'prod' referring to the same - * `Ruleset` name of 'uuid1234': Name | Ruleset - * Name ------------------------------|------------- - * projects/foo/releases/prod | projects/foo/rulesets/1234 - * projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 In the - * examples, the filter parameters refer to the search filters are relative - * to the project. Fully qualified prefixed may also be used. e.g. - * `test_suite_name=projects/foo/testsuites/uuid1` + * `Release` filter. The list method supports filters with restrictions on the `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used. e.g. `test_suite_name=projects/foo/testsuites/uuid1` */ filter?: string; /** @@ -1207,11 +1068,7 @@ export namespace firebaserules_v1 { */ name?: string; /** - * Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is - * just a hint and the service may choose to load fewer than `page_size` - * results due to the size of the output. To traverse all of the releases, - * the caller should iterate until the `page_token` on the response is - * empty. + * Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty. */ pageSize?: number; /** @@ -1227,8 +1084,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for the project which owns this `Release`. Format: - * `projects/{project_id}` + * Resource name for the project which owns this `Release`. Format: `projects/{project_id}` */ name?: string; @@ -1246,11 +1102,7 @@ export namespace firebaserules_v1 { /** * firebaserules.projects.rulesets.create - * @desc Create a `Ruleset` from `Source`. The `Ruleset` is given a unique - * generated name which is returned to the caller. `Source` containing - * syntactic or semantics errors will result in an error response indicating - * the first error encountered. For a detailed view of `Source` issues, use - * TestRuleset. + * @desc Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset. * @alias firebaserules.projects.rulesets.create * @memberOf! () * @@ -1324,8 +1176,7 @@ export namespace firebaserules_v1 { /** * firebaserules.projects.rulesets.delete - * @desc Delete a `Ruleset` by resource name. If the `Ruleset` is - * referenced by a `Release` the operation will fail. + * @desc Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail. * @alias firebaserules.projects.rulesets.delete * @memberOf! () * @@ -1465,9 +1316,7 @@ export namespace firebaserules_v1 { /** * firebaserules.projects.rulesets.list - * @desc List `Ruleset` metadata only and optionally filter the results by - * `Ruleset` name. The full `Source` contents of a `Ruleset` may be - * retrieved with GetRuleset. + * @desc List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset. * @alias firebaserules.projects.rulesets.list * @memberOf! () * @@ -1554,8 +1403,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for Project which owns this `Ruleset`. Format: - * `projects/{project_id}` + * Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}` */ name?: string; @@ -1572,8 +1420,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for the ruleset to delete. Format: - * `projects/{project_id}/rulesets/{ruleset_id}` + * Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_id}` */ name?: string; } @@ -1585,8 +1432,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for the ruleset to get. Format: - * `projects/{project_id}/rulesets/{ruleset_id}` + * Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}` */ name?: string; } @@ -1598,11 +1444,7 @@ export namespace firebaserules_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * `Ruleset` filter. The list method supports filters with restrictions on - * `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` - * function which parses strings that conform to the RFC 3339 date/time - * specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND - * name=UUID-*` + * `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*` */ filter?: string; /** @@ -1610,10 +1452,7 @@ export namespace firebaserules_v1 { */ name?: string; /** - * Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is - * just a hint and the service may choose to load less than `page_size` due - * to the size of the output. To traverse all of the releases, caller should - * iterate until the `page_token` is empty. + * Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty. */ pageSize?: number; /** diff --git a/src/apis/firestore/package.json b/src/apis/firestore/package.json index a543b0e0856..c2eb63ed765 100644 --- a/src/apis/firestore/package.json +++ b/src/apis/firestore/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index fef368e3b3e..bb8bf4b7a77 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace firestore_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace firestore_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace firestore_v1 { /** * Cloud Firestore API * - * Accesses the NoSQL document database built for automatic scaling, high - * performance, and ease of application development. + * Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace firestore_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -133,27 +131,19 @@ export namespace firestore_v1 { */ export interface Schema$BatchGetDocumentsRequest { /** - * The names of the documents to retrieve. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * The request will fail if any of the document is not a child resource of - * the given `database`. Duplicate names will be elided. + * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ documents?: string[]; /** - * The fields to return. If not set, returns all fields. If a document has - * a field that is not present in this mask, that field will not be returned - * in the response. + * The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. */ mask?: Schema$DocumentMask; /** - * Starts a new transaction and reads the documents. Defaults to a read-only - * transaction. The new transaction ID will be returned as the first - * response in the stream. + * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ newTransaction?: Schema$TransactionOptions; /** - * Reads documents as they were at the given time. This may not be older - * than 60 seconds. + * Reads documents as they were at the given time. This may not be older than 60 seconds. */ readTime?: string; /** @@ -170,20 +160,15 @@ export namespace firestore_v1 { */ found?: Schema$Document; /** - * A document name that was requested but does not exist. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * A document name that was requested but does not exist. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ missing?: string; /** - * The time at which the document was read. This may be monotically - * increasing, in this case the previous documents in the result stream are - * guaranteed not to have changed between their read_time and this one. + * The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. */ readTime?: string; /** - * The transaction that was started as part of this request. Will only be - * set in the first response, and only if - * BatchGetDocumentsRequest.new_transaction was set in the request. + * The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request. */ transaction?: string; } @@ -210,9 +195,7 @@ export namespace firestore_v1 { */ export interface Schema$CollectionSelector { /** - * When false, selects only collections that are immediate children of the - * `parent` specified in the containing `RunQueryRequest`. When true, - * selects all descendant collections. + * When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections. */ allDescendants?: boolean; /** @@ -242,8 +225,7 @@ export namespace firestore_v1 { */ commitTime?: string; /** - * The result of applying the writes. This i-th write result corresponds to - * the i-th write in the request. + * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ writeResults?: Schema$WriteResult[]; } @@ -265,14 +247,11 @@ export namespace firestore_v1 { */ export interface Schema$Cursor { /** - * If the position is just before or just after the given values, relative - * to the sort order defined by the query. + * If the position is just before or just after the given values, relative to the sort order defined by the query. */ before?: boolean; /** - * The values that represent a position, in the order they appear in the - * order by clause of a query. Can contain fewer values than specified in - * the order by clause. + * The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. */ values?: Schema$Value[]; } @@ -281,54 +260,28 @@ export namespace firestore_v1 { */ export interface Schema$Document { /** - * Output only. The time at which the document was created. This value - * increases monotonically when a document is deleted then recreated. It can - * also be compared to values from other documents and the `read_time` of a - * query. + * Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. */ createTime?: string; /** - * The document's fields. The map keys represent field names. A simple - * field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, - * or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. - * Field names matching the regular expression `__.*__` are reserved. - * Reserved field names are forbidden except in certain documented contexts. - * The map keys, represented as UTF-8, must not exceed 1,500 bytes and - * cannot be empty. Field paths may be used in other contexts to refer to - * structured fields defined here. For `map_value`, the field path is - * represented by the simple or quoted field names of the containing fields, - * delimited by `.`. For example, the structured field `"foo" : { - * map_value: { "x&y" : { string_value: "hello" }}}` - * would be represented by the field path `foo.x&y`. Within a field - * path, a quoted field name starts and ends with `` ` `` and may contain - * any character. Some characters, including `` ` ``, must be escaped using - * a `\`. For example, `` `x&y` `` represents `x&y` and `` - * `bak\`tik` `` represents `` bak`tik ``. + * The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. */ fields?: {[key: string]: Schema$Value}; /** - * The resource name of the document, for example - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** - * Output only. The time at which the document was last changed. This value - * is initially set to the `create_time` then increases monotonically with - * each change to the document. It can also be compared to values from other - * documents and the `read_time` of a query. + * Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. */ updateTime?: string; } /** - * A Document has changed. May be the result of multiple writes, including - * deletes, that ultimately resulted in a new value for the Document. Multiple - * DocumentChange messages may be returned for the same logical change, if - * multiple targets are affected. + * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. */ export interface Schema$DocumentChange { /** - * The new state of the Document. If `mask` is set, contains only fields - * that were updated or added. + * The new state of the Document. If `mask` is set, contains only fields that were updated or added. */ document?: Schema$Document; /** @@ -341,10 +294,7 @@ export namespace firestore_v1 { targetIds?: number[]; } /** - * A Document has been deleted. May be the result of multiple writes, - * including updates, the last of which deleted the Document. Multiple - * DocumentDelete messages may be returned for the same logical delete, if - * multiple targets are affected. + * A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected. */ export interface Schema$DocumentDelete { /** @@ -352,8 +302,7 @@ export namespace firestore_v1 { */ document?: string; /** - * The read timestamp at which the delete was observed. Greater or equal to - * the `commit_time` of the delete. + * The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete. */ readTime?: string; /** @@ -362,25 +311,16 @@ export namespace firestore_v1 { removedTargetIds?: number[]; } /** - * A set of field paths on a document. Used to restrict a get or update - * operation on a document to a subset of its fields. This is different from - * standard field masks, as this is always scoped to a Document, and takes in - * account the dynamic nature of Value. + * A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value. */ export interface Schema$DocumentMask { /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ fieldPaths?: string[]; } /** - * A Document has been removed from the view of the targets. Sent if the - * document is no longer relevant to a target and is out of view. Can be sent - * instead of a DocumentDelete or a DocumentChange if the server can not send - * the new value of the document. Multiple DocumentRemove messages may be - * returned for the same logical write or delete, if multiple targets are - * affected. + * A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected. */ export interface Schema$DocumentRemove { /** @@ -388,8 +328,7 @@ export namespace firestore_v1 { */ document?: string; /** - * The read timestamp at which the remove was observed. Greater or equal to - * the `commit_time` of the change/delete/remove. + * The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove. */ readTime?: string; /** @@ -402,10 +341,7 @@ export namespace firestore_v1 { */ export interface Schema$DocumentsTarget { /** - * The names of the documents to retrieve. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * The request will fail if any of the document is not a child resource of - * the given `database`. Duplicate names will be elided. + * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ documents?: string[]; } @@ -418,17 +354,12 @@ export namespace firestore_v1 { */ document?: string; /** - * The list of transformations to apply to the fields of the document, in - * order. This must not be empty. + * The list of transformations to apply to the fields of the document, in order. This must not be empty. */ fieldTransforms?: Schema$FieldTransform[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -436,9 +367,7 @@ export namespace firestore_v1 { */ export interface Schema$ExistenceFilter { /** - * The total count of documents that match target_id. If different from the - * count of documents in the client that match, the client must manually - * determine which documents no longer match the target. + * The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target. */ count?: number; /** @@ -474,65 +403,27 @@ export namespace firestore_v1 { */ export interface Schema$FieldTransform { /** - * Append the given elements in order if they are not already present in the - * current field value. If the field is not an array, or if the field does - * not yet exist, it is first set to the empty array. Equivalent numbers of - * different types (e.g. 3L and 3.0) are considered equal when checking if a - * value is missing. NaN is equal to NaN, and Null is equal to Null. If the - * input contains multiple equivalent values, only the first will be - * considered. The corresponding transform_result will be the null value. + * Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. */ appendMissingElements?: Schema$ArrayValue; /** - * The path of the field. See Document.fields for the field path syntax - * reference. + * The path of the field. See Document.fields for the field path syntax reference. */ fieldPath?: string; /** - * Adds the given value to the field's current value. This must be an - * integer or a double value. If the field is not an integer or double, or - * if the field does not yet exist, the transformation will set the field to - * the given value. If either of the given value or the current field value - * are doubles, both values will be interpreted as doubles. Double - * arithmetic and representation of double values follow IEEE 754 semantics. - * If there is positive/negative integer overflow, the field is resolved to - * the largest magnitude positive/negative integer. + * Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. */ increment?: Schema$Value; /** - * Sets the field to the maximum of its current value and the given value. - * This must be an integer or a double value. If the field is not an integer - * or double, or if the field does not yet exist, the transformation will - * set the field to the given value. If a maximum operation is applied where - * the field and the input value are of mixed types (that is - one is an - * integer and one is a double) the field takes on the type of the larger - * operand. If the operands are equivalent (e.g. 3 and 3.0), the field does - * not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored - * value and zero input value is always the stored value. The maximum of any - * numeric value x and NaN is NaN. + * Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. */ maximum?: Schema$Value; /** - * Sets the field to the minimum of its current value and the given value. - * This must be an integer or a double value. If the field is not an integer - * or double, or if the field does not yet exist, the transformation will - * set the field to the input value. If a minimum operation is applied where - * the field and the input value are of mixed types (that is - one is an - * integer and one is a double) the field takes on the type of the smaller - * operand. If the operands are equivalent (e.g. 3 and 3.0), the field does - * not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored - * value and zero input value is always the stored value. The minimum of any - * numeric value x and NaN is NaN. + * Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. */ minimum?: Schema$Value; /** - * Remove all of the given elements from the array in the field. If the - * field is not an array, or if the field does not yet exist, it is set to - * the empty array. Equivalent numbers of the different types (e.g. 3L - * and 3.0) are considered equal when deciding whether an element should be - * removed. NaN is equal to NaN, and Null is equal to Null. This will remove - * all equivalent values if there are duplicates. The corresponding - * transform_result will be the null value. + * Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. */ removeAllFromArray?: Schema$ArrayValue; /** @@ -558,8 +449,7 @@ export namespace firestore_v1 { unaryFilter?: Schema$UnaryFilter; } /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.ExportDocuments. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments. */ export interface Schema$GoogleFirestoreAdminV1ExportDocumentsMetadata { /** @@ -567,8 +457,7 @@ export namespace firestore_v1 { */ collectionIds?: string[]; /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** @@ -601,14 +490,7 @@ export namespace firestore_v1 { */ collectionIds?: string[]; /** - * The output URI. Currently only supports Google Cloud Storage URIs of the - * form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the - * name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an - * optional Google Cloud Storage namespace path. When choosing a name, be - * sure to consider Google Cloud Storage naming guidelines: - * https://cloud.google.com/storage/docs/naming. If the URI is a bucket - * (without a namespace path), a prefix will be generated based on the start - * time. + * The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. */ outputUriPrefix?: string; } @@ -617,61 +499,33 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1ExportDocumentsResponse { /** - * Location of the output files. This can be used to begin an import into - * Cloud Firestore (this project or another project) after the operation - * completes successfully. + * Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully. */ outputUriPrefix?: string; } /** - * Represents a single field in the database. Fields are grouped by their - * "Collection Group", which represent all collections in the - * database with the same id. + * Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id. */ export interface Schema$GoogleFirestoreAdminV1Field { /** - * The index configuration for this field. If unset, field indexing will - * revert to the configuration defined by the `ancestor_field`. To - * explicitly remove all indexes for this field, specify an index config - * with an empty list of indexes. + * The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes. */ indexConfig?: Schema$GoogleFirestoreAdminV1IndexConfig; /** - * A field name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` - * A field path may be a simple field name, e.g. `address` or a path to - * fields within map_value , e.g. `address.city`, or a special field path. - * The only valid special field is `*`, which represents any field. Field - * paths may be quoted using ` (backtick). The only character that needs to - * be escaped within a quoted field path is the backtick character itself, - * escaped using a backslash. Special characters in field paths that must be - * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii - * symbolic characters. Examples: (Note: Comments here are written in - * markdown syntax, so there is an additional layer of backticks to - * represent a code block) `\`address.city\`` represents a field named - * `address.city`, not the map key `city` in the field `address`. `\`*\`` - * represents a field named `*`, not any field. A special `Field` contains - * the default indexing settings for all fields. This field's resource - * name is: - * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x - * Indexes defined on this `Field` will be applied to all fields which do - * not have their own `Field` index configuration. + * A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */ name?: string; } /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.UpdateField. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField. */ export interface Schema$GoogleFirestoreAdminV1FieldOperationMetadata { /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** - * The field resource that this operation is acting on. For example: - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + * The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` */ field?: string; /** @@ -696,8 +550,7 @@ export namespace firestore_v1 { state?: string; } /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.ImportDocuments. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. */ export interface Schema$GoogleFirestoreAdminV1ImportDocumentsMetadata { /** @@ -705,8 +558,7 @@ export namespace firestore_v1 { */ collectionIds?: string[]; /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** @@ -735,49 +587,28 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1ImportDocumentsRequest { /** - * Which collection ids to import. Unspecified means all collections - * included in the import. + * Which collection ids to import. Unspecified means all collections included in the import. */ collectionIds?: string[]; /** - * Location of the exported files. This must match the output_uri_prefix of - * an ExportDocumentsResponse from an export that has completed - * successfully. See: - * google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. + * Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. */ inputUriPrefix?: string; } /** - * Cloud Firestore indexes enable simple and complex queries against documents - * in a database. + * Cloud Firestore indexes enable simple and complex queries against documents in a database. */ export interface Schema$GoogleFirestoreAdminV1Index { /** - * The fields supported by this index. For composite indexes, this is - * always 2 or more fields. The last field entry is always for the field - * path `__name__`. If, on creation, `__name__` was not specified as the - * last field, it will be added automatically with the same direction as - * that of the last field defined. If the final field in a composite index - * is not directional, the `__name__` will be ordered ASCENDING (unless - * explicitly specified). For single field indexes, this will always be - * exactly one entry with a field path equal to the field path of the - * associated field. + * The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. */ fields?: Schema$GoogleFirestoreAdminV1IndexField[]; /** - * Output only. A server defined name for this index. The form of this name - * for composite indexes will be: - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` - * For single field indexes, this field will be empty. + * Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. */ name?: string; /** - * Indexes with a collection query scope specified allow queries against a - * collection that is the child of a specific document, specified at query - * time, and that has the same collection id. Indexes with a collection - * group query scope specified allow queries against all collections - * descended from a specific document, specified at query time, and that - * have the same collection id as this index. + * Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. */ queryScope?: string; /** @@ -790,10 +621,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1IndexConfig { /** - * Output only. Specifies the resource name of the `Field` from which this - * field's index configuration is set (when `uses_ancestor_config` is - * true), or from which it *would* be set if this field had no index - * configuration (when `uses_ancestor_config` is false). + * Output only. Specifies the resource name of the `Field` from which this field's index configuration is set (when `uses_ancestor_config` is true), or from which it *would* be set if this field had no index configuration (when `uses_ancestor_config` is false). */ ancestorField?: string; /** @@ -801,17 +629,11 @@ export namespace firestore_v1 { */ indexes?: Schema$GoogleFirestoreAdminV1Index[]; /** - * Output only When true, the `Field`'s index configuration is in the - * process of being reverted. Once complete, the index config will - * transition to the same state as the field specified by `ancestor_field`, - * at which point `uses_ancestor_config` will be `true` and `reverting` will - * be `false`. + * Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`. */ reverting?: boolean; /** - * Output only. When true, the `Field`'s index configuration is set from - * the configuration specified by the `ancestor_field`. When false, the - * `Field`'s index configuration is defined explicitly. + * Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. */ usesAncestorConfig?: boolean; } @@ -829,8 +651,7 @@ export namespace firestore_v1 { index?: Schema$GoogleFirestoreAdminV1Index; } /** - * A field in an index. The field_path describes which field is indexed, the - * value_mode describes how the field value is indexed. + * A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. */ export interface Schema$GoogleFirestoreAdminV1IndexField { /** @@ -838,29 +659,24 @@ export namespace firestore_v1 { */ arrayConfig?: string; /** - * Can be __name__. For single field indexes, this must match the name of - * the field or may be omitted. + * Can be __name__. For single field indexes, this must match the name of the field or may be omitted. */ fieldPath?: string; /** - * Indicates that this field supports ordering by the specified order or - * comparing using =, <, <=, >, >=. + * Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. */ order?: string; } /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.CreateIndex. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. */ export interface Schema$GoogleFirestoreAdminV1IndexOperationMetadata { /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** - * The index resource that this operation is acting on. For example: - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ index?: string; /** @@ -889,8 +705,7 @@ export namespace firestore_v1 { */ fields?: Schema$GoogleFirestoreAdminV1Field[]; /** - * A page token that may be used to request another page of results. If - * blank, this is the last page. + * A page token that may be used to request another page of results. If blank, this is the last page. */ nextPageToken?: string; } @@ -903,8 +718,7 @@ export namespace firestore_v1 { */ indexes?: Schema$GoogleFirestoreAdminV1Index[]; /** - * A page token that may be used to request another page of results. If - * blank, this is the last page. + * A page token that may be used to request another page of results. If blank, this is the last page. */ nextPageToken?: string; } @@ -913,8 +727,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1LocationMetadata {} /** - * Describes the progress of the operation. Unit of work is generic and must - * be interpreted based on where Progress is used. + * Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used. */ export interface Schema$GoogleFirestoreAdminV1Progress { /** @@ -944,14 +757,11 @@ export namespace firestore_v1 { operations?: Schema$GoogleLongrunningOperation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -959,35 +769,20 @@ export namespace firestore_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -1068,14 +863,11 @@ export namespace firestore_v1 { */ documentDelete?: Schema$DocumentDelete; /** - * A Document has been removed from a target (because it is no longer - * relevant to that target). + * A Document has been removed from a target (because it is no longer relevant to that target). */ documentRemove?: Schema$DocumentRemove; /** - * A filter to apply to the set of documents previously returned for the - * given target. Returned when documents may have been removed from the - * given target, but the exact documents are unknown. + * A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown. */ filter?: Schema$ExistenceFilter; /** @@ -1101,13 +893,11 @@ export namespace firestore_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -1115,13 +905,11 @@ export namespace firestore_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -1130,10 +918,7 @@ export namespace firestore_v1 { */ export interface Schema$MapValue { /** - * The map's fields. The map keys represent field names. Field names - * matching the regular expression `__.*__` are reserved. Reserved field - * names are forbidden except in certain documented contexts. The map keys, - * represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + * The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. */ fields?: {[key: string]: Schema$Value}; } @@ -1155,13 +940,11 @@ export namespace firestore_v1 { */ export interface Schema$Precondition { /** - * When set to `true`, the target document must exist. When set to `false`, - * the target document must not exist. + * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ exists?: boolean; /** - * When set, the target document must exist and have been last updated at - * that time. + * When set, the target document must exist and have been last updated at that time. */ updateTime?: string; } @@ -1170,8 +953,7 @@ export namespace firestore_v1 { */ export interface Schema$Projection { /** - * The fields to return. If empty, all fields are returned. To only return - * the name of the document, use `['__name__']`. + * The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`. */ fields?: Schema$FieldReference[]; } @@ -1180,11 +962,7 @@ export namespace firestore_v1 { */ export interface Schema$QueryTarget { /** - * The parent resource name. In the format: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: `projects/my-project/databases/my-database/documents` or - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; /** @@ -1224,14 +1002,11 @@ export namespace firestore_v1 { */ export interface Schema$RunQueryRequest { /** - * Starts a new transaction and reads the documents. Defaults to a read-only - * transaction. The new transaction ID will be returned as the first - * response in the stream. + * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ newTransaction?: Schema$TransactionOptions; /** - * Reads documents as they were at the given time. This may not be older - * than 60 seconds. + * Reads documents as they were at the given time. This may not be older than 60 seconds. */ readTime?: string; /** @@ -1252,61 +1027,20 @@ export namespace firestore_v1 { */ document?: Schema$Document; /** - * The time at which the document was read. This may be monotonically - * increasing; in this case, the previous documents in the result stream are - * guaranteed not to have changed between their `read_time` and this one. If - * the query returns no results, a response with `read_time` and no - * `document` will be sent, and this represents the time at which the query - * was run. + * The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run. */ readTime?: string; /** - * The number of results that have been skipped due to an offset between the - * last response and the current response. + * The number of results that have been skipped due to an offset between the last response and the current response. */ skippedResults?: number; /** - * The transaction that was started as part of this request. Can only be set - * in the first response, and only if RunQueryRequest.new_transaction was - * set in the request. If set, no other fields will be set in this response. + * The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response. */ transaction?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1314,14 +1048,11 @@ export namespace firestore_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1338,27 +1069,15 @@ export namespace firestore_v1 { */ from?: Schema$CollectionSelector[]; /** - * The maximum number of results to return. Applies after all other - * constraints. Must be >= 0 if specified. + * The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified. */ limit?: number; /** - * The number of results to skip. Applies before limit, but after all other - * constraints. Must be >= 0 if specified. + * The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified. */ offset?: number; /** - * The order to apply to the query results. Firestore guarantees a stable - * ordering through the following rules: * Any field required to appear in - * `order_by`, that is not already specified in `order_by`, is appended - * to the order in field name order by default. * If an order on - * `__name__` is not specified, it is appended by default. Fields are - * appended with the same sort direction as the last order specified, or - * 'ASCENDING' if no order was specified. For example: * `SELECT * - * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` - * * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER - * BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes - * `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` + * The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` */ orderBy?: Schema$Order[]; /** @@ -1391,21 +1110,15 @@ export namespace firestore_v1 { */ query?: Schema$QueryTarget; /** - * Start listening after a specific `read_time`. The client must know the - * state of matching documents at this time. + * Start listening after a specific `read_time`. The client must know the state of matching documents at this time. */ readTime?: string; /** - * A resume token from a prior TargetChange for an identical target. Using - * a resume token with a different target is unsupported and may fail. + * A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail. */ resumeToken?: string; /** - * A client provided target ID. If not set, the server will assign an ID - * for the target. Used for resuming a target without changing IDs. The IDs - * can either be client-assigned or be server-assigned in a previous stream. - * All targets with client provided IDs must be added before adding a target - * that needs a server-assigned id. + * A client provided target ID. If not set, the server will assign an ID for the target. Used for resuming a target without changing IDs. The IDs can either be client-assigned or be server-assigned in a previous stream. All targets with client provided IDs must be added before adding a target that needs a server-assigned id. */ targetId?: number; } @@ -1418,18 +1131,11 @@ export namespace firestore_v1 { */ cause?: Schema$Status; /** - * The consistent `read_time` for the given `target_ids` (omitted when the - * target_ids are not at a consistent snapshot). The stream is guaranteed - * to send a `read_time` with `target_ids` empty whenever the entire stream - * reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are - * guaranteed to (eventually) result in a new consistent snapshot (while - * NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` - * is guaranteed to be monotonically increasing. + * The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a `read_time` with `target_ids` empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` is guaranteed to be monotonically increasing. */ readTime?: string; /** - * A token that can be used to resume the stream for the given `target_ids`, - * or all targets if `target_ids` is empty. Not set on every target change. + * A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change. */ resumeToken?: string; /** @@ -1437,12 +1143,7 @@ export namespace firestore_v1 { */ targetChangeType?: string; /** - * The target IDs of targets that have changed. If empty, the change - * applies to all targets. For `target_change_type=ADD`, the order of the - * target IDs matches the order of the requests to add the targets. This - * allows clients to unambiguously associate server-assigned target IDs with - * added targets. For other states, the order of the target IDs is not - * defined. + * The target IDs of targets that have changed. If empty, the change applies to all targets. For `target_change_type=ADD`, the order of the target IDs matches the order of the requests to add the targets. This allows clients to unambiguously associate server-assigned target IDs with added targets. For other states, the order of the target IDs is not defined. */ targetIds?: number[]; } @@ -1477,8 +1178,7 @@ export namespace firestore_v1 { */ export interface Schema$Value { /** - * An array value. Cannot directly contain another array value, though can - * contain an map which contains another array. + * An array value. Cannot directly contain another array value, though can contain an map which contains another array. */ arrayValue?: Schema$ArrayValue; /** @@ -1486,8 +1186,7 @@ export namespace firestore_v1 { */ booleanValue?: boolean; /** - * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 - * bytes are considered by queries. + * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. */ bytesValue?: string; /** @@ -1511,19 +1210,15 @@ export namespace firestore_v1 { */ nullValue?: string; /** - * A reference to a document. For example: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ referenceValue?: string; /** - * A string value. The string, represented as UTF-8, must not exceed 1 MiB - * - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are - * considered by queries. + * A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. */ stringValue?: string; /** - * A timestamp value. Precise only to microseconds. When stored, any - * additional precision is rounded down. + * A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. */ timestampValue?: string; } @@ -1532,19 +1227,15 @@ export namespace firestore_v1 { */ export interface Schema$Write { /** - * An optional precondition on the document. The write will fail if this is - * set and not met by the target document. + * An optional precondition on the document. The write will fail if this is set and not met by the target document. */ currentDocument?: Schema$Precondition; /** - * A document name to delete. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * A document name to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ delete?: string; /** - * Applies a transformation to a document. At most one `transform` per - * document is allowed in a given request. An `update` cannot follow a - * `transform` on the same document in a given request. + * Applies a transformation to a document. At most one `transform` per document is allowed in a given request. An `update` cannot follow a `transform` on the same document in a given request. */ transform?: Schema$DocumentTransform; /** @@ -1552,23 +1243,12 @@ export namespace firestore_v1 { */ update?: Schema$Document; /** - * The fields to update in this write. This field can be set only when the - * operation is `update`. If the mask is not set for an `update` and the - * document exists, any existing data will be overwritten. If the mask is - * set and the document on the server has fields not covered by the mask, - * they are left unchanged. Fields referenced in the mask, but not present - * in the input document, are deleted from the document on the server. The - * field paths in this mask must not contain a reserved field name. + * The fields to update in this write. This field can be set only when the operation is `update`. If the mask is not set for an `update` and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name. */ updateMask?: Schema$DocumentMask; } /** - * The request for Firestore.Write. The first request creates a stream, or - * resumes an existing one from a token. When creating a new stream, the - * server replies with a response containing only an ID and a token, to use in - * the next request. When resuming a stream, the server first streams any - * responses later than the given token, then a response containing only an - * up-to-date token, to use in the next request. + * The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request. */ export interface Schema$WriteRequest { /** @@ -1576,25 +1256,15 @@ export namespace firestore_v1 { */ labels?: {[key: string]: string}; /** - * The ID of the write stream to resume. This may only be set in the first - * message. When left empty, a new write stream will be created. + * The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */ streamId?: string; /** - * A stream token that was previously sent by the server. The client should - * set this field to the token from the most recent WriteResponse it has - * received. This acknowledges that the client has received responses up to - * this token. After sending this token, earlier tokens may not be used - * anymore. The server may close the stream if there are too many - * unacknowledged responses. Leave this field unset when creating a new - * stream. To resume a stream at a specific point, set this field and the - * `stream_id` field. Leave this field unset when creating a new stream. + * A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. */ streamToken?: string; /** - * The writes to apply. Always executed atomically and in order. This must - * be empty on the first request. This may be empty on the last request. - * This must not be empty on all other requests. + * The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. */ writes?: Schema$Write[]; } @@ -1607,19 +1277,15 @@ export namespace firestore_v1 { */ commitTime?: string; /** - * The ID of the stream. Only set on the first message, when a new stream - * was created. + * The ID of the stream. Only set on the first message, when a new stream was created. */ streamId?: string; /** - * A token that represents the position of this response in the stream. This - * can be used by a client to resume the stream at this point. This field - * is always set. + * A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set. */ streamToken?: string; /** - * The result of applying the writes. This i-th write result corresponds to - * the i-th write in the request. + * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ writeResults?: Schema$WriteResult[]; } @@ -1628,14 +1294,11 @@ export namespace firestore_v1 { */ export interface Schema$WriteResult { /** - * The results of applying each DocumentTransform.FieldTransform, in the - * same order. + * The results of applying each DocumentTransform.FieldTransform, in the same order. */ transformResults?: Schema$Value[]; /** - * The last update time of the document after applying the write. Not set - * after a `delete`. If the write did not actually change the document, - * this will be the previous update_time. + * The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. */ updateTime?: string; } @@ -1669,14 +1332,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.exportDocuments - * @desc Exports a copy of all or a subset of documents from Google Cloud - * Firestore to another storage system, such as Google Cloud Storage. Recent - * updates to documents may not be reflected in the export. The export - * occurs in the background and its progress can be monitored and managed - * via the Operation resource that is created. The output of an export may - * only be used once the associated operation is done. If an export - * operation is cancelled before completion it may leave partial data behind - * in Google Cloud Storage. + * @desc Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. * @alias firestore.projects.databases.exportDocuments * @memberOf! () * @@ -1758,12 +1414,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.importDocuments - * @desc Imports documents into Google Cloud Firestore. Existing documents - * with the same name are overwritten. The import occurs in the background - * and its progress can be monitored and managed via the Operation resource - * that is created. If an ImportDocuments operation is cancelled, it is - * possible that a subset of the data has already been imported to Cloud - * Firestore. + * @desc Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore. * @alias firestore.projects.databases.importDocuments * @memberOf! () * @@ -1852,8 +1503,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to export. Should be of the form: - * `projects/{project_id}/databases/{database_id}`. + * Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -1870,8 +1520,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to import into. Should be of the form: - * `projects/{project_id}/databases/{database_id}`. + * Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -1982,11 +1631,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.collectionGroups.fields.list - * @desc Lists the field configuration and metadata for this database. - * Currently, FirestoreAdmin.ListFields only supports listing fields that - * have been explicitly overridden. To issue this query, call - * FirestoreAdmin.ListFields with the filter set to - * `indexConfig.usesAncestorConfig:false`. + * @desc Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`. * @alias firestore.projects.databases.collectionGroups.fields.list * @memberOf! () * @@ -2080,16 +1725,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.collectionGroups.fields.patch - * @desc Updates a field configuration. Currently, field updates apply only - * to single field index configuration. However, calls to - * FirestoreAdmin.UpdateField should provide a field mask to avoid changing - * any configuration that the caller isn't aware of. The field mask should - * be specified as: `{ paths: "index_config" }`. This call returns a - * google.longrunning.Operation which may be used to track the status of the - * field update. The metadata for the operation will be the type - * FieldOperationMetadata. To configure the default field settings for the - * database, use the special `Field` with resource name: - * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x`. + * @desc Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x`. * @alias firestore.projects.databases.collectionGroups.fields.patch * @memberOf! () * @@ -2176,8 +1812,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` + * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` */ name?: string; } @@ -2189,10 +1824,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter to apply to list results. Currently, FirestoreAdmin.ListFields - * only supports listing fields that have been explicitly overridden. To - * issue this query, call FirestoreAdmin.ListFields with the filter set to - * `indexConfig.usesAncestorConfig:false`. + * The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`. */ filter?: string; /** @@ -2200,13 +1832,11 @@ export namespace firestore_v1 { */ pageSize?: number; /** - * A page token, returned from a previous call to FirestoreAdmin.ListFields, - * that may be used to get the next page of results. + * A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. */ pageToken?: string; /** - * A parent name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; } @@ -2218,30 +1848,11 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A field name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` - * A field path may be a simple field name, e.g. `address` or a path to - * fields within map_value , e.g. `address.city`, or a special field path. - * The only valid special field is `*`, which represents any field. Field - * paths may be quoted using ` (backtick). The only character that needs to - * be escaped within a quoted field path is the backtick character itself, - * escaped using a backslash. Special characters in field paths that must be - * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii - * symbolic characters. Examples: (Note: Comments here are written in - * markdown syntax, so there is an additional layer of backticks to - * represent a code block) `\`address.city\`` represents a field named - * `address.city`, not the map key `city` in the field `address`. `\`*\`` - * represents a field named `*`, not any field. A special `Field` contains - * the default indexing settings for all fields. This field's resource name - * is: - * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` - * Indexes defined on this `Field` will be applied to all fields which do - * not have their own `Field` index configuration. + * A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */ name?: string; /** - * A mask, relative to the field. If specified, only configuration specified - * by this field_mask will be updated in the field. + * A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. */ updateMask?: string; @@ -2259,10 +1870,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.collectionGroups.indexes.create - * @desc Creates a composite index. This returns a - * google.longrunning.Operation which may be used to track the status of the - * creation. The metadata for the operation will be the type - * IndexOperationMetadata. + * @desc Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. * @alias firestore.projects.databases.collectionGroups.indexes.create * @memberOf! () * @@ -2598,8 +2206,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A parent name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; @@ -2616,8 +2223,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ name?: string; } @@ -2629,8 +2235,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ name?: string; } @@ -2650,14 +2255,11 @@ export namespace firestore_v1 { */ pageSize?: number; /** - * A page token, returned from a previous call to - * FirestoreAdmin.ListIndexes, that may be used to get the next page of - * results. + * A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results. */ pageToken?: string; /** - * A parent name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; } @@ -2670,8 +2272,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.documents.batchGet - * @desc Gets multiple documents. Documents returned by this method are not - * guaranteed to be returned in the same order that they were requested. + * @desc Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. * @alias firestore.projects.databases.documents.batchGet * @memberOf! () * @@ -3670,8 +3271,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3688,8 +3288,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3706,8 +3305,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3724,24 +3322,19 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: - * `chatrooms`. + * The collection ID, relative to `parent`, to list. For example: `chatrooms`. */ collectionId?: string; /** - * The client-assigned document ID to use for this document. Optional. If - * not specified, an ID will be assigned by the service. + * The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. */ documentId?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** - * The parent resource. For example: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` + * The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` */ parent?: string; @@ -3758,18 +3351,15 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When set to `true`, the target document must exist. When set to `false`, - * the target document must not exist. + * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ 'currentDocument.exists'?: boolean; /** - * When set, the target document must exist and have been last updated at - * that time. + * When set, the target document must exist and have been last updated at that time. */ 'currentDocument.updateTime'?: string; /** - * The resource name of the Document to delete. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; } @@ -3781,18 +3371,15 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** - * The resource name of the Document to get. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** - * Reads the version of the document at the given time. This may not be - * older than 60 seconds. + * Reads the version of the document at the given time. This may not be older than 60 seconds. */ readTime?: string; /** @@ -3808,13 +3395,11 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: - * `chatrooms` or `messages`. + * The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. */ collectionId?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** @@ -3826,29 +3411,19 @@ export namespace firestore_v1 { */ pageSize?: number; /** - * The `next_page_token` value returned from a previous List request, if - * any. + * The `next_page_token` value returned from a previous List request, if any. */ pageToken?: string; /** - * The parent resource name. In the format: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: `projects/my-project/databases/my-database/documents` or - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; /** - * Reads documents as they were at the given time. This may not be older - * than 60 seconds. + * Reads documents as they were at the given time. This may not be older than 60 seconds. */ readTime?: string; /** - * If the list should show missing documents. A missing document is a - * document that does not exist but has sub-documents. These documents will - * be returned with a key but will not have fields, Document.create_time, or - * Document.update_time set. Requests with `show_missing` may not specify - * `where` or `order_by`. + * If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`. */ showMissing?: boolean; /** @@ -3864,10 +3439,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent document. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -3884,8 +3456,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3902,28 +3473,23 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When set to `true`, the target document must exist. When set to `false`, - * the target document must not exist. + * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ 'currentDocument.exists'?: boolean; /** - * When set, the target document must exist and have been last updated at - * that time. + * When set, the target document must exist and have been last updated at that time. */ 'currentDocument.updateTime'?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** - * The resource name of the document, for example - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'updateMask.fieldPaths'?: string[]; @@ -3940,8 +3506,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3958,11 +3523,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name. In the format: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: `projects/my-project/databases/my-database/documents` or - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -3979,9 +3540,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. This is only required in - * the first message. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */ database?: string; @@ -3999,15 +3558,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias firestore.projects.databases.operations.cancel * @memberOf! () * @@ -4077,10 +3628,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias firestore.projects.databases.operations.delete * @memberOf! () * @@ -4149,9 +3697,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias firestore.projects.databases.operations.get * @memberOf! () * @@ -4229,15 +3775,7 @@ export namespace firestore_v1 { /** * firestore.projects.databases.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias firestore.projects.databases.operations.list * @memberOf! () * diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 0a52440bbbc..73657e448eb 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace firestore_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace firestore_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace firestore_v1beta1 { /** * Cloud Firestore API * - * Accesses the NoSQL document database built for automatic scaling, high - * performance, and ease of application development. + * Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace firestore_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -133,27 +131,19 @@ export namespace firestore_v1beta1 { */ export interface Schema$BatchGetDocumentsRequest { /** - * The names of the documents to retrieve. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * The request will fail if any of the document is not a child resource of - * the given `database`. Duplicate names will be elided. + * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ documents?: string[]; /** - * The fields to return. If not set, returns all fields. If a document has - * a field that is not present in this mask, that field will not be returned - * in the response. + * The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. */ mask?: Schema$DocumentMask; /** - * Starts a new transaction and reads the documents. Defaults to a read-only - * transaction. The new transaction ID will be returned as the first - * response in the stream. + * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ newTransaction?: Schema$TransactionOptions; /** - * Reads documents as they were at the given time. This may not be older - * than 60 seconds. + * Reads documents as they were at the given time. This may not be older than 60 seconds. */ readTime?: string; /** @@ -170,20 +160,15 @@ export namespace firestore_v1beta1 { */ found?: Schema$Document; /** - * A document name that was requested but does not exist. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * A document name that was requested but does not exist. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ missing?: string; /** - * The time at which the document was read. This may be monotically - * increasing, in this case the previous documents in the result stream are - * guaranteed not to have changed between their read_time and this one. + * The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. */ readTime?: string; /** - * The transaction that was started as part of this request. Will only be - * set in the first response, and only if - * BatchGetDocumentsRequest.new_transaction was set in the request. + * The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request. */ transaction?: string; } @@ -210,9 +195,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$CollectionSelector { /** - * When false, selects only collections that are immediate children of the - * `parent` specified in the containing `RunQueryRequest`. When true, - * selects all descendant collections. + * When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections. */ allDescendants?: boolean; /** @@ -242,8 +225,7 @@ export namespace firestore_v1beta1 { */ commitTime?: string; /** - * The result of applying the writes. This i-th write result corresponds to - * the i-th write in the request. + * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ writeResults?: Schema$WriteResult[]; } @@ -265,14 +247,11 @@ export namespace firestore_v1beta1 { */ export interface Schema$Cursor { /** - * If the position is just before or just after the given values, relative - * to the sort order defined by the query. + * If the position is just before or just after the given values, relative to the sort order defined by the query. */ before?: boolean; /** - * The values that represent a position, in the order they appear in the - * order by clause of a query. Can contain fewer values than specified in - * the order by clause. + * The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. */ values?: Schema$Value[]; } @@ -281,54 +260,28 @@ export namespace firestore_v1beta1 { */ export interface Schema$Document { /** - * Output only. The time at which the document was created. This value - * increases monotonically when a document is deleted then recreated. It can - * also be compared to values from other documents and the `read_time` of a - * query. + * Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. */ createTime?: string; /** - * The document's fields. The map keys represent field names. A simple - * field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, - * or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. - * Field names matching the regular expression `__.*__` are reserved. - * Reserved field names are forbidden except in certain documented contexts. - * The map keys, represented as UTF-8, must not exceed 1,500 bytes and - * cannot be empty. Field paths may be used in other contexts to refer to - * structured fields defined here. For `map_value`, the field path is - * represented by the simple or quoted field names of the containing fields, - * delimited by `.`. For example, the structured field `"foo" : { - * map_value: { "x&y" : { string_value: "hello" }}}` - * would be represented by the field path `foo.x&y`. Within a field - * path, a quoted field name starts and ends with `` ` `` and may contain - * any character. Some characters, including `` ` ``, must be escaped using - * a `\`. For example, `` `x&y` `` represents `x&y` and `` - * `bak\`tik` `` represents `` bak`tik ``. + * The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. */ fields?: {[key: string]: Schema$Value}; /** - * The resource name of the document, for example - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** - * Output only. The time at which the document was last changed. This value - * is initially set to the `create_time` then increases monotonically with - * each change to the document. It can also be compared to values from other - * documents and the `read_time` of a query. + * Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. */ updateTime?: string; } /** - * A Document has changed. May be the result of multiple writes, including - * deletes, that ultimately resulted in a new value for the Document. Multiple - * DocumentChange messages may be returned for the same logical change, if - * multiple targets are affected. + * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. */ export interface Schema$DocumentChange { /** - * The new state of the Document. If `mask` is set, contains only fields - * that were updated or added. + * The new state of the Document. If `mask` is set, contains only fields that were updated or added. */ document?: Schema$Document; /** @@ -341,10 +294,7 @@ export namespace firestore_v1beta1 { targetIds?: number[]; } /** - * A Document has been deleted. May be the result of multiple writes, - * including updates, the last of which deleted the Document. Multiple - * DocumentDelete messages may be returned for the same logical delete, if - * multiple targets are affected. + * A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected. */ export interface Schema$DocumentDelete { /** @@ -352,8 +302,7 @@ export namespace firestore_v1beta1 { */ document?: string; /** - * The read timestamp at which the delete was observed. Greater or equal to - * the `commit_time` of the delete. + * The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete. */ readTime?: string; /** @@ -362,25 +311,16 @@ export namespace firestore_v1beta1 { removedTargetIds?: number[]; } /** - * A set of field paths on a document. Used to restrict a get or update - * operation on a document to a subset of its fields. This is different from - * standard field masks, as this is always scoped to a Document, and takes in - * account the dynamic nature of Value. + * A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value. */ export interface Schema$DocumentMask { /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ fieldPaths?: string[]; } /** - * A Document has been removed from the view of the targets. Sent if the - * document is no longer relevant to a target and is out of view. Can be sent - * instead of a DocumentDelete or a DocumentChange if the server can not send - * the new value of the document. Multiple DocumentRemove messages may be - * returned for the same logical write or delete, if multiple targets are - * affected. + * A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected. */ export interface Schema$DocumentRemove { /** @@ -388,8 +328,7 @@ export namespace firestore_v1beta1 { */ document?: string; /** - * The read timestamp at which the remove was observed. Greater or equal to - * the `commit_time` of the change/delete/remove. + * The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove. */ readTime?: string; /** @@ -402,10 +341,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$DocumentsTarget { /** - * The names of the documents to retrieve. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * The request will fail if any of the document is not a child resource of - * the given `database`. Duplicate names will be elided. + * The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided. */ documents?: string[]; } @@ -418,17 +354,12 @@ export namespace firestore_v1beta1 { */ document?: string; /** - * The list of transformations to apply to the fields of the document, in - * order. This must not be empty. + * The list of transformations to apply to the fields of the document, in order. This must not be empty. */ fieldTransforms?: Schema$FieldTransform[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -436,9 +367,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$ExistenceFilter { /** - * The total count of documents that match target_id. If different from the - * count of documents in the client that match, the client must manually - * determine which documents no longer match the target. + * The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target. */ count?: number; /** @@ -474,65 +403,27 @@ export namespace firestore_v1beta1 { */ export interface Schema$FieldTransform { /** - * Append the given elements in order if they are not already present in the - * current field value. If the field is not an array, or if the field does - * not yet exist, it is first set to the empty array. Equivalent numbers of - * different types (e.g. 3L and 3.0) are considered equal when checking if a - * value is missing. NaN is equal to NaN, and Null is equal to Null. If the - * input contains multiple equivalent values, only the first will be - * considered. The corresponding transform_result will be the null value. + * Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. */ appendMissingElements?: Schema$ArrayValue; /** - * The path of the field. See Document.fields for the field path syntax - * reference. + * The path of the field. See Document.fields for the field path syntax reference. */ fieldPath?: string; /** - * Adds the given value to the field's current value. This must be an - * integer or a double value. If the field is not an integer or double, or - * if the field does not yet exist, the transformation will set the field to - * the given value. If either of the given value or the current field value - * are doubles, both values will be interpreted as doubles. Double - * arithmetic and representation of double values follow IEEE 754 semantics. - * If there is positive/negative integer overflow, the field is resolved to - * the largest magnitude positive/negative integer. + * Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. */ increment?: Schema$Value; /** - * Sets the field to the maximum of its current value and the given value. - * This must be an integer or a double value. If the field is not an integer - * or double, or if the field does not yet exist, the transformation will - * set the field to the given value. If a maximum operation is applied where - * the field and the input value are of mixed types (that is - one is an - * integer and one is a double) the field takes on the type of the larger - * operand. If the operands are equivalent (e.g. 3 and 3.0), the field does - * not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored - * value and zero input value is always the stored value. The maximum of any - * numeric value x and NaN is NaN. + * Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. */ maximum?: Schema$Value; /** - * Sets the field to the minimum of its current value and the given value. - * This must be an integer or a double value. If the field is not an integer - * or double, or if the field does not yet exist, the transformation will - * set the field to the input value. If a minimum operation is applied where - * the field and the input value are of mixed types (that is - one is an - * integer and one is a double) the field takes on the type of the smaller - * operand. If the operands are equivalent (e.g. 3 and 3.0), the field does - * not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored - * value and zero input value is always the stored value. The minimum of any - * numeric value x and NaN is NaN. + * Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. */ minimum?: Schema$Value; /** - * Remove all of the given elements from the array in the field. If the - * field is not an array, or if the field does not yet exist, it is set to - * the empty array. Equivalent numbers of the different types (e.g. 3L - * and 3.0) are considered equal when deciding whether an element should be - * removed. NaN is equal to NaN, and Null is equal to Null. This will remove - * all equivalent values if there are duplicates. The corresponding - * transform_result will be the null value. + * Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. */ removeAllFromArray?: Schema$ArrayValue; /** @@ -566,8 +457,7 @@ export namespace firestore_v1beta1 { */ collectionIds?: string[]; /** - * The time the operation ended, either successfully or otherwise. Unset if - * the operation is still active. + * The time the operation ended, either successfully or otherwise. Unset if the operation is still active. */ endTime?: string; /** @@ -600,14 +490,7 @@ export namespace firestore_v1beta1 { */ collectionIds?: string[]; /** - * The output URI. Currently only supports Google Cloud Storage URIs of the - * form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the - * name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an - * optional Google Cloud Storage namespace path. When choosing a name, be - * sure to consider Google Cloud Storage naming guidelines: - * https://cloud.google.com/storage/docs/naming. If the URI is a bucket - * (without a namespace path), a prefix will be generated based on the start - * time. + * The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. */ outputUriPrefix?: string; } @@ -616,9 +499,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsResponse { /** - * Location of the output files. This can be used to begin an import into - * Cloud Firestore (this project or another project) after the operation - * completes successfully. + * Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully. */ outputUriPrefix?: string; } @@ -631,8 +512,7 @@ export namespace firestore_v1beta1 { */ collectionIds?: string[]; /** - * The time the operation ended, either successfully or otherwise. Unset if - * the operation is still active. + * The time the operation ended, either successfully or otherwise. Unset if the operation is still active. */ endTime?: string; /** @@ -661,15 +541,11 @@ export namespace firestore_v1beta1 { */ export interface Schema$GoogleFirestoreAdminV1beta1ImportDocumentsRequest { /** - * Which collection ids to import. Unspecified means all collections - * included in the import. + * Which collection ids to import. Unspecified means all collections included in the import. */ collectionIds?: string[]; /** - * Location of the exported files. This must match the output_uri_prefix of - * an ExportDocumentsResponse from an export that has completed - * successfully. See: - * google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix. + * Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix. */ inputUriPrefix?: string; } @@ -699,10 +575,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$GoogleFirestoreAdminV1beta1IndexField { /** - * The path of the field. Must match the field path specification described - * by google.firestore.v1beta1.Document.fields. Special field path - * `__name__` may be used by itself or at the end of a path. `__type__` may - * be used only at the end of path. + * The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path. */ fieldPath?: string; /** @@ -711,14 +584,11 @@ export namespace firestore_v1beta1 { mode?: string; } /** - * Metadata for index operations. This metadata populates the metadata field - * of google.longrunning.Operation. + * Metadata for index operations. This metadata populates the metadata field of google.longrunning.Operation. */ export interface Schema$GoogleFirestoreAdminV1beta1IndexOperationMetadata { /** - * True if the [google.longrunning.Operation] was cancelled. If the - * cancellation is in progress, cancelled will be true but - * google.longrunning.Operation.done will be false. + * True if the [google.longrunning.Operation] was cancelled. If the cancellation is in progress, cancelled will be true but google.longrunning.Operation.done will be false. */ cancelled?: boolean; /** @@ -726,13 +596,11 @@ export namespace firestore_v1beta1 { */ documentProgress?: Schema$GoogleFirestoreAdminV1beta1Progress; /** - * The time the operation ended, either successfully or otherwise. Unset if - * the operation is still active. + * The time the operation ended, either successfully or otherwise. Unset if the operation is still active. */ endTime?: string; /** - * The index resource that this operation is acting on. For example: - * `projects/{project_id}/databases/{database_id}/indexes/{index_id}` + * The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}` */ index?: string; /** @@ -766,25 +634,20 @@ export namespace firestore_v1beta1 { */ export interface Schema$GoogleFirestoreAdminV1beta1Progress { /** - * An estimate of how much work has been completed. Note that this may be - * greater than `work_estimated`. + * An estimate of how much work has been completed. Note that this may be greater than `work_estimated`. */ workCompleted?: string; /** - * An estimate of how much work needs to be performed. Zero if the work - * estimate is unavailable. May change as work progresses. + * An estimate of how much work needs to be performed. Zero if the work estimate is unavailable. May change as work progresses. */ workEstimated?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -792,35 +655,20 @@ export namespace firestore_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -901,14 +749,11 @@ export namespace firestore_v1beta1 { */ documentDelete?: Schema$DocumentDelete; /** - * A Document has been removed from a target (because it is no longer - * relevant to that target). + * A Document has been removed from a target (because it is no longer relevant to that target). */ documentRemove?: Schema$DocumentRemove; /** - * A filter to apply to the set of documents previously returned for the - * given target. Returned when documents may have been removed from the - * given target, but the exact documents are unknown. + * A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown. */ filter?: Schema$ExistenceFilter; /** @@ -921,10 +766,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$MapValue { /** - * The map's fields. The map keys represent field names. Field names - * matching the regular expression `__.*__` are reserved. Reserved field - * names are forbidden except in certain documented contexts. The map keys, - * represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + * The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. */ fields?: {[key: string]: Schema$Value}; } @@ -946,13 +788,11 @@ export namespace firestore_v1beta1 { */ export interface Schema$Precondition { /** - * When set to `true`, the target document must exist. When set to `false`, - * the target document must not exist. + * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ exists?: boolean; /** - * When set, the target document must exist and have been last updated at - * that time. + * When set, the target document must exist and have been last updated at that time. */ updateTime?: string; } @@ -961,8 +801,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$Projection { /** - * The fields to return. If empty, all fields are returned. To only return - * the name of the document, use `['__name__']`. + * The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`. */ fields?: Schema$FieldReference[]; } @@ -971,11 +810,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$QueryTarget { /** - * The parent resource name. In the format: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: `projects/my-project/databases/my-database/documents` or - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; /** @@ -1015,14 +850,11 @@ export namespace firestore_v1beta1 { */ export interface Schema$RunQueryRequest { /** - * Starts a new transaction and reads the documents. Defaults to a read-only - * transaction. The new transaction ID will be returned as the first - * response in the stream. + * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ newTransaction?: Schema$TransactionOptions; /** - * Reads documents as they were at the given time. This may not be older - * than 60 seconds. + * Reads documents as they were at the given time. This may not be older than 60 seconds. */ readTime?: string; /** @@ -1043,61 +875,20 @@ export namespace firestore_v1beta1 { */ document?: Schema$Document; /** - * The time at which the document was read. This may be monotonically - * increasing; in this case, the previous documents in the result stream are - * guaranteed not to have changed between their `read_time` and this one. If - * the query returns no results, a response with `read_time` and no - * `document` will be sent, and this represents the time at which the query - * was run. + * The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run. */ readTime?: string; /** - * The number of results that have been skipped due to an offset between the - * last response and the current response. + * The number of results that have been skipped due to an offset between the last response and the current response. */ skippedResults?: number; /** - * The transaction that was started as part of this request. Can only be set - * in the first response, and only if RunQueryRequest.new_transaction was - * set in the request. If set, no other fields will be set in this response. + * The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response. */ transaction?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1105,14 +896,11 @@ export namespace firestore_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1129,27 +917,15 @@ export namespace firestore_v1beta1 { */ from?: Schema$CollectionSelector[]; /** - * The maximum number of results to return. Applies after all other - * constraints. Must be >= 0 if specified. + * The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified. */ limit?: number; /** - * The number of results to skip. Applies before limit, but after all other - * constraints. Must be >= 0 if specified. + * The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified. */ offset?: number; /** - * The order to apply to the query results. Firestore guarantees a stable - * ordering through the following rules: * Any field required to appear in - * `order_by`, that is not already specified in `order_by`, is appended - * to the order in field name order by default. * If an order on - * `__name__` is not specified, it is appended by default. Fields are - * appended with the same sort direction as the last order specified, or - * 'ASCENDING' if no order was specified. For example: * `SELECT * - * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` - * * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER - * BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes - * `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` + * The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` */ orderBy?: Schema$Order[]; /** @@ -1182,21 +958,15 @@ export namespace firestore_v1beta1 { */ query?: Schema$QueryTarget; /** - * Start listening after a specific `read_time`. The client must know the - * state of matching documents at this time. + * Start listening after a specific `read_time`. The client must know the state of matching documents at this time. */ readTime?: string; /** - * A resume token from a prior TargetChange for an identical target. Using - * a resume token with a different target is unsupported and may fail. + * A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail. */ resumeToken?: string; /** - * A client provided target ID. If not set, the server will assign an ID - * for the target. Used for resuming a target without changing IDs. The IDs - * can either be client-assigned or be server-assigned in a previous stream. - * All targets with client provided IDs must be added before adding a target - * that needs a server-assigned id. + * A client provided target ID. If not set, the server will assign an ID for the target. Used for resuming a target without changing IDs. The IDs can either be client-assigned or be server-assigned in a previous stream. All targets with client provided IDs must be added before adding a target that needs a server-assigned id. */ targetId?: number; } @@ -1209,18 +979,11 @@ export namespace firestore_v1beta1 { */ cause?: Schema$Status; /** - * The consistent `read_time` for the given `target_ids` (omitted when the - * target_ids are not at a consistent snapshot). The stream is guaranteed - * to send a `read_time` with `target_ids` empty whenever the entire stream - * reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are - * guaranteed to (eventually) result in a new consistent snapshot (while - * NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` - * is guaranteed to be monotonically increasing. + * The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a `read_time` with `target_ids` empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` is guaranteed to be monotonically increasing. */ readTime?: string; /** - * A token that can be used to resume the stream for the given `target_ids`, - * or all targets if `target_ids` is empty. Not set on every target change. + * A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change. */ resumeToken?: string; /** @@ -1228,12 +991,7 @@ export namespace firestore_v1beta1 { */ targetChangeType?: string; /** - * The target IDs of targets that have changed. If empty, the change - * applies to all targets. For `target_change_type=ADD`, the order of the - * target IDs matches the order of the requests to add the targets. This - * allows clients to unambiguously associate server-assigned target IDs with - * added targets. For other states, the order of the target IDs is not - * defined. + * The target IDs of targets that have changed. If empty, the change applies to all targets. For `target_change_type=ADD`, the order of the target IDs matches the order of the requests to add the targets. This allows clients to unambiguously associate server-assigned target IDs with added targets. For other states, the order of the target IDs is not defined. */ targetIds?: number[]; } @@ -1268,8 +1026,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$Value { /** - * An array value. Cannot directly contain another array value, though can - * contain an map which contains another array. + * An array value. Cannot directly contain another array value, though can contain an map which contains another array. */ arrayValue?: Schema$ArrayValue; /** @@ -1277,8 +1034,7 @@ export namespace firestore_v1beta1 { */ booleanValue?: boolean; /** - * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 - * bytes are considered by queries. + * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. */ bytesValue?: string; /** @@ -1302,19 +1058,15 @@ export namespace firestore_v1beta1 { */ nullValue?: string; /** - * A reference to a document. For example: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ referenceValue?: string; /** - * A string value. The string, represented as UTF-8, must not exceed 1 MiB - * - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are - * considered by queries. + * A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. */ stringValue?: string; /** - * A timestamp value. Precise only to microseconds. When stored, any - * additional precision is rounded down. + * A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. */ timestampValue?: string; } @@ -1323,19 +1075,15 @@ export namespace firestore_v1beta1 { */ export interface Schema$Write { /** - * An optional precondition on the document. The write will fail if this is - * set and not met by the target document. + * An optional precondition on the document. The write will fail if this is set and not met by the target document. */ currentDocument?: Schema$Precondition; /** - * A document name to delete. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * A document name to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ delete?: string; /** - * Applies a transformation to a document. At most one `transform` per - * document is allowed in a given request. An `update` cannot follow a - * `transform` on the same document in a given request. + * Applies a transformation to a document. At most one `transform` per document is allowed in a given request. An `update` cannot follow a `transform` on the same document in a given request. */ transform?: Schema$DocumentTransform; /** @@ -1343,23 +1091,12 @@ export namespace firestore_v1beta1 { */ update?: Schema$Document; /** - * The fields to update in this write. This field can be set only when the - * operation is `update`. If the mask is not set for an `update` and the - * document exists, any existing data will be overwritten. If the mask is - * set and the document on the server has fields not covered by the mask, - * they are left unchanged. Fields referenced in the mask, but not present - * in the input document, are deleted from the document on the server. The - * field paths in this mask must not contain a reserved field name. + * The fields to update in this write. This field can be set only when the operation is `update`. If the mask is not set for an `update` and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name. */ updateMask?: Schema$DocumentMask; } /** - * The request for Firestore.Write. The first request creates a stream, or - * resumes an existing one from a token. When creating a new stream, the - * server replies with a response containing only an ID and a token, to use in - * the next request. When resuming a stream, the server first streams any - * responses later than the given token, then a response containing only an - * up-to-date token, to use in the next request. + * The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request. */ export interface Schema$WriteRequest { /** @@ -1367,25 +1104,15 @@ export namespace firestore_v1beta1 { */ labels?: {[key: string]: string}; /** - * The ID of the write stream to resume. This may only be set in the first - * message. When left empty, a new write stream will be created. + * The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */ streamId?: string; /** - * A stream token that was previously sent by the server. The client should - * set this field to the token from the most recent WriteResponse it has - * received. This acknowledges that the client has received responses up to - * this token. After sending this token, earlier tokens may not be used - * anymore. The server may close the stream if there are too many - * unacknowledged responses. Leave this field unset when creating a new - * stream. To resume a stream at a specific point, set this field and the - * `stream_id` field. Leave this field unset when creating a new stream. + * A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. */ streamToken?: string; /** - * The writes to apply. Always executed atomically and in order. This must - * be empty on the first request. This may be empty on the last request. - * This must not be empty on all other requests. + * The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. */ writes?: Schema$Write[]; } @@ -1398,19 +1125,15 @@ export namespace firestore_v1beta1 { */ commitTime?: string; /** - * The ID of the stream. Only set on the first message, when a new stream - * was created. + * The ID of the stream. Only set on the first message, when a new stream was created. */ streamId?: string; /** - * A token that represents the position of this response in the stream. This - * can be used by a client to resume the stream at this point. This field - * is always set. + * A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set. */ streamToken?: string; /** - * The result of applying the writes. This i-th write result corresponds to - * the i-th write in the request. + * The result of applying the writes. This i-th write result corresponds to the i-th write in the request. */ writeResults?: Schema$WriteResult[]; } @@ -1419,14 +1142,11 @@ export namespace firestore_v1beta1 { */ export interface Schema$WriteResult { /** - * The results of applying each DocumentTransform.FieldTransform, in the - * same order. + * The results of applying each DocumentTransform.FieldTransform, in the same order. */ transformResults?: Schema$Value[]; /** - * The last update time of the document after applying the write. Not set - * after a `delete`. If the write did not actually change the document, - * this will be the previous update_time. + * The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. */ updateTime?: string; } @@ -1452,14 +1172,7 @@ export namespace firestore_v1beta1 { /** * firestore.projects.databases.exportDocuments - * @desc Exports a copy of all or a subset of documents from Google Cloud - * Firestore to another storage system, such as Google Cloud Storage. Recent - * updates to documents may not be reflected in the export. The export - * occurs in the background and its progress can be monitored and managed - * via the Operation resource that is created. The output of an export may - * only be used once the associated operation is done. If an export - * operation is cancelled before completion it may leave partial data behind - * in Google Cloud Storage. + * @desc Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. * @alias firestore.projects.databases.exportDocuments * @memberOf! () * @@ -1541,12 +1254,7 @@ export namespace firestore_v1beta1 { /** * firestore.projects.databases.importDocuments - * @desc Imports documents into Google Cloud Firestore. Existing documents - * with the same name are overwritten. The import occurs in the background - * and its progress can be monitored and managed via the Operation resource - * that is created. If an ImportDocuments operation is cancelled, it is - * possible that a subset of the data has already been imported to Cloud - * Firestore. + * @desc Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore. * @alias firestore.projects.databases.importDocuments * @memberOf! () * @@ -1635,8 +1343,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to export. Should be of the form: - * `projects/{project_id}/databases/{database_id}`. + * Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -1653,8 +1360,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to import into. Should be of the form: - * `projects/{project_id}/databases/{database_id}`. + * Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -1672,8 +1378,7 @@ export namespace firestore_v1beta1 { /** * firestore.projects.databases.documents.batchGet - * @desc Gets multiple documents. Documents returned by this method are not - * guaranteed to be returned in the same order that they were requested. + * @desc Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. * @alias firestore.projects.databases.documents.batchGet * @memberOf! () * @@ -2672,8 +2377,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2690,8 +2394,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2708,8 +2411,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2726,24 +2428,19 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: - * `chatrooms`. + * The collection ID, relative to `parent`, to list. For example: `chatrooms`. */ collectionId?: string; /** - * The client-assigned document ID to use for this document. Optional. If - * not specified, an ID will be assigned by the service. + * The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. */ documentId?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** - * The parent resource. For example: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` + * The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` */ parent?: string; @@ -2760,18 +2457,15 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When set to `true`, the target document must exist. When set to `false`, - * the target document must not exist. + * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ 'currentDocument.exists'?: boolean; /** - * When set, the target document must exist and have been last updated at - * that time. + * When set, the target document must exist and have been last updated at that time. */ 'currentDocument.updateTime'?: string; /** - * The resource name of the Document to delete. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; } @@ -2783,18 +2477,15 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** - * The resource name of the Document to get. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** - * Reads the version of the document at the given time. This may not be - * older than 60 seconds. + * Reads the version of the document at the given time. This may not be older than 60 seconds. */ readTime?: string; /** @@ -2810,13 +2501,11 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: - * `chatrooms` or `messages`. + * The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. */ collectionId?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** @@ -2828,29 +2517,19 @@ export namespace firestore_v1beta1 { */ pageSize?: number; /** - * The `next_page_token` value returned from a previous List request, if - * any. + * The `next_page_token` value returned from a previous List request, if any. */ pageToken?: string; /** - * The parent resource name. In the format: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: `projects/my-project/databases/my-database/documents` or - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; /** - * Reads documents as they were at the given time. This may not be older - * than 60 seconds. + * Reads documents as they were at the given time. This may not be older than 60 seconds. */ readTime?: string; /** - * If the list should show missing documents. A missing document is a - * document that does not exist but has sub-documents. These documents will - * be returned with a key but will not have fields, Document.create_time, or - * Document.update_time set. Requests with `show_missing` may not specify - * `where` or `order_by`. + * If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`. */ showMissing?: boolean; /** @@ -2866,10 +2545,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent document. In the format: - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -2886,8 +2562,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2904,28 +2579,23 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When set to `true`, the target document must exist. When set to `false`, - * the target document must not exist. + * When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */ 'currentDocument.exists'?: boolean; /** - * When set, the target document must exist and have been last updated at - * that time. + * When set, the target document must exist and have been last updated at that time. */ 'currentDocument.updateTime'?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'mask.fieldPaths'?: string[]; /** - * The resource name of the document, for example - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** - * The list of field paths in the mask. See Document.fields for a field path - * syntax reference. + * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ 'updateMask.fieldPaths'?: string[]; @@ -2942,8 +2612,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2960,11 +2629,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name. In the format: - * `projects/{project_id}/databases/{database_id}/documents` or - * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - * For example: `projects/my-project/databases/my-database/documents` or - * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -2981,9 +2646,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: - * `projects/{project_id}/databases/{database_id}`. This is only required in - * the first message. + * The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */ database?: string; @@ -3001,15 +2664,7 @@ export namespace firestore_v1beta1 { /** * firestore.projects.databases.indexes.create - * @desc Creates the specified index. A newly created index's initial state - * is `CREATING`. On completion of the returned - * google.longrunning.Operation, the state will be `READY`. If the index - * already exists, the call will return an `ALREADY_EXISTS` status. During - * creation, the process could result in an error, in which case the index - * will move to the `ERROR` state. The process can be recovered by fixing - * the data that caused the error, removing the index with delete, then - * re-creating the index with create. Indexes with a single field cannot be - * created. + * @desc Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created. * @alias firestore.projects.databases.indexes.create * @memberOf! () * @@ -3349,8 +3004,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the database this index will apply to. For example: - * `projects/{project_id}/databases/{database_id}` + * The name of the database this index will apply to. For example: `projects/{project_id}/databases/{database_id}` */ parent?: string; @@ -3367,8 +3021,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The index name. For example: - * `projects/{project_id}/databases/{database_id}/indexes/{index_id}` + * The index name. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}` */ name?: string; } @@ -3380,8 +3033,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the index. For example: - * `projects/{project_id}/databases/{database_id}/indexes/{index_id}` + * The name of the index. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}` */ name?: string; } @@ -3405,8 +3057,7 @@ export namespace firestore_v1beta1 { */ pageToken?: string; /** - * The database name. For example: - * `projects/{project_id}/databases/{database_id}` + * The database name. For example: `projects/{project_id}/databases/{database_id}` */ parent?: string; } diff --git a/src/apis/firestore/v1beta2.ts b/src/apis/firestore/v1beta2.ts index 0b4a3f1b396..a7aa4c9a303 100644 --- a/src/apis/firestore/v1beta2.ts +++ b/src/apis/firestore/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace firestore_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace firestore_v1beta2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace firestore_v1beta2 { /** * Cloud Firestore API * - * Accesses the NoSQL document database built for automatic scaling, high - * performance, and ease of application development. + * Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. * * @example * const {google} = require('googleapis'); @@ -113,23 +108,21 @@ export namespace firestore_v1beta2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.ExportDocuments. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments. */ export interface Schema$GoogleFirestoreAdminV1beta2ExportDocumentsMetadata { /** @@ -137,8 +130,7 @@ export namespace firestore_v1beta2 { */ collectionIds?: string[]; /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** @@ -171,14 +163,7 @@ export namespace firestore_v1beta2 { */ collectionIds?: string[]; /** - * The output URI. Currently only supports Google Cloud Storage URIs of the - * form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the - * name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an - * optional Google Cloud Storage namespace path. When choosing a name, be - * sure to consider Google Cloud Storage naming guidelines: - * https://cloud.google.com/storage/docs/naming. If the URI is a bucket - * (without a namespace path), a prefix will be generated based on the start - * time. + * The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. */ outputUriPrefix?: string; } @@ -187,51 +172,25 @@ export namespace firestore_v1beta2 { */ export interface Schema$GoogleFirestoreAdminV1beta2ExportDocumentsResponse { /** - * Location of the output files. This can be used to begin an import into - * Cloud Firestore (this project or another project) after the operation - * completes successfully. + * Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully. */ outputUriPrefix?: string; } /** - * Represents a single field in the database. Fields are grouped by their - * "Collection Group", which represent all collections in the - * database with the same id. + * Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id. */ export interface Schema$GoogleFirestoreAdminV1beta2Field { /** - * The index configuration for this field. If unset, field indexing will - * revert to the configuration defined by the `ancestor_field`. To - * explicitly remove all indexes for this field, specify an index config - * with an empty list of indexes. + * The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes. */ indexConfig?: Schema$GoogleFirestoreAdminV1beta2IndexConfig; /** - * A field name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` - * A field path may be a simple field name, e.g. `address` or a path to - * fields within map_value , e.g. `address.city`, or a special field path. - * The only valid special field is `*`, which represents any field. Field - * paths may be quoted using ` (backtick). The only character that needs to - * be escaped within a quoted field path is the backtick character itself, - * escaped using a backslash. Special characters in field paths that must be - * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii - * symbolic characters. Examples: (Note: Comments here are written in - * markdown syntax, so there is an additional layer of backticks to - * represent a code block) `\`address.city\`` represents a field named - * `address.city`, not the map key `city` in the field `address`. `\`*\`` - * represents a field named `*`, not any field. A special `Field` contains - * the default indexing settings for all fields. This field's resource - * name is: - * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x - * Indexes defined on this `Field` will be applied to all fields which do - * not have their own `Field` index configuration. + * A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */ name?: string; } /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.UpdateField. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField. */ export interface Schema$GoogleFirestoreAdminV1beta2FieldOperationMetadata { /** @@ -243,13 +202,11 @@ export namespace firestore_v1beta2 { */ documentProgress?: Schema$GoogleFirestoreAdminV1beta2Progress; /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** - * The field resource that this operation is acting on. For example: - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + * The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` */ field?: string; /** @@ -266,8 +223,7 @@ export namespace firestore_v1beta2 { state?: string; } /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.ImportDocuments. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. */ export interface Schema$GoogleFirestoreAdminV1beta2ImportDocumentsMetadata { /** @@ -275,8 +231,7 @@ export namespace firestore_v1beta2 { */ collectionIds?: string[]; /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** @@ -305,49 +260,28 @@ export namespace firestore_v1beta2 { */ export interface Schema$GoogleFirestoreAdminV1beta2ImportDocumentsRequest { /** - * Which collection ids to import. Unspecified means all collections - * included in the import. + * Which collection ids to import. Unspecified means all collections included in the import. */ collectionIds?: string[]; /** - * Location of the exported files. This must match the output_uri_prefix of - * an ExportDocumentsResponse from an export that has completed - * successfully. See: - * google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix. + * Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix. */ inputUriPrefix?: string; } /** - * Cloud Firestore indexes enable simple and complex queries against documents - * in a database. + * Cloud Firestore indexes enable simple and complex queries against documents in a database. */ export interface Schema$GoogleFirestoreAdminV1beta2Index { /** - * The fields supported by this index. For composite indexes, this is - * always 2 or more fields. The last field entry is always for the field - * path `__name__`. If, on creation, `__name__` was not specified as the - * last field, it will be added automatically with the same direction as - * that of the last field defined. If the final field in a composite index - * is not directional, the `__name__` will be ordered ASCENDING (unless - * explicitly specified). For single field indexes, this will always be - * exactly one entry with a field path equal to the field path of the - * associated field. + * The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. */ fields?: Schema$GoogleFirestoreAdminV1beta2IndexField[]; /** - * Output only. A server defined name for this index. The form of this name - * for composite indexes will be: - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` - * For single field indexes, this field will be empty. + * Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. */ name?: string; /** - * Indexes with a collection query scope specified allow queries against a - * collection that is the child of a specific document, specified at query - * time, and that has the same collection id. Indexes with a collection - * group query scope specified allow queries against all collections - * descended from a specific document, specified at query time, and that - * have the same collection id as this index. + * Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. */ queryScope?: string; /** @@ -360,10 +294,7 @@ export namespace firestore_v1beta2 { */ export interface Schema$GoogleFirestoreAdminV1beta2IndexConfig { /** - * Output only. Specifies the resource name of the `Field` from which this - * field's index configuration is set (when `uses_ancestor_config` is - * true), or from which it *would* be set if this field had no index - * configuration (when `uses_ancestor_config` is false). + * Output only. Specifies the resource name of the `Field` from which this field's index configuration is set (when `uses_ancestor_config` is true), or from which it *would* be set if this field had no index configuration (when `uses_ancestor_config` is false). */ ancestorField?: string; /** @@ -371,17 +302,11 @@ export namespace firestore_v1beta2 { */ indexes?: Schema$GoogleFirestoreAdminV1beta2Index[]; /** - * Output only When true, the `Field`'s index configuration is in the - * process of being reverted. Once complete, the index config will - * transition to the same state as the field specified by `ancestor_field`, - * at which point `uses_ancestor_config` will be `true` and `reverting` will - * be `false`. + * Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`. */ reverting?: boolean; /** - * Output only. When true, the `Field`'s index configuration is set from - * the configuration specified by the `ancestor_field`. When false, the - * `Field`'s index configuration is defined explicitly. + * Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. */ usesAncestorConfig?: boolean; } @@ -399,8 +324,7 @@ export namespace firestore_v1beta2 { index?: Schema$GoogleFirestoreAdminV1beta2Index; } /** - * A field in an index. The field_path describes which field is indexed, the - * value_mode describes how the field value is indexed. + * A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. */ export interface Schema$GoogleFirestoreAdminV1beta2IndexField { /** @@ -408,29 +332,24 @@ export namespace firestore_v1beta2 { */ arrayConfig?: string; /** - * Can be __name__. For single field indexes, this must match the name of - * the field or may be omitted. + * Can be __name__. For single field indexes, this must match the name of the field or may be omitted. */ fieldPath?: string; /** - * Indicates that this field supports ordering by the specified order or - * comparing using =, <, <=, >, >=. + * Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. */ order?: string; } /** - * Metadata for google.longrunning.Operation results from - * FirestoreAdmin.CreateIndex. + * Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. */ export interface Schema$GoogleFirestoreAdminV1beta2IndexOperationMetadata { /** - * The time this operation completed. Will be unset if operation still in - * progress. + * The time this operation completed. Will be unset if operation still in progress. */ endTime?: string; /** - * The index resource that this operation is acting on. For example: - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ index?: string; /** @@ -459,8 +378,7 @@ export namespace firestore_v1beta2 { */ fields?: Schema$GoogleFirestoreAdminV1beta2Field[]; /** - * A page token that may be used to request another page of results. If - * blank, this is the last page. + * A page token that may be used to request another page of results. If blank, this is the last page. */ nextPageToken?: string; } @@ -473,14 +391,12 @@ export namespace firestore_v1beta2 { */ indexes?: Schema$GoogleFirestoreAdminV1beta2Index[]; /** - * A page token that may be used to request another page of results. If - * blank, this is the last page. + * A page token that may be used to request another page of results. If blank, this is the last page. */ nextPageToken?: string; } /** - * Describes the progress of the operation. Unit of work is generic and must - * be interpreted based on where Progress is used. + * Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used. */ export interface Schema$GoogleFirestoreAdminV1beta2Progress { /** @@ -493,14 +409,11 @@ export namespace firestore_v1beta2 { estimatedWork?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -508,64 +421,20 @@ export namespace firestore_v1beta2 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -573,14 +442,11 @@ export namespace firestore_v1beta2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -606,14 +472,7 @@ export namespace firestore_v1beta2 { /** * firestore.projects.databases.exportDocuments - * @desc Exports a copy of all or a subset of documents from Google Cloud - * Firestore to another storage system, such as Google Cloud Storage. Recent - * updates to documents may not be reflected in the export. The export - * occurs in the background and its progress can be monitored and managed - * via the Operation resource that is created. The output of an export may - * only be used once the associated operation is done. If an export - * operation is cancelled before completion it may leave partial data behind - * in Google Cloud Storage. + * @desc Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. * @alias firestore.projects.databases.exportDocuments * @memberOf! () * @@ -695,12 +554,7 @@ export namespace firestore_v1beta2 { /** * firestore.projects.databases.importDocuments - * @desc Imports documents into Google Cloud Firestore. Existing documents - * with the same name are overwritten. The import occurs in the background - * and its progress can be monitored and managed via the Operation resource - * that is created. If an ImportDocuments operation is cancelled, it is - * possible that a subset of the data has already been imported to Cloud - * Firestore. + * @desc Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore. * @alias firestore.projects.databases.importDocuments * @memberOf! () * @@ -789,8 +643,7 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to export. Should be of the form: - * `projects/{project_id}/databases/{database_id}`. + * Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -807,8 +660,7 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to import into. Should be of the form: - * `projects/{project_id}/databases/{database_id}`. + * Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -921,11 +773,7 @@ export namespace firestore_v1beta2 { /** * firestore.projects.databases.collectionGroups.fields.list - * @desc Lists the field configuration and metadata for this database. - * Currently, FirestoreAdmin.ListFields only supports listing fields that - * have been explicitly overridden. To issue this query, call - * FirestoreAdmin.ListFields with the filter set to - * `indexConfig.usesAncestorConfig:false`. + * @desc Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`. * @alias firestore.projects.databases.collectionGroups.fields.list * @memberOf! () * @@ -1027,16 +875,7 @@ export namespace firestore_v1beta2 { /** * firestore.projects.databases.collectionGroups.fields.patch - * @desc Updates a field configuration. Currently, field updates apply only - * to single field index configuration. However, calls to - * FirestoreAdmin.UpdateField should provide a field mask to avoid changing - * any configuration that the caller isn't aware of. The field mask should - * be specified as: `{ paths: "index_config" }`. This call returns a - * google.longrunning.Operation which may be used to track the status of the - * field update. The metadata for the operation will be the type - * FieldOperationMetadata. To configure the default field settings for the - * database, use the special `Field` with resource name: - * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x`. + * @desc Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x`. * @alias firestore.projects.databases.collectionGroups.fields.patch * @memberOf! () * @@ -1123,8 +962,7 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` + * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` */ name?: string; } @@ -1136,10 +974,7 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter to apply to list results. Currently, FirestoreAdmin.ListFields - * only supports listing fields that have been explicitly overridden. To - * issue this query, call FirestoreAdmin.ListFields with the filter set to - * `indexConfig.usesAncestorConfig:false`. + * The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`. */ filter?: string; /** @@ -1147,13 +982,11 @@ export namespace firestore_v1beta2 { */ pageSize?: number; /** - * A page token, returned from a previous call to FirestoreAdmin.ListFields, - * that may be used to get the next page of results. + * A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. */ pageToken?: string; /** - * A parent name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; } @@ -1165,30 +998,11 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A field name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` - * A field path may be a simple field name, e.g. `address` or a path to - * fields within map_value , e.g. `address.city`, or a special field path. - * The only valid special field is `*`, which represents any field. Field - * paths may be quoted using ` (backtick). The only character that needs to - * be escaped within a quoted field path is the backtick character itself, - * escaped using a backslash. Special characters in field paths that must be - * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii - * symbolic characters. Examples: (Note: Comments here are written in - * markdown syntax, so there is an additional layer of backticks to - * represent a code block) `\`address.city\`` represents a field named - * `address.city`, not the map key `city` in the field `address`. `\`*\`` - * represents a field named `*`, not any field. A special `Field` contains - * the default indexing settings for all fields. This field's resource name - * is: - * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` - * Indexes defined on this `Field` will be applied to all fields which do - * not have their own `Field` index configuration. + * A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */ name?: string; /** - * A mask, relative to the field. If specified, only configuration specified - * by this field_mask will be updated in the field. + * A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. */ updateMask?: string; @@ -1206,10 +1020,7 @@ export namespace firestore_v1beta2 { /** * firestore.projects.databases.collectionGroups.indexes.create - * @desc Creates a composite index. This returns a - * google.longrunning.Operation which may be used to track the status of the - * creation. The metadata for the operation will be the type - * IndexOperationMetadata. + * @desc Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. * @alias firestore.projects.databases.collectionGroups.indexes.create * @memberOf! () * @@ -1549,8 +1360,7 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A parent name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; @@ -1567,8 +1377,7 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ name?: string; } @@ -1580,8 +1389,7 @@ export namespace firestore_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ name?: string; } @@ -1601,14 +1409,11 @@ export namespace firestore_v1beta2 { */ pageSize?: number; /** - * A page token, returned from a previous call to - * FirestoreAdmin.ListIndexes, that may be used to get the next page of - * results. + * A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results. */ pageToken?: string; /** - * A parent name of the form - * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; } diff --git a/src/apis/fitness/package.json b/src/apis/fitness/package.json index c65e91bfb86..1e93f8bbcd2 100644 --- a/src/apis/fitness/package.json +++ b/src/apis/fitness/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index 572f51581f2..cdc1d42a2d6 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace fitness_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace fitness_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace fitness_v1 { /** * Fitness * - * Stores and accesses user data in the fitness store from apps on any - * platform. + * Stores and accesses user data in the fitness store from apps on any platform. * * @example * const {google} = require('googleapis'); @@ -96,7 +92,10 @@ export namespace fitness_v1 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.users = new Resource$Users(this.context); } @@ -112,8 +111,7 @@ export namespace fitness_v1 { */ dataset?: Schema$Dataset[]; /** - * The end time for the aggregated data, in milliseconds since epoch, - * inclusive. + * The end time for the aggregated data, in milliseconds since epoch, inclusive. */ endTimeMillis?: string; /** @@ -121,13 +119,11 @@ export namespace fitness_v1 { */ session?: Schema$Session; /** - * The start time for the aggregated data, in milliseconds since epoch, - * inclusive. + * The start time for the aggregated data, in milliseconds since epoch, inclusive. */ startTimeMillis?: string; /** - * The type of a bucket signifies how the data aggregation is performed in - * the bucket. + * The type of a bucket signifies how the data aggregation is performed in the bucket. */ type?: string; } @@ -136,17 +132,11 @@ export namespace fitness_v1 { */ export interface Schema$AggregateBy { /** - * A data source ID to aggregate. Mutually exclusive of dataTypeName. Only - * data from the specified data source ID will be included in the - * aggregation. The dataset in the response will have the same data source - * ID. + * A data source ID to aggregate. Mutually exclusive of dataTypeName. Only data from the specified data source ID will be included in the aggregation. The dataset in the response will have the same data source ID. */ dataSourceId?: string; /** - * The data type to aggregate. All data sources providing this data type - * will contribute data to the aggregation. The response will contain a - * single dataset for this data type name. The dataset will have a data - * source ID of derived:com.google.:com.google.android.gms:aggregated + * The data type to aggregate. All data sources providing this data type will contribute data to the aggregation. The response will contain a single dataset for this data type name. The dataset will have a data source ID of derived:com.google.:com.google.android.gms:aggregated */ dataTypeName?: string; } @@ -155,53 +145,35 @@ export namespace fitness_v1 { */ export interface Schema$AggregateRequest { /** - * The specification of data to be aggregated. At least one aggregateBy spec - * must be provided. All data that is specified will be aggregated using the - * same bucketing criteria. There will be one dataset in the response for - * every aggregateBy spec. + * The specification of data to be aggregated. At least one aggregateBy spec must be provided. All data that is specified will be aggregated using the same bucketing criteria. There will be one dataset in the response for every aggregateBy spec. */ aggregateBy?: Schema$AggregateBy[]; /** - * Specifies that data be aggregated each activity segment recored for a - * user. Similar to bucketByActivitySegment, but bucketing is done for each - * activity segment rather than all segments of the same type. Mutually - * exclusive of other bucketing specifications. + * Specifies that data be aggregated each activity segment recored for a user. Similar to bucketByActivitySegment, but bucketing is done for each activity segment rather than all segments of the same type. Mutually exclusive of other bucketing specifications. */ bucketByActivitySegment?: Schema$BucketByActivity; /** - * Specifies that data be aggregated by the type of activity being performed - * when the data was recorded. All data that was recorded during a certain - * activity type (for the given time range) will be aggregated into the same - * bucket. Data that was recorded while the user was not active will not be - * included in the response. Mutually exclusive of other bucketing - * specifications. + * Specifies that data be aggregated by the type of activity being performed when the data was recorded. All data that was recorded during a certain activity type (for the given time range) will be aggregated into the same bucket. Data that was recorded while the user was not active will not be included in the response. Mutually exclusive of other bucketing specifications. */ bucketByActivityType?: Schema$BucketByActivity; /** - * Specifies that data be aggregated by user sessions. Data that does not - * fall within the time range of a session will not be included in the - * response. Mutually exclusive of other bucketing specifications. + * Specifies that data be aggregated by user sessions. Data that does not fall within the time range of a session will not be included in the response. Mutually exclusive of other bucketing specifications. */ bucketBySession?: Schema$BucketBySession; /** - * Specifies that data be aggregated by a single time interval. Mutually - * exclusive of other bucketing specifications. + * Specifies that data be aggregated by a single time interval. Mutually exclusive of other bucketing specifications. */ bucketByTime?: Schema$BucketByTime; /** - * The end of a window of time. Data that intersects with this time window - * will be aggregated. The time is in milliseconds since epoch, inclusive. + * The end of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive. */ endTimeMillis?: string; /** - * DO NOT POPULATE THIS FIELD. As data quality standards are deprecated, - * filling it in will result in no data sources being returned. It will be - * removed in a future version entirely. + * DO NOT POPULATE THIS FIELD. As data quality standards are deprecated, filling it in will result in no data sources being returned. It will be removed in a future version entirely. */ filteredDataQualityStandard?: string[]; /** - * The start of a window of time. Data that intersects with this time window - * will be aggregated. The time is in milliseconds since epoch, inclusive. + * The start of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive. */ startTimeMillis?: string; } @@ -217,50 +189,37 @@ export namespace fitness_v1 { */ detailsUrl?: string; /** - * The name of this application. This is required for REST clients, but we - * do not enforce uniqueness of this name. It is provided as a matter of - * convenience for other developers who would like to identify which REST - * created an Application or Data Source. + * The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source. */ name?: string; /** - * Package name for this application. This is used as a unique identifier - * when created by Android applications, but cannot be specified by REST - * clients. REST clients will have their developer project number reflected - * into the Data Source data stream IDs, instead of the packageName. + * Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName. */ packageName?: string; /** - * Version of the application. You should update this field whenever the - * application changes in a way that affects the computation of the data. + * Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data. */ version?: string; } export interface Schema$BucketByActivity { /** - * The default activity stream will be used if a specific - * activityDataSourceId is not specified. + * The default activity stream will be used if a specific activityDataSourceId is not specified. */ activityDataSourceId?: string; /** - * Specifies that only activity segments of duration longer than - * minDurationMillis are considered and used as a container for aggregated - * data. + * Specifies that only activity segments of duration longer than minDurationMillis are considered and used as a container for aggregated data. */ minDurationMillis?: string; } export interface Schema$BucketBySession { /** - * Specifies that only sessions of duration longer than minDurationMillis - * are considered and used as a container for aggregated data. + * Specifies that only sessions of duration longer than minDurationMillis are considered and used as a container for aggregated data. */ minDurationMillis?: string; } export interface Schema$BucketByTime { /** - * Specifies that result buckets aggregate data by exactly durationMillis - * time frames. Time frames that contain no data will be included in the - * response with an empty dataset. + * Specifies that result buckets aggregate data by exactly durationMillis time frames. Time frames that contain no data will be included in the response with an empty dataset. */ durationMillis?: string; period?: Schema$BucketByTimePeriod; @@ -274,14 +233,7 @@ export namespace fitness_v1 { value?: number; } /** - * Represents a single data point, generated by a particular data source. A - * data point holds a value for each field, an end timestamp and an optional - * start time. The exact semantics of each of these attributes are specified - * in the documentation for the particular data type. A data point can - * represent an instantaneous measurement, reading or input observation, as - * well as averages or aggregates over a time interval. Check the data type - * documentation to determine which is the case for a particular data type. - * Data points always contain one value for each field of the data type. + * Represents a single data point, generated by a particular data source. A data point holds a value for each field, an end timestamp and an optional start time. The exact semantics of each of these attributes are specified in the documentation for the particular data type. A data point can represent an instantaneous measurement, reading or input observation, as well as averages or aggregates over a time interval. Check the data type documentation to determine which is the case for a particular data type. Data points always contain one value for each field of the data type. */ export interface Schema$DataPoint { /** @@ -293,23 +245,15 @@ export namespace fitness_v1 { */ dataTypeName?: string; /** - * The end time of the interval represented by this data point, in - * nanoseconds since epoch. + * The end time of the interval represented by this data point, in nanoseconds since epoch. */ endTimeNanos?: string; /** - * Indicates the last time this data point was modified. Useful only in - * contexts where we are listing the data changes, rather than representing - * the current state of the data. + * Indicates the last time this data point was modified. Useful only in contexts where we are listing the data changes, rather than representing the current state of the data. */ modifiedTimeMillis?: string; /** - * If the data point is contained in a dataset for a derived data source, - * this field will be populated with the data source stream ID that created - * the data point originally. WARNING: do not rely on this field for - * anything other than debugging. The value of this field, if it is set at - * all, is an implementation detail and is not guaranteed to remain - * consistent. + * If the data point is contained in a dataset for a derived data source, this field will be populated with the data source stream ID that created the data point originally. WARNING: do not rely on this field for anything other than debugging. The value of this field, if it is set at all, is an implementation detail and is not guaranteed to remain consistent. */ originDataSourceId?: string; /** @@ -317,126 +261,65 @@ export namespace fitness_v1 { */ rawTimestampNanos?: string; /** - * The start time of the interval represented by this data point, in - * nanoseconds since epoch. + * The start time of the interval represented by this data point, in nanoseconds since epoch. */ startTimeNanos?: string; /** - * Values of each data type field for the data point. It is expected that - * each value corresponding to a data type field will occur in the same - * order that the field is listed with in the data type specified in a data - * source. Only one of integer and floating point fields will be populated, - * depending on the format enum value within data source's type field. + * Values of each data type field for the data point. It is expected that each value corresponding to a data type field will occur in the same order that the field is listed with in the data type specified in a data source. Only one of integer and floating point fields will be populated, depending on the format enum value within data source's type field. */ value?: Schema$Value[]; } /** - * A dataset represents a projection container for data points. They do not - * carry any info of their own. Datasets represent a set of data points from a - * particular data source. A data point can be found in more than one dataset. + * A dataset represents a projection container for data points. They do not carry any info of their own. Datasets represent a set of data points from a particular data source. A data point can be found in more than one dataset. */ export interface Schema$Dataset { /** - * The data stream ID of the data source that created the points in this - * dataset. + * The data stream ID of the data source that created the points in this dataset. */ dataSourceId?: string; /** - * The largest end time of all data points in this possibly partial - * representation of the dataset. Time is in nanoseconds from epoch. This - * should also match the second part of the dataset identifier. + * The largest end time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the second part of the dataset identifier. */ maxEndTimeNs?: string; /** - * The smallest start time of all data points in this possibly partial - * representation of the dataset. Time is in nanoseconds from epoch. This - * should also match the first part of the dataset identifier. + * The smallest start time of all data points in this possibly partial representation of the dataset. Time is in nanoseconds from epoch. This should also match the first part of the dataset identifier. */ minStartTimeNs?: string; /** - * This token will be set when a dataset is received in response to a GET - * request and the dataset is too large to be included in a single response. - * Provide this value in a subsequent GET request to return the next page of - * data points within this dataset. + * This token will be set when a dataset is received in response to a GET request and the dataset is too large to be included in a single response. Provide this value in a subsequent GET request to return the next page of data points within this dataset. */ nextPageToken?: string; /** - * A partial list of data points contained in the dataset, ordered by - * largest endTimeNanos first. This list is considered complete when - * retrieving a small dataset and partial when patching a dataset or - * retrieving a dataset that is too large to include in a single response. + * A partial list of data points contained in the dataset, ordered by largest endTimeNanos first. This list is considered complete when retrieving a small dataset and partial when patching a dataset or retrieving a dataset that is too large to include in a single response. */ point?: Schema$DataPoint[]; } /** - * Definition of a unique source of sensor data. Data sources can expose raw - * data coming from hardware sensors on local or companion devices. They can - * also expose derived data, created by transforming or merging other data - * sources. Multiple data sources can exist for the same data type. Every data - * point inserted into or read from this service has an associated data - * source. The data source contains enough information to uniquely identify - * its data, including the hardware device and the application that collected - * and/or transformed the data. It also holds useful metadata, such as the - * hardware and application versions, and the device type. Each data source - * produces a unique stream of data, with a unique identifier. Not all changes - * to data source affect the stream identifier, so that data collected by - * updated versions of the same application/device can still be considered to - * belong to the same data stream. + * Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source. The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type. Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream. */ export interface Schema$DataSource { /** - * Information about an application which feeds sensor data into the - * platform. + * Information about an application which feeds sensor data into the platform. */ application?: Schema$Application; /** - * DO NOT POPULATE THIS FIELD. It is never populated in responses from the - * platform, and is ignored in queries. It will be removed in a future - * version entirely. + * DO NOT POPULATE THIS FIELD. It is never populated in responses from the platform, and is ignored in queries. It will be removed in a future version entirely. */ dataQualityStandard?: string[]; /** - * A unique identifier for the data stream produced by this data source. The - * identifier includes: - The physical device's manufacturer, model, - * and serial number (UID). - The application's package name or name. - * Package name is used when the data source was created by an Android - * application. The developer project number is used when the data source - * was created by a REST client. - The data source's type. - The data - * source's stream name. Note that not all attributes of the data - * source are used as part of the stream identifier. In particular, the - * version of the hardware/the application isn't used. This allows us to - * preserve the same stream through version updates. This also means that - * two DataSource objects may represent the same data stream even if - * they're not equal. The exact format of the data stream ID created by - * an Android application is: - * type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName - * The exact format of the data stream ID created by a REST client is: - * type:dataType.name:developer project - * number:device.manufacturer:device.model:device.uid:dataStreamName When - * any of the optional fields that make up the data stream ID are absent, - * they will be omitted from the data stream ID. The minimum viable data - * stream ID would be: type:dataType.name:developer project number Finally, - * the developer project number is obfuscated when read by any REST or - * Android client that did not create the data source. Only the data source - * creator will see the developer project number in clear and normal form. + * A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName When any of the optional fields that make up the data stream ID are absent, they will be omitted from the data stream ID. The minimum viable data stream ID would be: type:dataType.name:developer project number Finally, the developer project number is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. */ dataStreamId?: string; /** - * The stream name uniquely identifies this particular data source among - * other data sources of the same type from the same underlying producer. - * Setting the stream name is optional, but should be done whenever an - * application exposes two streams for the same data type, or when a device - * has two equivalent sensors. + * The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors. */ dataStreamName?: string; /** - * The data type defines the schema for a stream of data being collected by, - * inserted into, or queried from the Fitness API. + * The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API. */ dataType?: Schema$DataType; /** - * Representation of an integrated device (such as a phone or a wearable) - * that can hold sensors. + * Representation of an integrated device (such as a phone or a wearable) that can hold sensors. */ device?: Schema$Device; /** @@ -444,8 +327,7 @@ export namespace fitness_v1 { */ name?: string; /** - * A constant describing the type of this data source. Indicates whether - * this data source produces raw or derived data. + * A constant describing the type of this data source. Indicates whether this data source produces raw or derived data. */ type?: string; } @@ -455,17 +337,12 @@ export namespace fitness_v1 { */ field?: Schema$DataTypeField[]; /** - * Each data type has a unique, namespaced, name. All data types in the - * com.google namespace are shared as part of the platform. + * Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform. */ name?: string; } /** - * In case of multi-dimensional data (such as an accelerometer with x, y, and - * z axes) each field represents one dimension. Each data type field has a - * unique name which identifies it. The field also defines the format of the - * data (int, float, etc.). This message is only instantiated in code and not - * used for wire comms or stored in any way. + * In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.). This message is only instantiated in code and not used for wire comms or stored in any way. */ export interface Schema$DataTypeField { /** @@ -473,23 +350,13 @@ export namespace fitness_v1 { */ format?: string; /** - * Defines the name and format of data. Unlike data type names, field names - * are not namespaced, and only need to be unique within the data type. + * Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type. */ name?: string; optional?: boolean; } /** - * Representation of an integrated device (such as a phone or a wearable) that - * can hold sensors. Each sensor is exposed as a data source. The main - * purpose of the device information contained in this class is to identify - * the hardware of a particular data source. This can be useful in different - * ways, including: - Distinguishing two similar sensors on different - * devices (the step counter on two nexus 5 phones, for instance) - Display - * the source of data to the user (by using the device make / model) - Treat - * data differently depending on sensor type (accelerometers on a watch may - * give different patterns than those on a phone) - Build different analysis - * models for each device/version. + * Representation of an integrated device (such as a phone or a wearable) that can hold sensors. Each sensor is exposed as a data source. The main purpose of the device information contained in this class is to identify the hardware of a particular data source. This can be useful in different ways, including: - Distinguishing two similar sensors on different devices (the step counter on two nexus 5 phones, for instance) - Display the source of data to the user (by using the device make / model) - Treat data differently depending on sensor type (accelerometers on a watch may give different patterns than those on a phone) - Build different analysis models for each device/version. */ export interface Schema$Device { /** @@ -505,10 +372,7 @@ export namespace fitness_v1 { */ type?: string; /** - * The serial number or other unique ID for the hardware. This field is - * obfuscated when read by any REST or Android client that did not create - * the data source. Only the data source creator will see the uid field in - * clear and normal form. + * The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form. */ uid?: string; /** @@ -522,8 +386,7 @@ export namespace fitness_v1 { */ dataSourceId?: string; /** - * Deleted data points for the user. Note, for modifications this should be - * parsed before handling insertions. + * Deleted data points for the user. Note, for modifications this should be parsed before handling insertions. */ deletedDataPoint?: Schema$DataPoint[]; /** @@ -531,9 +394,7 @@ export namespace fitness_v1 { */ insertedDataPoint?: Schema$DataPoint[]; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -545,9 +406,7 @@ export namespace fitness_v1 { } export interface Schema$ListSessionsResponse { /** - * If includeDeleted is set to true in the request, this list will contain - * sessions deleted with original end times that are within the startTime - * and endTime frame. + * If includeDeleted is set to true in the request, this list will contain sessions deleted with original end times that are within the startTime and endTime frame. */ deletedSession?: Schema$Session[]; /** @@ -555,20 +414,16 @@ export namespace fitness_v1 { */ hasMoreData?: boolean; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** - * Sessions with an end time that is between startTime and endTime of the - * request. + * Sessions with an end time that is between startTime and endTime of the request. */ session?: Schema$Session[]; } /** - * Holder object for the value of an entry in a map field of a data point. A - * map value supports a subset of the formats that the regular Value supports. + * Holder object for the value of an entry in a map field of a data point. A map value supports a subset of the formats that the regular Value supports. */ export interface Schema$MapValue { /** @@ -577,16 +432,11 @@ export namespace fitness_v1 { fpVal?: number; } /** - * Sessions contain metadata, such as a user-friendly name and time interval - * information. + * Sessions contain metadata, such as a user-friendly name and time interval information. */ export interface Schema$Session { /** - * Session active time. While start_time_millis and end_time_millis define - * the full session time, the active time can be shorter and specified by - * active_time_millis. If the inactive time during the session is known, it - * should also be inserted via a com.google.activity.segment data point with - * a STILL activity value + * Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value */ activeTimeMillis?: string; /** @@ -606,8 +456,7 @@ export namespace fitness_v1 { */ endTimeMillis?: string; /** - * A client-generated identifier that is unique across all sessions owned by - * this particular user. + * A client-generated identifier that is unique across all sessions owned by this particular user. */ id?: string; /** @@ -624,9 +473,7 @@ export namespace fitness_v1 { startTimeMillis?: string; } /** - * Holder object for the value of a single field in a data point. A field - * value has a particular format and is only ever set to one of an integer or - * a floating point value. LINT.IfChange + * Holder object for the value of a single field in a data point. A field value has a particular format and is only ever set to one of an integer or a floating point value. LINT.IfChange */ export interface Schema$Value { /** @@ -638,16 +485,11 @@ export namespace fitness_v1 { */ intVal?: number; /** - * Map value. The valid key space and units for the corresponding value of - * each entry should be documented as part of the data type definition. Keys - * should be kept small whenever possible. Data streams with large keys and - * high data frequency may be down sampled. + * Map value. The valid key space and units for the corresponding value of each entry should be documented as part of the data type definition. Keys should be kept small whenever possible. Data streams with large keys and high data frequency may be down sampled. */ mapVal?: Schema$ValueMapValEntry[]; /** - * String value. When this is set, other values must not be set. Strings - * should be kept small whenever possible. Data streams with large string - * values and high data frequency may be down sampled. + * String value. When this is set, other values must not be set. Strings should be kept small whenever possible. Data streams with large string values and high data frequency may be down sampled. */ stringVal?: string; } @@ -677,10 +519,7 @@ export namespace fitness_v1 { /** * fitness.users.dataset.aggregate - * @desc Aggregates data of a certain type or stream into buckets divided by - * a given type of boundary. Multiple data sets of multiple types and from - * multiple sources can be aggreated into exactly one bucket type per - * request. + * @desc Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggreated into exactly one bucket type per request. * @alias fitness.users.dataset.aggregate * @memberOf! () * @@ -761,8 +600,7 @@ export namespace fitness_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Aggregate data for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Aggregate data for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; @@ -786,14 +624,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.create - * @desc Creates a new data source that is unique across all data sources - * belonging to this user. The data stream ID field can be omitted and will - * be generated by the server with the correct format. The data stream ID is - * an ordered combination of some fields from the data source. In addition - * to the data source fields reflected into the data source ID, the - * developer project number that is authenticated when creating the data - * source is included. This developer project number is obfuscated when read - * by any other developer reading public data types. + * @desc Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types. * @alias fitness.users.dataSources.create * @memberOf! () * @@ -868,8 +699,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.delete - * @desc Deletes the specified data source. The request will fail if the - * data source contains any data points. + * @desc Deletes the specified data source. The request will fail if the data source contains any data points. * @alias fitness.users.dataSources.delete * @memberOf! () * @@ -1017,10 +847,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.list - * @desc Lists all data sources that are visible to the developer, using the - * OAuth scopes provided. The list is not exhaustive; the user may have - * private data sources that are only visible to other developers, or calls - * using other scopes. + * @desc Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes. * @alias fitness.users.dataSources.list * @memberOf! () * @@ -1097,10 +924,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.update - * @desc Updates the specified data source. The dataStreamId, dataType, - * type, dataStreamName, and device properties with the exception of - * version, cannot be modified. Data sources are identified by their - * dataStreamId. + * @desc Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified. Data sources are identified by their dataStreamId. * @alias fitness.users.dataSources.update * @memberOf! () * @@ -1182,8 +1006,7 @@ export namespace fitness_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Create the data source for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Create the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; @@ -1204,8 +1027,7 @@ export namespace fitness_v1 { */ dataSourceId?: string; /** - * Retrieve a data source for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -1221,8 +1043,7 @@ export namespace fitness_v1 { */ dataSourceId?: string; /** - * Retrieve a data source for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -1234,13 +1055,11 @@ export namespace fitness_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The names of data types to include in the list. If not specified, all - * data sources will be returned. + * The names of data types to include in the list. If not specified, all data sources will be returned. */ dataTypeName?: string[]; /** - * List data sources for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * List data sources for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -1256,8 +1075,7 @@ export namespace fitness_v1 { */ dataSourceId?: string; /** - * Update the data source for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; @@ -1372,19 +1190,15 @@ export namespace fitness_v1 { */ dataSourceId?: string; /** - * If specified, no more than this many data point changes will be included - * in the response. + * If specified, no more than this many data point changes will be included in the response. */ limit?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * nextPageToken from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. */ pageToken?: string; /** - * List data points for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * List data points for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -1397,13 +1211,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.datasets.delete - * @desc Performs an inclusive delete of all data points whose start and end - * times have any overlap with the time range specified by the dataset ID. - * For most data types, the entire data point will be deleted. For data - * types where the time span represents a consistent value (such as - * com.google.activity.segment), and a data point straddles either end point - * of the dataset, only the overlapping portion of the data point will be - * deleted. + * @desc Performs an inclusive delete of all data points whose start and end times have any overlap with the time range specified by the dataset ID. For most data types, the entire data point will be deleted. For data types where the time span represents a consistent value (such as com.google.activity.segment), and a data point straddles either end point of the dataset, only the overlapping portion of the data point will be deleted. * @alias fitness.users.dataSources.datasets.delete * @memberOf! () * @@ -1479,11 +1287,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.datasets.get - * @desc Returns a dataset containing all data points whose start and end - * times overlap with the specified range of the dataset minimum start time - * and maximum end time. Specifically, any data point whose start time is - * less than or equal to the dataset end time and whose end time is greater - * than or equal to the dataset start time. + * @desc Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time. Specifically, any data point whose start time is less than or equal to the dataset end time and whose end time is greater than or equal to the dataset start time. * @alias fitness.users.dataSources.datasets.get * @memberOf! () * @@ -1559,10 +1363,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.datasets.patch - * @desc Adds data points to a dataset. The dataset need not be previously - * created. All points within the given dataset will be returned with - * subsquent calls to retrieve this dataset. Data points can belong to more - * than one dataset. This method does not use patch semantics. + * @desc Adds data points to a dataset. The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics. * @alias fitness.users.dataSources.datasets.patch * @memberOf! () * @@ -1649,10 +1450,7 @@ export namespace fitness_v1 { */ currentTimeMillis?: string; /** - * Dataset identifier that is a composite of the minimum data point start - * time and maximum data point end time represented as nanoseconds from the - * epoch. The ID is formatted like: "startTime-endTime" where startTime and - * endTime are 64 bit integers. + * Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers. */ datasetId?: string; /** @@ -1664,8 +1462,7 @@ export namespace fitness_v1 { */ modifiedTimeMillis?: string; /** - * Delete a dataset for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Delete a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -1677,10 +1474,7 @@ export namespace fitness_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Dataset identifier that is a composite of the minimum data point start - * time and maximum data point end time represented as nanoseconds from the - * epoch. The ID is formatted like: "startTime-endTime" where startTime and - * endTime are 64 bit integers. + * Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers. */ datasetId?: string; /** @@ -1688,22 +1482,15 @@ export namespace fitness_v1 { */ dataSourceId?: string; /** - * If specified, no more than this many data points will be included in the - * dataset. If there are more data points in the dataset, nextPageToken will - * be set in the dataset response. + * If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response. */ limit?: number; /** - * The continuation token, which is used to page through large datasets. To - * get the next page of a dataset, set this parameter to the value of - * nextPageToken from the previous response. Each subsequent call will yield - * a partial dataset with data point end timestamps that are strictly - * smaller than those in the previous partial response. + * The continuation token, which is used to page through large datasets. To get the next page of a dataset, set this parameter to the value of nextPageToken from the previous response. Each subsequent call will yield a partial dataset with data point end timestamps that are strictly smaller than those in the previous partial response. */ pageToken?: string; /** - * Retrieve a dataset for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -1715,16 +1502,11 @@ export namespace fitness_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The client's current time in milliseconds since epoch. Note that the - * minStartTimeNs and maxEndTimeNs properties in the request body are in - * nanoseconds instead of milliseconds. + * The client's current time in milliseconds since epoch. Note that the minStartTimeNs and maxEndTimeNs properties in the request body are in nanoseconds instead of milliseconds. */ currentTimeMillis?: string; /** - * Dataset identifier that is a composite of the minimum data point start - * time and maximum data point end time represented as nanoseconds from the - * epoch. The ID is formatted like: "startTime-endTime" where startTime and - * endTime are 64 bit integers. + * Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers. */ datasetId?: string; /** @@ -1732,8 +1514,7 @@ export namespace fitness_v1 { */ dataSourceId?: string; /** - * Patch a dataset for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Patch a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; @@ -1993,8 +1774,7 @@ export namespace fitness_v1 { */ sessionId?: string; /** - * Delete a session for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -2006,34 +1786,23 @@ export namespace fitness_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An RFC3339 timestamp. Only sessions ending between the start and end - * times will be included in the response. + * An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. */ endTime?: string; /** - * If true, deleted sessions will be returned. When set to true, sessions - * returned in this response will only have an ID and will not have any - * other fields. + * If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields. */ includeDeleted?: boolean; /** - * The continuation token, which is used for incremental syncing. To get the - * next batch of changes, set this parameter to the value of nextPageToken - * from the previous response. This token is treated as a timestamp (in - * millis since epoch). If specified, the API returns sessions modified - * since this time. The page token is ignored if either start or end time is - * specified. If none of start time, end time, and the page token is - * specified, sessions modified in the last 30 days are returned. + * The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. This token is treated as a timestamp (in millis since epoch). If specified, the API returns sessions modified since this time. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 30 days are returned. */ pageToken?: string; /** - * An RFC3339 timestamp. Only sessions ending between the start and end - * times will be included in the response. + * An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. */ startTime?: string; /** - * List sessions for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; } @@ -2053,8 +1822,7 @@ export namespace fitness_v1 { */ sessionId?: string; /** - * Create sessions for the person identified. Use me to indicate the - * authenticated user. Only me is supported at this time. + * Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. */ userId?: string; diff --git a/src/apis/fusiontables/package.json b/src/apis/fusiontables/package.json index b0fb08d8534..b0924d8b2a0 100644 --- a/src/apis/fusiontables/package.json +++ b/src/apis/fusiontables/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/fusiontables/v1.ts b/src/apis/fusiontables/v1.ts index 6e7b3816f95..ffc6a91c77b 100644 --- a/src/apis/fusiontables/v1.ts +++ b/src/apis/fusiontables/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace fusiontables_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace fusiontables_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -100,7 +97,10 @@ export namespace fusiontables_v1 { template: Resource$Template; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.column = new Resource$Column(this.context); this.query = new Resource$Query(this.context); @@ -112,8 +112,7 @@ export namespace fusiontables_v1 { } /** - * Specifies the minimum and maximum values, the color, opacity, icon and - * weight of a bucket within a StyleSetting. + * Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting. */ export interface Schema$Bucket { /** @@ -125,13 +124,11 @@ export namespace fusiontables_v1 { */ icon?: string; /** - * Maximum value in the selected column for a row to be styled according to - * the bucket color, opacity, icon, or weight. + * Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. */ max?: number; /** - * Minimum value in the selected column for a row to be styled according to - * the bucket color, opacity, icon, or weight. + * Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. */ min?: number; /** @@ -148,8 +145,7 @@ export namespace fusiontables_v1 { */ export interface Schema$Column { /** - * Optional identifier of the base column. If present, this column is - * derived from the specified base column. + * Optional identifier of the base column. If present, this column is derived from the specified base column. */ baseColumn?: {columnId?: number; tableIndex?: number}; /** @@ -161,9 +157,7 @@ export namespace fusiontables_v1 { */ description?: string; /** - * Optional column predicate. Used to map table to graph data model - * (subject,predicate,object) See - * http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model + * Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model */ graph_predicate?: string; /** @@ -192,8 +186,7 @@ export namespace fusiontables_v1 { */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; /** @@ -250,8 +243,7 @@ export namespace fusiontables_v1 { */ strokeColor?: string; /** - * Column-value, gradient or buckets styler that is used to determine the - * line color and opacity. + * Column-value, gradient or buckets styler that is used to determine the line color and opacity. */ strokeColorStyler?: Schema$StyleFunction; /** @@ -263,8 +255,7 @@ export namespace fusiontables_v1 { */ strokeWeight?: number; /** - * Column-value or bucket styler that is used to determine the width of the - * line. + * Column-value or bucket styler that is used to determine the width of the line. */ strokeWeightStyler?: Schema$StyleFunction; } @@ -286,8 +277,7 @@ export namespace fusiontables_v1 { */ export interface Schema$PointStyle { /** - * Name of the icon. Use values defined in - * http://www.google.com/fusiontables/DataSource?dsrcid=308519 + * Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519 */ iconName?: string; /** @@ -317,13 +307,11 @@ export namespace fusiontables_v1 { */ fillColor?: string; /** - * Column-value, gradient, or bucket styler that is used to determine the - * interior color and opacity of the polygon. + * Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon. */ fillColorStyler?: Schema$StyleFunction; /** - * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 - * (opaque). + * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque). */ fillOpacity?: number; /** @@ -331,8 +319,7 @@ export namespace fusiontables_v1 { */ strokeColor?: string; /** - * Column-value, gradient or buckets styler that is used to determine the - * border color and opacity. + * Column-value, gradient or buckets styler that is used to determine the border color and opacity. */ strokeColorStyler?: Schema$StyleFunction; /** @@ -344,8 +331,7 @@ export namespace fusiontables_v1 { */ strokeWeight?: number; /** - * Column-value or bucket styler that is used to determine the width of the - * polygon border. + * Column-value or bucket styler that is used to determine the width of the polygon border. */ strokeWeightStyler?: Schema$StyleFunction; } @@ -362,9 +348,7 @@ export namespace fusiontables_v1 { */ kind?: string; /** - * The rows in the table. For each cell we print out whatever cell value - * (e.g., numeric, string) exists. Thus it is important that each cell - * contains only one value. + * The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value. */ rows?: any[][]; } @@ -373,8 +357,7 @@ export namespace fusiontables_v1 { */ export interface Schema$StyleFunction { /** - * Bucket function that assigns a style based on the range a column value - * falls into. + * Bucket function that assigns a style based on the range a column value falls into. */ buckets?: Schema$Bucket[]; /** @@ -382,8 +365,7 @@ export namespace fusiontables_v1 { */ columnName?: string; /** - * Gradient function that interpolates a range of colors based on column - * value. + * Gradient function that interpolates a range of colors based on column value. */ gradient?: { colors?: Array<{color?: string; opacity?: number}>; @@ -391,26 +373,16 @@ export namespace fusiontables_v1 { min?: number; }; /** - * Stylers can be one of three kinds: "fusiontables#fromColumn" if - * the column value is to be used as is, i.e., the column values can have - * colors in #RRGGBBAA format or integer line widths or icon names; - * "fusiontables#gradient" if the styling of the row is to be - * based on applying the gradient function on the column value; or - * "fusiontables#buckets" if the styling is to based on the bucket - * into which the the column value falls. + * Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls. */ kind?: string; } /** - * Represents a complete StyleSettings object. The primary key is a - * combination of the tableId and a styleId. + * Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId. */ export interface Schema$StyleSetting { /** - * Type name: an individual style setting. A StyleSetting contains the style - * defintions for points, lines, and polygons in a table. Since a table can - * have any one or all of them, a style definition can have point, line and - * polygon style definitions. + * Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions. */ kind?: string; /** @@ -451,8 +423,7 @@ export namespace fusiontables_v1 { */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; /** @@ -461,8 +432,7 @@ export namespace fusiontables_v1 { totalItems?: number; } /** - * Represents a table. Specifies the name, whether it is exportable, - * description, attribution, and attribution link. + * Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link. */ export interface Schema$Table { /** @@ -519,8 +489,7 @@ export namespace fusiontables_v1 { */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; } @@ -537,8 +506,7 @@ export namespace fusiontables_v1 { */ progress?: string; /** - * false while the table is busy with some other task. true if this - * background task is currently running. + * false while the table is busy with some other task. true if this background task is currently running. */ started?: boolean; /** @@ -546,11 +514,7 @@ export namespace fusiontables_v1 { */ taskId?: string; /** - * Type of background task. One of DELETE_ROWS Deletes one or more rows - * from the table. ADD_ROWS "Adds one or more rows to a table. Includes - * importing data into a new table and importing more rows into an existing - * table. ADD_COLUMN Adds a new column to the table. CHANGE_TYPE Changes the - * type of a column. + * Type of background task. One of DELETE_ROWS Deletes one or more rows from the table. ADD_ROWS "Adds one or more rows to a table. Includes importing data into a new table and importing more rows into an existing table. ADD_COLUMN Adds a new column to the table. CHANGE_TYPE Changes the type of a column. */ type?: string; } @@ -567,8 +531,7 @@ export namespace fusiontables_v1 { */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; /** @@ -581,21 +544,15 @@ export namespace fusiontables_v1 { */ export interface Schema$Template { /** - * List of columns from which the template is to be automatically - * constructed. Only one of body or automaticColumns can be specified. + * List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified. */ automaticColumnNames?: string[]; /** - * Body of the template. It contains HTML with {column_name} to insert - * values from a particular column. The body is sanitized to remove certain - * tags, e.g., script. Only one of body or automaticColumns can be - * specified. + * Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified. */ body?: string; /** - * Type name: a template for the info window contents. The template can - * either include an HTML body or a list of columns from which the template - * is computed automatically. + * Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically. */ kind?: string; /** @@ -607,8 +564,7 @@ export namespace fusiontables_v1 { */ tableId?: string; /** - * Identifier for the template, unique within the context of a particular - * table. + * Identifier for the template, unique within the context of a particular table. */ templateId?: number; } @@ -625,8 +581,7 @@ export namespace fusiontables_v1 { */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; /** @@ -930,8 +885,7 @@ export namespace fusiontables_v1 { /** * fusiontables.column.patch - * @desc Updates the name or type of an existing column. This method - * supports patch semantics. + * @desc Updates the name or type of an existing column. This method supports patch semantics. * @alias fusiontables.column.patch * @memberOf! () * @@ -1188,8 +1142,7 @@ export namespace fusiontables_v1 { /** * fusiontables.query.sql - * @desc Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE - * statement. + * @desc Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement. * @alias fusiontables.query.sql * @memberOf! () * @@ -1353,8 +1306,7 @@ export namespace fusiontables_v1 { */ sql?: string; /** - * Should typed values be returned in the (JSON) response -- numbers for - * numeric values and parsed geometries for KML values? Default is true. + * Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true. */ typed?: boolean; } @@ -1373,8 +1325,7 @@ export namespace fusiontables_v1 { */ sql?: string; /** - * Should typed values be returned in the (JSON) response -- numbers for - * numeric values and parsed geometries for KML values? Default is true. + * Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true. */ typed?: boolean; } @@ -2463,9 +2414,7 @@ export namespace fusiontables_v1 { /** * fusiontables.table.patch - * @desc Updates an existing table. Unless explicitly requested, only the - * name, description, and attribution will be updated. This method supports - * patch semantics. + * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics. * @alias fusiontables.table.patch * @memberOf! () * @@ -2538,8 +2487,7 @@ export namespace fusiontables_v1 { /** * fusiontables.table.update - * @desc Updates an existing table. Unless explicitly requested, only the - * name, description, and attribution will be updated. + * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. * @alias fusiontables.table.update * @memberOf! () * @@ -2655,35 +2603,23 @@ export namespace fusiontables_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The delimiter used to separate cell values. This can only consist of a - * single character. Default is ','. + * The delimiter used to separate cell values. This can only consist of a single character. Default is ','. */ delimiter?: string; /** - * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you - * are unsure of the encoding. + * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. */ encoding?: string; /** - * The index of the last line from which to start importing, exclusive. - * Thus, the number of imported lines is endLine - startLine. If this - * parameter is not provided, the file will be imported until the last line - * of the file. If endLine is negative, then the imported content will - * exclude the last endLine lines. That is, if endline is negative, no line - * will be imported whose index is greater than N + endLine where N is the - * number of lines in the file, and the number of imported lines will be N + - * endLine - startLine. + * The index of the last line from which to start importing, exclusive. Thus, the number of imported lines is endLine - startLine. If this parameter is not provided, the file will be imported until the last line of the file. If endLine is negative, then the imported content will exclude the last endLine lines. That is, if endline is negative, no line will be imported whose index is greater than N + endLine where N is the number of lines in the file, and the number of imported lines will be N + endLine - startLine. */ endLine?: number; /** - * Whether the CSV must have the same number of values for each row. If - * false, rows with fewer values will be padded with empty values. Default - * is true. + * Whether the CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true. */ isStrict?: boolean; /** - * The index of the first line from which to start importing, inclusive. - * Default is 0. + * The index of the first line from which to start importing, inclusive. Default is 0. */ startLine?: number; /** @@ -2714,13 +2650,11 @@ export namespace fusiontables_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The delimiter used to separate cell values. This can only consist of a - * single character. Default is ','. + * The delimiter used to separate cell values. This can only consist of a single character. Default is ','. */ delimiter?: string; /** - * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you - * are unsure of the encoding. + * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. */ encoding?: string; /** @@ -2776,9 +2710,7 @@ export namespace fusiontables_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Should the view definition also be updated? The specified view definition - * replaces the existing one. Only a view can be updated with a new - * definition. + * Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition. */ replaceViewDefinition?: boolean; /** @@ -2798,9 +2730,7 @@ export namespace fusiontables_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Should the view definition also be updated? The specified view definition - * replaces the existing one. Only a view can be updated with a new - * definition. + * Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition. */ replaceViewDefinition?: boolean; /** diff --git a/src/apis/fusiontables/v2.ts b/src/apis/fusiontables/v2.ts index 477d024b9ae..a2e285d652c 100644 --- a/src/apis/fusiontables/v2.ts +++ b/src/apis/fusiontables/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace fusiontables_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace fusiontables_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -100,7 +97,10 @@ export namespace fusiontables_v2 { template: Resource$Template; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.column = new Resource$Column(this.context); this.query = new Resource$Query(this.context); @@ -112,8 +112,7 @@ export namespace fusiontables_v2 { } /** - * Specifies the minimum and maximum values, the color, opacity, icon and - * weight of a bucket within a StyleSetting. + * Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting. */ export interface Schema$Bucket { /** @@ -125,13 +124,11 @@ export namespace fusiontables_v2 { */ icon?: string; /** - * Maximum value in the selected column for a row to be styled according to - * the bucket color, opacity, icon, or weight. + * Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. */ max?: number; /** - * Minimum value in the selected column for a row to be styled according to - * the bucket color, opacity, icon, or weight. + * Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. */ min?: number; /** @@ -148,8 +145,7 @@ export namespace fusiontables_v2 { */ export interface Schema$Column { /** - * Identifier of the base column. If present, this column is derived from - * the specified base column. + * Identifier of the base column. If present, this column is derived from the specified base column. */ baseColumn?: {columnId?: number; tableIndex?: number}; /** @@ -169,41 +165,15 @@ export namespace fusiontables_v2 { */ description?: string; /** - * Format pattern. Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 - * DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, - * 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM - * DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 - * DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 - * DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM - * DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 - * DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 - * DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM - * DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor - * example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example - * 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor - * example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor - * example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not - * match the data type NONENo formatting (default) NUMBER_CURRENCYfor - * example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor - * example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor - * example 123,456% NUMBER_SCIENTIFICfor example 1E3 - * STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines - * of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four - * lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI - * STRING_JSON_LISTAllows editing of text as a JSON list in UI - * STRING_LINKTreats cell as a link (must start with http:// or https://) - * STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of - * text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail + * Format pattern. Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail */ formatPattern?: string; /** - * Column graph predicate. Used to map table to graph data model - * (subject,predicate,object) See W3C Graph-based Data Model. + * Column graph predicate. Used to map table to graph data model (subject,predicate,object) See W3C Graph-based Data Model. */ graphPredicate?: string; /** - * The kind of item this is. For a column, this is always - * fusiontables#column. + * The kind of item this is. For a column, this is always fusiontables#column. */ kind?: string; /** @@ -219,8 +189,7 @@ export namespace fusiontables_v2 { */ validateData?: boolean; /** - * List of valid values used to validate data and supply a drop-down list of - * values in the web application. + * List of valid values used to validate data and supply a drop-down list of values in the web application. */ validValues?: string[]; } @@ -233,13 +202,11 @@ export namespace fusiontables_v2 { */ items?: Schema$Column[]; /** - * The kind of item this is. For a column list, this is always - * fusiontables#columnList. + * The kind of item this is. For a column list, this is always fusiontables#columnList. */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; /** @@ -266,8 +233,7 @@ export namespace fusiontables_v2 { */ export interface Schema$Import { /** - * The kind of item this is. For an import, this is always - * fusiontables#import. + * The kind of item this is. For an import, this is always fusiontables#import. */ kind?: string; /** @@ -297,8 +263,7 @@ export namespace fusiontables_v2 { */ strokeColor?: string; /** - * Column-value, gradient or buckets styler that is used to determine the - * line color and opacity. + * Column-value, gradient or buckets styler that is used to determine the line color and opacity. */ strokeColorStyler?: Schema$StyleFunction; /** @@ -310,8 +275,7 @@ export namespace fusiontables_v2 { */ strokeWeight?: number; /** - * Column-value or bucket styler that is used to determine the width of the - * line. + * Column-value or bucket styler that is used to determine the width of the line. */ strokeWeightStyler?: Schema$StyleFunction; } @@ -333,8 +297,7 @@ export namespace fusiontables_v2 { */ export interface Schema$PointStyle { /** - * Name of the icon. Use values defined in - * http://www.google.com/fusiontables/DataSource?dsrcid=308519 + * Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519 */ iconName?: string; /** @@ -364,13 +327,11 @@ export namespace fusiontables_v2 { */ fillColor?: string; /** - * Column-value, gradient, or bucket styler that is used to determine the - * interior color and opacity of the polygon. + * Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon. */ fillColorStyler?: Schema$StyleFunction; /** - * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 - * (opaque). + * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque). */ fillOpacity?: number; /** @@ -378,8 +339,7 @@ export namespace fusiontables_v2 { */ strokeColor?: string; /** - * Column-value, gradient or buckets styler that is used to determine the - * border color and opacity. + * Column-value, gradient or buckets styler that is used to determine the border color and opacity. */ strokeColorStyler?: Schema$StyleFunction; /** @@ -391,8 +351,7 @@ export namespace fusiontables_v2 { */ strokeWeight?: number; /** - * Column-value or bucket styler that is used to determine the width of the - * polygon border. + * Column-value or bucket styler that is used to determine the width of the polygon border. */ strokeWeightStyler?: Schema$StyleFunction; } @@ -405,14 +364,11 @@ export namespace fusiontables_v2 { */ columns?: string[]; /** - * The kind of item this is. For responses to SQL queries, this is always - * fusiontables#sqlresponse. + * The kind of item this is. For responses to SQL queries, this is always fusiontables#sqlresponse. */ kind?: string; /** - * The rows in the table. For each cell we print out whatever cell value - * (e.g., numeric, string) exists. Thus it is important that each cell - * contains only one value. + * The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value. */ rows?: any[][]; } @@ -421,8 +377,7 @@ export namespace fusiontables_v2 { */ export interface Schema$StyleFunction { /** - * Bucket function that assigns a style based on the range a column value - * falls into. + * Bucket function that assigns a style based on the range a column value falls into. */ buckets?: Schema$Bucket[]; /** @@ -430,8 +385,7 @@ export namespace fusiontables_v2 { */ columnName?: string; /** - * Gradient function that interpolates a range of colors based on column - * value. + * Gradient function that interpolates a range of colors based on column value. */ gradient?: { colors?: Array<{color?: string; opacity?: number}>; @@ -439,26 +393,16 @@ export namespace fusiontables_v2 { min?: number; }; /** - * Stylers can be one of three kinds: "fusiontables#fromColumn if the - * column value is to be used as is, i.e., the column values can have colors - * in #RRGGBBAA format or integer line widths or icon names; - * fusiontables#gradient if the styling of the row is to be based on - * applying the gradient function on the column value; or - * fusiontables#buckets if the styling is to based on the bucket into which - * the the column value falls. + * Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls. */ kind?: string; } /** - * Represents a complete StyleSettings object. The primary key is a - * combination of the tableId and a styleId. + * Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId. */ export interface Schema$StyleSetting { /** - * The kind of item this is. A StyleSetting contains the style definitions - * for points, lines, and polygons in a table. Since a table can have any - * one or all of them, a style definition can have point, line and polygon - * style definitions. + * The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions. */ kind?: string; /** @@ -495,13 +439,11 @@ export namespace fusiontables_v2 { */ items?: Schema$StyleSetting[]; /** - * The kind of item this is. For a style list, this is always - * fusiontables#styleSettingList . + * The kind of item this is. For a style list, this is always fusiontables#styleSettingList . */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more styles left. + * Token used to access the next page of this result. No token is displayed if there are no more styles left. */ nextPageToken?: string; /** @@ -575,19 +517,16 @@ export namespace fusiontables_v2 { */ items?: Schema$Table[]; /** - * The kind of item this is. For table list, this is always - * fusiontables#tableList. + * The kind of item this is. For table list, this is always fusiontables#tableList. */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; } /** - * A background task on a table, initiated for time- or resource-consuming - * operations such as changing column types or deleting all rows. + * A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows. */ export interface Schema$Task { /** @@ -599,8 +538,7 @@ export namespace fusiontables_v2 { */ progress?: string; /** - * false while the table is busy with some other task. true if this - * background task is currently running. + * false while the table is busy with some other task. true if this background task is currently running. */ started?: boolean; /** @@ -625,8 +563,7 @@ export namespace fusiontables_v2 { */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; /** @@ -639,20 +576,15 @@ export namespace fusiontables_v2 { */ export interface Schema$Template { /** - * List of columns from which the template is to be automatically - * constructed. Only one of body or automaticColumns can be specified. + * List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified. */ automaticColumnNames?: string[]; /** - * Body of the template. It contains HTML with {column_name} to insert - * values from a particular column. The body is sanitized to remove certain - * tags, e.g., script. Only one of body or automaticColumns can be - * specified. + * Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified. */ body?: string; /** - * The kind of item this is. For a template, this is always - * fusiontables#template. + * The kind of item this is. For a template, this is always fusiontables#template. */ kind?: string; /** @@ -664,8 +596,7 @@ export namespace fusiontables_v2 { */ tableId?: string; /** - * Identifier for the template, unique within the context of a particular - * table. + * Identifier for the template, unique within the context of a particular table. */ templateId?: number; } @@ -678,13 +609,11 @@ export namespace fusiontables_v2 { */ items?: Schema$Template[]; /** - * The kind of item this is. For a template list, this is always - * fusiontables#templateList . + * The kind of item this is. For a template list, this is always fusiontables#templateList . */ kind?: string; /** - * Token used to access the next page of this result. No token is displayed - * if there are no more pages left. + * Token used to access the next page of this result. No token is displayed if there are no more pages left. */ nextPageToken?: string; /** @@ -988,8 +917,7 @@ export namespace fusiontables_v2 { /** * fusiontables.column.patch - * @desc Updates the name or type of an existing column. This method - * supports patch semantics. + * @desc Updates the name or type of an existing column. This method supports patch semantics. * @alias fusiontables.column.patch * @memberOf! () * @@ -1246,8 +1174,7 @@ export namespace fusiontables_v2 { /** * fusiontables.query.sql - * @desc Executes a Fusion Tables SQL statement, which can be any of - - * SELECT - INSERT - UPDATE - DELETE - SHOW - DESCRIBE - CREATE statement. + * @desc Executes a Fusion Tables SQL statement, which can be any of - SELECT - INSERT - UPDATE - DELETE - SHOW - DESCRIBE - CREATE statement. * @alias fusiontables.query.sql * @memberOf! () * @@ -1322,8 +1249,7 @@ export namespace fusiontables_v2 { /** * fusiontables.query.sqlGet - * @desc Executes a SQL statement which can be any of - SELECT - SHOW - - * DESCRIBE + * @desc Executes a SQL statement which can be any of - SELECT - SHOW - DESCRIBE * @alias fusiontables.query.sqlGet * @memberOf! () * @@ -1408,13 +1334,11 @@ export namespace fusiontables_v2 { */ hdrs?: boolean; /** - * A Fusion Tables SQL statement, which can be any of - SELECT - INSERT - - * UPDATE - DELETE - SHOW - DESCRIBE - CREATE + * A Fusion Tables SQL statement, which can be any of - SELECT - INSERT - UPDATE - DELETE - SHOW - DESCRIBE - CREATE */ sql?: string; /** - * Whether typed values are returned in the (JSON) response: numbers for - * numeric values and parsed geometries for KML values. Default is true. + * Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true. */ typed?: boolean; } @@ -1433,8 +1357,7 @@ export namespace fusiontables_v2 { */ sql?: string; /** - * Whether typed values are returned in the (JSON) response: numbers for - * numeric values and parsed geometries for KML values. Default is true. + * Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true. */ typed?: boolean; } @@ -2523,9 +2446,7 @@ export namespace fusiontables_v2 { /** * fusiontables.table.patch - * @desc Updates an existing table. Unless explicitly requested, only the - * name, description, and attribution will be updated. This method supports - * patch semantics. + * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics. * @alias fusiontables.table.patch * @memberOf! () * @@ -2598,9 +2519,7 @@ export namespace fusiontables_v2 { /** * fusiontables.table.refetchSheet - * @desc Replaces rows of the table with the rows of the spreadsheet that is - * first imported from. Current rows remain visible until all replacement - * rows are ready. + * @desc Replaces rows of the table with the rows of the spreadsheet that is first imported from. Current rows remain visible until all replacement rows are ready. * @alias fusiontables.table.refetchSheet * @memberOf! () * @@ -2671,8 +2590,7 @@ export namespace fusiontables_v2 { /** * fusiontables.table.replaceRows - * @desc Replaces rows of an existing table. Current rows remain visible - * until all replacement rows are ready. + * @desc Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready. * @alias fusiontables.table.replaceRows * @memberOf! () * @@ -2754,8 +2672,7 @@ export namespace fusiontables_v2 { /** * fusiontables.table.update - * @desc Updates an existing table. Unless explicitly requested, only the - * name, description, and attribution will be updated. + * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. * @alias fusiontables.table.update * @memberOf! () * @@ -2871,31 +2788,23 @@ export namespace fusiontables_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The delimiter used to separate cell values. This can only consist of a - * single character. Default is ,. + * The delimiter used to separate cell values. This can only consist of a single character. Default is ,. */ delimiter?: string; /** - * The encoding of the content. Default is UTF-8. Use auto-detect if you are - * unsure of the encoding. + * The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding. */ encoding?: string; /** - * The index of the line up to which data will be imported. Default is to - * import the entire file. If endLine is negative, it is an offset from the - * end of the file; the imported content will exclude the last endLine - * lines. + * The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines. */ endLine?: number; /** - * Whether the imported CSV must have the same number of values for each - * row. If false, rows with fewer values will be padded with empty values. - * Default is true. + * Whether the imported CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true. */ isStrict?: boolean; /** - * The index of the first line from which to start importing, inclusive. - * Default is 0. + * The index of the first line from which to start importing, inclusive. Default is 0. */ startLine?: number; /** @@ -2926,13 +2835,11 @@ export namespace fusiontables_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The delimiter used to separate cell values. This can only consist of a - * single character. Default is ,. + * The delimiter used to separate cell values. This can only consist of a single character. Default is ,. */ delimiter?: string; /** - * The encoding of the content. Default is UTF-8. Use auto-detect if you are - * unsure of the encoding. + * The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding. */ encoding?: string; /** @@ -2988,9 +2895,7 @@ export namespace fusiontables_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the view definition is also updated. The specified view - * definition replaces the existing one. Only a view can be updated with a - * new definition. + * Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition. */ replaceViewDefinition?: boolean; /** @@ -3023,32 +2928,23 @@ export namespace fusiontables_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The delimiter used to separate cell values. This can only consist of a - * single character. Default is ,. + * The delimiter used to separate cell values. This can only consist of a single character. Default is ,. */ delimiter?: string; /** - * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you - * are unsure of the encoding. + * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. */ encoding?: string; /** - * The index of the line up to which data will be imported. Default is to - * import the entire file. If endLine is negative, it is an offset from the - * end of the file; the imported content will exclude the last endLine - * lines. + * The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines. */ endLine?: number; /** - * Whether the imported CSV must have the same number of column values for - * each row. If true, throws an exception if the CSV does not have the same - * number of columns. If false, rows with fewer column values will be padded - * with empty values. Default is true. + * Whether the imported CSV must have the same number of column values for each row. If true, throws an exception if the CSV does not have the same number of columns. If false, rows with fewer column values will be padded with empty values. Default is true. */ isStrict?: boolean; /** - * The index of the first line from which to start importing, inclusive. - * Default is 0. + * The index of the first line from which to start importing, inclusive. Default is 0. */ startLine?: number; /** @@ -3078,9 +2974,7 @@ export namespace fusiontables_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the view definition is also updated. The specified view - * definition replaces the existing one. Only a view can be updated with a - * new definition. + * Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition. */ replaceViewDefinition?: boolean; /** @@ -3102,8 +2996,7 @@ export namespace fusiontables_v2 { /** * fusiontables.task.delete - * @desc Deletes a specific task by its ID, unless that task has already - * started running. + * @desc Deletes a specific task by its ID, unless that task has already started running. * @alias fusiontables.task.delete * @memberOf! () * diff --git a/src/apis/games/package.json b/src/apis/games/package.json index d42e9d02076..b7174e8ebb5 100644 --- a/src/apis/games/package.json +++ b/src/apis/games/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index 4d0f39ef226..9373d3f42c8 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace games_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace games_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -109,7 +106,10 @@ export namespace games_v1 { turnBasedMatches: Resource$Turnbasedmatches; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.achievementDefinitions = new Resource$Achievementdefinitions( this.context @@ -136,9 +136,7 @@ export namespace games_v1 { */ export interface Schema$AchievementDefinition { /** - * The type of the achievement. Possible values are: - - * "STANDARD" - Achievement is either locked or unlocked. - - * "INCREMENTAL" - Achievement is incremental. + * The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental. */ achievementType?: string; /** @@ -158,25 +156,19 @@ export namespace games_v1 { */ id?: string; /** - * The initial state of the achievement. Possible values are: - - * "HIDDEN" - Achievement is hidden. - "REVEALED" - - * Achievement is revealed. - "UNLOCKED" - Achievement is - * unlocked. + * The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ initialState?: string; /** - * Indicates whether the revealed icon image being returned is a default - * image, or is provided by the game. + * Indicates whether the revealed icon image being returned is a default image, or is provided by the game. */ isRevealedIconUrlDefault?: boolean; /** - * Indicates whether the unlocked icon image being returned is a default - * image, or is game-provided. + * Indicates whether the unlocked icon image being returned is a default image, or is game-provided. */ isUnlockedIconUrlDefault?: boolean; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementDefinition. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinition. */ kind?: string; /** @@ -205,8 +197,7 @@ export namespace games_v1 { */ items?: Schema$AchievementDefinition[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementDefinitionsListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinitionsListResponse. */ kind?: string; /** @@ -223,13 +214,11 @@ export namespace games_v1 { */ currentSteps?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementIncrementResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementIncrementResponse. */ kind?: string; /** - * Whether the current steps for the achievement has reached the number of - * steps required to unlock. + * Whether the current steps for the achievement has reached the number of steps required to unlock. */ newlyUnlocked?: boolean; } @@ -238,15 +227,11 @@ export namespace games_v1 { */ export interface Schema$AchievementRevealResponse { /** - * The current state of the achievement for which a reveal was attempted. - * This might be UNLOCKED if the achievement was already unlocked. Possible - * values are: - "REVEALED" - Achievement is revealed. - - * "UNLOCKED" - Achievement is unlocked. + * The current state of the achievement for which a reveal was attempted. This might be UNLOCKED if the achievement was already unlocked. Possible values are: - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ currentState?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementRevealResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementRevealResponse. */ kind?: string; } @@ -259,13 +244,11 @@ export namespace games_v1 { */ currentSteps?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementSetStepsAtLeastResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementSetStepsAtLeastResponse. */ kind?: string; /** - * Whether the the current steps for the achievement has reached the number - * of steps required to unlock. + * Whether the the current steps for the achievement has reached the number of steps required to unlock. */ newlyUnlocked?: boolean; } @@ -274,13 +257,11 @@ export namespace games_v1 { */ export interface Schema$AchievementUnlockResponse { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementUnlockResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUnlockResponse. */ kind?: string; /** - * Whether this achievement was newly unlocked (that is, whether the unlock - * request for the achievement was the first for the player). + * Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player). */ newlyUnlocked?: boolean; } @@ -289,8 +270,7 @@ export namespace games_v1 { */ export interface Schema$AchievementUpdateMultipleRequest { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementUpdateMultipleRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateMultipleRequest. */ kind?: string; /** @@ -303,8 +283,7 @@ export namespace games_v1 { */ export interface Schema$AchievementUpdateMultipleResponse { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementUpdateListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateListResponse. */ kind?: string; /** @@ -321,26 +300,19 @@ export namespace games_v1 { */ achievementId?: string; /** - * The payload if an update of type INCREMENT was requested for the - * achievement. + * The payload if an update of type INCREMENT was requested for the achievement. */ incrementPayload?: Schema$GamesAchievementIncrement; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementUpdateRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateRequest. */ kind?: string; /** - * The payload if an update of type SET_STEPS_AT_LEAST was requested for the - * achievement. + * The payload if an update of type SET_STEPS_AT_LEAST was requested for the achievement. */ setStepsAtLeastPayload?: Schema$GamesAchievementSetStepsAtLeast; /** - * The type of update being applied. Possible values are: - - * "REVEAL" - Achievement is revealed. - "UNLOCK" - - * Achievement is unlocked. - "INCREMENT" - Achievement is - * incremented. - "SET_STEPS_AT_LEAST" - Achievement progress is - * set to at least the passed value. + * The type of update being applied. Possible values are: - "REVEAL" - Achievement is revealed. - "UNLOCK" - Achievement is unlocked. - "INCREMENT" - Achievement is incremented. - "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed value. */ updateType?: string; } @@ -353,10 +325,7 @@ export namespace games_v1 { */ achievementId?: string; /** - * The current state of the achievement. Possible values are: - - * "HIDDEN" - Achievement is hidden. - "REVEALED" - - * Achievement is revealed. - "UNLOCKED" - Achievement is - * unlocked. + * The current state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ currentState?: string; /** @@ -364,13 +333,11 @@ export namespace games_v1 { */ currentSteps?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementUpdateResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateResponse. */ kind?: string; /** - * Whether this achievement was newly unlocked (that is, whether the unlock - * request for the achievement was the first for the player). + * Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player). */ newlyUnlocked?: boolean; /** @@ -387,8 +354,7 @@ export namespace games_v1 { */ count?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#aggregateStats. + * Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats. */ kind?: string; /** @@ -417,8 +383,7 @@ export namespace games_v1 { */ displayName?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#anonymousPlayer. + * Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. */ kind?: string; } @@ -447,8 +412,7 @@ export namespace games_v1 { */ description?: string; /** - * A list of features that have been enabled for the application. Possible - * values are: - "SNAPSHOTS" - Snapshots has been enabled + * A list of features that have been enabled for the application. Possible values are: - "SNAPSHOTS" - Snapshots has been enabled */ enabledFeatures?: string[]; /** @@ -460,8 +424,7 @@ export namespace games_v1 { */ instances?: Schema$Instance[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#application. + * Uniquely identifies the type of this resource. Value is always the fixed string games#application. */ kind?: string; /** @@ -477,8 +440,7 @@ export namespace games_v1 { */ name?: string; /** - * A hint to the client UI for what color to use as an app-themed color. The - * color is given as an RGB triplet (e.g. "E0E0E0"). + * A hint to the client UI for what color to use as an app-themed color. The color is given as an RGB triplet (e.g. "E0E0E0"). */ themeColor?: string; } @@ -487,8 +449,7 @@ export namespace games_v1 { */ export interface Schema$ApplicationCategory { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#applicationCategory. + * Uniquely identifies the type of this resource. Value is always the fixed string games#applicationCategory. */ kind?: string; /** @@ -501,18 +462,15 @@ export namespace games_v1 { secondary?: string; } /** - * This is a JSON template for a third party application verification response - * resource. + * This is a JSON template for a third party application verification response resource. */ export interface Schema$ApplicationVerifyResponse { /** - * An alternate ID that was once used for the player that was issued the - * auth token used in this request. (This field is not normally populated.) + * An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.) */ alternate_player_id?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#applicationVerifyResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#applicationVerifyResponse. */ kind?: string; /** @@ -533,8 +491,7 @@ export namespace games_v1 { */ experiencePoints?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#category. + * Uniquely identifies the type of this resource. Value is always the fixed string games#category. */ kind?: string; } @@ -547,8 +504,7 @@ export namespace games_v1 { */ items?: Schema$Category[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#categoryListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#categoryListResponse. */ kind?: string; /** @@ -561,21 +517,11 @@ export namespace games_v1 { */ export interface Schema$EventBatchRecordFailure { /** - * The cause for the update failure. Possible values are: - - * "TOO_LARGE": A batch request was issued with more events than - * are allowed in a single batch. - "TIME_PERIOD_EXPIRED": A - * batch was sent with data too far in the past to record. - - * "TIME_PERIOD_SHORT": A batch was sent with a time range that - * was too short. - "TIME_PERIOD_LONG": A batch was sent with a - * time range that was too long. - "ALREADY_UPDATED": An attempt - * was made to record a batch of data which was already seen. - - * "RECORD_RATE_HIGH": An attempt was made to record data faster - * than the server will apply updates. + * The cause for the update failure. Possible values are: - "TOO_LARGE": A batch request was issued with more events than are allowed in a single batch. - "TIME_PERIOD_EXPIRED": A batch was sent with data too far in the past to record. - "TIME_PERIOD_SHORT": A batch was sent with a time range that was too short. - "TIME_PERIOD_LONG": A batch was sent with a time range that was too long. - "ALREADY_UPDATED": An attempt was made to record a batch of data which was already seen. - "RECORD_RATE_HIGH": An attempt was made to record data faster than the server will apply updates. */ failureCause?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventBatchRecordFailure. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventBatchRecordFailure. */ kind?: string; /** @@ -592,8 +538,7 @@ export namespace games_v1 { */ childId?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventChild. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventChild. */ kind?: string; } @@ -622,20 +567,15 @@ export namespace games_v1 { */ imageUrl?: string; /** - * Indicates whether the icon image being returned is a default image, or is - * game-provided. + * Indicates whether the icon image being returned is a default image, or is game-provided. */ isDefaultImageUrl?: boolean; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventDefinition. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinition. */ kind?: string; /** - * The visibility of event being tracked in this definition. Possible values - * are: - "REVEALED": This event should be visible to all users. - * - "HIDDEN": This event should only be shown to users that have - * recorded this event at least once. + * The visibility of event being tracked in this definition. Possible values are: - "REVEALED": This event should be visible to all users. - "HIDDEN": This event should only be shown to users that have recorded this event at least once. */ visibility?: string; } @@ -648,8 +588,7 @@ export namespace games_v1 { */ items?: Schema$EventDefinition[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventDefinitionListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinitionListResponse. */ kind?: string; /** @@ -662,18 +601,15 @@ export namespace games_v1 { */ export interface Schema$EventPeriodRange { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventPeriodRange. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodRange. */ kind?: string; /** - * The time when this update period ends, in millis, since 1970 UTC (Unix - * Epoch). + * The time when this update period ends, in millis, since 1970 UTC (Unix Epoch). */ periodEndMillis?: string; /** - * The time when this update period begins, in millis, since 1970 UTC (Unix - * Epoch). + * The time when this update period begins, in millis, since 1970 UTC (Unix Epoch). */ periodStartMillis?: string; } @@ -682,8 +618,7 @@ export namespace games_v1 { */ export interface Schema$EventPeriodUpdate { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventPeriodUpdate. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodUpdate. */ kind?: string; /** @@ -704,15 +639,11 @@ export namespace games_v1 { */ eventId?: string; /** - * The cause for the update failure. Possible values are: - - * "NOT_FOUND" - An attempt was made to set an event that was not - * defined. - "INVALID_UPDATE_VALUE" - An attempt was made to - * increment an event by a non-positive value. + * The cause for the update failure. Possible values are: - "NOT_FOUND" - An attempt was made to set an event that was not defined. - "INVALID_UPDATE_VALUE" - An attempt was made to increment an event by a non-positive value. */ failureCause?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventRecordFailure. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordFailure. */ kind?: string; } @@ -721,13 +652,11 @@ export namespace games_v1 { */ export interface Schema$EventRecordRequest { /** - * The current time when this update was sent, in milliseconds, since 1970 - * UTC (Unix Epoch). + * The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch). */ currentTimeMillis?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventRecordRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordRequest. */ kind?: string; /** @@ -748,8 +677,7 @@ export namespace games_v1 { */ definitionId?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventUpdateRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateRequest. */ kind?: string; /** @@ -770,8 +698,7 @@ export namespace games_v1 { */ eventFailures?: Schema$EventRecordFailure[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#eventUpdateResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateResponse. */ kind?: string; /** @@ -780,13 +707,11 @@ export namespace games_v1 { playerEvents?: Schema$PlayerEvent[]; } /** - * This is a JSON template for the payload to request to increment an - * achievement. + * This is a JSON template for the payload to request to increment an achievement. */ export interface Schema$GamesAchievementIncrement { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#GamesAchievementIncrement. + * Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementIncrement. */ kind?: string; /** @@ -799,13 +724,11 @@ export namespace games_v1 { steps?: number; } /** - * This is a JSON template for the payload to request to increment an - * achievement. + * This is a JSON template for the payload to request to increment an achievement. */ export interface Schema$GamesAchievementSetStepsAtLeast { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#GamesAchievementSetStepsAtLeast. + * Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementSetStepsAtLeast. */ kind?: string; /** @@ -822,8 +745,7 @@ export namespace games_v1 { */ height?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#imageAsset. + * Uniquely identifies the type of this resource. Value is always the fixed string games#imageAsset. */ kind?: string; /** @@ -856,8 +778,7 @@ export namespace games_v1 { */ iosInstance?: Schema$InstanceIosDetails; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#instance. + * Uniquely identifies the type of this resource. Value is always the fixed string games#instance. */ kind?: string; /** @@ -865,9 +786,7 @@ export namespace games_v1 { */ name?: string; /** - * The platform type. Possible values are: - "ANDROID" - - * Instance is for Android. - "IOS" - Instance is for iOS - - * "WEB_APP" - Instance is for Web App. + * The platform type. Possible values are: - "ANDROID" - Instance is for Android. - "IOS" - Instance is for iOS - "WEB_APP" - Instance is for Web App. */ platformType?: string; /** @@ -892,8 +811,7 @@ export namespace games_v1 { */ enablePiracyCheck?: boolean; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#instanceAndroidDetails. + * Uniquely identifies the type of this resource. Value is always the fixed string games#instanceAndroidDetails. */ kind?: string; /** @@ -918,18 +836,15 @@ export namespace games_v1 { */ itunesAppId?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#instanceIosDetails. + * Uniquely identifies the type of this resource. Value is always the fixed string games#instanceIosDetails. */ kind?: string; /** - * Indicates that this instance is the default for new installations on iPad - * devices. + * Indicates that this instance is the default for new installations on iPad devices. */ preferredForIpad?: boolean; /** - * Indicates that this instance is the default for new installations on - * iPhone devices. + * Indicates that this instance is the default for new installations on iPhone devices. */ preferredForIphone?: boolean; /** @@ -946,8 +861,7 @@ export namespace games_v1 { */ export interface Schema$InstanceWebDetails { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#instanceWebDetails. + * Uniquely identifies the type of this resource. Value is always the fixed string games#instanceWebDetails. */ kind?: string; /** @@ -972,13 +886,11 @@ export namespace games_v1 { */ id?: string; /** - * Indicates whether the icon image being returned is a default image, or is - * game-provided. + * Indicates whether the icon image being returned is a default image, or is game-provided. */ isIconUrlDefault?: boolean; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#leaderboard. + * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard. */ kind?: string; /** @@ -986,10 +898,7 @@ export namespace games_v1 { */ name?: string; /** - * How scores are ordered. Possible values are: - - * "LARGER_IS_BETTER" - Larger values are better; scores are - * sorted in descending order. - "SMALLER_IS_BETTER" - Smaller - * values are better; scores are sorted in ascending order. + * How scores are ordered. Possible values are: - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order. - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order. */ order?: string; } @@ -1006,8 +915,7 @@ export namespace games_v1 { */ formattedScoreRank?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#leaderboardEntry. + * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardEntry. */ kind?: string; /** @@ -1019,8 +927,7 @@ export namespace games_v1 { */ scoreRank?: string; /** - * Additional information about the score. Values must contain no more than - * 64 URI-safe characters as defined by section 2.3 of RFC 3986. + * Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ scoreTag?: string; /** @@ -1028,15 +935,11 @@ export namespace games_v1 { */ scoreValue?: string; /** - * The time span of this high score. Possible values are: - - * "ALL_TIME" - The score is an all-time high score. - - * "WEEKLY" - The score is a weekly high score. - - * "DAILY" - The score is a daily high score. + * The time span of this high score. Possible values are: - "ALL_TIME" - The score is an all-time high score. - "WEEKLY" - The score is a weekly high score. - "DAILY" - The score is a daily high score. */ timeSpan?: string; /** - * The timestamp at which this score was recorded, in milliseconds since the - * epoch in UTC. + * The timestamp at which this score was recorded, in milliseconds since the epoch in UTC. */ writeTimestampMillis?: string; } @@ -1049,8 +952,7 @@ export namespace games_v1 { */ items?: Schema$Leaderboard[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#leaderboardListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardListResponse. */ kind?: string; /** @@ -1071,8 +973,7 @@ export namespace games_v1 { */ formattedRank?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#leaderboardScoreRank. + * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScoreRank. */ kind?: string; /** @@ -1093,8 +994,7 @@ export namespace games_v1 { */ items?: Schema$LeaderboardEntry[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#leaderboardScores. + * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScores. */ kind?: string; /** @@ -1106,11 +1006,7 @@ export namespace games_v1 { */ numScores?: string; /** - * The score of the requesting player on the leaderboard. The player's - * score may appear both here and in the list of scores above. If you are - * viewing a public leaderboard and the player is not sharing their gameplay - * information publicly, the scoreRank and formattedScoreRank values will - * not be present. + * The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the scoreRank and formattedScoreRank values will not be present. */ playerScore?: Schema$LeaderboardEntry; /** @@ -1123,13 +1019,11 @@ export namespace games_v1 { */ export interface Schema$MetagameConfig { /** - * Current version of the metagame configuration data. When this data is - * updated, the version number will be increased by one. + * Current version of the metagame configuration data. When this data is updated, the version number will be increased by one. */ currentVersion?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#metagameConfig. + * Uniquely identifies the type of this resource. Value is always the fixed string games#metagameConfig. */ kind?: string; /** @@ -1154,28 +1048,19 @@ export namespace games_v1 { */ iosNetworkType?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#networkDiagnostics. + * Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics. */ kind?: string; /** - * The MCC+MNC code for the client's network connection. On Android: - * http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() - * On iOS, see: - * https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html + * The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html */ networkOperatorCode?: string; /** - * The name of the carrier of the client's network connection. On - * Android: - * http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() - * On iOS: - * https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName + * The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName */ networkOperatorName?: string; /** - * The amount of time in milliseconds it took for the client to establish a - * connection with the XMPP server. + * The amount of time in milliseconds it took for the client to establish a connection with the XMPP server. */ registrationLatencyMillis?: number; } @@ -1184,8 +1069,7 @@ export namespace games_v1 { */ export interface Schema$ParticipantResult { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#participantResult. + * Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. */ kind?: string; /** @@ -1193,21 +1077,11 @@ export namespace games_v1 { */ participantId?: string; /** - * The placement or ranking of the participant in the match results; a - * number from one to the number of participants in the match. Multiple - * participants may have the same placing value in case of a type. + * The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. */ placing?: number; /** - * The result of the participant for this match. Possible values are: - - * "MATCH_RESULT_WIN" - The participant won the match. - - * "MATCH_RESULT_LOSS" - The participant lost the match. - - * "MATCH_RESULT_TIE" - The participant tied the match. - - * "MATCH_RESULT_NONE" - There was no winner for the match (nobody - * wins or loses this kind of game.) - "MATCH_RESULT_DISCONNECT" - * - The participant disconnected / left during the match. - - * "MATCH_RESULT_DISAGREED" - Different clients reported different - * results for this participant. + * The result of the participant for this match. Possible values are: - "MATCH_RESULT_WIN" - The participant won the match. - "MATCH_RESULT_LOSS" - The participant lost the match. - "MATCH_RESULT_TIE" - The participant tied the match. - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. */ result?: string; } @@ -1224,8 +1098,7 @@ export namespace games_v1 { */ bytesSent?: Schema$AggregateStats; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#peerChannelDiagnostics. + * Uniquely identifies the type of this resource. Value is always the fixed string games#peerChannelDiagnostics. */ kind?: string; /** @@ -1258,8 +1131,7 @@ export namespace games_v1 { */ connectedTimestampMillis?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#peerSessionDiagnostics. + * Uniquely identifies the type of this resource. Value is always the fixed string games#peerSessionDiagnostics. */ kind?: string; /** @@ -1276,23 +1148,19 @@ export namespace games_v1 { unreliableChannel?: Schema$PeerChannelDiagnostics; } /** - * This is a JSON template for metadata about a player playing a game with the - * currently authenticated user. + * This is a JSON template for metadata about a player playing a game with the currently authenticated user. */ export interface Schema$Played { /** - * True if the player was auto-matched with the currently authenticated - * user. + * True if the player was auto-matched with the currently authenticated user. */ autoMatched?: boolean; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#played. + * Uniquely identifies the type of this resource. Value is always the fixed string games#played. */ kind?: string; /** - * The last time the player played the game in milliseconds since the epoch - * in UTC. + * The last time the player played the game in milliseconds since the epoch in UTC. */ timeMillis?: string; } @@ -1321,26 +1189,19 @@ export namespace games_v1 { */ experienceInfo?: Schema$PlayerExperienceInfo; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#player. + * Uniquely identifies the type of this resource. Value is always the fixed string games#player. */ kind?: string; /** - * Details about the last time this player played a multiplayer game with - * the currently authenticated player. Populated for PLAYED_WITH player - * collection members. + * Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. */ lastPlayedWith?: Schema$Played; /** - * An object representation of the individual components of the player's - * name. For some players, these fields may not be present. + * An object representation of the individual components of the player's name. For some players, these fields may not be present. */ name?: {familyName?: string; givenName?: string}; /** - * The player ID that was used for this player the first time they signed - * into the game in question. This is only populated for calls to player.get - * for the requesting player, only if the player ID has subsequently - * changed, and only to clients that support remapping player IDs. + * The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. */ originalPlayerId?: string; /** @@ -1348,8 +1209,7 @@ export namespace games_v1 { */ playerId?: string; /** - * The player's profile settings. Controls whether or not the - * player's profile is visible to other players. + * The player's profile settings. Controls whether or not the player's profile is visible to other players. */ profileSettings?: Schema$ProfileSettings; /** @@ -1362,9 +1222,7 @@ export namespace games_v1 { */ export interface Schema$PlayerAchievement { /** - * The state of the achievement. Possible values are: - "HIDDEN" - * - Achievement is hidden. - "REVEALED" - Achievement is - * revealed. - "UNLOCKED" - Achievement is unlocked. + * The state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ achievementState?: string; /** @@ -1372,9 +1230,7 @@ export namespace games_v1 { */ currentSteps?: number; /** - * Experience points earned for the achievement. This field is absent for - * achievements that have not yet been unlocked and 0 for achievements that - * have been unlocked by testers but that are unpublished. + * Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished. */ experiencePoints?: string; /** @@ -1386,8 +1242,7 @@ export namespace games_v1 { */ id?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerAchievement. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievement. */ kind?: string; /** @@ -1404,8 +1259,7 @@ export namespace games_v1 { */ items?: Schema$PlayerAchievement[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerAchievementListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievementListResponse. */ kind?: string; /** @@ -1422,14 +1276,11 @@ export namespace games_v1 { */ definitionId?: string; /** - * The current number of times this event has occurred, as a string. The - * formatting of this string depends on the configuration of your event in - * the Play Games Developer Console. + * The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console. */ formattedNumEvents?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerEvent. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerEvent. */ kind?: string; /** @@ -1450,8 +1301,7 @@ export namespace games_v1 { */ items?: Schema$PlayerEvent[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerEventListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerEventListResponse. */ kind?: string; /** @@ -1460,8 +1310,7 @@ export namespace games_v1 { nextPageToken?: string; } /** - * This is a JSON template for 1P/3P metadata about the player's - * experience. + * This is a JSON template for 1P/3P metadata about the player's experience. */ export interface Schema$PlayerExperienceInfo { /** @@ -1473,18 +1322,15 @@ export namespace games_v1 { */ currentLevel?: Schema$PlayerLevel; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerExperienceInfo. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. */ kind?: string; /** - * The timestamp when the player was leveled up, in millis since Unix epoch - * UTC. + * The timestamp when the player was leveled up, in millis since Unix epoch UTC. */ lastLevelUpTimestampMillis?: string; /** - * The next level of the player. If the current level is the maximum level, - * this should be same as the current level. + * The next level of the player. If the current level is the maximum level, this should be same as the current level. */ nextLevel?: Schema$PlayerLevel; } @@ -1493,8 +1339,7 @@ export namespace games_v1 { */ export interface Schema$PlayerLeaderboardScore { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerLeaderboardScore. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScore. */ kind?: string; /** @@ -1502,8 +1347,7 @@ export namespace games_v1 { */ leaderboard_id?: string; /** - * The public rank of the score in this leaderboard. This object will not be - * present if the user is not sharing their scores publicly. + * The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly. */ publicRank?: Schema$LeaderboardScoreRank; /** @@ -1511,8 +1355,7 @@ export namespace games_v1 { */ scoreString?: string; /** - * Additional information about the score. Values must contain no more than - * 64 URI-safe characters as defined by section 2.3 of RFC 3986. + * Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ scoreTag?: string; /** @@ -1524,15 +1367,11 @@ export namespace games_v1 { */ socialRank?: Schema$LeaderboardScoreRank; /** - * The time span of this score. Possible values are: - - * "ALL_TIME" - The score is an all-time score. - - * "WEEKLY" - The score is a weekly score. - "DAILY" - - * The score is a daily score. + * The time span of this score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ timeSpan?: string; /** - * The timestamp at which this score was recorded, in milliseconds since the - * epoch in UTC. + * The timestamp at which this score was recorded, in milliseconds since the epoch in UTC. */ writeTimestamp?: string; } @@ -1545,8 +1384,7 @@ export namespace games_v1 { */ items?: Schema$PlayerLeaderboardScore[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerLeaderboardScoreListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScoreListResponse. */ kind?: string; /** @@ -1563,8 +1401,7 @@ export namespace games_v1 { */ export interface Schema$PlayerLevel { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerLevel. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. */ kind?: string; /** @@ -1589,8 +1426,7 @@ export namespace games_v1 { */ items?: Schema$Player[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerListResponse. */ kind?: string; /** @@ -1607,8 +1443,7 @@ export namespace games_v1 { */ formattedScore?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerScore. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScore. */ kind?: string; /** @@ -1616,15 +1451,11 @@ export namespace games_v1 { */ score?: string; /** - * Additional information about this score. Values will contain no more than - * 64 URI-safe characters as defined by section 2.3 of RFC 3986. + * Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ scoreTag?: string; /** - * The time span for this player score. Possible values are: - - * "ALL_TIME" - The score is an all-time score. - - * "WEEKLY" - The score is a weekly score. - "DAILY" - - * The score is a daily score. + * The time span for this player score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ timeSpan?: string; } @@ -1633,8 +1464,7 @@ export namespace games_v1 { */ export interface Schema$PlayerScoreListResponse { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerScoreListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreListResponse. */ kind?: string; /** @@ -1647,10 +1477,7 @@ export namespace games_v1 { */ export interface Schema$PlayerScoreResponse { /** - * The time spans where the submitted score is better than the existing - * score for that time span. Possible values are: - "ALL_TIME" - - * The score is an all-time score. - "WEEKLY" - The score is a - * weekly score. - "DAILY" - The score is a daily score. + * The time spans where the submitted score is better than the existing score for that time span. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ beatenScoreTimeSpans?: string[]; /** @@ -1658,8 +1485,7 @@ export namespace games_v1 { */ formattedScore?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerScoreResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreResponse. */ kind?: string; /** @@ -1667,15 +1493,11 @@ export namespace games_v1 { */ leaderboardId?: string; /** - * Additional information about this score. Values will contain no more than - * 64 URI-safe characters as defined by section 2.3 of RFC 3986. + * Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ scoreTag?: string; /** - * The scores in time spans that have not been beaten. As an example, the - * submitted score may be better than the player's DAILY score, but not - * better than the player's scores for the WEEKLY or ALL_TIME time - * spans. + * The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's DAILY score, but not better than the player's scores for the WEEKLY or ALL_TIME time spans. */ unbeatenScores?: Schema$PlayerScore[]; } @@ -1684,8 +1506,7 @@ export namespace games_v1 { */ export interface Schema$PlayerScoreSubmissionList { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#playerScoreSubmissionList. + * Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreSubmissionList. */ kind?: string; /** @@ -1698,13 +1519,11 @@ export namespace games_v1 { */ export interface Schema$ProfileSettings { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#profileSettings. + * Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. */ kind?: string; /** - * The player's current profile visibility. This field is visible to - * both 1P and 3P APIs. + * The player's current profile visibility. This field is visible to both 1P and 3P APIs. */ profileVisible?: boolean; } @@ -1713,10 +1532,7 @@ export namespace games_v1 { */ export interface Schema$PushToken { /** - * The revision of the client SDK used by your application, in the same - * format that's used by revisions.check. Used to send backward - * compatible messages. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible - * values of PLATFORM_TYPE are: - IOS - Push token is for iOS + * The revision of the client SDK used by your application, in the same format that's used by revisions.check. Used to send backward compatible messages. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - IOS - Push token is for iOS */ clientRevision?: string; /** @@ -1724,8 +1540,7 @@ export namespace games_v1 { */ id?: Schema$PushTokenId; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#pushToken. + * Uniquely identifies the type of this resource. Value is always the fixed string games#pushToken. */ kind?: string; /** @@ -1742,8 +1557,7 @@ export namespace games_v1 { */ ios?: {apns_device_token?: string; apns_environment?: string}; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#pushTokenId. + * Uniquely identifies the type of this resource. Value is always the fixed string games#pushTokenId. */ kind?: string; } @@ -1752,8 +1566,7 @@ export namespace games_v1 { */ export interface Schema$Quest { /** - * The timestamp at which the user accepted the quest in milliseconds since - * the epoch in UTC. Only present if the player has accepted the quest. + * The timestamp at which the user accepted the quest in milliseconds since the epoch in UTC. Only present if the player has accepted the quest. */ acceptedTimestampMillis?: string; /** @@ -1769,8 +1582,7 @@ export namespace games_v1 { */ description?: string; /** - * The timestamp at which the quest ceases to be active in milliseconds - * since the epoch in UTC. + * The timestamp at which the quest ceases to be active in milliseconds since the epoch in UTC. */ endTimestampMillis?: string; /** @@ -1782,24 +1594,19 @@ export namespace games_v1 { */ id?: string; /** - * Indicates whether the banner image being returned is a default image, or - * is game-provided. + * Indicates whether the banner image being returned is a default image, or is game-provided. */ isDefaultBannerUrl?: boolean; /** - * Indicates whether the icon image being returned is a default image, or is - * game-provided. + * Indicates whether the icon image being returned is a default image, or is game-provided. */ isDefaultIconUrl?: boolean; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#quest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#quest. */ kind?: string; /** - * The timestamp at which the quest was last updated by the user in - * milliseconds since the epoch in UTC. Only present if the player has - * accepted the quest. + * The timestamp at which the quest was last updated by the user in milliseconds since the epoch in UTC. Only present if the player has accepted the quest. */ lastUpdatedTimestampMillis?: string; /** @@ -1811,25 +1618,15 @@ export namespace games_v1 { */ name?: string; /** - * The timestamp at which the user should be notified that the quest will - * end soon in milliseconds since the epoch in UTC. + * The timestamp at which the user should be notified that the quest will end soon in milliseconds since the epoch in UTC. */ notifyTimestampMillis?: string; /** - * The timestamp at which the quest becomes active in milliseconds since the - * epoch in UTC. + * The timestamp at which the quest becomes active in milliseconds since the epoch in UTC. */ startTimestampMillis?: string; /** - * The state of the quest. Possible values are: - "UPCOMING": - * The quest is upcoming. The user can see the quest, but cannot accept it - * until it is open. - "OPEN": The quest is currently open and - * may be accepted at this time. - "ACCEPTED": The user is - * currently participating in this quest. - "COMPLETED": The user - * has completed the quest. - "FAILED": The quest was attempted - * but was not completed before the deadline expired. - - * "EXPIRED": The quest has expired and was not accepted. - - * "DELETED": The quest should be deleted from the local database. + * The state of the quest. Possible values are: - "UPCOMING": The quest is upcoming. The user can see the quest, but cannot accept it until it is open. - "OPEN": The quest is currently open and may be accepted at this time. - "ACCEPTED": The user is currently participating in this quest. - "COMPLETED": The user has completed the quest. - "FAILED": The quest was attempted but was not completed before the deadline expired. - "EXPIRED": The quest has expired and was not accepted. - "DELETED": The quest should be deleted from the local database. */ state?: string; } @@ -1838,14 +1635,11 @@ export namespace games_v1 { */ export interface Schema$QuestContribution { /** - * The formatted value of the contribution as a string. Format depends on - * the configuration for the associated event definition in the Play Games - * Developer Console. + * The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console. */ formattedValue?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#questContribution. + * Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution. */ kind?: string; /** @@ -1858,15 +1652,11 @@ export namespace games_v1 { */ export interface Schema$QuestCriterion { /** - * The total number of times the associated event must be incremented for - * the player to complete this quest. + * The total number of times the associated event must be incremented for the player to complete this quest. */ completionContribution?: Schema$QuestContribution; /** - * The number of increments the player has made toward the completion count - * event increments required to complete the quest. This value will not - * exceed the completion contribution. There will be no currentContribution - * until the player has accepted the quest. + * The number of increments the player has made toward the completion count event increments required to complete the quest. This value will not exceed the completion contribution. There will be no currentContribution until the player has accepted the quest. */ currentContribution?: Schema$QuestContribution; /** @@ -1874,16 +1664,11 @@ export namespace games_v1 { */ eventId?: string; /** - * The value of the event associated with this quest at the time that the - * quest was accepted. This value may change if event increments that took - * place before the start of quest are uploaded after the quest starts. - * There will be no initialPlayerProgress until the player has accepted the - * quest. + * The value of the event associated with this quest at the time that the quest was accepted. This value may change if event increments that took place before the start of quest are uploaded after the quest starts. There will be no initialPlayerProgress until the player has accepted the quest. */ initialPlayerProgress?: Schema$QuestContribution; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#questCriterion. + * Uniquely identifies the type of this resource. Value is always the fixed string games#questCriterion. */ kind?: string; } @@ -1896,8 +1681,7 @@ export namespace games_v1 { */ items?: Schema$Quest[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#questListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#questListResponse. */ kind?: string; /** @@ -1910,9 +1694,7 @@ export namespace games_v1 { */ export interface Schema$QuestMilestone { /** - * The completion reward data of the milestone, represented as a - * Base64-encoded string. This is a developer-specified binary blob with - * size between 0 and 2 KB before encoding. + * The completion reward data of the milestone, represented as a Base64-encoded string. This is a developer-specified binary blob with size between 0 and 2 KB before encoding. */ completionRewardData?: string; /** @@ -1924,17 +1706,11 @@ export namespace games_v1 { */ id?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#questMilestone. + * Uniquely identifies the type of this resource. Value is always the fixed string games#questMilestone. */ kind?: string; /** - * The current state of the milestone. Possible values are: - - * "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has - * not yet been claimed. - "CLAIMED" - The milestone is complete - * and has been claimed. - "NOT_COMPLETED" - The milestone has - * not yet been completed. - "NOT_STARTED" - The milestone is for - * a quest that has not yet been accepted. + * The current state of the milestone. Possible values are: - "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has not yet been claimed. - "CLAIMED" - The milestone is complete and has been claimed. - "NOT_COMPLETED" - The milestone has not yet been completed. - "NOT_STARTED" - The milestone is for a quest that has not yet been accepted. */ state?: string; } @@ -1943,21 +1719,15 @@ export namespace games_v1 { */ export interface Schema$RevisionCheckResponse { /** - * The version of the API this client revision should use when calling API - * methods. + * The version of the API this client revision should use when calling API methods. */ apiVersion?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#revisionCheckResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#revisionCheckResponse. */ kind?: string; /** - * The result of the revision check. Possible values are: - "OK" - * - The revision being used is current. - "DEPRECATED" - There - * is currently a newer version available, but the revision being used still - * works. - "INVALID" - The revision being used is not supported - * in any released version. + * The result of the revision check. Possible values are: - "OK" - The revision being used is current. - "DEPRECATED" - There is currently a newer version available, but the revision being used still works. - "INVALID" - The revision being used is not supported in any released version. */ revisionStatus?: string; } @@ -1974,8 +1744,7 @@ export namespace games_v1 { */ autoMatchingCriteria?: Schema$RoomAutoMatchingCriteria; /** - * Auto-matching status for this room. Not set if the room is not currently - * in the auto-matching queue. + * Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue. */ autoMatchingStatus?: Schema$RoomAutoMatchStatus; /** @@ -1983,19 +1752,15 @@ export namespace games_v1 { */ creationDetails?: Schema$RoomModification; /** - * This short description is generated by our servers and worded relative to - * the player requesting the room. It is intended to be displayed when the - * room is shown in a list (that is, an invitation to a room.) + * This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.) */ description?: string; /** - * The ID of the participant that invited the user to the room. Not set if - * the user was not invited to the room. + * The ID of the participant that invited the user to the room. Not set if the user was not invited to the room. */ inviterId?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#room. + * Uniquely identifies the type of this resource. Value is always the fixed string games#room. */ kind?: string; /** @@ -2003,8 +1768,7 @@ export namespace games_v1 { */ lastUpdateDetails?: Schema$RoomModification; /** - * The participants involved in the room, along with their statuses. - * Includes participants who have left or declined invitations. + * The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations. */ participants?: Schema$RoomParticipant[]; /** @@ -2012,26 +1776,15 @@ export namespace games_v1 { */ roomId?: string; /** - * The version of the room status: an increasing counter, used by the client - * to ignore out-of-order updates to room status. + * The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status. */ roomStatusVersion?: number; /** - * The status of the room. Possible values are: - - * "ROOM_INVITING" - One or more players have been invited and not - * responded. - "ROOM_AUTO_MATCHING" - One or more slots need to - * be filled by auto-matching. - "ROOM_CONNECTING" - Players have - * joined and are connecting to each other (either before or after - * auto-matching). - "ROOM_ACTIVE" - All players have joined and - * connected to each other. - "ROOM_DELETED" - The room should no - * longer be shown on the client. Returned in sync calls when a player joins - * a room (as a tombstone), or for rooms where all joined participants have - * left. + * The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left. */ status?: string; /** - * The variant / mode of the application being played; can be any integer - * value, or left blank. + * The variant / mode of the application being played; can be any integer value, or left blank. */ variant?: number; } @@ -2040,40 +1793,32 @@ export namespace games_v1 { */ export interface Schema$RoomAutoMatchingCriteria { /** - * A bitmask indicating when auto-matches are valid. When ANDed with other - * exclusive bitmasks, the result must be zero. Can be used to support - * exclusive roles within a game. + * A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. */ exclusiveBitmask?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomAutoMatchingCriteria. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria. */ kind?: string; /** - * The maximum number of players that should be added to the room by - * auto-matching. + * The maximum number of players that should be added to the room by auto-matching. */ maxAutoMatchingPlayers?: number; /** - * The minimum number of players that should be added to the room by - * auto-matching. + * The minimum number of players that should be added to the room by auto-matching. */ minAutoMatchingPlayers?: number; } /** - * This is a JSON template for status of room automatching that is in - * progress. + * This is a JSON template for status of room automatching that is in progress. */ export interface Schema$RoomAutoMatchStatus { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomAutoMatchStatus. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus. */ kind?: string; /** - * An estimate for the amount of time (in seconds) that auto-matching is - * expected to take to complete. + * An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete. */ waitEstimateSeconds?: number; } @@ -2082,8 +1827,7 @@ export namespace games_v1 { */ export interface Schema$RoomClientAddress { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomClientAddress. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress. */ kind?: string; /** @@ -2112,8 +1856,7 @@ export namespace games_v1 { */ invitedPlayerIds?: string[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomCreateRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest. */ kind?: string; /** @@ -2121,14 +1864,11 @@ export namespace games_v1 { */ networkDiagnostics?: Schema$NetworkDiagnostics; /** - * A randomly generated numeric ID. This number is used at the server to - * ensure that the request is handled correctly across retries. + * A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries. */ requestId?: string; /** - * The variant / mode of the application to be played. This can be any - * integer value, or left blank. You should use a small number of variants - * to keep the auto-matching pool as large as possible. + * The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible. */ variant?: number; } @@ -2145,8 +1885,7 @@ export namespace games_v1 { */ clientAddress?: Schema$RoomClientAddress; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomJoinRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomJoinRequest. */ kind?: string; /** @@ -2159,13 +1898,11 @@ export namespace games_v1 { */ export interface Schema$RoomLeaveDiagnostics { /** - * Android network subtype. - * http://developer.android.com/reference/android/net/NetworkInfo.html#getSubtype() + * Android network subtype. http://developer.android.com/reference/android/net/NetworkInfo.html#getSubtype() */ androidNetworkSubtype?: number; /** - * Android network type. - * http://developer.android.com/reference/android/net/NetworkInfo.html#getType() + * Android network type. http://developer.android.com/reference/android/net/NetworkInfo.html#getType() */ androidNetworkType?: number; /** @@ -2173,23 +1910,15 @@ export namespace games_v1 { */ iosNetworkType?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomLeaveDiagnostics. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveDiagnostics. */ kind?: string; /** - * The MCC+MNC code for the client's network connection. On Android: - * http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() - * On iOS, see: - * https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html + * The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html */ networkOperatorCode?: string; /** - * The name of the carrier of the client's network connection. On - * Android: - * http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() - * On iOS: - * https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName + * The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName */ networkOperatorName?: string; /** @@ -2206,8 +1935,7 @@ export namespace games_v1 { */ export interface Schema$RoomLeaveRequest { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomLeaveRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveRequest. */ kind?: string; /** @@ -2215,26 +1943,7 @@ export namespace games_v1 { */ leaveDiagnostics?: Schema$RoomLeaveDiagnostics; /** - * Reason for leaving the match. Possible values are: - - * "PLAYER_LEFT" - The player chose to leave the room.. - - * "GAME_LEFT" - The game chose to remove the player from the - * room. - "REALTIME_ABANDONED" - The player switched to another - * application and abandoned the room. - - * "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to - * establish a connection to other peer(s). - - * "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to - * communicate with the server. - "REALTIME_SERVER_ERROR" - The - * client received an error response when it tried to communicate with the - * server. - "REALTIME_TIMEOUT" - The client timed out while - * waiting for a room. - "REALTIME_CLIENT_DISCONNECTING" - The - * client disconnects without first calling Leave. - - * "REALTIME_SIGN_OUT" - The user signed out of G+ while in the - * room. - "REALTIME_GAME_CRASHED" - The game crashed. - - * "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed. - * - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client - * is trying to enter a room. - - * "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is - * trying to enter a new room. + * Reason for leaving the match. Possible values are: - "PLAYER_LEFT" - The player chose to leave the room.. - "GAME_LEFT" - The game chose to remove the player from the room. - "REALTIME_ABANDONED" - The player switched to another application and abandoned the room. - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a connection to other peer(s). - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate with the server. - "REALTIME_SERVER_ERROR" - The client received an error response when it tried to communicate with the server. - "REALTIME_TIMEOUT" - The client timed out while waiting for a room. - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first calling Leave. - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room. - "REALTIME_GAME_CRASHED" - The game crashed. - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed. - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to enter a room. - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a new room. */ reason?: string; } @@ -2247,8 +1956,7 @@ export namespace games_v1 { */ items?: Schema$Room[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomList. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomList. */ kind?: string; /** @@ -2261,13 +1969,11 @@ export namespace games_v1 { */ export interface Schema$RoomModification { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomModification. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification. */ kind?: string; /** - * The timestamp at which they modified the room, in milliseconds since the - * epoch in UTC. + * The timestamp at which they modified the room, in milliseconds since the epoch in UTC. */ modifiedTimestampMillis?: string; /** @@ -2280,17 +1986,11 @@ export namespace games_v1 { */ export interface Schema$RoomP2PStatus { /** - * The amount of time in milliseconds it took to establish connections with - * this peer. + * The amount of time in milliseconds it took to establish connections with this peer. */ connectionSetupLatencyMillis?: number; /** - * The error code in event of a failure. Possible values are: - - * "P2P_FAILED" - The client failed to establish a P2P connection - * with the peer. - "PRESENCE_FAILED" - The client failed to - * register to receive P2P connections. - "RELAY_SERVER_FAILED" - - * The client received an error when trying to use the relay server to - * establish a P2P connection with the peer. + * The error code in event of a failure. Possible values are: - "P2P_FAILED" - The client failed to establish a P2P connection with the peer. - "PRESENCE_FAILED" - The client failed to register to receive P2P connections. - "RELAY_SERVER_FAILED" - The client received an error when trying to use the relay server to establish a P2P connection with the peer. */ error?: string; /** @@ -2298,8 +1998,7 @@ export namespace games_v1 { */ error_reason?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomP2PStatus. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatus. */ kind?: string; /** @@ -2307,15 +2006,11 @@ export namespace games_v1 { */ participantId?: string; /** - * The status of the peer in the room. Possible values are: - - * "CONNECTION_ESTABLISHED" - The client established a P2P - * connection with the peer. - "CONNECTION_FAILED" - The client - * failed to establish directed presence with the peer. + * The status of the peer in the room. Possible values are: - "CONNECTION_ESTABLISHED" - The client established a P2P connection with the peer. - "CONNECTION_FAILED" - The client failed to establish directed presence with the peer. */ status?: string; /** - * The amount of time in milliseconds it took to send packets back and forth - * on the unreliable channel with this peer. + * The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer. */ unreliableRoundtripLatencyMillis?: number; } @@ -2324,8 +2019,7 @@ export namespace games_v1 { */ export interface Schema$RoomP2PStatuses { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomP2PStatuses. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatuses. */ kind?: string; /** @@ -2342,13 +2036,11 @@ export namespace games_v1 { */ autoMatched?: boolean; /** - * Information about a player that has been anonymously auto-matched against - * the requesting player. (Either player or autoMatchedPlayer will be set.) + * Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ autoMatchedPlayer?: Schema$AnonymousPlayer; /** - * The capabilities which can be used when communicating with this - * participant. + * The capabilities which can be used when communicating with this participant. */ capabilities?: string[]; /** @@ -2356,71 +2048,44 @@ export namespace games_v1 { */ clientAddress?: Schema$RoomClientAddress; /** - * True if this participant is in the fully connected set of peers in the - * room. + * True if this participant is in the fully connected set of peers in the room. */ connected?: boolean; /** - * An identifier for the participant in the scope of the room. Cannot be - * used to identify a player across rooms or in other contexts. + * An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts. */ id?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomParticipant. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant. */ kind?: string; /** - * The reason the participant left the room; populated if the participant - * status is PARTICIPANT_LEFT. Possible values are: - - * "PLAYER_LEFT" - The player explicitly chose to leave the room. - * - "GAME_LEFT" - The game chose to remove the player from the - * room. - "ABANDONED" - The player switched to another - * application and abandoned the room. - "PEER_CONNECTION_FAILURE" - * - The client was unable to establish or maintain a connection to other - * peer(s) in the room. - "SERVER_ERROR" - The client received an - * error response when it tried to communicate with the server. - - * "TIMEOUT" - The client timed out while waiting for players to - * join and connect. - "PRESENCE_FAILURE" - The client's XMPP - * connection ended abruptly. + * The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT. Possible values are: - "PLAYER_LEFT" - The player explicitly chose to leave the room. - "GAME_LEFT" - The game chose to remove the player from the room. - "ABANDONED" - The player switched to another application and abandoned the room. - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room. - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server. - "TIMEOUT" - The client timed out while waiting for players to join and connect. - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly. */ leaveReason?: string; /** - * Information about the player. Not populated if this player was - * anonymously auto-matched against the requesting player. (Either player or - * autoMatchedPlayer will be set.) + * Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ player?: Schema$Player; /** - * The status of the participant with respect to the room. Possible values - * are: - "PARTICIPANT_INVITED" - The participant has been - * invited to join the room, but has not yet responded. - - * "PARTICIPANT_JOINED" - The participant has joined the room - * (either after creating it or accepting an invitation.) - - * "PARTICIPANT_DECLINED" - The participant declined an invitation - * to join the room. - "PARTICIPANT_LEFT" - The participant - * joined the room and then left it. + * The status of the participant with respect to the room. Possible values are: - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room. - "PARTICIPANT_LEFT" - The participant joined the room and then left it. */ status?: string; } /** - * This is a JSON template for the status of a room that the player has - * joined. + * This is a JSON template for the status of a room that the player has joined. */ export interface Schema$RoomStatus { /** - * Auto-matching status for this room. Not set if the room is not currently - * in the automatching queue. + * Auto-matching status for this room. Not set if the room is not currently in the automatching queue. */ autoMatchingStatus?: Schema$RoomAutoMatchStatus; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#roomStatus. + * Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus. */ kind?: string; /** - * The participants involved in the room, along with their statuses. - * Includes participants who have left or declined invitations. + * The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations. */ participants?: Schema$RoomParticipant[]; /** @@ -2428,19 +2093,11 @@ export namespace games_v1 { */ roomId?: string; /** - * The status of the room. Possible values are: - - * "ROOM_INVITING" - One or more players have been invited and not - * responded. - "ROOM_AUTO_MATCHING" - One or more slots need to - * be filled by auto-matching. - "ROOM_CONNECTING" - Players have - * joined are connecting to each other (either before or after - * auto-matching). - "ROOM_ACTIVE" - All players have joined and - * connected to each other. - "ROOM_DELETED" - All joined players - * have left. + * The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - All joined players have left. */ status?: string; /** - * The version of the status for the room: an increasing counter, used by - * the client to ignore out-of-order updates to room status. + * The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status. */ statusVersion?: number; } @@ -2449,8 +2106,7 @@ export namespace games_v1 { */ export interface Schema$ScoreSubmission { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#scoreSubmission. + * Uniquely identifies the type of this resource. Value is always the fixed string games#scoreSubmission. */ kind?: string; /** @@ -2462,13 +2118,11 @@ export namespace games_v1 { */ score?: string; /** - * Additional information about this score. Values will contain no more than - * 64 URI-safe characters as defined by section 2.3 of RFC 3986. + * Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ scoreTag?: string; /** - * Signature Values will contain URI-safe characters as defined by - * section 2.3 of RFC 3986. + * Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986. */ signature?: string; } @@ -2485,9 +2139,7 @@ export namespace games_v1 { */ description?: string; /** - * The ID of the file underlying this snapshot in the Drive API. Only - * present if the snapshot is a view on a Drive file and the file is owned - * by the caller. + * The ID of the file underlying this snapshot in the Drive API. Only present if the snapshot is a view on a Drive file and the file is owned by the caller. */ driveId?: string; /** @@ -2499,18 +2151,15 @@ export namespace games_v1 { */ id?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#snapshot. + * Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot. */ kind?: string; /** - * The timestamp (in millis since Unix epoch) of the last modification to - * this snapshot. + * The timestamp (in millis since Unix epoch) of the last modification to this snapshot. */ lastModifiedMillis?: string; /** - * The progress value (64-bit integer set by developer) associated with this - * snapshot. + * The progress value (64-bit integer set by developer) associated with this snapshot. */ progressValue?: string; /** @@ -2518,8 +2167,7 @@ export namespace games_v1 { */ title?: string; /** - * The type of this snapshot. Possible values are: - "SAVE_GAME" - * - A snapshot representing a save game. + * The type of this snapshot. Possible values are: - "SAVE_GAME" - A snapshot representing a save game. */ type?: string; /** @@ -2536,8 +2184,7 @@ export namespace games_v1 { */ height?: number; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#snapshotImage. + * Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage. */ kind?: string; /** @@ -2545,8 +2192,7 @@ export namespace games_v1 { */ mime_type?: string; /** - * The URL of the image. This URL may be invalidated at any time and should - * not be cached. + * The URL of the image. This URL may be invalidated at any time and should not be cached. */ url?: string; /** @@ -2563,13 +2209,11 @@ export namespace games_v1 { */ items?: Schema$Snapshot[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#snapshotListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotListResponse. */ kind?: string; /** - * Token corresponding to the next page of results. If there are no more - * results, the token is omitted. + * Token corresponding to the next page of results. If there are no more results, the token is omitted. */ nextPageToken?: string; } @@ -2578,24 +2222,19 @@ export namespace games_v1 { */ export interface Schema$TurnBasedAutoMatchingCriteria { /** - * A bitmask indicating when auto-matches are valid. When ANDed with other - * exclusive bitmasks, the result must be zero. Can be used to support - * exclusive roles within a game. + * A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. */ exclusiveBitmask?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedAutoMatchingCriteria. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. */ kind?: string; /** - * The maximum number of players that should be added to the match by - * auto-matching. + * The maximum number of players that should be added to the match by auto-matching. */ maxAutoMatchingPlayers?: number; /** - * The minimum number of players that should be added to the match by - * auto-matching. + * The minimum number of players that should be added to the match by auto-matching. */ minAutoMatchingPlayers?: number; } @@ -2620,19 +2259,15 @@ export namespace games_v1 { */ data?: Schema$TurnBasedMatchData; /** - * This short description is generated by our servers based on turn state - * and is localized and worded relative to the player requesting the match. - * It is intended to be displayed when the match is shown in a list. + * This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list. */ description?: string; /** - * The ID of the participant that invited the user to the match. Not set if - * the user was not invited to the match. + * The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. */ inviterId?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatch. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. */ kind?: string; /** @@ -2644,18 +2279,15 @@ export namespace games_v1 { */ matchId?: string; /** - * The number of the match in a chain of rematches. Will be set to 1 for the - * first match and incremented by 1 for each rematch. + * The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch. */ matchNumber?: number; /** - * The version of this match: an increasing counter, used to avoid - * out-of-date updates to the match. + * The version of this match: an increasing counter, used to avoid out-of-date updates to the match. */ matchVersion?: number; /** - * The participants involved in the match, along with their statuses. - * Includes participants who have left or declined invitations. + * The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. */ participants?: Schema$TurnBasedMatchParticipant[]; /** @@ -2663,13 +2295,11 @@ export namespace games_v1 { */ pendingParticipantId?: string; /** - * The data / game state for the previous match; set for the first turn of - * rematches only. + * The data / game state for the previous match; set for the first turn of rematches only. */ previousMatchData?: Schema$TurnBasedMatchData; /** - * The ID of a rematch of this match. Only set for completed matches that - * have been rematched. + * The ID of a rematch of this match. Only set for completed matches that have been rematched. */ rematchId?: string; /** @@ -2677,36 +2307,19 @@ export namespace games_v1 { */ results?: Schema$ParticipantResult[]; /** - * The status of the match. Possible values are: - - * "MATCH_AUTO_MATCHING" - One or more slots need to be filled by - * auto-matching; the match cannot be established until they are filled. - - * "MATCH_ACTIVE" - The match has started. - - * "MATCH_COMPLETE" - The match has finished. - - * "MATCH_CANCELED" - The match was canceled. - - * "MATCH_EXPIRED" - The match expired due to inactivity. - - * "MATCH_DELETED" - The match should no longer be shown on the - * client. Returned only for tombstones for matches when sync is called. + * The status of the match. Possible values are: - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. - "MATCH_ACTIVE" - The match has started. - "MATCH_COMPLETE" - The match has finished. - "MATCH_CANCELED" - The match was canceled. - "MATCH_EXPIRED" - The match expired due to inactivity. - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. */ status?: string; /** - * The status of the current user in the match. Derived from the match type, - * match status, the user's participant status, and the pending - * participant for the match. Possible values are: - - * "USER_INVITED" - The user has been invited to join the match - * and has not responded yet. - "USER_AWAITING_TURN" - The user - * is waiting for their turn. - "USER_TURN" - The user has an - * action to take in the match. - "USER_MATCH_COMPLETED" - The - * match has ended (it is completed, canceled, or expired.) + * The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are: - "USER_INVITED" - The user has been invited to join the match and has not responded yet. - "USER_AWAITING_TURN" - The user is waiting for their turn. - "USER_TURN" - The user has an action to take in the match. - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) */ userMatchStatus?: string; /** - * The variant / mode of the application being played; can be any integer - * value, or left blank. + * The variant / mode of the application being played; can be any integer value, or left blank. */ variant?: number; /** - * The ID of another participant in the match that can be used when - * describing the participants the user is playing with. + * The ID of another participant in the match that can be used when describing the participants the user is playing with. */ withParticipantId?: string; } @@ -2723,19 +2336,15 @@ export namespace games_v1 { */ invitedPlayerIds?: string[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchCreateRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchCreateRequest. */ kind?: string; /** - * A randomly generated numeric ID. This number is used at the server to - * ensure that the request is handled correctly across retries. + * A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries. */ requestId?: string; /** - * The variant / mode of the application to be played. This can be any - * integer value, or left blank. You should use a small number of variants - * to keep the auto-matching pool as large as possible. + * The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible. */ variant?: number; } @@ -2744,18 +2353,15 @@ export namespace games_v1 { */ export interface Schema$TurnBasedMatchData { /** - * The byte representation of the data (limited to 128 kB), as a - * Base64-encoded string with the URL_SAFE encoding option. + * The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. */ data?: string; /** - * True if this match has data available but it wasn't returned in a - * list response; fetching the match individually will retrieve this data. + * True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. */ dataAvailable?: boolean; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchData. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. */ kind?: string; } @@ -2764,13 +2370,11 @@ export namespace games_v1 { */ export interface Schema$TurnBasedMatchDataRequest { /** - * The byte representation of the data (limited to 128 kB), as a - * Base64-encoded string with the URL_SAFE encoding option. + * The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. */ data?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchDataRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchDataRequest. */ kind?: string; } @@ -2783,8 +2387,7 @@ export namespace games_v1 { */ items?: Schema$TurnBasedMatch[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchList. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchList. */ kind?: string; /** @@ -2797,13 +2400,11 @@ export namespace games_v1 { */ export interface Schema$TurnBasedMatchModification { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchModification. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. */ kind?: string; /** - * The timestamp at which they modified the match, in milliseconds since the - * epoch in UTC. + * The timestamp at which they modified the match, in milliseconds since the epoch in UTC. */ modifiedTimestampMillis?: string; /** @@ -2820,41 +2421,23 @@ export namespace games_v1 { */ autoMatched?: boolean; /** - * Information about a player that has been anonymously auto-matched against - * the requesting player. (Either player or autoMatchedPlayer will be set.) + * Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ autoMatchedPlayer?: Schema$AnonymousPlayer; /** - * An identifier for the participant in the scope of the match. Cannot be - * used to identify a player across matches or in other contexts. + * An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. */ id?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchParticipant. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. */ kind?: string; /** - * Information about the player. Not populated if this player was - * anonymously auto-matched against the requesting player. (Either player or - * autoMatchedPlayer will be set.) + * Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) */ player?: Schema$Player; /** - * The status of the participant with respect to the match. Possible values - * are: - "PARTICIPANT_NOT_INVITED_YET" - The participant is - * slated to be invited to the match, but the invitation has not been sent; - * the invite will be sent when it becomes their turn. - - * "PARTICIPANT_INVITED" - The participant has been invited to - * join the match, but has not yet responded. - - * "PARTICIPANT_JOINED" - The participant has joined the match - * (either after creating it or accepting an invitation.) - - * "PARTICIPANT_DECLINED" - The participant declined an invitation - * to join the match. - "PARTICIPANT_LEFT" - The participant - * joined the match and then left it. - "PARTICIPANT_FINISHED" - - * The participant finished playing in the match. - - * "PARTICIPANT_UNRESPONSIVE" - The participant did not take their - * turn in the allotted time. + * The status of the participant with respect to the match. Possible values are: - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. - "PARTICIPANT_LEFT" - The participant joined the match and then left it. - "PARTICIPANT_FINISHED" - The participant finished playing in the match. - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. */ status?: string; } @@ -2863,18 +2446,15 @@ export namespace games_v1 { */ export interface Schema$TurnBasedMatchRematch { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchRematch. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchRematch. */ kind?: string; /** - * The old match that the rematch was created from; will be updated such - * that the rematchId field will point at the new match. + * The old match that the rematch was created from; will be updated such that the rematchId field will point at the new match. */ previousMatch?: Schema$TurnBasedMatch; /** - * The newly created match; a rematch of the old match with the same - * participants. + * The newly created match; a rematch of the old match with the same participants. */ rematch?: Schema$TurnBasedMatch; } @@ -2887,8 +2467,7 @@ export namespace games_v1 { */ data?: Schema$TurnBasedMatchDataRequest; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchResults. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchResults. */ kind?: string; /** @@ -2901,8 +2480,7 @@ export namespace games_v1 { results?: Schema$ParticipantResult[]; } /** - * This is a JSON template for a list of turn-based matches returned from a - * sync. + * This is a JSON template for a list of turn-based matches returned from a sync. */ export interface Schema$TurnBasedMatchSync { /** @@ -2910,13 +2488,11 @@ export namespace games_v1 { */ items?: Schema$TurnBasedMatch[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchSync. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchSync. */ kind?: string; /** - * True if there were more matches available to fetch at the time the - * response was generated (which were not returned due to page size limits.) + * True if there were more matches available to fetch at the time the response was generated (which were not returned due to page size limits.) */ moreAvailable?: boolean; /** @@ -2933,21 +2509,15 @@ export namespace games_v1 { */ data?: Schema$TurnBasedMatchDataRequest; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#turnBasedMatchTurn. + * Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchTurn. */ kind?: string; /** - * The version of this match: an increasing counter, used to avoid - * out-of-date updates to the match. + * The version of this match: an increasing counter, used to avoid out-of-date updates to the match. */ matchVersion?: number; /** - * The ID of the participant who should take their turn next. May be set to - * the current player's participant ID to update match state without - * changing the turn. If not set, the match will wait for other player(s) to - * join via automatching; this is only valid if automatch criteria is set on - * the match with remaining slots for automatched players. + * The ID of the participant who should take their turn next. May be set to the current player's participant ID to update match state without changing the turn. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players. */ pendingParticipantId?: string; /** @@ -3060,9 +2630,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of achievement resources to return in the response, - * used for paging. For any response, the actual number of achievement - * resources returned may be less than the specified maxResults. + * The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -3079,8 +2647,7 @@ export namespace games_v1 { /** * games.achievements.increment - * @desc Increments the steps of the achievement with the given ID for the - * currently authenticated player. + * @desc Increments the steps of the achievement with the given ID for the currently authenticated player. * @alias games.achievements.increment * @memberOf! () * @@ -3164,8 +2731,7 @@ export namespace games_v1 { /** * games.achievements.list - * @desc Lists the progress for all your application's achievements for the - * currently authenticated player. + * @desc Lists the progress for all your application's achievements for the currently authenticated player. * @alias games.achievements.list * @memberOf! () * @@ -3251,8 +2817,7 @@ export namespace games_v1 { /** * games.achievements.reveal - * @desc Sets the state of the achievement with the given ID to REVEALED for - * the currently authenticated player. + * @desc Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player. * @alias games.achievements.reveal * @memberOf! () * @@ -3332,10 +2897,7 @@ export namespace games_v1 { /** * games.achievements.setStepsAtLeast - * @desc Sets the steps for the currently authenticated player towards - * unlocking an achievement. If the steps parameter is less than the current - * number of steps that the player already gained for the achievement, the - * achievement is not modified. + * @desc Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified. * @alias games.achievements.setStepsAtLeast * @memberOf! () * @@ -3499,8 +3061,7 @@ export namespace games_v1 { /** * games.achievements.updateMultiple - * @desc Updates multiple achievements for the currently authenticated - * player. + * @desc Updates multiple achievements for the currently authenticated player. * @alias games.achievements.updateMultiple * @memberOf! () * @@ -3595,9 +3156,7 @@ export namespace games_v1 { */ achievementId?: string; /** - * A randomly generated numeric ID for each request specified by the caller. - * This number is used at the server to ensure that the request is handled - * correctly across retries. + * A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries. */ requestId?: string; /** @@ -3617,9 +3176,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of achievement resources to return in the response, - * used for paging. For any response, the actual number of achievement - * resources returned may be less than the specified maxResults. + * The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -3627,13 +3184,11 @@ export namespace games_v1 { */ pageToken?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; /** - * Tells the server to return only achievements with the specified state. If - * this parameter isn't specified, all achievements are returned. + * Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned. */ state?: string; } @@ -3707,9 +3262,7 @@ export namespace games_v1 { /** * games.applications.get - * @desc Retrieves the metadata of the application with the given ID. If the - * requested application is not available for the specified platformType, - * the returned response will not include any instance data. + * @desc Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data. * @alias games.applications.get * @memberOf! () * @@ -3784,8 +3337,7 @@ export namespace games_v1 { /** * games.applications.played - * @desc Indicate that the the currently authenticated user is playing your - * application. + * @desc Indicate that the the currently authenticated user is playing your application. * @alias games.applications.played * @memberOf! () * @@ -3857,9 +3409,7 @@ export namespace games_v1 { /** * games.applications.verify - * @desc Verifies the auth token provided with this request is for the - * application with the specified ID, and returns the ID of the player it - * was granted for. + * @desc Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for. * @alias games.applications.verify * @memberOf! () * @@ -3990,8 +3540,7 @@ export namespace games_v1 { /** * games.events.listByPlayer - * @desc Returns a list showing the current progress on events in this - * application for the currently authenticated user. + * @desc Returns a list showing the current progress on events in this application for the currently authenticated user. * @alias games.events.listByPlayer * @memberOf! () * @@ -4151,8 +3700,7 @@ export namespace games_v1 { /** * games.events.record - * @desc Records a batch of changes to the number of times events have - * occurred for the currently authenticated user of this application. + * @desc Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application. * @alias games.events.record * @memberOf! () * @@ -4234,9 +3782,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of events to return in the response, used for paging. - * For any response, the actual number of events to return may be less than - * the specified maxResults. + * The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults. */ maxResults?: number; /** @@ -4256,9 +3802,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of event definitions to return in the response, used - * for paging. For any response, the actual number of event definitions to - * return may be less than the specified maxResults. + * The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified maxResults. */ maxResults?: number; /** @@ -4469,9 +4013,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of leaderboards to return in the response. For any - * response, the actual number of leaderboards returned may be less than the - * specified maxResults. + * The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -4563,8 +4105,7 @@ export namespace games_v1 { /** * games.metagame.listCategoriesByPlayer - * @desc List play data aggregated per category for the player corresponding - * to playerId. + * @desc List play data aggregated per category for the player corresponding to playerId. * @alias games.metagame.listCategoriesByPlayer * @memberOf! () * @@ -4667,9 +4208,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of category resources to return in the response, used - * for paging. For any response, the actual number of category resources - * returned may be less than the specified maxResults. + * The maximum number of category resources to return in the response, used for paging. For any response, the actual number of category resources returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -4677,8 +4216,7 @@ export namespace games_v1 { */ pageToken?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; } @@ -4691,8 +4229,7 @@ export namespace games_v1 { /** * games.players.get - * @desc Retrieves the Player resource with the given ID. To retrieve the - * player for the currently authenticated user, set playerId to me. + * @desc Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me. * @alias games.players.get * @memberOf! () * @@ -4849,8 +4386,7 @@ export namespace games_v1 { */ language?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; } @@ -4869,9 +4405,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of player resources to return in the response, used - * for paging. For any response, the actual number of player resources - * returned may be less than the specified maxResults. + * The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -4888,8 +4422,7 @@ export namespace games_v1 { /** * games.pushtokens.remove - * @desc Removes a push token for the current user and application. Removing - * a non-existent push token will report success. + * @desc Removes a push token for the current user and application. Removing a non-existent push token will report success. * @alias games.pushtokens.remove * @memberOf! () * @@ -5065,9 +4598,7 @@ export namespace games_v1 { /** * games.questMilestones.claim - * @desc Report that a reward for the milestone corresponding to milestoneId - * for the quest corresponding to questId has been claimed by the currently - * authorized user. + * @desc Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user. * @alias games.questMilestones.claim * @memberOf! () * @@ -5156,8 +4687,7 @@ export namespace games_v1 { */ questId?: string; /** - * A numeric ID to ensure that the request is handled correctly across - * retries. Your client application must generate this ID randomly. + * A numeric ID to ensure that the request is handled correctly across retries. Your client application must generate this ID randomly. */ requestId?: string; } @@ -5170,8 +4700,7 @@ export namespace games_v1 { /** * games.quests.accept - * @desc Indicates that the currently authorized user will participate in - * the quest. + * @desc Indicates that the currently authorized user will participate in the quest. * @alias games.quests.accept * @memberOf! () * @@ -5243,8 +4772,7 @@ export namespace games_v1 { /** * games.quests.list - * @desc Get a list of quests for your application and the currently - * authenticated player. + * @desc Get a list of quests for your application and the currently authenticated player. * @alias games.quests.list * @memberOf! () * @@ -5345,10 +4873,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of quest resources to return in the response, used for - * paging. For any response, the actual number of quest resources returned - * may be less than the specified maxResults. Acceptable values are 1 to 50, - * inclusive. (Default: 50). + * The maximum number of quest resources to return in the response, used for paging. For any response, the actual number of quest resources returned may be less than the specified maxResults. Acceptable values are 1 to 50, inclusive. (Default: 50). */ maxResults?: number; /** @@ -5356,8 +4881,7 @@ export namespace games_v1 { */ pageToken?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; } @@ -5451,10 +4975,7 @@ export namespace games_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The revision of the client SDK used by your application. Format: - * [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - * - "ANDROID" - Client is running the Android SDK. - "IOS" - Client is - * running the iOS SDK. - "WEB_APP" - Client is running as a Web App. + * The revision of the client SDK used by your application. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - "ANDROID" - Client is running the Android SDK. - "IOS" - Client is running the iOS SDK. - "WEB_APP" - Client is running as a Web App. */ clientRevision?: string; } @@ -5467,8 +4988,7 @@ export namespace games_v1 { /** * games.rooms.create - * @desc Create a room. For internal use by the Games SDK only. Calling this - * method directly is unsupported. + * @desc Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported. * @alias games.rooms.create * @memberOf! () * @@ -5540,8 +5060,7 @@ export namespace games_v1 { /** * games.rooms.decline - * @desc Decline an invitation to join a room. For internal use by the Games - * SDK only. Calling this method directly is unsupported. + * @desc Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. * @alias games.rooms.decline * @memberOf! () * @@ -5613,8 +5132,7 @@ export namespace games_v1 { /** * games.rooms.dismiss - * @desc Dismiss an invitation to join a room. For internal use by the Games - * SDK only. Calling this method directly is unsupported. + * @desc Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. * @alias games.rooms.dismiss * @memberOf! () * @@ -5757,8 +5275,7 @@ export namespace games_v1 { /** * games.rooms.join - * @desc Join a room. For internal use by the Games SDK only. Calling this - * method directly is unsupported. + * @desc Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. * @alias games.rooms.join * @memberOf! () * @@ -5831,8 +5348,7 @@ export namespace games_v1 { /** * games.rooms.leave - * @desc Leave a room. For internal use by the Games SDK only. Calling this - * method directly is unsupported. + * @desc Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported. * @alias games.rooms.leave * @memberOf! () * @@ -5975,9 +5491,7 @@ export namespace games_v1 { /** * games.rooms.reportStatus - * @desc Updates sent by a client reporting the status of peers in a room. - * For internal use by the Games SDK only. Calling this method directly is - * unsupported. + * @desc Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported. * @alias games.rooms.reportStatus * @memberOf! () * @@ -6160,9 +5674,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of rooms to return in the response, used for paging. - * For any response, the actual number of rooms to return may be less than - * the specified maxResults. + * The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return may be less than the specified maxResults. */ maxResults?: number; /** @@ -6200,11 +5712,7 @@ export namespace games_v1 { /** * games.scores.get - * @desc Get high scores, and optionally ranks, in leaderboards for the - * currently authenticated player. For a specific time span, leaderboardId - * can be set to ALL to retrieve data for all leaderboards in a given time - * span. NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in - * the same request; only one parameter may be set to 'ALL'. + * @desc Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span. NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'. * @alias games.scores.get * @memberOf! () * @@ -6370,8 +5878,7 @@ export namespace games_v1 { /** * games.scores.listWindow - * @desc Lists the scores in a leaderboard around (and including) a player's - * score. + * @desc Lists the scores in a leaderboard around (and including) a player's score. * @alias games.scores.listWindow * @memberOf! () * @@ -6612,8 +6119,7 @@ export namespace games_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The types of ranks to return. If the parameter is omitted, no ranks will - * be returned. + * The types of ranks to return. If the parameter is omitted, no ranks will be returned. */ includeRankType?: string; /** @@ -6621,14 +6127,11 @@ export namespace games_v1 { */ language?: string; /** - * The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all - * leaderboards for this application. + * The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application. */ leaderboardId?: string; /** - * The maximum number of leaderboard scores to return in the response. For - * any response, the actual number of leaderboard scores returned may be - * less than the specified maxResults. + * The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -6636,8 +6139,7 @@ export namespace games_v1 { */ pageToken?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; /** @@ -6664,9 +6166,7 @@ export namespace games_v1 { */ leaderboardId?: string; /** - * The maximum number of leaderboard scores to return in the response. For - * any response, the actual number of leaderboard scores returned may be - * less than the specified maxResults. + * The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -6698,9 +6198,7 @@ export namespace games_v1 { */ leaderboardId?: string; /** - * The maximum number of leaderboard scores to return in the response. For - * any response, the actual number of leaderboard scores returned may be - * less than the specified maxResults. + * The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -6708,15 +6206,11 @@ export namespace games_v1 { */ pageToken?: string; /** - * The preferred number of scores to return above the player's score. More - * scores may be returned if the player is at the bottom of the leaderboard; - * fewer may be returned if the player is at the top. Must be less than or - * equal to maxResults. + * The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults. */ resultsAbove?: number; /** - * True if the top scores should be returned when the player is not in the - * leaderboard. Defaults to true. + * True if the top scores should be returned when the player is not in the leaderboard. Defaults to true. */ returnTopIfAbsent?: boolean; /** @@ -6739,18 +6233,11 @@ export namespace games_v1 { */ leaderboardId?: string; /** - * The score you're submitting. The submitted score is ignored if it is - * worse than a previously submitted score, where worse depends on the - * leaderboard sort order. The meaning of the score value depends on the - * leaderboard format type. For fixed-point, the score represents the raw - * value. For time, the score represents elapsed time in milliseconds. For - * currency, the score represents a value in micro units. + * The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units. */ score?: string; /** - * Additional information about the score you're submitting. Values must - * contain no more than 64 URI-safe characters as defined by section 2.3 of - * RFC 3986. + * Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. */ scoreTag?: string; } @@ -6852,8 +6339,7 @@ export namespace games_v1 { /** * games.snapshots.list - * @desc Retrieves a list of snapshots created by your application for the - * player corresponding to the player ID. + * @desc Retrieves a list of snapshots created by your application for the player corresponding to the player ID. * @alias games.snapshots.list * @memberOf! () * @@ -6956,9 +6442,7 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of snapshot resources to return in the response, used - * for paging. For any response, the actual number of snapshot resources - * returned may be less than the specified maxResults. + * The maximum number of snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot resources returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -6966,8 +6450,7 @@ export namespace games_v1 { */ pageToken?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; } @@ -7200,8 +6683,7 @@ export namespace games_v1 { /** * games.turnBasedMatches.dismiss - * @desc Dismiss a turn-based match from the match list. The match will no - * longer show up in the list and will not generate notifications. + * @desc Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications. * @alias games.turnBasedMatches.dismiss * @memberOf! () * @@ -7272,9 +6754,7 @@ export namespace games_v1 { /** * games.turnBasedMatches.finish - * @desc Finish a turn-based match. Each player should make this call once, - * after all results are in. Only the player whose turn it is may make the - * first call to Finish, and can pass in the final match state. + * @desc Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state. * @alias games.turnBasedMatches.finish * @memberOf! () * @@ -7499,8 +6979,7 @@ export namespace games_v1 { /** * games.turnBasedMatches.leave - * @desc Leave a turn-based match when it is not the current player's turn, - * without canceling the match. + * @desc Leave a turn-based match when it is not the current player's turn, without canceling the match. * @alias games.turnBasedMatches.leave * @memberOf! () * @@ -7574,8 +7053,7 @@ export namespace games_v1 { /** * games.turnBasedMatches.leaveTurn - * @desc Leave a turn-based match during the current player's turn, without - * canceling the match. + * @desc Leave a turn-based match during the current player's turn, without canceling the match. * @alias games.turnBasedMatches.leaveTurn * @memberOf! () * @@ -7729,10 +7207,7 @@ export namespace games_v1 { /** * games.turnBasedMatches.rematch - * @desc Create a rematch of a match that was previously completed, with the - * same participants. This can be called by only one player on a match still - * in their list; the player must have called Finish first. Returns the - * newly created match; it will be the caller's turn. + * @desc Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn. * @alias games.turnBasedMatches.rematch * @memberOf! () * @@ -7809,10 +7284,7 @@ export namespace games_v1 { /** * games.turnBasedMatches.sync - * @desc Returns turn-based matches the player is or was involved in that - * changed since the last sync call, with the least recent changes coming - * first. Matches that should be removed from the local cache will have a - * status of MATCH_DELETED. + * @desc Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED. * @alias games.turnBasedMatches.sync * @memberOf! () * @@ -8114,10 +7586,7 @@ export namespace games_v1 { */ matchVersion?: number; /** - * The ID of another participant who should take their turn next. If not - * set, the match will wait for other player(s) to join via automatching; - * this is only valid if automatch criteria is set on the match with - * remaining slots for automatched players. + * The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players. */ pendingParticipantId?: string; } @@ -8129,11 +7598,7 @@ export namespace games_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * True if match data should be returned in the response. Note that not all - * data will necessarily be returned if include_match_data is true; the - * server may decide to only return data for some of the matches to limit - * download size for the client. The remainder of the data for these matches - * will be retrievable on request. + * True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request. */ includeMatchData?: boolean; /** @@ -8141,15 +7606,11 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of completed or canceled matches to return in the - * response. If not set, all matches returned could be completed or - * canceled. + * The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled. */ maxCompletedMatches?: number; /** - * The maximum number of matches to return in the response, used for paging. - * For any response, the actual number of matches to return may be less than - * the specified maxResults. + * The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults. */ maxResults?: number; /** @@ -8173,9 +7634,7 @@ export namespace games_v1 { */ matchId?: string; /** - * A randomly generated numeric ID for each request specified by the caller. - * This number is used at the server to ensure that the request is handled - * correctly across retries. + * A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries. */ requestId?: string; } @@ -8187,11 +7646,7 @@ export namespace games_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * True if match data should be returned in the response. Note that not all - * data will necessarily be returned if include_match_data is true; the - * server may decide to only return data for some of the matches to limit - * download size for the client. The remainder of the data for these matches - * will be retrievable on request. + * True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request. */ includeMatchData?: boolean; /** @@ -8199,15 +7654,11 @@ export namespace games_v1 { */ language?: string; /** - * The maximum number of completed or canceled matches to return in the - * response. If not set, all matches returned could be completed or - * canceled. + * The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled. */ maxCompletedMatches?: number; /** - * The maximum number of matches to return in the response, used for paging. - * For any response, the actual number of matches to return may be less than - * the specified maxResults. + * The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults. */ maxResults?: number; /** diff --git a/src/apis/gamesConfiguration/package.json b/src/apis/gamesConfiguration/package.json index 227b73576d4..d9b3eae0573 100644 --- a/src/apis/gamesConfiguration/package.json +++ b/src/apis/gamesConfiguration/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/gamesConfiguration/v1configuration.ts b/src/apis/gamesConfiguration/v1configuration.ts index f46448509ca..4f763ce15f6 100644 --- a/src/apis/gamesConfiguration/v1configuration.ts +++ b/src/apis/gamesConfiguration/v1configuration.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace gamesConfiguration_v1configuration { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace gamesConfiguration_v1configuration { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -97,7 +94,10 @@ export namespace gamesConfiguration_v1configuration { leaderboardConfigurations: Resource$Leaderboardconfigurations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.achievementConfigurations = new Resource$Achievementconfigurations( this.context @@ -114,9 +114,7 @@ export namespace gamesConfiguration_v1configuration { */ export interface Schema$AchievementConfiguration { /** - * The type of the achievement. Possible values are: - - * "STANDARD" - Achievement is either locked or unlocked. - - * "INCREMENTAL" - Achievement is incremental. + * The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental. */ achievementType?: string; /** @@ -128,15 +126,11 @@ export namespace gamesConfiguration_v1configuration { */ id?: string; /** - * The initial state of the achievement. Possible values are: - - * "HIDDEN" - Achievement is hidden. - "REVEALED" - - * Achievement is revealed. - "UNLOCKED" - Achievement is - * unlocked. + * The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ initialState?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesConfiguration#achievementConfiguration. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration. */ kind?: string; /** @@ -165,8 +159,7 @@ export namespace gamesConfiguration_v1configuration { */ iconUrl?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesConfiguration#achievementConfigurationDetail. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail. */ kind?: string; /** @@ -191,8 +184,7 @@ export namespace gamesConfiguration_v1configuration { */ items?: Schema$AchievementConfiguration[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#achievementConfigurationListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementConfigurationListResponse. */ kind?: string; /** @@ -205,35 +197,27 @@ export namespace gamesConfiguration_v1configuration { */ export interface Schema$GamesNumberAffixConfiguration { /** - * When the language requires special treatment of "small" numbers - * (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, - * 13, or 14 in Polish). + * When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish). */ few?: Schema$LocalizedStringBundle; /** - * When the language requires special treatment of "large" numbers - * (as with numbers ending 11-99 in Maltese). + * When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese). */ many?: Schema$LocalizedStringBundle; /** - * When the language requires special treatment of numbers like one (as with - * the number 1 in English and most other languages; in Russian, any number - * ending in 1 but not ending in 11 is in this class). + * When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class). */ one?: Schema$LocalizedStringBundle; /** - * When the language does not require special treatment of the given - * quantity (as with all numbers in Chinese, or 42 in English). + * When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English). */ other?: Schema$LocalizedStringBundle; /** - * When the language requires special treatment of numbers like two (as with - * 2 in Welsh, or 102 in Slovenian). + * When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian). */ two?: Schema$LocalizedStringBundle; /** - * When the language requires special treatment of the number 0 (as in - * Arabic). + * When the language requires special treatment of the number 0 (as in Arabic). */ zero?: Schema$LocalizedStringBundle; } @@ -246,22 +230,15 @@ export namespace gamesConfiguration_v1configuration { */ currencyCode?: string; /** - * The formatting for the number. Possible values are: - - * "NUMERIC" - Numbers are formatted to have no digits or a fixed - * number of digits after the decimal point according to locale. An optional - * custom unit can be added. - "TIME_DURATION" - Numbers are - * formatted to hours, minutes and seconds. - "CURRENCY" - Numbers - * are formatted to currency according to locale. + * The formatting for the number. Possible values are: - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added. - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds. - "CURRENCY" - Numbers are formatted to currency according to locale. */ numberFormatType?: string; /** - * The number of decimal places for number. Only used for NUMERIC format - * type. + * The number of decimal places for number. Only used for NUMERIC format type. */ numDecimalPlaces?: number; /** - * An optional suffix for the NUMERIC format type. These strings follow the - * same plural rules as all Android string resources. + * An optional suffix for the NUMERIC format type. These strings follow the same plural rules as all Android string resources. */ suffix?: Schema$GamesNumberAffixConfiguration; } @@ -274,8 +251,7 @@ export namespace gamesConfiguration_v1configuration { */ imageType?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesConfiguration#imageConfiguration. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#imageConfiguration. */ kind?: string; /** @@ -300,8 +276,7 @@ export namespace gamesConfiguration_v1configuration { */ id?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesConfiguration#leaderboardConfiguration. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration. */ kind?: string; /** @@ -317,9 +292,7 @@ export namespace gamesConfiguration_v1configuration { */ scoreMin?: string; /** - * The type of the leaderboard. Possible values are: - - * "LARGER_IS_BETTER" - Larger scores posted are ranked higher. - - * "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher. + * The type of the leaderboard. Possible values are: - "LARGER_IS_BETTER" - Larger scores posted are ranked higher. - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher. */ scoreOrder?: string; /** @@ -336,8 +309,7 @@ export namespace gamesConfiguration_v1configuration { */ iconUrl?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesConfiguration#leaderboardConfigurationDetail. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail. */ kind?: string; /** @@ -362,8 +334,7 @@ export namespace gamesConfiguration_v1configuration { */ items?: Schema$LeaderboardConfiguration[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string games#leaderboardConfigurationListResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardConfigurationListResponse. */ kind?: string; /** @@ -376,8 +347,7 @@ export namespace gamesConfiguration_v1configuration { */ export interface Schema$LocalizedString { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesConfiguration#localizedString. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString. */ kind?: string; /** @@ -394,8 +364,7 @@ export namespace gamesConfiguration_v1configuration { */ export interface Schema$LocalizedStringBundle { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesConfiguration#localizedStringBundle. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle. */ kind?: string; /** @@ -483,8 +452,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.achievementConfigurations.get - * @desc Retrieves the metadata of the achievement configuration with the - * given ID. + * @desc Retrieves the metadata of the achievement configuration with the given ID. * @alias gamesConfiguration.achievementConfigurations.get * @memberOf! () * @@ -638,8 +606,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.achievementConfigurations.list - * @desc Returns a list of the achievement configurations in this - * application. + * @desc Returns a list of the achievement configurations in this application. * @alias gamesConfiguration.achievementConfigurations.list * @memberOf! () * @@ -732,8 +699,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.achievementConfigurations.patch - * @desc Update the metadata of the achievement configuration with the given - * ID. This method supports patch semantics. + * @desc Update the metadata of the achievement configuration with the given ID. This method supports patch semantics. * @alias gamesConfiguration.achievementConfigurations.patch * @memberOf! () * @@ -811,8 +777,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.achievementConfigurations.update - * @desc Update the metadata of the achievement configuration with the given - * ID. + * @desc Update the metadata of the achievement configuration with the given ID. * @alias gamesConfiguration.achievementConfigurations.update * @memberOf! () * @@ -942,9 +907,7 @@ export namespace gamesConfiguration_v1configuration { */ applicationId?: string; /** - * The maximum number of resource configurations to return in the response, - * used for paging. For any response, the actual number of resources - * returned may be less than the specified maxResults. + * The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -1187,8 +1150,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.leaderboardConfigurations.get - * @desc Retrieves the metadata of the leaderboard configuration with the - * given ID. + * @desc Retrieves the metadata of the leaderboard configuration with the given ID. * @alias gamesConfiguration.leaderboardConfigurations.get * @memberOf! () * @@ -1342,8 +1304,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.leaderboardConfigurations.list - * @desc Returns a list of the leaderboard configurations in this - * application. + * @desc Returns a list of the leaderboard configurations in this application. * @alias gamesConfiguration.leaderboardConfigurations.list * @memberOf! () * @@ -1436,8 +1397,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.leaderboardConfigurations.patch - * @desc Update the metadata of the leaderboard configuration with the given - * ID. This method supports patch semantics. + * @desc Update the metadata of the leaderboard configuration with the given ID. This method supports patch semantics. * @alias gamesConfiguration.leaderboardConfigurations.patch * @memberOf! () * @@ -1515,8 +1475,7 @@ export namespace gamesConfiguration_v1configuration { /** * gamesConfiguration.leaderboardConfigurations.update - * @desc Update the metadata of the leaderboard configuration with the given - * ID. + * @desc Update the metadata of the leaderboard configuration with the given ID. * @alias gamesConfiguration.leaderboardConfigurations.update * @memberOf! () * @@ -1646,9 +1605,7 @@ export namespace gamesConfiguration_v1configuration { */ applicationId?: string; /** - * The maximum number of resource configurations to return in the response, - * used for paging. For any response, the actual number of resources - * returned may be less than the specified maxResults. + * The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults. */ maxResults?: number; /** diff --git a/src/apis/gamesManagement/package.json b/src/apis/gamesManagement/package.json index 9b4ecd76831..b3da5d6e11b 100644 --- a/src/apis/gamesManagement/package.json +++ b/src/apis/gamesManagement/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index 53ac6f3e9e9..8bf8ed9611c 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace gamesManagement_v1management { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace gamesManagement_v1management { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -102,7 +99,10 @@ export namespace gamesManagement_v1management { turnBasedMatches: Resource$Turnbasedmatches; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.achievements = new Resource$Achievements(this.context); this.applications = new Resource$Applications(this.context); @@ -120,8 +120,7 @@ export namespace gamesManagement_v1management { */ export interface Schema$AchievementResetAllResponse { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#achievementResetAllResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse. */ kind?: string; /** @@ -138,8 +137,7 @@ export namespace gamesManagement_v1management { */ achievement_ids?: string[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#achievementResetMultipleForAllRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetMultipleForAllRequest. */ kind?: string; } @@ -148,10 +146,7 @@ export namespace gamesManagement_v1management { */ export interface Schema$AchievementResetResponse { /** - * The current state of the achievement. This is the same as the initial - * state of the achievement. Possible values are: - "HIDDEN"- - * Achievement is hidden. - "REVEALED" - Achievement is revealed. - * - "UNLOCKED" - Achievement is unlocked. + * The current state of the achievement. This is the same as the initial state of the achievement. Possible values are: - "HIDDEN"- Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. */ currentState?: string; /** @@ -159,8 +154,7 @@ export namespace gamesManagement_v1management { */ definitionId?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#achievementResetResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse. */ kind?: string; /** @@ -177,30 +171,25 @@ export namespace gamesManagement_v1management { */ event_ids?: string[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#eventsResetMultipleForAllRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#eventsResetMultipleForAllRequest. */ kind?: string; } /** - * This is a JSON template for metadata about a player playing a game with the - * currently authenticated user. + * This is a JSON template for metadata about a player playing a game with the currently authenticated user. */ export interface Schema$GamesPlayedResource { /** - * True if the player was auto-matched with the currently authenticated - * user. + * True if the player was auto-matched with the currently authenticated user. */ autoMatched?: boolean; /** - * The last time the player played the game in milliseconds since the epoch - * in UTC. + * The last time the player played the game in milliseconds since the epoch in UTC. */ timeMillis?: string; } /** - * This is a JSON template for 1P/3P metadata about the player's - * experience. + * This is a JSON template for 1P/3P metadata about the player's experience. */ export interface Schema$GamesPlayerExperienceInfoResource { /** @@ -212,13 +201,11 @@ export namespace gamesManagement_v1management { */ currentLevel?: Schema$GamesPlayerLevelResource; /** - * The timestamp when the player was leveled up, in millis since Unix epoch - * UTC. + * The timestamp when the player was leveled up, in millis since Unix epoch UTC. */ lastLevelUpTimestampMillis?: string; /** - * The next level of the player. If the current level is the maximum level, - * this should be same as the current level. + * The next level of the player. If the current level is the maximum level, this should be same as the current level. */ nextLevel?: Schema$GamesPlayerLevelResource; } @@ -248,8 +235,7 @@ export namespace gamesManagement_v1management { */ hiddenTimeMillis?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#hiddenPlayer. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayer. */ kind?: string; /** @@ -266,8 +252,7 @@ export namespace gamesManagement_v1management { */ items?: Schema$HiddenPlayer[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#hiddenPlayerList. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayerList. */ kind?: string; /** @@ -300,26 +285,19 @@ export namespace gamesManagement_v1management { */ experienceInfo?: Schema$GamesPlayerExperienceInfoResource; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#player. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player. */ kind?: string; /** - * Details about the last time this player played a multiplayer game with - * the currently authenticated player. Populated for PLAYED_WITH player - * collection members. + * Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. */ lastPlayedWith?: Schema$GamesPlayedResource; /** - * An object representation of the individual components of the player's - * name. For some players, these fields may not be present. + * An object representation of the individual components of the player's name. For some players, these fields may not be present. */ name?: {familyName?: string; givenName?: string}; /** - * The player ID that was used for this player the first time they signed - * into the game in question. This is only populated for calls to player.get - * for the requesting player, only if the player ID has subsequently - * changed, and only to clients that support remapping player IDs. + * The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. */ originalPlayerId?: string; /** @@ -327,8 +305,7 @@ export namespace gamesManagement_v1management { */ playerId?: string; /** - * The player's profile settings. Controls whether or not the - * player's profile is visible to other players. + * The player's profile settings. Controls whether or not the player's profile is visible to other players. */ profileSettings?: Schema$ProfileSettings; /** @@ -341,8 +318,7 @@ export namespace gamesManagement_v1management { */ export interface Schema$PlayerScoreResetAllResponse { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#playerScoreResetResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse. */ kind?: string; /** @@ -359,15 +335,11 @@ export namespace gamesManagement_v1management { */ definitionId?: string; /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#playerScoreResetResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse. */ kind?: string; /** - * The time spans of the updated score. Possible values are: - - * "ALL_TIME" - The score is an all-time score. - - * "WEEKLY" - The score is a weekly score. - "DAILY" - - * The score is a daily score. + * The time spans of the updated score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. */ resetScoreTimeSpans?: string[]; } @@ -376,13 +348,11 @@ export namespace gamesManagement_v1management { */ export interface Schema$ProfileSettings { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#profileSettings. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#profileSettings. */ kind?: string; /** - * The player's current profile visibility. This field is visible to - * both 1P and 3P APIs. + * The player's current profile visibility. This field is visible to both 1P and 3P APIs. */ profileVisible?: boolean; } @@ -391,8 +361,7 @@ export namespace gamesManagement_v1management { */ export interface Schema$QuestsResetMultipleForAllRequest { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#questsResetMultipleForAllRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#questsResetMultipleForAllRequest. */ kind?: string; /** @@ -405,8 +374,7 @@ export namespace gamesManagement_v1management { */ export interface Schema$ScoresResetMultipleForAllRequest { /** - * Uniquely identifies the type of this resource. Value is always the fixed - * string gamesManagement#scoresResetMultipleForAllRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#scoresResetMultipleForAllRequest. */ kind?: string; /** @@ -423,9 +391,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.achievements.reset - * @desc Resets the achievement with the given ID for the currently - * authenticated player. This method is only accessible to whitelisted - * tester accounts for your application. + * @desc Resets the achievement with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.achievements.reset * @memberOf! () * @@ -502,9 +468,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.achievements.resetAll - * @desc Resets all achievements for the currently authenticated player for - * your application. This method is only accessible to whitelisted tester - * accounts for your application. + * @desc Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.achievements.resetAll * @memberOf! () * @@ -584,8 +548,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.achievements.resetAllForAllPlayers - * @desc Resets all draft achievements for all players. This method is only - * available to user accounts for your developer console. + * @desc Resets all draft achievements for all players. This method is only available to user accounts for your developer console. * @alias gamesManagement.achievements.resetAllForAllPlayers * @memberOf! () * @@ -655,9 +618,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.achievements.resetForAllPlayers - * @desc Resets the achievement with the given ID for all players. This - * method is only available to user accounts for your developer console. - * Only draft achievements can be reset. + * @desc Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset. * @alias gamesManagement.achievements.resetForAllPlayers * @memberOf! () * @@ -729,9 +690,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.achievements.resetMultipleForAllPlayers - * @desc Resets achievements with the given IDs for all players. This method - * is only available to user accounts for your developer console. Only draft - * achievements may be reset. + * @desc Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset. * @alias gamesManagement.achievements.resetMultipleForAllPlayers * @memberOf! () * @@ -861,8 +820,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.applications.listHidden - * @desc Get the list of players hidden from the given application. This - * method is only available to user accounts for your developer console. + * @desc Get the list of players hidden from the given application. This method is only available to user accounts for your developer console. * @alias gamesManagement.applications.listHidden * @memberOf! () * @@ -949,9 +907,7 @@ export namespace gamesManagement_v1management { */ applicationId?: string; /** - * The maximum number of player resources to return in the response, used - * for paging. For any response, the actual number of player resources - * returned may be less than the specified maxResults. + * The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults. */ maxResults?: number; /** @@ -968,10 +924,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.reset - * @desc Resets all player progress on the event with the given ID for the - * currently authenticated player. This method is only accessible to - * whitelisted tester accounts for your application. All quests for this - * player that use the event will also be reset. + * @desc Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player that use the event will also be reset. * @alias gamesManagement.events.reset * @memberOf! () * @@ -1041,10 +994,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetAll - * @desc Resets all player progress on all events for the currently - * authenticated player. This method is only accessible to whitelisted - * tester accounts for your application. All quests for this player will - * also be reset. + * @desc Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player will also be reset. * @alias gamesManagement.events.resetAll * @memberOf! () * @@ -1114,9 +1064,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetAllForAllPlayers - * @desc Resets all draft events for all players. This method is only - * available to user accounts for your developer console. All quests that - * use any of these events will also be reset. + * @desc Resets all draft events for all players. This method is only available to user accounts for your developer console. All quests that use any of these events will also be reset. * @alias gamesManagement.events.resetAllForAllPlayers * @memberOf! () * @@ -1186,9 +1134,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetForAllPlayers - * @desc Resets the event with the given ID for all players. This method is - * only available to user accounts for your developer console. Only draft - * events can be reset. All quests that use the event will also be reset. + * @desc Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset. All quests that use the event will also be reset. * @alias gamesManagement.events.resetForAllPlayers * @memberOf! () * @@ -1260,10 +1206,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetMultipleForAllPlayers - * @desc Resets events with the given IDs for all players. This method is - * only available to user accounts for your developer console. Only draft - * events may be reset. All quests that use any of the events will also be - * reset. + * @desc Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset. All quests that use any of the events will also be reset. * @alias gamesManagement.events.resetMultipleForAllPlayers * @memberOf! () * @@ -1390,9 +1333,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.players.hide - * @desc Hide the given player's leaderboard scores from the given - * application. This method is only available to user accounts for your - * developer console. + * @desc Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console. * @alias gamesManagement.players.hide * @memberOf! () * @@ -1464,9 +1405,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.players.unhide - * @desc Unhide the given player's leaderboard scores from the given - * application. This method is only available to user accounts for your - * developer console. + * @desc Unhide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console. * @alias gamesManagement.players.unhide * @memberOf! () * @@ -1548,8 +1487,7 @@ export namespace gamesManagement_v1management { */ applicationId?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; } @@ -1564,8 +1502,7 @@ export namespace gamesManagement_v1management { */ applicationId?: string; /** - * A player ID. A value of me may be used in place of the authenticated - * player's ID. + * A player ID. A value of me may be used in place of the authenticated player's ID. */ playerId?: string; } @@ -1578,9 +1515,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.quests.reset - * @desc Resets all player progress on the quest with the given ID for the - * currently authenticated player. This method is only accessible to - * whitelisted tester accounts for your application. + * @desc Resets all player progress on the quest with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.quests.reset * @memberOf! () * @@ -1650,9 +1585,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.quests.resetAll - * @desc Resets all player progress on all quests for the currently - * authenticated player. This method is only accessible to whitelisted - * tester accounts for your application. + * @desc Resets all player progress on all quests for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.quests.resetAll * @memberOf! () * @@ -1722,8 +1655,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.quests.resetAllForAllPlayers - * @desc Resets all draft quests for all players. This method is only - * available to user accounts for your developer console. + * @desc Resets all draft quests for all players. This method is only available to user accounts for your developer console. * @alias gamesManagement.quests.resetAllForAllPlayers * @memberOf! () * @@ -1793,9 +1725,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.quests.resetForAllPlayers - * @desc Resets all player progress on the quest with the given ID for all - * players. This method is only available to user accounts for your - * developer console. Only draft quests can be reset. + * @desc Resets all player progress on the quest with the given ID for all players. This method is only available to user accounts for your developer console. Only draft quests can be reset. * @alias gamesManagement.quests.resetForAllPlayers * @memberOf! () * @@ -1867,9 +1797,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.quests.resetMultipleForAllPlayers - * @desc Resets quests with the given IDs for all players. This method is - * only available to user accounts for your developer console. Only draft - * quests may be reset. + * @desc Resets quests with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft quests may be reset. * @alias gamesManagement.quests.resetMultipleForAllPlayers * @memberOf! () * @@ -1996,9 +1924,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.rooms.reset - * @desc Reset all rooms for the currently authenticated player for your - * application. This method is only accessible to whitelisted tester - * accounts for your application. + * @desc Reset all rooms for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.rooms.reset * @memberOf! () * @@ -2068,9 +1994,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.rooms.resetForAllPlayers - * @desc Deletes rooms where the only room participants are from whitelisted - * tester accounts for your application. This method is only available to - * user accounts for your developer console. + * @desc Deletes rooms where the only room participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console. * @alias gamesManagement.rooms.resetForAllPlayers * @memberOf! () * @@ -2161,9 +2085,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.scores.reset - * @desc Resets scores for the leaderboard with the given ID for the - * currently authenticated player. This method is only accessible to - * whitelisted tester accounts for your application. + * @desc Resets scores for the leaderboard with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.scores.reset * @memberOf! () * @@ -2240,9 +2162,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.scores.resetAll - * @desc Resets all scores for all leaderboards for the currently - * authenticated players. This method is only accessible to whitelisted - * tester accounts for your application. + * @desc Resets all scores for all leaderboards for the currently authenticated players. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.scores.resetAll * @memberOf! () * @@ -2321,8 +2241,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.scores.resetAllForAllPlayers - * @desc Resets scores for all draft leaderboards for all players. This - * method is only available to user accounts for your developer console. + * @desc Resets scores for all draft leaderboards for all players. This method is only available to user accounts for your developer console. * @alias gamesManagement.scores.resetAllForAllPlayers * @memberOf! () * @@ -2392,9 +2311,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.scores.resetForAllPlayers - * @desc Resets scores for the leaderboard with the given ID for all - * players. This method is only available to user accounts for your - * developer console. Only draft leaderboards can be reset. + * @desc Resets scores for the leaderboard with the given ID for all players. This method is only available to user accounts for your developer console. Only draft leaderboards can be reset. * @alias gamesManagement.scores.resetForAllPlayers * @memberOf! () * @@ -2466,9 +2383,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.scores.resetMultipleForAllPlayers - * @desc Resets scores for the leaderboards with the given IDs for all - * players. This method is only available to user accounts for your - * developer console. Only draft leaderboards may be reset. + * @desc Resets scores for the leaderboards with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft leaderboards may be reset. * @alias gamesManagement.scores.resetMultipleForAllPlayers * @memberOf! () * @@ -2595,8 +2510,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.turnBasedMatches.reset - * @desc Reset all turn-based match data for a user. This method is only - * accessible to whitelisted tester accounts for your application. + * @desc Reset all turn-based match data for a user. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.turnBasedMatches.reset * @memberOf! () * @@ -2666,9 +2580,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.turnBasedMatches.resetForAllPlayers - * @desc Deletes turn-based matches where the only match participants are - * from whitelisted tester accounts for your application. This method is - * only available to user accounts for your developer console. + * @desc Deletes turn-based matches where the only match participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console. * @alias gamesManagement.turnBasedMatches.resetForAllPlayers * @memberOf! () * diff --git a/src/apis/genomics/package.json b/src/apis/genomics/package.json index 869dbb60052..5fc65c71904 100644 --- a/src/apis/genomics/package.json +++ b/src/apis/genomics/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/genomics/v1.ts b/src/apis/genomics/v1.ts index b88dc9b68b7..15806215427 100644 --- a/src/apis/genomics/v1.ts +++ b/src/apis/genomics/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace genomics_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace genomics_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace genomics_v1 { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); } @@ -123,8 +122,7 @@ export namespace genomics_v1 { */ export interface Schema$CancelOperationRequest {} /** - * Describes a Compute Engine resource that is being managed by a running - * pipeline. + * Describes a Compute Engine resource that is being managed by a running pipeline. */ export interface Schema$ComputeEngine { /** @@ -145,9 +143,7 @@ export namespace genomics_v1 { zone?: string; } /** - * An event generated when a container is forcibly terminated by the worker. - * Currently, this only occurs when the container outlives the timeout - * specified by the user. + * An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user. */ export interface Schema$ContainerKilledEvent { /** @@ -164,16 +160,11 @@ export namespace genomics_v1 { */ actionId?: number; /** - * The public IP address that can be used to connect to the container. This - * field is only populated when at least one port mapping is present. If the - * instance was created with a private address, this field will be empty - * even if port mappings exist. + * The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. */ ipAddress?: string; /** - * The container-to-host port mappings installed for this container. This - * set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag - * as well as any specified in the `Action` definition. + * The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition. */ portMappings?: {[key: string]: number}; } @@ -190,41 +181,25 @@ export namespace genomics_v1 { */ exitStatus?: number; /** - * The tail end of any content written to standard error by the container. - * If the content emits large amounts of debugging noise or contains - * sensitive information, you can prevent the content from being printed by - * setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a - * small amount of the end of the stream is captured here. The entire stream - * is stored in the `/google/logs` directory mounted into each action, and - * can be copied off the machine as described elsewhere. + * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ stderr?: string; } /** - * An event generated whenever a resource limitation or transient error delays - * execution of a pipeline that was otherwise ready to run. + * An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run. */ export interface Schema$DelayedEvent { /** - * A textual description of the cause of the delay. The string can change - * without notice because it is often generated by another service (such as - * Compute Engine). + * A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). */ cause?: string; /** - * If the delay was caused by a resource shortage, this field lists the - * Compute Engine metrics that are preventing this operation from running - * (for example, `CPUS` or `INSTANCES`). If the particular metric is not - * known, a single `UNKNOWN` metric will be present. + * If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present. */ metrics?: string[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -232,9 +207,7 @@ export namespace genomics_v1 { */ export interface Schema$Event { /** - * A human-readable description of the event. Note that these strings can - * change at any time without notice. Any application logic must use the - * information in the `details` field. + * A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field. */ description?: string; /** @@ -247,8 +220,7 @@ export namespace genomics_v1 { timestamp?: string; } /** - * An event generated when the execution of a pipeline has failed. Note that - * other events can continue to occur after this event. + * An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event. */ export interface Schema$FailedEvent { /** @@ -274,14 +246,11 @@ export namespace genomics_v1 { operations?: Schema$Operation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -289,14 +258,11 @@ export namespace genomics_v1 { */ error?: Schema$Status; /** - * An OperationMetadata or Metadata object. This will always be returned - * with the Operation. + * An OperationMetadata or Metadata object. This will always be returned with the Operation. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. For example&#58; - * `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` + * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ name?: string; /** @@ -313,9 +279,7 @@ export namespace genomics_v1 { */ description?: string; /** - * Optional time of when event finished. An event can have a start time and - * no finish time. If an event has a finish time, there must be a start - * time. + * Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time. */ endTime?: string; /** @@ -328,8 +292,7 @@ export namespace genomics_v1 { */ export interface Schema$OperationMetadata { /** - * This field is deprecated. Use `labels` instead. Optionally provided by - * the caller when submitting the request that creates the operation. + * This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation. */ clientId?: string; /** @@ -341,14 +304,11 @@ export namespace genomics_v1 { */ endTime?: string; /** - * Optional event messages that were generated during the job's - * execution. This also contains any warnings that were generated during - * import or export. + * Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export. */ events?: Schema$OperationEvent[]; /** - * Optionally provided by the caller when submitting the request that - * creates the operation. + * Optionally provided by the caller when submitting the request that creates the operation. */ labels?: {[key: string]: string}; /** @@ -356,10 +316,7 @@ export namespace genomics_v1 { */ projectId?: string; /** - * The original request that started the operation. Note that this will be - * in current version of the API. If the operation was started with v1beta2 - * API and a GetOperation is performed on v1 API, a v1 request will be - * returned. + * The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned. */ request?: {[key: string]: any}; /** @@ -390,13 +347,11 @@ export namespace genomics_v1 { imageUri?: string; } /** - * The response to the RunPipeline method, returned in the operation's - * result field on success. + * The response to the RunPipeline method, returned in the operation's result field on success. */ export interface Schema$RunPipelineResponse {} /** - * Runtime metadata that will be populated in the runtimeMetadata field of the - * Operation associated with a RunPipeline execution. + * Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution. */ export interface Schema$RuntimeMetadata { /** @@ -405,40 +360,7 @@ export namespace genomics_v1 { computeEngine?: Schema$ComputeEngine; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -446,22 +368,16 @@ export namespace genomics_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * An event generated when the execution of a container results in a non-zero - * exit status that was not otherwise ignored. Execution will continue, but - * only actions that are flagged as `ALWAYS_RUN` will be executed. Other - * actions will be skipped. + * An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped. */ export interface Schema$UnexpectedExitStatusEvent { /** @@ -487,8 +403,7 @@ export namespace genomics_v1 { zone?: string; } /** - * An event generated when the worker VM that was assigned to the pipeline has - * been released (deleted). + * An event generated when the worker VM that was assigned to the pipeline has been released (deleted). */ export interface Schema$WorkerReleasedEvent { /** @@ -509,27 +424,19 @@ export namespace genomics_v1 { /** * genomics.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. Clients may use Operations.GetOperation or - * Operations.ListOperations to check whether the cancellation succeeded or - * the operation completed despite cancellation. Authorization requires the - * following [Google IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.cancel` + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -562,10 +469,9 @@ export namespace genomics_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -639,25 +545,19 @@ export namespace genomics_v1 { /** * genomics.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.get` + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -689,10 +589,9 @@ export namespace genomics_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -766,24 +665,19 @@ export namespace genomics_v1 { /** * genomics.operations.list - * @desc Lists operations that match the specified filter in the request. - * Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.list` + * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -809,9 +703,8 @@ export namespace genomics_v1 { * return; * } * for (var i = 0; i < operationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `operationsPage`: console.log(JSON.stringify(operationsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -829,10 +722,9 @@ export namespace genomics_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -945,25 +837,7 @@ export namespace genomics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A string for filtering Operations. In v2alpha1, the following filter - * fields are supported: * createTime: The time this job was - * created * events: The set of event (names) that have occurred while - * running the pipeline. The : operator can be used to determine if a - * particular event has occurred. * error: If the pipeline is running, - * this value is NULL. Once the pipeline finishes, the value is the - * standard Google error code. * labels.key or labels."key with space" where - * key is a label key. * done: If the pipeline is running, this value is - * false. Once the pipeline finishes, the value is true. In v1 and - * v1alpha2, the following filter fields are supported: * - * projectId: Required. Corresponds to OperationMetadata.projectId. * - * createTime: The time this job was created, in seconds from the - * [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` - * operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or - * `CANCELED`. Only one status may be specified. * labels.key where key is - * a label key. Examples: * `projectId = my-project AND createTime >= - * 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND - * createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project - * AND labels.color = *` * `projectId = my-project AND labels.color = red` + * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` */ filter?: string; /** diff --git a/src/apis/genomics/v1alpha2.ts b/src/apis/genomics/v1alpha2.ts index 999272aa8d4..22c0c2cfaa6 100644 --- a/src/apis/genomics/v1alpha2.ts +++ b/src/apis/genomics/v1alpha2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace genomics_v1alpha2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace genomics_v1alpha2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace genomics_v1alpha2 { pipelines: Resource$Pipelines; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.pipelines = new Resource$Pipelines(this.context); @@ -125,8 +124,7 @@ export namespace genomics_v1alpha2 { */ export interface Schema$CancelOperationRequest {} /** - * Describes a Compute Engine resource that is being managed by a running - * pipeline. + * Describes a Compute Engine resource that is being managed by a running pipeline. */ export interface Schema$ComputeEngine { /** @@ -147,9 +145,7 @@ export namespace genomics_v1alpha2 { zone?: string; } /** - * An event generated when a container is forcibly terminated by the worker. - * Currently, this only occurs when the container outlives the timeout - * specified by the user. + * An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user. */ export interface Schema$ContainerKilledEvent { /** @@ -166,16 +162,11 @@ export namespace genomics_v1alpha2 { */ actionId?: number; /** - * The public IP address that can be used to connect to the container. This - * field is only populated when at least one port mapping is present. If the - * instance was created with a private address, this field will be empty - * even if port mappings exist. + * The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. */ ipAddress?: string; /** - * The container-to-host port mappings installed for this container. This - * set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag - * as well as any specified in the `Action` definition. + * The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition. */ portMappings?: {[key: string]: number}; } @@ -192,20 +183,12 @@ export namespace genomics_v1alpha2 { */ exitStatus?: number; /** - * The tail end of any content written to standard error by the container. - * If the content emits large amounts of debugging noise or contains - * sensitive information, you can prevent the content from being printed by - * setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a - * small amount of the end of the stream is captured here. The entire stream - * is stored in the `/google/logs` directory mounted into each action, and - * can be copied off the machine as described elsewhere. + * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ stderr?: string; } /** - * Stores the information that the controller will fetch from the server in - * order to run. Should only be used by VMs created by the Pipelines Service - * and not by end users. + * Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users. */ export interface Schema$ControllerConfig { cmd?: string; @@ -218,21 +201,15 @@ export namespace genomics_v1alpha2 { vars?: {[key: string]: string}; } /** - * An event generated whenever a resource limitation or transient error delays - * execution of a pipeline that was otherwise ready to run. + * An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run. */ export interface Schema$DelayedEvent { /** - * A textual description of the cause of the delay. The string can change - * without notice because it is often generated by another service (such as - * Compute Engine). + * A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). */ cause?: string; /** - * If the delay was caused by a resource shortage, this field lists the - * Compute Engine metrics that are preventing this operation from running - * (for example, `CPUS` or `INSTANCES`). If the particular metric is not - * known, a single `UNKNOWN` metric will be present. + * If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present. */ metrics?: string[]; } @@ -241,41 +218,27 @@ export namespace genomics_v1alpha2 { */ export interface Schema$Disk { /** - * Deprecated. Disks created by the Pipelines API will be deleted at the end - * of the pipeline run, regardless of what this field is set to. + * Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to. */ autoDelete?: boolean; /** - * Required at create time and cannot be overridden at run time. Specifies - * the path in the docker container where files on this disk should be - * located. For example, if `mountPoint` is `/mnt/disk`, and the parameter - * has `localPath` `inputs/file.txt`, the docker container can access the - * data at `/mnt/disk/inputs/file.txt`. + * Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`. */ mountPoint?: string; /** - * Required. The name of the disk that can be used in the pipeline - * parameters. Must be 1 - 63 characters. The name "boot" is - * reserved for system use. + * Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use. */ name?: string; /** - * Specifies how a sourced-base persistent disk will be mounted. See - * https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances - * for more details. Can only be set at create time. + * Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time. */ readOnly?: boolean; /** - * The size of the disk. Defaults to 500 (GB). This field is not applicable - * for local SSD. + * The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD. */ sizeGb?: number; /** - * The full or partial URL of the persistent disk to attach. See - * https://cloud.google.com/compute/docs/reference/latest/instances#resource - * and - * https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots - * for more details. + * The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details. */ source?: string; /** @@ -288,25 +251,16 @@ export namespace genomics_v1alpha2 { */ export interface Schema$DockerExecutor { /** - * Required. The command or newline delimited script to run. The command - * string will be executed within a bash shell. If the command exits with a - * non-zero exit code, output parameter de-localization will be skipped and - * the pipeline operation's `error` field will be populated. Maximum - * command string length is 16384. + * Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384. */ cmd?: string; /** - * Required. Image name from either Docker Hub or Google Container Registry. - * Users that run pipelines must have READ access to the image. + * Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image. */ imageName?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -314,9 +268,7 @@ export namespace genomics_v1alpha2 { */ export interface Schema$Event { /** - * A human-readable description of the event. Note that these strings can - * change at any time without notice. Any application logic must use the - * information in the `details` field. + * A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field. */ description?: string; /** @@ -329,8 +281,7 @@ export namespace genomics_v1alpha2 { timestamp?: string; } /** - * An event generated when the execution of a pipeline has failed. Note that - * other events can continue to occur after this event. + * An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event. */ export interface Schema$FailedEvent { /** @@ -356,10 +307,7 @@ export namespace genomics_v1alpha2 { operations?: Schema$Operation[]; } /** - * The response of ListPipelines. Contains at most `pageSize` pipelines. If it - * contains `pageSize` pipelines, and more pipelines exist, then - * `nextPageToken` will be populated and should be used as the `pageToken` - * argument to a subsequent ListPipelines request. + * The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request. */ export interface Schema$ListPipelinesResponse { /** @@ -376,16 +324,11 @@ export namespace genomics_v1alpha2 { */ export interface Schema$LocalCopy { /** - * Required. The name of the disk where this parameter is located. Can be - * the name of one of the disks specified in the Resources field, or - * "boot", which represents the Docker instance's boot disk - * and has a mount point of `/`. + * Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`. */ disk?: string; /** - * Required. The path within the user's docker container where this - * input should be localized to and from, relative to the specified - * disk's mount point. For example: file.txt, + * Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt, */ path?: string; } @@ -394,25 +337,16 @@ export namespace genomics_v1alpha2 { */ export interface Schema$LoggingOptions { /** - * The location in Google Cloud Storage to which the pipeline logs will be - * copied. Can be specified as a fully qualified directory path, in which - * case logs will be output with a unique identifier as the filename in that - * directory, or as a fully specified path, which must end in `.log`, in - * which case that path will be used, and the user must ensure that logs are - * not overwritten. Stdout and stderr logs from the run are also generated - * and output as `-stdout.log` and `-stderr.log`. + * The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`. */ gcsPath?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -420,14 +354,11 @@ export namespace genomics_v1alpha2 { */ error?: Schema$Status; /** - * An OperationMetadata or Metadata object. This will always be returned - * with the Operation. + * An OperationMetadata or Metadata object. This will always be returned with the Operation. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. For example&#58; - * `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` + * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ name?: string; /** @@ -444,9 +375,7 @@ export namespace genomics_v1alpha2 { */ description?: string; /** - * Optional time of when event finished. An event can have a start time and - * no finish time. If an event has a finish time, there must be a start - * time. + * Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time. */ endTime?: string; /** @@ -459,8 +388,7 @@ export namespace genomics_v1alpha2 { */ export interface Schema$OperationMetadata { /** - * This field is deprecated. Use `labels` instead. Optionally provided by - * the caller when submitting the request that creates the operation. + * This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation. */ clientId?: string; /** @@ -472,14 +400,11 @@ export namespace genomics_v1alpha2 { */ endTime?: string; /** - * Optional event messages that were generated during the job's - * execution. This also contains any warnings that were generated during - * import or export. + * Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export. */ events?: Schema$OperationEvent[]; /** - * Optionally provided by the caller when submitting the request that - * creates the operation. + * Optionally provided by the caller when submitting the request that creates the operation. */ labels?: {[key: string]: string}; /** @@ -487,10 +412,7 @@ export namespace genomics_v1alpha2 { */ projectId?: string; /** - * The original request that started the operation. Note that this will be - * in current version of the API. If the operation was started with v1beta2 - * API and a GetOperation is performed on v1 API, a v1 request will be - * returned. + * The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned. */ request?: {[key: string]: any}; /** @@ -503,12 +425,7 @@ export namespace genomics_v1alpha2 { startTime?: string; } /** - * The pipeline object. Represents a transformation from a set of input - * parameters to a set of output parameters. The transformation is defined as - * a docker image and command to run within that image. Each pipeline is run - * on a Google Compute Engine VM. A pipeline can be created with the `create` - * method and then later run with the `run` method, or a pipeline can be - * defined and run all at once with the `run` method. + * The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method. */ export interface Schema$Pipeline { /** @@ -524,8 +441,7 @@ export namespace genomics_v1alpha2 { */ inputParameters?: Schema$PipelineParameter[]; /** - * Required. A user specified pipeline name that does not have to be unique. - * This name can be used for filtering Pipelines in ListPipelines. + * Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines. */ name?: string; /** @@ -533,77 +449,24 @@ export namespace genomics_v1alpha2 { */ outputParameters?: Schema$PipelineParameter[]; /** - * Unique pipeline id that is generated by the service when CreatePipeline - * is called. Cannot be specified in the Pipeline used in the - * CreatePipelineRequest, and will be populated in the response to - * CreatePipeline and all subsequent Get and List calls. Indicates that the - * service has registered this pipeline. + * Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline. */ pipelineId?: string; /** - * Required. The project in which to create the pipeline. The caller must - * have WRITE access. + * Required. The project in which to create the pipeline. The caller must have WRITE access. */ projectId?: string; /** - * Required. Specifies resource requirements for the pipeline run. Required - * fields: * minimumCpuCores * minimumRamGb + * Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb */ resources?: Schema$PipelineResources; } /** - * Parameters facilitate setting and delivering data into the pipeline's - * execution environment. They are defined at create time, with optional - * defaults, and can be overridden at run time. If `localCopy` is unset, then - * the parameter specifies a string that is passed as-is into the pipeline, as - * the value of the environment variable with the given name. A default value - * can be optionally specified at create time. The default can be overridden - * at run time using the inputs map. If no default is given, a value must be - * supplied at runtime. If `localCopy` is defined, then the parameter - * specifies a data source or sink, both in Google Cloud Storage and on the - * Docker container where the pipeline computation is run. The service account - * associated with the Pipeline (by default the project's Compute Engine - * service account) must have access to the Google Cloud Storage paths. At - * run time, the Google Cloud Storage paths can be overridden if a default was - * provided at create time, or must be set otherwise. The pipeline runner - * should add a key/value pair to either the inputs or outputs map. The - * indicated data copies will be carried out before/after pipeline execution, - * just as if the corresponding arguments were provided to `gsutil cp`. For - * example: Given the following `PipelineParameter`, specified in the - * `inputParameters` list: ``` {name: "input_file", localCopy: - * {path: "file.txt", disk: "pd1"}} ``` where `disk` is - * defined in the `PipelineResources` object as: ``` {name: "pd1", - * mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, - * mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker - * container. At runtime, an entry for `input_file` would be required in the - * inputs map, such as: ``` inputs["input_file"] = - * "gs://my-bucket/bar.txt" ``` This would generate the following - * gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` - * The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker - * container. Acceptable paths are: <table> <thead> - * <tr><th>Google Cloud storage path</th><th>Local - * path</th></tr> </thead> <tbody> - * <tr><td>file</td><td>file</td></tr> - * <tr><td>glob</td><td>directory</td></tr> - * </tbody> </table> For outputs, the direction of the copy is - * reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` - * Acceptable paths are: <table> <thead> - * <tr><th>Local path</th><th>Google Cloud Storage - * path</th></tr> </thead> <tbody> - * <tr><td>file</td><td>file</td></tr> - * <tr> <td>file</td> <td>directory - - * directory must already exist</td> </tr> <tr> - * <td>glob</td> <td>directory - directory will be - * created if it doesn't exist</td></tr> </tbody> - * </table> One restriction due to docker limitations, is that for - * outputs that are found on the boot disk, the local path cannot be a glob - * and must be a file. + * Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: <table> <thead> <tr><th>Google Cloud storage path</th><th>Local path</th></tr> </thead> <tbody> <tr><td>file</td><td>file</td></tr> <tr><td>glob</td><td>directory</td></tr> </tbody> </table> For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: <table> <thead> <tr><th>Local path</th><th>Google Cloud Storage path</th></tr> </thead> <tbody> <tr><td>file</td><td>file</td></tr> <tr> <td>file</td> <td>directory - directory must already exist</td> </tr> <tr> <td>glob</td> <td>directory - directory will be created if it doesn't exist</td></tr> </tbody> </table> One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file. */ export interface Schema$PipelineParameter { /** - * The default value for this parameter. Can be overridden at runtime. If - * `localCopy` is present, then this must be a Google Cloud Storage path - * beginning with `gs://`. + * The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`. */ defaultValue?: string; /** @@ -611,15 +474,11 @@ export namespace genomics_v1alpha2 { */ description?: string; /** - * If present, this parameter is marked for copying to and from the VM. - * `LocalCopy` indicates where on the VM the file should be. The value given - * to this parameter (either at runtime or using `defaultValue`) must be the - * remote path where the file should be. + * If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be. */ localCopy?: Schema$LocalCopy; /** - * Required. Name of the parameter - the pipeline runner uses this string as - * the key to the input and output maps in RunPipeline. + * Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline. */ name?: string; } @@ -628,19 +487,11 @@ export namespace genomics_v1alpha2 { */ export interface Schema$PipelineResources { /** - * Optional. The number of accelerators of the specified type to attach. By - * specifying this parameter, you will download and install the following - * third-party software onto your managed Compute Engine instances: NVIDIA® - * Tesla® drivers and NVIDIA® CUDA toolkit. + * Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. */ acceleratorCount?: string; /** - * Optional. The Compute Engine defined accelerator type. By specifying this - * parameter, you will download and install the following third-party - * software onto your managed Compute Engine instances: NVIDIA® Tesla® - * drivers and NVIDIA® CUDA toolkit. Please see - * https://cloud.google.com/compute/docs/gpus/ for a list of available - * accelerator types. + * Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types. */ acceleratorType?: string; /** @@ -660,29 +511,15 @@ export namespace genomics_v1alpha2 { */ minimumRamGb?: number; /** - * Whether to assign an external IP to the instance. This is an experimental - * feature that may go away. Defaults to false. Corresponds to - * `--no_address` flag for [gcloud compute instances create] - * (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). - * In order to use this, must be true for both create time and run time. - * Cannot be true at run time if false at create time. If you need to ssh - * into a private IP VM for debugging, you can ssh to a public VM and then - * ssh into the private VM's Internal IP. If noAddress is set, this - * pipeline run may only load docker images from Google Container Registry - * and not Docker Hub. Before using this, you must [configure access to - * Google services from internal - * IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips). + * Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips). */ noAddress?: boolean; /** - * Whether to use preemptible VMs. Defaults to `false`. In order to use - * this, must be true for both create time and run time. Cannot be true at - * run time if false at create time. + * Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. */ preemptible?: boolean; /** - * List of Google Compute Engine availability zones to which resource - * creation will restricted. If empty, any zone may be chosen. + * List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen. */ zones?: string[]; } @@ -712,53 +549,31 @@ export namespace genomics_v1alpha2 { */ export interface Schema$RunPipelineArgs { /** - * This field is deprecated. Use `labels` instead. Client-specified pipeline - * operation identifier. + * This field is deprecated. Use `labels` instead. Client-specified pipeline operation identifier. */ clientId?: string; /** - * Pipeline input arguments; keys are defined in the pipeline documentation. - * All input parameters that do not have default values must be specified. - * If parameters with defaults are specified here, the defaults will be - * overridden. + * Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. */ inputs?: {[key: string]: string}; /** - * How long to keep the VM up after a failure (for example docker command - * failed, copying input or output files failed, etc). While the VM is up, - * one can ssh into the VM to debug. Default is 0; maximum allowed value is - * 1 day. + * How long to keep the VM up after a failure (for example docker command failed, copying input or output files failed, etc). While the VM is up, one can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day. */ keepVmAliveOnFailureDuration?: string; /** - * Labels to apply to this pipeline run. Labels will also be applied to - * compute resources (VM, disks) created by this pipeline run. When listing - * operations, operations can filtered by labels. Label keys may not be - * empty; label values may be empty. Non-empty labels must be 1-63 - * characters long, and comply with [RFC1035] - * (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be - * 1-63 characters long and match the regular expression - * `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - * lowercase letter, and all following characters must be a dash, lowercase - * letter, or digit, except the last character, which cannot be a dash. + * Labels to apply to this pipeline run. Labels will also be applied to compute resources (VM, disks) created by this pipeline run. When listing operations, operations can filtered by labels. Label keys may not be empty; label values may be empty. Non-empty labels must be 1-63 characters long, and comply with [RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ labels?: {[key: string]: string}; /** - * Required. Logging options. Used by the service to communicate results to - * the user. + * Required. Logging options. Used by the service to communicate results to the user. */ logging?: Schema$LoggingOptions; /** - * Pipeline output arguments; keys are defined in the pipeline - * documentation. All output parameters of without default values must be - * specified. If parameters with defaults are specified here, the defaults - * will be overridden. + * Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden. */ outputs?: {[key: string]: string}; /** - * Required. The project in which to run the pipeline. The caller must have - * WRITER access to all Google Cloud services and resources (e.g. Google - * Compute Engine) will be used. + * Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used. */ projectId?: string; /** @@ -766,19 +581,12 @@ export namespace genomics_v1alpha2 { */ resources?: Schema$PipelineResources; /** - * The Google Cloud Service Account that will be used to access data and - * services. By default, the compute service account associated with - * `projectId` is used. + * The Google Cloud Service Account that will be used to access data and services. By default, the compute service account associated with `projectId` is used. */ serviceAccount?: Schema$ServiceAccount; } /** - * The request to run a pipeline. If `pipelineId` is specified, it refers to a - * saved pipeline created with CreatePipeline and set as the `pipelineId` of - * the returned Pipeline object. If `ephemeralPipeline` is specified, that - * pipeline is run once with the given args and not saved. It is an error to - * specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be - * specified. + * The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified. */ export interface Schema$RunPipelineRequest { /** @@ -795,13 +603,11 @@ export namespace genomics_v1alpha2 { pipelineId?: string; } /** - * The response to the RunPipeline method, returned in the operation's - * result field on success. + * The response to the RunPipeline method, returned in the operation's result field on success. */ export interface Schema$RunPipelineResponse {} /** - * Runtime metadata that will be populated in the runtimeMetadata field of the - * Operation associated with a RunPipeline execution. + * Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution. */ export interface Schema$RuntimeMetadata { /** @@ -814,24 +620,16 @@ export namespace genomics_v1alpha2 { */ export interface Schema$ServiceAccount { /** - * Email address of the service account. Defaults to `default`, which uses - * the compute service account associated with the project. + * Email address of the service account. Defaults to `default`, which uses the compute service account associated with the project. */ email?: string; /** - * List of scopes to be enabled for this service account on the VM. The - * following scopes are automatically included: * - * https://www.googleapis.com/auth/compute * - * https://www.googleapis.com/auth/devstorage.full_control * - * https://www.googleapis.com/auth/genomics * - * https://www.googleapis.com/auth/logging.write * - * https://www.googleapis.com/auth/monitoring.write + * List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write */ scopes?: string[]; } /** - * Request to set operation status. Should only be used by VMs created by the - * Pipelines Service and not by end users. + * Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users. */ export interface Schema$SetOperationStatusRequest { errorCode?: string; @@ -841,40 +639,7 @@ export namespace genomics_v1alpha2 { validationToken?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -882,20 +647,16 @@ export namespace genomics_v1alpha2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Stores the list of events and times they occured for major events in job - * execution. + * Stores the list of events and times they occured for major events in job execution. */ export interface Schema$TimestampEvent { /** @@ -908,10 +669,7 @@ export namespace genomics_v1alpha2 { timestamp?: string; } /** - * An event generated when the execution of a container results in a non-zero - * exit status that was not otherwise ignored. Execution will continue, but - * only actions that are flagged as `ALWAYS_RUN` will be executed. Other - * actions will be skipped. + * An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped. */ export interface Schema$UnexpectedExitStatusEvent { /** @@ -937,8 +695,7 @@ export namespace genomics_v1alpha2 { zone?: string; } /** - * An event generated when the worker VM that was assigned to the pipeline has - * been released (deleted). + * An event generated when the worker VM that was assigned to the pipeline has been released (deleted). */ export interface Schema$WorkerReleasedEvent { /** @@ -959,27 +716,19 @@ export namespace genomics_v1alpha2 { /** * genomics.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. Clients may use Operations.GetOperation or - * Operations.ListOperations to check whether the cancellation succeeded or - * the operation completed despite cancellation. Authorization requires the - * following [Google IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.cancel` + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1012,10 +761,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1092,25 +840,19 @@ export namespace genomics_v1alpha2 { /** * genomics.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.get` + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1142,10 +884,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1219,24 +960,19 @@ export namespace genomics_v1alpha2 { /** * genomics.operations.list - * @desc Lists operations that match the specified filter in the request. - * Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.list` + * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1262,9 +998,8 @@ export namespace genomics_v1alpha2 { * return; * } * for (var i = 0; i < operationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `operationsPage`: console.log(JSON.stringify(operationsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1282,10 +1017,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1398,25 +1132,7 @@ export namespace genomics_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A string for filtering Operations. In v2alpha1, the following filter - * fields are supported: * createTime: The time this job was - * created * events: The set of event (names) that have occurred while - * running the pipeline. The : operator can be used to determine if a - * particular event has occurred. * error: If the pipeline is running, - * this value is NULL. Once the pipeline finishes, the value is the - * standard Google error code. * labels.key or labels."key with space" where - * key is a label key. * done: If the pipeline is running, this value is - * false. Once the pipeline finishes, the value is true. In v1 and - * v1alpha2, the following filter fields are supported: * - * projectId: Required. Corresponds to OperationMetadata.projectId. * - * createTime: The time this job was created, in seconds from the - * [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` - * operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or - * `CANCELED`. Only one status may be specified. * labels.key where key is - * a label key. Examples: * `projectId = my-project AND createTime >= - * 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND - * createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project - * AND labels.color = *` * `projectId = my-project AND labels.color = red` + * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` */ filter?: string; /** @@ -1441,24 +1157,19 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.create - * @desc Creates a pipeline that can be run later. Create takes a Pipeline - * that has all fields other than `pipelineId` populated, and then returns - * the same pipeline with `pipelineId` populated. This id can be used to run - * the pipeline. Caller must have WRITE permission to the project. + * @desc Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1491,10 +1202,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1569,22 +1279,19 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.delete - * @desc Deletes a pipeline based on ID. Caller must have WRITE permission - * to the project. + * @desc Deletes a pipeline based on ID. Caller must have WRITE permission to the project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1593,8 +1300,7 @@ export namespace genomics_v1alpha2 { * * authorize(function(authClient) { * var request = { - * // Caller must have WRITE access to the project in which this - * pipeline + * // Caller must have WRITE access to the project in which this pipeline * // is defined. * pipelineId: 'my-pipeline-id', // TODO: Update placeholder value. * @@ -1615,10 +1321,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1693,22 +1398,19 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.get - * @desc Retrieves a pipeline based on ID. Caller must have READ permission - * to the project. + * @desc Retrieves a pipeline based on ID. Caller must have READ permission to the project. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1741,10 +1443,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1819,22 +1520,19 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.getControllerConfig - * @desc Gets controller configuration information. Should only be called by - * VMs created by the Pipelines Service and not by end users. + * @desc Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1846,8 +1544,10 @@ export namespace genomics_v1alpha2 { * auth: authClient, * }; * - * genomics.pipelines.getControllerConfig(request, function(err, response) - * { if (err) { console.error(err); return; + * genomics.pipelines.getControllerConfig(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1861,10 +1561,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1952,14 +1651,12 @@ export namespace genomics_v1alpha2 { * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1982,8 +1679,8 @@ export namespace genomics_v1alpha2 { * return; * } * for (var i = 0; i < pipelinesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `pipelinesPage`: console.log(JSON.stringify(pipelinesPage[i], null, 2)); + * // TODO: Change code below to process each resource in `pipelinesPage`: + * console.log(JSON.stringify(pipelinesPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2001,10 +1698,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2086,27 +1782,19 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.run - * @desc Runs a pipeline. If `pipelineId` is specified in the request, then - * run a saved pipeline. If `ephemeralPipeline` is specified, then run that - * pipeline once without saving a copy. The caller must have READ - * permission to the project where the pipeline is stored and WRITE - * permission to the project where the pipeline will be run, as VMs will be - * created and storage will be used. If a pipeline operation is still - * running after 6 days, it will be canceled. + * @desc Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used. If a pipeline operation is still running after 6 days, it will be canceled. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2139,10 +1827,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2219,23 +1906,19 @@ export namespace genomics_v1alpha2 { /** * genomics.pipelines.setOperationStatus - * @desc Sets status of a given operation. Any new timestamps (as determined - * by description) are appended to TimestampEvents. Should only be called by - * VMs created by the Pipelines Service and not by end users. + * @desc Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Genomics API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/genomics - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2245,8 +1928,7 @@ export namespace genomics_v1alpha2 { * authorize(function(authClient) { * var request = { * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -2267,10 +1949,9 @@ export namespace genomics_v1alpha2 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2363,8 +2044,7 @@ export namespace genomics_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Caller must have WRITE access to the project in which this pipeline is - * defined. + * Caller must have WRITE access to the project in which this pipeline is defined. */ pipelineId?: string; } @@ -2375,8 +2055,7 @@ export namespace genomics_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Caller must have READ access to the project in which this pipeline is - * defined. + * Caller must have READ access to the project in which this pipeline is defined. */ pipelineId?: string; } @@ -2403,9 +2082,7 @@ export namespace genomics_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Pipelines with names that match this prefix should be returned. If - * unspecified, all pipelines in the project, up to `pageSize`, will be - * returned. + * Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned. */ namePrefix?: string; /** @@ -2413,13 +2090,11 @@ export namespace genomics_v1alpha2 { */ pageSize?: number; /** - * Token to use to indicate where to start getting results. If unspecified, - * returns the first page of results. + * Token to use to indicate where to start getting results. If unspecified, returns the first page of results. */ pageToken?: string; /** - * Required. The name of the project to search for pipelines. Caller must - * have READ access to this project. + * Required. The name of the project to search for pipelines. Caller must have READ access to this project. */ projectId?: string; } diff --git a/src/apis/genomics/v2alpha1.ts b/src/apis/genomics/v2alpha1.ts index fd2b0f8c91d..7bfd9bbfa59 100644 --- a/src/apis/genomics/v2alpha1.ts +++ b/src/apis/genomics/v2alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace genomics_v2alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace genomics_v2alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace genomics_v2alpha1 { workers: Resource$Workers; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.pipelines = new Resource$Pipelines(this.context); this.projects = new Resource$Projects(this.context); @@ -131,13 +130,7 @@ export namespace genomics_v2alpha1 { */ count?: string; /** - * The accelerator type string (for example, "nvidia-tesla-k80"). - * Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is - * attached, the required runtime libraries will be made available to all - * containers under `/usr/local/nvidia`. The driver version to install must - * be specified using the NVIDIA driver version parameter on the virtual - * machine specification. Note that attaching a GPU increases the worker VM - * startup time by a few minutes. + * The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes. */ type?: string; } @@ -146,17 +139,11 @@ export namespace genomics_v2alpha1 { */ export interface Schema$Action { /** - * If specified, overrides the `CMD` specified in the container. If the - * container also has an `ENTRYPOINT` the values are used as entrypoint - * arguments. Otherwise, they are used as a command and arguments to run - * inside the container. + * If specified, overrides the `CMD` specified in the container. If the container also has an `ENTRYPOINT` the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container. */ commands?: string[]; /** - * If the specified image is hosted on a private registry other than Google - * Container Registry, the credentials required to pull the image must be - * specified here as an encrypted secret. The secret must decrypt to a - * JSON-encoded dictionary containing both `username` and `password` keys. + * If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys. */ credentials?: Schema$Secret; /** @@ -164,19 +151,7 @@ export namespace genomics_v2alpha1 { */ entrypoint?: string; /** - * The environment to pass into the container. This environment is merged - * with any values specified in the `Pipeline` message. These values - * overwrite any in the `Pipeline` message. In addition to the values - * passed here, a few other values are automatically injected into the - * environment. These cannot be hidden or overwritten. - * `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline - * failed because an action has exited with a non-zero status (and did not - * have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if - * additional debug or logging actions should execute. - * `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last - * non-background action that executed. This can be used by workflow engine - * authors to determine whether an individual action has succeeded or - * failed. + * The environment to pass into the container. This environment is merged with any values specified in the `Pipeline` message. These values overwrite any in the `Pipeline` message. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed. */ environment?: {[key: string]: string}; /** @@ -184,64 +159,31 @@ export namespace genomics_v2alpha1 { */ flags?: string[]; /** - * The URI to pull the container image from. Note that all images referenced - * by actions in the pipeline are pulled before the first action runs. If - * multiple actions reference the same image, it is only pulled once, - * ensuring that the same image is used for all actions in a single - * pipeline. + * The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. */ imageUri?: string; /** - * Labels to associate with the action. This field is provided to assist - * workflow engine authors in identifying actions (for example, to indicate - * what sort of action they perform, such as localization or debugging). - * They are returned in the operation metadata, but are otherwise ignored. + * Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored. */ labels?: {[key: string]: string}; /** - * A list of mounts to make available to the action. In addition to the - * values specified here, every action has a special virtual disk mounted - * under `/google` that contains log files and other operational components. - * <ul> <li><code>/google/logs</code> All logs - * written during the pipeline execution.</li> - * <li><code>/google/logs/output</code> The combined - * standard output and standard error of all actions run as part of the - * pipeline execution.</li> - * <li><code>/google/logs/action/x/stdout</code> The - * complete contents of each individual action's standard - * output.</li> - * <li><code>/google/logs/action/x/stderr</code> The - * complete contents of each individual action's standard error - * output.</li> </ul> + * A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under `/google` that contains log files and other operational components. <ul> <li><code>/google/logs</code> All logs written during the pipeline execution.</li> <li><code>/google/logs/output</code> The combined standard output and standard error of all actions run as part of the pipeline execution.</li> <li><code>/google/logs/action/x/stdout</code> The complete contents of each individual action's standard output.</li> <li><code>/google/logs/action/x/stderr</code> The complete contents of each individual action's standard error output.</li> </ul> */ mounts?: Schema$Mount[]; /** - * An optional name for the container. The container hostname will be set to - * this name, making it useful for inter-container communication. The name - * must contain only upper and lowercase alphanumeric characters and hypens - * and cannot start with a hypen. + * An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hypen. */ name?: string; /** - * An optional identifier for a PID namespace to run the action inside. - * Multiple actions should use the same string to share a namespace. If - * unspecified, a separate isolated namespace is used. + * An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used. */ pidNamespace?: string; /** - * A map of containers to host port mappings for this container. If the - * container already specifies exposed ports, use the - * `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less - * than 65536. If it is zero, an unused random port is assigned. To - * determine the resulting port number, consult the `ContainerStartedEvent` - * in the operation metadata. + * A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata. */ portMappings?: {[key: string]: number}; /** - * The maximum amount of time to give the action to complete. If the action - * fails to complete before the timeout, it will be terminated and the exit - * status will be non-zero. The pipeline will continue or terminate based on - * the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. + * The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. */ timeout?: string; } @@ -275,10 +217,7 @@ export namespace genomics_v2alpha1 { */ export interface Schema$CheckInResponse { /** - * The deadline by which the worker must request an extension. The backend - * will allow for network transmission time and other delays, but the worker - * must attempt to transmit the extension request no later than the - * deadline. + * The deadline by which the worker must request an extension. The backend will allow for network transmission time and other delays, but the worker must attempt to transmit the extension request no later than the deadline. */ deadline?: string; /** @@ -287,8 +226,7 @@ export namespace genomics_v2alpha1 { metadata?: {[key: string]: any}; } /** - * Describes a Compute Engine resource that is being managed by a running - * pipeline. + * Describes a Compute Engine resource that is being managed by a running pipeline. */ export interface Schema$ComputeEngine { /** @@ -309,9 +247,7 @@ export namespace genomics_v2alpha1 { zone?: string; } /** - * An event generated when a container is forcibly terminated by the worker. - * Currently, this only occurs when the container outlives the timeout - * specified by the user. + * An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user. */ export interface Schema$ContainerKilledEvent { /** @@ -328,16 +264,11 @@ export namespace genomics_v2alpha1 { */ actionId?: number; /** - * The public IP address that can be used to connect to the container. This - * field is only populated when at least one port mapping is present. If the - * instance was created with a private address, this field will be empty - * even if port mappings exist. + * The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. */ ipAddress?: string; /** - * The container-to-host port mappings installed for this container. This - * set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag - * as well as any specified in the `Action` definition. + * The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition. */ portMappings?: {[key: string]: number}; } @@ -354,54 +285,33 @@ export namespace genomics_v2alpha1 { */ exitStatus?: number; /** - * The tail end of any content written to standard error by the container. - * If the content emits large amounts of debugging noise or contains - * sensitive information, you can prevent the content from being printed by - * setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a - * small amount of the end of the stream is captured here. The entire stream - * is stored in the `/google/logs` directory mounted into each action, and - * can be copied off the machine as described elsewhere. + * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. */ stderr?: string; } /** - * An event generated whenever a resource limitation or transient error delays - * execution of a pipeline that was otherwise ready to run. + * An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run. */ export interface Schema$DelayedEvent { /** - * A textual description of the cause of the delay. The string can change - * without notice because it is often generated by another service (such as - * Compute Engine). + * A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). */ cause?: string; /** - * If the delay was caused by a resource shortage, this field lists the - * Compute Engine metrics that are preventing this operation from running - * (for example, `CPUS` or `INSTANCES`). If the particular metric is not - * known, a single `UNKNOWN` metric will be present. + * If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present. */ metrics?: string[]; } /** - * Carries information about a disk that can be attached to a VM. See - * https://cloud.google.com/compute/docs/disks/performance for more - * information about disk type, size, and performance considerations. + * Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. */ export interface Schema$Disk { /** - * A user-supplied name for the disk. Used when mounting the disk into - * actions. The name must contain only upper and lowercase alphanumeric - * characters and hypens and cannot start with a hypen. + * A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hypen. */ name?: string; /** - * The size, in GB, of the disk to attach. If the size is not specified, a - * default is chosen to ensure reasonable I/O performance. If the disk type - * is specified as `local-ssd`, multiple local drives are automatically - * combined to provide the requested size. Note, however, that each physical - * SSD is 375GB in size, and no more than 8 drives can be attached to a - * single instance. + * The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance. */ sizeGb?: number; /** @@ -427,11 +337,7 @@ export namespace genomics_v2alpha1 { totalSpaceBytes?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -439,9 +345,7 @@ export namespace genomics_v2alpha1 { */ export interface Schema$Event { /** - * A human-readable description of the event. Note that these strings can - * change at any time without notice. Any application logic must use the - * information in the `details` field. + * A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field. */ description?: string; /** @@ -454,8 +358,7 @@ export namespace genomics_v2alpha1 { timestamp?: string; } /** - * An event generated when the execution of a pipeline has failed. Note that - * other events can continue to occur after this event. + * An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event. */ export interface Schema$FailedEvent { /** @@ -481,8 +384,7 @@ export namespace genomics_v2alpha1 { operations?: Schema$Operation[]; } /** - * Carries information about the pipeline execution that is returned in the - * long running operation's metadata field. + * Carries information about the pipeline execution that is returned in the long running operation's metadata field. */ export interface Schema$Metadata { /** @@ -494,8 +396,7 @@ export namespace genomics_v2alpha1 { */ endTime?: string; /** - * The list of events that have happened so far during the execution of this - * operation. + * The list of events that have happened so far during the execution of this operation. */ events?: Schema$Event[]; /** @@ -533,39 +434,24 @@ export namespace genomics_v2alpha1 { */ export interface Schema$Network { /** - * The network name to attach the VM's network interface to. The value - * will be prefixed with `global/networks/` unless it contains a `/`, in - * which case it is assumed to be a fully specified network resource URL. If - * unspecified, the global default network is used. + * The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used. */ name?: string; /** - * If the specified network is configured for custom subnet creation, the - * name of the subnetwork to attach the instance to must be specified here. - * The value is prefixed with `regions/x/subnetworks/` unless it contains a - * `/`, in which case it is assumed to be a fully specified subnetwork - * resource URL. If the `*` character appears in the value, it is replaced - * with the region that the virtual machine has been allocated in. + * If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with `regions/x/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in. */ subnetwork?: string; /** - * If set to true, do not attach a public IP address to the VM. Note that - * without a public IP address, additional configuration is required to - * allow the VM to access Google services. See - * https://cloud.google.com/vpc/docs/configure-private-google-access for - * more information. + * If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information. */ usePrivateAddress?: boolean; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -573,14 +459,11 @@ export namespace genomics_v2alpha1 { */ error?: Schema$Status; /** - * An OperationMetadata or Metadata object. This will always be returned - * with the Operation. + * An OperationMetadata or Metadata object. This will always be returned with the Operation. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. For example&#58; - * `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` + * The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` */ name?: string; /** @@ -597,9 +480,7 @@ export namespace genomics_v2alpha1 { */ description?: string; /** - * Optional time of when event finished. An event can have a start time and - * no finish time. If an event has a finish time, there must be a start - * time. + * Optional time of when event finished. An event can have a start time and no finish time. If an event has a finish time, there must be a start time. */ endTime?: string; /** @@ -612,8 +493,7 @@ export namespace genomics_v2alpha1 { */ export interface Schema$OperationMetadata { /** - * This field is deprecated. Use `labels` instead. Optionally provided by - * the caller when submitting the request that creates the operation. + * This field is deprecated. Use `labels` instead. Optionally provided by the caller when submitting the request that creates the operation. */ clientId?: string; /** @@ -625,14 +505,11 @@ export namespace genomics_v2alpha1 { */ endTime?: string; /** - * Optional event messages that were generated during the job's - * execution. This also contains any warnings that were generated during - * import or export. + * Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export. */ events?: Schema$OperationEvent[]; /** - * Optionally provided by the caller when submitting the request that - * creates the operation. + * Optionally provided by the caller when submitting the request that creates the operation. */ labels?: {[key: string]: string}; /** @@ -640,10 +517,7 @@ export namespace genomics_v2alpha1 { */ projectId?: string; /** - * The original request that started the operation. Note that this will be - * in current version of the API. If the operation was started with v1beta2 - * API and a GetOperation is performed on v1 API, a v1 request will be - * returned. + * The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned. */ request?: {[key: string]: any}; /** @@ -664,9 +538,7 @@ export namespace genomics_v2alpha1 { */ actions?: Schema$Action[]; /** - * The environment to pass into every action. Each action can also specify - * additional environment variables but cannot delete an entry from this map - * (though they can overwrite it with a different value). + * The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value). */ environment?: {[key: string]: string}; /** @@ -674,11 +546,7 @@ export namespace genomics_v2alpha1 { */ resources?: Schema$Resources; /** - * The maximum amount of time to give the pipeline to complete. This - * includes the time spent waiting for a worker to be allocated. If the - * pipeline fails to complete before the timeout, it will be cancelled and - * the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will - * default to 7 days. + * The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. */ timeout?: string; } @@ -701,8 +569,7 @@ export namespace genomics_v2alpha1 { imageUri?: string; } /** - * The system resources for the pipeline run. At least one zone or region - * must be specified or the pipeline run will fail. + * The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail. */ export interface Schema$Resources { /** @@ -710,8 +577,7 @@ export namespace genomics_v2alpha1 { */ projectId?: string; /** - * The list of regions allowed for VM allocation. If set, the `zones` field - * must not be set. + * The list of regions allowed for VM allocation. If set, the `zones` field must not be set. */ regions?: string[]; /** @@ -719,23 +585,16 @@ export namespace genomics_v2alpha1 { */ virtualMachine?: Schema$VirtualMachine; /** - * The list of zones allowed for VM allocation. If set, the `regions` field - * must not be set. + * The list of zones allowed for VM allocation. If set, the `regions` field must not be set. */ zones?: string[]; } /** - * The arguments to the `RunPipeline` method. The requesting user must have - * the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service - * account or the request will fail. + * The arguments to the `RunPipeline` method. The requesting user must have the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service account or the request will fail. */ export interface Schema$RunPipelineRequest { /** - * User-defined labels to associate with the returned operation. These - * labels are not propagated to any Google Cloud Platform resources used by - * the operation, and can be modified at any time. To associate labels with - * resources created while executing the operation, see the appropriate - * resource message (for example, `VirtualMachine`). + * User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`). */ labels?: {[key: string]: string}; /** @@ -744,13 +603,11 @@ export namespace genomics_v2alpha1 { pipeline?: Schema$Pipeline; } /** - * The response to the RunPipeline method, returned in the operation's - * result field on success. + * The response to the RunPipeline method, returned in the operation's result field on success. */ export interface Schema$RunPipelineResponse {} /** - * Runtime metadata that will be populated in the runtimeMetadata field of the - * Operation associated with a RunPipeline execution. + * Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution. */ export interface Schema$RuntimeMetadata { /** @@ -759,20 +616,15 @@ export namespace genomics_v2alpha1 { computeEngine?: Schema$ComputeEngine; } /** - * Holds encrypted information that is only decrypted and stored in RAM by the - * worker VM when running the pipeline. + * Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline. */ export interface Schema$Secret { /** - * The value of the cipherText response from the `encrypt` method. This - * field is intentionally unaudited. + * The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited. */ cipherText?: string; /** - * The name of the Cloud KMS key that will be used to decrypt the secret - * value. The VM service account must have the required permissions and - * authentication scopes to invoke the `decrypt` method on the specified - * key. + * The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key. */ keyName?: string; } @@ -781,51 +633,16 @@ export namespace genomics_v2alpha1 { */ export interface Schema$ServiceAccount { /** - * Email address of the service account. If not specified, the default - * Compute Engine service account for the project will be used. + * Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. */ email?: string; /** - * List of scopes to be enabled for this service account on the VM, in - * addition to the Cloud Genomics API scope. + * List of scopes to be enabled for this service account on the VM, in addition to the Cloud Genomics API scope. */ scopes?: string[]; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -833,22 +650,16 @@ export namespace genomics_v2alpha1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * An event generated when the execution of a container results in a non-zero - * exit status that was not otherwise ignored. Execution will continue, but - * only actions that are flagged as `ALWAYS_RUN` will be executed. Other - * actions will be skipped. + * An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped. */ export interface Schema$UnexpectedExitStatusEvent { /** @@ -869,32 +680,15 @@ export namespace genomics_v2alpha1 { */ accelerators?: Schema$Accelerator[]; /** - * The size of the boot disk, in GB. The boot disk must be large enough to - * accommodate all of the Docker images from each action in the pipeline at - * the same time. If not specified, a small but reasonable default value is - * used. + * The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used. */ bootDiskSizeGb?: number; /** - * The host operating system image to use. Currently, only - * Container-Optimized OS images can be used. The default value is - * `projects/cos-cloud/global/images/family/cos-stable`, which selects the - * latest stable release of Container-Optimized OS. This option is provided - * to allow testing against the beta release of the operating system to - * ensure that the new version does not interact negatively with production - * pipelines. To test a pipeline against the beta release of - * Container-Optimized OS, use the value - * `projects/cos-cloud/global/images/family/cos-beta`. + * The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is `projects/cos-cloud/global/images/family/cos-stable`, which selects the latest stable release of Container-Optimized OS. This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value `projects/cos-cloud/global/images/family/cos-beta`. */ bootImage?: string; /** - * The CPU platform to request. An instance based on a newer platform can be - * allocated, but never one with fewer capabilities. The value of this - * parameter must be a valid Compute Engine CPU platform name (such as - * "Intel Skylake"). This parameter is only useful for carefully - * optimized work loads where the CPU platform has a significant impact. For - * more information about the effect of this parameter, see - * https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + * The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. */ cpuPlatform?: string; /** @@ -902,22 +696,15 @@ export namespace genomics_v2alpha1 { */ disks?: Schema$Disk[]; /** - * Optional set of labels to apply to the VM and any attached disk - * resources. These labels must adhere to the name and value restrictions on - * VM labels imposed by Compute Engine. Labels applied at creation time to - * the VM. Applied on a best-effort basis to attached disk resources shortly - * after VM creation. + * Whether Stackdriver monitoring should be enabled on the VM. + */ + enableStackdriverMonitoring?: boolean; + /** + * Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the name and value restrictions on VM labels imposed by Compute Engine. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. */ labels?: {[key: string]: string}; /** - * The machine type of the virtual machine to create. Must be the short name - * of a standard machine type (such as "n1-standard-1") or a - * custom machine type (such as "custom-1-4096", where - * "1" indicates the number of vCPUs and "4096" - * indicates the memory in MB). See [Creating an instance with a custom - * machine - * type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) - * for more specifications on creating a custom machine type. + * The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as "n1-standard-1") or a custom machine type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "4096" indicates the memory in MB). See [Creating an instance with a custom machine type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) for more specifications on creating a custom machine type. */ machineType?: string; /** @@ -925,11 +712,7 @@ export namespace genomics_v2alpha1 { */ network?: Schema$Network; /** - * The NVIDIA driver version to use when attaching an NVIDIA GPU - * accelerator. The version specified here must be compatible with the GPU - * libraries contained in the container being executed, and must be one of - * the drivers hosted in the `nvidia-drivers-us-public` bucket on Google - * Cloud Storage. + * The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage. */ nvidiaDriverVersion?: string; /** @@ -937,8 +720,7 @@ export namespace genomics_v2alpha1 { */ preemptible?: boolean; /** - * The service account to install on the VM. This account does not need any - * permissions other than those required by the pipeline. + * The service account to install on the VM. This account does not need any permissions other than those required by the pipeline. */ serviceAccount?: Schema$ServiceAccount; } @@ -956,8 +738,7 @@ export namespace genomics_v2alpha1 { zone?: string; } /** - * An event generated when the worker VM that was assigned to the pipeline has - * been released (deleted). + * An event generated when the worker VM that was assigned to the pipeline has been released (deleted). */ export interface Schema$WorkerReleasedEvent { /** @@ -1003,14 +784,7 @@ export namespace genomics_v2alpha1 { /** * genomics.pipelines.run - * @desc Runs a pipeline. **Note:** Before you can use this method, the - * Genomics Service Agent must have access to your project. This is done - * automatically when the Cloud Genomics API is first enabled, but if you - * delete this permission, or if you enabled the Cloud Genomics API before - * the v2alpha1 API launch, you must disable and re-enable the API to grant - * the Genomics Service Agent the required permissions. Authorization - * requires the following [Google IAM](https://cloud.google.com/iam/) - * permission: * `genomics.operations.create` [1]: /genomics/gsa + * @desc Runs a pipeline. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa * @alias genomics.pipelines.run * @memberOf! () * @@ -1111,13 +885,7 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. Clients may use Operations.GetOperation or - * Operations.ListOperations to check whether the cancellation succeeded or - * the operation completed despite cancellation. Authorization requires the - * following [Google IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.cancel` + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` * @alias genomics.projects.operations.cancel * @memberOf! () * @@ -1190,11 +958,7 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.get` + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` * @alias genomics.projects.operations.get * @memberOf! () * @@ -1265,10 +1029,7 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.operations.list - * @desc Lists operations that match the specified filter in the request. - * Authorization requires the following [Google - * IAM](https://cloud.google.com/iam) permission: * - * `genomics.operations.list` + * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` * @alias genomics.projects.operations.list * @memberOf! () * @@ -1380,25 +1141,7 @@ export namespace genomics_v2alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A string for filtering Operations. In v2alpha1, the following filter - * fields are supported: * createTime: The time this job was - * created * events: The set of event (names) that have occurred while - * running the pipeline. The : operator can be used to determine if a - * particular event has occurred. * error: If the pipeline is running, - * this value is NULL. Once the pipeline finishes, the value is the - * standard Google error code. * labels.key or labels."key with space" where - * key is a label key. * done: If the pipeline is running, this value is - * false. Once the pipeline finishes, the value is true. In v1 and - * v1alpha2, the following filter fields are supported: * - * projectId: Required. Corresponds to OperationMetadata.projectId. * - * createTime: The time this job was created, in seconds from the - * [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` - * operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or - * `CANCELED`. Only one status may be specified. * labels.key where key is - * a label key. Examples: * `projectId = my-project AND createTime >= - * 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND - * createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project - * AND labels.color = *` * `projectId = my-project AND labels.color = red` + * A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red` */ filter?: string; /** @@ -1423,8 +1166,7 @@ export namespace genomics_v2alpha1 { /** * genomics.workers.checkIn - * @desc The worker uses this method to retrieve the assigned operation and - * provide periodic status updates. + * @desc The worker uses this method to retrieve the assigned operation and provide periodic status updates. * @alias genomics.workers.checkIn * @memberOf! () * diff --git a/src/apis/gmail/package.json b/src/apis/gmail/package.json index 3287efd3b99..41fff8cbc7c 100644 --- a/src/apis/gmail/package.json +++ b/src/apis/gmail/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 5c4ebabd4a2..5d21032c8db 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace gmail_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace gmail_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace gmail_v1 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.users = new Resource$Users(this.context); } @@ -110,8 +110,7 @@ export namespace gmail_v1 { */ disposition?: string; /** - * Email address to which all incoming messages are forwarded. This email - * address must be a verified member of the forwarding addresses. + * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. */ emailAddress?: string; /** @@ -131,8 +130,7 @@ export namespace gmail_v1 { */ addLabelIds?: string[]; /** - * The IDs of the messages to modify. There is a limit of 1000 ids per - * request. + * The IDs of the messages to modify. There is a limit of 1000 ids per request. */ ids?: string[]; /** @@ -141,9 +139,7 @@ export namespace gmail_v1 { removeLabelIds?: string[]; } /** - * Settings for a delegate. Delegates can read, send, and delete messages, as - * well as view and add contacts, for the delegator's account. See - * "Set up mail delegation" for more information about delegates. + * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates. */ export interface Schema$Delegate { /** @@ -151,8 +147,7 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * Indicates whether this address has been verified and can act as a - * delegate for the account. Read-only. + * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. */ verificationStatus?: string; } @@ -170,8 +165,7 @@ export namespace gmail_v1 { message?: Schema$Message; } /** - * Resource definition for Gmail filters. Filters apply to specific messages - * instead of an entire email thread. + * Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread. */ export interface Schema$Filter { /** @@ -221,20 +215,15 @@ export namespace gmail_v1 { */ hasAttachment?: boolean; /** - * Only return messages not matching the specified query. Supports the same - * query format as the Gmail search box. For example, - * "from:someuser@example.com rfc822msgid: is:unread". + * Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". */ negatedQuery?: string; /** - * Only return messages matching the specified query. Supports the same - * query format as the Gmail search box. For example, - * "from:someuser@example.com rfc822msgid: is:unread". + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". */ query?: string; /** - * The size of the entire RFC822 message in bytes, including all headers and - * attachments. + * The size of the entire RFC822 message in bytes, including all headers and attachments. */ size?: number; /** @@ -242,16 +231,11 @@ export namespace gmail_v1 { */ sizeComparison?: string; /** - * Case-insensitive phrase found in the message's subject. Trailing and - * leading whitespace are be trimmed and adjacent spaces are collapsed. + * Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed. */ subject?: string; /** - * The recipient's display name or email address. Includes recipients in - * the "to", "cc", and "bcc" header fields. - * You can use simply the local part of the email address. For example, - * "example" and "example@" both match - * "example@gmail.com". This field is case-insensitive. + * The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive. */ to?: string; } @@ -264,14 +248,12 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * Indicates whether this address has been verified and is usable for - * forwarding. Read-only. + * Indicates whether this address has been verified and is usable for forwarding. Read-only. */ verificationStatus?: string; } /** - * A record of a change to the user's mailbox. Each history change may - * affect multiple messages in multiple ways. + * A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways. */ export interface Schema$History { /** @@ -287,9 +269,7 @@ export namespace gmail_v1 { */ labelsRemoved?: Schema$HistoryLabelRemoved[]; /** - * List of messages changed in this history record. The fields for specific - * change types, such as messagesAdded may duplicate messages in this field. - * We recommend using the specific change-type fields instead of this. + * List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this. */ messages?: Schema$Message[]; /** @@ -326,9 +306,7 @@ export namespace gmail_v1 { */ export interface Schema$ImapSettings { /** - * If this value is true, Gmail will immediately expunge a message when it - * is marked as deleted in IMAP. Otherwise, Gmail will wait for an update - * from the client before expunging messages marked as deleted. + * If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted. */ autoExpunge?: boolean; /** @@ -336,25 +314,20 @@ export namespace gmail_v1 { */ enabled?: boolean; /** - * The action that will be executed on a message when it is marked as - * deleted and expunged from the last visible IMAP folder. + * The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder. */ expungeBehavior?: string; /** - * An optional limit on the number of messages that an IMAP folder may - * contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero - * is interpreted to mean that there is no limit. + * An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit. */ maxFolderSize?: number; } /** - * Labels are used to categorize messages and threads within the user's - * mailbox. + * Labels are used to categorize messages and threads within the user's mailbox. */ export interface Schema$Label { /** - * The color to assign to the label. Color is only available for labels that - * have their type set to user. + * The color to assign to the label. Color is only available for labels that have their type set to user. */ color?: Schema$LabelColor; /** @@ -366,8 +339,7 @@ export namespace gmail_v1 { */ labelListVisibility?: string; /** - * The visibility of the label in the message list in the Gmail web - * interface. + * The visibility of the label in the message list in the Gmail web interface. */ messageListVisibility?: string; /** @@ -391,47 +363,29 @@ export namespace gmail_v1 { */ threadsUnread?: number; /** - * The owner type for the label. User labels are created by the user and can - * be modified and deleted by the user and can be applied to any message or - * thread. System labels are internally created and cannot be added, - * modified, or deleted. System labels may be able to be applied to or - * removed from messages and threads under some circumstances but this is - * not guaranteed. For example, users can apply and remove the INBOX and - * UNREAD labels from messages and threads, but cannot apply or remove the - * DRAFTS or SENT labels from messages or threads. + * The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads. */ type?: string; } export interface Schema$LabelColor { /** - * The background color represented as hex string #RRGGBB (ex #000000). This - * field is required in order to set the color of a label. Only the - * following predefined set of color values are allowed: #000000, #434343, - * #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, - * #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, - * #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, - * #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, - * #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, - * #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, - * #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, - * #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c + * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c */ backgroundColor?: string; /** - * The text color of the label, represented as hex string. This field is - * required in order to set the color of a label. Only the following - * predefined set of color values are allowed: #000000, #434343, #666666, - * #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, - * #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, - * #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, - * #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, - * #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, - * #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, - * #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, - * #076239, #1a764d, #1c4587, #41236d, #83334c + * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c */ textColor?: string; } + /** + * Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. + */ + export interface Schema$LanguageSettings { + /** + * The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). + */ + displayLanguage?: string; + } /** * Response for the ListDelegates method. */ @@ -475,8 +429,7 @@ export namespace gmail_v1 { } export interface Schema$ListHistoryResponse { /** - * List of history records. Any messages contained in the response will - * typically only have id and threadId fields populated. + * List of history records. Any messages contained in the response will typically only have id and threadId fields populated. */ history?: Schema$History[]; /** @@ -496,9 +449,7 @@ export namespace gmail_v1 { } export interface Schema$ListMessagesResponse { /** - * List of messages. Note that each message resource contains only an id and - * a threadId. Additional message details can be fetched using the - * messages.get method. + * List of messages. Note that each message resource contains only an id and a threadId. Additional message details can be fetched using the messages.get method. */ messages?: Schema$Message[]; /** @@ -535,9 +486,7 @@ export namespace gmail_v1 { */ resultSizeEstimate?: number; /** - * List of threads. Note that each thread resource does not contain a list - * of messages. The list of messages for a given thread can be fetched using - * the threads.get method. + * List of threads. Note that each thread resource does not contain a list of messages. The list of messages for a given thread can be fetched using the threads.get method. */ threads?: Schema$Thread[]; } @@ -554,11 +503,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The internal message creation timestamp (epoch ms), which determines - * ordering in the inbox. For normal SMTP-received email, this represents - * the time the message was originally accepted by Google, which is more - * reliable than the Date header. However, for API-migrated mail, it can be - * configured by client to be based on the Date header. + * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header. */ internalDate?: string; /** @@ -570,9 +515,7 @@ export namespace gmail_v1 { */ payload?: Schema$MessagePart; /** - * The entire email message in an RFC 2822 formatted and base64url encoded - * string. Returned in messages.get and drafts.get responses when the - * format=RAW parameter is supplied. + * The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied. */ raw?: string; /** @@ -584,11 +527,7 @@ export namespace gmail_v1 { */ snippet?: string; /** - * The ID of the thread the message belongs to. To add a message or draft to - * a thread, the following criteria must be met: - The requested threadId - * must be specified on the Message or Draft.Message you supply with your - * request. - The References and In-Reply-To headers must be set in - * compliance with the RFC 2822 standard. - The Subject headers must match. + * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: - The requested threadId must be specified on the Message or Draft.Message you supply with your request. - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. - The Subject headers must match. */ threadId?: string; } @@ -597,19 +536,15 @@ export namespace gmail_v1 { */ export interface Schema$MessagePart { /** - * The message part body for this part, which may be empty for container - * MIME message parts. + * The message part body for this part, which may be empty for container MIME message parts. */ body?: Schema$MessagePartBody; /** - * The filename of the attachment. Only present if this message part - * represents an attachment. + * The filename of the attachment. Only present if this message part represents an attachment. */ filename?: string; /** - * List of headers on this message part. For the top-level message part, - * representing the entire message payload, it will contain the standard RFC - * 2822 email headers such as To, From, and Subject. + * List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject. */ headers?: Schema$MessagePartHeader[]; /** @@ -621,10 +556,7 @@ export namespace gmail_v1 { */ partId?: string; /** - * The child MIME message parts of this part. This only applies to container - * MIME message parts, for example multipart/*. For non- container MIME - * message part types, such as text/plain, this field is empty. For more - * information, see RFC 1521. + * The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521. */ parts?: Schema$MessagePart[]; } @@ -633,17 +565,11 @@ export namespace gmail_v1 { */ export interface Schema$MessagePartBody { /** - * When present, contains the ID of an external attachment that can be - * retrieved in a separate messages.attachments.get request. When not - * present, the entire content of the message part body is contained in the - * data field. + * When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field. */ attachmentId?: string; /** - * The body data of a MIME message part as a base64url encoded string. May - * be empty for MIME container types that have no message body or when the - * body data is sent as a separate attachment. An attachment ID is present - * if the body data is contained in a separate attachment. + * The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment. */ data?: string; /** @@ -657,8 +583,7 @@ export namespace gmail_v1 { */ name?: string; /** - * The value of the header after the : separator. For example, - * someuser@example.com. + * The value of the header after the : separator. For example, someuser@example.com. */ value?: string; } @@ -691,8 +616,7 @@ export namespace gmail_v1 { */ accessWindow?: string; /** - * The action that will be executed on a message after it has been fetched - * via POP. + * The action that will be executed on a message after it has been fetched via POP. */ disposition?: string; } @@ -718,70 +642,43 @@ export namespace gmail_v1 { threadsTotal?: number; } /** - * Settings associated with a send-as alias, which can be either the primary - * login address associated with the account or a custom "from" - * address. Send-as aliases correspond to the "Send Mail As" feature - * in the web interface. + * Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. */ export interface Schema$SendAs { /** - * A name that appears in the "From:" header for mail sent using - * this alias. For custom "from" addresses, when this is empty, - * Gmail will populate the "From:" header with the name that is - * used for the primary address associated with the account. If the admin - * has disabled the ability for users to update their name format, requests - * to update this field for the primary login will silently fail. + * A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail. */ displayName?: string; /** - * Whether this address is selected as the default "From:" address - * in situations such as composing a new message or sending a vacation - * auto-reply. Every Gmail account has exactly one default send-as address, - * so the only legal value that clients may write to this field is true. - * Changing this from false to true for an address will result in this field - * becoming false for the other previous default address. + * Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address. */ isDefault?: boolean; /** - * Whether this address is the primary address used to login to the account. - * Every Gmail account has exactly one primary address, and it cannot be - * deleted from the collection of send-as aliases. This field is read-only. + * Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only. */ isPrimary?: boolean; /** - * An optional email address that is included in a "Reply-To:" - * header for mail sent using this alias. If this is empty, Gmail will not - * generate a "Reply-To:" header. + * An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header. */ replyToAddress?: string; /** - * The email address that appears in the "From:" header for mail - * sent using this alias. This is read-only for all operations except - * create. + * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. */ sendAsEmail?: string; /** - * An optional HTML signature that is included in messages composed with - * this alias in the Gmail web UI. + * An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. */ signature?: string; /** - * An optional SMTP service that will be used as an outbound relay for mail - * sent using this alias. If this is empty, outbound mail will be sent - * directly from Gmail's servers to the destination SMTP service. This - * setting only applies to custom "from" aliases. + * An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases. */ smtpMsa?: Schema$SmtpMsa; /** - * Whether Gmail should treat this address as an alias for the user's - * primary email address. This setting only applies to custom - * "from" aliases. + * Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases. */ treatAsAlias?: boolean; /** - * Indicates whether this address has been verified for use as a send-as - * alias. Read-only. This setting only applies to custom "from" - * aliases. + * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. */ verificationStatus?: string; } @@ -802,8 +699,7 @@ export namespace gmail_v1 { */ id?: string; /** - * Whether this SmimeInfo is the default one for this user's send-as - * address. + * Whether this SmimeInfo is the default one for this user's send-as address. */ isDefault?: boolean; /** @@ -811,17 +707,11 @@ export namespace gmail_v1 { */ issuerCn?: string; /** - * PEM formatted X509 concatenated certificate string (standard base64 - * encoding). Format used for returning key, which includes public key as - * well as certificate chain (not private key). + * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). */ pem?: string; /** - * PKCS#12 format containing a single private/public key pair and - * certificate chain. This format is only accepted from client for creating - * a new SmimeInfo and is never returned, because the private key is not - * intended to be exported. PKCS#12 may be encrypted, in which case - * encryptedKeyPassword should be set appropriately. + * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. */ pkcs12?: string; } @@ -834,9 +724,7 @@ export namespace gmail_v1 { */ host?: string; /** - * The password that will be used for authentication with the SMTP service. - * This is a write-only field that can be specified in requests to create or - * update SendAs settings; it is never populated in responses. + * The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses. */ password?: string; /** @@ -844,14 +732,11 @@ export namespace gmail_v1 { */ port?: number; /** - * The protocol that will be used to secure communication with the SMTP - * service. Required. + * The protocol that will be used to secure communication with the SMTP service. Required. */ securityMode?: string; /** - * The username that will be used for authentication with the SMTP service. - * This is a write-only field that can be specified in requests to create or - * update SendAs settings; it is never populated in responses. + * The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses. */ username?: string; } @@ -877,8 +762,7 @@ export namespace gmail_v1 { snippet?: string; } /** - * Vacation auto-reply settings for an account. These settings correspond to - * the "Vacation responder" feature in the web interface. + * Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. */ export interface Schema$VacationSettings { /** @@ -886,15 +770,11 @@ export namespace gmail_v1 { */ enableAutoReply?: boolean; /** - * An optional end time for sending auto-replies (epoch ms). When this is - * specified, Gmail will automatically reply only to messages that it - * receives before the end time. If both startTime and endTime are - * specified, startTime must precede endTime. + * An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime. */ endTime?: string; /** - * Response body in HTML format. Gmail will sanitize the HTML before storing - * it. + * Response body in HTML format. Gmail will sanitize the HTML before storing it. */ responseBodyHtml?: string; /** @@ -902,27 +782,19 @@ export namespace gmail_v1 { */ responseBodyPlainText?: string; /** - * Optional text to prepend to the subject line in vacation responses. In - * order to enable auto-replies, either the response subject or the response - * body must be nonempty. + * Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. */ responseSubject?: string; /** - * Flag that determines whether responses are sent to recipients who are not - * in the user's list of contacts. + * Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. */ restrictToContacts?: boolean; /** - * Flag that determines whether responses are sent to recipients who are - * outside of the user's domain. This feature is only available for G - * Suite users. + * Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users. */ restrictToDomain?: boolean; /** - * An optional start time for sending auto-replies (epoch ms). When this is - * specified, Gmail will automatically reply only to messages that it - * receives after the start time. If both startTime and endTime are - * specified, startTime must precede endTime. + * An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime. */ startTime?: string; } @@ -935,20 +807,11 @@ export namespace gmail_v1 { */ labelFilterAction?: string; /** - * List of label_ids to restrict notifications about. By default, if - * unspecified, all changes are pushed out. If specified then dictates which - * labels are required for a push notification to be generated. + * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. */ labelIds?: string[]; /** - * A fully qualified Google Cloud Pub/Sub API topic name to publish the - * events to. This topic name **must** already exist in Cloud Pub/Sub and - * you **must** have already granted gmail "publish" permission on - * it. For example, - * "projects/my-project-identifier/topics/my-topic-name" (using - * the Cloud Pub/Sub "v1" topic naming format). Note that the - * "my-project-identifier" portion must exactly match your Google - * developer project id (the one executing this watch request). + * A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request). */ topicName?: string; } @@ -957,8 +820,7 @@ export namespace gmail_v1 { */ export interface Schema$WatchResponse { /** - * When Gmail will stop sending notifications for mailbox updates (epoch - * millis). Call watch again before this time to renew the watch. + * When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch. */ expiration?: string; /** @@ -1129,8 +991,7 @@ export namespace gmail_v1 { /** * gmail.users.watch - * @desc Set up or update a push notification watch on the given user - * mailbox. + * @desc Set up or update a push notification watch on the given user mailbox. * @alias gmail.users.watch * @memberOf! () * @@ -1210,8 +1071,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1222,8 +1082,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1234,8 +1093,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1333,8 +1191,7 @@ export namespace gmail_v1 { /** * gmail.users.drafts.delete - * @desc Immediately and permanently deletes the specified draft. Does not - * simply trash it. + * @desc Immediately and permanently deletes the specified draft. Does not simply trash it. * @alias gmail.users.drafts.delete * @memberOf! () * @@ -1558,8 +1415,7 @@ export namespace gmail_v1 { /** * gmail.users.drafts.send - * @desc Sends the specified, existing draft to the recipients in the To, - * Cc, and Bcc headers. + * @desc Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. * @alias gmail.users.drafts.send * @memberOf! () * @@ -1725,8 +1581,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1762,8 +1617,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1782,8 +1636,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1807,14 +1660,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return draft messages matching the specified query. Supports the - * same query format as the Gmail search box. For example, - * "from:someuser@example.com rfc822msgid: is:unread". + * Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". */ q?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1826,8 +1676,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1863,8 +1712,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1897,8 +1745,7 @@ export namespace gmail_v1 { /** * gmail.users.history.list - * @desc Lists the history of all changes to the given mailbox. History - * results are returned in chronological order (increasing historyId). + * @desc Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). * @alias gmail.users.history.list * @memberOf! () * @@ -2000,22 +1847,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Required. Returns history records after the specified startHistoryId. The - * supplied startHistoryId should be obtained from the historyId of a - * message, thread, or previous list response. History IDs increase - * chronologically but are not contiguous with random gaps in between valid - * IDs. Supplying an invalid or out of date startHistoryId typically returns - * an HTTP 404 error code. A historyId is typically valid for at least a - * week, but in some rare circumstances may be valid for only a few hours. - * If you receive an HTTP 404 error response, your application should - * perform a full sync. If you receive no nextPageToken in the response, - * there are no updates to retrieve and you can store the returned historyId - * for a future request. + * Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. */ startHistoryId?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2101,8 +1937,7 @@ export namespace gmail_v1 { /** * gmail.users.labels.delete - * @desc Immediately and permanently deletes the specified label and removes - * it from any messages and threads that it is applied to. + * @desc Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. * @alias gmail.users.labels.delete * @memberOf! () * @@ -2476,8 +2311,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2498,8 +2332,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2514,8 +2347,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2527,8 +2359,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2544,8 +2375,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2566,8 +2396,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2587,8 +2416,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.batchDelete - * @desc Deletes many messages by message ID. Provides no guarantees that - * messages were not already deleted or even existed at all. + * @desc Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. * @alias gmail.users.messages.batchDelete * @memberOf! () * @@ -2732,8 +2560,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.delete - * @desc Immediately and permanently deletes the specified message. This - * operation cannot be undone. Prefer messages.trash instead. + * @desc Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. * @alias gmail.users.messages.delete * @memberOf! () * @@ -2881,9 +2708,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.import - * @desc Imports a message into only this user's mailbox, with standard email - * delivery scanning and classification similar to receiving via SMTP. Does not - * send a message. + * @desc Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. * @alias gmail.users.messages.import * @memberOf! () * @@ -3201,8 +3026,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.send - * @desc Sends the specified message to the recipients in the To, Cc, and - * Bcc headers. + * @desc Sends the specified message to the recipients in the To, Cc, and Bcc headers. * @alias gmail.users.messages.send * @memberOf! () * @@ -3432,8 +3256,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3450,8 +3273,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3472,8 +3294,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3497,8 +3318,7 @@ export namespace gmail_v1 { */ metadataHeaders?: string[]; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3510,8 +3330,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Mark the email as permanently deleted (not TRASH) and only visible in - * Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -3519,18 +3338,15 @@ export namespace gmail_v1 { */ internalDateSource?: string; /** - * Ignore the Gmail spam classifier decision and never mark this email as - * SPAM in the mailbox. + * Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. */ neverMarkSpam?: boolean; /** - * Process calendar invites in the email and add any extracted meetings to - * the Google Calendar for this user. + * Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. */ processForCalendar?: boolean; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3562,8 +3378,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Mark the email as permanently deleted (not TRASH) and only visible in - * Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -3571,8 +3386,7 @@ export namespace gmail_v1 { */ internalDateSource?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3608,8 +3422,7 @@ export namespace gmail_v1 { */ includeSpamTrash?: boolean; /** - * Only return messages with labels that match all of the specified label - * IDs. + * Only return messages with labels that match all of the specified label IDs. */ labelIds?: string[]; /** @@ -3621,16 +3434,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return messages matching the specified query. Supports the same - * query format as the Gmail search box. For example, - * "from:someuser@example.com rfc822msgid: - * is:unread". Parameter cannot be used when accessing the api using the - * gmail.metadata scope. + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3646,8 +3454,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3664,8 +3471,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3701,8 +3507,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3718,8 +3523,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3823,8 +3627,7 @@ export namespace gmail_v1 { */ messageId?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3994,6 +3797,79 @@ export namespace gmail_v1 { } } + /** + * gmail.users.settings.getLanguage + * @desc Gets language settings. + * @alias gmail.users.settings.getLanguage + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getLanguage( + params?: Params$Resource$Users$Settings$Getlanguage, + options?: MethodOptions + ): GaxiosPromise; + getLanguage( + params: Params$Resource$Users$Settings$Getlanguage, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getLanguage( + params: Params$Resource$Users$Settings$Getlanguage, + callback: BodyResponseCallback + ): void; + getLanguage(callback: BodyResponseCallback): void; + getLanguage( + paramsOrCallback?: + | Params$Resource$Users$Settings$Getlanguage + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Settings$Getlanguage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Settings$Getlanguage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/gmail/v1/users/{userId}/settings/language' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * gmail.users.settings.getPop * @desc Gets POP settings. @@ -4143,10 +4019,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.updateAutoForwarding - * @desc Updates the auto-forwarding setting for the specified account. A - * verified forwarding address must be specified when auto-forwarding is - * enabled. This method is only available to service account clients that - * have been delegated domain-wide authority. + * @desc Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.updateAutoForwarding * @memberOf! () * @@ -4295,6 +4168,82 @@ export namespace gmail_v1 { } } + /** + * gmail.users.settings.updateLanguage + * @desc Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. + * @alias gmail.users.settings.updateLanguage + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {().LanguageSettings} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateLanguage( + params?: Params$Resource$Users$Settings$Updatelanguage, + options?: MethodOptions + ): GaxiosPromise; + updateLanguage( + params: Params$Resource$Users$Settings$Updatelanguage, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateLanguage( + params: Params$Resource$Users$Settings$Updatelanguage, + callback: BodyResponseCallback + ): void; + updateLanguage( + callback: BodyResponseCallback + ): void; + updateLanguage( + paramsOrCallback?: + | Params$Resource$Users$Settings$Updatelanguage + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Settings$Updatelanguage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Settings$Updatelanguage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/gmail/v1/users/{userId}/settings/language' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * gmail.users.settings.updatePop * @desc Updates POP settings. @@ -4455,8 +4404,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4468,8 +4416,19 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. + */ + userId?: string; + } + export interface Params$Resource$Users$Settings$Getlanguage + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4481,8 +4440,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4494,8 +4452,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4507,8 +4464,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4525,8 +4481,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4535,6 +4490,23 @@ export namespace gmail_v1 { */ requestBody?: Schema$ImapSettings; } + export interface Params$Resource$Users$Settings$Updatelanguage + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User's email address. The special value "me" can be used to indicate the authenticated user. + */ + userId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LanguageSettings; + } export interface Params$Resource$Users$Settings$Updatepop extends StandardParameters { /** @@ -4543,8 +4515,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4561,8 +4532,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4580,17 +4550,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.create - * @desc Adds a delegate with its verification status set directly to - * accepted, without sending any verification email. The delegate user must - * be a member of the same G Suite organization as the delegator user. Gmail - * imposes limtations on the number of delegates and delegators each user in - * a G Suite organization can have. These limits depend on your - * organization, but in general each user can have up to 25 delegates and up - * to 10 delegators. Note that a delegate user must be referred to by their - * primary email address, and not an email alias. Also note that when a new - * delegate is created, there may be up to a one minute delay before the new - * delegate is available for use. This method is only available to service - * account clients that have been delegated domain-wide authority. + * @desc Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limtations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.delegates.create * @memberOf! () * @@ -4662,11 +4622,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.delete - * @desc Removes the specified delegate (which can be of any verification - * status), and revokes any verification that may have been required for - * using it. Note that a delegate user must be referred to by their primary - * email address, and not an email alias. This method is only available to - * service account clients that have been delegated domain-wide authority. + * @desc Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.delegates.delete * @memberOf! () * @@ -4739,10 +4695,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.get - * @desc Gets the specified delegate. Note that a delegate user must be - * referred to by their primary email address, and not an email alias. This - * method is only available to service account clients that have been - * delegated domain-wide authority. + * @desc Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.delegates.get * @memberOf! () * @@ -4815,9 +4768,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.list - * @desc Lists the delegates for the specified account. This method is only - * available to service account clients that have been delegated domain-wide - * authority. + * @desc Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.delegates.list * @memberOf! () * @@ -4899,8 +4850,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4921,8 +4871,7 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4934,13 +4883,11 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The email address of the user whose delegate relationship is to be - * retrieved. + * The email address of the user whose delegate relationship is to be retrieved. */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4952,8 +4899,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5262,8 +5208,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -5284,8 +5229,7 @@ export namespace gmail_v1 { */ id?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5301,8 +5245,7 @@ export namespace gmail_v1 { */ id?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5314,8 +5257,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5328,12 +5270,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.forwardingAddresses.create - * @desc Creates a forwarding address. If ownership verification is - * required, a message will be sent to the recipient and the resource's - * verification status will be set to pending; otherwise, the resource will - * be created with verification status set to accepted. This method is only - * available to service account clients that have been delegated domain-wide - * authority. + * @desc Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.forwardingAddresses.create * @memberOf! () * @@ -5407,10 +5344,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.forwardingAddresses.delete - * @desc Deletes the specified forwarding address and revokes any - * verification that may have been required. This method is only available - * to service account clients that have been delegated domain-wide - * authority. + * @desc Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.forwardingAddresses.delete * @memberOf! () * @@ -5647,8 +5581,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -5669,8 +5602,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5686,8 +5618,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5699,8 +5630,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5717,15 +5647,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.create - * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, - * Gmail will attempt to connect to the SMTP service to validate the - * configuration before creating the alias. If ownership verification is - * required for the alias, a message will be sent to the email address and - * the resource's verification status will be set to pending; otherwise, the - * resource will be created with verification status set to accepted. If a - * signature is provided, Gmail will sanitize the HTML before saving it with - * the alias. This method is only available to service account clients that - * have been delegated domain-wide authority. + * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.create * @memberOf! () * @@ -5798,9 +5720,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.delete - * @desc Deletes the specified send-as alias. Revokes any verification that - * may have been required for using it. This method is only available to - * service account clients that have been delegated domain-wide authority. + * @desc Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.delete * @memberOf! () * @@ -5872,8 +5792,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.get - * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if - * the specified address is not a member of the collection. + * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. * @alias gmail.users.settings.sendAs.get * @memberOf! () * @@ -5945,9 +5864,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.list - * @desc Lists the send-as aliases for the specified account. The result - * includes the primary send-as address associated with the account as well - * as any custom "from" aliases. + * @desc Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. * @alias gmail.users.settings.sendAs.list * @memberOf! () * @@ -6021,11 +5938,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.patch - * @desc Updates a send-as alias. If a signature is provided, Gmail will - * sanitize the HTML before saving it with the alias. Addresses other than - * the primary address for the account can only be updated by service - * account clients that have been delegated domain-wide authority. This - * method supports patch semantics. + * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics. * @alias gmail.users.settings.sendAs.patch * @memberOf! () * @@ -6098,10 +6011,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.update - * @desc Updates a send-as alias. If a signature is provided, Gmail will - * sanitize the HTML before saving it with the alias. Addresses other than - * the primary address for the account can only be updated by service - * account clients that have been delegated domain-wide authority. + * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.update * @memberOf! () * @@ -6174,10 +6084,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.verify - * @desc Sends a verification email to the specified send-as alias address. - * The verification status must be pending. This method is only available - * to service account clients that have been delegated domain-wide - * authority. + * @desc Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.verify * @memberOf! () * @@ -6257,8 +6164,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -6279,8 +6185,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6296,8 +6201,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6309,8 +6213,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6326,8 +6229,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -6348,8 +6250,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -6370,8 +6271,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the - * authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6384,8 +6284,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.smimeInfo.delete - * @desc Deletes the specified S/MIME config for the specified send-as - * alias. + * @desc Deletes the specified S/MIME config for the specified send-as alias. * @alias gmail.users.settings.sendAs.smimeInfo.delete * @memberOf! () * @@ -6535,8 +6434,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.smimeInfo.insert - * @desc Insert (upload) the given S/MIME config for the specified send-as - * alias. Note that pkcs12 format is required for the key. + * @desc Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. * @alias gmail.users.settings.sendAs.smimeInfo.insert * @memberOf! () * @@ -6774,13 +6672,11 @@ export namespace gmail_v1 { */ id?: string; /** - * The email address that appears in the "From:" header for mail sent using - * this alias. + * The email address that appears in the "From:" header for mail sent using this alias. */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6796,13 +6692,11 @@ export namespace gmail_v1 { */ id?: string; /** - * The email address that appears in the "From:" header for mail sent using - * this alias. + * The email address that appears in the "From:" header for mail sent using this alias. */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6814,13 +6708,11 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The email address that appears in the "From:" header for mail sent using - * this alias. + * The email address that appears in the "From:" header for mail sent using this alias. */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -6837,13 +6729,11 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The email address that appears in the "From:" header for mail sent using - * this alias. + * The email address that appears in the "From:" header for mail sent using this alias. */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6859,13 +6749,11 @@ export namespace gmail_v1 { */ id?: string; /** - * The email address that appears in the "From:" header for mail sent using - * this alias. + * The email address that appears in the "From:" header for mail sent using this alias. */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6878,8 +6766,7 @@ export namespace gmail_v1 { /** * gmail.users.threads.delete - * @desc Immediately and permanently deletes the specified thread. This - * operation cannot be undone. Prefer threads.trash instead. + * @desc Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. * @alias gmail.users.threads.delete * @memberOf! () * @@ -7106,8 +6993,7 @@ export namespace gmail_v1 { /** * gmail.users.threads.modify - * @desc Modifies the labels applied to the thread. This applies to all - * messages in the thread. + * @desc Modifies the labels applied to the thread. This applies to all messages in the thread. * @alias gmail.users.threads.modify * @memberOf! () * @@ -7335,8 +7221,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7360,8 +7245,7 @@ export namespace gmail_v1 { */ metadataHeaders?: string[]; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7377,8 +7261,7 @@ export namespace gmail_v1 { */ includeSpamTrash?: boolean; /** - * Only return threads with labels that match all of the specified label - * IDs. + * Only return threads with labels that match all of the specified label IDs. */ labelIds?: string[]; /** @@ -7390,15 +7273,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return threads matching the specified query. Supports the same query - * format as the Gmail search box. For example, "from:someuser@example.com - * rfc822msgid: is:unread". Parameter cannot be used when accessing the api - * using the gmail.metadata scope. + * Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7414,8 +7293,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -7436,8 +7314,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7453,8 +7330,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate - * the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } diff --git a/src/apis/groupsmigration/package.json b/src/apis/groupsmigration/package.json index 2640e5ef089..43682393f71 100644 --- a/src/apis/groupsmigration/package.json +++ b/src/apis/groupsmigration/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/groupsmigration/v1.ts b/src/apis/groupsmigration/v1.ts index a00e8214ea2..61db682642e 100644 --- a/src/apis/groupsmigration/v1.ts +++ b/src/apis/groupsmigration/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace groupsmigration_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace groupsmigration_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace groupsmigration_v1 { archive: Resource$Archive; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.archive = new Resource$Archive(this.context); } diff --git a/src/apis/groupssettings/package.json b/src/apis/groupssettings/package.json index 99268965baf..d0196530352 100644 --- a/src/apis/groupssettings/package.json +++ b/src/apis/groupssettings/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/groupssettings/v1.ts b/src/apis/groupssettings/v1.ts index fca2cc08ece..f7df7c9e7bf 100644 --- a/src/apis/groupssettings/v1.ts +++ b/src/apis/groupssettings/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace groupssettings_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace groupssettings_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace groupssettings_v1 { groups: Resource$Groups; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.groups = new Resource$Groups(this.context); } @@ -130,8 +130,7 @@ export namespace groupssettings_v1 { */ customReplyTo?: string; /** - * If any of the settings that will be merged have custom roles which is - * anything other than owners, managers, or group scopes. + * If any of the settings that will be merged have custom roles which is anything other than owners, managers, or group scopes. */ customRolesEnabledForSettingsToBeMerged?: string; /** @@ -179,13 +178,11 @@ export namespace groupssettings_v1 { */ membersCanPostAsTheGroup?: string; /** - * Default message display font. Possible values are: DEFAULT_FONT - * FIXED_WIDTH_FONT + * Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT */ messageDisplayFont?: string; /** - * Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES - * MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE + * Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE */ messageModerationLevel?: string; /** @@ -197,9 +194,7 @@ export namespace groupssettings_v1 { */ primaryLanguage?: string; /** - * Whome should the default reply to a message go to. Possible values are: - * REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER - * REPLY_TO_IGNORE REPLY_TO_MANAGERS + * Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS */ replyTo?: string; /** @@ -211,194 +206,147 @@ export namespace groupssettings_v1 { */ showInGroupDirectory?: string; /** - * Moderation level for messages detected as spam. Possible values are: - * ALLOW MODERATE SILENTLY_MODERATE REJECT + * Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT */ spamModerationLevel?: string; /** - * Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD - * ALL_OWNERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD + * Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_OWNERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD */ whoCanAdd?: string; /** - * Permission to add references to a topic. Possible values are: NONE - * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to add references to a topic. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanAddReferences?: string; /** - * Permission to approve members. Possible values are: - * ALL_OWNERS_CAN_APPROVE ALL_MANAGERS_CAN_APPROVE ALL_MEMBERS_CAN_APPROVE - * NONE_CAN_APPROVE + * Permission to approve members. Possible values are: ALL_OWNERS_CAN_APPROVE ALL_MANAGERS_CAN_APPROVE ALL_MEMBERS_CAN_APPROVE NONE_CAN_APPROVE */ whoCanApproveMembers?: string; /** - * Permission to approve pending messages in the moderation queue. Possible - * values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to approve pending messages in the moderation queue. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanApproveMessages?: string; /** - * Permission to assign topics in a forum to another user. Possible values - * are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to assign topics in a forum to another user. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanAssignTopics?: string; /** - * Permission for content assistants. Possible values are: Possible values - * are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission for content assistants. Possible values are: Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanAssistContent?: string; /** - * Permission to ban users. Possible values are: NONE OWNERS_ONLY - * OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to ban users. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanBanUsers?: string; /** - * Permission to contact owner of the group via web UI. Possible values are: - * ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT - * ALL_MANAGERS_CAN_CONTACT + * Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT */ whoCanContactOwner?: string; /** - * Permission to delete replies to topics. Possible values are: NONE - * OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to delete replies to topics. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanDeleteAnyPost?: string; /** - * Permission to delete topics. Possible values are: NONE OWNERS_ONLY - * OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to delete topics. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanDeleteTopics?: string; /** - * Permission for who can discover the group. Possible values are: - * ALL_MEMBERS_CAN_DISCOVER ALL_IN_DOMAIN_CAN_DISCOVER ANYONE_CAN_DISCOVER + * Permission for who can discover the group. Possible values are: ALL_MEMBERS_CAN_DISCOVER ALL_IN_DOMAIN_CAN_DISCOVER ANYONE_CAN_DISCOVER */ whoCanDiscoverGroup?: string; /** - * Permission to enter free form tags for topics in a forum. Possible values - * are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to enter free form tags for topics in a forum. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanEnterFreeFormTags?: string; /** - * Permission to hide posts by reporting them as abuse. Possible values are: - * NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to hide posts by reporting them as abuse. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanHideAbuse?: string; /** - * Permissions to invite members. Possible values are: - * ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE ALL_OWNERS_CAN_INVITE - * NONE_CAN_INVITE + * Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE ALL_OWNERS_CAN_INVITE NONE_CAN_INVITE */ whoCanInvite?: string; /** - * Permissions to join the group. Possible values are: ANYONE_CAN_JOIN - * ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN + * Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN */ whoCanJoin?: string; /** - * Permission to leave the group. Possible values are: - * ALL_MANAGERS_CAN_LEAVE ALL_OWNERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE - * NONE_CAN_LEAVE + * Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_OWNERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE */ whoCanLeaveGroup?: string; /** - * Permission to lock topics. Possible values are: NONE OWNERS_ONLY - * OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to lock topics. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanLockTopics?: string; /** - * Permission to make topics appear at the top of the topic list. Possible - * values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS - * ALL_MEMBERS + * Permission to make topics appear at the top of the topic list. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanMakeTopicsSticky?: string; /** - * Permission to mark a topic as a duplicate of another topic. Possible - * values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS - * ALL_MEMBERS + * Permission to mark a topic as a duplicate of another topic. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanMarkDuplicate?: string; /** - * Permission to mark any other user's post as a favorite reply. - * Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS - * ALL_MEMBERS + * Permission to mark any other user's post as a favorite reply. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanMarkFavoriteReplyOnAnyTopic?: string; /** - * Permission to mark a post for a topic they started as a favorite reply. - * Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS - * ALL_MEMBERS + * Permission to mark a post for a topic they started as a favorite reply. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanMarkFavoriteReplyOnOwnTopic?: string; /** - * Permission to mark a topic as not needing a response. Possible values - * are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to mark a topic as not needing a response. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanMarkNoResponseNeeded?: string; /** - * Permission for content moderation. Possible values are: NONE OWNERS_ONLY - * OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission for content moderation. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanModerateContent?: string; /** - * Permission for membership moderation. Possible values are: NONE - * OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission for membership moderation. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanModerateMembers?: string; /** - * Permission to modify members (change member roles). Possible values are: - * NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to modify members (change member roles). Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanModifyMembers?: string; /** - * Permission to change tags and categories. Possible values are: NONE - * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to change tags and categories. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanModifyTagsAndCategories?: string; /** - * Permission to move topics into the group or forum. Possible values are: - * NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to move topics into the group or forum. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanMoveTopicsIn?: string; /** - * Permission to move topics out of the group or forum. Possible values are: - * NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to move topics out of the group or forum. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanMoveTopicsOut?: string; /** - * Permission to post announcements, a special topic type. Possible values - * are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to post announcements, a special topic type. Possible values are: NONE OWNERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanPostAnnouncements?: string; /** - * Permissions to post messages to the group. Possible values are: - * NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST - * ALL_OWNERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST + * Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_OWNERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST */ whoCanPostMessage?: string; /** - * Permission to take topics in a forum. Possible values are: NONE - * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to take topics in a forum. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanTakeTopics?: string; /** - * Permission to unassign any topic in a forum. Possible values are: NONE - * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to unassign any topic in a forum. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanUnassignTopic?: string; /** - * Permission to unmark any post from a favorite reply. Possible values are: - * NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + * Permission to unmark any post from a favorite reply. Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS */ whoCanUnmarkFavoriteReplyOnAnyTopic?: string; /** - * Permissions to view group. Possible values are: ANYONE_CAN_VIEW - * ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW - * ALL_OWNERS_CAN_VIEW + * Permissions to view group. Possible values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW ALL_OWNERS_CAN_VIEW */ whoCanViewGroup?: string; /** - * Permissions to view membership. Possible values are: - * ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW - * ALL_OWNERS_CAN_VIEW + * Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW ALL_OWNERS_CAN_VIEW */ whoCanViewMembership?: string; } diff --git a/src/apis/healthcare/index.ts b/src/apis/healthcare/index.ts index 1821b30c1b4..d85d18e3793 100644 --- a/src/apis/healthcare/index.ts +++ b/src/apis/healthcare/index.ts @@ -14,20 +14,14 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {healthcare_v1alpha} from './v1alpha'; import {healthcare_v1alpha2} from './v1alpha2'; import {healthcare_v1beta1} from './v1beta1'; export const VERSIONS = { - v1alpha: healthcare_v1alpha.Healthcare, v1alpha2: healthcare_v1alpha2.Healthcare, v1beta1: healthcare_v1beta1.Healthcare, }; -export function healthcare(version: 'v1alpha'): healthcare_v1alpha.Healthcare; -export function healthcare( - options: healthcare_v1alpha.Options -): healthcare_v1alpha.Healthcare; export function healthcare(version: 'v1alpha2'): healthcare_v1alpha2.Healthcare; export function healthcare( options: healthcare_v1alpha2.Options @@ -37,15 +31,10 @@ export function healthcare( options: healthcare_v1beta1.Options ): healthcare_v1beta1.Healthcare; export function healthcare< - T = - | healthcare_v1alpha.Healthcare - | healthcare_v1alpha2.Healthcare - | healthcare_v1beta1.Healthcare + T = healthcare_v1alpha2.Healthcare | healthcare_v1beta1.Healthcare >( this: GoogleConfigurable, versionOrOptions: - | 'v1alpha' - | healthcare_v1alpha.Options | 'v1alpha2' | healthcare_v1alpha2.Options | 'v1beta1' diff --git a/src/apis/healthcare/package.json b/src/apis/healthcare/package.json index 931b4e72f94..2c784f7344a 100644 --- a/src/apis/healthcare/package.json +++ b/src/apis/healthcare/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/healthcare/v1alpha.ts b/src/apis/healthcare/v1alpha.ts deleted file mode 100644 index 81e49b325dd..00000000000 --- a/src/apis/healthcare/v1alpha.ts +++ /dev/null @@ -1,1763 +0,0 @@ -/** - * Copyright 2019 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import {GaxiosPromise} from 'gaxios'; -import { - Compute, - JWT, - OAuth2Client, - UserRefreshClient, -} from 'google-auth-library'; -import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, - GoogleConfigurable, - MethodOptions, -} from 'googleapis-common'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace healthcare_v1alpha { - export interface Options extends GlobalOptions { - version: 'v1alpha'; - } - - interface StandardParameters { - /** - * V1 error format. - */ - '$.xgafv'?: string; - /** - * OAuth access token. - */ - access_token?: string; - /** - * Data format for response. - */ - alt?: string; - /** - * JSONP - */ - callback?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. - */ - quotaUser?: string; - /** - * Legacy upload protocol for media (e.g. "media", "multipart"). - */ - uploadType?: string; - /** - * Upload protocol for media (e.g. "raw", "multipart"). - */ - upload_protocol?: string; - } - - /** - * Cloud Healthcare API - * - * Manage, store, and access healthcare data in Google Cloud Platform. - * - * @example - * const {google} = require('googleapis'); - * const healthcare = google.healthcare('v1alpha'); - * - * @namespace healthcare - * @type {Function} - * @version v1alpha - * @variation v1alpha - * @param {object=} options Options for Healthcare - */ - export class Healthcare { - context: APIRequestContext; - projects: Resource$Projects; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; - - this.projects = new Resource$Projects(this.context); - } - } - - /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. - */ - export interface Schema$AuditConfig { - /** - * The configuration for logging of each type of permission. - */ - auditLogConfigs?: Schema$AuditLogConfig[]; - /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. - */ - service?: string; - } - /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. - */ - export interface Schema$AuditLogConfig { - /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. - */ - exemptedMembers?: string[]; - /** - * The log type that this config enables. - */ - logType?: string; - } - /** - * Associates `members` with a `role`. - */ - export interface Schema$Binding { - /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. - */ - condition?: Schema$Expr; - /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. - */ - members?: string[]; - /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. - */ - role?: string; - } - /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" - */ - export interface Schema$Expr { - /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. - */ - description?: string; - /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. - */ - expression?: string; - /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. - */ - location?: string; - /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. - */ - title?: string; - } - /** - * The response message for Locations.ListLocations. - */ - export interface Schema$ListLocationsResponse { - /** - * A list of locations that matches the specified filter in the request. - */ - locations?: Schema$Location[]; - /** - * The standard List next-page token. - */ - nextPageToken?: string; - } - /** - * The response message for Operations.ListOperations. - */ - export interface Schema$ListOperationsResponse { - /** - * The standard List next-page token. - */ - nextPageToken?: string; - /** - * A list of operations that matches the specified filter in the request. - */ - operations?: Schema$Operation[]; - } - /** - * A resource that represents Google Cloud Platform location. - */ - export interface Schema$Location { - /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". - */ - displayName?: string; - /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} - */ - labels?: {[key: string]: string}; - /** - * The canonical id for this location. For example: `"us-east1"`. - */ - locationId?: string; - /** - * Service-specific metadata. For example the available capacity at the - * given location. - */ - metadata?: {[key: string]: any}; - /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` - */ - name?: string; - } - /** - * This resource represents a long-running operation that is the result of a - * network API call. - */ - export interface Schema$Operation { - /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. - */ - done?: boolean; - /** - * The error result of the operation in case of failure or cancellation. - */ - error?: Schema$Status; - /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. - */ - metadata?: {[key: string]: any}; - /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. - */ - name?: string; - /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - */ - response?: {[key: string]: any}; - } - /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). - */ - export interface Schema$Policy { - /** - * Specifies cloud audit logging configuration for this policy. - */ - auditConfigs?: Schema$AuditConfig[]; - /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. - */ - bindings?: Schema$Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. - */ - etag?: string; - /** - * Deprecated. - */ - version?: number; - } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$SetIamPolicyRequest { - /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. - */ - policy?: Schema$Policy; - /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. - */ - updateMask?: string; - } - /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. - */ - export interface Schema$Status { - /** - * The status code, which should be an enum value of google.rpc.Code. - */ - code?: number; - /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. - */ - details?: Array<{[key: string]: any}>; - /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. - */ - message?: string; - } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsRequest { - /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. - */ - permissions?: string[]; - } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - datasets: Resource$Projects$Locations$Datasets; - constructor(context: APIRequestContext) { - this.context = context; - this.datasets = new Resource$Projects$Locations$Datasets(this.context); - } - - /** - * healthcare.projects.locations.get - * @desc Gets information about a location. - * @alias healthcare.projects.locations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Resource name for the location. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias healthcare.projects.locations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter The standard list filter. - * @param {string} params.name The resource that owns the locations collection, if applicable. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The standard list filter. - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datasets { - context: APIRequestContext; - dicomStores: Resource$Projects$Locations$Datasets$Dicomstores; - hl7V2Stores: Resource$Projects$Locations$Datasets$Hl7v2stores; - operations: Resource$Projects$Locations$Datasets$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.dicomStores = new Resource$Projects$Locations$Datasets$Dicomstores( - this.context - ); - this.hl7V2Stores = new Resource$Projects$Locations$Datasets$Hl7v2stores( - this.context - ); - this.operations = new Resource$Projects$Locations$Datasets$Operations( - this.context - ); - } - - /** - * healthcare.projects.locations.datasets.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. - * @alias healthcare.projects.locations.datasets.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias healthcare.projects.locations.datasets.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias healthcare.projects.locations.datasets.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.dicomStores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. - * @alias healthcare.projects.locations.datasets.dicomStores.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.dicomStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias - * healthcare.projects.locations.datasets.dicomStores.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Hl7v2stores { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias - * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. - * @alias healthcare.projects.locations.datasets.operations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * healthcare.projects.locations.datasets.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. - * @alias healthcare.projects.locations.datasets.operations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter The standard list filter. - * @param {string} params.name The name of the operation's parent resource. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Operations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Operations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Operations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } -} diff --git a/src/apis/healthcare/v1alpha2.ts b/src/apis/healthcare/v1alpha2.ts index 3c4886208e9..6725d48f4c0 100644 --- a/src/apis/healthcare/v1alpha2.ts +++ b/src/apis/healthcare/v1alpha2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace healthcare_v1alpha2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace healthcare_v1alpha2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace healthcare_v1alpha2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -131,8 +130,7 @@ export namespace healthcare_v1alpha2 { */ imageAnnotation?: Schema$ImageAnnotation; /** - * Output only. Resource name of the Annotation, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. + * Output only. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. */ name?: string; /** @@ -154,49 +152,20 @@ export namespace healthcare_v1alpha2 { cloudHealthcareSource?: Schema$CloudHealthcareSource; } /** - * An Annotation store that can store annotation resources such as labels and - * tags for text, image and audio. + * An Annotation store that can store annotation resources such as labels and tags for text, image and audio. */ export interface Schema$AnnotationStore { /** - * User-supplied key-value pairs used to organize Annotation stores. Label - * keys must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize Annotation stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** - * Output only. Resource name of the Annotation store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * Output only. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. */ name?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -204,25 +173,16 @@ export namespace healthcare_v1alpha2 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -235,30 +195,15 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -274,8 +219,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$CharacterMaskConfig { /** - * Character to mask the sensitive values. If not supplied, defaults to - * "*". + * Character to mask the sensitive values. If not supplied, defaults to "*". */ maskingCharacter?: string; } @@ -298,57 +242,38 @@ export namespace healthcare_v1alpha2 { message?: Schema$Message; } /** - * Pseudonymization method that generates surrogates via cryptographic - * hashing. Uses SHA-256. Outputs a base64-encoded representation of the - * hashed output (for example, - * `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + * Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). */ export interface Schema$CryptoHashConfig { /** - * An AES 128/192/256 bit key. Causes the hash to be computed based on this - * key. A default key is generated for each DeidentifyDataset operation and - * is used wherever crypto_key is not specified. + * An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each DeidentifyDataset operation and is used wherever crypto_key is not specified. */ cryptoKey?: string; } /** - * A message representing a health dataset. A health dataset represents a - * collection of healthcare data pertaining to one or more patients. This may - * include multiple modalities of healthcare data, such as electronic medical - * records or medical imaging data. + * A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data. */ export interface Schema$Dataset { /** - * Output only. Resource name of the dataset, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ name?: string; /** - * The default timezone used by this dataset. Must be a either a valid IANA - * time zone name such as "America/New_York" or empty, which - * defaults to UTC. This is used for parsing times in resources (e.g., HL7 - * messages) where no explicit timezone is specified. + * The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources (e.g., HL7 messages) where no explicit timezone is specified. */ timeZone?: string; } /** - * Shift a date forward or backward in time by a random amount which is - * consistent for a given patient and crypto key combination. + * Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. */ export interface Schema$DateShiftConfig { /** - * An AES 128/192/256 bit key. Causes the shift to be computed based on this - * key and the patient ID. A default key is generated for each - * DeidentifyDataset operation and is used wherever crypto_key is not - * specified. + * An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each DeidentifyDataset operation and is used wherever crypto_key is not specified. */ cryptoKey?: string; } /** - * Configures de-id options specific to different types of content. Each - * submessage customizes the handling of an - * https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are - * applied in a nested manner at runtime. + * Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. */ export interface Schema$DeidentifyConfig { /** @@ -360,13 +285,11 @@ export namespace healthcare_v1alpha2 { */ fhir?: Schema$FhirConfig; /** - * Configures de-identification of image pixels wherever they are found in - * the source_dataset. + * Configures de-identification of image pixels wherever they are found in the source_dataset. */ image?: Schema$ImageConfig; /** - * Configures de-identification of text wherever it is found in the - * source_dataset. + * Configures de-identification of text wherever it is found in the source_dataset. */ text?: Schema$TextConfig; } @@ -379,12 +302,7 @@ export namespace healthcare_v1alpha2 { */ config?: Schema$DeidentifyConfig; /** - * The name of the dataset resource to create and write the redacted data to - * (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - * * The destination dataset must not exist. * The destination dataset must - * be in the same project as the source dataset. De-identifying data - * across multiple projects is not supported. + * The name of the dataset resource to create and write the redacted data to (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). * The destination dataset must not exist. * The destination dataset must be in the same project as the source dataset. De-identifying data across multiple projects is not supported. */ destinationDataset?: string; } @@ -450,19 +368,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$DicomStore { /** - * User-supplied key-value pairs used to organize DICOM stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** - * Output only. Resource name of the DICOM store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ name?: string; /** @@ -471,17 +381,11 @@ export namespace healthcare_v1alpha2 { notificationConfig?: Schema$NotificationConfig; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Structure to describe the error encountered during batch operation on one - * resource. This is used both for sample errors in operation response, and - * for format of errors in error reports. + * Structure to describe the error encountered during batch operation on one resource. This is used both for sample errors in operation response, and for format of errors in error reports. */ export interface Schema$ErrorDetail { /** @@ -494,22 +398,15 @@ export namespace healthcare_v1alpha2 { resource?: string; } /** - * Exports data from the specified DICOM store. If a given resource (e.g., a - * DICOM object with the same SOPInstance UID) already exists in the output, - * it is overwritten with the version in the source dataset. Exported DICOM - * data will persist when the DICOM store from which it was exported is - * deleted. + * Exports data from the specified DICOM store. If a given resource (e.g., a DICOM object with the same SOPInstance UID) already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data will persist when the DICOM store from which it was exported is deleted. */ export interface Schema$ExportDicomDataRequest { /** - * The BigQuery output destination. For now, only exporting to a dataset in - * the current project is supported The BigQuery location requires two IAM - * roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. + * The BigQuery output destination. For now, only exporting to a dataset in the current project is supported The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1alpha2DicomBigQueryDestination; /** - * The Cloud Storage output destination. The Cloud Storage location - * requires the `roles/storage.objectAdmin` Cloud IAM role. + * The Cloud Storage output destination. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. */ gcsDestination?: Schema$GoogleCloudHealthcareV1alpha2DicomGcsDestination; } @@ -518,46 +415,32 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ExportResourcesRequest { /** - * The BigQuery output destination. The BigQuery location requires two IAM - * roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The - * output will be one BigQuery table per resource type. + * The BigQuery output destination. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output will be one BigQuery table per resource type. */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirBigQueryDestination; /** - * The Cloud Storage output destination. The Cloud Storage location - * requires the `roles/storage.objectAdmin` Cloud IAM role. The exported - * outputs are organized by FHIR resource types. The server will create one - * object per resource type. Each object contains newline delimited JSON, - * and each line is a FHIR resource. + * The Cloud Storage output destination. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. The exported outputs are organized by FHIR resource types. The server will create one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource. */ gcsDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsDestination; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -566,9 +449,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$FhirConfig { /** - * Specifies FHIR paths to match and how to transform them. Any field that - * is not matched by a FieldMetadata will be passed through to the output - * dataset unmodified. All extensions are removed in the output. + * Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata will be passed through to the output dataset unmodified. All extensions are removed in the output. */ fieldMetadataList?: Schema$FieldMetadata[]; } @@ -577,74 +458,36 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$FhirStore { /** - * Whether to disable referential integrity in this FHIR store. This field - * is immutable after FHIR store creation. The default value is false, - * meaning that the API will enforce referential integrity and fail the - * requests that will result in inconsistent state in the FHIR store. When - * this field is set to true, the API will skip referential integrity check. - * Consequently, operations that rely on references, such as - * GetPatientEverything, will not return all the results if broken - * references exist. + * Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as GetPatientEverything, will not return all the results if broken references exist. */ disableReferentialIntegrity?: boolean; /** - * Whether to disable resource versioning for this FHIR store. This field - * can not be changed after the creation of FHIR store. If set to false, - * which is the default behavior, all write operations will cause historical - * versions to be recorded automatically. The historical versions can be - * fetched through the history APIs, but cannot be updated. If set to true, - * no historical versions will be kept. The server will send back errors for - * attempts to read the historical versions. + * Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions. */ disableResourceVersioning?: boolean; /** - * Whether to allow the bulk import API to accept history bundles and - * directly insert historical resource versions into the FHIR store. - * Importing resource histories creates resource interactions that appear to - * have occurred in the past, which clients may not want to allow. If set to - * false, history bundles within an import will fail with an error. + * Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. */ enableHistoryImport?: boolean; /** - * Whether this FHIR store has the [updateCreate - * capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). - * This determines if the client can use an Update operation to create a new - * resource with a client-specified ID. If false, all IDs are - * server-assigned through the Create operation and attempts to Update a - * non-existent resource will return errors. Please treat the audit logs - * with appropriate levels of care if client-specified resource IDs contain - * sensitive data such as patient identifiers, those IDs will be part of the - * FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub - * notifications. + * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. */ enableUpdateCreate?: boolean; /** - * User-supplied key-value pairs used to organize FHIR stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** - * Output only. Resource name of the FHIR store, of the form - * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; /** - * If non-empty, publish all resource modifications of this FHIR store to - * this destination. The Cloud Pub/Sub message attributes will contain a map - * with a string describing the action that has triggered the notification, - * e.g. "action":"CreateResource". + * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes will contain a map with a string describing the action that has triggered the notification, e.g. "action":"CreateResource". */ notificationConfig?: Schema$NotificationConfig; } /** - * Specifies FHIR paths to match, and how to handle de-identification of - * matching fields. + * Specifies FHIR paths to match, and how to handle de-identification of matching fields. */ export interface Schema$FieldMetadata { /** @@ -652,14 +495,7 @@ export namespace healthcare_v1alpha2 { */ action?: string; /** - * List of paths to FHIR fields to be redacted. Each path is a - * period-separated list where each component is either a field name or FHIR - * type name, for example: Patient, HumanName. For "choice" types - * (those defined in the FHIR spec with the form: field[x]) we use two - * separate components. e.g. "deceasedAge.unit" is matched by - * "Deceased.Age.unit". Supported types are: - * AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, - * LanguageCode, Markdown, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. + * List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. e.g. "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. */ paths?: string[]; } @@ -669,8 +505,7 @@ export namespace healthcare_v1alpha2 { */ end?: string; /** - * The type of information stored in this text range (e.g. HumanName, - * BirthDate, Address, etc.) + * The type of information stored in this text range (e.g. HumanName, BirthDate, Address, etc.) */ infoType?: string; /** @@ -687,42 +522,24 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$GoogleCloudHealthcareV1alpha2DicomBigQueryDestination { /** - * If the destination table already exists and this flag is `TRUE`, the - * table will be overwritten by the contents of the DICOM store. If the flag - * is not set and the destination table already exists, the export call - * returns an error. + * If the destination table already exists and this flag is `TRUE`, the table will be overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error. */ force?: boolean; /** - * BigQuery URI to a table, up to 2000 characters long, in the format - * `bq://projectId.bqDatasetId.tableId` + * BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` */ tableUri?: string; } /** - * The Cloud Storage location where the output should be written, and the - * export configuration. + * The Cloud Storage location where the output should be written, and the export configuration. */ export interface Schema$GoogleCloudHealthcareV1alpha2DicomGcsDestination { /** - * MIME types supported by DICOM spec. Each file will be written in the - * following format: - * `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` - * The frame_number component will exist only for multi-frame instances. - * Refer to the DICOM conformance statement for permissible MIME types: - * https://cloud.google.com/healthcare/docs/dicom#wado-rs The following - * extensions will be used for output files: application/dicom -> .dcm - * image/jpeg -> .jpg image/png -> .png If unspecified, the - * instances will be exported in their original DICOM format. + * MIME types supported by DICOM spec. Each file will be written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component will exist only for multi-frame instances. Refer to the DICOM conformance statement for permissible MIME types: https://cloud.google.com/healthcare/docs/dicom#wado-rs The following extensions will be used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png If unspecified, the instances will be exported in their original DICOM format. */ mimeType?: string; /** - * The Cloud Storage destination to export to. URI for a Cloud Storage - * directory where result files should be written (in the format - * `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing - * slash, the service will append one when composing the object path. The - * user is responsible for creating the Cloud Storage bucket referenced in - * `uri_prefix`. + * The Cloud Storage destination to export to. URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ uriPrefix?: string; } @@ -731,19 +548,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$GoogleCloudHealthcareV1alpha2DicomGcsSource { /** - * Points to a Cloud Storage URI containing file(s) with content only. The - * URI must be in the following format: `gs://{bucket_id}/{object_id}`. The - * URI can include wildcards in `object_id` and thus identify multiple - * files. Supported wildcards: '*' to match 0 or more non-separator - * characters '**' to match 0 or more characters (including - * separators). Must be used at the end of a path and with no other - * wildcards in the path. Can also be used with a file extension (such - * as .dcm), which imports all files with the extension in the - * specified directory and its sub-directories. For example, - * `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm - * extensions in `my-directory/` and its sub-directories. '?' to - * match 1 character All other URI formats are invalid. Files matching the - * wildcard are expected to contain content only, no metadata. + * Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm extensions in `my-directory/` and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata. */ uri?: string; } @@ -752,8 +557,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$GoogleCloudHealthcareV1alpha2FhirBigQueryDestination { /** - * BigQuery URI to a dataset, up to 2000 characters long, in the format - * `bq://projectId.bqDatasetId` + * BigQuery URI to a dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId` */ datasetUri?: string; /** @@ -762,15 +566,11 @@ export namespace healthcare_v1alpha2 { schemaConfig?: Schema$SchemaConfig; } /** - * Final response of exporting resources. This structure will be included in - * the response to describe the detailed outcome. It will only be included - * when the operation finishes. + * Final response of exporting resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes. */ export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestExportResourcesResponse { /** - * The name of the FHIR store where resources have been exported, in the - * format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store where resources have been exported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ fhirStore?: string; /** @@ -783,11 +583,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsDestination { /** - * URI for a Cloud Storage directory where result files should be written - * (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is - * no trailing slash, the service will append one when composing the object - * path. The user is responsible for creating the Cloud Storage bucket - * referenced in `uri_prefix`. + * URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ uriPrefix?: string; } @@ -796,11 +592,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination { /** - * URI for a Cloud Storage directory to which error report files should be - * written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If - * there is no trailing slash, the service will append one when composing - * the object path. The user is responsible for creating the Cloud Storage - * bucket referenced in `uri_prefix`. + * URI for a Cloud Storage directory to which error report files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ uriPrefix?: string; } @@ -809,25 +601,12 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsSource { /** - * Points to a Cloud Storage URI containing file(s) to import. The URI must - * be in the following format: `gs://{bucket_id}/{object_id}`. The URI can - * include wildcards in `object_id` and thus identify multiple files. - * Supported wildcards: * `*` to match 0 or more non-separator characters - * * `**` to match 0 or more characters (including separators). Must be - * used at the end of a path and with no other wildcards in the path. Can - * also be used with a file extension (such as .ndjson), which imports all - * files with the extension in the specified directory and its - * sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` - * imports all files with `.ndjson` extensions in `my-directory/` and its - * sub-directories. * `?` to match 1 character Files matching the wildcard - * are expected to contain content only, no metadata. + * Points to a Cloud Storage URI containing file(s) to import. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: * `*` to match 0 or more non-separator characters * `**` to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson` extensions in `my-directory/` and its sub-directories. * `?` to match 1 character Files matching the wildcard are expected to contain content only, no metadata. */ uri?: string; } /** - * Error response of importing resources. This structure will be included in - * the error details to describe the detailed error. It will only be included - * when the operation finishes with some failure. + * Error response of importing resources. This structure will be included in the error details to describe the detailed error. It will only be included when the operation finishes with some failure. */ export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestImportResourcesErrorDetails { /** @@ -835,14 +614,11 @@ export namespace healthcare_v1alpha2 { */ errorCount?: string; /** - * The name of the FHIR store where resources have been imported, in the - * format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store where resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ fhirStore?: string; /** - * The total number of resources included in the source data. This is the - * sum of the success and error counts. + * The total number of resources included in the source data. This is the sum of the success and error counts. */ inputSize?: string; /** @@ -851,15 +627,11 @@ export namespace healthcare_v1alpha2 { successCount?: string; } /** - * Final response of importing resources. This structure will be included in - * the response to describe the detailed outcome. It will only be included - * when the operation finishes successfully. + * Final response of importing resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes successfully. */ export interface Schema$GoogleCloudHealthcareV1alpha2FhirRestImportResourcesResponse { /** - * The name of the FHIR store where the resources have been imported, in the - * format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store where the resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ fhirStore?: string; /** @@ -872,57 +644,28 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$Hl7V2Store { /** - * User-supplied key-value pairs used to organize HL7v2 stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** - * Output only. Resource name of the HL7v2 store, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. */ name?: string; /** - * The notification destination all messages (both Ingest & Create) are - * published on. Only the message name is sent as part of the notification. - * If this is unset, no notifications will be sent. Supplied by the client. + * The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications will be sent. Supplied by the client. */ notificationConfig?: Schema$NotificationConfig; /** - * The configuration for the parser. It determines how the server parses the - * messages. + * The configuration for the parser. It determines how the server parses the messages. */ parserConfig?: Schema$ParserConfig; } /** - * Message that represents an arbitrary HTTP body. It should only be used for - * payload formats that can't be represented as JSON, such as raw binary - * or an HTML page. This message can be used both in streaming and - * non-streaming API methods in the request as well as the response. It can - * be used as a top-level request field, which is convenient if one wants to - * extract parameters from either the URL or HTTP template into the request - * fields and also want access to the raw HTTP body. Example: message - * GetResourceRequest { // A unique request id. string request_id - * = 1; // The raw HTTP body is bound to this field. - * google.api.HttpBody http_body = 2; } service ResourceService { rpc - * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); - * } Example with streaming methods: service CaldavService { rpc - * GetCalendar(stream google.api.HttpBody) returns (stream - * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - * returns (stream google.api.HttpBody); } Use of this type only changes - * how the request and response bodies are handled, all other features will - * continue to work unchanged. + * Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. */ export interface Schema$HttpBody { /** - * The HTTP Content-Type header value specifying the content type of the - * body. + * The HTTP Content-Type header value specifying the content type of the body. */ contentType?: string; /** @@ -930,8 +673,7 @@ export namespace healthcare_v1alpha2 { */ data?: string; /** - * Application specific response metadata. Must be set in the first response - * for streaming APIs. + * Application specific response metadata. Must be set in the first response for streaming APIs. */ extensions?: Array<{[key: string]: any}>; } @@ -958,23 +700,16 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ImportDicomDataErrorDetails { /** - * Deprecated. Use only for debugging purposes. Contains sample errors - * encountered in imports of individual resources (for example, a Cloud - * Storage object). + * Deprecated. Use only for debugging purposes. Contains sample errors encountered in imports of individual resources (for example, a Cloud Storage object). */ sampleErrors?: Schema$ErrorDetail[]; } /** - * Imports data into the specified DICOM store. Returns an error if any of the - * files to import are not DICOM files. This API will accept duplicate DICOM - * instances, by simply ignoring the newly pushed instance (it will not - * overwrite). + * Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API will accept duplicate DICOM instances, by simply ignoring the newly pushed instance (it will not overwrite). */ export interface Schema$ImportDicomDataRequest { /** - * Cloud Storage source data location and import configuration. The Cloud - * Storage location requires the `roles/storage.objectViewer` Cloud IAM - * role. + * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. */ gcsSource?: Schema$GoogleCloudHealthcareV1alpha2DicomGcsSource; } @@ -987,27 +722,16 @@ export namespace healthcare_v1alpha2 { */ contentStructure?: string; /** - * The Cloud Storage destination to write the error report to. The Cloud - * Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. - * Note that writing a file to the same destination multiple times will - * result in the previous version of the file being overwritten. + * The Cloud Storage destination to write the error report to. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. Note that writing a file to the same destination multiple times will result in the previous version of the file being overwritten. */ gcsErrorDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination; /** - * Cloud Storage source data location and import configuration. The Cloud - * Storage location requires the `roles/storage.objectViewer` Cloud IAM - * role. Each Cloud Storage object should be a text file that contains - * newline delimited JSON structures conforming to FHIR standard. To - * improve performance, use multiple Cloud Storage objects where each object - * contains a subset of all of the newline-delimited JSON structures. You - * can select all of the objects using the uri as the prefix. The maximum - * number of objects is 1,000. + * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains newline delimited JSON structures conforming to FHIR standard. To improve performance, use multiple Cloud Storage objects where each object contains a subset of all of the newline-delimited JSON structures. You can select all of the objects using the uri as the prefix. The maximum number of objects is 1,000. */ gcsSource?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsSource; } /** - * A transformation to apply to text that is identified as a specific - * info_type. + * A transformation to apply to text that is identified as a specific info_type. */ export interface Schema$InfoTypeTransformation { /** @@ -1023,8 +747,7 @@ export namespace healthcare_v1alpha2 { */ dateShiftConfig?: Schema$DateShiftConfig; /** - * InfoTypes to apply this transformation to. If this is not specified, the - * transformation applies to any info_type. + * InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type. */ infoTypes?: string[]; /** @@ -1046,8 +769,7 @@ export namespace healthcare_v1alpha2 { message?: Schema$Message; } /** - * Acknowledges that a message has been ingested into the specified HL7v2 - * store. + * Acknowledges that a message has been ingested into the specified HL7v2 store. */ export interface Schema$IngestMessageResponse { /** @@ -1064,13 +786,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ListAnnotationsResponse { /** - * The returned Annotations names. Won't be more values than the value - * of page_size in the request. + * The returned Annotations names. Won't be more values than the value of page_size in the request. */ annotations?: string[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1079,13 +799,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ListAnnotationStoresResponse { /** - * The returned Annotation stores. Won't be more Annotation stores than - * the value of page_size in the request. + * The returned Annotation stores. Won't be more Annotation stores than the value of page_size in the request. */ annotationStores?: Schema$AnnotationStore[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1098,8 +816,7 @@ export namespace healthcare_v1alpha2 { */ datasets?: Schema$Dataset[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1108,13 +825,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ListDicomStoresResponse { /** - * The returned DICOM stores. Won't be more DICOM stores than the value - * of page_size in the request. + * The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request. */ dicomStores?: Schema$DicomStore[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1123,13 +838,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ListFhirStoresResponse { /** - * The returned FHIR stores. Won't be more FHIR stores than the value of - * page_size in the request. + * The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. */ fhirStores?: Schema$FhirStore[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1138,13 +851,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ListHl7V2StoresResponse { /** - * The returned HL7v2 stores. Won't be more HL7v2 stores than the value - * of page_size in the request. + * The returned HL7v2 stores. Won't be more HL7v2 stores than the value of page_size in the request. */ hl7V2Stores?: Schema$Hl7V2Store[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1166,13 +877,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ListMessagesResponse { /** - * The returned message names. Won't be more values than the value of - * page_size in the request. + * The returned message names. Won't be more values than the value of page_size in the request. */ messages?: string[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1194,13 +903,11 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -1208,20 +915,16 @@ export namespace healthcare_v1alpha2 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** - * A complete HL7v2 message. See - * http://www.hl7.org/implement/standards/index.cfm?ref=common for details on - * the standard. + * A complete HL7v2 message. See http://www.hl7.org/implement/standards/index.cfm?ref=common for details on the standard. */ export interface Schema$Message { /** @@ -1233,14 +936,7 @@ export namespace healthcare_v1alpha2 { */ data?: string; /** - * User-supplied key-value pairs used to organize HL7v2 stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** @@ -1248,9 +944,7 @@ export namespace healthcare_v1alpha2 { */ messageType?: string; /** - * Resource name of the Message, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. - * Assigned by the server. + * Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. */ name?: string; /** @@ -1258,8 +952,7 @@ export namespace healthcare_v1alpha2 { */ parsedData?: Schema$ParsedData; /** - * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this - * message. + * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. */ patientIds?: Schema$PatientId[]; /** @@ -1276,30 +969,16 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$NotificationConfig { /** - * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that - * notifications of changes are published on. Supplied by the client. - * PubsubMessage.Data will contain the resource name. - * PubsubMessage.MessageId is the ID of this message. It is guaranteed to be - * unique within the topic. PubsubMessage.PublishTime is the time at which - * the message was published. Notifications are only sent if the topic is - * non-empty. [Topic - * names](https://cloud.google.com/pubsub/docs/overview#names) must be - * scoped to a project. cloud-healthcare@system.gserviceaccount.com must - * have publisher permissions on the given Cloud Pub/Sub topic. Not having - * adequate permissions will cause the calls that send notifications to - * fail. + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail. */ pubsubTopic?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1307,32 +986,20 @@ export namespace healthcare_v1alpha2 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * OperationMetadata provides information about the operation execution. - * Returned in the long-running operation's metadata field. + * OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field. */ export interface Schema$OperationMetadata { /** @@ -1356,8 +1023,7 @@ export namespace healthcare_v1alpha2 { segments?: Schema$Segment[]; } /** - * The configuration for the parser. It determines how the server parses the - * messages. + * The configuration for the parser. It determines how the server parses the messages. */ export interface Schema$ParserConfig { /** @@ -1365,8 +1031,7 @@ export namespace healthcare_v1alpha2 { */ allowNullHeader?: boolean; /** - * Byte(s) to be used as the segment terminator. If this is unset, - * '\r' will be used as segment terminator. + * Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as segment terminator. */ segmentTerminator?: string; } @@ -1384,24 +1049,7 @@ export namespace healthcare_v1alpha2 { value?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -1409,20 +1057,11 @@ export namespace healthcare_v1alpha2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1448,15 +1087,11 @@ export namespace healthcare_v1alpha2 { success?: string; } /** - * Define how to redact sensitive values. Default behaviour is erase, e.g. - * "My name is Jake." becomes "My name is ." + * Define how to redact sensitive values. Default behaviour is erase, e.g. "My name is Jake." becomes "My name is ." */ export interface Schema$RedactConfig {} /** - * When using the INSPECT_AND_TRANSFORM action, each match is replaced with - * the name of the info_type. For example, "My name is Jake" becomes - * "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to - * redacting. + * When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jake" becomes "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. */ export interface Schema$ReplaceWithInfoTypeConfig {} /** @@ -1466,21 +1101,15 @@ export namespace healthcare_v1alpha2 { label?: string; } /** - * Configuration for the FHIR BigQuery schema. Determines how the server - * generates the schema. + * Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. */ export interface Schema$SchemaConfig { /** - * The depth for all recursive structures in the output analytics schema. - * For example, `concept` in the CodeSystem resource is a recursive - * structure; when the depth is 2, the CodeSystem table will have a column - * called `concept.concept` but not `concept.concept.concept`. If not - * specified or set to 0, the server will use the default value 2. + * The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. */ recursiveStructureDepth?: string; /** - * Specifies the output schema type. If unspecified, the default is - * `LOSSLESS`. + * Specifies the output schema type. If unspecified, the default is `LOSSLESS`. */ schemaType?: string; } @@ -1489,7 +1118,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$SearchResourcesRequest { /** - * The type of the resource to search. + * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). */ resourceType?: string; } @@ -1498,15 +1127,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$Segment { /** - * A mapping from the positional location to the value. The key string uses - * zero-based indexes separated by dots to identify Fields, components and - * sub-components. A bracket notation is also used to identify different - * instances of a repeated field. Regex for key: - * (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: - (0.1, - * "foo"): Component 1 of Field 0 has the value "foo". - - * (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has - * the value "bar". - (1[2].1, "baz"): Component 1 of - * Instance 2 of Field 1, which is repeated, has the value "baz". + * A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: - (0.1, "foo"): Component 1 of Field 0 has the value "foo". - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value "bar". - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, has the value "baz". */ fields?: {[key: string]: string}; /** @@ -1514,20 +1135,16 @@ export namespace healthcare_v1alpha2 { */ segmentId?: string; /** - * Set ID for segments that can be in a set. This can be empty if it is - * missing or it is not applicable. + * Set ID for segments that can be in a set. This can be empty if it is missing or it is not applicable. */ setId?: string; } /** - * A TextAnnotation specifies a text range that includes sensitive - * information. + * A TextAnnotation specifies a text range that includes sensitive information. */ export interface Schema$SensitiveTextAnnotation { /** - * Maps from a resource slice (e.g. FHIR resource field path) to a set of - * sensitive text findings. For example, Appointment.Narrative text1 --> - * {findings_1, findings_2, findings_3} + * Maps from a resource slice (e.g. FHIR resource field path) to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} */ details?: {[key: string]: Schema$Detail}; } @@ -1536,55 +1153,16 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1592,14 +1170,11 @@ export namespace healthcare_v1alpha2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1608,11 +1183,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$TagFilterList { /** - * Tags to be filtered. Tags must be DICOM Data Elements, File Meta - * Elements, or Directory Structuring Elements, as defined at: - * http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. - * They may be provided by "Keyword" or "Tag". For - * example "PatientID", "0010,0010". + * Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". */ tags?: string[]; } @@ -1621,10 +1192,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1633,15 +1201,13 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } export interface Schema$TextConfig { /** - * Experimental de-identification config to use. For internal use only. If - * not specified, it is ignored and standard DLP is used. + * Experimental de-identification config to use. For internal use only. If not specified, it is ignored and standard DLP is used. */ experimentalConfig?: string; /** @@ -1894,10 +1460,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.create - * @desc Creates a new health dataset. Results are returned through the - * Operation interface which returns either an `Operation.response` which - * contains a Dataset or `Operation.error`. The metadata field type is - * OperationMetadata. + * @desc Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. * @alias healthcare.projects.locations.datasets.create * @memberOf! () * @@ -1973,10 +1536,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.deidentify - * @desc Creates a new dataset containing de-identified data from the source - * dataset. The metadata field type is OperationMetadata. If the request is - * successful, the response field type is DeidentifySummary. If errors - * occur, details field type is DeidentifyErrorDetails. + * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails. * @alias healthcare.projects.locations.datasets.deidentify * @memberOf! () * @@ -2051,9 +1611,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.delete - * @desc Deletes the specified health dataset and all data contained in the - * dataset. Deleting a dataset does not affect the sources from which the - * dataset was imported (if any). + * @desc Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any). * @alias healthcare.projects.locations.datasets.delete * @memberOf! () * @@ -2191,8 +1749,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias healthcare.projects.locations.datasets.getIamPolicy * @memberOf! () * @@ -2413,8 +1970,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias healthcare.projects.locations.datasets.setIamPolicy * @memberOf! () * @@ -2487,11 +2043,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias healthcare.projects.locations.datasets.testIamPermissions * @memberOf! () * @@ -2580,13 +2132,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the dataset that is being created. The string must match the - * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. */ datasetId?: string; /** - * The name of the project in which the dataset should be created (e.g., - * `projects/{project_id}/locations/{location_id}`). + * The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). */ parent?: string; @@ -2603,8 +2153,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Source dataset resource name. (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). */ sourceDataset?: string; @@ -2621,8 +2170,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the dataset to delete (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). */ name?: string; } @@ -2634,8 +2182,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the dataset to read (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). */ name?: string; } @@ -2647,8 +2194,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2660,8 +2206,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. Capped to 100 if not specified. - * May not be larger than 1000. + * The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000. */ pageSize?: number; /** @@ -2669,8 +2214,7 @@ export namespace healthcare_v1alpha2 { */ pageToken?: string; /** - * The name of the project whose datasets should be listed (e.g., - * `projects/{project_id}/locations/{location_id}`). + * The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). */ parent?: string; } @@ -2682,14 +2226,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the dataset, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -2706,8 +2247,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2724,8 +2264,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2823,8 +2362,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.delete - * @desc Deletes the specified Annotation store and removes all annotations - * that are contained within it. + * @desc Deletes the specified Annotation store and removes all annotations that are contained within it. * @alias healthcare.projects.locations.datasets.annotationStores.delete * @memberOf! () * @@ -2893,8 +2431,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.get - * @desc Gets the specified Annotation store or returns NOT_FOUND if it does - * not exist. + * @desc Gets the specified Annotation store or returns NOT_FOUND if it does not exist. * @alias healthcare.projects.locations.datasets.annotationStores.get * @memberOf! () * @@ -2965,13 +2502,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns NOT_FOUND - * error if the resource does not exist. Returns an empty policy if the - * resource exists but does not have a policy set. Authorization requires - * the Google IAM permission `healthcare.AnnotationStores.getIamPolicy` on - * the specified resource - * @alias - * healthcare.projects.locations.datasets.annotationStores.getIamPolicy + * @desc Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission `healthcare.AnnotationStores.getIamPolicy` on the specified resource + * @alias healthcare.projects.locations.datasets.annotationStores.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -3043,8 +2575,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.list - * @desc Lists the Annotation stores in the given dataset for a source - * store. + * @desc Lists the Annotation stores in the given dataset for a source store. * @alias healthcare.projects.locations.datasets.annotationStores.list * @memberOf! () * @@ -3203,11 +2734,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.setIamPolicy - * @desc POLICIES Sets the access control policy for a resource. Replaces - * any existing policy. Authorization requires the Google IAM permission - * 'healthcare.annotationStores.setIamPolicy' on the specified resource - * @alias - * healthcare.projects.locations.datasets.annotationStores.setIamPolicy + * @desc POLICIES Sets the access control policy for a resource. Replaces any existing policy. Authorization requires the Google IAM permission 'healthcare.annotationStores.setIamPolicy' on the specified resource + * @alias healthcare.projects.locations.datasets.annotationStores.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -3279,12 +2807,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. There is no permission required to - * make this API call. - * @alias - * healthcare.projects.locations.datasets.annotationStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. There is no permission required to make this API call. + * @alias healthcare.projects.locations.datasets.annotationStores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -3372,8 +2896,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Annotation store that is being created. The string must - * match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. */ annotationStoreId?: string; /** @@ -3418,8 +2941,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3436,19 +2958,15 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. */ filter?: string; /** - * Limit on the number of Annotation stores to return in a single response. - * If zero the default page size of 100 is used. + * Limit on the number of Annotation stores to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -3464,14 +2982,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the Annotation store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * Output only. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -3488,8 +3003,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3506,8 +3020,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3525,11 +3038,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.annotations.create - * @desc Creates a new Annotation record. It is valid to create Annotation - * objects for the same source more than once since a unique ID is assigned - * to each record by this service. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.create + * @desc Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service. + * @alias healthcare.projects.locations.datasets.annotationStores.annotations.create * @memberOf! () * * @param {object} params Parameters for request @@ -3604,8 +3114,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.annotations.delete * @desc Deletes an Annotation or returns NOT_FOUND if it does not exist. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.delete + * @alias healthcare.projects.locations.datasets.annotationStores.annotations.delete * @memberOf! () * * @param {object} params Parameters for request @@ -3674,8 +3183,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.annotations.get * @desc Gets an Annotation. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.get + * @alias healthcare.projects.locations.datasets.annotationStores.annotations.get * @memberOf! () * * @param {object} params Parameters for request @@ -3745,10 +3253,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.annotations.list - * @desc Lists the Annotations in the given Annotation store for a source - * resource. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.list + * @desc Lists the Annotations in the given Annotation store for a source resource. + * @alias healthcare.projects.locations.datasets.annotationStores.annotations.list * @memberOf! () * * @param {object} params Parameters for request @@ -3827,8 +3333,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.annotations.patch * @desc Updates the Annotation. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.patch + * @alias healthcare.projects.locations.datasets.annotationStores.annotations.patch * @memberOf! () * * @param {object} params Parameters for request @@ -3907,8 +3412,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the Annotation store this annotation belongs to. For example, - * `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. + * The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. */ parent?: string; @@ -3949,19 +3453,15 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts Annotations returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Fields/functions available for filtering are: - source_version + * Restricts Annotations returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - source_version */ filter?: string; /** - * Limit on the number of Annotations to return in a single response. If - * zero the default page size of 100 is used. + * Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -3977,14 +3477,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the Annotation, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. + * Output only. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -4082,8 +3579,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.delete - * @desc Deletes the specified DICOM store and removes all images that are - * contained within it. + * @desc Deletes the specified DICOM store and removes all images that are contained within it. * @alias healthcare.projects.locations.datasets.dicomStores.delete * @memberOf! () * @@ -4152,8 +3648,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.export - * @desc Exports data to the specified destination by copying it from the - * DICOM store. The metadata field type is OperationMetadata. + * @desc Exports data to the specified destination by copying it from the DICOM store. The metadata field type is OperationMetadata. * @alias healthcare.projects.locations.datasets.dicomStores.export * @memberOf! () * @@ -4299,8 +3794,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias healthcare.projects.locations.datasets.dicomStores.getIamPolicy * @memberOf! () * @@ -4372,11 +3866,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.import - * @desc Imports data into the DICOM store by copying it from the specified - * source. For errors, the Operation will be populated with error details (in - * the form of ImportDicomDataErrorDetails in error.details), which will hold - * finer-grained error information. The metadata field type is - * OperationMetadata. + * @desc Imports data into the DICOM store by copying it from the specified source. For errors, the Operation will be populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which will hold finer-grained error information. The metadata field type is OperationMetadata. * @alias healthcare.projects.locations.datasets.dicomStores.import * @memberOf! () * @@ -4603,8 +4093,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias healthcare.projects.locations.datasets.dicomStores.setIamPolicy * @memberOf! () * @@ -4677,13 +4166,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias - * healthcare.projects.locations.datasets.dicomStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias healthcare.projects.locations.datasets.dicomStores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -4771,8 +4255,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the DICOM store that is being created. Any string value up to - * 256 characters in length. + * The ID of the DICOM store that is being created. Any string value up to 256 characters in length. */ dicomStoreId?: string; /** @@ -4805,9 +4288,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The DICOM store resource name from which the data should be exported - * (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The DICOM store resource name from which the data should be exported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ name?: string; @@ -4836,8 +4317,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -4849,9 +4329,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the DICOM store resource into which the data is imported - * (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store resource into which the data is imported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ name?: string; @@ -4868,19 +4346,15 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. */ filter?: string; /** - * Limit on the number of DICOM stores to return in a single response. If - * zero the default page size of 100 is used. + * Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -4896,14 +4370,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the DICOM store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -4920,8 +4391,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4938,8 +4408,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4961,10 +4430,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForInstances + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForInstances * @memberOf! () * * @param {object} params Parameters for request @@ -5035,10 +4502,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForSeries - * @desc SearchForSeries returns a list of matching series. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForSeries + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForSeries * @memberOf! () * * @param {object} params Parameters for request @@ -5109,10 +4574,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForStudies - * @desc SearchForStudies returns a list of matching studies. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForStudies + * @desc SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForStudies * @memberOf! () * * @param {object} params Parameters for request @@ -5183,11 +4646,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.storeInstances - * @desc StoreInstances stores DICOM instances associated with study - * instance unique identifiers (SUID). See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.storeInstances + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.storeInstances * @memberOf! () * * @param {object} params Parameters for request @@ -5266,13 +4726,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `instances`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5284,13 +4742,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `series`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5302,13 +4758,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5320,13 +4774,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; @@ -5348,11 +4800,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.delete - * @desc DeleteStudy deletes all instances within the given study. Delete - * requests are equivalent to the GET requests specified in the WADO-RS - * standard. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.delete + * @desc DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.delete * @memberOf! () * * @param {object} params Parameters for request @@ -5423,11 +4872,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.metadata - * @desc RetrieveStudyMetadata returns instance associated with the given - * study presented as metadata with the bulk data removed. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.metadata + * @desc RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.metadata * @memberOf! () * * @param {object} params Parameters for request @@ -5498,10 +4944,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.retrieveStudy - * @desc RetrieveStudy returns all instances within the given study. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.retrieveStudy + * @desc RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.retrieveStudy * @memberOf! () * * @param {object} params Parameters for request @@ -5572,10 +5016,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForInstances + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForInstances * @memberOf! () * * @param {object} params Parameters for request @@ -5646,10 +5088,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForSeries - * @desc SearchForSeries returns a list of matching series. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForSeries + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForSeries * @memberOf! () * * @param {object} params Parameters for request @@ -5720,11 +5160,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.storeInstances - * @desc StoreInstances stores DICOM instances associated with study - * instance unique identifiers (SUID). See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.storeInstances + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.storeInstances * @memberOf! () * * @param {object} params Parameters for request @@ -5803,13 +5240,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5821,13 +5256,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5839,13 +5272,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5857,13 +5288,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `instances`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5875,13 +5304,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `series`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5893,13 +5320,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; @@ -5921,11 +5346,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.delete - * @desc DeleteSeries deletes all instances within the given study and - * series. Delete requests are equivalent to the GET requests specified in - * the WADO-RS standard. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.delete + * @desc DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.delete * @memberOf! () * * @param {object} params Parameters for request @@ -5996,11 +5418,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.metadata - * @desc RetrieveSeriesMetadata returns instance associated with the given - * study and series, presented as metadata with the bulk data removed. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.metadata + * @desc RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.metadata * @memberOf! () * * @param {object} params Parameters for request @@ -6071,11 +5490,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.retrieveSeries - * @desc RetrieveSeries returns all instances within the given study and - * series. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.retrieveSeries + * @desc RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.retrieveSeries * @memberOf! () * * @param {object} params Parameters for request @@ -6146,10 +5562,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.searchForInstances + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.searchForInstances * @memberOf! () * * @param {object} params Parameters for request @@ -6227,13 +5641,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6245,14 +5657,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/metadata`. + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/metadata`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6264,13 +5673,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6282,13 +5689,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `instances`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6305,11 +5710,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.delete - * @desc DeleteInstance deletes an instance associated with the given study, - * series, and SOP Instance UID. Delete requests are equivalent to the GET - * requests specified in the WADO-RS standard. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.delete + * @desc DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.delete * @memberOf! () * * @param {object} params Parameters for request @@ -6380,12 +5782,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.metadata - * @desc RetrieveInstanceMetadata returns instance associated with the given - * study, series, and SOP Instance UID presented as metadata with the bulk - * data removed. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.metadata + * @desc RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.metadata * @memberOf! () * * @param {object} params Parameters for request @@ -6456,12 +5854,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.rendered - * @desc RetrieveRenderedInstance returns instance associated with the given - * study, series, and SOP Instance UID in an acceptable Rendered Media Type. - * See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.rendered + * @desc RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.rendered * @memberOf! () * * @param {object} params Parameters for request @@ -6532,11 +5926,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.retrieveInstance - * @desc RetrieveInstance returns instance associated with the given study, - * series, and SOP Instance UID. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.retrieveInstance + * @desc RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.retrieveInstance * @memberOf! () * * @param {object} params Parameters for request @@ -6614,14 +6005,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6633,14 +6021,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6652,14 +6037,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6671,14 +6053,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6691,12 +6070,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.rendered - * @desc RetrieveRenderedFrames returns instances associated with the given - * study, series, SOP Instance UID and frame numbers in an acceptable - * Rendered Media Type. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.rendered + * @desc RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.rendered * @memberOf! () * * @param {object} params Parameters for request @@ -6767,11 +6142,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.retrieveFrames - * @desc RetrieveFrames returns instances associated with the given study, - * series, SOP Instance UID and frame numbers. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.retrieveFrames + * @desc RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4. + * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.retrieveFrames * @memberOf! () * * @param {object} params Parameters for request @@ -6849,14 +6221,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6868,14 +6237,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -6894,6 +6260,78 @@ export namespace healthcare_v1alpha2 { ); } + /** + * healthcare.projects.locations.datasets.fhirStores.capabilities + * @desc Gets the FHIR [capability statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html) for the store, which contains a description of functionality supported by the server. Implements the FHIR standard [capabilities interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities). On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. + * @alias healthcare.projects.locations.datasets.fhirStores.capabilities + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + capabilities( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities, + options?: MethodOptions + ): GaxiosPromise; + capabilities( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + capabilities( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities, + callback: BodyResponseCallback + ): void; + capabilities(callback: BodyResponseCallback): void; + capabilities( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha2/{+name}/metadata').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * healthcare.projects.locations.datasets.fhirStores.create * @desc Creates a new FHIR store within the parent dataset. @@ -6972,8 +6410,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.delete - * @desc Deletes the specified FHIR store and removes all resources within - * it. + * @desc Deletes the specified FHIR store and removes all resources within it. * @alias healthcare.projects.locations.datasets.fhirStores.delete * @memberOf! () * @@ -7040,87 +6477,9 @@ export namespace healthcare_v1alpha2 { } } - /** - * healthcare.projects.locations.datasets.fhirStores.executeBundle - * @desc Executes all the requests in the given Bundle. - * @alias healthcare.projects.locations.datasets.fhirStores.executeBundle - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store in which this bundle will be executed. - * @param {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - executeBundle( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - options?: MethodOptions - ): GaxiosPromise; - executeBundle( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - executeBundle( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - callback: BodyResponseCallback - ): void; - executeBundle(callback: BodyResponseCallback): void; - executeBundle( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+parent}/fhir').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * healthcare.projects.locations.datasets.fhirStores.export - * @desc Export resources from the FHIR store to the specified destination. - * This method returns an Operation that can be used to track the status of - * the export by calling GetOperation. Immediate fatal errors appear in the - * error field. Otherwise, when the operation finishes, a detailed response - * of type ExportResourcesResponse is returned in the response field. The - * metadata field type for this operation is OperationMetadata. + * @desc Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @alias healthcare.projects.locations.datasets.fhirStores.export * @memberOf! () * @@ -7266,12 +6625,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.getIamPolicy - * @desc Gets the access control policy for a FHIR store or security label - * within a FHIR store. Returns NOT_FOUND error if the resource does not - * exist. Returns an empty policy if the resource exists but does not have a - * policy set. Authorization requires the Google IAM permission - * 'healthcare.fhirStores.getIamPolicy' for a FHIR store or - * 'healthcare.securityLabels.getIamPolicy' for a security label + * @desc Gets the access control policy for a FHIR store or security label within a FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission 'healthcare.fhirStores.getIamPolicy' for a FHIR store or 'healthcare.securityLabels.getIamPolicy' for a security label * @alias healthcare.projects.locations.datasets.fhirStores.getIamPolicy * @memberOf! () * @@ -7341,97 +6695,9 @@ export namespace healthcare_v1alpha2 { } } - /** - * healthcare.projects.locations.datasets.fhirStores.getMetadata - * @desc Gets the FHIR capability statement for the store, which contains a - * description of functionality supported by the server. - * @alias healthcare.projects.locations.datasets.fhirStores.getMetadata - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getMetadata( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, - options?: MethodOptions - ): GaxiosPromise; - getMetadata( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getMetadata( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, - callback: BodyResponseCallback - ): void; - getMetadata(callback: BodyResponseCallback): void; - getMetadata( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+name}/metadata').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * healthcare.projects.locations.datasets.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified - * sources. Each resource must have a client-supplied ID, which is retained by - * the server. The import operation is idempotent. Upon retry, the most recent - * data (matching the client-supplied ID) is overwritten, without creating a new - * resource version. If partial failures occur during the import, successful - * changes are not rolled back. If history imports are enabled - * (enable_history_import is set in the FHIR store's configuration), you can - * import historical versions of a resource by supplying a bundle of type - * `history`. The historical versions in the bundle must have `lastUpdated` - * timestamps. If a current or historical version with the supplied resource ID - * already exists, the bundle is rejected. This method returns an Operation - * that can be used to track the status of the import by calling GetOperation. - * Immediate fatal errors appear in the error field. Otherwise, when the - * operation finishes, a detailed response of type ImportResourcesResponse is - * returned in the response field. The metadata field type for this operation is - * OperationMetadata. + * @desc Import resources to the FHIR store by loading data from the specified sources. Each resource must have a client-supplied ID, which is retained by the server. The import operation is idempotent. Upon retry, the most recent data (matching the client-supplied ID) is overwritten, without creating a new resource version. If partial failures occur during the import, successful changes are not rolled back. If history imports are enabled (enable_history_import is set in the FHIR store's configuration), you can import historical versions of a resource by supplying a bundle of type `history`. The historical versions in the bundle must have `lastUpdated` timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @alias healthcare.projects.locations.datasets.fhirStores.import * @memberOf! () * @@ -7658,11 +6924,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @desc Sets the access control policy for a FHIR store or security label - * within a FHIR store. Replaces any existing policy. Authorization - * requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' - * for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a - * security label + * @desc Sets the access control policy for a FHIR store or security label within a FHIR store. Replaces any existing policy. Authorization requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a security label * @alias healthcare.projects.locations.datasets.fhirStores.setIamPolicy * @memberOf! () * @@ -7735,12 +6997,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. There is no permission required to - * make this API call. - * @alias - * healthcare.projects.locations.datasets.fhirStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. There is no permission required to make this API call. + * @alias healthcare.projects.locations.datasets.fhirStores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -7820,6 +7078,18 @@ export namespace healthcare_v1alpha2 { } } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Capabilities + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the FHIR store to retrieve the capabilities for. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Create extends StandardParameters { /** @@ -7828,8 +7098,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the FHIR store that is being created. The string must match the - * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. */ fhirStoreId?: string; /** @@ -7854,23 +7123,6 @@ export namespace healthcare_v1alpha2 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store in which this bundle will be executed. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Export extends StandardParameters { /** @@ -7879,9 +7131,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the FHIR store to export resource from. The name should be in - * the format of - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store to export resource from. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; @@ -7910,12 +7160,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Import extends StandardParameters { /** * Auth client or API Key for the request @@ -7923,21 +7172,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the FHIR store to retrieve the capabilities for. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Import - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store to import FHIR resources to. The name should - * be in the format of - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store to import FHIR resources to. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; @@ -7954,19 +7189,15 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. */ filter?: string; /** - * Limit on the number of FHIR stores to return in a single response. If - * zero the default page size of 100 is used. + * Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -7982,14 +7213,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the FHIR store, of the form - * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -8006,8 +7234,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -8024,8 +7251,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -8037,67 +7263,123 @@ export namespace healthcare_v1alpha2 { export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir { context: APIRequestContext; - Patient: Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient; - _history: Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history; constructor(context: APIRequestContext) { this.context = context; - this.Patient = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient( - this.context - ); - this._history = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history( - this.context - ); } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDeleteResource - * @desc Deletes FHIR resources matching a search query. Note: unless - * resource versioning is disabled by setting the - * disable_resource_versioning flag on the FHIR store, the deleted resources - * will be moved to a history repository that can still be retrieved through - * GetResourceVersion and related methods, unless they are removed by the - * DeleteResourceVersions method. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDeleteResource + * healthcare.projects.locations.datasets.fhirStores.fhir.capabilities + * @desc Gets the FHIR [capability statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html) for the store, which contains a description of functionality supported by the server. Implements the FHIR standard [capabilities interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities). On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.capabilities + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + capabilities( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, + options?: MethodOptions + ): GaxiosPromise; + capabilities( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + capabilities( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, + callback: BodyResponseCallback + ): void; + capabilities(callback: BodyResponseCallback): void; + capabilities( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha2/{+name}/fhir/metadata').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete + * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard [conditional delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. + * @param {string} params.type The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - conditionalDeleteResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource, + conditionalDelete( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, options?: MethodOptions ): GaxiosPromise; - conditionalDeleteResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource, + conditionalDelete( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - conditionalDeleteResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource, + conditionalDelete( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, callback: BodyResponseCallback ): void; - conditionalDeleteResource( - callback: BodyResponseCallback - ): void; - conditionalDeleteResource( + conditionalDelete(callback: BodyResponseCallback): void; + conditionalDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete; options = {}; } @@ -8131,51 +7413,47 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatchResource - * @desc Updates parts of a resource if the resource exists based on the - * search criteria specified via query parameters. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatchResource + * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch + * @desc If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [conditional patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - conditionalPatchResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource, + conditionalPatch( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, options?: MethodOptions ): GaxiosPromise; - conditionalPatchResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource, + conditionalPatch( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - conditionalPatchResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource, + conditionalPatch( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, callback: BodyResponseCallback ): void; - conditionalPatchResource( - callback: BodyResponseCallback - ): void; - conditionalPatchResource( + conditionalPatch(callback: BodyResponseCallback): void; + conditionalPatch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch; options = {}; } @@ -8209,51 +7487,47 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdateResource - * @desc Updates the entire resource if the resource exists based on the - * search criteria specified via query parameters. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdateResource + * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate + * @desc If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard [conditional update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - conditionalUpdateResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource, + conditionalUpdate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, options?: MethodOptions ): GaxiosPromise; - conditionalUpdateResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource, + conditionalUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - conditionalUpdateResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource, - callback: BodyResponseCallback - ): void; - conditionalUpdateResource( + conditionalUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, callback: BodyResponseCallback ): void; - conditionalUpdateResource( + conditionalUpdate(callback: BodyResponseCallback): void; + conditionalUpdate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate; options = {}; } @@ -8287,48 +7561,47 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.createResource - * @desc Creates a FHIR resource. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.createResource + * healthcare.projects.locations.datasets.fhirStores.fhir.create + * @desc Creates a FHIR resource. Implements the FHIR standard [create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#create), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard [conditional create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to create. + * @param {string} params.type The FHIR resource type to create, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - createResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource, + create( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, options?: MethodOptions ): GaxiosPromise; - createResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource, + create( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource, + create( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, callback: BodyResponseCallback ): void; - createResource(callback: BodyResponseCallback): void; - createResource( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create; options = {}; } @@ -8363,11 +7636,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.delete - * @desc Deletes a FHIR resource. Note: unless resource versioning is - * disabled by setting the disable_resource_versioning flag on the FHIR - * store, the deleted resources will be moved to a history repository that - * can still be retrieved through GetResourceVersion and related methods, - * unless they are removed by the DeleteResourceVersions method. + * @desc Deletes a FHIR resource. Implements the FHIR standard [delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#delete). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. * @alias healthcare.projects.locations.datasets.fhirStores.fhir.delete * @memberOf! () * @@ -8435,48 +7704,46 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.delete$purge - * @desc Deletes all the historical versions of a resource (excluding - * current version) from the FHIR store. To remove all versions of a - * resource, first delete the current version and call this method. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.delete$purge + * healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle + * @desc Executes all the requests in the given Bundle. Implements the FHIR standard [batch/transaction interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the [batch processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1) and [transaction processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to purge. + * @param {string} params.parent Name of the FHIR store in which this bundle will be executed. + * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete$purge( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge, + executeBundle( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, options?: MethodOptions - ): GaxiosPromise; - delete$purge( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + executeBundle( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete$purge( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge, - callback: BodyResponseCallback + executeBundle( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, + callback: BodyResponseCallback ): void; - delete$purge(callback: BodyResponseCallback): void; - delete$purge( + executeBundle(callback: BodyResponseCallback): void; + executeBundle( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle; options = {}; } @@ -8489,66 +7756,70 @@ export namespace healthcare_v1alpha2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha2/{+name}/$purge').replace( + url: (rootUrl + '/v1alpha2/{+parent}/fhir').replace( /([^:]\/)\/+/g, '$1' ), - method: 'DELETE', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.get - * @desc Gets a FHIR resource. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.get + * healthcare.projects.locations.datasets.fhirStores.fhir.history + * @desc Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard [history interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#history). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.history * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` + * @param {integer=} params.count The maximum number of search results on a page. Defaults to 1000. * @param {string} params.name The name of the resource to retrieve. + * @param {string=} params.page Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. + * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get, + history( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get, + history( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get, + history( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + history(callback: BodyResponseCallback): void; + history( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History; options = {}; } @@ -8561,7 +7832,10 @@ export namespace healthcare_v1alpha2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha2/{+name}/_history').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -8579,46 +7853,45 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.getMetadata - * @desc Gets the FHIR capability statement for the store, which contains a - * description of functionality supported by the server. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.getMetadata + * healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn + * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation [Observation-lastn](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). Search terms are provided as query parameters following the same pattern as the search method. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. + * @param {string} params.parent Name of the FHIR store to retrieve resources from. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getMetadata( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata, + ObservationLastn( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, options?: MethodOptions ): GaxiosPromise; - getMetadata( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata, + ObservationLastn( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getMetadata( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata, + ObservationLastn( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, callback: BodyResponseCallback ): void; - getMetadata(callback: BodyResponseCallback): void; - getMetadata( + ObservationLastn(callback: BodyResponseCallback): void; + ObservationLastn( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn; options = {}; } @@ -8631,17 +7904,16 @@ export namespace healthcare_v1alpha2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha2/{+name}/fhir/metadata').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha2/{+parent}/fhir/Observation/$lastn' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -8653,7 +7925,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.patch - * @desc Updates part of an existing resource. + * @desc Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @alias healthcare.projects.locations.datasets.fhirStores.fhir.patch * @memberOf! () * @@ -8722,54 +7994,47 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.searchResources - * @desc Searches resources in the given FHIR store. # Search Parameters - * The server's capability statement, retrieved through - * GetCapabilityStatement, indicates which search parameters are supported - * on each FHIR resource. # Search Modifiers Modifier | Supported - * ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | - * Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | - * Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | - * No - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.searchResources + * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything + * @desc Retrieves all the resources in the patient compartment for a `Patient` resource. Implements the FHIR extended operation [Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources from. - * @param {string} params.resourceType The type of the resource to search. + * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. + * @param {string} params.name Name of the `Patient` resource for which the information is required. + * @param {string=} params.start The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - searchResources( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources, + PatientEverything( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, options?: MethodOptions ): GaxiosPromise; - searchResources( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources, + PatientEverything( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchResources( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources, + PatientEverything( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, callback: BodyResponseCallback ): void; - searchResources(callback: BodyResponseCallback): void; - searchResources( + PatientEverything(callback: BodyResponseCallback): void; + PatientEverything( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything; options = {}; } @@ -8782,7 +8047,7 @@ export namespace healthcare_v1alpha2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha2/{+parent}/fhir/{+resourceType}').replace( + url: (rootUrl + '/v1alpha2/{+name}/$everything').replace( /([^:]\/)\/+/g, '$1' ), @@ -8791,8 +8056,8 @@ export namespace healthcare_v1alpha2 { options ), params, - requiredParams: ['parent', 'resourceType'], - pathParams: ['parent', 'resourceType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -8803,48 +8068,45 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.update - * @desc Updates the entire resource or creates a new resource with a client - * specified ID if the resource does not exist and the FHIR store has - * enable_update_create set. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.update + * healthcare.projects.locations.datasets.fhirStores.fhir.read + * @desc Gets the contents of a FHIR resource. Implements the FHIR standard [read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#read). Also supports the FHIR standard [conditional read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cread) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.read * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to update. - * @param {().HttpBody} params.resource Request body data + * @param {string} params.name The name of the resource to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - update( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, + read( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, options?: MethodOptions ): GaxiosPromise; - update( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, + read( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, + read( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + read(callback: BodyResponseCallback): void; + read( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read; options = {}; } @@ -8858,7 +8120,7 @@ export namespace healthcare_v1alpha2 { options: Object.assign( { url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'GET', }, options ), @@ -8875,53 +8137,45 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir._search - * @desc Searches resources in the given FHIR store. # Search Parameters - * The server's capability statement, retrieved through - * GetCapabilityStatement, indicates which search parameters are supported - * on each FHIR resource. # Search Modifiers Modifier | Supported - * ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | - * Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | - * Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | - * No - * @alias healthcare.projects.locations.datasets.fhirStores.fhir._search + * healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge + * @desc Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources from. - * @param {().SearchResourcesRequest} params.resource Request body data + * @param {string} params.name The name of the resource to purge. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - _search( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search, + ResourcePurge( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, options?: MethodOptions - ): GaxiosPromise; - _search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + ResourcePurge( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - _search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search, - callback: BodyResponseCallback + ResourcePurge( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, + callback: BodyResponseCallback ): void; - _search(callback: BodyResponseCallback): void; - _search( + ResourcePurge(callback: BodyResponseCallback): void; + ResourcePurge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge; options = {}; } @@ -8934,271 +8188,67 @@ export namespace healthcare_v1alpha2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha2/{+parent}/fhir/_search').replace( + url: (rootUrl + '/v1alpha2/{+name}/$purge').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to create. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to purge. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve the capabilities for. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - /** - * The type of the resource to search. - */ - resourceType?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SearchResourcesRequest; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.Patient.get$everything - * @desc Gets all the resources in the patient compartment. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.Patient.get$everything + * healthcare.projects.locations.datasets.fhirStores.fhir.search + * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. # Search Parameters The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). # Search Modifiers Modifier | Supported ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | No + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.search * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. - * @param {string} params.name Name of the patient for which the information is required. - * @param {string=} params.start The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. + * @param {string} params.parent Name of the FHIR store to retrieve resources from. + * @param {().SearchResourcesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get$everything( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything, + search( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, options?: MethodOptions ): GaxiosPromise; - get$everything( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything, + search( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get$everything( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything, + search( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, callback: BodyResponseCallback ): void; - get$everything(callback: BodyResponseCallback): void; - get$everything( + search(callback: BodyResponseCallback): void; + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search; options = {}; } @@ -9211,98 +8261,67 @@ export namespace healthcare_v1alpha2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha2/{+name}/$everything').replace( + url: (rootUrl + '/v1alpha2/{+parent}/fhir/_search').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The response includes records prior to the end date. If no end date is - * provided, all records subsequent to the start date are in scope. - */ - end?: string; - /** - * Name of the patient for which the information is required. - */ - name?: string; - /** - * The response includes records subsequent to the start date. If no start - * date is provided, all records prior to the end date are in scope. - */ - start?: string; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } } /** - * healthcare.projects.locations.datasets.fhirStores.fhir._history.get - * @desc Gets a version (current or historical) of FHIR resource by version - * id. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir._history.get + * healthcare.projects.locations.datasets.fhirStores.fhir.update + * @desc Updates the entire contents of a resource. Implements the FHIR standard [update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#update). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the resource version to retrieve. + * @param {string} params.name The name of the resource to update. + * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get, + update( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get, + update( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get, + update( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; options = {}; } @@ -9316,7 +8335,7 @@ export namespace healthcare_v1alpha2 { options: Object.assign( { url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PUT', }, options ), @@ -9333,51 +8352,45 @@ export namespace healthcare_v1alpha2 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir._history.list - * @desc Lists all the versions of a resource (including the current version - * and deleted versions) from the FHIR store. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir._history.list + * healthcare.projects.locations.datasets.fhirStores.fhir.vread + * @desc Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard [vread interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.vread * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: An entire year: `_at=2019` An entire month: `_at=2019-01` A specific day: `_at=2019-01-20` A specific second: `_at=2018-12-31T23:59:58Z` - * @param {integer=} params.count The maximum number of search results on a page. - * @param {string} params.name The name of the resource to retrieve. - * @param {string=} params.page Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. - * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. + * @param {string} params.name The name of the resource version to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List, + vread( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, options?: MethodOptions ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List, + vread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List, + vread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + vread(callback: BodyResponseCallback): void; + vread( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread; options = {}; } @@ -9390,10 +8403,7 @@ export namespace healthcare_v1alpha2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha2/{+name}/_history').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -9411,7 +8421,7 @@ export namespace healthcare_v1alpha2 { } } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities extends StandardParameters { /** * Auth client or API Key for the request @@ -9419,11 +8429,119 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the resource version to retrieve. + * Name of the FHIR store to retrieve the capabilities for. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + */ + type?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to create, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the FHIR store in which this bundle will be executed. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History extends StandardParameters { /** * Auth client or API Key for the request @@ -9431,16 +8549,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Only include resource versions that were current at some point during the - * time period specified in the date time value. The date parameter format - * is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the - * following: An entire year: `_at=2019` An entire month: `_at=2019-01` A - * specific day: `_at=2019-01-20` A specific second: - * `_at=2018-12-31T23:59:58Z` + * Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` */ at?: string; /** - * The maximum number of search results on a page. + * The maximum number of search results on a page. Defaults to 1000. */ count?: number; /** @@ -9448,22 +8561,133 @@ export namespace healthcare_v1alpha2 { */ name?: string; /** - * Used to retrieve the first, previous, next, or last page of resource - * versions when using pagination. Value should be set to the value of the - * `link.url` field returned in the response to the previous request, where - * `link.relation` is "first", "previous", "next" or "last". Omit `page` if - * no previous request has been made. + * Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. */ page?: string; /** - * Only include resource versions that were created at or after the given - * instant in time. The instant in time uses the format - * YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 - * or 2017-01-01T00:00:00Z). The time must be specified to the second and - * include a time zone. + * Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. */ since?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the FHIR store to retrieve resources from. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. + */ + end?: string; + /** + * Name of the `Patient` resource for which the information is required. + */ + name?: string; + /** + * The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. + */ + start?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to purge. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the FHIR store to retrieve resources from. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchResourcesRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource version to retrieve. + */ + name?: string; + } export class Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels { context: APIRequestContext; @@ -9473,14 +8697,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.securityLabels.getIamPolicy - * @desc Gets the access control policy for a FHIR store or security label - * within a FHIR store. Returns NOT_FOUND error if the resource does not - * exist. Returns an empty policy if the resource exists but does not have a - * policy set. Authorization requires the Google IAM permission - * 'healthcare.fhirStores.getIamPolicy' for a FHIR store or - * 'healthcare.securityLabels.getIamPolicy' for a security label - * @alias - * healthcare.projects.locations.datasets.fhirStores.securityLabels.getIamPolicy + * @desc Gets the access control policy for a FHIR store or security label within a FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission 'healthcare.fhirStores.getIamPolicy' for a FHIR store or 'healthcare.securityLabels.getIamPolicy' for a security label + * @alias healthcare.projects.locations.datasets.fhirStores.securityLabels.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -9551,13 +8769,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.securityLabels.setIamPolicy - * @desc Sets the access control policy for a FHIR store or security label - * within a FHIR store. Replaces any existing policy. Authorization - * requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' - * for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a - * security label - * @alias - * healthcare.projects.locations.datasets.fhirStores.securityLabels.setIamPolicy + * @desc Sets the access control policy for a FHIR store or security label within a FHIR store. Replaces any existing policy. Authorization requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a security label + * @alias healthcare.projects.locations.datasets.fhirStores.securityLabels.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -9636,8 +8849,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -9649,8 +8861,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -9748,8 +8959,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.hl7V2Stores.delete - * @desc Deletes the specified HL7v2 store and removes all messages that are - * contained within it. + * @desc Deletes the specified HL7v2 store and removes all messages that are contained within it. * @alias healthcare.projects.locations.datasets.hl7V2Stores.delete * @memberOf! () * @@ -9889,8 +9099,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy * @memberOf! () * @@ -10114,8 +9323,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy * @memberOf! () * @@ -10188,13 +9396,8 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias - * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -10282,8 +9485,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the HL7v2 store that is being created. The string must match - * the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. */ hl7V2StoreId?: string; /** @@ -10328,8 +9530,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -10341,19 +9542,15 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. */ filter?: string; /** - * Limit on the number of HL7v2 stores to return in a single response. If - * zero the default page size of 100 is used. + * Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -10369,14 +9566,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the HL7v2 store, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -10393,8 +9587,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -10411,8 +9604,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -10430,12 +9622,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.create - * @desc Creates a message and sends a notification to the Cloud Pub/Sub - * topic. If configured, the MLLP adapter listens to messages created by - * this method and sends those back to the hospital. A successful response - * indicates the message has been persisted to storage and a Cloud Pub/Sub - * notification has been sent. Sending to the hospital by the MLLP adapter - * happens asynchronously. + * @desc Creates a message and sends a notification to the Cloud Pub/Sub topic. If configured, the MLLP adapter listens to messages created by this method and sends those back to the hospital. A successful response indicates the message has been persisted to storage and a Cloud Pub/Sub notification has been sent. Sending to the hospital by the MLLP adapter happens asynchronously. * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.create * @memberOf! () * @@ -10647,11 +9834,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest - * @desc Ingests a new HL7v2 message from the hospital and sends a - * notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message - * if the message was successfully stored. Otherwise an error is returned. - * If an identical HL7v2 message is created twice only one resource is - * created on the server and no error is reported. + * @desc Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. If an identical HL7v2 message is created twice only one resource is created on the server and no error is reported. * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest * @memberOf! () * @@ -10728,8 +9911,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.list - * @desc Lists all the messages in the given HL7v2 store with support for - * filtering. + * @desc Lists all the messages in the given HL7v2 store with support for filtering. * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.list * @memberOf! () * @@ -10920,8 +10102,7 @@ export namespace healthcare_v1alpha2 { */ name?: string; /** - * Specifies which parts of the Message resource should be returned in the - * response. + * Specifies which parts of the Message resource should be returned in the response. */ view?: string; } @@ -10950,54 +10131,19 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts messages returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Fields/functions available for filtering are: * `message_type`, from - * the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` - * or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's - * time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` - * * `send_time`, the timestamp of when the message was sent, using the - * RFC3339 time format for comparisons, from the MSH-7 segment; for example - * `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care - * center that the message came from, from the MSH-4 segment; for example - * `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular - * expression matching of `expr` against the message payload using re2 - * (http://code.google.com/p/re2/) syntax; for example - * `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches - * if the message lists a patient having an ID of the given value and type - * in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", - * "MRN")` * `labels.x`, a string value of the label with key `x` as set - * using the Message.labels map, for example `labels."priority"="high"`. The - * operator `:*` can be used to assert the existence of a label, for example - * `labels."priority":*`. Limitations on conjunctions: * Negation on the - * patient ID function or the labels field is not supported, for example - * these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT - * labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple - * patient ID functions is not supported, for example this query is invalid: - * `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * - * Conjunction of multiple labels fields is also not supported, for example - * this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * - * Conjunction of one patient ID function, one labels field and conditions - * on other fields is supported, for example this query is valid: - * `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = - * "ADT"`. The HasLabel(x) and Label(x) syntax from previous API versions - * are deprecated; replaced by the `labels.x` syntax. + * Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` * `send_time`, the timestamp of when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care center that the message came from, from the MSH-4 segment; for example `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular expression matching of `expr` against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", "MRN")` * `labels.x`, a string value of the label with key `x` as set using the Message.labels map, for example `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label, for example `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. The HasLabel(x) and Label(x) syntax from previous API versions are deprecated; replaced by the `labels.x` syntax. */ filter?: string; /** - * Orders messages returned by the specified order_by clause. Syntax: - * https://cloud.google.com/apis/design/design_patterns#sorting_order Fields - * available for ordering are: * `send_time` + * Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * `send_time` */ orderBy?: string; /** - * Limit on the number of messages to return in a single response. If zero - * the default page size of 100 is used. + * Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -11013,18 +10159,11 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the Message, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. - * Assigned by the server. + * Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * Only the `labels` field is allowed to be updated. The labels in the - * request will be merged with the existing set of labels. Existing labels - * with the same keys will be updated. + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Only the `labels` field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated. */ updateMask?: string; @@ -11042,9 +10181,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias healthcare.projects.locations.datasets.operations.get * @memberOf! () * @@ -11115,15 +10252,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias healthcare.projects.locations.datasets.operations.list * @memberOf! () * diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 15f846210ca..50ec6494add 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace healthcare_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace healthcare_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,34 +108,17 @@ export namespace healthcare_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -147,25 +126,16 @@ export namespace healthcare_v1beta1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -178,30 +148,15 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -210,8 +165,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$CharacterMaskConfig { /** - * Character to mask the sensitive values. If not supplied, defaults to - * "*". + * Character to mask the sensitive values. If not supplied, defaults to "*". */ maskingCharacter?: string; } @@ -225,57 +179,38 @@ export namespace healthcare_v1beta1 { message?: Schema$Message; } /** - * Pseudonymization method that generates surrogates via cryptographic - * hashing. Uses SHA-256. Outputs a base64-encoded representation of the - * hashed output (for example, - * `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + * Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). */ export interface Schema$CryptoHashConfig { /** - * An AES 128/192/256 bit key. Causes the hash to be computed based on this - * key. A default key is generated for each DeidentifyDataset operation and - * is used wherever crypto_key is not specified. + * An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each DeidentifyDataset operation and is used wherever crypto_key is not specified. */ cryptoKey?: string; } /** - * A message representing a health dataset. A health dataset represents a - * collection of healthcare data pertaining to one or more patients. This may - * include multiple modalities of healthcare data, such as electronic medical - * records or medical imaging data. + * A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data. */ export interface Schema$Dataset { /** - * Output only. Resource name of the dataset, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ name?: string; /** - * The default timezone used by this dataset. Must be a either a valid IANA - * time zone name such as "America/New_York" or empty, which - * defaults to UTC. This is used for parsing times in resources (e.g., HL7 - * messages) where no explicit timezone is specified. + * The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources (e.g., HL7 messages) where no explicit timezone is specified. */ timeZone?: string; } /** - * Shift a date forward or backward in time by a random amount which is - * consistent for a given patient and crypto key combination. + * Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. */ export interface Schema$DateShiftConfig { /** - * An AES 128/192/256 bit key. Causes the shift to be computed based on this - * key and the patient ID. A default key is generated for each - * DeidentifyDataset operation and is used wherever crypto_key is not - * specified. + * An AES 128/192/256 bit key. Causes the shift to be computed based on this key and the patient ID. A default key is generated for each DeidentifyDataset operation and is used wherever crypto_key is not specified. */ cryptoKey?: string; } /** - * Configures de-id options specific to different types of content. Each - * submessage customizes the handling of an - * https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are - * applied in a nested manner at runtime. + * Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. */ export interface Schema$DeidentifyConfig { /** @@ -287,13 +222,11 @@ export namespace healthcare_v1beta1 { */ fhir?: Schema$FhirConfig; /** - * Configures de-identification of image pixels wherever they are found in - * the source_dataset. + * Configures de-identification of image pixels wherever they are found in the source_dataset. */ image?: Schema$ImageConfig; /** - * Configures de-identification of text wherever it is found in the - * source_dataset. + * Configures de-identification of text wherever it is found in the source_dataset. */ text?: Schema$TextConfig; } @@ -306,10 +239,7 @@ export namespace healthcare_v1beta1 { */ config?: Schema$DeidentifyConfig; /** - * The name of the dataset resource to create and write the redacted data to - * (e.g., * The destination dataset must not exist. * The destination - * dataset must be in the same project as the source dataset. - * De-identifying data across multiple projects is not supported. + * The name of the dataset resource to create and write the redacted data to (e.g., * The destination dataset must not exist. * The destination dataset must be in the same project as the source dataset. De-identifying data across multiple projects is not supported. */ destinationDataset?: string; } @@ -369,19 +299,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$DicomStore { /** - * User-supplied key-value pairs used to organize DICOM stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** - * Output only. Resource name of the DICOM store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ name?: string; /** @@ -390,17 +312,11 @@ export namespace healthcare_v1beta1 { notificationConfig?: Schema$NotificationConfig; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Structure to describe the error encountered during batch operation on one - * resource. This is used both for sample errors in operation response, and - * for format of errors in error reports. + * Structure to describe the error encountered during batch operation on one resource. This is used both for sample errors in operation response, and for format of errors in error reports. */ export interface Schema$ErrorDetail { /** @@ -413,22 +329,15 @@ export namespace healthcare_v1beta1 { resource?: string; } /** - * Exports data from the specified DICOM store. If a given resource (e.g., a - * DICOM object with the same SOPInstance UID) already exists in the output, - * it is overwritten with the version in the source dataset. Exported DICOM - * data will persist when the DICOM store from which it was exported is - * deleted. + * Exports data from the specified DICOM store. If a given resource (e.g., a DICOM object with the same SOPInstance UID) already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data will persist when the DICOM store from which it was exported is deleted. */ export interface Schema$ExportDicomDataRequest { /** - * The BigQuery output destination. For now, only exporting to a dataset in - * the current project is supported The BigQuery location requires two IAM - * roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. + * The BigQuery output destination. For now, only exporting to a dataset in the current project is supported The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1beta1DicomBigQueryDestination; /** - * The Cloud Storage output destination. The Cloud Storage location - * requires the `roles/storage.objectAdmin` Cloud IAM role. + * The Cloud Storage output destination. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. */ gcsDestination?: Schema$GoogleCloudHealthcareV1beta1DicomGcsDestination; } @@ -437,46 +346,32 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ExportResourcesRequest { /** - * The BigQuery output destination. The BigQuery location requires two IAM - * roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The - * output will be one BigQuery table per resource type. + * The BigQuery output destination. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output will be one BigQuery table per resource type. */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1beta1FhirBigQueryDestination; /** - * The Cloud Storage output destination. The Cloud Storage location - * requires the `roles/storage.objectAdmin` Cloud IAM role. The exported - * outputs are organized by FHIR resource types. The server will create one - * object per resource type. Each object contains newline delimited JSON, - * and each line is a FHIR resource. + * The Cloud Storage output destination. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role. The exported outputs are organized by FHIR resource types. The server will create one object per resource type. Each object contains newline delimited JSON, and each line is a FHIR resource. */ gcsDestination?: Schema$GoogleCloudHealthcareV1beta1FhirRestGcsDestination; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -485,9 +380,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$FhirConfig { /** - * Specifies FHIR paths to match and how to transform them. Any field that - * is not matched by a FieldMetadata will be passed through to the output - * dataset unmodified. All extensions are removed in the output. + * Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata will be passed through to the output dataset unmodified. All extensions are removed in the output. */ fieldMetadataList?: Schema$FieldMetadata[]; } @@ -496,74 +389,36 @@ export namespace healthcare_v1beta1 { */ export interface Schema$FhirStore { /** - * Whether to disable referential integrity in this FHIR store. This field - * is immutable after FHIR store creation. The default value is false, - * meaning that the API will enforce referential integrity and fail the - * requests that will result in inconsistent state in the FHIR store. When - * this field is set to true, the API will skip referential integrity check. - * Consequently, operations that rely on references, such as - * GetPatientEverything, will not return all the results if broken - * references exist. + * Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as GetPatientEverything, will not return all the results if broken references exist. */ disableReferentialIntegrity?: boolean; /** - * Whether to disable resource versioning for this FHIR store. This field - * can not be changed after the creation of FHIR store. If set to false, - * which is the default behavior, all write operations will cause historical - * versions to be recorded automatically. The historical versions can be - * fetched through the history APIs, but cannot be updated. If set to true, - * no historical versions will be kept. The server will send back errors for - * attempts to read the historical versions. + * Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions. */ disableResourceVersioning?: boolean; /** - * Whether to allow the bulk import API to accept history bundles and - * directly insert historical resource versions into the FHIR store. - * Importing resource histories creates resource interactions that appear to - * have occurred in the past, which clients may not want to allow. If set to - * false, history bundles within an import will fail with an error. + * Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. */ enableHistoryImport?: boolean; /** - * Whether this FHIR store has the [updateCreate - * capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). - * This determines if the client can use an Update operation to create a new - * resource with a client-specified ID. If false, all IDs are - * server-assigned through the Create operation and attempts to Update a - * non-existent resource will return errors. Please treat the audit logs - * with appropriate levels of care if client-specified resource IDs contain - * sensitive data such as patient identifiers, those IDs will be part of the - * FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub - * notifications. + * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. */ enableUpdateCreate?: boolean; /** - * User-supplied key-value pairs used to organize FHIR stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** - * Output only. Resource name of the FHIR store, of the form - * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; /** - * If non-empty, publish all resource modifications of this FHIR store to - * this destination. The Cloud Pub/Sub message attributes will contain a map - * with a string describing the action that has triggered the notification, - * e.g. "action":"CreateResource". + * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes will contain a map with a string describing the action that has triggered the notification, e.g. "action":"CreateResource". */ notificationConfig?: Schema$NotificationConfig; } /** - * Specifies FHIR paths to match, and how to handle de-identification of - * matching fields. + * Specifies FHIR paths to match, and how to handle de-identification of matching fields. */ export interface Schema$FieldMetadata { /** @@ -571,14 +426,7 @@ export namespace healthcare_v1beta1 { */ action?: string; /** - * List of paths to FHIR fields to be redacted. Each path is a - * period-separated list where each component is either a field name or FHIR - * type name, for example: Patient, HumanName. For "choice" types - * (those defined in the FHIR spec with the form: field[x]) we use two - * separate components. e.g. "deceasedAge.unit" is matched by - * "Deceased.Age.unit". Supported types are: - * AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, - * LanguageCode, Markdown, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. + * List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. e.g. "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. */ paths?: string[]; } @@ -587,42 +435,24 @@ export namespace healthcare_v1beta1 { */ export interface Schema$GoogleCloudHealthcareV1beta1DicomBigQueryDestination { /** - * If the destination table already exists and this flag is `TRUE`, the - * table will be overwritten by the contents of the DICOM store. If the flag - * is not set and the destination table already exists, the export call - * returns an error. + * If the destination table already exists and this flag is `TRUE`, the table will be overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error. */ force?: boolean; /** - * BigQuery URI to a table, up to 2000 characters long, in the format - * `bq://projectId.bqDatasetId.tableId` + * BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` */ tableUri?: string; } /** - * The Cloud Storage location where the output should be written, and the - * export configuration. + * The Cloud Storage location where the output should be written, and the export configuration. */ export interface Schema$GoogleCloudHealthcareV1beta1DicomGcsDestination { /** - * MIME types supported by DICOM spec. Each file will be written in the - * following format: - * `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` - * The frame_number component will exist only for multi-frame instances. - * Refer to the DICOM conformance statement for permissible MIME types: - * https://cloud.google.com/healthcare/docs/dicom#wado-rs The following - * extensions will be used for output files: application/dicom -> .dcm - * image/jpeg -> .jpg image/png -> .png If unspecified, the - * instances will be exported in their original DICOM format. + * MIME types supported by DICOM spec. Each file will be written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component will exist only for multi-frame instances. Refer to the DICOM conformance statement for permissible MIME types: https://cloud.google.com/healthcare/docs/dicom#wado-rs The following extensions will be used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png If unspecified, the instances will be exported in their original DICOM format. */ mimeType?: string; /** - * The Cloud Storage destination to export to. URI for a Cloud Storage - * directory where result files should be written (in the format - * `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing - * slash, the service will append one when composing the object path. The - * user is responsible for creating the Cloud Storage bucket referenced in - * `uri_prefix`. + * The Cloud Storage destination to export to. URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ uriPrefix?: string; } @@ -631,19 +461,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$GoogleCloudHealthcareV1beta1DicomGcsSource { /** - * Points to a Cloud Storage URI containing file(s) with content only. The - * URI must be in the following format: `gs://{bucket_id}/{object_id}`. The - * URI can include wildcards in `object_id` and thus identify multiple - * files. Supported wildcards: '*' to match 0 or more non-separator - * characters '**' to match 0 or more characters (including - * separators). Must be used at the end of a path and with no other - * wildcards in the path. Can also be used with a file extension (such - * as .dcm), which imports all files with the extension in the - * specified directory and its sub-directories. For example, - * `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm - * extensions in `my-directory/` and its sub-directories. '?' to - * match 1 character All other URI formats are invalid. Files matching the - * wildcard are expected to contain content only, no metadata. + * Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm extensions in `my-directory/` and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata. */ uri?: string; } @@ -652,8 +470,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$GoogleCloudHealthcareV1beta1FhirBigQueryDestination { /** - * BigQuery URI to a dataset, up to 2000 characters long, in the format - * `bq://projectId.bqDatasetId` + * BigQuery URI to a dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId` */ datasetUri?: string; /** @@ -662,15 +479,11 @@ export namespace healthcare_v1beta1 { schemaConfig?: Schema$SchemaConfig; } /** - * Final response of exporting resources. This structure will be included in - * the response to describe the detailed outcome. It will only be included - * when the operation finishes. + * Final response of exporting resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes. */ export interface Schema$GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse { /** - * The name of the FHIR store where resources have been exported, in the - * format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store where resources have been exported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ fhirStore?: string; /** @@ -683,11 +496,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$GoogleCloudHealthcareV1beta1FhirRestGcsDestination { /** - * URI for a Cloud Storage directory where result files should be written - * (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is - * no trailing slash, the service will append one when composing the object - * path. The user is responsible for creating the Cloud Storage bucket - * referenced in `uri_prefix`. + * URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ uriPrefix?: string; } @@ -696,25 +505,12 @@ export namespace healthcare_v1beta1 { */ export interface Schema$GoogleCloudHealthcareV1beta1FhirRestGcsSource { /** - * Points to a Cloud Storage URI containing file(s) to import. The URI must - * be in the following format: `gs://{bucket_id}/{object_id}`. The URI can - * include wildcards in `object_id` and thus identify multiple files. - * Supported wildcards: * `*` to match 0 or more non-separator characters - * * `**` to match 0 or more characters (including separators). Must be - * used at the end of a path and with no other wildcards in the path. Can - * also be used with a file extension (such as .ndjson), which imports all - * files with the extension in the specified directory and its - * sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` - * imports all files with `.ndjson` extensions in `my-directory/` and its - * sub-directories. * `?` to match 1 character Files matching the wildcard - * are expected to contain content only, no metadata. + * Points to a Cloud Storage URI containing file(s) to import. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: * `*` to match 0 or more non-separator characters * `**` to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson` extensions in `my-directory/` and its sub-directories. * `?` to match 1 character Files matching the wildcard are expected to contain content only, no metadata. */ uri?: string; } /** - * Error response of importing resources. This structure will be included in - * the error details to describe the detailed error. It will only be included - * when the operation finishes with some failure. + * Error response of importing resources. This structure will be included in the error details to describe the detailed error. It will only be included when the operation finishes with some failure. */ export interface Schema$GoogleCloudHealthcareV1beta1FhirRestImportResourcesErrorDetails { /** @@ -722,14 +518,11 @@ export namespace healthcare_v1beta1 { */ errorCount?: string; /** - * The name of the FHIR store where resources have been imported, in the - * format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store where resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ fhirStore?: string; /** - * The total number of resources included in the source data. This is the - * sum of the success and error counts. + * The total number of resources included in the source data. This is the sum of the success and error counts. */ inputSize?: string; /** @@ -738,15 +531,11 @@ export namespace healthcare_v1beta1 { successCount?: string; } /** - * Final response of importing resources. This structure will be included in - * the response to describe the detailed outcome. It will only be included - * when the operation finishes successfully. + * Final response of importing resources. This structure will be included in the response to describe the detailed outcome. It will only be included when the operation finishes successfully. */ export interface Schema$GoogleCloudHealthcareV1beta1FhirRestImportResourcesResponse { /** - * The name of the FHIR store where the resources have been imported, in the - * format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store where the resources have been imported, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ fhirStore?: string; /** @@ -759,57 +548,28 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Hl7V2Store { /** - * User-supplied key-value pairs used to organize HL7v2 stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** - * Output only. Resource name of the HL7v2 store, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. */ name?: string; /** - * The notification destination all messages (both Ingest & Create) are - * published on. Only the message name is sent as part of the notification. - * If this is unset, no notifications will be sent. Supplied by the client. + * The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications will be sent. Supplied by the client. */ notificationConfig?: Schema$NotificationConfig; /** - * The configuration for the parser. It determines how the server parses the - * messages. + * The configuration for the parser. It determines how the server parses the messages. */ parserConfig?: Schema$ParserConfig; } /** - * Message that represents an arbitrary HTTP body. It should only be used for - * payload formats that can't be represented as JSON, such as raw binary - * or an HTML page. This message can be used both in streaming and - * non-streaming API methods in the request as well as the response. It can - * be used as a top-level request field, which is convenient if one wants to - * extract parameters from either the URL or HTTP template into the request - * fields and also want access to the raw HTTP body. Example: message - * GetResourceRequest { // A unique request id. string request_id - * = 1; // The raw HTTP body is bound to this field. - * google.api.HttpBody http_body = 2; } service ResourceService { rpc - * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); - * } Example with streaming methods: service CaldavService { rpc - * GetCalendar(stream google.api.HttpBody) returns (stream - * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - * returns (stream google.api.HttpBody); } Use of this type only changes - * how the request and response bodies are handled, all other features will - * continue to work unchanged. + * Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. */ export interface Schema$HttpBody { /** - * The HTTP Content-Type header value specifying the content type of the - * body. + * The HTTP Content-Type header value specifying the content type of the body. */ contentType?: string; /** @@ -817,8 +577,7 @@ export namespace healthcare_v1beta1 { */ data?: string; /** - * Application specific response metadata. Must be set in the first response - * for streaming APIs. + * Application specific response metadata. Must be set in the first response for streaming APIs. */ extensions?: Array<{[key: string]: any}>; } @@ -836,23 +595,16 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ImportDicomDataErrorDetails { /** - * Deprecated. Use only for debugging purposes. Contains sample errors - * encountered in imports of individual resources (for example, a Cloud - * Storage object). + * Deprecated. Use only for debugging purposes. Contains sample errors encountered in imports of individual resources (for example, a Cloud Storage object). */ sampleErrors?: Schema$ErrorDetail[]; } /** - * Imports data into the specified DICOM store. Returns an error if any of the - * files to import are not DICOM files. This API will accept duplicate DICOM - * instances, by simply ignoring the newly pushed instance (it will not - * overwrite). + * Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API will accept duplicate DICOM instances, by simply ignoring the newly pushed instance (it will not overwrite). */ export interface Schema$ImportDicomDataRequest { /** - * Cloud Storage source data location and import configuration. The Cloud - * Storage location requires the `roles/storage.objectViewer` Cloud IAM - * role. + * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. */ gcsSource?: Schema$GoogleCloudHealthcareV1beta1DicomGcsSource; } @@ -865,20 +617,12 @@ export namespace healthcare_v1beta1 { */ contentStructure?: string; /** - * Cloud Storage source data location and import configuration. The Cloud - * Storage location requires the `roles/storage.objectViewer` Cloud IAM - * role. Each Cloud Storage object should be a text file that contains - * newline delimited JSON structures conforming to FHIR standard. To - * improve performance, use multiple Cloud Storage objects where each object - * contains a subset of all of the newline-delimited JSON structures. You - * can select all of the objects using the uri as the prefix. The maximum - * number of objects is 1,000. + * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains newline delimited JSON structures conforming to FHIR standard. To improve performance, use multiple Cloud Storage objects where each object contains a subset of all of the newline-delimited JSON structures. You can select all of the objects using the uri as the prefix. The maximum number of objects is 1,000. */ gcsSource?: Schema$GoogleCloudHealthcareV1beta1FhirRestGcsSource; } /** - * A transformation to apply to text that is identified as a specific - * info_type. + * A transformation to apply to text that is identified as a specific info_type. */ export interface Schema$InfoTypeTransformation { /** @@ -894,8 +638,7 @@ export namespace healthcare_v1beta1 { */ dateShiftConfig?: Schema$DateShiftConfig; /** - * InfoTypes to apply this transformation to. If this is not specified, the - * transformation applies to any info_type. + * InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type. */ infoTypes?: string[]; /** @@ -917,8 +660,7 @@ export namespace healthcare_v1beta1 { message?: Schema$Message; } /** - * Acknowledges that a message has been ingested into the specified HL7v2 - * store. + * Acknowledges that a message has been ingested into the specified HL7v2 store. */ export interface Schema$IngestMessageResponse { /** @@ -939,8 +681,7 @@ export namespace healthcare_v1beta1 { */ datasets?: Schema$Dataset[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -949,13 +690,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ListDicomStoresResponse { /** - * The returned DICOM stores. Won't be more DICOM stores than the value - * of page_size in the request. + * The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request. */ dicomStores?: Schema$DicomStore[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -964,13 +703,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ListFhirStoresResponse { /** - * The returned FHIR stores. Won't be more FHIR stores than the value of - * page_size in the request. + * The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. */ fhirStores?: Schema$FhirStore[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -979,13 +716,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ListHl7V2StoresResponse { /** - * The returned HL7v2 stores. Won't be more HL7v2 stores than the value - * of page_size in the request. + * The returned HL7v2 stores. Won't be more HL7v2 stores than the value of page_size in the request. */ hl7V2Stores?: Schema$Hl7V2Store[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1007,13 +742,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ListMessagesResponse { /** - * The returned message names. Won't be more values than the value of - * page_size in the request. + * The returned message names. Won't be more values than the value of page_size in the request. */ messages?: string[]; /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Token to retrieve the next page of results or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -1035,13 +768,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -1049,20 +780,16 @@ export namespace healthcare_v1beta1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** - * A complete HL7v2 message. See - * http://www.hl7.org/implement/standards/index.cfm?ref=common for details on - * the standard. + * A complete HL7v2 message. See http://www.hl7.org/implement/standards/index.cfm?ref=common for details on the standard. */ export interface Schema$Message { /** @@ -1074,14 +801,7 @@ export namespace healthcare_v1beta1 { */ data?: string; /** - * User-supplied key-value pairs used to organize HL7v2 stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. + * User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. */ labels?: {[key: string]: string}; /** @@ -1089,9 +809,7 @@ export namespace healthcare_v1beta1 { */ messageType?: string; /** - * Resource name of the Message, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. - * Assigned by the server. + * Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. */ name?: string; /** @@ -1099,8 +817,7 @@ export namespace healthcare_v1beta1 { */ parsedData?: Schema$ParsedData; /** - * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this - * message. + * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. */ patientIds?: Schema$PatientId[]; /** @@ -1117,30 +834,16 @@ export namespace healthcare_v1beta1 { */ export interface Schema$NotificationConfig { /** - * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that - * notifications of changes are published on. Supplied by the client. - * PubsubMessage.Data will contain the resource name. - * PubsubMessage.MessageId is the ID of this message. It is guaranteed to be - * unique within the topic. PubsubMessage.PublishTime is the time at which - * the message was published. Notifications are only sent if the topic is - * non-empty. [Topic - * names](https://cloud.google.com/pubsub/docs/overview#names) must be - * scoped to a project. cloud-healthcare@system.gserviceaccount.com must - * have publisher permissions on the given Cloud Pub/Sub topic. Not having - * adequate permissions will cause the calls that send notifications to - * fail. + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail. */ pubsubTopic?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1148,32 +851,20 @@ export namespace healthcare_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * OperationMetadata provides information about the operation execution. - * Returned in the long-running operation's metadata field. + * OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field. */ export interface Schema$OperationMetadata { /** @@ -1197,8 +888,7 @@ export namespace healthcare_v1beta1 { segments?: Schema$Segment[]; } /** - * The configuration for the parser. It determines how the server parses the - * messages. + * The configuration for the parser. It determines how the server parses the messages. */ export interface Schema$ParserConfig { /** @@ -1206,8 +896,7 @@ export namespace healthcare_v1beta1 { */ allowNullHeader?: boolean; /** - * Byte(s) to be used as the segment terminator. If this is unset, - * '\r' will be used as segment terminator. + * Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as segment terminator. */ segmentTerminator?: string; } @@ -1225,24 +914,7 @@ export namespace healthcare_v1beta1 { value?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -1250,20 +922,11 @@ export namespace healthcare_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1289,33 +952,23 @@ export namespace healthcare_v1beta1 { success?: string; } /** - * Define how to redact sensitive values. Default behaviour is erase, e.g. - * "My name is Jake." becomes "My name is ." + * Define how to redact sensitive values. Default behaviour is erase, e.g. "My name is Jake." becomes "My name is ." */ export interface Schema$RedactConfig {} /** - * When using the INSPECT_AND_TRANSFORM action, each match is replaced with - * the name of the info_type. For example, "My name is Jake" becomes - * "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to - * redacting. + * When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jake" becomes "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. */ export interface Schema$ReplaceWithInfoTypeConfig {} /** - * Configuration for the FHIR BigQuery schema. Determines how the server - * generates the schema. + * Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. */ export interface Schema$SchemaConfig { /** - * The depth for all recursive structures in the output analytics schema. - * For example, `concept` in the CodeSystem resource is a recursive - * structure; when the depth is 2, the CodeSystem table will have a column - * called `concept.concept` but not `concept.concept.concept`. If not - * specified or set to 0, the server will use the default value 2. + * The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. */ recursiveStructureDepth?: string; /** - * Specifies the output schema type. If unspecified, the default is - * `LOSSLESS`. + * Specifies the output schema type. If unspecified, the default is `LOSSLESS`. */ schemaType?: string; } @@ -1324,7 +977,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$SearchResourcesRequest { /** - * The type of the resource to search. + * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). */ resourceType?: string; } @@ -1333,15 +986,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Segment { /** - * A mapping from the positional location to the value. The key string uses - * zero-based indexes separated by dots to identify Fields, components and - * sub-components. A bracket notation is also used to identify different - * instances of a repeated field. Regex for key: - * (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: - (0.1, - * "foo"): Component 1 of Field 0 has the value "foo". - - * (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has - * the value "bar". - (1[2].1, "baz"): Component 1 of - * Instance 2 of Field 1, which is repeated, has the value "baz". + * A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: - (0.1, "foo"): Component 1 of Field 0 has the value "foo". - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value "bar". - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, has the value "baz". */ fields?: {[key: string]: string}; /** @@ -1349,8 +994,7 @@ export namespace healthcare_v1beta1 { */ segmentId?: string; /** - * Set ID for segments that can be in a set. This can be empty if it is - * missing or it is not applicable. + * Set ID for segments that can be in a set. This can be empty if it is missing or it is not applicable. */ setId?: string; } @@ -1359,55 +1003,16 @@ export namespace healthcare_v1beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1415,14 +1020,11 @@ export namespace healthcare_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1431,11 +1033,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$TagFilterList { /** - * Tags to be filtered. Tags must be DICOM Data Elements, File Meta - * Elements, or Directory Structuring Elements, as defined at: - * http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. - * They may be provided by "Keyword" or "Tag". For - * example "PatientID", "0010,0010". + * Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". */ tags?: string[]; } @@ -1444,10 +1042,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1456,8 +1051,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1695,10 +1289,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.create - * @desc Creates a new health dataset. Results are returned through the - * Operation interface which returns either an `Operation.response` which - * contains a Dataset or `Operation.error`. The metadata field type is - * OperationMetadata. + * @desc Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. * @alias healthcare.projects.locations.datasets.create * @memberOf! () * @@ -1774,10 +1365,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.deidentify - * @desc Creates a new dataset containing de-identified data from the source - * dataset. The metadata field type is OperationMetadata. If the request is - * successful, the response field type is DeidentifySummary. If errors - * occur, details field type is DeidentifyErrorDetails. + * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails. * @alias healthcare.projects.locations.datasets.deidentify * @memberOf! () * @@ -1852,9 +1440,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.delete - * @desc Deletes the specified health dataset and all data contained in the - * dataset. Deleting a dataset does not affect the sources from which the - * dataset was imported (if any). + * @desc Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any). * @alias healthcare.projects.locations.datasets.delete * @memberOf! () * @@ -1992,8 +1578,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias healthcare.projects.locations.datasets.getIamPolicy * @memberOf! () * @@ -2214,8 +1799,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias healthcare.projects.locations.datasets.setIamPolicy * @memberOf! () * @@ -2288,11 +1872,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias healthcare.projects.locations.datasets.testIamPermissions * @memberOf! () * @@ -2381,13 +1961,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the dataset that is being created. The string must match the - * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. */ datasetId?: string; /** - * The name of the project in which the dataset should be created (e.g., - * `projects/{project_id}/locations/{location_id}`). + * The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). */ parent?: string; @@ -2404,8 +1982,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Source dataset resource name. (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). */ sourceDataset?: string; @@ -2422,8 +1999,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the dataset to delete (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). */ name?: string; } @@ -2435,8 +2011,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the dataset to read (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). */ name?: string; } @@ -2448,8 +2023,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2461,8 +2035,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. Capped to 100 if not specified. - * May not be larger than 1000. + * The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000. */ pageSize?: number; /** @@ -2470,8 +2043,7 @@ export namespace healthcare_v1beta1 { */ pageToken?: string; /** - * The name of the project whose datasets should be listed (e.g., - * `projects/{project_id}/locations/{location_id}`). + * The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). */ parent?: string; } @@ -2483,14 +2055,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the dataset, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -2507,8 +2076,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2525,8 +2093,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2624,8 +2191,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.delete - * @desc Deletes the specified DICOM store and removes all images that are - * contained within it. + * @desc Deletes the specified DICOM store and removes all images that are contained within it. * @alias healthcare.projects.locations.datasets.dicomStores.delete * @memberOf! () * @@ -2694,8 +2260,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.export - * @desc Exports data to the specified destination by copying it from the - * DICOM store. The metadata field type is OperationMetadata. + * @desc Exports data to the specified destination by copying it from the DICOM store. The metadata field type is OperationMetadata. * @alias healthcare.projects.locations.datasets.dicomStores.export * @memberOf! () * @@ -2841,8 +2406,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias healthcare.projects.locations.datasets.dicomStores.getIamPolicy * @memberOf! () * @@ -2914,11 +2478,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.import - * @desc Imports data into the DICOM store by copying it from the specified - * source. For errors, the Operation will be populated with error details (in - * the form of ImportDicomDataErrorDetails in error.details), which will hold - * finer-grained error information. The metadata field type is - * OperationMetadata. + * @desc Imports data into the DICOM store by copying it from the specified source. For errors, the Operation will be populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which will hold finer-grained error information. The metadata field type is OperationMetadata. * @alias healthcare.projects.locations.datasets.dicomStores.import * @memberOf! () * @@ -3145,10 +2705,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.searchForInstances + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.searchForInstances * @memberOf! () * * @param {object} params Parameters for request @@ -3219,8 +2777,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.searchForSeries - * @desc SearchForSeries returns a list of matching series. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 * @alias healthcare.projects.locations.datasets.dicomStores.searchForSeries * @memberOf! () * @@ -3292,10 +2849,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.searchForStudies - * @desc SearchForStudies returns a list of matching studies. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.searchForStudies + * @desc SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.searchForStudies * @memberOf! () * * @param {object} params Parameters for request @@ -3366,8 +2921,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias healthcare.projects.locations.datasets.dicomStores.setIamPolicy * @memberOf! () * @@ -3440,9 +2994,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.storeInstances - * @desc StoreInstances stores DICOM instances associated with study - * instance unique identifiers (SUID). See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. * @alias healthcare.projects.locations.datasets.dicomStores.storeInstances * @memberOf! () * @@ -3515,13 +3067,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias - * healthcare.projects.locations.datasets.dicomStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias healthcare.projects.locations.datasets.dicomStores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -3609,8 +3156,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the DICOM store that is being created. Any string value up to - * 256 characters in length. + * The ID of the DICOM store that is being created. Any string value up to 256 characters in length. */ dicomStoreId?: string; /** @@ -3643,9 +3189,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The DICOM store resource name from which the data should be exported - * (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The DICOM store resource name from which the data should be exported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ name?: string; @@ -3674,8 +3218,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -3687,9 +3230,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the DICOM store resource into which the data is imported - * (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store resource into which the data is imported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ name?: string; @@ -3706,19 +3247,15 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. */ filter?: string; /** - * Limit on the number of DICOM stores to return in a single response. If - * zero the default page size of 100 is used. + * Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -3734,14 +3271,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the DICOM store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -3758,13 +3292,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `instances`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -3776,13 +3308,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `series`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -3794,13 +3324,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -3812,8 +3340,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3830,13 +3357,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; @@ -3853,8 +3378,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3876,9 +3400,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.delete - * @desc DeleteStudy deletes all instances within the given study. Delete - * requests are equivalent to the GET requests specified in the WADO-RS - * standard. + * @desc DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. * @alias healthcare.projects.locations.datasets.dicomStores.studies.delete * @memberOf! () * @@ -3950,11 +3472,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata - * @desc RetrieveStudyMetadata returns instance associated with the given - * study presented as metadata with the bulk data removed. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata + * @desc RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata * @memberOf! () * * @param {object} params Parameters for request @@ -4025,10 +3544,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy - * @desc RetrieveStudy returns all instances within the given study. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy + * @desc RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy * @memberOf! () * * @param {object} params Parameters for request @@ -4099,10 +3616,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances * @memberOf! () * * @param {object} params Parameters for request @@ -4173,10 +3688,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries - * @desc SearchForSeries returns a list of matching series. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries * @memberOf! () * * @param {object} params Parameters for request @@ -4247,11 +3760,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.storeInstances - * @desc StoreInstances stores DICOM instances associated with study - * instance unique identifiers (SUID). See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.storeInstances + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.storeInstances * @memberOf! () * * @param {object} params Parameters for request @@ -4330,13 +3840,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4348,13 +3856,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4366,13 +3872,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4384,13 +3888,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `instances`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4402,13 +3904,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `series`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4420,13 +3920,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; @@ -4448,11 +3946,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.delete - * @desc DeleteSeries deletes all instances within the given study and - * series. Delete requests are equivalent to the GET requests specified in - * the WADO-RS standard. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.delete + * @desc DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.delete * @memberOf! () * * @param {object} params Parameters for request @@ -4523,11 +4018,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata - * @desc RetrieveSeriesMetadata returns instance associated with the given - * study and series, presented as metadata with the bulk data removed. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata + * @desc RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata * @memberOf! () * * @param {object} params Parameters for request @@ -4598,11 +4090,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries - * @desc RetrieveSeries returns all instances within the given study and - * series. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries + * @desc RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries * @memberOf! () * * @param {object} params Parameters for request @@ -4673,10 +4162,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances * @memberOf! () * * @param {object} params Parameters for request @@ -4754,13 +4241,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4772,14 +4257,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/metadata`. + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/metadata`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4791,13 +4273,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4809,13 +4289,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., `instances`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -4832,11 +4310,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete - * @desc DeleteInstance deletes an instance associated with the given study, - * series, and SOP Instance UID. Delete requests are equivalent to the GET - * requests specified in the WADO-RS standard. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete + * @desc DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete * @memberOf! () * * @param {object} params Parameters for request @@ -4907,11 +4382,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance - * @desc RetrieveInstance returns instance associated with the given study, - * series, and SOP Instance UID. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance + * @desc RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance * @memberOf! () * * @param {object} params Parameters for request @@ -4982,12 +4454,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata - * @desc RetrieveInstanceMetadata returns instance associated with the given - * study, series, and SOP Instance UID presented as metadata with the bulk - * data removed. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata + * @desc RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata * @memberOf! () * * @param {object} params Parameters for request @@ -5058,12 +4526,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered - * @desc RetrieveRenderedInstance returns instance associated with the given - * study, series, and SOP Instance UID in an acceptable Rendered Media Type. - * See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered + * @desc RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered * @memberOf! () * * @param {object} params Parameters for request @@ -5141,14 +4605,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5160,14 +4621,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5179,14 +4637,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5198,14 +4653,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5218,11 +4670,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames - * @desc RetrieveFrames returns instances associated with the given study, - * series, SOP Instance UID and frame numbers. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames + * @desc RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames * @memberOf! () * * @param {object} params Parameters for request @@ -5293,12 +4742,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered - * @desc RetrieveRenderedFrames returns instances associated with the given - * study, series, SOP Instance UID and frame numbers in an acceptable - * Rendered Media Type. See - * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. - * @alias - * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered + * @desc RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered * @memberOf! () * * @param {object} params Parameters for request @@ -5376,14 +4821,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5395,14 +4837,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, - * or QIDO-RS standard (e.g., - * `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). */ parent?: string; } @@ -5495,8 +4934,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.delete - * @desc Deletes the specified FHIR store and removes all resources within - * it. + * @desc Deletes the specified FHIR store and removes all resources within it. * @alias healthcare.projects.locations.datasets.fhirStores.delete * @memberOf! () * @@ -5563,87 +5001,9 @@ export namespace healthcare_v1beta1 { } } - /** - * healthcare.projects.locations.datasets.fhirStores.executeBundle - * @desc Executes all the requests in the given Bundle. - * @alias healthcare.projects.locations.datasets.fhirStores.executeBundle - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store in which this bundle will be executed. - * @param {().HttpBody} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - executeBundle( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - options?: MethodOptions - ): GaxiosPromise; - executeBundle( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - executeBundle( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - callback: BodyResponseCallback - ): void; - executeBundle(callback: BodyResponseCallback): void; - executeBundle( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/fhir').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * healthcare.projects.locations.datasets.fhirStores.export - * @desc Export resources from the FHIR store to the specified destination. - * This method returns an Operation that can be used to track the status of - * the export by calling GetOperation. Immediate fatal errors appear in the - * error field. Otherwise, when the operation finishes, a detailed response - * of type ExportResourcesResponse is returned in the response field. The - * metadata field type for this operation is OperationMetadata. + * @desc Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @alias healthcare.projects.locations.datasets.fhirStores.export * @memberOf! () * @@ -5789,8 +5149,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias healthcare.projects.locations.datasets.fhirStores.getIamPolicy * @memberOf! () * @@ -5862,22 +5221,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified - * sources. Each resource must have a client-supplied ID, which is retained by - * the server. The import operation is idempotent. Upon retry, the most recent - * data (matching the client-supplied ID) is overwritten, without creating a new - * resource version. If partial failures occur during the import, successful - * changes are not rolled back. If history imports are enabled - * (enable_history_import is set in the FHIR store's configuration), you can - * import historical versions of a resource by supplying a bundle of type - * `history`. The historical versions in the bundle must have `lastUpdated` - * timestamps. If a current or historical version with the supplied resource ID - * already exists, the bundle is rejected. This method returns an Operation - * that can be used to track the status of the import by calling GetOperation. - * Immediate fatal errors appear in the error field. Otherwise, when the - * operation finishes, a detailed response of type ImportResourcesResponse is - * returned in the response field. The metadata field type for this operation is - * OperationMetadata. + * @desc Import resources to the FHIR store by loading data from the specified sources. Each resource must have a client-supplied ID, which is retained by the server. The import operation is idempotent. Upon retry, the most recent data (matching the client-supplied ID) is overwritten, without creating a new resource version. If partial failures occur during the import, successful changes are not rolled back. If history imports are enabled (enable_history_import is set in the FHIR store's configuration), you can import historical versions of a resource by supplying a bundle of type `history`. The historical versions in the bundle must have `lastUpdated` timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @alias healthcare.projects.locations.datasets.fhirStores.import * @memberOf! () * @@ -6104,8 +5448,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias healthcare.projects.locations.datasets.fhirStores.setIamPolicy * @memberOf! () * @@ -6178,13 +5521,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias - * healthcare.projects.locations.datasets.fhirStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias healthcare.projects.locations.datasets.fhirStores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -6272,8 +5610,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the FHIR store that is being created. The string must match the - * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. */ fhirStoreId?: string; /** @@ -6298,23 +5635,6 @@ export namespace healthcare_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store in which this bundle will be executed. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Export extends StandardParameters { /** @@ -6323,9 +5643,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the FHIR store to export resource from. The name should be in - * the format of - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store to export resource from. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; @@ -6354,8 +5672,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -6367,9 +5684,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the FHIR store to import FHIR resources to. The name should - * be in the format of - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The name of the FHIR store to import FHIR resources to. The name should be in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; @@ -6386,19 +5701,15 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. */ filter?: string; /** - * Limit on the number of FHIR stores to return in a single response. If - * zero the default page size of 100 is used. + * Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -6414,14 +5725,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the FHIR store, of the form - * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -6438,8 +5746,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6456,8 +5763,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -6469,71 +5775,123 @@ export namespace healthcare_v1beta1 { export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir { context: APIRequestContext; - Observation: Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation; - Patient: Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient; - _history: Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history; constructor(context: APIRequestContext) { this.context = context; - this.Observation = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation( - this.context - ); - this.Patient = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient( - this.context - ); - this._history = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history( - this.context - ); } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDeleteResource - * @desc Deletes FHIR resources matching a search query. Note: unless - * resource versioning is disabled by setting the - * disable_resource_versioning flag on the FHIR store, the deleted resources - * will be moved to a history repository that can still be retrieved through - * GetResourceVersion and related methods, unless they are removed by the - * DeleteResourceVersions method. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDeleteResource + * healthcare.projects.locations.datasets.fhirStores.fhir.capabilities + * @desc Gets the FHIR [capability statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html) for the store, which contains a description of functionality supported by the server. Implements the FHIR standard [capabilities interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities). On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.capabilities + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + capabilities( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, + options?: MethodOptions + ): GaxiosPromise; + capabilities( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + capabilities( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities, + callback: BodyResponseCallback + ): void; + capabilities(callback: BodyResponseCallback): void; + capabilities( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/fhir/metadata').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete + * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard [conditional delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. + * @param {string} params.type The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - conditionalDeleteResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource, + conditionalDelete( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, options?: MethodOptions ): GaxiosPromise; - conditionalDeleteResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource, + conditionalDelete( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - conditionalDeleteResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource, - callback: BodyResponseCallback - ): void; - conditionalDeleteResource( + conditionalDelete( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete, callback: BodyResponseCallback ): void; - conditionalDeleteResource( + conditionalDelete(callback: BodyResponseCallback): void; + conditionalDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete; options = {}; } @@ -6567,51 +5925,47 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatchResource - * @desc Updates parts of a resource if the resource exists based on the - * search criteria specified via query parameters. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatchResource + * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch + * @desc If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [conditional patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - conditionalPatchResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource, + conditionalPatch( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, options?: MethodOptions ): GaxiosPromise; - conditionalPatchResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource, + conditionalPatch( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - conditionalPatchResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource, + conditionalPatch( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch, callback: BodyResponseCallback ): void; - conditionalPatchResource( - callback: BodyResponseCallback - ): void; - conditionalPatchResource( + conditionalPatch(callback: BodyResponseCallback): void; + conditionalPatch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch; options = {}; } @@ -6645,51 +5999,47 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdateResource - * @desc Updates the entire resource if the resource exists based on the - * search criteria specified via query parameters. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdateResource + * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate + * @desc If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard [conditional update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - conditionalUpdateResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource, + conditionalUpdate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, options?: MethodOptions ): GaxiosPromise; - conditionalUpdateResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource, + conditionalUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - conditionalUpdateResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource, - callback: BodyResponseCallback - ): void; - conditionalUpdateResource( + conditionalUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate, callback: BodyResponseCallback ): void; - conditionalUpdateResource( + conditionalUpdate(callback: BodyResponseCallback): void; + conditionalUpdate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate; options = {}; } @@ -6723,48 +6073,47 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.createResource - * @desc Creates a FHIR resource. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.createResource + * healthcare.projects.locations.datasets.fhirStores.fhir.create + * @desc Creates a FHIR resource. Implements the FHIR standard [create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#create), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard [conditional create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to create. + * @param {string} params.type The FHIR resource type to create, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - createResource( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource, + create( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, options?: MethodOptions ): GaxiosPromise; - createResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource, + create( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createResource( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource, + create( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create, callback: BodyResponseCallback ): void; - createResource(callback: BodyResponseCallback): void; - createResource( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create; options = {}; } @@ -6799,11 +6148,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.delete - * @desc Deletes a FHIR resource. Note: unless resource versioning is - * disabled by setting the disable_resource_versioning flag on the FHIR - * store, the deleted resources will be moved to a history repository that - * can still be retrieved through GetResourceVersion and related methods, - * unless they are removed by the DeleteResourceVersions method. + * @desc Deletes a FHIR resource. Implements the FHIR standard [delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#delete). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. * @alias healthcare.projects.locations.datasets.fhirStores.fhir.delete * @memberOf! () * @@ -6871,48 +6216,46 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.delete$purge - * @desc Deletes all the historical versions of a resource (excluding - * current version) from the FHIR store. To remove all versions of a - * resource, first delete the current version and call this method. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.delete$purge + * healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle + * @desc Executes all the requests in the given Bundle. Implements the FHIR standard [batch/transaction interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the [batch processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1) and [transaction processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to purge. + * @param {string} params.parent Name of the FHIR store in which this bundle will be executed. + * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete$purge( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge, + executeBundle( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, options?: MethodOptions - ): GaxiosPromise; - delete$purge( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + executeBundle( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete$purge( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge, - callback: BodyResponseCallback + executeBundle( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle, + callback: BodyResponseCallback ): void; - delete$purge(callback: BodyResponseCallback): void; - delete$purge( + executeBundle(callback: BodyResponseCallback): void; + executeBundle( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle; options = {}; } @@ -6925,66 +6268,70 @@ export namespace healthcare_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/$purge').replace( + url: (rootUrl + '/v1beta1/{+parent}/fhir').replace( /([^:]\/)\/+/g, '$1' ), - method: 'DELETE', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.get - * @desc Gets a FHIR resource. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.get + * healthcare.projects.locations.datasets.fhirStores.fhir.history + * @desc Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard [history interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#history). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.history * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` + * @param {integer=} params.count The maximum number of search results on a page. Defaults to 1000. * @param {string} params.name The name of the resource to retrieve. + * @param {string=} params.page Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. + * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get, + history( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get, + history( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get, + history( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + history(callback: BodyResponseCallback): void; + history( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History; options = {}; } @@ -6997,7 +6344,10 @@ export namespace healthcare_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}/_history').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -7015,46 +6365,45 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.getMetadata - * @desc Gets the FHIR capability statement for the store, which contains a - * description of functionality supported by the server. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.getMetadata + * healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn + * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation [Observation-lastn](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). Search terms are provided as query parameters following the same pattern as the search method. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. + * @param {string} params.parent Name of the FHIR store to retrieve resources from. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getMetadata( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata, + ObservationLastn( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, options?: MethodOptions ): GaxiosPromise; - getMetadata( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata, + ObservationLastn( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getMetadata( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata, + ObservationLastn( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn, callback: BodyResponseCallback ): void; - getMetadata(callback: BodyResponseCallback): void; - getMetadata( + ObservationLastn(callback: BodyResponseCallback): void; + ObservationLastn( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn; options = {}; } @@ -7067,17 +6416,16 @@ export namespace healthcare_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/fhir/metadata').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+parent}/fhir/Observation/$lastn' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -7089,7 +6437,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.patch - * @desc Updates part of an existing resource. + * @desc Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @alias healthcare.projects.locations.datasets.fhirStores.fhir.patch * @memberOf! () * @@ -7158,54 +6506,47 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.searchResources - * @desc Searches resources in the given FHIR store. # Search Parameters - * The server's capability statement, retrieved through - * GetCapabilityStatement, indicates which search parameters are supported - * on each FHIR resource. # Search Modifiers Modifier | Supported - * ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | - * Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | - * Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | - * No - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.searchResources + * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything + * @desc Retrieves all the resources in the patient compartment for a `Patient` resource. Implements the FHIR extended operation [Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources from. - * @param {string} params.resourceType The type of the resource to search. + * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. + * @param {string} params.name Name of the `Patient` resource for which the information is required. + * @param {string=} params.start The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - searchResources( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources, + PatientEverything( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, options?: MethodOptions ): GaxiosPromise; - searchResources( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources, + PatientEverything( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchResources( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources, + PatientEverything( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything, callback: BodyResponseCallback ): void; - searchResources(callback: BodyResponseCallback): void; - searchResources( + PatientEverything(callback: BodyResponseCallback): void; + PatientEverything( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything; options = {}; } @@ -7218,7 +6559,7 @@ export namespace healthcare_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/fhir/{+resourceType}').replace( + url: (rootUrl + '/v1beta1/{+name}/$everything').replace( /([^:]\/)\/+/g, '$1' ), @@ -7227,8 +6568,8 @@ export namespace healthcare_v1beta1 { options ), params, - requiredParams: ['parent', 'resourceType'], - pathParams: ['parent', 'resourceType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -7239,48 +6580,45 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir.update - * @desc Updates the entire resource or creates a new resource with a client - * specified ID if the resource does not exist and the FHIR store has - * enable_update_create set. - * @alias healthcare.projects.locations.datasets.fhirStores.fhir.update + * healthcare.projects.locations.datasets.fhirStores.fhir.read + * @desc Gets the contents of a FHIR resource. Implements the FHIR standard [read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#read). Also supports the FHIR standard [conditional read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cread) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.read * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to update. - * @param {().HttpBody} params.resource Request body data + * @param {string} params.name The name of the resource to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - update( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, + read( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, options?: MethodOptions ): GaxiosPromise; - update( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, + read( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, + read( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + read(callback: BodyResponseCallback): void; + read( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read; options = {}; } @@ -7294,7 +6632,7 @@ export namespace healthcare_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'GET', }, options ), @@ -7311,53 +6649,45 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir._search - * @desc Searches resources in the given FHIR store. # Search Parameters - * The server's capability statement, retrieved through - * GetCapabilityStatement, indicates which search parameters are supported - * on each FHIR resource. # Search Modifiers Modifier | Supported - * ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | - * Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | - * Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | - * No - * @alias healthcare.projects.locations.datasets.fhirStores.fhir._search + * healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge + * @desc Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources from. - * @param {().SearchResourcesRequest} params.resource Request body data + * @param {string} params.name The name of the resource to purge. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - _search( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search, + ResourcePurge( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, options?: MethodOptions - ): GaxiosPromise; - _search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + ResourcePurge( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - _search( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search, - callback: BodyResponseCallback + ResourcePurge( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge, + callback: BodyResponseCallback ): void; - _search(callback: BodyResponseCallback): void; - _search( + ResourcePurge(callback: BodyResponseCallback): void; + ResourcePurge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge; options = {}; } @@ -7370,364 +6700,67 @@ export namespace healthcare_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/fhir/_search').replace( + url: (rootUrl + '/v1beta1/{+name}/$purge').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldeleteresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatchresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdateresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Createresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to create. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the resource to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete$purge - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to purge. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Getmetadata - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve the capabilities for. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Searchresources - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - /** - * The type of the resource to search. - */ - resourceType?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_search - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SearchResourcesRequest; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.fhirStores.fhir.Observation.get$lastn - * @desc Get N most recent observations for patient, grouped by code that - * match given query parameters. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.Observation.get$lastn + * healthcare.projects.locations.datasets.fhirStores.fhir.search + * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. # Search Parameters The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). # Search Modifiers Modifier | Supported ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | No + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.search * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Name of the FHIR store to retrieve resources from. + * @param {().SearchResourcesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get$lastn( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation$Get$lastn, - options?: MethodOptions - ): GaxiosPromise; - get$lastn( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation$Get$lastn, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get$lastn( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation$Get$lastn, - callback: BodyResponseCallback - ): void; - get$lastn(callback: BodyResponseCallback): void; - get$lastn( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation$Get$lastn - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation$Get$lastn; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation$Get$lastn; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/fhir/Observation/$lastn' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observation$Get$lastn - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * healthcare.projects.locations.datasets.fhirStores.fhir.Patient.get$everything - * @desc Gets all the resources in the patient compartment. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir.Patient.get$everything - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. - * @param {string} params.name Name of the patient for which the information is required. - * @param {string=} params.start The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get$everything( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything, + search( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, options?: MethodOptions ): GaxiosPromise; - get$everything( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything, + search( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get$everything( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything, + search( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search, callback: BodyResponseCallback ): void; - get$everything(callback: BodyResponseCallback): void; - get$everything( + search(callback: BodyResponseCallback): void; + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search; options = {}; } @@ -7740,98 +6773,67 @@ export namespace healthcare_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/$everything').replace( + url: (rootUrl + '/v1beta1/{+parent}/fhir/_search').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patient$Get$everything - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The response includes records prior to the end date. If no end date is - * provided, all records subsequent to the start date are in scope. - */ - end?: string; - /** - * Name of the patient for which the information is required. - */ - name?: string; - /** - * The response includes records subsequent to the start date. If no start - * date is provided, all records prior to the end date are in scope. - */ - start?: string; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } } /** - * healthcare.projects.locations.datasets.fhirStores.fhir._history.get - * @desc Gets a version (current or historical) of FHIR resource by version - * id. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir._history.get + * healthcare.projects.locations.datasets.fhirStores.fhir.update + * @desc Updates the entire contents of a resource. Implements the FHIR standard [update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#update). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the resource version to retrieve. + * @param {string} params.name The name of the resource to update. + * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get, + update( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get, + update( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get, + update( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update; options = {}; } @@ -7845,7 +6847,7 @@ export namespace healthcare_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PUT', }, options ), @@ -7862,51 +6864,45 @@ export namespace healthcare_v1beta1 { } /** - * healthcare.projects.locations.datasets.fhirStores.fhir._history.list - * @desc Lists all the versions of a resource (including the current version - * and deleted versions) from the FHIR store. - * @alias - * healthcare.projects.locations.datasets.fhirStores.fhir._history.list + * healthcare.projects.locations.datasets.fhirStores.fhir.vread + * @desc Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard [vread interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.vread * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: An entire year: `_at=2019` An entire month: `_at=2019-01` A specific day: `_at=2019-01-20` A specific second: `_at=2018-12-31T23:59:58Z` - * @param {integer=} params.count The maximum number of search results on a page. - * @param {string} params.name The name of the resource to retrieve. - * @param {string=} params.page Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. - * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. + * @param {string} params.name The name of the resource version to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List, + vread( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, options?: MethodOptions ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List, + vread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List, + vread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread, callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + vread(callback: BodyResponseCallback): void; + vread( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List; + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread; options = {}; } @@ -7919,10 +6915,7 @@ export namespace healthcare_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/_history').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -7940,7 +6933,7 @@ export namespace healthcare_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$Get + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities extends StandardParameters { /** * Auth client or API Key for the request @@ -7948,11 +6941,119 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the resource version to retrieve. + * Name of the FHIR store to retrieve the capabilities for. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + */ + type?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalpatch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionalupdate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The FHIR resource type to create, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$_history$List + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Executebundle + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the FHIR store in which this bundle will be executed. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$History extends StandardParameters { /** * Auth client or API Key for the request @@ -7960,16 +7061,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Only include resource versions that were current at some point during the - * time period specified in the date time value. The date parameter format - * is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the - * following: An entire year: `_at=2019` An entire month: `_at=2019-01` A - * specific day: `_at=2019-01-20` A specific second: - * `_at=2018-12-31T23:59:58Z` + * Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` */ at?: string; /** - * The maximum number of search results on a page. + * The maximum number of search results on a page. Defaults to 1000. */ count?: number; /** @@ -7977,22 +7073,133 @@ export namespace healthcare_v1beta1 { */ name?: string; /** - * Used to retrieve the first, previous, next, or last page of resource - * versions when using pagination. Value should be set to the value of the - * `link.url` field returned in the response to the previous request, where - * `link.relation` is "first", "previous", "next" or "last". Omit `page` if - * no previous request has been made. + * Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. */ page?: string; /** - * Only include resource versions that were created at or after the given - * instant in time. The instant in time uses the format - * YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 - * or 2017-01-01T00:00:00Z). The time must be specified to the second and - * include a time zone. + * Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. */ since?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the FHIR store to retrieve resources from. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Patienteverything + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. + */ + end?: string; + /** + * Name of the `Patient` resource for which the information is required. + */ + name?: string; + /** + * The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. + */ + start?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Resourcepurge + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to purge. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Search + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the FHIR store to retrieve resources from. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchResourcesRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Vread + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the resource version to retrieve. + */ + name?: string; + } export class Resource$Projects$Locations$Datasets$Hl7v2stores { context: APIRequestContext; @@ -8082,8 +7289,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.delete - * @desc Deletes the specified HL7v2 store and removes all messages that are - * contained within it. + * @desc Deletes the specified HL7v2 store and removes all messages that are contained within it. * @alias healthcare.projects.locations.datasets.hl7V2Stores.delete * @memberOf! () * @@ -8223,8 +7429,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy * @memberOf! () * @@ -8448,8 +7653,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy * @memberOf! () * @@ -8522,13 +7726,8 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. - * @alias - * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -8616,8 +7815,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the HL7v2 store that is being created. The string must match - * the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. */ hl7V2StoreId?: string; /** @@ -8662,8 +7860,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -8675,19 +7872,15 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. */ filter?: string; /** - * Limit on the number of HL7v2 stores to return in a single response. If - * zero the default page size of 100 is used. + * Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -8703,14 +7896,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. Resource name of the HL7v2 store, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -8727,8 +7917,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -8745,8 +7934,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -8764,12 +7952,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.create - * @desc Creates a message and sends a notification to the Cloud Pub/Sub - * topic. If configured, the MLLP adapter listens to messages created by - * this method and sends those back to the hospital. A successful response - * indicates the message has been persisted to storage and a Cloud Pub/Sub - * notification has been sent. Sending to the hospital by the MLLP adapter - * happens asynchronously. + * @desc Creates a message and sends a notification to the Cloud Pub/Sub topic. If configured, the MLLP adapter listens to messages created by this method and sends those back to the hospital. A successful response indicates the message has been persisted to storage and a Cloud Pub/Sub notification has been sent. Sending to the hospital by the MLLP adapter happens asynchronously. * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.create * @memberOf! () * @@ -8981,11 +8164,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest - * @desc Ingests a new HL7v2 message from the hospital and sends a - * notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message - * if the message was successfully stored. Otherwise an error is returned. - * If an identical HL7v2 message is created twice only one resource is - * created on the server and no error is reported. + * @desc Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. If an identical HL7v2 message is created twice only one resource is created on the server and no error is reported. * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest * @memberOf! () * @@ -9062,8 +8241,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.list - * @desc Lists all the messages in the given HL7v2 store with support for - * filtering. + * @desc Lists all the messages in the given HL7v2 store with support for filtering. * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.list * @memberOf! () * @@ -9254,8 +8432,7 @@ export namespace healthcare_v1beta1 { */ name?: string; /** - * Specifies which parts of the Message resource should be returned in the - * response. + * Specifies which parts of the Message resource should be returned in the response. */ view?: string; } @@ -9284,53 +8461,19 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts messages returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Fields/functions available for filtering are: * `message_type`, from - * the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` - * or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's - * time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` - * * `send_time`, the timestamp of when the message was sent, using the - * RFC3339 time format for comparisons, from the MSH-7 segment; for example - * `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care - * center that the message came from, from the MSH-4 segment; for example - * `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular - * expression matching of `expr` against the message payload using re2 - * (http://code.google.com/p/re2/) syntax; for example - * `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches - * if the message lists a patient having an ID of the given value and type - * in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", - * "MRN")` * `labels.x`, a string value of the label with key `x` as set - * using the Message.labels map, for example `labels."priority"="high"`. The - * operator `:*` can be used to assert the existence of a label, for example - * `labels."priority":*`. Limitations on conjunctions: * Negation on the - * patient ID function or the labels field is not supported, for example - * these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT - * labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple - * patient ID functions is not supported, for example this query is invalid: - * `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * - * Conjunction of multiple labels fields is also not supported, for example - * this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * - * Conjunction of one patient ID function, one labels field and conditions - * on other fields is supported, for example this query is valid: - * `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = - * "ADT"`. + * Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` * `send_time`, the timestamp of when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care center that the message came from, from the MSH-4 segment; for example `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular expression matching of `expr` against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", "MRN")` * `labels.x`, a string value of the label with key `x` as set using the Message.labels map, for example `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label, for example `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. */ filter?: string; /** - * Orders messages returned by the specified order_by clause. Syntax: - * https://cloud.google.com/apis/design/design_patterns#sorting_order Fields - * available for ordering are: * `send_time` + * Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * `send_time` */ orderBy?: string; /** - * Limit on the number of messages to return in a single response. If zero - * the default page size of 100 is used. + * Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. */ pageSize?: number; /** - * The next_page_token value returned from the previous List request, if - * any. + * The next_page_token value returned from the previous List request, if any. */ pageToken?: string; /** @@ -9346,18 +8489,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the Message, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. - * Assigned by the server. + * Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * Only the `labels` field is allowed to be updated. The labels in the - * request will be merged with the existing set of labels. Existing labels - * with the same keys will be updated. + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Only the `labels` field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated. */ updateMask?: string; @@ -9375,9 +8511,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias healthcare.projects.locations.datasets.operations.get * @memberOf! () * @@ -9448,15 +8582,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias healthcare.projects.locations.datasets.operations.list * @memberOf! () * diff --git a/src/apis/iam/package.json b/src/apis/iam/package.json index 7a1a42a6be3..4da7a8917d2 100644 --- a/src/apis/iam/package.json +++ b/src/apis/iam/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 59ed54072dc..d0271f2a13b 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace iam_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace iam_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace iam_v1 { /** * Identity and Access Management (IAM) API * - * Manages identity and access control for Google Cloud Platform resources, - * including the creation of service accounts, which you can use to - * authenticate to Google and make API calls. + * Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. * * @example * const {google} = require('googleapis'); @@ -118,7 +112,10 @@ export namespace iam_v1 { roles: Resource$Roles; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.iamPolicies = new Resource$Iampolicies(this.context); this.organizations = new Resource$Organizations(this.context); @@ -128,38 +125,26 @@ export namespace iam_v1 { } } + /** + * Audit log information specific to Cloud IAM admin APIs. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message. + */ + export interface Schema$AdminAuditData { + /** + * The permission_delta when when creating or updating a Role. + */ + permissionDelta?: Schema$PermissionDelta; + } /** * Contains information about an auditable service. */ export interface Schema$AuditableService { /** - * Public name of the service. For example, the service name for Cloud IAM - * is 'iam.googleapis.com'. + * Public name of the service. For example, the service name for Cloud IAM is 'iam.googleapis.com'. */ name?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -167,15 +152,12 @@ export namespace iam_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Audit log information specific to Cloud IAM. This message is serialized as - * an `Any` type in the `ServiceData` message of an `AuditLog` message. + * Audit log information specific to Cloud IAM. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message. */ export interface Schema$AuditData { /** @@ -184,18 +166,11 @@ export namespace iam_v1 { policyDelta?: Schema$PolicyDelta; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -208,36 +183,20 @@ export namespace iam_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * One delta entry for Binding. Each individual change (only one member in - * each entry) to a binding will be a separate entry. + * One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry. */ export interface Schema$BindingDelta { /** @@ -245,18 +204,15 @@ export namespace iam_v1 { */ action?: string; /** - * Unimplemented. The condition that is associated with this binding. This - * field is logged only for Cloud Audit Logging. + * Unimplemented. The condition that is associated with this binding. This field is logged only for Cloud Audit Logging. */ condition?: Schema$Expr; /** - * A single identity requesting access for a Cloud Platform resource. - * Follows the same format of Binding.members. Required + * A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required */ member?: string; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required */ role?: string; } @@ -278,14 +234,11 @@ export namespace iam_v1 { */ export interface Schema$CreateServiceAccountKeyRequest { /** - * Which type of key and algorithm to use for the key. The default is - * currently a 2K RSA key. However this may change in the future. + * Which type of key and algorithm to use for the key. The default is currently a 2K RSA key. However this may change in the future. */ keyAlgorithm?: string; /** - * The output format of the private key. The default value is - * `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File - * format. + * The output format of the private key. The default value is `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File format. */ privateKeyType?: string; } @@ -294,15 +247,11 @@ export namespace iam_v1 { */ export interface Schema$CreateServiceAccountRequest { /** - * Required. The account id that is used to generate the service account - * email address and a stable unique id. It is unique within a project, must - * be 6-30 characters long, and match the regular expression - * `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. + * Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. */ accountId?: string; /** - * The ServiceAccount resource to create. Currently, only the following - * values are user assignable: `display_name` . + * The ServiceAccount resource to create. Currently, only the following values are user assignable: `display_name` . */ serviceAccount?: Schema$ServiceAccount; } @@ -311,11 +260,7 @@ export namespace iam_v1 { */ export interface Schema$DisableServiceAccountRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -323,43 +268,32 @@ export namespace iam_v1 { */ export interface Schema$EnableServiceAccountRequest {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * The request to lint a Cloud IAM policy object. LintPolicy is currently - * functional only for `lint_object` of type `condition`. + * The request to lint a Cloud IAM policy object. LintPolicy is currently functional only for `lint_object` of type `condition`. */ export interface Schema$LintPolicyRequest { /** - * Binding object to be linted. The functionality of linting a binding is - * not yet implemented and if this field is set, it returns NOT_IMPLEMENTED - * error. + * Binding object to be linted. The functionality of linting a binding is not yet implemented and if this field is set, it returns NOT_IMPLEMENTED error. */ binding?: Schema$Binding; /** @@ -367,42 +301,24 @@ export namespace iam_v1 { */ condition?: Schema$Expr; /** - * `context` contains additional *permission-controlled* data that any lint - * unit may depend on, in form of `{key: value}` pairs. Currently, this - * field is non-operational and it will not be used during the lint - * operation. + * `context` contains additional *permission-controlled* data that any lint unit may depend on, in form of `{key: value}` pairs. Currently, this field is non-operational and it will not be used during the lint operation. */ context?: {[key: string]: any}; /** - * The full resource name of the policy this lint request is about. The - * name follows the Google Cloud Platform (GCP) resource format. For - * example, a GCP project with ID `my-project` will be named - * `//cloudresourcemanager.googleapis.com/projects/my-project`. The - * resource name is not used to read the policy instance from the Cloud IAM - * database. The candidate policy for lint has to be provided in the same - * request object. + * The full resource name of the policy this lint request is about. The name follows the Google Cloud Platform (GCP) resource format. For example, a GCP project with ID `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. The resource name is not used to read the policy instance from the Cloud IAM database. The candidate policy for lint has to be provided in the same request object. */ fullResourceName?: string; /** - * Policy object to be linted. The functionality of linting a policy is not - * yet implemented and if this field is set, it returns NOT_IMPLEMENTED - * error. + * Policy object to be linted. The functionality of linting a policy is not yet implemented and if this field is set, it returns NOT_IMPLEMENTED error. */ policy?: Schema$Policy; } /** - * The response of a lint operation. An empty response indicates the operation - * was able to fully execute and no lint issue was found. + * The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found. */ export interface Schema$LintPolicyResponse { /** - * List of lint results sorted by a composite <severity, - * binding_ordinal> key, descending order of severity and ascending order - * of binding_ordinal. There is no certain order among the same keys. For - * cross-binding results (only if the input object to lint is instance of - * google.iam.v1.Policy), there will be a google.iam.admin.v1.LintResult for - * each of the involved bindings, and the associated debug_message may - * enumerate the other involved binding ordinal number(s). + * List of lint results sorted by a composite <severity, binding_ordinal> key, descending order of severity and ascending order of binding_ordinal. There is no certain order among the same keys. For cross-binding results (only if the input object to lint is instance of google.iam.v1.Policy), there will be a google.iam.admin.v1.LintResult for each of the involved bindings, and the associated debug_message may enumerate the other involved binding ordinal number(s). */ lintResults?: Schema$LintResult[]; } @@ -411,12 +327,7 @@ export namespace iam_v1 { */ export interface Schema$LintResult { /** - * 0-based index ordinality of the binding in the input object associated - * with this result. This field is populated only if the input object to - * lint is of type google.iam.v1.Policy, which can comprise more than one - * binding. It is set to -1 if the result is not associated with any - * particular binding and only targets the policy as a whole, such as - * results about policy size violations. + * 0-based index ordinality of the binding in the input object associated with this result. This field is populated only if the input object to lint is of type google.iam.v1.Policy, which can comprise more than one binding. It is set to -1 if the result is not associated with any particular binding and only targets the policy as a whole, such as results about policy size violations. */ bindingOrdinal?: number; /** @@ -424,14 +335,7 @@ export namespace iam_v1 { */ debugMessage?: string; /** - * The name of the field for which this lint result is about. For nested - * messages, `field_name` consists of names of the embedded fields separated - * by period character. The top-level qualifier is the input object to lint - * in the request. For instance, if the lint request is on a - * google.iam.v1.Policy and this lint result is about a condition expression - * of one of the input policy bindings, the field would be populated as - * `policy.bindings.condition.expression`. This field does not identify the - * ordinality of the repetitive fields (for instance bindings in a policy). + * The name of the field for which this lint result is about. For nested messages, `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For instance, if the lint request is on a google.iam.v1.Policy and this lint result is about a condition expression of one of the input policy bindings, the field would be populated as `policy.bindings.condition.expression`. This field does not identify the ordinality of the repetitive fields (for instance bindings in a policy). */ fieldName?: string; /** @@ -439,9 +343,7 @@ export namespace iam_v1 { */ level?: string; /** - * 0-based character position of problematic construct within the object - * identified by `field_name`. Currently, this is populated only for - * condition expression. + * 0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression. */ locationOffset?: number; /** @@ -449,8 +351,7 @@ export namespace iam_v1 { */ severity?: string; /** - * The validation unit name, for instance - * “lintValidationUnits/ConditionComplexityCheck”. + * The validation unit name, for instance “lintValidationUnits/ConditionComplexityCheck”. */ validationUnitName?: string; } @@ -459,8 +360,7 @@ export namespace iam_v1 { */ export interface Schema$ListRolesResponse { /** - * To retrieve the next page of results, set `ListRolesRequest.page_token` - * to this value. + * To retrieve the next page of results, set `ListRolesRequest.page_token` to this value. */ nextPageToken?: string; /** @@ -486,8 +386,7 @@ export namespace iam_v1 { */ accounts?: Schema$ServiceAccount[]; /** - * To retrieve the next page of results, set - * ListServiceAccountsRequest.page_token to this value. + * To retrieve the next page of results, set ListServiceAccountsRequest.page_token to this value. */ nextPageToken?: string; } @@ -532,24 +431,20 @@ export namespace iam_v1 { title?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * A PermissionDelta message to record the added_permissions and removed_permissions inside a role. + */ + export interface Schema$PermissionDelta { + /** + * Added permissions. + */ + addedPermissions?: string[]; + /** + * Removed permissions. + */ + removedPermissions?: string[]; + } + /** + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -557,20 +452,11 @@ export namespace iam_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -592,10 +478,7 @@ export namespace iam_v1 { */ export interface Schema$QueryAuditableServicesRequest { /** - * Required. The full resource name to query from the list of auditable - * services. The name follows the Google Cloud Platform resource format. - * For example, a Cloud Platform project with id `my-project` will be named - * `//cloudresourcemanager.googleapis.com/projects/my-project`. + * Required. The full resource name to query from the list of auditable services. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. */ fullResourceName?: string; } @@ -613,10 +496,7 @@ export namespace iam_v1 { */ export interface Schema$QueryGrantableRolesRequest { /** - * Required. The full resource name to query from the list of grantable - * roles. The name follows the Google Cloud Platform resource format. For - * example, a Cloud Platform project with id `my-project` will be named - * `//cloudresourcemanager.googleapis.com/projects/my-project`. + * Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. */ fullResourceName?: string; /** @@ -624,8 +504,7 @@ export namespace iam_v1 { */ pageSize?: number; /** - * Optional pagination token returned in an earlier - * QueryGrantableRolesResponse. + * Optional pagination token returned in an earlier QueryGrantableRolesResponse. */ pageToken?: string; view?: string; @@ -635,8 +514,7 @@ export namespace iam_v1 { */ export interface Schema$QueryGrantableRolesResponse { /** - * To retrieve the next page of results, set - * `QueryGrantableRolesRequest.page_token` to this value. + * To retrieve the next page of results, set `QueryGrantableRolesRequest.page_token` to this value. */ nextPageToken?: string; /** @@ -649,10 +527,7 @@ export namespace iam_v1 { */ export interface Schema$QueryTestablePermissionsRequest { /** - * Required. The full resource name to query from the list of testable - * permissions. The name follows the Google Cloud Platform resource format. - * For example, a Cloud Platform project with id `my-project` will be named - * `//cloudresourcemanager.googleapis.com/projects/my-project`. + * Required. The full resource name to query from the list of testable permissions. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. */ fullResourceName?: string; /** @@ -660,8 +535,7 @@ export namespace iam_v1 { */ pageSize?: number; /** - * Optional pagination token returned in an earlier - * QueryTestablePermissionsRequest. + * Optional pagination token returned in an earlier QueryTestablePermissionsRequest. */ pageToken?: string; } @@ -670,8 +544,7 @@ export namespace iam_v1 { */ export interface Schema$QueryTestablePermissionsResponse { /** - * To retrieve the next page of results, set - * `QueryTestableRolesRequest.page_token` to this value. + * To retrieve the next page of results, set `QueryTestableRolesRequest.page_token` to this value. */ nextPageToken?: string; /** @@ -684,8 +557,7 @@ export namespace iam_v1 { */ export interface Schema$Role { /** - * The current deleted state of the role. This field is read only. It will - * be ignored in calls to CreateRole and UpdateRole. + * The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole. */ deleted?: boolean; /** @@ -697,57 +569,36 @@ export namespace iam_v1 { */ etag?: string; /** - * The names of the permissions this role grants when bound in an IAM - * policy. + * The names of the permissions this role grants when bound in an IAM policy. */ includedPermissions?: string[]; /** - * The name of the role. When Role is used in CreateRole, the role name - * must not be set. When Role is used in output and other input such as - * UpdateRole, the role name is the complete path, e.g., - * roles/logging.viewer for curated roles and - * organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles. + * The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for curated roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles. */ name?: string; /** - * The current launch stage of the role. If the `ALPHA` launch stage has - * been selected for a role, the `stage` field will not be included in the - * returned definition for the role. + * The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role. */ stage?: string; /** - * Optional. A human-readable title for the role. Typically this is - * limited to 100 UTF-8 bytes. + * Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. */ title?: string; } /** - * A service account in the Identity and Access Management API. To create a - * service account, specify the `project_id` and the `account_id` for the - * account. The `account_id` is unique within the project, and is used to - * generate the service account email address and a stable `unique_id`. If - * the account already exists, the account's resource name is returned in - * the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller - * can use the name in other methods to access the account. All other methods - * can identify the service account using the format - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard - * for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` - * value can be the `email` address or the `unique_id` of the service account. + * A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ export interface Schema$ServiceAccount { /** - * Optional. A user-specified opaque description of the service account. - * Must be less than or equal to 256 UTF-8 bytes. + * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. */ description?: string; /** - * @OutputOnly A bool indicate if the service account is disabled. The field - * is currently in alpha phase. + * @OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase. */ disabled?: boolean; /** - * Optional. A user-specified name for the service account. Must be less - * than or equal to 100 UTF-8 bytes. + * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. */ displayName?: string; /** @@ -755,23 +606,15 @@ export namespace iam_v1 { */ email?: string; /** - * Optional. Note: `etag` is an inoperable legacy field that is only - * returned for backwards compatibility. + * Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility. */ etag?: string; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as - * a wildcard for the `PROJECT_ID` will infer the project from the `account` - * and the `ACCOUNT` value can be the `email` address or the `unique_id` of - * the service account. In responses the resource name will always be in - * the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. */ name?: string; /** - * @OutputOnly The OAuth2 client id for the service account. This is used in - * conjunction with the OAuth2 clientconfig API to make three legged OAuth2 - * (3LO) flows to access the data of Google users. + * @OutputOnly The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users. */ oauth2ClientId?: string; /** @@ -784,18 +627,7 @@ export namespace iam_v1 { uniqueId?: string; } /** - * Represents a service account key. A service account has two sets of - * key-pairs: user-managed, and system-managed. User-managed key-pairs can be - * created and deleted by users. Users are responsible for rotating these - * keys periodically to ensure security of their service accounts. Users - * retain the private key of these key-pairs, and Google retains ONLY the - * public key. System-managed keys are automatically rotated by Google, and - * are used for signing for a maximum of two weeks. The rotation process is - * probabilistic, and usage of the new key will gradually ramp up and down - * over the key's lifetime. We recommend caching the public key set for a - * service account for no more than 24 hours to ensure you have access to the - * latest keys. Public keys for all service accounts are also published at - * the OAuth2 Service Account API. + * Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. We recommend caching the public key set for a service account for no more than 24 hours to ensure you have access to the latest keys. Public keys for all service accounts are also published at the OAuth2 Service Account API. */ export interface Schema$ServiceAccountKey { /** @@ -803,25 +635,15 @@ export namespace iam_v1 { */ keyAlgorithm?: string; /** - * The resource name of the service account key in the following format - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. + * The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. */ name?: string; /** - * The private key data. Only provided in `CreateServiceAccountKey` - * responses. Make sure to keep the private key data secure because it - * allows for the assertion of the service account identity. When base64 - * decoded, the private key data can be used to authenticate with Google API - * client libraries and with <a - * href="/sdk/gcloud/reference/auth/activate-service-account">gcloud - * auth activate-service-account</a>. + * The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud auth activate-service-account</a>. */ privateKeyData?: string; /** - * The output format for the private key. Only provided in - * `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or - * `ListServiceAccountKey` responses. Google never exposes system-managed - * private keys, and never retains user-managed private keys. + * The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys. */ privateKeyType?: string; /** @@ -842,17 +664,11 @@ export namespace iam_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -905,10 +721,7 @@ export namespace iam_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -917,8 +730,7 @@ export namespace iam_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -950,23 +762,7 @@ export namespace iam_v1 { /** * iam.iamPolicies.lintPolicy - * @desc Lints a Cloud IAM policy object or its sub fields. Currently - * supports google.iam.v1.Policy, google.iam.v1.Binding and - * google.iam.v1.Binding.condition. Each lint operation consists of - * multiple lint validation units. Validation units have the following - * properties: - Each unit inspects the input object in regard to a - * particular linting aspect and issues a google.iam.admin.v1.LintResult - * disclosing the result. - Domain of discourse of each unit can be either - * google.iam.v1.Policy, google.iam.v1.Binding, or - * google.iam.v1.Binding.condition depending on the purpose of the - * validation. - A unit may require additional data (like the list of all - * possible enumerable values of a particular attribute used in the policy - * instance) which shall be provided by the caller. Refer to the comments - * of google.iam.admin.v1.LintPolicyRequest.context for more details. The - * set of applicable validation units is determined by the Cloud IAM server - * and is not configurable. Regardless of any lint issues or their - * severities, successful calls to `lintPolicy` return an HTTP 200 OK status - * code. + * @desc Lints a Cloud IAM policy object or its sub fields. Currently supports google.iam.v1.Policy, google.iam.v1.Binding and google.iam.v1.Binding.condition. Each lint operation consists of multiple lint validation units. Validation units have the following properties: - Each unit inspects the input object in regard to a particular linting aspect and issues a google.iam.admin.v1.LintResult disclosing the result. - Domain of discourse of each unit can be either google.iam.v1.Policy, google.iam.v1.Binding, or google.iam.v1.Binding.condition depending on the purpose of the validation. - A unit may require additional data (like the list of all possible enumerable values of a particular attribute used in the policy instance) which shall be provided by the caller. Refer to the comments of google.iam.admin.v1.LintPolicyRequest.context for more details. The set of applicable validation units is determined by the Cloud IAM server and is not configurable. Regardless of any lint issues or their severities, successful calls to `lintPolicy` return an HTTP 200 OK status code. * @alias iam.iamPolicies.lintPolicy * @memberOf! () * @@ -1040,8 +836,7 @@ export namespace iam_v1 { /** * iam.iamPolicies.queryAuditableServices - * @desc Returns a list of services that support service level audit logging - * configuration for the given resource. + * @desc Returns a list of services that support service level audit logging configuration for the given resource. * @alias iam.iamPolicies.queryAuditableServices * @memberOf! () * @@ -1238,12 +1033,7 @@ export namespace iam_v1 { /** * iam.organizations.roles.delete - * @desc Soft deletes a role. The role is suspended and cannot be used to - * create new IAM Policy Bindings. The Role will not be included in - * `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The - * Role contains the deleted boolean set. Existing Bindings remains, but are - * inactive. The Role can be undeleted within 7 days. After 7 days the Role - * is deleted and all Bindings associated with the role are removed. + * @desc Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed. * @alias iam.organizations.roles.delete * @memberOf! () * @@ -1611,8 +1401,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the parent resource in one of the following formats: - * `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` */ parent?: string; @@ -1633,9 +1422,7 @@ export namespace iam_v1 { */ etag?: string; /** - * The resource name of the role in one of the following formats: - * `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; } @@ -1647,9 +1434,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: - * `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; } @@ -1669,9 +1454,7 @@ export namespace iam_v1 { */ pageToken?: string; /** - * The resource name of the parent resource in one of the following formats: - * `` (empty string) -- this refers to curated roles. - * `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` */ parent?: string; /** @@ -1679,10 +1462,7 @@ export namespace iam_v1 { */ showDeleted?: boolean; /** - * Optional view for the returned Role objects. When `FULL` is specified, - * the `includedPermissions` field is returned, which includes a list of all - * permissions in the role. The default value is `BASIC`, which does not - * return the `includedPermissions` field. + * Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field. */ view?: string; } @@ -1694,9 +1474,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: - * `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; /** @@ -1717,9 +1495,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: - * `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; @@ -1737,8 +1513,7 @@ export namespace iam_v1 { /** * iam.permissions.queryTestablePermissions - * @desc Lists the permissions testable on a resource. A permission is - * testable if it can be tested for an identity on a resource. + * @desc Lists the permissions testable on a resource. A permission is testable if it can be tested for an identity on a resource. * @alias iam.permissions.queryTestablePermissions * @memberOf! () * @@ -1927,12 +1702,7 @@ export namespace iam_v1 { /** * iam.projects.roles.delete - * @desc Soft deletes a role. The role is suspended and cannot be used to - * create new IAM Policy Bindings. The Role will not be included in - * `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The - * Role contains the deleted boolean set. Existing Bindings remains, but are - * inactive. The Role can be undeleted within 7 days. After 7 days the Role - * is deleted and all Bindings associated with the role are removed. + * @desc Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed. * @alias iam.projects.roles.delete * @memberOf! () * @@ -2300,8 +2070,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the parent resource in one of the following formats: - * `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` */ parent?: string; @@ -2322,9 +2091,7 @@ export namespace iam_v1 { */ etag?: string; /** - * The resource name of the role in one of the following formats: - * `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; } @@ -2336,9 +2103,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: - * `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; } @@ -2358,9 +2123,7 @@ export namespace iam_v1 { */ pageToken?: string; /** - * The resource name of the parent resource in one of the following formats: - * `` (empty string) -- this refers to curated roles. - * `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` */ parent?: string; /** @@ -2368,10 +2131,7 @@ export namespace iam_v1 { */ showDeleted?: boolean; /** - * Optional view for the returned Role objects. When `FULL` is specified, - * the `includedPermissions` field is returned, which includes a list of all - * permissions in the role. The default value is `BASIC`, which does not - * return the `includedPermissions` field. + * Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field. */ view?: string; } @@ -2383,9 +2143,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: - * `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; /** @@ -2406,9 +2164,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: - * `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; @@ -2572,7 +2328,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.disable - * @desc Disables a ServiceAccount. The API is currently in alpha phase. + * @desc DisableServiceAccount is currently in the alpha launch stage. Disables a ServiceAccount, which immediately prevents the service account from authenticating and gaining access to APIs. Disabled service accounts can be safely restored by using EnableServiceAccount at any point. Deleted service accounts cannot be restored using this method. Disabling a service account that is bound to VMs, Apps, Functions, or other jobs will cause those jobs to lose access to resources if they are using the disabled service account. To improve reliability of your services and avoid unexpected outages, it is recommended to first disable a service account rather than delete it. After disabling the service account, wait at least 24 hours to verify there are no unintended consequences, and then delete the service account. * @alias iam.projects.serviceAccounts.disable * @memberOf! () * @@ -2645,7 +2401,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.enable - * @desc Enables a ServiceAccount. The API is currently in alpha phase. + * @desc EnableServiceAccount is currently in the alpha launch stage. Restores a disabled ServiceAccount that has been manually disabled by using DisableServiceAccount. Service accounts that have been disabled by other means or for other reasons, such as abuse, cannot be restored using this method. EnableServiceAccount will have no effect on a service account that is not disabled. Enabling an already enabled service account will have no effect. * @alias iam.projects.serviceAccounts.enable * @memberOf! () * @@ -2786,17 +2542,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.getIamPolicy - * @desc Returns the Cloud IAM access control policy for a ServiceAccount. - * Note: Service accounts are both [resources and - * identities](/iam/docs/service-accounts#service_account_permissions). This - * method treats the service account as a resource. It returns the Cloud IAM - * policy that reflects what members have access to the service account. - * This method does not return what resources the service account has access - * to. To see if a service account has access to a resource, call the - * `getIamPolicy` method on the target resource. For example, to view grants - * for a project, call the - * [projects.getIamPolicy](/resource-manager/reference/rest/v1/projects/getIamPolicy) - * method. + * @desc Returns the Cloud IAM access control policy for a ServiceAccount. Note: Service accounts are both [resources and identities](/iam/docs/service-accounts#service_account_permissions). This method treats the service account as a resource. It returns the Cloud IAM policy that reflects what members have access to the service account. This method does not return what resources the service account has access to. To see if a service account has access to a resource, call the `getIamPolicy` method on the target resource. For example, to view grants for a project, call the [projects.getIamPolicy](/resource-manager/reference/rest/v1/projects/getIamPolicy) method. * @alias iam.projects.serviceAccounts.getIamPolicy * @memberOf! () * @@ -2951,10 +2697,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.patch - * @desc Patches a ServiceAccount. Currently, only the following fields are - * updatable: `display_name` and `description`. Only fields specified in - * the request are guaranteed to be returned in the response. Other fields - * in the response may be empty. Note: The field mask is required. + * @desc Patches a ServiceAccount. Currently, only the following fields are updatable: `display_name` and `description`. Only fields specified in the request are guaranteed to be returned in the response. Other fields in the response may be empty. Note: The field mask is required. * @alias iam.projects.serviceAccounts.patch * @memberOf! () * @@ -3026,18 +2769,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.setIamPolicy - * @desc Sets the Cloud IAM access control policy for a ServiceAccount. - * Note: Service accounts are both [resources and - * identities](/iam/docs/service-accounts#service_account_permissions). This - * method treats the service account as a resource. Use it to grant members - * access to the service account, such as when they need to impersonate it. - * This method does not grant the service account access to other resources, - * such as projects. To grant a service account access to resources, include - * the service account in the Cloud IAM policy for the desired resource, - * then call the appropriate `setIamPolicy` method on the target resource. - * For example, to grant a service account access to a project, call the - * [projects.setIamPolicy](/resource-manager/reference/rest/v1/projects/setIamPolicy) - * method. + * @desc Sets the Cloud IAM access control policy for a ServiceAccount. Note: Service accounts are both [resources and identities](/iam/docs/service-accounts#service_account_permissions). This method treats the service account as a resource. Use it to grant members access to the service account, such as when they need to impersonate it. This method does not grant the service account access to other resources, such as projects. To grant a service account access to resources, include the service account in the Cloud IAM policy for the desired resource, then call the appropriate `setIamPolicy` method on the target resource. For example, to grant a service account access to a project, call the [projects.setIamPolicy](/resource-manager/reference/rest/v1/projects/setIamPolicy) method. * @alias iam.projects.serviceAccounts.setIamPolicy * @memberOf! () * @@ -3110,11 +2842,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.signBlob - * @desc **Note**: This method is in the process of being deprecated. Call - * the - * [`signBlob()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob) - * method of the Cloud IAM Service Account Credentials API instead. Signs a - * blob using a service account's system-managed private key. + * @desc **Note**: This method is in the process of being deprecated. Call the [`signBlob()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob) method of the Cloud IAM Service Account Credentials API instead. Signs a blob using a service account's system-managed private key. * @alias iam.projects.serviceAccounts.signBlob * @memberOf! () * @@ -3189,14 +2917,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.signJwt - * @desc **Note**: This method is in the process of being deprecated. Call - * the - * [`signJwt()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signJwt) - * method of the Cloud IAM Service Account Credentials API instead. Signs a - * JWT using a service account's system-managed private key. If no expiry - * time (`exp`) is provided in the `SignJwtRequest`, IAM sets an an expiry - * time of one hour by default. If you request an expiry time of more than - * one hour, the request will fail. + * @desc **Note**: This method is in the process of being deprecated. Call the [`signJwt()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signJwt) method of the Cloud IAM Service Account Credentials API instead. Signs a JWT using a service account's system-managed private key. If no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an an expiry time of one hour by default. If you request an expiry time of more than one hour, the request will fail. * @alias iam.projects.serviceAccounts.signJwt * @memberOf! () * @@ -3271,8 +2992,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.testIamPermissions - * @desc Tests the specified permissions against the IAM access control - * policy for a ServiceAccount. + * @desc Tests the specified permissions against the IAM access control policy for a ServiceAccount. * @alias iam.projects.serviceAccounts.testIamPermissions * @memberOf! () * @@ -3354,8 +3074,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.undelete - * @desc Restores a deleted ServiceAccount. This is to be used as an action - * of last resort. A service account may not always be restorable. + * @desc Restores a deleted ServiceAccount. This is to be used as an action of last resort. A service account may not always be restorable. * @alias iam.projects.serviceAccounts.undelete * @memberOf! () * @@ -3439,10 +3158,7 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.update - * @desc Note: This method is in the process of being deprecated. Use - * PatchServiceAccount instead. Updates a ServiceAccount. Currently, only - * the following fields are updatable: `display_name` . The `etag` is - * mandatory. + * @desc Note: This method is in the process of being deprecated. Use PatchServiceAccount instead. Updates a ServiceAccount. Currently, only the following fields are updatable: `display_name` and `description`. * @alias iam.projects.serviceAccounts.update * @memberOf! () * @@ -3521,8 +3237,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project associated with the service - * accounts, such as `projects/my-project-123`. + * Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`. */ name?: string; @@ -3539,11 +3254,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a - * wildcard for the `PROJECT_ID` will infer the project from the account. - * The `ACCOUNT` value can be the `email` address or the `unique_id` of the - * service account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } @@ -3555,11 +3266,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a - * wildcard for the `PROJECT_ID` will infer the project from the account. - * The `ACCOUNT` value can be the `email` address or the `unique_id` of the - * service account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; @@ -3576,9 +3283,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}'. Using `-` as - * a wildcard for the `PROJECT_ID` will infer the project from the account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}'. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. */ name?: string; @@ -3595,11 +3300,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a - * wildcard for the `PROJECT_ID` will infer the project from the account. - * The `ACCOUNT` value can be the `email` address or the `unique_id` of the - * service account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } @@ -3611,8 +3312,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -3624,19 +3324,15 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project associated with the service - * accounts, such as `projects/my-project-123`. + * Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`. */ name?: string; /** - * Optional limit on the number of service accounts to include in the - * response. Further accounts can subsequently be obtained by including the - * ListServiceAccountsResponse.next_page_token in a subsequent request. + * Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the ListServiceAccountsResponse.next_page_token in a subsequent request. */ pageSize?: number; /** - * Optional pagination token returned in an earlier - * ListServiceAccountsResponse.next_page_token. + * Optional pagination token returned in an earlier ListServiceAccountsResponse.next_page_token. */ pageToken?: string; } @@ -3648,12 +3344,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as - * a wildcard for the `PROJECT_ID` will infer the project from the `account` - * and the `ACCOUNT` value can be the `email` address or the `unique_id` of - * the service account. In responses the resource name will always be in - * the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. */ name?: string; @@ -3670,8 +3361,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3688,11 +3378,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a - * wildcard for the `PROJECT_ID` will infer the project from the account. - * The `ACCOUNT` value can be the `email` address or the `unique_id` of the - * service account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; @@ -3709,11 +3395,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a - * wildcard for the `PROJECT_ID` will infer the project from the account. - * The `ACCOUNT` value can be the `email` address or the `unique_id` of the - * service account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; @@ -3730,8 +3412,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3748,9 +3429,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}'. Using `-` as - * a wildcard for the `PROJECT_ID` will infer the project from the account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}'. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. */ name?: string; @@ -3767,12 +3446,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as - * a wildcard for the `PROJECT_ID` will infer the project from the `account` - * and the `ACCOUNT` value can be the `email` address or the `unique_id` of - * the service account. In responses the resource name will always be in - * the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. */ name?: string; @@ -4091,11 +3765,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a - * wildcard for the `PROJECT_ID` will infer the project from the account. - * The `ACCOUNT` value can be the `email` address or the `unique_id` of the - * service account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; @@ -4112,11 +3782,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account key in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` - * as a wildcard for the `PROJECT_ID` will infer the project from the - * account. The `ACCOUNT` value can be the `email` address or the - * `unique_id` of the service account. + * The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } @@ -4128,16 +3794,11 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account key in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` - * as a wildcard for the `PROJECT_ID` will infer the project from the - * account. The `ACCOUNT` value can be the `email` address or the - * `unique_id` of the service account. + * The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; /** - * The output format of the public key requested. X509_PEM is the default - * output format. + * The output format of the public key requested. X509_PEM is the default output format. */ publicKeyType?: string; } @@ -4149,17 +3810,11 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Filters the types of keys the user wants to include in the list response. - * Duplicate key types are not allowed. If no key type is provided, all keys - * are returned. + * Filters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned. */ keyTypes?: string[]; /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a - * wildcard for the `PROJECT_ID`, will infer the project from the account. - * The `ACCOUNT` value can be the `email` address or the `unique_id` of the - * service account. + * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } @@ -4314,9 +3969,7 @@ export namespace iam_v1 { /** * iam.roles.queryGrantableRoles - * @desc Queries roles that can be granted on a particular resource. A role - * is grantable if it can be used as the role in a binding for a policy for - * that resource. + * @desc Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource. * @alias iam.roles.queryGrantableRoles * @memberOf! () * @@ -4403,9 +4056,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: - * `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` - * `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` */ name?: string; } @@ -4424,9 +4075,7 @@ export namespace iam_v1 { */ pageToken?: string; /** - * The resource name of the parent resource in one of the following formats: - * `` (empty string) -- this refers to curated roles. - * `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` */ parent?: string; /** @@ -4434,10 +4083,7 @@ export namespace iam_v1 { */ showDeleted?: boolean; /** - * Optional view for the returned Role objects. When `FULL` is specified, - * the `includedPermissions` field is returned, which includes a list of all - * permissions in the role. The default value is `BASIC`, which does not - * return the `includedPermissions` field. + * Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field. */ view?: string; } diff --git a/src/apis/iamcredentials/package.json b/src/apis/iamcredentials/package.json index 4e388f573f3..a7af892a854 100644 --- a/src/apis/iamcredentials/package.json +++ b/src/apis/iamcredentials/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index 9883b30c826..f5258c4e87b 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace iamcredentials_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace iamcredentials_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace iamcredentials_v1 { /** * IAM Service Account Credentials API * - * Creates short-lived, limited-privilege credentials for IAM service - * accounts. + * Creates short-lived, limited-privilege credentials for IAM service accounts. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace iamcredentials_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -121,28 +119,15 @@ export namespace iamcredentials_v1 { export interface Schema$GenerateAccessTokenRequest { /** - * The sequence of service accounts in a delegation chain. Each service - * account must be granted the `roles/iam.serviceAccountTokenCreator` role - * on its next service account in the chain. The last service account in the - * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on - * the service account that is specified in the `name` field of the request. - * The delegates must have the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ delegates?: string[]; /** - * The desired lifetime duration of the access token in seconds. Must be set - * to a value less than or equal to 3600 (1 hour). If a value is not - * specified, the token's lifetime will be set to a default value of one - * hour. + * The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour. */ lifetime?: string; /** - * Code to identify the scopes to be included in the OAuth 2.0 access token. - * See https://developers.google.com/identity/protocols/googlescopes for - * more information. At least one value required. + * Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required. */ scope?: string[]; } @@ -158,43 +143,11 @@ export namespace iamcredentials_v1 { } export interface Schema$GenerateIdentityBindingAccessTokenRequest { /** - * Required. Input token. Must be in JWT format according to RFC7523 - * (https://tools.ietf.org/html/rfc7523) and must have 'kid' field - * in the header. Supported signing algorithms: RS256 (RS512, ES256, ES512 - * coming soon). Mandatory payload fields (along the lines of RFC 7523, - * section 3): - iss: issuer of the token. Must provide a discovery document - * at $iss/.well-known/openid-configuration . The document needs to - * be formatted according to section 4.2 of the OpenID Connect - * Discovery 1.0 specification. - iat: Issue time in seconds since - * epoch. Must be in the past. - exp: Expiration time in seconds since - * epoch. Must be less than 48 hours after iat. We recommend to - * create tokens that last shorter than 6 hours to improve security - * unless business reasons mandate longer expiration times. Shorter - * token lifetimes are generally more secure since tokens that have - * been exfiltrated by attackers can be used for a shorter time. you - * can configure the maximum lifetime of the incoming token in the - * configuration of the mapper. The resulting Google token will - * expire within an hour or at "exp", whichever is earlier. - * - sub: JWT subject, identity asserted in the JWT. - aud: Configured in - * the mapper policy. By default the service account email. Claims - * from the incoming token can be transferred into the output token accoding - * to the mapper configuration. The outgoing claim size is limited. Outgoing - * claims size must be less than 4kB serialized as JSON without whitespace. - * Example header: { "alg": "RS256", "kid": - * "92a4265e14ab04d4d228a48d10d4ca31610936f8" } Example payload: { - * "iss": "https://accounts.google.com", - * "iat": 1517963104, "exp": 1517966704, - * "aud": - * "https://iamcredentials.googleapis.com/google.iam.credentials.v1.CloudGaia", - * "sub": "113475438248934895348", - * "my_claims": { "additional_claim": - * "value" } } + * Required. Input token. Must be in JWT format according to RFC7523 (https://tools.ietf.org/html/rfc7523) and must have 'kid' field in the header. Supported signing algorithms: RS256 (RS512, ES256, ES512 coming soon). Mandatory payload fields (along the lines of RFC 7523, section 3): - iss: issuer of the token. Must provide a discovery document at $iss/.well-known/openid-configuration . The document needs to be formatted according to section 4.2 of the OpenID Connect Discovery 1.0 specification. - iat: Issue time in seconds since epoch. Must be in the past. - exp: Expiration time in seconds since epoch. Must be less than 48 hours after iat. We recommend to create tokens that last shorter than 6 hours to improve security unless business reasons mandate longer expiration times. Shorter token lifetimes are generally more secure since tokens that have been exfiltrated by attackers can be used for a shorter time. you can configure the maximum lifetime of the incoming token in the configuration of the mapper. The resulting Google token will expire within an hour or at "exp", whichever is earlier. - sub: JWT subject, identity asserted in the JWT. - aud: Configured in the mapper policy. By default the service account email. Claims from the incoming token can be transferred into the output token accoding to the mapper configuration. The outgoing claim size is limited. Outgoing claims size must be less than 4kB serialized as JSON without whitespace. Example header: { "alg": "RS256", "kid": "92a4265e14ab04d4d228a48d10d4ca31610936f8" } Example payload: { "iss": "https://accounts.google.com", "iat": 1517963104, "exp": 1517966704, "aud": "https://iamcredentials.googleapis.com/google.iam.credentials.v1.CloudGaia", "sub": "113475438248934895348", "my_claims": { "additional_claim": "value" } } */ jwt?: string; /** - * Code to identify the scopes to be included in the OAuth 2.0 access token. - * See https://developers.google.com/identity/protocols/googlescopes for - * more information. At least one value required. + * Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required. */ scope?: string[]; } @@ -210,25 +163,15 @@ export namespace iamcredentials_v1 { } export interface Schema$GenerateIdTokenRequest { /** - * The audience for the token, such as the API or account that this token - * grants access to. + * The audience for the token, such as the API or account that this token grants access to. */ audience?: string; /** - * The sequence of service accounts in a delegation chain. Each service - * account must be granted the `roles/iam.serviceAccountTokenCreator` role - * on its next service account in the chain. The last service account in the - * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on - * the service account that is specified in the `name` field of the request. - * The delegates must have the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ delegates?: string[]; /** - * Include the service account email in the token. If set to `true`, the - * token will contain `email` and `email_verified` claims. + * Include the service account email in the token. If set to `true`, the token will contain `email` and `email_verified` claims. */ includeEmail?: boolean; } @@ -240,15 +183,7 @@ export namespace iamcredentials_v1 { } export interface Schema$SignBlobRequest { /** - * The sequence of service accounts in a delegation chain. Each service - * account must be granted the `roles/iam.serviceAccountTokenCreator` role - * on its next service account in the chain. The last service account in the - * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on - * the service account that is specified in the `name` field of the request. - * The delegates must have the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ delegates?: string[]; /** @@ -268,15 +203,7 @@ export namespace iamcredentials_v1 { } export interface Schema$SignJwtRequest { /** - * The sequence of service accounts in a delegation chain. Each service - * account must be granted the `roles/iam.serviceAccountTokenCreator` role - * on its next service account in the chain. The last service account in the - * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on - * the service account that is specified in the `name` field of the request. - * The delegates must have the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ delegates?: string[]; /** @@ -397,8 +324,7 @@ export namespace iamcredentials_v1 { /** * iamcredentials.projects.serviceAccounts.generateIdentityBindingAccessToken - * @alias - * iamcredentials.projects.serviceAccounts.generateIdentityBindingAccessToken + * @alias iamcredentials.projects.serviceAccounts.generateIdentityBindingAccessToken * @memberOf! () * * @param {object} params Parameters for request @@ -734,11 +660,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are - * requested, in the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; @@ -755,11 +677,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are - * requested, in the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; @@ -776,11 +694,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are - * requested, in the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; @@ -797,11 +711,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are - * requested, in the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; @@ -818,11 +728,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are - * requested, in the following format: - * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` - * wildcard character is required; replacing it with a project ID is - * invalid. + * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; diff --git a/src/apis/iap/package.json b/src/apis/iap/package.json index a084bea8a44..f450c8ac643 100644 --- a/src/apis/iap/package.json +++ b/src/apis/iap/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index e05ef194c37..1a7d7a69711 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace iap_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace iap_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace iap_v1 { v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.v1 = new Resource$V1(this.context); } @@ -123,59 +122,36 @@ export namespace iap_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -184,41 +160,15 @@ export namespace iap_v1 { */ export interface Schema$GetIamPolicyRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -231,10 +181,7 @@ export namespace iap_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } @@ -243,10 +190,7 @@ export namespace iap_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -255,8 +199,7 @@ export namespace iap_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -269,10 +212,7 @@ export namespace iap_v1 { /** * iap.getIamPolicy - * @desc Gets the access control policy for an Identity-Aware Proxy - * protected resource. More information about managing access via IAP can be - * found at: - * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @desc Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api * @alias iap.getIamPolicy * @memberOf! () * @@ -344,10 +284,7 @@ export namespace iap_v1 { /** * iap.setIamPolicy - * @desc Sets the access control policy for an Identity-Aware Proxy - * protected resource. Replaces any existing policy. More information about - * managing access via IAP can be found at: - * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @desc Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api * @alias iap.setIamPolicy * @memberOf! () * @@ -419,10 +356,7 @@ export namespace iap_v1 { /** * iap.testIamPermissions - * @desc Returns permissions that a caller has on the Identity-Aware Proxy - * protected resource. More information about managing access via IAP can be - * found at: - * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @desc Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api * @alias iap.testIamPermissions * @memberOf! () * @@ -510,8 +444,7 @@ export namespace iap_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -527,8 +460,7 @@ export namespace iap_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -545,8 +477,7 @@ export namespace iap_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index c52406e8b36..0d91480c677 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace iap_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace iap_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace iap_v1beta1 { v1beta1: Resource$V1beta1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.v1beta1 = new Resource$V1beta1(this.context); } @@ -123,59 +122,36 @@ export namespace iap_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -184,41 +160,15 @@ export namespace iap_v1beta1 { */ export interface Schema$GetIamPolicyRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -231,10 +181,7 @@ export namespace iap_v1beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } @@ -243,10 +190,7 @@ export namespace iap_v1beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -255,8 +199,7 @@ export namespace iap_v1beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -269,10 +212,7 @@ export namespace iap_v1beta1 { /** * iap.getIamPolicy - * @desc Gets the access control policy for an Identity-Aware Proxy - * protected resource. More information about managing access via IAP can be - * found at: - * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @desc Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api * @alias iap.getIamPolicy * @memberOf! () * @@ -345,10 +285,7 @@ export namespace iap_v1beta1 { /** * iap.setIamPolicy - * @desc Sets the access control policy for an Identity-Aware Proxy - * protected resource. Replaces any existing policy. More information about - * managing access via IAP can be found at: - * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @desc Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api * @alias iap.setIamPolicy * @memberOf! () * @@ -421,12 +358,7 @@ export namespace iap_v1beta1 { /** * iap.testIamPermissions - * @desc Returns permissions that a caller has on the Identity-Aware Proxy - * protected resource. If the resource does not exist or the caller does not - * have Identity-Aware Proxy permissions a - * [google.rpc.Code.PERMISSION_DENIED] will be returned. More information - * about managing access via IAP can be found at: - * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @desc Returns permissions that a caller has on the Identity-Aware Proxy protected resource. If the resource does not exist or the caller does not have Identity-Aware Proxy permissions a [google.rpc.Code.PERMISSION_DENIED] will be returned. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api * @alias iap.testIamPermissions * @memberOf! () * @@ -515,8 +447,7 @@ export namespace iap_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -533,8 +464,7 @@ export namespace iap_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -551,8 +481,7 @@ export namespace iap_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/identitytoolkit/package.json b/src/apis/identitytoolkit/package.json index d99d1b18b14..58403d24421 100644 --- a/src/apis/identitytoolkit/package.json +++ b/src/apis/identitytoolkit/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/identitytoolkit/v3.ts b/src/apis/identitytoolkit/v3.ts index 3dace5c8af4..65d4b5f38c1 100644 --- a/src/apis/identitytoolkit/v3.ts +++ b/src/apis/identitytoolkit/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace identitytoolkit_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace identitytoolkit_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace identitytoolkit_v3 { relyingparty: Resource$Relyingparty; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.relyingparty = new Resource$Relyingparty(this.context); } @@ -134,8 +134,7 @@ export namespace identitytoolkit_v3 { */ registered?: boolean; /** - * Session ID which should be passed in the following verifyAssertion - * request. + * Session ID which should be passed in the following verifyAssertion request. */ sessionId?: string; /** @@ -161,8 +160,7 @@ export namespace identitytoolkit_v3 { */ kind?: string; /** - * The next page token. To be used in a subsequent request to return the - * next page of results. + * The next page token. To be used in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -246,8 +244,7 @@ export namespace identitytoolkit_v3 { users?: Schema$UserInfo[]; } /** - * Response of getting a code for user confirmation (reset password, change - * email etc.). + * Response of getting a code for user confirmation (reset password, change email etc.). */ export interface Schema$GetOobConfirmationCodeResponse { /** @@ -255,8 +252,7 @@ export namespace identitytoolkit_v3 { */ email?: string; /** - * The fixed string - * "identitytoolkit#GetOobConfirmationCodeResponse". + * The fixed string "identitytoolkit#GetOobConfirmationCodeResponse". */ kind?: string; /** @@ -277,8 +273,7 @@ export namespace identitytoolkit_v3 { */ recaptchaSiteKey?: string; /** - * The stoken field for the recaptcha widget, used to request captcha - * challenge. + * The stoken field for the recaptcha widget, used to request captcha challenge. */ recaptchaStoken?: string; } @@ -287,13 +282,11 @@ export namespace identitytoolkit_v3 { */ export interface Schema$IdentitytoolkitRelyingpartyCreateAuthUriRequest { /** - * The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, - * BUNDLE_ID for iOS. + * The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS. */ appId?: string; /** - * Explicitly specify the auth flow type. Currently only support - * "CODE_FLOW" type. The field is only used for Google provider. + * Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider. */ authFlowType?: string; /** @@ -301,25 +294,19 @@ export namespace identitytoolkit_v3 { */ clientId?: string; /** - * The opaque value used by the client to maintain context info between the - * authentication request and the IDP callback. + * The opaque value used by the client to maintain context info between the authentication request and the IDP callback. */ context?: string; /** - * The URI to which the IDP redirects the user after the federated login - * flow. + * The URI to which the IDP redirects the user after the federated login flow. */ continueUri?: string; /** - * The query parameter that client can customize by themselves in auth url. - * The following parameters are reserved for server so that they cannot be - * customized by clients: client_id, response_type, scope, redirect_uri, - * state, oauth_token. + * The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token. */ customParameter?: {[key: string]: string}; /** - * The hosted domain to restrict sign-in to accounts at that domain for - * Google Apps hosted accounts. + * The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts. */ hostedDomain?: string; /** @@ -331,14 +318,11 @@ export namespace identitytoolkit_v3 { */ oauthConsumerKey?: string; /** - * Additional oauth scopes, beyond the basid user profile, that the user - * would be prompted to grant + * Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant */ oauthScope?: string; /** - * Optional realm for OpenID protocol. The sub string - * "scheme://domain:port" of the param "continueUri" is - * used if this is not set. + * Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set. */ openidRealm?: string; /** @@ -346,9 +330,7 @@ export namespace identitytoolkit_v3 { */ otaApp?: string; /** - * The IdP ID. For white listed IdPs it's a short domain name e.g. - * google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs - * it's the OP identifier. + * The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier. */ providerId?: string; /** @@ -356,9 +338,7 @@ export namespace identitytoolkit_v3 { */ sessionId?: string; /** - * For multi-tenant use cases, in order to construct sign-in URL with the - * correct IDP parameters, Firebear needs to know which Tenant to retrieve - * IDP configs from. + * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ tenantId?: string; /** @@ -371,8 +351,7 @@ export namespace identitytoolkit_v3 { */ export interface Schema$IdentitytoolkitRelyingpartyDeleteAccountRequest { /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -389,8 +368,7 @@ export namespace identitytoolkit_v3 { */ export interface Schema$IdentitytoolkitRelyingpartyDownloadAccountRequest { /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -398,13 +376,11 @@ export namespace identitytoolkit_v3 { */ maxResults?: number; /** - * The token for the next page. This should be taken from the previous - * response. + * The token for the next page. This should be taken from the previous response. */ nextPageToken?: string; /** - * Specify which project (field value is actually project id) to operate. - * Only used when provided credential. + * Specify which project (field value is actually project id) to operate. Only used when provided credential. */ targetProjectId?: string; } @@ -430,8 +406,7 @@ export namespace identitytoolkit_v3 { */ export interface Schema$IdentitytoolkitRelyingpartyGetAccountInfoRequest { /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -577,8 +552,7 @@ export namespace identitytoolkit_v3 { */ customAttributes?: string; /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -675,8 +649,7 @@ export namespace identitytoolkit_v3 { */ changeEmailTemplate?: Schema$EmailTemplate; /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -788,9 +761,7 @@ export namespace identitytoolkit_v3 { */ photoUrl?: string; /** - * For multi-tenant use cases, in order to construct sign-in URL with the - * correct IDP parameters, Firebear needs to know which Tenant to retrieve - * IDP configs from. + * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ tenantId?: string; /** @@ -812,8 +783,7 @@ export namespace identitytoolkit_v3 { */ cpuMemCost?: number; /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; dkLen?: number; @@ -835,8 +805,7 @@ export namespace identitytoolkit_v3 { */ saltSeparator?: string; /** - * If true, backend will do sanity check(including duplicate email and - * federated id) when uploading account. + * If true, backend will do sanity check(including duplicate email and federated id) when uploading account. */ sanityCheck?: boolean; /** @@ -844,8 +813,7 @@ export namespace identitytoolkit_v3 { */ signerKey?: string; /** - * Specify which project (field value is actually project id) to operate. - * Only used when provided credential. + * Specify which project (field value is actually project id) to operate. Only used when provided credential. */ targetProjectId?: string; /** @@ -858,14 +826,11 @@ export namespace identitytoolkit_v3 { */ export interface Schema$IdentitytoolkitRelyingpartyVerifyAssertionRequest { /** - * When it's true, automatically creates a new account if the user - * doesn't exist. When it's false, allows existing user to sign in - * normally and throws exception if the user doesn't exist. + * When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist. */ autoCreate?: boolean; /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -877,8 +842,7 @@ export namespace identitytoolkit_v3 { */ instanceId?: string; /** - * The GITKit token for the non-trusted IDP pending to be confirmed by the - * user. + * The GITKit token for the non-trusted IDP pending to be confirmed by the user. */ pendingIdToken?: string; /** @@ -886,13 +850,11 @@ export namespace identitytoolkit_v3 { */ postBody?: string; /** - * The URI to which the IDP redirects the user back. It may contain - * federated login result params added by the IDP. + * The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP. */ requestUri?: string; /** - * Whether return 200 and IDP credential rather than throw exception when - * federated id is already linked. + * Whether return 200 and IDP credential rather than throw exception when federated id is already linked. */ returnIdpCredential?: boolean; /** @@ -908,9 +870,7 @@ export namespace identitytoolkit_v3 { */ sessionId?: string; /** - * For multi-tenant use cases, in order to construct sign-in URL with the - * correct IDP parameters, Firebear needs to know which Tenant to retrieve - * IDP configs from. + * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ tenantId?: string; /** @@ -923,8 +883,7 @@ export namespace identitytoolkit_v3 { */ export interface Schema$IdentitytoolkitRelyingpartyVerifyCustomTokenRequest { /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -953,8 +912,7 @@ export namespace identitytoolkit_v3 { */ captchaResponse?: string; /** - * GCP project number of the requesting delegated app. Currently only - * intended for Firebase V1 migration. + * GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. */ delegatedProjectNumber?: string; /** @@ -974,8 +932,7 @@ export namespace identitytoolkit_v3 { */ password?: string; /** - * The GITKit token for the non-trusted IDP, which is to be confirmed by the - * user. + * The GITKit token for the non-trusted IDP, which is to be confirmed by the user. */ pendingIdToken?: string; /** @@ -983,9 +940,7 @@ export namespace identitytoolkit_v3 { */ returnSecureToken?: boolean; /** - * For multi-tenant use cases, in order to construct sign-in URL with the - * correct IDP parameters, Firebear needs to know which Tenant to retrieve - * IDP configs from. + * For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. */ tenantId?: string; /** @@ -1002,8 +957,7 @@ export namespace identitytoolkit_v3 { operation?: string; phoneNumber?: string; /** - * The session info previously returned by - * IdentityToolkit-SendVerificationCode. + * The session info previously returned by IdentityToolkit-SendVerificationCode. */ sessionInfo?: string; temporaryProof?: string; @@ -1037,8 +991,7 @@ export namespace identitytoolkit_v3 { */ enabled?: boolean; /** - * Percent of users who will be prompted/redirected federated login for this - * IDP. + * Percent of users who will be prompted/redirected federated login for this IDP. */ experimentPercent?: number; /** @@ -1055,18 +1008,15 @@ export namespace identitytoolkit_v3 { whitelistedAudiences?: string[]; } /** - * Request of getting a code for user confirmation (reset password, change - * email etc.) + * Request of getting a code for user confirmation (reset password, change email etc.) */ export interface Schema$Relyingparty { /** - * whether or not to install the android app on the device where the link is - * opened + * whether or not to install the android app on the device where the link is opened */ androidInstallApp?: boolean; /** - * minimum version of the app. if the version on the device is lower than - * this version then the user is taken to the play store to upgrade the app + * minimum version of the app. if the version on the device is lower than this version then the user is taken to the play store to upgrade the app */ androidMinimumVersion?: string; /** @@ -1127,8 +1077,7 @@ export namespace identitytoolkit_v3 { */ export interface Schema$ResetPasswordResponse { /** - * The user's email. If the out-of-band code is for email recovery, the - * user's original email. + * The user's email. If the out-of-band code is for email recovery, the user's original email. */ email?: string; /** @@ -1161,8 +1110,7 @@ export namespace identitytoolkit_v3 { */ emailVerified?: boolean; /** - * If idToken is STS id token, then this field will be expiration time of - * STS id token in seconds. + * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ expiresIn?: string; /** @@ -1204,8 +1152,7 @@ export namespace identitytoolkit_v3 { refreshToken?: string; } /** - * Response of signing up new user, creating anonymous user or anonymous user - * reauth. + * Response of signing up new user, creating anonymous user or anonymous user reauth. */ export interface Schema$SignupNewUserResponse { /** @@ -1217,8 +1164,7 @@ export namespace identitytoolkit_v3 { */ email?: string; /** - * If idToken is STS id token, then this field will be expiration time of - * STS id token in seconds. + * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ expiresIn?: string; /** @@ -1358,8 +1304,7 @@ export namespace identitytoolkit_v3 { */ appScheme?: string; /** - * The opaque value used by the client to maintain context info between the - * authentication request and the IDP callback. + * The opaque value used by the client to maintain context info between the authentication request and the IDP callback. */ context?: string; /** @@ -1371,8 +1316,7 @@ export namespace identitytoolkit_v3 { */ displayName?: string; /** - * The email returned by the IdP. NOTE: The federated login user may not own - * the email. + * The email returned by the IdP. NOTE: The federated login user may not own the email. */ email?: string; /** @@ -1380,8 +1324,7 @@ export namespace identitytoolkit_v3 { */ emailRecycled?: boolean; /** - * The value is true if the IDP is also the email provider. It means the - * user owns the email. + * The value is true if the IDP is also the email provider. It means the user owns the email. */ emailVerified?: boolean; /** @@ -1389,8 +1332,7 @@ export namespace identitytoolkit_v3 { */ errorMessage?: string; /** - * If idToken is STS id token, then this field will be expiration time of - * STS id token in seconds. + * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ expiresIn?: string; /** @@ -1410,9 +1352,7 @@ export namespace identitytoolkit_v3 { */ idToken?: string; /** - * It's the identifier param in the createAuthUri request if the - * identifier is an email. It can be used to check whether the user input - * email is different from the asserted email. + * It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email. */ inputEmail?: string; /** @@ -1432,13 +1372,11 @@ export namespace identitytoolkit_v3 { */ lastName?: string; /** - * The RP local ID if it's already been mapped to the IdP account - * identified by the federated ID. + * The RP local ID if it's already been mapped to the IdP account identified by the federated ID. */ localId?: string; /** - * Whether the assertion is from a non-trusted IDP and need account linking - * confirmation. + * Whether the assertion is from a non-trusted IDP and need account linking confirmation. */ needConfirmation?: boolean; /** @@ -1478,8 +1416,7 @@ export namespace identitytoolkit_v3 { */ oauthTokenSecret?: string; /** - * The original email stored in the mapping storage. It's returned when - * the federated ID is associated to a different email. + * The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email. */ originalEmail?: string; /** @@ -1487,12 +1424,7 @@ export namespace identitytoolkit_v3 { */ photoUrl?: string; /** - * The IdP ID. For white listed IdPs it's a short domain name e.g. - * google.com, aol.com, live.net and yahoo.com. If the - * "providerId" param is set to OpenID OP identifer other than the - * whilte listed IdPs the OP identifier is returned. If the - * "identifier" param is federated ID in the createAuthUri - * request. The domain part of the federated ID is returned. + * The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned. */ providerId?: string; /** @@ -1512,8 +1444,7 @@ export namespace identitytoolkit_v3 { */ timeZone?: string; /** - * When action is 'map', contains the idps which can be used for - * confirmation. + * When action is 'map', contains the idps which can be used for confirmation. */ verifiedProvider?: string[]; } @@ -1522,8 +1453,7 @@ export namespace identitytoolkit_v3 { */ export interface Schema$VerifyCustomTokenResponse { /** - * If idToken is STS id token, then this field will be expiration time of - * STS id token in seconds. + * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ expiresIn?: string; /** @@ -1552,13 +1482,11 @@ export namespace identitytoolkit_v3 { */ displayName?: string; /** - * The email returned by the IdP. NOTE: The federated login user may not own - * the email. + * The email returned by the IdP. NOTE: The federated login user may not own the email. */ email?: string; /** - * If idToken is STS id token, then this field will be expiration time of - * STS id token in seconds. + * If idToken is STS id token, then this field will be expiration time of STS id token in seconds. */ expiresIn?: string; /** @@ -1570,8 +1498,7 @@ export namespace identitytoolkit_v3 { */ kind?: string; /** - * The RP local ID if it's already been mapped to the IdP account - * identified by the federated ID. + * The RP local ID if it's already been mapped to the IdP account identified by the federated ID. */ localId?: string; /** @@ -3189,8 +3116,7 @@ export namespace identitytoolkit_v3 { /** * identitytoolkit.relyingparty.verifyPhoneNumber - * @desc Verifies ownership of a phone number and creates/updates the user - * account accordingly. + * @desc Verifies ownership of a phone number and creates/updates the user account accordingly. * @alias identitytoolkit.relyingparty.verifyPhoneNumber * @memberOf! () * diff --git a/src/apis/index.ts b/src/apis/index.ts index d9881933c75..64453ac255e 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -69,6 +69,7 @@ import * as containeranalysis from './containeranalysis'; import * as content from './content'; import * as customsearch from './customsearch'; import * as dataflow from './dataflow'; +import * as datafusion from './datafusion'; import * as dataproc from './dataproc'; import * as datastore from './datastore'; import * as deploymentmanager from './deploymentmanager'; @@ -231,6 +232,7 @@ export const APIS: APIList = { content: content.VERSIONS, customsearch: customsearch.VERSIONS, dataflow: dataflow.VERSIONS, + datafusion: datafusion.VERSIONS, dataproc: dataproc.VERSIONS, datastore: datastore.VERSIONS, deploymentmanager: deploymentmanager.VERSIONS, @@ -391,6 +393,7 @@ export class GeneratedAPIs { content = content.content; customsearch = customsearch.customsearch; dataflow = dataflow.dataflow; + datafusion = datafusion.datafusion; dataproc = dataproc.dataproc; datastore = datastore.datastore; deploymentmanager = deploymentmanager.deploymentmanager; diff --git a/src/apis/indexing/package.json b/src/apis/indexing/package.json index 120c9e05d89..feae5a35644 100644 --- a/src/apis/indexing/package.json +++ b/src/apis/indexing/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/indexing/v3.ts b/src/apis/indexing/v3.ts index 66a4710b7cc..11695cb6e5f 100644 --- a/src/apis/indexing/v3.ts +++ b/src/apis/indexing/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace indexing_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace indexing_v3 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace indexing_v3 { urlNotifications: Resource$Urlnotifications; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.urlNotifications = new Resource$Urlnotifications(this.context); } @@ -128,13 +127,11 @@ export namespace indexing_v3 { urlNotificationMetadata?: Schema$UrlNotificationMetadata; } /** - * `UrlNotification` is the resource used in all Indexing API calls. It - * describes one event in the life cycle of a Web Document. + * `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document. */ export interface Schema$UrlNotification { /** - * Creation timestamp for this notification. Users should _not_ specify it, - * the field is ignored at the request time. + * Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. */ notifyTime?: string; /** @@ -142,15 +139,12 @@ export namespace indexing_v3 { */ type?: string; /** - * The object of this notification. The URL must be owned by the publisher - * of this notification and, in case of `URL_UPDATED` notifications, it - * _must_ be crawlable by Google. + * The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. */ url?: string; } /** - * Summary of the most recent Indexing API notifications successfully - * received, for a given URL. + * Summary of the most recent Indexing API notifications successfully received, for a given URL. */ export interface Schema$UrlNotificationMetadata { /** @@ -175,10 +169,7 @@ export namespace indexing_v3 { /** * indexing.urlNotifications.getMetadata - * @desc Gets metadata about a Web Document. This method can _only_ be used - * to query URLs that were previously seen in successful Indexing API - * notifications. Includes the latest `UrlNotification` received via this - * API. + * @desc Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest `UrlNotification` received via this API. * @alias indexing.urlNotifications.getMetadata * @memberOf! () * diff --git a/src/apis/jobs/package.json b/src/apis/jobs/package.json index 5f38c85169e..4c91ea088d5 100644 --- a/src/apis/jobs/package.json +++ b/src/apis/jobs/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index cde72412a2a..4017e157ebd 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace jobs_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace jobs_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace jobs_v2 { /** * Cloud Talent Solution API * - * Cloud Talent Solution provides the capability to create, read, update, and - * delete job postings, as well as search jobs based on keywords and filters. + * Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. * * @example * const {google} = require('googleapis'); @@ -115,7 +110,10 @@ export namespace jobs_v2 { v2: Resource$V2; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.companies = new Resource$Companies(this.context); this.jobs = new Resource$Jobs(this.context); @@ -128,10 +126,7 @@ export namespace jobs_v2 { */ export interface Schema$BatchDeleteJobsRequest { /** - * Required. The filter string specifies the jobs to be deleted. Supported - * operator: =, AND The fields eligible for filtering are: * `companyName` - * (Required) * `requisitionId` (Required) Sample Query: companyName = - * "companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "companies/123" AND requisitionId = "req-1" */ filter?: string; } @@ -144,8 +139,7 @@ export namespace jobs_v2 { */ count?: number; /** - * Bucket range on which histogram was performed for the numeric field, that - * is, the count represents number of jobs in this range. + * Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range. */ range?: Schema$BucketRange; } @@ -171,10 +165,7 @@ export namespace jobs_v2 { */ jobLocation?: Schema$JobLocation; /** - * The number of seconds required to travel to the job location from the - * query location. A duration of 0 seconds indicates that the job is not - * reachable within the requested duration, but was returned as part of an - * expanded query. + * The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. */ travelDuration?: string; } @@ -183,54 +174,40 @@ export namespace jobs_v2 { */ export interface Schema$CommutePreference { /** - * Optional. If `true`, jobs without street level addresses may also be - * returned. For city level addresses, the city center is used. For state - * and coarser level addresses, text matching is used. If this field is set - * to `false` or is not specified, only jobs that include street level - * addresses will be returned by commute search. + * Optional. If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or is not specified, only jobs that include street level addresses will be returned by commute search. */ allowNonStreetLevelAddress?: boolean; /** - * Optional. The departure hour to use to calculate traffic impact. Accepts - * an integer between 0 and 23, representing the hour in the time zone of - * the start_location. Must not be present if road_traffic is specified. + * Optional. The departure hour to use to calculate traffic impact. Accepts an integer between 0 and 23, representing the hour in the time zone of the start_location. Must not be present if road_traffic is specified. */ departureHourLocal?: number; /** - * Required. The method of transportation for which to calculate the - * commute time. + * Required. The method of transportation for which to calculate the commute time. */ method?: string; /** - * Optional. Specifies the traffic density to use when calculating commute - * time. Must not be present if departure_hour_local is specified. + * Optional. Specifies the traffic density to use when calculating commute time. Must not be present if departure_hour_local is specified. */ roadTraffic?: string; /** - * Required. The latitude and longitude of the location from which to - * calculate the commute time. + * Required. The latitude and longitude of the location from which to calculate the commute time. */ startLocation?: Schema$LatLng; /** - * Required. The maximum travel time in seconds. The maximum allowed value - * is `3600s` (one hour). Format is `123s`. + * Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. */ travelTime?: string; } /** - * A Company resource represents a company in the service. A company is the - * entity that owns job listings, that is, the hiring entity responsible for - * employing applicants for the job position. + * A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position. */ export interface Schema$Company { /** - * Optional. The URL to employer's career site or careers page on the - * employer's web site. + * Optional. The URL to employer's career site or careers page on the employer's web site. */ careerPageLink?: string; /** - * Optional. Identifiers external to the application that help to further - * identify the employer. + * Optional. Identifiers external to the application that help to further identify the employer. */ companyInfoSources?: Schema$CompanyInfoSource[]; /** @@ -238,137 +215,89 @@ export namespace jobs_v2 { */ companySize?: string; /** - * Deprecated. Do not use this field. Optional. This field is no longer - * used. Any value set to it is ignored. + * Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored. */ disableLocationOptimization?: boolean; /** - * Required. The name of the employer to be displayed with the job, for - * example, "Google, LLC.". + * Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". */ displayName?: string; /** - * Optional. The unique company identifier provided by the client to - * identify an employer for billing purposes. Recommended practice is to use - * the distributor_company_id. Defaults to same value as - * distributor_company_id when a value is not provided. + * Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided. */ distributorBillingCompanyId?: string; /** - * Required. A client's company identifier, used to uniquely identify - * the company. If an employer has a subsidiary or sub-brand, such as - * "Alphabet" and "Google", which the client wishes to - * use as the company displayed on the job. Best practice is to create a - * distinct company identifier for each distinct brand displayed. The - * maximum number of allowed characters is 255. + * Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255. */ distributorCompanyId?: string; /** - * Optional. Equal Employment Opportunity legal disclaimer text to be - * associated with all jobs, and typically to be displayed in all roles. The - * maximum number of allowed characters is 500. + * Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. */ eeoText?: string; /** - * Optional. Set to true if it is the hiring agency that post jobs for - * other employers. Defaults to false if not provided. + * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ hiringAgency?: boolean; /** - * Optional. The street address of the company's main headquarters, - * which may be different from the job location. The service attempts to - * geolocate the provided address, and populates a more specific location - * wherever possible in structured_company_hq_location. + * Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in structured_company_hq_location. */ hqLocation?: string; /** - * Optional. A URL that hosts the employer's company logo. If provided, - * the logo image should be squared at 80x80 pixels. The url must be a - * Google Photos or Google Album url. Only images in these Google - * sub-domains are accepted. + * Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted. */ imageUrl?: string; /** - * Optional. A list of keys of filterable Job.custom_attributes, whose - * corresponding `string_values` are used in keyword search. Jobs with - * `string_values` under these specified field keys are returned if any of - * the values matches the search keyword. Custom field values with - * parenthesis, brackets and special symbols might not be properly - * searchable, and those keyword queries need to be surrounded by quotes. + * Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. */ keywordSearchableCustomAttributes?: string[]; /** - * Deprecated. Use keyword_searchable_custom_attributes instead. Optional. - * A list of filterable custom fields that should be used in keyword search. - * The jobs of this company are returned if any of these custom fields - * matches the search keyword. Custom field values with parenthesis, - * brackets and special symbols might not be properly searchable, and those - * keyword queries need to be surrounded by quotes. + * Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. */ keywordSearchableCustomFields?: number[]; /** - * Required during company update. The resource name for a company. This is - * generated by the service when a company is created, for example, - * "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ name?: string; /** - * Output only. A structured headquarters location of the company, resolved - * from hq_location if possible. + * Output only. A structured headquarters location of the company, resolved from hq_location if possible. */ structuredCompanyHqLocation?: Schema$JobLocation; /** - * Output only. Indicates whether a company is flagged to be suspended from - * public availability by the service when job content appears suspicious, - * abusive, or spammy. + * Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. */ suspended?: boolean; /** - * Deprecated. Use display_name instead. Required. The name of the - * employer to be displayed with the job, for example, "Google, - * LLC.". + * Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". */ title?: string; /** - * Optional. The URL representing the company's primary web site or - * home page, such as, "www.google.com". + * Optional. The URL representing the company's primary web site or home page, such as, "www.google.com". */ website?: string; } /** - * A resource that represents an external Google identifier for a company, - * for example, a Google+ business page or a Google Maps business page. For - * unsupported types, use `unknown_type_id`. + * A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`. */ export interface Schema$CompanyInfoSource { /** - * Optional. The Google's Knowledge Graph value for the employer's - * company. + * Optional. The Google's Knowledge Graph value for the employer's company. */ freebaseMid?: string; /** - * Optional. The numeric identifier for the employer's Google+ business - * page. + * Optional. The numeric identifier for the employer's Google+ business page. */ gplusId?: string; /** - * Optional. The numeric identifier for the employer's headquarters on - * Google Maps, namely, the Google Maps CID (cell id). + * Optional. The numeric identifier for the employer's headquarters on Google Maps, namely, the Google Maps CID (cell id). */ mapsCid?: string; /** - * Optional. A Google identifier that does not match any of the other - * types. + * Optional. A Google identifier that does not match any of the other types. */ unknownTypeId?: string; } /** - * A compensation entry that represents one component of compensation, such as - * base pay, bonus, or other compensation type. Annualization: One - * compensation entry can be annualized if - it contains valid amount or - * range. - and its expected_units_per_year is set or can be derived. Its - * annualized range is determined as (amount or range) times - * expected_units_per_year. + * A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$CompensationEntry { /** @@ -376,15 +305,11 @@ export namespace jobs_v2 { */ amount?: Schema$Money; /** - * Optional. Compensation description. For example, could indicate equity - * terms or provide additional context to an estimated bonus. + * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ description?: string; /** - * Optional. Expected number of units paid each year. If not specified, - * when Job.employment_types is FULLTIME, a default value is inferred based - * on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - - * MONTHLY: 12 - ANNUAL: 1 + * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ expectedUnitsPerYear?: number; /** @@ -396,8 +321,7 @@ export namespace jobs_v2 { */ type?: string; /** - * Optional. Frequency of the specified amount. Default is - * CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. */ unit?: string; } @@ -406,8 +330,7 @@ export namespace jobs_v2 { */ export interface Schema$CompensationFilter { /** - * Optional. Whether to include jobs whose compensation range is - * unspecified. + * Optional. Whether to include jobs whose compensation range is unspecified. */ includeJobsWithUnspecifiedCompensationRange?: boolean; /** @@ -419,8 +342,7 @@ export namespace jobs_v2 { */ type?: string; /** - * Required. Specify desired `base compensation entry's` - * CompensationInfo.CompensationUnit. + * Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit. */ units?: string[]; } @@ -429,14 +351,11 @@ export namespace jobs_v2 { */ export interface Schema$CompensationHistogramRequest { /** - * Required. Numeric histogram options, like buckets, whether include min - * or max value. + * Required. Numeric histogram options, like buckets, whether include min or max value. */ bucketingOption?: Schema$NumericBucketingOption; /** - * Required. Type of the request, representing which field the - * histogramming should be performed over. A single request can only specify - * one histogram of each `CompensationHistogramRequestType`. + * Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`. */ type?: string; } @@ -458,41 +377,27 @@ export namespace jobs_v2 { */ export interface Schema$CompensationInfo { /** - * Deprecated. Use entries instead. Optional. The amount of compensation - * or pay for the job. As an alternative, compensation_amount_min and - * compensation_amount_max may be used to define a range of compensation. + * Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation. */ amount?: Schema$Money; /** - * Output only. Annualized base compensation range. Computed as base - * compensation entry's CompensationEntry.compensation times - * CompensationEntry.expected_units_per_year. See CompensationEntry for - * explanation on compensation annualization. + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedBaseCompensationRange?: Schema$CompensationRange; /** - * Output only. Annualized total compensation range. Computed as all - * compensation entries' CompensationEntry.compensation times - * CompensationEntry.expected_units_per_year. See CompensationEntry for - * explanation on compensation annualization. + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedTotalCompensationRange?: Schema$CompensationRange; /** - * Optional. Job compensation information. At most one entry can be of - * type CompensationInfo.CompensationType.BASE, which is referred as ** base - * compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$CompensationEntry[]; /** - * Deprecated. Use entries instead. Optional. An upper bound on a range - * for compensation or pay for the job. The currency type is specified in - * compensation_amount. + * Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. */ max?: Schema$Money; /** - * Deprecated. Use entries instead. Optional. A lower bound on a range for - * compensation or pay for the job. The currency type is specified in - * compensation_amount. + * Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. */ min?: Schema$Money; /** @@ -505,15 +410,11 @@ export namespace jobs_v2 { */ export interface Schema$CompensationRange { /** - * Optional. The maximum amount of compensation. If left empty, the value - * is set to a maximal compensation value and the currency code is set to - * match the currency code of min_compensation. + * Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation. */ max?: Schema$Money; /** - * Optional. The minimum amount of compensation. If left empty, the value - * is set to zero and the currency code is set to match the currency code of - * max_compensation. + * Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation. */ min?: Schema$Money; } @@ -526,8 +427,7 @@ export namespace jobs_v2 { */ completionResults?: Schema$CompletionResult[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; } @@ -553,9 +453,7 @@ export namespace jobs_v2 { */ export interface Schema$CreateJobRequest { /** - * Deprecated. Please use processing_options. This flag is ignored if - * processing_options is set. Optional. If set to `true`, the service does - * not attempt to resolve a more precise address for the job. + * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean; /** @@ -572,50 +470,32 @@ export namespace jobs_v2 { */ export interface Schema$CustomAttribute { /** - * Optional. If the `filterable` flag is true, custom field values are - * searchable. If false, values are not searchable. Default is false. + * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ filterable?: boolean; /** - * Optional but at least one of string_values or long_value must be - * specified. This field is used to perform number range search. (`EQ`, - * `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a - * value between Long.MIN and Long.MAX is allowed. + * Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed. */ longValue?: string; /** - * Optional but at least one of string_values or long_value must be - * specified. This field is used to perform a string match - * (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For - * filterable `string_values`, a maximum total number of 200 values is - * allowed, with each `string_value` has a byte size of no more than 255B. - * For unfilterable `string_values`, the maximum total byte size of - * unfilterable `string_values` is 50KB. Empty strings are not allowed. + * Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed. */ stringValues?: Schema$StringValues; } /** - * Custom attributes histogram request. An error will be thrown if neither - * string_value_histogram or long_value_histogram_bucketing_option has been - * defined. + * Custom attributes histogram request. An error will be thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined. */ export interface Schema$CustomAttributeHistogramRequest { /** - * Required. Specifies the custom field key to perform a histogram on. If - * specified without `long_value_histogram_bucketing_option`, histogram on - * string values of the given `key` is triggered, otherwise histogram is - * performed on long values. + * Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values. */ key?: string; /** - * Optional. Specifies buckets used to perform a range histogram on - * Job's filterable long custom field values, or min/max value - * requirements. + * Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements. */ longValueHistogramBucketingOption?: Schema$NumericBucketingOption; /** - * Optional. If set to true, the response will include the histogram value - * for each key as a string. + * Optional. If set to true, the response will include the histogram value for each key as a string. */ stringValueHistogram?: boolean; } @@ -628,19 +508,16 @@ export namespace jobs_v2 { */ key?: string; /** - * Stores bucketed histogram counting result or min/max values for custom - * attribute long values associated with `key`. + * Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`. */ longValueHistogramResult?: Schema$NumericBucketingResult; /** - * Stores a map from the values of string custom field associated with `key` - * to the number of jobs with that value in this histogram result. + * Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result. */ stringValueHistogramResult?: {[key: string]: number}; } /** - * Resource that represents the custom data not captured by the standard - * fields. + * Resource that represents the custom data not captured by the standard fields. */ export interface Schema$CustomField { /** @@ -662,43 +539,28 @@ export namespace jobs_v2 { type?: string; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } /** - * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by - * filter request. The job typically becomes unsearchable within 10 seconds, - * but it may take up to 5 minutes. + * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes. */ export interface Schema$DeleteJobsByFilterRequest { /** - * Optional. If set to true, this call waits for all processing steps to - * complete before the job is cleaned up. Otherwise, the call returns while - * some steps are still taking place asynchronously, hence faster. + * Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. */ disableFastProcess?: boolean; /** @@ -707,9 +569,7 @@ export namespace jobs_v2 { filter?: Schema$Filter; } /** - * Input only. Device information collected from the job seeker, candidate, - * or other entity conducting the job search. Providing this information - * improves the quality of the search results across devices. + * Input only. Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices. */ export interface Schema$DeviceInfo { /** @@ -717,22 +577,16 @@ export namespace jobs_v2 { */ deviceType?: string; /** - * Optional. A device-specific ID. The ID must be a unique identifier that - * distinguishes the device from other devices. + * Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. */ id?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Deprecated. Always use CompensationFilter. Input only. Filter on job - * compensation type and amount. + * Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount. */ export interface Schema$ExtendedCompensationFilter { /** @@ -740,19 +594,15 @@ export namespace jobs_v2 { */ compensationRange?: Schema$ExtendedCompensationInfoCompensationRange; /** - * Required. Specify desired `base compensation entry's` - * ExtendedCompensationInfo.CompensationUnit. + * Required. Specify desired `base compensation entry's` ExtendedCompensationInfo.CompensationUnit. */ compensationUnits?: string[]; /** - * Optional. Specify currency in 3-letter [ISO - * 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If - * unspecified, jobs are returned regardless of currency. + * Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If unspecified, jobs are returned regardless of currency. */ currency?: string; /** - * Optional. Whether to include jobs whose compensation range is - * unspecified. + * Optional. Whether to include jobs whose compensation range is unspecified. */ includeJobWithUnspecifiedCompensationRange?: boolean; /** @@ -769,10 +619,7 @@ export namespace jobs_v2 { */ annualizedBaseCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange; /** - * Output only. Indicates annualized base compensation range cannot be - * derived, due to the job's base compensation entry cannot be - * annualized. See CompensationEntry for explanation on annualization and - * base compensation entry. + * Output only. Indicates annualized base compensation range cannot be derived, due to the job's base compensation entry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry. */ annualizedBaseCompensationUnspecified?: boolean; /** @@ -780,31 +627,20 @@ export namespace jobs_v2 { */ annualizedTotalCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange; /** - * Output only. Indicates annualized total compensation range cannot be - * derived, due to the job's all CompensationEntry cannot be annualized. - * See CompensationEntry for explanation on annualization and base - * compensation entry. + * Output only. Indicates annualized total compensation range cannot be derived, due to the job's all CompensationEntry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry. */ annualizedTotalCompensationUnspecified?: boolean; /** - * Optional. A 3-letter [ISO - * 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. + * Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. */ currency?: string; /** - * Optional. Job compensation information. At most one entry can be of - * type ExtendedCompensationInfo.CompensationType.BASE, which is referred as - * ** base compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$ExtendedCompensationInfoCompensationEntry[]; } /** - * Deprecated. See CompensationInfo. A compensation entry that represents one - * component of compensation, such as base pay, bonus, or other compensation - * type. Annualization: One compensation entry can be annualized if - it - * contains valid amount or range. - and its expected_units_per_year is set or - * can be derived. Its annualized range is determined as (amount or range) - * times expected_units_per_year. + * Deprecated. See CompensationInfo. A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$ExtendedCompensationInfoCompensationEntry { /** @@ -816,10 +652,7 @@ export namespace jobs_v2 { */ description?: string; /** - * Optional. Expected number of units paid each year. If not specified, - * when Job.employment_types is FULLTIME, a default value is inferred based - * on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - - * MONTHLY: 12 - ANNUAL: 1 + * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ expectedUnitsPerYear?: Schema$ExtendedCompensationInfoDecimal; /** @@ -831,8 +664,7 @@ export namespace jobs_v2 { */ type?: string; /** - * Optional. Frequency of the specified amount. Default is - * CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. */ unit?: string; /** @@ -858,11 +690,7 @@ export namespace jobs_v2 { */ export interface Schema$ExtendedCompensationInfoDecimal { /** - * Micro (10^-6) units. The value must be between -999,999 and +999,999 - * inclusive. If `units` is positive, `micros` must be positive or zero. If - * `units` is zero, `micros` can be positive, zero, or negative. If `units` - * is negative, `micros` must be negative or zero. For example -1.75 is - * represented as `units`=-1 and `micros`=-750,000. + * Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. If `units` is positive, `micros` must be positive or zero. If `units` is zero, `micros` can be positive, zero, or negative. If `units` is negative, `micros` must be negative or zero. For example -1.75 is represented as `units`=-1 and `micros`=-750,000. */ micros?: number; /** @@ -871,66 +699,45 @@ export namespace jobs_v2 { units?: string; } /** - * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for - * jobs to be deleted. + * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted. */ export interface Schema$Filter { /** - * Required. The requisition ID (or posting ID) assigned by the client to - * identify a job. This is intended for client identification and tracking - * of listings. name takes precedence over this field The maximum number of - * allowed characters is 225. + * Required. The requisition ID (or posting ID) assigned by the client to identify a job. This is intended for client identification and tracking of listings. name takes precedence over this field The maximum number of allowed characters is 225. */ requisitionId?: string; } /** - * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single - * call with both search and histogram. Input only. A request for the - * `GetHistogram` method. + * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method. */ export interface Schema$GetHistogramRequest { /** - * Optional. Controls whether to broaden the search to avoid too few - * results for a given query in instances where a search has sparse results. - * Results from a broadened query is a superset of the results from the - * original query. Defaults to false. + * Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false. */ allowBroadening?: boolean; /** - * Deprecated. Use query instead. Optional. Restrictions on the scope of - * the histogram. + * Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram. */ filters?: Schema$JobFilters; /** - * Optional. Query used to search against jobs, such as keyword, location - * filters, etc. + * Optional. Query used to search against jobs, such as keyword, location filters, etc. */ query?: Schema$JobQuery; /** - * Meta information, such as `user_id`, collected from the job searcher or - * other entity conducting a job search, is used to improve the - * service's search quality. Users determine identifier values, which - * must be unique and consist. + * Meta information, such as `user_id`, collected from the job searcher or other entity conducting a job search, is used to improve the service's search quality. Users determine identifier values, which must be unique and consist. */ requestMetadata?: Schema$RequestMetadata; /** - * Required. A list of facets that specify the histogram data to be - * calculated against and returned. Histogram response times can be slow, - * and counts can be approximations. This call may be temporarily or - * permanently removed prior to the production release of Cloud Talent - * Solution. + * Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution. */ searchTypes?: string[]; } /** - * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single - * call with both search and histogram. Output only. The response of the - * GetHistogram method. + * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method. */ export interface Schema$GetHistogramResponse { /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -943,27 +750,20 @@ export namespace jobs_v2 { */ export interface Schema$HistogramFacets { /** - * Optional. Specifies compensation field-based histogram requests. - * Duplicate values of CompensationHistogramRequest.type are not allowed. + * Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed. */ compensationHistogramFacets?: Schema$CompensationHistogramRequest[]; /** - * Optional. Specifies the custom attributes histogram requests. Duplicate - * values of CustomAttributeHistogramRequest.key are not allowed. + * Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed. */ customAttributeHistogramFacets?: Schema$CustomAttributeHistogramRequest[]; /** - * Optional. Specifies the simple type of histogram facets, for example, - * `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to - * GetHistogramRequest. + * Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to GetHistogramRequest. */ simpleHistogramFacets?: string[]; } /** - * Output only. Result of a histogram call. The response contains the - * histogram map for the search type specified by HistogramResult.field. The - * response is a map of each filter value to the corresponding count of jobs - * for that filter. + * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. */ export interface Schema$HistogramResult { /** @@ -971,62 +771,41 @@ export namespace jobs_v2 { */ searchType?: string; /** - * A map from the values of field to the number of jobs with that value in - * this search result. Key: search type (filter names, such as the - * companyName). Values: the count of jobs that match the filter for this - * search. + * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ values?: {[key: string]: number}; } /** - * Output only. Histogram results that matches HistogramFacets specified in - * SearchJobsRequest. + * Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest. */ export interface Schema$HistogramResults { /** - * Specifies compensation field-based histogram results that matches - * HistogramFacets.compensation_histogram_requests. + * Specifies compensation field-based histogram results that matches HistogramFacets.compensation_histogram_requests. */ compensationHistogramResults?: Schema$CompensationHistogramResult[]; /** - * Specifies histogram results for custom attributes that matches - * HistogramFacets.custom_attribute_histogram_facets. + * Specifies histogram results for custom attributes that matches HistogramFacets.custom_attribute_histogram_facets. */ customAttributeHistogramResults?: Schema$CustomAttributeHistogramResult[]; /** - * Specifies histogram results that matches - * HistogramFacets.simple_histogram_facets. + * Specifies histogram results that matches HistogramFacets.simple_histogram_facets. */ simpleHistogramResults?: Schema$HistogramResult[]; } /** - * A Job resource represents a job posting (also referred to as a "job - * listing" or "job requisition"). A job belongs to a Company, - * which is the hiring entity responsible for the job. + * A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. */ export interface Schema$Job { /** - * Optional but at least one of application_urls, application_email_list or - * application_instruction must be specified. Use this field to specify - * email address(es) to which resumes or applications can be sent. The - * maximum number of allowed characters is 255. + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255. */ applicationEmailList?: string[]; /** - * Optional but at least one of application_urls, application_email_list or - * application_instruction must be specified. Use this field to provide - * instructions, such as "Mail your application to ...", that a - * candidate can follow to apply for the job. This field accepts and - * sanitizes HTML input, and also accepts bold, italic, ordered list, and - * unordered list markup tags. The maximum number of allowed characters is - * 3,000. + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. */ applicationInstruction?: string; /** - * Optional but at least one of application_urls, application_email_list or - * application_instruction must be specified. Use this URL field to direct - * an applicant to a website, for example to link to an online application - * form. The maximum number of allowed characters is 2,000. + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000. */ applicationUrls?: string[]; /** @@ -1038,15 +817,11 @@ export namespace jobs_v2 { */ companyDisplayName?: string; /** - * Optional but one of company_name or distributor_company_id must be - * provided. The resource name of the company listing the job, such as - * /companies/foo. This field takes precedence over the distributor-assigned - * company identifier, distributor_company_id. + * Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id. */ companyName?: string; /** - * Deprecated. Use company_display_name instead. Output only. The name of - * the company listing the job. + * Deprecated. Use company_display_name instead. Output only. The name of the company listing the job. */ companyTitle?: string; /** @@ -1058,140 +833,51 @@ export namespace jobs_v2 { */ createTime?: string; /** - * Optional. A map of fields to hold both filterable and non-filterable - * custom job attributes that are not covered by the provided structured - * fields. This field is a more general combination of the deprecated - * id-based filterable_custom_fields and string-based - * non_filterable_custom_fields. The keys of the map are strings up to 64 - * bytes and must match the pattern: a-zA-Z*. At most 100 filterable and at - * most 100 unfilterable keys are supported. For filterable `string_values`, - * across all keys at most 200 values are allowed, with each string no more - * than 255 characters. For unfilterable `string_values`, the maximum total - * size of `string_values` across all keys is 50KB. + * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ customAttributes?: {[key: string]: Schema$CustomAttribute}; /** - * Optional. The department or functional area within the company with the - * open position. The maximum number of allowed characters is 255. + * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ department?: string; /** - * Required. The description of the job, which typically includes a - * multi-paragraph description of the company and related information. - * Separate fields are provided on the job object for responsibilities, - * qualifications, and other job characteristics. Use of these separate job - * fields is recommended. This field accepts and sanitizes HTML input, and - * also accepts bold, italic, ordered list, and unordered list markup tags. - * The maximum number of allowed characters is 100,000. + * Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. */ description?: string; /** - * Optional but one of company_name or distributor_company_id must be - * provided. A unique company identifier used by job distributors to - * identify an employer's company entity. company_name takes precedence - * over this field, and is the recommended field to use to identify - * companies. The maximum number of allowed characters is 255. + * Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255. */ distributorCompanyId?: string; /** - * Optional. The desired education level for the job, such as - * "Bachelors", "Masters", "Doctorate". + * Optional. The desired education level for the job, such as "Bachelors", "Masters", "Doctorate". */ educationLevels?: string[]; /** - * Optional. The employment type(s) of a job, for example, full time or - * part time. + * Optional. The employment type(s) of a job, for example, full time or part time. */ employmentTypes?: string[]; /** - * Optional. The end date of the job in UTC time zone. Typically this field - * is used for contracting engagements. Dates prior to 1970/1/1 and invalid - * date formats are ignored. + * Optional. The end date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored. */ endDate?: Schema$Date; /** - * Optional but strongly recommended for the best service experience. The - * expiration timestamp of the job. After this timestamp, the job is marked - * as expired, and it no longer appears in search results. The expired job - * can't be deleted or listed by the DeleteJob and ListJobs APIs, but it - * can be retrieved with the GetJob API or updated with the UpdateJob API. - * An expired job can be updated and opened again by using a future - * expiration timestamp. Updating an expired job fails if there is another - * existing open job with same requisition_id, company_name and - * language_code. The expired jobs are retained in our system for 90 days. - * However, the overall expired job count cannot exceed 3 times the maximum - * of open jobs count over the past week, otherwise jobs with earlier expire - * time are cleaned first. Expired jobs are no longer accessible after they - * are cleaned out. The format of this field is RFC 3339 date strings. - * Example: 2000-01-01T00:00:00.999999999Z See - * [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). - * A valid date range is between 1970-01-01T00:00:00.0Z and - * 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire - * time not provided. If this value is not provided at the time of job - * creation or is invalid, the job posting expires after 30 days from the - * job's creation time. For example, if the job was created on - * 2017/01/01 13:00AM UTC with an unspecified expiration date, the job - * expires after 2017/01/31 13:00AM UTC. If this value is not provided but - * expiry_date is, expiry_date is used. If this value is not provided on - * job update, it depends on the field masks set by - * UpdateJobRequest.update_job_fields. If the field masks include - * expiry_time, or the masks are empty meaning that every field is updated, - * the job posting expires after 30 days from the job's last update - * time. Otherwise the expiration date isn't updated. + * Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ expireTime?: string; /** - * Deprecated. Use expire_time instead. Optional but strongly recommended - * to be provided for the best service experience. The expiration date of - * the job in UTC time. After 12 am on this date, the job is marked as - * expired, and it no longer appears in search results. The expired job - * can't be deleted or listed by the DeleteJob and ListJobs APIs, but it - * can be retrieved with the GetJob API or updated with the UpdateJob API. - * An expired job can be updated and opened again by using a future - * expiration date. It can also remain expired. Updating an expired job to - * be open fails if there is another existing open job with same - * requisition_id, company_name and language_code. The expired jobs are - * retained in our system for 90 days. However, the overall expired job - * count cannot exceed 3 times the maximum of open jobs count over the past - * week, otherwise jobs with earlier expire time are removed first. Expired - * jobs are no longer accessible after they are cleaned out. A valid date - * range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and - * treated as expiry date not provided. If this value is not provided on - * job creation or is invalid, the job posting expires after 30 days from - * the job's creation time. For example, if the job was created on - * 2017/01/01 13:00AM UTC with an unspecified expiration date, the job - * expires after 2017/01/31 13:00AM UTC. If this value is not provided on - * job update, it depends on the field masks set by - * UpdateJobRequest.update_job_fields. If the field masks include - * expiry_date, or the masks are empty meaning that every field is updated, - * the job expires after 30 days from the job's last update time. - * Otherwise the expiration date isn't updated. + * Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ expiryDate?: Schema$Date; /** - * Deprecated. Always use compensation_info. Optional. Job compensation - * information. This field replaces compensation_info. Only - * CompensationInfo.entries or extended_compensation_info can be set, - * otherwise an exception is thrown. + * Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown. */ extendedCompensationInfo?: Schema$ExtendedCompensationInfo; /** - * Deprecated. Use custom_attributes instead. Optional. A map of fields to - * hold filterable custom job attributes not captured by the standard fields - * such as job_title, company_name, or level. These custom fields store - * arbitrary string values, and can be used for purposes not covered by the - * structured fields. For the best search experience, use of the structured - * rather than custom fields is recommended. Data stored in these custom - * fields fields are indexed and searched against by keyword searches (see - * SearchJobsRequest.custom_field_filters][]). The map key must be a number - * between 1-20. If an invalid key is provided on job create or update, an - * error is returned. + * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned. */ filterableCustomFields?: {[key: string]: Schema$CustomField}; /** - * Optional. A description of bonus, commission, and other compensation - * incentives associated with the job not including salary or pay. The - * maximum number of allowed characters is 10,000. + * Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. */ incentives?: string; /** @@ -1199,69 +885,35 @@ export namespace jobs_v2 { */ jobLocations?: Schema$JobLocation[]; /** - * Required. The title of the job, such as "Software Engineer" - * The maximum number of allowed characters is 500. + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ jobTitle?: string; /** - * Optional. The language of the posting. This field is distinct from any - * requirements for fluency that are associated with the job. Language - * codes must be in BCP-47 format, such as "en-US" or - * "sr-Latn". For more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47){: - * class="external" target="_blank" }. If this field is - * unspecified and Job.description is present, detected language code based - * on Job.description is assigned, otherwise defaults to 'en_US'. + * Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ languageCode?: string; /** - * Optional. The experience level associated with the job, such as - * "Entry Level". + * Optional. The experience level associated with the job, such as "Entry Level". */ level?: string; /** - * Optional but strongly recommended for the best service experience. - * Location(s) where the emploeyer is looking to hire for this job posting. - * Specifying the full street address(es) of the hiring location enables - * better API results, especially job searches by commute time. At most 50 - * locations are allowed for best search performance. If a job has more - * locations, it is suggested to split it into multiple jobs with unique - * requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', - * 'ReqA-2', etc.) as multiple jobs with the same requisition_id, - * company_name and language_code are not allowed. If the original - * requisition_id must be preserved, a custom field should be used for - * storage. It is also suggested to group the locations that close to each - * other in the same job for better search experience. The maximum number - * of allowed characters is 500. + * Optional but strongly recommended for the best service experience. Location(s) where the emploeyer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. */ locations?: string[]; /** - * Required during job update. Resource name assigned to a job by the API, - * for example, "/jobs/foo". Use of this field in job queries and - * API calls is preferred over the use of requisition_id since this value is - * unique. + * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; /** - * Optional. A promotion value of the job, as determined by the client. The - * value determines the sort order of the jobs returned when searching for - * jobs using the featured jobs search call, with higher promotional values - * being returned first and ties being resolved by relevance sort. Only the - * jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. - * Default value is 0, and negative values are treated as 0. + * Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. */ promotionValue?: number; /** - * Optional. The date this job was most recently published in UTC format. - * The default value is the time the request arrives at the server. + * Optional. The date this job was most recently published in UTC format. The default value is the time the request arrives at the server. */ publishDate?: Schema$Date; /** - * Optional. A description of the qualifications required to perform the - * job. The use of this field is recommended as an alternative to using the - * more general description field. This field accepts and sanitizes HTML - * input, and also accepts bold, italic, ordered list, and unordered list - * markup tags. The maximum number of allowed characters is 10,000. + * Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ qualifications?: string; /** @@ -1269,43 +921,23 @@ export namespace jobs_v2 { */ referenceUrl?: string; /** - * Optional. The job Region (for example, state, country) throughout which - * the job is available. If this field is set, a LocationFilter in a search - * query within the job region finds this job if an exact location match is - * not specified. If this field is set, setting job locations to the same - * location level as this field is strongly recommended. + * Optional. The job Region (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job if an exact location match is not specified. If this field is set, setting job locations to the same location level as this field is strongly recommended. */ region?: string; /** - * Required. The requisition ID, also referred to as the posting ID, - * assigned by the client to identify a job. This field is intended to be - * used by clients for client identification and tracking of listings. A job - * is not allowed to be created if there is another job with the same - * requisition_id, company_name and language_code. The maximum number of - * allowed characters is 255. + * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255. */ requisitionId?: string; /** - * Optional. A description of job responsibilities. The use of this field - * is recommended as an alternative to using the more general description - * field. This field accepts and sanitizes HTML input, and also accepts - * bold, italic, ordered list, and unordered list markup tags. The maximum - * number of allowed characters is 10,000. + * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ responsibilities?: string; /** - * Optional. The start date of the job in UTC time zone. Typically this - * field is used for contracting engagements. Dates prior to 1970/1/1 and - * invalid date formats are ignored. + * Optional. The start date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored. */ startDate?: Schema$Date; /** - * Deprecated. Use custom_attributes instead. Optional. A map of fields to - * hold non-filterable custom job attributes, similar to - * filterable_custom_fields. These fields are distinct in that the data in - * these fields are not indexed. Therefore, the client cannot search against - * them, nor can the client use them to list jobs. The key of the map can - * be any valid string. + * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string. */ unindexedCustomFields?: {[key: string]: Schema$CustomField}; /** @@ -1313,146 +945,77 @@ export namespace jobs_v2 { */ updateTime?: string; /** - * Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE - * if not specified. Currently only JobVisibility.PRIVATE is supported. + * Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE if not specified. Currently only JobVisibility.PRIVATE is supported. */ visibility?: string; } /** - * Input only. Deprecated. Use JobQuery instead. The filters required to - * perform a search query or histogram. + * Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram. */ export interface Schema$JobFilters { /** - * Optional. The category filter specifies the categories of jobs to search - * against. See Category for more information. If a value is not specified, - * jobs from any category are searched against. If multiple values are - * specified, jobs from any of the specified categories are searched - * against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ categories?: string[]; /** - * Optional. Allows filtering jobs by commute time with different travel - * methods (e.g. driving or public transit). Note: this only works with - * COMMUTE MODE. When specified, [JobFilters.location_filters] will be - * ignored. Currently we do not support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time. */ commuteFilter?: Schema$CommutePreference; /** - * Optional. The company names filter specifies the company entities to - * search against. If a value is not specified, jobs are searched for - * against all companies. If multiple values are specified, jobs are - * searched against the specified companies. At most 20 company filters are - * allowed. + * Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed. */ companyNames?: string[]; /** - * Optional. This filter specifies the exact company titles of jobs to - * search against. If a value is not specified, jobs within the search - * results can be associated with any company. If multiple values are - * specified, jobs within the search results may be associated with any of - * the specified companies. At most 20 company title filters are allowed. + * Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company title filters are allowed. */ companyTitles?: string[]; /** - * Optional. This search filter is applied only to Job.compensation_info. - * For example, if the filter is specified as "Hourly job with per-hour - * compensation > $15", only jobs that meet this criteria are - * searched. If a filter is not defined, all open jobs are searched. + * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet this criteria are searched. If a filter is not defined, all open jobs are searched. */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the - * Job.custom_attributes that are marked as `filterable`. The syntax for - * this expression is a subset of Google SQL syntax. Supported operators - * are: =, !=, <, <=, >, >= where the left of the operator is a - * custom field key and the right of the operator is a number or string - * (surrounded by quotes) value. Supported functions are - * LOWER(<field_name>) to perform case insensitive match and - * EMPTY(<field_name>) to filter on the existence of a key. Boolean - * expressions (AND/OR/NOT) are supported up to 3 levels of nesting (For - * example, "((A AND B AND C) OR NOT D) AND E"), and there can be - * a maximum of 100 comparisons/functions in the expression. The expression - * must be < 3000 bytes in length. Sample Query: (key1 = - * "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND - * key2 > 100 + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 */ customAttributeFilter?: string; /** - * Deprecated. Use custom_attribute_filter instead. Optional. This filter - * specifies searching against custom field values. See - * Job.filterable_custom_fields for information. The key value specifies a - * number between 1-20 (the service supports 20 custom fields) corresponding - * to the desired custom field map value. If an invalid key is provided or - * specified together with custom_attribute_filter, an error is thrown. + * Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown. */ customFieldFilters?: {[key: string]: Schema$CustomFieldFilter}; /** - * Optional. This flag controls the spell-check feature. If false, the - * service attempts to correct a misspelled query, for example, - * "enginee" is corrected to "engineer". Defaults to - * false: a spell check is performed. + * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ disableSpellCheck?: boolean; /** - * Optional. The employment type filter specifies the employment type of - * jobs to search against, such as EmploymentType.FULL_TIME. If a value is - * not specified, jobs in the search results include any employment type. If - * multiple values are specified, jobs in the search results include any of - * the specified employment types. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ employmentTypes?: string[]; /** - * Deprecated. Always use compensation_filter. Optional. This search - * filter is applied only to Job.extended_compensation_info. For example, if - * the filter is specified as "Hourly job with per-hour compensation - * > $15", only jobs that meet these criteria are searched. If a - * filter is not defined, all open jobs are searched. + * Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched. */ extendedCompensationFilter?: Schema$ExtendedCompensationFilter; /** - * Optional. This filter specifies the locale of jobs to search against, - * for example, "en-US". If a value is not specified, the search - * results may contain jobs in any locale. Language codes should be in - * BCP-47 format, for example, "en-US" or "sr-Latn". For - * more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47). At most 10 language code - * filters are allowed. + * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[]; /** - * Optional. The location filter specifies geo-regions containing the jobs - * to search against. See LocationFilter for more information. If a - * location value is not specified, jobs are retrieved from all locations. - * If multiple values are specified, jobs are retrieved from any of the - * specified locations. If different values are specified for the - * LocationFilter.distance_in_miles parameter, the maximum provided distance - * is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value is not specified, jobs are retrieved from all locations. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** - * Optional. Jobs published within a range specified by this filter are - * searched against, for example, DateRange.PAST_MONTH. If a value is not - * specified, all open jobs are searched against regardless of the date they - * were published. + * Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value is not specified, all open jobs are searched against regardless of the date they were published. */ publishDateRange?: string; /** - * Optional. The query filter contains the keywords that match against the - * job title, description, and location fields. The maximum query size is - * 255 bytes/characters. + * Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters. */ query?: string; /** - * Deprecated. Do not use this field. This flag controls whether the job - * search should be restricted to jobs owned by the current user. Defaults - * to false where all jobs accessible to the user are searched against. + * Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against. */ tenantJobOnly?: boolean; } /** - * Output only. A resource that represents a location with full geographic - * information. + * Output only. A resource that represents a location with full geographic information. */ export interface Schema$JobLocation { /** @@ -1460,25 +1023,15 @@ export namespace jobs_v2 { */ latLng?: Schema$LatLng; /** - * The type of a location, which corresponds to the address lines field of - * PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a - * type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" - * has a type of LocationType#LOCALITY. + * The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. */ locationType?: string; /** - * Postal address of the location that includes human readable information, - * such as postal delivery and payments addresses. Given a postal address, a - * postal service can deliver items to a premises, P.O. Box, or other - * delivery location. + * Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. */ postalAddress?: Schema$PostalAddress; /** - * Radius in meters of the job location. This value is derived from the - * location bounding box in which a circle with the specified radius - * centered from LatLng coves the area associated with the job location. For - * example, currently, "Mountain View, CA, USA" has a radius of - * 7885.79 meters. + * Radius in meters of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng coves the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 7885.79 meters. */ radiusMeters?: number; } @@ -1487,16 +1040,11 @@ export namespace jobs_v2 { */ export interface Schema$JobProcessingOptions { /** - * Optional. If set to `true`, the service does not attempt to resolve a - * more precise address for the job. + * Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean; /** - * Optional. Option for job HTML content sanitization. Applied fields are: - * * description * applicationInstruction * incentives * qualifications * - * responsibilities HTML tags in these fields may be stripped if - * sanitiazation is not disabled. Defaults to - * HtmlSanitization.SIMPLE_FORMATTING_ONLY. + * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ htmlSanitization?: string; } @@ -1505,114 +1053,56 @@ export namespace jobs_v2 { */ export interface Schema$JobQuery { /** - * Optional. The category filter specifies the categories of jobs to search - * against. See Category for more information. If a value is not specified, - * jobs from any category are searched against. If multiple values are - * specified, jobs from any of the specified categories are searched - * against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ categories?: string[]; /** - * Optional. Allows filtering jobs by commute time with different travel - * methods (for example, driving or public transit). Note: This only works - * with COMMUTE MODE. When specified, [JobQuery.location_filters] is - * ignored. Currently we don't support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. */ commuteFilter?: Schema$CommutePreference; /** - * Optional. This filter specifies the exact company display name of the - * jobs to search against. If a value isn't specified, jobs within the - * search results are associated with any company. If multiple values are - * specified, jobs within the search results may be associated with any of - * the specified companies. At most 20 company display name filters are - * allowed. + * Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. */ companyDisplayNames?: string[]; /** - * Optional. This filter specifies the company entities to search against. - * If a value isn't specified, jobs are searched for against all - * companies. If multiple values are specified, jobs are searched against - * the companies specified. At most 20 company filters are allowed. + * Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. At most 20 company filters are allowed. */ companyNames?: string[]; /** - * Optional. This search filter is applied only to Job.compensation_info. - * For example, if the filter is specified as "Hourly job with per-hour - * compensation > $15", only jobs meeting these criteria are - * searched. If a filter isn't defined, all open jobs are searched. + * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the - * Job.custom_attributes marked as `filterable`. The syntax for this - * expression is a subset of Google SQL syntax. Supported operators are: =, - * !=, <, <=, >, >= where the left of the operator is a custom - * field key and the right of the operator is a number or string (surrounded - * by quotes) value. Supported functions are LOWER(<field_name>) to - * perform case insensitive match and EMPTY(<field_name>) to filter on - * the existence of a key. Boolean expressions (AND/OR/NOT) are supported - * up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) - * AND E"), a maximum of 50 comparisons/functions are allowed in the - * expression. The expression must be < 2000 characters in length. Sample - * Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT - * EMPTY(key1)) AND key2 > 100 + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 */ customAttributeFilter?: string; /** - * Optional. This flag controls the spell-check feature. If false, the - * service attempts to correct a misspelled query, for example, - * "enginee" is corrected to "engineer". Defaults to - * false: a spell check is performed. + * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ disableSpellCheck?: boolean; /** - * Optional. The employment type filter specifies the employment type of - * jobs to search against, such as EmploymentType.FULL_TIME. If a value is - * not specified, jobs in the search results include any employment type. If - * multiple values are specified, jobs in the search results include any of - * the specified employment types. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ employmentTypes?: string[]; /** - * Optional. This filter specifies the locale of jobs to search against, - * for example, "en-US". If a value isn't specified, the - * search results can contain jobs in any locale. Language codes should be - * in BCP-47 format, such as "en-US" or "sr-Latn". For - * more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47). At most 10 language code - * filters are allowed. + * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[]; /** - * Optional. The location filter specifies geo-regions containing the jobs - * to search against. See LocationFilter for more information. If a - * location value isn't specified, jobs fitting the other search - * criteria are retrieved regardless of where they're located. If - * multiple values are specified, jobs are retrieved from any of the - * specified locations. If different values are specified for the - * LocationFilter.distance_in_miles parameter, the maximum provided distance - * is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** - * Optional. Jobs published within a range specified by this filter are - * searched against, for example, DateRange.PAST_MONTH. If a value isn't - * specified, all open jobs are searched against regardless of their - * published date. + * Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value isn't specified, all open jobs are searched against regardless of their published date. */ publishDateRange?: string; /** - * Optional. The query string that matches against the job title, - * description, and location fields. The maximum query size is 255 bytes. + * Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes. */ query?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -1633,8 +1123,7 @@ export namespace jobs_v2 { */ companies?: Schema$Company[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -1643,18 +1132,15 @@ export namespace jobs_v2 { nextPageToken?: string; } /** - * Deprecated. Use ListJobsResponse instead. Output only. The List jobs - * response object. + * Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object. */ export interface Schema$ListCompanyJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is - * based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -1662,9 +1148,7 @@ export namespace jobs_v2 { */ nextPageToken?: string; /** - * The total number of open jobs. The result will be empty if - * ListCompanyJobsRequest.include_jobs_count is not enabled or if no open - * jobs are available. + * The total number of open jobs. The result will be empty if ListCompanyJobsRequest.include_jobs_count is not enabled or if no open jobs are available. */ totalSize?: string; } @@ -1673,13 +1157,11 @@ export namespace jobs_v2 { */ export interface Schema$ListJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is - * based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -1692,44 +1174,23 @@ export namespace jobs_v2 { */ export interface Schema$LocationFilter { /** - * Optional. The distance_in_miles is applied when the location being - * searched for is identified as a city or smaller. When the location being - * searched for is a state or larger, this field is ignored. + * Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. */ distanceInMiles?: number; /** - * Optional. Allows the client to return jobs without a set location, - * specifically, telecommuting jobs (telecomuting is considered by the - * service as a special location. Job.allow_telecommute indicates if a job - * permits telecommuting. If this field is true, telecommuting jobs are - * searched, and name and lat_lng are ignored. This filter can be used by - * itself to search exclusively for telecommuting jobs, or it can be - * combined with another location filter to search for a combination of job - * locations, such as "Mountain View" or "telecommuting" - * jobs. However, when used in combination with other location filters, - * telecommuting jobs can be treated as less relevant than other jobs in the - * search response. + * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.allow_telecommute indicates if a job permits telecommuting. If this field is true, telecommuting jobs are searched, and name and lat_lng are ignored. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ isTelecommute?: boolean; /** - * Optional. The latitude and longitude of the geographic center from which - * to search. This field is ignored if `location_name` is provided. + * Optional. The latitude and longitude of the geographic center from which to search. This field is ignored if `location_name` is provided. */ latLng?: Schema$LatLng; /** - * Optional. The address name, such as "Mountain View" or - * "Bay Area". + * Optional. The address name, such as "Mountain View" or "Bay Area". */ name?: string; /** - * Optional. CLDR region code of the country/region of the address. This - * will be used to address ambiguity of the user-input location, e.g. - * "Liverpool" against "Liverpool, NY, US" or - * "Liverpool, UK". Set this field if all the jobs to search - * against are from a same region, or jobs are world-wide but the job seeker - * is from a specific region. See http://cldr.unicode.org/ and - * http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - * for details. Example: "CH" for Switzerland. + * Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string; } @@ -1738,8 +1199,7 @@ export namespace jobs_v2 { */ export interface Schema$MatchingJob { /** - * Commute information which is generated based on specified - * CommutePreference. + * Commute information which is generated based on specified CommutePreference. */ commuteInfo?: Schema$CommuteInfo; /** @@ -1747,21 +1207,15 @@ export namespace jobs_v2 { */ job?: Schema$Job; /** - * A summary of the job with core information that's displayed on the - * search results listing page. + * A summary of the job with core information that's displayed on the search results listing page. */ jobSummary?: string; /** - * Contains snippets of text from the Job.job_title field most closely - * matching a search query's keywords, if available. The matching query - * keywords are enclosed in HTML bold tags. + * Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags. */ jobTitleSnippet?: string; /** - * Contains snippets of text from the Job.description and similar fields - * that most closely match a search query's keywords, if available. All - * HTML tags in the original fields are stripped when returned in this - * field, and matching query keywords are enclosed in HTML bold tags. + * Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. */ searchTextSnippet?: string; } @@ -1774,35 +1228,24 @@ export namespace jobs_v2 { */ currencyCode?: string; /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ nanos?: number; /** - * The whole units of the amount. For example if `currencyCode` is - * `"USD"`, then 1 unit is one US dollar. + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ units?: string; } /** - * Input only. Use this field to specify bucketing option for the histogram - * search response. + * Input only. Use this field to specify bucketing option for the histogram search response. */ export interface Schema$NumericBucketingOption { /** - * Required. Two adjacent values form a histogram bucket. Values should be - * in ascending order. For example, if [5, 10, 15] are provided, four - * buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 - * [buckets_bound is supported. + * Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported. */ bucketBounds?: number[]; /** - * Optional. If set to true, the histogram result includes minimum/maximum - * value of the numeric field. + * Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field. */ requiresMinMax?: boolean; } @@ -1811,83 +1254,36 @@ export namespace jobs_v2 { */ export interface Schema$NumericBucketingResult { /** - * Count within each bucket. Its size is the length of - * NumericBucketingOption.bucket_bounds plus 1. + * Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1. */ counts?: Schema$BucketizedCount[]; /** - * Stores the maximum value of the numeric field. Will be populated only if - * [NumericBucketingOption.requires_min_max] is set to true. + * Stores the maximum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ maxValue?: number; /** - * Stores the minimum value of the numeric field. Will be populated only if - * [NumericBucketingOption.requires_min_max] is set to true. + * Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ minValue?: number; } /** - * Represents a postal address, e.g. for postal delivery or payments - * addresses. Given a postal address, a postal service can deliver items to a - * premise, P.O. Box or similar. It is not intended to model geographical - * locations (roads, towns, mountains). In typical usage an address would be - * created via user input or from importing existing data, depending on the - * type of process. Advice on address input / editing: - Use an i18n-ready - * address widget such as https://github.com/googlei18n/libaddressinput) - - * Users should not be presented with UI elements for input or editing of - * fields outside countries where that field is used. For more guidance on - * how to use this schema, please see: - * https://support.google.com/business/answer/6397478 + * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/googlei18n/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. - * Because values in address_lines do not have type information and may - * sometimes contain multiple values in a single field (e.g. "Austin, - * TX"), it is important that the line order is clear. The order of - * address lines should be "envelope order" for the country/region - * of the address. In places where this can vary (e.g. Japan), - * address_language is used to make it explicit (e.g. "ja" for - * large-to-small ordering and "ja-Latn" or "en" for - * small-to-large). This way, the most specific line of an address can be - * selected based on the language. The minimum permitted structural - * representation of an address consists of a region_code with all remaining - * information placed in the address_lines. It would be possible to format - * such an address very approximately without geocoding, but no semantic - * reasoning could be made about any of the address components until it was - * at least partially resolved. Creating an address only containing a - * region_code and address_lines, and then geocoding is the recommended way - * to handle completely unstructured addresses (as opposed to guessing which - * parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[]; /** - * Optional. Highest administrative subdivision which is used for postal - * addresses of a country or region. For example, this can be a state, a - * province, an oblast, or a prefecture. Specifically, for Spain this is the - * province and not the autonomous community (e.g. "Barcelona" and - * not "Catalonia"). Many countries don't use an - * administrative area in postal addresses. E.g. in Switzerland this should - * be left unpopulated. + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. */ administrativeArea?: string; /** - * Optional. BCP-47 language code of the contents of this address (if - * known). This is often the UI language of the input form or is expected to - * match one of the languages used in the address' country/region, or - * their transliterated equivalents. This can affect formatting in certain - * countries, but is not critical to the correctness of the data and will - * never affect any validation or other non-formatting related operations. - * If this value is not known, it should be omitted (rather than specifying - * a possibly incorrect default). Examples: "zh-Hant", - * "ja", "ja-Latn", "en". + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ languageCode?: string; /** - * Optional. Generally refers to the city/town portion of the address. - * Examples: US city, IT comune, UK post town. In regions of the world where - * localities are not well defined or do not fit into this structure well, - * leave locality empty and use address_lines. + * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. */ locality?: string; /** @@ -1895,101 +1291,57 @@ export namespace jobs_v2 { */ organization?: string; /** - * Optional. Postal code of the address. Not all countries use or require - * postal codes to be present, but where they are used, they may trigger - * additional validation with other parts of the address (e.g. state/zip - * validation in the U.S.A.). + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). */ postalCode?: string; /** - * Optional. The recipient at the address. This field may, under certain - * circumstances, contain multiline information. For example, it might - * contain "care of" information. + * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. */ recipients?: string[]; /** - * Required. CLDR region code of the country/region of the address. This is - * never inferred and it is up to the user to ensure the value is correct. - * See http://cldr.unicode.org/ and - * http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - * for details. Example: "CH" for Switzerland. + * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which - * is the latest revision. All new revisions **must** be backward - * compatible with old revisions. + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ revision?: number; /** - * Optional. Additional, country-specific, sorting code. This is not used in - * most regions. Where it is used, the value is either a string like - * "CEDEX", optionally followed by a number (e.g. "CEDEX - * 7"), or just a number alone, representing the "sector - * code" (Jamaica), "delivery area indicator" (Malawi) or - * "post office indicator" (e.g. Côte d'Ivoire). + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). */ sortingCode?: string; /** - * Optional. Sublocality of the address. For example, this can be - * neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. */ sublocality?: string; } /** - * Input only. Meta information related to the job searcher or entity - * conducting the job search. This information is used to improve the - * performance of the service. + * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. */ export interface Schema$RequestMetadata { /** - * Optional. The type of device used by the job seeker at the time of the - * call to the service. + * Optional. The type of device used by the job seeker at the time of the call to the service. */ deviceInfo?: Schema$DeviceInfo; /** - * Required. The client-defined scope or source of the service call, which - * typically is the domain on which the service has been implemented and is - * currently being run. For example, if the service is being run by client - * <em>Foo, Inc.</em>, on job board www.foo.com and career site - * www.bar.com, then this field is set to "foo.com" for use on the - * job board, and "bar.com" for use on the career site. If this - * field is not available for some reason, send "UNKNOWN". Note - * that any improvements to the service model for a particular tenant site - * rely on this field being set correctly to some domain. + * Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain. */ domain?: string; /** - * Required. A unique session identification string. A session is defined - * as the duration of an end user's interaction with the service over a - * period. Obfuscate this field for privacy concerns before providing it to - * the API. If this field is not available for some reason, please send - * "UNKNOWN". Note that any improvements to the service model for - * a particular tenant site, rely on this field being set correctly to some - * unique session_id. + * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id. */ sessionId?: string; /** - * Required. A unique user identification string, as determined by the - * client. The client is responsible for ensuring client-level uniqueness of - * this value in order to have the strongest positive impact on search - * quality. Obfuscate this field for privacy concerns before providing it to - * the service. If this field is not available for some reason, please send - * "UNKNOWN". Note that any improvements to the service model for - * a particular tenant site, rely on this field being set correctly to some - * unique user_id. + * Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id. */ userId?: string; } /** - * Output only. Additional information returned to client, such as debugging - * information. + * Output only. Additional information returned to client, such as debugging information. */ export interface Schema$ResponseMetadata { /** - * Identifiers for the versions of the search algorithm used during this API - * invocation if multiple algorithms are used. The default value is empty. - * For search response only. + * Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only. */ experimentIdList?: number[]; /** @@ -1997,8 +1349,7 @@ export namespace jobs_v2 { */ mode?: string; /** - * A unique id associated with this call. This id is logged for tracking - * purposes. + * A unique id associated with this call. This id is logged for tracking purposes. */ requestId?: string; } @@ -2007,42 +1358,27 @@ export namespace jobs_v2 { */ export interface Schema$SearchJobsRequest { /** - * Optional. Controls whether to disable relevance thresholding. Relevance - * thresholding removes jobs that have low relevance in search results, for - * example, removing "Assistant to the CEO" positions from the - * search results of a search for "CEO". Disabling relevance - * thresholding improves the accuracy of subsequent search requests. - * Defaults to false. + * Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing "Assistant to the CEO" positions from the search results of a search for "CEO". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false. */ disableRelevanceThresholding?: boolean; /** - * Optional. Controls whether to broaden the search when it produces sparse - * results. Broadened queries append results to the end of the matching - * results list. Defaults to false. + * Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. */ enableBroadening?: boolean; /** - * Optional. Controls if the search job request requires the return of a - * precise count of the first 300 results. Setting this to `true` ensures - * consistency in the number of results per page. Best practice is to set - * this value to true if a client allows users to jump directly to a - * non-sequential search results page. Enabling this flag may adversely - * impact performance. Defaults to false. + * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. */ enablePreciseResultSize?: boolean; /** - * Deprecated. Use query instead. Optional. Restrictions on the scope of - * the search request, such as filtering by location. + * Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location. */ filters?: Schema$JobFilters; /** - * Optional. Restrictions on what fields to perform histogram on, such as - * `COMPANY_SIZE` etc. + * Optional. Restrictions on what fields to perform histogram on, such as `COMPANY_SIZE` etc. */ histogramFacets?: Schema$HistogramFacets; /** - * Optional. The number of job attributes returned for jobs in the search - * response. Defaults to JobView.SMALL if no value is specified. + * Optional. The number of job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. */ jobView?: string; /** @@ -2050,47 +1386,31 @@ export namespace jobs_v2 { */ mode?: string; /** - * Optional. An integer that specifies the current offset (that is, - * starting result location, amongst the jobs deemed by the API as relevant) - * in search results. This field is only considered if page_token is unset. - * For example, 0 means to return results starting from the first matching - * job, and 10 means to return from the 11th job. This can be used for - * pagination, (for example, pageSize = 10 and offset = 10 means to return - * from the second page). + * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ offset?: number; /** - * Deprecated. Use sort_by instead. Optional. The criteria determining how - * search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value - * is specified. + * Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. */ orderBy?: string; /** - * Optional. A limit on the number of jobs returned in the search results. - * Increasing this value above the default value of 10 can increase search - * response time. The value can be between 1 and 100. + * Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. */ pageSize?: number; /** - * Optional. The token specifying the current offset within search results. - * See SearchJobsResponse.next_page_token for an explanation of how to - * obtain the next set of query results. + * Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. */ pageToken?: string; /** - * Optional. Query used to search against jobs, such as keyword, location - * filters, etc. + * Optional. Query used to search against jobs, such as keyword, location filters, etc. */ query?: Schema$JobQuery; /** - * Required. The meta information collected about the job searcher, used to - * improve the search quality of the service. The identifiers, (such as - * `user_id`) are provided by users, and must be unique and consistent. + * Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent. */ requestMetadata?: Schema$RequestMetadata; /** - * Optional. The criteria determining how search results are sorted. - * Defaults to SortBy.RELEVANCE_DESC if no value is specified. + * Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. */ sortBy?: string; } @@ -2099,25 +1419,19 @@ export namespace jobs_v2 { */ export interface Schema$SearchJobsResponse { /** - * The commute filter the service applied to the specified query. This - * information is only available when query has a valid CommutePreference. + * The commute filter the service applied to the specified query. This information is only available when query has a valid CommutePreference. */ appliedCommuteFilter?: Schema$CommutePreference; /** - * The location filters that the service applied to the specified query. If - * any filters are lat-lng based, the JobLocation.location_type is - * JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + * The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. */ appliedJobLocationFilters?: Schema$JobLocation[]; /** - * An estimation of the number of jobs that match the specified query. This - * number is not guaranteed to be accurate. For accurate results, - * seenenable_precise_result_size. + * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size. */ estimatedTotalSize?: string; /** - * The histogram results that match specified - * SearchJobsRequest.HistogramFacets. + * The histogram results that match specified SearchJobsRequest.HistogramFacets. */ histogramResults?: Schema$HistogramResults; /** @@ -2129,23 +1443,15 @@ export namespace jobs_v2 { */ matchingJobs?: Schema$MatchingJob[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** - * The token that specifies the starting position of the next page of - * results. This field is empty if there are no more results. + * The token that specifies the starting position of the next page of results. This field is empty if there are no more results. */ nextPageToken?: string; /** - * If query broadening is enabled, we may append additional results from the - * broadened query. This number indicates how many of the jobs returned in - * the jobs field are from the broadened query. These results are always at - * the end of the jobs list. In particular, a value of 0 means all the jobs - * in the jobs list are from the original (without broadening) query. If - * this field is non-zero, subsequent requests with offset after this result - * set should contain all broadened results. + * If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0 means all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results. */ numJobsFromBroadenedQuery?: number; /** @@ -2153,9 +1459,7 @@ export namespace jobs_v2 { */ spellResult?: Schema$SpellingCorrection; /** - * The precise result count, which is available only if the client set - * enable_precise_result_size to `true` or if the response is the last page - * of results. Otherwise, the value will be `-1`. + * The precise result count, which is available only if the client set enable_precise_result_size to `true` or if the response is the last page of results. Otherwise, the value will be `-1`. */ totalSize?: string; } @@ -2186,9 +1490,7 @@ export namespace jobs_v2 { */ export interface Schema$UpdateJobRequest { /** - * Deprecated. Please use processing_options. This flag is ignored if - * processing_options is set. Optional. If set to `true`, the service does - * not attempt resolve a more precise address for the job. + * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean; /** @@ -2196,23 +1498,11 @@ export namespace jobs_v2 { */ job?: Schema$Job; /** - * Optional. Options for job processing. - * UpdateJobRequest.disable_street_address_resolution is ignored if this - * flag is set. + * Optional. Options for job processing. UpdateJobRequest.disable_street_address_resolution is ignored if this flag is set. */ processingOptions?: Schema$JobProcessingOptions; /** - * Optional but strongly recommended to be provided for the best service - * experience. If update_job_fields is provided, only the specified fields - * in job are updated. Otherwise all the fields are updated. A field mask - * to restrict the fields that are updated. Valid values are: * jobTitle * - * employmentTypes * description * applicationUrls * applicationEmailList * - * applicationInstruction * responsibilities * qualifications * - * educationLevels * level * department * startDate * endDate * - * compensationInfo * incentives * languageCode * benefits * expireTime * - * customAttributes * visibility * publishDate * promotionValue * locations - * * region * expiryDate (deprecated) * filterableCustomFields (deprecated) - * * unindexedCustomFields (deprecated) + * Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated) */ updateJobFields?: string; } @@ -2431,8 +1721,7 @@ export namespace jobs_v2 { /** * jobs.companies.list - * @desc Lists all companies associated with a Cloud Talent Solution - * account. + * @desc Lists all companies associated with a Cloud Talent Solution account. * @alias jobs.companies.list * @memberOf! () * @@ -2506,9 +1795,7 @@ export namespace jobs_v2 { /** * jobs.companies.patch - * @desc Updates the specified company. Company names can't be updated. To - * update a company name, delete the company and all jobs associated with - * it, and only then re-create them. + * @desc Updates the specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them. * @alias jobs.companies.patch * @memberOf! () * @@ -2595,8 +1882,7 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the company to be deleted, such as, - * "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * Required. The resource name of the company to be deleted, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ name?: string; } @@ -2607,8 +1893,7 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the company to retrieve, such as - * "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * Required. Resource name of the company to retrieve, such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ name?: string; } @@ -2619,14 +1904,11 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Set to true if the companies request must have open jobs. - * Defaults to false. If true, at most page_size of companies are fetched, - * among which only those with open jobs are returned. + * Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. */ mustHaveOpenJobs?: boolean; /** - * Optional. The maximum number of companies to be returned, at most 100. - * Default is 100 if a non-positive number is provided. + * Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. */ pageSize?: number; /** @@ -2641,20 +1923,11 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required during company update. The resource name for a company. This is - * generated by the service when a company is created, for example, - * "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ name?: string; /** - * Optional but strongly recommended to be provided for the best service - * experience. If update_company_fields is provided, only the specified - * fields in company are updated. Otherwise all the fields are updated. A - * field mask to specify the company fields to update. Valid values are: * - * displayName * website * imageUrl * companySize * - * distributorBillingCompanyId * companyInfoSources * careerPageLink * - * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * - * title (deprecated) * keywordSearchableCustomFields (deprecated) + * Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) */ updateCompanyFields?: string; @@ -2672,8 +1945,7 @@ export namespace jobs_v2 { /** * jobs.companies.jobs.list - * @desc Deprecated. Use ListJobs instead. Lists all jobs associated with a - * company. + * @desc Deprecated. Use ListJobs instead. Lists all jobs associated with a company. * @alias jobs.companies.jobs.list * @memberOf! () * @@ -2761,32 +2033,23 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the company that owns the jobs to be - * listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * Required. The resource name of the company that owns the jobs to be listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ companyName?: string; /** - * Optional. If set to `true`, only job ID, job requisition ID and language - * code will be returned. A typical use is to synchronize job repositories. - * Defaults to false. + * Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. */ idsOnly?: boolean; /** - * Deprecated. Please DO NOT use this field except for small companies. - * Suggest counting jobs page by page instead. Optional. Set to true if - * the total number of open jobs is to be returned. Defaults to false. + * Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. */ includeJobsCount?: boolean; /** - * Optional. The requisition ID, also known as posting ID, assigned by the - * company to the job. The maximum number of allowable characters is 225. + * Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. */ jobRequisitionId?: string; /** - * Optional. The maximum number of jobs to be returned per page of results. - * If ids_only is set to true, the maximum allowed page size is 1000. - * Otherwise, the maximum allowed page size is 100. Default is 100 if empty - * or a number < 1 is specified. + * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. */ pageSize?: number; /** @@ -2874,8 +2137,7 @@ export namespace jobs_v2 { /** * jobs.jobs.create - * @desc Creates a new job. Typically, the job becomes searchable within 10 - * seconds, but it may take up to 5 minutes. + * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. * @alias jobs.jobs.create * @memberOf! () * @@ -2943,8 +2205,7 @@ export namespace jobs_v2 { /** * jobs.jobs.delete - * @desc Deletes the specified job. Typically, the job becomes unsearchable - * within 10 seconds, but it may take up to 5 minutes. + * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. * @alias jobs.jobs.delete * @memberOf! () * @@ -3013,10 +2274,7 @@ export namespace jobs_v2 { /** * jobs.jobs.deleteByFilter - * @desc Deprecated. Use BatchDeleteJobs instead. Deletes the specified job - * by filter. You can specify whether to synchronously wait for validation, - * indexing, and general processing to be completed before the response is - * returned. + * @desc Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned. * @alias jobs.jobs.deleteByFilter * @memberOf! () * @@ -3088,8 +2346,7 @@ export namespace jobs_v2 { /** * jobs.jobs.get - * @desc Retrieves the specified job, whose status is OPEN or recently - * EXPIRED within the last 90 days. + * @desc Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days. * @alias jobs.jobs.get * @memberOf! () * @@ -3157,14 +2414,7 @@ export namespace jobs_v2 { /** * jobs.jobs.histogram - * @desc Deprecated. Use SearchJobsRequest.histogram_facets instead to make - * a single call with both search and histogram. Retrieves a histogram for - * the given GetHistogramRequest. This call provides a structured count of - * jobs that match against the search query, grouped by specified facets. - * This call constrains the visibility of jobs present in the database, and - * only counts jobs the caller has permission to search against. For - * example, use this call to generate the number of jobs in the U.S. by - * state. + * @desc Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state. * @alias jobs.jobs.histogram * @memberOf! () * @@ -3311,8 +2561,7 @@ export namespace jobs_v2 { /** * jobs.jobs.patch - * @desc Updates specified job. Typically, updated contents become visible - * in search results within 10 seconds, but it may take up to 5 minutes. + * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. * @alias jobs.jobs.patch * @memberOf! () * @@ -3381,9 +2630,7 @@ export namespace jobs_v2 { /** * jobs.jobs.search - * @desc Searches for jobs using the provided SearchJobsRequest. This call - * constrains the visibility of jobs present in the database, and only - * returns jobs that the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. * @alias jobs.jobs.search * @memberOf! () * @@ -3453,13 +2700,7 @@ export namespace jobs_v2 { /** * jobs.jobs.searchForAlert - * @desc Searches for jobs using the provided SearchJobsRequest. This API - * call is intended for the use case of targeting passive job seekers (for - * example, job seekers who have signed up to receive email alerts about - * potential job opportunities), and has different algorithmic adjustments - * that are targeted to passive job seekers. This call constrains the - * visibility of jobs present in the database, and only returns jobs the - * caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. * @alias jobs.jobs.searchForAlert * @memberOf! () * @@ -3563,15 +2804,11 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. This field is not working anymore. Optional. If set to - * true, this call waits for all processing steps to complete before the job - * is cleaned up. Otherwise, the call returns while some steps are still - * taking place asynchronously, hence faster. + * Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. */ disableFastProcess?: boolean; /** - * Required. The resource name of the job to be deleted, such as - * "jobs/11111111". + * Required. The resource name of the job to be deleted, such as "jobs/11111111". */ name?: string; } @@ -3594,8 +2831,7 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the job to retrieve, such as - * "jobs/11111111". + * Required. The resource name of the job to retrieve, such as "jobs/11111111". */ name?: string; } @@ -3617,24 +2853,15 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The filter string specifies the jobs to be enumerated. - * Supported operator: =, AND The fields eligible for filtering are: * - * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * - * companyName = "companies/123" * companyName = "companies/123" AND - * requisitionId = "req-1" + * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" */ filter?: string; /** - * Optional. If set to `true`, only Job.name, Job.requisition_id and - * Job.language_code will be returned. A typical use case is to synchronize - * job repositories. Defaults to false. + * Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. */ idsOnly?: boolean; /** - * Optional. The maximum number of jobs to be returned per page of results. - * If ids_only is set to true, the maximum allowed page size is 1000. - * Otherwise, the maximum allowed page size is 100. Default is 100 if empty - * or a number < 1 is specified. + * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. */ pageSize?: number; /** @@ -3649,9 +2876,7 @@ export namespace jobs_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required during job update. Resource name assigned to a job by the API, - * for example, "/jobs/foo". Use of this field in job queries and API calls - * is preferred over the use of requisition_id since this value is unique. + * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; @@ -3692,8 +2917,7 @@ export namespace jobs_v2 { /** * jobs.complete - * @desc Completes the specified prefix with job keyword suggestions. - * Intended for use by a job search auto-complete search box. + * @desc Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box. * @alias jobs.complete * @memberOf! () * @@ -3782,14 +3006,7 @@ export namespace jobs_v2 { */ companyName?: string; /** - * Required. The language of the query. This is the BCP-47 language code, - * such as "en-US" or "sr-Latn". For more information, see [Tags for - * Identifying Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with same language_code are - * returned. For CompletionType.COMPANY_NAME type, only companies having - * open jobs with same language_code are returned. For - * CompletionType.COMBINED type, only open jobs with same language_code or - * companies having open jobs with same language_code are returned. + * Required. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. */ languageCode?: string; /** @@ -3801,8 +3018,7 @@ export namespace jobs_v2 { */ query?: string; /** - * Optional. The scope of the completion. The defaults is - * CompletionScope.PUBLIC. + * Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. */ scope?: string; /** diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index c282a7c6068..e497579c982 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace jobs_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace jobs_v3 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace jobs_v3 { /** * Cloud Talent Solution API * - * Cloud Talent Solution provides the capability to create, read, update, and - * delete job postings, as well as search jobs based on keywords and filters. + * Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace jobs_v3 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,26 +122,15 @@ export namespace jobs_v3 { */ export interface Schema$ApplicationInfo { /** - * Optional but at least one of uris, emails or instruction must be - * specified. Use this field to specify email address(es) to which resumes - * or applications can be sent. The maximum number of allowed characters - * for each entry is 255. + * Optional but at least one of uris, emails or instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255. */ emails?: string[]; /** - * Optional but at least one of uris, emails or instruction must be - * specified. Use this field to provide instructions, such as "Mail - * your application to ...", that a candidate can follow to apply for - * the job. This field accepts and sanitizes HTML input, and also accepts - * bold, italic, ordered list, and unordered list markup tags. The maximum - * number of allowed characters is 3,000. + * Optional but at least one of uris, emails or instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. */ instruction?: string; /** - * Optional but at least one of uris, emails or instruction must be - * specified. Use this URI field to direct an applicant to a website, for - * example to link to an online application form. The maximum number of - * allowed characters for each entry is 2,000. + * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. */ uris?: string[]; } @@ -152,11 +139,7 @@ export namespace jobs_v3 { */ export interface Schema$BatchDeleteJobsRequest { /** - * Required. The filter string specifies the jobs to be deleted. Supported - * operator: =, AND The fields eligible for filtering are: * `companyName` - * (Required) * `requisitionId` (Required) Sample Query: companyName = - * "projects/api-test-project/companies/123" AND requisitionId = - * "req-1" + * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string; } @@ -169,8 +152,7 @@ export namespace jobs_v3 { */ count?: number; /** - * Bucket range on which histogram was performed for the numeric field, that - * is, the count represents number of jobs in this range. + * Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range. */ range?: Schema$BucketRange; } @@ -188,12 +170,7 @@ export namespace jobs_v3 { to?: number; } /** - * An event issued when an end user interacts with the application that - * implements Cloud Talent Solution. Providing this information improves the - * quality of search and recommendation for the API clients, enabling the - * service to perform optimally. The number of events sent must be consistent - * with other calls, such as job searches, issued to the service by the - * client. + * An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client. */ export interface Schema$ClientEvent { /** @@ -201,34 +178,23 @@ export namespace jobs_v3 { */ createTime?: string; /** - * Required. A unique identifier, generated by the client application. This - * `event_id` is used to establish the relationship between different events - * (see parent_event_id). + * Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id). */ eventId?: string; /** - * Optional. Extra information about this event. Used for storing - * information with no matching field in event payload, for example, user - * application specific context or details. At most 20 keys are supported. - * The maximum total size of all keys and values is 2 KB. + * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. */ extraInfo?: {[key: string]: string}; /** - * A event issued when a job seeker interacts with the application that - * implements Cloud Talent Solution. + * A event issued when a job seeker interacts with the application that implements Cloud Talent Solution. */ jobEvent?: Schema$JobEvent; /** - * Optional. The event_id of an event that resulted in the current event. - * For example, a Job view event usually follows a parent impression event: - * A job seeker first does a search where a list of jobs appears - * (impression). The job seeker then selects a result and views the - * description of a particular job (Job view). + * Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view). */ parentEventId?: string; /** - * Required. A unique ID generated in the API responses. It can be found in - * ResponseMetadata.request_id. + * Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id. */ requestId?: string; } @@ -237,41 +203,27 @@ export namespace jobs_v3 { */ export interface Schema$CommuteFilter { /** - * Optional. If true, jobs without "precise" addresses (street - * level addresses or GPS coordinates) might also be returned. For city and - * coarser level addresses, text matching is used. If this field is set to - * false or is not specified, only jobs that include precise addresses are - * returned by Commute Search. Note: If `allow_imprecise_addresses` is set - * to true, Commute Search is not able to calculate accurate commute times - * to jobs with city level and coarser address information. Jobs with - * imprecise addresses will return a `travel_duration` time of 0 regardless - * of distance from the job seeker. + * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. */ allowImpreciseAddresses?: boolean; /** - * Required. The method of transportation for which to calculate the - * commute time. + * Required. The method of transportation for which to calculate the commute time. */ commuteMethod?: string; /** - * Optional. The departure time used to calculate traffic impact, - * represented as google.type.TimeOfDay in local time zone. Currently - * traffic model is restricted to hour level resolution. + * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. */ departureTime?: Schema$TimeOfDay; /** - * Optional. Specifies the traffic density to use when calculating commute - * time. + * Optional. Specifies the traffic density to use when calculating commute time. */ roadTraffic?: string; /** - * Required. The latitude and longitude of the location from which to - * calculate the commute time. + * Required. The latitude and longitude of the location from which to calculate the commute time. */ startCoordinates?: Schema$LatLng; /** - * Required. The maximum travel time in seconds. The maximum allowed value - * is `3600s` (one hour). Format is `123s`. + * Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. */ travelDuration?: string; } @@ -284,23 +236,16 @@ export namespace jobs_v3 { */ jobLocation?: Schema$Location; /** - * The number of seconds required to travel to the job location from the - * query location. A duration of 0 seconds indicates that the job is not - * reachable within the requested duration, but was returned as part of an - * expanded query. + * The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. */ travelDuration?: string; } /** - * A Company resource represents a company in the service. A company is the - * entity that owns job postings, that is, the hiring entity responsible for - * employing applicants for the job position. + * A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position. */ export interface Schema$Company { /** - * Optional. The URI to employer's career site or careers page on the - * employer's web site, for example, - * "https://careers.google.com". + * Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". */ careerSiteUri?: string; /** @@ -308,31 +253,23 @@ export namespace jobs_v3 { */ derivedInfo?: Schema$CompanyDerivedInfo; /** - * Required. The display name of the company, for example, "Google, - * LLC". + * Required. The display name of the company, for example, "Google, LLC". */ displayName?: string; /** - * Optional. Equal Employment Opportunity legal disclaimer text to be - * associated with all jobs, and typically to be displayed in all roles. The - * maximum number of allowed characters is 500. + * Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. */ eeoText?: string; /** - * Required. Client side company identifier, used to uniquely identify the - * company. The maximum number of allowed characters is 255. + * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. */ externalId?: string; /** - * Optional. The street address of the company's main headquarters, - * which may be different from the job location. The service attempts to - * geolocate the provided address, and populates a more specific location - * wherever possible in DerivedInfo.headquarters_location. + * Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location. */ headquartersAddress?: string; /** - * Optional. Set to true if it is the hiring agency that post jobs for - * other employers. Defaults to false if not provided. + * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ hiringAgency?: boolean; /** @@ -340,19 +277,11 @@ export namespace jobs_v3 { */ imageUri?: string; /** - * Optional. A list of keys of filterable Job.custom_attributes, whose - * corresponding `string_values` are used in keyword search. Jobs with - * `string_values` under these specified field keys are returned if any of - * the values matches the search keyword. Custom field values with - * parenthesis, brackets and special symbols won't be properly - * searchable, and those keyword queries need to be surrounded by quotes. + * Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes. */ keywordSearchableJobCustomAttributes?: string[]; /** - * Required during company update. The resource name for a company. This is - * generated by the service when a company is created. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; /** @@ -360,15 +289,11 @@ export namespace jobs_v3 { */ size?: string; /** - * Output only. Indicates whether a company is flagged to be suspended from - * public availability by the service when job content appears suspicious, - * abusive, or spammy. + * Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. */ suspended?: boolean; /** - * Optional. The URI representing the company's primary web site or - * home page, for example, "https://www.google.com". The maximum - * number of allowed characters is 255. + * Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. */ websiteUri?: string; } @@ -377,18 +302,12 @@ export namespace jobs_v3 { */ export interface Schema$CompanyDerivedInfo { /** - * A structured headquarters location of the company, resolved from - * Company.hq_location if provided. + * A structured headquarters location of the company, resolved from Company.hq_location if provided. */ headquartersLocation?: Schema$Location; } /** - * A compensation entry that represents one component of compensation, such as - * base pay, bonus, or other compensation type. Annualization: One - * compensation entry can be annualized if - it contains valid amount or - * range. - and its expected_units_per_year is set or can be derived. Its - * annualized range is determined as (amount or range) times - * expected_units_per_year. + * A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$CompensationEntry { /** @@ -396,15 +315,11 @@ export namespace jobs_v3 { */ amount?: Schema$Money; /** - * Optional. Compensation description. For example, could indicate equity - * terms or provide additional context to an estimated bonus. + * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ description?: string; /** - * Optional. Expected number of units paid each year. If not specified, - * when Job.employment_types is FULLTIME, a default value is inferred based - * on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - - * MONTHLY: 12 - ANNUAL: 1 + * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ expectedUnitsPerYear?: number; /** @@ -412,13 +327,11 @@ export namespace jobs_v3 { */ range?: Schema$CompensationRange; /** - * Optional. Compensation type. Default is - * CompensationUnit.OTHER_COMPENSATION_TYPE. + * Optional. Compensation type. Default is CompensationUnit.OTHER_COMPENSATION_TYPE. */ type?: string; /** - * Optional. Frequency of the specified amount. Default is - * CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. */ unit?: string; } @@ -427,8 +340,7 @@ export namespace jobs_v3 { */ export interface Schema$CompensationFilter { /** - * Optional. Whether to include jobs whose compensation range is - * unspecified. + * Optional. Whether to include jobs whose compensation range is unspecified. */ includeJobsWithUnspecifiedCompensationRange?: boolean; /** @@ -440,8 +352,7 @@ export namespace jobs_v3 { */ type?: string; /** - * Required. Specify desired `base compensation entry's` - * CompensationInfo.CompensationUnit. + * Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit. */ units?: string[]; } @@ -450,14 +361,11 @@ export namespace jobs_v3 { */ export interface Schema$CompensationHistogramRequest { /** - * Required. Numeric histogram options, like buckets, whether include min - * or max value. + * Required. Numeric histogram options, like buckets, whether include min or max value. */ bucketingOption?: Schema$NumericBucketingOption; /** - * Required. Type of the request, representing which field the - * histogramming should be performed over. A single request can only specify - * one histogram of each `CompensationHistogramRequestType`. + * Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`. */ type?: string; } @@ -479,23 +387,15 @@ export namespace jobs_v3 { */ export interface Schema$CompensationInfo { /** - * Output only. Annualized base compensation range. Computed as base - * compensation entry's CompensationEntry.compensation times - * CompensationEntry.expected_units_per_year. See CompensationEntry for - * explanation on compensation annualization. + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedBaseCompensationRange?: Schema$CompensationRange; /** - * Output only. Annualized total compensation range. Computed as all - * compensation entries' CompensationEntry.compensation times - * CompensationEntry.expected_units_per_year. See CompensationEntry for - * explanation on compensation annualization. + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedTotalCompensationRange?: Schema$CompensationRange; /** - * Optional. Job compensation information. At most one entry can be of - * type CompensationInfo.CompensationType.BASE, which is referred as ** base - * compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$CompensationEntry[]; } @@ -504,15 +404,11 @@ export namespace jobs_v3 { */ export interface Schema$CompensationRange { /** - * Optional. The maximum amount of compensation. If left empty, the value - * is set to a maximal compensation value and the currency code is set to - * match the currency code of min_compensation. + * Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation. */ maxCompensation?: Schema$Money; /** - * Optional. The minimum amount of compensation. If left empty, the value - * is set to zero and the currency code is set to match the currency code of - * max_compensation. + * Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation. */ minCompensation?: Schema$Money; } @@ -525,8 +421,7 @@ export namespace jobs_v3 { */ completionResults?: Schema$CompletionResult[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; } @@ -552,8 +447,7 @@ export namespace jobs_v3 { */ export interface Schema$CreateClientEventRequest { /** - * Required. Events issued when end user interacts with customer's - * application that uses Cloud Talent Solution. + * Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution. */ clientEvent?: Schema$ClientEvent; } @@ -580,50 +474,32 @@ export namespace jobs_v3 { */ export interface Schema$CustomAttribute { /** - * Optional. If the `filterable` flag is true, custom field values are - * searchable. If false, values are not searchable. Default is false. + * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ filterable?: boolean; /** - * Optional but exactly one of string_values or long_values must be - * specified. This field is used to perform number range search. (`EQ`, - * `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most - * 1 long_values is supported. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. */ longValues?: string[]; /** - * Optional but exactly one of string_values or long_values must be - * specified. This field is used to perform a string match - * (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For - * filterable `string_value`s, a maximum total number of 200 values is - * allowed, with each `string_value` has a byte size of no more than 255B. - * For unfilterable `string_values`, the maximum total byte size of - * unfilterable `string_values` is 50KB. Empty string is not allowed. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. */ stringValues?: string[]; } /** - * Custom attributes histogram request. An error is thrown if neither - * string_value_histogram or long_value_histogram_bucketing_option has been - * defined. + * Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined. */ export interface Schema$CustomAttributeHistogramRequest { /** - * Required. Specifies the custom field key to perform a histogram on. If - * specified without `long_value_histogram_bucketing_option`, histogram on - * string values of the given `key` is triggered, otherwise histogram is - * performed on long values. + * Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values. */ key?: string; /** - * Optional. Specifies buckets used to perform a range histogram on - * Job's filterable long custom field values, or min/max value - * requirements. + * Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements. */ longValueHistogramBucketingOption?: Schema$NumericBucketingOption; /** - * Optional. If set to true, the response includes the histogram value for - * each key as a string. + * Optional. If set to true, the response includes the histogram value for each key as a string. */ stringValueHistogram?: boolean; } @@ -636,20 +512,16 @@ export namespace jobs_v3 { */ key?: string; /** - * Stores bucketed histogram counting result or min/max values for custom - * attribute long values associated with `key`. + * Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`. */ longValueHistogramResult?: Schema$NumericBucketingResult; /** - * Stores a map from the values of string custom field associated with `key` - * to the number of jobs with that value in this histogram result. + * Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result. */ stringValueHistogramResult?: {[key: string]: number}; } /** - * Device information collected from the job seeker, candidate, or other - * entity conducting the job search. Providing this information improves the - * quality of the search results across devices. + * Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices. */ export interface Schema$DeviceInfo { /** @@ -657,17 +529,12 @@ export namespace jobs_v3 { */ deviceType?: string; /** - * Optional. A device-specific ID. The ID must be a unique identifier that - * distinguishes the device from other devices. + * Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. */ id?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -675,26 +542,20 @@ export namespace jobs_v3 { */ export interface Schema$HistogramFacets { /** - * Optional. Specifies compensation field-based histogram requests. - * Duplicate values of CompensationHistogramRequest.type are not allowed. + * Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed. */ compensationHistogramFacets?: Schema$CompensationHistogramRequest[]; /** - * Optional. Specifies the custom attributes histogram requests. Duplicate - * values of CustomAttributeHistogramRequest.key are not allowed. + * Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed. */ customAttributeHistogramFacets?: Schema$CustomAttributeHistogramRequest[]; /** - * Optional. Specifies the simple type of histogram facets, for example, - * `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. + * Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. */ simpleHistogramFacets?: string[]; } /** - * Output only. Result of a histogram call. The response contains the - * histogram map for the search type specified by HistogramResult.field. The - * response is a map of each filter value to the corresponding count of jobs - * for that filter. + * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. */ export interface Schema$HistogramResult { /** @@ -702,59 +563,37 @@ export namespace jobs_v3 { */ searchType?: string; /** - * A map from the values of field to the number of jobs with that value in - * this search result. Key: search type (filter names, such as the - * companyName). Values: the count of jobs that match the filter for this - * search. + * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ values?: {[key: string]: number}; } /** - * Output only. Histogram results that match HistogramFacets specified in - * SearchJobsRequest. + * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. */ export interface Schema$HistogramResults { /** - * Specifies compensation field-based histogram results that match - * HistogramFacets.compensation_histogram_requests. + * Specifies compensation field-based histogram results that match HistogramFacets.compensation_histogram_requests. */ compensationHistogramResults?: Schema$CompensationHistogramResult[]; /** - * Specifies histogram results for custom attributes that match - * HistogramFacets.custom_attribute_histogram_facets. + * Specifies histogram results for custom attributes that match HistogramFacets.custom_attribute_histogram_facets. */ customAttributeHistogramResults?: Schema$CustomAttributeHistogramResult[]; /** - * Specifies histogram results that matches - * HistogramFacets.simple_histogram_facets. + * Specifies histogram results that matches HistogramFacets.simple_histogram_facets. */ simpleHistogramResults?: Schema$HistogramResult[]; } /** - * A Job resource represents a job posting (also referred to as a "job - * listing" or "job requisition"). A job belongs to a Company, - * which is the hiring entity responsible for the job. + * A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. */ export interface Schema$Job { /** - * Optional but strongly recommended for the best service experience. - * Location(s) where the employer is looking to hire for this job posting. - * Specifying the full street address(es) of the hiring location enables - * better API results, especially job searches by commute time. At most 50 - * locations are allowed for best search performance. If a job has more - * locations, it is suggested to split it into multiple jobs with unique - * requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', - * 'ReqA-2', etc.) as multiple jobs with the same company_name, - * language_code and requisition_id are not allowed. If the original - * requisition_id must be preserved, a custom field should be used for - * storage. It is also suggested to group the locations that close to each - * other in the same job for better search experience. The maximum number - * of allowed characters is 500. + * Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. */ addresses?: string[]; /** - * Required. At least one field within ApplicationInfo must be specified. - * Job application information. + * Required. At least one field within ApplicationInfo must be specified. Job application information. */ applicationInfo?: Schema$ApplicationInfo; /** @@ -762,8 +601,7 @@ export namespace jobs_v3 { */ companyDisplayName?: string; /** - * Required. The resource name of the company listing the job, such as - * "projects/api-test-project/companies/foo". + * Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo". */ companyName?: string; /** @@ -771,25 +609,15 @@ export namespace jobs_v3 { */ compensationInfo?: Schema$CompensationInfo; /** - * Optional. A map of fields to hold both filterable and non-filterable - * custom job attributes that are not covered by the provided structured - * fields. The keys of the map are strings up to 64 bytes and must match - * the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At - * most 100 filterable and at most 100 unfilterable keys are supported. For - * filterable `string_values`, across all keys at most 200 values are - * allowed, with each string no more than 255 characters. For unfilterable - * `string_values`, the maximum total size of `string_values` across all - * keys is 50KB. + * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ customAttributes?: {[key: string]: Schema$CustomAttribute}; /** - * Optional. The desired education degrees for the job, such as Bachelors, - * Masters. + * Optional. The desired education degrees for the job, such as Bachelors, Masters. */ degreeTypes?: string[]; /** - * Optional. The department or functional area within the company with the - * open position. The maximum number of allowed characters is 255. + * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ department?: string; /** @@ -797,24 +625,15 @@ export namespace jobs_v3 { */ derivedInfo?: Schema$JobDerivedInfo; /** - * Required. The description of the job, which typically includes a - * multi-paragraph description of the company and related information. - * Separate fields are provided on the job object for responsibilities, - * qualifications, and other job characteristics. Use of these separate job - * fields is recommended. This field accepts and sanitizes HTML input, and - * also accepts bold, italic, ordered list, and unordered list markup tags. - * The maximum number of allowed characters is 100,000. + * Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. */ description?: string; /** - * Optional. The employment type(s) of a job, for example, full time or - * part time. + * Optional. The employment type(s) of a job, for example, full time or part time. */ employmentTypes?: string[]; /** - * Optional. A description of bonus, commission, and other compensation - * incentives associated with the job not including salary or pay. The - * maximum number of allowed characters is 10,000. + * Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. */ incentives?: string; /** @@ -822,39 +641,23 @@ export namespace jobs_v3 { */ jobBenefits?: string[]; /** - * Optional. The end timestamp of the job. Typically this field is used for - * contracting engagements. Invalid timestamps are ignored. + * Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ jobEndTime?: string; /** - * Optional. The experience level associated with the job, such as - * "Entry Level". + * Optional. The experience level associated with the job, such as "Entry Level". */ jobLevel?: string; /** - * Optional. The start timestamp of the job in UTC time zone. Typically - * this field is used for contracting engagements. Invalid timestamps are - * ignored. + * Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ jobStartTime?: string; /** - * Optional. The language of the posting. This field is distinct from any - * requirements for fluency that are associated with the job. Language - * codes must be in BCP-47 format, such as "en-US" or - * "sr-Latn". For more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47){: - * class="external" target="_blank" }. If this field is - * unspecified and Job.description is present, detected language code based - * on Job.description is assigned, otherwise defaults to 'en_US'. + * Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ languageCode?: string; /** - * Required during job update. The resource name for the job. This is - * generated by the service when a job is created. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". Use of this field in - * job queries and API calls is preferred over the use of requisition_id - * since this value is unique. + * Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; /** @@ -862,46 +665,15 @@ export namespace jobs_v3 { */ postingCreateTime?: string; /** - * Optional but strongly recommended for the best service experience. The - * expiration timestamp of the job. After this timestamp, the job is marked - * as expired, and it no longer appears in search results. The expired job - * can't be deleted or listed by the DeleteJob and ListJobs APIs, but it - * can be retrieved with the GetJob API or updated with the UpdateJob API. - * An expired job can be updated and opened again by using a future - * expiration timestamp. Updating an expired job fails if there is another - * existing open job with same company_name, language_code and - * requisition_id. The expired jobs are retained in our system for 90 days. - * However, the overall expired job count cannot exceed 3 times the maximum - * of open jobs count over the past week, otherwise jobs with earlier expire - * time are cleaned first. Expired jobs are no longer accessible after they - * are cleaned out. Invalid timestamps are ignored, and treated as expire - * time not provided. Timestamp before the instant request is made is - * considered valid, the job will be treated as expired immediately. If - * this value is not provided at the time of job creation or is invalid, the - * job posting expires after 30 days from the job's creation time. For - * example, if the job was created on 2017/01/01 13:00AM UTC with an - * unspecified expiration date, the job expires after 2017/01/31 13:00AM - * UTC. If this value is not provided on job update, it depends on the - * field masks set by UpdateJobRequest.update_mask. If the field masks - * include expiry_time, or the masks are empty meaning that every field is - * updated, the job posting expires after 30 days from the job's last - * update time. Otherwise the expiration date isn't updated. + * Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company_name, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ postingExpireTime?: string; /** - * Optional. The timestamp this job posting was most recently published. - * The default value is the time the request arrives at the server. Invalid - * timestamps are ignored. + * Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. */ postingPublishTime?: string; /** - * Optional. The job PostingRegion (for example, state, country) throughout - * which the job is available. If this field is set, a LocationFilter in a - * search query within the job region finds this job posting if an exact - * location match isn't specified. If this field is set to - * PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job - * Job.addresses to the same location level as this field is strongly - * recommended. + * Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. */ postingRegion?: string; /** @@ -913,47 +685,27 @@ export namespace jobs_v3 { */ processingOptions?: Schema$ProcessingOptions; /** - * Optional. A promotion value of the job, as determined by the client. The - * value determines the sort order of the jobs returned when searching for - * jobs using the featured jobs search call, with higher promotional values - * being returned first and ties being resolved by relevance sort. Only the - * jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. - * Default value is 0, and negative values are treated as 0. + * Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. */ promotionValue?: number; /** - * Optional. A description of the qualifications required to perform the - * job. The use of this field is recommended as an alternative to using the - * more general description field. This field accepts and sanitizes HTML - * input, and also accepts bold, italic, ordered list, and unordered list - * markup tags. The maximum number of allowed characters is 10,000. + * Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ qualifications?: string; /** - * Required. The requisition ID, also referred to as the posting ID, - * assigned by the client to identify a job. This field is intended to be - * used by clients for client identification and tracking of postings. A job - * is not allowed to be created if there is another job with the same - * [company_name], language_code and requisition_id. The maximum number of - * allowed characters is 255. + * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. */ requisitionId?: string; /** - * Optional. A description of job responsibilities. The use of this field - * is recommended as an alternative to using the more general description - * field. This field accepts and sanitizes HTML input, and also accepts - * bold, italic, ordered list, and unordered list markup tags. The maximum - * number of allowed characters is 10,000. + * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ responsibilities?: string; /** - * Required. The title of the job, such as "Software Engineer" - * The maximum number of allowed characters is 500. + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ title?: string; /** - * Optional. The visibility of the job. Defaults to - * Visibility.ACCOUNT_ONLY if not specified. + * Optional. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. */ visibility?: string; } @@ -966,21 +718,16 @@ export namespace jobs_v3 { */ jobCategories?: string[]; /** - * Structured locations of the job, resolved from Job.addresses. locations - * are exactly matched to Job.addresses in the same order. + * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. */ locations?: Schema$Location[]; } /** - * An event issued when a job seeker interacts with the application that - * implements Cloud Talent Solution. + * An event issued when a job seeker interacts with the application that implements Cloud Talent Solution. */ export interface Schema$JobEvent { /** - * Required. The job name(s) associated with this event. For example, if - * this is an impression event, this field contains the identifiers of all - * jobs shown to the job seeker. If this was a view event, this field - * contains the identifier of the viewed job. + * Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. */ jobs?: string[]; /** @@ -993,117 +740,56 @@ export namespace jobs_v3 { */ export interface Schema$JobQuery { /** - * Optional. Allows filtering jobs by commute time with different travel - * methods (for example, driving or public transit). Note: This only works - * with COMMUTE MODE. When specified, [JobQuery.location_filters] is - * ignored. Currently we don't support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. */ commuteFilter?: Schema$CommuteFilter; /** - * Optional. This filter specifies the exact company display name of the - * jobs to search against. If a value isn't specified, jobs within the - * search results are associated with any company. If multiple values are - * specified, jobs within the search results may be associated with any of - * the specified companies. At most 20 company display name filters are - * allowed. + * Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. */ companyDisplayNames?: string[]; /** - * Optional. This filter specifies the company entities to search against. - * If a value isn't specified, jobs are searched for against all - * companies. If multiple values are specified, jobs are searched against - * the companies specified. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". At most 20 company - * filters are allowed. + * Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. */ companyNames?: string[]; /** - * Optional. This search filter is applied only to Job.compensation_info. - * For example, if the filter is specified as "Hourly job with per-hour - * compensation > $15", only jobs meeting these criteria are - * searched. If a filter isn't defined, all open jobs are searched. + * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the - * Job.custom_attributes marked as `filterable`. The syntax for this - * expression is a subset of SQL syntax. Supported operators are: `=`, - * `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator - * is a custom field key and the right of the operator is a number or a - * quoted string. You must escape backslash (\\) and quote (\") - * characters. Supported functions are `LOWER([field_name])` to perform a - * case insensitive match and `EMPTY([field_name])` to filter on the - * existence of a key. Boolean expressions (AND/OR/NOT) are supported up to - * 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND - * E"), a maximum of 100 comparisons or functions are allowed in the - * expression. The expression must be < 3000 bytes in length. Sample - * Query: `(LOWER(driving_license)="class \"a\"" OR - * EMPTY(driving_license)) AND driving_years > 10` + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 3000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` */ customAttributeFilter?: string; /** - * Optional. This flag controls the spell-check feature. If false, the - * service attempts to correct a misspelled query, for example, - * "enginee" is corrected to "engineer". Defaults to - * false: a spell check is performed. + * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ disableSpellCheck?: boolean; /** - * Optional. The employment type filter specifies the employment type of - * jobs to search against, such as EmploymentType.FULL_TIME. If a value is - * not specified, jobs in the search results includes any employment type. - * If multiple values are specified, jobs in the search results include any - * of the specified employment types. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ employmentTypes?: string[]; /** - * Optional. The category filter specifies the categories of jobs to search - * against. See Category for more information. If a value is not specified, - * jobs from any category are searched against. If multiple values are - * specified, jobs from any of the specified categories are searched - * against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ jobCategories?: string[]; /** - * Optional. This filter specifies the locale of jobs to search against, - * for example, "en-US". If a value isn't specified, the - * search results can contain jobs in any locale. Language codes should be - * in BCP-47 format, such as "en-US" or "sr-Latn". For - * more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47). At most 10 language code - * filters are allowed. + * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[]; /** - * Optional. The location filter specifies geo-regions containing the jobs - * to search against. See LocationFilter for more information. If a - * location value isn't specified, jobs fitting the other search - * criteria are retrieved regardless of where they're located. If - * multiple values are specified, jobs are retrieved from any of the - * specified locations. If different values are specified for the - * LocationFilter.distance_in_miles parameter, the maximum provided distance - * is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** - * Optional. Jobs published within a range specified by this filter are - * searched against. + * Optional. Jobs published within a range specified by this filter are searched against. */ publishTimeRange?: Schema$TimestampRange; /** - * Optional. The query string that matches against the job title, - * description, and location fields. The maximum number of allowed - * characters is 255. + * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ query?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -1124,8 +810,7 @@ export namespace jobs_v3 { */ companies?: Schema$Company[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -1138,13 +823,11 @@ export namespace jobs_v3 { */ export interface Schema$ListJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is - * based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -1153,8 +836,7 @@ export namespace jobs_v3 { nextPageToken?: string; } /** - * Output only. A resource that represents a location with full geographic - * information. + * Output only. A resource that represents a location with full geographic information. */ export interface Schema$Location { /** @@ -1162,25 +844,15 @@ export namespace jobs_v3 { */ latLng?: Schema$LatLng; /** - * The type of a location, which corresponds to the address lines field of - * PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a - * type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" - * has a type of LocationType#LOCALITY. + * The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. */ locationType?: string; /** - * Postal address of the location that includes human readable information, - * such as postal delivery and payments addresses. Given a postal address, a - * postal service can deliver items to a premises, P.O. Box, or other - * delivery location. + * Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. */ postalAddress?: Schema$PostalAddress; /** - * Radius in miles of the job location. This value is derived from the - * location bounding box in which a circle with the specified radius - * centered from LatLng covers the area associated with the job location. - * For example, currently, "Mountain View, CA, USA" has a radius - * of 6.17 miles. + * Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. */ radiusInMiles?: number; } @@ -1189,46 +861,23 @@ export namespace jobs_v3 { */ export interface Schema$LocationFilter { /** - * Optional. The address name, such as "Mountain View" or - * "Bay Area". + * Optional. The address name, such as "Mountain View" or "Bay Area". */ address?: string; /** - * Optional. The distance_in_miles is applied when the location being - * searched for is identified as a city or smaller. When the location being - * searched for is a state or larger, this field is ignored. + * Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. */ distanceInMiles?: number; /** - * Optional. The latitude and longitude of the geographic center from which - * to search. This field's ignored if `address` is provided. + * Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if `address` is provided. */ latLng?: Schema$LatLng; /** - * Optional. CLDR region code of the country/region of the address. This is - * used to address ambiguity of the user-input location, for example, - * "Liverpool" against "Liverpool, NY, US" or - * "Liverpool, UK". Set this field if all the jobs to search - * against are from a same region, or jobs are world-wide, but the job - * seeker is from a specific region. See http://cldr.unicode.org/ and - * http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - * for details. Example: "CH" for Switzerland. + * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string; /** - * Optional. Allows the client to return jobs without a set location, - * specifically, telecommuting jobs (telecomuting is considered by the - * service as a special location. Job.posting_region indicates if a job - * permits telecommuting. If this field is set to - * TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are - * searched, and address and lat_lng are ignored. If not set or set to - * TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not - * searched. This filter can be used by itself to search exclusively for - * telecommuting jobs, or it can be combined with another location filter to - * search for a combination of job locations, such as "Mountain - * View" or "telecommuting" jobs. However, when used in - * combination with other location filters, telecommuting jobs can be - * treated as less relevant than other jobs in the search response. + * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ telecommutePreference?: string; } @@ -1245,21 +894,15 @@ export namespace jobs_v3 { */ job?: Schema$Job; /** - * A summary of the job with core information that's displayed on the - * search results listing page. + * A summary of the job with core information that's displayed on the search results listing page. */ jobSummary?: string; /** - * Contains snippets of text from the Job.job_title field most closely - * matching a search query's keywords, if available. The matching query - * keywords are enclosed in HTML bold tags. + * Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags. */ jobTitleSnippet?: string; /** - * Contains snippets of text from the Job.description and similar fields - * that most closely match a search query's keywords, if available. All - * HTML tags in the original fields are stripped when returned in this - * field, and matching query keywords are enclosed in HTML bold tags. + * Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. */ searchTextSnippet?: string; } @@ -1272,35 +915,24 @@ export namespace jobs_v3 { */ currencyCode?: string; /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ nanos?: number; /** - * The whole units of the amount. For example if `currencyCode` is - * `"USD"`, then 1 unit is one US dollar. + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ units?: string; } /** - * Input only. Use this field to specify bucketing option for the histogram - * search response. + * Input only. Use this field to specify bucketing option for the histogram search response. */ export interface Schema$NumericBucketingOption { /** - * Required. Two adjacent values form a histogram bucket. Values should be - * in ascending order. For example, if [5, 10, 15] are provided, four - * buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 - * [buckets_bound is supported. + * Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported. */ bucketBounds?: number[]; /** - * Optional. If set to true, the histogram result includes minimum/maximum - * value of the numeric field. + * Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field. */ requiresMinMax?: boolean; } @@ -1309,83 +941,36 @@ export namespace jobs_v3 { */ export interface Schema$NumericBucketingResult { /** - * Count within each bucket. Its size is the length of - * NumericBucketingOption.bucket_bounds plus 1. + * Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1. */ counts?: Schema$BucketizedCount[]; /** - * Stores the maximum value of the numeric field. Is populated only if - * [NumericBucketingOption.requires_min_max] is set to true. + * Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true. */ maxValue?: number; /** - * Stores the minimum value of the numeric field. Will be populated only if - * [NumericBucketingOption.requires_min_max] is set to true. + * Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ minValue?: number; } /** - * Represents a postal address, e.g. for postal delivery or payments - * addresses. Given a postal address, a postal service can deliver items to a - * premise, P.O. Box or similar. It is not intended to model geographical - * locations (roads, towns, mountains). In typical usage an address would be - * created via user input or from importing existing data, depending on the - * type of process. Advice on address input / editing: - Use an i18n-ready - * address widget such as https://github.com/googlei18n/libaddressinput) - - * Users should not be presented with UI elements for input or editing of - * fields outside countries where that field is used. For more guidance on - * how to use this schema, please see: - * https://support.google.com/business/answer/6397478 + * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/googlei18n/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. - * Because values in address_lines do not have type information and may - * sometimes contain multiple values in a single field (e.g. "Austin, - * TX"), it is important that the line order is clear. The order of - * address lines should be "envelope order" for the country/region - * of the address. In places where this can vary (e.g. Japan), - * address_language is used to make it explicit (e.g. "ja" for - * large-to-small ordering and "ja-Latn" or "en" for - * small-to-large). This way, the most specific line of an address can be - * selected based on the language. The minimum permitted structural - * representation of an address consists of a region_code with all remaining - * information placed in the address_lines. It would be possible to format - * such an address very approximately without geocoding, but no semantic - * reasoning could be made about any of the address components until it was - * at least partially resolved. Creating an address only containing a - * region_code and address_lines, and then geocoding is the recommended way - * to handle completely unstructured addresses (as opposed to guessing which - * parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[]; /** - * Optional. Highest administrative subdivision which is used for postal - * addresses of a country or region. For example, this can be a state, a - * province, an oblast, or a prefecture. Specifically, for Spain this is the - * province and not the autonomous community (e.g. "Barcelona" and - * not "Catalonia"). Many countries don't use an - * administrative area in postal addresses. E.g. in Switzerland this should - * be left unpopulated. + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. */ administrativeArea?: string; /** - * Optional. BCP-47 language code of the contents of this address (if - * known). This is often the UI language of the input form or is expected to - * match one of the languages used in the address' country/region, or - * their transliterated equivalents. This can affect formatting in certain - * countries, but is not critical to the correctness of the data and will - * never affect any validation or other non-formatting related operations. - * If this value is not known, it should be omitted (rather than specifying - * a possibly incorrect default). Examples: "zh-Hant", - * "ja", "ja-Latn", "en". + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ languageCode?: string; /** - * Optional. Generally refers to the city/town portion of the address. - * Examples: US city, IT comune, UK post town. In regions of the world where - * localities are not well defined or do not fit into this structure well, - * leave locality empty and use address_lines. + * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. */ locality?: string; /** @@ -1393,44 +978,27 @@ export namespace jobs_v3 { */ organization?: string; /** - * Optional. Postal code of the address. Not all countries use or require - * postal codes to be present, but where they are used, they may trigger - * additional validation with other parts of the address (e.g. state/zip - * validation in the U.S.A.). + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). */ postalCode?: string; /** - * Optional. The recipient at the address. This field may, under certain - * circumstances, contain multiline information. For example, it might - * contain "care of" information. + * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. */ recipients?: string[]; /** - * Required. CLDR region code of the country/region of the address. This is - * never inferred and it is up to the user to ensure the value is correct. - * See http://cldr.unicode.org/ and - * http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - * for details. Example: "CH" for Switzerland. + * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which - * is the latest revision. All new revisions **must** be backward - * compatible with old revisions. + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ revision?: number; /** - * Optional. Additional, country-specific, sorting code. This is not used in - * most regions. Where it is used, the value is either a string like - * "CEDEX", optionally followed by a number (e.g. "CEDEX - * 7"), or just a number alone, representing the "sector - * code" (Jamaica), "delivery area indicator" (Malawi) or - * "post office indicator" (e.g. Côte d'Ivoire). + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). */ sortingCode?: string; /** - * Optional. Sublocality of the address. For example, this can be - * neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. */ sublocality?: string; } @@ -1439,73 +1007,41 @@ export namespace jobs_v3 { */ export interface Schema$ProcessingOptions { /** - * Optional. If set to `true`, the service does not attempt to resolve a - * more precise address for the job. + * Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean; /** - * Optional. Option for job HTML content sanitization. Applied fields are: - * * description * applicationInfo.instruction * incentives * qualifications - * * responsibilities HTML tags in these fields may be stripped if - * sanitiazation is not disabled. Defaults to - * HtmlSanitization.SIMPLE_FORMATTING_ONLY. + * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ htmlSanitization?: string; } /** - * Input only. Meta information related to the job searcher or entity - * conducting the job search. This information is used to improve the - * performance of the service. + * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. */ export interface Schema$RequestMetadata { /** - * Optional. The type of device used by the job seeker at the time of the - * call to the service. + * Optional. The type of device used by the job seeker at the time of the call to the service. */ deviceInfo?: Schema$DeviceInfo; /** - * Required. The client-defined scope or source of the service call, which - * typically is the domain on which the service has been implemented and is - * currently being run. For example, if the service is being run by client - * <em>Foo, Inc.</em>, on job board www.foo.com and career site - * www.bar.com, then this field is set to "foo.com" for use on the - * job board, and "bar.com" for use on the career site. If this - * field isn't available for some reason, send "UNKNOWN". Any - * improvements to the model for a particular tenant site rely on this field - * being set correctly to a domain. The maximum number of allowed - * characters is 255. + * Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. */ domain?: string; /** - * Required. A unique session identification string. A session is defined - * as the duration of an end user's interaction with the service over a - * certain period. Obfuscate this field for privacy concerns before - * providing it to the service. If this field is not available for some - * reason, send "UNKNOWN". Note that any improvements to the model - * for a particular tenant site, rely on this field being set correctly to - * some unique session_id. The maximum number of allowed characters is 255. + * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. */ sessionId?: string; /** - * Required. A unique user identification string, as determined by the - * client. To have the strongest positive impact on search quality make sure - * the client-level is unique. Obfuscate this field for privacy concerns - * before providing it to the service. If this field is not available for - * some reason, send "UNKNOWN". Note that any improvements to the - * model for a particular tenant site, rely on this field being set - * correctly to a unique user_id. The maximum number of allowed characters - * is 255. + * Required. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to a unique user_id. The maximum number of allowed characters is 255. */ userId?: string; } /** - * Output only. Additional information returned to client, such as debugging - * information. + * Output only. Additional information returned to client, such as debugging information. */ export interface Schema$ResponseMetadata { /** - * A unique id associated with this call. This id is logged for tracking - * purposes. + * A unique id associated with this call. This id is logged for tracking purposes. */ requestId?: string; } @@ -1514,37 +1050,15 @@ export namespace jobs_v3 { */ export interface Schema$SearchJobsRequest { /** - * Optional. Controls whether to disable exact keyword match on - * Job.job_title, Job.description, Job.company_display_name, Job.locations, - * Job.qualifications. When disable keyword match is turned off, a keyword - * match returns jobs that do not match given category filters when there - * are matching keywords. For example, the query "program - * manager," a result is returned even if the job posting has the title - * "software developer," which does not fall into "program - * manager" ontology, but does have "program manager" - * appearing in its description. For queries like "cloud" that - * does not contain title or location specific ontology, jobs with - * "cloud" keyword matches are returned regardless of this - * flag's value. Please use Company.keyword_searchable_custom_fields or - * Company.keyword_searchable_custom_attributes if company specific globally - * matched custom field/attribute string values is needed. Enabling keyword - * match improves recall of subsequent search requests. Defaults to false. + * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. */ disableKeywordMatch?: boolean; /** - * Optional. Controls whether highly similar jobs are returned next to each - * other in the search results. Jobs are identified as highly similar based - * on their titles, job categories, and locations. Highly similar results - * are clustered so that only one representative job of the cluster is - * displayed to the job seeker higher up in the results, with the other jobs - * being displayed lower down in the results. Defaults to - * DiversificationLevel.SIMPLE if no value is specified. + * Optional. Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. */ diversificationLevel?: string; /** - * Optional. Controls whether to broaden the search when it produces sparse - * results. Broadened queries append results to the end of the matching - * results list. Defaults to false. + * Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. */ enableBroadening?: boolean; /** @@ -1552,74 +1066,35 @@ export namespace jobs_v3 { */ histogramFacets?: Schema$HistogramFacets; /** - * Optional. Query used to search against jobs, such as keyword, location - * filters, etc. + * Optional. Query used to search against jobs, such as keyword, location filters, etc. */ jobQuery?: Schema$JobQuery; /** - * Optional. The desired job attributes returned for jobs in the search - * response. Defaults to JobView.SMALL if no value is specified. + * Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. */ jobView?: string; /** - * Optional. An integer that specifies the current offset (that is, - * starting result location, amongst the jobs deemed by the API as relevant) - * in search results. This field is only considered if page_token is unset. - * For example, 0 means to return results starting from the first matching - * job, and 10 means to return from the 11th job. This can be used for - * pagination, (for example, pageSize = 10 and offset = 10 means to return - * from the second page). + * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ offset?: number; /** - * Optional. The criteria determining how search results are sorted. - * Default is "relevance desc". Supported options are: * - * "relevance desc": By relevance descending, as determined by the - * API algorithms. Relevance thresholding of query results is only available - * with this ordering. * "posting`_`publish`_`time desc": By - * Job.posting_publish_time descending. * "posting`_`update`_`time - * desc": By Job.posting_update_time descending. * "title": - * By Job.title ascending. * "title desc": By Job.title - * descending. * "annualized`_`base`_`compensation": By job's - * CompensationInfo.annualized_base_compensation_range ascending. Jobs whose - * annualized base compensation is unspecified are put at the end of search - * results. * "annualized`_`base`_`compensation desc": By - * job's CompensationInfo.annualized_base_compensation_range descending. - * Jobs whose annualized base compensation is unspecified are put at the end - * of search results. * "annualized`_`total`_`compensation": By - * job's CompensationInfo.annualized_total_compensation_range ascending. - * Jobs whose annualized base compensation is unspecified are put at the end - * of search results. * "annualized`_`total`_`compensation desc": - * By job's CompensationInfo.annualized_total_compensation_range - * descending. Jobs whose annualized base compensation is unspecified are - * put at the end of search results. + * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * "posting`_`publish`_`time desc": By Job.posting_publish_time descending. * "posting`_`update`_`time desc": By Job.posting_update_time descending. * "title": By Job.title ascending. * "title desc": By Job.title descending. * "annualized`_`base`_`compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`base`_`compensation desc": By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation": By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation desc": By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. */ orderBy?: string; /** - * Optional. A limit on the number of jobs returned in the search results. - * Increasing this value above the default value of 10 can increase search - * response time. The value can be between 1 and 100. + * Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. */ pageSize?: number; /** - * Optional. The token specifying the current offset within search results. - * See SearchJobsResponse.next_page_token for an explanation of how to - * obtain the next set of query results. + * Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. */ pageToken?: string; /** - * Required. The meta information collected about the job searcher, used to - * improve the search quality of the service.. The identifiers, (such as - * `user_id`) are provided by users, and must be unique and consistent. + * Required. The meta information collected about the job searcher, used to improve the search quality of the service.. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent. */ requestMetadata?: Schema$RequestMetadata; /** - * Optional. Controls if the search job request requires the return of a - * precise count of the first 300 results. Setting this to `true` ensures - * consistency in the number of results per page. Best practice is to set - * this value to true if a client allows users to jump directly to a - * non-sequential search results page. Enabling this flag may adversely - * impact performance. Defaults to false. + * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. */ requirePreciseResultSize?: boolean; /** @@ -1632,31 +1107,19 @@ export namespace jobs_v3 { */ export interface Schema$SearchJobsResponse { /** - * If query broadening is enabled, we may append additional results from the - * broadened query. This number indicates how many of the jobs returned in - * the jobs field are from the broadened query. These results are always at - * the end of the jobs list. In particular, a value of 0, or if the field - * isn't set, all the jobs in the jobs list are from the original - * (without broadening) query. If this field is non-zero, subsequent - * requests with offset after this result set should contain all broadened - * results. + * If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results. */ broadenedQueryJobsCount?: number; /** - * An estimation of the number of jobs that match the specified query. This - * number is not guaranteed to be accurate. For accurate results, see - * enable_precise_result_size. + * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see enable_precise_result_size. */ estimatedTotalSize?: number; /** - * The histogram results that match specified - * SearchJobsRequest.histogram_facets. + * The histogram results that match specified SearchJobsRequest.histogram_facets. */ histogramResults?: Schema$HistogramResults; /** - * The location filters that the service applied to the specified query. If - * any filters are lat-lng based, the JobLocation.location_type is - * JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + * The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. */ locationFilters?: Schema$Location[]; /** @@ -1664,13 +1127,11 @@ export namespace jobs_v3 { */ matchingJobs?: Schema$MatchingJob[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** - * The token that specifies the starting position of the next page of - * results. This field is empty if there are no more results. + * The token that specifies the starting position of the next page of results. This field is empty if there are no more results. */ nextPageToken?: string; /** @@ -1678,9 +1139,7 @@ export namespace jobs_v3 { */ spellCorrection?: Schema$SpellingCorrection; /** - * The precise result count, which is available only if the client set - * enable_precise_result_size to `true`, or if the response is the last page - * of results. Otherwise, the value is `-1`. + * The precise result count, which is available only if the client set enable_precise_result_size to `true`, or if the response is the last page of results. Otherwise, the value is `-1`. */ totalSize?: number; } @@ -1698,15 +1157,11 @@ export namespace jobs_v3 { correctedText?: string; } /** - * Represents a time of day. The date and time zone are either not significant - * or are specified elsewhere. An API may choose to allow leap seconds. - * Related types are google.type.Date and `google.protobuf.Timestamp`. + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - * to allow the value "24:00:00" for scenarios like business - * closing time. + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number; /** @@ -1718,8 +1173,7 @@ export namespace jobs_v3 { */ nanos?: number; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may - * allow the value 60 if it allows leap-seconds. + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number; } @@ -1741,16 +1195,11 @@ export namespace jobs_v3 { */ export interface Schema$UpdateCompanyRequest { /** - * Required. The company resource to replace the current resource in the - * system. + * Required. The company resource to replace the current resource in the system. */ company?: Schema$Company; /** - * Optional but strongly recommended for the best service experience. If - * update_mask is provided, only the specified fields in company are - * updated. Otherwise all the fields are updated. A field mask to specify - * the company fields to be updated. Only top level fields of Company are - * supported. + * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported. */ updateMask?: string; } @@ -1763,11 +1212,7 @@ export namespace jobs_v3 { */ job?: Schema$Job; /** - * Optional but strongly recommended to be provided for the best service - * experience. If update_mask is provided, only the specified fields in job - * are updated. Otherwise all the fields are updated. A field mask to - * restrict the fields that are updated. Only top level fields of Job are - * supported. + * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. */ updateMask?: string; } @@ -1786,8 +1231,7 @@ export namespace jobs_v3 { /** * jobs.projects.complete - * @desc Completes the specified prefix with keyword suggestions. Intended - * for use by a job search auto-complete search box. + * @desc Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box. * @alias jobs.projects.complete * @memberOf! () * @@ -1879,40 +1323,19 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. If provided, restricts completion to specified company. The - * format is "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ companyName?: string; /** - * Deprecated. Use language_codes instead. Optional. The language of the - * query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". - * For more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with the same language_code - * are returned. For CompletionType.COMPANY_NAME type, only companies - * having open jobs with the same language_code are returned. For - * CompletionType.COMBINED type, only open jobs with the same language_code - * or companies having open jobs with the same language_code are returned. - * The maximum number of allowed characters is 255. + * Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. */ languageCode?: string; /** - * Optional. The list of languages of the query. This is the BCP-47 - * language code, such as "en-US" or "sr-Latn". For more information, see - * [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with the same - * language_codes are returned. For CompletionType.COMPANY_NAME type, only - * companies having open jobs with the same language_codes are returned. For - * CompletionType.COMBINED type, only open jobs with the same language_codes - * or companies having open jobs with the same language_codes are returned. - * The maximum number of allowed characters is 255. + * Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. */ languageCodes?: string[]; /** - * Required. Resource name of project the completion is performed within. - * The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ name?: string; /** @@ -1920,13 +1343,11 @@ export namespace jobs_v3 { */ pageSize?: number; /** - * Required. The query used to generate suggestions. The maximum number of - * allowed characters is 255. + * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. */ query?: string; /** - * Optional. The scope of the completion. The defaults is - * CompletionScope.PUBLIC. + * Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. */ scope?: string; /** @@ -1943,12 +1364,7 @@ export namespace jobs_v3 { /** * jobs.projects.clientEvents.create - * @desc Report events issued when end user interacts with customer's - * application that uses Cloud Talent Solution. You may inspect the created - * events in [self service - * tools](https://console.cloud.google.com/talent-solution/overview). [Learn - * more](https://cloud.google.com/talent-solution/docs/management-tools) - * about self service tools. + * @desc Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools. * @alias jobs.projects.clientEvents.create * @memberOf! () * @@ -2121,8 +1537,7 @@ export namespace jobs_v3 { /** * jobs.projects.companies.delete - * @desc Deletes specified company. Prerequisite: The company has no jobs - * associated with it. + * @desc Deletes specified company. Prerequisite: The company has no jobs associated with it. * @alias jobs.projects.companies.delete * @memberOf! () * @@ -2339,9 +1754,7 @@ export namespace jobs_v3 { /** * jobs.projects.companies.patch - * @desc Updates specified company. Company names can't be updated. To - * update a company name, delete the company and all jobs associated with - * it, and only then re-create them. + * @desc Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them. * @alias jobs.projects.companies.patch * @memberOf! () * @@ -2418,9 +1831,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the project under which the company is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -2437,9 +1848,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the company to be deleted. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } @@ -2451,9 +1860,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the company to be retrieved. The format - * is "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } @@ -2465,8 +1872,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of companies to be returned, at most 100. - * Default is 100 if a non-positive number is provided. + * Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. */ pageSize?: number; /** @@ -2474,15 +1880,11 @@ export namespace jobs_v3 { */ pageToken?: string; /** - * Required. Resource name of the project under which the company is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; /** - * Optional. Set to true if the companies requested must have open jobs. - * Defaults to false. If true, at most page_size of companies are fetched, - * among which only those with open jobs are returned. + * Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. */ requireOpenJobs?: boolean; } @@ -2494,10 +1896,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required during company update. The resource name for a company. This is - * generated by the service when a company is created. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; @@ -2588,8 +1987,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.create - * @desc Creates a new job. Typically, the job becomes searchable within 10 - * seconds, but it may take up to 5 minutes. + * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. * @alias jobs.projects.jobs.create * @memberOf! () * @@ -2659,8 +2057,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.delete - * @desc Deletes the specified job. Typically, the job becomes unsearchable - * within 10 seconds, but it may take up to 5 minutes. + * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. * @alias jobs.projects.jobs.delete * @memberOf! () * @@ -2729,8 +2126,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.get - * @desc Retrieves the specified job, whose status is OPEN or recently - * EXPIRED within the last 90 days. + * @desc Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days. * @alias jobs.projects.jobs.get * @memberOf! () * @@ -2874,8 +2270,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.patch - * @desc Updates specified job. Typically, updated contents become visible - * in search results within 10 seconds, but it may take up to 5 minutes. + * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. * @alias jobs.projects.jobs.patch * @memberOf! () * @@ -2945,9 +2340,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.search - * @desc Searches for jobs using the provided SearchJobsRequest. This call - * constrains the visibility of jobs present in the database, and only - * returns jobs that the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. * @alias jobs.projects.jobs.search * @memberOf! () * @@ -3022,13 +2415,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.searchForAlert - * @desc Searches for jobs using the provided SearchJobsRequest. This API - * call is intended for the use case of targeting passive job seekers (for - * example, job seekers who have signed up to receive email alerts about - * potential job opportunities), and has different algorithmic adjustments - * that are targeted to passive job seekers. This call constrains the - * visibility of jobs present in the database, and only returns jobs the - * caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. * @alias jobs.projects.jobs.searchForAlert * @memberOf! () * @@ -3112,9 +2499,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project under which the job is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3131,9 +2516,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project under which the job is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3150,9 +2533,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the job to be deleted. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } @@ -3164,9 +2545,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the job to retrieve. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } @@ -3178,23 +2557,15 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The filter string specifies the jobs to be enumerated. - * Supported operator: =, AND The fields eligible for filtering are: * - * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * - * companyName = "projects/api-test-project/companies/123" * companyName = - * "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string; /** - * Optional. The desired job attributes returned for jobs in the search - * response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. + * Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. */ jobView?: string; /** - * Optional. The maximum number of jobs to be returned per page of results. - * If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page - * size is 1000. Otherwise, the maximum allowed page size is 100. Default - * is 100 if empty or a number < 1 is specified. + * Optional. The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. */ pageSize?: number; /** @@ -3202,9 +2573,7 @@ export namespace jobs_v3 { */ pageToken?: string; /** - * Required. The resource name of the project under which the job is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; } @@ -3216,12 +2585,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required during job update. The resource name for the job. This is - * generated by the service when a job is created. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". Use of this field in job queries - * and API calls is preferred over the use of requisition_id since this - * value is unique. + * Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; @@ -3238,8 +2602,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project to search within. The format - * is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3256,8 +2619,7 @@ export namespace jobs_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project to search within. The format - * is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index cbec899a47a..e67edfeb3c2 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace jobs_v3p1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace jobs_v3p1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace jobs_v3p1beta1 { /** * Cloud Talent Solution API * - * Cloud Talent Solution provides the capability to create, read, update, and - * delete job postings, as well as search jobs based on keywords and filters. + * Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace jobs_v3p1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,26 +122,15 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$ApplicationInfo { /** - * Optional but at least one of uris, emails or instruction must be - * specified. Use this field to specify email address(es) to which resumes - * or applications can be sent. The maximum number of allowed characters - * for each entry is 255. + * Optional but at least one of uris, emails or instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255. */ emails?: string[]; /** - * Optional but at least one of uris, emails or instruction must be - * specified. Use this field to provide instructions, such as "Mail - * your application to ...", that a candidate can follow to apply for - * the job. This field accepts and sanitizes HTML input, and also accepts - * bold, italic, ordered list, and unordered list markup tags. The maximum - * number of allowed characters is 3,000. + * Optional but at least one of uris, emails or instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. */ instruction?: string; /** - * Optional but at least one of uris, emails or instruction must be - * specified. Use this URI field to direct an applicant to a website, for - * example to link to an online application form. The maximum number of - * allowed characters for each entry is 2,000. + * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. */ uris?: string[]; } @@ -152,11 +139,7 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$BatchDeleteJobsRequest { /** - * Required. The filter string specifies the jobs to be deleted. Supported - * operator: =, AND The fields eligible for filtering are: * `companyName` - * (Required) * `requisitionId` (Required) Sample Query: companyName = - * "projects/api-test-project/companies/123" AND requisitionId = - * "req-1" + * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string; } @@ -169,8 +152,7 @@ export namespace jobs_v3p1beta1 { */ count?: number; /** - * Bucket range on which histogram was performed for the numeric field, that - * is, the count represents number of jobs in this range. + * Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range. */ range?: Schema$BucketRange; } @@ -188,12 +170,7 @@ export namespace jobs_v3p1beta1 { to?: number; } /** - * An event issued when an end user interacts with the application that - * implements Cloud Talent Solution. Providing this information improves the - * quality of search and recommendation for the API clients, enabling the - * service to perform optimally. The number of events sent must be consistent - * with other calls, such as job searches, issued to the service by the - * client. + * An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client. */ export interface Schema$ClientEvent { /** @@ -201,34 +178,23 @@ export namespace jobs_v3p1beta1 { */ createTime?: string; /** - * Required. A unique identifier, generated by the client application. This - * `event_id` is used to establish the relationship between different events - * (see parent_event_id). + * Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id). */ eventId?: string; /** - * Optional. Extra information about this event. Used for storing - * information with no matching field in event payload, for example, user - * application specific context or details. At most 20 keys are supported. - * The maximum total size of all keys and values is 2 KB. + * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. */ extraInfo?: {[key: string]: string}; /** - * A event issued when a job seeker interacts with the application that - * implements Cloud Talent Solution. + * A event issued when a job seeker interacts with the application that implements Cloud Talent Solution. */ jobEvent?: Schema$JobEvent; /** - * Optional. The event_id of an event that resulted in the current event. - * For example, a Job view event usually follows a parent impression event: - * A job seeker first does a search where a list of jobs appears - * (impression). The job seeker then selects a result and views the - * description of a particular job (Job view). + * Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view). */ parentEventId?: string; /** - * Required. A unique ID generated in the API responses. It can be found in - * ResponseMetadata.request_id. + * Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id. */ requestId?: string; } @@ -237,41 +203,27 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CommuteFilter { /** - * Optional. If true, jobs without "precise" addresses (street - * level addresses or GPS coordinates) might also be returned. For city and - * coarser level addresses, text matching is used. If this field is set to - * false or is not specified, only jobs that include precise addresses are - * returned by Commute Search. Note: If `allow_imprecise_addresses` is set - * to true, Commute Search is not able to calculate accurate commute times - * to jobs with city level and coarser address information. Jobs with - * imprecise addresses will return a `travel_duration` time of 0 regardless - * of distance from the job seeker. + * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. */ allowImpreciseAddresses?: boolean; /** - * Required. The method of transportation for which to calculate the - * commute time. + * Required. The method of transportation for which to calculate the commute time. */ commuteMethod?: string; /** - * Optional. The departure time used to calculate traffic impact, - * represented as google.type.TimeOfDay in local time zone. Currently - * traffic model is restricted to hour level resolution. + * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. */ departureTime?: Schema$TimeOfDay; /** - * Optional. Specifies the traffic density to use when calculating commute - * time. + * Optional. Specifies the traffic density to use when calculating commute time. */ roadTraffic?: string; /** - * Required. The latitude and longitude of the location from which to - * calculate the commute time. + * Required. The latitude and longitude of the location from which to calculate the commute time. */ startCoordinates?: Schema$LatLng; /** - * Required. The maximum travel time in seconds. The maximum allowed value - * is `3600s` (one hour). Format is `123s`. + * Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. */ travelDuration?: string; } @@ -284,23 +236,16 @@ export namespace jobs_v3p1beta1 { */ jobLocation?: Schema$Location; /** - * The number of seconds required to travel to the job location from the - * query location. A duration of 0 seconds indicates that the job is not - * reachable within the requested duration, but was returned as part of an - * expanded query. + * The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. */ travelDuration?: string; } /** - * A Company resource represents a company in the service. A company is the - * entity that owns job postings, that is, the hiring entity responsible for - * employing applicants for the job position. + * A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position. */ export interface Schema$Company { /** - * Optional. The URI to employer's career site or careers page on the - * employer's web site, for example, - * "https://careers.google.com". + * Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". */ careerSiteUri?: string; /** @@ -308,31 +253,23 @@ export namespace jobs_v3p1beta1 { */ derivedInfo?: Schema$CompanyDerivedInfo; /** - * Required. The display name of the company, for example, "Google, - * LLC". + * Required. The display name of the company, for example, "Google, LLC". */ displayName?: string; /** - * Optional. Equal Employment Opportunity legal disclaimer text to be - * associated with all jobs, and typically to be displayed in all roles. The - * maximum number of allowed characters is 500. + * Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. */ eeoText?: string; /** - * Required. Client side company identifier, used to uniquely identify the - * company. The maximum number of allowed characters is 255. + * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. */ externalId?: string; /** - * Optional. The street address of the company's main headquarters, - * which may be different from the job location. The service attempts to - * geolocate the provided address, and populates a more specific location - * wherever possible in DerivedInfo.headquarters_location. + * Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location. */ headquartersAddress?: string; /** - * Optional. Set to true if it is the hiring agency that post jobs for - * other employers. Defaults to false if not provided. + * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ hiringAgency?: boolean; /** @@ -340,19 +277,11 @@ export namespace jobs_v3p1beta1 { */ imageUri?: string; /** - * Optional. A list of keys of filterable Job.custom_attributes, whose - * corresponding `string_values` are used in keyword search. Jobs with - * `string_values` under these specified field keys are returned if any of - * the values matches the search keyword. Custom field values with - * parenthesis, brackets and special symbols won't be properly - * searchable, and those keyword queries need to be surrounded by quotes. + * Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes. */ keywordSearchableJobCustomAttributes?: string[]; /** - * Required during company update. The resource name for a company. This is - * generated by the service when a company is created. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; /** @@ -360,15 +289,11 @@ export namespace jobs_v3p1beta1 { */ size?: string; /** - * Output only. Indicates whether a company is flagged to be suspended from - * public availability by the service when job content appears suspicious, - * abusive, or spammy. + * Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. */ suspended?: boolean; /** - * Optional. The URI representing the company's primary web site or - * home page, for example, "https://www.google.com". The maximum - * number of allowed characters is 255. + * Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. */ websiteUri?: string; } @@ -377,18 +302,12 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CompanyDerivedInfo { /** - * A structured headquarters location of the company, resolved from - * Company.hq_location if provided. + * A structured headquarters location of the company, resolved from Company.hq_location if provided. */ headquartersLocation?: Schema$Location; } /** - * A compensation entry that represents one component of compensation, such as - * base pay, bonus, or other compensation type. Annualization: One - * compensation entry can be annualized if - it contains valid amount or - * range. - and its expected_units_per_year is set or can be derived. Its - * annualized range is determined as (amount or range) times - * expected_units_per_year. + * A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$CompensationEntry { /** @@ -396,15 +315,11 @@ export namespace jobs_v3p1beta1 { */ amount?: Schema$Money; /** - * Optional. Compensation description. For example, could indicate equity - * terms or provide additional context to an estimated bonus. + * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ description?: string; /** - * Optional. Expected number of units paid each year. If not specified, - * when Job.employment_types is FULLTIME, a default value is inferred based - * on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - - * MONTHLY: 12 - ANNUAL: 1 + * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 */ expectedUnitsPerYear?: number; /** @@ -412,13 +327,11 @@ export namespace jobs_v3p1beta1 { */ range?: Schema$CompensationRange; /** - * Optional. Compensation type. Default is - * CompensationUnit.OTHER_COMPENSATION_TYPE. + * Optional. Compensation type. Default is CompensationUnit.OTHER_COMPENSATION_TYPE. */ type?: string; /** - * Optional. Frequency of the specified amount. Default is - * CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. */ unit?: string; } @@ -427,8 +340,7 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CompensationFilter { /** - * Optional. Whether to include jobs whose compensation range is - * unspecified. + * Optional. Whether to include jobs whose compensation range is unspecified. */ includeJobsWithUnspecifiedCompensationRange?: boolean; /** @@ -440,8 +352,7 @@ export namespace jobs_v3p1beta1 { */ type?: string; /** - * Required. Specify desired `base compensation entry's` - * CompensationInfo.CompensationUnit. + * Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit. */ units?: string[]; } @@ -450,14 +361,11 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CompensationHistogramRequest { /** - * Required. Numeric histogram options, like buckets, whether include min - * or max value. + * Required. Numeric histogram options, like buckets, whether include min or max value. */ bucketingOption?: Schema$NumericBucketingOption; /** - * Required. Type of the request, representing which field the - * histogramming should be performed over. A single request can only specify - * one histogram of each `CompensationHistogramRequestType`. + * Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`. */ type?: string; } @@ -479,23 +387,15 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CompensationInfo { /** - * Output only. Annualized base compensation range. Computed as base - * compensation entry's CompensationEntry.compensation times - * CompensationEntry.expected_units_per_year. See CompensationEntry for - * explanation on compensation annualization. + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedBaseCompensationRange?: Schema$CompensationRange; /** - * Output only. Annualized total compensation range. Computed as all - * compensation entries' CompensationEntry.compensation times - * CompensationEntry.expected_units_per_year. See CompensationEntry for - * explanation on compensation annualization. + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedTotalCompensationRange?: Schema$CompensationRange; /** - * Optional. Job compensation information. At most one entry can be of - * type CompensationInfo.CompensationType.BASE, which is referred as ** base - * compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$CompensationEntry[]; } @@ -504,15 +404,11 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CompensationRange { /** - * Optional. The maximum amount of compensation. If left empty, the value - * is set to a maximal compensation value and the currency code is set to - * match the currency code of min_compensation. + * Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation. */ maxCompensation?: Schema$Money; /** - * Optional. The minimum amount of compensation. If left empty, the value - * is set to zero and the currency code is set to match the currency code of - * max_compensation. + * Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation. */ minCompensation?: Schema$Money; } @@ -525,8 +421,7 @@ export namespace jobs_v3p1beta1 { */ completionResults?: Schema$CompletionResult[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; } @@ -552,8 +447,7 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CreateClientEventRequest { /** - * Required. Events issued when end user interacts with customer's - * application that uses Cloud Talent Solution. + * Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution. */ clientEvent?: Schema$ClientEvent; } @@ -580,50 +474,32 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CustomAttribute { /** - * Optional. If the `filterable` flag is true, custom field values are - * searchable. If false, values are not searchable. Default is false. + * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ filterable?: boolean; /** - * Optional but exactly one of string_values or long_values must be - * specified. This field is used to perform number range search. (`EQ`, - * `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most - * 1 long_values is supported. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. */ longValues?: string[]; /** - * Optional but exactly one of string_values or long_values must be - * specified. This field is used to perform a string match - * (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For - * filterable `string_value`s, a maximum total number of 200 values is - * allowed, with each `string_value` has a byte size of no more than 255B. - * For unfilterable `string_values`, the maximum total byte size of - * unfilterable `string_values` is 50KB. Empty string is not allowed. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. */ stringValues?: string[]; } /** - * Custom attributes histogram request. An error is thrown if neither - * string_value_histogram or long_value_histogram_bucketing_option has been - * defined. + * Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined. */ export interface Schema$CustomAttributeHistogramRequest { /** - * Required. Specifies the custom field key to perform a histogram on. If - * specified without `long_value_histogram_bucketing_option`, histogram on - * string values of the given `key` is triggered, otherwise histogram is - * performed on long values. + * Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values. */ key?: string; /** - * Optional. Specifies buckets used to perform a range histogram on - * Job's filterable long custom field values, or min/max value - * requirements. + * Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements. */ longValueHistogramBucketingOption?: Schema$NumericBucketingOption; /** - * Optional. If set to true, the response includes the histogram value for - * each key as a string. + * Optional. If set to true, the response includes the histogram value for each key as a string. */ stringValueHistogram?: boolean; } @@ -636,13 +512,11 @@ export namespace jobs_v3p1beta1 { */ key?: string; /** - * Stores bucketed histogram counting result or min/max values for custom - * attribute long values associated with `key`. + * Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`. */ longValueHistogramResult?: Schema$NumericBucketingResult; /** - * Stores a map from the values of string custom field associated with `key` - * to the number of jobs with that value in this histogram result. + * Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result. */ stringValueHistogramResult?: {[key: string]: number}; } @@ -651,29 +525,16 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CustomRankingInfo { /** - * Required. Controls over how important the score of - * CustomRankingInfo.ranking_expression gets applied to job's final - * ranking position. An error is thrown if not specified. + * Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified. */ importanceLevel?: string; /** - * Required. Controls over how job documents get ranked on top of existing - * relevance score (determined by API algorithm). The product of ranking - * expression and relevance score is used to determine job's final - * ranking position. The syntax for this expression is a subset of Google - * SQL syntax. Supported operators are: +, -, *, /, where the left and - * right side of the operator is either a numeric Job.custom_attributes key, - * integer/double value or an expression that can be evaluated to a number. - * Parenthesis are supported to adjust calculation precedence. The - * expression must be < 100 characters in length. Sample ranking - * expression (year + 25) * 0.25 - (freshness / 0.5) + * Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). The product of ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5) */ rankingExpression?: string; } /** - * Device information collected from the job seeker, candidate, or other - * entity conducting the job search. Providing this information improves the - * quality of the search results across devices. + * Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices. */ export interface Schema$DeviceInfo { /** @@ -681,17 +542,12 @@ export namespace jobs_v3p1beta1 { */ deviceType?: string; /** - * Optional. A device-specific ID. The ID must be a unique identifier that - * distinguishes the device from other devices. + * Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. */ id?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -699,18 +555,15 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$HistogramFacets { /** - * Optional. Specifies compensation field-based histogram requests. - * Duplicate values of CompensationHistogramRequest.type are not allowed. + * Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed. */ compensationHistogramFacets?: Schema$CompensationHistogramRequest[]; /** - * Optional. Specifies the custom attributes histogram requests. Duplicate - * values of CustomAttributeHistogramRequest.key are not allowed. + * Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed. */ customAttributeHistogramFacets?: Schema$CustomAttributeHistogramRequest[]; /** - * Optional. Specifies the simple type of histogram facets, for example, - * `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. + * Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. */ simpleHistogramFacets?: string[]; } @@ -719,90 +572,16 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$HistogramQuery { /** - * An expression specifies a histogram request against matching resources - * (for example, jobs) for searches. Expression syntax is a aggregation - * function call with histogram facets and other options. Available - * aggregation function calls are: * `count(string_histogram_facet)`: Count - * the number of matching entity, for each distinct attribute value. * - * `count(numeric_histogram_facet, list of buckets)`: Count the number of - * matching entity within each bucket. Data types: * Histogram facet: - * facet names with format a-zA-Z+. * String: string like "any string - * with backslash escape for quote(\")." * Number: whole number - * and floating point number like 10, -1 and -0.01. * List: list of elements - * with comma(,) separator surrounded by square brackets. For example, [1, - * 2, 3] and ["one", "two", "three"]. Built-in - * constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX - * (maximum number similar to java Double.MAX_VALUE) Built-in functions: * - * bucket(start, end[, label]): bucket built-in function creates a bucket - * with range of start, end). Note that the end is exclusive. For example, - * bucket(1, MAX, "positive number") or bucket(1, 10). Job - * histogram facets: * company_id: histogram by - * [Job.distributor_company_id. * company_display_name: histogram by - * Job.company_display_name. * employment_type: histogram by - * Job.employment_types. For example, "FULL_TIME", - * "PART_TIME". * company_size: histogram by CompanySize, for - * example, "SMALL", "MEDIUM", "BIG". * - * publish_time_in_month: histogram by the Job.publish_time in months. Must - * specify list of numeric buckets in spec. * publish_time_in_year: - * histogram by the Job.publish_time in years. Must specify list of numeric - * buckets in spec. * degree_type: histogram by the Job.degree_type. For - * example, "Bachelors", "Masters". * job_level: - * histogram by the Job.job_level. For example, "Entry Level". * - * country: histogram by the country code of jobs. For example, - * "US", "FR". * admin1: histogram by the admin1 code of - * jobs, which is a global placeholder referring to the state, province, or - * the particular term a country uses to define the geographic structure - * below the country level. For example, "CA", "IL". * - * city: histogram by a combination of the "city name, admin1 - * code". For example, "Mountain View, CA", "New York, - * NY". * admin1_country: histogram by a combination of the - * "admin1 code, country". For example, "CA, US", - * "IL, US". * city_coordinate: histogram by the city center's - * GPS coordinates (latitude and longitude). For - * example, 37.4038522,-122.0987765. Since the coordinates of a city center - * can change, customers may need to refresh them periodically. * locale: - * histogram by the Job.language_code. For example, "en-US", - * "fr-FR". * language: histogram by the language subtag of the - * Job.language_code. For example, "en", "fr". * - * category: histogram by the JobCategory. For example, - * "COMPUTER_AND_IT", "HEALTHCARE". * - * base_compensation_unit: histogram by the CompensationUnit of base salary. - * For example, "WEEKLY", "MONTHLY". * - * base_compensation: histogram by the base salary. Must specify list of - * numeric buckets to group results by. * annualized_base_compensation: - * histogram by the base annualized salary. Must specify list of numeric - * buckets to group results by. * annualized_total_compensation: histogram - * by the total annualized salary. Must specify list of numeric buckets to - * group results by. * string_custom_attribute: histogram by string - * Job.custom_attributes. Values can be accessed via square bracket - * notations like string_custom_attribute["key1"]. * - * numeric_custom_attribute: histogram by numeric Job.custom_attributes. - * Values can be accessed via square bracket notations like - * numeric_custom_attribute["key1"]. Must specify list of numeric - * buckets to group results by. Example expressions: * count(admin1) * - * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), - * bucket(100000, MAX)]) * - * count(string_custom_attribute["some-string-custom-attribute"]) - * * - * count(numeric_custom_attribute["some-numeric-custom-attribute"], - * [bucket(MIN, 0, "negative"), bucket(0, MAX, - * "non-negative"]) + * An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like "any string with backslash escape for quote(\")." * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram facets: * company_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the Job.job_level. For example, "Entry Level". * country: histogram by the country code of jobs. For example, "US", "FR". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level. For example, "CA", "IL". * city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram by a combination of the "admin1 code, country". For example, "CA, US", "IL, US". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the CompensationUnit of base salary. For example, "WEEKLY", "MONTHLY". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by. Example expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute["some-string-custom-attribute"]) * count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"]) */ histogramQuery?: string; } /** - * Output only. Histogram result that matches HistogramSpec specified in - * searches. + * Output only. Histogram result that matches HistogramSpec specified in searches. */ export interface Schema$HistogramQueryResult { /** - * A map from the values of the facet associated with distinct values to the - * number of matching entries with corresponding value. The key format is: - * * (for string histogram) string values stored in the field. * (for named - * numeric bucket) name specified in `bucket()` function, like for - * `bucket(0, MAX, "non-negative")`, the key will be - * `non-negative`. * (for anonymous numeric bucket) range formatted as - * `<low>-<high>`, for example, `0-1000`, `MIN-0`, and `0-MAX`. + * A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: * (for string histogram) string values stored in the field. * (for named numeric bucket) name specified in `bucket()` function, like for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for example, `0-1000`, `MIN-0`, and `0-MAX`. */ histogram?: {[key: string]: string}; /** @@ -811,10 +590,7 @@ export namespace jobs_v3p1beta1 { histogramQuery?: string; } /** - * Output only. Result of a histogram call. The response contains the - * histogram map for the search type specified by HistogramResult.field. The - * response is a map of each filter value to the corresponding count of jobs - * for that filter. + * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. */ export interface Schema$HistogramResult { /** @@ -822,59 +598,37 @@ export namespace jobs_v3p1beta1 { */ searchType?: string; /** - * A map from the values of field to the number of jobs with that value in - * this search result. Key: search type (filter names, such as the - * companyName). Values: the count of jobs that match the filter for this - * search. + * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ values?: {[key: string]: number}; } /** - * Output only. Histogram results that match HistogramFacets specified in - * SearchJobsRequest. + * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. */ export interface Schema$HistogramResults { /** - * Specifies compensation field-based histogram results that match - * HistogramFacets.compensation_histogram_requests. + * Specifies compensation field-based histogram results that match HistogramFacets.compensation_histogram_requests. */ compensationHistogramResults?: Schema$CompensationHistogramResult[]; /** - * Specifies histogram results for custom attributes that match - * HistogramFacets.custom_attribute_histogram_facets. + * Specifies histogram results for custom attributes that match HistogramFacets.custom_attribute_histogram_facets. */ customAttributeHistogramResults?: Schema$CustomAttributeHistogramResult[]; /** - * Specifies histogram results that matches - * HistogramFacets.simple_histogram_facets. + * Specifies histogram results that matches HistogramFacets.simple_histogram_facets. */ simpleHistogramResults?: Schema$HistogramResult[]; } /** - * A Job resource represents a job posting (also referred to as a "job - * listing" or "job requisition"). A job belongs to a Company, - * which is the hiring entity responsible for the job. + * A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. */ export interface Schema$Job { /** - * Optional but strongly recommended for the best service experience. - * Location(s) where the employer is looking to hire for this job posting. - * Specifying the full street address(es) of the hiring location enables - * better API results, especially job searches by commute time. At most 50 - * locations are allowed for best search performance. If a job has more - * locations, it is suggested to split it into multiple jobs with unique - * requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', - * 'ReqA-2', etc.) as multiple jobs with the same company_name, - * language_code and requisition_id are not allowed. If the original - * requisition_id must be preserved, a custom field should be used for - * storage. It is also suggested to group the locations that close to each - * other in the same job for better search experience. The maximum number - * of allowed characters is 500. + * Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. */ addresses?: string[]; /** - * Required. At least one field within ApplicationInfo must be specified. - * Job application information. + * Required. At least one field within ApplicationInfo must be specified. Job application information. */ applicationInfo?: Schema$ApplicationInfo; /** @@ -882,8 +636,7 @@ export namespace jobs_v3p1beta1 { */ companyDisplayName?: string; /** - * Required. The resource name of the company listing the job, such as - * "projects/api-test-project/companies/foo". + * Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo". */ companyName?: string; /** @@ -891,25 +644,15 @@ export namespace jobs_v3p1beta1 { */ compensationInfo?: Schema$CompensationInfo; /** - * Optional. A map of fields to hold both filterable and non-filterable - * custom job attributes that are not covered by the provided structured - * fields. The keys of the map are strings up to 64 bytes and must match - * the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At - * most 100 filterable and at most 100 unfilterable keys are supported. For - * filterable `string_values`, across all keys at most 200 values are - * allowed, with each string no more than 255 characters. For unfilterable - * `string_values`, the maximum total size of `string_values` across all - * keys is 50KB. + * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ customAttributes?: {[key: string]: Schema$CustomAttribute}; /** - * Optional. The desired education degrees for the job, such as Bachelors, - * Masters. + * Optional. The desired education degrees for the job, such as Bachelors, Masters. */ degreeTypes?: string[]; /** - * Optional. The department or functional area within the company with the - * open position. The maximum number of allowed characters is 255. + * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ department?: string; /** @@ -917,24 +660,15 @@ export namespace jobs_v3p1beta1 { */ derivedInfo?: Schema$JobDerivedInfo; /** - * Required. The description of the job, which typically includes a - * multi-paragraph description of the company and related information. - * Separate fields are provided on the job object for responsibilities, - * qualifications, and other job characteristics. Use of these separate job - * fields is recommended. This field accepts and sanitizes HTML input, and - * also accepts bold, italic, ordered list, and unordered list markup tags. - * The maximum number of allowed characters is 100,000. + * Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. */ description?: string; /** - * Optional. The employment type(s) of a job, for example, full time or - * part time. + * Optional. The employment type(s) of a job, for example, full time or part time. */ employmentTypes?: string[]; /** - * Optional. A description of bonus, commission, and other compensation - * incentives associated with the job not including salary or pay. The - * maximum number of allowed characters is 10,000. + * Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. */ incentives?: string; /** @@ -942,39 +676,23 @@ export namespace jobs_v3p1beta1 { */ jobBenefits?: string[]; /** - * Optional. The end timestamp of the job. Typically this field is used for - * contracting engagements. Invalid timestamps are ignored. + * Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ jobEndTime?: string; /** - * Optional. The experience level associated with the job, such as - * "Entry Level". + * Optional. The experience level associated with the job, such as "Entry Level". */ jobLevel?: string; /** - * Optional. The start timestamp of the job in UTC time zone. Typically - * this field is used for contracting engagements. Invalid timestamps are - * ignored. + * Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. */ jobStartTime?: string; /** - * Optional. The language of the posting. This field is distinct from any - * requirements for fluency that are associated with the job. Language - * codes must be in BCP-47 format, such as "en-US" or - * "sr-Latn". For more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47){: - * class="external" target="_blank" }. If this field is - * unspecified and Job.description is present, detected language code based - * on Job.description is assigned, otherwise defaults to 'en_US'. + * Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ languageCode?: string; /** - * Required during job update. The resource name for the job. This is - * generated by the service when a job is created. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". Use of this field in - * job queries and API calls is preferred over the use of requisition_id - * since this value is unique. + * Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; /** @@ -982,46 +700,15 @@ export namespace jobs_v3p1beta1 { */ postingCreateTime?: string; /** - * Optional but strongly recommended for the best service experience. The - * expiration timestamp of the job. After this timestamp, the job is marked - * as expired, and it no longer appears in search results. The expired job - * can't be deleted or listed by the DeleteJob and ListJobs APIs, but it - * can be retrieved with the GetJob API or updated with the UpdateJob API. - * An expired job can be updated and opened again by using a future - * expiration timestamp. Updating an expired job fails if there is another - * existing open job with same company_name, language_code and - * requisition_id. The expired jobs are retained in our system for 90 days. - * However, the overall expired job count cannot exceed 3 times the maximum - * of open jobs count over the past week, otherwise jobs with earlier expire - * time are cleaned first. Expired jobs are no longer accessible after they - * are cleaned out. Invalid timestamps are ignored, and treated as expire - * time not provided. Timestamp before the instant request is made is - * considered valid, the job will be treated as expired immediately. If - * this value is not provided at the time of job creation or is invalid, the - * job posting expires after 30 days from the job's creation time. For - * example, if the job was created on 2017/01/01 13:00AM UTC with an - * unspecified expiration date, the job expires after 2017/01/31 13:00AM - * UTC. If this value is not provided on job update, it depends on the - * field masks set by UpdateJobRequest.update_mask. If the field masks - * include expiry_time, or the masks are empty meaning that every field is - * updated, the job posting expires after 30 days from the job's last - * update time. Otherwise the expiration date isn't updated. + * Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company_name, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ postingExpireTime?: string; /** - * Optional. The timestamp this job posting was most recently published. - * The default value is the time the request arrives at the server. Invalid - * timestamps are ignored. + * Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. */ postingPublishTime?: string; /** - * Optional. The job PostingRegion (for example, state, country) throughout - * which the job is available. If this field is set, a LocationFilter in a - * search query within the job region finds this job posting if an exact - * location match isn't specified. If this field is set to - * PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job - * Job.addresses to the same location level as this field is strongly - * recommended. + * Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. */ postingRegion?: string; /** @@ -1033,47 +720,27 @@ export namespace jobs_v3p1beta1 { */ processingOptions?: Schema$ProcessingOptions; /** - * Optional. A promotion value of the job, as determined by the client. The - * value determines the sort order of the jobs returned when searching for - * jobs using the featured jobs search call, with higher promotional values - * being returned first and ties being resolved by relevance sort. Only the - * jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. - * Default value is 0, and negative values are treated as 0. + * Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. */ promotionValue?: number; /** - * Optional. A description of the qualifications required to perform the - * job. The use of this field is recommended as an alternative to using the - * more general description field. This field accepts and sanitizes HTML - * input, and also accepts bold, italic, ordered list, and unordered list - * markup tags. The maximum number of allowed characters is 10,000. + * Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ qualifications?: string; /** - * Required. The requisition ID, also referred to as the posting ID, - * assigned by the client to identify a job. This field is intended to be - * used by clients for client identification and tracking of postings. A job - * is not allowed to be created if there is another job with the same - * [company_name], language_code and requisition_id. The maximum number of - * allowed characters is 255. + * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. */ requisitionId?: string; /** - * Optional. A description of job responsibilities. The use of this field - * is recommended as an alternative to using the more general description - * field. This field accepts and sanitizes HTML input, and also accepts - * bold, italic, ordered list, and unordered list markup tags. The maximum - * number of allowed characters is 10,000. + * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. */ responsibilities?: string; /** - * Required. The title of the job, such as "Software Engineer" - * The maximum number of allowed characters is 500. + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ title?: string; /** - * Optional. The visibility of the job. Defaults to - * Visibility.ACCOUNT_ONLY if not specified. + * Optional. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. */ visibility?: string; } @@ -1086,21 +753,16 @@ export namespace jobs_v3p1beta1 { */ jobCategories?: string[]; /** - * Structured locations of the job, resolved from Job.addresses. locations - * are exactly matched to Job.addresses in the same order. + * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. */ locations?: Schema$Location[]; } /** - * An event issued when a job seeker interacts with the application that - * implements Cloud Talent Solution. + * An event issued when a job seeker interacts with the application that implements Cloud Talent Solution. */ export interface Schema$JobEvent { /** - * Required. The job name(s) associated with this event. For example, if - * this is an impression event, this field contains the identifiers of all - * jobs shown to the job seeker. If this was a view event, this field - * contains the identifier of the viewed job. + * Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. */ jobs?: string[]; /** @@ -1113,122 +775,60 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$JobQuery { /** - * Optional. Allows filtering jobs by commute time with different travel - * methods (for example, driving or public transit). Note: This only works - * with COMMUTE MODE. When specified, [JobQuery.location_filters] is - * ignored. Currently we don't support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. */ commuteFilter?: Schema$CommuteFilter; /** - * Optional. This filter specifies the exact company display name of the - * jobs to search against. If a value isn't specified, jobs within the - * search results are associated with any company. If multiple values are - * specified, jobs within the search results may be associated with any of - * the specified companies. At most 20 company display name filters are - * allowed. + * Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. */ companyDisplayNames?: string[]; /** - * Optional. This filter specifies the company entities to search against. - * If a value isn't specified, jobs are searched for against all - * companies. If multiple values are specified, jobs are searched against - * the companies specified. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". At most 20 company - * filters are allowed. + * Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. */ companyNames?: string[]; /** - * Optional. This search filter is applied only to Job.compensation_info. - * For example, if the filter is specified as "Hourly job with per-hour - * compensation > $15", only jobs meeting these criteria are - * searched. If a filter isn't defined, all open jobs are searched. + * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the - * Job.custom_attributes marked as `filterable`. The syntax for this - * expression is a subset of SQL syntax. Supported operators are: `=`, - * `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator - * is a custom field key and the right of the operator is a number or a - * quoted string. You must escape backslash (\\) and quote (\") - * characters. Supported functions are `LOWER([field_name])` to perform a - * case insensitive match and `EMPTY([field_name])` to filter on the - * existence of a key. Boolean expressions (AND/OR/NOT) are supported up to - * 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND - * E"), a maximum of 100 comparisons or functions are allowed in the - * expression. The expression must be < 3000 bytes in length. Sample - * Query: `(LOWER(driving_license)="class \"a\"" OR - * EMPTY(driving_license)) AND driving_years > 10` + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 3000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` */ customAttributeFilter?: string; /** - * Optional. This flag controls the spell-check feature. If false, the - * service attempts to correct a misspelled query, for example, - * "enginee" is corrected to "engineer". Defaults to - * false: a spell check is performed. + * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. */ disableSpellCheck?: boolean; /** - * Optional. The employment type filter specifies the employment type of - * jobs to search against, such as EmploymentType.FULL_TIME. If a value is - * not specified, jobs in the search results includes any employment type. - * If multiple values are specified, jobs in the search results include any - * of the specified employment types. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ employmentTypes?: string[]; /** - * Optional. This filter specifies a list of job names to be excluded - * during search. At most 200 excluded job names are allowed. + * Optional. This filter specifies a list of job names to be excluded during search. At most 200 excluded job names are allowed. */ excludedJobs?: string[]; /** - * Optional. The category filter specifies the categories of jobs to search - * against. See Category for more information. If a value is not specified, - * jobs from any category are searched against. If multiple values are - * specified, jobs from any of the specified categories are searched - * against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ jobCategories?: string[]; /** - * Optional. This filter specifies the locale of jobs to search against, - * for example, "en-US". If a value isn't specified, the - * search results can contain jobs in any locale. Language codes should be - * in BCP-47 format, such as "en-US" or "sr-Latn". For - * more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47). At most 10 language code - * filters are allowed. + * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[]; /** - * Optional. The location filter specifies geo-regions containing the jobs - * to search against. See LocationFilter for more information. If a - * location value isn't specified, jobs fitting the other search - * criteria are retrieved regardless of where they're located. If - * multiple values are specified, jobs are retrieved from any of the - * specified locations. If different values are specified for the - * LocationFilter.distance_in_miles parameter, the maximum provided distance - * is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** - * Optional. Jobs published within a range specified by this filter are - * searched against. + * Optional. Jobs published within a range specified by this filter are searched against. */ publishTimeRange?: Schema$TimestampRange; /** - * Optional. The query string that matches against the job title, - * description, and location fields. The maximum number of allowed - * characters is 255. + * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ query?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -1249,8 +849,7 @@ export namespace jobs_v3p1beta1 { */ companies?: Schema$Company[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -1263,13 +862,11 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$ListJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is - * based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** @@ -1278,8 +875,7 @@ export namespace jobs_v3p1beta1 { nextPageToken?: string; } /** - * Output only. A resource that represents a location with full geographic - * information. + * Output only. A resource that represents a location with full geographic information. */ export interface Schema$Location { /** @@ -1287,25 +883,15 @@ export namespace jobs_v3p1beta1 { */ latLng?: Schema$LatLng; /** - * The type of a location, which corresponds to the address lines field of - * PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a - * type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" - * has a type of LocationType#LOCALITY. + * The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. */ locationType?: string; /** - * Postal address of the location that includes human readable information, - * such as postal delivery and payments addresses. Given a postal address, a - * postal service can deliver items to a premises, P.O. Box, or other - * delivery location. + * Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. */ postalAddress?: Schema$PostalAddress; /** - * Radius in miles of the job location. This value is derived from the - * location bounding box in which a circle with the specified radius - * centered from LatLng covers the area associated with the job location. - * For example, currently, "Mountain View, CA, USA" has a radius - * of 6.17 miles. + * Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. */ radiusInMiles?: number; } @@ -1314,46 +900,23 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$LocationFilter { /** - * Optional. The address name, such as "Mountain View" or - * "Bay Area". + * Optional. The address name, such as "Mountain View" or "Bay Area". */ address?: string; /** - * Optional. The distance_in_miles is applied when the location being - * searched for is identified as a city or smaller. When the location being - * searched for is a state or larger, this field is ignored. + * Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. */ distanceInMiles?: number; /** - * Optional. The latitude and longitude of the geographic center from which - * to search. This field's ignored if `address` is provided. + * Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if `address` is provided. */ latLng?: Schema$LatLng; /** - * Optional. CLDR region code of the country/region of the address. This is - * used to address ambiguity of the user-input location, for example, - * "Liverpool" against "Liverpool, NY, US" or - * "Liverpool, UK". Set this field if all the jobs to search - * against are from a same region, or jobs are world-wide, but the job - * seeker is from a specific region. See http://cldr.unicode.org/ and - * http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - * for details. Example: "CH" for Switzerland. + * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string; /** - * Optional. Allows the client to return jobs without a set location, - * specifically, telecommuting jobs (telecomuting is considered by the - * service as a special location. Job.posting_region indicates if a job - * permits telecommuting. If this field is set to - * TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are - * searched, and address and lat_lng are ignored. If not set or set to - * TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not - * searched. This filter can be used by itself to search exclusively for - * telecommuting jobs, or it can be combined with another location filter to - * search for a combination of job locations, such as "Mountain - * View" or "telecommuting" jobs. However, when used in - * combination with other location filters, telecommuting jobs can be - * treated as less relevant than other jobs in the search response. + * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ telecommutePreference?: string; } @@ -1370,21 +933,15 @@ export namespace jobs_v3p1beta1 { */ job?: Schema$Job; /** - * A summary of the job with core information that's displayed on the - * search results listing page. + * A summary of the job with core information that's displayed on the search results listing page. */ jobSummary?: string; /** - * Contains snippets of text from the Job.job_title field most closely - * matching a search query's keywords, if available. The matching query - * keywords are enclosed in HTML bold tags. + * Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags. */ jobTitleSnippet?: string; /** - * Contains snippets of text from the Job.description and similar fields - * that most closely match a search query's keywords, if available. All - * HTML tags in the original fields are stripped when returned in this - * field, and matching query keywords are enclosed in HTML bold tags. + * Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. */ searchTextSnippet?: string; } @@ -1397,35 +954,24 @@ export namespace jobs_v3p1beta1 { */ currencyCode?: string; /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ nanos?: number; /** - * The whole units of the amount. For example if `currencyCode` is - * `"USD"`, then 1 unit is one US dollar. + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ units?: string; } /** - * Input only. Use this field to specify bucketing option for the histogram - * search response. + * Input only. Use this field to specify bucketing option for the histogram search response. */ export interface Schema$NumericBucketingOption { /** - * Required. Two adjacent values form a histogram bucket. Values should be - * in ascending order. For example, if [5, 10, 15] are provided, four - * buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 - * [buckets_bound is supported. + * Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported. */ bucketBounds?: number[]; /** - * Optional. If set to true, the histogram result includes minimum/maximum - * value of the numeric field. + * Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field. */ requiresMinMax?: boolean; } @@ -1434,30 +980,24 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$NumericBucketingResult { /** - * Count within each bucket. Its size is the length of - * NumericBucketingOption.bucket_bounds plus 1. + * Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1. */ counts?: Schema$BucketizedCount[]; /** - * Stores the maximum value of the numeric field. Is populated only if - * [NumericBucketingOption.requires_min_max] is set to true. + * Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true. */ maxValue?: number; /** - * Stores the minimum value of the numeric field. Will be populated only if - * [NumericBucketingOption.requires_min_max] is set to true. + * Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. */ minValue?: number; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1465,91 +1005,36 @@ export namespace jobs_v3p1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * Represents a postal address, e.g. for postal delivery or payments - * addresses. Given a postal address, a postal service can deliver items to a - * premise, P.O. Box or similar. It is not intended to model geographical - * locations (roads, towns, mountains). In typical usage an address would be - * created via user input or from importing existing data, depending on the - * type of process. Advice on address input / editing: - Use an i18n-ready - * address widget such as https://github.com/googlei18n/libaddressinput) - - * Users should not be presented with UI elements for input or editing of - * fields outside countries where that field is used. For more guidance on - * how to use this schema, please see: - * https://support.google.com/business/answer/6397478 + * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/googlei18n/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. - * Because values in address_lines do not have type information and may - * sometimes contain multiple values in a single field (e.g. "Austin, - * TX"), it is important that the line order is clear. The order of - * address lines should be "envelope order" for the country/region - * of the address. In places where this can vary (e.g. Japan), - * address_language is used to make it explicit (e.g. "ja" for - * large-to-small ordering and "ja-Latn" or "en" for - * small-to-large). This way, the most specific line of an address can be - * selected based on the language. The minimum permitted structural - * representation of an address consists of a region_code with all remaining - * information placed in the address_lines. It would be possible to format - * such an address very approximately without geocoding, but no semantic - * reasoning could be made about any of the address components until it was - * at least partially resolved. Creating an address only containing a - * region_code and address_lines, and then geocoding is the recommended way - * to handle completely unstructured addresses (as opposed to guessing which - * parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[]; /** - * Optional. Highest administrative subdivision which is used for postal - * addresses of a country or region. For example, this can be a state, a - * province, an oblast, or a prefecture. Specifically, for Spain this is the - * province and not the autonomous community (e.g. "Barcelona" and - * not "Catalonia"). Many countries don't use an - * administrative area in postal addresses. E.g. in Switzerland this should - * be left unpopulated. + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. */ administrativeArea?: string; /** - * Optional. BCP-47 language code of the contents of this address (if - * known). This is often the UI language of the input form or is expected to - * match one of the languages used in the address' country/region, or - * their transliterated equivalents. This can affect formatting in certain - * countries, but is not critical to the correctness of the data and will - * never affect any validation or other non-formatting related operations. - * If this value is not known, it should be omitted (rather than specifying - * a possibly incorrect default). Examples: "zh-Hant", - * "ja", "ja-Latn", "en". + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ languageCode?: string; /** - * Optional. Generally refers to the city/town portion of the address. - * Examples: US city, IT comune, UK post town. In regions of the world where - * localities are not well defined or do not fit into this structure well, - * leave locality empty and use address_lines. + * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. */ locality?: string; /** @@ -1557,44 +1042,27 @@ export namespace jobs_v3p1beta1 { */ organization?: string; /** - * Optional. Postal code of the address. Not all countries use or require - * postal codes to be present, but where they are used, they may trigger - * additional validation with other parts of the address (e.g. state/zip - * validation in the U.S.A.). + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). */ postalCode?: string; /** - * Optional. The recipient at the address. This field may, under certain - * circumstances, contain multiline information. For example, it might - * contain "care of" information. + * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. */ recipients?: string[]; /** - * Required. CLDR region code of the country/region of the address. This is - * never inferred and it is up to the user to ensure the value is correct. - * See http://cldr.unicode.org/ and - * http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - * for details. Example: "CH" for Switzerland. + * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which - * is the latest revision. All new revisions **must** be backward - * compatible with old revisions. + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ revision?: number; /** - * Optional. Additional, country-specific, sorting code. This is not used in - * most regions. Where it is used, the value is either a string like - * "CEDEX", optionally followed by a number (e.g. "CEDEX - * 7"), or just a number alone, representing the "sector - * code" (Jamaica), "delivery area indicator" (Malawi) or - * "post office indicator" (e.g. Côte d'Ivoire). + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). */ sortingCode?: string; /** - * Optional. Sublocality of the address. For example, this can be - * neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. */ sublocality?: string; } @@ -1603,73 +1071,41 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$ProcessingOptions { /** - * Optional. If set to `true`, the service does not attempt to resolve a - * more precise address for the job. + * Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean; /** - * Optional. Option for job HTML content sanitization. Applied fields are: - * * description * applicationInfo.instruction * incentives * qualifications - * * responsibilities HTML tags in these fields may be stripped if - * sanitiazation is not disabled. Defaults to - * HtmlSanitization.SIMPLE_FORMATTING_ONLY. + * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ htmlSanitization?: string; } /** - * Input only. Meta information related to the job searcher or entity - * conducting the job search. This information is used to improve the - * performance of the service. + * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. */ export interface Schema$RequestMetadata { /** - * Optional. The type of device used by the job seeker at the time of the - * call to the service. + * Optional. The type of device used by the job seeker at the time of the call to the service. */ deviceInfo?: Schema$DeviceInfo; /** - * Required. The client-defined scope or source of the service call, which - * typically is the domain on which the service has been implemented and is - * currently being run. For example, if the service is being run by client - * <em>Foo, Inc.</em>, on job board www.foo.com and career site - * www.bar.com, then this field is set to "foo.com" for use on the - * job board, and "bar.com" for use on the career site. If this - * field isn't available for some reason, send "UNKNOWN". Any - * improvements to the model for a particular tenant site rely on this field - * being set correctly to a domain. The maximum number of allowed - * characters is 255. + * Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. */ domain?: string; /** - * Required. A unique session identification string. A session is defined - * as the duration of an end user's interaction with the service over a - * certain period. Obfuscate this field for privacy concerns before - * providing it to the service. If this field is not available for some - * reason, send "UNKNOWN". Note that any improvements to the model - * for a particular tenant site, rely on this field being set correctly to - * some unique session_id. The maximum number of allowed characters is 255. + * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. */ sessionId?: string; /** - * Required. A unique user identification string, as determined by the - * client. To have the strongest positive impact on search quality make sure - * the client-level is unique. Obfuscate this field for privacy concerns - * before providing it to the service. If this field is not available for - * some reason, send "UNKNOWN". Note that any improvements to the - * model for a particular tenant site, rely on this field being set - * correctly to a unique user_id. The maximum number of allowed characters - * is 255. + * Required. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to a unique user_id. The maximum number of allowed characters is 255. */ userId?: string; } /** - * Output only. Additional information returned to client, such as debugging - * information. + * Output only. Additional information returned to client, such as debugging information. */ export interface Schema$ResponseMetadata { /** - * A unique id associated with this call. This id is logged for tracking - * purposes. + * A unique id associated with this call. This id is logged for tracking purposes. */ requestId?: string; } @@ -1678,42 +1114,19 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$SearchJobsRequest { /** - * Optional. Controls over how job documents get ranked on top of existing - * relevance score (determined by API algorithm). + * Optional. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). */ customRankingInfo?: Schema$CustomRankingInfo; /** - * Optional. Controls whether to disable exact keyword match on - * Job.job_title, Job.description, Job.company_display_name, Job.locations, - * Job.qualifications. When disable keyword match is turned off, a keyword - * match returns jobs that do not match given category filters when there - * are matching keywords. For example, the query "program - * manager," a result is returned even if the job posting has the title - * "software developer," which does not fall into "program - * manager" ontology, but does have "program manager" - * appearing in its description. For queries like "cloud" that - * does not contain title or location specific ontology, jobs with - * "cloud" keyword matches are returned regardless of this - * flag's value. Please use Company.keyword_searchable_custom_fields or - * Company.keyword_searchable_custom_attributes if company specific globally - * matched custom field/attribute string values is needed. Enabling keyword - * match improves recall of subsequent search requests. Defaults to false. + * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. */ disableKeywordMatch?: boolean; /** - * Optional. Controls whether highly similar jobs are returned next to each - * other in the search results. Jobs are identified as highly similar based - * on their titles, job categories, and locations. Highly similar results - * are clustered so that only one representative job of the cluster is - * displayed to the job seeker higher up in the results, with the other jobs - * being displayed lower down in the results. Defaults to - * DiversificationLevel.SIMPLE if no value is specified. + * Optional. Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. */ diversificationLevel?: string; /** - * Optional. Controls whether to broaden the search when it produces sparse - * results. Broadened queries append results to the end of the matching - * results list. Defaults to false. + * Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. */ enableBroadening?: boolean; /** @@ -1721,93 +1134,39 @@ export namespace jobs_v3p1beta1 { */ histogramFacets?: Schema$HistogramFacets; /** - * Optional. Expression based histogram requests for jobs matching - * JobQuery. + * Optional. Expression based histogram requests for jobs matching JobQuery. */ histogramQueries?: Schema$HistogramQuery[]; /** - * Optional. Query used to search against jobs, such as keyword, location - * filters, etc. + * Optional. Query used to search against jobs, such as keyword, location filters, etc. */ jobQuery?: Schema$JobQuery; /** - * Optional. The desired job attributes returned for jobs in the search - * response. Defaults to JobView.SMALL if no value is specified. + * Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. */ jobView?: string; /** - * Optional. An integer that specifies the current offset (that is, - * starting result location, amongst the jobs deemed by the API as relevant) - * in search results. This field is only considered if page_token is unset. - * For example, 0 means to return results starting from the first matching - * job, and 10 means to return from the 11th job. This can be used for - * pagination, (for example, pageSize = 10 and offset = 10 means to return - * from the second page). + * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ offset?: number; /** - * Optional. The criteria determining how search results are sorted. - * Default is "relevance desc". Supported options are: * - * "relevance desc": By relevance descending, as determined by the - * API algorithms. Relevance thresholding of query results is only available - * with this ordering. * "posting`_`publish`_`time desc": By - * Job.posting_publish_time descending. * "posting`_`update`_`time - * desc": By Job.posting_update_time descending. * "title": - * By Job.title ascending. * "title desc": By Job.title - * descending. * "annualized`_`base`_`compensation": By job's - * CompensationInfo.annualized_base_compensation_range ascending. Jobs whose - * annualized base compensation is unspecified are put at the end of search - * results. * "annualized`_`base`_`compensation desc": By - * job's CompensationInfo.annualized_base_compensation_range descending. - * Jobs whose annualized base compensation is unspecified are put at the end - * of search results. * "annualized`_`total`_`compensation": By - * job's CompensationInfo.annualized_total_compensation_range ascending. - * Jobs whose annualized base compensation is unspecified are put at the end - * of search results. * "annualized`_`total`_`compensation desc": - * By job's CompensationInfo.annualized_total_compensation_range - * descending. Jobs whose annualized base compensation is unspecified are - * put at the end of search results. * "custom`_`ranking desc": By - * the relevance score adjusted to the - * SearchJobsRequest.custom_ranking_info.ranking_expression with weight - * factor assigned by SearchJobsRequest.custom_ranking_info.importance_level - * in descending order. * "location`_`distance": By the distance - * between the location on jobs and locations specified in the - * SearchJobsRequest.job_query.location_filters. When this order is - * selected, the SearchJobsRequest.job_query.location_filters must not be - * empty. When a job has multiple locations, the location closest to one of - * the locations specified in the location filter will be used to calculate - * location distance. Distance is calculated by the distance between two - * lat/long coordinates, with a precision of 10e-4 degrees (11.3 meters). - * Jobs that don't have locations specified will be ranked below jobs - * having locations. Diversification strategy is still applied unless - * explicitly disabled in SearchJobsRequest.diversification_level. + * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * "posting`_`publish`_`time desc": By Job.posting_publish_time descending. * "posting`_`update`_`time desc": By Job.posting_update_time descending. * "title": By Job.title ascending. * "title desc": By Job.title descending. * "annualized`_`base`_`compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`base`_`compensation desc": By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation": By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation desc": By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "custom`_`ranking desc": By the relevance score adjusted to the SearchJobsRequest.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.importance_level in descending order. * "location`_`distance": By the distance between the location on jobs and locations specified in the SearchJobsRequest.job_query.location_filters. When this order is selected, the SearchJobsRequest.job_query.location_filters must not be empty. When a job has multiple locations, the location closest to one of the locations specified in the location filter will be used to calculate location distance. Distance is calculated by the distance between two lat/long coordinates, with a precision of 10e-4 degrees (11.3 meters). Jobs that don't have locations specified will be ranked below jobs having locations. Diversification strategy is still applied unless explicitly disabled in SearchJobsRequest.diversification_level. */ orderBy?: string; /** - * Optional. A limit on the number of jobs returned in the search results. - * Increasing this value above the default value of 10 can increase search - * response time. The value can be between 1 and 100. + * Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. */ pageSize?: number; /** - * Optional. The token specifying the current offset within search results. - * See SearchJobsResponse.next_page_token for an explanation of how to - * obtain the next set of query results. + * Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. */ pageToken?: string; /** - * Required. The meta information collected about the job searcher, used to - * improve the search quality of the service.. The identifiers, (such as - * `user_id`) are provided by users, and must be unique and consistent. + * Required. The meta information collected about the job searcher, used to improve the search quality of the service.. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent. */ requestMetadata?: Schema$RequestMetadata; /** - * Optional. Controls if the search job request requires the return of a - * precise count of the first 300 results. Setting this to `true` ensures - * consistency in the number of results per page. Best practice is to set - * this value to true if a client allows users to jump directly to a - * non-sequential search results page. Enabling this flag may adversely - * impact performance. Defaults to false. + * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. */ requirePreciseResultSize?: boolean; /** @@ -1820,36 +1179,23 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$SearchJobsResponse { /** - * If query broadening is enabled, we may append additional results from the - * broadened query. This number indicates how many of the jobs returned in - * the jobs field are from the broadened query. These results are always at - * the end of the jobs list. In particular, a value of 0, or if the field - * isn't set, all the jobs in the jobs list are from the original - * (without broadening) query. If this field is non-zero, subsequent - * requests with offset after this result set should contain all broadened - * results. + * If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results. */ broadenedQueryJobsCount?: number; /** - * An estimation of the number of jobs that match the specified query. This - * number is not guaranteed to be accurate. For accurate results, see - * enable_precise_result_size. + * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see enable_precise_result_size. */ estimatedTotalSize?: number; /** - * The histogram results that match with specified - * SearchJobsRequest.histogram_queries. + * The histogram results that match with specified SearchJobsRequest.histogram_queries. */ histogramQueryResults?: Schema$HistogramQueryResult[]; /** - * The histogram results that match specified - * SearchJobsRequest.histogram_facets. + * The histogram results that match specified SearchJobsRequest.histogram_facets. */ histogramResults?: Schema$HistogramResults; /** - * The location filters that the service applied to the specified query. If - * any filters are lat-lng based, the JobLocation.location_type is - * JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + * The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. */ locationFilters?: Schema$Location[]; /** @@ -1857,13 +1203,11 @@ export namespace jobs_v3p1beta1 { */ matchingJobs?: Schema$MatchingJob[]; /** - * Additional information for the API invocation, such as the request - * tracking id. + * Additional information for the API invocation, such as the request tracking id. */ metadata?: Schema$ResponseMetadata; /** - * The token that specifies the starting position of the next page of - * results. This field is empty if there are no more results. + * The token that specifies the starting position of the next page of results. This field is empty if there are no more results. */ nextPageToken?: string; /** @@ -1871,9 +1215,7 @@ export namespace jobs_v3p1beta1 { */ spellCorrection?: Schema$SpellingCorrection; /** - * The precise result count, which is available only if the client set - * enable_precise_result_size to `true`, or if the response is the last page - * of results. Otherwise, the value is `-1`. + * The precise result count, which is available only if the client set enable_precise_result_size to `true`, or if the response is the last page of results. Otherwise, the value is `-1`. */ totalSize?: number; } @@ -1891,40 +1233,7 @@ export namespace jobs_v3p1beta1 { correctedText?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1932,27 +1241,20 @@ export namespace jobs_v3p1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Represents a time of day. The date and time zone are either not significant - * or are specified elsewhere. An API may choose to allow leap seconds. - * Related types are google.type.Date and `google.protobuf.Timestamp`. + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - * to allow the value "24:00:00" for scenarios like business - * closing time. + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number; /** @@ -1964,8 +1266,7 @@ export namespace jobs_v3p1beta1 { */ nanos?: number; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may - * allow the value 60 if it allows leap-seconds. + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number; } @@ -1987,16 +1288,11 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$UpdateCompanyRequest { /** - * Required. The company resource to replace the current resource in the - * system. + * Required. The company resource to replace the current resource in the system. */ company?: Schema$Company; /** - * Optional but strongly recommended for the best service experience. If - * update_mask is provided, only the specified fields in company are - * updated. Otherwise all the fields are updated. A field mask to specify - * the company fields to be updated. Only top level fields of Company are - * supported. + * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported. */ updateMask?: string; } @@ -2009,11 +1305,7 @@ export namespace jobs_v3p1beta1 { */ job?: Schema$Job; /** - * Optional but strongly recommended to be provided for the best service - * experience. If update_mask is provided, only the specified fields in job - * are updated. Otherwise all the fields are updated. A field mask to - * restrict the fields that are updated. Only top level fields of Job are - * supported. + * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. */ updateMask?: string; } @@ -2034,8 +1326,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.complete - * @desc Completes the specified prefix with keyword suggestions. Intended - * for use by a job search auto-complete search box. + * @desc Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box. * @alias jobs.projects.complete * @memberOf! () * @@ -2127,40 +1418,19 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. If provided, restricts completion to specified company. The - * format is "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ companyName?: string; /** - * Deprecated. Use language_codes instead. Optional. The language of the - * query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". - * For more information, see [Tags for Identifying - * Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with the same language_code - * are returned. For CompletionType.COMPANY_NAME type, only companies - * having open jobs with the same language_code are returned. For - * CompletionType.COMBINED type, only open jobs with the same language_code - * or companies having open jobs with the same language_code are returned. - * The maximum number of allowed characters is 255. + * Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. */ languageCode?: string; /** - * Optional. The list of languages of the query. This is the BCP-47 - * language code, such as "en-US" or "sr-Latn". For more information, see - * [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with the same - * language_codes are returned. For CompletionType.COMPANY_NAME type, only - * companies having open jobs with the same language_codes are returned. For - * CompletionType.COMBINED type, only open jobs with the same language_codes - * or companies having open jobs with the same language_codes are returned. - * The maximum number of allowed characters is 255. + * Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. */ languageCodes?: string[]; /** - * Required. Resource name of project the completion is performed within. - * The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ name?: string; /** @@ -2168,13 +1438,11 @@ export namespace jobs_v3p1beta1 { */ pageSize?: number; /** - * Required. The query used to generate suggestions. The maximum number of - * allowed characters is 255. + * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. */ query?: string; /** - * Optional. The scope of the completion. The defaults is - * CompletionScope.PUBLIC. + * Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. */ scope?: string; /** @@ -2191,12 +1459,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.clientEvents.create - * @desc Report events issued when end user interacts with customer's - * application that uses Cloud Talent Solution. You may inspect the created - * events in [self service - * tools](https://console.cloud.google.com/talent-solution/overview). [Learn - * more](https://cloud.google.com/talent-solution/docs/management-tools) - * about self service tools. + * @desc Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools. * @alias jobs.projects.clientEvents.create * @memberOf! () * @@ -2369,8 +1632,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.companies.delete - * @desc Deletes specified company. Prerequisite: The company has no jobs - * associated with it. + * @desc Deletes specified company. Prerequisite: The company has no jobs associated with it. * @alias jobs.projects.companies.delete * @memberOf! () * @@ -2587,9 +1849,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.companies.patch - * @desc Updates specified company. Company names can't be updated. To - * update a company name, delete the company and all jobs associated with - * it, and only then re-create them. + * @desc Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them. * @alias jobs.projects.companies.patch * @memberOf! () * @@ -2666,9 +1926,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the project under which the company is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -2685,9 +1943,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the company to be deleted. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } @@ -2699,9 +1955,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the company to be retrieved. The format - * is "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } @@ -2713,8 +1967,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of companies to be returned, at most 100. - * Default is 100 if a non-positive number is provided. + * Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. */ pageSize?: number; /** @@ -2722,15 +1975,11 @@ export namespace jobs_v3p1beta1 { */ pageToken?: string; /** - * Required. Resource name of the project under which the company is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; /** - * Optional. Set to true if the companies requested must have open jobs. - * Defaults to false. If true, at most page_size of companies are fetched, - * among which only those with open jobs are returned. + * Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. */ requireOpenJobs?: boolean; } @@ -2742,10 +1991,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required during company update. The resource name for a company. This is - * generated by the service when a company is created. The format is - * "projects/{project_id}/companies/{company_id}", for example, - * "projects/api-test-project/companies/foo". + * Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; @@ -2836,8 +2082,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.create - * @desc Creates a new job. Typically, the job becomes searchable within 10 - * seconds, but it may take up to 5 minutes. + * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. * @alias jobs.projects.jobs.create * @memberOf! () * @@ -2910,8 +2155,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.delete - * @desc Deletes the specified job. Typically, the job becomes unsearchable - * within 10 seconds, but it may take up to 5 minutes. + * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. * @alias jobs.projects.jobs.delete * @memberOf! () * @@ -2980,8 +2224,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.get - * @desc Retrieves the specified job, whose status is OPEN or recently - * EXPIRED within the last 90 days. + * @desc Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days. * @alias jobs.projects.jobs.get * @memberOf! () * @@ -3128,8 +2371,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.patch - * @desc Updates specified job. Typically, updated contents become visible - * in search results within 10 seconds, but it may take up to 5 minutes. + * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. * @alias jobs.projects.jobs.patch * @memberOf! () * @@ -3199,9 +2441,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.search - * @desc Searches for jobs using the provided SearchJobsRequest. This call - * constrains the visibility of jobs present in the database, and only - * returns jobs that the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. * @alias jobs.projects.jobs.search * @memberOf! () * @@ -3276,13 +2516,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.searchForAlert - * @desc Searches for jobs using the provided SearchJobsRequest. This API - * call is intended for the use case of targeting passive job seekers (for - * example, job seekers who have signed up to receive email alerts about - * potential job opportunities), and has different algorithmic adjustments - * that are targeted to passive job seekers. This call constrains the - * visibility of jobs present in the database, and only returns jobs the - * caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. * @alias jobs.projects.jobs.searchForAlert * @memberOf! () * @@ -3366,9 +2600,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project under which the job is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3385,9 +2617,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project under which the job is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3404,9 +2634,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the job to be deleted. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } @@ -3418,9 +2646,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the job to retrieve. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } @@ -3432,23 +2658,15 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The filter string specifies the jobs to be enumerated. - * Supported operator: =, AND The fields eligible for filtering are: * - * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * - * companyName = "projects/api-test-project/companies/123" * companyName = - * "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string; /** - * Optional. The desired job attributes returned for jobs in the search - * response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. + * Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. */ jobView?: string; /** - * Optional. The maximum number of jobs to be returned per page of results. - * If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page - * size is 1000. Otherwise, the maximum allowed page size is 100. Default - * is 100 if empty or a number < 1 is specified. + * Optional. The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. */ pageSize?: number; /** @@ -3456,9 +2674,7 @@ export namespace jobs_v3p1beta1 { */ pageToken?: string; /** - * Required. The resource name of the project under which the job is - * created. The format is "projects/{project_id}", for example, - * "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; } @@ -3470,12 +2686,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required during job update. The resource name for the job. This is - * generated by the service when a job is created. The format is - * "projects/{project_id}/jobs/{job_id}", for example, - * "projects/api-test-project/jobs/1234". Use of this field in job queries - * and API calls is preferred over the use of requisition_id since this - * value is unique. + * Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; @@ -3492,8 +2703,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project to search within. The format - * is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3510,8 +2720,7 @@ export namespace jobs_v3p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the project to search within. The format - * is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3529,9 +2738,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias jobs.projects.operations.get * @memberOf! () * diff --git a/src/apis/kgsearch/package.json b/src/apis/kgsearch/package.json index 753bb92f232..aaa6f90273b 100644 --- a/src/apis/kgsearch/package.json +++ b/src/apis/kgsearch/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/kgsearch/v1.ts b/src/apis/kgsearch/v1.ts index 7c9a990e94b..0178d066243 100644 --- a/src/apis/kgsearch/v1.ts +++ b/src/apis/kgsearch/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace kgsearch_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace kgsearch_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,20 +108,21 @@ export namespace kgsearch_v1 { entities: Resource$Entities; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.entities = new Resource$Entities(this.context); } } /** - * Response message includes the context and a list of matching results which - * contain the detail of associated entities. + * Response message includes the context and a list of matching results which contain the detail of associated entities. */ export interface Schema$SearchResponse { /** - * The local context applicable for the response. See more details at - * http://www.w3.org/TR/json-ld/#context-definitions. + * The local context applicable for the response. See more details at http://www.w3.org/TR/json-ld/#context-definitions. */ '@context'?: any; /** @@ -146,9 +143,7 @@ export namespace kgsearch_v1 { /** * kgsearch.entities.search - * @desc Searches Knowledge Graph for entities that match the constraints. A - * list of matched entities will be returned in response, which will be in - * JSON-LD format and compatible with http://schema.org + * @desc Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org * @alias kgsearch.entities.search * @memberOf! () * @@ -233,9 +228,7 @@ export namespace kgsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The list of entity id to be used for search instead of query string. To - * specify multiple ids in the HTTP request, repeat the parameter in the URL - * as in ...?ids=A&ids=B + * The list of entity id to be used for search instead of query string. To specify multiple ids in the HTTP request, repeat the parameter in the URL as in ...?ids=A&ids=B */ ids?: string[]; /** @@ -243,8 +236,7 @@ export namespace kgsearch_v1 { */ indent?: boolean; /** - * The list of language codes (defined in ISO 693) to run the query with, - * e.g. 'en'. + * The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. */ languages?: string[]; /** @@ -260,9 +252,7 @@ export namespace kgsearch_v1 { */ query?: string; /** - * Restricts returned entities with these types, e.g. Person (as defined in - * http://schema.org/Person). If multiple types are specified, returned - * entities will contain one or more of these types. + * Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types. */ types?: string[]; } diff --git a/src/apis/language/package.json b/src/apis/language/package.json index e9e5df4e95c..ecaea02a7dd 100644 --- a/src/apis/language/package.json +++ b/src/apis/language/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index 51bea795f20..41f8dbd6ab8 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace language_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace language_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace language_v1 { /** * Cloud Natural Language API * - * Provides natural language understanding technologies, such as sentiment - * analysis, entity recognition, entity sentiment analysis, and other text - * annotations, to developers. + * Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers. * * @example * const {google} = require('googleapis'); @@ -114,7 +108,10 @@ export namespace language_v1 { documents: Resource$Documents; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.documents = new Resource$Documents(this.context); } @@ -142,9 +139,7 @@ export namespace language_v1 { */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; } @@ -170,9 +165,7 @@ export namespace language_v1 { */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; } @@ -198,9 +191,7 @@ export namespace language_v1 { */ documentSentiment?: Schema$Sentiment; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** @@ -226,9 +217,7 @@ export namespace language_v1 { */ export interface Schema$AnalyzeSyntaxResponse { /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** @@ -241,8 +230,7 @@ export namespace language_v1 { tokens?: Schema$Token[]; } /** - * The request message for the text annotation API, which can perform multiple - * analysis types (sentiment, entities, and syntax) in one call. + * The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call. */ export interface Schema$AnnotateTextRequest { /** @@ -267,31 +255,23 @@ export namespace language_v1 { */ categories?: Schema$ClassificationCategory[]; /** - * The overall sentiment for the document. Populated if the user enables - * AnnotateTextRequest.Features.extract_document_sentiment. + * The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment. */ documentSentiment?: Schema$Sentiment; /** - * Entities, along with their semantic information, in the input document. - * Populated if the user enables - * AnnotateTextRequest.Features.extract_entities. + * Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities. */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** - * Sentences in the input document. Populated if the user enables - * AnnotateTextRequest.Features.extract_syntax. + * Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ sentences?: Schema$Sentence[]; /** - * Tokens, along with their syntactic information, in the input document. - * Populated if the user enables - * AnnotateTextRequest.Features.extract_syntax. + * Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ tokens?: Schema$Token[]; } @@ -300,13 +280,11 @@ export namespace language_v1 { */ export interface Schema$ClassificationCategory { /** - * The classifier's confidence of the category. Number represents how - * certain the classifier is that this category represents the given text. + * The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text. */ confidence?: number; /** - * The name of the category representing the document, from the [predefined - * taxonomy](/natural-language/docs/categories). + * The name of the category representing the document, from the [predefined taxonomy](/natural-language/docs/categories). */ name?: string; } @@ -329,17 +307,11 @@ export namespace language_v1 { categories?: Schema$ClassificationCategory[]; } /** - * Represents dependency parse tree information for a token. (For more - * information on dependency labels, see - * http://www.aclweb.org/anthology/P13-2017 + * Represents dependency parse tree information for a token. (For more information on dependency labels, see http://www.aclweb.org/anthology/P13-2017 */ export interface Schema$DependencyEdge { /** - * Represents the head of this token in the dependency tree. This is the - * index of the token which has an arc going to this token. The index is the - * position of the token in the array of tokens returned by the API method. - * If this token is a root token, then the `head_token_index` is its own - * index. + * Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index. */ headTokenIndex?: number; /** @@ -348,54 +320,36 @@ export namespace language_v1 { label?: string; } /** - * ################################################################ # - * Represents the input to API methods. + * ################################################################ # Represents the input to API methods. */ export interface Schema$Document { /** - * The content of the input in string format. Cloud audit logging exempt - * since it is based on user data. + * The content of the input in string format. Cloud audit logging exempt since it is based on user data. */ content?: string; /** - * The Google Cloud Storage URI where the file content is located. This URI - * must be of the form: gs://bucket_name/object_name. For more details, see - * https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage - * object versioning is not supported. + * The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported. */ gcsContentUri?: string; /** - * The language of the document (if not specified, the language is - * automatically detected). Both ISO and BCP-47 language codes are - * accepted.<br> [Language Support](/natural-language/docs/languages) - * lists currently supported languages for each API method. If the language - * (either specified by the caller or automatically detected) is not - * supported by the called API method, an `INVALID_ARGUMENT` error is - * returned. + * The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.<br> [Language Support](/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned. */ language?: string; /** - * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an - * `INVALID_ARGUMENT` error. + * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error. */ type?: string; } /** - * Represents a phrase in the text that is a known entity, such as a person, - * an organization, or location. The API associates information, such as - * salience and mentions, with entities. + * Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities. */ export interface Schema$Entity { /** - * The mentions of this entity in the input document. The API currently - * supports proper noun mentions. + * The mentions of this entity in the input document. The API currently supports proper noun mentions. */ mentions?: Schema$EntityMention[]; /** - * Metadata associated with the entity. For most entity types, the metadata - * is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if - * they are available. For the metadata associated with other entity types, - * see the Type table below. + * Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below. */ metadata?: {[key: string]: string}; /** @@ -403,17 +357,11 @@ export namespace language_v1 { */ name?: string; /** - * The salience score associated with the entity in the [0, 1.0] range. The - * salience score for an entity provides information about the importance or - * centrality of that entity to the entire document text. Scores closer to 0 - * are less salient, while scores closer to 1.0 are highly salient. + * The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. */ salience?: number; /** - * For calls to AnalyzeEntitySentiment or if - * AnnotateTextRequest.Features.extract_entity_sentiment is set to true, - * this field will contain the aggregate sentiment expressed for this entity - * in the provided document. + * For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document. */ sentiment?: Schema$Sentiment; /** @@ -422,15 +370,11 @@ export namespace language_v1 { type?: string; } /** - * Represents a mention for an entity in the text. Currently, proper noun - * mentions are supported. + * Represents a mention for an entity in the text. Currently, proper noun mentions are supported. */ export interface Schema$EntityMention { /** - * For calls to AnalyzeEntitySentiment or if - * AnnotateTextRequest.Features.extract_entity_sentiment is set to true, - * this field will contain the sentiment expressed for this mention of the - * entity in the provided document. + * For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document. */ sentiment?: Schema$Sentiment; /** @@ -443,8 +387,7 @@ export namespace language_v1 { type?: string; } /** - * All available features for sentiment, syntax, and semantic analysis. - * Setting each one to true will enable that specific analysis for the input. + * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. */ export interface Schema$Features { /** @@ -469,8 +412,7 @@ export namespace language_v1 { extractSyntax?: boolean; } /** - * Represents part of speech information for a token. Parts of speech are as - * defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf + * Represents part of speech information for a token. Parts of speech are as defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf */ export interface Schema$PartOfSpeech { /** @@ -527,9 +469,7 @@ export namespace language_v1 { */ export interface Schema$Sentence { /** - * For calls to AnalyzeSentiment or if - * AnnotateTextRequest.Features.extract_document_sentiment is set to true, - * this field will contain the sentiment for the sentence. + * For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence. */ sentiment?: Schema$Sentiment; /** @@ -538,57 +478,20 @@ export namespace language_v1 { text?: Schema$TextSpan; } /** - * Represents the feeling associated with the entire text or entities in the - * text. + * Represents the feeling associated with the entire text or entities in the text. */ export interface Schema$Sentiment { /** - * A non-negative number in the [0, +inf) range, which represents the - * absolute magnitude of sentiment regardless of score (positive or - * negative). + * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative). */ magnitude?: number; /** - * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - * sentiment). + * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ score?: number; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -596,14 +499,11 @@ export namespace language_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -612,8 +512,7 @@ export namespace language_v1 { */ export interface Schema$TextSpan { /** - * The API calculates the beginning offset of the content in the original - * document according to the EncodingType specified in the API request. + * The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request. */ beginOffset?: number; /** @@ -630,8 +529,7 @@ export namespace language_v1 { */ dependencyEdge?: Schema$DependencyEdge; /** - * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the - * token. + * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. */ lemma?: string; /** @@ -652,9 +550,7 @@ export namespace language_v1 { /** * language.documents.analyzeEntities - * @desc Finds named entities (currently proper names and common nouns) in - * the text along with entity types, salience, mentions for each entity, and - * other properties. + * @desc Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties. * @alias language.documents.analyzeEntities * @memberOf! () * @@ -732,8 +628,7 @@ export namespace language_v1 { /** * language.documents.analyzeEntitySentiment - * @desc Finds entities, similar to AnalyzeEntities in the text and analyzes - * sentiment associated with each entity and its mentions. + * @desc Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions. * @alias language.documents.analyzeEntitySentiment * @memberOf! () * @@ -894,9 +789,7 @@ export namespace language_v1 { /** * language.documents.analyzeSyntax - * @desc Analyzes the syntax of the text and provides sentence boundaries - * and tokenization along with part of speech tags, dependency trees, and - * other properties. + * @desc Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties. * @alias language.documents.analyzeSyntax * @memberOf! () * @@ -974,8 +867,7 @@ export namespace language_v1 { /** * language.documents.annotateText - * @desc A convenience method that provides all the features that - * analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call. + * @desc A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call. * @alias language.documents.annotateText * @memberOf! () * diff --git a/src/apis/language/v1beta1.ts b/src/apis/language/v1beta1.ts index 4ba4ddbf038..a69d81424d7 100644 --- a/src/apis/language/v1beta1.ts +++ b/src/apis/language/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace language_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace language_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace language_v1beta1 { /** * Cloud Natural Language API * - * Provides natural language understanding technologies, such as sentiment - * analysis, entity recognition, entity sentiment analysis, and other text - * annotations, to developers. + * Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers. * * @example * const {google} = require('googleapis'); @@ -114,7 +108,10 @@ export namespace language_v1beta1 { documents: Resource$Documents; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.documents = new Resource$Documents(this.context); } @@ -142,9 +139,7 @@ export namespace language_v1beta1 { */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; } @@ -157,8 +152,7 @@ export namespace language_v1beta1 { */ document?: Schema$Document; /** - * The encoding type used by the API to calculate sentence offsets for the - * sentence sentiment. + * The encoding type used by the API to calculate sentence offsets for the sentence sentiment. */ encodingType?: string; } @@ -171,9 +165,7 @@ export namespace language_v1beta1 { */ documentSentiment?: Schema$Sentiment; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** @@ -199,9 +191,7 @@ export namespace language_v1beta1 { */ export interface Schema$AnalyzeSyntaxResponse { /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** @@ -214,8 +204,7 @@ export namespace language_v1beta1 { tokens?: Schema$Token[]; } /** - * The request message for the text annotation API, which can perform multiple - * analysis types (sentiment, entities, and syntax) in one call. + * The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call. */ export interface Schema$AnnotateTextRequest { /** @@ -236,31 +225,23 @@ export namespace language_v1beta1 { */ export interface Schema$AnnotateTextResponse { /** - * The overall sentiment for the document. Populated if the user enables - * AnnotateTextRequest.Features.extract_document_sentiment. + * The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment. */ documentSentiment?: Schema$Sentiment; /** - * Entities, along with their semantic information, in the input document. - * Populated if the user enables - * AnnotateTextRequest.Features.extract_entities. + * Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities. */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** - * Sentences in the input document. Populated if the user enables - * AnnotateTextRequest.Features.extract_syntax. + * Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ sentences?: Schema$Sentence[]; /** - * Tokens, along with their syntactic information, in the input document. - * Populated if the user enables - * AnnotateTextRequest.Features.extract_syntax. + * Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ tokens?: Schema$Token[]; } @@ -269,11 +250,7 @@ export namespace language_v1beta1 { */ export interface Schema$DependencyEdge { /** - * Represents the head of this token in the dependency tree. This is the - * index of the token which has an arc going to this token. The index is the - * position of the token in the array of tokens returned by the API method. - * If this token is a root token, then the `head_token_index` is its own - * index. + * Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index. */ headTokenIndex?: number; /** @@ -282,53 +259,36 @@ export namespace language_v1beta1 { label?: string; } /** - * ################################################################ # - * Represents the input to API methods. + * ################################################################ # Represents the input to API methods. */ export interface Schema$Document { /** - * The content of the input in string format. Cloud audit logging exempt - * since it is based on user data. + * The content of the input in string format. Cloud audit logging exempt since it is based on user data. */ content?: string; /** - * The Google Cloud Storage URI where the file content is located. This URI - * must be of the form: gs://bucket_name/object_name. For more details, see - * https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage - * object versioning is not supported. + * The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported. */ gcsContentUri?: string; /** - * The language of the document (if not specified, the language is - * automatically detected). Both ISO and BCP-47 language codes are - * accepted.<br> [Language Support](/natural-language/docs/languages) - * lists currently supported languages for each API method. If the language - * (either specified by the caller or automatically detected) is not - * supported by the called API method, an `INVALID_ARGUMENT` error is - * returned. + * The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.<br> [Language Support](/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned. */ language?: string; /** - * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an - * `INVALID_ARGUMENT` error. + * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error. */ type?: string; } /** - * Represents a phrase in the text that is a known entity, such as a person, - * an organization, or location. The API associates information, such as - * salience and mentions, with entities. + * Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities. */ export interface Schema$Entity { /** - * The mentions of this entity in the input document. The API currently - * supports proper noun mentions. + * The mentions of this entity in the input document. The API currently supports proper noun mentions. */ mentions?: Schema$EntityMention[]; /** - * Metadata associated with the entity. Currently, Wikipedia URLs and - * Knowledge Graph MIDs are provided, if available. The associated keys are - * "wikipedia_url" and "mid", respectively. + * Metadata associated with the entity. Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if available. The associated keys are "wikipedia_url" and "mid", respectively. */ metadata?: {[key: string]: string}; /** @@ -336,10 +296,7 @@ export namespace language_v1beta1 { */ name?: string; /** - * The salience score associated with the entity in the [0, 1.0] range. The - * salience score for an entity provides information about the importance or - * centrality of that entity to the entire document text. Scores closer to 0 - * are less salient, while scores closer to 1.0 are highly salient. + * The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. */ salience?: number; /** @@ -348,8 +305,7 @@ export namespace language_v1beta1 { type?: string; } /** - * Represents a mention for an entity in the text. Currently, proper noun - * mentions are supported. + * Represents a mention for an entity in the text. Currently, proper noun mentions are supported. */ export interface Schema$EntityMention { /** @@ -362,8 +318,7 @@ export namespace language_v1beta1 { type?: string; } /** - * All available features for sentiment, syntax, and semantic analysis. - * Setting each one to true will enable that specific analysis for the input. + * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. */ export interface Schema$Features { /** @@ -437,9 +392,7 @@ export namespace language_v1beta1 { */ export interface Schema$Sentence { /** - * For calls to AnalyzeSentiment or if - * AnnotateTextRequest.Features.extract_document_sentiment is set to true, - * this field will contain the sentiment for the sentence. + * For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence. */ sentiment?: Schema$Sentiment; /** @@ -448,63 +401,24 @@ export namespace language_v1beta1 { text?: Schema$TextSpan; } /** - * Represents the feeling associated with the entire text or entities in the - * text. + * Represents the feeling associated with the entire text or entities in the text. */ export interface Schema$Sentiment { /** - * A non-negative number in the [0, +inf) range, which represents the - * absolute magnitude of sentiment regardless of score (positive or - * negative). + * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative). */ magnitude?: number; /** - * DEPRECATED FIELD - This field is being deprecated in favor of score. - * Please refer to our documentation at - * https://cloud.google.com/natural-language/docs for more information. + * DEPRECATED FIELD - This field is being deprecated in favor of score. Please refer to our documentation at https://cloud.google.com/natural-language/docs for more information. */ polarity?: number; /** - * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - * sentiment). + * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ score?: number; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -512,14 +426,11 @@ export namespace language_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -528,8 +439,7 @@ export namespace language_v1beta1 { */ export interface Schema$TextSpan { /** - * The API calculates the beginning offset of the content in the original - * document according to the EncodingType specified in the API request. + * The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request. */ beginOffset?: number; /** @@ -546,8 +456,7 @@ export namespace language_v1beta1 { */ dependencyEdge?: Schema$DependencyEdge; /** - * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the - * token. + * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. */ lemma?: string; /** @@ -568,9 +477,7 @@ export namespace language_v1beta1 { /** * language.documents.analyzeEntities - * @desc Finds named entities (currently proper names and common nouns) in - * the text along with entity types, salience, mentions for each entity, and - * other properties. + * @desc Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties. * @alias language.documents.analyzeEntities * @memberOf! () * @@ -726,9 +633,7 @@ export namespace language_v1beta1 { /** * language.documents.analyzeSyntax - * @desc Analyzes the syntax of the text and provides sentence boundaries - * and tokenization along with part of speech tags, dependency trees, and - * other properties. + * @desc Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties. * @alias language.documents.analyzeSyntax * @memberOf! () * @@ -806,8 +711,7 @@ export namespace language_v1beta1 { /** * language.documents.annotateText - * @desc A convenience method that provides all the features that - * analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call. + * @desc A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call. * @alias language.documents.annotateText * @memberOf! () * diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index 0065c99712c..43f606e71c4 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace language_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace language_v1beta2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace language_v1beta2 { /** * Cloud Natural Language API * - * Provides natural language understanding technologies, such as sentiment - * analysis, entity recognition, entity sentiment analysis, and other text - * annotations, to developers. + * Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers. * * @example * const {google} = require('googleapis'); @@ -114,7 +108,10 @@ export namespace language_v1beta2 { documents: Resource$Documents; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.documents = new Resource$Documents(this.context); } @@ -142,9 +139,7 @@ export namespace language_v1beta2 { */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; } @@ -170,9 +165,7 @@ export namespace language_v1beta2 { */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; } @@ -185,8 +178,7 @@ export namespace language_v1beta2 { */ document?: Schema$Document; /** - * The encoding type used by the API to calculate sentence offsets for the - * sentence sentiment. + * The encoding type used by the API to calculate sentence offsets for the sentence sentiment. */ encodingType?: string; } @@ -199,9 +191,7 @@ export namespace language_v1beta2 { */ documentSentiment?: Schema$Sentiment; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** @@ -227,9 +217,7 @@ export namespace language_v1beta2 { */ export interface Schema$AnalyzeSyntaxResponse { /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** @@ -242,8 +230,7 @@ export namespace language_v1beta2 { tokens?: Schema$Token[]; } /** - * The request message for the text annotation API, which can perform multiple - * analysis types (sentiment, entities, and syntax) in one call. + * The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call. */ export interface Schema$AnnotateTextRequest { /** @@ -268,31 +255,23 @@ export namespace language_v1beta2 { */ categories?: Schema$ClassificationCategory[]; /** - * The overall sentiment for the document. Populated if the user enables - * AnnotateTextRequest.Features.extract_document_sentiment. + * The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment. */ documentSentiment?: Schema$Sentiment; /** - * Entities, along with their semantic information, in the input document. - * Populated if the user enables - * AnnotateTextRequest.Features.extract_entities. + * Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities. */ entities?: Schema$Entity[]; /** - * The language of the text, which will be the same as the language - * specified in the request or, if not specified, the automatically-detected - * language. See Document.language field for more details. + * The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. */ language?: string; /** - * Sentences in the input document. Populated if the user enables - * AnnotateTextRequest.Features.extract_syntax. + * Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ sentences?: Schema$Sentence[]; /** - * Tokens, along with their syntactic information, in the input document. - * Populated if the user enables - * AnnotateTextRequest.Features.extract_syntax. + * Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax. */ tokens?: Schema$Token[]; } @@ -301,13 +280,11 @@ export namespace language_v1beta2 { */ export interface Schema$ClassificationCategory { /** - * The classifier's confidence of the category. Number represents how - * certain the classifier is that this category represents the given text. + * The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text. */ confidence?: number; /** - * The name of the category representing the document, from the [predefined - * taxonomy](/natural-language/docs/categories). + * The name of the category representing the document, from the [predefined taxonomy](/natural-language/docs/categories). */ name?: string; } @@ -334,11 +311,7 @@ export namespace language_v1beta2 { */ export interface Schema$DependencyEdge { /** - * Represents the head of this token in the dependency tree. This is the - * index of the token which has an arc going to this token. The index is the - * position of the token in the array of tokens returned by the API method. - * If this token is a root token, then the `head_token_index` is its own - * index. + * Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index. */ headTokenIndex?: number; /** @@ -347,54 +320,36 @@ export namespace language_v1beta2 { label?: string; } /** - * ################################################################ # - * Represents the input to API methods. + * ################################################################ # Represents the input to API methods. */ export interface Schema$Document { /** - * The content of the input in string format. Cloud audit logging exempt - * since it is based on user data. + * The content of the input in string format. Cloud audit logging exempt since it is based on user data. */ content?: string; /** - * The Google Cloud Storage URI where the file content is located. This URI - * must be of the form: gs://bucket_name/object_name. For more details, see - * https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage - * object versioning is not supported. + * The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported. */ gcsContentUri?: string; /** - * The language of the document (if not specified, the language is - * automatically detected). Both ISO and BCP-47 language codes are - * accepted.<br> [Language Support](/natural-language/docs/languages) - * lists currently supported languages for each API method. If the language - * (either specified by the caller or automatically detected) is not - * supported by the called API method, an `INVALID_ARGUMENT` error is - * returned. + * The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.<br> [Language Support](/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned. */ language?: string; /** - * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an - * `INVALID_ARGUMENT` error. + * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error. */ type?: string; } /** - * Represents a phrase in the text that is a known entity, such as a person, - * an organization, or location. The API associates information, such as - * salience and mentions, with entities. + * Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities. */ export interface Schema$Entity { /** - * The mentions of this entity in the input document. The API currently - * supports proper noun mentions. + * The mentions of this entity in the input document. The API currently supports proper noun mentions. */ mentions?: Schema$EntityMention[]; /** - * Metadata associated with the entity. For most entity types, the metadata - * is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if - * they are available. For the metadata associated with other entity types, - * see the Type table below. + * Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below. */ metadata?: {[key: string]: string}; /** @@ -402,17 +357,11 @@ export namespace language_v1beta2 { */ name?: string; /** - * The salience score associated with the entity in the [0, 1.0] range. The - * salience score for an entity provides information about the importance or - * centrality of that entity to the entire document text. Scores closer to 0 - * are less salient, while scores closer to 1.0 are highly salient. + * The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. */ salience?: number; /** - * For calls to AnalyzeEntitySentiment or if - * AnnotateTextRequest.Features.extract_entity_sentiment is set to true, - * this field will contain the aggregate sentiment expressed for this entity - * in the provided document. + * For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document. */ sentiment?: Schema$Sentiment; /** @@ -421,15 +370,11 @@ export namespace language_v1beta2 { type?: string; } /** - * Represents a mention for an entity in the text. Currently, proper noun - * mentions are supported. + * Represents a mention for an entity in the text. Currently, proper noun mentions are supported. */ export interface Schema$EntityMention { /** - * For calls to AnalyzeEntitySentiment or if - * AnnotateTextRequest.Features.extract_entity_sentiment is set to true, - * this field will contain the sentiment expressed for this mention of the - * entity in the provided document. + * For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document. */ sentiment?: Schema$Sentiment; /** @@ -442,15 +387,11 @@ export namespace language_v1beta2 { type?: string; } /** - * All available features for sentiment, syntax, and semantic analysis. - * Setting each one to true will enable that specific analysis for the input. - * Next ID: 10 + * All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 10 */ export interface Schema$Features { /** - * Classify the full document into categories. If this is true, the API will - * use the default model which classifies into a [predefined - * taxonomy](/natural-language/docs/categories). + * Classify the full document into categories. If this is true, the API will use the default model which classifies into a [predefined taxonomy](/natural-language/docs/categories). */ classifyText?: boolean; /** @@ -528,9 +469,7 @@ export namespace language_v1beta2 { */ export interface Schema$Sentence { /** - * For calls to AnalyzeSentiment or if - * AnnotateTextRequest.Features.extract_document_sentiment is set to true, - * this field will contain the sentiment for the sentence. + * For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence. */ sentiment?: Schema$Sentiment; /** @@ -539,57 +478,20 @@ export namespace language_v1beta2 { text?: Schema$TextSpan; } /** - * Represents the feeling associated with the entire text or entities in the - * text. Next ID: 6 + * Represents the feeling associated with the entire text or entities in the text. Next ID: 6 */ export interface Schema$Sentiment { /** - * A non-negative number in the [0, +inf) range, which represents the - * absolute magnitude of sentiment regardless of score (positive or - * negative). + * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative). */ magnitude?: number; /** - * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - * sentiment). + * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ score?: number; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -597,14 +499,11 @@ export namespace language_v1beta2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -613,8 +512,7 @@ export namespace language_v1beta2 { */ export interface Schema$TextSpan { /** - * The API calculates the beginning offset of the content in the original - * document according to the EncodingType specified in the API request. + * The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request. */ beginOffset?: number; /** @@ -631,8 +529,7 @@ export namespace language_v1beta2 { */ dependencyEdge?: Schema$DependencyEdge; /** - * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the - * token. + * [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. */ lemma?: string; /** @@ -653,9 +550,7 @@ export namespace language_v1beta2 { /** * language.documents.analyzeEntities - * @desc Finds named entities (currently proper names and common nouns) in - * the text along with entity types, salience, mentions for each entity, and - * other properties. + * @desc Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties. * @alias language.documents.analyzeEntities * @memberOf! () * @@ -733,8 +628,7 @@ export namespace language_v1beta2 { /** * language.documents.analyzeEntitySentiment - * @desc Finds entities, similar to AnalyzeEntities in the text and analyzes - * sentiment associated with each entity and its mentions. + * @desc Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions. * @alias language.documents.analyzeEntitySentiment * @memberOf! () * @@ -894,9 +788,7 @@ export namespace language_v1beta2 { /** * language.documents.analyzeSyntax - * @desc Analyzes the syntax of the text and provides sentence boundaries - * and tokenization along with part of speech tags, dependency trees, and - * other properties. + * @desc Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties. * @alias language.documents.analyzeSyntax * @memberOf! () * @@ -974,8 +866,7 @@ export namespace language_v1beta2 { /** * language.documents.annotateText - * @desc A convenience method that provides all syntax, sentiment, entity, - * and classification features in one call. + * @desc A convenience method that provides all syntax, sentiment, entity, and classification features in one call. * @alias language.documents.annotateText * @memberOf! () * diff --git a/src/apis/libraryagent/package.json b/src/apis/libraryagent/package.json index 32008607185..0d602576566 100644 --- a/src/apis/libraryagent/package.json +++ b/src/apis/libraryagent/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/libraryagent/v1.ts b/src/apis/libraryagent/v1.ts index 54d4e7a5d34..9fce8da8077 100644 --- a/src/apis/libraryagent/v1.ts +++ b/src/apis/libraryagent/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace libraryagent_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace libraryagent_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace libraryagent_v1 { shelves: Resource$Shelves; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.shelves = new Resource$Shelves(this.context); } @@ -127,9 +126,7 @@ export namespace libraryagent_v1 { */ author?: string; /** - * The resource name of the book. Book names have the form - * `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a - * book. + * The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book. */ name?: string; /** @@ -150,9 +147,7 @@ export namespace libraryagent_v1 { */ books?: Schema$GoogleExampleLibraryagentV1Book[]; /** - * A token to retrieve next page of results. Pass this value in the - * ListBooksRequest.page_token field in the subsequent call to `ListBooks` - * method to retrieve the next page of results. + * A token to retrieve next page of results. Pass this value in the ListBooksRequest.page_token field in the subsequent call to `ListBooks` method to retrieve the next page of results. */ nextPageToken?: string; } @@ -161,9 +156,7 @@ export namespace libraryagent_v1 { */ export interface Schema$GoogleExampleLibraryagentV1ListShelvesResponse { /** - * A token to retrieve next page of results. Pass this value in the - * ListShelvesRequest.page_token field in the subsequent call to - * `ListShelves` method to retrieve the next page of results. + * A token to retrieve next page of results. Pass this value in the ListShelvesRequest.page_token field in the subsequent call to `ListShelves` method to retrieve the next page of results. */ nextPageToken?: string; /** @@ -176,8 +169,7 @@ export namespace libraryagent_v1 { */ export interface Schema$GoogleExampleLibraryagentV1Shelf { /** - * Output only. The resource name of the shelf. Shelf names have the form - * `shelves/{shelf_id}`. The name is ignored when creating a shelf. + * Output only. The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf. */ name?: string; /** @@ -275,8 +267,7 @@ export namespace libraryagent_v1 { /** * libraryagent.shelves.list - * @desc Lists shelves. The order is unspecified but deterministic. Newly - * created shelves will not necessarily be added to the end of this list. + * @desc Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list. * @alias libraryagent.shelves.list * @memberOf! () * @@ -389,14 +380,11 @@ export namespace libraryagent_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. Server may return fewer shelves than requested. If - * unspecified, server will pick an appropriate default. + * Requested page size. Server may return fewer shelves than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListShelvesResponse.next_page_token - * returned from the previous call to `ListShelves` method. + * A token identifying a page of results the server should return. Typically, this is the value of ListShelvesResponse.next_page_token returned from the previous call to `ListShelves` method. */ pageToken?: string; } @@ -409,10 +397,7 @@ export namespace libraryagent_v1 { /** * libraryagent.shelves.books.borrow - * @desc Borrow a book from the library. Returns the book if it is borrowed - * successfully. Returns NOT_FOUND if the book does not exist in the - * library. Returns quota exceeded error if the amount of books borrowed - * exceeds allocation quota in any dimensions. + * @desc Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions. * @alias libraryagent.shelves.books.borrow * @memberOf! () * @@ -572,9 +557,7 @@ export namespace libraryagent_v1 { /** * libraryagent.shelves.books.list - * @desc Lists books in a shelf. The order is unspecified but deterministic. - * Newly created books will not necessarily be added to the end of this - * list. Returns NOT_FOUND if the shelf does not exist. + * @desc Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist. * @alias libraryagent.shelves.books.list * @memberOf! () * @@ -675,9 +658,7 @@ export namespace libraryagent_v1 { /** * libraryagent.shelves.books.return - * @desc Return a book to the library. Returns the book if it is returned to - * the library successfully. Returns error if the book does not belong to - * the library or the users didn't borrow before. + * @desc Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn't borrow before. * @alias libraryagent.shelves.books.return * @memberOf! () * @@ -788,14 +769,11 @@ export namespace libraryagent_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requested page size. Server may return fewer books than requested. If - * unspecified, server will pick an appropriate default. + * Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListBooksResponse.next_page_token. - * returned from the previous call to `ListBooks` method. + * A token identifying a page of results the server should return. Typically, this is the value of ListBooksResponse.next_page_token. returned from the previous call to `ListBooks` method. */ pageToken?: string; /** diff --git a/src/apis/licensing/package.json b/src/apis/licensing/package.json index 9426b3606f0..f52cdbe7281 100644 --- a/src/apis/licensing/package.json +++ b/src/apis/licensing/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/licensing/v1.ts b/src/apis/licensing/v1.ts index d4d2707c33c..1d743c9cc35 100644 --- a/src/apis/licensing/v1.ts +++ b/src/apis/licensing/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace licensing_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace licensing_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace licensing_v1 { licenseAssignments: Resource$Licenseassignments; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.licenseAssignments = new Resource$Licenseassignments(this.context); } @@ -164,8 +164,7 @@ export namespace licensing_v1 { */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -788,18 +787,15 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * CustomerId represents the customer for whom licenseassignments are - * queried + * CustomerId represents the customer for whom licenseassignments are queried */ customerId?: string; /** - * Maximum number of campaigns to return at one time. Must be positive. - * Optional. Default value is 100. + * Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100. */ maxResults?: number; /** - * Token to fetch the next page.Optional. By default server will return - * first page + * Token to fetch the next page.Optional. By default server will return first page */ pageToken?: string; /** @@ -815,18 +811,15 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * CustomerId represents the customer for whom licenseassignments are - * queried + * CustomerId represents the customer for whom licenseassignments are queried */ customerId?: string; /** - * Maximum number of campaigns to return at one time. Must be positive. - * Optional. Default value is 100. + * Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100. */ maxResults?: number; /** - * Token to fetch the next page.Optional. By default server will return - * first page + * Token to fetch the next page.Optional. By default server will return first page */ pageToken?: string; /** diff --git a/src/apis/logging/package.json b/src/apis/logging/package.json index 5ef25a7b279..79414b214c9 100644 --- a/src/apis/logging/package.json +++ b/src/apis/logging/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 5f601764564..009f7b74d69 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace logging_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace logging_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -120,7 +116,10 @@ export namespace logging_v2 { sinks: Resource$Sinks; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.billingAccounts = new Resource$Billingaccounts(this.context); this.entries = new Resource$Entries(this.context); @@ -137,20 +136,7 @@ export namespace logging_v2 { } /** - * BucketOptions describes the bucket boundaries used to create a histogram - * for the distribution. The buckets can be in a linear sequence, an - * exponential sequence, or each bucket can be specified explicitly. - * BucketOptions does not include the number of values in each bucket.A bucket - * has an inclusive lower bound and exclusive upper bound for the values that - * are counted for that bucket. The upper bound of a bucket must be strictly - * greater than the lower bound. The sequence of N buckets for a distribution - * consists of an underflow bucket (number 0), zero or more finite buckets - * (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets - * are contiguous: the lower bound of bucket i (i > 0) is the same as the - * upper bound of bucket i - 1. The buckets span the whole range of finite - * values: lower bound of the underflow bucket is -infinity and the upper - * bound of the overflow bucket is +infinity. The finite buckets are so-called - * because both bounds are finite. + * BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. */ export interface Schema$BucketOptions { /** @@ -167,20 +153,11 @@ export namespace logging_v2 { linearBuckets?: Schema$Linear; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** - * Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 - * (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i - * < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds - * field must contain at least one element. If bounds has only one element, - * then there are no finite buckets, and that single element is the common - * boundary of the overflow and underflow buckets. + * Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. */ export interface Schema$Explicit { /** @@ -189,12 +166,7 @@ export namespace logging_v2 { bounds?: number[]; } /** - * Specifies an exponential sequence of buckets that have a width that is - * proportional to the value of the lower bound. Each bucket represents a - * constant relative uncertainty on a specific value in the bucket.There are - * num_finite_buckets + 2 (= N) buckets. Bucket i has the following - * boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). - * Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). + * Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). */ export interface Schema$Exponential { /** @@ -211,19 +183,15 @@ export namespace logging_v2 { scale?: number; } /** - * A common proto for logging HTTP requests. Only contains semantics defined - * by the HTTP specification. Product-specific logging information MUST be - * defined in a separate message. + * A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. */ export interface Schema$HttpRequest { /** - * The number of HTTP response bytes inserted into cache. Set only when a - * cache fill was attempted. + * The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. */ cacheFillBytes?: string; /** - * Whether or not an entity was served from cache (with or without - * validation). + * Whether or not an entity was served from cache (with or without validation). */ cacheHit?: boolean; /** @@ -231,55 +199,43 @@ export namespace logging_v2 { */ cacheLookup?: boolean; /** - * Whether or not the response was validated with the origin server before - * being served from cache. This field is only meaningful if cache_hit is - * True. + * Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True. */ cacheValidatedWithOriginServer?: boolean; /** - * The request processing latency on the server, from the time the request - * was received until the response was sent. + * The request processing latency on the server, from the time the request was received until the response was sent. */ latency?: string; /** - * Protocol used for the request. Examples: "HTTP/1.1", - * "HTTP/2", "websocket" + * Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" */ protocol?: string; /** - * The referer URL of the request, as defined in HTTP/1.1 Header Field - * Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + * The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). */ referer?: string; /** - * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. - * Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329". + * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329". */ remoteIp?: string; /** - * The request method. Examples: "GET", "HEAD", - * "PUT", "POST". + * The request method. Examples: "GET", "HEAD", "PUT", "POST". */ requestMethod?: string; /** - * The size of the HTTP request message in bytes, including the request - * headers and the request body. + * The size of the HTTP request message in bytes, including the request headers and the request body. */ requestSize?: string; /** - * The scheme (http, https), the host name, the path and the query portion - * of the URL that was requested. Example: - * "http://example.com/some/info?color=red". + * The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red". */ requestUrl?: string; /** - * The size of the HTTP response message sent back to the client, in bytes, - * including the response headers and the response body. + * The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. */ responseSize?: string; /** - * The IP address (IPv4 or IPv6) of the origin server that the request was - * sent to. + * The IP address (IPv4 or IPv6) of the origin server that the request was sent to. */ serverIp?: string; /** @@ -287,8 +243,7 @@ export namespace logging_v2 { */ status?: number; /** - * The user agent sent by the client. Example: "Mozilla/4.0 - * (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". + * The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". */ userAgent?: string; } @@ -310,12 +265,7 @@ export namespace logging_v2 { valueType?: string; } /** - * Specifies a linear sequence of buckets that all have the same width (except - * overflow and underflow). Each bucket represents a constant absolute - * uncertainty on the specific value in the bucket.There are - * num_finite_buckets + 2 (= N) buckets. Bucket i has the following - * boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower - * bound (1 <= i < N): offset + (width * (i - 1)). + * Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). */ export interface Schema$Linear { /** @@ -340,9 +290,7 @@ export namespace logging_v2 { */ exclusions?: Schema$LogExclusion[]; /** - * If there might be more results than appear in this response, then - * nextPageToken is included. To get the next set of results, call the same - * method again using the value of nextPageToken as pageToken. + * If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken. */ nextPageToken?: string; } @@ -351,49 +299,27 @@ export namespace logging_v2 { */ export interface Schema$ListLogEntriesRequest { /** - * Optional. A filter that chooses which log entries to return. See Advanced - * Logs Filters. Only log entries that match the filter are returned. An - * empty filter matches all log entries in the resources listed in - * resource_names. Referencing a parent resource that is not listed in - * resource_names will cause the filter to return no results. The maximum - * length of the filter is 20000 characters. + * Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters. */ filter?: string; /** - * Optional. How the results should be sorted. Presently, the only permitted - * values are "timestamp asc" (default) and "timestamp - * desc". The first option returns entries in order of increasing - * values of LogEntry.timestamp (oldest first), and the second option - * returns entries in order of decreasing timestamps (newest first). Entries - * with equal timestamps are returned in order of their insert_id values. + * Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc" (default) and "timestamp desc". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values. */ orderBy?: string; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of next_page_token in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. page_token must be the value of - * next_page_token from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Deprecated. Use resource_names instead. One or more project identifiers - * or project numbers from which to retrieve log entries. Example: - * "my-project-1A". + * Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A". */ projectIds?: string[]; /** - * Required. Names of one or more parent resources from which to retrieve - * log entries: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" Projects listed in the project_ids field - * are added to this list. + * Required. Names of one or more parent resources from which to retrieve log entries: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Projects listed in the project_ids field are added to this list. */ resourceNames?: string[]; } @@ -402,21 +328,11 @@ export namespace logging_v2 { */ export interface Schema$ListLogEntriesResponse { /** - * A list of log entries. If entries is empty, nextPageToken may still be - * returned, indicating that more entries may exist. See nextPageToken for - * more information. + * A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information. */ entries?: Schema$LogEntry[]; /** - * If there might be more results than those appearing in this response, - * then nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken.If a value for - * next_page_token appears and the entries field is empty, it means that the - * search found no log entries so far but it did not have time to search all - * the possible log entries. Retry the method with this value for page_token - * to continue the search. Alternatively, consider speeding up the search by - * changing your filter to specify a single log name or resource type, or to - * narrow the time range of the search. + * If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search. */ nextPageToken?: string; } @@ -429,9 +345,7 @@ export namespace logging_v2 { */ metrics?: Schema$LogMetric[]; /** - * If there might be more results than appear in this response, then - * nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken. + * If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. */ nextPageToken?: string; } @@ -440,15 +354,11 @@ export namespace logging_v2 { */ export interface Schema$ListLogsResponse { /** - * A list of log names. For example, "projects/my-project/syslog" - * or - * "organizations/123/cloudresourcemanager.googleapis.com%2Factivity". + * A list of log names. For example, "projects/my-project/syslog" or "organizations/123/cloudresourcemanager.googleapis.com%2Factivity". */ logNames?: string[]; /** - * If there might be more results than those appearing in this response, - * then nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken. + * If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. */ nextPageToken?: string; } @@ -457,9 +367,7 @@ export namespace logging_v2 { */ export interface Schema$ListMonitoredResourceDescriptorsResponse { /** - * If there might be more results than those appearing in this response, - * then nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken. + * If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. */ nextPageToken?: string; /** @@ -472,9 +380,7 @@ export namespace logging_v2 { */ export interface Schema$ListSinksResponse { /** - * If there might be more results than appear in this response, then - * nextPageToken is included. To get the next set of results, call the same - * method again using the value of nextPageToken as pageToken. + * If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken. */ nextPageToken?: string; /** @@ -487,68 +393,35 @@ export namespace logging_v2 { */ export interface Schema$LogEntry { /** - * Optional. Information about the HTTP request associated with this log - * entry, if applicable. + * Optional. Information about the HTTP request associated with this log entry, if applicable. */ httpRequest?: Schema$HttpRequest; /** - * Optional. A unique identifier for the log entry. If you provide a value, - * then Logging considers other log entries in the same project, with the - * same timestamp, and with the same insert_id to be duplicates which can be - * removed. If omitted in new log entries, then Logging assigns its own - * unique identifier. The insert_id is also used to order log entries that - * have the same timestamp value. + * Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value. */ insertId?: string; /** - * The log entry payload, represented as a structure that is expressed as a - * JSON object. + * The log entry payload, represented as a structure that is expressed as a JSON object. */ jsonPayload?: {[key: string]: any}; /** - * Optional. A set of user-defined (key, value) data that provides - * additional information about the log entry. + * Optional. A set of user-defined (key, value) data that provides additional information about the log entry. */ labels?: {[key: string]: string}; /** - * Required. The resource name of the log to which this log entry belongs: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may - * optionally be used in place of PROJECT_ID. The project number is - * translated to its corresponding PROJECT_ID internally and the log_name - * field will contain PROJECT_ID in queries and exports.[LOG_ID] must be - * URL-encoded within log_name. Example: - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * [LOG_ID] must be less than 512 characters long and can only include the - * following characters: upper and lower case alphanumeric characters, - * forward-slash, underscore, hyphen, and period.For backward compatibility, - * if log_name begins with a forward-slash, such as /projects/..., then the - * log entry is ingested as usual but the forward-slash is removed. Listing - * the log entry will not show the leading slash and filtering for a log - * name with a leading slash will never return any results. + * Required. The resource name of the log to which this log entry belongs: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results. */ logName?: string; /** - * Deprecated. Output only. Additional metadata about the monitored - * resource.Only k8s_container, k8s_pod, and k8s_node MonitoredResources - * have this field populated for GKE versions older than 1.12.6. For GKE - * versions 1.12.6 and above, the metadata field has been deprecated. The - * Kubernetes pod labels that used to be in metadata.userLabels will now be - * present in the labels field with a key prefix of k8s-pod/. The - * Stackdriver system labels that were present in the metadata.systemLabels - * field will no longer be available in the LogEntry. + * Deprecated. Output only. Additional metadata about the monitored resource.Only k8s_container, k8s_pod, and k8s_node MonitoredResources have this field populated for GKE versions older than 1.12.6. For GKE versions 1.12.6 and above, the metadata field has been deprecated. The Kubernetes pod labels that used to be in metadata.userLabels will now be present in the labels field with a key prefix of k8s-pod/. The Stackdriver system labels that were present in the metadata.systemLabels field will no longer be available in the LogEntry. */ metadata?: Schema$MonitoredResourceMetadata; /** - * Optional. Information about an operation associated with the log entry, - * if applicable. + * Optional. Information about an operation associated with the log entry, if applicable. */ operation?: Schema$LogEntryOperation; /** - * The log entry payload, represented as a protocol buffer. Some Google - * Cloud Platform services use this field for their log entry payloads. + * The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads. */ protoPayload?: {[key: string]: any}; /** @@ -556,27 +429,19 @@ export namespace logging_v2 { */ receiveTimestamp?: string; /** - * Required. The primary monitored resource associated with this log - * entry.Example: a log entry that reports a database error would be - * associated with the monitored resource designating the particular - * database that reported the error. + * Required. The primary monitored resource associated with this log entry.Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error. */ resource?: Schema$MonitoredResource; /** - * Optional. The severity of the log entry. The default value is - * LogSeverity.DEFAULT. + * Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT. */ severity?: string; /** - * Optional. Source code location information associated with the log entry, - * if any. + * Optional. Source code location information associated with the log entry, if any. */ sourceLocation?: Schema$LogEntrySourceLocation; /** - * Optional. The span ID within the trace associated with the log entry.For - * Trace spans, this is the same format that the Trace API v2 uses: a - * 16-character hexadecimal encoding of an 8-byte array, such as - * <code>"000000000000004a"</code>. + * Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as <code>"000000000000004a"</code>. */ spanId?: string; /** @@ -584,99 +449,62 @@ export namespace logging_v2 { */ textPayload?: string; /** - * Optional. The time the event described by the log entry occurred. This - * time is used to compute the log entry's age and to enforce the logs - * retention period. If this field is omitted in a new log entry, then - * Logging assigns it the current time. Timestamps have nanosecond accuracy, - * but trailing zeros in the fractional seconds might be omitted when the - * timestamp is displayed.Incoming log entries should have timestamps that - * are no more than the logs retention period in the past, and no more than - * 24 hours in the future. Log entries outside those time boundaries will - * not be available when calling entries.list, but those log entries can - * still be exported with LogSinks. + * Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks. */ timestamp?: string; /** - * Optional. Resource name of the trace associated with the log entry, if - * any. If it contains a relative resource name, the name is assumed to be - * relative to //tracing.googleapis.com. Example: - * projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824 + * Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824 */ trace?: string; /** - * Optional. The sampling decision of the trace associated with the log - * entry.True means that the trace resource name in the trace field was - * sampled for storage in a trace backend. False means that the trace was - * not sampled for storage when this log entry was written, or the sampling - * decision was unknown at the time. A non-sampled trace value is still - * useful as a request correlation identifier. The default is False. + * Optional. The sampling decision of the trace associated with the log entry.True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False. */ traceSampled?: boolean; } /** - * Additional information about a potentially long-running operation with - * which a log entry is associated. + * Additional information about a potentially long-running operation with which a log entry is associated. */ export interface Schema$LogEntryOperation { /** - * Optional. Set this to True if this is the first log entry in the - * operation. + * Optional. Set this to True if this is the first log entry in the operation. */ first?: boolean; /** - * Optional. An arbitrary operation identifier. Log entries with the same - * identifier are assumed to be part of the same operation. + * Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. */ id?: string; /** - * Optional. Set this to True if this is the last log entry in the - * operation. + * Optional. Set this to True if this is the last log entry in the operation. */ last?: boolean; /** - * Optional. An arbitrary producer identifier. The combination of id and - * producer must be globally unique. Examples for producer: - * "MyDivision.MyBigCompany.com", - * "github.com/MyProject/MyApplication". + * Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication". */ producer?: string; } /** - * Additional information about the source code location that produced the log - * entry. + * Additional information about the source code location that produced the log entry. */ export interface Schema$LogEntrySourceLocation { /** - * Optional. Source file name. Depending on the runtime environment, this - * might be a simple name or a fully-qualified name. + * Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. */ file?: string; /** - * Optional. Human-readable name of the function or method being invoked, - * with optional context such as the class or package name. This information - * may be used in contexts such as the logs viewer, where a file and line - * number are less meaningful. The format can vary by language. For example: - * qual.if.ied.Class.method (Java), dir/package.func (Go), function - * (Python). + * Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). */ function?: string; /** - * Optional. Line within the source file. 1-based; 0 indicates no line - * number available. + * Optional. Line within the source file. 1-based; 0 indicates no line number available. */ line?: string; } /** - * Specifies a set of log entries that are not to be stored in Logging. If - * your project receives a large volume of logs, you might be able to use - * exclusions to reduce your chargeable logs. Exclusions are processed after - * log sinks, so you can export log entries before they are excluded. Audit - * log entries and log entries from Amazon Web Services are never excluded. + * Specifies a set of log entries that are not to be stored in Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded. */ export interface Schema$LogExclusion { /** - * Output only. The creation timestamp of the exclusion.This field may not - * be present for older exclusions. + * Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions. */ createTime?: string; /** @@ -684,30 +512,19 @@ export namespace logging_v2 { */ description?: string; /** - * Optional. If set to True, then this exclusion is disabled and it does not - * exclude any log entries. You can update an exclusion to change the value - * of this field. + * Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field. */ disabled?: boolean; /** - * Required. An advanced logs filter that matches the log entries to be - * excluded. By using the sample function, you can exclude less than 100% of - * the matching log entries. For example, the following filter matches 99% - * of low-severity log entries from load - * balancers:"resource.type=http_load_balancer severity<ERROR - * sample(insertId, 0.99)" + * Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. For example, the following filter matches 99% of low-severity log entries from load balancers:"resource.type=http_load_balancer severity<ERROR sample(insertId, 0.99)" */ filter?: string; /** - * Required. A client-assigned identifier, such as - * "load-balancer-exclusion". Identifiers are limited to 100 - * characters and can include only letters, digits, underscores, hyphens, - * and periods. + * Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. */ name?: string; /** - * Output only. The last update timestamp of the exclusion.This field may - * not be present for older exclusions. + * Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions. */ updateTime?: string; } @@ -733,192 +550,89 @@ export namespace logging_v2 { time?: string; } /** - * Describes a logs-based metric. The value of the metric is the number of log - * entries that match a logs filter in a given time interval.Logs-based metric - * can also be used to extract values from logs and create a a distribution of - * the values. The distribution records the statistics of the extracted values - * along with an optional histogram of the values as specified by the bucket - * options. + * Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options. */ export interface Schema$LogMetric { /** - * Optional. The bucket_options are required when the logs-based metric is - * using a DISTRIBUTION value type and it describes the bucket boundaries - * used to create a histogram of the extracted values. + * Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values. */ bucketOptions?: Schema$BucketOptions; /** - * Output only. The creation timestamp of the metric.This field may not be - * present for older metrics. + * Output only. The creation timestamp of the metric.This field may not be present for older metrics. */ createTime?: string; /** - * Optional. A description of this metric, which is used in documentation. - * The maximum length of the description is 8000 characters. + * Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. */ description?: string; /** - * Required. An advanced logs filter which is used to match log entries. - * Example: "resource.type=gae_app AND severity>=ERROR" The - * maximum length of the filter is 20000 characters. + * Required. An advanced logs filter which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters. */ filter?: string; /** - * Optional. A map from a label key string to an extractor expression which - * is used to extract data from a log entry field and assign as the label - * value. Each label key specified in the LabelDescriptor must have an - * associated extractor expression in this map. The syntax of the extractor - * expression is the same as for the value_extractor field.The extracted - * value is converted to the type defined in the label descriptor. If the - * either the extraction or the type conversion fails, the label will have a - * default value. The default value for a string label is an empty string, - * for an integer label its 0, and for a boolean label its false.Note that - * there are upper bounds on the maximum number of labels and the number of - * active time series that are allowed in a project. + * Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project. */ labelExtractors?: {[key: string]: string}; /** - * Optional. The metric descriptor associated with the logs-based metric. If - * unspecified, it uses a default metric descriptor with a DELTA metric - * kind, INT64 value type, with no labels and a unit of "1". Such - * a metric counts the number of log entries matching the filter - * expression.The name, type, and description fields in the - * metric_descriptor are output only, and is constructed using the name and - * description field in the LogMetric.To create a logs-based metric that - * records a distribution of log values, a DELTA metric kind with a - * DISTRIBUTION value type must be used along with a value_extractor - * expression in the LogMetric.Each label in the metric descriptor must have - * a matching label name as the key and an extractor expression as the value - * in the label_extractors map.The metric_kind and value_type fields in the - * metric_descriptor cannot be updated once initially configured. New labels - * can be added in the metric_descriptor, but existing labels cannot be - * modified except for their description. + * Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description. */ metricDescriptor?: Schema$MetricDescriptor; /** - * Required. The client-assigned metric identifier. Examples: - * "error_count", "nginx/requests".Metric identifiers - * are limited to 100 characters and can include only the following - * characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. - * The forward-slash character (/) denotes a hierarchy of name pieces, and - * it cannot be the first character of the name.The metric identifier in - * this field must not be URL-encoded - * (https://en.wikipedia.org/wiki/Percent-encoding). However, when the - * metric identifier appears as the [METRIC_ID] part of a metric_name API - * parameter, then the metric identifier must be URL-encoded. Example: - * "projects/my-project/metrics/nginx%2Frequests". + * Required. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests". */ name?: string; /** - * Output only. The last update timestamp of the metric.This field may not - * be present for older metrics. + * Output only. The last update timestamp of the metric.This field may not be present for older metrics. */ updateTime?: string; /** - * Optional. A value_extractor is required when using a distribution - * logs-based metric to extract the values to record from a log entry. Two - * functions are supported for value extraction: EXTRACT(field) or - * REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of - * the log entry field from which the value is to be extracted. 2. regex: - * A regular expression using the Google RE2 syntax - * (https://github.com/google/re2/wiki/Syntax) with a single capture group - * to extract data from the specified log entry field. The value of the - * field is converted to a string before applying the regex. It is an error - * to specify a regex that does not include exactly one capture group.The - * result of the extraction must be convertible to a double type, as the - * distribution always records double values. If either the extraction or - * the conversion to double fails, then those values are not recorded in the - * distribution.Example: REGEXP_EXTRACT(jsonPayload.request, - * ".*quantity=(\d+).*") + * Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*") */ valueExtractor?: string; /** - * Deprecated. The API version that created or updated this metric. The v2 - * format is used by default and cannot be changed. + * Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. */ version?: string; } /** - * Describes a sink used to export log entries to one of the following - * destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or - * a Cloud Pub/Sub topic. A logs filter controls which log entries are - * exported. The sink must be created within a project, organization, billing - * account, or folder. + * Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder. */ export interface Schema$LogSink { /** - * Output only. The creation timestamp of the sink.This field may not be - * present for older sinks. + * Output only. The creation timestamp of the sink.This field may not be present for older sinks. */ createTime?: string; /** - * Required. The export destination: - * "storage.googleapis.com/[GCS_BUCKET]" - * "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" - * "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" - * The sink's writer_identity, set when the sink is created, must have - * permission to write to the destination or else the log entries are not - * exported. For more information, see Exporting Logs with Sinks. + * Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks. */ destination?: string; /** - * Optional. An advanced logs filter. The only exported log entries are - * those that are in the resource owning the sink and that match the filter. - * For example: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND - * severity>=ERROR + * Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR */ filter?: string; /** - * Optional. This field applies only to sinks owned by organizations and - * folders. If the field is false, the default, only the logs owned by the - * sink's parent resource are available for export. If the field is - * true, then logs from all the projects, folders, and billing accounts - * contained in the sink's parent resource are also available for - * export. Whether a particular log entry from the children is exported - * depends on the sink's filter expression. For example, if this field - * is true, then the filter resource.type=gce_instance would export all - * Compute Engine VM instance log entries from all projects in the - * sink's parent. To only export entries from certain child projects, - * filter on the project part of the log name: - * logName:("projects/test-project1/" OR - * "projects/test-project2/") AND resource.type=gce_instance + * Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance */ includeChildren?: boolean; /** - * Required. The client-assigned sink identifier, unique within the project. - * Example: "my-syslog-errors-to-pubsub". Sink identifiers are - * limited to 100 characters and can include only the following characters: - * upper and lower-case alphanumeric characters, underscores, hyphens, and - * periods. + * Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. */ name?: string; /** - * Deprecated. The log entry format to use for this sink's exported log - * entries. The v2 format is used by default and cannot be changed. + * Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed. */ outputVersionFormat?: string; /** - * Output only. The last update timestamp of the sink.This field may not be - * present for older sinks. + * Output only. The last update timestamp of the sink.This field may not be present for older sinks. */ updateTime?: string; /** - * Output only. An IAM identity&mdash;a service account or - * group&mdash;under which Logging writes the exported log entries to - * the sink's destination. This field is set by sinks.create and - * sinks.update based on the value of unique_writer_identity in those - * methods.Until you grant this identity write-access to the destination, - * log entry exports from this sink will fail. For more information, see - * Granting Access for a Resource. Consult the destination service's - * documentation to determine the appropriate IAM roles to assign to the - * identity. + * Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity. */ writerIdentity?: string; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -926,18 +640,11 @@ export namespace logging_v2 { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * appengine.googleapis.com/http/server/response_latencies metric type has a - * label for the HTTP response code, response_code, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -945,8 +652,7 @@ export namespace logging_v2 { */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of metric_kind and value_type might not be supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. */ metricKind?: string; /** @@ -954,43 +660,15 @@ export namespace logging_v2 { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * custom.googleapis.com or external.googleapis.com. Metric types should use - * a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are - * a subset of The Unified Code for Units of Measure - * (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit - * By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) - * M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa - * (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro - * (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto - * (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi - * (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes - * these connectors: / division (as an infix operator, e.g. 1/s). . - * multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit - * is as follows: Expression = Component { "." Component } { - * "/" Component } ; Component = ( [ PREFIX ] UNIT | - * "%" ) [ Annotation ] | Annotation | - * "1" ; Annotation = "{" NAME "}" - * ; Notes: Annotation is just a comment if it follows a UNIT and is - * equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, - * By{transmitted}/s == By/s. NAME is a sequence of non-blank printable - * ASCII characters not containing '{' or '}'. 1 represents - * dimensionless value 1, such as in 1/s. % represents dimensionless value - * 1/100, and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of metric_kind and value_type might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. */ valueType?: string; } @@ -999,9 +677,7 @@ export namespace logging_v2 { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** @@ -1009,105 +685,58 @@ export namespace logging_v2 { */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * An object representing a resource that can be used for monitoring, logging, - * billing, or other purposes. Examples include virtual machine instances, - * databases, and storage devices such as disks. The type field identifies a - * MonitoredResourceDescriptor object that describes the resource's - * schema. Information in the labels field identifies the actual resource and - * its attributes according to the schema. For example, a particular Compute - * Engine VM instance could be represented by the following object, because - * the MonitoredResourceDescriptor for "gce_instance" has labels - * "instance_id" and "zone": { "type": - * "gce_instance", "labels": { "instance_id": - * "12345678901234", "zone": - * "us-central1-a" }} + * An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} */ export interface Schema$MonitoredResource { /** - * Required. Values for all of the labels listed in the associated monitored - * resource descriptor. For example, Compute Engine VM instances use the - * labels "project_id", "instance_id", and - * "zone". + * Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone". */ labels?: {[key: string]: string}; /** - * Required. The monitored resource type. This field must match the type - * field of a MonitoredResourceDescriptor object. For example, the type of a - * Compute Engine VM instance is gce_instance. + * Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. */ type?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * "gce_instance" and specifies the use of the labels - * "instance_id" and "zone" to identify particular VM - * instances.Different APIs can support different monitored resource types. - * APIs generally provide a list method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, "Google Cloud - * SQL Database". + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels "database_id" and - * "zone". + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone". */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * "projects/{project_id}/monitoredResourceDescriptors/{type}" - * where {type} is the value of the type field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format "monitoredResourceDescriptors/{type}". + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". */ name?: string; /** - * Required. The monitored resource type. For example, the type - * "cloudsql_database" represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Auxiliary metadata for a MonitoredResource object. MonitoredResource - * objects contain the minimum set of information to uniquely identify a - * monitored resource instance. There is some other useful auxiliary metadata. - * Monitoring and Logging use an ingestion pipeline to extract metadata for - * cloud resources of all types, and store the metadata in this message. + * Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. */ export interface Schema$MonitoredResourceMetadata { /** - * Output only. Values for predefined system metadata labels. System labels - * are a kind of metadata extracted by Google, including - * "machine_image", "vpc", "subnet_id", - * "security_group", "name", etc. System label values - * can be only strings, Boolean values, or a list of strings. For example: { - * "name": "my-test-instance", - * "security_group": ["a", "b", - * "c"], "spot_instance": false } + * Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } */ systemLabels?: {[key: string]: any}; /** @@ -1116,8 +745,7 @@ export namespace logging_v2 { userLabels?: {[key: string]: string}; } /** - * Complete log information about a single HTTP request to an App Engine - * application. + * Complete log information about a single HTTP request to an App Engine application. */ export interface Schema$RequestLog { /** @@ -1141,9 +769,7 @@ export namespace logging_v2 { */ finished?: boolean; /** - * Whether this is the first RequestLog entry for this request. If an active - * request has several RequestLog entries written to Stackdriver Logging, - * then this field will be set for one of them. + * Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them. */ first?: boolean; /** @@ -1159,9 +785,7 @@ export namespace logging_v2 { */ instanceId?: string; /** - * If the instance processing this request belongs to a manually scaled - * module, then this is the 0-based index of the instance. Otherwise, this - * value is -1. + * If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1. */ instanceIndex?: number; /** @@ -1173,8 +797,7 @@ export namespace logging_v2 { */ latency?: string; /** - * A list of log lines emitted by the application while serving this - * request. + * A list of log lines emitted by the application while serving this request. */ line?: Schema$LogLine[]; /** @@ -1182,8 +805,7 @@ export namespace logging_v2 { */ megaCycles?: string; /** - * Request method. Example: "GET", "HEAD", - * "PUT", "POST", "DELETE". + * Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE". */ method?: string; /** @@ -1191,12 +813,7 @@ export namespace logging_v2 { */ moduleId?: string; /** - * The logged-in user who made the request.Most likely, this is the part of - * the user's email before the @ sign. The field value is the same for - * different requests from the same user, but different users can have - * similar names. This information is also available to the application via - * the App Engine Users API.This field will be populated starting with App - * Engine 1.9.21. + * The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21. */ nickname?: string; /** @@ -1208,16 +825,11 @@ export namespace logging_v2 { */ referrer?: string; /** - * Globally unique identifier for a request, which is based on the request - * start time. Request IDs for requests which started later will compare - * greater as strings than those for requests which started earlier. + * Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier. */ requestId?: string; /** - * Contains the path and query portion of the URL that was requested. For - * example, if the URL was "http://example.com/app?name=val", the - * resource would be "/app?name=val". The fragment identifier, - * which is identified by the # character, is not included. + * Contains the path and query portion of the URL that was requested. For example, if the URL was "http://example.com/app?name=val", the resource would be "/app?name=val". The fragment identifier, which is identified by the # character, is not included. */ resource?: string; /** @@ -1225,9 +837,7 @@ export namespace logging_v2 { */ responseSize?: string; /** - * Source code for the application that handled this request. There can be - * more than one source reference per deployed application if source code is - * distributed among multiple repositories. + * Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories. */ sourceReference?: Schema$SourceReference[]; /** @@ -1251,8 +861,7 @@ export namespace logging_v2 { */ traceId?: string; /** - * If true, the value in the 'trace_id' field was sampled for - * storage in a trace backend. + * If true, the value in the 'trace_id' field was sampled for storage in a trace backend. */ traceSampled?: boolean; /** @@ -1277,17 +886,11 @@ export namespace logging_v2 { */ export interface Schema$SourceLocation { /** - * Source file name. Depending on the runtime environment, this might be a - * simple name or a fully-qualified name. + * Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. */ file?: string; /** - * Human-readable name of the function or method being invoked, with - * optional context such as the class or package name. This information is - * used in contexts such as the logs viewer, where a file and line number - * are less meaningful. The format can vary by language. For example: - * qual.if.ied.Class.method (Java), dir/package.func (Go), function - * (Python). + * Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). */ functionName?: string; /** @@ -1296,18 +899,15 @@ export namespace logging_v2 { line?: string; } /** - * A reference to a particular snapshot of the source tree used to build and - * deploy an application. + * A reference to a particular snapshot of the source tree used to build and deploy an application. */ export interface Schema$SourceReference { /** - * Optional. A URI string identifying the repository. Example: - * "https://github.com/GoogleCloudPlatform/kubernetes.git" + * Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" */ repository?: string; /** - * The canonical and persistent identifier of the deployed revision. Example - * (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" + * The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" */ revisionId?: string; } @@ -1316,67 +916,27 @@ export namespace logging_v2 { */ export interface Schema$WriteLogEntriesRequest { /** - * Optional. If true, the request should expect normal response, but the - * entries won't be persisted nor exported. Useful for checking whether - * the logging API endpoints are working properly before sending valuable - * data. + * Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data. */ dryRun?: boolean; /** - * Required. The log entries to send to Logging. The order of log entries in - * this list does not matter. Values supplied in this method's log_name, - * resource, and labels fields are copied into those log entries in this - * list that do not include values for their corresponding fields. For more - * information, see the LogEntry type.If the timestamp or insert_id fields - * are missing in log entries, then this method supplies the current time or - * a unique identifier, respectively. The supplied values are chosen so - * that, among the log entries that did not supply their own values, the - * entries earlier in the list will sort before the entries later in the - * list. See the entries.list method.Log entries with timestamps that are - * more than the logs retention period in the past or more than 24 hours in - * the future will not be available when calling entries.list. However, - * those log entries can still be exported with LogSinks.To improve - * throughput and to avoid exceeding the quota limit for calls to - * entries.write, you should try to include several log entries in this - * list, rather than calling this method for each individual log entry. + * Required. The log entries to send to Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling entries.list. However, those log entries can still be exported with LogSinks.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry. */ entries?: Schema$LogEntry[]; /** - * Optional. Default labels that are added to the labels field of all log - * entries in entries. If a log entry already has a label with the same key - * as a label in this parameter, then the log entry's label is not - * changed. See LogEntry. + * Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry. */ labels?: {[key: string]: string}; /** - * Optional. A default log resource name that is assigned to all log entries - * in entries that do not specify a value for log_name: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be - * URL-encoded. For example: "projects/my-project-id/logs/syslog" - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity" - * The permission <code>logging.logEntries.create</code> is - * needed on each project, organization, billing account, or folder that is - * receiving new log entries, whether the resource is specified in - * <code>logName</code> or in an individual log entry. + * Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example: "projects/my-project-id/logs/syslog" "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity" The permission <code>logging.logEntries.create</code> is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in <code>logName</code> or in an individual log entry. */ logName?: string; /** - * Optional. Whether valid entries should be written even if some other - * entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any - * entry is not written, then the response status is the error associated - * with one of the failed entries and the response includes error details - * keyed by the entries' zero-based index in the entries.write method. + * Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method. */ partialSuccess?: boolean; /** - * Optional. A default monitored resource object that is assigned to all log - * entries in entries that do not specify a value for resource. Example: { - * "type": "gce_instance", "labels": { - * "zone": "us-central1-a", "instance_id": - * "00000000000000000000" }} See LogEntry. + * Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See LogEntry. */ resource?: Schema$MonitoredResource; } @@ -1406,9 +966,7 @@ export namespace logging_v2 { /** * logging.billingAccounts.exclusions.create - * @desc Creates a new exclusion in a specified parent resource. Only log - * entries belonging to that resource can be excluded. You can have up to 10 - * exclusions in a resource. + * @desc Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. * @alias logging.billingAccounts.exclusions.create * @memberOf! () * @@ -1781,10 +1339,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource in which to create the exclusion: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; @@ -1801,12 +1356,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion to delete: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -1818,12 +1368,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -1835,22 +1380,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose exclusions are to be listed. - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -1862,21 +1400,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the exclusion to update: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. - * New values for the fields are taken from the corresponding fields in the - * LogExclusion included in this request. Fields not mentioned in - * update_mask are not changed and are ignored in the request.For example, - * to change the filter and description of an exclusion, specify an - * update_mask of "filter,description". + * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -1894,9 +1422,7 @@ export namespace logging_v2 { /** * logging.billingAccounts.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. * @alias logging.billingAccounts.logs.delete * @memberOf! () * @@ -1965,8 +1491,7 @@ export namespace logging_v2 { /** * logging.billingAccounts.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. * @alias logging.billingAccounts.logs.list * @memberOf! () * @@ -2046,14 +1571,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. + * Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. */ logName?: string; } @@ -2065,22 +1583,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" + * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -2093,10 +1604,7 @@ export namespace logging_v2 { /** * logging.billingAccounts.sinks.create - * @desc Creates a sink that exports specified log entries to a destination. - * The export of newly-ingested log entries begins immediately, unless the - * sink's writer_identity is not permitted to write to the destination. A - * sink can export log entries only from the resource owning the sink. + * @desc Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. * @alias logging.billingAccounts.sinks.create * @memberOf! () * @@ -2170,8 +1678,7 @@ export namespace logging_v2 { /** * logging.billingAccounts.sinks.delete - * @desc Deletes a sink. If the sink has a unique writer_identity, then that - * service account is also deleted. + * @desc Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. * @alias logging.billingAccounts.sinks.delete * @memberOf! () * @@ -2385,10 +1892,7 @@ export namespace logging_v2 { /** * logging.billingAccounts.sinks.patch - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.billingAccounts.sinks.patch * @memberOf! () * @@ -2460,10 +1964,7 @@ export namespace logging_v2 { /** * logging.billingAccounts.sinks.update - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.billingAccounts.sinks.update * @memberOf! () * @@ -2542,23 +2043,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource in which to create the sink: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; /** - * Optional. Determines the kind of IAM identity returned as writer_identity - * in the new sink. If this value is omitted or set to false, and if the - * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Logging before the addition of - * writer identities to this API. The sink's destination must be in the same - * project as the sink itself.If this field is set to true, or if the sink - * is owned by a non-project resource such as an organization, then the - * value of writer_identity will be a unique service account used only for - * exports from the new sink. For more information, see writer_identity in - * LogSink. + * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. */ uniqueWriterIdentity?: boolean; @@ -2575,13 +2064,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to delete, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -2593,12 +2076,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the sink: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -2610,22 +2088,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose sinks are to be listed: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -2637,37 +2108,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -2684,37 +2133,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -2732,9 +2159,7 @@ export namespace logging_v2 { /** * logging.entries.list - * @desc Lists log entries. Use this method to retrieve log entries that - * originated from a project/folder/organization/billing account. For ways - * to export log entries, see Exporting Logs. + * @desc Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs. * @alias logging.entries.list * @memberOf! () * @@ -2806,12 +2231,7 @@ export namespace logging_v2 { /** * logging.entries.write - * @desc Writes log entries to Logging. This API method is the only way to - * send log entries to Logging. This method is used, directly or indirectly, - * by the Logging agent (fluentd) and all logging libraries configured to - * use Logging. A single request may contain log entries for a maximum of - * 1000 different resources (projects, organizations, billing accounts or - * folders) + * @desc Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders) * @alias logging.entries.write * @memberOf! () * @@ -2913,9 +2333,7 @@ export namespace logging_v2 { /** * logging.exclusions.create - * @desc Creates a new exclusion in a specified parent resource. Only log - * entries belonging to that resource can be excluded. You can have up to 10 - * exclusions in a resource. + * @desc Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. * @alias logging.exclusions.create * @memberOf! () * @@ -3285,10 +2703,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource in which to create the exclusion: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; @@ -3305,12 +2720,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion to delete: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -3321,12 +2731,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -3337,22 +2742,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose exclusions are to be listed. - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -3363,21 +2761,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the exclusion to update: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. - * New values for the fields are taken from the corresponding fields in the - * LogExclusion included in this request. Fields not mentioned in - * update_mask are not changed and are ignored in the request.For example, - * to change the filter and description of an exclusion, specify an - * update_mask of "filter,description". + * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -3408,9 +2796,7 @@ export namespace logging_v2 { /** * logging.folders.exclusions.create - * @desc Creates a new exclusion in a specified parent resource. Only log - * entries belonging to that resource can be excluded. You can have up to 10 - * exclusions in a resource. + * @desc Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. * @alias logging.folders.exclusions.create * @memberOf! () * @@ -3783,10 +3169,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource in which to create the exclusion: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; @@ -3803,12 +3186,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion to delete: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -3820,12 +3198,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -3837,22 +3210,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose exclusions are to be listed. - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -3864,21 +3230,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the exclusion to update: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. - * New values for the fields are taken from the corresponding fields in the - * LogExclusion included in this request. Fields not mentioned in - * update_mask are not changed and are ignored in the request.For example, - * to change the filter and description of an exclusion, specify an - * update_mask of "filter,description". + * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -3896,9 +3252,7 @@ export namespace logging_v2 { /** * logging.folders.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. * @alias logging.folders.logs.delete * @memberOf! () * @@ -3967,8 +3321,7 @@ export namespace logging_v2 { /** * logging.folders.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. * @alias logging.folders.logs.list * @memberOf! () * @@ -4048,14 +3401,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. + * Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. */ logName?: string; } @@ -4067,22 +3413,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" + * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -4095,10 +3434,7 @@ export namespace logging_v2 { /** * logging.folders.sinks.create - * @desc Creates a sink that exports specified log entries to a destination. - * The export of newly-ingested log entries begins immediately, unless the - * sink's writer_identity is not permitted to write to the destination. A - * sink can export log entries only from the resource owning the sink. + * @desc Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. * @alias logging.folders.sinks.create * @memberOf! () * @@ -4172,8 +3508,7 @@ export namespace logging_v2 { /** * logging.folders.sinks.delete - * @desc Deletes a sink. If the sink has a unique writer_identity, then that - * service account is also deleted. + * @desc Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. * @alias logging.folders.sinks.delete * @memberOf! () * @@ -4387,10 +3722,7 @@ export namespace logging_v2 { /** * logging.folders.sinks.patch - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.folders.sinks.patch * @memberOf! () * @@ -4462,10 +3794,7 @@ export namespace logging_v2 { /** * logging.folders.sinks.update - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.folders.sinks.update * @memberOf! () * @@ -4544,23 +3873,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource in which to create the sink: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; /** - * Optional. Determines the kind of IAM identity returned as writer_identity - * in the new sink. If this value is omitted or set to false, and if the - * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Logging before the addition of - * writer identities to this API. The sink's destination must be in the same - * project as the sink itself.If this field is set to true, or if the sink - * is owned by a non-project resource such as an organization, then the - * value of writer_identity will be a unique service account used only for - * exports from the new sink. For more information, see writer_identity in - * LogSink. + * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. */ uniqueWriterIdentity?: boolean; @@ -4577,13 +3894,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to delete, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -4595,12 +3906,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the sink: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -4612,22 +3918,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose sinks are to be listed: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -4639,37 +3938,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -4686,37 +3963,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -4734,9 +3989,7 @@ export namespace logging_v2 { /** * logging.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. * @alias logging.logs.delete * @memberOf! () * @@ -4804,8 +4057,7 @@ export namespace logging_v2 { /** * logging.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. * @alias logging.logs.list * @memberOf! () * @@ -4883,14 +4135,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. + * Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. */ logName?: string; } @@ -4901,22 +4146,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" + * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -5028,16 +4266,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; } @@ -5063,9 +4296,7 @@ export namespace logging_v2 { /** * logging.organizations.exclusions.create - * @desc Creates a new exclusion in a specified parent resource. Only log - * entries belonging to that resource can be excluded. You can have up to 10 - * exclusions in a resource. + * @desc Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. * @alias logging.organizations.exclusions.create * @memberOf! () * @@ -5438,10 +4669,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource in which to create the exclusion: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; @@ -5458,12 +4686,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion to delete: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -5475,12 +4698,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -5492,22 +4710,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose exclusions are to be listed. - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -5519,21 +4730,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the exclusion to update: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. - * New values for the fields are taken from the corresponding fields in the - * LogExclusion included in this request. Fields not mentioned in - * update_mask are not changed and are ignored in the request.For example, - * to change the filter and description of an exclusion, specify an - * update_mask of "filter,description". + * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -5551,9 +4752,7 @@ export namespace logging_v2 { /** * logging.organizations.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. * @alias logging.organizations.logs.delete * @memberOf! () * @@ -5622,8 +4821,7 @@ export namespace logging_v2 { /** * logging.organizations.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. * @alias logging.organizations.logs.list * @memberOf! () * @@ -5703,14 +4901,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. + * Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. */ logName?: string; } @@ -5722,22 +4913,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" + * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -5750,10 +4934,7 @@ export namespace logging_v2 { /** * logging.organizations.sinks.create - * @desc Creates a sink that exports specified log entries to a destination. - * The export of newly-ingested log entries begins immediately, unless the - * sink's writer_identity is not permitted to write to the destination. A - * sink can export log entries only from the resource owning the sink. + * @desc Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. * @alias logging.organizations.sinks.create * @memberOf! () * @@ -5827,8 +5008,7 @@ export namespace logging_v2 { /** * logging.organizations.sinks.delete - * @desc Deletes a sink. If the sink has a unique writer_identity, then that - * service account is also deleted. + * @desc Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. * @alias logging.organizations.sinks.delete * @memberOf! () * @@ -6042,10 +5222,7 @@ export namespace logging_v2 { /** * logging.organizations.sinks.patch - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.organizations.sinks.patch * @memberOf! () * @@ -6117,10 +5294,7 @@ export namespace logging_v2 { /** * logging.organizations.sinks.update - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.organizations.sinks.update * @memberOf! () * @@ -6199,23 +5373,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource in which to create the sink: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; /** - * Optional. Determines the kind of IAM identity returned as writer_identity - * in the new sink. If this value is omitted or set to false, and if the - * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Logging before the addition of - * writer identities to this API. The sink's destination must be in the same - * project as the sink itself.If this field is set to true, or if the sink - * is owned by a non-project resource such as an organization, then the - * value of writer_identity will be a unique service account used only for - * exports from the new sink. For more information, see writer_identity in - * LogSink. + * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. */ uniqueWriterIdentity?: boolean; @@ -6232,13 +5394,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to delete, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -6250,12 +5406,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the sink: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -6267,22 +5418,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose sinks are to be listed: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -6294,37 +5438,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -6341,37 +5463,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -6404,9 +5504,7 @@ export namespace logging_v2 { /** * logging.projects.exclusions.create - * @desc Creates a new exclusion in a specified parent resource. Only log - * entries belonging to that resource can be excluded. You can have up to 10 - * exclusions in a resource. + * @desc Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. * @alias logging.projects.exclusions.create * @memberOf! () * @@ -6779,10 +5877,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource in which to create the exclusion: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; @@ -6799,12 +5894,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion to delete: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -6816,12 +5906,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; } @@ -6833,22 +5918,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose exclusions are to be listed. - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -6860,21 +5938,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the exclusion to update: - * "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" - * "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" - * "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: - * "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". */ name?: string; /** - * Required. A nonempty list of fields to change in the existing exclusion. - * New values for the fields are taken from the corresponding fields in the - * LogExclusion included in this request. Fields not mentioned in - * update_mask are not changed and are ignored in the request.For example, - * to change the filter and description of an exclusion, specify an - * update_mask of "filter,description". + * Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; @@ -6892,9 +5960,7 @@ export namespace logging_v2 { /** * logging.projects.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. * @alias logging.projects.logs.delete * @memberOf! () * @@ -6963,8 +6029,7 @@ export namespace logging_v2 { /** * logging.projects.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. * @alias logging.projects.logs.list * @memberOf! () * @@ -7044,14 +6109,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. + * Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. */ logName?: string; } @@ -7063,22 +6121,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" + * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -7463,8 +6514,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the project in which to create the metric: - * "projects/[PROJECT_ID]" The new metric must be provided in the request. + * The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request. */ parent?: string; @@ -7481,8 +6531,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the metric to delete: - * "projects/[PROJECT_ID]/metrics/[METRIC_ID]" + * The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" */ metricName?: string; } @@ -7494,8 +6543,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the desired metric: - * "projects/[PROJECT_ID]/metrics/[METRIC_ID]" + * The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" */ metricName?: string; } @@ -7507,21 +6555,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The name of the project containing the metrics: - * "projects/[PROJECT_ID]" + * Required. The name of the project containing the metrics: "projects/[PROJECT_ID]" */ parent?: string; } @@ -7533,11 +6575,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the metric to update: - * "projects/[PROJECT_ID]/metrics/[METRIC_ID]" The updated metric must be - * provided in the request and it's name field must be the same as - * [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new - * metric is created. + * The resource name of the metric to update: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created. */ metricName?: string; @@ -7555,10 +6593,7 @@ export namespace logging_v2 { /** * logging.projects.sinks.create - * @desc Creates a sink that exports specified log entries to a destination. - * The export of newly-ingested log entries begins immediately, unless the - * sink's writer_identity is not permitted to write to the destination. A - * sink can export log entries only from the resource owning the sink. + * @desc Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. * @alias logging.projects.sinks.create * @memberOf! () * @@ -7632,8 +6667,7 @@ export namespace logging_v2 { /** * logging.projects.sinks.delete - * @desc Deletes a sink. If the sink has a unique writer_identity, then that - * service account is also deleted. + * @desc Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. * @alias logging.projects.sinks.delete * @memberOf! () * @@ -7847,10 +6881,7 @@ export namespace logging_v2 { /** * logging.projects.sinks.patch - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.projects.sinks.patch * @memberOf! () * @@ -7922,10 +6953,7 @@ export namespace logging_v2 { /** * logging.projects.sinks.update - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.projects.sinks.update * @memberOf! () * @@ -8004,23 +7032,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource in which to create the sink: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; /** - * Optional. Determines the kind of IAM identity returned as writer_identity - * in the new sink. If this value is omitted or set to false, and if the - * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Logging before the addition of - * writer identities to this API. The sink's destination must be in the same - * project as the sink itself.If this field is set to true, or if the sink - * is owned by a non-project resource such as an organization, then the - * value of writer_identity will be a unique service account used only for - * exports from the new sink. For more information, see writer_identity in - * LogSink. + * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. */ uniqueWriterIdentity?: boolean; @@ -8037,13 +7053,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to delete, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -8055,12 +7065,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the sink: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -8072,22 +7077,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose sinks are to be listed: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -8099,37 +7097,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -8146,37 +7122,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; @@ -8194,10 +7148,7 @@ export namespace logging_v2 { /** * logging.sinks.create - * @desc Creates a sink that exports specified log entries to a destination. - * The export of newly-ingested log entries begins immediately, unless the - * sink's writer_identity is not permitted to write to the destination. A - * sink can export log entries only from the resource owning the sink. + * @desc Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. * @alias logging.sinks.create * @memberOf! () * @@ -8270,8 +7221,7 @@ export namespace logging_v2 { /** * logging.sinks.delete - * @desc Deletes a sink. If the sink has a unique writer_identity, then that - * service account is also deleted. + * @desc Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. * @alias logging.sinks.delete * @memberOf! () * @@ -8482,10 +7432,7 @@ export namespace logging_v2 { /** * logging.sinks.update - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. + * @desc Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * @alias logging.sinks.update * @memberOf! () * @@ -8562,23 +7509,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource in which to create the sink: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". + * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". */ parent?: string; /** - * Optional. Determines the kind of IAM identity returned as writer_identity - * in the new sink. If this value is omitted or set to false, and if the - * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Logging before the addition of - * writer identities to this API. The sink's destination must be in the same - * project as the sink itself.If this field is set to true, or if the sink - * is owned by a non-project resource such as an organization, then the - * value of writer_identity will be a unique service account used only for - * exports from the new sink. For more information, see writer_identity in - * LogSink. + * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. */ uniqueWriterIdentity?: boolean; @@ -8594,13 +7529,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to delete, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -8611,12 +7540,7 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the sink: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; } @@ -8627,22 +7551,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; /** - * Required. The parent resource whose sinks are to be listed: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } @@ -8653,37 +7570,15 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". */ sinkName?: string; /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. */ uniqueWriterIdentity?: boolean; /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. */ updateMask?: string; diff --git a/src/apis/manufacturers/package.json b/src/apis/manufacturers/package.json index 5bde00fd6c7..31f61a66c4b 100644 --- a/src/apis/manufacturers/package.json +++ b/src/apis/manufacturers/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/manufacturers/v1.ts b/src/apis/manufacturers/v1.ts index 46c5a0b4704..7245cdb26e7 100644 --- a/src/apis/manufacturers/v1.ts +++ b/src/apis/manufacturers/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace manufacturers_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace manufacturers_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,55 +108,49 @@ export namespace manufacturers_v1 { accounts: Resource$Accounts; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); } } /** - * Attributes of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116. + * Attributes of the product. For more information, see https://support.google.com/manufacturers/answer/6124116. */ export interface Schema$Attributes { /** - * The additional images of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#addlimage. + * The additional images of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#addlimage. */ additionalImageLink?: Schema$Image[]; /** - * The target age group of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#agegroup. + * The target age group of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#agegroup. */ ageGroup?: string; /** - * The brand name of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#brand. + * The brand name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#brand. */ brand?: string; /** - * The capacity of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#capacity. + * The capacity of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity. */ capacity?: Schema$Capacity; /** - * The color of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#color. + * The color of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#color. */ color?: string; /** - * The count of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#count. + * The count of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#count. */ count?: Schema$Count; /** - * The description of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#description. + * The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description. */ description?: string; /** - * The disclosure date of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#disclosure. + * The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure. */ disclosureDate?: string; /** @@ -168,33 +158,27 @@ export namespace manufacturers_v1 { */ excludedDestination?: string[]; /** - * The rich format description of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#featuredesc. + * The rich format description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc. */ featureDescription?: Schema$FeatureDescription[]; /** - * The flavor of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#flavor. + * The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor. */ flavor?: string; /** - * The format of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#format. + * The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format. */ format?: string; /** - * The target gender of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#gender. + * The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender. */ gender?: string; /** - * The Global Trade Item Number (GTIN) of the product. For more information, - * see https://support.google.com/manufacturers/answer/6124116#gtin. + * The Global Trade Item Number (GTIN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gtin. */ gtin?: string[]; /** - * The image of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#image. + * The image of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#image. */ imageLink?: Schema$Image; /** @@ -202,105 +186,84 @@ export namespace manufacturers_v1 { */ includedDestination?: string[]; /** - * The item group id of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#itemgroupid. + * The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. */ itemGroupId?: string; /** - * The material of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#material. + * The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. */ material?: string; /** - * The Manufacturer Part Number (MPN) of the product. For more information, - * see https://support.google.com/manufacturers/answer/6124116#mpn. + * The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. */ mpn?: string; /** - * The pattern of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#pattern. + * The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern. */ pattern?: string; /** - * The details of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#productdetail. + * The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. */ productDetail?: Schema$ProductDetail[]; /** - * The name of the group of products related to the product. For more - * information, see - * https://support.google.com/manufacturers/answer/6124116#productline. + * The name of the group of products related to the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productline. */ productLine?: string; /** - * The canonical name of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#productname. + * The canonical name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productname. */ productName?: string; /** - * The URL of the detail page of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#productpage. + * The URL of the detail page of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productpage. */ productPageUrl?: string; /** - * The type or category of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#producttype. + * The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype. */ productType?: string[]; /** - * The release date of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#release. + * The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release. */ releaseDate?: string; /** - * The scent of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#scent. + * The scent of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#scent. */ scent?: string; /** - * The size of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#size. + * The size of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#size. */ size?: string; /** - * The size system of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#sizesystem. + * The size system of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizesystem. */ sizeSystem?: string; /** - * The size type of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#sizetype. + * The size type of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizetype. */ sizeType?: string; /** - * The suggested retail price (MSRP) of the product. For more information, - * see https://support.google.com/manufacturers/answer/6124116#price. + * The suggested retail price (MSRP) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#price. */ suggestedRetailPrice?: Schema$Price; /** - * The target client id. Should only be used in the accounts of the data - * partners. + * The target client id. Should only be used in the accounts of the data partners. */ targetClientId?: string; /** - * The theme of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#theme. + * The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme. */ theme?: string; /** - * The title of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#title. + * The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title. */ title?: string; /** - * The videos of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#video. + * The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video. */ videoLink?: string[]; } /** - * The capacity of a product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#capacity. + * The capacity of a product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity. */ export interface Schema$Capacity { /** @@ -313,8 +276,7 @@ export namespace manufacturers_v1 { value?: string; } /** - * The number of products in a single package. For more information, see - * https://support.google.com/manufacturers/answer/6124116#count. + * The number of products in a single package. For more information, see https://support.google.com/manufacturers/answer/6124116#count. */ export interface Schema$Count { /** @@ -340,16 +302,11 @@ export namespace manufacturers_v1 { status?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A feature description of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#featuredesc. + * A feature description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc. */ export interface Schema$FeatureDescription { /** @@ -370,9 +327,7 @@ export namespace manufacturers_v1 { */ export interface Schema$Image { /** - * The URL of the image. For crawled images, this is the provided URL. For - * uploaded images, this is a serving URL from Google if the image has been - * processed successfully. + * The URL of the image. For crawled images, this is the provided URL. For uploaded images, this is a serving URL from Google if the image has been processed successfully. */ imageUrl?: string; /** @@ -389,9 +344,7 @@ export namespace manufacturers_v1 { */ export interface Schema$Issue { /** - * If present, the attribute that triggered the issue. For more information - * about attributes, see - * https://support.google.com/manufacturers/answer/6124116. + * If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. */ attribute?: string; /** @@ -419,8 +372,7 @@ export namespace manufacturers_v1 { */ title?: string; /** - * The server-generated type of the issue, for example, - * “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc. + * The server-generated type of the issue, for example, “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc. */ type?: string; } @@ -452,13 +404,11 @@ export namespace manufacturers_v1 { */ export interface Schema$Product { /** - * Attributes of the product uploaded to the Manufacturer Center. Manually - * edited attributes are taken into account. + * Attributes of the product uploaded to the Manufacturer Center. Manually edited attributes are taken into account. */ attributes?: Schema$Attributes; /** - * The content language of the product as a two-letter ISO 639-1 language - * code (for example, en). + * The content language of the product as a two-letter ISO 639-1 language code (for example, en). */ contentLanguage?: string; /** @@ -470,34 +420,24 @@ export namespace manufacturers_v1 { */ issues?: Schema$Issue[]; /** - * Name in the format `{target_country}:{content_language}:{product_id}`. - * `target_country` - The target country of the product as a CLDR - * territory code (for example, US). `content_language` - * - The content language of the product as a two-letter ISO 639-1 language - * code (for example, en). `product_id` - The ID of the product. For - * more information, see - * https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID - * of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; /** - * The ID of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#id. + * The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ productId?: string; /** - * The target country of the product as a CLDR territory code (for example, - * US). + * The target country of the product as a CLDR territory code (for example, US). */ targetCountry?: string; } /** - * A product detail of the product. For more information, see - * https://support.google.com/manufacturers/answer/6124116#productdetail. + * A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. */ export interface Schema$ProductDetail { /** @@ -605,11 +545,7 @@ export namespace manufacturers_v1 { /** * manufacturers.accounts.products.get - * @desc Gets the product from a Manufacturer Center account, including - * product issues. A recently updated product takes around 15 minutes to - * process. Changes are only visible after it has been processed. While some - * issues may be available once the product has been processed, other issues - * may take days to appear. + * @desc Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear. * @alias manufacturers.accounts.products.get * @memberOf! () * @@ -764,18 +700,7 @@ export namespace manufacturers_v1 { /** * manufacturers.accounts.products.update - * @desc Inserts or updates the attributes of the product in a Manufacturer - * Center account. Creates a product with the provided attributes. If the - * product already exists, then all attributes are replaced with the new - * ones. The checks at upload time are minimal. All required attributes need - * to be present for a product to be valid. Issues may show up later after - * the API has accepted a new upload for a product and it is possible to - * overwrite an existing valid product with an invalid product. To detect - * this, you should retrieve the product and check it for issues once the - * new version is available. Uploaded attributes first need to be processed - * before they can be retrieved. Until then, new products will be - * unavailable, and retrieval of previously uploaded products will return - * the original state of the product. + * @desc Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product. * @alias manufacturers.accounts.products.update * @memberOf! () * @@ -857,18 +782,11 @@ export namespace manufacturers_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name in the format `{target_country}:{content_language}:{product_id}`. - * `target_country` - The target country of the product as a CLDR - * territory code (for example, US). `content_language` - * - The content language of the product as a two-letter ISO 639-1 language - * code (for example, en). `product_id` - The ID of the product. For - * more information, see - * https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID - * of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; } @@ -880,23 +798,15 @@ export namespace manufacturers_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The information to be included in the response. Only sections listed here - * will be returned. + * The information to be included in the response. Only sections listed here will be returned. */ include?: string[]; /** - * Name in the format `{target_country}:{content_language}:{product_id}`. - * `target_country` - The target country of the product as a CLDR - * territory code (for example, US). `content_language` - * - The content language of the product as a two-letter ISO 639-1 language - * code (for example, en). `product_id` - The ID of the product. For - * more information, see - * https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID - * of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; } @@ -908,13 +818,11 @@ export namespace manufacturers_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The information to be included in the response. Only sections listed here - * will be returned. + * The information to be included in the response. Only sections listed here will be returned. */ include?: string[]; /** - * Maximum number of product statuses to return in the response, used for - * paging. + * Maximum number of product statuses to return in the response, used for paging. */ pageSize?: number; /** @@ -922,8 +830,7 @@ export namespace manufacturers_v1 { */ pageToken?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID - * of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; } @@ -935,18 +842,11 @@ export namespace manufacturers_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name in the format `{target_country}:{content_language}:{product_id}`. - * `target_country` - The target country of the product as a CLDR - * territory code (for example, US). `content_language` - * - The content language of the product as a two-letter ISO 639-1 language - * code (for example, en). `product_id` - The ID of the product. For - * more information, see - * https://support.google.com/manufacturers/answer/6124116#id. + * Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id. */ name?: string; /** - * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID - * of the Manufacturer Center account. + * Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account. */ parent?: string; diff --git a/src/apis/mirror/package.json b/src/apis/mirror/package.json index c05278bfac1..b8201a6afc5 100644 --- a/src/apis/mirror/package.json +++ b/src/apis/mirror/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/mirror/v1.ts b/src/apis/mirror/v1.ts index adef9734556..7a164a9c65a 100644 --- a/src/apis/mirror/v1.ts +++ b/src/apis/mirror/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace mirror_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace mirror_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -100,7 +97,10 @@ export namespace mirror_v1 { timeline: Resource$Timeline; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); this.contacts = new Resource$Contacts(this.context); @@ -121,8 +121,7 @@ export namespace mirror_v1 { userData?: Schema$UserData[]; } /** - * Represents media content, such as a photo, that can be attached to a - * timeline item. + * Represents media content, such as a photo, that can be attached to a timeline item. */ export interface Schema$Attachment { /** @@ -138,15 +137,12 @@ export namespace mirror_v1 { */ id?: string; /** - * Indicates that the contentUrl is not available because the attachment - * content is still being processed. If the caller wishes to retrieve the - * content, it should try again later. + * Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. */ isProcessingContent?: boolean; } /** - * A list of Attachments. This is the response from the server to GET requests - * on the attachments collection. + * A list of Attachments. This is the response from the server to GET requests on the attachments collection. */ export interface Schema$AttachmentsListResponse { /** @@ -167,11 +163,7 @@ export namespace mirror_v1 { */ export interface Schema$Command { /** - * The type of operation this command corresponds to. Allowed values are: - - * TAKE_A_NOTE - Shares a timeline item with the transcription of user - * speech from the "Take a note" voice menu command. - - * POST_AN_UPDATE - Shares a timeline item with the transcription of user - * speech from the "Post an update" voice menu command. + * The type of operation this command corresponds to. Allowed values are: - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. */ type?: string; } @@ -180,17 +172,11 @@ export namespace mirror_v1 { */ export interface Schema$Contact { /** - * A list of voice menu commands that a contact can handle. Glass shows up - * to three contacts for each voice menu command. If there are more than - * that, the three contacts with the highest priority are shown for that - * particular command. + * A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. */ acceptCommands?: Schema$Command[]; /** - * A list of MIME types that a contact supports. The contact will be shown - * to the user if any of its acceptTypes matches any of the types of the - * attachments on the item. If no acceptTypes are given, the contact will be - * shown for all items. + * A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. */ acceptTypes?: string[]; /** @@ -198,14 +184,11 @@ export namespace mirror_v1 { */ displayName?: string; /** - * An ID for this contact. This is generated by the application and is - * treated as an opaque token. + * An ID for this contact. This is generated by the application and is treated as an opaque token. */ id?: string; /** - * Set of image URLs to display for a contact. Most contacts will have a - * single image, but a "group" contact may include up to 8 image - * URLs and they will be resized and cropped into a mosaic on the client. + * Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. */ imageUrls?: string[]; /** @@ -213,44 +196,32 @@ export namespace mirror_v1 { */ kind?: string; /** - * Primary phone number for the contact. This can be a fully-qualified - * number, with country calling code and area code, or a local number. + * Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. */ phoneNumber?: string; /** - * Priority for the contact to determine ordering in a list of contacts. - * Contacts with higher priorities will be shown before ones with lower - * priorities. + * Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. */ priority?: number; /** - * A list of sharing features that a contact can handle. Allowed values are: - * - ADD_CAPTION + * A list of sharing features that a contact can handle. Allowed values are: - ADD_CAPTION */ sharingFeatures?: string[]; /** - * The ID of the application that created this contact. This is populated by - * the API + * The ID of the application that created this contact. This is populated by the API */ source?: string; /** - * Name of this contact as it should be pronounced. If this contact's - * name must be spoken as part of a voice disambiguation menu, this name is - * used as the expected pronunciation. This is useful for contact names with - * unpronounceable characters or whose display spelling is otherwise not - * phonetic. + * Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. */ speakableName?: string; /** - * The type for this contact. This is used for sorting in UIs. Allowed - * values are: - INDIVIDUAL - Represents a single person. This is the - * default. - GROUP - Represents more than a single person. + * The type for this contact. This is used for sorting in UIs. Allowed values are: - INDIVIDUAL - Represents a single person. This is the default. - GROUP - Represents more than a single person. */ type?: string; } /** - * A list of Contacts representing contacts. This is the response from the - * server to GET requests on the contacts collection. + * A list of Contacts representing contacts. This is the response from the server to GET requests on the contacts collection. */ export interface Schema$ContactsListResponse { /** @@ -275,8 +246,7 @@ export namespace mirror_v1 { */ address?: string; /** - * The name to be displayed. This may be a business name or a user-defined - * place, such as "Home". + * The name to be displayed. This may be a business name or a user-defined place, such as "Home". */ displayName?: string; /** @@ -296,14 +266,12 @@ export namespace mirror_v1 { */ longitude?: number; /** - * The time at which this location was captured, formatted according to RFC - * 3339. + * The time at which this location was captured, formatted according to RFC 3339. */ timestamp?: string; } /** - * A list of Locations. This is the response from the server to GET requests - * on the locations collection. + * A list of Locations. This is the response from the server to GET requests on the locations collection. */ export interface Schema$LocationsListResponse { /** @@ -320,67 +288,27 @@ export namespace mirror_v1 { */ export interface Schema$MenuItem { /** - * Controls the behavior when the user picks the menu option. Allowed values - * are: - CUSTOM - Custom action set by the service. When the user selects - * this menuItem, the API triggers a notification to your callbackUrl with - * the userActions.type set to CUSTOM and the userActions.payload set to the - * ID of this menu item. This is the default value. - Built-in actions: - - * REPLY - Initiate a reply to the timeline item using the voice recording - * UI. The creator attribute must be set in the timeline item for this menu - * to be available. - REPLY_ALL - Same behavior as REPLY. The original - * timeline item's recipients will be added to the reply item. - DELETE - * - Delete the timeline item. - SHARE - Share the timeline item with the - * available contacts. - READ_ALOUD - Read the timeline item's - * speakableText aloud; if this field is not set, read the text field; if - * none of those fields are set, this menu item is ignored. - - * GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from - * a menu item (currently, only transcribed text from voice input is - * supported). Subscribe to notifications when users invoke this menu item - * to receive the timeline item ID. Retrieve the media from the timeline - * item in the payload property. - VOICE_CALL - Initiate a phone call using - * the timeline item's creator.phoneNumber attribute as recipient. - - * NAVIGATE - Navigate to the timeline item's location. - TOGGLE_PINNED - * - Toggle the isPinned state of the timeline item. - OPEN_URI - Open the - * payload of the menu item in the browser. - PLAY_VIDEO - Open the payload - * of the menu item in the Glass video player. - SEND_MESSAGE - Initiate - * sending a message to the timeline item's creator: - If the - * creator.phoneNumber is set and Glass is connected to an Android phone, - * the message is an SMS. - Otherwise, if the creator.email is set, the - * message is an email. + * Controls the behavior when the user picks the menu option. Allowed values are: - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. - Built-in actions: - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. - DELETE - Delete the timeline item. - SHARE - Share the timeline item with the available contacts. - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. - NAVIGATE - Navigate to the timeline item's location. - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. - OPEN_URI - Open the payload of the menu item in the browser. - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. - Otherwise, if the creator.email is set, the message is an email. */ action?: string; /** - * The ContextualMenus.Command associated with this MenuItem (e.g. - * READ_ALOUD). The voice label for this command will be displayed in the - * voice menu and the touch label will be displayed in the touch menu. Note - * that the default menu value's display name will be overriden if you - * specify this property. Values that do not correspond to a - * ContextualMenus.Command name will be ignored. + * The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. */ contextual_command?: string; /** - * The ID for this menu item. This is generated by the application and is - * treated as an opaque token. + * The ID for this menu item. This is generated by the application and is treated as an opaque token. */ id?: string; /** - * A generic payload whose meaning changes depending on this MenuItem's - * action. - When the action is OPEN_URI, the payload is the URL of the - * website to view. - When the action is PLAY_VIDEO, the payload is the - * streaming URL of the video - When the action is GET_MEDIA_INPUT, the - * payload is the text transcription of a user's speech input + * A generic payload whose meaning changes depending on this MenuItem's action. - When the action is OPEN_URI, the payload is the URL of the website to view. - When the action is PLAY_VIDEO, the payload is the streaming URL of the video - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input */ payload?: string; /** - * If set to true on a CUSTOM menu item, that item will be removed from the - * menu after it is selected. + * If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. */ removeWhenSelected?: boolean; /** - * For CUSTOM items, a list of values controlling the appearance of the menu - * item in each of its states. A value for the DEFAULT state must be - * provided. If the PENDING or CONFIRMED states are missing, they will not - * be shown. + * For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. */ values?: Schema$MenuValue[]; } @@ -389,9 +317,7 @@ export namespace mirror_v1 { */ export interface Schema$MenuValue { /** - * The name to display for the menu item. If you specify this property for a - * built-in menu item, the default contextual voice command for that menu - * item is not shown. + * The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. */ displayName?: string; /** @@ -399,11 +325,7 @@ export namespace mirror_v1 { */ iconUrl?: string; /** - * The state that this value applies to. Allowed values are: - DEFAULT - - * Default value shown when displayed in the menuItems list. - PENDING - - * Value shown when the menuItem has been selected by the user but can still - * be cancelled. - CONFIRMED - Value shown when the menuItem has been - * selected by the user and can no longer be cancelled. + * The state that this value applies to. Allowed values are: - DEFAULT - Default value shown when displayed in the menuItems list. - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. */ state?: string; } @@ -428,13 +350,11 @@ export namespace mirror_v1 { */ userActions?: Schema$UserAction[]; /** - * The user token provided by the service when it subscribed for - * notifications. + * The user token provided by the service when it subscribed for notifications. */ userToken?: string; /** - * The secret verify token provided by the service when it subscribed for - * notifications. + * The secret verify token provided by the service when it subscribed for notifications. */ verifyToken?: string; } @@ -447,9 +367,7 @@ export namespace mirror_v1 { */ deliveryTime?: string; /** - * Describes how important the notification is. Allowed values are: - - * DEFAULT - Notifications of default importance. A chime will be played to - * alert users. + * Describes how important the notification is. Allowed values are: - DEFAULT - Notifications of default importance. A chime will be played to alert users. */ level?: string; } @@ -458,11 +376,7 @@ export namespace mirror_v1 { */ export interface Schema$Setting { /** - * The setting's ID. The following IDs are valid: - locale - The key - * to the user’s language/locale (BCP 47 identifier) that Glassware should - * use to render localized content. - timezone - The key to the user’s - * current time zone region as defined in the tz database. Example: - * America/Los_Angeles. + * The setting's ID. The following IDs are valid: - locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content. - timezone - The key to the user’s current time zone region as defined in the tz database. Example: America/Los_Angeles. */ id?: string; /** @@ -479,14 +393,11 @@ export namespace mirror_v1 { */ export interface Schema$Subscription { /** - * The URL where notifications should be delivered (must start with - * https://). + * The URL where notifications should be delivered (must start with https://). */ callbackUrl?: string; /** - * The collection to subscribe to. Allowed values are: - timeline - - * Changes in the timeline including insertion, deletion, and updates. - - * locations - Location updates. - settings - Settings updates. + * The collection to subscribe to. Allowed values are: - timeline - Changes in the timeline including insertion, deletion, and updates. - locations - Location updates. - settings - Settings updates. */ collection?: string; /** @@ -498,37 +409,28 @@ export namespace mirror_v1 { */ kind?: string; /** - * Container object for notifications. This is not populated in the - * Subscription resource. + * Container object for notifications. This is not populated in the Subscription resource. */ notification?: Schema$Notification; /** - * A list of operations that should be subscribed to. An empty list - * indicates that all operations on the collection should be subscribed to. - * Allowed values are: - UPDATE - The item has been updated. - INSERT - A - * new item has been inserted. - DELETE - The item has been deleted. - - * MENU_ACTION - A custom menu item has been triggered by the user. + * A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are: - UPDATE - The item has been updated. - INSERT - A new item has been inserted. - DELETE - The item has been deleted. - MENU_ACTION - A custom menu item has been triggered by the user. */ operation?: string[]; /** - * The time at which this subscription was last modified, formatted - * according to RFC 3339. + * The time at which this subscription was last modified, formatted according to RFC 3339. */ updated?: string; /** - * An opaque token sent to the subscriber in notifications so that it can - * determine the ID of the user. + * An opaque token sent to the subscriber in notifications so that it can determine the ID of the user. */ userToken?: string; /** - * A secret token sent to the subscriber in notifications so that it can - * verify that the notification was generated by Google. + * A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google. */ verifyToken?: string; } /** - * A list of Subscriptions. This is the response from the server to GET - * requests on the subscription collection. + * A list of Subscriptions. This is the response from the server to GET requests on the subscription collection. */ export interface Schema$SubscriptionsListResponse { /** @@ -541,29 +443,19 @@ export namespace mirror_v1 { kind?: string; } /** - * Each item in the user's timeline is represented as a TimelineItem JSON - * structure, described below. + * Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. */ export interface Schema$TimelineItem { /** - * A list of media attachments associated with this item. As a convenience, - * you can refer to attachments in your HTML payloads with the attachment or - * cid scheme. For example: - attachment: <img - * src="attachment:attachment_index"> where attachment_index is - * the 0-based index of this array. - cid: <img - * src="cid:attachment_id"> where attachment_id is the ID of - * the attachment. + * A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. */ attachments?: Schema$Attachment[]; /** - * The bundle ID for this item. Services can specify a bundleId to group - * many items together. They appear under a single top-level item on the - * device. + * The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. */ bundleId?: string; /** - * A canonical URL pointing to the canonical/high quality version of the - * data represented by the timeline item. + * A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. */ canonicalUrl?: string; /** @@ -575,11 +467,7 @@ export namespace mirror_v1 { */ creator?: Schema$Contact; /** - * The time that should be displayed when this item is viewed in the - * timeline, formatted according to RFC 3339. This user's timeline is - * sorted chronologically on display time, so this will also determine where - * the item is displayed in the timeline. If not set by the service, the - * display time defaults to the updated time. + * The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. */ displayTime?: string; /** @@ -587,19 +475,7 @@ export namespace mirror_v1 { */ etag?: string; /** - * HTML content for this item. If both text and html are provided for an - * item, the html will be rendered in the timeline. Allowed HTML elements - - * You can use these elements in your timeline cards. - Headers: h1, h2, - * h3, h4, h5, h6 - Images: img - Lists: li, ol, ul - HTML5 semantics: - * article, aside, details, figure, figcaption, footer, header, nav, - * section, summary, time - Structural: blockquote, br, div, hr, p, span - - * Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, - * sup - Tables: table, tbody, td, tfoot, th, thead, tr Blocked HTML - * elements: These elements and their contents are removed from HTML - * payloads. - Document headers: head, title - Embeds: audio, embed, - * object, source, video - Frames: frame, frameset - Scripting: applet, - * script Other elements: Any elements that aren't listed are removed, - * but their contents are preserved. + * HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. Allowed HTML elements - You can use these elements in your timeline cards. - Headers: h1, h2, h3, h4, h5, h6 - Images: img - Lists: li, ol, ul - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time - Structural: blockquote, br, div, hr, p, span - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup - Tables: table, tbody, td, tfoot, th, thead, tr Blocked HTML elements: These elements and their contents are removed from HTML payloads. - Document headers: head, title - Embeds: audio, embed, object, source, video - Frames: frame, frameset - Scripting: applet, script Other elements: Any elements that aren't listed are removed, but their contents are preserved. */ html?: string; /** @@ -607,32 +483,19 @@ export namespace mirror_v1 { */ id?: string; /** - * If this item was generated as a reply to another item, this field will be - * set to the ID of the item being replied to. This can be used to attach a - * reply to the appropriate conversation or post. + * If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. */ inReplyTo?: string; /** - * Whether this item is a bundle cover. If an item is marked as a bundle - * cover, it will be the entry point to the bundle of items that have the - * same bundleId as that item. It will be shown only on the main timeline — - * not within the opened bundle. On the main timeline, items that are shown - * are: - Items that have isBundleCover set to true - Items that do not - * have a bundleId In a bundle sub-timeline, items that are shown are: - - * Items that have the bundleId in question AND isBundleCover set to false + * Whether this item is a bundle cover. If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. On the main timeline, items that are shown are: - Items that have isBundleCover set to true - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: - Items that have the bundleId in question AND isBundleCover set to false */ isBundleCover?: boolean; /** - * When true, indicates this item is deleted, and only the ID property is - * set. + * When true, indicates this item is deleted, and only the ID property is set. */ isDeleted?: boolean; /** - * When true, indicates this item is pinned, which means it's grouped - * alongside "active" items like navigation and hangouts, on the - * opposite side of the home screen from historical (non-pinned) timeline - * items. You can allow the user to toggle the value of this property with - * the TOGGLE_PINNED built-in menu item. + * When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. */ isPinned?: boolean; /** @@ -644,19 +507,15 @@ export namespace mirror_v1 { */ location?: Schema$Location; /** - * A list of menu items that will be presented to the user when this item is - * selected in the timeline. + * A list of menu items that will be presented to the user when this item is selected in the timeline. */ menuItems?: Schema$MenuItem[]; /** - * Controls how notifications for this item are presented on the device. If - * this is missing, no notification will be generated. + * Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. */ notification?: Schema$NotificationConfig; /** - * For pinned items, this determines the order in which the item is - * displayed in the timeline, with a higher score appearing closer to the - * clock. Note: setting this field is currently not supported. + * For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. */ pinScore?: number; /** @@ -668,30 +527,15 @@ export namespace mirror_v1 { */ selfLink?: string; /** - * Opaque string you can use to map a timeline item to data in your own - * service. + * Opaque string you can use to map a timeline item to data in your own service. */ sourceItemId?: string; /** - * The speakable version of the content of this item. Along with the - * READ_ALOUD menu item, use this field to provide text that would be - * clearer when read aloud, or to provide extended information to what is - * displayed visually on Glass. Glassware should also specify the - * speakableType field, which will be spoken before this text in cases where - * the additional context is useful, for example when the user requests that - * the item be read aloud following a notification. + * The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. */ speakableText?: string; /** - * A speakable description of the type of this item. This will be announced - * to the user prior to reading the content of the item in cases where the - * additional context is useful, for example when the user requests that the - * item be read aloud following a notification. This should be a short, - * simple noun phrase such as "Email", "Text message", - * or "Daily Planet News Update". Glassware are encouraged to - * populate this field for every timeline item, even if the item does not - * contain speakableText or text so that the user can learn the type of the - * item without looking at the screen. + * A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. */ speakableType?: string; /** @@ -703,14 +547,12 @@ export namespace mirror_v1 { */ title?: string; /** - * The time at which this item was last modified, formatted according to RFC - * 3339. + * The time at which this item was last modified, formatted according to RFC 3339. */ updated?: string; } /** - * A list of timeline items. This is the response from the server to GET - * requests on the timeline collection. + * A list of timeline items. This is the response from the server to GET requests on the timeline collection. */ export interface Schema$TimelineListResponse { /** @@ -722,8 +564,7 @@ export namespace mirror_v1 { */ kind?: string; /** - * The next page token. Provide this as the pageToken parameter in the - * request to retrieve the next page of results. + * The next page token. Provide this as the pageToken parameter in the request to retrieve the next page of results. */ nextPageToken?: string; } @@ -732,19 +573,11 @@ export namespace mirror_v1 { */ export interface Schema$UserAction { /** - * An optional payload for the action. For actions of type CUSTOM, this is - * the ID of the custom menu item that was selected. + * An optional payload for the action. For actions of type CUSTOM, this is the ID of the custom menu item that was selected. */ payload?: string; /** - * The type of action. The value of this can be: - SHARE - the user shared - * an item. - REPLY - the user replied to an item. - REPLY_ALL - the user - * replied to all recipients of an item. - CUSTOM - the user selected a - * custom menu item on the timeline item. - DELETE - the user deleted the - * item. - PIN - the user pinned the item. - UNPIN - the user unpinned the - * item. - LAUNCH - the user initiated a voice command. In the future, - * additional types may be added. UserActions with unrecognized types should - * be ignored. + * The type of action. The value of this can be: - SHARE - the user shared an item. - REPLY - the user replied to an item. - REPLY_ALL - the user replied to all recipients of an item. - CUSTOM - the user selected a custom menu item on the timeline item. - DELETE - the user deleted the item. - PIN - the user pinned the item. - UNPIN - the user unpinned the item. - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored. */ type?: string; } @@ -1624,11 +1457,7 @@ export namespace mirror_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the setting. The following IDs are valid: - locale - The key - * to the user’s language/locale (BCP 47 identifier) that Glassware should - * use to render localized content. - timezone - The key to the user’s - * current time zone region as defined in the tz database. Example: - * America/Los_Angeles. + * The ID of the setting. The following IDs are valid: - locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content. - timezone - The key to the user’s current time zone region as defined in the tz database. Example: America/Los_Angeles. */ id?: string; } @@ -1787,8 +1616,7 @@ export namespace mirror_v1 { /** * mirror.subscriptions.list - * @desc Retrieves a list of subscriptions for the authenticated user and - * service. + * @desc Retrieves a list of subscriptions for the authenticated user and service. * @alias mirror.subscriptions.list * @memberOf! () * @@ -2306,8 +2134,7 @@ export namespace mirror_v1 { /** * mirror.timeline.patch - * @desc Updates a timeline item in place. This method supports patch - * semantics. + * @desc Updates a timeline item in place. This method supports patch semantics. * @alias mirror.timeline.patch * @memberOf! () * @@ -2673,8 +2500,7 @@ export namespace mirror_v1 { /** * mirror.timeline.attachments.get - * @desc Retrieves an attachment on a timeline item by item ID and - * attachment ID. + * @desc Retrieves an attachment on a timeline item by item ID and attachment ID. * @alias mirror.timeline.attachments.get * @memberOf! () * diff --git a/src/apis/ml/package.json b/src/apis/ml/package.json index 6befc514828..ce166378694 100644 --- a/src/apis/ml/package.json +++ b/src/apis/ml/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 7658d1d9cff..4760f10aa01 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace ml_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace ml_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace ml_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); @@ -121,29 +120,11 @@ export namespace ml_v1 { } /** - * Message that represents an arbitrary HTTP body. It should only be used for - * payload formats that can't be represented as JSON, such as raw binary - * or an HTML page. This message can be used both in streaming and - * non-streaming API methods in the request as well as the response. It can - * be used as a top-level request field, which is convenient if one wants to - * extract parameters from either the URL or HTTP template into the request - * fields and also want access to the raw HTTP body. Example: message - * GetResourceRequest { // A unique request id. string request_id - * = 1; // The raw HTTP body is bound to this field. - * google.api.HttpBody http_body = 2; } service ResourceService { rpc - * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); - * } Example with streaming methods: service CaldavService { rpc - * GetCalendar(stream google.api.HttpBody) returns (stream - * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - * returns (stream google.api.HttpBody); } Use of this type only changes - * how the request and response bodies are handled, all other features will - * continue to work unchanged. + * Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. */ export interface Schema$GoogleApi__HttpBody { /** - * The HTTP Content-Type header value specifying the content type of the - * body. + * The HTTP Content-Type header value specifying the content type of the body. */ contentType?: string; /** @@ -151,8 +132,7 @@ export namespace ml_v1 { */ data?: string; /** - * Application specific response metadata. Must be set in the first response - * for streaming APIs. + * Application specific response metadata. Must be set in the first response for streaming APIs. */ extensions?: Array<{[key: string]: any}>; } @@ -187,26 +167,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__AutoScaling { /** - * Optional. The minimum number of nodes to allocate for this model. These - * nodes are always up, starting from the time the model is deployed. - * Therefore, the cost of operating this model will be at least `rate` * - * `min_nodes` * number of hours since last billing cycle, where `rate` is - * the cost per node-hour as documented in the [pricing - * guide](/ml-engine/docs/pricing), even if no predictions are performed. - * There is additional cost for each prediction performed. Unlike manual - * scaling, if the load gets too heavy for the nodes that are up, the - * service will automatically add nodes to handle the increased load as well - * as scale back as traffic drops, always maintaining at least `min_nodes`. - * You will be charged for the time in which additional nodes are used. If - * not specified, `min_nodes` defaults to 0, in which case, when traffic to - * a model stops (and after a cool-down period), nodes will be shut down and - * no charges will be incurred until traffic to the model resumes. You can - * set `min_nodes` when creating the model version, and you can also update - * `min_nodes` for an existing version: <pre> update_body.json: { - * 'autoScaling': { 'minNodes': 5 } } </pre> - * HTTP request: <pre> PATCH - * https://ml.googleapis.com/v1/{name=projects/x/models/x/versions/*}?update_mask=autoScaling.minNodes - * -d @./update_body.json </pre> + * Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If not specified, `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: <pre> update_body.json: { 'autoScaling': { 'minNodes': 5 } } </pre> HTTP request: <pre> PATCH https://ml.googleapis.com/v1/{name=projects/x/models/x/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json </pre> */ minNodes?: number; } @@ -219,9 +180,7 @@ export namespace ml_v1 { */ framework?: string; /** - * The Cloud Storage path to the `model/` directory where the training job - * saves the trained model. Only set for successful jobs that don't use - * hyperparameter tuning. + * The Cloud Storage path to the `model/` directory where the training job saves the trained model. Only set for successful jobs that don't use hyperparameter tuning. */ modelPath?: string; /** @@ -229,8 +188,7 @@ export namespace ml_v1 { */ pythonVersion?: string; /** - * Cloud ML Engine runtime version on which the built-in algorithm was - * trained. + * Cloud ML Engine runtime version on which the built-in algorithm was trained. */ runtimeVersion?: string; } @@ -266,20 +224,15 @@ export namespace ml_v1 { serviceAccountProject?: string; } /** - * Represents the result of a single hyperparameter tuning trial from a - * training job. The TrainingOutput object that is returned on successful - * completion of a training job with hyperparameter tuning includes a list of - * HyperparameterOutput objects, one for each successful trial. + * Represents the result of a single hyperparameter tuning trial from a training job. The TrainingOutput object that is returned on successful completion of a training job with hyperparameter tuning includes a list of HyperparameterOutput objects, one for each successful trial. */ export interface Schema$GoogleCloudMlV1__HyperparameterOutput { /** - * All recorded object metrics for this trial. This field is not currently - * populated. + * All recorded object metrics for this trial. This field is not currently populated. */ allMetrics?: Schema$GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric[]; /** - * Details related to built-in algorithms jobs. Only set for trials of - * built-in algorithms jobs that have succeeded. + * Details related to built-in algorithms jobs. Only set for trials of built-in algorithms jobs that have succeeded. */ builtInAlgorithmOutput?: Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput; /** @@ -304,51 +257,31 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__HyperparameterSpec { /** - * Optional. The search algorithm specified for the hyperparameter tuning - * job. Uses the default CloudML Engine hyperparameter tuning algorithm if - * unspecified. + * Optional. The search algorithm specified for the hyperparameter tuning job. Uses the default CloudML Engine hyperparameter tuning algorithm if unspecified. */ algorithm?: string; /** - * Optional. Indicates if the hyperparameter tuning job enables auto trial - * early stopping. + * Optional. Indicates if the hyperparameter tuning job enables auto trial early stopping. */ enableTrialEarlyStopping?: boolean; /** - * Required. The type of goal to use for tuning. Available types are - * `MAXIMIZE` and `MINIMIZE`. Defaults to `MAXIMIZE`. + * Required. The type of goal to use for tuning. Available types are `MAXIMIZE` and `MINIMIZE`. Defaults to `MAXIMIZE`. */ goal?: string; /** - * Optional. The Tensorflow summary tag name to use for optimizing trials. - * For current versions of Tensorflow, this tag name should exactly match - * what is shown in Tensorboard, including all scopes. For versions of - * Tensorflow prior to 0.12, this should be only the tag passed to - * tf.Summary. By default, "training/hptuning/metric" will be - * used. + * Optional. The Tensorflow summary tag name to use for optimizing trials. For current versions of Tensorflow, this tag name should exactly match what is shown in Tensorboard, including all scopes. For versions of Tensorflow prior to 0.12, this should be only the tag passed to tf.Summary. By default, "training/hptuning/metric" will be used. */ hyperparameterMetricTag?: string; /** - * Optional. The number of failed trials that need to be seen before failing - * the hyperparameter tuning job. You can specify this field to override the - * default failing criteria for Cloud ML Engine hyperparameter tuning jobs. - * Defaults to zero, which means the service decides when a hyperparameter - * job should fail. + * Optional. The number of failed trials that need to be seen before failing the hyperparameter tuning job. You can specify this field to override the default failing criteria for Cloud ML Engine hyperparameter tuning jobs. Defaults to zero, which means the service decides when a hyperparameter job should fail. */ maxFailedTrials?: number; /** - * Optional. The number of training trials to run concurrently. You can - * reduce the time it takes to perform hyperparameter tuning by adding - * trials in parallel. However, each trail only benefits from the - * information gained in completed trials. That means that a trial does not - * get access to the results of trials running at the same time, which could - * reduce the quality of the overall optimization. Each trial will use the - * same scale tier and machine types. Defaults to one. + * Optional. The number of training trials to run concurrently. You can reduce the time it takes to perform hyperparameter tuning by adding trials in parallel. However, each trail only benefits from the information gained in completed trials. That means that a trial does not get access to the results of trials running at the same time, which could reduce the quality of the overall optimization. Each trial will use the same scale tier and machine types. Defaults to one. */ maxParallelTrials?: number; /** - * Optional. How many training trials should be attempted to optimize the - * specified hyperparameters. Defaults to one. + * Optional. How many training trials should be attempted to optimize the specified hyperparameters. Defaults to one. */ maxTrials?: number; /** @@ -356,9 +289,7 @@ export namespace ml_v1 { */ params?: Schema$GoogleCloudMlV1__ParameterSpec[]; /** - * Optional. The prior hyperparameter tuning job id that users hope to - * continue with. The job id will be used to find the corresponding vizier - * study guid and resume the study. + * Optional. The prior hyperparameter tuning job id that users hope to continue with. The job id will be used to find the corresponding vizier study guid and resume the study. */ resumePreviousJobId?: string; } @@ -379,13 +310,7 @@ export namespace ml_v1 { */ errorMessage?: string; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a job from overwriting each other. It is - * strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform job updates in order to avoid race - * conditions: An `etag` is returned in the response to `GetJob`, and - * systems are expected to put that etag in the request to `UpdateJob` to - * ensure that their change will be applied to the same version of the job. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job. */ etag?: string; /** @@ -393,12 +318,7 @@ export namespace ml_v1 { */ jobId?: string; /** - * Optional. One or more labels that you can add, to organize your jobs. - * Each label is a key-value pair, where both the key and the value are - * arbitrary strings that you supply. For more information, see the - * documentation on <a - * href="/ml-engine/docs/tensorflow/resource-labels">using - * labels</a>. + * Optional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on <a href="/ml-engine/docs/tensorflow/resource-labels">using labels</a>. */ labels?: {[key: string]: string}; /** @@ -435,8 +355,7 @@ export namespace ml_v1 { */ jobs?: Schema$GoogleCloudMlV1__Job[]; /** - * Optional. Pass this token as the `page_token` field of the request for a - * subsequent call. + * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ nextPageToken?: string; } @@ -446,8 +365,7 @@ export namespace ml_v1 { */ locations?: Schema$GoogleCloudMlV1__Location[]; /** - * Optional. Pass this token as the `page_token` field of the request for a - * subsequent call. + * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ nextPageToken?: string; } @@ -460,8 +378,7 @@ export namespace ml_v1 { */ models?: Schema$GoogleCloudMlV1__Model[]; /** - * Optional. Pass this token as the `page_token` field of the request for a - * subsequent call. + * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ nextPageToken?: string; } @@ -470,8 +387,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__ListVersionsResponse { /** - * Optional. Pass this token as the `page_token` field of the request for a - * subsequent call. + * Optional. Pass this token as the `page_token` field of the request for a subsequent call. */ nextPageToken?: string; /** @@ -491,24 +407,16 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__ManualScaling { /** - * The number of nodes to allocate for this model. These nodes are always - * up, starting from the time the model is deployed, so the cost of - * operating this model will be proportional to `nodes` * number of hours - * since last billing cycle plus the cost for each prediction performed. + * The number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed, so the cost of operating this model will be proportional to `nodes` * number of hours since last billing cycle plus the cost for each prediction performed. */ nodes?: number; } /** - * Represents a machine learning solution. A model can have multiple - * versions, each of which is a deployed, trained model ready to receive - * prediction requests. The model itself is just a container. + * Represents a machine learning solution. A model can have multiple versions, each of which is a deployed, trained model ready to receive prediction requests. The model itself is just a container. */ export interface Schema$GoogleCloudMlV1__Model { /** - * Output only. The default version of the model. This version will be used - * to handle prediction requests that do not specify a version. You can - * change the default version by calling - * [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). + * Output only. The default version of the model. This version will be used to handle prediction requests that do not specify a version. You can change the default version by calling [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). */ defaultVersion?: Schema$GoogleCloudMlV1__Version; /** @@ -516,57 +424,27 @@ export namespace ml_v1 { */ description?: string; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a model from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform model updates in order to avoid race - * conditions: An `etag` is returned in the response to `GetModel`, and - * systems are expected to put that etag in the request to `UpdateModel` to - * ensure that their change will be applied to the model as intended. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetModel`, and systems are expected to put that etag in the request to `UpdateModel` to ensure that their change will be applied to the model as intended. */ etag?: string; /** - * Optional. One or more labels that you can add, to organize your models. - * Each label is a key-value pair, where both the key and the value are - * arbitrary strings that you supply. For more information, see the - * documentation on <a - * href="/ml-engine/docs/tensorflow/resource-labels">using - * labels</a>. + * Optional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on <a href="/ml-engine/docs/tensorflow/resource-labels">using labels</a>. */ labels?: {[key: string]: string}; /** - * Required. The name specified for the model when it was created. The - * model name must be unique within the project it is created in. + * Required. The name specified for the model when it was created. The model name must be unique within the project it is created in. */ name?: string; /** - * Optional. If true, enables logging of stderr and stdout streams for - * online prediction in Stackdriver Logging. These can be more verbose than - * the standard access logs (see `online_prediction_logging`) and thus can - * incur higher cost. However, they are helpful for debugging. Note that - * since Stackdriver logs may incur a cost, particularly if the total QPS in - * your project is high, be sure to estimate your costs before enabling this - * flag. Default is false. + * Optional. If true, enables logging of stderr and stdout streams for online prediction in Stackdriver Logging. These can be more verbose than the standard access logs (see `online_prediction_logging`) and thus can incur higher cost. However, they are helpful for debugging. Note that since Stackdriver logs may incur a cost, particularly if the total QPS in your project is high, be sure to estimate your costs before enabling this flag. Default is false. */ onlinePredictionConsoleLogging?: boolean; /** - * Optional. If true, online prediction access logs are sent to StackDriver - * Logging. These logs are like standard server access logs, containing - * information like timestamp and latency for each request. Note that - * Stackdriver logs may incur a cost, particular if the total QPS in your - * project is high. Default is false. + * Optional. If true, online prediction access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that Stackdriver logs may incur a cost, particular if the total QPS in your project is high. Default is false. */ onlinePredictionLogging?: boolean; /** - * Optional. The list of regions where the model is going to be deployed. - * Currently only one region per model is supported. Defaults to - * 'us-central1' if nothing is set. See the <a - * href="/ml-engine/docs/tensorflow/regions">available - * regions</a> for ML Engine services. Note: * No matter where a - * model is deployed, it can always be accessed by users from anywhere, - * both for online and batch prediction. * The region for a batch - * prediction job is set by the region field when submitting the batch - * prediction job and does not take its value from this field. + * Optional. The list of regions where the model is going to be deployed. Currently only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for ML Engine services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field. */ regions?: string[]; } @@ -587,8 +465,7 @@ export namespace ml_v1 { */ isCancellationRequested?: boolean; /** - * The user labels, inherited from the model or the model version being - * operated on. + * The user labels, inherited from the model or the model version being operated on. */ labels?: {[key: string]: string}; /** @@ -621,32 +498,23 @@ export namespace ml_v1 { */ categoricalValues?: string[]; /** - * Required if type is `DISCRETE`. A list of feasible points. The list - * should be in strictly increasing order. For instance, this parameter - * might have possible settings of 1.5, 2.5, and 4.0. This list should not - * contain more than 1,000 values. + * Required if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values. */ discreteValues?: number[]; /** - * Required if type is `DOUBLE` or `INTEGER`. This field should be unset if - * type is `CATEGORICAL`. This value should be integers if type is - * `INTEGER`. + * Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is `INTEGER`. */ maxValue?: number; /** - * Required if type is `DOUBLE` or `INTEGER`. This field should be unset if - * type is `CATEGORICAL`. This value should be integers if type is INTEGER. + * Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type is `CATEGORICAL`. This value should be integers if type is INTEGER. */ minValue?: number; /** - * Required. The parameter name must be unique amongst all ParameterConfigs - * in a HyperparameterSpec message. E.g., "learning_rate". + * Required. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., "learning_rate". */ parameterName?: string; /** - * Optional. How the parameter should be scaled to the hypercube. Leave - * unset for categorical parameters. Some kind of scaling is strongly - * recommended for real or integral parameters (e.g., `UNIT_LINEAR_SCALE`). + * Optional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., `UNIT_LINEAR_SCALE`). */ scaleType?: string; /** @@ -659,10 +527,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__PredictionInput { /** - * Optional. Number of records per batch, defaults to 64. The service will - * buffer batch_size number of records in memory before invoking one - * Tensorflow prediction call internally. So take the record size and memory - * available into consideration when setting this parameter. + * Optional. Number of records per batch, defaults to 64. The service will buffer batch_size number of records in memory before invoking one Tensorflow prediction call internally. So take the record size and memory available into consideration when setting this parameter. */ batchSize?: string; /** @@ -670,20 +535,15 @@ export namespace ml_v1 { */ dataFormat?: string; /** - * Required. The Cloud Storage location of the input data files. May contain - * <a - * href="/storage/docs/gsutil/addlhelp/WildcardNames">wildcards</a>. + * Required. The Cloud Storage location of the input data files. May contain <a href="/storage/docs/gsutil/addlhelp/WildcardNames">wildcards</a>. */ inputPaths?: string[]; /** - * Optional. The maximum number of workers to be used for parallel - * processing. Defaults to 10 if not specified. + * Optional. The maximum number of workers to be used for parallel processing. Defaults to 10 if not specified. */ maxWorkerCount?: string; /** - * Use this field if you want to use the default version for the specified - * model. The string must use the following format: - * `"projects/YOUR_PROJECT/models/YOUR_MODEL"` + * Use this field if you want to use the default version for the specified model. The string must use the following format: `"projects/YOUR_PROJECT/models/YOUR_MODEL"` */ modelName?: string; /** @@ -695,39 +555,23 @@ export namespace ml_v1 { */ outputPath?: string; /** - * Required. The Google Compute Engine region to run the prediction job in. - * See the <a - * href="/ml-engine/docs/tensorflow/regions">available - * regions</a> for ML Engine services. + * Required. The Google Compute Engine region to run the prediction job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for ML Engine services. */ region?: string; /** - * Optional. The Cloud ML Engine runtime version to use for this batch - * prediction. If not set, Cloud ML Engine will pick the runtime version - * used during the CreateVersion request for this model version, or choose - * the latest stable version when model version information is not available - * such as when the model is specified by uri. + * Optional. The Cloud ML Engine runtime version to use for this batch prediction. If not set, Cloud ML Engine will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri. */ runtimeVersion?: string; /** - * Optional. The name of the signature defined in the SavedModel to use for - * this job. Please refer to - * [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) for - * information about how to use signatures. Defaults to - * [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/tf/saved_model/signature_constants) - * , which is "serving_default". + * Optional. The name of the signature defined in the SavedModel to use for this job. Please refer to [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) for information about how to use signatures. Defaults to [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/tf/saved_model/signature_constants) , which is "serving_default". */ signatureName?: string; /** - * Use this field if you want to specify a Google Cloud Storage path for the - * model to use. + * Use this field if you want to specify a Google Cloud Storage path for the model to use. */ uri?: string; /** - * Use this field if you want to specify a version of the model to use. The - * string is formatted the same way as `model_version`, with the addition of - * the version information: - * `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"` + * Use this field if you want to specify a version of the model to use. The string is formatted the same way as `model_version`, with the addition of the version information: `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"` */ versionName?: string; } @@ -744,8 +588,7 @@ export namespace ml_v1 { */ nodeHours?: number; /** - * The output Google Cloud Storage location provided at the job creation - * time. + * The output Google Cloud Storage location provided at the job creation time. */ outputPath?: string; /** @@ -767,15 +610,11 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__ReplicaConfig { /** - * Represents the type and number of accelerators used by the replica. - * [Learn about restrictions on accelerator configurations for - * training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) + * Represents the type and number of accelerators used by the replica. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) */ acceleratorConfig?: Schema$GoogleCloudMlV1__AcceleratorConfig; /** - * The Docker image to run on the replica. This image must be in Container - * Registry. Learn more about [configuring custom - * containers](/ml-engine/docs/distributed-training-containers). + * The Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ imageUri?: string; } @@ -784,13 +623,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__SetDefaultVersionRequest {} /** - * Represents input parameters for a training job. When using the gcloud - * command to submit your training job, you can specify the input parameters - * as command-line arguments and/or in a YAML configuration file referenced - * from the --config command-line argument. For details, see the guide to - * <a - * href="/ml-engine/docs/tensorflow/training-jobs">submitting a - * training job</a>. + * Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to <a href="/ml-engine/docs/tensorflow/training-jobs">submitting a training job</a>. */ export interface Schema$GoogleCloudMlV1__TrainingInput { /** @@ -802,119 +635,31 @@ export namespace ml_v1 { */ hyperparameters?: Schema$GoogleCloudMlV1__HyperparameterSpec; /** - * Optional. A Google Cloud Storage path in which to store training outputs - * and other data needed for training. This path is passed to your - * TensorFlow program as the '--job-dir' command-line argument. The - * benefit of specifying this field is that Cloud ML validates the path for - * use in training. + * Optional. A Google Cloud Storage path in which to store training outputs and other data needed for training. This path is passed to your TensorFlow program as the '--job-dir' command-line argument. The benefit of specifying this field is that Cloud ML validates the path for use in training. */ jobDir?: string; /** - * Optional. The configuration for your master worker. You should only set - * `masterConfig.acceleratorConfig` if `masterType` is set to a Compute - * Engine machine type. Learn about [restrictions on accelerator - * configurations for - * training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) - * Set `masterConfig.imageUri` only if you build a custom image. Only one of - * `masterConfig.imageUri` and `runtimeVersion` should be set. Learn more - * about [configuring custom - * containers](/ml-engine/docs/distributed-training-containers). + * Optional. The configuration for your master worker. You should only set `masterConfig.acceleratorConfig` if `masterType` is set to a Compute Engine machine type. Learn about [restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `masterConfig.imageUri` only if you build a custom image. Only one of `masterConfig.imageUri` and `runtimeVersion` should be set. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ masterConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** - * Optional. Specifies the type of virtual machine to use for your training - * job's master worker. The following types are supported: <dl> - * <dt>standard</dt> <dd> A basic machine - * configuration suitable for training simple models with small to - * moderate datasets. </dd> <dt>large_model</dt> - * <dd> A machine with a lot of memory, specially suited for - * parameter servers when your model is large (having many hidden layers - * or layers with very large numbers of nodes). </dd> - * <dt>complex_model_s</dt> <dd> A machine suitable - * for the master and workers of the cluster when your model requires more - * computation than the standard machine can handle satisfactorily. - * </dd> <dt>complex_model_m</dt> <dd> A - * machine with roughly twice the number of cores and roughly double the - * memory of <i>complex_model_s</i>. </dd> - * <dt>complex_model_l</dt> <dd> A machine with - * roughly twice the number of cores and roughly double the memory of - * <i>complex_model_m</i>. </dd> - * <dt>standard_gpu</dt> <dd> A machine equivalent to - * <i>standard</i> that also includes a single NVIDIA Tesla - * K80 GPU. See more about <a - * href="/ml-engine/docs/tensorflow/using-gpus">using GPUs to - * train your model</a>. </dd> - * <dt>complex_model_m_gpu</dt> <dd> A machine - * equivalent to <i>complex_model_m</i> that also includes four - * NVIDIA Tesla K80 GPUs. </dd> - * <dt>complex_model_l_gpu</dt> <dd> A machine - * equivalent to <i>complex_model_l</i> that also includes eight - * NVIDIA Tesla K80 GPUs. </dd> <dt>standard_p100</dt> - * <dd> A machine equivalent to <i>standard</i> that - * also includes a single NVIDIA Tesla P100 GPU. </dd> - * <dt>complex_model_m_p100</dt> <dd> A machine - * equivalent to <i>complex_model_m</i> that also includes four - * NVIDIA Tesla P100 GPUs. </dd> <dt>standard_v100</dt> - * <dd> A machine equivalent to <i>standard</i> that - * also includes a single NVIDIA Tesla V100 GPU. </dd> - * <dt>large_model_v100</dt> <dd> A machine equivalent - * to <i>large_model</i> that also includes a single NVIDIA - * Tesla V100 GPU. </dd> <dt>complex_model_m_v100</dt> - * <dd> A machine equivalent to <i>complex_model_m</i> - * that also includes four NVIDIA Tesla V100 GPUs. </dd> - * <dt>complex_model_l_v100</dt> <dd> A machine - * equivalent to <i>complex_model_l</i> that also includes - * eight NVIDIA Tesla V100 GPUs. </dd> - * <dt>cloud_tpu</dt> <dd> A TPU VM including one - * Cloud TPU. See more about <a - * href="/ml-engine/docs/tensorflow/using-tpus">using TPUs to - * train your model</a>. </dd> </dl> You may also use - * certain Compute Engine machine types directly in this field. The - * following types are supported: - `n1-standard-4` - `n1-standard-8` - - * `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - * - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - - * `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - - * `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` See more about - * [using Compute Engine machine - * types](/ml-engine/docs/tensorflow/machine-types#compute-engine-machine-types). - * You must set this value when `scaleTier` is set to `CUSTOM`. + * Optional. Specifies the type of virtual machine to use for your training job's master worker. The following types are supported: <dl> <dt>standard</dt> <dd> A basic machine configuration suitable for training simple models with small to moderate datasets. </dd> <dt>large_model</dt> <dd> A machine with a lot of memory, specially suited for parameter servers when your model is large (having many hidden layers or layers with very large numbers of nodes). </dd> <dt>complex_model_s</dt> <dd> A machine suitable for the master and workers of the cluster when your model requires more computation than the standard machine can handle satisfactorily. </dd> <dt>complex_model_m</dt> <dd> A machine with roughly twice the number of cores and roughly double the memory of <i>complex_model_s</i>. </dd> <dt>complex_model_l</dt> <dd> A machine with roughly twice the number of cores and roughly double the memory of <i>complex_model_m</i>. </dd> <dt>standard_gpu</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla K80 GPU. See more about <a href="/ml-engine/docs/tensorflow/using-gpus">using GPUs to train your model</a>. </dd> <dt>complex_model_m_gpu</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla K80 GPUs. </dd> <dt>complex_model_l_gpu</dt> <dd> A machine equivalent to <i>complex_model_l</i> that also includes eight NVIDIA Tesla K80 GPUs. </dd> <dt>standard_p100</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla P100 GPU. </dd> <dt>complex_model_m_p100</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla P100 GPUs. </dd> <dt>standard_v100</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla V100 GPU. </dd> <dt>large_model_v100</dt> <dd> A machine equivalent to <i>large_model</i> that also includes a single NVIDIA Tesla V100 GPU. </dd> <dt>complex_model_m_v100</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla V100 GPUs. </dd> <dt>complex_model_l_v100</dt> <dd> A machine equivalent to <i>complex_model_l</i> that also includes eight NVIDIA Tesla V100 GPUs. </dd> <dt>cloud_tpu</dt> <dd> A TPU VM including one Cloud TPU. See more about <a href="/ml-engine/docs/tensorflow/using-tpus">using TPUs to train your model</a>. </dd> </dl> You may also use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` See more about [using Compute Engine machine types](/ml-engine/docs/tensorflow/machine-types#compute-engine-machine-types). You must set this value when `scaleTier` is set to `CUSTOM`. */ masterType?: string; /** - * Required. The Google Cloud Storage location of the packages with the - * training program and any additional dependencies. The maximum number of - * package URIs is 100. + * Required. The Google Cloud Storage location of the packages with the training program and any additional dependencies. The maximum number of package URIs is 100. */ packageUris?: string[]; /** - * Optional. The configuration for parameter servers. You should only set - * `parameterServerConfig.acceleratorConfig` if `parameterServerConfigType` - * is set to a Compute Engine machine type. [Learn about restrictions on - * accelerator configurations for - * training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) - * Set `parameterServerConfig.imageUri` only if you build a custom image for - * your parameter server. If `parameterServerConfig.imageUri` has not been - * set, Cloud ML Engine uses the value of `masterConfig.imageUri`. Learn - * more about [configuring custom - * containers](/ml-engine/docs/distributed-training-containers). + * Optional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerConfigType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, Cloud ML Engine uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ parameterServerConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** - * Optional. The number of parameter server replicas to use for the training - * job. Each replica in the cluster will be of the type specified in - * `parameter_server_type`. This value can only be used when `scale_tier` - * is set to `CUSTOM`.If you set this value, you must also set - * `parameter_server_type`. The default value is zero. + * Optional. The number of parameter server replicas to use for the training job. Each replica in the cluster will be of the type specified in `parameter_server_type`. This value can only be used when `scale_tier` is set to `CUSTOM`.If you set this value, you must also set `parameter_server_type`. The default value is zero. */ parameterServerCount?: string; /** - * Optional. Specifies the type of virtual machine to use for your training - * job's parameter server. The supported values are the same as those - * described in the entry for `master_type`. This value must be consistent - * with the category of machine type that `masterType` uses. In other words, - * both must be Cloud ML Engine machine types or both must be Compute Engine - * machine types. This value must be present when `scaleTier` is set to - * `CUSTOM` and `parameter_server_count` is greater than zero. + * Optional. Specifies the type of virtual machine to use for your training job's parameter server. The supported values are the same as those described in the entry for `master_type`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Cloud ML Engine machine types or both must be Compute Engine machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `parameter_server_count` is greater than zero. */ parameterServerType?: string; /** @@ -922,67 +667,31 @@ export namespace ml_v1 { */ pythonModule?: string; /** - * Optional. The version of Python used in training. If not set, the default - * version is '2.7'. Python '3.5' is available when - * `runtime_version` is set to '1.4' and above. Python '2.7' - * works with all supported <a - * href="/ml-engine/docs/runtime-version-list">runtime - * versions</a>. + * Optional. The version of Python used in training. If not set, the default version is '2.7'. Python '3.5' is available when `runtime_version` is set to '1.4' and above. Python '2.7' works with all supported <a href="/ml-engine/docs/runtime-version-list">runtime versions</a>. */ pythonVersion?: string; /** - * Required. The Google Compute Engine region to run the training job in. - * See the <a - * href="/ml-engine/docs/tensorflow/regions">available - * regions</a> for ML Engine services. + * Required. The Google Compute Engine region to run the training job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for ML Engine services. */ region?: string; /** - * Optional. The Cloud ML Engine runtime version to use for training. If not - * set, Cloud ML Engine uses the default stable version, 1.0. For more - * information, see the <a - * href="/ml-engine/docs/runtime-version-list">runtime version - * list</a> and <a - * href="/ml-engine/docs/versioning">how to manage runtime - * versions</a>. + * Optional. The Cloud ML Engine runtime version to use for training. If not set, Cloud ML Engine uses the default stable version, 1.0. For more information, see the <a href="/ml-engine/docs/runtime-version-list">runtime version list</a> and <a href="/ml-engine/docs/versioning">how to manage runtime versions</a>. */ runtimeVersion?: string; /** - * Required. Specifies the machine types, the number of replicas for workers - * and parameter servers. + * Required. Specifies the machine types, the number of replicas for workers and parameter servers. */ scaleTier?: string; /** - * Optional. The configuration for workers. You should only set - * `workerConfig.acceleratorConfig` if `workerType` is set to a Compute - * Engine machine type. [Learn about restrictions on accelerator - * configurations for - * training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) - * Set `workerConfig.imageUri` only if you build a custom image for your - * worker. If `workerConfig.imageUri` has not been set, Cloud ML Engine uses - * the value of `masterConfig.imageUri`. Learn more about [configuring - * custom containers](/ml-engine/docs/distributed-training-containers). + * Optional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, Cloud ML Engine uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ workerConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** - * Optional. The number of worker replicas to use for the training job. Each - * replica in the cluster will be of the type specified in `worker_type`. - * This value can only be used when `scale_tier` is set to `CUSTOM`. If you - * set this value, you must also set `worker_type`. The default value is - * zero. + * Optional. The number of worker replicas to use for the training job. Each replica in the cluster will be of the type specified in `worker_type`. This value can only be used when `scale_tier` is set to `CUSTOM`. If you set this value, you must also set `worker_type`. The default value is zero. */ workerCount?: string; /** - * Optional. Specifies the type of virtual machine to use for your training - * job's worker nodes. The supported values are the same as those - * described in the entry for `masterType`. This value must be consistent - * with the category of machine type that `masterType` uses. In other words, - * both must be Cloud ML Engine machine types or both must be Compute Engine - * machine types. If you use `cloud_tpu` for this value, see special - * instructions for [configuring a custom TPU - * machine](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). - * This value must be present when `scaleTier` is set to `CUSTOM` and - * `workerCount` is greater than zero. + * Optional. Specifies the type of virtual machine to use for your training job's worker nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Cloud ML Engine machine types or both must be Compute Engine machine types. If you use `cloud_tpu` for this value, see special instructions for [configuring a custom TPU machine](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). This value must be present when `scaleTier` is set to `CUSTOM` and `workerCount` is greater than zero. */ workerType?: string; } @@ -991,13 +700,11 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__TrainingOutput { /** - * Details related to built-in algorithms jobs. Only set for built-in - * algorithms jobs. + * Details related to built-in algorithms jobs. Only set for built-in algorithms jobs. */ builtInAlgorithmOutput?: Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput; /** - * The number of hyperparameter tuning trials that completed successfully. - * Only set for hyperparameter tuning jobs. + * The number of hyperparameter tuning trials that completed successfully. Only set for hyperparameter tuning jobs. */ completedTrialCount?: string; /** @@ -1013,25 +720,16 @@ export namespace ml_v1 { */ isHyperparameterTuningJob?: boolean; /** - * Results for individual Hyperparameter trials. Only set for hyperparameter - * tuning jobs. + * Results for individual Hyperparameter trials. Only set for hyperparameter tuning jobs. */ trials?: Schema$GoogleCloudMlV1__HyperparameterOutput[]; } /** - * Represents a version of the model. Each version is a trained model - * deployed in the cloud, ready to handle prediction requests. A model can - * have multiple versions. You can get information about all of the versions - * of a given model by calling - * [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). - * Next ID: 30 + * Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). Next ID: 30 */ export interface Schema$GoogleCloudMlV1__Version { /** - * Automatically scale the number of nodes used to serve the model in - * response to increases and decreases in traffic. Care should be taken to - * ramp up traffic according to the model's ability to scale or you will - * start seeing increases in latency and 429 response codes. + * Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes. */ autoScaling?: Schema$GoogleCloudMlV1__AutoScaling; /** @@ -1039,15 +737,7 @@ export namespace ml_v1 { */ createTime?: string; /** - * Required. The Google Cloud Storage location of the trained model used to - * create the version. See the [guide to model - * deployment](/ml-engine/docs/tensorflow/deploying-models) for more - * information. When passing Version to - * [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create) - * the model service uses the specified location as the source of the model. - * Once deployed, the model version is hosted by the prediction service, so - * this location is useful only as a historical record. The total number of - * model files can't exceed 1000. + * Required. The Google Cloud Storage location of the trained model used to create the version. See the [guide to model deployment](/ml-engine/docs/tensorflow/deploying-models) for more information. When passing Version to [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create) the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000. */ deploymentUri?: string; /** @@ -1059,38 +749,19 @@ export namespace ml_v1 { */ errorMessage?: string; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a model from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform model updates in order to avoid race - * conditions: An `etag` is returned in the response to `GetVersion`, and - * systems are expected to put that etag in the request to `UpdateVersion` - * to ensure that their change will be applied to the model as intended. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended. */ etag?: string; /** - * Optional. The machine learning framework Cloud ML Engine uses to train - * this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, - * `XGBOOST`. If you do not specify a framework, Cloud ML Engine will - * analyze files in the deployment_uri to determine a framework. If you - * choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version - * of the model to 1.4 or greater. + * Optional. The machine learning framework Cloud ML Engine uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, Cloud ML Engine will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. */ framework?: string; /** - * Output only. If true, this version will be used to handle prediction - * requests that do not specify a version. You can change the default - * version by calling - * [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). + * Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). */ isDefault?: boolean; /** - * Optional. One or more labels that you can add, to organize your model - * versions. Each label is a key-value pair, where both the key and the - * value are arbitrary strings that you supply. For more information, see - * the documentation on <a - * href="/ml-engine/docs/tensorflow/resource-labels">using - * labels</a>. + * Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on <a href="/ml-engine/docs/tensorflow/resource-labels">using labels</a>. */ labels?: {[key: string]: string}; /** @@ -1098,74 +769,31 @@ export namespace ml_v1 { */ lastUseTime?: string; /** - * Optional. The type of machine on which to serve the model. Currently only - * applies to online prediction service. <dl> - * <dt>mls1-c1-m2</dt> <dd> The - * <b>default</b> machine type, with 1 core and 2 GB RAM. The - * deprecated name for this machine type is "mls1-highmem-1". - * </dd> <dt>mls1-c4-m2</dt> <dd> In - * <b>Beta</b>. This machine type has 4 cores and 2 GB RAM. The - * deprecated name for this machine type is "mls1-highcpu-4". - * </dd> </dl> + * Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. <dl> <dt>mls1-c1-m2</dt> <dd> The <b>default</b> machine type, with 1 core and 2 GB RAM. The deprecated name for this machine type is "mls1-highmem-1". </dd> <dt>mls1-c4-m2</dt> <dd> In <b>Beta</b>. This machine type has 4 cores and 2 GB RAM. The deprecated name for this machine type is "mls1-highcpu-4". </dd> </dl> */ machineType?: string; /** - * Manually select the number of nodes to use for serving the model. You - * should generally use `auto_scaling` with an appropriate `min_nodes` - * instead, but this option is available if you want more predictable - * billing. Beware that latency and error rates will increase if the traffic - * exceeds that capability of the system to serve it based on the selected - * number of nodes. + * Manually select the number of nodes to use for serving the model. You should generally use `auto_scaling` with an appropriate `min_nodes` instead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes. */ manualScaling?: Schema$GoogleCloudMlV1__ManualScaling; /** - * Required.The name specified for the version when it was created. The - * version name must be unique within the model it is created in. + * Required.The name specified for the version when it was created. The version name must be unique within the model it is created in. */ name?: string; /** - * Optional. The Google Cloud Storage location of the packages for custom - * prediction and any additional dependencies. + * Optional. The Google Cloud Storage location of the packages for custom prediction and any additional dependencies. */ packageUris?: string[]; /** - * class PredictionClass(object): """A Model performs - * predictions on a given list of instances. The input instances are the - * raw values sent by the user. It is the responsibility of a Model to - * translate these instances into actual predictions. The input - * instances and the output use python data types. The input instances - * have been decoded prior to being passed to the predict method. The - * output, which should use python data types is encoded after being - * returned from the predict method. """ def - * predict(self, instances, **kwargs): """Returns - * predictions for the provided instances. Instances are the decoded - * values from the request. Clients need not worry about decoding json - * nor base64 decoding. Args: instances: A list of instances, as - * described in the API. **kwargs: Additional keyword arguments, will - * be passed into the client's predict method. Returns: - * A list of outputs containing the prediction results. """ - * @classmethod def from_path(cls, model_path): """Creates - * a model using the given model path. Path is useful, e.g., to load - * files from the exported directory containing the model. Args: - * model_path: The local directory that contains the exported model file - * along with any additional files uploaded when creating the version - * resource. Returns: An instance implementing this Model class. - * """ + * class PredictionClass(object): """A Model performs predictions on a given list of instances. The input instances are the raw values sent by the user. It is the responsibility of a Model to translate these instances into actual predictions. The input instances and the output use python data types. The input instances have been decoded prior to being passed to the predict method. The output, which should use python data types is encoded after being returned from the predict method. """ def predict(self, instances, **kwargs): """Returns predictions for the provided instances. Instances are the decoded values from the request. Clients need not worry about decoding json nor base64 decoding. Args: instances: A list of instances, as described in the API. **kwargs: Additional keyword arguments, will be passed into the client's predict method. Returns: A list of outputs containing the prediction results. """ @classmethod def from_path(cls, model_path): """Creates a model using the given model path. Path is useful, e.g., to load files from the exported directory containing the model. Args: model_path: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Model class. """ */ predictionClass?: string; /** - * Optional. The version of Python used in prediction. If not set, the - * default version is '2.7'. Python '3.5' is available when - * `runtime_version` is set to '1.4' and above. Python '2.7' - * works with all supported runtime versions. + * Optional. The version of Python used in prediction. If not set, the default version is '2.7'. Python '3.5' is available when `runtime_version` is set to '1.4' and above. Python '2.7' works with all supported runtime versions. */ pythonVersion?: string; /** - * Optional. The Cloud ML Engine runtime version to use for this deployment. - * If not set, Cloud ML Engine uses the default stable version, 1.0. For - * more information, see the [runtime version - * list](/ml-engine/docs/runtime-version-list) and [how to manage runtime - * versions](/ml-engine/docs/versioning). + * Optional. The Cloud ML Engine runtime version to use for this deployment. If not set, Cloud ML Engine uses the default stable version, 1.0. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). */ runtimeVersion?: string; /** @@ -1174,27 +802,7 @@ export namespace ml_v1 { state?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$GoogleIamV1__AuditConfig { /** @@ -1202,25 +810,16 @@ export namespace ml_v1 { */ auditLogConfigs?: Schema$GoogleIamV1__AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$GoogleIamV1__AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -1233,52 +832,20 @@ export namespace ml_v1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$GoogleIamV1__Policy { /** @@ -1286,20 +853,11 @@ export namespace ml_v1 { */ auditConfigs?: Schema$GoogleIamV1__AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1312,17 +870,11 @@ export namespace ml_v1 { */ export interface Schema$GoogleIamV1__SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$GoogleIamV1__Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } @@ -1331,10 +883,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1343,8 +892,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1362,14 +910,11 @@ export namespace ml_v1 { operations?: Schema$GoogleLongrunning__Operation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunning__Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1377,72 +922,24 @@ export namespace ml_v1 { */ error?: Schema$GoogleRpc__Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobuf__Empty {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpc__Status { /** @@ -1450,43 +947,32 @@ export namespace ml_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$GoogleType__Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -1499,10 +985,7 @@ export namespace ml_v1 { /** * ml.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias ml.operations.delete * @memberOf! () * @@ -1603,11 +1086,7 @@ export namespace ml_v1 { /** * ml.projects.getConfig - * @desc Get the service account information associated with your project. - * You need this information in order to grant the service account - * permissions for the Google Cloud Storage location where you put your - * model training code for training the model with Google Cloud Machine - * Learning. + * @desc Get the service account information associated with your project. You need this information in order to grant the service account permissions for the Google Cloud Storage location where you put your model training code for training the model with Google Cloud Machine Learning. * @alias ml.projects.getConfig * @memberOf! () * @@ -1690,10 +1169,7 @@ export namespace ml_v1 { /** * ml.projects.predict - * @desc Performs prediction on the data in the request. Cloud ML Engine - * implements a custom `predict` verb on top of an HTTP POST method.

                          For - * details of the request and response format, see the **guide to the - * [predict request format](/ml-engine/docs/v1/predict-request)**. + * @desc Performs prediction on the data in the request. Cloud ML Engine implements a custom `predict` verb on top of an HTTP POST method.

                          For details of the request and response format, see the **guide to the [predict request format](/ml-engine/docs/v1/predict-request)**. * @alias ml.projects.predict * @memberOf! () * @@ -1785,8 +1261,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of a model or a version. Authorization: - * requires the `predict` permission on the specified resource. + * Required. The resource name of a model or a version. Authorization: requires the `predict` permission on the specified resource. */ name?: string; @@ -2025,8 +1500,7 @@ export namespace ml_v1 { /** * ml.projects.jobs.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias ml.projects.jobs.getIamPolicy * @memberOf! () * @@ -2102,13 +1576,12 @@ export namespace ml_v1 { /** * ml.projects.jobs.list - * @desc Lists the jobs in the project. If there are no jobs that match the - * request parameters, the list request returns an empty response body: {}. + * @desc Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}. * @alias ml.projects.jobs.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census':

                          gcloud ml-engine jobs list --filter='jobId:census*'

                          List all failed jobs with names that start with 'rnn':

                          gcloud ml-engine jobs list --filter='jobId:rnn* AND state:FAILED'

                          For more examples, see the guide to monitoring jobs. + * @param {string=} params.filter Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census':

                          gcloud ai-platform jobs list --filter='jobId:census*'

                          List all failed jobs with names that start with 'rnn':

                          gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED'

                          For more examples, see the guide to monitoring jobs. * @param {integer=} params.pageSize Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100. * @param {string=} params.pageToken Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call. * @param {string} params.parent Required. The name of the project for which to list jobs. @@ -2186,8 +1659,7 @@ export namespace ml_v1 { /** * ml.projects.jobs.patch - * @desc Updates a specific job resource. Currently the only supported - * fields to update are `labels`. + * @desc Updates a specific job resource. Currently the only supported fields to update are `labels`. * @alias ml.projects.jobs.patch * @memberOf! () * @@ -2262,8 +1734,7 @@ export namespace ml_v1 { /** * ml.projects.jobs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias ml.projects.jobs.setIamPolicy * @memberOf! () * @@ -2340,11 +1811,7 @@ export namespace ml_v1 { /** * ml.projects.jobs.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias ml.projects.jobs.testIamPermissions * @memberOf! () * @@ -2489,8 +1956,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2502,27 +1968,15 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Specifies the subset of jobs to retrieve. You can filter on the - * value of one or more attributes of the job object. For example, retrieve - * jobs with a job identifier that starts with 'census':

                          gcloud - * ml-engine jobs list --filter='jobId:census*'

                          List all failed - * jobs with names that start with 'rnn':

                          gcloud ml-engine jobs - * list --filter='jobId:rnn* AND state:FAILED'

                          For more examples, - * see the guide to monitoring jobs. + * Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census':

                          gcloud ai-platform jobs list --filter='jobId:census*'

                          List all failed jobs with names that start with 'rnn':

                          gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED'

                          For more examples, see the guide to monitoring jobs. */ filter?: string; /** - * Optional. The number of jobs to retrieve per "page" of results. If there - * are more remaining results than this number, the response message will - * contain a valid value in the `next_page_token` field. The default value - * is 20, and the maximum page size is 100. + * Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. You get the - * token from the `next_page_token` field of the response from the previous - * call. + * Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call. */ pageToken?: string; /** @@ -2542,17 +1996,7 @@ export namespace ml_v1 { */ name?: string; /** - * Required. Specifies the path, relative to `Job`, of the field to update. - * To adopt etag mechanism, include `etag` field in the mask, and include - * the `etag` value in your job resource. For example, to change the labels - * of a job, the `update_mask` parameter would be specified as `labels`, - * `etag`, and the `PATCH` request body would specify the new value, as - * follows: { "labels": { "owner": "Google", "color": - * "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" - * } If `etag` matches the one on the server, the labels of the job will be - * replaced with the given ones, and the server end `etag` will be - * recalculated. Currently the only supported update masks are `labels` and - * `etag`. + * Required. Specifies the path, relative to `Job`, of the field to update. To adopt etag mechanism, include `etag` field in the mask, and include the `etag` value in your job resource. For example, to change the labels of a job, the `update_mask` parameter would be specified as `labels`, `etag`, and the `PATCH` request body would specify the new value, as follows: { "labels": { "owner": "Google", "color": "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" } If `etag` matches the one on the server, the labels of the job will be replaced with the given ones, and the server end `etag` will be recalculated. Currently the only supported update masks are `labels` and `etag`. */ updateMask?: string; @@ -2569,8 +2013,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2587,8 +2030,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2606,8 +2048,7 @@ export namespace ml_v1 { /** * ml.projects.locations.get - * @desc Get the complete list of CMLE capabilities in a location, along - * with their location-specific properties. + * @desc Get the complete list of CMLE capabilities in a location, along with their location-specific properties. * @alias ml.projects.locations.get * @memberOf! () * @@ -2683,8 +2124,7 @@ export namespace ml_v1 { /** * ml.projects.locations.list - * @desc List all locations that provides at least one type of CMLE - * capability. + * @desc List all locations that provides at least one type of CMLE capability. * @alias ml.projects.locations.list * @memberOf! () * @@ -2796,21 +2236,15 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The number of locations to retrieve per "page" of results. If - * there are more remaining results than this number, the response message - * will contain a valid value in the `next_page_token` field. The default - * value is 20, and the maximum page size is 100. + * Optional. The number of locations to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. You get the - * token from the `next_page_token` field of the response from the previous - * call. + * Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call. */ pageToken?: string; /** - * Required. The name of the project for which available locations are to be - * listed (since some locations might be whitelisted for specific projects). + * Required. The name of the project for which available locations are to be listed (since some locations might be whitelisted for specific projects). */ parent?: string; } @@ -2825,10 +2259,7 @@ export namespace ml_v1 { /** * ml.projects.models.create - * @desc Creates a model which will later contain one or more versions. You - * must add at least one version before you can request predictions from the - * model. Add versions by calling - * [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create). + * @desc Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create). * @alias ml.projects.models.create * @memberOf! () * @@ -2905,9 +2336,7 @@ export namespace ml_v1 { /** * ml.projects.models.delete - * @desc Deletes a model. You can only delete a model if there are no - * versions in it. You can delete versions by calling - * [projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete). + * @desc Deletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling [projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete). * @alias ml.projects.models.delete * @memberOf! () * @@ -2987,9 +2416,7 @@ export namespace ml_v1 { /** * ml.projects.models.get - * @desc Gets information about a model, including its name, the description - * (if set), and the default version (if at least one version of the model - * has been deployed). + * @desc Gets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed). * @alias ml.projects.models.get * @memberOf! () * @@ -3062,8 +2489,7 @@ export namespace ml_v1 { /** * ml.projects.models.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias ml.projects.models.getIamPolicy * @memberOf! () * @@ -3139,10 +2565,7 @@ export namespace ml_v1 { /** * ml.projects.models.list - * @desc Lists the models in a project. Each project can contain multiple - * models, and each model can have multiple versions. If there are no - * models that match the request parameters, the list request returns an - * empty response body: {}. + * @desc Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}. * @alias ml.projects.models.list * @memberOf! () * @@ -3230,8 +2653,7 @@ export namespace ml_v1 { /** * ml.projects.models.patch - * @desc Updates a specific model resource. Currently the only supported - * fields to update are `description` and `default_version.name`. + * @desc Updates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`. * @alias ml.projects.models.patch * @memberOf! () * @@ -3313,8 +2735,7 @@ export namespace ml_v1 { /** * ml.projects.models.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias ml.projects.models.setIamPolicy * @memberOf! () * @@ -3391,11 +2812,7 @@ export namespace ml_v1 { /** * ml.projects.models.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias ml.projects.models.testIamPermissions * @memberOf! () * @@ -3535,8 +2952,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -3552,16 +2968,11 @@ export namespace ml_v1 { */ filter?: string; /** - * Optional. The number of models to retrieve per "page" of results. If - * there are more remaining results than this number, the response message - * will contain a valid value in the `next_page_token` field. The default - * value is 20, and the maximum page size is 100. + * Optional. The number of models to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. You get the - * token from the `next_page_token` field of the response from the previous - * call. + * Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call. */ pageToken?: string; /** @@ -3581,14 +2992,7 @@ export namespace ml_v1 { */ name?: string; /** - * Required. Specifies the path, relative to `Model`, of the field to - * update. For example, to change the description of a model to "foo" and - * set its default version to "version_1", the `update_mask` parameter would - * be specified as `description`, `default_version.name`, and the `PATCH` - * request body would specify the new value, as follows: { - * "description": "foo", "defaultVersion": { "name":"version_1" } } - * Currently the supported update masks are `description` and - * `default_version.name`. + * Required. Specifies the path, relative to `Model`, of the field to update. For example, to change the description of a model to "foo" and set its default version to "version_1", the `update_mask` parameter would be specified as `description`, `default_version.name`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo", "defaultVersion": { "name":"version_1" } } Currently the supported update masks are `description` and `default_version.name`. */ updateMask?: string; @@ -3605,8 +3009,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3623,8 +3026,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3642,13 +3044,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.create - * @desc Creates a new version of a model from a trained TensorFlow model. - * If the version created in the cloud by this call is the first deployed - * version of the specified model, it will be made the default version of - * the model. When you add a version to a model that already has one or more - * versions, the default version does not automatically change. If you want - * a new version to be the default, you must call - * [projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). + * @desc Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call [projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). * @alias ml.projects.models.versions.create * @memberOf! () * @@ -3732,10 +3128,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.delete - * @desc Deletes a model version. Each model can have multiple versions - * deployed and in use at any given time. Use this method to remove a single - * version. Note: You cannot delete the version that is set as the default - * version of the model unless it is the only remaining version. + * @desc Deletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version. * @alias ml.projects.models.versions.delete * @memberOf! () * @@ -3815,11 +3208,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.get - * @desc Gets information about a model version. Models can have multiple - * versions. You can call - * [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list) - * to get the same information that this method returns for all of the - * versions of a model. + * @desc Gets information about a model version. Models can have multiple versions. You can call [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list) to get the same information that this method returns for all of the versions of a model. * @alias ml.projects.models.versions.get * @memberOf! () * @@ -3892,12 +3281,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.list - * @desc Gets basic information about all the versions of a model. If you - * expect that a model has many versions, or if you need to handle only a - * limited number of results at a time, you can request that the list be - * retrieved in batches (called pages). If there are no versions that match - * the request parameters, the list request returns an empty response body: - * {}. + * @desc Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}. * @alias ml.projects.models.versions.list * @memberOf! () * @@ -3991,8 +3375,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.patch - * @desc Updates the specified Version resource. Currently the only - * update-able fields are `description` and `autoScaling.minNodes`. + * @desc Updates the specified Version resource. Currently the only update-able fields are `description` and `autoScaling.minNodes`. * @alias ml.projects.models.versions.patch * @memberOf! () * @@ -4074,11 +3457,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.setDefault - * @desc Designates a version to be the default for the model. The default - * version is used for prediction requests made against the model that don't - * specify a version. The first version to be created for a model is - * automatically set as the default. You must make any subsequent changes to - * the default version setting manually using this method. + * @desc Designates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method. * @alias ml.projects.models.versions.setDefault * @memberOf! () * @@ -4181,9 +3560,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the version. You can get the names of all the - * versions of a model by calling - * [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). + * Required. The name of the version. You can get the names of all the versions of a model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). */ name?: string; } @@ -4211,16 +3588,11 @@ export namespace ml_v1 { */ filter?: string; /** - * Optional. The number of versions to retrieve per "page" of results. If - * there are more remaining results than this number, the response message - * will contain a valid value in the `next_page_token` field. The default - * value is 20, and the maximum page size is 100. + * Optional. The number of versions to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. You get the - * token from the `next_page_token` field of the response from the previous - * call. + * Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call. */ pageToken?: string; /** @@ -4240,13 +3612,7 @@ export namespace ml_v1 { */ name?: string; /** - * Required. Specifies the path, relative to `Version`, of the field to - * update. Must be present and non-empty. For example, to change the - * description of a version to "foo", the `update_mask` parameter would be - * specified as `description`, and the `PATCH` request body would specify - * the new value, as follows: { "description": "foo" } - * Currently the only supported update mask fields are `description` and - * `autoScaling.minNodes`. + * Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo" } Currently the only supported update mask fields are `description` and `autoScaling.minNodes`. */ updateMask?: string; @@ -4263,9 +3629,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the version to make the default for the model. You - * can get the names of all the versions of a model by calling - * [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). + * Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). */ name?: string; @@ -4283,15 +3647,7 @@ export namespace ml_v1 { /** * ml.projects.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias ml.projects.operations.cancel * @memberOf! () * @@ -4364,9 +3720,7 @@ export namespace ml_v1 { /** * ml.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias ml.projects.operations.get * @memberOf! () * @@ -4446,15 +3800,7 @@ export namespace ml_v1 { /** * ml.projects.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias ml.projects.operations.list * @memberOf! () * diff --git a/src/apis/monitoring/package.json b/src/apis/monitoring/package.json index 2a8fd4a86fe..11d54971a07 100644 --- a/src/apis/monitoring/package.json +++ b/src/apis/monitoring/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 03caccd4cd6..f10c5342622 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace monitoring_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace monitoring_v3 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace monitoring_v3 { /** * Stackdriver Monitoring API * - * Manages your Stackdriver Monitoring data and configurations. Most projects - * must be associated with a Stackdriver account, with a few exceptions as - * noted on the individual method pages. + * Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace monitoring_v3 { uptimeCheckIps: Resource$Uptimecheckips; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); this.uptimeCheckIps = new Resource$Uptimecheckips(this.context); @@ -123,146 +120,73 @@ export namespace monitoring_v3 { } /** - * Describes how to combine multiple time series to provide different views of - * the data. Aggregation consists of an alignment step on individual time - * series (alignment_period and per_series_aligner) followed by an optional - * reduction step of the data across the aligned time series - * (cross_series_reducer and group_by_fields). For more details, see - * Aggregation. + * Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see Aggregation. */ export interface Schema$Aggregation { /** - * The alignment period for per-time series alignment. If present, - * alignmentPeriod must be at least 60 seconds. After per-time series - * alignment, each time series will contain data points only on the period - * boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, - * then this field is ignored. If perSeriesAligner is specified and does not - * equal ALIGN_NONE, then this field must be defined; otherwise an error is - * returned. + * The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. */ alignmentPeriod?: string; /** - * The approach to be used to combine time series. Not all reducer functions - * may be applied to all time series, depending on the metric type and the - * value type of the original time series. Reduction may change the metric - * type of value type of the time series.Time series data must be aligned in - * order to perform cross-time series reduction. If crossSeriesReducer is - * specified, then perSeriesAligner must be specified and not equal - * ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is - * returned. + * The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. */ crossSeriesReducer?: string; /** - * The set of fields to preserve when crossSeriesReducer is specified. The - * groupByFields determine how the time series are partitioned into subsets - * prior to applying the aggregation function. Each subset contains time - * series that have the same value for each of the grouping fields. Each - * individual time series is a member of exactly one subset. The - * crossSeriesReducer is applied to each subset of time series. It is not - * possible to reduce across different resource types, so this field - * implicitly contains resource.type. Fields not specified in groupByFields - * are aggregated away. If groupByFields is not specified and all the time - * series have the same resource type, then the time series are aggregated - * into a single output time series. If crossSeriesReducer is not defined, - * this field is ignored. + * The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. */ groupByFields?: string[]; /** - * The approach to be used to align individual time series. Not all - * alignment functions may be applied to all time series, depending on the - * metric type and value type of the original time series. Alignment may - * change the metric type or the value type of the time series.Time series - * data must be aligned in order to perform cross-time series reduction. If - * crossSeriesReducer is specified, then perSeriesAligner must be specified - * and not equal ALIGN_NONE and alignmentPeriod must be specified; - * otherwise, an error is returned. + * The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. */ perSeriesAligner?: string; } /** - * A description of the conditions under which some aspect of your system is - * considered to be "unhealthy" and the ways to notify people or - * services about this state. For an overview of alert policies, see - * Introduction to Alerting. + * A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting. */ export interface Schema$AlertPolicy { /** - * How to combine the results of multiple conditions to determine if an - * incident should be opened. + * How to combine the results of multiple conditions to determine if an incident should be opened. */ combiner?: string; /** - * A list of conditions for the policy. The conditions are combined by AND - * or OR according to the combiner field. If the combined conditions - * evaluate to true, then an incident is created. A policy can have from one - * to six conditions. + * A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. */ conditions?: Schema$Condition[]; /** - * A read-only record of the creation of the alerting policy. If provided in - * a call to create or update, this field will be ignored. + * A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. */ creationRecord?: Schema$MutationRecord; /** - * A short name or phrase used to identify the policy in dashboards, - * notifications, and incidents. To avoid confusion, don't use the same - * display name for multiple policies in the same project. The name is - * limited to 512 Unicode characters. + * A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters. */ displayName?: string; /** - * Documentation that is included with notifications and incidents related - * to this policy. Best practice is for the documentation to include - * information to help responders understand, mitigate, escalate, and - * correct the underlying problems detected by the alerting policy. - * Notification channels that have limited capacity might not show this - * documentation. + * Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. */ documentation?: Schema$Documentation; /** - * Whether or not the policy is enabled. On write, the default - * interpretation if unset is that the policy is enabled. On read, clients - * should not make any assumption about the state if it has not been - * populated. The field should always be populated on List and Get - * operations, unless a field projection has been specified that strips it - * out. + * Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. */ enabled?: boolean; /** - * A read-only record of the most recent change to the alerting policy. If - * provided in a call to create or update, this field will be ignored. + * A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. */ mutationRecord?: Schema$MutationRecord; /** - * Required if the policy exists. The resource name for this policy. The - * syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] - * [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy - * is created. When calling the alertPolicies.create method, do not include - * the name field in the alerting policy passed as part of the request. + * Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. */ name?: string; /** - * Identifies the notification channels to which notifications should be - * sent when incidents are opened or closed or when new violations occur on - * an already opened incident. Each element of this array corresponds to the - * name field in each of the NotificationChannel objects that are returned - * from the ListNotificationChannels method. The syntax of the entries in - * this field is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] + * Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The syntax of the entries in this field is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] */ notificationChannels?: string[]; /** - * User-supplied key/value data to be used for organizing and identifying - * the AlertPolicy objects.The field can contain up to 64 entries. Each key - * and value is limited to 63 Unicode characters or 128 bytes, whichever is - * smaller. Labels and values can contain only lowercase letters, numerals, - * underscores, and dashes. Keys must begin with a letter. + * User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. */ userLabels?: {[key: string]: string}; } /** - * A type of authentication to perform against the specified resource or URL - * that uses username and password. Currently, only Basic authentication is - * supported in Uptime Monitoring. + * A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring. */ export interface Schema$BasicAuthentication { /** @@ -275,20 +199,7 @@ export namespace monitoring_v3 { username?: string; } /** - * BucketOptions describes the bucket boundaries used to create a histogram - * for the distribution. The buckets can be in a linear sequence, an - * exponential sequence, or each bucket can be specified explicitly. - * BucketOptions does not include the number of values in each bucket.A bucket - * has an inclusive lower bound and exclusive upper bound for the values that - * are counted for that bucket. The upper bound of a bucket must be strictly - * greater than the lower bound. The sequence of N buckets for a distribution - * consists of an underflow bucket (number 0), zero or more finite buckets - * (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets - * are contiguous: the lower bound of bucket i (i > 0) is the same as the - * upper bound of bucket i - 1. The buckets span the whole range of finite - * values: lower bound of the underflow bucket is -infinity and the upper - * bound of the overflow bucket is +infinity. The finite buckets are so-called - * because both bounds are finite. + * BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. */ export interface Schema$BucketOptions { /** @@ -305,8 +216,7 @@ export namespace monitoring_v3 { linearBuckets?: Schema$Linear; } /** - * A collection of data points sent from a collectd-based plugin. See the - * collectd documentation for more information. + * A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information. */ export interface Schema$CollectdPayload { /** @@ -338,8 +248,7 @@ export namespace monitoring_v3 { */ typeInstance?: string; /** - * The measured values during this time interval. Each value must have a - * different dataSourceName. + * The measured values during this time interval. Each value must have a different dataSourceName. */ values?: Schema$CollectdValue[]; } @@ -348,19 +257,15 @@ export namespace monitoring_v3 { */ export interface Schema$CollectdPayloadError { /** - * Records the error status for the payload. If this field is present, the - * partial errors for nested values won't be populated. + * Records the error status for the payload. If this field is present, the partial errors for nested values won't be populated. */ error?: Schema$Status; /** - * The zero-based index in - * CreateCollectdTimeSeriesRequest.collectd_payloads. + * The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads. */ index?: number; /** - * Records the error status for values that were not written due to an - * error.Failed payloads for which nothing is written will not include - * partial value errors. + * Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors. */ valueErrors?: Schema$CollectdValueError[]; } @@ -369,8 +274,7 @@ export namespace monitoring_v3 { */ export interface Schema$CollectdValue { /** - * The data source for the collectd value. For example there are two data - * sources for network measurements: "rx" and "tx". + * The data source for the collectd value. For example there are two data sources for network measurements: "rx" and "tx". */ dataSourceName?: string; /** @@ -391,20 +295,16 @@ export namespace monitoring_v3 { */ error?: Schema$Status; /** - * The zero-based index in CollectdPayload.values within the parent - * CreateCollectdTimeSeriesRequest.collectd_payloads. + * The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads. */ index?: number; } /** - * A condition is a true/false test that determines when an alerting policy - * should open an incident. If a condition evaluates to true, it signifies - * that something is wrong. + * A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong. */ export interface Schema$Condition { /** - * A condition that checks that a time series continues to receive new data - * points. + * A condition that checks that a time series continues to receive new data points. */ conditionAbsent?: Schema$MetricAbsence; /** @@ -412,33 +312,16 @@ export namespace monitoring_v3 { */ conditionThreshold?: Schema$MetricThreshold; /** - * A short name or phrase used to identify the condition in dashboards, - * notifications, and incidents. To avoid confusion, don't use the same - * display name for multiple conditions in the same policy. + * A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy. */ displayName?: string; /** - * Required if the condition exists. The unique resource name for this - * condition. Its syntax is: - * projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] - * [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition - * is created as part of a new or updated alerting policy.When calling the - * alertPolicies.create method, do not include the name field in the - * conditions of the requested alerting policy. Stackdriver Monitoring - * creates the condition identifiers and includes them in the new - * policy.When calling the alertPolicies.update method to update a policy, - * including a condition name causes the existing condition to be updated. - * Conditions without names are added to the updated policy. Existing - * conditions are deleted if they are not updated.Best practice is to - * preserve [CONDITION_ID] if you make only small changes, such as those to - * condition thresholds, durations, or trigger values. Otherwise, treat the - * change as a new condition and let the existing condition be deleted. + * Required if the condition exists. The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Stackdriver Monitoring creates the condition identifiers and includes them in the new policy.When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted. */ name?: string; } /** - * Used to perform string matching. It allows substring and regular - * expressions, together with their negations. + * Used to perform string matching. It allows substring and regular expressions, together with their negations. */ export interface Schema$ContentMatcher { /** @@ -451,15 +334,11 @@ export namespace monitoring_v3 { */ export interface Schema$CreateCollectdTimeSeriesRequest { /** - * The collectd payloads representing the time series data. You must not - * include more than a single point for each time series, so no two payloads - * can have the same values for all of the fields plugin, plugin_instance, - * type, and type_instance. + * The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance. */ collectdPayloads?: Schema$CollectdPayload[]; /** - * The version of collectd that collected the data. Example: - * "5.3.0-192.el6". + * The version of collectd that collected the data. Example: "5.3.0-192.el6". */ collectdVersion?: string; /** @@ -472,9 +351,7 @@ export namespace monitoring_v3 { */ export interface Schema$CreateCollectdTimeSeriesResponse { /** - * Records the error status for points that were not written due to an - * error.Failed requests for which nothing is written will return an error - * response instead. + * Records the error status for points that were not written due to an error.Failed requests for which nothing is written will return an error response instead. */ payloadErrors?: Schema$CollectdPayloadError[]; } @@ -483,50 +360,24 @@ export namespace monitoring_v3 { */ export interface Schema$CreateTimeSeriesRequest { /** - * The new data to be added to a list of time series. Adds at most one data - * point to each of several time series. The new data point must be more - * recent than any other point in its time series. Each TimeSeries value - * must fully specify a unique time series by supplying all label values for - * the metric and the monitored resource.The maximum number of TimeSeries - * objects per Create request is 200. + * The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.The maximum number of TimeSeries objects per Create request is 200. */ timeSeries?: Schema$TimeSeries[]; } /** - * Distribution contains summary statistics for a population of values. It - * optionally contains a histogram representing the distribution of those - * values across a set of buckets.The summary statistics are the count, mean, - * sum of the squared deviation from the mean, the minimum, and the maximum of - * the set of population of values. The histogram is based on a sequence of - * buckets and gives a count of values that fall into each bucket. The - * boundaries of the buckets are given either explicitly or by formulas for - * buckets of fixed or exponentially increasing widths.Although it is not - * forbidden, it is generally a bad idea to include non-finite values - * (infinities or NaNs) in the population of values, as this will render the - * mean and sum_of_squared_deviation fields meaningless. + * Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. */ export interface Schema$Distribution { /** - * Required in the Stackdriver Monitoring API v3. The values for each bucket - * specified in bucket_options. The sum of the values in bucketCounts must - * equal the value in the count field of the Distribution object. The order - * of the bucket counts follows the numbering schemes described for the - * three bucket types. The underflow bucket has number 0; the finite - * buckets, if any, have numbers 1 through N-2; and the overflow bucket has - * number N-1. The size of bucket_counts must not be greater than N. If the - * size is less than N, then the remaining buckets are assigned values of - * zero. + * Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero. */ bucketCounts?: string[]; /** - * Required in the Stackdriver Monitoring API v3. Defines the histogram - * bucket boundaries. + * Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries. */ bucketOptions?: Schema$BucketOptions; /** - * The number of values in the population. Must be non-negative. This value - * must equal the sum of the values in bucket_counts if a histogram is - * provided. + * The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided. */ count?: string; /** @@ -534,56 +385,33 @@ export namespace monitoring_v3 { */ exemplars?: Schema$Exemplar[]; /** - * The arithmetic mean of the values in the population. If count is zero - * then this field must be zero. + * The arithmetic mean of the values in the population. If count is zero then this field must be zero. */ mean?: number; /** - * If specified, contains the range of the population values. The field must - * not be present if the count is zero. This field is presently ignored by - * the Stackdriver Monitoring API v3. + * If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3. */ range?: Schema$Range; /** - * The sum of squared deviations from the mean of the values in the - * population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, - * "The Art of Computer Programming", Vol. 2, page 323, 3rd - * edition describes Welford's method for accumulating this sum in one - * pass.If count is zero then this field must be zero. + * The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero. */ sumOfSquaredDeviation?: number; } /** - * A content string and a MIME type that describes the content string's - * format. + * A content string and a MIME type that describes the content string's format. */ export interface Schema$Documentation { /** - * The text of the documentation, interpreted according to mime_type. The - * content may not exceed 8,192 Unicode characters and may not exceed more - * than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. + * The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. */ content?: string; /** - * The format of the content field. Presently, only the value - * "text/markdown" is supported. See Markdown - * (https://en.wikipedia.org/wiki/Markdown) for more information. + * The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. */ mimeType?: string; } /** - * A set of (label, value) pairs which were dropped during aggregation, - * attached to google.api.Distribution.Exemplars in google.api.Distribution - * values during aggregation.These values are used in combination with the - * label values that remain on the aggregated Distribution timeseries to - * construct the full label set for the exemplar values. The resulting full - * label set may be used to identify the specific task/job/instance (for - * example) which may be contributing to a long-tail, while allowing the - * storage savings of only storing aggregated distribution values for a large - * group.Note that there are no guarantees on ordering of the labels from - * exemplar-to-exemplar and from distribution-to-distribution in the same - * stream, and there may be duplicates. It is up to clients to resolve any - * ambiguities. + * A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities. */ export interface Schema$DroppedLabels { /** @@ -592,28 +420,15 @@ export namespace monitoring_v3 { label?: {[key: string]: string}; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for Empty is empty JSON object {}. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. */ export interface Schema$Empty {} /** - * Exemplars are example points that may be used to annotate aggregated - * distribution values. They are metadata that gives information about a - * particular value added to a Distribution bucket, such as a trace ID that - * was active when a value was added. They may contain further information, - * such as a example values and timestamps, origin, etc. + * Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc. */ export interface Schema$Exemplar { /** - * Contextual information about the example value. Examples are:Trace: - * type.googleapis.com/google.monitoring.v3.SpanContextLiteral string: - * type.googleapis.com/google.protobuf.StringValueLabels dropped during - * aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere - * may be only a single attachment of any given message type in a single - * exemplar, and this is enforced by the system. + * Contextual information about the example value. Examples are:Trace: type.googleapis.com/google.monitoring.v3.SpanContextLiteral string: type.googleapis.com/google.protobuf.StringValueLabels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. */ attachments?: Array<{[key: string]: any}>; /** @@ -621,18 +436,12 @@ export namespace monitoring_v3 { */ timestamp?: string; /** - * Value of the exemplar point. This value determines to which bucket the - * exemplar belongs. + * Value of the exemplar point. This value determines to which bucket the exemplar belongs. */ value?: number; } /** - * Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 - * (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i - * < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds - * field must contain at least one element. If bounds has only one element, - * then there are no finite buckets, and that single element is the common - * boundary of the overflow and underflow buckets. + * Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. */ export interface Schema$Explicit { /** @@ -641,12 +450,7 @@ export namespace monitoring_v3 { bounds?: number[]; } /** - * Specifies an exponential sequence of buckets that have a width that is - * proportional to the value of the lower bound. Each bucket represents a - * constant relative uncertainty on a specific value in the bucket.There are - * num_finite_buckets + 2 (= N) buckets. Bucket i has the following - * boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). - * Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). + * Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). */ export interface Schema$Exponential { /** @@ -691,9 +495,7 @@ export namespace monitoring_v3 { */ number?: number; /** - * The index of the field type in Type.oneofs, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. + * The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ oneofIndex?: number; /** @@ -705,8 +507,7 @@ export namespace monitoring_v3 { */ packed?: boolean; /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: "type.googleapis.com/google.protobuf.Timestamp". + * The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp". */ typeUrl?: string; } @@ -715,15 +516,7 @@ export namespace monitoring_v3 { */ export interface Schema$GetNotificationChannelVerificationCodeRequest { /** - * The desired expiration time. If specified, the API will guarantee that - * the returned code will not be valid after the specified timestamp; - * however, the API cannot guarantee that the returned code will be valid - * for at least as long as the requested time (the API puts an upper bound - * on the amount of time for which a code may be valid). If omitted, a - * default expiration will be used, which may be less than the max - * permissible expiration (so specifying an expiration may extend the - * code's lifetime over omitting an expiration, even though the API does - * impose an upper limit on the maximum expiration that is permitted). + * The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted). */ expireTime?: string; } @@ -732,41 +525,16 @@ export namespace monitoring_v3 { */ export interface Schema$GetNotificationChannelVerificationCodeResponse { /** - * The verification code, which may be used to verify other channels that - * have an equivalent identity (i.e. other channels of the same type with - * the same fingerprint such as other email channels with the same email - * address or other sms channels with the same number). + * The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number). */ code?: string; /** - * The expiration time associated with the code that was returned. If an - * expiration was provided in the request, this is the minimum of the - * requested expiration in the request and the max permitted expiration. + * The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration. */ expireTime?: string; } /** - * The description of a dynamic collection of monitored resources. Each group - * has a filter that is matched against monitored resources and their - * associated metadata. If a group's filter matches an available monitored - * resource, then that resource is a member of that group. Groups can contain - * any number of monitored resources, and each monitored resource can be a - * member of any number of groups.Groups can be nested in parent-child - * hierarchies. The parentName field identifies an optional parent for each - * group. If a group has a parent, then the only monitored resources available - * to be matched by the group's filter are the resources contained in the - * parent group. In other words, a group contains the monitored resources that - * match its filter and the filters of all the group's ancestors. A group - * without a parent can contain any monitored resource.For example, consider - * an infrastructure running a set of instances with two user-defined tags: - * "environment" and "role". A parent group has a filter, - * environment="production". A child of that parent group has a - * filter, role="transcoder". The parent group contains all - * instances in the production environment, regardless of their roles. The - * child group contains instances that have the transcoder role and are in the - * production environment.The monitored resources contained in a group can - * change at any moment, depending on what resources exist and what filters - * are associated with the group and its ancestors. + * The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors. */ export interface Schema$Group { /** @@ -774,27 +542,19 @@ export namespace monitoring_v3 { */ displayName?: string; /** - * The filter used to determine which monitored resources belong to this - * group. + * The filter used to determine which monitored resources belong to this group. */ filter?: string; /** - * If true, the members of this group are considered to be a cluster. The - * system can perform additional analysis on groups that are clusters. + * If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. */ isCluster?: boolean; /** - * Output only. The name of this group. The format is - * "projects/{project_id_or_number}/groups/{group_id}". When - * creating a group, this field is ignored and a new name is created - * consisting of the project specified in the call to CreateGroup and a - * unique {group_id} that is generated automatically. + * Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. */ name?: string; /** - * The name of the group's parent, if it has one. The format is - * "projects/{project_id_or_number}/groups/{group_id}". For groups - * with no parent, parentName is the empty string, "". + * The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "". */ parentName?: string; } @@ -803,41 +563,23 @@ export namespace monitoring_v3 { */ export interface Schema$HttpCheck { /** - * The authentication information. Optional when creating an HTTP check; - * defaults to empty. + * The authentication information. Optional when creating an HTTP check; defaults to empty. */ authInfo?: Schema$BasicAuthentication; /** - * The list of headers to send as part of the uptime check request. If two - * headers have the same key and different values, they should be entered as - * a single header, with the value being a comma-separated list of all the - * desired values as described at - * https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two - * separate headers with the same key in a Create call will cause the first - * to be overwritten by the second. The maximum number of headers allowed is - * 100. + * The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. */ headers?: {[key: string]: string}; /** - * Boolean specifiying whether to encrypt the header information. Encryption - * should be specified for any headers related to authentication that you do - * not wish to be seen when retrieving the configuration. The server will be - * responsible for encrypting the headers. On Get/List calls, if - * mask_headers is set to True then the headers will be obscured with - * ******. + * Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******. */ maskHeaders?: boolean; /** - * The path to the page to run the check against. Will be combined with the - * host (specified within the MonitoredResource) and port to construct the - * full URL. Optional (defaults to "/"). If the provided path does - * not begin with "/", it will be prepended automatically. + * The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/"). If the provided path does not begin with "/", it will be prepended automatically. */ path?: string; /** - * The port to the page to run the check against. Will be combined with host - * (specified within the MonitoredResource) and path to construct the full - * URL. Optional (defaults to 80 without SSL, or 443 with SSL). + * The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). */ port?: number; /** @@ -846,36 +588,27 @@ export namespace monitoring_v3 { useSsl?: boolean; } /** - * An internal checker allows uptime checks to run on private/internal GCP - * resources. + * An internal checker allows uptime checks to run on private/internal GCP resources.DEPRECATED. Use PrivateChecker instead. */ export interface Schema$InternalChecker { /** - * The checker's human-readable name. The display name should be unique - * within a Stackdriver Workspace in order to make it easier to identify; - * however, uniqueness is not enforced. + * The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. */ displayName?: string; /** - * The GCP zone the uptime check should egress from. Only respected for - * internal uptime checks, where internal_network is specified. + * The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified. */ gcpZone?: string; /** - * A unique resource name for this InternalChecker. The format - * is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].PROJECT_ID - * is the stackdriver workspace project for the uptime check config - * associated with the internal checker. + * A unique resource name for this InternalChecker. The format is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].PROJECT_ID is the stackdriver workspace project for the uptime check config associated with the internal checker. */ name?: string; /** - * The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the - * internal resource lives (ex: "default"). + * The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default"). */ network?: string; /** - * The GCP project_id where the internal checker lives. Not necessary the - * same as the workspace project. + * The GCP project_id where the internal checker lives. Not necessary the same as the workspace project. */ peerProjectId?: string; /** @@ -901,12 +634,7 @@ export namespace monitoring_v3 { valueType?: string; } /** - * Specifies a linear sequence of buckets that all have the same width (except - * overflow and underflow). Each bucket represents a constant absolute - * uncertainty on the specific value in the bucket.There are - * num_finite_buckets + 2 (= N) buckets. Bucket i has the following - * boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower - * bound (1 <= i < N): offset + (width * (i - 1)). + * Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). */ export interface Schema$Linear { /** @@ -931,9 +659,7 @@ export namespace monitoring_v3 { */ alertPolicies?: Schema$AlertPolicy[]; /** - * If there might be more results than were returned, then this field is set - * to a non-empty value. To see the additional results, use that value as - * pageToken in the next call to this method. + * If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. */ nextPageToken?: string; } @@ -946,9 +672,7 @@ export namespace monitoring_v3 { */ members?: Schema$MonitoredResource[]; /** - * If there are more results than have been returned, then this field is set - * to a non-empty value. To see the additional results, use that value as - * pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. */ nextPageToken?: string; /** @@ -965,9 +689,7 @@ export namespace monitoring_v3 { */ group?: Schema$Group[]; /** - * If there are more results than have been returned, then this field is set - * to a non-empty value. To see the additional results, use that value as - * pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. */ nextPageToken?: string; } @@ -976,14 +698,11 @@ export namespace monitoring_v3 { */ export interface Schema$ListMetricDescriptorsResponse { /** - * The metric descriptors that are available to the project and that match - * the value of filter, if present. + * The metric descriptors that are available to the project and that match the value of filter, if present. */ metricDescriptors?: Schema$MetricDescriptor[]; /** - * If there are more results than have been returned, then this field is set - * to a non-empty value. To see the additional results, use that value as - * pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. */ nextPageToken?: string; } @@ -992,14 +711,11 @@ export namespace monitoring_v3 { */ export interface Schema$ListMonitoredResourceDescriptorsResponse { /** - * If there are more results than have been returned, then this field is set - * to a non-empty value. To see the additional results, use that value as - * pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. */ nextPageToken?: string; /** - * The monitored resource descriptors that are available to this project and - * that match filter, if present. + * The monitored resource descriptors that are available to this project and that match filter, if present. */ resourceDescriptors?: Schema$MonitoredResourceDescriptor[]; } @@ -1008,14 +724,11 @@ export namespace monitoring_v3 { */ export interface Schema$ListNotificationChannelDescriptorsResponse { /** - * The monitored resource descriptors supported for the specified project, - * optionally filtered. + * The monitored resource descriptors supported for the specified project, optionally filtered. */ channelDescriptors?: Schema$NotificationChannelDescriptor[]; /** - * If not empty, indicates that there may be more results that match the - * request. Use the value in the page_token field in a subsequent request to - * fetch the next set of results. If empty, all results have been returned. + * If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned. */ nextPageToken?: string; } @@ -1024,9 +737,7 @@ export namespace monitoring_v3 { */ export interface Schema$ListNotificationChannelsResponse { /** - * If not empty, indicates that there may be more results that match the - * request. Use the value in the page_token field in a subsequent request to - * fetch the next set of results. If empty, all results have been returned. + * If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned. */ nextPageToken?: string; /** @@ -1039,14 +750,11 @@ export namespace monitoring_v3 { */ export interface Schema$ListTimeSeriesResponse { /** - * Query execution errors that may have caused the time series data returned - * to be incomplete. + * Query execution errors that may have caused the time series data returned to be incomplete. */ executionErrors?: Schema$Status[]; /** - * If there are more results than have been returned, then this field is set - * to a non-empty value. To see the additional results, use that value as - * pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. */ nextPageToken?: string; /** @@ -1059,16 +767,11 @@ export namespace monitoring_v3 { */ export interface Schema$ListUptimeCheckConfigsResponse { /** - * This field represents the pagination token to retrieve the next page of - * results. If the value is empty, it means no further results for the - * request. To retrieve the next page of results, the value of the - * next_page_token is passed to the subsequent List method call (in the - * request message's page_token field). + * This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). */ nextPageToken?: string; /** - * The total number of uptime check configurations for the project, - * irrespective of any pagination. + * The total number of uptime check configurations for the project, irrespective of any pagination. */ totalSize?: number; /** @@ -1081,84 +784,50 @@ export namespace monitoring_v3 { */ export interface Schema$ListUptimeCheckIpsResponse { /** - * This field represents the pagination token to retrieve the next page of - * results. If the value is empty, it means no further results for the - * request. To retrieve the next page of results, the value of the - * next_page_token is passed to the subsequent List method call (in the - * request message's page_token field). NOTE: this field is not yet - * implemented + * This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented */ nextPageToken?: string; /** - * The returned list of IP addresses (including region and location) that - * the checkers run from. + * The returned list of IP addresses (including region and location) that the checkers run from. */ uptimeCheckIps?: Schema$UptimeCheckIp[]; } /** - * A specific metric, identified by specifying values for all of the labels of - * a MetricDescriptor. + * A specific metric, identified by specifying values for all of the labels of a MetricDescriptor. */ export interface Schema$Metric { /** - * The set of label values that uniquely identify this metric. All labels - * listed in the MetricDescriptor must be assigned values. + * The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values. */ labels?: {[key: string]: string}; /** - * An existing metric type, see google.api.MetricDescriptor. For example, - * custom.googleapis.com/invoice/paid/amount. + * An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount. */ type?: string; } /** - * A condition type that checks that monitored resources are reporting data. - * The configuration defines a metric and a set of monitored resources. The - * predicate is considered in violation when a time series for the specified - * metric of a monitored resource does not include any data in the specified - * duration. + * A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified duration. */ export interface Schema$MetricAbsence { /** - * Specifies the alignment of data points in individual time series as well - * as how to combine the retrieved time series together (such as when - * aggregating multiple streams on each resource to a single stream for each - * resource or when aggregating streams across all members of a group of - * resrouces). Multiple aggregations are applied in the order specified.This - * field is similar to the one in the MetricService.ListTimeSeries request. - * It is advisable to use the ListTimeSeries method when debugging this - * field. + * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. */ aggregations?: Schema$Aggregation[]; /** - * The amount of time that a time series must fail to report new data to be - * considered failing. Currently, only values that are a multiple of a - * minute--e.g. 60, 120, or 300 seconds--are supported. If an invalid value - * is given, an error will be returned. The Duration.nanos field is ignored. + * The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. The Duration.nanos field is ignored. */ duration?: string; /** - * A filter that identifies which time series should be compared with the - * threshold.The filter is similar to the one that is specified in the - * MetricService.ListTimeSeries request (that call is useful to verify the - * time series that will be retrieved / processed) and must specify the - * metric type and optionally may contain restrictions on resource type, - * resource labels, and metric labels. This field may not exceed 2048 - * Unicode characters in length. + * A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ filter?: string; /** - * The number/percent of time series for which the comparison must hold in - * order for the condition to trigger. If unspecified, then the condition - * will trigger if the comparison is true for any of the time series that - * have been identified by filter and aggregations. + * The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations. */ trigger?: Schema$Trigger; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1166,18 +835,11 @@ export namespace monitoring_v3 { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * appengine.googleapis.com/http/server/response_latencies metric type has a - * label for the HTTP response code, response_code, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -1185,8 +847,7 @@ export namespace monitoring_v3 { */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of metric_kind and value_type might not be supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. */ metricKind?: string; /** @@ -1194,43 +855,15 @@ export namespace monitoring_v3 { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * custom.googleapis.com or external.googleapis.com. Metric types should use - * a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are - * a subset of The Unified Code for Units of Measure - * (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit - * By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) - * M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa - * (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro - * (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto - * (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi - * (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes - * these connectors: / division (as an infix operator, e.g. 1/s). . - * multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit - * is as follows: Expression = Component { "." Component } { - * "/" Component } ; Component = ( [ PREFIX ] UNIT | - * "%" ) [ Annotation ] | Annotation | - * "1" ; Annotation = "{" NAME "}" - * ; Notes: Annotation is just a comment if it follows a UNIT and is - * equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, - * By{transmitted}/s == By/s. NAME is a sequence of non-blank printable - * ASCII characters not containing '{' or '}'. 1 represents - * dimensionless value 1, such as in 1/s. % represents dimensionless value - * 1/100, and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of metric_kind and value_type might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. */ valueType?: string; } @@ -1239,9 +872,7 @@ export namespace monitoring_v3 { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** @@ -1249,82 +880,36 @@ export namespace monitoring_v3 { */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * A condition type that compares a collection of time series against a - * threshold. + * A condition type that compares a collection of time series against a threshold. */ export interface Schema$MetricThreshold { /** - * Specifies the alignment of data points in individual time series as well - * as how to combine the retrieved time series together (such as when - * aggregating multiple streams on each resource to a single stream for each - * resource or when aggregating streams across all members of a group of - * resrouces). Multiple aggregations are applied in the order specified.This - * field is similar to the one in the MetricService.ListTimeSeries request. - * It is advisable to use the ListTimeSeries method when debugging this - * field. + * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. */ aggregations?: Schema$Aggregation[]; /** - * The comparison to apply between the time series (indicated by filter and - * aggregation) and the threshold (indicated by threshold_value). The - * comparison is applied on each time series, with the time series on the - * left-hand side and the threshold on the right-hand side.Only - * COMPARISON_LT and COMPARISON_GT are supported currently. + * The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side.Only COMPARISON_LT and COMPARISON_GT are supported currently. */ comparison?: string; /** - * Specifies the alignment of data points in individual time series selected - * by denominatorFilter as well as how to combine the retrieved time series - * together (such as when aggregating multiple streams on each resource to a - * single stream for each resource or when aggregating streams across all - * members of a group of resources).When computing ratios, the aggregations - * and denominator_aggregations fields must use the same alignment period - * and produce time series that have the same periodicity and labels.This - * field is similar to the one in the MetricService.ListTimeSeries request. - * It is advisable to use the ListTimeSeries method when debugging this - * field. + * Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. */ denominatorAggregations?: Schema$Aggregation[]; /** - * A filter that identifies a time series that should be used as the - * denominator of a ratio that will be compared with the threshold. If a - * denominator_filter is specified, the time series specified by the filter - * field will be used as the numerator.The filter is similar to the one that - * is specified in the MetricService.ListTimeSeries request (that call is - * useful to verify the time series that will be retrieved / processed) and - * must specify the metric type and optionally may contain restrictions on - * resource type, resource labels, and metric labels. This field may not - * exceed 2048 Unicode characters in length. + * A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ denominatorFilter?: string; /** - * The amount of time that a time series must violate the threshold to be - * considered failing. Currently, only values that are a multiple of a - * minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid - * value is given, an error will be returned. When choosing a duration, it - * is useful to keep in mind the frequency of the underlying time series - * data (which may also be affected by any alignments specified in the - * aggregations field); a good duration is long enough so that a single - * outlier does not generate spurious alerts, but short enough that - * unhealthy states are detected and alerted on quickly. + * The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly. */ duration?: string; /** - * A filter that identifies which time series should be compared with the - * threshold.The filter is similar to the one that is specified in the - * MetricService.ListTimeSeries request (that call is useful to verify the - * time series that will be retrieved / processed) and must specify the - * metric type and optionally may contain restrictions on resource type, - * resource labels, and metric labels. This field may not exceed 2048 - * Unicode characters in length. + * A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ filter?: string; /** @@ -1332,107 +917,58 @@ export namespace monitoring_v3 { */ thresholdValue?: number; /** - * The number/percent of time series for which the comparison must hold in - * order for the condition to trigger. If unspecified, then the condition - * will trigger if the comparison is true for any of the time series that - * have been identified by filter and aggregations, or by the ratio, if - * denominator_filter and denominator_aggregations are specified. + * The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified. */ trigger?: Schema$Trigger; } /** - * An object representing a resource that can be used for monitoring, logging, - * billing, or other purposes. Examples include virtual machine instances, - * databases, and storage devices such as disks. The type field identifies a - * MonitoredResourceDescriptor object that describes the resource's - * schema. Information in the labels field identifies the actual resource and - * its attributes according to the schema. For example, a particular Compute - * Engine VM instance could be represented by the following object, because - * the MonitoredResourceDescriptor for "gce_instance" has labels - * "instance_id" and "zone": { "type": - * "gce_instance", "labels": { "instance_id": - * "12345678901234", "zone": - * "us-central1-a" }} + * An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} */ export interface Schema$MonitoredResource { /** - * Required. Values for all of the labels listed in the associated monitored - * resource descriptor. For example, Compute Engine VM instances use the - * labels "project_id", "instance_id", and - * "zone". + * Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone". */ labels?: {[key: string]: string}; /** - * Required. The monitored resource type. This field must match the type - * field of a MonitoredResourceDescriptor object. For example, the type of a - * Compute Engine VM instance is gce_instance. For a list of types, see - * Monitoring resource types and Logging resource types. + * Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types. */ type?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * "gce_instance" and specifies the use of the labels - * "instance_id" and "zone" to identify particular VM - * instances.Different APIs can support different monitored resource types. - * APIs generally provide a list method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, "Google Cloud - * SQL Database". + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels "database_id" and - * "zone". + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone". */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * "projects/{project_id}/monitoredResourceDescriptors/{type}" - * where {type} is the value of the type field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format "monitoredResourceDescriptors/{type}". + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". */ name?: string; /** - * Required. The monitored resource type. For example, the type - * "cloudsql_database" represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Auxiliary metadata for a MonitoredResource object. MonitoredResource - * objects contain the minimum set of information to uniquely identify a - * monitored resource instance. There is some other useful auxiliary metadata. - * Monitoring and Logging use an ingestion pipeline to extract metadata for - * cloud resources of all types, and store the metadata in this message. + * Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. */ export interface Schema$MonitoredResourceMetadata { /** - * Output only. Values for predefined system metadata labels. System labels - * are a kind of metadata extracted by Google, including - * "machine_image", "vpc", "subnet_id", - * "security_group", "name", etc. System label values - * can be only strings, Boolean values, or a list of strings. For example: { - * "name": "my-test-instance", - * "security_group": ["a", "b", - * "c"], "spot_instance": false } + * Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } */ systemLabels?: {[key: string]: any}; /** @@ -1454,138 +990,81 @@ export namespace monitoring_v3 { mutateTime?: string; } /** - * A NotificationChannel is a medium through which an alert is delivered when - * a policy violation is detected. Examples of channels include email, SMS, - * and third-party messaging applications. Fields containing sensitive - * information like authentication tokens or contact info are only partially - * populated on retrieval. + * A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval. */ export interface Schema$NotificationChannel { /** - * An optional human-readable description of this notification channel. This - * description may provide additional details, beyond the display name, for - * the channel. This may not exceed 1024 Unicode characters. + * An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters. */ description?: string; /** - * An optional human-readable name for this notification channel. It is - * recommended that you specify a non-empty and unique name in order to make - * it easier to identify the channels in your project, though this is not - * enforced. The display name is limited to 512 Unicode characters. + * An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters. */ displayName?: string; /** - * Whether notifications are forwarded to the described channel. This makes - * it possible to disable delivery of notifications to a particular channel - * without removing the channel from all alerting policies that reference - * the channel. This is a more convenient approach when the change is - * temporary and you want to receive notifications from the same set of - * alerting policies on the channel at some point in the future. + * Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future. */ enabled?: boolean; /** - * Configuration fields that define the channel and its behavior. The - * permissible and required labels are specified in the - * NotificationChannelDescriptor.labels of the NotificationChannelDescriptor - * corresponding to the type field. + * Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field. */ labels?: {[key: string]: string}; /** - * The full REST resource name for this channel. The syntax is: - * projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] - * is automatically assigned by the server on creation. + * The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string; /** - * The type of the notification channel. This field matches the value of the - * NotificationChannelDescriptor.type field. + * The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. */ type?: string; /** - * User-supplied key/value data that does not need to conform to the - * corresponding NotificationChannelDescriptor's schema, unlike the - * labels field. This field is intended to be used for organizing and - * identifying the NotificationChannel objects.The field can contain up to - * 64 entries. Each key and value is limited to 63 Unicode characters or 128 - * bytes, whichever is smaller. Labels and values can contain only lowercase - * letters, numerals, underscores, and dashes. Keys must begin with a - * letter. + * User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. */ userLabels?: {[key: string]: string}; /** - * Indicates whether this channel has been verified or not. On a - * ListNotificationChannels or GetNotificationChannel operation, this field - * is expected to be populated.If the value is UNVERIFIED, then it indicates - * that the channel is non-functioning (it both requires verification and - * lacks verification); otherwise, it is assumed that the channel works.If - * the channel is neither VERIFIED nor UNVERIFIED, it implies that the - * channel is of a type that does not require verification or that this - * specific channel has been exempted from verification because it was - * created prior to verification being required for channels of this - * type.This field cannot be modified using a standard - * UpdateNotificationChannel operation. To change the value of this field, - * you must call VerifyNotificationChannel. + * Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel. */ verificationStatus?: string; } /** - * A description of a notification channel. The descriptor includes the - * properties of the channel and the set of labels or fields that must be - * specified to configure channels of a given type. + * A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type. */ export interface Schema$NotificationChannelDescriptor { /** - * A human-readable description of the notification channel type. The - * description may include a description of the properties of the channel - * and pointers to external documentation. + * A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation. */ description?: string; /** - * A human-readable name for the notification channel type. This form of the - * name is suitable for a user interface. + * A human-readable name for the notification channel type. This form of the name is suitable for a user interface. */ displayName?: string; /** - * The set of labels that must be defined to identify a particular channel - * of the corresponding type. Each label includes a description for how that - * field should be populated. + * The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated. */ labels?: Schema$LabelDescriptor[]; /** - * The full REST resource name for this descriptor. The syntax is: - * projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above, - * [TYPE] is the value of the type field. + * The full REST resource name for this descriptor. The syntax is: projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field. */ name?: string; /** - * The tiers that support this notification channel; the project service - * tier must be one of the supported_tiers. + * The tiers that support this notification channel; the project service tier must be one of the supported_tiers. */ supportedTiers?: string[]; /** - * The type of notification channel, such as "email", - * "sms", etc. Notification channel types are globally unique. + * The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique. */ type?: string; } /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ export interface Schema$Option { /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * "map_entry". For custom options, it should be the - * fully-qualified name. For example, "google.api.http". + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http". */ name?: string; /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ value?: {[key: string]: any}; } @@ -1594,14 +1073,7 @@ export namespace monitoring_v3 { */ export interface Schema$Point { /** - * The time interval to which the data point applies. For GAUGE metrics, - * only the end time of the interval is used. For DELTA metrics, the start - * and end time should specify a non-zero interval, with subsequent points - * specifying contiguous and non-overlapping intervals. For CUMULATIVE - * metrics, the start and end time should specify a non-zero interval, with - * subsequent points specifying the same start time and increasing end - * times, until an event resets the cumulative value to zero and sets a new - * start time for the following points. + * The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. */ interval?: Schema$TimeInterval; /** @@ -1623,13 +1095,11 @@ export namespace monitoring_v3 { min?: number; } /** - * The resource submessage for group checks. It can be used instead of a - * monitored resource, when multiple resources are being monitored. + * The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. */ export interface Schema$ResourceGroup { /** - * The group of resources being monitored. Should be only the group_id, not - * projects/<project_id>/groups/<group_id>. + * The group of resources being monitored. Should be only the group_id, not projects/<project_id>/groups/<group_id>. */ groupId?: string; /** @@ -1642,67 +1112,25 @@ export namespace monitoring_v3 { */ export interface Schema$SendNotificationChannelVerificationCodeRequest {} /** - * SourceContext represents information about the source of a protobuf - * element, like the file in which it is defined. + * SourceContext represents information about the source of a protobuf element, like the file in which it is defined. */ export interface Schema$SourceContext { /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * "google/protobuf/source_context.proto". + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". */ fileName?: string; } /** - * The context of a span, attached to google.api.Distribution.Exemplars in - * google.api.Distribution values during aggregation.It contains the name of a - * span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID + * The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.It contains the name of a span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID */ export interface Schema$SpanContext { /** - * The resource name of the span in the following format: - * projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] TRACE_ID is a - * unique identifier for a trace within a project; it is a 32-character - * hexadecimal encoding of a 16-byte array.SPAN_ID is a unique identifier - * for a span within a trace; it is a 16-character hexadecimal encoding of - * an 8-byte array. + * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] TRACE_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.SPAN_ID is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ spanName?: string; } /** - * The Status type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by gRPC (https://github.com/grpc). The error model is designed to be: - * Simple to use and understand for most users Flexible enough to meet - * unexpected needsOverviewThe Status message contains three pieces of data: - * error code, error message, and error details. The error code should be an - * enum value of google.rpc.Code, but it may accept additional error codes if - * needed. The error message should be a developer-facing English message that - * helps developers understand and resolve the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may - * contain arbitrary information about the error. There is a predefined set of - * error detail types in the package google.rpc that can be used for common - * error conditions.Language mappingThe Status message is the logical - * representation of the error model, but it is not necessarily the actual - * wire format. When the Status message is exposed in different client - * libraries and different wire protocols, it can be mapped differently. For - * example, it will likely be mapped to some exceptions in Java, but more - * likely mapped to some error codes in C.Other usesThe error model and the - * Status message can be used in a variety of environments, either with or - * without APIs, to provide a consistent developer experience across different - * environments.Example uses of this error model include: Partial errors. If a - * service needs to return partial errors to the client, it may embed the - * Status in the normal response to indicate the partial errors. Workflow - * errors. A typical workflow has multiple steps. Each step may have a Status - * message for error reporting. Batch operations. If a client uses batch - * request and batch response, the Status message should be used directly - * inside batch response, one for each error sub-response. Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the Status message. Logging. If some API errors are stored in logs, - * the message Status could be used directly after any stripping needed for - * security/privacy reasons. + * The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1710,14 +1138,11 @@ export namespace monitoring_v3 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1726,20 +1151,12 @@ export namespace monitoring_v3 { */ export interface Schema$TcpCheck { /** - * The port to the page to run the check against. Will be combined with host - * (specified within the MonitoredResource) to construct the full URL. - * Required. + * The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. Required. */ port?: number; } /** - * A time interval extending just after a start time through an end time. The - * start time must not be later than the end time. The default start time is - * the end time, making the startTime value technically optional. Whether this - * is useful depends on the MetricKind. If the start and end times are the - * same, the interval represents a point in time. This is appropriate for - * GAUGE metrics, but not for DELTA and CUMULATIVE metrics, which cover a span - * of time. + * A time interval extending just after a start time through an end time. The start time must not be later than the end time. The default start time is the end time, making the startTime value technically optional. Whether this is useful depends on the MetricKind. If the start and end times are the same, the interval represents a point in time. This is appropriate for GAUGE metrics, but not for DELTA and CUMULATIVE metrics, which cover a span of time. */ export interface Schema$TimeInterval { /** @@ -1747,79 +1164,49 @@ export namespace monitoring_v3 { */ endTime?: string; /** - * Optional. The beginning of the time interval. The default value for the - * start time is the end time. The start time must not be later than the end - * time. + * Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */ startTime?: string; } /** - * A collection of data points that describes the time-varying values of a - * metric. A time series is identified by a combination of a fully-specified - * monitored resource and a fully-specified metric. This type is used for both - * listing and creating time series. + * A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. */ export interface Schema$TimeSeries { /** - * Output only. The associated monitored resource metadata. When reading a a - * timeseries, this field will include metadata labels that are explicitly - * named in the reduction. When creating a timeseries, this field is - * ignored. + * Output only. The associated monitored resource metadata. When reading a a timeseries, this field will include metadata labels that are explicitly named in the reduction. When creating a timeseries, this field is ignored. */ metadata?: Schema$MonitoredResourceMetadata; /** - * The associated metric. A fully-specified metric used to identify the time - * series. + * The associated metric. A fully-specified metric used to identify the time series. */ metric?: Schema$Metric; /** - * The metric kind of the time series. When listing time series, this metric - * kind might be different from the metric kind of the associated metric if - * this time series is an alignment or reduction of other time series.When - * creating a time series, this field is optional. If present, it must be - * the same as the metric kind of the associated metric. If the associated - * metric's descriptor must be auto-created, then this field specifies - * the metric kind of the new descriptor and must be either GAUGE (the - * default) or CUMULATIVE. + * The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. */ metricKind?: string; /** - * The data points of this time series. When listing time series, points are - * returned in reverse time order.When creating a time series, this field - * must contain exactly one point and the point's type must be the same - * as the value type of the associated metric. If the associated - * metric's descriptor must be auto-created, then the value type of the - * descriptor is determined by the point's type, which must be BOOL, - * INT64, DOUBLE, or DISTRIBUTION. + * The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. */ points?: Schema$Point[]; /** - * The associated monitored resource. Custom metrics can use only certain - * monitored resource types in their time series data. + * The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. */ resource?: Schema$MonitoredResource; /** - * The value type of the time series. When listing time series, this value - * type might be different from the value type of the associated metric if - * this time series is an alignment or reduction of other time series.When - * creating a time series, this field is optional. If present, it must be - * the same as the type of the data in the points field. + * The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. */ valueType?: string; } /** - * Specifies how many time series must fail a predicate to trigger a - * condition. If not specified, then a {count: 1} trigger is used. + * Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a {count: 1} trigger is used. */ export interface Schema$Trigger { /** - * The absolute number of time series that must fail the predicate for the - * condition to be triggered. + * The absolute number of time series that must fail the predicate for the condition to be triggered. */ count?: number; /** - * The percentage of time series that must fail the predicate for the - * condition to be triggered. + * The percentage of time series that must fail the predicate for the condition to be triggered. */ percent?: number; } @@ -1865,14 +1252,11 @@ export namespace monitoring_v3 { */ distributionValue?: Schema$Distribution; /** - * A 64-bit double-precision floating-point number. Its magnitude is - * approximately &plusmn;10<sup>&plusmn;300</sup> and it - * has 16 significant digits of precision. + * A 64-bit double-precision floating-point number. Its magnitude is approximately &plusmn;10<sup>&plusmn;300</sup> and it has 16 significant digits of precision. */ doubleValue?: number; /** - * A 64-bit integer. Its range is approximately - * &plusmn;9.2x10<sup>18</sup>. + * A 64-bit integer. Its range is approximately &plusmn;9.2x10<sup>18</sup>. */ int64Value?: string; /** @@ -1881,22 +1265,15 @@ export namespace monitoring_v3 { stringValue?: string; } /** - * This message configures which resources and services to monitor for - * availability. + * This message configures which resources and services to monitor for availability. */ export interface Schema$UptimeCheckConfig { /** - * The expected content on the page the check is run against. Currently, - * only the first entry in the list is supported, and other entries will be - * ignored. The server will look for an exact match of the string in the - * page response's content. This field is optional and should only be - * specified if a content match is required. + * The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. */ contentMatchers?: Schema$ContentMatcher[]; /** - * A human-friendly name for the uptime check configuration. The display - * name should be unique within a Stackdriver Workspace in order to make it - * easier to identify; however, uniqueness is not enforced. Required. + * A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. */ displayName?: string; /** @@ -1904,31 +1281,19 @@ export namespace monitoring_v3 { */ httpCheck?: Schema$HttpCheck; /** - * The internal checkers that this check will egress from. If is_internal is - * true and this list is empty, the check will egress from all the - * InternalCheckers configured for the project that owns this CheckConfig. + * The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this CheckConfig. */ internalCheckers?: Schema$InternalChecker[]; /** - * The monitored resource - * (https://cloud.google.com/monitoring/api/resources) associated with the - * configuration. The following monitored resource types are supported for - * uptime checks: uptime_url gce_instance gae_app aws_ec2_instance - * aws_elb_load_balancer + * The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer */ monitoredResource?: Schema$MonitoredResource; /** - * A unique resource name for this UptimeCheckConfig. The format - * is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field - * should be omitted when creating the uptime check configuration; on - * create, the resource name is assigned by the server and included in the - * response. + * A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. */ name?: string; /** - * How often, in seconds, the uptime check is performed. Currently, the only - * supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), - * and 900s (15 minutes). Optional, defaults to 60s. + * How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s. */ period?: string; /** @@ -1936,11 +1301,7 @@ export namespace monitoring_v3 { */ resourceGroup?: Schema$ResourceGroup; /** - * The list of regions from which the check will be run. Some regions - * contain one location, and others contain more than one. If this field is - * specified, enough regions to include a minimum of 3 locations must be - * provided, or an error message is returned. Not specifying this field will - * result in uptime checks running from all regions. + * The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. */ selectedRegions?: string[]; /** @@ -1948,28 +1309,20 @@ export namespace monitoring_v3 { */ tcpCheck?: Schema$TcpCheck; /** - * The maximum amount of time to wait for the request to complete (must be - * between 1 and 60 seconds). Required. + * The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. */ timeout?: string; } /** - * Contains the region, location, and list of IP addresses where checkers in - * the location run from. + * Contains the region, location, and list of IP addresses where checkers in the location run from. */ export interface Schema$UptimeCheckIp { /** - * The IP address from which the uptime check originates. This is a full IP - * address (not an IP address range). Most IP addresses, as of this - * publication, are in IPv4 format; however, one should not rely on the IP - * addresses being in IPv4 format indefinitely and should support - * interpreting this field in either IPv4 or IPv6 format. + * The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format. */ ipAddress?: string; /** - * A more specific location within the region that typically encodes a - * particular city/town/metro (and its containing state/province or country) - * within the broader umbrella region category. + * A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category. */ location?: string; /** @@ -1982,13 +1335,7 @@ export namespace monitoring_v3 { */ export interface Schema$VerifyNotificationChannelRequest { /** - * The verification code that was delivered to the channel as a result of - * invoking the SendNotificationChannelVerificationCode API method or that - * was retrieved from a verified channel via - * GetNotificationChannelVerificationCode. For example, one might have - * "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, - * one is only guaranteed that the code is valid UTF-8; one should not make - * any assumptions regarding the structure or format of the code). + * The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code). */ code?: string; } @@ -2338,10 +1685,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.alertPolicies.patch - * @desc Updates an alerting policy. You can either replace the entire - * policy with a new one or replace only certain fields in the current - * alerting policy by specifying the fields to be updated via updateMask. - * Returns the updated alerting policy. + * @desc Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy. * @alias monitoring.projects.alertPolicies.patch * @memberOf! () * @@ -2421,13 +1765,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the alerting policy. The format is - * projects/[PROJECT_ID].Note that this field names the parent container in - * which the alerting policy will be written, not the name of the created - * policy. The alerting policy that is returned will have a name that - * contains a normalized representation of this name as a prefix but adds a - * suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in - * the container. + * The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container. */ name?: string; @@ -2444,9 +1782,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The alerting policy to delete. The format is: - * projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more - * information, see AlertPolicy. + * The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. */ name?: string; } @@ -2458,8 +1794,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The alerting policy to retrieve. The format is - * projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] + * The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] */ name?: string; } @@ -2471,23 +1806,15 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If provided, this field specifies the criteria that must be met by alert - * policies to be included in the response.For more details, see sorting and - * filtering. + * If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering. */ filter?: string; /** - * The project whose alert policies are to be listed. The format is - * projects/[PROJECT_ID] Note that this field names the parent container in - * which the alerting policies to be listed are stored. To retrieve a single - * alerting policy by name, use the GetAlertPolicy operation, instead. + * The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. */ name?: string; /** - * A comma-separated list of fields by which to sort the result. Supports - * the same set of field references as the filter field. Entries can be - * prefixed with a minus sign to sort by the field in descending order.For - * more details, see sorting and filtering. + * A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering. */ orderBy?: string; /** @@ -2495,9 +1822,7 @@ export namespace monitoring_v3 { */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return more results from the previous method call. + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. */ pageToken?: string; } @@ -2509,31 +1834,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required if the policy exists. The resource name for this policy. The - * syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] - * [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy - * is created. When calling the alertPolicies.create method, do not include - * the name field in the alerting policy passed as part of the request. + * Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. */ name?: string; /** - * Optional. A list of alerting policy field names. If this field is not - * empty, each listed field in the existing alerting policy is set to the - * value of the corresponding field in the supplied policy (alert_policy), - * or to the field's default value if the field is not in the supplied - * alerting policy. Fields not listed retain their previous value.Examples - * of valid field masks include display_name, documentation, - * documentation.content, documentation.mime_type, user_labels, - * user_label.nameofkey, enabled, conditions, combiner, etc.If this field is - * empty, then the supplied alerting policy replaces the existing policy. It - * is the same as deleting the existing policy and adding the supplied - * policy, except for the following: The new policy will have the same - * [ALERT_POLICY_ID] as the former policy. This gives you continuity with - * the former policy in your notifications and incidents. Conditions in the - * new policy will keep their former [CONDITION_ID] if the supplied - * condition includes the name field with that [CONDITION_ID]. If the - * supplied condition omits the name field, then a new [CONDITION_ID] is - * created. + * Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created. */ updateMask?: string; @@ -2551,22 +1856,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.collectdTimeSeries.create - * @desc Stackdriver Monitoring Agent only: Creates a new time series.

                          + * @desc Stackdriver Monitoring Agent only: Creates a new time series. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -2576,25 +1874,26 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'create' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'create' method: * - * // The project in which to create the time series. The format is - * `"projects/PROJECT_ID_OR_NUMBER"`. name: "projects/{MY-PROJECT}", + * // The project in which to create the time series. The format is `"projects/PROJECT_ID_OR_NUMBER"`. + * name: "projects/{MY-PROJECT}", * resource: {}, * // Auth client * auth: authClient * }; * - * monitoring.projects.collectdTimeSeries.create(request, function(err, - * result) { if (err) { console.log(err); } else { console.log(result); + * monitoring.projects.collectdTimeSeries.create(request, function(err, result) { + * if (err) { + * console.log(err); + * } else { + * console.log(result); * } * }); * }); @@ -2688,8 +1987,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the time series. The format is - * "projects/PROJECT_ID_OR_NUMBER". + * The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER". */ name?: string; @@ -2713,16 +2011,11 @@ export namespace monitoring_v3 { * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -2732,18 +2025,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'create' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'create' method: * - * // The project in which to create the group. The format is - * `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}", + * // The project in which to create the group. The format is `"projects/{project_id_or_number}"`. + * name: "projects/{MY-PROJECT}", * resource: {}, * // Auth client * auth: authClient @@ -2831,16 +2122,11 @@ export namespace monitoring_v3 { * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -2850,19 +2136,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'delete' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'delete' method: * - * // The group to delete. The format is - * `"projects/{project_id_or_number}/groups/{group_id}"`. name: - * "projects/{MY-PROJECT}/groups/{MY-GROUP}", + * // The group to delete. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. + * name: "projects/{MY-PROJECT}/groups/{MY-GROUP}", * // Auth client * auth: authClient * }; @@ -2948,16 +2231,11 @@ export namespace monitoring_v3 { * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -2967,19 +2245,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'get' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'get' method: * - * // The group to retrieve. The format is - * `"projects/{project_id_or_number}/groups/{group_id}"`. name: - * "projects/{MY-PROJECT}/groups/{MY-GROUP}", + * // The group to retrieve. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. + * name: "projects/{MY-PROJECT}/groups/{MY-GROUP}", * // Auth client * auth: authClient * }; @@ -3064,16 +2339,11 @@ export namespace monitoring_v3 { * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -3083,18 +2353,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'list' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'list' method: * - * // The project whose groups are to be listed. The format is - * `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}", + * // The project whose groups are to be listed. The format is `"projects/{project_id_or_number}"`. + * name: "projects/{MY-PROJECT}", * // Auth client * auth: authClient * }; @@ -3189,21 +2457,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.groups.update - * @desc Updates an existing group. You can change any group attributes - * except name. + * @desc Updates an existing group. You can change any group attributes except name. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -3213,22 +2475,17 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'update' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'update' method: * - * // The name of this group. The format is - * `"projects/{project_id_or_number}/groups/{group_id}"`. When - * // creating a group, this field is ignored and a new name is created - * consisting of the project - * // specified in the call to `CreateGroup` and a unique `{group_id}` - * that is generated automatically. + * // The name of this group. The format is `"projects/{project_id_or_number}/groups/{group_id}"`. When + * // creating a group, this field is ignored and a new name is created consisting of the project + * // specified in the call to `CreateGroup` and a unique `{group_id}` that is generated automatically. * // @OutputOnly * name: "projects/{MY-PROJECT}/groups/{MY-GROUP}", * resource: {}, @@ -3321,8 +2578,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the group. The format is - * "projects/{project_id_or_number}". + * The project in which to create the group. The format is "projects/{project_id_or_number}". */ name?: string; /** @@ -3343,14 +2599,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The group to delete. The format is - * "projects/{project_id_or_number}/groups/{group_id}". + * The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}". */ name?: string; /** - * If this field is true, then the request means to delete a group with all - * its descendants. Otherwise, the request means to delete a group only when - * it has no descendants. The default value is false. + * If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false. */ recursive?: boolean; } @@ -3362,8 +2615,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The group to retrieve. The format is - * "projects/{project_id_or_number}/groups/{group_id}". + * The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}". */ name?: string; } @@ -3375,29 +2627,19 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A group name: "projects/{project_id_or_number}/groups/{group_id}". - * Returns groups that are ancestors of the specified group. The groups are - * returned in order, starting with the immediate parent and ending with the - * most distant ancestor. If the specified group has no immediate parent, - * the results are empty. + * A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. */ ancestorsOfGroup?: string; /** - * A group name: "projects/{project_id_or_number}/groups/{group_id}". - * Returns groups whose parentName field contains the group name. If no - * groups have this parent, the results are empty. + * A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty. */ childrenOfGroup?: string; /** - * A group name: "projects/{project_id_or_number}/groups/{group_id}". - * Returns the descendants of the specified group. This is a superset of the - * results returned by the childrenOfGroup filter, and includes - * children-of-children, and so forth. + * A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth. */ descendantsOfGroup?: string; /** - * The project whose groups are to be listed. The format is - * "projects/{project_id_or_number}". + * The project whose groups are to be listed. The format is "projects/{project_id_or_number}". */ name?: string; /** @@ -3405,9 +2647,7 @@ export namespace monitoring_v3 { */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. */ pageToken?: string; } @@ -3419,11 +2659,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The name of this group. The format is - * "projects/{project_id_or_number}/groups/{group_id}". When creating a - * group, this field is ignored and a new name is created consisting of the - * project specified in the call to CreateGroup and a unique {group_id} that - * is generated automatically. + * Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. */ name?: string; /** @@ -3449,16 +2685,11 @@ export namespace monitoring_v3 { * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -3468,15 +2699,13 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'list' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'list' method: * * // The group whose members are listed. The format is * // `"projects/{project_id_or_number}/groups/{group_id}"`. @@ -3587,11 +2816,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional list filter describing the members to be returned. The filter - * may reference the type, labels, and metadata of monitored resources that - * comprise the group. For example, to return only resources representing - * Compute Engine VM instances, use this filter: resource.type = - * "gce_instance" + * An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: resource.type = "gce_instance" */ filter?: string; /** @@ -3599,14 +2824,11 @@ export namespace monitoring_v3 { */ 'interval.endTime'?: string; /** - * Optional. The beginning of the time interval. The default value for the - * start time is the end time. The start time must not be later than the end - * time. + * Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */ 'interval.startTime'?: string; /** - * The group whose members are listed. The format is - * "projects/{project_id_or_number}/groups/{group_id}". + * The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}". */ name?: string; /** @@ -3614,9 +2836,7 @@ export namespace monitoring_v3 { */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. */ pageToken?: string; } @@ -3629,21 +2849,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.metricDescriptors.create - * @desc Creates a new metric descriptor. User-created metric descriptors - * define custom metrics. + * @desc Creates a new metric descriptor. User-created metric descriptors define custom metrics. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -3653,25 +2867,26 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'create' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'create' method: * - * // The project on which to execute the request. The format is - * `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}", + * // The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. + * name: "projects/{MY-PROJECT}", * resource: {}, * // Auth client * auth: authClient * }; * - * monitoring.projects.metricDescriptors.create(request, function(err, - * result) { if (err) { console.log(err); } else { console.log(result); + * monitoring.projects.metricDescriptors.create(request, function(err, result) { + * if (err) { + * console.log(err); + * } else { + * console.log(result); * } * }); * }); @@ -3749,21 +2964,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.metricDescriptors.delete - * @desc Deletes a metric descriptor. Only user-created custom metrics can - * be deleted. + * @desc Deletes a metric descriptor. Only user-created custom metrics can be deleted. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -3773,28 +2982,27 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'delete' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'delete' method: * - * // The metric descriptor on which to execute the request. The format - * is - * // `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. - * An example of `{metric_id}` is: + * // The metric descriptor on which to execute the request. The format is + * // `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example of `{metric_id}` is: * // `"custom.googleapis.com/my_test_metric"`. * name: "", * // Auth client * auth: authClient * }; * - * monitoring.projects.metricDescriptors.delete(request, function(err, - * result) { if (err) { console.log(err); } else { console.log(result); + * monitoring.projects.metricDescriptors.delete(request, function(err, result) { + * if (err) { + * console.log(err); + * } else { + * console.log(result); * } * }); * }); @@ -3866,21 +3074,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.metricDescriptors.get - * @desc Gets a single metric descriptor. This method does not require a - * Stackdriver account. + * @desc Gets a single metric descriptor. This method does not require a Stackdriver account. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -3890,28 +3092,27 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'get' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'get' method: * - * // The metric descriptor on which to execute the request. The format - * is - * // `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. - * An example value of `{metric_id}` + * // The metric descriptor on which to execute the request. The format is + * // `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example value of `{metric_id}` * // is `"compute.googleapis.com/instance/disk/read_bytes_count"`. * name: "", * // Auth client * auth: authClient * }; * - * monitoring.projects.metricDescriptors.get(request, function(err, - * result) { if (err) { console.log(err); } else { console.log(result); + * monitoring.projects.metricDescriptors.get(request, function(err, result) { + * if (err) { + * console.log(err); + * } else { + * console.log(result); * } * }); * }); @@ -3985,21 +3186,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.metricDescriptors.list - * @desc Lists metric descriptors that match a filter. This method does not - * require a Stackdriver account. + * @desc Lists metric descriptors that match a filter. This method does not require a Stackdriver account. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -4009,18 +3204,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'list' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'list' method: * - * // The project on which to execute the request. The format is - * `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}", + * // The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. + * name: "projects/{MY-PROJECT}", * // Auth client * auth: authClient * }; @@ -4132,8 +3325,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". + * The project on which to execute the request. The format is "projects/{project_id_or_number}". */ name?: string; @@ -4150,9 +3342,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The metric descriptor on which to execute the request. The format is - * "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An - * example of {metric_id} is: "custom.googleapis.com/my_test_metric". + * The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric". */ name?: string; } @@ -4164,10 +3354,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The metric descriptor on which to execute the request. The format is - * "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An - * example value of {metric_id} is - * "compute.googleapis.com/instance/disk/read_bytes_count". + * The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count". */ name?: string; } @@ -4179,15 +3366,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If this field is empty, all custom and system-defined metric descriptors - * are returned. Otherwise, the filter specifies which metric descriptors - * are to be returned. For example, the following filter matches all custom - * metrics: metric.type = starts_with("custom.googleapis.com/") + * If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/") */ filter?: string; /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". + * The project on which to execute the request. The format is "projects/{project_id_or_number}". */ name?: string; /** @@ -4195,9 +3378,7 @@ export namespace monitoring_v3 { */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. */ pageToken?: string; } @@ -4210,21 +3391,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.monitoredResourceDescriptors.get - * @desc Gets a single monitored resource descriptor. This method does not - * require a Stackdriver account. + * @desc Gets a single monitored resource descriptor. This method does not require a Stackdriver account. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -4234,29 +3409,26 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'get' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'get' method: * * // The monitored resource descriptor to get. The format is - * // - * `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`. - * The - * // `{resource_type}` is a predefined type, such as - * `cloudsql_database`. name: - * "projects/{MY-PROJECT}/monitoredResourceDescriptors/{MY-MONITOREDRESOURCEDESCRIPTOR}", + * // `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`. The + * // `{resource_type}` is a predefined type, such as `cloudsql_database`. + * name: "projects/{MY-PROJECT}/monitoredResourceDescriptors/{MY-MONITOREDRESOURCEDESCRIPTOR}", * // Auth client * auth: authClient * }; * - * monitoring.projects.monitoredResourceDescriptors.get(request, - * function(err, result) { if (err) { console.log(err); } else { + * monitoring.projects.monitoredResourceDescriptors.get(request, function(err, result) { + * if (err) { + * console.log(err); + * } else { * console.log(result); * } * }); @@ -4338,21 +3510,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.monitoredResourceDescriptors.list - * @desc Lists monitored resource descriptors that match a filter. This - * method does not require a Stackdriver account. + * @desc Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -4362,18 +3528,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'list' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'list' method: * - * // The project on which to execute the request. The format is - * `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}", + * // The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. + * name: "projects/{MY-PROJECT}", * // Auth client * auth: authClient * }; @@ -4386,8 +3550,7 @@ export namespace monitoring_v3 { * console.log(result); * if (result.nextPageToken) { * request.pageToken = result.nextPageToken; - * monitoring.projects.monitoredResourceDescriptors.list(request, - * recur); + * monitoring.projects.monitoredResourceDescriptors.list(request, recur); * } * } * }; @@ -4494,9 +3657,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The monitored resource descriptor to get. The format is - * "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". - * The {resource_type} is a predefined type, such as cloudsql_database. + * The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. */ name?: string; } @@ -4508,15 +3669,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional filter describing the descriptors to be returned. The filter - * can reference the descriptor's type and labels. For example, the - * following filter returns only Google Compute Engine descriptors that have - * an id label: resource.type = starts_with("gce_") AND resource.label:id + * An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id */ filter?: string; /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". + * The project on which to execute the request. The format is "projects/{project_id_or_number}". */ name?: string; /** @@ -4524,9 +3681,7 @@ export namespace monitoring_v3 { */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. */ pageToken?: string; } @@ -4539,9 +3694,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannelDescriptors.get - * @desc Gets a single channel descriptor. The descriptor indicates which - * fields are expected / permitted for a notification channel of the given - * type. + * @desc Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type. * @alias monitoring.projects.notificationChannelDescriptors.get * @memberOf! () * @@ -4621,9 +3774,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannelDescriptors.list - * @desc Lists the descriptors for supported channel types. The use of - * descriptors makes it possible for new channel types to be dynamically - * added. + * @desc Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added. * @alias monitoring.projects.notificationChannelDescriptors.list * @memberOf! () * @@ -4728,8 +3879,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channel type for which to execute the request. The format is - * projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. + * The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. */ name?: string; } @@ -4741,22 +3891,15 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The REST resource name of the parent from which to retrieve the - * notification channel descriptors. The expected syntax is: - * projects/[PROJECT_ID] Note that this names the parent container in which - * to look for the descriptors; to retrieve a single descriptor by name, use - * the GetNotificationChannelDescriptor operation, instead. + * The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead. */ name?: string; /** - * The maximum number of results to return in a single response. If not set - * to a positive number, a reasonable value will be chosen by the service. + * The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. */ pageSize?: number; /** - * If non-empty, page_token must contain a value returned as the - * next_page_token in a previous response to request the next set of - * results. + * If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. */ pageToken?: string; } @@ -4769,9 +3912,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannels.create - * @desc Creates a new notification channel, representing a single - * notification endpoint such as an email address, SMS number, or PagerDuty - * service. + * @desc Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service. * @alias monitoring.projects.notificationChannels.create * @memberOf! () * @@ -4916,11 +4057,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannels.get - * @desc Gets a single notification channel. The channel includes the - * relevant configuration details with which the channel was created. - * However, the response may truncate or omit passwords, API keys, or other - * private key matter and thus the response may not be 100% identical to the - * information that was supplied in the call to the create method. + * @desc Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method. * @alias monitoring.projects.notificationChannels.get * @memberOf! () * @@ -4991,26 +4128,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannels.getVerificationCode - * @desc Requests a verification code for an already verified channel that - * can then be used in a call to VerifyNotificationChannel() on a different - * channel with an equivalent identity in the same or in a different - * project. This makes it possible to copy a channel between projects - * without requiring manual reverification of the channel. If the channel is - * not in the verified state, this method will fail (in other words, this - * may only be used if the SendNotificationChannelVerificationCode and - * VerifyNotificationChannel paths have already been used to put the given - * channel into the verified state).There is no guarantee that the - * verification codes returned by this method will be of a similar structure - * or form as the ones that are delivered to the channel via - * SendNotificationChannelVerificationCode; while - * VerifyNotificationChannel() will recognize both the codes delivered via - * SendNotificationChannelVerificationCode() and returned from - * GetNotificationChannelVerificationCode(), it is typically the case that - * the verification codes delivered via - * SendNotificationChannelVerificationCode() will be shorter and also have a - * shorter expiration (e.g. codes such as "G-123456") whereas - * GetVerificationCode() will typically return a much longer, websafe base - * 64 encoded string that has a longer expiration time. + * @desc Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time. * @alias monitoring.projects.notificationChannels.getVerificationCode * @memberOf! () * @@ -5110,8 +4228,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannels.list - * @desc Lists the notification channels that have been created for the - * project. + * @desc Lists the notification channels that have been created for the project. * @alias monitoring.projects.notificationChannels.list * @memberOf! () * @@ -5198,8 +4315,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannels.patch - * @desc Updates a notification channel. Fields not specified in the field - * mask remain unchanged. + * @desc Updates a notification channel. Fields not specified in the field mask remain unchanged. * @alias monitoring.projects.notificationChannels.patch * @memberOf! () * @@ -5272,8 +4388,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannels.sendVerificationCode - * @desc Causes a verification code to be delivered to the channel. The code - * can then be supplied in VerifyNotificationChannel to verify the channel. + * @desc Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel. * @alias monitoring.projects.notificationChannels.sendVerificationCode * @memberOf! () * @@ -5346,9 +4461,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.notificationChannels.verify - * @desc Verifies a NotificationChannel by proving receipt of the code - * delivered to the channel as a result of calling - * SendNotificationChannelVerificationCode. + * @desc Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode. * @alias monitoring.projects.notificationChannels.verify * @memberOf! () * @@ -5427,12 +4540,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project on which to execute the request. The format is: - * projects/[PROJECT_ID] Note that this names the container into which the - * channel will be written. This does not name the newly created channel. - * The resulting channel's name will have a normalized version of this field - * as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify - * the channel. + * The project on which to execute the request. The format is: projects/[PROJECT_ID] Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel. */ name?: string; @@ -5449,15 +4557,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If true, the notification channel will be deleted regardless of its use - * in alert policies (the policies will be updated to remove the channel). - * If false, channels that are still referenced by an existing alerting - * policy will fail to be deleted in a delete operation. + * If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation. */ force?: boolean; /** - * The channel for which to execute the request. The format is - * projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. + * The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. */ name?: string; } @@ -5469,8 +4573,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channel for which to execute the request. The format is - * projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. + * The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. */ name?: string; } @@ -5482,9 +4585,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The notification channel for which a verification code is to be generated - * and retrieved. This must name a channel that is already verified; if the - * specified channel is not verified, the request will fail. + * The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail. */ name?: string; @@ -5501,35 +4602,23 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If provided, this field specifies the criteria that must be met by - * notification channels to be included in the response.For more details, - * see sorting and filtering. + * If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering. */ filter?: string; /** - * The project on which to execute the request. The format is - * projects/[PROJECT_ID]. That is, this names the container in which to look - * for the notification channels; it does not name a specific channel. To - * query a specific channel by REST resource name, use the - * GetNotificationChannel operation. + * The project on which to execute the request. The format is projects/[PROJECT_ID]. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation. */ name?: string; /** - * A comma-separated list of fields by which to sort the result. Supports - * the same set of fields as in filter. Entries can be prefixed with a minus - * sign to sort in descending rather than ascending order.For more details, - * see sorting and filtering. + * A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering. */ orderBy?: string; /** - * The maximum number of results to return in a single response. If not set - * to a positive number, a reasonable value will be chosen by the service. + * The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. */ pageSize?: number; /** - * If non-empty, page_token must contain a value returned as the - * next_page_token in a previous response to request the next set of - * results. + * If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. */ pageToken?: string; } @@ -5541,9 +4630,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The full REST resource name for this channel. The syntax is: - * projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] - * is automatically assigned by the server on creation. + * The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string; /** @@ -5599,23 +4686,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.timeSeries.create - * @desc Creates or adds data to one or more time series. The response is - * empty if all time series in the request were written. If any time series - * could not be written, a corresponding failure message is included in the - * error response. + * @desc Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -5625,18 +4704,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'create' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'create' method: * - * // The project on which to execute the request. The format is - * `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}", + * // The project on which to execute the request. The format is `"projects/{project_id_or_number}"`. + * name: "projects/{MY-PROJECT}", * resource: {}, * // Auth client * auth: authClient @@ -5722,21 +4799,15 @@ export namespace monitoring_v3 { /** * monitoring.projects.timeSeries.list - * @desc Lists time series that match a filter. This method does not require - * a Stackdriver account. + * @desc Lists time series that match a filter. This method does not require a Stackdriver account. * @example * * // PRE-REQUISITES: * // --------------- - * // 1. If not already done, enable the Google Monitoring API and check the - * quota for your project at - * // - * https://console.developers.google.com/apis/api/monitoring_component/quotas - * // 2. This sample uses Application Default Credentials for Auth. If not - * already done, install the gcloud CLI from - * // https://cloud.google.com/sdk/ and run 'gcloud beta auth - * application-default login' - * // 3. To install the client library and Application Default Credentials - * library, run: + * // 1. If not already done, enable the Google Monitoring API and check the quota for your project at + * // https://console.developers.google.com/apis/api/monitoring_component/quotas + * // 2. This sample uses Application Default Credentials for Auth. If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk/ and run 'gcloud beta auth application-default login' + * // 3. To install the client library and Application Default Credentials library, run: * // 'npm install googleapis --save' * var google = require('googleapis'); * var monitoring = google.monitoring('v3'); @@ -5746,18 +4817,16 @@ export namespace monitoring_v3 { * console.log('Authentication failed because of ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * * var request = { - * // TODO: Change placeholders below to appropriate parameter values - * for the 'list' method: + * // TODO: Change placeholders below to appropriate parameter values for the 'list' method: * - * // The project on which to execute the request. The format is - * "projects/{project_id_or_number}". name: "projects/{MY-PROJECT}", + * // The project on which to execute the request. The format is "projects/{project_id_or_number}". + * name: "projects/{MY-PROJECT}", * // Auth client * auth: authClient * }; @@ -5870,8 +4939,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". + * The project on which to execute the request. The format is "projects/{project_id_or_number}". */ name?: string; @@ -5888,58 +4956,23 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The alignment period for per-time series alignment. If present, - * alignmentPeriod must be at least 60 seconds. After per-time series - * alignment, each time series will contain data points only on the period - * boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, - * then this field is ignored. If perSeriesAligner is specified and does not - * equal ALIGN_NONE, then this field must be defined; otherwise an error is - * returned. + * The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. */ 'aggregation.alignmentPeriod'?: string; /** - * The approach to be used to combine time series. Not all reducer functions - * may be applied to all time series, depending on the metric type and the - * value type of the original time series. Reduction may change the metric - * type of value type of the time series.Time series data must be aligned in - * order to perform cross-time series reduction. If crossSeriesReducer is - * specified, then perSeriesAligner must be specified and not equal - * ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is - * returned. + * The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. */ 'aggregation.crossSeriesReducer'?: string; /** - * The set of fields to preserve when crossSeriesReducer is specified. The - * groupByFields determine how the time series are partitioned into subsets - * prior to applying the aggregation function. Each subset contains time - * series that have the same value for each of the grouping fields. Each - * individual time series is a member of exactly one subset. The - * crossSeriesReducer is applied to each subset of time series. It is not - * possible to reduce across different resource types, so this field - * implicitly contains resource.type. Fields not specified in groupByFields - * are aggregated away. If groupByFields is not specified and all the time - * series have the same resource type, then the time series are aggregated - * into a single output time series. If crossSeriesReducer is not defined, - * this field is ignored. + * The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. */ 'aggregation.groupByFields'?: string[]; /** - * The approach to be used to align individual time series. Not all - * alignment functions may be applied to all time series, depending on the - * metric type and value type of the original time series. Alignment may - * change the metric type or the value type of the time series.Time series - * data must be aligned in order to perform cross-time series reduction. If - * crossSeriesReducer is specified, then perSeriesAligner must be specified - * and not equal ALIGN_NONE and alignmentPeriod must be specified; - * otherwise, an error is returned. + * The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. */ 'aggregation.perSeriesAligner'?: string; /** - * A monitoring filter that specifies which time series should be returned. - * The filter must specify a single metric type, and can additionally - * specify metric labels and other information. For example: metric.type = - * "compute.googleapis.com/instance/cpu/usage_time" AND - * metric.label.instance_name = "my-instance-name" + * A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name" */ filter?: string; /** @@ -5947,33 +4980,23 @@ export namespace monitoring_v3 { */ 'interval.endTime'?: string; /** - * Optional. The beginning of the time interval. The default value for the - * start time is the end time. The start time must not be later than the end - * time. + * Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */ 'interval.startTime'?: string; /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". + * The project on which to execute the request. The format is "projects/{project_id_or_number}". */ name?: string; /** - * Unsupported: must be left blank. The points in each time series are - * returned in reverse time order. + * Unsupported: must be left blank. The points in each time series are returned in reverse time order. */ orderBy?: string; /** - * A positive number that is the maximum number of results to return. If - * page_size is empty or more than 100,000 results, the effective page_size - * is 100,000 results. If view is set to FULL, this is the maximum number of - * Points returned. If view is set to HEADERS, this is the maximum number of - * TimeSeries returned. + * A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned. */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. */ pageToken?: string; /** @@ -6065,10 +5088,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.delete - * @desc Deletes an uptime check configuration. Note that this method will - * fail if the uptime check configuration is referenced by an alert policy - * or other dependent configs that would be rendered invalid by the - * deletion. + * @desc Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion. * @alias monitoring.projects.uptimeCheckConfigs.delete * @memberOf! () * @@ -6208,8 +5228,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.list - * @desc Lists the existing valid uptime check configurations for the - * project, leaving out any invalid configurations. + * @desc Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations. * @alias monitoring.projects.uptimeCheckConfigs.list * @memberOf! () * @@ -6294,10 +5313,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.uptimeCheckConfigs.patch - * @desc Updates an uptime check configuration. You can either replace the - * entire configuration with a new one or replace only certain fields in the - * current configuration by specifying the fields to be updated via - * "updateMask". Returns the updated configuration. + * @desc Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via "updateMask". Returns the updated configuration. * @alias monitoring.projects.uptimeCheckConfigs.patch * @memberOf! () * @@ -6377,8 +5393,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the uptime check. The format is - * projects/[PROJECT_ID]. + * The project in which to create the uptime check. The format is projects/[PROJECT_ID]. */ parent?: string; @@ -6395,8 +5410,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The uptime check configuration to delete. The format is - * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * The uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. */ name?: string; } @@ -6408,8 +5422,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The uptime check configuration to retrieve. The format is - * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * The uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. */ name?: string; } @@ -6421,21 +5434,15 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of results to return in a single response. The server - * may further constrain the maximum number of results returned in a single - * page. If the page_size is <=0, the server will decide the number of - * results to be returned. + * The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return more results from the previous method call. + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. */ pageToken?: string; /** - * The project whose uptime check configurations are listed. The format is - * projects/[PROJECT_ID]. + * The project whose uptime check configurations are listed. The format is projects/[PROJECT_ID]. */ parent?: string; } @@ -6447,18 +5454,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A unique resource name for this UptimeCheckConfig. The format - * is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field - * should be omitted when creating the uptime check configuration; on - * create, the resource name is assigned by the server and included in the - * response. + * A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. */ name?: string; /** - * Optional. If present, only the listed fields in the current uptime check - * configuration are updated with values from the new configuration. If this - * field is empty, then the current configuration is completely replaced - * with the new configuration. + * Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. */ updateMask?: string; @@ -6562,17 +5562,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of results to return in a single response. The server - * may further constrain the maximum number of results returned in a single - * page. If the page_size is <=0, the server will decide the number of - * results to be returned. NOTE: this field is not yet implemented + * The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return more results from the previous method call. NOTE: this - * field is not yet implemented + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented */ pageToken?: string; } diff --git a/src/apis/oauth2/package.json b/src/apis/oauth2/package.json index d5beba6d736..7751712d3dd 100644 --- a/src/apis/oauth2/package.json +++ b/src/apis/oauth2/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/oauth2/v1.ts b/src/apis/oauth2/v1.ts index a734a4e513e..0c61964dea5 100644 --- a/src/apis/oauth2/v1.ts +++ b/src/apis/oauth2/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace oauth2_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace oauth2_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace oauth2_v1 { userinfo: Resource$Userinfo; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.userinfo = new Resource$Userinfo(this.context); } @@ -181,18 +181,15 @@ export namespace oauth2_v1 { */ access_type?: string; /** - * Who is the intended audience for this token. In general the same as - * issued_to. + * Who is the intended audience for this token. In general the same as issued_to. */ audience?: string; /** - * The email address of the user. Present only if the email scope is present - * in the request. + * The email address of the user. Present only if the email scope is present in the request. */ email?: string; /** - * Boolean flag which is true if the email address is verified. Present only - * if the email scope is present in the request. + * Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request. */ email_verified?: boolean; /** @@ -224,8 +221,7 @@ export namespace oauth2_v1 { */ user_id?: string; /** - * Boolean flag which is true if the email address is verified. Present only - * if the email scope is present in the request. + * Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request. */ verified_email?: boolean; } @@ -271,8 +267,7 @@ export namespace oauth2_v1 { */ picture?: string; /** - * Boolean flag which is true if the email address is verified. Always - * verified because we only return the user's primary email address. + * Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address. */ verified_email?: boolean; } diff --git a/src/apis/oauth2/v2.ts b/src/apis/oauth2/v2.ts index e651b156d39..21e005aa671 100644 --- a/src/apis/oauth2/v2.ts +++ b/src/apis/oauth2/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace oauth2_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace oauth2_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace oauth2_v2 { userinfo: Resource$Userinfo; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.userinfo = new Resource$Userinfo(this.context); } @@ -257,13 +257,11 @@ export namespace oauth2_v2 { */ access_type?: string; /** - * Who is the intended audience for this token. In general the same as - * issued_to. + * Who is the intended audience for this token. In general the same as issued_to. */ audience?: string; /** - * The email address of the user. Present only if the email scope is present - * in the request. + * The email address of the user. Present only if the email scope is present in the request. */ email?: string; /** @@ -287,8 +285,7 @@ export namespace oauth2_v2 { */ user_id?: string; /** - * Boolean flag which is true if the email address is verified. Present only - * if the email scope is present in the request. + * Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request. */ verified_email?: boolean; } @@ -334,8 +331,7 @@ export namespace oauth2_v2 { */ picture?: string; /** - * Boolean flag which is true if the email address is verified. Always - * verified because we only return the user's primary email address. + * Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address. */ verified_email?: boolean; } diff --git a/src/apis/oslogin/package.json b/src/apis/oslogin/package.json index 8f7565f92aa..7dacafb3e41 100644 --- a/src/apis/oslogin/package.json +++ b/src/apis/oslogin/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index 75c654462c5..e74f171bec1 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace oslogin_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace oslogin_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +91,7 @@ export namespace oslogin_v1 { /** * Cloud OS Login API * - * Manages OS login configuration for Google account users. + * You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). * * @example * const {google} = require('googleapis'); @@ -112,18 +108,17 @@ export namespace oslogin_v1 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.users = new Resource$Users(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -136,8 +131,7 @@ export namespace oslogin_v1 { loginProfile?: Schema$LoginProfile; } /** - * The user profile information used for logging in to a virtual machine on - * Google Compute Engine. + * The user profile information used for logging in to a virtual machine on Google Compute Engine. */ export interface Schema$LoginProfile { /** @@ -186,8 +180,7 @@ export namespace oslogin_v1 { */ shell?: string; /** - * System identifier for which account the username or uid applies to. By - * default, the empty value is used. + * System identifier for which account the username or uid applies to. By default, the empty value is used. */ systemId?: string; /** @@ -212,9 +205,7 @@ export namespace oslogin_v1 { */ fingerprint?: string; /** - * Public key text in SSH format, defined by <a - * href="https://www.ietf.org/rfc/rfc4253.txt" - * target="_blank">RFC4253</a> section 6.6. + * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ key?: string; } @@ -231,8 +222,7 @@ export namespace oslogin_v1 { /** * oslogin.users.getLoginProfile - * @desc Retrieves the profile information used for logging in to a virtual - * machine on Google Compute Engine. + * @desc Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine. * @alias oslogin.users.getLoginProfile * @memberOf! () * @@ -308,9 +298,7 @@ export namespace oslogin_v1 { /** * oslogin.users.importSshPublicKey - * @desc Adds an SSH public key and returns the profile information. Default - * POSIX account information is set when no username and UID exist as part - * of the login profile. + * @desc Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile. * @alias oslogin.users.importSshPublicKey * @memberOf! () * @@ -518,9 +506,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A reference to the POSIX account to update. POSIX accounts are identified - * by the project ID they are associated with. A reference to the POSIX - * account is in format `users/{user}/projects/{project}`. + * A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. */ name?: string; } @@ -673,8 +659,7 @@ export namespace oslogin_v1 { /** * oslogin.users.sshPublicKeys.patch - * @desc Updates an SSH public key and returns the profile information. This - * method supports patch semantics. + * @desc Updates an SSH public key and returns the profile information. This method supports patch semantics. * @alias oslogin.users.sshPublicKeys.patch * @memberOf! () * @@ -754,9 +739,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -768,9 +751,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to retrieve. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -782,9 +763,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; /** diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index 19522701a50..4d06655b521 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace oslogin_v1alpha { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace oslogin_v1alpha { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +91,7 @@ export namespace oslogin_v1alpha { /** * Cloud OS Login API * - * Manages OS login configuration for Google account users. + * You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). * * @example * const {google} = require('googleapis'); @@ -112,18 +108,17 @@ export namespace oslogin_v1alpha { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.users = new Resource$Users(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -136,8 +131,7 @@ export namespace oslogin_v1alpha { loginProfile?: Schema$LoginProfile; } /** - * The user profile information used for logging in to a virtual machine on - * Google Compute Engine. + * The user profile information used for logging in to a virtual machine on Google Compute Engine. */ export interface Schema$LoginProfile { /** @@ -186,8 +180,7 @@ export namespace oslogin_v1alpha { */ shell?: string; /** - * System identifier for which account the username or uid applies to. By - * default, the empty value is used. + * System identifier for which account the username or uid applies to. By default, the empty value is used. */ systemId?: string; /** @@ -212,9 +205,7 @@ export namespace oslogin_v1alpha { */ fingerprint?: string; /** - * Public key text in SSH format, defined by <a - * href="https://www.ietf.org/rfc/rfc4253.txt" - * target="_blank">RFC4253</a> section 6.6. + * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ key?: string; } @@ -231,8 +222,7 @@ export namespace oslogin_v1alpha { /** * oslogin.users.getLoginProfile - * @desc Retrieves the profile information used for logging in to a virtual - * machine on Google Compute Engine. + * @desc Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine. * @alias oslogin.users.getLoginProfile * @memberOf! () * @@ -309,9 +299,7 @@ export namespace oslogin_v1alpha { /** * oslogin.users.importSshPublicKey - * @desc Adds an SSH public key and returns the profile information. Default - * POSIX account information is set when no username and UID exist as part - * of the login profile. + * @desc Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile. * @alias oslogin.users.importSshPublicKey * @memberOf! () * @@ -524,9 +512,7 @@ export namespace oslogin_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A reference to the POSIX account to update. POSIX accounts are identified - * by the project ID they are associated with. A reference to the POSIX - * account is in format `users/{user}/projects/{project}`. + * A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. */ name?: string; /** @@ -683,8 +669,7 @@ export namespace oslogin_v1alpha { /** * oslogin.users.sshPublicKeys.patch - * @desc Updates an SSH public key and returns the profile information. This - * method supports patch semantics. + * @desc Updates an SSH public key and returns the profile information. This method supports patch semantics. * @alias oslogin.users.sshPublicKeys.patch * @memberOf! () * @@ -764,9 +749,7 @@ export namespace oslogin_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -778,9 +761,7 @@ export namespace oslogin_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to retrieve. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -792,9 +773,7 @@ export namespace oslogin_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; /** diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index cb9d6ada330..28cd84ef2c7 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace oslogin_v1beta { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace oslogin_v1beta { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +91,7 @@ export namespace oslogin_v1beta { /** * Cloud OS Login API * - * Manages OS login configuration for Google account users. + * You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). * * @example * const {google} = require('googleapis'); @@ -112,18 +108,17 @@ export namespace oslogin_v1beta { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.users = new Resource$Users(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -136,8 +131,7 @@ export namespace oslogin_v1beta { loginProfile?: Schema$LoginProfile; } /** - * The user profile information used for logging in to a virtual machine on - * Google Compute Engine. + * The user profile information used for logging in to a virtual machine on Google Compute Engine. */ export interface Schema$LoginProfile { /** @@ -186,8 +180,7 @@ export namespace oslogin_v1beta { */ shell?: string; /** - * System identifier for which account the username or uid applies to. By - * default, the empty value is used. + * System identifier for which account the username or uid applies to. By default, the empty value is used. */ systemId?: string; /** @@ -212,9 +205,7 @@ export namespace oslogin_v1beta { */ fingerprint?: string; /** - * Public key text in SSH format, defined by <a - * href="https://www.ietf.org/rfc/rfc4253.txt" - * target="_blank">RFC4253</a> section 6.6. + * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ key?: string; } @@ -231,8 +222,7 @@ export namespace oslogin_v1beta { /** * oslogin.users.getLoginProfile - * @desc Retrieves the profile information used for logging in to a virtual - * machine on Google Compute Engine. + * @desc Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine. * @alias oslogin.users.getLoginProfile * @memberOf! () * @@ -308,9 +298,7 @@ export namespace oslogin_v1beta { /** * oslogin.users.importSshPublicKey - * @desc Adds an SSH public key and returns the profile information. Default - * POSIX account information is set when no username and UID exist as part - * of the login profile. + * @desc Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile. * @alias oslogin.users.importSshPublicKey * @memberOf! () * @@ -518,9 +506,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A reference to the POSIX account to update. POSIX accounts are identified - * by the project ID they are associated with. A reference to the POSIX - * account is in format `users/{user}/projects/{project}`. + * A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. */ name?: string; } @@ -673,8 +659,7 @@ export namespace oslogin_v1beta { /** * oslogin.users.sshPublicKeys.patch - * @desc Updates an SSH public key and returns the profile information. This - * method supports patch semantics. + * @desc Updates an SSH public key and returns the profile information. This method supports patch semantics. * @alias oslogin.users.sshPublicKeys.patch * @memberOf! () * @@ -754,9 +739,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -768,9 +751,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to retrieve. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -782,9 +763,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified - * by their SHA-256 fingerprint. The fingerprint of the public key is in - * format `users/{user}/sshPublicKeys/{fingerprint}`. + * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; /** diff --git a/src/apis/pagespeedonline/package.json b/src/apis/pagespeedonline/package.json index 82f43edfe08..c617d20937e 100644 --- a/src/apis/pagespeedonline/package.json +++ b/src/apis/pagespeedonline/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/pagespeedonline/v1.ts b/src/apis/pagespeedonline/v1.ts index 03a3703541c..090cf2fb4b3 100644 --- a/src/apis/pagespeedonline/v1.ts +++ b/src/apis/pagespeedonline/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace pagespeedonline_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace pagespeedonline_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace pagespeedonline_v1 { /** * PageSpeed Insights API * - * Analyzes the performance of a web page and provides tailored suggestions to - * make that page faster. + * Analyzes the performance of a web page and provides tailored suggestions to make that page faster. * * @example * const {google} = require('googleapis'); @@ -96,7 +92,10 @@ export namespace pagespeedonline_v1 { pagespeedapi: Resource$Pagespeedapi; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.pagespeedapi = new Resource$Pagespeedapi(this.context); } @@ -108,8 +107,7 @@ export namespace pagespeedonline_v1 { */ captchaResult?: string; /** - * Localized PageSpeed results. Contains a ruleResults entry for each - * PageSpeed rule instantiated and run by the server. + * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. */ formattedResults?: { locale?: string; @@ -137,13 +135,11 @@ export namespace pagespeedonline_v1 { }; }; /** - * Canonicalized and final URL for the document, after following page - * redirects (if any). + * Canonicalized and final URL for the document, after following page redirects (if any). */ id?: string; /** - * List of rules that were specified in the request, but which the server - * did not know how to instantiate. + * List of rules that were specified in the request, but which the server did not know how to instantiate. */ invalidRules?: string[]; /** @@ -151,8 +147,7 @@ export namespace pagespeedonline_v1 { */ kind?: string; /** - * Summary statistics for the page, such as number of JavaScript bytes, - * number of HTML bytes, etc. + * Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. */ pageStats?: { cssResponseBytes?: string; @@ -170,14 +165,11 @@ export namespace pagespeedonline_v1 { totalRequestBytes?: string; }; /** - * Response code for the document. 200 indicates a normal page load. 4xx/5xx - * indicates an error. + * Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. */ responseCode?: number; /** - * The PageSpeed Score (0-100), which indicates how much faster a page could - * be. A high score indicates little room for improvement, while a lower - * score indicates more room for improvement. + * The PageSpeed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement. */ score?: number; /** @@ -207,9 +199,7 @@ export namespace pagespeedonline_v1 { /** * pagespeedonline.pagespeedapi.runpagespeed - * @desc Runs PageSpeed analysis on the page at the specified URL, and - * returns a PageSpeed score, a list of suggestions to make that page - * faster, and other information. + * @desc Runs PageSpeed analysis on the page at the specified URL, and returns a PageSpeed score, a list of suggestions to make that page faster, and other information. * @alias pagespeedonline.pagespeedapi.runpagespeed * @memberOf! () * @@ -293,8 +283,7 @@ export namespace pagespeedonline_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Indicates if third party resources should be filtered out before - * PageSpeed analysis. + * Indicates if third party resources should be filtered out before PageSpeed analysis. */ filter_third_party_resources?: boolean; /** diff --git a/src/apis/pagespeedonline/v2.ts b/src/apis/pagespeedonline/v2.ts index c4aeae51cf7..27d44589517 100644 --- a/src/apis/pagespeedonline/v2.ts +++ b/src/apis/pagespeedonline/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace pagespeedonline_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace pagespeedonline_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace pagespeedonline_v2 { /** * PageSpeed Insights API * - * Analyzes the performance of a web page and provides tailored suggestions to - * make that page faster. + * Analyzes the performance of a web page and provides tailored suggestions to make that page faster. * * @example * const {google} = require('googleapis'); @@ -96,7 +92,10 @@ export namespace pagespeedonline_v2 { pagespeedapi: Resource$Pagespeedapi; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.pagespeedapi = new Resource$Pagespeedapi(this.context); } @@ -124,10 +123,7 @@ export namespace pagespeedonline_v2 { value?: string; }>; /** - * A localized format string with {{FOO}} placeholders, where 'FOO' - * is the key of the argument whose value should be substituted. For - * HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} - * and {{END_FOO}} for the argument with key 'FOO'. + * A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'. */ format?: string; } @@ -149,8 +145,7 @@ export namespace pagespeedonline_v2 { */ mime_type?: string; /** - * The region of the page that is captured by this image, with dimensions - * measured in CSS pixels. + * The region of the page that is captured by this image, with dimensions measured in CSS pixels. */ page_rect?: {height?: number; left?: number; top?: number; width?: number}; /** @@ -164,8 +159,7 @@ export namespace pagespeedonline_v2 { */ captchaResult?: string; /** - * Localized PageSpeed results. Contains a ruleResults entry for each - * PageSpeed rule instantiated and run by the server. + * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. */ formattedResults?: { locale?: string; @@ -186,13 +180,11 @@ export namespace pagespeedonline_v2 { }; }; /** - * Canonicalized and final URL for the document, after following page - * redirects (if any). + * Canonicalized and final URL for the document, after following page redirects (if any). */ id?: string; /** - * List of rules that were specified in the request, but which the server - * did not know how to instantiate. + * List of rules that were specified in the request, but which the server did not know how to instantiate. */ invalidRules?: string[]; /** @@ -200,8 +192,7 @@ export namespace pagespeedonline_v2 { */ kind?: string; /** - * Summary statistics for the page, such as number of JavaScript bytes, - * number of HTML bytes, etc. + * Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. */ pageStats?: { cssResponseBytes?: string; @@ -219,8 +210,7 @@ export namespace pagespeedonline_v2 { totalRequestBytes?: string; }; /** - * Response code for the document. 200 indicates a normal page load. 4xx/5xx - * indicates an error. + * Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. */ responseCode?: number; /** @@ -249,9 +239,7 @@ export namespace pagespeedonline_v2 { /** * pagespeedonline.pagespeedapi.runpagespeed - * @desc Runs PageSpeed analysis on the page at the specified URL, and - * returns PageSpeed scores, a list of suggestions to make that page faster, - * and other information. + * @desc Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information. * @alias pagespeedonline.pagespeedapi.runpagespeed * @memberOf! () * @@ -335,8 +323,7 @@ export namespace pagespeedonline_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Indicates if third party resources should be filtered out before - * PageSpeed analysis. + * Indicates if third party resources should be filtered out before PageSpeed analysis. */ filter_third_party_resources?: boolean; /** diff --git a/src/apis/pagespeedonline/v4.ts b/src/apis/pagespeedonline/v4.ts index a65ae3a4092..c0df45dc8ac 100644 --- a/src/apis/pagespeedonline/v4.ts +++ b/src/apis/pagespeedonline/v4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace pagespeedonline_v4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace pagespeedonline_v4 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace pagespeedonline_v4 { /** * PageSpeed Insights API * - * Analyzes the performance of a web page and provides tailored suggestions to - * make that page faster. + * Analyzes the performance of a web page and provides tailored suggestions to make that page faster. * * @example * const {google} = require('googleapis'); @@ -96,7 +92,10 @@ export namespace pagespeedonline_v4 { pagespeedapi: Resource$Pagespeedapi; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.pagespeedapi = new Resource$Pagespeedapi(this.context); } @@ -124,10 +123,7 @@ export namespace pagespeedonline_v4 { value?: string; }>; /** - * A localized format string with {{FOO}} placeholders, where 'FOO' - * is the key of the argument whose value should be substituted. For - * HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} - * and {{END_FOO}} for the argument with key 'FOO'. + * A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'. */ format?: string; } @@ -160,8 +156,7 @@ export namespace pagespeedonline_v4 { */ captchaResult?: string; /** - * Localized PageSpeed results. Contains a ruleResults entry for each - * PageSpeed rule instantiated and run by the server. + * Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. */ formattedResults?: { locale?: string; @@ -183,13 +178,11 @@ export namespace pagespeedonline_v4 { }; }; /** - * Canonicalized and final URL for the document, after following page - * redirects (if any). + * Canonicalized and final URL for the document, after following page redirects (if any). */ id?: string; /** - * List of rules that were specified in the request, but which the server - * did not know how to instantiate. + * List of rules that were specified in the request, but which the server did not know how to instantiate. */ invalidRules?: string[]; /** @@ -216,8 +209,7 @@ export namespace pagespeedonline_v4 { overall_category?: string; }; /** - * Summary statistics for the page, such as number of JavaScript bytes, - * number of HTML bytes, etc. + * Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. */ pageStats?: { cms?: string; @@ -243,8 +235,7 @@ export namespace pagespeedonline_v4 { transientFetchFailureUrls?: string[]; }; /** - * Response code for the document. 200 indicates a normal page load. 4xx/5xx - * indicates an error. + * Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. */ responseCode?: number; /** @@ -256,8 +247,7 @@ export namespace pagespeedonline_v4 { */ screenshot?: Schema$PagespeedApiImageV4; /** - * Additional base64-encoded screenshots of the page, in various partial - * render states. + * Additional base64-encoded screenshots of the page, in various partial render states. */ snapshots?: Schema$PagespeedApiImageV4[]; /** @@ -278,9 +268,7 @@ export namespace pagespeedonline_v4 { /** * pagespeedonline.pagespeedapi.runpagespeed - * @desc Runs PageSpeed analysis on the page at the specified URL, and - * returns PageSpeed scores, a list of suggestions to make that page faster, - * and other information. + * @desc Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information. * @alias pagespeedonline.pagespeedapi.runpagespeed * @memberOf! () * @@ -378,8 +366,7 @@ export namespace pagespeedonline_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Indicates if third party resources should be filtered out before - * PageSpeed analysis. + * Indicates if third party resources should be filtered out before PageSpeed analysis. */ filter_third_party_resources?: boolean; /** @@ -399,8 +386,7 @@ export namespace pagespeedonline_v4 { */ snapshots?: boolean; /** - * The analysis strategy (desktop or mobile) to use, and desktop is the - * default + * The analysis strategy (desktop or mobile) to use, and desktop is the default */ strategy?: string; /** diff --git a/src/apis/pagespeedonline/v5.ts b/src/apis/pagespeedonline/v5.ts index ab6456d9fb4..6bb51695d47 100644 --- a/src/apis/pagespeedonline/v5.ts +++ b/src/apis/pagespeedonline/v5.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace pagespeedonline_v5 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace pagespeedonline_v5 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace pagespeedonline_v5 { /** * PageSpeed Insights API * - * Analyzes the performance of a web page and provides tailored suggestions to - * make that page faster. + * Analyzes the performance of a web page and provides tailored suggestions to make that page faster. * * @example * const {google} = require('googleapis'); @@ -96,7 +92,10 @@ export namespace pagespeedonline_v5 { pagespeedapi: Resource$Pagespeedapi; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.pagespeedapi = new Resource$Pagespeedapi(this.context); } @@ -237,14 +236,22 @@ export namespace pagespeedonline_v5 { */ requestedUrl?: string; /** - * A top-level error message that, if present, indicates a serious enough - * problem that this Lighthouse result may need to be discarded. + * A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded. */ runtimeError?: {code?: string; message?: string}; /** * List of all run warnings in the LHR. Will always output to at least `[]`. */ runWarnings?: any[]; + /** + * The Stack Pack advice strings. + */ + stackPacks?: Array<{ + descriptions?: {[key: string]: string}; + iconDataURL?: string; + id?: string; + title?: string; + }>; /** * Timing information for this LHR. */ @@ -283,8 +290,7 @@ export namespace pagespeedonline_v5 { */ captchaResult?: string; /** - * Canonicalized and final URL for the document, after following page - * redirects (if any). + * Canonicalized and final URL for the document, after following page redirects (if any). */ id?: string; /** @@ -317,9 +323,7 @@ export namespace pagespeedonline_v5 { /** * pagespeedonline.pagespeedapi.runpagespeed - * @desc Runs PageSpeed analysis on the page at the specified URL, and - * returns PageSpeed scores, a list of suggestions to make that page faster, - * and other information. + * @desc Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information. * @alias pagespeedonline.pagespeedapi.runpagespeed * @memberOf! () * @@ -414,8 +418,7 @@ export namespace pagespeedonline_v5 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A Lighthouse category to run; if none are given, only Performance - * category will be run + * A Lighthouse category to run; if none are given, only Performance category will be run */ category?: string[]; /** @@ -423,8 +426,7 @@ export namespace pagespeedonline_v5 { */ locale?: string; /** - * The analysis strategy (desktop or mobile) to use, and desktop is the - * default + * The analysis strategy (desktop or mobile) to use, and desktop is the default */ strategy?: string; /** diff --git a/src/apis/people/package.json b/src/apis/people/package.json index ae220dd2910..40c30baccc3 100644 --- a/src/apis/people/package.json +++ b/src/apis/people/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index 4881b7a09e9..19980cb5ed1 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace people_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace people_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace people_v1 { people: Resource$People; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.contactGroups = new Resource$Contactgroups(this.context); this.people = new Resource$People(this.context); @@ -121,8 +120,7 @@ export namespace people_v1 { } /** - * A person's physical address. May be a P.O. box or street address. All - * fields are optional. + * A person's physical address. May be a P.O. box or street address. All fields are optional. */ export interface Schema$Address { /** @@ -134,8 +132,7 @@ export namespace people_v1 { */ country?: string; /** - * The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) - * country code of the address. + * The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address. */ countryCode?: string; /** @@ -143,13 +140,11 @@ export namespace people_v1 { */ extendedAddress?: string; /** - * The read-only type of the address translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** - * The unstructured value of the address. If this is not set by the user it - * will be automatically constructed from structured values. + * The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values. */ formattedValue?: string; /** @@ -173,8 +168,7 @@ export namespace people_v1 { */ streetAddress?: string; /** - * The type of the address. The type can be custom or one of these - * predefined values: * `home` * `work` * `other` + * The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other` */ type?: string; } @@ -218,9 +212,7 @@ export namespace people_v1 { value?: string; } /** - * A person's birthday. At least one of the `date` and `text` fields are - * specified. The `date` and `text` fields typically represent the same date, - * but are not guaranteed to. + * A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to. */ export interface Schema$Birthday { /** @@ -254,14 +246,11 @@ export namespace people_v1 { */ export interface Schema$ContactGroup { /** - * The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the - * resource. Used for web cache validation. + * The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation. */ etag?: string; /** - * The read-only name translated and formatted in the viewer's account - * locale or the `Accept-Language` HTTP header locale for system groups - * names. Group names set by the owner are the same as name. + * The read-only name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name. */ formattedName?: string; /** @@ -269,15 +258,11 @@ export namespace people_v1 { */ groupType?: string; /** - * The total number of contacts in the group irrespective of max members in - * specified in the request. + * The total number of contacts in the group irrespective of max members in specified in the request. */ memberCount?: number; /** - * The list of contact person resource names that are members of the contact - * group. The field is not populated for LIST requests and can only be - * updated through the - * [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify). + * The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify). */ memberResourceNames?: string[]; /** @@ -285,14 +270,11 @@ export namespace people_v1 { */ metadata?: Schema$ContactGroupMetadata; /** - * The contact group name set by the group owner or a system provided name - * for system groups. + * The contact group name set by the group owner or a system provided name for system groups. */ name?: string; /** - * The resource name for the contact group, assigned by the server. An ASCII - * string, in the form of - * `contactGroups/`<var>contact_group_id</var>. + * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>. */ resourceName?: string; } @@ -305,14 +287,7 @@ export namespace people_v1 { */ contactGroupId?: string; /** - * The resource name for the contact group, assigned by the server. An ASCII - * string, in the form of - * `contactGroups/`<var>contact_group_id</var>. Only - * contact_group_resource_name can be used for modifying memberships. Any - * contact group membership can be removed, but only user group or - * "myContacts" or "starred" system groups memberships - * can be added. A contact must always have at least one contact group - * membership. + * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership. */ contactGroupResourceName?: string; } @@ -321,9 +296,7 @@ export namespace people_v1 { */ export interface Schema$ContactGroupMetadata { /** - * True if the contact group resource has been deleted. Populated only for - * [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests - * that include a sync token. + * True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token. */ deleted?: boolean; /** @@ -349,14 +322,11 @@ export namespace people_v1 { status?: Schema$Status; } /** - * A person's read-only cover photo. A large image shown on the - * person's profile page that represents who they are or what they care - * about. + * A person's read-only cover photo. A large image shown on the person's profile page that represents who they are or what they care about. */ export interface Schema$CoverPhoto { /** - * True if the cover photo is the default cover photo; false if the cover - * photo is a user-provided cover photo. + * True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo. */ default?: boolean; /** @@ -378,29 +348,19 @@ export namespace people_v1 { contactGroup?: Schema$ContactGroup; } /** - * Represents a whole calendar date, for example a date of birth. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the [Proleptic Gregorian - * Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The - * day may be 0 to represent a year and month where the day is not - * significant. The year may be 0 to represent a month and day independent of - * year; for example, anniversary date. + * Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. */ export interface Schema$Date { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } @@ -422,8 +382,7 @@ export namespace people_v1 { */ displayName?: string; /** - * The read-only type of the email address translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** @@ -431,8 +390,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The type of the email address. The type can be custom or one of these - * predefined values: * `home` * `work` * `other` + * The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other` */ type?: string; /** @@ -441,11 +399,7 @@ export namespace people_v1 { value?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -457,8 +411,7 @@ export namespace people_v1 { */ date?: Schema$Date; /** - * The read-only type of the event translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** @@ -466,8 +419,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The type of the event. The type can be custom or one of these predefined - * values: * `anniversary` * `other` + * The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other` */ type?: string; } @@ -476,8 +428,7 @@ export namespace people_v1 { */ export interface Schema$FieldMetadata { /** - * True if the field is the primary field; false if the field is a secondary - * field. + * True if the field is the primary field; false if the field is a secondary field. */ primary?: boolean; /** @@ -485,9 +436,7 @@ export namespace people_v1 { */ source?: Schema$Source; /** - * True if the field is verified; false if the field is unverified. A - * verified field is typically a name, email address, phone number, or - * website that has been confirmed to be owned by the person. + * True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person. */ verified?: boolean; } @@ -496,8 +445,7 @@ export namespace people_v1 { */ export interface Schema$Gender { /** - * The read-only value of the gender translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedValue?: string; /** @@ -505,8 +453,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The gender for the person. The gender can be custom or one of these - * predefined values: * `male` * `female` * `other` * `unknown` + * The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `other` * `unknown` */ value?: string; } @@ -521,13 +468,11 @@ export namespace people_v1 { */ export interface Schema$ImClient { /** - * The read-only protocol of the IM client formatted in the viewer's - * account locale or the `Accept-Language` HTTP header locale. + * The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedProtocol?: string; /** - * The read-only type of the IM client translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** @@ -535,14 +480,11 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The protocol of the IM client. The protocol can be custom or one of these - * predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * - * `googleTalk` * `icq` * `jabber` * `netMeeting` + * The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting` */ protocol?: string; /** - * The type of the IM client. The type can be custom or one of these - * predefined values: * `home` * `work` * `other` + * The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other` */ type?: string; /** @@ -581,8 +523,7 @@ export namespace people_v1 { */ totalItems?: number; /** - * **DEPRECATED** (Please use totalItems) The total number of people in the - * list without pagination. + * **DEPRECATED** (Please use totalItems) The total number of people in the list without pagination. */ totalPeople?: number; } @@ -591,8 +532,7 @@ export namespace people_v1 { */ export interface Schema$ListContactGroupsResponse { /** - * The list of contact groups. Members of the contact groups are not - * populated. + * The list of contact groups. Members of the contact groups are not populated. */ contactGroups?: Schema$ContactGroup[]; /** @@ -617,14 +557,12 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language - * tag representing the locale. + * The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale. */ value?: string; } /** - * A person's membership in a group. Only contact group memberships can be - * modified. + * A person's membership in a group. Only contact group memberships can be modified. */ export interface Schema$Membership { /** @@ -641,19 +579,15 @@ export namespace people_v1 { metadata?: Schema$FieldMetadata; } /** - * A request to modify an existing contact group's members. Contacts can - * be removed from any group but they can only be added to a user group or - * "myContacts" or "starred" system groups. + * A request to modify an existing contact group's members. Contacts can be removed from any group but they can only be added to a user group or "myContacts" or "starred" system groups. */ export interface Schema$ModifyContactGroupMembersRequest { /** - * The resource names of the contact people to add in the form of in the - * form `people/`<var>person_id</var>. + * The resource names of the contact people to add in the form of in the form `people/`<var>person_id</var>. */ resourceNamesToAdd?: string[]; /** - * The resource names of the contact people to remove in the form of in the - * form of `people/`<var>person_id</var>. + * The resource names of the contact people to remove in the form of in the form of `people/`<var>person_id</var>. */ resourceNamesToRemove?: string[]; } @@ -671,14 +605,11 @@ export namespace people_v1 { */ export interface Schema$Name { /** - * The read-only display name formatted according to the locale specified by - * the viewer's account or the `Accept-Language` HTTP header. + * The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. */ displayName?: string; /** - * The read-only display name with the last name first formatted according - * to the locale specified by the viewer's account or the - * `Accept-Language` HTTP header. + * The read-only display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. */ displayNameLastFirst?: string; /** @@ -761,13 +692,11 @@ export namespace people_v1 { value?: string; } /** - * A person's past or current organization. Overlapping date ranges are - * permitted. + * A person's past or current organization. Overlapping date ranges are permitted. */ export interface Schema$Organization { /** - * True if the organization is the person's current organization; false - * if the organization is a past organization. + * True if the organization is the person's current organization; false if the organization is a past organization. */ current?: boolean; /** @@ -775,8 +704,7 @@ export namespace people_v1 { */ department?: string; /** - * The domain name associated with the organization; for example, - * `google.com`. + * The domain name associated with the organization; for example, `google.com`. */ domain?: string; /** @@ -784,8 +712,7 @@ export namespace people_v1 { */ endDate?: Schema$Date; /** - * The read-only type of the organization translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** @@ -813,8 +740,7 @@ export namespace people_v1 { */ startDate?: Schema$Date; /** - * The symbol associated with the organization; for example, a stock ticker - * symbol, abbreviation, or acronym. + * The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym. */ symbol?: string; /** @@ -822,17 +748,12 @@ export namespace people_v1 { */ title?: string; /** - * The type of the organization. The type can be custom or one of these - * predefined values: * `work` * `school` + * The type of the organization. The type can be custom or one of these predefined values: * `work` * `school` */ type?: string; } /** - * Information about a person merged from various data sources such as the - * authenticated user's contacts and profile data. Most fields can have - * multiple items. The items in a field have no guaranteed order, but each - * non-empty field is guaranteed to have exactly one field with - * `metadata.primary` set to true. + * Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. */ export interface Schema$Person { /** @@ -840,8 +761,7 @@ export namespace people_v1 { */ addresses?: Schema$Address[]; /** - * **DEPRECATED** (Please use `person.ageRanges` instead)** The - * person's read-only age range. + * **DEPRECATED** (Please use `person.ageRanges` instead)** The person's read-only age range. */ ageRange?: string; /** @@ -869,8 +789,7 @@ export namespace people_v1 { */ emailAddresses?: Schema$EmailAddress[]; /** - * The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the - * resource. Used for web cache validation. + * The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation. */ etag?: string; /** @@ -942,9 +861,7 @@ export namespace people_v1 { */ residences?: Schema$Residence[]; /** - * The resource name for the person, assigned by the server. An ASCII string - * with a max length of 27 characters, in the form of - * `people/`<var>person_id</var>. + * The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`<var>person_id</var>. */ resourceName?: string; /** @@ -973,9 +890,7 @@ export namespace people_v1 { */ export interface Schema$PersonMetadata { /** - * True if the person resource has been deleted. Populated only for - * [`connections.list`](/people/api/rest/v1/people.connections/list) - * requests that include a sync token. + * True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. */ deleted?: boolean; /** @@ -983,17 +898,11 @@ export namespace people_v1 { */ linkedPeopleResourceNames?: string[]; /** - * **DEPRECATED** (Please use - * `person.metadata.sources.profileMetadata.objectType` instead) The type - * of the person object. + * **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object. */ objectType?: string; /** - * Any former resource names this person has had. Populated only for - * [`connections.list`](/people/api/rest/v1/people.connections/list) - * requests that include a sync token. The resource name may change when - * adding or removing fields that link a contact and profile such as a - * verified email, verified phone number, or profile URL. + * Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL. */ previousResourceNames?: string[]; /** @@ -1006,8 +915,7 @@ export namespace people_v1 { */ export interface Schema$PersonResponse { /** - * **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] - * (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). + * **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). */ httpStatusCode?: number; /** @@ -1015,10 +923,7 @@ export namespace people_v1 { */ person?: Schema$Person; /** - * The original requested resource name. May be different than the resource - * name on the returned person. The resource name can change when adding or - * removing fields that link a contact and profile such as a verified email, - * verified phone number, or a profile URL. + * The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL. */ requestedResourceName?: string; /** @@ -1031,14 +936,11 @@ export namespace people_v1 { */ export interface Schema$PhoneNumber { /** - * The read-only canonicalized [ITU-T - * E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) - * form of the phone number. + * The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number. */ canonicalForm?: string; /** - * The read-only type of the phone number translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** @@ -1046,10 +948,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The type of the phone number. The type can be custom or one of these - * predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` - * * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * - * `googleVoice` * `other` + * The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other` */ type?: string; /** @@ -1058,13 +957,11 @@ export namespace people_v1 { value?: string; } /** - * A person's read-only photo. A picture shown next to the person's - * name to help others recognize the person. + * A person's read-only photo. A picture shown next to the person's name to help others recognize the person. */ export interface Schema$Photo { /** - * True if the photo is a default photo; false if the photo is a - * user-provided photo. + * True if the photo is a default photo; false if the photo is a user-provided photo. */ default?: boolean; /** @@ -1072,10 +969,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The URL of the photo. You can change the desired size by appending a - * query parameter `sz=`<var>size</var> at the end of the url. - * Example: - * `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50` + * The URL of the photo. You can change the desired size by appending a query parameter `sz=`<var>size</var> at the end of the url. Example: `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50` */ url?: string; } @@ -1097,9 +991,7 @@ export namespace people_v1 { */ export interface Schema$Relation { /** - * The type of the relation translated and formatted in the viewer's - * account locale or the locale specified in the Accept-Language HTTP - * header. + * The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. */ formattedType?: string; /** @@ -1111,10 +1003,7 @@ export namespace people_v1 { */ person?: string; /** - * The person's relation to the other person. The type can be custom or - * one of these predefined values: * `spouse` * `child` * `mother` * - * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * - * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` + * The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` */ type?: string; } @@ -1123,9 +1012,7 @@ export namespace people_v1 { */ export interface Schema$RelationshipInterest { /** - * The value of the relationship interest translated and formatted in the - * viewer's account locale or the locale specified in the - * Accept-Language HTTP header. + * The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. */ formattedValue?: string; /** @@ -1133,9 +1020,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The kind of relationship the person is looking for. The value can be - * custom or one of these predefined values: * `friend` * `date` * - * `relationship` * `networking` + * The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking` */ value?: string; } @@ -1144,9 +1029,7 @@ export namespace people_v1 { */ export interface Schema$RelationshipStatus { /** - * The read-only value of the relationship status translated and formatted - * in the viewer's account locale or the `Accept-Language` HTTP header - * locale. + * The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedValue?: string; /** @@ -1154,10 +1037,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The relationship status. The value can be custom or one of these - * predefined values: * `single` * `inARelationship` * `engaged` * - * `married` * `itsComplicated` * `openRelationship` * `widowed` * - * `inDomesticPartnership` * `inCivilUnion` + * The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion` */ value?: string; } @@ -1166,8 +1046,7 @@ export namespace people_v1 { */ export interface Schema$Residence { /** - * True if the residence is the person's current residence; false if the - * residence is a past residence. + * True if the residence is the person's current residence; false if the residence is a past residence. */ current?: boolean; /** @@ -1180,13 +1059,11 @@ export namespace people_v1 { value?: string; } /** - * A person's SIP address. Session Initial Protocol addresses are used for - * VoIP communications to make voice or video calls over the internet. + * A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet. */ export interface Schema$SipAddress { /** - * The read-only type of the SIP address translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** @@ -1194,14 +1071,11 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The type of the SIP address. The type can be custom or or one of these - * predefined values: * `home` * `work` * `mobile` * `other` + * The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other` */ type?: string; /** - * The SIP address in the [RFC - * 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI - * format. + * The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format. */ value?: string; } @@ -1223,9 +1097,7 @@ export namespace people_v1 { */ export interface Schema$Source { /** - * **Only populated in `person.metadata.sources`.** The [HTTP entity - * tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web - * cache validation. + * **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. */ etag?: string; /** @@ -1233,8 +1105,7 @@ export namespace people_v1 { */ id?: string; /** - * **Only populated in `person.metadata.sources`.** Metadata about a source - * of type PROFILE. + * **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. */ profileMetadata?: Schema$ProfileMetadata; /** @@ -1242,46 +1113,12 @@ export namespace people_v1 { */ type?: string; /** - * **Only populated in `person.metadata.sources`.** Last update timestamp - * of this source. + * **Only populated in `person.metadata.sources`.** Last update timestamp of this source. */ updateTime?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1289,14 +1126,11 @@ export namespace people_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1314,8 +1148,7 @@ export namespace people_v1 { value?: string; } /** - * A request to update an existing user contact group. All updated fields will - * be replaced. + * A request to update an existing user contact group. All updated fields will be replaced. */ export interface Schema$UpdateContactGroupRequest { /** @@ -1328,8 +1161,7 @@ export namespace people_v1 { */ export interface Schema$Url { /** - * The read-only type of the URL translated and formatted in the - * viewer's account locale or the `Accept-Language` HTTP header locale. + * The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string; /** @@ -1337,10 +1169,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The type of the URL. The type can be custom or one of these predefined - * values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * - * `reservations` * `appInstallPage`: website for a Google+ application. * - * `other` + * The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other` */ type?: string; /** @@ -1376,8 +1205,7 @@ export namespace people_v1 { /** * people.contactGroups.batchGet - * @desc Get a list of contact groups owned by the authenticated user by - * specifying a list of contact group resource names. + * @desc Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names. * @alias people.contactGroups.batchGet * @memberOf! () * @@ -1532,8 +1360,7 @@ export namespace people_v1 { /** * people.contactGroups.delete - * @desc Delete an existing contact group owned by the authenticated user by - * specifying a contact group resource name. + * @desc Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. * @alias people.contactGroups.delete * @memberOf! () * @@ -1606,8 +1433,7 @@ export namespace people_v1 { /** * people.contactGroups.get - * @desc Get a specific contact group owned by the authenticated user by - * specifying a contact group resource name. + * @desc Get a specific contact group owned by the authenticated user by specifying a contact group resource name. * @alias people.contactGroups.get * @memberOf! () * @@ -1682,8 +1508,7 @@ export namespace people_v1 { /** * people.contactGroups.list - * @desc List all contact groups owned by the authenticated user. Members of - * the contact groups are not populated. + * @desc List all contact groups owned by the authenticated user. Members of the contact groups are not populated. * @alias people.contactGroups.list * @memberOf! () * @@ -1763,8 +1588,7 @@ export namespace people_v1 { /** * people.contactGroups.update - * @desc Update the name of an existing contact group owned by the - * authenticated user. + * @desc Update the name of an existing contact group owned by the authenticated user. * @alias people.contactGroups.update * @memberOf! () * @@ -1910,14 +1734,11 @@ export namespace people_v1 { */ pageSize?: number; /** - * The next_page_token value returned from a previous call to - * [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the - * next page of resources. + * The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources. */ pageToken?: string; /** - * A sync token, returned by a previous call to `contactgroups.list`. Only - * resources changed since the sync token was created will be returned. + * A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned. */ syncToken?: string; } @@ -1929,8 +1750,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name for the contact group, assigned by the server. An ASCII - * string, in the form of `contactGroups/`contact_group_id. + * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`contact_group_id. */ resourceName?: string; @@ -1948,10 +1768,7 @@ export namespace people_v1 { /** * people.contactGroups.members.modify - * @desc Modify the members of a contact group owned by the authenticated - * user.
                          The only system contact groups that can have members added are - * `contactGroups/myContacts` and `contactGroups/starred`. Other system - * contact groups are deprecated and can only have contacts removed. + * @desc Modify the members of a contact group owned by the authenticated user.
                          The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed. * @alias people.contactGroups.members.modify * @memberOf! () * @@ -2062,8 +1879,7 @@ export namespace people_v1 { /** * people.people.createContact - * @desc Create a new contact and return the person resource for that - * contact. + * @desc Create a new contact and return the person resource for that contact. * @alias people.people.createContact * @memberOf! () * @@ -2208,9 +2024,7 @@ export namespace people_v1 { /** * people.people.get - * @desc Provides information about a person by specifying a resource name. - * Use `people/me` to indicate the authenticated user.
                          The request - * throws a 400 error if 'personFields' is not specified. + * @desc Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user.
                          The request throws a 400 error if 'personFields' is not specified. * @alias people.people.get * @memberOf! () * @@ -2283,10 +2097,7 @@ export namespace people_v1 { /** * people.people.getBatchGet - * @desc Provides information about a list of specific people by specifying - * a list of requested resource names. Use `people/me` to indicate the - * authenticated user.
                          The request throws a 400 error if 'personFields' - * is not specified. + * @desc Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.
                          The request throws a 400 error if 'personFields' is not specified. * @alias people.people.getBatchGet * @memberOf! () * @@ -2362,15 +2173,7 @@ export namespace people_v1 { /** * people.people.updateContact - * @desc Update contact data for an existing contact person. Any non-contact - * data will not be modified. The request throws a 400 error if - * `updatePersonFields` is not specified.
                          The request throws a 400 - * error if `person.metadata.sources` is not specified for the contact to be - * updated.
                          The request throws a 412 error if - * `person.metadata.sources.etag` is different than the contact's etag, - * which indicates the contact has changed since its data was read. Clients - * should get the latest person and re-apply their updates to the latest - * person. + * @desc Update contact data for an existing contact person. Any non-contact data will not be modified. The request throws a 400 error if `updatePersonFields` is not specified.
                          The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated.
                          The request throws a 412 error if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and re-apply their updates to the latest person. * @alias people.people.updateContact * @memberOf! () * @@ -2479,29 +2282,15 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * **Required.** A field mask to restrict which fields on the person are - * returned. Multiple fields can be specified by separating them with - * commas. Valid values are: * addresses * ageRanges * biographies * - * birthdays * braggingRights * coverPhotos * emailAddresses * events * - * genders * imClients * interests * locales * memberships * metadata * - * names * nicknames * occupations * organizations * phoneNumbers * photos * - * relations * relationshipInterests * relationshipStatuses * residences * - * sipAddresses * skills * taglines * urls * userDefined + * **Required.** A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined */ personFields?: string; /** - * **Required.** Comma-separated list of person fields to be included in the - * response. Each path should start with `person.`: for example, - * `person.names` or `person.photos`. + * **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. */ 'requestMask.includeField'?: string; /** - * The resource name of the person to provide information about. - To get - * information about the authenticated user, specify `people/me`. - To get - * information about a google account, specify - * `people/`account_id. - To get information about a contact, - * specify the resource name that identifies the contact as returned by - * [`people.connections.list`](/people/api/rest/v1/people.connections/list). + * The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). */ resourceName?: string; } @@ -2513,30 +2302,15 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * **Required.** A field mask to restrict which fields on each person are - * returned. Multiple fields can be specified by separating them with - * commas. Valid values are: * addresses * ageRanges * biographies * - * birthdays * braggingRights * coverPhotos * emailAddresses * events * - * genders * imClients * interests * locales * memberships * metadata * - * names * nicknames * occupations * organizations * phoneNumbers * photos * - * relations * relationshipInterests * relationshipStatuses * residences * - * sipAddresses * skills * taglines * urls * userDefined + * **Required.** A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined */ personFields?: string; /** - * **Required.** Comma-separated list of person fields to be included in the - * response. Each path should start with `person.`: for example, - * `person.names` or `person.photos`. + * **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. */ 'requestMask.includeField'?: string; /** - * The resource names of the people to provide information about. - To get - * information about the authenticated user, specify `people/me`. - To get - * information about a google account, specify - * `people/`account_id. - To get information about a contact, - * specify the resource name that identifies the contact as returned by - * [`people.connections.list`](/people/api/rest/v1/people.connections/list). - * You can include up to 50 resource names in one request. + * The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request. */ resourceNames?: string[]; } @@ -2548,19 +2322,11 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name for the person, assigned by the server. An ASCII string - * with a max length of 27 characters, in the form of - * `people/`person_id. + * The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`person_id. */ resourceName?: string; /** - * **Required.** A field mask to restrict which fields on the person are - * updated. Multiple fields can be specified by separating them with commas. - * All updated fields will be replaced. Valid values are: * addresses * - * biographies * birthdays * emailAddresses * events * genders * imClients * - * interests * locales * memberships * names * nicknames * occupations * - * organizations * phoneNumbers * relations * residences * sipAddresses * - * urls * userDefined + * **Required.** A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders * imClients * interests * locales * memberships * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined */ updatePersonFields?: string; @@ -2578,9 +2344,7 @@ export namespace people_v1 { /** * people.people.connections.list - * @desc Provides a list of the authenticated user's contacts merged with - * any connected profiles.
                          The request throws a 400 error if - * 'personFields' is not specified. + * @desc Provides a list of the authenticated user's contacts merged with any connected profiles.
                          The request throws a 400 error if 'personFields' is not specified. * @alias people.people.connections.list * @memberOf! () * @@ -2670,8 +2434,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The number of connections to include in the response. Valid values are - * between 1 and 2000, inclusive. Defaults to 100. + * The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100. */ pageSize?: number; /** @@ -2679,27 +2442,15 @@ export namespace people_v1 { */ pageToken?: string; /** - * **Required.** A field mask to restrict which fields on each person are - * returned. Multiple fields can be specified by separating them with - * commas. Valid values are: * addresses * ageRanges * biographies * - * birthdays * braggingRights * coverPhotos * emailAddresses * events * - * genders * imClients * interests * locales * memberships * metadata * - * names * nicknames * occupations * organizations * phoneNumbers * photos * - * relations * relationshipInterests * relationshipStatuses * residences * - * sipAddresses * skills * taglines * urls * userDefined + * **Required.** A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined */ personFields?: string; /** - * **Required.** Comma-separated list of person fields to be included in the - * response. Each path should start with `person.`: for example, - * `person.names` or `person.photos`. + * **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. */ 'requestMask.includeField'?: string; /** - * Whether the response should include a sync token, which can be used to - * get all changes since the last request. For subsequent sync requests use - * the `sync_token` param instead. Initial sync requests that specify - * `request_sync_token` have an additional rate limit. + * Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit. */ requestSyncToken?: boolean; /** @@ -2707,14 +2458,11 @@ export namespace people_v1 { */ resourceName?: string; /** - * The order in which the connections should be sorted. Defaults to - * `LAST_MODIFIED_ASCENDING`. + * The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. */ sortOrder?: string; /** - * A sync token returned by a previous call to `people.connections.list`. - * Only resources changed since the sync token was created will be returned. - * Sync requests that specify `sync_token` have an additional rate limit. + * A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit. */ syncToken?: string; } diff --git a/src/apis/playcustomapp/package.json b/src/apis/playcustomapp/package.json index 9992c4f856d..c6e7a39e29c 100644 --- a/src/apis/playcustomapp/package.json +++ b/src/apis/playcustomapp/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/playcustomapp/v1.ts b/src/apis/playcustomapp/v1.ts index 3d5bd23d9ba..90a6f4ce4be 100644 --- a/src/apis/playcustomapp/v1.ts +++ b/src/apis/playcustomapp/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace playcustomapp_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace playcustomapp_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace playcustomapp_v1 { accounts: Resource$Accounts; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); } diff --git a/src/apis/plus/package.json b/src/apis/plus/package.json index b27d1194480..a259e6d772b 100644 --- a/src/apis/plus/package.json +++ b/src/apis/plus/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/plus/v1.ts b/src/apis/plus/v1.ts index 0bb1d73e02f..2e29d0ecedb 100644 --- a/src/apis/plus/v1.ts +++ b/src/apis/plus/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace plus_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace plus_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -97,7 +94,10 @@ export namespace plus_v1 { people: Resource$People; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.activities = new Resource$Activities(this.context); this.comments = new Resource$Comments(this.context); @@ -115,8 +115,7 @@ export namespace plus_v1 { */ items?: Schema$PlusAclentryResource[]; /** - * Identifies this resource as a collection of access controls. Value: - * "plus#acl". + * Identifies this resource as a collection of access controls. Value: "plus#acl". */ kind?: string; } @@ -142,13 +141,11 @@ export namespace plus_v1 { */ address?: string; /** - * Additional content added by the person who shared this activity, - * applicable only when resharing an activity. + * Additional content added by the person who shared this activity, applicable only when resharing an activity. */ annotation?: string; /** - * If this activity is a crosspost from another system, this property - * specifies the ID of the original activity. + * If this activity is a crosspost from another system, this property specifies the ID of the original activity. */ crosspostSource?: string; /** @@ -156,8 +153,7 @@ export namespace plus_v1 { */ etag?: string; /** - * Latitude and longitude where this activity occurred. Format is latitude - * followed by longitude, space separated. + * Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. */ geocode?: string; /** @@ -165,8 +161,7 @@ export namespace plus_v1 { */ id?: string; /** - * Identifies this resource as an activity. Value: - * "plus#activity". + * Identifies this resource as an activity. Value: "plus#activity". */ kind?: string; /** @@ -232,13 +227,11 @@ export namespace plus_v1 { */ provider?: {title?: string}; /** - * The time at which this activity was initially published. Formatted as an - * RFC 3339 timestamp. + * The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. */ published?: string; /** - * Radius, in meters, of the region where this activity occurred, centered - * at the latitude and longitude identified in geocode. + * Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. */ radius?: string; /** @@ -246,8 +239,7 @@ export namespace plus_v1 { */ title?: string; /** - * The time at which this activity was last updated. Formatted as an RFC - * 3339 timestamp. + * The time at which this activity was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; /** @@ -255,10 +247,7 @@ export namespace plus_v1 { */ url?: string; /** - * This activity's verb, which indicates the action that was performed. - * Possible values include, but are not limited to, the following values: - - * "post" - Publish content to the stream. - "share" - - * Reshare an activity. + * This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: - "post" - Publish content to the stream. - "share" - Reshare an activity. */ verb?: string; } @@ -276,8 +265,7 @@ export namespace plus_v1 { */ items?: Schema$Activity[]; /** - * Identifies this resource as a collection of activities. Value: - * "plus#activityFeed". + * Identifies this resource as a collection of activities. Value: "plus#activityFeed". */ kind?: string; /** @@ -285,9 +273,7 @@ export namespace plus_v1 { */ nextLink?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -295,13 +281,11 @@ export namespace plus_v1 { */ selfLink?: string; /** - * The title of this collection of activities, which is a truncated portion - * of the content. + * The title of this collection of activities, which is a truncated portion of the content. */ title?: string; /** - * The time at which this collection of activities was last updated. - * Formatted as an RFC 3339 timestamp. + * The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; } @@ -342,8 +326,7 @@ export namespace plus_v1 { */ plusoners?: {totalItems?: number}; /** - * The time at which this comment was initially published. Formatted as an - * RFC 3339 timestamp. + * The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. */ published?: string; /** @@ -351,13 +334,11 @@ export namespace plus_v1 { */ selfLink?: string; /** - * The time at which this comment was last updated. Formatted as an RFC 3339 - * timestamp. + * The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; /** - * This comment's verb, indicating what action was performed. Possible - * values are: - "post" - Publish content to the stream. + * This comment's verb, indicating what action was performed. Possible values are: - "post" - Publish content to the stream. */ verb?: string; } @@ -375,8 +356,7 @@ export namespace plus_v1 { */ items?: Schema$Comment[]; /** - * Identifies this resource as a collection of comments. Value: - * "plus#commentFeed". + * Identifies this resource as a collection of comments. Value: "plus#commentFeed". */ kind?: string; /** @@ -384,9 +364,7 @@ export namespace plus_v1 { */ nextLink?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -394,8 +372,7 @@ export namespace plus_v1 { */ title?: string; /** - * The time at which this collection of comments was last updated. Formatted - * as an RFC 3339 timestamp. + * The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; } @@ -405,20 +382,15 @@ export namespace plus_v1 { */ etag?: string; /** - * The people in this page of results. Each item includes the id, - * displayName, image, and url for the person. To retrieve additional - * profile data, see the people.get method. + * The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method. */ items?: Schema$Person[]; /** - * Identifies this resource as a collection of people. Value: - * "plus#peopleFeed". + * Identifies this resource as a collection of people. Value: "plus#peopleFeed". */ kind?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -430,9 +402,7 @@ export namespace plus_v1 { */ title?: string; /** - * The total number of people available in this list. The number of people - * in a response might be smaller due to paging. This might not be set for - * all collections. + * The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. */ totalItems?: number; } @@ -442,9 +412,7 @@ export namespace plus_v1 { */ aboutMe?: string; /** - * The age range of the person. Valid ranges are 17 or younger, 18 to 20, - * and 21 or older. Age is determined from the user's birthday using - * Western age reckoning. + * The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. */ ageRange?: {max?: number; min?: number}; /** @@ -456,8 +424,7 @@ export namespace plus_v1 { */ braggingRights?: string; /** - * For followers who are visible, the number of people who have added this - * person or page to a circle. + * For followers who are visible, the number of people who have added this person or page to a circle. */ circledByCount?: number; /** @@ -477,17 +444,11 @@ export namespace plus_v1 { */ displayName?: string; /** - * The hosted domain name for the user's Google Apps account. For - * instance, example.com. The plus.profile.emails.read or email scope is - * needed to get this domain name. + * The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. */ domain?: string; /** - * A list of email addresses that this person has, including their Google - * account email address, and the public verified email addresses on their - * Google+ profile. The plus.profile.emails.read scope is needed to retrieve - * these email addresses, or the email scope can be used to retrieve just - * the Google account email address. + * A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. */ emails?: Array<{type?: string; value?: string}>; /** @@ -495,9 +456,7 @@ export namespace plus_v1 { */ etag?: string; /** - * The person's gender. Possible values include, but are not limited to, - * the following values: - "male" - Male gender. - - * "female" - Female gender. - "other" - Other. + * The person's gender. Possible values include, but are not limited to, the following values: - "male" - Male gender. - "female" - Female gender. - "other" - Other. */ gender?: string; /** @@ -521,8 +480,7 @@ export namespace plus_v1 { */ language?: string; /** - * An object representation of the individual components of a person's - * name. + * An object representation of the individual components of a person's name. */ name?: { familyName?: string; @@ -537,9 +495,7 @@ export namespace plus_v1 { */ nickname?: string; /** - * Type of person within Google+. Possible values include, but are not - * limited to, the following values: - "person" - represents an - * actual person. - "page" - represents a page. + * Type of person within Google+. Possible values include, but are not limited to, the following values: - "person" - represents an actual person. - "page" - represents a page. */ objectType?: string; /** @@ -547,8 +503,7 @@ export namespace plus_v1 { */ occupation?: string; /** - * A list of current or past organizations with which this person is - * associated. + * A list of current or past organizations with which this person is associated. */ organizations?: Array<{ department?: string; @@ -570,15 +525,7 @@ export namespace plus_v1 { */ plusOneCount?: number; /** - * The person's relationship status. Possible values include, but are - * not limited to, the following values: - "single" - Person is - * single. - "in_a_relationship" - Person is in a relationship. - * - "engaged" - Person is engaged. - "married" - - * Person is married. - "its_complicated" - The relationship is - * complicated. - "open_relationship" - Person is in an open - * relationship. - "widowed" - Person is widowed. - - * "in_domestic_partnership" - Person is in a domestic - * partnership. - "in_civil_union" - Person is in a civil union. + * The person's relationship status. Possible values include, but are not limited to, the following values: - "single" - Person is single. - "in_a_relationship" - Person is in a relationship. - "engaged" - Person is engaged. - "married" - Person is married. - "its_complicated" - The relationship is complicated. - "open_relationship" - Person is in an open relationship. - "widowed" - Person is widowed. - "in_domestic_partnership" - Person is in a domestic partnership. - "in_civil_union" - Person is in a civil union. */ relationshipStatus?: string; /** @@ -630,20 +577,11 @@ export namespace plus_v1 { */ displayName?: string; /** - * The ID of the entry. For entries of type "person" or - * "circle", this is the ID of the resource. For other types, this - * property is not set. + * The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. */ id?: string; /** - * The type of entry describing to whom access is granted. Possible values - * are: - "person" - Access to an individual. - - * "circle" - Access to members of a circle. - - * "myCircles" - Access to members of all the person's - * circles. - "extendedCircles" - Access to members of all the - * person's circles, plus all of the people in their circles. - - * "domain" - Access to members of the person's Google Apps - * domain. - "public" - Access to anyone on the web. + * The type of entry describing to whom access is granted. Possible values are: - "person" - Access to an individual. - "circle" - Access to members of a circle. - "myCircles" - Access to members of all the person's circles. - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. - "domain" - Access to members of the person's Google Apps domain. - "public" - Access to anyone on the web. */ type?: string; } @@ -656,8 +594,7 @@ export namespace plus_v1 { /** * plus.activities.get - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plus.activities.get * @memberOf! () * @@ -728,8 +665,7 @@ export namespace plus_v1 { /** * plus.activities.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plus.activities.list * @memberOf! () * @@ -804,8 +740,7 @@ export namespace plus_v1 { /** * plus.activities.search - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plus.activities.search * @memberOf! () * @@ -904,20 +839,15 @@ export namespace plus_v1 { */ collection?: string; /** - * The maximum number of activities to include in the response, which is - * used for paging. For any response, the actual number returned might be - * less than the specified maxResults. + * The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** - * The ID of the user to get activities for. The special value "me" can be - * used to indicate the authenticated user. + * The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -929,14 +859,11 @@ export namespace plus_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specify the preferred language to search with. See search language codes - * for available values. + * Specify the preferred language to search with. See search language codes for available values. */ language?: string; /** - * The maximum number of activities to include in the response, which is - * used for paging. For any response, the actual number returned might be - * less than the specified maxResults. + * The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** @@ -944,10 +871,7 @@ export namespace plus_v1 { */ orderBy?: string; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. This token can be of any - * length. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length. */ pageToken?: string; /** @@ -964,8 +888,7 @@ export namespace plus_v1 { /** * plus.comments.get - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plus.comments.get * @memberOf! () * @@ -1036,8 +959,7 @@ export namespace plus_v1 { /** * plus.comments.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plus.comments.list * @memberOf! () * @@ -1133,15 +1055,11 @@ export namespace plus_v1 { */ activityId?: string; /** - * The maximum number of comments to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** @@ -1158,9 +1076,7 @@ export namespace plus_v1 { /** * plus.people.get - * @desc Get a person's profile. If your app uses scope - * https://www.googleapis.com/auth/plus.login, this method is guaranteed to - * return ageRange and language. + * @desc Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language. * @alias plus.people.get * @memberOf! () * @@ -1307,8 +1223,7 @@ export namespace plus_v1 { /** * plus.people.listByActivity - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plus.people.listByActivity * @memberOf! () * @@ -1384,8 +1299,7 @@ export namespace plus_v1 { /** * plus.people.search - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plus.people.search * @memberOf! () * @@ -1464,8 +1378,7 @@ export namespace plus_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the person to get the profile for. The special value "me" can - * be used to indicate the authenticated user. + * The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -1480,9 +1393,7 @@ export namespace plus_v1 { */ collection?: string; /** - * The maximum number of people to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** @@ -1490,14 +1401,11 @@ export namespace plus_v1 { */ orderBy?: string; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** - * Get the collection of people for the person identified. Use "me" to - * indicate the authenticated user. + * Get the collection of people for the person identified. Use "me" to indicate the authenticated user. */ userId?: string; } @@ -1517,15 +1425,11 @@ export namespace plus_v1 { */ collection?: string; /** - * The maximum number of people to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } @@ -1536,26 +1440,19 @@ export namespace plus_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specify the preferred language to search with. See search language codes - * for available values. + * Specify the preferred language to search with. See search language codes for available values. */ language?: string; /** - * The maximum number of people to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. This token can be of any - * length. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length. */ pageToken?: string; /** - * Specify a query string for full text search of public text in all - * profiles. + * Specify a query string for full text search of public text in all profiles. */ query?: string; } diff --git a/src/apis/plusDomains/package.json b/src/apis/plusDomains/package.json index 603e121c4f9..e1ad5f05a54 100644 --- a/src/apis/plusDomains/package.json +++ b/src/apis/plusDomains/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/plusDomains/v1.ts b/src/apis/plusDomains/v1.ts index 91c417c2099..94176126ab0 100644 --- a/src/apis/plusDomains/v1.ts +++ b/src/apis/plusDomains/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace plusDomains_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace plusDomains_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -100,7 +97,10 @@ export namespace plusDomains_v1 { people: Resource$People; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.activities = new Resource$Activities(this.context); this.audiences = new Resource$Audiences(this.context); @@ -125,8 +125,7 @@ export namespace plusDomains_v1 { */ items?: Schema$PlusDomainsAclentryResource[]; /** - * Identifies this resource as a collection of access controls. Value: - * "plus#acl". + * Identifies this resource as a collection of access controls. Value: "plus#acl". */ kind?: string; } @@ -152,13 +151,11 @@ export namespace plusDomains_v1 { */ address?: string; /** - * Additional content added by the person who shared this activity, - * applicable only when resharing an activity. + * Additional content added by the person who shared this activity, applicable only when resharing an activity. */ annotation?: string; /** - * If this activity is a crosspost from another system, this property - * specifies the ID of the original activity. + * If this activity is a crosspost from another system, this property specifies the ID of the original activity. */ crosspostSource?: string; /** @@ -166,8 +163,7 @@ export namespace plusDomains_v1 { */ etag?: string; /** - * Latitude and longitude where this activity occurred. Format is latitude - * followed by longitude, space separated. + * Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. */ geocode?: string; /** @@ -175,8 +171,7 @@ export namespace plusDomains_v1 { */ id?: string; /** - * Identifies this resource as an activity. Value: - * "plus#activity". + * Identifies this resource as an activity. Value: "plus#activity". */ kind?: string; /** @@ -250,13 +245,11 @@ export namespace plusDomains_v1 { */ provider?: {title?: string}; /** - * The time at which this activity was initially published. Formatted as an - * RFC 3339 timestamp. + * The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. */ published?: string; /** - * Radius, in meters, of the region where this activity occurred, centered - * at the latitude and longitude identified in geocode. + * Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. */ radius?: string; /** @@ -264,8 +257,7 @@ export namespace plusDomains_v1 { */ title?: string; /** - * The time at which this activity was last updated. Formatted as an RFC - * 3339 timestamp. + * The time at which this activity was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; /** @@ -273,10 +265,7 @@ export namespace plusDomains_v1 { */ url?: string; /** - * This activity's verb, which indicates the action that was performed. - * Possible values include, but are not limited to, the following values: - - * "post" - Publish content to the stream. - "share" - - * Reshare an activity. + * This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: - "post" - Publish content to the stream. - "share" - Reshare an activity. */ verb?: string; } @@ -294,8 +283,7 @@ export namespace plusDomains_v1 { */ items?: Schema$Activity[]; /** - * Identifies this resource as a collection of activities. Value: - * "plus#activityFeed". + * Identifies this resource as a collection of activities. Value: "plus#activityFeed". */ kind?: string; /** @@ -303,9 +291,7 @@ export namespace plusDomains_v1 { */ nextLink?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -313,13 +299,11 @@ export namespace plusDomains_v1 { */ selfLink?: string; /** - * The title of this collection of activities, which is a truncated portion - * of the content. + * The title of this collection of activities, which is a truncated portion of the content. */ title?: string; /** - * The time at which this collection of activities was last updated. - * Formatted as an RFC 3339 timestamp. + * The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; } @@ -333,22 +317,15 @@ export namespace plusDomains_v1 { */ item?: Schema$PlusDomainsAclentryResource; /** - * Identifies this resource as an audience. Value: - * "plus#audience". + * Identifies this resource as an audience. Value: "plus#audience". */ kind?: string; /** - * The number of people in this circle. This only applies if entity_type is - * CIRCLE. + * The number of people in this circle. This only applies if entity_type is CIRCLE. */ memberCount?: number; /** - * The circle members' visibility as chosen by the owner of the circle. - * This only applies for items with "item.type" equals - * "circle". Possible values are: - "public" - Members - * are visible to the public. - "limited" - Members are visible - * to a limited audience. - "private" - Members are visible to - * the owner only. + * The circle members' visibility as chosen by the owner of the circle. This only applies for items with "item.type" equals "circle". Possible values are: - "public" - Members are visible to the public. - "limited" - Members are visible to a limited audience. - "private" - Members are visible to the owner only. */ visibility?: string; } @@ -362,19 +339,15 @@ export namespace plusDomains_v1 { */ items?: Schema$Audience[]; /** - * Identifies this resource as a collection of audiences. Value: - * "plus#audienceFeed". + * Identifies this resource as a collection of audiences. Value: "plus#audienceFeed". */ kind?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** - * The total number of ACL entries. The number of entries in this response - * may be smaller due to paging. + * The total number of ACL entries. The number of entries in this response may be smaller due to paging. */ totalItems?: number; } @@ -418,8 +391,7 @@ export namespace plusDomains_v1 { */ items?: Schema$Circle[]; /** - * Identifies this resource as a collection of circles. Value: - * "plus#circleFeed". + * Identifies this resource as a collection of circles. Value: "plus#circleFeed". */ kind?: string; /** @@ -427,9 +399,7 @@ export namespace plusDomains_v1 { */ nextLink?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -441,8 +411,7 @@ export namespace plusDomains_v1 { */ title?: string; /** - * The total number of circles. The number of circles in this response may - * be smaller due to paging. + * The total number of circles. The number of circles in this response may be smaller due to paging. */ totalItems?: number; } @@ -483,8 +452,7 @@ export namespace plusDomains_v1 { */ plusoners?: {totalItems?: number}; /** - * The time at which this comment was initially published. Formatted as an - * RFC 3339 timestamp. + * The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. */ published?: string; /** @@ -492,13 +460,11 @@ export namespace plusDomains_v1 { */ selfLink?: string; /** - * The time at which this comment was last updated. Formatted as an RFC 3339 - * timestamp. + * The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; /** - * This comment's verb, indicating what action was performed. Possible - * values are: - "post" - Publish content to the stream. + * This comment's verb, indicating what action was performed. Possible values are: - "post" - Publish content to the stream. */ verb?: string; } @@ -516,8 +482,7 @@ export namespace plusDomains_v1 { */ items?: Schema$Comment[]; /** - * Identifies this resource as a collection of comments. Value: - * "plus#commentFeed". + * Identifies this resource as a collection of comments. Value: "plus#commentFeed". */ kind?: string; /** @@ -525,9 +490,7 @@ export namespace plusDomains_v1 { */ nextLink?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -535,8 +498,7 @@ export namespace plusDomains_v1 { */ title?: string; /** - * The time at which this collection of comments was last updated. Formatted - * as an RFC 3339 timestamp. + * The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp. */ updated?: string; } @@ -575,8 +537,7 @@ export namespace plusDomains_v1 { */ kind?: string; /** - * The time at which this media was originally created in UTC. Formatted as - * an RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z + * The time at which this media was originally created in UTC. Formatted as an RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z */ mediaCreatedTime?: string; /** @@ -584,8 +545,7 @@ export namespace plusDomains_v1 { */ mediaUrl?: string; /** - * The time at which this media was uploaded. Formatted as an RFC 3339 - * timestamp. + * The time at which this media was uploaded. Formatted as an RFC 3339 timestamp. */ published?: string; /** @@ -593,9 +553,7 @@ export namespace plusDomains_v1 { */ sizeBytes?: string; /** - * The list of video streams for this video. There might be several - * different streams available for a single video, either Flash or MPEG, of - * various sizes + * The list of video streams for this video. There might be several different streams available for a single video, either Flash or MPEG, of various sizes */ streams?: Schema$Videostream[]; /** @@ -603,8 +561,7 @@ export namespace plusDomains_v1 { */ summary?: string; /** - * The time at which this media was last updated. This includes changes to - * media metadata. Formatted as an RFC 3339 timestamp. + * The time at which this media was last updated. This includes changes to media metadata. Formatted as an RFC 3339 timestamp. */ updated?: string; /** @@ -616,11 +573,7 @@ export namespace plusDomains_v1 { */ videoDuration?: string; /** - * The encoding status of this video. Possible values are: - - * "UPLOADING" - Not all the video bytes have been received. - - * "PENDING" - Video not yet processed. - "FAILED" - - * Video processing failed. - "READY" - A single video stream is - * playable. - "FINAL" - All video streams are playable. + * The encoding status of this video. Possible values are: - "UPLOADING" - Not all the video bytes have been received. - "PENDING" - Video not yet processed. - "FAILED" - Video processing failed. - "READY" - A single video stream is playable. - "FINAL" - All video streams are playable. */ videoStatus?: string; /** @@ -634,20 +587,15 @@ export namespace plusDomains_v1 { */ etag?: string; /** - * The people in this page of results. Each item includes the id, - * displayName, image, and url for the person. To retrieve additional - * profile data, see the people.get method. + * The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method. */ items?: Schema$Person[]; /** - * Identifies this resource as a collection of people. Value: - * "plus#peopleFeed". + * Identifies this resource as a collection of people. Value: "plus#peopleFeed". */ kind?: string; /** - * The continuation token, which is used to page through large result sets. - * Provide this value in a subsequent request to return the next page of - * results. + * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -659,9 +607,7 @@ export namespace plusDomains_v1 { */ title?: string; /** - * The total number of people available in this list. The number of people - * in a response might be smaller due to paging. This might not be set for - * all collections. + * The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. */ totalItems?: number; } @@ -679,8 +625,7 @@ export namespace plusDomains_v1 { */ braggingRights?: string; /** - * For followers who are visible, the number of people who have added this - * person or page to a circle. + * For followers who are visible, the number of people who have added this person or page to a circle. */ circledByCount?: number; /** @@ -700,17 +645,11 @@ export namespace plusDomains_v1 { */ displayName?: string; /** - * The hosted domain name for the user's Google Apps account. For - * instance, example.com. The plus.profile.emails.read or email scope is - * needed to get this domain name. + * The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. */ domain?: string; /** - * A list of email addresses that this person has, including their Google - * account email address, and the public verified email addresses on their - * Google+ profile. The plus.profile.emails.read scope is needed to retrieve - * these email addresses, or the email scope can be used to retrieve just - * the Google account email address. + * A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. */ emails?: Array<{type?: string; value?: string}>; /** @@ -718,9 +657,7 @@ export namespace plusDomains_v1 { */ etag?: string; /** - * The person's gender. Possible values include, but are not limited to, - * the following values: - "male" - Male gender. - - * "female" - Female gender. - "other" - Other. + * The person's gender. Possible values include, but are not limited to, the following values: - "male" - Male gender. - "female" - Female gender. - "other" - Other. */ gender?: string; /** @@ -740,8 +677,7 @@ export namespace plusDomains_v1 { */ kind?: string; /** - * An object representation of the individual components of a person's - * name. + * An object representation of the individual components of a person's name. */ name?: { familyName?: string; @@ -756,9 +692,7 @@ export namespace plusDomains_v1 { */ nickname?: string; /** - * Type of person within Google+. Possible values include, but are not - * limited to, the following values: - "person" - represents an - * actual person. - "page" - represents a page. + * Type of person within Google+. Possible values include, but are not limited to, the following values: - "person" - represents an actual person. - "page" - represents a page. */ objectType?: string; /** @@ -766,8 +700,7 @@ export namespace plusDomains_v1 { */ occupation?: string; /** - * A list of current or past organizations with which this person is - * associated. + * A list of current or past organizations with which this person is associated. */ organizations?: Array<{ department?: string; @@ -789,15 +722,7 @@ export namespace plusDomains_v1 { */ plusOneCount?: number; /** - * The person's relationship status. Possible values include, but are - * not limited to, the following values: - "single" - Person is - * single. - "in_a_relationship" - Person is in a relationship. - * - "engaged" - Person is engaged. - "married" - - * Person is married. - "its_complicated" - The relationship is - * complicated. - "open_relationship" - Person is in an open - * relationship. - "widowed" - Person is widowed. - - * "in_domestic_partnership" - Person is in a domestic - * partnership. - "in_civil_union" - Person is in a civil union. + * The person's relationship status. Possible values include, but are not limited to, the following values: - "single" - Person is single. - "in_a_relationship" - Person is in a relationship. - "engaged" - Person is engaged. - "married" - Person is married. - "its_complicated" - The relationship is complicated. - "open_relationship" - Person is in an open relationship. - "widowed" - Person is widowed. - "in_domestic_partnership" - Person is in a domestic partnership. - "in_civil_union" - Person is in a civil union. */ relationshipStatus?: string; /** @@ -849,20 +774,11 @@ export namespace plusDomains_v1 { */ displayName?: string; /** - * The ID of the entry. For entries of type "person" or - * "circle", this is the ID of the resource. For other types, this - * property is not set. + * The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. */ id?: string; /** - * The type of entry describing to whom access is granted. Possible values - * are: - "person" - Access to an individual. - - * "circle" - Access to members of a circle. - - * "myCircles" - Access to members of all the person's - * circles. - "extendedCircles" - Access to members of all the - * person's circles, plus all of the people in their circles. - - * "domain" - Access to members of the person's Google Apps - * domain. - "public" - Access to anyone on the web. + * The type of entry describing to whom access is granted. Possible values are: - "person" - Access to an individual. - "circle" - Access to members of a circle. - "myCircles" - Access to members of all the person's circles. - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. - "domain" - Access to members of the person's Google Apps domain. - "public" - Access to anyone on the web. */ type?: string; } @@ -893,8 +809,7 @@ export namespace plusDomains_v1 { /** * plusDomains.activities.get - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.activities.get * @memberOf! () * @@ -965,8 +880,7 @@ export namespace plusDomains_v1 { /** * plusDomains.activities.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.activities.list * @memberOf! () * @@ -1063,20 +977,15 @@ export namespace plusDomains_v1 { */ collection?: string; /** - * The maximum number of activities to include in the response, which is - * used for paging. For any response, the actual number returned might be - * less than the specified maxResults. + * The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** - * The ID of the user to get activities for. The special value "me" can be - * used to indicate the authenticated user. + * The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -1089,8 +998,7 @@ export namespace plusDomains_v1 { /** * plusDomains.audiences.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.audiences.list * @memberOf! () * @@ -1170,20 +1078,15 @@ export namespace plusDomains_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of circles to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of circles to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** - * The ID of the user to get audiences for. The special value "me" can be - * used to indicate the authenticated user. + * The ID of the user to get audiences for. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -1196,8 +1099,7 @@ export namespace plusDomains_v1 { /** * plusDomains.circles.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.circles.list * @memberOf! () * @@ -1278,20 +1180,15 @@ export namespace plusDomains_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of circles to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of circles to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** - * The ID of the user to get circles for. The special value "me" can be used - * to indicate the authenticated user. + * The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -1304,8 +1201,7 @@ export namespace plusDomains_v1 { /** * plusDomains.comments.get - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.comments.get * @memberOf! () * @@ -1376,8 +1272,7 @@ export namespace plusDomains_v1 { /** * plusDomains.comments.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.comments.list * @memberOf! () * @@ -1473,15 +1368,11 @@ export namespace plusDomains_v1 { */ activityId?: string; /** - * The maximum number of comments to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** @@ -1498,8 +1389,7 @@ export namespace plusDomains_v1 { /** * plusDomains.media.insert - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.media.insert * @memberOf! () * @@ -1767,8 +1657,7 @@ export namespace plusDomains_v1 { /** * plusDomains.people.listByActivity - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. + * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. * @alias plusDomains.people.listByActivity * @memberOf! () * @@ -1851,8 +1740,7 @@ export namespace plusDomains_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the person to get the profile for. The special value "me" can - * be used to indicate the authenticated user. + * The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -1867,9 +1755,7 @@ export namespace plusDomains_v1 { */ collection?: string; /** - * The maximum number of people to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** @@ -1877,14 +1763,11 @@ export namespace plusDomains_v1 { */ orderBy?: string; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; /** - * Get the collection of people for the person identified. Use "me" to - * indicate the authenticated user. + * Get the collection of people for the person identified. Use "me" to indicate the authenticated user. */ userId?: string; } @@ -1904,15 +1787,11 @@ export namespace plusDomains_v1 { */ collection?: string; /** - * The maximum number of people to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. + * The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. */ maxResults?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. */ pageToken?: string; } diff --git a/src/apis/poly/package.json b/src/apis/poly/package.json index 5b69612ec29..c4908381e2b 100644 --- a/src/apis/poly/package.json +++ b/src/apis/poly/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/poly/v1.ts b/src/apis/poly/v1.ts index be0c7fd0f4d..93afa20fdf1 100644 --- a/src/apis/poly/v1.ts +++ b/src/apis/poly/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace poly_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace poly_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,11 +91,7 @@ export namespace poly_v1 { /** * Poly API * - * The Poly API provides read access to assets hosted on <a - * href="https://poly.google.com">poly.google.com</a> to - * all, and upload access to <a - * href="https://poly.google.com">poly.google.com</a> for - * whitelisted accounts. + * The Poly API provides read access to assets hosted on <a href="https://poly.google.com">poly.google.com</a> to all, and upload access to <a href="https://poly.google.com">poly.google.com</a> for whitelisted accounts. * * @example * const {google} = require('googleapis'); @@ -117,7 +109,10 @@ export namespace poly_v1 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.assets = new Resource$Assets(this.context); this.users = new Resource$Users(this.context); @@ -125,21 +120,15 @@ export namespace poly_v1 { } /** - * Represents and describes an asset in the Poly library. An asset is a 3D - * model or scene created using [Tilt Brush](//www.tiltbrush.com), - * [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file - * that can be upload to Poly. + * Represents and describes an asset in the Poly library. An asset is a 3D model or scene created using [Tilt Brush](//www.tiltbrush.com), [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file that can be upload to Poly. */ export interface Schema$Asset { /** - * The author's publicly visible name. Use this name when giving credit - * to the author. For more information, see - * [Licensing](/poly/discover/licensing). + * The author's publicly visible name. Use this name when giving credit to the author. For more information, see [Licensing](/poly/discover/licensing). */ authorName?: string; /** - * For published assets, the time when the asset was published. For - * unpublished assets, the time when the asset was created. + * For published assets, the time when the asset was published. For unpublished assets, the time when the asset was created. */ createTime?: string; /** @@ -151,8 +140,7 @@ export namespace poly_v1 { */ displayName?: string; /** - * A list of Formats where each format describes one representation of the - * asset. + * A list of Formats where each format describes one representation of the asset. */ formats?: Schema$Format[]; /** @@ -160,16 +148,11 @@ export namespace poly_v1 { */ isCurated?: boolean; /** - * The license under which the author has made the asset available for use, - * if any. + * The license under which the author has made the asset available for use, if any. */ license?: string; /** - * Application-defined opaque metadata for this asset. This field is only - * returned when querying for the signed-in user's own assets, not for - * public assets. This string is limited to 1K chars. It is up to the - * creator of the asset to define the format for this string (for example, - * JSON). + * Application-defined opaque metadata for this asset. This field is only returned when querying for the signed-in user's own assets, not for public assets. This string is limited to 1K chars. It is up to the creator of the asset to define the format for this string (for example, JSON). */ metadata?: string; /** @@ -177,8 +160,7 @@ export namespace poly_v1 { */ name?: string; /** - * Hints for displaying the asset. Note that these parameters are not - * immutable; the author of an asset may change them post-publication. + * Hints for displaying the asset. Note that these parameters are not immutable; the author of an asset may change them post-publication. */ presentationParams?: Schema$PresentationParams; /** @@ -190,9 +172,7 @@ export namespace poly_v1 { */ thumbnail?: Schema$File; /** - * The time when the asset was last modified. For published assets, whose - * contents are immutable, the update time changes only when metadata - * properties, such as visibility, are updated. + * The time when the asset was last modified. For published assets, whose contents are immutable, the update time changes only when metadata properties, such as visibility, are updated. */ updateTime?: string; /** @@ -209,8 +189,7 @@ export namespace poly_v1 { */ code?: string; /** - * An optional file path. Only present for those error codes that specify - * it. + * An optional file path. Only present for those error codes that specify it. */ filePath?: string; /** @@ -223,19 +202,15 @@ export namespace poly_v1 { objParseError?: Schema$ObjParseError; } /** - * Represents a file in Poly, which can be a root, resource, or thumbnail - * file. + * Represents a file in Poly, which can be a root, resource, or thumbnail file. */ export interface Schema$File { /** - * The MIME content-type, such as `image/png`. For more information, see - * [MIME - * types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). + * The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). */ contentType?: string; /** - * The path of the resource file relative to the root file. For root or - * thumbnail files, this is just the filename. + * The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename. */ relativePath?: string; /** @@ -244,12 +219,7 @@ export namespace poly_v1 { url?: string; } /** - * The same asset can be represented in different formats, for example, a - * [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its - * corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file - * with its corresponding .glb binary data. A format refers to a specific - * representation of an asset and contains all information needed to retrieve - * and describe this representation. + * The same asset can be represented in different formats, for example, a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file with its corresponding .glb binary data. A format refers to a specific representation of an asset and contains all information needed to retrieve and describe this representation. */ export interface Schema$Format { /** @@ -257,20 +227,15 @@ export namespace poly_v1 { */ formatComplexity?: Schema$FormatComplexity; /** - * A short string that identifies the format type of this representation. - * Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. + * A short string that identifies the format type of this representation. Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. */ formatType?: string; /** - * A list of dependencies of the root element. May include, but is not - * limited to, materials, textures, and shader programs. + * A list of dependencies of the root element. May include, but is not limited to, materials, textures, and shader programs. */ resources?: Schema$File[]; /** - * The root of the file hierarchy. This will always be populated. For some - * format_types - such as `TILT`, which are self-contained - this is all of - * the data. Other types - such as `OBJ` - often reference other data - * elements. These are contained in the resources field. + * The root of the file hierarchy. This will always be populated. For some format_types - such as `TILT`, which are self-contained - this is all of the data. Other types - such as `OBJ` - often reference other data elements. These are contained in the resources field. */ root?: Schema$File; } @@ -279,10 +244,7 @@ export namespace poly_v1 { */ export interface Schema$FormatComplexity { /** - * A non-negative integer that represents the level of detail (LOD) of this - * format relative to other formats of the same asset with the same - * format_type. This hint allows you to sort formats from the most-detailed - * (0) to least-detailed (integers greater than 0). + * A non-negative integer that represents the level of detail (LOD) of this format relative to other formats of the same asset with the same format_type. This hint allows you to sort formats from the most-detailed (0) to least-detailed (integers greater than 0). */ lodHint?: number; /** @@ -312,9 +274,7 @@ export namespace poly_v1 { */ assets?: Schema$Asset[]; /** - * The continuation token for retrieving the next page. If empty, indicates - * that there are no more pages. To get the next page, submit the same - * request specifying this value as the page_token. + * The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token. */ nextPageToken?: string; /** @@ -331,9 +291,7 @@ export namespace poly_v1 { */ assets?: Schema$Asset[]; /** - * The continuation token for retrieving the next page. If empty, indicates - * that there are no more pages. To get the next page, submit the same - * request specifying this value as the page_token. + * The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token. */ nextPageToken?: string; /** @@ -346,9 +304,7 @@ export namespace poly_v1 { */ export interface Schema$ListUserAssetsResponse { /** - * The continuation token for retrieving the next page. If empty, indicates - * that there are no more pages. To get the next page, submit the same - * request specifying this value as the page_token. + * The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token. */ nextPageToken?: string; /** @@ -377,9 +333,7 @@ export namespace poly_v1 { */ filePath?: string; /** - * The text of the line. Note that this may be truncated if the line was - * very long. This may not include the error if it occurs after line - * truncation. + * The text of the line. Note that this may be truncated if the line was very long. This may not include the error if it occurs after line truncation. */ line?: string; /** @@ -392,44 +346,24 @@ export namespace poly_v1 { startIndex?: number; } /** - * Hints for displaying the asset, based on information available when the - * asset was uploaded. + * Hints for displaying the asset, based on information available when the asset was uploaded. */ export interface Schema$PresentationParams { /** - * A background color which could be used for displaying the 3D asset in a - * 'thumbnail' or 'palette' style view. Authors have the - * option to set this background color when publishing or editing their - * asset. This is represented as a six-digit hexademical triplet specifying - * the RGB components of the background color, e.g. #FF0000 for Red. + * A background color which could be used for displaying the 3D asset in a 'thumbnail' or 'palette' style view. Authors have the option to set this background color when publishing or editing their asset. This is represented as a six-digit hexademical triplet specifying the RGB components of the background color, e.g. #FF0000 for Red. */ backgroundColor?: string; /** - * The materials' diffuse/albedo color. This does not apply to vertex - * colors or texture maps. + * The materials' diffuse/albedo color. This does not apply to vertex colors or texture maps. */ colorSpace?: string; /** - * A rotation that should be applied to the object root to make it upright. - * More precisely, this quaternion transforms from "object space" - * (the space in which the object is defined) to "presentation - * space", a coordinate system where +Y is up, +X is right, -Z is - * forward. For example, if the object is the Eiffel Tower, in its local - * coordinate system the object might be laid out such that the base of the - * tower is on the YZ plane and the tip of the tower is towards positive X. - * In this case this quaternion would specify a rotation (of 90 degrees - * about the Z axis) such that in the presentation space the base of the - * tower is aligned with the XZ plane, and the tip of the tower lies towards - * +Y. This rotation is unrelated to the object's pose in the web - * preview, which is just a camera position setting and is *not* reflected - * in this rotation. Please note: this is applicable only to the gLTF. + * A rotation that should be applied to the object root to make it upright. More precisely, this quaternion transforms from "object space" (the space in which the object is defined) to "presentation space", a coordinate system where +Y is up, +X is right, -Z is forward. For example, if the object is the Eiffel Tower, in its local coordinate system the object might be laid out such that the base of the tower is on the YZ plane and the tip of the tower is towards positive X. In this case this quaternion would specify a rotation (of 90 degrees about the Z axis) such that in the presentation space the base of the tower is aligned with the XZ plane, and the tip of the tower lies towards +Y. This rotation is unrelated to the object's pose in the web preview, which is just a camera position setting and is *not* reflected in this rotation. Please note: this is applicable only to the gLTF. */ orientingRotation?: Schema$Quaternion; } /** - * A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the - * response you see "w: 1" and nothing else this is the default - * value of [0, 0, 0, 1] where x,y, and z are 0. + * A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the response you see "w: 1" and nothing else this is the default value of [0, 0, 0, 1] where x,y, and z are 0. */ export interface Schema$Quaternion { /** @@ -450,25 +384,20 @@ export namespace poly_v1 { z?: number; } /** - * Info about the sources of this asset (i.e. assets that were remixed to - * create this asset). + * Info about the sources of this asset (i.e. assets that were remixed to create this asset). */ export interface Schema$RemixInfo { /** - * Resource ids for the sources of this remix, of the form: - * `assets/{ASSET_ID}` + * Resource ids for the sources of this remix, of the form: `assets/{ASSET_ID}` */ sourceAsset?: string[]; } /** - * A response message from a request to startImport. This is returned in the - * response field of the Operation. + * A response message from a request to startImport. This is returned in the response field of the Operation. */ export interface Schema$StartAssetImportResponse { /** - * The id of newly created asset. If this is empty when the operation is - * complete it means the import failed. Please refer to the - * assetImportMessages field to understand what went wrong. + * The id of newly created asset. If this is empty when the operation is complete it means the import failed. Please refer to the assetImportMessages field to understand what went wrong. */ assetId?: string; /** @@ -476,8 +405,7 @@ export namespace poly_v1 { */ assetImportId?: string; /** - * The message from the asset import. This will contain any warnings (or - - * in the case of failure - errors) that occurred during import. + * The message from the asset import. This will contain any warnings (or - in the case of failure - errors) that occurred during import. */ assetImportMessages?: Schema$AssetImportMessage[]; /** @@ -503,9 +431,7 @@ export namespace poly_v1 { /** * poly.assets.get - * @desc Returns detailed information about an asset given its name. PRIVATE - * assets are returned only if the currently authenticated user (via OAuth - * token) is the author of the asset. + * @desc Returns detailed information about an asset given its name. PRIVATE assets are returned only if the currently authenticated user (via OAuth token) is the author of the asset. * @alias poly.assets.get * @memberOf! () * @@ -573,8 +499,7 @@ export namespace poly_v1 { /** * poly.assets.list - * @desc Lists all public, remixable assets. These are assets with an access - * level of PUBLIC and published under the CC-By license. + * @desc Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license. * @alias poly.assets.list * @memberOf! () * @@ -668,9 +593,7 @@ export namespace poly_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Filter assets based on the specified category. Supported values are: - * `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, - * `scenes`, `technology`, and `transport`. + * Filter assets based on the specified category. Supported values are: `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`, `technology`, and `transport`. */ category?: string; /** @@ -678,37 +601,27 @@ export namespace poly_v1 { */ curated?: boolean; /** - * Return only assets with the matching format. Acceptable values are: - * `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`. + * Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`. */ format?: string; /** - * One or more search terms to be matched against all text that Poly has - * indexed for assets, which includes display_name, description, and tags. - * Multiple keywords should be separated by spaces. + * One or more search terms to be matched against all text that Poly has indexed for assets, which includes display_name, description, and tags. Multiple keywords should be separated by spaces. */ keywords?: string; /** - * Returns assets that are of the specified complexity or less. Defaults to - * COMPLEX. For example, a request for MEDIUM assets also includes SIMPLE - * assets. + * Returns assets that are of the specified complexity or less. Defaults to COMPLEX. For example, a request for MEDIUM assets also includes SIMPLE assets. */ maxComplexity?: string; /** - * Specifies an ordering for assets. Acceptable values are: `BEST`, - * `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a - * combination of popularity and other features. + * Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features. */ orderBy?: string; /** - * The maximum number of assets to be returned. This value must be between - * `1` and `100`. Defaults to `20`. + * The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`. */ pageSize?: number; /** - * Specifies a continuation token from a previous search whose results were - * split into multiple pages. To get the next page, submit the same request - * specifying the value from next_page_token. + * Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token. */ pageToken?: string; } @@ -732,10 +645,7 @@ export namespace poly_v1 { /** * poly.users.assets.list - * @desc Lists assets authored by the given user. Only the value 'me', - * representing the currently-authenticated user, is supported. May include - * assets with an access level of PRIVATE or UNLISTED and assets which are - * All Rights Reserved for the currently-authenticated user. + * @desc Lists assets authored by the given user. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of PRIVATE or UNLISTED and assets which are All Rights Reserved for the currently-authenticated user. * @alias poly.users.assets.list * @memberOf! () * @@ -820,36 +730,27 @@ export namespace poly_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Return only assets with the matching format. Acceptable values are: - * `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. + * Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. */ format?: string; /** - * A valid user id. Currently, only the special value 'me', representing the - * currently-authenticated user is supported. To use 'me', you must pass an - * OAuth token with the request. + * A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request. */ name?: string; /** - * Specifies an ordering for assets. Acceptable values are: `BEST`, - * `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a - * combination of popularity and other features. + * Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features. */ orderBy?: string; /** - * The maximum number of assets to be returned. This value must be between - * `1` and `100`. Defaults to `20`. + * The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`. */ pageSize?: number; /** - * Specifies a continuation token from a previous search whose results were - * split into multiple pages. To get the next page, submit the same request - * specifying the value from next_page_token. + * Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token. */ pageToken?: string; /** - * The visibility of the assets to be returned. Defaults to - * VISIBILITY_UNSPECIFIED which returns all assets. + * The visibility of the assets to be returned. Defaults to VISIBILITY_UNSPECIFIED which returns all assets. */ visibility?: string; } @@ -862,9 +763,7 @@ export namespace poly_v1 { /** * poly.users.likedassets.list - * @desc Lists assets that the user has liked. Only the value 'me', - * representing the currently-authenticated user, is supported. May include - * assets with an access level of UNLISTED. + * @desc Lists assets that the user has liked. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of UNLISTED. * @alias poly.users.likedassets.list * @memberOf! () * @@ -951,31 +850,23 @@ export namespace poly_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Return only assets with the matching format. Acceptable values are: - * `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`. + * Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`. */ format?: string; /** - * A valid user id. Currently, only the special value 'me', representing the - * currently-authenticated user is supported. To use 'me', you must pass an - * OAuth token with the request. + * A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request. */ name?: string; /** - * Specifies an ordering for assets. Acceptable values are: `BEST`, - * `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which ranks - * assets based on how recently they were liked. + * Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which ranks assets based on how recently they were liked. */ orderBy?: string; /** - * The maximum number of assets to be returned. This value must be between - * `1` and `100`. Defaults to `20`. + * The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`. */ pageSize?: number; /** - * Specifies a continuation token from a previous search whose results were - * split into multiple pages. To get the next page, submit the same request - * specifying the value from next_page_token. + * Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token. */ pageToken?: string; } diff --git a/src/apis/proximitybeacon/package.json b/src/apis/proximitybeacon/package.json index a50e7c8e02c..34370704c04 100644 --- a/src/apis/proximitybeacon/package.json +++ b/src/apis/proximitybeacon/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/proximitybeacon/v1beta1.ts b/src/apis/proximitybeacon/v1beta1.ts index d14ff091541..93cf195cd8b 100644 --- a/src/apis/proximitybeacon/v1beta1.ts +++ b/src/apis/proximitybeacon/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace proximitybeacon_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace proximitybeacon_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -115,7 +111,10 @@ export namespace proximitybeacon_v1beta1 { v1beta1: Resource$V1beta1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.beaconinfo = new Resource$Beaconinfo(this.context); this.beacons = new Resource$Beacons(this.context); @@ -129,11 +128,7 @@ export namespace proximitybeacon_v1beta1 { */ export interface Schema$AdvertisedId { /** - * The actual beacon identifier, as broadcast by the beacon hardware. Must - * be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP - * requests, and will be so encoded (with padding) in responses. The base64 - * encoding should be of the binary byte-stream and not any textual (such as - * hex) representation thereof. Required. + * The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required. */ id?: string; /** @@ -142,9 +137,7 @@ export namespace proximitybeacon_v1beta1 { type?: string; } /** - * A subset of attachment information served via the - * `beaconinfo.getforobserved` method, used when your users encounter your - * beacons. + * A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons. */ export interface Schema$AttachmentInfo { /** @@ -152,23 +145,11 @@ export namespace proximitybeacon_v1beta1 { */ data?: string; /** - * The distance away from the beacon at which this attachment should be - * delivered to a mobile app. Setting this to a value greater than zero - * indicates that the app should behave as if the beacon is "seen" - * when the mobile device is less than this distance away from the beacon. - * Different attachments on the same beacon can have different max - * distances. Note that even though this value is expressed with fractional - * meter precision, real-world behavior is likley to be much less precise - * than one meter, due to the nature of current Bluetooth radio technology. - * Optional. When not set or zero, the attachment should be delivered at the - * beacon's outer limit of detection. + * The distance away from the beacon at which this attachment should be delivered to a mobile app. Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon. Different attachments on the same beacon can have different max distances. Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology. Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection. */ maxDistanceMeters?: number; /** - * Specifies what kind of attachment this is. Tells a client how to - * interpret the `data` field. Format is - * <var>namespace/type</var>, for example - * <code>scrupulous-wombat-12345/welcome-message</code> + * Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is <var>namespace/type</var>, for example <code>scrupulous-wombat-12345/welcome-message</code> */ namespacedType?: string; } @@ -177,74 +158,43 @@ export namespace proximitybeacon_v1beta1 { */ export interface Schema$Beacon { /** - * The identifier of a beacon as advertised by it. This field must be - * populated when registering. It may be empty when updating a beacon record - * because it is ignored in updates. When registering a beacon that - * broadcasts Eddystone-EID, this field should contain a "stable" - * Eddystone-UID that identifies the beacon and links it to its attachments. - * The stable Eddystone-UID is only used for administering the beacon. + * The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon. */ advertisedId?: Schema$AdvertisedId; /** - * Resource name of this beacon. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID - * broadcast by the beacon and N is a code for the beacon's type. - * Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for - * AltBeacon. This field must be left empty when registering. After reading - * a beacon, clients can use the name for future operations. + * Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations. */ beaconName?: string; /** - * Free text used to identify and describe the beacon. Maximum length 140 - * characters. Optional. + * Free text used to identify and describe the beacon. Maximum length 140 characters. Optional. */ description?: string; /** - * Write-only registration parameters for beacons using Eddystone-EID - * (remotely resolved ephemeral ID) format. This information will not be - * populated in API responses. When submitting this data, the - * `advertised_id` field must contain an ID of type Eddystone-UID. Any other - * ID type will result in an error. + * Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error. */ ephemeralIdRegistration?: Schema$EphemeralIdRegistration; /** - * Expected location stability. This is set when the beacon is registered or - * updated, not automatically detected in any way. Optional. + * Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional. */ expectedStability?: string; /** - * The indoor level information for this beacon, if known. As returned by - * the Google Maps API. Optional. + * The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional. */ indoorLevel?: Schema$IndoorLevel; /** - * The location of the beacon, expressed as a latitude and longitude pair. - * This location is given when the beacon is registered or updated. It does - * not necessarily indicate the actual current location of the beacon. - * Optional. + * The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional. */ latLng?: Schema$LatLng; /** - * The [Google Places API](/places/place-id) Place ID of the place where the - * beacon is deployed. This is given when the beacon is registered or - * updated, not automatically detected in any way. Optional. + * The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional. */ placeId?: string; /** - * Properties of the beacon device, for example battery type or firmware - * version. Optional. + * Properties of the beacon device, for example battery type or firmware version. Optional. */ properties?: {[key: string]: string}; /** - * Some beacons may require a user to provide an authorization key before - * changing any of its configuration (e.g. broadcast frames, transmit - * power). This field provides a place to store and control access to that - * key. This field is populated in responses to `GET - * /v1beta1/beacons/3!beaconId` from users with write access to the given - * beacon. That is to say: If the user is authorized to write the - * beacon's confidential data in the service, the service considers them - * authorized to configure the beacon. Note that this key grants nothing on - * the service, only on the beacon itself. + * Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself. */ provisioningKey?: string; /** @@ -257,48 +207,28 @@ export namespace proximitybeacon_v1beta1 { */ export interface Schema$BeaconAttachment { /** - * Resource name of this attachment. Attachment names have the format: - * <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>. - * Leave this empty on creation. + * Resource name of this attachment. Attachment names have the format: <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>. Leave this empty on creation. */ attachmentName?: string; /** - * The UTC time when this attachment was created, in milliseconds since the - * UNIX epoch. + * The UTC time when this attachment was created, in milliseconds since the UNIX epoch. */ creationTimeMs?: string; /** - * An opaque data container for client-provided data. Must be - * [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP - * requests, and will be so encoded (with padding) in responses. Required. + * An opaque data container for client-provided data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. Required. */ data?: string; /** - * The distance away from the beacon at which this attachment should be - * delivered to a mobile app. Setting this to a value greater than zero - * indicates that the app should behave as if the beacon is "seen" - * when the mobile device is less than this distance away from the beacon. - * Different attachments on the same beacon can have different max - * distances. Note that even though this value is expressed with fractional - * meter precision, real-world behavior is likley to be much less precise - * than one meter, due to the nature of current Bluetooth radio technology. - * Optional. When not set or zero, the attachment should be delivered at the - * beacon's outer limit of detection. Negative values are invalid and - * return an error. + * The distance away from the beacon at which this attachment should be delivered to a mobile app. Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon. Different attachments on the same beacon can have different max distances. Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology. Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection. Negative values are invalid and return an error. */ maxDistanceMeters?: number; /** - * Specifies what kind of attachment this is. Tells a client how to - * interpret the `data` field. Format is - * <var>namespace/type</var>. Namespace provides type separation - * between clients. Type describes the type of `data`, for use by the client - * when parsing the `data` field. Required. + * Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is <var>namespace/type</var>. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required. */ namespacedType?: string; } /** - * A subset of beacon information served via the `beaconinfo.getforobserved` - * method, which you call when users of your app encounter your beacons. + * A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons. */ export interface Schema$BeaconInfo { /** @@ -306,8 +236,7 @@ export namespace proximitybeacon_v1beta1 { */ advertisedId?: Schema$AdvertisedId; /** - * Attachments matching the type(s) requested. May be empty if no attachment - * types were requested. + * Attachments matching the type(s) requested. May be empty if no attachment types were requested. */ attachments?: Schema$AttachmentInfo[]; /** @@ -316,30 +245,19 @@ export namespace proximitybeacon_v1beta1 { beaconName?: string; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } @@ -361,128 +279,70 @@ export namespace proximitybeacon_v1beta1 { */ alerts?: string[]; /** - * Resource name of the beacon. For Eddystone-EID beacons, this may be the - * beacon's current EID, or the beacon's "stable" - * Eddystone-UID. + * Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's "stable" Eddystone-UID. */ beaconName?: string; /** - * The date when the battery is expected to be low. If the value is missing - * then there is no estimate for when the battery will be low. This value is - * only an estimate, not an exact date. + * The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date. */ estimatedLowBatteryDate?: Schema$Date; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Write-only registration parameters for beacons using Eddystone-EID format. - * Two ways of securely registering an Eddystone-EID beacon with the service - * are supported: 1. Perform an ECDH key exchange via this API, including a - * previous call to `GET /v1beta1/eidparams`. In this case the fields - * `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated - * and `beacon_identity_key` should not be populated. This method ensures - * that only the two parties in the ECDH key exchange can compute the - * identity key, which becomes a secret between them. 2. Derive or obtain the - * beacon's identity key via other secure means (perhaps an ECDH key - * exchange between the beacon and a mobile device or any other secure - * method), and then submit the resulting identity key to the service. In - * this case `beacon_identity_key` field should be populated, and neither - * of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should - * be. The security of this method depends on how securely the parties - * involved (in particular the bluetooth client) handle the identity key, - * and obviously on how securely the identity key was generated. See [the - * Eddystone - * specification](https://github.com/google/eddystone/tree/master/eddystone-eid) - * at GitHub. + * Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. */ export interface Schema$EphemeralIdRegistration { /** - * The beacon's public key used for the Elliptic curve Diffie-Hellman - * key exchange. When this field is populated, `service_ecdh_public_key` - * must also be populated, and `beacon_identity_key` must not be. + * The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be. */ beaconEcdhPublicKey?: string; /** - * The private key of the beacon. If this field is populated, - * `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be - * populated. + * The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated. */ beaconIdentityKey?: string; /** - * The initial clock value of the beacon. The beacon's clock must have - * begun counting at this value immediately prior to transmitting this value - * to the resolving service. Significant delay in transmitting this value to - * the service risks registration or resolution failures. If a value is not - * provided, the default is zero. + * The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero. */ initialClockValue?: string; /** - * An initial ephemeral ID calculated using the clock value submitted as - * `initial_clock_value`, and the secret key generated by the Diffie-Hellman - * key exchange using `service_ecdh_public_key` and - * `service_ecdh_public_key`. This initial EID value will be used by the - * service to confirm that the key exchange process was successful. + * An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful. */ initialEid?: string; /** - * Indicates the nominal period between each rotation of the beacon's - * ephemeral ID. "Nominal" because the beacon should randomize the - * actual interval. See [the spec at - * github](https://github.com/google/eddystone/tree/master/eddystone-eid) - * for details. This value corresponds to a power-of-two scaler on the - * beacon's clock: when the scaler value is K, the beacon will begin - * broadcasting a new ephemeral ID on average every 2^K seconds. + * Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds. */ rotationPeriodExponent?: number; /** - * The service's public key used for the Elliptic curve Diffie-Hellman - * key exchange. When this field is populated, `beacon_ecdh_public_key` must - * also be populated, and `beacon_identity_key` must not be. + * The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be. */ serviceEcdhPublicKey?: string; } /** - * Information a client needs to provision and register beacons that broadcast - * Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key - * exchange. See [the Eddystone - * specification](https://github.com/google/eddystone/tree/master/eddystone-eid) - * at GitHub. + * Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub. */ export interface Schema$EphemeralIdRegistrationParams { /** - * Indicates the maximum rotation period supported by the service. See - * EddystoneEidRegistration.rotation_period_exponent + * Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent */ maxRotationPeriodExponent?: number; /** - * Indicates the minimum rotation period supported by the service. See - * EddystoneEidRegistration.rotation_period_exponent + * Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent */ minRotationPeriodExponent?: number; /** - * The beacon service's public key for use by a beacon to derive its - * Identity Key using Elliptic Curve Diffie-Hellman key exchange. + * The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange. */ serviceEcdhPublicKey?: string; } /** - * Request for beacon and attachment information about beacons that a mobile - * client has encountered "in the wild". + * Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild". */ export interface Schema$GetInfoForObservedBeaconsRequest { /** - * Specifies what kind of attachments to include in the response. When - * given, the response will include only attachments of the given types. - * When empty, no attachments will be returned. Must be in the format - * <var>namespace/type</var>. Accepts `*` to specify all types - * in all namespaces owned by the client. Optional. + * Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format <var>namespace/type</var>. Accepts `*` to specify all types in all namespaces owned by the client. Optional. */ namespacedTypes?: string[]; /** @@ -491,19 +351,16 @@ export namespace proximitybeacon_v1beta1 { observations?: Schema$Observation[]; } /** - * Information about the requested beacons, optionally including attachment - * data. + * Information about the requested beacons, optionally including attachment data. */ export interface Schema$GetInfoForObservedBeaconsResponse { /** - * Public information about beacons. May be empty if the request matched no - * beacons. + * Public information about beacons. May be empty if the request matched no beacons. */ beacons?: Schema$BeaconInfo[]; } /** - * Indoor level, a human-readable string as returned by Google Maps APIs, - * useful to indicate which floor of a building a beacon is located on. + * Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on. */ export interface Schema$IndoorLevel { /** @@ -512,11 +369,7 @@ export namespace proximitybeacon_v1beta1 { name?: string; } /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -529,8 +382,7 @@ export namespace proximitybeacon_v1beta1 { longitude?: number; } /** - * Response to `ListBeaconAttachments` that contains the requested - * attachments. + * Response to `ListBeaconAttachments` that contains the requested attachments. */ export interface Schema$ListBeaconAttachmentsResponse { /** @@ -547,13 +399,11 @@ export namespace proximitybeacon_v1beta1 { */ beacons?: Schema$Beacon[]; /** - * An opaque pagination token that the client may provide in their next - * request to retrieve the next page of results. + * An opaque pagination token that the client may provide in their next request to retrieve the next page of results. */ nextPageToken?: string; /** - * Estimate of the total number of beacons matched by the query. Higher - * values may be less accurate. + * Estimate of the total number of beacons matched by the query. Higher values may be less accurate. */ totalCount?: string; } @@ -566,14 +416,12 @@ export namespace proximitybeacon_v1beta1 { */ diagnostics?: Schema$Diagnostics[]; /** - * Token that can be used for pagination. Returned only if the request - * matches more beacons than can be returned in this response. + * Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response. */ nextPageToken?: string; } /** - * Response to ListNamespacesRequest that contains all the project's - * namespaces. + * Response to ListNamespacesRequest that contains all the project's namespaces. */ export interface Schema$ListNamespacesResponse { /** @@ -582,20 +430,15 @@ export namespace proximitybeacon_v1beta1 { namespaces?: Schema$Namespace[]; } /** - * An attachment namespace defines read and write access for all the - * attachments created under it. Each namespace is globally unique, and owned - * by one project which is the only project that can create attachments under - * it. + * An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it. */ export interface Schema$Namespace { /** - * Resource name of this namespace. Namespaces names have the format: - * <code>namespaces/<var>namespace</var></code>. + * Resource name of this namespace. Namespaces names have the format: <code>namespaces/<var>namespace</var></code>. */ namespaceName?: string; /** - * Specifies what clients may receive attachments under this namespace via - * `beaconinfo.getforobserved`. + * Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`. */ servingVisibility?: string; } @@ -604,16 +447,11 @@ export namespace proximitybeacon_v1beta1 { */ export interface Schema$Observation { /** - * The ID advertised by the beacon the client has encountered. If the - * submitted `advertised_id` type is Eddystone-EID, then the client must be - * authorized to resolve the given beacon. Otherwise no data will be - * returned for that beacon. Required. + * The ID advertised by the beacon the client has encountered. If the submitted `advertised_id` type is Eddystone-EID, then the client must be authorized to resolve the given beacon. Otherwise no data will be returned for that beacon. Required. */ advertisedId?: Schema$AdvertisedId; /** - * The array of telemetry bytes received from the beacon. The server is - * responsible for parsing it. This field may frequently be empty, as with a - * beacon that transmits telemetry only occasionally. + * The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally. */ telemetry?: string; /** @@ -630,11 +468,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beaconinfo.getforobserved - * @desc Given one or more beacon observations, returns any beacon - * information and attachments accessible to your application. Authorize by - * using the [API - * key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key) - * for the application. + * @desc Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key) for the application. * @alias proximitybeacon.beaconinfo.getforobserved * @memberOf! () * @@ -742,13 +576,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.activate - * @desc Activates a beacon. A beacon that is active will return information - * and attachment data when queried via `beaconinfo.getforobserved`. Calling - * this method on an already active beacon will do nothing (but will return - * a successful response code). Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.activate * @memberOf! () * @@ -821,14 +649,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.deactivate - * @desc Deactivates a beacon. Once deactivated, the API will not return - * information nor attachment data for the beacon when queried via - * `beaconinfo.getforobserved`. Calling this method on an already inactive - * beacon will do nothing (but will return a successful response code). - * Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.deactivate * @memberOf! () * @@ -902,13 +723,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.decommission - * @desc Decommissions the specified beacon in the service. This beacon will - * no longer be returned from `beaconinfo.getforobserved`. This operation is - * permanent -- you will not be able to re-register a beacon with this ID - * again. Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.decommission * @memberOf! () * @@ -982,13 +797,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.delete - * @desc Deletes the specified beacon including all diagnostics data for the - * beacon as well as any attachments on the beacon (including those - * belonging to other projects). This operation cannot be undone. - * Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the beacon (including those belonging to other projects). This operation cannot be undone. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.delete * @memberOf! () * @@ -1061,16 +870,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.get - * @desc Returns detailed information about the specified beacon. - * Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **viewer**, **Is owner** or **Can edit** permissions - * in the Google Developers Console project. Requests may supply an - * Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the - * `beaconId` is the base16 ephemeral ID broadcast by the beacon. The - * returned `Beacon` object will contain the beacon's stable Eddystone-UID. - * Clients not authorized to resolve the beacon's ephemeral Eddystone-EID - * broadcast will receive an error. + * @desc Returns detailed information about the specified beacon. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error. * @alias proximitybeacon.beacons.get * @memberOf! () * @@ -1143,12 +943,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.list - * @desc Searches the beacon registry for beacons that match the given - * search criteria. Only those beacons that the client has permission to - * list will be returned. Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **viewer**, **Is owner** or **Can edit** permissions - * in the Google Developers Console project. + * @desc Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.list * @memberOf! () * @@ -1222,12 +1017,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.register - * @desc Registers a previously unregistered beacon given its - * `advertisedId`. These IDs are unique within the system. An ID can be - * registered only once. Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.register * @memberOf! () * @@ -1300,16 +1090,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.update - * @desc Updates the information about the specified beacon. **Any field - * that you do not populate in the submitted beacon will be permanently - * erased**, so you should follow the "read, modify, write" pattern to avoid - * inadvertently destroying data. Changes to the beacon status via this - * method will be silently ignored. To update beacon status, use the - * separate methods on this API for activation, deactivation, and - * decommissioning. Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.update * @memberOf! () * @@ -1389,18 +1170,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Beacon that should be activated. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the - * beacon and N is a code for the beacon's type. Possible values are `3` for - * Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * or the beacon's "stable" UID. Required. + * Beacon that should be activated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. */ beaconName?: string; /** - * The project id of the beacon to activate. If the project id is not - * specified then the project making the request is used. The project id - * must match the project that owns the beacon. Optional. + * The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional. */ projectId?: string; } @@ -1412,18 +1186,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Beacon that should be deactivated. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the - * beacon and N is a code for the beacon's type. Possible values are `3` for - * Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * or the beacon's "stable" UID. Required. + * Beacon that should be deactivated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. */ beaconName?: string; /** - * The project id of the beacon to deactivate. If the project id is not - * specified then the project making the request is used. The project id - * must match the project that owns the beacon. Optional. + * The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional. */ projectId?: string; } @@ -1435,18 +1202,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Beacon that should be decommissioned. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the - * beacon and N is a code for the beacon's type. Possible values are `3` for - * Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * of the beacon's "stable" UID. Required. + * Beacon that should be decommissioned. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's "stable" UID. Required. */ beaconName?: string; /** - * The project id of the beacon to decommission. If the project id is not - * specified then the project making the request is used. The project id - * must match the project that owns the beacon. Optional. + * The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional. */ projectId?: string; } @@ -1457,17 +1217,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Beacon that should be deleted. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the - * beacon and N is a code for the beacon's type. Possible values are `3` for - * Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * or the beacon's "stable" UID. Required. + * Beacon that should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. */ beaconName?: string; /** - * The project id of the beacon to delete. If not provided, the project that - * is making the request is used. Optional. + * The project id of the beacon to delete. If not provided, the project that is making the request is used. Optional. */ projectId?: string; } @@ -1478,18 +1232,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of this beacon. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the - * beacon and N is a code for the beacon's type. Possible values are `3` for - * Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * or the beacon's "stable" UID. Required. + * Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. */ beaconName?: string; /** - * The project id of the beacon to request. If the project id is not - * specified then the project making the request is used. The project id - * must match the project that owns the beacon. Optional. + * The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional. */ projectId?: string; } @@ -1500,8 +1247,7 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of records to return for this request, up to a - * server-defined upper limit. + * The maximum number of records to return for this request, up to a server-defined upper limit. */ pageSize?: number; /** @@ -1509,61 +1255,11 @@ export namespace proximitybeacon_v1beta1 { */ pageToken?: string; /** - * The project id to list beacons under. If not present then the project - * credential that made the request is used as the project. Optional. + * The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional. */ projectId?: string; /** - * Filter query string that supports the following field filters: * - * **description:`""`** For example: **description:"Room 3"** - * Returns beacons whose description matches tokens in the string "Room 3" - * (not necessarily that exact string). The string must be double-quoted. - * * **status:``** For example: **status:active** Returns beacons - * whose status matches the given value. Values must be one of the - * Beacon.Status enum values (case insensitive). Accepts multiple filters - * which will be combined with OR logic. * **stability:``** For - * example: **stability:mobile** Returns beacons whose expected stability - * matches the given value. Values must be one of the Beacon.Stability - * enum values (case insensitive). Accepts multiple filters which will be - * combined with OR logic. * **place\_id:`""`** For example: - * **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="** Returns beacons explicitly - * registered at the given place, expressed as a Place ID obtained from - * [Google Places API](/places/place-id). Does not match places inside the - * given place. Does not consider the beacon's actual location (which may - * be different from its registered place). Accepts multiple filters that - * will be combined with OR logic. The place ID must be double-quoted. * - * **registration\_time`[<|>|<=|>=]`** For example: - * **registration\_time>=1433116800** Returns beacons whose registration - * time matches the given filter. Supports the operators: <, >, <=, and - * >=. Timestamp must be expressed as an integer number of seconds since - * midnight January 1, 1970 UTC. Accepts at most two filters that will be - * combined with AND logic, to support "between" semantics. If more than - * two are supplied, the latter ones are ignored. * **lat:` - * lng: radius:`** For example: **lat:51.1232343 - * lng:-1.093852 radius:1000** Returns beacons whose registered location - * is within the given circle. When any of these fields are given, all are - * required. Latitude and longitude must be decimal degrees between -90.0 - * and 90.0 and between -180.0 and 180.0 respectively. Radius must be an - * integer number of meters between 10 and 1,000,000 (1000 km). * - * **property:`"="`** For example: - * **property:"battery-type=CR2032"** Returns beacons which have a - * property of the given name and value. Supports multiple filters which - * will be combined with OR logic. The entire name=value string must be - * double-quoted as one string. * **attachment\_type:`""`** For - * example: **attachment_type:"my-namespace/my-type"** Returns beacons - * having at least one attachment of the given namespaced type. Supports - * "any within this namespace" via the partial wildcard syntax: - * "my-namespace/x". Supports multiple filters which will be combined with - * OR logic. The string must be double-quoted. * - * **indoor\_level:`""`** For example: **indoor\_level:"1"** - * Returns beacons which are located on the given indoor level. Accepts - * multiple filters that will be combined with OR logic. Multiple filters - * on the same field are combined with OR logic (except registration_time - * which is combined with AND logic). Multiple filters on different fields - * are combined with AND logic. Filters should be separated by spaces. As - * with any HTTP query string parameter, the whole filter expression must be - * URL-encoded. Example REST request: `GET - * /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000` + * Filter query string that supports the following field filters: * **description:`""`** For example: **description:"Room 3"** Returns beacons whose description matches tokens in the string "Room 3" (not necessarily that exact string). The string must be double-quoted. * **status:``** For example: **status:active** Returns beacons whose status matches the given value. Values must be one of the Beacon.Status enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * **stability:``** For example: **stability:mobile** Returns beacons whose expected stability matches the given value. Values must be one of the Beacon.Stability enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * **place\_id:`""`** For example: **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="** Returns beacons explicitly registered at the given place, expressed as a Place ID obtained from [Google Places API](/places/place-id). Does not match places inside the given place. Does not consider the beacon's actual location (which may be different from its registered place). Accepts multiple filters that will be combined with OR logic. The place ID must be double-quoted. * **registration\_time`[<|>|<=|>=]`** For example: **registration\_time>=1433116800** Returns beacons whose registration time matches the given filter. Supports the operators: <, >, <=, and >=. Timestamp must be expressed as an integer number of seconds since midnight January 1, 1970 UTC. Accepts at most two filters that will be combined with AND logic, to support "between" semantics. If more than two are supplied, the latter ones are ignored. * **lat:` lng: radius:`** For example: **lat:51.1232343 lng:-1.093852 radius:1000** Returns beacons whose registered location is within the given circle. When any of these fields are given, all are required. Latitude and longitude must be decimal degrees between -90.0 and 90.0 and between -180.0 and 180.0 respectively. Radius must be an integer number of meters between 10 and 1,000,000 (1000 km). * **property:`"="`** For example: **property:"battery-type=CR2032"** Returns beacons which have a property of the given name and value. Supports multiple filters which will be combined with OR logic. The entire name=value string must be double-quoted as one string. * **attachment\_type:`""`** For example: **attachment_type:"my-namespace/my-type"** Returns beacons having at least one attachment of the given namespaced type. Supports "any within this namespace" via the partial wildcard syntax: "my-namespace/x". Supports multiple filters which will be combined with OR logic. The string must be double-quoted. * **indoor\_level:`""`** For example: **indoor\_level:"1"** Returns beacons which are located on the given indoor level. Accepts multiple filters that will be combined with OR logic. Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces. As with any HTTP query string parameter, the whole filter expression must be URL-encoded. Example REST request: `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000` */ q?: string; } @@ -1574,9 +1270,7 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project id of the project the beacon will be registered to. If the - * project id is not specified then the project making the request is used. - * Optional. + * The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used. Optional. */ projectId?: string; @@ -1592,18 +1286,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of this beacon. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the - * beacon and N is a code for the beacon's type. Possible values are `3` for - * Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be - * left empty when registering. After reading a beacon, clients can use the - * name for future operations. + * Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations. */ beaconName?: string; /** - * The project id of the beacon to update. If the project id is not - * specified then the project making the request is used. The project id - * must match the project that owns the beacon. Optional. + * The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional. */ projectId?: string; @@ -1621,15 +1308,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.attachments.batchDelete - * @desc Deletes multiple attachments on a given beacon. This operation is - * permanent and cannot be undone. You can optionally specify - * `namespacedType` to choose which attachments should be deleted. If you do - * not specify `namespacedType`, all your attachments on the given beacon - * will be deleted. You also may explicitly specify `x/x` to delete all. - * Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `x/x` to delete all. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.attachments.batchDelete * @memberOf! () * @@ -1712,17 +1391,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.attachments.create - * @desc Associates the given data with the specified beacon. Attachment - * data must contain two parts:
                          • A namespaced type.
                          • The - * actual attachment data itself.
                          The namespaced type consists of - * two parts, the namespace and the type. The namespace must be one of the - * values returned by the `namespaces` endpoint, while the type can be a - * string of any characters except for the forward slash (`/`) up to 100 - * characters in length. Attachment data can be up to 1024 bytes long. - * Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Associates the given data with the specified beacon. Attachment data must contain two parts:
                          • A namespaced type.
                          • The actual attachment data itself.
                          The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.attachments.create * @memberOf! () * @@ -1799,14 +1468,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.attachments.delete - * @desc Deletes the specified attachment for the given beacon. Each - * attachment has a unique attachment name (`attachmentName`) which is - * returned when you fetch the attachment data via this API. You specify - * this with the delete request to control which attachment is removed. This - * operation cannot be undone. Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **Is owner** or **Can edit** permissions in the - * Google Developers Console project. + * @desc Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.attachments.delete * @memberOf! () * @@ -1880,15 +1542,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.attachments.list - * @desc Returns the attachments for the specified beacon that match the - * specified namespaced-type pattern. To control which namespaced types are - * returned, you add the `namespacedType` query parameter to the request. - * You must either use `x/x`, to return all attachments, or the namespace - * must be one of the ones returned from the `namespaces` endpoint. - * Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **viewer**, **Is owner** or **Can edit** permissions - * in the Google Developers Console project. + * @desc Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `x/x`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.attachments.list * @memberOf! () * @@ -1981,26 +1635,15 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The beacon whose attachments should be deleted. A beacon name has the - * format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast - * by the beacon and N is a code for the beacon's type. Possible values are - * `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * or the beacon's "stable" UID. Required. + * The beacon whose attachments should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. */ beaconName?: string; /** - * Specifies the namespace and type of attachments to delete in - * `namespace/type` format. Accepts `x/x` to specify "all types in all - * namespaces". Optional. + * Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `x/x` to specify "all types in all namespaces". Optional. */ namespacedType?: string; /** - * The project id to delete beacon attachments under. This field can be used - * when "*" is specified to mean all attachment namespaces. Projects may - * have multiple attachments with multiple namespaces. If "*" is specified - * and the projectId string is empty, then the project making the request is - * used. Optional. + * The project id to delete beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional. */ projectId?: string; } @@ -2012,18 +1655,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Beacon on which the attachment should be created. A beacon name has the - * format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast - * by the beacon and N is a code for the beacon's type. Possible values are - * `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * or the beacon's "stable" UID. Required. + * Beacon on which the attachment should be created. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. */ beaconName?: string; /** - * The project id of the project the attachment will belong to. If the - * project id is not specified then the project making the request is used. - * Optional. + * The project id of the project the attachment will belong to. If the project id is not specified then the project making the request is used. Optional. */ projectId?: string; @@ -2040,16 +1676,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The attachment name (`attachmentName`) of the attachment to remove. For - * example: - * `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For - * Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the - * beacon's current EID, or its "stable" Eddystone-UID. Required. + * The attachment name (`attachmentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the beacon's current EID, or its "stable" Eddystone-UID. Required. */ attachmentName?: string; /** - * The project id of the attachment to delete. If not provided, the project - * that is making the request is used. Optional. + * The project id of the attachment to delete. If not provided, the project that is making the request is used. Optional. */ projectId?: string; } @@ -2061,26 +1692,15 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Beacon whose attachments should be fetched. A beacon name has the format - * "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the - * beacon and N is a code for the beacon's type. Possible values are `3` for - * Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for - * AltBeacon. For Eddystone-EID beacons, you may use either the current EID - * or the beacon's "stable" UID. Required. + * Beacon whose attachments should be fetched. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required. */ beaconName?: string; /** - * Specifies the namespace and type of attachment to include in response in - * namespace/type format. Accepts `x/x` to specify "all types in - * all namespaces". + * Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `x/x` to specify "all types in all namespaces". */ namespacedType?: string; /** - * The project id to list beacon attachments under. This field can be used - * when "*" is specified to mean all attachment namespaces. Projects may - * have multiple attachments with multiple namespaces. If "*" is specified - * and the projectId string is empty, then the project making the request is - * used. Optional. + * The project id to list beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional. */ projectId?: string; } @@ -2093,13 +1713,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.beacons.diagnostics.list - * @desc List the diagnostics for a single beacon. You can also list - * diagnostics for all the beacons owned by your Google Developers Console - * project by using the beacon name `beacons/-`. Authenticate using an - * [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **viewer**, **Is owner** or **Can edit** permissions - * in the Google Developers Console project. + * @desc List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.beacons.diagnostics.list * @memberOf! () * @@ -2187,8 +1801,7 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Requests only beacons that have the given alert. For example, to find - * beacons that have low batteries use `alert_filter=LOW_BATTERY`. + * Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`. */ alertFilter?: string; /** @@ -2196,19 +1809,15 @@ export namespace proximitybeacon_v1beta1 { */ beaconName?: string; /** - * Specifies the maximum number of results to return. Defaults to 10. - * Maximum 1000. Optional. + * Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional. */ pageSize?: number; /** - * Requests results that occur after the `page_token`, obtained from the - * response to a previous request. Optional. + * Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional. */ pageToken?: string; /** - * Requests only diagnostic records for the given project id. If not set, - * then the project making the request will be used for looking up - * diagnostic records. Optional. + * Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. Optional. */ projectId?: string; } @@ -2221,13 +1830,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.namespaces.list - * @desc Lists all attachment namespaces owned by your Google Developers - * Console project. Attachment data associated with a beacon must include a - * namespaced type, and the namespace must be owned by your project. - * Authenticate using an [OAuth access - * token](https://developers.google.com/identity/protocols/OAuth2) from a - * signed-in user with **viewer**, **Is owner** or **Can edit** permissions - * in the Google Developers Console project. + * @desc Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. * @alias proximitybeacon.namespaces.list * @memberOf! () * @@ -2303,8 +1906,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.namespaces.update - * @desc Updates the information about the specified namespace. Only the - * namespace visibility can be updated. + * @desc Updates the information about the specified namespace. Only the namespace visibility can be updated. * @alias proximitybeacon.namespaces.update * @memberOf! () * @@ -2399,14 +2001,11 @@ export namespace proximitybeacon_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of this namespace. Namespaces names have the format: - * namespaces/namespace. + * Resource name of this namespace. Namespaces names have the format: namespaces/namespace. */ namespaceName?: string; /** - * The project id of the namespace to update. If the project id is not - * specified then the project making the request is used. The project id - * must match the project that owns the beacon. Optional. + * The project id of the namespace to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional. */ projectId?: string; @@ -2424,13 +2023,7 @@ export namespace proximitybeacon_v1beta1 { /** * proximitybeacon.getEidparams - * @desc Gets the Proximity Beacon API's current public key and associated - * parameters used to initiate the Diffie-Hellman key exchange required to - * register a beacon that broadcasts the Eddystone-EID format. This key - * changes periodically; clients may cache it and re-use the same public key - * to provision and register multiple beacons. However, clients should be - * prepared to refresh this key when they encounter an error registering an - * Eddystone-EID beacon. + * @desc Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon. * @alias proximitybeacon.getEidparams * @memberOf! () * diff --git a/src/apis/pubsub/package.json b/src/apis/pubsub/package.json index 0c7f98df2f9..62ea77efe6c 100644 --- a/src/apis/pubsub/package.json +++ b/src/apis/pubsub/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 0b5edf16fd1..6690da33228 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace pubsub_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace pubsub_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace pubsub_v1 { /** * Cloud Pub/Sub API * - * Provides reliable, many-to-many, asynchronous messaging between - * applications. + * Provides reliable, many-to-many, asynchronous messaging between applications. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace pubsub_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,8 +122,7 @@ export namespace pubsub_v1 { */ export interface Schema$AcknowledgeRequest { /** - * The acknowledgment ID for the messages being acknowledged that was - * returned by the Pub/Sub system in the `Pull` response. Must not be empty. + * The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. */ ackIds?: string[]; } @@ -134,30 +131,15 @@ export namespace pubsub_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -166,72 +148,45 @@ export namespace pubsub_v1 { */ export interface Schema$CreateSnapshotRequest { /** - * See <a - * href="https://cloud.google.com/pubsub/docs/labels"> Creating - * and managing labels</a>. + * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ labels?: {[key: string]: string}; /** - * The subscription whose backlog the snapshot retains. Specifically, the - * created snapshot is guaranteed to retain: (a) The existing backlog on - * the subscription. More precisely, this is defined as the messages in - * the subscription's backlog that are unacknowledged upon the - * successful completion of the `CreateSnapshot` request; as well as: - * (b) Any messages published to the subscription's topic following the - * successful completion of the CreateSnapshot request. Format is - * `projects/{project}/subscriptions/{sub}`. + * The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A policy that specifies the conditions for resource expiration (i.e., - * automatic resource deletion). + * A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion). */ export interface Schema$ExpirationPolicy { /** - * Specifies the "time-to-live" duration for an associated - * resource. The resource expires if it is not active for a period of `ttl`. - * The definition of "activity" depends on the type of the - * associated resource. The minimum and maximum allowed values for `ttl` - * depend on the type of the associated resource, as well. If `ttl` is not - * set, the associated resource never expires. + * Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of `ttl`. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for `ttl` depend on the type of the associated resource, as well. If `ttl` is not set, the associated resource never expires. */ ttl?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -240,8 +195,7 @@ export namespace pubsub_v1 { */ export interface Schema$ListSnapshotsResponse { /** - * If not empty, indicates that there may be more snapshot that match the - * request; this value should be passed in a new `ListSnapshotsRequest`. + * If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`. */ nextPageToken?: string; /** @@ -254,9 +208,7 @@ export namespace pubsub_v1 { */ export interface Schema$ListSubscriptionsResponse { /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new - * `ListSubscriptionsRequest` to get more subscriptions. + * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions. */ nextPageToken?: string; /** @@ -269,9 +221,7 @@ export namespace pubsub_v1 { */ export interface Schema$ListTopicSnapshotsResponse { /** - * If not empty, indicates that there may be more snapshots that match the - * request; this value should be passed in a new `ListTopicSnapshotsRequest` - * to get more snapshots. + * If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new `ListTopicSnapshotsRequest` to get more snapshots. */ nextPageToken?: string; /** @@ -284,8 +234,7 @@ export namespace pubsub_v1 { */ export interface Schema$ListTopicsResponse { /** - * If not empty, indicates that there may be more topics that match the - * request; this value should be passed in a new `ListTopicsRequest`. + * If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`. */ nextPageToken?: string; /** @@ -298,9 +247,7 @@ export namespace pubsub_v1 { */ export interface Schema$ListTopicSubscriptionsResponse { /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new - * `ListTopicSubscriptionsRequest` to get more subscriptions. + * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions. */ nextPageToken?: string; /** @@ -313,14 +260,7 @@ export namespace pubsub_v1 { */ export interface Schema$ModifyAckDeadlineRequest { /** - * The new ack deadline with respect to the time this request was sent to - * the Pub/Sub system. For example, if the value is 10, the new ack deadline - * will expire 10 seconds after the `ModifyAckDeadline` call was made. - * Specifying zero might immediately make the message available for delivery - * to another subscriber client. This typically results in an increase in - * the rate of message redeliveries (that is, duplicates). The minimum - * deadline you can specify is 0 seconds. The maximum deadline you can - * specify is 600 seconds (10 minutes). + * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes). */ ackDeadlineSeconds?: number; /** @@ -333,73 +273,33 @@ export namespace pubsub_v1 { */ export interface Schema$ModifyPushConfigRequest { /** - * The push configuration for future deliveries. An empty `pushConfig` - * indicates that the Pub/Sub system should stop pushing messages from the - * given subscription and allow messages to be pulled and acknowledged - - * effectively pausing the subscription if `Pull` or `StreamingPull` is not - * called. + * The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called. */ pushConfig?: Schema$PushConfig; } /** - * Contains information needed for generating an [OpenID Connect - * token](https://developers.google.com/identity/protocols/OpenIDConnect). + * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). */ export interface Schema$OidcToken { /** - * Audience to be used when generating OIDC token. The audience claim - * identifies the recipients that the JWT is intended for. The audience - * value is a single case-sensitive string. Having multiple values (array) - * for the audience field is not supported. More info about the OIDC JWT - * token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - * Note: if not specified, the Push endpoint URL will be used. + * Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used. */ audience?: string; /** - * [Service account - * email](https://cloud.google.com/iam/docs/service-accounts) to be used for - * generating the OIDC token. The caller (for CreateSubscription, - * UpdateSubscription, and ModifyPushConfig RPCs) must have the - * iam.serviceAccounts.actAs permission for the service account. + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account. */ serviceAccountEmail?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -421,21 +321,12 @@ export namespace pubsub_v1 { */ export interface Schema$PublishResponse { /** - * The server-assigned ID of each published message, in the same order as - * the messages in the request. IDs are guaranteed to be unique within the - * topic. + * The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic. */ messageIds?: string[]; } /** - * A message that is published by publishers and consumed by subscribers. The - * message must contain either a non-empty data field or at least one - * attribute. Note that client libraries represent this object differently - * depending on the language. See the corresponding <a - * href="https://cloud.google.com/pubsub/docs/reference/libraries">client - * library documentation</a> for more information. See <a - * href="https://cloud.google.com/pubsub/quotas">Quotas and - * limits</a> for more information about message limits. + * A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> for more information about message limits. */ export interface Schema$PubsubMessage { /** @@ -443,21 +334,15 @@ export namespace pubsub_v1 { */ attributes?: {[key: string]: string}; /** - * The message data field. If this field is empty, the message must contain - * at least one attribute. + * The message data field. If this field is empty, the message must contain at least one attribute. */ data?: string; /** - * ID of this message, assigned by the server when the message is published. - * Guaranteed to be unique within the topic. This value may be read by a - * subscriber that receives a `PubsubMessage` via a `Pull` call or a push - * delivery. It must not be populated by the publisher in a `Publish` call. + * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ messageId?: string; /** - * The time at which the message was published, populated by the server when - * it receives the `Publish` call. It must not be populated by the publisher - * in a `Publish` call. + * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ publishTime?: string; } @@ -466,15 +351,11 @@ export namespace pubsub_v1 { */ export interface Schema$PullRequest { /** - * The maximum number of messages returned for this request. The Pub/Sub - * system may return fewer than the number specified. + * The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified. */ maxMessages?: number; /** - * If this field set to true, the system will respond immediately even if it - * there are no messages available to return in the `Pull` response. - * Otherwise, the system may wait (for a bounded amount of time) until at - * least one message is available, rather than returning no messages. + * If this field set to true, the system will respond immediately even if it there are no messages available to return in the `Pull` response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. */ returnImmediately?: boolean; } @@ -483,10 +364,7 @@ export namespace pubsub_v1 { */ export interface Schema$PullResponse { /** - * Received Pub/Sub messages. The list will be empty if there are no more - * messages available in the backlog. For JSON, the response can be entirely - * empty. The Pub/Sub system may return fewer than the `maxMessages` - * requested even if there are more messages available in the backlog. + * Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog. */ receivedMessages?: Schema$ReceivedMessage[]; } @@ -495,32 +373,15 @@ export namespace pubsub_v1 { */ export interface Schema$PushConfig { /** - * Endpoint configuration attributes. Every endpoint has a set of API - * supported attributes that can be used to control different aspects of the - * message delivery. The currently supported attribute is `x-goog-version`, - * which you can use to change the format of the pushed message. This - * attribute indicates the version of the data expected by the endpoint. - * This controls the shape of the pushed message (i.e., its fields and - * metadata). The endpoint version is based on the version of the Pub/Sub - * API. If not present during the `CreateSubscription` call, it will - * default to the version of the API used to make such call. If not present - * during a `ModifyPushConfig` call, its value will not be changed. - * `GetSubscription` calls will always return a valid version, even if the - * subscription was created without this attribute. The possible values for - * this attribute are: * `v1beta1`: uses the push format defined in the - * v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in - * the v1 Pub/Sub API. + * Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. */ attributes?: {[key: string]: string}; /** - * If specified, Pub/Sub will generate and attach an OIDC JWT token as an - * `Authorization` header in the HTTP request for every pushed message. + * If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. */ oidcToken?: Schema$OidcToken; /** - * A URL locating the endpoint to which messages should be pushed. For - * example, a Webhook endpoint might use - * "https://example.com/push". + * A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". */ pushEndpoint?: string; } @@ -542,22 +403,11 @@ export namespace pubsub_v1 { */ export interface Schema$SeekRequest { /** - * The snapshot to seek to. The snapshot's topic must be the same as - * that of the provided subscription. Format is - * `projects/{project}/snapshots/{snap}`. + * The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is `projects/{project}/snapshots/{snap}`. */ snapshot?: string; /** - * The time to seek to. Messages retained in the subscription that were - * published before this time are marked as acknowledged, and messages - * retained in the subscription that were published after this time are - * marked as unacknowledged. Note that this operation affects only those - * messages retained in the subscription (configured by the combination of - * `message_retention_duration` and `retain_acked_messages`). For example, - * if `time` corresponds to a point before the message retention window (or - * to a point before the system's notion of the subscription creation - * time), only retained messages will be marked as unacknowledged, and - * already-expunged messages will not be restored. + * The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of `message_retention_duration` and `retain_acked_messages`). For example, if `time` corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored. */ time?: string; } @@ -570,38 +420,20 @@ export namespace pubsub_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } /** - * A snapshot resource. Snapshots are used in <a - * href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> - * operations, which allow you to manage message acknowledgments in bulk. That - * is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot. + * A snapshot resource. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. */ export interface Schema$Snapshot { /** - * The snapshot is guaranteed to exist up until this time. A newly-created - * snapshot expires no later than 7 days from the time of its creation. Its - * exact lifetime is determined at creation by the existing backlog in the - * source subscription. Specifically, the lifetime of the snapshot is `7 - * days - (age of oldest unacked message in the subscription)`. For example, - * consider a subscription whose oldest unacked message is 3 days old. If a - * snapshot is created from this subscription, the snapshot -- which will - * always capture this 3-day-old backlog as long as the snapshot exists -- - * will expire in 4 days. The service will refuse to create a snapshot that - * would expire in less than 1 hour after creation. + * The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation. */ expireTime?: string; /** - * See <a - * href="https://cloud.google.com/pubsub/docs/labels"> Creating - * and managing labels</a>. + * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ labels?: {[key: string]: string}; /** @@ -618,80 +450,35 @@ export namespace pubsub_v1 { */ export interface Schema$Subscription { /** - * The approximate amount of time (on a best-effort basis) Pub/Sub waits for - * the subscriber to acknowledge receipt before resending the message. In - * the interval after the message is delivered and before it is - * acknowledged, it is considered to be <i>outstanding</i>. - * During that time period, the message will not be redelivered (on a - * best-effort basis). For pull subscriptions, this value is used as the - * initial value for the ack deadline. To override this value for a given - * message, call `ModifyAckDeadline` with the corresponding `ack_id` if - * using non-streaming pull or send the `ack_id` in a - * `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum - * custom deadline you can specify is 10 seconds. The maximum custom - * deadline you can specify is 600 seconds (10 minutes). If this parameter - * is 0, a default value of 10 seconds is used. For push delivery, this - * value is also used to set the request timeout for the call to the push - * endpoint. If the subscriber never acknowledges the message, the Pub/Sub - * system will eventually redeliver the message. + * The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be <i>outstanding</i>. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. */ ackDeadlineSeconds?: number; /** - * A policy that specifies the conditions for this subscription's - * expiration. A subscription is considered active as long as any connected - * subscriber is successfully consuming messages from the subscription or is - * issuing operations on the subscription. If `expiration_policy` is not - * set, a *default policy* with `ttl` of 31 days will be used. The minimum - * allowed value for `expiration_policy.ttl` is 1 day. - * <b>BETA:</b> This feature is part of a beta release. This API - * might be changed in backward-incompatible ways and is not recommended for - * production use. It is not subject to any SLA or deprecation policy. + * A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. */ expirationPolicy?: Schema$ExpirationPolicy; /** - * See <a - * href="https://cloud.google.com/pubsub/docs/labels"> Creating - * and managing labels</a>. + * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ labels?: {[key: string]: string}; /** - * How long to retain unacknowledged messages in the subscription's - * backlog, from the moment a message is published. If - * `retain_acked_messages` is true, then this also configures the retention - * of acknowledged messages, and thus configures how far back in time a - * `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or - * less than 10 minutes. + * How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. */ messageRetentionDuration?: string; /** - * The name of the subscription. It must have the format - * `"projects/{project}/subscriptions/{subscription}"`. - * `{subscription}` must start with a letter, and contain only letters - * (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods - * (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be - * between 3 and 255 characters in length, and it must not start with - * `"goog"`. + * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; /** - * If push delivery is used with this subscription, this field is used to - * configure it. An empty `pushConfig` signifies that the subscriber will - * pull and ack messages using API methods. + * If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. */ pushConfig?: Schema$PushConfig; /** - * Indicates whether to retain acknowledged messages. If true, then messages - * are not expunged from the subscription's backlog, even if they are - * acknowledged, until they fall out of the `message_retention_duration` - * window. This must be true if you would like to <a - * href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> - * Seek to a timestamp</a>. + * Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to <a href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> Seek to a timestamp</a>. */ retainAckedMessages?: boolean; /** - * The name of the topic from which this subscription is receiving messages. - * Format is `projects/{project}/topics/{topic}`. The value of this field - * will be `_deleted-topic_` if the topic has been deleted. + * The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. */ topic?: string; } @@ -700,10 +487,7 @@ export namespace pubsub_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -712,8 +496,7 @@ export namespace pubsub_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -722,18 +505,11 @@ export namespace pubsub_v1 { */ export interface Schema$Topic { /** - * See <a - * href="https://cloud.google.com/pubsub/docs/labels"> Creating - * and managing labels</a>. + * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ labels?: {[key: string]: string}; /** - * The name of the topic. It must have the format - * `"projects/{project}/topics/{topic}"`. `{topic}` must start - * with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), - * dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) - * or percent signs (`%`). It must be between 3 and 255 characters in - * length, and it must not start with `"goog"`. + * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; } @@ -746,8 +522,7 @@ export namespace pubsub_v1 { */ snapshot?: Schema$Snapshot; /** - * Indicates which fields in the provided snapshot to update. Must be - * specified and non-empty. + * Indicates which fields in the provided snapshot to update. Must be specified and non-empty. */ updateMask?: string; } @@ -760,8 +535,7 @@ export namespace pubsub_v1 { */ subscription?: Schema$Subscription; /** - * Indicates which fields in the provided subscription to update. Must be - * specified and non-empty. + * Indicates which fields in the provided subscription to update. Must be specified and non-empty. */ updateMask?: string; } @@ -774,11 +548,7 @@ export namespace pubsub_v1 { */ topic?: Schema$Topic; /** - * Indicates which fields in the provided topic to update. Must be specified - * and non-empty. Note that if `update_mask` contains - * "message_storage_policy" then the new value will be determined - * based on the policy configured at the project or organization level. The - * `message_storage_policy` must not be set in the `topic` provided above. + * Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The `message_storage_policy` must not be set in the `topic` provided above. */ updateMask?: string; } @@ -804,22 +574,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.create - * @desc Creates a snapshot from the requested subscription. Snapshots are - * used in Seek - * operations, which allow you to manage message acknowledgments in bulk. - * That is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot.

                          If the snapshot - * already exists, returns `ALREADY_EXISTS`. If the requested subscription - * doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is - * too old -- and the resulting snapshot would expire in less than 1 hour -- - * then `FAILED_PRECONDITION` is returned. See also the - * `Snapshot.expire_time` field. If the name is not provided in the request, - * the server will assign a random name for this snapshot on the same - * project as the subscription, conforming to the [resource name - * format](https://cloud.google.com/pubsub/docs/admin#resource_names). The - * generated name is populated in the returned Snapshot object. Note that - * for REST API requests, you must specify a name in the request. + * @desc Creates a snapshot from the requested subscription. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

                          If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. * @alias pubsub.projects.snapshots.create * @memberOf! () * @@ -889,16 +644,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.delete - * @desc Removes an existing snapshot. Snapshots are used in Seek - * operations, which allow you to manage message acknowledgments in bulk. - * That is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot.

                          When the - * snapshot is deleted, all messages retained in the snapshot are - * immediately dropped. After a snapshot is deleted, a new one may be - * created with the same name, but the new one has no association with the - * old snapshot or its subscription, unless the same subscription is - * specified. + * @desc Removes an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

                          When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified. * @alias pubsub.projects.snapshots.delete * @memberOf! () * @@ -967,11 +713,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.get - * @desc Gets the configuration details of a snapshot. Snapshots are used in - * Seek - * operations, which allow you to manage message acknowledgments in bulk. - * That is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot. + * @desc Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. * @alias pubsub.projects.snapshots.get * @memberOf! () * @@ -1040,22 +782,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1065,15 +804,16 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/snapshots/my-snapshot', // TODO: - * Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/snapshots/my-snapshot', // TODO: Update placeholder value. * * auth: authClient, * }; * - * pubsub.projects.snapshots.getIamPolicy(request, function(err, response) - * { if (err) { console.error(err); return; + * pubsub.projects.snapshots.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1087,10 +827,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1166,11 +905,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.list - * @desc Lists the existing snapshots. Snapshots are used in Seek - * operations, which allow you to manage message acknowledgments in bulk. - * That is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot. + * @desc Lists the existing snapshots. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. * @alias pubsub.projects.snapshots.list * @memberOf! () * @@ -1248,11 +983,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.patch - * @desc Updates an existing snapshot. Snapshots are used in Seek - * operations, which allow you to manage message acknowledgments in bulk. - * That is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot. + * @desc Updates an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. * @alias pubsub.projects.snapshots.patch * @memberOf! () * @@ -1322,22 +1053,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1347,9 +1075,8 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/snapshots/my-snapshot', // TODO: - * Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/snapshots/my-snapshot', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1358,8 +1085,10 @@ export namespace pubsub_v1 { * auth: authClient, * }; * - * pubsub.projects.snapshots.setIamPolicy(request, function(err, response) - * { if (err) { console.error(err); return; + * pubsub.projects.snapshots.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1373,10 +1102,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1453,25 +1181,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1480,11 +1202,9 @@ export namespace pubsub_v1 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/snapshots/my-snapshot', // TODO: - * Update placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/snapshots/my-snapshot', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1493,8 +1213,10 @@ export namespace pubsub_v1 { * auth: authClient, * }; * - * pubsub.projects.snapshots.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * pubsub.projects.snapshots.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1508,10 +1230,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1604,12 +1325,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional user-provided name for this snapshot. If the name is not - * provided in the request, the server will assign a random name for this - * snapshot on the same project as the subscription. Note that for REST API - * requests, you must specify a name. See the - * resource name rules. Format is `projects/{project}/snapshots/{snap}`. + * Optional user-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. */ name?: string; @@ -1626,8 +1342,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the snapshot to delete. Format is - * `projects/{project}/snapshots/{snap}`. + * The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`. */ snapshot?: string; } @@ -1639,8 +1354,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the snapshot to get. Format is - * `projects/{project}/snapshots/{snap}`. + * The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`. */ snapshot?: string; } @@ -1652,8 +1366,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1669,14 +1382,11 @@ export namespace pubsub_v1 { */ pageSize?: number; /** - * The value returned by the last `ListSnapshotsResponse`; indicates that - * this is a continuation of a prior `ListSnapshots` call, and that the - * system should return the next page of data. + * The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data. */ pageToken?: string; /** - * The name of the project in which to list snapshots. Format is - * `projects/{project-id}`. + * The name of the project in which to list snapshots. Format is `projects/{project-id}`. */ project?: string; } @@ -1705,8 +1415,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1723,8 +1432,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1742,25 +1450,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.acknowledge - * @desc Acknowledges the messages associated with the `ack_ids` in the - * `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages - * from the subscription. Acknowledging a message whose ack deadline has - * expired may succeed, but such a message may be redelivered later. - * Acknowledging a message more than once will not result in an error. + * @desc Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1771,8 +1473,7 @@ export namespace pubsub_v1 { * var request = { * // The subscription whose message is being acknowledged. * // Format is `projects/{project}/subscriptions/{sub}`. - * subscription: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * subscription: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -1795,10 +1496,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1875,30 +1575,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.create - * @desc Creates a subscription to a given topic. See the - * resource name rules. If the subscription already exists, returns - * `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns - * `NOT_FOUND`. If the name is not provided in the request, the server will - * assign a random name for this subscription on the same project as the - * topic, conforming to the [resource name - * format](https://cloud.google.com/pubsub/docs/admin#resource_names). The - * generated name is populated in the returned Subscription object. Note - * that for REST API requests, you must specify a name in the request. + * @desc Creates a subscription to a given topic. See the resource name rules. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1908,21 +1597,15 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // The name of the subscription. It must have the format - * // `"projects/{project}/subscriptions/{subscription}"`. - * `{subscription}` must - * // start with a letter, and contain only letters (`[A-Za-z]`), - * numbers - * // (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes - * (`~`), - * // plus (`+`) or percent signs (`%`). It must be between 3 and 255 - * characters + * // `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must + * // start with a letter, and contain only letters (`[A-Za-z]`), numbers + * // (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), + * // plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters * // in length, and it must not start with `"goog"`. - * name: 'projects/my-project/subscriptions/my-subscription', // TODO: - * Update placeholder value. + * name: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -1946,10 +1629,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2025,25 +1707,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.delete - * @desc Deletes an existing subscription. All messages retained in the - * subscription are immediately dropped. Calls to `Pull` after deletion will - * return `NOT_FOUND`. After a subscription is deleted, a new one may be - * created with the same name, but the new one has no association with the - * old subscription or its topic unless the same topic is specified. + * @desc Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2054,8 +1730,7 @@ export namespace pubsub_v1 { * var request = { * // The subscription to delete. * // Format is `projects/{project}/subscriptions/{sub}`. - * subscription: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * subscription: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -2074,10 +1749,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2160,14 +1834,12 @@ export namespace pubsub_v1 { * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2178,8 +1850,7 @@ export namespace pubsub_v1 { * var request = { * // The name of the subscription to get. * // Format is `projects/{project}/subscriptions/{sub}`. - * subscription: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * subscription: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -2201,10 +1872,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2282,22 +1952,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2307,15 +1974,16 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * auth: authClient, * }; * - * pubsub.projects.subscriptions.getIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * pubsub.projects.subscriptions.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -2329,10 +1997,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2415,14 +2082,12 @@ export namespace pubsub_v1 { * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2449,9 +2114,8 @@ export namespace pubsub_v1 { * return; * } * for (var i = 0; i < subscriptionsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `subscriptionsPage`: console.log(JSON.stringify(subscriptionsPage[i], - * null, 2)); + * // TODO: Change code below to process each resource in `subscriptionsPage`: + * console.log(JSON.stringify(subscriptionsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -2469,10 +2133,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2559,25 +2222,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.modifyAckDeadline - * @desc Modifies the ack deadline for a specific message. This method is - * useful to indicate that more time is needed to process a message by the - * subscriber, or to make the message available for redelivery if the - * processing was interrupted. Note that this does not modify the - * subscription-level `ackDeadlineSeconds` used for subsequent messages. + * @desc Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2588,8 +2245,7 @@ export namespace pubsub_v1 { * var request = { * // The name of the subscription. * // Format is `projects/{project}/subscriptions/{sub}`. - * subscription: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * subscription: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2598,8 +2254,10 @@ export namespace pubsub_v1 { * auth: authClient, * }; * - * pubsub.projects.subscriptions.modifyAckDeadline(request, function(err) - * { if (err) { console.error(err); return; + * pubsub.projects.subscriptions.modifyAckDeadline(request, function(err) { + * if (err) { + * console.error(err); + * return; * } * }); * }); @@ -2610,10 +2268,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2690,25 +2347,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.modifyPushConfig - * @desc Modifies the `PushConfig` for a specified subscription. This may - * be used to change a push subscription to a pull one (signified by an - * empty `PushConfig`) or vice versa, or change the endpoint URL and other - * attributes of a push subscription. Messages will accumulate for delivery - * continuously through the call regardless of changes to the `PushConfig`. + * @desc Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2719,8 +2370,7 @@ export namespace pubsub_v1 { * var request = { * // The name of the subscription. * // Format is `projects/{project}/subscriptions/{sub}`. - * subscription: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * subscription: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2743,10 +2393,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2823,8 +2472,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.patch - * @desc Updates an existing subscription. Note that certain properties of a - * subscription, such as its topic, are not modifiable. + * @desc Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. * @alias pubsub.projects.subscriptions.patch * @memberOf! () * @@ -2896,23 +2544,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.pull - * @desc Pulls messages from the server. The server may return `UNAVAILABLE` - * if there are too many concurrent pull requests pending for the given - * subscription. + * @desc Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2923,8 +2567,7 @@ export namespace pubsub_v1 { * var request = { * // The subscription from which messages should be pulled. * // Format is `projects/{project}/subscriptions/{sub}`. - * subscription: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * subscription: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2950,10 +2593,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3032,13 +2674,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.seek - * @desc Seeks an existing subscription to a point in time or to a given - * snapshot, whichever is provided in the request. Snapshots are used in Seek - * operations, which allow you to manage message acknowledgments in bulk. - * That is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot. Note that both the - * subscription and the snapshot must be on the same topic. + * @desc Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic. * @alias pubsub.projects.subscriptions.seek * @memberOf! () * @@ -3113,22 +2749,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3138,9 +2771,8 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3149,8 +2781,10 @@ export namespace pubsub_v1 { * auth: authClient, * }; * - * pubsub.projects.subscriptions.setIamPolicy(request, function(err, - * response) { if (err) { console.error(err); return; + * pubsub.projects.subscriptions.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3164,10 +2798,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3244,25 +2877,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3271,11 +2898,9 @@ export namespace pubsub_v1 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/subscriptions/my-subscription', // - * TODO: Update placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -3284,8 +2909,10 @@ export namespace pubsub_v1 { * auth: authClient, * }; * - * pubsub.projects.subscriptions.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * pubsub.projects.subscriptions.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3299,10 +2926,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3395,8 +3021,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The subscription whose message is being acknowledged. Format is - * `projects/{project}/subscriptions/{sub}`. + * The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3413,12 +3038,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. It must have the format - * `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` - * must start with a letter, and contain only letters (`[A-Za-z]`), numbers - * (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - * plus (`+`) or percent signs (`%`). It must be between 3 and 255 - * characters in length, and it must not start with `"goog"`. + * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -3435,8 +3055,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The subscription to delete. Format is - * `projects/{project}/subscriptions/{sub}`. + * The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; } @@ -3448,8 +3067,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription to get. Format is - * `projects/{project}/subscriptions/{sub}`. + * The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; } @@ -3461,8 +3079,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -3478,14 +3095,11 @@ export namespace pubsub_v1 { */ pageSize?: number; /** - * The value returned by the last `ListSubscriptionsResponse`; indicates - * that this is a continuation of a prior `ListSubscriptions` call, and that - * the system should return the next page of data. + * The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data. */ pageToken?: string; /** - * The name of the project in which to list subscriptions. Format is - * `projects/{project-id}`. + * The name of the project in which to list subscriptions. Format is `projects/{project-id}`. */ project?: string; } @@ -3497,8 +3111,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. Format is - * `projects/{project}/subscriptions/{sub}`. + * The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3515,8 +3128,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. Format is - * `projects/{project}/subscriptions/{sub}`. + * The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3533,12 +3145,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. It must have the format - * `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` - * must start with a letter, and contain only letters (`[A-Za-z]`), numbers - * (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - * plus (`+`) or percent signs (`%`). It must be between 3 and 255 - * characters in length, and it must not start with `"goog"`. + * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -3555,8 +3162,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The subscription from which messages should be pulled. Format is - * `projects/{project}/subscriptions/{sub}`. + * The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3590,8 +3196,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3608,8 +3213,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3633,23 +3237,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.create - * @desc Creates the given topic with the given name. See the - * resource name rules. + * @desc Creates the given topic with the given name. See the resource name rules. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3659,21 +3259,15 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // The name of the topic. It must have the format - * // `"projects/{project}/topics/{topic}"`. `{topic}` must start with a - * letter, - * // and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes - * (`-`), - * // underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or - * percent - * // signs (`%`). It must be between 3 and 255 characters in length, - * and it + * // `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, + * // and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), + * // underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent + * // signs (`%`). It must be between 3 and 255 characters in length, and it * // must not start with `"goog"`. - * name: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * name: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -3697,10 +3291,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3774,26 +3367,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.delete - * @desc Deletes the topic with the given name. Returns `NOT_FOUND` if the - * topic does not exist. After a topic is deleted, a new topic may be - * created with the same name; this is an entirely new topic with none of - * the old configuration or subscriptions. Existing subscriptions to this - * topic are not deleted, but their `topic` field is set to - * `_deleted-topic_`. + * @desc Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3804,8 +3390,7 @@ export namespace pubsub_v1 { * var request = { * // Name of the topic to delete. * // Format is `projects/{project}/topics/{topic}`. - * topic: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * topic: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -3824,10 +3409,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3907,14 +3491,12 @@ export namespace pubsub_v1 { * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3925,8 +3507,7 @@ export namespace pubsub_v1 { * var request = { * // The name of the topic to get. * // Format is `projects/{project}/topics/{topic}`. - * topic: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * topic: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -3948,10 +3529,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4024,22 +3604,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4049,9 +3626,8 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -4073,10 +3649,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4159,14 +3734,12 @@ export namespace pubsub_v1 { * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4193,8 +3766,8 @@ export namespace pubsub_v1 { * return; * } * for (var i = 0; i < topicsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `topicsPage`: console.log(JSON.stringify(topicsPage[i], null, 2)); + * // TODO: Change code below to process each resource in `topicsPage`: + * console.log(JSON.stringify(topicsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -4212,10 +3785,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4295,8 +3867,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.patch - * @desc Updates an existing topic. Note that certain properties of a topic - * are not modifiable. + * @desc Updates an existing topic. Note that certain properties of a topic are not modifiable. * @alias pubsub.projects.topics.patch * @memberOf! () * @@ -4366,22 +3937,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.publish - * @desc Adds one or more messages to the topic. Returns `NOT_FOUND` if the - * topic does not exist. + * @desc Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4392,8 +3960,7 @@ export namespace pubsub_v1 { * var request = { * // The messages in the request will be published on this topic. * // Format is `projects/{project}/topics/{topic}`. - * topic: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * topic: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -4419,10 +3986,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4501,22 +4067,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4526,9 +4089,8 @@ export namespace pubsub_v1 { * authorize(function(authClient) { * var request = { * // REQUIRED: The resource for which the policy is being specified. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -4554,10 +4116,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4634,25 +4195,19 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4661,11 +4216,9 @@ export namespace pubsub_v1 { * * authorize(function(authClient) { * var request = { - * // REQUIRED: The resource for which the policy detail is being - * requested. - * // See the operation documentation for the appropriate value for this - * field. resource_: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -4674,8 +4227,10 @@ export namespace pubsub_v1 { * auth: authClient, * }; * - * pubsub.projects.topics.testIamPermissions(request, function(err, - * response) { if (err) { console.error(err); return; + * pubsub.projects.topics.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4689,10 +4244,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4785,12 +4339,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the topic. It must have the format - * `"projects/{project}/topics/{topic}"`. `{topic}` must start with a - * letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes - * (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or - * percent signs (`%`). It must be between 3 and 255 characters in length, - * and it must not start with `"goog"`. + * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -4807,8 +4356,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the topic to delete. Format is - * `projects/{project}/topics/{topic}`. + * Name of the topic to delete. Format is `projects/{project}/topics/{topic}`. */ topic?: string; } @@ -4820,8 +4368,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the topic to get. Format is - * `projects/{project}/topics/{topic}`. + * The name of the topic to get. Format is `projects/{project}/topics/{topic}`. */ topic?: string; } @@ -4833,8 +4380,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -4850,14 +4396,11 @@ export namespace pubsub_v1 { */ pageSize?: number; /** - * The value returned by the last `ListTopicsResponse`; indicates that this - * is a continuation of a prior `ListTopics` call, and that the system - * should return the next page of data. + * The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data. */ pageToken?: string; /** - * The name of the project in which to list topics. Format is - * `projects/{project-id}`. + * The name of the project in which to list topics. Format is `projects/{project-id}`. */ project?: string; } @@ -4869,12 +4412,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the topic. It must have the format - * `"projects/{project}/topics/{topic}"`. `{topic}` must start with a - * letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes - * (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or - * percent signs (`%`). It must be between 3 and 255 characters in length, - * and it must not start with `"goog"`. + * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -4891,8 +4429,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The messages in the request will be published on this topic. Format is - * `projects/{project}/topics/{topic}`. + * The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`. */ topic?: string; @@ -4909,8 +4446,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4927,8 +4463,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4946,12 +4481,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.snapshots.list - * @desc Lists the names of the snapshots on this topic. Snapshots are used - * in Seek - * operations, which allow you to manage message acknowledgments in bulk. - * That is, you can set the acknowledgment state of messages in an existing - * subscription to the state captured by a snapshot. + * @desc Lists the names of the snapshots on this topic. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. * @alias pubsub.projects.topics.snapshots.list * @memberOf! () * @@ -5045,14 +4575,11 @@ export namespace pubsub_v1 { */ pageSize?: number; /** - * The value returned by the last `ListTopicSnapshotsResponse`; indicates - * that this is a continuation of a prior `ListTopicSnapshots` call, and - * that the system should return the next page of data. + * The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data. */ pageToken?: string; /** - * The name of the topic that snapshots are attached to. Format is - * `projects/{project}/topics/{topic}`. + * The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`. */ topic?: string; } @@ -5072,14 +4599,12 @@ export namespace pubsub_v1 { * // 1. If not already done, enable the Google Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5090,8 +4615,7 @@ export namespace pubsub_v1 { * var request = { * // The name of the topic that subscriptions are attached to. * // Format is `projects/{project}/topics/{topic}`. - * topic: 'projects/my-project/topics/my-topic', // TODO: Update - * placeholder value. + * topic: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -5107,9 +4631,8 @@ export namespace pubsub_v1 { * return; * } * for (var i = 0; i < subscriptionsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `subscriptionsPage`: console.log(JSON.stringify(subscriptionsPage[i], - * null, 2)); + * // TODO: Change code below to process each resource in `subscriptionsPage`: + * console.log(JSON.stringify(subscriptionsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -5127,10 +4650,9 @@ export namespace pubsub_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5230,14 +4752,11 @@ export namespace pubsub_v1 { */ pageSize?: number; /** - * The value returned by the last `ListTopicSubscriptionsResponse`; - * indicates that this is a continuation of a prior `ListTopicSubscriptions` - * call, and that the system should return the next page of data. + * The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data. */ pageToken?: string; /** - * The name of the topic that subscriptions are attached to. Format is - * `projects/{project}/topics/{topic}`. + * The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`. */ topic?: string; } diff --git a/src/apis/pubsub/v1beta1a.ts b/src/apis/pubsub/v1beta1a.ts index a9c19bf6aba..290532c8376 100644 --- a/src/apis/pubsub/v1beta1a.ts +++ b/src/apis/pubsub/v1beta1a.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace pubsub_v1beta1a { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace pubsub_v1beta1a { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace pubsub_v1beta1a { /** * Cloud Pub/Sub API * - * Provides reliable, many-to-many, asynchronous messaging between - * applications. + * Provides reliable, many-to-many, asynchronous messaging between applications. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace pubsub_v1beta1a { topics: Resource$Topics; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.subscriptions = new Resource$Subscriptions(this.context); this.topics = new Resource$Topics(this.context); @@ -126,8 +124,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$AcknowledgeRequest { /** - * The acknowledgment ID for the message being acknowledged. This was - * returned by the Pub/Sub system in the Pull response. + * The acknowledgment ID for the message being acknowledged. This was returned by the Pub/Sub system in the Pull response. */ ackId?: string[]; /** @@ -136,14 +133,7 @@ export namespace pubsub_v1beta1a { subscription?: string; } /** - * An empty message that you can re-use to avoid defining duplicated empty - * messages in your project. A typical example is to use it as argument or the - * return value of a service API. For instance: service Foo { rpc Bar - * (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The - * difference between this one and net/rpc/empty-message.proto is that 1) The - * generated message here is in proto2 C++ API. 2) The proto2.Empty has - * minimum dependencies (no message_set or net/rpc dependencies) END - * GOOGLE-INTERNAL + * An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL */ export interface Schema$Empty {} /** @@ -151,19 +141,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$Label { /** - * The key of a label is a syntactically valid URL (as per RFC 1738) with - * the "scheme" and initial slashes omitted and with the - * additional restrictions noted below. Each key should be globally unique. - * The "host" portion is called the "namespace" and is - * not necessarily resolvable to a network endpoint. Instead, the namespace - * indicates what system or entity defines the semantics of the label. - * Namespaces do not restrict the set of objects to which a label may be - * associated. Keys are defined by the following grammar: key = - * hostname "/" kpath kpath = ksegment *[ "/" - * ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | - * "_" | "." ] where "hostname" and - * "alphadigit" are defined as in RFC 1738. Example key: - * spanner.google.com/universe + * The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe */ key?: string; /** @@ -180,9 +158,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$ListSubscriptionsResponse { /** - * If not empty, indicates that there are more subscriptions that match the - * request and this value should be passed to the next - * <code>ListSubscriptionsRequest</code> to continue. + * If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next <code>ListSubscriptionsRequest</code> to continue. */ nextPageToken?: string; /** @@ -195,9 +171,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$ListTopicsResponse { /** - * If not empty, indicates that there are more topics that match the - * request, and this value should be passed to the next - * <code>ListTopicsRequest</code> to continue. + * If not empty, indicates that there are more topics that match the request, and this value should be passed to the next <code>ListTopicsRequest</code> to continue. */ nextPageToken?: string; /** @@ -210,26 +184,19 @@ export namespace pubsub_v1beta1a { */ export interface Schema$ModifyAckDeadlineRequest { /** - * The new ack deadline with respect to the time this request was sent to - * the Pub/Sub system. Must be >= 0. For example, if the value is 10, the - * new ack deadline will expire 10 seconds after the ModifyAckDeadline call - * was made. Specifying zero may immediately make the message available for - * another pull request. + * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request. */ ackDeadlineSeconds?: number; /** - * The acknowledgment ID. Either this or ack_ids must be populated, not - * both. + * The acknowledgment ID. Either this or ack_ids must be populated, not both. */ ackId?: string; /** - * List of acknowledgment IDs. Either this field or ack_id should be - * populated, not both. + * List of acknowledgment IDs. Either this field or ack_id should be populated, not both. */ ackIds?: string[]; /** - * Next Index: 5 The name of the subscription from which messages are being - * pulled. + * Next Index: 5 The name of the subscription from which messages are being pulled. */ subscription?: string; } @@ -238,8 +205,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$ModifyPushConfigRequest { /** - * An empty <code>push_config</code> indicates that the Pub/Sub - * system should pause pushing messages from the given subscription. + * An empty <code>push_config</code> indicates that the Pub/Sub system should pause pushing messages from the given subscription. */ pushConfig?: Schema$PushConfig; /** @@ -265,9 +231,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$PublishBatchResponse { /** - * The server-assigned ID of each published message, in the same order as - * the messages in the request. IDs are guaranteed to be unique within the - * topic. + * The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic. */ messageIds?: string[]; } @@ -289,9 +253,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$PubsubEvent { /** - * Indicates that this subscription has been deleted. (Note that pull - * subscribers will always receive NOT_FOUND in response in their pull - * request on the subscription, rather than seeing this boolean.) + * Indicates that this subscription has been deleted. (Note that pull subscribers will always receive NOT_FOUND in response in their pull request on the subscription, rather than seeing this boolean.) */ deleted?: boolean; /** @@ -316,20 +278,15 @@ export namespace pubsub_v1beta1a { */ data?: string; /** - * Optional list of labels for this message. Keys in this collection must be - * unique. + * Optional list of labels for this message. Keys in this collection must be unique. */ label?: Schema$Label[]; /** - * ID of this message assigned by the server at publication time. Guaranteed - * to be unique within the topic. This value may be read by a subscriber - * that receives a PubsubMessage via a Pull call or a push delivery. It must - * not be populated by a publisher in a Publish call. + * ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call. */ messageId?: string; /** - * The time at which the message was published. The time is milliseconds - * since the UNIX epoch. + * The time at which the message was published. The time is milliseconds since the UNIX epoch. */ publishTime?: string; } @@ -338,16 +295,11 @@ export namespace pubsub_v1beta1a { */ export interface Schema$PullBatchRequest { /** - * The maximum number of PubsubEvents returned for this request. The Pub/Sub - * system may return fewer than the number of events specified. + * The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return fewer than the number of events specified. */ maxEvents?: number; /** - * If this is specified as true the system will respond immediately even if - * it is not able to return a message in the Pull response. Otherwise the - * system is allowed to wait until at least one message is available rather - * than returning no messages. The client may cancel the request if it does - * not wish to wait any longer for the response. + * If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. */ returnImmediately?: boolean; /** @@ -360,10 +312,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$PullBatchResponse { /** - * Received Pub/Sub messages or status events. The Pub/Sub system will - * return zero messages if there are no more messages available in the - * backlog. The Pub/Sub system may return fewer than the max_events - * requested even if there are more messages available in the backlog. + * Received Pub/Sub messages or status events. The Pub/Sub system will return zero messages if there are no more messages available in the backlog. The Pub/Sub system may return fewer than the max_events requested even if there are more messages available in the backlog. */ pullResponses?: Schema$PullResponse[]; } @@ -372,11 +321,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$PullRequest { /** - * If this is specified as true the system will respond immediately even if - * it is not able to return a message in the Pull response. Otherwise the - * system is allowed to wait until at least one message is available rather - * than returning FAILED_PRECONDITION. The client may cancel the request if - * it does not wish to wait any longer for the response. + * If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning FAILED_PRECONDITION. The client may cancel the request if it does not wish to wait any longer for the response. */ returnImmediately?: boolean; /** @@ -385,8 +330,7 @@ export namespace pubsub_v1beta1a { subscription?: string; } /** - * Either a <code>PubsubMessage</code> or a truncation event. One - * of these two must be populated. + * Either a <code>PubsubMessage</code> or a truncation event. One of these two must be populated. */ export interface Schema$PullResponse { /** @@ -403,9 +347,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$PushConfig { /** - * A URL locating the endpoint to which messages should be pushed. For - * example, a Webhook endpoint might use - * "https://example.com/push". + * A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". */ pushEndpoint?: string; } @@ -414,21 +356,7 @@ export namespace pubsub_v1beta1a { */ export interface Schema$Subscription { /** - * For either push or pull delivery, the value is the maximum time after a - * subscriber receives a message before the subscriber should acknowledge or - * Nack the message. If the Ack deadline for a message passes without an Ack - * or a Nack, the Pub/Sub system will eventually redeliver the message. If a - * subscriber acknowledges after the deadline, the Pub/Sub system may accept - * the Ack, but it is possible that the message has been already delivered - * again. Multiple Acks to the message are allowed and will succeed. For - * push delivery, this value is used to set the request timeout for the call - * to the push endpoint. For pull delivery, this value is used as the - * initial value for the Ack deadline. It may be overridden for each message - * using its corresponding ack_id with - * <code>ModifyAckDeadline</code>. While a message is - * outstanding (i.e. it has been delivered to a pull subscriber and the - * subscriber has not yet Acked or Nacked), the Pub/Sub system will not - * deliver that message to another pull subscriber (on a best-effort basis). + * For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with <code>ModifyAckDeadline</code>. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis). */ ackDeadlineSeconds?: number; /** @@ -436,8 +364,7 @@ export namespace pubsub_v1beta1a { */ name?: string; /** - * If push delivery is used with this subscription, this field is used to - * configure it. + * If push delivery is used with this subscription, this field is used to configure it. */ pushConfig?: Schema$PushConfig; /** @@ -463,11 +390,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.subscriptions.acknowledge - * @desc Acknowledges a particular received message: the Pub/Sub system can - * remove the given message from the subscription. Acknowledging a message - * whose Ack deadline has expired may succeed, but the message could have - * been already redelivered. Acknowledging a message more than once will not - * result in an error. This is only used for messages received via pull. + * @desc Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull. * @alias pubsub.subscriptions.acknowledge * @memberOf! () * @@ -539,11 +462,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.subscriptions.create - * @desc Creates a subscription on a given topic for a given subscriber. If - * the subscription already exists, returns ALREADY_EXISTS. If the - * corresponding topic doesn't exist, returns NOT_FOUND. If the name is not - * provided in the request, the server will assign a random name for this - * subscription on the same project as the topic. + * @desc Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. * @alias pubsub.subscriptions.create * @memberOf! () * @@ -617,9 +536,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.subscriptions.delete - * @desc Deletes an existing subscription. All pending messages in the - * subscription are immediately dropped. Calls to Pull after deletion will - * return NOT_FOUND. + * @desc Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. * @alias pubsub.subscriptions.delete * @memberOf! () * @@ -848,8 +765,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.subscriptions.modifyAckDeadline - * @desc Modifies the Ack deadline for a message received from a pull - * request. + * @desc Modifies the Ack deadline for a message received from a pull request. * @alias pubsub.subscriptions.modifyAckDeadline * @memberOf! () * @@ -920,11 +836,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.subscriptions.modifyPushConfig - * @desc Modifies the PushConfig for a specified subscription. - * This method can be used to suspend the flow of messages to an endpoint by - * clearing the PushConfig field in the request. Messages will - * be accumulated for delivery even if no push configuration is defined or - * while the configuration is modified. + * @desc Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified. * @alias pubsub.subscriptions.modifyPushConfig * @memberOf! () * @@ -996,11 +908,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.subscriptions.pull - * @desc Pulls a single message from the server. If return_immediately is - * true, and no messages are available in the subscription, this method - * returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE - * error if no messages are available in a reasonable amount of time (to - * reduce system load). + * @desc Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load). * @alias pubsub.subscriptions.pull * @memberOf! () * @@ -1074,10 +982,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.subscriptions.pullBatch - * @desc Pulls messages from the server. Returns an empty list if there are - * no messages available in the backlog. The system is free to return - * UNAVAILABLE if there are too many pull requests outstanding for the given - * subscription. + * @desc Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription. * @alias pubsub.subscriptions.pullBatch * @memberOf! () * @@ -1210,8 +1115,7 @@ export namespace pubsub_v1beta1a { */ maxResults?: number; /** - * The value obtained in the last ListSubscriptionsResponse for - * continuation. + * The value obtained in the last ListSubscriptionsResponse for continuation. */ pageToken?: string; /** @@ -1344,9 +1248,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.topics.delete - * @desc Deletes the topic with the given name. Returns NOT_FOUND if the - * topic does not exist. After a topic is deleted, a new topic may be - * created with the same name. + * @desc Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name. * @alias pubsub.topics.delete * @memberOf! () * @@ -1417,10 +1319,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.topics.get - * @desc Gets the configuration of a topic. Since the topic only has the - * name attribute, this method is only useful to check the existence of a - * topic. If other attributes are added in the future, they will be returned - * here. + * @desc Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here. * @alias pubsub.topics.get * @memberOf! () * @@ -1563,8 +1462,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.topics.publish - * @desc Adds a message to the topic. Returns NOT_FOUND if the topic does - * not exist. + * @desc Adds a message to the topic. Returns NOT_FOUND if the topic does not exist. * @alias pubsub.topics.publish * @memberOf! () * @@ -1635,8 +1533,7 @@ export namespace pubsub_v1beta1a { /** * pubsub.topics.publishBatch - * @desc Adds one or more messages to the topic. Returns NOT_FOUND if the - * topic does not exist. + * @desc Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. * @alias pubsub.topics.publishBatch * @memberOf! () * @@ -1757,8 +1654,7 @@ export namespace pubsub_v1beta1a { */ maxResults?: number; /** - * The value obtained in the last ListTopicsResponse for - * continuation. + * The value obtained in the last ListTopicsResponse for continuation. */ pageToken?: string; /** diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 8b8d706f490..6414b00eed2 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace pubsub_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace pubsub_v1beta2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace pubsub_v1beta2 { /** * Cloud Pub/Sub API * - * Provides reliable, many-to-many, asynchronous messaging between - * applications. + * Provides reliable, many-to-many, asynchronous messaging between applications. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace pubsub_v1beta2 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,8 +122,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$AcknowledgeRequest { /** - * The acknowledgment ID for the messages being acknowledged that was - * returned by the Pub/Sub system in the `Pull` response. Must not be empty. + * The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. */ ackIds?: string[]; } @@ -134,67 +131,40 @@ export namespace pubsub_v1beta2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -203,9 +173,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$ListSubscriptionsResponse { /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new - * `ListSubscriptionsRequest` to get more subscriptions. + * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions. */ nextPageToken?: string; /** @@ -218,8 +186,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$ListTopicsResponse { /** - * If not empty, indicates that there may be more topics that match the - * request; this value should be passed in a new `ListTopicsRequest`. + * If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`. */ nextPageToken?: string; /** @@ -232,9 +199,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$ListTopicSubscriptionsResponse { /** - * If not empty, indicates that there may be more subscriptions that match - * the request; this value should be passed in a new - * `ListTopicSubscriptionsRequest` to get more subscriptions. + * If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions. */ nextPageToken?: string; /** @@ -247,16 +212,11 @@ export namespace pubsub_v1beta2 { */ export interface Schema$ModifyAckDeadlineRequest { /** - * The new ack deadline with respect to the time this request was sent to - * the Pub/Sub system. Must be >= 0. For example, if the value is 10, the - * new ack deadline will expire 10 seconds after the `ModifyAckDeadline` - * call was made. Specifying zero may immediately make the message available - * for another pull request. + * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request. */ ackDeadlineSeconds?: number; /** - * The acknowledgment ID. Either this or ack_ids must be populated, but not - * both. + * The acknowledgment ID. Either this or ack_ids must be populated, but not both. */ ackId?: string; /** @@ -269,72 +229,33 @@ export namespace pubsub_v1beta2 { */ export interface Schema$ModifyPushConfigRequest { /** - * The push configuration for future deliveries. An empty `pushConfig` - * indicates that the Pub/Sub system should stop pushing messages from the - * given subscription and allow messages to be pulled and acknowledged - - * effectively pausing the subscription if `Pull` is not called. + * The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` is not called. */ pushConfig?: Schema$PushConfig; } /** - * Contains information needed for generating an [OpenID Connect - * token](https://developers.google.com/identity/protocols/OpenIDConnect). + * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). */ export interface Schema$OidcToken { /** - * Audience to be used when generating OIDC token. The audience claim - * identifies the recipients that the JWT is intended for. The audience - * value is a single case-sensitive string. Having multiple values (array) - * for the audience field is not supported. More info about the OIDC JWT - * token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - * Note: if not specified, the Push endpoint URL will be used. + * Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used. */ audience?: string; /** - * [Service account - * email](https://cloud.google.com/iam/docs/service-accounts) to be used for - * generating the OIDC token. The caller (for CreateSubscription, - * UpdateSubscription, and ModifyPushConfig RPCs) must have the - * iam.serviceAccounts.actAs permission for the service account. + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account. */ serviceAccountEmail?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -356,15 +277,12 @@ export namespace pubsub_v1beta2 { */ export interface Schema$PublishResponse { /** - * The server-assigned ID of each published message, in the same order as - * the messages in the request. IDs are guaranteed to be unique within the - * topic. + * The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic. */ messageIds?: string[]; } /** - * A message data and its attributes. The message payload must not be empty; - * it must contain either a non-empty data field, or at least one attribute. + * A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. */ export interface Schema$PubsubMessage { /** @@ -372,21 +290,15 @@ export namespace pubsub_v1beta2 { */ attributes?: {[key: string]: string}; /** - * The message payload. For JSON requests, the value of this field must be - * [base64-encoded](https://tools.ietf.org/html/rfc4648). + * The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648). */ data?: string; /** - * ID of this message, assigned by the server when the message is published. - * Guaranteed to be unique within the topic. This value may be read by a - * subscriber that receives a `PubsubMessage` via a `Pull` call or a push - * delivery. It must not be populated by the publisher in a `Publish` call. + * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. */ messageId?: string; /** - * The time at which the message was published, populated by the server when - * it receives the `Publish` call. It must not be populated by the publisher - * in a `Publish` call. + * The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */ publishTime?: string; } @@ -395,16 +307,11 @@ export namespace pubsub_v1beta2 { */ export interface Schema$PullRequest { /** - * The maximum number of messages returned for this request. The Pub/Sub - * system may return fewer than the number specified. + * The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified. */ maxMessages?: number; /** - * If this is specified as true the system will respond immediately even if - * it is not able to return a message in the `Pull` response. Otherwise the - * system is allowed to wait until at least one message is available rather - * than returning no messages. The client may cancel the request if it does - * not wish to wait any longer for the response. + * If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. */ returnImmediately?: boolean; } @@ -413,10 +320,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$PullResponse { /** - * Received Pub/Sub messages. The Pub/Sub system will return zero messages - * if there are no more available in the backlog. The Pub/Sub system may - * return fewer than the `maxMessages` requested even if there are more - * messages available in the backlog. + * Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog. */ receivedMessages?: Schema$ReceivedMessage[]; } @@ -425,32 +329,15 @@ export namespace pubsub_v1beta2 { */ export interface Schema$PushConfig { /** - * Endpoint configuration attributes. Every endpoint has a set of API - * supported attributes that can be used to control different aspects of the - * message delivery. The currently supported attribute is `x-goog-version`, - * which you can use to change the format of the push message. This - * attribute indicates the version of the data expected by the endpoint. - * This controls the shape of the envelope (i.e. its fields and metadata). - * The endpoint version is based on the version of the Pub/Sub API. If not - * present during the `CreateSubscription` call, it will default to the - * version of the API used to make such call. If not present during a - * `ModifyPushConfig` call, its value will not be changed. `GetSubscription` - * calls will always return a valid version, even if the subscription was - * created without this attribute. The possible values for this attribute - * are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub - * API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub - * API. + * Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. */ attributes?: {[key: string]: string}; /** - * If specified, Pub/Sub will generate and attach an OIDC JWT token as an - * `Authorization` header in the HTTP request for every pushed message. + * If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. */ oidcToken?: Schema$OidcToken; /** - * A URL locating the endpoint to which messages should be pushed. For - * example, a Webhook endpoint might use - * "https://example.com/push". + * A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". */ pushEndpoint?: string; } @@ -472,10 +359,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } @@ -484,41 +368,19 @@ export namespace pubsub_v1beta2 { */ export interface Schema$Subscription { /** - * This value is the maximum time after a subscriber receives a message - * before the subscriber should acknowledge the message. After message - * delivery but before the ack deadline expires and before the message is - * acknowledged, it is an outstanding message and will not be delivered - * again during that time (on a best-effort basis). For pull subscriptions, - * this value is used as the initial value for the ack deadline. To override - * this value for a given message, call `ModifyAckDeadline` with the - * corresponding `ack_id` if using pull. The maximum custom deadline you can - * specify is 600 seconds (10 minutes). For push delivery, this value is - * also used to set the request timeout for the call to the push endpoint. - * If the subscriber never acknowledges the message, the Pub/Sub system will - * eventually redeliver the message. If this parameter is 0, a default - * value of 10 seconds is used. + * This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used. */ ackDeadlineSeconds?: number; /** - * The name of the subscription. It must have the format - * `"projects/{project}/subscriptions/{subscription}"`. - * `{subscription}` must start with a letter, and contain only letters - * (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods - * (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be - * between 3 and 255 characters in length, and it must not start with - * `"goog"`. + * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; /** - * If push delivery is used with this subscription, this field is used to - * configure it. An empty `pushConfig` signifies that the subscriber will - * pull and ack messages using API methods. + * If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. */ pushConfig?: Schema$PushConfig; /** - * The name of the topic from which this subscription is receiving messages. - * The value of this field will be `_deleted-topic_` if the topic has been - * deleted. + * The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted. */ topic?: string; } @@ -527,10 +389,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -539,8 +398,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -549,12 +407,7 @@ export namespace pubsub_v1beta2 { */ export interface Schema$Topic { /** - * The name of the topic. It must have the format - * `"projects/{project}/topics/{topic}"`. `{topic}` must start - * with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), - * dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) - * or percent signs (`%`). It must be between 3 and 255 characters in - * length, and it must not start with `"goog"`. + * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; } @@ -578,11 +431,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.acknowledge - * @desc Acknowledges the messages associated with the `ack_ids` in the - * `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages - * from the subscription. Acknowledging a message whose ack deadline has - * expired may succeed, but such a message may be redelivered later. - * Acknowledging a message more than once will not result in an error. + * @desc Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error. * @alias pubsub.projects.subscriptions.acknowledge * @memberOf! () * @@ -655,12 +504,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.create - * @desc Creates a subscription to a given topic. If the subscription - * already exists, returns `ALREADY_EXISTS`. If the corresponding topic - * doesn't exist, returns `NOT_FOUND`. If the name is not provided in the - * request, the server will assign a random name for this subscription on - * the same project as the topic. Note that for REST API requests, you must - * specify a name. + * @desc Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name. * @alias pubsub.projects.subscriptions.create * @memberOf! () * @@ -732,11 +576,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.delete - * @desc Deletes an existing subscription. All pending messages in the - * subscription are immediately dropped. Calls to `Pull` after deletion will - * return `NOT_FOUND`. After a subscription is deleted, a new one may be - * created with the same name, but the new one has no association with the - * old subscription, or its topic unless the same topic is specified. + * @desc Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified. * @alias pubsub.projects.subscriptions.delete * @memberOf! () * @@ -882,8 +722,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias pubsub.projects.subscriptions.getIamPolicy * @memberOf! () * @@ -1038,11 +877,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.modifyAckDeadline - * @desc Modifies the ack deadline for a specific message. This method is - * useful to indicate that more time is needed to process a message by the - * subscriber, or to make the message available for redelivery if the - * processing was interrupted. Note that this does not modify the - * subscription-level `ackDeadlineSeconds` used for subsequent messages. + * @desc Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages. * @alias pubsub.projects.subscriptions.modifyAckDeadline * @memberOf! () * @@ -1114,11 +949,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.modifyPushConfig - * @desc Modifies the `PushConfig` for a specified subscription. This may - * be used to change a push subscription to a pull one (signified by an - * empty `PushConfig`) or vice versa, or change the endpoint URL and other - * attributes of a push subscription. Messages will accumulate for delivery - * continuously through the call regardless of changes to the `PushConfig`. + * @desc Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`. * @alias pubsub.projects.subscriptions.modifyPushConfig * @memberOf! () * @@ -1190,10 +1021,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.pull - * @desc Pulls messages from the server. Returns an empty list if there are - * no messages available in the backlog. The server may return `UNAVAILABLE` - * if there are too many concurrent pull requests pending for the given - * subscription. + * @desc Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription. * @alias pubsub.projects.subscriptions.pull * @memberOf! () * @@ -1268,8 +1096,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias pubsub.projects.subscriptions.setIamPolicy * @memberOf! () * @@ -1342,11 +1169,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias pubsub.projects.subscriptions.testIamPermissions * @memberOf! () * @@ -1452,12 +1275,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. It must have the format - * `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` - * must start with a letter, and contain only letters (`[A-Za-z]`), numbers - * (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - * plus (`+`) or percent signs (`%`). It must be between 3 and 255 - * characters in length, and it must not start with `"goog"`. + * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -1498,8 +1316,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1515,9 +1332,7 @@ export namespace pubsub_v1beta2 { */ pageSize?: number; /** - * The value returned by the last `ListSubscriptionsResponse`; indicates - * that this is a continuation of a prior `ListSubscriptions` call, and that - * the system should return the next page of data. + * The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -1584,8 +1399,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1602,8 +1416,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1695,12 +1508,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.topics.delete - * @desc Deletes the topic with the given name. Returns `NOT_FOUND` if the - * topic does not exist. After a topic is deleted, a new topic may be - * created with the same name; this is an entirely new topic with none of - * the old configuration or subscriptions. Existing subscriptions to this - * topic are not deleted, but their `topic` field is set to - * `_deleted-topic_`. + * @desc Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`. * @alias pubsub.projects.topics.delete * @memberOf! () * @@ -1838,8 +1646,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.topics.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias pubsub.projects.topics.getIamPolicy * @memberOf! () * @@ -1987,9 +1794,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.topics.publish - * @desc Adds one or more messages to the topic. Returns `NOT_FOUND` if the - * topic does not exist. The message payload must not be empty; it must - * contain either a non-empty data field, or at least one attribute. + * @desc Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. * @alias pubsub.projects.topics.publish * @memberOf! () * @@ -2064,8 +1869,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.topics.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias pubsub.projects.topics.setIamPolicy * @memberOf! () * @@ -2138,11 +1942,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.topics.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias pubsub.projects.topics.testIamPermissions * @memberOf! () * @@ -2231,12 +2031,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the topic. It must have the format - * `"projects/{project}/topics/{topic}"`. `{topic}` must start with a - * letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes - * (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or - * percent signs (`%`). It must be between 3 and 255 characters in length, - * and it must not start with `"goog"`. + * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -2277,8 +2072,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2294,9 +2088,7 @@ export namespace pubsub_v1beta2 { */ pageSize?: number; /** - * The value returned by the last `ListTopicsResponse`; indicates that this - * is a continuation of a prior `ListTopics` call, and that the system - * should return the next page of data. + * The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -2329,8 +2121,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2347,8 +2138,7 @@ export namespace pubsub_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2462,9 +2252,7 @@ export namespace pubsub_v1beta2 { */ pageSize?: number; /** - * The value returned by the last `ListTopicSubscriptionsResponse`; - * indicates that this is a continuation of a prior `ListTopicSubscriptions` - * call, and that the system should return the next page of data. + * The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data. */ pageToken?: string; /** diff --git a/src/apis/redis/package.json b/src/apis/redis/package.json index c7a4e2e0de9..1681bb8437c 100644 --- a/src/apis/redis/package.json +++ b/src/apis/redis/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 4b73beafd97..7ff7e53cf69 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace redis_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace redis_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,18 +108,17 @@ export namespace redis_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -131,24 +126,16 @@ export namespace redis_v1 { */ export interface Schema$FailoverInstanceRequest { /** - * Optional. Available data protection modes that the user can choose. If - * it's unspecified, data protection mode will be LIMITED_DATA_LOSS by - * default. + * Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. */ dataProtectionMode?: string; } /** - * This location metadata represents additional configuration options for a - * given location where a Redis instance may be created. All fields are output - * only. It is returned as content of the - * `google.cloud.location.Location.metadata` field. + * This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the `google.cloud.location.Location.metadata` field. */ export interface Schema$GoogleCloudRedisV1LocationMetadata { /** - * Output only. The set of available zones in the location. The map is keyed - * by the lowercase ID of each zone, as defined by GCE. These keys can be - * specified in `location_id` or `alternative_location_id` fields when - * creating a Redis instance. + * Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. */ availableZones?: {[key: string]: Schema$GoogleCloudRedisV1ZoneMetadata}; } @@ -186,8 +173,7 @@ export namespace redis_v1 { verb?: string; } /** - * Defines specific information for a particular zone. Currently empty and - * reserved for future use only. + * Defines specific information for a particular zone. Currently empty and reserved for future use only. */ export interface Schema$GoogleCloudRedisV1ZoneMetadata {} /** @@ -195,16 +181,11 @@ export namespace redis_v1 { */ export interface Schema$Instance { /** - * Optional. Only applicable to STANDARD_HA tier which protects the instance - * against zonal failures by provisioning it across two zones. If provided, - * it must be a different zone from the one provided in [location_id]. + * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id]. */ alternativeLocationId?: string; /** - * Optional. The full name of the Google Compute Engine - * [network](/compute/docs/networks-and-firewalls#networks) to which the - * instance is connected. If left unspecified, the `default` network will be - * used. + * Optional. The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. */ authorizedNetwork?: string; /** @@ -212,11 +193,7 @@ export namespace redis_v1 { */ createTime?: string; /** - * Output only. The current zone where the Redis endpoint is placed. For - * Basic Tier instances, this will always be the same as the [location_id] - * provided by the user at creation time. For Standard Tier instances, this - * can be either [location_id] or [alternative_location_id] and can change - * after a failover event. + * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event. */ currentLocationId?: string; /** @@ -224,8 +201,7 @@ export namespace redis_v1 { */ displayName?: string; /** - * Output only. Hostname or IP address of the exposed Redis endpoint used by - * clients to connect to the service. + * Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. */ host?: string; /** @@ -233,11 +209,7 @@ export namespace redis_v1 { */ labels?: {[key: string]: string}; /** - * Optional. The zone where the instance will be provisioned. If not - * provided, the service will choose a zone for the instance. For - * STANDARD_HA tier, instances will be created across two zones for - * protection against zonal failures. If [alternative_location_id] is also - * provided, it must be different from [location_id]. + * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id]. */ locationId?: string; /** @@ -245,14 +217,7 @@ export namespace redis_v1 { */ memorySizeGb?: number; /** - * Required. Unique name of the resource in this scope including project and - * location using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * Note: Redis instances are managed and addressed at regional level so - * location_id here refers to a GCP region; however, users may choose which - * specific zone (or collection of zones for cross-zone instances) an - * instance should be provisioned in. Refer to [location_id] and - * [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ name?: string; /** @@ -260,23 +225,15 @@ export namespace redis_v1 { */ port?: number; /** - * Optional. Redis configuration parameters, according to - * http://redis.io/topics/config. Currently, the only supported parameters - * are: * maxmemory-policy * notify-keyspace-events + * Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: * maxmemory-policy * notify-keyspace-events */ redisConfigs?: {[key: string]: string}; /** - * Optional. The version of Redis software. If not provided, latest - * supported version will be used. Updating the version will perform an - * upgrade/downgrade to the new version. Currently, the supported values are - * `REDIS_3_2` for Redis 3.2. + * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are `REDIS_3_2` for Redis 3.2. */ redisVersion?: string; /** - * Optional. The CIDR range of internal addresses that are reserved for this - * instance. If not provided, the service will choose an unused /29 block, - * for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and - * non-overlapping with existing subnets in an authorized network. + * Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. */ reservedIpRange?: string; /** @@ -284,8 +241,7 @@ export namespace redis_v1 { */ state?: string; /** - * Output only. Additional information about the current status of this - * instance, if available. + * Output only. Additional information about the current status of this instance, if available. */ statusMessage?: string; /** @@ -298,20 +254,11 @@ export namespace redis_v1 { */ export interface Schema$ListInstancesResponse { /** - * A list of Redis instances in the project in the specified location, or - * across all locations. If the `location_id` in the parent field of the - * request is "-", all regions available to the project are - * queried, and the results aggregated. If in such an aggregated query a - * location is unavailable, a dummy Redis entry is included in the response - * with the "name" field set to a value of the form - * projects/{project_id}/locations/{location_id}/instances/- and the - * "status" field set to ERROR and "status_message" - * field set to "location not available for ListInstances". + * A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the "name" field set to a value of the form projects/{project_id}/locations/{location_id}/instances/- and the "status" field set to ERROR and "status_message" field set to "location not available for ListInstances". */ instances?: Schema$Instance[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** @@ -350,13 +297,11 @@ export namespace redis_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -364,27 +309,20 @@ export namespace redis_v1 { */ locationId?: string; /** - * Output only. The set of available zones in the location. The map is keyed - * by the lowercase ID of each zone, as defined by Compute Engine. These - * keys can be specified in `location_id` or `alternative_location_id` - * fields when creating a Redis instance. + * Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. */ metadata?: {[key: string]: any}; /** - * Full resource name for the region. For example: - * "projects/example-project/locations/us-east1". + * Full resource name for the region. For example: "projects/example-project/locations/us-east1". */ name?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -392,69 +330,20 @@ export namespace redis_v1 { */ error?: Schema$Status; /** - * { `createTime`: The time the operation was created. `endTime`: The time - * the operation finished running. `target`: Server-defined resource path - * for the target of the operation. `verb`: Name of the verb executed by - * the operation. `statusDetail`: Human-readable status of the operation, - * if any. `cancelRequested`: Identifies whether the user has requested - * cancellation of the operation. Operations that have successfully been - * cancelled have Operation.error value with a google.rpc.Status.code of 1, - * corresponding to `Code.CANCELLED`. `apiVersion`: API version used to - * start the operation. } + * { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -462,14 +351,11 @@ export namespace redis_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -689,21 +575,13 @@ export namespace redis_v1 { /** * redis.projects.locations.instances.create - * @desc Creates a Redis instance based on the specified tier and memory - * size. By default, the instance is accessible from the project's [default - * network](/compute/docs/networks-and-firewalls#networks). The creation is - * executed asynchronously and callers may check the returned operation to - * track its progress. Once the operation is completed the Redis instance - * will be fully functional. Completed longrunning.Operation will contain - * the new instance object in the response field. The returned operation is - * automatically deleted after a few hours, so there is no need to call - * DeleteOperation. + * @desc Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. * @alias redis.projects.locations.instances.create * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.instanceId Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location - * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region + * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. * @param {().Instance} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -773,13 +651,12 @@ export namespace redis_v1 { /** * redis.projects.locations.instances.delete - * @desc Deletes a specific Redis instance. Instance stops serving and data - * is deleted. + * @desc Deletes a specific Redis instance. Instance stops serving and data is deleted. * @alias redis.projects.locations.instances.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -845,13 +722,12 @@ export namespace redis_v1 { /** * redis.projects.locations.instances.failover - * @desc Failover the master role to current replica node against a specific - * STANDARD tier redis instance. + * @desc Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance. * @alias redis.projects.locations.instances.failover * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. * @param {().FailoverInstanceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -926,7 +802,7 @@ export namespace redis_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -990,18 +866,14 @@ export namespace redis_v1 { /** * redis.projects.locations.instances.list - * @desc Lists all Redis instances owned by a project in either the - * specified location (region) or all locations. The location should have - * the following format: * `projects/{project_id}/locations/{location_id}` - * If `location_id` is specified as `-` (wildcard), then all regions - * available to the project are queried, and the results are aggregated. + * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. * @alias redis.projects.locations.instances.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. - * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region + * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1072,10 +944,7 @@ export namespace redis_v1 { /** * redis.projects.locations.instances.patch - * @desc Updates the metadata and configuration of a specific Redis - * instance. Completed longrunning.Operation will contain the new instance - * object in the response field. The returned operation is automatically - * deleted after a few hours, so there is no need to call DeleteOperation. + * @desc Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. * @alias redis.projects.locations.instances.patch * @memberOf! () * @@ -1155,17 +1024,11 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The logical name of the Redis instance in the customer project - * with the following restrictions: * Must contain only lowercase letters, - * numbers, and hyphens. * Must start with a letter. * Must be between 1-40 - * characters. * Must end with a number or a letter. * Must be unique within - * the customer project / location + * Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location */ instanceId?: string; /** - * Required. The resource name of the instance location using the form: - * `projects/{project_id}/locations/{location_id}` where `location_id` - * refers to a GCP region + * Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. */ parent?: string; @@ -1182,9 +1045,7 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Redis instance resource name using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * where `location_id` refers to a GCP region + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. */ name?: string; } @@ -1196,9 +1057,7 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Redis instance resource name using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * where `location_id` refers to a GCP region + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. */ name?: string; @@ -1215,9 +1074,7 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Redis instance resource name using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * where `location_id` refers to a GCP region + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. */ name?: string; } @@ -1229,11 +1086,7 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. If not specified, a default value - * of 1000 will be used by the service. Regardless of the page_size value, - * the response may include a partial list and a caller should only rely on - * response's next_page_token to determine if there are more instances left - * to be queried. + * The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. */ pageSize?: number; /** @@ -1241,9 +1094,7 @@ export namespace redis_v1 { */ pageToken?: string; /** - * Required. The resource name of the instance location using the form: - * `projects/{project_id}/locations/{location_id}` where `location_id` - * refers to a GCP region + * Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. */ parent?: string; } @@ -1255,21 +1106,11 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Unique name of the resource in this scope including project and - * location using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * Note: Redis instances are managed and addressed at regional level so - * location_id here refers to a GCP region; however, users may choose which - * specific zone (or collection of zones for cross-zone instances) an - * instance should be provisioned in. Refer to [location_id] and - * [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ name?: string; /** - * Required. Mask of fields to update. At least one path must be supplied in - * this field. The elements of the repeated paths field may only include - * these fields from Instance: * `displayName` * `labels` * - * `memorySizeGb` * `redisConfig` + * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig` */ updateMask?: string; @@ -1287,15 +1128,7 @@ export namespace redis_v1 { /** * redis.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias redis.projects.locations.operations.cancel * @memberOf! () * @@ -1364,10 +1197,7 @@ export namespace redis_v1 { /** * redis.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias redis.projects.locations.operations.delete * @memberOf! () * @@ -1436,9 +1266,7 @@ export namespace redis_v1 { /** * redis.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias redis.projects.locations.operations.get * @memberOf! () * @@ -1509,15 +1337,7 @@ export namespace redis_v1 { /** * redis.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias redis.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index a66b027b35b..467f2366d56 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace redis_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace redis_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,18 +108,17 @@ export namespace redis_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -135,10 +130,7 @@ export namespace redis_v1beta1 { */ apiVersion?: string; /** - * [Output only] Identifies whether the user has requested cancellation of - * the operation. Operations that have successfully been cancelled have - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ cancelRequested?: boolean; /** @@ -154,8 +146,7 @@ export namespace redis_v1beta1 { */ statusDetail?: string; /** - * [Output only] Server-defined resource path for the target of the - * operation. + * [Output only] Server-defined resource path for the target of the operation. */ target?: string; /** @@ -164,25 +155,18 @@ export namespace redis_v1beta1 { verb?: string; } /** - * This location metadata represents additional configuration options for a - * given location where a Redis instance may be created. All fields are output - * only. It is returned as content of the - * `google.cloud.location.Location.metadata` field. + * This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the `google.cloud.location.Location.metadata` field. */ export interface Schema$GoogleCloudRedisV1beta1LocationMetadata { /** - * Output only. The set of available zones in the location. The map is keyed - * by the lowercase ID of each zone, as defined by GCE. These keys can be - * specified in `location_id` or `alternative_location_id` fields when - * creating a Redis instance. + * Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. */ availableZones?: { [key: string]: Schema$GoogleCloudRedisV1beta1ZoneMetadata; }; } /** - * Defines specific information for a particular zone. Currently empty and - * reserved for future use only. + * Defines specific information for a particular zone. Currently empty and reserved for future use only. */ export interface Schema$GoogleCloudRedisV1beta1ZoneMetadata {} /** @@ -190,16 +174,11 @@ export namespace redis_v1beta1 { */ export interface Schema$Instance { /** - * Optional. Only applicable to STANDARD_HA tier which protects the instance - * against zonal failures by provisioning it across two zones. If provided, - * it must be a different zone from the one provided in [location_id]. + * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id]. */ alternativeLocationId?: string; /** - * Optional. The full name of the Google Compute Engine - * [network](/compute/docs/networks-and-firewalls#networks) to which the - * instance is connected. If left unspecified, the `default` network will be - * used. + * Optional. The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. */ authorizedNetwork?: string; /** @@ -207,11 +186,7 @@ export namespace redis_v1beta1 { */ createTime?: string; /** - * Output only. The current zone where the Redis endpoint is placed. For - * Basic Tier instances, this will always be the same as the [location_id] - * provided by the user at creation time. For Standard Tier instances, this - * can be either [location_id] or [alternative_location_id] and can change - * after a failover event. + * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event. */ currentLocationId?: string; /** @@ -219,8 +194,7 @@ export namespace redis_v1beta1 { */ displayName?: string; /** - * Output only. Hostname or IP address of the exposed Redis endpoint used by - * clients to connect to the service. + * Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. */ host?: string; /** @@ -228,11 +202,7 @@ export namespace redis_v1beta1 { */ labels?: {[key: string]: string}; /** - * Optional. The zone where the instance will be provisioned. If not - * provided, the service will choose a zone for the instance. For - * STANDARD_HA tier, instances will be created across two zones for - * protection against zonal failures. If [alternative_location_id] is also - * provided, it must be different from [location_id]. + * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id]. */ locationId?: string; /** @@ -240,14 +210,7 @@ export namespace redis_v1beta1 { */ memorySizeGb?: number; /** - * Required. Unique name of the resource in this scope including project and - * location using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * Note: Redis instances are managed and addressed at regional level so - * location_id here refers to a GCP region; however, users may choose which - * specific zone (or collection of zones for cross-zone instances) an - * instance should be provisioned in. Refer to [location_id] and - * [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ name?: string; /** @@ -255,26 +218,15 @@ export namespace redis_v1beta1 { */ port?: number; /** - * Optional. Redis configuration parameters, according to - * http://redis.io/topics/config. Currently, the only supported parameters - * are: Redis 3.2 and above: * maxmemory-policy * - * notify-keyspace-events Redis 4.0 and above: * activedefrag * - * lfu-log-factor * lfu-decay-time + * Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis 3.2 and above: * maxmemory-policy * notify-keyspace-events Redis 4.0 and above: * activedefrag * lfu-log-factor * lfu-decay-time */ redisConfigs?: {[key: string]: string}; /** - * Optional. The version of Redis software. If not provided, latest - * supported version will be used. Updating the version will perform an - * upgrade/downgrade to the new version. Currently, the supported values - * are: * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_3_2` for - * Redis 3.2 compatibility + * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_3_2` for Redis 3.2 compatibility (default) */ redisVersion?: string; /** - * Optional. The CIDR range of internal addresses that are reserved for this - * instance. If not provided, the service will choose an unused /29 block, - * for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and - * non-overlapping with existing subnets in an authorized network. + * Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. */ reservedIpRange?: string; /** @@ -282,8 +234,7 @@ export namespace redis_v1beta1 { */ state?: string; /** - * Output only. Additional information about the current status of this - * instance, if available. + * Output only. Additional information about the current status of this instance, if available. */ statusMessage?: string; /** @@ -296,20 +247,11 @@ export namespace redis_v1beta1 { */ export interface Schema$ListInstancesResponse { /** - * A list of Redis instances in the project in the specified location, or - * across all locations. If the `location_id` in the parent field of the - * request is "-", all regions available to the project are - * queried, and the results aggregated. If in such an aggregated query a - * location is unavailable, a dummy Redis entry is included in the response - * with the "name" field set to a value of the form - * projects/{project_id}/locations/{location_id}/instances/- and the - * "status" field set to ERROR and "status_message" - * field set to "location not available for ListInstances". + * A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the "name" field set to a value of the form projects/{project_id}/locations/{location_id}/instances/- and the "status" field set to ERROR and "status_message" field set to "location not available for ListInstances". */ instances?: Schema$Instance[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** @@ -348,13 +290,11 @@ export namespace redis_v1beta1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -362,27 +302,20 @@ export namespace redis_v1beta1 { */ locationId?: string; /** - * Output only. The set of available zones in the location. The map is keyed - * by the lowercase ID of each zone, as defined by Compute Engine. These - * keys can be specified in `location_id` or `alternative_location_id` - * fields when creating a Redis instance. + * Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. */ metadata?: {[key: string]: any}; /** - * Full resource name for the region. For example: - * "projects/example-project/locations/us-east1". + * Full resource name for the region. For example: "projects/example-project/locations/us-east1". */ name?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -390,69 +323,20 @@ export namespace redis_v1beta1 { */ error?: Schema$Status; /** - * { `createTime`: The time the operation was created. `endTime`: The time - * the operation finished running. `target`: Server-defined resource path - * for the target of the operation. `verb`: Name of the verb executed by - * the operation. `statusDetail`: Human-readable status of the operation, - * if any. `cancelRequested`: Identifies whether the user has requested - * cancellation of the operation. Operations that have successfully been - * cancelled have Operation.error value with a google.rpc.Status.code of 1, - * corresponding to `Code.CANCELLED`. `apiVersion`: API version used to - * start the operation. } + * { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -460,14 +344,11 @@ export namespace redis_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -687,21 +568,13 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.instances.create - * @desc Creates a Redis instance based on the specified tier and memory - * size. By default, the instance is accessible from the project's [default - * network](/compute/docs/networks-and-firewalls#networks). The creation is - * executed asynchronously and callers may check the returned operation to - * track its progress. Once the operation is completed the Redis instance - * will be fully functional. Completed longrunning.Operation will contain - * the new instance object in the response field. The returned operation is - * automatically deleted after a few hours, so there is no need to call - * DeleteOperation. + * @desc Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. * @alias redis.projects.locations.instances.create * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.instanceId Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location - * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region + * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. * @param {().Instance} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -771,13 +644,12 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.instances.delete - * @desc Deletes a specific Redis instance. Instance stops serving and data - * is deleted. + * @desc Deletes a specific Redis instance. Instance stops serving and data is deleted. * @alias redis.projects.locations.instances.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -848,7 +720,7 @@ export namespace redis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -912,18 +784,14 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.instances.list - * @desc Lists all Redis instances owned by a project in either the - * specified location (region) or all locations. The location should have - * the following format: * `projects/{project_id}/locations/{location_id}` - * If `location_id` is specified as `-` (wildcard), then all regions - * available to the project are queried, and the results are aggregated. + * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. * @alias redis.projects.locations.instances.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. - * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region + * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -994,10 +862,7 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.instances.patch - * @desc Updates the metadata and configuration of a specific Redis - * instance. Completed longrunning.Operation will contain the new instance - * object in the response field. The returned operation is automatically - * deleted after a few hours, so there is no need to call DeleteOperation. + * @desc Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. * @alias redis.projects.locations.instances.patch * @memberOf! () * @@ -1077,17 +942,11 @@ export namespace redis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The logical name of the Redis instance in the customer project - * with the following restrictions: * Must contain only lowercase letters, - * numbers, and hyphens. * Must start with a letter. * Must be between 1-40 - * characters. * Must end with a number or a letter. * Must be unique within - * the customer project / location + * Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location */ instanceId?: string; /** - * Required. The resource name of the instance location using the form: - * `projects/{project_id}/locations/{location_id}` where `location_id` - * refers to a GCP region + * Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. */ parent?: string; @@ -1104,9 +963,7 @@ export namespace redis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Redis instance resource name using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * where `location_id` refers to a GCP region + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. */ name?: string; } @@ -1118,9 +975,7 @@ export namespace redis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Redis instance resource name using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * where `location_id` refers to a GCP region + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. */ name?: string; } @@ -1132,11 +987,7 @@ export namespace redis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. If not specified, a default value - * of 1000 will be used by the service. Regardless of the page_size value, - * the response may include a partial list and a caller should only rely on - * response's next_page_token to determine if there are more instances left - * to be queried. + * The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. */ pageSize?: number; /** @@ -1144,9 +995,7 @@ export namespace redis_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the instance location using the form: - * `projects/{project_id}/locations/{location_id}` where `location_id` - * refers to a GCP region + * Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. */ parent?: string; } @@ -1158,21 +1007,11 @@ export namespace redis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Unique name of the resource in this scope including project and - * location using the form: - * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - * Note: Redis instances are managed and addressed at regional level so - * location_id here refers to a GCP region; however, users may choose which - * specific zone (or collection of zones for cross-zone instances) an - * instance should be provisioned in. Refer to [location_id] and - * [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ name?: string; /** - * Required. Mask of fields to update. At least one path must be supplied in - * this field. The elements of the repeated paths field may only include - * these fields from Instance: * `displayName` * `labels` * - * `memorySizeGb` * `redisConfig` + * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig` */ updateMask?: string; @@ -1190,15 +1029,7 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias redis.projects.locations.operations.cancel * @memberOf! () * @@ -1270,10 +1101,7 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias redis.projects.locations.operations.delete * @memberOf! () * @@ -1342,9 +1170,7 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias redis.projects.locations.operations.get * @memberOf! () * @@ -1415,15 +1241,7 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias redis.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/remotebuildexecution/package.json b/src/apis/remotebuildexecution/package.json index 907c6772a35..3b9f1fa1f0c 100644 --- a/src/apis/remotebuildexecution/package.json +++ b/src/apis/remotebuildexecution/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index f644f0326be..c3f9db12efc 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace remotebuildexecution_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace remotebuildexecution_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -115,7 +111,10 @@ export namespace remotebuildexecution_v1 { v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.media = new Resource$Media(this.context); this.operations = new Resource$Operations(this.context); @@ -125,25 +124,11 @@ export namespace remotebuildexecution_v1 { } /** - * An `Action` captures all the information about an execution which is - * required to reproduce it. `Action`s are the core component of the - * [Execution] service. A single `Action` represents a repeatable action that - * can be performed by the execution service. `Action`s can be succinctly - * identified by the digest of their wire format encoding and, once an - * `Action` has been executed, will be cached in the action cache. Future - * requests can then use the cached result rather than needing to run afresh. - * When a server completes execution of an Action, it MAY choose to cache the - * result in the ActionCache unless `do_not_cache` is `true`. Clients SHOULD - * expect the server to do so. By default, future calls to Execute the same - * `Action` will also serve their results from the cache. Clients must take - * care to understand the caching behaviour. Ideally, all `Action`s will be - * reproducible so that serving a result from cache is always desirable and - * correct. + * An `Action` captures all the information about an execution which is required to reproduce it. `Action`s are the core component of the [Execution] service. A single `Action` represents a repeatable action that can be performed by the execution service. `Action`s can be succinctly identified by the digest of their wire format encoding and, once an `Action` has been executed, will be cached in the action cache. Future requests can then use the cached result rather than needing to run afresh. When a server completes execution of an Action, it MAY choose to cache the result in the ActionCache unless `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, future calls to Execute the same `Action` will also serve their results from the cache. Clients must take care to understand the caching behaviour. Ideally, all `Action`s will be reproducible so that serving a result from cache is always desirable and correct. */ export interface Schema$BuildBazelRemoteExecutionV2Action { /** - * The digest of the Command to run, which MUST be present in the - * ContentAddressableStorage. + * The digest of the Command to run, which MUST be present in the ContentAddressableStorage. */ commandDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** @@ -151,27 +136,11 @@ export namespace remotebuildexecution_v1 { */ doNotCache?: boolean; /** - * The digest of the root Directory for the input files. The files in the - * directory tree are available in the correct location on the build machine - * before the command is executed. The root directory, as well as every - * subdirectory and content blob referred to, MUST be in the - * ContentAddressableStorage. + * The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage. */ inputRootDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * A timeout after which the execution should be killed. If the timeout is - * absent, then the client is specifying that the execution should continue - * as long as the server will let it. The server SHOULD impose a timeout if - * the client does not specify one, however, if the client does specify a - * timeout that is longer than the server's maximum timeout, the server - * MUST reject the request. The timeout is a part of the Action message, - * and therefore two `Actions` with different timeouts are different, even - * if they are otherwise identical. This is because, if they were not, - * running an `Action` with a lower timeout than is required might result in - * a cache hit from an execution run with a longer timeout, hiding the fact - * that the timeout is too short. By encoding it directly in the `Action`, a - * lower timeout will result in a cache miss and the execution timeout will - * fail immediately, rather than whenever the cache entry gets evicted. + * A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted. */ timeout?: string; } @@ -188,184 +157,69 @@ export namespace remotebuildexecution_v1 { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested - * in the `output_directories` field of the Action, if the corresponding - * directory existed after the action completed, a single entry will be - * present in the output list, which will contain the digest of a Tree - * message containing the directory tree, and the path equal exactly to the - * corresponding Action output_directories member. As an example, suppose - * the Action had an output directory `a/b/dir` and the execution produced - * the following contents in `a/b/dir`: a file named `bar` and a directory - * named `foo` with an executable file named `baz`. Then, output_directory - * will contain (hashes shortened for readability): ```json // - * OutputDirectory proto: { path: "a/b/dir" tree_digest: { - * hash: "4a73bc9d03...", size: 55 } } // Tree proto with - * hash "4a73bc9d03..." and size 55: { root: { files: [ { - * name: "bar", digest: { hash: - * "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { - * hash: "4cf2eda940...", size: 43 } } ] - * } children : { // (Directory proto with hash - * "4cf2eda940..." and size 43) files: [ { name: - * "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, - * is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ outputDirectories?: Schema$BuildBazelRemoteExecutionV2OutputDirectory[]; /** - * The output directories of the action that are symbolic links to other - * directories. Those may be links to other output directories, or input - * directories, or even absolute paths outside of the working directory, if - * the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output - * directory requested in the `output_directories` field of the Action, if - * the directory file existed after the action completed, a single entry - * will be present either in this field, or in the `output_directories` - * field, if the directory was not a symbolic link. If the action does not - * produce the requested output, or produces a file where a directory is - * expected or vice versa, then that output will be omitted from the list. - * The server is free to arrange the output list as desired; clients MUST - * NOT assume that the output list is sorted. + * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory file existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If the action does not produce the requested output, or produces a file where a directory is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputDirectorySymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The output files of the action. For each output file requested in the - * `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present either in this - * field, or in the output_file_symlinks field, if the file was a symbolic - * link to another file. If the action does not produce the requested - * output, or produces a directory where a regular file is expected or vice - * versa, then that output will be omitted from the list. The server is free - * to arrange the output list as desired; clients MUST NOT assume that the - * output list is sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the output_file_symlinks field, if the file was a symbolic link to another file. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$BuildBazelRemoteExecutionV2OutputFile[]; /** - * The output files of the action that are symbolic links to other files. - * Those may be links to other output files, or input files, or even - * absolute paths outside of the working directory, if the server supports - * SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in - * the `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present either in this - * field, or in the `output_files` field, if the file was not a symbolic - * link. If the action does not produce the requested output, or produces a - * directory where a regular file is expected or vice versa, then that - * output will be omitted from the list. The server is free to arrange the - * output list as desired; clients MUST NOT assume that the output list is - * sorted. + * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFileSymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The digest for a blob containing the standard error of the action, which - * can be retrieved from the ContentAddressableStorage. See `stderr_raw` for - * when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. */ stderrDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard error buffer of the action. The server will determine, based - * on the size of the buffer, whether to return it in raw form or to return - * a digest in `stderr_digest` that points to the buffer. If neither is set, - * then the buffer is empty. The client SHOULD NOT assume it will get one of - * the raw buffer or a digest on any given request and should be prepared to - * handle either. + * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which - * can be retrieved from the ContentAddressableStorage. See `stdout_raw` for - * when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ stdoutDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard output buffer of the action. The server will determine, - * based on the size of the buffer, whether to return it in raw form or to - * return a digest in `stdout_digest` that points to the buffer. If neither - * is set, then the buffer is empty. The client SHOULD NOT assume it will - * get one of the raw buffer or a digest on any given request and should be - * prepared to handle either. + * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stdoutRaw?: string; } /** - * A `Command` is the actual command executed by a worker running an Action - * and specifications of its environment. Except as otherwise required, the - * environment (such as which system libraries or binaries are available, and - * what filesystems are mounted where) is defined by and specific to the - * implementation of the remote execution API. + * A `Command` is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. */ export interface Schema$BuildBazelRemoteExecutionV2Command { /** - * The arguments to the command. The first argument must be the path to the - * executable, which must be either a relative path, in which case it is - * evaluated with respect to the input root, or an absolute path. + * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. */ arguments?: string[]; /** - * The environment variables to set when running the program. The worker may - * provide its own default environment variables; these defaults can be - * overridden using this field. Additional variables can also be specified. - * In order to ensure that equivalent Commands always hash to the same - * value, the environment variables MUST be lexicographically sorted by - * name. Sorting of strings is done by code point, equivalently, by the - * UTF-8 bytes. + * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ environmentVariables?: Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable[]; /** - * A list of the output directories that the client expects to retrieve from - * the action. Only the listed directories will be returned (an entire - * directory structure will be returned as a Tree message digest, see - * OutputDirectory), as well as files listed in `output_files`. Other files - * or directories that may be created during command execution are - * discarded. The paths are relative to the working directory of the action - * execution. The paths are specified using a single forward slash (`/`) as - * a path separator, even if the execution platform natively uses a - * different separator. The path MUST NOT include a trailing slash, nor a - * leading slash, being a relative path. The special value of empty string - * is allowed, although not recommended, and can be used to capture the - * entire working directory tree, including inputs. In order to ensure - * consistent hashing of the same Action, the output paths MUST be sorted - * lexicographically by code point (or, equivalently, by UTF-8 bytes). An - * output directory cannot be duplicated or have the same path as any of the - * listed output files. Directories leading up to the output directories - * (but not the output directories themselves) are created by the worker - * prior to execution, even if they are not explicitly part of the input - * root. + * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputDirectories?: string[]; /** - * A list of the output files that the client expects to retrieve from the - * action. Only the listed files, as well as directories listed in - * `output_directories`, will be returned to the client as output. Other - * files or directories that may be created during command execution are - * discarded. The paths are relative to the working directory of the action - * execution. The paths are specified using a single forward slash (`/`) as - * a path separator, even if the execution platform natively uses a - * different separator. The path MUST NOT include a trailing slash, nor a - * leading slash, being a relative path. In order to ensure consistent - * hashing of the same Action, the output paths MUST be sorted - * lexicographically by code point (or, equivalently, by UTF-8 bytes). An - * output file cannot be duplicated, be a parent of another output file, or - * have the same path as any of the listed output directories. Directories - * leading up to the output files are created by the worker prior to - * execution, even if they are not explicitly part of the input root. + * A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputFiles?: string[]; /** - * The platform requirements for the execution environment. The server MAY - * choose to execute the action on any worker satisfying the requirements, - * so the client SHOULD ensure that running the action on any such worker - * will have the same result. + * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. */ platform?: Schema$BuildBazelRemoteExecutionV2Platform; /** - * The working directory, relative to the input root, for the command to run - * in. It must be a directory which exists in the input tree. If it is left - * empty, then the action is run in the input root. + * The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root. */ workingDirectory?: string; } /** - * An `EnvironmentVariable` is one variable to set in the running - * program's environment. + * An `EnvironmentVariable` is one variable to set in the running program's environment. */ export interface Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable { /** @@ -378,36 +232,11 @@ export namespace remotebuildexecution_v1 { value?: string; } /** - * A content digest. A digest for a given blob consists of the size of the - * blob and its hash. The hash algorithm to use is defined by the server, but - * servers SHOULD use SHA-256. The size is considered to be an integral part - * of the digest and cannot be separated. That is, even if the `hash` field is - * correctly specified but `size_bytes` is not, the server MUST reject the - * request. The reason for including the size in the digest is as follows: in - * a great many cases, the server needs to know the size of the blob it is - * about to work with prior to starting an operation with it, such as - * flattening Merkle tree structures or streaming it to a worker. Technically, - * the server could implement a separate metadata store, but this results in a - * significantly more complicated implementation as opposed to having the - * client specify the size up-front (or storing the size along with the digest - * in every message where digests are embedded). This does mean that the API - * leaks some implementation details of (what we consider to be) a reasonable - * server implementation, but we consider this to be a worthwhile tradeoff. - * When a `Digest` is used to refer to a proto message, it always refers to - * the message in binary encoded form. To ensure consistent hashing, clients - * and servers MUST ensure that they serialize messages according to the - * following rules, even if there are alternate valid encodings for the same - * message: * Fields are serialized in tag order. * There are no unknown - * fields. * There are no duplicate fields. * Fields are serialized according - * to the default semantics for their type. Most protocol buffer - * implementations will always follow these rules when serializing, but care - * should be taken to avoid shortcuts. For instance, concatenating two - * messages to merge them may produce duplicate fields. + * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message: * Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. */ export interface Schema$BuildBazelRemoteExecutionV2Digest { /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** @@ -416,30 +245,7 @@ export namespace remotebuildexecution_v1 { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero - * or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` - * contains its name in the directory, either the digest of its content - * (either a file blob or a `Directory` proto) or a symlink target, as well as - * possibly some metadata about the file or directory. In order to ensure - * that two equivalent directory trees hash to the same value, the following - * restrictions MUST be obeyed when constructing a a `Directory`: * Every - * child in the directory must have a path of exactly one segment. Multiple - * levels of directory hierarchy may not be collapsed. * Each child in the - * directory must have a unique path segment (file name). * The files, - * directories and symlinks in the directory must each be sorted in - * lexicographical order by path. The path strings must be sorted by code - * point, equivalently, by UTF-8 bytes. A `Directory` that obeys the - * restrictions is said to be in canonical form. As an example, the following - * could be used for a file named `bar` and a directory named `foo` with an - * executable file named `baz` (hashes shortened for readability): ```json // - * (Directory proto) { files: [ { name: "bar", digest: { - * hash: "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { hash: - * "4cf2eda940...", size: 43 } } ] } // - * (Directory proto with hash "4cf2eda940..." and size 43) { files: - * [ { name: "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, is_executable: true - * } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$BuildBazelRemoteExecutionV2Directory { /** @@ -456,13 +262,11 @@ export namespace remotebuildexecution_v1 { symlinks?: Schema$BuildBazelRemoteExecutionV2SymlinkNode[]; } /** - * A `DirectoryNode` represents a child of a Directory which is itself a - * `Directory` and its associated metadata. + * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. */ export interface Schema$BuildBazelRemoteExecutionV2DirectoryNode { /** - * The digest of the Directory object represented. See Digest for - * information about how to take the digest of a proto message. + * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. */ digest?: Schema$BuildBazelRemoteExecutionV2Digest; /** @@ -516,8 +320,7 @@ export namespace remotebuildexecution_v1 { workerStartTimestamp?: string; } /** - * Metadata about an ongoing execution, which will be contained in the - * metadata field of the Operation. + * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. */ export interface Schema$BuildBazelRemoteExecutionV2ExecuteOperationMetadata { /** @@ -526,19 +329,16 @@ export namespace remotebuildexecution_v1 { actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest; stage?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard error. + * If set, the client can use this name with ByteStream.Read to stream the standard error. */ stderrStreamName?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard output. + * If set, the client can use this name with ByteStream.Read to stream the standard output. */ stdoutStreamName?: string; } /** - * The response message for Execution.Execute, which will be contained in the - * response field of the Operation. + * The response message for Execution.Execute, which will be contained in the response field of the Operation. */ export interface Schema$BuildBazelRemoteExecutionV2ExecuteResponse { /** @@ -546,9 +346,7 @@ export namespace remotebuildexecution_v1 { */ cachedResult?: boolean; /** - * Freeform informational message with details on the execution of the - * action that may be displayed to the user upon failure or when requested - * explicitly. + * Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly. */ message?: string; /** @@ -556,25 +354,11 @@ export namespace remotebuildexecution_v1 { */ result?: Schema$BuildBazelRemoteExecutionV2ActionResult; /** - * An optional list of additional log outputs the server wishes to provide. - * A server can use this to return execution-specific logs however it - * wishes. This is intended primarily to make it easier for users to debug - * issues that may be outside of the actual job execution, such as by - * identifying the worker executing the action or by providing logs from the - * worker's setup phase. The keys SHOULD be human readable so that a - * client can display them to a user. + * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ serverLogs?: {[key: string]: Schema$BuildBazelRemoteExecutionV2LogFile}; /** - * If the status has a code other than `OK`, it indicates that the action - * did not finish execution. For example, if the operation times out during - * execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST - * use this field for errors in execution, rather than the error field on - * the `Operation` object. If the status code is other than `OK`, then the - * result MUST NOT be cached. For an error status, the `result` field is - * optional; the server may populate the output-, stdout-, and - * stderr-related fields if it has any information available, such as the - * stdout and stderr of a timed-out action. + * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ status?: Schema$GoogleRpcStatus; } @@ -604,36 +388,25 @@ export namespace remotebuildexecution_v1 { */ digest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * This is a hint as to the purpose of the log, and is set to true if the - * log is human-readable text that can be usefully displayed to a user, and - * false otherwise. For instance, if a command-line client wishes to print - * the server logs to the terminal for a failed action, this allows it to - * avoid displaying a binary file. + * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ humanReadable?: boolean; } /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a - * directory's full contents rather than a single file. + * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. */ export interface Schema$BuildBazelRemoteExecutionV2OutputDirectory { /** - * The full path of the directory relative to the working directory. The - * path separator is a forward slash `/`. Since this is a relative path, it - * MUST NOT begin with a leading forward slash. The empty string value is - * allowed, and it denotes the entire working directory. + * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ path?: string; /** - * The digest of the encoded Tree proto containing the directory's - * contents. + * The digest of the encoded Tree proto containing the directory's contents. */ treeDigest?: Schema$BuildBazelRemoteExecutionV2Digest; } /** - * An `OutputFile` is similar to a FileNode, but it is used as an output in an - * `ActionResult`. It allows a full file path rather than only a name. - * `OutputFile` is binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. `OutputFile` is binary-compatible with `FileNode`. */ export interface Schema$BuildBazelRemoteExecutionV2OutputFile { /** @@ -645,62 +418,34 @@ export namespace remotebuildexecution_v1 { */ isExecutable?: boolean; /** - * The full path of the file relative to the working directory, including - * the filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the file relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; } /** - * An `OutputSymlink` is similar to a Symlink, but it is used as an output in - * an `ActionResult`. `OutputSymlink` is binary-compatible with - * `SymlinkNode`. + * An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. */ export interface Schema$BuildBazelRemoteExecutionV2OutputSymlink { /** - * The full path of the symlink relative to the working directory, including - * the filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the symlink relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; /** - * The target path of the symlink. The path separator is a forward slash - * `/`. The target path can be relative to the parent directory of the - * symlink or it can be an absolute path starting with `/`. Support for - * absolute paths can be checked using the Capabilities API. The canonical - * form forbids the substrings `/./` and `//` in the target path. `..` - * components are allowed anywhere in the target path. + * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ target?: string; } /** - * A `Platform` is a set of requirements, such as hardware, operating system, - * or compiler toolchain, for an Action's execution environment. A - * `Platform` is represented as a series of key-value pairs representing the - * properties that are required of the platform. + * A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform. */ export interface Schema$BuildBazelRemoteExecutionV2Platform { /** - * The properties that make up this platform. In order to ensure that - * equivalent `Platform`s always hash to the same value, the properties MUST - * be lexicographically sorted by name, and then by value. Sorting of - * strings is done by code point, equivalently, by the UTF-8 bytes. + * The properties that make up this platform. In order to ensure that equivalent `Platform`s always hash to the same value, the properties MUST be lexicographically sorted by name, and then by value. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ properties?: Schema$BuildBazelRemoteExecutionV2PlatformProperty[]; } /** - * A single property for the environment. The server is responsible for - * specifying the property `name`s that it accepts. If an unknown `name` is - * provided in the requirements for an Action, the server SHOULD reject the - * execution request. If permitted by the server, the same `name` may occur - * multiple times. The server is also responsible for specifying the - * interpretation of property `value`s. For instance, a property describing - * how much RAM must be available may be interpreted as allowing a worker with - * 16GB to fulfill a request for 8GB, while a property describing the OS - * environment on which the action must be performed may require an exact - * match with the worker's OS. The server MAY use the `value` of one or - * more properties to determine how it sets up the execution environment, such - * as by making specific system files available to the worker. + * A single property for the environment. The server is responsible for specifying the property `name`s that it accepts. If an unknown `name` is provided in the requirements for an Action, the server SHOULD reject the execution request. If permitted by the server, the same `name` may occur multiple times. The server is also responsible for specifying the interpretation of property `value`s. For instance, a property describing how much RAM must be available may be interpreted as allowing a worker with 16GB to fulfill a request for 8GB, while a property describing the OS environment on which the action must be performed may require an exact match with the worker's OS. The server MAY use the `value` of one or more properties to determine how it sets up the execution environment, such as by making specific system files available to the worker. */ export interface Schema$BuildBazelRemoteExecutionV2PlatformProperty { /** @@ -713,24 +458,15 @@ export namespace remotebuildexecution_v1 { value?: string; } /** - * An optional Metadata to attach to any RPC request to tell the server about - * an external context of the request. The server may use this for logging or - * other purposes. To use it, the client attaches the header to the call using - * the canonical proto serialization: * name: - * `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the - * base64 encoded binary `RequestMetadata` message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. */ export interface Schema$BuildBazelRemoteExecutionV2RequestMetadata { /** - * An identifier that ties multiple requests to the same action. For - * example, multiple requests to the CAS, Action Cache, and Execution API - * are used in order to compile foo.cc. + * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ actionId?: string; /** - * An identifier to tie multiple tool invocations together. For example, - * runs of foo_test, bar_test and baz_test on a post-submit of a given - * patch. + * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ correlatedInvocationsId?: string; /** @@ -738,8 +474,7 @@ export namespace remotebuildexecution_v1 { */ toolDetails?: Schema$BuildBazelRemoteExecutionV2ToolDetails; /** - * An identifier that ties multiple actions together to a final result. For - * example, multiple actions are required to build and run foo_test. + * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ toolInvocationId?: string; } @@ -752,12 +487,7 @@ export namespace remotebuildexecution_v1 { */ name?: string; /** - * The target path of the symlink. The path separator is a forward slash - * `/`. The target path can be relative to the parent directory of the - * symlink or it can be an absolute path starting with `/`. Support for - * absolute paths can be checked using the Capabilities API. The canonical - * form forbids the substrings `/./` and `//` in the target path. `..` - * components are allowed anywhere in the target path. + * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ target?: string; } @@ -775,15 +505,11 @@ export namespace remotebuildexecution_v1 { toolVersion?: string; } /** - * A `Tree` contains all the Directory protos in a single directory Merkle - * tree, compressed into one message. + * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. */ export interface Schema$BuildBazelRemoteExecutionV2Tree { /** - * All the child directories: the directories referred to by the root and, - * recursively, all its children. In order to reconstruct the directory - * tree, the client must take the digests of each of the child directories - * and then build up a tree starting from the `root`. + * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. */ children?: Schema$BuildBazelRemoteExecutionV2Directory[]; /** @@ -801,18 +527,15 @@ export namespace remotebuildexecution_v1 { resourceName?: string; } /** - * CommandDuration contains the various duration metrics tracked when a bot - * performs a command. + * CommandDuration contains the various duration metrics tracked when a bot performs a command. */ export interface Schema$GoogleDevtoolsRemotebuildbotCommandDurations { /** - * The time spent preparing the command to be run in a Docker container - * (includes pulling the Docker image, if necessary). + * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ dockerPrep?: string; /** - * The time spent downloading the input files and constructing the working - * directory. + * The time spent downloading the input files and constructing the working directory. */ download?: string; /** @@ -837,13 +560,11 @@ export namespace remotebuildexecution_v1 { upload?: string; } /** - * CommandEvents contains counters for the number of warnings and errors that - * occurred during the execution of a command. + * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. */ export interface Schema$GoogleDevtoolsRemotebuildbotCommandEvents { /** - * Indicates whether we are using a cached Docker image (true) or had to - * pull the Docker image (false) for this command. + * Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command. */ dockerCacheHit?: boolean; /** @@ -864,20 +585,15 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest { /** - * Specifies the instance to create. The name in the instance, if specified - * in the instance, is ignored. + * Specifies the instance to create. The name in the instance, if specified in the instance, is ignored. */ instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; /** - * ID of the created instance. A valid `instance_id` must: be 6-50 - * characters long, contain only lowercase letters, digits, hyphens and - * underscores, start with a lowercase letter, and end with a lowercase - * letter or a digit. + * ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ instanceId?: string; /** - * Resource name of the project containing the instance. Format: - * `projects/[PROJECT_ID]`. + * Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. */ parent?: string; } @@ -886,20 +602,15 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest { /** - * Resource name of the instance in which to create the new worker pool. - * Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; /** - * ID of the created worker pool. A valid pool ID must: be 6-50 characters - * long, contain only lowercase letters, digits, hyphens and underscores, - * start with a lowercase letter, and end with a lowercase letter or a - * digit. + * ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ poolId?: string; /** - * Specifies the worker pool to create. The name in the worker pool, if - * specified, is ignored. + * Specifies the worker pool to create. The name in the worker pool, if specified, is ignored. */ workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool; } @@ -908,8 +619,7 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest { /** - * Name of the instance to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -918,8 +628,7 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest { /** - * Name of the worker pool to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } @@ -928,8 +637,7 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest { /** - * Name of the instance to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -938,17 +646,12 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest { /** - * Name of the worker pool to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } /** - * Instance conceptually encapsulates all Remote Build Execution resources for - * remote builds. An instance consists of storage and compute resources (for - * example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used - * for running remote builds. All Remote Build Execution API calls are scoped - * to an instance. + * Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance { /** @@ -960,10 +663,7 @@ export namespace remotebuildexecution_v1 { */ loggingEnabled?: boolean; /** - * Output only. Instance resource name formatted as: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be - * populated when creating an instance since it is provided in the - * `instance_id` field. + * Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. */ name?: string; /** @@ -985,8 +685,7 @@ export namespace remotebuildexecution_v1 { } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest { /** - * Resource name of the instance. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; } @@ -1001,13 +700,7 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest { /** - * The update mask applies to worker_pool. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * If an empty update_mask is provided, only the non-default valued field in - * the worker pool field will be updated. Note that in order to update a - * field to the default value (zero, false, empty string) an explicit - * update_mask must be provided. + * The update mask applies to worker_pool. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ updateMask?: string; /** @@ -1016,37 +709,27 @@ export namespace remotebuildexecution_v1 { workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool; } /** - * Defines the configuration to be used for a creating workers in the worker - * pool. + * Defines the configuration to be used for a creating workers in the worker pool. */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig { /** - * Required. Size of the disk attached to the worker, in GB. See - * https://cloud.google.com/compute/docs/disks/ + * Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ */ diskSizeGb?: string; /** - * Required. Disk Type to use for the worker. See [Storage - * options](https://cloud.google.com/compute/docs/disks/#introduction). - * Currently only `pd-standard` is supported. + * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. */ diskType?: string; /** - * Required. Machine type of the worker, such as `n1-standard-2`. See - * https://cloud.google.com/compute/docs/machine-types for a list of - * supported machine types. Note that `f1-micro` and `g1-small` are not yet - * supported. + * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ machineType?: string; /** - * Minimum CPU platform to use when creating the worker. See [CPU - * Platforms](https://cloud.google.com/compute/docs/cpu-platforms). + * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ minCpuPlatform?: string; /** - * Determines whether the worker is reserved (equivalent to a Compute Engine - * on-demand VM and therefore won't be preempted). See [Preemptible - * VMs](https://cloud.google.com/preemptible-vms/) for more details. + * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ reserved?: boolean; } @@ -1055,10 +738,7 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool { /** - * WorkerPool resource name formatted as: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - * name should not be populated when creating a worker pool since it is - * provided in the `poolId` field. + * WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field. */ name?: string; /** @@ -1066,13 +746,11 @@ export namespace remotebuildexecution_v1 { */ state?: string; /** - * Specifies the properties, such as machine type and disk size, used for - * creating workers in a worker pool. + * Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool. */ workerConfig?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig; /** - * The desired number of workers in the worker pool. Must be a value between - * 0 and 1000. + * The desired number of workers in the worker pool. Must be a value between 0 and 1000. */ workerCount?: string; } @@ -1085,101 +763,45 @@ export namespace remotebuildexecution_v1 { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested - * in the `output_directories` field of the Action, if the corresponding - * directory existed after the action completed, a single entry will be - * present in the output list, which will contain the digest of a Tree - * message containing the directory tree, and the path equal exactly to the - * corresponding Action output_directories member. As an example, suppose - * the Action had an output directory `a/b/dir` and the execution produced - * the following contents in `a/b/dir`: a file named `bar` and a directory - * named `foo` with an executable file named `baz`. Then, output_directory - * will contain (hashes shortened for readability): ```json // - * OutputDirectory proto: { path: "a/b/dir" tree_digest: { - * hash: "4a73bc9d03...", size: 55 } } // Tree proto with - * hash "4a73bc9d03..." and size 55: { root: { files: [ { - * name: "bar", digest: { hash: - * "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { - * hash: "4cf2eda940...", size: 43 } } ] - * } children : { // (Directory proto with hash - * "4cf2eda940..." and size 43) files: [ { name: - * "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, - * is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ outputDirectories?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory[]; /** - * The output files of the action. For each output file requested in the - * `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present in the output - * list. If the action does not produce the requested output, or produces a - * directory where a regular file is expected or vice versa, then that - * output will be omitted from the list. The server is free to arrange the - * output list as desired; clients MUST NOT assume that the output list is - * sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile[]; /** - * The digest for a blob containing the standard error of the action, which - * can be retrieved from the ContentAddressableStorage. See `stderr_raw` for - * when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. */ stderrDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The standard error buffer of the action. The server will determine, based - * on the size of the buffer, whether to return it in raw form or to return - * a digest in `stderr_digest` that points to the buffer. If neither is set, - * then the buffer is empty. The client SHOULD NOT assume it will get one of - * the raw buffer or a digest on any given request and should be prepared to - * handle either. + * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which - * can be retrieved from the ContentAddressableStorage. See `stdout_raw` for - * when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ stdoutDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The standard output buffer of the action. The server will determine, - * based on the size of the buffer, whether to return it in raw form or to - * return a digest in `stdout_digest` that points to the buffer. If neither - * is set, then the buffer is empty. The client SHOULD NOT assume it will - * get one of the raw buffer or a digest on any given request and should be - * prepared to handle either. + * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stdoutRaw?: string; } /** - * A `Command` is the actual command executed by a worker running an Action. - * Except as otherwise required, the environment (such as which system - * libraries or binaries are available, and what filesystems are mounted - * where) is defined by and specific to the implementation of the remote - * execution API. + * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommand { /** - * The arguments to the command. The first argument must be the path to the - * executable, which must be either a relative path, in which case it is - * evaluated with respect to the input root, or an absolute path. The - * working directory will always be the input root. + * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. */ arguments?: string[]; /** - * The environment variables to set when running the program. The worker may - * provide its own default environment variables; these defaults can be - * overridden using this field. Additional variables can also be specified. - * In order to ensure that equivalent `Command`s always hash to the same - * value, the environment variables MUST be lexicographically sorted by - * name. Sorting of strings is done by code point, equivalently, by the - * UTF-8 bytes. + * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ environmentVariables?: Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable[]; } /** - * An `EnvironmentVariable` is one variable to set in the running - * program's environment. + * An `EnvironmentVariable` is one variable to set in the running program's environment. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable { /** @@ -1192,36 +814,11 @@ export namespace remotebuildexecution_v1 { value?: string; } /** - * A content digest. A digest for a given blob consists of the size of the - * blob and its hash. The hash algorithm to use is defined by the server, but - * servers SHOULD use SHA-256. The size is considered to be an integral part - * of the digest and cannot be separated. That is, even if the `hash` field is - * correctly specified but `size_bytes` is not, the server MUST reject the - * request. The reason for including the size in the digest is as follows: in - * a great many cases, the server needs to know the size of the blob it is - * about to work with prior to starting an operation with it, such as - * flattening Merkle tree structures or streaming it to a worker. Technically, - * the server could implement a separate metadata store, but this results in a - * significantly more complicated implementation as opposed to having the - * client specify the size up-front (or storing the size along with the digest - * in every message where digests are embedded). This does mean that the API - * leaks some implementation details of (what we consider to be) a reasonable - * server implementation, but we consider this to be a worthwhile tradeoff. - * When a `Digest` is used to refer to a proto message, it always refers to - * the message in binary encoded form. To ensure consistent hashing, clients - * and servers MUST ensure that they serialize messages according to the - * following rules, even if there are alternate valid encodings for the same - * message. - Fields are serialized in tag order. - There are no unknown - * fields. - There are no duplicate fields. - Fields are serialized according - * to the default semantics for their type. Most protocol buffer - * implementations will always follow these rules when serializing, but care - * should be taken to avoid shortcuts. For instance, concatenating two - * messages to merge them may produce duplicate fields. + * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDigest { /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** @@ -1230,29 +827,7 @@ export namespace remotebuildexecution_v1 { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero - * or more children FileNodes and DirectoryNodes. Each `Node` contains its - * name in the directory, the digest of its content (either a file blob or a - * `Directory` proto), as well as possibly some metadata about the file or - * directory. In order to ensure that two equivalent directory trees hash to - * the same value, the following restrictions MUST be obeyed when constructing - * a a `Directory`: - Every child in the directory must have a path of - * exactly one segment. Multiple levels of directory hierarchy may not be - * collapsed. - Each child in the directory must have a unique path segment - * (file name). - The files and directories in the directory must each be - * sorted in lexicographical order by path. The path strings must be - * sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that - * obeys the restrictions is said to be in canonical form. As an example, the - * following could be used for a file named `bar` and a directory named `foo` - * with an executable file named `baz` (hashes shortened for readability): - * ```json // (Directory proto) { files: [ { name: - * "bar", digest: { hash: "4a73bc9d03...", - * size: 65534 } } ], directories: [ { name: - * "foo", digest: { hash: "4cf2eda940...", - * size: 43 } } ] } // (Directory proto with hash - * "4cf2eda940..." and size 43) { files: [ { name: - * "baz", digest: { hash: "b2c941073e...", - * size: 1294, }, is_executable: true } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectory { /** @@ -1265,13 +840,11 @@ export namespace remotebuildexecution_v1 { files?: Schema$GoogleDevtoolsRemoteexecutionV1testFileNode[]; } /** - * A `DirectoryNode` represents a child of a Directory which is itself a - * `Directory` and its associated metadata. + * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode { /** - * The digest of the Directory object represented. See Digest for - * information about how to take the digest of a proto message. + * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** @@ -1280,8 +853,7 @@ export namespace remotebuildexecution_v1 { name?: string; } /** - * Metadata about an ongoing execution, which will be contained in the - * metadata field of the Operation. + * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata { /** @@ -1290,19 +862,16 @@ export namespace remotebuildexecution_v1 { actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; stage?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard error. + * If set, the client can use this name with ByteStream.Read to stream the standard error. */ stderrStreamName?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard output. + * If set, the client can use this name with ByteStream.Read to stream the standard output. */ stdoutStreamName?: string; } /** - * The response message for Execution.Execute, which will be contained in the - * response field of the Operation. + * The response message for Execution.Execute, which will be contained in the response field of the Operation. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteResponse { /** @@ -1314,27 +883,13 @@ export namespace remotebuildexecution_v1 { */ result?: Schema$GoogleDevtoolsRemoteexecutionV1testActionResult; /** - * An optional list of additional log outputs the server wishes to provide. - * A server can use this to return execution-specific logs however it - * wishes. This is intended primarily to make it easier for users to debug - * issues that may be outside of the actual job execution, such as by - * identifying the worker executing the action or by providing logs from the - * worker's setup phase. The keys SHOULD be human readable so that a - * client can display them to a user. + * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ serverLogs?: { [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; }; /** - * If the status has a code other than `OK`, it indicates that the action - * did not finish execution. For example, if the operation times out during - * execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST - * use this field for errors in execution, rather than the error field on - * the `Operation` object. If the status code is other than `OK`, then the - * result MUST NOT be cached. For an error status, the `result` field is - * optional; the server may populate the output-, stdout-, and - * stderr-related fields if it has any information available, such as the - * stdout and stderr of a timed-out action. + * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ status?: Schema$GoogleRpcStatus; } @@ -1364,17 +919,12 @@ export namespace remotebuildexecution_v1 { */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * This is a hint as to the purpose of the log, and is set to true if the - * log is human-readable text that can be usefully displayed to a user, and - * false otherwise. For instance, if a command-line client wishes to print - * the server logs to the terminal for a failed action, this allows it to - * avoid displaying a binary file. + * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ humanReadable?: boolean; } /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a - * directory's full contents rather than a single file. + * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory { /** @@ -1382,32 +932,20 @@ export namespace remotebuildexecution_v1 { */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The full path of the directory relative to the working directory. The - * path separator is a forward slash `/`. Since this is a relative path, it - * MUST NOT begin with a leading forward slash. The empty string value is - * allowed, and it denotes the entire working directory. + * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ path?: string; /** - * The digest of the encoded Tree proto containing the directory's - * contents. + * The digest of the encoded Tree proto containing the directory's contents. */ treeDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; } /** - * An `OutputFile` is similar to a FileNode, but it is tailored for output as - * part of an `ActionResult`. It allows a full file path rather than only a - * name, and allows the server to include content inline. `OutputFile` is - * binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline. `OutputFile` is binary-compatible with `FileNode`. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile { /** - * The raw content of the file. This field may be used by the server to - * provide the content of a file inline in an ActionResult and avoid - * requiring that the client make a separate call to - * [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD - * NOT assume that it will get raw content with any request, and always be - * prepared to retrieve it via `digest`. + * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. */ content?: string; /** @@ -1419,31 +957,20 @@ export namespace remotebuildexecution_v1 { */ isExecutable?: boolean; /** - * The full path of the file relative to the input root, including the - * filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; } /** - * An optional Metadata to attach to any RPC request to tell the server about - * an external context of the request. The server may use this for logging or - * other purposes. To use it, the client attaches the header to the call using - * the canonical proto serialization: name: - * google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the - * base64 encoded binary RequestMetadata message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testRequestMetadata { /** - * An identifier that ties multiple requests to the same action. For - * example, multiple requests to the CAS, Action Cache, and Execution API - * are used in order to compile foo.cc. + * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ actionId?: string; /** - * An identifier to tie multiple tool invocations together. For example, - * runs of foo_test, bar_test and baz_test on a post-submit of a given - * patch. + * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ correlatedInvocationsId?: string; /** @@ -1451,8 +978,7 @@ export namespace remotebuildexecution_v1 { */ toolDetails?: Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails; /** - * An identifier that ties multiple actions together to a final result. For - * example, multiple actions are required to build and run foo_test. + * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ toolInvocationId?: string; } @@ -1470,15 +996,11 @@ export namespace remotebuildexecution_v1 { toolVersion?: string; } /** - * A `Tree` contains all the Directory protos in a single directory Merkle - * tree, compressed into one message. + * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testTree { /** - * All the child directories: the directories referred to by the root and, - * recursively, all its children. In order to reconstruct the directory - * tree, the client must take the digests of each of the child directories - * and then build up a tree starting from the `root`. + * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. */ children?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory[]; /** @@ -1487,16 +1009,7 @@ export namespace remotebuildexecution_v1 { root?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory; } /** - * AdminTemp is a prelimiary set of administration tasks. It's called - * "Temp" because we do not yet know the best way to represent admin - * tasks; it's possible that this will be entirely replaced in later - * versions of this API. If this message proves to be sufficient, it will be - * renamed in the alpha or beta release of this API. This message (suitably - * marshalled into a protobuf.Any) can be used as the inline_assignment field - * in a lease; the lease assignment field should simply be `"admin"` - * in these cases. This message is heavily based on Swarming administration - * tasks from the LUCI project - * (http://github.com/luci/luci-py/appengine/swarming). + * AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `"admin"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming). */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2AdminTemp { /** @@ -1522,91 +1035,62 @@ export namespace remotebuildexecution_v1 { digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; } /** - * DEPRECATED - use CommandResult instead. Describes the actual outputs from - * the task. + * DEPRECATED - use CommandResult instead. Describes the actual outputs from the task. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOutputs { /** - * exit_code is only fully reliable if the status' code is OK. If the - * task exceeded its deadline or was cancelled, the process may still - * produce an exit code as it is cancelled, and this will be populated, but - * a successful (zero) is unlikely to be correct unless the status code is - * OK. + * exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK. */ exitCode?: number; /** - * The output files. The blob referenced by the digest should contain one of - * the following (implementation-dependent): * A marshalled - * DirectoryMetadata of the returned filesystem * A LUCI-style .isolated - * file + * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; } /** - * DEPRECATED - use CommandResult instead. Can be used as part of - * CompleteRequest.metadata, or are part of a more sophisticated message. + * DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest.metadata, or are part of a more sophisticated message. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOverhead { /** - * The elapsed time between calling Accept and Complete. The server will - * also have its own idea of what this should be, but this excludes the - * overhead of the RPCs and the bot response time. + * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ duration?: string; /** - * The amount of time *not* spent executing the command (ie - * uploading/downloading files). + * The amount of time *not* spent executing the command (ie uploading/downloading files). */ overhead?: string; } /** - * All information about the execution of a command, suitable for providing as - * the Bots interface's `Lease.result` field. + * All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandResult { /** - * The elapsed time between calling Accept and Complete. The server will - * also have its own idea of what this should be, but this excludes the - * overhead of the RPCs and the bot response time. + * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ duration?: string; /** - * The exit code of the process. An exit code of "0" should only - * be trusted if `status` has a code of OK (otherwise it may simply be - * unset). + * The exit code of the process. An exit code of "0" should only be trusted if `status` has a code of OK (otherwise it may simply be unset). */ exitCode?: number; /** - * Implementation-dependent metadata about the task. Both servers and bots - * may define messages which can be encoded here; bots are free to provide - * metadata in multiple formats, and servers are free to choose one or more - * of the values to process and ignore others. In particular, it is *not* - * considered an error for the bot to provide the server with a field that - * it doesn't know about. + * Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about. */ metadata?: Array<{[key: string]: any}>; /** - * The output files. The blob referenced by the digest should contain one of - * the following (implementation-dependent): * A marshalled - * DirectoryMetadata of the returned filesystem * A LUCI-style .isolated - * file + * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** - * The amount of time *not* spent executing the command (ie - * uploading/downloading files). + * The amount of time *not* spent executing the command (ie uploading/downloading files). */ overhead?: string; /** - * An overall status for the command. For example, if the command timed out, - * this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS - * for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. + * An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. */ status?: Schema$GoogleRpcStatus; } /** - * Describes a shell-style task to execute, suitable for providing as the Bots - * interface's `Lease.payload` field. + * Describes a shell-style task to execute, suitable for providing as the Bots interface's `Lease.payload` field. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTask { /** @@ -1627,14 +1111,7 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs { /** - * The command itself to run (e.g., argv). This field should be passed - * directly to the underlying operating system, and so it must be sensible - * to that operating system. For example, on Windows, the first argument - * might be "C:\Windows\System32\ping.exe" - that is, using drive - * letters and backslashes. A command for a *nix system, on the other hand, - * would use forward slashes. All other fields in the RWAPI must - * consistently use forward slashes, since those fields may be interpretted - * by both the service and the bot. + * The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be "C:\Windows\System32\ping.exe" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpretted by both the service and the bot. */ arguments?: string[]; /** @@ -1642,28 +1119,15 @@ export namespace remotebuildexecution_v1 { */ environmentVariables?: Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable[]; /** - * The input filesystem to be set up prior to the task beginning. The - * contents should be a repeated set of FileMetadata messages though other - * formats are allowed if better for the implementation (eg, a LUCI-style - * .isolated file). This field is repeated since implementations might want - * to cache the metadata, in which case it may be useful to break up - * portions of the filesystem that change frequently (eg, specific input - * files) from those that don't (eg, standard header files). + * The input filesystem to be set up prior to the task beginning. The contents should be a repeated set of FileMetadata messages though other formats are allowed if better for the implementation (eg, a LUCI-style .isolated file). This field is repeated since implementations might want to cache the metadata, in which case it may be useful to break up portions of the filesystem that change frequently (eg, specific input files) from those that don't (eg, standard header files). */ files?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest[]; /** - * Inline contents for blobs expected to be needed by the bot to execute the - * task. For example, contents of entries in `files` or blobs that are - * indirectly referenced by an entry there. The bot should check against - * this list before downloading required task inputs to reduce the number of - * communications between itself and the remote CAS server. + * Inline contents for blobs expected to be needed by the bot to execute the task. For example, contents of entries in `files` or blobs that are indirectly referenced by an entry there. The bot should check against this list before downloading required task inputs to reduce the number of communications between itself and the remote CAS server. */ inlineBlobs?: Schema$GoogleDevtoolsRemoteworkersV1test2Blob[]; /** - * Directory from which a command is executed. It is a relative directory - * with respect to the bot's working directory (i.e., "./"). - * If it is non-empty, then it must exist under "./". Otherwise, - * "./" will be used. + * Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., "./"). If it is non-empty, then it must exist under "./". Otherwise, "./" will be used. */ workingDirectory?: string; } @@ -1685,29 +1149,19 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs { /** - * A list of expected directories, relative to the execution root. All paths - * MUST be delimited by forward slashes. + * A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes. */ directories?: string[]; /** - * A list of expected files, relative to the execution root. All paths MUST - * be delimited by forward slashes. + * A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes. */ files?: string[]; /** - * The destination to which any stderr should be sent. The method by which - * the bot should send the stream contents to that destination is not - * defined in this API. As examples, the destination could be a file - * referenced in the `files` field in this message, or it could be a URI - * that must be written via the ByteStream API. + * The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ stderrDestination?: string; /** - * The destination to which any stdout should be sent. The method by which - * the bot should send the stream contents to that destination is not - * defined in this API. As examples, the destination could be a file - * referenced in the `files` field in this message, or it could be a URI - * that must be written via the ByteStream API. + * The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ stdoutDestination?: string; } @@ -1716,55 +1170,33 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts { /** - * This specifies the maximum time that the task can run, excluding the time - * required to download inputs or upload outputs. That is, the worker will - * terminate the task if it runs longer than this. + * This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this. */ execution?: string; /** - * This specifies the maximum amount of time the task can be idle - that is, - * go without generating some output in either stdout or stderr. If the - * process is silent for more than the specified time, the worker will - * terminate the task. + * This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task. */ idle?: string; /** - * If the execution or IO timeouts are exceeded, the worker will try to - * gracefully terminate the task and return any existing logs. However, - * tasks may be hard-frozen in which case this process will fail. This - * timeout specifies how long to wait for a terminated task to shut down - * gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. - * SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). + * If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). */ shutdown?: string; } /** - * The CommandTask and CommandResult messages assume the existence of a - * service that can serve blobs of content, identified by a hash and size - * known as a "digest." The method by which these blobs may be - * retrieved is not specified here, but a model implementation is in the - * Remote Execution API's "ContentAddressibleStorage" interface. - * In the context of the RWAPI, a Digest will virtually always refer to the - * contents of a file or a directory. The latter is represented by the - * byte-encoded Directory message. + * The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2Digest { /** - * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, - * 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). + * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). */ hash?: string; /** - * The size of the contents. While this is not strictly required as part of - * an identifier (after all, any given hash will have exactly one canonical - * size), it's useful in almost all cases when one might want to send or - * retrieve blobs of content and is included here for this reason. + * The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason. */ sizeBytes?: string; } /** - * The contents of a directory. Similar to the equivalent message in the - * Remote Execution API. + * The contents of a directory. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2Directory { /** @@ -1777,13 +1209,11 @@ export namespace remotebuildexecution_v1 { files?: Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata[]; } /** - * The metadata for a directory. Similar to the equivalent message in the - * Remote Execution API. + * The metadata for a directory. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata { /** - * A pointer to the contents of the directory, in the form of a marshalled - * Directory message. + * A pointer to the contents of the directory, in the form of a marshalled Directory message. */ digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** @@ -1792,18 +1222,15 @@ export namespace remotebuildexecution_v1 { path?: string; } /** - * The metadata for a file. Similar to the equivalent message in the Remote - * Execution API. + * The metadata for a file. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata { /** - * If the file is small enough, its contents may also or alternatively be - * listed here. + * If the file is small enough, its contents may also or alternatively be listed here. */ contents?: string; /** - * A pointer to the contents of the file. The method by which a client - * retrieves the contents from a CAS system is not defined here. + * A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here. */ digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** @@ -1811,11 +1238,7 @@ export namespace remotebuildexecution_v1 { */ isExecutable?: boolean; /** - * The path of this file. If this message is part of the - * CommandOutputs.outputs fields, the path is relative to the execution root - * and must correspond to an entry in CommandTask.outputs.files. If this - * message is part of a Directory message, then the path is relative to the - * root of that directory. All paths MUST be delimited by forward slashes. + * The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes. */ path?: string; } @@ -1837,14 +1260,11 @@ export namespace remotebuildexecution_v1 { operations?: Schema$GoogleLongrunningOperation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1852,72 +1272,24 @@ export namespace remotebuildexecution_v1 { */ error?: Schema$GoogleRpcStatus; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobufEmpty {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpcStatus { /** @@ -1925,14 +1297,11 @@ export namespace remotebuildexecution_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1941,28 +1310,19 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleWatcherV1Change { /** - * If true, this Change is followed by more Changes that are in the same - * group as this Change. + * If true, this Change is followed by more Changes that are in the same group as this Change. */ continued?: boolean; /** - * The actual change data. This field is present only when `state() == - * EXISTS` or `state() == ERROR`. Please see google.protobuf.Any about how - * to use the Any type. + * The actual change data. This field is present only when `state() == EXISTS` or `state() == ERROR`. Please see google.protobuf.Any about how to use the Any type. */ data?: {[key: string]: any}; /** - * Name of the element, interpreted relative to the entity's actual - * name. "" refers to the entity itself. The element name is a - * valid UTF-8 string. + * Name of the element, interpreted relative to the entity's actual name. "" refers to the entity itself. The element name is a valid UTF-8 string. */ element?: string; /** - * If present, provides a compact representation of all the messages that - * have been received by the caller for the given entity, e.g., it could be - * a sequence number or a multi-part timestamp/version vector. This marker - * can be provided in the Request message, allowing the caller to resume the - * stream watching at a specific point without fetching the initial state. + * If present, provides a compact representation of all the messages that have been received by the caller for the given entity, e.g., it could be a sequence number or a multi-part timestamp/version vector. This marker can be provided in the Request message, allowing the caller to resume the stream watching at a specific point without fetching the initial state. */ resumeMarker?: string; /** @@ -1988,8 +1348,7 @@ export namespace remotebuildexecution_v1 { /** * remotebuildexecution.media.download - * @desc Downloads media. Download is supported on the URI - * `/v1/media/{+name}?alt=media`. + * @desc Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`. * @alias remotebuildexecution.media.download * @memberOf! () * @@ -2067,8 +1426,7 @@ export namespace remotebuildexecution_v1 { /** * remotebuildexecution.media.upload - * @desc Uploads media. Upload is supported on the URI - * `/upload/v1/media/{+name}`. + * @desc Uploads media. Upload is supported on the URI `/upload/v1/media/{+name}`. * @alias remotebuildexecution.media.upload * @memberOf! () * @@ -2158,8 +1516,7 @@ export namespace remotebuildexecution_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the media that is being downloaded. See - * ReadRequest.resource_name. + * Name of the media that is being downloaded. See ReadRequest.resource_name. */ resourceName?: string; } @@ -2170,8 +1527,7 @@ export namespace remotebuildexecution_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the media that is being downloaded. See - * ReadRequest.resource_name. + * Name of the media that is being downloaded. See ReadRequest.resource_name. */ resourceName?: string; @@ -2204,15 +1560,7 @@ export namespace remotebuildexecution_v1 { /** * remotebuildexecution.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias remotebuildexecution.operations.cancel * @memberOf! () * @@ -2285,10 +1633,7 @@ export namespace remotebuildexecution_v1 { /** * remotebuildexecution.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias remotebuildexecution.operations.delete * @memberOf! () * @@ -2360,15 +1705,7 @@ export namespace remotebuildexecution_v1 { /** * remotebuildexecution.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias remotebuildexecution.operations.list * @memberOf! () * @@ -2528,9 +1865,7 @@ export namespace remotebuildexecution_v1 { /** * remotebuildexecution.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias remotebuildexecution.projects.operations.get * @memberOf! () * @@ -2714,49 +2049,11 @@ export namespace remotebuildexecution_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The `resume_marker` specifies how much of the existing underlying state - * is delivered to the client when the watch request is received by the - * system. The client can set this marker in one of the following ways to - * get different semantics: * Parameter is not specified or has the value - * "". Semantics: Fetch initial state. The client wants the entity's - * initial state to be delivered. See the description in "Initial - * State". * Parameter is set to the string "now" (UTF-8 encoding). - * Semantics: Fetch new changes only. The client just wants to get the - * changes received by the system after the watch point. The system may - * deliver changes from before the watch point as well. * Parameter - * is set to a value received in an earlier `Change.resume_marker` field - * while watching the same entity. Semantics: Resume from a specific - * point. The client wants to receive the changes from a specific point; - * this value must correspond to a value received in the - * `Change.resume_marker` field. The system may deliver changes from - * before the `resume_marker` as well. If the system cannot resume the - * stream from this point (e.g., if it is too far behind in the stream), - * it can raise the `FAILED_PRECONDITION` error. An implementation MUST - * support an unspecified parameter and the empty string "" marker (initial - * state fetching) and the "now" marker. It need not support resuming from a - * specific point. + * The `resume_marker` specifies how much of the existing underlying state is delivered to the client when the watch request is received by the system. The client can set this marker in one of the following ways to get different semantics: * Parameter is not specified or has the value "". Semantics: Fetch initial state. The client wants the entity's initial state to be delivered. See the description in "Initial State". * Parameter is set to the string "now" (UTF-8 encoding). Semantics: Fetch new changes only. The client just wants to get the changes received by the system after the watch point. The system may deliver changes from before the watch point as well. * Parameter is set to a value received in an earlier `Change.resume_marker` field while watching the same entity. Semantics: Resume from a specific point. The client wants to receive the changes from a specific point; this value must correspond to a value received in the `Change.resume_marker` field. The system may deliver changes from before the `resume_marker` as well. If the system cannot resume the stream from this point (e.g., if it is too far behind in the stream), it can raise the `FAILED_PRECONDITION` error. An implementation MUST support an unspecified parameter and the empty string "" marker (initial state fetching) and the "now" marker. It need not support resuming from a specific point. */ resumeMarker?: string; /** - * The `target` value **must** be a valid URL path pointing to an entity to - * watch. Note that the service name **must** be removed from the target - * field (e.g., the target field must say "/foo/bar", not - * "myservice.googleapis.com/foo/bar"). A client is also allowed to pass - * system-specific parameters in the URL that are only obeyed by some - * implementations. Some parameters will be implementation-specific. - * However, some have predefined meaning and are listed here: * recursive - * = true|false [default=false] If set to true, indicates that the client - * wants to watch all elements of entities in the subtree rooted at the - * entity's name in `target`. For descendants that are not the immediate - * children of the target, the `Change.element` will contain slashes. - * Note that some namespaces and entities will not support recursive - * watching. When watching such an entity, a client must not set recursive - * to true. Otherwise, it will receive an `UNIMPLEMENTED` error. Normal URL - * encoding must be used inside `target`. For example, if a query parameter - * name or value, or the non-query parameter portion of `target` contains a - * special character, it must be %-encoded. We recommend that clients and - * servers use their runtime's URL library to produce and consume target - * values. + * The `target` value **must** be a valid URL path pointing to an entity to watch. Note that the service name **must** be removed from the target field (e.g., the target field must say "/foo/bar", not "myservice.googleapis.com/foo/bar"). A client is also allowed to pass system-specific parameters in the URL that are only obeyed by some implementations. Some parameters will be implementation-specific. However, some have predefined meaning and are listed here: * recursive = true|false [default=false] If set to true, indicates that the client wants to watch all elements of entities in the subtree rooted at the entity's name in `target`. For descendants that are not the immediate children of the target, the `Change.element` will contain slashes. Note that some namespaces and entities will not support recursive watching. When watching such an entity, a client must not set recursive to true. Otherwise, it will receive an `UNIMPLEMENTED` error. Normal URL encoding must be used inside `target`. For example, if a query parameter name or value, or the non-query parameter portion of `target` contains a special character, it must be %-encoded. We recommend that clients and servers use their runtime's URL library to produce and consume target values. */ target?: string; } diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index d29f5e24f7f..9ea17e60c3b 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace remotebuildexecution_v1alpha { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace remotebuildexecution_v1alpha { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,32 +108,21 @@ export namespace remotebuildexecution_v1alpha { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * An `Action` captures all the information about an execution which is - * required to reproduce it. `Action`s are the core component of the - * [Execution] service. A single `Action` represents a repeatable action that - * can be performed by the execution service. `Action`s can be succinctly - * identified by the digest of their wire format encoding and, once an - * `Action` has been executed, will be cached in the action cache. Future - * requests can then use the cached result rather than needing to run afresh. - * When a server completes execution of an Action, it MAY choose to cache the - * result in the ActionCache unless `do_not_cache` is `true`. Clients SHOULD - * expect the server to do so. By default, future calls to Execute the same - * `Action` will also serve their results from the cache. Clients must take - * care to understand the caching behaviour. Ideally, all `Action`s will be - * reproducible so that serving a result from cache is always desirable and - * correct. + * An `Action` captures all the information about an execution which is required to reproduce it. `Action`s are the core component of the [Execution] service. A single `Action` represents a repeatable action that can be performed by the execution service. `Action`s can be succinctly identified by the digest of their wire format encoding and, once an `Action` has been executed, will be cached in the action cache. Future requests can then use the cached result rather than needing to run afresh. When a server completes execution of an Action, it MAY choose to cache the result in the ActionCache unless `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, future calls to Execute the same `Action` will also serve their results from the cache. Clients must take care to understand the caching behaviour. Ideally, all `Action`s will be reproducible so that serving a result from cache is always desirable and correct. */ export interface Schema$BuildBazelRemoteExecutionV2Action { /** - * The digest of the Command to run, which MUST be present in the - * ContentAddressableStorage. + * The digest of the Command to run, which MUST be present in the ContentAddressableStorage. */ commandDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** @@ -145,27 +130,11 @@ export namespace remotebuildexecution_v1alpha { */ doNotCache?: boolean; /** - * The digest of the root Directory for the input files. The files in the - * directory tree are available in the correct location on the build machine - * before the command is executed. The root directory, as well as every - * subdirectory and content blob referred to, MUST be in the - * ContentAddressableStorage. + * The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage. */ inputRootDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * A timeout after which the execution should be killed. If the timeout is - * absent, then the client is specifying that the execution should continue - * as long as the server will let it. The server SHOULD impose a timeout if - * the client does not specify one, however, if the client does specify a - * timeout that is longer than the server's maximum timeout, the server - * MUST reject the request. The timeout is a part of the Action message, - * and therefore two `Actions` with different timeouts are different, even - * if they are otherwise identical. This is because, if they were not, - * running an `Action` with a lower timeout than is required might result in - * a cache hit from an execution run with a longer timeout, hiding the fact - * that the timeout is too short. By encoding it directly in the `Action`, a - * lower timeout will result in a cache miss and the execution timeout will - * fail immediately, rather than whenever the cache entry gets evicted. + * A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted. */ timeout?: string; } @@ -182,184 +151,69 @@ export namespace remotebuildexecution_v1alpha { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested - * in the `output_directories` field of the Action, if the corresponding - * directory existed after the action completed, a single entry will be - * present in the output list, which will contain the digest of a Tree - * message containing the directory tree, and the path equal exactly to the - * corresponding Action output_directories member. As an example, suppose - * the Action had an output directory `a/b/dir` and the execution produced - * the following contents in `a/b/dir`: a file named `bar` and a directory - * named `foo` with an executable file named `baz`. Then, output_directory - * will contain (hashes shortened for readability): ```json // - * OutputDirectory proto: { path: "a/b/dir" tree_digest: { - * hash: "4a73bc9d03...", size: 55 } } // Tree proto with - * hash "4a73bc9d03..." and size 55: { root: { files: [ { - * name: "bar", digest: { hash: - * "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { - * hash: "4cf2eda940...", size: 43 } } ] - * } children : { // (Directory proto with hash - * "4cf2eda940..." and size 43) files: [ { name: - * "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, - * is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ outputDirectories?: Schema$BuildBazelRemoteExecutionV2OutputDirectory[]; /** - * The output directories of the action that are symbolic links to other - * directories. Those may be links to other output directories, or input - * directories, or even absolute paths outside of the working directory, if - * the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output - * directory requested in the `output_directories` field of the Action, if - * the directory file existed after the action completed, a single entry - * will be present either in this field, or in the `output_directories` - * field, if the directory was not a symbolic link. If the action does not - * produce the requested output, or produces a file where a directory is - * expected or vice versa, then that output will be omitted from the list. - * The server is free to arrange the output list as desired; clients MUST - * NOT assume that the output list is sorted. + * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory file existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If the action does not produce the requested output, or produces a file where a directory is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputDirectorySymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The output files of the action. For each output file requested in the - * `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present either in this - * field, or in the output_file_symlinks field, if the file was a symbolic - * link to another file. If the action does not produce the requested - * output, or produces a directory where a regular file is expected or vice - * versa, then that output will be omitted from the list. The server is free - * to arrange the output list as desired; clients MUST NOT assume that the - * output list is sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the output_file_symlinks field, if the file was a symbolic link to another file. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$BuildBazelRemoteExecutionV2OutputFile[]; /** - * The output files of the action that are symbolic links to other files. - * Those may be links to other output files, or input files, or even - * absolute paths outside of the working directory, if the server supports - * SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in - * the `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present either in this - * field, or in the `output_files` field, if the file was not a symbolic - * link. If the action does not produce the requested output, or produces a - * directory where a regular file is expected or vice versa, then that - * output will be omitted from the list. The server is free to arrange the - * output list as desired; clients MUST NOT assume that the output list is - * sorted. + * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFileSymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The digest for a blob containing the standard error of the action, which - * can be retrieved from the ContentAddressableStorage. See `stderr_raw` for - * when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. */ stderrDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard error buffer of the action. The server will determine, based - * on the size of the buffer, whether to return it in raw form or to return - * a digest in `stderr_digest` that points to the buffer. If neither is set, - * then the buffer is empty. The client SHOULD NOT assume it will get one of - * the raw buffer or a digest on any given request and should be prepared to - * handle either. + * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which - * can be retrieved from the ContentAddressableStorage. See `stdout_raw` for - * when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ stdoutDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard output buffer of the action. The server will determine, - * based on the size of the buffer, whether to return it in raw form or to - * return a digest in `stdout_digest` that points to the buffer. If neither - * is set, then the buffer is empty. The client SHOULD NOT assume it will - * get one of the raw buffer or a digest on any given request and should be - * prepared to handle either. + * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stdoutRaw?: string; } /** - * A `Command` is the actual command executed by a worker running an Action - * and specifications of its environment. Except as otherwise required, the - * environment (such as which system libraries or binaries are available, and - * what filesystems are mounted where) is defined by and specific to the - * implementation of the remote execution API. + * A `Command` is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. */ export interface Schema$BuildBazelRemoteExecutionV2Command { /** - * The arguments to the command. The first argument must be the path to the - * executable, which must be either a relative path, in which case it is - * evaluated with respect to the input root, or an absolute path. + * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. */ arguments?: string[]; /** - * The environment variables to set when running the program. The worker may - * provide its own default environment variables; these defaults can be - * overridden using this field. Additional variables can also be specified. - * In order to ensure that equivalent Commands always hash to the same - * value, the environment variables MUST be lexicographically sorted by - * name. Sorting of strings is done by code point, equivalently, by the - * UTF-8 bytes. + * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ environmentVariables?: Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable[]; /** - * A list of the output directories that the client expects to retrieve from - * the action. Only the listed directories will be returned (an entire - * directory structure will be returned as a Tree message digest, see - * OutputDirectory), as well as files listed in `output_files`. Other files - * or directories that may be created during command execution are - * discarded. The paths are relative to the working directory of the action - * execution. The paths are specified using a single forward slash (`/`) as - * a path separator, even if the execution platform natively uses a - * different separator. The path MUST NOT include a trailing slash, nor a - * leading slash, being a relative path. The special value of empty string - * is allowed, although not recommended, and can be used to capture the - * entire working directory tree, including inputs. In order to ensure - * consistent hashing of the same Action, the output paths MUST be sorted - * lexicographically by code point (or, equivalently, by UTF-8 bytes). An - * output directory cannot be duplicated or have the same path as any of the - * listed output files. Directories leading up to the output directories - * (but not the output directories themselves) are created by the worker - * prior to execution, even if they are not explicitly part of the input - * root. + * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputDirectories?: string[]; /** - * A list of the output files that the client expects to retrieve from the - * action. Only the listed files, as well as directories listed in - * `output_directories`, will be returned to the client as output. Other - * files or directories that may be created during command execution are - * discarded. The paths are relative to the working directory of the action - * execution. The paths are specified using a single forward slash (`/`) as - * a path separator, even if the execution platform natively uses a - * different separator. The path MUST NOT include a trailing slash, nor a - * leading slash, being a relative path. In order to ensure consistent - * hashing of the same Action, the output paths MUST be sorted - * lexicographically by code point (or, equivalently, by UTF-8 bytes). An - * output file cannot be duplicated, be a parent of another output file, or - * have the same path as any of the listed output directories. Directories - * leading up to the output files are created by the worker prior to - * execution, even if they are not explicitly part of the input root. + * A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputFiles?: string[]; /** - * The platform requirements for the execution environment. The server MAY - * choose to execute the action on any worker satisfying the requirements, - * so the client SHOULD ensure that running the action on any such worker - * will have the same result. + * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. */ platform?: Schema$BuildBazelRemoteExecutionV2Platform; /** - * The working directory, relative to the input root, for the command to run - * in. It must be a directory which exists in the input tree. If it is left - * empty, then the action is run in the input root. + * The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root. */ workingDirectory?: string; } /** - * An `EnvironmentVariable` is one variable to set in the running - * program's environment. + * An `EnvironmentVariable` is one variable to set in the running program's environment. */ export interface Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable { /** @@ -372,36 +226,11 @@ export namespace remotebuildexecution_v1alpha { value?: string; } /** - * A content digest. A digest for a given blob consists of the size of the - * blob and its hash. The hash algorithm to use is defined by the server, but - * servers SHOULD use SHA-256. The size is considered to be an integral part - * of the digest and cannot be separated. That is, even if the `hash` field is - * correctly specified but `size_bytes` is not, the server MUST reject the - * request. The reason for including the size in the digest is as follows: in - * a great many cases, the server needs to know the size of the blob it is - * about to work with prior to starting an operation with it, such as - * flattening Merkle tree structures or streaming it to a worker. Technically, - * the server could implement a separate metadata store, but this results in a - * significantly more complicated implementation as opposed to having the - * client specify the size up-front (or storing the size along with the digest - * in every message where digests are embedded). This does mean that the API - * leaks some implementation details of (what we consider to be) a reasonable - * server implementation, but we consider this to be a worthwhile tradeoff. - * When a `Digest` is used to refer to a proto message, it always refers to - * the message in binary encoded form. To ensure consistent hashing, clients - * and servers MUST ensure that they serialize messages according to the - * following rules, even if there are alternate valid encodings for the same - * message: * Fields are serialized in tag order. * There are no unknown - * fields. * There are no duplicate fields. * Fields are serialized according - * to the default semantics for their type. Most protocol buffer - * implementations will always follow these rules when serializing, but care - * should be taken to avoid shortcuts. For instance, concatenating two - * messages to merge them may produce duplicate fields. + * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message: * Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. */ export interface Schema$BuildBazelRemoteExecutionV2Digest { /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** @@ -410,30 +239,7 @@ export namespace remotebuildexecution_v1alpha { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero - * or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` - * contains its name in the directory, either the digest of its content - * (either a file blob or a `Directory` proto) or a symlink target, as well as - * possibly some metadata about the file or directory. In order to ensure - * that two equivalent directory trees hash to the same value, the following - * restrictions MUST be obeyed when constructing a a `Directory`: * Every - * child in the directory must have a path of exactly one segment. Multiple - * levels of directory hierarchy may not be collapsed. * Each child in the - * directory must have a unique path segment (file name). * The files, - * directories and symlinks in the directory must each be sorted in - * lexicographical order by path. The path strings must be sorted by code - * point, equivalently, by UTF-8 bytes. A `Directory` that obeys the - * restrictions is said to be in canonical form. As an example, the following - * could be used for a file named `bar` and a directory named `foo` with an - * executable file named `baz` (hashes shortened for readability): ```json // - * (Directory proto) { files: [ { name: "bar", digest: { - * hash: "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { hash: - * "4cf2eda940...", size: 43 } } ] } // - * (Directory proto with hash "4cf2eda940..." and size 43) { files: - * [ { name: "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, is_executable: true - * } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$BuildBazelRemoteExecutionV2Directory { /** @@ -450,13 +256,11 @@ export namespace remotebuildexecution_v1alpha { symlinks?: Schema$BuildBazelRemoteExecutionV2SymlinkNode[]; } /** - * A `DirectoryNode` represents a child of a Directory which is itself a - * `Directory` and its associated metadata. + * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. */ export interface Schema$BuildBazelRemoteExecutionV2DirectoryNode { /** - * The digest of the Directory object represented. See Digest for - * information about how to take the digest of a proto message. + * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. */ digest?: Schema$BuildBazelRemoteExecutionV2Digest; /** @@ -510,8 +314,7 @@ export namespace remotebuildexecution_v1alpha { workerStartTimestamp?: string; } /** - * Metadata about an ongoing execution, which will be contained in the - * metadata field of the Operation. + * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. */ export interface Schema$BuildBazelRemoteExecutionV2ExecuteOperationMetadata { /** @@ -520,19 +323,16 @@ export namespace remotebuildexecution_v1alpha { actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest; stage?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard error. + * If set, the client can use this name with ByteStream.Read to stream the standard error. */ stderrStreamName?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard output. + * If set, the client can use this name with ByteStream.Read to stream the standard output. */ stdoutStreamName?: string; } /** - * The response message for Execution.Execute, which will be contained in the - * response field of the Operation. + * The response message for Execution.Execute, which will be contained in the response field of the Operation. */ export interface Schema$BuildBazelRemoteExecutionV2ExecuteResponse { /** @@ -540,9 +340,7 @@ export namespace remotebuildexecution_v1alpha { */ cachedResult?: boolean; /** - * Freeform informational message with details on the execution of the - * action that may be displayed to the user upon failure or when requested - * explicitly. + * Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly. */ message?: string; /** @@ -550,25 +348,11 @@ export namespace remotebuildexecution_v1alpha { */ result?: Schema$BuildBazelRemoteExecutionV2ActionResult; /** - * An optional list of additional log outputs the server wishes to provide. - * A server can use this to return execution-specific logs however it - * wishes. This is intended primarily to make it easier for users to debug - * issues that may be outside of the actual job execution, such as by - * identifying the worker executing the action or by providing logs from the - * worker's setup phase. The keys SHOULD be human readable so that a - * client can display them to a user. + * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ serverLogs?: {[key: string]: Schema$BuildBazelRemoteExecutionV2LogFile}; /** - * If the status has a code other than `OK`, it indicates that the action - * did not finish execution. For example, if the operation times out during - * execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST - * use this field for errors in execution, rather than the error field on - * the `Operation` object. If the status code is other than `OK`, then the - * result MUST NOT be cached. For an error status, the `result` field is - * optional; the server may populate the output-, stdout-, and - * stderr-related fields if it has any information available, such as the - * stdout and stderr of a timed-out action. + * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ status?: Schema$GoogleRpcStatus; } @@ -598,36 +382,25 @@ export namespace remotebuildexecution_v1alpha { */ digest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * This is a hint as to the purpose of the log, and is set to true if the - * log is human-readable text that can be usefully displayed to a user, and - * false otherwise. For instance, if a command-line client wishes to print - * the server logs to the terminal for a failed action, this allows it to - * avoid displaying a binary file. + * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ humanReadable?: boolean; } /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a - * directory's full contents rather than a single file. + * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. */ export interface Schema$BuildBazelRemoteExecutionV2OutputDirectory { /** - * The full path of the directory relative to the working directory. The - * path separator is a forward slash `/`. Since this is a relative path, it - * MUST NOT begin with a leading forward slash. The empty string value is - * allowed, and it denotes the entire working directory. + * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ path?: string; /** - * The digest of the encoded Tree proto containing the directory's - * contents. + * The digest of the encoded Tree proto containing the directory's contents. */ treeDigest?: Schema$BuildBazelRemoteExecutionV2Digest; } /** - * An `OutputFile` is similar to a FileNode, but it is used as an output in an - * `ActionResult`. It allows a full file path rather than only a name. - * `OutputFile` is binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. `OutputFile` is binary-compatible with `FileNode`. */ export interface Schema$BuildBazelRemoteExecutionV2OutputFile { /** @@ -639,62 +412,34 @@ export namespace remotebuildexecution_v1alpha { */ isExecutable?: boolean; /** - * The full path of the file relative to the working directory, including - * the filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the file relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; } /** - * An `OutputSymlink` is similar to a Symlink, but it is used as an output in - * an `ActionResult`. `OutputSymlink` is binary-compatible with - * `SymlinkNode`. + * An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. */ export interface Schema$BuildBazelRemoteExecutionV2OutputSymlink { /** - * The full path of the symlink relative to the working directory, including - * the filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the symlink relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; /** - * The target path of the symlink. The path separator is a forward slash - * `/`. The target path can be relative to the parent directory of the - * symlink or it can be an absolute path starting with `/`. Support for - * absolute paths can be checked using the Capabilities API. The canonical - * form forbids the substrings `/./` and `//` in the target path. `..` - * components are allowed anywhere in the target path. + * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ target?: string; } /** - * A `Platform` is a set of requirements, such as hardware, operating system, - * or compiler toolchain, for an Action's execution environment. A - * `Platform` is represented as a series of key-value pairs representing the - * properties that are required of the platform. + * A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform. */ export interface Schema$BuildBazelRemoteExecutionV2Platform { /** - * The properties that make up this platform. In order to ensure that - * equivalent `Platform`s always hash to the same value, the properties MUST - * be lexicographically sorted by name, and then by value. Sorting of - * strings is done by code point, equivalently, by the UTF-8 bytes. + * The properties that make up this platform. In order to ensure that equivalent `Platform`s always hash to the same value, the properties MUST be lexicographically sorted by name, and then by value. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ properties?: Schema$BuildBazelRemoteExecutionV2PlatformProperty[]; } /** - * A single property for the environment. The server is responsible for - * specifying the property `name`s that it accepts. If an unknown `name` is - * provided in the requirements for an Action, the server SHOULD reject the - * execution request. If permitted by the server, the same `name` may occur - * multiple times. The server is also responsible for specifying the - * interpretation of property `value`s. For instance, a property describing - * how much RAM must be available may be interpreted as allowing a worker with - * 16GB to fulfill a request for 8GB, while a property describing the OS - * environment on which the action must be performed may require an exact - * match with the worker's OS. The server MAY use the `value` of one or - * more properties to determine how it sets up the execution environment, such - * as by making specific system files available to the worker. + * A single property for the environment. The server is responsible for specifying the property `name`s that it accepts. If an unknown `name` is provided in the requirements for an Action, the server SHOULD reject the execution request. If permitted by the server, the same `name` may occur multiple times. The server is also responsible for specifying the interpretation of property `value`s. For instance, a property describing how much RAM must be available may be interpreted as allowing a worker with 16GB to fulfill a request for 8GB, while a property describing the OS environment on which the action must be performed may require an exact match with the worker's OS. The server MAY use the `value` of one or more properties to determine how it sets up the execution environment, such as by making specific system files available to the worker. */ export interface Schema$BuildBazelRemoteExecutionV2PlatformProperty { /** @@ -707,24 +452,15 @@ export namespace remotebuildexecution_v1alpha { value?: string; } /** - * An optional Metadata to attach to any RPC request to tell the server about - * an external context of the request. The server may use this for logging or - * other purposes. To use it, the client attaches the header to the call using - * the canonical proto serialization: * name: - * `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the - * base64 encoded binary `RequestMetadata` message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. */ export interface Schema$BuildBazelRemoteExecutionV2RequestMetadata { /** - * An identifier that ties multiple requests to the same action. For - * example, multiple requests to the CAS, Action Cache, and Execution API - * are used in order to compile foo.cc. + * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ actionId?: string; /** - * An identifier to tie multiple tool invocations together. For example, - * runs of foo_test, bar_test and baz_test on a post-submit of a given - * patch. + * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ correlatedInvocationsId?: string; /** @@ -732,8 +468,7 @@ export namespace remotebuildexecution_v1alpha { */ toolDetails?: Schema$BuildBazelRemoteExecutionV2ToolDetails; /** - * An identifier that ties multiple actions together to a final result. For - * example, multiple actions are required to build and run foo_test. + * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ toolInvocationId?: string; } @@ -746,12 +481,7 @@ export namespace remotebuildexecution_v1alpha { */ name?: string; /** - * The target path of the symlink. The path separator is a forward slash - * `/`. The target path can be relative to the parent directory of the - * symlink or it can be an absolute path starting with `/`. Support for - * absolute paths can be checked using the Capabilities API. The canonical - * form forbids the substrings `/./` and `//` in the target path. `..` - * components are allowed anywhere in the target path. + * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ target?: string; } @@ -769,15 +499,11 @@ export namespace remotebuildexecution_v1alpha { toolVersion?: string; } /** - * A `Tree` contains all the Directory protos in a single directory Merkle - * tree, compressed into one message. + * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. */ export interface Schema$BuildBazelRemoteExecutionV2Tree { /** - * All the child directories: the directories referred to by the root and, - * recursively, all its children. In order to reconstruct the directory - * tree, the client must take the digests of each of the child directories - * and then build up a tree starting from the `root`. + * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. */ children?: Schema$BuildBazelRemoteExecutionV2Directory[]; /** @@ -786,18 +512,15 @@ export namespace remotebuildexecution_v1alpha { root?: Schema$BuildBazelRemoteExecutionV2Directory; } /** - * CommandDuration contains the various duration metrics tracked when a bot - * performs a command. + * CommandDuration contains the various duration metrics tracked when a bot performs a command. */ export interface Schema$GoogleDevtoolsRemotebuildbotCommandDurations { /** - * The time spent preparing the command to be run in a Docker container - * (includes pulling the Docker image, if necessary). + * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ dockerPrep?: string; /** - * The time spent downloading the input files and constructing the working - * directory. + * The time spent downloading the input files and constructing the working directory. */ download?: string; /** @@ -822,13 +545,11 @@ export namespace remotebuildexecution_v1alpha { upload?: string; } /** - * CommandEvents contains counters for the number of warnings and errors that - * occurred during the execution of a command. + * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. */ export interface Schema$GoogleDevtoolsRemotebuildbotCommandEvents { /** - * Indicates whether we are using a cached Docker image (true) or had to - * pull the Docker image (false) for this command. + * Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command. */ dockerCacheHit?: boolean; /** @@ -849,20 +570,15 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest { /** - * Specifies the instance to create. The name in the instance, if specified - * in the instance, is ignored. + * Specifies the instance to create. The name in the instance, if specified in the instance, is ignored. */ instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; /** - * ID of the created instance. A valid `instance_id` must: be 6-50 - * characters long, contain only lowercase letters, digits, hyphens and - * underscores, start with a lowercase letter, and end with a lowercase - * letter or a digit. + * ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ instanceId?: string; /** - * Resource name of the project containing the instance. Format: - * `projects/[PROJECT_ID]`. + * Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. */ parent?: string; } @@ -871,20 +587,15 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest { /** - * Resource name of the instance in which to create the new worker pool. - * Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; /** - * ID of the created worker pool. A valid pool ID must: be 6-50 characters - * long, contain only lowercase letters, digits, hyphens and underscores, - * start with a lowercase letter, and end with a lowercase letter or a - * digit. + * ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ poolId?: string; /** - * Specifies the worker pool to create. The name in the worker pool, if - * specified, is ignored. + * Specifies the worker pool to create. The name in the worker pool, if specified, is ignored. */ workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool; } @@ -893,8 +604,7 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest { /** - * Name of the instance to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -903,8 +613,7 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest { /** - * Name of the worker pool to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } @@ -913,8 +622,7 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest { /** - * Name of the instance to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -923,17 +631,12 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest { /** - * Name of the worker pool to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } /** - * Instance conceptually encapsulates all Remote Build Execution resources for - * remote builds. An instance consists of storage and compute resources (for - * example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used - * for running remote builds. All Remote Build Execution API calls are scoped - * to an instance. + * Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance { /** @@ -945,10 +648,7 @@ export namespace remotebuildexecution_v1alpha { */ loggingEnabled?: boolean; /** - * Output only. Instance resource name formatted as: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be - * populated when creating an instance since it is provided in the - * `instance_id` field. + * Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. */ name?: string; /** @@ -970,8 +670,7 @@ export namespace remotebuildexecution_v1alpha { } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest { /** - * Resource name of the instance. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; } @@ -986,13 +685,7 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest { /** - * The update mask applies to worker_pool. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * If an empty update_mask is provided, only the non-default valued field in - * the worker pool field will be updated. Note that in order to update a - * field to the default value (zero, false, empty string) an explicit - * update_mask must be provided. + * The update mask applies to worker_pool. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ updateMask?: string; /** @@ -1001,37 +694,27 @@ export namespace remotebuildexecution_v1alpha { workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool; } /** - * Defines the configuration to be used for a creating workers in the worker - * pool. + * Defines the configuration to be used for a creating workers in the worker pool. */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig { /** - * Required. Size of the disk attached to the worker, in GB. See - * https://cloud.google.com/compute/docs/disks/ + * Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ */ diskSizeGb?: string; /** - * Required. Disk Type to use for the worker. See [Storage - * options](https://cloud.google.com/compute/docs/disks/#introduction). - * Currently only `pd-standard` is supported. + * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. */ diskType?: string; /** - * Required. Machine type of the worker, such as `n1-standard-2`. See - * https://cloud.google.com/compute/docs/machine-types for a list of - * supported machine types. Note that `f1-micro` and `g1-small` are not yet - * supported. + * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ machineType?: string; /** - * Minimum CPU platform to use when creating the worker. See [CPU - * Platforms](https://cloud.google.com/compute/docs/cpu-platforms). + * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ minCpuPlatform?: string; /** - * Determines whether the worker is reserved (equivalent to a Compute Engine - * on-demand VM and therefore won't be preempted). See [Preemptible - * VMs](https://cloud.google.com/preemptible-vms/) for more details. + * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ reserved?: boolean; } @@ -1040,10 +723,7 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool { /** - * WorkerPool resource name formatted as: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - * name should not be populated when creating a worker pool since it is - * provided in the `poolId` field. + * WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field. */ name?: string; /** @@ -1051,13 +731,11 @@ export namespace remotebuildexecution_v1alpha { */ state?: string; /** - * Specifies the properties, such as machine type and disk size, used for - * creating workers in a worker pool. + * Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool. */ workerConfig?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig; /** - * The desired number of workers in the worker pool. Must be a value between - * 0 and 1000. + * The desired number of workers in the worker pool. Must be a value between 0 and 1000. */ workerCount?: string; } @@ -1070,101 +748,45 @@ export namespace remotebuildexecution_v1alpha { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested - * in the `output_directories` field of the Action, if the corresponding - * directory existed after the action completed, a single entry will be - * present in the output list, which will contain the digest of a Tree - * message containing the directory tree, and the path equal exactly to the - * corresponding Action output_directories member. As an example, suppose - * the Action had an output directory `a/b/dir` and the execution produced - * the following contents in `a/b/dir`: a file named `bar` and a directory - * named `foo` with an executable file named `baz`. Then, output_directory - * will contain (hashes shortened for readability): ```json // - * OutputDirectory proto: { path: "a/b/dir" tree_digest: { - * hash: "4a73bc9d03...", size: 55 } } // Tree proto with - * hash "4a73bc9d03..." and size 55: { root: { files: [ { - * name: "bar", digest: { hash: - * "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { - * hash: "4cf2eda940...", size: 43 } } ] - * } children : { // (Directory proto with hash - * "4cf2eda940..." and size 43) files: [ { name: - * "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, - * is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ outputDirectories?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory[]; /** - * The output files of the action. For each output file requested in the - * `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present in the output - * list. If the action does not produce the requested output, or produces a - * directory where a regular file is expected or vice versa, then that - * output will be omitted from the list. The server is free to arrange the - * output list as desired; clients MUST NOT assume that the output list is - * sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile[]; /** - * The digest for a blob containing the standard error of the action, which - * can be retrieved from the ContentAddressableStorage. See `stderr_raw` for - * when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. */ stderrDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The standard error buffer of the action. The server will determine, based - * on the size of the buffer, whether to return it in raw form or to return - * a digest in `stderr_digest` that points to the buffer. If neither is set, - * then the buffer is empty. The client SHOULD NOT assume it will get one of - * the raw buffer or a digest on any given request and should be prepared to - * handle either. + * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which - * can be retrieved from the ContentAddressableStorage. See `stdout_raw` for - * when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ stdoutDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The standard output buffer of the action. The server will determine, - * based on the size of the buffer, whether to return it in raw form or to - * return a digest in `stdout_digest` that points to the buffer. If neither - * is set, then the buffer is empty. The client SHOULD NOT assume it will - * get one of the raw buffer or a digest on any given request and should be - * prepared to handle either. + * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stdoutRaw?: string; } /** - * A `Command` is the actual command executed by a worker running an Action. - * Except as otherwise required, the environment (such as which system - * libraries or binaries are available, and what filesystems are mounted - * where) is defined by and specific to the implementation of the remote - * execution API. + * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommand { /** - * The arguments to the command. The first argument must be the path to the - * executable, which must be either a relative path, in which case it is - * evaluated with respect to the input root, or an absolute path. The - * working directory will always be the input root. + * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. */ arguments?: string[]; /** - * The environment variables to set when running the program. The worker may - * provide its own default environment variables; these defaults can be - * overridden using this field. Additional variables can also be specified. - * In order to ensure that equivalent `Command`s always hash to the same - * value, the environment variables MUST be lexicographically sorted by - * name. Sorting of strings is done by code point, equivalently, by the - * UTF-8 bytes. + * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ environmentVariables?: Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable[]; } /** - * An `EnvironmentVariable` is one variable to set in the running - * program's environment. + * An `EnvironmentVariable` is one variable to set in the running program's environment. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable { /** @@ -1177,36 +799,11 @@ export namespace remotebuildexecution_v1alpha { value?: string; } /** - * A content digest. A digest for a given blob consists of the size of the - * blob and its hash. The hash algorithm to use is defined by the server, but - * servers SHOULD use SHA-256. The size is considered to be an integral part - * of the digest and cannot be separated. That is, even if the `hash` field is - * correctly specified but `size_bytes` is not, the server MUST reject the - * request. The reason for including the size in the digest is as follows: in - * a great many cases, the server needs to know the size of the blob it is - * about to work with prior to starting an operation with it, such as - * flattening Merkle tree structures or streaming it to a worker. Technically, - * the server could implement a separate metadata store, but this results in a - * significantly more complicated implementation as opposed to having the - * client specify the size up-front (or storing the size along with the digest - * in every message where digests are embedded). This does mean that the API - * leaks some implementation details of (what we consider to be) a reasonable - * server implementation, but we consider this to be a worthwhile tradeoff. - * When a `Digest` is used to refer to a proto message, it always refers to - * the message in binary encoded form. To ensure consistent hashing, clients - * and servers MUST ensure that they serialize messages according to the - * following rules, even if there are alternate valid encodings for the same - * message. - Fields are serialized in tag order. - There are no unknown - * fields. - There are no duplicate fields. - Fields are serialized according - * to the default semantics for their type. Most protocol buffer - * implementations will always follow these rules when serializing, but care - * should be taken to avoid shortcuts. For instance, concatenating two - * messages to merge them may produce duplicate fields. + * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDigest { /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** @@ -1215,29 +812,7 @@ export namespace remotebuildexecution_v1alpha { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero - * or more children FileNodes and DirectoryNodes. Each `Node` contains its - * name in the directory, the digest of its content (either a file blob or a - * `Directory` proto), as well as possibly some metadata about the file or - * directory. In order to ensure that two equivalent directory trees hash to - * the same value, the following restrictions MUST be obeyed when constructing - * a a `Directory`: - Every child in the directory must have a path of - * exactly one segment. Multiple levels of directory hierarchy may not be - * collapsed. - Each child in the directory must have a unique path segment - * (file name). - The files and directories in the directory must each be - * sorted in lexicographical order by path. The path strings must be - * sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that - * obeys the restrictions is said to be in canonical form. As an example, the - * following could be used for a file named `bar` and a directory named `foo` - * with an executable file named `baz` (hashes shortened for readability): - * ```json // (Directory proto) { files: [ { name: - * "bar", digest: { hash: "4a73bc9d03...", - * size: 65534 } } ], directories: [ { name: - * "foo", digest: { hash: "4cf2eda940...", - * size: 43 } } ] } // (Directory proto with hash - * "4cf2eda940..." and size 43) { files: [ { name: - * "baz", digest: { hash: "b2c941073e...", - * size: 1294, }, is_executable: true } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectory { /** @@ -1250,13 +825,11 @@ export namespace remotebuildexecution_v1alpha { files?: Schema$GoogleDevtoolsRemoteexecutionV1testFileNode[]; } /** - * A `DirectoryNode` represents a child of a Directory which is itself a - * `Directory` and its associated metadata. + * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode { /** - * The digest of the Directory object represented. See Digest for - * information about how to take the digest of a proto message. + * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** @@ -1265,8 +838,7 @@ export namespace remotebuildexecution_v1alpha { name?: string; } /** - * Metadata about an ongoing execution, which will be contained in the - * metadata field of the Operation. + * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata { /** @@ -1275,19 +847,16 @@ export namespace remotebuildexecution_v1alpha { actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; stage?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard error. + * If set, the client can use this name with ByteStream.Read to stream the standard error. */ stderrStreamName?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard output. + * If set, the client can use this name with ByteStream.Read to stream the standard output. */ stdoutStreamName?: string; } /** - * The response message for Execution.Execute, which will be contained in the - * response field of the Operation. + * The response message for Execution.Execute, which will be contained in the response field of the Operation. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteResponse { /** @@ -1299,27 +868,13 @@ export namespace remotebuildexecution_v1alpha { */ result?: Schema$GoogleDevtoolsRemoteexecutionV1testActionResult; /** - * An optional list of additional log outputs the server wishes to provide. - * A server can use this to return execution-specific logs however it - * wishes. This is intended primarily to make it easier for users to debug - * issues that may be outside of the actual job execution, such as by - * identifying the worker executing the action or by providing logs from the - * worker's setup phase. The keys SHOULD be human readable so that a - * client can display them to a user. + * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ serverLogs?: { [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; }; /** - * If the status has a code other than `OK`, it indicates that the action - * did not finish execution. For example, if the operation times out during - * execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST - * use this field for errors in execution, rather than the error field on - * the `Operation` object. If the status code is other than `OK`, then the - * result MUST NOT be cached. For an error status, the `result` field is - * optional; the server may populate the output-, stdout-, and - * stderr-related fields if it has any information available, such as the - * stdout and stderr of a timed-out action. + * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ status?: Schema$GoogleRpcStatus; } @@ -1349,17 +904,12 @@ export namespace remotebuildexecution_v1alpha { */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * This is a hint as to the purpose of the log, and is set to true if the - * log is human-readable text that can be usefully displayed to a user, and - * false otherwise. For instance, if a command-line client wishes to print - * the server logs to the terminal for a failed action, this allows it to - * avoid displaying a binary file. + * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ humanReadable?: boolean; } /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a - * directory's full contents rather than a single file. + * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory { /** @@ -1367,32 +917,20 @@ export namespace remotebuildexecution_v1alpha { */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The full path of the directory relative to the working directory. The - * path separator is a forward slash `/`. Since this is a relative path, it - * MUST NOT begin with a leading forward slash. The empty string value is - * allowed, and it denotes the entire working directory. + * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ path?: string; /** - * The digest of the encoded Tree proto containing the directory's - * contents. + * The digest of the encoded Tree proto containing the directory's contents. */ treeDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; } /** - * An `OutputFile` is similar to a FileNode, but it is tailored for output as - * part of an `ActionResult`. It allows a full file path rather than only a - * name, and allows the server to include content inline. `OutputFile` is - * binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline. `OutputFile` is binary-compatible with `FileNode`. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile { /** - * The raw content of the file. This field may be used by the server to - * provide the content of a file inline in an ActionResult and avoid - * requiring that the client make a separate call to - * [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD - * NOT assume that it will get raw content with any request, and always be - * prepared to retrieve it via `digest`. + * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. */ content?: string; /** @@ -1404,31 +942,20 @@ export namespace remotebuildexecution_v1alpha { */ isExecutable?: boolean; /** - * The full path of the file relative to the input root, including the - * filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; } /** - * An optional Metadata to attach to any RPC request to tell the server about - * an external context of the request. The server may use this for logging or - * other purposes. To use it, the client attaches the header to the call using - * the canonical proto serialization: name: - * google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the - * base64 encoded binary RequestMetadata message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testRequestMetadata { /** - * An identifier that ties multiple requests to the same action. For - * example, multiple requests to the CAS, Action Cache, and Execution API - * are used in order to compile foo.cc. + * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ actionId?: string; /** - * An identifier to tie multiple tool invocations together. For example, - * runs of foo_test, bar_test and baz_test on a post-submit of a given - * patch. + * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ correlatedInvocationsId?: string; /** @@ -1436,8 +963,7 @@ export namespace remotebuildexecution_v1alpha { */ toolDetails?: Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails; /** - * An identifier that ties multiple actions together to a final result. For - * example, multiple actions are required to build and run foo_test. + * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ toolInvocationId?: string; } @@ -1455,15 +981,11 @@ export namespace remotebuildexecution_v1alpha { toolVersion?: string; } /** - * A `Tree` contains all the Directory protos in a single directory Merkle - * tree, compressed into one message. + * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testTree { /** - * All the child directories: the directories referred to by the root and, - * recursively, all its children. In order to reconstruct the directory - * tree, the client must take the digests of each of the child directories - * and then build up a tree starting from the `root`. + * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. */ children?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory[]; /** @@ -1472,16 +994,7 @@ export namespace remotebuildexecution_v1alpha { root?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory; } /** - * AdminTemp is a prelimiary set of administration tasks. It's called - * "Temp" because we do not yet know the best way to represent admin - * tasks; it's possible that this will be entirely replaced in later - * versions of this API. If this message proves to be sufficient, it will be - * renamed in the alpha or beta release of this API. This message (suitably - * marshalled into a protobuf.Any) can be used as the inline_assignment field - * in a lease; the lease assignment field should simply be `"admin"` - * in these cases. This message is heavily based on Swarming administration - * tasks from the LUCI project - * (http://github.com/luci/luci-py/appengine/swarming). + * AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `"admin"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming). */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2AdminTemp { /** @@ -1507,91 +1020,62 @@ export namespace remotebuildexecution_v1alpha { digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; } /** - * DEPRECATED - use CommandResult instead. Describes the actual outputs from - * the task. + * DEPRECATED - use CommandResult instead. Describes the actual outputs from the task. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOutputs { /** - * exit_code is only fully reliable if the status' code is OK. If the - * task exceeded its deadline or was cancelled, the process may still - * produce an exit code as it is cancelled, and this will be populated, but - * a successful (zero) is unlikely to be correct unless the status code is - * OK. + * exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK. */ exitCode?: number; /** - * The output files. The blob referenced by the digest should contain one of - * the following (implementation-dependent): * A marshalled - * DirectoryMetadata of the returned filesystem * A LUCI-style .isolated - * file + * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; } /** - * DEPRECATED - use CommandResult instead. Can be used as part of - * CompleteRequest.metadata, or are part of a more sophisticated message. + * DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest.metadata, or are part of a more sophisticated message. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOverhead { /** - * The elapsed time between calling Accept and Complete. The server will - * also have its own idea of what this should be, but this excludes the - * overhead of the RPCs and the bot response time. + * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ duration?: string; /** - * The amount of time *not* spent executing the command (ie - * uploading/downloading files). + * The amount of time *not* spent executing the command (ie uploading/downloading files). */ overhead?: string; } /** - * All information about the execution of a command, suitable for providing as - * the Bots interface's `Lease.result` field. + * All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandResult { /** - * The elapsed time between calling Accept and Complete. The server will - * also have its own idea of what this should be, but this excludes the - * overhead of the RPCs and the bot response time. + * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ duration?: string; /** - * The exit code of the process. An exit code of "0" should only - * be trusted if `status` has a code of OK (otherwise it may simply be - * unset). + * The exit code of the process. An exit code of "0" should only be trusted if `status` has a code of OK (otherwise it may simply be unset). */ exitCode?: number; /** - * Implementation-dependent metadata about the task. Both servers and bots - * may define messages which can be encoded here; bots are free to provide - * metadata in multiple formats, and servers are free to choose one or more - * of the values to process and ignore others. In particular, it is *not* - * considered an error for the bot to provide the server with a field that - * it doesn't know about. + * Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about. */ metadata?: Array<{[key: string]: any}>; /** - * The output files. The blob referenced by the digest should contain one of - * the following (implementation-dependent): * A marshalled - * DirectoryMetadata of the returned filesystem * A LUCI-style .isolated - * file + * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** - * The amount of time *not* spent executing the command (ie - * uploading/downloading files). + * The amount of time *not* spent executing the command (ie uploading/downloading files). */ overhead?: string; /** - * An overall status for the command. For example, if the command timed out, - * this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS - * for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. + * An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. */ status?: Schema$GoogleRpcStatus; } /** - * Describes a shell-style task to execute, suitable for providing as the Bots - * interface's `Lease.payload` field. + * Describes a shell-style task to execute, suitable for providing as the Bots interface's `Lease.payload` field. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTask { /** @@ -1612,14 +1096,7 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs { /** - * The command itself to run (e.g., argv). This field should be passed - * directly to the underlying operating system, and so it must be sensible - * to that operating system. For example, on Windows, the first argument - * might be "C:\Windows\System32\ping.exe" - that is, using drive - * letters and backslashes. A command for a *nix system, on the other hand, - * would use forward slashes. All other fields in the RWAPI must - * consistently use forward slashes, since those fields may be interpretted - * by both the service and the bot. + * The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be "C:\Windows\System32\ping.exe" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpretted by both the service and the bot. */ arguments?: string[]; /** @@ -1627,28 +1104,15 @@ export namespace remotebuildexecution_v1alpha { */ environmentVariables?: Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable[]; /** - * The input filesystem to be set up prior to the task beginning. The - * contents should be a repeated set of FileMetadata messages though other - * formats are allowed if better for the implementation (eg, a LUCI-style - * .isolated file). This field is repeated since implementations might want - * to cache the metadata, in which case it may be useful to break up - * portions of the filesystem that change frequently (eg, specific input - * files) from those that don't (eg, standard header files). + * The input filesystem to be set up prior to the task beginning. The contents should be a repeated set of FileMetadata messages though other formats are allowed if better for the implementation (eg, a LUCI-style .isolated file). This field is repeated since implementations might want to cache the metadata, in which case it may be useful to break up portions of the filesystem that change frequently (eg, specific input files) from those that don't (eg, standard header files). */ files?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest[]; /** - * Inline contents for blobs expected to be needed by the bot to execute the - * task. For example, contents of entries in `files` or blobs that are - * indirectly referenced by an entry there. The bot should check against - * this list before downloading required task inputs to reduce the number of - * communications between itself and the remote CAS server. + * Inline contents for blobs expected to be needed by the bot to execute the task. For example, contents of entries in `files` or blobs that are indirectly referenced by an entry there. The bot should check against this list before downloading required task inputs to reduce the number of communications between itself and the remote CAS server. */ inlineBlobs?: Schema$GoogleDevtoolsRemoteworkersV1test2Blob[]; /** - * Directory from which a command is executed. It is a relative directory - * with respect to the bot's working directory (i.e., "./"). - * If it is non-empty, then it must exist under "./". Otherwise, - * "./" will be used. + * Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., "./"). If it is non-empty, then it must exist under "./". Otherwise, "./" will be used. */ workingDirectory?: string; } @@ -1670,29 +1134,19 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs { /** - * A list of expected directories, relative to the execution root. All paths - * MUST be delimited by forward slashes. + * A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes. */ directories?: string[]; /** - * A list of expected files, relative to the execution root. All paths MUST - * be delimited by forward slashes. + * A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes. */ files?: string[]; /** - * The destination to which any stderr should be sent. The method by which - * the bot should send the stream contents to that destination is not - * defined in this API. As examples, the destination could be a file - * referenced in the `files` field in this message, or it could be a URI - * that must be written via the ByteStream API. + * The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ stderrDestination?: string; /** - * The destination to which any stdout should be sent. The method by which - * the bot should send the stream contents to that destination is not - * defined in this API. As examples, the destination could be a file - * referenced in the `files` field in this message, or it could be a URI - * that must be written via the ByteStream API. + * The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ stdoutDestination?: string; } @@ -1701,55 +1155,33 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts { /** - * This specifies the maximum time that the task can run, excluding the time - * required to download inputs or upload outputs. That is, the worker will - * terminate the task if it runs longer than this. + * This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this. */ execution?: string; /** - * This specifies the maximum amount of time the task can be idle - that is, - * go without generating some output in either stdout or stderr. If the - * process is silent for more than the specified time, the worker will - * terminate the task. + * This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task. */ idle?: string; /** - * If the execution or IO timeouts are exceeded, the worker will try to - * gracefully terminate the task and return any existing logs. However, - * tasks may be hard-frozen in which case this process will fail. This - * timeout specifies how long to wait for a terminated task to shut down - * gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. - * SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). + * If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). */ shutdown?: string; } /** - * The CommandTask and CommandResult messages assume the existence of a - * service that can serve blobs of content, identified by a hash and size - * known as a "digest." The method by which these blobs may be - * retrieved is not specified here, but a model implementation is in the - * Remote Execution API's "ContentAddressibleStorage" interface. - * In the context of the RWAPI, a Digest will virtually always refer to the - * contents of a file or a directory. The latter is represented by the - * byte-encoded Directory message. + * The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2Digest { /** - * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, - * 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). + * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). */ hash?: string; /** - * The size of the contents. While this is not strictly required as part of - * an identifier (after all, any given hash will have exactly one canonical - * size), it's useful in almost all cases when one might want to send or - * retrieve blobs of content and is included here for this reason. + * The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason. */ sizeBytes?: string; } /** - * The contents of a directory. Similar to the equivalent message in the - * Remote Execution API. + * The contents of a directory. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2Directory { /** @@ -1762,13 +1194,11 @@ export namespace remotebuildexecution_v1alpha { files?: Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata[]; } /** - * The metadata for a directory. Similar to the equivalent message in the - * Remote Execution API. + * The metadata for a directory. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata { /** - * A pointer to the contents of the directory, in the form of a marshalled - * Directory message. + * A pointer to the contents of the directory, in the form of a marshalled Directory message. */ digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** @@ -1777,18 +1207,15 @@ export namespace remotebuildexecution_v1alpha { path?: string; } /** - * The metadata for a file. Similar to the equivalent message in the Remote - * Execution API. + * The metadata for a file. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata { /** - * If the file is small enough, its contents may also or alternatively be - * listed here. + * If the file is small enough, its contents may also or alternatively be listed here. */ contents?: string; /** - * A pointer to the contents of the file. The method by which a client - * retrieves the contents from a CAS system is not defined here. + * A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here. */ digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** @@ -1796,23 +1223,16 @@ export namespace remotebuildexecution_v1alpha { */ isExecutable?: boolean; /** - * The path of this file. If this message is part of the - * CommandOutputs.outputs fields, the path is relative to the execution root - * and must correspond to an entry in CommandTask.outputs.files. If this - * message is part of a Directory message, then the path is relative to the - * root of that directory. All paths MUST be delimited by forward slashes. + * The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes. */ path?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1820,64 +1240,20 @@ export namespace remotebuildexecution_v1alpha { */ error?: Schema$GoogleRpcStatus; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpcStatus { /** @@ -1885,14 +1261,11 @@ export namespace remotebuildexecution_v1alpha { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1920,10 +1293,7 @@ export namespace remotebuildexecution_v1alpha { /** * remotebuildexecution.projects.instances.create - * @desc Creates a new instance in the specified region. Returns a long - * running operation which contains an instance on completion. While the - * long running operation is in progress, any call to `GetInstance` returns - * an instance in state `CREATING`. + * @desc Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`. * @alias remotebuildexecution.projects.instances.create * @memberOf! () * @@ -2006,9 +1376,7 @@ export namespace remotebuildexecution_v1alpha { /** * remotebuildexecution.projects.instances.delete - * @desc Deletes the specified instance. Returns a long running operation - * which contains a `google.protobuf.Empty` response on completion. Deleting - * an instance with worker pools in it will delete these worker pools. + * @desc Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools. * @alias remotebuildexecution.projects.instances.delete * @memberOf! () * @@ -2293,8 +1661,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the project containing the instance. Format: - * `projects/[PROJECT_ID]`. + * Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. */ parent?: string; @@ -2311,8 +1678,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the instance to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -2324,8 +1690,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the instance to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -2350,10 +1715,7 @@ export namespace remotebuildexecution_v1alpha { /** * remotebuildexecution.projects.instances.workerpools.create - * @desc Creates a new worker pool with a specified size and configuration. - * Returns a long running operation which contains a worker pool on - * completion. While the long running operation is in progress, any call to - * `GetWorkerPool` returns a worker pool in state `CREATING`. + * @desc Creates a new worker pool with a specified size and configuration. Returns a long running operation which contains a worker pool on completion. While the long running operation is in progress, any call to `GetWorkerPool` returns a worker pool in state `CREATING`. * @alias remotebuildexecution.projects.instances.workerpools.create * @memberOf! () * @@ -2436,10 +1798,7 @@ export namespace remotebuildexecution_v1alpha { /** * remotebuildexecution.projects.instances.workerpools.delete - * @desc Deletes the specified worker pool. Returns a long running - * operation, which contains a `google.protobuf.Empty` response on - * completion. While the long running operation is in progress, any call to - * `GetWorkerPool` returns a worker pool in state `DELETING`. + * @desc Deletes the specified worker pool. Returns a long running operation, which contains a `google.protobuf.Empty` response on completion. While the long running operation is in progress, any call to `GetWorkerPool` returns a worker pool in state `DELETING`. * @alias remotebuildexecution.projects.instances.workerpools.delete * @memberOf! () * @@ -2717,10 +2076,7 @@ export namespace remotebuildexecution_v1alpha { /** * remotebuildexecution.projects.instances.workerpools.patch - * @desc Updates an existing worker pool with a specified size and/or - * configuration. Returns a long running operation, which contains a worker - * pool on completion. While the long running operation is in progress, any - * call to `GetWorkerPool` returns a worker pool in state `UPDATING`. + * @desc Updates an existing worker pool with a specified size and/or configuration. Returns a long running operation, which contains a worker pool on completion. While the long running operation is in progress, any call to `GetWorkerPool` returns a worker pool in state `UPDATING`. * @alias remotebuildexecution.projects.instances.workerpools.patch * @memberOf! () * @@ -2807,8 +2163,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the instance in which to create the new worker pool. - * Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; @@ -2825,8 +2180,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the worker pool to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } @@ -2838,8 +2192,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the worker pool to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } @@ -2851,8 +2204,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the instance. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; } @@ -2864,10 +2216,7 @@ export namespace remotebuildexecution_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * WorkerPool resource name formatted as: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - * name should not be populated when creating a worker pool since it is - * provided in the `poolId` field. + * WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field. */ name?: string; @@ -2885,9 +2234,7 @@ export namespace remotebuildexecution_v1alpha { /** * remotebuildexecution.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias remotebuildexecution.projects.operations.get * @memberOf! () * diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index c965bdfbf14..8fc9172d361 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace remotebuildexecution_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace remotebuildexecution_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -116,7 +112,10 @@ export namespace remotebuildexecution_v2 { v2: Resource$V2; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.actionResults = new Resource$Actionresults(this.context); this.actions = new Resource$Actions(this.context); @@ -127,25 +126,11 @@ export namespace remotebuildexecution_v2 { } /** - * An `Action` captures all the information about an execution which is - * required to reproduce it. `Action`s are the core component of the - * [Execution] service. A single `Action` represents a repeatable action that - * can be performed by the execution service. `Action`s can be succinctly - * identified by the digest of their wire format encoding and, once an - * `Action` has been executed, will be cached in the action cache. Future - * requests can then use the cached result rather than needing to run afresh. - * When a server completes execution of an Action, it MAY choose to cache the - * result in the ActionCache unless `do_not_cache` is `true`. Clients SHOULD - * expect the server to do so. By default, future calls to Execute the same - * `Action` will also serve their results from the cache. Clients must take - * care to understand the caching behaviour. Ideally, all `Action`s will be - * reproducible so that serving a result from cache is always desirable and - * correct. + * An `Action` captures all the information about an execution which is required to reproduce it. `Action`s are the core component of the [Execution] service. A single `Action` represents a repeatable action that can be performed by the execution service. `Action`s can be succinctly identified by the digest of their wire format encoding and, once an `Action` has been executed, will be cached in the action cache. Future requests can then use the cached result rather than needing to run afresh. When a server completes execution of an Action, it MAY choose to cache the result in the ActionCache unless `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, future calls to Execute the same `Action` will also serve their results from the cache. Clients must take care to understand the caching behaviour. Ideally, all `Action`s will be reproducible so that serving a result from cache is always desirable and correct. */ export interface Schema$BuildBazelRemoteExecutionV2Action { /** - * The digest of the Command to run, which MUST be present in the - * ContentAddressableStorage. + * The digest of the Command to run, which MUST be present in the ContentAddressableStorage. */ commandDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** @@ -153,27 +138,11 @@ export namespace remotebuildexecution_v2 { */ doNotCache?: boolean; /** - * The digest of the root Directory for the input files. The files in the - * directory tree are available in the correct location on the build machine - * before the command is executed. The root directory, as well as every - * subdirectory and content blob referred to, MUST be in the - * ContentAddressableStorage. + * The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage. */ inputRootDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * A timeout after which the execution should be killed. If the timeout is - * absent, then the client is specifying that the execution should continue - * as long as the server will let it. The server SHOULD impose a timeout if - * the client does not specify one, however, if the client does specify a - * timeout that is longer than the server's maximum timeout, the server - * MUST reject the request. The timeout is a part of the Action message, - * and therefore two `Actions` with different timeouts are different, even - * if they are otherwise identical. This is because, if they were not, - * running an `Action` with a lower timeout than is required might result in - * a cache hit from an execution run with a longer timeout, hiding the fact - * that the timeout is too short. By encoding it directly in the `Action`, a - * lower timeout will result in a cache miss and the execution timeout will - * fail immediately, rather than whenever the cache entry gets evicted. + * A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted. */ timeout?: string; } @@ -196,100 +165,35 @@ export namespace remotebuildexecution_v2 { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested - * in the `output_directories` field of the Action, if the corresponding - * directory existed after the action completed, a single entry will be - * present in the output list, which will contain the digest of a Tree - * message containing the directory tree, and the path equal exactly to the - * corresponding Action output_directories member. As an example, suppose - * the Action had an output directory `a/b/dir` and the execution produced - * the following contents in `a/b/dir`: a file named `bar` and a directory - * named `foo` with an executable file named `baz`. Then, output_directory - * will contain (hashes shortened for readability): ```json // - * OutputDirectory proto: { path: "a/b/dir" tree_digest: { - * hash: "4a73bc9d03...", size: 55 } } // Tree proto with - * hash "4a73bc9d03..." and size 55: { root: { files: [ { - * name: "bar", digest: { hash: - * "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { - * hash: "4cf2eda940...", size: 43 } } ] - * } children : { // (Directory proto with hash - * "4cf2eda940..." and size 43) files: [ { name: - * "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, - * is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ outputDirectories?: Schema$BuildBazelRemoteExecutionV2OutputDirectory[]; /** - * The output directories of the action that are symbolic links to other - * directories. Those may be links to other output directories, or input - * directories, or even absolute paths outside of the working directory, if - * the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output - * directory requested in the `output_directories` field of the Action, if - * the directory file existed after the action completed, a single entry - * will be present either in this field, or in the `output_directories` - * field, if the directory was not a symbolic link. If the action does not - * produce the requested output, or produces a file where a directory is - * expected or vice versa, then that output will be omitted from the list. - * The server is free to arrange the output list as desired; clients MUST - * NOT assume that the output list is sorted. + * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory file existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If the action does not produce the requested output, or produces a file where a directory is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputDirectorySymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The output files of the action. For each output file requested in the - * `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present either in this - * field, or in the output_file_symlinks field, if the file was a symbolic - * link to another file. If the action does not produce the requested - * output, or produces a directory where a regular file is expected or vice - * versa, then that output will be omitted from the list. The server is free - * to arrange the output list as desired; clients MUST NOT assume that the - * output list is sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the output_file_symlinks field, if the file was a symbolic link to another file. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$BuildBazelRemoteExecutionV2OutputFile[]; /** - * The output files of the action that are symbolic links to other files. - * Those may be links to other output files, or input files, or even - * absolute paths outside of the working directory, if the server supports - * SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in - * the `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present either in this - * field, or in the `output_files` field, if the file was not a symbolic - * link. If the action does not produce the requested output, or produces a - * directory where a regular file is expected or vice versa, then that - * output will be omitted from the list. The server is free to arrange the - * output list as desired; clients MUST NOT assume that the output list is - * sorted. + * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFileSymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The digest for a blob containing the standard error of the action, which - * can be retrieved from the ContentAddressableStorage. See `stderr_raw` for - * when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. */ stderrDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard error buffer of the action. The server will determine, based - * on the size of the buffer, whether to return it in raw form or to return - * a digest in `stderr_digest` that points to the buffer. If neither is set, - * then the buffer is empty. The client SHOULD NOT assume it will get one of - * the raw buffer or a digest on any given request and should be prepared to - * handle either. + * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which - * can be retrieved from the ContentAddressableStorage. See `stdout_raw` for - * when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ stdoutDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard output buffer of the action. The server will determine, - * based on the size of the buffer, whether to return it in raw form or to - * return a digest in `stdout_digest` that points to the buffer. If neither - * is set, then the buffer is empty. The client SHOULD NOT assume it will - * get one of the raw buffer or a digest on any given request and should be - * prepared to handle either. + * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stdoutRaw?: string; } @@ -385,15 +289,11 @@ export namespace remotebuildexecution_v2 { */ cachePriorityCapabilities?: Schema$BuildBazelRemoteExecutionV2PriorityCapabilities; /** - * All the digest functions supported by the remote cache. Remote cache may - * support multiple digest functions simultaneously. + * All the digest functions supported by the remote cache. Remote cache may support multiple digest functions simultaneously. */ digestFunction?: string[]; /** - * Maximum total size of blobs to be uploaded/downloaded using batch - * methods. A value of 0 means no limit is set, although in practice there - * will always be a message size limitation of the protocol in use, e.g. - * GRPC. + * Maximum total size of blobs to be uploaded/downloaded using batch methods. A value of 0 means no limit is set, although in practice there will always be a message size limitation of the protocol in use, e.g. GRPC. */ maxBatchTotalSizeBytes?: string; /** @@ -402,86 +302,36 @@ export namespace remotebuildexecution_v2 { symlinkAbsolutePathStrategy?: string; } /** - * A `Command` is the actual command executed by a worker running an Action - * and specifications of its environment. Except as otherwise required, the - * environment (such as which system libraries or binaries are available, and - * what filesystems are mounted where) is defined by and specific to the - * implementation of the remote execution API. + * A `Command` is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. */ export interface Schema$BuildBazelRemoteExecutionV2Command { /** - * The arguments to the command. The first argument must be the path to the - * executable, which must be either a relative path, in which case it is - * evaluated with respect to the input root, or an absolute path. + * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. */ arguments?: string[]; /** - * The environment variables to set when running the program. The worker may - * provide its own default environment variables; these defaults can be - * overridden using this field. Additional variables can also be specified. - * In order to ensure that equivalent Commands always hash to the same - * value, the environment variables MUST be lexicographically sorted by - * name. Sorting of strings is done by code point, equivalently, by the - * UTF-8 bytes. + * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ environmentVariables?: Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable[]; /** - * A list of the output directories that the client expects to retrieve from - * the action. Only the listed directories will be returned (an entire - * directory structure will be returned as a Tree message digest, see - * OutputDirectory), as well as files listed in `output_files`. Other files - * or directories that may be created during command execution are - * discarded. The paths are relative to the working directory of the action - * execution. The paths are specified using a single forward slash (`/`) as - * a path separator, even if the execution platform natively uses a - * different separator. The path MUST NOT include a trailing slash, nor a - * leading slash, being a relative path. The special value of empty string - * is allowed, although not recommended, and can be used to capture the - * entire working directory tree, including inputs. In order to ensure - * consistent hashing of the same Action, the output paths MUST be sorted - * lexicographically by code point (or, equivalently, by UTF-8 bytes). An - * output directory cannot be duplicated or have the same path as any of the - * listed output files. Directories leading up to the output directories - * (but not the output directories themselves) are created by the worker - * prior to execution, even if they are not explicitly part of the input - * root. + * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputDirectories?: string[]; /** - * A list of the output files that the client expects to retrieve from the - * action. Only the listed files, as well as directories listed in - * `output_directories`, will be returned to the client as output. Other - * files or directories that may be created during command execution are - * discarded. The paths are relative to the working directory of the action - * execution. The paths are specified using a single forward slash (`/`) as - * a path separator, even if the execution platform natively uses a - * different separator. The path MUST NOT include a trailing slash, nor a - * leading slash, being a relative path. In order to ensure consistent - * hashing of the same Action, the output paths MUST be sorted - * lexicographically by code point (or, equivalently, by UTF-8 bytes). An - * output file cannot be duplicated, be a parent of another output file, or - * have the same path as any of the listed output directories. Directories - * leading up to the output files are created by the worker prior to - * execution, even if they are not explicitly part of the input root. + * A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputFiles?: string[]; /** - * The platform requirements for the execution environment. The server MAY - * choose to execute the action on any worker satisfying the requirements, - * so the client SHOULD ensure that running the action on any such worker - * will have the same result. + * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. */ platform?: Schema$BuildBazelRemoteExecutionV2Platform; /** - * The working directory, relative to the input root, for the command to run - * in. It must be a directory which exists in the input tree. If it is left - * empty, then the action is run in the input root. + * The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root. */ workingDirectory?: string; } /** - * An `EnvironmentVariable` is one variable to set in the running - * program's environment. + * An `EnvironmentVariable` is one variable to set in the running program's environment. */ export interface Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable { /** @@ -494,36 +344,11 @@ export namespace remotebuildexecution_v2 { value?: string; } /** - * A content digest. A digest for a given blob consists of the size of the - * blob and its hash. The hash algorithm to use is defined by the server, but - * servers SHOULD use SHA-256. The size is considered to be an integral part - * of the digest and cannot be separated. That is, even if the `hash` field is - * correctly specified but `size_bytes` is not, the server MUST reject the - * request. The reason for including the size in the digest is as follows: in - * a great many cases, the server needs to know the size of the blob it is - * about to work with prior to starting an operation with it, such as - * flattening Merkle tree structures or streaming it to a worker. Technically, - * the server could implement a separate metadata store, but this results in a - * significantly more complicated implementation as opposed to having the - * client specify the size up-front (or storing the size along with the digest - * in every message where digests are embedded). This does mean that the API - * leaks some implementation details of (what we consider to be) a reasonable - * server implementation, but we consider this to be a worthwhile tradeoff. - * When a `Digest` is used to refer to a proto message, it always refers to - * the message in binary encoded form. To ensure consistent hashing, clients - * and servers MUST ensure that they serialize messages according to the - * following rules, even if there are alternate valid encodings for the same - * message: * Fields are serialized in tag order. * There are no unknown - * fields. * There are no duplicate fields. * Fields are serialized according - * to the default semantics for their type. Most protocol buffer - * implementations will always follow these rules when serializing, but care - * should be taken to avoid shortcuts. For instance, concatenating two - * messages to merge them may produce duplicate fields. + * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message: * Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. */ export interface Schema$BuildBazelRemoteExecutionV2Digest { /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** @@ -532,30 +357,7 @@ export namespace remotebuildexecution_v2 { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero - * or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` - * contains its name in the directory, either the digest of its content - * (either a file blob or a `Directory` proto) or a symlink target, as well as - * possibly some metadata about the file or directory. In order to ensure - * that two equivalent directory trees hash to the same value, the following - * restrictions MUST be obeyed when constructing a a `Directory`: * Every - * child in the directory must have a path of exactly one segment. Multiple - * levels of directory hierarchy may not be collapsed. * Each child in the - * directory must have a unique path segment (file name). * The files, - * directories and symlinks in the directory must each be sorted in - * lexicographical order by path. The path strings must be sorted by code - * point, equivalently, by UTF-8 bytes. A `Directory` that obeys the - * restrictions is said to be in canonical form. As an example, the following - * could be used for a file named `bar` and a directory named `foo` with an - * executable file named `baz` (hashes shortened for readability): ```json // - * (Directory proto) { files: [ { name: "bar", digest: { - * hash: "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { hash: - * "4cf2eda940...", size: 43 } } ] } // - * (Directory proto with hash "4cf2eda940..." and size 43) { files: - * [ { name: "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, is_executable: true - * } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$BuildBazelRemoteExecutionV2Directory { /** @@ -572,13 +374,11 @@ export namespace remotebuildexecution_v2 { symlinks?: Schema$BuildBazelRemoteExecutionV2SymlinkNode[]; } /** - * A `DirectoryNode` represents a child of a Directory which is itself a - * `Directory` and its associated metadata. + * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. */ export interface Schema$BuildBazelRemoteExecutionV2DirectoryNode { /** - * The digest of the Directory object represented. See Digest for - * information about how to take the digest of a proto message. + * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. */ digest?: Schema$BuildBazelRemoteExecutionV2Digest; /** @@ -632,8 +432,7 @@ export namespace remotebuildexecution_v2 { workerStartTimestamp?: string; } /** - * Metadata about an ongoing execution, which will be contained in the - * metadata field of the Operation. + * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. */ export interface Schema$BuildBazelRemoteExecutionV2ExecuteOperationMetadata { /** @@ -642,13 +441,11 @@ export namespace remotebuildexecution_v2 { actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest; stage?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard error. + * If set, the client can use this name with ByteStream.Read to stream the standard error. */ stderrStreamName?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard output. + * If set, the client can use this name with ByteStream.Read to stream the standard output. */ stdoutStreamName?: string; } @@ -661,26 +458,20 @@ export namespace remotebuildexecution_v2 { */ actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * An optional policy for execution of the action. The server will have a - * default policy if this is not provided. + * An optional policy for execution of the action. The server will have a default policy if this is not provided. */ executionPolicy?: Schema$BuildBazelRemoteExecutionV2ExecutionPolicy; /** - * An optional policy for the results of this execution in the remote cache. - * The server will have a default policy if this is not provided. This may - * be applied to both the ActionResult and the associated blobs. + * An optional policy for the results of this execution in the remote cache. The server will have a default policy if this is not provided. This may be applied to both the ActionResult and the associated blobs. */ resultsCachePolicy?: Schema$BuildBazelRemoteExecutionV2ResultsCachePolicy; /** - * If true, the action will be executed anew even if its result was already - * present in the cache. If false, the result may be served from the - * ActionCache. + * If true, the action will be executed anew even if its result was already present in the cache. If false, the result may be served from the ActionCache. */ skipCacheLookup?: boolean; } /** - * The response message for Execution.Execute, which will be contained in the - * response field of the Operation. + * The response message for Execution.Execute, which will be contained in the response field of the Operation. */ export interface Schema$BuildBazelRemoteExecutionV2ExecuteResponse { /** @@ -688,9 +479,7 @@ export namespace remotebuildexecution_v2 { */ cachedResult?: boolean; /** - * Freeform informational message with details on the execution of the - * action that may be displayed to the user upon failure or when requested - * explicitly. + * Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly. */ message?: string; /** @@ -698,25 +487,11 @@ export namespace remotebuildexecution_v2 { */ result?: Schema$BuildBazelRemoteExecutionV2ActionResult; /** - * An optional list of additional log outputs the server wishes to provide. - * A server can use this to return execution-specific logs however it - * wishes. This is intended primarily to make it easier for users to debug - * issues that may be outside of the actual job execution, such as by - * identifying the worker executing the action or by providing logs from the - * worker's setup phase. The keys SHOULD be human readable so that a - * client can display them to a user. + * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ serverLogs?: {[key: string]: Schema$BuildBazelRemoteExecutionV2LogFile}; /** - * If the status has a code other than `OK`, it indicates that the action - * did not finish execution. For example, if the operation times out during - * execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST - * use this field for errors in execution, rather than the error field on - * the `Operation` object. If the status code is other than `OK`, then the - * result MUST NOT be cached. For an error status, the `result` field is - * optional; the server may populate the output-, stdout-, and - * stderr-related fields if it has any information available, such as the - * stdout and stderr of a timed-out action. + * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ status?: Schema$GoogleRpcStatus; } @@ -742,15 +517,7 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$BuildBazelRemoteExecutionV2ExecutionPolicy { /** - * The priority (relative importance) of this action. Generally, a lower - * value means that the action should be run sooner than actions having a - * greater priority value, but the interpretation of a given value is - * server- dependent. A priority of 0 means the *default* priority. - * Priorities may be positive or negative, and such actions should run later - * or sooner than actions having the default priority, respectively. The - * particular semantics of this field is up to the server. In particular, - * every server will have their own supported range of priorities, and will - * decide how these map into scheduling policy. + * The priority (relative importance) of this action. Generally, a lower value means that the action should be run sooner than actions having a greater priority value, but the interpretation of a given value is server- dependent. A priority of 0 means the *default* priority. Priorities may be positive or negative, and such actions should run later or sooner than actions having the default priority, respectively. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into scheduling policy. */ priority?: number; } @@ -798,9 +565,7 @@ export namespace remotebuildexecution_v2 { */ directories?: Schema$BuildBazelRemoteExecutionV2Directory[]; /** - * If present, signifies that there are more results which the client can - * retrieve by passing this as the page_token in a subsequent request. If - * empty, signifies that this is the last page of results. + * If present, signifies that there are more results which the client can retrieve by passing this as the page_token in a subsequent request. If empty, signifies that this is the last page of results. */ nextPageToken?: string; } @@ -813,36 +578,25 @@ export namespace remotebuildexecution_v2 { */ digest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * This is a hint as to the purpose of the log, and is set to true if the - * log is human-readable text that can be usefully displayed to a user, and - * false otherwise. For instance, if a command-line client wishes to print - * the server logs to the terminal for a failed action, this allows it to - * avoid displaying a binary file. + * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ humanReadable?: boolean; } /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a - * directory's full contents rather than a single file. + * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. */ export interface Schema$BuildBazelRemoteExecutionV2OutputDirectory { /** - * The full path of the directory relative to the working directory. The - * path separator is a forward slash `/`. Since this is a relative path, it - * MUST NOT begin with a leading forward slash. The empty string value is - * allowed, and it denotes the entire working directory. + * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ path?: string; /** - * The digest of the encoded Tree proto containing the directory's - * contents. + * The digest of the encoded Tree proto containing the directory's contents. */ treeDigest?: Schema$BuildBazelRemoteExecutionV2Digest; } /** - * An `OutputFile` is similar to a FileNode, but it is used as an output in an - * `ActionResult`. It allows a full file path rather than only a name. - * `OutputFile` is binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. `OutputFile` is binary-compatible with `FileNode`. */ export interface Schema$BuildBazelRemoteExecutionV2OutputFile { /** @@ -854,62 +608,34 @@ export namespace remotebuildexecution_v2 { */ isExecutable?: boolean; /** - * The full path of the file relative to the working directory, including - * the filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the file relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; } /** - * An `OutputSymlink` is similar to a Symlink, but it is used as an output in - * an `ActionResult`. `OutputSymlink` is binary-compatible with - * `SymlinkNode`. + * An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. */ export interface Schema$BuildBazelRemoteExecutionV2OutputSymlink { /** - * The full path of the symlink relative to the working directory, including - * the filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the symlink relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; /** - * The target path of the symlink. The path separator is a forward slash - * `/`. The target path can be relative to the parent directory of the - * symlink or it can be an absolute path starting with `/`. Support for - * absolute paths can be checked using the Capabilities API. The canonical - * form forbids the substrings `/./` and `//` in the target path. `..` - * components are allowed anywhere in the target path. + * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ target?: string; } /** - * A `Platform` is a set of requirements, such as hardware, operating system, - * or compiler toolchain, for an Action's execution environment. A - * `Platform` is represented as a series of key-value pairs representing the - * properties that are required of the platform. + * A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform. */ export interface Schema$BuildBazelRemoteExecutionV2Platform { /** - * The properties that make up this platform. In order to ensure that - * equivalent `Platform`s always hash to the same value, the properties MUST - * be lexicographically sorted by name, and then by value. Sorting of - * strings is done by code point, equivalently, by the UTF-8 bytes. + * The properties that make up this platform. In order to ensure that equivalent `Platform`s always hash to the same value, the properties MUST be lexicographically sorted by name, and then by value. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ properties?: Schema$BuildBazelRemoteExecutionV2PlatformProperty[]; } /** - * A single property for the environment. The server is responsible for - * specifying the property `name`s that it accepts. If an unknown `name` is - * provided in the requirements for an Action, the server SHOULD reject the - * execution request. If permitted by the server, the same `name` may occur - * multiple times. The server is also responsible for specifying the - * interpretation of property `value`s. For instance, a property describing - * how much RAM must be available may be interpreted as allowing a worker with - * 16GB to fulfill a request for 8GB, while a property describing the OS - * environment on which the action must be performed may require an exact - * match with the worker's OS. The server MAY use the `value` of one or - * more properties to determine how it sets up the execution environment, such - * as by making specific system files available to the worker. + * A single property for the environment. The server is responsible for specifying the property `name`s that it accepts. If an unknown `name` is provided in the requirements for an Action, the server SHOULD reject the execution request. If permitted by the server, the same `name` may occur multiple times. The server is also responsible for specifying the interpretation of property `value`s. For instance, a property describing how much RAM must be available may be interpreted as allowing a worker with 16GB to fulfill a request for 8GB, while a property describing the OS environment on which the action must be performed may require an exact match with the worker's OS. The server MAY use the `value` of one or more properties to determine how it sets up the execution environment, such as by making specific system files available to the worker. */ export interface Schema$BuildBazelRemoteExecutionV2PlatformProperty { /** @@ -922,8 +648,7 @@ export namespace remotebuildexecution_v2 { value?: string; } /** - * Allowed values for priority in ResultsCachePolicy Used for querying both - * cache and execution valid priority ranges. + * Allowed values for priority in ResultsCachePolicy Used for querying both cache and execution valid priority ranges. */ export interface Schema$BuildBazelRemoteExecutionV2PriorityCapabilities { priorities?: Schema$BuildBazelRemoteExecutionV2PriorityCapabilitiesPriorityRange[]; @@ -936,24 +661,15 @@ export namespace remotebuildexecution_v2 { minPriority?: number; } /** - * An optional Metadata to attach to any RPC request to tell the server about - * an external context of the request. The server may use this for logging or - * other purposes. To use it, the client attaches the header to the call using - * the canonical proto serialization: * name: - * `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the - * base64 encoded binary `RequestMetadata` message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. */ export interface Schema$BuildBazelRemoteExecutionV2RequestMetadata { /** - * An identifier that ties multiple requests to the same action. For - * example, multiple requests to the CAS, Action Cache, and Execution API - * are used in order to compile foo.cc. + * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ actionId?: string; /** - * An identifier to tie multiple tool invocations together. For example, - * runs of foo_test, bar_test and baz_test on a post-submit of a given - * patch. + * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ correlatedInvocationsId?: string; /** @@ -961,24 +677,16 @@ export namespace remotebuildexecution_v2 { */ toolDetails?: Schema$BuildBazelRemoteExecutionV2ToolDetails; /** - * An identifier that ties multiple actions together to a final result. For - * example, multiple actions are required to build and run foo_test. + * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ toolInvocationId?: string; } /** - * A `ResultsCachePolicy` is used for fine-grained control over how action - * outputs are stored in the CAS and Action Cache. + * A `ResultsCachePolicy` is used for fine-grained control over how action outputs are stored in the CAS and Action Cache. */ export interface Schema$BuildBazelRemoteExecutionV2ResultsCachePolicy { /** - * The priority (relative importance) of this content in the overall cache. - * Generally, a lower value means a longer retention time or other - * advantage, but the interpretation of a given value is server-dependent. A - * priority of 0 means a *default* value, decided by the server. The - * particular semantics of this field is up to the server. In particular, - * every server will have their own supported range of priorities, and will - * decide how these map into retention/eviction policy. + * The priority (relative importance) of this content in the overall cache. Generally, a lower value means a longer retention time or other advantage, but the interpretation of a given value is server-dependent. A priority of 0 means a *default* value, decided by the server. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into retention/eviction policy. */ priority?: number; } @@ -1016,12 +724,7 @@ export namespace remotebuildexecution_v2 { */ name?: string; /** - * The target path of the symlink. The path separator is a forward slash - * `/`. The target path can be relative to the parent directory of the - * symlink or it can be an absolute path starting with `/`. Support for - * absolute paths can be checked using the Capabilities API. The canonical - * form forbids the substrings `/./` and `//` in the target path. `..` - * components are allowed anywhere in the target path. + * The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path. */ target?: string; } @@ -1039,15 +742,11 @@ export namespace remotebuildexecution_v2 { toolVersion?: string; } /** - * A `Tree` contains all the Directory protos in a single directory Merkle - * tree, compressed into one message. + * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. */ export interface Schema$BuildBazelRemoteExecutionV2Tree { /** - * All the child directories: the directories referred to by the root and, - * recursively, all its children. In order to reconstruct the directory - * tree, the client must take the digests of each of the child directories - * and then build up a tree starting from the `root`. + * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. */ children?: Schema$BuildBazelRemoteExecutionV2Directory[]; /** @@ -1076,25 +775,20 @@ export namespace remotebuildexecution_v2 { */ patch?: number; /** - * The pre-release version. Either this field or major/minor/patch fields - * must be filled. They are mutually exclusive. Pre-release versions are - * assumed to be earlier than any released versions. + * The pre-release version. Either this field or major/minor/patch fields must be filled. They are mutually exclusive. Pre-release versions are assumed to be earlier than any released versions. */ prerelease?: string; } /** - * CommandDuration contains the various duration metrics tracked when a bot - * performs a command. + * CommandDuration contains the various duration metrics tracked when a bot performs a command. */ export interface Schema$GoogleDevtoolsRemotebuildbotCommandDurations { /** - * The time spent preparing the command to be run in a Docker container - * (includes pulling the Docker image, if necessary). + * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ dockerPrep?: string; /** - * The time spent downloading the input files and constructing the working - * directory. + * The time spent downloading the input files and constructing the working directory. */ download?: string; /** @@ -1119,13 +813,11 @@ export namespace remotebuildexecution_v2 { upload?: string; } /** - * CommandEvents contains counters for the number of warnings and errors that - * occurred during the execution of a command. + * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. */ export interface Schema$GoogleDevtoolsRemotebuildbotCommandEvents { /** - * Indicates whether we are using a cached Docker image (true) or had to - * pull the Docker image (false) for this command. + * Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command. */ dockerCacheHit?: boolean; /** @@ -1146,20 +838,15 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest { /** - * Specifies the instance to create. The name in the instance, if specified - * in the instance, is ignored. + * Specifies the instance to create. The name in the instance, if specified in the instance, is ignored. */ instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; /** - * ID of the created instance. A valid `instance_id` must: be 6-50 - * characters long, contain only lowercase letters, digits, hyphens and - * underscores, start with a lowercase letter, and end with a lowercase - * letter or a digit. + * ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ instanceId?: string; /** - * Resource name of the project containing the instance. Format: - * `projects/[PROJECT_ID]`. + * Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. */ parent?: string; } @@ -1168,20 +855,15 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest { /** - * Resource name of the instance in which to create the new worker pool. - * Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; /** - * ID of the created worker pool. A valid pool ID must: be 6-50 characters - * long, contain only lowercase letters, digits, hyphens and underscores, - * start with a lowercase letter, and end with a lowercase letter or a - * digit. + * ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit. */ poolId?: string; /** - * Specifies the worker pool to create. The name in the worker pool, if - * specified, is ignored. + * Specifies the worker pool to create. The name in the worker pool, if specified, is ignored. */ workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool; } @@ -1190,8 +872,7 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest { /** - * Name of the instance to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -1200,8 +881,7 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest { /** - * Name of the worker pool to delete. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } @@ -1210,8 +890,7 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest { /** - * Name of the instance to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -1220,17 +899,12 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest { /** - * Name of the worker pool to retrieve. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + * Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. */ name?: string; } /** - * Instance conceptually encapsulates all Remote Build Execution resources for - * remote builds. An instance consists of storage and compute resources (for - * example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used - * for running remote builds. All Remote Build Execution API calls are scoped - * to an instance. + * Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance { /** @@ -1242,10 +916,7 @@ export namespace remotebuildexecution_v2 { */ loggingEnabled?: boolean; /** - * Output only. Instance resource name formatted as: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be - * populated when creating an instance since it is provided in the - * `instance_id` field. + * Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. */ name?: string; /** @@ -1267,8 +938,7 @@ export namespace remotebuildexecution_v2 { } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest { /** - * Resource name of the instance. Format: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ parent?: string; } @@ -1283,13 +953,7 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest { /** - * The update mask applies to worker_pool. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * If an empty update_mask is provided, only the non-default valued field in - * the worker pool field will be updated. Note that in order to update a - * field to the default value (zero, false, empty string) an explicit - * update_mask must be provided. + * The update mask applies to worker_pool. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ updateMask?: string; /** @@ -1298,37 +962,27 @@ export namespace remotebuildexecution_v2 { workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool; } /** - * Defines the configuration to be used for a creating workers in the worker - * pool. + * Defines the configuration to be used for a creating workers in the worker pool. */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig { /** - * Required. Size of the disk attached to the worker, in GB. See - * https://cloud.google.com/compute/docs/disks/ + * Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ */ diskSizeGb?: string; /** - * Required. Disk Type to use for the worker. See [Storage - * options](https://cloud.google.com/compute/docs/disks/#introduction). - * Currently only `pd-standard` is supported. + * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. */ diskType?: string; /** - * Required. Machine type of the worker, such as `n1-standard-2`. See - * https://cloud.google.com/compute/docs/machine-types for a list of - * supported machine types. Note that `f1-micro` and `g1-small` are not yet - * supported. + * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ machineType?: string; /** - * Minimum CPU platform to use when creating the worker. See [CPU - * Platforms](https://cloud.google.com/compute/docs/cpu-platforms). + * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ minCpuPlatform?: string; /** - * Determines whether the worker is reserved (equivalent to a Compute Engine - * on-demand VM and therefore won't be preempted). See [Preemptible - * VMs](https://cloud.google.com/preemptible-vms/) for more details. + * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ reserved?: boolean; } @@ -1337,10 +991,7 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool { /** - * WorkerPool resource name formatted as: - * `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - * name should not be populated when creating a worker pool since it is - * provided in the `poolId` field. + * WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field. */ name?: string; /** @@ -1348,13 +999,11 @@ export namespace remotebuildexecution_v2 { */ state?: string; /** - * Specifies the properties, such as machine type and disk size, used for - * creating workers in a worker pool. + * Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool. */ workerConfig?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig; /** - * The desired number of workers in the worker pool. Must be a value between - * 0 and 1000. + * The desired number of workers in the worker pool. Must be a value between 0 and 1000. */ workerCount?: string; } @@ -1367,101 +1016,45 @@ export namespace remotebuildexecution_v2 { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested - * in the `output_directories` field of the Action, if the corresponding - * directory existed after the action completed, a single entry will be - * present in the output list, which will contain the digest of a Tree - * message containing the directory tree, and the path equal exactly to the - * corresponding Action output_directories member. As an example, suppose - * the Action had an output directory `a/b/dir` and the execution produced - * the following contents in `a/b/dir`: a file named `bar` and a directory - * named `foo` with an executable file named `baz`. Then, output_directory - * will contain (hashes shortened for readability): ```json // - * OutputDirectory proto: { path: "a/b/dir" tree_digest: { - * hash: "4a73bc9d03...", size: 55 } } // Tree proto with - * hash "4a73bc9d03..." and size 55: { root: { files: [ { - * name: "bar", digest: { hash: - * "4a73bc9d03...", size: 65534 } } ], - * directories: [ { name: "foo", digest: { - * hash: "4cf2eda940...", size: 43 } } ] - * } children : { // (Directory proto with hash - * "4cf2eda940..." and size 43) files: [ { name: - * "baz", digest: { hash: - * "b2c941073e...", size: 1294, }, - * is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` */ outputDirectories?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory[]; /** - * The output files of the action. For each output file requested in the - * `output_files` field of the Action, if the corresponding file existed - * after the action completed, a single entry will be present in the output - * list. If the action does not produce the requested output, or produces a - * directory where a regular file is expected or vice versa, then that - * output will be omitted from the list. The server is free to arrange the - * output list as desired; clients MUST NOT assume that the output list is - * sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile[]; /** - * The digest for a blob containing the standard error of the action, which - * can be retrieved from the ContentAddressableStorage. See `stderr_raw` for - * when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. */ stderrDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The standard error buffer of the action. The server will determine, based - * on the size of the buffer, whether to return it in raw form or to return - * a digest in `stderr_digest` that points to the buffer. If neither is set, - * then the buffer is empty. The client SHOULD NOT assume it will get one of - * the raw buffer or a digest on any given request and should be prepared to - * handle either. + * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which - * can be retrieved from the ContentAddressableStorage. See `stdout_raw` for - * when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. */ stdoutDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The standard output buffer of the action. The server will determine, - * based on the size of the buffer, whether to return it in raw form or to - * return a digest in `stdout_digest` that points to the buffer. If neither - * is set, then the buffer is empty. The client SHOULD NOT assume it will - * get one of the raw buffer or a digest on any given request and should be - * prepared to handle either. + * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. */ stdoutRaw?: string; } /** - * A `Command` is the actual command executed by a worker running an Action. - * Except as otherwise required, the environment (such as which system - * libraries or binaries are available, and what filesystems are mounted - * where) is defined by and specific to the implementation of the remote - * execution API. + * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommand { /** - * The arguments to the command. The first argument must be the path to the - * executable, which must be either a relative path, in which case it is - * evaluated with respect to the input root, or an absolute path. The - * working directory will always be the input root. + * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. */ arguments?: string[]; /** - * The environment variables to set when running the program. The worker may - * provide its own default environment variables; these defaults can be - * overridden using this field. Additional variables can also be specified. - * In order to ensure that equivalent `Command`s always hash to the same - * value, the environment variables MUST be lexicographically sorted by - * name. Sorting of strings is done by code point, equivalently, by the - * UTF-8 bytes. + * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. */ environmentVariables?: Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable[]; } /** - * An `EnvironmentVariable` is one variable to set in the running - * program's environment. + * An `EnvironmentVariable` is one variable to set in the running program's environment. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable { /** @@ -1474,36 +1067,11 @@ export namespace remotebuildexecution_v2 { value?: string; } /** - * A content digest. A digest for a given blob consists of the size of the - * blob and its hash. The hash algorithm to use is defined by the server, but - * servers SHOULD use SHA-256. The size is considered to be an integral part - * of the digest and cannot be separated. That is, even if the `hash` field is - * correctly specified but `size_bytes` is not, the server MUST reject the - * request. The reason for including the size in the digest is as follows: in - * a great many cases, the server needs to know the size of the blob it is - * about to work with prior to starting an operation with it, such as - * flattening Merkle tree structures or streaming it to a worker. Technically, - * the server could implement a separate metadata store, but this results in a - * significantly more complicated implementation as opposed to having the - * client specify the size up-front (or storing the size along with the digest - * in every message where digests are embedded). This does mean that the API - * leaks some implementation details of (what we consider to be) a reasonable - * server implementation, but we consider this to be a worthwhile tradeoff. - * When a `Digest` is used to refer to a proto message, it always refers to - * the message in binary encoded form. To ensure consistent hashing, clients - * and servers MUST ensure that they serialize messages according to the - * following rules, even if there are alternate valid encodings for the same - * message. - Fields are serialized in tag order. - There are no unknown - * fields. - There are no duplicate fields. - Fields are serialized according - * to the default semantics for their type. Most protocol buffer - * implementations will always follow these rules when serializing, but care - * should be taken to avoid shortcuts. For instance, concatenating two - * messages to merge them may produce duplicate fields. + * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDigest { /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** @@ -1512,29 +1080,7 @@ export namespace remotebuildexecution_v2 { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero - * or more children FileNodes and DirectoryNodes. Each `Node` contains its - * name in the directory, the digest of its content (either a file blob or a - * `Directory` proto), as well as possibly some metadata about the file or - * directory. In order to ensure that two equivalent directory trees hash to - * the same value, the following restrictions MUST be obeyed when constructing - * a a `Directory`: - Every child in the directory must have a path of - * exactly one segment. Multiple levels of directory hierarchy may not be - * collapsed. - Each child in the directory must have a unique path segment - * (file name). - The files and directories in the directory must each be - * sorted in lexicographical order by path. The path strings must be - * sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that - * obeys the restrictions is said to be in canonical form. As an example, the - * following could be used for a file named `bar` and a directory named `foo` - * with an executable file named `baz` (hashes shortened for readability): - * ```json // (Directory proto) { files: [ { name: - * "bar", digest: { hash: "4a73bc9d03...", - * size: 65534 } } ], directories: [ { name: - * "foo", digest: { hash: "4cf2eda940...", - * size: 43 } } ] } // (Directory proto with hash - * "4cf2eda940..." and size 43) { files: [ { name: - * "baz", digest: { hash: "b2c941073e...", - * size: 1294, }, is_executable: true } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectory { /** @@ -1547,13 +1093,11 @@ export namespace remotebuildexecution_v2 { files?: Schema$GoogleDevtoolsRemoteexecutionV1testFileNode[]; } /** - * A `DirectoryNode` represents a child of a Directory which is itself a - * `Directory` and its associated metadata. + * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode { /** - * The digest of the Directory object represented. See Digest for - * information about how to take the digest of a proto message. + * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** @@ -1562,8 +1106,7 @@ export namespace remotebuildexecution_v2 { name?: string; } /** - * Metadata about an ongoing execution, which will be contained in the - * metadata field of the Operation. + * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata { /** @@ -1572,19 +1115,16 @@ export namespace remotebuildexecution_v2 { actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; stage?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard error. + * If set, the client can use this name with ByteStream.Read to stream the standard error. */ stderrStreamName?: string; /** - * If set, the client can use this name with ByteStream.Read to stream the - * standard output. + * If set, the client can use this name with ByteStream.Read to stream the standard output. */ stdoutStreamName?: string; } /** - * The response message for Execution.Execute, which will be contained in the - * response field of the Operation. + * The response message for Execution.Execute, which will be contained in the response field of the Operation. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteResponse { /** @@ -1596,27 +1136,13 @@ export namespace remotebuildexecution_v2 { */ result?: Schema$GoogleDevtoolsRemoteexecutionV1testActionResult; /** - * An optional list of additional log outputs the server wishes to provide. - * A server can use this to return execution-specific logs however it - * wishes. This is intended primarily to make it easier for users to debug - * issues that may be outside of the actual job execution, such as by - * identifying the worker executing the action or by providing logs from the - * worker's setup phase. The keys SHOULD be human readable so that a - * client can display them to a user. + * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. */ serverLogs?: { [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; }; /** - * If the status has a code other than `OK`, it indicates that the action - * did not finish execution. For example, if the operation times out during - * execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST - * use this field for errors in execution, rather than the error field on - * the `Operation` object. If the status code is other than `OK`, then the - * result MUST NOT be cached. For an error status, the `result` field is - * optional; the server may populate the output-, stdout-, and - * stderr-related fields if it has any information available, such as the - * stdout and stderr of a timed-out action. + * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. */ status?: Schema$GoogleRpcStatus; } @@ -1646,17 +1172,12 @@ export namespace remotebuildexecution_v2 { */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * This is a hint as to the purpose of the log, and is set to true if the - * log is human-readable text that can be usefully displayed to a user, and - * false otherwise. For instance, if a command-line client wishes to print - * the server logs to the terminal for a failed action, this allows it to - * avoid displaying a binary file. + * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. */ humanReadable?: boolean; } /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a - * directory's full contents rather than a single file. + * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory { /** @@ -1664,32 +1185,20 @@ export namespace remotebuildexecution_v2 { */ digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; /** - * The full path of the directory relative to the working directory. The - * path separator is a forward slash `/`. Since this is a relative path, it - * MUST NOT begin with a leading forward slash. The empty string value is - * allowed, and it denotes the entire working directory. + * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. */ path?: string; /** - * The digest of the encoded Tree proto containing the directory's - * contents. + * The digest of the encoded Tree proto containing the directory's contents. */ treeDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; } /** - * An `OutputFile` is similar to a FileNode, but it is tailored for output as - * part of an `ActionResult`. It allows a full file path rather than only a - * name, and allows the server to include content inline. `OutputFile` is - * binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline. `OutputFile` is binary-compatible with `FileNode`. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile { /** - * The raw content of the file. This field may be used by the server to - * provide the content of a file inline in an ActionResult and avoid - * requiring that the client make a separate call to - * [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD - * NOT assume that it will get raw content with any request, and always be - * prepared to retrieve it via `digest`. + * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. */ content?: string; /** @@ -1701,31 +1210,20 @@ export namespace remotebuildexecution_v2 { */ isExecutable?: boolean; /** - * The full path of the file relative to the input root, including the - * filename. The path separator is a forward slash `/`. Since this is a - * relative path, it MUST NOT begin with a leading forward slash. + * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. */ path?: string; } /** - * An optional Metadata to attach to any RPC request to tell the server about - * an external context of the request. The server may use this for logging or - * other purposes. To use it, the client attaches the header to the call using - * the canonical proto serialization: name: - * google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the - * base64 encoded binary RequestMetadata message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testRequestMetadata { /** - * An identifier that ties multiple requests to the same action. For - * example, multiple requests to the CAS, Action Cache, and Execution API - * are used in order to compile foo.cc. + * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. */ actionId?: string; /** - * An identifier to tie multiple tool invocations together. For example, - * runs of foo_test, bar_test and baz_test on a post-submit of a given - * patch. + * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. */ correlatedInvocationsId?: string; /** @@ -1733,8 +1231,7 @@ export namespace remotebuildexecution_v2 { */ toolDetails?: Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails; /** - * An identifier that ties multiple actions together to a final result. For - * example, multiple actions are required to build and run foo_test. + * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. */ toolInvocationId?: string; } @@ -1752,15 +1249,11 @@ export namespace remotebuildexecution_v2 { toolVersion?: string; } /** - * A `Tree` contains all the Directory protos in a single directory Merkle - * tree, compressed into one message. + * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. */ export interface Schema$GoogleDevtoolsRemoteexecutionV1testTree { /** - * All the child directories: the directories referred to by the root and, - * recursively, all its children. In order to reconstruct the directory - * tree, the client must take the digests of each of the child directories - * and then build up a tree starting from the `root`. + * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. */ children?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory[]; /** @@ -1769,16 +1262,7 @@ export namespace remotebuildexecution_v2 { root?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory; } /** - * AdminTemp is a prelimiary set of administration tasks. It's called - * "Temp" because we do not yet know the best way to represent admin - * tasks; it's possible that this will be entirely replaced in later - * versions of this API. If this message proves to be sufficient, it will be - * renamed in the alpha or beta release of this API. This message (suitably - * marshalled into a protobuf.Any) can be used as the inline_assignment field - * in a lease; the lease assignment field should simply be `"admin"` - * in these cases. This message is heavily based on Swarming administration - * tasks from the LUCI project - * (http://github.com/luci/luci-py/appengine/swarming). + * AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `"admin"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming). */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2AdminTemp { /** @@ -1804,91 +1288,62 @@ export namespace remotebuildexecution_v2 { digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; } /** - * DEPRECATED - use CommandResult instead. Describes the actual outputs from - * the task. + * DEPRECATED - use CommandResult instead. Describes the actual outputs from the task. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOutputs { /** - * exit_code is only fully reliable if the status' code is OK. If the - * task exceeded its deadline or was cancelled, the process may still - * produce an exit code as it is cancelled, and this will be populated, but - * a successful (zero) is unlikely to be correct unless the status code is - * OK. + * exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK. */ exitCode?: number; /** - * The output files. The blob referenced by the digest should contain one of - * the following (implementation-dependent): * A marshalled - * DirectoryMetadata of the returned filesystem * A LUCI-style .isolated - * file + * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; } /** - * DEPRECATED - use CommandResult instead. Can be used as part of - * CompleteRequest.metadata, or are part of a more sophisticated message. + * DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest.metadata, or are part of a more sophisticated message. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOverhead { /** - * The elapsed time between calling Accept and Complete. The server will - * also have its own idea of what this should be, but this excludes the - * overhead of the RPCs and the bot response time. + * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ duration?: string; /** - * The amount of time *not* spent executing the command (ie - * uploading/downloading files). + * The amount of time *not* spent executing the command (ie uploading/downloading files). */ overhead?: string; } /** - * All information about the execution of a command, suitable for providing as - * the Bots interface's `Lease.result` field. + * All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandResult { /** - * The elapsed time between calling Accept and Complete. The server will - * also have its own idea of what this should be, but this excludes the - * overhead of the RPCs and the bot response time. + * The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. */ duration?: string; /** - * The exit code of the process. An exit code of "0" should only - * be trusted if `status` has a code of OK (otherwise it may simply be - * unset). + * The exit code of the process. An exit code of "0" should only be trusted if `status` has a code of OK (otherwise it may simply be unset). */ exitCode?: number; /** - * Implementation-dependent metadata about the task. Both servers and bots - * may define messages which can be encoded here; bots are free to provide - * metadata in multiple formats, and servers are free to choose one or more - * of the values to process and ignore others. In particular, it is *not* - * considered an error for the bot to provide the server with a field that - * it doesn't know about. + * Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about. */ metadata?: Array<{[key: string]: any}>; /** - * The output files. The blob referenced by the digest should contain one of - * the following (implementation-dependent): * A marshalled - * DirectoryMetadata of the returned filesystem * A LUCI-style .isolated - * file + * The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file */ outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** - * The amount of time *not* spent executing the command (ie - * uploading/downloading files). + * The amount of time *not* spent executing the command (ie uploading/downloading files). */ overhead?: string; /** - * An overall status for the command. For example, if the command timed out, - * this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS - * for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. + * An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. */ status?: Schema$GoogleRpcStatus; } /** - * Describes a shell-style task to execute, suitable for providing as the Bots - * interface's `Lease.payload` field. + * Describes a shell-style task to execute, suitable for providing as the Bots interface's `Lease.payload` field. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTask { /** @@ -1909,14 +1364,7 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs { /** - * The command itself to run (e.g., argv). This field should be passed - * directly to the underlying operating system, and so it must be sensible - * to that operating system. For example, on Windows, the first argument - * might be "C:\Windows\System32\ping.exe" - that is, using drive - * letters and backslashes. A command for a *nix system, on the other hand, - * would use forward slashes. All other fields in the RWAPI must - * consistently use forward slashes, since those fields may be interpretted - * by both the service and the bot. + * The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be "C:\Windows\System32\ping.exe" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpretted by both the service and the bot. */ arguments?: string[]; /** @@ -1924,28 +1372,15 @@ export namespace remotebuildexecution_v2 { */ environmentVariables?: Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable[]; /** - * The input filesystem to be set up prior to the task beginning. The - * contents should be a repeated set of FileMetadata messages though other - * formats are allowed if better for the implementation (eg, a LUCI-style - * .isolated file). This field is repeated since implementations might want - * to cache the metadata, in which case it may be useful to break up - * portions of the filesystem that change frequently (eg, specific input - * files) from those that don't (eg, standard header files). + * The input filesystem to be set up prior to the task beginning. The contents should be a repeated set of FileMetadata messages though other formats are allowed if better for the implementation (eg, a LUCI-style .isolated file). This field is repeated since implementations might want to cache the metadata, in which case it may be useful to break up portions of the filesystem that change frequently (eg, specific input files) from those that don't (eg, standard header files). */ files?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest[]; /** - * Inline contents for blobs expected to be needed by the bot to execute the - * task. For example, contents of entries in `files` or blobs that are - * indirectly referenced by an entry there. The bot should check against - * this list before downloading required task inputs to reduce the number of - * communications between itself and the remote CAS server. + * Inline contents for blobs expected to be needed by the bot to execute the task. For example, contents of entries in `files` or blobs that are indirectly referenced by an entry there. The bot should check against this list before downloading required task inputs to reduce the number of communications between itself and the remote CAS server. */ inlineBlobs?: Schema$GoogleDevtoolsRemoteworkersV1test2Blob[]; /** - * Directory from which a command is executed. It is a relative directory - * with respect to the bot's working directory (i.e., "./"). - * If it is non-empty, then it must exist under "./". Otherwise, - * "./" will be used. + * Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., "./"). If it is non-empty, then it must exist under "./". Otherwise, "./" will be used. */ workingDirectory?: string; } @@ -1967,29 +1402,19 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs { /** - * A list of expected directories, relative to the execution root. All paths - * MUST be delimited by forward slashes. + * A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes. */ directories?: string[]; /** - * A list of expected files, relative to the execution root. All paths MUST - * be delimited by forward slashes. + * A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes. */ files?: string[]; /** - * The destination to which any stderr should be sent. The method by which - * the bot should send the stream contents to that destination is not - * defined in this API. As examples, the destination could be a file - * referenced in the `files` field in this message, or it could be a URI - * that must be written via the ByteStream API. + * The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ stderrDestination?: string; /** - * The destination to which any stdout should be sent. The method by which - * the bot should send the stream contents to that destination is not - * defined in this API. As examples, the destination could be a file - * referenced in the `files` field in this message, or it could be a URI - * that must be written via the ByteStream API. + * The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API. */ stdoutDestination?: string; } @@ -1998,55 +1423,33 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts { /** - * This specifies the maximum time that the task can run, excluding the time - * required to download inputs or upload outputs. That is, the worker will - * terminate the task if it runs longer than this. + * This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this. */ execution?: string; /** - * This specifies the maximum amount of time the task can be idle - that is, - * go without generating some output in either stdout or stderr. If the - * process is silent for more than the specified time, the worker will - * terminate the task. + * This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task. */ idle?: string; /** - * If the execution or IO timeouts are exceeded, the worker will try to - * gracefully terminate the task and return any existing logs. However, - * tasks may be hard-frozen in which case this process will fail. This - * timeout specifies how long to wait for a terminated task to shut down - * gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. - * SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). + * If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). */ shutdown?: string; } /** - * The CommandTask and CommandResult messages assume the existence of a - * service that can serve blobs of content, identified by a hash and size - * known as a "digest." The method by which these blobs may be - * retrieved is not specified here, but a model implementation is in the - * Remote Execution API's "ContentAddressibleStorage" interface. - * In the context of the RWAPI, a Digest will virtually always refer to the - * contents of a file or a directory. The latter is represented by the - * byte-encoded Directory message. + * The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2Digest { /** - * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, - * 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). + * A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256). */ hash?: string; /** - * The size of the contents. While this is not strictly required as part of - * an identifier (after all, any given hash will have exactly one canonical - * size), it's useful in almost all cases when one might want to send or - * retrieve blobs of content and is included here for this reason. + * The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason. */ sizeBytes?: string; } /** - * The contents of a directory. Similar to the equivalent message in the - * Remote Execution API. + * The contents of a directory. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2Directory { /** @@ -2059,13 +1462,11 @@ export namespace remotebuildexecution_v2 { files?: Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata[]; } /** - * The metadata for a directory. Similar to the equivalent message in the - * Remote Execution API. + * The metadata for a directory. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata { /** - * A pointer to the contents of the directory, in the form of a marshalled - * Directory message. + * A pointer to the contents of the directory, in the form of a marshalled Directory message. */ digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** @@ -2074,18 +1475,15 @@ export namespace remotebuildexecution_v2 { path?: string; } /** - * The metadata for a file. Similar to the equivalent message in the Remote - * Execution API. + * The metadata for a file. Similar to the equivalent message in the Remote Execution API. */ export interface Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata { /** - * If the file is small enough, its contents may also or alternatively be - * listed here. + * If the file is small enough, its contents may also or alternatively be listed here. */ contents?: string; /** - * A pointer to the contents of the file. The method by which a client - * retrieves the contents from a CAS system is not defined here. + * A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here. */ digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest; /** @@ -2093,23 +1491,16 @@ export namespace remotebuildexecution_v2 { */ isExecutable?: boolean; /** - * The path of this file. If this message is part of the - * CommandOutputs.outputs fields, the path is relative to the execution root - * and must correspond to an entry in CommandTask.outputs.files. If this - * message is part of a Directory message, then the path is relative to the - * root of that directory. All paths MUST be delimited by forward slashes. + * The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes. */ path?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunningOperation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2117,64 +1508,20 @@ export namespace remotebuildexecution_v2 { */ error?: Schema$GoogleRpcStatus; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpcStatus { /** @@ -2182,14 +1529,11 @@ export namespace remotebuildexecution_v2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2202,8 +1546,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.actionResults.get - * @desc Retrieve a cached execution result. Errors: * `NOT_FOUND`: The - * requested `ActionResult` is not in the cache. + * @desc Retrieve a cached execution result. Errors: * `NOT_FOUND`: The requested `ActionResult` is not in the cache. * @alias remotebuildexecution.actionResults.get * @memberOf! () * @@ -2296,14 +1639,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.actionResults.update - * @desc Upload a new execution result. In order to allow the server to - * perform access control based on the type of action, and to assist with - * client debugging, the client MUST first upload the Action that produced - * the result, along with its Command, into the `ContentAddressableStorage`. - * Errors: * `INVALID_ARGUMENT`: One or more arguments are invalid. * - * `FAILED_PRECONDITION`: One or more errors occurred in updating the action - * result, such as a missing command or action. * `RESOURCE_EXHAUSTED`: - * There is insufficient storage space to add the entry to the cache. + * @desc Upload a new execution result. In order to allow the server to perform access control based on the type of action, and to assist with client debugging, the client MUST first upload the Action that produced the result, along with its Command, into the `ContentAddressableStorage`. Errors: * `INVALID_ARGUMENT`: One or more arguments are invalid. * `FAILED_PRECONDITION`: One or more errors occurred in updating the action result, such as a missing command or action. * `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the entry to the cache. * @alias remotebuildexecution.actionResults.update * @memberOf! () * @@ -2405,16 +1741,11 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; /** @@ -2430,26 +1761,15 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; /** - * The priority (relative importance) of this content in the overall cache. - * Generally, a lower value means a longer retention time or other - * advantage, but the interpretation of a given value is server-dependent. A - * priority of 0 means a *default* value, decided by the server. The - * particular semantics of this field is up to the server. In particular, - * every server will have their own supported range of priorities, and will - * decide how these map into retention/eviction policy. + * The priority (relative importance) of this content in the overall cache. Generally, a lower value means a longer retention time or other advantage, but the interpretation of a given value is server-dependent. A priority of 0 means a *default* value, decided by the server. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into retention/eviction policy. */ 'resultsCachePolicy.priority'?: number; /** @@ -2471,48 +1791,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.actions.execute - * @desc Execute an action remotely. In order to execute an action, the - * client must first upload all of the inputs, the Command to run, and the - * Action into the ContentAddressableStorage. It then calls `Execute` with - * an `action_digest` referring to them. The server will run the action and - * eventually return the result. The input `Action`'s fields MUST meet the - * various canonicalization requirements specified in the documentation for - * their types so that it has the same digest as other logically equivalent - * `Action`s. The server MAY enforce the requirements and return errors if a - * non-canonical input is received. It MAY also proceed without verifying - * some or all of the requirements, such as for performance reasons. If the - * server does not verify the requirement, then it will treat the `Action` - * as distinct from another logically equivalent action if they hash - * differently. Returns a stream of google.longrunning.Operation messages - * describing the resulting execution, with eventual `response` - * ExecuteResponse. The `metadata` on the operation is of type - * ExecuteOperationMetadata. If the client remains connected after the - * first response is returned after the server, then updates are streamed as - * if the client had called WaitExecution until the execution completes or - * the request reaches an error. The operation can also be queried using - * Operations API. The server NEED NOT implement other methods or - * functionality of the Operations API. Errors discovered during creation - * of the `Operation` will be reported as gRPC Status errors, while errors - * that occurred while running the action will be reported in the `status` - * field of the `ExecuteResponse`. The server MUST NOT set the `error` field - * of the `Operation` proto. The possible errors include: * - * `INVALID_ARGUMENT`: One or more arguments are invalid. * - * `FAILED_PRECONDITION`: One or more errors occurred in setting up the - * action requested, such as a missing input or command or no worker being - * available. The client may be able to fix the errors and retry. * - * `RESOURCE_EXHAUSTED`: There is insufficient quota of some resource to run - * the action. * `UNAVAILABLE`: Due to a transient condition, such as all - * workers being occupied (and the server does not support a queue), the - * action could not be started. The client should retry. * `INTERNAL`: An - * internal error occurred in the execution engine or the worker. * - * `DEADLINE_EXCEEDED`: The execution timed out. * `CANCELLED`: The - * operation was cancelled by the client. This status is only possible if - * the server implements the Operations API CancelOperation method, and it - * was called for the current execution. In the case of a missing input or - * command, the server SHOULD additionally send a PreconditionFailure error - * detail where, for each requested blob not present in the CAS, there is a - * `Violation` with a `type` of `MISSING` and a `subject` of - * `"blobs/{hash}/{size}"` indicating the digest of the missing blob. + * @desc Execute an action remotely. In order to execute an action, the client must first upload all of the inputs, the Command to run, and the Action into the ContentAddressableStorage. It then calls `Execute` with an `action_digest` referring to them. The server will run the action and eventually return the result. The input `Action`'s fields MUST meet the various canonicalization requirements specified in the documentation for their types so that it has the same digest as other logically equivalent `Action`s. The server MAY enforce the requirements and return errors if a non-canonical input is received. It MAY also proceed without verifying some or all of the requirements, such as for performance reasons. If the server does not verify the requirement, then it will treat the `Action` as distinct from another logically equivalent action if they hash differently. Returns a stream of google.longrunning.Operation messages describing the resulting execution, with eventual `response` ExecuteResponse. The `metadata` on the operation is of type ExecuteOperationMetadata. If the client remains connected after the first response is returned after the server, then updates are streamed as if the client had called WaitExecution until the execution completes or the request reaches an error. The operation can also be queried using Operations API. The server NEED NOT implement other methods or functionality of the Operations API. Errors discovered during creation of the `Operation` will be reported as gRPC Status errors, while errors that occurred while running the action will be reported in the `status` field of the `ExecuteResponse`. The server MUST NOT set the `error` field of the `Operation` proto. The possible errors include: * `INVALID_ARGUMENT`: One or more arguments are invalid. * `FAILED_PRECONDITION`: One or more errors occurred in setting up the action requested, such as a missing input or command or no worker being available. The client may be able to fix the errors and retry. * `RESOURCE_EXHAUSTED`: There is insufficient quota of some resource to run the action. * `UNAVAILABLE`: Due to a transient condition, such as all workers being occupied (and the server does not support a queue), the action could not be started. The client should retry. * `INTERNAL`: An internal error occurred in the execution engine or the worker. * `DEADLINE_EXCEEDED`: The execution timed out. * `CANCELLED`: The operation was cancelled by the client. This status is only possible if the server implements the Operations API CancelOperation method, and it was called for the current execution. In the case of a missing input or command, the server SHOULD additionally send a PreconditionFailure error detail where, for each requested blob not present in the CAS, there is a `Violation` with a `type` of `MISSING` and a `subject` of `"blobs/{hash}/{size}"` indicating the digest of the missing blob. * @alias remotebuildexecution.actions.execute * @memberOf! () * @@ -2600,11 +1879,7 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; @@ -2622,16 +1897,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.blobs.batchRead - * @desc Download many blobs at once. The server may enforce a limit of the - * combined total size of blobs to be downloaded using this API. This limit - * may be obtained using the Capabilities API. Requests exceeding the limit - * should either be split into smaller chunks or downloaded using the - * ByteStream API, as appropriate. This request is equivalent to calling a - * Bytestream `Read` request on each individual blob, in parallel. The - * requests may succeed or fail independently. Errors: * - * `INVALID_ARGUMENT`: The client attempted to read more than the server - * supported limit. Every error on individual read will be returned in the - * corresponding digest status. + * @desc Download many blobs at once. The server may enforce a limit of the combined total size of blobs to be downloaded using this API. This limit may be obtained using the Capabilities API. Requests exceeding the limit should either be split into smaller chunks or downloaded using the ByteStream API, as appropriate. This request is equivalent to calling a Bytestream `Read` request on each individual blob, in parallel. The requests may succeed or fail independently. Errors: * `INVALID_ARGUMENT`: The client attempted to read more than the server supported limit. Every error on individual read will be returned in the corresponding digest status. * @alias remotebuildexecution.blobs.batchRead * @memberOf! () * @@ -2730,18 +1996,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.blobs.batchUpdate - * @desc Upload many blobs at once. The server may enforce a limit of the - * combined total size of blobs to be uploaded using this API. This limit - * may be obtained using the Capabilities API. Requests exceeding the limit - * should either be split into smaller chunks or uploaded using the - * ByteStream API, as appropriate. This request is equivalent to calling a - * Bytestream `Write` request on each individual blob, in parallel. The - * requests may succeed or fail independently. Errors: * - * `INVALID_ARGUMENT`: The client attempted to upload more than the server - * supported limit. Individual requests may return the following errors, - * additionally: * `RESOURCE_EXHAUSTED`: There is insufficient disk quota - * to store the blob. * `INVALID_ARGUMENT`: The Digest does not match the - * provided data. + * @desc Upload many blobs at once. The server may enforce a limit of the combined total size of blobs to be uploaded using this API. This limit may be obtained using the Capabilities API. Requests exceeding the limit should either be split into smaller chunks or uploaded using the ByteStream API, as appropriate. This request is equivalent to calling a Bytestream `Write` request on each individual blob, in parallel. The requests may succeed or fail independently. Errors: * `INVALID_ARGUMENT`: The client attempted to upload more than the server supported limit. Individual requests may return the following errors, additionally: * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob. * `INVALID_ARGUMENT`: The Digest does not match the provided data. * @alias remotebuildexecution.blobs.batchUpdate * @memberOf! () * @@ -2843,10 +2098,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.blobs.findMissing - * @desc Determine if blobs are present in the CAS. Clients can use this - * API before uploading blobs to determine which ones are already present in - * the CAS and do not need to be uploaded again. There are no - * method-specific errors. + * @desc Determine if blobs are present in the CAS. Clients can use this API before uploading blobs to determine which ones are already present in the CAS and do not need to be uploaded again. There are no method-specific errors. * @alias remotebuildexecution.blobs.findMissing * @memberOf! () * @@ -2948,19 +2200,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.blobs.getTree - * @desc Fetch the entire directory tree rooted at a node. This request - * must be targeted at a Directory stored in the ContentAddressableStorage - * (CAS). The server will enumerate the `Directory` tree recursively and - * return every node descended from the root. The GetTreeRequest.page_token - * parameter can be used to skip ahead in the stream (e.g. when retrying a - * partially completed and aborted request), by setting it to a value taken - * from GetTreeResponse.next_page_token of the last successfully processed - * GetTreeResponse). The exact traversal order is unspecified and, unless - * retrieving subsequent pages from an earlier request, is not guaranteed to - * be stable across multiple invocations of `GetTree`. If part of the tree - * is missing from the CAS, the server will return the portion present and - * omit the rest. * `NOT_FOUND`: The requested tree root is not present in - * the CAS. + * @desc Fetch the entire directory tree rooted at a node. This request must be targeted at a Directory stored in the ContentAddressableStorage (CAS). The server will enumerate the `Directory` tree recursively and return every node descended from the root. The GetTreeRequest.page_token parameter can be used to skip ahead in the stream (e.g. when retrying a partially completed and aborted request), by setting it to a value taken from GetTreeResponse.next_page_token of the last successfully processed GetTreeResponse). The exact traversal order is unspecified and, unless retrieving subsequent pages from an earlier request, is not guaranteed to be stable across multiple invocations of `GetTree`. If part of the tree is missing from the CAS, the server will return the portion present and omit the rest. * `NOT_FOUND`: The requested tree root is not present in the CAS. * @alias remotebuildexecution.blobs.getTree * @memberOf! () * @@ -3066,11 +2306,7 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; @@ -3087,11 +2323,7 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; @@ -3108,11 +2340,7 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; @@ -3128,30 +2356,19 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hash. In the case of SHA-256, it will always be a lowercase hex - * string exactly 64 characters long. + * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; /** - * A maximum page size to request. If present, the server will request no - * more than this many items. Regardless of whether a page size is - * specified, the server may place its own limit on the number of items to - * be returned and require the client to retrieve more items using a - * subsequent request. + * A maximum page size to request. If present, the server will request no more than this many items. Regardless of whether a page size is specified, the server may place its own limit on the number of items to be returned and require the client to retrieve more items using a subsequent request. */ pageSize?: number; /** - * A page token, which must be a value received in a previous - * GetTreeResponse. If present, the server will use it to return the - * following page of results. + * A page token, which must be a value received in a previous GetTreeResponse. If present, the server will use it to return the following page of results. */ pageToken?: string; /** @@ -3168,13 +2385,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.operations.waitExecution - * @desc Wait for an execution operation to complete. When the client - * initially makes the request, the server immediately responds with the - * current status of the execution. The server will leave the request stream - * open until the operation completes, and then respond with the completed - * operation. The server MAY choose to stream additional updates as - * execution progresses, such as to provide an update as to the state of the - * execution. + * @desc Wait for an execution operation to complete. When the client initially makes the request, the server immediately responds with the current status of the execution. The server will leave the request stream open until the operation completes, and then respond with the completed operation. The server MAY choose to stream additional updates as execution progresses, such as to provide an update as to the state of the execution. * @alias remotebuildexecution.operations.waitExecution * @memberOf! () * @@ -3389,11 +2600,7 @@ export namespace remotebuildexecution_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance of the execution system to operate against. A server may - * support multiple instances of the execution system (with their own - * workers, storage, caches, etc.). The server MAY require use of this field - * to select between them in an implementation-defined fashion, otherwise it - * can be omitted. + * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ instanceName?: string; } diff --git a/src/apis/replicapool/package.json b/src/apis/replicapool/package.json index ab7763fd61f..80f505c6a94 100644 --- a/src/apis/replicapool/package.json +++ b/src/apis/replicapool/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/replicapool/v1beta1.ts b/src/apis/replicapool/v1beta1.ts index 1a28292791a..4d51cef1330 100644 --- a/src/apis/replicapool/v1beta1.ts +++ b/src/apis/replicapool/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace replicapool_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace replicapool_v1beta1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace replicapool_v1beta1 { /** * Replica Pool API * - * The Replica Pool API allows users to declaratively provision and manage - * groups of Google Compute Engine instances based on a common template. + * The Replica Pool API allows users to declaratively provision and manage groups of Google Compute Engine instances based on a common template. * * @example * const {google} = require('googleapis'); @@ -97,7 +93,10 @@ export namespace replicapool_v1beta1 { replicas: Resource$Replicas; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.pools = new Resource$Pools(this.context); this.replicas = new Resource$Replicas(this.context); @@ -105,8 +104,7 @@ export namespace replicapool_v1beta1 { } /** - * A Compute Engine network accessConfig. Identical to the accessConfig on - * corresponding Compute Engine resource. + * A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource. */ export interface Schema$AccessConfig { /** @@ -118,8 +116,7 @@ export namespace replicapool_v1beta1 { */ natIp?: string; /** - * Type of this access configuration file. Currently only ONE_TO_ONE_NAT is - * supported. + * Type of this access configuration file. Currently only ONE_TO_ONE_NAT is supported. */ type?: string; } @@ -128,9 +125,7 @@ export namespace replicapool_v1beta1 { */ export interface Schema$Action { /** - * A list of commands to run, one per line. If any command fails, the whole - * action is considered a failure and no further actions are run. This also - * marks the virtual machine or replica as a failure. + * A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure. */ commands?: string[]; /** @@ -138,11 +133,7 @@ export namespace replicapool_v1beta1 { */ envVariables?: Schema$EnvVariable[]; /** - * If an action's commands on a particular replica do not finish in the - * specified timeoutMilliSeconds, the replica is considered to be in a - * FAILING state. No efforts are made to stop any processes that were - * spawned or created as the result of running the action's commands. - * The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds). + * If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds). */ timeoutMilliSeconds?: number; } @@ -155,8 +146,7 @@ export namespace replicapool_v1beta1 { */ deviceName?: string; /** - * A zero-based index to assign to this disk, where 0 is reserved for the - * boot disk. If not specified, this is assigned by the server. + * A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server. */ index?: number; } @@ -178,8 +168,7 @@ export namespace replicapool_v1beta1 { value?: string; } /** - * A pre-existing persistent disk that will be attached to every Replica in - * the Pool in READ_ONLY mode. + * A pre-existing persistent disk that will be attached to every Replica in the Pool in READ_ONLY mode. */ export interface Schema$ExistingDisk { /** @@ -187,15 +176,13 @@ export namespace replicapool_v1beta1 { */ attachment?: Schema$DiskAttachment; /** - * The name of the Persistent Disk resource. The Persistent Disk resource - * must be in the same zone as the Pool. + * The name of the Persistent Disk resource. The Persistent Disk resource must be in the same zone as the Pool. */ source?: string; } export interface Schema$HealthCheck { /** - * How often (in seconds) to make HTTP requests for this healthcheck. The - * default value is 5 seconds. + * How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds. */ checkIntervalSec?: number; /** @@ -203,13 +190,11 @@ export namespace replicapool_v1beta1 { */ description?: string; /** - * The number of consecutive health check requests that need to succeed - * before the replica is considered healthy again. The default value is 2. + * The number of consecutive health check requests that need to succeed before the replica is considered healthy again. The default value is 2. */ healthyThreshold?: number; /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the localhost IP 127.0.0.1 will be used. + * The value of the host header in the HTTP health check request. If left empty (default value), the localhost IP 127.0.0.1 will be used. */ host?: string; /** @@ -217,8 +202,7 @@ export namespace replicapool_v1beta1 { */ name?: string; /** - * The localhost request path to send this health check, in the format - * /path/to/use. For example, /healthcheck. + * The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck. */ path?: string; /** @@ -226,13 +210,11 @@ export namespace replicapool_v1beta1 { */ port?: number; /** - * How long (in seconds) to wait before a timeout failure for this - * healthcheck. The default value is 5 seconds. + * How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds. */ timeoutSec?: number; /** - * The number of consecutive health check requests that need to fail in - * order to consider the replica unhealthy. The default value is 2. + * The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2. */ unhealthyThreshold?: number; } @@ -250,13 +232,11 @@ export namespace replicapool_v1beta1 { value?: string; } /** - * A Compute Engine metadata entry. Identical to the metadata on the - * corresponding Compute Engine resource. + * A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. */ export interface Schema$Metadata { /** - * The fingerprint of the metadata. Required for updating the metadata - * entries for this instance. + * The fingerprint of the metadata. Required for updating the metadata entries for this instance. */ fingerPrint?: string; /** @@ -265,8 +245,7 @@ export namespace replicapool_v1beta1 { items?: Schema$MetadataItem[]; } /** - * A Compute Engine metadata item, defined as a key:value pair. Identical to - * the metadata on the corresponding Compute Engine resource. + * A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource. */ export interface Schema$MetadataItem { /** @@ -279,13 +258,11 @@ export namespace replicapool_v1beta1 { value?: string; } /** - * A Compute Engine NetworkInterface resource. Identical to the - * NetworkInterface on the corresponding Compute Engine resource. + * A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource. */ export interface Schema$NetworkInterface { /** - * An array of configurations for this interface. This specifies how this - * interface is configured to interact with other network services. + * An array of configurations for this interface. This specifies how this interface is configured to interact with other network services. */ accessConfigs?: Schema$AccessConfig[]; /** @@ -293,15 +270,12 @@ export namespace replicapool_v1beta1 { */ network?: string; /** - * An optional IPV4 internal network address to assign to the instance for - * this network interface. + * An optional IPV4 internal network address to assign to the instance for this network interface. */ networkIp?: string; } /** - * A Persistent Disk resource that will be created and attached to each - * Replica in the Pool. Each Replica will have a unique persistent disk that - * is created and attached to that Replica in READ_WRITE mode. + * A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode. */ export interface Schema$NewDisk { /** @@ -309,8 +283,7 @@ export namespace replicapool_v1beta1 { */ attachment?: Schema$DiskAttachment; /** - * If true, then this disk will be deleted when the instance is deleted. The - * default value is true. + * If true, then this disk will be deleted when the instance is deleted. The default value is true. */ autoDelete?: boolean; /** @@ -318,8 +291,7 @@ export namespace replicapool_v1beta1 { */ boot?: boolean; /** - * Create the new disk using these parameters. The name of the disk will be - * <instance_name>-<four_random_charactersgt;. + * Create the new disk using these parameters. The name of the disk will be <instance_name>-<four_random_charactersgt;. */ initializeParams?: Schema$NewDiskInitializeParams; } @@ -332,36 +304,21 @@ export namespace replicapool_v1beta1 { */ diskSizeGb?: string; /** - * Name of the disk type resource describing which disk type to use to - * create the disk. For example 'pd-ssd' or 'pd-standard'. - * Default is 'pd-standard' + * Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard' */ diskType?: string; /** - * The name or fully-qualified URL of a source image to use to create this - * disk. If you provide a name of the source image, Replica Pool will look - * for an image with that name in your project. If you are specifying an - * image provided by Compute Engine, you will need to provide the full URL - * with the correct project, such as: - * http://www.googleapis.com/compute/v1/projects/debian-cloud/ - * global/images/debian-wheezy-7-vYYYYMMDD + * The name or fully-qualified URL of a source image to use to create this disk. If you provide a name of the source image, Replica Pool will look for an image with that name in your project. If you are specifying an image provided by Compute Engine, you will need to provide the full URL with the correct project, such as: http://www.googleapis.com/compute/v1/projects/debian-cloud/ global/images/debian-wheezy-7-vYYYYMMDD */ sourceImage?: string; } export interface Schema$Pool { /** - * Whether replicas in this pool should be restarted if they experience a - * failure. The default value is true. + * Whether replicas in this pool should be restarted if they experience a failure. The default value is true. */ autoRestart?: boolean; /** - * The base instance name to use for the replicas in this pool. This must - * match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances - * in this replica pool will be named in the format - * <base-instance-name>-<ID>. The <ID> postfix will be a - * four character alphanumeric identifier generated by the service. If this - * is not specified by the user, a random base instance name is generated by - * the service. + * The base instance name to use for the replicas in this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances in this replica pool will be named in the format <base-instance-name>-<ID>. The <ID> postfix will be a four character alphanumeric identifier generated by the service. If this is not specified by the user, a random base instance name is generated by the service. */ baseInstanceName?: string; /** @@ -377,18 +334,15 @@ export namespace replicapool_v1beta1 { */ healthChecks?: Schema$HealthCheck[]; /** - * The initial number of replicas this pool should have. You must provide a - * value greater than or equal to 0. + * The initial number of replicas this pool should have. You must provide a value greater than or equal to 0. */ initialNumReplicas?: number; /** - * A list of labels to attach to this replica pool and all created virtual - * machines in this replica pool. + * A list of labels to attach to this replica pool and all created virtual machines in this replica pool. */ labels?: Schema$Label[]; /** - * The name of the replica pool. Must follow the regex - * [a-z]([-a-z0-9]*[a-z0-9])? and be 1-28 characters long. + * The name of the replica pool. Must follow the regex [a-z]([-a-z0-9]*[a-z0-9])? and be 1-28 characters long. */ name?: string; /** @@ -396,8 +350,7 @@ export namespace replicapool_v1beta1 { */ numReplicas?: number; /** - * The list of resource views that should be updated with all the replicas - * that are managed by this pool. + * The list of resource views that should be updated with all the replicas that are managed by this pool. */ resourceViews?: string[]; /** @@ -409,18 +362,11 @@ export namespace replicapool_v1beta1 { */ targetPool?: string; /** - * A list of target pools to update with the replicas that are managed by - * this pool. If specified, the replicas in this replica pool will be added - * to the specified target pools for load balancing purposes. The replica - * pool must live in the same region as the specified target pools. These - * values must be the target pool resource names, and not fully qualified - * URLs. + * A list of target pools to update with the replicas that are managed by this pool. If specified, the replicas in this replica pool will be added to the specified target pools for load balancing purposes. The replica pool must live in the same region as the specified target pools. These values must be the target pool resource names, and not fully qualified URLs. */ targetPools?: string[]; /** - * The template to use when creating replicas in this pool. This template is - * used during initial instance creation of the pool, when growing the pool - * in size, or when a replica restarts. + * The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts. */ template?: Schema$Template; /** @@ -430,9 +376,7 @@ export namespace replicapool_v1beta1 { } export interface Schema$PoolsDeleteRequest { /** - * If there are instances you would like to keep, you can specify them here. - * These instances won't be deleted, but the associated replica objects - * will be removed. + * If there are instances you would like to keep, you can specify them here. These instances won't be deleted, but the associated replica objects will be removed. */ abandonInstances?: string[]; } @@ -441,9 +385,7 @@ export namespace replicapool_v1beta1 { resources?: Schema$Pool[]; } /** - * An individual Replica within a Pool. Replicas are automatically created by - * the replica pool, using the template provided by the user. You cannot - * directly create replicas. + * An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas. */ export interface Schema$Replica { /** @@ -461,10 +403,7 @@ export namespace replicapool_v1beta1 { } export interface Schema$ReplicasDeleteRequest { /** - * Whether the instance resource represented by this replica should be - * deleted or abandoned. If abandoned, the replica will be deleted but the - * virtual machine instance will remain. By default, this is set to false - * and the instance will be deleted along with the replica. + * Whether the instance resource represented by this replica should be deleted or abandoned. If abandoned, the replica will be deleted but the virtual machine instance will remain. By default, this is set to false and the instance will be deleted along with the replica. */ abandonInstance?: boolean; } @@ -477,8 +416,7 @@ export namespace replicapool_v1beta1 { */ export interface Schema$ReplicaStatus { /** - * [Output Only] Human-readable details about the current state of the - * replica + * [Output Only] Human-readable details about the current state of the replica */ details?: string; /** @@ -494,8 +432,7 @@ export namespace replicapool_v1beta1 { */ vmLink?: string; /** - * [Output Only] The time that this Replica got to the RUNNING state, in RFC - * 3339 format. If the start time is unknown, UNKNOWN is returned. + * [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned. */ vmStartTime?: string; } @@ -504,19 +441,16 @@ export namespace replicapool_v1beta1 { */ export interface Schema$ServiceAccount { /** - * The service account email address, for example: - * 123845678986@project.gserviceaccount.com + * The service account email address, for example: 123845678986@project.gserviceaccount.com */ email?: string; /** - * The list of OAuth2 scopes to obtain for the service account, for example: - * https://www.googleapis.com/auth/devstorage.full_control + * The list of OAuth2 scopes to obtain for the service account, for example: https://www.googleapis.com/auth/devstorage.full_control */ scopes?: string[]; } /** - * A Compute Engine Instance tag, identical to the tags on the corresponding - * Compute Engine Instance resource. + * A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. */ export interface Schema$Tag { /** @@ -533,33 +467,24 @@ export namespace replicapool_v1beta1 { */ export interface Schema$Template { /** - * An action to run during initialization of your replicas. An action is run - * as shell commands which are executed one after the other in the same bash - * shell, so any state established by one command is inherited by later - * commands. + * An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands. */ action?: Schema$Action; /** - * A list of HTTP Health Checks to configure for this replica pool and all - * virtual machines in this replica pool. + * A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool. */ healthChecks?: Schema$HealthCheck[]; /** - * A free-form string describing the version of this template. You can - * provide any versioning string you would like. For example, version1 or - * template-v1. + * A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1. */ version?: string; /** - * The virtual machine parameters to use for creating replicas. You can - * define settings such as the machine type and the image of replicas in - * this pool. This is required if replica type is SMART_VM. + * The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM. */ vmParams?: Schema$VmParams; } /** - * Parameters for creating a Compute Engine Instance resource. Most fields are - * identical to the corresponding Compute Engine resource. + * Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. */ export interface Schema$VmParams { /** @@ -567,9 +492,7 @@ export namespace replicapool_v1beta1 { */ baseInstanceName?: string; /** - * Enables IP Forwarding, which allows this instance to receive packets - * destined for a different IP address, and send packets with a different - * source IP. See IP Forwarding for more information. + * Enables IP Forwarding, which allows this instance to receive packets destined for a different IP address, and send packets with a different source IP. See IP Forwarding for more information. */ canIpForward?: boolean; /** @@ -577,20 +500,15 @@ export namespace replicapool_v1beta1 { */ description?: string; /** - * A list of existing Persistent Disk resources to attach to each replica in - * the pool. Each disk will be attached in read-only mode to every replica. + * A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica. */ disksToAttach?: Schema$ExistingDisk[]; /** - * A list of Disk resources to create and attach to each Replica in the - * Pool. Currently, you can only define one disk and it must be a root - * persistent disk. Note that Replica Pool will create a root persistent - * disk for each replica. + * A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica. */ disksToCreate?: Schema$NewDisk[]; /** - * The machine type for this instance. The resource name (e.g. - * n1-standard-1). + * The machine type for this instance. The resource name (e.g. n1-standard-1). */ machineType?: string; /** @@ -598,8 +516,7 @@ export namespace replicapool_v1beta1 { */ metadata?: Schema$Metadata; /** - * A list of network interfaces for the instance. Currently only one - * interface is supported by Google Compute Engine, ONE_TO_ONE_NAT. + * A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine, ONE_TO_ONE_NAT. */ networkInterfaces?: Schema$NetworkInterface[]; onHostMaintenance?: string; @@ -608,8 +525,7 @@ export namespace replicapool_v1beta1 { */ serviceAccounts?: Schema$ServiceAccount[]; /** - * A list of tags to apply to the Google Compute Engine instance to identify - * resources. + * A list of tags to apply to the Google Compute Engine instance to identify resources. */ tags?: Schema$Tag; } @@ -918,9 +834,7 @@ export namespace replicapool_v1beta1 { /** * replicapool.pools.resize - * @desc Resize a pool. This is an asynchronous operation, and multiple - * overlapping resize requests can be made. Replica Pools will use the - * information from the last resize request. + * @desc Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last resize request. * @alias replicapool.pools.resize * @memberOf! () * @@ -1138,13 +1052,11 @@ export namespace replicapool_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum count of results to be returned. Acceptable values are 0 to 100, - * inclusive. (Default: 50) + * Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50) */ maxResults?: number; /** - * Set this to the nextPageToken value returned by a previous list request - * to obtain the next page of results from the previous list request. + * Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request. */ pageToken?: string; /** @@ -1163,9 +1075,7 @@ export namespace replicapool_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The desired number of replicas to resize to. If this number is larger - * than the existing number of replicas, new replicas will be added. If the - * number is smaller, then existing replicas will be deleted. + * The desired number of replicas to resize to. If this number is larger than the existing number of replicas, new replicas will be added. If the number is smaller, then existing replicas will be deleted. */ numReplicas?: number; /** @@ -1574,13 +1484,11 @@ export namespace replicapool_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum count of results to be returned. Acceptable values are 0 to 100, - * inclusive. (Default: 50) + * Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50) */ maxResults?: number; /** - * Set this to the nextPageToken value returned by a previous list request - * to obtain the next page of results from the previous list request. + * Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request. */ pageToken?: string; /** diff --git a/src/apis/reseller/package.json b/src/apis/reseller/package.json index f7f1f5c0a16..78c10b6c698 100644 --- a/src/apis/reseller/package.json +++ b/src/apis/reseller/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index 990835c61e9..c42f6d38ccc 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace reseller_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace reseller_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -97,7 +94,10 @@ export namespace reseller_v1 { subscriptions: Resource$Subscriptions; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.customers = new Resource$Customers(this.context); this.resellernotify = new Resource$Resellernotify(this.context); @@ -110,8 +110,7 @@ export namespace reseller_v1 { */ export interface Schema$Address { /** - * A customer's physical address. An address can be composed of one to - * three lines. The addressline2 and addressLine3 are optional. + * A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. */ addressLine1?: string; /** @@ -127,9 +126,7 @@ export namespace reseller_v1 { */ contactName?: string; /** - * For countryCode information, see the ISO 3166 country code elements. - * Verify that country is approved for resale of Google products. This - * property is required when creating a new customer. + * For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer. */ countryCode?: string; /** @@ -145,8 +142,7 @@ export namespace reseller_v1 { */ organizationName?: string; /** - * A postalCode example is a postal zip code such as 94043. This property is - * required when creating a new customer. + * A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. */ postalCode?: string; /** @@ -159,41 +155,23 @@ export namespace reseller_v1 { */ export interface Schema$ChangePlanRequest { /** - * Google-issued code (100 char max) for discounted pricing on subscription - * plans. Deal code must be included in changePlan request in order to - * receive discounted rate. This property is optional. If a deal code has - * already been added to a subscription, this property may be left empty and - * the existing discounted rate will still apply (if not empty, only provide - * the deal code that is already present on the subscription). If a deal - * code has never been added to a subscription and this property is left - * blank, regular pricing will apply. + * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in changePlan request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply. */ dealCode?: string; /** - * Identifies the resource as a subscription change plan request. Value: - * subscriptions#changePlanRequest + * Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest */ kind?: string; /** - * The planName property is required. This is the name of the - * subscription's payment plan. For more information about the Google - * payment plans, see API concepts. Possible values are: - - * ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments - * Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - * - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments - - * FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan + * The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan */ planName?: string; /** - * This is an optional property. This purchase order (PO) information is for - * resellers to use for their company tracking usage. If a purchaseOrderId - * value is given it appears in the API responses and shows up in the - * invoice. The property accepts up to 80 plain text characters. + * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. */ purchaseOrderId?: string; /** - * This is a required property. The seats property is the number of user - * seat licenses. + * This is a required property. The seats property is the number of user seat licenses. */ seats?: Schema$Seats; } @@ -202,17 +180,11 @@ export namespace reseller_v1 { */ export interface Schema$Customer { /** - * Like the "Customer email" in the reseller tools, this email is - * the secondary contact used if something happens to the customer's - * service such as service outage or a security issue. This property is - * required when creating a new customer and should not use the same domain - * as customerDomain. + * Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain. */ alternateEmail?: string; /** - * The customer's primary domain name string. customerDomain is required - * when creating a new customer. Do not include the www prefix in the domain - * when adding a customer. + * The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer. */ customerDomain?: string; /** @@ -220,9 +192,7 @@ export namespace reseller_v1 { */ customerDomainVerified?: boolean; /** - * This property will always be returned in a response as the unique - * identifier generated by Google. In a request, this property can be either - * the primary domain or the unique identifier generated by Google. + * This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google. */ customerId?: string; /** @@ -230,22 +200,15 @@ export namespace reseller_v1 { */ kind?: string; /** - * Customer contact phone number. Must start with "+" followed by - * the country code. The rest of the number can be contiguous numbers or - * respect the phone local format conventions, but it must be a real phone - * number and not, for example, "123". This field is silently - * ignored if invalid. + * Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid. */ phoneNumber?: string; /** - * A customer's address information. Each field has a limit of 255 - * charcters. + * A customer's address information. Each field has a limit of 255 charcters. */ postalAddress?: Schema$Address; /** - * URL to customer's Admin console dashboard. The read-only URL is - * generated by the API service. This is used if your client application - * requires the customer to complete a task in the Admin console. + * URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console. */ resourceUiUrl?: string; } @@ -254,14 +217,11 @@ export namespace reseller_v1 { */ export interface Schema$RenewalSettings { /** - * Identifies the resource as a subscription renewal setting. Value: - * subscriptions#renewalSettings + * Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings */ kind?: string; /** - * Renewal settings for the annual commitment plan. For more detailed - * information, see renewal options in the administrator help center. When - * renewing a subscription, the renewalType is a required property. + * Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property. */ renewalType?: string; } @@ -292,35 +252,19 @@ export namespace reseller_v1 { */ export interface Schema$Seats { /** - * Identifies the resource as a subscription seat setting. Value: - * subscriptions#seats + * Identifies the resource as a subscription seat setting. Value: subscriptions#seats */ kind?: string; /** - * Read-only field containing the current number of users that are assigned - * a license for the product defined in skuId. This field's value is - * equivalent to the numerical count of users returned by the Enterprise - * License Manager API method: listForProductAndSku + * Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku */ licensedNumberOfSeats?: number; /** - * This is a required property and is exclusive to subscriptions with - * FLEXIBLE or TRIAL plans. This property sets the maximum number of - * licensed users allowed on a subscription. This quantity can be increased - * up to the maximum limit defined in the reseller's contract. The - * minimum quantity is the current number of users in the customer account. - * Note: G Suite subscriptions automatically assign a license to every user. + * This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user. */ maximumNumberOfSeats?: number; /** - * This is a required property and is exclusive to subscriptions with - * ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the - * maximum number of licenses assignable to users on a subscription. The - * reseller can add more licenses, but once set, the numberOfSeats cannot be - * reduced until renewal. The reseller is invoiced based on the - * numberOfSeats value regardless of how many of these user licenses are - * assigned. Note: G Suite subscriptions automatically assign a license to - * every user. + * This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user. */ numberOfSeats?: number; } @@ -329,14 +273,11 @@ export namespace reseller_v1 { */ export interface Schema$Subscription { /** - * Read-only field that returns the current billing method for a - * subscription. + * Read-only field that returns the current billing method for a subscription. */ billingMethod?: string; /** - * The creationTime property is the date when subscription was created. It - * is in milliseconds using the Epoch format. See an example Epoch - * converter. + * The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter. */ creationTime?: string; /** @@ -344,16 +285,11 @@ export namespace reseller_v1 { */ customerDomain?: string; /** - * This property will always be returned in a response as the unique - * identifier generated by Google. In a request, this property can be either - * the primary domain or the unique identifier generated by Google. + * This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google. */ customerId?: string; /** - * Google-issued code (100 char max) for discounted pricing on subscription - * plans. Deal code must be included in insert requests in order to receive - * discounted rate. This property is optional, regular pricing applies if - * left empty. + * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty. */ dealCode?: string; /** @@ -361,10 +297,7 @@ export namespace reseller_v1 { */ kind?: string; /** - * The plan property is required. In this version of the API, the G Suite - * plans are the flexible plan, annual commitment plan, and the 30-day free - * trial plan. For more information about the API"s payment plans, see - * the API concepts. + * The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts. */ plan?: { commitmentInterval?: {endTime?: string; startTime?: string}; @@ -372,41 +305,27 @@ export namespace reseller_v1 { planName?: string; }; /** - * This is an optional property. This purchase order (PO) information is for - * resellers to use for their company tracking usage. If a purchaseOrderId - * value is given it appears in the API responses and shows up in the - * invoice. The property accepts up to 80 plain text characters. + * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. */ purchaseOrderId?: string; /** - * Renewal settings for the annual commitment plan. For more detailed - * information, see renewal options in the administrator help center. + * Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. */ renewalSettings?: Schema$RenewalSettings; /** - * URL to customer's Subscriptions page in the Admin console. The - * read-only URL is generated by the API service. This is used if your - * client application requires the customer to complete a task using the - * Subscriptions page in the Admin console. + * URL to customer's Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console. */ resourceUiUrl?: string; /** - * This is a required property. The number and limit of user seat licenses - * in the plan. + * This is a required property. The number and limit of user seat licenses in the plan. */ seats?: Schema$Seats; /** - * A required property. The skuId is a unique system identifier for a - * product's SKU assigned to a customer in the subscription. For - * products and SKUs available in this version of the API, see Product and - * SKU IDs. + * A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs. */ skuId?: string; /** - * Read-only external display name for a product's SKU assigned to a - * customer in the subscription. SKU names are subject to change at - * Google's discretion. For products and SKUs available in this version - * of the API, see Product and SKU IDs. + * Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs. */ skuName?: string; /** @@ -414,39 +333,22 @@ export namespace reseller_v1 { */ status?: string; /** - * The subscriptionId is the subscription identifier and is unique for each - * customer. This is a required property. Since a subscriptionId changes - * when a subscription is updated, we recommend not using this ID as a key - * for persistent data. Use the subscriptionId as described in retrieve all - * reseller subscriptions. + * The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions. */ subscriptionId?: string; /** - * Read-only field containing an enumerable of all the current suspension - * reasons for a subscription. It is possible for a subscription to have - * many concurrent, overlapping suspension reasons. A subscription's - * STATUS is SUSPENDED until all pending suspensions are removed. Possible - * options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged - * in and accepted the G Suite Resold Terms of Services. - - * RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their - * service was cancelled at the end of their term. - RESELLER_INITIATED - - * A manual suspension invoked by a Reseller. - TRIAL_ENDED - The - * customer's trial expired without a plan selected. - OTHER - The - * customer is suspended for an internal Google reason (e.g. abuse or - * otherwise). + * Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. - RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED - The customer's trial expired without a plan selected. - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). */ suspensionReasons?: string[]; /** - * Read-only transfer related information for the subscription. For more - * information, see retrieve transferable subscriptions for a customer. + * Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer. */ transferInfo?: { minimumTransferableSeats?: number; transferabilityExpirationTime?: string; }; /** - * The G Suite annual commitment and flexible payment plans can be in a - * 30-day free trial. For more information, see the API concepts. + * The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts. */ trialSettings?: {isInTrial?: boolean; trialEndTime?: string}; } @@ -455,13 +357,11 @@ export namespace reseller_v1 { */ export interface Schema$Subscriptions { /** - * Identifies the resource as a collection of subscriptions. Value: - * reseller#subscriptions + * Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -621,8 +521,7 @@ export namespace reseller_v1 { /** * reseller.customers.patch - * @desc Update a customer account's settings. This method supports patch - * semantics. + * @desc Update a customer account's settings. This method supports patch semantics. * @alias reseller.customers.patch * @memberOf! () * @@ -772,10 +671,7 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; } @@ -786,12 +682,7 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The customerAuthToken query string is required when creating a resold - * account that transfers a direct customer's subscription or transfers - * another reseller customer's subscription to your reseller management. - * This is a hexadecimal authentication token needed to complete the - * subscription transfer. For more information, see the administrator help - * center. + * The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center. */ customerAuthToken?: string; @@ -807,10 +698,7 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; @@ -826,10 +714,7 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; @@ -1204,9 +1089,7 @@ export namespace reseller_v1 { /** * reseller.subscriptions.changePlan - * @desc Update a subscription plan. Use this method to update a plan for a - * 30-day trial or a flexible plan subscription to an annual commitment plan - * with monthly or yearly payments. + * @desc Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. * @alias reseller.subscriptions.changePlan * @memberOf! () * @@ -1282,8 +1165,7 @@ export namespace reseller_v1 { /** * reseller.subscriptions.changeRenewalSettings - * @desc Update a user license's renewal settings. This is applicable for - * accounts with annual commitment plans only. + * @desc Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. * @alias reseller.subscriptions.changeRenewalSettings * @memberOf! () * @@ -1661,9 +1543,7 @@ export namespace reseller_v1 { /** * reseller.subscriptions.list - * @desc List of subscriptions managed by the reseller. The list can be all - * subscriptions, all of a customer's subscriptions, or all of a customer's - * transferable subscriptions. + * @desc List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. * @alias reseller.subscriptions.list * @memberOf! () * @@ -1741,8 +1621,7 @@ export namespace reseller_v1 { /** * reseller.subscriptions.startPaidService - * @desc Immediately move a 30-day free trial subscription to a paid service - * subscription. + * @desc Immediately move a 30-day free trial subscription to a paid service subscription. * @alias reseller.subscriptions.startPaidService * @memberOf! () * @@ -1899,18 +1778,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } @@ -1922,18 +1794,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; @@ -1950,18 +1815,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; @@ -1978,18 +1836,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; @@ -2006,23 +1857,15 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * The deletionType query string enables the cancellation, downgrade, or - * suspension of a subscription. + * The deletionType query string enables the cancellation, downgrade, or suspension of a subscription. */ deletionType?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } @@ -2034,18 +1877,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } @@ -2057,19 +1893,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The customerAuthToken query string is required when creating a resold - * account that transfers a direct customer's subscription or transfers - * another reseller customer's subscription to your reseller management. - * This is a hexadecimal authentication token needed to complete the - * subscription transfer. For more information, see the administrator help - * center. + * The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center. */ customerAuthToken?: string; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; @@ -2086,35 +1914,19 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The customerAuthToken query string is required when creating a resold - * account that transfers a direct customer's subscription or transfers - * another reseller customer's subscription to your reseller management. - * This is a hexadecimal authentication token needed to complete the - * subscription transfer. For more information, see the administrator help - * center. + * The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center. */ customerAuthToken?: string; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * When retrieving all of your subscriptions and filtering for specific - * customers, you can enter a prefix for a customer name. Using an example - * customer group that includes exam.com, example20.com and example.com: - - * exa -- Returns all customer names that start with 'exa' which could - * include exam.com, example20.com, and example.com. A name prefix is - * similar to using a regular expression's asterisk, exa*. - example -- - * Returns example20.com and example.com. + * When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com. */ customerNamePrefix?: string; /** - * When retrieving a large list, the maxResults is the maximum number of - * results per page. The nextPageToken value takes you to the next page. The - * default is 20. + * When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20. */ maxResults?: number; /** @@ -2130,18 +1942,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } @@ -2153,18 +1958,11 @@ export namespace reseller_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Either the customer's primary domain name or the customer's unique - * identifier. If using the domain name, we do not recommend using a - * customerId as a key for persistent data. If the domain name for a - * customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription - * identifier and is unique for each customer. Since a subscriptionId - * changes when a subscription is updated, we recommend to not use this ID - * as a key for persistent data. And the subscriptionId can be found using - * the retrieve all reseller subscriptions method. + * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } diff --git a/src/apis/run/package.json b/src/apis/run/package.json index 60f18d8c324..c48136a6cc0 100644 --- a/src/apis/run/package.json +++ b/src/apis/run/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 1e218eeaab7..c7e0b5b06f6 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace run_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace run_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace run_v1 { /** * Cloud Run API * - * Deploy and manage user provided container images that scale automatically - * based on HTTP traffic. + * Deploy and manage user provided container images that scale automatically based on HTTP traffic. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace run_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -124,13 +122,11 @@ export namespace run_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -138,13 +134,11 @@ export namespace run_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index a4bf52aa358..76aac180100 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace run_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace run_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace run_v1alpha1 { /** * Cloud Run API * - * Deploy and manage user provided container images that scale automatically - * based on HTTP traffic. + * Deploy and manage user provided container images that scale automatically based on HTTP traffic. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace run_v1alpha1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.namespaces = new Resource$Namespaces(this.context); this.projects = new Resource$Projects(this.context); @@ -128,27 +126,7 @@ export namespace run_v1alpha1 { hostname?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -156,25 +134,16 @@ export namespace run_v1alpha1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -183,9 +152,7 @@ export namespace run_v1alpha1 { logType?: string; } /** - * A domain that a user has been authorized to administer. To authorize use of - * a domain, verify ownership via [Webmaster - * Central](https://www.google.com/webmasters/verification/home). + * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via [Webmaster Central](https://www.google.com/webmasters/verification/home). */ export interface Schema$AuthorizedDomain { /** @@ -193,8 +160,7 @@ export namespace run_v1alpha1 { */ id?: string; /** - * Read only. Full path to the `AuthorizedDomain` resource in the API. - * Example: `apps/myapp/authorizedDomains/example.com`. + * Read only. Full path to the `AuthorizedDomain` resource in the API. Example: `apps/myapp/authorizedDomains/example.com`. */ name?: string; } @@ -203,30 +169,15 @@ export namespace run_v1alpha1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -244,9 +195,7 @@ export namespace run_v1alpha1 { drop?: string[]; } /** - * ConfigMapEnvSource selects a ConfigMap to populate the environment - * variables with. The contents of the target ConfigMap's Data field will - * represent the key-value pairs as environment variables. + * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ export interface Schema$ConfigMapEnvSource { /** @@ -259,12 +208,7 @@ export namespace run_v1alpha1 { optional?: boolean; } /** - * Configuration represents the "floating HEAD" of a linear history - * of Revisions, and optionally how the containers those revisions reference - * are built. Users create new Revisions by updating the Configuration's - * spec. The "latest created" revision's name is available under - * status, as is the "latest ready" revision's name. See also: - * https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration + * Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration */ export interface Schema$Configuration { /** @@ -276,8 +220,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * Metadata associated with this Configuration, including name, namespace, - * labels, and annotations. + * Metadata associated with this Configuration, including name, namespace, labels, and annotations. */ metadata?: Schema$ObjectMeta; /** @@ -285,8 +228,7 @@ export namespace run_v1alpha1 { */ spec?: Schema$ConfigurationSpec; /** - * Status communicates the observed state of the Configuration (from the - * controller). + * Status communicates the observed state of the Configuration (from the controller). */ status?: Schema$ConfigurationStatus; } @@ -295,18 +237,15 @@ export namespace run_v1alpha1 { */ export interface Schema$ConfigurationCondition { /** - * Last time the condition transitioned from one status to another. - * +optional + * Last time the condition transitioned from one status to another. +optional */ lastTransitionTime?: string; /** - * Human-readable message indicating details about last transition. - * +optional + * Human-readable message indicating details about last transition. +optional */ message?: string; /** - * One-word CamelCase reason for the condition's last transition. - * +optional + * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; /** @@ -314,232 +253,134 @@ export namespace run_v1alpha1 { */ status?: string; /** - * ConfigurationConditionType is used to communicate the status of the - * reconciliation process. See also: - * https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting - * Types include:"Ready" + * ConfigurationConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include:"Ready" */ type?: string; } /** - * ConfigurationSpec holds the desired state of the Configuration (from the - * client). + * ConfigurationSpec holds the desired state of the Configuration (from the client). */ export interface Schema$ConfigurationSpec { /** - * Deprecated and not currently populated by Cloud Run. See - * metadata.generation instead, which is the sequence number containing the - * latest generation of the desired state. Read-only. + * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ generation?: number; /** - * RevisionTemplate holds the latest specification for the Revision to be - * stamped out. The template references the container image, and may also - * include labels and annotations that should be attached to the Revision. - * To correlate a Revision, and/or to force a Revision to be created when - * the spec doesn't otherwise change, a nonce label may be provided in - * the template metadata. For more details, see: - * https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions - * Cloud Run does not currently support referencing a build that is - * responsible for materializing the container image from source. + * RevisionTemplate holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn't otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. */ revisionTemplate?: Schema$RevisionTemplate; + /** + * Template holds the latest specification for the Revision to be stamped out. Not currently supported by Cloud Run. + */ + template?: Schema$RevisionTemplate; } /** - * ConfigurationStatus communicates the observed state of the Configuration - * (from the controller). + * ConfigurationStatus communicates the observed state of the Configuration (from the controller). */ export interface Schema$ConfigurationStatus { /** - * Conditions communicates information about ongoing/complete reconciliation - * processes that bring the "spec" inline with the observed state - * of the world. + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. */ conditions?: Schema$ConfigurationCondition[]; /** - * LatestCreatedRevisionName is the last revision that was created from this - * Configuration. It might not be ready yet, for that use - * LatestReadyRevisionName. + * LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, for that use LatestReadyRevisionName. */ latestCreatedRevisionName?: string; /** - * LatestReadyRevisionName holds the name of the latest Revision stamped out - * from this Configuration that has had its "Ready" condition - * become "True". + * LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True". */ latestReadyRevisionName?: string; /** - * ObservedGeneration is the 'Generation' of the Configuration that - * was last processed by the controller. The observed generation is updated - * even if the controller failed to process the spec and create the - * Revision. Clients polling for completed reconciliation should poll until - * observedGeneration = metadata.generation, and the Ready condition's - * status is True or False. + * ObservedGeneration is the 'Generation' of the Configuration that was last processed by the controller. The observed generation is updated even if the controller failed to process the spec and create the Revision. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False. */ observedGeneration?: number; } /** - * A single application container. This specifies both the container to run, - * the command to run in the container and the arguments to supply to it. Note - * that additional arguments may be supplied by the system to the container at - * runtime. + * A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. */ export interface Schema$Container { /** - * Arguments to the entrypoint. The docker image's CMD is used if this - * is not provided. Variable references $(VAR_NAME) are expanded using the - * container's environment. If a variable cannot be resolved, the - * reference in the input string will be unchanged. The $(VAR_NAME) syntax - * can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references - * will never be expanded, regardless of whether the variable exists or not. - * Cannot be updated. More info: - * https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - * +optional + * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional */ args?: string[]; /** - * Entrypoint array. Not executed within a shell. The docker image's - * ENTRYPOINT is used if this is not provided. Variable references - * $(VAR_NAME) are expanded using the container's environment. If a - * variable cannot be resolved, the reference in the input string will be - * unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: - * $$(VAR_NAME). Escaped references will never be expanded, regardless of - * whether the variable exists or not. Cannot be updated. More info: - * https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - * +optional + * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional */ command?: string[]; /** - * List of environment variables to set in the container. Cannot be updated. - * +optional + * List of environment variables to set in the container. Cannot be updated. +optional */ env?: Schema$EnvVar[]; /** - * List of sources to populate environment variables in the container. The - * keys defined within a source must be a C_IDENTIFIER. All invalid keys - * will be reported as an event when the container is starting. When a key - * exists in multiple sources, the value associated with the last source - * will take precedence. Values defined by an Env with a duplicate key will - * take precedence. Cannot be updated. +optional + * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional */ envFrom?: Schema$EnvFromSource[]; /** - * Docker image name. More info: - * https://kubernetes.io/docs/concepts/containers/images + * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images */ image?: string; /** - * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always - * if :latest tag is specified, or IfNotPresent otherwise. Cannot be - * updated. More info: - * https://kubernetes.io/docs/concepts/containers/images#updating-images - * +optional + * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images +optional */ imagePullPolicy?: string; /** - * Actions that the management system should take in response to container - * lifecycle events. Cannot be updated. +optional + * Actions that the management system should take in response to container lifecycle events. Cannot be updated. +optional */ lifecycle?: Schema$Lifecycle; /** - * Periodic probe of container liveness. Container will be restarted if the - * probe fails. Cannot be updated. More info: - * https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * +optional + * Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ livenessProbe?: Schema$Probe; /** - * Name of the container specified as a DNS_LABEL. Each container must have - * a unique name (DNS_LABEL). Cannot be updated. + * Name of the container specified as a DNS_LABEL. Each container must have a unique name (DNS_LABEL). Cannot be updated. */ name?: string; /** - * List of ports to expose from the container. Exposing a port here gives - * the system additional information about the network connections a - * container uses, but is primarily informational. Not specifying a port - * here DOES NOT prevent that port from being exposed. Any port which is - * listening on the default "0.0.0.0" address inside a container - * will be accessible from the network. Cannot be updated. +optional + * List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +optional */ ports?: Schema$ContainerPort[]; /** - * Periodic probe of container service readiness. Container will be removed - * from service endpoints if the probe fails. Cannot be updated. More info: - * https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * +optional + * Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ readinessProbe?: Schema$Probe; /** - * Compute Resources required by this container. Cannot be updated. More - * info: - * https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources - * +optional + * Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources +optional */ resources?: Schema$ResourceRequirements; /** - * Security options the pod should run with. More info: - * https://kubernetes.io/docs/concepts/policy/security-context/ More info: - * https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - * +optional + * Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +optional */ securityContext?: Schema$SecurityContext; /** - * Whether this container should allocate a buffer for stdin in the - * container runtime. If this is not set, reads from stdin in the container - * will always result in EOF. Default is false. +optional + * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional */ stdin?: boolean; /** - * Whether the container runtime should close the stdin channel after it has - * been opened by a single attach. When stdin is true the stdin stream will - * remain open across multiple attach sessions. If stdinOnce is set to true, - * stdin is opened on container start, is empty until the first client - * attaches to stdin, and then remains open and accepts data until the - * client disconnects, at which time stdin is closed and remains closed - * until the container is restarted. If this flag is false, a container - * processes that reads from stdin will never receive an EOF. Default is - * false +optional + * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional */ stdinOnce?: boolean; /** - * Optional: Path at which the file to which the container's termination - * message will be written is mounted into the container's filesystem. - * Message written is intended to be brief final status, such as an - * assertion failure message. Will be truncated by the node if greater than - * 4096 bytes. The total message length across all containers will be - * limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. - * +optional + * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional */ terminationMessagePath?: string; /** - * Indicate how the termination message should be populated. File will use - * the contents of terminationMessagePath to populate the container status - * message on both success and failure. FallbackToLogsOnError will use the - * last chunk of container log output if the termination message file is - * empty and the container exited with an error. The log output is limited - * to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot - * be updated. +optional + * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. +optional */ terminationMessagePolicy?: string; /** - * Whether this container should allocate a TTY for itself, also requires - * 'stdin' to be true. Default is false. +optional + * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional */ tty?: boolean; /** - * volumeDevices is the list of block devices to be used by the container. - * This is an alpha feature and may change in the future. +optional + * volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future. +optional */ volumeDevices?: Schema$VolumeDevice[]; /** - * Pod volumes to mount into the container's filesystem. Cannot be - * updated. +optional + * Pod volumes to mount into the container's filesystem. Cannot be updated. +optional */ volumeMounts?: Schema$VolumeMount[]; /** - * Container's working directory. If not specified, the container - * runtime's default will be used, which might be configured in the - * container image. Cannot be updated. +optional + * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional */ workingDir?: string; } @@ -548,8 +389,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ContainerPort { /** - * Number of port to expose on the pod's IP address. This must be a - * valid port number, 0 < x < 65536. + * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. */ containerPort?: number; /** @@ -557,20 +397,15 @@ export namespace run_v1alpha1 { */ hostIP?: string; /** - * Number of port to expose on the host. If specified, this must be a valid - * port number, 0 < x < 65536. If HostNetwork is specified, this must - * match ContainerPort. Most containers do not need this. +optional + * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional */ hostPort?: number; /** - * If specified, this must be an IANA_SVC_NAME and unique within the pod. - * Each named port in a pod must have a unique name. Name for the port that - * can be referred to by services. +optional + * If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional */ name?: string; /** - * Protocol for port. Must be UDP or TCP. Defaults to "TCP". - * +optional + * Protocol for port. Must be UDP or TCP. Defaults to "TCP". +optional */ protocol?: string; } @@ -604,13 +439,11 @@ export namespace run_v1alpha1 { */ export interface Schema$DomainMappingCondition { /** - * Human readable message indicating details about the current status. - * +optional + * Human readable message indicating details about the current status. +optional */ message?: string; /** - * One-word CamelCase reason for the condition's current status. - * +optional + * One-word CamelCase reason for the condition's current status. +optional */ reason?: string; /** @@ -631,15 +464,11 @@ export namespace run_v1alpha1 { */ certificateMode?: string; /** - * If set, the mapping will override any mapping set before this spec was - * set. It is recommended that the user leaves this empty to receive an - * error warning about a potential conflict and only set it once the - * respective UI has given such a warning. + * If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning. */ forceOverride?: boolean; /** - * The name of the Knative Route that this DomainMapping applies to. The - * route must exist. + * The name of the Knative Route that this DomainMapping applies to. The route must exist. */ routeName?: string; } @@ -648,8 +477,7 @@ export namespace run_v1alpha1 { */ export interface Schema$DomainMappingStatus { /** - * Array of observed DomainMappingConditions, indicating the current state - * of the DomainMapping. + * Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. */ conditions?: Schema$DomainMappingCondition[]; /** @@ -657,25 +485,16 @@ export namespace run_v1alpha1 { */ mappedRouteName?: string; /** - * ObservedGeneration is the 'Generation' of the DomainMapping that - * was last processed by the controller. Clients polling for completed - * reconciliation should poll until observedGeneration = metadata.generation - * and the Ready condition's status is True or False. + * ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. */ observedGeneration?: number; /** - * The resource records required to configure this domain mapping. These - * records must be added to the domain's DNS configuration in order to - * serve the application via this domain mapping. + * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. */ resourceRecords?: Schema$ResourceRecord[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -687,8 +506,7 @@ export namespace run_v1alpha1 { */ configMapRef?: Schema$ConfigMapEnvSource; /** - * An optional identifier to prepend to each key in the ConfigMap. Must be a - * C_IDENTIFIER. +optional + * An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. +optional */ prefix?: string; /** @@ -705,13 +523,7 @@ export namespace run_v1alpha1 { */ name?: string; /** - * Variable references $(VAR_NAME) are expanded using the previous defined - * environment variables in the container and any route environment - * variables. If a variable cannot be resolved, the reference in the input - * string will be unchanged. The $(VAR_NAME) syntax can be escaped with a - * double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, - * regardless of whether the variable exists or not. Defaults to - * "". +optional + * Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional */ value?: string; } @@ -720,42 +532,28 @@ export namespace run_v1alpha1 { */ export interface Schema$ExecAction { /** - * Command is the command line to execute inside the container, the working - * directory for the command is root ('/') in the container's - * filesystem. The command is simply exec'd, it is not run inside a - * shell, so traditional shell instructions ('|', etc) won't - * work. To use a shell, you need to explicitly call out to that shell. Exit - * status of 0 is treated as live/healthy and non-zero is unhealthy. - * +optional + * Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional */ command?: string; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -764,8 +562,7 @@ export namespace run_v1alpha1 { */ export interface Schema$Handler { /** - * One and only one of the following should be specified. Exec specifies the - * action to take. +optional + * One and only one of the following should be specified. Exec specifies the action to take. +optional */ exec?: Schema$ExecAction; /** @@ -773,8 +570,7 @@ export namespace run_v1alpha1 { */ httpGet?: Schema$HTTPGetAction; /** - * TCPSocket specifies an action involving a TCP port. TCP hooks not yet - * supported + * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported */ tcpSocket?: Schema$TCPSocketAction; } @@ -783,13 +579,11 @@ export namespace run_v1alpha1 { */ export interface Schema$HTTPGetAction { /** - * Host name to connect to, defaults to the pod IP. You probably want to set - * "Host" in httpHeaders instead. +optional + * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional */ host?: string; /** - * Custom headers to set in the request. HTTP allows repeated headers. - * +optional + * Custom headers to set in the request. HTTP allows repeated headers. +optional */ httpHeaders?: Schema$HTTPHeader[]; /** @@ -797,8 +591,7 @@ export namespace run_v1alpha1 { */ path?: string; /** - * Name or number of the port to access on the container. Number must be in - * the range 1 to 65535. Name must be an IANA_SVC_NAME. + * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port?: Schema$IntOrString; /** @@ -833,19 +626,12 @@ export namespace run_v1alpha1 { */ export interface Schema$Initializers { /** - * Pending is a list of initializers that must execute in order before this - * object is visible. When the last pending initializer is removed, and no - * failing result is set, the initializers struct will be set to nil and the - * object is considered as initialized and visible to all clients. - * +patchMergeKey=name +patchStrategy=merge + * Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients. +patchMergeKey=name +patchStrategy=merge */ pending?: Schema$Initializer[]; } /** - * IntOrString is a type that can hold an int32 or a string. When used in - * JSON or YAML marshalling and unmarshalling, it produces or consumes the - * inner type. This allows you to have, for example, a JSON field that can - * accept a name or number. + * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. */ export interface Schema$IntOrString { /** @@ -862,30 +648,15 @@ export namespace run_v1alpha1 { type?: string; } /** - * Lifecycle describes actions that the management system should take in - * response to container lifecycle events. For the PostStart and PreStop - * lifecycle handlers, management of the container blocks until the action is - * complete, unless the container process fails, in which case the handler is - * aborted. + * Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ export interface Schema$Lifecycle { /** - * PostStart is called immediately after a container is created. If the - * handler fails, the container is terminated and restarted according to its - * restart policy. Other management of the container blocks until the hook - * completes. More info: - * https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - * +optional + * PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks +optional */ postStart?: Schema$Handler; /** - * PreStop is called immediately before a container is terminated. The - * container is terminated after the handler completes. The reason for - * termination is passed to the handler. Regardless of the outcome of the - * handler, the container is eventually terminated. Other management of the - * container blocks until the hook completes. More info: - * https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - * +optional + * PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks +optional */ preStop?: Schema$Handler; } @@ -962,34 +733,19 @@ export namespace run_v1alpha1 { nextPageToken?: string; } /** - * ListMeta describes metadata that synthetic resources must have, including - * lists and various status objects. A resource may have only one of - * {ObjectMeta, ListMeta}. + * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. */ export interface Schema$ListMeta { /** - * continue may be set if the user set a limit on the number of items - * returned, and indicates that the server has more data available. The - * value is opaque and may be used to issue another request to the endpoint - * that served this list to retrieve the next set of available objects. - * Continuing a list may not be possible if the server configuration has - * changed or more than a few minutes have passed. The resourceVersion field - * returned when using this continue value will be identical to the value in - * the first response. + * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. */ continue?: string; /** - * String that identifies the server's internal version of this object - * that can be used by clients to determine when objects have changed. Value - * must be treated as opaque by clients and passed unmodified back to the - * server. Populated by the system. Read-only. More info: - * https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency - * +optional + * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional */ resourceVersion?: string; /** - * SelfLink is a URL representing this object. Populated by the system. - * Read-only. +optional + * SelfLink is a URL representing this object. Populated by the system. Read-only. +optional */ selfLink?: string; } @@ -1069,13 +825,36 @@ export namespace run_v1alpha1 { unreachable?: string[]; } /** - * LocalObjectReference contains enough information to let you locate the - * referenced object inside the same namespace. + * ListTriggersResponse is a list of Trigger resources. + */ + export interface Schema$ListTriggersResponse { + /** + * The API version for this call such as "v1alpha1". + */ + apiVersion?: string; + /** + * List of Triggers. + */ + items?: Schema$Trigger[]; + /** + * The kind of this resource, in this case "TriggerList". + */ + kind?: string; + /** + * Metadata associated with this Trigger list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[]; + } + /** + * LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ export interface Schema$LocalObjectReference { /** - * Name of the referent. More info: - * https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; } @@ -1084,13 +863,11 @@ export namespace run_v1alpha1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -1098,178 +875,118 @@ export namespace run_v1alpha1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** - * ObjectMeta is metadata that all persisted resources must have, which - * includes all objects users must create. + * ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. */ export interface Schema$ObjectMeta { /** - * Annotations is an unstructured key value map stored with a resource that - * may be set by external tools to store and retrieve arbitrary metadata. - * They are not queryable and should be preserved when modifying objects. - * More info: http://kubernetes.io/docs/user-guide/annotations +optional + * Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional */ annotations?: {[key: string]: string}; /** - * Not currently supported by Cloud Run. The name of the cluster which the - * object belongs to. This is used to distinguish resources with same name - * and namespace in different clusters. This field is not set anywhere right - * now and apiserver is going to ignore it if set in create or update - * request. +optional + * Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional */ clusterName?: string; /** - * CreationTimestamp is a timestamp representing the server time when this - * object was created. It is not guaranteed to be set in happens-before - * order across separate operations. Clients may not set this value. It is - * represented in RFC3339 form and is in UTC. Populated by the system. - * Read-only. Null for lists. More info: - * https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - * +optional + * CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional */ creationTimestamp?: string; /** - * Not currently supported by Cloud Run. Number of seconds allowed for this - * object to gracefully terminate before it will be removed from the system. - * Only set when deletionTimestamp is also set. May only be shortened. - * Read-only. +optional + * Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional */ deletionGracePeriodSeconds?: number; /** - * DeletionTimestamp is RFC 3339 date and time at which this resource will - * be deleted. This field is set by the server when a graceful deletion is - * requested by the user, and is not directly settable by a client. The - * resource is expected to be deleted (no longer visible from resource - * lists, and not reachable by name) after the time in this field, once the - * finalizers list is empty. As long as the finalizers list contains items, - * deletion is blocked. Once the deletionTimestamp is set, this value may - * not be unset or be set further into the future, although it may be - * shortened or the resource may be deleted prior to this time. For example, - * a user may request that a pod is deleted in 30 seconds. The Kubelet will - * react by sending a graceful termination signal to the containers in the - * pod. After that 30 seconds, the Kubelet will send a hard termination - * signal (SIGKILL) to the container and after cleanup, remove the pod from - * the API. In the presence of network partitions, this object may still - * exist after this timestamp, until an administrator or automated process - * can determine the resource is fully terminated. If not set, graceful - * deletion of the object has not been requested. Populated by the system - * when a graceful deletion is requested. Read-only. More info: - * https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - * +optional + * DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional */ deletionTimestamp?: string; /** - * Not currently supported by Cloud Run. Must be empty before the object is - * deleted from the registry. Each entry is an identifier for the - * responsible component that will remove the entry from the list. If the - * deletionTimestamp of the object is non-nil, entries in this list can only - * be removed. +optional +patchStrategy=merge + * Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge */ finalizers?: string[]; /** - * Not currently supported by Cloud Run. GenerateName is an optional - * prefix, used by the server, to generate a unique name ONLY IF the Name - * field has not been provided. If this field is used, the name returned to - * the client will be different than the name passed. This value will also - * be combined with a unique suffix. The provided value has the same - * validation rules as the Name field, and may be truncated by the length of - * the suffix required to make the value unique on the server. If this - * field is specified and the generated name exists, the server will NOT - * return a 409 - instead, it will either return 201 Created or 500 with - * Reason ServerTimeout indicating a unique name could not be found in the - * time allotted, and the client should retry (optionally after the time - * indicated in the Retry-After header). Applied only if Name is not - * specified. More info: - * https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency - * +optional string generateName = 2; + * Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional string generateName = 2; */ generateName?: string; /** - * A sequence number representing a specific generation of the desired - * state. Populated by the system. Read-only. +optional + * A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional */ generation?: number; /** - * Not currently supported by Cloud Run. An initializer is a controller - * which enforces some system invariant at object creation time. This field - * is a list of initializers that have not yet acted on this object. If nil - * or empty, this object has been completely initialized. Otherwise, the - * object is considered uninitialized and is hidden (in list/watch and get - * calls) from clients that haven't explicitly asked to observe - * uninitialized objects. When an object is created, the system will - * populate this list with the current set of initializers. Only privileged - * users may set or modify this list. Once it is empty, it may not be - * modified further by any user. + * Not currently supported by Cloud Run. An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. */ initializers?: Schema$Initializers; /** - * Map of string keys and values that can be used to organize and categorize - * (scope and select) objects. May match selectors of replication - * controllers and routes. More info: - * http://kubernetes.io/docs/user-guide/labels +optional + * Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels +optional */ labels?: {[key: string]: string}; /** - * Name must be unique within a namespace, within a Cloud Run region. Is - * required when creating resources, although some resources may allow a - * client to request the generation of an appropriate name automatically. - * Name is primarily intended for creation idempotence and configuration - * definition. Cannot be updated. More info: - * http://kubernetes.io/docs/user-guide/identifiers#names +optional + * Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional */ name?: string; /** - * Namespace defines the space within each name must be unique, within a - * Cloud Run region. In Cloud Run the namespace must be equal to either the - * project ID or project number. + * Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. */ namespace?: string; /** - * List of objects that own this object. If ALL objects in the list have - * been deleted, this object will be garbage collected. +optional + * List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional */ ownerReferences?: Schema$OwnerReference[]; /** - * An opaque value that represents the internal version of this object that - * can be used by clients to determine when objects have changed. May be - * used for optimistic concurrency, change detection, and the watch - * operation on a resource or set of resources. Clients must treat these - * values as opaque and passed unmodified back to the server. They may only - * be valid for a particular resource or set of resources. Populated by the - * system. Read-only. Value must be treated as opaque by clients and . More - * info: - * https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency - * +optional + * An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional */ resourceVersion?: string; /** - * SelfLink is a URL representing this object. Populated by the system. - * Read-only. +optional string selfLink = 4; + * SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4; */ selfLink?: string; /** - * UID is the unique in time and space value for this object. It is - * typically generated by the server on successful creation of a resource - * and is not allowed to change on PUT operations. Populated by the system. - * Read-only. More info: - * http://kubernetes.io/docs/user-guide/identifiers#uids +optional + * UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional + */ + uid?: string; + } + /** + * ObjectReference contains enough information to let you inspect or modify the referred object. + */ + export interface Schema$ObjectReference { + /** + * API version of the referent. +optional + */ + apiVersion?: string; + /** + * If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + */ + fieldPath?: string; + /** + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional + */ + kind?: string; + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional + */ + name?: string; + /** + * Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional + */ + namespace?: string; + /** + * Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional + */ + resourceVersion?: string; + /** + * UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional */ uid?: string; } /** - * OwnerReference contains enough information to let you identify an owning - * object. Currently, an owning object must be in the same namespace, so there - * is no namespace field. + * OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. */ export interface Schema$OwnerReference { /** @@ -1277,11 +994,7 @@ export namespace run_v1alpha1 { */ apiVersion?: string; /** - * If true, AND if the owner has the "foregroundDeletion" - * finalizer, then the owner cannot be deleted from the key-value store - * until this reference is removed. Defaults to false. To set this field, a - * user needs "delete" permission of the owner, otherwise 422 - * (Unprocessable Entity) will be returned. +optional + * If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional */ blockOwnerDeletion?: boolean; /** @@ -1289,40 +1002,20 @@ export namespace run_v1alpha1 { */ controller?: boolean; /** - * Kind of the referent. More info: - * https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds */ kind?: string; /** - * Name of the referent. More info: - * http://kubernetes.io/docs/user-guide/identifiers#names + * Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names */ name?: string; /** - * UID of the referent. More info: - * http://kubernetes.io/docs/user-guide/identifiers#uids + * UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids */ uid?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -1330,20 +1023,11 @@ export namespace run_v1alpha1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1352,13 +1036,11 @@ export namespace run_v1alpha1 { version?: number; } /** - * Probe describes a health check to be performed against a container to - * determine whether it is alive or ready to receive traffic. + * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ export interface Schema$Probe { /** - * Minimum consecutive failures for the probe to be considered failed after - * having succeeded. Defaults to 3. Minimum value is 1. +optional + * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional */ failureThreshold?: number; /** @@ -1366,35 +1048,24 @@ export namespace run_v1alpha1 { */ handler?: Schema$Handler; /** - * Number of seconds after the container has started before liveness probes - * are initiated. More info: - * https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * +optional + * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ initialDelaySeconds?: number; /** - * How often (in seconds) to perform the probe. Default to 10 seconds. - * Minimum value is 1. +optional + * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional */ periodSeconds?: number; /** - * Minimum consecutive successes for the probe to be considered successful - * after having failed. Defaults to 1. Must be 1 for liveness. Minimum value - * is 1. +optional + * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional */ successThreshold?: number; /** - * Number of seconds after which the probe times out. Defaults to 1 second. - * Minimum value is 1. More info: - * https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - * +optional + * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ timeoutSeconds?: number; } /** - * The view model of a single quantity, e.g. "800 MiB". Corresponds - * to - * https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto + * The view model of a single quantity, e.g. "800 MiB". Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto */ export interface Schema$Quantity { /** @@ -1407,13 +1078,11 @@ export namespace run_v1alpha1 { */ export interface Schema$ResourceRecord { /** - * Relative name of the object affected by this record. Only applicable for - * `CNAME` records. Example: 'www'. + * Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: 'www'. */ name?: string; /** - * Data for this record. Values vary by record type, as defined in RFC 1035 - * (section 5) and RFC 1034 (section 3.6.1). + * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). */ rrdata?: string; /** @@ -1426,43 +1095,24 @@ export namespace run_v1alpha1 { */ export interface Schema$ResourceRequirements { /** - * Limits describes the maximum amount of compute resources allowed. The - * values of the map is string form of the 'quantity' k8s type: - * https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go + * Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go */ limits?: {[key: string]: string}; /** - * Limits describes the maximum amount of compute resources allowed. This is - * a temporary field created to migrate away from the map<string, - * Quantity> limits field. This is done to become compliant with k8s - * style API. This field is deprecated in favor of limits field. + * Limits describes the maximum amount of compute resources allowed. This is a temporary field created to migrate away from the map<string, Quantity> limits field. This is done to become compliant with k8s style API. This field is deprecated in favor of limits field. */ limitsInMap?: {[key: string]: Schema$Quantity}; /** - * Requests describes the minimum amount of compute resources required. If - * Requests is omitted for a container, it defaults to Limits if that is - * explicitly specified, otherwise to an implementation-defined value. The - * values of the map is string form of the 'quantity' k8s type: - * https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go + * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go */ requests?: {[key: string]: string}; /** - * Requests describes the minimum amount of compute resources required. If - * Requests is omitted for a container, it defaults to Limits if that is - * explicitly specified, otherwise to an implementation-defined value. This - * is a temporary field created to migrate away from the map<string, - * Quantity> requests field. This is done to become compliant with k8s - * style API. This field is deprecated in favor of requests field. + * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. This is a temporary field created to migrate away from the map<string, Quantity> requests field. This is done to become compliant with k8s style API. This field is deprecated in favor of requests field. */ requestsInMap?: {[key: string]: Schema$Quantity}; } /** - * Revision is an immutable snapshot of code and configuration. A revision - * references a container image. Revisions are created by updates to a - * Configuration. Cloud Run does not currently support referencing a build - * that is responsible for materializing the container image from source. See - * also: - * https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision + * Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision */ export interface Schema$Revision { /** @@ -1474,8 +1124,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * Metadata associated with this Revision, including name, namespace, - * labels, and annotations. + * Metadata associated with this Revision, including name, namespace, labels, and annotations. */ metadata?: Schema$ObjectMeta; /** @@ -1483,8 +1132,7 @@ export namespace run_v1alpha1 { */ spec?: Schema$RevisionSpec; /** - * Status communicates the observed state of the Revision (from the - * controller). + * Status communicates the observed state of the Revision (from the controller). */ status?: Schema$RevisionStatus; } @@ -1493,18 +1141,15 @@ export namespace run_v1alpha1 { */ export interface Schema$RevisionCondition { /** - * Last time the condition transitioned from one status to another. - * +optional + * Last time the condition transitioned from one status to another. +optional */ lastTransitionTime?: string; /** - * Human readable message indicating details about the current status. - * +optional + * Human readable message indicating details about the current status. +optional */ message?: string; /** - * One-word CamelCase reason for the condition's last transition. - * +optional + * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; /** @@ -1512,14 +1157,7 @@ export namespace run_v1alpha1 { */ status?: string; /** - * RevisionConditionType is used to communicate the status of the - * reconciliation process. See also: - * https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting - * Types include: * "Ready": True when the Revision is ready. * - * "ResourcesAvailable": True when underlying resources have been - * provisioned. * "ContainerHealthy": True when the Revision - * readiness check completes. * "Active": True when the Revision - * may receive traffic. + * RevisionConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: * "Ready": True when the Revision is ready. * "ResourcesAvailable": True when underlying resources have been provisioned. * "ContainerHealthy": True when the Revision readiness check completes. * "Active": True when the Revision may receive traffic. */ type?: string; } @@ -1528,31 +1166,23 @@ export namespace run_v1alpha1 { */ export interface Schema$RevisionSpec { /** - * ConcurrencyModel specifies the desired concurrency model (Single or - * Multi) for the Revision. Defaults to Multi. Deprecated in favor of - * ContainerConcurrency. +optional + * ConcurrencyModel specifies the desired concurrency model (Single or Multi) for the Revision. Defaults to Multi. Deprecated in favor of ContainerConcurrency. +optional */ concurrencyModel?: string; /** - * Container defines the unit of execution for this Revision. In the context - * of a Revision, we disallow a number of the fields of this Container, - * including: name, ports, and volumeMounts. The runtime contract is - * documented here: - * https://github.com/knative/serving/blob/master/docs/runtime-contract.md + * Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md */ container?: Schema$Container; /** - * ContainerConcurrency specifies the maximum allowed in-flight (concurrent) - * requests per container of the Revision. Values are: - `0` thread-safe, - * the system should manage the max concurrency. This is the default - * value. - `1` not-thread-safe. Single concurrency - `2-N` thread-safe, max - * concurrency of N + * ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Values are: - `0` thread-safe, the system should manage the max concurrency. This is the default value. - `1` not-thread-safe. Single concurrency - `2-N` thread-safe, max concurrency of N */ containerConcurrency?: number; /** - * Deprecated and not currently populated by Cloud Run. See - * metadata.generation instead, which is the sequence number containing the - * latest generation of the desired state. Read-only. + * Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. + */ + containers?: Schema$Container[]; + /** + * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ generation?: number; /** @@ -1560,51 +1190,32 @@ export namespace run_v1alpha1 { */ serviceAccountName?: string; /** - * ServingState holds a value describing the state the resources are in for - * this Revision. Users must not specify this when creating a revision. It - * is expected that the system will manipulate this based on routability and - * load. Populated by the system. Read-only. + * ServingState holds a value describing the state the resources are in for this Revision. Users must not specify this when creating a revision. It is expected that the system will manipulate this based on routability and load. Populated by the system. Read-only. */ servingState?: string; /** - * TimeoutSeconds holds the max duration the instance is allowed for - * responding to a request. Not currently used by Cloud Run. + * TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Not currently used by Cloud Run. */ timeoutSeconds?: number; } /** - * RevisionStatus communicates the observed state of the Revision (from the - * controller). + * RevisionStatus communicates the observed state of the Revision (from the controller). */ export interface Schema$RevisionStatus { /** - * Conditions communicates information about ongoing/complete reconciliation - * processes that bring the "spec" inline with the observed state - * of the world. As a Revision is being prepared, it will incrementally - * update conditions "ResourcesAvailable", - * "ContainerHealthy", and "Active", which contribute to - * the overall "Ready" condition. + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. As a Revision is being prepared, it will incrementally update conditions "ResourcesAvailable", "ContainerHealthy", and "Active", which contribute to the overall "Ready" condition. */ conditions?: Schema$RevisionCondition[]; /** - * ImageDigest holds the resolved digest for the image specified within - * .Spec.Container.Image. The digest is resolved during the creation of - * Revision. This field holds the digest value regardless of whether a tag - * or digest was originally specified in the Container object. + * ImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. */ imageDigest?: string; /** - * Specifies the generated logging url for this particular revision based on - * the revision url template specified in the controller's config. - * +optional + * Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config. +optional */ logUrl?: string; /** - * ObservedGeneration is the 'Generation' of the Revision that was - * last processed by the controller. Clients polling for completed - * reconciliation should poll until observedGeneration = - * metadata.generation, and the Ready condition's status is True or - * False. + * ObservedGeneration is the 'Generation' of the Revision that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False. */ observedGeneration?: number; /** @@ -1613,14 +1224,11 @@ export namespace run_v1alpha1 { serviceName?: string; } /** - * RevisionTemplateSpec describes the data a revision should have when created - * from a template. Based on: - * https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 + * RevisionTemplateSpec describes the data a revision should have when created from a template. Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 */ export interface Schema$RevisionTemplate { /** - * Optional metadata for this Revision, including labels and annotations. - * Name will be generated by the Configuration. + * Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. */ metadata?: Schema$ObjectMeta; /** @@ -1629,16 +1237,7 @@ export namespace run_v1alpha1 { spec?: Schema$RevisionSpec; } /** - * Route is responsible for configuring ingress over a collection of - * Revisions. Some of the Revisions a Route distributes traffic over may be - * specified by referencing the Configuration responsible for creating them; - * in these cases the Route is additionally responsible for monitoring the - * Configuration for "latest ready" revision changes, and smoothly - * rolling out latest revisions. See also: - * https://github.com/knative/serving/blob/master/docs/spec/overview.md#route - * Cloud Run currently supports referencing a single Configuration to - * automatically deploy the "latest ready" Revision from that - * Configuration. + * Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for "latest ready" revision changes, and smoothly rolling out latest revisions. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route Cloud Run currently supports referencing a single Configuration to automatically deploy the "latest ready" Revision from that Configuration. */ export interface Schema$Route { /** @@ -1650,8 +1249,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * Metadata associated with this Route, including name, namespace, labels, - * and annotations. + * Metadata associated with this Route, including name, namespace, labels, and annotations. */ metadata?: Schema$ObjectMeta; /** @@ -1659,8 +1257,7 @@ export namespace run_v1alpha1 { */ spec?: Schema$RouteSpec; /** - * Status communicates the observed state of the Route (from the - * controller). + * Status communicates the observed state of the Route (from the controller). */ status?: Schema$RouteStatus; } @@ -1669,30 +1266,23 @@ export namespace run_v1alpha1 { */ export interface Schema$RouteCondition { /** - * Last time the condition transitioned from one status to another. - * +optional + * Last time the condition transitioned from one status to another. +optional */ lastTransitionTime?: string; /** - * Human-readable message indicating details about last transition. - * +optional + * Human-readable message indicating details about last transition. +optional */ message?: string; /** - * One-word CamelCase reason for the condition's last transition. - * +optional + * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; /** - * Status of the condition, one of "True", "False", - * "Unknown". + * Status of the condition, one of "True", "False", "Unknown". */ status?: string; /** - * RouteConditionType is used to communicate the status of the - * reconciliation process. See also: - * https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting - * Types include: "Ready". + * RouteConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: "Ready". */ type?: string; } @@ -1701,21 +1291,16 @@ export namespace run_v1alpha1 { */ export interface Schema$RouteSpec { /** - * Deprecated and not currently populated by Cloud Run. See - * metadata.generation instead, which is the sequence number containing the - * latest generation of the desired state. Read-only. + * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ generation?: number; /** - * Traffic specifies how to distribute traffic over a collection of Knative - * Revisions and Configurations. Cloud Run currently supports a single - * configurationName. + * Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName. */ traffic?: Schema$TrafficTarget[]; } /** - * RouteStatus communicates the observed state of the Route (from the - * controller). + * RouteStatus communicates the observed state of the Route (from the controller). */ export interface Schema$RouteStatus { /** @@ -1723,15 +1308,11 @@ export namespace run_v1alpha1 { */ address?: Schema$Addressable; /** - * Conditions communicates information about ongoing/complete reconciliation - * processes that bring the "spec" inline with the observed state - * of the world. + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. */ conditions?: Schema$RouteCondition[]; /** - * Domain holds the top-level domain that will distribute traffic over the - * provided targets. It generally has the form - * https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app + * Domain holds the top-level domain that will distribute traffic over the provided targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app */ domain?: string; /** @@ -1739,28 +1320,16 @@ export namespace run_v1alpha1 { */ domainInternal?: string; /** - * ObservedGeneration is the 'Generation' of the Route that was last - * processed by the controller. Clients polling for completed - * reconciliation should poll until observedGeneration = metadata.generation - * and the Ready condition's status is True or False. Note that - * providing a trafficTarget that only has a configurationName will result - * in a Route that does not increment either its metadata.generation or its - * observedGeneration, as new "latest ready" revisions from the - * Configuration are processed without an update to the Route's spec. + * ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. Note that providing a trafficTarget that only has a configurationName will result in a Route that does not increment either its metadata.generation or its observedGeneration, as new "latest ready" revisions from the Configuration are processed without an update to the Route's spec. */ observedGeneration?: number; /** - * Traffic holds the configured traffic distribution. These entries will - * always contain RevisionName references. When ConfigurationName appears in - * the spec, this will hold the LatestReadyRevisionName that we last - * observed. + * Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. */ traffic?: Schema$TrafficTarget[]; } /** - * SecretEnvSource selects a Secret to populate the environment variables - * with. The contents of the target Secret's Data field will represent - * the key-value pairs as environment variables. + * SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ export interface Schema$SecretEnvSource { /** @@ -1773,66 +1342,39 @@ export namespace run_v1alpha1 { optional?: boolean; } /** - * SecurityContext holds security configuration that will be applied to a - * container. Some fields are present in both SecurityContext and - * PodSecurityContext. When both are set, the values in SecurityContext take - * precedence. + * SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ export interface Schema$SecurityContext { /** - * AllowPrivilegeEscalation controls whether a process can gain more - * privileges than its parent process. This bool directly controls if the - * no_new_privs flag will be set on the container process. - * AllowPrivilegeEscalation is true always when the container is: 1) run as - * Privileged 2) has CAP_SYS_ADMIN +optional + * AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN +optional */ allowPrivilegeEscalation?: boolean; /** - * The capabilities to add/drop when running containers. Defaults to the - * default set of capabilities granted by the container runtime. +optional + * The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. +optional */ capabilities?: Schema$Capabilities; /** - * Run container in privileged mode. Processes in privileged containers are - * essentially equivalent to root on the host. Defaults to false. +optional + * Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional */ privileged?: boolean; /** - * Whether this container has a read-only root filesystem. Default is false. - * +optional + * Whether this container has a read-only root filesystem. Default is false. +optional */ readOnlyRootFilesystem?: boolean; /** - * The GID to run the entrypoint of the container process. Uses runtime - * default if unset. May also be set in PodSecurityContext. If set in both - * SecurityContext and PodSecurityContext, the value specified in - * SecurityContext takes precedence. +optional + * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ runAsGroup?: string; /** - * Indicates that the container must run as a non-root user. If true, the - * Kubelet will validate the image at runtime to ensure that it does not run - * as UID 0 (root) and fail to start the container if it does. If unset or - * false, no such validation will be performed. May also be set in - * PodSecurityContext. If set in both SecurityContext and - * PodSecurityContext, the value specified in SecurityContext takes - * precedence. +optional + * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ runAsNonRoot?: boolean; /** - * The UID to run the entrypoint of the container process. Defaults to user - * specified in image metadata if unspecified. May also be set in - * PodSecurityContext. If set in both SecurityContext and - * PodSecurityContext, the value specified in SecurityContext takes - * precedence. +optional + * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ runAsUser?: string; /** - * The SELinux context to be applied to the container. If unspecified, the - * container runtime will allocate a random SELinux context for each - * container. May also be set in PodSecurityContext. If set in both - * SecurityContext and PodSecurityContext, the value specified in - * SecurityContext takes precedence. +optional + * The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional */ seLinuxOptions?: Schema$SELinuxOptions; } @@ -1858,16 +1400,7 @@ export namespace run_v1alpha1 { user?: string; } /** - * Service acts as a top-level container that manages a set of Routes and - * Configurations which implement a network service. Service exists to provide - * a singular abstraction which can be access controlled, reasoned about, and - * which encapsulates software lifecycle decisions such as rollout policy and - * team resource ownership. Service acts only as an orchestrator of the - * underlying Routes and Configurations (much as a kubernetes Deployment - * orchestrates ReplicaSets). The Service's controller will track the - * statuses of its owned Configuration and Route, reflecting their statuses - * and conditions as its own. See also: - * https://github.com/knative/serving/blob/master/docs/spec/overview.md#service + * Service acts as a top-level container that manages a set of Routes and Configurations which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets). The Service's controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service */ export interface Schema$Service { /** @@ -1879,8 +1412,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * Metadata associated with this Service, including name, namespace, labels, - * and annotations. + * Metadata associated with this Service, including name, namespace, labels, and annotations. */ metadata?: Schema$ObjectMeta; /** @@ -1888,8 +1420,7 @@ export namespace run_v1alpha1 { */ spec?: Schema$ServiceSpec; /** - * Status communicates the observed state of the Service (from the - * controller). + * Status communicates the observed state of the Service (from the controller). */ status?: Schema$ServiceStatus; } @@ -1898,18 +1429,15 @@ export namespace run_v1alpha1 { */ export interface Schema$ServiceCondition { /** - * Last time the condition transitioned from one status to another. - * +optional + * Last time the condition transitioned from one status to another. +optional */ lastTransitionTime?: string; /** - * Human-readable message indicating details about last transition. - * +optional + * Human-readable message indicating details about last transition. +optional */ message?: string; /** - * One-word CamelCase reason for the condition's last transition. - * +optional + * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; /** @@ -1917,60 +1445,49 @@ export namespace run_v1alpha1 { */ status?: string; /** - * ServiceConditionType is used to communicate the status of the - * reconciliation process. See also: - * https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting - * Types include: "Ready", "ConfigurationsReady", and - * "RoutesReady". "Ready" will be true when the - * underlying Route and Configuration are ready. + * ServiceConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: "Ready", "ConfigurationsReady", and "RoutesReady". "Ready" will be true when the underlying Route and Configuration are ready. */ type?: string; } /** - * ServiceSpec holds the desired state of the Route (from the client), which - * is used to manipulate the underlying Route and Configuration(s). + * ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). */ export interface Schema$ServiceSpec { /** - * Deprecated and not currently populated by Cloud Run. See - * metadata.generation instead, which is the sequence number containing the - * latest generation of the desired state. Read-only. + * Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. */ generation?: number; /** - * Manual contains the options for configuring a manual service. See - * ServiceSpec for more details. Not currently supported by Cloud Run. + * Manual contains the options for configuring a manual service. See ServiceSpec for more details. Not currently supported by Cloud Run. */ manual?: Schema$ServiceSpecManualType; /** - * Pins this service to a specific revision name. The revision must be owned - * by the configuration provided. Deprecated and not supported by Cloud - * Run. +optional + * Pins this service to a specific revision name. The revision must be owned by the configuration provided. Deprecated and not supported by Cloud Run. +optional */ pinned?: Schema$ServiceSpecPinnedType; /** - * Release enables gradual promotion of new revisions by allowing traffic to - * be split between two revisions. This type replaces the deprecated Pinned - * type. Not currently supported by Cloud Run. + * Release enables gradual promotion of new revisions by allowing traffic to be split between two revisions. This type replaces the deprecated Pinned type. Not currently supported by Cloud Run. */ release?: Schema$ServiceSpecReleaseType; /** - * RunLatest defines a simple Service. It will automatically configure a - * route that keeps the latest ready revision from the supplied - * configuration running. +optional + * RunLatest defines a simple Service. It will automatically configure a route that keeps the latest ready revision from the supplied configuration running. +optional */ runLatest?: Schema$ServiceSpecRunLatest; + /** + * Template holds the latest specification for the Revision to be stamped out. Not currently supported by Cloud Run. + */ + template?: Schema$RevisionTemplate; + /** + * Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. This will replace existing service specs (ServiceSpecRunLatest, ServiceSpecPinnedType, ServiceSpecReleaseType, and ServiceSpecManualType). Not currently supported by Cloud Run. + */ + traffic?: Schema$TrafficTarget[]; } /** - * ServiceSpecManualType contains the options for configuring a manual - * service. See ServiceSpec for more details. Not currently supported by - * Cloud Run. + * ServiceSpecManualType contains the options for configuring a manual service. See ServiceSpec for more details. Not currently supported by Cloud Run. */ export interface Schema$ServiceSpecManualType {} /** - * ServiceSpecPinnedType Pins this service to a specific revision name. The - * revision must be owned by the configuration provided. Deprecated and not - * supported by Cloud Run. + * ServiceSpecPinnedType Pins this service to a specific revision name. The revision must be owned by the configuration provided. Deprecated and not supported by Cloud Run. */ export interface Schema$ServiceSpecPinnedType { /** @@ -1978,39 +1495,29 @@ export namespace run_v1alpha1 { */ configuration?: Schema$ConfigurationSpec; /** - * The revision name to pin this service to until changed to a different - * service type. + * The revision name to pin this service to until changed to a different service type. */ revisionName?: string; } /** - * ServiceSpecReleaseType contains the options for slowly releasing revisions. - * See ServiceSpec for more details. Not currently supported by Cloud Run. + * ServiceSpecReleaseType contains the options for slowly releasing revisions. See ServiceSpec for more details. Not currently supported by Cloud Run. */ export interface Schema$ServiceSpecReleaseType { /** - * The configuration for this service. All revisions from this service must - * come from a single configuration. + * The configuration for this service. All revisions from this service must come from a single configuration. */ configuration?: Schema$ConfigurationSpec; /** - * Revisions is an ordered list of 1 or 2 revisions. The first is the - * current revision, and the second is the candidate revision. If a single - * revision is provided, traffic will be pinned at that revision. - * "@latest" is a shortcut for usage that refers to the latest - * created revision by the configuration. + * Revisions is an ordered list of 1 or 2 revisions. The first is the current revision, and the second is the candidate revision. If a single revision is provided, traffic will be pinned at that revision. "@latest" is a shortcut for usage that refers to the latest created revision by the configuration. */ revisions?: string[]; /** - * RolloutPercent is the percent of traffic that should be sent to the - * candidate revision, i.e. the 2nd revision in the revisions list. Valid - * values are between 0 and 99 inclusive. + * RolloutPercent is the percent of traffic that should be sent to the candidate revision, i.e. the 2nd revision in the revisions list. Valid values are between 0 and 99 inclusive. */ rolloutPercent?: number; } /** - * ServiceSpecRunLatest contains the options for always having a route to the - * latest configuration. See ServiceSpec for more details. + * ServiceSpecRunLatest contains the options for always having a route to the latest configuration. See ServiceSpec for more details. */ export interface Schema$ServiceSpecRunLatest { /** @@ -2023,46 +1530,31 @@ export namespace run_v1alpha1 { */ export interface Schema$ServiceStatus { /** - * From RouteStatus. Similar to domain, information on where the service is - * available on HTTP. + * From RouteStatus. Similar to domain, information on where the service is available on HTTP. */ address?: Schema$Addressable; /** - * Conditions communicates information about ongoing/complete reconciliation - * processes that bring the "spec" inline with the observed state - * of the world. + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. */ conditions?: Schema$ServiceCondition[]; /** - * From RouteStatus. Domain holds the top-level domain that will distribute - * traffic over the provided targets. It generally has the form - * https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app + * From RouteStatus. Domain holds the top-level domain that will distribute traffic over the provided targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app */ domain?: string; /** - * From ConfigurationStatus. LatestCreatedRevisionName is the last revision - * that was created from this Service's Configuration. It might not be - * ready yet, for that use LatestReadyRevisionName. + * From ConfigurationStatus. LatestCreatedRevisionName is the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName. */ latestCreatedRevisionName?: string; /** - * From ConfigurationStatus. LatestReadyRevisionName holds the name of the - * latest Revision stamped out from this Service's Configuration that - * has had its "Ready" condition become "True". + * From ConfigurationStatus. LatestReadyRevisionName holds the name of the latest Revision stamped out from this Service's Configuration that has had its "Ready" condition become "True". */ latestReadyRevisionName?: string; /** - * ObservedGeneration is the 'Generation' of the Route that was last - * processed by the controller. Clients polling for completed - * reconciliation should poll until observedGeneration = metadata.generation - * and the Ready condition's status is True or False. + * ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. */ observedGeneration?: number; /** - * From RouteStatus. Traffic holds the configured traffic distribution. - * These entries will always contain RevisionName references. When - * ConfigurationName appears in the spec, this will hold the - * LatestReadyRevisionName that we last observed. + * From RouteStatus. Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. */ traffic?: Schema$TrafficTarget[]; } @@ -2071,20 +1563,24 @@ export namespace run_v1alpha1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } + export interface Schema$SubscriberSpec { + /** + * Reference to an object that will be used to find the target endpoint, which should implement the Addressable duck type. For example, this could be a reference to a Route resource or a Knative Service resource. + */ + ref?: Schema$ObjectReference; + /** + * Reference to a 'known' endpoint where no resolving is done. http://k8s-service for example http://myexternalhandler.example.com/foo/bar + */ + uri?: string; + } /** * TCPSocketAction describes an action based on opening a socket */ @@ -2094,8 +1590,7 @@ export namespace run_v1alpha1 { */ host?: string; /** - * Number or name of the port to access on the container. Number must be in - * the range 1 to 65535. Name must be an IANA_SVC_NAME. + * Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port?: Schema$IntOrString; } @@ -2104,10 +1599,7 @@ export namespace run_v1alpha1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -2116,8 +1608,7 @@ export namespace run_v1alpha1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -2126,41 +1617,119 @@ export namespace run_v1alpha1 { */ export interface Schema$TrafficTarget { /** - * ConfigurationName of a configuration to whose latest revision we will - * send this portion of traffic. When the - * "status.latestReadyRevisionName" of the referenced - * configuration changes, we will automatically migrate traffic from the - * prior "latest ready" revision to the new one. This field is - * never set in Route's status, only its spec. This is mutually - * exclusive with RevisionName. Cloud Run currently supports a single - * ConfigurationName. + * ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName. */ configurationName?: string; /** - * Name is optionally used to expose a dedicated hostname for referencing - * this target exclusively. Not currently supported by Cloud Run. +optional + * Name is optionally used to expose a dedicated hostname for referencing this target exclusively. Not currently supported by Cloud Run. +optional */ name?: string; /** - * Percent specifies percent of the traffic to this Revision or - * Configuration. This defaults to zero if unspecified. Cloud Run currently - * requires 100 percent for a single ConfigurationName TrafficTarget entry. + * Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry. */ percent?: number; /** - * RevisionName of a specific revision to which to send this portion of - * traffic. This is mutually exclusive with ConfigurationName. Providing - * RevisionName in spec is not currently supported by Cloud Run. + * RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run. */ revisionName?: string; } + export interface Schema$Trigger { + /** + * The API version for this call such as "v1alpha1". + */ + apiVersion?: string; + /** + * The kind of resource, in this case "Trigger". + */ + kind?: string; + /** + * Metadata associated with this Trigger. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec defines the desired state of the Trigger. + */ + spec?: Schema$TriggerSpec; + /** + * Status represents the current state of the Trigger. This data may be out of date. +optional + */ + status?: Schema$TriggerStatus; + } + /** + * TriggerCondition contains state information for an Trigger. + */ + export interface Schema$TriggerCondition { + /** + * Last time the condition transitioned from one status to another. +optional + */ + lastTransitionTime?: string; + /** + * Human readable message indicating details about the current status. +optional + */ + message?: string; + /** + * One-word CamelCase reason for the condition's current status. +optional + */ + reason?: string; + /** + * Status of the condition, one of True, False, Unknown. + */ + status?: string; + /** + * Type of Trigger condition. + */ + type?: string; + } + export interface Schema$TriggerFilter { + sourceAndType?: Schema$TriggerFilterSourceAndType; + } + /** + * TriggerFilterSourceAndType filters events based on exact matches on the cloud event's type and source attributes. Only exact matches will pass the filter. + */ + export interface Schema$TriggerFilterSourceAndType { + source?: string; + type?: string; + } + /** + * The desired state of the Trigger. + */ + export interface Schema$TriggerSpec { + /** + * Broker is the broker that this trigger receives events from. If not specified, will default to 'default'. Not currently supported by Cloud Run. + */ + broker?: string; + /** + * Filter is the filter to apply against all events from the Broker. Only events that pass this filter will be sent to the Subscriber. If not specified, will default to allowing all events. This must be specified in Cloud Run. + */ + filter?: Schema$TriggerFilter; + /** + * Subscriber is the addressable that receives events from the Broker that pass the Filter. It is required. E.g. https://us-central1-myproject.cloudfunctions.net/myfunction or /namespaces/my-project/services/my-service. + */ + subscriber?: Schema$SubscriberSpec; + } + /** + * TriggerStatus represents the current state of a Trigger. + */ + export interface Schema$TriggerStatus { + /** + * Array of observed TriggerConditions, indicating the current state of the Trigger. + */ + conditions?: Schema$TriggerCondition[]; + /** + * ObservedGeneration is the 'Generation' of the Trigger that was last processed by the controller. + */ + observedGeneration?: number; + /** + * SubscriberURI is the resolved URI of the receiver for this Trigger. + */ + subscriberUri?: string; + } /** * volumeDevice describes a mapping of a raw block device within a container. */ export interface Schema$VolumeDevice { /** - * devicePath is the path inside of the container that the device will be - * mapped to. + * devicePath is the path inside of the container that the device will be mapped to. */ devicePath?: string; /** @@ -2173,15 +1742,11 @@ export namespace run_v1alpha1 { */ export interface Schema$VolumeMount { /** - * Path within the container at which the volume should be mounted. Must - * not contain ':'. + * Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath?: string; /** - * mountPropagation determines how mounts are propagated from the host to - * container and the other way around. When not set, - * MountPropagationHostToContainer is used. This field is beta in 1.10. - * +optional + * mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is beta in 1.10. +optional */ mountPropagation?: string; /** @@ -2189,13 +1754,11 @@ export namespace run_v1alpha1 { */ name?: string; /** - * Mounted read-only if true, read-write otherwise (false or unspecified). - * Defaults to false. +optional + * Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional */ readOnly?: boolean; /** - * Path within the volume from which the container's volume should be - * mounted. Defaults to "" (volume's root). +optional + * Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional */ subPath?: string; } @@ -2208,6 +1771,7 @@ export namespace run_v1alpha1 { revisions: Resource$Namespaces$Revisions; routes: Resource$Namespaces$Routes; services: Resource$Namespaces$Services; + triggers: Resource$Namespaces$Triggers; constructor(context: APIRequestContext) { this.context = context; this.authorizeddomains = new Resource$Namespaces$Authorizeddomains( @@ -2222,6 +1786,7 @@ export namespace run_v1alpha1 { this.revisions = new Resource$Namespaces$Revisions(this.context); this.routes = new Resource$Namespaces$Routes(this.context); this.services = new Resource$Namespaces$Services(this.context); + this.triggers = new Resource$Namespaces$Triggers(this.context); } } @@ -2514,8 +2079,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the configuration being retrieved. If needed, replace - * {namespace_id} with the project ID. + * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } @@ -2531,9 +2095,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -2541,8 +2103,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -2550,18 +2111,15 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the configurations should be - * listed. + * The project ID or project number from which the configurations should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } @@ -2892,8 +2450,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this domain mapping should be - * created. + * The project ID or project number in which this domain mapping should be created. */ parent?: string; @@ -2918,22 +2475,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the domain mapping being deleted. If needed, replace - * {namespace_id} with the project ID. + * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only - * supports cascading behavior, so this must be false. This attribute is - * deprecated, and is now replaced with PropagationPolicy See - * https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. */ orphanDependents?: boolean; /** - * Specifies the propagation policy of delete. Cloud Run currently ignores - * this setting, and deletes in the background. Please see - * kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for - * more information. + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } @@ -2945,8 +2495,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the domain mapping being retrieved. If needed, replace - * {namespace_id} with the project ID. + * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } @@ -2962,9 +2511,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -2972,8 +2519,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -2981,18 +2527,15 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the domain mappings should be - * listed. + * The project ID or project number from which the domain mappings should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } @@ -3248,22 +2791,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the revision being deleted. If needed, replace {namespace_id} - * with the project ID. + * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only - * supports cascading behavior, so this must be false. This attribute is - * deprecated, and is now replaced with PropagationPolicy See - * https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. */ orphanDependents?: boolean; /** - * Specifies the propagation policy of delete. Cloud Run currently ignores - * this setting, and deletes in the background. Please see - * kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for - * more information. + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } @@ -3275,8 +2811,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the revision being retrieved. If needed, replace - * {namespace_id} with the project ID. + * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } @@ -3292,9 +2827,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -3302,8 +2835,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -3311,18 +2843,15 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the revisions should be - * listed. + * The project ID or project number from which the revisions should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } @@ -3493,8 +3022,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the route being retrieved. If needed, replace {namespace_id} - * with the project ID. + * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } @@ -3510,9 +3038,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -3520,8 +3046,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -3533,13 +3058,11 @@ export namespace run_v1alpha1 { */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } @@ -3624,9 +3147,7 @@ export namespace run_v1alpha1 { /** * run.namespaces.services.delete - * @desc Rpc to delete a service. This will cause the Service to stop - * serving traffic and will delete the child entities like Routes, - * Configurations and Revisions. + * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. * @alias run.namespaces.services.delete * @memberOf! () * @@ -3854,11 +3375,7 @@ export namespace run_v1alpha1 { /** * run.namespaces.services.replaceService - * @desc Rpc to replace a service. Only the spec and metadata labels and - * annotations are modifiable. After the Update request, Cloud Run will work - * to make the 'status' match the requested 'spec'. May provide - * metadata.resourceVersion to enforce update from last read for optimistic - * concurrency control. + * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. * @alias run.namespaces.services.replaceService * @memberOf! () * @@ -3962,22 +3479,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the service being deleted. If needed, replace {namespace_id} - * with the project ID. + * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only - * supports cascading behavior, so this must be false. This attribute is - * deprecated, and is now replaced with PropagationPolicy See - * https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. */ orphanDependents?: boolean; /** - * Specifies the propagation policy of delete. Cloud Run currently ignores - * this setting, and deletes in the background. Please see - * kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for - * more information. + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } @@ -3989,8 +3499,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being retrieved. If needed, replace - * {namespace_id} with the project ID. + * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } @@ -4006,9 +3515,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -4016,8 +3523,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -4025,18 +3531,15 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the services should be - * listed. + * The project ID or project number from which the services should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } @@ -4048,8 +3551,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being replaced. If needed, replace {namespace_id} - * with the project ID. + * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. */ name?: string; @@ -4059,86 +3561,53 @@ export namespace run_v1alpha1 { requestBody?: Schema$Service; } - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } - - export class Resource$Projects$Locations { + export class Resource$Namespaces$Triggers { context: APIRequestContext; - authorizeddomains: Resource$Projects$Locations$Authorizeddomains; - configurations: Resource$Projects$Locations$Configurations; - domainmappings: Resource$Projects$Locations$Domainmappings; - revisions: Resource$Projects$Locations$Revisions; - routes: Resource$Projects$Locations$Routes; - services: Resource$Projects$Locations$Services; constructor(context: APIRequestContext) { this.context = context; - this.authorizeddomains = new Resource$Projects$Locations$Authorizeddomains( - this.context - ); - this.configurations = new Resource$Projects$Locations$Configurations( - this.context - ); - this.domainmappings = new Resource$Projects$Locations$Domainmappings( - this.context - ); - this.revisions = new Resource$Projects$Locations$Revisions(this.context); - this.routes = new Resource$Projects$Locations$Routes(this.context); - this.services = new Resource$Projects$Locations$Services(this.context); } /** - * run.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias run.projects.locations.list + * run.namespaces.triggers.create + * @desc Creates a new trigger. + * @alias run.namespaces.triggers.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The standard list filter. - * @param {string} params.name The resource that owns the locations collection, if applicable. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. + * @param {string} params.parent The project ID or project number in which this trigger should be created. + * @param {().Trigger} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$List, + create( + params?: Params$Resource$Namespaces$Triggers$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Triggers$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Namespaces$Triggers$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Triggers$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Namespaces$Triggers$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Namespaces$Triggers$Create; options = {}; } @@ -4151,106 +3620,68 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+parent}/triggers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The standard list filter. - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Authorizeddomains { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.projects.locations.authorizeddomains.list - * @desc RPC to list authorized domains. - * @alias run.projects.locations.authorizeddomains.list + * run.namespaces.triggers.delete + * @desc Rpc to delete a trigger. + * @alias run.namespaces.triggers.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.parent Name of the parent Application resource. Example: `apps/myapp`. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Authorizeddomains$List, + delete( + params?: Params$Resource$Namespaces$Triggers$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Authorizeddomains$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Authorizeddomains$List, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Triggers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Namespaces$Triggers$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizeddomains$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Triggers$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizeddomains$List; + {}) as Params$Resource$Namespaces$Triggers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Authorizeddomains$List; + params = {} as Params$Resource$Namespaces$Triggers$Delete; options = {}; } @@ -4263,101 +3694,65 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/authorizeddomains').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Authorizeddomains$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum results to return per page. - */ - pageSize?: number; - /** - * Continuation token for fetching the next page of results. - */ - pageToken?: string; - /** - * Name of the parent Application resource. Example: `apps/myapp`. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Configurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.projects.locations.configurations.get - * @desc Rpc to get information about a configuration. - * @alias run.projects.locations.configurations.get + * run.namespaces.triggers.get + * @desc Rpc to get information about a trigger. + * @alias run.namespaces.triggers.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Configurations$Get, + params?: Params$Resource$Namespaces$Triggers$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Configurations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Triggers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Configurations$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Triggers$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Configurations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Triggers$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Configurations$Get; + {}) as Params$Resource$Namespaces$Triggers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Configurations$Get; + params = {} as Params$Resource$Namespaces$Triggers$Get; options = {}; } @@ -4370,7 +3765,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -4381,16 +3778,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.configurations.list - * @desc Rpc to list configurations. - * @alias run.projects.locations.configurations.list + * run.namespaces.triggers.list + * @desc Rpc to list triggers. + * @alias run.namespaces.triggers.list * @memberOf! () * * @param {object} params Parameters for request @@ -4399,7 +3796,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the configurations should be listed. + * @param {string} params.parent The project ID or project number from which the triggers should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4407,39 +3804,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Configurations$List, + params?: Params$Resource$Namespaces$Triggers$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Configurations$List, + params: Params$Resource$Namespaces$Triggers$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Configurations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Triggers$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Configurations$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Triggers$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Configurations$List; + {}) as Params$Resource$Namespaces$Triggers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Configurations$List; + params = {} as Params$Resource$Namespaces$Triggers$List; options = {}; } @@ -4452,10 +3847,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/configurations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+parent}/triggers' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -4466,17 +3860,103 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.triggers.replaceTrigger + * @desc Rpc to replace a trigger. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.triggers.replaceTrigger + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().Trigger} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceTrigger( + params?: Params$Resource$Namespaces$Triggers$Replacetrigger, + options?: MethodOptions + ): GaxiosPromise; + replaceTrigger( + params: Params$Resource$Namespaces$Triggers$Replacetrigger, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceTrigger( + params: Params$Resource$Namespaces$Triggers$Replacetrigger, + callback: BodyResponseCallback + ): void; + replaceTrigger(callback: BodyResponseCallback): void; + replaceTrigger( + paramsOrCallback?: + | Params$Resource$Namespaces$Triggers$Replacetrigger + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Triggers$Replacetrigger; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Triggers$Replacetrigger; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Configurations$Get + export interface Params$Resource$Namespaces$Triggers$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this trigger should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Trigger; + } + export interface Params$Resource$Namespaces$Triggers$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -4484,12 +3964,35 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the configuration being retrieved. If needed, replace - * {namespace_id} with the project ID. + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Configurations$List + export interface Params$Resource$Namespaces$Triggers$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Triggers$List extends StandardParameters { /** * Auth client or API Key for the request @@ -4501,9 +4004,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -4511,8 +4012,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -4520,71 +4020,118 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the configurations should be - * listed. + * The project ID or project number from which the triggers should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } + export interface Params$Resource$Namespaces$Triggers$Replacetrigger + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - export class Resource$Projects$Locations$Domainmappings { + /** + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Trigger; + } + + export class Resource$Projects { context: APIRequestContext; + locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; + this.locations = new Resource$Projects$Locations(this.context); } + } - /** - * run.projects.locations.domainmappings.create - * @desc Creates a new domain mapping. - * @alias run.projects.locations.domainmappings.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this domain mapping should be created. - * @param {().DomainMapping} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Locations$Domainmappings$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Domainmappings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + export class Resource$Projects$Locations { + context: APIRequestContext; + authorizeddomains: Resource$Projects$Locations$Authorizeddomains; + configurations: Resource$Projects$Locations$Configurations; + domainmappings: Resource$Projects$Locations$Domainmappings; + revisions: Resource$Projects$Locations$Revisions; + routes: Resource$Projects$Locations$Routes; + services: Resource$Projects$Locations$Services; + triggers: Resource$Projects$Locations$Triggers; + constructor(context: APIRequestContext) { + this.context = context; + this.authorizeddomains = new Resource$Projects$Locations$Authorizeddomains( + this.context + ); + this.configurations = new Resource$Projects$Locations$Configurations( + this.context + ); + this.domainmappings = new Resource$Projects$Locations$Domainmappings( + this.context + ); + this.revisions = new Resource$Projects$Locations$Revisions(this.context); + this.routes = new Resource$Projects$Locations$Routes(this.context); + this.services = new Resource$Projects$Locations$Services(this.context); + this.triggers = new Resource$Projects$Locations$Triggers(this.context); + } + + /** + * run.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias run.projects.locations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Domainmappings$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Create - | BodyResponseCallback, + | Params$Resource$Projects$Locations$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Create; + {}) as Params$Resource$Projects$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Create; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -4597,70 +4144,106 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + url: (rootUrl + '/v1alpha1/{+name}/locations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { /** - * run.projects.locations.domainmappings.delete - * @desc Rpc to delete a domain mapping. - * @alias run.projects.locations.domainmappings.delete + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Authorizeddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.authorizeddomains.list + * @desc RPC to list authorized domains. + * @alias run.projects.locations.authorizeddomains.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {integer=} params.pageSize Maximum results to return per page. + * @param {string=} params.pageToken Continuation token for fetching the next page of results. + * @param {string} params.parent Name of the parent Application resource. Example: `apps/myapp`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Projects$Locations$Domainmappings$Delete, + list( + params?: Params$Resource$Projects$Locations$Authorizeddomains$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Domainmappings$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizeddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Domainmappings$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Authorizeddomains$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Authorizeddomains$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Delete; + {}) as Params$Resource$Projects$Locations$Authorizeddomains$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Delete; + params = {} as Params$Resource$Projects$Locations$Authorizeddomains$List; options = {}; } @@ -4673,65 +4256,101 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha1/{+parent}/authorizeddomains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Authorizeddomains$List + extends StandardParameters { /** - * run.projects.locations.domainmappings.get - * @desc Rpc to get information about a domain mapping. - * @alias run.projects.locations.domainmappings.get + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum results to return per page. + */ + pageSize?: number; + /** + * Continuation token for fetching the next page of results. + */ + pageToken?: string; + /** + * Name of the parent Application resource. Example: `apps/myapp`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Configurations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.configurations.get + * @desc Rpc to get information about a configuration. + * @alias run.projects.locations.configurations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Domainmappings$Get, + params?: Params$Resource$Projects$Locations$Configurations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Domainmappings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Configurations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Domainmappings$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Configurations$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Get - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Configurations$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Get; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Get; + params = {} as Params$Resource$Projects$Locations$Configurations$Get; options = {}; } @@ -4755,16 +4374,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.domainmappings.list - * @desc Rpc to list domain mappings. - * @alias run.projects.locations.domainmappings.list + * run.projects.locations.configurations.list + * @desc Rpc to list configurations. + * @alias run.projects.locations.configurations.list * @memberOf! () * * @param {object} params Parameters for request @@ -4773,7 +4392,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. + * @param {string} params.parent The project ID or project number from which the configurations should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4781,39 +4400,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Domainmappings$List, + params?: Params$Resource$Projects$Locations$Configurations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Domainmappings$List, + params: Params$Resource$Projects$Locations$Configurations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Domainmappings$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Configurations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Configurations$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$List; + {}) as Params$Resource$Projects$Locations$Configurations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$List; + params = {} as Params$Resource$Projects$Locations$Configurations$List; options = {}; } @@ -4826,7 +4445,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + url: (rootUrl + '/v1alpha1/{+parent}/configurations').replace( /([^:]\/)\/+/g, '$1' ), @@ -4840,70 +4459,17 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Domainmappings$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The project ID or project number in which this domain mapping should be - * created. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DomainMapping; - } - export interface Params$Resource$Projects$Locations$Domainmappings$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Cloud Run currently ignores this parameter. - */ - apiVersion?: string; - /** - * Cloud Run currently ignores this parameter. - */ - kind?: string; - /** - * The name of the domain mapping being deleted. If needed, replace - * {namespace_id} with the project ID. - */ - name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only - * supports cascading behavior, so this must be false. This attribute is - * deprecated, and is now replaced with PropagationPolicy See - * https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores - * this setting, and deletes in the background. Please see - * kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for - * more information. - */ - propagationPolicy?: string; - } - export interface Params$Resource$Projects$Locations$Domainmappings$Get + export interface Params$Resource$Projects$Locations$Configurations$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -4911,12 +4477,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the domain mapping being retrieved. If needed, replace - * {namespace_id} with the project ID. + * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Domainmappings$List + export interface Params$Resource$Projects$Locations$Configurations$List extends StandardParameters { /** * Auth client or API Key for the request @@ -4928,9 +4493,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -4938,8 +4501,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -4947,38 +4509,110 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the domain mappings should be - * listed. + * The project ID or project number from which the configurations should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } - export class Resource$Projects$Locations$Revisions { + export class Resource$Projects$Locations$Domainmappings { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.revisions.delete - * @desc Rpc to delete a revision. - * @alias run.projects.locations.revisions.delete + * run.projects.locations.domainmappings.create + * @desc Creates a new domain mapping. + * @alias run.projects.locations.domainmappings.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this domain mapping should be created. + * @param {().DomainMapping} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Domainmappings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Domainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Domainmappings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.domainmappings.delete + * @desc Rpc to delete a domain mapping. + * @alias run.projects.locations.domainmappings.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4986,33 +4620,33 @@ export namespace run_v1alpha1 { * @return {object} Request object */ delete( - params?: Params$Resource$Projects$Locations$Revisions$Delete, + params?: Params$Resource$Projects$Locations$Domainmappings$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Revisions$Delete, + params: Params$Resource$Projects$Locations$Domainmappings$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Revisions$Delete, + params: Params$Resource$Projects$Locations$Domainmappings$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$Delete + | Params$Resource$Projects$Locations$Domainmappings$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$Delete; + {}) as Params$Resource$Projects$Locations$Domainmappings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$Delete; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Delete; options = {}; } @@ -5043,45 +4677,47 @@ export namespace run_v1alpha1 { } /** - * run.projects.locations.revisions.get - * @desc Rpc to get information about a revision. - * @alias run.projects.locations.revisions.get + * run.projects.locations.domainmappings.get + * @desc Rpc to get information about a domain mapping. + * @alias run.projects.locations.domainmappings.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Revisions$Get, + params?: Params$Resource$Projects$Locations$Domainmappings$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Revisions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Revisions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Domainmappings$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Domainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$Get; + {}) as Params$Resource$Projects$Locations$Domainmappings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$Get; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Get; options = {}; } @@ -5105,16 +4741,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.revisions.list - * @desc Rpc to list revisions. - * @alias run.projects.locations.revisions.list + * run.projects.locations.domainmappings.list + * @desc Rpc to list domain mappings. + * @alias run.projects.locations.domainmappings.list * @memberOf! () * * @param {object} params Parameters for request @@ -5123,7 +4759,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the revisions should be listed. + * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5131,37 +4767,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Revisions$List, + params?: Params$Resource$Projects$Locations$Domainmappings$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Revisions$List, + params: Params$Resource$Projects$Locations$Domainmappings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Revisions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Domainmappings$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Domainmappings$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$List; + {}) as Params$Resource$Projects$Locations$Domainmappings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$List; + params = {} as Params$Resource$Projects$Locations$Domainmappings$List; options = {}; } @@ -5174,7 +4812,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/revisions').replace( + url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( /([^:]\/)\/+/g, '$1' ), @@ -5188,14 +4826,34 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Revisions$Delete + export interface Params$Resource$Projects$Locations$Domainmappings$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this domain mapping should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DomainMapping; + } + export interface Params$Resource$Projects$Locations$Domainmappings$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -5211,26 +4869,19 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the revision being deleted. If needed, replace {namespace_id} - * with the project ID. + * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only - * supports cascading behavior, so this must be false. This attribute is - * deprecated, and is now replaced with PropagationPolicy See - * https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. */ orphanDependents?: boolean; /** - * Specifies the propagation policy of delete. Cloud Run currently ignores - * this setting, and deletes in the background. Please see - * kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for - * more information. + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Revisions$Get + export interface Params$Resource$Projects$Locations$Domainmappings$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -5238,12 +4889,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the revision being retrieved. If needed, replace - * {namespace_id} with the project ID. + * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Revisions$List + export interface Params$Resource$Projects$Locations$Domainmappings$List extends StandardParameters { /** * Auth client or API Key for the request @@ -5255,9 +4905,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -5265,8 +4913,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -5274,68 +4921,138 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the revisions should be - * listed. + * The project ID or project number from which the domain mappings should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } - export class Resource$Projects$Locations$Routes { + export class Resource$Projects$Locations$Revisions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.routes.get - * @desc Rpc to get information about a route. - * @alias run.projects.locations.routes.get + * run.projects.locations.revisions.delete + * @desc Rpc to delete a revision. + * @alias run.projects.locations.revisions.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Revisions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Revisions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Revisions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Revisions$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Revisions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Revisions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.revisions.get + * @desc Rpc to get information about a revision. + * @alias run.projects.locations.revisions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Routes$Get, + params?: Params$Resource$Projects$Locations$Revisions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Routes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Revisions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Routes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Revisions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Routes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Revisions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Routes$Get; + {}) as Params$Resource$Projects$Locations$Revisions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Routes$Get; + params = {} as Params$Resource$Projects$Locations$Revisions$Get; options = {}; } @@ -5359,16 +5076,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.routes.list - * @desc Rpc to list routes. - * @alias run.projects.locations.routes.list + * run.projects.locations.revisions.list + * @desc Rpc to list revisions. + * @alias run.projects.locations.revisions.list * @memberOf! () * * @param {object} params Parameters for request @@ -5377,7 +5094,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the routes should be listed. + * @param {string} params.parent The project ID or project number from which the revisions should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5385,35 +5102,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Routes$List, + params?: Params$Resource$Projects$Locations$Revisions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Routes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Revisions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Routes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Revisions$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Routes$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Revisions$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Routes$List; + {}) as Params$Resource$Projects$Locations$Revisions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Routes$List; + params = {} as Params$Resource$Projects$Locations$Revisions$List; options = {}; } @@ -5426,7 +5145,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/routes').replace( + url: (rootUrl + '/v1alpha1/{+parent}/revisions').replace( /([^:]\/)\/+/g, '$1' ), @@ -5440,14 +5159,42 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Routes$Get + export interface Params$Resource$Projects$Locations$Revisions$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Revisions$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -5455,12 +5202,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the route being retrieved. If needed, replace {namespace_id} - * with the project ID. + * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Routes$List + export interface Params$Resource$Projects$Locations$Revisions$List extends StandardParameters { /** * Auth client or API Key for the request @@ -5472,9 +5218,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -5482,8 +5226,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -5491,32 +5234,240 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the routes should be listed. + * The project ID or project number from which the revisions should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } - export class Resource$Projects$Locations$Services { + export class Resource$Projects$Locations$Routes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.services.create - * @desc Rpc to create a service. - * @alias run.projects.locations.services.create - * @memberOf! () + * run.projects.locations.routes.get + * @desc Rpc to get information about a route. + * @alias run.projects.locations.routes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Routes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Routes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Routes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.routes.list + * @desc Rpc to list routes. + * @alias run.projects.locations.routes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the routes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Routes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Routes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/routes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Routes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Routes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the routes should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Projects$Locations$Services { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.services.create + * @desc Rpc to create a service. + * @alias run.projects.locations.services.create + * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The project ID or project number in which this service should be created. @@ -5587,9 +5538,7 @@ export namespace run_v1alpha1 { /** * run.projects.locations.services.delete - * @desc Rpc to delete a service. This will cause the Service to stop - * serving traffic and will delete the child entities like Routes, - * Configurations and Revisions. + * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. * @alias run.projects.locations.services.delete * @memberOf! () * @@ -5731,8 +5680,7 @@ export namespace run_v1alpha1 { /** * run.projects.locations.services.getIamPolicy - * @desc Get the IAM Access Control policy currently in effect for the given - * Cloud Run service. This result does not include any inherited policies. + * @desc Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies. * @alias run.projects.locations.services.getIamPolicy * @memberOf! () * @@ -5764,12 +5712,561 @@ export namespace run_v1alpha1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Services$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.list + * @desc Rpc to list services. + * @alias run.projects.locations.services.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the services should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Services$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Services$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/services').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.replaceService + * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.services.replaceService + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + * @param {().Service} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceService( + params?: Params$Resource$Projects$Locations$Services$Replaceservice, + options?: MethodOptions + ): GaxiosPromise; + replaceService( + params: Params$Resource$Projects$Locations$Services$Replaceservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceService( + params: Params$Resource$Projects$Locations$Services$Replaceservice, + callback: BodyResponseCallback + ): void; + replaceService(callback: BodyResponseCallback): void; + replaceService( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Replaceservice + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Replaceservice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Replaceservice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.setIamPolicy + * @desc Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. + * @alias run.projects.locations.services.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Services$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.testIamPermissions + * @desc Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. + * @alias run.projects.locations.services.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Services$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Services$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this service should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + export interface Params$Resource$Projects$Locations$Services$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Services$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Services$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Services$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the services should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + export interface Params$Resource$Projects$Locations$Services$Replaceservice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + export interface Params$Resource$Projects$Locations$Services$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Services$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Triggers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.triggers.create + * @desc Creates a new trigger. + * @alias run.projects.locations.triggers.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this trigger should be created. + * @param {().Trigger} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Triggers$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Triggers$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Triggers$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Triggers$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Triggers$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Triggers$Create; options = {}; } @@ -5782,77 +6279,69 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1alpha1/{+parent}/triggers').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.list - * @desc Rpc to list services. - * @alias run.projects.locations.services.list + * run.projects.locations.triggers.delete + * @desc Rpc to delete a trigger. + * @alias run.projects.locations.triggers.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the services should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Services$List, + delete( + params?: Params$Resource$Projects$Locations$Triggers$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Services$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Triggers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Services$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Triggers$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Triggers$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$List; + {}) as Params$Resource$Projects$Locations$Triggers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$List; + params = {} as Params$Resource$Projects$Locations$Triggers$Delete; options = {}; } @@ -5865,71 +6354,63 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/services').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.replaceService - * @desc Rpc to replace a service. Only the spec and metadata labels and - * annotations are modifiable. After the Update request, Cloud Run will work - * to make the 'status' match the requested 'spec'. May provide - * metadata.resourceVersion to enforce update from last read for optimistic - * concurrency control. - * @alias run.projects.locations.services.replaceService + * run.projects.locations.triggers.get + * @desc Rpc to get information about a trigger. + * @alias run.projects.locations.triggers.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. - * @param {().Service} params.resource Request body data + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - replaceService( - params?: Params$Resource$Projects$Locations$Services$Replaceservice, + get( + params?: Params$Resource$Projects$Locations$Triggers$Get, options?: MethodOptions - ): GaxiosPromise; - replaceService( - params: Params$Resource$Projects$Locations$Services$Replaceservice, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Triggers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - replaceService( - params: Params$Resource$Projects$Locations$Services$Replaceservice, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Triggers$Get, + callback: BodyResponseCallback ): void; - replaceService(callback: BodyResponseCallback): void; - replaceService( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Replaceservice - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Triggers$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Replaceservice; + {}) as Params$Resource$Projects$Locations$Triggers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Replaceservice; + params = {} as Params$Resource$Projects$Locations$Triggers$Get; options = {}; } @@ -5943,7 +6424,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'GET', }, options ), @@ -5953,54 +6434,63 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.setIamPolicy - * @desc Sets the IAM Access control policy for the specified Service. - * Overwrites any existing policy. - * @alias run.projects.locations.services.setIamPolicy + * run.projects.locations.triggers.list + * @desc Rpc to list triggers. + * @alias run.projects.locations.triggers.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the triggers should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Services$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Triggers$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Services$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Triggers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Services$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Triggers$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Triggers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Triggers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Triggers$List; options = {}; } @@ -6013,74 +6503,67 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1alpha1/{+parent}/triggers').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.testIamPermissions - * @desc Returns permissions that a caller has on the specified Project. - * There are no permissions required for making this API call. - * @alias run.projects.locations.services.testIamPermissions + * run.projects.locations.triggers.replaceTrigger + * @desc Rpc to replace a trigger. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.triggers.replaceTrigger * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().Trigger} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Services$Testiampermissions, + replaceTrigger( + params?: Params$Resource$Projects$Locations$Triggers$Replacetrigger, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Services$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Services$Testiampermissions, - callback: BodyResponseCallback + ): GaxiosPromise; + replaceTrigger( + params: Params$Resource$Projects$Locations$Triggers$Replacetrigger, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + replaceTrigger( + params: Params$Resource$Projects$Locations$Triggers$Replacetrigger, + callback: BodyResponseCallback ): void; - testIamPermissions( + replaceTrigger(callback: BodyResponseCallback): void; + replaceTrigger( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Triggers$Replacetrigger + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Triggers$Replacetrigger; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Triggers$Replacetrigger; options = {}; } @@ -6093,31 +6576,25 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Services$Create + export interface Params$Resource$Projects$Locations$Triggers$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -6125,16 +6602,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this service should be created. + * The project ID or project number in which this trigger should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$Service; + requestBody?: Schema$Trigger; } - export interface Params$Resource$Projects$Locations$Services$Delete + export interface Params$Resource$Projects$Locations$Triggers$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -6150,26 +6627,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the service being deleted. If needed, replace {namespace_id} - * with the project ID. + * The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only - * supports cascading behavior, so this must be false. This attribute is - * deprecated, and is now replaced with PropagationPolicy See - * https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores - * this setting, and deletes in the background. Please see - * kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for - * more information. + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Services$Get + export interface Params$Resource$Projects$Locations$Triggers$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -6177,25 +6643,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being retrieved. If needed, replace - * {namespace_id} with the project ID. + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Services$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Services$List + export interface Params$Resource$Projects$Locations$Triggers$List extends StandardParameters { /** * Auth client or API Key for the request @@ -6207,9 +6659,7 @@ export namespace run_v1alpha1 { */ continue?: string; /** - * Allows to filter resources based on a specific value for a field name. - * Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not - * currently used by Cloud Run. + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ fieldSelector?: string; /** @@ -6217,8 +6667,7 @@ export namespace run_v1alpha1 { */ includeUninitialized?: boolean; /** - * Allows to filter resources based on a label. Supported operations are =, - * !=, exists, in, and notIn. + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. */ labelSelector?: string; /** @@ -6226,22 +6675,19 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the services should be - * listed. + * The project ID or project number from which the triggers should be listed. */ parent?: string; /** - * The baseline resource version from which the list or watch operation - * should start. Not currently used by Cloud Run. + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. */ resourceVersion?: string; /** - * Flag that indicates that the client expects to watch this resource as - * well. Not currently used by Cloud Run. + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. */ watch?: boolean; } - export interface Params$Resource$Projects$Locations$Services$Replaceservice + export interface Params$Resource$Projects$Locations$Triggers$Replacetrigger extends StandardParameters { /** * Auth client or API Key for the request @@ -6249,50 +6695,13 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being replaced. If needed, replace {namespace_id} - * with the project ID. + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$Service; - } - export interface Params$Resource$Projects$Locations$Services$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Services$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$Trigger; } } diff --git a/src/apis/runtimeconfig/package.json b/src/apis/runtimeconfig/package.json index 84674cb1184..5c2be98581c 100644 --- a/src/apis/runtimeconfig/package.json +++ b/src/apis/runtimeconfig/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/runtimeconfig/v1.ts b/src/apis/runtimeconfig/v1.ts index 1928060595b..ce27d49a297 100644 --- a/src/apis/runtimeconfig/v1.ts +++ b/src/apis/runtimeconfig/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace runtimeconfig_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace runtimeconfig_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,10 +91,7 @@ export namespace runtimeconfig_v1 { /** * Cloud Runtime Configuration API * - * The Runtime Configurator allows you to dynamically configure and expose - * variables through Google Cloud Platform. In addition, you can also set - * Watchers and Waiters that will watch for changes to your data and return - * based on certain conditions. + * The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions. * * @example * const {google} = require('googleapis'); @@ -115,7 +108,10 @@ export namespace runtimeconfig_v1 { operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); } @@ -126,11 +122,7 @@ export namespace runtimeconfig_v1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -147,14 +139,11 @@ export namespace runtimeconfig_v1 { operations?: Schema$Operation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -162,64 +151,20 @@ export namespace runtimeconfig_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -227,14 +172,11 @@ export namespace runtimeconfig_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -247,15 +189,7 @@ export namespace runtimeconfig_v1 { /** * runtimeconfig.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias runtimeconfig.operations.cancel * @memberOf! () * @@ -326,10 +260,7 @@ export namespace runtimeconfig_v1 { /** * runtimeconfig.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias runtimeconfig.operations.delete * @memberOf! () * @@ -399,15 +330,7 @@ export namespace runtimeconfig_v1 { /** * runtimeconfig.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias runtimeconfig.operations.list * @memberOf! () * diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index e5faf1a67f6..a0bd3d04e13 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace runtimeconfig_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace runtimeconfig_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,10 +91,7 @@ export namespace runtimeconfig_v1beta1 { /** * Cloud Runtime Configuration API * - * The Runtime Configurator allows you to dynamically configure and expose - * variables through Google Cloud Platform. In addition, you can also set - * Watchers and Waiters that will watch for changes to your data and return - * based on certain conditions. + * The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions. * * @example * const {google} = require('googleapis'); @@ -115,7 +108,10 @@ export namespace runtimeconfig_v1beta1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -126,49 +122,24 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A Cardinality condition for the Waiter resource. A cardinality condition is - * met when the number of variables under a specified path prefix reaches a - * predefined number. For example, if you set a Cardinality condition where - * the `path` is set to `/foo` and the number of paths is set to `2`, the - * following variables would meet the condition in a RuntimeConfig resource: - * + `/foo/variable1 = "value1"` + `/foo/variable2 = - * "value2"` + `/bar/variable3 = "value3"` It would not - * satisfy the same condition with the `number` set to `3`, however, because - * there is only 2 paths that start with `/foo`. Cardinality conditions are - * recursive; all subtrees under the specific path prefix are counted. + * A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to `2`, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = "value1"` + `/foo/variable2 = "value2"` + `/bar/variable3 = "value3"` It would not satisfy the same condition with the `number` set to `3`, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted. */ export interface Schema$Cardinality { /** - * The number variables under the `path` that must exist to meet this - * condition. Defaults to 1 if not specified. + * The number variables under the `path` that must exist to meet this condition. Defaults to 1 if not specified. */ number?: number; /** @@ -177,11 +148,7 @@ export namespace runtimeconfig_v1beta1 { path?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -194,50 +161,36 @@ export namespace runtimeconfig_v1beta1 { cardinality?: Schema$Cardinality; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * `ListConfigs()` returns the following response. The order of returned - * objects is arbitrary; that is, it is not ordered in any particular way. + * `ListConfigs()` returns the following response. The order of returned objects is arbitrary; that is, it is not ordered in any particular way. */ export interface Schema$ListConfigsResponse { /** - * A list of the configurations in the project. The order of returned - * objects is arbitrary; that is, it is not ordered in any particular way. + * A list of the configurations in the project. The order of returned objects is arbitrary; that is, it is not ordered in any particular way. */ configs?: Schema$RuntimeConfig[]; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; } @@ -246,30 +199,20 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$ListVariablesResponse { /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; /** - * A list of variables and their values. The order of returned variable - * objects is arbitrary. + * A list of variables and their values. The order of returned variable objects is arbitrary. */ variables?: Schema$Variable[]; } /** - * Response for the `ListWaiters()` method. Order of returned waiter objects - * is arbitrary. + * Response for the `ListWaiters()` method. Order of returned waiter objects is arbitrary. */ export interface Schema$ListWaitersResponse { /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; /** @@ -278,14 +221,11 @@ export namespace runtimeconfig_v1beta1 { waiters?: Schema$Waiter[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -293,65 +233,28 @@ export namespace runtimeconfig_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -360,9 +263,7 @@ export namespace runtimeconfig_v1beta1 { version?: number; } /** - * A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig - * service. A RuntimeConfig resource consists of metadata and a hierarchy of - * variables. + * A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. A RuntimeConfig resource consists of metadata and a hierarchy of variables. */ export interface Schema$RuntimeConfig { /** @@ -370,14 +271,7 @@ export namespace runtimeconfig_v1beta1 { */ description?: string; /** - * The resource name of a runtime config. The name must have the format: - * projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a - * valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches - * the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular - * expression. The length of `[CONFIG_NAME]` must be less than 64 - * characters. You pick the RuntimeConfig resource name, but the server - * will validate that the name adheres to this format. After you create the - * resource, you cannot change the resource's name. + * The resource name of a runtime config. The name must have the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression. The length of `[CONFIG_NAME]` must be less than 64 characters. You pick the RuntimeConfig resource name, but the server will validate that the name adheres to this format. After you create the resource, you cannot change the resource's name. */ name?: string; } @@ -386,48 +280,12 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -435,14 +293,11 @@ export namespace runtimeconfig_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -451,10 +306,7 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -463,124 +315,65 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * Describes a single variable within a RuntimeConfig resource. The name - * denotes the hierarchical variable name. For example, `ports/serving_port` - * is a valid variable name. The variable value is an opaque string and only - * leaf variables can have values (that is, variables that do not have any - * child variables). + * Describes a single variable within a RuntimeConfig resource. The name denotes the hierarchical variable name. For example, `ports/serving_port` is a valid variable name. The variable value is an opaque string and only leaf variables can have values (that is, variables that do not have any child variables). */ export interface Schema$Variable { /** - * The name of the variable resource, in the format: - * projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The - * `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a - * valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file - * system file path naming. The `[VARIABLE_NAME]` can contain ASCII - * letters, numbers, slashes and dashes. Slashes are used as path element - * separators and are not part of the `[VARIABLE_NAME]` itself, so - * `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple - * slashes are coalesced into single slash character. Each path segment - * should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular - * expression. The length of a `[VARIABLE_NAME]` must be less than 256 - * characters. Once you create a variable, you cannot change the variable - * name. + * The name of the variable resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system file path naming. The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression. The length of a `[VARIABLE_NAME]` must be less than 256 characters. Once you create a variable, you cannot change the variable name. */ name?: string; /** - * Output only. The current state of the variable. The variable state - * indicates the outcome of the `variables().watch` call and is visible - * through the `get` and `list` calls. + * Output only. The current state of the variable. The variable state indicates the outcome of the `variables().watch` call and is visible through the `get` and `list` calls. */ state?: string; /** - * The string value of the variable. The length of the value must be less - * than 4096 bytes. Empty values are also accepted. For example, `text: - * "my text value"`. The string must be valid UTF-8. + * The string value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. For example, `text: "my text value"`. The string must be valid UTF-8. */ text?: string; /** - * Output only. The time of the last variable update. Timestamp will be UTC - * timestamp. + * Output only. The time of the last variable update. Timestamp will be UTC timestamp. */ updateTime?: string; /** - * The binary value of the variable. The length of the value must be less - * than 4096 bytes. Empty values are also accepted. The value must be base64 - * encoded, and must comply with IETF RFC4648 - * (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text` can - * be set. + * The binary value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. The value must be base64 encoded, and must comply with IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text` can be set. */ value?: string; } /** - * A Waiter resource waits for some end condition within a RuntimeConfig - * resource to be met before it returns. For example, assume you have a - * distributed system where each node writes to a Variable resource indicating - * the node's readiness as part of the startup process. You then - * configure a Waiter resource with the success condition set to wait until - * some number of nodes have checked in. Afterwards, your application runs - * some arbitrary code after the condition has been met and the waiter returns - * successfully. Once created, a Waiter resource is immutable. To learn more - * about using waiters, read the [Creating a - * Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) - * documentation. + * A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) documentation. */ export interface Schema$Waiter { /** - * Output only. The instant at which this Waiter resource was created. - * Adding the value of `timeout` to this instant yields the timeout deadline - * for the waiter. + * Output only. The instant at which this Waiter resource was created. Adding the value of `timeout` to this instant yields the timeout deadline for the waiter. */ createTime?: string; /** - * Output only. If the value is `false`, it means the waiter is still - * waiting for one of its conditions to be met. If true, the waiter has - * finished. If the waiter finished due to a timeout or failure, `error` - * will be set. + * Output only. If the value is `false`, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, `error` will be set. */ done?: boolean; /** - * Output only. If the waiter ended due to a failure or timeout, this value - * will be set. + * Output only. If the waiter ended due to a failure or timeout, this value will be set. */ error?: Schema$Status; /** - * [Optional] The failure condition of this waiter. If this condition is - * met, `done` will be set to `true` and the `error` code will be set to - * `ABORTED`. The failure condition takes precedence over the success - * condition. If both conditions are met, a failure will be indicated. This - * value is optional; if no failure condition is set, the only failure - * scenario will be a timeout. + * [Optional] The failure condition of this waiter. If this condition is met, `done` will be set to `true` and the `error` code will be set to `ABORTED`. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated. This value is optional; if no failure condition is set, the only failure scenario will be a timeout. */ failure?: Schema$EndCondition; /** - * The name of the Waiter resource, in the format: - * projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The - * `[PROJECT_ID]` must be a valid Google Cloud project ID, the - * `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the - * `[WAITER_NAME]` must match RFC 1035 segment specification, and the length - * of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter - * resource, you cannot change the resource name. + * The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC 1035 segment specification, and the length of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name. */ name?: string; /** - * [Required] The success condition. If this condition is met, `done` will - * be set to `true` and the `error` value will remain unset. The failure - * condition takes precedence over the success condition. If both conditions - * are met, a failure will be indicated. + * [Required] The success condition. If this condition is met, `done` will be set to `true` and the `error` value will remain unset. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated. */ success?: Schema$EndCondition; /** - * [Required] Specifies the timeout of the waiter in seconds, beginning from - * the instant that `waiters().create` method is called. If this time - * elapses before the success or failure conditions are met, the waiter - * fails and sets the `error` code to `DEADLINE_EXCEEDED`. + * [Required] Specifies the timeout of the waiter in seconds, beginning from the instant that `waiters().create` method is called. If this time elapses before the success or failure conditions are met, the waiter fails and sets the `error` code to `DEADLINE_EXCEEDED`. */ timeout?: string; } @@ -589,10 +382,7 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$WatchVariableRequest { /** - * If specified, checks the current timestamp of the variable and if the - * current timestamp is newer than `newerThan` timestamp, the method returns - * immediately. If not specified or the variable has an older timestamp, - * the watcher waits for a the value to change before returning. + * If specified, checks the current timestamp of the variable and if the current timestamp is newer than `newerThan` timestamp, the method returns immediately. If not specified or the variable has an older timestamp, the watcher waits for a the value to change before returning. */ newerThan?: string; } @@ -620,8 +410,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.create - * @desc Creates a new RuntimeConfig resource. The configuration name must - * be unique within project. + * @desc Creates a new RuntimeConfig resource. The configuration name must be unique within project. * @alias runtimeconfig.projects.configs.create * @memberOf! () * @@ -840,8 +629,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias runtimeconfig.projects.configs.getIamPolicy * @memberOf! () * @@ -991,8 +779,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias runtimeconfig.projects.configs.setIamPolicy * @memberOf! () * @@ -1066,11 +853,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.testIamPermissions * @memberOf! () * @@ -1153,8 +936,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.update - * @desc Updates a RuntimeConfig resource. The configuration must exist - * beforehand. + * @desc Updates a RuntimeConfig resource. The configuration must exist beforehand. * @alias runtimeconfig.projects.configs.update * @memberOf! () * @@ -1234,18 +1016,11 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [project - * ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) - * for this request, in the format `projects/[PROJECT_ID]`. + * The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`. */ parent?: string; /** - * An optional but recommended unique `request_id`. If the server receives - * two `create()` requests with the same `request_id`, then the second - * request will be ignored and the first resource created and stored in the - * backend is returned. Empty `request_id` fields are ignored. It is - * responsibility of the client to ensure uniqueness of the `request_id` - * strings. `request_id` strings are limited to 64 characters. + * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. */ requestId?: string; @@ -1262,8 +1037,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The RuntimeConfig resource to delete, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; } @@ -1275,8 +1049,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the RuntimeConfig resource to retrieve, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; } @@ -1288,8 +1061,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1301,19 +1073,15 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** - * The [project - * ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) - * for this request, in the format `projects/[PROJECT_ID]`. + * The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`. */ parent?: string; } @@ -1325,8 +1093,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1343,8 +1110,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1361,8 +1127,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the RuntimeConfig resource to update, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; @@ -1380,9 +1145,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias runtimeconfig.projects.configs.operations.get * @memberOf! () * @@ -1454,11 +1217,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.operations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.operations.testIamPermissions * @memberOf! () * @@ -1560,8 +1319,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1579,12 +1337,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.create - * @desc Creates a variable within the given configuration. You cannot - * create a variable with a name that is a prefix of an existing variable - * name, or a name that has an existing variable name as a prefix. To learn - * more about creating a variable, read the [Setting and Getting - * Data](/deployment-manager/runtime-configurator/set-and-get-variables) - * documentation. + * @desc Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the [Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables) documentation. * @alias runtimeconfig.projects.configs.variables.create * @memberOf! () * @@ -1659,10 +1412,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.delete - * @desc Deletes a variable or multiple variables. If you specify a - * variable name, then that variable is deleted. If you specify a prefix and - * `recursive` is true, then all variables with that prefix are deleted. You - * must set a `recursive` to true if you delete variables by prefix. + * @desc Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and `recursive` is true, then all variables with that prefix are deleted. You must set a `recursive` to true if you delete variables by prefix. * @alias runtimeconfig.projects.configs.variables.delete * @memberOf! () * @@ -1803,10 +1553,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.list - * @desc Lists variables within given a configuration, matching any provided - * filters. This only lists variable names, not the values, unless - * `return_values` is true, in which case only variables that user has IAM - * permission to GetVariable will be returned. + * @desc Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values, unless `return_values` is true, in which case only variables that user has IAM permission to GetVariable will be returned. * @alias runtimeconfig.projects.configs.variables.list * @memberOf! () * @@ -1887,11 +1634,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.variables.testIamPermissions * @memberOf! () * @@ -2045,16 +1788,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.watch - * @desc Watches a specific variable and waits for a change in the - * variable's value. When there is a change, this method returns the new - * value or times out. If a variable is deleted while being watched, the - * `variableState` state is set to `DELETED` and the method returns the last - * known variable `value`. If you set the deadline for watching to a larger - * value than internal timeout (60 seconds), the current variable value is - * returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To - * learn more about creating a watcher, read the [Watching a Variable for - * Changes](/deployment-manager/runtime-configurator/watching-a-variable) - * documentation. + * @desc Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the `variableState` state is set to `DELETED` and the method returns the last known variable `value`. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To learn more about creating a watcher, read the [Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable) documentation. * @alias runtimeconfig.projects.configs.variables.watch * @memberOf! () * @@ -2135,18 +1869,11 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path to the RutimeConfig resource that this variable should belong - * to. The configuration must exist beforehand; the path must be in the - * format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ parent?: string; /** - * An optional but recommended unique `request_id`. If the server receives - * two `create()` requests with the same `request_id`, then the second - * request will be ignored and the first resource created and stored in the - * backend is returned. Empty `request_id` fields are ignored. It is - * responsibility of the client to ensure uniqueness of the `request_id` - * strings. `request_id` strings are limited to 64 characters. + * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. */ requestId?: string; @@ -2163,13 +1890,11 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the variable to delete, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` */ name?: string; /** - * Set to `true` to recursively delete multiple variables with the same - * prefix. + * Set to `true` to recursively delete multiple variables with the same prefix. */ recursive?: boolean; } @@ -2181,8 +1906,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the variable to return, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` + * The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` */ name?: string; } @@ -2194,30 +1918,23 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Filters variables by matching the specified filter. For example: - * `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. + * Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`. */ filter?: string; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** - * The path to the RuntimeConfig resource for which you want to list - * variables. The configuration must exist beforehand; the path must be in - * the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ parent?: string; /** - * The flag indicates whether the user wants to return values of variables. - * If true, then only those variables that user has IAM GetVariable - * permission will be returned along with their values. + * The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values. */ returnValues?: boolean; } @@ -2229,8 +1946,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2247,8 +1963,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the variable to update, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` + * The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` */ name?: string; @@ -2265,8 +1980,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the variable to watch, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ name?: string; @@ -2284,12 +1998,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.waiters.create - * @desc Creates a Waiter resource. This operation returns a long-running - * Operation resource which can be polled for completion. However, a waiter - * with the given name will exist (and can be retrieved) prior to the - * operation completing. If the operation fails, the failed Waiter resource - * will still exist and must be deleted prior to subsequent creation - * attempts. + * @desc Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts. * @alias runtimeconfig.projects.configs.waiters.create * @memberOf! () * @@ -2583,11 +2292,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.waiters.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.waiters.testIamPermissions * @memberOf! () * @@ -2677,18 +2382,11 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path to the configuration that will own the waiter. The configuration - * must exist beforehand; the path must be in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. + * The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`. */ parent?: string; /** - * An optional but recommended unique `request_id`. If the server receives - * two `create()` requests with the same `request_id`, then the second - * request will be ignored and the first resource created and stored in the - * backend is returned. Empty `request_id` fields are ignored. It is - * responsibility of the client to ensure uniqueness of the `request_id` - * strings. `request_id` strings are limited to 64 characters. + * An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters. */ requestId?: string; @@ -2705,8 +2403,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The Waiter resource to delete, in the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` */ name?: string; } @@ -2718,9 +2415,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fully-qualified name of the Waiter resource object to retrieve, in - * the format: - * `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` + * The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]` */ name?: string; } @@ -2732,19 +2427,15 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** - * The path to the configuration for which you want to get a list of - * waiters. The configuration must exist beforehand; the path must be in the - * format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` + * The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]` */ parent?: string; } @@ -2756,8 +2447,7 @@ export namespace runtimeconfig_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/safebrowsing/package.json b/src/apis/safebrowsing/package.json index 09f4ca26082..d9463b895de 100644 --- a/src/apis/safebrowsing/package.json +++ b/src/apis/safebrowsing/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/safebrowsing/v4.ts b/src/apis/safebrowsing/v4.ts index 8559bef4fda..e4a8368fcad 100644 --- a/src/apis/safebrowsing/v4.ts +++ b/src/apis/safebrowsing/v4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace safebrowsing_v4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace safebrowsing_v4 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace safebrowsing_v4 { /** * Safe Browsing API * - * Enables client applications to check web resources (most commonly URLs) - * against Google-generated lists of unsafe web resources. + * Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. * * @example * const {google} = require('googleapis'); @@ -119,7 +114,10 @@ export namespace safebrowsing_v4 { threatMatches: Resource$Threatmatches; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.encodedFullHashes = new Resource$Encodedfullhashes(this.context); this.encodedUpdates = new Resource$Encodedupdates(this.context); @@ -136,8 +134,7 @@ export namespace safebrowsing_v4 { */ export interface Schema$Checksum { /** - * The SHA256 hash of the client state; that is, of the sorted list of all - * hashes present in the database. + * The SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database. */ sha256?: string; } @@ -146,8 +143,7 @@ export namespace safebrowsing_v4 { */ export interface Schema$ClientInfo { /** - * A client ID that (hopefully) uniquely identifies the client - * implementation of the Safe Browsing API. + * A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API. */ clientId?: string; /** @@ -160,31 +156,23 @@ export namespace safebrowsing_v4 { */ export interface Schema$Constraints { /** - * A client's physical location, expressed as a ISO 31166-1 alpha-2 - * region code. + * A client's physical location, expressed as a ISO 31166-1 alpha-2 region code. */ deviceLocation?: string; /** - * Requests the lists for a specific language. Expects ISO 639 alpha-2 - * format. + * Requests the lists for a specific language. Expects ISO 639 alpha-2 format. */ language?: string; /** - * Sets the maximum number of entries that the client is willing to have in - * the local database. This should be a power of 2 between 2**10 and 2**20. - * If zero, no database size limit is set. + * Sets the maximum number of entries that the client is willing to have in the local database. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set. */ maxDatabaseEntries?: number; /** - * The maximum size in number of entries. The update will not contain more - * entries than this value. This should be a power of 2 between 2**10 and - * 2**20. If zero, no update size limit is set. + * The maximum size in number of entries. The update will not contain more entries than this value. This should be a power of 2 between 2**10 and 2**20. If zero, no update size limit is set. */ maxUpdateEntries?: number; /** - * Requests the list for a specific geographic location. If not set the - * server may pick that value based on the user's IP address. Expects - * ISO 3166-1 alpha-2 format. + * Requests the list for a specific geographic location. If not set the server may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2 format. */ region?: string; /** @@ -193,17 +181,11 @@ export namespace safebrowsing_v4 { supportedCompressions?: string[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Describes a Safe Browsing API update request. Clients can request updates - * for multiple lists in a single request. NOTE: Field index 2 is unused. - * NEXT: 5 + * Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. NOTE: Field index 2 is unused. NEXT: 5 */ export interface Schema$FetchThreatListUpdatesRequest { /** @@ -221,9 +203,7 @@ export namespace safebrowsing_v4 { */ listUpdateResponses?: Schema$ListUpdateResponse[]; /** - * The minimum duration the client must wait before issuing any update - * request. If this field is not set clients may update as soon as they - * want. + * The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want. */ minimumWaitDuration?: string; } @@ -232,8 +212,7 @@ export namespace safebrowsing_v4 { */ export interface Schema$FindFullHashesRequest { /** - * Client metadata associated with callers of higher-level APIs built on top - * of the client's implementation. + * Client metadata associated with callers of higher-level APIs built on top of the client's implementation. */ apiClient?: Schema$ClientInfo; /** @@ -241,8 +220,7 @@ export namespace safebrowsing_v4 { */ client?: Schema$ClientInfo; /** - * The current client states for each of the client's local threat - * lists. + * The current client states for each of the client's local threat lists. */ clientStates?: string[]; /** @@ -256,14 +234,11 @@ export namespace safebrowsing_v4 { */ matches?: Schema$ThreatMatch[]; /** - * The minimum duration the client must wait before issuing any find hashes - * request. If this field is not set, clients can issue a request as soon as - * they want. + * The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want. */ minimumWaitDuration?: string; /** - * For requested entities that did not match the threat list, how long to - * cache the response. + * For requested entities that did not match the threat list, how long to cache the response. */ negativeCacheDuration?: string; } @@ -305,8 +280,7 @@ export namespace safebrowsing_v4 { */ platformType?: string; /** - * The current state of the client for the requested list (the encrypted - * client state that was received from the last successful list update). + * The current state of the client for the requested list (the encrypted client state that was received from the last successful list update). */ state?: string; /** @@ -323,16 +297,11 @@ export namespace safebrowsing_v4 { */ export interface Schema$ListUpdateResponse { /** - * A set of entries to add to a local threat type's list. Repeated to - * allow for a combination of compressed and raw data to be sent in a single - * response. + * A set of entries to add to a local threat type's list. Repeated to allow for a combination of compressed and raw data to be sent in a single response. */ additions?: Schema$ThreatEntrySet[]; /** - * The expected SHA256 hash of the client state; that is, of the sorted list - * of all hashes present in the database after applying the provided update. - * If the client state doesn't match the expected state, the client must - * disregard this update and retry later. + * The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided update. If the client state doesn't match the expected state, the client must disregard this update and retry later. */ checksum?: Schema$Checksum; /** @@ -344,13 +313,11 @@ export namespace safebrowsing_v4 { */ platformType?: string; /** - * A set of entries to remove from a local threat type's list. In - * practice, this field is empty or contains exactly one ThreatEntrySet. + * A set of entries to remove from a local threat type's list. In practice, this field is empty or contains exactly one ThreatEntrySet. */ removals?: Schema$ThreatEntrySet[]; /** - * The type of response. This may indicate that an action is required by the - * client when the response is received. + * The type of response. This may indicate that an action is required by the client when the response is received. */ responseType?: string; /** @@ -376,23 +343,15 @@ export namespace safebrowsing_v4 { value?: string; } /** - * The uncompressed threat entries in hash format of a particular prefix - * length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority - * are 4 bytes, but some hashes are lengthened if they collide with the hash - * of a popular URL. Used for sending ThreatEntrySet to clients that do not - * support compression, or when sending non-4-byte hashes to clients that do - * support compression. + * The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression. */ export interface Schema$RawHashes { /** - * The number of bytes for each prefix encoded below. This field can be - * anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). + * The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). */ prefixSize?: number; /** - * The hashes, in binary format, concatenated into one long string. Hashes - * are sorted in lexicographic order. For JSON API users, hashes are - * base64-encoded. + * The hashes, in binary format, concatenated into one long string. Hashes are sorted in lexicographic order. For JSON API users, hashes are base64-encoded. */ rawHashes?: string; } @@ -406,8 +365,7 @@ export namespace safebrowsing_v4 { indices?: number[]; } /** - * The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or - * compressed removal indices. + * The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices. */ export interface Schema$RiceDeltaEncoding { /** @@ -415,37 +373,28 @@ export namespace safebrowsing_v4 { */ encodedData?: string; /** - * The offset of the first entry in the encoded data, or, if only a single - * integer was encoded, that single integer's value. If the field is - * empty or missing, assume zero. + * The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value. If the field is empty or missing, assume zero. */ firstValue?: string; /** - * The number of entries that are delta encoded in the encoded data. If only - * a single integer was encoded, this will be zero and the single value will - * be stored in `first_value`. + * The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`. */ numEntries?: number; /** - * The Golomb-Rice parameter, which is a number between 2 and 28. This field - * is missing (that is, zero) if `num_entries` is zero. + * The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero. */ riceParameter?: number; } /** - * An individual threat; for example, a malicious URL or its hash - * representation. Only one of these fields should be set. + * An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. */ export interface Schema$ThreatEntry { /** - * The digest of an executable in SHA256 format. The API supports both - * binary and hex digests. For JSON requests, digests are base64-encoded. + * The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded. */ digest?: string; /** - * A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 - * hash. This field is in binary format. For JSON requests, hashes are - * base64-encoded. + * A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded. */ hash?: string; /** @@ -454,9 +403,7 @@ export namespace safebrowsing_v4 { url?: string; } /** - * The metadata associated with a specific threat entry. The client is - * expected to know the metadata key/value pairs associated with each threat - * type. + * The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type. */ export interface Schema$ThreatEntryMetadata { /** @@ -465,8 +412,7 @@ export namespace safebrowsing_v4 { entries?: Schema$MetadataEntry[]; } /** - * A set of threats that should be added or removed from a client's local - * database. + * A set of threats that should be added or removed from a client's local database. */ export interface Schema$ThreatEntrySet { /** @@ -482,16 +428,11 @@ export namespace safebrowsing_v4 { */ rawIndices?: Schema$RawIndices; /** - * The encoded 4-byte prefixes of SHA256-formatted entries, using a - * Golomb-Rice encoding. The hashes are converted to uint32, sorted in - * ascending order, then delta encoded and stored as encoded_data. + * The encoded 4-byte prefixes of SHA256-formatted entries, using a Golomb-Rice encoding. The hashes are converted to uint32, sorted in ascending order, then delta encoded and stored as encoded_data. */ riceHashes?: Schema$RiceDeltaEncoding; /** - * The encoded local, lexicographically-sorted list indices, using a - * Golomb-Rice encoding. Used for sending compressed removal indices. The - * removal indices (uint32) are sorted in ascending order, then delta - * encoded and stored as encoded_data. + * The encoded local, lexicographically-sorted list indices, using a Golomb-Rice encoding. Used for sending compressed removal indices. The removal indices (uint32) are sorted in ascending order, then delta encoded and stored as encoded_data. */ riceIndices?: Schema$RiceDeltaEncoding; } @@ -501,8 +442,7 @@ export namespace safebrowsing_v4 { */ clientInfo?: Schema$ClientInfo; /** - * The threat entry responsible for the hit. Full hash should be reported - * for hash-based hits. + * The threat entry responsible for the hit. Full hash should be reported for hash-based hits. */ entry?: Schema$ThreatEntry; /** @@ -523,8 +463,7 @@ export namespace safebrowsing_v4 { userInfo?: Schema$UserInfo; } /** - * The information regarding one or more threats that a client submits when - * checking for matches in threat lists. + * The information regarding one or more threats that a client submits when checking for matches in threat lists. */ export interface Schema$ThreatInfo { /** @@ -545,9 +484,7 @@ export namespace safebrowsing_v4 { threatTypes?: string[]; } /** - * Describes an individual threat list. A list is defined by three parameters: - * the type of threat posed, the type of platform targeted by the threat, and - * the type of entries in the list. + * Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list. */ export interface Schema$ThreatListDescriptor { /** @@ -568,8 +505,7 @@ export namespace safebrowsing_v4 { */ export interface Schema$ThreatMatch { /** - * The cache lifetime for the returned match. Clients must not cache this - * response for more than this duration to avoid false positives. + * The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives. */ cacheDuration?: string; /** @@ -720,8 +656,7 @@ export namespace safebrowsing_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A client ID that (hopefully) uniquely identifies the client - * implementation of the Safe Browsing API. + * A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API. */ clientId?: string; /** @@ -833,8 +768,7 @@ export namespace safebrowsing_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A client ID that uniquely identifies the client implementation of the - * Safe Browsing API. + * A client ID that uniquely identifies the client implementation of the Safe Browsing API. */ clientId?: string; /** @@ -949,8 +883,7 @@ export namespace safebrowsing_v4 { /** * safebrowsing.threatHits.create - * @desc Reports a Safe Browsing threat list hit to Google. Only projects - * with TRUSTED_REPORTER visibility can use this method. + * @desc Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method. * @alias safebrowsing.threatHits.create * @memberOf! () * @@ -1124,8 +1057,7 @@ export namespace safebrowsing_v4 { /** * safebrowsing.threatListUpdates.fetch - * @desc Fetches the most recent threat list updates. A client can request - * updates for multiple lists at once. + * @desc Fetches the most recent threat list updates. A client can request updates for multiple lists at once. * @alias safebrowsing.threatListUpdates.fetch * @memberOf! () * diff --git a/src/apis/script/package.json b/src/apis/script/package.json index 64326bcf85d..b89e648f5be 100644 --- a/src/apis/script/package.json +++ b/src/apis/script/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index 419e773db51..99345589861 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace script_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace script_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace script_v1 { scripts: Resource$Scripts; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.processes = new Resource$Processes(this.context); this.projects = new Resource$Projects(this.context); @@ -127,9 +126,7 @@ export namespace script_v1 { */ export interface Schema$Content { /** - * The list of script project files. One of the files is a script manifest; - * it must be named "appsscript", must have type of JSON, and - * include the manifest configurations for the project. + * The list of script project files. One of the files is a script manifest; it must be named "appsscript", must have type of JSON, and include the manifest configurations for the project. */ files?: Schema$File[]; /** @@ -142,9 +139,7 @@ export namespace script_v1 { */ export interface Schema$CreateProjectRequest { /** - * The Drive ID of a parent file that the created script project is bound - * to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or - * Google Slides file. If not set, a standalone script project is created. + * The Drive ID of a parent file that the created script project is bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google Slides file. If not set, a standalone script project is created. */ parentId?: string; /** @@ -195,11 +190,7 @@ export namespace script_v1 { versionNumber?: number; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -224,97 +215,67 @@ export namespace script_v1 { webApp?: Schema$GoogleAppsScriptTypeWebAppEntryPoint; } /** - * An object that provides information about the nature of an error resulting - * from an attempted execution of a script function using the Apps Script API. - * If a run call succeeds but the script function (or Apps Script itself) - * throws an exception, the response body's error field contains a Status - * object. The `Status` object's `details` field contains an array with a - * single one of these `ExecutionError` objects. + * The response for executing or debugging a function in an Apps Script project. + */ + export interface Schema$ExecuteStreamResponse { + /** + * The result of the execution. TODO (johnlattin): Add debugging and logging. + */ + result?: Schema$ScriptExecutionResult; + } + /** + * An object that provides information about the nature of an error resulting from an attempted execution of a script function using the Apps Script API. If a run call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains a Status object. The `Status` object's `details` field contains an array with a single one of these `ExecutionError` objects. */ export interface Schema$ExecutionError { /** - * The error message thrown by Apps Script, usually localized into the - * user's language. + * The error message thrown by Apps Script, usually localized into the user's language. */ errorMessage?: string; /** - * The error type, for example `TypeError` or `ReferenceError`. If the error - * type is unavailable, this field is not included. + * The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included. */ errorType?: string; /** - * An array of objects that provide a stack trace through the script to show - * where the execution failed, with the deepest call first. + * An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first. */ scriptStackTraceElements?: Schema$ScriptStackTraceElement[]; } /** - * A request to run the function in a script. The script is identified by the - * specified `script_id`. Executing a function on a script returns results - * based on the implementation of the script. + * A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script returns results based on the implementation of the script. */ export interface Schema$ExecutionRequest { /** - * If `true` and the user is an owner of the script, the script runs at the - * most recently saved version rather than the version deployed for use with - * the Apps Script API. Optional; default is `false`. + * If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Apps Script API. Optional; default is `false`. */ devMode?: boolean; /** - * The name of the function to execute in the given script. The name does - * not include parentheses or parameters. It can reference a function in an - * included library such as `Library.libFunction1`. + * The name of the function to execute in the given script. The name does not include parentheses or parameters. It can reference a function in an included library such as `Library.libFunction1`. */ function?: string; /** - * The parameters to be passed to the function being executed. The object - * type for each parameter should match the expected type in Apps Script. - * Parameters cannot be Apps Script-specific object types (such as a - * `Document` or a `Calendar`); they can only be primitive types such as - * `string`, `number`, `array`, `object`, or `boolean`. Optional. + * The parameters to be passed to the function being executed. The object type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific object types (such as a `Document` or a `Calendar`); they can only be primitive types such as `string`, `number`, `array`, `object`, or `boolean`. Optional. */ parameters?: any[]; /** - * <b>Deprecated</b>. For use with Android add-ons only. An ID - * that represents the user's current session in the Android app for - * Google Docs or Sheets, included as extra data in the - * [Intent](https://developer.android.com/guide/components/intents-filters.html) - * that launches the add-on. When an Android add-on is run with a session - * state, it gains the privileges of a - * [bound](https://developers.google.com/apps-script/guides/bound) - * script&mdash;that is, it can access information like the user's - * current cursor position (in Docs) or selected cell (in Sheets). To - * retrieve the state, call - * `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. - * Optional. + * <b>Deprecated</b>. For use with Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the [Intent](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/bound) script&mdash;that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. Optional. */ sessionState?: string; } /** - * An object that provides the return value of a function executed using the - * Apps Script API. If the script function returns successfully, the response - * body's response field contains this `ExecutionResponse` object. + * An object that provides the return value of a function executed using the Apps Script API. If the script function returns successfully, the response body's response field contains this `ExecutionResponse` object. */ export interface Schema$ExecutionResponse { /** - * The return value of the script function. The type matches the object type - * returned in Apps Script. Functions called using the Apps Script API - * cannot return Apps Script-specific objects (such as a `Document` or a - * `Calendar`); they can only return primitive types such as a `string`, - * `number`, `array`, `object`, or `boolean`. + * The return value of the script function. The type matches the object type returned in Apps Script. Functions called using the Apps Script API cannot return Apps Script-specific objects (such as a `Document` or a `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`. */ result?: any; } /** - * An individual file within a script project. A file is a third-party source - * code created by one or more developers. It can be a server-side JS code, - * HTML, or a configuration file. Each script project can contain multiple - * files. + * An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files. */ export interface Schema$File { /** - * Creation date timestamp. This read-only field is only visible to users - * who have WRITER permission for the script project. + * Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project. */ createTime?: string; /** @@ -322,13 +283,11 @@ export namespace script_v1 { */ functionSet?: Schema$GoogleAppsScriptTypeFunctionSet; /** - * The user who modified the file most recently. This read-only field is - * only visible to users who have WRITER permission for the script project. + * The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project. */ lastModifyUser?: Schema$GoogleAppsScriptTypeUser; /** - * The name of the file. The file extension is not part of the file name, - * which can be identified from the type field. + * The name of the file. The file extension is not part of the file name, which can be identified from the type field. */ name?: string; /** @@ -340,8 +299,7 @@ export namespace script_v1 { */ type?: string; /** - * Last modified date timestamp. This read-only field is only visible to - * users who have WRITER permission for the script project. + * Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project. */ updateTime?: string; } @@ -411,10 +369,7 @@ export namespace script_v1 { values?: Schema$GoogleAppsScriptTypeFunction[]; } /** - * Representation of a single script process execution that was started from - * the script editor, a trigger, an application, or using the Apps Script API. - * This is distinct from the `Operation` resource, which only represents - * executions started via the Apps Script API. + * Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API. */ export interface Schema$GoogleAppsScriptTypeProcess { /** @@ -494,8 +449,7 @@ export namespace script_v1 { url?: string; } /** - * Response with the list of deployments for the specified Apps Script - * project. + * Response with the list of deployments for the specified Apps Script project. */ export interface Schema$ListDeploymentsResponse { /** @@ -503,8 +457,7 @@ export namespace script_v1 { */ deployments?: Schema$Deployment[]; /** - * The token that can be used in the next call to get the next page of - * results. + * The token that can be used in the next call to get the next page of results. */ nextPageToken?: string; } @@ -513,8 +466,7 @@ export namespace script_v1 { */ export interface Schema$ListScriptProcessesResponse { /** - * Token for the next page of results. If empty, there are no more pages - * remaining. + * Token for the next page of results. If empty, there are no more pages remaining. */ nextPageToken?: string; /** @@ -527,8 +479,7 @@ export namespace script_v1 { */ export interface Schema$ListUserProcessesResponse { /** - * Token for the next page of results. If empty, there are no more pages - * remaining. + * Token for the next page of results. If empty, there are no more pages remaining. */ nextPageToken?: string; /** @@ -536,13 +487,21 @@ export namespace script_v1 { */ processes?: Schema$GoogleAppsScriptTypeProcess[]; } + /** + * `ListValue` is a wrapper around a repeated field of values. Based on LustValue at: google3/apps/maestro/api/struct.proto?q=message%5c%20ListValue + */ + export interface Schema$ListValue { + /** + * Repeated field of dynamically typed values. + */ + values?: Schema$Value[]; + } /** * Response with the list of the versions for the specified script project. */ export interface Schema$ListVersionsResponse { /** - * The token use to fetch the next page of records. if not exist in the - * response, that means no more versions to list. + * The token use to fetch the next page of records. if not exist in the response, that means no more versions to list. */ nextPageToken?: string; /** @@ -551,8 +510,7 @@ export namespace script_v1 { versions?: Schema$Version[]; } /** - * Resource containing usage stats for a given script, based on the supplied - * filter and mask present in the request. + * Resource containing usage stats for a given script, based on the supplied filter and mask present in the request. */ export interface Schema$Metrics { /** @@ -586,44 +544,19 @@ export namespace script_v1 { value?: string; } /** - * A representation of an execution of an Apps Script function started with - * run. The execution response does not arrive until the function finishes - * executing. The maximum execution runtime is listed in the [Apps Script - * quotas guide](/apps-script/guides/services/quotas#current_limitations). - * <p>After execution has started, it can have one of four - * outcomes:</p> <ul> <li> If the script function returns - * successfully, the response field contains an ExecutionResponse object - * with the function's return value in the object's `result` - * field.</li> <li> If the script function (or Apps Script itself) - * throws an exception, the error field contains a Status object. The - * `Status` object's `details` field contains an array with a single - * ExecutionError object that provides information about the nature of the - * error.</li> <li> If the execution has not yet completed, the - * done field is `false` and the neither the `response` nor `error` fields - * are present.</li> <li> If the `run` call itself fails (for - * example, because of a malformed request or an authorization error), the - * method returns an HTTP response code in the 4XX range with a different - * format for the response body. Client libraries automatically convert a - * 4XX response into an exception class.</li> </ul> + * A representation of an execution of an Apps Script function started with run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). <p>After execution has started, it can have one of four outcomes:</p> <ul> <li> If the script function returns successfully, the response field contains an ExecutionResponse object with the function's return value in the object's `result` field.</li> <li> If the script function (or Apps Script itself) throws an exception, the error field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.</li> <li> If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present.</li> <li> If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries automatically convert a 4XX response into an exception class.</li> </ul> */ export interface Schema$Operation { /** - * This field indicates whether the script execution has completed. A - * completed execution has a populated `response` field containing the - * ExecutionResponse from function that was executed. + * This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed. */ done?: boolean; /** - * If a `run` call succeeds but the script function (or Apps Script itself) - * throws an exception, this field contains a Status object. The `Status` - * object's `details` field contains an array with a single - * ExecutionError object that provides information about the nature of the - * error. + * If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error. */ error?: Schema$Status; /** - * If the script function returns successfully, this field contains an - * ExecutionResponse object with the function's return value. + * If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value. */ response?: {[key: string]: any}; } @@ -644,9 +577,7 @@ export namespace script_v1 { */ lastModifyUser?: Schema$GoogleAppsScriptTypeUser; /** - * The parent's Drive ID that the script will be attached to. This is - * usually the ID of a Google Document or Google Sheet. This filed is - * optional, and if not set, a stand-alone script will be created. + * The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This filed is optional, and if not set, a stand-alone script will be created. */ parentId?: string; /** @@ -662,6 +593,15 @@ export namespace script_v1 { */ updateTime?: string; } + /** + * The result of an execution Based on ScriptExecutionResult at: google3/apps/maestro/api/frontend_execution_common.proto?q=message%5c%20ScriptExecutionResult + */ + export interface Schema$ScriptExecutionResult { + /** + * The returned value of the execution. TODO (johnlattin): Add HtmlResponse TODO (johnlattin): Add ExceptionResponse TODO (johlnattin): Add TextResponse + */ + returnValue?: Schema$Value; + } /** * A stack trace through the script that shows where the execution failed. */ @@ -676,30 +616,31 @@ export namespace script_v1 { lineNumber?: number; } /** - * If a `run` call succeeds but the script function (or Apps Script itself) - * throws an exception, the response body's error field contains this - * `Status` object. + * If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object. */ export interface Schema$Status { /** - * The status code. For this API, this value either: <ul> <li> - * 10, indicating a `SCRIPT_TIMEOUT` error,</li> <li> 3, - * indicating an `INVALID_ARGUMENT` error, or</li> <li> 1, - * indicating a `CANCELLED` execution.</li> </ul> + * The status code. For this API, this value either: <ul> <li> 10, indicating a `SCRIPT_TIMEOUT` error,</li> <li> 3, indicating an `INVALID_ARGUMENT` error, or</li> <li> 1, indicating a `CANCELLED` execution.</li> </ul> */ code?: number; /** - * An array that contains a single ExecutionError object that provides - * information about the nature of the error. + * An array that contains a single ExecutionError object that provides information about the nature of the error. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which is in English. Any user-facing - * error message is localized and sent in the details field, or localized by - * the client. + * A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the details field, or localized by the client. */ message?: string; } + /** + * `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. Based on Struct at: google3/apps/maestro/api/struct.proto?q=message%5c%20Struct + */ + export interface Schema$Struct { + /** + * Unordered map of dynamically typed values. + */ + fields?: {[key: string]: Schema$Value}; + } /** * Request with deployment information to update an existing deployment. */ @@ -710,10 +651,48 @@ export namespace script_v1 { deploymentConfig?: Schema$DeploymentConfig; } /** - * A resource representing a script project version. A version is a - * "snapshot" of a script project and is similar to a read-only - * branched release. When creating deployments, the version to use must be - * specified. + * `Value` represents a dynamically typed value which is the outcome of an executed script Based on Value at: google3/apps/maestro/api/struct.proto?q=message%5c%20Value + */ + export interface Schema$Value { + /** + * Represents a boolean value. + */ + boolValue?: boolean; + /** + * Represents raw byte values. + */ + bytesValue?: string; + /** + * Represents a date in ms since the epoch. + */ + dateValue?: string; + /** + * Represents a repeated `Value`. + */ + listValue?: Schema$ListValue; + /** + * Represents a null value. + */ + nullValue?: string; + /** + * Represents a double value. + */ + numberValue?: number; + /** + * Represents a structured proto value. + */ + protoValue?: {[key: string]: any}; + /** + * Represents a string value. + */ + stringValue?: string; + /** + * Represents a structured value. + */ + structValue?: Schema$Struct; + } + /** + * A resource representing a script project version. A version is a "snapshot" of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified. */ export interface Schema$Version { /** @@ -729,8 +708,7 @@ export namespace script_v1 { */ scriptId?: string; /** - * The incremental ID that is created by Apps Script when a version is - * created. This is system assigned number and is immutable once created. + * The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created. */ versionNumber?: number; } @@ -743,8 +721,7 @@ export namespace script_v1 { /** * script.processes.list - * @desc List information about processes made by or on behalf of a user, - * such as process type and current status. + * @desc List information about processes made by or on behalf of a user, such as process type and current status. * @alias script.processes.list * @memberOf! () * @@ -831,8 +808,7 @@ export namespace script_v1 { /** * script.processes.listScriptProcesses - * @desc List information about a script's executed processes, such as - * process type and current status. + * @desc List information about a script's executed processes, such as process type and current status. * @alias script.processes.listScriptProcesses * @memberOf! () * @@ -928,58 +904,47 @@ export namespace script_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of returned processes per page of results. Defaults - * to 50. + * The maximum number of returned processes per page of results. Defaults to 50. */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of `nextPageToken` from a previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response. */ pageToken?: string; /** - * Optional field used to limit returned processes to those originating from - * projects with a specific deployment ID. + * Optional field used to limit returned processes to those originating from projects with a specific deployment ID. */ 'userProcessFilter.deploymentId'?: string; /** - * Optional field used to limit returned processes to those that completed - * on or before the given timestamp. + * Optional field used to limit returned processes to those that completed on or before the given timestamp. */ 'userProcessFilter.endTime'?: string; /** - * Optional field used to limit returned processes to those originating from - * a script function with the given function name. + * Optional field used to limit returned processes to those originating from a script function with the given function name. */ 'userProcessFilter.functionName'?: string; /** - * Optional field used to limit returned processes to those originating from - * projects with project names containing a specific string. + * Optional field used to limit returned processes to those originating from projects with project names containing a specific string. */ 'userProcessFilter.projectName'?: string; /** - * Optional field used to limit returned processes to those originating from - * projects with a specific script ID. + * Optional field used to limit returned processes to those originating from projects with a specific script ID. */ 'userProcessFilter.scriptId'?: string; /** - * Optional field used to limit returned processes to those that were - * started on or after the given timestamp. + * Optional field used to limit returned processes to those that were started on or after the given timestamp. */ 'userProcessFilter.startTime'?: string; /** - * Optional field used to limit returned processes to those having one of - * the specified process statuses. + * Optional field used to limit returned processes to those having one of the specified process statuses. */ 'userProcessFilter.statuses'?: string[]; /** - * Optional field used to limit returned processes to those having one of - * the specified process types. + * Optional field used to limit returned processes to those having one of the specified process types. */ 'userProcessFilter.types'?: string[]; /** - * Optional field used to limit returned processes to those having one of - * the specified user access levels. + * Optional field used to limit returned processes to those having one of the specified user access levels. */ 'userProcessFilter.userAccessLevels'?: string[]; } @@ -991,13 +956,11 @@ export namespace script_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of returned processes per page of results. Defaults - * to 50. + * The maximum number of returned processes per page of results. Defaults to 50. */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of `nextPageToken` from a previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response. */ pageToken?: string; /** @@ -1005,38 +968,31 @@ export namespace script_v1 { */ scriptId?: string; /** - * Optional field used to limit returned processes to those originating from - * projects with a specific deployment ID. + * Optional field used to limit returned processes to those originating from projects with a specific deployment ID. */ 'scriptProcessFilter.deploymentId'?: string; /** - * Optional field used to limit returned processes to those that completed - * on or before the given timestamp. + * Optional field used to limit returned processes to those that completed on or before the given timestamp. */ 'scriptProcessFilter.endTime'?: string; /** - * Optional field used to limit returned processes to those originating from - * a script function with the given function name. + * Optional field used to limit returned processes to those originating from a script function with the given function name. */ 'scriptProcessFilter.functionName'?: string; /** - * Optional field used to limit returned processes to those that were - * started on or after the given timestamp. + * Optional field used to limit returned processes to those that were started on or after the given timestamp. */ 'scriptProcessFilter.startTime'?: string; /** - * Optional field used to limit returned processes to those having one of - * the specified process statuses. + * Optional field used to limit returned processes to those having one of the specified process statuses. */ 'scriptProcessFilter.statuses'?: string[]; /** - * Optional field used to limit returned processes to those having one of - * the specified process types. + * Optional field used to limit returned processes to those having one of the specified process types. */ 'scriptProcessFilter.types'?: string[]; /** - * Optional field used to limit returned processes to those having one of - * the specified user access levels. + * Optional field used to limit returned processes to those having one of the specified user access levels. */ 'scriptProcessFilter.userAccessLevels'?: string[]; } @@ -1053,8 +1009,7 @@ export namespace script_v1 { /** * script.projects.create - * @desc Creates a new, empty script project with no script files and a base - * manifest file. + * @desc Creates a new, empty script project with no script files and a base manifest file. * @alias script.projects.create * @memberOf! () * @@ -1193,8 +1148,7 @@ export namespace script_v1 { /** * script.projects.getContent - * @desc Gets the content of the script project, including the code source - * and metadata for each script file. + * @desc Gets the content of the script project, including the code source and metadata for each script file. * @alias script.projects.getContent * @memberOf! () * @@ -1267,8 +1221,7 @@ export namespace script_v1 { /** * script.projects.getMetrics - * @desc Get metrics data for scripts, such as number of executions and - * active users. + * @desc Get metrics data for scripts, such as number of executions and active users. * @alias script.projects.getMetrics * @memberOf! () * @@ -1342,11 +1295,7 @@ export namespace script_v1 { /** * script.projects.updateContent - * @desc Updates the content of the specified script project. This content - * is stored as the HEAD version, and is used when the script is executed as - * a trigger, in the script editor, in add-on preview mode, or as a web app - * or Apps Script API in development mode. This clears all the existing - * files in the project. + * @desc Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project. * @alias script.projects.updateContent * @memberOf! () * @@ -1452,8 +1401,7 @@ export namespace script_v1 { */ scriptId?: string; /** - * The version number of the project to retrieve. If not provided, the - * project's HEAD version is returned. + * The version number of the project to retrieve. If not provided, the project's HEAD version is returned. */ versionNumber?: number; } @@ -1937,8 +1885,7 @@ export namespace script_v1 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of `nextPageToken` from a previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response. */ pageToken?: string; /** @@ -1976,8 +1923,7 @@ export namespace script_v1 { /** * script.projects.versions.create - * @desc Creates a new immutable version using the current code, with a - * unique version number. + * @desc Creates a new immutable version using the current code, with a unique version number. * @alias script.projects.versions.create * @memberOf! () * @@ -2244,8 +2190,7 @@ export namespace script_v1 { */ pageSize?: number; /** - * The token for continuing a previous list request on the next page. This - * should be set to the value of `nextPageToken` from a previous response. + * The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response. */ pageToken?: string; /** @@ -2262,18 +2207,7 @@ export namespace script_v1 { /** * script.scripts.run - * @desc Runs a function in an Apps Script project. The script project must - * be deployed for use with the Apps Script API and the calling application - * must share the same Cloud Platform project. This method requires - * authorization with an OAuth 2.0 token that includes at least one of the - * scopes listed in the [Authorization](#authorization) section; script - * projects that do not require authorization cannot be executed through - * this API. To find the correct scopes to include in the authentication - * token, open the project in the script editor, then select **File > - * Project properties** and click the **Scopes** tab. The error `403, - * PERMISSION_DENIED: The caller does not have permission` indicates that - * the Cloud Platform project used to authorize the request is not the same - * as the one used by the script. + * @desc Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab. The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script. * @alias script.scripts.run * @memberOf! () * @@ -2353,9 +2287,7 @@ export namespace script_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The script ID of the script to be executed. To find the script ID, open - * the project in the script editor and select **File > Project - * properties**. + * The script ID of the script to be executed. To find the script ID, open the project in the script editor and select **File > Project properties**. */ scriptId?: string; diff --git a/src/apis/searchconsole/package.json b/src/apis/searchconsole/package.json index 6bec85412d3..ff83e58882b 100644 --- a/src/apis/searchconsole/package.json +++ b/src/apis/searchconsole/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/searchconsole/v1.ts b/src/apis/searchconsole/v1.ts index 5d887c14ddb..5489ef3d41d 100644 --- a/src/apis/searchconsole/v1.ts +++ b/src/apis/searchconsole/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace searchconsole_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace searchconsole_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace searchconsole_v1 { urlTestingTools: Resource$Urltestingtools; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.urlTestingTools = new Resource$Urltestingtools(this.context); } @@ -132,9 +131,7 @@ export namespace searchconsole_v1 { */ export interface Schema$Image { /** - * Image data in format determined by the mime type. Currently, the format - * will always be "image/png", but this might change in the - * future. + * Image data in format determined by the mime type. Currently, the format will always be "image/png", but this might change in the future. */ data?: string; /** @@ -174,8 +171,7 @@ export namespace searchconsole_v1 { url?: string; } /** - * Mobile-friendly test response, including mobile-friendly issues and - * resource issues. + * Mobile-friendly test response, including mobile-friendly issues and resource issues. */ export interface Schema$RunMobileFriendlyTestResponse { /** diff --git a/src/apis/securitycenter/package.json b/src/apis/securitycenter/package.json index a47ad76d95b..8ced6cd6fd6 100644 --- a/src/apis/securitycenter/package.json +++ b/src/apis/securitycenter/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 065061d39ed..976090d673d 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace securitycenter_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace securitycenter_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace securitycenter_v1 { /** * Cloud Security Command Center API * - * Cloud Security Command Center API provides access to temporal views of - * assets and findings within an organization. + * Cloud Security Command Center API provides access to temporal views of assets and findings within an organization. * * @example * const {google} = require('googleapis'); @@ -113,18 +108,17 @@ export namespace securitycenter_v1 { organizations: Resource$Organizations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.organizations = new Resource$Organizations(this.context); } } /** - * Cloud Security Command Center's (Cloud SCC) representation of a Google - * Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that - * captures information about a single GCP resource. All modifications to an - * Asset are only within the context of Cloud SCC and don't affect the - * referenced GCP resource. + * Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that captures information about a single GCP resource. All modifications to an Asset are only within the context of Cloud SCC and don't affect the referenced GCP resource. */ export interface Schema$Asset { /** @@ -132,35 +126,27 @@ export namespace securitycenter_v1 { */ createTime?: string; /** - * IAM Policy information associated with the GCP resource described by the - * Cloud SCC asset. This information is managed and defined by the GCP - * resource and cannot be modified by the user. + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. */ iamPolicy?: Schema$IamPolicy; /** - * The relative resource name of this asset. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/assets/456". + * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/assets/456". */ name?: string; /** - * Resource managed properties. These properties are managed and defined by - * the GCP resource and cannot be modified by the user. + * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. */ resourceProperties?: {[key: string]: any}; /** - * Cloud SCC managed properties. These properties are managed by Cloud SCC - * and cannot be modified by the user. + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. */ securityCenterProperties?: Schema$SecurityCenterProperties; /** - * User specified security marks. These marks are entirely managed by the - * user and come from the SecurityMarks resource that belongs to the asset. + * User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. */ securityMarks?: Schema$SecurityMarks; /** - * The time at which the asset was last updated, added, or deleted in Cloud - * SCC. + * The time at which the asset was last updated, added, or deleted in Cloud SCC. */ updateTime?: string; } @@ -178,27 +164,7 @@ export namespace securitycenter_v1 { projectIds?: string[]; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -206,25 +172,16 @@ export namespace securitycenter_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -237,82 +194,49 @@ export namespace securitycenter_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Cloud Security Command Center (Cloud SCC) finding. A finding is a record - * of assessment data (security, risk, health or privacy) ingested into Cloud - * SCC for presentation, notification, analysis, policy testing, and - * enforcement. For example, an XSS vulnerability in an App Engine application - * is a finding. + * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. */ export interface Schema$Finding { /** - * The additional taxonomy group within findings from a given source. This - * field is immutable after creation time. Example: - * "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ category?: string; /** @@ -320,48 +244,31 @@ export namespace securitycenter_v1 { */ createTime?: string; /** - * The time at which the event took place. For example, if the finding - * represents an open firewall it would capture the time the open firewall - * was detected. + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the open firewall was detected. */ eventTime?: string; /** - * The URI that, if available, points to a web page outside of Cloud SCC - * where additional information about the finding can be found. This field - * is guaranteed to be either empty or a well formed URL. + * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. */ externalUri?: string; /** - * The relative resource name of this finding. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456/findings/789" + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" */ name?: string; /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. For example: - * "organizations/123/sources/456" + * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/123/sources/456" */ parent?: string; /** - * The full resource name of the Google Cloud Platform (GCP) resource this - * finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * This field is immutable after creation time. + * The full resource name of the Google Cloud Platform (GCP) resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name This field is immutable after creation time. */ resourceName?: string; /** - * Output only. User specified security marks. These marks are entirely - * managed by the user and come from the SecurityMarks resource that belongs - * to the finding. + * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ securityMarks?: Schema$SecurityMarks; /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must - * be between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. */ sourceProperties?: {[key: string]: any}; /** @@ -404,83 +311,27 @@ export namespace securitycenter_v1 { */ export interface Schema$GroupAssetsRequest { /** - * When compare_duration is set, the GroupResult's - * "state_change" property is updated to indicate whether the - * asset was added, removed, or remained present during the compare_duration - * period of time that precedes the read_time. This is the time between - * (read_time - compare_duration) and read_time. The state change value is - * derived based on the presence of the asset at the two points in time. - * Intermediate state changes between the two times don't affect the - * result. For example, the results aren't affected if the asset is - * removed and re-created again. Possible "state_change" values - * when compare_duration is specified: * "ADDED": indicates - * that the asset was not present at the start of compare_duration, but - * present at reference_time. * "REMOVED": indicates that the - * asset was present at the start of compare_duration, but - * not present at reference_time. * "ACTIVE": indicates that the - * asset was present at both the start and the end of the - * time period defined by compare_duration and - * reference_time. If compare_duration is not specified, then the only - * possible state_change is "UNUSED", which will be the - * state_change set for all assets present at read_time. If this field is - * set then `state_change` must be a specified field in `group_by`. + * When compare_duration is set, the GroupResult's "state_change" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`. */ compareDuration?: string; /** - * Expression that defines the filter to apply across assets. The expression - * is a list of zero or more restrictions combined via logical operators - * `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence - * than `AND`. Restrictions have the form `<field> <operator> - * <value>` and may have a `-` character in front of them to indicate - * negation. The fields map to those defined in the Asset resource. Examples - * include: * name * security_center_properties.resource_name * - * resource_properties.a_property * security_marks.marks.marka The - * supported operators are: * `=` for all value types. * `>`, `<`, - * `>=`, `<=` for integer values. * `:`, meaning substring matching, - * for strings. The supported value types are: * string literals in - * quotes. * integer literals without quotes. * boolean literals `true` and - * `false` without quotes. The following field and operator combinations - * are supported: name | `=` update_time | `>`, `<`, `>=`, `<=` - * iam_policy.policy_blob | '=', ':' resource_properties | - * '=', ':', `>`, `<`, `>=`, `<=` security_marks - * | '=', ':' security_center_properties.resource_name | - * '=', ':' security_center_properties.resource_type | - * '=', ':' security_center_properties.resource_parent | - * '=', ':' security_center_properties.resource_project | - * '=', ':' security_center_properties.resource_owners | - * '=', ':' For example, `resource_properties.size = 100` - * is a valid filter string. + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `>`, `<`, `>=`, `<=`, `=` * create_time: `>`, `<`, `>=`, `<=`, `=` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what assets fields to use for grouping. The - * string value should follow SQL syntax: comma separated list of fields. - * For example: - * "security_center_properties.resource_project,security_center_properties.project". - * The following fields are supported when compare_duration is not set: * - * security_center_properties.resource_project * - * security_center_properties.resource_type * - * security_center_properties.resource_parent The following fields are - * supported when compare_duration is set: * - * security_center_properties.resource_type + * Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type */ groupBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `GroupAssetsResponse`; indicates that this - * is a continuation of a prior `GroupAssets` call, and that the system - * should return the next page of data. + * The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Time used as a reference point when filtering assets. The filter is - * limited to assets existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -489,14 +340,11 @@ export namespace securitycenter_v1 { */ export interface Schema$GroupAssetsResponse { /** - * Group results. There exists an element for each existing unique - * combination of property/values. The element contains a count for the - * number of times those specific property/values appear. + * Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. */ groupByResults?: Schema$GroupResult[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -513,76 +361,27 @@ export namespace securitycenter_v1 { */ export interface Schema$GroupFindingsRequest { /** - * When compare_duration is set, the GroupResult's - * "state_change" attribute is updated to indicate whether the - * finding had its state changed, the finding's state remained - * unchanged, or if the finding was added during the compare_duration period - * of time that precedes the read_time. This is the time between (read_time - * - compare_duration) and read_time. The state_change value is derived - * based on the presence and state of the finding at the two points in time. - * Intermediate state changes between the two times don't affect the - * result. For example, the results aren't affected if the finding is - * made inactive and then active again. Possible "state_change" - * values when compare_duration is specified: * "CHANGED": - * indicates that the finding was present at the start of compare_duration, - * but changed its state at read_time. * "UNCHANGED": indicates - * that the finding was present at the start of compare_duration and did not - * change state at read_time. * "ADDED": indicates that the - * finding was not present at the start of - * compare_duration, but was present at read_time. If compare_duration is - * not specified, then the only possible state_change is "UNUSED", - * which will be the state_change set for all findings present at read_time. - * If this field is set then `state_change` must be a specified field in - * `group_by`. + * When compare_duration is set, the GroupResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`. */ compareDuration?: string; /** - * Expression that defines the filter to apply across findings. The - * expression is a list of one or more restrictions combined via logical - * operators `AND` and `OR`. Parentheses are supported, and `OR` has higher - * precedence than `AND`. Restrictions have the form `<field> - * <operator> <value>` and may have a `-` character in front of - * them to indicate negation. Examples include: * name * - * source_properties.a_property * security_marks.marks.marka The supported - * operators are: * `=` for all value types. * `>`, `<`, `>=`, - * `<=` for integer values. * `:`, meaning substring matching, for - * strings. The supported value types are: * string literals in quotes. * - * integer literals without quotes. * boolean literals `true` and `false` - * without quotes. The following field and operator combinations are - * supported: name | `=` parent | '=', ':' resource_name | - * '=', ':' state | '=', ':' category | - * '=', ':' external_uri | '=', ':' - * event_time | `>`, `<`, `>=`, `<=` security_marks | - * '=', ':' source_properties | '=', ':', - * `>`, `<`, `>=`, `<=` For example, `source_properties.size = - * 100` is a valid filter string. + * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `>`, `<`, `>=`, `<=` * security_marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what assets fields to use for grouping (including - * `state_change`). The string value should follow SQL syntax: comma - * separated list of fields. For example: "parent,resource_name". - * The following fields are supported: * resource_name * category * state * - * parent The following fields are supported when compare_duration is set: - * * state_change + * Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: * resource_name * category * state * parent The following fields are supported when compare_duration is set: * state_change */ groupBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `GroupFindingsResponse`; indicates that - * this is a continuation of a prior `GroupFindings` call, and that the - * system should return the next page of data. + * The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Time used as a reference point when filtering findings. The filter is - * limited to findings existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -591,14 +390,11 @@ export namespace securitycenter_v1 { */ export interface Schema$GroupFindingsResponse { /** - * Group results. There exists an element for each existing unique - * combination of property/values. The element contains a count for the - * number of times those specific property/values appear. + * Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. */ groupByResults?: Schema$GroupResult[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -624,14 +420,11 @@ export namespace securitycenter_v1 { properties?: {[key: string]: any}; } /** - * IAM Policy information associated with the GCP resource described by the - * Cloud SCC asset. This information is managed and defined by the GCP - * resource and cannot be modified by the user. + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. */ export interface Schema$IamPolicy { /** - * The JSON representation of the Policy associated with the asset. See - * https://cloud.google.com/iam/reference/rest/v1/Policy for format details. + * The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details. */ policyBlob?: string; } @@ -644,8 +437,7 @@ export namespace securitycenter_v1 { */ listAssetsResults?: Schema$ListAssetsResult[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -679,8 +471,7 @@ export namespace securitycenter_v1 { */ listFindingsResults?: Schema$ListFindingsResult[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -723,8 +514,7 @@ export namespace securitycenter_v1 { */ export interface Schema$ListSourcesResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -733,14 +523,11 @@ export namespace securitycenter_v1 { sources?: Schema$Source[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -748,32 +535,20 @@ export namespace securitycenter_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * User specified settings that are attached to the Cloud Security Command - * Center (Cloud SCC) organization. + * User specified settings that are attached to the Cloud Security Command Center (Cloud SCC) organization. */ export interface Schema$OrganizationSettings { /** @@ -781,38 +556,16 @@ export namespace securitycenter_v1 { */ assetDiscoveryConfig?: Schema$AssetDiscoveryConfig; /** - * A flag that indicates if Asset Discovery should be enabled. If the flag - * is set to `true`, then discovery of assets will occur. If it is set to - * `false, all historical assets will remain, but discovery of future assets - * will not occur. + * A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur. */ enableAssetDiscovery?: boolean; /** - * The relative resource name of the settings. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/organizationSettings". + * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". */ name?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -820,20 +573,11 @@ export namespace securitycenter_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -846,14 +590,11 @@ export namespace securitycenter_v1 { */ export interface Schema$RunAssetDiscoveryRequest {} /** - * Cloud SCC managed properties. These properties are managed by Cloud SCC and - * cannot be modified by the user. + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. */ export interface Schema$SecurityCenterProperties { /** - * The full resource name of the GCP resource this asset represents. This - * field is immutable after create time. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name + * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceName?: string; /** @@ -861,43 +602,28 @@ export namespace securitycenter_v1 { */ resourceOwners?: string[]; /** - * The full resource name of the immediate parent of the resource. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name + * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceParent?: string; /** - * The full resource name of the project the resource belongs to. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name + * The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceProject?: string; /** - * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and - * ORGANIZATION. This is a case insensitive field defined by Cloud SCC - * and/or the producer of the resource and is immutable after create time. + * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. */ resourceType?: string; } /** - * User specified security marks that are attached to the parent Cloud - * Security Command Center (Cloud SCC) resource. Security marks are scoped - * within a Cloud SCC organization -- they can be modified and viewed by all - * users who have proper permissions on the organization. + * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. */ export interface Schema$SecurityMarks { /** - * Mutable user specified security marks belonging to the parent resource. - * Constraints are as follows: - Keys and values are treated as case - * insensitive - Keys must be between 1 - 256 characters (inclusive) - - * Keys must be letters, numbers, underscores, or dashes - Values have - * leading and trailing whitespace trimmed, remaining characters must be - * between 1 - 4096 characters (inclusive) + * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: - Keys and values are treated as case insensitive - Keys must be between 1 - 256 characters (inclusive) - Keys must be letters, numbers, underscores, or dashes - Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) */ marks?: {[key: string]: string}; /** - * The relative resource name of the SecurityMarks. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Examples: "organizations/123/assets/456/securityMarks" - * "organizations/123/sources/456/findings/789/securityMarks". + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ name?: string; } @@ -919,88 +645,33 @@ export namespace securitycenter_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * Cloud Security Command Center's (Cloud SCC) finding source. A finding - * source is an entity or a mechanism that can produce a finding. A source is - * like a container of findings that come from the same scanner, logger, - * monitor, etc. + * Cloud Security Command Center's (Cloud SCC) finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. */ export interface Schema$Source { /** - * The description of the source (max of 1024 characters). Example: - * "Cloud Security Scanner is a web security scanner for common - * vulnerabilities in App Engine applications. It can automatically scan and - * detect four common vulnerabilities, including cross-site-scripting (XSS), - * Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure - * libraries." + * The description of the source (max of 1024 characters). Example: "Cloud Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." */ description?: string; /** - * The source's display name. A source's display name must be unique - * amongst its siblings, for example, two sources with the same parent - * can't share the same display name. The display name must start and - * end with a letter or digit, may contain letters, digits, spaces, hyphens, - * and underscores, and can be no longer than 32 characters. This is - * captured by the regular expression: [\p{L}\p{N}]({\p{L}\p{N}_- - * ]{0,30}[\p{L}\p{N}])?. + * The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens, and underscores, and can be no longer than 32 characters. This is captured by the regular expression: [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,30}[\p{L}\p{N}])?. */ displayName?: string; /** - * The relative resource name of this source. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456" + * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" */ name?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1008,14 +679,11 @@ export namespace securitycenter_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1024,10 +692,7 @@ export namespace securitycenter_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -1036,8 +701,7 @@ export namespace securitycenter_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1217,8 +881,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to get organization settings for. Its format is - * "organizations/[organization_id]/organizationSettings". + * Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". */ name?: string; } @@ -1230,14 +893,11 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the settings. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/organizationSettings". + * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". */ name?: string; /** - * The FieldMask to use when updating the settings resource. If empty all - * mutable fields will be updated. + * The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated. */ updateMask?: string; @@ -1255,8 +915,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.assets.group - * @desc Filters an organization's assets and groups them by their - * specified properties. + * @desc Filters an organization's assets and groups them by their specified properties. * @alias securitycenter.organizations.assets.group * @memberOf! () * @@ -1339,7 +998,7 @@ export namespace securitycenter_v1 { * @param {object} params Parameters for request * @param {string=} params.compareDuration When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. * @param {string=} params.fieldMask Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. - * @param {string=} params.filter Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: name | `=` update_time | `>`, `<`, `>=`, `<=` iam_policy.policy_blob | '=', ':' resource_properties | '=', ':', `>`, `<`, `>=`, `<=` security_marks | '=', ':' security_center_properties.resource_name | '=', ':' security_center_properties.resource_type | '=', ':' security_center_properties.resource_parent | '=', ':' security_center_properties.resource_project | '=', ':' security_center_properties.resource_owners | '=', ':' For example, `resource_properties.size = 100` is a valid filter string. + * @param {string=} params.filter Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `>`, `<`, `>=`, `<=` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks security_center_properties.resource_name security_center_properties.resource_parent security_center_properties.resource_project security_center_properties.resource_type * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. * @param {string=} params.pageToken The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data. @@ -1414,10 +1073,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.assets.runDiscovery - * @desc Runs asset discovery. The discovery is tracked with a long-running - * operation. This API can only be called with limited frequency for an - * organization. If it is called too frequently the caller will receive a - * TOO_MANY_REQUESTS error. + * @desc Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. * @alias securitycenter.organizations.assets.runDiscovery * @memberOf! () * @@ -1577,8 +1233,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to groupBy. Its format is - * "organizations/[organization_id]". + * Name of the organization to groupBy. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1595,92 +1250,35 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When compare_duration is set, the ListAssetsResult's "state_change" - * attribute is updated to indicate whether the asset was added, removed, or - * remained present during the compare_duration period of time that precedes - * the read_time. This is the time between (read_time - compare_duration) - * and read_time. The state_change value is derived based on the presence - * of the asset at the two points in time. Intermediate state changes - * between the two times don't affect the result. For example, the results - * aren't affected if the asset is removed and re-created again. Possible - * "state_change" values when compare_duration is specified: * "ADDED": - * indicates that the asset was not present at the start of - * compare_duration, but present at read_time. * "REMOVED": indicates that - * the asset was present at the start of compare_duration, - * but not present at read_time. * "ACTIVE": indicates that the asset was - * present at both the start and the end of the time period - * defined by compare_duration and read_time. If - * compare_duration is not specified, then the only possible state_change is - * "UNUSED", which will be the state_change set for all assets present at - * read_time. + * When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. */ compareDuration?: string; /** - * Optional. A field mask to specify the ListAssetsResult fields to be - * listed in the response. An empty field mask will list all fields. + * Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** - * Expression that defines the filter to apply across assets. The expression - * is a list of zero or more restrictions combined via logical operators - * `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence - * than `AND`. Restrictions have the form ` ` and - * may have a `-` character in front of them to indicate negation. The - * fields map to those defined in the Asset resource. Examples include: * - * name * security_center_properties.resource_name * - * resource_properties.a_property * security_marks.marks.marka The - * supported operators are: * `=` for all value types. * `>`, `<`, `>=`, - * `<=` for integer values. * `:`, meaning substring matching, for strings. - * The supported value types are: * string literals in quotes. * integer - * literals without quotes. * boolean literals `true` and `false` without - * quotes. The following are the allowed field and operator combinations: - * name | `=` update_time | `>`, `<`, `>=`, `<=` iam_policy.policy_blob | - * '=', ':' resource_properties | '=', ':', `>`, `<`, `>=`, `<=` - * security_marks | '=', ':' security_center_properties.resource_name | '=', - * ':' security_center_properties.resource_type | '=', ':' - * security_center_properties.resource_parent | '=', ':' - * security_center_properties.resource_project | '=', ':' - * security_center_properties.resource_owners | '=', ':' For example, - * `resource_properties.size = 100` is a valid filter string. + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `>`, `<`, `>=`, `<=` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what fields and order to use for sorting. The - * string value should follow SQL syntax: comma separated list of fields. - * For example: "name,resource_properties.a_property". The default sorting - * order is ascending. To specify descending order for a field, a suffix " - * desc" should be appended to the field name. For example: "name - * desc,resource_properties.a_property". Redundant space characters in the - * syntax are insignificant. "name desc,resource_properties.a_property" and - * " name desc , resource_properties.a_property " are equivalent. - * The following fields are supported: name update_time resource_properties - * security_marks security_center_properties.resource_name - * security_center_properties.resource_parent - * security_center_properties.resource_project - * security_center_properties.resource_type + * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks security_center_properties.resource_name security_center_properties.resource_parent security_center_properties.resource_project security_center_properties.resource_type */ orderBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `ListAssetsResponse`; indicates that this - * is a continuation of a prior `ListAssets` call, and that the system - * should return the next page of data. + * The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Name of the organization assets should belong to. Its format is - * "organizations/[organization_id]". + * Name of the organization assets should belong to. Its format is "organizations/[organization_id]". */ parent?: string; /** - * Time used as a reference point when filtering assets. The filter is - * limited to assets existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -1692,8 +1290,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to run asset discovery for. Its format is - * "organizations/[organization_id]". + * Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1710,23 +1307,15 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the SecurityMarks. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Examples: "organizations/123/assets/456/securityMarks" - * "organizations/123/sources/456/findings/789/securityMarks". + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ name?: string; /** - * The time at which the updated SecurityMarks take effect. If not set uses - * current server time. Updates will be applied to the SecurityMarks that - * are active immediately preceding this time. + * The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. */ startTime?: string; /** - * The FieldMask to use when updating the security marks resource. The - * field mask must not contain duplicate fields. If empty or set to "marks", - * all marks will be replaced. Individual marks can be updated using - * "marks.". + * The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.". */ updateMask?: string; @@ -1744,15 +1333,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias securitycenter.organizations.operations.cancel * @memberOf! () * @@ -1822,10 +1403,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias securitycenter.organizations.operations.delete * @memberOf! () * @@ -1895,9 +1473,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias securitycenter.organizations.operations.get * @memberOf! () * @@ -1969,15 +1545,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias securitycenter.organizations.operations.list * @memberOf! () * @@ -2655,8 +2223,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the new source's parent. Its format should be - * "organizations/[organization_id]". + * Resource name of the new source's parent. Its format should be "organizations/[organization_id]". */ parent?: string; @@ -2673,8 +2240,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Relative resource name of the source. Its format is - * "organizations/[organization_id]/source/[source_id]". + * Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". */ name?: string; } @@ -2686,8 +2252,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2704,19 +2269,15 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `ListSourcesResponse`; indicates that this - * is a continuation of a prior `ListSources` call, and that the system - * should return the next page of data. + * The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Resource name of the parent of sources to list. Its format should be - * "organizations/[organization_id]". + * Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". */ parent?: string; } @@ -2728,14 +2289,11 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of this source. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456" + * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" */ name?: string; /** - * The FieldMask to use when updating the source resource. If empty all - * mutable fields will be updated. + * The FieldMask to use when updating the source resource. If empty all mutable fields will be updated. */ updateMask?: string; @@ -2752,8 +2310,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2770,8 +2327,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2789,8 +2345,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.create - * @desc Creates a finding. The corresponding source must exist for finding - * creation to succeed. + * @desc Creates a finding. The corresponding source must exist for finding creation to succeed. * @alias securitycenter.organizations.sources.findings.create * @memberOf! () * @@ -2865,9 +2420,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.group - * @desc Filters an organization or source's findings and groups them by - * their specified properties. To group across all sources provide a `-` as - * the source id. Example: /v1/organizations/123/sources/-/findings + * @desc Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings * @alias securitycenter.organizations.sources.findings.group * @memberOf! () * @@ -2945,16 +2498,14 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.list - * @desc Lists an organization or source's findings. To list across all - * sources provide a `-` as the source id. Example: - * /v1/organizations/123/sources/-/findings + * @desc Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings * @alias securitycenter.organizations.sources.findings.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.compareDuration When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. * @param {string=} params.fieldMask Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. - * @param {string=} params.filter Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name | `=` parent | '=', ':' resource_name | '=', ':' state | '=', ':' category | '=', ':' external_uri | '=', ':' event_time | `>`, `<`, `>=`, `<=` security_marks | '=', ':' source_properties | '=', ':', `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. + * @param {string=} params.filter Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `>`, `<`, `>=`, `<=` security_marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. * @param {string=} params.pageToken The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data. @@ -3031,8 +2582,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.patch - * @desc Creates or updates a finding. The corresponding source must exist - * for a finding creation to succeed. + * @desc Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. * @alias securitycenter.organizations.sources.findings.patch * @memberOf! () * @@ -3262,14 +2812,11 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier provided by the client within the parent scope. It must - * be alphanumeric and less than or equal to 32 characters and greater than - * 0 characters in length. + * Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. */ findingId?: string; /** - * Resource name of the new finding's parent. Its format should be - * "organizations/[organization_id]/sources/[source_id]". + * Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". */ parent?: string; @@ -3286,10 +2833,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the source to groupBy. Its format is - * "organizations/[organization_id]/sources/[source_id]". To groupBy across - * all sources provide a source_id of `-`. For example: - * organizations/123/sources/- + * Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/123/sources/- */ parent?: string; @@ -3306,87 +2850,35 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When compare_duration is set, the ListFindingsResult's "state_change" - * attribute is updated to indicate whether the finding had its state - * changed, the finding's state remained unchanged, or if the finding was - * added in any state during the compare_duration period of time that - * precedes the read_time. This is the time between (read_time - - * compare_duration) and read_time. The state_change value is derived based - * on the presence and state of the finding at the two points in time. - * Intermediate state changes between the two times don't affect the result. - * For example, the results aren't affected if the finding is made inactive - * and then active again. Possible "state_change" values when - * compare_duration is specified: * "CHANGED": indicates that the finding - * was present at the start of compare_duration, but - * changed its state at read_time. * "UNCHANGED": indicates that the finding - * was present at the start of compare_duration and did not - * change state at read_time. * "ADDED": indicates that the finding was - * not present at the start of compare_duration, but was - * present at read_time. If compare_duration is not specified, then the - * only possible state_change is "UNUSED", which will be the state_change - * set for all findings present at read_time. + * When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. */ compareDuration?: string; /** - * Optional. A field mask to specify the Finding fields to be listed in the - * response. An empty field mask will list all fields. + * Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** - * Expression that defines the filter to apply across findings. The - * expression is a list of one or more restrictions combined via logical - * operators `AND` and `OR`. Parentheses are supported, and `OR` has higher - * precedence than `AND`. Restrictions have the form ` - * ` and may have a `-` character in front of them to indicate - * negation. Examples include: * name * source_properties.a_property * - * security_marks.marks.marka The supported operators are: * `=` for all - * value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning - * substring matching, for strings. The supported value types are: * - * string literals in quotes. * integer literals without quotes. * boolean - * literals `true` and `false` without quotes. The following field and - * operator combinations are supported: name | `=` parent | '=', ':' - * resource_name | '=', ':' state | '=', ':' category | '=', ':' - * external_uri | '=', ':' event_time | `>`, `<`, `>=`, `<=` security_marks - * | '=', ':' source_properties | '=', ':', `>`, `<`, `>=`, `<=` For - * example, `source_properties.size = 100` is a valid filter string. + * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `>`, `<`, `>=`, `<=` security_marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what fields and order to use for sorting. The - * string value should follow SQL syntax: comma separated list of fields. - * For example: "name,resource_properties.a_property". The default sorting - * order is ascending. To specify descending order for a field, a suffix " - * desc" should be appended to the field name. For example: "name - * desc,source_properties.a_property". Redundant space characters in the - * syntax are insignificant. "name desc,source_properties.a_property" and " - * name desc , source_properties.a_property " are equivalent. The - * following fields are supported: name parent state category resource_name - * event_time source_properties security_marks + * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks */ orderBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `ListFindingsResponse`; indicates that - * this is a continuation of a prior `ListFindings` call, and that the - * system should return the next page of data. + * The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Name of the source the findings belong to. Its format is - * "organizations/[organization_id]/sources/[source_id]". To list across all - * sources provide a source_id of `-`. For example: - * organizations/123/sources/- + * Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/123/sources/- */ parent?: string; /** - * Time used as a reference point when filtering findings. The filter is - * limited to findings existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -3398,18 +2890,11 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of this finding. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456/findings/789" + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" */ name?: string; /** - * The FieldMask to use when updating the finding resource. This field - * should not be specified when creating a finding. When updating a - * finding, an empty mask is treated as updating all mutable fields and - * replacing source_properties. Individual source_properties can be - * added/updated by using "source_properties." in the field - * mask. + * The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties." in the field mask. */ updateMask?: string; @@ -3426,9 +2911,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the finding. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456/finding/789". + * The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/finding/789". */ name?: string; @@ -3445,23 +2928,15 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the SecurityMarks. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Examples: "organizations/123/assets/456/securityMarks" - * "organizations/123/sources/456/findings/789/securityMarks". + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ name?: string; /** - * The time at which the updated SecurityMarks take effect. If not set uses - * current server time. Updates will be applied to the SecurityMarks that - * are active immediately preceding this time. + * The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. */ startTime?: string; /** - * The FieldMask to use when updating the security marks resource. The - * field mask must not contain duplicate fields. If empty or set to "marks", - * all marks will be replaced. Individual marks can be updated using - * "marks.". + * The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.". */ updateMask?: string; diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index bd852813c97..7b4f1c8a102 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace securitycenter_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace securitycenter_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace securitycenter_v1beta1 { /** * Cloud Security Command Center API * - * Cloud Security Command Center API provides access to temporal views of - * assets and findings within an organization. + * Cloud Security Command Center API provides access to temporal views of assets and findings within an organization. * * @example * const {google} = require('googleapis'); @@ -113,18 +108,17 @@ export namespace securitycenter_v1beta1 { organizations: Resource$Organizations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.organizations = new Resource$Organizations(this.context); } } /** - * Cloud Security Command Center's (Cloud SCC) representation of a Google - * Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that - * captures information about a single GCP resource. All modifications to an - * Asset are only within the context of Cloud SCC and don't affect the - * referenced GCP resource. + * Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that captures information about a single GCP resource. All modifications to an Asset are only within the context of Cloud SCC and don't affect the referenced GCP resource. */ export interface Schema$Asset { /** @@ -132,29 +126,23 @@ export namespace securitycenter_v1beta1 { */ createTime?: string; /** - * The relative resource name of this asset. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/assets/456". + * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/assets/456". */ name?: string; /** - * Resource managed properties. These properties are managed and defined by - * the GCP resource and cannot be modified by the user. + * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. */ resourceProperties?: {[key: string]: any}; /** - * Cloud SCC managed properties. These properties are managed by Cloud SCC - * and cannot be modified by the user. + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. */ securityCenterProperties?: Schema$SecurityCenterProperties; /** - * User specified security marks. These marks are entirely managed by the - * user and come from the SecurityMarks resource that belongs to the asset. + * User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. */ securityMarks?: Schema$SecurityMarks; /** - * The time at which the asset was last updated, added, or deleted in Cloud - * SCC. + * The time at which the asset was last updated, added, or deleted in Cloud SCC. */ updateTime?: string; } @@ -172,27 +160,7 @@ export namespace securitycenter_v1beta1 { projectIds?: string[]; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -200,25 +168,16 @@ export namespace securitycenter_v1beta1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -231,30 +190,15 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } @@ -263,54 +207,36 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$CancelOperationRequest {} /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * Cloud Security Command Center (Cloud SCC) finding. A finding is a record - * of assessment data (security, risk, health or privacy) ingested into Cloud - * SCC for presentation, notification, analysis, policy testing, and - * enforcement. For example, an XSS vulnerability in an App Engine application - * is a finding. + * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. */ export interface Schema$Finding { /** - * The additional taxonomy group within findings from a given source. This - * field is immutable after creation time. Example: - * "XSS_FLASH_INJECTION" + * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ category?: string; /** @@ -318,48 +244,31 @@ export namespace securitycenter_v1beta1 { */ createTime?: string; /** - * The time at which the event took place. For example, if the finding - * represents an open firewall it would capture the time the open firewall - * was detected. + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the open firewall was detected. */ eventTime?: string; /** - * The URI that, if available, points to a web page outside of Cloud SCC - * where additional information about the finding can be found. This field - * is guaranteed to be either empty or a well formed URL. + * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. */ externalUri?: string; /** - * The relative resource name of this finding. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456/findings/789" + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" */ name?: string; /** - * The relative resource name of the source the finding belongs to. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * This field is immutable after creation time. For example: - * "organizations/123/sources/456" + * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/123/sources/456" */ parent?: string; /** - * The full resource name of the Google Cloud Platform (GCP) resource this - * finding is for. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name - * This field is immutable after creation time. + * The full resource name of the Google Cloud Platform (GCP) resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name This field is immutable after creation time. */ resourceName?: string; /** - * Output only. User specified security marks. These marks are entirely - * managed by the user and come from the SecurityMarks resource that belongs - * to the finding. + * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ securityMarks?: Schema$SecurityMarks; /** - * Source specific properties. These properties are managed by the source - * that writes the finding. The key names in the source_properties map must - * be between 1 and 255 characters, and must start with a letter and contain - * alphanumeric characters or underscores only. + * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. */ sourceProperties?: {[key: string]: any}; /** @@ -402,70 +311,27 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GroupAssetsRequest { /** - * When compare_duration is set, the Asset's "state" property - * is updated to indicate whether the asset was added, removed, or remained - * present during the compare_duration period of time that precedes the - * read_time. This is the time between (read_time - compare_duration) and - * read_time. The state value is derived based on the presence of the asset - * at the two points in time. Intermediate state changes between the two - * times don't affect the result. For example, the results aren't - * affected if the asset is removed and re-created again. Possible - * "state" values when compare_duration is specified: * - * "ADDED": indicates that the asset was not present before - * compare_duration, but present at reference_time. * "REMOVED": - * indicates that the asset was present at the start of compare_duration, - * but not present at reference_time. * "ACTIVE": indicates that - * the asset was present at both the start and the end of the - * time period defined by compare_duration and reference_time. - * This field is ignored if `state` is not a field in `group_by`. + * When compare_duration is set, the Asset's "state" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state" values when compare_duration is specified: * "ADDED": indicates that the asset was not present before compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. This field is ignored if `state` is not a field in `group_by`. */ compareDuration?: string; /** - * Expression that defines the filter to apply across assets. The expression - * is a list of zero or more restrictions combined via logical operators - * `AND` and `OR`. Parentheses are not supported, and `OR` has higher - * precedence than `AND`. Restrictions have the form `<field> - * <operator> <value>` and may have a `-` character in front of - * them to indicate negation. The fields map to those defined in the Asset - * resource. Examples include: * name * - * security_center_properties.resource_name * resource_properties.a_property - * * security_marks.marks.marka The supported operators are: * `=` for all - * value types. * `>`, `<`, `>=`, `<=` for integer values. * - * `:`, meaning substring matching, for strings. The supported value types - * are: * string literals in quotes. * integer literals without quotes. * - * boolean literals `true` and `false` without quotes. For example, - * `resource_properties.size = 100` is a valid filter string. + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `resource_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what assets fields to use for grouping. The - * string value should follow SQL syntax: comma separated list of fields. - * For example: - * "security_center_properties.resource_project,security_center_properties.project". - * The following fields are supported when compare_duration is not set: * - * security_center_properties.resource_project * - * security_center_properties.resource_type * - * security_center_properties.resource_parent The following fields are - * supported when compare_duration is set: * - * security_center_properties.resource_type + * Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type */ groupBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `GroupAssetsResponse`; indicates that this - * is a continuation of a prior `GroupAssets` call, and that the system - * should return the next page of data. + * The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Time used as a reference point when filtering assets. The filter is - * limited to assets existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -474,14 +340,11 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GroupAssetsResponse { /** - * Group results. There exists an element for each existing unique - * combination of property/values. The element contains a count for the - * number of times those specific property/values appear. + * Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. */ groupByResults?: Schema$GroupResult[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -494,44 +357,23 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GroupFindingsRequest { /** - * Expression that defines the filter to apply across findings. The - * expression is a list of one or more restrictions combined via logical - * operators `AND` and `OR`. Parentheses are not supported, and `OR` has - * higher precedence than `AND`. Restrictions have the form `<field> - * <operator> <value>` and may have a `-` character in front of - * them to indicate negation. Examples include: * name * - * source_properties.a_property * security_marks.marks.marka The supported - * operators are: * `=` for all value types. * `>`, `<`, `>=`, - * `<=` for integer values. * `:`, meaning substring matching, for - * strings. The supported value types are: * string literals in quotes. * - * integer literals without quotes. * boolean literals `true` and `false` - * without quotes. For example, `source_properties.size = 100` is a valid - * filter string. + * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what assets fields to use for grouping (including - * `state`). The string value should follow SQL syntax: comma separated list - * of fields. For example: "parent,resource_name". The following - * fields are supported: * resource_name * category * state * parent + * Expression that defines what assets fields to use for grouping (including `state`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: * resource_name * category * state * parent */ groupBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `GroupFindingsResponse`; indicates that - * this is a continuation of a prior `GroupFindings` call, and that the - * system should return the next page of data. + * The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Time used as a reference point when filtering findings. The filter is - * limited to findings existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -540,14 +382,11 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GroupFindingsResponse { /** - * Group results. There exists an element for each existing unique - * combination of property/values. The element contains a count for the - * number of times those specific property/values appear. + * Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. */ groupByResults?: Schema$GroupResult[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -577,8 +416,7 @@ export namespace securitycenter_v1beta1 { */ listAssetsResults?: Schema$ListAssetsResult[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -612,8 +450,7 @@ export namespace securitycenter_v1beta1 { */ findings?: Schema$Finding[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -643,8 +480,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$ListSourcesResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results. + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string; /** @@ -653,14 +489,11 @@ export namespace securitycenter_v1beta1 { sources?: Schema$Source[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -668,32 +501,20 @@ export namespace securitycenter_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * User specified settings that are attached to the Cloud Security Command - * Center (Cloud SCC) organization. + * User specified settings that are attached to the Cloud Security Command Center (Cloud SCC) organization. */ export interface Schema$OrganizationSettings { /** @@ -701,38 +522,16 @@ export namespace securitycenter_v1beta1 { */ assetDiscoveryConfig?: Schema$AssetDiscoveryConfig; /** - * A flag that indicates if Asset Discovery should be enabled. If the flag - * is set to `true`, then discovery of assets will occur. If it is set to - * `false, all historical assets will remain, but discovery of future assets - * will not occur. + * A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur. */ enableAssetDiscovery?: boolean; /** - * The relative resource name of the settings. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/organizationSettings". + * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". */ name?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -740,20 +539,11 @@ export namespace securitycenter_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -766,14 +556,11 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$RunAssetDiscoveryRequest {} /** - * Cloud SCC managed properties. These properties are managed by Cloud SCC and - * cannot be modified by the user. + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. */ export interface Schema$SecurityCenterProperties { /** - * The full resource name of the GCP resource this asset represents. This - * field is immutable after create time. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name + * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceName?: string; /** @@ -781,43 +568,28 @@ export namespace securitycenter_v1beta1 { */ resourceOwners?: string[]; /** - * The full resource name of the immediate parent of the resource. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name + * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceParent?: string; /** - * The full resource name of the project the resource belongs to. See: - * https://cloud.google.com/apis/design/resource_names#full_resource_name + * The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceProject?: string; /** - * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and - * ORGANIZATION. This is a case insensitive field defined by Cloud SCC - * and/or the producer of the resource and is immutable after create time. + * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. */ resourceType?: string; } /** - * User specified security marks that are attached to the parent Cloud - * Security Command Center (Cloud SCC) resource. Security marks are scoped - * within a Cloud SCC organization -- they can be modified and viewed by all - * users who have proper permissions on the organization. + * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. */ export interface Schema$SecurityMarks { /** - * Mutable user specified security marks belonging to the parent resource. - * Constraints are as follows: - Keys and values are treated as case - * insensitive - Keys must be between 1 - 256 characters (inclusive) - - * Keys must be letters, numbers, underscores, or dashes - Values have - * leading and trailing whitespace trimmed, remaining characters must be - * between 1 - 4096 characters (inclusive) + * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: - Keys and values are treated as case insensitive - Keys must be between 1 - 256 characters (inclusive) - Keys must be letters, numbers, underscores, or dashes - Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) */ marks?: {[key: string]: string}; /** - * The relative resource name of the SecurityMarks. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Examples: "organizations/123/assets/456/securityMarks" - * "organizations/123/sources/456/findings/789/securityMarks". + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ name?: string; } @@ -839,87 +611,33 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * Cloud Security Command Center's (Cloud SCC) finding source. A finding - * source is an entity or a mechanism that can produce a finding. A source is - * like a container of findings that come from the same scanner, logger, - * monitor, etc. + * Cloud Security Command Center's (Cloud SCC) finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. */ export interface Schema$Source { /** - * The description of the source (max of 1024 characters). Example: - * "Cloud Security Scanner is a web security scanner for common - * vulnerabilities in App Engine applications. It can automatically scan and - * detect four common vulnerabilities, including cross-site-scripting (XSS), - * Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure - * libraries." + * The description of the source (max of 1024 characters). Example: "Cloud Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." */ description?: string; /** - * The source’s display name. A source’s display name must be unique amongst - * its siblings, for example, two sources with the same parent can't - * share the same display name. The display name must start and end with a - * letter or digit, may contain letters, digits, spaces, hyphens, and - * underscores, and can be no longer than 32 characters. This is captured by - * the regular expression: [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,30}[\p{L}\p{N}])?. + * The source’s display name. A source’s display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens, and underscores, and can be no longer than 32 characters. This is captured by the regular expression: [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,30}[\p{L}\p{N}])?. */ displayName?: string; /** - * The relative resource name of this source. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456" + * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" */ name?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -927,14 +645,11 @@ export namespace securitycenter_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -943,10 +658,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -955,8 +667,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1136,8 +847,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to get organization settings for. Its format is - * "organizations/[organization_id]/organizationSettings". + * Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". */ name?: string; } @@ -1149,9 +859,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the settings. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/organizationSettings". + * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". */ name?: string; /** @@ -1173,8 +881,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.assets.group - * @desc Filters an organization's assets and groups them by their - * specified properties. + * @desc Filters an organization's assets and groups them by their specified properties. * @alias securitycenter.organizations.assets.group * @memberOf! () * @@ -1332,10 +1039,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.assets.runDiscovery - * @desc Runs asset discovery. The discovery is tracked with a long-running - * operation. This API can only be called with limited frequency for an - * organization. If it is called too frequently the caller will receive a - * TOO_MANY_REQUESTS error. + * @desc Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. * @alias securitycenter.organizations.assets.runDiscovery * @memberOf! () * @@ -1495,8 +1199,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to groupBy. Its format is - * "organizations/[organization_id]". + * Name of the organization to groupBy. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1513,79 +1216,35 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When compare_duration is set, the ListAssetResult's "state" attribute is - * updated to indicate whether the asset was added, removed, or remained - * present during the compare_duration period of time that precedes the - * read_time. This is the time between (read_time - compare_duration) and - * read_time. The state value is derived based on the presence of the asset - * at the two points in time. Intermediate state changes between the two - * times don't affect the result. For example, the results aren't affected - * if the asset is removed and re-created again. Possible "state" values - * when compare_duration is specified: * "ADDED": indicates that the asset - * was not present before compare_duration, but present at - * read_time. * "REMOVED": indicates that the asset was present at the start - * of compare_duration, but not present at read_time. * - * "ACTIVE": indicates that the asset was present at both the start and the - * end of the time period defined by compare_duration and - * read_time. If compare_duration is not specified, then the only possible - * state is "UNUSED", which indicates that the asset is present at - * read_time. + * When compare_duration is set, the ListAssetResult's "state" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state" values when compare_duration is specified: * "ADDED": indicates that the asset was not present before compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state is "UNUSED", which indicates that the asset is present at read_time. */ compareDuration?: string; /** - * Optional. A field mask to specify the ListAssetsResult fields to be - * listed in the response. An empty field mask will list all fields. + * Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** - * Expression that defines the filter to apply across assets. The expression - * is a list of zero or more restrictions combined via logical operators - * `AND` and `OR`. Parentheses are not supported, and `OR` has higher - * precedence than `AND`. Restrictions have the form ` - * ` and may have a `-` character in front of them to indicate - * negation. The fields map to those defined in the Asset resource. Examples - * include: * name * security_center_properties.resource_name * - * resource_properties.a_property * security_marks.marks.marka The - * supported operators are: * `=` for all value types. * `>`, `<`, `>=`, - * `<=` for integer values. * `:`, meaning substring matching, for strings. - * The supported value types are: * string literals in quotes. * integer - * literals without quotes. * boolean literals `true` and `false` without - * quotes. For example, `resource_properties.size = 100` is a valid filter - * string. + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `resource_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what fields and order to use for sorting. The - * string value should follow SQL syntax: comma separated list of fields. - * For example: "name,resource_properties.a_property". The default sorting - * order is ascending. To specify descending order for a field, a suffix " - * desc" should be appended to the field name. For example: "name - * desc,resource_properties.a_property". Redundant space characters in the - * syntax are insignificant. "name desc,resource_properties.a_property" and - * " name desc , resource_properties.a_property " are equivalent. + * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. */ orderBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `ListAssetsResponse`; indicates that this - * is a continuation of a prior `ListAssets` call, and that the system - * should return the next page of data. + * The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Name of the organization assets should belong to. Its format is - * "organizations/[organization_id]". + * Name of the organization assets should belong to. Its format is "organizations/[organization_id]". */ parent?: string; /** - * Time used as a reference point when filtering assets. The filter is - * limited to assets existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -1597,8 +1256,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to run asset discovery for. Its format is - * "organizations/[organization_id]". + * Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1615,10 +1273,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the SecurityMarks. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Examples: "organizations/123/assets/456/securityMarks" - * "organizations/123/sources/456/findings/789/securityMarks". + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ name?: string; /** @@ -1644,15 +1299,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias securitycenter.organizations.operations.cancel * @memberOf! () * @@ -1726,10 +1373,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias securitycenter.organizations.operations.delete * @memberOf! () * @@ -1799,9 +1443,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias securitycenter.organizations.operations.get * @memberOf! () * @@ -1873,15 +1515,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias securitycenter.organizations.operations.list * @memberOf! () * @@ -2564,8 +2198,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the new source's parent. Its format should be - * "organizations/[organization_id]". + * Resource name of the new source's parent. Its format should be "organizations/[organization_id]". */ parent?: string; @@ -2582,8 +2215,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Relative resource name of the source. Its format is - * "organizations/[organization_id]/source/[source_id]". + * Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". */ name?: string; } @@ -2595,8 +2227,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2613,19 +2244,15 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `ListSourcesResponse`; indicates that this - * is a continuation of a prior `ListSources` call, and that the system - * should return the next page of data. + * The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Resource name of the parent of sources to list. Its format should be - * "organizations/[organization_id]". + * Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". */ parent?: string; } @@ -2637,9 +2264,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of this source. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456" + * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" */ name?: string; /** @@ -2660,8 +2285,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2678,8 +2302,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2697,8 +2320,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.sources.findings.create - * @desc Creates a finding. The corresponding source must exist for finding - * creation to succeed. + * @desc Creates a finding. The corresponding source must exist for finding creation to succeed. * @alias securitycenter.organizations.sources.findings.create * @memberOf! () * @@ -2773,9 +2395,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.sources.findings.group - * @desc Filters an organization or source's findings and groups them by - * their specified properties. To group across all sources provide a `-` as - * the source id. Example: /v1beta1/organizations/123/sources/-/findings + * @desc Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1beta1/organizations/123/sources/-/findings * @alias securitycenter.organizations.sources.findings.group * @memberOf! () * @@ -2853,9 +2473,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.sources.findings.list - * @desc Lists an organization or source's findings. To list across all - * sources provide a `-` as the source id. Example: - * /v1beta1/organizations/123/sources/-/findings + * @desc Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1beta1/organizations/123/sources/-/findings * @alias securitycenter.organizations.sources.findings.list * @memberOf! () * @@ -2938,8 +2556,7 @@ export namespace securitycenter_v1beta1 { /** * securitycenter.organizations.sources.findings.patch - * @desc Creates or updates a finding. The corresponding source must exist - * for a finding creation to succeed. + * @desc Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. * @alias securitycenter.organizations.sources.findings.patch * @memberOf! () * @@ -3169,14 +2786,11 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Unique identifier provided by the client within the parent scope. It must - * be alphanumeric and less than or equal to 32 characters and greater than - * 0 characters in length. + * Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. */ findingId?: string; /** - * Resource name of the new finding's parent. Its format should be - * "organizations/[organization_id]/sources/[source_id]". + * Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". */ parent?: string; @@ -3193,10 +2807,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the source to groupBy. Its format is - * "organizations/[organization_id]/sources/[source_id]". To groupBy across - * all sources provide a source_id of `-`. For example: - * organizations/123/sources/- + * Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/123/sources/- */ parent?: string; @@ -3213,60 +2824,31 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. A field mask to specify the Finding fields to be listed in the - * response. An empty field mask will list all fields. + * Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** - * Expression that defines the filter to apply across findings. The - * expression is a list of one or more restrictions combined via logical - * operators `AND` and `OR`. Parentheses are not supported, and `OR` has - * higher precedence than `AND`. Restrictions have the form ` - * ` and may have a `-` character in front of them to - * indicate negation. Examples include: * name * - * source_properties.a_property * security_marks.marks.marka The supported - * operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for - * integer values. * `:`, meaning substring matching, for strings. The - * supported value types are: * string literals in quotes. * integer - * literals without quotes. * boolean literals `true` and `false` without - * quotes. For example, `source_properties.size = 100` is a valid filter - * string. + * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what fields and order to use for sorting. The - * string value should follow SQL syntax: comma separated list of fields. - * For example: "name,resource_properties.a_property". The default sorting - * order is ascending. To specify descending order for a field, a suffix " - * desc" should be appended to the field name. For example: "name - * desc,source_properties.a_property". Redundant space characters in the - * syntax are insignificant. "name desc,source_properties.a_property" and " - * name desc , source_properties.a_property " are equivalent. + * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. */ orderBy?: string; /** - * The maximum number of results to return in a single response. Default is - * 10, minimum is 1, maximum is 1000. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ pageSize?: number; /** - * The value returned by the last `ListFindingsResponse`; indicates that - * this is a continuation of a prior `ListFindings` call, and that the - * system should return the next page of data. + * The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Name of the source the findings belong to. Its format is - * "organizations/[organization_id]/sources/[source_id]". To list across all - * sources provide a source_id of `-`. For example: - * organizations/123/sources/- + * Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/123/sources/- */ parent?: string; /** - * Time used as a reference point when filtering findings. The filter is - * limited to findings existing at the supplied time and their values are - * those at that specific time. Absence of this field will default to the - * API's version of NOW. + * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. */ readTime?: string; } @@ -3278,14 +2860,11 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of this finding. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456/findings/789" + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" */ name?: string; /** - * The FieldMask to use when updating the finding resource. This field - * should not be specified when creating a finding. + * The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. */ updateMask?: string; @@ -3302,9 +2881,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the finding. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Example: "organizations/123/sources/456/finding/789". + * The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/finding/789". */ name?: string; @@ -3321,10 +2898,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the SecurityMarks. See: - * https://cloud.google.com/apis/design/resource_names#relative_resource_name - * Examples: "organizations/123/assets/456/securityMarks" - * "organizations/123/sources/456/findings/789/securityMarks". + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". */ name?: string; /** diff --git a/src/apis/servicebroker/package.json b/src/apis/servicebroker/package.json index 0acd8d2b0aa..10847500eba 100644 --- a/src/apis/servicebroker/package.json +++ b/src/apis/servicebroker/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index 18e21f642f4..522857138d9 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace servicebroker_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace servicebroker_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace servicebroker_v1 { /** * Service Broker API * - * The Google Cloud Platform Service Broker API provides Google hosted - * implementation of the Open Service Broker API - * (https://www.openservicebrokerapi.org/). + * The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). * * @example * const {google} = require('googleapis'); @@ -114,7 +108,10 @@ export namespace servicebroker_v1 { v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.v1 = new Resource$V1(this.context); } @@ -125,69 +122,28 @@ export namespace servicebroker_v1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -200,10 +156,7 @@ export namespace servicebroker_v1 { */ export interface Schema$GoogleIamV1__SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$GoogleIamV1__Policy; } @@ -212,10 +165,7 @@ export namespace servicebroker_v1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -224,37 +174,28 @@ export namespace servicebroker_v1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$GoogleType__Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -267,8 +208,7 @@ export namespace servicebroker_v1 { /** * servicebroker.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias servicebroker.getIamPolicy * @memberOf! () * @@ -344,8 +284,7 @@ export namespace servicebroker_v1 { /** * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias servicebroker.setIamPolicy * @memberOf! () * @@ -422,11 +361,7 @@ export namespace servicebroker_v1 { /** * servicebroker.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias servicebroker.testIamPermissions * @memberOf! () * @@ -525,8 +460,7 @@ export namespace servicebroker_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -537,8 +471,7 @@ export namespace servicebroker_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -555,8 +488,7 @@ export namespace servicebroker_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index e2477287c78..1df7925999f 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace servicebroker_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace servicebroker_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace servicebroker_v1alpha1 { /** * Service Broker API * - * The Google Cloud Platform Service Broker API provides Google hosted - * implementation of the Open Service Broker API - * (https://www.openservicebrokerapi.org/). + * The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace servicebroker_v1alpha1 { v1alpha1: Resource$V1alpha1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); this.v1alpha1 = new Resource$V1alpha1(this.context); @@ -127,13 +124,11 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__Binding { /** - * The id of the binding. Must be unique within GCP project. Maximum length - * is 64, GUID recommended. Required. + * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ binding_id?: string; /** - * A JSON object that contains data for platform resources associated with - * the binding to be created. + * A JSON object that contains data for platform resources associated with the binding to be created. */ bind_resource?: {[key: string]: any}; /** @@ -145,14 +140,11 @@ export namespace servicebroker_v1alpha1 { */ parameters?: {[key: string]: any}; /** - * The ID of the plan. See `Service` and `Plan` resources for details. - * Maximum length is 64, GUID recommended. Required. + * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ plan_id?: string; /** - * The id of the service. Must be a valid identifier of a service contained - * in the list from a `ListServices()` call. Maximum length is 64, GUID - * recommended. Required. + * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ service_id?: string; } @@ -165,20 +157,15 @@ export namespace servicebroker_v1alpha1 { */ credentials?: {[key: string]: any}; /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. This - * broker always executes all create/delete operations asynchronously. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously. */ operation?: string; /** - * A URL to which the platform may proxy requests for the address sent with - * bind_resource.route + * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ route_service_url?: string; /** @@ -195,15 +182,11 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. This - * broker always will return a non-empty operation on success. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success. */ operation?: string; } @@ -216,8 +199,7 @@ export namespace servicebroker_v1alpha1 { */ id?: string; /** - * A URI for the service dashboard. Validated by the OAuth token server when - * the dashboard requests a token. + * A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. */ redirect_uri?: string; /** @@ -230,14 +212,11 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } @@ -246,14 +225,11 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } @@ -266,14 +242,11 @@ export namespace servicebroker_v1alpha1 { */ credentials?: {[key: string]: any}; /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * A URL to which the platform may proxy requests for the address sent with - * bind_resource.route + * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ route_service_url?: string; /** @@ -294,17 +267,11 @@ export namespace servicebroker_v1alpha1 { */ bindings?: Schema$GoogleCloudServicebrokerV1alpha1__Binding[]; /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; } @@ -313,17 +280,11 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; /** @@ -336,9 +297,7 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** @@ -346,11 +305,7 @@ export namespace servicebroker_v1alpha1 { */ instances?: Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance[]; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; } @@ -363,8 +318,7 @@ export namespace servicebroker_v1alpha1 { */ description?: string; /** - * The state of the operation. Valid values are: "in progress", - * "succeeded", and "failed". + * The state of the operation. Valid values are: "in progress", "succeeded", and "failed". */ state?: string; } @@ -373,8 +327,7 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__Plan { /** - * Specifies whether instances of the service can be bound to applications. - * If not specified, `Service.bindable` will be presumed. + * Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed. */ bindable?: boolean; /** @@ -386,19 +339,15 @@ export namespace servicebroker_v1alpha1 { */ free?: boolean; /** - * ID is a globally unique identifier used to uniquely identify the plan. - * User must make no presumption about the format of this field. + * ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field. */ id?: string; /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON - * object. + * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ metadata?: {[key: string]: any}; /** - * User friendly name of the plan. The name must be globally unique within - * GCP project. Note, which is different from ("This must be globally - * unique within a platform marketplace"). + * User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). */ name?: string; /** @@ -407,15 +356,11 @@ export namespace servicebroker_v1alpha1 { schemas?: {[key: string]: any}; } /** - * The resource model mostly follows the Open Service Broker API, as described - * here: - * https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md - * Though due to Google Specifics it has additional optional fields. + * The resource model mostly follows the Open Service Broker API, as described here: https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md Though due to Google Specifics it has additional optional fields. */ export interface Schema$GoogleCloudServicebrokerV1alpha1__Service { /** - * Specifies whether instances of the service can be bound to applications. - * Required. + * Specifies whether instances of the service can be bound to applications. Required. */ bindable?: boolean; /** @@ -431,8 +376,7 @@ export namespace servicebroker_v1alpha1 { */ description?: string; /** - * ID is a globally unique identifier used to uniquely identify the service. - * ID is an opaque string. + * ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string. */ id?: string; /** @@ -440,15 +384,11 @@ export namespace servicebroker_v1alpha1 { */ instance_retrievable?: boolean; /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON - * object. + * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ metadata?: {[key: string]: any}; /** - * User friendly service name. Name must match [a-z0-9]+ regexp. The name - * must be globally unique within GCP project. Note, which is different from - * ("This must be globally unique within a platform marketplace"). - * Required. + * User friendly service name. Name must match [a-z0-9]+ regexp. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). Required. */ name?: string; /** @@ -460,21 +400,16 @@ export namespace servicebroker_v1alpha1 { */ plan_updateable?: boolean; /** - * Tags provide a flexible mechanism to expose a classification, attribute, - * or base technology of a service. + * Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service. */ tags?: string[]; } /** - * Message describing inputs to Provision and Update Service instance - * requests. + * Message describing inputs to Provision and Update Service instance requests. */ export interface Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance { /** - * Platform specific contextual information under which the service instance - * is to be provisioned. This replaces organization_guid and space_guid. But - * can also contain anything. Currently only used for logging context - * information. + * Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information. */ context?: {[key: string]: any}; /** @@ -482,49 +417,39 @@ export namespace servicebroker_v1alpha1 { */ createTime?: string; /** - * Output only. Name of the Deployment Manager deployment used for - * provisioning of this service instance. + * Output only. Name of the Deployment Manager deployment used for provisioning of this service instance. */ deploymentName?: string; /** - * The id of the service instance. Must be unique within GCP project. - * Maximum length is 64, GUID recommended. Required. + * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ instance_id?: string; /** - * The platform GUID for the organization under which the service is to be - * provisioned. Required. + * The platform GUID for the organization under which the service is to be provisioned. Required. */ organization_guid?: string; /** - * Configuration options for the service instance. Parameters is JSON object - * serialized to string. + * Configuration options for the service instance. Parameters is JSON object serialized to string. */ parameters?: {[key: string]: any}; /** - * The ID of the plan. See `Service` and `Plan` resources for details. - * Maximum length is 64, GUID recommended. Required. + * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ plan_id?: string; /** - * Used only in UpdateServiceInstance request to optionally specify previous - * fields. + * Used only in UpdateServiceInstance request to optionally specify previous fields. */ previous_values?: {[key: string]: any}; /** - * Output only. The resource name of the instance, e.g. - * projects/project_id/brokers/broker_id/service_instances/instance_id + * Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id */ resourceName?: string; /** - * The id of the service. Must be a valid identifier of a service contained - * in the list from a `ListServices()` call. Maximum length is 64, GUID - * recommended. Required. + * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ service_id?: string; /** - * The identifier for the project space within the platform organization. - * Required. + * The identifier for the project space within the platform organization. Required. */ space_guid?: string; } @@ -533,14 +458,11 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } @@ -549,69 +471,28 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -624,10 +505,7 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleIamV1__SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$GoogleIamV1__Policy; } @@ -636,10 +514,7 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -648,37 +523,28 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$GoogleType__Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -719,9 +585,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.instances.get - * @desc Gets the given service instance from the system. This API is an - * extension and not part of the OSB spec. Hence the path is a standard - * Google API URL. + * @desc Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. * @alias servicebroker.projects.brokers.instances.get * @memberOf! () * @@ -947,19 +811,15 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. Optional. If - * unset or 0, all the results will be returned. + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** - * Parent must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. + * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. */ parent?: string; } @@ -972,8 +832,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.service_instances.list - * @desc Lists all the instances in the brokers This API is an extension and - * not part of the OSB spec. Hence the path is a standard Google API URL. + * @desc Lists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. * @alias servicebroker.projects.brokers.service_instances.list * @memberOf! () * @@ -1083,14 +942,11 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. Optional. If - * unset or 0, all the results will be returned. + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -1120,9 +976,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.catalog.list - * @desc Lists all the Services registered with this broker for consumption - * for given service registry broker, which contains an set of services. - * Note, that Service producer API is separate from Broker API. + * @desc Lists all the Services registered with this broker for consumption for given service registry broker, which contains an set of services. Note, that Service producer API is separate from Broker API. * @alias servicebroker.projects.brokers.v2.catalog.list * @memberOf! () * @@ -1232,14 +1086,11 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. Optional. If - * unset or 0, all the results will be returned. + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -1260,16 +1111,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.create - * @desc Provisions a service instance. If `request.accepts_incomplete` is - * false and Broker cannot execute request synchronously HTTP 422 error will - * be returned along with FAILED_PRECONDITION status. If - * `request.accepts_incomplete` is true and the Broker decides to execute - * resource asynchronously then HTTP 202 response code will be returned and - * a valid polling operation in the response will be included. If Broker - * executes the request synchronously and it succeeds HTTP 201 response will - * be furnished. If identical instance exists, then HTTP 200 response will - * be returned. If an instance with identical ID but mismatching parameters - * exists, then HTTP 409 status code will be returned. + * @desc Provisions a service instance. If `request.accepts_incomplete` is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If `request.accepts_incomplete` is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned. * @alias servicebroker.projects.brokers.v2.service_instances.create * @memberOf! () * @@ -1373,9 +1215,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.delete - * @desc Deprovisions a service instance. For synchronous/asynchronous - * request details see CreateServiceInstance method. If service instance - * does not exist HTTP 410 status will be returned. + * @desc Deprovisions a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If service instance does not exist HTTP 410 status will be returned. * @alias servicebroker.projects.brokers.v2.service_instances.delete * @memberOf! () * @@ -1479,9 +1319,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.get - * @desc Gets the given service instance from the system. This API is an - * extension and not part of the OSB spec. Hence the path is a standard - * Google API URL. + * @desc Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. * @alias servicebroker.projects.brokers.v2.service_instances.get * @memberOf! () * @@ -1577,10 +1415,8 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.getLast_operation - * @desc Returns the state of the last operation for the service instance. - * Only last (or current) operation can be polled. - * @alias - * servicebroker.projects.brokers.v2.service_instances.getLast_operation + * @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled. + * @alias servicebroker.projects.brokers.v2.service_instances.getLast_operation * @memberOf! () * * @param {object} params Parameters for request @@ -1683,8 +1519,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.patch - * @desc Updates an existing service instance. See CreateServiceInstance for - * possible response codes. + * @desc Updates an existing service instance. See CreateServiceInstance for possible response codes. * @alias servicebroker.projects.brokers.v2.service_instances.patch * @memberOf! () * @@ -1795,17 +1630,11 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Value indicating that API client supports asynchronous operations. If - * Broker cannot execute the request synchronously HTTP 422 code will be - * returned to HTTP clients along with FAILED_PRECONDITION error. If true - * and broker will execute request asynchronously 202 HTTP code will be - * returned. This broker always requires this to be true as all mutator - * operations are asynchronous. + * Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. */ acceptsIncomplete?: boolean; /** - * The id of the service instance. Must be unique within GCP project. - * Maximum length is 64, GUID recommended. Required. + * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ instance_id?: string; /** @@ -1870,8 +1699,7 @@ export namespace servicebroker_v1alpha1 { */ instanceId?: string; /** - * If `operation` was returned during mutation operation, this field must be - * populated with the provided value. + * If `operation` was returned during mutation operation, this field must be populated with the provided value. */ operation?: string; /** @@ -1899,8 +1727,7 @@ export namespace servicebroker_v1alpha1 { */ acceptsIncomplete?: boolean; /** - * The id of the service instance. Must be unique within GCP project. - * Maximum length is 64, GUID recommended. Required. + * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ instance_id?: string; /** @@ -1922,10 +1749,8 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.create - * @desc CreateBinding generates a service binding to an existing service - * instance. See ProviServiceInstance for async operation details. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.create + * @desc CreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details. + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.create * @memberOf! () * * @param {object} params Parameters for request @@ -2029,11 +1854,8 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.delete - * @desc Unbinds from a service instance. For synchronous/asynchronous - * request details see CreateServiceInstance method. If binding does not - * exist HTTP 410 status will be returned. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.delete + * @desc Unbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will be returned. + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.delete * @memberOf! () * * @param {object} params Parameters for request @@ -2139,8 +1961,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.get * @desc GetBinding returns the binding information. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.get + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.get * @memberOf! () * * @param {object} params Parameters for request @@ -2244,10 +2065,8 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation - * @desc Returns the state of the last operation for the binding. Only last - * (or current) operation can be polled. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation + * @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled. + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation * @memberOf! () * * @param {object} params Parameters for request @@ -2362,8 +2181,7 @@ export namespace servicebroker_v1alpha1 { */ acceptsIncomplete?: boolean; /** - * The id of the binding. Must be unique within GCP project. Maximum length - * is 64, GUID recommended. Required. + * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ binding_id?: string; /** @@ -2371,8 +2189,7 @@ export namespace servicebroker_v1alpha1 { */ instanceId?: string; /** - * The GCP container. Must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. + * The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. */ parent?: string; @@ -2457,8 +2274,7 @@ export namespace servicebroker_v1alpha1 { */ instanceId?: string; /** - * If `operation` was returned during mutation operation, this field must be - * populated with the provided value. + * If `operation` was returned during mutation operation, this field must be populated with the provided value. */ operation?: string; /** @@ -2483,8 +2299,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias servicebroker.getIamPolicy * @memberOf! () * @@ -2561,8 +2376,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias servicebroker.setIamPolicy * @memberOf! () * @@ -2640,11 +2454,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias servicebroker.testIamPermissions * @memberOf! () * @@ -2744,8 +2554,7 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -2757,8 +2566,7 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -2775,8 +2583,7 @@ export namespace servicebroker_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index cd55e760665..7864d9040e5 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace servicebroker_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace servicebroker_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace servicebroker_v1beta1 { /** * Service Broker API * - * The Google Cloud Platform Service Broker API provides Google hosted - * implementation of the Open Service Broker API - * (https://www.openservicebrokerapi.org/). + * The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace servicebroker_v1beta1 { v1beta1: Resource$V1beta1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); this.v1beta1 = new Resource$V1beta1(this.context); @@ -127,13 +124,11 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__Binding { /** - * The id of the binding. Must be unique within GCP project. Maximum length - * is 64, GUID recommended. Required. + * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ binding_id?: string; /** - * A JSON object that contains data for platform resources associated with - * the binding to be created. + * A JSON object that contains data for platform resources associated with the binding to be created. */ bind_resource?: {[key: string]: any}; /** @@ -141,8 +136,7 @@ export namespace servicebroker_v1beta1 { */ createTime?: string; /** - * Output only. String containing the Deployment Manager deployment name - * that was created for this binding, + * Output only. String containing the Deployment Manager deployment name that was created for this binding, */ deploymentName?: string; /** @@ -150,25 +144,20 @@ export namespace servicebroker_v1beta1 { */ parameters?: {[key: string]: any}; /** - * The ID of the plan. See `Service` and `Plan` resources for details. - * Maximum length is 64, GUID recommended. Required. + * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ plan_id?: string; /** - * Output only. The resource name of the binding, e.g. - * projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. + * Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. */ resourceName?: string; /** - * The id of the service. Must be a valid identifier of a service contained - * in the list from a `ListServices()` call. Maximum length is 64, GUID - * recommended. Required. + * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ service_id?: string; } /** - * Broker represents a consumable collection of Service Registry catalogs - * exposed as an OSB Broker. + * Broker represents a consumable collection of Service Registry catalogs exposed as an OSB Broker. */ export interface Schema$GoogleCloudServicebrokerV1beta1__Broker { /** @@ -176,20 +165,15 @@ export namespace servicebroker_v1beta1 { */ createTime?: string; /** - * Name of the broker in the format: - * <projects>/<project-id>/brokers/<broker>. This allows - * for multiple brokers per project which can be used to enable having - * custom brokers per GKE cluster, for example. + * Name of the broker in the format: <projects>/<project-id>/brokers/<broker>. This allows for multiple brokers per project which can be used to enable having custom brokers per GKE cluster, for example. */ name?: string; /** - * User friendly title of the broker. Limited to 1024 characters. Requests - * with longer titles will be rejected. + * User friendly title of the broker. Limited to 1024 characters. Requests with longer titles will be rejected. */ title?: string; /** - * Output only. URL of the broker OSB-compliant endpoint, for example: - * https://servicebroker.googleapis.com/projects/<project>/brokers/<broker> + * Output only. URL of the broker OSB-compliant endpoint, for example: https://servicebroker.googleapis.com/projects/<project>/brokers/<broker> */ url?: string; } @@ -202,20 +186,15 @@ export namespace servicebroker_v1beta1 { */ credentials?: {[key: string]: any}; /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. This - * broker always executes all create/delete operations asynchronously. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously. */ operation?: string; /** - * A URL to which the platform may proxy requests for the address sent with - * bind_resource.route + * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ route_service_url?: string; /** @@ -232,15 +211,11 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. This - * broker always will return a non-empty operation on success. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success. */ operation?: string; } @@ -253,8 +228,7 @@ export namespace servicebroker_v1beta1 { */ id?: string; /** - * A URI for the service dashboard. Validated by the OAuth token server when - * the dashboard requests a token. + * A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. */ redirect_uri?: string; /** @@ -267,14 +241,11 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } @@ -283,14 +254,11 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } @@ -303,24 +271,19 @@ export namespace servicebroker_v1beta1 { */ credentials?: {[key: string]: any}; /** - * String containing the Deployment Manager deployment name that was created - * for this binding, + * String containing the Deployment Manager deployment name that was created for this binding, */ deploymentName?: string; /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * Output only. The resource name of the binding, e.g. - * projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. + * Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. */ resourceName?: string; /** - * A URL to which the platform may proxy requests for the address sent with - * bind_resource.route + * A URL to which the platform may proxy requests for the address sent with bind_resource.route */ route_service_url?: string; /** @@ -341,17 +304,11 @@ export namespace servicebroker_v1beta1 { */ bindings?: Schema$GoogleCloudServicebrokerV1beta1__Binding[]; /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; } @@ -364,11 +321,7 @@ export namespace servicebroker_v1beta1 { */ brokers?: Schema$GoogleCloudServicebrokerV1beta1__Broker[]; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; } @@ -377,17 +330,11 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; /** @@ -400,9 +347,7 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** @@ -410,11 +355,7 @@ export namespace servicebroker_v1beta1 { */ instances?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance[]; /** - * This token allows you to get the next page of results for list requests. - * If the number of results is larger than `pageSize`, use the - * `nextPageToken` as a value for the query parameter `pageToken` in the - * next list request. Subsequent list requests will have their own - * `nextPageToken` to continue paging through the results + * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results */ nextPageToken?: string; } @@ -427,8 +368,7 @@ export namespace servicebroker_v1beta1 { */ description?: string; /** - * The state of the operation. Valid values are: "in progress", - * "succeeded", and "failed". + * The state of the operation. Valid values are: "in progress", "succeeded", and "failed". */ state?: string; } @@ -437,8 +377,7 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__Plan { /** - * Specifies whether instances of the service can be bound to applications. - * If not specified, `Service.bindable` will be presumed. + * Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed. */ bindable?: boolean; /** @@ -450,19 +389,15 @@ export namespace servicebroker_v1beta1 { */ free?: boolean; /** - * ID is a globally unique identifier used to uniquely identify the plan. - * User must make no presumption about the format of this field. + * ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field. */ id?: string; /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON - * object. + * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ metadata?: {[key: string]: any}; /** - * User friendly name of the plan. The name must be globally unique within - * GCP project. Note, which is different from ("This must be globally - * unique within a platform marketplace"). + * User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). */ name?: string; /** @@ -471,15 +406,11 @@ export namespace servicebroker_v1beta1 { schemas?: {[key: string]: any}; } /** - * The resource model mostly follows the Open Service Broker API, as described - * here: - * https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md - * Though due to Google Specifics it has additional optional fields. + * The resource model mostly follows the Open Service Broker API, as described here: https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md Though due to Google Specifics it has additional optional fields. */ export interface Schema$GoogleCloudServicebrokerV1beta1__Service { /** - * Specifies whether instances of the service can be bound to applications. - * Required. + * Specifies whether instances of the service can be bound to applications. Required. */ bindable?: boolean; /** @@ -499,8 +430,7 @@ export namespace servicebroker_v1beta1 { */ description?: string; /** - * ID is a globally unique identifier used to uniquely identify the service. - * ID is an opaque string. + * ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string. */ id?: string; /** @@ -508,15 +438,11 @@ export namespace servicebroker_v1beta1 { */ instances_retrievable?: boolean; /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON - * object. + * A list of metadata for a service offering. Metadata is an arbitrary JSON object. */ metadata?: {[key: string]: any}; /** - * User friendly service name. Name must match [a-z0-9]+ regexp. The name - * must be globally unique within GCP project. Note, which is different from - * ("This must be globally unique within a platform marketplace"). - * Required. + * User friendly service name. Name must match [a-z0-9]+ regexp. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). Required. */ name?: string; /** @@ -528,21 +454,16 @@ export namespace servicebroker_v1beta1 { */ plan_updateable?: boolean; /** - * Tags provide a flexible mechanism to expose a classification, attribute, - * or base technology of a service. + * Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service. */ tags?: string[]; } /** - * Message describing inputs to Provision and Update Service instance - * requests. + * Message describing inputs to Provision and Update Service instance requests. */ export interface Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance { /** - * Platform specific contextual information under which the service instance - * is to be provisioned. This replaces organization_guid and space_guid. But - * can also contain anything. Currently only used for logging context - * information. + * Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information. */ context?: {[key: string]: any}; /** @@ -550,54 +471,43 @@ export namespace servicebroker_v1beta1 { */ createTime?: string; /** - * Output only. String containing the Deployment Manager deployment name - * that was created for this instance, + * Output only. String containing the Deployment Manager deployment name that was created for this instance, */ deploymentName?: string; /** - * To return errors when GetInstance call is done via HTTP to be unified - * with other methods. + * To return errors when GetInstance call is done via HTTP to be unified with other methods. */ description?: string; /** - * The id of the service instance. Must be unique within GCP project. - * Maximum length is 64, GUID recommended. Required. + * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ instance_id?: string; /** - * The platform GUID for the organization under which the service is to be - * provisioned. Required. + * The platform GUID for the organization under which the service is to be provisioned. Required. */ organization_guid?: string; /** - * Configuration options for the service instance. Parameters is JSON object - * serialized to string. + * Configuration options for the service instance. Parameters is JSON object serialized to string. */ parameters?: {[key: string]: any}; /** - * The ID of the plan. See `Service` and `Plan` resources for details. - * Maximum length is 64, GUID recommended. Required. + * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. */ plan_id?: string; /** - * Used only in UpdateServiceInstance request to optionally specify previous - * fields. + * Used only in UpdateServiceInstance request to optionally specify previous fields. */ previous_values?: {[key: string]: any}; /** - * Output only. The resource name of the instance, e.g. - * projects/project_id/brokers/broker_id/service_instances/instance_id + * Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id */ resourceName?: string; /** - * The id of the service. Must be a valid identifier of a service contained - * in the list from a `ListServices()` call. Maximum length is 64, GUID - * recommended. Required. + * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. */ service_id?: string; /** - * The identifier for the project space within the platform organization. - * Required. + * The identifier for the project space within the platform organization. Required. */ space_guid?: string; } @@ -606,14 +516,11 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse { /** - * Used to communicate description of the response. Usually for non-standard - * error codes. - * https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors + * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors */ description?: string; /** - * If broker executes operation asynchronously, this is the operation ID - * that can be polled to check the completion status of said operation. + * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. */ operation?: string; } @@ -622,69 +529,28 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -697,10 +563,7 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleIamV1__SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$GoogleIamV1__Policy; } @@ -709,10 +572,7 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -721,45 +581,32 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleIamV1__TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobuf__Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$GoogleType__Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -1091,14 +938,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. Optional. - * Acceptable values are 0 to 200, inclusive. (Default: 100) + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -1119,10 +963,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.instances.get - * @desc Gets the given service instance from the system. The API call - * accepts both OSB style API and standard google style API resource path. - * i.e. both `projects/x/brokers/x/instances/x` and - * `projects/x/brokers/x/v2/service_instances/x` are acceptable paths. + * @desc Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both `projects/x/brokers/x/instances/x` and `projects/x/brokers/x/v2/service_instances/x` are acceptable paths. * @alias servicebroker.projects.brokers.instances.get * @memberOf! () * @@ -1218,8 +1059,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.instances.getLast_operation - * @desc Returns the state of the last operation for the service instance. - * Only last (or current) operation can be polled. + * @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled. * @alias servicebroker.projects.brokers.instances.getLast_operation * @memberOf! () * @@ -1320,8 +1160,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.instances.list - * @desc Lists all the instances in the brokers This API is an extension and - * not part of the OSB spec. Hence the path is a standard Google API URL. + * @desc Lists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. * @alias servicebroker.projects.brokers.instances.list * @memberOf! () * @@ -1431,10 +1270,7 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the instance to return. Name must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + - * `v2/service_instances/[INSTANCE_ID]` or - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. + * The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -1446,13 +1282,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ - * `service_instances/[INSTANCE_ID]`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`. */ name?: string; /** - * If `operation` was returned during mutation operation, this field must be - * populated with the provided value. + * If `operation` was returned during mutation operation, this field must be populated with the provided value. */ operation?: string; /** @@ -1472,14 +1306,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. Optional. - * Acceptable values are 0 to 200, inclusive. (Default: 100) + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -1496,10 +1327,8 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.instances.bindings.getLast_operation - * @desc Returns the state of the last operation for the binding. Only last - * (or current) operation can be polled. - * @alias - * servicebroker.projects.brokers.instances.bindings.getLast_operation + * @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled. + * @alias servicebroker.projects.brokers.instances.bindings.getLast_operation * @memberOf! () * * @param {object} params Parameters for request @@ -1709,13 +1538,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. */ name?: string; /** - * If `operation` was returned during mutation operation, this field must be - * populated with the provided value. + * If `operation` was returned during mutation operation, this field must be populated with the provided value. */ operation?: string; /** @@ -1735,20 +1562,15 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. Optional. - * Acceptable values are 0 to 200, inclusive. (Default: 100) + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + - * `v2/service_instances/[INSTANCE_ID]` or - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. + * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. */ parent?: string; } @@ -1774,9 +1596,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.catalog.list - * @desc Lists all the Services registered with this broker for consumption - * for given service registry broker, which contains an set of services. - * Note, that Service producer API is separate from Broker API. + * @desc Lists all the Services registered with this broker for consumption for given service registry broker, which contains an set of services. Note, that Service producer API is separate from Broker API. * @alias servicebroker.projects.brokers.v2.catalog.list * @memberOf! () * @@ -1886,14 +1706,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the number of results to return per page. If there are fewer - * elements than the specified number, returns all elements. Optional. If - * unset or 0, all the results will be returned. + * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. */ pageSize?: number; /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` - * returned by a previous list request to get the next page of results. + * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -1914,16 +1731,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.create - * @desc Provisions a service instance. If `request.accepts_incomplete` is - * false and Broker cannot execute request synchronously HTTP 422 error will - * be returned along with FAILED_PRECONDITION status. If - * `request.accepts_incomplete` is true and the Broker decides to execute - * resource asynchronously then HTTP 202 response code will be returned and - * a valid polling operation in the response will be included. If Broker - * executes the request synchronously and it succeeds HTTP 201 response will - * be furnished. If identical instance exists, then HTTP 200 response will - * be returned. If an instance with identical ID but mismatching parameters - * exists, then HTTP 409 status code will be returned. + * @desc Provisions a service instance. If `request.accepts_incomplete` is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If `request.accepts_incomplete` is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned. * @alias servicebroker.projects.brokers.v2.service_instances.create * @memberOf! () * @@ -2026,9 +1834,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.delete - * @desc Deprovisions a service instance. For synchronous/asynchronous - * request details see CreateServiceInstance method. If service instance - * does not exist HTTP 410 status will be returned. + * @desc Deprovisions a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If service instance does not exist HTTP 410 status will be returned. * @alias servicebroker.projects.brokers.v2.service_instances.delete * @memberOf! () * @@ -2129,10 +1935,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.get - * @desc Gets the given service instance from the system. The API call - * accepts both OSB style API and standard google style API resource path. - * i.e. both `projects/x/brokers/x/instances/x` and - * `projects/x/brokers/x/v2/service_instances/x` are acceptable paths. + * @desc Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both `projects/x/brokers/x/instances/x` and `projects/x/brokers/x/v2/service_instances/x` are acceptable paths. * @alias servicebroker.projects.brokers.v2.service_instances.get * @memberOf! () * @@ -2228,10 +2031,8 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.getLast_operation - * @desc Returns the state of the last operation for the service instance. - * Only last (or current) operation can be polled. - * @alias - * servicebroker.projects.brokers.v2.service_instances.getLast_operation + * @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled. + * @alias servicebroker.projects.brokers.v2.service_instances.getLast_operation * @memberOf! () * * @param {object} params Parameters for request @@ -2331,8 +2132,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.patch - * @desc Updates an existing service instance. See CreateServiceInstance for - * possible response codes. + * @desc Updates an existing service instance. See CreateServiceInstance for possible response codes. * @alias servicebroker.projects.brokers.v2.service_instances.patch * @memberOf! () * @@ -2439,17 +2239,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Value indicating that API client supports asynchronous operations. If - * Broker cannot execute the request synchronously HTTP 422 code will be - * returned to HTTP clients along with FAILED_PRECONDITION error. If true - * and broker will execute request asynchronously 202 HTTP code will be - * returned. This broker always requires this to be true as all mutator - * operations are asynchronous. + * Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. */ acceptsIncomplete?: boolean; /** - * The id of the service instance. Must be unique within GCP project. - * Maximum length is 64, GUID recommended. Required. + * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ instance_id?: string; /** @@ -2474,9 +2268,7 @@ export namespace servicebroker_v1beta1 { */ acceptsIncomplete?: boolean; /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + - * `v2/service_instances/[INSTANCE_ID]` or - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. */ name?: string; /** @@ -2496,10 +2288,7 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the instance to return. Name must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + - * `v2/service_instances/[INSTANCE_ID]` or - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. + * The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. */ name?: string; } @@ -2511,13 +2300,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ - * `service_instances/[INSTANCE_ID]`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`. */ name?: string; /** - * If `operation` was returned during mutation operation, this field must be - * populated with the provided value. + * If `operation` was returned during mutation operation, this field must be populated with the provided value. */ operation?: string; /** @@ -2541,8 +2328,7 @@ export namespace servicebroker_v1beta1 { */ acceptsIncomplete?: boolean; /** - * Name must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. */ name?: string; @@ -2560,10 +2346,8 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.create - * @desc CreateBinding generates a service binding to an existing service - * instance. See ProviServiceInstance for async operation details. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.create + * @desc CreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details. + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.create * @memberOf! () * * @param {object} params Parameters for request @@ -2665,11 +2449,8 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.delete - * @desc Unbinds from a service instance. For synchronous/asynchronous - * request details see CreateServiceInstance method. If binding does not - * exist HTTP 410 status will be returned. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.delete + * @desc Unbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will be returned. + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.delete * @memberOf! () * * @param {object} params Parameters for request @@ -2770,8 +2551,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.get * @desc GetBinding returns the binding information. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.get + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.get * @memberOf! () * * @param {object} params Parameters for request @@ -2870,10 +2650,8 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation - * @desc Returns the state of the last operation for the binding. Only last - * (or current) operation can be polled. - * @alias - * servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation + * @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled. + * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation * @memberOf! () * * @param {object} params Parameters for request @@ -2984,13 +2762,11 @@ export namespace servicebroker_v1beta1 { */ acceptsIncomplete?: boolean; /** - * The id of the binding. Must be unique within GCP project. Maximum length - * is 64, GUID recommended. Required. + * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. */ binding_id?: string; /** - * The GCP container. Must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. + * The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. */ parent?: string; @@ -3011,10 +2787,7 @@ export namespace servicebroker_v1beta1 { */ acceptsIncomplete?: boolean; /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` - * `v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID]` or - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` - * `/instances/[INSTANCE_ID]/bindings/[BINDING_ID]`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `/instances/[INSTANCE_ID]/bindings/[BINDING_ID]`. */ name?: string; /** @@ -3034,8 +2807,7 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_bindings`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_bindings`. */ name?: string; /** @@ -3055,13 +2827,11 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name must match - * `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. + * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. */ name?: string; /** - * If `operation` was returned during mutation operation, this field must be - * populated with the provided value. + * If `operation` was returned during mutation operation, this field must be populated with the provided value. */ operation?: string; /** @@ -3082,8 +2852,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias servicebroker.getIamPolicy * @memberOf! () * @@ -3160,8 +2929,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias servicebroker.setIamPolicy * @memberOf! () * @@ -3239,11 +3007,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias servicebroker.testIamPermissions * @memberOf! () * @@ -3343,8 +3107,7 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -3356,8 +3119,7 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3374,8 +3136,7 @@ export namespace servicebroker_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/serviceconsumermanagement/package.json b/src/apis/serviceconsumermanagement/package.json index 35155a25730..5249c225371 100644 --- a/src/apis/serviceconsumermanagement/package.json +++ b/src/apis/serviceconsumermanagement/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 199d55417f9..c9b025f710f 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace serviceconsumermanagement_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace serviceconsumermanagement_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -113,7 +109,10 @@ export namespace serviceconsumermanagement_v1 { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.services = new Resource$Services(this.context); @@ -121,13 +120,11 @@ export namespace serviceconsumermanagement_v1 { } /** - * Request to add a newly created and configured tenant project to a tenancy - * unit. + * Request to add a newly created and configured tenant project to a tenancy unit. */ export interface Schema$AddTenantProjectRequest { /** - * Configuration of the new tenant project to be added to tenancy unit - * resources. + * Configuration of the new tenant project to be added to tenancy unit resources. */ projectConfig?: Schema$TenantProjectConfig; /** @@ -136,14 +133,7 @@ export namespace serviceconsumermanagement_v1 { tag?: string; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also - * described as "protocol buffer services" in some contexts, such as - * by the "service" keyword in a .proto file, but they are different - * from API Services, which represent a concrete implementation of an - * interface as opposed to simply a description of methods and bindings. They - * are also sometimes simply referred to as "APIs" in other - * contexts, such as the name of this message itself. See - * https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ export interface Schema$Api { /** @@ -155,8 +145,7 @@ export namespace serviceconsumermanagement_v1 { */ mixins?: Schema$Mixin[]; /** - * The fully qualified name of this interface, including package name - * followed by the interface's simple name. + * The fully qualified name of this interface, including package name followed by the interface's simple name. */ name?: string; /** @@ -164,8 +153,7 @@ export namespace serviceconsumermanagement_v1 { */ options?: Schema$Option[]; /** - * Source context for the protocol buffer service represented by this - * message. + * Source context for the protocol buffer service represented by this message. */ sourceContext?: Schema$SourceContext; /** @@ -173,21 +161,7 @@ export namespace serviceconsumermanagement_v1 { */ syntax?: string; /** - * A version string for this interface. If specified, must have the form - * `major-version.minor-version`, as in `1.10`. If the minor version is - * omitted, it defaults to zero. If the entire version field is empty, the - * major version is derived from the package name, as outlined below. If the - * field is not empty, the version in the package name will be verified to - * be consistent with what is provided here. The versioning schema uses - * [semantic versioning](http://semver.org) where the major version number - * indicates a breaking change and the minor version an additive, - * non-breaking change. Both version numbers are signals to users what to - * expect from different versions, and should be carefully chosen based on - * the product plan. The major version is also reflected in the package - * name of the interface, which must end in `v<major-version>`, as in - * `google.feature.v1`. For major versions 0 and 1, the suffix can be - * omitted. Zero major versions must only be used for experimental, non-GA - * interfaces. + * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ version?: string; } @@ -205,36 +179,24 @@ export namespace serviceconsumermanagement_v1 { tag?: string; } /** - * Request to attach an existing project to the tenancy unit as a new tenant - * resource. + * Request to attach an existing project to the tenancy unit as a new tenant resource. */ export interface Schema$AttachTenantProjectRequest { /** - * When attaching an external project, this is in the format of - * `projects/{project_number}`. + * When attaching an external project, this is in the format of `projects/{project_number}`. */ externalResource?: string; /** - * When attaching a reserved project already in tenancy units, this is the - * tag of a tenant resource under the tenancy unit for the managed - * service's service producer project. The reserved tenant resource must - * be in an active state. + * When attaching a reserved project already in tenancy units, this is the tag of a tenant resource under the tenancy unit for the managed service's service producer project. The reserved tenant resource must be in an active state. */ reservedResource?: string; /** - * Tag of the tenant resource after attachment. Must be less than 128 - * characters. Required. + * Tag of the tenant resource after attachment. Must be less than 128 characters. Required. */ tag?: string; } /** - * `Authentication` defines the authentication configuration for an API. - * Example for an API targeted for external use: name: - * calendar.googleapis.com authentication: providers: - id: - * google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Authentication { /** @@ -242,18 +204,12 @@ export namespace serviceconsumermanagement_v1 { */ providers?: Schema$AuthProvider[]; /** - * A list of authentication rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$AuthenticationRule[]; } /** - * Authentication rules for the service. By default, if a method has any - * authentication requirements, every request must include a valid credential - * matching one of the requirements. It's an error to include more than - * one kind of credential in a single request. If a method doesn't have - * any auth requirements, request credentials will be ignored. + * Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored. */ export interface Schema$AuthenticationRule { /** @@ -269,96 +225,45 @@ export namespace serviceconsumermanagement_v1 { */ requirements?: Schema$AuthRequirement[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Configuration of authorization. This section determines the authorization - * provider, if unspecified, then no authorization check will be done. - * Example: experimental: authorization: provider: - * firebaserules.googleapis.com - */ - export interface Schema$AuthorizationConfig { - /** - * The name of the authorization provider, such as - * firebaserules.googleapis.com. - */ - provider?: string; - } - /** - * Configuration for an authentication provider, including support for [JSON - * Web Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthProvider { /** - * The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * Redirect URL if JWT token is required but not present or is expired. - * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ authorizationUrl?: string; /** - * The unique identifier of the auth provider. It will be referred to by - * `AuthRequirement.provider_id`. Example: "bookstore_auth". + * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ id?: string; /** - * Identifies the principal that issued the JWT. See - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - * Usually a URL or an email address. Example: - * https://securetoken.google.com Example: - * 1234567-compute@developer.gserviceaccount.com + * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ issuer?: string; /** - * URL of the provider's public key set to validate signature of the - * JWT. See [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - * Optional if the key set document: - can be retrieved from [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: - * https://www.googleapis.com/oauth2/v1/certs + * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string; } /** - * User-defined authentication requirements, including support for [JSON Web - * Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthRequirement { /** - * NOTE: This will be deprecated soon, once AuthProvider.audiences is - * implemented and accepted in all the runtime components. The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * id from authentication provider. Example: provider_id: - * bookstore_auth + * id from authentication provider. Example: provider_id: bookstore_auth */ providerId?: string; } @@ -367,9 +272,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$Backend { /** - * A list of API backend rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$BackendRule[]; } @@ -382,9 +285,7 @@ export namespace serviceconsumermanagement_v1 { */ address?: string; /** - * The number of seconds to wait for a response from a request. The default - * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 - * seconds. + * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ deadline?: number; /** @@ -392,40 +293,25 @@ export namespace serviceconsumermanagement_v1 { */ jwtAudience?: string; /** - * Minimum deadline in seconds needed for this method. Calls having deadline - * value lower than this will be rejected. + * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ minDeadline?: number; /** - * The number of seconds to wait for the completion of a long running - * operation. The default is no deadline. + * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ operationDeadline?: number; pathTranslation?: string; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Billing related configuration of the service. The following example shows - * how to configure monitored resources and metrics for billing: - * monitored_resources: - type: library.googleapis.com/branch labels: - - * key: /city description: The city where the library branch is - * located in. - key: /name description: The name of the branch. - * metrics: - name: library.googleapis.com/book/borrowed_count - * metric_kind: DELTA value_type: INT64 billing: - * consumer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/borrowed_count + * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** - * Billing configurations for sending metrics to the consumer project. There - * can be multiple consumer destinations per service, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. + * Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. */ consumerDestinations?: Schema$BillingDestination[]; } @@ -434,24 +320,20 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$BillingConfig { /** - * Name of the billing account. For example - * `billingAccounts/012345-567890-ABCDEF`. + * Name of the billing account. For example `billingAccounts/012345-567890-ABCDEF`. */ billingAccount?: string; } /** - * Configuration of a specific billing destination (Currently only support - * bill against consumer project). + * Configuration of a specific billing destination (Currently only support bill against consumer project). */ export interface Schema$BillingDestination { /** - * Names of the metrics to report to this billing destination. Each name - * must be defined in Service.metrics section. + * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } @@ -460,44 +342,24 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$CancelOperationRequest {} /** - * `Context` defines which contexts an API requests. Example: context: - * rules: - selector: "*" requested: - - * google.rpc.context.ProjectContext - - * google.rpc.context.OriginContext The above specifies that all methods in - * the API request `google.rpc.context.ProjectContext` and - * `google.rpc.context.OriginContext`. Available context types are defined in - * package `google.rpc.context`. This also provides mechanism to whitelist - * any protobuf message extension that can be sent in grpc metadata using - * “x-goog-ext-<extension_id>-bin” and - * “x-goog-ext-<extension_id>-jspb” format. For example, list any - * service specific protobuf types that can appear in grpc metadata as follows - * in your yaml file: Example: context: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allowed_request_extensions: - google.foo.v1.NewExtension - * allowed_response_extensions: - google.foo.v1.NewExtension You can - * also specify extension ID instead of fully qualified extension name here. + * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ export interface Schema$Context { /** - * A list of RPC context rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$ContextRule[]; } /** - * A context rule provides information about the context for an individual API - * element. + * A context rule provides information about the context for an individual API element. */ export interface Schema$ContextRule { /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from client to backend. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ allowedRequestExtensions?: string[]; /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from backend to client. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ allowedResponseExtensions?: string[]; /** @@ -509,55 +371,38 @@ export namespace serviceconsumermanagement_v1 { */ requested?: string[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Selects and configures the service controller used by the service. The - * service controller handles features like abuse, quota, billing, logging, - * monitoring, etc. + * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. */ export interface Schema$Control { /** - * The service control environment to use. If empty, no control plane - * feature (like quota and billing) will be enabled. + * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ environment?: string; } /** - * Request to create a tenancy unit for a service consumer of a managed - * service. + * Request to create a tenancy unit for a service consumer of a managed service. */ export interface Schema$CreateTenancyUnitRequest { /** - * Optional service producer-provided identifier of the tenancy unit. Must - * be no longer than 40 characters and preferably URI friendly. If it - * isn't provided, a UID for the tenancy unit is automatically - * generated. The identifier must be unique across a managed service. If the - * tenancy unit already exists for the managed service and service consumer - * pair, calling `CreateTenancyUnit` returns the existing tenancy unit if - * the provided identifier is identical or empty, otherwise the call fails. + * Optional service producer-provided identifier of the tenancy unit. Must be no longer than 40 characters and preferably URI friendly. If it isn't provided, a UID for the tenancy unit is automatically generated. The identifier must be unique across a managed service. If the tenancy unit already exists for the managed service and service consumer pair, calling `CreateTenancyUnit` returns the existing tenancy unit if the provided identifier is identical or empty, otherwise the call fails. */ tenancyUnitId?: string; } /** - * Customize service error responses. For example, list any service specific - * protobuf types that can appear in error detail lists of error responses. - * Example: custom_error: types: - google.foo.v1.CustomError - * - google.foo.v1.AnotherError + * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError */ export interface Schema$CustomError { /** - * The list of custom error rules that apply to individual API messages. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$CustomErrorRule[]; /** - * The list of custom error detail types, e.g. - * 'google.foo.v1.CustomError'. + * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ types?: string[]; } @@ -566,13 +411,11 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$CustomErrorRule { /** - * Mark this message as possible payload in error response. Otherwise, - * objects of this type will be filtered when they appear in error payload. + * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ isErrorType?: boolean; /** - * Selects messages to which this rule applies. Refer to selector for - * syntax details. + * Selects messages to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -599,42 +442,7 @@ export namespace serviceconsumermanagement_v1 { tag?: string; } /** - * `Documentation` provides the information for describing a service. Example: - * <pre><code>documentation: summary: > The Google - * Calendar API gives access to most calendar features. pages: - name: - * Overview content: &#40;== include google/foo/overview.md - * ==&#41; - name: Tutorial content: &#40;== include - * google/foo/tutorial.md ==&#41; subpages; - name: Java content: - * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - - * selector: google.calendar.Calendar.Get description: > ... - - * selector: google.calendar.Calendar.Put description: > ... - * </code></pre> Documentation is provided in markdown syntax. In - * addition to standard markdown features, definition lists, tables and fenced - * code blocks are supported. Section headers can be provided and are - * interpreted relative to the section nesting of the context where a - * documentation fragment is embedded. Documentation from the IDL is merged - * with documentation defined via the config at normalization time, where - * documentation provided by config rules overrides IDL provided. A number of - * constructs specific to the API platform are supported in documentation - * text. In order to reference a proto element, the following notation can be - * used: - * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> - * To override the display text used for the link, this can be used: - * <pre><code>&#91;display - * text]&#91;fully.qualified.proto.name]</code></pre> Text can - * be excluded from doc using the following notation: - * <pre><code>&#40;-- internal comment - * --&#41;</code></pre> A few directives are available in - * documentation. Note that directives must appear on a single line to be - * properly identified. The `include` directive includes a markdown file from - * an external source: <pre><code>&#40;== include path/to/file - * ==&#41;</code></pre> The `resource_for` directive marks a - * message to be the resource of a collection in REST view. If it is not - * specified, tools attempt to infer the resource from the operations in a - * collection: <pre><code>&#40;== resource_for - * v1.shelves.books ==&#41;</code></pre> The directive - * `suppress_warning` does not directly affect documentation and is documented - * together with service config validation. + * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -642,14 +450,7 @@ export namespace serviceconsumermanagement_v1 { */ documentationRootUrl?: string; /** - * Declares a single overview page. For example: - * <pre><code>documentation: summary: ... overview: - * &#40;== include overview.md ==&#41; </code></pre> - * This is a shortcut for the following declaration (using pages style): - * <pre><code>documentation: summary: ... pages: - name: - * Overview content: &#40;== include overview.md ==&#41; - * </code></pre> Note: you cannot specify both `overview` field - * and `pages` field. + * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ overview?: string; /** @@ -657,14 +458,11 @@ export namespace serviceconsumermanagement_v1 { */ pages?: Schema$Page[]; /** - * A list of documentation rules that apply to individual API elements. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; /** - * A short summary of what the service does. Can only be provided by plain - * text. + * A short summary of what the service does. Can only be provided by plain text. */ summary?: string; } @@ -673,8 +471,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$DocumentationRule { /** - * Deprecation description of the selected element(s). It can be provided if - * an element is marked as `deprecated`. + * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ deprecationDescription?: string; /** @@ -682,50 +479,24 @@ export namespace serviceconsumermanagement_v1 { */ description?: string; /** - * The selector is a comma-separated list of patterns. Each pattern is a - * qualified name of the element which may end in "*", indicating - * a wildcard. Wildcards are only allowed at the end and for a whole - * component of the qualified name, i.e. "foo.*" is ok, but not - * "foo.b*" or "foo.*.bar". A wildcard will match one or - * more components. To specify a default for all applicable elements, the - * whole pattern "*" is used. + * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ selector?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * `Endpoint` describes a network endpoint that serves a set of APIs. A - * service may expose any number of endpoints, and all endpoints share the - * same service configuration, such as quota configuration and monitoring - * configuration. Example service configuration: name: - * library-example.googleapis.com endpoints: # Below entry makes - * 'google.example.library.v1.Library' # API be served from - * endpoint address library-example.googleapis.com. # It also allows - * HTTP OPTIONS calls to be passed to the backend, for # it to decide - * whether the subsequent cross-origin request is # allowed to proceed. - * - name: library-example.googleapis.com allow_cors: true + * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ export interface Schema$Endpoint { /** - * DEPRECATED: This field is no longer supported. Instead of using aliases, - * please specify multiple google.api.Endpoint for each of the intended - * aliases. Additional names that this endpoint will be hosted on. + * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ aliases?: string[]; /** - * Allowing - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - * cross-domain traffic, would allow the backends served from this endpoint - * to receive and respond to HTTP OPTIONS requests. The response will be - * used by the browser to determine whether the subsequent cross-origin - * request is allowed to proceed. + * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ allowCors?: boolean; /** @@ -737,11 +508,7 @@ export namespace serviceconsumermanagement_v1 { */ name?: string; /** - * The specification of an Internet routable address of API frontend that - * will handle requests to this [API - * Endpoint](https://cloud.google.com/apis/design/glossary). It should be - * either a valid IPv4 address or a fully-qualified domain name. For - * example, "8.8.8.8" or "myservice.appspot.com". + * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ target?: string; } @@ -787,16 +554,6 @@ export namespace serviceconsumermanagement_v1 { */ options?: Schema$Option[]; } - /** - * Experimental service configuration. These configuration options can only be - * used by whitelisted users. - */ - export interface Schema$Experimental { - /** - * Authorization configuration. - */ - authorization?: Schema$AuthorizationConfig; - } /** * A single field of a message type. */ @@ -826,9 +583,7 @@ export namespace serviceconsumermanagement_v1 { */ number?: number; /** - * The index of the field type in `Type.oneofs`, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. + * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ oneofIndex?: number; /** @@ -840,204 +595,37 @@ export namespace serviceconsumermanagement_v1 { */ packed?: boolean; /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ typeUrl?: string; } /** - * Defines the HTTP configuration for an API service. It contains a list of - * HttpRule, each specifying the mapping of an RPC method to one or more HTTP - * REST API methods. + * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. */ export interface Schema$Http { /** - * When set to true, URL path parameters will be fully URI-decoded except in - * cases of single segment matches in reserved expansion, where - * "%2F" will be left encoded. The default behavior is to not - * decode RFC 6570 reserved characters in multi segment matches. + * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ fullyDecodeReservedExpansion?: boolean; /** - * A list of HTTP configuration rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$HttpRule[]; } /** - * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - * gRPC method and one or more HTTP REST endpoints. It allows developers to - * build a single API service that supports both gRPC APIs and REST APIs. Many - * systems, including [Google APIs](https://github.com/googleapis/googleapis), - * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and - * use it for large scale production services. `HttpRule` defines the schema - * of the gRPC/REST mapping. The mapping specifies how different portions of - * the gRPC request message are mapped to the URL path, URL query parameters, - * and HTTP request body. It also controls how the gRPC response message is - * mapped to the HTTP response body. `HttpRule` is typically specified as an - * `google.api.http` annotation on the gRPC method. Each mapping specifies a - * URL path template and an HTTP method. The path template may refer to one or - * more fields in the gRPC request message, as long as each field is a - * non-repeated field with a primitive (non-message) type. The path template - * controls how fields of the request message are mapped to the URL path. - * Example: service Messaging { rpc GetMessage(GetMessageRequest) - * returns (Message) { option (google.api.http) = { get: - * "/v1/{name=messages/*}" }; } } message - * GetMessageRequest { string name = 1; // Mapped to URL path. } - * message Message { string text = 1; // The resource content. } - * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC - * -----|----- `GET /v1/messages/123456` | `GetMessage(name: - * "messages/123456")` Any fields in the request message which are - * not bound by the path template automatically become HTTP query parameters - * if there is no HTTP request body. For example: service Messaging { rpc - * GetMessage(GetMessageRequest) returns (Message) { option - * (google.api.http) = { get:"/v1/messages/{message_id}" - * }; } } message GetMessageRequest { message SubMessage { - * string subfield = 1; } string message_id = 1; // Mapped to URL - * path. int64 revision = 2; // Mapped to URL query parameter - * `revision`. SubMessage sub = 3; // Mapped to URL query parameter - * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - * HTTP | gRPC -----|----- `GET - * /v1/messages/123456?revision=2&sub.subfield=foo` | - * `GetMessage(message_id: "123456" revision: 2 sub: - * SubMessage(subfield: "foo"))` Note that fields which are mapped - * to URL query parameters must have a primitive type or a repeated primitive - * type or a non-repeated message type. In the case of a repeated type, the - * parameter can be repeated in the URL as `...?param=A&param=B`. In the - * case of a message type, each field of the message is mapped to a separate - * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods - * that allow a request body, the `body` field specifies the mapping. Consider - * a REST update method on the message resource collection: service - * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) - * { option (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "message" - * }; } } message UpdateMessageRequest { string message_id - * = 1; // mapped to the URL Message message = 2; // mapped to the - * body } The following HTTP JSON to RPC mapping is enabled, where the - * representation of the JSON in the request body is determined by protos JSON - * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { - * "text": "Hi!" }` | `UpdateMessage(message_id: - * "123456" message { text: "Hi!" })` The special name - * `*` can be used in the body mapping to define that every field not bound by - * the path template should be mapped to the request body. This enables the - * following alternative definition of the update method: service - * Messaging { rpc UpdateMessage(Message) returns (Message) { option - * (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "*" }; } } - * message Message { string message_id = 1; string text = 2; } - * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- - * `PATCH /v1/messages/123456 { "text": "Hi!" }` | - * `UpdateMessage(message_id: "123456" text: "Hi!")` Note - * that when using `*` in the body mapping, it is not possible to have HTTP - * parameters, as all fields not bound by the path end in the body. This makes - * this option more rarely used in practice when defining REST APIs. The - * common usage of `*` is in custom methods which don't use the URL at all - * for transferring data. It is possible to define multiple HTTP methods for - * one RPC by using the `additional_bindings` option. Example: service - * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { - * option (google.api.http) = { get: - * "/v1/messages/{message_id}" additional_bindings { get: - * "/v1/users/{user_id}/messages/{message_id}" } }; } } - * message GetMessageRequest { string message_id = 1; string - * user_id = 2; } This enables the following two alternative HTTP JSON to - * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - * `GetMessage(message_id: "123456")` `GET - * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" - * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf - * request fields (recursive expansion nested messages in the request message) - * are classified into three categories: - Fields referred by the path - * template. They are passed via the URL path. - Fields referred by the - * HttpRule.body. They are passed via the HTTP request body. - All - * other fields are passed via the URL query parameters, and the parameter - * name is the field path in the request message. A repeated field can be - * represented as multiple query parameters under the same name. 2. If - * HttpRule.body is "*", there is no URL query parameter, all fields - * are passed via URL path and HTTP request body. 3. If HttpRule.body is - * omitted, there is no HTTP request body, all fields are passed via URL - * path and URL query parameters. ### Path template syntax Template = - * "/" Segments [ Verb ] ; Segments = Segment { "/" - * Segment } ; Segment = "*" | "**" | LITERAL | - * Variable ; Variable = "{" FieldPath [ "=" Segments - * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb - * = ":" LITERAL ; The syntax `*` matches a single URL path - * segment. The syntax `**` matches zero or more URL path segments, which must - * be the last part of the URL path except the `Verb`. The syntax `Variable` - * matches part of the URL path as specified by its template. A variable - * template must not contain other variables. If a variable matches a single - * path segment, its template may be omitted, e.g. `{var}` is equivalent to - * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If - * the `LITERAL` contains any reserved character, such characters should be - * percent-encoded before the matching. If a variable contains exactly one - * path segment, such as `"{var}"` or `"{var=*}"`, when - * such a variable is expanded into a URL path on the client side, all - * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - * does the reverse decoding. Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{var}`. If a variable contains multiple path segments, such as - * `"{var=foo/*}"` or `"{var=**}"`, when such a variable - * is expanded into a URL path on the client side, all characters except - * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse - * decoding, except "%2F" and "%2f" are left unchanged. - * Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - * Configuration (service config) is a configuration language for configuring - * a gRPC service to become a user-facing product. The service config is - * simply the YAML representation of the `google.api.Service` proto message. - * As an alternative to annotating your proto file, you can configure gRPC - * transcoding in your service config YAML files. You do this by specifying a - * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - * effect as the proto annotation. This can be particularly useful if you have - * a proto that is reused in multiple services. Note that any transcoding - * specified in the service config will override any matching transcoding - * configuration in the proto. Example: http: rules: # - * Selects a gRPC method and applies HttpRule to it. - selector: - * example.v1.Messaging.GetMessage get: - * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON - * conversion must follow the [proto3 - * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - * While the single segment variable follows the semantics of [RFC - * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - * Expansion, the multi segment variable **does not** follow RFC 6570 - * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - * does not expand special characters like `?` and `#`, which would lead to - * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for - * multi segment variables. The path variables **must not** refer to any - * repeated or mapped field, because client libraries are not capable of - * handling such variable expansion. The path variables **must not** capture - * the leading "/" character. The reason is that the most common use - * case "{var}" does not capture the leading "/" - * character. For consistency, all path variables must share the same - * behavior. Repeated message fields must not be mapped to URL query - * parameters, because no client library can support such complicated mapping. - * If an API needs to use a JSON array for request or response body, it can - * map the request or response body to a repeated field. However, some gRPC - * Transcoding implementations may not support this feature. + * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** - * Additional HTTP bindings for the selector. Nested bindings must not - * contain an `additional_bindings` field themselves (that is, the nesting - * may only be one level deep). + * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; /** - * The name of the request field whose value is mapped to the HTTP request - * body, or `*` for mapping all request fields not captured by the path - * pattern to the HTTP body, or omitted for not having any HTTP request - * body. NOTE: the referred field must be present at the top-level of the - * request message type. + * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ body?: string; /** - * The custom pattern is used for specifying an HTTP method that is not - * included in the `pattern` field, such as HEAD, or "*" to leave - * the HTTP method unspecified for this rule. The wild-card rule is useful - * for services that provide content to Web (HTML) clients. + * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ custom?: Schema$CustomHttpPattern; /** @@ -1045,8 +633,7 @@ export namespace serviceconsumermanagement_v1 { */ delete?: string; /** - * Maps to HTTP GET. Used for listing and getting information about - * resources. + * Maps to HTTP GET. Used for listing and getting information about resources. */ get?: string; /** @@ -1062,15 +649,11 @@ export namespace serviceconsumermanagement_v1 { */ put?: string; /** - * Optional. The name of the response field whose value is mapped to the - * HTTP response body. When omitted, the entire response message will be - * used as the HTTP response body. NOTE: The referred field must be present - * at the top-level of the response message type. + * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ responseBody?: string; /** - * Selects a method to which this rule applies. Refer to selector for - * syntax details. + * Selects a method to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -1118,82 +701,49 @@ export namespace serviceconsumermanagement_v1 { tenancyUnits?: Schema$TenancyUnit[]; } /** - * A description of a log type. Example in YAML format: - name: - * library.googleapis.com/activity_history description: The history of - * borrowing and returning library items. display_name: Activity labels: - * - key: /customer_id description: Identifier of a library customer + * A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer */ export interface Schema$LogDescriptor { /** - * A human-readable description of this log. This information appears in the - * documentation and can contain details. + * A human-readable description of this log. This information appears in the documentation and can contain details. */ description?: string; /** - * The human-readable name for this log. This information appears on the - * user interface and should be concise. + * The human-readable name for this log. This information appears on the user interface and should be concise. */ displayName?: string; /** - * The set of labels that are available to describe a specific log entry. - * Runtime requests that contain labels not specified here are considered - * invalid. + * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ labels?: Schema$LabelDescriptor[]; /** - * The name of the log. It must be less than 512 characters long and can - * include the following characters: upper- and lower-case alphanumeric - * characters [A-Za-z0-9], and punctuation characters including slash, - * underscore, hyphen, period [/_-.]. + * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ name?: string; } /** - * Logging configuration of the service. The following example shows how to - * configure logs to be sent to the producer and consumer projects. In the - * example, the `activity_history` log is sent to both the producer and - * consumer projects, whereas the `purchase_history` log is only sent to the - * producer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. logs: - name: activity_history - * labels: - key: /customer_id - name: purchase_history logging: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - - * purchase_history consumer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history + * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history */ export interface Schema$Logging { /** - * Logging configurations for sending logs to the consumer project. There - * can be multiple consumer destinations, each one must have a different - * monitored resource type. A log can be used in at most one consumer - * destination. + * Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination. */ consumerDestinations?: Schema$LoggingDestination[]; /** - * Logging configurations for sending logs to the producer project. There - * can be multiple producer destinations, each one must have a different - * monitored resource type. A log can be used in at most one producer - * destination. + * Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination. */ producerDestinations?: Schema$LoggingDestination[]; } /** - * Configuration of a specific logging destination (the producer project or - * the consumer project). + * Configuration of a specific logging destination (the producer project or the consumer project). */ export interface Schema$LoggingDestination { /** - * Names of the logs to be sent to this destination. Each name must be - * defined in the Service.logs section. If the log name is not a domain - * scoped name, it will be automatically prefixed with the service name - * followed by "/". + * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ logs?: string[]; /** - * The monitored resource type. The type must be defined in the - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ monitoredResource?: string; } @@ -1231,9 +781,7 @@ export namespace serviceconsumermanagement_v1 { syntax?: string; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1241,28 +789,23 @@ export namespace serviceconsumermanagement_v1 { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * `appengine.googleapis.com/http/server/response_latencies` metric type has - * a label for the HTTP response code, `response_code`, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of `metric_kind` and `value_type` might not be - * supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string; /** @@ -1270,47 +813,15 @@ export namespace serviceconsumermanagement_v1 { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * `custom.googleapis.com` or `external.googleapis.com`. Metric types - * should use a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported - * units are a subset of [The Unified Code for Units of - * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units - * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute - * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo - * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera - * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` - * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * - * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico - * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` - * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * - * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) - * **Grammar** The grammar also includes these connectors: * `/` division - * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix - * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression - * = Component { "." Component } { "/" Component } ; - * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | - * Annotation | "1" ; Annotation - * = "{" NAME "}" ; Notes: * `Annotation` is just a - * comment if it follows a `UNIT` and is equivalent to `1` if it is used - * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == - * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not - * containing '{' or '}'. * `1` represents dimensionless - * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, - * and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of `metric_kind` and `value_type` might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ valueType?: string; } @@ -1319,77 +830,33 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * Bind API methods to metrics. Binding a method to a metric causes that - * metric's configured quota behaviors to apply to the method call. + * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. */ export interface Schema$MetricRule { /** - * Metrics to update when the selected methods are called, and the - * associated cost applied to each metric. The key of the map is the metric - * name, and the values are the amount increased for the metric against - * which the quota limits are defined. The value must not be negative. + * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ metricCosts?: {[key: string]: string}; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Declares an API Interface to be included in this interface. The including - * interface must redeclare all the methods from the included interface, but - * documentation and options are inherited as follows: - If after comment and - * whitespace stripping, the documentation string of the redeclared method - * is empty, it will be inherited from the original method. - Each - * annotation belonging to the service config (http, visibility) which is - * not set in the redeclared method will be inherited. - If an http - * annotation is inherited, the path pattern will be modified as follows. - * Any version prefix will be replaced by the version of the including - * interface plus the root path if specified. Example of a simple mixin: - * package google.acl.v1; service AccessControl { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } - * package google.storage.v2; service Storage { // rpc - * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc - * GetData(GetDataRequest) returns (Data) { option - * (google.api.http).get = "/v2/{resource=**}"; } } - * Example of a mixin configuration: apis: - name: - * google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl The mixin construct implies that all methods - * in `AccessControl` are also declared with same name and request/response - * types in `Storage`. A documentation generator or annotation processor will - * see the effective `Storage.GetAcl` method after inherting documentation and - * annotations as follows: service Storage { // Get the underlying - * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... - * } Note how the version in the path pattern changed from `v1` to `v2`. If - * the `root` field in the mixin is specified, it should be a relative path - * under which inherited HTTP paths are placed. Example: apis: - - * name: google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl root: acls This implies the following - * inherited HTTP annotation: service Storage { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; - * } ... } + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } */ export interface Schema$Mixin { /** @@ -1397,149 +864,80 @@ export namespace serviceconsumermanagement_v1 { */ name?: string; /** - * If non-empty specifies a path under which inherited HTTP paths are - * rooted. + * If non-empty specifies a path under which inherited HTTP paths are rooted. */ root?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * `"gce_instance"` and specifies the use of the labels - * `"instance_id"` and `"zone"` to identify particular VM - * instances. Different APIs can support different monitored resource types. - * APIs generally provide a `list` method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, `"Google - * Cloud SQL Database"`. + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels `"database_id"` and - * `"zone"`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` - * where {type} is the value of the `type` field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format `"monitoredResourceDescriptors/{type}"`. + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ name?: string; /** - * Required. The monitored resource type. For example, the type - * `"cloudsql_database"` represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Monitoring configuration of the service. The example below shows how to - * configure monitored resources and metrics for monitoring. In the example, a - * monitored resource and two metrics are defined. The - * `library.googleapis.com/book/returned_count` metric is sent to both - * producer and consumer projects, whereas the - * `library.googleapis.com/book/overdue_count` metric is only sent to the - * consumer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. metrics: - name: - * library.googleapis.com/book/returned_count metric_kind: DELTA - * value_type: INT64 labels: - key: /customer_id - name: - * library.googleapis.com/book/overdue_count metric_kind: GAUGE - * value_type: INT64 labels: - key: /customer_id monitoring: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count consumer_destinations: - - * monitored_resource: library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count - - * library.googleapis.com/book/overdue_count + * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count */ export interface Schema$Monitoring { /** - * Monitoring configurations for sending metrics to the consumer project. - * There can be multiple consumer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ consumerDestinations?: Schema$MonitoringDestination[]; /** - * Monitoring configurations for sending metrics to the producer project. - * There can be multiple producer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ producerDestinations?: Schema$MonitoringDestination[]; } /** - * Configuration of a specific monitoring destination (the producer project or - * the consumer project). + * Configuration of a specific monitoring destination (the producer project or the consumer project). */ export interface Schema$MonitoringDestination { /** - * Types of the metrics to report to this monitoring destination. Each type - * must be defined in Service.metrics section. + * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * OAuth scopes are a way to define data and permissions on data. For example, - * there are scopes defined for "Read-only access to Google - * Calendar" and "Access to Cloud Platform". Users can consent - * to a scope for an application, giving it permission to access that data on - * their behalf. OAuth scope specifications should be fairly coarse grained; - * a user will need to see and understand the text description of what your - * scope means. In most cases: use one or at most two OAuth scopes for an - * entire family of products. If your product has multiple APIs, you should - * probably be sharing the OAuth scope across all of those APIs. When you - * need finer grained OAuth consent screens: talk with your product management - * about how developers will use them in practice. Please note that even - * though each of the canonical scopes is enough for a request to be accepted - * and passed to the backend, a request can still fail due to the backend - * requiring additional scopes or permissions. + * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. */ export interface Schema$OAuthRequirements { /** - * The list of publicly documented OAuth scopes that are allowed access. An - * OAuth token containing any of these scopes will be accepted. Example: - * canonical_scopes: https://www.googleapis.com/auth/calendar, - * https://www.googleapis.com/auth/calendar.read + * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ canonicalScopes?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1547,76 +945,45 @@ export namespace serviceconsumermanagement_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ export interface Schema$Option { /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * `"map_entry"`. For custom options, it should be the - * fully-qualified name. For example, `"google.api.http"`. + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ name?: string; /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ value?: {[key: string]: any}; } /** - * Represents a documentation page. A page can contain subpages to represent - * nested documentation set structure. + * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. */ export interface Schema$Page { /** - * The Markdown content of the page. You can use <code>&#40;== - * include {path} ==&#41;</code> to include content from a - * Markdown file. + * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ content?: string; /** - * The name of the page. It will be used as an identity of the page to - * generate URI of the page, text of the link to this page in navigation, - * etc. The full page name (start from the root page name to this page - * concatenated with `.`) can be used as reference to the page in your - * documentation. For example: <pre><code>pages: - name: - * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - * - name: Java content: &#40;== include tutorial_java.md - * ==&#41; </code></pre> You can reference `Java` page using - * Markdown reference link syntax: `Java`. + * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ name?: string; /** - * Subpages of this page. The order of subpages specified here will be - * honored in the generated docset. + * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ subpages?: Schema$Page[]; } @@ -1625,41 +992,16 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$PolicyBinding { /** - * Uses the same format as in IAM policy. `member` must include both a - * prefix and ID. For example, `user:{emailId}`, `serviceAccount:{emailId}`, - * `group:{emailId}`. + * Uses the same format as in IAM policy. `member` must include both a prefix and ID. For example, `user:{emailId}`, `serviceAccount:{emailId}`, `group:{emailId}`. */ members?: string[]; /** - * Role. (https://cloud.google.com/iam/docs/understanding-roles) For - * example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * Role. (https://cloud.google.com/iam/docs/understanding-roles) For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Quota configuration helps to achieve fairness and budgeting in service - * usage. The metric based quota configuration works this way: - The service - * configuration defines a set of metrics. - For API calls, the - * quota.metric_rules maps methods to metrics with corresponding costs. - - * The quota.limits defines limits on the metrics, which will be used for - * quota checks at runtime. An example quota configuration in yaml format: - * quota: limits: - name: apiWriteQpsPerProject metric: - * library.googleapis.com/write_calls unit: "1/min/{project}" - * # rate limit for consumer projects values: STANDARD: 10000 - * # The metric rules bind all methods to the read_calls metric, # except - * for the UpdateBook and DeleteBook methods. These two methods # are - * mapped to the write_calls metric, with the UpdateBook method # - * consuming at twice rate as the DeleteBook method. metric_rules: - - * selector: "*" metric_costs: - * library.googleapis.com/read_calls: 1 - selector: - * google.example.library.v1.LibraryService.UpdateBook metric_costs: - * library.googleapis.com/write_calls: 2 - selector: - * google.example.library.v1.LibraryService.DeleteBook metric_costs: - * library.googleapis.com/write_calls: 1 Corresponding Metric definition: - * metrics: - name: library.googleapis.com/read_calls display_name: Read - * requests metric_kind: DELTA value_type: INT64 - name: - * library.googleapis.com/write_calls display_name: Write requests - * metric_kind: DELTA value_type: INT64 + * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 */ export interface Schema$Quota { /** @@ -1667,93 +1009,52 @@ export namespace serviceconsumermanagement_v1 { */ limits?: Schema$QuotaLimit[]; /** - * List of `MetricRule` definitions, each one mapping a selected method to - * one or more metrics. + * List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */ metricRules?: Schema$MetricRule[]; } /** - * `QuotaLimit` defines a specific limit that applies over a specified - * duration for a limit type. There can be at most one limit for a duration - * and limit type combination defined within a `QuotaGroup`. + * `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. */ export interface Schema$QuotaLimit { /** - * Default number of tokens that can be consumed during the specified - * duration. This is the number of tokens assigned when a client application - * developer activates the service for his/her project. Specifying a value - * of 0 will block all requests. This can be used if you are provisioning - * quota to selected consumers and blocking others. Similarly, a value of -1 - * will indicate an unlimited quota. No other negative values are allowed. - * Used by group-based quotas only. + * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ defaultLimit?: string; /** - * Optional. User-visible, extended description for this quota limit. Should - * be used only when more context is needed to understand this limit than - * provided by the limit's display name (see: `display_name`). + * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ description?: string; /** - * User-visible display name for this limit. Optional. If not set, the UI - * will provide a default display name based on the quota configuration. - * This field can be used to override the default display name generated - * from the configuration. + * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ displayName?: string; /** - * Duration of this limit in textual notation. Example: "100s", - * "24h", "1d". For duration longer than a day, only - * multiple of days is supported. We support only "100s" and - * "1d" for now. Additional support will be added in the future. - * "0" indicates indefinite duration. Used by group-based quotas - * only. + * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. */ duration?: string; /** - * Free tier value displayed in the Developers Console for this limit. The - * free tier is the number of tokens that will be subtracted from the billed - * amount when billing is enabled. This field can only be set on a limit - * with duration "1d", in a billable group; it is invalid on any - * other limit. If this field is not set, it defaults to 0, indicating that - * there is no free tier for this service. Used by group-based quotas only. + * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ freeTier?: string; /** - * Maximum number of tokens that can be consumed during the specified - * duration. Client application developers can override the default limit up - * to this maximum. If specified, this value cannot be set to a value less - * than the default limit. If not specified, it is set to the default limit. - * To allow clients to apply overrides with no upper bound, set this to -1, - * indicating unlimited maximum quota. Used by group-based quotas only. + * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ maxLimit?: string; /** - * The name of the metric this quota limit applies to. The quota limits with - * the same metric will be checked together during runtime. The metric must - * be defined within the service config. + * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ metric?: string; /** - * Name of the quota limit. The name must be provided, and it must be - * unique within the service. The name can only include alphanumeric - * characters as well as '-'. The maximum length of the limit name - * is 64 characters. + * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ name?: string; /** - * Specify the unit of the quota limit. It uses the same syntax as - * Metric.unit. The supported unit kinds are determined by the quota backend - * system. Here are some examples: * "1/min/{project}" for quota - * per minute per project. Note: the order of unit components is - * insignificant. The "1" at the beginning is required to follow - * the metric unit syntax. + * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ unit?: string; /** - * Tiered limit values. You must specify this as a key:value pair, with an - * integer value that is the maximum number of requests allowed for the - * specified unit. Currently only STANDARD is supported. + * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ values?: {[key: string]: string}; } @@ -1780,26 +1081,11 @@ export namespace serviceconsumermanagement_v1 { tenancyUnits?: Schema$TenancyUnit[]; } /** - * `Service` is the root object of Google service configuration schema. It - * describes basic information about a service, such as the name and the - * title, and delegates other aspects to sub-sections. Each sub-section is - * either a proto message or a repeated proto message that configures a - * specific aspect, such as auth. See each proto message definition for - * details. Example: type: google.api.Service config_version: 3 - * name: calendar.googleapis.com title: Google Calendar API apis: - - * name: google.calendar.v3.Calendar authentication: providers: - - * id: google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Service { /** - * A list of API interfaces exported by this service. Only the `name` field - * of the google.protobuf.Api needs to be provided by the configuration - * author, as the remaining fields will be derived from the IDL during the - * normalization process. It is an error to specify an API interface here - * which cannot be resolved against the associated IDL files. + * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; /** @@ -1815,10 +1101,7 @@ export namespace serviceconsumermanagement_v1 { */ billing?: Schema$Billing; /** - * The semantic version of the service configuration. The config version - * affects the interpretation of the service configuration. For example, - * certain features are enabled by default for certain config versions. The - * latest config version is `3`. + * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ configVersion?: number; /** @@ -1838,30 +1121,19 @@ export namespace serviceconsumermanagement_v1 { */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. If this is empty, then an endpoint - * with the same name as the service is automatically generated to service - * all defined APIs. + * Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */ endpoints?: Schema$Endpoint[]; /** - * A list of all enum types included in this API service. Enums referenced - * directly or indirectly by the `apis` are automatically included. Enums - * which are not referenced but shall be included should be listed here by - * name. Example: enums: - name: google.someapi.v1.SomeEnum + * A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum */ enums?: Schema$Enum[]; - /** - * Experimental configuration. - */ - experimental?: Schema$Experimental; /** * HTTP configuration. */ http?: Schema$Http; /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. Must be no longer than 60 characters. + * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ id?: string; /** @@ -1877,8 +1149,7 @@ export namespace serviceconsumermanagement_v1 { */ metrics?: Schema$MetricDescriptor[]; /** - * Defines the monitored resources used by this service. This is required by - * the Service.monitoring and Service.logging configurations. + * Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */ monitoredResources?: Schema$MonitoredResourceDescriptor[]; /** @@ -1886,10 +1157,7 @@ export namespace serviceconsumermanagement_v1 { */ monitoring?: Schema$Monitoring; /** - * The service name, which is a DNS-like logical identifier for the service, - * such as `calendar.googleapis.com`. The service name typically goes - * through DNS verification to make sure the owner of the service also owns - * the DNS name. + * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ name?: string; /** @@ -1909,11 +1177,7 @@ export namespace serviceconsumermanagement_v1 { */ systemParameters?: Schema$SystemParameters; /** - * A list of all proto message types included in this API service. It serves - * similar purpose as [google.api.Service.types], except that these types - * are not needed by user-defined APIs. Therefore, they will not show up in - * the generated discovery doc. This field should only be used to define - * system APIs in ESF. + * A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. */ systemTypes?: Schema$Type[]; /** @@ -1921,11 +1185,7 @@ export namespace serviceconsumermanagement_v1 { */ title?: string; /** - * A list of all proto message types included in this API service. Types - * referenced directly or indirectly by the `apis` are automatically - * included. Messages which are not referenced but shall be included, such - * as types used by the `google.protobuf.Any` type, should be listed here by - * name. Example: types: - name: google.protobuf.Int32 + * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ types?: Schema$Type[]; /** @@ -1938,12 +1198,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$ServiceAccountConfig { /** - * ID of the IAM service account to be created in tenant project. The email - * format of the service account is - * "<account-id>@<tenant-project-id>.iam.gserviceaccount.com". - * This account ID must be unique within tenant project and service - * producers have to guarantee it. The ID must be 6-30 characters long, and - * match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`. + * ID of the IAM service account to be created in tenant project. The email format of the service account is "<account-id>@<tenant-project-id>.iam.gserviceaccount.com". This account ID must be unique within tenant project and service producers have to guarantee it. The ID must be 6-30 characters long, and match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`. */ accountId?: string; /** @@ -1952,14 +1207,11 @@ export namespace serviceconsumermanagement_v1 { tenantProjectRoles?: string[]; } /** - * `SourceContext` represents information about the source of a protobuf - * element, like the file in which it is defined. + * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ export interface Schema$SourceContext { /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * `"google/protobuf/source_context.proto"`. + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ fileName?: string; } @@ -1973,40 +1225,7 @@ export namespace serviceconsumermanagement_v1 { sourceFiles?: Array<{[key: string]: any}>; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -2014,78 +1233,50 @@ export namespace serviceconsumermanagement_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Define a parameter's name and location. The parameter may be passed as - * either an HTTP header or a URL query parameter, and if both are passed the - * behavior is implementation-dependent. + * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. */ export interface Schema$SystemParameter { /** - * Define the HTTP header name to use for the parameter. It is case - * insensitive. + * Define the HTTP header name to use for the parameter. It is case insensitive. */ httpHeader?: string; /** - * Define the name of the parameter, such as "api_key" . It is - * case sensitive. + * Define the name of the parameter, such as "api_key" . It is case sensitive. */ name?: string; /** - * Define the URL query parameter name to use for the parameter. It is case - * sensitive. + * Define the URL query parameter name to use for the parameter. It is case sensitive. */ urlQueryParameter?: string; } /** - * Define a system parameter rule mapping system parameter definitions to - * methods. + * Define a system parameter rule mapping system parameter definitions to methods. */ export interface Schema$SystemParameterRule { /** - * Define parameters. Multiple names may be defined for a parameter. For a - * given method call, only one of them should be used. If multiple names are - * used the behavior is implementation-dependent. If none of the specified - * names are present the behavior is parameter-dependent. + * Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent. */ parameters?: Schema$SystemParameter[]; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; } /** - * ### System parameter configuration A system parameter is a special kind of - * parameter defined by the API system, not by an individual API. It is - * typically mapped to an HTTP header and/or a URL query parameter. This - * configuration specifies which methods change the names of the system - * parameters. + * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. */ export interface Schema$SystemParameters { /** - * Define system parameters. The parameters defined here will override the - * default parameters implemented by the system. If this field is missing - * from the service config, default system parameters will be used. Default - * system parameters and names is implementation-dependent. Example: define - * api key for all methods system_parameters rules: - - * selector: "*" parameters: - name: api_key - * url_query_parameter: api_key Example: define 2 api key names for a - * specific method. system_parameters rules: - selector: - * "/ListShelves" parameters: - name: - * api_key http_header: Api-Key1 - name: api_key - * http_header: Api-Key2 **NOTE:** All service configuration rules follow - * "last one wins" order. + * Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$SystemParameterRule[]; } @@ -2094,8 +1285,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$TenancyUnit { /** - * @OutputOnly Cloud resource name of the consumer of this service. For - * example 'projects/123456'. + * @OutputOnly Cloud resource name of the consumer of this service. For example 'projects/123456'. */ consumer?: string; /** @@ -2103,29 +1293,20 @@ export namespace serviceconsumermanagement_v1 { */ createTime?: string; /** - * Globally unique identifier of this tenancy unit - * "services/{service}/{collection id}/{resource - * id}/tenancyUnits/{unit}" + * Globally unique identifier of this tenancy unit "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}" */ name?: string; /** - * Output only. Google Cloud API name of the managed service owning this - * tenancy unit. For example - * 'serviceconsumermanagement.googleapis.com'. + * Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. */ service?: string; /** - * Resources constituting the tenancy unit. There can be at most 512 tenant - * resources in a tenancy unit. + * Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. */ tenantResources?: Schema$TenantResource[]; } /** - * This structure defines a tenant project to be added to the specified - * tenancy unit and its initial configuration and properties. A project lien - * is created for the tenant project to prevent the tenant project from being - * deleted accidentally. The lien is deleted as part of tenant project - * removal. + * This structure defines a tenant project to be added to the specified tenancy unit and its initial configuration and properties. A project lien is created for the tenant project to prevent the tenant project from being deleted accidentally. The lien is deleted as part of tenant project removal. */ export interface Schema$TenantProjectConfig { /** @@ -2133,11 +1314,7 @@ export namespace serviceconsumermanagement_v1 { */ billingConfig?: Schema$BillingConfig; /** - * Folder where project in this tenancy unit must be located This folder - * must have been previously created with the required permissions for the - * caller to create and configure a project in it. Valid folder resource - * names have the format `folders/{folder_number}` (for example, - * `folders/123456`). + * Folder where project in this tenancy unit must be located This folder must have been previously created with the required permissions for the caller to create and configure a project in it. Valid folder resource names have the format `folders/{folder_number}` (for example, `folders/123456`). */ folder?: string; /** @@ -2149,10 +1326,7 @@ export namespace serviceconsumermanagement_v1 { */ serviceAccountConfig?: Schema$ServiceAccountConfig; /** - * Google Cloud API names of services that are activated on this project - * during provisioning. If any of these services can't be activated, - * the request fails. For example: - * 'compute.googleapis.com','cloudfunctions.googleapis.com' + * Google Cloud API names of services that are activated on this project during provisioning. If any of these services can't be activated, the request fails. For example: 'compute.googleapis.com','cloudfunctions.googleapis.com' */ services?: string[]; /** @@ -2161,16 +1335,11 @@ export namespace serviceconsumermanagement_v1 { tenantProjectPolicy?: Schema$TenantProjectPolicy; } /** - * Describes policy settings that need to be applied to a newly created tenant - * project. + * Describes policy settings that need to be applied to a newly created tenant project. */ export interface Schema$TenantProjectPolicy { /** - * Policy bindings to be applied to the tenant project, in addition to the - * 'roles/owner' role granted to the Service Consumer Management - * service account. At least one binding must have the role `roles/owner`. - * Among the list of members for `roles/owner`, at least one of them must be - * either the `user` or `group` type. + * Policy bindings to be applied to the tenant project, in addition to the 'roles/owner' role granted to the Service Consumer Management service account. At least one binding must have the role `roles/owner`. Among the list of members for `roles/owner`, at least one of them must be either the `user` or `group` type. */ policyBindings?: Schema$PolicyBinding[]; } @@ -2179,9 +1348,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$TenantResource { /** - * @OutputOnly Identifier of the tenant resource. For cloud projects, it is - * in the form 'projects/{number}'. For example - * 'projects/123456'. + * @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. */ resource?: string; /** @@ -2223,8 +1390,7 @@ export namespace serviceconsumermanagement_v1 { syntax?: string; } /** - * Request message to undelete tenant project resource previously deleted from - * the tenancy unit. + * Request message to undelete tenant project resource previously deleted from the tenancy unit. */ export interface Schema$UndeleteTenantProjectRequest { /** @@ -2237,64 +1403,37 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$Usage { /** - * The full resource name of a channel used for sending notifications to the - * service producer. Google Service Management currently only supports - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - * channel. To use Google Cloud Pub/Sub as the channel, this must be the - * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name - * format documented in https://cloud.google.com/pubsub/docs/overview. + * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ producerNotificationChannel?: string; /** - * Requirements that must be satisfied before a consumer project can use the - * service. Each requirement is of the form - * <service.name>/<requirement-id>; for example - * 'serviceusage.googleapis.com/billing-enabled'. + * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ requirements?: string[]; /** - * A list of usage rules that apply to individual API methods. **NOTE:** - * All service configuration rules follow "last one wins" order. + * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use - * this rule to configure unregistered calls for the service. Unregistered - * calls are calls that do not contain consumer project identity. (Example: - * calls that do not contain an API key). By default, API methods do not allow - * unregistered calls, and each method call must be identified by a consumer - * project identity. Use this rule to allow/disallow unregistered calls. - * Example of an API that wants to allow unregistered calls for entire - * service. usage: rules: - selector: "*" - * allow_unregistered_calls: true Example of a method that wants to allow - * unregistered calls. usage: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allow_unregistered_calls: true + * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that - * don't identify any user or application. + * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ allowUnregisteredCalls?: boolean; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; /** - * If true, the selected method should skip service control and the control - * plane features, such as quota and billing, will not be available. This - * flag is used by Google Cloud Endpoints to bypass checks for internal - * methods, such as service health check methods. + * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ skipServiceControl?: boolean; } /** - * Response message for the `AddVisibilityLabels` method. This response - * message is assigned to the `response` field of the returned Operation when - * that operation is done. + * Response message for the `AddVisibilityLabels` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1AddVisibilityLabelsResponse { /** @@ -2312,15 +1451,11 @@ export namespace serviceconsumermanagement_v1 { overrides?: Schema$V1Beta1QuotaOverride[]; } /** - * Response message for the `DisableConsumer` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `DisableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1Beta1DisableConsumerResponse {} /** - * Response message for the `EnableConsumer` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `EnableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1Beta1EnableConsumerResponse {} /** @@ -2337,70 +1472,40 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$V1Beta1QuotaOverride { /** - * If this map is nonempty, then this override applies only to specific - * values for dimensions defined in the limit unit. For example, an - * override on a limit with the unit 1/{project}/{region} could contain an - * entry with the key "region" and the value - * "us-east-1"; the override is only applied to quota consumed in - * that region. This map has the following restrictions: - Keys that are - * not defined in the limit's unit are not valid keys. Any string - * appearing in {brackets} in the unit (besides {project} or {user}) is a - * defined key. - "project" is not a valid key; the project is - * already specified in the parent resource name. - "user" is - * not a valid key; the API does not support quota overrides that apply - * only to a specific user. - If "region" appears as a key, its - * value must be a valid Cloud region. - If "zone" appears as a - * key, its value must be a valid Cloud zone. - If any valid key other than - * "region" or "zone" appears in the map, then all - * valid keys other than "region" or "zone" must also - * appear in the map. + * If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: - Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. - "project" is not a valid key; the project is already specified in the parent resource name. - "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. - If "region" appears as a key, its value must be a valid Cloud region. - If "zone" appears as a key, its value must be a valid Cloud zone. - If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. */ dimensions?: {[key: string]: string}; /** - * The name of the metric to which this override applies. An example name - * would be: `compute.googleapis.com/cpus` + * The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` */ metric?: string; /** - * The resource name of the producer override. An example name would be: - * `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` + * The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` */ name?: string; /** - * The overriding quota limit value. Can be any nonnegative integer, or -1 - * (unlimited quota). + * The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */ overrideValue?: string; /** - * The limit unit of the limit to which this override applies. An example - * unit would be: `1/{project}/{region}` Note that `{project}` and - * `{region}` are not placeholders in this example; the literal characters - * `{` and `}` occur in the string. + * The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. */ unit?: string; } /** - * Response message for the `RefreshConsumer` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1Beta1RefreshConsumerResponse {} /** - * Response message for the `DisableConsumer` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `DisableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1DisableConsumerResponse {} /** - * Response message for the `EnableConsumer` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `EnableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1EnableConsumerResponse {} /** - * Response message for the `GenerateServiceAccount` method. This response - * message is assigned to the `response` field of the returned Operation when - * that operation is done. + * Response message for the `GenerateServiceAccount` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1GenerateServiceAccountResponse { /** @@ -2409,15 +1514,11 @@ export namespace serviceconsumermanagement_v1 { account?: Schema$V1ServiceAccount; } /** - * Response message for the `RefreshConsumer` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1RefreshConsumerResponse {} /** - * Response message for the `RemoveVisibilityLabels` method. This response - * message is assigned to the `response` field of the returned Operation when - * that operation is done. + * Response message for the `RemoveVisibilityLabels` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1RemoveVisibilityLabelsResponse { /** @@ -2434,19 +1535,15 @@ export namespace serviceconsumermanagement_v1 { */ email?: string; /** - * The IAM resource name of the service account in the following format: - * projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. + * The IAM resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. */ iamAccountName?: string; /** - * P4 SA resource name. An example name would be: - * `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` + * P4 SA resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` */ name?: string; /** - * The P4 SA configuration tag. This must be defined in activation_grants. - * If not specified when creating the account, the tag is set to - * "default". + * The P4 SA configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to "default". */ tag?: string; /** @@ -2463,15 +1560,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias serviceconsumermanagement.operations.cancel * @memberOf! () * @@ -2542,10 +1631,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias serviceconsumermanagement.operations.delete * @memberOf! () * @@ -2615,9 +1701,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias serviceconsumermanagement.operations.get * @memberOf! () * @@ -2688,15 +1772,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias serviceconsumermanagement.operations.list * @memberOf! () * @@ -2935,36 +2011,19 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of results returned by this request. Currently, the - * default maximum is set to 1000. If `page_size` isn't provided or the size - * provided is a number larger than 1000, it's automatically set to 1000. - * Optional. + * The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If `page_size` isn't provided or the size provided is a number larger than 1000, it's automatically set to 1000. Optional. */ pageSize?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * `nextPageToken` from the previous response. Optional. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response. Optional. */ pageToken?: string; /** - * Service for which search is performed. services/{service} {service} the - * name of a service, for example 'service.googleapis.com'. + * Service for which search is performed. services/{service} {service} the name of a service, for example 'service.googleapis.com'. */ parent?: string; /** - * Set a query `{expression}` for querying tenancy units. Your - * `{expression}` must be in the format: `field_name=literal_string`. The - * `field_name` is the name of the field you want to compare. Supported - * fields are `tenant_resources.tag` and `tenant_resources.resource`. For - * example, to search tenancy units that contain at least one tenant - * resource with a given tag 'xyz', use the query - * `tenant_resources.tag=xyz`. To search tenancy units that contain at least - * one tenant resource with a given resource name 'projects/123456', use the - * query `tenant_resources.resource=projects/123456`. Multiple expressions - * can be joined with `AND`s. Tenancy units must match all expressions to be - * included in the result set. For example, `tenant_resources.tag=xyz AND - * tenant_resources.resource=projects/123456` Optional. + * Set a query `{expression}` for querying tenancy units. Your `{expression}` must be in the format: `field_name=literal_string`. The `field_name` is the name of the field you want to compare. Supported fields are `tenant_resources.tag` and `tenant_resources.resource`. For example, to search tenancy units that contain at least one tenant resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`. To search tenancy units that contain at least one tenant resource with a given resource name 'projects/123456', use the query `tenant_resources.resource=projects/123456`. Multiple expressions can be joined with `AND`s. Tenancy units must match all expressions to be included in the result set. For example, `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456` Optional. */ query?: string; } @@ -2977,16 +2036,12 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.addProject - * @desc Add a new tenant project to the tenancy unit. There can be a - * maximum of 512 tenant projects in a tenancy unit. If there are previously - * failed `AddTenantProject` calls, you might need to call - * `RemoveTenantProject` first to resolve them before you can make another - * call to `AddTenantProject` with the same tag. Operation. + * @desc Add a new tenant project to the tenancy unit. There can be a maximum of 512 tenant projects in a tenancy unit. If there are previously failed `AddTenantProject` calls, you might need to call `RemoveTenantProject` first to resolve them before you can make another call to `AddTenantProject` with the same tag. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.addProject * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the tenancy unit. + * @param {string} params.parent Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. * @param {().AddTenantProjectRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3057,24 +2112,12 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.applyProjectConfig - * @desc Apply a configuration to an existing tenant project. This project - * must exist in an active state and have the original owner account. The - * caller must have permission to add a project to the given tenancy unit. - * The configuration is applied, but any existing settings on the project - * aren't modified. Specified policy bindings are applied. Existing bindings - * aren't modified. Specified services are activated. No service is - * deactivated. If specified, new billing configuration is applied. Omit a - * billing configuration to keep the existing one. A service account in the - * project is created if previously non existed. The specified folder is - * ignored, as moving a tenant project to a different folder isn't - * supported. The operation fails if any of the steps fail, but no rollback - * of already applied configuration changes is attempted. - * Operation. + * @desc Apply a configuration to an existing tenant project. This project must exist in an active state and have the original owner account. The caller must have permission to add a project to the given tenancy unit. The configuration is applied, but any existing settings on the project aren't modified. Specified policy bindings are applied. Existing bindings aren't modified. Specified services are activated. No service is deactivated. If specified, new billing configuration is applied. Omit a billing configuration to keep the existing one. A service account in the project is created if previously non existed. Specified labels will be appended to tenant project, note that the value of existing label key will be updated if the same label key is requested. The specified folder is ignored, as moving a tenant project to a different folder isn't supported. The operation fails if any of the steps fail, but no rollback of already applied configuration changes is attempted. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.applyProjectConfig * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the tenancy unit. + * @param {string} params.name Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. * @param {().ApplyTenantProjectConfigRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3145,21 +2188,12 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.attachProject - * @desc Attach an existing project to the tenancy unit as a new tenant - * resource. The project could either be the tenant project reserved by - * calling `AddTenantProject` under a tenancy unit of a service producer's - * project of a managed service, or from a separate project. The caller is - * checked against a set of permissions as if calling `AddTenantProject` on - * the same service consumer. To trigger the attachment, the targeted tenant - * project must be in a folder. Make sure the ServiceConsumerManagement - * service account is the owner of that project. These two requirements are - * already met if the project is reserved by calling `AddTenantProject`. - * Operation. + * @desc Attach an existing project to the tenancy unit as a new tenant resource. The project could either be the tenant project reserved by calling `AddTenantProject` under a tenancy unit of a service producer's project of a managed service, or from a separate project. The caller is checked against a set of permissions as if calling `AddTenantProject` on the same service consumer. To trigger the attachment, the targeted tenant project must be in a folder. Make sure the ServiceConsumerManagement service account is the owner of that project. These two requirements are already met if the project is reserved by calling `AddTenantProject`. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.attachProject * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the tenancy unit that the project will be attached to. + * @param {string} params.name Name of the tenancy unit that the project will be attached to. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. * @param {().AttachTenantProjectRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3306,9 +2340,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.delete - * @desc Delete a tenancy unit. Before you delete the tenancy unit, there - * should be no tenant resources in it that aren't in a DELETED state. - * Operation. + * @desc Delete a tenancy unit. Before you delete the tenancy unit, there should be no tenant resources in it that aren't in a DELETED state. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.delete * @memberOf! () * @@ -3380,14 +2412,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.deleteProject - * @desc Deletes the specified project resource identified by a tenant - * resource tag. The mothod removes a project lien with a 'TenantManager' - * origin if that was added. It will then attempt to delete the project. If - * that operation fails, this method also fails. After the project has been - * deleted, the tenant resource state is set to DELETED. To permanently - * remove resource metadata, call the `RemoveTenantProject` method. New - * resources with the same tag can't be added if there are existing - * resources in a DELETED state. Operation. + * @desc Deletes the specified project resource identified by a tenant resource tag. The mothod removes a project lien with a 'TenantManager' origin if that was added. It will then attempt to delete the project. If that operation fails, this method also fails. After the project has been deleted, the tenant resource state is set to DELETED. To permanently remove resource metadata, call the `RemoveTenantProject` method. New resources with the same tag can't be added if there are existing resources in a DELETED state. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.deleteProject * @memberOf! () * @@ -3463,11 +2488,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.list - * @desc Find the tenancy unit for a managed service and service consumer. - * This method shouldn't be used in a service producer's runtime path, for - * example to find the tenant project number when creating VMs. Service - * producers must persist the tenant project's information after the project - * is created. + * @desc Find the tenancy unit for a managed service and service consumer. This method shouldn't be used in a service producer's runtime path, for example to find the tenant project number when creating VMs. Service producers must persist the tenant project's information after the project is created. * @alias serviceconsumermanagement.services.tenancyUnits.list * @memberOf! () * @@ -3547,13 +2568,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.removeProject - * @desc Removes the specified project resource identified by a tenant - * resource tag. The method removes the project lien with 'TenantManager' - * origin if that was added. It then attempts to delete the project. If that - * operation fails, this method also fails. Calls to remove already removed - * or non-existent tenant project succeed. After the project has been - * deleted, or if was already in a DELETED state, resource metadata is - * permanently removed from the tenancy unit. Operation. + * @desc Removes the specified project resource identified by a tenant resource tag. The method removes the project lien with 'TenantManager' origin if that was added. It then attempts to delete the project. If that operation fails, this method also fails. Calls to remove already removed or non-existent tenant project succeed. After the project has been deleted, or if was already in a DELETED state, resource metadata is permanently removed from the tenancy unit. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.removeProject * @memberOf! () * @@ -3629,11 +2644,7 @@ export namespace serviceconsumermanagement_v1 { /** * serviceconsumermanagement.services.tenancyUnits.undeleteProject - * @desc Attempts to undelete a previously deleted tenant project. The - * project must be in a DELETED state. There are no guarantees that an - * undeleted project will be in a fully restored and functional state. Call - * the `ApplyTenantProjectConfig` method to update its configuration and - * then validate all managed service resources. Operation. + * @desc Attempts to undelete a previously deleted tenant project. The project must be in a DELETED state. There are no guarantees that an undeleted project will be in a fully restored and functional state. Call the `ApplyTenantProjectConfig` method to update its configuration and then validate all managed service resources. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.undeleteProject * @memberOf! () * @@ -3716,7 +2727,7 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the tenancy unit. + * Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. */ parent?: string; @@ -3733,7 +2744,7 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the tenancy unit. + * Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. */ name?: string; @@ -3750,7 +2761,7 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the tenancy unit that the project will be attached to. + * Name of the tenancy unit that the project will be attached to. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. */ name?: string; @@ -3767,12 +2778,7 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * services/{service}/{collection id}/{resource id} {collection id} is the - * cloud resource collection type representing the service consumer, for - * example 'projects', or 'organizations'. {resource id} is the consumer - * numeric id, such as project number: '123456'. {service} the name of a - * managed service, such as 'service.googleapis.com'. Enables service - * binding using the new tenancy unit. + * services/{service}/{collection id}/{resource id} {collection id} is the cloud resource collection type representing the service consumer, for example 'projects', or 'organizations'. {resource id} is the consumer numeric id, such as project number: '123456'. {service} the name of a managed service, such as 'service.googleapis.com'. Enables service binding using the new tenancy unit. */ parent?: string; @@ -3801,8 +2807,7 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the tenancy unit. Such as - * 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + * Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. */ name?: string; @@ -3827,18 +2832,11 @@ export namespace serviceconsumermanagement_v1 { */ pageSize?: number; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * `nextPageToken` from the previous response. + * The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response. */ pageToken?: string; /** - * Managed service and service consumer. Required. - * services/{service}/{collection id}/{resource id} {collection id} is the - * cloud resource collection type representing the service consumer, for - * example 'projects', or 'organizations'. {resource id} is the consumer - * numeric id, such as project number: '123456'. {service} the name of a - * service, such as 'service.googleapis.com'. + * Managed service and service consumer. Required. services/{service}/{collection id}/{resource id} {collection id} is the cloud resource collection type representing the service consumer, for example 'projects', or 'organizations'. {resource id} is the consumer numeric id, such as project number: '123456'. {service} the name of a service, such as 'service.googleapis.com'. */ parent?: string; } @@ -3850,8 +2848,7 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the tenancy unit. Such as - * 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + * Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. */ name?: string; @@ -3868,8 +2865,7 @@ export namespace serviceconsumermanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the tenancy unit. Such as - * 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + * Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. */ name?: string; diff --git a/src/apis/servicecontrol/package.json b/src/apis/servicecontrol/package.json index 1c610124287..08aa9ac3196 100644 --- a/src/apis/servicecontrol/package.json +++ b/src/apis/servicecontrol/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 4e21a603f00..71b34e2a672 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace servicecontrol_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace servicecontrol_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace servicecontrol_v1 { /** * Service Control API * - * Provides control plane functionality to managed services, such as logging, - * monitoring, and status checks. + * Provides control plane functionality to managed services, such as logging, monitoring, and status checks. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace servicecontrol_v1 { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.services = new Resource$Services(this.context); } @@ -121,10 +119,7 @@ export namespace servicecontrol_v1 { export interface Schema$AllocateInfo { /** - * A list of label keys that were unused by the server in processing the - * request. Thus, for similar requests repeated in a certain future time - * window, the caller can choose to ignore these labels in the requests to - * achieve better client-side cache hits and quota aggregation. + * A list of label keys that were unused by the server in processing the request. Thus, for similar requests repeated in a certain future time window, the caller can choose to ignore these labels in the requests to achieve better client-side cache hits and quota aggregation. */ unusedArguments?: string[]; } @@ -137,9 +132,7 @@ export namespace servicecontrol_v1 { */ allocateOperation?: Schema$QuotaOperation; /** - * Specifies which version of service configuration should be used to - * process the request. If unspecified or no matching version can be found, - * the latest one will be used. + * Specifies which version of service configuration should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. */ serviceConfigId?: string; } @@ -156,19 +149,11 @@ export namespace servicecontrol_v1 { */ allocateInfo?: Schema$AllocateInfo; /** - * The same operation_id value used in the AllocateQuotaRequest. Used for - * logging and diagnostics purposes. + * The same operation_id value used in the AllocateQuotaRequest. Used for logging and diagnostics purposes. */ operationId?: string; /** - * Quota metrics to indicate the result of allocation. Depending on the - * request, one or more of the following metrics will be included: 1. Per - * quota group or per quota metric incremental usage will be specified using - * the following delta metric : - * "serviceruntime.googleapis.com/api/consumer/quota_used_count" - * 2. The quota limit reached condition will be specified using the - * following boolean metric : - * "serviceruntime.googleapis.com/quota/exceeded" + * Quota metrics to indicate the result of allocation. Depending on the request, one or more of the following metrics will be included: 1. Per quota group or per quota metric incremental usage will be specified using the following delta metric : "serviceruntime.googleapis.com/api/consumer/quota_used_count" 2. The quota limit reached condition will be specified using the following boolean metric : "serviceruntime.googleapis.com/quota/exceeded" */ quotaMetrics?: Schema$MetricValueSet[]; /** @@ -185,34 +170,23 @@ export namespace servicecontrol_v1 { */ authenticationInfo?: Schema$AuthenticationInfo; /** - * Authorization information. If there are multiple resources or permissions - * involved, then there is one AuthorizationInfo element for each {resource, - * permission} tuple. + * Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple. */ authorizationInfo?: Schema$AuthorizationInfo[]; /** - * Other service-specific data about the request, response, and other - * information associated with the current audited event. + * Other service-specific data about the request, response, and other information associated with the current audited event. */ metadata?: {[key: string]: any}; /** - * The name of the service method or operation. For API calls, this should - * be the name of the API method. For example, - * "google.datastore.v1.Datastore.RunQuery" - * "google.logging.v1.LoggingService.DeleteLog" + * The name of the service method or operation. For API calls, this should be the name of the API method. For example, "google.datastore.v1.Datastore.RunQuery" "google.logging.v1.LoggingService.DeleteLog" */ methodName?: string; /** - * The number of items returned from a List or Query API method, if - * applicable. + * The number of items returned from a List or Query API method, if applicable. */ numResponseItems?: string; /** - * The operation request. This may not include all request parameters, such - * as those that are too large, privacy-sensitive, or duplicated elsewhere - * in the log record. It should never include user-generated data, such as - * file contents. When the JSON object represented here has a proto - * equivalent, the proto name will be indicated in the `@type` property. + * The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ request?: {[key: string]: any}; /** @@ -224,37 +198,23 @@ export namespace servicecontrol_v1 { */ resourceLocation?: Schema$ResourceLocation; /** - * The resource or collection that is the target of the operation. The name - * is a scheme-less URI, not including the API service name. For example: - * "shelves/SHELF_ID/books" - * "shelves/SHELF_ID/books/BOOK_ID" + * The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example: "shelves/SHELF_ID/books" "shelves/SHELF_ID/books/BOOK_ID" */ resourceName?: string; /** - * The resource's original state before mutation. Present only for - * operations which have successfully modified the targeted resource(s). In - * general, this field should contain all changed fields, except those that - * are already been included in `request`, `response`, `metadata` or - * `service_data` fields. When the JSON object represented here has a proto - * equivalent, the proto name will be indicated in the `@type` property. + * The resource's original state before mutation. Present only for operations which have successfully modified the targeted resource(s). In general, this field should contain all changed fields, except those that are already been included in `request`, `response`, `metadata` or `service_data` fields. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ resourceOriginalState?: {[key: string]: any}; /** - * The operation response. This may not include all response elements, such - * as those that are too large, privacy-sensitive, or duplicated elsewhere - * in the log record. It should never include user-generated data, such as - * file contents. When the JSON object represented here has a proto - * equivalent, the proto name will be indicated in the `@type` property. + * The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ response?: {[key: string]: any}; /** - * Deprecated, use `metadata` field instead. Other service-specific data - * about the request, response, and other activities. + * Deprecated, use `metadata` field instead. Other service-specific data about the request, response, and other activities. */ serviceData?: {[key: string]: any}; /** - * The name of the API service performing the operation. For example, - * `"datastore.googleapis.com"`. + * The name of the API service performing the operation. For example, `"datastore.googleapis.com"`. */ serviceName?: string; /** @@ -263,60 +223,27 @@ export namespace servicecontrol_v1 { status?: Schema$Status; } /** - * This message defines request authentication attributes. Terminology is - * based on the JSON Web Token (JWT) standard, but the terms also correlate to - * concepts in other standards. + * This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards. */ export interface Schema$Auth { /** - * A list of access level resource names that allow resources to be accessed - * by authenticated requester. It is part of Secure GCP processing for the - * incoming request. An access level string has the format: - * "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" - * Example: - * "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL" + * A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL" */ accessLevels?: string[]; /** - * The intended audience(s) for this authentication information. Reflects - * the audience (`aud`) claim within a JWT. The audience value(s) depends on - * the `issuer`, but typically include one or more of the following pieces - * of information: * The services intended to receive the credential such - * as ["pubsub.googleapis.com", - * "storage.googleapis.com"] * A set of service-based scopes. For - * example, ["https://www.googleapis.com/auth/cloud-platform"] - * * The client id of an app, such as the Firebase project id for JWTs from - * Firebase Auth. Consult the documentation for the credential issuer to - * determine the information provided. + * The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential such as ["pubsub.googleapis.com", "storage.googleapis.com"] * A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"] * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided. */ audiences?: string[]; /** - * Structured claims presented with the credential. JWTs include `{key: - * value}` pairs for standard and private claims. The following is a subset - * of the standard required and optional claims that would typically be - * presented for a Google-based JWT: {'iss': - * 'accounts.google.com', 'sub': - * '113289723416554971153', 'aud': - * ['123456789012', 'pubsub.googleapis.com'], 'azp': - * '123456789012.apps.googleusercontent.com', 'email': - * 'jsmith@example.com', 'iat': 1353601026, - * 'exp': 1353604926} SAML assertions are similarly specified, but - * with an identity provider dependent structure. + * Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure. */ claims?: {[key: string]: any}; /** - * The authorized presenter of the credential. Reflects the optional - * Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. - * For example, a Google Cloud Platform client id looks as follows: - * "123456789012.apps.googleusercontent.com". + * The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com". */ presenter?: string; /** - * The authenticated principal. Reflects the issuer (`iss`) and subject - * (`sub`) claims within a JWT. The issuer and subject should be `/` - * delimited, with `/` percent-encoded within the subject fragment. For - * Google accounts, the principal format is: - * "https://accounts.google.com/{id}" + * The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}" */ principal?: string; } @@ -325,36 +252,23 @@ export namespace servicecontrol_v1 { */ export interface Schema$AuthenticationInfo { /** - * The authority selector specified by the requestor, if any. It is not - * guaranteed that the principal was allowed to use this authority. + * The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority. */ authoritySelector?: string; /** - * The email address of the authenticated user (or service account on behalf - * of third party principal) making the request. For privacy reasons, the - * principal email address is redacted for all read-only operations that - * fail with a "permission denied" error. + * The email address of the authenticated user (or service account on behalf of third party principal) making the request. For privacy reasons, the principal email address is redacted for all read-only operations that fail with a "permission denied" error. */ principalEmail?: string; /** - * Identity delegation history of an authenticated service account that - * makes the request. It contains information on the real authorities that - * try to access GCP resources by delegating on a service account. When - * multiple authorities present, they are guaranteed to be sorted based on - * the original ordering of the identity delegation events. + * Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. */ serviceAccountDelegationInfo?: Schema$ServiceAccountDelegationInfo[]; /** - * The name of the service account key used to create or exchange - * credentials for authenticating the service account making the request. - * This is a scheme-less URI full resource name. For example: - * "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}" + * The name of the service account key used to create or exchange credentials for authenticating the service account making the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}" */ serviceAccountKeyName?: string; /** - * The third party identification (if any) of the authenticated user making - * the request. When the JSON object represented here has a proto - * equivalent, the proto name will be indicated in the `@type` property. + * The third party identification (if any) of the authenticated user making the request. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property. */ thirdPartyPrincipal?: {[key: string]: any}; } @@ -371,21 +285,16 @@ export namespace servicecontrol_v1 { */ permission?: string; /** - * The resource being accessed, as a REST-style string. For example: - * bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID + * The resource being accessed, as a REST-style string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID */ resource?: string; /** - * Resource attributes used in IAM condition evaluation. This field contains - * resource attributes like resource type and resource name. To get the - * whole view of the attributes used in IAM condition evaluation, the user - * must also look into `AuditLog.request_metadata.request_attributes`. + * Resource attributes used in IAM condition evaluation. This field contains resource attributes like resource type and resource name. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into `AuditLog.request_metadata.request_attributes`. */ resourceAttributes?: Schema$Resource; } /** - * Defines the errors to be returned in - * google.api.servicecontrol.v1.CheckResponse.check_errors. + * Defines the errors to be returned in google.api.servicecontrol.v1.CheckResponse.check_errors. */ export interface Schema$CheckError { /** @@ -397,16 +306,11 @@ export namespace servicecontrol_v1 { */ detail?: string; /** - * Contains public information about the check error. If available, - * `status.code` will be non zero and client can propagate it out as public - * error. + * Contains public information about the check error. If available, `status.code` will be non zero and client can propagate it out as public error. */ status?: Schema$Status; /** - * Subject to whom this error applies. See the specific code enum for more - * details on this field. For example: - “project:<project-id or - * project-number>” - “folder:<folder-id>” - - * “organization:<organization-id>” + * Subject to whom this error applies. See the specific code enum for more details on this field. For example: - “project:<project-id or project-number>” - “folder:<folder-id>” - “organization:<organization-id>” */ subject?: string; } @@ -419,9 +323,7 @@ export namespace servicecontrol_v1 { */ consumerInfo?: Schema$ConsumerInfo; /** - * A list of fields and label keys that are ignored by the server. The - * client doesn't need to send them for following requests to improve - * performance and allow better aggregation. + * A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation. */ unusedArguments?: string[]; } @@ -434,21 +336,15 @@ export namespace servicecontrol_v1 { */ operation?: Schema$Operation; /** - * Requests the project settings to be returned as part of the check - * response. + * Requests the project settings to be returned as part of the check response. */ requestProjectSettings?: boolean; /** - * Specifies which version of service configuration should be used to - * process the request. If unspecified or no matching version can be found, - * the latest one will be used. + * Specifies which version of service configuration should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. */ serviceConfigId?: string; /** - * Indicates if service activation check should be skipped for this request. - * Default behavior is to perform the check and apply relevant quota. - * WARNING: Setting this flag to "true" will disable quota - * enforcement. + * Indicates if service activation check should be skipped for this request. Default behavior is to perform the check and apply relevant quota. WARNING: Setting this flag to "true" will disable quota enforcement. */ skipActivationCheck?: boolean; } @@ -457,9 +353,7 @@ export namespace servicecontrol_v1 { */ export interface Schema$CheckResponse { /** - * Indicate the decision of the check. If no check errors are present, the - * service should process the operation. Otherwise the service should use - * the list of errors to determine the appropriate action. + * Indicate the decision of the check. If no check errors are present, the service should process the operation. Otherwise the service should use the list of errors to determine the appropriate action. */ checkErrors?: Schema$CheckError[]; /** @@ -467,8 +361,7 @@ export namespace servicecontrol_v1 { */ checkInfo?: Schema$CheckInfo; /** - * The same operation_id value used in the CheckRequest. Used for logging - * and diagnostics purposes. + * The same operation_id value used in the CheckRequest. Used for logging and diagnostics purposes. */ operationId?: string; /** @@ -479,44 +372,34 @@ export namespace servicecontrol_v1 { * The actual config id used to process the request. */ serviceConfigId?: string; + /** + * Unimplemented. The current service rollout id used to process the request. + */ + serviceRolloutId?: string; } /** * `ConsumerInfo` provides information about the consumer. */ export interface Schema$ConsumerInfo { /** - * The consumer identity number, can be Google cloud project number, folder - * number or organization number e.g. 1234567890. A value of 0 indicates no - * consumer number is found. + * The consumer identity number, can be Google cloud project number, folder number or organization number e.g. 1234567890. A value of 0 indicates no consumer number is found. */ consumerNumber?: string; /** - * The Google cloud project number, e.g. 1234567890. A value of 0 indicates - * no project number is found. NOTE: This field is deprecated after Chemist - * support flexible consumer id. New code should not depend on this field - * anymore. + * The Google cloud project number, e.g. 1234567890. A value of 0 indicates no project number is found. NOTE: This field is deprecated after Chemist support flexible consumer id. New code should not depend on this field anymore. */ projectNumber?: string; + /** + * The type of the consumer which should have been defined in [Google Resource Manager](https://cloud.google.com/resource-manager/). + */ type?: string; } /** - * Distribution represents a frequency distribution of double-valued sample - * points. It contains the size of the population of sample points plus - * additional optional information: - the arithmetic mean of the samples - - * the minimum and maximum of the samples - the sum-squared-deviation of the - * samples, used to compute variance - a histogram of the values of the - * sample points + * Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information: - the arithmetic mean of the samples - the minimum and maximum of the samples - the sum-squared-deviation of the samples, used to compute variance - a histogram of the values of the sample points */ export interface Schema$Distribution { /** - * The number of samples in each histogram bucket. `bucket_counts` are - * optional. If present, they must sum to the `count` value. The buckets - * are defined below in `bucket_option`. There are N buckets. - * `bucket_counts[0]` is the number of samples in the underflow bucket. - * `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in - * each of the finite buckets. And `bucket_counts[N] is the number of - * samples in the overflow bucket. See the comments of `bucket_option` below - * for more details. Any suffix of trailing zeros may be omitted. + * The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted. */ bucketCounts?: string[]; /** @@ -540,8 +423,7 @@ export namespace servicecontrol_v1 { */ maximum?: number; /** - * The arithmetic mean of the samples in the distribution. If `count` is - * zero then this field must be zero. + * The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero. */ mean?: number; /** @@ -549,9 +431,7 @@ export namespace servicecontrol_v1 { */ minimum?: number; /** - * The sum of squared deviations from the mean: Sum[i=1..count]((x_i - - * mean)^2) where each x_i is a sample values. If `count` is zero then this - * field must be zero, otherwise validation of the request fails. + * The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails. */ sumOfSquaredDeviation?: number; } @@ -560,17 +440,7 @@ export namespace servicecontrol_v1 { */ export interface Schema$ExplicitBuckets { /** - * 'bound' is a list of strictly increasing boundaries between - * buckets. Note that a list of length N-1 defines N buckets because of - * fenceposting. See comments on `bucket_options` for details. The i'th - * finite bucket covers the interval [bound[i-1], bound[i]) where i ranges - * from 1 to bound_size() - 1. Note that there are no finite buckets at all - * if 'bound' only contains a single element; in that special case - * the single bound defines the boundary between the underflow and overflow - * buckets. bucket number lower bound upper bound i - * == 0 (underflow) -inf bound[i] 0 < i < - * bound_size() bound[i-1] bound[i] i == bound_size() - * (overflow) bound[i-1] +inf + * 'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on `bucket_options` for details. The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf */ bounds?: number[]; } @@ -579,21 +449,15 @@ export namespace servicecontrol_v1 { */ export interface Schema$ExponentialBuckets { /** - * The i'th exponential bucket covers the interval [scale * - * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to - * num_finite_buckets inclusive. Must be larger than 1.0. + * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0. */ growthFactor?: number; /** - * The number of finite buckets. With the underflow and overflow buckets, - * the total number of buckets is `num_finite_buckets` + 2. See comments on - * `bucket_options` for details. + * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. */ numFiniteBuckets?: number; /** - * The i'th exponential bucket covers the interval [scale * - * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to - * num_finite_buckets inclusive. Must be > 0. + * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0. */ scale?: number; } @@ -611,19 +475,15 @@ export namespace servicecontrol_v1 { serviceMetadata?: {[key: string]: any}; } /** - * A common proto for logging HTTP requests. Only contains semantics defined - * by the HTTP specification. Product-specific logging information MUST be - * defined in a separate message. + * A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. */ export interface Schema$HttpRequest { /** - * The number of HTTP response bytes inserted into cache. Set only when a - * cache fill was attempted. + * The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. */ cacheFillBytes?: string; /** - * Whether or not an entity was served from cache (with or without - * validation). + * Whether or not an entity was served from cache (with or without validation). */ cacheHit?: boolean; /** @@ -631,66 +491,51 @@ export namespace servicecontrol_v1 { */ cacheLookup?: boolean; /** - * Whether or not the response was validated with the origin server before - * being served from cache. This field is only meaningful if `cache_hit` is - * True. + * Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True. */ cacheValidatedWithOriginServer?: boolean; /** - * The request processing latency on the server, from the time the request - * was received until the response was sent. + * The request processing latency on the server, from the time the request was received until the response was sent. */ latency?: string; /** - * Protocol used for the request. Examples: "HTTP/1.1", - * "HTTP/2", "websocket" + * Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" */ protocol?: string; /** - * The referer URL of the request, as defined in [HTTP/1.1 Header Field - * Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + * The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). */ referer?: string; /** - * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. - * Examples: `"192.168.1.1"`, - * `"FE80::0202:B3FF:FE1E:8329"`. + * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`. */ remoteIp?: string; /** - * The request method. Examples: `"GET"`, `"HEAD"`, - * `"PUT"`, `"POST"`. + * The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`. */ requestMethod?: string; /** - * The size of the HTTP request message in bytes, including the request - * headers and the request body. + * The size of the HTTP request message in bytes, including the request headers and the request body. */ requestSize?: string; /** - * The scheme (http, https), the host name, the path, and the query portion - * of the URL that was requested. Example: - * `"http://example.com/some/info?color=red"`. + * The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`. */ requestUrl?: string; /** - * The size of the HTTP response message sent back to the client, in bytes, - * including the response headers and the response body. + * The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. */ responseSize?: string; /** - * The IP address (IPv4 or IPv6) of the origin server that the request was - * sent to. + * The IP address (IPv4 or IPv6) of the origin server that the request was sent to. */ serverIp?: string; /** - * The response code indicating the status of the response. Examples: 200, - * 404. + * The response code indicating the status of the response. Examples: 200, 404. */ status?: number; /** - * The user agent sent by the client. Example: `"Mozilla/4.0 - * (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`. + * The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`. */ userAgent?: string; } @@ -699,21 +544,15 @@ export namespace servicecontrol_v1 { */ export interface Schema$LinearBuckets { /** - * The number of finite buckets. With the underflow and overflow buckets, - * the total number of buckets is `num_finite_buckets` + 2. See comments on - * `bucket_options` for details. + * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. */ numFiniteBuckets?: number; /** - * The i'th linear bucket covers the interval [offset + (i-1) * width, - * offset + i * width) where i ranges from 1 to num_finite_buckets, - * inclusive. + * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. */ offset?: number; /** - * The i'th linear bucket covers the interval [offset + (i-1) * width, - * offset + i * width) where i ranges from 1 to num_finite_buckets, - * inclusive. Must be strictly positive. + * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive. */ width?: number; } @@ -722,43 +561,35 @@ export namespace servicecontrol_v1 { */ export interface Schema$LogEntry { /** - * Optional. Information about the HTTP request associated with this log - * entry, if applicable. + * Optional. Information about the HTTP request associated with this log entry, if applicable. */ httpRequest?: Schema$HttpRequest; /** - * A unique ID for the log entry used for deduplication. If omitted, the - * implementation will generate one based on operation_id. + * A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id. */ insertId?: string; /** - * A set of user-defined (key, value) data that provides additional - * information about the log entry. + * A set of user-defined (key, value) data that provides additional information about the log entry. */ labels?: {[key: string]: string}; /** - * Required. The log to which this log entry belongs. Examples: - * `"syslog"`, `"book_log"`. + * Required. The log to which this log entry belongs. Examples: `"syslog"`, `"book_log"`. */ name?: string; /** - * Optional. Information about an operation associated with the log entry, - * if applicable. + * Optional. Information about an operation associated with the log entry, if applicable. */ operation?: Schema$LogEntryOperation; /** - * The log entry payload, represented as a protocol buffer that is expressed - * as a JSON object. The only accepted type currently is AuditLog. + * The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog. */ protoPayload?: {[key: string]: any}; /** - * The severity of the log entry. The default value is - * `LogSeverity.DEFAULT`. + * The severity of the log entry. The default value is `LogSeverity.DEFAULT`. */ severity?: string; /** - * The log entry payload, represented as a structure that is expressed as a - * JSON object. + * The log entry payload, represented as a structure that is expressed as a JSON object. */ structPayload?: {[key: string]: any}; /** @@ -766,43 +597,32 @@ export namespace servicecontrol_v1 { */ textPayload?: string; /** - * The time the event described by the log entry occurred. If omitted, - * defaults to operation start time. + * The time the event described by the log entry occurred. If omitted, defaults to operation start time. */ timestamp?: string; /** - * Optional. Resource name of the trace associated with the log entry, if - * any. If this field contains a relative resource name, you can assume the - * name is relative to `//tracing.googleapis.com`. Example: - * `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824` + * Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824` */ trace?: string; } /** - * Additional information about a potentially long-running operation with - * which a log entry is associated. + * Additional information about a potentially long-running operation with which a log entry is associated. */ export interface Schema$LogEntryOperation { /** - * Optional. Set this to True if this is the first log entry in the - * operation. + * Optional. Set this to True if this is the first log entry in the operation. */ first?: boolean; /** - * Optional. An arbitrary operation identifier. Log entries with the same - * identifier are assumed to be part of the same operation. + * Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. */ id?: string; /** - * Optional. Set this to True if this is the last log entry in the - * operation. + * Optional. Set this to True if this is the last log entry in the operation. */ last?: boolean; /** - * Optional. An arbitrary producer identifier. The combination of `id` and - * `producer` must be globally unique. Examples for `producer`: - * `"MyDivision.MyBigCompany.com"`, - * `"github.com/MyProject/MyApplication"`. + * Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`. */ producer?: string; } @@ -823,8 +643,7 @@ export namespace servicecontrol_v1 { */ doubleValue?: number; /** - * The end of the time period over which this metric value's measurement - * applies. + * The end of the time period over which this metric value's measurement applies. */ endTime?: string; /** @@ -832,9 +651,7 @@ export namespace servicecontrol_v1 { */ int64Value?: string; /** - * The labels describing the metric value. See comments on - * google.api.servicecontrol.v1.Operation.labels for the overriding - * relationship. + * The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. */ labels?: {[key: string]: string}; /** @@ -842,10 +659,7 @@ export namespace servicecontrol_v1 { */ moneyValue?: Schema$Money; /** - * The start of the time period over which this metric value's - * measurement applies. The time period has different semantics for - * different metric types (cumulative, delta, and gauge). See the metric - * definition documentation in the service configuration for details. + * The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. */ startTime?: string; /** @@ -854,9 +668,7 @@ export namespace servicecontrol_v1 { stringValue?: string; } /** - * Represents a set of metric values in the same metric. Each metric value in - * the set should have a unique combination of start time, end time, and label - * values. + * Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values. */ export interface Schema$MetricValueSet { /** @@ -877,17 +689,11 @@ export namespace servicecontrol_v1 { */ currencyCode?: string; /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */ nanos?: number; /** - * The whole units of the amount. For example if `currencyCode` is - * `"USD"`, then 1 unit is one US dollar. + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */ units?: string; } @@ -896,19 +702,11 @@ export namespace servicecontrol_v1 { */ export interface Schema$Operation { /** - * Identity of the consumer who is using the service. This field should be - * filled in for the operations initiated by a consumer, but not for - * service-initiated operations that are not related to a specific consumer. - * - This can be in one of the following formats: - project:PROJECT_ID, - * - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or - * PROJECT_NUMBER, - folders/FOLDER_NUMBER, - - * organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY. + * Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY. */ consumerId?: string; /** - * End time of the operation. Required when the operation is used in - * ServiceController.Report, but optional when the operation is used in - * ServiceController.Check. + * End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check. */ endTime?: string; /** @@ -916,19 +714,7 @@ export namespace servicecontrol_v1 { */ importance?: string; /** - * Labels describing the operation. Only the following labels are allowed: - * - Labels describing monitored resources as defined in the service - * configuration. - Default labels of metric values. When specified, labels - * defined in the metric value override these default. - The following - * labels defined by Google Cloud Platform: - - * `cloud.googleapis.com/location` describing the location where the - * operation happened, - `servicecontrol.googleapis.com/user_agent` - * describing the user agent of the API request, - - * `servicecontrol.googleapis.com/service_agent` describing the service used - * to handle the API request (e.g. ESP), - - * `servicecontrol.googleapis.com/platform` describing the platform where - * the API is served, such as App Engine, Compute Engine, or Kubernetes - * Engine. + * Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine. */ labels?: {[key: string]: string}; /** @@ -936,24 +722,11 @@ export namespace servicecontrol_v1 { */ logEntries?: Schema$LogEntry[]; /** - * Represents information about this operation. Each MetricValueSet - * corresponds to a metric defined in the service configuration. The data - * type used in the MetricValueSet must agree with the data type specified - * in the metric definition. Within a single operation, it is not allowed - * to have more than one MetricValue instances that have the same metric - * names and identical label value combinations. If a request has such - * duplicated MetricValue instances, the entire request is rejected with an - * invalid argument error. + * Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error. */ metricValueSets?: Schema$MetricValueSet[]; /** - * Identity of the operation. This must be unique within the scope of the - * service that generated the operation. If the service calls Check() and - * Report() on the same operation, the two calls should carry the same id. - * UUID version 4 is recommended, though not required. In scenarios where an - * operation is computed from existing information and an idempotent id is - * desirable for deduplication purpose, UUID version 5 is recommended. See - * RFC 4122 for details. + * Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. */ operationId?: string; /** @@ -961,22 +734,15 @@ export namespace servicecontrol_v1 { */ operationName?: string; /** - * Represents the properties needed for quota check. Applicable only if this - * operation is for a quota check request. If this is not specified, no - * quota check will be performed. + * Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed. */ quotaProperties?: Schema$QuotaProperties; /** - * DO NOT USE. This field is deprecated, use "resources" field - * instead. The resource name of the parent of a resource in the resource - * hierarchy. This can be in one of the following formats: - - * “projects/<project-id or project-number>” - - * “folders/<folder-id>” - “organizations/<organization-id>” + * DO NOT USE. This field is deprecated, use "resources" field instead. The resource name of the parent of a resource in the resource hierarchy. This can be in one of the following formats: - “projects/<project-id or project-number>” - “folders/<folder-id>” - “organizations/<organization-id>” */ resourceContainer?: string; /** - * The resources that are involved in the operation. The maximum supported - * number of entries in this field is 100. + * The resources that are involved in the operation. The maximum supported number of entries in this field is 100. */ resources?: Schema$ResourceInfo[]; /** @@ -984,17 +750,12 @@ export namespace servicecontrol_v1 { */ startTime?: string; /** - * User defined labels for the resource that this operation is associated - * with. Only a combination of 1000 user labels per consumer project are - * allowed. + * User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed. */ userLabels?: {[key: string]: string}; } /** - * This message defines attributes for a node that handles a network request. - * The node can be either a service or an application that sends, forwards, or - * receives the request. Service peers should fill in the `service`, - * `principal`, and `labels` as appropriate. + * This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in the `service`, `principal`, and `labels` as appropriate. */ export interface Schema$Peer { /** @@ -1010,20 +771,15 @@ export namespace servicecontrol_v1 { */ port?: string; /** - * The identity of this peer. Similar to `Request.auth.principal`, but - * relative to the peer instead of the request. For example, the idenity - * associated with a load balancer that forwared the request. + * The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request. */ principal?: string; /** - * The CLDR country/region code associated with the above IP address. If the - * IP address is private, the `region_code` should reflect the physical - * location where this peer is running. + * The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running. */ regionCode?: string; /** - * The canonical service name of the peer. NOTE: different systems may have - * different service naming schemes. + * The canonical service name of the peer. NOTE: different systems may have different service naming schemes. */ service?: string; } @@ -1040,10 +796,7 @@ export namespace servicecontrol_v1 { */ description?: string; /** - * Subject to whom this error applies. See the specific enum for more - * details on this field. For example, "clientip:<ip address of - * client>" or "project:<Google developer project - * id>". + * Subject to whom this error applies. See the specific enum for more details on this field. For example, "clientip:<ip address of client>" or "project:<Google developer project id>". */ subject?: string; } @@ -1052,34 +805,15 @@ export namespace servicecontrol_v1 { */ export interface Schema$QuotaInfo { /** - * Quota Metrics that have exceeded quota limits. For QuotaGroup-based - * quota, this is QuotaGroup.name For QuotaLimit-based quota, this is - * QuotaLimit.name See: google.api.Quota Deprecated: Use quota_metrics to - * get per quota group limit exceeded status. + * Quota Metrics that have exceeded quota limits. For QuotaGroup-based quota, this is QuotaGroup.name For QuotaLimit-based quota, this is QuotaLimit.name See: google.api.Quota Deprecated: Use quota_metrics to get per quota group limit exceeded status. */ limitExceeded?: string[]; /** - * Map of quota group name to the actual number of tokens consumed. If the - * quota check was not successful, then this will not be populated due to no - * quota consumption. We are not merging this field with - * 'quota_metrics' field because of the complexity of scaling in - * Chemist client code base. For simplicity, we will keep this field for - * Castor (that scales quota usage) and 'quota_metrics' for - * SuperQuota (that doesn't scale quota usage). + * Map of quota group name to the actual number of tokens consumed. If the quota check was not successful, then this will not be populated due to no quota consumption. We are not merging this field with 'quota_metrics' field because of the complexity of scaling in Chemist client code base. For simplicity, we will keep this field for Castor (that scales quota usage) and 'quota_metrics' for SuperQuota (that doesn't scale quota usage). */ quotaConsumed?: {[key: string]: number}; /** - * Quota metrics to indicate the usage. Depending on the check request, one - * or more of the following metrics will be included: 1. For rate quota, - * per quota group or per quota metric incremental usage will be specified - * using the following delta metric: - * "serviceruntime.googleapis.com/api/consumer/quota_used_count" - * 2. For allocation quota, per quota metric total usage will be specified - * using the following gauge metric: - * "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" - * 3. For both rate quota and allocation quota, the quota limit reached - * condition will be specified using the following boolean metric: - * "serviceruntime.googleapis.com/quota/exceeded" + * Quota metrics to indicate the usage. Depending on the check request, one or more of the following metrics will be included: 1. For rate quota, per quota group or per quota metric incremental usage will be specified using the following delta metric: "serviceruntime.googleapis.com/api/consumer/quota_used_count" 2. For allocation quota, per quota metric total usage will be specified using the following gauge metric: "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" 3. For both rate quota and allocation quota, the quota limit reached condition will be specified using the following boolean metric: "serviceruntime.googleapis.com/quota/exceeded" */ quotaMetrics?: Schema$MetricValueSet[]; } @@ -1088,10 +822,7 @@ export namespace servicecontrol_v1 { */ export interface Schema$QuotaOperation { /** - * Identity of the consumer for whom this quota operation is being - * performed. This can be in one of the following formats: - * project:<project_id>, project_number:<project_number>, - * api_key:<api_key>. + * Identity of the consumer for whom this quota operation is being performed. This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>. */ consumerId?: string; /** @@ -1099,34 +830,15 @@ export namespace servicecontrol_v1 { */ labels?: {[key: string]: string}; /** - * Fully qualified name of the API method for which this quota operation is - * requested. This name is used for matching quota rules or metric rules and - * billing status rules defined in service configuration. This field should - * not be set if any of the following is true: (1) the quota operation is - * performed on non-API resources. (2) quota_metrics is set because the - * caller is doing quota override. Example of an RPC method name: - * google.example.library.v1.LibraryService.CreateShelf + * Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration. This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override. Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf */ methodName?: string; /** - * Identity of the operation. This is expected to be unique within the scope - * of the service that generated the operation, and guarantees idempotency - * in case of retries. UUID version 4 is recommended, though not required. - * In scenarios where an operation is computed from existing information and - * an idempotent id is desirable for deduplication purpose, UUID version 5 - * is recommended. See RFC 4122 for details. + * Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. */ operationId?: string; /** - * Represents information about this operation. Each MetricValueSet - * corresponds to a metric defined in the service configuration. The data - * type used in the MetricValueSet must agree with the data type specified - * in the metric definition. Within a single operation, it is not allowed - * to have more than one MetricValue instances that have the same metric - * names and identical label value combinations. If a request has such - * duplicated MetricValue instances, the entire request is rejected with an - * invalid argument error. This field is mutually exclusive with - * method_name. + * Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error. This field is mutually exclusive with method_name. */ quotaMetrics?: Schema$MetricValueSet[]; /** @@ -1174,18 +886,11 @@ export namespace servicecontrol_v1 { */ export interface Schema$ReportRequest { /** - * Operations to be reported. Typically the service should report one - * operation per request. Putting multiple operations into a single request - * is allowed, but should be used only when multiple operations are natually - * available at the time of the report. If multiple operations are in a - * single request, the total request size should be no larger than 1MB. See - * ReportResponse.report_errors for partial failure behavior. + * Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. If multiple operations are in a single request, the total request size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior. */ operations?: Schema$Operation[]; /** - * Specifies which version of service config should be used to process the - * request. If unspecified or no matching version can be found, the latest - * one will be used. + * Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. */ serviceConfigId?: string; } @@ -1194,42 +899,28 @@ export namespace servicecontrol_v1 { */ export interface Schema$ReportResponse { /** - * Partial failures, one for each `Operation` in the request that failed - * processing. There are three possible combinations of the RPC status: 1. - * The combination of a successful RPC status and an empty `report_errors` - * list indicates a complete success where all `Operations` in the request - * are processed successfully. 2. The combination of a successful RPC status - * and a non-empty `report_errors` list indicates a partial success where - * some `Operations` in the request succeeded. Each `Operation` that - * failed processing has a corresponding item in this list. 3. A failed - * RPC status indicates a general non-deterministic failure. When this - * happens, it's impossible to know which of the 'Operations' - * in the request succeeded or failed. + * Partial failures, one for each `Operation` in the request that failed processing. There are three possible combinations of the RPC status: 1. The combination of a successful RPC status and an empty `report_errors` list indicates a complete success where all `Operations` in the request are processed successfully. 2. The combination of a successful RPC status and a non-empty `report_errors` list indicates a partial success where some `Operations` in the request succeeded. Each `Operation` that failed processing has a corresponding item in this list. 3. A failed RPC status indicates a general non-deterministic failure. When this happens, it's impossible to know which of the 'Operations' in the request succeeded or failed. */ reportErrors?: Schema$ReportError[]; /** - * Quota usage for each quota release `Operation` request. Fully or - * partially failed quota release request may or may not be present in - * `report_quota_info`. For example, a failed quota release request will - * have the current quota usage info when precise quota library returns the - * info. A deadline exceeded quota request will not have quota usage info. - * If there is no quota release request, report_quota_info will be empty. + * Quota usage for each quota release `Operation` request. Fully or partially failed quota release request may or may not be present in `report_quota_info`. For example, a failed quota release request will have the current quota usage info when precise quota library returns the info. A deadline exceeded quota request will not have quota usage info. If there is no quota release request, report_quota_info will be empty. */ reportInfos?: Schema$ReportInfo[]; /** * The actual config id used to process the request. */ serviceConfigId?: string; + /** + * Unimplemented. The current service rollout id used to process the request. + */ + serviceRolloutId?: string; } /** - * This message defines attributes for an HTTP request. If the actual request - * is not an HTTP request, the runtime system should try to map the actual - * request to an equivalent HTTP request. + * This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. */ export interface Schema$Request { /** - * The request authentication. May be absent for unauthenticated requests. - * Derived from the HTTP request `Authorization` header or equivalent. + * The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request `Authorization` header or equivalent. */ auth?: Schema$Auth; /** @@ -1237,9 +928,7 @@ export namespace servicecontrol_v1 { */ fragment?: string; /** - * The HTTP request headers. If multiple headers share the same key, they - * must be merged according to the HTTP spec. All header keys must be - * lowercased, because HTTP header keys are case-insensitive. + * The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive. */ headers?: {[key: string]: string}; /** @@ -1247,9 +936,7 @@ export namespace servicecontrol_v1 { */ host?: string; /** - * The unique ID for a request, which can be propagated to downstream - * systems. The ID should have low probability of collision within a single - * day for a specific service. + * The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service. */ id?: string; /** @@ -1261,22 +948,15 @@ export namespace servicecontrol_v1 { */ path?: string; /** - * The network protocol used with the request, such as "http/1.1", - * "spdy/3", "h2", "h2c", "webrtc", - * "tcp", "udp", "quic". See - * https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - * for details. + * The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details. */ protocol?: string; /** - * The HTTP URL query in the format of `name1=value`&name2=value2`, as - * it appears in the first line of the HTTP request. No decoding is - * performed. + * The HTTP URL query in the format of `name1=value`&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed. */ query?: string; /** - * A special parameter for request reason. It is used by security systems to - * associate auditing information with a request. + * A special parameter for request reason. It is used by security systems to associate auditing information with a request. */ reason?: string; /** @@ -1288,8 +968,7 @@ export namespace servicecontrol_v1 { */ size?: string; /** - * The timestamp when the `destination` service receives the first byte of - * the request. + * The timestamp when the `destination` service receives the first byte of the request. */ time?: string; } @@ -1298,85 +977,44 @@ export namespace servicecontrol_v1 { */ export interface Schema$RequestMetadata { /** - * The IP address of the caller. For caller from internet, this will be - * public IPv4 or IPv6 address. For caller from a Compute Engine VM with - * external IP address, this will be the VM's external IP address. For - * caller from a Compute Engine VM without external IP address, if the VM is - * in the same organization (or project) as the accessed resource, - * `caller_ip` will be the VM's internal IPv4 address, otherwise the - * `caller_ip` will be redacted to "gce-internal-ip". See - * https://cloud.google.com/compute/docs/vpc/ for more information. + * The IP address of the caller. For caller from internet, this will be public IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP address, this will be the VM's external IP address. For caller from a Compute Engine VM without external IP address, if the VM is in the same organization (or project) as the accessed resource, `caller_ip` will be the VM's internal IPv4 address, otherwise the `caller_ip` will be redacted to "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more information. */ callerIp?: string; /** - * The network of the caller. Set only if the network host project is part - * of the same GCP organization (or project) as the accessed resource. See - * https://cloud.google.com/compute/docs/vpc/ for more information. This is - * a scheme-less URI full resource name. For example: - * "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID" + * The network of the caller. Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example: "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID" */ callerNetwork?: string; /** - * The user agent of the caller. This information is not authenticated and - * should be treated accordingly. For example: + - * `google-api-python-client/1.4.0`: The request was made by the Google - * API client for Python. + `Cloud SDK Command Line Tool - * apitools-client/1.0 gcloud/0.9.62`: The request was made by the - * Google Cloud SDK CLI (gcloud). + `AppEngine-Google; - * (+http://code.google.com/appengine; appid: s~my-project`: The request - * was made from the `my-project` App Engine app. NOLINT + * The user agent of the caller. This information is not authenticated and should be treated accordingly. For example: + `google-api-python-client/1.4.0`: The request was made by the Google API client for Python. + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`: The request was made by the Google Cloud SDK CLI (gcloud). + `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`: The request was made from the `my-project` App Engine app. NOLINT */ callerSuppliedUserAgent?: string; /** - * The destination of a network activity, such as accepting a TCP - * connection. In a multi hop network activity, the destination represents - * the receiver of the last hop. Only two fields are used in this message, - * Peer.port and Peer.ip. These fields are optionally populated by those - * services utilizing the IAM condition feature. + * The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature. */ destinationAttributes?: Schema$Peer; /** - * Request attributes used in IAM condition evaluation. This field contains - * request attributes like request time and access levels associated with - * the request. To get the whole view of the attributes used in IAM - * condition evaluation, the user must also look into - * `AuditLog.authentication_info.resource_attributes`. + * Request attributes used in IAM condition evaluation. This field contains request attributes like request time and access levels associated with the request. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into `AuditLog.authentication_info.resource_attributes`. */ requestAttributes?: Schema$Request; } /** - * This message defines core attributes for a resource. A resource is an - * addressable (named) entity provided by the destination service. For - * example, a file stored on a network storage service. + * This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service. */ export interface Schema$Resource { /** - * The labels or tags on the resource, such as AWS resource tags and - * Kubernetes resource labels. + * The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels. */ labels?: {[key: string]: string}; /** - * The stable identifier (name) of a resource on the `service`. A resource - * can be logically identified as - * "//{resource.service}/{resource.name}". The differences between - * a resource name and a URI are: * Resource name is a logical - * identifier, independent of network protocol and API version. For - * example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * - * URI often includes protocol and version information, so it can be - * used directly by applications. For example, - * `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See - * https://cloud.google.com/apis/design/resource_names for details. + * The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details. */ name?: string; /** - * The name of the service that this resource belongs to, such as - * `pubsub.googleapis.com`. The service may be different from the DNS - * hostname that actually serves the request. + * The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request. */ service?: string; /** - * The type of the resource. The scheme is platform-specific because - * different platforms define their resources differently. + * The type of the resource. The scheme is platform-specific because different platforms define their resources differently. */ type?: string; } @@ -1385,17 +1023,11 @@ export namespace servicecontrol_v1 { */ export interface Schema$ResourceInfo { /** - * The identifier of the parent of this resource instance. Must be in one of - * the following formats: - “projects/<project-id or - * project-number>” - “folders/<folder-id>” - - * “organizations/<organization-id>” + * The identifier of the parent of this resource instance. Must be in one of the following formats: - “projects/<project-id or project-number>” - “folders/<folder-id>” - “organizations/<organization-id>” */ resourceContainer?: string; /** - * The location of the resource. If not empty, the resource will be checked - * against location policy. The value must be a valid zone, region or - * multiregion. For example: "europe-west4" or - * "northamerica-northeast1-a" + * The location of the resource. If not empty, the resource will be checked against location policy. The value must be a valid zone, region or multiregion. For example: "europe-west4" or "northamerica-northeast1-a" */ resourceLocation?: string; /** @@ -1408,19 +1040,11 @@ export namespace servicecontrol_v1 { */ export interface Schema$ResourceLocation { /** - * The locations of a resource after the execution of the operation. - * Requests to create or delete a location based resource must populate the - * 'current_locations' field and not the - * 'original_locations' field. For example: - * "europe-west1-a" "us-east1" "nam3" + * The locations of a resource after the execution of the operation. Requests to create or delete a location based resource must populate the 'current_locations' field and not the 'original_locations' field. For example: "europe-west1-a" "us-east1" "nam3" */ currentLocations?: string[]; /** - * The locations of a resource prior to the execution of the operation. - * Requests that mutate the resource's location must populate both the - * 'original_locations' as well as the 'current_locations' - * fields. For example: "europe-west1-a" "us-east1" - * "nam3" + * The locations of a resource prior to the execution of the operation. Requests that mutate the resource's location must populate both the 'original_locations' as well as the 'current_locations' fields. For example: "europe-west1-a" "us-east1" "nam3" */ originalLocations?: string[]; } @@ -1438,40 +1062,7 @@ export namespace servicecontrol_v1 { thirdPartyPrincipal?: Schema$ThirdPartyPrincipal; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1479,14 +1070,11 @@ export namespace servicecontrol_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1508,14 +1096,7 @@ export namespace servicecontrol_v1 { /** * servicecontrol.services.allocateQuota - * @desc Attempts to allocate quota for the specified consumer. It should be - * called before the operation is executed. This method requires the - * `servicemanagement.services.quota` permission on the specified service. - * For more information, see [Cloud IAM](https://cloud.google.com/iam). - * **NOTE:** The client **must** fail-open on server errors `INTERNAL`, - * `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system - * reliability, the server may inject these errors to prohibit any hard - * dependency on the quota functionality. + * @desc Attempts to allocate quota for the specified consumer. It should be called before the operation is executed. This method requires the `servicemanagement.services.quota` permission on the specified service. For more information, see [Cloud IAM](https://cloud.google.com/iam). **NOTE:** The client **must** fail-open on server errors `INTERNAL`, `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality. * @alias servicecontrol.services.allocateQuota * @memberOf! () * @@ -1595,17 +1176,7 @@ export namespace servicecontrol_v1 { /** * servicecontrol.services.check - * @desc Checks whether an operation on a service should be allowed to - * proceed based on the configuration of the service and related policies. - * It must be called before the operation is executed. If feasible, the - * client should cache the check results and reuse them for 60 seconds. In - * case of any server errors, the client should rely on the cached results - * for much longer time to avoid outage. WARNING: There is general 60s delay - * for the configuration and policy propagation, therefore callers MUST NOT - * depend on the `Check` method having the latest policy information. NOTE: - * the CheckRequest has the size limit of 64KB. This method requires the - * `servicemanagement.services.check` permission on the specified service. - * For more information, see [Cloud IAM](https://cloud.google.com/iam). + * @desc Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies. It must be called before the operation is executed. If feasible, the client should cache the check results and reuse them for 60 seconds. In case of any server errors, the client should rely on the cached results for much longer time to avoid outage. WARNING: There is general 60s delay for the configuration and policy propagation, therefore callers MUST NOT depend on the `Check` method having the latest policy information. NOTE: the CheckRequest has the size limit of 64KB. This method requires the `servicemanagement.services.check` permission on the specified service. For more information, see [Cloud IAM](https://cloud.google.com/iam). * @alias servicecontrol.services.check * @memberOf! () * @@ -1680,17 +1251,7 @@ export namespace servicecontrol_v1 { /** * servicecontrol.services.report - * @desc Reports operation results to Google Service Control, such as logs - * and metrics. It should be called after an operation is completed. If - * feasible, the client should aggregate reporting data for up to 5 seconds - * to reduce API traffic. Limiting aggregation to 5 seconds is to reduce - * data loss during client crashes. Clients should carefully choose the - * aggregation time window to avoid data loss risk more than 0.01% for - * business and compliance reasons. NOTE: the ReportRequest has the size - * limit of 1MB. This method requires the - * `servicemanagement.services.report` permission on the specified service. - * For more information, see [Google Cloud - * IAM](https://cloud.google.com/iam). + * @desc Reports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed. If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons. NOTE: the ReportRequest has the size limit of 1MB. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Google Cloud IAM](https://cloud.google.com/iam). * @alias servicecontrol.services.report * @memberOf! () * @@ -1772,9 +1333,7 @@ export namespace servicecontrol_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the service as specified in the service configuration. For - * example, `"pubsub.googleapis.com"`. See google.api.Service for the - * definition of a service name. + * Name of the service as specified in the service configuration. For example, `"pubsub.googleapis.com"`. See google.api.Service for the definition of a service name. */ serviceName?: string; @@ -1790,10 +1349,7 @@ export namespace servicecontrol_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The service name as specified in its service configuration. For example, - * `"pubsub.googleapis.com"`. See - * [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) - * for the definition of a service name. + * The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name. */ serviceName?: string; @@ -1809,10 +1365,7 @@ export namespace servicecontrol_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The service name as specified in its service configuration. For example, - * `"pubsub.googleapis.com"`. See - * [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) - * for the definition of a service name. + * The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name. */ serviceName?: string; diff --git a/src/apis/servicemanagement/package.json b/src/apis/servicemanagement/package.json index 0d8ac8a5a5e..6a3aebe7703 100644 --- a/src/apis/servicemanagement/package.json +++ b/src/apis/servicemanagement/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index ff27bb77065..ffd19982d31 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace servicemanagement_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace servicemanagement_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace servicemanagement_v1 { /** * Service Management API * - * Google Service Management allows service producers to publish their - * services on Google Cloud Platform so that they can be discovered and used - * by service consumers. + * Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace servicemanagement_v1 { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.services = new Resource$Services(this.context); @@ -123,25 +120,16 @@ export namespace servicemanagement_v1 { } /** - * Generated advice about this change, used for providing more information - * about how a change will affect the existing service. + * Generated advice about this change, used for providing more information about how a change will affect the existing service. */ export interface Schema$Advice { /** - * Useful description for why this advice was applied and what actions - * should be taken to mitigate any implied risks. + * Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks. */ description?: string; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also - * described as "protocol buffer services" in some contexts, such as - * by the "service" keyword in a .proto file, but they are different - * from API Services, which represent a concrete implementation of an - * interface as opposed to simply a description of methods and bindings. They - * are also sometimes simply referred to as "APIs" in other - * contexts, such as the name of this message itself. See - * https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ export interface Schema$Api { /** @@ -153,8 +141,7 @@ export namespace servicemanagement_v1 { */ mixins?: Schema$Mixin[]; /** - * The fully qualified name of this interface, including package name - * followed by the interface's simple name. + * The fully qualified name of this interface, including package name followed by the interface's simple name. */ name?: string; /** @@ -162,8 +149,7 @@ export namespace servicemanagement_v1 { */ options?: Schema$Option[]; /** - * Source context for the protocol buffer service represented by this - * message. + * Source context for the protocol buffer service represented by this message. */ sourceContext?: Schema$SourceContext; /** @@ -171,46 +157,12 @@ export namespace servicemanagement_v1 { */ syntax?: string; /** - * A version string for this interface. If specified, must have the form - * `major-version.minor-version`, as in `1.10`. If the minor version is - * omitted, it defaults to zero. If the entire version field is empty, the - * major version is derived from the package name, as outlined below. If the - * field is not empty, the version in the package name will be verified to - * be consistent with what is provided here. The versioning schema uses - * [semantic versioning](http://semver.org) where the major version number - * indicates a breaking change and the minor version an additive, - * non-breaking change. Both version numbers are signals to users what to - * expect from different versions, and should be carefully chosen based on - * the product plan. The major version is also reflected in the package - * name of the interface, which must end in `v<major-version>`, as in - * `google.feature.v1`. For major versions 0 and 1, the suffix can be - * omitted. Zero major versions must only be used for experimental, non-GA - * interfaces. + * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ version?: string; } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -218,25 +170,16 @@ export namespace servicemanagement_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -245,13 +188,7 @@ export namespace servicemanagement_v1 { logType?: string; } /** - * `Authentication` defines the authentication configuration for an API. - * Example for an API targeted for external use: name: - * calendar.googleapis.com authentication: providers: - id: - * google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Authentication { /** @@ -259,18 +196,12 @@ export namespace servicemanagement_v1 { */ providers?: Schema$AuthProvider[]; /** - * A list of authentication rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$AuthenticationRule[]; } /** - * Authentication rules for the service. By default, if a method has any - * authentication requirements, every request must include a valid credential - * matching one of the requirements. It's an error to include more than - * one kind of credential in a single request. If a method doesn't have - * any auth requirements, request credentials will be ignored. + * Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored. */ export interface Schema$AuthenticationRule { /** @@ -286,96 +217,54 @@ export namespace servicemanagement_v1 { */ requirements?: Schema$AuthRequirement[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Configuration of authorization. This section determines the authorization - * provider, if unspecified, then no authorization check will be done. - * Example: experimental: authorization: provider: - * firebaserules.googleapis.com + * Configuration of authorization. This section determines the authorization provider, if unspecified, then no authorization check will be done. Example: experimental: authorization: provider: firebaserules.googleapis.com */ export interface Schema$AuthorizationConfig { /** - * The name of the authorization provider, such as - * firebaserules.googleapis.com. + * The name of the authorization provider, such as firebaserules.googleapis.com. */ provider?: string; } /** - * Configuration for an authentication provider, including support for [JSON - * Web Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthProvider { /** - * The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * Redirect URL if JWT token is required but not present or is expired. - * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ authorizationUrl?: string; /** - * The unique identifier of the auth provider. It will be referred to by - * `AuthRequirement.provider_id`. Example: "bookstore_auth". + * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ id?: string; /** - * Identifies the principal that issued the JWT. See - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - * Usually a URL or an email address. Example: - * https://securetoken.google.com Example: - * 1234567-compute@developer.gserviceaccount.com + * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ issuer?: string; /** - * URL of the provider's public key set to validate signature of the - * JWT. See [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - * Optional if the key set document: - can be retrieved from [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: - * https://www.googleapis.com/oauth2/v1/certs + * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string; } /** - * User-defined authentication requirements, including support for [JSON Web - * Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthRequirement { /** - * NOTE: This will be deprecated soon, once AuthProvider.audiences is - * implemented and accepted in all the runtime components. The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * id from authentication provider. Example: provider_id: - * bookstore_auth + * id from authentication provider. Example: provider_id: bookstore_auth */ providerId?: string; } @@ -384,9 +273,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$Backend { /** - * A list of API backend rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$BackendRule[]; } @@ -399,9 +286,7 @@ export namespace servicemanagement_v1 { */ address?: string; /** - * The number of seconds to wait for a response from a request. The default - * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 - * seconds. + * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ deadline?: number; /** @@ -409,56 +294,38 @@ export namespace servicemanagement_v1 { */ jwtAudience?: string; /** - * Minimum deadline in seconds needed for this method. Calls having deadline - * value lower than this will be rejected. + * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ minDeadline?: number; /** - * The number of seconds to wait for the completion of a long running - * operation. The default is no deadline. + * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ operationDeadline?: number; pathTranslation?: string; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Billing related configuration of the service. The following example shows - * how to configure monitored resources and metrics for billing: - * monitored_resources: - type: library.googleapis.com/branch labels: - - * key: /city description: The city where the library branch is - * located in. - key: /name description: The name of the branch. - * metrics: - name: library.googleapis.com/book/borrowed_count - * metric_kind: DELTA value_type: INT64 billing: - * consumer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/borrowed_count + * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** - * Billing configurations for sending metrics to the consumer project. There - * can be multiple consumer destinations per service, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. + * Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. */ consumerDestinations?: Schema$BillingDestination[]; } /** - * Configuration of a specific billing destination (Currently only support - * bill against consumer project). + * Configuration of a specific billing destination (Currently only support bill against consumer project). */ export interface Schema$BillingDestination { /** - * Names of the metrics to report to this billing destination. Each name - * must be defined in Service.metrics section. + * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } @@ -467,58 +334,33 @@ export namespace servicemanagement_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Change report associated with a particular service configuration. It - * contains a list of ConfigChanges based on the comparison between two - * service configurations. + * Change report associated with a particular service configuration. It contains a list of ConfigChanges based on the comparison between two service configurations. */ export interface Schema$ChangeReport { /** - * List of changes between two service configurations. The changes will be - * alphabetically sorted based on the identifier of each change. A - * ConfigChange identifier is a dot separated path to the configuration. - * Example: - * visibility.rules[selector='LibraryService.CreateBook'].restriction + * List of changes between two service configurations. The changes will be alphabetically sorted based on the identifier of each change. A ConfigChange identifier is a dot separated path to the configuration. Example: visibility.rules[selector='LibraryService.CreateBook'].restriction */ configChanges?: Schema$ConfigChange[]; } /** - * Output generated from semantically comparing two versions of a service - * configuration. Includes detailed information about a field that have - * changed with applicable advice about potential consequences for the change, - * such as backwards-incompatibility. + * Output generated from semantically comparing two versions of a service configuration. Includes detailed information about a field that have changed with applicable advice about potential consequences for the change, such as backwards-incompatibility. */ export interface Schema$ConfigChange { /** - * Collection of advice provided for this change, useful for determining the - * possible impact of this change. + * Collection of advice provided for this change, useful for determining the possible impact of this change. */ advices?: Schema$Advice[]; /** @@ -526,25 +368,15 @@ export namespace servicemanagement_v1 { */ changeType?: string; /** - * Object hierarchy path to the change, with levels separated by a - * '.' character. For repeated fields, an applicable unique - * identifier field is used for the index (usually selector, name, or id). - * For maps, the term 'key' is used. If the field has no unique - * identifier, the numeric index is used. Examples: - - * visibility.rules[selector=="google.LibraryService.ListBooks"].restriction - * - - * quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value - * - logging.producer_destinations[0] + * Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used. Examples: - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value - logging.producer_destinations[0] */ element?: string; /** - * Value of the changed object in the new Service configuration, in JSON - * format. This field will not be populated if ChangeType == REMOVED. + * Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED. */ newValue?: string; /** - * Value of the changed object in the old Service configuration, in JSON - * format. This field will not be populated if ChangeType == ADDED. + * Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED. */ oldValue?: string; } @@ -570,67 +402,42 @@ export namespace servicemanagement_v1 { */ export interface Schema$ConfigRef { /** - * Resource name of a service config. It must have the following format: - * "services/{service name}/configs/{config id}". + * Resource name of a service config. It must have the following format: "services/{service name}/configs/{config id}". */ name?: string; } /** - * Represents a source file which is used to generate the service - * configuration defined by `google.api.Service`. + * Represents a source file which is used to generate the service configuration defined by `google.api.Service`. */ export interface Schema$ConfigSource { /** - * Set of source configuration files that are used to generate a service - * configuration (`google.api.Service`). + * Set of source configuration files that are used to generate a service configuration (`google.api.Service`). */ files?: Schema$ConfigFile[]; /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. + * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. */ id?: string; } /** - * `Context` defines which contexts an API requests. Example: context: - * rules: - selector: "*" requested: - - * google.rpc.context.ProjectContext - - * google.rpc.context.OriginContext The above specifies that all methods in - * the API request `google.rpc.context.ProjectContext` and - * `google.rpc.context.OriginContext`. Available context types are defined in - * package `google.rpc.context`. This also provides mechanism to whitelist - * any protobuf message extension that can be sent in grpc metadata using - * “x-goog-ext-<extension_id>-bin” and - * “x-goog-ext-<extension_id>-jspb” format. For example, list any - * service specific protobuf types that can appear in grpc metadata as follows - * in your yaml file: Example: context: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allowed_request_extensions: - google.foo.v1.NewExtension - * allowed_response_extensions: - google.foo.v1.NewExtension You can - * also specify extension ID instead of fully qualified extension name here. + * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ export interface Schema$Context { /** - * A list of RPC context rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$ContextRule[]; } /** - * A context rule provides information about the context for an individual API - * element. + * A context rule provides information about the context for an individual API element. */ export interface Schema$ContextRule { /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from client to backend. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ allowedRequestExtensions?: string[]; /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from backend to client. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ allowedResponseExtensions?: string[]; /** @@ -642,39 +449,29 @@ export namespace servicemanagement_v1 { */ requested?: string[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Selects and configures the service controller used by the service. The - * service controller handles features like abuse, quota, billing, logging, - * monitoring, etc. + * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. */ export interface Schema$Control { /** - * The service control environment to use. If empty, no control plane - * feature (like quota and billing) will be enabled. + * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ environment?: string; } /** - * Customize service error responses. For example, list any service specific - * protobuf types that can appear in error detail lists of error responses. - * Example: custom_error: types: - google.foo.v1.CustomError - * - google.foo.v1.AnotherError + * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError */ export interface Schema$CustomError { /** - * The list of custom error rules that apply to individual API messages. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$CustomErrorRule[]; /** - * The list of custom error detail types, e.g. - * 'google.foo.v1.CustomError'. + * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ types?: string[]; } @@ -683,13 +480,11 @@ export namespace servicemanagement_v1 { */ export interface Schema$CustomErrorRule { /** - * Mark this message as possible payload in error response. Otherwise, - * objects of this type will be filtered when they appear in error payload. + * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ isErrorType?: boolean; /** - * Selects messages to which this rule applies. Refer to selector for - * syntax details. + * Selects messages to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -707,8 +502,7 @@ export namespace servicemanagement_v1 { path?: string; } /** - * Strategy used to delete a service. This strategy is a placeholder only used - * by the system generated rollout to delete a service. + * Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. */ export interface Schema$DeleteServiceStrategy {} /** @@ -733,50 +527,12 @@ export namespace servicemanagement_v1 { */ export interface Schema$DisableServiceRequest { /** - * The identity of consumer resource which service disablement will be - * applied to. The Google Service Management implementation accepts the - * following forms: - "project:<project_id>" Note: this is - * made compatible with google.api.servicecontrol.v1.Operation.consumer_id. + * The identity of consumer resource which service disablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. */ consumerId?: string; } /** - * `Documentation` provides the information for describing a service. Example: - * <pre><code>documentation: summary: > The Google - * Calendar API gives access to most calendar features. pages: - name: - * Overview content: &#40;== include google/foo/overview.md - * ==&#41; - name: Tutorial content: &#40;== include - * google/foo/tutorial.md ==&#41; subpages; - name: Java content: - * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - - * selector: google.calendar.Calendar.Get description: > ... - - * selector: google.calendar.Calendar.Put description: > ... - * </code></pre> Documentation is provided in markdown syntax. In - * addition to standard markdown features, definition lists, tables and fenced - * code blocks are supported. Section headers can be provided and are - * interpreted relative to the section nesting of the context where a - * documentation fragment is embedded. Documentation from the IDL is merged - * with documentation defined via the config at normalization time, where - * documentation provided by config rules overrides IDL provided. A number of - * constructs specific to the API platform are supported in documentation - * text. In order to reference a proto element, the following notation can be - * used: - * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> - * To override the display text used for the link, this can be used: - * <pre><code>&#91;display - * text]&#91;fully.qualified.proto.name]</code></pre> Text can - * be excluded from doc using the following notation: - * <pre><code>&#40;-- internal comment - * --&#41;</code></pre> A few directives are available in - * documentation. Note that directives must appear on a single line to be - * properly identified. The `include` directive includes a markdown file from - * an external source: <pre><code>&#40;== include path/to/file - * ==&#41;</code></pre> The `resource_for` directive marks a - * message to be the resource of a collection in REST view. If it is not - * specified, tools attempt to infer the resource from the operations in a - * collection: <pre><code>&#40;== resource_for - * v1.shelves.books ==&#41;</code></pre> The directive - * `suppress_warning` does not directly affect documentation and is documented - * together with service config validation. + * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -784,14 +540,7 @@ export namespace servicemanagement_v1 { */ documentationRootUrl?: string; /** - * Declares a single overview page. For example: - * <pre><code>documentation: summary: ... overview: - * &#40;== include overview.md ==&#41; </code></pre> - * This is a shortcut for the following declaration (using pages style): - * <pre><code>documentation: summary: ... pages: - name: - * Overview content: &#40;== include overview.md ==&#41; - * </code></pre> Note: you cannot specify both `overview` field - * and `pages` field. + * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ overview?: string; /** @@ -799,14 +548,11 @@ export namespace servicemanagement_v1 { */ pages?: Schema$Page[]; /** - * A list of documentation rules that apply to individual API elements. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; /** - * A short summary of what the service does. Can only be provided by plain - * text. + * A short summary of what the service does. Can only be provided by plain text. */ summary?: string; } @@ -815,8 +561,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$DocumentationRule { /** - * Deprecation description of the selected element(s). It can be provided if - * an element is marked as `deprecated`. + * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ deprecationDescription?: string; /** @@ -824,13 +569,7 @@ export namespace servicemanagement_v1 { */ description?: string; /** - * The selector is a comma-separated list of patterns. Each pattern is a - * qualified name of the element which may end in "*", indicating - * a wildcard. Wildcards are only allowed at the end and for a whole - * component of the qualified name, i.e. "foo.*" is ok, but not - * "foo.b*" or "foo.*.bar". A wildcard will match one or - * more components. To specify a default for all applicable elements, the - * whole pattern "*" is used. + * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ selector?: string; } @@ -839,39 +578,20 @@ export namespace servicemanagement_v1 { */ export interface Schema$EnableServiceRequest { /** - * The identity of consumer resource which service enablement will be - * applied to. The Google Service Management implementation accepts the - * following forms: - "project:<project_id>" Note: this is - * made compatible with google.api.servicecontrol.v1.Operation.consumer_id. + * The identity of consumer resource which service enablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. */ consumerId?: string; } /** - * `Endpoint` describes a network endpoint that serves a set of APIs. A - * service may expose any number of endpoints, and all endpoints share the - * same service configuration, such as quota configuration and monitoring - * configuration. Example service configuration: name: - * library-example.googleapis.com endpoints: # Below entry makes - * 'google.example.library.v1.Library' # API be served from - * endpoint address library-example.googleapis.com. # It also allows - * HTTP OPTIONS calls to be passed to the backend, for # it to decide - * whether the subsequent cross-origin request is # allowed to proceed. - * - name: library-example.googleapis.com allow_cors: true + * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ export interface Schema$Endpoint { /** - * DEPRECATED: This field is no longer supported. Instead of using aliases, - * please specify multiple google.api.Endpoint for each of the intended - * aliases. Additional names that this endpoint will be hosted on. + * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ aliases?: string[]; /** - * Allowing - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - * cross-domain traffic, would allow the backends served from this endpoint - * to receive and respond to HTTP OPTIONS requests. The response will be - * used by the browser to determine whether the subsequent cross-origin - * request is allowed to proceed. + * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ allowCors?: boolean; /** @@ -883,11 +603,7 @@ export namespace servicemanagement_v1 { */ name?: string; /** - * The specification of an Internet routable address of API frontend that - * will handle requests to this [API - * Endpoint](https://cloud.google.com/apis/design/glossary). It should be - * either a valid IPv4 address or a fully-qualified domain name. For - * example, "8.8.8.8" or "myservice.appspot.com". + * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ target?: string; } @@ -934,8 +650,7 @@ export namespace servicemanagement_v1 { options?: Schema$Option[]; } /** - * Experimental service configuration. These configuration options can only be - * used by whitelisted users. + * Experimental service configuration. These configuration options can only be used by whitelisted users. */ export interface Schema$Experimental { /** @@ -944,31 +659,23 @@ export namespace servicemanagement_v1 { authorization?: Schema$AuthorizationConfig; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -1001,9 +708,7 @@ export namespace servicemanagement_v1 { */ number?: number; /** - * The index of the field type in `Type.oneofs`, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. + * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ oneofIndex?: number; /** @@ -1015,27 +720,33 @@ export namespace servicemanagement_v1 { */ packed?: boolean; /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ typeUrl?: string; } + /** + * Encapsulation of flow-specific error details for debugging. Used as a details field on an error Status, not intended for external use. + */ + export interface Schema$FlowErrorDetails { + /** + * The type of exception (as a class name). + */ + exceptionType?: string; + /** + * The step that failed. + */ + flowStepId?: string; + } /** * Request message for GenerateConfigReport method. */ export interface Schema$GenerateConfigReportRequest { /** - * Service configuration for which we want to generate the report. For this - * version of API, the supported types are - * google.api.servicemanagement.v1.ConfigRef, - * google.api.servicemanagement.v1.ConfigSource, and google.api.Service + * Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ newConfig?: {[key: string]: any}; /** - * Service configuration against which the comparison will be done. For this - * version of API, the supported types are - * google.api.servicemanagement.v1.ConfigRef, - * google.api.servicemanagement.v1.ConfigSource, and google.api.Service + * Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ oldConfig?: {[key: string]: any}; } @@ -1044,13 +755,11 @@ export namespace servicemanagement_v1 { */ export interface Schema$GenerateConfigReportResponse { /** - * list of ChangeReport, each corresponding to comparison between two - * service configurations. + * list of ChangeReport, each corresponding to comparison between two service configurations. */ changeReports?: Schema$ChangeReport[]; /** - * Errors / Linter warnings associated with the service definition this - * report belongs to. + * Errors / Linter warnings associated with the service definition this report belongs to. */ diagnostics?: Schema$Diagnostic[]; /** @@ -1067,198 +776,32 @@ export namespace servicemanagement_v1 { */ export interface Schema$GetIamPolicyRequest {} /** - * Defines the HTTP configuration for an API service. It contains a list of - * HttpRule, each specifying the mapping of an RPC method to one or more HTTP - * REST API methods. + * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. */ export interface Schema$Http { /** - * When set to true, URL path parameters will be fully URI-decoded except in - * cases of single segment matches in reserved expansion, where - * "%2F" will be left encoded. The default behavior is to not - * decode RFC 6570 reserved characters in multi segment matches. + * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ fullyDecodeReservedExpansion?: boolean; /** - * A list of HTTP configuration rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$HttpRule[]; } /** - * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - * gRPC method and one or more HTTP REST endpoints. It allows developers to - * build a single API service that supports both gRPC APIs and REST APIs. Many - * systems, including [Google APIs](https://github.com/googleapis/googleapis), - * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and - * use it for large scale production services. `HttpRule` defines the schema - * of the gRPC/REST mapping. The mapping specifies how different portions of - * the gRPC request message are mapped to the URL path, URL query parameters, - * and HTTP request body. It also controls how the gRPC response message is - * mapped to the HTTP response body. `HttpRule` is typically specified as an - * `google.api.http` annotation on the gRPC method. Each mapping specifies a - * URL path template and an HTTP method. The path template may refer to one or - * more fields in the gRPC request message, as long as each field is a - * non-repeated field with a primitive (non-message) type. The path template - * controls how fields of the request message are mapped to the URL path. - * Example: service Messaging { rpc GetMessage(GetMessageRequest) - * returns (Message) { option (google.api.http) = { get: - * "/v1/{name=messages/*}" }; } } message - * GetMessageRequest { string name = 1; // Mapped to URL path. } - * message Message { string text = 1; // The resource content. } - * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC - * -----|----- `GET /v1/messages/123456` | `GetMessage(name: - * "messages/123456")` Any fields in the request message which are - * not bound by the path template automatically become HTTP query parameters - * if there is no HTTP request body. For example: service Messaging { rpc - * GetMessage(GetMessageRequest) returns (Message) { option - * (google.api.http) = { get:"/v1/messages/{message_id}" - * }; } } message GetMessageRequest { message SubMessage { - * string subfield = 1; } string message_id = 1; // Mapped to URL - * path. int64 revision = 2; // Mapped to URL query parameter - * `revision`. SubMessage sub = 3; // Mapped to URL query parameter - * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - * HTTP | gRPC -----|----- `GET - * /v1/messages/123456?revision=2&sub.subfield=foo` | - * `GetMessage(message_id: "123456" revision: 2 sub: - * SubMessage(subfield: "foo"))` Note that fields which are mapped - * to URL query parameters must have a primitive type or a repeated primitive - * type or a non-repeated message type. In the case of a repeated type, the - * parameter can be repeated in the URL as `...?param=A&param=B`. In the - * case of a message type, each field of the message is mapped to a separate - * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods - * that allow a request body, the `body` field specifies the mapping. Consider - * a REST update method on the message resource collection: service - * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) - * { option (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "message" - * }; } } message UpdateMessageRequest { string message_id - * = 1; // mapped to the URL Message message = 2; // mapped to the - * body } The following HTTP JSON to RPC mapping is enabled, where the - * representation of the JSON in the request body is determined by protos JSON - * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { - * "text": "Hi!" }` | `UpdateMessage(message_id: - * "123456" message { text: "Hi!" })` The special name - * `*` can be used in the body mapping to define that every field not bound by - * the path template should be mapped to the request body. This enables the - * following alternative definition of the update method: service - * Messaging { rpc UpdateMessage(Message) returns (Message) { option - * (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "*" }; } } - * message Message { string message_id = 1; string text = 2; } - * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- - * `PATCH /v1/messages/123456 { "text": "Hi!" }` | - * `UpdateMessage(message_id: "123456" text: "Hi!")` Note - * that when using `*` in the body mapping, it is not possible to have HTTP - * parameters, as all fields not bound by the path end in the body. This makes - * this option more rarely used in practice when defining REST APIs. The - * common usage of `*` is in custom methods which don't use the URL at all - * for transferring data. It is possible to define multiple HTTP methods for - * one RPC by using the `additional_bindings` option. Example: service - * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { - * option (google.api.http) = { get: - * "/v1/messages/{message_id}" additional_bindings { get: - * "/v1/users/{user_id}/messages/{message_id}" } }; } } - * message GetMessageRequest { string message_id = 1; string - * user_id = 2; } This enables the following two alternative HTTP JSON to - * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - * `GetMessage(message_id: "123456")` `GET - * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" - * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf - * request fields (recursive expansion nested messages in the request message) - * are classified into three categories: - Fields referred by the path - * template. They are passed via the URL path. - Fields referred by the - * HttpRule.body. They are passed via the HTTP request body. - All - * other fields are passed via the URL query parameters, and the parameter - * name is the field path in the request message. A repeated field can be - * represented as multiple query parameters under the same name. 2. If - * HttpRule.body is "*", there is no URL query parameter, all fields - * are passed via URL path and HTTP request body. 3. If HttpRule.body is - * omitted, there is no HTTP request body, all fields are passed via URL - * path and URL query parameters. ### Path template syntax Template = - * "/" Segments [ Verb ] ; Segments = Segment { "/" - * Segment } ; Segment = "*" | "**" | LITERAL | - * Variable ; Variable = "{" FieldPath [ "=" Segments - * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb - * = ":" LITERAL ; The syntax `*` matches a single URL path - * segment. The syntax `**` matches zero or more URL path segments, which must - * be the last part of the URL path except the `Verb`. The syntax `Variable` - * matches part of the URL path as specified by its template. A variable - * template must not contain other variables. If a variable matches a single - * path segment, its template may be omitted, e.g. `{var}` is equivalent to - * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If - * the `LITERAL` contains any reserved character, such characters should be - * percent-encoded before the matching. If a variable contains exactly one - * path segment, such as `"{var}"` or `"{var=*}"`, when - * such a variable is expanded into a URL path on the client side, all - * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - * does the reverse decoding. Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{var}`. If a variable contains multiple path segments, such as - * `"{var=foo/*}"` or `"{var=**}"`, when such a variable - * is expanded into a URL path on the client side, all characters except - * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse - * decoding, except "%2F" and "%2f" are left unchanged. - * Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - * Configuration (service config) is a configuration language for configuring - * a gRPC service to become a user-facing product. The service config is - * simply the YAML representation of the `google.api.Service` proto message. - * As an alternative to annotating your proto file, you can configure gRPC - * transcoding in your service config YAML files. You do this by specifying a - * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - * effect as the proto annotation. This can be particularly useful if you have - * a proto that is reused in multiple services. Note that any transcoding - * specified in the service config will override any matching transcoding - * configuration in the proto. Example: http: rules: # - * Selects a gRPC method and applies HttpRule to it. - selector: - * example.v1.Messaging.GetMessage get: - * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON - * conversion must follow the [proto3 - * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - * While the single segment variable follows the semantics of [RFC - * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - * Expansion, the multi segment variable **does not** follow RFC 6570 - * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - * does not expand special characters like `?` and `#`, which would lead to - * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for - * multi segment variables. The path variables **must not** refer to any - * repeated or mapped field, because client libraries are not capable of - * handling such variable expansion. The path variables **must not** capture - * the leading "/" character. The reason is that the most common use - * case "{var}" does not capture the leading "/" - * character. For consistency, all path variables must share the same - * behavior. Repeated message fields must not be mapped to URL query - * parameters, because no client library can support such complicated mapping. - * If an API needs to use a JSON array for request or response body, it can - * map the request or response body to a repeated field. However, some gRPC - * Transcoding implementations may not support this feature. + * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** - * Additional HTTP bindings for the selector. Nested bindings must not - * contain an `additional_bindings` field themselves (that is, the nesting - * may only be one level deep). + * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; /** - * The name of the request field whose value is mapped to the HTTP request - * body, or `*` for mapping all request fields not captured by the path - * pattern to the HTTP body, or omitted for not having any HTTP request - * body. NOTE: the referred field must be present at the top-level of the - * request message type. + * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ body?: string; /** - * The custom pattern is used for specifying an HTTP method that is not - * included in the `pattern` field, such as HEAD, or "*" to leave - * the HTTP method unspecified for this rule. The wild-card rule is useful - * for services that provide content to Web (HTML) clients. + * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ custom?: Schema$CustomHttpPattern; /** @@ -1266,8 +809,7 @@ export namespace servicemanagement_v1 { */ delete?: string; /** - * Maps to HTTP GET. Used for listing and getting information about - * resources. + * Maps to HTTP GET. Used for listing and getting information about resources. */ get?: string; /** @@ -1283,15 +825,11 @@ export namespace servicemanagement_v1 { */ put?: string; /** - * Optional. The name of the response field whose value is mapped to the - * HTTP response body. When omitted, the entire response message will be - * used as the HTTP response body. NOTE: The referred field must be present - * at the top-level of the response message type. + * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ responseBody?: string; /** - * Selects a method to which this rule applies. Refer to selector for - * syntax details. + * Selects a method to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -1365,88 +903,54 @@ export namespace servicemanagement_v1 { services?: Schema$ManagedService[]; } /** - * A description of a log type. Example in YAML format: - name: - * library.googleapis.com/activity_history description: The history of - * borrowing and returning library items. display_name: Activity labels: - * - key: /customer_id description: Identifier of a library customer + * A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer */ export interface Schema$LogDescriptor { /** - * A human-readable description of this log. This information appears in the - * documentation and can contain details. + * A human-readable description of this log. This information appears in the documentation and can contain details. */ description?: string; /** - * The human-readable name for this log. This information appears on the - * user interface and should be concise. + * The human-readable name for this log. This information appears on the user interface and should be concise. */ displayName?: string; /** - * The set of labels that are available to describe a specific log entry. - * Runtime requests that contain labels not specified here are considered - * invalid. + * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ labels?: Schema$LabelDescriptor[]; /** - * The name of the log. It must be less than 512 characters long and can - * include the following characters: upper- and lower-case alphanumeric - * characters [A-Za-z0-9], and punctuation characters including slash, - * underscore, hyphen, period [/_-.]. + * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ name?: string; } /** - * Logging configuration of the service. The following example shows how to - * configure logs to be sent to the producer and consumer projects. In the - * example, the `activity_history` log is sent to both the producer and - * consumer projects, whereas the `purchase_history` log is only sent to the - * producer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. logs: - name: activity_history - * labels: - key: /customer_id - name: purchase_history logging: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - - * purchase_history consumer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history + * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history */ export interface Schema$Logging { /** - * Logging configurations for sending logs to the consumer project. There - * can be multiple consumer destinations, each one must have a different - * monitored resource type. A log can be used in at most one consumer - * destination. + * Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination. */ consumerDestinations?: Schema$LoggingDestination[]; /** - * Logging configurations for sending logs to the producer project. There - * can be multiple producer destinations, each one must have a different - * monitored resource type. A log can be used in at most one producer - * destination. + * Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination. */ producerDestinations?: Schema$LoggingDestination[]; } /** - * Configuration of a specific logging destination (the producer project or - * the consumer project). + * Configuration of a specific logging destination (the producer project or the consumer project). */ export interface Schema$LoggingDestination { /** - * Names of the logs to be sent to this destination. Each name must be - * defined in the Service.logs section. If the log name is not a domain - * scoped name, it will be automatically prefixed with the service name - * followed by "/". + * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ logs?: string[]; /** - * The monitored resource type. The type must be defined in the - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ monitoredResource?: string; } /** - * The full representation of a Service that is managed by Google Service - * Management. + * The full representation of a Service that is managed by Google Service Management. */ export interface Schema$ManagedService { /** @@ -1454,8 +958,7 @@ export namespace servicemanagement_v1 { */ producerProjectId?: string; /** - * The name of the service. See the [overview](/service-management/overview) - * for naming requirements. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. */ serviceName?: string; } @@ -1493,9 +996,7 @@ export namespace servicemanagement_v1 { syntax?: string; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1503,18 +1004,11 @@ export namespace servicemanagement_v1 { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * `appengine.googleapis.com/http/server/response_latencies` metric type has - * a label for the HTTP response code, `response_code`, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; /** @@ -1522,9 +1016,7 @@ export namespace servicemanagement_v1 { */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of `metric_kind` and `value_type` might not be - * supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string; /** @@ -1532,47 +1024,15 @@ export namespace servicemanagement_v1 { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * `custom.googleapis.com` or `external.googleapis.com`. Metric types - * should use a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported - * units are a subset of [The Unified Code for Units of - * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units - * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute - * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo - * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera - * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` - * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * - * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico - * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` - * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * - * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) - * **Grammar** The grammar also includes these connectors: * `/` division - * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix - * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression - * = Component { "." Component } { "/" Component } ; - * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | - * Annotation | "1" ; Annotation - * = "{" NAME "}" ; Notes: * `Annotation` is just a - * comment if it follows a `UNIT` and is equivalent to `1` if it is used - * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == - * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not - * containing '{' or '}'. * `1` represents dimensionless - * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, - * and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of `metric_kind` and `value_type` might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ valueType?: string; } @@ -1581,9 +1041,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** @@ -1591,67 +1049,25 @@ export namespace servicemanagement_v1 { */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * Bind API methods to metrics. Binding a method to a metric causes that - * metric's configured quota behaviors to apply to the method call. + * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. */ export interface Schema$MetricRule { /** - * Metrics to update when the selected methods are called, and the - * associated cost applied to each metric. The key of the map is the metric - * name, and the values are the amount increased for the metric against - * which the quota limits are defined. The value must not be negative. + * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ metricCosts?: {[key: string]: string}; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Declares an API Interface to be included in this interface. The including - * interface must redeclare all the methods from the included interface, but - * documentation and options are inherited as follows: - If after comment and - * whitespace stripping, the documentation string of the redeclared method - * is empty, it will be inherited from the original method. - Each - * annotation belonging to the service config (http, visibility) which is - * not set in the redeclared method will be inherited. - If an http - * annotation is inherited, the path pattern will be modified as follows. - * Any version prefix will be replaced by the version of the including - * interface plus the root path if specified. Example of a simple mixin: - * package google.acl.v1; service AccessControl { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } - * package google.storage.v2; service Storage { // rpc - * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc - * GetData(GetDataRequest) returns (Data) { option - * (google.api.http).get = "/v2/{resource=**}"; } } - * Example of a mixin configuration: apis: - name: - * google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl The mixin construct implies that all methods - * in `AccessControl` are also declared with same name and request/response - * types in `Storage`. A documentation generator or annotation processor will - * see the effective `Storage.GetAcl` method after inherting documentation and - * annotations as follows: service Storage { // Get the underlying - * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... - * } Note how the version in the path pattern changed from `v1` to `v2`. If - * the `root` field in the mixin is specified, it should be a relative path - * under which inherited HTTP paths are placed. Example: apis: - - * name: google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl root: acls This implies the following - * inherited HTTP annotation: service Storage { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; - * } ... } + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } */ export interface Schema$Mixin { /** @@ -1659,149 +1075,80 @@ export namespace servicemanagement_v1 { */ name?: string; /** - * If non-empty specifies a path under which inherited HTTP paths are - * rooted. + * If non-empty specifies a path under which inherited HTTP paths are rooted. */ root?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * `"gce_instance"` and specifies the use of the labels - * `"instance_id"` and `"zone"` to identify particular VM - * instances. Different APIs can support different monitored resource types. - * APIs generally provide a `list` method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, `"Google - * Cloud SQL Database"`. + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels `"database_id"` and - * `"zone"`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` - * where {type} is the value of the `type` field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format `"monitoredResourceDescriptors/{type}"`. + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ name?: string; /** - * Required. The monitored resource type. For example, the type - * `"cloudsql_database"` represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Monitoring configuration of the service. The example below shows how to - * configure monitored resources and metrics for monitoring. In the example, a - * monitored resource and two metrics are defined. The - * `library.googleapis.com/book/returned_count` metric is sent to both - * producer and consumer projects, whereas the - * `library.googleapis.com/book/overdue_count` metric is only sent to the - * consumer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. metrics: - name: - * library.googleapis.com/book/returned_count metric_kind: DELTA - * value_type: INT64 labels: - key: /customer_id - name: - * library.googleapis.com/book/overdue_count metric_kind: GAUGE - * value_type: INT64 labels: - key: /customer_id monitoring: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count consumer_destinations: - - * monitored_resource: library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count - - * library.googleapis.com/book/overdue_count + * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count */ export interface Schema$Monitoring { /** - * Monitoring configurations for sending metrics to the consumer project. - * There can be multiple consumer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ consumerDestinations?: Schema$MonitoringDestination[]; /** - * Monitoring configurations for sending metrics to the producer project. - * There can be multiple producer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ producerDestinations?: Schema$MonitoringDestination[]; } /** - * Configuration of a specific monitoring destination (the producer project or - * the consumer project). + * Configuration of a specific monitoring destination (the producer project or the consumer project). */ export interface Schema$MonitoringDestination { /** - * Types of the metrics to report to this monitoring destination. Each type - * must be defined in Service.metrics section. + * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * OAuth scopes are a way to define data and permissions on data. For example, - * there are scopes defined for "Read-only access to Google - * Calendar" and "Access to Cloud Platform". Users can consent - * to a scope for an application, giving it permission to access that data on - * their behalf. OAuth scope specifications should be fairly coarse grained; - * a user will need to see and understand the text description of what your - * scope means. In most cases: use one or at most two OAuth scopes for an - * entire family of products. If your product has multiple APIs, you should - * probably be sharing the OAuth scope across all of those APIs. When you - * need finer grained OAuth consent screens: talk with your product management - * about how developers will use them in practice. Please note that even - * though each of the canonical scopes is enough for a request to be accepted - * and passed to the backend, a request can still fail due to the backend - * requiring additional scopes or permissions. + * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. */ export interface Schema$OAuthRequirements { /** - * The list of publicly documented OAuth scopes that are allowed access. An - * OAuth token containing any of these scopes will be accepted. Example: - * canonical_scopes: https://www.googleapis.com/auth/calendar, - * https://www.googleapis.com/auth/calendar.read + * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ canonicalScopes?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1809,26 +1156,15 @@ export namespace servicemanagement_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -1841,8 +1177,7 @@ export namespace servicemanagement_v1 { */ progressPercentage?: number; /** - * The full name of the resources that this operation is directly associated - * with. + * The full name of the resources that this operation is directly associated with. */ resourceNames?: string[]; /** @@ -1855,74 +1190,37 @@ export namespace servicemanagement_v1 { steps?: Schema$Step[]; } /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ export interface Schema$Option { /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * `"map_entry"`. For custom options, it should be the - * fully-qualified name. For example, `"google.api.http"`. + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ name?: string; /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ value?: {[key: string]: any}; } /** - * Represents a documentation page. A page can contain subpages to represent - * nested documentation set structure. + * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. */ export interface Schema$Page { /** - * The Markdown content of the page. You can use <code>&#40;== - * include {path} ==&#41;</code> to include content from a - * Markdown file. + * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ content?: string; /** - * The name of the page. It will be used as an identity of the page to - * generate URI of the page, text of the link to this page in navigation, - * etc. The full page name (start from the root page name to this page - * concatenated with `.`) can be used as reference to the page in your - * documentation. For example: <pre><code>pages: - name: - * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - * - name: Java content: &#40;== include tutorial_java.md - * ==&#41; </code></pre> You can reference `Java` page using - * Markdown reference link syntax: `Java`. + * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ name?: string; /** - * Subpages of this page. The order of subpages specified here will be - * honored in the generated docset. + * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ subpages?: Schema$Page[]; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -1930,20 +1228,11 @@ export namespace servicemanagement_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1952,29 +1241,7 @@ export namespace servicemanagement_v1 { version?: number; } /** - * Quota configuration helps to achieve fairness and budgeting in service - * usage. The metric based quota configuration works this way: - The service - * configuration defines a set of metrics. - For API calls, the - * quota.metric_rules maps methods to metrics with corresponding costs. - - * The quota.limits defines limits on the metrics, which will be used for - * quota checks at runtime. An example quota configuration in yaml format: - * quota: limits: - name: apiWriteQpsPerProject metric: - * library.googleapis.com/write_calls unit: "1/min/{project}" - * # rate limit for consumer projects values: STANDARD: 10000 - * # The metric rules bind all methods to the read_calls metric, # except - * for the UpdateBook and DeleteBook methods. These two methods # are - * mapped to the write_calls metric, with the UpdateBook method # - * consuming at twice rate as the DeleteBook method. metric_rules: - - * selector: "*" metric_costs: - * library.googleapis.com/read_calls: 1 - selector: - * google.example.library.v1.LibraryService.UpdateBook metric_costs: - * library.googleapis.com/write_calls: 2 - selector: - * google.example.library.v1.LibraryService.DeleteBook metric_costs: - * library.googleapis.com/write_calls: 1 Corresponding Metric definition: - * metrics: - name: library.googleapis.com/read_calls display_name: Read - * requests metric_kind: DELTA value_type: INT64 - name: - * library.googleapis.com/write_calls display_name: Write requests - * metric_kind: DELTA value_type: INT64 + * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 */ export interface Schema$Quota { /** @@ -1982,100 +1249,57 @@ export namespace servicemanagement_v1 { */ limits?: Schema$QuotaLimit[]; /** - * List of `MetricRule` definitions, each one mapping a selected method to - * one or more metrics. + * List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */ metricRules?: Schema$MetricRule[]; } /** - * `QuotaLimit` defines a specific limit that applies over a specified - * duration for a limit type. There can be at most one limit for a duration - * and limit type combination defined within a `QuotaGroup`. + * `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. */ export interface Schema$QuotaLimit { /** - * Default number of tokens that can be consumed during the specified - * duration. This is the number of tokens assigned when a client application - * developer activates the service for his/her project. Specifying a value - * of 0 will block all requests. This can be used if you are provisioning - * quota to selected consumers and blocking others. Similarly, a value of -1 - * will indicate an unlimited quota. No other negative values are allowed. - * Used by group-based quotas only. + * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ defaultLimit?: string; /** - * Optional. User-visible, extended description for this quota limit. Should - * be used only when more context is needed to understand this limit than - * provided by the limit's display name (see: `display_name`). + * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ description?: string; /** - * User-visible display name for this limit. Optional. If not set, the UI - * will provide a default display name based on the quota configuration. - * This field can be used to override the default display name generated - * from the configuration. + * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ displayName?: string; /** - * Duration of this limit in textual notation. Example: "100s", - * "24h", "1d". For duration longer than a day, only - * multiple of days is supported. We support only "100s" and - * "1d" for now. Additional support will be added in the future. - * "0" indicates indefinite duration. Used by group-based quotas - * only. + * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. */ duration?: string; /** - * Free tier value displayed in the Developers Console for this limit. The - * free tier is the number of tokens that will be subtracted from the billed - * amount when billing is enabled. This field can only be set on a limit - * with duration "1d", in a billable group; it is invalid on any - * other limit. If this field is not set, it defaults to 0, indicating that - * there is no free tier for this service. Used by group-based quotas only. + * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ freeTier?: string; /** - * Maximum number of tokens that can be consumed during the specified - * duration. Client application developers can override the default limit up - * to this maximum. If specified, this value cannot be set to a value less - * than the default limit. If not specified, it is set to the default limit. - * To allow clients to apply overrides with no upper bound, set this to -1, - * indicating unlimited maximum quota. Used by group-based quotas only. + * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ maxLimit?: string; /** - * The name of the metric this quota limit applies to. The quota limits with - * the same metric will be checked together during runtime. The metric must - * be defined within the service config. + * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ metric?: string; /** - * Name of the quota limit. The name must be provided, and it must be - * unique within the service. The name can only include alphanumeric - * characters as well as '-'. The maximum length of the limit name - * is 64 characters. + * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ name?: string; /** - * Specify the unit of the quota limit. It uses the same syntax as - * Metric.unit. The supported unit kinds are determined by the quota backend - * system. Here are some examples: * "1/min/{project}" for quota - * per minute per project. Note: the order of unit components is - * insignificant. The "1" at the beginning is required to follow - * the metric unit syntax. + * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ unit?: string; /** - * Tiered limit values. You must specify this as a key:value pair, with an - * integer value that is the maximum number of requests allowed for the - * specified unit. Currently only STANDARD is supported. + * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ values?: {[key: string]: string}; } /** - * A rollout resource that defines how service configuration versions are - * pushed to control plane systems. Typically, you create a new version of the - * service config, and then create a Rollout to push the service config. + * A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config. */ export interface Schema$Rollout { /** @@ -2087,18 +1311,11 @@ export namespace servicemanagement_v1 { */ createTime?: string; /** - * The strategy associated with a rollout to delete a `ManagedService`. - * Readonly. + * The strategy associated with a rollout to delete a `ManagedService`. Readonly. */ deleteServiceStrategy?: Schema$DeleteServiceStrategy; /** - * Optional unique identifier of this Rollout. Only lower case letters, - * digits and '-' are allowed. If not specified by client, the - * server will generate one. The generated id will have the form of - * <date><revision number>, where "date" is the create - * date in ISO 8601 format. "revision number" is a monotonically - * increasing positive number that is reset every day for each service. An - * example of the generated rollout_id is '2016-02-16r1' + * Optional unique identifier of this Rollout. Only lower case letters, digits and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of <date><revision number>, where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1' */ rolloutId?: string; /** @@ -2106,38 +1323,20 @@ export namespace servicemanagement_v1 { */ serviceName?: string; /** - * The status of this rollout. Readonly. In case of a failed rollout, the - * system will automatically rollback to the current Rollout version. - * Readonly. + * The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly. */ status?: string; /** - * Google Service Control selects service configurations based on traffic - * percentage. + * Google Service Control selects service configurations based on traffic percentage. */ trafficPercentStrategy?: Schema$TrafficPercentStrategy; } /** - * `Service` is the root object of Google service configuration schema. It - * describes basic information about a service, such as the name and the - * title, and delegates other aspects to sub-sections. Each sub-section is - * either a proto message or a repeated proto message that configures a - * specific aspect, such as auth. See each proto message definition for - * details. Example: type: google.api.Service config_version: 3 - * name: calendar.googleapis.com title: Google Calendar API apis: - - * name: google.calendar.v3.Calendar authentication: providers: - - * id: google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Service { /** - * A list of API interfaces exported by this service. Only the `name` field - * of the google.protobuf.Api needs to be provided by the configuration - * author, as the remaining fields will be derived from the IDL during the - * normalization process. It is an error to specify an API interface here - * which cannot be resolved against the associated IDL files. + * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; /** @@ -2153,10 +1352,7 @@ export namespace servicemanagement_v1 { */ billing?: Schema$Billing; /** - * The semantic version of the service configuration. The config version - * affects the interpretation of the service configuration. For example, - * certain features are enabled by default for certain config versions. The - * latest config version is `3`. + * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ configVersion?: number; /** @@ -2176,16 +1372,11 @@ export namespace servicemanagement_v1 { */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. If this is empty, then an endpoint - * with the same name as the service is automatically generated to service - * all defined APIs. + * Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */ endpoints?: Schema$Endpoint[]; /** - * A list of all enum types included in this API service. Enums referenced - * directly or indirectly by the `apis` are automatically included. Enums - * which are not referenced but shall be included should be listed here by - * name. Example: enums: - name: google.someapi.v1.SomeEnum + * A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum */ enums?: Schema$Enum[]; /** @@ -2197,9 +1388,7 @@ export namespace servicemanagement_v1 { */ http?: Schema$Http; /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. Must be no longer than 60 characters. + * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ id?: string; /** @@ -2215,8 +1404,7 @@ export namespace servicemanagement_v1 { */ metrics?: Schema$MetricDescriptor[]; /** - * Defines the monitored resources used by this service. This is required by - * the Service.monitoring and Service.logging configurations. + * Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */ monitoredResources?: Schema$MonitoredResourceDescriptor[]; /** @@ -2224,10 +1412,7 @@ export namespace servicemanagement_v1 { */ monitoring?: Schema$Monitoring; /** - * The service name, which is a DNS-like logical identifier for the service, - * such as `calendar.googleapis.com`. The service name typically goes - * through DNS verification to make sure the owner of the service also owns - * the DNS name. + * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ name?: string; /** @@ -2247,11 +1432,7 @@ export namespace servicemanagement_v1 { */ systemParameters?: Schema$SystemParameters; /** - * A list of all proto message types included in this API service. It serves - * similar purpose as [google.api.Service.types], except that these types - * are not needed by user-defined APIs. Therefore, they will not show up in - * the generated discovery doc. This field should only be used to define - * system APIs in ESF. + * A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. */ systemTypes?: Schema$Type[]; /** @@ -2259,11 +1440,7 @@ export namespace servicemanagement_v1 { */ title?: string; /** - * A list of all proto message types included in this API service. Types - * referenced directly or indirectly by the `apis` are automatically - * included. Messages which are not referenced but shall be included, such - * as types used by the `google.protobuf.Any` type, should be listed here by - * name. Example: types: - name: google.protobuf.Int32 + * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ types?: Schema$Type[]; /** @@ -2276,29 +1453,20 @@ export namespace servicemanagement_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } /** - * `SourceContext` represents information about the source of a protobuf - * element, like the file in which it is defined. + * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ export interface Schema$SourceContext { /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * `"google/protobuf/source_context.proto"`. + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ fileName?: string; } @@ -2312,40 +1480,7 @@ export namespace servicemanagement_v1 { sourceFiles?: Array<{[key: string]: any}>; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -2353,14 +1488,11 @@ export namespace servicemanagement_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2386,9 +1518,7 @@ export namespace servicemanagement_v1 { */ configSource?: Schema$ConfigSource; /** - * Optional. If set, this will result in the generation of a - * `google.api.Service` configuration based on the `ConfigSource` provided, - * but the generated config and the sources will NOT be persisted. + * Optional. If set, this will result in the generation of a `google.api.Service` configuration based on the `ConfigSource` provided, but the generated config and the sources will NOT be persisted. */ validateOnly?: boolean; } @@ -2402,66 +1532,41 @@ export namespace servicemanagement_v1 { serviceConfig?: Schema$Service; } /** - * Define a parameter's name and location. The parameter may be passed as - * either an HTTP header or a URL query parameter, and if both are passed the - * behavior is implementation-dependent. + * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. */ export interface Schema$SystemParameter { /** - * Define the HTTP header name to use for the parameter. It is case - * insensitive. + * Define the HTTP header name to use for the parameter. It is case insensitive. */ httpHeader?: string; /** - * Define the name of the parameter, such as "api_key" . It is - * case sensitive. + * Define the name of the parameter, such as "api_key" . It is case sensitive. */ name?: string; /** - * Define the URL query parameter name to use for the parameter. It is case - * sensitive. + * Define the URL query parameter name to use for the parameter. It is case sensitive. */ urlQueryParameter?: string; } /** - * Define a system parameter rule mapping system parameter definitions to - * methods. + * Define a system parameter rule mapping system parameter definitions to methods. */ export interface Schema$SystemParameterRule { /** - * Define parameters. Multiple names may be defined for a parameter. For a - * given method call, only one of them should be used. If multiple names are - * used the behavior is implementation-dependent. If none of the specified - * names are present the behavior is parameter-dependent. + * Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent. */ parameters?: Schema$SystemParameter[]; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; } /** - * ### System parameter configuration A system parameter is a special kind of - * parameter defined by the API system, not by an individual API. It is - * typically mapped to an HTTP header and/or a URL query parameter. This - * configuration specifies which methods change the names of the system - * parameters. + * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. */ export interface Schema$SystemParameters { /** - * Define system parameters. The parameters defined here will override the - * default parameters implemented by the system. If this field is missing - * from the service config, default system parameters will be used. Default - * system parameters and names is implementation-dependent. Example: define - * api key for all methods system_parameters rules: - - * selector: "*" parameters: - name: api_key - * url_query_parameter: api_key Example: define 2 api key names for a - * specific method. system_parameters rules: - selector: - * "/ListShelves" parameters: - name: - * api_key http_header: Api-Key1 - name: api_key - * http_header: Api-Key2 **NOTE:** All service configuration rules follow - * "last one wins" order. + * Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$SystemParameterRule[]; } @@ -2470,10 +1575,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -2482,31 +1584,16 @@ export namespace servicemanagement_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** - * Strategy that specifies how clients of Google Service Controller want to - * send traffic to use different config versions. This is generally used by - * API proxy to split traffic based on your configured precentage for each - * config version. One example of how to gradually rollout a new service - * configuration using this strategy: Day 1 Rollout { id: - * "example.googleapis.com/rollout_20160206" - * traffic_percent_strategy { percentages: { - * "example.googleapis.com/20160201": 70.00 - * "example.googleapis.com/20160206": 30.00 } } } - * Day 2 Rollout { id: - * "example.googleapis.com/rollout_20160207" - * traffic_percent_strategy: { percentages: { - * "example.googleapis.com/20160206": 100.00 } } } + * Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured precentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } } */ export interface Schema$TrafficPercentStrategy { /** - * Maps service configuration IDs to their corresponding traffic percentage. - * Key is the service configuration ID, Value is the traffic percentage - * which must be greater than 0.0 and the sum must equal to 100.0. + * Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0. */ percentages?: {[key: string]: number}; } @@ -2553,57 +1640,32 @@ export namespace servicemanagement_v1 { */ export interface Schema$Usage { /** - * The full resource name of a channel used for sending notifications to the - * service producer. Google Service Management currently only supports - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - * channel. To use Google Cloud Pub/Sub as the channel, this must be the - * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name - * format documented in https://cloud.google.com/pubsub/docs/overview. + * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ producerNotificationChannel?: string; /** - * Requirements that must be satisfied before a consumer project can use the - * service. Each requirement is of the form - * <service.name>/<requirement-id>; for example - * 'serviceusage.googleapis.com/billing-enabled'. + * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ requirements?: string[]; /** - * A list of usage rules that apply to individual API methods. **NOTE:** - * All service configuration rules follow "last one wins" order. + * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use - * this rule to configure unregistered calls for the service. Unregistered - * calls are calls that do not contain consumer project identity. (Example: - * calls that do not contain an API key). By default, API methods do not allow - * unregistered calls, and each method call must be identified by a consumer - * project identity. Use this rule to allow/disallow unregistered calls. - * Example of an API that wants to allow unregistered calls for entire - * service. usage: rules: - selector: "*" - * allow_unregistered_calls: true Example of a method that wants to allow - * unregistered calls. usage: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allow_unregistered_calls: true + * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that - * don't identify any user or application. + * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ allowUnregisteredCalls?: boolean; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; /** - * If true, the selected method should skip service control and the control - * plane features, such as quota and billing, will not be available. This - * flag is used by Google Cloud Endpoints to bypass checks for internal - * methods, such as service health check methods. + * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ skipServiceControl?: boolean; } @@ -2616,9 +1678,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias servicemanagement.operations.get * @memberOf! () * @@ -2689,8 +1749,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.operations.list - * @desc Lists service operations that match the specified filter in the - * request. + * @desc Lists service operations that match the specified filter in the request. * @alias servicemanagement.operations.list * @memberOf! () * @@ -2783,20 +1842,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A string for filtering Operations. The following filter fields are - * supported: * serviceName: Required. Only `=` operator is - * allowed. * startTime: The time this job was started, in ISO 8601 - * format. Allowed operators are `>=`, `>`, `<=`, and `<`. * - * status: Can be `done`, `in_progress`, or `failed`. Allowed operators - * are `=`, and `!=`. Filter expression supports conjunction (AND) and - * disjunction (OR) logical operators. However, the serviceName - * restriction must be at the top-level and can only be combined with - * other restrictions via the AND logical operator. Examples: * - * `serviceName={some-service}.googleapis.com` * - * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"` - * * `serviceName={some-service}.googleapis.com AND status=done` * - * `serviceName={some-service}.googleapis.com AND (status=done OR - * startTime>="2017-02-01")` + * A string for filtering Operations. The following filter fields are supported: * serviceName: Required. Only `=` operator is allowed. * startTime: The time this job was started, in ISO 8601 format. Allowed operators are `>=`, `>`, `<=`, and `<`. * status: Can be `done`, `in_progress`, or `failed`. Allowed operators are `=`, and `!=`. Filter expression supports conjunction (AND) and disjunction (OR) logical operators. However, the serviceName restriction must be at the top-level and can only be combined with other restrictions via the AND logical operator. Examples: * `serviceName={some-service}.googleapis.com` * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"` * `serviceName={some-service}.googleapis.com AND status=done` * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")` */ filter?: string; /** @@ -2804,8 +1850,7 @@ export namespace servicemanagement_v1 { */ name?: string; /** - * The maximum number of operations to return. If unspecified, defaults - * to 50. The maximum value is 100. + * The maximum number of operations to return. If unspecified, defaults to 50. The maximum value is 100. */ pageSize?: number; /** @@ -2828,8 +1873,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.create - * @desc Creates a new managed service. Please note one producer project can - * own no more than 20 services. Operation + * @desc Creates a new managed service. Please note one producer project can own no more than 20 services. Operation * @alias servicemanagement.services.create * @memberOf! () * @@ -2900,11 +1944,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.delete - * @desc Deletes a managed service. This method will change the service to - * the `Soft-Delete` state for 30 days. Within this period, service - * producers may call UndeleteService to restore the service. After 30 days, - * the service will be permanently deleted. Operation + * @desc Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation * @alias servicemanagement.services.delete * @memberOf! () * @@ -2978,10 +2018,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.disable - * @desc Disables a service for a project, so it can no longer be be used - * for the project. It prevents accidental usage that may cause unexpected - * billing charges or security leaks. Operation + * @desc Disables a service for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks. Operation * @alias servicemanagement.services.disable * @memberOf! () * @@ -3056,9 +2093,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.enable - * @desc Enables a service for a project, so it can be used for the project. - * See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for - * more information. Operation + * @desc Enables a service for a project, so it can be used for the project. See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for more information. Operation * @alias servicemanagement.services.enable * @memberOf! () * @@ -3133,16 +2168,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.generateConfigReport - * @desc Generates and returns a report (errors, warnings and changes from - * existing configurations) associated with - * GenerateConfigReportRequest.new_value If - * GenerateConfigReportRequest.old_value is specified, - * GenerateConfigReportRequest will contain a single ChangeReport based on - * the comparison between GenerateConfigReportRequest.new_value and - * GenerateConfigReportRequest.old_value. If - * GenerateConfigReportRequest.old_value is not specified, this method will - * compare GenerateConfigReportRequest.new_value with the last pushed - * service configuration. + * @desc Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration. * @alias servicemanagement.services.generateConfigReport * @memberOf! () * @@ -3226,8 +2252,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.get - * @desc Gets a managed service. Authentication is required unless the - * service is public. + * @desc Gets a managed service. Authentication is required unless the service is public. * @alias servicemanagement.services.get * @memberOf! () * @@ -3376,8 +2401,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias servicemanagement.services.getIamPolicy * @memberOf! () * @@ -3451,12 +2475,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.list - * @desc Lists managed services. Returns all public services. For - * authenticated users, also returns all services the calling user has - * "servicemanagement.services.get" permission for. **BETA:** If the caller - * specifies the `consumer_id`, it returns only the services enabled on the - * consumer. The `consumer_id` must have the format of - * "project:{PROJECT-ID}". + * @desc Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. **BETA:** If the caller specifies the `consumer_id`, it returns only the services enabled on the consumer. The `consumer_id` must have the format of "project:{PROJECT-ID}". * @alias servicemanagement.services.list * @memberOf! () * @@ -3532,8 +2551,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias servicemanagement.services.setIamPolicy * @memberOf! () * @@ -3607,11 +2625,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias servicemanagement.services.testIamPermissions * @memberOf! () * @@ -3694,10 +2708,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.undelete - * @desc Revives a previously deleted managed service. The method restores - * the service using the configuration at the time the service was deleted. - * The target service must exist and must have been deleted within the last - * 30 days. Operation + * @desc Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days. Operation * @alias servicemanagement.services.undelete * @memberOf! () * @@ -3789,9 +2800,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -3802,8 +2811,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the service to disable. Specifying an unknown service name will - * cause the request to fail. + * Name of the service to disable. Specifying an unknown service name will cause the request to fail. */ serviceName?: string; @@ -3819,8 +2827,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the service to enable. Specifying an unknown service name will - * cause the request to fail. + * Name of the service to enable. Specifying an unknown service name will cause the request to fail. */ serviceName?: string; @@ -3848,8 +2855,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the `ServiceManager` overview for naming - * requirements. For example: `example.googleapis.com`. + * The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -3861,19 +2867,15 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the service configuration resource. This field must be - * specified for the server to return all fields, including `SourceInfo`. + * The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. */ configId?: string; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; /** - * Specifies which parts of the Service Config should be returned in the - * response. + * Specifies which parts of the Service Config should be returned in the response. */ view?: string; } @@ -3885,8 +2887,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3902,19 +2903,15 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Include services consumed by the specified consumer. The Google Service - * Management implementation accepts the following forms: - - * project: + * Include services consumed by the specified consumer. The Google Service Management implementation accepts the following forms: - project: */ consumerId?: string; /** - * The max number of items to include in the response list. Page size is 50 - * if not specified. Maximum value is 100. + * The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100. */ pageSize?: number; /** - * Token identifying which result to start with; returned by a previous list - * call. + * Token identifying which result to start with; returned by a previous list call. */ pageToken?: string; /** @@ -3930,8 +2927,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3948,8 +2944,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -3966,8 +2961,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the [overview](/service-management/overview) - * for naming requirements. For example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -3980,12 +2974,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.configs.create - * @desc Creates a new service configuration (version) for a managed - * service. This method only stores the service configuration. To roll out - * the service configuration to backend systems please call - * CreateServiceRollout. Only the 100 most recent service configurations - * and ones referenced by existing rollouts are kept for each service. The - * rest will be deleted eventually. + * @desc Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually. * @alias servicemanagement.services.configs.create * @memberOf! () * @@ -4133,8 +3122,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.configs.list - * @desc Lists the history of the service configuration for a managed - * service, from the newest to the oldest. + * @desc Lists the history of the service configuration for a managed service, from the newest to the oldest. * @alias servicemanagement.services.configs.list * @memberOf! () * @@ -4218,14 +3206,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.configs.submit - * @desc Creates a new service configuration (version) for a managed service - * based on user-supplied configuration source files (for example: OpenAPI - * Specification). This method stores the source configurations as well as - * the generated service configuration. To rollout the service configuration - * to other services, please call CreateServiceRollout. Only the 100 most - * recent configuration sources and ones referenced by existing service - * configurtions are kept for each service. The rest will be deleted - * eventually. Operation + * @desc Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout. Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually. Operation * @alias servicemanagement.services.configs.submit * @memberOf! () * @@ -4307,9 +3288,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; @@ -4326,19 +3305,15 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the service configuration resource. This field must be - * specified for the server to return all fields, including `SourceInfo`. + * The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. */ configId?: string; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; /** - * Specifies which parts of the Service Config should be returned in the - * response. + * Specifies which parts of the Service Config should be returned in the response. */ view?: string; } @@ -4350,8 +3325,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The max number of items to include in the response list. Page size is 50 - * if not specified. Maximum value is 100. + * The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100. */ pageSize?: number; /** @@ -4359,9 +3333,7 @@ export namespace servicemanagement_v1 { */ pageToken?: string; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -4373,9 +3345,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; @@ -4393,8 +3363,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.consumers.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias servicemanagement.services.consumers.getIamPolicy * @memberOf! () * @@ -4468,8 +3437,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.consumers.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias servicemanagement.services.consumers.setIamPolicy * @memberOf! () * @@ -4543,11 +3511,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.consumers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias servicemanagement.services.consumers.testIamPermissions * @memberOf! () * @@ -4637,8 +3601,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4655,8 +3618,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4673,8 +3635,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -4692,16 +3653,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.rollouts.create - * @desc Creates a new service configuration rollout. Based on rollout, the - * Google Service Management will roll out the service configurations to - * different backend services. For example, the logging configuration will - * be pushed to Google Cloud Logging. Please note that any previous pending - * and running Rollouts and associated Operations will be automatically - * cancelled so that the latest Rollout will not be blocked by previous - * Rollouts. Only the 100 most recent (in any state) and the last 10 - * successful (if not already part of the set of 100 most recent) rollouts - * are kept for each service. The rest will be deleted eventually. - * Operation + * @desc Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation * @alias servicemanagement.services.rollouts.create * @memberOf! () * @@ -4850,8 +3802,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.rollouts.list - * @desc Lists the history of the service configuration rollouts for a - * managed service, from the newest to the oldest. + * @desc Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest. * @alias servicemanagement.services.rollouts.list * @memberOf! () * @@ -4943,9 +3894,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; @@ -4966,9 +3915,7 @@ export namespace servicemanagement_v1 { */ rolloutId?: string; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -4980,17 +3927,11 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Use `filter` to return subset of rollouts. The following filters are - * supported: -- To limit the results to only those in - * [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use - * filter='status=SUCCESS' -- To limit the results to those in - * [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or - * 'FAILED', use filter='status=CANCELLED OR status=FAILED' + * Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED' */ filter?: string; /** - * The max number of items to include in the response list. Page size is 50 - * if not specified. Maximum value is 100. + * The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100. */ pageSize?: number; /** @@ -4998,9 +3939,7 @@ export namespace servicemanagement_v1 { */ pageToken?: string; /** - * The name of the service. See the - * [overview](/service-management/overview) for naming requirements. For - * example: `example.googleapis.com`. + * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } diff --git a/src/apis/servicenetworking/package.json b/src/apis/servicenetworking/package.json index c8581be3346..2ace162d0ac 100644 --- a/src/apis/servicenetworking/package.json +++ b/src/apis/servicenetworking/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 2e1de7699ee..1c46de00a89 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace servicenetworking_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace servicenetworking_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace servicenetworking_v1 { /** * Service Networking API * - * Provides automatic management of network configurations necessary for - * certain services. + * Provides automatic management of network configurations necessary for certain services. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace servicenetworking_v1 { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.services = new Resource$Services(this.context); @@ -126,20 +124,11 @@ export namespace servicenetworking_v1 { */ export interface Schema$AddSubnetworkRequest { /** - * Required. A resource that represents the service consumer, such as - * `projects/123456`. The project number can be different from the value in - * the consumer network parameter. For example, the network might be part of - * a Shared VPC network. In those cases, Service Networking validates that - * this resource belongs to that Shared VPC. + * Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC. */ consumer?: string; /** - * Required. The name of the service consumer's VPC network. The network - * must have an existing private connection that was provisioned through the - * connections.create method. The name must be in the following format: - * `projects/{project}/global/networks/{network}`, where {project} is a - * project number, such as `12345`. {network} is the name of a VPC network - * in the project. + * Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project. */ consumerNetwork?: string; /** @@ -147,47 +136,28 @@ export namespace servicenetworking_v1 { */ description?: string; /** - * Required. The prefix length of the subnet's IP address range. Use - * CIDR range notation, such as `30` to provision a subnet with an - * `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of - * available ranges in the service consumer's allocated range. + * Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. */ ipPrefixLength?: number; /** - * Required. The name of a [region](/compute/docs/regions-zones) for the - * subnet, such `europe-west1`. + * Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe-west1`. */ region?: string; /** - * Optional. The starting address of a range. The address must be a valid - * IPv4 address in the x.x.x.x format. This value combined with the IP - * prefix range is the CIDR range for the subnet. The range must be within - * the allocated range that is assigned to the private connection. If the - * CIDR range isn't available, the call fails. + * Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails. */ requestedAddress?: string; /** - * Required. A name for the new subnet. For information about the naming - * requirements, see - * [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute - * API documentation. + * Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation. */ subnetwork?: string; /** - * A list of members that are granted the `compute.networkUser` role on the - * subnet. + * A list of members that are granted the `compute.networkUser` role on the subnet. */ subnetworkUsers?: string[]; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also - * described as "protocol buffer services" in some contexts, such as - * by the "service" keyword in a .proto file, but they are different - * from API Services, which represent a concrete implementation of an - * interface as opposed to simply a description of methods and bindings. They - * are also sometimes simply referred to as "APIs" in other - * contexts, such as the name of this message itself. See - * https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ export interface Schema$Api { /** @@ -199,8 +169,7 @@ export namespace servicenetworking_v1 { */ mixins?: Schema$Mixin[]; /** - * The fully qualified name of this interface, including package name - * followed by the interface's simple name. + * The fully qualified name of this interface, including package name followed by the interface's simple name. */ name?: string; /** @@ -208,8 +177,7 @@ export namespace servicenetworking_v1 { */ options?: Schema$Option[]; /** - * Source context for the protocol buffer service represented by this - * message. + * Source context for the protocol buffer service represented by this message. */ sourceContext?: Schema$SourceContext; /** @@ -217,32 +185,12 @@ export namespace servicenetworking_v1 { */ syntax?: string; /** - * A version string for this interface. If specified, must have the form - * `major-version.minor-version`, as in `1.10`. If the minor version is - * omitted, it defaults to zero. If the entire version field is empty, the - * major version is derived from the package name, as outlined below. If the - * field is not empty, the version in the package name will be verified to - * be consistent with what is provided here. The versioning schema uses - * [semantic versioning](http://semver.org) where the major version number - * indicates a breaking change and the minor version an additive, - * non-breaking change. Both version numbers are signals to users what to - * expect from different versions, and should be carefully chosen based on - * the product plan. The major version is also reflected in the package - * name of the interface, which must end in `v<major-version>`, as in - * `google.feature.v1`. For major versions 0 and 1, the suffix can be - * omitted. Zero major versions must only be used for experimental, non-GA - * interfaces. + * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ version?: string; } /** - * `Authentication` defines the authentication configuration for an API. - * Example for an API targeted for external use: name: - * calendar.googleapis.com authentication: providers: - id: - * google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Authentication { /** @@ -250,18 +198,12 @@ export namespace servicenetworking_v1 { */ providers?: Schema$AuthProvider[]; /** - * A list of authentication rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$AuthenticationRule[]; } /** - * Authentication rules for the service. By default, if a method has any - * authentication requirements, every request must include a valid credential - * matching one of the requirements. It's an error to include more than - * one kind of credential in a single request. If a method doesn't have - * any auth requirements, request credentials will be ignored. + * Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored. */ export interface Schema$AuthenticationRule { /** @@ -277,96 +219,45 @@ export namespace servicenetworking_v1 { */ requirements?: Schema$AuthRequirement[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Configuration of authorization. This section determines the authorization - * provider, if unspecified, then no authorization check will be done. - * Example: experimental: authorization: provider: - * firebaserules.googleapis.com - */ - export interface Schema$AuthorizationConfig { - /** - * The name of the authorization provider, such as - * firebaserules.googleapis.com. - */ - provider?: string; - } - /** - * Configuration for an authentication provider, including support for [JSON - * Web Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthProvider { /** - * The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * Redirect URL if JWT token is required but not present or is expired. - * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ authorizationUrl?: string; /** - * The unique identifier of the auth provider. It will be referred to by - * `AuthRequirement.provider_id`. Example: "bookstore_auth". + * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ id?: string; /** - * Identifies the principal that issued the JWT. See - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - * Usually a URL or an email address. Example: - * https://securetoken.google.com Example: - * 1234567-compute@developer.gserviceaccount.com + * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ issuer?: string; /** - * URL of the provider's public key set to validate signature of the - * JWT. See [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - * Optional if the key set document: - can be retrieved from [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: - * https://www.googleapis.com/oauth2/v1/certs + * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string; } /** - * User-defined authentication requirements, including support for [JSON Web - * Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthRequirement { /** - * NOTE: This will be deprecated soon, once AuthProvider.audiences is - * implemented and accepted in all the runtime components. The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * id from authentication provider. Example: provider_id: - * bookstore_auth + * id from authentication provider. Example: provider_id: bookstore_auth */ providerId?: string; } @@ -375,9 +266,7 @@ export namespace servicenetworking_v1 { */ export interface Schema$Backend { /** - * A list of API backend rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$BackendRule[]; } @@ -390,9 +279,7 @@ export namespace servicenetworking_v1 { */ address?: string; /** - * The number of seconds to wait for a response from a request. The default - * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 - * seconds. + * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ deadline?: number; /** @@ -400,56 +287,38 @@ export namespace servicenetworking_v1 { */ jwtAudience?: string; /** - * Minimum deadline in seconds needed for this method. Calls having deadline - * value lower than this will be rejected. + * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ minDeadline?: number; /** - * The number of seconds to wait for the completion of a long running - * operation. The default is no deadline. + * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ operationDeadline?: number; pathTranslation?: string; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Billing related configuration of the service. The following example shows - * how to configure monitored resources and metrics for billing: - * monitored_resources: - type: library.googleapis.com/branch labels: - - * key: /city description: The city where the library branch is - * located in. - key: /name description: The name of the branch. - * metrics: - name: library.googleapis.com/book/borrowed_count - * metric_kind: DELTA value_type: INT64 billing: - * consumer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/borrowed_count + * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** - * Billing configurations for sending metrics to the consumer project. There - * can be multiple consumer destinations per service, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. + * Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. */ consumerDestinations?: Schema$BillingDestination[]; } /** - * Configuration of a specific billing destination (Currently only support - * bill against consumer project). + * Configuration of a specific billing destination (Currently only support bill against consumer project). */ export interface Schema$BillingDestination { /** - * Names of the metrics to report to this billing destination. Each name - * must be defined in Service.metrics section. + * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } @@ -458,80 +327,45 @@ export namespace servicenetworking_v1 { */ export interface Schema$CancelOperationRequest {} /** - * Represents a private connection resource. A private connection is - * implemented as a VPC Network Peering connection between a service - * producer's VPC network and a service consumer's VPC network. + * Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network. */ export interface Schema$Connection { /** - * The name of service consumer's VPC network that's connected with - * service producer network, in the following format: - * `projects/{project}/global/networks/{network}`. `{project}` is a project - * number, such as in `12345` that includes the VPC service consumer's - * VPC network. `{network}` is the name of the service consumer's VPC - * network. + * The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network}` is the name of the service consumer's VPC network. */ network?: string; /** - * Output only. The name of the VPC Network Peering connection that was - * created by the service producer. + * Output only. The name of the VPC Network Peering connection that was created by the service producer. */ peering?: string; /** - * The name of one or more allocated IP address ranges for this service - * producer of type `PEERING`. Note that invoking CreateConnection method - * with a different range when connection is already established will not - * modify already provisioned service producer subnetworks. If - * CreateConnection method is invoked repeatedly to reconnect when peering - * connection had been disconnected on the consumer side, leaving this field - * empty will restore previously allocated IP ranges. + * The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking CreateConnection method with a different range when connection is already established will not modify already provisioned service producer subnetworks. If CreateConnection method is invoked repeatedly to reconnect when peering connection had been disconnected on the consumer side, leaving this field empty will restore previously allocated IP ranges. */ reservedPeeringRanges?: string[]; /** - * Output only. The name of the peering service that's associated with - * this connection, in the following format: `services/{service name}`. + * Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`. */ service?: string; } /** - * `Context` defines which contexts an API requests. Example: context: - * rules: - selector: "*" requested: - - * google.rpc.context.ProjectContext - - * google.rpc.context.OriginContext The above specifies that all methods in - * the API request `google.rpc.context.ProjectContext` and - * `google.rpc.context.OriginContext`. Available context types are defined in - * package `google.rpc.context`. This also provides mechanism to whitelist - * any protobuf message extension that can be sent in grpc metadata using - * “x-goog-ext-<extension_id>-bin” and - * “x-goog-ext-<extension_id>-jspb” format. For example, list any - * service specific protobuf types that can appear in grpc metadata as follows - * in your yaml file: Example: context: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allowed_request_extensions: - google.foo.v1.NewExtension - * allowed_response_extensions: - google.foo.v1.NewExtension You can - * also specify extension ID instead of fully qualified extension name here. + * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ export interface Schema$Context { /** - * A list of RPC context rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$ContextRule[]; } /** - * A context rule provides information about the context for an individual API - * element. + * A context rule provides information about the context for an individual API element. */ export interface Schema$ContextRule { /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from client to backend. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ allowedRequestExtensions?: string[]; /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from backend to client. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ allowedResponseExtensions?: string[]; /** @@ -543,39 +377,29 @@ export namespace servicenetworking_v1 { */ requested?: string[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Selects and configures the service controller used by the service. The - * service controller handles features like abuse, quota, billing, logging, - * monitoring, etc. + * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. */ export interface Schema$Control { /** - * The service control environment to use. If empty, no control plane - * feature (like quota and billing) will be enabled. + * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ environment?: string; } /** - * Customize service error responses. For example, list any service specific - * protobuf types that can appear in error detail lists of error responses. - * Example: custom_error: types: - google.foo.v1.CustomError - * - google.foo.v1.AnotherError + * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError */ export interface Schema$CustomError { /** - * The list of custom error rules that apply to individual API messages. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$CustomErrorRule[]; /** - * The list of custom error detail types, e.g. - * 'google.foo.v1.CustomError'. + * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ types?: string[]; } @@ -584,13 +408,11 @@ export namespace servicenetworking_v1 { */ export interface Schema$CustomErrorRule { /** - * Mark this message as possible payload in error response. Otherwise, - * objects of this type will be filtered when they appear in error payload. + * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ isErrorType?: boolean; /** - * Selects messages to which this rule applies. Refer to selector for - * syntax details. + * Selects messages to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -608,42 +430,7 @@ export namespace servicenetworking_v1 { path?: string; } /** - * `Documentation` provides the information for describing a service. Example: - * <pre><code>documentation: summary: > The Google - * Calendar API gives access to most calendar features. pages: - name: - * Overview content: &#40;== include google/foo/overview.md - * ==&#41; - name: Tutorial content: &#40;== include - * google/foo/tutorial.md ==&#41; subpages; - name: Java content: - * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - - * selector: google.calendar.Calendar.Get description: > ... - - * selector: google.calendar.Calendar.Put description: > ... - * </code></pre> Documentation is provided in markdown syntax. In - * addition to standard markdown features, definition lists, tables and fenced - * code blocks are supported. Section headers can be provided and are - * interpreted relative to the section nesting of the context where a - * documentation fragment is embedded. Documentation from the IDL is merged - * with documentation defined via the config at normalization time, where - * documentation provided by config rules overrides IDL provided. A number of - * constructs specific to the API platform are supported in documentation - * text. In order to reference a proto element, the following notation can be - * used: - * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> - * To override the display text used for the link, this can be used: - * <pre><code>&#91;display - * text]&#91;fully.qualified.proto.name]</code></pre> Text can - * be excluded from doc using the following notation: - * <pre><code>&#40;-- internal comment - * --&#41;</code></pre> A few directives are available in - * documentation. Note that directives must appear on a single line to be - * properly identified. The `include` directive includes a markdown file from - * an external source: <pre><code>&#40;== include path/to/file - * ==&#41;</code></pre> The `resource_for` directive marks a - * message to be the resource of a collection in REST view. If it is not - * specified, tools attempt to infer the resource from the operations in a - * collection: <pre><code>&#40;== resource_for - * v1.shelves.books ==&#41;</code></pre> The directive - * `suppress_warning` does not directly affect documentation and is documented - * together with service config validation. + * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -651,14 +438,7 @@ export namespace servicenetworking_v1 { */ documentationRootUrl?: string; /** - * Declares a single overview page. For example: - * <pre><code>documentation: summary: ... overview: - * &#40;== include overview.md ==&#41; </code></pre> - * This is a shortcut for the following declaration (using pages style): - * <pre><code>documentation: summary: ... pages: - name: - * Overview content: &#40;== include overview.md ==&#41; - * </code></pre> Note: you cannot specify both `overview` field - * and `pages` field. + * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ overview?: string; /** @@ -666,14 +446,11 @@ export namespace servicenetworking_v1 { */ pages?: Schema$Page[]; /** - * A list of documentation rules that apply to individual API elements. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; /** - * A short summary of what the service does. Can only be provided by plain - * text. + * A short summary of what the service does. Can only be provided by plain text. */ summary?: string; } @@ -682,8 +459,7 @@ export namespace servicenetworking_v1 { */ export interface Schema$DocumentationRule { /** - * Deprecation description of the selected element(s). It can be provided if - * an element is marked as `deprecated`. + * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ deprecationDescription?: string; /** @@ -691,50 +467,24 @@ export namespace servicenetworking_v1 { */ description?: string; /** - * The selector is a comma-separated list of patterns. Each pattern is a - * qualified name of the element which may end in "*", indicating - * a wildcard. Wildcards are only allowed at the end and for a whole - * component of the qualified name, i.e. "foo.*" is ok, but not - * "foo.b*" or "foo.*.bar". A wildcard will match one or - * more components. To specify a default for all applicable elements, the - * whole pattern "*" is used. + * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ selector?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * `Endpoint` describes a network endpoint that serves a set of APIs. A - * service may expose any number of endpoints, and all endpoints share the - * same service configuration, such as quota configuration and monitoring - * configuration. Example service configuration: name: - * library-example.googleapis.com endpoints: # Below entry makes - * 'google.example.library.v1.Library' # API be served from - * endpoint address library-example.googleapis.com. # It also allows - * HTTP OPTIONS calls to be passed to the backend, for # it to decide - * whether the subsequent cross-origin request is # allowed to proceed. - * - name: library-example.googleapis.com allow_cors: true + * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ export interface Schema$Endpoint { /** - * DEPRECATED: This field is no longer supported. Instead of using aliases, - * please specify multiple google.api.Endpoint for each of the intended - * aliases. Additional names that this endpoint will be hosted on. + * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ aliases?: string[]; /** - * Allowing - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - * cross-domain traffic, would allow the backends served from this endpoint - * to receive and respond to HTTP OPTIONS requests. The response will be - * used by the browser to determine whether the subsequent cross-origin - * request is allowed to proceed. + * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ allowCors?: boolean; /** @@ -746,11 +496,7 @@ export namespace servicenetworking_v1 { */ name?: string; /** - * The specification of an Internet routable address of API frontend that - * will handle requests to this [API - * Endpoint](https://cloud.google.com/apis/design/glossary). It should be - * either a valid IPv4 address or a fully-qualified domain name. For - * example, "8.8.8.8" or "myservice.appspot.com". + * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ target?: string; } @@ -796,16 +542,6 @@ export namespace servicenetworking_v1 { */ options?: Schema$Option[]; } - /** - * Experimental service configuration. These configuration options can only be - * used by whitelisted users. - */ - export interface Schema$Experimental { - /** - * Authorization configuration. - */ - authorization?: Schema$AuthorizationConfig; - } /** * A single field of a message type. */ @@ -835,9 +571,7 @@ export namespace servicenetworking_v1 { */ number?: number; /** - * The index of the field type in `Type.oneofs`, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. + * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ oneofIndex?: number; /** @@ -849,14 +583,12 @@ export namespace servicenetworking_v1 { */ packed?: boolean; /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ typeUrl?: string; } /** - * Represents a subnet that was created or discovered by a private access - * management service. + * Represents a subnet that was created or discovered by a private access management service. */ export interface Schema$GoogleCloudServicenetworkingV1betaSubnetwork { /** @@ -868,210 +600,41 @@ export namespace servicenetworking_v1 { */ name?: string; /** - * In the Shared VPC host project, the VPC network that's peered with - * the consumer network. For example: - * `projects/1234321/global/networks/host-network` + * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ network?: string; /** - * This is a discovered subnet that is not within the current consumer - * allocated ranges. + * This is a discovered subnet that is not within the current consumer allocated ranges. */ outsideAllocation?: boolean; } /** - * Defines the HTTP configuration for an API service. It contains a list of - * HttpRule, each specifying the mapping of an RPC method to one or more HTTP - * REST API methods. + * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. */ export interface Schema$Http { /** - * When set to true, URL path parameters will be fully URI-decoded except in - * cases of single segment matches in reserved expansion, where - * "%2F" will be left encoded. The default behavior is to not - * decode RFC 6570 reserved characters in multi segment matches. + * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ fullyDecodeReservedExpansion?: boolean; /** - * A list of HTTP configuration rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$HttpRule[]; } /** - * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - * gRPC method and one or more HTTP REST endpoints. It allows developers to - * build a single API service that supports both gRPC APIs and REST APIs. Many - * systems, including [Google APIs](https://github.com/googleapis/googleapis), - * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and - * use it for large scale production services. `HttpRule` defines the schema - * of the gRPC/REST mapping. The mapping specifies how different portions of - * the gRPC request message are mapped to the URL path, URL query parameters, - * and HTTP request body. It also controls how the gRPC response message is - * mapped to the HTTP response body. `HttpRule` is typically specified as an - * `google.api.http` annotation on the gRPC method. Each mapping specifies a - * URL path template and an HTTP method. The path template may refer to one or - * more fields in the gRPC request message, as long as each field is a - * non-repeated field with a primitive (non-message) type. The path template - * controls how fields of the request message are mapped to the URL path. - * Example: service Messaging { rpc GetMessage(GetMessageRequest) - * returns (Message) { option (google.api.http) = { get: - * "/v1/{name=messages/*}" }; } } message - * GetMessageRequest { string name = 1; // Mapped to URL path. } - * message Message { string text = 1; // The resource content. } - * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC - * -----|----- `GET /v1/messages/123456` | `GetMessage(name: - * "messages/123456")` Any fields in the request message which are - * not bound by the path template automatically become HTTP query parameters - * if there is no HTTP request body. For example: service Messaging { rpc - * GetMessage(GetMessageRequest) returns (Message) { option - * (google.api.http) = { get:"/v1/messages/{message_id}" - * }; } } message GetMessageRequest { message SubMessage { - * string subfield = 1; } string message_id = 1; // Mapped to URL - * path. int64 revision = 2; // Mapped to URL query parameter - * `revision`. SubMessage sub = 3; // Mapped to URL query parameter - * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - * HTTP | gRPC -----|----- `GET - * /v1/messages/123456?revision=2&sub.subfield=foo` | - * `GetMessage(message_id: "123456" revision: 2 sub: - * SubMessage(subfield: "foo"))` Note that fields which are mapped - * to URL query parameters must have a primitive type or a repeated primitive - * type or a non-repeated message type. In the case of a repeated type, the - * parameter can be repeated in the URL as `...?param=A&param=B`. In the - * case of a message type, each field of the message is mapped to a separate - * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods - * that allow a request body, the `body` field specifies the mapping. Consider - * a REST update method on the message resource collection: service - * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) - * { option (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "message" - * }; } } message UpdateMessageRequest { string message_id - * = 1; // mapped to the URL Message message = 2; // mapped to the - * body } The following HTTP JSON to RPC mapping is enabled, where the - * representation of the JSON in the request body is determined by protos JSON - * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { - * "text": "Hi!" }` | `UpdateMessage(message_id: - * "123456" message { text: "Hi!" })` The special name - * `*` can be used in the body mapping to define that every field not bound by - * the path template should be mapped to the request body. This enables the - * following alternative definition of the update method: service - * Messaging { rpc UpdateMessage(Message) returns (Message) { option - * (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "*" }; } } - * message Message { string message_id = 1; string text = 2; } - * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- - * `PATCH /v1/messages/123456 { "text": "Hi!" }` | - * `UpdateMessage(message_id: "123456" text: "Hi!")` Note - * that when using `*` in the body mapping, it is not possible to have HTTP - * parameters, as all fields not bound by the path end in the body. This makes - * this option more rarely used in practice when defining REST APIs. The - * common usage of `*` is in custom methods which don't use the URL at all - * for transferring data. It is possible to define multiple HTTP methods for - * one RPC by using the `additional_bindings` option. Example: service - * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { - * option (google.api.http) = { get: - * "/v1/messages/{message_id}" additional_bindings { get: - * "/v1/users/{user_id}/messages/{message_id}" } }; } } - * message GetMessageRequest { string message_id = 1; string - * user_id = 2; } This enables the following two alternative HTTP JSON to - * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - * `GetMessage(message_id: "123456")` `GET - * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" - * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf - * request fields (recursive expansion nested messages in the request message) - * are classified into three categories: - Fields referred by the path - * template. They are passed via the URL path. - Fields referred by the - * HttpRule.body. They are passed via the HTTP request body. - All - * other fields are passed via the URL query parameters, and the parameter - * name is the field path in the request message. A repeated field can be - * represented as multiple query parameters under the same name. 2. If - * HttpRule.body is "*", there is no URL query parameter, all fields - * are passed via URL path and HTTP request body. 3. If HttpRule.body is - * omitted, there is no HTTP request body, all fields are passed via URL - * path and URL query parameters. ### Path template syntax Template = - * "/" Segments [ Verb ] ; Segments = Segment { "/" - * Segment } ; Segment = "*" | "**" | LITERAL | - * Variable ; Variable = "{" FieldPath [ "=" Segments - * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb - * = ":" LITERAL ; The syntax `*` matches a single URL path - * segment. The syntax `**` matches zero or more URL path segments, which must - * be the last part of the URL path except the `Verb`. The syntax `Variable` - * matches part of the URL path as specified by its template. A variable - * template must not contain other variables. If a variable matches a single - * path segment, its template may be omitted, e.g. `{var}` is equivalent to - * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If - * the `LITERAL` contains any reserved character, such characters should be - * percent-encoded before the matching. If a variable contains exactly one - * path segment, such as `"{var}"` or `"{var=*}"`, when - * such a variable is expanded into a URL path on the client side, all - * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - * does the reverse decoding. Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{var}`. If a variable contains multiple path segments, such as - * `"{var=foo/*}"` or `"{var=**}"`, when such a variable - * is expanded into a URL path on the client side, all characters except - * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse - * decoding, except "%2F" and "%2f" are left unchanged. - * Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - * Configuration (service config) is a configuration language for configuring - * a gRPC service to become a user-facing product. The service config is - * simply the YAML representation of the `google.api.Service` proto message. - * As an alternative to annotating your proto file, you can configure gRPC - * transcoding in your service config YAML files. You do this by specifying a - * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - * effect as the proto annotation. This can be particularly useful if you have - * a proto that is reused in multiple services. Note that any transcoding - * specified in the service config will override any matching transcoding - * configuration in the proto. Example: http: rules: # - * Selects a gRPC method and applies HttpRule to it. - selector: - * example.v1.Messaging.GetMessage get: - * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON - * conversion must follow the [proto3 - * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - * While the single segment variable follows the semantics of [RFC - * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - * Expansion, the multi segment variable **does not** follow RFC 6570 - * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - * does not expand special characters like `?` and `#`, which would lead to - * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for - * multi segment variables. The path variables **must not** refer to any - * repeated or mapped field, because client libraries are not capable of - * handling such variable expansion. The path variables **must not** capture - * the leading "/" character. The reason is that the most common use - * case "{var}" does not capture the leading "/" - * character. For consistency, all path variables must share the same - * behavior. Repeated message fields must not be mapped to URL query - * parameters, because no client library can support such complicated mapping. - * If an API needs to use a JSON array for request or response body, it can - * map the request or response body to a repeated field. However, some gRPC - * Transcoding implementations may not support this feature. + * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** - * Additional HTTP bindings for the selector. Nested bindings must not - * contain an `additional_bindings` field themselves (that is, the nesting - * may only be one level deep). + * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; /** - * The name of the request field whose value is mapped to the HTTP request - * body, or `*` for mapping all request fields not captured by the path - * pattern to the HTTP body, or omitted for not having any HTTP request - * body. NOTE: the referred field must be present at the top-level of the - * request message type. + * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ body?: string; /** - * The custom pattern is used for specifying an HTTP method that is not - * included in the `pattern` field, such as HEAD, or "*" to leave - * the HTTP method unspecified for this rule. The wild-card rule is useful - * for services that provide content to Web (HTML) clients. + * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ custom?: Schema$CustomHttpPattern; /** @@ -1079,8 +642,7 @@ export namespace servicenetworking_v1 { */ delete?: string; /** - * Maps to HTTP GET. Used for listing and getting information about - * resources. + * Maps to HTTP GET. Used for listing and getting information about resources. */ get?: string; /** @@ -1096,15 +658,11 @@ export namespace servicenetworking_v1 { */ put?: string; /** - * Optional. The name of the response field whose value is mapped to the - * HTTP response body. When omitted, the entire response message will be - * used as the HTTP response body. NOTE: The referred field must be present - * at the top-level of the response message type. + * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ responseBody?: string; /** - * Selects a method to which this rule applies. Refer to selector for - * syntax details. + * Selects a method to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -1126,8 +684,7 @@ export namespace servicenetworking_v1 { valueType?: string; } /** - * ListConnectionsResponse is the response to list peering states for the - * given service and consumer project. + * ListConnectionsResponse is the response to list peering states for the given service and consumer project. */ export interface Schema$ListConnectionsResponse { /** @@ -1149,82 +706,49 @@ export namespace servicenetworking_v1 { operations?: Schema$Operation[]; } /** - * A description of a log type. Example in YAML format: - name: - * library.googleapis.com/activity_history description: The history of - * borrowing and returning library items. display_name: Activity labels: - * - key: /customer_id description: Identifier of a library customer + * A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer */ export interface Schema$LogDescriptor { /** - * A human-readable description of this log. This information appears in the - * documentation and can contain details. + * A human-readable description of this log. This information appears in the documentation and can contain details. */ description?: string; /** - * The human-readable name for this log. This information appears on the - * user interface and should be concise. + * The human-readable name for this log. This information appears on the user interface and should be concise. */ displayName?: string; /** - * The set of labels that are available to describe a specific log entry. - * Runtime requests that contain labels not specified here are considered - * invalid. + * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ labels?: Schema$LabelDescriptor[]; /** - * The name of the log. It must be less than 512 characters long and can - * include the following characters: upper- and lower-case alphanumeric - * characters [A-Za-z0-9], and punctuation characters including slash, - * underscore, hyphen, period [/_-.]. + * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ name?: string; } /** - * Logging configuration of the service. The following example shows how to - * configure logs to be sent to the producer and consumer projects. In the - * example, the `activity_history` log is sent to both the producer and - * consumer projects, whereas the `purchase_history` log is only sent to the - * producer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. logs: - name: activity_history - * labels: - key: /customer_id - name: purchase_history logging: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - - * purchase_history consumer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history + * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history */ export interface Schema$Logging { /** - * Logging configurations for sending logs to the consumer project. There - * can be multiple consumer destinations, each one must have a different - * monitored resource type. A log can be used in at most one consumer - * destination. + * Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination. */ consumerDestinations?: Schema$LoggingDestination[]; /** - * Logging configurations for sending logs to the producer project. There - * can be multiple producer destinations, each one must have a different - * monitored resource type. A log can be used in at most one producer - * destination. + * Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination. */ producerDestinations?: Schema$LoggingDestination[]; } /** - * Configuration of a specific logging destination (the producer project or - * the consumer project). + * Configuration of a specific logging destination (the producer project or the consumer project). */ export interface Schema$LoggingDestination { /** - * Names of the logs to be sent to this destination. Each name must be - * defined in the Service.logs section. If the log name is not a domain - * scoped name, it will be automatically prefixed with the service name - * followed by "/". + * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ logs?: string[]; /** - * The monitored resource type. The type must be defined in the - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ monitoredResource?: string; } @@ -1262,9 +786,7 @@ export namespace servicenetworking_v1 { syntax?: string; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1272,28 +794,23 @@ export namespace servicenetworking_v1 { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * `appengine.googleapis.com/http/server/response_latencies` metric type has - * a label for the HTTP response code, `response_code`, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of `metric_kind` and `value_type` might not be - * supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string; /** @@ -1301,47 +818,15 @@ export namespace servicenetworking_v1 { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * `custom.googleapis.com` or `external.googleapis.com`. Metric types - * should use a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported - * units are a subset of [The Unified Code for Units of - * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units - * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute - * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo - * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera - * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` - * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * - * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico - * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` - * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * - * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) - * **Grammar** The grammar also includes these connectors: * `/` division - * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix - * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression - * = Component { "." Component } { "/" Component } ; - * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | - * Annotation | "1" ; Annotation - * = "{" NAME "}" ; Notes: * `Annotation` is just a - * comment if it follows a `UNIT` and is equivalent to `1` if it is used - * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == - * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not - * containing '{' or '}'. * `1` represents dimensionless - * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, - * and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of `metric_kind` and `value_type` might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ valueType?: string; } @@ -1350,77 +835,33 @@ export namespace servicenetworking_v1 { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * Bind API methods to metrics. Binding a method to a metric causes that - * metric's configured quota behaviors to apply to the method call. + * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. */ export interface Schema$MetricRule { /** - * Metrics to update when the selected methods are called, and the - * associated cost applied to each metric. The key of the map is the metric - * name, and the values are the amount increased for the metric against - * which the quota limits are defined. The value must not be negative. + * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ metricCosts?: {[key: string]: string}; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Declares an API Interface to be included in this interface. The including - * interface must redeclare all the methods from the included interface, but - * documentation and options are inherited as follows: - If after comment and - * whitespace stripping, the documentation string of the redeclared method - * is empty, it will be inherited from the original method. - Each - * annotation belonging to the service config (http, visibility) which is - * not set in the redeclared method will be inherited. - If an http - * annotation is inherited, the path pattern will be modified as follows. - * Any version prefix will be replaced by the version of the including - * interface plus the root path if specified. Example of a simple mixin: - * package google.acl.v1; service AccessControl { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } - * package google.storage.v2; service Storage { // rpc - * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc - * GetData(GetDataRequest) returns (Data) { option - * (google.api.http).get = "/v2/{resource=**}"; } } - * Example of a mixin configuration: apis: - name: - * google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl The mixin construct implies that all methods - * in `AccessControl` are also declared with same name and request/response - * types in `Storage`. A documentation generator or annotation processor will - * see the effective `Storage.GetAcl` method after inherting documentation and - * annotations as follows: service Storage { // Get the underlying - * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... - * } Note how the version in the path pattern changed from `v1` to `v2`. If - * the `root` field in the mixin is specified, it should be a relative path - * under which inherited HTTP paths are placed. Example: apis: - - * name: google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl root: acls This implies the following - * inherited HTTP annotation: service Storage { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; - * } ... } + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } */ export interface Schema$Mixin { /** @@ -1428,149 +869,80 @@ export namespace servicenetworking_v1 { */ name?: string; /** - * If non-empty specifies a path under which inherited HTTP paths are - * rooted. + * If non-empty specifies a path under which inherited HTTP paths are rooted. */ root?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * `"gce_instance"` and specifies the use of the labels - * `"instance_id"` and `"zone"` to identify particular VM - * instances. Different APIs can support different monitored resource types. - * APIs generally provide a `list` method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, `"Google - * Cloud SQL Database"`. + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels `"database_id"` and - * `"zone"`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` - * where {type} is the value of the `type` field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format `"monitoredResourceDescriptors/{type}"`. + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ name?: string; /** - * Required. The monitored resource type. For example, the type - * `"cloudsql_database"` represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Monitoring configuration of the service. The example below shows how to - * configure monitored resources and metrics for monitoring. In the example, a - * monitored resource and two metrics are defined. The - * `library.googleapis.com/book/returned_count` metric is sent to both - * producer and consumer projects, whereas the - * `library.googleapis.com/book/overdue_count` metric is only sent to the - * consumer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. metrics: - name: - * library.googleapis.com/book/returned_count metric_kind: DELTA - * value_type: INT64 labels: - key: /customer_id - name: - * library.googleapis.com/book/overdue_count metric_kind: GAUGE - * value_type: INT64 labels: - key: /customer_id monitoring: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count consumer_destinations: - - * monitored_resource: library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count - - * library.googleapis.com/book/overdue_count + * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count */ export interface Schema$Monitoring { /** - * Monitoring configurations for sending metrics to the consumer project. - * There can be multiple consumer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ consumerDestinations?: Schema$MonitoringDestination[]; /** - * Monitoring configurations for sending metrics to the producer project. - * There can be multiple producer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ producerDestinations?: Schema$MonitoringDestination[]; } /** - * Configuration of a specific monitoring destination (the producer project or - * the consumer project). + * Configuration of a specific monitoring destination (the producer project or the consumer project). */ export interface Schema$MonitoringDestination { /** - * Types of the metrics to report to this monitoring destination. Each type - * must be defined in Service.metrics section. + * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * OAuth scopes are a way to define data and permissions on data. For example, - * there are scopes defined for "Read-only access to Google - * Calendar" and "Access to Cloud Platform". Users can consent - * to a scope for an application, giving it permission to access that data on - * their behalf. OAuth scope specifications should be fairly coarse grained; - * a user will need to see and understand the text description of what your - * scope means. In most cases: use one or at most two OAuth scopes for an - * entire family of products. If your product has multiple APIs, you should - * probably be sharing the OAuth scope across all of those APIs. When you - * need finer grained OAuth consent screens: talk with your product management - * about how developers will use them in practice. Please note that even - * though each of the canonical scopes is enough for a request to be accepted - * and passed to the backend, a request can still fail due to the backend - * requiring additional scopes or permissions. + * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. */ export interface Schema$OAuthRequirements { /** - * The list of publicly documented OAuth scopes that are allowed access. An - * OAuth token containing any of these scopes will be accepted. Example: - * canonical_scopes: https://www.googleapis.com/auth/calendar, - * https://www.googleapis.com/auth/calendar.read + * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ canonicalScopes?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1578,103 +950,50 @@ export namespace servicenetworking_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ export interface Schema$Option { /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * `"map_entry"`. For custom options, it should be the - * fully-qualified name. For example, `"google.api.http"`. + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ name?: string; /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ value?: {[key: string]: any}; } /** - * Represents a documentation page. A page can contain subpages to represent - * nested documentation set structure. + * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. */ export interface Schema$Page { /** - * The Markdown content of the page. You can use <code>&#40;== - * include {path} ==&#41;</code> to include content from a - * Markdown file. + * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ content?: string; /** - * The name of the page. It will be used as an identity of the page to - * generate URI of the page, text of the link to this page in navigation, - * etc. The full page name (start from the root page name to this page - * concatenated with `.`) can be used as reference to the page in your - * documentation. For example: <pre><code>pages: - name: - * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - * - name: Java content: &#40;== include tutorial_java.md - * ==&#41; </code></pre> You can reference `Java` page using - * Markdown reference link syntax: `Java`. + * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ name?: string; /** - * Subpages of this page. The order of subpages specified here will be - * honored in the generated docset. + * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ subpages?: Schema$Page[]; } /** - * Quota configuration helps to achieve fairness and budgeting in service - * usage. The metric based quota configuration works this way: - The service - * configuration defines a set of metrics. - For API calls, the - * quota.metric_rules maps methods to metrics with corresponding costs. - - * The quota.limits defines limits on the metrics, which will be used for - * quota checks at runtime. An example quota configuration in yaml format: - * quota: limits: - name: apiWriteQpsPerProject metric: - * library.googleapis.com/write_calls unit: "1/min/{project}" - * # rate limit for consumer projects values: STANDARD: 10000 - * # The metric rules bind all methods to the read_calls metric, # except - * for the UpdateBook and DeleteBook methods. These two methods # are - * mapped to the write_calls metric, with the UpdateBook method # - * consuming at twice rate as the DeleteBook method. metric_rules: - - * selector: "*" metric_costs: - * library.googleapis.com/read_calls: 1 - selector: - * google.example.library.v1.LibraryService.UpdateBook metric_costs: - * library.googleapis.com/write_calls: 2 - selector: - * google.example.library.v1.LibraryService.DeleteBook metric_costs: - * library.googleapis.com/write_calls: 1 Corresponding Metric definition: - * metrics: - name: library.googleapis.com/read_calls display_name: Read - * requests metric_kind: DELTA value_type: INT64 - name: - * library.googleapis.com/write_calls display_name: Write requests - * metric_kind: DELTA value_type: INT64 + * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 */ export interface Schema$Quota { /** @@ -1682,93 +1001,52 @@ export namespace servicenetworking_v1 { */ limits?: Schema$QuotaLimit[]; /** - * List of `MetricRule` definitions, each one mapping a selected method to - * one or more metrics. + * List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */ metricRules?: Schema$MetricRule[]; } /** - * `QuotaLimit` defines a specific limit that applies over a specified - * duration for a limit type. There can be at most one limit for a duration - * and limit type combination defined within a `QuotaGroup`. + * `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. */ export interface Schema$QuotaLimit { /** - * Default number of tokens that can be consumed during the specified - * duration. This is the number of tokens assigned when a client application - * developer activates the service for his/her project. Specifying a value - * of 0 will block all requests. This can be used if you are provisioning - * quota to selected consumers and blocking others. Similarly, a value of -1 - * will indicate an unlimited quota. No other negative values are allowed. - * Used by group-based quotas only. + * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ defaultLimit?: string; /** - * Optional. User-visible, extended description for this quota limit. Should - * be used only when more context is needed to understand this limit than - * provided by the limit's display name (see: `display_name`). + * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ description?: string; /** - * User-visible display name for this limit. Optional. If not set, the UI - * will provide a default display name based on the quota configuration. - * This field can be used to override the default display name generated - * from the configuration. + * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ displayName?: string; /** - * Duration of this limit in textual notation. Example: "100s", - * "24h", "1d". For duration longer than a day, only - * multiple of days is supported. We support only "100s" and - * "1d" for now. Additional support will be added in the future. - * "0" indicates indefinite duration. Used by group-based quotas - * only. + * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. */ duration?: string; /** - * Free tier value displayed in the Developers Console for this limit. The - * free tier is the number of tokens that will be subtracted from the billed - * amount when billing is enabled. This field can only be set on a limit - * with duration "1d", in a billable group; it is invalid on any - * other limit. If this field is not set, it defaults to 0, indicating that - * there is no free tier for this service. Used by group-based quotas only. + * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ freeTier?: string; /** - * Maximum number of tokens that can be consumed during the specified - * duration. Client application developers can override the default limit up - * to this maximum. If specified, this value cannot be set to a value less - * than the default limit. If not specified, it is set to the default limit. - * To allow clients to apply overrides with no upper bound, set this to -1, - * indicating unlimited maximum quota. Used by group-based quotas only. + * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ maxLimit?: string; /** - * The name of the metric this quota limit applies to. The quota limits with - * the same metric will be checked together during runtime. The metric must - * be defined within the service config. + * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ metric?: string; /** - * Name of the quota limit. The name must be provided, and it must be - * unique within the service. The name can only include alphanumeric - * characters as well as '-'. The maximum length of the limit name - * is 64 characters. + * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ name?: string; /** - * Specify the unit of the quota limit. It uses the same syntax as - * Metric.unit. The supported unit kinds are determined by the quota backend - * system. Here are some examples: * "1/min/{project}" for quota - * per minute per project. Note: the order of unit components is - * insignificant. The "1" at the beginning is required to follow - * the metric unit syntax. + * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ unit?: string; /** - * Tiered limit values. You must specify this as a key:value pair, with an - * integer value that is the maximum number of requests allowed for the - * specified unit. Currently only STANDARD is supported. + * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ values?: {[key: string]: string}; } @@ -1777,14 +1055,11 @@ export namespace servicenetworking_v1 { */ export interface Schema$Range { /** - * CIDR range in "10.x.x.x/y" format that is within the allocated - * ranges and currently unused. + * CIDR range in "10.x.x.x/y" format that is within the allocated ranges and currently unused. */ ipCidrRange?: string; /** - * In the Shared VPC host project, the VPC network that's peered with - * the consumer network. For example: - * `projects/1234321/global/networks/host-network` + * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ network?: string; } @@ -1793,42 +1068,20 @@ export namespace servicenetworking_v1 { */ export interface Schema$SearchRangeRequest { /** - * Required. The prefix length of the IP range. Use usual CIDR range - * notation. For example, '30' to find unused x.x.x.x/30 CIDR range. - * Actual range will be determined using allocated range for the consumer - * peered network and returned in the result. + * Required. The prefix length of the IP range. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be determined using allocated range for the consumer peered network and returned in the result. */ ipPrefixLength?: number; /** - * Network name in the consumer project. This network must have been - * already peered with a shared VPC network using CreateConnection method. - * Must be in a form 'projects/{project}/global/networks/{network}'. - * {project} is a project number, as in '12345' {network} is network - * name. + * Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/{project}/global/networks/{network}'. {project} is a project number, as in '12345' {network} is network name. */ network?: string; } /** - * `Service` is the root object of Google service configuration schema. It - * describes basic information about a service, such as the name and the - * title, and delegates other aspects to sub-sections. Each sub-section is - * either a proto message or a repeated proto message that configures a - * specific aspect, such as auth. See each proto message definition for - * details. Example: type: google.api.Service config_version: 3 - * name: calendar.googleapis.com title: Google Calendar API apis: - - * name: google.calendar.v3.Calendar authentication: providers: - - * id: google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Service { /** - * A list of API interfaces exported by this service. Only the `name` field - * of the google.protobuf.Api needs to be provided by the configuration - * author, as the remaining fields will be derived from the IDL during the - * normalization process. It is an error to specify an API interface here - * which cannot be resolved against the associated IDL files. + * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; /** @@ -1844,10 +1097,7 @@ export namespace servicenetworking_v1 { */ billing?: Schema$Billing; /** - * The semantic version of the service configuration. The config version - * affects the interpretation of the service configuration. For example, - * certain features are enabled by default for certain config versions. The - * latest config version is `3`. + * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ configVersion?: number; /** @@ -1867,30 +1117,19 @@ export namespace servicenetworking_v1 { */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. If this is empty, then an endpoint - * with the same name as the service is automatically generated to service - * all defined APIs. + * Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */ endpoints?: Schema$Endpoint[]; /** - * A list of all enum types included in this API service. Enums referenced - * directly or indirectly by the `apis` are automatically included. Enums - * which are not referenced but shall be included should be listed here by - * name. Example: enums: - name: google.someapi.v1.SomeEnum + * A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum */ enums?: Schema$Enum[]; - /** - * Experimental configuration. - */ - experimental?: Schema$Experimental; /** * HTTP configuration. */ http?: Schema$Http; /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. Must be no longer than 60 characters. + * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ id?: string; /** @@ -1906,8 +1145,7 @@ export namespace servicenetworking_v1 { */ metrics?: Schema$MetricDescriptor[]; /** - * Defines the monitored resources used by this service. This is required by - * the Service.monitoring and Service.logging configurations. + * Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */ monitoredResources?: Schema$MonitoredResourceDescriptor[]; /** @@ -1915,10 +1153,7 @@ export namespace servicenetworking_v1 { */ monitoring?: Schema$Monitoring; /** - * The service name, which is a DNS-like logical identifier for the service, - * such as `calendar.googleapis.com`. The service name typically goes - * through DNS verification to make sure the owner of the service also owns - * the DNS name. + * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ name?: string; /** @@ -1938,11 +1173,7 @@ export namespace servicenetworking_v1 { */ systemParameters?: Schema$SystemParameters; /** - * A list of all proto message types included in this API service. It serves - * similar purpose as [google.api.Service.types], except that these types - * are not needed by user-defined APIs. Therefore, they will not show up in - * the generated discovery doc. This field should only be used to define - * system APIs in ESF. + * A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. */ systemTypes?: Schema$Type[]; /** @@ -1950,11 +1181,7 @@ export namespace servicenetworking_v1 { */ title?: string; /** - * A list of all proto message types included in this API service. Types - * referenced directly or indirectly by the `apis` are automatically - * included. Messages which are not referenced but shall be included, such - * as types used by the `google.protobuf.Any` type, should be listed here by - * name. Example: types: - name: google.protobuf.Int32 + * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ types?: Schema$Type[]; /** @@ -1963,14 +1190,11 @@ export namespace servicenetworking_v1 { usage?: Schema$Usage; } /** - * `SourceContext` represents information about the source of a protobuf - * element, like the file in which it is defined. + * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ export interface Schema$SourceContext { /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * `"google/protobuf/source_context.proto"`. + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ fileName?: string; } @@ -1984,40 +1208,7 @@ export namespace servicenetworking_v1 { sourceFiles?: Array<{[key: string]: any}>; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -2025,20 +1216,16 @@ export namespace servicenetworking_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Represents a subnet that was created or discovered by a private access - * management service. + * Represents a subnet that was created or discovered by a private access management service. */ export interface Schema$Subnetwork { /** @@ -2050,78 +1237,50 @@ export namespace servicenetworking_v1 { */ name?: string; /** - * In the Shared VPC host project, the VPC network that's peered with - * the consumer network. For example: - * `projects/1234321/global/networks/host-network` + * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ network?: string; /** - * This is a discovered subnet that is not within the current consumer - * allocated ranges. + * This is a discovered subnet that is not within the current consumer allocated ranges. */ outsideAllocation?: boolean; } /** - * Define a parameter's name and location. The parameter may be passed as - * either an HTTP header or a URL query parameter, and if both are passed the - * behavior is implementation-dependent. + * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. */ export interface Schema$SystemParameter { /** - * Define the HTTP header name to use for the parameter. It is case - * insensitive. + * Define the HTTP header name to use for the parameter. It is case insensitive. */ httpHeader?: string; /** - * Define the name of the parameter, such as "api_key" . It is - * case sensitive. + * Define the name of the parameter, such as "api_key" . It is case sensitive. */ name?: string; /** - * Define the URL query parameter name to use for the parameter. It is case - * sensitive. + * Define the URL query parameter name to use for the parameter. It is case sensitive. */ urlQueryParameter?: string; } /** - * Define a system parameter rule mapping system parameter definitions to - * methods. + * Define a system parameter rule mapping system parameter definitions to methods. */ export interface Schema$SystemParameterRule { /** - * Define parameters. Multiple names may be defined for a parameter. For a - * given method call, only one of them should be used. If multiple names are - * used the behavior is implementation-dependent. If none of the specified - * names are present the behavior is parameter-dependent. + * Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent. */ parameters?: Schema$SystemParameter[]; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; } /** - * ### System parameter configuration A system parameter is a special kind of - * parameter defined by the API system, not by an individual API. It is - * typically mapped to an HTTP header and/or a URL query parameter. This - * configuration specifies which methods change the names of the system - * parameters. + * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. */ export interface Schema$SystemParameters { /** - * Define system parameters. The parameters defined here will override the - * default parameters implemented by the system. If this field is missing - * from the service config, default system parameters will be used. Default - * system parameters and names is implementation-dependent. Example: define - * api key for all methods system_parameters rules: - - * selector: "*" parameters: - name: api_key - * url_query_parameter: api_key Example: define 2 api key names for a - * specific method. system_parameters rules: - selector: - * "/ListShelves" parameters: - name: - * api_key http_header: Api-Key1 - name: api_key - * http_header: Api-Key2 **NOTE:** All service configuration rules follow - * "last one wins" order. + * Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$SystemParameterRule[]; } @@ -2159,57 +1318,32 @@ export namespace servicenetworking_v1 { */ export interface Schema$Usage { /** - * The full resource name of a channel used for sending notifications to the - * service producer. Google Service Management currently only supports - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - * channel. To use Google Cloud Pub/Sub as the channel, this must be the - * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name - * format documented in https://cloud.google.com/pubsub/docs/overview. + * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ producerNotificationChannel?: string; /** - * Requirements that must be satisfied before a consumer project can use the - * service. Each requirement is of the form - * <service.name>/<requirement-id>; for example - * 'serviceusage.googleapis.com/billing-enabled'. + * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ requirements?: string[]; /** - * A list of usage rules that apply to individual API methods. **NOTE:** - * All service configuration rules follow "last one wins" order. + * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use - * this rule to configure unregistered calls for the service. Unregistered - * calls are calls that do not contain consumer project identity. (Example: - * calls that do not contain an API key). By default, API methods do not allow - * unregistered calls, and each method call must be identified by a consumer - * project identity. Use this rule to allow/disallow unregistered calls. - * Example of an API that wants to allow unregistered calls for entire - * service. usage: rules: - selector: "*" - * allow_unregistered_calls: true Example of a method that wants to allow - * unregistered calls. usage: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allow_unregistered_calls: true + * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that - * don't identify any user or application. + * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ allowUnregisteredCalls?: boolean; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; /** - * If true, the selected method should skip service control and the control - * plane features, such as quota and billing, will not be available. This - * flag is used by Google Cloud Endpoints to bypass checks for internal - * methods, such as service health check methods. + * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ skipServiceControl?: boolean; } @@ -2222,15 +1356,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias servicenetworking.operations.cancel * @memberOf! () * @@ -2301,10 +1427,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias servicenetworking.operations.delete * @memberOf! () * @@ -2374,9 +1497,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias servicenetworking.operations.get * @memberOf! () * @@ -2447,15 +1568,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias servicenetworking.operations.list * @memberOf! () * @@ -2604,16 +1717,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.services.addSubnetwork - * @desc For service producers, provisions a new subnet in a peered - * service's shared VPC network in the requested region and with the - * requested size that's expressed as a CIDR range (number of leading bits - * of ipV4 network mask). The method checks against the assigned allocated - * ranges to find a non-conflicting IP address range. The method will reuse - * a subnet if subsequent calls contain the same subnet name, region, and - * prefix length. This method will make producer's tenant project to be a - * shared VPC service project as needed. The response from the `get` - * operation will be of type `Subnetwork` if the operation successfully - * completes. + * @desc For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed. The response from the `get` operation will be of type `Subnetwork` if the operation successfully completes. * @alias servicenetworking.services.addSubnetwork * @memberOf! () * @@ -2689,12 +1793,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.services.searchRange - * @desc Service producers can use this method to find a currently unused - * range within consumer allocated ranges. This returned range is not - * reserved, and not guaranteed to remain unused. It will validate - * previously provided allocated ranges, find non-conflicting sub-range of - * requested size (expressed in number of leading bits of ipv4 network mask, - * as in CIDR range notation). Operation + * @desc Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation). Operation * @alias servicenetworking.services.searchRange * @memberOf! () * @@ -2777,13 +1876,7 @@ export namespace servicenetworking_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A tenant project in the service producer organization, in the - * following format: services/{service}/{collection-id}/{resource-id}. - * {collection-id} is the cloud resource collection type that represents the - * tenant project. Only `projects` are supported. {resource-id} is the - * tenant project numeric id, such as `123456`. {service} the name of the - * peering service, such as `service-peering.example.com`. This service must - * already be enabled in the service consumer's project. + * Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id}/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only `projects` are supported. {resource-id} is the tenant project numeric id, such as `123456`. {service} the name of the peering service, such as `service-peering.example.com`. This service must already be enabled in the service consumer's project. */ parent?: string; @@ -2800,9 +1893,7 @@ export namespace servicenetworking_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. This is in a form services/{service}. {service} the name of the - * private access management service, for example - * 'service-peering.example.com'. + * Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'. */ parent?: string; @@ -2820,15 +1911,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.services.connections.create - * @desc Creates a private connection that establishes a VPC Network Peering - * connection to a VPC network in the service producer's organization. The - * administrator of the service consumer's VPC network invokes this method. - * The administrator must assign one or more allocated IP ranges for - * provisioning subnetworks in the service producer's VPC network. This - * connection is used for all supported services in the service producer's - * organization, so it only needs to be invoked once. The response from the - * `get` operation will be of type `Connection` if the operation - * successfully completes. + * @desc Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once. The response from the `get` operation will be of type `Connection` if the operation successfully completes. * @alias servicenetworking.services.connections.create * @memberOf! () * @@ -2904,8 +1987,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.services.connections.list - * @desc List the private connections that are configured in a service - * consumer's VPC network. + * @desc List the private connections that are configured in a service consumer's VPC network. * @alias servicenetworking.services.connections.list * @memberOf! () * @@ -2983,9 +2065,7 @@ export namespace servicenetworking_v1 { /** * servicenetworking.services.connections.patch - * @desc Updates the allocated ranges that are assigned to a connection. The - * response from the `get` operation will be of type `Connection` if the - * operation successfully completes. + * @desc Updates the allocated ranges that are assigned to a connection. The response from the `get` operation will be of type `Connection` if the operation successfully completes. * @alias servicenetworking.services.connections.patch * @memberOf! () * @@ -3067,9 +2147,7 @@ export namespace servicenetworking_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The service that is managing peering connectivity for a service - * producer's organization. For Google services that support this - * functionality, this value is `services/servicenetworking.googleapis.com`. + * The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. */ parent?: string; @@ -3086,20 +2164,11 @@ export namespace servicenetworking_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of service consumer's VPC network that's connected with service - * producer network through a private connection. The network name must be - * in the following format: `projects/{project}/global/networks/{network}`. - * {project} is a project number, such as in `12345` that includes the VPC - * service consumer's VPC network. {network} is the name of the service - * consumer's VPC network. + * The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: `projects/{project}/global/networks/{network}`. {project} is a project number, such as in `12345` that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network. */ network?: string; /** - * The service that is managing peering connectivity for a service - * producer's organization. For Google services that support this - * functionality, this value is `services/servicenetworking.googleapis.com`. - * If you specify `services/-` as the parameter value, all configured - * peering services are listed. + * The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `services/-` as the parameter value, all configured peering services are listed. */ parent?: string; } @@ -3111,22 +2180,15 @@ export namespace servicenetworking_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If a previously defined allocated range is removed, force flag must be - * set to true. + * If a previously defined allocated range is removed, force flag must be set to true. */ force?: boolean; /** - * The private service connection that connects to a service producer - * organization. The name includes both the private service name and the VPC - * network peering name in the format of - * `services/{peering_service_name}/connections/{vpc_peering_name}`. For - * Google services that support this functionality, this is - * `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`. + * The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name}/connections/{vpc_peering_name}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`. */ name?: string; /** - * The update mask. If this is omitted, it defaults to "*". You can only - * update the listed peering ranges. + * The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges. */ updateMask?: string; diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index d54b6b270f1..274d5c9e417 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace servicenetworking_v1beta { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace servicenetworking_v1beta { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace servicenetworking_v1beta { /** * Service Networking API * - * Provides automatic management of network configurations necessary for - * certain services. + * Provides automatic management of network configurations necessary for certain services. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace servicenetworking_v1beta { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.services = new Resource$Services(this.context); @@ -126,20 +124,11 @@ export namespace servicenetworking_v1beta { */ export interface Schema$AddSubnetworkRequest { /** - * Required. A resource that represents the service consumer, such as - * `projects/123456`. The project number can be different from the value in - * the consumer network parameter. For example, the network might be part of - * a Shared VPC network. In those cases, Service Networking validates that - * this resource belongs to that Shared VPC. + * Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC. */ consumer?: string; /** - * Required. The name of the service consumer's VPC network. The network - * must have an existing private connection that was provisioned through the - * connections.create method. The name must be in the following format: - * `projects/{project}/global/networks/{network}`, where {project} is a - * project number, such as `12345`. {network} is the name of a VPC network - * in the project. + * Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project. */ consumerNetwork?: string; /** @@ -147,47 +136,28 @@ export namespace servicenetworking_v1beta { */ description?: string; /** - * Required. The prefix length of the subnet's IP address range. Use - * CIDR range notation, such as `30` to provision a subnet with an - * `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of - * available ranges in the service consumer's allocated range. + * Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. */ ipPrefixLength?: number; /** - * Required. The name of a [region](/compute/docs/regions-zones) for the - * subnet, such `europe-west1`. + * Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe-west1`. */ region?: string; /** - * Optional. The starting address of a range. The address must be a valid - * IPv4 address in the x.x.x.x format. This value combined with the IP - * prefix range is the CIDR range for the subnet. The range must be within - * the allocated range that is assigned to the private connection. If the - * CIDR range isn't available, the call fails. + * Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails. */ requestedAddress?: string; /** - * Required. A name for the new subnet. For information about the naming - * requirements, see - * [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute - * API documentation. + * Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation. */ subnetwork?: string; /** - * A list of members that are granted the `compute.networkUser` role on the - * subnet. + * A list of members that are granted the `compute.networkUser` role on the subnet. */ subnetworkUsers?: string[]; } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also - * described as "protocol buffer services" in some contexts, such as - * by the "service" keyword in a .proto file, but they are different - * from API Services, which represent a concrete implementation of an - * interface as opposed to simply a description of methods and bindings. They - * are also sometimes simply referred to as "APIs" in other - * contexts, such as the name of this message itself. See - * https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ export interface Schema$Api { /** @@ -199,8 +169,7 @@ export namespace servicenetworking_v1beta { */ mixins?: Schema$Mixin[]; /** - * The fully qualified name of this interface, including package name - * followed by the interface's simple name. + * The fully qualified name of this interface, including package name followed by the interface's simple name. */ name?: string; /** @@ -208,8 +177,7 @@ export namespace servicenetworking_v1beta { */ options?: Schema$Option[]; /** - * Source context for the protocol buffer service represented by this - * message. + * Source context for the protocol buffer service represented by this message. */ sourceContext?: Schema$SourceContext; /** @@ -217,32 +185,12 @@ export namespace servicenetworking_v1beta { */ syntax?: string; /** - * A version string for this interface. If specified, must have the form - * `major-version.minor-version`, as in `1.10`. If the minor version is - * omitted, it defaults to zero. If the entire version field is empty, the - * major version is derived from the package name, as outlined below. If the - * field is not empty, the version in the package name will be verified to - * be consistent with what is provided here. The versioning schema uses - * [semantic versioning](http://semver.org) where the major version number - * indicates a breaking change and the minor version an additive, - * non-breaking change. Both version numbers are signals to users what to - * expect from different versions, and should be carefully chosen based on - * the product plan. The major version is also reflected in the package - * name of the interface, which must end in `v<major-version>`, as in - * `google.feature.v1`. For major versions 0 and 1, the suffix can be - * omitted. Zero major versions must only be used for experimental, non-GA - * interfaces. + * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ version?: string; } /** - * `Authentication` defines the authentication configuration for an API. - * Example for an API targeted for external use: name: - * calendar.googleapis.com authentication: providers: - id: - * google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Authentication { /** @@ -250,18 +198,12 @@ export namespace servicenetworking_v1beta { */ providers?: Schema$AuthProvider[]; /** - * A list of authentication rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$AuthenticationRule[]; } /** - * Authentication rules for the service. By default, if a method has any - * authentication requirements, every request must include a valid credential - * matching one of the requirements. It's an error to include more than - * one kind of credential in a single request. If a method doesn't have - * any auth requirements, request credentials will be ignored. + * Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored. */ export interface Schema$AuthenticationRule { /** @@ -277,96 +219,45 @@ export namespace servicenetworking_v1beta { */ requirements?: Schema$AuthRequirement[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Configuration of authorization. This section determines the authorization - * provider, if unspecified, then no authorization check will be done. - * Example: experimental: authorization: provider: - * firebaserules.googleapis.com - */ - export interface Schema$AuthorizationConfig { - /** - * The name of the authorization provider, such as - * firebaserules.googleapis.com. - */ - provider?: string; - } - /** - * Configuration for an authentication provider, including support for [JSON - * Web Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthProvider { /** - * The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * Redirect URL if JWT token is required but not present or is expired. - * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ authorizationUrl?: string; /** - * The unique identifier of the auth provider. It will be referred to by - * `AuthRequirement.provider_id`. Example: "bookstore_auth". + * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ id?: string; /** - * Identifies the principal that issued the JWT. See - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - * Usually a URL or an email address. Example: - * https://securetoken.google.com Example: - * 1234567-compute@developer.gserviceaccount.com + * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ issuer?: string; /** - * URL of the provider's public key set to validate signature of the - * JWT. See [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - * Optional if the key set document: - can be retrieved from [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: - * https://www.googleapis.com/oauth2/v1/certs + * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string; } /** - * User-defined authentication requirements, including support for [JSON Web - * Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthRequirement { /** - * NOTE: This will be deprecated soon, once AuthProvider.audiences is - * implemented and accepted in all the runtime components. The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * id from authentication provider. Example: provider_id: - * bookstore_auth + * id from authentication provider. Example: provider_id: bookstore_auth */ providerId?: string; } @@ -375,9 +266,7 @@ export namespace servicenetworking_v1beta { */ export interface Schema$Backend { /** - * A list of API backend rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$BackendRule[]; } @@ -390,9 +279,7 @@ export namespace servicenetworking_v1beta { */ address?: string; /** - * The number of seconds to wait for a response from a request. The default - * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 - * seconds. + * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ deadline?: number; /** @@ -400,131 +287,81 @@ export namespace servicenetworking_v1beta { */ jwtAudience?: string; /** - * Minimum deadline in seconds needed for this method. Calls having deadline - * value lower than this will be rejected. + * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ minDeadline?: number; /** - * The number of seconds to wait for the completion of a long running - * operation. The default is no deadline. + * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ operationDeadline?: number; pathTranslation?: string; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Billing related configuration of the service. The following example shows - * how to configure monitored resources and metrics for billing: - * monitored_resources: - type: library.googleapis.com/branch labels: - - * key: /city description: The city where the library branch is - * located in. - key: /name description: The name of the branch. - * metrics: - name: library.googleapis.com/book/borrowed_count - * metric_kind: DELTA value_type: INT64 billing: - * consumer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/borrowed_count + * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** - * Billing configurations for sending metrics to the consumer project. There - * can be multiple consumer destinations per service, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. + * Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. */ consumerDestinations?: Schema$BillingDestination[]; } /** - * Configuration of a specific billing destination (Currently only support - * bill against consumer project). + * Configuration of a specific billing destination (Currently only support bill against consumer project). */ export interface Schema$BillingDestination { /** - * Names of the metrics to report to this billing destination. Each name - * must be defined in Service.metrics section. + * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * Represents a private connection resource. A private connection is - * implemented as a VPC Network Peering connection between a service - * producer's VPC network and a service consumer's VPC network. + * Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network. */ export interface Schema$Connection { /** - * The name of service consumer's VPC network that's connected with - * service producer network, in the following format: - * `projects/{project}/global/networks/{network}`. `{project}` is a project - * number, such as in `12345` that includes the VPC service consumer's - * VPC network. `{network}` is the name of the service consumer's VPC - * network. + * The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network}` is the name of the service consumer's VPC network. */ network?: string; /** - * Output only. The name of the VPC Network Peering connection that was - * created by the service producer. + * Output only. The name of the VPC Network Peering connection that was created by the service producer. */ peering?: string; /** - * The name of one or more allocated IP address ranges for this service - * producer of type `PEERING`. Note that invoking this method with a - * different range when connection is already established will not modify - * already provisioned service producer subnetworks. + * The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking this method with a different range when connection is already established will not modify already provisioned service producer subnetworks. */ reservedPeeringRanges?: string[]; /** - * Output only. The name of the peering service that's associated with - * this connection, in the following format: `services/{service name}`. + * Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`. */ service?: string; } /** - * `Context` defines which contexts an API requests. Example: context: - * rules: - selector: "*" requested: - - * google.rpc.context.ProjectContext - - * google.rpc.context.OriginContext The above specifies that all methods in - * the API request `google.rpc.context.ProjectContext` and - * `google.rpc.context.OriginContext`. Available context types are defined in - * package `google.rpc.context`. This also provides mechanism to whitelist - * any protobuf message extension that can be sent in grpc metadata using - * “x-goog-ext-<extension_id>-bin” and - * “x-goog-ext-<extension_id>-jspb” format. For example, list any - * service specific protobuf types that can appear in grpc metadata as follows - * in your yaml file: Example: context: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allowed_request_extensions: - google.foo.v1.NewExtension - * allowed_response_extensions: - google.foo.v1.NewExtension You can - * also specify extension ID instead of fully qualified extension name here. + * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ export interface Schema$Context { /** - * A list of RPC context rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$ContextRule[]; } /** - * A context rule provides information about the context for an individual API - * element. + * A context rule provides information about the context for an individual API element. */ export interface Schema$ContextRule { /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from client to backend. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ allowedRequestExtensions?: string[]; /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from backend to client. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ allowedResponseExtensions?: string[]; /** @@ -536,39 +373,29 @@ export namespace servicenetworking_v1beta { */ requested?: string[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Selects and configures the service controller used by the service. The - * service controller handles features like abuse, quota, billing, logging, - * monitoring, etc. + * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. */ export interface Schema$Control { /** - * The service control environment to use. If empty, no control plane - * feature (like quota and billing) will be enabled. + * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ environment?: string; } /** - * Customize service error responses. For example, list any service specific - * protobuf types that can appear in error detail lists of error responses. - * Example: custom_error: types: - google.foo.v1.CustomError - * - google.foo.v1.AnotherError + * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError */ export interface Schema$CustomError { /** - * The list of custom error rules that apply to individual API messages. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$CustomErrorRule[]; /** - * The list of custom error detail types, e.g. - * 'google.foo.v1.CustomError'. + * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ types?: string[]; } @@ -577,13 +404,11 @@ export namespace servicenetworking_v1beta { */ export interface Schema$CustomErrorRule { /** - * Mark this message as possible payload in error response. Otherwise, - * objects of this type will be filtered when they appear in error payload. + * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ isErrorType?: boolean; /** - * Selects messages to which this rule applies. Refer to selector for - * syntax details. + * Selects messages to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -601,42 +426,7 @@ export namespace servicenetworking_v1beta { path?: string; } /** - * `Documentation` provides the information for describing a service. Example: - * <pre><code>documentation: summary: > The Google - * Calendar API gives access to most calendar features. pages: - name: - * Overview content: &#40;== include google/foo/overview.md - * ==&#41; - name: Tutorial content: &#40;== include - * google/foo/tutorial.md ==&#41; subpages; - name: Java content: - * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - - * selector: google.calendar.Calendar.Get description: > ... - - * selector: google.calendar.Calendar.Put description: > ... - * </code></pre> Documentation is provided in markdown syntax. In - * addition to standard markdown features, definition lists, tables and fenced - * code blocks are supported. Section headers can be provided and are - * interpreted relative to the section nesting of the context where a - * documentation fragment is embedded. Documentation from the IDL is merged - * with documentation defined via the config at normalization time, where - * documentation provided by config rules overrides IDL provided. A number of - * constructs specific to the API platform are supported in documentation - * text. In order to reference a proto element, the following notation can be - * used: - * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> - * To override the display text used for the link, this can be used: - * <pre><code>&#91;display - * text]&#91;fully.qualified.proto.name]</code></pre> Text can - * be excluded from doc using the following notation: - * <pre><code>&#40;-- internal comment - * --&#41;</code></pre> A few directives are available in - * documentation. Note that directives must appear on a single line to be - * properly identified. The `include` directive includes a markdown file from - * an external source: <pre><code>&#40;== include path/to/file - * ==&#41;</code></pre> The `resource_for` directive marks a - * message to be the resource of a collection in REST view. If it is not - * specified, tools attempt to infer the resource from the operations in a - * collection: <pre><code>&#40;== resource_for - * v1.shelves.books ==&#41;</code></pre> The directive - * `suppress_warning` does not directly affect documentation and is documented - * together with service config validation. + * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -644,14 +434,7 @@ export namespace servicenetworking_v1beta { */ documentationRootUrl?: string; /** - * Declares a single overview page. For example: - * <pre><code>documentation: summary: ... overview: - * &#40;== include overview.md ==&#41; </code></pre> - * This is a shortcut for the following declaration (using pages style): - * <pre><code>documentation: summary: ... pages: - name: - * Overview content: &#40;== include overview.md ==&#41; - * </code></pre> Note: you cannot specify both `overview` field - * and `pages` field. + * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ overview?: string; /** @@ -659,14 +442,11 @@ export namespace servicenetworking_v1beta { */ pages?: Schema$Page[]; /** - * A list of documentation rules that apply to individual API elements. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; /** - * A short summary of what the service does. Can only be provided by plain - * text. + * A short summary of what the service does. Can only be provided by plain text. */ summary?: string; } @@ -675,8 +455,7 @@ export namespace servicenetworking_v1beta { */ export interface Schema$DocumentationRule { /** - * Deprecation description of the selected element(s). It can be provided if - * an element is marked as `deprecated`. + * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ deprecationDescription?: string; /** @@ -684,42 +463,20 @@ export namespace servicenetworking_v1beta { */ description?: string; /** - * The selector is a comma-separated list of patterns. Each pattern is a - * qualified name of the element which may end in "*", indicating - * a wildcard. Wildcards are only allowed at the end and for a whole - * component of the qualified name, i.e. "foo.*" is ok, but not - * "foo.b*" or "foo.*.bar". A wildcard will match one or - * more components. To specify a default for all applicable elements, the - * whole pattern "*" is used. + * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ selector?: string; } /** - * `Endpoint` describes a network endpoint that serves a set of APIs. A - * service may expose any number of endpoints, and all endpoints share the - * same service configuration, such as quota configuration and monitoring - * configuration. Example service configuration: name: - * library-example.googleapis.com endpoints: # Below entry makes - * 'google.example.library.v1.Library' # API be served from - * endpoint address library-example.googleapis.com. # It also allows - * HTTP OPTIONS calls to be passed to the backend, for # it to decide - * whether the subsequent cross-origin request is # allowed to proceed. - * - name: library-example.googleapis.com allow_cors: true + * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ export interface Schema$Endpoint { /** - * DEPRECATED: This field is no longer supported. Instead of using aliases, - * please specify multiple google.api.Endpoint for each of the intended - * aliases. Additional names that this endpoint will be hosted on. + * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ aliases?: string[]; /** - * Allowing - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - * cross-domain traffic, would allow the backends served from this endpoint - * to receive and respond to HTTP OPTIONS requests. The response will be - * used by the browser to determine whether the subsequent cross-origin - * request is allowed to proceed. + * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ allowCors?: boolean; /** @@ -731,11 +488,7 @@ export namespace servicenetworking_v1beta { */ name?: string; /** - * The specification of an Internet routable address of API frontend that - * will handle requests to this [API - * Endpoint](https://cloud.google.com/apis/design/glossary). It should be - * either a valid IPv4 address or a fully-qualified domain name. For - * example, "8.8.8.8" or "myservice.appspot.com". + * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ target?: string; } @@ -781,16 +534,6 @@ export namespace servicenetworking_v1beta { */ options?: Schema$Option[]; } - /** - * Experimental service configuration. These configuration options can only be - * used by whitelisted users. - */ - export interface Schema$Experimental { - /** - * Authorization configuration. - */ - authorization?: Schema$AuthorizationConfig; - } /** * A single field of a message type. */ @@ -820,9 +563,7 @@ export namespace servicenetworking_v1beta { */ number?: number; /** - * The index of the field type in `Type.oneofs`, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. + * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ oneofIndex?: number; /** @@ -834,14 +575,12 @@ export namespace servicenetworking_v1beta { */ packed?: boolean; /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ typeUrl?: string; } /** - * Represents a subnet that was created or discovered by a private access - * management service. + * Represents a subnet that was created or discovered by a private access management service. */ export interface Schema$GoogleCloudServicenetworkingV1betaSubnetwork { /** @@ -853,210 +592,41 @@ export namespace servicenetworking_v1beta { */ name?: string; /** - * In the Shared VPC host project, the VPC network that's peered with - * the consumer network. For example: - * `projects/1234321/global/networks/host-network` + * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ network?: string; /** - * This is a discovered subnet that is not within the current consumer - * allocated ranges. + * This is a discovered subnet that is not within the current consumer allocated ranges. */ outsideAllocation?: boolean; } /** - * Defines the HTTP configuration for an API service. It contains a list of - * HttpRule, each specifying the mapping of an RPC method to one or more HTTP - * REST API methods. + * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. */ export interface Schema$Http { /** - * When set to true, URL path parameters will be fully URI-decoded except in - * cases of single segment matches in reserved expansion, where - * "%2F" will be left encoded. The default behavior is to not - * decode RFC 6570 reserved characters in multi segment matches. + * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ fullyDecodeReservedExpansion?: boolean; /** - * A list of HTTP configuration rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$HttpRule[]; } /** - * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - * gRPC method and one or more HTTP REST endpoints. It allows developers to - * build a single API service that supports both gRPC APIs and REST APIs. Many - * systems, including [Google APIs](https://github.com/googleapis/googleapis), - * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and - * use it for large scale production services. `HttpRule` defines the schema - * of the gRPC/REST mapping. The mapping specifies how different portions of - * the gRPC request message are mapped to the URL path, URL query parameters, - * and HTTP request body. It also controls how the gRPC response message is - * mapped to the HTTP response body. `HttpRule` is typically specified as an - * `google.api.http` annotation on the gRPC method. Each mapping specifies a - * URL path template and an HTTP method. The path template may refer to one or - * more fields in the gRPC request message, as long as each field is a - * non-repeated field with a primitive (non-message) type. The path template - * controls how fields of the request message are mapped to the URL path. - * Example: service Messaging { rpc GetMessage(GetMessageRequest) - * returns (Message) { option (google.api.http) = { get: - * "/v1/{name=messages/*}" }; } } message - * GetMessageRequest { string name = 1; // Mapped to URL path. } - * message Message { string text = 1; // The resource content. } - * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC - * -----|----- `GET /v1/messages/123456` | `GetMessage(name: - * "messages/123456")` Any fields in the request message which are - * not bound by the path template automatically become HTTP query parameters - * if there is no HTTP request body. For example: service Messaging { rpc - * GetMessage(GetMessageRequest) returns (Message) { option - * (google.api.http) = { get:"/v1/messages/{message_id}" - * }; } } message GetMessageRequest { message SubMessage { - * string subfield = 1; } string message_id = 1; // Mapped to URL - * path. int64 revision = 2; // Mapped to URL query parameter - * `revision`. SubMessage sub = 3; // Mapped to URL query parameter - * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - * HTTP | gRPC -----|----- `GET - * /v1/messages/123456?revision=2&sub.subfield=foo` | - * `GetMessage(message_id: "123456" revision: 2 sub: - * SubMessage(subfield: "foo"))` Note that fields which are mapped - * to URL query parameters must have a primitive type or a repeated primitive - * type or a non-repeated message type. In the case of a repeated type, the - * parameter can be repeated in the URL as `...?param=A&param=B`. In the - * case of a message type, each field of the message is mapped to a separate - * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods - * that allow a request body, the `body` field specifies the mapping. Consider - * a REST update method on the message resource collection: service - * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) - * { option (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "message" - * }; } } message UpdateMessageRequest { string message_id - * = 1; // mapped to the URL Message message = 2; // mapped to the - * body } The following HTTP JSON to RPC mapping is enabled, where the - * representation of the JSON in the request body is determined by protos JSON - * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { - * "text": "Hi!" }` | `UpdateMessage(message_id: - * "123456" message { text: "Hi!" })` The special name - * `*` can be used in the body mapping to define that every field not bound by - * the path template should be mapped to the request body. This enables the - * following alternative definition of the update method: service - * Messaging { rpc UpdateMessage(Message) returns (Message) { option - * (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "*" }; } } - * message Message { string message_id = 1; string text = 2; } - * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- - * `PATCH /v1/messages/123456 { "text": "Hi!" }` | - * `UpdateMessage(message_id: "123456" text: "Hi!")` Note - * that when using `*` in the body mapping, it is not possible to have HTTP - * parameters, as all fields not bound by the path end in the body. This makes - * this option more rarely used in practice when defining REST APIs. The - * common usage of `*` is in custom methods which don't use the URL at all - * for transferring data. It is possible to define multiple HTTP methods for - * one RPC by using the `additional_bindings` option. Example: service - * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { - * option (google.api.http) = { get: - * "/v1/messages/{message_id}" additional_bindings { get: - * "/v1/users/{user_id}/messages/{message_id}" } }; } } - * message GetMessageRequest { string message_id = 1; string - * user_id = 2; } This enables the following two alternative HTTP JSON to - * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - * `GetMessage(message_id: "123456")` `GET - * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" - * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf - * request fields (recursive expansion nested messages in the request message) - * are classified into three categories: - Fields referred by the path - * template. They are passed via the URL path. - Fields referred by the - * HttpRule.body. They are passed via the HTTP request body. - All - * other fields are passed via the URL query parameters, and the parameter - * name is the field path in the request message. A repeated field can be - * represented as multiple query parameters under the same name. 2. If - * HttpRule.body is "*", there is no URL query parameter, all fields - * are passed via URL path and HTTP request body. 3. If HttpRule.body is - * omitted, there is no HTTP request body, all fields are passed via URL - * path and URL query parameters. ### Path template syntax Template = - * "/" Segments [ Verb ] ; Segments = Segment { "/" - * Segment } ; Segment = "*" | "**" | LITERAL | - * Variable ; Variable = "{" FieldPath [ "=" Segments - * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb - * = ":" LITERAL ; The syntax `*` matches a single URL path - * segment. The syntax `**` matches zero or more URL path segments, which must - * be the last part of the URL path except the `Verb`. The syntax `Variable` - * matches part of the URL path as specified by its template. A variable - * template must not contain other variables. If a variable matches a single - * path segment, its template may be omitted, e.g. `{var}` is equivalent to - * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If - * the `LITERAL` contains any reserved character, such characters should be - * percent-encoded before the matching. If a variable contains exactly one - * path segment, such as `"{var}"` or `"{var=*}"`, when - * such a variable is expanded into a URL path on the client side, all - * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - * does the reverse decoding. Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{var}`. If a variable contains multiple path segments, such as - * `"{var=foo/*}"` or `"{var=**}"`, when such a variable - * is expanded into a URL path on the client side, all characters except - * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse - * decoding, except "%2F" and "%2f" are left unchanged. - * Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - * Configuration (service config) is a configuration language for configuring - * a gRPC service to become a user-facing product. The service config is - * simply the YAML representation of the `google.api.Service` proto message. - * As an alternative to annotating your proto file, you can configure gRPC - * transcoding in your service config YAML files. You do this by specifying a - * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - * effect as the proto annotation. This can be particularly useful if you have - * a proto that is reused in multiple services. Note that any transcoding - * specified in the service config will override any matching transcoding - * configuration in the proto. Example: http: rules: # - * Selects a gRPC method and applies HttpRule to it. - selector: - * example.v1.Messaging.GetMessage get: - * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON - * conversion must follow the [proto3 - * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - * While the single segment variable follows the semantics of [RFC - * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - * Expansion, the multi segment variable **does not** follow RFC 6570 - * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - * does not expand special characters like `?` and `#`, which would lead to - * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for - * multi segment variables. The path variables **must not** refer to any - * repeated or mapped field, because client libraries are not capable of - * handling such variable expansion. The path variables **must not** capture - * the leading "/" character. The reason is that the most common use - * case "{var}" does not capture the leading "/" - * character. For consistency, all path variables must share the same - * behavior. Repeated message fields must not be mapped to URL query - * parameters, because no client library can support such complicated mapping. - * If an API needs to use a JSON array for request or response body, it can - * map the request or response body to a repeated field. However, some gRPC - * Transcoding implementations may not support this feature. + * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** - * Additional HTTP bindings for the selector. Nested bindings must not - * contain an `additional_bindings` field themselves (that is, the nesting - * may only be one level deep). + * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; /** - * The name of the request field whose value is mapped to the HTTP request - * body, or `*` for mapping all request fields not captured by the path - * pattern to the HTTP body, or omitted for not having any HTTP request - * body. NOTE: the referred field must be present at the top-level of the - * request message type. + * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ body?: string; /** - * The custom pattern is used for specifying an HTTP method that is not - * included in the `pattern` field, such as HEAD, or "*" to leave - * the HTTP method unspecified for this rule. The wild-card rule is useful - * for services that provide content to Web (HTML) clients. + * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ custom?: Schema$CustomHttpPattern; /** @@ -1064,8 +634,7 @@ export namespace servicenetworking_v1beta { */ delete?: string; /** - * Maps to HTTP GET. Used for listing and getting information about - * resources. + * Maps to HTTP GET. Used for listing and getting information about resources. */ get?: string; /** @@ -1081,15 +650,11 @@ export namespace servicenetworking_v1beta { */ put?: string; /** - * Optional. The name of the response field whose value is mapped to the - * HTTP response body. When omitted, the entire response message will be - * used as the HTTP response body. NOTE: The referred field must be present - * at the top-level of the response message type. + * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ responseBody?: string; /** - * Selects a method to which this rule applies. Refer to selector for - * syntax details. + * Selects a method to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -1111,8 +676,7 @@ export namespace servicenetworking_v1beta { valueType?: string; } /** - * ListConnectionsResponse is the response to list peering states for the - * given service and consumer project. + * ListConnectionsResponse is the response to list peering states for the given service and consumer project. */ export interface Schema$ListConnectionsResponse { /** @@ -1121,82 +685,49 @@ export namespace servicenetworking_v1beta { connections?: Schema$Connection[]; } /** - * A description of a log type. Example in YAML format: - name: - * library.googleapis.com/activity_history description: The history of - * borrowing and returning library items. display_name: Activity labels: - * - key: /customer_id description: Identifier of a library customer + * A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer */ export interface Schema$LogDescriptor { /** - * A human-readable description of this log. This information appears in the - * documentation and can contain details. + * A human-readable description of this log. This information appears in the documentation and can contain details. */ description?: string; /** - * The human-readable name for this log. This information appears on the - * user interface and should be concise. + * The human-readable name for this log. This information appears on the user interface and should be concise. */ displayName?: string; /** - * The set of labels that are available to describe a specific log entry. - * Runtime requests that contain labels not specified here are considered - * invalid. + * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ labels?: Schema$LabelDescriptor[]; /** - * The name of the log. It must be less than 512 characters long and can - * include the following characters: upper- and lower-case alphanumeric - * characters [A-Za-z0-9], and punctuation characters including slash, - * underscore, hyphen, period [/_-.]. + * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ name?: string; } /** - * Logging configuration of the service. The following example shows how to - * configure logs to be sent to the producer and consumer projects. In the - * example, the `activity_history` log is sent to both the producer and - * consumer projects, whereas the `purchase_history` log is only sent to the - * producer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. logs: - name: activity_history - * labels: - key: /customer_id - name: purchase_history logging: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - - * purchase_history consumer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history + * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history */ export interface Schema$Logging { /** - * Logging configurations for sending logs to the consumer project. There - * can be multiple consumer destinations, each one must have a different - * monitored resource type. A log can be used in at most one consumer - * destination. + * Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination. */ consumerDestinations?: Schema$LoggingDestination[]; /** - * Logging configurations for sending logs to the producer project. There - * can be multiple producer destinations, each one must have a different - * monitored resource type. A log can be used in at most one producer - * destination. + * Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination. */ producerDestinations?: Schema$LoggingDestination[]; } /** - * Configuration of a specific logging destination (the producer project or - * the consumer project). + * Configuration of a specific logging destination (the producer project or the consumer project). */ export interface Schema$LoggingDestination { /** - * Names of the logs to be sent to this destination. Each name must be - * defined in the Service.logs section. If the log name is not a domain - * scoped name, it will be automatically prefixed with the service name - * followed by "/". + * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ logs?: string[]; /** - * The monitored resource type. The type must be defined in the - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ monitoredResource?: string; } @@ -1234,9 +765,7 @@ export namespace servicenetworking_v1beta { syntax?: string; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1244,28 +773,23 @@ export namespace servicenetworking_v1beta { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * `appengine.googleapis.com/http/server/response_latencies` metric type has - * a label for the HTTP response code, `response_code`, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of `metric_kind` and `value_type` might not be - * supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string; /** @@ -1273,47 +797,15 @@ export namespace servicenetworking_v1beta { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * `custom.googleapis.com` or `external.googleapis.com`. Metric types - * should use a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported - * units are a subset of [The Unified Code for Units of - * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units - * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute - * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo - * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera - * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` - * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * - * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico - * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` - * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * - * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) - * **Grammar** The grammar also includes these connectors: * `/` division - * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix - * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression - * = Component { "." Component } { "/" Component } ; - * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | - * Annotation | "1" ; Annotation - * = "{" NAME "}" ; Notes: * `Annotation` is just a - * comment if it follows a `UNIT` and is equivalent to `1` if it is used - * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == - * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not - * containing '{' or '}'. * `1` represents dimensionless - * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, - * and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of `metric_kind` and `value_type` might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ valueType?: string; } @@ -1322,77 +814,33 @@ export namespace servicenetworking_v1beta { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * Bind API methods to metrics. Binding a method to a metric causes that - * metric's configured quota behaviors to apply to the method call. + * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. */ export interface Schema$MetricRule { /** - * Metrics to update when the selected methods are called, and the - * associated cost applied to each metric. The key of the map is the metric - * name, and the values are the amount increased for the metric against - * which the quota limits are defined. The value must not be negative. + * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ metricCosts?: {[key: string]: string}; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Declares an API Interface to be included in this interface. The including - * interface must redeclare all the methods from the included interface, but - * documentation and options are inherited as follows: - If after comment and - * whitespace stripping, the documentation string of the redeclared method - * is empty, it will be inherited from the original method. - Each - * annotation belonging to the service config (http, visibility) which is - * not set in the redeclared method will be inherited. - If an http - * annotation is inherited, the path pattern will be modified as follows. - * Any version prefix will be replaced by the version of the including - * interface plus the root path if specified. Example of a simple mixin: - * package google.acl.v1; service AccessControl { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } - * package google.storage.v2; service Storage { // rpc - * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc - * GetData(GetDataRequest) returns (Data) { option - * (google.api.http).get = "/v2/{resource=**}"; } } - * Example of a mixin configuration: apis: - name: - * google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl The mixin construct implies that all methods - * in `AccessControl` are also declared with same name and request/response - * types in `Storage`. A documentation generator or annotation processor will - * see the effective `Storage.GetAcl` method after inherting documentation and - * annotations as follows: service Storage { // Get the underlying - * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... - * } Note how the version in the path pattern changed from `v1` to `v2`. If - * the `root` field in the mixin is specified, it should be a relative path - * under which inherited HTTP paths are placed. Example: apis: - - * name: google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl root: acls This implies the following - * inherited HTTP annotation: service Storage { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; - * } ... } + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } */ export interface Schema$Mixin { /** @@ -1400,149 +848,80 @@ export namespace servicenetworking_v1beta { */ name?: string; /** - * If non-empty specifies a path under which inherited HTTP paths are - * rooted. + * If non-empty specifies a path under which inherited HTTP paths are rooted. */ root?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * `"gce_instance"` and specifies the use of the labels - * `"instance_id"` and `"zone"` to identify particular VM - * instances. Different APIs can support different monitored resource types. - * APIs generally provide a `list` method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, `"Google - * Cloud SQL Database"`. + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels `"database_id"` and - * `"zone"`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` - * where {type} is the value of the `type` field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format `"monitoredResourceDescriptors/{type}"`. + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ name?: string; /** - * Required. The monitored resource type. For example, the type - * `"cloudsql_database"` represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Monitoring configuration of the service. The example below shows how to - * configure monitored resources and metrics for monitoring. In the example, a - * monitored resource and two metrics are defined. The - * `library.googleapis.com/book/returned_count` metric is sent to both - * producer and consumer projects, whereas the - * `library.googleapis.com/book/overdue_count` metric is only sent to the - * consumer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. metrics: - name: - * library.googleapis.com/book/returned_count metric_kind: DELTA - * value_type: INT64 labels: - key: /customer_id - name: - * library.googleapis.com/book/overdue_count metric_kind: GAUGE - * value_type: INT64 labels: - key: /customer_id monitoring: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count consumer_destinations: - - * monitored_resource: library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count - - * library.googleapis.com/book/overdue_count + * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count */ export interface Schema$Monitoring { /** - * Monitoring configurations for sending metrics to the consumer project. - * There can be multiple consumer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ consumerDestinations?: Schema$MonitoringDestination[]; /** - * Monitoring configurations for sending metrics to the producer project. - * There can be multiple producer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ producerDestinations?: Schema$MonitoringDestination[]; } /** - * Configuration of a specific monitoring destination (the producer project or - * the consumer project). + * Configuration of a specific monitoring destination (the producer project or the consumer project). */ export interface Schema$MonitoringDestination { /** - * Types of the metrics to report to this monitoring destination. Each type - * must be defined in Service.metrics section. + * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * OAuth scopes are a way to define data and permissions on data. For example, - * there are scopes defined for "Read-only access to Google - * Calendar" and "Access to Cloud Platform". Users can consent - * to a scope for an application, giving it permission to access that data on - * their behalf. OAuth scope specifications should be fairly coarse grained; - * a user will need to see and understand the text description of what your - * scope means. In most cases: use one or at most two OAuth scopes for an - * entire family of products. If your product has multiple APIs, you should - * probably be sharing the OAuth scope across all of those APIs. When you - * need finer grained OAuth consent screens: talk with your product management - * about how developers will use them in practice. Please note that even - * though each of the canonical scopes is enough for a request to be accepted - * and passed to the backend, a request can still fail due to the backend - * requiring additional scopes or permissions. + * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. */ export interface Schema$OAuthRequirements { /** - * The list of publicly documented OAuth scopes that are allowed access. An - * OAuth token containing any of these scopes will be accepted. Example: - * canonical_scopes: https://www.googleapis.com/auth/calendar, - * https://www.googleapis.com/auth/calendar.read + * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ canonicalScopes?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1550,103 +929,50 @@ export namespace servicenetworking_v1beta { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ export interface Schema$Option { /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * `"map_entry"`. For custom options, it should be the - * fully-qualified name. For example, `"google.api.http"`. + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ name?: string; /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ value?: {[key: string]: any}; } /** - * Represents a documentation page. A page can contain subpages to represent - * nested documentation set structure. + * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. */ export interface Schema$Page { /** - * The Markdown content of the page. You can use <code>&#40;== - * include {path} ==&#41;</code> to include content from a - * Markdown file. + * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ content?: string; /** - * The name of the page. It will be used as an identity of the page to - * generate URI of the page, text of the link to this page in navigation, - * etc. The full page name (start from the root page name to this page - * concatenated with `.`) can be used as reference to the page in your - * documentation. For example: <pre><code>pages: - name: - * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - * - name: Java content: &#40;== include tutorial_java.md - * ==&#41; </code></pre> You can reference `Java` page using - * Markdown reference link syntax: `Java`. + * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ name?: string; /** - * Subpages of this page. The order of subpages specified here will be - * honored in the generated docset. + * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ subpages?: Schema$Page[]; } /** - * Quota configuration helps to achieve fairness and budgeting in service - * usage. The metric based quota configuration works this way: - The service - * configuration defines a set of metrics. - For API calls, the - * quota.metric_rules maps methods to metrics with corresponding costs. - - * The quota.limits defines limits on the metrics, which will be used for - * quota checks at runtime. An example quota configuration in yaml format: - * quota: limits: - name: apiWriteQpsPerProject metric: - * library.googleapis.com/write_calls unit: "1/min/{project}" - * # rate limit for consumer projects values: STANDARD: 10000 - * # The metric rules bind all methods to the read_calls metric, # except - * for the UpdateBook and DeleteBook methods. These two methods # are - * mapped to the write_calls metric, with the UpdateBook method # - * consuming at twice rate as the DeleteBook method. metric_rules: - - * selector: "*" metric_costs: - * library.googleapis.com/read_calls: 1 - selector: - * google.example.library.v1.LibraryService.UpdateBook metric_costs: - * library.googleapis.com/write_calls: 2 - selector: - * google.example.library.v1.LibraryService.DeleteBook metric_costs: - * library.googleapis.com/write_calls: 1 Corresponding Metric definition: - * metrics: - name: library.googleapis.com/read_calls display_name: Read - * requests metric_kind: DELTA value_type: INT64 - name: - * library.googleapis.com/write_calls display_name: Write requests - * metric_kind: DELTA value_type: INT64 + * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 */ export interface Schema$Quota { /** @@ -1654,93 +980,52 @@ export namespace servicenetworking_v1beta { */ limits?: Schema$QuotaLimit[]; /** - * List of `MetricRule` definitions, each one mapping a selected method to - * one or more metrics. + * List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */ metricRules?: Schema$MetricRule[]; } /** - * `QuotaLimit` defines a specific limit that applies over a specified - * duration for a limit type. There can be at most one limit for a duration - * and limit type combination defined within a `QuotaGroup`. + * `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. */ export interface Schema$QuotaLimit { /** - * Default number of tokens that can be consumed during the specified - * duration. This is the number of tokens assigned when a client application - * developer activates the service for his/her project. Specifying a value - * of 0 will block all requests. This can be used if you are provisioning - * quota to selected consumers and blocking others. Similarly, a value of -1 - * will indicate an unlimited quota. No other negative values are allowed. - * Used by group-based quotas only. + * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ defaultLimit?: string; /** - * Optional. User-visible, extended description for this quota limit. Should - * be used only when more context is needed to understand this limit than - * provided by the limit's display name (see: `display_name`). + * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ description?: string; /** - * User-visible display name for this limit. Optional. If not set, the UI - * will provide a default display name based on the quota configuration. - * This field can be used to override the default display name generated - * from the configuration. + * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ displayName?: string; /** - * Duration of this limit in textual notation. Example: "100s", - * "24h", "1d". For duration longer than a day, only - * multiple of days is supported. We support only "100s" and - * "1d" for now. Additional support will be added in the future. - * "0" indicates indefinite duration. Used by group-based quotas - * only. + * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. */ duration?: string; /** - * Free tier value displayed in the Developers Console for this limit. The - * free tier is the number of tokens that will be subtracted from the billed - * amount when billing is enabled. This field can only be set on a limit - * with duration "1d", in a billable group; it is invalid on any - * other limit. If this field is not set, it defaults to 0, indicating that - * there is no free tier for this service. Used by group-based quotas only. + * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ freeTier?: string; /** - * Maximum number of tokens that can be consumed during the specified - * duration. Client application developers can override the default limit up - * to this maximum. If specified, this value cannot be set to a value less - * than the default limit. If not specified, it is set to the default limit. - * To allow clients to apply overrides with no upper bound, set this to -1, - * indicating unlimited maximum quota. Used by group-based quotas only. + * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ maxLimit?: string; /** - * The name of the metric this quota limit applies to. The quota limits with - * the same metric will be checked together during runtime. The metric must - * be defined within the service config. + * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ metric?: string; /** - * Name of the quota limit. The name must be provided, and it must be - * unique within the service. The name can only include alphanumeric - * characters as well as '-'. The maximum length of the limit name - * is 64 characters. + * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ name?: string; /** - * Specify the unit of the quota limit. It uses the same syntax as - * Metric.unit. The supported unit kinds are determined by the quota backend - * system. Here are some examples: * "1/min/{project}" for quota - * per minute per project. Note: the order of unit components is - * insignificant. The "1" at the beginning is required to follow - * the metric unit syntax. + * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ unit?: string; /** - * Tiered limit values. You must specify this as a key:value pair, with an - * integer value that is the maximum number of requests allowed for the - * specified unit. Currently only STANDARD is supported. + * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ values?: {[key: string]: string}; } @@ -1749,14 +1034,11 @@ export namespace servicenetworking_v1beta { */ export interface Schema$Range { /** - * CIDR range in "10.x.x.x/y" format that is within the allocated - * ranges and currently unused. + * CIDR range in "10.x.x.x/y" format that is within the allocated ranges and currently unused. */ ipCidrRange?: string; /** - * In the Shared VPC host project, the VPC network that's peered with - * the consumer network. For example: - * `projects/1234321/global/networks/host-network` + * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ network?: string; } @@ -1765,42 +1047,20 @@ export namespace servicenetworking_v1beta { */ export interface Schema$SearchRangeRequest { /** - * Required. The prefix length of the IP range. Use usual CIDR range - * notation. For example, '30' to find unused x.x.x.x/30 CIDR range. - * Actual range will be determined using allocated range for the consumer - * peered network and returned in the result. + * Required. The prefix length of the IP range. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be determined using allocated range for the consumer peered network and returned in the result. */ ipPrefixLength?: number; /** - * Network name in the consumer project. This network must have been - * already peered with a shared VPC network using CreateConnection method. - * Must be in a form 'projects/{project}/global/networks/{network}'. - * {project} is a project number, as in '12345' {network} is network - * name. + * Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/{project}/global/networks/{network}'. {project} is a project number, as in '12345' {network} is network name. */ network?: string; } /** - * `Service` is the root object of Google service configuration schema. It - * describes basic information about a service, such as the name and the - * title, and delegates other aspects to sub-sections. Each sub-section is - * either a proto message or a repeated proto message that configures a - * specific aspect, such as auth. See each proto message definition for - * details. Example: type: google.api.Service config_version: 3 - * name: calendar.googleapis.com title: Google Calendar API apis: - - * name: google.calendar.v3.Calendar authentication: providers: - - * id: google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Service { /** - * A list of API interfaces exported by this service. Only the `name` field - * of the google.protobuf.Api needs to be provided by the configuration - * author, as the remaining fields will be derived from the IDL during the - * normalization process. It is an error to specify an API interface here - * which cannot be resolved against the associated IDL files. + * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; /** @@ -1816,10 +1076,7 @@ export namespace servicenetworking_v1beta { */ billing?: Schema$Billing; /** - * The semantic version of the service configuration. The config version - * affects the interpretation of the service configuration. For example, - * certain features are enabled by default for certain config versions. The - * latest config version is `3`. + * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ configVersion?: number; /** @@ -1839,30 +1096,19 @@ export namespace servicenetworking_v1beta { */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. If this is empty, then an endpoint - * with the same name as the service is automatically generated to service - * all defined APIs. + * Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */ endpoints?: Schema$Endpoint[]; /** - * A list of all enum types included in this API service. Enums referenced - * directly or indirectly by the `apis` are automatically included. Enums - * which are not referenced but shall be included should be listed here by - * name. Example: enums: - name: google.someapi.v1.SomeEnum + * A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum */ enums?: Schema$Enum[]; - /** - * Experimental configuration. - */ - experimental?: Schema$Experimental; /** * HTTP configuration. */ http?: Schema$Http; /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. Must be no longer than 60 characters. + * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ id?: string; /** @@ -1878,8 +1124,7 @@ export namespace servicenetworking_v1beta { */ metrics?: Schema$MetricDescriptor[]; /** - * Defines the monitored resources used by this service. This is required by - * the Service.monitoring and Service.logging configurations. + * Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */ monitoredResources?: Schema$MonitoredResourceDescriptor[]; /** @@ -1887,10 +1132,7 @@ export namespace servicenetworking_v1beta { */ monitoring?: Schema$Monitoring; /** - * The service name, which is a DNS-like logical identifier for the service, - * such as `calendar.googleapis.com`. The service name typically goes - * through DNS verification to make sure the owner of the service also owns - * the DNS name. + * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ name?: string; /** @@ -1910,11 +1152,7 @@ export namespace servicenetworking_v1beta { */ systemParameters?: Schema$SystemParameters; /** - * A list of all proto message types included in this API service. It serves - * similar purpose as [google.api.Service.types], except that these types - * are not needed by user-defined APIs. Therefore, they will not show up in - * the generated discovery doc. This field should only be used to define - * system APIs in ESF. + * A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. */ systemTypes?: Schema$Type[]; /** @@ -1922,11 +1160,7 @@ export namespace servicenetworking_v1beta { */ title?: string; /** - * A list of all proto message types included in this API service. Types - * referenced directly or indirectly by the `apis` are automatically - * included. Messages which are not referenced but shall be included, such - * as types used by the `google.protobuf.Any` type, should be listed here by - * name. Example: types: - name: google.protobuf.Int32 + * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ types?: Schema$Type[]; /** @@ -1935,14 +1169,11 @@ export namespace servicenetworking_v1beta { usage?: Schema$Usage; } /** - * `SourceContext` represents information about the source of a protobuf - * element, like the file in which it is defined. + * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ export interface Schema$SourceContext { /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * `"google/protobuf/source_context.proto"`. + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ fileName?: string; } @@ -1956,40 +1187,7 @@ export namespace servicenetworking_v1beta { sourceFiles?: Array<{[key: string]: any}>; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1997,20 +1195,16 @@ export namespace servicenetworking_v1beta { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Represents a subnet that was created or discovered by a private access - * management service. + * Represents a subnet that was created or discovered by a private access management service. */ export interface Schema$Subnetwork { /** @@ -2022,78 +1216,50 @@ export namespace servicenetworking_v1beta { */ name?: string; /** - * In the Shared VPC host project, the VPC network that's peered with - * the consumer network. For example: - * `projects/1234321/global/networks/host-network` + * In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` */ network?: string; /** - * This is a discovered subnet that is not within the current consumer - * allocated ranges. + * This is a discovered subnet that is not within the current consumer allocated ranges. */ outsideAllocation?: boolean; } /** - * Define a parameter's name and location. The parameter may be passed as - * either an HTTP header or a URL query parameter, and if both are passed the - * behavior is implementation-dependent. + * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. */ export interface Schema$SystemParameter { /** - * Define the HTTP header name to use for the parameter. It is case - * insensitive. + * Define the HTTP header name to use for the parameter. It is case insensitive. */ httpHeader?: string; /** - * Define the name of the parameter, such as "api_key" . It is - * case sensitive. + * Define the name of the parameter, such as "api_key" . It is case sensitive. */ name?: string; /** - * Define the URL query parameter name to use for the parameter. It is case - * sensitive. + * Define the URL query parameter name to use for the parameter. It is case sensitive. */ urlQueryParameter?: string; } /** - * Define a system parameter rule mapping system parameter definitions to - * methods. + * Define a system parameter rule mapping system parameter definitions to methods. */ export interface Schema$SystemParameterRule { /** - * Define parameters. Multiple names may be defined for a parameter. For a - * given method call, only one of them should be used. If multiple names are - * used the behavior is implementation-dependent. If none of the specified - * names are present the behavior is parameter-dependent. + * Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent. */ parameters?: Schema$SystemParameter[]; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; } /** - * ### System parameter configuration A system parameter is a special kind of - * parameter defined by the API system, not by an individual API. It is - * typically mapped to an HTTP header and/or a URL query parameter. This - * configuration specifies which methods change the names of the system - * parameters. + * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. */ export interface Schema$SystemParameters { /** - * Define system parameters. The parameters defined here will override the - * default parameters implemented by the system. If this field is missing - * from the service config, default system parameters will be used. Default - * system parameters and names is implementation-dependent. Example: define - * api key for all methods system_parameters rules: - - * selector: "*" parameters: - name: api_key - * url_query_parameter: api_key Example: define 2 api key names for a - * specific method. system_parameters rules: - selector: - * "/ListShelves" parameters: - name: - * api_key http_header: Api-Key1 - name: api_key - * http_header: Api-Key2 **NOTE:** All service configuration rules follow - * "last one wins" order. + * Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$SystemParameterRule[]; } @@ -2131,57 +1297,32 @@ export namespace servicenetworking_v1beta { */ export interface Schema$Usage { /** - * The full resource name of a channel used for sending notifications to the - * service producer. Google Service Management currently only supports - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - * channel. To use Google Cloud Pub/Sub as the channel, this must be the - * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name - * format documented in https://cloud.google.com/pubsub/docs/overview. + * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ producerNotificationChannel?: string; /** - * Requirements that must be satisfied before a consumer project can use the - * service. Each requirement is of the form - * <service.name>/<requirement-id>; for example - * 'serviceusage.googleapis.com/billing-enabled'. + * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ requirements?: string[]; /** - * A list of usage rules that apply to individual API methods. **NOTE:** - * All service configuration rules follow "last one wins" order. + * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use - * this rule to configure unregistered calls for the service. Unregistered - * calls are calls that do not contain consumer project identity. (Example: - * calls that do not contain an API key). By default, API methods do not allow - * unregistered calls, and each method call must be identified by a consumer - * project identity. Use this rule to allow/disallow unregistered calls. - * Example of an API that wants to allow unregistered calls for entire - * service. usage: rules: - selector: "*" - * allow_unregistered_calls: true Example of a method that wants to allow - * unregistered calls. usage: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allow_unregistered_calls: true + * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that - * don't identify any user or application. + * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ allowUnregisteredCalls?: boolean; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; /** - * If true, the selected method should skip service control and the control - * plane features, such as quota and billing, will not be available. This - * flag is used by Google Cloud Endpoints to bypass checks for internal - * methods, such as service health check methods. + * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ skipServiceControl?: boolean; } @@ -2194,9 +1335,7 @@ export namespace servicenetworking_v1beta { /** * servicenetworking.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias servicenetworking.operations.get * @memberOf! () * @@ -2288,16 +1427,7 @@ export namespace servicenetworking_v1beta { /** * servicenetworking.services.addSubnetwork - * @desc For service producers, provisions a new subnet in a peered - * service's shared VPC network in the requested region and with the - * requested size that's expressed as a CIDR range (number of leading bits - * of ipV4 network mask). The method checks against the assigned allocated - * ranges to find a non-conflicting IP address range. The method will reuse - * a subnet if subsequent calls contain the same subnet name, region, and - * prefix length. This method will make producer's tenant project to be a - * shared VPC service project as needed. The response from the `get` - * operation will be of type `Subnetwork` if the operation successfully - * completes. + * @desc For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed. The response from the `get` operation will be of type `Subnetwork` if the operation successfully completes. * @alias servicenetworking.services.addSubnetwork * @memberOf! () * @@ -2373,12 +1503,7 @@ export namespace servicenetworking_v1beta { /** * servicenetworking.services.searchRange - * @desc Service producers can use this method to find a currently unused - * range within consumer allocated ranges. This returned range is not - * reserved, and not guaranteed to remain unused. It will validate - * previously provided allocated ranges, find non-conflicting sub-range of - * requested size (expressed in number of leading bits of ipv4 network mask, - * as in CIDR range notation). Operation + * @desc Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation). Operation * @alias servicenetworking.services.searchRange * @memberOf! () * @@ -2454,9 +1579,7 @@ export namespace servicenetworking_v1beta { /** * servicenetworking.services.updateConnections - * @desc Updates the allocated ranges that are assigned to a connection. The - * response from the `get` operation will be of type `Connection` if the - * operation successfully completes. + * @desc Updates the allocated ranges that are assigned to a connection. The response from the `get` operation will be of type `Connection` if the operation successfully completes. * @alias servicenetworking.services.updateConnections * @memberOf! () * @@ -2541,13 +1664,7 @@ export namespace servicenetworking_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A tenant project in the service producer organization, in the - * following format: services/{service}/{collection-id}/{resource-id}. - * {collection-id} is the cloud resource collection type that represents the - * tenant project. Only `projects` are supported. {resource-id} is the - * tenant project numeric id, such as `123456`. {service} the name of the - * peering service, such as `service-peering.example.com`. This service must - * already be enabled in the service consumer's project. + * Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id}/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only `projects` are supported. {resource-id} is the tenant project numeric id, such as `123456`. {service} the name of the peering service, such as `service-peering.example.com`. This service must already be enabled in the service consumer's project. */ parent?: string; @@ -2564,9 +1681,7 @@ export namespace servicenetworking_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. This is in a form services/{service}. {service} the name of the - * private access management service, for example - * 'service-peering.example.com'. + * Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'. */ parent?: string; @@ -2583,20 +1698,15 @@ export namespace servicenetworking_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If a previously defined allocated range is removed, force flag must be - * set to true. + * If a previously defined allocated range is removed, force flag must be set to true. */ force?: boolean; /** - * The service producer peering service that is managing peering - * connectivity for a service producer organization. For Google services - * that support this functionality, this is - * `services/servicenetworking.googleapis.com`. + * The service producer peering service that is managing peering connectivity for a service producer organization. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com`. */ name?: string; /** - * The update mask. If this is omitted, it defaults to "*". You can only - * update the listed peering ranges. + * The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges. */ updateMask?: string; @@ -2614,15 +1724,7 @@ export namespace servicenetworking_v1beta { /** * servicenetworking.services.connections.create - * @desc Creates a private connection that establishes a VPC Network Peering - * connection to a VPC network in the service producer's organization. The - * administrator of the service consumer's VPC network invokes this method. - * The administrator must assign one or more allocated IP ranges for - * provisioning subnetworks in the service producer's VPC network. This - * connection is used for all supported services in the service producer's - * organization, so it only needs to be invoked once. The response from the - * `get` operation will be of type `Connection` if the operation - * successfully completes. + * @desc Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once. The response from the `get` operation will be of type `Connection` if the operation successfully completes. * @alias servicenetworking.services.connections.create * @memberOf! () * @@ -2698,8 +1800,7 @@ export namespace servicenetworking_v1beta { /** * servicenetworking.services.connections.list - * @desc List the private connections that are configured in a service - * consumer's VPC network. + * @desc List the private connections that are configured in a service consumer's VPC network. * @alias servicenetworking.services.connections.list * @memberOf! () * @@ -2784,9 +1885,7 @@ export namespace servicenetworking_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The service that is managing peering connectivity for a service - * producer's organization. For Google services that support this - * functionality, this value is `services/servicenetworking.googleapis.com`. + * The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. */ parent?: string; @@ -2803,20 +1902,11 @@ export namespace servicenetworking_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of service consumer's VPC network that's connected with service - * producer network through a private connection. The network name must be - * in the following format: `projects/{project}/global/networks/{network}`. - * {project} is a project number, such as in `12345` that includes the VPC - * service consumer's VPC network. {network} is the name of the service - * consumer's VPC network. + * The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: `projects/{project}/global/networks/{network}`. {project} is a project number, such as in `12345` that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network. */ network?: string; /** - * The service that is managing peering connectivity for a service - * producer's organization. For Google services that support this - * functionality, this value is `services/servicenetworking.googleapis.com`. - * If you specify `-` as the parameter value, all configured public peering - * services are listed. + * The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `-` as the parameter value, all configured public peering services are listed. */ parent?: string; } diff --git a/src/apis/serviceusage/package.json b/src/apis/serviceusage/package.json index ab040c3f03b..a230647367c 100644 --- a/src/apis/serviceusage/package.json +++ b/src/apis/serviceusage/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index e2b76ca5d9e..47e509adda0 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace serviceusage_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace serviceusage_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace serviceusage_v1 { /** * Service Usage API * - * Enables services that service consumers want to use on Google Cloud - * Platform, lists the available or enabled services, or disables services - * that service consumers no longer use. + * Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace serviceusage_v1 { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.services = new Resource$Services(this.context); @@ -123,14 +120,7 @@ export namespace serviceusage_v1 { } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also - * described as "protocol buffer services" in some contexts, such as - * by the "service" keyword in a .proto file, but they are different - * from API Services, which represent a concrete implementation of an - * interface as opposed to simply a description of methods and bindings. They - * are also sometimes simply referred to as "APIs" in other - * contexts, such as the name of this message itself. See - * https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ export interface Schema$Api { /** @@ -142,8 +132,7 @@ export namespace serviceusage_v1 { */ mixins?: Schema$Mixin[]; /** - * The fully qualified name of this interface, including package name - * followed by the interface's simple name. + * The fully qualified name of this interface, including package name followed by the interface's simple name. */ name?: string; /** @@ -151,8 +140,7 @@ export namespace serviceusage_v1 { */ options?: Schema$Option[]; /** - * Source context for the protocol buffer service represented by this - * message. + * Source context for the protocol buffer service represented by this message. */ sourceContext?: Schema$SourceContext; /** @@ -160,32 +148,12 @@ export namespace serviceusage_v1 { */ syntax?: string; /** - * A version string for this interface. If specified, must have the form - * `major-version.minor-version`, as in `1.10`. If the minor version is - * omitted, it defaults to zero. If the entire version field is empty, the - * major version is derived from the package name, as outlined below. If the - * field is not empty, the version in the package name will be verified to - * be consistent with what is provided here. The versioning schema uses - * [semantic versioning](http://semver.org) where the major version number - * indicates a breaking change and the minor version an additive, - * non-breaking change. Both version numbers are signals to users what to - * expect from different versions, and should be carefully chosen based on - * the product plan. The major version is also reflected in the package - * name of the interface, which must end in `v<major-version>`, as in - * `google.feature.v1`. For major versions 0 and 1, the suffix can be - * omitted. Zero major versions must only be used for experimental, non-GA - * interfaces. + * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ version?: string; } /** - * `Authentication` defines the authentication configuration for an API. - * Example for an API targeted for external use: name: - * calendar.googleapis.com authentication: providers: - id: - * google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Authentication { /** @@ -193,18 +161,12 @@ export namespace serviceusage_v1 { */ providers?: Schema$AuthProvider[]; /** - * A list of authentication rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$AuthenticationRule[]; } /** - * Authentication rules for the service. By default, if a method has any - * authentication requirements, every request must include a valid credential - * matching one of the requirements. It's an error to include more than - * one kind of credential in a single request. If a method doesn't have - * any auth requirements, request credentials will be ignored. + * Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored. */ export interface Schema$AuthenticationRule { /** @@ -220,96 +182,45 @@ export namespace serviceusage_v1 { */ requirements?: Schema$AuthRequirement[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Configuration of authorization. This section determines the authorization - * provider, if unspecified, then no authorization check will be done. - * Example: experimental: authorization: provider: - * firebaserules.googleapis.com - */ - export interface Schema$AuthorizationConfig { - /** - * The name of the authorization provider, such as - * firebaserules.googleapis.com. - */ - provider?: string; - } - /** - * Configuration for an authentication provider, including support for [JSON - * Web Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthProvider { /** - * The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * Redirect URL if JWT token is required but not present or is expired. - * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ authorizationUrl?: string; /** - * The unique identifier of the auth provider. It will be referred to by - * `AuthRequirement.provider_id`. Example: "bookstore_auth". + * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ id?: string; /** - * Identifies the principal that issued the JWT. See - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - * Usually a URL or an email address. Example: - * https://securetoken.google.com Example: - * 1234567-compute@developer.gserviceaccount.com + * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ issuer?: string; /** - * URL of the provider's public key set to validate signature of the - * JWT. See [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - * Optional if the key set document: - can be retrieved from [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: - * https://www.googleapis.com/oauth2/v1/certs + * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string; } /** - * User-defined authentication requirements, including support for [JSON Web - * Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthRequirement { /** - * NOTE: This will be deprecated soon, once AuthProvider.audiences is - * implemented and accepted in all the runtime components. The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * id from authentication provider. Example: provider_id: - * bookstore_auth + * id from authentication provider. Example: provider_id: bookstore_auth */ providerId?: string; } @@ -318,9 +229,7 @@ export namespace serviceusage_v1 { */ export interface Schema$Backend { /** - * A list of API backend rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$BackendRule[]; } @@ -333,9 +242,7 @@ export namespace serviceusage_v1 { */ address?: string; /** - * The number of seconds to wait for a response from a request. The default - * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 - * seconds. + * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ deadline?: number; /** @@ -343,19 +250,16 @@ export namespace serviceusage_v1 { */ jwtAudience?: string; /** - * Minimum deadline in seconds needed for this method. Calls having deadline - * value lower than this will be rejected. + * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ minDeadline?: number; /** - * The number of seconds to wait for the completion of a long running - * operation. The default is no deadline. + * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ operationDeadline?: number; pathTranslation?: string; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -382,25 +286,16 @@ export namespace serviceusage_v1 { */ export interface Schema$BatchEnableServicesRequest { /** - * The identifiers of the services to enable on the project. A valid - * identifier would be: serviceusage.googleapis.com Enabling services - * requires that each service is public or is shared with the user enabling - * the service. Two or more services must be specified. To enable a single - * service, use the `EnableService` method instead. A single request can - * enable a maximum of 20 services at a time. If more than 20 services are - * specified, the request will fail, and no state changes will occur. + * The identifiers of the services to enable on the project. A valid identifier would be: serviceusage.googleapis.com Enabling services requires that each service is public or is shared with the user enabling the service. Two or more services must be specified. To enable a single service, use the `EnableService` method instead. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur. */ serviceIds?: string[]; } /** - * Response message for the `BatchEnableServices` method. This response - * message is assigned to the `response` field of the returned Operation when - * that operation is done. + * Response message for the `BatchEnableServices` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$BatchEnableServicesResponse { /** - * If allow_partial_success is true, and one or more services could not be - * enabled, this field contains the details about each failure. + * If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure. */ failures?: Schema$EnableFailure[]; /** @@ -409,39 +304,24 @@ export namespace serviceusage_v1 { services?: Schema$GoogleApiServiceusageV1Service[]; } /** - * Billing related configuration of the service. The following example shows - * how to configure monitored resources and metrics for billing: - * monitored_resources: - type: library.googleapis.com/branch labels: - - * key: /city description: The city where the library branch is - * located in. - key: /name description: The name of the branch. - * metrics: - name: library.googleapis.com/book/borrowed_count - * metric_kind: DELTA value_type: INT64 billing: - * consumer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/borrowed_count + * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** - * Billing configurations for sending metrics to the consumer project. There - * can be multiple consumer destinations per service, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. + * Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. */ consumerDestinations?: Schema$BillingDestination[]; } /** - * Configuration of a specific billing destination (Currently only support - * bill against consumer project). + * Configuration of a specific billing destination (Currently only support bill against consumer project). */ export interface Schema$BillingDestination { /** - * Names of the metrics to report to this billing destination. Each name - * must be defined in Service.metrics section. + * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } @@ -450,44 +330,24 @@ export namespace serviceusage_v1 { */ export interface Schema$CancelOperationRequest {} /** - * `Context` defines which contexts an API requests. Example: context: - * rules: - selector: "*" requested: - - * google.rpc.context.ProjectContext - - * google.rpc.context.OriginContext The above specifies that all methods in - * the API request `google.rpc.context.ProjectContext` and - * `google.rpc.context.OriginContext`. Available context types are defined in - * package `google.rpc.context`. This also provides mechanism to whitelist - * any protobuf message extension that can be sent in grpc metadata using - * “x-goog-ext-<extension_id>-bin” and - * “x-goog-ext-<extension_id>-jspb” format. For example, list any - * service specific protobuf types that can appear in grpc metadata as follows - * in your yaml file: Example: context: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allowed_request_extensions: - google.foo.v1.NewExtension - * allowed_response_extensions: - google.foo.v1.NewExtension You can - * also specify extension ID instead of fully qualified extension name here. + * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ export interface Schema$Context { /** - * A list of RPC context rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$ContextRule[]; } /** - * A context rule provides information about the context for an individual API - * element. + * A context rule provides information about the context for an individual API element. */ export interface Schema$ContextRule { /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from client to backend. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ allowedRequestExtensions?: string[]; /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from backend to client. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ allowedResponseExtensions?: string[]; /** @@ -499,39 +359,29 @@ export namespace serviceusage_v1 { */ requested?: string[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Selects and configures the service controller used by the service. The - * service controller handles features like abuse, quota, billing, logging, - * monitoring, etc. + * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. */ export interface Schema$Control { /** - * The service control environment to use. If empty, no control plane - * feature (like quota and billing) will be enabled. + * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ environment?: string; } /** - * Customize service error responses. For example, list any service specific - * protobuf types that can appear in error detail lists of error responses. - * Example: custom_error: types: - google.foo.v1.CustomError - * - google.foo.v1.AnotherError + * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError */ export interface Schema$CustomError { /** - * The list of custom error rules that apply to individual API messages. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$CustomErrorRule[]; /** - * The list of custom error detail types, e.g. - * 'google.foo.v1.CustomError'. + * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ types?: string[]; } @@ -540,13 +390,11 @@ export namespace serviceusage_v1 { */ export interface Schema$CustomErrorRule { /** - * Mark this message as possible payload in error response. Otherwise, - * objects of this type will be filtered when they appear in error payload. + * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ isErrorType?: boolean; /** - * Selects messages to which this rule applies. Refer to selector for - * syntax details. + * Selects messages to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -568,18 +416,12 @@ export namespace serviceusage_v1 { */ export interface Schema$DisableServiceRequest { /** - * Indicates if services that are enabled and which depend on this service - * should also be disabled. If not set, an error will be generated if any - * enabled services depend on the service to be disabled. When set, the - * service, and any enabled services that depend on it, will be disabled - * together. + * Indicates if services that are enabled and which depend on this service should also be disabled. If not set, an error will be generated if any enabled services depend on the service to be disabled. When set, the service, and any enabled services that depend on it, will be disabled together. */ disableDependentServices?: boolean; } /** - * Response message for the `DisableService` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `DisableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$DisableServiceResponse { /** @@ -588,42 +430,7 @@ export namespace serviceusage_v1 { service?: Schema$GoogleApiServiceusageV1Service; } /** - * `Documentation` provides the information for describing a service. Example: - * <pre><code>documentation: summary: > The Google - * Calendar API gives access to most calendar features. pages: - name: - * Overview content: &#40;== include google/foo/overview.md - * ==&#41; - name: Tutorial content: &#40;== include - * google/foo/tutorial.md ==&#41; subpages; - name: Java content: - * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - - * selector: google.calendar.Calendar.Get description: > ... - - * selector: google.calendar.Calendar.Put description: > ... - * </code></pre> Documentation is provided in markdown syntax. In - * addition to standard markdown features, definition lists, tables and fenced - * code blocks are supported. Section headers can be provided and are - * interpreted relative to the section nesting of the context where a - * documentation fragment is embedded. Documentation from the IDL is merged - * with documentation defined via the config at normalization time, where - * documentation provided by config rules overrides IDL provided. A number of - * constructs specific to the API platform are supported in documentation - * text. In order to reference a proto element, the following notation can be - * used: - * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> - * To override the display text used for the link, this can be used: - * <pre><code>&#91;display - * text]&#91;fully.qualified.proto.name]</code></pre> Text can - * be excluded from doc using the following notation: - * <pre><code>&#40;-- internal comment - * --&#41;</code></pre> A few directives are available in - * documentation. Note that directives must appear on a single line to be - * properly identified. The `include` directive includes a markdown file from - * an external source: <pre><code>&#40;== include path/to/file - * ==&#41;</code></pre> The `resource_for` directive marks a - * message to be the resource of a collection in REST view. If it is not - * specified, tools attempt to infer the resource from the operations in a - * collection: <pre><code>&#40;== resource_for - * v1.shelves.books ==&#41;</code></pre> The directive - * `suppress_warning` does not directly affect documentation and is documented - * together with service config validation. + * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -631,14 +438,7 @@ export namespace serviceusage_v1 { */ documentationRootUrl?: string; /** - * Declares a single overview page. For example: - * <pre><code>documentation: summary: ... overview: - * &#40;== include overview.md ==&#41; </code></pre> - * This is a shortcut for the following declaration (using pages style): - * <pre><code>documentation: summary: ... pages: - name: - * Overview content: &#40;== include overview.md ==&#41; - * </code></pre> Note: you cannot specify both `overview` field - * and `pages` field. + * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ overview?: string; /** @@ -646,14 +446,11 @@ export namespace serviceusage_v1 { */ pages?: Schema$Page[]; /** - * A list of documentation rules that apply to individual API elements. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; /** - * A short summary of what the service does. Can only be provided by plain - * text. + * A short summary of what the service does. Can only be provided by plain text. */ summary?: string; } @@ -662,8 +459,7 @@ export namespace serviceusage_v1 { */ export interface Schema$DocumentationRule { /** - * Deprecation description of the selected element(s). It can be provided if - * an element is marked as `deprecated`. + * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ deprecationDescription?: string; /** @@ -671,22 +467,12 @@ export namespace serviceusage_v1 { */ description?: string; /** - * The selector is a comma-separated list of patterns. Each pattern is a - * qualified name of the element which may end in "*", indicating - * a wildcard. Wildcards are only allowed at the end and for a whole - * component of the qualified name, i.e. "foo.*" is ok, but not - * "foo.b*" or "foo.*.bar". A wildcard will match one or - * more components. To specify a default for all applicable elements, the - * whole pattern "*" is used. + * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ selector?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -707,9 +493,7 @@ export namespace serviceusage_v1 { */ export interface Schema$EnableServiceRequest {} /** - * Response message for the `EnableService` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `EnableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$EnableServiceResponse { /** @@ -718,31 +502,15 @@ export namespace serviceusage_v1 { service?: Schema$GoogleApiServiceusageV1Service; } /** - * `Endpoint` describes a network endpoint that serves a set of APIs. A - * service may expose any number of endpoints, and all endpoints share the - * same service configuration, such as quota configuration and monitoring - * configuration. Example service configuration: name: - * library-example.googleapis.com endpoints: # Below entry makes - * 'google.example.library.v1.Library' # API be served from - * endpoint address library-example.googleapis.com. # It also allows - * HTTP OPTIONS calls to be passed to the backend, for # it to decide - * whether the subsequent cross-origin request is # allowed to proceed. - * - name: library-example.googleapis.com allow_cors: true + * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ export interface Schema$Endpoint { /** - * DEPRECATED: This field is no longer supported. Instead of using aliases, - * please specify multiple google.api.Endpoint for each of the intended - * aliases. Additional names that this endpoint will be hosted on. + * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ aliases?: string[]; /** - * Allowing - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - * cross-domain traffic, would allow the backends served from this endpoint - * to receive and respond to HTTP OPTIONS requests. The response will be - * used by the browser to determine whether the subsequent cross-origin - * request is allowed to proceed. + * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ allowCors?: boolean; /** @@ -754,11 +522,7 @@ export namespace serviceusage_v1 { */ name?: string; /** - * The specification of an Internet routable address of API frontend that - * will handle requests to this [API - * Endpoint](https://cloud.google.com/apis/design/glossary). It should be - * either a valid IPv4 address or a fully-qualified domain name. For - * example, "8.8.8.8" or "myservice.appspot.com". + * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ target?: string; } @@ -804,16 +568,6 @@ export namespace serviceusage_v1 { */ options?: Schema$Option[]; } - /** - * Experimental service configuration. These configuration options can only be - * used by whitelisted users. - */ - export interface Schema$Experimental { - /** - * Authorization configuration. - */ - authorization?: Schema$AuthorizationConfig; - } /** * A single field of a message type. */ @@ -843,9 +597,7 @@ export namespace serviceusage_v1 { */ number?: number; /** - * The index of the field type in `Type.oneofs`, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. + * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ oneofIndex?: number; /** @@ -857,32 +609,16 @@ export namespace serviceusage_v1 { */ packed?: boolean; /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ typeUrl?: string; } /** - * `Service` is the root object of Google service configuration schema. It - * describes basic information about a service, such as the name and the - * title, and delegates other aspects to sub-sections. Each sub-section is - * either a proto message or a repeated proto message that configures a - * specific aspect, such as auth. See each proto message definition for - * details. Example: type: google.api.Service config_version: 3 - * name: calendar.googleapis.com title: Google Calendar API apis: - - * name: google.calendar.v3.Calendar authentication: providers: - - * id: google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$GoogleApiService { /** - * A list of API interfaces exported by this service. Only the `name` field - * of the google.protobuf.Api needs to be provided by the configuration - * author, as the remaining fields will be derived from the IDL during the - * normalization process. It is an error to specify an API interface here - * which cannot be resolved against the associated IDL files. + * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; /** @@ -898,10 +634,7 @@ export namespace serviceusage_v1 { */ billing?: Schema$Billing; /** - * The semantic version of the service configuration. The config version - * affects the interpretation of the service configuration. For example, - * certain features are enabled by default for certain config versions. The - * latest config version is `3`. + * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ configVersion?: number; /** @@ -921,30 +654,19 @@ export namespace serviceusage_v1 { */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. If this is empty, then an endpoint - * with the same name as the service is automatically generated to service - * all defined APIs. + * Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */ endpoints?: Schema$Endpoint[]; /** - * A list of all enum types included in this API service. Enums referenced - * directly or indirectly by the `apis` are automatically included. Enums - * which are not referenced but shall be included should be listed here by - * name. Example: enums: - name: google.someapi.v1.SomeEnum + * A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum */ enums?: Schema$Enum[]; - /** - * Experimental configuration. - */ - experimental?: Schema$Experimental; /** * HTTP configuration. */ http?: Schema$Http; /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. Must be no longer than 60 characters. + * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ id?: string; /** @@ -960,8 +682,7 @@ export namespace serviceusage_v1 { */ metrics?: Schema$MetricDescriptor[]; /** - * Defines the monitored resources used by this service. This is required by - * the Service.monitoring and Service.logging configurations. + * Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */ monitoredResources?: Schema$MonitoredResourceDescriptor[]; /** @@ -969,10 +690,7 @@ export namespace serviceusage_v1 { */ monitoring?: Schema$Monitoring; /** - * The service name, which is a DNS-like logical identifier for the service, - * such as `calendar.googleapis.com`. The service name typically goes - * through DNS verification to make sure the owner of the service also owns - * the DNS name. + * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ name?: string; /** @@ -992,11 +710,7 @@ export namespace serviceusage_v1 { */ systemParameters?: Schema$SystemParameters; /** - * A list of all proto message types included in this API service. It serves - * similar purpose as [google.api.Service.types], except that these types - * are not needed by user-defined APIs. Therefore, they will not show up in - * the generated discovery doc. This field should only be used to define - * system APIs in ESF. + * A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. */ systemTypes?: Schema$Type[]; /** @@ -1004,11 +718,7 @@ export namespace serviceusage_v1 { */ title?: string; /** - * A list of all proto message types included in this API service. Types - * referenced directly or indirectly by the `apis` are automatically - * included. Messages which are not referenced but shall be included, such - * as types used by the `google.protobuf.Any` type, should be listed here by - * name. Example: types: - name: google.protobuf.Int32 + * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ types?: Schema$Type[]; /** @@ -1021,8 +731,7 @@ export namespace serviceusage_v1 { */ export interface Schema$GoogleApiServiceusageV1OperationMetadata { /** - * The full name of the resources that this operation is directly associated - * with. + * The full name of the resources that this operation is directly associated with. */ resourceNames?: string[]; } @@ -1031,15 +740,11 @@ export namespace serviceusage_v1 { */ export interface Schema$GoogleApiServiceusageV1Service { /** - * The service configuration of the available service. Some fields may be - * filtered out of the configuration in responses to the `ListServices` - * method. These fields are present only in responses to the `GetService` - * method. + * The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. */ config?: Schema$GoogleApiServiceusageV1ServiceConfig; /** - * The resource name of the consumer and service. A valid name would be: - - * projects/123/services/serviceusage.googleapis.com + * The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */ name?: string; /** @@ -1056,8 +761,7 @@ export namespace serviceusage_v1 { */ export interface Schema$GoogleApiServiceusageV1ServiceConfig { /** - * A list of API interfaces exported by this service. Contains only the - * names, versions, and method names of the interfaces. + * A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. */ apis?: Schema$Api[]; /** @@ -1065,18 +769,15 @@ export namespace serviceusage_v1 { */ authentication?: Schema$Authentication; /** - * Additional API documentation. Contains only the summary and the - * documentation URL. + * Additional API documentation. Contains only the summary and the documentation URL. */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. Contains only the names and aliases - * of the endpoints. + * Configuration for network endpoints. Contains only the names and aliases of the endpoints. */ endpoints?: Schema$Endpoint[]; /** - * The DNS address at which this service is available. An example DNS - * address would be: `calendar.googleapis.com`. + * The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */ name?: string; /** @@ -1093,198 +794,32 @@ export namespace serviceusage_v1 { usage?: Schema$Usage; } /** - * Defines the HTTP configuration for an API service. It contains a list of - * HttpRule, each specifying the mapping of an RPC method to one or more HTTP - * REST API methods. + * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. */ export interface Schema$Http { /** - * When set to true, URL path parameters will be fully URI-decoded except in - * cases of single segment matches in reserved expansion, where - * "%2F" will be left encoded. The default behavior is to not - * decode RFC 6570 reserved characters in multi segment matches. + * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ fullyDecodeReservedExpansion?: boolean; /** - * A list of HTTP configuration rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$HttpRule[]; } /** - * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - * gRPC method and one or more HTTP REST endpoints. It allows developers to - * build a single API service that supports both gRPC APIs and REST APIs. Many - * systems, including [Google APIs](https://github.com/googleapis/googleapis), - * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and - * use it for large scale production services. `HttpRule` defines the schema - * of the gRPC/REST mapping. The mapping specifies how different portions of - * the gRPC request message are mapped to the URL path, URL query parameters, - * and HTTP request body. It also controls how the gRPC response message is - * mapped to the HTTP response body. `HttpRule` is typically specified as an - * `google.api.http` annotation on the gRPC method. Each mapping specifies a - * URL path template and an HTTP method. The path template may refer to one or - * more fields in the gRPC request message, as long as each field is a - * non-repeated field with a primitive (non-message) type. The path template - * controls how fields of the request message are mapped to the URL path. - * Example: service Messaging { rpc GetMessage(GetMessageRequest) - * returns (Message) { option (google.api.http) = { get: - * "/v1/{name=messages/*}" }; } } message - * GetMessageRequest { string name = 1; // Mapped to URL path. } - * message Message { string text = 1; // The resource content. } - * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC - * -----|----- `GET /v1/messages/123456` | `GetMessage(name: - * "messages/123456")` Any fields in the request message which are - * not bound by the path template automatically become HTTP query parameters - * if there is no HTTP request body. For example: service Messaging { rpc - * GetMessage(GetMessageRequest) returns (Message) { option - * (google.api.http) = { get:"/v1/messages/{message_id}" - * }; } } message GetMessageRequest { message SubMessage { - * string subfield = 1; } string message_id = 1; // Mapped to URL - * path. int64 revision = 2; // Mapped to URL query parameter - * `revision`. SubMessage sub = 3; // Mapped to URL query parameter - * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - * HTTP | gRPC -----|----- `GET - * /v1/messages/123456?revision=2&sub.subfield=foo` | - * `GetMessage(message_id: "123456" revision: 2 sub: - * SubMessage(subfield: "foo"))` Note that fields which are mapped - * to URL query parameters must have a primitive type or a repeated primitive - * type or a non-repeated message type. In the case of a repeated type, the - * parameter can be repeated in the URL as `...?param=A&param=B`. In the - * case of a message type, each field of the message is mapped to a separate - * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods - * that allow a request body, the `body` field specifies the mapping. Consider - * a REST update method on the message resource collection: service - * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) - * { option (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "message" - * }; } } message UpdateMessageRequest { string message_id - * = 1; // mapped to the URL Message message = 2; // mapped to the - * body } The following HTTP JSON to RPC mapping is enabled, where the - * representation of the JSON in the request body is determined by protos JSON - * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { - * "text": "Hi!" }` | `UpdateMessage(message_id: - * "123456" message { text: "Hi!" })` The special name - * `*` can be used in the body mapping to define that every field not bound by - * the path template should be mapped to the request body. This enables the - * following alternative definition of the update method: service - * Messaging { rpc UpdateMessage(Message) returns (Message) { option - * (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "*" }; } } - * message Message { string message_id = 1; string text = 2; } - * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- - * `PATCH /v1/messages/123456 { "text": "Hi!" }` | - * `UpdateMessage(message_id: "123456" text: "Hi!")` Note - * that when using `*` in the body mapping, it is not possible to have HTTP - * parameters, as all fields not bound by the path end in the body. This makes - * this option more rarely used in practice when defining REST APIs. The - * common usage of `*` is in custom methods which don't use the URL at all - * for transferring data. It is possible to define multiple HTTP methods for - * one RPC by using the `additional_bindings` option. Example: service - * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { - * option (google.api.http) = { get: - * "/v1/messages/{message_id}" additional_bindings { get: - * "/v1/users/{user_id}/messages/{message_id}" } }; } } - * message GetMessageRequest { string message_id = 1; string - * user_id = 2; } This enables the following two alternative HTTP JSON to - * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - * `GetMessage(message_id: "123456")` `GET - * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" - * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf - * request fields (recursive expansion nested messages in the request message) - * are classified into three categories: - Fields referred by the path - * template. They are passed via the URL path. - Fields referred by the - * HttpRule.body. They are passed via the HTTP request body. - All - * other fields are passed via the URL query parameters, and the parameter - * name is the field path in the request message. A repeated field can be - * represented as multiple query parameters under the same name. 2. If - * HttpRule.body is "*", there is no URL query parameter, all fields - * are passed via URL path and HTTP request body. 3. If HttpRule.body is - * omitted, there is no HTTP request body, all fields are passed via URL - * path and URL query parameters. ### Path template syntax Template = - * "/" Segments [ Verb ] ; Segments = Segment { "/" - * Segment } ; Segment = "*" | "**" | LITERAL | - * Variable ; Variable = "{" FieldPath [ "=" Segments - * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb - * = ":" LITERAL ; The syntax `*` matches a single URL path - * segment. The syntax `**` matches zero or more URL path segments, which must - * be the last part of the URL path except the `Verb`. The syntax `Variable` - * matches part of the URL path as specified by its template. A variable - * template must not contain other variables. If a variable matches a single - * path segment, its template may be omitted, e.g. `{var}` is equivalent to - * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If - * the `LITERAL` contains any reserved character, such characters should be - * percent-encoded before the matching. If a variable contains exactly one - * path segment, such as `"{var}"` or `"{var=*}"`, when - * such a variable is expanded into a URL path on the client side, all - * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - * does the reverse decoding. Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{var}`. If a variable contains multiple path segments, such as - * `"{var=foo/*}"` or `"{var=**}"`, when such a variable - * is expanded into a URL path on the client side, all characters except - * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse - * decoding, except "%2F" and "%2f" are left unchanged. - * Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - * Configuration (service config) is a configuration language for configuring - * a gRPC service to become a user-facing product. The service config is - * simply the YAML representation of the `google.api.Service` proto message. - * As an alternative to annotating your proto file, you can configure gRPC - * transcoding in your service config YAML files. You do this by specifying a - * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - * effect as the proto annotation. This can be particularly useful if you have - * a proto that is reused in multiple services. Note that any transcoding - * specified in the service config will override any matching transcoding - * configuration in the proto. Example: http: rules: # - * Selects a gRPC method and applies HttpRule to it. - selector: - * example.v1.Messaging.GetMessage get: - * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON - * conversion must follow the [proto3 - * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - * While the single segment variable follows the semantics of [RFC - * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - * Expansion, the multi segment variable **does not** follow RFC 6570 - * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - * does not expand special characters like `?` and `#`, which would lead to - * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for - * multi segment variables. The path variables **must not** refer to any - * repeated or mapped field, because client libraries are not capable of - * handling such variable expansion. The path variables **must not** capture - * the leading "/" character. The reason is that the most common use - * case "{var}" does not capture the leading "/" - * character. For consistency, all path variables must share the same - * behavior. Repeated message fields must not be mapped to URL query - * parameters, because no client library can support such complicated mapping. - * If an API needs to use a JSON array for request or response body, it can - * map the request or response body to a repeated field. However, some gRPC - * Transcoding implementations may not support this feature. + * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** - * Additional HTTP bindings for the selector. Nested bindings must not - * contain an `additional_bindings` field themselves (that is, the nesting - * may only be one level deep). + * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; /** - * The name of the request field whose value is mapped to the HTTP request - * body, or `*` for mapping all request fields not captured by the path - * pattern to the HTTP body, or omitted for not having any HTTP request - * body. NOTE: the referred field must be present at the top-level of the - * request message type. + * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ body?: string; /** - * The custom pattern is used for specifying an HTTP method that is not - * included in the `pattern` field, such as HEAD, or "*" to leave - * the HTTP method unspecified for this rule. The wild-card rule is useful - * for services that provide content to Web (HTML) clients. + * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ custom?: Schema$CustomHttpPattern; /** @@ -1292,8 +827,7 @@ export namespace serviceusage_v1 { */ delete?: string; /** - * Maps to HTTP GET. Used for listing and getting information about - * resources. + * Maps to HTTP GET. Used for listing and getting information about resources. */ get?: string; /** @@ -1309,15 +843,11 @@ export namespace serviceusage_v1 { */ put?: string; /** - * Optional. The name of the response field whose value is mapped to the - * HTTP response body. When omitted, the entire response message will be - * used as the HTTP response body. NOTE: The referred field must be present - * at the top-level of the response message type. + * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ responseBody?: string; /** - * Selects a method to which this rule applies. Refer to selector for - * syntax details. + * Selects a method to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -1365,82 +895,49 @@ export namespace serviceusage_v1 { services?: Schema$GoogleApiServiceusageV1Service[]; } /** - * A description of a log type. Example in YAML format: - name: - * library.googleapis.com/activity_history description: The history of - * borrowing and returning library items. display_name: Activity labels: - * - key: /customer_id description: Identifier of a library customer + * A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer */ export interface Schema$LogDescriptor { /** - * A human-readable description of this log. This information appears in the - * documentation and can contain details. + * A human-readable description of this log. This information appears in the documentation and can contain details. */ description?: string; /** - * The human-readable name for this log. This information appears on the - * user interface and should be concise. + * The human-readable name for this log. This information appears on the user interface and should be concise. */ displayName?: string; /** - * The set of labels that are available to describe a specific log entry. - * Runtime requests that contain labels not specified here are considered - * invalid. + * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ labels?: Schema$LabelDescriptor[]; /** - * The name of the log. It must be less than 512 characters long and can - * include the following characters: upper- and lower-case alphanumeric - * characters [A-Za-z0-9], and punctuation characters including slash, - * underscore, hyphen, period [/_-.]. + * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ name?: string; } /** - * Logging configuration of the service. The following example shows how to - * configure logs to be sent to the producer and consumer projects. In the - * example, the `activity_history` log is sent to both the producer and - * consumer projects, whereas the `purchase_history` log is only sent to the - * producer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. logs: - name: activity_history - * labels: - key: /customer_id - name: purchase_history logging: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - - * purchase_history consumer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history + * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history */ export interface Schema$Logging { /** - * Logging configurations for sending logs to the consumer project. There - * can be multiple consumer destinations, each one must have a different - * monitored resource type. A log can be used in at most one consumer - * destination. + * Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination. */ consumerDestinations?: Schema$LoggingDestination[]; /** - * Logging configurations for sending logs to the producer project. There - * can be multiple producer destinations, each one must have a different - * monitored resource type. A log can be used in at most one producer - * destination. + * Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination. */ producerDestinations?: Schema$LoggingDestination[]; } /** - * Configuration of a specific logging destination (the producer project or - * the consumer project). + * Configuration of a specific logging destination (the producer project or the consumer project). */ export interface Schema$LoggingDestination { /** - * Names of the logs to be sent to this destination. Each name must be - * defined in the Service.logs section. If the log name is not a domain - * scoped name, it will be automatically prefixed with the service name - * followed by "/". + * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ logs?: string[]; /** - * The monitored resource type. The type must be defined in the - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ monitoredResource?: string; } @@ -1478,9 +975,7 @@ export namespace serviceusage_v1 { syntax?: string; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1488,28 +983,23 @@ export namespace serviceusage_v1 { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * `appengine.googleapis.com/http/server/response_latencies` metric type has - * a label for the HTTP response code, `response_code`, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of `metric_kind` and `value_type` might not be - * supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string; /** @@ -1517,47 +1007,15 @@ export namespace serviceusage_v1 { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * `custom.googleapis.com` or `external.googleapis.com`. Metric types - * should use a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported - * units are a subset of [The Unified Code for Units of - * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units - * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute - * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo - * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera - * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` - * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * - * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico - * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` - * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * - * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) - * **Grammar** The grammar also includes these connectors: * `/` division - * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix - * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression - * = Component { "." Component } { "/" Component } ; - * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | - * Annotation | "1" ; Annotation - * = "{" NAME "}" ; Notes: * `Annotation` is just a - * comment if it follows a `UNIT` and is equivalent to `1` if it is used - * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == - * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not - * containing '{' or '}'. * `1` represents dimensionless - * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, - * and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of `metric_kind` and `value_type` might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ valueType?: string; } @@ -1566,77 +1024,33 @@ export namespace serviceusage_v1 { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * Bind API methods to metrics. Binding a method to a metric causes that - * metric's configured quota behaviors to apply to the method call. + * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. */ export interface Schema$MetricRule { /** - * Metrics to update when the selected methods are called, and the - * associated cost applied to each metric. The key of the map is the metric - * name, and the values are the amount increased for the metric against - * which the quota limits are defined. The value must not be negative. + * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ metricCosts?: {[key: string]: string}; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Declares an API Interface to be included in this interface. The including - * interface must redeclare all the methods from the included interface, but - * documentation and options are inherited as follows: - If after comment and - * whitespace stripping, the documentation string of the redeclared method - * is empty, it will be inherited from the original method. - Each - * annotation belonging to the service config (http, visibility) which is - * not set in the redeclared method will be inherited. - If an http - * annotation is inherited, the path pattern will be modified as follows. - * Any version prefix will be replaced by the version of the including - * interface plus the root path if specified. Example of a simple mixin: - * package google.acl.v1; service AccessControl { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } - * package google.storage.v2; service Storage { // rpc - * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc - * GetData(GetDataRequest) returns (Data) { option - * (google.api.http).get = "/v2/{resource=**}"; } } - * Example of a mixin configuration: apis: - name: - * google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl The mixin construct implies that all methods - * in `AccessControl` are also declared with same name and request/response - * types in `Storage`. A documentation generator or annotation processor will - * see the effective `Storage.GetAcl` method after inherting documentation and - * annotations as follows: service Storage { // Get the underlying - * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... - * } Note how the version in the path pattern changed from `v1` to `v2`. If - * the `root` field in the mixin is specified, it should be a relative path - * under which inherited HTTP paths are placed. Example: apis: - - * name: google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl root: acls This implies the following - * inherited HTTP annotation: service Storage { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; - * } ... } + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } */ export interface Schema$Mixin { /** @@ -1644,149 +1058,80 @@ export namespace serviceusage_v1 { */ name?: string; /** - * If non-empty specifies a path under which inherited HTTP paths are - * rooted. + * If non-empty specifies a path under which inherited HTTP paths are rooted. */ root?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * `"gce_instance"` and specifies the use of the labels - * `"instance_id"` and `"zone"` to identify particular VM - * instances. Different APIs can support different monitored resource types. - * APIs generally provide a `list` method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, `"Google - * Cloud SQL Database"`. + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels `"database_id"` and - * `"zone"`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` - * where {type} is the value of the `type` field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format `"monitoredResourceDescriptors/{type}"`. + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ name?: string; /** - * Required. The monitored resource type. For example, the type - * `"cloudsql_database"` represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Monitoring configuration of the service. The example below shows how to - * configure monitored resources and metrics for monitoring. In the example, a - * monitored resource and two metrics are defined. The - * `library.googleapis.com/book/returned_count` metric is sent to both - * producer and consumer projects, whereas the - * `library.googleapis.com/book/overdue_count` metric is only sent to the - * consumer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. metrics: - name: - * library.googleapis.com/book/returned_count metric_kind: DELTA - * value_type: INT64 labels: - key: /customer_id - name: - * library.googleapis.com/book/overdue_count metric_kind: GAUGE - * value_type: INT64 labels: - key: /customer_id monitoring: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count consumer_destinations: - - * monitored_resource: library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count - - * library.googleapis.com/book/overdue_count + * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count */ export interface Schema$Monitoring { /** - * Monitoring configurations for sending metrics to the consumer project. - * There can be multiple consumer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ consumerDestinations?: Schema$MonitoringDestination[]; /** - * Monitoring configurations for sending metrics to the producer project. - * There can be multiple producer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ producerDestinations?: Schema$MonitoringDestination[]; } /** - * Configuration of a specific monitoring destination (the producer project or - * the consumer project). + * Configuration of a specific monitoring destination (the producer project or the consumer project). */ export interface Schema$MonitoringDestination { /** - * Types of the metrics to report to this monitoring destination. Each type - * must be defined in Service.metrics section. + * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * OAuth scopes are a way to define data and permissions on data. For example, - * there are scopes defined for "Read-only access to Google - * Calendar" and "Access to Cloud Platform". Users can consent - * to a scope for an application, giving it permission to access that data on - * their behalf. OAuth scope specifications should be fairly coarse grained; - * a user will need to see and understand the text description of what your - * scope means. In most cases: use one or at most two OAuth scopes for an - * entire family of products. If your product has multiple APIs, you should - * probably be sharing the OAuth scope across all of those APIs. When you - * need finer grained OAuth consent screens: talk with your product management - * about how developers will use them in practice. Please note that even - * though each of the canonical scopes is enough for a request to be accepted - * and passed to the backend, a request can still fail due to the backend - * requiring additional scopes or permissions. + * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. */ export interface Schema$OAuthRequirements { /** - * The list of publicly documented OAuth scopes that are allowed access. An - * OAuth token containing any of these scopes will be accepted. Example: - * canonical_scopes: https://www.googleapis.com/auth/calendar, - * https://www.googleapis.com/auth/calendar.read + * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ canonicalScopes?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1794,26 +1139,15 @@ export namespace serviceusage_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -1822,85 +1156,42 @@ export namespace serviceusage_v1 { */ export interface Schema$OperationMetadata { /** - * The full name of the resources that this operation is directly associated - * with. + * The full name of the resources that this operation is directly associated with. */ resourceNames?: string[]; } /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ export interface Schema$Option { /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * `"map_entry"`. For custom options, it should be the - * fully-qualified name. For example, `"google.api.http"`. + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ name?: string; /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ value?: {[key: string]: any}; } /** - * Represents a documentation page. A page can contain subpages to represent - * nested documentation set structure. + * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. */ export interface Schema$Page { /** - * The Markdown content of the page. You can use <code>&#40;== - * include {path} ==&#41;</code> to include content from a - * Markdown file. + * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ content?: string; /** - * The name of the page. It will be used as an identity of the page to - * generate URI of the page, text of the link to this page in navigation, - * etc. The full page name (start from the root page name to this page - * concatenated with `.`) can be used as reference to the page in your - * documentation. For example: <pre><code>pages: - name: - * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - * - name: Java content: &#40;== include tutorial_java.md - * ==&#41; </code></pre> You can reference `Java` page using - * Markdown reference link syntax: `Java`. + * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ name?: string; /** - * Subpages of this page. The order of subpages specified here will be - * honored in the generated docset. + * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ subpages?: Schema$Page[]; } /** - * Quota configuration helps to achieve fairness and budgeting in service - * usage. The metric based quota configuration works this way: - The service - * configuration defines a set of metrics. - For API calls, the - * quota.metric_rules maps methods to metrics with corresponding costs. - - * The quota.limits defines limits on the metrics, which will be used for - * quota checks at runtime. An example quota configuration in yaml format: - * quota: limits: - name: apiWriteQpsPerProject metric: - * library.googleapis.com/write_calls unit: "1/min/{project}" - * # rate limit for consumer projects values: STANDARD: 10000 - * # The metric rules bind all methods to the read_calls metric, # except - * for the UpdateBook and DeleteBook methods. These two methods # are - * mapped to the write_calls metric, with the UpdateBook method # - * consuming at twice rate as the DeleteBook method. metric_rules: - - * selector: "*" metric_costs: - * library.googleapis.com/read_calls: 1 - selector: - * google.example.library.v1.LibraryService.UpdateBook metric_costs: - * library.googleapis.com/write_calls: 2 - selector: - * google.example.library.v1.LibraryService.DeleteBook metric_costs: - * library.googleapis.com/write_calls: 1 Corresponding Metric definition: - * metrics: - name: library.googleapis.com/read_calls display_name: Read - * requests metric_kind: DELTA value_type: INT64 - name: - * library.googleapis.com/write_calls display_name: Write requests - * metric_kind: DELTA value_type: INT64 + * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 */ export interface Schema$Quota { /** @@ -1908,93 +1199,52 @@ export namespace serviceusage_v1 { */ limits?: Schema$QuotaLimit[]; /** - * List of `MetricRule` definitions, each one mapping a selected method to - * one or more metrics. + * List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */ metricRules?: Schema$MetricRule[]; } /** - * `QuotaLimit` defines a specific limit that applies over a specified - * duration for a limit type. There can be at most one limit for a duration - * and limit type combination defined within a `QuotaGroup`. + * `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. */ export interface Schema$QuotaLimit { /** - * Default number of tokens that can be consumed during the specified - * duration. This is the number of tokens assigned when a client application - * developer activates the service for his/her project. Specifying a value - * of 0 will block all requests. This can be used if you are provisioning - * quota to selected consumers and blocking others. Similarly, a value of -1 - * will indicate an unlimited quota. No other negative values are allowed. - * Used by group-based quotas only. + * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ defaultLimit?: string; /** - * Optional. User-visible, extended description for this quota limit. Should - * be used only when more context is needed to understand this limit than - * provided by the limit's display name (see: `display_name`). + * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ description?: string; /** - * User-visible display name for this limit. Optional. If not set, the UI - * will provide a default display name based on the quota configuration. - * This field can be used to override the default display name generated - * from the configuration. + * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ displayName?: string; /** - * Duration of this limit in textual notation. Example: "100s", - * "24h", "1d". For duration longer than a day, only - * multiple of days is supported. We support only "100s" and - * "1d" for now. Additional support will be added in the future. - * "0" indicates indefinite duration. Used by group-based quotas - * only. + * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. */ duration?: string; /** - * Free tier value displayed in the Developers Console for this limit. The - * free tier is the number of tokens that will be subtracted from the billed - * amount when billing is enabled. This field can only be set on a limit - * with duration "1d", in a billable group; it is invalid on any - * other limit. If this field is not set, it defaults to 0, indicating that - * there is no free tier for this service. Used by group-based quotas only. + * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ freeTier?: string; /** - * Maximum number of tokens that can be consumed during the specified - * duration. Client application developers can override the default limit up - * to this maximum. If specified, this value cannot be set to a value less - * than the default limit. If not specified, it is set to the default limit. - * To allow clients to apply overrides with no upper bound, set this to -1, - * indicating unlimited maximum quota. Used by group-based quotas only. + * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ maxLimit?: string; /** - * The name of the metric this quota limit applies to. The quota limits with - * the same metric will be checked together during runtime. The metric must - * be defined within the service config. + * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ metric?: string; /** - * Name of the quota limit. The name must be provided, and it must be - * unique within the service. The name can only include alphanumeric - * characters as well as '-'. The maximum length of the limit name - * is 64 characters. + * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ name?: string; /** - * Specify the unit of the quota limit. It uses the same syntax as - * Metric.unit. The supported unit kinds are determined by the quota backend - * system. Here are some examples: * "1/min/{project}" for quota - * per minute per project. Note: the order of unit components is - * insignificant. The "1" at the beginning is required to follow - * the metric unit syntax. + * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ unit?: string; /** - * Tiered limit values. You must specify this as a key:value pair, with an - * integer value that is the maximum number of requests allowed for the - * specified unit. Currently only STANDARD is supported. + * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ values?: {[key: string]: string}; } @@ -2003,50 +1253,24 @@ export namespace serviceusage_v1 { */ export interface Schema$QuotaOverride { /** - * If this map is nonempty, then this override applies only to specific - * values for dimensions defined in the limit unit. For example, an - * override on a limit with the unit 1/{project}/{region} could contain an - * entry with the key "region" and the value - * "us-east-1"; the override is only applied to quota consumed in - * that region. This map has the following restrictions: - Keys that are - * not defined in the limit's unit are not valid keys. Any string - * appearing in {brackets} in the unit (besides {project} or {user}) is a - * defined key. - "project" is not a valid key; the project is - * already specified in the parent resource name. - "user" is - * not a valid key; the API does not support quota overrides that apply - * only to a specific user. - If "region" appears as a key, its - * value must be a valid Cloud region. - If "zone" appears as a - * key, its value must be a valid Cloud zone. - If any valid key other than - * "region" or "zone" appears in the map, then all - * valid keys other than "region" or "zone" must also - * appear in the map. + * If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: - Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. - "project" is not a valid key; the project is already specified in the parent resource name. - "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. - If "region" appears as a key, its value must be a valid Cloud region. - If "zone" appears as a key, its value must be a valid Cloud zone. - If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. */ dimensions?: {[key: string]: string}; /** - * The resource name of the override. This name is generated by the server - * when the override is created. Example names would be: - * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - * The resource name is intended to be opaque and should not be parsed for - * its component strings, since its representation could change in the - * future. + * The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. */ name?: string; /** - * The overriding quota limit value. Can be any nonnegative integer, or -1 - * (unlimited quota). + * The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */ overrideValue?: string; } /** - * `SourceContext` represents information about the source of a protobuf - * element, like the file in which it is defined. + * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ export interface Schema$SourceContext { /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * `"google/protobuf/source_context.proto"`. + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ fileName?: string; } @@ -2060,40 +1284,7 @@ export namespace serviceusage_v1 { sourceFiles?: Array<{[key: string]: any}>; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -2101,78 +1292,50 @@ export namespace serviceusage_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Define a parameter's name and location. The parameter may be passed as - * either an HTTP header or a URL query parameter, and if both are passed the - * behavior is implementation-dependent. + * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. */ export interface Schema$SystemParameter { /** - * Define the HTTP header name to use for the parameter. It is case - * insensitive. + * Define the HTTP header name to use for the parameter. It is case insensitive. */ httpHeader?: string; /** - * Define the name of the parameter, such as "api_key" . It is - * case sensitive. + * Define the name of the parameter, such as "api_key" . It is case sensitive. */ name?: string; /** - * Define the URL query parameter name to use for the parameter. It is case - * sensitive. + * Define the URL query parameter name to use for the parameter. It is case sensitive. */ urlQueryParameter?: string; } /** - * Define a system parameter rule mapping system parameter definitions to - * methods. + * Define a system parameter rule mapping system parameter definitions to methods. */ export interface Schema$SystemParameterRule { /** - * Define parameters. Multiple names may be defined for a parameter. For a - * given method call, only one of them should be used. If multiple names are - * used the behavior is implementation-dependent. If none of the specified - * names are present the behavior is parameter-dependent. + * Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent. */ parameters?: Schema$SystemParameter[]; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; } /** - * ### System parameter configuration A system parameter is a special kind of - * parameter defined by the API system, not by an individual API. It is - * typically mapped to an HTTP header and/or a URL query parameter. This - * configuration specifies which methods change the names of the system - * parameters. + * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. */ export interface Schema$SystemParameters { /** - * Define system parameters. The parameters defined here will override the - * default parameters implemented by the system. If this field is missing - * from the service config, default system parameters will be used. Default - * system parameters and names is implementation-dependent. Example: define - * api key for all methods system_parameters rules: - - * selector: "*" parameters: - name: api_key - * url_query_parameter: api_key Example: define 2 api key names for a - * specific method. system_parameters rules: - selector: - * "/ListShelves" parameters: - name: - * api_key http_header: Api-Key1 - name: api_key - * http_header: Api-Key2 **NOTE:** All service configuration rules follow - * "last one wins" order. + * Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$SystemParameterRule[]; } @@ -2210,57 +1373,32 @@ export namespace serviceusage_v1 { */ export interface Schema$Usage { /** - * The full resource name of a channel used for sending notifications to the - * service producer. Google Service Management currently only supports - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - * channel. To use Google Cloud Pub/Sub as the channel, this must be the - * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name - * format documented in https://cloud.google.com/pubsub/docs/overview. + * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ producerNotificationChannel?: string; /** - * Requirements that must be satisfied before a consumer project can use the - * service. Each requirement is of the form - * <service.name>/<requirement-id>; for example - * 'serviceusage.googleapis.com/billing-enabled'. + * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ requirements?: string[]; /** - * A list of usage rules that apply to individual API methods. **NOTE:** - * All service configuration rules follow "last one wins" order. + * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use - * this rule to configure unregistered calls for the service. Unregistered - * calls are calls that do not contain consumer project identity. (Example: - * calls that do not contain an API key). By default, API methods do not allow - * unregistered calls, and each method call must be identified by a consumer - * project identity. Use this rule to allow/disallow unregistered calls. - * Example of an API that wants to allow unregistered calls for entire - * service. usage: rules: - selector: "*" - * allow_unregistered_calls: true Example of a method that wants to allow - * unregistered calls. usage: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allow_unregistered_calls: true + * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that - * don't identify any user or application. + * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ allowUnregisteredCalls?: boolean; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; /** - * If true, the selected method should skip service control and the control - * plane features, such as quota and billing, will not be available. This - * flag is used by Google Cloud Endpoints to bypass checks for internal - * methods, such as service health check methods. + * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ skipServiceControl?: boolean; } @@ -2273,15 +1411,7 @@ export namespace serviceusage_v1 { /** * serviceusage.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias serviceusage.operations.cancel * @memberOf! () * @@ -2351,10 +1481,7 @@ export namespace serviceusage_v1 { /** * serviceusage.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias serviceusage.operations.delete * @memberOf! () * @@ -2423,9 +1550,7 @@ export namespace serviceusage_v1 { /** * serviceusage.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias serviceusage.operations.get * @memberOf! () * @@ -2495,15 +1620,7 @@ export namespace serviceusage_v1 { /** * serviceusage.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias serviceusage.operations.list * @memberOf! () * @@ -2649,14 +1766,12 @@ export namespace serviceusage_v1 { /** * serviceusage.services.batchEnable - * @desc Enable multiple services on a project. The operation is atomic: if - * enabling any service fails, then the entire batch fails, and no state - * changes occur. + * @desc Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. * @alias serviceusage.services.batchEnable * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Parent to enable services on. An example name would be: `projects/123` where `123` is the project number (not project ID). The `BatchEnableServices` method currently only supports projects. + * @param {string} params.parent Parent to enable services on. An example name would be: `projects/123` where `123` is the project number. The `BatchEnableServices` method currently only supports projects. * @param {().BatchEnableServicesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2726,17 +1841,12 @@ export namespace serviceusage_v1 { /** * serviceusage.services.disable - * @desc Disable a service so that it can no longer be used with a project. - * This prevents unintended usage that may cause unexpected billing charges - * or security leaks. It is not valid to call the disable method on a - * service that is not currently enabled. Callers will receive a - * `FAILED_PRECONDITION` status if the target service is not currently - * enabled. + * @desc Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. * @alias serviceusage.services.disable * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). + * @param {string} params.name Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. * @param {().DisableServiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2810,7 +1920,7 @@ export namespace serviceusage_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). + * @param {string} params.name Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. * @param {().EnableServiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2876,13 +1986,12 @@ export namespace serviceusage_v1 { /** * serviceusage.services.get - * @desc Returns the service configuration and enabled state for a given - * service. + * @desc Returns the service configuration and enabled state for a given service. * @alias serviceusage.services.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the consumer and service to get the `ConsumerState` for. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). + * @param {string} params.name Name of the consumer and service to get the `ConsumerState` for. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2956,13 +2065,7 @@ export namespace serviceusage_v1 { /** * serviceusage.services.list - * @desc List all services available to the specified project, and the - * current state of those services with respect to the project. The list - * includes all public services, all services for which the calling user has - * the `servicemanagement.services.bind` permission, and all services that - * have already been enabled on the project. The list can be filtered to - * only include services in a specific state, for example to only include - * services enabled on the project. + * @desc List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project. * @alias serviceusage.services.list * @memberOf! () * @@ -2970,7 +2073,7 @@ export namespace serviceusage_v1 { * @param {string=} params.filter Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`. * @param {integer=} params.pageSize Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50. * @param {string=} params.pageToken Token identifying which result to start with, which is returned by a previous list call. - * @param {string} params.parent Parent to search for services on. An example name would be: `projects/123` where `123` is the project number (not project ID). + * @param {string} params.parent Parent to search for services on. An example name would be: `projects/123` where `123` is the project number. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3047,9 +2150,7 @@ export namespace serviceusage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Parent to enable services on. An example name would be: `projects/123` - * where `123` is the project number (not project ID). The - * `BatchEnableServices` method currently only supports projects. + * Parent to enable services on. An example name would be: `projects/123` where `123` is the project number. The `BatchEnableServices` method currently only supports projects. */ parent?: string; @@ -3065,10 +2166,7 @@ export namespace serviceusage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the consumer and service to disable the service on. The enable - * and disable methods currently only support projects. An example name - * would be: `projects/123/services/serviceusage.googleapis.com` where `123` - * is the project number (not project ID). + * Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name?: string; @@ -3084,12 +2182,7 @@ export namespace serviceusage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the consumer and service to enable the service on. The - * `EnableService` and `DisableService` methods currently only support - * projects. Enabling a service requires that the service is public or is - * shared with the user enabling the service. An example name would be: - * `projects/123/services/serviceusage.googleapis.com` where `123` is the - * project number (not project ID). + * Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name?: string; @@ -3105,10 +2198,7 @@ export namespace serviceusage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the consumer and service to get the `ConsumerState` for. An - * example name would be: - * `projects/123/services/serviceusage.googleapis.com` where `123` is the - * project number (not project ID). + * Name of the consumer and service to get the `ConsumerState` for. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name?: string; } @@ -3119,23 +2209,19 @@ export namespace serviceusage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Only list services that conform to the given filter. The allowed filter - * strings are `state:ENABLED` and `state:DISABLED`. + * Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`. */ filter?: string; /** - * Requested size of the next page of data. Requested page size cannot - * exceed 200. If not set, the default page size is 50. + * Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50. */ pageSize?: number; /** - * Token identifying which result to start with, which is returned by a - * previous list call. + * Token identifying which result to start with, which is returned by a previous list call. */ pageToken?: string; /** - * Parent to search for services on. An example name would be: - * `projects/123` where `123` is the project number (not project ID). + * Parent to search for services on. An example name would be: `projects/123` where `123` is the project number. */ parent?: string; } diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 7a434c6d157..9df692043e8 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace serviceusage_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace serviceusage_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace serviceusage_v1beta1 { /** * Service Usage API * - * Enables services that service consumers want to use on Google Cloud - * Platform, lists the available or enabled services, or disables services - * that service consumers no longer use. + * Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace serviceusage_v1beta1 { services: Resource$Services; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.services = new Resource$Services(this.context); @@ -123,14 +120,7 @@ export namespace serviceusage_v1beta1 { } /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also - * described as "protocol buffer services" in some contexts, such as - * by the "service" keyword in a .proto file, but they are different - * from API Services, which represent a concrete implementation of an - * interface as opposed to simply a description of methods and bindings. They - * are also sometimes simply referred to as "APIs" in other - * contexts, such as the name of this message itself. See - * https://cloud.google.com/apis/design/glossary for detailed terminology. + * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ export interface Schema$Api { /** @@ -142,8 +132,7 @@ export namespace serviceusage_v1beta1 { */ mixins?: Schema$Mixin[]; /** - * The fully qualified name of this interface, including package name - * followed by the interface's simple name. + * The fully qualified name of this interface, including package name followed by the interface's simple name. */ name?: string; /** @@ -151,8 +140,7 @@ export namespace serviceusage_v1beta1 { */ options?: Schema$Option[]; /** - * Source context for the protocol buffer service represented by this - * message. + * Source context for the protocol buffer service represented by this message. */ sourceContext?: Schema$SourceContext; /** @@ -160,32 +148,12 @@ export namespace serviceusage_v1beta1 { */ syntax?: string; /** - * A version string for this interface. If specified, must have the form - * `major-version.minor-version`, as in `1.10`. If the minor version is - * omitted, it defaults to zero. If the entire version field is empty, the - * major version is derived from the package name, as outlined below. If the - * field is not empty, the version in the package name will be verified to - * be consistent with what is provided here. The versioning schema uses - * [semantic versioning](http://semver.org) where the major version number - * indicates a breaking change and the minor version an additive, - * non-breaking change. Both version numbers are signals to users what to - * expect from different versions, and should be carefully chosen based on - * the product plan. The major version is also reflected in the package - * name of the interface, which must end in `v<major-version>`, as in - * `google.feature.v1`. For major versions 0 and 1, the suffix can be - * omitted. Zero major versions must only be used for experimental, non-GA - * interfaces. + * A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. */ version?: string; } /** - * `Authentication` defines the authentication configuration for an API. - * Example for an API targeted for external use: name: - * calendar.googleapis.com authentication: providers: - id: - * google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$Authentication { /** @@ -193,18 +161,12 @@ export namespace serviceusage_v1beta1 { */ providers?: Schema$AuthProvider[]; /** - * A list of authentication rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$AuthenticationRule[]; } /** - * Authentication rules for the service. By default, if a method has any - * authentication requirements, every request must include a valid credential - * matching one of the requirements. It's an error to include more than - * one kind of credential in a single request. If a method doesn't have - * any auth requirements, request credentials will be ignored. + * Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored. */ export interface Schema$AuthenticationRule { /** @@ -220,96 +182,45 @@ export namespace serviceusage_v1beta1 { */ requirements?: Schema$AuthRequirement[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Configuration of authorization. This section determines the authorization - * provider, if unspecified, then no authorization check will be done. - * Example: experimental: authorization: provider: - * firebaserules.googleapis.com - */ - export interface Schema$AuthorizationConfig { - /** - * The name of the authorization provider, such as - * firebaserules.googleapis.com. - */ - provider?: string; - } - /** - * Configuration for an authentication provider, including support for [JSON - * Web Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthProvider { /** - * The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * Redirect URL if JWT token is required but not present or is expired. - * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + * Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ authorizationUrl?: string; /** - * The unique identifier of the auth provider. It will be referred to by - * `AuthRequirement.provider_id`. Example: "bookstore_auth". + * The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ id?: string; /** - * Identifies the principal that issued the JWT. See - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - * Usually a URL or an email address. Example: - * https://securetoken.google.com Example: - * 1234567-compute@developer.gserviceaccount.com + * Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com */ issuer?: string; /** - * URL of the provider's public key set to validate signature of the - * JWT. See [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - * Optional if the key set document: - can be retrieved from [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: - * https://www.googleapis.com/oauth2/v1/certs + * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string; } /** - * User-defined authentication requirements, including support for [JSON Web - * Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ export interface Schema$AuthRequirement { /** - * NOTE: This will be deprecated soon, once AuthProvider.audiences is - * implemented and accepted in all the runtime components. The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com + * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com */ audiences?: string; /** - * id from authentication provider. Example: provider_id: - * bookstore_auth + * id from authentication provider. Example: provider_id: bookstore_auth */ providerId?: string; } @@ -318,9 +229,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$Backend { /** - * A list of API backend rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$BackendRule[]; } @@ -333,9 +242,7 @@ export namespace serviceusage_v1beta1 { */ address?: string; /** - * The number of seconds to wait for a response from a request. The default - * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 - * seconds. + * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. */ deadline?: number; /** @@ -343,19 +250,16 @@ export namespace serviceusage_v1beta1 { */ jwtAudience?: string; /** - * Minimum deadline in seconds needed for this method. Calls having deadline - * value lower than this will be rejected. + * Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected. */ minDeadline?: number; /** - * The number of seconds to wait for the completion of a long running - * operation. The default is no deadline. + * The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ operationDeadline?: number; pathTranslation?: string; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -382,25 +286,16 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$BatchEnableServicesRequest { /** - * The identifiers of the services to enable on the project. A valid - * identifier would be: serviceusage.googleapis.com Enabling services - * requires that each service is public or is shared with the user enabling - * the service. Two or more services must be specified. To enable a single - * service, use the `EnableService` method instead. A single request can - * enable a maximum of 20 services at a time. If more than 20 services are - * specified, the request will fail, and no state changes will occur. + * The identifiers of the services to enable on the project. A valid identifier would be: serviceusage.googleapis.com Enabling services requires that each service is public or is shared with the user enabling the service. Two or more services must be specified. To enable a single service, use the `EnableService` method instead. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur. */ serviceIds?: string[]; } /** - * Response message for the `BatchEnableServices` method. This response - * message is assigned to the `response` field of the returned Operation when - * that operation is done. + * Response message for the `BatchEnableServices` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$BatchEnableServicesResponse { /** - * If allow_partial_success is true, and one or more services could not be - * enabled, this field contains the details about each failure. + * If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure. */ failures?: Schema$EnableFailure[]; /** @@ -409,81 +304,46 @@ export namespace serviceusage_v1beta1 { services?: Schema$GoogleApiServiceusageV1Service[]; } /** - * Billing related configuration of the service. The following example shows - * how to configure monitored resources and metrics for billing: - * monitored_resources: - type: library.googleapis.com/branch labels: - - * key: /city description: The city where the library branch is - * located in. - key: /name description: The name of the branch. - * metrics: - name: library.googleapis.com/book/borrowed_count - * metric_kind: DELTA value_type: INT64 billing: - * consumer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/borrowed_count + * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/borrowed_count */ export interface Schema$Billing { /** - * Billing configurations for sending metrics to the consumer project. There - * can be multiple consumer destinations per service, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. + * Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. */ consumerDestinations?: Schema$BillingDestination[]; } /** - * Configuration of a specific billing destination (Currently only support - * bill against consumer project). + * Configuration of a specific billing destination (Currently only support bill against consumer project). */ export interface Schema$BillingDestination { /** - * Names of the metrics to report to this billing destination. Each name - * must be defined in Service.metrics section. + * Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * `Context` defines which contexts an API requests. Example: context: - * rules: - selector: "*" requested: - - * google.rpc.context.ProjectContext - - * google.rpc.context.OriginContext The above specifies that all methods in - * the API request `google.rpc.context.ProjectContext` and - * `google.rpc.context.OriginContext`. Available context types are defined in - * package `google.rpc.context`. This also provides mechanism to whitelist - * any protobuf message extension that can be sent in grpc metadata using - * “x-goog-ext-<extension_id>-bin” and - * “x-goog-ext-<extension_id>-jspb” format. For example, list any - * service specific protobuf types that can appear in grpc metadata as follows - * in your yaml file: Example: context: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allowed_request_extensions: - google.foo.v1.NewExtension - * allowed_response_extensions: - google.foo.v1.NewExtension You can - * also specify extension ID instead of fully qualified extension name here. + * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. */ export interface Schema$Context { /** - * A list of RPC context rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$ContextRule[]; } /** - * A context rule provides information about the context for an individual API - * element. + * A context rule provides information about the context for an individual API element. */ export interface Schema$ContextRule { /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from client to backend. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ allowedRequestExtensions?: string[]; /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from backend to client. + * A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ allowedResponseExtensions?: string[]; /** @@ -495,39 +355,29 @@ export namespace serviceusage_v1beta1 { */ requested?: string[]; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Selects and configures the service controller used by the service. The - * service controller handles features like abuse, quota, billing, logging, - * monitoring, etc. + * Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. */ export interface Schema$Control { /** - * The service control environment to use. If empty, no control plane - * feature (like quota and billing) will be enabled. + * The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. */ environment?: string; } /** - * Customize service error responses. For example, list any service specific - * protobuf types that can appear in error detail lists of error responses. - * Example: custom_error: types: - google.foo.v1.CustomError - * - google.foo.v1.AnotherError + * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError */ export interface Schema$CustomError { /** - * The list of custom error rules that apply to individual API messages. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$CustomErrorRule[]; /** - * The list of custom error detail types, e.g. - * 'google.foo.v1.CustomError'. + * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ types?: string[]; } @@ -536,13 +386,11 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$CustomErrorRule { /** - * Mark this message as possible payload in error response. Otherwise, - * objects of this type will be filtered when they appear in error payload. + * Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ isErrorType?: boolean; /** - * Selects messages to which this rule applies. Refer to selector for - * syntax details. + * Selects messages to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -564,9 +412,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$DisableServiceRequest {} /** - * Response message for the `DisableService` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `DisableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$DisableServiceResponse { /** @@ -575,42 +421,7 @@ export namespace serviceusage_v1beta1 { service?: Schema$GoogleApiServiceusageV1Service; } /** - * `Documentation` provides the information for describing a service. Example: - * <pre><code>documentation: summary: > The Google - * Calendar API gives access to most calendar features. pages: - name: - * Overview content: &#40;== include google/foo/overview.md - * ==&#41; - name: Tutorial content: &#40;== include - * google/foo/tutorial.md ==&#41; subpages; - name: Java content: - * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - - * selector: google.calendar.Calendar.Get description: > ... - - * selector: google.calendar.Calendar.Put description: > ... - * </code></pre> Documentation is provided in markdown syntax. In - * addition to standard markdown features, definition lists, tables and fenced - * code blocks are supported. Section headers can be provided and are - * interpreted relative to the section nesting of the context where a - * documentation fragment is embedded. Documentation from the IDL is merged - * with documentation defined via the config at normalization time, where - * documentation provided by config rules overrides IDL provided. A number of - * constructs specific to the API platform are supported in documentation - * text. In order to reference a proto element, the following notation can be - * used: - * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> - * To override the display text used for the link, this can be used: - * <pre><code>&#91;display - * text]&#91;fully.qualified.proto.name]</code></pre> Text can - * be excluded from doc using the following notation: - * <pre><code>&#40;-- internal comment - * --&#41;</code></pre> A few directives are available in - * documentation. Note that directives must appear on a single line to be - * properly identified. The `include` directive includes a markdown file from - * an external source: <pre><code>&#40;== include path/to/file - * ==&#41;</code></pre> The `resource_for` directive marks a - * message to be the resource of a collection in REST view. If it is not - * specified, tools attempt to infer the resource from the operations in a - * collection: <pre><code>&#40;== resource_for - * v1.shelves.books ==&#41;</code></pre> The directive - * `suppress_warning` does not directly affect documentation and is documented - * together with service config validation. + * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -618,14 +429,7 @@ export namespace serviceusage_v1beta1 { */ documentationRootUrl?: string; /** - * Declares a single overview page. For example: - * <pre><code>documentation: summary: ... overview: - * &#40;== include overview.md ==&#41; </code></pre> - * This is a shortcut for the following declaration (using pages style): - * <pre><code>documentation: summary: ... pages: - name: - * Overview content: &#40;== include overview.md ==&#41; - * </code></pre> Note: you cannot specify both `overview` field - * and `pages` field. + * Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;== include overview.md ==&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: &#40;== include overview.md ==&#41; </code></pre> Note: you cannot specify both `overview` field and `pages` field. */ overview?: string; /** @@ -633,14 +437,11 @@ export namespace serviceusage_v1beta1 { */ pages?: Schema$Page[]; /** - * A list of documentation rules that apply to individual API elements. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; /** - * A short summary of what the service does. Can only be provided by plain - * text. + * A short summary of what the service does. Can only be provided by plain text. */ summary?: string; } @@ -649,8 +450,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$DocumentationRule { /** - * Deprecation description of the selected element(s). It can be provided if - * an element is marked as `deprecated`. + * Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ deprecationDescription?: string; /** @@ -658,22 +458,12 @@ export namespace serviceusage_v1beta1 { */ description?: string; /** - * The selector is a comma-separated list of patterns. Each pattern is a - * qualified name of the element which may end in "*", indicating - * a wildcard. Wildcards are only allowed at the end and for a whole - * component of the qualified name, i.e. "foo.*" is ok, but not - * "foo.b*" or "foo.*.bar". A wildcard will match one or - * more components. To specify a default for all applicable elements, the - * whole pattern "*" is used. + * The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. */ selector?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -694,9 +484,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$EnableServiceRequest {} /** - * Response message for the `EnableService` method. This response message is - * assigned to the `response` field of the returned Operation when that - * operation is done. + * Response message for the `EnableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$EnableServiceResponse { /** @@ -705,31 +493,15 @@ export namespace serviceusage_v1beta1 { service?: Schema$GoogleApiServiceusageV1Service; } /** - * `Endpoint` describes a network endpoint that serves a set of APIs. A - * service may expose any number of endpoints, and all endpoints share the - * same service configuration, such as quota configuration and monitoring - * configuration. Example service configuration: name: - * library-example.googleapis.com endpoints: # Below entry makes - * 'google.example.library.v1.Library' # API be served from - * endpoint address library-example.googleapis.com. # It also allows - * HTTP OPTIONS calls to be passed to the backend, for # it to decide - * whether the subsequent cross-origin request is # allowed to proceed. - * - name: library-example.googleapis.com allow_cors: true + * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ export interface Schema$Endpoint { /** - * DEPRECATED: This field is no longer supported. Instead of using aliases, - * please specify multiple google.api.Endpoint for each of the intended - * aliases. Additional names that this endpoint will be hosted on. + * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. */ aliases?: string[]; /** - * Allowing - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - * cross-domain traffic, would allow the backends served from this endpoint - * to receive and respond to HTTP OPTIONS requests. The response will be - * used by the browser to determine whether the subsequent cross-origin - * request is allowed to proceed. + * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. */ allowCors?: boolean; /** @@ -741,11 +513,7 @@ export namespace serviceusage_v1beta1 { */ name?: string; /** - * The specification of an Internet routable address of API frontend that - * will handle requests to this [API - * Endpoint](https://cloud.google.com/apis/design/glossary). It should be - * either a valid IPv4 address or a fully-qualified domain name. For - * example, "8.8.8.8" or "myservice.appspot.com". + * The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". */ target?: string; } @@ -791,16 +559,6 @@ export namespace serviceusage_v1beta1 { */ options?: Schema$Option[]; } - /** - * Experimental service configuration. These configuration options can only be - * used by whitelisted users. - */ - export interface Schema$Experimental { - /** - * Authorization configuration. - */ - authorization?: Schema$AuthorizationConfig; - } /** * A single field of a message type. */ @@ -830,9 +588,7 @@ export namespace serviceusage_v1beta1 { */ number?: number; /** - * The index of the field type in `Type.oneofs`, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. + * The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */ oneofIndex?: number; /** @@ -844,32 +600,16 @@ export namespace serviceusage_v1beta1 { */ packed?: boolean; /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + * The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ typeUrl?: string; } /** - * `Service` is the root object of Google service configuration schema. It - * describes basic information about a service, such as the name and the - * title, and delegates other aspects to sub-sections. Each sub-section is - * either a proto message or a repeated proto message that configures a - * specific aspect, such as auth. See each proto message definition for - * details. Example: type: google.api.Service config_version: 3 - * name: calendar.googleapis.com title: Google Calendar API apis: - - * name: google.calendar.v3.Calendar authentication: providers: - - * id: google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth + * `Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ export interface Schema$GoogleApiService { /** - * A list of API interfaces exported by this service. Only the `name` field - * of the google.protobuf.Api needs to be provided by the configuration - * author, as the remaining fields will be derived from the IDL during the - * normalization process. It is an error to specify an API interface here - * which cannot be resolved against the associated IDL files. + * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; /** @@ -885,10 +625,7 @@ export namespace serviceusage_v1beta1 { */ billing?: Schema$Billing; /** - * The semantic version of the service configuration. The config version - * affects the interpretation of the service configuration. For example, - * certain features are enabled by default for certain config versions. The - * latest config version is `3`. + * The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`. */ configVersion?: number; /** @@ -908,30 +645,19 @@ export namespace serviceusage_v1beta1 { */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. If this is empty, then an endpoint - * with the same name as the service is automatically generated to service - * all defined APIs. + * Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */ endpoints?: Schema$Endpoint[]; /** - * A list of all enum types included in this API service. Enums referenced - * directly or indirectly by the `apis` are automatically included. Enums - * which are not referenced but shall be included should be listed here by - * name. Example: enums: - name: google.someapi.v1.SomeEnum + * A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum */ enums?: Schema$Enum[]; - /** - * Experimental configuration. - */ - experimental?: Schema$Experimental; /** * HTTP configuration. */ http?: Schema$Http; /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. Must be no longer than 60 characters. + * A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters. */ id?: string; /** @@ -947,8 +673,7 @@ export namespace serviceusage_v1beta1 { */ metrics?: Schema$MetricDescriptor[]; /** - * Defines the monitored resources used by this service. This is required by - * the Service.monitoring and Service.logging configurations. + * Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */ monitoredResources?: Schema$MonitoredResourceDescriptor[]; /** @@ -956,10 +681,7 @@ export namespace serviceusage_v1beta1 { */ monitoring?: Schema$Monitoring; /** - * The service name, which is a DNS-like logical identifier for the service, - * such as `calendar.googleapis.com`. The service name typically goes - * through DNS verification to make sure the owner of the service also owns - * the DNS name. + * The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. */ name?: string; /** @@ -979,11 +701,7 @@ export namespace serviceusage_v1beta1 { */ systemParameters?: Schema$SystemParameters; /** - * A list of all proto message types included in this API service. It serves - * similar purpose as [google.api.Service.types], except that these types - * are not needed by user-defined APIs. Therefore, they will not show up in - * the generated discovery doc. This field should only be used to define - * system APIs in ESF. + * A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. */ systemTypes?: Schema$Type[]; /** @@ -991,11 +709,7 @@ export namespace serviceusage_v1beta1 { */ title?: string; /** - * A list of all proto message types included in this API service. Types - * referenced directly or indirectly by the `apis` are automatically - * included. Messages which are not referenced but shall be included, such - * as types used by the `google.protobuf.Any` type, should be listed here by - * name. Example: types: - name: google.protobuf.Int32 + * A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32 */ types?: Schema$Type[]; /** @@ -1008,8 +722,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$GoogleApiServiceusageV1OperationMetadata { /** - * The full name of the resources that this operation is directly associated - * with. + * The full name of the resources that this operation is directly associated with. */ resourceNames?: string[]; } @@ -1018,15 +731,11 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$GoogleApiServiceusageV1Service { /** - * The service configuration of the available service. Some fields may be - * filtered out of the configuration in responses to the `ListServices` - * method. These fields are present only in responses to the `GetService` - * method. + * The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. */ config?: Schema$GoogleApiServiceusageV1ServiceConfig; /** - * The resource name of the consumer and service. A valid name would be: - - * projects/123/services/serviceusage.googleapis.com + * The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */ name?: string; /** @@ -1043,8 +752,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$GoogleApiServiceusageV1ServiceConfig { /** - * A list of API interfaces exported by this service. Contains only the - * names, versions, and method names of the interfaces. + * A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. */ apis?: Schema$Api[]; /** @@ -1052,18 +760,15 @@ export namespace serviceusage_v1beta1 { */ authentication?: Schema$Authentication; /** - * Additional API documentation. Contains only the summary and the - * documentation URL. + * Additional API documentation. Contains only the summary and the documentation URL. */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. Contains only the names and aliases - * of the endpoints. + * Configuration for network endpoints. Contains only the names and aliases of the endpoints. */ endpoints?: Schema$Endpoint[]; /** - * The DNS address at which this service is available. An example DNS - * address would be: `calendar.googleapis.com`. + * The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */ name?: string; /** @@ -1080,198 +785,32 @@ export namespace serviceusage_v1beta1 { usage?: Schema$Usage; } /** - * Defines the HTTP configuration for an API service. It contains a list of - * HttpRule, each specifying the mapping of an RPC method to one or more HTTP - * REST API methods. + * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. */ export interface Schema$Http { /** - * When set to true, URL path parameters will be fully URI-decoded except in - * cases of single segment matches in reserved expansion, where - * "%2F" will be left encoded. The default behavior is to not - * decode RFC 6570 reserved characters in multi segment matches. + * When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. */ fullyDecodeReservedExpansion?: boolean; /** - * A list of HTTP configuration rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. + * A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$HttpRule[]; } /** - * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - * gRPC method and one or more HTTP REST endpoints. It allows developers to - * build a single API service that supports both gRPC APIs and REST APIs. Many - * systems, including [Google APIs](https://github.com/googleapis/googleapis), - * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and - * use it for large scale production services. `HttpRule` defines the schema - * of the gRPC/REST mapping. The mapping specifies how different portions of - * the gRPC request message are mapped to the URL path, URL query parameters, - * and HTTP request body. It also controls how the gRPC response message is - * mapped to the HTTP response body. `HttpRule` is typically specified as an - * `google.api.http` annotation on the gRPC method. Each mapping specifies a - * URL path template and an HTTP method. The path template may refer to one or - * more fields in the gRPC request message, as long as each field is a - * non-repeated field with a primitive (non-message) type. The path template - * controls how fields of the request message are mapped to the URL path. - * Example: service Messaging { rpc GetMessage(GetMessageRequest) - * returns (Message) { option (google.api.http) = { get: - * "/v1/{name=messages/*}" }; } } message - * GetMessageRequest { string name = 1; // Mapped to URL path. } - * message Message { string text = 1; // The resource content. } - * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC - * -----|----- `GET /v1/messages/123456` | `GetMessage(name: - * "messages/123456")` Any fields in the request message which are - * not bound by the path template automatically become HTTP query parameters - * if there is no HTTP request body. For example: service Messaging { rpc - * GetMessage(GetMessageRequest) returns (Message) { option - * (google.api.http) = { get:"/v1/messages/{message_id}" - * }; } } message GetMessageRequest { message SubMessage { - * string subfield = 1; } string message_id = 1; // Mapped to URL - * path. int64 revision = 2; // Mapped to URL query parameter - * `revision`. SubMessage sub = 3; // Mapped to URL query parameter - * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - * HTTP | gRPC -----|----- `GET - * /v1/messages/123456?revision=2&sub.subfield=foo` | - * `GetMessage(message_id: "123456" revision: 2 sub: - * SubMessage(subfield: "foo"))` Note that fields which are mapped - * to URL query parameters must have a primitive type or a repeated primitive - * type or a non-repeated message type. In the case of a repeated type, the - * parameter can be repeated in the URL as `...?param=A&param=B`. In the - * case of a message type, each field of the message is mapped to a separate - * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods - * that allow a request body, the `body` field specifies the mapping. Consider - * a REST update method on the message resource collection: service - * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) - * { option (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "message" - * }; } } message UpdateMessageRequest { string message_id - * = 1; // mapped to the URL Message message = 2; // mapped to the - * body } The following HTTP JSON to RPC mapping is enabled, where the - * representation of the JSON in the request body is determined by protos JSON - * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { - * "text": "Hi!" }` | `UpdateMessage(message_id: - * "123456" message { text: "Hi!" })` The special name - * `*` can be used in the body mapping to define that every field not bound by - * the path template should be mapped to the request body. This enables the - * following alternative definition of the update method: service - * Messaging { rpc UpdateMessage(Message) returns (Message) { option - * (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "*" }; } } - * message Message { string message_id = 1; string text = 2; } - * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- - * `PATCH /v1/messages/123456 { "text": "Hi!" }` | - * `UpdateMessage(message_id: "123456" text: "Hi!")` Note - * that when using `*` in the body mapping, it is not possible to have HTTP - * parameters, as all fields not bound by the path end in the body. This makes - * this option more rarely used in practice when defining REST APIs. The - * common usage of `*` is in custom methods which don't use the URL at all - * for transferring data. It is possible to define multiple HTTP methods for - * one RPC by using the `additional_bindings` option. Example: service - * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { - * option (google.api.http) = { get: - * "/v1/messages/{message_id}" additional_bindings { get: - * "/v1/users/{user_id}/messages/{message_id}" } }; } } - * message GetMessageRequest { string message_id = 1; string - * user_id = 2; } This enables the following two alternative HTTP JSON to - * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - * `GetMessage(message_id: "123456")` `GET - * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" - * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf - * request fields (recursive expansion nested messages in the request message) - * are classified into three categories: - Fields referred by the path - * template. They are passed via the URL path. - Fields referred by the - * HttpRule.body. They are passed via the HTTP request body. - All - * other fields are passed via the URL query parameters, and the parameter - * name is the field path in the request message. A repeated field can be - * represented as multiple query parameters under the same name. 2. If - * HttpRule.body is "*", there is no URL query parameter, all fields - * are passed via URL path and HTTP request body. 3. If HttpRule.body is - * omitted, there is no HTTP request body, all fields are passed via URL - * path and URL query parameters. ### Path template syntax Template = - * "/" Segments [ Verb ] ; Segments = Segment { "/" - * Segment } ; Segment = "*" | "**" | LITERAL | - * Variable ; Variable = "{" FieldPath [ "=" Segments - * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb - * = ":" LITERAL ; The syntax `*` matches a single URL path - * segment. The syntax `**` matches zero or more URL path segments, which must - * be the last part of the URL path except the `Verb`. The syntax `Variable` - * matches part of the URL path as specified by its template. A variable - * template must not contain other variables. If a variable matches a single - * path segment, its template may be omitted, e.g. `{var}` is equivalent to - * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If - * the `LITERAL` contains any reserved character, such characters should be - * percent-encoded before the matching. If a variable contains exactly one - * path segment, such as `"{var}"` or `"{var=*}"`, when - * such a variable is expanded into a URL path on the client side, all - * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - * does the reverse decoding. Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{var}`. If a variable contains multiple path segments, such as - * `"{var=foo/*}"` or `"{var=**}"`, when such a variable - * is expanded into a URL path on the client side, all characters except - * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse - * decoding, except "%2F" and "%2f" are left unchanged. - * Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - * Configuration (service config) is a configuration language for configuring - * a gRPC service to become a user-facing product. The service config is - * simply the YAML representation of the `google.api.Service` proto message. - * As an alternative to annotating your proto file, you can configure gRPC - * transcoding in your service config YAML files. You do this by specifying a - * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - * effect as the proto annotation. This can be particularly useful if you have - * a proto that is reused in multiple services. Note that any transcoding - * specified in the service config will override any matching transcoding - * configuration in the proto. Example: http: rules: # - * Selects a gRPC method and applies HttpRule to it. - selector: - * example.v1.Messaging.GetMessage get: - * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON - * conversion must follow the [proto3 - * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - * While the single segment variable follows the semantics of [RFC - * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - * Expansion, the multi segment variable **does not** follow RFC 6570 - * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - * does not expand special characters like `?` and `#`, which would lead to - * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for - * multi segment variables. The path variables **must not** refer to any - * repeated or mapped field, because client libraries are not capable of - * handling such variable expansion. The path variables **must not** capture - * the leading "/" character. The reason is that the most common use - * case "{var}" does not capture the leading "/" - * character. For consistency, all path variables must share the same - * behavior. Repeated message fields must not be mapped to URL query - * parameters, because no client library can support such complicated mapping. - * If an API needs to use a JSON array for request or response body, it can - * map the request or response body to a repeated field. However, some gRPC - * Transcoding implementations may not support this feature. + * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** - * Additional HTTP bindings for the selector. Nested bindings must not - * contain an `additional_bindings` field themselves (that is, the nesting - * may only be one level deep). + * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; /** - * The name of the request field whose value is mapped to the HTTP request - * body, or `*` for mapping all request fields not captured by the path - * pattern to the HTTP body, or omitted for not having any HTTP request - * body. NOTE: the referred field must be present at the top-level of the - * request message type. + * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ body?: string; /** - * The custom pattern is used for specifying an HTTP method that is not - * included in the `pattern` field, such as HEAD, or "*" to leave - * the HTTP method unspecified for this rule. The wild-card rule is useful - * for services that provide content to Web (HTML) clients. + * The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. */ custom?: Schema$CustomHttpPattern; /** @@ -1279,8 +818,7 @@ export namespace serviceusage_v1beta1 { */ delete?: string; /** - * Maps to HTTP GET. Used for listing and getting information about - * resources. + * Maps to HTTP GET. Used for listing and getting information about resources. */ get?: string; /** @@ -1296,15 +834,11 @@ export namespace serviceusage_v1beta1 { */ put?: string; /** - * Optional. The name of the response field whose value is mapped to the - * HTTP response body. When omitted, the entire response message will be - * used as the HTTP response body. NOTE: The referred field must be present - * at the top-level of the response message type. + * Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. */ responseBody?: string; /** - * Selects a method to which this rule applies. Refer to selector for - * syntax details. + * Selects a method to which this rule applies. Refer to selector for syntax details. */ selector?: string; } @@ -1352,82 +886,49 @@ export namespace serviceusage_v1beta1 { services?: Schema$Service[]; } /** - * A description of a log type. Example in YAML format: - name: - * library.googleapis.com/activity_history description: The history of - * borrowing and returning library items. display_name: Activity labels: - * - key: /customer_id description: Identifier of a library customer + * A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items. display_name: Activity labels: - key: /customer_id description: Identifier of a library customer */ export interface Schema$LogDescriptor { /** - * A human-readable description of this log. This information appears in the - * documentation and can contain details. + * A human-readable description of this log. This information appears in the documentation and can contain details. */ description?: string; /** - * The human-readable name for this log. This information appears on the - * user interface and should be concise. + * The human-readable name for this log. This information appears on the user interface and should be concise. */ displayName?: string; /** - * The set of labels that are available to describe a specific log entry. - * Runtime requests that contain labels not specified here are considered - * invalid. + * The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ labels?: Schema$LabelDescriptor[]; /** - * The name of the log. It must be less than 512 characters long and can - * include the following characters: upper- and lower-case alphanumeric - * characters [A-Za-z0-9], and punctuation characters including slash, - * underscore, hyphen, period [/_-.]. + * The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. */ name?: string; } /** - * Logging configuration of the service. The following example shows how to - * configure logs to be sent to the producer and consumer projects. In the - * example, the `activity_history` log is sent to both the producer and - * consumer projects, whereas the `purchase_history` log is only sent to the - * producer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. logs: - name: activity_history - * labels: - key: /customer_id - name: purchase_history logging: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - - * purchase_history consumer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history + * Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history */ export interface Schema$Logging { /** - * Logging configurations for sending logs to the consumer project. There - * can be multiple consumer destinations, each one must have a different - * monitored resource type. A log can be used in at most one consumer - * destination. + * Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination. */ consumerDestinations?: Schema$LoggingDestination[]; /** - * Logging configurations for sending logs to the producer project. There - * can be multiple producer destinations, each one must have a different - * monitored resource type. A log can be used in at most one producer - * destination. + * Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination. */ producerDestinations?: Schema$LoggingDestination[]; } /** - * Configuration of a specific logging destination (the producer project or - * the consumer project). + * Configuration of a specific logging destination (the producer project or the consumer project). */ export interface Schema$LoggingDestination { /** - * Names of the logs to be sent to this destination. Each name must be - * defined in the Service.logs section. If the log name is not a domain - * scoped name, it will be automatically prefixed with the service name - * followed by "/". + * Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". */ logs?: string[]; /** - * The monitored resource type. The type must be defined in the - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in the Service.monitored_resources section. */ monitoredResource?: string; } @@ -1465,9 +966,7 @@ export namespace serviceusage_v1beta1 { syntax?: string; } /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. + * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. */ export interface Schema$MetricDescriptor { /** @@ -1475,28 +974,23 @@ export namespace serviceusage_v1beta1 { */ description?: string; /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. + * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. */ displayName?: string; /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * `appengine.googleapis.com/http/server/response_latencies` metric type has - * a label for the HTTP response code, `response_code`, so you can look at - * latencies for successful responses or just for responses that failed. + * The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ metadata?: Schema$MetricDescriptorMetadata; /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of `metric_kind` and `value_type` might not be - * supported. + * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string; /** @@ -1504,47 +998,15 @@ export namespace serviceusage_v1beta1 { */ name?: string; /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * `custom.googleapis.com` or `external.googleapis.com`. Metric types - * should use a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" + * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" */ type?: string; /** - * The unit in which the metric value is reported. It is only applicable if - * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported - * units are a subset of [The Unified Code for Units of - * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units - * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute - * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo - * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera - * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` - * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * - * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico - * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` - * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * - * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) - * **Grammar** The grammar also includes these connectors: * `/` division - * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix - * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression - * = Component { "." Component } { "/" Component } ; - * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | - * Annotation | "1" ; Annotation - * = "{" NAME "}" ; Notes: * `Annotation` is just a - * comment if it follows a `UNIT` and is equivalent to `1` if it is used - * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == - * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not - * containing '{' or '}'. * `1` represents dimensionless - * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, - * and annotates values giving a percentage. + * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. */ unit?: string; /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of `metric_kind` and `value_type` might not be supported. + * Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ valueType?: string; } @@ -1553,77 +1015,33 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$MetricDescriptorMetadata { /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. + * The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. + * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string; } /** - * Bind API methods to metrics. Binding a method to a metric causes that - * metric's configured quota behaviors to apply to the method call. + * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. */ export interface Schema$MetricRule { /** - * Metrics to update when the selected methods are called, and the - * associated cost applied to each metric. The key of the map is the metric - * name, and the values are the amount increased for the metric against - * which the quota limits are defined. The value must not be negative. + * Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. */ metricCosts?: {[key: string]: string}; /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. + * Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } /** - * Declares an API Interface to be included in this interface. The including - * interface must redeclare all the methods from the included interface, but - * documentation and options are inherited as follows: - If after comment and - * whitespace stripping, the documentation string of the redeclared method - * is empty, it will be inherited from the original method. - Each - * annotation belonging to the service config (http, visibility) which is - * not set in the redeclared method will be inherited. - If an http - * annotation is inherited, the path pattern will be modified as follows. - * Any version prefix will be replaced by the version of the including - * interface plus the root path if specified. Example of a simple mixin: - * package google.acl.v1; service AccessControl { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } - * package google.storage.v2; service Storage { // rpc - * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc - * GetData(GetDataRequest) returns (Data) { option - * (google.api.http).get = "/v2/{resource=**}"; } } - * Example of a mixin configuration: apis: - name: - * google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl The mixin construct implies that all methods - * in `AccessControl` are also declared with same name and request/response - * types in `Storage`. A documentation generator or annotation processor will - * see the effective `Storage.GetAcl` method after inherting documentation and - * annotations as follows: service Storage { // Get the underlying - * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... - * } Note how the version in the path pattern changed from `v1` to `v2`. If - * the `root` field in the mixin is specified, it should be a relative path - * under which inherited HTTP paths are placed. Example: apis: - - * name: google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl root: acls This implies the following - * inherited HTTP annotation: service Storage { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; - * } ... } + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } */ export interface Schema$Mixin { /** @@ -1631,149 +1049,80 @@ export namespace serviceusage_v1beta1 { */ name?: string; /** - * If non-empty specifies a path under which inherited HTTP paths are - * rooted. + * If non-empty specifies a path under which inherited HTTP paths are rooted. */ root?: string; } /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * `"gce_instance"` and specifies the use of the labels - * `"instance_id"` and `"zone"` to identify particular VM - * instances. Different APIs can support different monitored resource types. - * APIs generally provide a `list` method that returns the monitored resource - * descriptors used by the API. + * An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. */ export interface Schema$MonitoredResourceDescriptor { /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. + * Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, `"Google - * Cloud SQL Database"`. + * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. */ displayName?: string; /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels `"database_id"` and - * `"zone"`. + * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. */ labels?: Schema$LabelDescriptor[]; /** - * Optional. The resource name of the monitored resource descriptor: - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` - * where {type} is the value of the `type` field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format `"monitoredResourceDescriptors/{type}"`. + * Optional. The launch stage of the monitored resource definition. + */ + launchStage?: string; + /** + * Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. */ name?: string; /** - * Required. The monitored resource type. For example, the type - * `"cloudsql_database"` represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. + * Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. */ type?: string; } /** - * Monitoring configuration of the service. The example below shows how to - * configure monitored resources and metrics for monitoring. In the example, a - * monitored resource and two metrics are defined. The - * `library.googleapis.com/book/returned_count` metric is sent to both - * producer and consumer projects, whereas the - * `library.googleapis.com/book/overdue_count` metric is only sent to the - * consumer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. metrics: - name: - * library.googleapis.com/book/returned_count metric_kind: DELTA - * value_type: INT64 labels: - key: /customer_id - name: - * library.googleapis.com/book/overdue_count metric_kind: GAUGE - * value_type: INT64 labels: - key: /customer_id monitoring: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count consumer_destinations: - - * monitored_resource: library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count - - * library.googleapis.com/book/overdue_count + * Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count */ export interface Schema$Monitoring { /** - * Monitoring configurations for sending metrics to the consumer project. - * There can be multiple consumer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ consumerDestinations?: Schema$MonitoringDestination[]; /** - * Monitoring configurations for sending metrics to the producer project. - * There can be multiple producer destinations. A monitored resouce type may - * appear in multiple monitoring destinations if different aggregations are - * needed for different sets of metrics associated with that monitored - * resource type. A monitored resource and metric pair may only be used once - * in the Monitoring configuration. + * Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resouce type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration. */ producerDestinations?: Schema$MonitoringDestination[]; } /** - * Configuration of a specific monitoring destination (the producer project or - * the consumer project). + * Configuration of a specific monitoring destination (the producer project or the consumer project). */ export interface Schema$MonitoringDestination { /** - * Types of the metrics to report to this monitoring destination. Each type - * must be defined in Service.metrics section. + * Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ metrics?: string[]; /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. + * The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } /** - * OAuth scopes are a way to define data and permissions on data. For example, - * there are scopes defined for "Read-only access to Google - * Calendar" and "Access to Cloud Platform". Users can consent - * to a scope for an application, giving it permission to access that data on - * their behalf. OAuth scope specifications should be fairly coarse grained; - * a user will need to see and understand the text description of what your - * scope means. In most cases: use one or at most two OAuth scopes for an - * entire family of products. If your product has multiple APIs, you should - * probably be sharing the OAuth scope across all of those APIs. When you - * need finer grained OAuth consent screens: talk with your product management - * about how developers will use them in practice. Please note that even - * though each of the canonical scopes is enough for a request to be accepted - * and passed to the backend, a request can still fail due to the backend - * requiring additional scopes or permissions. + * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. */ export interface Schema$OAuthRequirements { /** - * The list of publicly documented OAuth scopes that are allowed access. An - * OAuth token containing any of these scopes will be accepted. Example: - * canonical_scopes: https://www.googleapis.com/auth/calendar, - * https://www.googleapis.com/auth/calendar.read + * The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read */ canonicalScopes?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -1781,26 +1130,15 @@ export namespace serviceusage_v1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -1809,85 +1147,42 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$OperationMetadata { /** - * The full name of the resources that this operation is directly associated - * with. + * The full name of the resources that this operation is directly associated with. */ resourceNames?: string[]; } /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ export interface Schema$Option { /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * `"map_entry"`. For custom options, it should be the - * fully-qualified name. For example, `"google.api.http"`. + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. */ name?: string; /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. */ value?: {[key: string]: any}; } /** - * Represents a documentation page. A page can contain subpages to represent - * nested documentation set structure. + * Represents a documentation page. A page can contain subpages to represent nested documentation set structure. */ export interface Schema$Page { /** - * The Markdown content of the page. You can use <code>&#40;== - * include {path} ==&#41;</code> to include content from a - * Markdown file. + * The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. */ content?: string; /** - * The name of the page. It will be used as an identity of the page to - * generate URI of the page, text of the link to this page in navigation, - * etc. The full page name (start from the root page name to this page - * concatenated with `.`) can be used as reference to the page in your - * documentation. For example: <pre><code>pages: - name: - * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - * - name: Java content: &#40;== include tutorial_java.md - * ==&#41; </code></pre> You can reference `Java` page using - * Markdown reference link syntax: `Java`. + * The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. */ name?: string; /** - * Subpages of this page. The order of subpages specified here will be - * honored in the generated docset. + * Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ subpages?: Schema$Page[]; } /** - * Quota configuration helps to achieve fairness and budgeting in service - * usage. The metric based quota configuration works this way: - The service - * configuration defines a set of metrics. - For API calls, the - * quota.metric_rules maps methods to metrics with corresponding costs. - - * The quota.limits defines limits on the metrics, which will be used for - * quota checks at runtime. An example quota configuration in yaml format: - * quota: limits: - name: apiWriteQpsPerProject metric: - * library.googleapis.com/write_calls unit: "1/min/{project}" - * # rate limit for consumer projects values: STANDARD: 10000 - * # The metric rules bind all methods to the read_calls metric, # except - * for the UpdateBook and DeleteBook methods. These two methods # are - * mapped to the write_calls metric, with the UpdateBook method # - * consuming at twice rate as the DeleteBook method. metric_rules: - - * selector: "*" metric_costs: - * library.googleapis.com/read_calls: 1 - selector: - * google.example.library.v1.LibraryService.UpdateBook metric_costs: - * library.googleapis.com/write_calls: 2 - selector: - * google.example.library.v1.LibraryService.DeleteBook metric_costs: - * library.googleapis.com/write_calls: 1 Corresponding Metric definition: - * metrics: - name: library.googleapis.com/read_calls display_name: Read - * requests metric_kind: DELTA value_type: INT64 - name: - * library.googleapis.com/write_calls display_name: Write requests - * metric_kind: DELTA value_type: INT64 + * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 */ export interface Schema$Quota { /** @@ -1895,93 +1190,52 @@ export namespace serviceusage_v1beta1 { */ limits?: Schema$QuotaLimit[]; /** - * List of `MetricRule` definitions, each one mapping a selected method to - * one or more metrics. + * List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */ metricRules?: Schema$MetricRule[]; } /** - * `QuotaLimit` defines a specific limit that applies over a specified - * duration for a limit type. There can be at most one limit for a duration - * and limit type combination defined within a `QuotaGroup`. + * `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. */ export interface Schema$QuotaLimit { /** - * Default number of tokens that can be consumed during the specified - * duration. This is the number of tokens assigned when a client application - * developer activates the service for his/her project. Specifying a value - * of 0 will block all requests. This can be used if you are provisioning - * quota to selected consumers and blocking others. Similarly, a value of -1 - * will indicate an unlimited quota. No other negative values are allowed. - * Used by group-based quotas only. + * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. */ defaultLimit?: string; /** - * Optional. User-visible, extended description for this quota limit. Should - * be used only when more context is needed to understand this limit than - * provided by the limit's display name (see: `display_name`). + * Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). */ description?: string; /** - * User-visible display name for this limit. Optional. If not set, the UI - * will provide a default display name based on the quota configuration. - * This field can be used to override the default display name generated - * from the configuration. + * User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. */ displayName?: string; /** - * Duration of this limit in textual notation. Example: "100s", - * "24h", "1d". For duration longer than a day, only - * multiple of days is supported. We support only "100s" and - * "1d" for now. Additional support will be added in the future. - * "0" indicates indefinite duration. Used by group-based quotas - * only. + * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. */ duration?: string; /** - * Free tier value displayed in the Developers Console for this limit. The - * free tier is the number of tokens that will be subtracted from the billed - * amount when billing is enabled. This field can only be set on a limit - * with duration "1d", in a billable group; it is invalid on any - * other limit. If this field is not set, it defaults to 0, indicating that - * there is no free tier for this service. Used by group-based quotas only. + * Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. */ freeTier?: string; /** - * Maximum number of tokens that can be consumed during the specified - * duration. Client application developers can override the default limit up - * to this maximum. If specified, this value cannot be set to a value less - * than the default limit. If not specified, it is set to the default limit. - * To allow clients to apply overrides with no upper bound, set this to -1, - * indicating unlimited maximum quota. Used by group-based quotas only. + * Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. */ maxLimit?: string; /** - * The name of the metric this quota limit applies to. The quota limits with - * the same metric will be checked together during runtime. The metric must - * be defined within the service config. + * The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. */ metric?: string; /** - * Name of the quota limit. The name must be provided, and it must be - * unique within the service. The name can only include alphanumeric - * characters as well as '-'. The maximum length of the limit name - * is 64 characters. + * Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. */ name?: string; /** - * Specify the unit of the quota limit. It uses the same syntax as - * Metric.unit. The supported unit kinds are determined by the quota backend - * system. Here are some examples: * "1/min/{project}" for quota - * per minute per project. Note: the order of unit components is - * insignificant. The "1" at the beginning is required to follow - * the metric unit syntax. + * Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. */ unit?: string; /** - * Tiered limit values. You must specify this as a key:value pair, with an - * integer value that is the maximum number of requests allowed for the - * specified unit. Currently only STANDARD is supported. + * Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. */ values?: {[key: string]: string}; } @@ -1990,38 +1244,15 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$QuotaOverride { /** - * If this map is nonempty, then this override applies only to specific - * values for dimensions defined in the limit unit. For example, an - * override on a limit with the unit 1/{project}/{region} could contain an - * entry with the key "region" and the value - * "us-east-1"; the override is only applied to quota consumed in - * that region. This map has the following restrictions: - Keys that are - * not defined in the limit's unit are not valid keys. Any string - * appearing in {brackets} in the unit (besides {project} or {user}) is a - * defined key. - "project" is not a valid key; the project is - * already specified in the parent resource name. - "user" is - * not a valid key; the API does not support quota overrides that apply - * only to a specific user. - If "region" appears as a key, its - * value must be a valid Cloud region. - If "zone" appears as a - * key, its value must be a valid Cloud zone. - If any valid key other than - * "region" or "zone" appears in the map, then all - * valid keys other than "region" or "zone" must also - * appear in the map. + * If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: - Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. - "project" is not a valid key; the project is already specified in the parent resource name. - "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. - If "region" appears as a key, its value must be a valid Cloud region. - If "zone" appears as a key, its value must be a valid Cloud zone. - If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map. */ dimensions?: {[key: string]: string}; /** - * The resource name of the override. This name is generated by the server - * when the override is created. Example names would be: - * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - * The resource name is intended to be opaque and should not be parsed for - * its component strings, since its representation could change in the - * future. + * The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future. */ name?: string; /** - * The overriding quota limit value. Can be any nonnegative integer, or -1 - * (unlimited quota). + * The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */ overrideValue?: string; } @@ -2030,15 +1261,11 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$Service { /** - * The service configuration of the available service. Some fields may be - * filtered out of the configuration in responses to the `ListServices` - * method. These fields are present only in responses to the `GetService` - * method. + * The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. */ config?: Schema$ServiceConfig; /** - * The resource name of the consumer and service. A valid name would be: - - * projects/123/services/serviceusage.googleapis.com + * The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */ name?: string; /** @@ -2055,8 +1282,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$ServiceConfig { /** - * A list of API interfaces exported by this service. Contains only the - * names, versions, and method names of the interfaces. + * A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. */ apis?: Schema$Api[]; /** @@ -2064,18 +1290,15 @@ export namespace serviceusage_v1beta1 { */ authentication?: Schema$Authentication; /** - * Additional API documentation. Contains only the summary and the - * documentation URL. + * Additional API documentation. Contains only the summary and the documentation URL. */ documentation?: Schema$Documentation; /** - * Configuration for network endpoints. Contains only the names and aliases - * of the endpoints. + * Configuration for network endpoints. Contains only the names and aliases of the endpoints. */ endpoints?: Schema$Endpoint[]; /** - * The DNS address at which this service is available. An example DNS - * address would be: `calendar.googleapis.com`. + * The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */ name?: string; /** @@ -2092,14 +1315,11 @@ export namespace serviceusage_v1beta1 { usage?: Schema$Usage; } /** - * `SourceContext` represents information about the source of a protobuf - * element, like the file in which it is defined. + * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ export interface Schema$SourceContext { /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * `"google/protobuf/source_context.proto"`. + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ fileName?: string; } @@ -2113,40 +1333,7 @@ export namespace serviceusage_v1beta1 { sourceFiles?: Array<{[key: string]: any}>; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -2154,78 +1341,50 @@ export namespace serviceusage_v1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Define a parameter's name and location. The parameter may be passed as - * either an HTTP header or a URL query parameter, and if both are passed the - * behavior is implementation-dependent. + * Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent. */ export interface Schema$SystemParameter { /** - * Define the HTTP header name to use for the parameter. It is case - * insensitive. + * Define the HTTP header name to use for the parameter. It is case insensitive. */ httpHeader?: string; /** - * Define the name of the parameter, such as "api_key" . It is - * case sensitive. + * Define the name of the parameter, such as "api_key" . It is case sensitive. */ name?: string; /** - * Define the URL query parameter name to use for the parameter. It is case - * sensitive. + * Define the URL query parameter name to use for the parameter. It is case sensitive. */ urlQueryParameter?: string; } /** - * Define a system parameter rule mapping system parameter definitions to - * methods. + * Define a system parameter rule mapping system parameter definitions to methods. */ export interface Schema$SystemParameterRule { /** - * Define parameters. Multiple names may be defined for a parameter. For a - * given method call, only one of them should be used. If multiple names are - * used the behavior is implementation-dependent. If none of the specified - * names are present the behavior is parameter-dependent. + * Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent. */ parameters?: Schema$SystemParameter[]; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; } /** - * ### System parameter configuration A system parameter is a special kind of - * parameter defined by the API system, not by an individual API. It is - * typically mapped to an HTTP header and/or a URL query parameter. This - * configuration specifies which methods change the names of the system - * parameters. + * ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. */ export interface Schema$SystemParameters { /** - * Define system parameters. The parameters defined here will override the - * default parameters implemented by the system. If this field is missing - * from the service config, default system parameters will be used. Default - * system parameters and names is implementation-dependent. Example: define - * api key for all methods system_parameters rules: - - * selector: "*" parameters: - name: api_key - * url_query_parameter: api_key Example: define 2 api key names for a - * specific method. system_parameters rules: - selector: - * "/ListShelves" parameters: - name: - * api_key http_header: Api-Key1 - name: api_key - * http_header: Api-Key2 **NOTE:** All service configuration rules follow - * "last one wins" order. + * Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$SystemParameterRule[]; } @@ -2263,57 +1422,32 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$Usage { /** - * The full resource name of a channel used for sending notifications to the - * service producer. Google Service Management currently only supports - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - * channel. To use Google Cloud Pub/Sub as the channel, this must be the - * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name - * format documented in https://cloud.google.com/pubsub/docs/overview. + * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. */ producerNotificationChannel?: string; /** - * Requirements that must be satisfied before a consumer project can use the - * service. Each requirement is of the form - * <service.name>/<requirement-id>; for example - * 'serviceusage.googleapis.com/billing-enabled'. + * Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. */ requirements?: string[]; /** - * A list of usage rules that apply to individual API methods. **NOTE:** - * All service configuration rules follow "last one wins" order. + * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use - * this rule to configure unregistered calls for the service. Unregistered - * calls are calls that do not contain consumer project identity. (Example: - * calls that do not contain an API key). By default, API methods do not allow - * unregistered calls, and each method call must be identified by a consumer - * project identity. Use this rule to allow/disallow unregistered calls. - * Example of an API that wants to allow unregistered calls for entire - * service. usage: rules: - selector: "*" - * allow_unregistered_calls: true Example of a method that wants to allow - * unregistered calls. usage: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allow_unregistered_calls: true + * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that - * don't identify any user or application. + * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */ allowUnregisteredCalls?: boolean; /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. + * Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; /** - * If true, the selected method should skip service control and the control - * plane features, such as quota and billing, will not be available. This - * flag is used by Google Cloud Endpoints to bypass checks for internal - * methods, such as service health check methods. + * If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. */ skipServiceControl?: boolean; } @@ -2326,9 +1460,7 @@ export namespace serviceusage_v1beta1 { /** * serviceusage.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias serviceusage.operations.get * @memberOf! () * @@ -2398,15 +1530,7 @@ export namespace serviceusage_v1beta1 { /** * serviceusage.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias serviceusage.operations.list * @memberOf! () * @@ -2526,9 +1650,7 @@ export namespace serviceusage_v1beta1 { /** * serviceusage.services.batchEnable - * @desc Enable multiple services on a project. The operation is atomic: if - * enabling any service fails, then the entire batch fails, and no state - * changes occur. Operation + * @desc Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation * @alias serviceusage.services.batchEnable * @memberOf! () * @@ -2603,12 +1725,7 @@ export namespace serviceusage_v1beta1 { /** * serviceusage.services.disable - * @desc Disable a service so that it can no longer be used with a project. - * This prevents unintended usage that may cause unexpected billing charges - * or security leaks. It is not valid to call the disable method on a - * service that is not currently enabled. Callers will receive a - * `FAILED_PRECONDITION` status if the target service is not currently - * enabled. Operation + * @desc Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation * @alias serviceusage.services.disable * @memberOf! () * @@ -2682,8 +1799,7 @@ export namespace serviceusage_v1beta1 { /** * serviceusage.services.enable - * @desc Enable a service so that it can be used with a project. - * Operation + * @desc Enable a service so that it can be used with a project. Operation * @alias serviceusage.services.enable * @memberOf! () * @@ -2757,8 +1873,7 @@ export namespace serviceusage_v1beta1 { /** * serviceusage.services.get - * @desc Returns the service configuration and enabled state for a given - * service. + * @desc Returns the service configuration and enabled state for a given service. * @alias serviceusage.services.get * @memberOf! () * @@ -2826,13 +1941,7 @@ export namespace serviceusage_v1beta1 { /** * serviceusage.services.list - * @desc List all services available to the specified project, and the - * current state of those services with respect to the project. The list - * includes all public services, all services for which the calling user has - * the `servicemanagement.services.bind` permission, and all services that - * have already been enabled on the project. The list can be filtered to - * only include services in a specific state, for example to only include - * services enabled on the project. + * @desc List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project. * @alias serviceusage.services.list * @memberOf! () * @@ -2917,9 +2026,7 @@ export namespace serviceusage_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Parent to enable services on. An example name would be: `projects/123` - * where `123` is the project number (not project ID). The - * `BatchEnableServices` method currently only supports projects. + * Parent to enable services on. An example name would be: `projects/123` where `123` is the project number (not project ID). The `BatchEnableServices` method currently only supports projects. */ parent?: string; @@ -2935,10 +2042,7 @@ export namespace serviceusage_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the consumer and service to disable the service on. The enable - * and disable methods currently only support projects. An example name - * would be: `projects/123/services/serviceusage.googleapis.com` where `123` - * is the project number (not project ID). + * Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). */ name?: string; @@ -2954,12 +2058,7 @@ export namespace serviceusage_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the consumer and service to enable the service on. The - * `EnableService` and `DisableService` methods currently only support - * projects. Enabling a service requires that the service is public or is - * shared with the user enabling the service. An example name would be: - * `projects/123/services/serviceusage.googleapis.com` where `123` is the - * project number (not project ID). + * Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). */ name?: string; @@ -2975,10 +2074,7 @@ export namespace serviceusage_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the consumer and service to get the `ConsumerState` for. An - * example name would be: - * `projects/123/services/serviceusage.googleapis.com` where `123` is the - * project number (not project ID). + * Name of the consumer and service to get the `ConsumerState` for. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). */ name?: string; } @@ -2989,23 +2085,19 @@ export namespace serviceusage_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Only list services that conform to the given filter. The allowed filter - * strings are `state:ENABLED` and `state:DISABLED`. + * Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`. */ filter?: string; /** - * Requested size of the next page of data. Requested page size cannot - * exceed 200. If not set, the default page size is 50. + * Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50. */ pageSize?: number; /** - * Token identifying which result to start with, which is returned by a - * previous list call. + * Token identifying which result to start with, which is returned by a previous list call. */ pageToken?: string; /** - * Parent to search for services on. An example name would be: - * `projects/123` where `123` is the project number (not project ID). + * Parent to search for services on. An example name would be: `projects/123` where `123` is the project number (not project ID). */ parent?: string; } diff --git a/src/apis/sheets/package.json b/src/apis/sheets/package.json index 75902c263ba..200d917c2a1 100644 --- a/src/apis/sheets/package.json +++ b/src/apis/sheets/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 232b28f089b..418748fe163 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace sheets_v4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace sheets_v4 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace sheets_v4 { spreadsheets: Resource$Spreadsheets; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.spreadsheets = new Resource$Spreadsheets(this.context); } @@ -123,9 +122,7 @@ export namespace sheets_v4 { */ export interface Schema$AddBandingRequest { /** - * The banded range to add. The bandedRangeId field is optional; if one is - * not set, an id will be randomly generated. (It is an error to specify the - * ID of a range that already exists.) + * The banded range to add. The bandedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.) */ bandedRange?: Schema$BandedRange; } @@ -143,10 +140,7 @@ export namespace sheets_v4 { */ export interface Schema$AddChartRequest { /** - * The chart that should be added to the spreadsheet, including the position - * where it should be placed. The chartId field is optional; if one is not - * set, an id will be randomly generated. (It is an error to specify the ID - * of a chart that already exists.) + * The chart that should be added to the spreadsheet, including the position where it should be placed. The chartId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of an embedded object that already exists.) */ chart?: Schema$EmbeddedChart; } @@ -160,8 +154,7 @@ export namespace sheets_v4 { chart?: Schema$EmbeddedChart; } /** - * Adds a new conditional format rule at the given index. All subsequent - * rules' indexes are incremented. + * Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented. */ export interface Schema$AddConditionalFormatRuleRequest { /** @@ -174,20 +167,7 @@ export namespace sheets_v4 { rule?: Schema$ConditionalFormatRule; } /** - * Creates a group over the specified range. If the requested range is a - * superset of the range of an existing group G, then the depth of G is - * incremented and this new group G' has the depth of that group. For - * example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] - * and [C:D, depth 2]. If the requested range is a subset of the range of an - * existing group G, then the depth of the new group G' becomes one - * greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] - * results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range - * starts before and ends within, or starts within and ends after, the range - * of an existing group G, then the range of the existing group G becomes the - * union of the ranges, and the new group G' has depth one greater than - * the depth of G and range as the intersection of the ranges. For example, a - * group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, - * depth 2]. + * Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2]. */ export interface Schema$AddDimensionGroupRequest { /** @@ -209,9 +189,7 @@ export namespace sheets_v4 { */ export interface Schema$AddFilterViewRequest { /** - * The filter to add. The filterViewId field is optional; if one is not set, - * an id will be randomly generated. (It is an error to specify the ID of a - * filter that already exists.) + * The filter to add. The filterViewId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a filter that already exists.) */ filter?: Schema$FilterView; } @@ -229,9 +207,7 @@ export namespace sheets_v4 { */ export interface Schema$AddNamedRangeRequest { /** - * The named range to add. The namedRangeId field is optional; if one is not - * set, an id will be randomly generated. (It is an error to specify the ID - * of a range that already exists.) + * The named range to add. The namedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.) */ namedRange?: Schema$NamedRange; } @@ -249,9 +225,7 @@ export namespace sheets_v4 { */ export interface Schema$AddProtectedRangeRequest { /** - * The protected range to be added. The protectedRangeId field is optional; - * if one is not set, an id will be randomly generated. (It is an error to - * specify the ID of a range that already exists.) + * The protected range to be added. The protectedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.) */ protectedRange?: Schema$ProtectedRange; } @@ -265,17 +239,11 @@ export namespace sheets_v4 { protectedRange?: Schema$ProtectedRange; } /** - * Adds a new sheet. When a sheet is added at a given index, all subsequent - * sheets' indexes are incremented. To add an object sheet, use - * AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or - * EmbeddedObjectPosition.newSheet. + * Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet. */ export interface Schema$AddSheetRequest { /** - * The properties the new sheet should have. All properties are optional. - * The sheetId field is optional; if one is not set, an id will be randomly - * generated. (It is an error to specify the ID of a sheet that already - * exists.) + * The properties the new sheet should have. All properties are optional. The sheetId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a sheet that already exists.) */ properties?: Schema$SheetProperties; } @@ -289,15 +257,11 @@ export namespace sheets_v4 { properties?: Schema$SheetProperties; } /** - * Adds new cells after the last row with data in a sheet, inserting new rows - * into the sheet if necessary. + * Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary. */ export interface Schema$AppendCellsRequest { /** - * The fields of CellData that should be updated. At least one field must be - * specified. The root is the CellData; 'row.values.' should not be - * specified. A single `"*"` can be used as short-hand for listing - * every field. + * The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -335,8 +299,7 @@ export namespace sheets_v4 { */ spreadsheetId?: string; /** - * The range (in A1 notation) of the table that values are being appended to - * (before the values were appended). Empty if no table was found. + * The range (in A1 notation) of the table that values are being appended to (before the values were appended). Empty if no table was found. */ tableRange?: string; /** @@ -349,25 +312,20 @@ export namespace sheets_v4 { */ export interface Schema$AutoFillRequest { /** - * The range to autofill. This will examine the range and detect the - * location that has data and automatically fill that data in to the rest of - * the range. + * The range to autofill. This will examine the range and detect the location that has data and automatically fill that data in to the rest of the range. */ range?: Schema$GridRange; /** - * The source and destination areas to autofill. This explicitly lists the - * source of the autofill and where to extend that data. + * The source and destination areas to autofill. This explicitly lists the source of the autofill and where to extend that data. */ sourceAndDestination?: Schema$SourceAndDestination; /** - * True if we should generate data with the "alternate" series. - * This differs based on the type and amount of source data. + * True if we should generate data with the "alternate" series. This differs based on the type and amount of source data. */ useAlternateSeries?: boolean; } /** - * Automatically resizes one or more dimensions based on the contents of the - * cells in that dimension. + * Automatically resizes one or more dimensions based on the contents of the cells in that dimension. */ export interface Schema$AutoResizeDimensionsRequest { /** @@ -384,9 +342,7 @@ export namespace sheets_v4 { */ bandedRangeId?: number; /** - * Properties for column bands. These properties are applied on a column- - * by-column basis throughout all the columns in the range. At least one of - * row_properties or column_properties must be specified. + * Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified. */ columnProperties?: Schema$BandingProperties; /** @@ -394,23 +350,12 @@ export namespace sheets_v4 { */ range?: Schema$GridRange; /** - * Properties for row bands. These properties are applied on a row-by-row - * basis throughout all the rows in the range. At least one of - * row_properties or column_properties must be specified. + * Properties for row bands. These properties are applied on a row-by-row basis throughout all the rows in the range. At least one of row_properties or column_properties must be specified. */ rowProperties?: Schema$BandingProperties; } /** - * Properties referring a single dimension (either row or column). If both - * BandedRange.row_properties and BandedRange.column_properties are set, the - * fill colors are applied to cells according to the following rules: * - * header_color and footer_color take priority over band colors. * - * first_band_color takes priority over second_band_color. * row_properties - * takes priority over column_properties. For example, the first row color - * takes priority over the first column color, but the first column color - * takes priority over the second row color. Similarly, the row header takes - * priority over the column header in the top left cell, but the column header - * takes priority over the first row color if the row header is not set. + * Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set. */ export interface Schema$BandingProperties { /** @@ -418,18 +363,11 @@ export namespace sheets_v4 { */ firstBandColor?: Schema$Color; /** - * The color of the last row or column. If this field is not set, the last - * row or column will be filled with either first_band_color or - * second_band_color, depending on the color of the previous row or column. + * The color of the last row or column. If this field is not set, the last row or column will be filled with either first_band_color or second_band_color, depending on the color of the previous row or column. */ footerColor?: Schema$Color; /** - * The color of the first row or column. If this field is set, the first row - * or column will be filled with this color and the colors will alternate - * between first_band_color and second_band_color starting from the second - * row or column. Otherwise, the first row or column will be filled with - * first_band_color and the colors will proceed to alternate as they - * normally would. + * The color of the first row or column. If this field is set, the first row or column will be filled with this color and the colors will alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column will be filled with first_band_color and the colors will proceed to alternate as they normally would. */ headerColor?: Schema$Color; /** @@ -438,13 +376,11 @@ export namespace sheets_v4 { secondBandColor?: Schema$Color; } /** - * An axis of the chart. A chart may not have more than one axis per axis - * position. + * An axis of the chart. A chart may not have more than one axis per axis position. */ export interface Schema$BasicChartAxis { /** - * The format of the title. Only valid if the axis is not associated with - * the domain. + * The format of the title. Only valid if the axis is not associated with the domain. */ format?: Schema$TextFormat; /** @@ -452,8 +388,7 @@ export namespace sheets_v4 { */ position?: string; /** - * The title of this axis. If set, this overrides any title inferred from - * headers of the data. + * The title of this axis. If set, this overrides any title inferred from headers of the data. */ title?: string; /** @@ -462,13 +397,11 @@ export namespace sheets_v4 { titleTextPosition?: Schema$TextPosition; } /** - * The domain of a chart. For example, if charting stock prices over time, - * this would be the date. + * The domain of a chart. For example, if charting stock prices over time, this would be the date. */ export interface Schema$BasicChartDomain { /** - * The data of the domain. For example, if charting stock prices over time, - * this is the data representing the dates. + * The data of the domain. For example, if charting stock prices over time, this is the data representing the dates. */ domain?: Schema$ChartData; /** @@ -477,20 +410,15 @@ export namespace sheets_v4 { reversed?: boolean; } /** - * A single series of data in a chart. For example, if charting stock prices - * over time, multiple series may exist, one for the "Open Price", - * "High Price", "Low Price" and "Close Price". + * A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". */ export interface Schema$BasicChartSeries { /** - * The color for elements (i.e. bars, lines, points) associated with this - * series. If empty, a default color is used. + * The color for elements (i.e. bars, lines, points) associated with this series. If empty, a default color is used. */ color?: Schema$Color; /** - * The line style of this series. Valid only if the chartType is AREA, LINE, - * or SCATTER. COMBO charts are also supported if the series chart type is - * AREA or LINE. + * The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. */ lineStyle?: Schema$LineStyle; /** @@ -498,24 +426,16 @@ export namespace sheets_v4 { */ series?: Schema$ChartData; /** - * The minor axis that will specify the range of values for this series. For - * example, if charting stocks over time, the "Volume" series may - * want to be pinned to the right with the prices pinned to the left, - * because the scale of trading volume is different than the scale of - * prices. It is an error to specify an axis that isn't a valid minor - * axis for the chart's type. + * The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. */ targetAxis?: string; /** - * The type of this series. Valid only if the chartType is COMBO. Different - * types will change the way the series is visualized. Only LINE, AREA, and - * COLUMN are supported. + * The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. */ type?: string; } /** - * The specification for a basic chart. See BasicChartType for the list of - * charts this supports. + * The specification for a basic chart. See BasicChartType for the list of charts this supports. */ export interface Schema$BasicChartSpec { /** @@ -527,8 +447,7 @@ export namespace sheets_v4 { */ chartType?: string; /** - * The behavior of tooltips and data highlighting when hovering on data and - * chart area. + * The behavior of tooltips and data highlighting when hovering on data and chart area. */ compareMode?: string; /** @@ -536,16 +455,11 @@ export namespace sheets_v4 { */ domains?: Schema$BasicChartDomain[]; /** - * The number of rows or columns in the data that are "headers". - * If not set, Google Sheets will guess how many rows are headers based on - * the data. (Note that BasicChartAxis.title may override the axis title - * inferred from the header values.) + * The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) */ headerCount?: number; /** - * If some values in a series are missing, gaps may appear in the chart - * (e.g, segments of lines in a line chart will be missing). To eliminate - * these gaps set this to true. Applies to Line, Area, and Combo charts. + * If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. */ interpolateNulls?: boolean; /** @@ -553,8 +467,7 @@ export namespace sheets_v4 { */ legendPosition?: string; /** - * Gets whether all lines should be rendered smooth or straight by default. - * Applies to Line charts. + * Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. */ lineSmoothing?: boolean; /** @@ -562,8 +475,7 @@ export namespace sheets_v4 { */ series?: Schema$BasicChartSeries[]; /** - * The stacked type for charts that support vertical stacking. Applies to - * Area, Bar, Column, Combo, and Stepped Area charts. + * The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. */ stackedType?: string; /** @@ -576,8 +488,7 @@ export namespace sheets_v4 { */ export interface Schema$BasicFilter { /** - * The criteria for showing/hiding values per column. The map's key is - * the column index, and the value is the criteria for that column. + * The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. */ criteria?: {[key: string]: Schema$FilterCriteria}; /** @@ -585,14 +496,12 @@ export namespace sheets_v4 { */ range?: Schema$GridRange; /** - * The sort order per column. Later specifications are used when values are - * equal in the earlier specifications. + * The sort order per column. Later specifications are used when values are equal in the earlier specifications. */ sortSpecs?: Schema$SortSpec[]; } /** - * The request for clearing more than one range selected by a DataFilter in a - * spreadsheet. + * The request for clearing more than one range selected by a DataFilter in a spreadsheet. */ export interface Schema$BatchClearValuesByDataFilterRequest { /** @@ -601,15 +510,11 @@ export namespace sheets_v4 { dataFilters?: Schema$DataFilter[]; } /** - * The response when clearing a range of values selected with DataFilters in a - * spreadsheet. + * The response when clearing a range of values selected with DataFilters in a spreadsheet. */ export interface Schema$BatchClearValuesByDataFilterResponse { /** - * The ranges that were cleared, in A1 notation. (If the requests were for - * an unbounded range or a ranger larger than the bounds of the sheet, this - * will be the actual ranges that were cleared, bounded to the sheet's - * limits.) + * The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.) */ clearedRanges?: string[]; /** @@ -631,10 +536,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchClearValuesResponse { /** - * The ranges that were cleared, in A1 notation. (If the requests were for - * an unbounded range or a ranger larger than the bounds of the sheet, this - * will be the actual ranges that were cleared, bounded to the sheet's - * limits.) + * The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.) */ clearedRanges?: string[]; /** @@ -643,39 +545,28 @@ export namespace sheets_v4 { spreadsheetId?: string; } /** - * The request for retrieving a range of values in a spreadsheet selected by a - * set of DataFilters. + * The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters. */ export interface Schema$BatchGetValuesByDataFilterRequest { /** - * The data filters used to match the ranges of values to retrieve. Ranges - * that match any of the specified data filters will be included in the - * response. + * The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters will be included in the response. */ dataFilters?: Schema$DataFilter[]; /** - * How dates, times, and durations should be represented in the output. This - * is ignored if value_render_option is FORMATTED_VALUE. The default - * dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + * How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. */ dateTimeRenderOption?: string; /** - * The major dimension that results should use. For example, if the - * spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects - * that range and sets `majorDimension=ROWS` will return `[[1,2],[3,4]]`, - * whereas a request that sets `majorDimension=COLUMNS` will return - * `[[1,3],[2,4]]`. + * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. */ majorDimension?: string; /** - * How values should be represented in the output. The default render option - * is ValueRenderOption.FORMATTED_VALUE. + * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */ valueRenderOption?: string; } /** - * The response when retrieving more than one range of values in a spreadsheet - * selected by DataFilters. + * The response when retrieving more than one range of values in a spreadsheet selected by DataFilters. */ export interface Schema$BatchGetValuesByDataFilterResponse { /** @@ -688,8 +579,7 @@ export namespace sheets_v4 { valueRanges?: Schema$MatchedValueRange[]; } /** - * The response when retrieving more than one range of values in a - * spreadsheet. + * The response when retrieving more than one range of values in a spreadsheet. */ export interface Schema$BatchGetValuesResponse { /** @@ -697,8 +587,7 @@ export namespace sheets_v4 { */ spreadsheetId?: string; /** - * The requested values. The order of the ValueRanges is the same as the - * order of the requested ranges. + * The requested values. The order of the ValueRanges is the same as the order of the requested ranges. */ valueRanges?: Schema$ValueRange[]; } @@ -707,25 +596,19 @@ export namespace sheets_v4 { */ export interface Schema$BatchUpdateSpreadsheetRequest { /** - * Determines if the update response should include the spreadsheet - * resource. + * Determines if the update response should include the spreadsheet resource. */ includeSpreadsheetInResponse?: boolean; /** - * A list of updates to apply to the spreadsheet. Requests will be applied - * in the order they are specified. If any request is not valid, no requests - * will be applied. + * A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied. */ requests?: Schema$Request[]; /** - * True if grid data should be returned. Meaningful only if if - * include_spreadsheet_in_response is 'true'. This parameter is - * ignored if a field mask was set in the request. + * True if grid data should be returned. Meaningful only if if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request. */ responseIncludeGridData?: boolean; /** - * Limits the ranges included in the response spreadsheet. Meaningful only - * if include_spreadsheet_response is 'true'. + * Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_response is 'true'. */ responseRanges?: string[]; } @@ -734,8 +617,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchUpdateSpreadsheetResponse { /** - * The reply of the updates. This maps 1:1 with the updates, although - * replies to some requests may be empty. + * The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */ replies?: Schema$Response[]; /** @@ -743,9 +625,7 @@ export namespace sheets_v4 { */ spreadsheetId?: string; /** - * The spreadsheet after updates were applied. This is only set if - * [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is - * `true`. + * The spreadsheet after updates were applied. This is only set if [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`. */ updatedSpreadsheet?: Schema$Spreadsheet; } @@ -754,31 +634,19 @@ export namespace sheets_v4 { */ export interface Schema$BatchUpdateValuesByDataFilterRequest { /** - * The new values to apply to the spreadsheet. If more than one range is - * matched by the specified DataFilter the specified values will be applied - * to all of those ranges. + * The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values will be applied to all of those ranges. */ data?: Schema$DataFilterValueRange[]; /** - * Determines if the update response should include the values of the cells - * that were updated. By default, responses do not include the updated - * values. The `updatedData` field within each of the - * BatchUpdateValuesResponse.responses will contain the updated values. If - * the range to write was larger than than the range actually written, the - * response will include all values in the requested range (excluding - * trailing empty rows and columns). + * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). */ includeValuesInResponse?: boolean; /** - * Determines how dates, times, and durations in the response should be - * rendered. This is ignored if response_value_render_option is - * FORMATTED_VALUE. The default dateTime render option is - * DateTimeRenderOption.SERIAL_NUMBER. + * Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. */ responseDateTimeRenderOption?: string; /** - * Determines how values in the response should be rendered. The default - * render option is ValueRenderOption.FORMATTED_VALUE. + * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. */ responseValueRenderOption?: string; /** @@ -803,8 +671,7 @@ export namespace sheets_v4 { */ totalUpdatedCells?: number; /** - * The total number of columns where at least one cell in the column was - * updated. + * The total number of columns where at least one cell in the column was updated. */ totalUpdatedColumns?: number; /** @@ -812,8 +679,7 @@ export namespace sheets_v4 { */ totalUpdatedRows?: number; /** - * The total number of sheets where at least one cell in the sheet was - * updated. + * The total number of sheets where at least one cell in the sheet was updated. */ totalUpdatedSheets?: number; } @@ -826,25 +692,15 @@ export namespace sheets_v4 { */ data?: Schema$ValueRange[]; /** - * Determines if the update response should include the values of the cells - * that were updated. By default, responses do not include the updated - * values. The `updatedData` field within each of the - * BatchUpdateValuesResponse.responses will contain the updated values. If - * the range to write was larger than than the range actually written, the - * response will include all values in the requested range (excluding - * trailing empty rows and columns). + * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). */ includeValuesInResponse?: boolean; /** - * Determines how dates, times, and durations in the response should be - * rendered. This is ignored if response_value_render_option is - * FORMATTED_VALUE. The default dateTime render option is - * DateTimeRenderOption.SERIAL_NUMBER. + * Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. */ responseDateTimeRenderOption?: string; /** - * Determines how values in the response should be rendered. The default - * render option is ValueRenderOption.FORMATTED_VALUE. + * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. */ responseValueRenderOption?: string; /** @@ -857,8 +713,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchUpdateValuesResponse { /** - * One UpdateValuesResponse per requested range, in the same order as the - * requests appeared. + * One UpdateValuesResponse per requested range, in the same order as the requests appeared. */ responses?: Schema$UpdateValuesResponse[]; /** @@ -870,8 +725,7 @@ export namespace sheets_v4 { */ totalUpdatedCells?: number; /** - * The total number of columns where at least one cell in the column was - * updated. + * The total number of columns where at least one cell in the column was updated. */ totalUpdatedColumns?: number; /** @@ -879,14 +733,12 @@ export namespace sheets_v4 { */ totalUpdatedRows?: number; /** - * The total number of sheets where at least one cell in the sheet was - * updated. + * The total number of sheets where at least one cell in the sheet was updated. */ totalUpdatedSheets?: number; } /** - * A condition that can evaluate to true or false. BooleanConditions are used - * by conditional formatting, data validation, and the criteria in filters. + * A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters. */ export interface Schema$BooleanCondition { /** @@ -894,9 +746,7 @@ export namespace sheets_v4 { */ type?: string; /** - * The values of the condition. The number of supported values depends on - * the condition type. Some support zero values, others one or two values, - * and ConditionType.ONE_OF_LIST supports an arbitrary number of values. + * The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values. */ values?: Schema$ConditionValue[]; } @@ -905,14 +755,11 @@ export namespace sheets_v4 { */ export interface Schema$BooleanRule { /** - * The condition of the rule. If the condition evaluates to true, the format - * is applied. + * The condition of the rule. If the condition evaluates to true, the format is applied. */ condition?: Schema$BooleanCondition; /** - * The format to apply. Conditional formatting can only apply a subset of - * formatting: bold, italic, strikethrough, foreground color & - * background color. + * The format to apply. Conditional formatting can only apply a subset of formatting: bold, italic, strikethrough, foreground color & background color. */ format?: Schema$CellFormat; } @@ -929,8 +776,7 @@ export namespace sheets_v4 { */ style?: string; /** - * The width of the border, in pixels. Deprecated; the width is determined - * by the "style" field. + * The width of the border, in pixels. Deprecated; the width is determined by the "style" field. */ width?: number; } @@ -956,9 +802,7 @@ export namespace sheets_v4 { top?: Schema$Border; } /** - * A <a - * href="/chart/interactive/docs/gallery/bubblechart">bubble - * chart</a>. + * A <a href="/chart/interactive/docs/gallery/bubblechart">bubble chart</a>. */ export interface Schema$BubbleChartSpec { /** @@ -970,41 +814,31 @@ export namespace sheets_v4 { */ bubbleLabels?: Schema$ChartData; /** - * The max radius size of the bubbles, in pixels. If specified, the field - * must be a positive value. + * The max radius size of the bubbles, in pixels. If specified, the field must be a positive value. */ bubbleMaxRadiusSize?: number; /** - * The minimum radius size of the bubbles, in pixels. If specific, the field - * must be a positive value. + * The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value. */ bubbleMinRadiusSize?: number; /** - * The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and - * 1 is fully opaque. + * The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque. */ bubbleOpacity?: number; /** - * The data contianing the bubble sizes. Bubble sizes are used to draw the - * bubbles at different sizes relative to each other. If specified, - * group_ids must also be specified. This field is optional. + * The data contianing the bubble sizes. Bubble sizes are used to draw the bubbles at different sizes relative to each other. If specified, group_ids must also be specified. This field is optional. */ bubbleSizes?: Schema$ChartData; /** - * The format of the text inside the bubbles. Underline and Strikethrough - * are not supported. + * The format of the text inside the bubbles. Underline and Strikethrough are not supported. */ bubbleTextStyle?: Schema$TextFormat; /** - * The data containing the bubble x-values. These values locate the bubbles - * in the chart horizontally. + * The data containing the bubble x-values. These values locate the bubbles in the chart horizontally. */ domain?: Schema$ChartData; /** - * The data containing the bubble group IDs. All bubbles with the same group - * ID are drawn in the same color. If bubble_sizes is specified then this - * field must also be specified but may contain blank values. This field is - * optional. + * The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the same color. If bubble_sizes is specified then this field must also be specified but may contain blank values. This field is optional. */ groupIds?: Schema$ChartData; /** @@ -1012,15 +846,12 @@ export namespace sheets_v4 { */ legendPosition?: string; /** - * The data contianing the bubble y-values. These values locate the bubbles - * in the chart vertically. + * The data contianing the bubble y-values. These values locate the bubbles in the chart vertically. */ series?: Schema$ChartData; } /** - * A <a - * href="/chart/interactive/docs/gallery/candlestickchart">candlestick - * chart</a>. + * A <a href="/chart/interactive/docs/gallery/candlestickchart">candlestick chart</a>. */ export interface Schema$CandlestickChartSpec { /** @@ -1028,37 +859,28 @@ export namespace sheets_v4 { */ data?: Schema$CandlestickData[]; /** - * The domain data (horizontal axis) for the candlestick chart. String data - * will be treated as discrete labels, other data will be treated as - * continuous values. + * The domain data (horizontal axis) for the candlestick chart. String data will be treated as discrete labels, other data will be treated as continuous values. */ domain?: Schema$CandlestickDomain; } /** - * The Candlestick chart data, each containing the low, open, close, and high - * values for a series. + * The Candlestick chart data, each containing the low, open, close, and high values for a series. */ export interface Schema$CandlestickData { /** - * The range data (vertical axis) for the close/final value for each candle. - * This is the top of the candle body. If greater than the open value the - * candle will be filled. Otherwise the candle will be hollow. + * The range data (vertical axis) for the close/final value for each candle. This is the top of the candle body. If greater than the open value the candle will be filled. Otherwise the candle will be hollow. */ closeSeries?: Schema$CandlestickSeries; /** - * The range data (vertical axis) for the high/maximum value for each - * candle. This is the top of the candle's center line. + * The range data (vertical axis) for the high/maximum value for each candle. This is the top of the candle's center line. */ highSeries?: Schema$CandlestickSeries; /** - * The range data (vertical axis) for the low/minimum value for each candle. - * This is the bottom of the candle's center line. + * The range data (vertical axis) for the low/minimum value for each candle. This is the bottom of the candle's center line. */ lowSeries?: Schema$CandlestickSeries; /** - * The range data (vertical axis) for the open/initial value for each - * candle. This is the bottom of the candle body. If less than the close - * value the candle will be filled. Otherwise the candle will be hollow. + * The range data (vertical axis) for the open/initial value for each candle. This is the bottom of the candle body. If less than the close value the candle will be filled. Otherwise the candle will be hollow. */ openSeries?: Schema$CandlestickSeries; } @@ -1089,32 +911,23 @@ export namespace sheets_v4 { */ export interface Schema$CellData { /** - * A data validation rule on the cell, if any. When writing, the new data - * validation rule will overwrite any prior rule. + * A data validation rule on the cell, if any. When writing, the new data validation rule will overwrite any prior rule. */ dataValidation?: Schema$DataValidationRule; /** - * The effective format being used by the cell. This includes the results of - * applying any conditional formatting and, if the cell contains a formula, - * the computed number format. If the effective format is the default - * format, effective format will not be written. This field is read-only. + * The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written. This field is read-only. */ effectiveFormat?: Schema$CellFormat; /** - * The effective value of the cell. For cells with formulas, this is the - * calculated value. For cells with literals, this is the same as the - * user_entered_value. This field is read-only. + * The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the user_entered_value. This field is read-only. */ effectiveValue?: Schema$ExtendedValue; /** - * The formatted value of the cell. This is the value as it's shown to - * the user. This field is read-only. + * The formatted value of the cell. This is the value as it's shown to the user. This field is read-only. */ formattedValue?: string; /** - * A hyperlink this cell points to, if any. This field is read-only. (To - * set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue - * field.) + * A hyperlink this cell points to, if any. This field is read-only. (To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field.) */ hyperlink?: string; /** @@ -1122,33 +935,19 @@ export namespace sheets_v4 { */ note?: string; /** - * A pivot table anchored at this cell. The size of pivot table itself is - * computed dynamically based on its data, grouping, filters, values, etc. - * Only the top-left cell of the pivot table contains the pivot table - * definition. The other cells will contain the calculated values of the - * results of the pivot in their effective_value fields. + * A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effective_value fields. */ pivotTable?: Schema$PivotTable; /** - * Runs of rich text applied to subsections of the cell. Runs are only - * valid on user entered strings, not formulas, bools, or numbers. Runs - * start at specific indexes in the text and continue until the next run. - * Properties of a run will continue unless explicitly changed in a - * subsequent run (and properties of the first run will continue the - * properties of the cell unless explicitly changed). When writing, the new - * runs will overwrite any prior runs. When writing a new - * user_entered_value, previous runs are erased. + * Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Runs start at specific indexes in the text and continue until the next run. Properties of a run will continue unless explicitly changed in a subsequent run (and properties of the first run will continue the properties of the cell unless explicitly changed). When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased. */ textFormatRuns?: Schema$TextFormatRun[]; /** - * The format the user entered for the cell. When writing, the new format - * will be merged with the existing format. + * The format the user entered for the cell. When writing, the new format will be merged with the existing format. */ userEnteredFormat?: Schema$CellFormat; /** - * The value the user entered in the cell. e.g, `1234`, `'Hello'`, - * or `=NOW()` Note: Dates, Times and DateTimes are represented as doubles - * in serial number format. + * The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()` Note: Dates, Times and DateTimes are represented as doubles in serial number format. */ userEnteredValue?: Schema$ExtendedValue; } @@ -1215,15 +1014,7 @@ export namespace sheets_v4 { */ export interface Schema$ChartSourceRange { /** - * The ranges of data for a series or domain. Exactly one dimension must - * have a length of 1, and all sources in the list must have the same - * dimension with length 1. The domain (if it exists) & all series must - * have the same number of source ranges. If using more than one source - * range, then the source range at a given offset must be in order and - * contiguous across the domain and series. For example, these are valid - * configurations: domain sources: A1:A5 series1 sources: B1:B5 - * series2 sources: D6:D10 domain sources: A1:A5, C10:C12 series1 - * sources: B1:B5, D10:D12 series2 sources: C1:C5, E10:E12 + * The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more than one source range, then the source range at a given offset must be in order and contiguous across the domain and series. For example, these are valid configurations: domain sources: A1:A5 series1 sources: B1:B5 series2 sources: D6:D10 domain sources: A1:A5, C10:C12 series1 sources: B1:B5, D10:D12 series2 sources: C1:C5, E10:E12 */ sources?: Schema$GridRange[]; } @@ -1232,8 +1023,7 @@ export namespace sheets_v4 { */ export interface Schema$ChartSpec { /** - * The alternative text that describes the chart. This is often used for - * accessibility. + * The alternative text that describes the chart. This is often used for accessibility. */ altText?: string; /** @@ -1241,8 +1031,7 @@ export namespace sheets_v4 { */ backgroundColor?: Schema$Color; /** - * A basic chart specification, can be one of many kinds of charts. See - * BasicChartType for the list of all charts this supports. + * A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports. */ basicChart?: Schema$BasicChartSpec; /** @@ -1254,9 +1043,7 @@ export namespace sheets_v4 { */ candlestickChart?: Schema$CandlestickChartSpec; /** - * The name of the font to use by default for all chart text (e.g. title, - * axis labels, legend). If a font is specified for a specific part of the - * chart it will override this font name. + * The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name. */ fontName?: string; /** @@ -1268,9 +1055,7 @@ export namespace sheets_v4 { */ histogramChart?: Schema$HistogramChartSpec; /** - * True to make a chart fill the entire space in which it's rendered - * with minimum padding. False to use the default padding. (Not applicable - * to Geo and Org charts.) + * True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.) */ maximized?: boolean; /** @@ -1332,10 +1117,7 @@ export namespace sheets_v4 { */ export interface Schema$ClearValuesResponse { /** - * The range (in A1 notation) that was cleared. (If the request was for an - * unbounded range or a ranger larger than the bounds of the sheet, this - * will be the actual range that was cleared, bounded to the sheet's - * limits.) + * The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet's limits.) */ clearedRange?: string; /** @@ -1344,72 +1126,11 @@ export namespace sheets_v4 { spreadsheetId?: string; } /** - * Represents a color in the RGBA color space. This representation is designed - * for simplicity of conversion to/from color representations in various - * languages over compactness; for example, the fields of this representation - * can be trivially provided to the constructor of "java.awt.Color" - * in Java; it can also be trivially provided to UIColor's - * "+colorWithRed:green:blue:alpha" method in iOS; and, with just a - * little work, it can be easily formatted into a CSS "rgba()" - * string in JavaScript, as well. Note: this proto does not carry information - * about the absolute color space that should be used to interpret the RGB - * value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, - * applications SHOULD assume the sRGB color space. Example (Java): import - * com.google.type.Color; // ... public static java.awt.Color - * fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? - * protocolor.getAlpha().getValue() : 1.0; return new - * java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - * protocolor.getBlue(), alpha); } public static Color - * toProto(java.awt.Color color) { float red = (float) color.getRed(); - * float green = (float) color.getGreen(); float blue = (float) - * color.getBlue(); float denominator = 255.0; Color.Builder - * resultBuilder = Color .newBuilder() .setRed(red / - * denominator) .setGreen(green / denominator) .setBlue(blue / - * denominator); int alpha = color.getAlpha(); if (alpha != 255) - * { result.setAlpha( FloatValue .newBuilder() - * .setValue(((float) alpha) / denominator) .build()); } - * return resultBuilder.build(); } // ... Example (iOS / Obj-C): // - * ... static UIColor* fromProto(Color* protocolor) { float red = - * [protocolor red]; float green = [protocolor green]; float - * blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor - * alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { - * alpha = [alpha_wrapper value]; } return [UIColor - * colorWithRed:red green:green blue:blue alpha:alpha]; } static - * Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; - * if (![color getRed:&red green:&green blue:&blue - * alpha:&alpha]) { return nil; } Color* - * result = [[Color alloc] init]; [result setRed:red]; [result - * setGreen:green]; [result setBlue:blue]; if (alpha <= - * 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } - * [result autorelease]; return result; } // ... Example - * (JavaScript): // ... var protoToCssColor = function(rgb_color) { - * var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green - * || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = - * Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); - * var blue = Math.floor(blueFrac * 255); if (!('alpha' in - * rgb_color)) { return rgbToCssColor_(red, green, blue); } - * var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - * green, blue].join(','); return ['rgba(', rgbParams, - * ',', alphaFrac, ')'].join(''); }; var - * rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new - * Number((red << 16) | (green << 8) | blue); var hexString - * = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; - * var resultBuilder = ['#']; for (var i = 0; i < - * missingZeros; i++) { resultBuilder.push('0'); } - * resultBuilder.push(hexString); return resultBuilder.join(''); - * }; // ... + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... */ export interface Schema$Color { /** - * The fraction of this color that should be applied to the pixel. That is, - * the final pixel color is defined by the equation: pixel color = alpha - * * (this color) + (1.0 - alpha) * (background color) This means that a - * value of 1.0 corresponds to a solid color, whereas a value of 0.0 - * corresponds to a completely transparent color. This uses a wrapper - * message rather than a simple float scalar so that it is possible to - * distinguish between a default value and the value being unset. If - * omitted, this color object is to be rendered as a solid color (as if the - * alpha value had been explicitly given with a value of 1.0). + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ alpha?: number; /** @@ -1430,8 +1151,7 @@ export namespace sheets_v4 { */ export interface Schema$ConditionalFormatRule { /** - * The formatting is either "on" or "off" according to - * the rule. + * The formatting is either "on" or "off" according to the rule. */ booleanRule?: Schema$BooleanRule; /** @@ -1439,8 +1159,7 @@ export namespace sheets_v4 { */ gradientRule?: Schema$GradientRule; /** - * The ranges that are formatted if the condition is true. All the ranges - * must be on the same grid. + * The ranges that are formatted if the condition is true. All the ranges must be on the same grid. */ ranges?: Schema$GridRange[]; } @@ -1449,16 +1168,11 @@ export namespace sheets_v4 { */ export interface Schema$ConditionValue { /** - * A relative date (based on the current date). Valid only if the type is - * DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative - * dates are not supported in data validation. They are supported only in - * conditional formatting and conditional filters. + * A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters. */ relativeDate?: string; /** - * A value the condition is based on. The value is parsed as if the user - * typed into a cell. Formulas are supported (and must begin with an `=` or - * a '+'). + * A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+'). */ userEnteredValue?: string; } @@ -1467,11 +1181,7 @@ export namespace sheets_v4 { */ export interface Schema$CopyPasteRequest { /** - * The location to paste to. If the range covers a span that's a - * multiple of the source's height or width, then the data will be - * repeated to fill in the destination range. If the range is smaller than - * the source range, the entire source data will still be copied (beyond the - * end of the destination range). + * The location to paste to. If the range covers a span that's a multiple of the source's height or width, then the data will be repeated to fill in the destination range. If the range is smaller than the source range, the entire source data will still be copied (beyond the end of the destination range). */ destination?: Schema$GridRange; /** @@ -1523,8 +1233,7 @@ export namespace sheets_v4 { */ destination?: Schema$GridCoordinate; /** - * What kind of data to paste. All the source data will be cut, regardless - * of what is pasted. + * What kind of data to paste. All the source data will be cut, regardless of what is pasted. */ pasteType?: string; /** @@ -1533,8 +1242,7 @@ export namespace sheets_v4 { source?: Schema$GridRange; } /** - * Filter that describes what data should be selected or returned from a - * request. + * Filter that describes what data should be selected or returned from a request. */ export interface Schema$DataFilter { /** @@ -1542,8 +1250,7 @@ export namespace sheets_v4 { */ a1Range?: string; /** - * Selects data associated with the developer metadata matching the criteria - * described by this DeveloperMetadataLookup. + * Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */ developerMetadataLookup?: Schema$DeveloperMetadataLookup; /** @@ -1564,10 +1271,7 @@ export namespace sheets_v4 { */ majorDimension?: string; /** - * The data to be written. If the provided values exceed any of the ranges - * matched by the data filter then the request will fail. If the provided - * values are less than the matched ranges only the specified values will be - * written, existing values in the matched ranges will remain unaffected. + * The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request will fail. If the provided values are less than the matched ranges only the specified values will be written, existing values in the matched ranges will remain unaffected. */ values?: any[][]; } @@ -1584,8 +1288,7 @@ export namespace sheets_v4 { */ inputMessage?: string; /** - * True if the UI should be customized based on the kind of condition. If - * true, "List" conditions will show a dropdown. + * True if the UI should be customized based on the kind of condition. If true, "List" conditions will show a dropdown. */ showCustomUi?: boolean; /** @@ -1594,18 +1297,7 @@ export namespace sheets_v4 { strict?: boolean; } /** - * Allows you to organize the date-time values in a source data column into - * buckets based on selected parts of their date or time values. For example, - * consider a pivot table showing sales transactions by date: - * +----------+--------------+ | Date | SUM of Sales | - * +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 - * | $708.84 | | 5/8/2017 | $326.84 | ... - * +----------+--------------+ Applying a date-time group rule with a - * DateTimeRuleType of YEAR_MONTH results in the following pivot table. - * +--------------+--------------+ | Grouped Date | SUM of Sales | - * +--------------+--------------+ | 2017-Jan | $53,731.78 | | - * 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... - * +--------------+--------------+ + * Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+--------------+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +--------------+--------------+ | Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +--------------+--------------+ */ export interface Schema$DateTimeRule { /** @@ -1623,8 +1315,7 @@ export namespace sheets_v4 { bandedRangeId?: number; } /** - * Deletes a conditional format rule at the given index. All subsequent - * rules' indexes are decremented. + * Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented. */ export interface Schema$DeleteConditionalFormatRuleRequest { /** @@ -1650,8 +1341,7 @@ export namespace sheets_v4 { */ export interface Schema$DeleteDeveloperMetadataRequest { /** - * The data filter describing the criteria used to select which developer - * metadata entry to delete. + * The data filter describing the criteria used to select which developer metadata entry to delete. */ dataFilter?: Schema$DataFilter; } @@ -1665,10 +1355,7 @@ export namespace sheets_v4 { deletedDeveloperMetadata?: Schema$DeveloperMetadata[]; } /** - * Deletes a group over the specified range by decrementing the depth of the - * dimensions in the range. For example, assume the sheet has a depth-1 group - * over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the - * sheet with a depth-1 group over B:D and a depth-2 group over C:C. + * Deletes a group over the specified range by decrementing the depth of the dimensions in the range. For example, assume the sheet has a depth-1 group over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the sheet with a depth-1 group over B:D and a depth-2 group over C:C. */ export interface Schema$DeleteDimensionGroupRequest { /** @@ -1739,10 +1426,7 @@ export namespace sheets_v4 { */ range?: Schema$GridRange; /** - * The dimension from which deleted cells will be replaced with. If ROWS, - * existing cells will be shifted upward to replace the deleted cells. If - * COLUMNS, existing cells will be shifted left to replace the deleted - * cells. + * The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells. */ shiftDimension?: string; } @@ -1756,14 +1440,7 @@ export namespace sheets_v4 { sheetId?: number; } /** - * Developer metadata associated with a location or object in a spreadsheet. - * Developer metadata may be used to associate arbitrary data with various - * parts of a spreadsheet and will remain associated at those locations as - * they move around and the spreadsheet is edited. For example, if developer - * metadata is associated with row 5 and another row is then subsequently - * inserted above row 5, that original metadata will still be associated with - * the row it was first associated with (what is now row 6). If the associated - * object is deleted its metadata is deleted too. + * Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too. */ export interface Schema$DeveloperMetadata { /** @@ -1771,14 +1448,11 @@ export namespace sheets_v4 { */ location?: Schema$DeveloperMetadataLocation; /** - * The spreadsheet-scoped unique ID that identifies the metadata. IDs may be - * specified when metadata is created, otherwise one will be randomly - * generated and assigned. Must be positive. + * The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive. */ metadataId?: number; /** - * The metadata key. There may be multiple metadata in a spreadsheet with - * the same key. Developer metadata must always have a key specified. + * The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified. */ metadataKey?: string; /** @@ -1786,8 +1460,7 @@ export namespace sheets_v4 { */ metadataValue?: string; /** - * The metadata visibility. Developer metadata must always have a - * visibility specified. + * The metadata visibility. Developer metadata must always have a visibility specified. */ visibility?: string; } @@ -1796,9 +1469,7 @@ export namespace sheets_v4 { */ export interface Schema$DeveloperMetadataLocation { /** - * Represents the row or column when metadata is associated with a - * dimension. The specified DimensionRange must represent a single row or - * column; it cannot be unbounded or span multiple rows or columns. + * Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */ dimensionRange?: Schema$DimensionRange; /** @@ -1815,87 +1486,48 @@ export namespace sheets_v4 { spreadsheet?: boolean; } /** - * Selects DeveloperMetadata that matches all of the specified fields. For - * example, if only a metadata ID is specified this considers the - * DeveloperMetadata with that particular unique ID. If a metadata key is - * specified, this considers all developer metadata with that key. If a key, - * visibility, and location type are all specified, this considers all - * developer metadata with that key and visibility that are associated with a - * location of that type. In general, this selects all DeveloperMetadata that - * matches the intersection of all the specified fields; any field or - * combination of fields may be specified. + * Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified. */ export interface Schema$DeveloperMetadataLookup { /** - * Determines how this lookup matches the location. If this field is - * specified as EXACT, only developer metadata associated on the exact - * location specified is matched. If this field is specified to - * INTERSECTING, developer metadata associated on intersecting locations is - * also matched. If left unspecified, this field assumes a default value of - * INTERSECTING. If this field is specified, a metadataLocation must also be - * specified. + * Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */ locationMatchingStrategy?: string; /** - * Limits the selected developer metadata to those entries which are - * associated with locations of the specified type. For example, when this - * field is specified as ROW this lookup only considers developer metadata - * associated on rows. If the field is left unspecified, all location types - * are considered. This field cannot be specified as SPREADSHEET when the - * locationMatchingStrategy is specified as INTERSECTING or when the - * metadataLocation is specified as a non-spreadsheet location: spreadsheet - * metadata cannot intersect any other developer metadata location. This - * field also must be left unspecified when the locationMatchingStrategy is - * specified as EXACT. + * Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */ locationType?: string; /** - * Limits the selected developer metadata to that which has a matching - * DeveloperMetadata.metadata_id. + * Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */ metadataId?: number; /** - * Limits the selected developer metadata to that which has a matching - * DeveloperMetadata.metadata_key. + * Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */ metadataKey?: string; /** - * Limits the selected developer metadata to those entries associated with - * the specified location. This field either matches exact locations or all - * intersecting locations according the specified locationMatchingStrategy. + * Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */ metadataLocation?: Schema$DeveloperMetadataLocation; /** - * Limits the selected developer metadata to that which has a matching - * DeveloperMetadata.metadata_value. + * Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */ metadataValue?: string; /** - * Limits the selected developer metadata to that which has a matching - * DeveloperMetadata.visibility. If left unspecified, all developer - * metadata visibile to the requesting project is considered. + * Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */ visibility?: string; } /** - * A group over an interval of rows or columns on a sheet, which can contain - * or be contained within other groups. A group can be collapsed or expanded - * as a unit on the sheet. + * A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet. */ export interface Schema$DimensionGroup { /** - * This field is true if this group is collapsed. A collapsed group remains - * collapsed if an overlapping group at a shallower depth is expanded. A - * true value does not imply that all dimensions within the group are - * hidden, since a dimension's visibility can change independently from - * this group property. However, when this property is updated, all - * dimensions within it are set to hidden if this field is true, or set to - * visible if this field is false. + * This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false. */ collapsed?: boolean; /** - * The depth of the group, representing how many groups have a range that - * wholly contains the range of this group. + * The depth of the group, representing how many groups have a range that wholly contains the range of this group. */ depth?: number; /** @@ -1925,9 +1557,7 @@ export namespace sheets_v4 { pixelSize?: number; } /** - * A range along a single dimension on a sheet. All indexes are zero-based. - * Indexes are half open: the start index is inclusive and the end index is - * exclusive. Missing indexes indicate the range is unbounded on that side. + * A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side. */ export interface Schema$DimensionRange { /** @@ -1970,14 +1600,11 @@ export namespace sheets_v4 { */ export interface Schema$DuplicateSheetRequest { /** - * The zero-based index where the new sheet should be inserted. The index of - * all sheets after this are incremented. + * The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented. */ insertSheetIndex?: number; /** - * If set, the ID of the new sheet. If not set, an ID is chosen. If set, the - * ID must not conflict with any existing sheet ID. If set, it must be - * non-negative. + * If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative. */ newSheetId?: number; /** @@ -2003,9 +1630,7 @@ export namespace sheets_v4 { */ export interface Schema$Editors { /** - * True if anyone in the document's domain has edit access to the - * protected range. Domain protection is only supported on documents within - * a domain. + * True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain. */ domainUsersCanEdit?: boolean; /** @@ -2039,8 +1664,7 @@ export namespace sheets_v4 { */ export interface Schema$EmbeddedObjectPosition { /** - * If true, the embedded object is put on a new sheet whose ID is chosen for - * you. Used only when writing. + * If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing. */ newSheet?: boolean; /** @@ -2048,8 +1672,7 @@ export namespace sheets_v4 { */ overlayPosition?: Schema$OverlayPosition; /** - * The sheet this is on. Set only if the embedded object is on its own - * sheet. Must be non-negative. + * The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative. */ sheetId?: number; } @@ -2058,8 +1681,7 @@ export namespace sheets_v4 { */ export interface Schema$ErrorValue { /** - * A message with more information about the error (in the spreadsheet's - * locale). + * A message with more information about the error (in the spreadsheet's locale). */ message?: string; /** @@ -2084,14 +1706,11 @@ export namespace sheets_v4 { */ formulaValue?: string; /** - * Represents a double value. Note: Dates, Times and DateTimes are - * represented as doubles in "serial number" format. + * Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in "serial number" format. */ numberValue?: number; /** - * Represents a string value. Leading single quotes are not included. For - * example, if the user typed `'123` into the UI, this would be - * represented as a `stringValue` of `"123"`. + * Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`. */ stringValue?: string; } @@ -2100,9 +1719,7 @@ export namespace sheets_v4 { */ export interface Schema$FilterCriteria { /** - * A condition that must be true for values to be shown. (This does not - * override hiddenValues -- if a value is listed there, it will still be - * hidden.) + * A condition that must be true for values to be shown. (This does not override hiddenValues -- if a value is listed there, it will still be hidden.) */ condition?: Schema$BooleanCondition; /** @@ -2115,8 +1732,7 @@ export namespace sheets_v4 { */ export interface Schema$FilterView { /** - * The criteria for showing/hiding values per column. The map's key is - * the column index, and the value is the criteria for that column. + * The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. */ criteria?: {[key: string]: Schema$FilterCriteria}; /** @@ -2124,18 +1740,15 @@ export namespace sheets_v4 { */ filterViewId?: number; /** - * The named range this filter view is backed by, if any. When writing, - * only one of range or named_range_id may be set. + * The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set. */ namedRangeId?: string; /** - * The range this filter view covers. When writing, only one of range or - * named_range_id may be set. + * The range this filter view covers. When writing, only one of range or named_range_id may be set. */ range?: Schema$GridRange; /** - * The sort order per column. Later specifications are used when values are - * equal in the earlier specifications. + * The sort order per column. Later specifications are used when values are equal in the earlier specifications. */ sortSpecs?: Schema$SortSpec[]; /** @@ -2156,8 +1769,7 @@ export namespace sheets_v4 { */ find?: string; /** - * True if the search should include cells with formulas. False to skip - * cells with formulas. + * True if the search should include cells with formulas. False to skip cells with formulas. */ includeFormulas?: boolean; /** @@ -2177,15 +1789,7 @@ export namespace sheets_v4 { */ replacement?: string; /** - * True if the find value is a regex. The regular expression and replacement - * should follow Java regex rules at - * https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. - * The replacement string is allowed to refer to capturing groups. For - * example, if one cell has the contents `"Google Sheets"` and - * another has `"Google Docs"`, then searching for `"o.* - * (.*)"` with a replacement of `"$1 Rocks"` would change the - * contents of the cells to `"GSheets Rocks"` and `"GDocs - * Rocks"` respectively. + * True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents `"Google Sheets"` and another has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of `"$1 Rocks"` would change the contents of the cells to `"GSheets Rocks"` and `"GDocs Rocks"` respectively. */ searchByRegex?: boolean; /** @@ -2202,10 +1806,7 @@ export namespace sheets_v4 { */ formulasChanged?: number; /** - * The number of occurrences (possibly multiple within a cell) changed. For - * example, if replacing `"e"` with `"o"` in - * `"Google Sheets"`, this would be `"3"` because - * `"Google Sheets"` -> `"Googlo Shoots"`. + * The number of occurrences (possibly multiple within a cell) changed. For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`. */ occurrencesChanged?: number; /** @@ -2226,20 +1827,16 @@ export namespace sheets_v4 { */ export interface Schema$GetSpreadsheetByDataFilterRequest { /** - * The DataFilters used to select which ranges to retrieve from the - * spreadsheet. + * The DataFilters used to select which ranges to retrieve from the spreadsheet. */ dataFilters?: Schema$DataFilter[]; /** - * True if grid data should be returned. This parameter is ignored if a - * field mask was set in the request. + * True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */ includeGridData?: boolean; } /** - * A rule that applies a gradient color scale format, based on the - * interpolation points listed. The format of a cell will vary based on its - * contents as compared to the values of the interpolation points. + * A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points. */ export interface Schema$GradientRule { /** @@ -2277,19 +1874,15 @@ export namespace sheets_v4 { */ export interface Schema$GridData { /** - * Metadata about the requested columns in the grid, starting with the - * column in start_column. + * Metadata about the requested columns in the grid, starting with the column in start_column. */ columnMetadata?: Schema$DimensionProperties[]; /** - * The data in the grid, one entry per row, starting with the row in - * startRow. The values in RowData will correspond to columns starting at - * start_column. + * The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column. */ rowData?: Schema$RowData[]; /** - * Metadata about the requested rows in the grid, starting with the row in - * start_row. + * Metadata about the requested rows in the grid, starting with the row in start_row. */ rowMetadata?: Schema$DimensionProperties[]; /** @@ -2335,20 +1928,7 @@ export namespace sheets_v4 { rowGroupControlAfter?: boolean; } /** - * A range on a sheet. All indexes are zero-based. Indexes are half open, e.g - * the start index is inclusive and the end index is exclusive -- - * [start_index, end_index). Missing indexes indicate the range is unbounded - * on that side. For example, if `"Sheet1"` is sheet ID 0, then: - * `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, - * end_row_index: 1, start_column_index: 0, - * end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, - * end_row_index: 4, start_column_index: 0, - * end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, - * end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, - * start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The - * start index must always be less than or equal to the end index. If the - * start index equals the end index, then the range is empty. Empty ranges are - * typically not meaningful and are usually rendered in the UI as `#REF!`. + * A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`. */ export interface Schema$GridRange { /** @@ -2373,20 +1953,11 @@ export namespace sheets_v4 { startRowIndex?: number; } /** - * A <a - * href="/chart/interactive/docs/gallery/histogram">histogram - * chart</a>. A histogram chart groups data items into bins, displaying - * each bin as a column of stacked items. Histograms are used to display the - * distribution of a dataset. Each column of items represents a range into - * which those items fall. The number of bins can be chosen automatically or - * specified explicitly. + * A <a href="/chart/interactive/docs/gallery/histogram">histogram chart</a>. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly. */ export interface Schema$HistogramChartSpec { /** - * By default the bucket size (the range of values stacked in a single - * column) is chosen automatically, but it may be overridden here. E.g., A - * bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. - * Cannot be negative. This field is optional. + * By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional. */ bucketSize?: number; /** @@ -2394,53 +1965,24 @@ export namespace sheets_v4 { */ legendPosition?: string; /** - * The outlier percentile is used to ensure that outliers do not adversely - * affect the calculation of bucket sizes. For example, setting an outlier - * percentile of 0.05 indicates that the top and bottom 5% of values when - * calculating buckets. The values are still included in the chart, they - * will be added to the first or last buckets instead of their own buckets. - * Must be between 0.0 and 0.5. + * The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5. */ outlierPercentile?: number; /** - * The series for a histogram may be either a single series of values to be - * bucketed or multiple series, each of the same length, containing the name - * of the series followed by the values to be bucketed for that series. + * The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series. */ series?: Schema$HistogramSeries[]; /** - * Whether horizontal divider lines should be displayed between items in - * each column. + * Whether horizontal divider lines should be displayed between items in each column. */ showItemDividers?: boolean; } /** - * Allows you to organize the numeric values in a source data column into - * buckets of a constant size. All values from HistogramRule.start to - * HistogramRule.end are placed into groups of size HistogramRule.interval. In - * addition, all values below HistogramRule.start are placed in one group, and - * all values above HistogramRule.end are placed in another. Only - * HistogramRule.interval is required, though if HistogramRule.start and - * HistogramRule.end are both provided, HistogramRule.start must be less than - * HistogramRule.end. For example, a pivot table showing average purchase - * amount by age that has 50+ rows: +-----+-------------------+ | Age - * | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | - * | 17 | $5.24 | | 18 | $20.15 | ... - * +-----+-------------------+ could be turned into a pivot table that looks - * like the one below by applying a histogram group rule with a - * HistogramRule.start of 25, an HistogramRule.interval of 20, and an - * HistogramRule.end of 65. +-------------+-------------------+ | - * Grouped Age | AVERAGE of Amount | +-------------+-------------------+ - * | < 25 | $19.34 | | 25-45 | $31.43 | | - * 45-65 | $35.87 | | > 65 | $27.55 - * | +-------------+-------------------+ | Grand Total | $29.12 | - * +-------------+-------------------+ + * Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+ */ export interface Schema$HistogramRule { /** - * The maximum value at which items are placed into buckets of constant - * size. Values above end are lumped into a single bucket. This field is - * optional. + * The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional. */ end?: number; /** @@ -2448,9 +1990,7 @@ export namespace sheets_v4 { */ interval?: number; /** - * The minimum value at which items are placed into buckets of constant - * size. Values below start are lumped into a single bucket. This field is - * optional. + * The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional. */ start?: number; } @@ -2459,8 +1999,7 @@ export namespace sheets_v4 { */ export interface Schema$HistogramSeries { /** - * The color of the column representing this series in each bucket. This - * field is optional. + * The color of the column representing this series in each bucket. This field is optional. */ barColor?: Schema$Color; /** @@ -2473,21 +2012,11 @@ export namespace sheets_v4 { */ export interface Schema$InsertDimensionRequest { /** - * Whether dimension properties should be extended from the dimensions - * before or after the newly inserted dimensions. True to inherit from the - * dimensions before (in which case the start index must be greater than 0), - * and false to inherit from the dimensions after. For example, if row - * index 0 has red background and row index 1 has a green background, then - * inserting 2 rows at index 1 can inherit either the green or red - * background. If `inheritFromBefore` is true, the two new rows will be red - * (because the row before the insertion point was red), whereas if - * `inheritFromBefore` is false, the two new rows will be green (because the - * row after the insertion point was green). + * Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green). */ inheritFromBefore?: boolean; /** - * The dimensions to insert. Both the start and end indexes must be - * bounded. + * The dimensions to insert. Both the start and end indexes must be bounded. */ range?: Schema$DimensionRange; } @@ -2500,15 +2029,12 @@ export namespace sheets_v4 { */ range?: Schema$GridRange; /** - * The dimension which will be shifted when inserting cells. If ROWS, - * existing cells will be shifted down. If COLUMNS, existing cells will be - * shifted right. + * The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right. */ shiftDimension?: string; } /** - * A single interpolation point on a gradient conditional format. These pin - * the gradient color scale according to the color, type and value chosen. + * A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen. */ export interface Schema$InterpolationPoint { /** @@ -2520,24 +2046,20 @@ export namespace sheets_v4 { */ type?: string; /** - * The value this interpolation point uses. May be a formula. Unused if - * type is MIN or MAX. + * The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX. */ value?: string; } /** - * Settings to control how circular dependencies are resolved with iterative - * calculation. + * Settings to control how circular dependencies are resolved with iterative calculation. */ export interface Schema$IterativeCalculationSettings { /** - * When iterative calculation is enabled and successive results differ by - * less than this threshold value, the calculation rounds stop. + * When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop. */ convergenceThreshold?: number; /** - * When iterative calculation is enabled, the maximum number of calculation - * rounds to perform. + * When iterative calculation is enabled, the maximum number of calculation rounds to perform. */ maxIterations?: number; } @@ -2555,49 +2077,29 @@ export namespace sheets_v4 { width?: number; } /** - * Allows you to manually organize the values in a source data column into - * buckets with names of your choosing. For example, a pivot table that - * aggregates population by state: +-------+-------------------+ | - * State | SUM of Population | +-------+-------------------+ | AK | - * 0.7 | | AL | 4.8 | | AR | 2.9 | - * ... +-------+-------------------+ could be turned into a pivot table - * that aggregates population by time zone by providing a list of groups (for - * example, groupName = 'Central', items = ['AL', - * 'AR', 'IA', ...]) to a manual group rule. Note that a - * similar effect could be achieved by adding a time zone column to the source - * data and adjusting the pivot table. +-----------+-------------------+ - * | Time Zone | SUM of Population | +-----------+-------------------+ | - * Central | 106.3 | | Eastern | 151.9 | | - * Mountain | 17.4 | ... +-----------+-------------------+ + * Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+ */ export interface Schema$ManualRule { /** - * The list of group names and the corresponding items from the source data - * that map to each group name. + * The list of group names and the corresponding items from the source data that map to each group name. */ groups?: Schema$ManualRuleGroup[]; } /** - * A group name and a list of items from the source data that should be placed - * in the group with this name. + * A group name and a list of items from the source data that should be placed in the group with this name. */ export interface Schema$ManualRuleGroup { /** - * The group name, which must be a string. Each group in a given ManualRule - * must have a unique group name. + * The group name, which must be a string. Each group in a given ManualRule must have a unique group name. */ groupName?: Schema$ExtendedValue; /** - * The items in the source data that should be placed into this group. Each - * item may be a string, number, or boolean. Items may appear in at most one - * group within a given ManualRule. Items that do not appear in any group - * will appear on their own. + * The items in the source data that should be placed into this group. Each item may be a string, number, or boolean. Items may appear in at most one group within a given ManualRule. Items that do not appear in any group will appear on their own. */ items?: Schema$ExtendedValue[]; } /** - * A developer metadata entry and the data filters specified in the original - * request that matched it. + * A developer metadata entry and the data filters specified in the original request that matched it. */ export interface Schema$MatchedDeveloperMetadata { /** @@ -2640,16 +2142,7 @@ export namespace sheets_v4 { */ export interface Schema$MoveDimensionRequest { /** - * The zero-based start index of where to move the source data to, based on - * the coordinates *before* the source data is removed from the grid. - * Existing data will be shifted down or right (depending on the dimension) - * to make room for the moved dimensions. The source dimensions are removed - * from the grid, so the the data may end up in a different index than - * specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to - * move `"1"` and `"2"` to between `"3"` and - * `"4"`, the source would be `ROWS [1..3)`,and the destination - * index would be `"4"` (the zero-based index of row 5). The end - * result would be `A1..A5` of `0, 3, 1, 2, 4`. + * The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move `"1"` and `"2"` to between `"3"` and `"4"`, the source would be `ROWS [1..3)`,and the destination index would be `"4"` (the zero-based index of row 5). The end result would be `A1..A5` of `0, 3, 1, 2, 4`. */ destinationIndex?: number; /** @@ -2679,10 +2172,7 @@ export namespace sheets_v4 { */ export interface Schema$NumberFormat { /** - * Pattern string used for formatting. If not set, a default pattern based - * on the user's locale will be used if necessary for the given type. - * See the [Date and Number Formats guide](/sheets/api/guides/formats) for - * more information about the supported patterns. + * Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the [Date and Number Formats guide](/sheets/api/guides/formats) for more information about the supported patterns. */ pattern?: string; /** @@ -2691,21 +2181,11 @@ export namespace sheets_v4 { type?: string; } /** - * An <a href="/chart/interactive/docs/gallery/orgchart">org - * chart</a>. Org charts require a unique set of labels in labels and - * may optionally include parent_labels and tooltips. parent_labels contain, - * for each node, the label identifying the parent node. tooltips contain, - * for each node, an optional tooltip. For example, to describe an OrgChart - * with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy - * as VP of Sales (also reporting to Alice), have labels contain - * "Alice", "Bob", "Cathy", parent_labels - * contain "", "Alice", "Alice" and tooltips - * contain "CEO", "President", "VP Sales". + * An <a href="/chart/interactive/docs/gallery/orgchart">org chart</a>. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain "Alice", "Bob", "Cathy", parent_labels contain "", "Alice", "Alice" and tooltips contain "CEO", "President", "VP Sales". */ export interface Schema$OrgChartSpec { /** - * The data containing the labels for all the nodes in the chart. Labels - * must be unique. + * The data containing the labels for all the nodes in the chart. Labels must be unique. */ labels?: Schema$ChartData; /** @@ -2717,9 +2197,7 @@ export namespace sheets_v4 { */ nodeSize?: string; /** - * The data containing the label of the parent for the corresponding node. A - * blank value indicates that the node has no parent and is a top-level - * node. This field is optional. + * The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional. */ parentLabels?: Schema$ChartData; /** @@ -2727,9 +2205,7 @@ export namespace sheets_v4 { */ selectedNodeColor?: Schema$Color; /** - * The data containing the tooltip for the corresponding node. A blank - * value results in no tooltip being displayed for the node. This field is - * optional. + * The data containing the tooltip for the corresponding node. A blank value results in no tooltip being displayed for the node. This field is optional. */ tooltips?: Schema$ChartData; } @@ -2746,13 +2222,11 @@ export namespace sheets_v4 { */ heightPixels?: number; /** - * The horizontal offset, in pixels, that the object is offset from the - * anchor cell. + * The horizontal offset, in pixels, that the object is offset from the anchor cell. */ offsetXPixels?: number; /** - * The vertical offset, in pixels, that the object is offset from the anchor - * cell. + * The vertical offset, in pixels, that the object is offset from the anchor cell. */ offsetYPixels?: number; /** @@ -2761,8 +2235,7 @@ export namespace sheets_v4 { widthPixels?: number; } /** - * The amount of padding around the cell, in pixels. When updating padding, - * every field must be specified. + * The amount of padding around the cell, in pixels. When updating padding, every field must be specified. */ export interface Schema$Padding { /** @@ -2808,8 +2281,7 @@ export namespace sheets_v4 { type?: string; } /** - * A <a href="/chart/interactive/docs/gallery/piechart">pie - * chart</a>. + * A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. */ export interface Schema$PieChartSpec { /** @@ -2851,31 +2323,11 @@ export namespace sheets_v4 { */ groupRule?: Schema$PivotGroupRule; /** - * The labels to use for the row/column groups which can be customized. For - * example, in the following pivot table, the row label is `Region` (which - * could be renamed to `State`) and the column label is `Product` (which - * could be renamed `Item`). Pivot tables created before December 2017 do - * not have header labels. If you'd like to add header labels to an - * existing pivot table, please delete the existing pivot table and then - * create a new pivot table with same parameters. - * +--------------+---------+-------+ | SUM of Units | Product | | - * | Region | Pen | Paper | +--------------+---------+-------+ - * | New York | 345 | 98 | | Oregon | 234 | 123 | - * | Tennessee | 531 | 415 | +--------------+---------+-------+ - * | Grand Total | 1110 | 636 | +--------------+---------+-------+ + * The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables created before December 2017 do not have header labels. If you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then create a new pivot table with same parameters. +--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+ */ label?: string; /** - * True if the headings in this pivot group should be repeated. This is only - * valid for row groupings and is ignored by columns. By default, we - * minimize repitition of headings by not showing higher level headings - * where they are the same. For example, even though the third row below - * corresponds to "Q1 Mar", "Q1" is not shown because it - * is redundant with previous rows. Setting repeat_headings to true would - * cause "Q1" to be repeated for "Feb" and - * "Mar". +--------------+ | Q1 | Jan | | | Feb | - * | | Mar | +--------+-----+ | Q1 Total | - * +--------------+ + * True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repitition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to "Q1 Mar", "Q1" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause "Q1" to be repeated for "Feb" and "Mar". +--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+ */ repeatHeadings?: boolean; /** @@ -2887,15 +2339,11 @@ export namespace sheets_v4 { */ sortOrder?: string; /** - * The column offset of the source range that this grouping is based on. For - * example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means - * this group refers to column `C`, whereas the offset `1` would refer to - * column `D`. + * The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`. */ sourceColumnOffset?: number; /** - * The bucket of the opposite pivot group to sort by. If not specified, - * sorting is alphabetical by this group's values. + * The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values. */ valueBucket?: Schema$PivotGroupSortValueBucket; /** @@ -2904,11 +2352,7 @@ export namespace sheets_v4 { valueMetadata?: Schema$PivotGroupValueMetadata[]; } /** - * An optional setting on a PivotGroup that defines buckets for the values in - * the source data column rather than breaking out each individual value. Only - * one PivotGroup with a group rule may be added for each column in the source - * data, though on any given column you may add both a PivotGroup that has a - * rule and a PivotGroup that does not. + * An optional setting on a PivotGroup that defines buckets for the values in the source data column rather than breaking out each individual value. Only one PivotGroup with a group rule may be added for each column in the source data, though on any given column you may add both a PivotGroup that has a rule and a PivotGroup that does not. */ export interface Schema$PivotGroupRule { /** @@ -2929,19 +2373,11 @@ export namespace sheets_v4 { */ export interface Schema$PivotGroupSortValueBucket { /** - * Determines the bucket from which values are chosen to sort. For example, - * in a pivot table with one row group & two column groups, the row - * group can list up to two values. The first value corresponds to a value - * within the first column group, and the second value corresponds to a - * value in the second column group. If no values are listed, this would - * indicate that the row should be sorted according to the "Grand - * Total" over the column groups. If a single value is listed, this - * would correspond to using the "Total" of that bucket. + * Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the "Grand Total" over the column groups. If a single value is listed, this would correspond to using the "Total" of that bucket. */ buckets?: Schema$ExtendedValue[]; /** - * The offset in the PivotTable.values list which the values in this - * grouping should be sorted by. + * The offset in the PivotTable.values list which the values in this grouping should be sorted by. */ valuesIndex?: number; } @@ -2954,8 +2390,7 @@ export namespace sheets_v4 { */ collapsed?: boolean; /** - * The calculated value the metadata corresponds to. (Note that formulaValue - * is not valid, because the values will be calculated.) + * The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.) */ value?: Schema$ExtendedValue; } @@ -2968,12 +2403,7 @@ export namespace sheets_v4 { */ columns?: Schema$PivotGroup[]; /** - * An optional mapping of filters per source column offset. The filters are - * applied before aggregating data into the pivot table. The map's key - * is the column offset of the source range that you want to filter, and the - * value is the criteria for that column. For example, if the source was - * `C10:E15`, a key of `0` will have the filter for column `C`, whereas the - * key `1` is for column `D`. + * An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. */ criteria?: {[key: string]: Schema$PivotFilterCriteria}; /** @@ -2985,8 +2415,7 @@ export namespace sheets_v4 { */ source?: Schema$GridRange; /** - * Whether values should be listed horizontally (as columns) or vertically - * (as rows). + * Whether values should be listed horizontally (as columns) or vertically (as rows). */ valueLayout?: string; /** @@ -2999,17 +2428,11 @@ export namespace sheets_v4 { */ export interface Schema$PivotValue { /** - * If specified, indicates that pivot values should be displayed as the - * result of a calculation with another pivot value. For example, if - * calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the - * pivot values are displayed as the percentage of the grand total. In the - * Sheets UI, this is referred to as "Show As" in the value - * section of a pivot table. + * If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets UI, this is referred to as "Show As" in the value section of a pivot table. */ calculatedDisplayType?: string; /** - * A custom formula to calculate the value. The formula must start with an - * `=` character. + * A custom formula to calculate the value. The formula must start with an `=` character. */ formula?: string; /** @@ -3017,16 +2440,11 @@ export namespace sheets_v4 { */ name?: string; /** - * The column offset of the source range that this value reads from. For - * example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means - * this value refers to column `C`, whereas the offset `1` would refer to - * column `D`. + * The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`. */ sourceColumnOffset?: number; /** - * A function to summarize the value. If formula is set, the only supported - * values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is - * not supported. + * A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported. */ summarizeFunction?: string; } @@ -3039,14 +2457,11 @@ export namespace sheets_v4 { */ description?: string; /** - * The users and groups with edit access to the protected range. This field - * is only visible to users with edit access to the protected range and the - * document. Editors are not supported with warning_only protection. + * The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection. */ editors?: Schema$Editors; /** - * The named range this protected range is backed by, if any. When writing, - * only one of range or named_range_id may be set. + * The named range this protected range is backed by, if any. When writing, only one of range or named_range_id may be set. */ namedRangeId?: string; /** @@ -3054,29 +2469,19 @@ export namespace sheets_v4 { */ protectedRangeId?: number; /** - * The range that is being protected. The range may be fully unbounded, in - * which case this is considered a protected sheet. When writing, only one - * of range or named_range_id may be set. + * The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id may be set. */ range?: Schema$GridRange; /** - * True if the user who requested this protected range can edit the - * protected area. This field is read-only. + * True if the user who requested this protected range can edit the protected area. This field is read-only. */ requestingUserCanEdit?: boolean; /** - * The list of unprotected ranges within a protected sheet. Unprotected - * ranges are only supported on protected sheets. + * The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets. */ unprotectedRanges?: Schema$GridRange[]; /** - * True if this protected range will show a warning when editing. - * Warning-based protection means that every user can edit data in the - * protected range, except editing will prompt a warning asking the user to - * confirm the edit. When writing: if this field is true, then editors is - * ignored. Additionally, if this field is changed from true to false and - * the `editors` field is not set (nor included in the field mask), then the - * editors will be set to all the editors in the document. + * True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors is ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document. */ warningOnly?: boolean; } @@ -3090,15 +2495,7 @@ export namespace sheets_v4 { range?: Schema$GridRange; } /** - * Updates all cells in the range to the values in the given Cell object. Only - * the fields listed in the fields field are updated; others are unchanged. If - * writing a cell with a formula, the formula's ranges will automatically - * increment for each field in the range. For example, if writing a cell with - * formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 - * would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To - * keep the formula's ranges static, use the `$` indicator. For example, - * use the formula `=$A$1` to prevent both the row and the column from - * incrementing. + * Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the formula's ranges static, use the `$` indicator. For example, use the formula `=$A$1` to prevent both the row and the column from incrementing. */ export interface Schema$RepeatCellRequest { /** @@ -3106,9 +2503,7 @@ export namespace sheets_v4 { */ cell?: Schema$CellData; /** - * The fields that should be updated. At least one field must be specified. - * The root `cell` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `cell` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -3165,8 +2560,7 @@ export namespace sheets_v4 { */ autoFill?: Schema$AutoFillRequest; /** - * Automatically resizes one or more dimensions based on the contents of the - * cells in that dimension. + * Automatically resizes one or more dimensions based on the contents of the cells in that dimension. */ autoResizeDimensions?: Schema$AutoResizeDimensionsRequest; /** @@ -3429,14 +2823,11 @@ export namespace sheets_v4 { values?: Schema$CellData[]; } /** - * A request to retrieve all developer metadata matching the set of specified - * criteria. + * A request to retrieve all developer metadata matching the set of specified criteria. */ export interface Schema$SearchDeveloperMetadataRequest { /** - * The data filters describing the criteria used to determine which - * DeveloperMetadata entries to return. DeveloperMetadata matching any of - * the specified filters will be included in the response. + * The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters will be included in the response. */ dataFilters?: Schema$DataFilter[]; } @@ -3459,8 +2850,7 @@ export namespace sheets_v4 { filter?: Schema$BasicFilter; } /** - * Sets a data validation rule to every cell in the range. To clear validation - * in a range, call this with no rule specified. + * Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified. */ export interface Schema$SetDataValidationRequest { /** @@ -3468,8 +2858,7 @@ export namespace sheets_v4 { */ range?: Schema$GridRange; /** - * The data validation rule to set on each cell in the range, or empty to - * clear the data validation in the range. + * The data validation rule to set on each cell in the range, or empty to clear the data validation in the range. */ rule?: Schema$DataValidationRule; } @@ -3490,8 +2879,7 @@ export namespace sheets_v4 { */ charts?: Schema$EmbeddedChart[]; /** - * All column groups on this sheet, ordered by increasing range start index, - * then by group depth. + * All column groups on this sheet, ordered by increasing range start index, then by group depth. */ columnGroups?: Schema$DimensionGroup[]; /** @@ -3499,13 +2887,7 @@ export namespace sheets_v4 { */ conditionalFormats?: Schema$ConditionalFormatRule[]; /** - * Data in the grid, if this is a grid sheet. The number of GridData objects - * returned is dependent on the number of ranges requested on this sheet. - * For example, if this is representing `Sheet1`, and the spreadsheet was - * requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the - * first GridData will have a startRow/startColumn of `0`, while the second - * one will have `startRow 14` (zero-based row 15), and `startColumn 3` - * (zero-based column D). + * Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D). */ data?: Schema$GridData[]; /** @@ -3529,8 +2911,7 @@ export namespace sheets_v4 { */ protectedRanges?: Schema$ProtectedRange[]; /** - * All row groups on this sheet, ordered by increasing range start index, - * then by group depth. + * All row groups on this sheet, ordered by increasing range start index, then by group depth. */ rowGroups?: Schema$DimensionGroup[]; } @@ -3539,10 +2920,7 @@ export namespace sheets_v4 { */ export interface Schema$SheetProperties { /** - * Additional properties of the sheet if this sheet is a grid. (If the sheet - * is an object sheet, containing a chart or image, then this field will be - * absent.) When writing it is an error to set any grid properties on - * non-grid sheets. + * Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. */ gridProperties?: Schema$GridProperties; /** @@ -3550,15 +2928,7 @@ export namespace sheets_v4 { */ hidden?: boolean; /** - * The index of the sheet within the spreadsheet. When adding or updating - * sheet properties, if this field is excluded then the sheet is added or - * moved to the end of the sheet list. When updating sheet indices or - * inserting sheets, movement is considered in "before the move" - * indexes. For example, if there were 3 sheets (S1, S2, S3) in order to - * move S1 ahead of S2 the index would have to be set to 2. A sheet index - * update request is ignored if the requested index is identical to the - * sheets current index or if the requested new index is equal to the - * current sheet index + 1. + * The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1. */ index?: number; /** @@ -3566,13 +2936,11 @@ export namespace sheets_v4 { */ rightToLeft?: boolean; /** - * The ID of the sheet. Must be non-negative. This field cannot be changed - * once set. + * The ID of the sheet. Must be non-negative. This field cannot be changed once set. */ sheetId?: number; /** - * The type of sheet. Defaults to GRID. This field cannot be changed once - * set. + * The type of sheet. Defaults to GRID. This field cannot be changed once set. */ sheetType?: string; /** @@ -3593,8 +2961,7 @@ export namespace sheets_v4 { */ range?: Schema$GridRange; /** - * The sort order per column. Later specifications are used when values are - * equal in the earlier specifications. + * The sort order per column. Later specifications are used when values are equal in the earlier specifications. */ sortSpecs?: Schema$SortSpec[]; } @@ -3620,9 +2987,7 @@ export namespace sheets_v4 { */ dimension?: string; /** - * The number of rows or columns that data should be filled into. Positive - * numbers expand beyond the last row or last column of the source. Negative - * numbers expand before the first row or first column of the source. + * The number of rows or columns that data should be filled into. Positive numbers expand beyond the last row or last column of the source. Negative numbers expand before the first row or first column of the source. */ fillLength?: number; /** @@ -3668,29 +3033,19 @@ export namespace sheets_v4 { */ autoRecalc?: string; /** - * The default format of all cells in the spreadsheet. - * CellData.effectiveFormat will not be set if the cell's format is - * equal to this default format. This field is read-only. + * The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only. */ defaultFormat?: Schema$CellFormat; /** - * Determines whether and how circular references are resolved with - * iterative calculation. Absence of this field means that circular - * references will result in calculation errors. + * Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references will result in calculation errors. */ iterativeCalculationSettings?: Schema$IterativeCalculationSettings; /** - * The locale of the spreadsheet in one of the following formats: * an ISO - * 639-1 language code such as `en` * an ISO 639-2 language code such as - * `fil`, if no 639-1 code exists * a combination of the ISO language code - * and country code, such as `en_US` Note: when updating this field, not - * all locales/languages are supported. + * The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported. */ locale?: string; /** - * The time zone of the spreadsheet, in CLDR format such as - * `America/New_York`. If the time zone isn't recognized, this may be a - * custom time zone such as `GMT-07:00`. + * The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`. */ timeZone?: string; /** @@ -3699,8 +3054,7 @@ export namespace sheets_v4 { title?: string; } /** - * The format of a run of text in a cell. Absent values indicate that the - * field isn't specified. + * The format of a run of text in a cell. Absent values indicate that the field isn't specified. */ export interface Schema$TextFormat { /** @@ -3733,8 +3087,7 @@ export namespace sheets_v4 { underline?: boolean; } /** - * A run of a text format. The format of this run continues until the start - * index of the next run. When updating, all fields must be set. + * A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set. */ export interface Schema$TextFormatRun { /** @@ -3760,23 +3113,16 @@ export namespace sheets_v4 { */ export interface Schema$TextRotation { /** - * The angle between the standard orientation and the desired orientation. - * Measured in degrees. Valid values are between -90 and 90. Positive angles - * are angled upwards, negative are angled downwards. Note: For LTR text - * direction positive angles are in the counterclockwise direction, whereas - * for RTL they are in the clockwise direction + * The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counterclockwise direction, whereas for RTL they are in the clockwise direction */ angle?: number; /** - * If true, text reads top to bottom, but the orientation of individual - * characters is unchanged. For example: | V | | e | | r | | t - * | | i | | c | | a | | l | + * If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: | V | | e | | r | | t | | i | | c | | a | | l | */ vertical?: boolean; } /** - * Splits a column of text into multiple columns, based on a delimiter in each - * cell. + * Splits a column of text into multiple columns, based on a delimiter in each cell. */ export interface Schema$TextToColumnsRequest { /** @@ -3797,50 +3143,32 @@ export namespace sheets_v4 { */ export interface Schema$TreemapChartColorScale { /** - * The background color for cells with a color value greater than or equal - * to maxValue. Defaults to #109618 if not specified. + * The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. */ maxValueColor?: Schema$Color; /** - * The background color for cells with a color value at the midpoint between - * minValue and maxValue. Defaults to #efe6dc if not specified. + * The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. */ midValueColor?: Schema$Color; /** - * The background color for cells with a color value less than or equal to - * minValue. Defaults to #dc3912 if not specified. + * The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. */ minValueColor?: Schema$Color; /** - * The background color for cells that have no color data associated with - * them. Defaults to #000000 if not specified. + * The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. */ noDataColor?: Schema$Color; } /** - * A <a href="/chart/interactive/docs/gallery/treemap">Treemap - * chart</a>. + * A <a href="/chart/interactive/docs/gallery/treemap">Treemap chart</a>. */ export interface Schema$TreemapChartSpec { /** - * The data that determines the background color of each treemap data cell. - * This field is optional. If not specified, size_data is used to determine - * background colors. If specified, the data is expected to be numeric. - * color_scale will determine how the values in this data map to data cell - * background colors. + * The data that determines the background color of each treemap data cell. This field is optional. If not specified, size_data is used to determine background colors. If specified, the data is expected to be numeric. color_scale will determine how the values in this data map to data cell background colors. */ colorData?: Schema$ChartData; /** - * The color scale for data cells in the treemap chart. Data cells are - * assigned colors based on their color values. These color values come from - * color_data, or from size_data if color_data is not specified. Cells with - * color values less than or equal to min_value will have minValueColor as - * their background color. Cells with color values greater than or equal to - * max_value will have maxValueColor as their background color. Cells with - * color values between min_value and max_value will have background colors - * on a gradient between minValueColor and maxValueColor, the midpoint of - * the gradient being midValueColor. Cells with missing or non-numeric color - * values will have noDataColor as their background color. + * The color scale for data cells in the treemap chart. Data cells are assigned colors based on their color values. These color values come from color_data, or from size_data if color_data is not specified. Cells with color values less than or equal to min_value will have minValueColor as their background color. Cells with color values greater than or equal to max_value will have maxValueColor as their background color. Cells with color values between min_value and max_value will have background colors on a gradient between minValueColor and maxValueColor, the midpoint of the gradient being midValueColor. Cells with missing or non-numeric color values will have noDataColor as their background color. */ colorScale?: Schema$TreemapChartColorScale; /** @@ -3852,9 +3180,7 @@ export namespace sheets_v4 { */ hideTooltips?: boolean; /** - * The number of additional data levels beyond the labeled levels to be - * shown on the treemap chart. These levels are not interactive and are - * shown without their labels. Defaults to 0 if not specified. + * The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified. */ hintedLevels?: number; /** @@ -3862,23 +3188,15 @@ export namespace sheets_v4 { */ labels?: Schema$ChartData; /** - * The number of data levels to show on the treemap chart. These levels are - * interactive and are shown with their labels. Defaults to 2 if not - * specified. + * The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified. */ levels?: number; /** - * The maximum possible data value. Cells with values greater than this will - * have the same color as cells with this value. If not specified, defaults - * to the actual maximum value from color_data, or the maximum value from - * size_data if color_data is not specified. + * The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified. */ maxValue?: number; /** - * The minimum possible data value. Cells with values less than this will - * have the same color as cells with this value. If not specified, defaults - * to the actual minimum value from color_data, or the minimum value from - * size_data if color_data is not specified. + * The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified. */ minValue?: number; /** @@ -3886,10 +3204,7 @@ export namespace sheets_v4 { */ parentLabels?: Schema$ChartData; /** - * The data that determines the size of each treemap data cell. This data is - * expected to be numeric. The cells corresponding to non-numeric or missing - * data will not be rendered. If color_data is not specified, this data is - * used to determine data cell background colors as well. + * The data that determines the size of each treemap data cell. This data is expected to be numeric. The cells corresponding to non-numeric or missing data will not be rendered. If color_data is not specified, this data is used to determine data cell background colors as well. */ sizeData?: Schema$ChartData; /** @@ -3902,9 +3217,7 @@ export namespace sheets_v4 { */ export interface Schema$UnmergeCellsRequest { /** - * The range within which all cells should be unmerged. If the range spans - * multiple merges, all will be unmerged. The range must not partially span - * any merge. + * The range within which all cells should be unmerged. If the range spans multiple merges, all will be unmerged. The range must not partially span any merge. */ range?: Schema$GridRange; } @@ -3917,19 +3230,12 @@ export namespace sheets_v4 { */ bandedRange?: Schema$BandedRange; /** - * The fields that should be updated. At least one field must be specified. - * The root `bandedRange` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `bandedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; } /** - * Updates the borders of a range. If a field is not set in the request, that - * means the border remains as-is. For example, with two subsequent - * UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. - * range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders - * of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a - * border, explicitly set the style to NONE. + * Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a border, explicitly set the style to NONE. */ export interface Schema$UpdateBordersRequest { /** @@ -3966,16 +3272,11 @@ export namespace sheets_v4 { */ export interface Schema$UpdateCellsRequest { /** - * The fields of CellData that should be updated. At least one field must be - * specified. The root is the CellData; 'row.values.' should not be - * specified. A single `"*"` can be used as short-hand for listing - * every field. + * The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** - * The range to write data to. If the data in rows does not cover the - * entire requested range, the fields matching those set in fields will be - * cleared. + * The range to write data to. If the data in rows does not cover the entire requested range, the fields matching those set in fields will be cleared. */ range?: Schema$GridRange; /** @@ -3983,14 +3284,12 @@ export namespace sheets_v4 { */ rows?: Schema$RowData[]; /** - * The coordinate to start writing data at. Any number of rows and columns - * (including a different number of columns per row) may be written. + * The coordinate to start writing data at. Any number of rows and columns (including a different number of columns per row) may be written. */ start?: Schema$GridCoordinate; } /** - * Updates a chart's specifications. (This does not move or resize a - * chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.) + * Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.) */ export interface Schema$UpdateChartSpecRequest { /** @@ -4003,8 +3302,7 @@ export namespace sheets_v4 { spec?: Schema$ChartSpec; } /** - * Updates a conditional format rule at the given index, or moves a - * conditional format rule to another index. + * Updates a conditional format rule at the given index, or moves a conditional format rule to another index. */ export interface Schema$UpdateConditionalFormatRuleRequest { /** @@ -4020,8 +3318,7 @@ export namespace sheets_v4 { */ rule?: Schema$ConditionalFormatRule; /** - * The sheet of the rule to move. Required if new_index is set, unused - * otherwise. + * The sheet of the rule to move. Required if new_index is set, unused otherwise. */ sheetId?: number; } @@ -4034,27 +3331,20 @@ export namespace sheets_v4 { */ newIndex?: number; /** - * The new rule that replaced the old rule (if replacing), or the rule that - * was moved (if moved) + * The new rule that replaced the old rule (if replacing), or the rule that was moved (if moved) */ newRule?: Schema$ConditionalFormatRule; /** - * The old index of the rule. Not set if a rule was replaced (because it is - * the same as new_index). + * The old index of the rule. Not set if a rule was replaced (because it is the same as new_index). */ oldIndex?: number; /** - * The old (deleted) rule. Not set if a rule was moved (because it is the - * same as new_rule). + * The old (deleted) rule. Not set if a rule was moved (because it is the same as new_rule). */ oldRule?: Schema$ConditionalFormatRule; } /** - * A request to update properties of developer metadata. Updates the - * properties of the developer metadata selected by the filters to the values - * provided in the DeveloperMetadata resource. Callers must specify the - * properties they wish to update in the fields parameter, as well as specify - * at least one DataFilter matching the metadata they wish to update. + * A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update. */ export interface Schema$UpdateDeveloperMetadataRequest { /** @@ -4062,14 +3352,11 @@ export namespace sheets_v4 { */ dataFilters?: Schema$DataFilter[]; /** - * The value that all metadata matched by the data filters will be updated - * to. + * The value that all metadata matched by the data filters will be updated to. */ developerMetadata?: Schema$DeveloperMetadata; /** - * The fields that should be updated. At least one field must be specified. - * The root `developerMetadata` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `developerMetadata` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; } @@ -4087,14 +3374,11 @@ export namespace sheets_v4 { */ export interface Schema$UpdateDimensionGroupRequest { /** - * The group whose state should be updated. The range and depth of the group - * should specify a valid group on the sheet, and all other fields updated. + * The group whose state should be updated. The range and depth of the group should specify a valid group on the sheet, and all other fields updated. */ dimensionGroup?: Schema$DimensionGroup; /** - * The fields that should be updated. At least one field must be specified. - * The root `dimensionGroup` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `dimensionGroup` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; } @@ -4103,9 +3387,7 @@ export namespace sheets_v4 { */ export interface Schema$UpdateDimensionPropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `properties` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -4118,23 +3400,15 @@ export namespace sheets_v4 { range?: Schema$DimensionRange; } /** - * Update an embedded object's position (such as a moving or resizing a - * chart or image). + * Update an embedded object's position (such as a moving or resizing a chart or image). */ export interface Schema$UpdateEmbeddedObjectPositionRequest { /** - * The fields of OverlayPosition that should be updated when setting a new - * position. Used only if newPosition.overlayPosition is set, in which case - * at least one field must be specified. The root - * `newPosition.overlayPosition` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. + * The fields of OverlayPosition that should be updated when setting a new position. Used only if newPosition.overlayPosition is set, in which case at least one field must be specified. The root `newPosition.overlayPosition` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** - * An explicit position to move the embedded object to. If - * newPosition.sheetId is set, a new sheet with that ID will be created. If - * newPosition.newSheet is set to true, a new sheet will be created with an - * ID that will be chosen for you. + * An explicit position to move the embedded object to. If newPosition.sheetId is set, a new sheet with that ID will be created. If newPosition.newSheet is set to true, a new sheet will be created with an ID that will be chosen for you. */ newPosition?: Schema$EmbeddedObjectPosition; /** @@ -4156,9 +3430,7 @@ export namespace sheets_v4 { */ export interface Schema$UpdateFilterViewRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `filter` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `filter` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -4171,9 +3443,7 @@ export namespace sheets_v4 { */ export interface Schema$UpdateNamedRangeRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `namedRange` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `namedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -4186,9 +3456,7 @@ export namespace sheets_v4 { */ export interface Schema$UpdateProtectedRangeRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `protectedRange` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `protectedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -4201,9 +3469,7 @@ export namespace sheets_v4 { */ export interface Schema$UpdateSheetPropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `properties` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -4216,9 +3482,7 @@ export namespace sheets_v4 { */ export interface Schema$UpdateSpreadsheetPropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root 'properties' is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. + * The fields that should be updated. At least one field must be specified. The root 'properties' is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */ fields?: string; /** @@ -4227,8 +3491,7 @@ export namespace sheets_v4 { properties?: Schema$SpreadsheetProperties; } /** - * The response when updating a range of values by a data filter in a - * spreadsheet. + * The response when updating a range of values by a data filter in a spreadsheet. */ export interface Schema$UpdateValuesByDataFilterResponse { /** @@ -4244,9 +3507,7 @@ export namespace sheets_v4 { */ updatedColumns?: number; /** - * The values of the cells in the range matched by the dataFilter after all - * updates were applied. This is only included if the request's - * `includeValuesInResponse` field was `true`. + * The values of the cells in the range matched by the dataFilter after all updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */ updatedData?: Schema$ValueRange; /** @@ -4275,8 +3536,7 @@ export namespace sheets_v4 { */ updatedColumns?: number; /** - * The values of the cells after updates were applied. This is only included - * if the request's `includeValuesInResponse` field was `true`. + * The values of the cells after updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */ updatedData?: Schema$ValueRange; /** @@ -4293,32 +3553,15 @@ export namespace sheets_v4 { */ export interface Schema$ValueRange { /** - * The major dimension of the values. For output, if the spreadsheet data - * is: `A1=1,B1=2,A2=3,B2=4`, then requesting - * `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas - * requesting `range=A1:B2,majorDimension=COLUMNS` will return - * `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then - * `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With - * `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set - * `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it - * defaults to ROWS. + * The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */ majorDimension?: string; /** - * The range the values cover, in A1 notation. For output, this range - * indicates the entire requested range, even though the values will exclude - * trailing rows and columns. When appending values, this field represents - * the range to search for a table, after which values will be appended. + * The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */ range?: string; /** - * The data that was read or to be written. This is an array of arrays, the - * outer array representing all the data and each inner array representing a - * major dimension. Each item in the inner array corresponds with one cell. - * For output, empty trailing rows and columns will not be included. For - * input, supported value types are: bool, string, and double. Null values - * will be skipped. To set a cell to an empty value, set the string value to - * an empty string. + * The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */ values?: any[][]; } @@ -4340,8 +3583,7 @@ export namespace sheets_v4 { */ export interface Schema$WaterfallChartCustomSubtotal { /** - * True if the data point at subtotal_index is the subtotal. If false, the - * subtotal will be computed and appear after the data point. + * True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point. */ dataIsSubtotal?: boolean; /** @@ -4349,14 +3591,7 @@ export namespace sheets_v4 { */ label?: string; /** - * The 0-based index of a data point within the series. If data_is_subtotal - * is true, the data point at this index is the subtotal. Otherwise, the - * subtotal appears after the data point with this index. A series can have - * multiple subtotals at arbitrary indices, but subtotals do not affect the - * indices of the data points. For example, if a series has three data - * points, their indices will always be 0, 1, and 2, regardless of how many - * subtotals exist on the series or what data points they are associated - * with. + * The 0-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has three data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with. */ subtotalIndex?: number; } @@ -4378,9 +3613,7 @@ export namespace sheets_v4 { */ export interface Schema$WaterfallChartSeries { /** - * Custom subtotal columns appearing in this series. The order in which - * subtotals are defined is not significant. Only one subtotal may be - * defined for each data point. + * Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point. */ customSubtotals?: Schema$WaterfallChartCustomSubtotal[]; /** @@ -4388,9 +3621,7 @@ export namespace sheets_v4 { */ data?: Schema$ChartData; /** - * True to hide the subtotal column from the end of the series. By default, - * a subtotal column will appear at the end of each series. Setting this - * field to true will hide that subtotal column for this series. + * True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series. */ hideTrailingSubtotal?: boolean; /** @@ -4452,19 +3683,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.batchUpdate - * @desc Applies one or more updates to the spreadsheet. Each request is - * validated before being applied. If any request is not valid then the - * entire request will fail and nothing will be applied. Some requests have - * replies to give you some information about how they are applied. The - * replies will mirror the requests. For example, if you applied 4 updates - * and the 3rd one had a reply, then the response will have 2 empty replies, - * the actual reply, and another empty reply, in that order. Due to the - * collaborative nature of spreadsheets, it is not guaranteed that the - * spreadsheet will reflect exactly your changes after this completes, - * however it is guaranteed that the updates in the request will be applied - * together atomically. Your changes may be altered with respect to - * collaborator changes. If there are no collaborators, the spreadsheet - * should reflect your changes. + * @desc Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes. * @example * * // BEFORE RUNNING: * // --------------- @@ -4480,8 +3699,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The spreadsheet to apply the updates to. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // A list of updates to apply to the spreadsheet. @@ -4507,10 +3725,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -4640,10 +3856,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -4727,17 +3941,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.get - * @desc Returns the spreadsheet at the given ID. The caller must specify - * the spreadsheet ID. By default, data within grids will not be returned. - * You can include grid data one of two ways: * Specify a field mask - * listing your desired fields using the `fields` URL parameter in HTTP * - * Set the includeGridData URL parameter to true. If a field mask is set, - * the `includeGridData` parameter is ignored For large spreadsheets, it is - * recommended to retrieve only the specific fields of the spreadsheet that - * you want. To retrieve only subsets of the spreadsheet, use the ranges - * URL parameter. Multiple ranges can be specified. Limiting the range will - * return only the portions of the spreadsheet that intersect the requested - * ranges. Ranges are specified using A1 notation. + * @desc Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation. * @example * * // BEFORE RUNNING: * // --------------- @@ -4753,8 +3957,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The spreadsheet to request. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The ranges to retrieve from the spreadsheet. * ranges: [], // TODO: Update placeholder value. @@ -4778,10 +3981,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -4871,18 +4072,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.getByDataFilter - * @desc Returns the spreadsheet at the given ID. The caller must specify - * the spreadsheet ID. This method differs from GetSpreadsheet in that it - * allows selecting which subsets of spreadsheet data to return by - * specifying a dataFilters parameter. Multiple DataFilters can be - * specified. Specifying one or more data filters will return the portions - * of the spreadsheet that intersect ranges matched by any of the filters. - * By default, data within grids will not be returned. You can include grid - * data one of two ways: * Specify a field mask listing your desired fields - * using the `fields` URL parameter in HTTP * Set the includeGridData - * parameter to true. If a field mask is set, the `includeGridData` - * parameter is ignored For large spreadsheets, it is recommended to - * retrieve only the specific fields of the spreadsheet that you want. + * @desc Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want. * @example * * // BEFORE RUNNING: * // --------------- @@ -4898,8 +4088,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The spreadsheet to request. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // The DataFilters used to select which ranges to retrieve from @@ -4907,8 +4096,8 @@ export namespace sheets_v4 { * dataFilters: [], // TODO: Update placeholder value. * * // True if grid data should be returned. - * // This parameter is ignored if a field mask was set in the - * request. includeGridData: false, // TODO: Update placeholder value. + * // This parameter is ignored if a field mask was set in the request. + * includeGridData: false, // TODO: Update placeholder value. * * // TODO: Add desired properties to the request body. * }, @@ -4928,10 +4117,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -5053,8 +4240,7 @@ export namespace sheets_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * True if grid data should be returned. This parameter is ignored if a - * field mask was set in the request. + * True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */ includeGridData?: boolean; /** @@ -5092,9 +4278,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.developerMetadata.get - * @desc Returns the developer metadata with the specified ID. The caller - * must specify the spreadsheet ID and the developer metadata's unique - * metadataId. + * @desc Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. * @example * * // BEFORE RUNNING: * // --------------- @@ -5110,8 +4294,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to retrieve metadata from. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The ID of the developer metadata to retrieve. * metadataId: 0, // TODO: Update placeholder value. @@ -5119,8 +4302,10 @@ export namespace sheets_v4 { * auth: authClient, * }; * - * sheets.spreadsheets.developerMetadata.get(request, function(err, - * response) { if (err) { console.error(err); return; + * sheets.spreadsheets.developerMetadata.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5129,10 +4314,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -5220,11 +4403,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.developerMetadata.search - * @desc Returns all developer metadata matching the specified DataFilter. - * If the provided DataFilter represents a DeveloperMetadataLookup object, - * this will return all DeveloperMetadata entries selected by it. If the - * DataFilter represents a location in a spreadsheet, this will return all - * developer metadata associated with locations intersecting that region. + * @desc Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region. * @example * * // BEFORE RUNNING: * // --------------- @@ -5240,8 +4419,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to retrieve metadata from. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -5250,8 +4428,10 @@ export namespace sheets_v4 { * auth: authClient, * }; * - * sheets.spreadsheets.developerMetadata.search(request, function(err, - * response) { if (err) { console.error(err); return; + * sheets.spreadsheets.developerMetadata.search(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5260,10 +4440,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -5401,8 +4579,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.sheets.copyTo - * @desc Copies a single sheet from a spreadsheet to another spreadsheet. - * Returns the properties of the newly created sheet. + * @desc Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet. * @example * * // BEFORE RUNNING: * // --------------- @@ -5418,8 +4595,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet containing the sheet to copy. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The ID of the sheet to copy. * sheetId: 0, // TODO: Update placeholder value. @@ -5446,10 +4622,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -5567,16 +4741,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.append - * @desc Appends values to a spreadsheet. The input range is used to search - * for existing data and find a "table" within that range. Values will be - * appended to the next row of the table, starting with the first column of - * the table. See the [guide](/sheets/api/guides/values#appending_values) - * and [sample code](/sheets/api/samples/writing#append_values) for specific - * details of how tables are detected and data is appended. The caller must - * specify the spreadsheet ID, range, and a valueInputOption. The - * `valueInputOption` only controls how the input data will be added to the - * sheet (column-wise or row-wise), it does not influence what cell the data - * starts being written to. + * @desc Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. * @example * * // BEFORE RUNNING: * // --------------- @@ -5592,8 +4757,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to update. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The A1 notation of a range to search for a logical table of data. * // Values will be appended after the last row of the table. @@ -5624,10 +4788,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -5722,10 +4884,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.batchClear - * @desc Clears one or more ranges of values from a spreadsheet. The caller - * must specify the spreadsheet ID and one or more ranges. Only values are - * cleared -- all other properties of the cell (such as formatting, data - * validation, etc..) are kept. + * @desc Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. * @example * * // BEFORE RUNNING: * // --------------- @@ -5741,8 +4900,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to update. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // The ranges to clear, in A1 notation. @@ -5754,8 +4912,10 @@ export namespace sheets_v4 { * auth: authClient, * }; * - * sheets.spreadsheets.values.batchClear(request, function(err, response) - * { if (err) { console.error(err); return; + * sheets.spreadsheets.values.batchClear(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5764,10 +4924,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -5858,11 +5016,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.batchClearByDataFilter - * @desc Clears one or more ranges of values from a spreadsheet. The caller - * must specify the spreadsheet ID and one or more DataFilters. Ranges - * matching any of the specified data filters will be cleared. Only values - * are cleared -- all other properties of the cell (such as formatting, data - * validation, etc..) are kept. + * @desc Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. * @example * * // BEFORE RUNNING: * // --------------- @@ -5878,8 +5032,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to update. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // The DataFilters used to determine which ranges to clear. @@ -5891,8 +5044,10 @@ export namespace sheets_v4 { * auth: authClient, * }; * - * sheets.spreadsheets.values.batchClearByDataFilter(request, - * function(err, response) { if (err) { console.error(err); return; + * sheets.spreadsheets.values.batchClearByDataFilter(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -5901,10 +5056,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -6009,8 +5162,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.batchGet - * @desc Returns one or more ranges of values from a spreadsheet. The caller - * must specify the spreadsheet ID and one or more ranges. + * @desc Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. * @example * * // BEFORE RUNNING: * // --------------- @@ -6026,8 +5178,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to retrieve data from. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The A1 notation of the values to retrieve. * ranges: [], // TODO: Update placeholder value. @@ -6036,13 +5187,11 @@ export namespace sheets_v4 { * // The default render option is ValueRenderOption.FORMATTED_VALUE. * valueRenderOption: '', // TODO: Update placeholder value. * - * // How dates, times, and durations should be represented in the - * output. + * // How dates, times, and durations should be represented in the output. * // This is ignored if value_render_option is * // FORMATTED_VALUE. - * // The default dateTime render option is - * [DateTimeRenderOption.SERIAL_NUMBER]. dateTimeRenderOption: '', // TODO: - * Update placeholder value. + * // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + * dateTimeRenderOption: '', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -6059,10 +5208,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -6158,10 +5305,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.batchGetByDataFilter - * @desc Returns one or more ranges of values that match the specified data - * filters. The caller must specify the spreadsheet ID and one or more - * DataFilters. Ranges that match any of the data filters in the request - * will be returned. + * @desc Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned. * @example * * // BEFORE RUNNING: * // --------------- @@ -6177,28 +5321,23 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to retrieve data from. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // How values should be represented in the output. * // The default render option is ValueRenderOption.FORMATTED_VALUE. * valueRenderOption: '', // TODO: Update placeholder value. * - * // The data filters used to match the ranges of values to retrieve. - * Ranges - * // that match any of the specified data filters will be included in - * the + * // The data filters used to match the ranges of values to retrieve. Ranges + * // that match any of the specified data filters will be included in the * // response. * dataFilters: [], // TODO: Update placeholder value. * - * // How dates, times, and durations should be represented in the - * output. + * // How dates, times, and durations should be represented in the output. * // This is ignored if value_render_option is * // FORMATTED_VALUE. - * // The default dateTime render option is - * [DateTimeRenderOption.SERIAL_NUMBER]. dateTimeRenderOption: '', // TODO: - * Update placeholder value. + * // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + * dateTimeRenderOption: '', // TODO: Update placeholder value. * * // TODO: Add desired properties to the request body. * }, @@ -6206,8 +5345,10 @@ export namespace sheets_v4 { * auth: authClient, * }; * - * sheets.spreadsheets.values.batchGetByDataFilter(request, function(err, - * response) { if (err) { console.error(err); return; + * sheets.spreadsheets.values.batchGetByDataFilter(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6216,10 +5357,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -6316,9 +5455,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.batchUpdate - * @desc Sets values in one or more ranges of a spreadsheet. The caller must - * specify the spreadsheet ID, a valueInputOption, and one or more - * ValueRanges. + * @desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. * @example * * // BEFORE RUNNING: * // --------------- @@ -6334,8 +5471,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to update. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // How the input data should be interpreted. @@ -6350,8 +5486,10 @@ export namespace sheets_v4 { * auth: authClient, * }; * - * sheets.spreadsheets.values.batchUpdate(request, function(err, response) - * { if (err) { console.error(err); return; + * sheets.spreadsheets.values.batchUpdate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6360,10 +5498,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -6457,9 +5593,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.batchUpdateByDataFilter - * @desc Sets values in one or more ranges of a spreadsheet. The caller must - * specify the spreadsheet ID, a valueInputOption, and one or more - * DataFilterValueRanges. + * @desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. * @example * * // BEFORE RUNNING: * // --------------- @@ -6475,15 +5609,13 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to update. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * resource: { * // How the input data should be interpreted. * valueInputOption: '', // TODO: Update placeholder value. * - * // The new values to apply to the spreadsheet. If more than one - * range is + * // The new values to apply to the spreadsheet. If more than one range is * // matched by the specified DataFilter the specified values will be * // applied to all of those ranges. * data: [], // TODO: Update placeholder value. @@ -6494,8 +5626,10 @@ export namespace sheets_v4 { * auth: authClient, * }; * - * sheets.spreadsheets.values.batchUpdateByDataFilter(request, - * function(err, response) { if (err) { console.error(err); return; + * sheets.spreadsheets.values.batchUpdateByDataFilter(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -6504,10 +5638,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -6612,9 +5744,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.clear - * @desc Clears values from a spreadsheet. The caller must specify the - * spreadsheet ID and range. Only values are cleared -- all other properties - * of the cell (such as formatting, data validation, etc..) are kept. + * @desc Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. * @example * * // BEFORE RUNNING: * // --------------- @@ -6630,8 +5760,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to update. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The A1 notation of the values to clear. * range: 'my-range', // TODO: Update placeholder value. @@ -6655,10 +5784,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -6746,8 +5873,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.get - * @desc Returns a range of values from a spreadsheet. The caller must - * specify the spreadsheet ID and a range. + * @desc Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. * @example * * // BEFORE RUNNING: * // --------------- @@ -6763,8 +5889,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to retrieve data from. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The A1 notation of the values to retrieve. * range: 'my-range', // TODO: Update placeholder value. @@ -6773,13 +5898,11 @@ export namespace sheets_v4 { * // The default render option is ValueRenderOption.FORMATTED_VALUE. * valueRenderOption: '', // TODO: Update placeholder value. * - * // How dates, times, and durations should be represented in the - * output. + * // How dates, times, and durations should be represented in the output. * // This is ignored if value_render_option is * // FORMATTED_VALUE. - * // The default dateTime render option is - * [DateTimeRenderOption.SERIAL_NUMBER]. dateTimeRenderOption: '', // TODO: - * Update placeholder value. + * // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + * dateTimeRenderOption: '', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -6796,10 +5919,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -6891,8 +6012,7 @@ export namespace sheets_v4 { /** * sheets.spreadsheets.values.update - * @desc Sets values in a range of a spreadsheet. The caller must specify - * the spreadsheet ID, range, and a valueInputOption. + * @desc Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. * @example * * // BEFORE RUNNING: * // --------------- @@ -6908,8 +6028,7 @@ export namespace sheets_v4 { * authorize(function(authClient) { * var request = { * // The ID of the spreadsheet to update. - * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder - * value. + * spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value. * * // The A1 notation of the values to update. * range: 'my-range', // TODO: Update placeholder value. @@ -6918,8 +6037,7 @@ export namespace sheets_v4 { * valueInputOption: '', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -6938,10 +6056,8 @@ export namespace sheets_v4 { * }); * * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample + * // TODO: Change placeholder below to generate authentication credentials. See + * // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample * // * // Authorize using one of the following scopes: * // 'https://www.googleapis.com/auth/drive' @@ -7042,9 +6158,7 @@ export namespace sheets_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Determines if the update response should include the values of the cells - * that were appended. By default, responses do not include the updated - * values. + * Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. */ includeValuesInResponse?: boolean; /** @@ -7052,20 +6166,15 @@ export namespace sheets_v4 { */ insertDataOption?: string; /** - * The A1 notation of a range to search for a logical table of data. Values - * will be appended after the last row of the table. + * The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table. */ range?: string; /** - * Determines how dates, times, and durations in the response should be - * rendered. This is ignored if response_value_render_option is - * FORMATTED_VALUE. The default dateTime render option is - * [DateTimeRenderOption.SERIAL_NUMBER]. + * Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. */ responseDateTimeRenderOption?: string; /** - * Determines how values in the response should be rendered. The default - * render option is ValueRenderOption.FORMATTED_VALUE. + * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. */ responseValueRenderOption?: string; /** @@ -7124,17 +6233,11 @@ export namespace sheets_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * How dates, times, and durations should be represented in the output. This - * is ignored if value_render_option is FORMATTED_VALUE. The default - * dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + * How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. */ dateTimeRenderOption?: string; /** - * The major dimension that results should use. For example, if the - * spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting - * `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas - * requesting `range=A1:B2,majorDimension=COLUMNS` will return - * `[[1,3],[2,4]]`. + * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. */ majorDimension?: string; /** @@ -7146,8 +6249,7 @@ export namespace sheets_v4 { */ spreadsheetId?: string; /** - * How values should be represented in the output. The default render option - * is ValueRenderOption.FORMATTED_VALUE. + * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */ valueRenderOption?: string; } @@ -7231,17 +6333,11 @@ export namespace sheets_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * How dates, times, and durations should be represented in the output. This - * is ignored if value_render_option is FORMATTED_VALUE. The default - * dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + * How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. */ dateTimeRenderOption?: string; /** - * The major dimension that results should use. For example, if the - * spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting - * `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas - * requesting `range=A1:B2,majorDimension=COLUMNS` will return - * `[[1,3],[2,4]]`. + * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. */ majorDimension?: string; /** @@ -7253,8 +6349,7 @@ export namespace sheets_v4 { */ spreadsheetId?: string; /** - * How values should be represented in the output. The default render option - * is ValueRenderOption.FORMATTED_VALUE. + * How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */ valueRenderOption?: string; } @@ -7266,11 +6361,7 @@ export namespace sheets_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Determines if the update response should include the values of the cells - * that were updated. By default, responses do not include the updated - * values. If the range to write was larger than than the range actually - * written, the response will include all values in the requested range - * (excluding trailing empty rows and columns). + * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). */ includeValuesInResponse?: boolean; /** @@ -7278,15 +6369,11 @@ export namespace sheets_v4 { */ range?: string; /** - * Determines how dates, times, and durations in the response should be - * rendered. This is ignored if response_value_render_option is - * FORMATTED_VALUE. The default dateTime render option is - * DateTimeRenderOption.SERIAL_NUMBER. + * Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. */ responseDateTimeRenderOption?: string; /** - * Determines how values in the response should be rendered. The default - * render option is ValueRenderOption.FORMATTED_VALUE. + * Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. */ responseValueRenderOption?: string; /** diff --git a/src/apis/siteVerification/package.json b/src/apis/siteVerification/package.json index 44571d7849a..a5ebcb233b5 100644 --- a/src/apis/siteVerification/package.json +++ b/src/apis/siteVerification/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/siteVerification/v1.ts b/src/apis/siteVerification/v1.ts index 31bd22ba592..713ecf5537b 100644 --- a/src/apis/siteVerification/v1.ts +++ b/src/apis/siteVerification/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace siteVerification_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace siteVerification_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace siteVerification_v1 { webResource: Resource$Webresource; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.webResource = new Resource$Webresource(this.context); } @@ -107,24 +107,17 @@ export namespace siteVerification_v1 { */ site?: {identifier?: string; type?: string}; /** - * The verification method that will be used to verify this site. For sites, - * 'FILE' or 'META' methods may be used. For domains, only - * 'DNS' may be used. + * The verification method that will be used to verify this site. For sites, 'FILE' or 'META' methods may be used. For domains, only 'DNS' may be used. */ verificationMethod?: string; } export interface Schema$SiteVerificationWebResourceGettokenResponse { /** - * The verification method to use in conjunction with this token. For FILE, - * the token should be placed in the top-level directory of the site, stored - * inside a file of the same name. For META, the token should be placed in - * the HEAD tag of the default page that is loaded for the site. For DNS, - * the token should be placed in a TXT record of the domain. + * The verification method to use in conjunction with this token. For FILE, the token should be placed in the top-level directory of the site, stored inside a file of the same name. For META, the token should be placed in the HEAD tag of the default page that is loaded for the site. For DNS, the token should be placed in a TXT record of the domain. */ method?: string; /** - * The verification token. The token must be placed appropriately in order - * for verification to succeed. + * The verification token. The token must be placed appropriately in order for verification to succeed. */ token?: string; } @@ -136,9 +129,7 @@ export namespace siteVerification_v1 { } export interface Schema$SiteVerificationWebResourceResource { /** - * The string used to identify this site. This value should be used in the - * "id" portion of the REST URL for the Get, Update, and Delete - * operations. + * The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations. */ id?: string; /** @@ -589,8 +580,7 @@ export namespace siteVerification_v1 { /** * siteVerification.webResource.patch - * @desc Modify the list of owners for your website or domain. This method - * supports patch semantics. + * @desc Modify the list of owners for your website or domain. This method supports patch semantics. * @alias siteVerification.webResource.patch * @memberOf! () * diff --git a/src/apis/slides/package.json b/src/apis/slides/package.json index e85c806fbbc..acef35e7f4c 100644 --- a/src/apis/slides/package.json +++ b/src/apis/slides/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index cc4cd28f123..1658ab10369 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace slides_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace slides_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,19 +108,17 @@ export namespace slides_v1 { presentations: Resource$Presentations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.presentations = new Resource$Presentations(this.context); } } /** - * AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to - * transform source coordinates (x,y) into destination coordinates (x', - * y') according to: x' x = shear_y scale_y translate_y - * 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + - * translate_x; y' = scale_y * y + shear_y * x + translate_y; This - * message is therefore composed of these six matrix elements. + * AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. */ export interface Schema$AffineTransform { /** @@ -195,8 +189,7 @@ export namespace slides_v1 { */ presentationId?: string; /** - * The reply of the updates. This maps 1:1 with the updates, although - * replies to some requests may be empty. + * The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */ replies?: Schema$Response[]; /** @@ -239,8 +232,7 @@ export namespace slides_v1 { */ export interface Schema$ColorStop { /** - * The alpha value of this color in the gradient band. Defaults to 1.0, - * fully opaque. + * The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. */ alpha?: number; /** @@ -248,8 +240,7 @@ export namespace slides_v1 { */ color?: Schema$OpaqueColor; /** - * The relative position of the color stop in the gradient band measured in - * percentage. The value should be in the interval [0.0, 1.0]. + * The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. */ position?: number; } @@ -258,34 +249,15 @@ export namespace slides_v1 { */ export interface Schema$CreateImageRequest { /** - * The element properties for the image. When the aspect ratio of the - * provided size does not match the image aspect ratio, the image is scaled - * and centered with respect to the size in order to maintain aspect ratio. - * The provided transform is applied after this operation. The - * PageElementProperties.size property is optional. If you don't specify - * the size, the default size of the image is used. The - * PageElementProperties.transform property is optional. If you don't - * specify a transform, the image will be placed at the top left corner of - * the page. + * The element properties for the image. When the aspect ratio of the provided size does not match the image aspect ratio, the image is scaled and centered with respect to the size in order to maintain aspect ratio. The provided transform is applied after this operation. The PageElementProperties.size property is optional. If you don't specify the size, the default size of the image is used. The PageElementProperties.transform property is optional. If you don't specify a transform, the image will be placed at the top left corner of the page. */ elementProperties?: Schema$PageElementProperties; /** - * A user-supplied object ID. If you specify an ID, it must be unique among - * all pages and page elements in the presentation. The ID must start with - * an alphanumeric character or an underscore (matches regex - * `[a-zA-Z0-9_]`); remaining characters may include those as well as a - * hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID - * must not be less than 5 or greater than 50. If you don't specify an - * ID, a unique one is generated. + * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ objectId?: string; /** - * The image URL. The image is fetched once at insertion time and a copy is - * stored for display inside the presentation. Images must be less than 50MB - * in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or - * GIF format. The provided URL can be at most 2 kB in length. The URL - * itself is saved with the image, and exposed via the Image.source_url - * field. + * The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field. */ url?: string; } @@ -303,13 +275,7 @@ export namespace slides_v1 { */ export interface Schema$CreateLineRequest { /** - * The category of the line to be created. The exact line type created is - * determined based on the category and how it's routed to connect to - * other page elements. If you specify both a `category` and a - * `line_category`, the `category` takes precedence. If you do not specify - * a value for `category`, but specify a value for `line_category`, then the - * specified `line_category` value is used. If you do not specify either, - * then STRAIGHT is used. + * The category of the line to be created. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence. If you do not specify a value for `category`, but specify a value for `line_category`, then the specified `line_category` value is used. If you do not specify either, then STRAIGHT is used. */ category?: string; /** @@ -317,21 +283,11 @@ export namespace slides_v1 { */ elementProperties?: Schema$PageElementProperties; /** - * The category of the line to be created. <b>Deprecated</b>: - * use `category` instead. The exact line type created is determined based - * on the category and how it's routed to connect to other page - * elements. If you specify both a `category` and a `line_category`, the - * `category` takes precedence. + * The category of the line to be created. <b>Deprecated</b>: use `category` instead. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence. */ lineCategory?: string; /** - * A user-supplied object ID. If you specify an ID, it must be unique among - * all pages and page elements in the presentation. The ID must start with - * an alphanumeric character or an underscore (matches regex - * `[a-zA-Z0-9_]`); remaining characters may include those as well as a - * hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID - * must not be less than 5 or greater than 50. If you don't specify an - * ID, a unique one is generated. + * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ objectId?: string; } @@ -345,34 +301,23 @@ export namespace slides_v1 { objectId?: string; } /** - * Creates bullets for all of the paragraphs that overlap with the given text - * index range. The nesting level of each paragraph will be determined by - * counting leading tabs in front of each paragraph. To avoid excess space - * between the bullet and the corresponding paragraph, these leading tabs are - * removed by this request. This may change the indices of parts of the text. - * If the paragraph immediately before paragraphs being updated is in a list - * with a matching preset, the paragraphs being updated are added to that - * preceding list. + * Creates bullets for all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. */ export interface Schema$CreateParagraphBulletsRequest { /** - * The kinds of bullet glyphs to be used. Defaults to the - * `BULLET_DISC_CIRCLE_SQUARE` preset. + * The kinds of bullet glyphs to be used. Defaults to the `BULLET_DISC_CIRCLE_SQUARE` preset. */ bulletPreset?: string; /** - * The optional table cell location if the text to be modified is in a table - * cell. If present, the object_id must refer to a table. + * The optional table cell location if the text to be modified is in a table cell. If present, the object_id must refer to a table. */ cellLocation?: Schema$TableCellLocation; /** - * The object ID of the shape or table containing the text to add bullets - * to. + * The object ID of the shape or table containing the text to add bullets to. */ objectId?: string; /** - * The range of text to apply the bullet presets to, based on TextElement - * indexes. + * The range of text to apply the bullet presets to, based on TextElement indexes. */ textRange?: Schema$Range; } @@ -385,13 +330,7 @@ export namespace slides_v1 { */ elementProperties?: Schema$PageElementProperties; /** - * A user-supplied object ID. If you specify an ID, it must be unique among - * all pages and page elements in the presentation. The ID must start with - * an alphanumeric character or an underscore (matches regex - * `[a-zA-Z0-9_]`); remaining characters may include those as well as a - * hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID - * must not be less than 5 or greater than 50. If empty, a unique identifier - * will be generated. + * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If empty, a unique identifier will be generated. */ objectId?: string; /** @@ -409,9 +348,7 @@ export namespace slides_v1 { objectId?: string; } /** - * Creates an embedded Google Sheets chart. NOTE: Chart creation requires at - * least one of the spreadsheets.readonly, spreadsheets, drive.readonly, - * drive.file, or drive OAuth scopes. + * Creates an embedded Google Sheets chart. NOTE: Chart creation requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive.file, or drive OAuth scopes. */ export interface Schema$CreateSheetsChartRequest { /** @@ -419,24 +356,15 @@ export namespace slides_v1 { */ chartId?: number; /** - * The element properties for the chart. When the aspect ratio of the - * provided size does not match the chart aspect ratio, the chart is scaled - * and centered with respect to the size in order to maintain aspect ratio. - * The provided transform is applied after this operation. + * The element properties for the chart. When the aspect ratio of the provided size does not match the chart aspect ratio, the chart is scaled and centered with respect to the size in order to maintain aspect ratio. The provided transform is applied after this operation. */ elementProperties?: Schema$PageElementProperties; /** - * The mode with which the chart is linked to the source spreadsheet. When - * not specified, the chart will be an image that is not linked. + * The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked. */ linkingMode?: string; /** - * A user-supplied object ID. If specified, the ID must be unique among all - * pages and page elements in the presentation. The ID should start with a - * word character [a-zA-Z0-9_] and then followed by any number of the - * following characters [a-zA-Z0-9_-:]. The length of the ID should not be - * less than 5 or greater than 50. If empty, a unique identifier will be - * generated. + * A user-supplied object ID. If specified, the ID must be unique among all pages and page elements in the presentation. The ID should start with a word character [a-zA-Z0-9_] and then followed by any number of the following characters [a-zA-Z0-9_-:]. The length of the ID should not be less than 5 or greater than 50. If empty, a unique identifier will be generated. */ objectId?: string; /** @@ -458,35 +386,19 @@ export namespace slides_v1 { */ export interface Schema$CreateSlideRequest { /** - * The optional zero-based index indicating where to insert the slides. If - * you don't specify an index, the new slide is created at the end. + * The optional zero-based index indicating where to insert the slides. If you don't specify an index, the new slide is created at the end. */ insertionIndex?: number; /** - * A user-supplied object ID. If you specify an ID, it must be unique among - * all pages and page elements in the presentation. The ID must start with - * an alphanumeric character or an underscore (matches regex - * `[a-zA-Z0-9_]`); remaining characters may include those as well as a - * hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID - * must not be less than 5 or greater than 50. If you don't specify an - * ID, a unique one is generated. + * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ objectId?: string; /** - * An optional list of object ID mappings from the placeholder(s) on the - * layout to the placeholder(s) that will be created on the new slide from - * that specified layout. Can only be used when `slide_layout_reference` is - * specified. + * An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s) that will be created on the new slide from that specified layout. Can only be used when `slide_layout_reference` is specified. */ placeholderIdMappings?: Schema$LayoutPlaceholderIdMapping[]; /** - * Layout reference of the slide to be inserted, based on the *current - * master*, which is one of the following: - The master of the previous - * slide index. - The master of the first slide, if the insertion_index is - * zero. - The first master in the presentation, if there are no slides. If - * the LayoutReference is not found in the current master, a 400 bad request - * error is returned. If you don't specify a layout reference, then the - * new slide will use the predefined layout `BLANK`. + * Layout reference of the slide to be inserted, based on the *current master*, which is one of the following: - The master of the previous slide index. - The master of the first slide, if the insertion_index is zero. - The first master in the presentation, if there are no slides. If the LayoutReference is not found in the current master, a 400 bad request error is returned. If you don't specify a layout reference, then the new slide will use the predefined layout `BLANK`. */ slideLayoutReference?: Schema$LayoutReference; } @@ -508,21 +420,11 @@ export namespace slides_v1 { */ columns?: number; /** - * The element properties for the table. The table will be created at the - * provided size, subject to a minimum size. If no size is provided, the - * table will be automatically sized. Table transforms must have a scale of - * 1 and no shear components. If no transform is provided, the table will be - * centered on the page. + * The element properties for the table. The table will be created at the provided size, subject to a minimum size. If no size is provided, the table will be automatically sized. Table transforms must have a scale of 1 and no shear components. If no transform is provided, the table will be centered on the page. */ elementProperties?: Schema$PageElementProperties; /** - * A user-supplied object ID. If you specify an ID, it must be unique among - * all pages and page elements in the presentation. The ID must start with - * an alphanumeric character or an underscore (matches regex - * `[a-zA-Z0-9_]`); remaining characters may include those as well as a - * hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID - * must not be less than 5 or greater than 50. If you don't specify an - * ID, a unique one is generated. + * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ objectId?: string; /** @@ -540,36 +442,19 @@ export namespace slides_v1 { objectId?: string; } /** - * Creates a video. NOTE: Creating a video from Google Drive requires that - * the requesting app have at least one of the drive, drive.readonly, or - * drive.file OAuth scopes. + * Creates a video. NOTE: Creating a video from Google Drive requires that the requesting app have at least one of the drive, drive.readonly, or drive.file OAuth scopes. */ export interface Schema$CreateVideoRequest { /** - * The element properties for the video. The PageElementProperties.size - * property is optional. If you don't specify a size, a default size is - * chosen by the server. The PageElementProperties.transform property is - * optional. The transform must not have shear components. If you don't - * specify a transform, the video will be placed at the top left corner of - * the page. + * The element properties for the video. The PageElementProperties.size property is optional. If you don't specify a size, a default size is chosen by the server. The PageElementProperties.transform property is optional. The transform must not have shear components. If you don't specify a transform, the video will be placed at the top left corner of the page. */ elementProperties?: Schema$PageElementProperties; /** - * The video source's unique identifier for this video. e.g. For - * YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is - * 7U3axjORYZ0. For a Google Drive video - * https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID - * is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. + * The video source's unique identifier for this video. e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is 7U3axjORYZ0. For a Google Drive video https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. */ id?: string; /** - * A user-supplied object ID. If you specify an ID, it must be unique among - * all pages and page elements in the presentation. The ID must start with - * an alphanumeric character or an underscore (matches regex - * `[a-zA-Z0-9_]`); remaining characters may include those as well as a - * hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID - * must not be less than 5 or greater than 50. If you don't specify an - * ID, a unique one is generated. + * A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ objectId?: string; /** @@ -587,50 +472,27 @@ export namespace slides_v1 { objectId?: string; } /** - * The crop properties of an object enclosed in a container. For example, an - * Image. The crop properties is represented by the offsets of four edges - * which define a crop rectangle. The offsets are measured in percentage from - * the corresponding edges of the object's original bounding rectangle - * towards inside, relative to the object's original dimensions. - If the - * offset is in the interval (0, 1), the corresponding edge of crop rectangle - * is positioned inside of the object's original bounding rectangle. - If - * the offset is negative or greater than 1, the corresponding edge of crop - * rectangle is positioned outside of the object's original bounding - * rectangle. - If the left edge of the crop rectangle is on the right side of - * its right edge, the object will be flipped horizontally. - If the top edge - * of the crop rectangle is below its bottom edge, the object will be flipped - * vertically. - If all offsets and rotation angle is 0, the object is not - * cropped. After cropping, the content in the crop rectangle will be - * stretched to fit its container. + * The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. */ export interface Schema$CropProperties { /** - * The rotation angle of the crop window around its center, in radians. - * Rotation angle is applied after the offset. + * The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. */ angle?: number; /** - * The offset specifies the bottom edge of the crop rectangle that is - * located above the original bounding rectangle bottom edge, relative to - * the object's original height. + * The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. */ bottomOffset?: number; /** - * The offset specifies the left edge of the crop rectangle that is located - * to the right of the original bounding rectangle left edge, relative to - * the object's original width. + * The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. */ leftOffset?: number; /** - * The offset specifies the right edge of the crop rectangle that is located - * to the left of the original bounding rectangle right edge, relative to - * the object's original width. + * The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. */ rightOffset?: number; /** - * The offset specifies the top edge of the crop rectangle that is located - * below the original bounding rectangle top edge, relative to the - * object's original height. + * The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. */ topOffset?: number; } @@ -639,27 +501,20 @@ export namespace slides_v1 { */ export interface Schema$DeleteObjectRequest { /** - * The object ID of the page or page element to delete. If after a delete - * operation a group contains only 1 or no page elements, the group is also - * deleted. If a placeholder is deleted on a layout, any empty inheriting - * shapes are also deleted. + * The object ID of the page or page element to delete. If after a delete operation a group contains only 1 or no page elements, the group is also deleted. If a placeholder is deleted on a layout, any empty inheriting shapes are also deleted. */ objectId?: string; } /** - * Deletes bullets from all of the paragraphs that overlap with the given text - * index range. The nesting level of each paragraph will be visually - * preserved by adding indent to the start of the corresponding paragraph. + * Deletes bullets from all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. */ export interface Schema$DeleteParagraphBulletsRequest { /** - * The optional table cell location if the text to be modified is in a table - * cell. If present, the object_id must refer to a table. + * The optional table cell location if the text to be modified is in a table cell. If present, the object_id must refer to a table. */ cellLocation?: Schema$TableCellLocation; /** - * The object ID of the shape or table containing the text to delete bullets - * from. + * The object ID of the shape or table containing the text to delete bullets from. */ objectId?: string; /** @@ -672,10 +527,7 @@ export namespace slides_v1 { */ export interface Schema$DeleteTableColumnRequest { /** - * The reference table cell location from which a column will be deleted. - * The column this cell spans will be deleted. If this is a merged cell, - * multiple columns will be deleted. If no columns remain in the table after - * this deletion, the whole table is deleted. + * The reference table cell location from which a column will be deleted. The column this cell spans will be deleted. If this is a merged cell, multiple columns will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. */ cellLocation?: Schema$TableCellLocation; /** @@ -688,10 +540,7 @@ export namespace slides_v1 { */ export interface Schema$DeleteTableRowRequest { /** - * The reference table cell location from which a row will be deleted. The - * row this cell spans will be deleted. If this is a merged cell, multiple - * rows will be deleted. If no rows remain in the table after this deletion, - * the whole table is deleted. + * The reference table cell location from which a row will be deleted. The row this cell spans will be deleted. If this is a merged cell, multiple rows will be deleted. If no rows remain in the table after this deletion, the whole table is deleted. */ cellLocation?: Schema$TableCellLocation; /** @@ -704,8 +553,7 @@ export namespace slides_v1 { */ export interface Schema$DeleteTextRequest { /** - * The optional table cell location if the text is to be deleted from a - * table cell. If present, the object_id must refer to a table. + * The optional table cell location if the text is to be deleted from a table cell. If present, the object_id must refer to a table. */ cellLocation?: Schema$TableCellLocation; /** @@ -713,17 +561,7 @@ export namespace slides_v1 { */ objectId?: string; /** - * The range of text to delete, based on TextElement indexes. There is - * always an implicit newline character at the end of a shape's or table - * cell's text that cannot be deleted. `Range.Type.ALL` will use the - * correct bounds, but care must be taken when specifying explicit bounds - * for range types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the - * text is "ABC", followed by an implicit newline, then the - * maximum value is 2 for `text_range.start_index` and 3 for - * `text_range.end_index`. Deleting text that crosses a paragraph boundary - * may result in changes to paragraph styles and lists as the two paragraphs - * are merged. Ranges that include only one code unit of a surrogate pair - * are expanded to include both code units. + * The range of text to delete, based on TextElement indexes. There is always an implicit newline character at the end of a shape's or table cell's text that cannot be deleted. `Range.Type.ALL` will use the correct bounds, but care must be taken when specifying explicit bounds for range types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text is "ABC", followed by an implicit newline, then the maximum value is 2 for `text_range.start_index` and 3 for `text_range.end_index`. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles and lists as the two paragraphs are merged. Ranges that include only one code unit of a surrogate pair are expanded to include both code units. */ textRange?: Schema$Range; } @@ -741,10 +579,7 @@ export namespace slides_v1 { unit?: string; } /** - * Duplicates a slide or page element. When duplicating a slide, the - * duplicate slide will be created immediately following the specified slide. - * When duplicating a page element, the duplicate will be placed on the same - * page at the same position as the original. + * Duplicates a slide or page element. When duplicating a slide, the duplicate slide will be created immediately following the specified slide. When duplicating a page element, the duplicate will be placed on the same page at the same position as the original. */ export interface Schema$DuplicateObjectRequest { /** @@ -752,21 +587,7 @@ export namespace slides_v1 { */ objectId?: string; /** - * The object being duplicated may contain other objects, for example when - * duplicating a slide or a group page element. This map defines how the IDs - * of duplicated objects are generated: the keys are the IDs of the original - * objects and its values are the IDs that will be assigned to the - * corresponding duplicate object. The ID of the source object's - * duplicate may be specified in this map as well, using the same value of - * the `object_id` field as a key and the newly desired ID as the value. All - * keys must correspond to existing IDs in the presentation. All values must - * be unique in the presentation and must start with an alphanumeric - * character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining - * characters may include those as well as a hyphen or colon (matches regex - * `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or - * greater than 50. If any IDs of source objects are omitted from the map, - * a new random ID will be assigned. If the map is empty or unset, all - * duplicate objects will receive a new random ID. + * The object being duplicated may contain other objects, for example when duplicating a slide or a group page element. This map defines how the IDs of duplicated objects are generated: the keys are the IDs of the original objects and its values are the IDs that will be assigned to the corresponding duplicate object. The ID of the source object's duplicate may be specified in this map as well, using the same value of the `object_id` field as a key and the newly desired ID as the value. All keys must correspond to existing IDs in the presentation. All values must be unique in the presentation and must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or greater than 50. If any IDs of source objects are omitted from the map, a new random ID will be assigned. If the map is empty or unset, all duplicate objects will receive a new random ID. */ objectIds?: {[key: string]: string}; } @@ -784,32 +605,20 @@ export namespace slides_v1 { */ export interface Schema$Group { /** - * The collection of elements in the group. The minimum size of a group - * is 2. + * The collection of elements in the group. The minimum size of a group is 2. */ children?: Schema$PageElement[]; } /** - * Groups objects to create an object group. For example, groups PageElements - * to create a Group on the same page as all the children. + * Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children. */ export interface Schema$GroupObjectsRequest { /** - * The object IDs of the objects to group. Only page elements can be - * grouped. There should be at least two page elements on the same page that - * are not already in another group. Some page elements, such as videos, - * tables and placeholder shapes cannot be grouped. + * The object IDs of the objects to group. Only page elements can be grouped. There should be at least two page elements on the same page that are not already in another group. Some page elements, such as videos, tables and placeholder shapes cannot be grouped. */ childrenObjectIds?: string[]; /** - * A user-supplied object ID for the group to be created. If you specify an - * ID, it must be unique among all pages and page elements in the - * presentation. The ID must start with an alphanumeric character or an - * underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may - * include those as well as a hyphen or colon (matches regex - * `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or - * greater than 50. If you don't specify an ID, a unique one is - * generated. + * A user-supplied object ID for the group to be created. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ groupObjectId?: string; } @@ -827,10 +636,7 @@ export namespace slides_v1 { */ export interface Schema$Image { /** - * An URL to an image with a default lifetime of 30 minutes. This URL is - * tagged with the account of the requester. Anyone with the URL effectively - * accesses the image as the original requester. Access to the image may be - * lost if the presentation's sharing settings change. + * An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. */ contentUrl?: string; /** @@ -838,8 +644,7 @@ export namespace slides_v1 { */ imageProperties?: Schema$ImageProperties; /** - * The source URL is the URL used to insert the image. The source URL can be - * empty. + * The source URL is the URL used to insert the image. The source URL can be empty. */ sourceUrl?: string; } @@ -848,18 +653,15 @@ export namespace slides_v1 { */ export interface Schema$ImageProperties { /** - * The brightness effect of the image. The value should be in the interval - * [-1.0, 1.0], where 0 means no effect. This property is read-only. + * The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. */ brightness?: number; /** - * The contrast effect of the image. The value should be in the interval - * [-1.0, 1.0], where 0 means no effect. This property is read-only. + * The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. */ contrast?: number; /** - * The crop properties of the image. If not set, the image is not cropped. - * This property is read-only. + * The crop properties of the image. If not set, the image is not cropped. This property is read-only. */ cropProperties?: Schema$CropProperties; /** @@ -871,37 +673,28 @@ export namespace slides_v1 { */ outline?: Schema$Outline; /** - * The recolor effect of the image. If not set, the image is not recolored. - * This property is read-only. + * The recolor effect of the image. If not set, the image is not recolored. This property is read-only. */ recolor?: Schema$Recolor; /** - * The shadow of the image. If not set, the image has no shadow. This - * property is read-only. + * The shadow of the image. If not set, the image has no shadow. This property is read-only. */ shadow?: Schema$Shadow; /** - * The transparency effect of the image. The value should be in the interval - * [0.0, 1.0], where 0 means no effect and 1 means completely transparent. - * This property is read-only. + * The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. */ transparency?: number; } /** - * Inserts columns into a table. Other columns in the table will be resized - * to fit the new column. + * Inserts columns into a table. Other columns in the table will be resized to fit the new column. */ export interface Schema$InsertTableColumnsRequest { /** - * The reference table cell location from which columns will be inserted. A - * new column will be inserted to the left (or right) of the column where - * the reference cell is. If the reference cell is a merged cell, a new - * column will be inserted to the left (or right) of the merged cell. + * The reference table cell location from which columns will be inserted. A new column will be inserted to the left (or right) of the column where the reference cell is. If the reference cell is a merged cell, a new column will be inserted to the left (or right) of the merged cell. */ cellLocation?: Schema$TableCellLocation; /** - * Whether to insert new columns to the right of the reference cell - * location. - `True`: insert to the right. - `False`: insert to the left. + * Whether to insert new columns to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left. */ insertRight?: boolean; /** @@ -918,15 +711,11 @@ export namespace slides_v1 { */ export interface Schema$InsertTableRowsRequest { /** - * The reference table cell location from which rows will be inserted. A - * new row will be inserted above (or below) the row where the reference - * cell is. If the reference cell is a merged cell, a new row will be - * inserted above (or below) the merged cell. + * The reference table cell location from which rows will be inserted. A new row will be inserted above (or below) the row where the reference cell is. If the reference cell is a merged cell, a new row will be inserted above (or below) the merged cell. */ cellLocation?: Schema$TableCellLocation; /** - * Whether to insert new rows below the reference cell location. - `True`: - * insert below the cell. - `False`: insert above the cell. + * Whether to insert new rows below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell. */ insertBelow?: boolean; /** @@ -943,16 +732,11 @@ export namespace slides_v1 { */ export interface Schema$InsertTextRequest { /** - * The optional table cell location if the text is to be inserted into a - * table cell. If present, the object_id must refer to a table. + * The optional table cell location if the text is to be inserted into a table cell. If present, the object_id must refer to a table. */ cellLocation?: Schema$TableCellLocation; /** - * The index where the text will be inserted, in Unicode code units, based - * on TextElement indexes. The index is zero-based and is computed from the - * start of the string. The index may be adjusted to prevent insertions - * inside Unicode grapheme clusters. In these cases, the text will be - * inserted immediately after the grapheme cluster. + * The index where the text will be inserted, in Unicode code units, based on TextElement indexes. The index is zero-based and is computed from the start of the string. The index may be adjusted to prevent insertions inside Unicode grapheme clusters. In these cases, the text will be inserted immediately after the grapheme cluster. */ insertionIndex?: number; /** @@ -960,45 +744,24 @@ export namespace slides_v1 { */ objectId?: string; /** - * The text to be inserted. Inserting a newline character will implicitly - * create a new ParagraphMarker at that index. The paragraph style of the - * new paragraph will be copied from the paragraph at the current insertion - * index, including lists and bullets. Text styles for inserted text will - * be determined automatically, generally preserving the styling of - * neighboring text. In most cases, the text will be added to the TextRun - * that exists at the insertion index. Some control characters - * (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic - * Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out - * of the inserted text. + * The text to be inserted. Inserting a newline character will implicitly create a new ParagraphMarker at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text will be added to the TextRun that exists at the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. */ text?: string; } /** - * The user-specified ID mapping for a placeholder that will be created on a - * slide from a specified layout. + * The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout. */ export interface Schema$LayoutPlaceholderIdMapping { /** - * The placeholder on a layout that will be applied to a slide. Only type - * and index are needed. For example, a predefined `TITLE_AND_BODY` layout - * may usually have a TITLE placeholder with index 0 and a BODY placeholder - * with index 0. + * The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a predefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder with index 0 and a BODY placeholder with index 0. */ layoutPlaceholder?: Schema$Placeholder; /** - * The object ID of the placeholder on a layout that will be applied to a - * slide. + * The object ID of the placeholder on a layout that will be applied to a slide. */ layoutPlaceholderObjectId?: string; /** - * A user-supplied object ID for the placeholder identified above that to be - * created onto a slide. If you specify an ID, it must be unique among all - * pages and page elements in the presentation. The ID must start with an - * alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); - * remaining characters may include those as well as a hyphen or colon - * (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less - * than 5 or greater than 50. If you don't specify an ID, a unique one - * is generated. + * A user-supplied object ID for the placeholder identified above that to be created onto a slide. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated. */ objectId?: string; } @@ -1020,8 +783,7 @@ export namespace slides_v1 { name?: string; } /** - * Slide layout reference. This may reference either: - A predefined layout - - * One of the layouts in the presentation. + * Slide layout reference. This may reference either: - A predefined layout - One of the layouts in the presentation. */ export interface Schema$LayoutReference { /** @@ -1034,13 +796,11 @@ export namespace slides_v1 { predefinedLayout?: string; } /** - * A PageElement kind representing a non-connector line, straight connector, - * curved connector, or bent connector. + * A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector. */ export interface Schema$Line { /** - * The category of the line. It matches the `category` specified in - * CreateLineRequest, and can be updated with UpdateLineCategoryRequest. + * The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest. */ lineCategory?: string; /** @@ -1057,22 +817,11 @@ export namespace slides_v1 { */ export interface Schema$LineConnection { /** - * The object ID of the connected page element. Some page elements, such as - * groups, tables, and lines do not have connection sites and therefore - * cannot be connected to a connector line. + * The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. */ connectedObjectId?: string; /** - * The index of the connection site on the connected page element. In most - * cases, it corresponds to the predefined connection site index from the - * ECMA-376 standard. More information on those connection sites can be - * found in the description of the "cnx" attribute in - * section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text - * Geometries" of "Office Open XML File Formats-Fundamentals and - * Markup Language Reference", part 1 of [ECMA-376 5th edition] - * (http://www.ecma-international.org/publications/standards/Ecma-376.htm). - * The position of each connection site can also be viewed from Slides - * editor. + * The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. */ connectionSiteIndex?: number; } @@ -1086,8 +835,7 @@ export namespace slides_v1 { solidFill?: Schema$SolidFill; } /** - * The properties of the Line. When unset, these fields default to values - * that match the appearance of new lines created in the Slides editor. + * The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor. */ export interface Schema$LineProperties { /** @@ -1099,14 +847,11 @@ export namespace slides_v1 { */ endArrow?: string; /** - * The connection at the end of the line. If unset, there is no connection. - * Only lines with a Type indicating it is a "connector" can have - * an `end_connection`. + * The connection at the end of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have an `end_connection`. */ endConnection?: Schema$LineConnection; /** - * The fill of the line. The default line fill matches the defaults for new - * lines created in the Slides editor. + * The fill of the line. The default line fill matches the defaults for new lines created in the Slides editor. */ lineFill?: Schema$LineFill; /** @@ -1118,9 +863,7 @@ export namespace slides_v1 { */ startArrow?: string; /** - * The connection at the beginning of the line. If unset, there is no - * connection. Only lines with a Type indicating it is a - * "connector" can have a `start_connection`. + * The connection at the beginning of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have a `start_connection`. */ startConnection?: Schema$LineConnection; /** @@ -1133,18 +876,15 @@ export namespace slides_v1 { */ export interface Schema$Link { /** - * If set, indicates this is a link to the specific page in this - * presentation with this ID. A page with this ID may not exist. + * If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. */ pageObjectId?: string; /** - * If set, indicates this is a link to a slide in this presentation, - * addressed by its position. + * If set, indicates this is a link to a slide in this presentation, addressed by its position. */ relativeLink?: string; /** - * If set, indicates this is a link to the slide at this zero-based index in - * the presentation. There may not be a slide at this index. + * If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. */ slideIndex?: number; /** @@ -1153,9 +893,7 @@ export namespace slides_v1 { url?: string; } /** - * A List describes the look and feel of bullets belonging to paragraphs - * associated with a list. A paragraph that is part of a list has an implicit - * reference to that list's ID. + * A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. */ export interface Schema$List { /** @@ -1163,15 +901,12 @@ export namespace slides_v1 { */ listId?: string; /** - * A map of nesting levels to the properties of bullets at the associated - * level. A list has at most nine levels of nesting, so the possible values - * for the keys of this map are 0 through 8, inclusive. + * A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. */ nestingLevel?: {[key: string]: Schema$NestingLevel}; } /** - * The properties of Page that are only relevant for pages with page_type - * MASTER. + * The properties of Page that are only relevant for pages with page_type MASTER. */ export interface Schema$MasterProperties { /** @@ -1188,17 +923,12 @@ export namespace slides_v1 { */ objectId?: string; /** - * The table range specifying which cells of the table to merge. Any text - * in the cells being merged will be concatenated and stored in the - * upper-left ("head") cell of the range. If the range is - * non-rectangular (which can occur in some cases where the range covers - * cells that are already merged), a 400 bad request error is returned. + * The table range specifying which cells of the table to merge. Any text in the cells being merged will be concatenated and stored in the upper-left ("head") cell of the range. If the range is non-rectangular (which can occur in some cases where the range covers cells that are already merged), a 400 bad request error is returned. */ tableRange?: Schema$TableRange; } /** - * Contains properties describing the look and feel of a list bullet at a - * given level of nesting. + * Contains properties describing the look and feel of a list bullet at a given level of nesting. */ export interface Schema$NestingLevel { /** @@ -1207,17 +937,11 @@ export namespace slides_v1 { bulletStyle?: Schema$TextStyle; } /** - * The properties of Page that are only relevant for pages with page_type - * NOTES. + * The properties of Page that are only relevant for pages with page_type NOTES. */ export interface Schema$NotesProperties { /** - * The object ID of the shape on this notes page that contains the speaker - * notes for the corresponding slide. The actual shape may not always exist - * on the notes page. Inserting text using this object ID will automatically - * create the shape. In this case, the actual shape may have different - * object ID. The `GetPresentation` or `GetPage` action will always return - * the latest object ID. + * The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID. */ speakerNotesObjectId?: string; } @@ -1239,16 +963,12 @@ export namespace slides_v1 { */ export interface Schema$OptionalColor { /** - * If set, this will be used as an opaque color. If unset, this represents a - * transparent color. + * If set, this will be used as an opaque color. If unset, this represents a transparent color. */ opaqueColor?: Schema$OpaqueColor; } /** - * The outline of a PageElement. If these fields are unset, they may be - * inherited from a parent placeholder if it exists. If there is no parent, - * the fields will default to the value used for new page elements created in - * the Slides editor, which may depend on the page element kind. + * The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. */ export interface Schema$Outline { /** @@ -1260,11 +980,7 @@ export namespace slides_v1 { */ outlineFill?: Schema$OutlineFill; /** - * The outline property state. Updating the outline on a page element will - * implicitly update this field to `RENDERED`, unless another value is - * specified in the same request. To have no outline on a page element, set - * this field to `NOT_RENDERED`. In this case, any other outline fields set - * in the same request will be ignored. + * The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. */ propertyState?: string; /** @@ -1298,8 +1014,7 @@ export namespace slides_v1 { */ notesProperties?: Schema$NotesProperties; /** - * The object ID for this page. Object IDs used by Page and PageElement - * share the same namespace. + * The object ID for this page. Object IDs used by Page and PageElement share the same namespace. */ objectId?: string; /** @@ -1315,17 +1030,7 @@ export namespace slides_v1 { */ pageType?: string; /** - * The revision ID of the presentation containing this page. Can be used in - * update requests to assert that the presentation revision hasn't - * changed since the last read operation. Only populated if the user has - * edit access to the presentation. The format of the revision ID may - * change over time, so it should be treated opaquely. A returned revision - * ID is only guaranteed to be valid for 24 hours after it has been returned - * and cannot be shared across users. If the revision ID is unchanged - * between calls, then the presentation has not changed. Conversely, a - * changed ID (for the same presentation and user) usually means the - * presentation has been updated; however, a changed ID can also be due to - * internal factors such as ID format changes. + * The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */ revisionId?: string; /** @@ -1338,11 +1043,7 @@ export namespace slides_v1 { */ export interface Schema$PageBackgroundFill { /** - * The background fill property state. Updating the fill on a page will - * implicitly update this field to `RENDERED`, unless another value is - * specified in the same request. To have no fill on a page, set this field - * to `NOT_RENDERED`. In this case, any other fill fields set in the same - * request will be ignored. + * The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. */ propertyState?: string; /** @@ -1359,8 +1060,7 @@ export namespace slides_v1 { */ export interface Schema$PageElement { /** - * The description of the page element. Combined with title to display alt - * text. + * The description of the page element. Combined with title to display alt text. */ description?: string; /** @@ -1376,9 +1076,7 @@ export namespace slides_v1 { */ line?: Schema$Line; /** - * The object ID for this page element. Object IDs used by - * google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share - * the same namespace. + * The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace. */ objectId?: string; /** @@ -1386,8 +1084,7 @@ export namespace slides_v1 { */ shape?: Schema$Shape; /** - * A linked chart embedded from Google Sheets. Unlinked charts are - * represented as images. + * A linked chart embedded from Google Sheets. Unlinked charts are represented as images. */ sheetsChart?: Schema$SheetsChart; /** @@ -1399,18 +1096,11 @@ export namespace slides_v1 { */ table?: Schema$Table; /** - * The title of the page element. Combined with description to display alt - * text. + * The title of the page element. Combined with description to display alt text. */ title?: string; /** - * The transform of the page element. The visual appearance of the page - * element is determined by its absolute transform. To compute the absolute - * transform, preconcatenate a page element's transform with the - * transforms of all of its parent groups. If the page element is not in a - * group, its absolute transform is the same as the value in this field. The - * initial transform for the newly created Group is always the identity - * transform. + * The transform of the page element. The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field. The initial transform for the newly created Group is always the identity transform. */ transform?: Schema$AffineTransform; /** @@ -1423,9 +1113,7 @@ export namespace slides_v1 { wordArt?: Schema$WordArt; } /** - * Common properties for a page element. Note: When you initially create a - * PageElement, the API may modify the values of both `size` and `transform`, - * but the visual size will be unchanged. + * Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both `size` and `transform`, but the visual size will be unchanged. */ export interface Schema$PageElementProperties { /** @@ -1442,22 +1130,15 @@ export namespace slides_v1 { transform?: Schema$AffineTransform; } /** - * The properties of the Page. The page will inherit properties from the - * parent page. Depending on the page type the hierarchy is defined in either - * SlideProperties or LayoutProperties. + * The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties. */ export interface Schema$PageProperties { /** - * The color scheme of the page. If unset, the color scheme is inherited - * from a parent page. If the page has no parent, the color scheme uses a - * default Slides color scheme. This field is read-only. + * The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme. This field is read-only. */ colorScheme?: Schema$ColorScheme; /** - * The background fill of the page. If unset, the background fill is - * inherited from a parent page if it exists. If the page has no parent, - * then the background fill defaults to the corresponding fill in the Slides - * editor. + * The background fill of the page. If unset, the background fill is inherited from a parent page if it exists. If the page has no parent, then the background fill defaults to the corresponding fill in the Slides editor. */ pageBackgroundFill?: Schema$PageBackgroundFill; } @@ -1466,8 +1147,7 @@ export namespace slides_v1 { */ export interface Schema$ParagraphMarker { /** - * The bullet for this paragraph. If not present, the paragraph does not - * belong to a list. + * The bullet for this paragraph. If not present, the paragraph does not belong to a list. */ bullet?: Schema$Bullet; /** @@ -1476,15 +1156,7 @@ export namespace slides_v1 { style?: Schema$ParagraphStyle; } /** - * Styles that apply to a whole paragraph. If this text is contained in a - * shape with a parent placeholder, then these paragraph styles may be - * inherited from the parent. Which paragraph styles are inherited depend on - * the nesting level of lists: * A paragraph not in a list will inherit its - * paragraph style from the paragraph at the 0 nesting level of the list - * inside the parent placeholder. * A paragraph in a list will inherit its - * paragraph style from the paragraph at its corresponding nesting level of - * the list inside the parent placeholder. Inherited paragraph styles are - * represented as unset fields in this message. + * Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. */ export interface Schema$ParagraphStyle { /** @@ -1492,41 +1164,31 @@ export namespace slides_v1 { */ alignment?: string; /** - * The text direction of this paragraph. If unset, the value defaults to - * LEFT_TO_RIGHT since text direction is not inherited. + * The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. */ direction?: string; /** - * The amount indentation for the paragraph on the side that corresponds to - * the end of the text, based on the current text direction. If unset, the - * value is inherited from the parent. + * The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. */ indentEnd?: Schema$Dimension; /** - * The amount of indentation for the start of the first line of the - * paragraph. If unset, the value is inherited from the parent. + * The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. */ indentFirstLine?: Schema$Dimension; /** - * The amount indentation for the paragraph on the side that corresponds to - * the start of the text, based on the current text direction. If unset, the - * value is inherited from the parent. + * The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. */ indentStart?: Schema$Dimension; /** - * The amount of space between lines, as a percentage of normal, where - * normal is represented as 100.0. If unset, the value is inherited from the - * parent. + * The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. */ lineSpacing?: number; /** - * The amount of extra space above the paragraph. If unset, the value is - * inherited from the parent. + * The amount of extra space above the paragraph. If unset, the value is inherited from the parent. */ spaceAbove?: Schema$Dimension; /** - * The amount of extra space below the paragraph. If unset, the value is - * inherited from the parent. + * The amount of extra space below the paragraph. If unset, the value is inherited from the parent. */ spaceBelow?: Schema$Dimension; /** @@ -1539,14 +1201,11 @@ export namespace slides_v1 { */ export interface Schema$Placeholder { /** - * The index of the placeholder. If the same placeholder types are present - * in the same page, they would have different index values. + * The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. */ index?: number; /** - * The object ID of this shape's parent placeholder. If unset, the - * parent placeholder shape does not exist, so the shape does not inherit - * properties from any other shape. + * The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. */ parentObjectId?: string; /** @@ -1559,9 +1218,7 @@ export namespace slides_v1 { */ export interface Schema$Presentation { /** - * The layouts in the presentation. A layout is a template that determines - * how content is arranged and styled on the slides that inherit from that - * layout. + * The layouts in the presentation. A layout is a template that determines how content is arranged and styled on the slides that inherit from that layout. */ layouts?: Schema$Page[]; /** @@ -1569,25 +1226,11 @@ export namespace slides_v1 { */ locale?: string; /** - * The slide masters in the presentation. A slide master contains all common - * page elements and the common properties for a set of layouts. They serve - * three purposes: - Placeholder shapes on a master contain the default - * text styles and shape properties of all placeholder shapes on pages - * that use that master. - The master page properties define the common page - * properties inherited by its layouts. - Any other shapes on the master - * slide will appear on all slides using that master, regardless of their - * layout. + * The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts. They serve three purposes: - Placeholder shapes on a master contain the default text styles and shape properties of all placeholder shapes on pages that use that master. - The master page properties define the common page properties inherited by its layouts. - Any other shapes on the master slide will appear on all slides using that master, regardless of their layout. */ masters?: Schema$Page[]; /** - * The notes master in the presentation. It serves three purposes: - - * Placeholder shapes on a notes master contain the default text styles and - * shape properties of all placeholder shapes on notes pages. Specifically, - * a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a - * `BODY` placeholder shape contains the speaker notes. - The notes master - * page properties define the common page properties inherited by all - * notes pages. - Any other shapes on the notes master will appear on all - * notes pages. The notes master is read-only. + * The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master will appear on all notes pages. The notes master is read-only. */ notesMaster?: Schema$Page; /** @@ -1599,22 +1242,11 @@ export namespace slides_v1 { */ presentationId?: string; /** - * The revision ID of the presentation. Can be used in update requests to - * assert that the presentation revision hasn't changed since the last - * read operation. Only populated if the user has edit access to the - * presentation. The format of the revision ID may change over time, so it - * should be treated opaquely. A returned revision ID is only guaranteed to - * be valid for 24 hours after it has been returned and cannot be shared - * across users. If the revision ID is unchanged between calls, then the - * presentation has not changed. Conversely, a changed ID (for the same - * presentation and user) usually means the presentation has been updated; - * however, a changed ID can also be due to internal factors such as ID - * format changes. + * The revision ID of the presentation. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */ revisionId?: string; /** - * The slides in the presentation. A slide inherits properties from a slide - * layout. + * The slides in the presentation. A slide inherits properties from a slide layout. */ slides?: Schema$Page[]; /** @@ -1623,18 +1255,15 @@ export namespace slides_v1 { title?: string; } /** - * Specifies a contiguous range of an indexed collection, such as characters - * in text. + * Specifies a contiguous range of an indexed collection, such as characters in text. */ export interface Schema$Range { /** - * The optional zero-based index of the end of the collection. Required for - * `FIXED_RANGE` ranges. + * The optional zero-based index of the end of the collection. Required for `FIXED_RANGE` ranges. */ endIndex?: number; /** - * The optional zero-based index of the beginning of the collection. - * Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges. + * The optional zero-based index of the beginning of the collection. Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges. */ startIndex?: number; /** @@ -1647,24 +1276,16 @@ export namespace slides_v1 { */ export interface Schema$Recolor { /** - * The name of the recolor effect. The name is determined from the - * `recolor_stops` by matching the gradient against the colors in the - * page's current color scheme. This property is read-only. + * The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. */ name?: string; /** - * The recolor effect is represented by a gradient, which is a list of color - * stops. The colors in the gradient will replace the corresponding colors - * at the same position in the color palette and apply to the image. This - * property is read-only. + * The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. */ recolorStops?: Schema$ColorStop[]; } /** - * Refreshes an embedded Google Sheets chart by replacing it with the latest - * version of the chart from Google Sheets. NOTE: Refreshing charts requires - * at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or - * drive OAuth scopes. + * Refreshes an embedded Google Sheets chart by replacing it with the latest version of the chart from Google Sheets. NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes. */ export interface Schema$RefreshSheetsChartRequest { /** @@ -1673,45 +1294,27 @@ export namespace slides_v1 { objectId?: string; } /** - * Replaces all shapes that match the given criteria with the provided image. - * The images replacing the shapes are rectangular after being inserted into - * the presentation and do not take on the forms of the shapes. + * Replaces all shapes that match the given criteria with the provided image. The images replacing the shapes are rectangular after being inserted into the presentation and do not take on the forms of the shapes. */ export interface Schema$ReplaceAllShapesWithImageRequest { /** - * If set, this request will replace all of the shapes that contain the - * given text. + * If set, this request will replace all of the shapes that contain the given text. */ containsText?: Schema$SubstringMatchCriteria; /** - * The image replace method. If you specify both a `replace_method` and an - * `image_replace_method`, the `image_replace_method` takes precedence. If - * you do not specify a value for `image_replace_method`, but specify a - * value for `replace_method`, then the specified `replace_method` value is - * used. If you do not specify either, then CENTER_INSIDE is used. + * The image replace method. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence. If you do not specify a value for `image_replace_method`, but specify a value for `replace_method`, then the specified `replace_method` value is used. If you do not specify either, then CENTER_INSIDE is used. */ imageReplaceMethod?: string; /** - * The image URL. The image is fetched once at insertion time and a copy is - * stored for display inside the presentation. Images must be less than 50MB - * in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or - * GIF format. The provided URL can be at most 2 kB in length. The URL - * itself is saved with the image, and exposed via the Image.source_url - * field. + * The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field. */ imageUrl?: string; /** - * If non-empty, limits the matches to page elements only on the given - * pages. Returns a 400 bad request error if given the page object ID of a - * notes page or a notes master, or if a page with that object ID - * doesn't exist in the presentation. + * If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation. */ pageObjectIds?: string[]; /** - * The replace method. <b>Deprecated</b>: use - * `image_replace_method` instead. If you specify both a `replace_method` - * and an `image_replace_method`, the `image_replace_method` takes - * precedence. + * The replace method. <b>Deprecated</b>: use `image_replace_method` instead. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence. */ replaceMethod?: string; } @@ -1725,11 +1328,7 @@ export namespace slides_v1 { occurrencesChanged?: number; } /** - * Replaces all shapes that match the given criteria with the provided Google - * Sheets chart. The chart will be scaled and centered to fit within the - * bounds of the original shape. NOTE: Replacing shapes with a chart requires - * at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or - * drive OAuth scopes. + * Replaces all shapes that match the given criteria with the provided Google Sheets chart. The chart will be scaled and centered to fit within the bounds of the original shape. NOTE: Replacing shapes with a chart requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes. */ export interface Schema$ReplaceAllShapesWithSheetsChartRequest { /** @@ -1737,20 +1336,15 @@ export namespace slides_v1 { */ chartId?: number; /** - * The criteria that the shapes must match in order to be replaced. The - * request will replace all of the shapes that contain the given text. + * The criteria that the shapes must match in order to be replaced. The request will replace all of the shapes that contain the given text. */ containsText?: Schema$SubstringMatchCriteria; /** - * The mode with which the chart is linked to the source spreadsheet. When - * not specified, the chart will be an image that is not linked. + * The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked. */ linkingMode?: string; /** - * If non-empty, limits the matches to page elements only on the given - * pages. Returns a 400 bad request error if given the page object ID of a - * notes page or a notes master, or if a page with that object ID - * doesn't exist in the presentation. + * If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation. */ pageObjectIds?: string[]; /** @@ -1776,10 +1370,7 @@ export namespace slides_v1 { */ containsText?: Schema$SubstringMatchCriteria; /** - * If non-empty, limits the matches to page elements only on the given - * pages. Returns a 400 bad request error if given the page object ID of a - * notes master, or if a page with that object ID doesn't exist in the - * presentation. + * If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes master, or if a page with that object ID doesn't exist in the presentation. */ pageObjectIds?: string[]; /** @@ -1797,8 +1388,7 @@ export namespace slides_v1 { occurrencesChanged?: number; } /** - * Replaces an existing image with a new image. Replacing an image removes - * some image effects from the existing image. + * Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image. */ export interface Schema$ReplaceImageRequest { /** @@ -1810,12 +1400,7 @@ export namespace slides_v1 { */ imageReplaceMethod?: string; /** - * The URL of the new image. The image is fetched once at insertion time - * and a copy is stored for display inside the presentation. Images must be - * less than 50MB in size, cannot exceed 25 megapixels, and must be in one - * of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in - * length. The URL itself is saved with the image, and exposed via the - * Image.source_url field. + * The URL of the new image. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field. */ url?: string; } @@ -1920,8 +1505,7 @@ export namespace slides_v1 { */ replaceImage?: Schema$ReplaceImageRequest; /** - * Reroutes a line such that it's connected at the two closest - * connection sites on the connected page elements. + * Reroutes a line such that it's connected at the two closest connection sites on the connected page elements. */ rerouteLine?: Schema$RerouteLineRequest; /** @@ -1998,14 +1582,11 @@ export namespace slides_v1 { updateVideoProperties?: Schema$UpdateVideoPropertiesRequest; } /** - * Reroutes a line such that it's connected at the two closest connection - * sites on the connected page elements. + * Reroutes a line such that it's connected at the two closest connection sites on the connected page elements. */ export interface Schema$RerouteLineRequest { /** - * The object ID of the line to reroute. Only a line with a category - * indicating it is a "connector" can be rerouted. The start and - * end connections of the line must be on different page elements. + * The object ID of the line to reroute. Only a line with a category indicating it is a "connector" can be rerouted. The start and end connections of the line must be on different page elements. */ objectId?: string; } @@ -2054,8 +1635,7 @@ export namespace slides_v1 { */ replaceAllShapesWithImage?: Schema$ReplaceAllShapesWithImageResponse; /** - * The result of replacing all shapes matching some criteria with a Google - * Sheets chart. + * The result of replacing all shapes matching some criteria with a Google Sheets chart. */ replaceAllShapesWithSheetsChart?: Schema$ReplaceAllShapesWithSheetsChartResponse; /** @@ -2081,15 +1661,11 @@ export namespace slides_v1 { red?: number; } /** - * The shadow properties of a page element. If these fields are unset, they - * may be inherited from a parent placeholder if it exists. If there is no - * parent, the fields will default to the value used for new page elements - * created in the Slides editor, which may depend on the page element kind. + * The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. */ export interface Schema$Shadow { /** - * The alignment point of the shadow, that sets the origin for translate, - * scale and skew of the shadow. This property is read-only. + * The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. */ alignment?: string; /** @@ -2097,8 +1673,7 @@ export namespace slides_v1 { */ alpha?: number; /** - * The radius of the shadow blur. The larger the radius, the more diffuse - * the shadow becomes. + * The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. */ blurRadius?: Schema$Dimension; /** @@ -2106,21 +1681,15 @@ export namespace slides_v1 { */ color?: Schema$OpaqueColor; /** - * The shadow property state. Updating the shadow on a page element will - * implicitly update this field to `RENDERED`, unless another value is - * specified in the same request. To have no shadow on a page element, set - * this field to `NOT_RENDERED`. In this case, any other shadow fields set - * in the same request will be ignored. + * The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. */ propertyState?: string; /** - * Whether the shadow should rotate with the shape. This property is - * read-only. + * Whether the shadow should rotate with the shape. This property is read-only. */ rotateWithShape?: boolean; /** - * Transform that encodes the translate, scale, and skew of the shadow, - * relative to the alignment position. + * Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. */ transform?: Schema$AffineTransform; /** @@ -2129,15 +1698,11 @@ export namespace slides_v1 { type?: string; } /** - * A PageElement kind representing a generic shape that does not have a more - * specific classification. + * A PageElement kind representing a generic shape that does not have a more specific classification. */ export interface Schema$Shape { /** - * Placeholders are shapes that are inherit from corresponding placeholders - * on layouts and masters. If set, the shape is a placeholder shape and any - * inherited properties can be resolved by looking at the parent placeholder - * identified by the Placeholder.parent_object_id field. + * Placeholders are shapes that are inherit from corresponding placeholders on layouts and masters. If set, the shape is a placeholder shape and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. */ placeholder?: Schema$Placeholder; /** @@ -2158,11 +1723,7 @@ export namespace slides_v1 { */ export interface Schema$ShapeBackgroundFill { /** - * The background fill property state. Updating the fill on a shape will - * implicitly update this field to `RENDERED`, unless another value is - * specified in the same request. To have no fill on a shape, set this field - * to `NOT_RENDERED`. In this case, any other fill fields set in the same - * request will be ignored. + * The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. */ propertyState?: string; /** @@ -2171,43 +1732,27 @@ export namespace slides_v1 { solidFill?: Schema$SolidFill; } /** - * The properties of a Shape. If the shape is a placeholder shape as - * determined by the placeholder field, then these properties may be inherited - * from a parent placeholder shape. Determining the rendered value of the - * property depends on the corresponding property_state field value. + * The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. */ export interface Schema$ShapeProperties { /** - * The alignment of the content in the shape. If unspecified, the alignment - * is inherited from a parent placeholder if it exists. If the shape has no - * parent, the default alignment matches the alignment for new shapes - * created in the Slides editor. + * The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor. */ contentAlignment?: string; /** - * The hyperlink destination of the shape. If unset, there is no link. Links - * are not inherited from parent placeholders. + * The hyperlink destination of the shape. If unset, there is no link. Links are not inherited from parent placeholders. */ link?: Schema$Link; /** - * The outline of the shape. If unset, the outline is inherited from a - * parent placeholder if it exists. If the shape has no parent, then the - * default outline depends on the shape type, matching the defaults for new - * shapes created in the Slides editor. + * The outline of the shape. If unset, the outline is inherited from a parent placeholder if it exists. If the shape has no parent, then the default outline depends on the shape type, matching the defaults for new shapes created in the Slides editor. */ outline?: Schema$Outline; /** - * The shadow properties of the shape. If unset, the shadow is inherited - * from a parent placeholder if it exists. If the shape has no parent, then - * the default shadow matches the defaults for new shapes created in the - * Slides editor. This property is read-only. + * The shadow properties of the shape. If unset, the shadow is inherited from a parent placeholder if it exists. If the shape has no parent, then the default shadow matches the defaults for new shapes created in the Slides editor. This property is read-only. */ shadow?: Schema$Shadow; /** - * The background fill of the shape. If unset, the background fill is - * inherited from a parent placeholder if it exists. If the shape has no - * parent, then the default background fill depends on the shape type, - * matching the defaults for new shapes created in the Slides editor. + * The background fill of the shape. If unset, the background fill is inherited from a parent placeholder if it exists. If the shape has no parent, then the default background fill depends on the shape type, matching the defaults for new shapes created in the Slides editor. */ shapeBackgroundFill?: Schema$ShapeBackgroundFill; } @@ -2216,16 +1761,11 @@ export namespace slides_v1 { */ export interface Schema$SheetsChart { /** - * The ID of the specific chart in the Google Sheets spreadsheet that is - * embedded. + * The ID of the specific chart in the Google Sheets spreadsheet that is embedded. */ chartId?: number; /** - * The URL of an image of the embedded chart, with a default lifetime of 30 - * minutes. This URL is tagged with the account of the requester. Anyone - * with the URL effectively accesses the image as the original requester. - * Access to the image may be lost if the presentation's sharing - * settings change. + * The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. */ contentUrl?: string; /** @@ -2260,44 +1800,28 @@ export namespace slides_v1 { width?: Schema$Dimension; } /** - * The properties of Page that are only relevant for pages with page_type - * SLIDE. + * The properties of Page that are only relevant for pages with page_type SLIDE. */ export interface Schema$SlideProperties { /** - * The object ID of the layout that this slide is based on. This property is - * read-only. + * The object ID of the layout that this slide is based on. This property is read-only. */ layoutObjectId?: string; /** - * The object ID of the master that this slide is based on. This property is - * read-only. + * The object ID of the master that this slide is based on. This property is read-only. */ masterObjectId?: string; /** - * The notes page that this slide is associated with. It defines the visual - * appearance of a notes page when printing or exporting slides with speaker - * notes. A notes page inherits properties from the notes master. The - * placeholder shape with type BODY on the notes page contains the speaker - * notes for this slide. The ID of this shape is identified by the - * speakerNotesObjectId field. The notes page is read-only except for the - * text content and styles of the speaker notes shape. This property is - * read-only. + * The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. */ notesPage?: Schema$Page; } /** - * A solid color fill. The page or page element is filled entirely with the - * specified color value. If any field is unset, its value may be inherited - * from a parent placeholder if it exists. + * A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. */ export interface Schema$SolidFill { /** - * The fraction of this `color` that should be applied to the pixel. That - * is, the final pixel color is defined by the equation: pixel color = - * alpha * (color) + (1.0 - alpha) * (background color) This means that a - * value of 1.0 corresponds to a solid color, whereas a value of 0.0 - * corresponds to a completely transparent color. + * The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. */ alpha?: number; /** @@ -2306,20 +1830,11 @@ export namespace slides_v1 { color?: Schema$OpaqueColor; } /** - * The stretched picture fill. The page or page element is filled entirely - * with the specified picture. The picture is stretched to fit its container. + * The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container. */ export interface Schema$StretchedPictureFill { /** - * Reading the content_url: An URL to a picture with a default lifetime of - * 30 minutes. This URL is tagged with the account of the requester. Anyone - * with the URL effectively accesses the picture as the original requester. - * Access to the picture may be lost if the presentation's sharing - * settings change. Writing the content_url: The picture is fetched once - * at insertion time and a copy is stored for display inside the - * presentation. Pictures must be less than 50MB in size, cannot exceed 25 - * megapixels, and must be in one of PNG, JPEG, or GIF format. The provided - * URL can be at most 2 kB in length. + * Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. */ contentUrl?: string; /** @@ -2332,8 +1847,7 @@ export namespace slides_v1 { */ export interface Schema$SubstringMatchCriteria { /** - * Indicates whether the search should respect case: - `True`: the search - * is case sensitive. - `False`: the search is case insensitive. + * Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive. */ matchCase?: boolean; /** @@ -2350,11 +1864,7 @@ export namespace slides_v1 { */ columns?: number; /** - * Properties of horizontal cell borders. A table's horizontal cell - * borders are represented as a grid. The grid has one more row than the - * number of rows in the table and the same number of columns as the table. - * For example, if the table is 3 x 3, its horizontal borders will be - * represented as a grid with 4 rows and 3 columns. + * Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns. */ horizontalBorderRows?: Schema$TableBorderRow[]; /** @@ -2366,16 +1876,11 @@ export namespace slides_v1 { */ tableColumns?: Schema$TableColumnProperties[]; /** - * Properties and contents of each row. Cells that span multiple rows are - * contained in only one of these rows and have a row_span greater than 1. + * Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1. */ tableRows?: Schema$TableRow[]; /** - * Properties of vertical cell borders. A table's vertical cell borders - * are represented as a grid. The grid has the same number of rows as the - * table and one more column than the number of columns in the table. For - * example, if the table is 3 x 3, its vertical borders will be represented - * as a grid with 3 rows and 4 columns. + * Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns. */ verticalBorderRows?: Schema$TableBorderRow[]; } @@ -2423,8 +1928,7 @@ export namespace slides_v1 { */ export interface Schema$TableBorderRow { /** - * Properties of each border cell. When a border's adjacent table cells - * are merged, it is not included in the response. + * Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. */ tableBorderCells?: Schema$TableBorderCell[]; } @@ -2458,11 +1962,7 @@ export namespace slides_v1 { */ export interface Schema$TableCellBackgroundFill { /** - * The background fill property state. Updating the fill on a table cell - * will implicitly update this field to `RENDERED`, unless another value is - * specified in the same request. To have no fill on a table cell, set this - * field to `NOT_RENDERED`. In this case, any other fill fields set in the - * same request will be ignored. + * The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. */ propertyState?: string; /** @@ -2488,13 +1988,11 @@ export namespace slides_v1 { */ export interface Schema$TableCellProperties { /** - * The alignment of the content in the table cell. The default alignment - * matches the alignment for newly created table cells in the Slides editor. + * The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor. */ contentAlignment?: string; /** - * The background fill of the table cell. The default fill matches the fill - * for newly created table cells in the Slides editor. + * The background fill of the table cell. The default fill matches the fill for newly created table cells in the Slides editor. */ tableCellBackgroundFill?: Schema$TableCellBackgroundFill; } @@ -2508,13 +2006,7 @@ export namespace slides_v1 { columnWidth?: Schema$Dimension; } /** - * A table range represents a reference to a subset of a table. It's - * important to note that the cells specified by a table range do not - * necessarily form a rectangle. For example, let's say we have a 3 x 3 - * table where all the cells of the last row are merged together. The table - * looks like this: [ ] A table range with - * location = (0, 0), row span = 3 and column span = 2 specifies the following - * cells: x x [ x x x ] + * A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ] */ export interface Schema$TableRange { /** @@ -2539,10 +2031,7 @@ export namespace slides_v1 { */ rowHeight?: Schema$Dimension; /** - * Properties and contents of each cell. Cells that span multiple columns - * are represented only once with a column_span greater than 1. As a result, - * the length of this collection does not always match the number of columns - * of the entire table. + * Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table. */ tableCells?: Schema$TableCell[]; /** @@ -2555,15 +2044,12 @@ export namespace slides_v1 { */ export interface Schema$TableRowProperties { /** - * Minimum height of the row. The row will be rendered in the Slides editor - * at a height equal to or greater than this value in order to show all the - * text in the row's cell(s). + * Minimum height of the row. The row will be rendered in the Slides editor at a height equal to or greater than this value in order to show all the text in the row's cell(s). */ minRowHeight?: Schema$Dimension; } /** - * The general text content. The text must reside in a compatible shape (e.g. - * text box or rectangle) or a table cell in a page. + * The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. */ export interface Schema$TextContent { /** @@ -2571,32 +2057,24 @@ export namespace slides_v1 { */ lists?: {[key: string]: Schema$List}; /** - * The text contents broken down into its component parts, including styling - * information. This property is read-only. + * The text contents broken down into its component parts, including styling information. This property is read-only. */ textElements?: Schema$TextElement[]; } /** - * A TextElement describes the content of a range of indices in the text - * content of a Shape or TableCell. + * A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. */ export interface Schema$TextElement { /** - * A TextElement representing a spot in the text that is dynamically - * replaced with content that can change over time. + * A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. */ autoText?: Schema$AutoText; /** - * The zero-based end index of this text element, exclusive, in Unicode code - * units. + * The zero-based end index of this text element, exclusive, in Unicode code units. */ endIndex?: number; /** - * A marker representing the beginning of a new paragraph. The - * `start_index` and `end_index` of this TextElement represent the range of - * the paragraph. Other TextElements with an index range contained inside - * this paragraph's range are considered to be part of this paragraph. - * The range of indices of two separate paragraphs will never overlap. + * A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. */ paragraphMarker?: Schema$ParagraphMarker; /** @@ -2604,17 +2082,12 @@ export namespace slides_v1 { */ startIndex?: number; /** - * A TextElement representing a run of text where all of the characters in - * the run have the same TextStyle. The `start_index` and `end_index` of - * TextRuns will always be fully contained in the index range of a single - * `paragraph_marker` TextElement. In other words, a TextRun will never span - * multiple paragraphs. + * A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. */ textRun?: Schema$TextRun; } /** - * A TextElement kind that represents a run of text that all has the same - * styling. + * A TextElement kind that represents a run of text that all has the same styling. */ export interface Schema$TextRun { /** @@ -2627,31 +2100,15 @@ export namespace slides_v1 { style?: Schema$TextStyle; } /** - * Represents the styling that can be applied to a TextRun. If this text is - * contained in a shape with a parent placeholder, then these text styles may - * be inherited from the parent. Which text styles are inherited depend on the - * nesting level of lists: * A text run in a paragraph that is not in a list - * will inherit its text style from the the newline character in the - * paragraph at the 0 nesting level of the list inside the parent - * placeholder. * A text run in a paragraph that is in a list will inherit its - * text style from the newline character in the paragraph at its - * corresponding nesting level of the list inside the parent placeholder. - * Inherited text styles are represented as unset fields in this message. If - * text is contained in a shape without a parent placeholder, unsetting these - * fields will revert the style to a value matching the defaults in the Slides - * editor. + * Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. */ export interface Schema$TextStyle { /** - * The background color of the text. If set, the color is either opaque or - * transparent, depending on if the `opaque_color` field in it is set. + * The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. */ backgroundColor?: Schema$OptionalColor; /** - * The text's vertical offset from its normal position. Text with - * `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered - * in a smaller font size, computed based on the `font_size` field. The - * `font_size` itself is not affected by changes in this field. + * The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. */ baselineOffset?: string; /** @@ -2659,22 +2116,15 @@ export namespace slides_v1 { */ bold?: boolean; /** - * The font family of the text. The font family can be any font from the - * Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). - * If the font name is unrecognized, the text is rendered in `Arial`. Some - * fonts can affect the weight of the text. If an update request specifies - * values for both `font_family` and `bold`, the explicitly-set `bold` value - * is used. + * The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. */ fontFamily?: string; /** - * The size of the text's font. When read, the `font_size` will - * specified in points. + * The size of the text's font. When read, the `font_size` will specified in points. */ fontSize?: Schema$Dimension; /** - * The color of the text itself. If set, the color is either opaque or - * transparent, depending on if the `opaque_color` field in it is set. + * The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. */ foregroundColor?: Schema$OptionalColor; /** @@ -2682,22 +2132,7 @@ export namespace slides_v1 { */ italic?: boolean; /** - * The hyperlink destination of the text. If unset, there is no link. Links - * are not inherited from parent text. Changing the link in an update - * request causes some other changes to the text style of the range: * When - * setting a link, the text foreground color will be set to - * ThemeColorType.HYPERLINK and the text will be underlined. If these - * fields are modified in the same request, those values will be used - * instead of the link defaults. * Setting a link on a text range that - * overlaps with an existing link will also update the existing link to - * point to the new URL. * Links are not settable on newline characters. As - * a result, setting a link on a text range that crosses a paragraph - * boundary, such as `"ABCx/123"`, will separate the newline - * character(s) into their own text runs. The link will be applied - * separately to the runs before and after the newline. * Removing a link - * will update the text style of the range to match the style of the - * preceding text (or the default text styles if the preceding text is - * another link) unless different styles are being set in the same request. + * The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABCx/123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. */ link?: Schema$Link; /** @@ -2713,28 +2148,7 @@ export namespace slides_v1 { */ underline?: boolean; /** - * The font family and rendered weight of the text. This field is an - * extension of `font_family` meant to support explicit font weights without - * breaking backwards compatibility. As such, when reading the style of a - * range of text, the value of `weighted_font_family#font_family` will - * always be equal to that of `font_family`. However, when writing, if both - * fields are included in the field mask (either explicitly or through the - * wildcard `"*"`), their values are reconciled as follows: * If - * `font_family` is set and `weighted_font_family` is not, the value of - * `font_family` is applied with weight `400` ("normal"). * If - * both fields are set, the value of `font_family` must match that of - * `weighted_font_family#font_family`. If so, the font family and weight of - * `weighted_font_family` is applied. Otherwise, a 400 bad request error is - * returned. * If `weighted_font_family` is set and `font_family` is not, - * the font family and weight of `weighted_font_family` is applied. * If - * neither field is set, the font family and weight of the text inherit from - * the parent. Note that these properties cannot inherit separately from - * each other. If an update request specifies values for both - * `weighted_font_family` and `bold`, the `weighted_font_family` is applied - * first, then `bold`. If `weighted_font_family#weight` is not set, it - * defaults to `400`. If `weighted_font_family` is set, then - * `weighted_font_family#font_family` must also be set with a non-empty - * value. Otherwise, a 400 bad request error is returned. + * The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. */ weightedFontFamily?: Schema$WeightedFontFamily; } @@ -2756,13 +2170,7 @@ export namespace slides_v1 { */ export interface Schema$Thumbnail { /** - * The content URL of the thumbnail image. The URL to the image has a - * default lifetime of 30 minutes. This URL is tagged with the account of - * the requester. Anyone with the URL effectively accesses the image as the - * original requester. Access to the image may be lost if the - * presentation's sharing settings change. The mime type of the - * thumbnail image is the same as specified in the - * `GetPageThumbnailRequest`. + * The content URL of the thumbnail image. The URL to the image has a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. The mime type of the thumbnail image is the same as specified in the `GetPageThumbnailRequest`. */ contentUrl?: string; /** @@ -2779,10 +2187,7 @@ export namespace slides_v1 { */ export interface Schema$UngroupObjectsRequest { /** - * The object IDs of the objects to ungroup. Only groups that are not - * inside other groups can be ungrouped. All the groups should be on the - * same page. The group itself is deleted. The visual sizes and positions of - * all the children are preserved. + * The object IDs of the objects to ungroup. Only groups that are not inside other groups can be ungrouped. All the groups should be on the same page. The group itself is deleted. The visual sizes and positions of all the children are preserved. */ objectIds?: string[]; } @@ -2795,12 +2200,7 @@ export namespace slides_v1 { */ objectId?: string; /** - * The table range specifying which cells of the table to unmerge. All - * merged cells in this range will be unmerged, and cells that are already - * unmerged will not be affected. If the range has no merged cells, the - * request will do nothing. If there is text in any of the merged cells, the - * text will remain in the upper-left ("head") cell of the - * resulting block of unmerged cells. + * The table range specifying which cells of the table to unmerge. All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing. If there is text in any of the merged cells, the text will remain in the upper-left ("head") cell of the resulting block of unmerged cells. */ tableRange?: Schema$TableRange; } @@ -2809,13 +2209,7 @@ export namespace slides_v1 { */ export interface Schema$UpdateImagePropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `imageProperties` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. - * For example to update the image outline color, set `fields` to - * `"outline.outlineFill.solidFill.color"`. To reset a property - * to its default value, include its field name in the field mask but leave - * the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `imageProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the image outline color, set `fields` to `"outline.outlineFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -2832,15 +2226,11 @@ export namespace slides_v1 { */ export interface Schema$UpdateLineCategoryRequest { /** - * The line category to update to. The exact line type is determined based - * on the category to update to and how it's routed to connect to other - * page elements. + * The line category to update to. The exact line type is determined based on the category to update to and how it's routed to connect to other page elements. */ lineCategory?: string; /** - * The object ID of the line the update is applied to. Only a line with a - * category indicating it is a "connector" can be updated. The - * line may be rerouted after updating its category. + * The object ID of the line the update is applied to. Only a line with a category indicating it is a "connector" can be updated. The line may be rerouted after updating its category. */ objectId?: string; } @@ -2849,13 +2239,7 @@ export namespace slides_v1 { */ export interface Schema$UpdateLinePropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `lineProperties` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. - * For example to update the line solid fill color, set `fields` to - * `"lineFill.solidFill.color"`. To reset a property to its - * default value, include its field name in the field mask but leave the - * field itself unset. + * The fields that should be updated. At least one field must be specified. The root `lineProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the line solid fill color, set `fields` to `"lineFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -2872,10 +2256,7 @@ export namespace slides_v1 { */ export interface Schema$UpdatePageElementAltTextRequest { /** - * The updated alt text description of the page element. If unset the - * existing value will be maintained. The description is exposed to screen - * readers and other accessibility interfaces. Only use human readable - * values related to the content of the page element. + * The updated alt text description of the page element. If unset the existing value will be maintained. The description is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element. */ description?: string; /** @@ -2883,36 +2264,25 @@ export namespace slides_v1 { */ objectId?: string; /** - * The updated alt text title of the page element. If unset the existing - * value will be maintained. The title is exposed to screen readers and - * other accessibility interfaces. Only use human readable values related to - * the content of the page element. + * The updated alt text title of the page element. If unset the existing value will be maintained. The title is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element. */ title?: string; } /** - * Updates the Z-order of page elements. Z-order is an ordering of the - * elements on the page from back to front. The page element in the front may - * cover the elements that are behind it. + * Updates the Z-order of page elements. Z-order is an ordering of the elements on the page from back to front. The page element in the front may cover the elements that are behind it. */ export interface Schema$UpdatePageElementsZOrderRequest { /** - * The Z-order operation to apply on the page elements. When applying the - * operation on multiple page elements, the relative Z-orders within these - * page elements before the operation is maintained. + * The Z-order operation to apply on the page elements. When applying the operation on multiple page elements, the relative Z-orders within these page elements before the operation is maintained. */ operation?: string; /** - * The object IDs of the page elements to update. All the page elements - * must be on the same page and must not be grouped. + * The object IDs of the page elements to update. All the page elements must be on the same page and must not be grouped. */ pageElementObjectIds?: string[]; } /** - * Updates the transform of a page element. Updating the transform of a group - * will change the absolute transform of the page elements in that group, - * which can change their visual appearance. See the documentation for - * PageElement.transform for more details. + * Updates the transform of a page element. Updating the transform of a group will change the absolute transform of the page elements in that group, which can change their visual appearance. See the documentation for PageElement.transform for more details. */ export interface Schema$UpdatePageElementTransformRequest { /** @@ -2933,13 +2303,7 @@ export namespace slides_v1 { */ export interface Schema$UpdatePagePropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `pageProperties` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. - * For example to update the page background solid fill color, set `fields` - * to `"pageBackgroundFill.solidFill.color"`. To reset a property - * to its default value, include its field name in the field mask but leave - * the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `pageProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the page background solid fill color, set `fields` to `"pageBackgroundFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -2952,24 +2316,15 @@ export namespace slides_v1 { pageProperties?: Schema$PageProperties; } /** - * Updates the styling for all of the paragraphs within a Shape or Table that - * overlap with the given text index range. + * Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range. */ export interface Schema$UpdateParagraphStyleRequest { /** - * The location of the cell in the table containing the paragraph(s) to - * style. If `object_id` refers to a table, `cell_location` must have a - * value. Otherwise, it must not. + * The location of the cell in the table containing the paragraph(s) to style. If `object_id` refers to a table, `cell_location` must have a value. Otherwise, it must not. */ cellLocation?: Schema$TableCellLocation; /** - * The fields that should be updated. At least one field must be specified. - * The root `style` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. For - * example, to update the paragraph alignment, set `fields` to - * `"alignment"`. To reset a property to its default value, - * include its field name in the field mask but leave the field itself - * unset. + * The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the paragraph alignment, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -2990,13 +2345,7 @@ export namespace slides_v1 { */ export interface Schema$UpdateShapePropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `shapeProperties` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. - * For example to update the shape background solid fill color, set `fields` - * to `"shapeBackgroundFill.solidFill.color"`. To reset a - * property to its default value, include its field name in the field mask - * but leave the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `shapeProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the shape background solid fill color, set `fields` to `"shapeBackgroundFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -3013,15 +2362,11 @@ export namespace slides_v1 { */ export interface Schema$UpdateSlidesPositionRequest { /** - * The index where the slides should be inserted, based on the slide - * arrangement before the move takes place. Must be between zero and the - * number of slides in the presentation, inclusive. + * The index where the slides should be inserted, based on the slide arrangement before the move takes place. Must be between zero and the number of slides in the presentation, inclusive. */ insertionIndex?: number; /** - * The IDs of the slides in the presentation that should be moved. The - * slides in this list must be in existing presentation order, without - * duplicates. + * The IDs of the slides in the presentation that should be moved. The slides in this list must be in existing presentation order, without duplicates. */ slideObjectIds?: string[]; } @@ -3030,19 +2375,11 @@ export namespace slides_v1 { */ export interface Schema$UpdateTableBorderPropertiesRequest { /** - * The border position in the table range the updates should apply to. If a - * border position is not specified, the updates will apply to all borders - * in the table range. + * The border position in the table range the updates should apply to. If a border position is not specified, the updates will apply to all borders in the table range. */ borderPosition?: string; /** - * The fields that should be updated. At least one field must be specified. - * The root `tableBorderProperties` is implied and should not be specified. - * A single `"*"` can be used as short-hand for listing every - * field. For example to update the table border solid fill color, set - * `fields` to `"tableBorderFill.solidFill.color"`. To reset a - * property to its default value, include its field name in the field mask - * but leave the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `tableBorderProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the table border solid fill color, set `fields` to `"tableBorderFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -3054,9 +2391,7 @@ export namespace slides_v1 { */ tableBorderProperties?: Schema$TableBorderProperties; /** - * The table range representing the subset of the table to which the updates - * are applied. If a table range is not specified, the updates will apply to - * the entire table. + * The table range representing the subset of the table to which the updates are applied. If a table range is not specified, the updates will apply to the entire table. */ tableRange?: Schema$TableRange; } @@ -3065,13 +2400,7 @@ export namespace slides_v1 { */ export interface Schema$UpdateTableCellPropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `tableCellProperties` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. - * For example to update the table cell background solid fill color, set - * `fields` to `"tableCellBackgroundFill.solidFill.color"`. To - * reset a property to its default value, include its field name in the - * field mask but leave the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `tableCellProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the table cell background solid fill color, set `fields` to `"tableCellBackgroundFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -3083,9 +2412,7 @@ export namespace slides_v1 { */ tableCellProperties?: Schema$TableCellProperties; /** - * The table range representing the subset of the table to which the updates - * are applied. If a table range is not specified, the updates will apply to - * the entire table. + * The table range representing the subset of the table to which the updates are applied. If a table range is not specified, the updates will apply to the entire table. */ tableRange?: Schema$TableRange; } @@ -3094,18 +2421,11 @@ export namespace slides_v1 { */ export interface Schema$UpdateTableColumnPropertiesRequest { /** - * The list of zero-based indices specifying which columns to update. If no - * indices are provided, all columns in the table will be updated. + * The list of zero-based indices specifying which columns to update. If no indices are provided, all columns in the table will be updated. */ columnIndices?: number[]; /** - * The fields that should be updated. At least one field must be specified. - * The root `tableColumnProperties` is implied and should not be specified. - * A single `"*"` can be used as short-hand for listing every - * field. For example to update the column width, set `fields` to - * `"column_width"`. If '"column_width"' is - * included in the field mask but the property is left unset, the column - * width will default to 406,400 EMU (32 points). + * The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `"column_width"`. If '"column_width"' is included in the field mask but the property is left unset, the column width will default to 406,400 EMU (32 points). */ fields?: string; /** @@ -3113,9 +2433,7 @@ export namespace slides_v1 { */ objectId?: string; /** - * The table column properties to update. If the value of - * `table_column_properties#column_width` in the request is less than - * 406,400 EMU (32 points), a 400 bad request error is returned. + * The table column properties to update. If the value of `table_column_properties#column_width` in the request is less than 406,400 EMU (32 points), a 400 bad request error is returned. */ tableColumnProperties?: Schema$TableColumnProperties; } @@ -3124,13 +2442,7 @@ export namespace slides_v1 { */ export interface Schema$UpdateTableRowPropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `tableRowProperties` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. - * For example to update the minimum row height, set `fields` to - * `"min_row_height"`. If '"min_row_height"' is - * included in the field mask but the property is left unset, the minimum - * row height will default to 0. + * The fields that should be updated. At least one field must be specified. The root `tableRowProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `"min_row_height"`. If '"min_row_height"' is included in the field mask but the property is left unset, the minimum row height will default to 0. */ fields?: string; /** @@ -3138,8 +2450,7 @@ export namespace slides_v1 { */ objectId?: string; /** - * The list of zero-based indices specifying which rows to update. If no - * indices are provided, all rows in the table will be updated. + * The list of zero-based indices specifying which rows to update. If no indices are provided, all rows in the table will be updated. */ rowIndices?: number[]; /** @@ -3152,18 +2463,11 @@ export namespace slides_v1 { */ export interface Schema$UpdateTextStyleRequest { /** - * The location of the cell in the table containing the text to style. If - * `object_id` refers to a table, `cell_location` must have a value. - * Otherwise, it must not. + * The location of the cell in the table containing the text to style. If `object_id` refers to a table, `cell_location` must have a value. Otherwise, it must not. */ cellLocation?: Schema$TableCellLocation; /** - * The fields that should be updated. At least one field must be specified. - * The root `style` is implied and should not be specified. A single - * `"*"` can be used as short-hand for listing every field. For - * example, to update the text style to bold, set `fields` to - * `"bold"`. To reset a property to its default value, include - * its field name in the field mask but leave the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `"bold"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -3171,18 +2475,11 @@ export namespace slides_v1 { */ objectId?: string; /** - * The style(s) to set on the text. If the value for a particular style - * matches that of the parent, that style will be set to inherit. Certain - * text style changes may cause other changes meant to mirror the behavior - * of the Slides editor. See the documentation of TextStyle for more - * information. + * The style(s) to set on the text. If the value for a particular style matches that of the parent, that style will be set to inherit. Certain text style changes may cause other changes meant to mirror the behavior of the Slides editor. See the documentation of TextStyle for more information. */ style?: Schema$TextStyle; /** - * The range of text to style. The range may be extended to include - * adjacent newlines. If the range fully contains a paragraph belonging to - * a list, the paragraph's bullet is also updated with the matching text - * style. + * The range of text to style. The range may be extended to include adjacent newlines. If the range fully contains a paragraph belonging to a list, the paragraph's bullet is also updated with the matching text style. */ textRange?: Schema$Range; } @@ -3191,13 +2488,7 @@ export namespace slides_v1 { */ export interface Schema$UpdateVideoPropertiesRequest { /** - * The fields that should be updated. At least one field must be specified. - * The root `videoProperties` is implied and should not be specified. A - * single `"*"` can be used as short-hand for listing every field. - * For example to update the video outline color, set `fields` to - * `"outline.outlineFill.solidFill.color"`. To reset a property - * to its default value, include its field name in the field mask but leave - * the field itself unset. + * The fields that should be updated. At least one field must be specified. The root `videoProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the video outline color, set `fields` to `"outline.outlineFill.solidFill.color"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */ fields?: string; /** @@ -3222,8 +2513,7 @@ export namespace slides_v1 { */ source?: string; /** - * An URL to a video. The URL is valid as long as the source video exists - * and sharing settings do not change. + * An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change. */ url?: string; /** @@ -3236,15 +2526,11 @@ export namespace slides_v1 { */ export interface Schema$VideoProperties { /** - * Whether to enable video autoplay when the page is displayed in present - * mode. Defaults to false. + * Whether to enable video autoplay when the page is displayed in present mode. Defaults to false. */ autoPlay?: boolean; /** - * The time at which to end playback, measured in seconds from the beginning - * of the video. If set, the end time should be after the start time. If not - * set or if you set this to a value that exceeds the video's length, - * the video will be played until its end. + * The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end. */ end?: number; /** @@ -3252,16 +2538,11 @@ export namespace slides_v1 { */ mute?: boolean; /** - * The outline of the video. The default outline matches the defaults for - * new videos created in the Slides editor. + * The outline of the video. The default outline matches the defaults for new videos created in the Slides editor. */ outline?: Schema$Outline; /** - * The time at which to start playback, measured in seconds from the - * beginning of the video. If set, the start time should be before the end - * time. If you set this to a value that exceeds the video's length in - * seconds, the video will be played from the last second. If not set, the - * video will be played from the beginning. + * The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning. */ start?: number; } @@ -3270,20 +2551,11 @@ export namespace slides_v1 { */ export interface Schema$WeightedFontFamily { /** - * The font family of the text. The font family can be any font from the - * Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). - * If the font name is unrecognized, the text is rendered in `Arial`. + * The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. */ fontFamily?: string; /** - * The rendered weight of the text. This field can have any value that is a - * multiple of `100` between `100` and `900`, inclusive. This range - * corresponds to the numerical values described in the CSS 2.1 - * Specification, - * [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), - * with non-numerical values disallowed. Weights greater than or equal to - * `700` are considered bold, and weights less than `700`are not bold. The - * default value is `400` ("normal"). + * The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). */ weight?: number; } @@ -3301,10 +2573,7 @@ export namespace slides_v1 { */ export interface Schema$WriteControl { /** - * The revision ID of the presentation required for the write request. If - * specified and the `required_revision_id` doesn't exactly match the - * presentation's current `revision_id`, the request will not be - * processed and will return a 400 bad request error. + * The revision ID of the presentation required for the write request. If specified and the `required_revision_id` doesn't exactly match the presentation's current `revision_id`, the request will not be processed and will return a 400 bad request error. */ requiredRevisionId?: string; } @@ -3319,20 +2588,7 @@ export namespace slides_v1 { /** * slides.presentations.batchUpdate - * @desc Applies one or more updates to the presentation. Each request is - * validated before being applied. If any request is not valid, then the - * entire request will fail and nothing will be applied. Some requests have - * replies to give you some information about how they are applied. Other - * requests do not need to return information; these each return an empty - * reply. The order of replies matches that of the requests. For example, - * suppose you call batchUpdate with four updates, and only the third one - * returns information. The response would have two empty replies: the reply - * to the third request, and another empty reply, in that order. Because - * other users may be editing the presentation, the presentation might not - * exactly reflect your changes: your changes may be altered with respect to - * collaborator changes. If there are no collaborators, the presentation - * should reflect your changes. In any case, the updates in your request are - * guaranteed to be applied together atomically. + * @desc Applies one or more updates to the presentation. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies: the reply to the third request, and another empty reply, in that order. Because other users may be editing the presentation, the presentation might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the presentation should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. * @alias slides.presentations.batchUpdate * @memberOf! () * @@ -3415,11 +2671,7 @@ export namespace slides_v1 { /** * slides.presentations.create - * @desc Creates a blank presentation using the title given in the request. - * If a `presentationId` is provided, it is used as the ID of the new - * presentation. Otherwise, a new ID is generated. Other fields in the - * request, including any provided content, are ignored. Returns the created - * presentation. + * @desc Creates a blank presentation using the title given in the request. If a `presentationId` is provided, it is used as the ID of the new presentation. Otherwise, a new ID is generated. Other fields in the request, including any provided content, are ignored. Returns the created presentation. * @alias slides.presentations.create * @memberOf! () * @@ -3686,10 +2938,7 @@ export namespace slides_v1 { /** * slides.presentations.pages.getThumbnail - * @desc Generates a thumbnail of the latest version of the specified page - * in the presentation and returns a URL to the thumbnail image. This - * request counts as an [expensive read request](/slides/limits) for quota - * purposes. + * @desc Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](/slides/limits) for quota purposes. * @alias slides.presentations.pages.getThumbnail * @memberOf! () * @@ -3797,13 +3046,11 @@ export namespace slides_v1 { */ presentationId?: string; /** - * The optional mime type of the thumbnail image. If you don't specify the - * mime type, the default mime type will be PNG. + * The optional mime type of the thumbnail image. If you don't specify the mime type, the default mime type will be PNG. */ 'thumbnailProperties.mimeType'?: string; /** - * The optional thumbnail image size. If you don't specify the size, the - * server chooses a default size of the image. + * The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image. */ 'thumbnailProperties.thumbnailSize'?: string; } diff --git a/src/apis/sourcerepo/package.json b/src/apis/sourcerepo/package.json index 9da370e6e97..a486efb627a 100644 --- a/src/apis/sourcerepo/package.json +++ b/src/apis/sourcerepo/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 43dae8f22a9..0f005ed7aab 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace sourcerepo_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace sourcerepo_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,34 +108,17 @@ export namespace sourcerepo_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } } /** - * Specifies the audit configuration for a service. The configuration - * determines which permission types are logged, and what identities, if any, - * are exempted from logging. An AuditConfig must have one or more - * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - * specific service, the union of the two AuditConfigs is used for that - * service: the log_types specified in each AuditConfig are enabled, and the - * exempted_members in each AuditLogConfig are exempted. Example Policy with - * multiple AuditConfigs: { "audit_configs": [ { - * "service": "allServices" "audit_log_configs": - * [ { "log_type": "DATA_READ", - * "exempted_members": [ "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", }, { - * "log_type": "ADMIN_READ", } ] }, - * { "service": "fooservice.googleapis.com" - * "audit_log_configs": [ { "log_type": - * "DATA_READ", }, { "log_type": - * "DATA_WRITE", "exempted_members": [ - * "user:bar@gmail.com" ] } ] } - * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and - * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, - * and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -147,25 +126,16 @@ export namespace sourcerepo_v1 { */ auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Specifies a service that will be enabled for audit logging. For example, - * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a - * special value that covers all services. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ service?: string; } /** - * Provides the configuration for logging a type of permissions. Example: { - * "audit_log_configs": [ { "log_type": - * "DATA_READ", "exempted_members": [ - * "user:foo@gmail.com" ] }, { - * "log_type": "DATA_WRITE", } ] } This - * enables 'DATA_READ' and 'DATA_WRITE' logging, while - * exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** - * Specifies the identities that do not cause logging for this type of - * permission. Follows the same format of Binding.members. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** @@ -178,67 +148,40 @@ export namespace sourcerepo_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -247,9 +190,7 @@ export namespace sourcerepo_v1 { */ export interface Schema$ListReposResponse { /** - * If non-empty, additional repositories exist within the project. These can - * be retrieved by including this value in the next ListReposRequest's - * page_token field. + * If non-empty, additional repositories exist within the project. These can be retrieved by including this value in the next ListReposRequest's page_token field. */ nextPageToken?: string; /** @@ -258,14 +199,11 @@ export namespace sourcerepo_v1 { repos?: Schema$Repo[]; } /** - * Configuration to automatically mirror a repository from another hosting - * service, for example GitHub or Bitbucket. + * Configuration to automatically mirror a repository from another hosting service, for example GitHub or Bitbucket. */ export interface Schema$MirrorConfig { /** - * ID of the SSH deploy key at the other hosting service. Removing this key - * from the other service would deauthorize Google Cloud Source Repositories - * from mirroring. + * ID of the SSH deploy key at the other hosting service. Removing this key from the other service would deauthorize Google Cloud Source Repositories from mirroring. */ deployKeyId?: string; /** @@ -273,32 +211,37 @@ export namespace sourcerepo_v1 { */ url?: string; /** - * ID of the webhook listening to updates to trigger mirroring. Removing - * this webhook from the other hosting service will stop Google Cloud Source - * Repositories from receiving notifications, and thereby disabling - * mirroring. + * ID of the webhook listening to updates to trigger mirroring. Removing this webhook from the other hosting service will stop Google Cloud Source Repositories from receiving notifications, and thereby disabling mirroring. */ webhookId?: string; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any}; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any}; + } + /** + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** @@ -306,20 +249,11 @@ export namespace sourcerepo_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -336,13 +270,11 @@ export namespace sourcerepo_v1 { */ enablePrivateKeyCheck?: boolean; /** - * The name of the project. Values are of the form - * `projects/<project>`. + * The name of the project. Values are of the form `projects/<project>`. */ name?: string; /** - * How this project publishes a change in the repositories through Cloud - * Pub/Sub. Keyed by the topic names. + * How this project publishes a change in the repositories through Cloud Pub/Sub. Keyed by the topic names. */ pubsubConfigs?: {[key: string]: Schema$PubsubConfig}; } @@ -355,49 +287,36 @@ export namespace sourcerepo_v1 { */ messageFormat?: string; /** - * Email address of the service account used for publishing Cloud Pub/Sub - * messages. This service account needs to be in the same project as the - * PubsubConfig. When added, the caller needs to have - * iam.serviceAccounts.actAs permission on this service account. If - * unspecified, it defaults to the compute engine default service account. + * Email address of the service account used for publishing Cloud Pub/Sub messages. This service account needs to be in the same project as the PubsubConfig. When added, the caller needs to have iam.serviceAccounts.actAs permission on this service account. If unspecified, it defaults to the compute engine default service account. */ serviceAccountEmail?: string; /** - * A topic of Cloud Pub/Sub. Values are of the form - * `projects/<project>/topics/<topic>`. The project needs to be - * the same project as this config is in. + * A topic of Cloud Pub/Sub. Values are of the form `projects/<project>/topics/<topic>`. The project needs to be the same project as this config is in. */ topic?: string; } /** - * A repository (or repo) is a Git repository storing versioned source - * content. + * A repository (or repo) is a Git repository storing versioned source content. */ export interface Schema$Repo { /** - * How this repository mirrors a repository managed by another service. - * Read-only field. + * How this repository mirrors a repository managed by another service. Read-only field. */ mirrorConfig?: Schema$MirrorConfig; /** - * Resource name of the repository, of the form - * `projects/<project>/repos/<repo>`. The repo name may contain - * slashes. eg, `projects/myproject/repos/name/with/slash` + * Resource name of the repository, of the form `projects/<project>/repos/<repo>`. The repo name may contain slashes. eg, `projects/myproject/repos/name/with/slash` */ name?: string; /** - * How this repository publishes a change in the repository through Cloud - * Pub/Sub. Keyed by the topic names. + * How this repository publishes a change in the repository through Cloud Pub/Sub. Keyed by the topic names. */ pubsubConfigs?: {[key: string]: Schema$PubsubConfig}; /** - * The disk usage of the repo, in bytes. Read-only field. Size is only - * returned by GetRepo. + * The disk usage of the repo, in bytes. Read-only field. Size is only returned by GetRepo. */ size?: string; /** - * URL to clone the repository from Google Cloud Source Repositories. - * Read-only field. + * URL to clone the repository from Google Cloud Source Repositories. Read-only field. */ url?: string; } @@ -406,29 +325,41 @@ export namespace sourcerepo_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. */ updateMask?: string; } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}>; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string; + } + /** + * Request for SyncRepo. + */ + export interface Schema$SyncRepoRequest {} /** * Request message for `TestIamPermissions` method. */ export interface Schema$TestIamPermissionsRequest { /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } @@ -437,8 +368,7 @@ export namespace sourcerepo_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -451,9 +381,7 @@ export namespace sourcerepo_v1 { */ projectConfig?: Schema$ProjectConfig; /** - * A FieldMask specifying which fields of the project_config to modify. Only - * the fields in the mask will be modified. If no mask is provided, this - * request is no-op. + * A FieldMask specifying which fields of the project_config to modify. Only the fields in the mask will be modified. If no mask is provided, this request is no-op. */ updateMask?: string; } @@ -466,9 +394,7 @@ export namespace sourcerepo_v1 { */ repo?: Schema$Repo; /** - * A FieldMask specifying which fields of the repo to modify. Only the - * fields in the mask will be modified. If no mask is provided, this request - * is no-op. + * A FieldMask specifying which fields of the repo to modify. Only the fields in the mask will be modified. If no mask is provided, this request is no-op. */ updateMask?: string; } @@ -633,8 +559,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the requested project. Values are of the form - * `projects/`. + * The name of the requested project. Values are of the form `projects/`. */ name?: string; } @@ -646,8 +571,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the requested project. Values are of the form - * `projects/`. + * The name of the requested project. Values are of the form `projects/`. */ name?: string; @@ -665,8 +589,7 @@ export namespace sourcerepo_v1 { /** * sourcerepo.projects.repos.create - * @desc Creates a repo in the given project with the given name. If the - * named repository already exists, `CreateRepo` returns `ALREADY_EXISTS`. + * @desc Creates a repo in the given project with the given name. If the named repository already exists, `CreateRepo` returns `ALREADY_EXISTS`. * @alias sourcerepo.projects.repos.create * @memberOf! () * @@ -877,8 +800,7 @@ export namespace sourcerepo_v1 { /** * sourcerepo.projects.repos.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @alias sourcerepo.projects.repos.getIamPolicy * @memberOf! () * @@ -950,8 +872,7 @@ export namespace sourcerepo_v1 { /** * sourcerepo.projects.repos.list - * @desc Returns all repos belonging to a project. The sizes of the repos - * are not set by ListRepos. To get the size of a repo, use GetRepo. + * @desc Returns all repos belonging to a project. The sizes of the repos are not set by ListRepos. To get the size of a repo, use GetRepo. * @alias sourcerepo.projects.repos.list * @memberOf! () * @@ -1094,8 +1015,7 @@ export namespace sourcerepo_v1 { /** * sourcerepo.projects.repos.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias sourcerepo.projects.repos.setIamPolicy * @memberOf! () * @@ -1166,11 +1086,81 @@ export namespace sourcerepo_v1 { } } + /** + * sourcerepo.projects.repos.sync + * @desc Synchronize a connected repo. The response contains SyncRepoMetadata in the metadata field. + * @alias sourcerepo.projects.repos.sync + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the repo to synchronize. Values are of the form `projects//repos/`. + * @param {().SyncRepoRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + sync( + params?: Params$Resource$Projects$Repos$Sync, + options?: MethodOptions + ): GaxiosPromise; + sync( + params: Params$Resource$Projects$Repos$Sync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sync( + params: Params$Resource$Projects$Repos$Sync, + callback: BodyResponseCallback + ): void; + sync(callback: BodyResponseCallback): void; + sync( + paramsOrCallback?: + | Params$Resource$Projects$Repos$Sync + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Repos$Sync; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Repos$Sync; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sourcerepo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:sync').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * sourcerepo.projects.repos.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. * @alias sourcerepo.projects.repos.testIamPermissions * @memberOf! () * @@ -1259,8 +1249,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the repo. Values are of the form - * `projects/`. + * The project in which to create the repo. Values are of the form `projects/`. */ parent?: string; @@ -1277,8 +1266,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the repo to delete. Values are of the form - * `projects//repos/`. + * The name of the repo to delete. Values are of the form `projects//repos/`. */ name?: string; } @@ -1290,8 +1278,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the requested repository. Values are of the form - * `projects//repos/`. + * The name of the requested repository. Values are of the form `projects//repos/`. */ name?: string; } @@ -1303,8 +1290,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being requested. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } @@ -1316,19 +1302,15 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID whose repos should be listed. Values are of the form - * `projects/`. + * The project ID whose repos should be listed. Values are of the form `projects/`. */ name?: string; /** - * Maximum number of repositories to return; between 1 and 500. If not set - * or zero, defaults to 100 at the server. + * Maximum number of repositories to return; between 1 and 500. If not set or zero, defaults to 100 at the server. */ pageSize?: number; /** - * Resume listing repositories where a prior ListReposResponse left off. - * This is an opaque token that must be obtained from a recent, prior - * ListReposResponse's next_page_token field. + * Resume listing repositories where a prior ListReposResponse left off. This is an opaque token that must be obtained from a recent, prior ListReposResponse's next_page_token field. */ pageToken?: string; } @@ -1340,8 +1322,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the requested repository. Values are of the form - * `projects//repos/`. + * The name of the requested repository. Values are of the form `projects//repos/`. */ name?: string; @@ -1358,8 +1339,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy is being specified. See the - * operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. */ resource?: string; @@ -1368,6 +1348,23 @@ export namespace sourcerepo_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } + export interface Params$Resource$Projects$Repos$Sync + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the repo to synchronize. Values are of the form `projects//repos/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SyncRepoRequest; + } export interface Params$Resource$Projects$Repos$Testiampermissions extends StandardParameters { /** @@ -1376,8 +1373,7 @@ export namespace sourcerepo_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; diff --git a/src/apis/spanner/package.json b/src/apis/spanner/package.json index 430bb577372..72dfd8ca870 100644 --- a/src/apis/spanner/package.json +++ b/src/apis/spanner/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index bafdd81ab60..afcf0532d24 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace spanner_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace spanner_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace spanner_v1 { /** * Cloud Spanner API * - * Cloud Spanner is a managed, mission-critical, globally consistent and - * scalable relational database service. + * Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. * * @example * const {google} = require('googleapis'); @@ -113,7 +108,10 @@ export namespace spanner_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -133,37 +131,20 @@ export namespace spanner_v1 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. - * `members` can have the following values: * `allUsers`: A special - * identifier that represents anyone who is on the internet; with or - * without a Google account. * `allAuthenticatedUsers`: A special - * identifier that represents anyone who is authenticated with a Google - * account or a service account. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice@gmail.com` . - * * `serviceAccount:{emailid}`: An email address that represents a service - * account. For example, `my-other-app@appspot.gserviceaccount.com`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** - * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** - * Metadata associated with a parent-child relationship appearing in a - * PlanNode. + * Metadata associated with a parent-child relationship appearing in a PlanNode. */ export interface Schema$ChildLink { /** @@ -171,20 +152,11 @@ export namespace spanner_v1 { */ childIndex?: number; /** - * The type of the link. For example, in Hash Joins this could be used to - * distinguish between the build child and the probe child, or in the case - * of the child being an output variable, to represent the tag associated - * with the output variable. + * The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable. */ type?: string; /** - * Only present if the child node is SCALAR and corresponds to an output - * variable of the parent node. The field carries the name of the output - * variable. For example, a `TableScan` operator that reads rows from a - * table will have child links to the `SCALAR` nodes representing the output - * variables created for each column that is read by the operator. The - * corresponding `variable` fields will be set to the variable names - * assigned to the columns. + * Only present if the child node is SCALAR and corresponds to an output variable of the parent node. The field carries the name of the output variable. For example, a `TableScan` operator that reads rows from a table will have child links to the `SCALAR` nodes representing the output variables created for each column that is read by the operator. The corresponding `variable` fields will be set to the variable names assigned to the columns. */ variable?: string; } @@ -193,18 +165,11 @@ export namespace spanner_v1 { */ export interface Schema$CommitRequest { /** - * The mutations to be executed when this transaction commits. All mutations - * are applied atomically, in the order they appear in this list. + * The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. */ mutations?: Schema$Mutation[]; /** - * Execute mutations in a temporary transaction. Note that unlike commit of - * a previously-started transaction, commit with a temporary transaction is - * non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner - * more than once (for instance, due to retries in the application, or in - * the transport library), it is possible that the mutations are executed - * more than once. If this is undesirable, use BeginTransaction and Commit - * instead. + * Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. */ singleUseTransaction?: Schema$TransactionOptions; /** @@ -235,18 +200,11 @@ export namespace spanner_v1 { */ export interface Schema$CreateDatabaseRequest { /** - * Required. A `CREATE DATABASE` statement, which specifies the ID of the - * new database. The database ID must conform to the regular expression - * `a-z*[a-z0-9]` and be between 2 and 30 characters in length. If the - * database ID is a reserved word or if it contains a hyphen, the database - * ID must be enclosed in backticks (`` ` ``). + * Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `a-z*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``). */ createStatement?: string; /** - * An optional list of DDL statements to run inside the newly created - * database. Statements can create tables, indexes, etc. These statements - * execute atomically with the creation of the database: if there is an - * error in any statement, the database is not created. + * An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created. */ extraStatements?: string[]; } @@ -255,9 +213,7 @@ export namespace spanner_v1 { */ export interface Schema$CreateInstanceMetadata { /** - * The time at which this operation was cancelled. If set, this operation is - * in the process of undoing itself (which is guaranteed to succeed) and - * cannot be cancelled again. + * The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. */ cancelTime?: string; /** @@ -278,13 +234,11 @@ export namespace spanner_v1 { */ export interface Schema$CreateInstanceRequest { /** - * Required. The instance to create. The name may be omitted, but if - * specified must be `<parent>/instances/<instance_id>`. + * Required. The instance to create. The name may be omitted, but if specified must be `<parent>/instances/<instance_id>`. */ instance?: Schema$Instance; /** - * Required. The ID of the instance to create. Valid identifiers are of the - * form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. + * Required. The ID of the instance to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. */ instanceId?: string; } @@ -302,11 +256,7 @@ export namespace spanner_v1 { */ export interface Schema$Database { /** - * Required. The name of the database. Values are of the form - * `projects/<project>/instances/<instance>/databases/<database>`, - * where `<database>` is as specified in the `CREATE DATABASE` - * statement. This name can be passed to other API methods to identify the - * database. + * Required. The name of the database. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`, where `<database>` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. */ name?: string; /** @@ -319,9 +269,7 @@ export namespace spanner_v1 { */ export interface Schema$Delete { /** - * Required. The primary keys of the rows within table to delete. Delete is - * idempotent. The transaction will succeed even if some or all rows do not - * exist. + * Required. The primary keys of the rows within table to delete. Delete is idempotent. The transaction will succeed even if some or all rows do not exist. */ keySet?: Schema$KeySet; /** @@ -330,11 +278,7 @@ export namespace spanner_v1 { table?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -342,54 +286,28 @@ export namespace spanner_v1 { */ export interface Schema$ExecuteBatchDmlRequest { /** - * A per-transaction sequence number used to identify this request. This is - * used in the same space as the seqno in ExecuteSqlRequest. See more - * details in ExecuteSqlRequest. + * A per-transaction sequence number used to identify this request. This is used in the same space as the seqno in ExecuteSqlRequest. See more details in ExecuteSqlRequest. */ seqno?: string; /** - * The list of statements to execute in this batch. Statements are executed - * serially, such that the effects of statement i are visible to statement - * i+1. Each statement must be a DML statement. Execution will stop at the - * first failed statement; the remaining statements will not run. REQUIRES: - * statements_size() > 0. + * The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution will stop at the first failed statement; the remaining statements will not run. REQUIRES: `statements_size()` > 0. */ statements?: Schema$Statement[]; /** - * The transaction to use. A ReadWrite transaction is required. Single-use - * transactions are not supported (to avoid replay). The caller must either - * supply an existing transaction ID or begin a new transaction. + * The transaction to use. A ReadWrite transaction is required. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction. */ transaction?: Schema$TransactionSelector; } /** - * The response for ExecuteBatchDml. Contains a list of ResultSet, one for - * each DML statement that has successfully executed. If a statement fails, - * the error is returned as part of the response payload. Clients can - * determine whether all DML statements have run successfully, or if a - * statement failed, using one of the following approaches: 1. Check if - * 'status' field is OkStatus. 2. Check if result_sets_size() equals - * the number of statements in ExecuteBatchDmlRequest. Example 1: A - * request with 5 DML statements, all executed successfully. Result: A - * response with 5 ResultSets, one for each statement in the same order, and - * an OK status. Example 2: A request with 5 DML statements. The 3rd - * statement has a syntax error. Result: A response with 2 ResultSets, for the - * first 2 statements that run successfully, and a syntax error - * (INVALID_ARGUMENT) status. From result_set_size() client can determine that - * the 3rd statement has failed. + * The response for ExecuteBatchDml. Contains a list of ResultSet, one for each DML statement that has successfully executed. If a statement fails, the error is returned as part of the response payload. Clients can determine whether all DML statements have run successfully, or if a statement failed, using one of the following approaches: 1. Check if `'status'` field is `OkStatus`. 2. Check if `result_sets_size()` equals the number of statements in ExecuteBatchDmlRequest. Example 1: A request with 5 DML statements, all executed successfully. Result: A response with 5 ResultSets, one for each statement in the same order, and an `OkStatus`. Example 2: A request with 5 DML statements. The 3rd statement has a syntax error. Result: A response with 2 ResultSets, for the first 2 statements that run successfully, and a syntax error (`INVALID_ARGUMENT`) status. From `result_set_size()` client can determine that the 3rd statement has failed. */ export interface Schema$ExecuteBatchDmlResponse { /** - * ResultSets, one for each statement in the request that ran successfully, - * in the same order as the statements in the request. Each ResultSet will - * not contain any rows. The ResultSetStats in each ResultSet will contain - * the number of rows modified by the statement. Only the first ResultSet - * in the response contains a valid ResultSetMetadata. + * ResultSets, one for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet will not contain any rows. The ResultSetStats in each ResultSet will contain the number of rows modified by the statement. Only the first ResultSet in the response contains a valid ResultSetMetadata. */ resultSets?: Schema$ResultSet[]; /** - * If all DML statements are executed successfully, status will be OK. - * Otherwise, the error status of the first failed statement. + * If all DML statements are executed successfully, status will be OK. Otherwise, the error status of the first failed statement. */ status?: Schema$Status; } @@ -398,57 +316,27 @@ export namespace spanner_v1 { */ export interface Schema$ExecuteSqlRequest { /** - * The SQL string can contain parameter placeholders. A parameter - * placeholder consists of `'@'` followed by the parameter name. - * Parameter names consist of any combination of letters, numbers, and - * underscores. Parameters can appear anywhere that a literal value is - * expected. The same parameter name can be used more than once, for - * example: `"WHERE id > @msg_id AND id < @msg_id + 100"` - * It is an error to execute an SQL statement with unbound parameters. - * Parameter values are specified using `params`, which is a JSON object - * whose keys are parameter names, and whose values are the corresponding - * parameter values. + * The SQL string can contain parameter placeholders. A parameter placeholder consists of `'@'` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. */ params?: {[key: string]: any}; /** - * It is not always possible for Cloud Spanner to infer the right SQL type - * from a JSON value. For example, values of type `BYTES` and values of - * type `STRING` both appear in params as JSON strings. In these cases, - * `param_types` can be used to specify the exact SQL type for some or all - * of the SQL statement parameters. See the definition of Type for more - * information about SQL types. + * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */ paramTypes?: {[key: string]: Schema$Type}; /** - * If present, results will be restricted to the specified partition - * previously created using PartitionQuery(). There must be an exact match - * for the values of fields common to this message and the - * PartitionQueryRequest message used to create this partition_token. + * If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token. */ partitionToken?: string; /** - * Used to control the amount of debugging information returned in - * ResultSetStats. If partition_token is set, query_mode can only be set to - * QueryMode.NORMAL. + * Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. */ queryMode?: string; /** - * If this request is resuming a previously interrupted SQL statement - * execution, `resume_token` should be copied from the last PartialResultSet - * yielded before the interruption. Doing this enables the new SQL statement - * execution to resume where the last one left off. The rest of the request - * parameters must exactly match the request that yielded this token. + * If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. */ resumeToken?: string; /** - * A per-transaction sequence number used to identify this request. This - * makes each request idempotent such that if the request is received - * multiple times, at most one will succeed. The sequence number must be - * monotonically increasing within the transaction. If a request arrives for - * the first time with an out-of-order sequence number, the transaction may - * be aborted. Replays of previously handled requests will yield the same - * response as the first execution. Required for DML statements. Ignored - * for queries. + * A per-transaction sequence number used to identify this request. This makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. */ seqno?: string; /** @@ -456,43 +344,28 @@ export namespace spanner_v1 { */ sql?: string; /** - * The transaction to use. If none is provided, the default is a temporary - * read-only transaction with strong concurrency. The transaction to use. - * For queries, if none is provided, the default is a temporary read-only - * transaction with strong concurrency. Standard DML statements require a - * ReadWrite transaction. Single-use transactions are not supported (to - * avoid replay). The caller must either supply an existing transaction ID - * or begin a new transaction. Partitioned DML requires an existing - * PartitionedDml transaction ID. + * The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a ReadWrite transaction. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing PartitionedDml transaction ID. */ transaction?: Schema$TransactionSelector; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a - * user account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } @@ -501,13 +374,7 @@ export namespace spanner_v1 { */ export interface Schema$Field { /** - * The name of the field. For reads, this is the column name. For SQL - * queries, it is the column alias (e.g., `"Word"` in the query - * `"SELECT 'hello' AS Word"`), or the column name (e.g., - * `"ColName"` in the query `"SELECT ColName FROM - * Table"`). Some columns might have an empty name (e.g., !"SELECT - * UPPER(ColName)"`). Note that a query result can contain multiple - * fields with the same name. + * The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. */ name?: string; /** @@ -520,8 +387,7 @@ export namespace spanner_v1 { */ export interface Schema$GetDatabaseDdlResponse { /** - * A list of formatted DDL statements defining the schema of the database - * specified in the request. + * A list of formatted DDL statements defining the schema of the database specified in the request. */ statements?: string[]; } @@ -530,67 +396,36 @@ export namespace spanner_v1 { */ export interface Schema$GetIamPolicyRequest {} /** - * An isolated set of Cloud Spanner resources on which databases can be - * hosted. + * An isolated set of Cloud Spanner resources on which databases can be hosted. */ export interface Schema$Instance { /** - * Required. The name of the instance's configuration. Values are of the - * form `projects/<project>/instanceConfigs/<configuration>`. - * See also InstanceConfig and ListInstanceConfigs. + * Required. The name of the instance's configuration. Values are of the form `projects/<project>/instanceConfigs/<configuration>`. See also InstanceConfig and ListInstanceConfigs. */ config?: string; /** - * Required. The descriptive name for this instance as it appears in UIs. - * Must be unique per project and between 4 and 30 characters in length. + * Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. */ displayName?: string; /** - * Cloud Labels are a flexible and lightweight mechanism for organizing - * cloud resources into groups that reflect a customer's organizational - * needs and deployment strategies. Cloud Labels can be used to filter - * collections of resources. They can be used to control how resource - * metrics are aggregated. And they can be used as arguments to policy - * management rules (e.g. route, firewall, load balancing, etc.). * Label - * keys must be between 1 and 63 characters long and must conform to the - * following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label - * values must be between 0 and 63 characters long and must conform to - * the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than - * 64 labels can be associated with a given resource. See - * https://goo.gl/xmQnxf for more information on and examples of labels. If - * you plan to use labels in your own code, please note that additional - * characters may be allowed in the future. And so you are advised to use an - * internal label representation, such as JSON, which doesn't rely upon - * specific characters being disallowed. For example, representing labels - * as the string: name + "_" + value would prove problematic if - * we were to allow "_" in a future release. + * Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. */ labels?: {[key: string]: string}; /** - * Required. A unique identifier for the instance, which cannot be changed - * after the instance is created. Values are of the form - * `projects/<project>/instances/a-z*[a-z0-9]`. The final segment of - * the name must be between 2 and 64 characters in length. + * Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects/<project>/instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. */ name?: string; /** - * Required. The number of nodes allocated to this instance. This may be - * zero in API responses for instances that are not yet in state `READY`. - * See [the - * documentation](https://cloud.google.com/spanner/docs/instances#node_count) - * for more information about nodes. + * Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/instances#node_count) for more information about nodes. */ nodeCount?: number; /** - * Output only. The current instance state. For CreateInstance, the state - * must be either omitted or set to `CREATING`. For UpdateInstance, the - * state must be either omitted or set to `READY`. + * Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. */ state?: string; } /** - * A possible configuration for a Cloud Spanner instance. Configurations - * define the geographic placement of nodes and their replication. + * A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. */ export interface Schema$InstanceConfig { /** @@ -598,100 +433,49 @@ export namespace spanner_v1 { */ displayName?: string; /** - * A unique identifier for the instance configuration. Values are of the - * form `projects/<project>/instanceConfigs/a-z*` + * A unique identifier for the instance configuration. Values are of the form `projects/<project>/instanceConfigs/a-z*` */ name?: string; + /** + * The geographic placement of nodes in this instance configuration and their replication properties. + */ + replicas?: Schema$ReplicaInfo[]; } /** - * KeyRange represents a range of rows in a table or index. A range has a - * start key and an end key. These keys can be open or closed, indicating if - * the range includes rows with that key. Keys are represented by lists, - * where the ith value in the list corresponds to the ith component of the - * table or index primary key. Individual values are encoded as described - * here. For example, consider the following table definition: CREATE - * TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) - * ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this - * table: "Bob", "2014-09-23" Since the `UserEvents` - * table's `PRIMARY KEY` clause names two columns, each `UserEvents` key - * has two elements; the first is the `UserName`, and the second is the - * `EventDate`. Key ranges with multiple components are interpreted - * lexicographically by component using the table or index key's declared - * sort order. For example, the following range returns all events for user - * `"Bob"` that occurred in the year 2015: "start_closed": - * ["Bob", "2015-01-01"] "end_closed": - * ["Bob", "2015-12-31"] Start and end keys can omit - * trailing key components. This affects the inclusion and exclusion of rows - * that exactly match the provided key components: if the key is closed, then - * rows that exactly match the provided components are included; if the key is - * open, then rows that exactly match are not included. For example, the - * following range includes all events for `"Bob"` that occurred - * during and after the year 2000: "start_closed": - * ["Bob", "2000-01-01"] "end_closed": - * ["Bob"] The next example retrieves all events for - * `"Bob"`: "start_closed": ["Bob"] - * "end_closed": ["Bob"] To retrieve events before the - * year 2000: "start_closed": ["Bob"] - * "end_open": ["Bob", "2000-01-01"] The - * following range includes all rows in the table: "start_closed": - * [] "end_closed": [] This range returns all users whose - * `UserName` begins with any character from A to C: "start_closed": - * ["A"] "end_open": ["D"] This range - * returns all users whose `UserName` begins with B: "start_closed": - * ["B"] "end_open": ["C"] Key ranges honor - * column sort order. For example, suppose a table is defined as follows: - * CREATE TABLE DescendingSortedTable { Key INT64, ... ) - * PRIMARY KEY(Key DESC); The following range retrieves all rows with key - * values between 1 and 100 inclusive: "start_closed": - * ["100"] "end_closed": ["1"] Note that - * 100 is passed as the start, and 1 is passed as the end, because `Key` is a - * descending column in the schema. + * KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: "Bob", "2014-09-23" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `"Bob"` that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `"Bob"` that occurred during and after the year 2000: "start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example retrieves all events for `"Bob"`: "start_closed": ["Bob"] "end_closed": ["Bob"] To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"] The following range includes all rows in the table: "start_closed": [] "end_closed": [] This range returns all users whose `UserName` begins with any character from A to C: "start_closed": ["A"] "end_open": ["D"] This range returns all users whose `UserName` begins with B: "start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: "start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema. */ export interface Schema$KeyRange { /** - * If the end is closed, then the range includes all rows whose first - * `len(end_closed)` key columns exactly match `end_closed`. + * If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`. */ endClosed?: any[]; /** - * If the end is open, then the range excludes rows whose first - * `len(end_open)` key columns exactly match `end_open`. + * If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`. */ endOpen?: any[]; /** - * If the start is closed, then the range includes all rows whose first - * `len(start_closed)` key columns exactly match `start_closed`. + * If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`. */ startClosed?: any[]; /** - * If the start is open, then the range excludes rows whose first - * `len(start_open)` key columns exactly match `start_open`. + * If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`. */ startOpen?: any[]; } /** - * `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All - * the keys are expected to be in the same table or index. The keys need not - * be sorted in any particular way. If the same key is specified multiple - * times in the set (for example if two ranges, two keys, or a key and a range - * overlap), Cloud Spanner behaves as if the key were only specified once. + * `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way. If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once. */ export interface Schema$KeySet { /** - * For convenience `all` can be set to `true` to indicate that this `KeySet` - * matches all keys in the table or index. Note that any keys specified in - * `keys` or `ranges` are only yielded once. + * For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index. Note that any keys specified in `keys` or `ranges` are only yielded once. */ all?: boolean; /** - * A list of specific keys. Entries in `keys` should have exactly as many - * elements as there are columns in the primary or index key with which this - * `KeySet` is used. Individual key values are encoded as described here. + * A list of specific keys. Entries in `keys` should have exactly as many elements as there are columns in the primary or index key with which this `KeySet` is used. Individual key values are encoded as described here. */ keys?: any[][]; /** - * A list of key ranges. See KeyRange for more information about key range - * specifications. + * A list of key ranges. See KeyRange for more information about key range specifications. */ ranges?: Schema$KeyRange[]; } @@ -704,8 +488,7 @@ export namespace spanner_v1 { */ databases?: Schema$Database[]; /** - * `next_page_token` can be sent in a subsequent ListDatabases call to fetch - * more of the matching databases. + * `next_page_token` can be sent in a subsequent ListDatabases call to fetch more of the matching databases. */ nextPageToken?: string; } @@ -718,8 +501,7 @@ export namespace spanner_v1 { */ instanceConfigs?: Schema$InstanceConfig[]; /** - * `next_page_token` can be sent in a subsequent ListInstanceConfigs call to - * fetch more of the matching instance configurations. + * `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations. */ nextPageToken?: string; } @@ -732,8 +514,7 @@ export namespace spanner_v1 { */ instances?: Schema$Instance[]; /** - * `next_page_token` can be sent in a subsequent ListInstances call to fetch - * more of the matching instances. + * `next_page_token` can be sent in a subsequent ListInstances call to fetch more of the matching instances. */ nextPageToken?: string; } @@ -755,8 +536,7 @@ export namespace spanner_v1 { */ export interface Schema$ListSessionsResponse { /** - * `next_page_token` can be sent in a subsequent ListSessions call to fetch - * more of the matching sessions. + * `next_page_token` can be sent in a subsequent ListSessions call to fetch more of the matching sessions. */ nextPageToken?: string; /** @@ -765,47 +545,36 @@ export namespace spanner_v1 { sessions?: Schema$Session[]; } /** - * A modification to one or more Cloud Spanner rows. Mutations can be applied - * to a Cloud Spanner database by sending them in a Commit call. + * A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call. */ export interface Schema$Mutation { /** - * Delete rows from a table. Succeeds whether or not the named rows were - * present. + * Delete rows from a table. Succeeds whether or not the named rows were present. */ delete?: Schema$Delete; /** - * Insert new rows in a table. If any of the rows already exist, the write - * or transaction fails with error `ALREADY_EXISTS`. + * Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error `ALREADY_EXISTS`. */ insert?: Schema$Write; /** - * Like insert, except that if the row already exists, then its column - * values are overwritten with the ones provided. Any column values not - * explicitly written are preserved. + * Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved. */ insertOrUpdate?: Schema$Write; /** - * Like insert, except that if the row already exists, it is deleted, and - * the column values provided are inserted instead. Unlike insert_or_update, - * this means any values not explicitly written become `NULL`. + * Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. */ replace?: Schema$Write; /** - * Update existing rows in a table. If any of the rows does not already - * exist, the transaction fails with error `NOT_FOUND`. + * Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`. */ update?: Schema$Write; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -813,109 +582,40 @@ export namespace spanner_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * Partial results from a streaming read or SQL query. Streaming reads and SQL - * queries better tolerate large result sets, large rows, and large values, - * but are a little trickier to consume. + * Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume. */ export interface Schema$PartialResultSet { /** - * If true, then the final value in values is chunked, and must be combined - * with more values from subsequent `PartialResultSet`s to obtain a complete - * field value. + * If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value. */ chunkedValue?: boolean; /** - * Metadata about the result set, such as row type information. Only present - * in the first response. + * Metadata about the result set, such as row type information. Only present in the first response. */ metadata?: Schema$ResultSetMetadata; /** - * Streaming calls might be interrupted for a variety of reasons, such as - * TCP connection loss. If this occurs, the stream of results can be resumed - * by re-sending the original request and including `resume_token`. Note - * that executing any other transaction in the same session invalidates the - * token. + * Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token. */ resumeToken?: string; /** - * Query plan and execution statistics for the statement that produced this - * streaming result set. These can be requested by setting - * ExecuteSqlRequest.query_mode and are sent only once with the last - * response in the stream. This field will also be present in the last - * response for DML statements. + * Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements. */ stats?: Schema$ResultSetStats; /** - * A streamed result set consists of a stream of values, which might be - * split into many `PartialResultSet` messages to accommodate large rows - * and/or large values. Every N complete values defines a row, where N is - * equal to the number of entries in metadata.row_type.fields. Most values - * are encoded based on type as described here. It is possible that the - * last value in values is "chunked", meaning that the rest of the - * value is sent in subsequent `PartialResultSet`(s). This is denoted by the - * chunked_value field. Two or more chunked values can be merged to form a - * complete value as follows: * `bool/number/null`: cannot be chunked * - * `string`: concatenate the strings * `list`: concatenate the lists. If - * the last element in a list is a `string`, `list`, or `object`, merge - * it with the first element in the next list by applying these rules - * recursively. * `object`: concatenate the (field name, field value) - * pairs. If a field name is duplicated, then apply these rules - * recursively to merge the field values. Some examples of merging: # - * Strings are concatenated. "foo", "bar" => - * "foobar" # Lists of non-strings are concatenated. [2, - * 3], [4] => [2, 3, 4] # Lists are concatenated, but the last and - * first elements are merged # because they are strings. ["a", - * "b"], ["c", "d"] => ["a", - * "bc", "d"] # Lists are concatenated, but the - * last and first elements are merged # because they are lists. - * Recursively, the last and first elements # of the inner lists are - * merged because they are strings. ["a", ["b", - * "c"]], [["d"], "e"] => ["a", - * ["b", "cd"], "e"] # Non-overlapping - * object fields are combined. {"a": "1"}, - * {"b": "2"} => {"a": "1", - * "b": 2"} # Overlapping object fields are merged. - * {"a": "1"}, {"a": "2"} => - * {"a": "12"} # Examples of merging objects - * containing lists of strings. {"a": ["1"]}, - * {"a": ["2"]} => {"a": ["12"]} - * For a more complete example, suppose a streaming SQL query is yielding a - * result set whose rows contain a single string field. The following - * `PartialResultSet`s might be yielded: { "metadata": - * { ... } "values": ["Hello", "W"] - * "chunked_value": true "resume_token": - * "Af65..." } { "values": - * ["orl"] "chunked_value": true - * "resume_token": "Bqp2..." } { - * "values": ["d"] "resume_token": - * "Zx1B..." } This sequence of `PartialResultSet`s encodes - * two rows, one containing the field value `"Hello"`, and a - * second containing the field value `"World" = "W" + - * "orl" + "d"`. + * A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: cannot be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: # Strings are concatenated. "foo", "bar" => "foobar" # Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are concatenated, but the last and first elements are merged # because they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] # Lists are concatenated, but the last and first elements are merged # because they are lists. Recursively, the last and first elements # of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] # Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} # Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} # Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. */ values?: any[]; } @@ -924,9 +624,7 @@ export namespace spanner_v1 { */ export interface Schema$Partition { /** - * This token can be passed to Read, StreamingRead, ExecuteSql, or - * ExecuteStreamingSql requests to restrict the results to those identified - * by this partition token. + * This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token. */ partitionToken?: string; } @@ -939,20 +637,11 @@ export namespace spanner_v1 { */ export interface Schema$PartitionOptions { /** - * **Note:** This hint is currently ignored by PartitionQuery and - * PartitionRead requests. The desired maximum number of partitions to - * return. For example, this may be set to the number of workers available. - * The default for this option is currently 10,000. The maximum value is - * currently 200,000. This is only a hint. The actual number of partitions - * returned may be smaller or larger than this maximum count request. + * **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request. */ maxPartitions?: string; /** - * **Note:** This hint is currently ignored by PartitionQuery and - * PartitionRead requests. The desired data size for each partition - * generated. The default for this option is currently 1 GiB. This is only - * a hint. The actual size of each partition may be smaller or larger than - * this size request. + * **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request. */ partitionSizeBytes?: string; } @@ -961,25 +650,11 @@ export namespace spanner_v1 { */ export interface Schema$PartitionQueryRequest { /** - * The SQL query string can contain parameter placeholders. A parameter - * placeholder consists of `'@'` followed by the parameter name. - * Parameter names consist of any combination of letters, numbers, and - * underscores. Parameters can appear anywhere that a literal value is - * expected. The same parameter name can be used more than once, for - * example: `"WHERE id > @msg_id AND id < @msg_id + 100"` - * It is an error to execute an SQL query with unbound parameters. Parameter - * values are specified using `params`, which is a JSON object whose keys - * are parameter names, and whose values are the corresponding parameter - * values. + * The SQL query string can contain parameter placeholders. A parameter placeholder consists of `'@'` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute an SQL query with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. */ params?: {[key: string]: any}; /** - * It is not always possible for Cloud Spanner to infer the right SQL type - * from a JSON value. For example, values of type `BYTES` and values of - * type `STRING` both appear in params as JSON strings. In these cases, - * `param_types` can be used to specify the exact SQL type for some or all - * of the SQL query parameters. See the definition of Type for more - * information about SQL types. + * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. */ paramTypes?: {[key: string]: Schema$Type}; /** @@ -987,19 +662,11 @@ export namespace spanner_v1 { */ partitionOptions?: Schema$PartitionOptions; /** - * The query request to generate partitions for. The request will fail if - * the query is not root partitionable. The query plan of a root - * partitionable query has a single distributed union operator. A - * distributed union operator conceptually divides one or more tables into - * multiple splits, remotely evaluates a subquery independently on each - * split, and then unions all results. This must not contain DML commands, - * such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a - * PartitionedDml transaction for large, partition-friendly DML operations. + * The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. */ sql?: string; /** - * Read only snapshot transactions are supported, read/write and single use - * transactions are not. + * Read only snapshot transactions are supported, read/write and single use transactions are not. */ transaction?: Schema$TransactionSelector; } @@ -1012,17 +679,11 @@ export namespace spanner_v1 { */ columns?: string[]; /** - * If non-empty, the name of an index on table. This index is used instead - * of the table primary key when interpreting key_set and sorting result - * rows. See key_set for further information. + * If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. */ index?: string; /** - * Required. `key_set` identifies the rows to be yielded. `key_set` names - * the primary keys of the rows in table to be yielded, unless index is - * present. If index is present, then key_set instead names index keys in - * index. It is not an error for the `key_set` to name rows that do not - * exist in the database. Read yields nothing for nonexistent rows. + * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. */ keySet?: Schema$KeySet; /** @@ -1034,8 +695,7 @@ export namespace spanner_v1 { */ table?: string; /** - * Read only snapshot transactions are supported, read/write and single use - * transactions are not. + * Read only snapshot transactions are supported, read/write and single use transactions are not. */ transaction?: Schema$TransactionSelector; } @@ -1065,10 +725,7 @@ export namespace spanner_v1 { */ displayName?: string; /** - * The execution statistics associated with the node, contained in a group - * of key-value pairs. Only present if the plan was returned as a result of - * a profile query. For example, number of executions, number of rows/time - * per execution etc. + * The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc. */ executionStats?: {[key: string]: any}; /** @@ -1076,17 +733,11 @@ export namespace spanner_v1 { */ index?: number; /** - * Used to determine the type of node. May be needed for visualizing - * different kinds of nodes differently. For example, If the node is a - * SCALAR node, it will have a condensed representation which can be used to - * directly embed a description of the node in its parent. + * Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent. */ kind?: string; /** - * Attributes relevant to the node contained in a group of key-value pairs. - * For example, a Parameter Reference node could have the following - * information in its metadata: { "parameter_reference": - * "param1", "parameter_type": "array" } + * Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" } */ metadata?: {[key: string]: any}; /** @@ -1095,41 +746,15 @@ export namespace spanner_v1 { shortRepresentation?: Schema$ShortRepresentation; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). + * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. + * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; /** @@ -1142,9 +767,7 @@ export namespace spanner_v1 { */ export interface Schema$QueryPlan { /** - * The nodes in the query plan. Plan nodes are returned in pre-order - * starting with the plan root. Each PlanNode's `id` corresponds to its - * index in `plan_nodes`. + * The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's `id` corresponds to its index in `plan_nodes`. */ planNodes?: Schema$PlanNode[]; } @@ -1153,56 +776,27 @@ export namespace spanner_v1 { */ export interface Schema$ReadOnly { /** - * Executes all reads at a timestamp that is `exact_staleness` old. The - * timestamp is chosen soon after the read is started. Guarantees that all - * writes that have committed more than the specified number of seconds ago - * are visible. Because Cloud Spanner chooses the exact timestamp, this mode - * works even if the client's local clock is substantially skewed from - * Cloud Spanner commit timestamps. Useful for reading at nearby replicas - * without the distributed timestamp negotiation overhead of - * `max_staleness`. + * Executes all reads at a timestamp that is `exact_staleness` old. The timestamp is chosen soon after the read is started. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of `max_staleness`. */ exactStaleness?: string; /** - * Read data at a timestamp >= `NOW - max_staleness` seconds. Guarantees - * that all writes that have committed more than the specified number of - * seconds ago are visible. Because Cloud Spanner chooses the exact - * timestamp, this mode works even if the client's local clock is - * substantially skewed from Cloud Spanner commit timestamps. Useful for - * reading the freshest data available at a nearby replica, while bounding - * the possible staleness if the local replica has fallen behind. Note that - * this option can only be used in single-use transactions. + * Read data at a timestamp >= `NOW - max_staleness` seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind. Note that this option can only be used in single-use transactions. */ maxStaleness?: string; /** - * Executes all reads at a timestamp >= `min_read_timestamp`. This is - * useful for requesting fresher data than some previous read, or data that - * is fresh enough to observe the effects of some previously committed - * transaction whose timestamp is known. Note that this option can only be - * used in single-use transactions. A timestamp in RFC3339 UTC - * \"Zulu\" format, accurate to nanoseconds. Example: - * `"2014-10-02T15:01:23.045123456Z"`. + * Executes all reads at a timestamp >= `min_read_timestamp`. This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known. Note that this option can only be used in single-use transactions. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */ minReadTimestamp?: string; /** - * Executes all reads at the given timestamp. Unlike other modes, reads at a - * specific timestamp are repeatable; the same read at the same timestamp - * always returns the same data. If the timestamp is in the future, the read - * will block until the specified timestamp, modulo the read's deadline. - * Useful for large scale consistent reads such as mapreduces, or for - * coordinating many reads against a consistent snapshot of the data. A - * timestamp in RFC3339 UTC \"Zulu\" format, accurate to - * nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. + * Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */ readTimestamp?: string; /** - * If true, the Cloud Spanner-selected read timestamp is included in the - * Transaction message that describes the transaction. + * If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction. */ returnReadTimestamp?: boolean; /** - * Read at a timestamp where all previously committed transactions are - * visible. + * Read at a timestamp where all previously committed transactions are visible. */ strong?: boolean; } @@ -1215,42 +809,23 @@ export namespace spanner_v1 { */ columns?: string[]; /** - * If non-empty, the name of an index on table. This index is used instead - * of the table primary key when interpreting key_set and sorting result - * rows. See key_set for further information. + * If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. */ index?: string; /** - * Required. `key_set` identifies the rows to be yielded. `key_set` names - * the primary keys of the rows in table to be yielded, unless index is - * present. If index is present, then key_set instead names index keys in - * index. If the partition_token field is empty, rows are yielded in table - * primary key order (if index is empty) or index key order (if index is - * non-empty). If the partition_token field is not empty, rows will be - * yielded in an unspecified order. It is not an error for the `key_set` to - * name rows that do not exist in the database. Read yields nothing for - * nonexistent rows. + * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. */ keySet?: Schema$KeySet; /** - * If greater than zero, only the first `limit` rows are yielded. If `limit` - * is zero, the default is no limit. A limit cannot be specified if - * `partition_token` is set. + * If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit cannot be specified if `partition_token` is set. */ limit?: string; /** - * If present, results will be restricted to the specified partition - * previously created using PartitionRead(). There must be an exact match - * for the values of fields common to this message and the - * PartitionReadRequest message used to create this partition_token. + * If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. */ partitionToken?: string; /** - * If this request is resuming a previously interrupted read, `resume_token` - * should be copied from the last PartialResultSet yielded before the - * interruption. Doing this enables the new read to resume where the last - * read left off. The rest of the request parameters must exactly match the - * request that yielded this token. + * If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. */ resumeToken?: string; /** @@ -1258,16 +833,28 @@ export namespace spanner_v1 { */ table?: string; /** - * The transaction to use. If none is provided, the default is a temporary - * read-only transaction with strong concurrency. + * The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. */ transaction?: Schema$TransactionSelector; } /** - * Message type to initiate a read-write transaction. Currently this - * transaction type has no options. + * Message type to initiate a read-write transaction. Currently this transaction type has no options. */ export interface Schema$ReadWrite {} + export interface Schema$ReplicaInfo { + /** + * If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. + */ + defaultLeaderLocation?: boolean; + /** + * The location of the serving resources, e.g. "us-central1". + */ + location?: string; + /** + * The type of replica. + */ + type?: string; + } /** * Results from Read or ExecuteSql. */ @@ -1277,19 +864,11 @@ export namespace spanner_v1 { */ metadata?: Schema$ResultSetMetadata; /** - * Each element in `rows` is a row whose format is defined by - * metadata.row_type. The ith element in each row matches the ith field in - * metadata.row_type. Elements are encoded based on type as described here. + * Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here. */ rows?: any[][]; /** - * Query plan and execution statistics for the SQL statement that produced - * this result set. These can be requested by setting - * ExecuteSqlRequest.query_mode. DML statements always produce stats - * containing the number of rows modified, unless executed using the - * ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other - * fields may or may not be populated, based on the - * ExecuteSqlRequest.query_mode. + * Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode. */ stats?: Schema$ResultSetStats; } @@ -1298,18 +877,11 @@ export namespace spanner_v1 { */ export interface Schema$ResultSetMetadata { /** - * Indicates the field names and types for the rows in the result set. For - * example, a SQL query like `"SELECT UserId, UserName FROM - * Users"` could return a `row_type` value like: "fields": [ - * { "name": "UserId", "type": { - * "code": "INT64" } }, { "name": - * "UserName", "type": { "code": - * "STRING" } }, ] + * Indicates the field names and types for the rows in the result set. For example, a SQL query like `"SELECT UserId, UserName FROM Users"` could return a `row_type` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ] */ rowType?: Schema$StructType; /** - * If the read or SQL query began a transaction as a side-effect, the - * information about the new transaction is yielded here. + * If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here. */ transaction?: Schema$Transaction; } @@ -1322,11 +894,7 @@ export namespace spanner_v1 { */ queryPlan?: Schema$QueryPlan; /** - * Aggregated statistics from the execution of the query. Only present when - * the query is profiled. For example, a query could return the statistics - * as follows: { "rows_returned": "3", - * "elapsed_time": "1.22 secs", "cpu_time": - * "1.19 secs" } + * Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" } */ queryStats?: {[key: string]: any}; /** @@ -1334,8 +902,7 @@ export namespace spanner_v1 { */ rowCountExact?: string; /** - * Partitioned DML does not offer exactly-once semantics, so it returns a - * lower bound of the rows modified. + * Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified. */ rowCountLowerBound?: string; } @@ -1353,8 +920,7 @@ export namespace spanner_v1 { */ export interface Schema$Session { /** - * Output only. The approximate timestamp when the session is last used. It - * is typically earlier than the actual last use time. + * Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. */ approximateLastUseTime?: string; /** @@ -1362,18 +928,11 @@ export namespace spanner_v1 { */ createTime?: string; /** - * The labels for the session. * Label keys must be between 1 and 63 - * characters long and must conform to the following regular expression: - * `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 - * characters long and must conform to the regular expression - * `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be - * associated with a given session. See https://goo.gl/xmQnxf for more - * information on and examples of labels. + * The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. */ labels?: {[key: string]: string}; /** - * The name of the session. This is always system-assigned; values provided - * when creating a session are ignored. + * The name of the session. This is always system-assigned; values provided when creating a session are ignored. */ name?: string; } @@ -1382,16 +941,12 @@ export namespace spanner_v1 { */ export interface Schema$SetIamPolicyRequest { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. */ policy?: Schema$Policy; } /** - * Condensed representation of a node and its subtree. Only present for - * `SCALAR` PlanNode(s). + * Condensed representation of a node and its subtree. Only present for `SCALAR` PlanNode(s). */ export interface Schema$ShortRepresentation { /** @@ -1399,11 +954,7 @@ export namespace spanner_v1 { */ description?: string; /** - * A mapping of (subquery variable name) -> (subquery node id) for cases - * where the `description` string of this node references a `SCALAR` - * subquery contained in the expression subtree rooted at this node. The - * referenced `SCALAR` subquery may not necessarily be a direct child of - * this node. + * A mapping of (subquery variable name) -> (subquery node id) for cases where the `description` string of this node references a `SCALAR` subquery contained in the expression subtree rooted at this node. The referenced `SCALAR` subquery may not necessarily be a direct child of this node. */ subqueries?: {[key: string]: number}; } @@ -1412,25 +963,11 @@ export namespace spanner_v1 { */ export interface Schema$Statement { /** - * The DML string can contain parameter placeholders. A parameter - * placeholder consists of `'@'` followed by the parameter name. - * Parameter names consist of any combination of letters, numbers, and - * underscores. Parameters can appear anywhere that a literal value is - * expected. The same parameter name can be used more than once, for - * example: `"WHERE id > @msg_id AND id < @msg_id + 100"` - * It is an error to execute an SQL statement with unbound parameters. - * Parameter values are specified using `params`, which is a JSON object - * whose keys are parameter names, and whose values are the corresponding - * parameter values. + * The DML string can contain parameter placeholders. A parameter placeholder consists of `'@'` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. */ params?: {[key: string]: any}; /** - * It is not always possible for Cloud Spanner to infer the right SQL type - * from a JSON value. For example, values of type `BYTES` and values of - * type `STRING` both appear in params as JSON strings. In these cases, - * `param_types` can be used to specify the exact SQL type for some or all - * of the SQL statement parameters. See the definition of Type for more - * information about SQL types. + * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */ paramTypes?: {[key: string]: Schema$Type}; /** @@ -1439,40 +976,7 @@ export namespace spanner_v1 { sql?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -1480,14 +984,11 @@ export namespace spanner_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1496,11 +997,7 @@ export namespace spanner_v1 { */ export interface Schema$StructType { /** - * The list of fields that make up this struct. Order is significant, - * because values of this struct type are represented as lists, where the - * order of field values matches the order of fields in the StructType. In - * turn, the order of fields matches the order of columns in a read request, - * or the order of fields in the `SELECT` clause of a query. + * The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query. */ fields?: Schema$Field[]; } @@ -1509,9 +1006,7 @@ export namespace spanner_v1 { */ export interface Schema$TestIamPermissionsRequest { /** - * REQUIRED: The set of permissions to check for 'resource'. - * Permissions with wildcards (such as '*', 'spanner.*', - * 'spanner.instances.*') are not allowed. + * REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed. */ permissions?: string[]; } @@ -1520,8 +1015,7 @@ export namespace spanner_v1 { */ export interface Schema$TestIamPermissionsResponse { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } @@ -1530,221 +1024,37 @@ export namespace spanner_v1 { */ export interface Schema$Transaction { /** - * `id` may be used to identify the transaction in subsequent Read, - * ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions - * do not have IDs, because single-use transactions do not support multiple - * requests. + * `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests. */ id?: string; /** - * For snapshot read-only transactions, the read timestamp chosen for the - * transaction. Not returned by default: see - * TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in - * RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: - * `"2014-10-02T15:01:23.045123456Z"`. + * For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */ readTimestamp?: string; } /** - * # Transactions Each session can have at most one active transaction at a - * time. After the active transaction is completed, the session can - * immediately be re-used for the next transaction. It is not necessary to - * create a new session for each transaction. # Transaction Modes Cloud - * Spanner supports three transaction modes: 1. Locking read-write. This - * type of transaction is the only way to write data into Cloud Spanner. - * These transactions rely on pessimistic locking and, if necessary, - * two-phase commit. Locking read-write transactions may abort, requiring - * the application to retry. 2. Snapshot read-only. This transaction - * type provides guaranteed consistency across several reads, but does - * not allow writes. Snapshot read-only transactions can be configured to - * read at timestamps in the past. Snapshot read-only transactions do not - * need to be committed. 3. Partitioned DML. This type of transaction is - * used to execute a single Partitioned DML statement. Partitioned DML - * partitions the key space and runs the DML statement over each - * partition in parallel using separate, internal transactions that - * commit independently. Partitioned DML transactions do not need to be - * committed. For transactions that only read, snapshot read-only - * transactions provide simpler semantics and are almost always faster. In - * particular, read-only transactions do not take locks, so they do not - * conflict with read-write transactions. As a consequence of not taking - * locks, they also do not abort, so retry loops are not needed. Transactions - * may only read/write data in a single database. They may, however, - * read/write data in different tables within that database. ## Locking - * Read-Write Transactions Locking transactions may be used to atomically - * read-modify-write data anywhere in a database. This type of transaction is - * externally consistent. Clients should attempt to minimize the amount of - * time a transaction is active. Faster transactions commit with higher - * probability and cause less contention. Cloud Spanner attempts to keep read - * locks active as long as the transaction continues to do reads, and the - * transaction has not been terminated by Commit or Rollback. Long periods of - * inactivity at the client may cause Cloud Spanner to release a - * transaction's locks and abort it. Conceptually, a read-write - * transaction consists of zero or more reads or SQL statements followed by - * Commit. At any time before Commit, the client can send a Rollback request - * to abort the transaction. ### Semantics Cloud Spanner can commit the - * transaction if all read locks it acquired are still valid at commit time, - * and it is able to acquire write locks for all writes. Cloud Spanner can - * abort the transaction for any reason. If a commit attempt returns - * `ABORTED`, Cloud Spanner guarantees that the transaction has not modified - * any user data in Cloud Spanner. Unless the transaction commits, Cloud - * Spanner makes no guarantees about how long the transaction's locks were - * held for. It is an error to use Cloud Spanner locks for any sort of mutual - * exclusion other than between Cloud Spanner transactions themselves. ### - * Retrying Aborted Transactions When a transaction aborts, the application - * can choose to retry the whole transaction again. To maximize the chances of - * successfully committing the retry, the client should execute the retry in - * the same session as the original attempt. The original session's lock - * priority increases with each consecutive abort, meaning that each attempt - * has a slightly better chance of success than the previous. Under some - * circumstances (e.g., many transactions attempting to modify the same - * row(s)), a transaction can abort many times in a short period before - * successfully committing. Thus, it is not a good idea to cap the number of - * retries a transaction can attempt; instead, it is better to limit the total - * amount of wall time spent retrying. ### Idle Transactions A transaction - * is considered idle if it has no outstanding reads or SQL queries and has - * not started a read or SQL query within the last 10 seconds. Idle - * transactions can be aborted by Cloud Spanner so that they don't hold on - * to locks indefinitely. In that case, the commit will fail with error - * `ABORTED`. If this behavior is undesirable, periodically executing a - * simple SQL query in the transaction (e.g., `SELECT 1`) prevents the - * transaction from becoming idle. ## Snapshot Read-Only Transactions - * Snapshot read-only transactions provides a simpler method than locking - * read-write transactions for doing several consistent reads. However, this - * type of transaction does not support writes. Snapshot transactions do not - * take locks. Instead, they work by choosing a Cloud Spanner timestamp, then - * executing all reads at that timestamp. Since they do not acquire locks, - * they do not block concurrent read-write transactions. Unlike locking - * read-write transactions, snapshot read-only transactions never abort. They - * can fail if the chosen read timestamp is garbage collected; however, the - * default garbage collection policy is generous enough that most applications - * do not need to worry about this in practice. Snapshot read-only - * transactions do not need to call Commit or Rollback (and in fact are not - * permitted to do so). To execute a snapshot transaction, the client - * specifies a timestamp bound, which tells Cloud Spanner how to choose a read - * timestamp. The types of timestamp bound are: - Strong (the default). - - * Bounded staleness. - Exact staleness. If the Cloud Spanner database to - * be read is geographically distributed, stale read-only transactions can - * execute more quickly than strong or read-write transaction, because they - * are able to execute far from the leader replica. Each type of timestamp - * bound is discussed in detail below. ### Strong Strong reads are - * guaranteed to see the effects of all transactions that have committed - * before the start of the read. Furthermore, all rows yielded by a single - * read are consistent with each other -- if any part of the read observes a - * transaction, all parts of the read see the transaction. Strong reads are - * not repeatable: two consecutive strong read-only transactions might return - * inconsistent results if there are concurrent writes. If consistency across - * reads is required, the reads should be executed within a transaction or at - * an exact read timestamp. See TransactionOptions.ReadOnly.strong. ### - * Exact Staleness These timestamp bounds execute reads at a user-specified - * timestamp. Reads at a timestamp are guaranteed to see a consistent prefix - * of the global transaction history: they observe modifications done by all - * transactions with a commit timestamp <= the read timestamp, and observe - * none of the modifications done by transactions with a larger commit - * timestamp. They will block until all conflicting transactions that may be - * assigned commit timestamps <= the read timestamp have finished. The - * timestamp can either be expressed as an absolute Cloud Spanner commit - * timestamp or a staleness relative to the current time. These modes do not - * require a "negotiation phase" to pick a timestamp. As a result, - * they execute slightly faster than the equivalent boundedly stale - * concurrency modes. On the other hand, boundedly stale reads usually return - * fresher results. See TransactionOptions.ReadOnly.read_timestamp and - * TransactionOptions.ReadOnly.exact_staleness. ### Bounded Staleness Bounded - * staleness modes allow Cloud Spanner to pick the read timestamp, subject to - * a user-provided staleness bound. Cloud Spanner chooses the newest timestamp - * within the staleness bound that allows execution of the reads at the - * closest available replica without blocking. All rows yielded are - * consistent with each other -- if any part of the read observes a - * transaction, all parts of the read see the transaction. Boundedly stale - * reads are not repeatable: two stale reads, even if they use the same - * staleness bound, can execute at different timestamps and thus return - * inconsistent results. Boundedly stale reads execute in two phases: the - * first phase negotiates a timestamp among all replicas needed to serve the - * read. In the second phase, reads are executed at the negotiated timestamp. - * As a result of the two phase execution, bounded staleness reads are usually - * a little slower than comparable exact staleness reads. However, they are - * typically able to return fresher results, and are more likely to execute at - * the closest replica. Because the timestamp negotiation requires up-front - * knowledge of which rows will be read, it can only be used with single-use - * read-only transactions. See TransactionOptions.ReadOnly.max_staleness and - * TransactionOptions.ReadOnly.min_read_timestamp. ### Old Read Timestamps - * and Garbage Collection Cloud Spanner continuously garbage collects deleted - * and overwritten data in the background to reclaim storage space. This - * process is known as "version GC". By default, version GC reclaims - * versions after they are one hour old. Because of this, Cloud Spanner cannot - * perform reads at read timestamps more than one hour in the past. This - * restriction also applies to in-progress reads and/or SQL queries whose - * timestamp become too old while executing. Reads and SQL queries with - * too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## - * Partitioned DML Transactions Partitioned DML transactions are used to - * execute DML statements with a different execution strategy that provides - * different, and often better, scalability properties for large, table-wide - * operations than DML in a ReadWrite transaction. Smaller scoped statements, - * such as an OLTP workload, should prefer using ReadWrite transactions. - * Partitioned DML partitions the keyspace and runs the DML statement on each - * partition in separate, internal transactions. These transactions commit - * automatically when complete, and run independently from one another. To - * reduce lock contention, this execution strategy only acquires read locks on - * rows that match the WHERE clause of the statement. Additionally, the - * smaller per-partition transactions hold locks for less time. That said, - * Partitioned DML is not a drop-in replacement for standard DML used in - * ReadWrite transactions. - The DML statement must be fully-partitionable. - * Specifically, the statement must be expressible as the union of many - * statements which each access only a single row of the table. - The - * statement is not applied atomically to all rows of the table. Rather, the - * statement is applied atomically to partitions of the table, in independent - * transactions. Secondary index rows are updated atomically with the base - * table rows. - Partitioned DML does not guarantee exactly-once execution - * semantics against a partition. The statement will be applied at least - * once to each partition. It is strongly recommended that the DML - * statement should be idempotent to avoid unexpected results. For - * instance, it is potentially dangerous to run a statement such as `UPDATE - * table SET column = column + 1` as it could be run multiple times against - * some rows. - The partitions are committed automatically - there is no - * support for Commit or Rollback. If the call returns an error, or if the - * client issuing the ExecuteSql call dies, it is possible that some rows - * had the statement executed on them successfully. It is also possible - * that statement was never executed against other rows. - Partitioned - * DML transactions may only contain the execution of a single DML - * statement via ExecuteSql or ExecuteStreamingSql. - If any error is - * encountered during the execution of the partitioned DML operation (for - * instance, a UNIQUE INDEX violation, division by zero, or a value that - * cannot be stored due to schema constraints), then the operation is - * stopped at that point and an error is returned. It is possible that at - * this point, some partitions have been committed (or even committed - * multiple times), and other partitions have not been run at all. Given the - * above, Partitioned DML is good fit for large, database-wide, operations - * that are idempotent, such as deleting old rows from a very large table. + * # Transactions Each session can have at most one active transaction at a time. After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. # Transaction Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. This transaction type provides guaranteed consistency across several reads, but does not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past. Snapshot read-only transactions do not need to be committed. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read/write data in a single database. They may, however, read/write data in different tables within that database. ## Locking Read-Write Transactions Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. ### Semantics Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. ### Retrying Aborted Transactions When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (e.g., many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of wall time spent retrying. ### Idle Transactions A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. In that case, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transaction, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. ### Strong Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. See TransactionOptions.ReadOnly.strong. ### Exact Staleness These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp <= the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded Staleness Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## Partitioned DML Transactions Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table. */ export interface Schema$TransactionOptions { /** - * Partitioned DML transaction. Authorization to begin a Partitioned DML - * transaction requires `spanner.databases.beginPartitionedDmlTransaction` - * permission on the `session` resource. + * Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource. */ partitionedDml?: Schema$PartitionedDml; /** - * Transaction will not write. Authorization to begin a read-only - * transaction requires `spanner.databases.beginReadOnlyTransaction` - * permission on the `session` resource. + * Transaction will not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource. */ readOnly?: Schema$ReadOnly; /** - * Transaction may write. Authorization to begin a read-write transaction - * requires `spanner.databases.beginOrRollbackReadWriteTransaction` - * permission on the `session` resource. + * Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. */ readWrite?: Schema$ReadWrite; } /** - * This message is used to select the transaction in which a Read or - * ExecuteSql call runs. See TransactionOptions for more information about - * transactions. + * This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions. */ export interface Schema$TransactionSelector { /** - * Begin a new transaction and execute this read or SQL query in it. The - * transaction ID of the new transaction is returned in - * ResultSetMetadata.transaction, which is a Transaction. + * Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in ResultSetMetadata.transaction, which is a Transaction. */ begin?: Schema$TransactionOptions; /** @@ -1752,20 +1062,16 @@ export namespace spanner_v1 { */ id?: string; /** - * Execute the read or SQL query in a temporary transaction. This is the - * most efficient way to execute a transaction that consists of a single SQL - * query. + * Execute the read or SQL query in a temporary transaction. This is the most efficient way to execute a transaction that consists of a single SQL query. */ singleUse?: Schema$TransactionOptions; } /** - * `Type` indicates the type of a Cloud Spanner value, as might be stored in a - * table cell or returned from an SQL query. + * `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. */ export interface Schema$Type { /** - * If code == ARRAY, then `array_element_type` is the type of the array - * elements. + * If code == ARRAY, then `array_element_type` is the type of the array elements. */ arrayElementType?: Schema$Type; /** @@ -1773,8 +1079,7 @@ export namespace spanner_v1 { */ code?: string; /** - * If code == STRUCT, then `struct_type` provides type information for the - * struct's fields. + * If code == STRUCT, then `struct_type` provides type information for the struct's fields. */ structType?: Schema$StructType; } @@ -1783,9 +1088,7 @@ export namespace spanner_v1 { */ export interface Schema$UpdateDatabaseDdlMetadata { /** - * Reports the commit timestamps of all statements that have succeeded so - * far, where `commit_timestamps[i]` is the commit timestamp for the - * statement `statements[i]`. + * Reports the commit timestamps of all statements that have succeeded so far, where `commit_timestamps[i]` is the commit timestamp for the statement `statements[i]`. */ commitTimestamps?: string[]; /** @@ -1793,38 +1096,16 @@ export namespace spanner_v1 { */ database?: string; /** - * For an update this list contains all the statements. For an individual - * statement, this list contains only that statement. + * For an update this list contains all the statements. For an individual statement, this list contains only that statement. */ statements?: string[]; } /** - * Enqueues the given DDL statements to be applied, in order but not - * necessarily all at once, to the database schema at some point (or points) - * in the future. The server checks that the statements are executable - * (syntactically valid, name tables that exist, etc.) before enqueueing them, - * but they may still fail upon later execution (e.g., if a statement from - * another batch of statements is applied first and it conflicts in some way, - * or if there is some data-related problem like a `NULL` value in a column to - * which `NOT NULL` would be added). If a statement fails, all subsequent - * statements in the batch are automatically cancelled. Each batch of - * statements is assigned a name which can be used with the Operations API to - * monitor progress. See the operation_id field for more details. + * Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details. */ export interface Schema$UpdateDatabaseDdlRequest { /** - * If empty, the new update request is assigned an automatically-generated - * operation ID. Otherwise, `operation_id` is used to construct the name of - * the resulting Operation. Specifying an explicit operation ID simplifies - * determining whether the statements were executed in the event that the - * UpdateDatabaseDdl call is replayed, or the return value is otherwise - * lost: the database and `operation_id` fields can be combined to form the - * name of the resulting longrunning.Operation: - * `<database>/operations/<operation_id>`. `operation_id` - * should be unique within the database, and must be a valid identifier: - * `a-z*`. Note that automatically-generated operation IDs always begin with - * an underscore. If the named operation already exists, UpdateDatabaseDdl - * returns `ALREADY_EXISTS`. + * If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the name of the resulting longrunning.Operation: `<database>/operations/<operation_id>`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`. */ operationId?: string; /** @@ -1837,9 +1118,7 @@ export namespace spanner_v1 { */ export interface Schema$UpdateInstanceMetadata { /** - * The time at which this operation was cancelled. If set, this operation is - * in the process of undoing itself (which is guaranteed to succeed) and - * cannot be cancelled again. + * The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. */ cancelTime?: string; /** @@ -1860,18 +1139,11 @@ export namespace spanner_v1 { */ export interface Schema$UpdateInstanceRequest { /** - * Required. A mask specifying which fields in - * [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] - * should be updated. The field mask must always be specified; this prevents - * any future fields in [][google.spanner.admin.instance.v1.Instance] from - * being erased accidentally by clients that do not know about them. + * Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated. The field mask must always be specified; this prevents any future fields in [][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them. */ fieldMask?: string; /** - * Required. The instance to update, which must always include the instance - * name. Otherwise, only fields mentioned in - * [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] - * need be included. + * Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included. */ instance?: Schema$Instance; } @@ -1880,9 +1152,7 @@ export namespace spanner_v1 { */ export interface Schema$Write { /** - * The names of the columns in table to be written. The list of columns - * must contain enough columns to allow Cloud Spanner to derive values for - * all primary key columns in the row(s) to be modified. + * The names of the columns in table to be written. The list of columns must contain enough columns to allow Cloud Spanner to derive values for all primary key columns in the row(s) to be modified. */ columns?: string[]; /** @@ -1890,13 +1160,7 @@ export namespace spanner_v1 { */ table?: string; /** - * The values to be written. `values` can contain more than one list of - * values. If it does, then multiple rows are written, one for each entry in - * `values`. Each list in `values` must have exactly as many entries as - * there are entries in columns above. Sending multiple lists is equivalent - * to sending multiple `Mutation`s, each containing one `values` entry and - * repeating table and columns. Individual values in each list are encoded - * as described here. + * The values to be written. `values` can contain more than one list of values. If it does, then multiple rows are written, one for each entry in `values`. Each list in `values` must have exactly as many entries as there are entries in columns above. Sending multiple lists is equivalent to sending multiple `Mutation`s, each containing one `values` entry and repeating table and columns. Individual values in each list are encoded as described here. */ values?: any[][]; } @@ -2083,8 +1347,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the requested instance configuration. Values are of - * the form `projects//instanceConfigs/`. + * Required. The name of the requested instance configuration. Values are of the form `projects//instanceConfigs/`. */ name?: string; } @@ -2096,18 +1359,15 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Number of instance configurations to be returned in the response. If 0 or - * less, defaults to the server's maximum allowed page size. + * Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */ pageSize?: number; /** - * If non-empty, `page_token` should contain a next_page_token from a - * previous ListInstanceConfigsResponse. + * If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse. */ pageToken?: string; /** - * Required. The name of the project for which a list of supported instance - * configurations is requested. Values are of the form `projects/`. + * Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. */ parent?: string; } @@ -2126,26 +1386,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.create - * @desc Creates an instance and begins preparing it to begin serving. The - * returned long-running operation can be used to track the progress of - * preparing the new instance. The instance name is assigned by the caller. - * If the named instance already exists, `CreateInstance` returns - * `ALREADY_EXISTS`. Immediately upon completion of this request: * The - * instance is readable via the API, with all requested attributes but - * no allocated resources. Its state is `CREATING`. Until completion of the - * returned operation: * Cancelling the operation renders the instance - * immediately unreadable via the API. * The instance can be deleted. - * * All other attempts to modify the instance are rejected. Upon - * completion of the returned operation: * Billing for all - * successfully-allocated resources begins (some types may have lower - * than the requested levels). * Databases can be created in the instance. - * * The instance's allocated resource levels are readable via the API. * - * The instance's state becomes `READY`. The returned long-running - * operation will have a name of the format - * `/operations/` and can be used to track - * creation of the instance. The metadata field type is - * CreateInstanceMetadata. The response field type is Instance, if - * successful. + * @desc Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful. * @alias spanner.projects.instances.create * @memberOf! () * @@ -2220,11 +1461,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.delete - * @desc Deletes an instance. Immediately upon completion of the request: - * * Billing ceases for all of the instance's reserved resources. Soon - * afterward: * The instance and *all of its databases* immediately and - * irrevocably disappear from the API. All data in the databases is - * permanently deleted. + * @desc Deletes an instance. Immediately upon completion of the request: * Billing ceases for all of the instance's reserved resources. Soon afterward: * The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted. * @alias spanner.projects.instances.delete * @memberOf! () * @@ -2362,9 +1599,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.getIamPolicy - * @desc Gets the access control policy for an instance resource. Returns an - * empty policy if an instance exists but does not have a policy set. - * Authorization requires `spanner.instances.getIamPolicy` on resource. + * @desc Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Authorization requires `spanner.instances.getIamPolicy` on resource. * @alias spanner.projects.instances.getIamPolicy * @memberOf! () * @@ -2516,29 +1751,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.patch - * @desc Updates an instance, and begins allocating or releasing resources - * as requested. The returned long-running operation can be used to track - * the progress of updating the instance. If the named instance does not - * exist, returns `NOT_FOUND`. Immediately upon completion of this request: - * * For resource types for which a decrease in the instance's allocation - * has been requested, billing is based on the newly-requested level. Until - * completion of the returned operation: * Cancelling the operation sets - * its metadata's cancel_time, and begins restoring resources to - * their pre-request values. The operation is guaranteed to succeed at - * undoing all resource changes, after which point it terminates with a - * `CANCELLED` status. * All other attempts to modify the instance are - * rejected. * Reading the instance via the API continues to give the - * pre-request resource levels. Upon completion of the returned - * operation: * Billing begins for all successfully-allocated resources - * (some types may have lower than the requested levels). * All - * newly-reserved resources are available for serving the instance's tables. - * * The instance's new resource levels are readable via the API. The - * returned long-running operation will have a name of the format - * `/operations/` and can be used to track the - * instance modification. The metadata field type is - * UpdateInstanceMetadata. The response field type is Instance, if - * successful. Authorization requires `spanner.instances.update` permission - * on resource name. + * @desc Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on resource name. * @alias spanner.projects.instances.patch * @memberOf! () * @@ -2610,9 +1823,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.setIamPolicy - * @desc Sets the access control policy on an instance resource. Replaces - * any existing policy. Authorization requires - * `spanner.instances.setIamPolicy` on resource. + * @desc Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires `spanner.instances.setIamPolicy` on resource. * @alias spanner.projects.instances.setIamPolicy * @memberOf! () * @@ -2685,11 +1896,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.testIamPermissions - * @desc Returns permissions that the caller has on the specified instance - * resource. Attempting this RPC on a non-existent Cloud Spanner instance - * resource will result in a NOT_FOUND error if the user has - * `spanner.instances.list` permission on the containing Google Cloud - * Project. Otherwise returns an empty set of permissions. + * @desc Returns permissions that the caller has on the specified instance resource. Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions. * @alias spanner.projects.instances.testIamPermissions * @memberOf! () * @@ -2778,8 +1985,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the project in which to create the instance. Values - * are of the form `projects/`. + * Required. The name of the project in which to create the instance. Values are of the form `projects/`. */ parent?: string; @@ -2796,8 +2002,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the instance to be deleted. Values are of the form - * `projects//instances/` + * Required. The name of the instance to be deleted. Values are of the form `projects//instances/` */ name?: string; } @@ -2809,8 +2014,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the requested instance. Values are of the form - * `projects//instances/`. + * Required. The name of the requested instance. Values are of the form `projects//instances/`. */ name?: string; } @@ -2822,10 +2026,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The Cloud Spanner resource for which the policy is being - * retrieved. The format is `projects//instances/` - * for instance resources and `projects//instances//databases/` for database resources. + * REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. */ resource?: string; @@ -2842,32 +2043,19 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An expression for filtering the results of the request. Filter rules are - * case insensitive. The fields eligible for filtering are: * `name` * - * `display_name` * `labels.key` where key is the name of a label Some - * examples of using filters are: * `name:*` --> The instance has a name. - * * `name:Howl` --> The instance's name contains the string "howl". * - * `name:HOWL` --> Equivalent to above. * `NAME:howl` --> Equivalent to - * above. * `labels.env:*` --> The instance has the label "env". * - * `labels.env:dev` --> The instance has the label "env" and the value of - * the label contains the string "dev". * `name:howl labels.env:dev` --> - * The instance's name contains "howl" and it has the label "env" with its - * value containing "dev". + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `display_name` * `labels.key` where key is the name of a label Some examples of using filters are: * `name:*` --> The instance has a name. * `name:Howl` --> The instance's name contains the string "howl". * `name:HOWL` --> Equivalent to above. * `NAME:howl` --> Equivalent to above. * `labels.env:*` --> The instance has the label "env". * `labels.env:dev` --> The instance has the label "env" and the value of the label contains the string "dev". * `name:howl labels.env:dev` --> The instance's name contains "howl" and it has the label "env" with its value containing "dev". */ filter?: string; /** - * Number of instances to be returned in the response. If 0 or less, - * defaults to the server's maximum allowed page size. + * Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */ pageSize?: number; /** - * If non-empty, `page_token` should contain a next_page_token from a - * previous ListInstancesResponse. + * If non-empty, `page_token` should contain a next_page_token from a previous ListInstancesResponse. */ pageToken?: string; /** - * Required. The name of the project for which a list of instances is - * requested. Values are of the form `projects/`. + * Required. The name of the project for which a list of instances is requested. Values are of the form `projects/`. */ parent?: string; } @@ -2879,10 +2067,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A unique identifier for the instance, which cannot be changed - * after the instance is created. Values are of the form - * `projects//instances/a-z*[a-z0-9]`. The final segment of the - * name must be between 2 and 64 characters in length. + * Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. */ name?: string; @@ -2899,10 +2084,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The Cloud Spanner resource for which the policy is being set. - * The format is `projects//instances/` for - * instance resources and `projects//instances//databases/` for databases resources. + * REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. */ resource?: string; @@ -2919,10 +2101,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The Cloud Spanner resource for which permissions are being - * tested. The format is `projects//instances/` for - * instance resources and `projects//instances//databases/` for database resources. + * REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. */ resource?: string; @@ -2948,12 +2127,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.create - * @desc Creates a new Cloud Spanner database and starts to prepare it for - * serving. The returned long-running operation will have a name of the - * format `/operations/` and can be used to - * track preparation of the database. The metadata field type is - * CreateDatabaseMetadata. The response field type is Database, if - * successful. + * @desc Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. * @alias spanner.projects.instances.databases.create * @memberOf! () * @@ -3166,9 +2340,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.getDdl - * @desc Returns the schema of a Cloud Spanner database as a list of - * formatted DDL statements. This method does not show pending schema - * updates, those may be queried using the Operations API. + * @desc Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API. * @alias spanner.projects.instances.databases.getDdl * @memberOf! () * @@ -3244,10 +2416,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.getIamPolicy - * @desc Gets the access control policy for a database resource. Returns an - * empty policy if a database exists but does not have a policy set. - * Authorization requires `spanner.databases.getIamPolicy` permission on - * resource. + * @desc Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. * @alias spanner.projects.instances.databases.getIamPolicy * @memberOf! () * @@ -3398,9 +2567,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.setIamPolicy - * @desc Sets the access control policy on a database resource. Replaces any - * existing policy. Authorization requires `spanner.databases.setIamPolicy` - * permission on resource. + * @desc Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. * @alias spanner.projects.instances.databases.setIamPolicy * @memberOf! () * @@ -3473,11 +2640,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.testIamPermissions - * @desc Returns permissions that the caller has on the specified database - * resource. Attempting this RPC on a non-existent Cloud Spanner database - * will result in a NOT_FOUND error if the user has `spanner.databases.list` - * permission on the containing Cloud Spanner instance. Otherwise returns an - * empty set of permissions. + * @desc Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. * @alias spanner.projects.instances.databases.testIamPermissions * @memberOf! () * @@ -3559,12 +2722,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.updateDdl - * @desc Updates the schema of a Cloud Spanner database by - * creating/altering/dropping tables, columns, indexes, etc. The returned - * long-running operation will have a name of the format - * `/operations/` and can be used to track - * execution of the schema change(s). The metadata field type is - * UpdateDatabaseDdlMetadata. The operation has no response. + * @desc Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response. * @alias spanner.projects.instances.databases.updateDdl * @memberOf! () * @@ -3646,8 +2804,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the instance that will serve the new database. - * Values are of the form `projects//instances/`. + * Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`. */ parent?: string; @@ -3676,8 +2833,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the requested database. Values are of the form - * `projects//instances//databases/`. + * Required. The name of the requested database. Values are of the form `projects//instances//databases/`. */ name?: string; } @@ -3701,10 +2857,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The Cloud Spanner resource for which the policy is being - * retrieved. The format is `projects//instances/` - * for instance resources and `projects//instances//databases/` for database resources. + * REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. */ resource?: string; @@ -3721,18 +2874,15 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Number of databases to be returned in the response. If 0 or less, - * defaults to the server's maximum allowed page size. + * Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */ pageSize?: number; /** - * If non-empty, `page_token` should contain a next_page_token from a - * previous ListDatabasesResponse. + * If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse. */ pageToken?: string; /** - * Required. The instance whose databases should be listed. Values are of - * the form `projects//instances/`. + * Required. The instance whose databases should be listed. Values are of the form `projects//instances/`. */ parent?: string; } @@ -3744,10 +2894,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The Cloud Spanner resource for which the policy is being set. - * The format is `projects//instances/` for - * instance resources and `projects//instances//databases/` for databases resources. + * REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. */ resource?: string; @@ -3764,10 +2911,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * REQUIRED: The Cloud Spanner resource for which permissions are being - * tested. The format is `projects//instances/` for - * instance resources and `projects//instances//databases/` for database resources. + * REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. */ resource?: string; @@ -3802,15 +2946,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias spanner.projects.instances.databases.operations.cancel * @memberOf! () * @@ -3879,10 +3015,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias spanner.projects.instances.databases.operations.delete * @memberOf! () * @@ -3951,9 +3084,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias spanner.projects.instances.databases.operations.get * @memberOf! () * @@ -4024,15 +3155,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias spanner.projects.instances.databases.operations.list * @memberOf! () * @@ -4176,8 +3299,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.beginTransaction - * @desc Begins a new transaction. This step can often be skipped: Read, - * ExecuteSql and Commit can begin a new transaction as a side-effect. + * @desc Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect. * @alias spanner.projects.instances.databases.sessions.beginTransaction * @memberOf! () * @@ -4252,12 +3374,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.commit - * @desc Commits a transaction. The request includes the mutations to be - * applied to rows in the database. `Commit` might return an `ABORTED` - * error. This can occur at any time; commonly, the cause is conflicts with - * concurrent transactions. However, it can also happen for a variety of - * other reasons. If `Commit` returns `ABORTED`, the caller should - * re-attempt the transaction from the beginning, re-using the same session. + * @desc Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. * @alias spanner.projects.instances.databases.sessions.commit * @memberOf! () * @@ -4332,19 +3449,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.create - * @desc Creates a new session. A session can be used to perform - * transactions that read and/or modify data in a Cloud Spanner database. - * Sessions are meant to be reused for many consecutive transactions. - * Sessions can only execute one transaction at a time. To execute multiple - * concurrent read-write/write-only transactions, create multiple sessions. - * Note that standalone reads and queries use a transaction internally, and - * count toward the one transaction limit. Cloud Spanner limits the number - * of sessions that can exist at any given time; thus, it is a good idea to - * delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud - * Spanner can delete sessions for which no operations are sent for more - * than an hour. If a session is deleted, requests to it return `NOT_FOUND`. - * Idle sessions can be kept alive by sending a trivial SQL query - * periodically, e.g., `"SELECT 1"`. + * @desc Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. * @alias spanner.projects.instances.databases.sessions.create * @memberOf! () * @@ -4417,9 +3522,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.delete - * @desc Ends a session, releasing server resources associated with it. This - * will asynchronously trigger cancellation of any operations that are - * running with this session. + * @desc Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. * @alias spanner.projects.instances.databases.sessions.delete * @memberOf! () * @@ -4488,18 +3591,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.executeBatchDml - * @desc Executes a batch of SQL DML statements. This method allows many - * statements to be run with lower latency than submitting them sequentially - * with ExecuteSql. Statements are executed in order, sequentially. - * ExecuteBatchDmlResponse will contain a ResultSet for each DML statement - * that has successfully executed. If a statement fails, its error status - * will be returned as part of the ExecuteBatchDmlResponse. Execution will - * stop at the first failed statement; the remaining statements will not - * run. ExecuteBatchDml is expected to return an OK status with a response - * even if there was an error while processing one of the DML statements. - * Clients must inspect response.status to determine if there were any - * errors while processing the request. See more details in - * ExecuteBatchDmlRequest and ExecuteBatchDmlResponse. + * @desc Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in order, sequentially. ExecuteBatchDmlResponse will contain a ResultSet for each DML statement that has successfully executed. If a statement fails, its error status will be returned as part of the ExecuteBatchDmlResponse. Execution will stop at the first failed statement; the remaining statements will not run. ExecuteBatchDml is expected to return an OK status with a response even if there was an error while processing one of the DML statements. Clients must inspect response.status to determine if there were any errors while processing the request. See more details in ExecuteBatchDmlRequest and ExecuteBatchDmlResponse. * @alias spanner.projects.instances.databases.sessions.executeBatchDml * @memberOf! () * @@ -4578,14 +3670,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.executeSql - * @desc Executes an SQL statement, returning all results in a single reply. - * This method cannot be used to return a result set larger than 10 MiB; if - * the query yields more data than that, the query fails with a - * `FAILED_PRECONDITION` error. Operations inside read-write transactions - * might return `ABORTED`. If this occurs, the application should restart - * the transaction from the beginning. See Transaction for more details. - * Larger result sets can be fetched in streaming fashion by calling - * ExecuteStreamingSql instead. + * @desc Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. * @alias spanner.projects.instances.databases.sessions.executeSql * @memberOf! () * @@ -4660,10 +3745,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.executeStreamingSql - * @desc Like ExecuteSql, except returns the result set as a stream. Unlike - * ExecuteSql, there is no limit on the size of the returned result set. - * However, no individual row in the result set can exceed 100 MiB, and no - * column value can exceed 10 MiB. + * @desc Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. * @alias spanner.projects.instances.databases.sessions.executeStreamingSql * @memberOf! () * @@ -4740,8 +3822,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.get - * @desc Gets a session. Returns `NOT_FOUND` if the session does not exist. - * This is mainly useful for determining whether a session is still alive. + * @desc Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive. * @alias spanner.projects.instances.databases.sessions.get * @memberOf! () * @@ -4889,16 +3970,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.partitionQuery - * @desc Creates a set of partition tokens that can be used to execute a - * query operation in parallel. Each of the returned partition tokens can - * be used by ExecuteStreamingSql to specify a subset of the query result to - * read. The same session and read-only transaction must be used by the - * PartitionQueryRequest used to create the partition tokens and the - * ExecuteSqlRequests that use the partition tokens. Partition tokens - * become invalid when the session used to create them is deleted, is idle - * for too long, begins a new transaction, or becomes too old. When any of - * these happen, it is not possible to resume the query, and the whole - * operation must be restarted from the beginning. + * @desc Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning. * @alias spanner.projects.instances.databases.sessions.partitionQuery * @memberOf! () * @@ -4975,18 +4047,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.partitionRead - * @desc Creates a set of partition tokens that can be used to execute a - * read operation in parallel. Each of the returned partition tokens can be - * used by StreamingRead to specify a subset of the read result to read. The - * same session and read-only transaction must be used by the - * PartitionReadRequest used to create the partition tokens and the - * ReadRequests that use the partition tokens. There are no ordering - * guarantees on rows returned among the returned partition tokens, or even - * within each individual StreamingRead call issued with a partition_token. - * Partition tokens become invalid when the session used to create them is - * deleted, is idle for too long, begins a new transaction, or becomes too - * old. When any of these happen, it is not possible to resume the read, - * and the whole operation must be restarted from the beginning. + * @desc Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning. * @alias spanner.projects.instances.databases.sessions.partitionRead * @memberOf! () * @@ -5063,14 +4124,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.read - * @desc Reads rows from the database using key lookups and scans, as a - * simple key/value style alternative to ExecuteSql. This method cannot be - * used to return a result set larger than 10 MiB; if the read matches more - * data than that, the read fails with a `FAILED_PRECONDITION` error. Reads - * inside read-write transactions might return `ABORTED`. If this occurs, - * the application should restart the transaction from the beginning. See - * Transaction for more details. Larger result sets can be yielded in - * streaming fashion by calling StreamingRead instead. + * @desc Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. * @alias spanner.projects.instances.databases.sessions.read * @memberOf! () * @@ -5145,12 +4199,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.rollback - * @desc Rolls back a transaction, releasing any locks it holds. It is a - * good idea to call this for any transaction that includes one or more Read - * or ExecuteSql requests and ultimately decides not to commit. `Rollback` - * returns `OK` if it successfully aborts the transaction, the transaction - * was already aborted, or the transaction is not found. `Rollback` never - * returns `ABORTED`. + * @desc Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. * @alias spanner.projects.instances.databases.sessions.rollback * @memberOf! () * @@ -5223,10 +4272,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.streamingRead - * @desc Like Read, except returns the result set as a stream. Unlike Read, - * there is no limit on the size of the returned result set. However, no - * individual row in the result set can exceed 100 MiB, and no column value - * can exceed 10 MiB. + * @desc Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. * @alias spanner.projects.instances.databases.sessions.streamingRead * @memberOf! () * @@ -5327,8 +4373,7 @@ export namespace spanner_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The session in which the transaction to be committed is - * running. + * Required. The session in which the transaction to be committed is running. */ session?: string; @@ -5441,22 +4486,15 @@ export namespace spanner_v1 { */ database?: string; /** - * An expression for filtering the results of the request. Filter rules are - * case insensitive. The fields eligible for filtering are: * - * `labels.key` where key is the name of a label Some examples of using - * filters are: * `labels.env:*` --> The session has the label "env". * - * `labels.env:dev` --> The session has the label "env" and the value of the - * label contains the string "dev". + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `labels.key` where key is the name of a label Some examples of using filters are: * `labels.env:*` --> The session has the label "env". * `labels.env:dev` --> The session has the label "env" and the value of the label contains the string "dev". */ filter?: string; /** - * Number of sessions to be returned in the response. If 0 or less, defaults - * to the server's maximum allowed page size. + * Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. */ pageSize?: number; /** - * If non-empty, `page_token` should contain a next_page_token from a - * previous ListSessionsResponse. + * If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse. */ pageToken?: string; } @@ -5554,15 +4592,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias spanner.projects.instances.operations.cancel * @memberOf! () * @@ -5631,10 +4661,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias spanner.projects.instances.operations.delete * @memberOf! () * @@ -5703,9 +4730,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias spanner.projects.instances.operations.get * @memberOf! () * @@ -5776,15 +4801,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias spanner.projects.instances.operations.list * @memberOf! () * diff --git a/src/apis/speech/package.json b/src/apis/speech/package.json index 4add9225ee1..b95ea335006 100644 --- a/src/apis/speech/package.json +++ b/src/apis/speech/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index f6258457fc1..1d0951e753e 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace speech_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace speech_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace speech_v1 { speech: Resource$Speech; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); @@ -136,9 +135,7 @@ export namespace speech_v1 { operations?: Schema$Operation[]; } /** - * Describes the progress of a long-running `LongRunningRecognize` call. It is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Describes the progress of a long-running `LongRunningRecognize` call. It is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$LongRunningRecognizeMetadata { /** @@ -146,8 +143,7 @@ export namespace speech_v1 { */ lastUpdateTime?: string; /** - * Approximate percentage of audio processed thus far. Guaranteed to be 100 - * when the audio is fully processed and the results are available. + * Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available. */ progressPercent?: number; /** @@ -156,8 +152,7 @@ export namespace speech_v1 { startTime?: string; } /** - * The top-level message sent by the client for the `LongRunningRecognize` - * method. + * The top-level message sent by the client for the `LongRunningRecognize` method. */ export interface Schema$LongRunningRecognizeRequest { /** @@ -165,34 +160,25 @@ export namespace speech_v1 { */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to - * process the request. + * *Required* Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; } /** - * The only message returned to the client by the `LongRunningRecognize` - * method. It contains the result as zero or more sequential - * `SpeechRecognitionResult` messages. It is included in the `result.response` - * field of the `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * The only message returned to the client by the `LongRunningRecognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages. It is included in the `result.response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$LongRunningRecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to - * sequential portions of audio. + * Output only. Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -200,114 +186,61 @@ export namespace speech_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * Contains audio data in the encoding specified in the `RecognitionConfig`. - * Either `content` or `uri` must be supplied. Supplying both or neither - * returns google.rpc.Code.INVALID_ARGUMENT. See [content - * limits](/speech-to-text/quotas#content). + * Contains audio data in the encoding specified in the `RecognitionConfig`. Either `content` or `uri` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. See [content limits](/speech-to-text/quotas#content). */ export interface Schema$RecognitionAudio { /** - * The audio data bytes encoded as specified in `RecognitionConfig`. Note: - * as with all bytes fields, protobuffers use a pure binary representation, - * whereas JSON representations use base64. + * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ content?: string; /** - * URI that points to a file that contains audio data bytes as specified in - * `RecognitionConfig`. The file must not be compressed (for example, gzip). - * Currently, only Google Cloud Storage URIs are supported, which must be - * specified in the following format: `gs://bucket_name/object_name` (other - * URI formats return google.rpc.Code.INVALID_ARGUMENT). For more - * information, see [Request - * URIs](https://cloud.google.com/storage/docs/reference-uris). + * URI that points to a file that contains audio data bytes as specified in `RecognitionConfig`. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: `gs://bucket_name/object_name` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris). */ uri?: string; } /** - * Provides information to the recognizer that specifies how to process the - * request. + * Provides information to the recognizer that specifies how to process the request. */ export interface Schema$RecognitionConfig { /** - * *Optional* The number of channels in the input audio data. ONLY set this - * for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are - * `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid - * value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If - * `0` or omitted, defaults to one channel (mono). Note: We only recognize - * the first channel by default. To perform independent recognition on each - * channel set `enable_separate_recognition_per_channel` to 'true'. + * *Optional* The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. */ audioChannelCount?: number; /** - * *Optional* If 'true', adds punctuation to recognition result - * hypotheses. This feature is only available in select languages. Setting - * this for requests in other languages has no effect at all. The default - * 'false' value does not add punctuation to result hypotheses. - * Note: This is currently offered as an experimental service, complimentary - * to all users. In the future this may be exclusively available as a - * premium feature. + * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. */ enableAutomaticPunctuation?: boolean; /** - * This needs to be set to `true` explicitly and `audio_channel_count` > - * 1 to get each channel recognized separately. The recognition result will - * contain a `channel_tag` field to state which channel that result belongs - * to. If this is not true, we will only recognize the first channel. The - * request is billed cumulatively for all channels recognized: - * `audio_channel_count` multiplied by the length of the audio. + * This needs to be set to `true` explicitly and `audio_channel_count` > 1 to get each channel recognized separately. The recognition result will contain a `channel_tag` field to state which channel that result belongs to. If this is not true, we will only recognize the first channel. The request is billed cumulatively for all channels recognized: `audio_channel_count` multiplied by the length of the audio. */ enableSeparateRecognitionPerChannel?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * start and end time offsets (timestamps) for those words. If `false`, no - * word-level time offset information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. */ enableWordTimeOffsets?: boolean; /** - * Encoding of audio data sent in all `RecognitionAudio` messages. This - * field is optional for `FLAC` and `WAV` audio files and required for all - * other audio formats. For details, see AudioEncoding. + * Encoding of audio data sent in all `RecognitionAudio` messages. This field is optional for `FLAC` and `WAV` audio files and required for all other audio formats. For details, see AudioEncoding. */ encoding?: string; /** - * *Required* The language of the supplied audio as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". See [Language - * Support](/speech-to-text/docs/languages) for a list of the currently - * supported language codes. + * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](/speech-to-text/docs/languages) for a list of the currently supported language codes. */ languageCode?: string; /** - * *Optional* Maximum number of recognition hypotheses to be returned. - * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechRecognitionResult`. The server may return - * fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` - * or `1` will return a maximum of one. If omitted, will return a maximum of - * one. + * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -315,65 +248,23 @@ export namespace speech_v1 { */ metadata?: Schema$RecognitionMetadata; /** - * *Optional* Which model to select for the given request. Select the model - * best suited to your domain to get best results. If a model is not - * explicitly specified, then we auto-select a model based on the parameters - * in the RecognitionConfig. <table> <tr> - * <td><b>Model</b></td> - * <td><b>Description</b></td> </tr> - * <tr> - * <td><code>command_and_search</code></td> - * <td>Best for short queries such as voice commands or voice - * search.</td> </tr> <tr> - * <td><code>phone_call</code></td> <td>Best - * for audio that originated from a phone call (typically recorded at an - * 8khz sampling rate).</td> </tr> <tr> - * <td><code>video</code></td> <td>Best - * for audio that originated from from video or includes multiple speakers. - * Ideally the audio is recorded at a 16khz or greater sampling - * rate. This is a premium model that costs more than the standard - * rate.</td> </tr> <tr> - * <td><code>default</code></td> <td>Best - * for audio that is not one of the specific audio models. For - * example, long-form audio. Ideally the audio is high-fidelity, recorded at - * a 16khz or greater sampling rate.</td> </tr> </table> + * *Optional* Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> */ model?: string; /** - * *Optional* If set to `true`, the server will attempt to filter out - * profanities, replacing all but the initial character in each filtered - * word with asterisks, e.g. "f***". If set to `false` or omitted, - * profanities won't be filtered out. + * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ profanityFilter?: boolean; /** - * Sample rate in Hertz of the audio data sent in all `RecognitionAudio` - * messages. Valid values are: 8000-48000. 16000 is optimal. For best - * results, set the sampling rate of the audio source to 16000 Hz. If - * that's not possible, use the native sample rate of the audio source - * (instead of re-sampling). This field is optional for FLAC and WAV audio - * files, but is required for all other audio formats. For details, see - * AudioEncoding. + * Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. */ sampleRateHertz?: number; /** - * *Optional* array of SpeechContext. A means to provide context to assist - * the speech recognition. For more information, see [Phrase - * Hints](/speech-to-text/docs/basics#phrase-hints). + * *Optional* array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [Phrase Hints](/speech-to-text/docs/basics#phrase-hints). */ speechContexts?: Schema$SpeechContext[]; /** - * *Optional* Set to true to use an enhanced model for speech recognition. - * If `use_enhanced` is set to true and the `model` field is not set, then - * an appropriate enhanced model is chosen if: 1. project is eligible for - * requesting enhanced models 2. an enhanced model exists for the audio If - * `use_enhanced` is true and an enhanced version of the specified model - * does not exist, then the speech is recognized using the standard version - * of the specified model. Enhanced speech models require that you opt-in - * to data logging using instructions in the - * [documentation](/speech-to-text/docs/enable-data-logging). If you set - * `use_enhanced` to true and you have not enabled audio logging, then you - * will receive an error. + * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if: 1. project is eligible for requesting enhanced models 2. an enhanced model exists for the audio If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. Enhanced speech models require that you opt-in to data logging using instructions in the [documentation](/speech-to-text/docs/enable-data-logging). If you set `use_enhanced` to true and you have not enabled audio logging, then you will receive an error. */ useEnhanced?: boolean; } @@ -382,15 +273,11 @@ export namespace speech_v1 { */ export interface Schema$RecognitionMetadata { /** - * Description of the content. Eg. "Recordings of federal supreme court - * hearings from 2012". + * Description of the content. Eg. "Recordings of federal supreme court hearings from 2012". */ audioTopic?: string; /** - * The industry vertical to which this speech recognition request most - * closely applies. This is most indicative of the topics contained in the - * audio. Use the 6-digit NAICS code to identify the industry vertical - - * see https://www.naics.com/search/. + * The industry vertical to which this speech recognition request most closely applies. This is most indicative of the topics contained in the audio. Use the 6-digit NAICS code to identify the industry vertical - see https://www.naics.com/search/. */ industryNaicsCodeOfAudio?: number; /** @@ -402,8 +289,7 @@ export namespace speech_v1 { */ microphoneDistance?: string; /** - * Obfuscated (privacy-protected) ID of the user, to identify number of - * unique users using the service. + * Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service. */ obfuscatedId?: string; /** @@ -411,16 +297,11 @@ export namespace speech_v1 { */ originalMediaType?: string; /** - * Mime type of the original audio file. For example `audio/m4a`, - * `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list of possible audio - * mime types is maintained at - * http://www.iana.org/assignments/media-types/media-types.xhtml#audio + * Mime type of the original audio file. For example `audio/m4a`, `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list of possible audio mime types is maintained at http://www.iana.org/assignments/media-types/media-types.xhtml#audio */ originalMimeType?: string; /** - * The device used to make the recording. Examples 'Nexus 5X' or - * 'Polycom SoundStation IP 6000' or 'POTS' or - * 'VoIP' or 'Cardioid Microphone'. + * The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. */ recordingDeviceName?: string; /** @@ -437,36 +318,25 @@ export namespace speech_v1 { */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to - * process the request. + * *Required* Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; } /** - * The only message returned to the client by the `Recognize` method. It - * contains the result as zero or more sequential `SpeechRecognitionResult` - * messages. + * The only message returned to the client by the `Recognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages. */ export interface Schema$RecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to - * sequential portions of audio. + * Output only. Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$SpeechContext { /** - * *Optional* A list of strings containing words and phrases - * "hints" so that the speech recognition is more likely to - * recognize them. This can be used to improve the accuracy for specific - * words and phrases, for example, if specific commands are typically spoken - * by the user. This can also be used to add additional words to the - * vocabulary of the recognizer. See [usage - * limits](/speech-to-text/quotas#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](/speech-to-text/quotas#content). */ phrases?: string[]; } @@ -475,13 +345,7 @@ export namespace speech_v1 { */ export interface Schema$SpeechRecognitionAlternative { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative of a - * non-streaming result or, of a streaming result where `is_final=true`. - * This field is not guaranteed to be accurate and users should not rely on - * it to be always provided. The default of 0.0 is a sentinel value - * indicating `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -489,9 +353,7 @@ export namespace speech_v1 { */ transcript?: string; /** - * Output only. A list of word-specific information for each recognized - * word. Note: When `enable_speaker_diarization` is true, you will see all - * the words from the beginning of the audio. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$WordInfo[]; } @@ -500,55 +362,16 @@ export namespace speech_v1 { */ export interface Schema$SpeechRecognitionResult { /** - * Output only. May contain one or more recognition hypotheses (up to the - * maximum specified in `max_alternatives`). These alternatives are ordered - * in terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * Output only. May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$SpeechRecognitionAlternative[]; /** - * For multi-channel audio, this is the channel number corresponding to the - * recognized result for the audio from that channel. For - * audio_channel_count = N, its output values can range from '1' to - * 'N'. + * For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N, its output values can range from '1' to 'N'. */ channelTag?: number; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -556,14 +379,11 @@ export namespace speech_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -572,17 +392,11 @@ export namespace speech_v1 { */ export interface Schema$WordInfo { /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -599,9 +413,7 @@ export namespace speech_v1 { /** * speech.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias speech.operations.get * @memberOf! () * @@ -674,15 +486,7 @@ export namespace speech_v1 { /** * speech.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias speech.operations.list * @memberOf! () * @@ -821,9 +625,7 @@ export namespace speech_v1 { /** * speech.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias speech.projects.locations.operations.get * @memberOf! () * @@ -894,15 +696,7 @@ export namespace speech_v1 { /** * speech.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias speech.projects.locations.operations.list * @memberOf! () * @@ -1036,9 +830,7 @@ export namespace speech_v1 { /** * speech.projects.operations.manualRecognitionTasks.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias speech.projects.operations.manualRecognitionTasks.get * @memberOf! () * @@ -1129,12 +921,7 @@ export namespace speech_v1 { /** * speech.speech.longrunningrecognize - * @desc Performs asynchronous speech recognition: receive results via the - * google.longrunning.Operations interface. Returns either an - * `Operation.error` or an `Operation.response` which contains a - * `LongRunningRecognizeResponse` message. For more information on - * asynchronous speech recognition, see the - * [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize). + * @desc Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an `Operation.error` or an `Operation.response` which contains a `LongRunningRecognizeResponse` message. For more information on asynchronous speech recognition, see the [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize). * @alias speech.speech.longrunningrecognize * @memberOf! () * @@ -1210,8 +997,7 @@ export namespace speech_v1 { /** * speech.speech.recognize - * @desc Performs synchronous speech recognition: receive results after all - * audio has been sent and processed. + * @desc Performs synchronous speech recognition: receive results after all audio has been sent and processed. * @alias speech.speech.recognize * @memberOf! () * diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index e012ad3a8e1..e23d5f73551 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace speech_v1p1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace speech_v1p1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace speech_v1p1beta1 { speech: Resource$Speech; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); @@ -136,9 +135,7 @@ export namespace speech_v1p1beta1 { operations?: Schema$Operation[]; } /** - * Describes the progress of a long-running `LongRunningRecognize` call. It is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Describes the progress of a long-running `LongRunningRecognize` call. It is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$LongRunningRecognizeMetadata { /** @@ -146,8 +143,7 @@ export namespace speech_v1p1beta1 { */ lastUpdateTime?: string; /** - * Approximate percentage of audio processed thus far. Guaranteed to be 100 - * when the audio is fully processed and the results are available. + * Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available. */ progressPercent?: number; /** @@ -156,8 +152,7 @@ export namespace speech_v1p1beta1 { startTime?: string; } /** - * The top-level message sent by the client for the `LongRunningRecognize` - * method. + * The top-level message sent by the client for the `LongRunningRecognize` method. */ export interface Schema$LongRunningRecognizeRequest { /** @@ -165,34 +160,25 @@ export namespace speech_v1p1beta1 { */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to - * process the request. + * *Required* Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; } /** - * The only message returned to the client by the `LongRunningRecognize` - * method. It contains the result as zero or more sequential - * `SpeechRecognitionResult` messages. It is included in the `result.response` - * field of the `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * The only message returned to the client by the `LongRunningRecognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages. It is included in the `result.response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$LongRunningRecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to - * sequential portions of audio. + * Output only. Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -200,159 +186,81 @@ export namespace speech_v1p1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * Contains audio data in the encoding specified in the `RecognitionConfig`. - * Either `content` or `uri` must be supplied. Supplying both or neither - * returns google.rpc.Code.INVALID_ARGUMENT. See [content - * limits](/speech-to-text/quotas#content). + * Contains audio data in the encoding specified in the `RecognitionConfig`. Either `content` or `uri` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. See [content limits](/speech-to-text/quotas#content). */ export interface Schema$RecognitionAudio { /** - * The audio data bytes encoded as specified in `RecognitionConfig`. Note: - * as with all bytes fields, protobuffers use a pure binary representation, - * whereas JSON representations use base64. + * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ content?: string; /** - * URI that points to a file that contains audio data bytes as specified in - * `RecognitionConfig`. The file must not be compressed (for example, gzip). - * Currently, only Google Cloud Storage URIs are supported, which must be - * specified in the following format: `gs://bucket_name/object_name` (other - * URI formats return google.rpc.Code.INVALID_ARGUMENT). For more - * information, see [Request - * URIs](https://cloud.google.com/storage/docs/reference-uris). + * URI that points to a file that contains audio data bytes as specified in `RecognitionConfig`. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: `gs://bucket_name/object_name` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris). */ uri?: string; } /** - * Provides information to the recognizer that specifies how to process the - * request. + * Provides information to the recognizer that specifies how to process the request. */ export interface Schema$RecognitionConfig { /** - * *Optional* A list of up to 3 additional - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, - * listing possible alternative languages of the supplied audio. See - * [Language Support](/speech-to-text/docs/languages) for a list of the - * currently supported language codes. If alternative languages are listed, - * recognition result will contain recognition in the most likely language - * detected including the main language_code. The recognition result will - * include the language tag of the language detected in the audio. Note: - * This feature is only supported for Voice Command and Voice Search use - * cases and performance may vary for other use cases (e.g., phone call - * transcription). + * *Optional* A list of up to 3 additional [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, listing possible alternative languages of the supplied audio. See [Language Support](/speech-to-text/docs/languages) for a list of the currently supported language codes. If alternative languages are listed, recognition result will contain recognition in the most likely language detected including the main language_code. The recognition result will include the language tag of the language detected in the audio. Note: This feature is only supported for Voice Command and Voice Search use cases and performance may vary for other use cases (e.g., phone call transcription). */ alternativeLanguageCodes?: string[]; /** - * *Optional* The number of channels in the input audio data. ONLY set this - * for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are - * `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid - * value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If - * `0` or omitted, defaults to one channel (mono). Note: We only recognize - * the first channel by default. To perform independent recognition on each - * channel set `enable_separate_recognition_per_channel` to 'true'. + * *Optional* The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. */ audioChannelCount?: number; /** - * *Optional* Config to enable speaker diarization and set additional - * parameters to make diarization better suited for your application. Note: - * When this is enabled, we send all the words from the beginning of the - * audio for the top alternative in every consecutive STREAMING responses. - * This is done in order to improve our speaker tags as our models learn to - * identify the speakers in the conversation over time. For non-streaming - * requests, the diarization results will be provided only in the top - * alternative of the FINAL SpeechRecognitionResult. + * *Optional* Config to enable speaker diarization and set additional parameters to make diarization better suited for your application. Note: When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult. */ diarizationConfig?: Schema$SpeakerDiarizationConfig; /** - * *Optional* If set, specifies the estimated number of speakers in the - * conversation. If not set, defaults to '2'. Ignored unless - * enable_speaker_diarization is set to true." Note: Use - * diarization_config instead. This field will be DEPRECATED soon. + * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true." Note: Use diarization_config instead. This field will be DEPRECATED soon. */ diarizationSpeakerCount?: number; /** - * *Optional* If 'true', adds punctuation to recognition result - * hypotheses. This feature is only available in select languages. Setting - * this for requests in other languages has no effect at all. The default - * 'false' value does not add punctuation to result hypotheses. - * Note: This is currently offered as an experimental service, complimentary - * to all users. In the future this may be exclusively available as a - * premium feature. + * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. */ enableAutomaticPunctuation?: boolean; /** - * This needs to be set to `true` explicitly and `audio_channel_count` > - * 1 to get each channel recognized separately. The recognition result will - * contain a `channel_tag` field to state which channel that result belongs - * to. If this is not true, we will only recognize the first channel. The - * request is billed cumulatively for all channels recognized: - * `audio_channel_count` multiplied by the length of the audio. + * This needs to be set to `true` explicitly and `audio_channel_count` > 1 to get each channel recognized separately. The recognition result will contain a `channel_tag` field to state which channel that result belongs to. If this is not true, we will only recognize the first channel. The request is billed cumulatively for all channels recognized: `audio_channel_count` multiplied by the length of the audio. */ enableSeparateRecognitionPerChannel?: boolean; /** - * *Optional* If 'true', enables speaker detection for each - * recognized word in the top alternative of the recognition result using a - * speaker_tag provided in the WordInfo. Note: Use diarization_config - * instead. This field will be DEPRECATED soon. + * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: Use diarization_config instead. This field will be DEPRECATED soon. */ enableSpeakerDiarization?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * confidence for those words. If `false`, no word-level confidence - * information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * start and end time offsets (timestamps) for those words. If `false`, no - * word-level time offset information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. */ enableWordTimeOffsets?: boolean; /** - * Encoding of audio data sent in all `RecognitionAudio` messages. This - * field is optional for `FLAC` and `WAV` audio files and required for all - * other audio formats. For details, see AudioEncoding. + * Encoding of audio data sent in all `RecognitionAudio` messages. This field is optional for `FLAC` and `WAV` audio files and required for all other audio formats. For details, see AudioEncoding. */ encoding?: string; /** - * *Required* The language of the supplied audio as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". See [Language - * Support](/speech-to-text/docs/languages) for a list of the currently - * supported language codes. + * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](/speech-to-text/docs/languages) for a list of the currently supported language codes. */ languageCode?: string; /** - * *Optional* Maximum number of recognition hypotheses to be returned. - * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechRecognitionResult`. The server may return - * fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` - * or `1` will return a maximum of one. If omitted, will return a maximum of - * one. + * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -360,65 +268,23 @@ export namespace speech_v1p1beta1 { */ metadata?: Schema$RecognitionMetadata; /** - * *Optional* Which model to select for the given request. Select the model - * best suited to your domain to get best results. If a model is not - * explicitly specified, then we auto-select a model based on the parameters - * in the RecognitionConfig. <table> <tr> - * <td><b>Model</b></td> - * <td><b>Description</b></td> </tr> - * <tr> - * <td><code>command_and_search</code></td> - * <td>Best for short queries such as voice commands or voice - * search.</td> </tr> <tr> - * <td><code>phone_call</code></td> <td>Best - * for audio that originated from a phone call (typically recorded at an - * 8khz sampling rate).</td> </tr> <tr> - * <td><code>video</code></td> <td>Best - * for audio that originated from from video or includes multiple speakers. - * Ideally the audio is recorded at a 16khz or greater sampling - * rate. This is a premium model that costs more than the standard - * rate.</td> </tr> <tr> - * <td><code>default</code></td> <td>Best - * for audio that is not one of the specific audio models. For - * example, long-form audio. Ideally the audio is high-fidelity, recorded at - * a 16khz or greater sampling rate.</td> </tr> </table> + * *Optional* Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> */ model?: string; /** - * *Optional* If set to `true`, the server will attempt to filter out - * profanities, replacing all but the initial character in each filtered - * word with asterisks, e.g. "f***". If set to `false` or omitted, - * profanities won't be filtered out. + * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ profanityFilter?: boolean; /** - * Sample rate in Hertz of the audio data sent in all `RecognitionAudio` - * messages. Valid values are: 8000-48000. 16000 is optimal. For best - * results, set the sampling rate of the audio source to 16000 Hz. If - * that's not possible, use the native sample rate of the audio source - * (instead of re-sampling). This field is optional for FLAC and WAV audio - * files, but is required for all other audio formats. For details, see - * AudioEncoding. + * Sample rate in Hertz of the audio data sent in all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see AudioEncoding. */ sampleRateHertz?: number; /** - * *Optional* array of SpeechContext. A means to provide context to assist - * the speech recognition. For more information, see [Phrase - * Hints](/speech-to-text/docs/basics#phrase-hints). + * *Optional* array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [Phrase Hints](/speech-to-text/docs/basics#phrase-hints). */ speechContexts?: Schema$SpeechContext[]; /** - * *Optional* Set to true to use an enhanced model for speech recognition. - * If `use_enhanced` is set to true and the `model` field is not set, then - * an appropriate enhanced model is chosen if: 1. project is eligible for - * requesting enhanced models 2. an enhanced model exists for the audio If - * `use_enhanced` is true and an enhanced version of the specified model - * does not exist, then the speech is recognized using the standard version - * of the specified model. Enhanced speech models require that you opt-in - * to data logging using instructions in the - * [documentation](/speech-to-text/docs/enable-data-logging). If you set - * `use_enhanced` to true and you have not enabled audio logging, then you - * will receive an error. + * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if: 1. project is eligible for requesting enhanced models 2. an enhanced model exists for the audio If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. Enhanced speech models require that you opt-in to data logging using instructions in the [documentation](/speech-to-text/docs/enable-data-logging). If you set `use_enhanced` to true and you have not enabled audio logging, then you will receive an error. */ useEnhanced?: boolean; } @@ -427,15 +293,11 @@ export namespace speech_v1p1beta1 { */ export interface Schema$RecognitionMetadata { /** - * Description of the content. Eg. "Recordings of federal supreme court - * hearings from 2012". + * Description of the content. Eg. "Recordings of federal supreme court hearings from 2012". */ audioTopic?: string; /** - * The industry vertical to which this speech recognition request most - * closely applies. This is most indicative of the topics contained in the - * audio. Use the 6-digit NAICS code to identify the industry vertical - - * see https://www.naics.com/search/. + * The industry vertical to which this speech recognition request most closely applies. This is most indicative of the topics contained in the audio. Use the 6-digit NAICS code to identify the industry vertical - see https://www.naics.com/search/. */ industryNaicsCodeOfAudio?: number; /** @@ -447,8 +309,7 @@ export namespace speech_v1p1beta1 { */ microphoneDistance?: string; /** - * Obfuscated (privacy-protected) ID of the user, to identify number of - * unique users using the service. + * Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service. */ obfuscatedId?: string; /** @@ -456,16 +317,11 @@ export namespace speech_v1p1beta1 { */ originalMediaType?: string; /** - * Mime type of the original audio file. For example `audio/m4a`, - * `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list of possible audio - * mime types is maintained at - * http://www.iana.org/assignments/media-types/media-types.xhtml#audio + * Mime type of the original audio file. For example `audio/m4a`, `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list of possible audio mime types is maintained at http://www.iana.org/assignments/media-types/media-types.xhtml#audio */ originalMimeType?: string; /** - * The device used to make the recording. Examples 'Nexus 5X' or - * 'Polycom SoundStation IP 6000' or 'POTS' or - * 'VoIP' or 'Cardioid Microphone'. + * The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'. */ recordingDeviceName?: string; /** @@ -482,8 +338,7 @@ export namespace speech_v1p1beta1 { */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to - * process the request. + * *Required* Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; /** @@ -492,52 +347,34 @@ export namespace speech_v1p1beta1 { name?: string; } /** - * The only message returned to the client by the `Recognize` method. It - * contains the result as zero or more sequential `SpeechRecognitionResult` - * messages. + * The only message returned to the client by the `Recognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages. */ export interface Schema$RecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to - * sequential portions of audio. + * Output only. Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } export interface Schema$SpeakerDiarizationConfig { /** - * *Optional* If 'true', enables speaker detection for each - * recognized word in the top alternative of the recognition result using a - * speaker_tag provided in the WordInfo. + * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. */ enableSpeakerDiarization?: boolean; /** - * *Optional* Only used if diarization_speaker_count is not set. Maximum - * number of speakers in the conversation. This range gives you more - * flexibility by allowing the system to automatically determine the correct - * number of speakers. If not set, the default value is 6. + * *Optional* Only used if diarization_speaker_count is not set. Maximum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 6. */ maxSpeakerCount?: number; /** - * *Optional* Only used if diarization_speaker_count is not set. Minimum - * number of speakers in the conversation. This range gives you more - * flexibility by allowing the system to automatically determine the correct - * number of speakers. If not set, the default value is 2. + * *Optional* Only used if diarization_speaker_count is not set. Minimum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 2. */ minSpeakerCount?: number; } /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$SpeechContext { /** - * *Optional* A list of strings containing words and phrases - * "hints" so that the speech recognition is more likely to - * recognize them. This can be used to improve the accuracy for specific - * words and phrases, for example, if specific commands are typically spoken - * by the user. This can also be used to add additional words to the - * vocabulary of the recognizer. See [usage - * limits](/speech-to-text/quotas#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](/speech-to-text/quotas#content). */ phrases?: string[]; } @@ -546,13 +383,7 @@ export namespace speech_v1p1beta1 { */ export interface Schema$SpeechRecognitionAlternative { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative of a - * non-streaming result or, of a streaming result where `is_final=true`. - * This field is not guaranteed to be accurate and users should not rely on - * it to be always provided. The default of 0.0 is a sentinel value - * indicating `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -560,9 +391,7 @@ export namespace speech_v1p1beta1 { */ transcript?: string; /** - * Output only. A list of word-specific information for each recognized - * word. Note: When `enable_speaker_diarization` is true, you will see all - * the words from the beginning of the audio. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$WordInfo[]; } @@ -571,61 +400,20 @@ export namespace speech_v1p1beta1 { */ export interface Schema$SpeechRecognitionResult { /** - * Output only. May contain one or more recognition hypotheses (up to the - * maximum specified in `max_alternatives`). These alternatives are ordered - * in terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * Output only. May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$SpeechRecognitionAlternative[]; /** - * For multi-channel audio, this is the channel number corresponding to the - * recognized result for the audio from that channel. For - * audio_channel_count = N, its output values can range from '1' to - * 'N'. + * For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N, its output values can range from '1' to 'N'. */ channelTag?: number; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -633,14 +421,11 @@ export namespace speech_v1p1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -649,36 +434,19 @@ export namespace speech_v1p1beta1 { */ export interface Schema$WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative of a - * non-streaming result or, of a streaming result where `is_final=true`. - * This field is not guaranteed to be accurate and users should not rely on - * it to be always provided. The default of 0.0 is a sentinel value - * indicating `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from '1' to - * diarization_speaker_count. speaker_tag is set if - * enable_speaker_diarization = 'true' and only in the top - * alternative. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. */ speakerTag?: number; /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -695,9 +463,7 @@ export namespace speech_v1p1beta1 { /** * speech.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias speech.operations.get * @memberOf! () * @@ -770,15 +536,7 @@ export namespace speech_v1p1beta1 { /** * speech.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias speech.operations.list * @memberOf! () * @@ -920,9 +678,7 @@ export namespace speech_v1p1beta1 { /** * speech.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias speech.projects.locations.operations.get * @memberOf! () * @@ -993,15 +749,7 @@ export namespace speech_v1p1beta1 { /** * speech.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias speech.projects.locations.operations.list * @memberOf! () * @@ -1135,9 +883,7 @@ export namespace speech_v1p1beta1 { /** * speech.projects.operations.manualRecognitionTasks.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias speech.projects.operations.manualRecognitionTasks.get * @memberOf! () * @@ -1228,12 +974,7 @@ export namespace speech_v1p1beta1 { /** * speech.speech.longrunningrecognize - * @desc Performs asynchronous speech recognition: receive results via the - * google.longrunning.Operations interface. Returns either an - * `Operation.error` or an `Operation.response` which contains a - * `LongRunningRecognizeResponse` message. For more information on - * asynchronous speech recognition, see the - * [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize). + * @desc Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an `Operation.error` or an `Operation.response` which contains a `LongRunningRecognizeResponse` message. For more information on asynchronous speech recognition, see the [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize). * @alias speech.speech.longrunningrecognize * @memberOf! () * @@ -1309,8 +1050,7 @@ export namespace speech_v1p1beta1 { /** * speech.speech.recognize - * @desc Performs synchronous speech recognition: receive results after all - * audio has been sent and processed. + * @desc Performs synchronous speech recognition: receive results after all audio has been sent and processed. * @alias speech.speech.recognize * @memberOf! () * diff --git a/src/apis/sqladmin/package.json b/src/apis/sqladmin/package.json index 8ffc9baa85a..8a349639d1d 100644 --- a/src/apis/sqladmin/package.json +++ b/src/apis/sqladmin/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 37dbf8b2367..600dad2fdc4 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace sqladmin_v1beta4 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace sqladmin_v1beta4 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace sqladmin_v1beta4 { /** * Cloud SQL Admin API * - * Creates and manages Cloud SQL instances, which provide fully managed MySQL - * or PostgreSQL databases. + * Creates and manages Cloud SQL instances, which provide fully managed MySQL or PostgreSQL databases. * * @example * const {google} = require('googleapis'); @@ -103,7 +99,10 @@ export namespace sqladmin_v1beta4 { users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.backupRuns = new Resource$Backupruns(this.context); this.databases = new Resource$Databases(this.context); @@ -121,8 +120,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$AclEntry { /** - * The time when this access control entry expires in RFC 3339 format, for - * example 2012-11-15T16:19:00.094Z. + * The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ expirationTime?: string; /** @@ -156,8 +154,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$BackupConfiguration { /** - * Whether binary log is enabled. If backup configuration is disabled, - * binary log must be disabled as well. + * Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well. */ binaryLogEnabled?: boolean; /** @@ -168,13 +165,16 @@ export namespace sqladmin_v1beta4 { * This is always sql#backupConfiguration. */ kind?: string; + /** + * The location of the backup. + */ + location?: string; /** * Reserved for future use. */ replicationLogArchivingEnabled?: boolean; /** - * Start time for the daily backup configuration in UTC timezone in the 24 - * hour format - HH:MM. + * Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM. */ startTime?: string; } @@ -187,23 +187,19 @@ export namespace sqladmin_v1beta4 { */ description?: string; /** - * The time the backup operation completed in UTC timezone in RFC 3339 - * format, for example 2012-11-15T16:19:00.094Z. + * The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ endTime?: string; /** - * The time the run was enqueued in UTC timezone in RFC 3339 format, for - * example 2012-11-15T16:19:00.094Z. + * The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ enqueuedTime?: string; /** - * Information about why the backup operation failed. This is only present - * if the run has the FAILED status. + * Information about why the backup operation failed. This is only present if the run has the FAILED status. */ error?: Schema$OperationError; /** - * The identifier for this backup run. Unique only for a specific Cloud SQL - * instance. + * The identifier for this backup run. Unique only for a specific Cloud SQL instance. */ id?: string; /** @@ -214,13 +210,16 @@ export namespace sqladmin_v1beta4 { * This is always sql#backupRun. */ kind?: string; + /** + * The location of the backup. + */ + location?: string; /** * The URI of this resource. */ selfLink?: string; /** - * The time the backup operation actually started in UTC timezone in RFC - * 3339 format, for example 2012-11-15T16:19:00.094Z. + * The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ startTime?: string; /** @@ -228,13 +227,11 @@ export namespace sqladmin_v1beta4 { */ status?: string; /** - * The type of this run; can be either "AUTOMATED" or - * "ON_DEMAND". + * The type of this run; can be either "AUTOMATED" or "ON_DEMAND". */ type?: string; /** - * The start time of the backup window during which this the backup was - * attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. + * The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ windowStartTime?: string; } @@ -243,8 +240,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$BackupRunsListResponse { /** - * A list of backup runs in reverse chronological order of the enqueued - * time. + * A list of backup runs in reverse chronological order of the enqueued time. */ items?: Schema$BackupRun[]; /** @@ -252,8 +248,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -279,9 +274,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$CloneContext { /** - * Binary log coordinates, if specified, identify the position up to which - * the source instance should be cloned. If not specified, the source - * instance is cloned up to the most recent binary log coordinates. + * Binary log coordinates, if specified, identify the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates. */ binLogCoordinates?: Schema$BinLogCoordinates; /** @@ -310,8 +303,7 @@ export namespace sqladmin_v1beta4 { */ collation?: string; /** - * This field is deprecated and will be removed from a future version of the - * API. + * This field is deprecated and will be removed from a future version of the API. */ etag?: string; /** @@ -323,13 +315,11 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The name of the database in the Cloud SQL instance. This does not include - * the project ID or instance name. + * The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. */ name?: string; /** - * The project ID of the project containing the Cloud SQL database. The - * Google apps domain is prefixed if applicable. + * The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. */ project?: string; /** @@ -342,15 +332,11 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$DatabaseFlags { /** - * The name of the flag. These flags are passed at instance startup, so - * include both server options and system variables for MySQL. Flags should - * be specified with underscores, not hyphens. For more information, see - * Configuring Database Flags in the Cloud SQL documentation. + * The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags should be specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation. */ name?: string; /** - * The value of the flag. Booleans should be set to on for true and off for - * false. This field must be omitted if the flag doesn't take a value. + * The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value. */ value?: string; } @@ -359,11 +345,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$DatabaseInstance { /** - * FIRST_GEN: First Generation instance. MySQL only. SECOND_GEN: Second - * Generation instance or PostgreSQL instance. EXTERNAL: A database server - * that is not managed by Google. This property is read-only; use the tier - * property in the settings object to determine the database type and Second - * or First Generation. + * FIRST_GEN: First Generation instance. MySQL only. SECOND_GEN: Second Generation instance or PostgreSQL instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type and Second or First Generation. */ backendType?: string; /** @@ -371,52 +353,35 @@ export namespace sqladmin_v1beta4 { */ connectionName?: string; /** - * The current disk usage of the instance in bytes. This property has been - * deprecated. Users should use the - * "cloudsql.googleapis.com/database/disk/bytes_used" metric in - * Cloud Monitoring API instead. Please see this announcement for details. + * The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details. */ currentDiskSize?: string; /** - * The database engine type and version. The databaseVersion field can not - * be changed after instance creation. MySQL Second Generation instances: - * MYSQL_5_7 (default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 - * (default) or POSTGRES_11 Beta. MySQL First Generation instances: - * MYSQL_5_6 (default) or MYSQL_5_5 + * The database engine type and version. The databaseVersion field can not be changed after instance creation. MySQL Second Generation instances: MYSQL_5_7 (default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 (default) or POSTGRES_11 Beta. MySQL First Generation instances: MYSQL_5_6 (default) or MYSQL_5_5 */ databaseVersion?: string; /** - * Disk encryption configuration specific to an instance. Applies only to - * Second Generation instances. + * Disk encryption configuration specific to an instance. Applies only to Second Generation instances. */ diskEncryptionConfiguration?: Schema$DiskEncryptionConfiguration; /** - * Disk encryption status specific to an instance. Applies only to Second - * Generation instances. + * Disk encryption status specific to an instance. Applies only to Second Generation instances. */ diskEncryptionStatus?: Schema$DiskEncryptionStatus; /** - * This field is deprecated and will be removed from a future version of the - * API. Use the settings.settingsVersion field instead. + * This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead. */ etag?: string; /** - * The name and status of the failover replica. This property is applicable - * only to Second Generation instances. + * The name and status of the failover replica. This property is applicable only to Second Generation instances. */ failoverReplica?: {available?: boolean; name?: string}; /** - * The Compute Engine zone that the instance is currently serving from. This - * value could be different from the zone that was specified when the - * instance was created if the instance has failed over to its secondary - * zone. + * The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. */ gceZone?: string; /** - * The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: - * A Cloud SQL instance that is not replicating from a master. - * ON_PREMISES_INSTANCE: An instance running on the customer's premises. - * READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. + * The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. */ instanceType?: string; /** @@ -424,8 +389,7 @@ export namespace sqladmin_v1beta4 { */ ipAddresses?: Schema$IpMapping[]; /** - * The IPv6 address assigned to the instance. This property is applicable - * only to First Generation instances. + * The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. */ ipv6Address?: string; /** @@ -433,8 +397,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The name of the instance which will act as master in the replication - * setup. + * The name of the instance which will act as master in the replication setup. */ masterInstanceName?: string; /** @@ -450,16 +413,11 @@ export namespace sqladmin_v1beta4 { */ onPremisesConfiguration?: Schema$OnPremisesConfiguration; /** - * The project ID of the project containing the Cloud SQL instance. The - * Google apps domain is prefixed if applicable. + * The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. */ project?: string; /** - * The geographical region. Can be us-central (FIRST_GEN instances only), - * us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. - * Defaults to us-central or us-central1 depending on the instance type - * (First Generation or Second Generation). The region can not be changed - * after instance creation. + * The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. */ region?: string; /** @@ -483,8 +441,7 @@ export namespace sqladmin_v1beta4 { */ serverCaCert?: Schema$SslCert; /** - * The service account email address assigned to the instance. This property - * is applicable only to Second Generation instances. + * The service account email address assigned to the instance. This property is applicable only to Second Generation instances. */ serviceAccountEmailAddress?: string; /** @@ -492,12 +449,7 @@ export namespace sqladmin_v1beta4 { */ settings?: Schema$Settings; /** - * The current serving state of the Cloud SQL instance. This can be one of - * the following. RUNNABLE: The instance is running, or is ready to run when - * accessed. SUSPENDED: The instance is not available, for example due to - * problems with billing. PENDING_CREATE: The instance is being created. - * MAINTENANCE: The instance is down for maintenance. FAILED: The instance - * creation failed. UNKNOWN_STATE: The state of the instance is unknown. + * The current serving state of the Cloud SQL instance. This can be one of the following. RUNNABLE: The instance is running, or is ready to run when accessed. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed. UNKNOWN_STATE: The state of the instance is unknown. */ state?: string; /** @@ -527,12 +479,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * MySQL specific configuration when replicating from a MySQL on-premises - * master. Replication configuration information such as the username, - * password, certificates, and keys are not stored in the instance metadata. - * The configuration information is used only to set up the replication - * connection and is stored by MySQL in a file named master.info in the data - * directory. + * MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. */ mysqlReplicaConfiguration?: Schema$DemoteMasterMySqlReplicaConfiguration; } @@ -545,23 +492,15 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The name of the instance which will act as on-premises master in the - * replication setup. + * The name of the instance which will act as on-premises master in the replication setup. */ masterInstanceName?: string; /** - * Configuration specific to read-replicas replicating from the on-premises - * master. + * Configuration specific to read-replicas replicating from the on-premises master. */ replicaConfiguration?: Schema$DemoteMasterConfiguration; /** - * Verify GTID consistency for demote operation. Default value: True. Second - * Generation instances only. Setting this flag to false enables you to - * bypass GTID consistency check between on-premises master and Cloud SQL - * instance during the demotion operation but also exposes you to the risk - * of future replication failures. Change the value only if you know the - * reason for the GTID divergence and are confident that doing so will not - * cause any replication issues. + * Verify GTID consistency for demote operation. Default value: True. Second Generation instances only. Setting this flag to false enables you to bypass GTID consistency check between on-premises master and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues. */ verifyGtidConsistency?: boolean; } @@ -578,9 +517,7 @@ export namespace sqladmin_v1beta4 { */ clientCertificate?: string; /** - * PEM representation of the slave's private key. The corresponsing - * public key is encoded in the client's certificate. The format of the - * slave's private key can be either PKCS #1 or PKCS #8. + * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. The format of the slave's private key can be either PKCS #1 or PKCS #8. */ clientKey?: string; /** @@ -631,19 +568,11 @@ export namespace sqladmin_v1beta4 { */ csvExportOptions?: {selectQuery?: string}; /** - * Databases to be exported. MySQL instances: If fileType is SQL and no - * database is specified, all databases are exported, except for the mysql - * system database. If fileType is CSV, you can specify one database, either - * by using this property or by using the csvExportOptions.selectQuery - * property, which takes precedence over this property. PostgreSQL - * instances: Specify exactly one database to be exported. If fileType is - * CSV, this database must match the database used in the - * csvExportOptions.selectQuery property. + * Databases to be exported. MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. PostgreSQL instances: Specify exactly one database to be exported. If fileType is CSV, this database must match the database used in the csvExportOptions.selectQuery property. */ databases?: string[]; /** - * The file type for the specified uri. SQL: The file contains SQL - * statements. CSV: The file contains CSV data. + * The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data. */ fileType?: string; /** @@ -659,11 +588,7 @@ export namespace sqladmin_v1beta4 { tables?: string[]; }; /** - * The path to the file in Google Cloud Storage where the export will be - * stored. The URI is in the form gs://bucketName/fileName. If the file - * already exists, the requests succeeds, but the operation fails. If - * fileType is SQL and the filename ends with .gz, the contents are - * compressed. + * The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the requests succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed. */ uri?: string; } @@ -676,8 +601,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The current settings version of this instance. Request will be rejected - * if this version doesn't match the current settings version. + * The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. */ settingsVersion?: string; } @@ -690,9 +614,7 @@ export namespace sqladmin_v1beta4 { */ allowedStringValues?: string[]; /** - * The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, - * or MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation - * instances. + * The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation instances. */ appliesTo?: string[]; /** @@ -712,19 +634,15 @@ export namespace sqladmin_v1beta4 { */ minValue?: string; /** - * This is the name of the flag. Flag names always use underscores, not - * hyphens, e.g. max_allowed_packet + * This is the name of the flag. Flag names always use underscores, not hyphens, e.g. max_allowed_packet */ name?: string; /** - * Indicates whether changing this flag will trigger a database restart. - * Only applicable to Second Generation instances. + * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. */ requiresRestart?: boolean; /** - * The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER - * or NONE. NONE is used for flags which do not take a value, such as - * skip_grant_tables. + * The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables. */ type?: string; } @@ -750,15 +668,11 @@ export namespace sqladmin_v1beta4 { */ csvImportOptions?: {columns?: string[]; table?: string}; /** - * The target database for the import. If fileType is SQL, this field is - * required only if the import file does not specify a database, and is - * overridden by any database specification in the import file. If fileType - * is CSV, one database must be specified. + * The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If fileType is CSV, one database must be specified. */ database?: string; /** - * The file type for the specified uri. SQL: The file contains SQL - * statements. CSV: The file contains CSV data. + * The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data. */ fileType?: string; /** @@ -770,10 +684,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * Path to the import file in Cloud Storage, in the form - * gs://bucketName/fileName. Compressed gzip files (.gz) are supported when - * fileType is SQL. The instance must have write permissions to the bucket - * and read access to the file. + * Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file. */ uri?: string; } @@ -835,8 +746,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** @@ -890,9 +800,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$IpConfiguration { /** - * The list of external networks that are allowed to connect to the instance - * using the IP. In CIDR notation, also known as 'slash' notation - * (e.g. 192.168.100.0/24). + * The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24). */ authorizedNetworks?: Schema$AclEntry[]; /** @@ -900,10 +808,7 @@ export namespace sqladmin_v1beta4 { */ ipv4Enabled?: boolean; /** - * The resource link for the VPC network from which the Cloud SQL instance - * is accessible for private IP. For example, - * /projects/myProject/global/networks/default. This setting can be updated, - * but it cannot be removed after it is set. + * The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set. */ privateNetwork?: string; /** @@ -920,29 +825,20 @@ export namespace sqladmin_v1beta4 { */ ipAddress?: string; /** - * The due time for this IP to be retired in RFC 3339 format, for example - * 2012-11-15T16:19:00.094Z. This field is only available when the IP is - * scheduled to be retired. + * The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired. */ timeToRetire?: string; /** - * The type of this IP address. A PRIMARY address is an address that can - * accept incoming connections. An OUTGOING address is the source address of - * connections originating from the instance, if supported. + * The type of this IP address. A PRIMARY address is an address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported. */ type?: string; } /** - * Preferred location. This specifies where a Cloud SQL instance should - * preferably be located, either in a specific Compute Engine zone, or - * co-located with an App Engine application. Note that if the preferred - * location is not available, the instance will be located as close as - * possible within the region. Only one location may be specified. + * Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. */ export interface Schema$LocationPreference { /** - * The AppEngine application to follow, it must be in the same region as the - * Cloud SQL instance. + * The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. */ followGaeApplication?: string; /** @@ -950,14 +846,12 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, - * etc.). + * The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). */ zone?: string; } /** - * Maintenance window. This specifies when a v2 Cloud SQL instance should - * preferably be restarted for system maintenance purposes. + * Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance purposes. */ export interface Schema$MaintenanceWindow { /** @@ -973,8 +867,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * Maintenance timing setting: canary (Earlier) or stable (Later). Learn - * more. + * Maintenance timing setting: canary (Earlier) or stable (Later). Learn more. */ updateTrack?: string; } @@ -991,22 +884,15 @@ export namespace sqladmin_v1beta4 { */ clientCertificate?: string; /** - * PEM representation of the slave's private key. The corresponsing - * public key is encoded in the client's certificate. + * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. */ clientKey?: string; /** - * Seconds to wait between connect retries. MySQL's default is 60 - * seconds. + * Seconds to wait between connect retries. MySQL's default is 60 seconds. */ connectRetryInterval?: number; /** - * Path to a SQL dump file in Google Cloud Storage from which the slave - * instance is to be created. The URI is in the form - * gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. - * Dumps should have the binlog co-ordinates from which replication should - * begin. This can be accomplished by setting --master-data to 1 when using - * mysqldump. + * Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump. */ dumpFilePath?: string; /** @@ -1030,8 +916,7 @@ export namespace sqladmin_v1beta4 { */ username?: string; /** - * Whether or not to check the master's Common Name value in the - * certificate that it sends during the SSL handshake. + * Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. */ verifyServerCertificate?: boolean; } @@ -1049,19 +934,15 @@ export namespace sqladmin_v1beta4 { kind?: string; } /** - * An Operation resource. For successful operations that return an Operation - * resource, only the fields relevant to the operation are populated in the - * resource. + * An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. */ export interface Schema$Operation { /** - * The time this operation finished in UTC timezone in RFC 3339 format, for - * example 2012-11-15T16:19:00.094Z. + * The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ endTime?: string; /** - * If errors occurred during processing of this operation, this field will - * be populated. + * If errors occurred during processing of this operation, this field will be populated. */ error?: Schema$OperationErrors; /** @@ -1073,8 +954,7 @@ export namespace sqladmin_v1beta4 { */ importContext?: Schema$ImportContext; /** - * The time this operation was enqueued in UTC timezone in RFC 3339 format, - * for example 2012-11-15T16:19:00.094Z. + * The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ insertTime?: string; /** @@ -1082,15 +962,11 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * An identifier that uniquely identifies the operation. You can use this - * identifier to retrieve the Operations resource that has information about - * the operation. + * An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. */ name?: string; /** - * The type of the operation. Valid values are CREATE, DELETE, UPDATE, - * RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, - * DELETE_USER, CREATE_DATABASE, DELETE_DATABASE . + * The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE . */ operationType?: string; /** @@ -1098,13 +974,11 @@ export namespace sqladmin_v1beta4 { */ selfLink?: string; /** - * The time this operation actually started in UTC timezone in RFC 3339 - * format, for example 2012-11-15T16:19:00.094Z. + * The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ startTime?: string; /** - * The status of an operation. Valid values are PENDING, RUNNING, DONE, - * UNKNOWN. + * The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN. */ status?: string; /** @@ -1164,8 +1038,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -1174,11 +1047,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$ReplicaConfiguration { /** - * Specifies if the replica is the failover target. If the field is set to - * true the replica will be designated as a failover replica. In case the - * master instance fails, the replica instance will be promoted as the new - * master instance. Only one replica can be specified as failover target, - * and the replica has to be in different zone with the master instance. + * Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. */ failoverTarget?: boolean; /** @@ -1186,12 +1055,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * MySQL specific configuration when replicating from a MySQL on-premises - * master. Replication configuration information such as the username, - * password, certificates, and keys are not stored in the instance metadata. - * The configuration information is used only to set up the replication - * connection and is stored by MySQL in a file named master.info in the data - * directory. + * MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. */ mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration; } @@ -1221,9 +1085,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The fingerprint of the next version to be rotated to. If left - * unspecified, will be rotated to the most recently added server CA - * version. + * The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version. */ nextVersion?: string; } @@ -1232,28 +1094,15 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$Settings { /** - * The activation policy specifies when the instance is activated; it is - * applicable only when the instance state is RUNNABLE. Valid values: - * ALWAYS: The instance is on, and remains so even in the absence of - * connection requests. NEVER: The instance is off; it is not activated, - * even if a connection request arrives. ON_DEMAND: First Generation - * instances only. The instance responds to incoming requests, and turns - * itself off when not in use. Instances with PER_USE pricing turn off after - * 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off - * after 12 hours of inactivity. + * The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: ALWAYS: The instance is on, and remains so even in the absence of connection requests. NEVER: The instance is off; it is not activated, even if a connection request arrives. ON_DEMAND: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity. */ activationPolicy?: string; /** - * The App Engine app IDs that can access this instance. First Generation - * instances only. + * The App Engine app IDs that can access this instance. First Generation instances only. */ authorizedGaeApplications?: string[]; /** - * Availability type (PostgreSQL instances only). Potential values: ZONAL: - * The instance serves data from only one zone. Outages in that zone affect - * data accessibility. REGIONAL: The instance can serve data from more than - * one zone in a region (it is highly available). For more information, see - * Overview of the High Availability Configuration. + * Availability type (PostgreSQL instances only). Potential values: ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. REGIONAL: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration. */ availabilityType?: string; /** @@ -1261,9 +1110,7 @@ export namespace sqladmin_v1beta4 { */ backupConfiguration?: Schema$BackupConfiguration; /** - * Configuration specific to read replica instances. Indicates whether - * database flags for crash-safe replication are enabled. This property is - * only applicable to First Generation instances. + * Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. */ crashSafeReplicationEnabled?: boolean; /** @@ -1271,25 +1118,19 @@ export namespace sqladmin_v1beta4 { */ databaseFlags?: Schema$DatabaseFlags[]; /** - * Configuration specific to read replica instances. Indicates whether - * replication is enabled or not. + * Configuration specific to read replica instances. Indicates whether replication is enabled or not. */ databaseReplicationEnabled?: boolean; /** - * The size of data disk, in GB. The data disk size minimum is 10GB. Not - * used for First Generation instances. + * The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. */ dataDiskSizeGb?: string; /** - * The type of data disk: PD_SSD (default) or PD_HDD. Not used for First - * Generation instances. + * The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances. */ dataDiskType?: string; /** - * The settings for IP Management. This allows to enable or disable the - * instance IP and manage which external networks can connect to the - * instance. The IPv4 address cannot be disabled for Second Generation - * instances. + * The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. */ ipConfiguration?: Schema$IpConfiguration; /** @@ -1297,58 +1138,39 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The location preference settings. This allows the instance to be located - * as near as possible to either an App Engine app or Compute Engine zone - * for better performance. App Engine co-location is only applicable to - * First Generation instances. + * The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location is only applicable to First Generation instances. */ locationPreference?: Schema$LocationPreference; /** - * The maintenance window for this instance. This specifies when the - * instance can be restarted for maintenance purposes. Not used for First - * Generation instances. + * The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. Not used for First Generation instances. */ maintenanceWindow?: Schema$MaintenanceWindow; /** - * The pricing plan for this instance. This can be either PER_USE or - * PACKAGE. Only PER_USE is supported for Second Generation instances. + * The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances. */ pricingPlan?: string; /** - * The type of replication this instance uses. This can be either - * ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First - * Generation instances. + * The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances. */ replicationType?: string; /** - * The version of instance settings. This is a required field for update - * method to make sure concurrent updates are handled properly. During - * update, use the most recent settingsVersion value for this instance and - * do not try to update this value. + * The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. */ settingsVersion?: string; /** - * Configuration to increase storage size automatically. The default value - * is true. Not used for First Generation instances. + * Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. */ storageAutoResize?: boolean; /** - * The maximum size to which storage capacity can be automatically - * increased. The default value is 0, which specifies that there is no - * limit. Not used for First Generation instances. + * The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. */ storageAutoResizeLimit?: string; /** - * The tier (or machine type) for this instance, for example - * db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL - * instances). For MySQL instances, this property determines whether the - * instance is First or Second Generation. For more information, see - * Instance Settings. + * The tier (or machine type) for this instance, for example db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see Instance Settings. */ tier?: string; /** - * User-provided labels, represented as a dictionary where each label is a - * single key value pair. + * User-provided labels, represented as a dictionary where each label is a single key value pair. */ userLabels?: {[key: string]: string}; } @@ -1369,13 +1191,11 @@ export namespace sqladmin_v1beta4 { */ commonName?: string; /** - * The time when the certificate was created in RFC 3339 format, for example - * 2012-11-15T16:19:00.094Z + * The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z */ createTime?: string; /** - * The time when the certificate expires in RFC 3339 format, for example - * 2012-11-15T16:19:00.094Z. + * The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. */ expirationTime?: string; /** @@ -1404,8 +1224,7 @@ export namespace sqladmin_v1beta4 { */ certInfo?: Schema$SslCert; /** - * The private key for the client cert, in pem format. Keep private in order - * to protect your security. + * The private key for the client cert, in pem format. Keep private in order to protect your security. */ certPrivateKey?: string; } @@ -1423,8 +1242,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$SslCertsInsertRequest { /** - * User supplied name. Must be a distinct name from the other certificates - * for this instance. + * User supplied name. Must be a distinct name from the other certificates for this instance. */ commonName?: string; } @@ -1433,9 +1251,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$SslCertsInsertResponse { /** - * The new client certificate and private key. For First Generation - * instances, the new certificate does not take effect until the instance is - * restarted. + * The new client certificate and private key. For First Generation instances, the new certificate does not take effect until the instance is restarted. */ clientCert?: Schema$SslCertDetail; /** @@ -1447,9 +1263,7 @@ export namespace sqladmin_v1beta4 { */ operation?: Schema$Operation; /** - * The server Certificate Authority's certificate. If this is missing - * you can force a new one to be generated by calling resetSslConfig method - * on instances resource. + * The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource. */ serverCaCert?: Schema$SslCert; } @@ -1487,8 +1301,7 @@ export namespace sqladmin_v1beta4 { */ region?: string[]; /** - * An identifier for the machine type, for example, db-n1-standard-1. For - * related information, see Pricing. + * An identifier for the machine type, for example, db-n1-standard-1. For related information, see Pricing. */ tier?: string; } @@ -1514,8 +1327,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The type of log to truncate. Valid values are MYSQL_GENERAL_TABLE and - * MYSQL_SLOW_TABLE. + * The type of log to truncate. Valid values are MYSQL_GENERAL_TABLE and MYSQL_SLOW_TABLE. */ logType?: string; } @@ -1524,20 +1336,15 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$User { /** - * This field is deprecated and will be removed from a future version of the - * API. + * This field is deprecated and will be removed from a future version of the API. */ etag?: string; /** - * The host name from which the user can connect. For insert operations, - * host defaults to an empty string. For update operations, host is - * specified as part of the request URL. The host name cannot be updated - * after insertion. + * The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. */ host?: string; /** - * The name of the Cloud SQL instance. This does not include the project ID. - * Can be omitted for update since it is already specified on the URL. + * The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL. */ instance?: string; /** @@ -1545,8 +1352,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * The name of the user in the Cloud SQL instance. Can be omitted for update - * since it is already specified in the URL. + * The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified in the URL. */ name?: string; /** @@ -1554,9 +1360,7 @@ export namespace sqladmin_v1beta4 { */ password?: string; /** - * The project ID of the project containing the Cloud SQL database. The - * Google apps domain is prefixed if applicable. Can be omitted for update - * since it is already specified on the URL. + * The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL. */ project?: string; } @@ -1573,9 +1377,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * An identifier that uniquely identifies the operation. You can use this - * identifier to retrieve the Operations resource that has information about - * the operation. + * An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. */ nextPageToken?: string; } @@ -1739,8 +1541,7 @@ export namespace sqladmin_v1beta4 { /** * sql.backupRuns.insert - * @desc Creates a new backup run on demand. This method is applicable only - * to Second Generation instances. + * @desc Creates a new backup run on demand. This method is applicable only to Second Generation instances. * @alias sql.backupRuns.insert * @memberOf! () * @@ -1816,9 +1617,7 @@ export namespace sqladmin_v1beta4 { /** * sql.backupRuns.list - * @desc Lists all backup runs associated with a given instance and - * configuration in the reverse chronological order of the backup initiation - * time. + * @desc Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time. * @alias sql.backupRuns.list * @memberOf! () * @@ -1903,8 +1702,7 @@ export namespace sqladmin_v1beta4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Backup Run to delete. To find a Backup Run ID, use the list - * method. + * The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. */ id?: string; /** @@ -1971,8 +1769,7 @@ export namespace sqladmin_v1beta4 { */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -2064,8 +1861,7 @@ export namespace sqladmin_v1beta4 { /** * sql.databases.get - * @desc Retrieves a resource containing information about a database inside - * a Cloud SQL instance. + * @desc Retrieves a resource containing information about a database inside a Cloud SQL instance. * @alias sql.databases.get * @memberOf! () * @@ -2138,8 +1934,7 @@ export namespace sqladmin_v1beta4 { /** * sql.databases.insert - * @desc Inserts a resource containing information about a database inside a - * Cloud SQL instance. + * @desc Inserts a resource containing information about a database inside a Cloud SQL instance. * @alias sql.databases.insert * @memberOf! () * @@ -2290,8 +2085,7 @@ export namespace sqladmin_v1beta4 { /** * sql.databases.patch - * @desc Updates a resource containing information about a database inside a - * Cloud SQL instance. This method supports patch semantics. + * @desc Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics. * @alias sql.databases.patch * @memberOf! () * @@ -2367,8 +2161,7 @@ export namespace sqladmin_v1beta4 { /** * sql.databases.update - * @desc Updates a resource containing information about a database inside a - * Cloud SQL instance. + * @desc Updates a resource containing information about a database inside a Cloud SQL instance. * @alias sql.databases.update * @memberOf! () * @@ -2649,8 +2442,7 @@ export namespace sqladmin_v1beta4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database type and version you want to retrieve flags for. By default, - * this method returns flags for all database types and versions. + * Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions. */ databaseVersion?: string; } @@ -2663,11 +2455,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.addServerCa - * @desc Add a new trusted Certificate Authority (CA) version for the - * specified instance. Required to prepare for a certificate rotation. If a - * CA version was previously added but never used in a certificate rotation, - * this operation replaces that version. There cannot be more than one CA - * version waiting to be rotated in. + * @desc Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. * @alias sql.instances.addServerCa * @memberOf! () * @@ -2890,8 +2678,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.demoteMaster - * @desc Demotes the stand-alone instance to be a Cloud SQL read replica for - * an external database server. + * @desc Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. * @alias sql.instances.demoteMaster * @memberOf! () * @@ -2967,8 +2754,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.export - * @desc Exports data from a Cloud SQL instance to a Cloud Storage bucket as - * a SQL dump or CSV file. + * @desc Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. * @alias sql.instances.export * @memberOf! () * @@ -3119,8 +2905,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.get - * @desc Retrieves a resource containing information about a Cloud SQL - * instance. + * @desc Retrieves a resource containing information about a Cloud SQL instance. * @alias sql.instances.get * @memberOf! () * @@ -3193,8 +2978,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.import - * @desc Imports data into a Cloud SQL instance from a SQL dump or CSV file in - * Cloud Storage. + * @desc Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage. * @alias sql.instances.import * @memberOf! () * @@ -3342,8 +3126,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.list - * @desc Lists instances under a given project in the alphabetical order of - * the instance name. + * @desc Lists instances under a given project in the alphabetical order of the instance name. * @alias sql.instances.list * @memberOf! () * @@ -3420,11 +3203,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.listServerCas - * @desc Lists all of the trusted Certificate Authorities (CAs) for the - * specified instance. There can be up to three CAs listed: the CA that was - * used to sign the certificate that is currently in use, a CA that has been - * added but not yet used to sign a certificate, and a CA used to sign a - * certificate that has previously rotated out. + * @desc Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out. * @alias sql.instances.listServerCas * @memberOf! () * @@ -3508,10 +3287,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.patch - * @desc Updates settings of a Cloud SQL instance. Caution: This is not a - * partial update, so you must include values for all the settings that you - * want to retain. For partial updates, use patch.. This method supports - * patch semantics. + * @desc Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics. * @alias sql.instances.patch * @memberOf! () * @@ -3585,8 +3361,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.promoteReplica - * @desc Promotes the read replica instance to be a stand-alone Cloud SQL - * instance. + * @desc Promotes the read replica instance to be a stand-alone Cloud SQL instance. * @alias sql.instances.promoteReplica * @memberOf! () * @@ -3661,8 +3436,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.resetSslConfig - * @desc Deletes all client certificates and generates a new server SSL - * certificate for the instance. + * @desc Deletes all client certificates and generates a new server SSL certificate for the instance. * @alias sql.instances.resetSslConfig * @memberOf! () * @@ -3888,8 +3662,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.rotateServerCa - * @desc Rotates the server certificate to one signed by the Certificate - * Authority (CA) version previously added with the addServerCA method. + * @desc Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. * @alias sql.instances.rotateServerCa * @memberOf! () * @@ -4191,9 +3964,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.update - * @desc Updates settings of a Cloud SQL instance. Caution: This is not a - * partial update, so you must include values for all the settings that you - * want to retain. For partial updates, use patch. + * @desc Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch. * @alias sql.instances.update * @memberOf! () * @@ -4289,8 +4060,7 @@ export namespace sqladmin_v1beta4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Cloud SQL instance to be cloned (source). This does not - * include the project ID. + * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. */ instance?: string; /** @@ -4422,8 +4192,7 @@ export namespace sqladmin_v1beta4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Project ID of the project to which the newly created Cloud SQL instances - * should belong. + * Project ID of the project to which the newly created Cloud SQL instances should belong. */ project?: string; @@ -4439,8 +4208,7 @@ export namespace sqladmin_v1beta4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An expression for filtering the results of the request, such as by name - * or label. + * An expression for filtering the results of the request, such as by name or label. */ filter?: string; /** @@ -4448,8 +4216,7 @@ export namespace sqladmin_v1beta4 { */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -4665,8 +4432,7 @@ export namespace sqladmin_v1beta4 { /** * sql.operations.get - * @desc Retrieves an instance operation that has been performed on an - * instance. + * @desc Retrieves an instance operation that has been performed on an instance. * @alias sql.operations.get * @memberOf! () * @@ -4739,8 +4505,7 @@ export namespace sqladmin_v1beta4 { /** * sql.operations.list - * @desc Lists all instance operations that have been performed on the given - * Cloud SQL instance in the reverse chronological order of the start time. + * @desc Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time. * @alias sql.operations.list * @memberOf! () * @@ -4846,8 +4611,7 @@ export namespace sqladmin_v1beta4 { */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -4864,10 +4628,7 @@ export namespace sqladmin_v1beta4 { /** * sql.sslCerts.createEphemeral - * @desc Generates a short-lived X509 certificate containing the provided - * public key and signed by a private key specific to the target instance. - * Users may use the certificate to authenticate as themselves when - * connecting to the database. + * @desc Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. * @alias sql.sslCerts.createEphemeral * @memberOf! () * @@ -4941,8 +4702,7 @@ export namespace sqladmin_v1beta4 { /** * sql.sslCerts.delete - * @desc Deletes the SSL certificate. For First Generation instances, the - * certificate remains valid until the instance is restarted. + * @desc Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. * @alias sql.sslCerts.delete * @memberOf! () * @@ -5017,9 +4777,7 @@ export namespace sqladmin_v1beta4 { /** * sql.sslCerts.get - * @desc Retrieves a particular SSL certificate. Does not include the - * private key (required for usage). The private key must be saved from the - * response to initial creation. + * @desc Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation. * @alias sql.sslCerts.get * @memberOf! () * @@ -5092,9 +4850,7 @@ export namespace sqladmin_v1beta4 { /** * sql.sslCerts.insert - * @desc Creates an SSL certificate and returns it along with the private - * key and server certificate authority. The new certificate will not be - * usable until the instance is restarted. + * @desc Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted. * @alias sql.sslCerts.insert * @memberOf! () * @@ -5349,8 +5105,7 @@ export namespace sqladmin_v1beta4 { /** * sql.tiers.list - * @desc Lists all available machine types (tiers) for Cloud SQL, for - * example, db-n1-standard-1. For related information, see Pricing. + * @desc Lists all available machine types (tiers) for Cloud SQL, for example, db-n1-standard-1. For related information, see Pricing. * @alias sql.tiers.list * @memberOf! () * diff --git a/src/apis/storage/package.json b/src/apis/storage/package.json index f16149ddcfc..09d028ccef7 100644 --- a/src/apis/storage/package.json +++ b/src/apis/storage/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index c747cec1415..924707c2a75 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace storage_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace storage_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -102,7 +99,10 @@ export namespace storage_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.bucketAccessControls = new Resource$Bucketaccesscontrols( this.context @@ -143,19 +143,7 @@ export namespace storage_v1 { responseHeader?: string[]; }>; /** - * The default value for event-based hold on newly created objects in this - * bucket. Event-based hold is a way to retain objects indefinitely until an - * event occurs, signified by the hold's release. After being released, - * such objects will be subject to bucket-level retention (if any). One - * sample use case of this flag is for banks to hold loan documents for at - * least 3 years after loan is paid in full. Here, bucket-level retention is - * 3 years and the event is loan being paid in full. In this example, these - * objects will be held intact for any number of years until the event has - * occurred (event-based hold on the object is released) and then 3 more - * years after that. That means retention duration of the objects begins - * from the moment event-based hold transitioned from true to false. Objects - * under event-based hold cannot be deleted, overwritten or archived until - * the hold is removed. + * The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed. */ defaultEventBasedHold?: boolean; /** @@ -177,8 +165,7 @@ export namespace storage_v1 { bucketPolicyOnly?: {enabled?: boolean; lockedTime?: string}; }; /** - * The ID of the bucket. For buckets, the id and name properties are the - * same. + * The ID of the bucket. For buckets, the id and name properties are the same. */ id?: string; /** @@ -190,8 +177,7 @@ export namespace storage_v1 { */ labels?: {[key: string]: string}; /** - * The bucket's lifecycle configuration. See lifecycle management for - * more information. + * The bucket's lifecycle configuration. See lifecycle management for more information. */ lifecycle?: { rule?: Array<{ @@ -207,14 +193,15 @@ export namespace storage_v1 { }>; }; /** - * The location of the bucket. Object data for objects in the bucket resides - * in physical storage within this region. Defaults to US. See the - * developer's guide for the authoritative list. + * The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. */ location?: string; /** - * The bucket's logging configuration, which defines the destination - * bucket and optional name prefix for the current bucket's logs. + * The type of the bucket location. + */ + locationType?: string; + /** + * The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. */ logging?: {logBucket?: string; logObjectPrefix?: string}; /** @@ -226,8 +213,7 @@ export namespace storage_v1 { */ name?: string; /** - * The owner of the bucket. This is always the project team's owner - * group. + * The owner of the bucket. This is always the project team's owner group. */ owner?: {entity?: string; entityId?: string}; /** @@ -235,15 +221,7 @@ export namespace storage_v1 { */ projectNumber?: string; /** - * The bucket's retention policy. The retention policy enforces a - * minimum retention time for all objects contained in the bucket, based on - * their creation time. Any attempt to overwrite or delete objects younger - * than the retention period will result in a PERMISSION_DENIED error. An - * unlocked retention policy can be modified or removed from the bucket via - * a storage.buckets.update operation. A locked retention policy cannot be - * removed or shortened in duration for the lifetime of the bucket. - * Attempting to remove or decrease period of a locked retention policy will - * result in a PERMISSION_DENIED error. + * The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error. */ retentionPolicy?: { effectiveTime?: string; @@ -255,13 +233,7 @@ export namespace storage_v1 { */ selfLink?: string; /** - * The bucket's default storage class, used whenever no storageClass is - * specified for a newly-created object. This defines how objects in the - * bucket are stored and determines the SLA and the cost of storage. Values - * include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and - * DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the - * bucket is created, it will default to STANDARD. For more information, see - * storage classes. + * The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. */ storageClass?: string; /** @@ -277,9 +249,7 @@ export namespace storage_v1 { */ versioning?: {enabled?: boolean}; /** - * The bucket's website configuration, controlling how the service - * behaves when accessing bucket contents as a web site. See the Static - * Website Examples for more information. + * The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. */ website?: {mainPageSuffix?: string; notFoundPage?: string}; } @@ -300,14 +270,7 @@ export namespace storage_v1 { */ email?: string; /** - * The entity holding the permission, in one of the following forms: - - * user-userId - user-email - group-groupId - group-email - - * domain-domain - project-team-projectId - allUsers - - * allAuthenticatedUsers Examples: - The user liz@example.com would be - * user-liz@example.com. - The group example@googlegroups.com would be - * group-example@googlegroups.com. - To refer to all members of the Google - * Apps for Business domain example.com, the entity would be - * domain-example.com. + * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ entity?: string; /** @@ -323,8 +286,7 @@ export namespace storage_v1 { */ id?: string; /** - * The kind of item this is. For bucket access control entries, this is - * always storage#bucketAccessControl. + * The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. */ kind?: string; /** @@ -349,8 +311,7 @@ export namespace storage_v1 { */ items?: Schema$BucketAccessControl[]; /** - * The kind of item this is. For lists of bucket access control entries, - * this is always storage#bucketAccessControls. + * The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. */ kind?: string; } @@ -363,13 +324,11 @@ export namespace storage_v1 { */ items?: Schema$Bucket[]; /** - * The kind of item this is. For lists of buckets, this is always - * storage#buckets. + * The kind of item this is. For lists of buckets, this is always storage#buckets. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -382,8 +341,7 @@ export namespace storage_v1 { */ address?: string; /** - * Date and time of notification channel expiration, expressed as a Unix - * timestamp, in milliseconds. Optional. + * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ expiration?: string; /** @@ -391,8 +349,7 @@ export namespace storage_v1 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a - * resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". */ kind?: string; /** @@ -404,8 +361,7 @@ export namespace storage_v1 { */ payload?: boolean; /** - * An opaque ID that identifies the resource being watched on this channel. - * Stable across different API versions. + * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ resourceId?: string; /** @@ -413,8 +369,7 @@ export namespace storage_v1 { */ resourceUri?: string; /** - * An arbitrary string delivered to the target address with each - * notification delivered over this channel. Optional. + * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ token?: string; /** @@ -435,8 +390,7 @@ export namespace storage_v1 { */ kind?: string; /** - * The list of source objects that will be concatenated into a single - * object. + * The list of source objects that will be concatenated into a single object. */ sourceObjects?: Array<{ generation?: string; @@ -445,42 +399,32 @@ export namespace storage_v1 { }>; } /** - * Represents an expression text. Example: title: "User account - * presence" description: "Determines whether the request has a user - * account" expression: "size(request.user) > 0" + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** - * Textual representation of an expression in Common Expression Language - * syntax. The application context of the containing message determines - * which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** - * The kind of item this is. For storage, this is always storage#expr. This - * field is ignored on input. + * The kind of item this is. For storage, this is always storage#expr. This field is ignored on input. */ kind?: string; /** - * An optional string indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** - * An optional title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the - * expression. + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** - * JSON template to produce a JSON-style HMAC Key resource for Create - * responses. + * JSON template to produce a JSON-style HMAC Key resource for Create responses. */ export interface Schema$HmacKey { /** @@ -490,7 +434,7 @@ export namespace storage_v1 { /** * Key metadata. */ - metadata?: any; + metadata?: Schema$HmacKeyMetadata; /** * HMAC secret key material. */ @@ -505,7 +449,7 @@ export namespace storage_v1 { */ accessId?: string; /** - * HTTP 1.1 Entity tag for the access-control entry. + * HTTP 1.1 Entity tag for the HMAC key. */ etag?: string; /** @@ -513,8 +457,7 @@ export namespace storage_v1 { */ id?: string; /** - * The kind of item this is. For HMAC Key metadata, this is always - * storage#hmacKeyMetadata. + * The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata. */ kind?: string; /** @@ -551,13 +494,11 @@ export namespace storage_v1 { */ items?: Schema$HmacKeyMetadata[]; /** - * The kind of item this is. For lists of hmacKeys, this is always - * storage#hmacKeysMetadata. + * The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -566,8 +507,7 @@ export namespace storage_v1 { */ export interface Schema$Notification { /** - * An optional list of additional attributes to attach to each Cloud PubSub - * message published for this notification subscription. + * An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription. */ custom_attributes?: {[key: string]: string}; /** @@ -575,8 +515,7 @@ export namespace storage_v1 { */ etag?: string; /** - * If present, only send notifications about listed event types. If empty, - * sent notifications for all event types. + * If present, only send notifications about listed event types. If empty, sent notifications for all event types. */ event_types?: string[]; /** @@ -584,13 +523,11 @@ export namespace storage_v1 { */ id?: string; /** - * The kind of item this is. For notifications, this is always - * storage#notification. + * The kind of item this is. For notifications, this is always storage#notification. */ kind?: string; /** - * If present, only apply this notification configuration to object names - * that begin with this prefix. + * If present, only apply this notification configuration to object names that begin with this prefix. */ object_name_prefix?: string; /** @@ -602,9 +539,7 @@ export namespace storage_v1 { */ selfLink?: string; /** - * The Cloud PubSub topic to which this subscription publishes. Formatted - * as: - * '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' + * The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' */ topic?: string; } @@ -617,8 +552,7 @@ export namespace storage_v1 { */ items?: Schema$Notification[]; /** - * The kind of item this is. For lists of notifications, this is always - * storage#notifications. + * The kind of item this is. For lists of notifications, this is always storage#notifications. */ kind?: string; } @@ -635,14 +569,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * Cache-Control directive for the object data. If omitted, and the object - * is accessible to all anonymous users, the default will be public, - * max-age=3600. + * Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. */ cacheControl?: string; /** - * Number of underlying components that make up this object. Components are - * accumulated by compose operations. + * Number of underlying components that make up this object. Components are accumulated by compose operations. */ componentCount?: number; /** @@ -658,19 +589,15 @@ export namespace storage_v1 { */ contentLanguage?: string; /** - * Content-Type of the object data. If an object is stored without a - * Content-Type, it is served as application/octet-stream. + * Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. */ contentType?: string; /** - * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using - * base64 in big-endian byte order. For more information about using the - * CRC32c checksum, see Hashes and ETags: Best Practices. + * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. */ crc32c?: string; /** - * Metadata of customer-supplied encryption key, if the object is encrypted - * by such a key. + * Metadata of customer-supplied encryption key, if the object is encrypted by such a key. */ customerEncryption?: {encryptionAlgorithm?: string; keySha256?: string}; /** @@ -678,18 +605,7 @@ export namespace storage_v1 { */ etag?: string; /** - * Whether an object is under event-based hold. Event-based hold is a way to - * retain objects until an event occurs, which is signified by the - * hold's release (i.e. this value is set to false). After being - * released (set to false), such objects will be subject to bucket-level - * retention (if any). One sample use case of this flag is for banks to hold - * loan documents for at least 3 years after loan is paid in full. Here, - * bucket-level retention is 3 years and the event is the loan being paid in - * full. In this example, these objects will be held intact for any number - * of years until the event has occurred (event-based hold on the object is - * released) and then 3 more years after that. That means retention duration - * of the objects begins from the moment event-based hold transitioned from - * true to false. + * Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. */ eventBasedHold?: boolean; /** @@ -697,8 +613,7 @@ export namespace storage_v1 { */ generation?: string; /** - * The ID of the object, including the bucket name, object name, and - * generation number. + * The ID of the object, including the bucket name, object name, and generation number. */ id?: string; /** @@ -706,13 +621,11 @@ export namespace storage_v1 { */ kind?: string; /** - * Cloud KMS Key used to encrypt this object, if the object is encrypted by - * such a key. + * Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. */ kmsKeyName?: string; /** - * MD5 hash of the data; encoded using base64. For more information about - * using the MD5 hash, see Hashes and ETags: Best Practices. + * MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. */ md5Hash?: string; /** @@ -724,10 +637,7 @@ export namespace storage_v1 { */ metadata?: {[key: string]: string}; /** - * The version of the metadata for this object at this generation. Used for - * preconditions and for detecting changes in metadata. A metageneration - * number is only meaningful in the context of a particular generation of a - * particular object. + * The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. */ metageneration?: string; /** @@ -739,13 +649,7 @@ export namespace storage_v1 { */ owner?: {entity?: string; entityId?: string}; /** - * A server-determined value that specifies the earliest time that the - * object's retention period expires. This value is in RFC 3339 format. - * Note 1: This field is not provided for objects with an active event-based - * hold, since retention expiration is unknown until the hold is removed. - * Note 2: This value can be provided even when temporary hold is set (so - * that the user can reason about policy without having to first unset the - * temporary hold). + * A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold). */ retentionExpirationTime?: string; /** @@ -761,12 +665,7 @@ export namespace storage_v1 { */ storageClass?: string; /** - * Whether an object is under temporary hold. While this flag is set to - * true, the object is protected against deletion and overwrites. A common - * use case of this flag is regulatory investigations where objects need to - * be retained while the investigation is ongoing. Note that unlike - * event-based hold, temporary hold does not impact retention expiration - * time of an object. + * Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object. */ temporaryHold?: boolean; /** @@ -774,13 +673,11 @@ export namespace storage_v1 { */ timeCreated?: string; /** - * The deletion time of the object in RFC 3339 format. Will be returned if - * and only if this version of the object has been deleted. + * The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. */ timeDeleted?: string; /** - * The time at which the object's storage class was last changed. When - * the object is initially created, it will be set to timeCreated. + * The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. */ timeStorageClassUpdated?: string; /** @@ -805,14 +702,7 @@ export namespace storage_v1 { */ email?: string; /** - * The entity holding the permission, in one of the following forms: - - * user-userId - user-email - group-groupId - group-email - - * domain-domain - project-team-projectId - allUsers - - * allAuthenticatedUsers Examples: - The user liz@example.com would be - * user-liz@example.com. - The group example@googlegroups.com would be - * group-example@googlegroups.com. - To refer to all members of the Google - * Apps for Business domain example.com, the entity would be - * domain-example.com. + * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ entity?: string; /** @@ -832,8 +722,7 @@ export namespace storage_v1 { */ id?: string; /** - * The kind of item this is. For object access control entries, this is - * always storage#objectAccessControl. + * The kind of item this is. For object access control entries, this is always storage#objectAccessControl. */ kind?: string; /** @@ -862,8 +751,7 @@ export namespace storage_v1 { */ items?: Schema$ObjectAccessControl[]; /** - * The kind of item this is. For lists of object access control entries, - * this is always storage#objectAccessControls. + * The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. */ kind?: string; } @@ -876,18 +764,15 @@ export namespace storage_v1 { */ items?: Schema$Object[]; /** - * The kind of item this is. For lists of objects, this is always - * storage#objects. + * The kind of item this is. For lists of objects, this is always storage#objects. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** - * The list of prefixes of objects matching-but-not-listed up to and - * including the requested delimiter. + * The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. */ prefixes?: string[]; } @@ -896,8 +781,7 @@ export namespace storage_v1 { */ export interface Schema$Policy { /** - * An association between a role, which comes with a set of permissions, and - * members who may assume that role. + * An association between a role, which comes with a set of permissions, and members who may assume that role. */ bindings?: Array<{ condition?: Schema$Expr; @@ -909,18 +793,11 @@ export namespace storage_v1 { */ etag?: string; /** - * The kind of item this is. For policies, this is always storage#policy. - * This field is ignored on input. + * The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. */ kind?: string; /** - * The ID of the resource to which this policy belongs. Will be of the form - * projects/_/buckets/bucket for buckets, and - * projects/_/buckets/bucket/objects/object for objects. A specific - * generation may be specified by appending #generationNumber to the end of - * the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. - * The current generation can be denoted with #0. This field is ignored on - * input. + * The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. */ resourceId?: string; } @@ -929,8 +806,7 @@ export namespace storage_v1 { */ export interface Schema$RewriteResponse { /** - * true if the copy is finished; otherwise, false if the copy is in - * progress. This property is always present in the response. + * true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response. */ done?: boolean; /** @@ -938,24 +814,19 @@ export namespace storage_v1 { */ kind?: string; /** - * The total size of the object being copied in bytes. This property is - * always present in the response. + * The total size of the object being copied in bytes. This property is always present in the response. */ objectSize?: string; /** - * A resource containing the metadata for the copied-to object. This - * property is present in the response only when copying completes. + * A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes. */ resource?: Schema$Object; /** - * A token to use in subsequent requests to continue copying data. This - * token is present in the response only when there is more data to copy. + * A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy. */ rewriteToken?: string; /** - * The total bytes written so far, which can be used to provide a waiting - * user with a progress indicator. This property is always present in the - * response. + * The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response. */ totalBytesRewritten?: string; } @@ -968,8 +839,7 @@ export namespace storage_v1 { */ email_address?: string; /** - * The kind of item this is. For notifications, this is always - * storage#notification. + * The kind of item this is. For notifications, this is always storage#notification. */ kind?: string; } @@ -982,20 +852,7 @@ export namespace storage_v1 { */ kind?: string; /** - * The permissions held by the caller. Permissions are always of the format - * storage.resource.capability, where resource is one of buckets or objects. - * The supported permissions are as follows: - storage.buckets.delete — - * Delete bucket. - storage.buckets.get — Read bucket metadata. - - * storage.buckets.getIamPolicy — Read bucket IAM policy. - - * storage.buckets.create — Create bucket. - storage.buckets.list — List - * buckets. - storage.buckets.setIamPolicy — Update bucket IAM policy. - - * storage.buckets.update — Update bucket metadata. - - * storage.objects.delete — Delete object. - storage.objects.get — Read - * object data and metadata. - storage.objects.getIamPolicy — Read object - * IAM policy. - storage.objects.create — Create object. - - * storage.objects.list — List objects. - storage.objects.setIamPolicy — - * Update object IAM policy. - storage.objects.update — Update object - * metadata. + * The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows: - storage.buckets.delete — Delete bucket. - storage.buckets.get — Read bucket metadata. - storage.buckets.getIamPolicy — Read bucket IAM policy. - storage.buckets.create — Create bucket. - storage.buckets.list — List buckets. - storage.buckets.setIamPolicy — Update bucket IAM policy. - storage.buckets.update — Update bucket metadata. - storage.objects.delete — Delete object. - storage.objects.get — Read object data and metadata. - storage.objects.getIamPolicy — Read object IAM policy. - storage.objects.create — Create object. - storage.objects.list — List objects. - storage.objects.setIamPolicy — Update object IAM policy. - storage.objects.update — Update object metadata. */ permissions?: string[]; } @@ -1008,22 +865,19 @@ export namespace storage_v1 { /** * storage.bucketAccessControls.delete - * @desc Permanently deletes the ACL entry for the specified entity on the - * specified bucket. + * @desc Permanently deletes the ACL entry for the specified entity on the specified bucket. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1035,8 +889,7 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * @@ -1057,10 +910,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1071,6 +923,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1138,22 +991,19 @@ export namespace storage_v1 { /** * storage.bucketAccessControls.get - * @desc Returns the ACL entry for the specified entity on the specified - * bucket. + * @desc Returns the ACL entry for the specified entity on the specified bucket. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1165,8 +1015,7 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * @@ -1190,10 +1039,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1204,6 +1052,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1280,14 +1129,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1323,10 +1170,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1336,6 +1182,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().BucketAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1413,14 +1260,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1452,10 +1297,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1465,6 +1309,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1543,14 +1388,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1562,14 +1405,12 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -1593,10 +1434,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1607,6 +1447,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().BucketAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1684,14 +1525,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1703,14 +1542,12 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -1734,10 +1571,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1748,6 +1584,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().BucketAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1829,13 +1666,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -1851,13 +1690,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -1873,8 +1714,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -1895,8 +1739,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -1912,13 +1759,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -1939,13 +1788,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -1970,14 +1821,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2006,10 +1855,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2021,6 +1869,7 @@ export namespace storage_v1 { * @param {string} params.bucket Name of a bucket. * @param {string=} params.ifMetagenerationMatch If set, only deletes the bucket if its metageneration matches this value. * @param {string=} params.ifMetagenerationNotMatch If set, only deletes the bucket if its metageneration does not match this value. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2094,14 +1943,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2133,10 +1980,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2149,6 +1995,7 @@ export namespace storage_v1 { * @param {string=} params.ifMetagenerationMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. * @param {string=} params.ifMetagenerationNotMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. * @param {string=} params.projection Set of properties to return. Defaults to noAcl. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2222,14 +2069,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2261,10 +2106,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2274,6 +2118,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2348,14 +2193,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2391,10 +2234,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2407,6 +2249,7 @@ export namespace storage_v1 { * @param {string=} params.predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket. * @param {string} params.project A valid API project identifier. * @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. * @param {().Bucket} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2478,14 +2321,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2530,10 +2371,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2547,6 +2387,7 @@ export namespace storage_v1 { * @param {string=} params.prefix Filter results to buckets whose names begin with this prefix. * @param {string} params.project A valid API project identifier. * @param {string=} params.projection Set of properties to return. Defaults to noAcl. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2617,6 +2458,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.ifMetagenerationMatch Makes the operation conditional on whether bucket's current metageneration matches the given value. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2683,23 +2525,19 @@ export namespace storage_v1 { /** * storage.buckets.patch - * @desc Patches a bucket. Changes to the bucket will be readable - * immediately after writing, but configuration changes may take time to - * propagate. + * @desc Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2712,8 +2550,7 @@ export namespace storage_v1 { * bucket: 'my-bucket', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -2737,10 +2574,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2755,6 +2591,7 @@ export namespace storage_v1 { * @param {string=} params.predefinedAcl Apply a predefined set of access controls to this bucket. * @param {string=} params.predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket. * @param {string=} params.projection Set of properties to return. Defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().Bucket} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2829,14 +2666,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2849,8 +2684,7 @@ export namespace storage_v1 { * bucket: 'my-bucket', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -2874,10 +2708,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2887,6 +2720,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().Policy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2955,22 +2789,19 @@ export namespace storage_v1 { /** * storage.buckets.testIamPermissions - * @desc Tests a set of permissions on the given bucket to see which, if - * any, are held by the caller. + * @desc Tests a set of permissions on the given bucket to see which, if any, are held by the caller. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3005,10 +2836,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3019,6 +2849,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.permissions Permissions to test. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3094,23 +2925,19 @@ export namespace storage_v1 { /** * storage.buckets.update - * @desc Updates a bucket. Changes to the bucket will be readable - * immediately after writing, but configuration changes may take time to - * propagate. + * @desc Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3123,8 +2950,7 @@ export namespace storage_v1 { * bucket: 'my-bucket', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -3148,10 +2974,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3166,6 +2991,7 @@ export namespace storage_v1 { * @param {string=} params.predefinedAcl Apply a predefined set of access controls to this bucket. * @param {string=} params.predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket. * @param {string=} params.projection Set of properties to return. Defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().Bucket} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3247,13 +3073,15 @@ export namespace storage_v1 { */ ifMetagenerationMatch?: string; /** - * If set, only deletes the bucket if its metageneration does not match this - * value. + * If set, only deletes the bucket if its metageneration does not match this value. */ ifMetagenerationNotMatch?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -3268,13 +3096,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration matches the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration does not match the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -3282,8 +3108,11 @@ export namespace storage_v1 { */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -3299,8 +3128,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -3323,11 +3155,13 @@ export namespace storage_v1 { */ project?: string; /** - * Set of properties to return. Defaults to noAcl, unless the bucket - * resource specifies acl or defaultObjectAcl properties, when it defaults - * to full. + * Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. */ projection?: string; + /** + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; /** * The project to be billed for this request. */ @@ -3345,13 +3179,11 @@ export namespace storage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of buckets to return in a single response. The service - * will use this parameter or 1,000 items, whichever is smaller. + * Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller. */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -3366,6 +3198,10 @@ export namespace storage_v1 { * Set of properties to return. Defaults to noAcl. */ projection?: string; + /** + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; /** * The project to be billed for this request. */ @@ -3383,13 +3219,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * Makes the operation conditional on whether bucket's current - * metageneration matches the given value. + * Makes the operation conditional on whether bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -3404,13 +3242,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration matches the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration does not match the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -3426,8 +3262,11 @@ export namespace storage_v1 { */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -3448,8 +3287,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -3474,8 +3316,11 @@ export namespace storage_v1 { */ permissions?: string[]; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -3490,13 +3335,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration matches the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration does not match the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -3512,8 +3355,11 @@ export namespace storage_v1 { */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -3538,14 +3384,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3575,10 +3419,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3672,22 +3515,19 @@ export namespace storage_v1 { /** * storage.defaultObjectAccessControls.delete - * @desc Permanently deletes the default object ACL entry for the specified - * entity on the specified bucket. + * @desc Permanently deletes the default object ACL entry for the specified entity on the specified bucket. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3699,8 +3539,7 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * @@ -3721,10 +3560,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3735,6 +3573,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3801,22 +3640,19 @@ export namespace storage_v1 { /** * storage.defaultObjectAccessControls.get - * @desc Returns the default object ACL entry for the specified entity on - * the specified bucket. + * @desc Returns the default object ACL entry for the specified entity on the specified bucket. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3828,16 +3664,17 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * * auth: authClient, * }; * - * storage.defaultObjectAccessControls.get(request, function(err, - * response) { if (err) { console.error(err); return; + * storage.defaultObjectAccessControls.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3851,10 +3688,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3865,6 +3701,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3940,14 +3777,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -3966,8 +3801,10 @@ export namespace storage_v1 { * auth: authClient, * }; * - * storage.defaultObjectAccessControls.insert(request, function(err, - * response) { if (err) { console.error(err); return; + * storage.defaultObjectAccessControls.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -3981,10 +3818,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -3994,6 +3830,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().ObjectAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4071,14 +3908,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4093,8 +3928,10 @@ export namespace storage_v1 { * auth: authClient, * }; * - * storage.defaultObjectAccessControls.list(request, function(err, - * response) { if (err) { console.error(err); return; + * storage.defaultObjectAccessControls.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4108,10 +3945,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4123,6 +3959,7 @@ export namespace storage_v1 { * @param {string} params.bucket Name of a bucket. * @param {string=} params.ifMetagenerationMatch If present, only return default ACL listing if the bucket's current metageneration matches this value. * @param {string=} params.ifMetagenerationNotMatch If present, only return default ACL listing if the bucket's current metageneration does not match the given value. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4201,14 +4038,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4220,22 +4055,22 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * * auth: authClient, * }; * - * storage.defaultObjectAccessControls.patch(request, function(err, - * response) { if (err) { console.error(err); return; + * storage.defaultObjectAccessControls.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4249,10 +4084,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4263,6 +4097,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().ObjectAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4339,14 +4174,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4358,22 +4191,22 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * * auth: authClient, * }; * - * storage.defaultObjectAccessControls.update(request, function(err, - * response) { if (err) { console.error(err); return; + * storage.defaultObjectAccessControls.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -4387,10 +4220,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4401,6 +4233,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket Name of a bucket. * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().ObjectAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4481,13 +4314,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -4503,13 +4338,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -4525,8 +4362,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -4547,18 +4387,19 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, only return default ACL listing if the bucket's current - * metageneration matches this value. + * If present, only return default ACL listing if the bucket's current metageneration matches this value. */ ifMetagenerationMatch?: string; /** - * If present, only return default ACL listing if the bucket's current - * metageneration does not match the given value. + * If present, only return default ACL listing if the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -4574,13 +4415,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -4601,13 +4444,15 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -4632,14 +4477,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4671,10 +4514,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4685,6 +4527,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket The parent bucket of the notification. * @param {string} params.notification ID of the notification to delete. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4759,14 +4602,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4801,10 +4642,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4815,6 +4655,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.bucket The parent bucket of the notification. * @param {string} params.notification Notification ID + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4891,14 +4732,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -4934,10 +4773,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -4947,6 +4785,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.bucket The parent bucket of the notification. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().Notification} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5023,14 +4862,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5062,10 +4899,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5075,6 +4911,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.bucket Name of a Google Cloud Storage bucket. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5158,8 +4995,11 @@ export namespace storage_v1 { */ notification?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -5179,8 +5019,11 @@ export namespace storage_v1 { */ notification?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -5196,8 +5039,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -5218,8 +5064,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -5232,22 +5081,19 @@ export namespace storage_v1 { /** * storage.objectAccessControls.delete - * @desc Permanently deletes the ACL entry for the specified entity on the - * specified object. + * @desc Permanently deletes the ACL entry for the specified entity on the specified object. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5259,13 +5105,11 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * @@ -5286,10 +5130,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5302,6 +5145,7 @@ export namespace storage_v1 { * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5368,22 +5212,19 @@ export namespace storage_v1 { /** * storage.objectAccessControls.get - * @desc Returns the ACL entry for the specified entity on the specified - * object. + * @desc Returns the ACL entry for the specified entity on the specified object. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5395,13 +5236,11 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * @@ -5425,10 +5264,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5441,6 +5279,7 @@ export namespace storage_v1 { * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5516,14 +5355,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5535,8 +5372,7 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * @@ -5564,10 +5400,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5579,6 +5414,7 @@ export namespace storage_v1 { * @param {string} params.bucket Name of a bucket. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().ObjectAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5656,14 +5492,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5675,8 +5509,7 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * @@ -5700,10 +5533,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5715,6 +5547,7 @@ export namespace storage_v1 { * @param {string} params.bucket Name of a bucket. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5793,14 +5626,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5812,19 +5643,16 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -5848,10 +5676,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -5864,6 +5691,7 @@ export namespace storage_v1 { * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().ObjectAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5940,14 +5768,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -5959,19 +5785,16 @@ export namespace storage_v1 { * // Name of a bucket. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * - * // The entity holding the permission. Can be user-userId, - * user-emailAddress, group-groupId, + * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, * // group-emailAddress, allUsers, or allAuthenticatedUsers. * entity: 'my-entity', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -5995,10 +5818,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6011,6 +5833,7 @@ export namespace storage_v1 { * @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().ObjectAccessControl} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6091,23 +5914,23 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -6123,23 +5946,23 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -6155,18 +5978,19 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -6187,18 +6011,19 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -6214,23 +6039,23 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -6251,23 +6076,23 @@ export namespace storage_v1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -6285,22 +6110,19 @@ export namespace storage_v1 { /** * storage.objects.compose - * @desc Concatenates a list of existing objects into a new object in the - * same bucket. + * @desc Concatenates a list of existing objects into a new object in the same bucket. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6310,14 +6132,11 @@ export namespace storage_v1 { * authorize(function(authClient) { * var request = { * // Name of the bucket in which to store the new object. - * destinationBucket: 'my-destination-bucket', // TODO: Update - * placeholder value. + * destinationBucket: 'my-destination-bucket', // TODO: Update placeholder value. * - * // Name of the new object. For information about how to URL encode - * object names to be path safe, see + * // Name of the new object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. - * destinationObject: 'my-destination-object', // TODO: Update - * placeholder value. + * destinationObject: 'my-destination-object', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -6343,10 +6162,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6361,6 +6179,7 @@ export namespace storage_v1 { * @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. * @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. * @param {string=} params.kmsKeyName Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().ComposeRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6428,22 +6247,19 @@ export namespace storage_v1 { /** * storage.objects.copy - * @desc Copies a source object to a destination object. Optionally - * overrides metadata. + * @desc Copies a source object to a destination object. Optionally overrides metadata. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6455,24 +6271,18 @@ export namespace storage_v1 { * // Name of the bucket in which to find the source object. * sourceBucket: 'my-source-bucket', // TODO: Update placeholder value. * - * // Name of the source object. For information about how to URL encode - * object names to be path safe, + * // Name of the source object. For information about how to URL encode object names to be path safe, * // see Encoding URI Path Parts. * sourceObject: 'my-source-object', // TODO: Update placeholder value. * - * // Name of the bucket in which to store the new object. Overrides the - * provided object metadata's - * // bucket value, if any.For information about how to URL encode - * object names to be path safe, see + * // Name of the bucket in which to store the new object. Overrides the provided object metadata's + * // bucket value, if any.For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. - * destinationBucket: 'my-destination-bucket', // TODO: Update - * placeholder value. + * destinationBucket: 'my-destination-bucket', // TODO: Update placeholder value. * - * // Name of the new object. Required when the object metadata is not - * otherwise provided. Overrides the + * // Name of the new object. Required when the object metadata is not otherwise provided. Overrides the * // object metadata's name value, if any. - * destinationObject: 'my-destination-object', // TODO: Update - * placeholder value. + * destinationObject: 'my-destination-object', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -6498,10 +6308,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6522,6 +6331,7 @@ export namespace storage_v1 { * @param {string=} params.ifSourceMetagenerationMatch Makes the operation conditional on whether the source object's current metageneration matches the given value. * @param {string=} params.ifSourceMetagenerationNotMatch Makes the operation conditional on whether the source object's current metageneration does not match the given value. * @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string} params.sourceBucket Name of the bucket in which to find the source object. * @param {string=} params.sourceGeneration If present, selects a specific revision of the source object (as opposed to the latest version, the default). * @param {string} params.sourceObject Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @@ -6602,23 +6412,19 @@ export namespace storage_v1 { /** * storage.objects.delete - * @desc Deletes an object and its metadata. Deletions are permanent if - * versioning is not enabled for the bucket, or if the generation parameter - * is used. + * @desc Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6630,8 +6436,7 @@ export namespace storage_v1 { * // Name of the bucket in which the object resides. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * @@ -6652,10 +6457,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6671,6 +6475,7 @@ export namespace storage_v1 { * @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. * @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value. * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6744,14 +6549,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6763,8 +6566,7 @@ export namespace storage_v1 { * // Name of the bucket in which the object resides. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * @@ -6792,10 +6594,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6812,6 +6613,7 @@ export namespace storage_v1 { * @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value. * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. * @param {string=} params.projection Set of properties to return. Defaults to noAcl. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6885,14 +6687,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6904,8 +6704,7 @@ export namespace storage_v1 { * // Name of the bucket in which the object resides. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * @@ -6929,10 +6728,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6944,6 +6742,7 @@ export namespace storage_v1 { * @param {string} params.bucket Name of the bucket in which the object resides. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7018,14 +6817,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7034,8 +6831,7 @@ export namespace storage_v1 { * * authorize(function(authClient) { * var request = { - * // Name of the bucket in which to store the new object. Overrides the - * provided object metadata's + * // Name of the bucket in which to store the new object. Overrides the provided object metadata's * // bucket value, if any. * bucket: 'my-bucket', // TODO: Update placeholder value. * @@ -7046,8 +6842,8 @@ export namespace storage_v1 { * media: { * // TODO: Add desired media content for upload. See * // https://github.com/google/google-api-nodejs-client#media-uploads - * mimeType: '', // See - * https://www.w3.org/Protocols/rfc1341/4_Content-Type.html body: '', + * mimeType: '', // See https://www.w3.org/Protocols/rfc1341/4_Content-Type.html + * body: '', * }, * * auth: authClient, @@ -7070,10 +6866,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7092,6 +6887,7 @@ export namespace storage_v1 { * @param {string=} params.name Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. * @param {string=} params.predefinedAcl Apply a predefined set of access controls to this object. * @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} params.resource Media resource metadata * @param {object} params.media Media object @@ -7173,14 +6969,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7225,10 +7019,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7244,6 +7037,7 @@ export namespace storage_v1 { * @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view. * @param {string=} params.prefix Filter results to objects whose names begin with this prefix. * @param {string=} params.projection Set of properties to return. Defaults to noAcl. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {boolean=} params.versions If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7318,14 +7112,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7337,14 +7129,12 @@ export namespace storage_v1 { * // Name of the bucket in which the object resides. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -7368,10 +7158,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7389,6 +7178,7 @@ export namespace storage_v1 { * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. * @param {string=} params.predefinedAcl Apply a predefined set of access controls to this object. * @param {string=} params.projection Set of properties to return. Defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets. * @param {().Object} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7456,22 +7246,19 @@ export namespace storage_v1 { /** * storage.objects.rewrite - * @desc Rewrites a source object to a destination object. Optionally - * overrides metadata. + * @desc Rewrites a source object to a destination object. Optionally overrides metadata. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7483,24 +7270,18 @@ export namespace storage_v1 { * // Name of the bucket in which to find the source object. * sourceBucket: 'my-source-bucket', // TODO: Update placeholder value. * - * // Name of the source object. For information about how to URL encode - * object names to be path safe, + * // Name of the source object. For information about how to URL encode object names to be path safe, * // see Encoding URI Path Parts. * sourceObject: 'my-source-object', // TODO: Update placeholder value. * - * // Name of the bucket in which to store the new object. Overrides the - * provided object metadata's + * // Name of the bucket in which to store the new object. Overrides the provided object metadata's * // bucket value, if any. - * destinationBucket: 'my-destination-bucket', // TODO: Update - * placeholder value. + * destinationBucket: 'my-destination-bucket', // TODO: Update placeholder value. * - * // Name of the new object. Required when the object metadata is not - * otherwise provided. Overrides the - * // object metadata's name value, if any. For information about how to - * URL encode object names to be + * // Name of the new object. Required when the object metadata is not otherwise provided. Overrides the + * // object metadata's name value, if any. For information about how to URL encode object names to be * // path safe, see Encoding URI Path Parts. - * destinationObject: 'my-destination-object', // TODO: Update - * placeholder value. + * destinationObject: 'my-destination-object', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -7526,10 +7307,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7552,6 +7332,7 @@ export namespace storage_v1 { * @param {string=} params.ifSourceMetagenerationNotMatch Makes the operation conditional on whether the source object's current metageneration does not match the given value. * @param {string=} params.maxBytesRewrittenPerCall The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid. * @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.rewriteToken Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request. * @param {string} params.sourceBucket Name of the bucket in which to find the source object. * @param {string=} params.sourceGeneration If present, selects a specific revision of the source object (as opposed to the latest version, the default). @@ -7642,14 +7423,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7661,14 +7440,12 @@ export namespace storage_v1 { * // Name of the bucket in which the object resides. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -7692,10 +7469,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7707,6 +7483,7 @@ export namespace storage_v1 { * @param {string} params.bucket Name of the bucket in which the object resides. * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().Policy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7775,22 +7552,19 @@ export namespace storage_v1 { /** * storage.objects.testIamPermissions - * @desc Tests a set of permissions on the given object to see which, if - * any, are held by the caller. + * @desc Tests a set of permissions on the given object to see which, if any, are held by the caller. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7802,8 +7576,7 @@ export namespace storage_v1 { * // Name of the bucket in which the object resides. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * @@ -7830,10 +7603,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7846,6 +7618,7 @@ export namespace storage_v1 { * @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default). * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. * @param {string} params.permissions Permissions to test. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7928,14 +7701,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -7947,14 +7718,12 @@ export namespace storage_v1 { * // Name of the bucket in which the object resides. * bucket: 'my-bucket', // TODO: Update placeholder value. * - * // Name of the object. For information about how to URL encode object - * names to be path safe, see + * // Name of the object. For information about how to URL encode object names to be path safe, see * // Encoding URI Path Parts. * object: 'my-object', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties + * // TODO: Add desired properties to the request body. All existing properties * // will be replaced. * }, * @@ -7978,10 +7747,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -7999,6 +7767,7 @@ export namespace storage_v1 { * @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. * @param {string=} params.predefinedAcl Apply a predefined set of access controls to this object. * @param {string=} params.projection Set of properties to return. Defaults to full. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {().Object} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8073,14 +7842,12 @@ export namespace storage_v1 { * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -8116,10 +7883,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -8135,6 +7901,7 @@ export namespace storage_v1 { * @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view. * @param {string=} params.prefix Filter results to objects whose names begin with this prefix. * @param {string=} params.projection Set of properties to return. Defaults to noAcl. + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. Required for Requester Pays buckets. * @param {boolean=} params.versions If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. * @param {().Channel} params.resource Request body data @@ -8209,13 +7976,11 @@ export namespace storage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket containing the source objects. The destination object - * is stored in this bucket. + * Name of the bucket containing the source objects. The destination object is stored in this bucket. */ destinationBucket?: string; /** - * Name of the new object. For information about how to URL encode object - * names to be path safe, see Encoding URI Path Parts. + * Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ destinationObject?: string; /** @@ -8223,26 +7988,23 @@ export namespace storage_v1 { */ destinationPredefinedAcl?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. Setting to 0 makes the operation - * succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Resource name of the Cloud KMS key, of the form - * projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, - * that will be used to encrypt the object. Overrides the object metadata's - * kms_key_name value, if any. + * Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. */ kmsKeyName?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -8258,14 +8020,11 @@ export namespace storage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket in which to store the new object. Overrides the - * provided object metadata's bucket value, if any.For information about how - * to URL encode object names to be path safe, see Encoding URI Path Parts. + * Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ destinationBucket?: string; /** - * Name of the new object. Required when the object metadata is not - * otherwise provided. Overrides the object metadata's name value, if any. + * Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. */ destinationObject?: string; /** @@ -8273,70 +8032,59 @@ export namespace storage_v1 { */ destinationPredefinedAcl?: string; /** - * Makes the operation conditional on whether the destination object's - * current generation matches the given value. Setting to 0 makes the - * operation succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current generation does not match the given value. If no live object - * exists, the precondition fails. Setting to 0 makes the operation succeed - * only if there is a live version of the object. + * Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current metageneration matches the given value. + * Makes the operation conditional on whether the destination object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current metageneration does not match the given value. + * Makes the operation conditional on whether the destination object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * generation matches the given value. + * Makes the operation conditional on whether the source object's current generation matches the given value. */ ifSourceGenerationMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * generation does not match the given value. + * Makes the operation conditional on whether the source object's current generation does not match the given value. */ ifSourceGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the source object's current metageneration matches the given value. */ ifSourceMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the source object's current metageneration does not match the given value. */ ifSourceMetagenerationNotMatch?: string; /** - * Set of properties to return. Defaults to noAcl, unless the object - * resource specifies the acl property, when it defaults to full. + * Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. */ projection?: string; + /** + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; /** * Name of the bucket in which to find the source object. */ sourceBucket?: string; /** - * If present, selects a specific revision of the source object (as opposed - * to the latest version, the default). + * If present, selects a specific revision of the source object (as opposed to the latest version, the default). */ sourceGeneration?: string; /** - * Name of the source object. For information about how to URL encode object - * names to be path safe, see Encoding URI Path Parts. + * Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ sourceObject?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -8356,41 +8104,35 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, permanently deletes a specific revision of this object (as - * opposed to the latest version, the default). + * If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. Setting to 0 makes the operation - * succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. If no live object exists, the - * precondition fails. Setting to 0 makes the operation succeed only if - * there is a live version of the object. + * Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -8405,36 +8147,27 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. Setting to 0 makes the operation - * succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. If no live object exists, the - * precondition fails. Setting to 0 makes the operation succeed only if - * there is a live version of the object. + * Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** @@ -8442,8 +8175,11 @@ export namespace storage_v1 { */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -8459,18 +8195,19 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -8481,53 +8218,35 @@ export namespace storage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket in which to store the new object. Overrides the - * provided object metadata's bucket value, if any. + * Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. */ bucket?: string; /** - * If set, sets the contentEncoding property of the final object to this - * value. Setting this parameter is equivalent to setting the - * contentEncoding metadata property. This can be useful when uploading an - * object with uploadType=media to indicate the encoding of the content - * being uploaded. + * If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded. */ contentEncoding?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. Setting to 0 makes the operation - * succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. If no live object exists, the - * precondition fails. Setting to 0 makes the operation succeed only if - * there is a live version of the object. + * Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Resource name of the Cloud KMS key, of the form - * projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, - * that will be used to encrypt the object. Overrides the object metadata's - * kms_key_name value, if any. + * Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. */ kmsKeyName?: string; /** - * Name of the object. Required when the object metadata is not otherwise - * provided. Overrides the object metadata's name value, if any. For - * information about how to URL encode object names to be path safe, see - * Encoding URI Path Parts. + * Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ name?: string; /** @@ -8535,13 +8254,15 @@ export namespace storage_v1 { */ predefinedAcl?: string; /** - * Set of properties to return. Defaults to noAcl, unless the object - * resource specifies the acl property, when it defaults to full. + * Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -8576,28 +8297,19 @@ export namespace storage_v1 { */ bucket?: string; /** - * Returns results in a directory-like mode. items will contain only objects - * whose names, aside from the prefix, do not contain delimiter. Objects - * whose names, aside from the prefix, contain delimiter will have their - * name, truncated after the delimiter, returned in prefixes. Duplicate - * prefixes are omitted. + * Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. */ delimiter?: string; /** - * If true, objects that end in exactly one instance of delimiter will have - * their metadata included in items in addition to prefixes. + * If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. */ includeTrailingDelimiter?: boolean; /** - * Maximum number of items plus prefixes to return in a single page of - * responses. As duplicate prefixes are omitted, fewer total results may be - * returned than requested. The service will use this parameter or 1,000 - * items, whichever is smaller. + * Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller. */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -8609,13 +8321,15 @@ export namespace storage_v1 { */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; /** - * If true, lists all versions of an object as distinct results. The default - * is false. For more information, see Object Versioning. + * If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. */ versions?: boolean; } @@ -8630,36 +8344,27 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. Setting to 0 makes the operation - * succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. If no live object exists, the - * precondition fails. Setting to 0 makes the operation succeed only if - * there is a live version of the object. + * Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** @@ -8670,6 +8375,10 @@ export namespace storage_v1 { * Set of properties to return. Defaults to full. */ projection?: string; + /** + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; /** * The project to be billed for this request, for Requester Pays buckets. */ @@ -8687,22 +8396,15 @@ export namespace storage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket in which to store the new object. Overrides the - * provided object metadata's bucket value, if any. + * Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. */ destinationBucket?: string; /** - * Resource name of the Cloud KMS key, of the form - * projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, - * that will be used to encrypt the object. Overrides the object metadata's - * kms_key_name value, if any. + * Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. */ destinationKmsKeyName?: string; /** - * Name of the new object. Required when the object metadata is not - * otherwise provided. Overrides the object metadata's name value, if any. - * For information about how to URL encode object names to be path safe, see - * Encoding URI Path Parts. + * Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ destinationObject?: string; /** @@ -8710,69 +8412,51 @@ export namespace storage_v1 { */ destinationPredefinedAcl?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. Setting to 0 makes the operation - * succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. If no live object exists, the - * precondition fails. Setting to 0 makes the operation succeed only if - * there is a live version of the object. + * Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current metageneration matches the given value. + * Makes the operation conditional on whether the destination object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current metageneration does not match the given value. + * Makes the operation conditional on whether the destination object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * generation matches the given value. + * Makes the operation conditional on whether the source object's current generation matches the given value. */ ifSourceGenerationMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * generation does not match the given value. + * Makes the operation conditional on whether the source object's current generation does not match the given value. */ ifSourceGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the source object's current metageneration matches the given value. */ ifSourceMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the source object's current metageneration does not match the given value. */ ifSourceMetagenerationNotMatch?: string; /** - * The maximum number of bytes that will be rewritten per rewrite request. - * Most callers shouldn't need to specify this parameter - it is primarily - * in place to support testing. If specified the value must be an integral - * multiple of 1 MiB (1048576). Also, this only applies to requests where - * the source and destination span locations and/or storage classes. - * Finally, this value must not change across rewrite calls else you'll get - * an error that the rewriteToken is invalid. + * The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid. */ maxBytesRewrittenPerCall?: string; /** - * Set of properties to return. Defaults to noAcl, unless the object - * resource specifies the acl property, when it defaults to full. + * Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. */ projection?: string; /** - * Include this field (from the previous rewrite response) on each rewrite - * request after the first one, until the rewrite response 'done' flag is - * true. Calls that provide a rewriteToken can omit all other request - * fields, but if included those fields must match the values provided in - * the first rewrite request. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request. */ rewriteToken?: string; /** @@ -8780,18 +8464,15 @@ export namespace storage_v1 { */ sourceBucket?: string; /** - * If present, selects a specific revision of the source object (as opposed - * to the latest version, the default). + * If present, selects a specific revision of the source object (as opposed to the latest version, the default). */ sourceGeneration?: string; /** - * Name of the source object. For information about how to URL encode object - * names to be path safe, see Encoding URI Path Parts. + * Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ sourceObject?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -8812,18 +8493,19 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -8844,13 +8526,11 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** @@ -8858,8 +8538,11 @@ export namespace storage_v1 { */ permissions?: string[]; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; } @@ -8874,36 +8557,27 @@ export namespace storage_v1 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. Setting to 0 makes the operation - * succeed only if there are no live versions of the object. + * Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. If no live object exists, the - * precondition fails. Setting to 0 makes the operation succeed only if - * there is a live version of the object. + * Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Name of the object. For information about how to URL encode object names - * to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ object?: string; /** @@ -8915,8 +8589,11 @@ export namespace storage_v1 { */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; @@ -8936,28 +8613,19 @@ export namespace storage_v1 { */ bucket?: string; /** - * Returns results in a directory-like mode. items will contain only objects - * whose names, aside from the prefix, do not contain delimiter. Objects - * whose names, aside from the prefix, contain delimiter will have their - * name, truncated after the delimiter, returned in prefixes. Duplicate - * prefixes are omitted. + * Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. */ delimiter?: string; /** - * If true, objects that end in exactly one instance of delimiter will have - * their metadata included in items in addition to prefixes. + * If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. */ includeTrailingDelimiter?: boolean; /** - * Maximum number of items plus prefixes to return in a single page of - * responses. As duplicate prefixes are omitted, fewer total results may be - * returned than requested. The service will use this parameter or 1,000 - * items, whichever is smaller. + * Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller. */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -8969,13 +8637,15 @@ export namespace storage_v1 { */ projection?: string; /** - * The project to be billed for this request. Required for Requester Pays - * buckets. + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. */ userProject?: string; /** - * If true, lists all versions of an object as distinct results. The default - * is false. For more information, see Object Versioning. + * If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. */ versions?: boolean; @@ -9011,6 +8681,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.projectId Project ID owning the service account. * @param {string} params.serviceAccountEmail Email address of the service account. + * @param {string=} params.userProject The project to be billed for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9083,6 +8754,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.accessId Name of the HMAC key to be deleted. * @param {string} params.projectId Project ID owning the requested key + * @param {string=} params.userProject The project to be billed for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9155,6 +8827,7 @@ export namespace storage_v1 { * @param {object} params Parameters for request * @param {string} params.accessId Name of the HMAC key. * @param {string} params.projectId Project ID owning the service account of the requested key. + * @param {string=} params.userProject The project to be billed for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9227,11 +8900,12 @@ export namespace storage_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of items plus prefixes to return in a single page of responses. Because duplicate prefixes are omitted, fewer total results may be returned than requested. The service uses this parameter or 1,000 items, whichever is smaller. + * @param {integer=} params.maxResults Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned. * @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view. * @param {string} params.projectId Name of the project in which to look for HMAC keys. * @param {string=} params.serviceAccountEmail If present, only keys for the given service account are returned. * @param {boolean=} params.showDeletedKeys Whether or not to show keys in the DELETED state. + * @param {string=} params.userProject The project to be billed for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9299,14 +8973,14 @@ export namespace storage_v1 { /** * storage.projects.hmacKeys.update - * @desc Updates the state of an HMAC key. See the HMAC Key resource - * descriptor for valid states. + * @desc Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. * @alias storage.projects.hmacKeys.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accessId Name of the HMAC key being updated. * @param {string} params.projectId Project ID owning the service account of the updated key. + * @param {string=} params.userProject The project to be billed for this request. * @param {().HmacKeyMetadata} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9389,6 +9063,10 @@ export namespace storage_v1 { * Email address of the service account. */ serviceAccountEmail?: string; + /** + * The project to be billed for this request. + */ + userProject?: string; } export interface Params$Resource$Projects$Hmackeys$Delete extends StandardParameters { @@ -9405,6 +9083,10 @@ export namespace storage_v1 { * Project ID owning the requested key */ projectId?: string; + /** + * The project to be billed for this request. + */ + userProject?: string; } export interface Params$Resource$Projects$Hmackeys$Get extends StandardParameters { @@ -9421,6 +9103,10 @@ export namespace storage_v1 { * Project ID owning the service account of the requested key. */ projectId?: string; + /** + * The project to be billed for this request. + */ + userProject?: string; } export interface Params$Resource$Projects$Hmackeys$List extends StandardParameters { @@ -9430,15 +9116,11 @@ export namespace storage_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of items plus prefixes to return in a single page of - * responses. Because duplicate prefixes are omitted, fewer total results - * may be returned than requested. The service uses this parameter or 1,000 - * items, whichever is smaller. + * Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned. */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -9453,6 +9135,10 @@ export namespace storage_v1 { * Whether or not to show keys in the DELETED state. */ showDeletedKeys?: boolean; + /** + * The project to be billed for this request. + */ + userProject?: string; } export interface Params$Resource$Projects$Hmackeys$Update extends StandardParameters { @@ -9469,6 +9155,10 @@ export namespace storage_v1 { * Project ID owning the service account of the updated key. */ projectId?: string; + /** + * The project to be billed for this request. + */ + userProject?: string; /** * Request body metadata @@ -9484,22 +9174,19 @@ export namespace storage_v1 { /** * storage.projects.serviceAccount.get - * @desc Get the email address of this project's Google Cloud Storage - * service account. + * @desc Get the email address of this project's Google Cloud Storage service account. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Cloud Storage JSON API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storage - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -9531,10 +9218,9 @@ export namespace storage_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -9544,6 +9230,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.projectId Project ID + * @param {string=} params.provisionalUserProject The project to be billed for this request if the target bucket is requester-pays bucket. * @param {string=} params.userProject The project to be billed for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9622,6 +9309,10 @@ export namespace storage_v1 { * Project ID */ projectId?: string; + /** + * The project to be billed for this request if the target bucket is requester-pays bucket. + */ + provisionalUserProject?: string; /** * The project to be billed for this request. */ diff --git a/src/apis/storage/v1beta1.ts b/src/apis/storage/v1beta1.ts index 4366879ab04..c9ffb5c5292 100644 --- a/src/apis/storage/v1beta1.ts +++ b/src/apis/storage/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace storage_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace storage_v1beta1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -98,7 +95,10 @@ export namespace storage_v1beta1 { objects: Resource$Objects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.bucketAccessControls = new Resource$Bucketaccesscontrols( this.context @@ -132,13 +132,11 @@ export namespace storage_v1beta1 { */ kind?: string; /** - * The location of the bucket. Object data for objects in the bucket resides - * in physical storage in this location. Can be US or EU. Defaults to US. + * The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. */ location?: string; /** - * The owner of the bucket. This will always be the project team's owner - * group. + * The owner of the bucket. This will always be the project team's owner group. */ owner?: {entity?: string; entityId?: string}; /** @@ -175,13 +173,7 @@ export namespace storage_v1beta1 { */ email?: string; /** - * The entity holding the permission, in one of the following forms: - - * user-userId - user-email - group-groupId - group-email - - * domain-domain - allUsers - allAuthenticatedUsers Examples: - The user - * liz@example.com would be user-liz@example.com. - The group - * example@googlegroups.com would be group-example@googlegroups.com. - To - * refer to all members of the Google Apps for Business domain example.com, - * the entity would be domain-example.com. + * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ entity?: string; /** @@ -193,8 +185,7 @@ export namespace storage_v1beta1 { */ id?: string; /** - * The kind of item this is. For bucket access control entries, this is - * always storage#bucketAccessControl. + * The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. */ kind?: string; /** @@ -215,8 +206,7 @@ export namespace storage_v1beta1 { */ items?: Schema$BucketAccessControl[]; /** - * The kind of item this is. For lists of bucket access control entries, - * this is always storage#bucketAccessControls. + * The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. */ kind?: string; } @@ -229,13 +219,11 @@ export namespace storage_v1beta1 { */ items?: Schema$Bucket[]; /** - * The kind of item this is. For lists of buckets, this is always - * storage#buckets. + * The kind of item this is. For lists of buckets, this is always storage#buckets. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -276,8 +264,7 @@ export namespace storage_v1beta1 { */ kind?: string; /** - * Object media data. Provided on your behalf when uploading raw media or - * multipart/related with an auxiliary media part. + * Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. */ media?: { algorithm?: string; @@ -322,13 +309,7 @@ export namespace storage_v1beta1 { */ email?: string; /** - * The entity holding the permission, in one of the following forms: - - * user-userId - user-email - group-groupId - group-email - - * domain-domain - allUsers - allAuthenticatedUsers Examples: - The user - * liz@example.com would be user-liz@example.com. - The group - * example@googlegroups.com would be group-example@googlegroups.com. - To - * refer to all members of the Google Apps for Business domain example.com, - * the entity would be domain-example.com. + * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ entity?: string; /** @@ -340,8 +321,7 @@ export namespace storage_v1beta1 { */ id?: string; /** - * The kind of item this is. For object access control entries, this is - * always storage#objectAccessControl. + * The kind of item this is. For object access control entries, this is always storage#objectAccessControl. */ kind?: string; /** @@ -366,8 +346,7 @@ export namespace storage_v1beta1 { */ items?: Schema$ObjectAccessControl[]; /** - * The kind of item this is. For lists of object access control entries, - * this is always storage#objectAccessControls. + * The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. */ kind?: string; } @@ -380,18 +359,15 @@ export namespace storage_v1beta1 { */ items?: Schema$Object[]; /** - * The kind of item this is. For lists of objects, this is always - * storage#objects. + * The kind of item this is. For lists of objects, this is always storage#objects. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** - * The list of prefixes of objects matching-but-not-listed up to and - * including the requested delimiter. + * The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. */ prefixes?: string[]; } @@ -404,8 +380,7 @@ export namespace storage_v1beta1 { /** * storage.bucketAccessControls.delete - * @desc Deletes the ACL entry for the specified entity on the specified - * bucket. + * @desc Deletes the ACL entry for the specified entity on the specified bucket. * @alias storage.bucketAccessControls.delete * @memberOf! () * @@ -478,8 +453,7 @@ export namespace storage_v1beta1 { /** * storage.bucketAccessControls.get - * @desc Returns the ACL entry for the specified entity on the specified - * bucket. + * @desc Returns the ACL entry for the specified entity on the specified bucket. * @alias storage.bucketAccessControls.get * @memberOf! () * @@ -705,8 +679,7 @@ export namespace storage_v1beta1 { /** * storage.bucketAccessControls.patch - * @desc Updates an ACL entry on the specified bucket. This method supports - * patch semantics. + * @desc Updates an ACL entry on the specified bucket. This method supports patch semantics. * @alias storage.bucketAccessControls.patch * @memberOf! () * @@ -869,8 +842,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; } @@ -886,8 +858,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; } @@ -932,8 +903,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; @@ -954,8 +924,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; @@ -1434,9 +1403,7 @@ export namespace storage_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set of properties to return. Defaults to no_acl, unless the bucket - * resource specifies acl or defaultObjectAcl properties, when it defaults - * to full. + * Set of properties to return. Defaults to no_acl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. */ projection?: string; @@ -1456,8 +1423,7 @@ export namespace storage_v1beta1 { */ 'max-results'?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -1518,8 +1484,7 @@ export namespace storage_v1beta1 { /** * storage.objectAccessControls.delete - * @desc Deletes the ACL entry for the specified entity on the specified - * object. + * @desc Deletes the ACL entry for the specified entity on the specified object. * @alias storage.objectAccessControls.delete * @memberOf! () * @@ -1592,8 +1557,7 @@ export namespace storage_v1beta1 { /** * storage.objectAccessControls.get - * @desc Returns the ACL entry for the specified entity on the specified - * object. + * @desc Returns the ACL entry for the specified entity on the specified object. * @alias storage.objectAccessControls.get * @memberOf! () * @@ -1819,8 +1783,7 @@ export namespace storage_v1beta1 { /** * storage.objectAccessControls.patch - * @desc Updates an ACL entry on the specified object. This method supports - * patch semantics. + * @desc Updates an ACL entry on the specified object. This method supports patch semantics. * @alias storage.objectAccessControls.patch * @memberOf! () * @@ -1983,8 +1946,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** @@ -2004,8 +1966,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** @@ -2062,8 +2023,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** @@ -2088,8 +2048,7 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** @@ -2413,8 +2372,7 @@ export namespace storage_v1beta1 { /** * storage.objects.patch - * @desc Updates a data blob's associated metadata. This method supports - * patch semantics. + * @desc Updates a data blob's associated metadata. This method supports patch semantics. * @alias storage.objects.patch * @memberOf! () * @@ -2602,18 +2560,15 @@ export namespace storage_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket in which to store the new object. Overrides the - * provided object metadata's bucket value, if any. + * Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. */ bucket?: string; /** - * Name of the object. Required when the object metadata is not otherwise - * provided. Overrides the object metadata's name value, if any. + * Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. */ name?: string; /** - * Set of properties to return. Defaults to no_acl, unless the object - * resource specifies the acl property, when it defaults to full. + * Set of properties to return. Defaults to no_acl, unless the object resource specifies the acl property, when it defaults to full. */ projection?: string; @@ -2648,21 +2603,15 @@ export namespace storage_v1beta1 { */ bucket?: string; /** - * Returns results in a directory-like mode. items will contain only objects - * whose names, aside from the prefix, do not contain delimiter. Objects - * whose names, aside from the prefix, contain delimiter will have their - * name, truncated after the delimiter, returned in prefixes. Duplicate - * prefixes are omitted. + * Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. */ delimiter?: string; /** - * Maximum number of items plus prefixes to return. As duplicate prefixes - * are omitted, fewer total results may be returned than requested. + * Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. */ 'max-results'?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** diff --git a/src/apis/storage/v1beta2.ts b/src/apis/storage/v1beta2.ts index 417a0388011..2eceb62d3a6 100644 --- a/src/apis/storage/v1beta2.ts +++ b/src/apis/storage/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace storage_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace storage_v1beta2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -100,7 +97,10 @@ export namespace storage_v1beta2 { objects: Resource$Objects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.bucketAccessControls = new Resource$Bucketaccesscontrols( this.context @@ -151,8 +151,7 @@ export namespace storage_v1beta2 { */ kind?: string; /** - * The bucket's lifecycle configuration. See object lifecycle management - * for more information. + * The bucket's lifecycle configuration. See object lifecycle management for more information. */ lifecycle?: { rule?: Array<{ @@ -166,14 +165,11 @@ export namespace storage_v1beta2 { }>; }; /** - * The location of the bucket. Object data for objects in the bucket resides - * in physical storage within this region. Typical values are US and EU. - * Defaults to US. See the developer's guide for the authoritative list. + * The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. */ location?: string; /** - * The bucket's logging configuration, which defines the destination - * bucket and optional name prefix for the current bucket's logs. + * The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. */ logging?: {logBucket?: string; logObjectPrefix?: string}; /** @@ -185,8 +181,7 @@ export namespace storage_v1beta2 { */ name?: string; /** - * The owner of the bucket. This is always the project team's owner - * group. + * The owner of the bucket. This is always the project team's owner group. */ owner?: {entity?: string; entityId?: string}; /** @@ -194,10 +189,7 @@ export namespace storage_v1beta2 { */ selfLink?: string; /** - * The bucket's storage class. This defines how objects in the bucket - * are stored and determines the SLA and the cost of storage. Typical values - * are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See - * the developer's guide for the authoritative list. + * The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. */ storageClass?: string; /** @@ -230,13 +222,7 @@ export namespace storage_v1beta2 { */ email?: string; /** - * The entity holding the permission, in one of the following forms: - - * user-userId - user-email - group-groupId - group-email - - * domain-domain - allUsers - allAuthenticatedUsers Examples: - The user - * liz@example.com would be user-liz@example.com. - The group - * example@googlegroups.com would be group-example@googlegroups.com. - To - * refer to all members of the Google Apps for Business domain example.com, - * the entity would be domain-example.com. + * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ entity?: string; /** @@ -252,8 +238,7 @@ export namespace storage_v1beta2 { */ id?: string; /** - * The kind of item this is. For bucket access control entries, this is - * always storage#bucketAccessControl. + * The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. */ kind?: string; /** @@ -274,8 +259,7 @@ export namespace storage_v1beta2 { */ items?: Schema$BucketAccessControl[]; /** - * The kind of item this is. For lists of bucket access control entries, - * this is always storage#bucketAccessControls. + * The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. */ kind?: string; } @@ -288,13 +272,11 @@ export namespace storage_v1beta2 { */ items?: Schema$Bucket[]; /** - * The kind of item this is. For lists of buckets, this is always - * storage#buckets. + * The kind of item this is. For lists of buckets, this is always storage#buckets. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; } @@ -307,8 +289,7 @@ export namespace storage_v1beta2 { */ address?: string; /** - * Date and time of notification channel expiration, expressed as a Unix - * timestamp, in milliseconds. Optional. + * Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */ expiration?: string; /** @@ -316,8 +297,7 @@ export namespace storage_v1beta2 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a - * resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". */ kind?: string; /** @@ -329,8 +309,7 @@ export namespace storage_v1beta2 { */ payload?: boolean; /** - * An opaque ID that identifies the resource being watched on this channel. - * Stable across different API versions. + * An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */ resourceId?: string; /** @@ -338,8 +317,7 @@ export namespace storage_v1beta2 { */ resourceUri?: string; /** - * An arbitrary string delivered to the target address with each - * notification delivered over this channel. Optional. + * An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */ token?: string; /** @@ -360,8 +338,7 @@ export namespace storage_v1beta2 { */ kind?: string; /** - * The list of source objects that will be concatenated into a single - * object. + * The list of source objects that will be concatenated into a single object. */ sourceObjects?: Array<{ generation?: string; @@ -386,8 +363,7 @@ export namespace storage_v1beta2 { */ cacheControl?: string; /** - * Number of underlying components that make up this object. Components are - * accumulated by compose operations and are limited to a count of 32. + * Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. */ componentCount?: number; /** @@ -407,8 +383,7 @@ export namespace storage_v1beta2 { */ contentType?: string; /** - * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using - * base64. + * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. */ crc32c?: string; /** @@ -440,9 +415,7 @@ export namespace storage_v1beta2 { */ metadata?: {[key: string]: string}; /** - * The generation of the metadata for this object at this generation. Used - * for metadata versioning. Has no meaning outside of the context of this - * generation. + * The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. */ metageneration?: string; /** @@ -466,8 +439,7 @@ export namespace storage_v1beta2 { */ storageClass?: string; /** - * Deletion time of the object in RFC 3339 format. Will be returned if and - * only if this version of the object has been deleted. + * Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. */ timeDeleted?: string; /** @@ -492,13 +464,7 @@ export namespace storage_v1beta2 { */ email?: string; /** - * The entity holding the permission, in one of the following forms: - - * user-userId - user-email - group-groupId - group-email - - * domain-domain - allUsers - allAuthenticatedUsers Examples: - The user - * liz@example.com would be user-liz@example.com. - The group - * example@googlegroups.com would be group-example@googlegroups.com. - To - * refer to all members of the Google Apps for Business domain example.com, - * the entity would be domain-example.com. + * The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. */ entity?: string; /** @@ -518,8 +484,7 @@ export namespace storage_v1beta2 { */ id?: string; /** - * The kind of item this is. For object access control entries, this is - * always storage#objectAccessControl. + * The kind of item this is. For object access control entries, this is always storage#objectAccessControl. */ kind?: string; /** @@ -544,8 +509,7 @@ export namespace storage_v1beta2 { */ items?: any[]; /** - * The kind of item this is. For lists of object access control entries, - * this is always storage#objectAccessControls. + * The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. */ kind?: string; } @@ -558,18 +522,15 @@ export namespace storage_v1beta2 { */ items?: Schema$Object[]; /** - * The kind of item this is. For lists of objects, this is always - * storage#objects. + * The kind of item this is. For lists of objects, this is always storage#objects. */ kind?: string; /** - * The continuation token, used to page through large result sets. Provide - * this value in a subsequent request to return the next page of results. + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string; /** - * The list of prefixes of objects matching-but-not-listed up to and - * including the requested delimiter. + * The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. */ prefixes?: string[]; } @@ -582,8 +543,7 @@ export namespace storage_v1beta2 { /** * storage.bucketAccessControls.delete - * @desc Permanently deletes the ACL entry for the specified entity on the - * specified bucket. + * @desc Permanently deletes the ACL entry for the specified entity on the specified bucket. * @alias storage.bucketAccessControls.delete * @memberOf! () * @@ -656,8 +616,7 @@ export namespace storage_v1beta2 { /** * storage.bucketAccessControls.get - * @desc Returns the ACL entry for the specified entity on the specified - * bucket. + * @desc Returns the ACL entry for the specified entity on the specified bucket. * @alias storage.bucketAccessControls.get * @memberOf! () * @@ -883,8 +842,7 @@ export namespace storage_v1beta2 { /** * storage.bucketAccessControls.patch - * @desc Updates an ACL entry on the specified bucket. This method supports - * patch semantics. + * @desc Updates an ACL entry on the specified bucket. This method supports patch semantics. * @alias storage.bucketAccessControls.patch * @memberOf! () * @@ -1047,8 +1005,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; } @@ -1064,8 +1021,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; } @@ -1110,8 +1066,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; @@ -1132,8 +1087,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; @@ -1599,13 +1553,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration matches the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration does not match the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; } @@ -1620,13 +1572,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration matches the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration does not match the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -1645,9 +1595,7 @@ export namespace storage_v1beta2 { */ project?: string; /** - * Set of properties to return. Defaults to noAcl, unless the bucket - * resource specifies acl or defaultObjectAcl properties, when it defaults - * to full. + * Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. */ projection?: string; @@ -1667,8 +1615,7 @@ export namespace storage_v1beta2 { */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -1691,13 +1638,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration matches the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration does not match the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -1721,13 +1666,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration matches the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the return of the bucket metadata conditional on whether the - * bucket's current metageneration does not match the given value. + * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -1839,8 +1782,7 @@ export namespace storage_v1beta2 { /** * storage.defaultObjectAccessControls.delete - * @desc Permanently deletes the default object ACL entry for the specified - * entity on the specified bucket. + * @desc Permanently deletes the default object ACL entry for the specified entity on the specified bucket. * @alias storage.defaultObjectAccessControls.delete * @memberOf! () * @@ -1912,8 +1854,7 @@ export namespace storage_v1beta2 { /** * storage.defaultObjectAccessControls.get - * @desc Returns the default object ACL entry for the specified entity on - * the specified bucket. + * @desc Returns the default object ACL entry for the specified entity on the specified bucket. * @alias storage.defaultObjectAccessControls.get * @memberOf! () * @@ -2138,8 +2079,7 @@ export namespace storage_v1beta2 { /** * storage.defaultObjectAccessControls.patch - * @desc Updates a default object ACL entry on the specified bucket. This - * method supports patch semantics. + * @desc Updates a default object ACL entry on the specified bucket. This method supports patch semantics. * @alias storage.defaultObjectAccessControls.patch * @memberOf! () * @@ -2300,8 +2240,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; } @@ -2317,8 +2256,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; } @@ -2351,13 +2289,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * If present, only return default ACL listing if the bucket's current - * metageneration matches this value. + * If present, only return default ACL listing if the bucket's current metageneration matches this value. */ ifMetagenerationMatch?: string; /** - * If present, only return default ACL listing if the bucket's current - * metageneration does not match the given value. + * If present, only return default ACL listing if the bucket's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; } @@ -2373,8 +2309,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; @@ -2395,8 +2330,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; @@ -2414,8 +2348,7 @@ export namespace storage_v1beta2 { /** * storage.objectAccessControls.delete - * @desc Permanently deletes the ACL entry for the specified entity on the - * specified object. + * @desc Permanently deletes the ACL entry for the specified entity on the specified object. * @alias storage.objectAccessControls.delete * @memberOf! () * @@ -2489,8 +2422,7 @@ export namespace storage_v1beta2 { /** * storage.objectAccessControls.get - * @desc Returns the ACL entry for the specified entity on the specified - * object. + * @desc Returns the ACL entry for the specified entity on the specified object. * @alias storage.objectAccessControls.get * @memberOf! () * @@ -2719,8 +2651,7 @@ export namespace storage_v1beta2 { /** * storage.objectAccessControls.patch - * @desc Updates an ACL entry on the specified object. This method supports - * patch semantics. + * @desc Updates an ACL entry on the specified object. This method supports patch semantics. * @alias storage.objectAccessControls.patch * @memberOf! () * @@ -2885,13 +2816,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** @@ -2911,13 +2840,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** @@ -2937,8 +2864,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** @@ -2963,8 +2889,7 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** @@ -2984,13 +2909,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** @@ -3015,13 +2938,11 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * The entity holding the permission. Can be user-userId, user-emailAddress, - * group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. + * The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. */ entity?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** @@ -3043,8 +2964,7 @@ export namespace storage_v1beta2 { /** * storage.objects.compose - * @desc Concatenates a list of existing objects into a new object in the - * same bucket. + * @desc Concatenates a list of existing objects into a new object in the same bucket. * @alias storage.objects.compose * @memberOf! () * @@ -3119,8 +3039,7 @@ export namespace storage_v1beta2 { /** * storage.objects.copy - * @desc Copies an object to a destination in the same location. Optionally - * overrides metadata. + * @desc Copies an object to a destination in the same location. Optionally overrides metadata. * @alias storage.objects.copy * @memberOf! () * @@ -3215,9 +3134,7 @@ export namespace storage_v1beta2 { /** * storage.objects.delete - * @desc Deletes data blobs and associated metadata. Deletions are permanent - * if versioning is not enabled for the bucket, or if the generation - * parameter is used. + * @desc Deletes data blobs and associated metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. * @alias storage.objects.delete * @memberOf! () * @@ -3534,8 +3451,7 @@ export namespace storage_v1beta2 { /** * storage.objects.patch - * @desc Updates a data blob's associated metadata. This method supports - * patch semantics. + * @desc Updates a data blob's associated metadata. This method supports patch semantics. * @alias storage.objects.patch * @memberOf! () * @@ -3777,8 +3693,7 @@ export namespace storage_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket containing the source objects. The destination object - * is stored in this bucket. + * Name of the bucket containing the source objects. The destination object is stored in this bucket. */ destinationBucket?: string; /** @@ -3786,13 +3701,11 @@ export namespace storage_v1beta2 { */ destinationObject?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. + * Makes the operation conditional on whether the object's current generation matches the given value. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; @@ -3808,58 +3721,47 @@ export namespace storage_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket in which to store the new object. Overrides the - * provided object metadata's bucket value, if any. + * Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. */ destinationBucket?: string; /** - * Name of the new object. Required when the object metadata is not - * otherwise provided. Overrides the object metadata's name value, if any. + * Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. */ destinationObject?: string; /** - * Makes the operation conditional on whether the destination object's - * current generation matches the given value. + * Makes the operation conditional on whether the destination object's current generation matches the given value. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current generation does not match the given value. + * Makes the operation conditional on whether the destination object's current generation does not match the given value. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current metageneration matches the given value. + * Makes the operation conditional on whether the destination object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the destination object's - * current metageneration does not match the given value. + * Makes the operation conditional on whether the destination object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Makes the operation conditional on whether the source object's generation - * matches the given value. + * Makes the operation conditional on whether the source object's generation matches the given value. */ ifSourceGenerationMatch?: string; /** - * Makes the operation conditional on whether the source object's generation - * does not match the given value. + * Makes the operation conditional on whether the source object's generation does not match the given value. */ ifSourceGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the source object's current metageneration matches the given value. */ ifSourceMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the source object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the source object's current metageneration does not match the given value. */ ifSourceMetagenerationNotMatch?: string; /** - * Set of properties to return. Defaults to noAcl, unless the object - * resource specifies the acl property, when it defaults to full. + * Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. */ projection?: string; /** @@ -3867,8 +3769,7 @@ export namespace storage_v1beta2 { */ sourceBucket?: string; /** - * If present, selects a specific revision of the source object (as opposed - * to the latest version, the default). + * If present, selects a specific revision of the source object (as opposed to the latest version, the default). */ sourceGeneration?: string; /** @@ -3892,28 +3793,23 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * If present, permanently deletes a specific revision of this object (as - * opposed to the latest version, the default). + * If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. + * Makes the operation conditional on whether the object's current generation matches the given value. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. + * Makes the operation conditional on whether the object's current generation does not match the given value. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -3932,28 +3828,23 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's generation - * matches the given value. + * Makes the operation conditional on whether the object's generation matches the given value. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's generation does - * not match the given value. + * Makes the operation conditional on whether the object's generation does not match the given value. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -3972,38 +3863,31 @@ export namespace storage_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the bucket in which to store the new object. Overrides the - * provided object metadata's bucket value, if any. + * Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. */ bucket?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. + * Makes the operation conditional on whether the object's current generation matches the given value. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. + * Makes the operation conditional on whether the object's current generation does not match the given value. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** - * Name of the object. Required when the object metadata is not otherwise - * provided. Overrides the object metadata's name value, if any. + * Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. */ name?: string; /** - * Set of properties to return. Defaults to noAcl, unless the object - * resource specifies the acl property, when it defaults to full. + * Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. */ projection?: string; @@ -4038,21 +3922,15 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * Returns results in a directory-like mode. items will contain only objects - * whose names, aside from the prefix, do not contain delimiter. Objects - * whose names, aside from the prefix, contain delimiter will have their - * name, truncated after the delimiter, returned in prefixes. Duplicate - * prefixes are omitted. + * Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. */ delimiter?: string; /** - * Maximum number of items plus prefixes to return. As duplicate prefixes - * are omitted, fewer total results may be returned than requested. + * Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** @@ -4079,28 +3957,23 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. + * Makes the operation conditional on whether the object's current generation matches the given value. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. + * Makes the operation conditional on whether the object's current generation does not match the given value. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -4128,28 +4001,23 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * If present, selects a specific revision of this object (as opposed to the - * latest version, the default). + * If present, selects a specific revision of this object (as opposed to the latest version, the default). */ generation?: string; /** - * Makes the operation conditional on whether the object's current - * generation matches the given value. + * Makes the operation conditional on whether the object's current generation matches the given value. */ ifGenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * generation does not match the given value. + * Makes the operation conditional on whether the object's current generation does not match the given value. */ ifGenerationNotMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration matches the given value. + * Makes the operation conditional on whether the object's current metageneration matches the given value. */ ifMetagenerationMatch?: string; /** - * Makes the operation conditional on whether the object's current - * metageneration does not match the given value. + * Makes the operation conditional on whether the object's current metageneration does not match the given value. */ ifMetagenerationNotMatch?: string; /** @@ -4177,21 +4045,15 @@ export namespace storage_v1beta2 { */ bucket?: string; /** - * Returns results in a directory-like mode. items will contain only objects - * whose names, aside from the prefix, do not contain delimiter. Objects - * whose names, aside from the prefix, contain delimiter will have their - * name, truncated after the delimiter, returned in prefixes. Duplicate - * prefixes are omitted. + * Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. */ delimiter?: string; /** - * Maximum number of items plus prefixes to return. As duplicate prefixes - * are omitted, fewer total results may be returned than requested. + * Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. */ maxResults?: number; /** - * A previously-returned page token representing part of the larger set of - * results to view. + * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; /** diff --git a/src/apis/storagetransfer/package.json b/src/apis/storagetransfer/package.json index f95408c7b17..b60b93295d9 100644 --- a/src/apis/storagetransfer/package.json +++ b/src/apis/storagetransfer/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index bb63502b753..c3f6180b0ce 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace storagetransfer_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace storagetransfer_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace storagetransfer_v1 { /** * Storage Transfer API * - * Transfers data from external data sources to a Google Cloud Storage bucket - * or between Google Cloud Storage buckets. + * Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets. * * @example * const {google} = require('googleapis'); @@ -115,7 +110,10 @@ export namespace storagetransfer_v1 { transferOperations: Resource$Transferoperations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.googleServiceAccounts = new Resource$Googleserviceaccounts( this.context @@ -126,8 +124,7 @@ export namespace storagetransfer_v1 { } /** - * AWS access key (see [AWS Security - * Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). + * AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). */ export interface Schema$AwsAccessKey { /** @@ -135,63 +132,42 @@ export namespace storagetransfer_v1 { */ accessKeyId?: string; /** - * AWS secret access key. This field is not returned in RPC responses. - * Required. + * AWS secret access key. This field is not returned in RPC responses. Required. */ secretAccessKey?: string; } /** - * An AwsS3Data resource can be a data source, but not a data sink. In an - * AwsS3Data resource, an object's name is the S3 object's key name. + * An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name. */ export interface Schema$AwsS3Data { /** - * AWS access key used to sign the API requests to the AWS S3 bucket. - * Permissions on the bucket must be granted to the access ID of the AWS - * access key. Required. + * AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required. */ awsAccessKey?: Schema$AwsAccessKey; /** - * S3 Bucket name (see [Creating a - * bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). - * Required. + * S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required. */ bucketName?: string; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -203,14 +179,12 @@ export namespace storagetransfer_v1 { */ errorDetails?: string[]; /** - * A URL that refers to the target (a data source, a data sink, or an - * object) with which the error is associated. Required. + * A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. Required. */ url?: string; } /** - * A summary of errors by error code, plus a count and sample error log - * entries. + * A summary of errors by error code, plus a count and sample error log entries. */ export interface Schema$ErrorSummary { /** @@ -222,22 +196,16 @@ export namespace storagetransfer_v1 { */ errorCount?: string; /** - * Error samples. No more than 100 error log entries may be recorded for a - * given error code for a single task. + * Error samples. No more than 100 error log entries may be recorded for a given error code for a single task. */ errorLogEntries?: Schema$ErrorLogEntry[]; } /** - * In a GcsData resource, an object's name is the Google Cloud Storage - * object's name and its `lastModificationTime` refers to the object's - * updated time, which changes when the content or the metadata of the object - * is updated. + * In a GcsData resource, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. */ export interface Schema$GcsData { /** - * Google Cloud Storage bucket name (see [Bucket Name - * Requirements](https://cloud.google.com/storage/docs/naming#requirements)). - * Required. + * Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/naming#requirements)). Required. */ bucketName?: string; } @@ -251,39 +219,11 @@ export namespace storagetransfer_v1 { accountEmail?: string; } /** - * An HttpData resource specifies a list of objects on the web to be - * transferred over HTTP. The information of the objects to be transferred is - * contained in a file referenced by a URL. The first line in the file must be - * "TsvHttpData-1.0", which specifies the format of the file. - * Subsequent lines specify the information of the list of objects, one object - * per list entry. Each entry has the following tab-delimited fields: * HTTP - * URL - The location of the object. * Length - The size of the object in - * bytes. * MD5 - The base64-encoded MD5 hash of the object. For an example - * of a valid TSV file, see [Transferring data from - * URLs](https://cloud.google.com/storage/transfer/create-url-list). When - * transferring data based on a URL list, keep the following in mind: * When - * an object located at `http(s)://hostname:port/<URL-path>` is - * transferred to a data sink, the name of the object at the data sink is - * `<hostname>/<URL-path>`. * If the specified size of an object - * does not match the actual size of the object fetched, the object will not - * be transferred. * If the specified MD5 does not match the MD5 computed - * from the transferred bytes, the object transfer will fail. For more - * information, see [Generating MD5 - * hashes](https://cloud.google.com/storage/transfer/#md5) * Ensure that each - * URL you specify is publicly accessible. For example, in Google Cloud - * Storage you can [share an object publicly] - * (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get - * a link to it. * Storage Transfer Service obeys `robots.txt` rules and - * requires the source HTTP server to support `Range` requests and to return a - * `Content-Length` header in each response. * - * [ObjectConditions](#ObjectConditions) have no effect when filtering objects - * to transfer. + * An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL - The location of the object. * Length - The size of the object in bytes. * MD5 - The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage/transfer/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/<URL-path>` is transferred to a data sink, the name of the object at the data sink is `<hostname>/<URL-path>`. * If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5) * Ensure that each URL you specify is publicly accessible. For example, in Google Cloud Storage you can [share an object publicly] (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * [ObjectConditions](#ObjectConditions) have no effect when filtering objects to transfer. */ export interface Schema$HttpData { /** - * The URL that points to the file that stores the object list entries. This - * file must allow public access. Currently, only URLs with HTTP and HTTPS - * schemes are supported. Required. + * The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required. */ listUrl?: string; } @@ -314,70 +254,32 @@ export namespace storagetransfer_v1 { transferJobs?: Schema$TransferJob[]; } /** - * Conditions that determine which objects will be transferred. Applies only - * to S3 and GCS objects. + * Conditions that determine which objects will be transferred. Applies only to S3 and GCS objects. */ export interface Schema$ObjectConditions { /** - * `excludePrefixes` must follow the requirements described for - * `includePrefixes`. The max size of `excludePrefixes` is 1000. + * `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 1000. */ excludePrefixes?: string[]; /** - * If `includePrefixes` is specified, objects that satisfy the object - * conditions must have names that start with one of the `includePrefixes` - * and that do not start with any of the `excludePrefixes`. If - * `includePrefixes` is not specified, all objects except those that have - * names starting with one of the `excludePrefixes` must satisfy the object - * conditions. Requirements: * Each include-prefix and exclude-prefix - * can contain any sequence of Unicode characters, of max length 1024 - * bytes when UTF8-encoded, and must not contain Carriage Return or Line - * Feed characters. Wildcard matching and regular expression matching - * are not supported. * Each include-prefix and exclude-prefix must omit - * the leading slash. For example, to include the `requests.gz` object - * in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`, - * specify the include prefix as `logs/y=2015/requests.gz`. * None of - * the include-prefix or the exclude-prefix values can be empty, if - * specified. * Each include-prefix must include a distinct portion of - * the object namespace, i.e., no include-prefix may be a prefix of - * another include-prefix. * Each exclude-prefix must exclude a - * distinct portion of the object namespace, i.e., no exclude-prefix may - * be a prefix of another exclude-prefix. * If `includePrefixes` is - * specified, then each exclude-prefix must start with the value of a - * path explicitly included by `includePrefixes`. The max size of - * `includePrefixes` is 1000. + * If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the `requests.gz` object in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 1000. */ includePrefixes?: string[]; /** - * If specified, only objects with a `lastModificationTime` on or after - * `NOW` - `maxTimeElapsedSinceLastModification` and objects that don't - * have a `lastModificationTime` are transferred. Note that `NOW` refers to - * the creation time of the transfer job, and `lastModificationTime` refers - * to the time of the last change to the object's content or metadata. - * Specifically, this would be the `updated` property of GCS objects and the - * `LastModified` field of S3 objects. + * If specified, only objects with a `lastModificationTime` on or after `NOW` - `maxTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that `NOW` refers to the creation time of the transfer job, and `lastModificationTime` refers to the time of the last change to the object's content or metadata. Specifically, this would be the `updated` property of GCS objects and the `LastModified` field of S3 objects. */ maxTimeElapsedSinceLastModification?: string; /** - * If specified, only objects with a `lastModificationTime` before `NOW` - - * `minTimeElapsedSinceLastModification` and objects that don't have a - * `lastModificationTime` are transferred. Note that `NOW` refers to the - * creation time of the transfer job, and `lastModificationTime` refers to - * the time of the last change to the object's content or metadata. - * Specifically, this would be the `updated` property of GCS objects and the - * `LastModified` field of S3 objects. + * If specified, only objects with a `lastModificationTime` before `NOW` - `minTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that `NOW` refers to the creation time of the transfer job, and `lastModificationTime` refers to the time of the last change to the object's content or metadata. Specifically, this would be the `updated` property of GCS objects and the `LastModified` field of S3 objects. */ minTimeElapsedSinceLastModification?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -389,19 +291,11 @@ export namespace storagetransfer_v1 { */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `transferOperations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -418,62 +312,20 @@ export namespace storagetransfer_v1 { */ export interface Schema$Schedule { /** - * The last day the recurring transfer will be run. If `scheduleEndDate` is - * the same as `scheduleStartDate`, the transfer will be executed only once. + * The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once. */ scheduleEndDate?: Schema$Date; /** - * The first day the recurring transfer is scheduled to run. If - * `scheduleStartDate` is in the past, the transfer will run for the first - * time on the following day. Required. + * The first day the recurring transfer is scheduled to run. If `scheduleStartDate` is in the past, the transfer will run for the first time on the following day. Required. */ scheduleStartDate?: Schema$Date; /** - * The time in UTC at which the transfer will be scheduled to start in a - * day. Transfers may start later than this time. If not specified, - * recurring and one-time transfers that are scheduled to run today will run - * immediately; recurring transfers that are scheduled to run on a future - * date will start at approximately midnight UTC on that date. Note that - * when configuring a transfer with the Cloud Platform Console, the - * transfer's start time in a day is specified in your local timezone. + * The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer's start time in a day is specified in your local timezone. */ startTimeOfDay?: Schema$TimeOfDay; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -481,27 +333,20 @@ export namespace storagetransfer_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Represents a time of day. The date and time zone are either not significant - * or are specified elsewhere. An API may choose to allow leap seconds. - * Related types are google.type.Date and `google.protobuf.Timestamp`. + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - * to allow the value "24:00:00" for scenarios like business - * closing time. + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number; /** @@ -513,8 +358,7 @@ export namespace storagetransfer_v1 { */ nanos?: number; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may - * allow the value 60 if it allows leap-seconds. + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number; } @@ -539,9 +383,7 @@ export namespace storagetransfer_v1 { */ bytesFailedToDeleteFromSink?: string; /** - * Bytes found in the data source that are scheduled to be transferred, - * excluding any that are filtered based on object conditions or skipped due - * to sync. + * Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync. */ bytesFoundFromSource?: string; /** @@ -549,13 +391,11 @@ export namespace storagetransfer_v1 { */ bytesFoundOnlyFromSink?: string; /** - * Bytes in the data source that failed to be transferred or that failed to - * be deleted after being transferred. + * Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred. */ bytesFromSourceFailed?: string; /** - * Bytes in the data source that are not transferred because they already - * exist in the data sink. + * Bytes in the data source that are not transferred because they already exist in the data sink. */ bytesFromSourceSkippedBySync?: string; /** @@ -575,9 +415,7 @@ export namespace storagetransfer_v1 { */ objectsFailedToDeleteFromSink?: string; /** - * Objects found in the data source that are scheduled to be transferred, - * excluding any that are filtered based on object conditions or skipped due - * to sync. + * Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync. */ objectsFoundFromSource?: string; /** @@ -585,43 +423,36 @@ export namespace storagetransfer_v1 { */ objectsFoundOnlyFromSink?: string; /** - * Objects in the data source that failed to be transferred or that failed - * to be deleted after being transferred. + * Objects in the data source that failed to be transferred or that failed to be deleted after being transferred. */ objectsFromSourceFailed?: string; /** - * Objects in the data source that are not transferred because they already - * exist in the data sink. + * Objects in the data source that are not transferred because they already exist in the data sink. */ objectsFromSourceSkippedBySync?: string; } /** - * This resource represents the configuration of a transfer job that runs - * periodically. + * This resource represents the configuration of a transfer job that runs periodically. */ export interface Schema$TransferJob { /** - * This field cannot be changed by user requests. + * Output only. The time that the transfer job was created. */ creationTime?: string; /** - * This field cannot be changed by user requests. + * Output only. The time that the transfer job was deleted. */ deletionTime?: string; /** - * A description provided by the user for the job. Its max length is 1024 - * bytes when Unicode-encoded. + * A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. */ description?: string; /** - * This field cannot be changed by user requests. + * Output only. The time that the transfer job was last modified. */ lastModificationTime?: string; /** - * A globally unique name assigned by Storage Transfer Service when the job - * is created. This field should be left empty in requests to create a new - * transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` - * error. + * A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error. */ name?: string; /** @@ -633,12 +464,7 @@ export namespace storagetransfer_v1 { */ schedule?: Schema$Schedule; /** - * Status of the job. This value MUST be specified for - * `CreateTransferJobRequests`. NOTE: The effect of the new job status - * takes place during a subsequent job run. For example, if you change the - * job status from `ENABLED` to `DISABLED`, and an operation spawned by the - * transfer is running, the status change would not affect the current - * operation. + * Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation. */ status?: string; /** @@ -667,8 +493,7 @@ export namespace storagetransfer_v1 { */ name?: string; /** - * The ID of the Google Cloud Platform Project that owns the operation. - * Required. + * The ID of the Google Cloud Platform Project that owns the operation. Required. */ projectId?: string; /** @@ -689,20 +514,15 @@ export namespace storagetransfer_v1 { transferSpec?: Schema$TransferSpec; } /** - * TransferOptions uses three boolean parameters to define the actions to be - * performed on objects in a transfer. + * TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer. */ export interface Schema$TransferOptions { /** - * Whether objects should be deleted from the source after they are - * transferred to the sink. Note that this option and - * `deleteObjectsUniqueInSink` are mutually exclusive. + * Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and `deleteObjectsUniqueInSink` are mutually exclusive. */ deleteObjectsFromSourceAfterTransfer?: boolean; /** - * Whether objects that exist only in the sink should be deleted. Note that - * this option and `deleteObjectsFromSourceAfterTransfer` are mutually - * exclusive. + * Whether objects that exist only in the sink should be deleted. Note that this option and `deleteObjectsFromSourceAfterTransfer` are mutually exclusive. */ deleteObjectsUniqueInSink?: boolean; /** @@ -731,16 +551,11 @@ export namespace storagetransfer_v1 { */ httpDataSource?: Schema$HttpData; /** - * Only objects that satisfy these object conditions are included in the set - * of data source and data sink objects. Object conditions based on - * objects' `lastModificationTime` do not exclude objects in a data - * sink. + * Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink. */ objectConditions?: Schema$ObjectConditions; /** - * If the option `deleteObjectsUniqueInSink` is `true`, object conditions - * based on objects' `lastModificationTime` are ignored and do not - * exclude objects in a data source or a data sink. + * If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink. */ transferOptions?: Schema$TransferOptions; } @@ -749,24 +564,15 @@ export namespace storagetransfer_v1 { */ export interface Schema$UpdateTransferJobRequest { /** - * The ID of the Google Cloud Platform Console project that owns the job. - * Required. + * The ID of the Google Cloud Platform Console project that owns the job. Required. */ projectId?: string; /** - * The job to update. `transferJob` is expected to specify only three - * fields: `description`, `transferSpec`, and `status`. An - * UpdateTransferJobRequest that specifies other fields will be rejected - * with an error `INVALID_ARGUMENT`. Required. + * The job to update. `transferJob` is expected to specify only three fields: `description`, `transferSpec`, and `status`. An UpdateTransferJobRequest that specifies other fields will be rejected with an error `INVALID_ARGUMENT`. Required. */ transferJob?: Schema$TransferJob; /** - * The field mask of the fields in `transferJob` that are to be updated in - * this request. Fields in `transferJob` that can be updated are: - * `description`, `transferSpec`, and `status`. To update the - * `transferSpec` of the job, a complete transfer specification has to be - * provided. An incomplete specification which misses any required fields - * will be rejected with the error `INVALID_ARGUMENT`. + * The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: `description`, `transferSpec`, and `status`. To update the `transferSpec` of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error `INVALID_ARGUMENT`. */ updateTransferJobFieldMask?: string; } @@ -779,27 +585,19 @@ export namespace storagetransfer_v1 { /** * storagetransfer.googleServiceAccounts.get - * @desc Returns the Google service account that is used by Storage Transfer - * Service to access buckets in the project where transfers run or in other - * projects. Each Google service account is associated with one Google Cloud - * Platform Console project. Users should add this service account to the - * Google Cloud Storage bucket ACLs to grant access to Storage Transfer - * Service. This service account is created and owned by Storage Transfer - * Service and can only be used by Storage Transfer Service. + * @desc Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud Platform Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -808,8 +606,7 @@ export namespace storagetransfer_v1 { * * authorize(function(authClient) { * var request = { - * // The ID of the Google Cloud Platform Console project that the - * Google service + * // The ID of the Google Cloud Platform Console project that the Google service * // account is associated with. * // Required. * projectId: 'my-project-id', // TODO: Update placeholder value. @@ -817,8 +614,10 @@ export namespace storagetransfer_v1 { * auth: authClient, * }; * - * storagetransfer.googleServiceAccounts.get(request, function(err, - * response) { if (err) { console.error(err); return; + * storagetransfer.googleServiceAccounts.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -832,10 +631,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -923,8 +721,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Google Cloud Platform Console project that the Google - * service account is associated with. Required. + * The ID of the Google Cloud Platform Console project that the Google service account is associated with. Required. */ projectId?: string; } @@ -944,14 +741,12 @@ export namespace storagetransfer_v1 { * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -984,10 +779,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1070,14 +864,12 @@ export namespace storagetransfer_v1 { * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1088,8 +880,7 @@ export namespace storagetransfer_v1 { * var request = { * // The job to get. * // Required. - * jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder - * value. + * jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1111,10 +902,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1197,14 +987,12 @@ export namespace storagetransfer_v1 { * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1227,9 +1015,8 @@ export namespace storagetransfer_v1 { * return; * } * for (var i = 0; i < transferJobsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `transferJobsPage`: console.log(JSON.stringify(transferJobsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `transferJobsPage`: + * console.log(JSON.stringify(transferJobsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1247,10 +1034,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1330,23 +1116,19 @@ export namespace storagetransfer_v1 { /** * storagetransfer.transferJobs.patch - * @desc Updates a transfer job. Updating a job's transfer spec does not - * affect transfer operations that are running already. Updating the - * scheduling of a job is not allowed. + * @desc Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1357,12 +1139,10 @@ export namespace storagetransfer_v1 { * var request = { * // The name of job to update. * // Required. - * jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder - * value. + * jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties + * // TODO: Add desired properties to the request body. Only these properties * // will be changed. * }, * @@ -1386,10 +1166,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1488,8 +1267,7 @@ export namespace storagetransfer_v1 { */ jobName?: string; /** - * The ID of the Google Cloud Platform Console project that owns the job. - * Required. + * The ID of the Google Cloud Platform Console project that owns the job. Required. */ projectId?: string; } @@ -1501,13 +1279,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of query parameters specified as JSON text in the form of - * {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], - * "job_statuses":["status1","status2",...]}. Since `job_names` and - * `job_statuses` support multiple values, their values must be specified - * with array notation. `project_id` is required. `job_names` and - * `job_statuses` are optional. The valid values for `job_statuses` are - * case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. + * A list of query parameters specified as JSON text in the form of {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. */ filter?: string; /** @@ -1545,23 +1317,19 @@ export namespace storagetransfer_v1 { /** * storagetransfer.transferOperations.cancel - * @desc Cancels a transfer. Use the get method to check whether the - * cancellation succeeded or whether the operation completed despite - * cancellation. + * @desc Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1571,8 +1339,7 @@ export namespace storagetransfer_v1 { * authorize(function(authClient) { * var request = { * // The name of the operation resource to be cancelled. - * name: 'transferOperations/my-transfer-operation', // TODO: Update - * placeholder value. + * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1591,10 +1358,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1668,22 +1434,19 @@ export namespace storagetransfer_v1 { /** * storagetransfer.transferOperations.delete - * @desc This method is not supported and the server returns - * `UNIMPLEMENTED`. + * @desc This method is not supported and the server returns `UNIMPLEMENTED`. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1693,8 +1456,7 @@ export namespace storagetransfer_v1 { * authorize(function(authClient) { * var request = { * // The name of the operation resource to be deleted. - * name: 'transferOperations/my-transfer-operation', // TODO: Update - * placeholder value. + * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. * * auth: authClient, * }; @@ -1713,10 +1475,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1790,23 +1551,19 @@ export namespace storagetransfer_v1 { /** * storagetransfer.transferOperations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1816,14 +1573,15 @@ export namespace storagetransfer_v1 { * authorize(function(authClient) { * var request = { * // The name of the operation resource. - * name: 'transferOperations/my-transfer-operation', // TODO: Update - * placeholder value. + * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. * * auth: authClient, * }; * - * storagetransfer.transferOperations.get(request, function(err, response) - * { if (err) { console.error(err); return; + * storagetransfer.transferOperations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; * } * * // TODO: Change code below to process the `response` object: @@ -1837,10 +1595,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -1916,29 +1673,19 @@ export namespace storagetransfer_v1 { /** * storagetransfer.transferOperations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -1964,9 +1711,8 @@ export namespace storagetransfer_v1 { * return; * } * for (var i = 0; i < operationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `operationsPage`: console.log(JSON.stringify(operationsPage[i], null, - * 2)); + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); * } * * if (response.nextPageToken) { @@ -1984,10 +1730,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2075,14 +1820,12 @@ export namespace storagetransfer_v1 { * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2093,8 +1836,7 @@ export namespace storagetransfer_v1 { * var request = { * // The name of the transfer operation. * // Required. - * name: 'transferOperations/my-transfer-operation', // TODO: Update - * placeholder value. + * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2117,10 +1859,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2202,14 +1943,12 @@ export namespace storagetransfer_v1 { * // 1. If not already done, enable the Google Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -2220,8 +1959,7 @@ export namespace storagetransfer_v1 { * var request = { * // The name of the transfer operation. * // Required. - * name: 'transferOperations/my-transfer-operation', // TODO: Update - * placeholder value. + * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -2244,10 +1982,9 @@ export namespace storagetransfer_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -2365,13 +2102,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of query parameters specified as JSON text in the form of - * {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", - * \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], - * \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, - * `operation_names`, and `transfer_statuses` support multiple values, they - * must be specified with array notation. `job_names`, `operation_names`, - * and `transfer_statuses` are optional. + * A list of query parameters specified as JSON text in the form of {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional. */ filter?: string; /** diff --git a/src/apis/streetviewpublish/package.json b/src/apis/streetviewpublish/package.json index 196d071ce3d..4791f9ce4c7 100644 --- a/src/apis/streetviewpublish/package.json +++ b/src/apis/streetviewpublish/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index 6eb29b6059a..64c66d9510f 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace streetviewpublish_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace streetviewpublish_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace streetviewpublish_v1 { /** * Street View Publish API * - * Publishes 360 photos to Google Maps, along with position, orientation, and - * connectivity metadata. Apps can offer an interface for positioning, - * connecting, and uploading user-generated Street View images. + * Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace streetviewpublish_v1 { photos: Resource$Photos; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.photo = new Resource$Photo(this.context); this.photos = new Resource$Photos(this.context); @@ -127,9 +124,7 @@ export namespace streetviewpublish_v1 { */ export interface Schema$BatchDeletePhotosRequest { /** - * Required. IDs of the Photos. HTTP GET requests require the following - * syntax for the URL query parameter: - * `photoIds=<id1>&photoIds=<id2>&...`. + * Required. IDs of the Photos. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=<id1>&photoIds=<id2>&...`. */ photoIds?: string[]; } @@ -138,8 +133,7 @@ export namespace streetviewpublish_v1 { */ export interface Schema$BatchDeletePhotosResponse { /** - * The status for the operation to delete a single Photo in the batch - * request. + * The status for the operation to delete a single Photo in the batch request. */ status?: Schema$Status[]; } @@ -148,14 +142,12 @@ export namespace streetviewpublish_v1 { */ export interface Schema$BatchGetPhotosResponse { /** - * List of results for each individual Photo requested, in the same order as - * the requests in BatchGetPhotos. + * List of results for each individual Photo requested, in the same order as the requests in BatchGetPhotos. */ results?: Schema$PhotoResponse[]; } /** - * Request to update the metadata of photos. Updating the pixels of photos is - * not supported. + * Request to update the metadata of photos. Updating the pixels of photos is not supported. */ export interface Schema$BatchUpdatePhotosRequest { /** @@ -168,8 +160,7 @@ export namespace streetviewpublish_v1 { */ export interface Schema$BatchUpdatePhotosResponse { /** - * List of results for each individual Photo updated, in the same order as - * the request. + * List of results for each individual Photo updated, in the same order as the request. */ results?: Schema$PhotoResponse[]; } @@ -178,25 +169,16 @@ export namespace streetviewpublish_v1 { */ export interface Schema$Connection { /** - * Required. The destination of the connection from the containing photo to - * another photo. + * Required. The destination of the connection from the containing photo to another photo. */ target?: Schema$PhotoId; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -213,15 +195,11 @@ export namespace streetviewpublish_v1 { */ export interface Schema$Level { /** - * Required. A name assigned to this Level, restricted to 3 characters. - * Consider how the elevator buttons would be labeled for this level if - * there was an elevator. + * Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator. */ name?: string; /** - * Floor number, used for ordering. 0 indicates the ground level, 1 - * indicates the first level above ground level, -1 indicates the first - * level under ground level. Non-integer values are OK. + * Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK. */ number?: number; } @@ -230,25 +208,20 @@ export namespace streetviewpublish_v1 { */ export interface Schema$ListPhotosResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** - * List of photos. The pageSize field in the request determines the number - * of items returned. + * List of photos. The pageSize field in the request determines the number of items returned. */ photos?: Schema$Photo[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -256,26 +229,15 @@ export namespace streetviewpublish_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -284,28 +246,23 @@ export namespace streetviewpublish_v1 { */ export interface Schema$Photo { /** - * Absolute time when the photo was captured. When the photo has no exif - * timestamp, this is used to set a timestamp in the photo metadata. + * Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata. */ captureTime?: string; /** - * Connections to other photos. A connection represents the link from this - * photo to another photo. + * Connections to other photos. A connection represents the link from this photo to another photo. */ connections?: Schema$Connection[]; /** - * Output only. The download URL for the photo bytes. This field is set only - * when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL. + * Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL. */ downloadUrl?: string; /** - * Output only. Status in Google Maps, whether this photo was published or - * rejected. + * Output only. Status in Google Maps, whether this photo was published or rejected. */ mapsPublishStatus?: string; /** - * Required when updating a photo. Output only when creating a photo. - * Identifier for the photo, which is unique among all photos in Google. + * Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google. */ photoId?: Schema$PhotoId; /** @@ -329,8 +286,7 @@ export namespace streetviewpublish_v1 { */ transferStatus?: string; /** - * Required when creating a photo. Input only. The resource URL where the - * photo bytes are uploaded to. + * Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to. */ uploadReference?: Schema$UploadRef; /** @@ -348,8 +304,7 @@ export namespace streetviewpublish_v1 { id?: string; } /** - * Response payload for a single Photo in batch operations including - * BatchGetPhotos and BatchUpdatePhotos. + * Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos. */ export interface Schema$PhotoResponse { /** @@ -357,8 +312,7 @@ export namespace streetviewpublish_v1 { */ photo?: Schema$Photo; /** - * The status for the operation to get or update a single photo in the batch - * request. + * The status for the operation to get or update a single photo in the batch request. */ status?: Schema$Status; } @@ -367,9 +321,7 @@ export namespace streetviewpublish_v1 { */ export interface Schema$Place { /** - * Output-only. The language_code that the name is localized with. This - * should be the language_code specified in the request, but may be a - * fallback. + * Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback. */ languageCode?: string; /** @@ -377,8 +329,7 @@ export namespace streetviewpublish_v1 { */ name?: string; /** - * Place identifier, as described in - * https://developers.google.com/places/place-id. + * Place identifier, as described in https://developers.google.com/places/place-id. */ placeId?: string; } @@ -387,32 +338,19 @@ export namespace streetviewpublish_v1 { */ export interface Schema$Pose { /** - * The estimated horizontal accuracy of this pose in meters with 68% - * confidence (one standard deviation). For example, on Android, this value - * is available from this method: - * https://developer.android.com/reference/android/location/Location#getAccuracy(). - * Other platforms have different methods of obtaining similar accuracy - * estimations. + * The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations. */ accuracyMeters?: number; /** - * Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an - * unmeasured quantity. + * Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity. */ altitude?: number; /** - * Compass heading, measured at the center of the photo in degrees clockwise - * from North. Value must be >=0 and <360. NaN indicates an unmeasured - * quantity. + * Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. */ heading?: number; /** - * Latitude and longitude pair of the pose, as explained here: - * https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng - * When creating a Photo, if the latitude and longitude pair are not - * provided, the geolocation from the exif header is used. A latitude and - * longitude pair not provided in the photo or exif header causes the photo - * process to fail. + * Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail. */ latLngPair?: Schema$LatLng; /** @@ -420,53 +358,16 @@ export namespace streetviewpublish_v1 { */ level?: Schema$Level; /** - * Pitch, measured at the center of the photo in degrees. Value must be - * >=-90 and <= 90. A value of -90 means looking directly down, and a - * value of 90 means looking directly up. NaN indicates an unmeasured - * quantity. + * Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity. */ pitch?: number; /** - * Roll, measured in degrees. Value must be >= 0 and <360. A value of - * 0 means level with the horizon. NaN indicates an unmeasured quantity. + * Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity. */ roll?: number; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -474,20 +375,16 @@ export namespace streetviewpublish_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } /** - * Request to update the metadata of a Photo. Updating the pixels of a photo - * is not supported. + * Request to update the metadata of a Photo. Updating the pixels of a photo is not supported. */ export interface Schema$UpdatePhotoRequest { /** @@ -495,18 +392,7 @@ export namespace streetviewpublish_v1 { */ photo?: Schema$Photo; /** - * Mask that identifies fields on the photo metadata to update. If not - * present, the old Photo metadata is entirely replaced with the new Photo - * metadata in this request. The update fails if invalid fields are - * specified. Multiple fields can be specified in a comma-delimited list. - * The following fields are valid: * `pose.heading` * `pose.latLngPair` * - * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * - * `connections` * `places` <aside - * class="note"><b>Note:</b> When updateMask - * contains repeated fields, the entire set of repeated values get replaced - * with the new contents. For example, if updateMask contains `connections` - * and `UpdatePhotoRequest.photo.connections` is empty, all connections are - * removed.</aside> + * Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` <aside class="note"><b>Note:</b> When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.</aside> */ updateMask?: string; } @@ -515,9 +401,7 @@ export namespace streetviewpublish_v1 { */ export interface Schema$UploadRef { /** - * Required. An upload reference should be unique for each user. It follows - * the form: - * "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}" + * Required. An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}" */ uploadUrl?: string; } @@ -530,18 +414,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photo.create - * @desc After the client finishes uploading the photo with the returned - * UploadRef, CreatePhoto publishes the uploaded Photo to Street View on - * Google Maps. Currently, the only way to set heading, pitch, and roll in - * CreatePhoto is through the [Photo Sphere XMP - * metadata](https://developers.google.com/streetview/spherical-metadata) in - * the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`, - * `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose. This - * method returns the following error codes: * - * google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if the - * uploaded photo is not a 360 photo. * google.rpc.Code.NOT_FOUND if the - * upload reference does not exist. * google.rpc.Code.RESOURCE_EXHAUSTED if - * the account has reached the storage limit. + * @desc After the client finishes uploading the photo with the returned UploadRef, CreatePhoto publishes the uploaded Photo to Street View on Google Maps. Currently, the only way to set heading, pitch, and roll in CreatePhoto is through the [Photo Sphere XMP metadata](https://developers.google.com/streetview/spherical-metadata) in the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`, `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose. This method returns the following error codes: * google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if the uploaded photo is not a 360 photo. * google.rpc.Code.NOT_FOUND if the upload reference does not exist. * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the storage limit. * @alias streetviewpublish.photo.create * @memberOf! () * @@ -610,10 +483,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photo.delete - * @desc Deletes a Photo and its metadata. This method returns the - * following error codes: * google.rpc.Code.PERMISSION_DENIED if the - * requesting user did not create the requested photo. * - * google.rpc.Code.NOT_FOUND if the photo ID does not exist. + * @desc Deletes a Photo and its metadata. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.NOT_FOUND if the photo ID does not exist. * @alias streetviewpublish.photo.delete * @memberOf! () * @@ -685,12 +555,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photo.get - * @desc Gets the metadata of the specified Photo. This method returns the - * following error codes: * google.rpc.Code.PERMISSION_DENIED if the - * requesting user did not create the requested Photo. * - * google.rpc.Code.NOT_FOUND if the requested Photo does not exist. * - * google.rpc.Code.UNAVAILABLE if the requested Photo is still being - * indexed. + * @desc Gets the metadata of the specified Photo. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested Photo. * google.rpc.Code.NOT_FOUND if the requested Photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed. * @alias streetviewpublish.photo.get * @memberOf! () * @@ -764,19 +629,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photo.startUpload - * @desc Creates an upload session to start uploading photo bytes. The - * method uses the upload URL of the returned UploadRef to upload the bytes - * for the Photo. In addition to the photo requirements shown in - * https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, - * the photo must meet the following requirements: * Photo Sphere XMP - * metadata must be included in the photo medadata. See - * https://developers.google.com/streetview/spherical-metadata for the - * required fields. * The pixel size of the photo must meet the size - * requirements listed in - * https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, - * and the photo must be a full 360 horizontally. After the upload - * completes, the method uses UploadRef with CreatePhoto to create the Photo - * object entry. + * @desc Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo medadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry. * @alias streetviewpublish.photo.startUpload * @memberOf! () * @@ -851,16 +704,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photo.update - * @desc Updates the metadata of a Photo, such as pose, place association, - * connections, etc. Changing the pixels of a photo is not supported. Only - * the fields specified in the updateMask field are used. If `updateMask` is - * not present, the update applies to all fields. This method returns the - * following error codes: * google.rpc.Code.PERMISSION_DENIED if the - * requesting user did not create the requested photo. * - * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * - * google.rpc.Code.NOT_FOUND if the requested photo does not exist. * - * google.rpc.Code.UNAVAILABLE if the requested Photo is still being - * indexed. + * @desc Updates the metadata of a Photo, such as pose, place association, connections, etc. Changing the pixels of a photo is not supported. Only the fields specified in the updateMask field are used. If `updateMask` is not present, the update applies to all fields. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * google.rpc.Code.NOT_FOUND if the requested photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed. * @alias streetviewpublish.photo.update * @memberOf! () * @@ -959,11 +803,7 @@ export namespace streetviewpublish_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more - * information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If - * language_code is unspecified, the user's language preference for Google - * services is used. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. */ languageCode?: string; /** @@ -971,8 +811,7 @@ export namespace streetviewpublish_v1 { */ photoId?: string; /** - * Specifies if a download URL for the photo bytes should be returned in the - * Photo response. + * Specifies if a download URL for the photo bytes should be returned in the Photo response. */ view?: string; } @@ -999,17 +838,7 @@ export namespace streetviewpublish_v1 { */ id?: string; /** - * Mask that identifies fields on the photo metadata to update. If not - * present, the old Photo metadata is entirely replaced with the new Photo - * metadata in this request. The update fails if invalid fields are - * specified. Multiple fields can be specified in a comma-delimited list. - * The following fields are valid: * `pose.heading` * `pose.latLngPair` * - * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * - * `connections` * `places` + * Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` */ updateMask?: string; @@ -1027,12 +856,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photos.batchDelete - * @desc Deletes a list of Photos and their metadata. Note that if - * BatchDeletePhotos fails, either critical fields are missing or there is - * an authentication error. Even if BatchDeletePhotos succeeds, individual - * photos in the batch may have failures. These failures are specified in - * each PhotoResponse.status in BatchDeletePhotosResponse.results. See - * DeletePhoto for specific failures that can occur per photo. + * @desc Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo. * @alias streetviewpublish.photos.batchDelete * @memberOf! () * @@ -1114,12 +938,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photos.batchGet - * @desc Gets the metadata of the specified Photo batch. Note that if - * BatchGetPhotos fails, either critical fields are missing or there is an - * authentication error. Even if BatchGetPhotos succeeds, individual photos - * in the batch may have failures. These failures are specified in each - * PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for - * specific failures that can occur per photo. + * @desc Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo. * @alias streetviewpublish.photos.batchGet * @memberOf! () * @@ -1199,19 +1018,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photos.batchUpdate - * @desc Updates the metadata of Photos, such as pose, place association, - * connections, etc. Changing the pixels of photos is not supported. Note - * that if BatchUpdatePhotos fails, either critical fields are missing or - * there is an authentication error. Even if BatchUpdatePhotos succeeds, - * individual photos in the batch may have failures. These failures are - * specified in each PhotoResponse.status in - * BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures - * that can occur per photo. Only the fields specified in updateMask field - * are used. If `updateMask` is not present, the update applies to all - * fields. The number of UpdatePhotoRequest messages in a - * BatchUpdatePhotosRequest must not exceed 20. + * @desc Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. * @alias streetviewpublish.photos.batchUpdate * @memberOf! () * @@ -1293,9 +1100,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photos.list - * @desc Lists all the Photos that belong to the user. + * @desc Lists all the Photos that belong to the user. * @alias streetviewpublish.photos.list * @memberOf! () * @@ -1388,21 +1193,15 @@ export namespace streetviewpublish_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more - * information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If - * language_code is unspecified, the user's language preference for Google - * services is used. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. */ languageCode?: string; /** - * Required. IDs of the Photos. For HTTP GET requests, the URL query - * parameter should be `photoIds=&photoIds=&...`. + * Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`. */ photoIds?: string[]; /** - * Specifies if a download URL for the photo bytes should be returned in the - * Photo response. + * Specifies if a download URL for the photo bytes should be returned in the Photo response. */ view?: string; } @@ -1425,35 +1224,23 @@ export namespace streetviewpublish_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter expression. For example: - * `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the - * moment is `placeId`. + * The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`. */ filter?: string; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more - * information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If - * language_code is unspecified, the user's language preference for Google - * services is used. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. */ languageCode?: string; /** - * The maximum number of photos to return. `pageSize` must be non-negative. - * If `pageSize` is zero or is not provided, the default page size of 100 is - * used. The number of photos returned in the response may be less than - * `pageSize` if the number of photos that belong to the user is less than - * `pageSize`. + * The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 is used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`. */ pageSize?: number; /** - * The nextPageToken value returned from a previous ListPhotos request, if - * any. + * The nextPageToken value returned from a previous ListPhotos request, if any. */ pageToken?: string; /** - * Specifies if a download URL for the photos bytes should be returned in - * the Photos response. + * Specifies if a download URL for the photos bytes should be returned in the Photos response. */ view?: string; } diff --git a/src/apis/surveys/package.json b/src/apis/surveys/package.json index 62172209b90..58e78489078 100644 --- a/src/apis/surveys/package.json +++ b/src/apis/surveys/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/surveys/v2.ts b/src/apis/surveys/v2.ts index 1131e06f0af..c864461c99c 100644 --- a/src/apis/surveys/v2.ts +++ b/src/apis/surveys/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace surveys_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace surveys_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace surveys_v2 { /** * Surveys API * - * Creates and conducts surveys, lists the surveys that an authenticated user - * owns, and retrieves survey results and information about specified surveys. + * Creates and conducts surveys, lists the surveys that an authenticated user owns, and retrieves survey results and information about specified surveys. * * @example * const {google} = require('googleapis'); @@ -97,7 +93,10 @@ export namespace surveys_v2 { surveys: Resource$Surveys; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.results = new Resource$Results(this.context); this.surveys = new Resource$Surveys(this.context); @@ -133,9 +132,7 @@ export namespace surveys_v2 { */ cost?: Schema$SurveyCost; /** - * Additional information to store on behalf of the API consumer and - * associate with this question. This binary blob is treated as opaque. This - * field is limited to 64K bytes. + * Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes. */ customerData?: string; /** @@ -143,8 +140,7 @@ export namespace surveys_v2 { */ description?: string; /** - * List of email addresses for survey owners. Must contain at least the - * address of the user making the API call. + * List of email addresses for survey owners. Must contain at least the address of the user making the API call. */ owners?: string[]; /** @@ -152,8 +148,7 @@ export namespace surveys_v2 { */ questions?: Schema$SurveyQuestion[]; /** - * Reason for the survey being rejected. Only present if the survey state is - * rejected. + * Reason for the survey being rejected. Only present if the survey state is rejected. */ rejectionReason?: Schema$SurveyRejection; /** @@ -178,24 +173,15 @@ export namespace surveys_v2 { */ export interface Schema$SurveyAudience { /** - * Optional list of age buckets to target. Supported age buckets are: - * ['18-24', '25-34', '35-44', '45-54', - * '55-64', '65+'] + * Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+'] */ ages?: string[]; /** - * Required country code that surveys should be targeted to. Accepts - * standard ISO 3166-1 2 character language codes. For instance, - * 'US' for the United States, and 'GB' for the United - * Kingdom. + * Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. */ country?: string; /** - * Country subdivision (states/provinces/etc) that surveys should be - * targeted to. For all countries except GB, ISO-3166-2 subdivision code is - * required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 - * statistical region codes for the United Kingdom is required (eg. - * 'UK-UKC' for North East England). + * Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England). */ countrySubdivision?: string; /** @@ -203,12 +189,7 @@ export namespace surveys_v2 { */ gender?: string; /** - * Language code that surveys should be targeted to. For instance, - * 'en-US'. Surveys may target bilingual users by specifying a list - * of language codes (for example, 'de' and 'en-US'). In - * that case, all languages will be used for targeting users but the survey - * content (which is displayed) must match the first language listed. - * Accepts standard BCP47 language codes. See specification. + * Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification. */ languages?: string[]; /** @@ -221,8 +202,7 @@ export namespace surveys_v2 { */ export interface Schema$SurveyCost { /** - * Cost per survey response in nano units of the given currency. To get the - * total cost for a survey, multiply this value by wanted_response_count. + * Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count. */ costPerResponseNanos?: string; /** @@ -230,28 +210,11 @@ export namespace surveys_v2 { */ currencyCode?: string; /** - * *Deprecated* Threshold to start a survey automatically if the quoted - * price is at most this value. When a survey has a Screener (threshold) - * question, it must go through an incidence pricing test to determine the - * final cost per response. Typically you will have to make a followup call - * to start the survey giving the final computed cost per response. If the - * survey has no threshold_answers, setting this property will return an - * error. By specifying this property, you indicate the max price per - * response you are willing to pay in advance of the incidence test. If the - * price turns out to be lower than the specified value, the survey will - * begin immediately and you will be charged at the rate determined by the - * incidence pricing test. If the price turns out to be greater than the - * specified value the survey will not be started and you will instead be - * notified what price was determined by the incidence test. At that point, - * you must raise the value of this property to be greater than or equal to - * that cost before attempting to start the survey again. This will - * immediately start the survey as long the incidence test was run within - * the last 21 days. This will no longer be available after June 2018. + * *Deprecated* Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days. This will no longer be available after June 2018. */ maxCostPerResponseNanos?: string; /** - * Cost of survey in nano units of the given currency. DEPRECATED in favor - * of cost_per_response_nanos + * Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos */ nanos?: string; } @@ -260,8 +223,7 @@ export namespace surveys_v2 { */ export interface Schema$SurveyQuestion { /** - * The randomization option for multiple choice and multi-select questions. - * If not specified, this option defaults to randomize. + * The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize. */ answerOrder?: string; /** @@ -269,16 +231,11 @@ export namespace surveys_v2 { */ answers?: string[]; /** - * Option to allow open-ended text box for Single Answer and Multiple Answer - * question types. This can be used with SINGLE_ANSWER, - * SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and - * MULTIPLE_ANSWERS_WITH_IMAGE question types. + * Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types. */ hasOther?: boolean; /** - * For rating questions, the text for the higher end of the scale, such as - * 'Best'. For numeric questions, a string representing a - * floating-point that is the maximum allowed number for a response. + * For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response. */ highValueLabel?: string; images?: Schema$SurveyQuestionImage[]; @@ -287,14 +244,11 @@ export namespace surveys_v2 { */ lastAnswerPositionPinned?: boolean; /** - * For rating questions, the text for the lower end of the scale, such as - * 'Worst'. For numeric questions, a string representing a - * floating-point that is the minimum allowed number for a response. + * For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response. */ lowValueLabel?: string; /** - * Option to force the user to pick one of the open text suggestions. This - * requires that suggestions are provided for this question. + * Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question. */ mustPickSuggestion?: boolean; /** @@ -306,8 +260,7 @@ export namespace surveys_v2 { */ openTextPlaceholder?: string; /** - * A list of suggested answers for open text question auto-complete. This is - * only valid if single_line_response is true. + * A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true. */ openTextSuggestions?: string[]; /** @@ -315,30 +268,23 @@ export namespace surveys_v2 { */ question?: string; /** - * Used by the Rating Scale with Text question type. This text goes along - * with the question field that is presented to the respondent, and is the - * actual text that the respondent is asked to rate. + * Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate. */ sentimentText?: string; /** - * Option to allow multiple line open text responses instead of a single - * line response. Note that we don't show auto-complete suggestions with - * multiple line responses. + * Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses. */ singleLineResponse?: boolean; /** - * The threshold/screener answer options, which will screen a user into the - * rest of the survey. These will be a subset of the answer option strings. + * The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings. */ thresholdAnswers?: string[]; /** - * Required field defining the question type. For details about configuring - * different type of questions, consult the question configuration guide. + * Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide. */ type?: string; /** - * Optional unit of measurement for display (for example: hours, people, - * miles). + * Optional unit of measurement for display (for example: hours, people, miles). */ unitOfMeasurementLabel?: string; /** @@ -355,8 +301,7 @@ export namespace surveys_v2 { */ altText?: string; /** - * Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question - * types. + * Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types. */ data?: string; /** @@ -373,8 +318,7 @@ export namespace surveys_v2 { */ explanation?: string; /** - * Which category of rejection this was. See the Google Surveys Help Center - * for additional details on each category. + * Which category of rejection this was. See the Google Surveys Help Center for additional details on each category. */ type?: string; } @@ -393,16 +337,14 @@ export namespace surveys_v2 { } export interface Schema$SurveysDeleteResponse { /** - * Unique request ID used for logging and debugging. Please include in any - * error reporting or troubleshooting requests. + * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */ requestId?: string; } export interface Schema$SurveysListResponse { pageInfo?: Schema$PageInfo; /** - * Unique request ID used for logging and debugging. Please include in any - * error reporting or troubleshooting requests. + * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */ requestId?: string; /** @@ -413,23 +355,19 @@ export namespace surveys_v2 { } export interface Schema$SurveysStartRequest { /** - * *Deprecated* Threshold to start a survey automatically if the quoted - * prices is less than or equal to this value. See Survey.Cost for more - * details. This will no longer be available after June 2018. + * *Deprecated* Threshold to start a survey automatically if the quoted prices is less than or equal to this value. See Survey.Cost for more details. This will no longer be available after June 2018. */ maxCostPerResponseNanos?: string; } export interface Schema$SurveysStartResponse { /** - * Unique request ID used for logging and debugging. Please include in any - * error reporting or troubleshooting requests. + * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */ requestId?: string; } export interface Schema$SurveysStopResponse { /** - * Unique request ID used for logging and debugging. Please include in any - * error reporting or troubleshooting requests. + * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. */ requestId?: string; } @@ -446,9 +384,7 @@ export namespace surveys_v2 { /** * surveys.results.get - * @desc Retrieves any survey results that have been produced so far. - * Results are formatted as an Excel file. You must add "?alt=media" to the - * URL as an argument to get results. + * @desc Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results. * @alias surveys.results.get * @memberOf! () * @@ -986,8 +922,7 @@ export namespace surveys_v2 { /** * surveys.surveys.update - * @desc Updates a survey. Currently the only property that can be updated - * is the owners property. + * @desc Updates a survey. Currently the only property that can be updated is the owners property. * @alias surveys.surveys.update * @memberOf! () * diff --git a/src/apis/tagmanager/package.json b/src/apis/tagmanager/package.json index b8ba1817425..c2b21b49626 100644 --- a/src/apis/tagmanager/package.json +++ b/src/apis/tagmanager/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index dbed7f71801..d0b1017e8f7 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace tagmanager_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace tagmanager_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace tagmanager_v1 { accounts: Resource$Accounts; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); } @@ -110,8 +110,7 @@ export namespace tagmanager_v1 { */ accountId?: string; /** - * The fingerprint of the GTM Account as computed at storage time. This - * value is recomputed whenever the account is modified. + * The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified. */ fingerprint?: string; /** @@ -128,8 +127,7 @@ export namespace tagmanager_v1 { */ export interface Schema$AccountAccess { /** - * List of Account permissions. Valid account permissions are read and - * manage. + * List of Account permissions. Valid account permissions are read and manage. */ permission?: string[]; } @@ -138,15 +136,7 @@ export namespace tagmanager_v1 { */ export interface Schema$Condition { /** - * A list of named parameters (key/value), depending on the condition's - * type. Notes: - For binary operators, include parameters named arg0 and - * arg1 for specifying the left and right operands, respectively. - At this - * time, the left operand (arg0) must be a reference to a variable. - For - * case-insensitive Regex matching, include a boolean parameter named - * ignore_case that is set to true. If not specified or set to any other - * value, the matching will be case sensitive. - To negate an operator, - * include a boolean parameter named negate boolean parameter that is set to - * true. + * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. */ parameter?: Schema$Parameter[]; /** @@ -171,17 +161,11 @@ export namespace tagmanager_v1 { */ domainName?: string[]; /** - * List of enabled built-in variables. Valid values include: pageUrl, - * pageHostname, pagePath, referrer, event, clickElement, clickClasses, - * clickId, clickTarget, clickUrl, clickText, formElement, formClasses, - * formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, - * newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, - * historySource, containerVersion, debugMode, randomNumber, containerId. + * List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId. */ enabledBuiltInVariable?: string[]; /** - * The fingerprint of the GTM Container as computed at storage time. This - * value is recomputed whenever the account is modified. + * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. */ fingerprint?: string; /** @@ -205,8 +189,7 @@ export namespace tagmanager_v1 { */ timeZoneId?: string; /** - * List of Usage Contexts for the Container. Valid values include: web, - * android, ios. + * List of Usage Contexts for the Container. Valid values include: web, android, ios. */ usageContext?: string[]; } @@ -219,8 +202,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * List of Container permissions. Valid container permissions are: read, - * edit, delete, publish. + * List of Container permissions. Valid container permissions are: read, edit, delete, publish. */ permission?: string[]; } @@ -249,8 +231,7 @@ export namespace tagmanager_v1 { */ deleted?: boolean; /** - * The fingerprint of the GTM Container Version as computed at storage time. - * This value is recomputed whenever the container version is modified. + * The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified. */ fingerprint?: string; /** @@ -344,8 +325,7 @@ export namespace tagmanager_v1 { */ notes?: string; /** - * The creation of this version may be for quick preview and shouldn't - * be saved. + * The creation of this version may be for quick preview and shouldn't be saved. */ quickPreview?: boolean; } @@ -363,9 +343,7 @@ export namespace tagmanager_v1 { containerVersion?: Schema$ContainerVersion; } /** - * Represents a Google Tag Manager Environment. Note that a user can create, - * delete and update environments of type USER, but can only update the - * enable_debug and url fields of environments of other types. + * Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types. */ export interface Schema$Environment { /** @@ -386,8 +364,7 @@ export namespace tagmanager_v1 { containerId?: string; containerVersionId?: string; /** - * The environment description. Can be set or changed only on USER type - * environments. + * The environment description. Can be set or changed only on USER type environments. */ description?: string; /** @@ -399,13 +376,11 @@ export namespace tagmanager_v1 { */ environmentId?: string; /** - * The fingerprint of the GTM environment as computed at storage time. This - * value is recomputed whenever the environment is modified. + * The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified. */ fingerprint?: string; /** - * The environment display name. Can be set or changed only on USER type - * environments. + * The environment display name. Can be set or changed only on USER type environments. */ name?: string; /** @@ -430,8 +405,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * The fingerprint of the GTM Folder as computed at storage time. This value - * is recomputed whenever the folder is modified. + * The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified. */ fingerprint?: string; /** @@ -558,20 +532,15 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * For mobile containers only: A list of rule IDs for disabling conditional - * macros; the macro is enabled if one of the enabling rules is true while - * all the disabling rules are false. Treated as an unordered set. + * For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. */ disablingRuleId?: string[]; /** - * For mobile containers only: A list of rule IDs for enabling conditional - * macros; the macro is enabled if one of the enabling rules is true while - * all the disabling rules are false. Treated as an unordered set. + * For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. */ enablingRuleId?: string[]; /** - * The fingerprint of the GTM Macro as computed at storage time. This value - * is recomputed whenever the macro is modified. + * The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. */ fingerprint?: string; /** @@ -612,8 +581,7 @@ export namespace tagmanager_v1 { */ export interface Schema$Parameter { /** - * The named key that uniquely identifies a parameter. Required for - * top-level parameters, as well as map values. Ignored for list values. + * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. */ key?: string; /** @@ -621,23 +589,15 @@ export namespace tagmanager_v1 { */ list?: Schema$Parameter[]; /** - * This map parameter's parameters (must have keys; keys must be - * unique). + * This map parameter's parameters (must have keys; keys must be unique). */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a - * boolean, represented as 'true' or 'false' - integer: The - * value represents a 64-bit signed integer value, in base 10 - list: A - * list of parameters should be specified - map: A map of parameters should - * be specified - template: The value represents any text; this can include - * variable references (even variable references that might return - * non-string types) + * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) */ type?: string; /** - * A parameter's value (may contain variable references such as - * "{{myVariable}}") as appropriate to the specified type. + * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. */ value?: string; } @@ -663,8 +623,7 @@ export namespace tagmanager_v1 { */ accountId?: string; /** - * The list of conditions that make up this rule (implicit AND between - * them). + * The list of conditions that make up this rule (implicit AND between them). */ condition?: Schema$Condition[]; /** @@ -672,8 +631,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * The fingerprint of the GTM Rule as computed at storage time. This value - * is recomputed whenever the rule is modified. + * The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. */ fingerprint?: string; /** @@ -691,9 +649,7 @@ export namespace tagmanager_v1 { } export interface Schema$SetupTag { /** - * If true, fire the main tag if and only if the setup tag fires - * successfully. If false, fire the main tag regardless of setup tag firing - * status. + * If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status. */ stopOnSetupFailure?: boolean; /** @@ -710,13 +666,11 @@ export namespace tagmanager_v1 { */ accountId?: string; /** - * Blocking rule IDs. If any of the listed rules evaluate to true, the tag - * will not fire. + * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. */ blockingRuleId?: string[]; /** - * Blocking trigger IDs. If any of the listed triggers evaluate to true, the - * tag will not fire. + * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. */ blockingTriggerId?: string[]; /** @@ -724,23 +678,19 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * The fingerprint of the GTM Tag as computed at storage time. This value is - * recomputed whenever the tag is modified. + * The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. */ fingerprint?: string; /** - * Firing rule IDs. A tag will fire when any of the listed rules are true - * and all of its blockingRuleIds (if any specified) are false. + * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. */ firingRuleId?: string[]; /** - * Firing trigger IDs. A tag will fire when any of the listed triggers are - * true and all of its blockingTriggerIds (if any specified) are false. + * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. */ firingTriggerId?: string[]; /** - * If set to true, this tag will only fire in the live environment (e.g. not - * in preview or debug mode). + * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). */ liveOnly?: boolean; /** @@ -764,10 +714,7 @@ export namespace tagmanager_v1 { */ paused?: boolean; /** - * User defined numeric priority of the tag. Tags are fired asynchronously - * in order of priority. Tags with higher numeric value fire first. A - * tag's priority can be a positive or negative value. The default value - * is 0. + * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. */ priority?: Schema$Parameter; /** @@ -801,9 +748,7 @@ export namespace tagmanager_v1 { } export interface Schema$TeardownTag { /** - * If true, fire the teardown tag if and only if the main tag fires - * successfully. If false, fire the teardown tag regardless of main tag - * firing status. + * If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status. */ stopTeardownOnFailure?: boolean; /** @@ -824,9 +769,7 @@ export namespace tagmanager_v1 { */ autoEventFilter?: Schema$Condition[]; /** - * Whether or not we should only fire tags if the form submit or link click - * event is not cancelled by some other event handler (e.g. because of - * validation). Only valid for Form Submission and Link Click triggers. + * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. */ checkValidation?: Schema$Parameter; /** @@ -834,13 +777,11 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * A visibility trigger minimum continuous visible time (in milliseconds). - * Only valid for AMP Visibility trigger. + * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. */ continuousTimeMinMilliseconds?: Schema$Parameter; /** - * Used in the case of custom event, which is fired iff all Conditions are - * true. + * Used in the case of custom event, which is fired iff all Conditions are true. */ customEventFilter?: Schema$Condition[]; /** @@ -852,35 +793,27 @@ export namespace tagmanager_v1 { */ filter?: Schema$Condition[]; /** - * The fingerprint of the GTM Trigger as computed at storage time. This - * value is recomputed whenever the trigger is modified. + * The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. */ fingerprint?: string; /** - * List of integer percentage values for scroll triggers. The trigger will - * fire when each percentage is reached when the view is scrolled - * horizontally. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. */ horizontalScrollPercentageList?: Schema$Parameter; /** - * Time between triggering recurring Timer Events (in milliseconds). Only - * valid for Timer triggers. + * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. */ interval?: Schema$Parameter; /** - * Time between Timer Events to fire (in seconds). Only valid for AMP Timer - * trigger. + * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. */ intervalSeconds?: Schema$Parameter; /** - * Limit of the number of GTM events this Timer Trigger will fire. If no - * limit is set, we will continue to fire GTM events until the user leaves - * the page. Only valid for Timer triggers. + * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. */ limit?: Schema$Parameter; /** - * Max time to fire Timer Events (in seconds). Only valid for AMP Timer - * trigger. + * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. */ maxTimerLengthSeconds?: Schema$Parameter; /** @@ -896,13 +829,11 @@ export namespace tagmanager_v1 { */ parentFolderId?: string; /** - * A click trigger CSS selector (i.e. "a", "button" - * etc.). Only valid for AMP Click trigger. + * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. */ selector?: Schema$Parameter; /** - * A visibility trigger minimum total visible time (in milliseconds). Only - * valid for AMP Visibility trigger. + * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. */ totalTimeMinMilliseconds?: Schema$Parameter; /** @@ -914,46 +845,31 @@ export namespace tagmanager_v1 { */ type?: string; /** - * Globally unique id of the trigger that auto-generates this (a Form - * Submit, Link Click or Timer listener) if any. Used to make incompatible - * auto-events work together with trigger filtering based on trigger ids. - * This value is populated during output generation since the tags implied - * by triggers don't exist until then. Only valid for Form Submit, Link - * Click and Timer triggers. + * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. */ uniqueTriggerId?: Schema$Parameter; /** - * List of integer percentage values for scroll triggers. The trigger will - * fire when each percentage is reached when the view is scrolled - * vertically. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. */ verticalScrollPercentageList?: Schema$Parameter; /** - * A visibility trigger CSS selector (i.e. "#id"). Only valid for - * AMP Visibility trigger. + * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. */ visibilitySelector?: Schema$Parameter; /** - * A visibility trigger maximum percent visibility. Only valid for AMP - * Visibility trigger. + * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMax?: Schema$Parameter; /** - * A visibility trigger minimum percent visibility. Only valid for AMP - * Visibility trigger. + * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMin?: Schema$Parameter; /** - * Whether or not we should delay the form submissions or link opening until - * all of the tags have fired (by preventing the default action and later - * simulating the default action). Only valid for Form Submission and Link - * Click triggers. + * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. */ waitForTags?: Schema$Parameter; /** - * How long to wait (in milliseconds) for tags to fire when - * 'waits_for_tags' above evaluates to true. Only valid for Form - * Submission and Link Click triggers. + * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. */ waitForTagsTimeout?: Schema$Parameter; } @@ -995,22 +911,15 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * For mobile containers only: A list of trigger IDs for disabling - * conditional variables; the variable is enabled if one of the enabling - * trigger is true while all the disabling trigger are false. Treated as an - * unordered set. + * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. */ disablingTriggerId?: string[]; /** - * For mobile containers only: A list of trigger IDs for enabling - * conditional variables; the variable is enabled if one of the enabling - * triggers is true while all the disabling triggers are false. Treated as - * an unordered set. + * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. */ enablingTriggerId?: string[]; /** - * The fingerprint of the GTM Variable as computed at storage time. This - * value is recomputed whenever the variable is modified. + * The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified. */ fingerprint?: string; /** @@ -1304,8 +1213,7 @@ export namespace tagmanager_v1 { */ accountId?: string; /** - * When provided, this fingerprint must match the fingerprint of the account - * in storage. + * When provided, this fingerprint must match the fingerprint of the account in storage. */ fingerprint?: string; @@ -1795,8 +1703,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * When provided, this fingerprint must match the fingerprint of the - * container in storage. + * When provided, this fingerprint must match the fingerprint of the container in storage. */ fingerprint?: string; @@ -2291,8 +2198,7 @@ export namespace tagmanager_v1 { */ environmentId?: string; /** - * When provided, this fingerprint must match the fingerprint of the - * environment in storage. + * When provided, this fingerprint must match the fingerprint of the environment in storage. */ fingerprint?: string; @@ -2779,8 +2685,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * When provided, this fingerprint must match the fingerprint of the folder - * in storage. + * When provided, this fingerprint must match the fingerprint of the folder in storage. */ fingerprint?: string; /** @@ -3604,8 +3509,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * When provided, this fingerprint must match the fingerprint of the tag in - * storage. + * When provided, this fingerprint must match the fingerprint of the tag in storage. */ fingerprint?: string; /** @@ -4094,8 +3998,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * When provided, this fingerprint must match the fingerprint of the trigger - * in storage. + * When provided, this fingerprint must match the fingerprint of the trigger in storage. */ fingerprint?: string; /** @@ -4584,8 +4487,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * When provided, this fingerprint must match the fingerprint of the - * variable in storage. + * When provided, this fingerprint must match the fingerprint of the variable in storage. */ fingerprint?: string; /** @@ -5014,10 +4916,7 @@ export namespace tagmanager_v1 { /** * tagmanager.accounts.containers.versions.restore - * @desc Restores a Container Version. This will overwrite the container's - * current configuration (including its variables, triggers and tags). The - * operation will not have any effect on the version that is being served - * (i.e. the published version). + * @desc Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version). * @alias tagmanager.accounts.containers.versions.restore * @memberOf! () * @@ -5303,8 +5202,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * The GTM Container Version ID. Specify published to retrieve the currently - * published version. + * The GTM Container Version ID. Specify published to retrieve the currently published version. */ containerVersionId?: string; } @@ -5352,8 +5250,7 @@ export namespace tagmanager_v1 { */ containerVersionId?: string; /** - * When provided, this fingerprint must match the fingerprint of the - * container version in storage. + * When provided, this fingerprint must match the fingerprint of the container version in storage. */ fingerprint?: string; } @@ -5417,8 +5314,7 @@ export namespace tagmanager_v1 { */ containerVersionId?: string; /** - * When provided, this fingerprint must match the fingerprint of the - * container version in storage. + * When provided, this fingerprint must match the fingerprint of the container version in storage. */ fingerprint?: string; @@ -5510,8 +5406,7 @@ export namespace tagmanager_v1 { /** * tagmanager.accounts.permissions.delete - * @desc Removes a user from the account, revoking access to it and all of - * its containers. + * @desc Removes a user from the account, revoking access to it and all of its containers. * @alias tagmanager.accounts.permissions.delete * @memberOf! () * @@ -5659,8 +5554,7 @@ export namespace tagmanager_v1 { /** * tagmanager.accounts.permissions.list - * @desc List all users that have access to the account along with Account - * and Container Permissions granted to each of them. + * @desc List all users that have access to the account along with Account and Container Permissions granted to each of them. * @alias tagmanager.accounts.permissions.list * @memberOf! () * diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 5a71211a1ab..c69ad07c74c 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace tagmanager_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace tagmanager_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace tagmanager_v2 { accounts: Resource$Accounts; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.accounts = new Resource$Accounts(this.context); } @@ -110,8 +110,7 @@ export namespace tagmanager_v2 { */ accountId?: string; /** - * The fingerprint of the GTM Account as computed at storage time. This - * value is recomputed whenever the account is modified. + * The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified. */ fingerprint?: string; /** @@ -123,11 +122,7 @@ export namespace tagmanager_v2 { */ path?: string; /** - * Whether the account shares data anonymously with Google and others. This - * flag enables benchmarking by sharing your data in an anonymous form. - * Google will remove all identifiable information about your website, - * combine the data with hundreds of other anonymous sites and report - * aggregate trends in the benchmarking service. + * Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. */ shareData?: boolean; /** @@ -140,16 +135,12 @@ export namespace tagmanager_v2 { */ export interface Schema$AccountAccess { /** - * Whether the user has no access, user access, or admin access to an - * account. + * Whether the user has no access, user access, or admin access to an account. */ permission?: string; } /** - * Built-in variables are a special category of variables that are pre-created - * and non-customizable. They provide common functionality like accessing - * propeties of the gtm data layer, monitoring clicks, or accessing elements - * of a page URL. + * Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing propeties of the gtm data layer, monitoring clicks, or accessing elements of a page URL. */ export interface Schema$BuiltInVariable { /** @@ -161,8 +152,7 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * Name of the built-in variable to be used to refer to the built-in - * variable. + * Name of the built-in variable to be used to refer to the built-in variable. */ name?: string; /** @@ -183,15 +173,7 @@ export namespace tagmanager_v2 { */ export interface Schema$Condition { /** - * A list of named parameters (key/value), depending on the condition's - * type. Notes: - For binary operators, include parameters named arg0 and - * arg1 for specifying the left and right operands, respectively. - At this - * time, the left operand (arg0) must be a reference to a variable. - For - * case-insensitive Regex matching, include a boolean parameter named - * ignore_case that is set to true. If not specified or set to any other - * value, the matching will be case sensitive. - To negate an operator, - * include a boolean parameter named negate boolean parameter that is set to - * true. + * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. */ parameter?: Schema$Parameter[]; /** @@ -200,8 +182,7 @@ export namespace tagmanager_v2 { type?: string; } /** - * Represents a Google Tag Manager Container, which specifies the platform - * tags will run on, manages workspaces, and retains container versions. + * Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions. */ export interface Schema$Container { /** @@ -217,8 +198,7 @@ export namespace tagmanager_v2 { */ domainName?: string[]; /** - * The fingerprint of the GTM Container as computed at storage time. This - * value is recomputed whenever the account is modified. + * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. */ fingerprint?: string; /** @@ -242,8 +222,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string; /** - * List of Usage Contexts for the Container. Valid values include: web, - * android, or ios. + * List of Usage Contexts for the Container. Valid values include: web, android, or ios. */ usageContext?: string[]; } @@ -297,8 +276,7 @@ export namespace tagmanager_v2 { */ description?: string; /** - * The fingerprint of the GTM Container Version as computed at storage time. - * This value is recomputed whenever the container version is modified. + * The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified. */ fingerprint?: string; /** @@ -423,14 +401,11 @@ export namespace tagmanager_v2 { */ containerVersion?: Schema$ContainerVersion; /** - * Auto generated workspace path created as a result of version creation. - * This field should only be populated if the created version was not a - * quick preview. + * Auto generated workspace path created as a result of version creation. This field should only be populated if the created version was not a quick preview. */ newWorkspacePath?: string; /** - * Whether version creation failed when syncing the workspace to the latest - * container version. + * Whether version creation failed when syncing the workspace to the latest container version. */ syncStatus?: Schema$SyncStatus; } @@ -447,8 +422,7 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * The fingerprint of the GTM Custom Template as computed at storage time. - * This value is recomputed whenever the template is modified. + * The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified. */ fingerprint?: string; /** @@ -477,8 +451,7 @@ export namespace tagmanager_v2 { workspaceId?: string; } /** - * A workspace entity that may represent a tag, trigger, variable, or folder - * in addition to its status in the workspace. + * A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace. */ export interface Schema$Entity { /** @@ -503,9 +476,7 @@ export namespace tagmanager_v2 { variable?: Schema$Variable; } /** - * Represents a Google Tag Manager Environment. Note that a user can create, - * delete and update environments of type USER, but can only update the - * enable_debug and url fields of environments of other types. + * Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types. */ export interface Schema$Environment { /** @@ -529,8 +500,7 @@ export namespace tagmanager_v2 { */ containerVersionId?: string; /** - * The environment description. Can be set or changed only on USER type - * environments. + * The environment description. Can be set or changed only on USER type environments. */ description?: string; /** @@ -542,13 +512,11 @@ export namespace tagmanager_v2 { */ environmentId?: string; /** - * The fingerprint of the GTM environment as computed at storage time. This - * value is recomputed whenever the environment is modified. + * The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified. */ fingerprint?: string; /** - * The environment display name. Can be set or changed only on USER type - * environments. + * The environment display name. Can be set or changed only on USER type environments. */ name?: string; /** @@ -585,8 +553,7 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * The fingerprint of the GTM Folder as computed at storage time. This value - * is recomputed whenever the folder is modified. + * The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified. */ fingerprint?: string; /** @@ -636,8 +603,7 @@ export namespace tagmanager_v2 { variable?: Schema$Variable[]; } /** - * The changes that have occurred in the workspace since the base container - * version. + * The changes that have occurred in the workspace since the base container version. */ export interface Schema$GetWorkspaceStatusResponse { /** @@ -807,15 +773,11 @@ export namespace tagmanager_v2 { */ export interface Schema$MergeConflict { /** - * The base version entity (since the latest sync operation) that has - * conflicting changes compared to the workspace. If this field is missing, - * it means the workspace entity is deleted from the base version. + * The base version entity (since the latest sync operation) that has conflicting changes compared to the workspace. If this field is missing, it means the workspace entity is deleted from the base version. */ entityInBaseVersion?: Schema$Entity; /** - * The workspace entity that has conflicting changes compared to the base - * version. If an entity is deleted in a workspace, it will still appear - * with a deleted change status. + * The workspace entity that has conflicting changes compared to the base version. If an entity is deleted in a workspace, it will still appear with a deleted change status. */ entityInWorkspace?: Schema$Entity; } @@ -824,8 +786,7 @@ export namespace tagmanager_v2 { */ export interface Schema$Parameter { /** - * The named key that uniquely identifies a parameter. Required for - * top-level parameters, as well as map values. Ignored for list values. + * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. */ key?: string; /** @@ -833,23 +794,15 @@ export namespace tagmanager_v2 { */ list?: Schema$Parameter[]; /** - * This map parameter's parameters (must have keys; keys must be - * unique). + * This map parameter's parameters (must have keys; keys must be unique). */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a - * boolean, represented as 'true' or 'false' - integer: The - * value represents a 64-bit signed integer value, in base 10 - list: A - * list of parameters should be specified - map: A map of parameters should - * be specified - template: The value represents any text; this can include - * variable references (even variable references that might return - * non-string types) + * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) */ type?: string; /** - * A parameter's value (may contain variable references such as - * "{{myVariable}}") as appropriate to the specified type. + * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. */ value?: string; } @@ -879,8 +832,7 @@ export namespace tagmanager_v2 { */ containerVersion?: Schema$ContainerVersion; /** - * Whether quick previewing failed when syncing the workspace to the latest - * container version. + * Whether quick previewing failed when syncing the workspace to the latest container version. */ syncStatus?: Schema$SyncStatus; } @@ -898,9 +850,7 @@ export namespace tagmanager_v2 { */ export interface Schema$RevertFolderResponse { /** - * Folder as it appears in the latest container version since the last - * workspace synchronization operation. If no folder is present, that means - * the folder was deleted in the latest container version. + * Folder as it appears in the latest container version since the last workspace synchronization operation. If no folder is present, that means the folder was deleted in the latest container version. */ folder?: Schema$Folder; } @@ -909,9 +859,7 @@ export namespace tagmanager_v2 { */ export interface Schema$RevertTagResponse { /** - * Tag as it appears in the latest container version since the last - * workspace synchronization operation. If no tag is present, that means the - * tag was deleted in the latest container version. + * Tag as it appears in the latest container version since the last workspace synchronization operation. If no tag is present, that means the tag was deleted in the latest container version. */ tag?: Schema$Tag; } @@ -920,9 +868,7 @@ export namespace tagmanager_v2 { */ export interface Schema$RevertTriggerResponse { /** - * Trigger as it appears in the latest container version since the last - * workspace synchronization operation. If no trigger is present, that means - * the trigger was deleted in the latest container version. + * Trigger as it appears in the latest container version since the last workspace synchronization operation. If no trigger is present, that means the trigger was deleted in the latest container version. */ trigger?: Schema$Trigger; } @@ -931,9 +877,7 @@ export namespace tagmanager_v2 { */ export interface Schema$RevertVariableResponse { /** - * Variable as it appears in the latest container version since the last - * workspace synchronization operation. If no variable is present, that - * means the variable was deleted in the latest container version. + * Variable as it appears in the latest container version since the last workspace synchronization operation. If no variable is present, that means the variable was deleted in the latest container version. */ variable?: Schema$Variable; } @@ -942,21 +886,16 @@ export namespace tagmanager_v2 { */ export interface Schema$RevertZoneResponse { /** - * Zone as it appears in the latest container version since the last - * workspace synchronization operation. If no zone is present, that means - * the zone was deleted in the latest container version. + * Zone as it appears in the latest container version since the last workspace synchronization operation. If no zone is present, that means the zone was deleted in the latest container version. */ zone?: Schema$Zone; } /** - * Represents a reference to atag that fires before another tag in order to - * set up dependencies. + * Represents a reference to atag that fires before another tag in order to set up dependencies. */ export interface Schema$SetupTag { /** - * If true, fire the main tag if and only if the setup tag fires - * successfully. If false, fire the main tag regardless of setup tag firing - * status. + * If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status. */ stopOnSetupFailure?: boolean; /** @@ -978,14 +917,11 @@ export namespace tagmanager_v2 { syncError?: boolean; } /** - * A response after synchronizing the workspace to the latest container - * version. + * A response after synchronizing the workspace to the latest container version. */ export interface Schema$SyncWorkspaceResponse { /** - * The merge conflict after sync. If this field is not empty, the sync is - * still treated as successful. But a version cannot be created until all - * conflicts are resolved. + * The merge conflict after sync. If this field is not empty, the sync is still treated as successful. But a version cannot be created until all conflicts are resolved. */ mergeConflict?: Schema$MergeConflict[]; /** @@ -1002,13 +938,11 @@ export namespace tagmanager_v2 { */ accountId?: string; /** - * Blocking rule IDs. If any of the listed rules evaluate to true, the tag - * will not fire. + * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. */ blockingRuleId?: string[]; /** - * Blocking trigger IDs. If any of the listed triggers evaluate to true, the - * tag will not fire. + * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. */ blockingTriggerId?: string[]; /** @@ -1016,23 +950,19 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * The fingerprint of the GTM Tag as computed at storage time. This value is - * recomputed whenever the tag is modified. + * The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. */ fingerprint?: string; /** - * Firing rule IDs. A tag will fire when any of the listed rules are true - * and all of its blockingRuleIds (if any specified) are false. + * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. */ firingRuleId?: string[]; /** - * Firing trigger IDs. A tag will fire when any of the listed triggers are - * true and all of its blockingTriggerIds (if any specified) are false. + * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. */ firingTriggerId?: string[]; /** - * If set to true, this tag will only fire in the live environment (e.g. not - * in preview or debug mode). + * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). */ liveOnly?: boolean; /** @@ -1060,10 +990,7 @@ export namespace tagmanager_v2 { */ paused?: boolean; /** - * User defined numeric priority of the tag. Tags are fired asynchronously - * in order of priority. Tags with higher numeric value fire first. A - * tag's priority can be a positive or negative value. The default value - * is 0. + * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. */ priority?: Schema$Parameter; /** @@ -1104,14 +1031,11 @@ export namespace tagmanager_v2 { workspaceId?: string; } /** - * Represents a tag that fires after another tag in order to tear down - * dependencies. + * Represents a tag that fires after another tag in order to tear down dependencies. */ export interface Schema$TeardownTag { /** - * If true, fire the teardown tag if and only if the main tag fires - * successfully. If false, fire the teardown tag regardless of main tag - * firing status. + * If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status. */ stopTeardownOnFailure?: boolean; /** @@ -1120,67 +1044,15 @@ export namespace tagmanager_v2 { tagName?: string; } /** - * A Timestamp represents a point in time independent of any time zone or - * local calendar, encoded as a count of seconds and fractions of seconds at - * nanosecond resolution. The count is relative to an epoch at UTC midnight on - * January 1, 1970, in the proleptic Gregorian calendar which extends the - * Gregorian calendar backwards to year one. All minutes are 60 seconds long. - * Leap seconds are "smeared" so that no leap second table is needed - * for interpretation, using a [24-hour linear - * smear](https://developers.google.com/time/smear). The range is from - * 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to - * that range, we ensure that we can convert to and from [RFC - * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples - * Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; - * timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: - * Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; - * gettimeofday(&tv, NULL); Timestamp timestamp; - * timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); - * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - * FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = - * (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows - * tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - * 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - * timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - - * 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long - * millis = System.currentTimeMillis(); Timestamp timestamp = - * Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % - * 1000) * 1000000)).build(); Example 5: Compute Timestamp from current - * time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON - * Mapping In JSON format, the Timestamp type is encoded as a string in the - * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the - * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" - * where {year} is always expressed using four digits while {month}, {day}, - * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional - * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), - * are optional. The "Z" suffix indicates the timezone - * ("UTC"); the timezone is required. A proto3 JSON serializer - * should always use UTC (as indicated by "Z") when printing the - * Timestamp type and a proto3 JSON parser should be able to accept both UTC - * and other timezones (as indicated by an offset). For example, - * "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - * January 15, 2017. In JavaScript, one can convert a Date object to this - * format using the standard - * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) - * method. In Python, a standard `datetime.datetime` object can be converted - * to this format using - * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) - * with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in - * Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( - * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D - * ) to obtain a formatter capable of generating timestamps in this format. + * A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. */ export interface Schema$Timestamp { /** - * Non-negative fractions of a second at nanosecond resolution. Negative - * second values with fractions must still have non-negative nanos values - * that count forward in time. Must be from 0 to 999,999,999 inclusive. + * Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. */ nanos?: number; /** - * Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. - * Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. + * Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. */ seconds?: string; } @@ -1197,9 +1069,7 @@ export namespace tagmanager_v2 { */ autoEventFilter?: Schema$Condition[]; /** - * Whether or not we should only fire tags if the form submit or link click - * event is not cancelled by some other event handler (e.g. because of - * validation). Only valid for Form Submission and Link Click triggers. + * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. */ checkValidation?: Schema$Parameter; /** @@ -1207,13 +1077,11 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * A visibility trigger minimum continuous visible time (in milliseconds). - * Only valid for AMP Visibility trigger. + * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. */ continuousTimeMinMilliseconds?: Schema$Parameter; /** - * Used in the case of custom event, which is fired iff all Conditions are - * true. + * Used in the case of custom event, which is fired iff all Conditions are true. */ customEventFilter?: Schema$Condition[]; /** @@ -1225,35 +1093,27 @@ export namespace tagmanager_v2 { */ filter?: Schema$Condition[]; /** - * The fingerprint of the GTM Trigger as computed at storage time. This - * value is recomputed whenever the trigger is modified. + * The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. */ fingerprint?: string; /** - * List of integer percentage values for scroll triggers. The trigger will - * fire when each percentage is reached when the view is scrolled - * horizontally. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. */ horizontalScrollPercentageList?: Schema$Parameter; /** - * Time between triggering recurring Timer Events (in milliseconds). Only - * valid for Timer triggers. + * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. */ interval?: Schema$Parameter; /** - * Time between Timer Events to fire (in seconds). Only valid for AMP Timer - * trigger. + * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. */ intervalSeconds?: Schema$Parameter; /** - * Limit of the number of GTM events this Timer Trigger will fire. If no - * limit is set, we will continue to fire GTM events until the user leaves - * the page. Only valid for Timer triggers. + * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. */ limit?: Schema$Parameter; /** - * Max time to fire Timer Events (in seconds). Only valid for AMP Timer - * trigger. + * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. */ maxTimerLengthSeconds?: Schema$Parameter; /** @@ -1277,8 +1137,7 @@ export namespace tagmanager_v2 { */ path?: string; /** - * A click trigger CSS selector (i.e. "a", "button" - * etc.). Only valid for AMP Click trigger. + * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. */ selector?: Schema$Parameter; /** @@ -1286,8 +1145,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string; /** - * A visibility trigger minimum total visible time (in milliseconds). Only - * valid for AMP Visibility trigger. + * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. */ totalTimeMinMilliseconds?: Schema$Parameter; /** @@ -1299,46 +1157,31 @@ export namespace tagmanager_v2 { */ type?: string; /** - * Globally unique id of the trigger that auto-generates this (a Form - * Submit, Link Click or Timer listener) if any. Used to make incompatible - * auto-events work together with trigger filtering based on trigger ids. - * This value is populated during output generation since the tags implied - * by triggers don't exist until then. Only valid for Form Submit, Link - * Click and Timer triggers. + * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. */ uniqueTriggerId?: Schema$Parameter; /** - * List of integer percentage values for scroll triggers. The trigger will - * fire when each percentage is reached when the view is scrolled - * vertically. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. */ verticalScrollPercentageList?: Schema$Parameter; /** - * A visibility trigger CSS selector (i.e. "#id"). Only valid for - * AMP Visibility trigger. + * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. */ visibilitySelector?: Schema$Parameter; /** - * A visibility trigger maximum percent visibility. Only valid for AMP - * Visibility trigger. + * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMax?: Schema$Parameter; /** - * A visibility trigger minimum percent visibility. Only valid for AMP - * Visibility trigger. + * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMin?: Schema$Parameter; /** - * Whether or not we should delay the form submissions or link opening until - * all of the tags have fired (by preventing the default action and later - * simulating the default action). Only valid for Form Submission and Link - * Click triggers. + * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. */ waitForTags?: Schema$Parameter; /** - * How long to wait (in milliseconds) for tags to fire when - * 'waits_for_tags' above evaluates to true. Only valid for Form - * Submission and Link Click triggers. + * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. */ waitForTagsTimeout?: Schema$Parameter; /** @@ -1384,22 +1227,15 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * For mobile containers only: A list of trigger IDs for disabling - * conditional variables; the variable is enabled if one of the enabling - * trigger is true while all the disabling trigger are false. Treated as an - * unordered set. + * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. */ disablingTriggerId?: string[]; /** - * For mobile containers only: A list of trigger IDs for enabling - * conditional variables; the variable is enabled if one of the enabling - * triggers is true while all the disabling triggers are false. Treated as - * an unordered set. + * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. */ enablingTriggerId?: string[]; /** - * The fingerprint of the GTM Variable as computed at storage time. This - * value is recomputed whenever the variable is modified. + * The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified. */ fingerprint?: string; /** @@ -1453,8 +1289,7 @@ export namespace tagmanager_v2 { } export interface Schema$VariableFormatValue { /** - * The option to convert a string-type variable value to either lowercase or - * uppercase. + * The option to convert a string-type variable value to either lowercase or uppercase. */ caseConversionType?: string; /** @@ -1491,8 +1326,7 @@ export namespace tagmanager_v2 { */ description?: string; /** - * The fingerprint of the GTM Workspace as computed at storage time. This - * value is recomputed whenever the workspace is modified. + * The fingerprint of the GTM Workspace as computed at storage time. This value is recomputed whenever the workspace is modified. */ fingerprint?: string; /** @@ -1533,8 +1367,7 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * The fingerprint of the GTM Zone as computed at storage time. This value - * is recomputed whenever the zone is modified. + * The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. */ fingerprint?: string; /** @@ -1575,8 +1408,7 @@ export namespace tagmanager_v2 { */ condition?: Schema$Condition[]; /** - * Custom evaluation trigger IDs. A zone will evaluate its boundary - * conditions when any of the listed triggers are true. + * Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. */ customEvaluationTriggerId?: string[]; } @@ -1868,8 +1700,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the account - * in storage. + * When provided, this fingerprint must match the fingerprint of the account in storage. */ fingerprint?: string; /** @@ -2303,8 +2134,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ path?: string; } @@ -2316,8 +2146,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ path?: string; } @@ -2345,13 +2174,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * container in storage. + * When provided, this fingerprint must match the fingerprint of the container in storage. */ fingerprint?: string; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ path?: string; @@ -2825,8 +2652,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ parent?: string; @@ -2843,8 +2669,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Environment's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/environments/{environment_id} + * GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id} */ path?: string; } @@ -2856,8 +2681,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Environment's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/environments/{environment_id} + * GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id} */ path?: string; } @@ -2873,8 +2697,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ parent?: string; } @@ -2886,8 +2709,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Environment's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/environments/{environment_id} + * GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id} */ path?: string; @@ -2904,13 +2726,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * environment in storage. + * When provided, this fingerprint must match the fingerprint of the environment in storage. */ fingerprint?: string; /** - * GTM Environment's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/environments/{environment_id} + * GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id} */ path?: string; @@ -3233,8 +3053,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.versions.set_latest - * @desc Sets the latest version used for synchronization of workspaces when - * detecting conflicts and errors. + * @desc Sets the latest version used for synchronization of workspaces when detecting conflicts and errors. * @alias tagmanager.accounts.containers.versions.set_latest * @memberOf! () * @@ -3465,8 +3284,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM ContainerVersion's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/versions/{version_id} + * GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} */ path?: string; } @@ -3478,13 +3296,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The GTM ContainerVersion ID. Specify published to retrieve the currently - * published version. + * The GTM ContainerVersion ID. Specify published to retrieve the currently published version. */ containerVersionId?: string; /** - * GTM ContainerVersion's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/versions/{version_id} + * GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} */ path?: string; } @@ -3496,8 +3312,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ parent?: string; } @@ -3509,13 +3324,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * container version in storage. + * When provided, this fingerprint must match the fingerprint of the container version in storage. */ fingerprint?: string; /** - * GTM ContainerVersion's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/versions/{version_id} + * GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} */ path?: string; } @@ -3527,8 +3340,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM ContainerVersion's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/versions/{version_id} + * GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} */ path?: string; } @@ -3540,8 +3352,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM ContainerVersion's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/versions/{version_id} + * GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} */ path?: string; } @@ -3553,13 +3364,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * container version in storage. + * When provided, this fingerprint must match the fingerprint of the container version in storage. */ fingerprint?: string; /** - * GTM ContainerVersion's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/versions/{version_id} + * GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} */ path?: string; @@ -3744,8 +3553,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ parent?: string; } @@ -3765,8 +3573,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ parent?: string; } @@ -3878,9 +3685,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.create_version - * @desc Creates a Container Version from the entities present in the - * workspace, deletes the workspace, and sets the base container version to - * the newly created version. + * @desc Creates a Container Version from the entities present in the workspace, deletes the workspace, and sets the base container version to the newly created version. * @alias tagmanager.accounts.containers.workspaces.create_version * @memberOf! () * @@ -4268,8 +4073,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.quick_preview - * @desc Quick previews a workspace by creating a fake container version - * from all entities in the provided workspace. + * @desc Quick previews a workspace by creating a fake container version from all entities in the provided workspace. * @alias tagmanager.accounts.containers.workspaces.quick_preview * @memberOf! () * @@ -4347,8 +4151,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.resolve_conflict - * @desc Resolves a merge conflict for a workspace entity by updating it to - * the resolved entity passed in the request. + * @desc Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request. * @alias tagmanager.accounts.containers.workspaces.resolve_conflict * @memberOf! () * @@ -4422,9 +4225,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.sync - * @desc Syncs a workspace to the latest container version by updating all - * unmodified workspace entities and displaying conflicts for modified - * entities. + * @desc Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities. * @alias tagmanager.accounts.containers.workspaces.sync * @memberOf! () * @@ -4583,8 +4384,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM parent Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ parent?: string; @@ -4601,8 +4401,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; @@ -4619,8 +4418,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; } @@ -4632,8 +4430,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; } @@ -4645,8 +4442,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; } @@ -4662,8 +4458,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM parent Container's API relative path. Example: - * accounts/{account_id}/containers/{container_id} + * GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id} */ parent?: string; } @@ -4675,8 +4470,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; } @@ -4688,13 +4482,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * entity_in_workspace in the merge conflict. + * When provided, this fingerprint must match the fingerprint of the entity_in_workspace in the merge conflict. */ fingerprint?: string; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; @@ -4711,8 +4503,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; } @@ -4724,13 +4515,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * workspace in storage. + * When provided, this fingerprint must match the fingerprint of the workspace in storage. */ fingerprint?: string; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ path?: string; @@ -4749,8 +4538,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.built_in_variables.create * @desc Creates one or more GTM Built-In Variables. - * @alias - * tagmanager.accounts.containers.workspaces.built_in_variables.create + * @alias tagmanager.accounts.containers.workspaces.built_in_variables.create * @memberOf! () * * @param {object} params Parameters for request @@ -4833,8 +4621,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.built_in_variables.delete * @desc Deletes one or more GTM Built-In Variables. - * @alias - * tagmanager.accounts.containers.workspaces.built_in_variables.delete + * @alias tagmanager.accounts.containers.workspaces.built_in_variables.delete * @memberOf! () * * @param {object} params Parameters for request @@ -4992,8 +4779,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.built_in_variables.revert * @desc Reverts changes to a GTM Built-In Variables in a GTM Workspace. - * @alias - * tagmanager.accounts.containers.workspaces.built_in_variables.revert + * @alias tagmanager.accounts.containers.workspaces.built_in_variables.revert * @memberOf! () * * @param {object} params Parameters for request @@ -5082,8 +4868,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; /** @@ -5099,8 +4884,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM BuiltInVariable's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables + * GTM BuiltInVariable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables */ path?: string; /** @@ -5120,8 +4904,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; } @@ -5133,8 +4916,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM BuiltInVariable's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables + * GTM BuiltInVariable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables */ path?: string; /** @@ -5519,8 +5301,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.containers.workspaces.folders.move_entities_to_folder * @desc Moves entities to a GTM Folder. - * @alias - * tagmanager.accounts.containers.workspaces.folders.move_entities_to_folder + * @alias tagmanager.accounts.containers.workspaces.folders.move_entities_to_folder * @memberOf! () * * @param {object} params Parameters for request @@ -5752,8 +5533,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; @@ -5770,8 +5550,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Folder's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} + * GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} */ path?: string; } @@ -5787,8 +5566,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Folder's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} + * GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} */ path?: string; } @@ -5800,8 +5578,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Folder's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} + * GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} */ path?: string; } @@ -5817,8 +5594,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; } @@ -5830,8 +5606,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Folder's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} + * GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} */ path?: string; /** @@ -5860,13 +5635,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the tag in - * storage. + * When provided, this fingerprint must match the fingerprint of the tag in storage. */ fingerprint?: string; /** - * GTM Folder's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} + * GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} */ path?: string; } @@ -5878,13 +5651,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the folder - * in storage. + * When provided, this fingerprint must match the fingerprint of the folder in storage. */ fingerprint?: string; /** - * GTM Folder's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} + * GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id} */ path?: string; @@ -6350,8 +6121,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; @@ -6368,8 +6138,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Tag's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} + * GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} */ path?: string; } @@ -6381,8 +6150,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Tag's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} + * GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} */ path?: string; } @@ -6398,8 +6166,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; } @@ -6411,13 +6178,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of thetag in - * storage. + * When provided, this fingerprint must match the fingerprint of thetag in storage. */ fingerprint?: string; /** - * GTM Tag's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} + * GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} */ path?: string; } @@ -6429,13 +6194,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the tag in - * storage. + * When provided, this fingerprint must match the fingerprint of the tag in storage. */ fingerprint?: string; /** - * GTM Tag's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} + * GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id} */ path?: string; @@ -6905,8 +6668,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspaces's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspaces's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; @@ -6923,8 +6685,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Trigger's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} + * GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} */ path?: string; } @@ -6936,8 +6697,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Trigger's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} + * GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} */ path?: string; } @@ -6953,8 +6713,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspaces's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspaces's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; } @@ -6966,13 +6725,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the trigger - * in storage. + * When provided, this fingerprint must match the fingerprint of the trigger in storage. */ fingerprint?: string; /** - * GTM Trigger's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} + * GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} */ path?: string; } @@ -6984,13 +6741,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the trigger - * in storage. + * When provided, this fingerprint must match the fingerprint of the trigger in storage. */ fingerprint?: string; /** - * GTM Trigger's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} + * GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id} */ path?: string; @@ -7460,8 +7215,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; @@ -7478,8 +7232,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Variable's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} + * GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} */ path?: string; } @@ -7491,8 +7244,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Variable's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} + * GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} */ path?: string; } @@ -7508,8 +7260,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; } @@ -7521,13 +7272,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * variable in storage. + * When provided, this fingerprint must match the fingerprint of the variable in storage. */ fingerprint?: string; /** - * GTM Variable's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} + * GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} */ path?: string; } @@ -7539,13 +7288,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the - * variable in storage. + * When provided, this fingerprint must match the fingerprint of the variable in storage. */ fingerprint?: string; /** - * GTM Variable's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} + * GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id} */ path?: string; @@ -8011,8 +7758,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; @@ -8029,8 +7775,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Zone's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} + * GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} */ path?: string; } @@ -8042,8 +7787,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM Zone's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} + * GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} */ path?: string; } @@ -8059,8 +7803,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} */ parent?: string; } @@ -8072,13 +7815,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the zone in - * storage. + * When provided, this fingerprint must match the fingerprint of the zone in storage. */ fingerprint?: string; /** - * GTM Zone's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} + * GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} */ path?: string; } @@ -8090,13 +7831,11 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When provided, this fingerprint must match the fingerprint of the zone in - * storage. + * When provided, this fingerprint must match the fingerprint of the zone in storage. */ fingerprint?: string; /** - * GTM Zone's API relative path. Example: - * accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} + * GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} */ path?: string; @@ -8188,8 +7927,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.user_permissions.delete - * @desc Removes a user from the account, revoking access to it and all of - * its containers. + * @desc Removes a user from the account, revoking access to it and all of its containers. * @alias tagmanager.accounts.user_permissions.delete * @memberOf! () * @@ -8335,8 +8073,7 @@ export namespace tagmanager_v2 { /** * tagmanager.accounts.user_permissions.list - * @desc List all users that have access to the account along with Account - * and Container user access granted to each of them. + * @desc List all users that have access to the account along with Account and Container user access granted to each of them. * @alias tagmanager.accounts.user_permissions.list * @memberOf! () * @@ -8516,8 +8253,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM UserPermission's API relative path. Example: - * accounts/{account_id}/user_permissions/{user_permission_id} + * GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id} */ path?: string; } @@ -8529,8 +8265,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM UserPermission's API relative path. Example: - * accounts/{account_id}/user_permissions/{user_permission_id} + * GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id} */ path?: string; } @@ -8558,8 +8293,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * GTM UserPermission's API relative path. Example: - * accounts/{account_id}/user_permissions/{user_permission_id} + * GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id} */ path?: string; diff --git a/src/apis/tasks/package.json b/src/apis/tasks/package.json index 3f761b85d23..cfd5f36fc91 100644 --- a/src/apis/tasks/package.json +++ b/src/apis/tasks/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index a6d066e7f93..a442462b034 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace tasks_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace tasks_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -96,7 +93,10 @@ export namespace tasks_v1 { tasks: Resource$Tasks; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.tasklists = new Resource$Tasklists(this.context); this.tasks = new Resource$Tasks(this.context); @@ -105,8 +105,7 @@ export namespace tasks_v1 { export interface Schema$Task { /** - * Completion date of the task (as a RFC 3339 timestamp). This field is - * omitted if the task has not been completed. + * Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. */ completed?: string; /** @@ -122,9 +121,7 @@ export namespace tasks_v1 { */ etag?: string; /** - * Flag indicating whether the task is hidden. This is the case if the task - * had been marked completed when the task list was last cleared. The - * default is False. This field is read-only. + * Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. */ hidden?: boolean; /** @@ -144,19 +141,11 @@ export namespace tasks_v1 { */ notes?: string; /** - * Parent task identifier. This field is omitted if it is a top-level task. - * This field is read-only. Use the "move" method to move the task - * under a different parent or to the top level. + * Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. */ parent?: string; /** - * String indicating the position of the task among its sibling tasks under - * the same parent task or at the top level. If this string is greater than - * another task's corresponding position string according to - * lexicographical ordering, the task is positioned after the other task - * under the same parent task (or at the top level). This field is - * read-only. Use the "move" method to move the task to another - * position. + * String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. */ position?: string; /** @@ -164,8 +153,7 @@ export namespace tasks_v1 { */ selfLink?: string; /** - * Status of the task. This is either "needsAction" or - * "completed". + * Status of the task. This is either "needsAction" or "completed". */ status?: string; /** @@ -191,8 +179,7 @@ export namespace tasks_v1 { */ kind?: string; /** - * URL pointing to this task list. Used to retrieve, update, or delete this - * task list. + * URL pointing to this task list. Used to retrieve, update, or delete this task list. */ selfLink?: string; /** @@ -391,8 +378,7 @@ export namespace tasks_v1 { /** * tasks.tasklists.insert - * @desc Creates a new task list and adds it to the authenticated user's - * task lists. + * @desc Creates a new task list and adds it to the authenticated user's task lists. * @alias tasks.tasklists.insert * @memberOf! () * @@ -537,8 +523,7 @@ export namespace tasks_v1 { /** * tasks.tasklists.patch - * @desc Updates the authenticated user's specified task list. This method - * supports patch semantics. + * @desc Updates the authenticated user's specified task list. This method supports patch semantics. * @alias tasks.tasklists.patch * @memberOf! () * @@ -721,8 +706,7 @@ export namespace tasks_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of task lists returned on one page. Optional. The default - * is 20 (max allowed: 100). + * Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100). */ maxResults?: string; /** @@ -771,9 +755,7 @@ export namespace tasks_v1 { /** * tasks.tasks.clear - * @desc Clears all completed tasks from the specified task list. The - * affected tasks will be marked as 'hidden' and no longer be returned by - * default when retrieving all tasks for a task list. + * @desc Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list. * @alias tasks.tasks.clear * @memberOf! () * @@ -1143,9 +1125,7 @@ export namespace tasks_v1 { /** * tasks.tasks.move - * @desc Moves the specified task to another position in the task list. This - * can include putting it as a child task under a new parent and/or move it - * to a different position among its sibling tasks. + * @desc Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. * @alias tasks.tasks.move * @memberOf! () * @@ -1411,13 +1391,11 @@ export namespace tasks_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Parent task identifier. If the task is created at the top level, this - * parameter is omitted. Optional. + * Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional. */ parent?: string; /** - * Previous sibling task identifier. If the task is created at the first - * position among its siblings, this parameter is omitted. Optional. + * Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional. */ previous?: string; /** @@ -1437,28 +1415,23 @@ export namespace tasks_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Upper bound for a task's completion date (as a RFC 3339 timestamp) to - * filter by. Optional. The default is not to filter by completion date. + * Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. */ completedMax?: string; /** - * Lower bound for a task's completion date (as a RFC 3339 timestamp) to - * filter by. Optional. The default is not to filter by completion date. + * Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. */ completedMin?: string; /** - * Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. - * Optional. The default is not to filter by due date. + * Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. */ dueMax?: string; /** - * Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. - * Optional. The default is not to filter by due date. + * Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. */ dueMin?: string; /** - * Maximum number of task lists returned on one page. Optional. The default - * is 20 (max allowed: 100). + * Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100). */ maxResults?: string; /** @@ -1466,18 +1439,15 @@ export namespace tasks_v1 { */ pageToken?: string; /** - * Flag indicating whether completed tasks are returned in the result. - * Optional. The default is True. + * Flag indicating whether completed tasks are returned in the result. Optional. The default is True. */ showCompleted?: boolean; /** - * Flag indicating whether deleted tasks are returned in the result. - * Optional. The default is False. + * Flag indicating whether deleted tasks are returned in the result. Optional. The default is False. */ showDeleted?: boolean; /** - * Flag indicating whether hidden tasks are returned in the result. - * Optional. The default is False. + * Flag indicating whether hidden tasks are returned in the result. Optional. The default is False. */ showHidden?: boolean; /** @@ -1485,9 +1455,7 @@ export namespace tasks_v1 { */ tasklist?: string; /** - * Lower bound for a task's last modification time (as a RFC 3339 timestamp) - * to filter by. Optional. The default is not to filter by last modification - * time. + * Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time. */ updatedMin?: string; } @@ -1498,13 +1466,11 @@ export namespace tasks_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * New parent task identifier. If the task is moved to the top level, this - * parameter is omitted. Optional. + * New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional. */ parent?: string; /** - * New previous sibling task identifier. If the task is moved to the first - * position among its siblings, this parameter is omitted. Optional. + * New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional. */ previous?: string; /** diff --git a/src/apis/testing/package.json b/src/apis/testing/package.json index ad57641f562..a1b9263e917 100644 --- a/src/apis/testing/package.json +++ b/src/apis/testing/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 6839f29613a..6e4689dc353 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace testing_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace testing_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace testing_v1 { /** * Cloud Testing API * - * Allows developers to run automated tests for their mobile applications on - * Google infrastructure. + * Allows developers to run automated tests for their mobile applications on Google infrastructure. * * @example * const {google} = require('googleapis'); @@ -115,7 +110,10 @@ export namespace testing_v1 { testEnvironmentCatalog: Resource$Testenvironmentcatalog; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.applicationDetailService = new Resource$Applicationdetailservice( this.context @@ -141,23 +139,19 @@ export namespace testing_v1 { */ export interface Schema$AndroidDevice { /** - * Required. The id of the Android device to be used. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ androidModelId?: string; /** - * Required. The id of the Android OS version to be used. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ androidVersionId?: string; /** - * Required. The locale the test device used for testing. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */ locale?: string; /** - * Required. How the device is oriented during the test. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */ orientation?: string; } @@ -179,8 +173,7 @@ export namespace testing_v1 { versions?: Schema$AndroidVersion[]; } /** - * A list of Android device configurations in which the test is to be - * executed. + * A list of Android device configurations in which the test is to be executed. */ export interface Schema$AndroidDeviceList { /** @@ -189,14 +182,7 @@ export namespace testing_v1 { androidDevices?: Schema$AndroidDevice[]; } /** - * A test of an Android application that can control an Android component - * independently of its normal lifecycle. Android instrumentation tests run an - * application APK and test APK inside the same process on a virtual or - * physical AndroidDevice. They also specify a test runner class, such as - * com.google.GoogleTestRunner, which can vary on the specific instrumentation - * framework chosen. See - * <http://developer.android.com/tools/testing/testing_android.html> for - * more information on types of Android tests. + * A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See <http://developer.android.com/tools/testing/testing_android.html> for more information on types of Android tests. */ export interface Schema$AndroidInstrumentationTest { /** @@ -208,19 +194,11 @@ export namespace testing_v1 { */ appBundle?: Schema$AppBundle; /** - * The java package for the application under test. The default value is - * determined by examining the application's manifest. + * The java package for the application under test. The default value is determined by examining the application's manifest. */ appPackageId?: string; /** - * The option of whether running each test within its own invocation of - * instrumentation with Android Test Orchestrator or not. ** Orchestrator is - * only compatible with AndroidJUnitRunner version 1.0 or higher! ** - * Orchestrator offers the following benefits: - No shared state - Crashes - * are isolated - Logs are scoped per test See - * <https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator> - * for more information about Android Test Orchestrator. If not set, the - * test will be run without the orchestrator. + * The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See <https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator> for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator. */ orchestratorOption?: string; /** @@ -228,50 +206,36 @@ export namespace testing_v1 { */ testApk?: Schema$FileReference; /** - * The java package for the test to be executed. The default value is - * determined by examining the application's manifest. + * The java package for the test to be executed. The default value is determined by examining the application's manifest. */ testPackageId?: string; /** - * The InstrumentationTestRunner class. The default value is determined by - * examining the application's manifest. + * The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. */ testRunnerClass?: string; /** - * Each target must be fully qualified with the package name or class name, - * in one of these formats: - "package package_name" - - * "class package_name.class_name" - "class - * package_name.class_name#method_name" If empty, all targets in the - * module will be run. + * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. */ testTargets?: string[]; } /** - * A set of Android device configuration permutations is defined by the the - * cross-product of the given axes. Internally, the given AndroidMatrix will - * be expanded into a set of AndroidDevices. Only supported permutations will - * be instantiated. Invalid permutations (e.g., incompatible models/versions) - * are ignored. + * A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored. */ export interface Schema$AndroidMatrix { /** - * Required. The ids of the set of Android device to be used. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ androidModelIds?: string[]; /** - * Required. The ids of the set of Android OS version to be used. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ androidVersionIds?: string[]; /** - * Required. The set of locales the test device will enable for testing. Use - * the TestEnvironmentDiscoveryService to get supported options. + * Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. */ locales?: string[]; /** - * Required. The set of orientations to test with. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. */ orientations?: string[]; } @@ -280,13 +244,11 @@ export namespace testing_v1 { */ export interface Schema$AndroidModel { /** - * The company that this device is branded with. Example: - * "Google", "Samsung". + * The company that this device is branded with. Example: "Google", "Samsung". */ brand?: string; /** - * The name of the industrial design. This corresponds to - * android.os.Build.DEVICE. + * The name of the industrial design. This corresponds to android.os.Build.DEVICE. */ codename?: string; /** @@ -298,13 +260,11 @@ export namespace testing_v1 { */ formFactor?: string; /** - * The unique opaque id for this model. Use this for invoking the - * TestExecutionService. + * The unique opaque id for this model. Use this for invoking the TestExecutionService. */ id?: string; /** - * True if and only if tests with this model are recorded by stitching - * together screenshots. See use_low_spec_video_recording in device config. + * True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config. */ lowFpsVideoRecording?: boolean; /** @@ -312,8 +272,7 @@ export namespace testing_v1 { */ manufacturer?: string; /** - * The human-readable marketing name for this device model. Examples: - * "Nexus 5", "Galaxy S5". + * The human-readable marketing name for this device model. Examples: "Nexus 5", "Galaxy S5". */ name?: string; /** @@ -329,13 +288,7 @@ export namespace testing_v1 { */ screenY?: number; /** - * The list of supported ABIs for this device. This corresponds to either - * android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or - * android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first - * element in the list. Elements are optionally prefixed by - * "version_id:" (where version_id is the id of an - * AndroidVersion), denoting an ABI that is supported only on a particular - * version. + * The list of supported ABIs for this device. This corresponds to either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first element in the list. Elements are optionally prefixed by "version_id:" (where version_id is the id of an AndroidVersion), denoting an ABI that is supported only on a particular version. */ supportedAbis?: string[]; /** @@ -343,14 +296,12 @@ export namespace testing_v1 { */ supportedVersionIds?: string[]; /** - * Tags for this dimension. Examples: "default", - * "preview", "deprecated". + * Tags for this dimension. Examples: "default", "preview", "deprecated". */ tags?: string[]; } /** - * A test of an android application that explores the application on a virtual - * or physical Android Device, finding culprits and crashes as it goes. + * A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes. */ export interface Schema$AndroidRoboTest { /** @@ -366,14 +317,11 @@ export namespace testing_v1 { */ appInitialActivity?: string; /** - * The java package for the application under test. The default value is - * determined by examining the application's manifest. + * The java package for the application under test. The default value is determined by examining the application's manifest. */ appPackageId?: string; /** - * The max depth of the traversal stack Robo can explore. Needs to be at - * least 2 to make Robo explore the app beyond the first activity. Default - * is 50. + * The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. */ maxDepth?: number; /** @@ -381,21 +329,15 @@ export namespace testing_v1 { */ maxSteps?: number; /** - * A set of directives Robo should apply during the crawl. This allows users - * to customize the crawl. For example, the username and password for a test - * account can be provided. + * A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. */ roboDirectives?: Schema$RoboDirective[]; /** - * A JSON file with a sequence of actions Robo should perform as a prologue - * for the crawl. + * A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. */ roboScript?: Schema$FileReference; /** - * The intents used to launch the app for the crawl. If none are provided, - * then the main launcher activity is launched. If some are provided, then - * only those provided are launched (the main launcher activity must be - * provided explicitly). + * The intents used to launch the app for the crawl. If none are provided, then the main launcher activity is launched. If some are provided, then only those provided are launched (the main launcher activity must be provided explicitly). */ startingIntents?: Schema$RoboStartingIntent[]; } @@ -413,9 +355,7 @@ export namespace testing_v1 { orientations?: Schema$Orientation[]; } /** - * A test of an Android Application with a Test Loop. The intent - * \<intent-name\> will be implicitly added, since Games is the only - * user of this api, for the time being. + * A test of an Android Application with a Test Loop. The intent \<intent-name\> will be implicitly added, since Games is the only user of this api, for the time being. */ export interface Schema$AndroidTestLoop { /** @@ -427,22 +367,15 @@ export namespace testing_v1 { */ appBundle?: Schema$AppBundle; /** - * The java package for the application under test. The default is - * determined by examining the application's manifest. + * The java package for the application under test. The default is determined by examining the application's manifest. */ appPackageId?: string; /** - * The list of scenario labels that should be run during the test. The - * scenario labels should map to labels defined in the application's - * manifest. For example, player_experience and - * com.google.test.loops.player_experience add all of the loops labeled in - * the manifest with the com.google.test.loops.player_experience name to the - * execution. Scenarios can also be specified in the scenarios field. + * The list of scenario labels that should be run during the test. The scenario labels should map to labels defined in the application's manifest. For example, player_experience and com.google.test.loops.player_experience add all of the loops labeled in the manifest with the com.google.test.loops.player_experience name to the execution. Scenarios can also be specified in the scenarios field. */ scenarioLabels?: string[]; /** - * The list of scenarios that should be run during the test. The default is - * all test loops, derived from the application's manifest. + * The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. */ scenarios?: number[]; } @@ -455,8 +388,7 @@ export namespace testing_v1 { */ apiLevel?: number; /** - * The code name for this Android version. Examples: "JellyBean", - * "KitKat". + * The code name for this Android version. Examples: "JellyBean", "KitKat". */ codeName?: string; /** @@ -464,8 +396,7 @@ export namespace testing_v1 { */ distribution?: Schema$Distribution; /** - * An opaque id for this Android version. Use this id to invoke the - * TestExecutionService. + * An opaque id for this Android version. Use this id to invoke the TestExecutionService. */ id?: string; /** @@ -473,13 +404,11 @@ export namespace testing_v1 { */ releaseDate?: Schema$Date; /** - * Tags for this dimension. Examples: "default", - * "preview", "deprecated". + * Tags for this dimension. Examples: "default", "preview", "deprecated". */ tags?: string[]; /** - * A string representing this version of the Android OS. Examples: - * "4.3", "4.4". + * A string representing this version of the Android OS. Examples: "4.3", "4.4". */ versionString?: string; } @@ -492,21 +421,18 @@ export namespace testing_v1 { */ location?: Schema$FileReference; /** - * The java package for the APK to be installed. Value is determined by - * examining the application's manifest. + * The java package for the APK to be installed. Value is determined by examining the application's manifest. */ packageName?: string; } /** - * Android application details based on application manifest and apk archive - * contents. + * Android application details based on application manifest and apk archive contents. */ export interface Schema$ApkDetail { apkManifest?: Schema$ApkManifest; } /** - * An Android app manifest. See - * http://developer.android.com/guide/topics/manifest/manifest-intro.html + * An Android app manifest. See http://developer.android.com/guide/topics/manifest/manifest-intro.html */ export interface Schema$ApkManifest { /** @@ -523,16 +449,16 @@ export namespace testing_v1 { */ minSdkVersion?: number; /** - * Full Java-style package name for this application, e.g. - * "com.example.foo". + * Full Java-style package name for this application, e.g. "com.example.foo". */ packageName?: string; + /** + * Specifies the API Level on which the application is designed to run. + */ + targetSdkVersion?: number; } /** - * An Android App Bundle file format, containing a BundleConfig.pb file, a - * base module directory, zero or more dynamic feature module directories. - * <p>See https://developer.android.com/guide/app-bundle/build for - * guidance on building App Bundles. + * An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. <p>See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles. */ export interface Schema$AppBundle { /** @@ -545,8 +471,7 @@ export namespace testing_v1 { */ export interface Schema$CancelTestMatrixResponse { /** - * The current rolled-up state of the test matrix. If this state is already - * final, then the cancelation request will have no effect. + * The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect. */ testState?: string; } @@ -564,9 +489,7 @@ export namespace testing_v1 { name?: string; } /** - * Key-value pair of detailed information about the client which invoked the - * test. Examples: {'Version', '1.0'}, {'Release - * Track', 'BETA'}. + * Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}. */ export interface Schema$ClientInfoDetail { /** @@ -579,30 +502,19 @@ export namespace testing_v1 { value?: string; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. */ day?: number; /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. */ month?: number; /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. */ year?: number; } @@ -620,13 +532,11 @@ export namespace testing_v1 { regularFile?: Schema$RegularFile; } /** - * Data about the relative number of devices running a given configuration of - * the Android platform. + * Data about the relative number of devices running a given configuration of the Android platform. */ export interface Schema$Distribution { /** - * Output only. The estimated fraction (0-1) of the total market with this - * configuration. + * Output only. The estimated fraction (0-1) of the total market with this configuration. */ marketShare?: number; /** @@ -652,8 +562,7 @@ export namespace testing_v1 { */ export interface Schema$EnvironmentMatrix { /** - * A list of Android devices; the test will be run only on the specified - * devices. + * A list of Android devices; the test will be run only on the specified devices. */ androidDeviceList?: Schema$AndroidDeviceList; /** @@ -683,8 +592,7 @@ export namespace testing_v1 { */ export interface Schema$FileReference { /** - * A path to a file in Google Cloud Storage. Example: - * gs://build-app-1414623860166/app-debug-unaligned.apk + * A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app-debug-unaligned.apk */ gcsPath?: string; } @@ -698,12 +606,7 @@ export namespace testing_v1 { apkDetail?: Schema$ApkDetail; } /** - * Enables automatic Google account login. If set, the service will - * automatically generate a Google test account and add it to the device, - * before executing the test. Note that test accounts might be reused. Many - * applications show their full set of functionalities when an account is - * present on the device. Logging into the device with these generated - * accounts allows testing more functionalities. + * Enables automatic Google account login. If set, the service will automatically generate a Google test account and add it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities. */ export interface Schema$GoogleAuto {} /** @@ -711,15 +614,12 @@ export namespace testing_v1 { */ export interface Schema$GoogleCloudStorage { /** - * Required. The path to a directory in GCS that will eventually contain the - * results for this test. The requesting user must have write access on the - * bucket in the supplied path. + * Required. The path to a directory in GCS that will eventually contain the results for this test. The requesting user must have write access on the bucket in the supplied path. */ gcsPath?: string; } /** - * The <intent-filter> section of an <activity> tag. - * https://developer.android.com/guide/topics/manifest/intent-filter-element.html + * The <intent-filter> section of an <activity> tag. https://developer.android.com/guide/topics/manifest/intent-filter-element.html */ export interface Schema$IntentFilter { /** @@ -740,23 +640,19 @@ export namespace testing_v1 { */ export interface Schema$IosDevice { /** - * Required. The id of the iOS device to be used. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ iosModelId?: string; /** - * Required. The id of the iOS major software version to be used. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */ iosVersionId?: string; /** - * Required. The locale the test device used for testing. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */ locale?: string; /** - * Required. How the device is oriented during the test. Use the - * TestEnvironmentDiscoveryService to get supported options. + * Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */ orientation?: string; } @@ -795,8 +691,7 @@ export namespace testing_v1 { */ export interface Schema$IosModel { /** - * Device capabilities. Copied from - * https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html + * Device capabilities. Copied from https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html */ deviceCapabilities?: string[]; /** @@ -804,13 +699,11 @@ export namespace testing_v1 { */ formFactor?: string; /** - * The unique opaque id for this model. Use this for invoking the - * TestExecutionService. + * The unique opaque id for this model. Use this for invoking the TestExecutionService. */ id?: string; /** - * The human-readable name for this device model. Examples: "iPhone - * 4s", "iPad Mini 2". + * The human-readable name for this device model. Examples: "iPhone 4s", "iPad Mini 2". */ name?: string; /** @@ -818,8 +711,7 @@ export namespace testing_v1 { */ supportedVersionIds?: string[]; /** - * Tags for this dimension. Examples: "default", - * "preview", "deprecated". + * Tags for this dimension. Examples: "default", "preview", "deprecated". */ tags?: string[]; } @@ -841,10 +733,7 @@ export namespace testing_v1 { */ export interface Schema$IosTestSetup { /** - * The network traffic profile used for running the test. Available network - * profiles can be queried by using the NETWORK_CONFIGURATION environment - * type when calling - * TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. + * The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. */ networkProfile?: string; } @@ -853,18 +742,15 @@ export namespace testing_v1 { */ export interface Schema$IosVersion { /** - * An opaque id for this iOS version. Use this id to invoke the - * TestExecutionService. + * An opaque id for this iOS version. Use this id to invoke the TestExecutionService. */ id?: string; /** - * An integer representing the major iOS version. Examples: "8", - * "9". + * An integer representing the major iOS version. Examples: "8", "9". */ majorVersion?: number; /** - * An integer representing the minor iOS version. Examples: "1", - * "2". + * An integer representing the minor iOS version. Examples: "1", "2". */ minorVersion?: number; /** @@ -872,18 +758,12 @@ export namespace testing_v1 { */ supportedXcodeVersionIds?: string[]; /** - * Tags for this dimension. Examples: "default", - * "preview", "deprecated". + * Tags for this dimension. Examples: "default", "preview", "deprecated". */ tags?: string[]; } /** - * A test of an iOS application that uses the XCTest framework. Xcode supports - * the option to "build for testing", which generates an .xctestrun - * file that contains a test specification (arguments, test methods, etc). - * This test type accepts a zip file containing the .xctestrun file and the - * corresponding contents of the Build/Products directory that contains all - * the binaries needed to run the tests. + * A test of an iOS application that uses the XCTest framework. Xcode supports the option to "build for testing", which generates an .xctestrun file that contains a test specification (arguments, test methods, etc). This test type accepts a zip file containing the .xctestrun file and the corresponding contents of the Build/Products directory that contains all the binaries needed to run the tests. */ export interface Schema$IosXcTest { /** @@ -891,22 +771,15 @@ export namespace testing_v1 { */ appBundleId?: string; /** - * Required. The .zip containing the .xctestrun file and the contents of the - * DerivedData/Build/Products directory. The .xctestrun file in this zip is - * ignored if the xctestrun field is specified. + * Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. */ testsZip?: Schema$FileReference; /** - * The Xcode version that should be used for the test. Use the - * TestEnvironmentDiscoveryService to get supported options. Defaults to the - * latest Xcode version Firebase Test Lab supports. + * The Xcode version that should be used for the test. Use the TestEnvironmentDiscoveryService to get supported options. Defaults to the latest Xcode version Firebase Test Lab supports. */ xcodeVersion?: string; /** - * An .xctestrun file that will override the .xctestrun file in the tests - * zip. Because the .xctestrun file contains environment variables along - * with test methods to run and/or ignore, this can be useful for sharding - * tests. Default is taken from the tests zip. + * An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. */ xctestrun?: Schema$FileReference; } @@ -923,13 +796,11 @@ export namespace testing_v1 { */ id?: string; /** - * A human-friendly name for this language/locale. Example: - * "English". + * A human-friendly name for this language/locale. Example: "English". */ name?: string; /** - * A human-friendly string representing the region for this locale. Example: - * "United States". Not present for every locale. + * A human-friendly string representing the region for this locale. Example: "United States". Not present for every locale. */ region?: string; /** @@ -963,11 +834,7 @@ export namespace testing_v1 { */ obb?: Schema$FileReference; /** - * Required. OBB file name which must conform to the format as specified by - * Android e.g. [main|patch].0300110.com.example.android.obb which will be - * installed into - * \<shared-storage\>/Android/obb/\<package-name\>/ on the - * device. + * Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \<shared-storage\>/Android/obb/\<package-name\>/ on the device. */ obbFileName?: string; } @@ -980,8 +847,7 @@ export namespace testing_v1 { */ id?: string; /** - * A human-friendly name for this orientation. Example: - * "portrait". + * A human-friendly name for this orientation. Example: "portrait". */ name?: string; /** @@ -994,9 +860,7 @@ export namespace testing_v1 { */ export interface Schema$ProvidedSoftwareCatalog { /** - * A string representing the current version of Android Test Orchestrator - * that is provided by TestExecutionService. Example: "1.0.2 - * beta". + * A string representing the current version of Android Test Orchestrator that is provided by TestExecutionService. Example: "1.0.2 beta". */ orchestratorVersion?: string; } @@ -1009,20 +873,7 @@ export namespace testing_v1 { */ content?: Schema$FileReference; /** - * Required. Where to put the content on the device. Must be an absolute, - * whitelisted path. If the file exists, it will be replaced. The following - * device-side directories and any of their subdirectories are whitelisted: - * <p>${EXTERNAL_STORAGE}, or /sdcard</p> - * <p>${ANDROID_DATA}/local/tmp, or /data/local/tmp</p> - * <p>Specifying a path outside of these directory trees is invalid. - * <p> The paths /sdcard and /data will be made available and treated - * as implicit path substitutions. E.g. if /sdcard on a particular device - * does not map to external storage, the system will replace it with the - * external storage path prefix for that device and copy the file there. - * <p> It is strongly advised to use the <a href= - * "http://developer.android.com/reference/android/os/Environment.html"> - * Environment API</a> in app and test code to access files on the - * device in a portable way. + * Required. Where to put the content on the device. Must be an absolute, whitelisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are whitelisted: <p>${EXTERNAL_STORAGE}, or /sdcard</p> <p>${ANDROID_DATA}/local/tmp, or /data/local/tmp</p> <p>Specifying a path outside of these directory trees is invalid. <p> The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. <p> It is strongly advised to use the <a href= "http://developer.android.com/reference/android/os/Environment.html"> Environment API</a> in app and test code to access files on the device in a portable way. */ devicePath?: string; } @@ -1039,32 +890,24 @@ export namespace testing_v1 { */ toolResultsExecution?: Schema$ToolResultsExecution; /** - * The tool results history that contains the tool results execution that - * results are written to. If not provided, the service will choose an - * appropriate value. + * The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value. */ toolResultsHistory?: Schema$ToolResultsHistory; } /** - * Directs Robo to interact with a specific UI element if it is encountered - * during the crawl. Currently, Robo can perform text entry or element click. + * Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click. */ export interface Schema$RoboDirective { /** - * Required. The type of action that Robo should perform on the specified - * element. + * Required. The type of action that Robo should perform on the specified element. */ actionType?: string; /** - * The text that Robo is directed to set. If left empty, the directive will - * be treated as a CLICK on the element matching the resource_name. + * The text that Robo is directed to set. If left empty, the directive will be treated as a CLICK on the element matching the resource_name. */ inputText?: string; /** - * Required. The android resource name of the target UI element. For - * example, in Java: R.string.foo in xml: @string/foo Only the - * "foo" part is needed. Reference doc: - * https://developer.android.com/guide/topics/resources/accessing-resources.html + * Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the "foo" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html */ resourceName?: string; } @@ -1101,15 +944,11 @@ export namespace testing_v1 { */ export interface Schema$TestDetails { /** - * Output only. If the TestState is ERROR, then this string will contain - * human-readable details about the error. + * Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. */ errorMessage?: string; /** - * Output only. Human-readable, detailed descriptions of the test's - * progress. For example: "Provisioning a device", "Starting - * Test". During the course of execution new data may be appended to - * the end of progress_messages. + * Output only. Human-readable, detailed descriptions of the test's progress. For example: "Provisioning a device", "Starting Test". During the course of execution new data may be appended to the end of progress_messages. */ progressMessages?: string[]; } @@ -1155,8 +994,7 @@ export namespace testing_v1 { */ projectId?: string; /** - * Output only. Indicates the current progress of the test execution (e.g., - * FINISHED). + * Output only. Indicates the current progress of the test execution (e.g., FINISHED). */ state?: string; /** @@ -1177,8 +1015,7 @@ export namespace testing_v1 { toolResultsStep?: Schema$ToolResultsStep; } /** - * A group of one or more TestExecutions, built by taking a product of values - * over a pre-defined set of axes. + * A group of one or more TestExecutions, built by taking a product of values over a pre-defined set of axes. */ export interface Schema$TestMatrix { /** @@ -1190,14 +1027,11 @@ export namespace testing_v1 { */ environmentMatrix?: Schema$EnvironmentMatrix; /** - * The number of times a TestExecution should be re-attempted if one or more - * of its test cases fail for any reason. The maximum number of reruns - * allowed is 10. Default is 0, which implies no reruns. + * The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. */ flakyTestAttempts?: number; /** - * Output only. Describes why the matrix is considered invalid. Only useful - * for matrices in the INVALID state. + * Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. */ invalidMatrixDetails?: string; /** @@ -1209,13 +1043,11 @@ export namespace testing_v1 { */ resultStorage?: Schema$ResultStorage; /** - * Output only. Indicates the current progress of the test matrix (e.g., - * FINISHED). + * Output only. Indicates the current progress of the test matrix (e.g., FINISHED). */ state?: string; /** - * Output only. The list of test executions that the service creates for - * this matrix. + * Output only. The list of test executions that the service creates for this matrix. */ testExecutions?: Schema$TestExecution[]; /** @@ -1232,33 +1064,23 @@ export namespace testing_v1 { timestamp?: string; } /** - * A description of how to set up the Android device prior to running the - * test. + * A description of how to set up the Android device prior to running the test. */ export interface Schema$TestSetup { /** - * The device will be logged in on this account for the duration of the - * test. + * The device will be logged in on this account for the duration of the test. */ account?: Schema$Account; /** - * APKs to install in addition to those being directly tested. Currently - * capped at 100. + * APKs to install in addition to those being directly tested. Currently capped at 100. */ additionalApks?: Schema$Apk[]; /** - * List of directories on the device to upload to GCS at the end of the - * test; they must be absolute paths under /sdcard or /data/local/tmp. Path - * names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The - * paths /sdcard and /data will be made available and treated as implicit - * path substitutions. E.g. if /sdcard on a particular device does not map - * to external storage, the system will replace it with the external storage - * path prefix for that device. + * List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device. */ directoriesToPull?: string[]; /** - * Environment variables to set for the test (only applicable for - * instrumentation tests). + * Environment variables to set for the test (only applicable for instrumentation tests). */ environmentVariables?: Schema$EnvironmentVariable[]; /** @@ -1266,10 +1088,7 @@ export namespace testing_v1 { */ filesToPush?: Schema$DeviceFile[]; /** - * The network traffic profile used for running the test. Available network - * profiles can be queried by using the NETWORK_CONFIGURATION environment - * type when calling - * TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. + * The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. */ networkProfile?: string; } @@ -1306,19 +1125,16 @@ export namespace testing_v1 { */ iosXcTest?: Schema$IosXcTest; /** - * Test setup requirements for Android e.g. files to install, bootstrap - * scripts. + * Test setup requirements for Android e.g. files to install, bootstrap scripts. */ testSetup?: Schema$TestSetup; /** - * Max time a test execution is allowed to run before it is automatically - * cancelled. The default value is 5 min. + * Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. */ testTimeout?: string; } /** - * Represents a tool results execution resource. This has the results of a - * TestMatrix. + * Represents a tool results execution resource. This has the results of a TestMatrix. */ export interface Schema$ToolResultsExecution { /** @@ -1348,8 +1164,7 @@ export namespace testing_v1 { projectId?: string; } /** - * Represents a tool results step resource. This has the results of a - * TestExecution. + * Represents a tool results step resource. This has the results of a TestExecution. */ export interface Schema$ToolResultsStep { /** @@ -1522,12 +1337,7 @@ export namespace testing_v1 { /** * testing.projects.testMatrices.cancel - * @desc Cancels unfinished test executions in a test matrix. This call - * returns immediately and cancellation proceeds asychronously. If the - * matrix is already final, this operation will have no effect. May return - * any of the following canonical error codes: - PERMISSION_DENIED - if the - * user is not authorized to read project - INVALID_ARGUMENT - if the - * request is malformed - NOT_FOUND - if the Test Matrix does not exist + * @desc Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asychronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist * @alias testing.projects.testMatrices.cancel * @memberOf! () * @@ -1606,13 +1416,7 @@ export namespace testing_v1 { /** * testing.projects.testMatrices.create - * @desc Creates and runs a matrix of tests according to the given - * specifications. Unsupported environments will be returned in the state - * UNSUPPORTED. Matrices are limited to at most 200 supported executions. - * May return any of the following canonical error codes: - - * PERMISSION_DENIED - if the user is not authorized to write to project - - * INVALID_ARGUMENT - if the request is malformed or if the matrix expands - * to more than 200 supported executions + * @desc Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. Matrices are limited to at most 200 supported executions. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix expands to more than 200 supported executions * @alias testing.projects.testMatrices.create * @memberOf! () * @@ -1688,10 +1492,7 @@ export namespace testing_v1 { /** * testing.projects.testMatrices.get - * @desc Checks the status of a test matrix. May return any of the - * following canonical error codes: - PERMISSION_DENIED - if the user is - * not authorized to read project - INVALID_ARGUMENT - if the request is - * malformed - NOT_FOUND - if the Test Matrix does not exist + * @desc Checks the status of a test matrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist * @alias testing.projects.testMatrices.get * @memberOf! () * @@ -1792,9 +1593,7 @@ export namespace testing_v1 { */ projectId?: string; /** - * A string id used to detect duplicated requests. Ids are automatically - * scoped to a project, so users should ensure the ID is unique per-project. - * A UUID is recommended. Optional, but strongly recommended. + * A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended. */ requestId?: string; @@ -1828,10 +1627,7 @@ export namespace testing_v1 { /** * testing.testEnvironmentCatalog.get - * @desc Gets the catalog of supported test environments. May return any of - * the following canonical error codes: - INVALID_ARGUMENT - if the request - * is malformed - NOT_FOUND - if the environment type does not exist - - * INTERNAL - if an internal error occurred + * @desc Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred * @alias testing.testEnvironmentCatalog.get * @memberOf! () * @@ -1918,8 +1714,7 @@ export namespace testing_v1 { */ environmentType?: string; /** - * For authorization, the cloud project requesting the - * TestEnvironmentCatalog. + * For authorization, the cloud project requesting the TestEnvironmentCatalog. */ projectId?: string; } diff --git a/src/apis/texttospeech/package.json b/src/apis/texttospeech/package.json index 43eb24466b5..c86ef7e54b2 100644 --- a/src/apis/texttospeech/package.json +++ b/src/apis/texttospeech/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index 6f718632a20..005f4276017 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace texttospeech_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace texttospeech_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace texttospeech_v1 { /** * Cloud Text-to-Speech API * - * Synthesizes natural-sounding speech by applying powerful neural network - * models. + * Synthesizes natural-sounding speech by applying powerful neural network models. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace texttospeech_v1 { voices: Resource$Voices; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.text = new Resource$Text(this.context); this.voices = new Resource$Voices(this.context); @@ -130,44 +128,23 @@ export namespace texttospeech_v1 { */ audioEncoding?: string; /** - * An identifier which selects 'audio effects' profiles that are - * applied on (post synthesized) text to speech. Effects are applied on top - * of each other in the order they are given. See [audio-profiles](https: - * //cloud.google.com/text-to-speech/docs/audio-profiles) for current - * supported profile ids. + * An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. See [audio-profiles](https: //cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. */ effectsProfileId?: string[]; /** - * Optional speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 - * semitones from the original pitch. -20 means decrease 20 semitones from - * the original pitch. + * Optional speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number; /** - * The synthesis sample rate (in hertz) for this audio. Optional. If this - * is different from the voice's natural sample rate, then the - * synthesizer will honor this request by converting to the desired sample - * rate (which might result in worse audio quality), unless the specified - * sample rate is not supported for the encoding chosen, in which case it - * will fail the request and return google.rpc.Code.INVALID_ARGUMENT. + * The synthesis sample rate (in hertz) for this audio. Optional. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ sampleRateHertz?: number; /** - * Optional speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal - * native speed supported by the specific voice. 2.0 is twice as fast, and - * 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any - * other values < 0.25 or > 4.0 will return an error. + * Optional speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ speakingRate?: number; /** - * Optional volume gain (in dB) of the normal native volume supported by the - * specific voice, in the range [-96.0, 16.0]. If unset, or set to a value - * of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 - * (dB) will play at approximately half the amplitude of the normal native - * signal amplitude. A value of +6.0 (dB) will play at approximately twice - * the amplitude of the normal native signal amplitude. Strongly recommend - * not to exceed +10 (dB) as there's usually no effective increase in - * loudness for any value greater than that. + * Optional volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ volumeGainDb?: number; } @@ -181,17 +158,11 @@ export namespace texttospeech_v1 { voices?: Schema$Voice[]; } /** - * Contains text input to be synthesized. Either `text` or `ssml` must be - * supplied. Supplying both or neither returns - * google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 - * characters. + * Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 characters. */ export interface Schema$SynthesisInput { /** - * The SSML document to be synthesized. The SSML document must be valid and - * well-formed. Otherwise the RPC will fail and return - * google.rpc.Code.INVALID_ARGUMENT. For more information, see - * [SSML](/speech/text-to-speech/docs/ssml). + * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](/speech/text-to-speech/docs/ssml). */ ssml?: string; /** @@ -221,10 +192,7 @@ export namespace texttospeech_v1 { */ export interface Schema$SynthesizeSpeechResponse { /** - * The audio data bytes encoded as specified in the request, including the - * header (For LINEAR16 audio, we include the WAV header). Note: as with all - * bytes fields, protobuffers use a pure binary representation, whereas JSON - * representations use base64. + * The audio data bytes encoded as specified in the request, including the header (For LINEAR16 audio, we include the WAV header). Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ audioContent?: string; } @@ -233,9 +201,7 @@ export namespace texttospeech_v1 { */ export interface Schema$Voice { /** - * The languages that this voice supports, expressed as - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags - * (e.g. "en-US", "es-419", "cmn-tw"). + * The languages that this voice supports, expressed as [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw"). */ languageCodes?: string[]; /** @@ -256,32 +222,15 @@ export namespace texttospeech_v1 { */ export interface Schema$VoiceSelectionParams { /** - * The language (and optionally also the region) of the voice expressed as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. - * "en-US". Required. This should not include a script tag (e.g. - * use "cmn-cn" rather than "cmn-Hant-cn"), because the - * script will be inferred from the input provided in the SynthesisInput. - * The TTS service will use this parameter to help choose an appropriate - * voice. Note that the TTS service may choose a voice with a slightly - * different language code than the one selected; it may substitute a - * different region (e.g. using en-US rather than en-CA if there isn't a - * Canadian voice available), or even a different language, e.g. using - * "nb" (Norwegian Bokmal) instead of "no" - * (Norwegian)". + * The language (and optionally also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". Required. This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". */ languageCode?: string; /** - * The name of the voice. Optional; if not set, the service will choose a - * voice based on the other parameters such as language_code and gender. + * The name of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and gender. */ name?: string; /** - * The preferred gender of the voice. Optional; if not set, the service will - * choose a voice based on the other parameters such as language_code and - * name. Note that this is only a preference, not requirement; if a voice of - * the appropriate gender is not available, the synthesizer should - * substitute a voice with a different gender rather than failing the - * request. + * The preferred gender of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ ssmlGender?: string; } @@ -294,8 +243,7 @@ export namespace texttospeech_v1 { /** * texttospeech.text.synthesize - * @desc Synthesizes speech synchronously: receive results after all text - * input has been processed. + * @desc Synthesizes speech synchronously: receive results after all text input has been processed. * @alias texttospeech.text.synthesize * @memberOf! () * @@ -467,14 +415,7 @@ export namespace texttospeech_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional (but recommended) - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If - * specified, the ListVoices call will only return voices that can be used - * to synthesize this language_code. E.g. when specifying "en-NZ", you will - * get supported "en-*" voices; when specifying "no", you will get supported - * "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" - * will also get supported "cmn-*" voices; specifying "zh-hk" will also get - * supported "yue-*" voices. + * Optional (but recommended) [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. */ languageCode?: string; } diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 518e724dcd9..9b4ebfd943c 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace texttospeech_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace texttospeech_v1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace texttospeech_v1beta1 { /** * Cloud Text-to-Speech API * - * Synthesizes natural-sounding speech by applying powerful neural network - * models. + * Synthesizes natural-sounding speech by applying powerful neural network models. * * @example * const {google} = require('googleapis'); @@ -114,7 +109,10 @@ export namespace texttospeech_v1beta1 { voices: Resource$Voices; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.text = new Resource$Text(this.context); this.voices = new Resource$Voices(this.context); @@ -130,44 +128,23 @@ export namespace texttospeech_v1beta1 { */ audioEncoding?: string; /** - * An identifier which selects 'audio effects' profiles that are - * applied on (post synthesized) text to speech. Effects are applied on top - * of each other in the order they are given. See [audio-profiles](https: - * //cloud.google.com/text-to-speech/docs/audio-profiles) for current - * supported profile ids. + * An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. See [audio-profiles](https: //cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. */ effectsProfileId?: string[]; /** - * Optional speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 - * semitones from the original pitch. -20 means decrease 20 semitones from - * the original pitch. + * Optional speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number; /** - * The synthesis sample rate (in hertz) for this audio. Optional. If this - * is different from the voice's natural sample rate, then the - * synthesizer will honor this request by converting to the desired sample - * rate (which might result in worse audio quality), unless the specified - * sample rate is not supported for the encoding chosen, in which case it - * will fail the request and return google.rpc.Code.INVALID_ARGUMENT. + * The synthesis sample rate (in hertz) for this audio. Optional. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ sampleRateHertz?: number; /** - * Optional speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal - * native speed supported by the specific voice. 2.0 is twice as fast, and - * 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any - * other values < 0.25 or > 4.0 will return an error. + * Optional speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ speakingRate?: number; /** - * Optional volume gain (in dB) of the normal native volume supported by the - * specific voice, in the range [-96.0, 16.0]. If unset, or set to a value - * of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 - * (dB) will play at approximately half the amplitude of the normal native - * signal amplitude. A value of +6.0 (dB) will play at approximately twice - * the amplitude of the normal native signal amplitude. Strongly recommend - * not to exceed +10 (dB) as there's usually no effective increase in - * loudness for any value greater than that. + * Optional volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ volumeGainDb?: number; } @@ -181,17 +158,11 @@ export namespace texttospeech_v1beta1 { voices?: Schema$Voice[]; } /** - * Contains text input to be synthesized. Either `text` or `ssml` must be - * supplied. Supplying both or neither returns - * google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 - * characters. + * Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 characters. */ export interface Schema$SynthesisInput { /** - * The SSML document to be synthesized. The SSML document must be valid and - * well-formed. Otherwise the RPC will fail and return - * google.rpc.Code.INVALID_ARGUMENT. For more information, see - * [SSML](/speech/text-to-speech/docs/ssml). + * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](/speech/text-to-speech/docs/ssml). */ ssml?: string; /** @@ -221,10 +192,7 @@ export namespace texttospeech_v1beta1 { */ export interface Schema$SynthesizeSpeechResponse { /** - * The audio data bytes encoded as specified in the request, including the - * header (For LINEAR16 audio, we include the WAV header). Note: as with all - * bytes fields, protobuffers use a pure binary representation, whereas JSON - * representations use base64. + * The audio data bytes encoded as specified in the request, including the header (For LINEAR16 audio, we include the WAV header). Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ audioContent?: string; } @@ -233,9 +201,7 @@ export namespace texttospeech_v1beta1 { */ export interface Schema$Voice { /** - * The languages that this voice supports, expressed as - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags - * (e.g. "en-US", "es-419", "cmn-tw"). + * The languages that this voice supports, expressed as [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw"). */ languageCodes?: string[]; /** @@ -256,32 +222,15 @@ export namespace texttospeech_v1beta1 { */ export interface Schema$VoiceSelectionParams { /** - * The language (and optionally also the region) of the voice expressed as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. - * "en-US". Required. This should not include a script tag (e.g. - * use "cmn-cn" rather than "cmn-Hant-cn"), because the - * script will be inferred from the input provided in the SynthesisInput. - * The TTS service will use this parameter to help choose an appropriate - * voice. Note that the TTS service may choose a voice with a slightly - * different language code than the one selected; it may substitute a - * different region (e.g. using en-US rather than en-CA if there isn't a - * Canadian voice available), or even a different language, e.g. using - * "nb" (Norwegian Bokmal) instead of "no" - * (Norwegian)". + * The language (and optionally also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". Required. This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". */ languageCode?: string; /** - * The name of the voice. Optional; if not set, the service will choose a - * voice based on the other parameters such as language_code and gender. + * The name of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and gender. */ name?: string; /** - * The preferred gender of the voice. Optional; if not set, the service will - * choose a voice based on the other parameters such as language_code and - * name. Note that this is only a preference, not requirement; if a voice of - * the appropriate gender is not available, the synthesizer should - * substitute a voice with a different gender rather than failing the - * request. + * The preferred gender of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ ssmlGender?: string; } @@ -294,8 +243,7 @@ export namespace texttospeech_v1beta1 { /** * texttospeech.text.synthesize - * @desc Synthesizes speech synchronously: receive results after all text - * input has been processed. + * @desc Synthesizes speech synchronously: receive results after all text input has been processed. * @alias texttospeech.text.synthesize * @memberOf! () * @@ -467,14 +415,7 @@ export namespace texttospeech_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional (but recommended) - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If - * specified, the ListVoices call will only return voices that can be used - * to synthesize this language_code. E.g. when specifying "en-NZ", you will - * get supported "en-*" voices; when specifying "no", you will get supported - * "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" - * will also get supported "cmn-*" voices; specifying "zh-hk" will also get - * supported "yue-*" voices. + * Optional (but recommended) [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. */ languageCode?: string; } diff --git a/src/apis/toolresults/package.json b/src/apis/toolresults/package.json index 541705a1a6c..bcee0f9a9cd 100644 --- a/src/apis/toolresults/package.json +++ b/src/apis/toolresults/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 74b920366b2..4720e0f2d5b 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace toolresults_v1beta3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace toolresults_v1beta3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace toolresults_v1beta3 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -123,9 +123,7 @@ export namespace toolresults_v1beta3 { versionName?: string; } /** - * A test of an Android application that can control an Android component - * independently of its normal lifecycle. See for more information on types - * of Android tests. + * A test of an Android application that can control an Android component independently of its normal lifecycle. See for more information on types of Android tests. */ export interface Schema$AndroidInstrumentationTest { /** @@ -137,22 +135,16 @@ export namespace toolresults_v1beta3 { */ testRunnerClass?: string; /** - * Each target must be fully qualified with the package name or class name, - * in one of these formats: - "package package_name" - "class - * package_name.class_name" - "class - * package_name.class_name#method_name" If empty, all targets in the - * module will be run. + * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. */ testTargets?: string[]; /** - * The flag indicates whether Android Test Orchestrator will be used to run - * test or not. + * The flag indicates whether Android Test Orchestrator will be used to run test or not. */ useOrchestrator?: boolean; } /** - * A test of an android application that explores the application on a virtual - * or physical Android device, finding culprits and crashes as it goes. + * A test of an android application that explores the application on a virtual or physical Android device, finding culprits and crashes as it goes. */ export interface Schema$AndroidRoboTest { /** @@ -172,8 +164,7 @@ export namespace toolresults_v1beta3 { */ maxDepth?: number; /** - * The max number of steps/actions Robo can execute. Default is no limit - * (0). Optional + * The max number of steps/actions Robo can execute. Default is no limit (0). Optional */ maxSteps?: number; } @@ -199,58 +190,11 @@ export namespace toolresults_v1beta3 { testTimeout?: Schema$Duration; } /** - * `Any` contains an arbitrary serialized protocol buffer message along with a - * URL that describes the type of the serialized message. Protobuf library - * provides support to pack/unpack Any values in the form of utility functions - * or additional generated methods of the Any type. Example 1: Pack and - * unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if - * (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in - * Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { - * foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in - * Python. foo = Foo(...) any = Any() any.Pack(foo) ... if - * any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a - * message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) - * ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != - * nil { ... } The pack methods provided by protobuf library will by default - * use 'type.googleapis.com/full.type.name' as the type URL and the - * unpack methods only use the fully qualified type name after the last - * '/' in the type URL, for example "foo.bar.com/x/y.z" will - * yield type name "y.z". JSON ==== The JSON representation of an - * `Any` value uses the regular representation of the deserialized, embedded - * message, with an additional field `@type` which contains the type URL. - * Example: package google.profile; message Person { string first_name = 1; - * string last_name = 2; } { "@type": - * "type.googleapis.com/google.profile.Person", - * "firstName": , "lastName": } If the embedded message - * type is well-known and has a custom JSON representation, that - * representation will be embedded adding a field `value` which holds the - * custom JSON in addition to the `@type` field. Example (for message - * [google.protobuf.Duration][]): { "@type": - * "type.googleapis.com/google.protobuf.Duration", - * "value": "1.212s" } + * `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } */ export interface Schema$Any { /** - * A URL/resource name that uniquely identifies the type of the serialized - * protocol buffer message. This string must contain at least one - * "/" character. The last segment of the URL's path must - * represent the fully qualified name of the type (as in - * `path/google.protobuf.Duration`). The name should be in a canonical form - * (e.g., leading "." is not accepted). In practice, teams - * usually precompile into the binary all types that they expect it to use - * in the context of Any. However, for URLs which use the scheme `http`, - * `https`, or no scheme, one can optionally set up a type server that maps - * type URLs to message definitions as follows: * If no scheme is provided, - * `https` is assumed. * An HTTP GET on the URL must yield a - * [google.protobuf.Type][] value in binary format, or produce an error. * - * Applications are allowed to cache lookup results based on the URL, or - * have them precompiled into a binary to avoid any lookup. Therefore, - * binary compatibility needs to be preserved on changes to types. (Use - * versioned type names to manage breaking changes.) Note: this - * functionality is not currently available in the official protobuf - * release, and it is not used for type URLs beginning with - * type.googleapis.com. Schemes other than `http`, `https` (or the empty - * scheme) might be used with implementation specific semantics. + * A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. */ typeUrl?: string; /** @@ -260,22 +204,16 @@ export namespace toolresults_v1beta3 { } export interface Schema$AppStartTime { /** - * Optional. The time from app start to reaching the developer-reported - * "fully drawn" time. This is only stored if the app includes a - * call to Activity.reportFullyDrawn(). See - * https://developer.android.com/topic/performance/launch-time.html#time-full + * Optional. The time from app start to reaching the developer-reported "fully drawn" time. This is only stored if the app includes a call to Activity.reportFullyDrawn(). See https://developer.android.com/topic/performance/launch-time.html#time-full */ fullyDrawnTime?: Schema$Duration; /** - * The time from app start to the first displayed activity being drawn, as - * reported in Logcat. See - * https://developer.android.com/topic/performance/launch-time.html#time-initial + * The time from app start to the first displayed activity being drawn, as reported in Logcat. See https://developer.android.com/topic/performance/launch-time.html#time-initial */ initialDisplayTime?: Schema$Duration; } /** - * Encapsulates the metadata for basic sample series represented by a line - * chart + * Encapsulates the metadata for basic sample series represented by a line chart */ export interface Schema$BasicPerfSampleSeries { perfMetricType?: string; @@ -283,8 +221,7 @@ export namespace toolresults_v1beta3 { sampleSeriesLabel?: string; } /** - * The request must provide up to a maximum of 5000 samples to be created; a - * larger sample size will cause an INVALID_ARGUMENT error + * The request must provide up to a maximum of 5000 samples to be created; a larger sample size will cause an INVALID_ARGUMENT error */ export interface Schema$BatchCreatePerfSamplesRequest { /** @@ -297,8 +234,7 @@ export namespace toolresults_v1beta3 { } export interface Schema$CPUInfo { /** - * description of the device processor ie '1.8 GHz hexa core 64-bit - * ARMv8-A' + * description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A' */ cpuProcessor?: string; /** @@ -311,115 +247,61 @@ export namespace toolresults_v1beta3 { numberOfCores?: number; } /** - * A Duration represents a signed, fixed-length span of time represented as a - * count of seconds and fractions of seconds at nanosecond resolution. It is - * independent of any calendar and concepts like "day" or - * "month". It is related to Timestamp in that the difference - * between two Timestamp values is a Duration and it can be added or - * subtracted from a Timestamp. Range is approximately +-10,000 years. # - * Examples Example 1: Compute Duration from two Timestamps in pseudo code. - * Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - * duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - * - start.nanos; if (duration.seconds 0) { duration.seconds += 1; - * duration.nanos -= 1000000000; } else if (durations.seconds > 0 - * && duration.nanos < 0) { duration.seconds -= 1; duration.nanos - * += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in - * pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end - * = ...; end.seconds = start.seconds + duration.seconds; end.nanos = - * start.nanos + duration.nanos; if (end.nanos = 1000000000) { end.seconds += - * 1; end.nanos -= 1000000000; } Example 3: Compute Duration from - * datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) - * duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON - * format, the Duration type is encoded as a string rather than an object, - * where the string ends in the suffix "s" (indicating seconds) and - * is preceded by the number of seconds, with nanoseconds expressed as - * fractional seconds. For example, 3 seconds with 0 nanoseconds should be - * encoded in JSON format as "3s", while 3 seconds and 1 nanosecond - * should be expressed in JSON format as "3.000000001s", and 3 - * seconds and 1 microsecond should be expressed in JSON format as - * "3.000001s". + * A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # Examples Example 1: Compute Duration from two Timestamps in pseudo code. Timestamp start = ...; Timestamp end = ...; Duration duration = ...; duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos; if (duration.seconds 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end = ...; end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos; if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; } Example 3: Compute Duration from datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s". */ export interface Schema$Duration { /** - * Signed fractions of a second at nanosecond resolution of the span of - * time. Durations less than one second are represented with a 0 `seconds` - * field and a positive or negative `nanos` field. For durations of one - * second or more, a non-zero value for the `nanos` field must be of the - * same sign as the `seconds` field. Must be from -999,999,999 to - * +999,999,999 inclusive. + * Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive. */ nanos?: number; /** - * Signed seconds of the span of time. Must be from -315,576,000,000 to - * +315,576,000,000 inclusive. Note: these bounds are computed from: 60 - * sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + * Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years */ seconds?: string; } /** - * An Execution represents a collection of Steps. For instance, it could - * represent: - a mobile test executed across a range of device configurations - * - a jenkins job with a build step followed by a test step The maximum size - * of an execution message is 1 MiB. An Execution can be updated until its - * state is set to COMPLETE at which point it becomes immutable. + * An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. */ export interface Schema$Execution { /** - * The time when the Execution status transitioned to COMPLETE. This value - * will be set automatically when state transitions to COMPLETE. - In - * response: set if the execution state is COMPLETE. - In create/update - * request: never set + * The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set */ completionTime?: Schema$Timestamp; /** - * The time when the Execution was created. This value will be set - * automatically when CreateExecution is called. - In response: always set - * - In create/update request: never set + * The time when the Execution was created. This value will be set automatically when CreateExecution is called. - In response: always set - In create/update request: never set */ creationTime?: Schema$Timestamp; /** - * A unique identifier within a History for this Execution. Returns - * INVALID_ARGUMENT if this field is set or overwritten by the caller. - In - * response always set - In create/update request: never set + * A unique identifier within a History for this Execution. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create/update request: never set */ executionId?: string; /** - * Classify the result, for example into SUCCESS or FAILURE - In response: - * present if set by create/update request - In create/update request: - * optional + * Classify the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional */ outcome?: Schema$Outcome; /** - * Lightweight information about execution request. - In response: present - * if set by create - In create: optional - In update: optional + * Lightweight information about execution request. - In response: present if set by create - In create: optional - In update: optional */ specification?: Schema$Specification; /** - * The initial state is IN_PROGRESS. The only legal state transitions is - * from IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if - * an invalid transition is requested. The state can only be set to - * COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set - * to COMPLETE multiple times. If the state is set to COMPLETE, all the - * in-progress steps within the execution will be set as COMPLETE. If the - * outcome of the step is not set, the outcome will be set to INCONCLUSIVE. - * - In response always set - In create/update request: optional + * The initial state is IN_PROGRESS. The only legal state transitions is from IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if an invalid transition is requested. The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times. If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE. - In response always set - In create/update request: optional */ state?: string; /** - * TestExecution Matrix ID that the TestExecutionService uses. - In - * response: present if set by create - In create: optional - In update: - * never set + * TestExecution Matrix ID that the TestExecutionService uses. - In response: present if set by create - In create: optional - In update: never set */ testExecutionMatrixId?: string; } + /** + * Details for an outcome with a FAILURE outcome summary. + */ export interface Schema$FailureDetail { /** * If the failure was severe because the system (app) under test crashed. */ crashed?: boolean; /** - * If an app is not installed and thus no test can be run with the app. This - * might be caused by trying to run a test on an unsupported platform. + * If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform. */ notInstalled?: boolean; /** @@ -431,8 +313,7 @@ export namespace toolresults_v1beta3 { */ timedOut?: boolean; /** - * If the robo was unable to crawl the app; perhaps because the app did not - * start. + * If the robo was unable to crawl the app; perhaps because the app did not start. */ unableToCrawl?: boolean; } @@ -441,25 +322,16 @@ export namespace toolresults_v1beta3 { */ export interface Schema$FileReference { /** - * The URI of a file stored in Google Cloud Storage. For example: - * http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil - * format: gs://mybucket/path/to/test.xml with version-specific info, - * gs://mybucket/path/to/test.xml#1360383693690000 An INVALID_ARGUMENT - * error will be returned if the URI format is not supported. - In - * response: always set - In create/update request: always set + * The URI of a file stored in Google Cloud Storage. For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000 An INVALID_ARGUMENT error will be returned if the URI format is not supported. - In response: always set - In create/update request: always set */ fileUri?: string; } /** - * Graphics statistics for the App. The information is collected from 'adb - * shell dumpsys graphicsstats'. For more info see: - * https://developer.android.com/training/testing/performance.html Statistics - * will only be present for API 23+. + * Graphics statistics for the App. The information is collected from 'adb shell dumpsys graphicsstats'. For more info see: https://developer.android.com/training/testing/performance.html Statistics will only be present for API 23+. */ export interface Schema$GraphicsStats { /** - * Histogram of frame render times. There should be 154 buckets ranging from - * [5ms, 6ms) to [4950ms, infinity) + * Histogram of frame render times. There should be 154 buckets ranging from [5ms, 6ms) to [4950ms, infinity) */ buckets?: Schema$GraphicsStatsBucket[]; /** @@ -518,29 +390,19 @@ export namespace toolresults_v1beta3 { renderMillis?: string; } /** - * A History represents a sorted list of Executions ordered by the - * start_timestamp_millis field (descending). It can be used to group all the - * Executions of a continuous build. Note that the ordering only operates on - * one-dimension. If a repository has multiple branches, it means that - * multiple histories will need to be used in order to order Executions per - * branch. + * A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build. Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch. */ export interface Schema$History { /** - * A short human-readable (plain text) name to display in the UI. Maximum of - * 100 characters. - In response: present if set during create. - In create - * request: optional + * A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional */ displayName?: string; /** - * A unique identifier within a project for this History. Returns - * INVALID_ARGUMENT if this field is set or overwritten by the caller. - In - * response always set - In create request: never set + * A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set */ historyId?: string; /** - * A name to uniquely identify a history within a project. Maximum of 200 - * characters. - In response always set - In create request: always set + * A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set */ name?: string; } @@ -553,8 +415,7 @@ export namespace toolresults_v1beta3 { */ error?: Schema$Status; /** - * A reference to the full-size, original image. This is the same as the - * tool_outputs entry for the image under its Step. Always set. + * A reference to the full-size, original image. This is the same as the tool_outputs entry for the image under its Step. Always set. */ sourceImage?: Schema$ToolOutputReference; /** @@ -566,29 +427,25 @@ export namespace toolresults_v1beta3 { */ thumbnail?: Schema$Thumbnail; } + /** + * Details for an outcome with an INCONCLUSIVE outcome summary. + */ export interface Schema$InconclusiveDetail { /** - * If the end user aborted the test execution before a pass or fail could be - * determined. For example, the user pressed ctrl-c which sent a kill signal - * to the test runner while the test was running. + * If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running. */ abortedByUser?: boolean; /** - * If the test runner could not determine success or failure because the - * test depends on a component other than the system under test which - * failed. For example, a mobile test requires provisioning a device where - * the test executes, and that provisioning can fail. + * If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed. For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail. */ infrastructureFailure?: boolean; } /** - * Step Id and outcome of each individual step that was run as a group with - * other steps with the same configuration. + * Step Id and outcome of each individual step that was run as a group with other steps with the same configuration. */ export interface Schema$IndividualOutcome { /** - * Unique int given to each step. Ranges from 0(inclusive) to total number - * of steps(exclusive). The primary step is 0. + * Unique int given to each step. Ranges from 0(inclusive) to total number of steps(exclusive). The primary step is 0. */ multistepNumber?: number; outcomeSummary?: string; @@ -604,8 +461,7 @@ export namespace toolresults_v1beta3 { */ executions?: Schema$Execution[]; /** - * A continuation token to resume the query at the next item. Will only be - * set if there are more Executions to fetch. + * A continuation token to resume the query at the next item. Will only be set if there are more Executions to fetch. */ nextPageToken?: string; } @@ -618,12 +474,7 @@ export namespace toolresults_v1beta3 { */ histories?: Schema$History[]; /** - * A continuation token to resume the query at the next item. Will only be - * set if there are more histories to fetch. Tokens are valid for up to one - * hour from the time of the first list request. For instance, if you make a - * list request at 1PM and use the token from this first request 10 minutes - * later, the token from this second response will only be valid for 50 - * minutes. + * A continuation token to resume the query at the next item. Will only be set if there are more histories to fetch. Tokens are valid for up to one hour from the time of the first list request. For instance, if you make a list request at 1PM and use the token from this first request 10 minutes later, the token from this second response will only be valid for 50 minutes. */ nextPageToken?: string; } @@ -635,9 +486,7 @@ export namespace toolresults_v1beta3 { } export interface Schema$ListPerfSamplesResponse { /** - * Optional, returned if result size exceeds the page size specified in the - * request (or the default page size, 500, if unspecified). It indicates the - * last sample timestamp to be used as page_token in subsequent request + * Optional, returned if result size exceeds the page size specified in the request (or the default page size, 500, if unspecified). It indicates the last sample timestamp to be used as page_token in subsequent request */ nextPageToken?: string; perfSamples?: Schema$PerfSample[]; @@ -653,9 +502,7 @@ export namespace toolresults_v1beta3 { */ export interface Schema$ListStepsResponse { /** - * A continuation token to resume the query at the next item. If set, - * indicates that there are more steps to read, by calling list again with - * this value in the page_token field. + * A continuation token to resume the query at the next item. If set, indicates that there are more steps to read, by calling list again with this value in the page_token field. */ nextPageToken?: string; /** @@ -668,18 +515,11 @@ export namespace toolresults_v1beta3 { */ export interface Schema$ListStepThumbnailsResponse { /** - * A continuation token to resume the query at the next item. If set, - * indicates that there are more thumbnails to read, by calling list again - * with this value in the page_token field. + * A continuation token to resume the query at the next item. If set, indicates that there are more thumbnails to read, by calling list again with this value in the page_token field. */ nextPageToken?: string; /** - * A list of image data. Images are returned in a deterministic order; they - * are ordered by these factors, in order of importance: * First, by their - * associated test case. Images without a test case are considered greater - * than images with one. * Second, by their creation time. Images without a - * creation time are greater than images with one. * Third, by the order in - * which they were added to the step (by calls to CreateStep or UpdateStep). + * A list of image data. Images are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep). */ thumbnails?: Schema$Image[]; } @@ -708,8 +548,7 @@ export namespace toolresults_v1beta3 { */ export interface Schema$MultiStep { /** - * Unique int given to each step. Ranges from 0(inclusive) to total number - * of steps(exclusive). The primary step is 0. + * Unique int given to each step. Ranges from 0(inclusive) to total number of steps(exclusive). The primary step is 0. */ multistepNumber?: number; /** @@ -726,23 +565,19 @@ export namespace toolresults_v1beta3 { */ export interface Schema$Outcome { /** - * More information about a FAILURE outcome. Returns INVALID_ARGUMENT if - * this field is set but the summary is not FAILURE. Optional + * More information about a FAILURE outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE. Optional */ failureDetail?: Schema$FailureDetail; /** - * More information about an INCONCLUSIVE outcome. Returns INVALID_ARGUMENT - * if this field is set but the summary is not INCONCLUSIVE. Optional + * More information about an INCONCLUSIVE outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE. Optional */ inconclusiveDetail?: Schema$InconclusiveDetail; /** - * More information about a SKIPPED outcome. Returns INVALID_ARGUMENT if - * this field is set but the summary is not SKIPPED. Optional + * More information about a SKIPPED outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED. Optional */ skippedDetail?: Schema$SkippedDetail; /** - * More information about a SUCCESS outcome. Returns INVALID_ARGUMENT if - * this field is set but the summary is not SUCCESS. Optional + * More information about a SUCCESS outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS. Optional */ successDetail?: Schema$SuccessDetail; /** @@ -773,8 +608,7 @@ export namespace toolresults_v1beta3 { */ executionId?: string; /** - * Graphics statistics for the entire run. Statistics are reset at the - * beginning of the run and collected at the end of the run. + * Graphics statistics for the entire run. Statistics are reset at the beginning of the run and collected at the end of the run. */ graphicsStats?: Schema$GraphicsStats; /** @@ -841,8 +675,7 @@ export namespace toolresults_v1beta3 { stepId?: string; } /** - * Stores rollup test status of multiple steps that were run as a group and - * outcome of each individual step. + * Stores rollup test status of multiple steps that were run as a group and outcome of each individual step. */ export interface Schema$PrimaryStep { /** @@ -850,8 +683,7 @@ export namespace toolresults_v1beta3 { */ individualOutcome?: Schema$IndividualOutcome[]; /** - * Rollup test status of multiple steps that were run with the same - * configuration as a group. + * Rollup test status of multiple steps that were run with the same configuration as a group. */ rollUp?: string; } @@ -860,15 +692,11 @@ export namespace toolresults_v1beta3 { */ export interface Schema$ProjectSettings { /** - * The name of the Google Cloud Storage bucket to which results are written. - * By default, this is unset. In update request: optional In response: - * optional + * The name of the Google Cloud Storage bucket to which results are written. By default, this is unset. In update request: optional In response: optional */ defaultBucket?: string; /** - * The name of the project's settings. Always of the form: - * projects/{project-id}/settings In update request: never set In response: - * always set + * The name of the project's settings. Always of the form: projects/{project-id}/settings In update request: never set In response: always set */ name?: string; } @@ -877,8 +705,7 @@ export namespace toolresults_v1beta3 { */ export interface Schema$PublishXunitXmlFilesRequest { /** - * URI of the Xunit XML files to publish. The maximum size of the file this - * reference is pointing to is 50MB. Required. + * URI of the Xunit XML files to publish. The maximum size of the file this reference is pointing to is 50MB. Required. */ xunitXmlFiles?: Schema$FileReference[]; } @@ -910,10 +737,7 @@ export namespace toolresults_v1beta3 { */ clusterId?: string; /** - * A singular screen that represents the cluster as a whole. This screen - * will act as the "cover" of the entire cluster. When users look - * at the clusters, only the key screen from each cluster will be shown. - * Which screen is the key screen is determined by the ClusteringAlgorithm + * A singular screen that represents the cluster as a whole. This screen will act as the "cover" of the entire cluster. When users look at the clusters, only the key screen from each cluster will be shown. Which screen is the key screen is determined by the ClusteringAlgorithm */ keyScreen?: Schema$Screen; /** @@ -921,14 +745,16 @@ export namespace toolresults_v1beta3 { */ screens?: Schema$Screen[]; } + /** + * Details for an outcome with a SKIPPED outcome summary. + */ export interface Schema$SkippedDetail { /** * If the App doesn't support the specific API level. */ incompatibleAppVersion?: boolean; /** - * If the App doesn't run on the specific architecture, for example, - * x86. + * If the App doesn't run on the specific architecture, for example, x86. */ incompatibleArchitecture?: boolean; /** @@ -955,40 +781,7 @@ export namespace toolresults_v1beta3 { exception?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of [google.rpc.Code][], but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside batch - * response, one for each error sub-response. - Asynchronous operations. If - * an API call embeds asynchronous operation results in its response, the - * status of those operations should be represented directly using the - * `Status` message. - Logging. If some API errors are stored in logs, the - * message `Status` could be used directly after any stripping needed for - * security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -996,154 +789,68 @@ export namespace toolresults_v1beta3 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Schema$Any[]; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * [google.rpc.Status.details][] field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][] field, or localized by the client. */ message?: string; } /** - * A Step represents a single operation performed as part of Execution. A step - * can be used to represent the execution of a tool ( for example a test - * runner execution or an execution of a compiler). Steps can overlap (for - * instance two steps might have the same start time if some operations are - * done in parallel). Here is an example, let's consider that we have a - * continuous build is executing a test runner for each iteration. The - * workflow would look like: - user creates a Execution with id 1 - user - * creates an TestExecutionStep with id 100 for Execution 1 - user update - * TestExecutionStep with id 100 to add a raw xml log + the service parses the - * xml logs and returns a TestExecutionStep with updated TestResult(s). - user - * update the status of TestExecutionStep with id 100 to COMPLETE A Step can - * be updated until its state is set to COMPLETE at which points it becomes - * immutable. + * A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. */ export interface Schema$Step { /** - * The time when the step status was set to complete. This value will be - * set automatically when state transitions to COMPLETE. - In response: set - * if the execution state is COMPLETE. - In create/update request: never set + * The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set */ completionTime?: Schema$Timestamp; /** - * The time when the step was created. - In response: always set - In - * create/update request: never set + * The time when the step was created. - In response: always set - In create/update request: never set */ creationTime?: Schema$Timestamp; /** - * A description of this tool For example: mvn clean package -D - * skipTests=true - In response: present if set by create/update request - - * In create/update request: optional + * A description of this tool For example: mvn clean package -D skipTests=true - In response: present if set by create/update request - In create/update request: optional */ description?: string; /** - * How much the device resource is used to perform the test. This is the - * device usage used for billing purpose, which is different from the - * run_duration, for example, infrastructure failure won't be charged - * for device usage. PRECONDITION_FAILED will be returned if one attempts - * to set a device_usage on a step which already has this field set. - In - * response: present if previously set. - In create request: optional - In - * update request: optional + * How much the device resource is used to perform the test. This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage. PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set. - In response: present if previously set. - In create request: optional - In update request: optional */ deviceUsageDuration?: Schema$Duration; /** - * If the execution containing this step has any dimension_definition set, - * then this field allows the child to specify the values of the dimensions. - * The keys must exactly match the dimension_definition of the execution. - * For example, if the execution has `dimension_definition = - * ['attempt', 'device']` then a step must define values for - * those dimensions, eg. `dimension_value = ['attempt': '1', - * 'device': 'Nexus 6']` If a step does not participate in - * one dimension of the matrix, the value for that dimension should be empty - * string. For example, if one of the tests is executed by a runner which - * does not support retries, the step could have `dimension_value = - * ['attempt': '', 'device': 'Nexus 6']` If - * the step does not participate in any dimensions of the matrix, it may - * leave dimension_value unset. A PRECONDITION_FAILED will be returned if - * any of the keys do not exist in the dimension_definition of the - * execution. A PRECONDITION_FAILED will be returned if another step in - * this execution already has the same name and dimension_value, but differs - * on other data fields, for example, step field is different. A - * PRECONDITION_FAILED will be returned if dimension_value is set, and there - * is a dimension_definition in the execution which is not specified as one - * of the keys. - In response: present if set by create - In create - * request: optional - In update request: never set + * If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions. The keys must exactly match the dimension_definition of the execution. For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']` If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']` If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset. A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution. A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different. A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys. - In response: present if set by create - In create request: optional - In update request: never set */ dimensionValue?: Schema$StepDimensionValueEntry[]; /** - * Whether any of the outputs of this step are images whose thumbnails can - * be fetched with ListThumbnails. - In response: always set - In - * create/update request: never set + * Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails. - In response: always set - In create/update request: never set */ hasImages?: boolean; /** - * Arbitrary user-supplied key/value pairs that are associated with the - * step. Users are responsible for managing the key namespace such that - * keys don't accidentally collide. An INVALID_ARGUMENT will be - * returned if the number of labels exceeds 100 or if the length of any of - * the keys or values exceeds 100 characters. - In response: always set - - * In create request: optional - In update request: optional; any new - * key/value pair will be added to the map, and any new value for an - * existing key will update that key's value + * Arbitrary user-supplied key/value pairs that are associated with the step. Users are responsible for managing the key namespace such that keys don't accidentally collide. An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters. - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value */ labels?: Schema$StepLabelsEntry[]; /** - * Details when multiple steps are run with the same configuration as a - * group. These details can be used identify which group this step is part - * of. It also identifies the groups 'primary step' which indexes - * all the group members. - In response: present if previously set. - In - * create request: optional, set iff this step was performed more than once. - * - In update request: optional + * Details when multiple steps are run with the same configuration as a group. These details can be used identify which group this step is part of. It also identifies the groups 'primary step' which indexes all the group members. - In response: present if previously set. - In create request: optional, set iff this step was performed more than once. - In update request: optional */ multiStep?: Schema$MultiStep; /** - * A short human-readable name to display in the UI. Maximum of 100 - * characters. For example: Clean build A PRECONDITION_FAILED will be - * returned upon creating a new step if it shares its name and - * dimension_value with an existing step. If two steps represent a similar - * action, but have different dimension values, they should share the same - * name. For instance, if the same set of tests is run on two different - * platforms, the two steps should have the same name. - In response: - * always set - In create request: always set - In update request: never set + * A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name. - In response: always set - In create request: always set - In update request: never set */ name?: string; /** - * Classification of the result, for example into SUCCESS or FAILURE - In - * response: present if set by create/update request - In create/update - * request: optional + * Classification of the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional */ outcome?: Schema$Outcome; /** - * How long it took for this step to run. If unset, this is set to the - * difference between creation_time and completion_time when the step is set - * to the COMPLETE state. In some cases, it is appropriate to set this value - * separately: For instance, if a step is created, but the operation it - * represents is queued for a few minutes before it executes, it would be - * appropriate not to include the time spent queued in its run_duration. - * PRECONDITION_FAILED will be returned if one attempts to set a - * run_duration on a step which already has this field set. - In response: - * present if previously set; always present on COMPLETE step - In create - * request: optional - In update request: optional + * How long it took for this step to run. If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration. PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set. - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional */ runDuration?: Schema$Duration; /** - * The initial state is IN_PROGRESS. The only legal state transitions are * - * IN_PROGRESS -> COMPLETE A PRECONDITION_FAILED will be returned if an - * invalid transition is requested. It is valid to create Step with a state - * set to COMPLETE. The state can only be set to COMPLETE once. A - * PRECONDITION_FAILED will be returned if the state is set to COMPLETE - * multiple times. - In response: always set - In create/update request: - * optional + * The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE A PRECONDITION_FAILED will be returned if an invalid transition is requested. It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times. - In response: always set - In create/update request: optional */ state?: string; /** - * A unique identifier within a Execution for this Step. Returns - * INVALID_ARGUMENT if this field is set or overwritten by the caller. - In - * response: always set - In create/update request: never set + * A unique identifier within a Execution for this Step. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response: always set - In create/update request: never set */ stepId?: string; /** @@ -1163,6 +870,9 @@ export namespace toolresults_v1beta3 { key?: string; value?: string; } + /** + * Details for an outcome with a SUCCESS outcome summary. + */ export interface Schema$SuccessDetail { /** * If a native process other than the app crashed. @@ -1179,9 +889,7 @@ export namespace toolresults_v1beta3 { */ skippedMessage?: string; /** - * The stack trace details if the test case failed or encountered an error. - * The maximum size of the stack traces is 100KiB, beyond which the stack - * track will be truncated. Zero if the test case passed. + * The stack trace details if the test case failed or encountered an error. The maximum size of the stack traces is 100KiB, beyond which the stack track will be truncated. Zero if the test case passed. */ stackTraces?: Schema$StackTrace[]; /** @@ -1197,7 +905,7 @@ export namespace toolresults_v1beta3 { */ testCaseId?: string; /** - * Test case reference, e.g. name, class name and test suite name. Required. + * Test case reference, e.g. name, class name and test suite name. Required. */ testCaseReference?: Schema$TestCaseReference; /** @@ -1206,9 +914,7 @@ export namespace toolresults_v1beta3 { toolOutputs?: Schema$ToolOutputReference[]; } /** - * A reference to a test case. Test case references are canonically ordered - * lexicographically by these three factors: * First, by test_suite_name. * - * Second, by class_name. * Third, by name. + * A reference to a test case. Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name. */ export interface Schema$TestCaseReference { /** @@ -1225,38 +931,23 @@ export namespace toolresults_v1beta3 { testSuiteName?: string; } /** - * A step that represents running tests. It accepts ant-junit xml files which - * will be parsed into structured test results by the service. Xml file paths - * are updated in order to append more files, however they can't be - * deleted. Users can also add test results manually by using the test_result - * field. + * A step that represents running tests. It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted. Users can also add test results manually by using the test_result field. */ export interface Schema$TestExecutionStep { /** - * Issues observed during the test execution. For example, if the mobile - * app under test crashed during the test, the error message and the stack - * trace content can be recorded here to assist debugging. - In response: - * present if set by create or update - In create/update request: optional + * Issues observed during the test execution. For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging. - In response: present if set by create or update - In create/update request: optional */ testIssues?: Schema$TestIssue[]; /** - * List of test suite overview contents. This could be parsed from xUnit XML - * log by server, or uploaded directly by user. This references should only - * be called when test suites are fully parsed or uploaded. The maximum - * allowed number of test suite overviews per step is 1000. - In response: - * always set - In create request: optional - In update request: never (use - * publishXunitXmlFiles custom method instead) + * List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded. The maximum allowed number of test suite overviews per step is 1000. - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead) */ testSuiteOverviews?: Schema$TestSuiteOverview[]; /** - * The timing break down of the test execution. - In response: present if - * set by create or update - In create/update request: optional + * The timing break down of the test execution. - In response: present if set by create or update - In create/update request: optional */ testTiming?: Schema$TestTiming; /** - * Represents the execution of the test runner. The exit code of this tool - * will be used to determine if the test passed. - In response: always set - * - In create/update request: optional + * Represents the execution of the test runner. The exit code of this tool will be used to determine if the test passed. - In response: always set - In create/update request: optional */ toolExecution?: Schema$ToolExecution; } @@ -1285,50 +976,36 @@ export namespace toolresults_v1beta3 { */ type?: string; /** - * Warning message with additional details of the issue. Should always be a - * message from com.google.devtools.toolresults.v1.warnings + * Warning message with additional details of the issue. Should always be a message from com.google.devtools.toolresults.v1.warnings */ warning?: Schema$Any; } /** - * A summary of a test suite result either parsed from XML or uploaded - * directly by a user. Note: the API related comments are for StepService - * only. This message is also being used in ExecutionService in a read only - * mode for the corresponding step. + * A summary of a test suite result either parsed from XML or uploaded directly by a user. Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step. */ export interface Schema$TestSuiteOverview { /** - * Number of test cases in error, typically set by the service by parsing - * the xml_source. - In create/response: always set - In update request: - * never + * Number of test cases in error, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never */ errorCount?: number; /** - * Number of failed test cases, typically set by the service by parsing the - * xml_source. May also be set by the user. - In create/response: always - * set - In update request: never + * Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user. - In create/response: always set - In update request: never */ failureCount?: number; /** - * The name of the test suite. - In create/response: always set - In update - * request: never + * The name of the test suite. - In create/response: always set - In update request: never */ name?: string; /** - * Number of test cases not run, typically set by the service by parsing the - * xml_source. - In create/response: always set - In update request: never + * Number of test cases not run, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never */ skippedCount?: number; /** - * Number of test cases, typically set by the service by parsing the - * xml_source. - In create/response: always set - In update request: never + * Number of test cases, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never */ totalCount?: number; /** - * If this test suite was parsed from XML, this is the URI where the - * original XML file is stored. Note: Multiple test suites can share the - * same xml_source Returns INVALID_ARGUMENT if the uri format is not - * supported. - In create/response: optional - In update request: never + * If this test suite was parsed from XML, this is the URI where the original XML file is stored. Note: Multiple test suites can share the same xml_source Returns INVALID_ARGUMENT if the uri format is not supported. - In create/response: optional - In update request: never */ xmlSource?: Schema$FileReference; } @@ -1337,8 +1014,7 @@ export namespace toolresults_v1beta3 { */ export interface Schema$TestTiming { /** - * How long it took to run the test process. - In response: present if - * previously set. - In create/update request: optional + * How long it took to run the test process. - In response: present if previously set. - In create/update request: optional */ testProcessDuration?: Schema$Duration; } @@ -1347,14 +1023,11 @@ export namespace toolresults_v1beta3 { */ export interface Schema$Thumbnail { /** - * The thumbnail's content type, i.e. "image/png". Always - * set. + * The thumbnail's content type, i.e. "image/png". Always set. */ contentType?: string; /** - * The thumbnail file itself. That is, the bytes here are precisely the - * bytes that make up the thumbnail file; they can be served as an image - * as-is (with the appropriate content type.) Always set. + * The thumbnail file itself. That is, the bytes here are precisely the bytes that make up the thumbnail file; they can be served as an image as-is (with the appropriate content type.) Always set. */ data?: string; /** @@ -1367,116 +1040,45 @@ export namespace toolresults_v1beta3 { widthPx?: number; } /** - * A Timestamp represents a point in time independent of any time zone or - * local calendar, encoded as a count of seconds and fractions of seconds at - * nanosecond resolution. The count is relative to an epoch at UTC midnight on - * January 1, 1970, in the proleptic Gregorian calendar which extends the - * Gregorian calendar backwards to year one. All minutes are 60 seconds long. - * Leap seconds are "smeared" so that no leap second table is needed - * for interpretation, using a [24-hour linear - * smear](https://developers.google.com/time/smear). The range is from - * 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to - * that range, we ensure that we can convert to and from [RFC - * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples - * Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; - * timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: - * Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; - * gettimeofday(&tv, NULL); Timestamp timestamp; - * timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); - * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - * FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = - * (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows - * tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is - * 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp - * timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - - * 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long - * millis = System.currentTimeMillis(); Timestamp timestamp = - * Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % - * 1000) * 1000000)).build(); Example 5: Compute Timestamp from current - * time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON - * Mapping In JSON format, the Timestamp type is encoded as a string in the - * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the - * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" - * where {year} is always expressed using four digits while {month}, {day}, - * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional - * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), - * are optional. The "Z" suffix indicates the timezone - * ("UTC"); the timezone is required. A proto3 JSON serializer - * should always use UTC (as indicated by "Z") when printing the - * Timestamp type and a proto3 JSON parser should be able to accept both UTC - * and other timezones (as indicated by an offset). For example, - * "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on - * January 15, 2017. In JavaScript, one can convert a Date object to this - * format using the standard - * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) - * method. In Python, a standard `datetime.datetime` object can be converted - * to this format using - * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) - * with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in - * Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( - * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D - * ) to obtain a formatter capable of generating timestamps in this format. + * A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. */ export interface Schema$Timestamp { /** - * Non-negative fractions of a second at nanosecond resolution. Negative - * second values with fractions must still have non-negative nanos values - * that count forward in time. Must be from 0 to 999,999,999 inclusive. + * Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. */ nanos?: number; /** - * Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. - * Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. + * Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. */ seconds?: string; } /** - * An execution of an arbitrary tool. It could be a test runner or a tool - * copying artifacts or deploying code. + * An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code. */ export interface Schema$ToolExecution { /** - * The full tokenized command line including the program name (equivalent to - * argv in a C program). - In response: present if set by create request - - * In create request: optional - In update request: never set + * The full tokenized command line including the program name (equivalent to argv in a C program). - In response: present if set by create request - In create request: optional - In update request: never set */ commandLineArguments?: string[]; /** - * Tool execution exit code. This field will be set once the tool has - * exited. - In response: present if set by create/update request - In - * create request: optional - In update request: optional, a - * FAILED_PRECONDITION error will be returned if an exit_code is already - * set. + * Tool execution exit code. This field will be set once the tool has exited. - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set. */ exitCode?: Schema$ToolExitCode; /** - * References to any plain text logs output the tool execution. This field - * can be set before the tool has exited in order to be able to have access - * to a live view of the logs while the tool is running. The maximum - * allowed number of tool logs per step is 1000. - In response: present if - * set by create/update request - In create request: optional - In update - * request: optional, any value provided will be appended to the existing - * list + * References to any plain text logs output the tool execution. This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running. The maximum allowed number of tool logs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list */ toolLogs?: Schema$FileReference[]; /** - * References to opaque files of any format output by the tool execution. - * The maximum allowed number of tool outputs per step is 1000. - In - * response: present if set by create/update request - In create request: - * optional - In update request: optional, any value provided will be - * appended to the existing list + * References to opaque files of any format output by the tool execution. The maximum allowed number of tool outputs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list */ toolOutputs?: Schema$ToolOutputReference[]; } /** - * Generic tool step to be used for binaries we do not explicitly support. For - * example: running cp to copy artifacts from one location to another. + * Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another. */ export interface Schema$ToolExecutionStep { /** - * A Tool execution. - In response: present if set by create/update request - * - In create/update request: optional + * A Tool execution. - In response: present if set by create/update request - In create/update request: optional */ toolExecution?: Schema$ToolExecution; } @@ -1485,9 +1087,7 @@ export namespace toolresults_v1beta3 { */ export interface Schema$ToolExitCode { /** - * Tool execution exit code. A value of 0 means that the execution was - * successful. - In response: always set - In create/update request: always - * set + * Tool execution exit code. A value of 0 means that the execution was successful. - In response: always set - In create/update request: always set */ number?: number; } @@ -1496,18 +1096,15 @@ export namespace toolresults_v1beta3 { */ export interface Schema$ToolOutputReference { /** - * The creation time of the file. - In response: present if set by - * create/update request - In create/update request: optional + * The creation time of the file. - In response: present if set by create/update request - In create/update request: optional */ creationTime?: Schema$Timestamp; /** - * A FileReference to an output file. - In response: always set - In - * create/update request: always set + * A FileReference to an output file. - In response: always set - In create/update request: always set */ output?: Schema$FileReference; /** - * The test case to which this output file belongs. - In response: present - * if set by create/update request - In create/update request: optional + * The test case to which this output file belongs. - In response: present if set by create/update request - In create/update request: optional */ testCase?: Schema$TestCaseReference; } @@ -1522,9 +1119,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.getSettings - * @desc Gets the Tool Results settings for a project. May return any of - * the following canonical error codes: - PERMISSION_DENIED - if the user - * is not authorized to read from project + * @desc Gets the Tool Results settings for a project. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from project * @alias toolresults.projects.getSettings * @memberOf! () * @@ -1597,26 +1192,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.initializeSettings - * @desc Creates resources for settings which have not yet been set. - * Currently, this creates a single resource: a Google Cloud Storage bucket, - * to be used as the default bucket for this project. The bucket is created - * in an FTL-own storage project. Except for in rare cases, calling this - * method in parallel from multiple clients will only create a single - * bucket. In order to avoid unnecessary storage charges, the bucket is - * configured to automatically delete objects older than 90 days. The - * bucket is created with the following permissions: - Owner access for - * owners of central storage project (FTL-owned) - Writer access for - * owners/editors of customer project - Reader access for viewers of - * customer project The default ACL on objects created in the bucket is: - - * Owner access for owners of central storage project - Reader access for - * owners/editors/viewers of customer project See Google Cloud Storage - * documentation for more details. If there is already a default bucket set - * and the project can access the bucket, this call does nothing. However, - * if the project doesn't have the permission to access the bucket or the - * bucket is deleted, a new bucket will be created. May return any - * canonical error codes, including the following: - PERMISSION_DENIED - if - * the user is not authorized to write to project - Any error code raised by - * Google Cloud Storage + * @desc Creates resources for settings which have not yet been set. Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days. The bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details. If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created. May return any canonical error codes, including the following: - PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage * @alias toolresults.projects.initializeSettings * @memberOf! () * @@ -1728,11 +1304,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.create - * @desc Creates a History. The returned History will have the id set. May - * return any of the following canonical error codes: - PERMISSION_DENIED - - * if the user is not authorized to write to project - INVALID_ARGUMENT - if - * the request is malformed - NOT_FOUND - if the containing project does not - * exist + * @desc Creates a History. The returned History will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist * @alias toolresults.projects.histories.create * @memberOf! () * @@ -1805,10 +1377,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.get - * @desc Gets a History. May return any of the following canonical error - * codes: - PERMISSION_DENIED - if the user is not authorized to read - * project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if - * the History does not exist + * @desc Gets a History. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist * @alias toolresults.projects.histories.get * @memberOf! () * @@ -1881,12 +1450,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.list - * @desc Lists Histories for a given Project. The histories are sorted by - * modification time in descending order. The history_id key will be used to - * order the history with the same modification time. May return any of the - * following canonical error codes: - PERMISSION_DENIED - if the user is - * not authorized to read project - INVALID_ARGUMENT - if the request is - * malformed - NOT_FOUND - if the History does not exist + * @desc Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist * @alias toolresults.projects.histories.list * @memberOf! () * @@ -1975,8 +1539,7 @@ export namespace toolresults_v1beta3 { */ projectId?: string; /** - * A unique request ID for server to detect duplicated requests. For - * example, a UUID. Optional, but strongly recommended. + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. */ requestId?: string; @@ -2013,9 +1576,7 @@ export namespace toolresults_v1beta3 { */ filterByName?: string; /** - * The maximum number of Histories to fetch. Default value: 20. The server - * will use this default if the field is not set or has a value of 0. Any - * value greater than 100 will be treated as 100. Optional. + * The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional. */ pageSize?: number; /** @@ -2044,11 +1605,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.create - * @desc Creates an Execution. The returned Execution will have the id set. - * May return any of the following canonical error codes: - - * PERMISSION_DENIED - if the user is not authorized to write to project - - * INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the - * containing History does not exist + * @desc Creates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist * @alias toolresults.projects.histories.executions.create * @memberOf! () * @@ -2125,10 +1682,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.get - * @desc Gets an Execution. May return any of the following canonical error - * codes: - PERMISSION_DENIED - if the user is not authorized to write to - * project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if - * the Execution does not exist + * @desc Gets an Execution. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist * @alias toolresults.projects.histories.executions.get * @memberOf! () * @@ -2204,12 +1758,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.list - * @desc Lists Executions for a given History. The executions are sorted by - * creation_time in descending order. The execution_id key will be used to - * order the executions with the same creation_time. May return any of the - * following canonical error codes: - PERMISSION_DENIED - if the user is - * not authorized to read project - INVALID_ARGUMENT - if the request is - * malformed - NOT_FOUND - if the containing History does not exist + * @desc Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist * @alias toolresults.projects.histories.executions.list * @memberOf! () * @@ -2288,12 +1837,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.patch - * @desc Updates an existing Execution with the supplied partial entity. May - * return any of the following canonical error codes: - PERMISSION_DENIED - - * if the user is not authorized to write to project - INVALID_ARGUMENT - if - * the request is malformed - FAILED_PRECONDITION - if the requested state - * transition is illegal - NOT_FOUND - if the containing History does not - * exist + * @desc Updates an existing Execution with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist * @alias toolresults.projects.histories.executions.patch * @memberOf! () * @@ -2386,8 +1930,7 @@ export namespace toolresults_v1beta3 { */ projectId?: string; /** - * A unique request ID for server to detect duplicated requests. For - * example, a UUID. Optional, but strongly recommended. + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. */ requestId?: string; @@ -2428,9 +1971,7 @@ export namespace toolresults_v1beta3 { */ historyId?: string; /** - * The maximum number of Executions to fetch. Default value: 25. The server - * will use this default if the field is not set or has a value of 0. - * Optional. + * The maximum number of Executions to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional. */ pageSize?: number; /** @@ -2462,8 +2003,7 @@ export namespace toolresults_v1beta3 { */ projectId?: string; /** - * A unique request ID for server to detect duplicated requests. For - * example, a UUID. Optional, but strongly recommended. + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. */ requestId?: string; @@ -2558,13 +2098,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.clusters.list - * @desc Lists Screenshot Clusters Returns the list of screenshot clusters - * corresponding to an execution. Screenshot clusters are created after the - * execution is finished. Clusters are created from a set of screenshots. - * Between any two screenshots, a matching score is calculated based off - * their metadata that determines how similar they are. Screenshots are - * placed in the cluster that has screens which have the highest matching - * scores. + * @desc Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores. * @alias toolresults.projects.histories.executions.clusters.list * @memberOf! () * @@ -2717,12 +2251,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.create - * @desc Creates a Step. The returned Step will have the id set. May - * return any of the following canonical error codes: - PERMISSION_DENIED - - * if the user is not authorized to write to project - INVALID_ARGUMENT - if - * the request is malformed - FAILED_PRECONDITION - if the step is too large - * (more than 10Mib) - NOT_FOUND - if the containing Execution does not - * exist + * @desc Creates a Step. The returned Step will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist * @alias toolresults.projects.histories.executions.steps.create * @memberOf! () * @@ -2798,10 +2327,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.get - * @desc Gets a Step. May return any of the following canonical error - * codes: - PERMISSION_DENIED - if the user is not authorized to read - * project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if - * the Step does not exist + * @desc Gets a Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist * @alias toolresults.projects.histories.executions.steps.get * @memberOf! () * @@ -2876,11 +2402,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.getPerfMetricsSummary - * @desc Retrieves a PerfMetricsSummary. May return any of the following - * error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not - * exist - * @alias - * toolresults.projects.histories.executions.steps.getPerfMetricsSummary + * @desc Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist + * @alias toolresults.projects.histories.executions.steps.getPerfMetricsSummary * @memberOf! () * * @param {object} params Parameters for request @@ -2958,14 +2481,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.list - * @desc Lists Steps for a given Execution. The steps are sorted by - * creation_time in descending order. The step_id key will be used to order - * the steps with the same creation_time. May return any of the following - * canonical error codes: - PERMISSION_DENIED - if the user is not - * authorized to read project - INVALID_ARGUMENT - if the request is - * malformed - FAILED_PRECONDITION - if an argument in the request happens - * to be invalid; e.g. if an attempt is made to list the children of a - * nonexistent Step - NOT_FOUND - if the containing Execution does not exist + * @desc Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist * @alias toolresults.projects.histories.executions.steps.list * @memberOf! () * @@ -3043,13 +2559,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.patch - * @desc Updates an existing Step with the supplied partial entity. May - * return any of the following canonical error codes: - PERMISSION_DENIED - - * if the user is not authorized to write project - INVALID_ARGUMENT - if - * the request is malformed - FAILED_PRECONDITION - if the requested state - * transition is illegal (e.g try to upload a duplicate xml file), if the - * updated step is too large (more than 10Mib) - NOT_FOUND - if the - * containing Execution does not exist + * @desc Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist * @alias toolresults.projects.histories.executions.steps.patch * @memberOf! () * @@ -3126,14 +2636,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.publishXunitXmlFiles - * @desc Publish xml files to an existing Step. May return any of the - * following canonical error codes: - PERMISSION_DENIED - if the user is - * not authorized to write project - INVALID_ARGUMENT - if the request is - * malformed - FAILED_PRECONDITION - if the requested state transition is - * illegal, e.g try to upload a duplicate xml file or a file too large. - - * NOT_FOUND - if the containing Execution does not exist - * @alias - * toolresults.projects.histories.executions.steps.publishXunitXmlFiles + * @desc Publish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist + * @alias toolresults.projects.histories.executions.steps.publishXunitXmlFiles * @memberOf! () * * @param {object} params Parameters for request @@ -3227,8 +2731,7 @@ export namespace toolresults_v1beta3 { */ projectId?: string; /** - * A unique request ID for server to detect duplicated requests. For - * example, a UUID. Optional, but strongly recommended. + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. */ requestId?: string; @@ -3301,8 +2804,7 @@ export namespace toolresults_v1beta3 { */ historyId?: string; /** - * The maximum number of Steps to fetch. Default value: 25. The server will - * use this default if the field is not set or has a value of 0. Optional. + * The maximum number of Steps to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional. */ pageSize?: number; /** @@ -3334,8 +2836,7 @@ export namespace toolresults_v1beta3 { */ projectId?: string; /** - * A unique request ID for server to detect duplicated requests. For - * example, a UUID. Optional, but strongly recommended. + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. */ requestId?: string; /** @@ -3386,11 +2887,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.perfMetricsSummary.create - * @desc Creates a PerfMetricsSummary resource. Returns the existing one if - * it has already been created. May return any of the following error - * code(s): - NOT_FOUND - The containing Step does not exist - * @alias - * toolresults.projects.histories.executions.steps.perfMetricsSummary.create + * @desc Creates a PerfMetricsSummary resource. Returns the existing one if it has already been created. May return any of the following error code(s): - NOT_FOUND - The containing Step does not exist + * @alias toolresults.projects.histories.executions.steps.perfMetricsSummary.create * @memberOf! () * * @param {object} params Parameters for request @@ -3508,11 +3006,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.perfSampleSeries.create - * @desc Creates a PerfSampleSeries. May return any of the following error - * code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the - * given Step - NOT_FOUND - The containing Step does not exist - * @alias - * toolresults.projects.histories.executions.steps.perfSampleSeries.create + * @desc Creates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist + * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.create * @memberOf! () * * @param {object} params Parameters for request @@ -3589,10 +3084,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.perfSampleSeries.get - * @desc Gets a PerfSampleSeries. May return any of the following error - * code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist - * @alias - * toolresults.projects.histories.executions.steps.perfSampleSeries.get + * @desc Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist + * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.get * @memberOf! () * * @param {object} params Parameters for request @@ -3681,13 +3174,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.perfSampleSeries.list - * @desc Lists PerfSampleSeries for a given Step. The request provides an - * optional filter which specifies one or more PerfMetricsType to include in - * the result; if none returns all. The resulting PerfSampleSeries are - * sorted by ids. May return any of the following canonical error codes: - - * NOT_FOUND - The containing Step does not exist - * @alias - * toolresults.projects.histories.executions.steps.perfSampleSeries.list + * @desc Lists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist + * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.list * @memberOf! () * * @param {object} params Parameters for request @@ -3841,8 +3329,7 @@ export namespace toolresults_v1beta3 { */ executionId?: string; /** - * Specify one or more PerfMetricType values such as CPU to filter the - * result + * Specify one or more PerfMetricType values such as CPU to filter the result */ filter?: string[]; /** @@ -3867,16 +3354,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate - * @desc Creates a batch of PerfSamples - a client can submit multiple - * batches of Perf Samples through repeated calls to this method in order to - * split up a large request payload - duplicates and existing timestamp - * entries will be ignored. - the batch operation may partially succeed - - * the set of elements successfully inserted is returned in the response - * (omits items which already existed in the database). May return any of - * the following canonical error codes: - NOT_FOUND - The containing - * PerfSampleSeries does not exist - * @alias - * toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate + * @desc Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist + * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate * @memberOf! () * * @param {object} params Parameters for request @@ -3975,17 +3454,8 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list - * @desc Lists the Performance Samples of a given Sample Series - The list - * results are sorted by timestamps ascending - The default page size is 500 - * samples; and maximum size allowed 5000 - The response token indicates the - * last returned PerfSample timestamp - When the results size exceeds the - * page size, submit a subsequent request including the page token to return - * the rest of the samples up to the page limit May return any of the - * following canonical error codes: - OUT_OF_RANGE - The specified request - * page_token is out of valid range - NOT_FOUND - The containing - * PerfSampleSeries does not exist - * @alias - * toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list + * @desc Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist + * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list * @memberOf! () * * @param {object} params Parameters for request @@ -4126,8 +3596,7 @@ export namespace toolresults_v1beta3 { */ historyId?: string; /** - * The default page size is 500 samples, and the maximum size is 5000. If - * the page_size is greater than 5000, the effective page size will be 5000 + * The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000 */ pageSize?: number; /** @@ -4156,11 +3625,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.testCases.get - * @desc Gets details of a Test Case for a Step. Experimental test cases - * API. Still in active development. May return any of the following - * canonical error codes: - PERMISSION_DENIED - if the user is not - * authorized to write to project - INVALID_ARGUMENT - if the request is - * malformed - NOT_FOUND - if the containing Test Case does not exist + * @desc Gets details of a Test Case for a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Test Case does not exist * @alias toolresults.projects.histories.executions.steps.testCases.get * @memberOf! () * @@ -4248,11 +3713,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.testCases.list - * @desc Lists Test Cases attached to a Step. Experimental test cases API. - * Still in active development. May return any of the following canonical - * error codes: - PERMISSION_DENIED - if the user is not authorized to - * write to project - INVALID_ARGUMENT - if the request is malformed - - * NOT_FOUND - if the containing Step does not exist + * @desc Lists Test Cases attached to a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Step does not exist * @alias toolresults.projects.histories.executions.steps.testCases.list * @memberOf! () * @@ -4376,9 +3837,7 @@ export namespace toolresults_v1beta3 { */ historyId?: string; /** - * The maximum number of TestCases to fetch. Default value: 100. The server - * will use this default if the field is not set or has a value of 0. - * Optional. + * The maximum number of TestCases to fetch. Default value: 100. The server will use this default if the field is not set or has a value of 0. Optional. */ pageSize?: number; /** @@ -4403,11 +3862,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.steps.thumbnails.list - * @desc Lists thumbnails of images attached to a step. May return any of - * the following canonical error codes: - PERMISSION_DENIED - if the user is - * not authorized to read from the project, or from any of the images - - * INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step - * does not exist, or if any of the images do not exist + * @desc Lists thumbnails of images attached to a step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist * @alias toolresults.projects.histories.executions.steps.thumbnails.list * @memberOf! () * @@ -4508,9 +3963,7 @@ export namespace toolresults_v1beta3 { */ historyId?: string; /** - * The maximum number of thumbnails to fetch. Default value: 50. The server - * will use this default if the field is not set or has a value of 0. - * Optional. + * The maximum number of thumbnails to fetch. Default value: 50. The server will use this default if the field is not set or has a value of 0. Optional. */ pageSize?: number; /** diff --git a/src/apis/tpu/package.json b/src/apis/tpu/package.json index ca020621570..e6d7b87d849 100644 --- a/src/apis/tpu/package.json +++ b/src/apis/tpu/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index 149ab484d32..aa149f1905b 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace tpu_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace tpu_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace tpu_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -132,11 +131,7 @@ export namespace tpu_v1 { type?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -213,13 +208,11 @@ export namespace tpu_v1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -227,13 +220,11 @@ export namespace tpu_v1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -259,14 +250,7 @@ export namespace tpu_v1 { */ acceleratorType?: string; /** - * The CIDR block that the TPU node will use when selecting an IP address. - * This CIDR block must be a /29 block; the Compute Engine networks API - * forbids a smaller block, and using a larger block would be wasteful (a - * node can only consume one IP address). Errors will occur if the CIDR - * block has already been used for a currently existing TPU node, the CIDR - * block conflicts with any subnetworks in the user's provided network, - * or the provided network is peered with another network that is using that - * CIDR block. Required. + * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Required. */ cidrBlock?: string; /** @@ -282,13 +266,11 @@ export namespace tpu_v1 { */ health?: string; /** - * Output only. If this field is populated, it contains a description of why - * the TPU Node is unhealthy. + * Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. */ healthDescription?: string; /** - * Output only. DEPRECATED! Use network_endpoints instead. The network - * address for the TPU Node as visible to Compute Engine instances. + * Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. */ ipAddress?: string; /** @@ -300,29 +282,20 @@ export namespace tpu_v1 { */ name?: string; /** - * The name of a network they wish to peer the TPU node to. It must be a - * preexisting Compute Engine network inside of the project on which this - * API has been activated. If none is provided, "default" will be - * used. + * The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. */ network?: string; /** - * Output only. The network endpoints where TPU workers can be accessed and - * sent work. It is recommended that Tensorflow clients of the node reach - * out to the 0th entry in this map first. + * Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first. */ networkEndpoints?: Schema$NetworkEndpoint[]; /** - * Output only. DEPRECATED! Use network_endpoints instead. The network port - * for the TPU Node as visible to Compute Engine instances. + * Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. */ port?: string; schedulingConfig?: Schema$SchedulingConfig; /** - * Output only. The service account used to run the tensor flow services - * within the node. To share resources, including Google Cloud Storage data, - * with the Tensorflow job running in the Node, this account must have - * permissions to that data. + * Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data. */ serviceAccount?: string; /** @@ -335,14 +308,11 @@ export namespace tpu_v1 { tensorflowVersion?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -350,26 +320,15 @@ export namespace tpu_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -382,10 +341,7 @@ export namespace tpu_v1 { */ apiVersion?: string; /** - * [Output only] Identifies whether the user has requested cancellation of - * the operation. Operations that have successfully been cancelled have - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ cancelRequested?: boolean; /** @@ -401,8 +357,7 @@ export namespace tpu_v1 { */ statusDetail?: string; /** - * [Output only] Server-defined resource path for the target of the - * operation. + * [Output only] Server-defined resource path for the target of the operation. */ target?: string; /** @@ -421,46 +376,17 @@ export namespace tpu_v1 { } export interface Schema$SchedulingConfig { preemptible?: boolean; + /** + * Whether the node is created under a reservation. + */ + reserved?: boolean; } /** * Request for StartNode. */ export interface Schema$StartNodeRequest {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -468,14 +394,11 @@ export namespace tpu_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1561,15 +1484,7 @@ export namespace tpu_v1 { /** * tpu.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias tpu.projects.locations.operations.cancel * @memberOf! () * @@ -1638,10 +1553,7 @@ export namespace tpu_v1 { /** * tpu.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias tpu.projects.locations.operations.delete * @memberOf! () * @@ -1710,9 +1622,7 @@ export namespace tpu_v1 { /** * tpu.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias tpu.projects.locations.operations.get * @memberOf! () * @@ -1783,15 +1693,7 @@ export namespace tpu_v1 { /** * tpu.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias tpu.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index 2b4b577ee8a..bc9b4df866f 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace tpu_v1alpha1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace tpu_v1alpha1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace tpu_v1alpha1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -132,11 +131,7 @@ export namespace tpu_v1alpha1 { type?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -213,13 +208,11 @@ export namespace tpu_v1alpha1 { */ export interface Schema$Location { /** - * The friendly name for this location, typically a nearby city name. For - * example, "Tokyo". + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */ labels?: {[key: string]: string}; /** @@ -227,13 +220,11 @@ export namespace tpu_v1alpha1 { */ locationId?: string; /** - * Service-specific metadata. For example the available capacity at the - * given location. + * Service-specific metadata. For example the available capacity at the given location. */ metadata?: {[key: string]: any}; /** - * Resource name for the location, which may vary between implementations. - * For example: `"projects/example-project/locations/us-east1"` + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */ name?: string; } @@ -259,14 +250,7 @@ export namespace tpu_v1alpha1 { */ acceleratorType?: string; /** - * The CIDR block that the TPU node will use when selecting an IP address. - * This CIDR block must be a /29 block; the Compute Engine networks API - * forbids a smaller block, and using a larger block would be wasteful (a - * node can only consume one IP address). Errors will occur if the CIDR - * block has already been used for a currently existing TPU node, the CIDR - * block conflicts with any subnetworks in the user's provided network, - * or the provided network is peered with another network that is using that - * CIDR block. Required. + * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Required. */ cidrBlock?: string; /** @@ -282,13 +266,11 @@ export namespace tpu_v1alpha1 { */ health?: string; /** - * Output only. If this field is populated, it contains a description of why - * the TPU Node is unhealthy. + * Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. */ healthDescription?: string; /** - * Output only. DEPRECATED! Use network_endpoints instead. The network - * address for the TPU Node as visible to Compute Engine instances. + * Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. */ ipAddress?: string; /** @@ -300,29 +282,20 @@ export namespace tpu_v1alpha1 { */ name?: string; /** - * The name of a network they wish to peer the TPU node to. It must be a - * preexisting Compute Engine network inside of the project on which this - * API has been activated. If none is provided, "default" will be - * used. + * The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. */ network?: string; /** - * Output only. The network endpoints where TPU workers can be accessed and - * sent work. It is recommended that Tensorflow clients of the node reach - * out to the 0th entry in this map first. + * Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first. */ networkEndpoints?: Schema$NetworkEndpoint[]; /** - * Output only. DEPRECATED! Use network_endpoints instead. The network port - * for the TPU Node as visible to Compute Engine instances. + * Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. */ port?: string; schedulingConfig?: Schema$SchedulingConfig; /** - * Output only. The service account used to run the tensor flow services - * within the node. To share resources, including Google Cloud Storage data, - * with the Tensorflow job running in the Node, this account must have - * permissions to that data. + * Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data. */ serviceAccount?: string; /** @@ -335,14 +308,11 @@ export namespace tpu_v1alpha1 { tensorflowVersion?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -350,26 +320,15 @@ export namespace tpu_v1alpha1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -382,10 +341,7 @@ export namespace tpu_v1alpha1 { */ apiVersion?: string; /** - * [Output only] Identifies whether the user has requested cancellation of - * the operation. Operations that have successfully been cancelled have - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * [Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ cancelRequested?: boolean; /** @@ -401,8 +357,7 @@ export namespace tpu_v1alpha1 { */ statusDetail?: string; /** - * [Output only] Server-defined resource path for the target of the - * operation. + * [Output only] Server-defined resource path for the target of the operation. */ target?: string; /** @@ -421,46 +376,17 @@ export namespace tpu_v1alpha1 { } export interface Schema$SchedulingConfig { preemptible?: boolean; + /** + * Whether the node is created under a reservation. + */ + reserved?: boolean; } /** * Request for StartNode. */ export interface Schema$StartNodeRequest {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -468,14 +394,11 @@ export namespace tpu_v1alpha1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -1567,15 +1490,7 @@ export namespace tpu_v1alpha1 { /** * tpu.projects.locations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias tpu.projects.locations.operations.cancel * @memberOf! () * @@ -1647,10 +1562,7 @@ export namespace tpu_v1alpha1 { /** * tpu.projects.locations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias tpu.projects.locations.operations.delete * @memberOf! () * @@ -1719,9 +1631,7 @@ export namespace tpu_v1alpha1 { /** * tpu.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias tpu.projects.locations.operations.get * @memberOf! () * @@ -1792,15 +1702,7 @@ export namespace tpu_v1alpha1 { /** * tpu.projects.locations.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias tpu.projects.locations.operations.list * @memberOf! () * diff --git a/src/apis/translate/package.json b/src/apis/translate/package.json index af96acd2725..d8cbd9fbbf1 100644 --- a/src/apis/translate/package.json +++ b/src/apis/translate/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/translate/v2.ts b/src/apis/translate/v2.ts index 6dc623277ba..c2cd64a9776 100644 --- a/src/apis/translate/v2.ts +++ b/src/apis/translate/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -67,9 +67,7 @@ export namespace translate_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -85,9 +83,7 @@ export namespace translate_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. Overrides userIp if both are provided. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. */ quotaUser?: string; /** @@ -103,8 +99,7 @@ export namespace translate_v2 { /** * Google Cloud Translation API * - * The Google Cloud Translation API lets websites and programs integrate with - * Google Translate programmatically. + * The Google Cloud Translation API lets websites and programs integrate with Google Translate programmatically. * * @example * const {google} = require('googleapis'); @@ -123,7 +118,10 @@ export namespace translate_v2 { translations: Resource$Translations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.detections = new Resource$Detections(this.context); this.languages = new Resource$Languages(this.context); @@ -138,8 +136,7 @@ export namespace translate_v2 { detections?: Schema$DetectionsResource[]; } /** - * An array of languages which we detect for the given text The most likely - * language list first. + * An array of languages which we detect for the given text The most likely language list first. */ export interface Schema$DetectionsResource {} /** @@ -147,8 +144,7 @@ export namespace translate_v2 { */ export interface Schema$DetectLanguageRequest { /** - * The input text upon which to perform language detection. Repeat this - * parameter to perform language detection on multiple text inputs. + * The input text upon which to perform language detection. Repeat this parameter to perform language detection on multiple text inputs. */ q?: string[]; } @@ -157,27 +153,19 @@ export namespace translate_v2 { */ export interface Schema$GetSupportedLanguagesRequest { /** - * The language to use to return localized, human readable names of - * supported languages. + * The language to use to return localized, human readable names of supported languages. */ target?: string; } export interface Schema$LanguagesListResponse { /** - * List of source/target languages supported by the translation API. If - * target parameter is unspecified, the list is sorted by the ASCII code - * point order of the language code. If target parameter is specified, the - * list is sorted by the collation order of the language name in the target - * language. + * List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language. */ languages?: Schema$LanguagesResource[]; } export interface Schema$LanguagesResource { /** - * Supported language code, generally consisting of its ISO 639-1 - * identifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 - * codes including language + region identifiers are returned (e.g. - * 'zh-TW' and 'zh-CH') + * Supported language code, generally consisting of its ISO 639-1 identifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes including language + region identifiers are returned (e.g. 'zh-TW' and 'zh-CH') */ language?: string; /** @@ -190,31 +178,23 @@ export namespace translate_v2 { */ export interface Schema$TranslateTextRequest { /** - * The format of the source text, in either HTML (default) or plain-text. A - * value of "html" indicates HTML and a value of "text" - * indicates plain-text. + * The format of the source text, in either HTML (default) or plain-text. A value of "html" indicates HTML and a value of "text" indicates plain-text. */ format?: string; /** - * The `model` type requested for this translation. Valid values are listed - * in public documentation. + * The `model` type requested for this translation. Valid values are listed in public documentation. */ model?: string; /** - * The input text to translate. Repeat this parameter to perform translation - * operations on multiple text inputs. + * The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs. */ q?: string[]; /** - * The language of the source text, set to one of the language codes listed - * in Language Support. If the source language is not specified, the API - * will attempt to identify the source language automatically and return it - * within the response. + * The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to identify the source language automatically and return it within the response. */ source?: string; /** - * The language to use for translation of the input text, set to one of the - * language codes listed in Language Support. + * The language to use for translation of the input text, set to one of the language codes listed in Language Support. */ target?: string; } @@ -229,16 +209,11 @@ export namespace translate_v2 { } export interface Schema$TranslationsResource { /** - * The source language of the initial request, detected automatically, if no - * source language was passed within the initial request. If the source - * language was passed, auto-detection of the language will not occur and - * this field will be empty. + * The source language of the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language will not occur and this field will be empty. */ detectedSourceLanguage?: string; /** - * The `model` type used for this translation. Valid values are listed in - * public documentation. Can be different from requested `model`. Present - * only if specific model type was explicitly requested. + * The `model` type used for this translation. Valid values are listed in public documentation. Can be different from requested `model`. Present only if specific model type was explicitly requested. */ model?: string; /** @@ -424,8 +399,7 @@ export namespace translate_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The input text upon which to perform language detection. Repeat this - * parameter to perform language detection on multiple text inputs. + * The input text upon which to perform language detection. Repeat this parameter to perform language detection on multiple text inputs. */ q?: string[]; } @@ -524,8 +498,7 @@ export namespace translate_v2 { */ model?: string; /** - * The language to use to return localized, human readable names of - * supported languages. + * The language to use to return localized, human readable names of supported languages. */ target?: string; } @@ -708,31 +681,23 @@ export namespace translate_v2 { */ cid?: string[]; /** - * The format of the source text, in either HTML (default) or plain-text. A - * value of "html" indicates HTML and a value of "text" indicates - * plain-text. + * The format of the source text, in either HTML (default) or plain-text. A value of "html" indicates HTML and a value of "text" indicates plain-text. */ format?: string; /** - * The `model` type requested for this translation. Valid values are listed - * in public documentation. + * The `model` type requested for this translation. Valid values are listed in public documentation. */ model?: string; /** - * The input text to translate. Repeat this parameter to perform translation - * operations on multiple text inputs. + * The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs. */ q?: string[]; /** - * The language of the source text, set to one of the language codes listed - * in Language Support. If the source language is not specified, the API - * will attempt to identify the source language automatically and return it - * within the response. + * The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to identify the source language automatically and return it within the response. */ source?: string; /** - * The language to use for translation of the input text, set to one of the - * language codes listed in Language Support. + * The language to use for translation of the input text, set to one of the language codes listed in Language Support. */ target?: string; } diff --git a/src/apis/urlshortener/package.json b/src/apis/urlshortener/package.json index 213f6e65f72..746f73ce004 100644 --- a/src/apis/urlshortener/package.json +++ b/src/apis/urlshortener/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/urlshortener/v1.ts b/src/apis/urlshortener/v1.ts index 803997f33a1..02cde3874cf 100644 --- a/src/apis/urlshortener/v1.ts +++ b/src/apis/urlshortener/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace urlshortener_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace urlshortener_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,7 +92,10 @@ export namespace urlshortener_v1 { url: Resource$Url; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.url = new Resource$Url(this.context); } @@ -103,14 +103,11 @@ export namespace urlshortener_v1 { export interface Schema$AnalyticsSnapshot { /** - * Top browsers, e.g. "Chrome"; sorted by (descending) click - * counts. Only present if this data is available. + * Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available. */ browsers?: Schema$StringCount[]; /** - * Top countries (expressed as country codes), e.g. "US" or - * "DE"; sorted by (descending) click counts. Only present if this - * data is available. + * Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available. */ countries?: Schema$StringCount[]; /** @@ -118,13 +115,11 @@ export namespace urlshortener_v1 { */ longUrlClicks?: string; /** - * Top platforms or OSes, e.g. "Windows"; sorted by (descending) - * click counts. Only present if this data is available. + * Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available. */ platforms?: Schema$StringCount[]; /** - * Top referring hosts, e.g. "www.google.com"; sorted by - * (descending) click counts. Only present if this data is available. + * Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available. */ referrers?: Schema$StringCount[]; /** @@ -156,26 +151,21 @@ export namespace urlshortener_v1 { } export interface Schema$StringCount { /** - * Number of clicks for this top entry, e.g. for this particular country or - * browser. + * Number of clicks for this top entry, e.g. for this particular country or browser. */ count?: string; /** - * Label assigned to this top entry, e.g. "US" or - * "Chrome". + * Label assigned to this top entry, e.g. "US" or "Chrome". */ id?: string; } export interface Schema$Url { /** - * A summary of the click analytics for the short and long URL. Might not be - * present if not requested or currently unavailable. + * A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable. */ analytics?: Schema$AnalyticsSummary; /** - * Time the short URL was created; ISO 8601 representation using the - * yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. - * "2010-10-14T19:01:24.944+00:00". + * Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00". */ created?: string; /** @@ -187,15 +177,11 @@ export namespace urlshortener_v1 { */ kind?: string; /** - * Long URL, e.g. "http://www.google.com/". Might not be present - * if the status is "REMOVED". + * Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED". */ longUrl?: string; /** - * Status of the target URL. Possible values: "OK", - * "MALWARE", "PHISHING", or "REMOVED". A URL - * might be marked "REMOVED" if it was flagged as spam, for - * example. + * Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example. */ status?: string; } @@ -205,9 +191,7 @@ export namespace urlshortener_v1 { */ items?: Schema$Url[]; /** - * Number of items returned with each full "page" of results. Note - * that the last page could have fewer items than the - * "itemsPerPage" value. + * Number of items returned with each full "page" of results. Note that the last page could have fewer items than the "itemsPerPage" value. */ itemsPerPage?: number; /** @@ -219,8 +203,7 @@ export namespace urlshortener_v1 { */ nextPageToken?: string; /** - * Total number of short URLs associated with this user (may be - * approximate). + * Total number of short URLs associated with this user (may be approximate). */ totalItems?: number; } diff --git a/src/apis/vault/package.json b/src/apis/vault/package.json index 23c331d5f7c..6948ea5a9bb 100644 --- a/src/apis/vault/package.json +++ b/src/apis/vault/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 91509aaaf76..f87b7708756 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace vault_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace vault_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace vault_v1 { matters: Resource$Matters; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.matters = new Resource$Matters(this.context); } @@ -128,8 +127,7 @@ export namespace vault_v1 { emails?: string[]; } /** - * A status detailing the status of each account creation, and the - * HeldAccount, if successful. + * A status detailing the status of each account creation, and the HeldAccount, if successful. */ export interface Schema$AddHeldAccountResult { /** @@ -146,13 +144,11 @@ export namespace vault_v1 { */ export interface Schema$AddHeldAccountsRequest { /** - * Account ids to identify which accounts to add. Only account_ids or only - * emails should be specified, but not both. + * Account ids to identify which accounts to add. Only account_ids or only emails should be specified, but not both. */ accountIds?: string[]; /** - * Emails to identify which accounts to add. Only emails or only account_ids - * should be specified, but not both. + * Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both. */ emails?: string[]; } @@ -166,13 +162,11 @@ export namespace vault_v1 { responses?: Schema$AddHeldAccountResult[]; } /** - * Add an account with the permission specified. The role cannot be owner. If - * an account already has a role in the matter, it will be overwritten. + * Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten. */ export interface Schema$AddMatterPermissionsRequest { /** - * Only relevant if send_emails is true. True to CC requestor in the email - * message. False to not CC requestor. + * Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor. */ ccMe?: boolean; /** @@ -180,8 +174,7 @@ export namespace vault_v1 { */ matterPermission?: Schema$MatterPermission; /** - * True to send notification email to the added account. False to not send - * notification email. + * True to send notification email to the added account. False to not send notification email. */ sendEmails?: boolean; } @@ -203,8 +196,7 @@ export namespace vault_v1 { */ export interface Schema$CloudStorageFile { /** - * The cloud storage bucket name of this export file. Can be used in cloud - * storage JSON/XML API. + * The cloud storage bucket name of this export file. Can be used in cloud storage JSON/XML API. */ bucketName?: string; /** @@ -212,8 +204,7 @@ export namespace vault_v1 { */ md5Hash?: string; /** - * The cloud storage object name of this export file. Can be used in cloud - * storage JSON/XML API. + * The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API. */ objectName?: string; /** @@ -243,8 +234,7 @@ export namespace vault_v1 { */ groupsQuery?: Schema$HeldGroupsQuery; /** - * Details pertaining to Hangouts Chat holds. If set, corpus must be - * Hangouts Chat. + * Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat. */ hangoutsChatQuery?: Schema$HeldHangoutsChatQuery; /** @@ -257,9 +247,7 @@ export namespace vault_v1 { */ export interface Schema$DriveExportOptions { /** - * Set to true to include access level information for users with <a - * href="https://support.google.com/vault/answer/6099459#metadata">indirect - * access</a> to files. + * Set to true to include access level information for users with <a href="https://support.google.com/vault/answer/6099459#metadata">indirect access</a> to files. */ includeAccessInfo?: boolean; } @@ -272,17 +260,12 @@ export namespace vault_v1 { */ includeTeamDrives?: boolean; /** - * Search the versions of the Drive file as of the reference date. These - * timestamps are in GMT and rounded down to the given date. + * Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date. */ versionDate?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -409,20 +392,15 @@ export namespace vault_v1 { includeRooms?: boolean; } /** - * An account being held in a particular hold. This structure is immutable. - * This can be either a single user or a google group, depending on the - * corpus. + * An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus. */ export interface Schema$HeldAccount { /** - * The account's ID as provided by the <a - * href="https://developers.google.com/admin-sdk/">Admin - * SDK</a>. + * The account's ID as provided by the <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. */ accountId?: string; /** - * The primary email address of the account. If used as an input, this takes - * precedence over account ID. + * The primary email address of the account. If used as an input, this takes precedence over account ID. */ email?: string; /** @@ -452,13 +430,11 @@ export namespace vault_v1 { */ export interface Schema$HeldGroupsQuery { /** - * The end time range for the search query. These timestamps are in GMT and - * rounded down to the start of the given date. + * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ endTime?: string; /** - * The start time range for the search query. These timestamps are in GMT - * and rounded down to the start of the given date. + * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ startTime?: string; /** @@ -480,13 +456,11 @@ export namespace vault_v1 { */ export interface Schema$HeldMailQuery { /** - * The end time range for the search query. These timestamps are in GMT and - * rounded down to the start of the given date. + * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ endTime?: string; /** - * The start time range for the search query. These timestamps are in GMT - * and rounded down to the start of the given date. + * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ startTime?: string; /** @@ -495,8 +469,7 @@ export namespace vault_v1 { terms?: string; } /** - * A organizational unit being held in a particular hold. This structure is - * immutable. + * A organizational unit being held in a particular hold. This structure is immutable. */ export interface Schema$HeldOrgUnit { /** @@ -509,15 +482,11 @@ export namespace vault_v1 { orgUnitId?: string; } /** - * Represents a hold within Vault. A hold restricts purging of artifacts based - * on the combination of the query and accounts restrictions. A hold can be - * configured to either apply to an explicitly configured set of accounts, or - * can be applied to all members of an organizational unit. + * Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit. */ export interface Schema$Hold { /** - * If set, the hold applies to the enumerated accounts and org_unit must be - * empty. + * If set, the hold applies to the enumerated accounts and org_unit must be empty. */ accounts?: Schema$HeldAccount[]; /** @@ -533,14 +502,11 @@ export namespace vault_v1 { */ name?: string; /** - * If set, the hold applies to all members of the organizational unit and - * accounts must be empty. This property is mutable. For groups holds, set - * the accounts field. + * If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field. */ orgUnit?: Schema$HeldOrgUnit; /** - * The corpus-specific query. If set, the corpusQuery must match corpus - * type. + * The corpus-specific query. If set, the corpusQuery must match corpus type. */ query?: Schema$CorpusQuery; /** @@ -579,8 +545,7 @@ export namespace vault_v1 { */ holds?: Schema$Hold[]; /** - * Page token to retrieve the next page of results in the list. If this is - * empty, then there are no more holds to list. + * Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list. */ nextPageToken?: string; } @@ -602,8 +567,7 @@ export namespace vault_v1 { */ export interface Schema$ListSavedQueriesResponse { /** - * Page token to retrieve the next page of results in the list. If this is - * empty, then there are no more saved queries to list. + * Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list. */ nextPageToken?: string; /** @@ -642,13 +606,11 @@ export namespace vault_v1 { */ description?: string; /** - * The matter ID which is generated by the server. Should be blank when - * creating a new matter. + * The matter ID which is generated by the server. Should be blank when creating a new matter. */ matterId?: string; /** - * List of users and access to the matter. Currently there is no programmer - * defined limit on the number of permissions a matter can have. + * List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. */ matterPermissions?: Schema$MatterPermission[]; /** @@ -661,15 +623,11 @@ export namespace vault_v1 { state?: string; } /** - * Currently each matter only has one owner, and all others are collaborators. - * When an account is purged, its corresponding MatterPermission resources - * cease to exist. + * Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. */ export interface Schema$MatterPermission { /** - * The account id, as provided by <a - * href="https://developers.google.com/admin-sdk/">Admin - * SDK</a>. + * The account id, as provided by <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>. */ accountId?: string; /** @@ -682,9 +640,7 @@ export namespace vault_v1 { */ export interface Schema$OrgUnitInfo { /** - * Org unit to search, as provided by the <a - * href="https://developers.google.com/admin-sdk/directory/">Admin - * SDK Directory API</a>. + * Org unit to search, as provided by the <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK Directory API</a>. */ orgUnitId?: string; } @@ -693,8 +649,7 @@ export namespace vault_v1 { */ export interface Schema$Query { /** - * When 'ACCOUNT' is chosen as search method, account_info needs to - * be specified. + * When 'ACCOUNT' is chosen as search method, account_info needs to be specified. */ accountInfo?: Schema$AccountInfo; /** @@ -710,13 +665,11 @@ export namespace vault_v1 { */ driveOptions?: Schema$DriveOptions; /** - * The end time range for the search query. These timestamps are in GMT and - * rounded down to the start of the given date. + * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ endTime?: string; /** - * When 'ROOM' is chosen as search method, hangout_chats_info needs - * to be specified. (read-only) + * When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only) */ hangoutsChatInfo?: Schema$HangoutsChatInfo; /** @@ -728,8 +681,7 @@ export namespace vault_v1 { */ mailOptions?: Schema$MailOptions; /** - * When 'ORG_UNIT' is chosen as as search method, org_unit_info - * needs to be specified. + * When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. */ orgUnitInfo?: Schema$OrgUnitInfo; /** @@ -737,26 +689,19 @@ export namespace vault_v1 { */ searchMethod?: string; /** - * The start time range for the search query. These timestamps are in GMT - * and rounded down to the start of the given date. + * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ startTime?: string; /** - * When 'TEAM_DRIVE' is chosen as search method, team_drive_info - * needs to be specified. + * When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified. */ teamDriveInfo?: Schema$TeamDriveInfo; /** - * The corpus-specific <a - * href="https://support.google.com/vault/answer/2474474">search - * operators</a> used to generate search results. + * The corpus-specific <a href="https://support.google.com/vault/answer/2474474">search operators</a> used to generate search results. */ terms?: string; /** - * The time zone name. It should be an IANA TZ name, such as - * "America/Los_Angeles". For more information, see <a - * href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time - * Zone</a>. + * The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time Zone</a>. */ timeZone?: string; } @@ -774,8 +719,7 @@ export namespace vault_v1 { */ export interface Schema$RemoveHeldAccountsResponse { /** - * A list of statuses for deleted accounts. Results have the same order as - * the request. + * A list of statuses for deleted accounts. Results have the same order as the request. */ statuses?: Schema$Status[]; } @@ -806,8 +750,7 @@ export namespace vault_v1 { */ export interface Schema$SavedQuery { /** - * Output only. The server generated timestamp at which saved query was - * created. + * Output only. The server generated timestamp at which saved query was created. */ createTime?: string; /** @@ -815,13 +758,11 @@ export namespace vault_v1 { */ displayName?: string; /** - * Output only. The matter id of the associated matter. The server does not - * look at this field during create and always uses matter id in the URL. + * Output only. The matter id of the associated matter. The server does not look at this field during create and always uses matter id in the URL. */ matterId?: string; /** - * The underlying Query object which contains all the information of the - * saved query. + * The underlying Query object which contains all the information of the saved query. */ query?: Schema$Query; /** @@ -830,40 +771,7 @@ export namespace vault_v1 { savedQueryId?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -871,14 +779,11 @@ export namespace vault_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -887,9 +792,7 @@ export namespace vault_v1 { */ export interface Schema$TeamDriveInfo { /** - * List of Team Drive ids, as provided by <a - * href="https://developers.google.com/drive">Drive - * API</a>. + * List of Team Drive ids, as provided by <a href="https://developers.google.com/drive">Drive API</a>. */ teamDriveIds?: string[]; } @@ -1076,9 +979,7 @@ export namespace vault_v1 { /** * vault.matters.create - * @desc Creates a new matter with the given name and description. The - * initial state is open, and the owner is the method caller. Returns the - * created matter with default view. + * @desc Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view. * @alias vault.matters.create * @memberOf! () * @@ -1583,9 +1484,7 @@ export namespace vault_v1 { /** * vault.matters.update - * @desc Updates the specified matter. This updates only the name and - * description of the matter, identified by matter id. Changes to any other - * fields are ignored. Returns the default view of the matter. + * @desc Updates the specified matter. This updates only the name and description of the matter, identified by matter id. Changes to any other fields are ignored. Returns the default view of the matter. * @alias vault.matters.update * @memberOf! () * @@ -1733,8 +1632,7 @@ export namespace vault_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The number of matters to return in the response. Default and maximum are - * 100. + * The number of matters to return in the response. Default and maximum are 100. */ pageSize?: number; /** @@ -1742,8 +1640,7 @@ export namespace vault_v1 { */ pageToken?: string; /** - * If set, list only matters with that specific state. The default is - * listing matters of all states. + * If set, list only matters with that specific state. The default is listing matters of all states. */ state?: string; /** @@ -2197,9 +2094,7 @@ export namespace vault_v1 { /** * vault.matters.holds.addHeldAccounts - * @desc Adds HeldAccounts to a hold. Returns a list of accounts that have - * been successfully added. Accounts can only be added to an existing - * account-based hold. + * @desc Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold. * @alias vault.matters.holds.addHeldAccounts * @memberOf! () * @@ -2351,8 +2246,7 @@ export namespace vault_v1 { /** * vault.matters.holds.delete - * @desc Removes a hold by ID. This will release any HeldAccounts on this - * Hold. + * @desc Removes a hold by ID. This will release any HeldAccounts on this Hold. * @alias vault.matters.holds.delete * @memberOf! () * @@ -2499,8 +2393,7 @@ export namespace vault_v1 { /** * vault.matters.holds.list - * @desc Lists holds within a matter. An empty page token in - * ListHoldsResponse denotes no more holds to list. + * @desc Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list. * @alias vault.matters.holds.list * @memberOf! () * @@ -2577,9 +2470,7 @@ export namespace vault_v1 { /** * vault.matters.holds.removeHeldAccounts - * @desc Removes HeldAccounts from a hold. Returns a list of statuses in the - * same order as the request. If this request leaves the hold with no held - * accounts, the hold will not apply to any accounts. + * @desc Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts. * @alias vault.matters.holds.removeHeldAccounts * @memberOf! () * @@ -2662,9 +2553,7 @@ export namespace vault_v1 { /** * vault.matters.holds.update - * @desc Updates the OU and/or query parameters of a hold. You cannot add - * accounts to a hold that covers an OU, nor can you add OUs to a hold that - * covers individual accounts. Accounts listed in the hold will be ignored. + * @desc Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored. * @alias vault.matters.holds.update * @memberOf! () * @@ -2823,13 +2712,11 @@ export namespace vault_v1 { */ matterId?: string; /** - * The number of holds to return in the response, between 0 and 100 - * inclusive. Leaving this empty, or as 0, is the same as page_size = 100. + * The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100. */ pageSize?: number; /** - * The pagination token as returned in the response. An empty token means - * start from the beginning. + * The pagination token as returned in the response. An empty token means start from the beginning. */ pageToken?: string; /** @@ -2888,9 +2775,7 @@ export namespace vault_v1 { /** * vault.matters.holds.accounts.create - * @desc Adds a HeldAccount to a hold. Accounts can only be added to a hold - * that has no held_org_unit set. Attempting to add an account to an - * OU-based hold will result in an error. + * @desc Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error. * @alias vault.matters.holds.accounts.create * @memberOf! () * @@ -2965,8 +2850,7 @@ export namespace vault_v1 { /** * vault.matters.holds.accounts.delete - * @desc Removes a HeldAccount from a hold. If this request leaves the hold - * with no held accounts, the hold will not apply to any accounts. + * @desc Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts. * @alias vault.matters.holds.accounts.delete * @memberOf! () * @@ -3040,10 +2924,7 @@ export namespace vault_v1 { /** * vault.matters.holds.accounts.list - * @desc Lists HeldAccounts for a hold. This will only list individually - * specified held accounts. If the hold is on an OU, then use Admin SDK to - * enumerate its members. + * @desc Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members. * @alias vault.matters.holds.accounts.list * @memberOf! () * @@ -3405,8 +3286,7 @@ export namespace vault_v1 { /** * vault.matters.savedQueries.list - * @desc Lists saved queries within a matter. An empty page token in - * ListSavedQueriesResponse denotes no more saved queries to list. + * @desc Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list. * @alias vault.matters.savedQueries.list * @memberOf! () * @@ -3491,8 +3371,7 @@ export namespace vault_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The matter id of the parent matter for which the saved query is to be - * created. + * The matter id of the parent matter for which the saved query is to be created. */ matterId?: string; @@ -3509,8 +3388,7 @@ export namespace vault_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The matter id of the parent matter for which the saved query is to be - * deleted. + * The matter id of the parent matter for which the saved query is to be deleted. */ matterId?: string; /** @@ -3526,8 +3404,7 @@ export namespace vault_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The matter id of the parent matter for which the saved query is to be - * retrieved. + * The matter id of the parent matter for which the saved query is to be retrieved. */ matterId?: string; /** @@ -3543,8 +3420,7 @@ export namespace vault_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The matter id of the parent matter for which the saved queries are to be - * retrieved. + * The matter id of the parent matter for which the saved queries are to be retrieved. */ matterId?: string; /** @@ -3552,8 +3428,7 @@ export namespace vault_v1 { */ pageSize?: number; /** - * The pagination token as returned in the previous response. An empty token - * means start from the beginning. + * The pagination token as returned in the previous response. An empty token means start from the beginning. */ pageToken?: string; } diff --git a/src/apis/videointelligence/package.json b/src/apis/videointelligence/package.json index 816f66d0243..638f2ea2b02 100644 --- a/src/apis/videointelligence/package.json +++ b/src/apis/videointelligence/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 3df56cbecc4..7b050886098 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace videointelligence_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace videointelligence_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace videointelligence_v1 { /** * Cloud Video Intelligence API * - * Detects objects, explicit content, and scene changes in videos. It also - * specifies the region for annotation and transcribes speech to text. - * Supports both asynchronous API and streaming API. + * Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace videointelligence_v1 { videos: Resource$Videos; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.operations = new Resource$Operations(this.context); this.videos = new Resource$Videos(this.context); @@ -123,9 +120,7 @@ export namespace videointelligence_v1 { } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { /** @@ -134,9 +129,7 @@ export namespace videointelligence_v1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { /** @@ -153,8 +146,7 @@ export namespace videointelligence_v1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -163,9 +155,7 @@ export namespace videointelligence_v1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { /** @@ -182,8 +172,7 @@ export namespace videointelligence_v1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -192,9 +181,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -219,8 +206,7 @@ export namespace videointelligence_v1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -238,8 +224,7 @@ export namespace videointelligence_v1 { segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingBox { /** @@ -260,14 +245,7 @@ export namespace videointelligence_v1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingPoly { /** @@ -276,8 +254,7 @@ export namespace videointelligence_v1 { vertices?: Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex { /** @@ -302,29 +279,20 @@ export namespace videointelligence_v1 { */ entity?: Schema$GoogleCloudVideointelligenceV1beta2_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame { /** @@ -341,12 +309,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -363,23 +326,16 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation { /** @@ -392,9 +348,7 @@ export namespace videointelligence_v1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextFrame { /** @@ -411,8 +365,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -429,13 +382,11 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -452,8 +403,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -461,13 +411,11 @@ export namespace videointelligence_v1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -475,8 +423,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -484,8 +431,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -493,8 +439,7 @@ export namespace videointelligence_v1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation[]; } @@ -503,51 +448,32 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -556,9 +482,7 @@ export namespace videointelligence_v1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { /** @@ -567,9 +491,7 @@ export namespace videointelligence_v1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { /** @@ -586,8 +508,7 @@ export namespace videointelligence_v1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -596,9 +517,7 @@ export namespace videointelligence_v1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { /** @@ -615,8 +534,7 @@ export namespace videointelligence_v1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -625,9 +543,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -652,8 +568,7 @@ export namespace videointelligence_v1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -671,8 +586,7 @@ export namespace videointelligence_v1 { segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox { /** @@ -693,14 +607,7 @@ export namespace videointelligence_v1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingPoly { /** @@ -709,8 +616,7 @@ export namespace videointelligence_v1 { vertices?: Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex { /** @@ -735,29 +641,20 @@ export namespace videointelligence_v1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame { /** @@ -774,12 +671,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -796,23 +688,16 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation { /** @@ -825,9 +710,7 @@ export namespace videointelligence_v1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextFrame { /** @@ -844,8 +727,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -862,13 +744,11 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -885,8 +765,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -894,13 +773,11 @@ export namespace videointelligence_v1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -908,8 +785,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -917,8 +793,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -926,8 +801,7 @@ export namespace videointelligence_v1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation[]; } @@ -936,51 +810,32 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -989,9 +844,7 @@ export namespace videointelligence_v1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoProgress { /** @@ -1000,9 +853,7 @@ export namespace videointelligence_v1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse { /** @@ -1019,8 +870,7 @@ export namespace videointelligence_v1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1029,9 +879,7 @@ export namespace videointelligence_v1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation { /** @@ -1048,8 +896,7 @@ export namespace videointelligence_v1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1058,9 +905,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1085,8 +930,7 @@ export namespace videointelligence_v1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1104,8 +948,7 @@ export namespace videointelligence_v1 { segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox { /** @@ -1126,14 +969,7 @@ export namespace videointelligence_v1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingPoly { /** @@ -1142,8 +978,7 @@ export namespace videointelligence_v1 { vertices?: Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex { /** @@ -1168,29 +1003,20 @@ export namespace videointelligence_v1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame { /** @@ -1207,12 +1033,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1229,23 +1050,16 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** @@ -1258,9 +1072,7 @@ export namespace videointelligence_v1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame { /** @@ -1277,8 +1089,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1295,13 +1106,11 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1318,8 +1127,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1327,13 +1135,11 @@ export namespace videointelligence_v1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1341,8 +1147,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1350,8 +1155,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1359,8 +1163,7 @@ export namespace videointelligence_v1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation[]; } @@ -1369,51 +1172,32 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1422,9 +1206,7 @@ export namespace videointelligence_v1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoProgress { /** @@ -1433,9 +1215,7 @@ export namespace videointelligence_v1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoResponse { /** @@ -1452,8 +1232,7 @@ export namespace videointelligence_v1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1462,9 +1241,7 @@ export namespace videointelligence_v1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation { /** @@ -1481,8 +1258,7 @@ export namespace videointelligence_v1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1491,9 +1267,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -1518,8 +1292,7 @@ export namespace videointelligence_v1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1537,8 +1310,7 @@ export namespace videointelligence_v1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox { /** @@ -1559,14 +1331,7 @@ export namespace videointelligence_v1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingPoly { /** @@ -1575,8 +1340,7 @@ export namespace videointelligence_v1 { vertices?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex { /** @@ -1601,29 +1365,20 @@ export namespace videointelligence_v1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame { /** @@ -1640,12 +1395,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1662,23 +1412,16 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * `StreamingAnnotateVideoResponse` is the only message returned to the client - * by `StreamingAnnotateVideo`. A series of zero or more - * `StreamingAnnotateVideoResponse` messages are streamed back to the client. + * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingAnnotateVideoResponse { /** @@ -1686,20 +1429,16 @@ export namespace videointelligence_v1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * GCS URI that stores annotation results of one streaming session. It is a - * directory that can hold multiple files in JSON format. Example uri - * format: gs://bucket_id/object_id/cloud_project_name-session_id + * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ annotationResultsUri?: string; /** - * If set, returns a google.rpc.Status message that specifies the error for - * the operation. + * If set, returns a google.rpc.Status message that specifies the error for the operation. */ error?: Schema$GoogleRpc_Status; } /** - * Streaming annotation results corresponding to a portion of the video that - * is currently being processed. + * Streaming annotation results corresponding to a portion of the video that is currently being processed. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults { /** @@ -1720,9 +1459,7 @@ export namespace videointelligence_v1 { shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation { /** @@ -1735,9 +1472,7 @@ export namespace videointelligence_v1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextFrame { /** @@ -1754,8 +1489,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1772,13 +1506,11 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1795,8 +1527,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1804,13 +1535,11 @@ export namespace videointelligence_v1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1818,8 +1547,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1827,8 +1555,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1836,8 +1563,7 @@ export namespace videointelligence_v1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation[]; } @@ -1846,51 +1572,32 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1899,9 +1606,7 @@ export namespace videointelligence_v1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { /** @@ -1918,37 +1623,19 @@ export namespace videointelligence_v1 { */ features?: string[]; /** - * The video data bytes. If unset, the input video(s) should be specified - * via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ inputContent?: string; /** - * Input video location. Currently, only [Google Cloud - * Storage](https://cloud.google.com/storage/) URIs are supported, which - * must be specified in the following format: `gs://bucket-id/object-id` - * (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more - * information, see [Request URIs](/storage/docs/reference-uris). A video - * URI may include wildcards in `object-id`, and thus identify multiple - * videos. Supported wildcards: '*' to match 0 or more characters; - * '?' to match 1 character. If unset, the input video should be - * embedded in the request as `input_content`. If set, `input_content` - * should be unset. + * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ inputUri?: string; /** - * Optional cloud region where annotation should take place. Supported cloud - * regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no - * region is specified, a region will be determined based on video file - * location. + * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string; /** - * Optional location where the output (in JSON format) should be stored. - * Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) - * URIs are supported, which must be specified in the following format: - * `gs://bucket-id/object-id` (other URI formats return - * google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request - * URIs](/storage/docs/reference-uris). + * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string; /** @@ -1957,9 +1644,7 @@ export namespace videointelligence_v1 { videoContext?: Schema$GoogleCloudVideointelligenceV1_VideoContext; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { /** @@ -1976,8 +1661,7 @@ export namespace videointelligence_v1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1986,9 +1670,7 @@ export namespace videointelligence_v1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { /** @@ -2001,9 +1683,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentDetectionConfig { /** - * Model to use for explicit content detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } @@ -2016,8 +1696,7 @@ export namespace videointelligence_v1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2026,9 +1705,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2049,39 +1726,23 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from - * frame-level detection. If not set, it is set to 0.4 by default. The valid - * range for this threshold is [0.1, 0.9]. Any value set outside of this - * range will be clipped. Note: for best results please follow the default - * threshold. We will update the default threshold everytime when we release - * a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number; /** - * What labels should be detected with LABEL_DETECTION, in addition to - * video-level labels or segment-level labels. If unspecified, defaults to - * `SHOT_MODE`. + * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ labelDetectionMode?: string; /** - * Model to use for label detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** - * Whether the video has been shot from a stationary (i.e. non-moving) - * camera. When set to true, might improve detection accuracy for moving - * objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean; /** - * The confidence threshold we perform filtering on the labels from - * video-level and shot-level detections. If not set, it is set to 0.3 by - * default. The valid range for this threshold is [0.1, 0.9]. Any value set - * outside of this range will be clipped. Note: for best results please - * follow the default threshold. We will update the default threshold - * everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number; } @@ -2094,8 +1755,7 @@ export namespace videointelligence_v1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2113,8 +1773,7 @@ export namespace videointelligence_v1 { segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingBox { /** @@ -2135,14 +1794,7 @@ export namespace videointelligence_v1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingPoly { /** @@ -2151,8 +1803,7 @@ export namespace videointelligence_v1 { vertices?: Schema$GoogleCloudVideointelligenceV1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedVertex { /** @@ -2177,29 +1828,20 @@ export namespace videointelligence_v1 { */ entity?: Schema$GoogleCloudVideointelligenceV1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame { /** @@ -2216,25 +1858,16 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig { /** - * Model to use for shot change detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases - * "hints" so that the speech recognition is more likely to - * recognize them. This can be used to improve the accuracy for specific - * words and phrases, for example, if specific commands are typically spoken - * by the user. This can also be used to add additional words to the - * vocabulary of the recognizer. See [usage - * limits](https://cloud.google.com/speech/limits#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[]; } @@ -2243,12 +1876,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -2265,16 +1893,11 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } @@ -2283,63 +1906,35 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple - * audio tracks, specify up to two tracks. Default: track 0. + * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[]; /** - * *Optional* If set, specifies the estimated number of speakers in the - * conversation. If not set, defaults to '2'. Ignored unless - * enable_speaker_diarization is set to true. + * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number; /** - * *Optional* If 'true', adds punctuation to recognition result - * hypotheses. This feature is only available in select languages. Setting - * this for requests in other languages has no effect at all. The default - * 'false' value does not add punctuation to result hypotheses. - * NOTE: "This is currently offered as an experimental service, - * complimentary to all users. In the future this may be exclusively - * available as a premium feature." + * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean; /** - * *Optional* If 'true', enables speaker detection for each - * recognized word in the top alternative of the recognition result using a - * speaker_tag provided in the WordInfo. Note: When this is true, we send - * all the words from the beginning of the audio for the top alternative in - * every consecutive responses. This is done in order to improve our speaker - * tags as our models learn to identify the speakers in the conversation - * over time. + * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * confidence for those words. If `false`, no word-level confidence - * information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean; /** - * *Optional* If set to `true`, the server will attempt to filter out - * profanities, replacing all but the initial character in each filtered - * word with asterisks, e.g. "f***". If set to `false` or omitted, - * profanities won't be filtered out. + * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean; /** - * *Required* The language of the supplied audio as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". See [Language - * Support](https://cloud.google.com/speech/docs/languages) for a list of - * the currently supported language codes. + * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string; /** - * *Optional* Maximum number of recognition hypotheses to be returned. - * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechTranscription`. The server may return fewer - * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` - * will return a maximum of one. If omitted, will return a maximum of one. + * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -2348,9 +1943,7 @@ export namespace videointelligence_v1 { speechContexts?: Schema$GoogleCloudVideointelligenceV1_SpeechContext[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1_TextAnnotation { /** @@ -2367,17 +1960,12 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_TextDetectionConfig { /** - * Language hint can be specified if the language to be detected is known a - * priori. It can increase the accuracy of the detection. Language hint must - * be language code in BCP-47 format. Automatic language detection is - * performed if no hint is provided. + * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1_TextFrame { /** @@ -2394,8 +1982,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2412,13 +1999,11 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2435,8 +2020,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2444,13 +2028,11 @@ export namespace videointelligence_v1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2458,8 +2040,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2467,8 +2048,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2476,8 +2056,7 @@ export namespace videointelligence_v1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1_TextAnnotation[]; } @@ -2494,9 +2073,7 @@ export namespace videointelligence_v1 { */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1_LabelDetectionConfig; /** - * Video segments to annotate. The segments may overlap and are not required - * to be contiguous or span the whole video. If unspecified, each video is - * treated as a single segment. + * Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment. */ segments?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** @@ -2517,51 +2094,32 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2587,14 +2145,11 @@ export namespace videointelligence_v1 { operations?: Schema$GoogleLongrunning_Operation[]; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunning_Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2602,72 +2157,24 @@ export namespace videointelligence_v1 { */ error?: Schema$GoogleRpc_Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobuf_Empty {} /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpc_Status { /** @@ -2675,14 +2182,11 @@ export namespace videointelligence_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2695,15 +2199,7 @@ export namespace videointelligence_v1 { /** * videointelligence.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias videointelligence.operations.cancel * @memberOf! () * @@ -2781,10 +2277,7 @@ export namespace videointelligence_v1 { /** * videointelligence.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias videointelligence.operations.delete * @memberOf! () * @@ -2861,9 +2354,7 @@ export namespace videointelligence_v1 { /** * videointelligence.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias videointelligence.operations.get * @memberOf! () * @@ -2944,15 +2435,7 @@ export namespace videointelligence_v1 { /** * videointelligence.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias videointelligence.operations.list * @memberOf! () * @@ -3114,10 +2597,7 @@ export namespace videointelligence_v1 { /** * videointelligence.videos.annotate - * @desc Performs asynchronous video annotation. Progress and results can be - * retrieved through the `google.longrunning.Operations` interface. - * `Operation.metadata` contains `AnnotateVideoProgress` (progress). - * `Operation.response` contains `AnnotateVideoResponse` (results). + * @desc Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results). * @alias videointelligence.videos.annotate * @memberOf! () * diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index 2a3090b81ce..6b600d802cf 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace videointelligence_v1beta2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace videointelligence_v1beta2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace videointelligence_v1beta2 { /** * Cloud Video Intelligence API * - * Detects objects, explicit content, and scene changes in videos. It also - * specifies the region for annotation and transcribes speech to text. - * Supports both asynchronous API and streaming API. + * Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API. * * @example * const {google} = require('googleapis'); @@ -114,16 +108,17 @@ export namespace videointelligence_v1beta2 { videos: Resource$Videos; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.videos = new Resource$Videos(this.context); } } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { /** @@ -140,37 +135,19 @@ export namespace videointelligence_v1beta2 { */ features?: string[]; /** - * The video data bytes. If unset, the input video(s) should be specified - * via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ inputContent?: string; /** - * Input video location. Currently, only [Google Cloud - * Storage](https://cloud.google.com/storage/) URIs are supported, which - * must be specified in the following format: `gs://bucket-id/object-id` - * (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more - * information, see [Request URIs](/storage/docs/reference-uris). A video - * URI may include wildcards in `object-id`, and thus identify multiple - * videos. Supported wildcards: '*' to match 0 or more characters; - * '?' to match 1 character. If unset, the input video should be - * embedded in the request as `input_content`. If set, `input_content` - * should be unset. + * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ inputUri?: string; /** - * Optional cloud region where annotation should take place. Supported cloud - * regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no - * region is specified, a region will be determined based on video file - * location. + * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string; /** - * Optional location where the output (in JSON format) should be stored. - * Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) - * URIs are supported, which must be specified in the following format: - * `gs://bucket-id/object-id` (other URI formats return - * google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request - * URIs](/storage/docs/reference-uris). + * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string; /** @@ -179,9 +156,7 @@ export namespace videointelligence_v1beta2 { videoContext?: Schema$GoogleCloudVideointelligenceV1beta2_VideoContext; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { /** @@ -198,8 +173,7 @@ export namespace videointelligence_v1beta2 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -208,9 +182,7 @@ export namespace videointelligence_v1beta2 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { /** @@ -223,9 +195,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentDetectionConfig { /** - * Model to use for explicit content detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } @@ -238,8 +208,7 @@ export namespace videointelligence_v1beta2 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -248,9 +217,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -271,39 +238,23 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from - * frame-level detection. If not set, it is set to 0.4 by default. The valid - * range for this threshold is [0.1, 0.9]. Any value set outside of this - * range will be clipped. Note: for best results please follow the default - * threshold. We will update the default threshold everytime when we release - * a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number; /** - * What labels should be detected with LABEL_DETECTION, in addition to - * video-level labels or segment-level labels. If unspecified, defaults to - * `SHOT_MODE`. + * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ labelDetectionMode?: string; /** - * Model to use for label detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** - * Whether the video has been shot from a stationary (i.e. non-moving) - * camera. When set to true, might improve detection accuracy for moving - * objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean; /** - * The confidence threshold we perform filtering on the labels from - * video-level and shot-level detections. If not set, it is set to 0.3 by - * default. The valid range for this threshold is [0.1, 0.9]. Any value set - * outside of this range will be clipped. Note: for best results please - * follow the default threshold. We will update the default threshold - * everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number; } @@ -316,8 +267,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -335,8 +285,7 @@ export namespace videointelligence_v1beta2 { segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingBox { /** @@ -357,14 +306,7 @@ export namespace videointelligence_v1beta2 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingPoly { /** @@ -373,8 +315,7 @@ export namespace videointelligence_v1beta2 { vertices?: Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex { /** @@ -399,29 +340,20 @@ export namespace videointelligence_v1beta2 { */ entity?: Schema$GoogleCloudVideointelligenceV1beta2_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame { /** @@ -438,25 +370,16 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ShotChangeDetectionConfig { /** - * Model to use for shot change detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechContext { /** - * *Optional* A list of strings containing words and phrases - * "hints" so that the speech recognition is more likely to - * recognize them. This can be used to improve the accuracy for specific - * words and phrases, for example, if specific commands are typically spoken - * by the user. This can also be used to add additional words to the - * vocabulary of the recognizer. See [usage - * limits](https://cloud.google.com/speech/limits#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[]; } @@ -465,12 +388,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -487,16 +405,11 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } @@ -505,63 +418,35 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple - * audio tracks, specify up to two tracks. Default: track 0. + * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[]; /** - * *Optional* If set, specifies the estimated number of speakers in the - * conversation. If not set, defaults to '2'. Ignored unless - * enable_speaker_diarization is set to true. + * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number; /** - * *Optional* If 'true', adds punctuation to recognition result - * hypotheses. This feature is only available in select languages. Setting - * this for requests in other languages has no effect at all. The default - * 'false' value does not add punctuation to result hypotheses. - * NOTE: "This is currently offered as an experimental service, - * complimentary to all users. In the future this may be exclusively - * available as a premium feature." + * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean; /** - * *Optional* If 'true', enables speaker detection for each - * recognized word in the top alternative of the recognition result using a - * speaker_tag provided in the WordInfo. Note: When this is true, we send - * all the words from the beginning of the audio for the top alternative in - * every consecutive responses. This is done in order to improve our speaker - * tags as our models learn to identify the speakers in the conversation - * over time. + * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * confidence for those words. If `false`, no word-level confidence - * information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean; /** - * *Optional* If set to `true`, the server will attempt to filter out - * profanities, replacing all but the initial character in each filtered - * word with asterisks, e.g. "f***". If set to `false` or omitted, - * profanities won't be filtered out. + * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean; /** - * *Required* The language of the supplied audio as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". See [Language - * Support](https://cloud.google.com/speech/docs/languages) for a list of - * the currently supported language codes. + * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string; /** - * *Optional* Maximum number of recognition hypotheses to be returned. - * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechTranscription`. The server may return fewer - * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` - * will return a maximum of one. If omitted, will return a maximum of one. + * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -570,9 +455,7 @@ export namespace videointelligence_v1beta2 { speechContexts?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechContext[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation { /** @@ -589,17 +472,12 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextDetectionConfig { /** - * Language hint can be specified if the language to be detected is known a - * priori. It can increase the accuracy of the detection. Language hint must - * be language code in BCP-47 format. Automatic language detection is - * performed if no hint is provided. + * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextFrame { /** @@ -616,8 +494,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -634,13 +511,11 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -657,8 +532,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -666,13 +540,11 @@ export namespace videointelligence_v1beta2 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -680,8 +552,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -689,8 +560,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -698,8 +568,7 @@ export namespace videointelligence_v1beta2 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation[]; } @@ -716,9 +585,7 @@ export namespace videointelligence_v1beta2 { */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1beta2_LabelDetectionConfig; /** - * Video segments to annotate. The segments may overlap and are not required - * to be contiguous or span the whole video. If unspecified, each video is - * treated as a single segment. + * Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment. */ segments?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** @@ -739,51 +606,32 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -792,9 +640,7 @@ export namespace videointelligence_v1beta2 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { /** @@ -803,9 +649,7 @@ export namespace videointelligence_v1beta2 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { /** @@ -822,8 +666,7 @@ export namespace videointelligence_v1beta2 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -832,9 +675,7 @@ export namespace videointelligence_v1beta2 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { /** @@ -851,8 +692,7 @@ export namespace videointelligence_v1beta2 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -861,9 +701,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -888,8 +726,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -907,8 +744,7 @@ export namespace videointelligence_v1beta2 { segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox { /** @@ -929,14 +765,7 @@ export namespace videointelligence_v1beta2 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingPoly { /** @@ -945,8 +774,7 @@ export namespace videointelligence_v1beta2 { vertices?: Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex { /** @@ -971,29 +799,20 @@ export namespace videointelligence_v1beta2 { */ entity?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame { /** @@ -1010,12 +829,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1032,23 +846,16 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation { /** @@ -1061,9 +868,7 @@ export namespace videointelligence_v1beta2 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextFrame { /** @@ -1080,8 +885,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1098,13 +902,11 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1121,8 +923,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1130,13 +931,11 @@ export namespace videointelligence_v1beta2 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1144,8 +943,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1153,8 +951,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1162,8 +959,7 @@ export namespace videointelligence_v1beta2 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation[]; } @@ -1172,51 +968,32 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1225,9 +1002,7 @@ export namespace videointelligence_v1beta2 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoProgress { /** @@ -1236,9 +1011,7 @@ export namespace videointelligence_v1beta2 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse { /** @@ -1255,8 +1028,7 @@ export namespace videointelligence_v1beta2 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1265,9 +1037,7 @@ export namespace videointelligence_v1beta2 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation { /** @@ -1284,8 +1054,7 @@ export namespace videointelligence_v1beta2 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1294,9 +1063,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1321,8 +1088,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1340,8 +1106,7 @@ export namespace videointelligence_v1beta2 { segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox { /** @@ -1362,14 +1127,7 @@ export namespace videointelligence_v1beta2 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingPoly { /** @@ -1378,8 +1136,7 @@ export namespace videointelligence_v1beta2 { vertices?: Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex { /** @@ -1404,29 +1161,20 @@ export namespace videointelligence_v1beta2 { */ entity?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame { /** @@ -1443,12 +1191,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1465,23 +1208,16 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** @@ -1494,9 +1230,7 @@ export namespace videointelligence_v1beta2 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame { /** @@ -1513,8 +1247,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1531,13 +1264,11 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1554,8 +1285,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1563,13 +1293,11 @@ export namespace videointelligence_v1beta2 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1577,8 +1305,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1586,8 +1313,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1595,8 +1321,7 @@ export namespace videointelligence_v1beta2 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation[]; } @@ -1605,51 +1330,32 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1658,9 +1364,7 @@ export namespace videointelligence_v1beta2 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoProgress { /** @@ -1669,9 +1373,7 @@ export namespace videointelligence_v1beta2 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoResponse { /** @@ -1688,8 +1390,7 @@ export namespace videointelligence_v1beta2 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1698,9 +1399,7 @@ export namespace videointelligence_v1beta2 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation { /** @@ -1717,8 +1416,7 @@ export namespace videointelligence_v1beta2 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1727,9 +1425,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -1754,8 +1450,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1773,8 +1468,7 @@ export namespace videointelligence_v1beta2 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox { /** @@ -1795,14 +1489,7 @@ export namespace videointelligence_v1beta2 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingPoly { /** @@ -1811,8 +1498,7 @@ export namespace videointelligence_v1beta2 { vertices?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex { /** @@ -1837,29 +1523,20 @@ export namespace videointelligence_v1beta2 { */ entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame { /** @@ -1876,12 +1553,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1898,23 +1570,16 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * `StreamingAnnotateVideoResponse` is the only message returned to the client - * by `StreamingAnnotateVideo`. A series of zero or more - * `StreamingAnnotateVideoResponse` messages are streamed back to the client. + * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingAnnotateVideoResponse { /** @@ -1922,20 +1587,16 @@ export namespace videointelligence_v1beta2 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * GCS URI that stores annotation results of one streaming session. It is a - * directory that can hold multiple files in JSON format. Example uri - * format: gs://bucket_id/object_id/cloud_project_name-session_id + * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ annotationResultsUri?: string; /** - * If set, returns a google.rpc.Status message that specifies the error for - * the operation. + * If set, returns a google.rpc.Status message that specifies the error for the operation. */ error?: Schema$GoogleRpc_Status; } /** - * Streaming annotation results corresponding to a portion of the video that - * is currently being processed. + * Streaming annotation results corresponding to a portion of the video that is currently being processed. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults { /** @@ -1956,9 +1617,7 @@ export namespace videointelligence_v1beta2 { shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation { /** @@ -1971,9 +1630,7 @@ export namespace videointelligence_v1beta2 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextFrame { /** @@ -1990,8 +1647,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2008,13 +1664,11 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2031,8 +1685,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2040,13 +1693,11 @@ export namespace videointelligence_v1beta2 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2054,8 +1705,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2063,8 +1713,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2072,8 +1721,7 @@ export namespace videointelligence_v1beta2 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation[]; } @@ -2082,51 +1730,32 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2135,9 +1764,7 @@ export namespace videointelligence_v1beta2 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { /** @@ -2146,9 +1773,7 @@ export namespace videointelligence_v1beta2 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { /** @@ -2165,8 +1790,7 @@ export namespace videointelligence_v1beta2 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -2175,9 +1799,7 @@ export namespace videointelligence_v1beta2 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { /** @@ -2194,8 +1816,7 @@ export namespace videointelligence_v1beta2 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2204,9 +1825,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2231,8 +1850,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2250,8 +1868,7 @@ export namespace videointelligence_v1beta2 { segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingBox { /** @@ -2272,14 +1889,7 @@ export namespace videointelligence_v1beta2 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingPoly { /** @@ -2288,8 +1898,7 @@ export namespace videointelligence_v1beta2 { vertices?: Schema$GoogleCloudVideointelligenceV1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedVertex { /** @@ -2314,29 +1923,20 @@ export namespace videointelligence_v1beta2 { */ entity?: Schema$GoogleCloudVideointelligenceV1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame { /** @@ -2353,12 +1953,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -2375,23 +1970,16 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1_TextAnnotation { /** @@ -2404,9 +1992,7 @@ export namespace videointelligence_v1beta2 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1_TextFrame { /** @@ -2423,8 +2009,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2441,13 +2026,11 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2464,8 +2047,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2473,13 +2055,11 @@ export namespace videointelligence_v1beta2 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2487,8 +2067,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2496,8 +2075,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2505,8 +2083,7 @@ export namespace videointelligence_v1beta2 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1_TextAnnotation[]; } @@ -2515,51 +2092,32 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2568,14 +2126,11 @@ export namespace videointelligence_v1beta2 { word?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunning_Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2583,64 +2138,20 @@ export namespace videointelligence_v1beta2 { */ error?: Schema$GoogleRpc_Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpc_Status { /** @@ -2648,14 +2159,11 @@ export namespace videointelligence_v1beta2 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2668,10 +2176,7 @@ export namespace videointelligence_v1beta2 { /** * videointelligence.videos.annotate - * @desc Performs asynchronous video annotation. Progress and results can be - * retrieved through the `google.longrunning.Operations` interface. - * `Operation.metadata` contains `AnnotateVideoProgress` (progress). - * `Operation.response` contains `AnnotateVideoResponse` (results). + * @desc Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results). * @alias videointelligence.videos.annotate * @memberOf! () * diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index 91c1aba082a..83402fd268e 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace videointelligence_v1p1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace videointelligence_v1p1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace videointelligence_v1p1beta1 { /** * Cloud Video Intelligence API * - * Detects objects, explicit content, and scene changes in videos. It also - * specifies the region for annotation and transcribes speech to text. - * Supports both asynchronous API and streaming API. + * Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API. * * @example * const {google} = require('googleapis'); @@ -114,16 +108,17 @@ export namespace videointelligence_v1p1beta1 { videos: Resource$Videos; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.videos = new Resource$Videos(this.context); } } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { /** @@ -132,9 +127,7 @@ export namespace videointelligence_v1p1beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { /** @@ -151,8 +144,7 @@ export namespace videointelligence_v1p1beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -161,9 +153,7 @@ export namespace videointelligence_v1p1beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { /** @@ -180,8 +170,7 @@ export namespace videointelligence_v1p1beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -190,9 +179,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -217,8 +204,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -236,8 +222,7 @@ export namespace videointelligence_v1p1beta1 { segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingBox { /** @@ -258,14 +243,7 @@ export namespace videointelligence_v1p1beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingPoly { /** @@ -274,8 +252,7 @@ export namespace videointelligence_v1p1beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex { /** @@ -300,29 +277,20 @@ export namespace videointelligence_v1p1beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1beta2_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame { /** @@ -339,12 +307,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -361,23 +324,16 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation { /** @@ -390,9 +346,7 @@ export namespace videointelligence_v1p1beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextFrame { /** @@ -409,8 +363,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -427,13 +380,11 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -450,8 +401,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -459,13 +409,11 @@ export namespace videointelligence_v1p1beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -473,8 +421,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -482,8 +429,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -491,8 +437,7 @@ export namespace videointelligence_v1p1beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation[]; } @@ -501,51 +446,32 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -554,9 +480,7 @@ export namespace videointelligence_v1p1beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { /** @@ -573,37 +497,19 @@ export namespace videointelligence_v1p1beta1 { */ features?: string[]; /** - * The video data bytes. If unset, the input video(s) should be specified - * via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ inputContent?: string; /** - * Input video location. Currently, only [Google Cloud - * Storage](https://cloud.google.com/storage/) URIs are supported, which - * must be specified in the following format: `gs://bucket-id/object-id` - * (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more - * information, see [Request URIs](/storage/docs/reference-uris). A video - * URI may include wildcards in `object-id`, and thus identify multiple - * videos. Supported wildcards: '*' to match 0 or more characters; - * '?' to match 1 character. If unset, the input video should be - * embedded in the request as `input_content`. If set, `input_content` - * should be unset. + * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ inputUri?: string; /** - * Optional cloud region where annotation should take place. Supported cloud - * regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no - * region is specified, a region will be determined based on video file - * location. + * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string; /** - * Optional location where the output (in JSON format) should be stored. - * Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) - * URIs are supported, which must be specified in the following format: - * `gs://bucket-id/object-id` (other URI formats return - * google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request - * URIs](/storage/docs/reference-uris). + * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string; /** @@ -612,9 +518,7 @@ export namespace videointelligence_v1p1beta1 { videoContext?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoContext; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { /** @@ -631,8 +535,7 @@ export namespace videointelligence_v1p1beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -641,9 +544,7 @@ export namespace videointelligence_v1p1beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { /** @@ -656,9 +557,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentDetectionConfig { /** - * Model to use for explicit content detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } @@ -671,8 +570,7 @@ export namespace videointelligence_v1p1beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -681,9 +579,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -704,39 +600,23 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from - * frame-level detection. If not set, it is set to 0.4 by default. The valid - * range for this threshold is [0.1, 0.9]. Any value set outside of this - * range will be clipped. Note: for best results please follow the default - * threshold. We will update the default threshold everytime when we release - * a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number; /** - * What labels should be detected with LABEL_DETECTION, in addition to - * video-level labels or segment-level labels. If unspecified, defaults to - * `SHOT_MODE`. + * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ labelDetectionMode?: string; /** - * Model to use for label detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** - * Whether the video has been shot from a stationary (i.e. non-moving) - * camera. When set to true, might improve detection accuracy for moving - * objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean; /** - * The confidence threshold we perform filtering on the labels from - * video-level and shot-level detections. If not set, it is set to 0.3 by - * default. The valid range for this threshold is [0.1, 0.9]. Any value set - * outside of this range will be clipped. Note: for best results please - * follow the default threshold. We will update the default threshold - * everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number; } @@ -749,8 +629,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -768,8 +647,7 @@ export namespace videointelligence_v1p1beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox { /** @@ -790,14 +668,7 @@ export namespace videointelligence_v1p1beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingPoly { /** @@ -806,8 +677,7 @@ export namespace videointelligence_v1p1beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex { /** @@ -832,29 +702,20 @@ export namespace videointelligence_v1p1beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame { /** @@ -871,25 +732,16 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ShotChangeDetectionConfig { /** - * Model to use for shot change detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases - * "hints" so that the speech recognition is more likely to - * recognize them. This can be used to improve the accuracy for specific - * words and phrases, for example, if specific commands are typically spoken - * by the user. This can also be used to add additional words to the - * vocabulary of the recognizer. See [usage - * limits](https://cloud.google.com/speech/limits#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[]; } @@ -898,12 +750,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -920,16 +767,11 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } @@ -938,63 +780,35 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple - * audio tracks, specify up to two tracks. Default: track 0. + * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[]; /** - * *Optional* If set, specifies the estimated number of speakers in the - * conversation. If not set, defaults to '2'. Ignored unless - * enable_speaker_diarization is set to true. + * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number; /** - * *Optional* If 'true', adds punctuation to recognition result - * hypotheses. This feature is only available in select languages. Setting - * this for requests in other languages has no effect at all. The default - * 'false' value does not add punctuation to result hypotheses. - * NOTE: "This is currently offered as an experimental service, - * complimentary to all users. In the future this may be exclusively - * available as a premium feature." + * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean; /** - * *Optional* If 'true', enables speaker detection for each - * recognized word in the top alternative of the recognition result using a - * speaker_tag provided in the WordInfo. Note: When this is true, we send - * all the words from the beginning of the audio for the top alternative in - * every consecutive responses. This is done in order to improve our speaker - * tags as our models learn to identify the speakers in the conversation - * over time. + * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * confidence for those words. If `false`, no word-level confidence - * information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean; /** - * *Optional* If set to `true`, the server will attempt to filter out - * profanities, replacing all but the initial character in each filtered - * word with asterisks, e.g. "f***". If set to `false` or omitted, - * profanities won't be filtered out. + * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean; /** - * *Required* The language of the supplied audio as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". See [Language - * Support](https://cloud.google.com/speech/docs/languages) for a list of - * the currently supported language codes. + * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string; /** - * *Optional* Maximum number of recognition hypotheses to be returned. - * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechTranscription`. The server may return fewer - * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` - * will return a maximum of one. If omitted, will return a maximum of one. + * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -1003,9 +817,7 @@ export namespace videointelligence_v1p1beta1 { speechContexts?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechContext[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation { /** @@ -1022,17 +834,12 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextDetectionConfig { /** - * Language hint can be specified if the language to be detected is known a - * priori. It can increase the accuracy of the detection. Language hint must - * be language code in BCP-47 format. Automatic language detection is - * performed if no hint is provided. + * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextFrame { /** @@ -1049,8 +856,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1067,13 +873,11 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1090,8 +894,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1099,13 +902,11 @@ export namespace videointelligence_v1p1beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1113,8 +914,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1122,8 +922,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1131,8 +930,7 @@ export namespace videointelligence_v1p1beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation[]; } @@ -1149,9 +947,7 @@ export namespace videointelligence_v1p1beta1 { */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelDetectionConfig; /** - * Video segments to annotate. The segments may overlap and are not required - * to be contiguous or span the whole video. If unspecified, each video is - * treated as a single segment. + * Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment. */ segments?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** @@ -1172,51 +968,32 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1225,9 +1002,7 @@ export namespace videointelligence_v1p1beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoProgress { /** @@ -1236,9 +1011,7 @@ export namespace videointelligence_v1p1beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse { /** @@ -1255,8 +1028,7 @@ export namespace videointelligence_v1p1beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1265,9 +1037,7 @@ export namespace videointelligence_v1p1beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation { /** @@ -1284,8 +1054,7 @@ export namespace videointelligence_v1p1beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1294,9 +1063,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1321,8 +1088,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1340,8 +1106,7 @@ export namespace videointelligence_v1p1beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox { /** @@ -1362,14 +1127,7 @@ export namespace videointelligence_v1p1beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingPoly { /** @@ -1378,8 +1136,7 @@ export namespace videointelligence_v1p1beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex { /** @@ -1404,29 +1161,20 @@ export namespace videointelligence_v1p1beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame { /** @@ -1443,12 +1191,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1465,23 +1208,16 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** @@ -1494,9 +1230,7 @@ export namespace videointelligence_v1p1beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame { /** @@ -1513,8 +1247,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1531,13 +1264,11 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1554,8 +1285,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1563,13 +1293,11 @@ export namespace videointelligence_v1p1beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1577,8 +1305,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1586,8 +1313,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1595,8 +1321,7 @@ export namespace videointelligence_v1p1beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation[]; } @@ -1605,51 +1330,32 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1658,9 +1364,7 @@ export namespace videointelligence_v1p1beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoProgress { /** @@ -1669,9 +1373,7 @@ export namespace videointelligence_v1p1beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoResponse { /** @@ -1688,8 +1390,7 @@ export namespace videointelligence_v1p1beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1698,9 +1399,7 @@ export namespace videointelligence_v1p1beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation { /** @@ -1717,8 +1416,7 @@ export namespace videointelligence_v1p1beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1727,9 +1425,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -1754,8 +1450,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1773,8 +1468,7 @@ export namespace videointelligence_v1p1beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox { /** @@ -1795,14 +1489,7 @@ export namespace videointelligence_v1p1beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingPoly { /** @@ -1811,8 +1498,7 @@ export namespace videointelligence_v1p1beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex { /** @@ -1837,29 +1523,20 @@ export namespace videointelligence_v1p1beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame { /** @@ -1876,12 +1553,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1898,23 +1570,16 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * `StreamingAnnotateVideoResponse` is the only message returned to the client - * by `StreamingAnnotateVideo`. A series of zero or more - * `StreamingAnnotateVideoResponse` messages are streamed back to the client. + * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingAnnotateVideoResponse { /** @@ -1922,20 +1587,16 @@ export namespace videointelligence_v1p1beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * GCS URI that stores annotation results of one streaming session. It is a - * directory that can hold multiple files in JSON format. Example uri - * format: gs://bucket_id/object_id/cloud_project_name-session_id + * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ annotationResultsUri?: string; /** - * If set, returns a google.rpc.Status message that specifies the error for - * the operation. + * If set, returns a google.rpc.Status message that specifies the error for the operation. */ error?: Schema$GoogleRpc_Status; } /** - * Streaming annotation results corresponding to a portion of the video that - * is currently being processed. + * Streaming annotation results corresponding to a portion of the video that is currently being processed. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults { /** @@ -1956,9 +1617,7 @@ export namespace videointelligence_v1p1beta1 { shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation { /** @@ -1971,9 +1630,7 @@ export namespace videointelligence_v1p1beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextFrame { /** @@ -1990,8 +1647,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2008,13 +1664,11 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2031,8 +1685,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2040,13 +1693,11 @@ export namespace videointelligence_v1p1beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2054,8 +1705,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2063,8 +1713,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2072,8 +1721,7 @@ export namespace videointelligence_v1p1beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation[]; } @@ -2082,51 +1730,32 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2135,9 +1764,7 @@ export namespace videointelligence_v1p1beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { /** @@ -2146,9 +1773,7 @@ export namespace videointelligence_v1p1beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { /** @@ -2165,8 +1790,7 @@ export namespace videointelligence_v1p1beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -2175,9 +1799,7 @@ export namespace videointelligence_v1p1beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { /** @@ -2194,8 +1816,7 @@ export namespace videointelligence_v1p1beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2204,9 +1825,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2231,8 +1850,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2250,8 +1868,7 @@ export namespace videointelligence_v1p1beta1 { segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingBox { /** @@ -2272,14 +1889,7 @@ export namespace videointelligence_v1p1beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingPoly { /** @@ -2288,8 +1898,7 @@ export namespace videointelligence_v1p1beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedVertex { /** @@ -2314,29 +1923,20 @@ export namespace videointelligence_v1p1beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame { /** @@ -2353,12 +1953,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -2375,23 +1970,16 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1_TextAnnotation { /** @@ -2404,9 +1992,7 @@ export namespace videointelligence_v1p1beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1_TextFrame { /** @@ -2423,8 +2009,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2441,13 +2026,11 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2464,8 +2047,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2473,13 +2055,11 @@ export namespace videointelligence_v1p1beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2487,8 +2067,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2496,8 +2075,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2505,8 +2083,7 @@ export namespace videointelligence_v1p1beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1_TextAnnotation[]; } @@ -2515,51 +2092,32 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2568,14 +2126,11 @@ export namespace videointelligence_v1p1beta1 { word?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunning_Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2583,64 +2138,20 @@ export namespace videointelligence_v1p1beta1 { */ error?: Schema$GoogleRpc_Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpc_Status { /** @@ -2648,14 +2159,11 @@ export namespace videointelligence_v1p1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2668,10 +2176,7 @@ export namespace videointelligence_v1p1beta1 { /** * videointelligence.videos.annotate - * @desc Performs asynchronous video annotation. Progress and results can be - * retrieved through the `google.longrunning.Operations` interface. - * `Operation.metadata` contains `AnnotateVideoProgress` (progress). - * `Operation.response` contains `AnnotateVideoResponse` (results). + * @desc Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results). * @alias videointelligence.videos.annotate * @memberOf! () * diff --git a/src/apis/videointelligence/v1p2beta1.ts b/src/apis/videointelligence/v1p2beta1.ts index a48b6b6bb3b..bf66eb08e40 100644 --- a/src/apis/videointelligence/v1p2beta1.ts +++ b/src/apis/videointelligence/v1p2beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace videointelligence_v1p2beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace videointelligence_v1p2beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace videointelligence_v1p2beta1 { /** * Cloud Video Intelligence API * - * Detects objects, explicit content, and scene changes in videos. It also - * specifies the region for annotation and transcribes speech to text. - * Supports both asynchronous API and streaming API. + * Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API. * * @example * const {google} = require('googleapis'); @@ -114,16 +108,17 @@ export namespace videointelligence_v1p2beta1 { videos: Resource$Videos; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.videos = new Resource$Videos(this.context); } } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { /** @@ -132,9 +127,7 @@ export namespace videointelligence_v1p2beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { /** @@ -151,8 +144,7 @@ export namespace videointelligence_v1p2beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -161,9 +153,7 @@ export namespace videointelligence_v1p2beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { /** @@ -180,8 +170,7 @@ export namespace videointelligence_v1p2beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -190,9 +179,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -217,8 +204,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -236,8 +222,7 @@ export namespace videointelligence_v1p2beta1 { segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingBox { /** @@ -258,14 +243,7 @@ export namespace videointelligence_v1p2beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingPoly { /** @@ -274,8 +252,7 @@ export namespace videointelligence_v1p2beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex { /** @@ -300,29 +277,20 @@ export namespace videointelligence_v1p2beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1beta2_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame { /** @@ -339,12 +307,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -361,23 +324,16 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation { /** @@ -390,9 +346,7 @@ export namespace videointelligence_v1p2beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextFrame { /** @@ -409,8 +363,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -427,13 +380,11 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -450,8 +401,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -459,13 +409,11 @@ export namespace videointelligence_v1p2beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -473,8 +421,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -482,8 +429,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -491,8 +437,7 @@ export namespace videointelligence_v1p2beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation[]; } @@ -501,51 +446,32 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -554,9 +480,7 @@ export namespace videointelligence_v1p2beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { /** @@ -565,9 +489,7 @@ export namespace videointelligence_v1p2beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { /** @@ -584,8 +506,7 @@ export namespace videointelligence_v1p2beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -594,9 +515,7 @@ export namespace videointelligence_v1p2beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { /** @@ -613,8 +532,7 @@ export namespace videointelligence_v1p2beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -623,9 +541,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -650,8 +566,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -669,8 +584,7 @@ export namespace videointelligence_v1p2beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox { /** @@ -691,14 +605,7 @@ export namespace videointelligence_v1p2beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingPoly { /** @@ -707,8 +614,7 @@ export namespace videointelligence_v1p2beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex { /** @@ -733,29 +639,20 @@ export namespace videointelligence_v1p2beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame { /** @@ -772,12 +669,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -794,23 +686,16 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation { /** @@ -823,9 +708,7 @@ export namespace videointelligence_v1p2beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextFrame { /** @@ -842,8 +725,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -860,13 +742,11 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -883,8 +763,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -892,13 +771,11 @@ export namespace videointelligence_v1p2beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -906,8 +783,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -915,8 +791,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -924,8 +799,7 @@ export namespace videointelligence_v1p2beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation[]; } @@ -934,51 +808,32 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -987,9 +842,7 @@ export namespace videointelligence_v1p2beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoProgress { /** @@ -1006,37 +859,19 @@ export namespace videointelligence_v1p2beta1 { */ features?: string[]; /** - * The video data bytes. If unset, the input video(s) should be specified - * via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ inputContent?: string; /** - * Input video location. Currently, only [Google Cloud - * Storage](https://cloud.google.com/storage/) URIs are supported, which - * must be specified in the following format: `gs://bucket-id/object-id` - * (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more - * information, see [Request URIs](/storage/docs/reference-uris). A video - * URI may include wildcards in `object-id`, and thus identify multiple - * videos. Supported wildcards: '*' to match 0 or more characters; - * '?' to match 1 character. If unset, the input video should be - * embedded in the request as `input_content`. If set, `input_content` - * should be unset. + * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ inputUri?: string; /** - * Optional cloud region where annotation should take place. Supported cloud - * regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no - * region is specified, a region will be determined based on video file - * location. + * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string; /** - * Optional location where the output (in JSON format) should be stored. - * Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) - * URIs are supported, which must be specified in the following format: - * `gs://bucket-id/object-id` (other URI formats return - * google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request - * URIs](/storage/docs/reference-uris). + * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string; /** @@ -1045,9 +880,7 @@ export namespace videointelligence_v1p2beta1 { videoContext?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoContext; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse { /** @@ -1064,8 +897,7 @@ export namespace videointelligence_v1p2beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1074,9 +906,7 @@ export namespace videointelligence_v1p2beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation { /** @@ -1089,9 +919,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentDetectionConfig { /** - * Model to use for explicit content detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } @@ -1104,8 +932,7 @@ export namespace videointelligence_v1p2beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1114,9 +941,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1137,39 +962,23 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from - * frame-level detection. If not set, it is set to 0.4 by default. The valid - * range for this threshold is [0.1, 0.9]. Any value set outside of this - * range will be clipped. Note: for best results please follow the default - * threshold. We will update the default threshold everytime when we release - * a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number; /** - * What labels should be detected with LABEL_DETECTION, in addition to - * video-level labels or segment-level labels. If unspecified, defaults to - * `SHOT_MODE`. + * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ labelDetectionMode?: string; /** - * Model to use for label detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** - * Whether the video has been shot from a stationary (i.e. non-moving) - * camera. When set to true, might improve detection accuracy for moving - * objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean; /** - * The confidence threshold we perform filtering on the labels from - * video-level and shot-level detections. If not set, it is set to 0.3 by - * default. The valid range for this threshold is [0.1, 0.9]. Any value set - * outside of this range will be clipped. Note: for best results please - * follow the default threshold. We will update the default threshold - * everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number; } @@ -1182,8 +991,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1201,8 +1009,7 @@ export namespace videointelligence_v1p2beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox { /** @@ -1223,14 +1030,7 @@ export namespace videointelligence_v1p2beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingPoly { /** @@ -1239,8 +1039,7 @@ export namespace videointelligence_v1p2beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex { /** @@ -1265,29 +1064,20 @@ export namespace videointelligence_v1p2beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame { /** @@ -1304,25 +1094,16 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ShotChangeDetectionConfig { /** - * Model to use for shot change detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases - * "hints" so that the speech recognition is more likely to - * recognize them. This can be used to improve the accuracy for specific - * words and phrases, for example, if specific commands are typically spoken - * by the user. This can also be used to add additional words to the - * vocabulary of the recognizer. See [usage - * limits](https://cloud.google.com/speech/limits#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[]; } @@ -1331,12 +1112,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1353,16 +1129,11 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } @@ -1371,63 +1142,35 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple - * audio tracks, specify up to two tracks. Default: track 0. + * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[]; /** - * *Optional* If set, specifies the estimated number of speakers in the - * conversation. If not set, defaults to '2'. Ignored unless - * enable_speaker_diarization is set to true. + * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number; /** - * *Optional* If 'true', adds punctuation to recognition result - * hypotheses. This feature is only available in select languages. Setting - * this for requests in other languages has no effect at all. The default - * 'false' value does not add punctuation to result hypotheses. - * NOTE: "This is currently offered as an experimental service, - * complimentary to all users. In the future this may be exclusively - * available as a premium feature." + * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean; /** - * *Optional* If 'true', enables speaker detection for each - * recognized word in the top alternative of the recognition result using a - * speaker_tag provided in the WordInfo. Note: When this is true, we send - * all the words from the beginning of the audio for the top alternative in - * every consecutive responses. This is done in order to improve our speaker - * tags as our models learn to identify the speakers in the conversation - * over time. + * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * confidence for those words. If `false`, no word-level confidence - * information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean; /** - * *Optional* If set to `true`, the server will attempt to filter out - * profanities, replacing all but the initial character in each filtered - * word with asterisks, e.g. "f***". If set to `false` or omitted, - * profanities won't be filtered out. + * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean; /** - * *Required* The language of the supplied audio as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". See [Language - * Support](https://cloud.google.com/speech/docs/languages) for a list of - * the currently supported language codes. + * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string; /** - * *Optional* Maximum number of recognition hypotheses to be returned. - * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechTranscription`. The server may return fewer - * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` - * will return a maximum of one. If omitted, will return a maximum of one. + * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -1436,9 +1179,7 @@ export namespace videointelligence_v1p2beta1 { speechContexts?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechContext[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** @@ -1455,17 +1196,12 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextDetectionConfig { /** - * Language hint can be specified if the language to be detected is known a - * priori. It can increase the accuracy of the detection. Language hint must - * be language code in BCP-47 format. Automatic language detection is - * performed if no hint is provided. + * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame { /** @@ -1482,8 +1218,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1500,13 +1235,11 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1523,8 +1256,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1532,13 +1264,11 @@ export namespace videointelligence_v1p2beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1546,8 +1276,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1555,8 +1284,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1564,8 +1292,7 @@ export namespace videointelligence_v1p2beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation[]; } @@ -1582,9 +1309,7 @@ export namespace videointelligence_v1p2beta1 { */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelDetectionConfig; /** - * Video segments to annotate. The segments may overlap and are not required - * to be contiguous or span the whole video. If unspecified, each video is - * treated as a single segment. + * Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment. */ segments?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** @@ -1605,51 +1330,32 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1658,9 +1364,7 @@ export namespace videointelligence_v1p2beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoProgress { /** @@ -1669,9 +1373,7 @@ export namespace videointelligence_v1p2beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoResponse { /** @@ -1688,8 +1390,7 @@ export namespace videointelligence_v1p2beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1698,9 +1399,7 @@ export namespace videointelligence_v1p2beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation { /** @@ -1717,8 +1416,7 @@ export namespace videointelligence_v1p2beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1727,9 +1425,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -1754,8 +1450,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1773,8 +1468,7 @@ export namespace videointelligence_v1p2beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox { /** @@ -1795,14 +1489,7 @@ export namespace videointelligence_v1p2beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingPoly { /** @@ -1811,8 +1498,7 @@ export namespace videointelligence_v1p2beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex { /** @@ -1837,29 +1523,20 @@ export namespace videointelligence_v1p2beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame { /** @@ -1876,12 +1553,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1898,23 +1570,16 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * `StreamingAnnotateVideoResponse` is the only message returned to the client - * by `StreamingAnnotateVideo`. A series of zero or more - * `StreamingAnnotateVideoResponse` messages are streamed back to the client. + * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingAnnotateVideoResponse { /** @@ -1922,20 +1587,16 @@ export namespace videointelligence_v1p2beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * GCS URI that stores annotation results of one streaming session. It is a - * directory that can hold multiple files in JSON format. Example uri - * format: gs://bucket_id/object_id/cloud_project_name-session_id + * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ annotationResultsUri?: string; /** - * If set, returns a google.rpc.Status message that specifies the error for - * the operation. + * If set, returns a google.rpc.Status message that specifies the error for the operation. */ error?: Schema$GoogleRpc_Status; } /** - * Streaming annotation results corresponding to a portion of the video that - * is currently being processed. + * Streaming annotation results corresponding to a portion of the video that is currently being processed. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults { /** @@ -1956,9 +1617,7 @@ export namespace videointelligence_v1p2beta1 { shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation { /** @@ -1971,9 +1630,7 @@ export namespace videointelligence_v1p2beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextFrame { /** @@ -1990,8 +1647,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2008,13 +1664,11 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2031,8 +1685,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2040,13 +1693,11 @@ export namespace videointelligence_v1p2beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2054,8 +1705,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2063,8 +1713,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2072,8 +1721,7 @@ export namespace videointelligence_v1p2beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation[]; } @@ -2082,51 +1730,32 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2135,9 +1764,7 @@ export namespace videointelligence_v1p2beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { /** @@ -2146,9 +1773,7 @@ export namespace videointelligence_v1p2beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { /** @@ -2165,8 +1790,7 @@ export namespace videointelligence_v1p2beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -2175,9 +1799,7 @@ export namespace videointelligence_v1p2beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { /** @@ -2194,8 +1816,7 @@ export namespace videointelligence_v1p2beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2204,9 +1825,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2231,8 +1850,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2250,8 +1868,7 @@ export namespace videointelligence_v1p2beta1 { segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingBox { /** @@ -2272,14 +1889,7 @@ export namespace videointelligence_v1p2beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingPoly { /** @@ -2288,8 +1898,7 @@ export namespace videointelligence_v1p2beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedVertex { /** @@ -2314,29 +1923,20 @@ export namespace videointelligence_v1p2beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame { /** @@ -2353,12 +1953,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -2375,23 +1970,16 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1_TextAnnotation { /** @@ -2404,9 +1992,7 @@ export namespace videointelligence_v1p2beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1_TextFrame { /** @@ -2423,8 +2009,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2441,13 +2026,11 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2464,8 +2047,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2473,13 +2055,11 @@ export namespace videointelligence_v1p2beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2487,8 +2067,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2496,8 +2075,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2505,8 +2083,7 @@ export namespace videointelligence_v1p2beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1_TextAnnotation[]; } @@ -2515,51 +2092,32 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2568,14 +2126,11 @@ export namespace videointelligence_v1p2beta1 { word?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunning_Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2583,64 +2138,20 @@ export namespace videointelligence_v1p2beta1 { */ error?: Schema$GoogleRpc_Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpc_Status { /** @@ -2648,14 +2159,11 @@ export namespace videointelligence_v1p2beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2668,10 +2176,7 @@ export namespace videointelligence_v1p2beta1 { /** * videointelligence.videos.annotate - * @desc Performs asynchronous video annotation. Progress and results can be - * retrieved through the `google.longrunning.Operations` interface. - * `Operation.metadata` contains `AnnotateVideoProgress` (progress). - * `Operation.response` contains `AnnotateVideoResponse` (results). + * @desc Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results). * @alias videointelligence.videos.annotate * @memberOf! () * diff --git a/src/apis/videointelligence/v1p3beta1.ts b/src/apis/videointelligence/v1p3beta1.ts index fec9cacf61d..851f36f3019 100644 --- a/src/apis/videointelligence/v1p3beta1.ts +++ b/src/apis/videointelligence/v1p3beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace videointelligence_v1p3beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace videointelligence_v1p3beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace videointelligence_v1p3beta1 { /** * Cloud Video Intelligence API * - * Detects objects, explicit content, and scene changes in videos. It also - * specifies the region for annotation and transcribes speech to text. - * Supports both asynchronous API and streaming API. + * Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API. * * @example * const {google} = require('googleapis'); @@ -114,16 +108,17 @@ export namespace videointelligence_v1p3beta1 { videos: Resource$Videos; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.videos = new Resource$Videos(this.context); } } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { /** @@ -132,9 +127,7 @@ export namespace videointelligence_v1p3beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { /** @@ -151,8 +144,7 @@ export namespace videointelligence_v1p3beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -161,9 +153,7 @@ export namespace videointelligence_v1p3beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { /** @@ -180,8 +170,7 @@ export namespace videointelligence_v1p3beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -190,9 +179,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -217,8 +204,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -236,8 +222,7 @@ export namespace videointelligence_v1p3beta1 { segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingBox { /** @@ -258,14 +243,7 @@ export namespace videointelligence_v1p3beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedBoundingPoly { /** @@ -274,8 +252,7 @@ export namespace videointelligence_v1p3beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_NormalizedVertex { /** @@ -300,29 +277,20 @@ export namespace videointelligence_v1p3beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1beta2_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingFrame { /** @@ -339,12 +307,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -361,23 +324,16 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation { /** @@ -390,9 +346,7 @@ export namespace videointelligence_v1p3beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextFrame { /** @@ -409,8 +363,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -427,13 +380,11 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -450,8 +401,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -459,13 +409,11 @@ export namespace videointelligence_v1p3beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -473,8 +421,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -482,8 +429,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -491,8 +437,7 @@ export namespace videointelligence_v1p3beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_TextAnnotation[]; } @@ -501,51 +446,32 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -554,9 +480,7 @@ export namespace videointelligence_v1p3beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { /** @@ -565,9 +489,7 @@ export namespace videointelligence_v1p3beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { /** @@ -584,8 +506,7 @@ export namespace videointelligence_v1p3beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -594,9 +515,7 @@ export namespace videointelligence_v1p3beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { /** @@ -613,8 +532,7 @@ export namespace videointelligence_v1p3beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -623,9 +541,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -650,8 +566,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -669,8 +584,7 @@ export namespace videointelligence_v1p3beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox { /** @@ -691,14 +605,7 @@ export namespace videointelligence_v1p3beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingPoly { /** @@ -707,8 +614,7 @@ export namespace videointelligence_v1p3beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex { /** @@ -733,29 +639,20 @@ export namespace videointelligence_v1p3beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingFrame { /** @@ -772,12 +669,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -794,23 +686,16 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation { /** @@ -823,9 +708,7 @@ export namespace videointelligence_v1p3beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextFrame { /** @@ -842,8 +725,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -860,13 +742,11 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -883,8 +763,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -892,13 +771,11 @@ export namespace videointelligence_v1p3beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -906,8 +783,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -915,8 +791,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -924,8 +799,7 @@ export namespace videointelligence_v1p3beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_TextAnnotation[]; } @@ -934,51 +808,32 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -987,9 +842,7 @@ export namespace videointelligence_v1p3beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoProgress { /** @@ -998,9 +851,7 @@ export namespace videointelligence_v1p3beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse { /** @@ -1017,8 +868,7 @@ export namespace videointelligence_v1p3beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1027,9 +877,7 @@ export namespace videointelligence_v1p3beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation { /** @@ -1046,8 +894,7 @@ export namespace videointelligence_v1p3beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1056,9 +903,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1083,8 +928,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1102,8 +946,7 @@ export namespace videointelligence_v1p3beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox { /** @@ -1124,14 +967,7 @@ export namespace videointelligence_v1p3beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingPoly { /** @@ -1140,8 +976,7 @@ export namespace videointelligence_v1p3beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex { /** @@ -1166,29 +1001,20 @@ export namespace videointelligence_v1p3beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame { /** @@ -1205,12 +1031,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1227,23 +1048,16 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** @@ -1256,9 +1070,7 @@ export namespace videointelligence_v1p3beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame { /** @@ -1275,8 +1087,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1293,13 +1104,11 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -1316,8 +1125,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -1325,13 +1133,11 @@ export namespace videointelligence_v1p3beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -1339,8 +1145,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1348,8 +1153,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1357,8 +1161,7 @@ export namespace videointelligence_v1p3beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation[]; } @@ -1367,51 +1170,32 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -1420,9 +1204,7 @@ export namespace videointelligence_v1p3beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoProgress { /** @@ -1439,37 +1221,19 @@ export namespace videointelligence_v1p3beta1 { */ features?: string[]; /** - * The video data bytes. If unset, the input video(s) should be specified - * via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. */ inputContent?: string; /** - * Input video location. Currently, only [Google Cloud - * Storage](https://cloud.google.com/storage/) URIs are supported, which - * must be specified in the following format: `gs://bucket-id/object-id` - * (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more - * information, see [Request URIs](/storage/docs/reference-uris). A video - * URI may include wildcards in `object-id`, and thus identify multiple - * videos. Supported wildcards: '*' to match 0 or more characters; - * '?' to match 1 character. If unset, the input video should be - * embedded in the request as `input_content`. If set, `input_content` - * should be unset. + * Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. */ inputUri?: string; /** - * Optional cloud region where annotation should take place. Supported cloud - * regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no - * region is specified, a region will be determined based on video file - * location. + * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string; /** - * Optional location where the output (in JSON format) should be stored. - * Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) - * URIs are supported, which must be specified in the following format: - * `gs://bucket-id/object-id` (other URI formats return - * google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request - * URIs](/storage/docs/reference-uris). + * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string; /** @@ -1478,9 +1242,7 @@ export namespace videointelligence_v1p3beta1 { videoContext?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoContext; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoResponse { /** @@ -1497,8 +1259,7 @@ export namespace videointelligence_v1p3beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -1507,9 +1268,7 @@ export namespace videointelligence_v1p3beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation { /** @@ -1522,9 +1281,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentDetectionConfig { /** - * Model to use for explicit content detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } @@ -1537,8 +1294,7 @@ export namespace videointelligence_v1p3beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1547,9 +1303,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -1570,39 +1324,23 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from - * frame-level detection. If not set, it is set to 0.4 by default. The valid - * range for this threshold is [0.1, 0.9]. Any value set outside of this - * range will be clipped. Note: for best results please follow the default - * threshold. We will update the default threshold everytime when we release - * a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number; /** - * What labels should be detected with LABEL_DETECTION, in addition to - * video-level labels or segment-level labels. If unspecified, defaults to - * `SHOT_MODE`. + * What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. */ labelDetectionMode?: string; /** - * Model to use for label detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** - * Whether the video has been shot from a stationary (i.e. non-moving) - * camera. When set to true, might improve detection accuracy for moving - * objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean; /** - * The confidence threshold we perform filtering on the labels from - * video-level and shot-level detections. If not set, it is set to 0.3 by - * default. The valid range for this threshold is [0.1, 0.9]. Any value set - * outside of this range will be clipped. Note: for best results please - * follow the default threshold. We will update the default threshold - * everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number; } @@ -1615,8 +1353,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -1634,8 +1371,7 @@ export namespace videointelligence_v1p3beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox { /** @@ -1656,14 +1392,7 @@ export namespace videointelligence_v1p3beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingPoly { /** @@ -1672,8 +1401,7 @@ export namespace videointelligence_v1p3beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex { /** @@ -1698,29 +1426,20 @@ export namespace videointelligence_v1p3beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingFrame { /** @@ -1737,25 +1456,16 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ShotChangeDetectionConfig { /** - * Model to use for shot change detection. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; } /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases - * "hints" so that the speech recognition is more likely to - * recognize them. This can be used to improve the accuracy for specific - * words and phrases, for example, if specific commands are typically spoken - * by the user. This can also be used to add additional words to the - * vocabulary of the recognizer. See [usage - * limits](https://cloud.google.com/speech/limits#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[]; } @@ -1764,12 +1474,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1786,16 +1491,11 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } @@ -1804,63 +1504,35 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple - * audio tracks, specify up to two tracks. Default: track 0. + * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[]; /** - * *Optional* If set, specifies the estimated number of speakers in the - * conversation. If not set, defaults to '2'. Ignored unless - * enable_speaker_diarization is set to true. + * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number; /** - * *Optional* If 'true', adds punctuation to recognition result - * hypotheses. This feature is only available in select languages. Setting - * this for requests in other languages has no effect at all. The default - * 'false' value does not add punctuation to result hypotheses. - * NOTE: "This is currently offered as an experimental service, - * complimentary to all users. In the future this may be exclusively - * available as a premium feature." + * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean; /** - * *Optional* If 'true', enables speaker detection for each - * recognized word in the top alternative of the recognition result using a - * speaker_tag provided in the WordInfo. Note: When this is true, we send - * all the words from the beginning of the audio for the top alternative in - * every consecutive responses. This is done in order to improve our speaker - * tags as our models learn to identify the speakers in the conversation - * over time. + * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean; /** - * *Optional* If `true`, the top result includes a list of words and the - * confidence for those words. If `false`, no word-level confidence - * information is returned. The default is `false`. + * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean; /** - * *Optional* If set to `true`, the server will attempt to filter out - * profanities, replacing all but the initial character in each filtered - * word with asterisks, e.g. "f***". If set to `false` or omitted, - * profanities won't be filtered out. + * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean; /** - * *Required* The language of the supplied audio as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". See [Language - * Support](https://cloud.google.com/speech/docs/languages) for a list of - * the currently supported language codes. + * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string; /** - * *Optional* Maximum number of recognition hypotheses to be returned. - * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechTranscription`. The server may return fewer - * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` - * will return a maximum of one. If omitted, will return a maximum of one. + * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -1869,9 +1541,7 @@ export namespace videointelligence_v1p3beta1 { speechContexts?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechContext[]; } /** - * `StreamingAnnotateVideoResponse` is the only message returned to the client - * by `StreamingAnnotateVideo`. A series of zero or more - * `StreamingAnnotateVideoResponse` messages are streamed back to the client. + * `StreamingAnnotateVideoResponse` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingAnnotateVideoResponse { /** @@ -1879,20 +1549,16 @@ export namespace videointelligence_v1p3beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * GCS URI that stores annotation results of one streaming session. It is a - * directory that can hold multiple files in JSON format. Example uri - * format: gs://bucket_id/object_id/cloud_project_name-session_id + * GCS URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id */ annotationResultsUri?: string; /** - * If set, returns a google.rpc.Status message that specifies the error for - * the operation. + * If set, returns a google.rpc.Status message that specifies the error for the operation. */ error?: Schema$GoogleRpc_Status; } /** - * Streaming annotation results corresponding to a portion of the video that - * is currently being processed. + * Streaming annotation results corresponding to a portion of the video that is currently being processed. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults { /** @@ -1913,9 +1579,7 @@ export namespace videointelligence_v1p3beta1 { shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation { /** @@ -1932,17 +1596,12 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextDetectionConfig { /** - * Language hint can be specified if the language to be detected is known a - * priori. It can increase the accuracy of the detection. Language hint must - * be language code in BCP-47 format. Automatic language detection is - * performed if no hint is provided. + * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextFrame { /** @@ -1959,8 +1618,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -1977,13 +1635,11 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2000,8 +1656,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2009,13 +1664,11 @@ export namespace videointelligence_v1p3beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2023,8 +1676,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2032,8 +1684,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2041,8 +1692,7 @@ export namespace videointelligence_v1p3beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_TextAnnotation[]; } @@ -2059,9 +1709,7 @@ export namespace videointelligence_v1p3beta1 { */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelDetectionConfig; /** - * Video segments to annotate. The segments may overlap and are not required - * to be contiguous or span the whole video. If unspecified, each video is - * treated as a single segment. + * Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment. */ segments?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** @@ -2082,51 +1730,32 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2135,9 +1764,7 @@ export namespace videointelligence_v1p3beta1 { word?: string; } /** - * Video annotation progress. Included in the `metadata` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { /** @@ -2146,9 +1773,7 @@ export namespace videointelligence_v1p3beta1 { annotationProgress?: Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress[]; } /** - * Video annotation response. Included in the `response` field of the - * `Operation` returned by the `GetOperation` call of the - * `google::longrunning::Operations` service. + * Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { /** @@ -2165,8 +1790,7 @@ export namespace videointelligence_v1p3beta1 { */ description?: string; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ entityId?: string; /** @@ -2175,9 +1799,7 @@ export namespace videointelligence_v1p3beta1 { languageCode?: string; } /** - * Explicit content annotation (based on per-frame visual signals only). If no - * explicit content has been detected in a frame, no annotations are present - * for that frame. + * Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame. */ export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { /** @@ -2194,8 +1816,7 @@ export namespace videointelligence_v1p3beta1 { */ pornographyLikelihood?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2204,9 +1825,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is - * `Terrier` the category is likely `dog`. And in some cases there might be - * more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2231,8 +1850,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * video frame for this location. + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. */ timeOffset?: string; } @@ -2250,8 +1868,7 @@ export namespace videointelligence_v1p3beta1 { segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; } /** - * Normalized bounding box. The normalized vertex coordinates are relative to - * the original image. Range: [0, 1]. + * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingBox { /** @@ -2272,14 +1889,7 @@ export namespace videointelligence_v1p3beta1 { top?: number; } /** - * Normalized bounding polygon for text (that might not be aligned with axis). - * Contains list of the corner points in clockwise order starting from - * top-left corner. For example, for a rectangular bounding box: When the text - * is horizontal it might look like: 0----1 | | 3----2 When - * it's clockwise rotated 180 degrees around the top-left corner it - * becomes: 2----3 | | 1----0 and the vertex order - * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater - * than 1 due to trignometric calculations for location of the box. + * Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedBoundingPoly { /** @@ -2288,8 +1898,7 @@ export namespace videointelligence_v1p3beta1 { vertices?: Schema$GoogleCloudVideointelligenceV1_NormalizedVertex[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVideointelligenceV1_NormalizedVertex { /** @@ -2314,29 +1923,20 @@ export namespace videointelligence_v1p3beta1 { */ entity?: Schema$GoogleCloudVideointelligenceV1_Entity; /** - * Information corresponding to all frames where this object track appears. - * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - * messages in frames. Streaming mode: it can only be one - * ObjectTrackingFrame message in frames. + * Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. */ frames?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame[]; /** - * Non-streaming batch mode ONLY. Each object track corresponds to one video - * segment where it appears. + * Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Streaming mode ONLY. In streaming mode, we do not know the end time of a - * tracked object before it is completed. Hence, there is no VideoSegment - * info returned. Instead, we provide a unique identifiable integer track_id - * so that the customers can correlate the results of the ongoing - * ObjectTrackAnnotation of the same track_id over time. + * Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. */ trackId?: string; } /** - * Video frame level annotations for object detection and tracking. This field - * stores per frame location, time offset, and confidence. + * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ export interface Schema$GoogleCloudVideointelligenceV1_ObjectTrackingFrame { /** @@ -2353,12 +1953,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * The confidence estimate between 0.0 and 1.0. A higher number indicates an - * estimated greater likelihood that the recognized words are correct. This - * field is typically provided only for the top hypothesis, and only for - * `is_final=true` results. Clients should not rely on the `confidence` - * field as it is not guaranteed to be accurate or consistent. The default - * of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for `is_final=true` results. Clients should not rely on the `confidence` field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -2375,23 +1970,16 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { /** - * May contain one or more recognition hypotheses (up to the maximum - * specified in `max_alternatives`). These alternatives are ordered in - * terms of accuracy, with the top (first) alternative being the most - * probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - * language tag of the language in this result. This language code was - * detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection. */ export interface Schema$GoogleCloudVideointelligenceV1_TextAnnotation { /** @@ -2404,9 +1992,7 @@ export namespace videointelligence_v1p3beta1 { text?: string; } /** - * Video frame level annotation results for text annotation (OCR). Contains - * information regarding timestamp and bounding box locations for the frames - * containing detected OCR text snippets. + * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. */ export interface Schema$GoogleCloudVideointelligenceV1_TextFrame { /** @@ -2423,8 +2009,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_TextSegment { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. */ confidence?: number; /** @@ -2441,13 +2026,11 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Approximate percentage processed thus far. Guaranteed to be 100 when - * fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; /** @@ -2464,8 +2047,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { /** - * If set, indicates an error. Note that for a single `AnnotateVideoRequest` - * some videos may succeed and some may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -2473,13 +2055,11 @@ export namespace videointelligence_v1p3beta1 { */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; /** - * Label annotations on frame level. There is exactly one element for each - * unique label. + * Label annotations on frame level. There is exactly one element for each unique label. */ frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Video file location in [Google Cloud - * Storage](https://cloud.google.com/storage/). + * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** @@ -2487,8 +2067,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There - * is exactly one element for each unique label. + * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2496,8 +2075,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each - * unique label. + * Label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2505,8 +2083,7 @@ export namespace videointelligence_v1p3beta1 { */ speechTranscriptions?: Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; /** - * OCR text detection and tracking. Annotations for list of detected text - * snippets. Each will have list of frame information associated with it. + * OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. */ textAnnotations?: Schema$GoogleCloudVideointelligenceV1_TextAnnotation[]; } @@ -2515,51 +2092,32 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { /** - * Time-offset, relative to the beginning of the video, corresponding to the - * end of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). */ endTimeOffset?: string; /** - * Time-offset, relative to the beginning of the video, corresponding to the - * start of the segment (inclusive). + * Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). */ startTimeOffset?: string; } /** - * Word-specific information for recognized words. Word information is only - * included in the response when certain request parameters are set, such as - * `enable_word_time_offsets`. + * Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as `enable_word_time_offsets`. */ export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is set only for the top alternative. This field is - * not guaranteed to be accurate and users should not rely on it to be - * always provided. The default of 0.0 is a sentinel value indicating - * `confidence` was not set. + * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the end of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. A distinct integer value is assigned for every speaker - * within the audio. This field specifies which one of those speakers was - * detected to have spoken this word. Value ranges from 1 up to - * diarization_speaker_count, and is only set if speaker diarization is - * enabled. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. */ speakerTag?: number; /** - * Time offset relative to the beginning of the audio, and corresponding to - * the start of the spoken word. This field is only set if - * `enable_word_time_offsets=true` and only in the top hypothesis. This is - * an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** @@ -2568,14 +2126,11 @@ export namespace videointelligence_v1p3beta1 { word?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$GoogleLongrunning_Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -2583,64 +2138,20 @@ export namespace videointelligence_v1p3beta1 { */ error?: Schema$GoogleRpc_Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$GoogleRpc_Status { /** @@ -2648,14 +2159,11 @@ export namespace videointelligence_v1p3beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -2668,10 +2176,7 @@ export namespace videointelligence_v1p3beta1 { /** * videointelligence.videos.annotate - * @desc Performs asynchronous video annotation. Progress and results can be - * retrieved through the `google.longrunning.Operations` interface. - * `Operation.metadata` contains `AnnotateVideoProgress` (progress). - * `Operation.response` contains `AnnotateVideoResponse` (results). + * @desc Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results). * @alias videointelligence.videos.annotate * @memberOf! () * diff --git a/src/apis/vision/package.json b/src/apis/vision/package.json index fe36cf7c19d..bbd25daa28a 100644 --- a/src/apis/vision/package.json +++ b/src/apis/vision/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 72a406b6f9f..573437adece 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace vision_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace vision_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace vision_v1 { /** * Cloud Vision API * - * Integrates Google Vision features, including image labeling, face, logo, - * and landmark detection, optical character recognition (OCR), and detection - * of explicit content, into applications. + * Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications. * * @example * const {google} = require('googleapis'); @@ -118,7 +112,10 @@ export namespace vision_v1 { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.files = new Resource$Files(this.context); this.images = new Resource$Images(this.context); @@ -133,14 +130,33 @@ export namespace vision_v1 { */ export interface Schema$AddProductToProductSetRequest { /** - * The resource name for the Product to be added to this ProductSet. Format - * is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * A request to annotate one single file, e.g. a PDF, TIFF or GIF file. + */ + export interface Schema$AnnotateFileRequest { + /** + * Required. Requested features. + */ + features?: Schema$Feature[]; + /** + * Additional context that may accompany the image(s) in the file. + */ + imageContext?: Schema$ImageContext; + /** + * Required. Information about the input file. + */ + inputConfig?: Schema$InputConfig; + /** + * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. + */ + pages?: number[]; + } + /** + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$AnnotateFileResponse { /** @@ -151,10 +167,13 @@ export namespace vision_v1 { * Individual responses to images found within the file. */ responses?: Schema$AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** - * Request for performing Google Cloud Vision API tasks over a user-provided - * image, with user-requested features, and with context information. + * Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information. */ export interface Schema$AnnotateImageRequest { /** @@ -175,8 +194,7 @@ export namespace vision_v1 { */ export interface Schema$AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$ImageAnnotationContext; /** @@ -184,9 +202,7 @@ export namespace vision_v1 { */ cropHintsAnnotation?: Schema$CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -194,9 +210,7 @@ export namespace vision_v1 { */ faceAnnotations?: Schema$FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$TextAnnotation; /** @@ -212,8 +226,7 @@ export namespace vision_v1 { */ landmarkAnnotations?: Schema$EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$LocalizedObjectAnnotation[]; /** @@ -268,8 +281,7 @@ export namespace vision_v1 { outputConfig?: Schema$OutputConfig; } /** - * Multiple async file annotation requests are batched into a single service - * call. + * Multiple async file annotation requests are batched into a single service call. */ export interface Schema$AsyncBatchAnnotateFilesRequest { /** @@ -282,11 +294,50 @@ export namespace vision_v1 { */ export interface Schema$AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$AsyncAnnotateFileResponse[]; } + /** + * Request for async image annotation for a list of images. + */ + export interface Schema$AsyncBatchAnnotateImagesRequest { + /** + * Required. The desired output location and metadata (e.g. format). + */ + outputConfig?: Schema$OutputConfig; + /** + * Individual image annotation requests for this batch. + */ + requests?: Schema$AnnotateImageRequest[]; + } + /** + * Response to an async batch image annotation request. + */ + export interface Schema$AsyncBatchAnnotateImagesResponse { + /** + * The output location and metadata from AsyncBatchAnnotateImagesRequest. + */ + outputConfig?: Schema$OutputConfig; + } + /** + * A list of requests to annotate files using the BatchAnnotateFiles API. + */ + export interface Schema$BatchAnnotateFilesRequest { + /** + * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + requests?: Schema$AnnotateFileRequest[]; + } + /** + * A list of file annotation responses. + */ + export interface Schema$BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$AnnotateFileResponse[]; + } /** * Multiple image annotation requests are batched into a single service call. */ @@ -306,14 +357,11 @@ export namespace vision_v1 { responses?: Schema$AnnotateImageResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -334,14 +382,7 @@ export namespace vision_v1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -375,72 +416,11 @@ export namespace vision_v1 { */ export interface Schema$CancelOperationRequest {} /** - * Represents a color in the RGBA color space. This representation is designed - * for simplicity of conversion to/from color representations in various - * languages over compactness; for example, the fields of this representation - * can be trivially provided to the constructor of "java.awt.Color" - * in Java; it can also be trivially provided to UIColor's - * "+colorWithRed:green:blue:alpha" method in iOS; and, with just a - * little work, it can be easily formatted into a CSS "rgba()" - * string in JavaScript, as well. Note: this proto does not carry information - * about the absolute color space that should be used to interpret the RGB - * value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, - * applications SHOULD assume the sRGB color space. Example (Java): import - * com.google.type.Color; // ... public static java.awt.Color - * fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? - * protocolor.getAlpha().getValue() : 1.0; return new - * java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - * protocolor.getBlue(), alpha); } public static Color - * toProto(java.awt.Color color) { float red = (float) color.getRed(); - * float green = (float) color.getGreen(); float blue = (float) - * color.getBlue(); float denominator = 255.0; Color.Builder - * resultBuilder = Color .newBuilder() .setRed(red / - * denominator) .setGreen(green / denominator) .setBlue(blue / - * denominator); int alpha = color.getAlpha(); if (alpha != 255) - * { result.setAlpha( FloatValue .newBuilder() - * .setValue(((float) alpha) / denominator) .build()); } - * return resultBuilder.build(); } // ... Example (iOS / Obj-C): // - * ... static UIColor* fromProto(Color* protocolor) { float red = - * [protocolor red]; float green = [protocolor green]; float - * blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor - * alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { - * alpha = [alpha_wrapper value]; } return [UIColor - * colorWithRed:red green:green blue:blue alpha:alpha]; } static - * Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; - * if (![color getRed:&red green:&green blue:&blue - * alpha:&alpha]) { return nil; } Color* - * result = [[Color alloc] init]; [result setRed:red]; [result - * setGreen:green]; [result setBlue:blue]; if (alpha <= - * 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } - * [result autorelease]; return result; } // ... Example - * (JavaScript): // ... var protoToCssColor = function(rgb_color) { - * var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green - * || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = - * Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); - * var blue = Math.floor(blueFrac * 255); if (!('alpha' in - * rgb_color)) { return rgbToCssColor_(red, green, blue); } - * var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - * green, blue].join(','); return ['rgba(', rgbParams, - * ',', alphaFrac, ')'].join(''); }; var - * rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new - * Number((red << 16) | (green << 8) | blue); var hexString - * = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; - * var resultBuilder = ['#']; for (var i = 0; i < - * missingZeros; i++) { resultBuilder.push('0'); } - * resultBuilder.push(hexString); return resultBuilder.join(''); - * }; // ... + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... */ export interface Schema$Color { /** - * The fraction of this color that should be applied to the pixel. That is, - * the final pixel color is defined by the equation: pixel color = alpha - * * (this color) + (1.0 - alpha) * (background color) This means that a - * value of 1.0 corresponds to a solid color, whereas a value of 0.0 - * corresponds to a completely transparent color. This uses a wrapper - * message rather than a simple float scalar so that it is possible to - * distinguish between a default value and the value being unset. If - * omitted, this color object is to be rendered as a solid color (as if the - * alpha value had been explicitly given with a value of 1.0). + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ alpha?: number; /** @@ -457,8 +437,7 @@ export namespace vision_v1 { red?: number; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$ColorInfo { /** @@ -466,8 +445,7 @@ export namespace vision_v1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -480,8 +458,7 @@ export namespace vision_v1 { */ export interface Schema$CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$BoundingPoly; /** @@ -489,8 +466,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -508,12 +484,7 @@ export namespace vision_v1 { */ export interface Schema$CropHintsParams { /** - * Aspect ratios in floats, representing the ratio of the width to the - * height of the image. For example, if the desired aspect ratio is 4/3, the - * corresponding float value should be 1.33333. If not specified, the best - * possible crop is returned. The number of provided aspect ratios is - * limited to a maximum of 16; any aspect ratios provided after the 16th are - * ignored. + * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ aspectRatios?: number[]; } @@ -539,9 +510,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -555,11 +524,7 @@ export namespace vision_v1 { colors?: Schema$ColorInfo[]; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -567,15 +532,11 @@ export namespace vision_v1 { */ export interface Schema$EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -583,26 +544,19 @@ export namespace vision_v1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$Property[]; /** @@ -610,12 +564,7 @@ export namespace vision_v1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -632,13 +581,7 @@ export namespace vision_v1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$BoundingPoly; /** @@ -646,12 +589,7 @@ export namespace vision_v1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$BoundingPoly; /** @@ -671,15 +609,11 @@ export namespace vision_v1 { */ landmarks?: Schema$Landmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -691,8 +625,7 @@ export namespace vision_v1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -701,20 +634,15 @@ export namespace vision_v1 { underExposedLikelihood?: string; } /** - * The type of Google Cloud Vision API detection to perform, and the maximum - * number of results to return for that type. Multiple `Feature` objects can - * be specified in the `features` list. + * The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. */ export interface Schema$Feature { /** - * Maximum number of results of this type. Does not apply to - * `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + * Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. */ maxResults?: number; /** - * Model to use for the feature. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** @@ -727,22 +655,7 @@ export namespace vision_v1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -751,14 +664,12 @@ export namespace vision_v1 { */ export interface Schema$GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateFileResponse { /** @@ -769,14 +680,17 @@ export namespace vision_v1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext; /** @@ -784,9 +698,7 @@ export namespace vision_v1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p1beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -794,9 +706,7 @@ export namespace vision_v1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p1beta1TextAnnotation; /** @@ -812,8 +722,7 @@ export namespace vision_v1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation[]; /** @@ -851,8 +760,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse[]; } @@ -865,14 +773,7 @@ export namespace vision_v1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -902,8 +803,7 @@ export namespace vision_v1 { vertices?: Schema$GoogleCloudVisionV1p1beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p1beta1ColorInfo { /** @@ -911,8 +811,7 @@ export namespace vision_v1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -925,8 +824,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -934,8 +832,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -962,15 +859,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -978,26 +871,19 @@ export namespace vision_v1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p1beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p1beta1Property[]; /** @@ -1005,12 +891,7 @@ export namespace vision_v1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -1027,13 +908,7 @@ export namespace vision_v1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1041,12 +916,7 @@ export namespace vision_v1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1066,15 +936,11 @@ export namespace vision_v1 { */ landmarks?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -1086,8 +952,7 @@ export namespace vision_v1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -1113,22 +978,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -1137,19 +987,16 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -1170,13 +1017,16 @@ export namespace vision_v1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p1beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p1beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -1189,9 +1039,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -1217,8 +1065,7 @@ export namespace vision_v1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p1beta1NormalizedVertex { /** @@ -1252,14 +1099,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -1280,8 +1120,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -1289,8 +1128,7 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -1299,14 +1137,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1323,9 +1154,7 @@ export namespace vision_v1 { words?: Schema$GoogleCloudVisionV1p1beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p1beta1Position { /** @@ -1346,34 +1175,23 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; } @@ -1382,13 +1200,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -1397,16 +1213,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult[]; /** @@ -1415,8 +1226,7 @@ export namespace vision_v1 { results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult { /** @@ -1433,8 +1243,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -1442,8 +1251,7 @@ export namespace vision_v1 { */ product?: Schema$GoogleCloudVisionV1p1beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -1465,15 +1273,11 @@ export namespace vision_v1 { value?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p1beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -1481,15 +1285,11 @@ export namespace vision_v1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -1502,14 +1302,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1526,13 +1319,7 @@ export namespace vision_v1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p1beta1TextAnnotation { /** @@ -1566,9 +1353,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -1586,8 +1371,7 @@ export namespace vision_v1 { detectedLanguages?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p1beta1Vertex { /** @@ -1604,13 +1388,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1618,9 +1400,7 @@ export namespace vision_v1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1645,8 +1425,7 @@ export namespace vision_v1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -1672,9 +1451,7 @@ export namespace vision_v1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -1683,8 +1460,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1692,9 +1468,7 @@ export namespace vision_v1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1711,14 +1485,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1730,14 +1497,12 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p1beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse { /** @@ -1748,14 +1513,17 @@ export namespace vision_v1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext; /** @@ -1763,9 +1531,7 @@ export namespace vision_v1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -1773,9 +1539,7 @@ export namespace vision_v1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p2beta1TextAnnotation; /** @@ -1791,8 +1555,7 @@ export namespace vision_v1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation[]; /** @@ -1830,8 +1593,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse[]; } @@ -1844,14 +1606,7 @@ export namespace vision_v1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1881,8 +1636,7 @@ export namespace vision_v1 { vertices?: Schema$GoogleCloudVisionV1p2beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p2beta1ColorInfo { /** @@ -1890,8 +1644,7 @@ export namespace vision_v1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -1904,8 +1657,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1913,8 +1665,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -1941,15 +1692,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -1957,26 +1704,19 @@ export namespace vision_v1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p2beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p2beta1Property[]; /** @@ -1984,12 +1724,7 @@ export namespace vision_v1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -2006,13 +1741,7 @@ export namespace vision_v1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2020,12 +1749,7 @@ export namespace vision_v1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2045,15 +1769,11 @@ export namespace vision_v1 { */ landmarks?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -2065,8 +1785,7 @@ export namespace vision_v1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -2092,22 +1811,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -2116,19 +1820,16 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -2149,13 +1850,16 @@ export namespace vision_v1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p2beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2168,9 +1872,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -2196,8 +1898,7 @@ export namespace vision_v1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p2beta1NormalizedVertex { /** @@ -2231,14 +1932,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -2259,8 +1953,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -2268,8 +1961,7 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -2278,14 +1970,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2302,9 +1987,7 @@ export namespace vision_v1 { words?: Schema$GoogleCloudVisionV1p2beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p2beta1Position { /** @@ -2325,34 +2008,23 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; } @@ -2361,13 +2033,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -2376,16 +2046,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult[]; /** @@ -2394,8 +2059,7 @@ export namespace vision_v1 { results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult { /** @@ -2412,8 +2076,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -2421,8 +2084,7 @@ export namespace vision_v1 { */ product?: Schema$GoogleCloudVisionV1p2beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -2444,15 +2106,11 @@ export namespace vision_v1 { value?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -2460,15 +2118,11 @@ export namespace vision_v1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -2481,14 +2135,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2505,13 +2152,7 @@ export namespace vision_v1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { /** @@ -2545,9 +2186,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -2565,8 +2204,7 @@ export namespace vision_v1 { detectedLanguages?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p2beta1Vertex { /** @@ -2583,13 +2221,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2597,9 +2233,7 @@ export namespace vision_v1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2624,8 +2258,7 @@ export namespace vision_v1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -2651,9 +2284,7 @@ export namespace vision_v1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -2662,8 +2293,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2671,9 +2301,7 @@ export namespace vision_v1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2690,14 +2318,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2709,14 +2330,12 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p2beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p3beta1AnnotateFileResponse { /** @@ -2727,14 +2346,17 @@ export namespace vision_v1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext; /** @@ -2742,9 +2364,7 @@ export namespace vision_v1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p3beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -2752,9 +2372,7 @@ export namespace vision_v1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p3beta1TextAnnotation; /** @@ -2770,8 +2388,7 @@ export namespace vision_v1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p3beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation[]; /** @@ -2809,20 +2426,16 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p3beta1BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -2843,14 +2456,7 @@ export namespace vision_v1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2880,8 +2486,7 @@ export namespace vision_v1 { vertices?: Schema$GoogleCloudVisionV1p3beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p3beta1ColorInfo { /** @@ -2889,8 +2494,7 @@ export namespace vision_v1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -2903,8 +2507,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2912,8 +2515,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -2940,15 +2542,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -2956,26 +2554,19 @@ export namespace vision_v1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p3beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p3beta1Property[]; /** @@ -2983,12 +2574,7 @@ export namespace vision_v1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -3005,13 +2591,7 @@ export namespace vision_v1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3019,12 +2599,7 @@ export namespace vision_v1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3044,15 +2619,11 @@ export namespace vision_v1 { */ landmarks?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -3064,8 +2635,7 @@ export namespace vision_v1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -3091,22 +2661,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -3115,19 +2670,16 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -3145,9 +2697,7 @@ export namespace vision_v1 { dominantColors?: Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p3beta1ImportProductSetsResponse { /** @@ -3155,10 +2705,7 @@ export namespace vision_v1 { */ referenceImages?: Schema$GoogleCloudVisionV1p3beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -3166,13 +2713,16 @@ export namespace vision_v1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p3beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p3beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -3185,9 +2735,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -3213,8 +2761,7 @@ export namespace vision_v1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p3beta1NormalizedVertex { /** @@ -3248,14 +2795,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -3276,8 +2816,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -3285,8 +2824,7 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -3295,14 +2833,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3319,9 +2850,7 @@ export namespace vision_v1 { words?: Schema$GoogleCloudVisionV1p3beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p3beta1Position { /** @@ -3342,34 +2871,23 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p3beta1ProductKeyValue[]; } @@ -3378,13 +2896,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -3393,16 +2909,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult[]; /** @@ -3411,8 +2922,7 @@ export namespace vision_v1 { results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult { /** @@ -3429,8 +2939,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -3438,8 +2947,7 @@ export namespace vision_v1 { */ product?: Schema$GoogleCloudVisionV1p3beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -3461,41 +2969,28 @@ export namespace vision_v1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p3beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -3503,15 +2998,11 @@ export namespace vision_v1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -3524,14 +3015,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3548,13 +3032,7 @@ export namespace vision_v1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p3beta1TextAnnotation { /** @@ -3588,9 +3066,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -3608,8 +3084,7 @@ export namespace vision_v1 { detectedLanguages?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p3beta1Vertex { /** @@ -3626,13 +3101,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3640,9 +3113,7 @@ export namespace vision_v1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3667,8 +3138,7 @@ export namespace vision_v1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -3694,9 +3164,7 @@ export namespace vision_v1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -3705,8 +3173,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3714,9 +3181,7 @@ export namespace vision_v1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3733,14 +3198,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3752,14 +3210,12 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p3beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse { /** @@ -3780,8 +3236,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext; /** @@ -3789,9 +3244,7 @@ export namespace vision_v1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -3799,9 +3252,7 @@ export namespace vision_v1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p4beta1TextAnnotation; /** @@ -3817,8 +3268,7 @@ export namespace vision_v1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; /** @@ -3856,8 +3306,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; } @@ -3875,20 +3324,16 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { /** - * The list of file annotation responses, each response corresponding to - * each AnnotateFileRequest in BatchAnnotateFilesRequest. + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -3909,14 +3354,7 @@ export namespace vision_v1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3946,8 +3384,7 @@ export namespace vision_v1 { vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { /** @@ -3955,8 +3392,7 @@ export namespace vision_v1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -3969,8 +3405,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -3978,8 +3413,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -4006,15 +3440,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -4022,26 +3452,19 @@ export namespace vision_v1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; /** @@ -4049,12 +3472,7 @@ export namespace vision_v1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -4071,13 +3489,7 @@ export namespace vision_v1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4085,12 +3497,7 @@ export namespace vision_v1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4110,15 +3517,11 @@ export namespace vision_v1 { */ landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -4130,8 +3533,7 @@ export namespace vision_v1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -4157,22 +3559,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -4181,19 +3568,16 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -4211,9 +3595,7 @@ export namespace vision_v1 { dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** @@ -4221,10 +3603,7 @@ export namespace vision_v1 { */ referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -4233,11 +3612,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` - * fields, protobuffers use a pure binary representation, whereas JSON - * representations use base64. Currently, this field only works for - * BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles - * requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string; /** @@ -4245,8 +3620,7 @@ export namespace vision_v1 { */ gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -4259,9 +3633,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -4287,8 +3659,7 @@ export namespace vision_v1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { /** @@ -4322,14 +3693,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -4350,8 +3714,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -4359,8 +3722,7 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -4369,14 +3731,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4393,9 +3748,7 @@ export namespace vision_v1 { words?: Schema$GoogleCloudVisionV1p4beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p4beta1Position { /** @@ -4416,34 +3769,23 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } @@ -4452,13 +3794,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -4467,16 +3807,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; /** @@ -4485,8 +3820,7 @@ export namespace vision_v1 { results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { /** @@ -4503,8 +3837,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -4512,8 +3845,7 @@ export namespace vision_v1 { */ product?: Schema$GoogleCloudVisionV1p4beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -4535,41 +3867,28 @@ export namespace vision_v1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -4577,15 +3896,11 @@ export namespace vision_v1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -4598,14 +3913,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4622,13 +3930,7 @@ export namespace vision_v1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** @@ -4662,9 +3964,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -4682,8 +3982,7 @@ export namespace vision_v1 { detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p4beta1Vertex { /** @@ -4700,13 +3999,11 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4714,9 +4011,7 @@ export namespace vision_v1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4741,8 +4036,7 @@ export namespace vision_v1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -4768,9 +4062,7 @@ export namespace vision_v1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -4779,8 +4071,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4788,9 +4079,7 @@ export namespace vision_v1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4807,14 +4096,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4826,326 +4108,1240 @@ export namespace vision_v1 { */ property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; } /** - * Information about the products similar to a single product in a query - * image. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ - export interface Schema$GroupedResult { + export interface Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse { /** - * The bounding polygon around the product detected in the query image. + * Information about the file for which this response is generated. */ - boundingPoly?: Schema$BoundingPoly; + inputConfig?: Schema$GoogleCloudVisionV1p5beta1InputConfig; /** - * List of results, one for each product match. + * Individual responses to images found within the file. */ - results?: Schema$Result[]; + responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** - * Client image to perform Google Cloud Vision API tasks over. + * Response to an image annotation request. */ - export interface Schema$Image { + export interface Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse { /** - * Image content, represented as a stream of bytes. Note: As with all - * `bytes` fields, protobuffers use a pure binary representation, whereas - * JSON representations use base64. + * If present, contextual information is needed to understand where this image comes from. */ - content?: string; + context?: Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext; /** - * Google Cloud Storage image location, or publicly-accessible image URL. If - * both `content` and `source` are provided for an image, `content` takes - * precedence and is used to perform the image annotation request. + * If present, crop hints have completed successfully. */ - source?: Schema$ImageSource; - } - /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. - */ - export interface Schema$ImageAnnotationContext { + cropHintsAnnotation?: Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation; /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ - pageNumber?: number; + error?: Schema$Status; /** - * The URI of the file used to produce the image. + * If present, face detection has completed successfully. */ - uri?: string; - } - /** - * Image context and/or feature-specific parameters. - */ - export interface Schema$ImageContext { + faceAnnotations?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotation[]; /** - * Parameters for crop hints annotation request. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ - cropHintsParams?: Schema$CropHintsParams; + fullTextAnnotation?: Schema$GoogleCloudVisionV1p5beta1TextAnnotation; /** - * List of languages to use for TEXT_DETECTION. In most cases, an empty - * value yields the best results since it enables automatic language - * detection. For languages based on the Latin alphabet, setting - * `language_hints` is not needed. In rare cases, when the language of the - * text in the image is known, setting a hint will help get better results - * (although it will be a significant hindrance if the hint is wrong). Text - * detection returns an error if one or more of the specified languages is - * not one of the [supported languages](/vision/docs/languages). + * If present, image properties were extracted successfully. */ - languageHints?: string[]; + imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p5beta1ImageProperties; /** - * Not used. + * If present, label detection has completed successfully. */ - latLongRect?: Schema$LatLongRect; + labelAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * Parameters for product search. + * If present, landmark detection has completed successfully. */ - productSearchParams?: Schema$ProductSearchParams; + landmarkAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * Parameters for web detection. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ - webDetectionParams?: Schema$WebDetectionParams; - } - /** - * Stores image properties, such as dominant colors. - */ - export interface Schema$ImageProperties { + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation[]; /** - * If present, dominant colors completed successfully. + * If present, logo detection has completed successfully. */ - dominantColors?: Schema$DominantColorsAnnotation; - } - /** - * External image source (Google Cloud Storage or web URL image location). - */ - export interface Schema$ImageSource { + logoAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResults; /** - * **Use `image_uri` instead.** The Google Cloud Storage URI of the form - * `gs://bucket_name/object_name`. Object versioning is not supported. See - * [Google Cloud Storage Request - * URIs](https://cloud.google.com/storage/docs/reference-uris) for more - * info. + * If present, safe-search annotation has completed successfully. */ - gcsImageUri?: string; + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation; /** - * The URI of the source image. Can be either: 1. A Google Cloud Storage - * URI of the form `gs://bucket_name/object_name`. Object versioning is - * not supported. See [Google Cloud Storage Request - * URIs](https://cloud.google.com/storage/docs/reference-uris) for more - * info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching - * images from HTTP/HTTPS URLs, Google cannot guarantee that the request - * will be completed. Your request may fail if the specified host denies - * the request (e.g. due to request throttling or DOS prevention), or if - * Google throttles requests to the site for abuse prevention. You should - * not depend on externally-hosted images for production applications. - * When both `gcs_image_uri` and `image_uri` are specified, `image_uri` - * takes precedence. + * If present, text (OCR) detection has completed successfully. */ - imageUri?: string; + textAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection?: Schema$GoogleCloudVisionV1p5beta1WebDetection; } /** - * The Google Cloud Storage location for a csv file which preserves a list of - * ImportProductSetRequests in each line. + * The response for a single offline file annotation request. */ - export interface Schema$ImportProductSetsGcsSource { + export interface Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse { /** - * The Google Cloud Storage URI of the input csv file. The URI must start - * with `gs://`. The format of the input csv file should be one image per - * line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. - * product-set-id 4. product-id 5. product-category 6. - * product-display-name 7. labels 8. bounding-poly The `image-uri`, - * `product-set-id`, `product-id`, and `product-category` columns are - * required. All other columns are optional. If the `ProductSet` or - * `Product` specified by the `product-set-id` and `product-id` values does - * not exist, then the system will create a new `ProductSet` or `Product` - * for the image. In this case, the `product-display-name` column refers to - * display_name, the `product-category` column refers to product_category, - * and the `labels` column refers to product_labels. The `image-id` column - * is optional but must be unique if provided. If it is empty, the system - * will automatically assign a unique id to the image. The - * `product-display-name` column is optional. If it is empty, the system - * sets the display_name field for the product to a space (" "). - * You can update the `display_name` later by using the API. If a `Product` - * with the specified `product-id` already exists, then the system ignores - * the `product-display-name`, `product-category`, and `labels` columns. The - * `labels` column (optional) is a line containing a list of comma-separated - * key-value pairs, in the following format: - * "key_1=value_1,key_2=value_2,...,key_n=value_n" The - * `bounding-poly` column (optional) identifies one region of interest from - * the image in the same manner as `CreateReferenceImage`. If you do not - * specify the `bounding-poly` column, then the system will try to detect - * regions of interest automatically. At most one `bounding-poly` column is - * allowed per line. If the image contains multiple regions of interest, add - * a line to the CSV file that includes the same product information, and - * the `bounding-poly` values for each region of interest. The - * `bounding-poly` column must contain an even number of comma-separated - * numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use - * non-negative integers for absolute bounding polygons, and float values in - * [0, 1] for normalized bounding polygons. The system will resize the - * image if the image resolution is too large to process (larger than 20MP). + * The output location and metadata from AsyncAnnotateFileRequest. */ - csvFileUri?: string; + outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; } /** - * The input content for the `ImportProductSets` method. + * Response to an async batch file annotation request. */ - export interface Schema$ImportProductSetsInputConfig { + export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateFilesResponse { /** - * The Google Cloud Storage location for a csv file which preserves a list - * of ImportProductSetRequests in each line. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ - gcsSource?: Schema$ImportProductSetsGcsSource; + responses?: Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse[]; } /** - * Request message for the `ImportProductSets` method. + * Response to an async batch image annotation request. */ - export interface Schema$ImportProductSetsRequest { + export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateImagesResponse { /** - * The input content for the list of requests. + * The output location and metadata from AsyncBatchAnnotateImagesRequest. */ - inputConfig?: Schema$ImportProductSetsInputConfig; + outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; } /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. + * A list of file annotation responses. */ - export interface Schema$ImportProductSetsResponse { - /** - * The list of reference_images that are imported successfully. - */ - referenceImages?: Schema$ReferenceImage[]; + export interface Schema$GoogleCloudVisionV1p5beta1BatchAnnotateFilesResponse { /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ - statuses?: Schema$Status[]; + responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse[]; } /** - * The desired input location and metadata. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ - export interface Schema$InputConfig { + export interface Schema$GoogleCloudVisionV1p5beta1BatchOperationMetadata { /** - * The Google Cloud Storage location to read the input from. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - gcsSource?: Schema$GcsSource; + endTime?: string; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The current state of the batch operation. */ - mimeType?: string; + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; } /** - * A product label represented as a key-value pair. + * Logical element on the page. */ - export interface Schema$KeyValue { + export interface Schema$GoogleCloudVisionV1p5beta1Block { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * Detected block type (text, image etc) for this block. */ - key?: string; + blockType?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - value?: string; - } - /** - * A face-specific landmark (for example, a face feature). - */ - export interface Schema$Landmark { + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; /** - * Face landmark position. + * Confidence of the OCR results on the block. Range [0, 1]. */ - position?: Schema$Position; + confidence?: number; /** - * Face landmark type. + * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ - type?: string; - } - /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. - */ - export interface Schema$LatLng { + keyValuePair?: Schema$GoogleCloudVisionV1p5beta1KeyValuePair; /** - * The latitude in degrees. It must be in the range [-90.0, +90.0]. + * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. */ - latitude?: number; + mergedText?: string; /** - * The longitude in degrees. It must be in the range [-180.0, +180.0]. + * List of paragraphs in this block (if this blocks is of type text). */ - longitude?: number; - } - /** - * Rectangle determined by min and max `LatLng` pairs. - */ - export interface Schema$LatLongRect { + paragraphs?: Schema$GoogleCloudVisionV1p5beta1Paragraph[]; /** - * Max lat/long pair. + * Additional information detected for the block. */ - maxLatLng?: Schema$LatLng; + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; /** - * Min lat/long pair. + * Detected table for TABLE block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ - minLatLng?: Schema$LatLng; + table?: Schema$GoogleCloudVisionV1p5beta1Table; } /** - * The response message for Operations.ListOperations. + * A bounding polygon for the detected image annotation. */ - export interface Schema$ListOperationsResponse { + export interface Schema$GoogleCloudVisionV1p5beta1BoundingPoly { /** - * The standard List next-page token. + * The bounding polygon normalized vertices. */ - nextPageToken?: string; + normalizedVertices?: Schema$GoogleCloudVisionV1p5beta1NormalizedVertex[]; /** - * A list of operations that matches the specified filter in the request. + * The bounding polygon vertices. */ - operations?: Schema$Operation[]; + vertices?: Schema$GoogleCloudVisionV1p5beta1Vertex[]; } /** - * Response message for the `ListProductSets` method. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ - export interface Schema$ListProductSetsResponse { + export interface Schema$GoogleCloudVisionV1p5beta1ColorInfo { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * RGB components of the color. */ - nextPageToken?: string; + color?: Schema$Color; /** - * List of ProductSets. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - productSets?: Schema$ProductSet[]; + pixelFraction?: number; + /** + * Image-specific score for this color. Value in range [0, 1]. + */ + score?: number; } /** - * Response message for the `ListProductsInProductSet` method. + * Single crop hint that is used to generate a new crop when serving an image. */ - export interface Schema$ListProductsInProductSetResponse { + export interface Schema$GoogleCloudVisionV1p5beta1CropHint { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ - nextPageToken?: string; + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; /** - * The list of Products. + * Confidence of this being a salient region. Range [0, 1]. */ - products?: Schema$Product[]; + confidence?: number; + /** + * Fraction of importance of this salient region with respect to the original image. + */ + importanceFraction?: number; } /** - * Response message for the `ListProducts` method. + * Set of crop hints that are used to generate new crops when serving images. + */ + export interface Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints?: Schema$GoogleCloudVisionV1p5beta1CropHint[]; + } + /** + * Set of dominant colors and their corresponding scores. + */ + export interface Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors?: Schema$GoogleCloudVisionV1p5beta1ColorInfo[]; + } + /** + * Set of detected entity features. + */ + export interface Schema$GoogleCloudVisionV1p5beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. + */ + confidence?: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description?: string; + /** + * The language code for the locale in which the entity textual `description` is expressed. + */ + locale?: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. + */ + locations?: Schema$GoogleCloudVisionV1p5beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). + */ + mid?: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. + */ + properties?: Schema$GoogleCloudVisionV1p5beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score?: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality?: number; + } + /** + * A face annotation object contains the results of face detection. + */ + export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood?: string; + /** + * Blurred likelihood. + */ + blurredLikelihood?: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence?: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + */ + fdBoundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood?: string; + /** + * Joy likelihood. + */ + joyLikelihood?: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence?: number; + /** + * Detected face landmarks. + */ + landmarks?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. + */ + panAngle?: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. + */ + rollAngle?: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood?: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood?: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle?: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position?: Schema$GoogleCloudVisionV1p5beta1Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * The Google Cloud Storage location where the output will be written to. + */ + export interface Schema$GoogleCloudVisionV1p5beta1GcsDestination { + /** + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + */ + uri?: string; + } + /** + * The Google Cloud Storage location where the input will be read from. + */ + export interface Schema$GoogleCloudVisionV1p5beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. + */ + uri?: string; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation; + } + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$GoogleCloudVisionV1p5beta1ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p5beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * Proto for a key value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1KeyValuePair { + /** + * The key string value. + */ + key?: string; + /** + * Key block of the pair containing the normalized bounding box and key text. + */ + keyBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + /** + * Optional. The translation of key text if the text is not in English. + */ + normalizedKey?: string; + /** + * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. + */ + valueBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + /** + * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. + */ + valueType?: string; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$GoogleCloudVisionV1p5beta1LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$GoogleCloudVisionV1p5beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p5beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GoogleCloudVisionV1p5beta1GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$GoogleCloudVisionV1p5beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** + * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. + */ + mergedText?: string; + /** + * Additional information detected on the page. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + width?: number; + } + /** + * Structural unit of text representing a number of words in certain order. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Paragraph { + /** + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence?: number; + /** + * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. + */ + mergedText?: string; + /** + * Additional information detected for the paragraph. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words?: Schema$GoogleCloudVisionV1p5beta1Word[]; + } + /** + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Position { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + /** + * Z coordinate (or depth). + */ + z?: number; + } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p5beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p5beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). + */ + score?: number; + } + /** + * A `Property` consists of a user-supplied name/value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Property { + /** + * Name of the property. + */ + name?: string; + /** + * Value of numeric properties. + */ + uint64Value?: string; + /** + * Value of the property. + */ + value?: string; + } + /** + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly[]; + /** + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + */ + uri?: string; + } + /** + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). + */ + export interface Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. + */ + adult?: string; + /** + * Likelihood that this is a medical image. + */ + medical?: string; + /** + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. + */ + racy?: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. + */ + spoof?: string; + /** + * Likelihood that this image contains violent content. + */ + violence?: string; + } + /** + * A single symbol representation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the symbol. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text?: string; + } + /** + * A table representation similar to HTML table structure. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Table { + /** + * Body rows of the table + */ + bodyRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; + /** + * Header rows of the table + */ + headerRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; + } + /** + * A cell representation inside of tables. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TableTableCell { + /** + * How many columns this cell spans. + */ + colSpan?: number; + /** + * How many rows this cell spans. + */ + rowSpan?: number; + /** + * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. + */ + text?: string; + /** + * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. + */ + textBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + } + /** + * A row of table cells. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TableTableRow { + /** + * Cells that make up this row. + */ + cells?: Schema$GoogleCloudVisionV1p5beta1TableTableCell[]; + } + /** + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages?: Schema$GoogleCloudVisionV1p5beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text?: string; + } + /** + * Detected start or end of a structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix?: boolean; + /** + * Detected break type. + */ + type?: string; + } + /** + * Detected language for a structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence?: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Additional information detected on the structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage[]; + } + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Vertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Relevant information for the image from the Internet. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetection { + /** + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. + */ + bestGuessLabels?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage[]; + /** + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity[]; + } + /** + * Entity deduced from similar images on the Internet. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description?: string; + /** + * Opaque entity ID. + */ + entityId?: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. + */ + score?: number; + } + /** + * Metadata for online images. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score?: number; + /** + * The result image URL. + */ + url?: string; + } + /** + * Label to provide extra metadata for the web detection. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label?: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Metadata for web pages. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle?: string; + /** + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score?: number; + /** + * The result web page URL. + */ + url?: string; + } + /** + * A word representation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Word { + /** + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence?: number; + /** + * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. + */ + mergedText?: string; + /** + * Additional information detected for the word. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural reading order. + */ + symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } + /** + * Client image to perform Google Cloud Vision API tasks over. + */ + export interface Schema$Image { + /** + * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + */ + content?: string; + /** + * Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request. + */ + source?: Schema$ImageSource; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Image context and/or feature-specific parameters. + */ + export interface Schema$ImageContext { + /** + * Parameters for crop hints annotation request. + */ + cropHintsParams?: Schema$CropHintsParams; + /** + * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). + */ + languageHints?: string[]; + /** + * Not used. + */ + latLongRect?: Schema$LatLongRect; + /** + * Parameters for product search. + */ + productSearchParams?: Schema$ProductSearchParams; + /** + * Parameters for web detection. + */ + webDetectionParams?: Schema$WebDetectionParams; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$DominantColorsAnnotation; + } + /** + * External image source (Google Cloud Storage or web URL image location). + */ + export interface Schema$ImageSource { + /** + * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + */ + gcsImageUri?: string; + /** + * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. + */ + imageUri?: string; + } + /** + * The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line. + */ + export interface Schema$ImportProductSetsGcsSource { + /** + * The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to display_name, the `product-category` column refers to product_category, and the `labels` column refers to product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: "key_1=value_1,key_2=value_2,...,key_n=value_n" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP). + */ + csvFileUri?: string; + } + /** + * The input content for the `ImportProductSets` method. + */ + export interface Schema$ImportProductSetsInputConfig { + /** + * The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line. + */ + gcsSource?: Schema$ImportProductSetsGcsSource; + } + /** + * Request message for the `ImportProductSets` method. + */ + export interface Schema$ImportProductSetsRequest { + /** + * The input content for the list of requests. + */ + inputConfig?: Schema$ImportProductSetsInputConfig; + } + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GcsSource; + /** + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$KeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$Landmark { + /** + * Face landmark position. + */ + position?: Schema$Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + */ + export interface Schema$LatLng { + /** + * The latitude in degrees. It must be in the range [-90.0, +90.0]. + */ + latitude?: number; + /** + * The longitude in degrees. It must be in the range [-180.0, +180.0]. + */ + longitude?: number; + } + /** + * Rectangle determined by min and max `LatLng` pairs. + */ + export interface Schema$LatLongRect { + /** + * Max lat/long pair. + */ + maxLatLng?: Schema$LatLng; + /** + * Min lat/long pair. + */ + minLatLng?: Schema$LatLng; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * Response message for the `ListProductSets` method. + */ + export interface Schema$ListProductSetsResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string; + /** + * List of ProductSets. + */ + productSets?: Schema$ProductSet[]; + } + /** + * Response message for the `ListProductsInProductSet` method. + */ + export interface Schema$ListProductsInProductSetResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string; + /** + * The list of Products. + */ + products?: Schema$Product[]; + } + /** + * Response message for the `ListProducts` method. */ export interface Schema$ListProductsResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** @@ -5179,9 +5375,7 @@ export namespace vision_v1 { */ boundingPoly?: Schema$BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -5207,8 +5401,7 @@ export namespace vision_v1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$NormalizedVertex { /** @@ -5221,14 +5414,11 @@ export namespace vision_v1 { y?: number; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * This resource represents a long-running operation that is the result of a network API call. */ export interface Schema$Operation { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */ done?: boolean; /** @@ -5236,26 +5426,15 @@ export namespace vision_v1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any}; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any}; } @@ -5281,14 +5460,7 @@ export namespace vision_v1 { */ export interface Schema$OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -5309,8 +5481,7 @@ export namespace vision_v1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -5318,8 +5489,7 @@ export namespace vision_v1 { */ property?: Schema$TextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -5328,14 +5498,7 @@ export namespace vision_v1 { */ export interface Schema$Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5352,9 +5515,7 @@ export namespace vision_v1 { words?: Schema$Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$Position { /** @@ -5375,34 +5536,23 @@ export namespace vision_v1 { */ export interface Schema$Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$KeyValue[]; } @@ -5411,31 +5561,19 @@ export namespace vision_v1 { */ export interface Schema$ProductSearchParams { /** - * The bounding polygon around the area of interest in the image. Optional. - * If it is not specified, system discretion will be applied. + * The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. */ boundingPoly?: Schema$BoundingPoly; /** - * The filtering expression. This can be used to restrict search results - * based on Product labels. We currently support an AND of OR of key-value - * expressions, where each expression within an OR must have the same key. - * An '=' should be used to connect the key and value. For example, - * "(color = red OR color = blue) AND brand = Google" is - * acceptable, but "(color = red OR brand = Google)" is not - * acceptable. "color: red" is not acceptable because it uses a - * ':' instead of an '='. + * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ filter?: string; /** - * The list of product categories to search in. Currently, we only consider - * the first category, and either "homegoods", - * "apparel", or "toys" should be specified. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods", "apparel", or "toys" should be specified. */ productCategories?: string[]; /** - * The resource name of a ProductSet to be searched for similar images. - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ productSet?: string; } @@ -5444,16 +5582,11 @@ export namespace vision_v1 { */ export interface Schema$ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GroupedResult[]; /** @@ -5462,33 +5595,23 @@ export namespace vision_v1 { results?: Schema$Result[]; } /** - * A ProductSet contains Products. A ProductSet can contain a maximum of 1 - * million reference images. If the limit is exceeded, periodic indexing will - * fail. + * A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail. */ export interface Schema$ProductSet { /** - * The user-provided name for this ProductSet. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * Output only. If there was an error with indexing the product set, the - * field is populated. This field is ignored when creating a ProductSet. + * Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet. */ indexError?: Schema$Status; /** - * Output only. The time at which this ProductSet was last indexed. Query - * results will reflect all updates before this time. If this ProductSet has - * never been indexed, this timestamp is the default value - * "1970-01-01T00:00:00Z". This field is ignored when creating a - * ProductSet. + * Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. */ indexTime?: string; /** - * The resource name of the ProductSet. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This - * field is ignored when creating a ProductSet. + * The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. */ name?: string; } @@ -5510,28 +5633,19 @@ export namespace vision_v1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } @@ -5540,8 +5654,7 @@ export namespace vision_v1 { */ export interface Schema$RemoveProductFromProductSetRequest { /** - * The resource name for the Product to be removed from this ProductSet. - * Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string; } @@ -5550,8 +5663,7 @@ export namespace vision_v1 { */ export interface Schema$Result { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -5559,21 +5671,16 @@ export namespace vision_v1 { */ product?: Schema$Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -5581,15 +5688,11 @@ export namespace vision_v1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -5598,40 +5701,7 @@ export namespace vision_v1 { violence?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -5639,14 +5709,11 @@ export namespace vision_v1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -5655,14 +5722,7 @@ export namespace vision_v1 { */ export interface Schema$Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5679,13 +5739,7 @@ export namespace vision_v1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$TextAnnotation { /** @@ -5711,8 +5765,7 @@ export namespace vision_v1 { detectedLanguages?: Schema$DetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$Vertex { /** @@ -5729,13 +5782,11 @@ export namespace vision_v1 { */ export interface Schema$WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$WebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$WebImage[]; /** @@ -5743,9 +5794,7 @@ export namespace vision_v1 { */ pagesWithMatchingImages?: Schema$WebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** @@ -5779,8 +5828,7 @@ export namespace vision_v1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -5806,9 +5854,7 @@ export namespace vision_v1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -5817,8 +5863,7 @@ export namespace vision_v1 { */ export interface Schema$WebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$WebImage[]; /** @@ -5826,9 +5871,7 @@ export namespace vision_v1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** @@ -5845,14 +5888,7 @@ export namespace vision_v1 { */ export interface Schema$Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5864,8 +5900,7 @@ export namespace vision_v1 { */ property?: Schema$TextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$Symbol[]; } @@ -5876,14 +5911,86 @@ export namespace vision_v1 { this.context = context; } + /** + * vision.files.annotate + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @alias vision.files.annotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().BatchAnnotateFilesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + annotate( + params?: Params$Resource$Files$Annotate, + options?: MethodOptions + ): GaxiosPromise; + annotate( + params: Params$Resource$Files$Annotate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + annotate( + params: Params$Resource$Files$Annotate, + callback: BodyResponseCallback + ): void; + annotate( + callback: BodyResponseCallback + ): void; + annotate( + paramsOrCallback?: + | Params$Resource$Files$Annotate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Annotate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Annotate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/files:annotate').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * vision.files.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of - * generic files, such as PDF files, which may contain multiple pages and - * multiple images per page. Progress and results can be retrieved through - * the `google.longrunning.Operations` interface. `Operation.metadata` - * contains `OperationMetadata` (metadata). `Operation.response` contains - * `AsyncBatchAnnotateFilesResponse` (results). + * @desc Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). * @alias vision.files.asyncBatchAnnotate * @memberOf! () * @@ -5956,6 +6063,17 @@ export namespace vision_v1 { } } + export interface Params$Resource$Files$Annotate extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchAnnotateFilesRequest; + } export interface Params$Resource$Files$Asyncbatchannotate extends StandardParameters { /** @@ -5984,14 +6102,12 @@ export namespace vision_v1 { * // 1. If not already done, enable the Google Cloud Vision API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/vision - * // 2. This sample uses Application Default Credentials for - * authentication. + * // 2. This sample uses Application Default Credentials for authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials + * // https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * @@ -6024,10 +6140,9 @@ export namespace vision_v1 { * console.error('authentication failed: ', err); * return; * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); * } * callback(authClient); * }); @@ -6108,6 +6223,80 @@ export namespace vision_v1 { return createAPIRequest(parameters); } } + + /** + * vision.images.asyncBatchAnnotate + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @alias vision.images.asyncBatchAnnotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().AsyncBatchAnnotateImagesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + asyncBatchAnnotate( + params?: Params$Resource$Images$Asyncbatchannotate, + options?: MethodOptions + ): GaxiosPromise; + asyncBatchAnnotate( + params: Params$Resource$Images$Asyncbatchannotate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + asyncBatchAnnotate( + params: Params$Resource$Images$Asyncbatchannotate, + callback: BodyResponseCallback + ): void; + asyncBatchAnnotate(callback: BodyResponseCallback): void; + asyncBatchAnnotate( + paramsOrCallback?: + | Params$Resource$Images$Asyncbatchannotate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Images$Asyncbatchannotate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Asyncbatchannotate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/images:asyncBatchAnnotate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Images$Annotate extends StandardParameters { @@ -6121,6 +6310,18 @@ export namespace vision_v1 { */ requestBody?: Schema$BatchAnnotateImagesRequest; } + export interface Params$Resource$Images$Asyncbatchannotate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$AsyncBatchAnnotateImagesRequest; + } export class Resource$Locations { context: APIRequestContext; @@ -6139,9 +6340,7 @@ export namespace vision_v1 { /** * vision.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias vision.locations.operations.get * @memberOf! () * @@ -6232,15 +6431,7 @@ export namespace vision_v1 { /** * vision.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The - * server makes a best effort to cancel the operation, but success is not - * guaranteed. If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - * or other methods to check whether the cancellation succeeded or whether - * the operation completed despite cancellation. On successful cancellation, - * the operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of 1, corresponding - * to `Code.CANCELLED`. + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * @alias vision.operations.cancel * @memberOf! () * @@ -6310,10 +6501,7 @@ export namespace vision_v1 { /** * vision.operations.delete - * @desc Deletes a long-running operation. This method indicates that the - * client is no longer interested in the operation result. It does not - * cancel the operation. If the server doesn't support this method, it - * returns `google.rpc.Code.UNIMPLEMENTED`. + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @alias vision.operations.delete * @memberOf! () * @@ -6382,9 +6570,7 @@ export namespace vision_v1 { /** * vision.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias vision.operations.get * @memberOf! () * @@ -6454,15 +6640,7 @@ export namespace vision_v1 { /** * vision.operations.list - * @desc Lists operations that match the specified filter in the request. If - * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: - * the `name` binding allows API services to override the binding to use - * different resource name schemes, such as `users/x/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/x}/operations"` to their service configuration. For - * backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding is - * the parent resource, without the operations collection id. + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. * @alias vision.operations.list * @memberOf! () * @@ -6636,9 +6814,7 @@ export namespace vision_v1 { /** * vision.projects.locations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias vision.projects.locations.operations.get * @memberOf! () * @@ -6733,11 +6909,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.create - * @desc Creates and returns a new product resource. Possible errors: * - * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 - * characters. * Returns INVALID_ARGUMENT if description is longer than 4096 - * characters. * Returns INVALID_ARGUMENT if product_category is missing or - * invalid. + * @desc Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid. * @alias vision.projects.locations.products.create * @memberOf! () * @@ -6811,10 +6983,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.delete - * @desc Permanently deletes a product and its reference images. Metadata - * of the product and all its images will be deleted right away, but search - * queries against ProductSets containing the product may still work until - * all related caches are refreshed. Possible errors: none + * @desc Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed. * @alias vision.projects.locations.products.delete * @memberOf! () * @@ -6883,8 +7052,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.get - * @desc Gets information associated with a Product. Possible errors: * - * Returns NOT_FOUND if the Product does not exist. + * @desc Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist. * @alias vision.projects.locations.products.get * @memberOf! () * @@ -6953,8 +7121,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.list - * @desc Lists products in an unspecified order. Possible errors: * - * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + * @desc Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. * @alias vision.projects.locations.products.list * @memberOf! () * @@ -7032,15 +7199,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.patch - * @desc Makes changes to a Product resource. Only the `display_name`, - * `description`, and `labels` fields can be updated right now. If labels - * are updated, the change will not be reflected in queries until the next - * index time. Possible errors: * Returns NOT_FOUND if the Product does - * not exist. * Returns INVALID_ARGUMENT if display_name is present in - * update_mask but is missing from the request or longer than 4096 - * characters. * Returns INVALID_ARGUMENT if description is present in - * update_mask but is longer than 4096 characters. * Returns - * INVALID_ARGUMENT if product_category is present in update_mask. + * @desc Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask. * @alias vision.projects.locations.products.patch * @memberOf! () * @@ -7118,15 +7277,11 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which the Product should be created. Format is - * `projects/PROJECT_ID/locations/LOC_ID`. + * The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** - * A user-supplied resource id for this Product. If set, the server will - * attempt to use this value as the resource id. If it is already in use, an - * error is returned with code ALREADY_EXISTS. Must be at most 128 - * characters long. It cannot contain the character `/`. + * A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. */ productId?: string; @@ -7143,8 +7298,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of product to delete. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } @@ -7156,8 +7310,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the Product to get. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } @@ -7177,8 +7330,7 @@ export namespace vision_v1 { */ pageToken?: string; /** - * The project OR ProductSet from which Products should be listed. Format: - * `projects/PROJECT_ID/locations/LOC_ID` + * The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` */ parent?: string; } @@ -7190,15 +7342,11 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The FieldMask that specifies which fields to update. If update_mask isn't - * specified, all mutable fields are to be updated. Valid mask paths include - * `product_labels`, `display_name`, and `description`. + * The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`. */ updateMask?: string; @@ -7216,19 +7364,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.create - * @desc Creates and returns a new ReferenceImage resource. The - * `bounding_poly` field is optional. If `bounding_poly` is not specified, - * the system will try to detect regions of interest in the image that are - * compatible with the product_category on the parent product. If it is - * specified, detection is ALWAYS skipped. The system converts polygons into - * non-rotated rectangles. Note that the pipeline will resize the image if - * the image resolution is too large to process (above 50MP). Possible - * errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer - * than 4096 characters. * Returns INVALID_ARGUMENT if the product does - * not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, - * and nothing compatible with the parent product's product_category is - * detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than - * 10 polygons. + * @desc Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. * @alias vision.projects.locations.products.referenceImages.create * @memberOf! () * @@ -7304,11 +7440,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.delete - * @desc Permanently deletes a reference image. The image metadata will be - * deleted right away, but search queries against ProductSets containing the - * image may still work until all related caches are refreshed. The actual - * image files are not deleted from Google Cloud Storage. Possible errors: - * none + * @desc Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage. * @alias vision.projects.locations.products.referenceImages.delete * @memberOf! () * @@ -7377,8 +7509,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.get - * @desc Gets information associated with a ReferenceImage. Possible - * errors: * Returns NOT_FOUND if the specified image does not exist. + * @desc Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist. * @alias vision.projects.locations.products.referenceImages.get * @memberOf! () * @@ -7449,9 +7580,7 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.list - * @desc Lists reference images. Possible errors: * Returns NOT_FOUND if - * the parent product does not exist. * Returns INVALID_ARGUMENT if the - * page_size is greater than 100, or less than 1. + * @desc Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1. * @alias vision.projects.locations.products.referenceImages.list * @memberOf! () * @@ -7541,15 +7670,11 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the product in which to create the reference image. - * Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; /** - * A user-supplied resource id for the ReferenceImage to be added. If set, - * the server will attempt to use this value as the resource id. If it is - * already in use, an error is returned with code ALREADY_EXISTS. Must be at - * most 128 characters long. It cannot contain the character `/`. + * A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. */ referenceImageId?: string; @@ -7566,8 +7691,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the reference image to delete. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` */ name?: string; } @@ -7579,8 +7703,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the ReferenceImage to get. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. */ name?: string; } @@ -7596,14 +7719,11 @@ export namespace vision_v1 { */ pageSize?: number; /** - * A token identifying a page of results to be returned. This is the value - * of `nextPageToken` returned in a previous reference image list request. - * Defaults to the first page if not specified. + * A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. */ pageToken?: string; /** - * Resource name of the product containing the reference images. Format is - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; } @@ -7620,10 +7740,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.addProduct - * @desc Adds a Product to the specified ProductSet. If the Product is - * already present, no change is made. One Product can be added to at most - * 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or - * the ProductSet doesn't exist. + * @desc Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or the ProductSet doesn't exist. * @alias vision.projects.locations.productSets.addProduct * @memberOf! () * @@ -7696,9 +7813,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.create - * @desc Creates and returns a new ProductSet resource. Possible errors: * - * Returns INVALID_ARGUMENT if display_name is missing, or is longer than - * 4096 characters. + * @desc Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters. * @alias vision.projects.locations.productSets.create * @memberOf! () * @@ -7774,9 +7889,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.delete - * @desc Permanently deletes a ProductSet. Products and ReferenceImages in - * the ProductSet are not deleted. The actual image files are not deleted - * from Google Cloud Storage. Possible errors: none + * @desc Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. * @alias vision.projects.locations.productSets.delete * @memberOf! () * @@ -7845,8 +7958,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.get - * @desc Gets information associated with a ProductSet. Possible errors: * - * Returns NOT_FOUND if the ProductSet does not exist. + * @desc Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * @alias vision.projects.locations.productSets.get * @memberOf! () * @@ -7917,14 +8029,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.import - * @desc Asynchronous API that imports a list of reference images to specified - * product sets based on a list of image information. The - * google.longrunning.Operation API can be used to keep track of the progress - * and results of the request. `Operation.metadata` contains - * `BatchOperationMetadata`. (progress) `Operation.response` contains - * `ImportProductSetsResponse`. (results) The input source of this method is a - * csv file on Google Cloud Storage. For the format of the csv file please see - * ImportProductSetsGcsSource.csv_file_uri. + * @desc Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri. * @alias vision.projects.locations.productSets.import * @memberOf! () * @@ -8077,11 +8182,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.patch - * @desc Makes changes to a ProductSet resource. Only display_name can be - * updated currently. Possible errors: * Returns NOT_FOUND if the - * ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is - * present in update_mask but missing from the request or longer than 4096 - * characters. + * @desc Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters. * @alias vision.projects.locations.productSets.patch * @memberOf! () * @@ -8154,8 +8255,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.removeProduct - * @desc Removes a Product from the specified ProductSet. Possible errors: - * none + * @desc Removes a Product from the specified ProductSet. * @alias vision.projects.locations.productSets.removeProduct * @memberOf! () * @@ -8235,8 +8335,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name for the ProductSet to modify. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; @@ -8253,15 +8352,11 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which the ProductSet should be created. Format is - * `projects/PROJECT_ID/locations/LOC_ID`. + * The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** - * A user-supplied resource id for this ProductSet. If set, the server will - * attempt to use this value as the resource id. If it is already in use, an - * error is returned with code ALREADY_EXISTS. Must be at most 128 - * characters long. It cannot contain the character `/`. + * A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. */ productSetId?: string; @@ -8278,8 +8373,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the ProductSet to delete. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; } @@ -8291,8 +8385,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the ProductSet to get. Format is: - * `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` + * Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` */ name?: string; } @@ -8304,8 +8397,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which the ProductSets should be imported. Format is - * `projects/PROJECT_ID/locations/LOC_ID`. + * The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; @@ -8330,8 +8422,7 @@ export namespace vision_v1 { */ pageToken?: string; /** - * The project from which ProductSets should be listed. Format is - * `projects/PROJECT_ID/locations/LOC_ID`. + * The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; } @@ -8343,15 +8434,11 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the ProductSet. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This - * field is ignored when creating a ProductSet. + * The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. */ name?: string; /** - * The FieldMask that specifies which fields to update. If update_mask isn't - * specified, all mutable fields are to be updated. Valid mask path is - * `display_name`. + * The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`. */ updateMask?: string; @@ -8368,8 +8455,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name for the ProductSet to modify. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; @@ -8387,10 +8473,7 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.products.list - * @desc Lists the Products in a ProductSet, in an unspecified order. If the - * ProductSet does not exist, the products field of the response will be - * empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is - * greater than 100 or less than 1. + * @desc Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. * @alias vision.projects.locations.productSets.products.list * @memberOf! () * @@ -8482,8 +8565,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ProductSet resource for which to retrieve Products. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; /** @@ -8504,9 +8586,7 @@ export namespace vision_v1 { /** * vision.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @alias vision.projects.operations.get * @memberOf! () * diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 330d76b9ad9..f389aad3446 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace vision_v1p1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace vision_v1p1beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace vision_v1p1beta1 { /** * Cloud Vision API * - * Integrates Google Vision features, including image labeling, face, logo, - * and landmark detection, optical character recognition (OCR), and detection - * of explicit content, into applications. + * Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace vision_v1p1beta1 { images: Resource$Images; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.files = new Resource$Files(this.context); this.images = new Resource$Images(this.context); @@ -123,8 +120,7 @@ export namespace vision_v1p1beta1 { } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$AnnotateFileResponse { /** @@ -135,14 +131,17 @@ export namespace vision_v1p1beta1 { * Individual responses to images found within the file. */ responses?: Schema$AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$ImageAnnotationContext; /** @@ -150,9 +149,7 @@ export namespace vision_v1p1beta1 { */ cropHintsAnnotation?: Schema$CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -160,9 +157,7 @@ export namespace vision_v1p1beta1 { */ faceAnnotations?: Schema$FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$TextAnnotation; /** @@ -178,8 +173,7 @@ export namespace vision_v1p1beta1 { */ landmarkAnnotations?: Schema$EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$LocalizedObjectAnnotation[]; /** @@ -217,20 +211,34 @@ export namespace vision_v1p1beta1 { */ export interface Schema$AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Response to an async batch image annotation request. + */ + export interface Schema$AsyncBatchAnnotateImagesResponse { + /** + * The output location and metadata from AsyncBatchAnnotateImagesRequest. + */ + outputConfig?: Schema$OutputConfig; + } + /** + * A list of file annotation responses. + */ + export interface Schema$BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$AnnotateFileResponse[]; + } + /** + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -251,14 +259,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -288,72 +289,11 @@ export namespace vision_v1p1beta1 { vertices?: Schema$Vertex[]; } /** - * Represents a color in the RGBA color space. This representation is designed - * for simplicity of conversion to/from color representations in various - * languages over compactness; for example, the fields of this representation - * can be trivially provided to the constructor of "java.awt.Color" - * in Java; it can also be trivially provided to UIColor's - * "+colorWithRed:green:blue:alpha" method in iOS; and, with just a - * little work, it can be easily formatted into a CSS "rgba()" - * string in JavaScript, as well. Note: this proto does not carry information - * about the absolute color space that should be used to interpret the RGB - * value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, - * applications SHOULD assume the sRGB color space. Example (Java): import - * com.google.type.Color; // ... public static java.awt.Color - * fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? - * protocolor.getAlpha().getValue() : 1.0; return new - * java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - * protocolor.getBlue(), alpha); } public static Color - * toProto(java.awt.Color color) { float red = (float) color.getRed(); - * float green = (float) color.getGreen(); float blue = (float) - * color.getBlue(); float denominator = 255.0; Color.Builder - * resultBuilder = Color .newBuilder() .setRed(red / - * denominator) .setGreen(green / denominator) .setBlue(blue / - * denominator); int alpha = color.getAlpha(); if (alpha != 255) - * { result.setAlpha( FloatValue .newBuilder() - * .setValue(((float) alpha) / denominator) .build()); } - * return resultBuilder.build(); } // ... Example (iOS / Obj-C): // - * ... static UIColor* fromProto(Color* protocolor) { float red = - * [protocolor red]; float green = [protocolor green]; float - * blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor - * alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { - * alpha = [alpha_wrapper value]; } return [UIColor - * colorWithRed:red green:green blue:blue alpha:alpha]; } static - * Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; - * if (![color getRed:&red green:&green blue:&blue - * alpha:&alpha]) { return nil; } Color* - * result = [[Color alloc] init]; [result setRed:red]; [result - * setGreen:green]; [result setBlue:blue]; if (alpha <= - * 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } - * [result autorelease]; return result; } // ... Example - * (JavaScript): // ... var protoToCssColor = function(rgb_color) { - * var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green - * || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = - * Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); - * var blue = Math.floor(blueFrac * 255); if (!('alpha' in - * rgb_color)) { return rgbToCssColor_(red, green, blue); } - * var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - * green, blue].join(','); return ['rgba(', rgbParams, - * ',', alphaFrac, ')'].join(''); }; var - * rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new - * Number((red << 16) | (green << 8) | blue); var hexString - * = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; - * var resultBuilder = ['#']; for (var i = 0; i < - * missingZeros; i++) { resultBuilder.push('0'); } - * resultBuilder.push(hexString); return resultBuilder.join(''); - * }; // ... + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... */ export interface Schema$Color { /** - * The fraction of this color that should be applied to the pixel. That is, - * the final pixel color is defined by the equation: pixel color = alpha - * * (this color) + (1.0 - alpha) * (background color) This means that a - * value of 1.0 corresponds to a solid color, whereas a value of 0.0 - * corresponds to a completely transparent color. This uses a wrapper - * message rather than a simple float scalar so that it is possible to - * distinguish between a default value and the value being unset. If - * omitted, this color object is to be rendered as a solid color (as if the - * alpha value had been explicitly given with a value of 1.0). + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ alpha?: number; /** @@ -370,8 +310,7 @@ export namespace vision_v1p1beta1 { red?: number; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$ColorInfo { /** @@ -379,8 +318,7 @@ export namespace vision_v1p1beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -393,8 +331,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$BoundingPoly; /** @@ -402,8 +339,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -438,9 +374,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -458,15 +392,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -474,26 +404,19 @@ export namespace vision_v1p1beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$Property[]; /** @@ -501,12 +424,7 @@ export namespace vision_v1p1beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -523,13 +441,7 @@ export namespace vision_v1p1beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$BoundingPoly; /** @@ -537,12 +449,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$BoundingPoly; /** @@ -562,15 +469,11 @@ export namespace vision_v1p1beta1 { */ landmarks?: Schema$Landmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -582,8 +485,7 @@ export namespace vision_v1p1beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -596,22 +498,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -620,14 +507,33 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * A request to annotate one single file, e.g. a PDF, TIFF or GIF file. + */ + export interface Schema$GoogleCloudVisionV1p1beta1AnnotateFileRequest { + /** + * Required. Requested features. + */ + features?: Schema$GoogleCloudVisionV1p1beta1Feature[]; + /** + * Additional context that may accompany the image(s) in the file. + */ + imageContext?: Schema$GoogleCloudVisionV1p1beta1ImageContext; + /** + * Required. Information about the input file. + */ + inputConfig?: Schema$GoogleCloudVisionV1p1beta1InputConfig; + /** + * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. + */ + pages?: number[]; + } + /** + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateFileResponse { /** @@ -638,10 +544,13 @@ export namespace vision_v1p1beta1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** - * Request for performing Google Cloud Vision API tasks over a user-provided - * image, with user-requested features, and with context information. + * Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information. */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateImageRequest { /** @@ -662,8 +571,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext; /** @@ -671,9 +579,7 @@ export namespace vision_v1p1beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p1beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -681,9 +587,7 @@ export namespace vision_v1p1beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p1beta1TextAnnotation; /** @@ -699,8 +603,7 @@ export namespace vision_v1p1beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation[]; /** @@ -755,8 +658,7 @@ export namespace vision_v1p1beta1 { outputConfig?: Schema$GoogleCloudVisionV1p1beta1OutputConfig; } /** - * Multiple async file annotation requests are batched into a single service - * call. + * Multiple async file annotation requests are batched into a single service call. */ export interface Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest { /** @@ -769,11 +671,41 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse[]; } + /** + * Request for async image annotation for a list of images. + */ + export interface Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest { + /** + * Required. The desired output location and metadata (e.g. format). + */ + outputConfig?: Schema$GoogleCloudVisionV1p1beta1OutputConfig; + /** + * Individual image annotation requests for this batch. + */ + requests?: Schema$GoogleCloudVisionV1p1beta1AnnotateImageRequest[]; + } + /** + * A list of requests to annotate files using the BatchAnnotateFiles API. + */ + export interface Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest { + /** + * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + requests?: Schema$GoogleCloudVisionV1p1beta1AnnotateFileRequest[]; + } + /** + * A list of file annotation responses. + */ + export interface Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p1beta1AnnotateFileResponse[]; + } /** * Multiple image annotation requests are batched into a single service call. */ @@ -801,14 +733,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -838,8 +763,7 @@ export namespace vision_v1p1beta1 { vertices?: Schema$GoogleCloudVisionV1p1beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p1beta1ColorInfo { /** @@ -847,8 +771,7 @@ export namespace vision_v1p1beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -861,8 +784,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -870,8 +792,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -889,12 +810,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1CropHintsParams { /** - * Aspect ratios in floats, representing the ratio of the width to the - * height of the image. For example, if the desired aspect ratio is 4/3, the - * corresponding float value should be 1.33333. If not specified, the best - * possible crop is returned. The number of provided aspect ratios is - * limited to a maximum of 16; any aspect ratios provided after the 16th are - * ignored. + * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ aspectRatios?: number[]; } @@ -912,15 +828,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -928,26 +840,19 @@ export namespace vision_v1p1beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p1beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p1beta1Property[]; /** @@ -955,12 +860,7 @@ export namespace vision_v1p1beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -977,13 +877,7 @@ export namespace vision_v1p1beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -991,12 +885,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1016,15 +905,11 @@ export namespace vision_v1p1beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -1036,8 +921,7 @@ export namespace vision_v1p1beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -1059,20 +943,15 @@ export namespace vision_v1p1beta1 { type?: string; } /** - * The type of Google Cloud Vision API detection to perform, and the maximum - * number of results to return for that type. Multiple `Feature` objects can - * be specified in the `features` list. + * The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. */ export interface Schema$GoogleCloudVisionV1p1beta1Feature { /** - * Maximum number of results of this type. Does not apply to - * `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + * Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. */ maxResults?: number; /** - * Model to use for the feature. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** @@ -1085,22 +964,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -1109,8 +973,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } @@ -1119,26 +982,20 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Image { /** - * Image content, represented as a stream of bytes. Note: As with all - * `bytes` fields, protobuffers use a pure binary representation, whereas - * JSON representations use base64. + * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ content?: string; /** - * Google Cloud Storage image location, or publicly-accessible image URL. If - * both `content` and `source` are provided for an image, `content` takes - * precedence and is used to perform the image annotation request. + * Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request. */ source?: Schema$GoogleCloudVisionV1p1beta1ImageSource; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -1155,14 +1012,7 @@ export namespace vision_v1p1beta1 { */ cropHintsParams?: Schema$GoogleCloudVisionV1p1beta1CropHintsParams; /** - * List of languages to use for TEXT_DETECTION. In most cases, an empty - * value yields the best results since it enables automatic language - * detection. For languages based on the Latin alphabet, setting - * `language_hints` is not needed. In rare cases, when the language of the - * text in the image is known, setting a hint will help get better results - * (although it will be a significant hindrance if the hint is wrong). Text - * detection returns an error if one or more of the specified languages is - * not one of the [supported languages](/vision/docs/languages). + * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). */ languageHints?: string[]; /** @@ -1192,26 +1042,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ImageSource { /** - * **Use `image_uri` instead.** The Google Cloud Storage URI of the form - * `gs://bucket_name/object_name`. Object versioning is not supported. See - * [Google Cloud Storage Request - * URIs](https://cloud.google.com/storage/docs/reference-uris) for more - * info. + * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ gcsImageUri?: string; /** - * The URI of the source image. Can be either: 1. A Google Cloud Storage - * URI of the form `gs://bucket_name/object_name`. Object versioning is - * not supported. See [Google Cloud Storage Request - * URIs](https://cloud.google.com/storage/docs/reference-uris) for more - * info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching - * images from HTTP/HTTPS URLs, Google cannot guarantee that the request - * will be completed. Your request may fail if the specified host denies - * the request (e.g. due to request throttling or DOS prevention), or if - * Google throttles requests to the site for abuse prevention. You should - * not depend on externally-hosted images for production applications. - * When both `gcs_image_uri` and `image_uri` are specified, `image_uri` - * takes precedence. + * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ imageUri?: string; } @@ -1219,13 +1054,16 @@ export namespace vision_v1p1beta1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p1beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p1beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -1251,9 +1089,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -1279,8 +1115,7 @@ export namespace vision_v1p1beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p1beta1NormalizedVertex { /** @@ -1314,14 +1149,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -1342,8 +1170,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -1351,8 +1178,7 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -1361,14 +1187,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1385,9 +1204,7 @@ export namespace vision_v1p1beta1 { words?: Schema$GoogleCloudVisionV1p1beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p1beta1Position { /** @@ -1408,34 +1225,23 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; } @@ -1444,13 +1250,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -1459,31 +1263,19 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchParams { /** - * The bounding polygon around the area of interest in the image. Optional. - * If it is not specified, system discretion will be applied. + * The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * The filtering expression. This can be used to restrict search results - * based on Product labels. We currently support an AND of OR of key-value - * expressions, where each expression within an OR must have the same key. - * An '=' should be used to connect the key and value. For example, - * "(color = red OR color = blue) AND brand = Google" is - * acceptable, but "(color = red OR brand = Google)" is not - * acceptable. "color: red" is not acceptable because it uses a - * ':' instead of an '='. + * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ filter?: string; /** - * The list of product categories to search in. Currently, we only consider - * the first category, and either "homegoods", - * "apparel", or "toys" should be specified. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods", "apparel", or "toys" should be specified. */ productCategories?: string[]; /** - * The resource name of a ProductSet to be searched for similar images. - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ productSet?: string; } @@ -1492,16 +1284,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult[]; /** @@ -1510,8 +1297,7 @@ export namespace vision_v1p1beta1 { results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult { /** @@ -1528,8 +1314,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -1537,8 +1322,7 @@ export namespace vision_v1p1beta1 { */ product?: Schema$GoogleCloudVisionV1p1beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -1560,15 +1344,11 @@ export namespace vision_v1p1beta1 { value?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p1beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -1576,15 +1356,11 @@ export namespace vision_v1p1beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -1597,14 +1373,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1621,13 +1390,7 @@ export namespace vision_v1p1beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p1beta1TextAnnotation { /** @@ -1661,9 +1424,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -1681,8 +1442,7 @@ export namespace vision_v1p1beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p1beta1Vertex { /** @@ -1699,13 +1459,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1713,9 +1471,7 @@ export namespace vision_v1p1beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1749,8 +1505,7 @@ export namespace vision_v1p1beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -1776,9 +1531,7 @@ export namespace vision_v1p1beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -1787,8 +1540,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1796,9 +1548,7 @@ export namespace vision_v1p1beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1815,14 +1565,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1834,14 +1577,12 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p1beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse { /** @@ -1852,14 +1593,17 @@ export namespace vision_v1p1beta1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext; /** @@ -1867,9 +1611,7 @@ export namespace vision_v1p1beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -1877,9 +1619,7 @@ export namespace vision_v1p1beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p2beta1TextAnnotation; /** @@ -1895,8 +1635,7 @@ export namespace vision_v1p1beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation[]; /** @@ -1934,8 +1673,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse[]; } @@ -1948,14 +1686,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1985,8 +1716,7 @@ export namespace vision_v1p1beta1 { vertices?: Schema$GoogleCloudVisionV1p2beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p2beta1ColorInfo { /** @@ -1994,8 +1724,7 @@ export namespace vision_v1p1beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -2008,8 +1737,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2017,8 +1745,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -2045,15 +1772,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -2061,26 +1784,19 @@ export namespace vision_v1p1beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p2beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p2beta1Property[]; /** @@ -2088,12 +1804,7 @@ export namespace vision_v1p1beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -2110,13 +1821,7 @@ export namespace vision_v1p1beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2124,12 +1829,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2149,15 +1849,11 @@ export namespace vision_v1p1beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -2169,8 +1865,7 @@ export namespace vision_v1p1beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -2196,22 +1891,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -2220,19 +1900,16 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -2253,13 +1930,16 @@ export namespace vision_v1p1beta1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p2beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2272,9 +1952,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -2300,8 +1978,7 @@ export namespace vision_v1p1beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p2beta1NormalizedVertex { /** @@ -2335,14 +2012,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -2363,8 +2033,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -2372,8 +2041,7 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -2382,14 +2050,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2406,9 +2067,7 @@ export namespace vision_v1p1beta1 { words?: Schema$GoogleCloudVisionV1p2beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p2beta1Position { /** @@ -2429,34 +2088,23 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; } @@ -2465,13 +2113,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -2480,16 +2126,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult[]; /** @@ -2498,8 +2139,7 @@ export namespace vision_v1p1beta1 { results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult { /** @@ -2516,8 +2156,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -2525,8 +2164,7 @@ export namespace vision_v1p1beta1 { */ product?: Schema$GoogleCloudVisionV1p2beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -2548,15 +2186,11 @@ export namespace vision_v1p1beta1 { value?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -2564,15 +2198,11 @@ export namespace vision_v1p1beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -2585,14 +2215,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2609,13 +2232,7 @@ export namespace vision_v1p1beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { /** @@ -2649,9 +2266,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -2669,8 +2284,7 @@ export namespace vision_v1p1beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p2beta1Vertex { /** @@ -2687,13 +2301,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2701,9 +2313,7 @@ export namespace vision_v1p1beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2728,8 +2338,7 @@ export namespace vision_v1p1beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -2755,9 +2364,7 @@ export namespace vision_v1p1beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -2766,8 +2373,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2775,9 +2381,7 @@ export namespace vision_v1p1beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2794,14 +2398,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2813,14 +2410,12 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p2beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p3beta1AnnotateFileResponse { /** @@ -2831,14 +2426,17 @@ export namespace vision_v1p1beta1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext; /** @@ -2846,9 +2444,7 @@ export namespace vision_v1p1beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p3beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -2856,9 +2452,7 @@ export namespace vision_v1p1beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p3beta1TextAnnotation; /** @@ -2874,8 +2468,7 @@ export namespace vision_v1p1beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p3beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation[]; /** @@ -2913,20 +2506,16 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p3beta1BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -2947,14 +2536,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2984,8 +2566,7 @@ export namespace vision_v1p1beta1 { vertices?: Schema$GoogleCloudVisionV1p3beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p3beta1ColorInfo { /** @@ -2993,8 +2574,7 @@ export namespace vision_v1p1beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -3007,8 +2587,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3016,8 +2595,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -3044,15 +2622,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -3060,26 +2634,19 @@ export namespace vision_v1p1beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p3beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p3beta1Property[]; /** @@ -3087,12 +2654,7 @@ export namespace vision_v1p1beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -3109,13 +2671,7 @@ export namespace vision_v1p1beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3123,12 +2679,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3148,15 +2699,11 @@ export namespace vision_v1p1beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -3168,8 +2715,7 @@ export namespace vision_v1p1beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -3195,22 +2741,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -3219,19 +2750,16 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -3249,9 +2777,7 @@ export namespace vision_v1p1beta1 { dominantColors?: Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p3beta1ImportProductSetsResponse { /** @@ -3259,10 +2785,7 @@ export namespace vision_v1p1beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p3beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -3270,13 +2793,16 @@ export namespace vision_v1p1beta1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p3beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p3beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -3289,9 +2815,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -3317,8 +2841,7 @@ export namespace vision_v1p1beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p3beta1NormalizedVertex { /** @@ -3352,14 +2875,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -3380,8 +2896,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -3389,8 +2904,7 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -3399,14 +2913,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3423,9 +2930,7 @@ export namespace vision_v1p1beta1 { words?: Schema$GoogleCloudVisionV1p3beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p3beta1Position { /** @@ -3446,34 +2951,23 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p3beta1ProductKeyValue[]; } @@ -3482,13 +2976,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -3497,16 +2989,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult[]; /** @@ -3515,8 +3002,7 @@ export namespace vision_v1p1beta1 { results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult { /** @@ -3533,8 +3019,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -3542,8 +3027,7 @@ export namespace vision_v1p1beta1 { */ product?: Schema$GoogleCloudVisionV1p3beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -3565,41 +3049,28 @@ export namespace vision_v1p1beta1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p3beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -3607,15 +3078,11 @@ export namespace vision_v1p1beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -3628,14 +3095,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3652,13 +3112,7 @@ export namespace vision_v1p1beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p3beta1TextAnnotation { /** @@ -3692,9 +3146,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -3712,8 +3164,7 @@ export namespace vision_v1p1beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p3beta1Vertex { /** @@ -3730,13 +3181,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3744,9 +3193,7 @@ export namespace vision_v1p1beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3771,8 +3218,7 @@ export namespace vision_v1p1beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -3798,9 +3244,7 @@ export namespace vision_v1p1beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -3809,8 +3253,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3818,9 +3261,7 @@ export namespace vision_v1p1beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3837,14 +3278,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3856,14 +3290,12 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p3beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse { /** @@ -3884,8 +3316,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext; /** @@ -3893,9 +3324,7 @@ export namespace vision_v1p1beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -3903,9 +3332,7 @@ export namespace vision_v1p1beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p4beta1TextAnnotation; /** @@ -3921,8 +3348,7 @@ export namespace vision_v1p1beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; /** @@ -3960,8 +3386,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; } @@ -3979,20 +3404,16 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { /** - * The list of file annotation responses, each response corresponding to - * each AnnotateFileRequest in BatchAnnotateFilesRequest. + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -4013,14 +3434,7 @@ export namespace vision_v1p1beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4050,8 +3464,7 @@ export namespace vision_v1p1beta1 { vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { /** @@ -4059,8 +3472,7 @@ export namespace vision_v1p1beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -4073,8 +3485,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4082,8 +3493,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -4110,15 +3520,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -4126,26 +3532,19 @@ export namespace vision_v1p1beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; /** @@ -4153,12 +3552,7 @@ export namespace vision_v1p1beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -4175,13 +3569,7 @@ export namespace vision_v1p1beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4189,12 +3577,7 @@ export namespace vision_v1p1beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4214,15 +3597,11 @@ export namespace vision_v1p1beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -4234,8 +3613,7 @@ export namespace vision_v1p1beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -4261,22 +3639,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -4285,19 +3648,16 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -4315,9 +3675,7 @@ export namespace vision_v1p1beta1 { dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** @@ -4325,10 +3683,7 @@ export namespace vision_v1p1beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -4337,11 +3692,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` - * fields, protobuffers use a pure binary representation, whereas JSON - * representations use base64. Currently, this field only works for - * BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles - * requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string; /** @@ -4349,8 +3700,7 @@ export namespace vision_v1p1beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -4363,9 +3713,7 @@ export namespace vision_v1p1beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -4391,8 +3739,7 @@ export namespace vision_v1p1beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { /** @@ -4426,14 +3773,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -4454,8 +3794,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -4463,8 +3802,7 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -4473,14 +3811,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4497,9 +3828,7 @@ export namespace vision_v1p1beta1 { words?: Schema$GoogleCloudVisionV1p4beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p4beta1Position { /** @@ -4520,34 +3849,23 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } @@ -4556,13 +3874,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -4571,16 +3887,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; /** @@ -4589,8 +3900,7 @@ export namespace vision_v1p1beta1 { results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { /** @@ -4607,8 +3917,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -4616,8 +3925,7 @@ export namespace vision_v1p1beta1 { */ product?: Schema$GoogleCloudVisionV1p4beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -4639,41 +3947,28 @@ export namespace vision_v1p1beta1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -4681,15 +3976,11 @@ export namespace vision_v1p1beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -4702,14 +3993,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4726,13 +4010,7 @@ export namespace vision_v1p1beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** @@ -4766,9 +4044,7 @@ export namespace vision_v1p1beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -4786,8 +4062,7 @@ export namespace vision_v1p1beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p4beta1Vertex { /** @@ -4804,13 +4079,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4818,9 +4091,7 @@ export namespace vision_v1p1beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4845,8 +4116,7 @@ export namespace vision_v1p1beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -4872,9 +4142,7 @@ export namespace vision_v1p1beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -4883,8 +4151,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4892,9 +4159,7 @@ export namespace vision_v1p1beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4911,14 +4176,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4930,276 +4188,1228 @@ export namespace vision_v1p1beta1 { */ property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; } /** - * Information about the products similar to a single product in a query - * image. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ - export interface Schema$GroupedResult { + export interface Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse { /** - * The bounding polygon around the product detected in the query image. + * Information about the file for which this response is generated. */ - boundingPoly?: Schema$BoundingPoly; + inputConfig?: Schema$GoogleCloudVisionV1p5beta1InputConfig; /** - * List of results, one for each product match. + * Individual responses to images found within the file. */ - results?: Schema$Result[]; + responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * Response to an image annotation request. */ - export interface Schema$ImageAnnotationContext { + export interface Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If present, contextual information is needed to understand where this image comes from. */ - pageNumber?: number; + context?: Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext; /** - * The URI of the file used to produce the image. + * If present, crop hints have completed successfully. */ - uri?: string; - } - /** - * Stores image properties, such as dominant colors. - */ - export interface Schema$ImageProperties { + cropHintsAnnotation?: Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation; /** - * If present, dominant colors completed successfully. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ - dominantColors?: Schema$DominantColorsAnnotation; - } - /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. - */ - export interface Schema$ImportProductSetsResponse { + error?: Schema$Status; /** - * The list of reference_images that are imported successfully. + * If present, face detection has completed successfully. */ - referenceImages?: Schema$ReferenceImage[]; + faceAnnotations?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotation[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ - statuses?: Schema$Status[]; - } - /** - * The desired input location and metadata. - */ - export interface Schema$InputConfig { + fullTextAnnotation?: Schema$GoogleCloudVisionV1p5beta1TextAnnotation; /** - * The Google Cloud Storage location to read the input from. + * If present, image properties were extracted successfully. */ - gcsSource?: Schema$GcsSource; + imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p5beta1ImageProperties; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * If present, label detection has completed successfully. */ - mimeType?: string; - } - /** - * A product label represented as a key-value pair. - */ - export interface Schema$KeyValue { + labelAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * If present, landmark detection has completed successfully. */ - key?: string; + landmarkAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ - value?: string; - } - /** - * A face-specific landmark (for example, a face feature). - */ - export interface Schema$Landmark { + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation[]; /** - * Face landmark position. + * If present, logo detection has completed successfully. */ - position?: Schema$Position; + logoAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * Face landmark type. + * If present, product search has completed successfully. */ - type?: string; - } - /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. - */ - export interface Schema$LatLng { + productSearchResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResults; /** - * The latitude in degrees. It must be in the range [-90.0, +90.0]. + * If present, safe-search annotation has completed successfully. */ - latitude?: number; + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation; /** - * The longitude in degrees. It must be in the range [-180.0, +180.0]. + * If present, text (OCR) detection has completed successfully. */ - longitude?: number; + textAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection?: Schema$GoogleCloudVisionV1p5beta1WebDetection; } /** - * Set of detected objects with bounding boxes. + * The response for a single offline file annotation request. */ - export interface Schema$LocalizedObjectAnnotation { - /** - * Image region to which this object belongs. This must be populated. - */ - boundingPoly?: Schema$BoundingPoly; - /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string; + export interface Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse { /** - * Object ID that should align with EntityAnnotation mid. + * The output location and metadata from AsyncAnnotateFileRequest. */ - mid?: string; + outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + } + /** + * Response to an async batch file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateFilesResponse { /** - * Object name, expressed in its `language_code` language. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ - name?: string; + responses?: Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse[]; + } + /** + * Response to an async batch image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateImagesResponse { /** - * Score of the result. Range [0, 1]. + * The output location and metadata from AsyncBatchAnnotateImagesRequest. */ - score?: number; + outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; } /** - * Detected entity location information. + * A list of file annotation responses. */ - export interface Schema$LocationInfo { + export interface Schema$GoogleCloudVisionV1p5beta1BatchAnnotateFilesResponse { /** - * lat/long location coordinates. + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ - latLng?: Schema$LatLng; + responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ - export interface Schema$NormalizedVertex { + export interface Schema$GoogleCloudVisionV1p5beta1BatchOperationMetadata { /** - * X coordinate. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - x?: number; + endTime?: string; /** - * Y coordinate. + * The current state of the batch operation. */ - y?: number; + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * Logical element on the page. */ - export interface Schema$Operation { + export interface Schema$GoogleCloudVisionV1p5beta1Block { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * Detected block type (text, image etc) for this block. */ - done?: boolean; + blockType?: string; /** - * The error result of the operation in case of failure or cancellation. + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - error?: Schema$Status; + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Confidence of the OCR results on the block. Range [0, 1]. */ - metadata?: {[key: string]: any}; + confidence?: number; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ - name?: string; + keyValuePair?: Schema$GoogleCloudVisionV1p5beta1KeyValuePair; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. */ - response?: {[key: string]: any}; - } - /** - * Contains metadata for the BatchAnnotateImages operation. - */ - export interface Schema$OperationMetadata { + mergedText?: string; /** - * The time when the batch request was received. + * List of paragraphs in this block (if this blocks is of type text). */ - createTime?: string; + paragraphs?: Schema$GoogleCloudVisionV1p5beta1Paragraph[]; /** - * Current state of the batch operation. + * Additional information detected for the block. */ - state?: string; + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; /** - * The time when the operation result was last updated. + * Detected table for TABLE block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ - updateTime?: string; + table?: Schema$GoogleCloudVisionV1p5beta1Table; } /** - * The desired output location and metadata. + * A bounding polygon for the detected image annotation. */ - export interface Schema$OutputConfig { + export interface Schema$GoogleCloudVisionV1p5beta1BoundingPoly { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The bounding polygon normalized vertices. */ - batchSize?: number; + normalizedVertices?: Schema$GoogleCloudVisionV1p5beta1NormalizedVertex[]; /** - * The Google Cloud Storage location to write the output(s) to. + * The bounding polygon vertices. */ - gcsDestination?: Schema$GcsDestination; + vertices?: Schema$GoogleCloudVisionV1p5beta1Vertex[]; } /** - * Detected page from OCR. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ - export interface Schema$Page { + export interface Schema$GoogleCloudVisionV1p5beta1ColorInfo { /** - * List of blocks of text, images etc on this page. + * RGB components of the color. */ - blocks?: Schema$Block[]; + color?: Schema$Color; /** - * Confidence of the OCR results on the page. Range [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - confidence?: number; + pixelFraction?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Image-specific score for this color. Value in range [0, 1]. */ - height?: number; - /** + score?: number; + } + /** + * Single crop hint that is used to generate a new crop when serving an image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1CropHint { + /** + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of this being a salient region. Range [0, 1]. + */ + confidence?: number; + /** + * Fraction of importance of this salient region with respect to the original image. + */ + importanceFraction?: number; + } + /** + * Set of crop hints that are used to generate new crops when serving images. + */ + export interface Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints?: Schema$GoogleCloudVisionV1p5beta1CropHint[]; + } + /** + * Set of dominant colors and their corresponding scores. + */ + export interface Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors?: Schema$GoogleCloudVisionV1p5beta1ColorInfo[]; + } + /** + * Set of detected entity features. + */ + export interface Schema$GoogleCloudVisionV1p5beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. + */ + confidence?: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description?: string; + /** + * The language code for the locale in which the entity textual `description` is expressed. + */ + locale?: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. + */ + locations?: Schema$GoogleCloudVisionV1p5beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). + */ + mid?: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. + */ + properties?: Schema$GoogleCloudVisionV1p5beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score?: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality?: number; + } + /** + * A face annotation object contains the results of face detection. + */ + export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood?: string; + /** + * Blurred likelihood. + */ + blurredLikelihood?: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence?: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + */ + fdBoundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood?: string; + /** + * Joy likelihood. + */ + joyLikelihood?: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence?: number; + /** + * Detected face landmarks. + */ + landmarks?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. + */ + panAngle?: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. + */ + rollAngle?: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood?: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood?: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle?: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position?: Schema$GoogleCloudVisionV1p5beta1Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * The Google Cloud Storage location where the output will be written to. + */ + export interface Schema$GoogleCloudVisionV1p5beta1GcsDestination { + /** + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + */ + uri?: string; + } + /** + * The Google Cloud Storage location where the input will be read from. + */ + export interface Schema$GoogleCloudVisionV1p5beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. + */ + uri?: string; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation; + } + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$GoogleCloudVisionV1p5beta1ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p5beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * Proto for a key value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1KeyValuePair { + /** + * The key string value. + */ + key?: string; + /** + * Key block of the pair containing the normalized bounding box and key text. + */ + keyBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + /** + * Optional. The translation of key text if the text is not in English. + */ + normalizedKey?: string; + /** + * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. + */ + valueBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + /** + * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. + */ + valueType?: string; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$GoogleCloudVisionV1p5beta1LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$GoogleCloudVisionV1p5beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p5beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GoogleCloudVisionV1p5beta1GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$GoogleCloudVisionV1p5beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** + * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. + */ + mergedText?: string; + /** + * Additional information detected on the page. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + width?: number; + } + /** + * Structural unit of text representing a number of words in certain order. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Paragraph { + /** + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence?: number; + /** + * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. + */ + mergedText?: string; + /** + * Additional information detected for the paragraph. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words?: Schema$GoogleCloudVisionV1p5beta1Word[]; + } + /** + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Position { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + /** + * Z coordinate (or depth). + */ + z?: number; + } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p5beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p5beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). + */ + score?: number; + } + /** + * A `Property` consists of a user-supplied name/value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Property { + /** + * Name of the property. + */ + name?: string; + /** + * Value of numeric properties. + */ + uint64Value?: string; + /** + * Value of the property. + */ + value?: string; + } + /** + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly[]; + /** + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + */ + uri?: string; + } + /** + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). + */ + export interface Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. + */ + adult?: string; + /** + * Likelihood that this is a medical image. + */ + medical?: string; + /** + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. + */ + racy?: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. + */ + spoof?: string; + /** + * Likelihood that this image contains violent content. + */ + violence?: string; + } + /** + * A single symbol representation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the symbol. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text?: string; + } + /** + * A table representation similar to HTML table structure. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Table { + /** + * Body rows of the table + */ + bodyRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; + /** + * Header rows of the table + */ + headerRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; + } + /** + * A cell representation inside of tables. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TableTableCell { + /** + * How many columns this cell spans. + */ + colSpan?: number; + /** + * How many rows this cell spans. + */ + rowSpan?: number; + /** + * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. + */ + text?: string; + /** + * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. + */ + textBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + } + /** + * A row of table cells. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TableTableRow { + /** + * Cells that make up this row. + */ + cells?: Schema$GoogleCloudVisionV1p5beta1TableTableCell[]; + } + /** + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages?: Schema$GoogleCloudVisionV1p5beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text?: string; + } + /** + * Detected start or end of a structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix?: boolean; + /** + * Detected break type. + */ + type?: string; + } + /** + * Detected language for a structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence?: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Additional information detected on the structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage[]; + } + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Vertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Relevant information for the image from the Internet. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetection { + /** + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. + */ + bestGuessLabels?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage[]; + /** + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity[]; + } + /** + * Entity deduced from similar images on the Internet. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description?: string; + /** + * Opaque entity ID. + */ + entityId?: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. + */ + score?: number; + } + /** + * Metadata for online images. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score?: number; + /** + * The result image URL. + */ + url?: string; + } + /** + * Label to provide extra metadata for the web detection. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label?: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Metadata for web pages. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle?: string; + /** + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score?: number; + /** + * The result web page URL. + */ + url?: string; + } + /** + * A word representation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Word { + /** + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence?: number; + /** + * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. + */ + mergedText?: string; + /** + * Additional information detected for the word. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural reading order. + */ + symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$DominantColorsAnnotation; + } + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GcsSource; + /** + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$KeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$Landmark { + /** + * Face landmark position. + */ + position?: Schema$Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + */ + export interface Schema$LatLng { + /** + * The latitude in degrees. It must be in the range [-90.0, +90.0]. + */ + latitude?: number; + /** + * The longitude in degrees. It must be in the range [-180.0, +180.0]. + */ + longitude?: number; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any}; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any}; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** * Additional information detected on the page. */ property?: Schema$TextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -5208,14 +5418,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5232,9 +5435,7 @@ export namespace vision_v1p1beta1 { words?: Schema$Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$Position { /** @@ -5255,34 +5456,23 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$KeyValue[]; } @@ -5291,16 +5481,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GroupedResult[]; /** @@ -5326,28 +5511,19 @@ export namespace vision_v1p1beta1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } @@ -5356,8 +5532,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Result { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -5365,21 +5540,16 @@ export namespace vision_v1p1beta1 { */ product?: Schema$Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -5387,15 +5557,11 @@ export namespace vision_v1p1beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -5404,40 +5570,7 @@ export namespace vision_v1p1beta1 { violence?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -5445,14 +5578,11 @@ export namespace vision_v1p1beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -5461,14 +5591,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5485,13 +5608,7 @@ export namespace vision_v1p1beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$TextAnnotation { /** @@ -5517,8 +5634,7 @@ export namespace vision_v1p1beta1 { detectedLanguages?: Schema$DetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$Vertex { /** @@ -5535,13 +5651,11 @@ export namespace vision_v1p1beta1 { */ export interface Schema$WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$WebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$WebImage[]; /** @@ -5549,9 +5663,7 @@ export namespace vision_v1p1beta1 { */ pagesWithMatchingImages?: Schema$WebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** @@ -5576,8 +5688,7 @@ export namespace vision_v1p1beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -5603,9 +5714,7 @@ export namespace vision_v1p1beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -5614,8 +5723,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$WebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$WebImage[]; /** @@ -5623,9 +5731,7 @@ export namespace vision_v1p1beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** @@ -5642,14 +5748,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5661,8 +5760,7 @@ export namespace vision_v1p1beta1 { */ property?: Schema$TextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$Symbol[]; } @@ -5673,14 +5771,108 @@ export namespace vision_v1p1beta1 { this.context = context; } + /** + * vision.files.annotate + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @alias vision.files.annotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + annotate( + params?: Params$Resource$Files$Annotate, + options?: MethodOptions + ): GaxiosPromise< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + >; + annotate( + params: Params$Resource$Files$Annotate, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + > + ): void; + annotate( + params: Params$Resource$Files$Annotate, + callback: BodyResponseCallback< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + > + ): void; + annotate( + callback: BodyResponseCallback< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + > + ): void; + annotate( + paramsOrCallback?: + | Params$Resource$Files$Annotate + | BodyResponseCallback< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + > { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Annotate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Annotate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/files:annotate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse + >(parameters); + } + } + /** * vision.files.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of - * generic files, such as PDF files, which may contain multiple pages and - * multiple images per page. Progress and results can be retrieved through - * the `google.longrunning.Operations` interface. `Operation.metadata` - * contains `OperationMetadata` (metadata). `Operation.response` contains - * `AsyncBatchAnnotateFilesResponse` (results). + * @desc Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). * @alias vision.files.asyncBatchAnnotate * @memberOf! () * @@ -5753,6 +5945,17 @@ export namespace vision_v1p1beta1 { } } + export interface Params$Resource$Files$Annotate extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest; + } export interface Params$Resource$Files$Asyncbatchannotate extends StandardParameters { /** @@ -5870,6 +6073,80 @@ export namespace vision_v1p1beta1 { >(parameters); } } + + /** + * vision.images.asyncBatchAnnotate + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @alias vision.images.asyncBatchAnnotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + asyncBatchAnnotate( + params?: Params$Resource$Images$Asyncbatchannotate, + options?: MethodOptions + ): GaxiosPromise; + asyncBatchAnnotate( + params: Params$Resource$Images$Asyncbatchannotate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + asyncBatchAnnotate( + params: Params$Resource$Images$Asyncbatchannotate, + callback: BodyResponseCallback + ): void; + asyncBatchAnnotate(callback: BodyResponseCallback): void; + asyncBatchAnnotate( + paramsOrCallback?: + | Params$Resource$Images$Asyncbatchannotate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Images$Asyncbatchannotate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Asyncbatchannotate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/images:asyncBatchAnnotate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Images$Annotate extends StandardParameters { @@ -5883,4 +6160,16 @@ export namespace vision_v1p1beta1 { */ requestBody?: Schema$GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest; } + export interface Params$Resource$Images$Asyncbatchannotate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest; + } } diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index a09ad34f67a..069154f5f6a 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace vision_v1p2beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace vision_v1p2beta1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,9 +91,7 @@ export namespace vision_v1p2beta1 { /** * Cloud Vision API * - * Integrates Google Vision features, including image labeling, face, logo, - * and landmark detection, optical character recognition (OCR), and detection - * of explicit content, into applications. + * Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications. * * @example * const {google} = require('googleapis'); @@ -115,7 +109,10 @@ export namespace vision_v1p2beta1 { images: Resource$Images; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.files = new Resource$Files(this.context); this.images = new Resource$Images(this.context); @@ -123,8 +120,7 @@ export namespace vision_v1p2beta1 { } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$AnnotateFileResponse { /** @@ -135,14 +131,17 @@ export namespace vision_v1p2beta1 { * Individual responses to images found within the file. */ responses?: Schema$AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$ImageAnnotationContext; /** @@ -150,9 +149,7 @@ export namespace vision_v1p2beta1 { */ cropHintsAnnotation?: Schema$CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -160,9 +157,7 @@ export namespace vision_v1p2beta1 { */ faceAnnotations?: Schema$FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$TextAnnotation; /** @@ -178,8 +173,7 @@ export namespace vision_v1p2beta1 { */ landmarkAnnotations?: Schema$EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$LocalizedObjectAnnotation[]; /** @@ -217,20 +211,34 @@ export namespace vision_v1p2beta1 { */ export interface Schema$AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Response to an async batch image annotation request. + */ + export interface Schema$AsyncBatchAnnotateImagesResponse { + /** + * The output location and metadata from AsyncBatchAnnotateImagesRequest. + */ + outputConfig?: Schema$OutputConfig; + } + /** + * A list of file annotation responses. + */ + export interface Schema$BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$AnnotateFileResponse[]; + } + /** + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -251,14 +259,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -288,72 +289,11 @@ export namespace vision_v1p2beta1 { vertices?: Schema$Vertex[]; } /** - * Represents a color in the RGBA color space. This representation is designed - * for simplicity of conversion to/from color representations in various - * languages over compactness; for example, the fields of this representation - * can be trivially provided to the constructor of "java.awt.Color" - * in Java; it can also be trivially provided to UIColor's - * "+colorWithRed:green:blue:alpha" method in iOS; and, with just a - * little work, it can be easily formatted into a CSS "rgba()" - * string in JavaScript, as well. Note: this proto does not carry information - * about the absolute color space that should be used to interpret the RGB - * value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, - * applications SHOULD assume the sRGB color space. Example (Java): import - * com.google.type.Color; // ... public static java.awt.Color - * fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? - * protocolor.getAlpha().getValue() : 1.0; return new - * java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - * protocolor.getBlue(), alpha); } public static Color - * toProto(java.awt.Color color) { float red = (float) color.getRed(); - * float green = (float) color.getGreen(); float blue = (float) - * color.getBlue(); float denominator = 255.0; Color.Builder - * resultBuilder = Color .newBuilder() .setRed(red / - * denominator) .setGreen(green / denominator) .setBlue(blue / - * denominator); int alpha = color.getAlpha(); if (alpha != 255) - * { result.setAlpha( FloatValue .newBuilder() - * .setValue(((float) alpha) / denominator) .build()); } - * return resultBuilder.build(); } // ... Example (iOS / Obj-C): // - * ... static UIColor* fromProto(Color* protocolor) { float red = - * [protocolor red]; float green = [protocolor green]; float - * blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor - * alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { - * alpha = [alpha_wrapper value]; } return [UIColor - * colorWithRed:red green:green blue:blue alpha:alpha]; } static - * Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; - * if (![color getRed:&red green:&green blue:&blue - * alpha:&alpha]) { return nil; } Color* - * result = [[Color alloc] init]; [result setRed:red]; [result - * setGreen:green]; [result setBlue:blue]; if (alpha <= - * 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } - * [result autorelease]; return result; } // ... Example - * (JavaScript): // ... var protoToCssColor = function(rgb_color) { - * var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green - * || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = - * Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); - * var blue = Math.floor(blueFrac * 255); if (!('alpha' in - * rgb_color)) { return rgbToCssColor_(red, green, blue); } - * var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - * green, blue].join(','); return ['rgba(', rgbParams, - * ',', alphaFrac, ')'].join(''); }; var - * rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new - * Number((red << 16) | (green << 8) | blue); var hexString - * = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; - * var resultBuilder = ['#']; for (var i = 0; i < - * missingZeros; i++) { resultBuilder.push('0'); } - * resultBuilder.push(hexString); return resultBuilder.join(''); - * }; // ... + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... */ export interface Schema$Color { /** - * The fraction of this color that should be applied to the pixel. That is, - * the final pixel color is defined by the equation: pixel color = alpha - * * (this color) + (1.0 - alpha) * (background color) This means that a - * value of 1.0 corresponds to a solid color, whereas a value of 0.0 - * corresponds to a completely transparent color. This uses a wrapper - * message rather than a simple float scalar so that it is possible to - * distinguish between a default value and the value being unset. If - * omitted, this color object is to be rendered as a solid color (as if the - * alpha value had been explicitly given with a value of 1.0). + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). */ alpha?: number; /** @@ -370,8 +310,7 @@ export namespace vision_v1p2beta1 { red?: number; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$ColorInfo { /** @@ -379,8 +318,7 @@ export namespace vision_v1p2beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -393,8 +331,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$BoundingPoly; /** @@ -402,8 +339,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -438,9 +374,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -458,15 +392,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -474,26 +404,19 @@ export namespace vision_v1p2beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$Property[]; /** @@ -501,12 +424,7 @@ export namespace vision_v1p2beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -523,13 +441,7 @@ export namespace vision_v1p2beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$BoundingPoly; /** @@ -537,12 +449,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$BoundingPoly; /** @@ -562,15 +469,11 @@ export namespace vision_v1p2beta1 { */ landmarks?: Schema$Landmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -582,8 +485,7 @@ export namespace vision_v1p2beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -596,22 +498,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -620,14 +507,12 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateFileResponse { /** @@ -638,14 +523,17 @@ export namespace vision_v1p2beta1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext; /** @@ -653,9 +541,7 @@ export namespace vision_v1p2beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p1beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -663,9 +549,7 @@ export namespace vision_v1p2beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p1beta1TextAnnotation; /** @@ -681,8 +565,7 @@ export namespace vision_v1p2beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation[]; /** @@ -720,8 +603,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse[]; } @@ -734,14 +616,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -771,8 +646,7 @@ export namespace vision_v1p2beta1 { vertices?: Schema$GoogleCloudVisionV1p1beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p1beta1ColorInfo { /** @@ -780,8 +654,7 @@ export namespace vision_v1p2beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -794,8 +667,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -803,8 +675,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -831,15 +702,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -847,26 +714,19 @@ export namespace vision_v1p2beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p1beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p1beta1Property[]; /** @@ -874,12 +734,7 @@ export namespace vision_v1p2beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -896,13 +751,7 @@ export namespace vision_v1p2beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -910,12 +759,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -935,15 +779,11 @@ export namespace vision_v1p2beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -955,8 +795,7 @@ export namespace vision_v1p2beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -982,22 +821,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -1006,19 +830,16 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -1039,13 +860,16 @@ export namespace vision_v1p2beta1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p1beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p1beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -1058,9 +882,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -1086,8 +908,7 @@ export namespace vision_v1p2beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p1beta1NormalizedVertex { /** @@ -1121,14 +942,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -1149,8 +963,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -1158,8 +971,7 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -1168,14 +980,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1192,9 +997,7 @@ export namespace vision_v1p2beta1 { words?: Schema$GoogleCloudVisionV1p1beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p1beta1Position { /** @@ -1215,34 +1018,23 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; } @@ -1251,13 +1043,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -1266,16 +1056,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult[]; /** @@ -1284,8 +1069,7 @@ export namespace vision_v1p2beta1 { results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult { /** @@ -1302,8 +1086,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -1311,8 +1094,7 @@ export namespace vision_v1p2beta1 { */ product?: Schema$GoogleCloudVisionV1p1beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -1334,15 +1116,11 @@ export namespace vision_v1p2beta1 { value?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p1beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -1350,15 +1128,11 @@ export namespace vision_v1p2beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -1371,14 +1145,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1395,13 +1162,7 @@ export namespace vision_v1p2beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p1beta1TextAnnotation { /** @@ -1435,9 +1196,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -1455,8 +1214,7 @@ export namespace vision_v1p2beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p1beta1Vertex { /** @@ -1473,13 +1231,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1487,9 +1243,7 @@ export namespace vision_v1p2beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1514,8 +1268,7 @@ export namespace vision_v1p2beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -1541,9 +1294,7 @@ export namespace vision_v1p2beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -1552,8 +1303,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1561,9 +1311,7 @@ export namespace vision_v1p2beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** @@ -1580,14 +1328,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1599,14 +1340,33 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p1beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * A request to annotate one single file, e.g. a PDF, TIFF or GIF file. + */ + export interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileRequest { + /** + * Required. Requested features. + */ + features?: Schema$GoogleCloudVisionV1p2beta1Feature[]; + /** + * Additional context that may accompany the image(s) in the file. + */ + imageContext?: Schema$GoogleCloudVisionV1p2beta1ImageContext; + /** + * Required. Information about the input file. + */ + inputConfig?: Schema$GoogleCloudVisionV1p2beta1InputConfig; + /** + * Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. + */ + pages?: number[]; + } + /** + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse { /** @@ -1617,10 +1377,13 @@ export namespace vision_v1p2beta1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** - * Request for performing Google Cloud Vision API tasks over a user-provided - * image, with user-requested features, and with context information. + * Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information. */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageRequest { /** @@ -1641,8 +1404,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext; /** @@ -1650,9 +1412,7 @@ export namespace vision_v1p2beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -1660,9 +1420,7 @@ export namespace vision_v1p2beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p2beta1TextAnnotation; /** @@ -1678,8 +1436,7 @@ export namespace vision_v1p2beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation[]; /** @@ -1734,8 +1491,7 @@ export namespace vision_v1p2beta1 { outputConfig?: Schema$GoogleCloudVisionV1p2beta1OutputConfig; } /** - * Multiple async file annotation requests are batched into a single service - * call. + * Multiple async file annotation requests are batched into a single service call. */ export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest { /** @@ -1748,11 +1504,41 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse[]; } + /** + * Request for async image annotation for a list of images. + */ + export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest { + /** + * Required. The desired output location and metadata (e.g. format). + */ + outputConfig?: Schema$GoogleCloudVisionV1p2beta1OutputConfig; + /** + * Individual image annotation requests for this batch. + */ + requests?: Schema$GoogleCloudVisionV1p2beta1AnnotateImageRequest[]; + } + /** + * A list of requests to annotate files using the BatchAnnotateFiles API. + */ + export interface Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest { + /** + * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + requests?: Schema$GoogleCloudVisionV1p2beta1AnnotateFileRequest[]; + } + /** + * A list of file annotation responses. + */ + export interface Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse[]; + } /** * Multiple image annotation requests are batched into a single service call. */ @@ -1780,14 +1566,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1817,8 +1596,7 @@ export namespace vision_v1p2beta1 { vertices?: Schema$GoogleCloudVisionV1p2beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p2beta1ColorInfo { /** @@ -1826,8 +1604,7 @@ export namespace vision_v1p2beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -1840,8 +1617,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1849,8 +1625,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -1868,12 +1643,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1CropHintsParams { /** - * Aspect ratios in floats, representing the ratio of the width to the - * height of the image. For example, if the desired aspect ratio is 4/3, the - * corresponding float value should be 1.33333. If not specified, the best - * possible crop is returned. The number of provided aspect ratios is - * limited to a maximum of 16; any aspect ratios provided after the 16th are - * ignored. + * Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored. */ aspectRatios?: number[]; } @@ -1891,15 +1661,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -1907,26 +1673,19 @@ export namespace vision_v1p2beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p2beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p2beta1Property[]; /** @@ -1934,12 +1693,7 @@ export namespace vision_v1p2beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -1956,13 +1710,7 @@ export namespace vision_v1p2beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1970,12 +1718,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -1995,15 +1738,11 @@ export namespace vision_v1p2beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -2015,8 +1754,7 @@ export namespace vision_v1p2beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -2038,20 +1776,15 @@ export namespace vision_v1p2beta1 { type?: string; } /** - * The type of Google Cloud Vision API detection to perform, and the maximum - * number of results to return for that type. Multiple `Feature` objects can - * be specified in the `features` list. + * The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list. */ export interface Schema$GoogleCloudVisionV1p2beta1Feature { /** - * Maximum number of results of this type. Does not apply to - * `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + * Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. */ maxResults?: number; /** - * Model to use for the feature. Supported values: - * "builtin/stable" (the default if unset) and - * "builtin/latest". + * Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". */ model?: string; /** @@ -2064,22 +1797,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -2088,8 +1806,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } @@ -2098,26 +1815,20 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Image { /** - * Image content, represented as a stream of bytes. Note: As with all - * `bytes` fields, protobuffers use a pure binary representation, whereas - * JSON representations use base64. + * Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ content?: string; /** - * Google Cloud Storage image location, or publicly-accessible image URL. If - * both `content` and `source` are provided for an image, `content` takes - * precedence and is used to perform the image annotation request. + * Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request. */ source?: Schema$GoogleCloudVisionV1p2beta1ImageSource; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -2134,14 +1845,7 @@ export namespace vision_v1p2beta1 { */ cropHintsParams?: Schema$GoogleCloudVisionV1p2beta1CropHintsParams; /** - * List of languages to use for TEXT_DETECTION. In most cases, an empty - * value yields the best results since it enables automatic language - * detection. For languages based on the Latin alphabet, setting - * `language_hints` is not needed. In rare cases, when the language of the - * text in the image is known, setting a hint will help get better results - * (although it will be a significant hindrance if the hint is wrong). Text - * detection returns an error if one or more of the specified languages is - * not one of the [supported languages](/vision/docs/languages). + * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). */ languageHints?: string[]; /** @@ -2171,26 +1875,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ImageSource { /** - * **Use `image_uri` instead.** The Google Cloud Storage URI of the form - * `gs://bucket_name/object_name`. Object versioning is not supported. See - * [Google Cloud Storage Request - * URIs](https://cloud.google.com/storage/docs/reference-uris) for more - * info. + * **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. */ gcsImageUri?: string; /** - * The URI of the source image. Can be either: 1. A Google Cloud Storage - * URI of the form `gs://bucket_name/object_name`. Object versioning is - * not supported. See [Google Cloud Storage Request - * URIs](https://cloud.google.com/storage/docs/reference-uris) for more - * info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching - * images from HTTP/HTTPS URLs, Google cannot guarantee that the request - * will be completed. Your request may fail if the specified host denies - * the request (e.g. due to request throttling or DOS prevention), or if - * Google throttles requests to the site for abuse prevention. You should - * not depend on externally-hosted images for production applications. - * When both `gcs_image_uri` and `image_uri` are specified, `image_uri` - * takes precedence. + * The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence. */ imageUri?: string; } @@ -2198,13 +1887,16 @@ export namespace vision_v1p2beta1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p2beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2230,9 +1922,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -2258,8 +1948,7 @@ export namespace vision_v1p2beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p2beta1NormalizedVertex { /** @@ -2293,14 +1982,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -2321,8 +2003,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -2330,8 +2011,7 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -2340,14 +2020,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2364,9 +2037,7 @@ export namespace vision_v1p2beta1 { words?: Schema$GoogleCloudVisionV1p2beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p2beta1Position { /** @@ -2387,34 +2058,23 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; } @@ -2423,13 +2083,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -2438,31 +2096,19 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchParams { /** - * The bounding polygon around the area of interest in the image. Optional. - * If it is not specified, system discretion will be applied. + * The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * The filtering expression. This can be used to restrict search results - * based on Product labels. We currently support an AND of OR of key-value - * expressions, where each expression within an OR must have the same key. - * An '=' should be used to connect the key and value. For example, - * "(color = red OR color = blue) AND brand = Google" is - * acceptable, but "(color = red OR brand = Google)" is not - * acceptable. "color: red" is not acceptable because it uses a - * ':' instead of an '='. + * The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='. */ filter?: string; /** - * The list of product categories to search in. Currently, we only consider - * the first category, and either "homegoods", - * "apparel", or "toys" should be specified. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods", "apparel", or "toys" should be specified. */ productCategories?: string[]; /** - * The resource name of a ProductSet to be searched for similar images. - * Format is: - * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + * The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ productSet?: string; } @@ -2471,16 +2117,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult[]; /** @@ -2489,8 +2130,7 @@ export namespace vision_v1p2beta1 { results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult { /** @@ -2507,8 +2147,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -2516,8 +2155,7 @@ export namespace vision_v1p2beta1 { */ product?: Schema$GoogleCloudVisionV1p2beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -2539,15 +2177,11 @@ export namespace vision_v1p2beta1 { value?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -2555,15 +2189,11 @@ export namespace vision_v1p2beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -2576,14 +2206,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2600,13 +2223,7 @@ export namespace vision_v1p2beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { /** @@ -2640,9 +2257,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -2660,8 +2275,7 @@ export namespace vision_v1p2beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p2beta1Vertex { /** @@ -2678,13 +2292,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2692,9 +2304,7 @@ export namespace vision_v1p2beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2728,8 +2338,7 @@ export namespace vision_v1p2beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -2755,9 +2364,7 @@ export namespace vision_v1p2beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -2766,8 +2373,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2775,9 +2381,7 @@ export namespace vision_v1p2beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** @@ -2794,14 +2398,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2813,14 +2410,12 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p2beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p3beta1AnnotateFileResponse { /** @@ -2831,14 +2426,17 @@ export namespace vision_v1p2beta1 { * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** * Response to an image annotation request. */ export interface Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext; /** @@ -2846,9 +2444,7 @@ export namespace vision_v1p2beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p3beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -2856,9 +2452,7 @@ export namespace vision_v1p2beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p3beta1TextAnnotation; /** @@ -2874,8 +2468,7 @@ export namespace vision_v1p2beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p3beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation[]; /** @@ -2913,20 +2506,16 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p3beta1BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -2947,14 +2536,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -2984,8 +2566,7 @@ export namespace vision_v1p2beta1 { vertices?: Schema$GoogleCloudVisionV1p3beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p3beta1ColorInfo { /** @@ -2993,8 +2574,7 @@ export namespace vision_v1p2beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -3007,8 +2587,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3016,8 +2595,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -3044,15 +2622,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -3060,26 +2634,19 @@ export namespace vision_v1p2beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p3beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p3beta1Property[]; /** @@ -3087,12 +2654,7 @@ export namespace vision_v1p2beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -3109,13 +2671,7 @@ export namespace vision_v1p2beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3123,12 +2679,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3148,15 +2699,11 @@ export namespace vision_v1p2beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -3168,8 +2715,7 @@ export namespace vision_v1p2beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -3195,22 +2741,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -3219,19 +2750,16 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -3249,9 +2777,7 @@ export namespace vision_v1p2beta1 { dominantColors?: Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p3beta1ImportProductSetsResponse { /** @@ -3259,10 +2785,7 @@ export namespace vision_v1p2beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p3beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -3270,13 +2793,16 @@ export namespace vision_v1p2beta1 { * The desired input location and metadata. */ export interface Schema$GoogleCloudVisionV1p3beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p3beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -3289,9 +2815,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -3317,8 +2841,7 @@ export namespace vision_v1p2beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p3beta1NormalizedVertex { /** @@ -3352,14 +2875,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -3380,8 +2896,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -3389,8 +2904,7 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -3399,14 +2913,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3423,9 +2930,7 @@ export namespace vision_v1p2beta1 { words?: Schema$GoogleCloudVisionV1p3beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p3beta1Position { /** @@ -3446,34 +2951,23 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p3beta1ProductKeyValue[]; } @@ -3482,13 +2976,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -3497,16 +2989,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult[]; /** @@ -3515,8 +3002,7 @@ export namespace vision_v1p2beta1 { results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult { /** @@ -3533,8 +3019,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -3542,8 +3027,7 @@ export namespace vision_v1p2beta1 { */ product?: Schema$GoogleCloudVisionV1p3beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -3565,41 +3049,28 @@ export namespace vision_v1p2beta1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p3beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -3607,15 +3078,11 @@ export namespace vision_v1p2beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -3628,14 +3095,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3652,13 +3112,7 @@ export namespace vision_v1p2beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p3beta1TextAnnotation { /** @@ -3692,9 +3146,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -3712,8 +3164,7 @@ export namespace vision_v1p2beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p3beta1Vertex { /** @@ -3730,13 +3181,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3744,9 +3193,7 @@ export namespace vision_v1p2beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3771,8 +3218,7 @@ export namespace vision_v1p2beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -3798,9 +3244,7 @@ export namespace vision_v1p2beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -3809,8 +3253,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3818,9 +3261,7 @@ export namespace vision_v1p2beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** @@ -3837,14 +3278,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3856,14 +3290,12 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p3beta1Symbol[]; } /** - * Response to a single file annotation request. A file may contain one or - * more images, which individually have their own responses. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ export interface Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse { /** @@ -3884,8 +3316,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1AnnotateImageResponse { /** - * If present, contextual information is needed to understand where this - * image comes from. + * If present, contextual information is needed to understand where this image comes from. */ context?: Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext; /** @@ -3893,9 +3324,7 @@ export namespace vision_v1p2beta1 { */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation; /** - * If set, represents the error message for the operation. Note that - * filled-in image annotations are guaranteed to be correct, even when - * `error` is set. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ error?: Schema$Status; /** @@ -3903,9 +3332,7 @@ export namespace vision_v1p2beta1 { */ faceAnnotations?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotation[]; /** - * If present, text (OCR) detection or document (OCR) text detection has - * completed successfully. This annotation provides the structural hierarchy - * for the OCR detected text. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p4beta1TextAnnotation; /** @@ -3921,8 +3348,7 @@ export namespace vision_v1p2beta1 { */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** - * If present, localized object detection has completed successfully. This - * will be sorted descending by confidence score. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; /** @@ -3960,8 +3386,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { /** - * The list of file annotation responses, one for each request in - * AsyncBatchAnnotateFilesRequest. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; } @@ -3979,20 +3404,16 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { /** - * The list of file annotation responses, each response corresponding to - * each AnnotateFileRequest in BatchAnnotateFilesRequest. + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** - * Metadata for the batch operations such as the current state. This is - * included in the `metadata` field of the `Operation` returned by the - * `GetOperation` call of the `google::longrunning::Operations` service. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** - * The time when the batch request is finished and - * google.longrunning.Operation.done is set to true. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ endTime?: string; /** @@ -4013,14 +3434,7 @@ export namespace vision_v1p2beta1 { */ blockType?: string; /** - * The bounding box for the block. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's - * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4050,8 +3464,7 @@ export namespace vision_v1p2beta1 { vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; } /** - * Color information consists of RGB channels, score, and the fraction of the - * image that the color occupies in the image. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { /** @@ -4059,8 +3472,7 @@ export namespace vision_v1p2beta1 { */ color?: Schema$Color; /** - * The fraction of pixels the color occupies in the image. Value in range - * [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ pixelFraction?: number; /** @@ -4073,8 +3485,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1CropHint { /** - * The bounding polygon for the crop region. The coordinates of the bounding - * box are in the original image's scale. + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4082,8 +3493,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Fraction of importance of this salient region with respect to the - * original image. + * Fraction of importance of this salient region with respect to the original image. */ importanceFraction?: number; } @@ -4110,15 +3520,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { /** - * Image region to which this entity belongs. Not produced for - * `LABEL_DETECTION` features. + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection - * in an image. For example, for an image in which the "Eiffel - * Tower" entity is detected, this field represents the confidence that - * there is a tower in the query image. Range [0, 1]. + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** @@ -4126,26 +3532,19 @@ export namespace vision_v1p2beta1 { */ description?: string; /** - * The language code for the locale in which the entity textual - * `description` is expressed. + * The language code for the locale in which the entity textual `description` is expressed. */ locale?: string; /** - * The location information for the detected entity. Multiple `LocationInfo` - * elements can be present because one location may indicate the location of - * the scene in the image, and another location may indicate the location of - * the place where the image was taken. Location information is usually - * present for landmarks. + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph - * Search API](https://developers.google.com/knowledge-graph/). + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** - * Some entities may have optional user-supplied `Property` (name/value) - * fields, such a score or string that qualifies the entity. + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; /** @@ -4153,12 +3552,7 @@ export namespace vision_v1p2beta1 { */ score?: number; /** - * The relevancy of the ICA (Image Content Annotation) label to the image. - * For example, the relevancy of "tower" is likely higher to an - * image containing the detected "Eiffel Tower" than to an image - * containing a detected distant towering building, even though the - * confidence that there is a tower in each image may be the same. Range [0, - * 1]. + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. */ topicality?: number; } @@ -4175,13 +3569,7 @@ export namespace vision_v1p2beta1 { */ blurredLikelihood?: string; /** - * The bounding polygon around the face. The coordinates of the bounding box - * are in the original image's scale. The bounding box is computed to - * "frame" the face in accordance with human expectations. It is - * based on the landmarker results. Note that one or more x and/or y - * coordinates may not be generated in the `BoundingPoly` (the polygon will - * be unbounded) if only a partial face appears in the image to be - * annotated. + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4189,12 +3577,7 @@ export namespace vision_v1p2beta1 { */ detectionConfidence?: number; /** - * The `fd_bounding_poly` bounding polygon is tighter than the - * `boundingPoly`, and encloses only the skin part of the face. Typically, - * it is used to eliminate the face from any image analysis that detects the - * "amount of skin" visible in an image. It is not based on the - * landmarker results, only on the initial face detection, hence the - * <code>fd</code> (face detection) prefix. + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4214,15 +3597,11 @@ export namespace vision_v1p2beta1 { */ landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; /** - * Yaw angle, which indicates the leftward/rightward angle that the face is - * pointing relative to the vertical plane perpendicular to the image. Range - * [-180,180]. + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ panAngle?: number; /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise - * rotation of the face relative to the image vertical about the axis - * perpendicular to the face. Range [-180,180]. + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** @@ -4234,8 +3613,7 @@ export namespace vision_v1p2beta1 { */ surpriseLikelihood?: string; /** - * Pitch angle, which indicates the upwards/downwards angle that the face is - * pointing relative to the image's horizontal plane. Range [-180,180]. + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** @@ -4261,22 +3639,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI prefix where the results will be stored. Results - * will be in JSON format and preceded by its corresponding input URI - * prefix. This field can either represent a gcs file prefix or gcs - * directory. In either case, the uri should be unique because in order to - * get all of the output files, you will need to do a wildcard gcs search on - * the uri prefix you provide. Examples: * File Prefix: - * gs://bucket-name/here/filenameprefix The output files will be created - * in gs://bucket-name/here/ and the names of the output files will begin - * with "filenameprefix". * Directory Prefix: - * gs://bucket-name/some/location/ The output files will be created in - * gs://bucket-name/some/location/ and the names of the output files could - * be anything because there was no filename prefix specified. If multiple - * outputs, each response is still AnnotateFileResponse, each of which - * contains some subset of the full list of AnnotateImageResponse. Multiple - * outputs can happen if, for example, the output JSON is too large and - * overflows into multiple sharded files. + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ uri?: string; } @@ -4285,19 +3648,16 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a Google - * Cloud Storage object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ pageNumber?: number; /** @@ -4315,9 +3675,7 @@ export namespace vision_v1p2beta1 { dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** @@ -4325,10 +3683,7 @@ export namespace vision_v1p2beta1 { */ referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } @@ -4337,11 +3692,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** - * File content, represented as a stream of bytes. Note: As with all `bytes` - * fields, protobuffers use a pure binary representation, whereas JSON - * representations use base64. Currently, this field only works for - * BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles - * requests. + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ content?: string; /** @@ -4349,8 +3700,7 @@ export namespace vision_v1p2beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -4363,9 +3713,7 @@ export namespace vision_v1p2beta1 { */ boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** @@ -4391,8 +3739,7 @@ export namespace vision_v1p2beta1 { latLng?: Schema$LatLng; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { /** @@ -4426,14 +3773,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ batchSize?: number; /** @@ -4454,8 +3794,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number; /** @@ -4463,8 +3802,7 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -4473,14 +3811,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4497,9 +3828,7 @@ export namespace vision_v1p2beta1 { words?: Schema$GoogleCloudVisionV1p4beta1Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p4beta1Position { /** @@ -4520,34 +3849,23 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } @@ -4556,13 +3874,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ key?: string; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ value?: string; } @@ -4571,16 +3887,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; /** @@ -4589,8 +3900,7 @@ export namespace vision_v1p2beta1 { results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** - * Information about the products similar to a single product in a query - * image. + * Information about the products similar to a single product in a query image. */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { /** @@ -4607,8 +3917,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -4616,8 +3925,7 @@ export namespace vision_v1p2beta1 { */ product?: Schema$GoogleCloudVisionV1p4beta1Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } @@ -4639,41 +3947,28 @@ export namespace vision_v1p2beta1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -4681,15 +3976,11 @@ export namespace vision_v1p2beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -4702,14 +3993,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4726,13 +4010,7 @@ export namespace vision_v1p2beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** @@ -4766,9 +4044,7 @@ export namespace vision_v1p2beta1 { */ confidence?: number; /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -4786,8 +4062,7 @@ export namespace vision_v1p2beta1 { detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$GoogleCloudVisionV1p4beta1Vertex { /** @@ -4804,13 +4079,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4818,9 +4091,7 @@ export namespace vision_v1p2beta1 { */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4845,8 +4116,7 @@ export namespace vision_v1p2beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -4872,9 +4142,7 @@ export namespace vision_v1p2beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -4883,8 +4151,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4892,9 +4159,7 @@ export namespace vision_v1p2beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** @@ -4911,14 +4176,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** @@ -4930,276 +4188,1228 @@ export namespace vision_v1p2beta1 { */ property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; } /** - * Information about the products similar to a single product in a query - * image. + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. */ - export interface Schema$GroupedResult { + export interface Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse { /** - * The bounding polygon around the product detected in the query image. + * Information about the file for which this response is generated. */ - boundingPoly?: Schema$BoundingPoly; + inputConfig?: Schema$GoogleCloudVisionV1p5beta1InputConfig; /** - * List of results, one for each product match. + * Individual responses to images found within the file. */ - results?: Schema$Result[]; + responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; } /** - * If an image was produced from a file (e.g. a PDF), this message gives - * information about the source of that image. + * Response to an image annotation request. */ - export interface Schema$ImageAnnotationContext { + export interface Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse { /** - * If the file was a PDF or TIFF, this field gives the page number within - * the file used to produce the image. + * If present, contextual information is needed to understand where this image comes from. */ - pageNumber?: number; + context?: Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext; /** - * The URI of the file used to produce the image. + * If present, crop hints have completed successfully. */ - uri?: string; - } - /** - * Stores image properties, such as dominant colors. - */ - export interface Schema$ImageProperties { + cropHintsAnnotation?: Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation; /** - * If present, dominant colors completed successfully. + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. */ - dominantColors?: Schema$DominantColorsAnnotation; - } - /** - * Response message for the `ImportProductSets` method. This message is - * returned by the google.longrunning.Operations.GetOperation method in the - * returned google.longrunning.Operation.response field. - */ - export interface Schema$ImportProductSetsResponse { + error?: Schema$Status; /** - * The list of reference_images that are imported successfully. + * If present, face detection has completed successfully. */ - referenceImages?: Schema$ReferenceImage[]; + faceAnnotations?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotation[]; /** - * The rpc status for each ImportProductSet request, including both - * successes and errors. The number of statuses here matches the number of - * lines in the csv file, and statuses[i] stores the success or failure - * status of processing the i-th line of the csv, starting from line 0. + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. */ - statuses?: Schema$Status[]; - } - /** - * The desired input location and metadata. - */ - export interface Schema$InputConfig { + fullTextAnnotation?: Schema$GoogleCloudVisionV1p5beta1TextAnnotation; /** - * The Google Cloud Storage location to read the input from. + * If present, image properties were extracted successfully. */ - gcsSource?: Schema$GcsSource; + imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p5beta1ImageProperties; /** - * The type of the file. Currently only "application/pdf" and - * "image/tiff" are supported. Wildcards are not supported. + * If present, label detection has completed successfully. */ - mimeType?: string; - } - /** - * A product label represented as a key-value pair. - */ - export interface Schema$KeyValue { + labelAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * The key of the label attached to the product. Cannot be empty and cannot - * exceed 128 bytes. + * If present, landmark detection has completed successfully. */ - key?: string; + landmarkAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * The value of the label attached to the product. Cannot be empty and - * cannot exceed 128 bytes. + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ - value?: string; - } - /** - * A face-specific landmark (for example, a face feature). - */ - export interface Schema$Landmark { + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation[]; /** - * Face landmark position. + * If present, logo detection has completed successfully. */ - position?: Schema$Position; + logoAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; /** - * Face landmark type. + * If present, product search has completed successfully. */ - type?: string; - } - /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. - */ - export interface Schema$LatLng { + productSearchResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResults; /** - * The latitude in degrees. It must be in the range [-90.0, +90.0]. + * If present, safe-search annotation has completed successfully. */ - latitude?: number; + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation; /** - * The longitude in degrees. It must be in the range [-180.0, +180.0]. + * If present, text (OCR) detection has completed successfully. */ - longitude?: number; + textAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection?: Schema$GoogleCloudVisionV1p5beta1WebDetection; } /** - * Set of detected objects with bounding boxes. + * The response for a single offline file annotation request. */ - export interface Schema$LocalizedObjectAnnotation { - /** - * Image region to which this object belongs. This must be populated. - */ - boundingPoly?: Schema$BoundingPoly; - /** - * The BCP-47 language code, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string; + export interface Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse { /** - * Object ID that should align with EntityAnnotation mid. + * The output location and metadata from AsyncAnnotateFileRequest. */ - mid?: string; + outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + } + /** + * Response to an async batch file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateFilesResponse { /** - * Object name, expressed in its `language_code` language. + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ - name?: string; + responses?: Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse[]; + } + /** + * Response to an async batch image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateImagesResponse { /** - * Score of the result. Range [0, 1]. + * The output location and metadata from AsyncBatchAnnotateImagesRequest. */ - score?: number; + outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; } /** - * Detected entity location information. + * A list of file annotation responses. */ - export interface Schema$LocationInfo { + export interface Schema$GoogleCloudVisionV1p5beta1BatchAnnotateFilesResponse { /** - * lat/long location coordinates. + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ - latLng?: Schema$LatLng; + responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse[]; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex - * coordinates are relative to the original image and range from 0 to 1. + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ - export interface Schema$NormalizedVertex { + export interface Schema$GoogleCloudVisionV1p5beta1BatchOperationMetadata { /** - * X coordinate. + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ - x?: number; + endTime?: string; /** - * Y coordinate. + * The current state of the batch operation. */ - y?: number; + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * Logical element on the page. */ - export interface Schema$Operation { + export interface Schema$GoogleCloudVisionV1p5beta1Block { /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. + * Detected block type (text, image etc) for this block. */ - done?: boolean; + blockType?: string; /** - * The error result of the operation in case of failure or cancellation. + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - error?: Schema$Status; + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. + * Confidence of the OCR results on the block. Range [0, 1]. */ - metadata?: {[key: string]: any}; + confidence?: number; /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. + * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ - name?: string; + keyValuePair?: Schema$GoogleCloudVisionV1p5beta1KeyValuePair; /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. */ - response?: {[key: string]: any}; - } - /** - * Contains metadata for the BatchAnnotateImages operation. - */ - export interface Schema$OperationMetadata { + mergedText?: string; /** - * The time when the batch request was received. + * List of paragraphs in this block (if this blocks is of type text). */ - createTime?: string; + paragraphs?: Schema$GoogleCloudVisionV1p5beta1Paragraph[]; /** - * Current state of the batch operation. + * Additional information detected for the block. */ - state?: string; + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; /** - * The time when the operation result was last updated. + * Detected table for TABLE block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. */ - updateTime?: string; + table?: Schema$GoogleCloudVisionV1p5beta1Table; } /** - * The desired output location and metadata. + * A bounding polygon for the detected image annotation. */ - export interface Schema$OutputConfig { + export interface Schema$GoogleCloudVisionV1p5beta1BoundingPoly { /** - * The max number of response protos to put into each output JSON file on - * Google Cloud Storage. The valid range is [1, 100]. If not specified, the - * default value is 20. For example, for one pdf file with 100 pages, 100 - * response protos will be generated. If `batch_size` = 20, then 5 json - * files each containing 20 response protos will be written under the prefix - * `gcs_destination`.`uri`. Currently, batch_size only applies to - * GcsDestination, with potential future support for other output - * configurations. + * The bounding polygon normalized vertices. */ - batchSize?: number; + normalizedVertices?: Schema$GoogleCloudVisionV1p5beta1NormalizedVertex[]; /** - * The Google Cloud Storage location to write the output(s) to. + * The bounding polygon vertices. */ - gcsDestination?: Schema$GcsDestination; + vertices?: Schema$GoogleCloudVisionV1p5beta1Vertex[]; } /** - * Detected page from OCR. + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ - export interface Schema$Page { + export interface Schema$GoogleCloudVisionV1p5beta1ColorInfo { /** - * List of blocks of text, images etc on this page. + * RGB components of the color. */ - blocks?: Schema$Block[]; + color?: Schema$Color; /** - * Confidence of the OCR results on the page. Range [0, 1]. + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. */ - confidence?: number; + pixelFraction?: number; /** - * Page height. For PDFs the unit is points. For images (including TIFFs) - * the unit is pixels. + * Image-specific score for this color. Value in range [0, 1]. */ - height?: number; - /** + score?: number; + } + /** + * Single crop hint that is used to generate a new crop when serving an image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1CropHint { + /** + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of this being a salient region. Range [0, 1]. + */ + confidence?: number; + /** + * Fraction of importance of this salient region with respect to the original image. + */ + importanceFraction?: number; + } + /** + * Set of crop hints that are used to generate new crops when serving images. + */ + export interface Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints?: Schema$GoogleCloudVisionV1p5beta1CropHint[]; + } + /** + * Set of dominant colors and their corresponding scores. + */ + export interface Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors?: Schema$GoogleCloudVisionV1p5beta1ColorInfo[]; + } + /** + * Set of detected entity features. + */ + export interface Schema$GoogleCloudVisionV1p5beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. + */ + confidence?: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description?: string; + /** + * The language code for the locale in which the entity textual `description` is expressed. + */ + locale?: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. + */ + locations?: Schema$GoogleCloudVisionV1p5beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). + */ + mid?: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. + */ + properties?: Schema$GoogleCloudVisionV1p5beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score?: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality?: number; + } + /** + * A face annotation object contains the results of face detection. + */ + export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood?: string; + /** + * Blurred likelihood. + */ + blurredLikelihood?: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence?: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + */ + fdBoundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood?: string; + /** + * Joy likelihood. + */ + joyLikelihood?: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence?: number; + /** + * Detected face landmarks. + */ + landmarks?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. + */ + panAngle?: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. + */ + rollAngle?: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood?: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood?: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle?: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position?: Schema$GoogleCloudVisionV1p5beta1Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * The Google Cloud Storage location where the output will be written to. + */ + export interface Schema$GoogleCloudVisionV1p5beta1GcsDestination { + /** + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + */ + uri?: string; + } + /** + * The Google Cloud Storage location where the input will be read from. + */ + export interface Schema$GoogleCloudVisionV1p5beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. + */ + uri?: string; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation; + } + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$GoogleCloudVisionV1p5beta1ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p5beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * Proto for a key value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1KeyValuePair { + /** + * The key string value. + */ + key?: string; + /** + * Key block of the pair containing the normalized bounding box and key text. + */ + keyBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + /** + * Optional. The translation of key text if the text is not in English. + */ + normalizedKey?: string; + /** + * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. + */ + valueBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + /** + * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. + */ + valueType?: string; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$GoogleCloudVisionV1p5beta1LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$GoogleCloudVisionV1p5beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p5beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GoogleCloudVisionV1p5beta1GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$GoogleCloudVisionV1p5beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** + * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. + */ + mergedText?: string; + /** + * Additional information detected on the page. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + width?: number; + } + /** + * Structural unit of text representing a number of words in certain order. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Paragraph { + /** + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence?: number; + /** + * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. + */ + mergedText?: string; + /** + * Additional information detected for the paragraph. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words?: Schema$GoogleCloudVisionV1p5beta1Word[]; + } + /** + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Position { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + /** + * Z coordinate (or depth). + */ + z?: number; + } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p5beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p5beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). + */ + score?: number; + } + /** + * A `Property` consists of a user-supplied name/value pair. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Property { + /** + * Name of the property. + */ + name?: string; + /** + * Value of numeric properties. + */ + uint64Value?: string; + /** + * Value of the property. + */ + value?: string; + } + /** + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p5beta1ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly[]; + /** + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + */ + uri?: string; + } + /** + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). + */ + export interface Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. + */ + adult?: string; + /** + * Likelihood that this is a medical image. + */ + medical?: string; + /** + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. + */ + racy?: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. + */ + spoof?: string; + /** + * Likelihood that this image contains violent content. + */ + violence?: string; + } + /** + * A single symbol representation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the symbol. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text?: string; + } + /** + * A table representation similar to HTML table structure. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Table { + /** + * Body rows of the table + */ + bodyRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; + /** + * Header rows of the table + */ + headerRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; + } + /** + * A cell representation inside of tables. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TableTableCell { + /** + * How many columns this cell spans. + */ + colSpan?: number; + /** + * How many rows this cell spans. + */ + rowSpan?: number; + /** + * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. + */ + text?: string; + /** + * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. + */ + textBlock?: Schema$GoogleCloudVisionV1p5beta1Block; + } + /** + * A row of table cells. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TableTableRow { + /** + * Cells that make up this row. + */ + cells?: Schema$GoogleCloudVisionV1p5beta1TableTableCell[]; + } + /** + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages?: Schema$GoogleCloudVisionV1p5beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text?: string; + } + /** + * Detected start or end of a structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix?: boolean; + /** + * Detected break type. + */ + type?: string; + } + /** + * Detected language for a structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence?: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Additional information detected on the structural component. + */ + export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage[]; + } + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Vertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Relevant information for the image from the Internet. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetection { + /** + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. + */ + bestGuessLabels?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage[]; + /** + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity[]; + } + /** + * Entity deduced from similar images on the Internet. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description?: string; + /** + * Opaque entity ID. + */ + entityId?: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. + */ + score?: number; + } + /** + * Metadata for online images. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score?: number; + /** + * The result image URL. + */ + url?: string; + } + /** + * Label to provide extra metadata for the web detection. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label?: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Metadata for web pages. + */ + export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle?: string; + /** + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score?: number; + /** + * The result web page URL. + */ + url?: string; + } + /** + * A word representation. + */ + export interface Schema$GoogleCloudVisionV1p5beta1Word { + /** + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence?: number; + /** + * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. + */ + mergedText?: string; + /** + * Additional information detected for the word. + */ + property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural reading order. + */ + symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$DominantColorsAnnotation; + } + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GcsSource; + /** + * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$KeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$Landmark { + /** + * Face landmark position. + */ + position?: Schema$Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + */ + export interface Schema$LatLng { + /** + * The latitude in degrees. It must be in the range [-90.0, +90.0]. + */ + latitude?: number; + /** + * The longitude in degrees. It must be in the range [-180.0, +180.0]. + */ + longitude?: number; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any}; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any}; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** * Additional information detected on the page. */ property?: Schema$TextProperty; /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the - * unit is pixels. + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ width?: number; } @@ -5208,14 +5418,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Paragraph { /** - * The bounding box for the paragraph. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertex order will still be (0, 1, 2, 3). + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5232,9 +5435,7 @@ export namespace vision_v1p2beta1 { words?: Schema$Word[]; } /** - * A 3D position in the image, used primarily for Face detection landmarks. A - * valid Position must have both x and y coordinates. The position coordinates - * are in the same scale as the original image. + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ export interface Schema$Position { /** @@ -5255,34 +5456,23 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Product { /** - * User-provided metadata to be stored with this product. Must be at most - * 4096 characters long. + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ description?: string; /** - * The user-provided name for this Product. Must not be empty. Must be at - * most 4096 characters long. + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. */ displayName?: string; /** - * The resource name of the product. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field - * is ignored when creating a product. + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. */ name?: string; /** - * The category for the product identified by the reference image. This - * should be either "homegoods", "apparel", or - * "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. */ productCategory?: string; /** - * Key-value pairs that can be attached to a product. At query time, - * constraints can be specified based on the product_labels. Note that - * integer values can be provided as strings, e.g. "1199". Only - * strings with integer values can match a range-based restriction which is - * to be supported soon. Multiple values can be assigned to the same key. - * One product may have up to 100 product_labels. + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. */ productLabels?: Schema$KeyValue[]; } @@ -5291,16 +5481,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$ProductSearchResults { /** - * Timestamp of the index which provided these results. Products added to - * the product set and products removed from the product set after this time - * are not reflected in the current results. + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ indexTime?: string; /** - * List of results grouped by products detected in the query image. Each - * entry corresponds to one bounding polygon in the query image, and - * contains the matching products specific to that region. There may be - * duplicate product matches in the union of all the per-product results. + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GroupedResult[]; /** @@ -5326,28 +5511,19 @@ export namespace vision_v1p2beta1 { value?: string; } /** - * A `ReferenceImage` represents a product image and its associated metadata, - * such as bounding boxes. + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ export interface Schema$ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. - * Optional. If this field is empty, the system will try to detect regions - * of interest. At most 10 bounding polygons will be used. The provided - * shape is converted into a non-rotated rectangle. Once converted, the - * small edge of the rectangle must be greater than or equal to 300 pixels. - * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** - * The resource name of the reference image. Format is: - * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. - * This field is ignored when creating a reference image. + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string; /** - * The Google Cloud Storage URI of the reference image. The URI must start - * with `gs://`. Required. + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. */ uri?: string; } @@ -5356,8 +5532,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Result { /** - * The resource name of the image from the product that is the closest match - * to the query. + * The resource name of the image from the product that is the closest match to the query. */ image?: string; /** @@ -5365,21 +5540,16 @@ export namespace vision_v1p2beta1 { */ product?: Schema$Product; /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 - * (full confidence). + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ score?: number; } /** - * Set of features pertaining to the image, computed by computer vision - * methods over safe-search verticals (for example, adult, spoof, medical, - * violence). + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ export interface Schema$SafeSearchAnnotation { /** - * Represents the adult content likelihood for the image. Adult content may - * contain elements such as nudity, pornographic images or cartoons, or - * sexual activities. + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string; /** @@ -5387,15 +5557,11 @@ export namespace vision_v1p2beta1 { */ medical?: string; /** - * Likelihood that the request image contains racy content. Racy content may - * include (but is not limited to) skimpy or sheer clothing, strategically - * covered nudity, lewd or provocative poses, or close-ups of sensitive body - * areas. + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string; /** - * Spoof likelihood. The likelihood that an modification was made to the - * image's canonical version to make it appear funny or offensive. + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string; /** @@ -5404,40 +5570,7 @@ export namespace vision_v1p2beta1 { violence?: string; } /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. */ export interface Schema$Status { /** @@ -5445,14 +5578,11 @@ export namespace vision_v1p2beta1 { */ code?: number; /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}>; /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */ message?: string; } @@ -5461,14 +5591,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Symbol { /** - * The bounding box for the symbol. The vertices are in the order of - * top-left, top-right, bottom-right, bottom-left. When a rotation of the - * bounding box is detected the rotation is represented as around the - * top-left corner as defined when the text is read in the 'natural' - * orientation. For example: * when the text is horizontal it might look - * like: 0----1 | | 3----2 * when it's rotated 180 - * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5485,13 +5608,7 @@ export namespace vision_v1p2beta1 { text?: string; } /** - * TextAnnotation contains a structured representation of OCR extracted text. - * The hierarchy of an OCR extracted text structure is like this: - * TextAnnotation -> Page -> Block -> Paragraph -> Word -> - * Symbol Each structural component, starting from Page, may further have - * their own properties. Properties describe detected languages, breaks etc.. - * Please refer to the TextAnnotation.TextProperty message definition below - * for more detail. + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ export interface Schema$TextAnnotation { /** @@ -5517,8 +5634,7 @@ export namespace vision_v1p2beta1 { detectedLanguages?: Schema$DetectedLanguage[]; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates - * are in the same scale as the original image. + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ export interface Schema$Vertex { /** @@ -5535,13 +5651,11 @@ export namespace vision_v1p2beta1 { */ export interface Schema$WebDetection { /** - * The service's best guess as to the topic of the request image. - * Inferred from similar images on the open web. + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ bestGuessLabels?: Schema$WebLabel[]; /** - * Fully matching images from the Internet. Can include resized copies of - * the query image. + * Fully matching images from the Internet. Can include resized copies of the query image. */ fullMatchingImages?: Schema$WebImage[]; /** @@ -5549,9 +5663,7 @@ export namespace vision_v1p2beta1 { */ pagesWithMatchingImages?: Schema$WebPage[]; /** - * Partial matching images from the Internet. Those images are similar - * enough to share some key-point features. For example an original image - * will likely have partial matching for its crops. + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** @@ -5576,8 +5688,7 @@ export namespace vision_v1p2beta1 { */ entityId?: string; /** - * Overall relevancy score for the entity. Not normalized and not comparable - * across different image queries. + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. */ score?: number; } @@ -5603,9 +5714,7 @@ export namespace vision_v1p2beta1 { */ label?: string; /** - * The BCP-47 language code for `label`, such as "en-US" or - * "sr-Latn". For more information, see - * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } @@ -5614,8 +5723,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$WebPage { /** - * Fully matching images on the page. Can include resized copies of the - * query image. + * Fully matching images on the page. Can include resized copies of the query image. */ fullMatchingImages?: Schema$WebImage[]; /** @@ -5623,9 +5731,7 @@ export namespace vision_v1p2beta1 { */ pageTitle?: string; /** - * Partial matching images on the page. Those images are similar enough to - * share some key-point features. For example an original image will likely - * have partial matching for its crops. + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** @@ -5642,14 +5748,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$Word { /** - * The bounding box for the word. The vertices are in the order of top-left, - * top-right, bottom-right, bottom-left. When a rotation of the bounding box - * is detected the rotation is represented as around the top-left corner as - * defined when the text is read in the 'natural' orientation. For - * example: * when the text is horizontal it might look like: 0----1 - * | | 3----2 * when it's rotated 180 degrees around the - * top-left corner it becomes: 2----3 | | 1----0 and the - * vertex order will still be (0, 1, 2, 3). + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -5661,8 +5760,7 @@ export namespace vision_v1p2beta1 { */ property?: Schema$TextProperty; /** - * List of symbols in the word. The order of the symbols follows the natural - * reading order. + * List of symbols in the word. The order of the symbols follows the natural reading order. */ symbols?: Schema$Symbol[]; } @@ -5673,14 +5771,108 @@ export namespace vision_v1p2beta1 { this.context = context; } + /** + * vision.files.annotate + * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @alias vision.files.annotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + annotate( + params?: Params$Resource$Files$Annotate, + options?: MethodOptions + ): GaxiosPromise< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + >; + annotate( + params: Params$Resource$Files$Annotate, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + > + ): void; + annotate( + params: Params$Resource$Files$Annotate, + callback: BodyResponseCallback< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + > + ): void; + annotate( + callback: BodyResponseCallback< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + > + ): void; + annotate( + paramsOrCallback?: + | Params$Resource$Files$Annotate + | BodyResponseCallback< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + > { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Annotate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Annotate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p2beta1/files:annotate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse + >(parameters); + } + } + /** * vision.files.asyncBatchAnnotate - * @desc Run asynchronous image detection and annotation for a list of - * generic files, such as PDF files, which may contain multiple pages and - * multiple images per page. Progress and results can be retrieved through - * the `google.longrunning.Operations` interface. `Operation.metadata` - * contains `OperationMetadata` (metadata). `Operation.response` contains - * `AsyncBatchAnnotateFilesResponse` (results). + * @desc Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). * @alias vision.files.asyncBatchAnnotate * @memberOf! () * @@ -5753,6 +5945,17 @@ export namespace vision_v1p2beta1 { } } + export interface Params$Resource$Files$Annotate extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest; + } export interface Params$Resource$Files$Asyncbatchannotate extends StandardParameters { /** @@ -5870,6 +6073,80 @@ export namespace vision_v1p2beta1 { >(parameters); } } + + /** + * vision.images.asyncBatchAnnotate + * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @alias vision.images.asyncBatchAnnotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + asyncBatchAnnotate( + params?: Params$Resource$Images$Asyncbatchannotate, + options?: MethodOptions + ): GaxiosPromise; + asyncBatchAnnotate( + params: Params$Resource$Images$Asyncbatchannotate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + asyncBatchAnnotate( + params: Params$Resource$Images$Asyncbatchannotate, + callback: BodyResponseCallback + ): void; + asyncBatchAnnotate(callback: BodyResponseCallback): void; + asyncBatchAnnotate( + paramsOrCallback?: + | Params$Resource$Images$Asyncbatchannotate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Images$Asyncbatchannotate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Asyncbatchannotate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p2beta1/images:asyncBatchAnnotate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Images$Annotate extends StandardParameters { @@ -5883,4 +6160,16 @@ export namespace vision_v1p2beta1 { */ requestBody?: Schema$GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest; } + export interface Params$Resource$Images$Asyncbatchannotate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest; + } } diff --git a/src/apis/webfonts/package.json b/src/apis/webfonts/package.json index ef431b77a46..c768b8ba89e 100644 --- a/src/apis/webfonts/package.json +++ b/src/apis/webfonts/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/webfonts/v1.ts b/src/apis/webfonts/v1.ts index 1e7151bb3bd..ba44c660d3b 100644 --- a/src/apis/webfonts/v1.ts +++ b/src/apis/webfonts/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace webfonts_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace webfonts_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,9 +75,7 @@ export namespace webfonts_v1 { /** * Google Fonts Developer API * - * Accesses the metadata for all families served by Google Fonts, providing a - * list of families currently available (including available styles and a list - * of supported script subsets). + * Accesses the metadata for all families served by Google Fonts, providing a list of families currently available (including available styles and a list of supported script subsets). * * @example * const {google} = require('googleapis'); @@ -97,7 +92,10 @@ export namespace webfonts_v1 { webfonts: Resource$Webfonts; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.webfonts = new Resource$Webfonts(this.context); } @@ -113,8 +111,7 @@ export namespace webfonts_v1 { */ family?: string; /** - * The font files (with all supported scripts) for each one of the available - * variants, as a key : value map. + * The font files (with all supported scripts) for each one of the available variants, as a key : value map. */ files?: {[key: string]: string}; /** @@ -122,8 +119,7 @@ export namespace webfonts_v1 { */ kind?: string; /** - * The date (format "yyyy-MM-dd") the font was modified for the - * last time. + * The date (format "yyyy-MM-dd") the font was modified for the last time. */ lastModified?: string; /** @@ -158,8 +154,7 @@ export namespace webfonts_v1 { /** * webfonts.webfonts.list - * @desc Retrieves the list of fonts currently served by the Google Fonts - * Developer API + * @desc Retrieves the list of fonts currently served by the Google Fonts Developer API * @alias webfonts.webfonts.list * @memberOf! () * diff --git a/src/apis/webmasters/package.json b/src/apis/webmasters/package.json index 1094c322830..8755b8a53f9 100644 --- a/src/apis/webmasters/package.json +++ b/src/apis/webmasters/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/webmasters/v3.ts b/src/apis/webmasters/v3.ts index 972728620f7..9eea38bbf3a 100644 --- a/src/apis/webmasters/v3.ts +++ b/src/apis/webmasters/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace webmasters_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace webmasters_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -95,21 +92,16 @@ export namespace webmasters_v3 { searchanalytics: Resource$Searchanalytics; sitemaps: Resource$Sitemaps; sites: Resource$Sites; - urlcrawlerrorscounts: Resource$Urlcrawlerrorscounts; - urlcrawlerrorssamples: Resource$Urlcrawlerrorssamples; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.searchanalytics = new Resource$Searchanalytics(this.context); this.sitemaps = new Resource$Sitemaps(this.context); this.sites = new Resource$Sites(this.context); - this.urlcrawlerrorscounts = new Resource$Urlcrawlerrorscounts( - this.context - ); - this.urlcrawlerrorssamples = new Resource$Urlcrawlerrorssamples( - this.context - ); } } @@ -131,42 +123,23 @@ export namespace webmasters_v3 { } export interface Schema$SearchAnalyticsQueryRequest { /** - * [Optional; Default is "auto"] How data is aggregated. If - * aggregated by property, all data for the same property is aggregated; if - * aggregated by page, all data is aggregated by canonical URI. If you - * filter or group by page, choose AUTO; otherwise you can aggregate either - * by property or by page, depending on how you want your data calculated; - * see the help documentation to learn how data is calculated differently - * by site versus by page. Note: If you group or filter by page, you cannot - * aggregate by property. If you specify any value other than AUTO, the - * aggregation type in the result will match the requested type, or if you - * request an invalid type, you will get an error. The API will never change - * your aggregation type if the requested type is invalid. + * [Optional; Default is "auto"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. Note: If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid. */ aggregationType?: string; /** - * [Optional] Zero or more filters to apply to the dimension grouping - * values; for example, 'query contains "buy"' to see only - * data where the query string contains the substring "buy" (not - * case-sensitive). You can filter by a dimension without grouping by it. + * [Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains "buy"' to see only data where the query string contains the substring "buy" (not case-sensitive). You can filter by a dimension without grouping by it. */ dimensionFilterGroups?: Schema$ApiDimensionFilterGroup[]; /** - * [Optional] Zero or more dimensions to group results by. Dimensions are - * the group-by values in the Search Analytics page. Dimensions are combined - * to create a unique row key for each row. Results are grouped in the order - * that you supply these dimensions. + * [Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions. */ dimensions?: string[]; /** - * [Required] End date of the requested date range, in YYYY-MM-DD format, in - * PST (UTC - 8:00). Must be greater than or equal to the start date. This - * value is included in the range. + * [Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range. */ endDate?: string; /** - * [Optional; Default is 1000] The maximum number of rows to return. Must be - * a number from 1 to 5,000 (inclusive). + * [Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive). */ rowLimit?: number; /** @@ -174,21 +147,16 @@ export namespace webmasters_v3 { */ searchType?: string; /** - * [Required] Start date of the requested date range, in YYYY-MM-DD format, - * in PST time (UTC - 8:00). Must be less than or equal to the end date. - * This value is included in the range. + * [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range. */ startDate?: string; /** - * [Optional; Default is 0] Zero-based index of the first row in the - * response. Must be a non-negative number. + * [Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number. */ startRow?: number; } /** - * A list of rows, one per result, grouped by key. Metrics in each row are - * aggregated for all data grouped by that key either by page or property, as - * specified by the aggregation type parameter. + * A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter. */ export interface Schema$SearchAnalyticsQueryResponse { /** @@ -205,8 +173,7 @@ export namespace webmasters_v3 { */ export interface Schema$SitemapsListResponse { /** - * Contains detailed information about a specific URL submitted as a - * sitemap. + * Contains detailed information about a specific URL submitted as a sitemap. */ sitemap?: Schema$WmxSitemap[]; } @@ -215,104 +182,12 @@ export namespace webmasters_v3 { */ export interface Schema$SitesListResponse { /** - * Contains permission level information about a Search Console site. For - * more information, see Permissions in Search Console. + * Contains permission level information about a Search Console site. For more information, see Permissions in Search Console. */ siteEntry?: Schema$WmxSite[]; } /** - * An entry in a URL crawl errors time series. - */ - export interface Schema$UrlCrawlErrorCount { - /** - * The error count at the given timestamp. - */ - count?: string; - /** - * The date and time when the crawl attempt took place, in RFC 3339 format. - */ - timestamp?: string; - } - /** - * Number of errors per day for a specific error type (defined by platform and - * category). - */ - export interface Schema$UrlCrawlErrorCountsPerType { - /** - * The crawl error type. - */ - category?: string; - /** - * The error count entries time series. - */ - entries?: Schema$UrlCrawlErrorCount[]; - /** - * The general type of Googlebot that made the request (see list of - * Googlebot user-agents for the user-agents used). - */ - platform?: string; - } - /** - * A time series of the number of URL crawl errors per error category and - * platform. - */ - export interface Schema$UrlCrawlErrorsCountsQueryResponse { - /** - * The time series of the number of URL crawl errors per error category and - * platform. - */ - countPerTypes?: Schema$UrlCrawlErrorCountsPerType[]; - } - /** - * Contains information about specific crawl errors. - */ - export interface Schema$UrlCrawlErrorsSample { - /** - * The time the error was first detected, in RFC 3339 format. - */ - first_detected?: string; - /** - * The time when the URL was last crawled, in RFC 3339 format. - */ - last_crawled?: string; - /** - * The URL of an error, relative to the site. - */ - pageUrl?: string; - /** - * The HTTP response code, if any. - */ - responseCode?: number; - /** - * Additional details about the URL, set only when calling get(). - */ - urlDetails?: Schema$UrlSampleDetails; - } - /** - * List of crawl error samples. - */ - export interface Schema$UrlCrawlErrorsSamplesListResponse { - /** - * Information about the sample URL and its crawl error. - */ - urlCrawlErrorSample?: Schema$UrlCrawlErrorsSample[]; - } - /** - * Additional details about the URL, set only when calling get(). - */ - export interface Schema$UrlSampleDetails { - /** - * List of sitemaps pointing at this URL. - */ - containingSitemaps?: string[]; - /** - * A sample set of URLs linking to this URL. - */ - linkedFromUrls?: string[]; - } - /** - * Contains permission level information about a Search Console site. For more - * information, see Permissions in Search Console. + * Contains permission level information about a Search Console site. For more information, see Permissions in Search Console. */ export interface Schema$WmxSite { /** @@ -333,8 +208,7 @@ export namespace webmasters_v3 { */ contents?: Schema$WmxSitemapContent[]; /** - * Number of errors in the sitemap. These are issues with the sitemap itself - * that need to be fixed before it can be processed correctly. + * Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly. */ errors?: string; /** @@ -346,13 +220,11 @@ export namespace webmasters_v3 { */ isSitemapsIndex?: boolean; /** - * Date & time in which this sitemap was last downloaded. Date format is - * in RFC 3339 format (yyyy-mm-dd). + * Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd). */ lastDownloaded?: string; /** - * Date & time in which this sitemap was submitted. Date format is in - * RFC 3339 format (yyyy-mm-dd). + * Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd). */ lastSubmitted?: string; /** @@ -364,8 +236,7 @@ export namespace webmasters_v3 { */ type?: string; /** - * Number of warnings for the sitemap. These are generally non-critical - * issues with URLs in the sitemaps. + * Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps. */ warnings?: string; } @@ -374,8 +245,7 @@ export namespace webmasters_v3 { */ export interface Schema$WmxSitemapContent { /** - * The number of URLs from the sitemap that were indexed (of the content - * type). + * The number of URLs from the sitemap that were indexed (of the content type). */ indexed?: string; /** @@ -396,12 +266,7 @@ export namespace webmasters_v3 { /** * webmasters.searchanalytics.query - * @desc Query your data with filters and parameters that you define. - * Returns zero or more rows grouped by the row keys that you define. You - * must define a date range of one or more days. When date is one of the - * group by values, any days without data are omitted from the result list. - * If you need to know which days have data, issue a broad date range query - * grouped by date for any metric, and see which day rows are returned. + * @desc Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned. * @alias webmasters.searchanalytics.query * @memberOf! () * @@ -653,8 +518,7 @@ export namespace webmasters_v3 { /** * webmasters.sitemaps.list - * @desc Lists the sitemaps-entries submitted for this site, or included in - * the sitemap index file (if sitemapIndex is specified in the request). + * @desc Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request). * @alias webmasters.sitemaps.list * @memberOf! () * @@ -807,8 +671,7 @@ export namespace webmasters_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The URL of the actual sitemap. For example: - * http://www.example.com/sitemap.xml + * The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml */ feedpath?: string; /** @@ -823,8 +686,7 @@ export namespace webmasters_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The URL of the actual sitemap. For example: - * http://www.example.com/sitemap.xml + * The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml */ feedpath?: string; /** @@ -839,8 +701,7 @@ export namespace webmasters_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A URL of a site's sitemap index. For example: - * http://www.example.com/sitemapindex.xml + * A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml */ sitemapIndex?: string; /** @@ -855,8 +716,7 @@ export namespace webmasters_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The URL of the sitemap to add. For example: - * http://www.example.com/sitemap.xml + * The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml */ feedpath?: string; /** @@ -1173,10 +1033,7 @@ export namespace webmasters_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The URI of the property as defined in Search Console. Examples: - * http://www.example.com/ or android-app://com.example/ Note: for - * property-sets, use the URI that starts with sc-set: which is used in - * Search Console URLs. + * The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs. */ siteUrl?: string; } @@ -1187,10 +1044,7 @@ export namespace webmasters_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The URI of the property as defined in Search Console. Examples: - * http://www.example.com/ or android-app://com.example/ Note: for - * property-sets, use the URI that starts with sc-set: which is used in - * Search Console URLs. + * The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs. */ siteUrl?: string; } @@ -1200,447 +1054,4 @@ export namespace webmasters_v3 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; } - - export class Resource$Urlcrawlerrorscounts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * webmasters.urlcrawlerrorscounts.query - * @desc Retrieves a time series of the number of URL crawl errors per error - * category and platform. - * @alias webmasters.urlcrawlerrorscounts.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.category The crawl error category. For example: serverError. If not specified, returns results for all categories. - * @param {boolean=} params.latestCountsOnly If true, returns only the latest crawl error counts. - * @param {string=} params.platform The user agent type (platform) that made the request. For example: web. If not specified, returns results for all platforms. - * @param {string} params.siteUrl The site's URL, including protocol. For example: http://www.example.com/ - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - query( - params?: Params$Resource$Urlcrawlerrorscounts$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Urlcrawlerrorscounts$Query, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Urlcrawlerrorscounts$Query, - callback: BodyResponseCallback - ): void; - query( - callback: BodyResponseCallback - ): void; - query( - paramsOrCallback?: - | Params$Resource$Urlcrawlerrorscounts$Query - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Urlcrawlerrorscounts$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Urlcrawlerrorscounts$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/webmasters/v3/sites/{siteUrl}/urlCrawlErrorsCounts/query' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['siteUrl'], - pathParams: ['siteUrl'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Urlcrawlerrorscounts$Query - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The crawl error category. For example: serverError. If not specified, - * returns results for all categories. - */ - category?: string; - /** - * If true, returns only the latest crawl error counts. - */ - latestCountsOnly?: boolean; - /** - * The user agent type (platform) that made the request. For example: web. - * If not specified, returns results for all platforms. - */ - platform?: string; - /** - * The site's URL, including protocol. For example: http://www.example.com/ - */ - siteUrl?: string; - } - - export class Resource$Urlcrawlerrorssamples { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * webmasters.urlcrawlerrorssamples.get - * @desc Retrieves details about crawl errors for a site's sample URL. - * @alias webmasters.urlcrawlerrorssamples.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.category The crawl error category. For example: authPermissions - * @param {string} params.platform The user agent type (platform) that made the request. For example: web - * @param {string} params.siteUrl The site's URL, including protocol. For example: http://www.example.com/ - * @param {string} params.url The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Urlcrawlerrorssamples$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Urlcrawlerrorssamples$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Urlcrawlerrorssamples$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Urlcrawlerrorssamples$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Urlcrawlerrorssamples$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Urlcrawlerrorssamples$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/webmasters/v3/sites/{siteUrl}/urlCrawlErrorsSamples/{url}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['siteUrl', 'url', 'category', 'platform'], - pathParams: ['siteUrl', 'url'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * webmasters.urlcrawlerrorssamples.list - * @desc Lists a site's sample URLs for the specified crawl error category - * and platform. - * @alias webmasters.urlcrawlerrorssamples.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.category The crawl error category. For example: authPermissions - * @param {string} params.platform The user agent type (platform) that made the request. For example: web - * @param {string} params.siteUrl The site's URL, including protocol. For example: http://www.example.com/ - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Urlcrawlerrorssamples$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Urlcrawlerrorssamples$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Urlcrawlerrorssamples$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Urlcrawlerrorssamples$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Urlcrawlerrorssamples$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Urlcrawlerrorssamples$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/webmasters/v3/sites/{siteUrl}/urlCrawlErrorsSamples' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['siteUrl', 'category', 'platform'], - pathParams: ['siteUrl'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * webmasters.urlcrawlerrorssamples.markAsFixed - * @desc Marks the provided site's sample URL as fixed, and removes it from - * the samples list. - * @alias webmasters.urlcrawlerrorssamples.markAsFixed - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.category The crawl error category. For example: authPermissions - * @param {string} params.platform The user agent type (platform) that made the request. For example: web - * @param {string} params.siteUrl The site's URL, including protocol. For example: http://www.example.com/ - * @param {string} params.url The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - markAsFixed( - params?: Params$Resource$Urlcrawlerrorssamples$Markasfixed, - options?: MethodOptions - ): GaxiosPromise; - markAsFixed( - params: Params$Resource$Urlcrawlerrorssamples$Markasfixed, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - markAsFixed( - params: Params$Resource$Urlcrawlerrorssamples$Markasfixed, - callback: BodyResponseCallback - ): void; - markAsFixed(callback: BodyResponseCallback): void; - markAsFixed( - paramsOrCallback?: - | Params$Resource$Urlcrawlerrorssamples$Markasfixed - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Urlcrawlerrorssamples$Markasfixed; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Urlcrawlerrorssamples$Markasfixed; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/webmasters/v3/sites/{siteUrl}/urlCrawlErrorsSamples/{url}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['siteUrl', 'url', 'category', 'platform'], - pathParams: ['siteUrl', 'url'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Urlcrawlerrorssamples$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The crawl error category. For example: authPermissions - */ - category?: string; - /** - * The user agent type (platform) that made the request. For example: web - */ - platform?: string; - /** - * The site's URL, including protocol. For example: http://www.example.com/ - */ - siteUrl?: string; - /** - * The relative path (without the site) of the sample URL. It must be one of - * the URLs returned by list(). For example, for the URL - * https://www.example.com/pagename on the site https://www.example.com/, - * the url value is pagename - */ - url?: string; - } - export interface Params$Resource$Urlcrawlerrorssamples$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The crawl error category. For example: authPermissions - */ - category?: string; - /** - * The user agent type (platform) that made the request. For example: web - */ - platform?: string; - /** - * The site's URL, including protocol. For example: http://www.example.com/ - */ - siteUrl?: string; - } - export interface Params$Resource$Urlcrawlerrorssamples$Markasfixed - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The crawl error category. For example: authPermissions - */ - category?: string; - /** - * The user agent type (platform) that made the request. For example: web - */ - platform?: string; - /** - * The site's URL, including protocol. For example: http://www.example.com/ - */ - siteUrl?: string; - /** - * The relative path (without the site) of the sample URL. It must be one of - * the URLs returned by list(). For example, for the URL - * https://www.example.com/pagename on the site https://www.example.com/, - * the url value is pagename - */ - url?: string; - } } diff --git a/src/apis/websecurityscanner/package.json b/src/apis/websecurityscanner/package.json index 2f7328e2211..2126b34c40d 100644 --- a/src/apis/websecurityscanner/package.json +++ b/src/apis/websecurityscanner/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/websecurityscanner/v1alpha.ts b/src/apis/websecurityscanner/v1alpha.ts index 936893d8225..bdf0fc8543d 100644 --- a/src/apis/websecurityscanner/v1alpha.ts +++ b/src/apis/websecurityscanner/v1alpha.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace websecurityscanner_v1alpha { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace websecurityscanner_v1alpha { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace websecurityscanner_v1alpha { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -132,9 +131,7 @@ export namespace websecurityscanner_v1alpha { googleAccount?: Schema$GoogleAccount; } /** - * A CrawledUrl resource represents a URL that was crawled during a ScanRun. - * Web Security Scanner Service crawls the web applications, following all - * links within the scope of sites, to find the URLs to test against. + * A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against. */ export interface Schema$CrawledUrl { /** @@ -142,8 +139,7 @@ export namespace websecurityscanner_v1alpha { */ body?: string; /** - * Output only. The http method of the request that was used to visit the - * URL, in uppercase. + * Output only. The http method of the request that was used to visit the URL, in uppercase. */ httpMethod?: string; /** @@ -160,9 +156,7 @@ export namespace websecurityscanner_v1alpha { */ loginUrl?: string; /** - * Input only. Required. The password of the custom account. The credential - * is stored encrypted and not returned in any response nor included in - * audit logs. + * Input only. Required. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** @@ -171,16 +165,11 @@ export namespace websecurityscanner_v1alpha { username?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A Finding resource represents a vulnerability instance identified during a - * ScanRun. + * A Finding resource represents a vulnerability instance identified during a ScanRun. */ export interface Schema$Finding { /** @@ -192,8 +181,7 @@ export namespace websecurityscanner_v1alpha { */ description?: string; /** - * Output only. The URL where the browser lands when the vulnerability is - * detected. + * Output only. The URL where the browser lands when the vulnerability is detected. */ finalUrl?: string; /** @@ -201,25 +189,19 @@ export namespace websecurityscanner_v1alpha { */ findingType?: string; /** - * Output only. If the vulnerability was originated from nested IFrame, the - * immediate parent IFrame is reported. + * Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */ frameUrl?: string; /** - * Output only. The URL produced by the server-side fuzzer and used in the - * request that triggered the vulnerability. + * Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */ fuzzedUrl?: string; /** - * Output only. The http method of the request that triggered the - * vulnerability, in uppercase. + * Output only. The http method of the request that triggered the vulnerability, in uppercase. */ httpMethod?: string; /** - * Output only. The resource name of the Finding. The name follows the - * format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. - * The finding IDs are generated by the system. + * Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */ name?: string; /** @@ -227,29 +209,23 @@ export namespace websecurityscanner_v1alpha { */ outdatedLibrary?: Schema$OutdatedLibrary; /** - * Output only. The URL containing human-readable payload that user can - * leverage to reproduce the vulnerability. + * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ reproductionUrl?: string; /** - * Output only. The tracking ID uniquely identifies a vulnerability instance - * across multiple ScanRuns. + * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ trackingId?: string; /** - * Output only. An addon containing detailed information regarding any - * resource causing the vulnerability such as JavaScript sources, image, - * audio files, etc. + * Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ violatingResource?: Schema$ViolatingResource; /** - * Output only. An addon containing information about vulnerable or missing - * HTTP headers. + * Output only. An addon containing information about vulnerable or missing HTTP headers. */ vulnerableHeaders?: Schema$VulnerableHeaders; /** - * Output only. An addon containing information about request parameters - * which were found to be vulnerable. + * Output only. An addon containing information about request parameters which were found to be vulnerable. */ vulnerableParameters?: Schema$VulnerableParameters; /** @@ -258,8 +234,7 @@ export namespace websecurityscanner_v1alpha { xss?: Schema$Xss; } /** - * A FindingTypeStats resource represents stats regarding a specific - * FindingType of Findings under a given ScanRun. + * A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun. */ export interface Schema$FindingTypeStats { /** @@ -276,9 +251,7 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$GoogleAccount { /** - * Input only. Required. The password of the Google account. The credential - * is stored encrypted and not returned in any response nor included in - * audit logs. + * Input only. Required. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** @@ -308,8 +281,7 @@ export namespace websecurityscanner_v1alpha { */ crawledUrls?: Schema$CrawledUrl[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -322,8 +294,7 @@ export namespace websecurityscanner_v1alpha { */ findings?: Schema$Finding[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -341,8 +312,7 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$ListScanConfigsResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** @@ -355,8 +325,7 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$ListScanRunsResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** @@ -382,18 +351,15 @@ export namespace websecurityscanner_v1alpha { version?: string; } /** - * A ScanConfig resource contains the configurations to launch a scan. next - * id: 12 + * A ScanConfig resource contains the configurations to launch a scan. next id: 12 */ export interface Schema$ScanConfig { /** - * The authentication configuration. If specified, service will use the - * authentication configuration during scanning. + * The authentication configuration. If specified, service will use the authentication configuration during scanning. */ authentication?: Schema$Authentication; /** - * The blacklist URL patterns as described in - * https://cloud.google.com/security-scanner/docs/excluded-urls + * The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls */ blacklistPatterns?: string[]; /** @@ -405,16 +371,11 @@ export namespace websecurityscanner_v1alpha { */ latestRun?: Schema$ScanRun; /** - * The maximum QPS during scanning. A valid value ranges from 5 to 20 - * inclusively. If the field is unspecified or its value is set 0, server - * will default to 15. Other values outside of [5, 20] range will be - * rejected with INVALID_ARGUMENT error. + * The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. */ maxQps?: number; /** - * The resource name of the ScanConfig. The name follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig - * IDs are generated by the system. + * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ name?: string; /** @@ -426,8 +387,7 @@ export namespace websecurityscanner_v1alpha { */ startingUrls?: string[]; /** - * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be - * used as a default. + * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */ targetPlatforms?: string[]; /** @@ -440,8 +400,7 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$ScanRun { /** - * Output only. The time at which the ScanRun reached termination state - - * that the ScanRun is either finished or stopped by user. + * Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */ endTime?: string; /** @@ -453,21 +412,15 @@ export namespace websecurityscanner_v1alpha { */ hasVulnerabilities?: boolean; /** - * Output only. The resource name of the ScanRun. The name follows the - * format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. - * The ScanRun IDs are generated by the system. + * Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */ name?: string; /** - * Output only. The percentage of total completion ranging from 0 to 100. If - * the scan is in queue, the value is 0. If the scan is running, the value - * ranges from 0 to 100. If the scan is finished, the value is 100. + * Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */ progressPercent?: number; /** - * Output only. The result state of the ScanRun. This field is only - * available after the execution state reaches "FINISHED". + * Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */ resultState?: string; /** @@ -475,16 +428,11 @@ export namespace websecurityscanner_v1alpha { */ startTime?: string; /** - * Output only. The number of URLs crawled during this ScanRun. If the scan - * is in progress, the value represents the number of URLs crawled up to - * now. + * Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */ urlsCrawledCount?: string; /** - * Output only. The number of URLs tested during this ScanRun. If the scan - * is in progress, the value represents the number of URLs tested up to now. - * The number of URLs tested is usually larger than the number URLS crawled - * because typically a crawled URL is tested with multiple test payloads. + * Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */ urlsTestedCount?: string; } @@ -497,10 +445,7 @@ export namespace websecurityscanner_v1alpha { */ intervalDurationDays?: number; /** - * A timestamp indicates when the next run will be scheduled. The value is - * refreshed by the server after each run. If unspecified, it will default - * to current server time, which means the scan will be scheduled to start - * immediately. + * A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. */ scheduleTime?: string; } @@ -513,8 +458,7 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$StopScanRunRequest {} /** - * Information regarding any resource causing the vulnerability such as - * JavaScript sources, image, audio files, etc. + * Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ export interface Schema$ViolatingResource { /** @@ -878,8 +822,7 @@ export namespace websecurityscanner_v1alpha { /** * websecurityscanner.projects.scanConfigs.patch - * @desc Updates a ScanConfig. This method support partial update of a - * ScanConfig. + * @desc Updates a ScanConfig. This method support partial update of a ScanConfig. * @alias websecurityscanner.projects.scanConfigs.patch * @memberOf! () * @@ -1034,8 +977,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource name where the scan is created, which - * should be a project resource name in the format 'projects/{projectId}'. + * Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. */ parent?: string; @@ -1052,8 +994,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanConfig to be deleted. The name - * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; } @@ -1065,8 +1006,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanConfig to be returned. The name - * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; } @@ -1078,20 +1018,15 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of ScanConfigs to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a project resource - * name in the format 'projects/{projectId}'. + * Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. */ parent?: string; } @@ -1103,15 +1038,11 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the ScanConfig. The name follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are - * generated by the system. + * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ name?: string; /** - * Required. The update mask applies to the resource. For the `FieldMask` - * definition, see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -1128,8 +1059,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanConfig to be used. The name - * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; @@ -1229,8 +1159,7 @@ export namespace websecurityscanner_v1alpha { /** * websecurityscanner.projects.scanConfigs.scanRuns.list - * @desc Lists ScanRuns under a given ScanConfig, in descending order of - * ScanRun stop time. + * @desc Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. * @alias websecurityscanner.projects.scanConfigs.scanRuns.list * @memberOf! () * @@ -1390,9 +1319,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanRun to be returned. The name - * follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ name?: string; } @@ -1404,20 +1331,15 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of ScanRuns to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a scan resource name - * in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ parent?: string; } @@ -1429,9 +1351,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanRun to be stopped. The name - * follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ name?: string; @@ -1535,21 +1455,15 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of CrawledUrls to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a scan run resource - * name in the format - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } @@ -1719,9 +1633,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Finding to be returned. The name - * follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. + * Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. */ name?: string; } @@ -1733,27 +1645,19 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter expression. The expression must be in the format: - * . Supported field: 'finding_type'. Supported operator: - * '='. + * The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */ filter?: string; /** - * The maximum number of Findings to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a scan run resource - * name in the format - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } @@ -1767,8 +1671,7 @@ export namespace websecurityscanner_v1alpha { /** * websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list * @desc List all FindingTypeStats under a given ScanRun. - * @alias - * websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list + * @alias websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list * @memberOf! () * * @param {object} params Parameters for request @@ -1858,9 +1761,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource name, which should be a scan run resource - * name in the format - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } diff --git a/src/apis/websecurityscanner/v1beta.ts b/src/apis/websecurityscanner/v1beta.ts index 2f4470ddccf..ea850000fef 100644 --- a/src/apis/websecurityscanner/v1beta.ts +++ b/src/apis/websecurityscanner/v1beta.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace websecurityscanner_v1beta { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace websecurityscanner_v1beta { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -112,7 +108,10 @@ export namespace websecurityscanner_v1beta { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.projects = new Resource$Projects(this.context); } @@ -132,9 +131,7 @@ export namespace websecurityscanner_v1beta { googleAccount?: Schema$GoogleAccount; } /** - * A CrawledUrl resource represents a URL that was crawled during a ScanRun. - * Web Security Scanner Service crawls the web applications, following all - * links within the scope of sites, to find the URLs to test against. + * A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against. */ export interface Schema$CrawledUrl { /** @@ -142,8 +139,7 @@ export namespace websecurityscanner_v1beta { */ body?: string; /** - * Output only. The http method of the request that was used to visit the - * URL, in uppercase. + * Output only. The http method of the request that was used to visit the URL, in uppercase. */ httpMethod?: string; /** @@ -160,9 +156,7 @@ export namespace websecurityscanner_v1beta { */ loginUrl?: string; /** - * Input only. Required. The password of the custom account. The credential - * is stored encrypted and not returned in any response nor included in - * audit logs. + * Input only. Required. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** @@ -171,16 +165,11 @@ export namespace websecurityscanner_v1beta { username?: string; } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * A Finding resource represents a vulnerability instance identified during a - * ScanRun. + * A Finding resource represents a vulnerability instance identified during a ScanRun. */ export interface Schema$Finding { /** @@ -192,41 +181,31 @@ export namespace websecurityscanner_v1beta { */ description?: string; /** - * Output only. The URL where the browser lands when the vulnerability is - * detected. + * Output only. The URL where the browser lands when the vulnerability is detected. */ finalUrl?: string; /** - * Output only. The type of the Finding. Detailed and up-to-date information - * on findings can be found here: - * https://cloud.google.com/security-scanner/docs/scan-result-details + * Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-scanner/docs/scan-result-details */ findingType?: string; /** - * Output only. An addon containing information reported for a vulnerability - * with an HTML form, if any. + * Output only. An addon containing information reported for a vulnerability with an HTML form, if any. */ form?: Schema$Form; /** - * Output only. If the vulnerability was originated from nested IFrame, the - * immediate parent IFrame is reported. + * Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */ frameUrl?: string; /** - * Output only. The URL produced by the server-side fuzzer and used in the - * request that triggered the vulnerability. + * Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */ fuzzedUrl?: string; /** - * Output only. The http method of the request that triggered the - * vulnerability, in uppercase. + * Output only. The http method of the request that triggered the vulnerability, in uppercase. */ httpMethod?: string; /** - * Output only. The resource name of the Finding. The name follows the - * format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. - * The finding IDs are generated by the system. + * Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */ name?: string; /** @@ -234,29 +213,23 @@ export namespace websecurityscanner_v1beta { */ outdatedLibrary?: Schema$OutdatedLibrary; /** - * Output only. The URL containing human-readable payload that user can - * leverage to reproduce the vulnerability. + * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ reproductionUrl?: string; /** - * Output only. The tracking ID uniquely identifies a vulnerability instance - * across multiple ScanRuns. + * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ trackingId?: string; /** - * Output only. An addon containing detailed information regarding any - * resource causing the vulnerability such as JavaScript sources, image, - * audio files, etc. + * Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ violatingResource?: Schema$ViolatingResource; /** - * Output only. An addon containing information about vulnerable or missing - * HTTP headers. + * Output only. An addon containing information about vulnerable or missing HTTP headers. */ vulnerableHeaders?: Schema$VulnerableHeaders; /** - * Output only. An addon containing information about request parameters - * which were found to be vulnerable. + * Output only. An addon containing information about request parameters which were found to be vulnerable. */ vulnerableParameters?: Schema$VulnerableParameters; /** @@ -265,8 +238,7 @@ export namespace websecurityscanner_v1beta { xss?: Schema$Xss; } /** - * A FindingTypeStats resource represents stats regarding a specific - * FindingType of Findings under a given ScanRun. + * A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun. */ export interface Schema$FindingTypeStats { /** @@ -296,9 +268,7 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$GoogleAccount { /** - * Input only. Required. The password of the Google account. The credential - * is stored encrypted and not returned in any response nor included in - * audit logs. + * Input only. Required. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** @@ -328,8 +298,7 @@ export namespace websecurityscanner_v1beta { */ crawledUrls?: Schema$CrawledUrl[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -342,8 +311,7 @@ export namespace websecurityscanner_v1beta { */ findings?: Schema$Finding[]; /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; } @@ -361,8 +329,7 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$ListScanConfigsResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** @@ -375,8 +342,7 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$ListScanRunsResponse { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string; /** @@ -402,18 +368,15 @@ export namespace websecurityscanner_v1beta { version?: string; } /** - * A ScanConfig resource contains the configurations to launch a scan. next - * id: 12 + * A ScanConfig resource contains the configurations to launch a scan. next id: 12 */ export interface Schema$ScanConfig { /** - * The authentication configuration. If specified, service will use the - * authentication configuration during scanning. + * The authentication configuration. If specified, service will use the authentication configuration during scanning. */ authentication?: Schema$Authentication; /** - * The blacklist URL patterns as described in - * https://cloud.google.com/security-scanner/docs/excluded-urls + * The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls */ blacklistPatterns?: string[]; /** @@ -421,8 +384,7 @@ export namespace websecurityscanner_v1beta { */ displayName?: string; /** - * Controls export of scan configurations and results to Cloud Security - * Command Center. + * Controls export of scan configurations and results to Cloud Security Command Center. */ exportToSecurityCommandCenter?: string; /** @@ -430,16 +392,11 @@ export namespace websecurityscanner_v1beta { */ latestRun?: Schema$ScanRun; /** - * The maximum QPS during scanning. A valid value ranges from 5 to 20 - * inclusively. If the field is unspecified or its value is set 0, server - * will default to 15. Other values outside of [5, 20] range will be - * rejected with INVALID_ARGUMENT error. + * The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. */ maxQps?: number; /** - * The resource name of the ScanConfig. The name follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig - * IDs are generated by the system. + * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ name?: string; /** @@ -451,8 +408,7 @@ export namespace websecurityscanner_v1beta { */ startingUrls?: string[]; /** - * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be - * used as a default. + * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */ targetPlatforms?: string[]; /** @@ -461,10 +417,7 @@ export namespace websecurityscanner_v1beta { userAgent?: string; } /** - * Defines a custom error message used by CreateScanConfig and - * UpdateScanConfig APIs when scan configuration validation fails. It is also - * reported as part of a ScanRunErrorTrace message if scan validation fails - * due to a scan configuration error. + * Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. */ export interface Schema$ScanConfigError { /** @@ -472,27 +425,20 @@ export namespace websecurityscanner_v1beta { */ code?: string; /** - * Output only. Indicates the full name of the ScanConfig field that - * triggers this error, for example "scan_config.max_qps". This - * field is provided for troubleshooting purposes only and its actual value - * can change in the future. + * Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. */ fieldName?: string; } /** - * A ScanRun is a output-only resource representing an actual run of the scan. - * Next id: 12 + * A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 */ export interface Schema$ScanRun { /** - * Output only. The time at which the ScanRun reached termination state - - * that the ScanRun is either finished or stopped by user. + * Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */ endTime?: string; /** - * Output only. If result_state is an ERROR, this field provides the primary - * reason for scan's termination and more details, if such are - * available. + * Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. */ errorTrace?: Schema$ScanRunErrorTrace; /** @@ -504,21 +450,15 @@ export namespace websecurityscanner_v1beta { */ hasVulnerabilities?: boolean; /** - * Output only. The resource name of the ScanRun. The name follows the - * format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. - * The ScanRun IDs are generated by the system. + * Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */ name?: string; /** - * Output only. The percentage of total completion ranging from 0 to 100. If - * the scan is in queue, the value is 0. If the scan is running, the value - * ranges from 0 to 100. If the scan is finished, the value is 100. + * Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */ progressPercent?: number; /** - * Output only. The result state of the ScanRun. This field is only - * available after the execution state reaches "FINISHED". + * Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */ resultState?: string; /** @@ -526,21 +466,15 @@ export namespace websecurityscanner_v1beta { */ startTime?: string; /** - * Output only. The number of URLs crawled during this ScanRun. If the scan - * is in progress, the value represents the number of URLs crawled up to - * now. + * Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */ urlsCrawledCount?: string; /** - * Output only. The number of URLs tested during this ScanRun. If the scan - * is in progress, the value represents the number of URLs tested up to now. - * The number of URLs tested is usually larger than the number URLS crawled - * because typically a crawled URL is tested with multiple test payloads. + * Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */ urlsTestedCount?: string; /** - * Output only. A list of warnings, if such are encountered during this scan - * run. + * Output only. A list of warnings, if such are encountered during this scan run. */ warningTraces?: Schema$ScanRunWarningTrace[]; } @@ -553,23 +487,16 @@ export namespace websecurityscanner_v1beta { */ code?: string; /** - * Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field - * indicates the most common HTTP error code, if such is available. For - * example, if this code is 404, the scan has encountered too many NOT_FOUND - * responses. + * Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. */ mostCommonHttpErrorCode?: number; /** - * Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field - * has the error message encountered during scan configuration validation - * that is performed before each scan run. + * Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. */ scanConfigError?: Schema$ScanConfigError; } /** - * Output only. Defines a warning trace message for ScanRun. Warning traces - * provide customers with useful information that helps make the scanning - * process more effective. + * Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective. */ export interface Schema$ScanRunWarningTrace { /** @@ -586,10 +513,7 @@ export namespace websecurityscanner_v1beta { */ intervalDurationDays?: number; /** - * A timestamp indicates when the next run will be scheduled. The value is - * refreshed by the server after each run. If unspecified, it will default - * to current server time, which means the scan will be scheduled to start - * immediately. + * A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. */ scheduleTime?: string; } @@ -602,8 +526,7 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$StopScanRunRequest {} /** - * Information regarding any resource causing the vulnerability such as - * JavaScript sources, image, audio files, etc. + * Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ export interface Schema$ViolatingResource { /** @@ -967,8 +890,7 @@ export namespace websecurityscanner_v1beta { /** * websecurityscanner.projects.scanConfigs.patch - * @desc Updates a ScanConfig. This method support partial update of a - * ScanConfig. + * @desc Updates a ScanConfig. This method support partial update of a ScanConfig. * @alias websecurityscanner.projects.scanConfigs.patch * @memberOf! () * @@ -1123,8 +1045,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource name where the scan is created, which - * should be a project resource name in the format 'projects/{projectId}'. + * Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. */ parent?: string; @@ -1141,8 +1062,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanConfig to be deleted. The name - * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; } @@ -1154,8 +1074,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanConfig to be returned. The name - * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; } @@ -1167,20 +1086,15 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of ScanConfigs to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a project resource - * name in the format 'projects/{projectId}'. + * Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. */ parent?: string; } @@ -1192,15 +1106,11 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the ScanConfig. The name follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are - * generated by the system. + * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ name?: string; /** - * Required. The update mask applies to the resource. For the `FieldMask` - * definition, see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; @@ -1217,8 +1127,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanConfig to be used. The name - * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; @@ -1318,8 +1227,7 @@ export namespace websecurityscanner_v1beta { /** * websecurityscanner.projects.scanConfigs.scanRuns.list - * @desc Lists ScanRuns under a given ScanConfig, in descending order of - * ScanRun stop time. + * @desc Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. * @alias websecurityscanner.projects.scanConfigs.scanRuns.list * @memberOf! () * @@ -1479,9 +1387,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanRun to be returned. The name - * follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ name?: string; } @@ -1493,20 +1399,15 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of ScanRuns to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a scan resource name - * in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. + * Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ parent?: string; } @@ -1518,9 +1419,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the ScanRun to be stopped. The name - * follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ name?: string; @@ -1624,21 +1523,15 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of CrawledUrls to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a scan run resource - * name in the format - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } @@ -1808,9 +1701,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Finding to be returned. The name - * follows the format of - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. + * Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. */ name?: string; } @@ -1822,27 +1713,19 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter expression. The expression must be in the format: - * . Supported field: 'finding_type'. Supported operator: - * '='. + * The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */ filter?: string; /** - * The maximum number of Findings to return, can be limited by server. If - * not specified or not positive, the implementation will select a - * reasonable value. + * The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. */ pageSize?: number; /** - * A token identifying a page of results to be returned. This should be a - * `next_page_token` value returned from a previous List request. If - * unspecified, the first page of results is returned. + * A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. The parent resource name, which should be a scan run resource - * name in the format - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } @@ -1856,8 +1739,7 @@ export namespace websecurityscanner_v1beta { /** * websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list * @desc List all FindingTypeStats under a given ScanRun. - * @alias - * websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list + * @alias websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list * @memberOf! () * * @param {object} params Parameters for request @@ -1947,9 +1829,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource name, which should be a scan run resource - * name in the format - * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + * Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } diff --git a/src/apis/youtube/package.json b/src/apis/youtube/package.json index e2e91a7c885..ec0fcda6133 100644 --- a/src/apis/youtube/package.json +++ b/src/apis/youtube/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index cb0d9b8e6e8..d0d8db1c613 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace youtube_v3 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace youtube_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -78,8 +75,7 @@ export namespace youtube_v3 { /** * YouTube Data API * - * Supports core YouTube features, such as uploading videos, creating and - * managing playlists, searching for content, and much more. + * Supports core YouTube features, such as uploading videos, creating and managing playlists, searching for content, and much more. * * @example * const {google} = require('googleapis'); @@ -121,7 +117,10 @@ export namespace youtube_v3 { watermarks: Resource$Watermarks; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.activities = new Resource$Activities(this.context); this.captions = new Resource$Captions(this.context); @@ -159,31 +158,20 @@ export namespace youtube_v3 { */ export interface Schema$AccessPolicy { /** - * The value of allowed indicates whether the access to the policy is - * allowed or denied by default. + * The value of allowed indicates whether the access to the policy is allowed or denied by default. */ allowed?: boolean; /** - * A list of region codes that identify countries where the default policy - * do not apply. + * A list of region codes that identify countries where the default policy do not apply. */ exception?: string[]; } /** - * An activity resource contains information about an action that a particular - * channel, or user, has taken on YouTube.The actions reported in activity - * feeds include rating a video, sharing a video, marking a video as a - * favorite, commenting on a video, uploading a video, and so forth. Each - * activity resource identifies the type of action, the channel associated - * with the action, and the resource(s) associated with the action, such as - * the video that was rated or uploaded. + * An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded. */ export interface Schema$Activity { /** - * The contentDetails object contains information about the content - * associated with the activity. For example, if the snippet.type value is - * videoRated, then the contentDetails object's content identifies the - * rated video. + * The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video. */ contentDetails?: Schema$ActivityContentDetails; /** @@ -195,80 +183,60 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#activity". + * Identifies what kind of resource this is. Value: the fixed string "youtube#activity". */ kind?: string; /** - * The snippet object contains basic details about the activity, including - * the activity's type and group ID. + * The snippet object contains basic details about the activity, including the activity's type and group ID. */ snippet?: Schema$ActivitySnippet; } /** - * Details about the content of an activity: the video that was shared, the - * channel that was subscribed to, etc. + * Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. */ export interface Schema$ActivityContentDetails { /** - * The bulletin object contains details about a channel bulletin post. This - * object is only present if the snippet.type is bulletin. + * The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin. */ bulletin?: Schema$ActivityContentDetailsBulletin; /** - * The channelItem object contains details about a resource which was added - * to a channel. This property is only present if the snippet.type is - * channelItem. + * The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem. */ channelItem?: Schema$ActivityContentDetailsChannelItem; /** - * The comment object contains information about a resource that received a - * comment. This property is only present if the snippet.type is comment. + * The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment. */ comment?: Schema$ActivityContentDetailsComment; /** - * The favorite object contains information about a video that was marked as - * a favorite video. This property is only present if the snippet.type is - * favorite. + * The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite. */ favorite?: Schema$ActivityContentDetailsFavorite; /** - * The like object contains information about a resource that received a - * positive (like) rating. This property is only present if the snippet.type - * is like. + * The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like. */ like?: Schema$ActivityContentDetailsLike; /** - * The playlistItem object contains information about a new playlist item. - * This property is only present if the snippet.type is playlistItem. + * The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem. */ playlistItem?: Schema$ActivityContentDetailsPlaylistItem; /** - * The promotedItem object contains details about a resource which is being - * promoted. This property is only present if the snippet.type is - * promotedItem. + * The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem. */ promotedItem?: Schema$ActivityContentDetailsPromotedItem; /** - * The recommendation object contains information about a recommended - * resource. This property is only present if the snippet.type is - * recommendation. + * The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation. */ recommendation?: Schema$ActivityContentDetailsRecommendation; /** - * The social object contains details about a social network post. This - * property is only present if the snippet.type is social. + * The social object contains details about a social network post. This property is only present if the snippet.type is social. */ social?: Schema$ActivityContentDetailsSocial; /** - * The subscription object contains information about a channel that a user - * subscribed to. This property is only present if the snippet.type is - * subscription. + * The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription. */ subscription?: Schema$ActivityContentDetailsSubscription; /** - * The upload object contains information about the uploaded video. This - * property is only present if the snippet.type is upload. + * The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload. */ upload?: Schema$ActivityContentDetailsUpload; } @@ -277,8 +245,7 @@ export namespace youtube_v3 { */ export interface Schema$ActivityContentDetailsBulletin { /** - * The resourceId object contains information that identifies the resource - * associated with a bulletin post. + * The resourceId object contains information that identifies the resource associated with a bulletin post. */ resourceId?: Schema$ResourceId; } @@ -287,8 +254,7 @@ export namespace youtube_v3 { */ export interface Schema$ActivityContentDetailsChannelItem { /** - * The resourceId object contains information that identifies the resource - * that was added to the channel. + * The resourceId object contains information that identifies the resource that was added to the channel. */ resourceId?: Schema$ResourceId; } @@ -297,8 +263,7 @@ export namespace youtube_v3 { */ export interface Schema$ActivityContentDetailsComment { /** - * The resourceId object contains information that identifies the resource - * associated with the comment. + * The resourceId object contains information that identifies the resource associated with the comment. */ resourceId?: Schema$ResourceId; } @@ -307,8 +272,7 @@ export namespace youtube_v3 { */ export interface Schema$ActivityContentDetailsFavorite { /** - * The resourceId object contains information that identifies the resource - * that was marked as a favorite. + * The resourceId object contains information that identifies the resource that was marked as a favorite. */ resourceId?: Schema$ResourceId; } @@ -317,8 +281,7 @@ export namespace youtube_v3 { */ export interface Schema$ActivityContentDetailsLike { /** - * The resourceId object contains information that identifies the rated - * resource. + * The resourceId object contains information that identifies the rated resource. */ resourceId?: Schema$ResourceId; } @@ -335,8 +298,7 @@ export namespace youtube_v3 { */ playlistItemId?: string; /** - * The resourceId object contains information about the resource that was - * added to the playlist. + * The resourceId object contains information about the resource that was added to the playlist. */ resourceId?: Schema$ResourceId; } @@ -349,23 +311,19 @@ export namespace youtube_v3 { */ adTag?: string; /** - * The URL the client should ping to indicate that the user clicked through - * on this promoted item. + * The URL the client should ping to indicate that the user clicked through on this promoted item. */ clickTrackingUrl?: string; /** - * The URL the client should ping to indicate that the user was shown this - * promoted item. + * The URL the client should ping to indicate that the user was shown this promoted item. */ creativeViewUrl?: string; /** - * The type of call-to-action, a message to the user indicating action that - * can be taken. + * The type of call-to-action, a message to the user indicating action that can be taken. */ ctaType?: string; /** - * The custom call-to-action button text. If specified, it will override the - * default button text for the cta_type. + * The custom call-to-action button text. If specified, it will override the default button text for the cta_type. */ customCtaButtonText?: string; /** @@ -373,19 +331,15 @@ export namespace youtube_v3 { */ descriptionText?: string; /** - * The URL the client should direct the user to, if the user chooses to - * visit the advertiser's website. + * The URL the client should direct the user to, if the user chooses to visit the advertiser's website. */ destinationUrl?: string; /** - * The list of forecasting URLs. The client should ping all of these URLs - * when a promoted item is not available, to indicate that a promoted item - * could have been shown. + * The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown. */ forecastingUrl?: string[]; /** - * The list of impression URLs. The client should ping all of these URLs to - * indicate that the user was shown this promoted item. + * The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item. */ impressionUrl?: string[]; /** @@ -402,13 +356,11 @@ export namespace youtube_v3 { */ reason?: string; /** - * The resourceId object contains information that identifies the - * recommended resource. + * The resourceId object contains information that identifies the recommended resource. */ resourceId?: Schema$ResourceId; /** - * The seedResourceId object contains information about the resource that - * caused the recommendation. + * The seedResourceId object contains information about the resource that caused the recommendation. */ seedResourceId?: Schema$ResourceId; } @@ -429,8 +381,7 @@ export namespace youtube_v3 { */ referenceUrl?: string; /** - * The resourceId object encapsulates information that identifies the - * resource associated with a social network post. + * The resourceId object encapsulates information that identifies the resource associated with a social network post. */ resourceId?: Schema$ResourceId; /** @@ -443,8 +394,7 @@ export namespace youtube_v3 { */ export interface Schema$ActivityContentDetailsSubscription { /** - * The resourceId object contains information that identifies the resource - * that the user subscribed to. + * The resourceId object contains information that identifies the resource that the user subscribed to. */ resourceId?: Schema$ResourceId; } @@ -471,19 +421,16 @@ export namespace youtube_v3 { */ items?: Schema$Activity[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#activityListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#activityListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -493,13 +440,11 @@ export namespace youtube_v3 { visitorId?: string; } /** - * Basic details about an activity, including title, description, thumbnails, - * activity type and group. + * Basic details about an activity, including title, description, thumbnails, activity type and group. */ export interface Schema$ActivitySnippet { /** - * The ID that YouTube uses to uniquely identify the channel associated with - * the activity. + * The ID that YouTube uses to uniquely identify the channel associated with the activity. */ channelId?: string; /** @@ -511,24 +456,15 @@ export namespace youtube_v3 { */ description?: string; /** - * The group ID associated with the activity. A group ID identifies user - * events that are associated with the same user and resource. For example, - * if a user rates a video and marks the same video as a favorite, the - * entries for those events would have the same group ID in the user's - * activity feed. In your user interface, you can avoid repetition by - * grouping events with the same groupId value. + * The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value. */ groupId?: string; /** - * The date and time that the video was uploaded. The value is specified in - * ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * A map of thumbnail images associated with the resource that is primarily - * associated with the activity. For each object in the map, the key is the - * name of the thumbnail image, and the value is an object that contains - * other information about the thumbnail. + * A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -541,8 +477,7 @@ export namespace youtube_v3 { type?: string; } /** - * A caption resource represents a YouTube caption track. A caption track is - * associated with exactly one YouTube video. + * A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video. */ export interface Schema$Caption { /** @@ -554,8 +489,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#caption". + * Identifies what kind of resource this is. Value: the fixed string "youtube#caption". */ kind?: string; /** @@ -577,8 +511,7 @@ export namespace youtube_v3 { */ items?: Schema$Caption[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#captionListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse". */ kind?: string; /** @@ -595,54 +528,39 @@ export namespace youtube_v3 { */ audioTrackType?: string; /** - * The reason that YouTube failed to process the caption track. This - * property is only present if the state property's value is failed. + * The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed. */ failureReason?: string; /** - * Indicates whether YouTube synchronized the caption track to the audio - * track in the video. The value will be true if a sync was explicitly - * requested when the caption track was uploaded. For example, when calling - * the captions.insert or captions.update methods, you can set the sync - * parameter to true to instruct YouTube to sync the uploaded track to the - * video. If the value is false, YouTube uses the time codes in the uploaded - * caption track to determine when to display captions. + * Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions. */ isAutoSynced?: boolean; /** - * Indicates whether the track contains closed captions for the deaf and - * hard of hearing. The default value is false. + * Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false. */ isCC?: boolean; /** - * Indicates whether the caption track is a draft. If the value is true, - * then the track is not publicly visible. The default value is false. + * Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. */ isDraft?: boolean; /** - * Indicates whether caption track is formatted for "easy reader," - * meaning it is at a third-grade level for language learners. The default - * value is false. + * Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false. */ isEasyReader?: boolean; /** - * Indicates whether the caption track uses large text for the - * vision-impaired. The default value is false. + * Indicates whether the caption track uses large text for the vision-impaired. The default value is false. */ isLarge?: boolean; /** - * The language of the caption track. The property value is a BCP-47 - * language tag. + * The language of the caption track. The property value is a BCP-47 language tag. */ language?: string; /** - * The date and time when the caption track was last updated. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ lastUpdated?: string; /** - * The name of the caption track. The name is intended to be visible to the - * user as an option during playback. + * The name of the caption track. The name is intended to be visible to the user as an option during playback. */ name?: string; /** @@ -654,8 +572,7 @@ export namespace youtube_v3 { */ trackKind?: string; /** - * The ID that YouTube uses to uniquely identify the video associated with - * the caption track. + * The ID that YouTube uses to uniquely identify the video associated with the caption track. */ videoId?: string; } @@ -672,8 +589,7 @@ export namespace youtube_v3 { */ frameRate?: string; /** - * The ingestionInfo object contains information that YouTube provides that - * you need to transmit your RTMP or HTTP stream to YouTube. + * The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube. */ ingestionInfo?: Schema$IngestionInfo; /** @@ -690,28 +606,23 @@ export namespace youtube_v3 { */ export interface Schema$Channel { /** - * The auditionDetails object encapsulates channel data that is relevant for - * YouTube Partners during the audition process. + * The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process. */ auditDetails?: Schema$ChannelAuditDetails; /** - * The brandingSettings object encapsulates information about the branding - * of the channel. + * The brandingSettings object encapsulates information about the branding of the channel. */ brandingSettings?: Schema$ChannelBrandingSettings; /** - * The contentDetails object encapsulates information about the - * channel's content. + * The contentDetails object encapsulates information about the channel's content. */ contentDetails?: Schema$ChannelContentDetails; /** - * The contentOwnerDetails object encapsulates channel data that is relevant - * for YouTube Partners linked with the channel. + * The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. */ contentOwnerDetails?: Schema$ChannelContentOwnerDetails; /** - * The conversionPings object encapsulates information about conversion - * pings that need to be respected by the channel. + * The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. */ conversionPings?: Schema$ChannelConversionPings; /** @@ -723,13 +634,11 @@ export namespace youtube_v3 { */ id?: string; /** - * The invideoPromotion object encapsulates information about promotion - * campaign associated with the channel. + * The invideoPromotion object encapsulates information about promotion campaign associated with the channel. */ invideoPromotion?: Schema$InvideoPromotion; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#channel". + * Identifies what kind of resource this is. Value: the fixed string "youtube#channel". */ kind?: string; /** @@ -737,8 +646,7 @@ export namespace youtube_v3 { */ localizations?: {[key: string]: Schema$ChannelLocalization}; /** - * The snippet object contains basic details about the channel, such as its - * title, description, and thumbnail images. + * The snippet object contains basic details about the channel, such as its title, description, and thumbnail images. */ snippet?: Schema$ChannelSnippet; /** @@ -746,19 +654,16 @@ export namespace youtube_v3 { */ statistics?: Schema$ChannelStatistics; /** - * The status object encapsulates information about the privacy status of - * the channel. + * The status object encapsulates information about the privacy status of the channel. */ status?: Schema$ChannelStatus; /** - * The topicDetails object encapsulates information about Freebase topics - * associated with the channel. + * The topicDetails object encapsulates information about Freebase topics associated with the channel. */ topicDetails?: Schema$ChannelTopicDetails; } /** - * The auditDetails object encapsulates channel data that is relevant for - * YouTube Partners during the audit process. + * The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. */ export interface Schema$ChannelAuditDetails { /** @@ -783,8 +688,7 @@ export namespace youtube_v3 { */ etag?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#channelBannerResource". + * Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource". */ kind?: string; /** @@ -826,8 +730,7 @@ export namespace youtube_v3 { }; } /** - * The contentOwnerDetails object encapsulates channel data that is relevant - * for YouTube Partners linked with the channel. + * The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. */ export interface Schema$ChannelContentOwnerDetails { /** @@ -835,15 +738,12 @@ export namespace youtube_v3 { */ contentOwner?: string; /** - * The date and time of when the channel was linked to the content owner. - * The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ timeLinked?: string; } /** - * Pings that the app shall fire (authenticated by biscotti cookie). Each ping - * has a context, in which the app must fire the ping, and a url identifying - * the ping. + * Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. */ export interface Schema$ChannelConversionPing { /** @@ -851,26 +751,16 @@ export namespace youtube_v3 { */ context?: string; /** - * The url (without the schema) that the player shall send the ping to. - * It's at caller's descretion to decide which schema to use (http - * vs https) Example of a returned url: - * //googleads.g.doubleclick.net/pagead/ - * viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D - * cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must - * append biscotti authentication (ms param in case of mobile, for example) - * to this ping. + * The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. */ conversionUrl?: string; } /** - * The conversionPings object encapsulates information about conversion pings - * that need to be respected by the channel. + * The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. */ export interface Schema$ChannelConversionPings { /** - * Pings that the app shall fire (authenticated by biscotti cookie). Each - * ping has a context, in which the app must fire the ping, and a url - * identifying the ping. + * Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. */ pings?: Schema$ChannelConversionPing[]; } @@ -888,19 +778,16 @@ export namespace youtube_v3 { */ items?: Schema$Channel[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#channelListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -942,8 +829,7 @@ export namespace youtube_v3 { } export interface Schema$ChannelSection { /** - * The contentDetails object contains details about the channel section - * content, such as a list of playlists or channels featured in the section. + * The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section. */ contentDetails?: Schema$ChannelSectionContentDetails; /** @@ -955,8 +841,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#channelSection". + * Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". */ kind?: string; /** @@ -964,13 +849,11 @@ export namespace youtube_v3 { */ localizations?: {[key: string]: Schema$ChannelSectionLocalization}; /** - * The snippet object contains basic details about the channel section, such - * as its type, style and title. + * The snippet object contains basic details about the channel section, such as its type, style and title. */ snippet?: Schema$ChannelSectionSnippet; /** - * The targeting object contains basic targeting settings about the channel - * section. + * The targeting object contains basic targeting settings about the channel section. */ targeting?: Schema$ChannelSectionTargeting; } @@ -983,8 +866,7 @@ export namespace youtube_v3 { */ channels?: string[]; /** - * The playlist ids for type single_playlist and multiple_playlists. For - * singlePlaylist, only one playlistId is allowed. + * The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. */ playlists?: string[]; } @@ -1002,8 +884,7 @@ export namespace youtube_v3 { */ items?: Schema$ChannelSection[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#channelSectionListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse". */ kind?: string; /** @@ -1025,8 +906,7 @@ export namespace youtube_v3 { */ export interface Schema$ChannelSectionSnippet { /** - * The ID that YouTube uses to uniquely identify the channel that published - * the channel section. + * The ID that YouTube uses to uniquely identify the channel that published the channel section. */ channelId?: string; /** @@ -1046,8 +926,7 @@ export namespace youtube_v3 { */ style?: string; /** - * The channel section's title for multiple_playlists and - * multiple_channels. + * The channel section's title for multiple_playlists and multiple_channels. */ title?: string; /** @@ -1102,8 +981,7 @@ export namespace youtube_v3 { */ keywords?: string; /** - * Whether user-submitted comments left on the channel page need to be - * approved by the channel owner to be publicly visible. + * Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. */ moderateComments?: boolean; /** @@ -1123,8 +1001,7 @@ export namespace youtube_v3 { */ title?: string; /** - * The ID for a Google Analytics account to track and measure traffic to the - * channels. + * The ID for a Google Analytics account to track and measure traffic to the channels. */ trackingAnalyticsAccountId?: string; /** @@ -1157,22 +1034,11 @@ export namespace youtube_v3 { */ localized?: Schema$ChannelLocalization; /** - * The date and time that the channel was created. The value is specified in - * ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * A map of thumbnail images associated with the channel. For each object in - * the map, the key is the name of the thumbnail image, and the value is an - * object that contains other information about the thumbnail. When - * displaying thumbnails in your application, make sure that your code uses - * the image URLs exactly as they are returned in API responses. For - * example, your application should not use the http domain instead of the - * https domain in a URL returned in an API response. Beginning in July - * 2018, channel thumbnail URLs will only be available in the https domain, - * which is how the URLs appear in API responses. After that time, you might - * see broken images in your application if it tries to load YouTube images - * from the http domain. + * A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response. Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -1181,8 +1047,7 @@ export namespace youtube_v3 { title?: string; } /** - * Statistics about a channel: number of subscribers, number of videos in the - * channel, etc. + * Statistics about a channel: number of subscribers, number of videos in the channel, etc. */ export interface Schema$ChannelStatistics { /** @@ -1211,8 +1076,7 @@ export namespace youtube_v3 { */ export interface Schema$ChannelStatus { /** - * If true, then the user is linked to either a YouTube username or G+ - * account. Otherwise, the user doesn't have a public YouTube identity. + * If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity. */ isLinked?: boolean; /** @@ -1233,8 +1097,7 @@ export namespace youtube_v3 { */ topicCategories?: string[]; /** - * A list of Freebase topic IDs associated with the channel. You can - * retrieve information about each topic using the Freebase Topic API. + * A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API. */ topicIds?: string[]; } @@ -1251,8 +1114,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#comment". + * Identifies what kind of resource this is. Value: the fixed string "youtube#comment". */ kind?: string; /** @@ -1274,13 +1136,11 @@ export namespace youtube_v3 { */ items?: Schema$Comment[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#commentListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; @@ -1315,9 +1175,7 @@ export namespace youtube_v3 { */ canRate?: boolean; /** - * The id of the corresponding YouTube channel. In case of a channel comment - * this is the channel the comment refers to. In case of a video comment - * it's the video's channel. + * The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel. */ channelId?: string; /** @@ -1325,8 +1183,7 @@ export namespace youtube_v3 { */ likeCount?: number; /** - * The comment's moderation status. Will not be set if the comments were - * requested through the id filter. + * The comment's moderation status. Will not be set if the comments were requested through the id filter. */ moderationStatus?: string; /** @@ -1334,27 +1191,19 @@ export namespace youtube_v3 { */ parentId?: string; /** - * The date and time when the comment was orignally published. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * The comment's text. The format is either plain text or HTML dependent - * on what has been requested. Even the plain text representation may differ - * from the text originally posted in that it may replace video links with - * video titles etc. + * The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc. */ textDisplay?: string; /** - * The comment's original raw text as initially posted or last updated. - * The original text will only be returned if it is accessible to the - * viewer, which is only guaranteed if the viewer is the comment's - * author. + * The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author. */ textOriginal?: string; /** - * The date and time when was last updated . The value is specified in ISO - * 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ updatedAt?: string; /** @@ -1362,16 +1211,12 @@ export namespace youtube_v3 { */ videoId?: string; /** - * The rating the viewer has given to this comment. For the time being this - * will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. - * This may change in the future. + * The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future. */ viewerRating?: string; } /** - * A comment thread represents information that applies to a top level comment - * and all its replies. It can also include the top level comment itself and - * some of the replies. + * A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies. */ export interface Schema$CommentThread { /** @@ -1383,18 +1228,15 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#commentThread". + * Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread". */ kind?: string; /** - * The replies object contains a limited number of replies (if any) to the - * top level comment found in the snippet. + * The replies object contains a limited number of replies (if any) to the top level comment found in the snippet. */ replies?: Schema$CommentThreadReplies; /** - * The snippet object contains basic details about the comment thread and - * also the top level comment. + * The snippet object contains basic details about the comment thread and also the top level comment. */ snippet?: Schema$CommentThreadSnippet; } @@ -1412,13 +1254,11 @@ export namespace youtube_v3 { */ items?: Schema$CommentThread[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#commentThreadListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; @@ -1433,9 +1273,7 @@ export namespace youtube_v3 { */ export interface Schema$CommentThreadReplies { /** - * A limited number of replies. Unless the number of replies returned equals - * total_reply_count in the snippet the returned replies are only a subset - * of the total number of replies. + * A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies. */ comments?: Schema$Comment[]; } @@ -1444,19 +1282,15 @@ export namespace youtube_v3 { */ export interface Schema$CommentThreadSnippet { /** - * Whether the current viewer of the thread can reply to it. This is viewer - * specific - other viewers may see a different value for this field. + * Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field. */ canReply?: boolean; /** - * The YouTube channel the comments in the thread refer to or the channel - * with the video the comments refer to. If video_id isn't set the - * comments refer to the channel itself. + * The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself. */ channelId?: string; /** - * Whether the thread (and therefore all its comments) is visible to all - * YouTube users. + * Whether the thread (and therefore all its comments) is visible to all YouTube users. */ isPublic?: boolean; /** @@ -1468,30 +1302,24 @@ export namespace youtube_v3 { */ totalReplyCount?: number; /** - * The ID of the video the comments refer to, if any. No video_id implies a - * channel discussion comment. + * The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. */ videoId?: string; } /** - * Ratings schemes. The country-specific ratings are mostly for movies and - * shows. NEXT_ID: 71 + * Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 71 */ export interface Schema$ContentRating { /** - * The video's Australian Classification Board (ACB) or Australian - * Communications and Media Authority (ACMA) rating. ACMA ratings are used - * to classify children's television programming. + * The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. */ acbRating?: string; /** - * The video's rating from Italy's Autorità per le Garanzie nelle - * Comunicazioni (AGCOM). + * The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). */ agcomRating?: string; /** - * The video's Anatel (Asociación Nacional de Televisión) rating for - * Chilean television. + * The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. */ anatelRating?: string; /** @@ -1499,33 +1327,23 @@ export namespace youtube_v3 { */ bbfcRating?: string; /** - * The video's rating from Thailand's Board of Film and Video - * Censors. + * The video's rating from Thailand's Board of Film and Video Censors. */ bfvcRating?: string; /** - * The video's rating from the Austrian Board of Media Classification - * (Bundesministerium für Unterricht, Kunst und Kultur). + * The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). */ bmukkRating?: string; /** - * The video's rating from the Canadian Radio-Television and - * Telecommunications Commission (CRTC) for Canadian French-language - * broadcasts. For more information, see the Canadian Broadcast Standards - * Council website. + * The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. */ catvfrRating?: string; /** - * Rating system for Canadian TV - Canadian TV Classification System The - * video's rating from the Canadian Radio-Television and - * Telecommunications Commission (CRTC) for Canadian English-language - * broadcasts. For more information, see the Canadian Broadcast Standards - * Council website. + * Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. */ catvRating?: string; /** - * The video's Central Board of Film Certification (CBFC - India) - * rating. + * The video's Central Board of Film Certification (CBFC - India) rating. */ cbfcRating?: string; /** @@ -1533,8 +1351,7 @@ export namespace youtube_v3 { */ cccRating?: string; /** - * The video's rating from Portugal's Comissão de Classificação de - * Espect´culos. + * The video's rating from Portugal's Comissão de Classificação de Espect´culos. */ cceRating?: string; /** @@ -1546,13 +1363,11 @@ export namespace youtube_v3 { */ chvrsRating?: string; /** - * The video's rating from the Commission de Contrôle des Films - * (Belgium). + * The video's rating from the Commission de Contrôle des Films (Belgium). */ cicfRating?: string; /** - * The video's rating from Romania's CONSILIUL NATIONAL AL - * AUDIOVIZUALULUI (CNA). + * The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). */ cnaRating?: string; /** @@ -1560,13 +1375,11 @@ export namespace youtube_v3 { */ cncRating?: string; /** - * The video's rating from France's Conseil supérieur de - * l?audiovisuel, which rates broadcast content. + * The video's rating from France's Conseil supérieur de l?audiovisuel, which rates broadcast content. */ csaRating?: string; /** - * The video's rating from Luxembourg's Commission de surveillance - * de la classification des films (CSCF). + * The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). */ cscfRating?: string; /** @@ -1574,8 +1387,7 @@ export namespace youtube_v3 { */ czfilmRating?: string; /** - * The video's Departamento de Justiça, Classificação, Qualificação e - * Títulos (DJCQT - Brazil) rating. + * The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. */ djctqRating?: string; /** @@ -1583,8 +1395,7 @@ export namespace youtube_v3 { */ djctqRatingReasons?: string[]; /** - * Rating system in Turkey - Evaluation and Classification Board of the - * Ministry of Culture and Tourism + * Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism */ ecbmctRating?: string; /** @@ -1604,28 +1415,23 @@ export namespace youtube_v3 { */ fcbmRating?: string; /** - * The video's rating from Hong Kong's Office for Film, Newspaper - * and Article Administration. + * The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. */ fcoRating?: string; /** - * This property has been deprecated. Use the - * contentDetails.contentRating.cncRating instead. + * This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. */ fmocRating?: string; /** - * The video's rating from South Africa's Film and Publication - * Board. + * The video's rating from South Africa's Film and Publication Board. */ fpbRating?: string; /** - * Reasons that explain why the video received its FPB (South Africa) - * rating. + * Reasons that explain why the video received its FPB (South Africa) rating. */ fpbRatingReasons?: string[]; /** - * The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - - * Germany) rating. + * The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. */ fskRating?: string; /** @@ -1633,13 +1439,11 @@ export namespace youtube_v3 { */ grfilmRating?: string; /** - * The video's Instituto de la Cinematografía y de las Artes - * Audiovisuales (ICAA - Spain) rating. + * The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. */ icaaRating?: string; /** - * The video's Irish Film Classification Office (IFCO - Ireland) rating. - * See the IFCO website for more information. + * The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. */ ifcoRating?: string; /** @@ -1647,8 +1451,7 @@ export namespace youtube_v3 { */ ilfilmRating?: string; /** - * The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - - * Argentina) rating. + * The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. */ incaaRating?: string; /** @@ -1660,8 +1463,7 @@ export namespace youtube_v3 { */ kijkwijzerRating?: string; /** - * The video's Korea Media Rating Board (영상물등급위원회) rating. The - * KMRB rates videos in South Korea. + * The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. */ kmrbRating?: string; /** @@ -1673,8 +1475,7 @@ export namespace youtube_v3 { */ mccaaRating?: string; /** - * The video's rating from the Danish Film Institute's (Det Danske - * Filminstitut) Media Council for Children and Young People. + * The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. */ mccypRating?: string; /** @@ -1682,8 +1483,7 @@ export namespace youtube_v3 { */ mcstRating?: string; /** - * The video's rating from Singapore's Media Development Authority - * (MDA) and, specifically, it's Board of Film Censors (BFC). + * The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). */ mdaRating?: string; /** @@ -1691,8 +1491,7 @@ export namespace youtube_v3 { */ medietilsynetRating?: string; /** - * The video's rating from Finland's Kansallinen Audiovisuaalinen - * Instituutti (National Audiovisual Institute). + * The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). */ mekuRating?: string; /** @@ -1700,8 +1499,7 @@ export namespace youtube_v3 { */ menaMpaaRating?: string; /** - * The video's rating from the Ministero dei Beni e delle Attività - * Culturali e del Turismo (Italy). + * The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). */ mibacRating?: string; /** @@ -1717,13 +1515,11 @@ export namespace youtube_v3 { */ mpaaRating?: string; /** - * The rating system for trailer, DVD, and Ad in the US. See - * http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. + * The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. */ mpaatRating?: string; /** - * The video's rating from the Movie and Television Review and - * Classification Board (Philippines). + * The video's rating from the Movie and Television Review and Classification Board (Philippines). */ mtrcbRating?: string; /** @@ -1731,8 +1527,7 @@ export namespace youtube_v3 { */ nbcplRating?: string; /** - * The video's rating from the Maldives National Bureau of - * Classification. + * The video's rating from the Maldives National Bureau of Classification. */ nbcRating?: string; /** @@ -1740,18 +1535,15 @@ export namespace youtube_v3 { */ nfrcRating?: string; /** - * The video's rating from Nigeria's National Film and Video Censors - * Board. + * The video's rating from Nigeria's National Film and Video Censors Board. */ nfvcbRating?: string; /** - * The video's rating from the Nacionãlais Kino centrs (National Film - * Centre of Latvia). + * The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). */ nkclvRating?: string; /** - * The video's Office of Film and Literature Classification (OFLC - New - * Zealand) rating. + * The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. */ oflcRating?: string; /** @@ -1759,8 +1551,7 @@ export namespace youtube_v3 { */ pefilmRating?: string; /** - * The video's rating from the Hungarian Nemzeti Filmiroda, the Rating - * Committee of the National Office of Film. + * The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film. */ rcnofRating?: string; /** @@ -1768,8 +1559,7 @@ export namespace youtube_v3 { */ resorteviolenciaRating?: string; /** - * The video's General Directorate of Radio, Television and - * Cinematography (Mexico) rating. + * The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. */ rtcRating?: string; /** @@ -1777,8 +1567,7 @@ export namespace youtube_v3 { */ rteRating?: string; /** - * The video's National Film Registry of the Russian Federation (MKRF - - * Russia) rating. + * The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. */ russiaRating?: string; /** @@ -1790,8 +1579,7 @@ export namespace youtube_v3 { */ smaisRating?: string; /** - * The video's rating from Statens medieråd (Sweden's National Media - * Council). + * The video's rating from Statens medieråd (Sweden's National Media Council). */ smsaRating?: string; /** @@ -1821,11 +1609,7 @@ export namespace youtube_v3 { longitude?: number; } /** - * A guideCategory resource identifies a category that YouTube algorithmically - * assigns based on a channel's content or other indicators, such as the - * channel's popularity. The list is similar to video categories, with the - * difference being that a video's uploader can assign a video category - * but only YouTube can assign a channel category. + * A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category. */ export interface Schema$GuideCategory { /** @@ -1837,13 +1621,11 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#guideCategory". + * Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategory". */ kind?: string; /** - * The snippet object contains basic details about the category, such as its - * title. + * The snippet object contains basic details about the category, such as its title. */ snippet?: Schema$GuideCategorySnippet; } @@ -1857,25 +1639,20 @@ export namespace youtube_v3 { */ eventId?: string; /** - * A list of categories that can be associated with YouTube channels. In - * this map, the category ID is the map key, and its value is the - * corresponding guideCategory resource. + * A list of categories that can be associated with YouTube channels. In this map, the category ID is the map key, and its value is the corresponding guideCategory resource. */ items?: Schema$GuideCategory[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#guideCategoryListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategoryListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -1895,8 +1672,7 @@ export namespace youtube_v3 { title?: string; } /** - * An i18nLanguage resource identifies a UI language currently supported by - * YouTube. + * An i18nLanguage resource identifies a UI language currently supported by YouTube. */ export interface Schema$I18nLanguage { /** @@ -1908,13 +1684,11 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#i18nLanguage". + * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguage". */ kind?: string; /** - * The snippet object contains basic details about the i18n language, such - * as language code and human-readable name. + * The snippet object contains basic details about the i18n language, such as language code and human-readable name. */ snippet?: Schema$I18nLanguageSnippet; } @@ -1928,13 +1702,11 @@ export namespace youtube_v3 { */ eventId?: string; /** - * A list of supported i18n languages. In this map, the i18n language ID is - * the map key, and its value is the corresponding i18nLanguage resource. + * A list of supported i18n languages. In this map, the i18n language ID is the map key, and its value is the corresponding i18nLanguage resource. */ items?: Schema$I18nLanguage[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#i18nLanguageListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguageListResponse". */ kind?: string; /** @@ -1943,8 +1715,7 @@ export namespace youtube_v3 { visitorId?: string; } /** - * Basic details about an i18n language, such as language code and - * human-readable name. + * Basic details about an i18n language, such as language code and human-readable name. */ export interface Schema$I18nLanguageSnippet { /** @@ -1969,13 +1740,11 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#i18nRegion". + * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegion". */ kind?: string; /** - * The snippet object contains basic details about the i18n region, such as - * region code and human-readable name. + * The snippet object contains basic details about the i18n region, such as region code and human-readable name. */ snippet?: Schema$I18nRegionSnippet; } @@ -1989,14 +1758,11 @@ export namespace youtube_v3 { */ eventId?: string; /** - * A list of regions where YouTube is available. In this map, the i18n - * region ID is the map key, and its value is the corresponding i18nRegion - * resource. + * A list of regions where YouTube is available. In this map, the i18n region ID is the map key, and its value is the corresponding i18nRegion resource. */ items?: Schema$I18nRegion[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#i18nRegionListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegionListResponse". */ kind?: string; /** @@ -2005,8 +1771,7 @@ export namespace youtube_v3 { visitorId?: string; } /** - * Basic details about an i18n region, such as region code and human-readable - * name. + * Basic details about an i18n region, such as region code and human-readable name. */ export interface Schema$I18nRegionSnippet { /** @@ -2023,13 +1788,11 @@ export namespace youtube_v3 { */ export interface Schema$ImageSettings { /** - * The URL for the background image shown on the video watch page. The image - * should be 1200px by 615px, with a maximum file size of 128k. + * The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k. */ backgroundImageUrl?: Schema$LocalizedProperty; /** - * This is used only in update requests; if it's set, we use this URL to - * generate all of the above banner URLs. + * This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs. */ bannerExternalUrl?: string; /** @@ -2093,8 +1856,7 @@ export namespace youtube_v3 { */ largeBrandedBannerImageImapScript?: Schema$LocalizedProperty; /** - * The URL for the 854px by 70px image that appears below the video player - * in the expanded video view of the video watch page. + * The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page. */ largeBrandedBannerImageUrl?: Schema$LocalizedProperty; /** @@ -2102,19 +1864,15 @@ export namespace youtube_v3 { */ smallBrandedBannerImageImapScript?: Schema$LocalizedProperty; /** - * The URL for the 640px by 70px banner image that appears below the video - * player in the default view of the video watch page. + * The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. */ smallBrandedBannerImageUrl?: Schema$LocalizedProperty; /** - * The URL for a 1px by 1px tracking pixel that can be used to collect - * statistics for views of the channel or video pages. + * The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages. */ trackingImageUrl?: string; /** - * The URL for the image that appears above the top-left corner of the video - * player. This is a 25-pixel-high image with a flexible width that cannot - * exceed 170 pixels. + * The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels. */ watchIconImageUrl?: string; } @@ -2123,17 +1881,11 @@ export namespace youtube_v3 { */ export interface Schema$IngestionInfo { /** - * The backup ingestion URL that you should use to stream video to YouTube. - * You have the option of simultaneously streaming the content that you are - * sending to the ingestionAddress to this URL. + * The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL. */ backupIngestionAddress?: string; /** - * The primary ingestion URL that you should use to stream video to YouTube. - * You must stream video to this URL. Depending on which application or - * tool you use to encode your video stream, you may need to enter the - * stream URL and stream name separately or you may need to concatenate them - * in the following format: STREAM_URL/STREAM_NAME + * The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format: STREAM_URL/STREAM_NAME */ ingestionAddress?: string; /** @@ -2149,8 +1901,7 @@ export namespace youtube_v3 { timing?: Schema$InvideoTiming; } /** - * Describes the spatial position of a visual widget inside a video. It is a - * union of various position types, out of which only will be set one. + * Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. */ export interface Schema$InvideoPosition { /** @@ -2163,13 +1914,11 @@ export namespace youtube_v3 { type?: string; } /** - * Describes an invideo promotion campaign consisting of multiple promoted - * items. A campaign belongs to a single channel_id. + * Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. */ export interface Schema$InvideoPromotion { /** - * The default temporal position within the video where the promoted item - * will be displayed. Can be overriden by more specific timing in the item. + * The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item. */ defaultTiming?: Schema$InvideoTiming; /** @@ -2177,16 +1926,11 @@ export namespace youtube_v3 { */ items?: Schema$PromotedItem[]; /** - * The spatial position within the video where the promoted item will be - * displayed. + * The spatial position within the video where the promoted item will be displayed. */ position?: Schema$InvideoPosition; /** - * Indicates whether the channel's promotional campaign uses "smart - * timing." This feature attempts to show promotions at a point in the - * video when they are more likely to be clicked and less likely to disrupt - * the viewing experience. This feature also picks up a single promotion to - * show on each video. + * Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video. */ useSmartTiming?: boolean; } @@ -2195,22 +1939,15 @@ export namespace youtube_v3 { */ export interface Schema$InvideoTiming { /** - * Defines the duration in milliseconds for which the promotion should be - * displayed. If missing, the client should use the default. + * Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default. */ durationMs?: string; /** - * Defines the time at which the promotion will appear. Depending on the - * value of type the value of the offsetMs field will represent a time - * offset from the start or from the end of the video, expressed in - * milliseconds. + * Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds. */ offsetMs?: string; /** - * Describes a timing type. If the value is offsetFromStart, then the - * offsetMs field represents an offset from the start of the video. If the - * value is offsetFromEnd, then the offsetMs field represents an offset from - * the end of the video. + * Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video. */ type?: string; } @@ -2218,15 +1955,11 @@ export namespace youtube_v3 { value?: string; } /** - * A liveBroadcast resource represents an event that will be streamed, via - * live video, on YouTube. + * A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube. */ export interface Schema$LiveBroadcast { /** - * The contentDetails object contains information about the event's - * video content, such as whether the content can be shown in an embedded - * video player or if it will be archived and therefore available for - * viewing after the event has concluded. + * The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. */ contentDetails?: Schema$LiveBroadcastContentDetails; /** @@ -2238,20 +1971,15 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveBroadcast". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast". */ kind?: string; /** - * The snippet object contains basic details about the event, including its - * title, description, start time, and end time. + * The snippet object contains basic details about the event, including its title, description, start time, and end time. */ snippet?: Schema$LiveBroadcastSnippet; /** - * The statistics object contains info about the event's current stats. - * These include concurrent viewers and total chat count. Statistics can - * change (in either direction) during the lifetime of an event. Statistics - * are only returned while the event is live. + * The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live. */ statistics?: Schema$LiveBroadcastStatistics; /** @@ -2268,8 +1996,7 @@ export namespace youtube_v3 { */ boundStreamId?: string; /** - * The date and time that the live stream referenced by boundStreamId was - * last updated. + * The date and time that the live stream referenced by boundStreamId was last updated. */ boundStreamLastUpdateTimeMs?: string; closedCaptionsType?: string; @@ -2278,33 +2005,19 @@ export namespace youtube_v3 { */ enableAutoStart?: boolean; /** - * This setting indicates whether HTTP POST closed captioning is enabled for - * this broadcast. The ingestion URL of the closed captions is returned - * through the liveStreams API. This is mutually exclusive with using the - * closed_captions_type property, and is equivalent to setting - * closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. + * This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. */ enableClosedCaptions?: boolean; /** - * This setting indicates whether YouTube should enable content encryption - * for the broadcast. + * This setting indicates whether YouTube should enable content encryption for the broadcast. */ enableContentEncryption?: boolean; /** - * This setting determines whether viewers can access DVR controls while - * watching the video. DVR controls enable the viewer to control the video - * playback experience by pausing, rewinding, or fast forwarding content. - * The default value for this property is true. Important: You must set - * the value to true and also set the enableArchive property's value to - * true if you want to make playback available immediately after the - * broadcast ends. + * This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends. */ enableDvr?: boolean; /** - * This setting indicates whether the broadcast video can be played in an - * embedded player. If you choose to archive the video (using the - * enableArchive property), this setting will also apply to the archived - * video. + * This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. */ enableEmbed?: boolean; /** @@ -2312,17 +2025,12 @@ export namespace youtube_v3 { */ enableLowLatency?: boolean; /** - * If both this and enable_low_latency are set, they must match. - * LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should - * match enable_low_latency=true LATENCY_ULTRA_LOW should have - * enable_low_latency omitted. + * If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted. */ latencyPreference?: string; mesh?: string; /** - * The monitorStream object contains information about the monitor stream, - * which the broadcaster can use to review the event content before the - * broadcast stream is shown publicly. + * The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly. */ monitorStream?: Schema$MonitorStreamInfo; /** @@ -2330,22 +2038,11 @@ export namespace youtube_v3 { */ projection?: string; /** - * Automatically start recording after the event goes live. The default - * value for this property is true. Important: You must also set the - * enableDvr property's value to true if you want the playback to be - * available immediately after the broadcast ends. If you set this - * property's value to true but do not also set the enableDvr property - * to true, there may be a delay of around one day before the archived video - * will be available for playback. + * Automatically start recording after the event goes live. The default value for this property is true. Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback. */ recordFromStart?: boolean; /** - * This setting indicates whether the broadcast should automatically begin - * with an in-stream slate when you update the broadcast's status to - * live. After updating the status, you then need to send a - * liveCuepoints.insert request that sets the cuepoint's eventState to - * end to remove the in-stream slate and make your broadcast stream visible - * to viewers. + * This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. */ startWithSlate?: boolean; stereoLayout?: string; @@ -2364,19 +2061,16 @@ export namespace youtube_v3 { */ items?: Schema$LiveBroadcast[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveBroadcastListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -2387,26 +2081,19 @@ export namespace youtube_v3 { } export interface Schema$LiveBroadcastSnippet { /** - * The date and time that the broadcast actually ended. This information is - * only available once the broadcast's state is complete. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ actualEndTime?: string; /** - * The date and time that the broadcast actually started. This information - * is only available once the broadcast's state is live. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ actualStartTime?: string; /** - * The ID that YouTube uses to uniquely identify the channel that is - * publishing the broadcast. + * The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast. */ channelId?: string; /** - * The broadcast's description. As with the title, you can set this - * field by modifying the broadcast resource or by setting the description - * field of the corresponding video resource. + * The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource. */ description?: string; isDefaultBroadcast?: boolean; @@ -2415,65 +2102,42 @@ export namespace youtube_v3 { */ liveChatId?: string; /** - * The date and time that the broadcast was added to YouTube's live - * broadcast schedule. The value is specified in ISO 8601 - * (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * The date and time that the broadcast is scheduled to end. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ scheduledEndTime?: string; /** - * The date and time that the broadcast is scheduled to start. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ scheduledStartTime?: string; /** - * A map of thumbnail images associated with the broadcast. For each nested - * object in this object, the key is the name of the thumbnail image, and - * the value is an object that contains other information about the - * thumbnail. + * A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** - * The broadcast's title. Note that the broadcast represents exactly one - * YouTube video. You can set this field by modifying the broadcast resource - * or by setting the title field of the corresponding video resource. + * The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource. */ title?: string; } /** - * Statistics about the live broadcast. These represent a snapshot of the - * values at the time of the request. Statistics are only returned for live - * broadcasts. + * Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. */ export interface Schema$LiveBroadcastStatistics { /** - * The number of viewers currently watching the broadcast. The property and - * its value will be present if the broadcast has current viewers and the - * broadcast owner has not hidden the viewcount for the video. Note that - * YouTube stops tracking the number of concurrent viewers for a broadcast - * when the broadcast ends. So, this property would not identify the number - * of viewers watching an archived video of a live broadcast that already - * ended. + * The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. */ concurrentViewers?: string; /** - * The total number of live chat messages currently on the broadcast. The - * property and its value will be present if the broadcast is public, has - * the live chat feature enabled, and has at least one message. Note that - * this field will not be filled after the broadcast ends. So this property - * would not identify the number of chat messages for an archived video of a - * completed live broadcast. + * The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. */ totalChatCount?: string; } export interface Schema$LiveBroadcastStatus { /** - * The broadcast's status. The status can be updated using the API's - * liveBroadcasts.transition method. + * The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method. */ lifeCycleStatus?: string; /** @@ -2481,11 +2145,7 @@ export namespace youtube_v3 { */ liveBroadcastPriority?: string; /** - * The broadcast's privacy status. Note that the broadcast represents - * exactly one YouTube video, so the privacy settings are identical to those - * supported for videos. In addition, you can set this field by modifying - * the broadcast resource or by setting the privacyStatus field of the - * corresponding video resource. + * The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource. */ privacyStatus?: string; /** @@ -2506,8 +2166,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveChatBan". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan". */ kind?: string; /** @@ -2549,13 +2208,11 @@ export namespace youtube_v3 { userComment?: string; } /** - * A liveChatMessage resource represents a chat message in a YouTube Live - * Chat. + * A liveChatMessage resource represents a chat message in a YouTube Live Chat. */ export interface Schema$LiveChatMessage { /** - * The authorDetails object contains basic details about the user that - * posted this message. + * The authorDetails object contains basic details about the user that posted this message. */ authorDetails?: Schema$LiveChatMessageAuthorDetails; /** @@ -2567,8 +2224,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveChatMessage". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". */ kind?: string; /** @@ -2627,18 +2283,15 @@ export namespace youtube_v3 { */ items?: Schema$LiveChatMessage[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveChatMessageListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; /** - * The date and time when the underlying stream went offline. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when the underlying stream went offline. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ offlineAt?: string; pageInfo?: Schema$PageInfo; @@ -2657,29 +2310,19 @@ export namespace youtube_v3 { } export interface Schema$LiveChatMessageSnippet { /** - * The ID of the user that authored this message, this field is not always - * filled. textMessageEvent - the user that wrote the message - * fanFundingEvent - the user that funded the broadcast newSponsorEvent - - * the user that just became a sponsor messageDeletedEvent - the moderator - * that took the action messageRetractedEvent - the author that retracted - * their message userBannedEvent - the moderator that took the action - * superChatEvent - the user that made the purchase + * The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase */ authorChannelId?: string; /** - * Contains a string that can be displayed to the user. If this field is not - * present the message is silent, at the moment only messages of type - * TOMBSTONE and CHAT_ENDED_EVENT are silent. + * Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. */ displayMessage?: string; /** - * Details about the funding event, this is only set if the type is - * 'fanFundingEvent'. + * Details about the funding event, this is only set if the type is 'fanFundingEvent'. */ fanFundingEventDetails?: Schema$LiveChatFanFundingEventDetails; /** - * Whether the message has display content that should be displayed to - * users. + * Whether the message has display content that should be displayed to users. */ hasDisplayContent?: boolean; liveChatId?: string; @@ -2690,36 +2333,29 @@ export namespace youtube_v3 { pollOpenedDetails?: Schema$LiveChatPollOpenedDetails; pollVotedDetails?: Schema$LiveChatPollVotedDetails; /** - * The date and time when the message was orignally published. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * Details about the Super Chat event, this is only set if the type is - * 'superChatEvent'. + * Details about the Super Chat event, this is only set if the type is 'superChatEvent'. */ superChatDetails?: Schema$LiveChatSuperChatDetails; /** - * Details about the Super Sticker event, this is only set if the type is - * 'superStickerEvent'. + * Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'. */ superStickerDetails?: Schema$LiveChatSuperStickerDetails; /** - * Details about the text message, this is only set if the type is - * 'textMessageEvent'. + * Details about the text message, this is only set if the type is 'textMessageEvent'. */ textMessageDetails?: Schema$LiveChatTextMessageDetails; /** - * The type of message, this will always be present, it determines the - * contents of the message as well as which fields will be present. + * The type of message, this will always be present, it determines the contents of the message as well as which fields will be present. */ type?: string; userBannedDetails?: Schema$LiveChatUserBannedMessageDetails; } /** - * A liveChatModerator resource represents a moderator for a YouTube live - * chat. A chat moderator has the ability to ban/unban users from a chat, - * remove message, etc. + * A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc. */ export interface Schema$LiveChatModerator { /** @@ -2731,8 +2367,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveChatModerator". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator". */ kind?: string; /** @@ -2754,19 +2389,16 @@ export namespace youtube_v3 { */ items?: Schema$LiveChatModerator[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveChatModeratorListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -2832,8 +2464,7 @@ export namespace youtube_v3 { */ currency?: string; /** - * The tier in which the amount belongs. Lower amounts belong to lower - * tiers. The lowest tier is 1. + * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. */ tier?: number; /** @@ -2859,8 +2490,7 @@ export namespace youtube_v3 { */ superStickerMetadata?: Schema$SuperStickerMetadata; /** - * The tier in which the amount belongs. Lower amounts belong to lower - * tiers. The lowest tier is 1. + * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1. */ tier?: number; } @@ -2872,8 +2502,7 @@ export namespace youtube_v3 { } export interface Schema$LiveChatUserBannedMessageDetails { /** - * The duration of the ban. This property is only present if the banType is - * temporary. + * The duration of the ban. This property is only present if the banType is temporary. */ banDurationSeconds?: string; /** @@ -2890,14 +2519,11 @@ export namespace youtube_v3 { */ export interface Schema$LiveStream { /** - * The cdn object defines the live stream's content delivery network - * (CDN) settings. These settings provide details about the manner in which - * you stream your content to YouTube. + * The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube. */ cdn?: Schema$CdnSettings; /** - * The content_details object contains information about the stream, - * including the closed captions ingestion URL. + * The content_details object contains information about the stream, including the closed captions ingestion URL. */ contentDetails?: Schema$LiveStreamContentDetails; /** @@ -2909,13 +2535,11 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveStream". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream". */ kind?: string; /** - * The snippet object contains basic details about the stream, including its - * channel, title, and description. + * The snippet object contains basic details about the stream, including its channel, title, and description. */ snippet?: Schema$LiveStreamSnippet; /** @@ -2950,18 +2574,7 @@ export namespace youtube_v3 { */ closedCaptionsIngestionUrl?: string; /** - * Indicates whether the stream is reusable, which means that it can be - * bound to multiple broadcasts. It is common for broadcasters to reuse the - * same stream for many different broadcasts if those broadcasts occur at - * different times. If you set this value to false, then the stream will - * not be reusable, which means that it can only be bound to one broadcast. - * Non-reusable streams differ from reusable streams in the following ways: - * - A non-reusable stream can only be bound to one broadcast. - A - * non-reusable stream might be deleted by an automated process after the - * broadcast ends. - The liveStreams.list method does not list - * non-reusable streams if you call the method and set the mine parameter to - * true. The only way to use that method to retrieve the resource for a - * non-reusable stream is to use the id parameter to identify the stream. + * Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times. If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream. */ isReusable?: boolean; } @@ -2993,19 +2606,16 @@ export namespace youtube_v3 { */ items?: Schema$LiveStream[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#liveStreamListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -3016,24 +2626,20 @@ export namespace youtube_v3 { } export interface Schema$LiveStreamSnippet { /** - * The ID that YouTube uses to uniquely identify the channel that is - * transmitting the stream. + * The ID that YouTube uses to uniquely identify the channel that is transmitting the stream. */ channelId?: string; /** - * The stream's description. The value cannot be longer than 10000 - * characters. + * The stream's description. The value cannot be longer than 10000 characters. */ description?: string; isDefaultStream?: boolean; /** - * The date and time that the stream was created. The value is specified in - * ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * The stream's title. The value must be between 1 and 128 characters - * long. + * The stream's title. The value must be between 1 and 128 characters long. */ title?: string; } @@ -3064,8 +2670,7 @@ export namespace youtube_v3 { */ export interface Schema$MonitorStreamInfo { /** - * If you have set the enableMonitorStream property to true, then this - * property determines the length of the live broadcast delay. + * If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay. */ broadcastStreamDelayMs?: number; /** @@ -3073,14 +2678,7 @@ export namespace youtube_v3 { */ embedHtml?: string; /** - * This value determines whether the monitor stream is enabled for the - * broadcast. If the monitor stream is enabled, then YouTube will broadcast - * the event content on a special stream intended only for the - * broadcaster's consumption. The broadcaster can use the stream to - * review the event content and also to identify the optimal times to insert - * cuepoints. You need to set this value to true if you intend to have a - * broadcast delay for your event. Note: This property cannot be updated - * once the broadcast is in the testing or live state. + * This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. Note: This property cannot be updated once the broadcast is in the testing or live state. */ enableMonitorStream?: boolean; } @@ -3101,8 +2699,7 @@ export namespace youtube_v3 { value?: string; } /** - * Paging details for lists of resources, including total number of items - * available and number of resources returned in a single page. + * Paging details for lists of resources, including total number of items available and number of resources returned in a single page. */ export interface Schema$PageInfo { /** @@ -3115,21 +2712,7 @@ export namespace youtube_v3 { totalResults?: number; } /** - * A playlist resource represents a YouTube playlist. A playlist is a - * collection of videos that can be viewed sequentially and shared with other - * users. A playlist can contain up to 200 videos, and YouTube does not limit - * the number of playlists that each user creates. By default, playlists are - * publicly visible to other users, but playlists can be public or private. - * YouTube also uses playlists to identify special collections of videos for a - * channel, such as: - uploaded videos - favorite videos - positively - * rated (liked) videos - watch history - watch later To be more specific, - * these lists are associated with a channel, which is a collection of a - * person, group, or company's videos, playlists, and other YouTube - * information. You can retrieve the playlist IDs for each of these lists from - * the channel resource for a given channel. You can then use the - * playlistItems.list method to retrieve any of those lists. You can also add - * or remove items from those lists by calling the playlistItems.insert and - * playlistItems.delete methods. + * A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private. YouTube also uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. */ export interface Schema$Playlist { /** @@ -3145,8 +2728,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#playlist". + * Identifies what kind of resource this is. Value: the fixed string "youtube#playlist". */ kind?: string; /** @@ -3154,13 +2736,11 @@ export namespace youtube_v3 { */ localizations?: {[key: string]: Schema$PlaylistLocalization}; /** - * The player object contains information that you would use to play the - * playlist in an embedded player. + * The player object contains information that you would use to play the playlist in an embedded player. */ player?: Schema$PlaylistPlayer; /** - * The snippet object contains basic details about the playlist, such as its - * title and description. + * The snippet object contains basic details about the playlist, such as its title and description. */ snippet?: Schema$PlaylistSnippet; /** @@ -3175,27 +2755,11 @@ export namespace youtube_v3 { itemCount?: number; } /** - * A playlistItem resource identifies another resource, such as a video, that - * is included in a playlist. In addition, the playlistItem resource contains - * details about the included resource that pertain specifically to how that - * resource is used in that playlist. YouTube uses playlists to identify - * special collections of videos for a channel, such as: - uploaded videos - * - favorite videos - positively rated (liked) videos - watch history - - * watch later To be more specific, these lists are associated with a - * channel, which is a collection of a person, group, or company's videos, - * playlists, and other YouTube information. You can retrieve the playlist - * IDs for each of these lists from the channel resource for a given - * channel. You can then use the playlistItems.list method to retrieve any - * of those lists. You can also add or remove items from those lists by - * calling the playlistItems.insert and playlistItems.delete methods. For - * example, if a user gives a positive rating to a video, you would insert - * that video into the liked videos playlist for that user's channel. + * A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel. */ export interface Schema$PlaylistItem { /** - * The contentDetails object is included in the resource if the included - * item is a YouTube video. The object contains additional information about - * the video. + * The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video. */ contentDetails?: Schema$PlaylistItemContentDetails; /** @@ -3207,28 +2771,21 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#playlistItem". + * Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem". */ kind?: string; /** - * The snippet object contains basic details about the playlist item, such - * as its title and position in the playlist. + * The snippet object contains basic details about the playlist item, such as its title and position in the playlist. */ snippet?: Schema$PlaylistItemSnippet; /** - * The status object contains information about the playlist item's - * privacy status. + * The status object contains information about the playlist item's privacy status. */ status?: Schema$PlaylistItemStatus; } export interface Schema$PlaylistItemContentDetails { /** - * The time, measured in seconds from the start of the video, when the video - * should stop playing. (The playlist owner can specify the times when the - * video should start and stop playing when the video is played in the - * context of the playlist.) By default, assume that the video.endTime is - * the end of the video. + * The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video. */ endAt?: string; /** @@ -3236,21 +2793,15 @@ export namespace youtube_v3 { */ note?: string; /** - * The time, measured in seconds from the start of the video, when the video - * should start playing. (The playlist owner can specify the times when the - * video should start and stop playing when the video is played in the - * context of the playlist.) The default value is 0. + * The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0. */ startAt?: string; /** - * The ID that YouTube uses to uniquely identify a video. To retrieve the - * video resource, set the id query parameter to this value in your API - * request. + * The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request. */ videoId?: string; /** - * The date and time that the video was published to YouTube. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ videoPublishedAt?: string; } @@ -3268,19 +2819,16 @@ export namespace youtube_v3 { */ items?: Schema$PlaylistItem[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#playlistItemListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItemListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -3290,13 +2838,11 @@ export namespace youtube_v3 { visitorId?: string; } /** - * Basic details about a playlist, including title, description and - * thumbnails. + * Basic details about a playlist, including title, description and thumbnails. */ export interface Schema$PlaylistItemSnippet { /** - * The ID that YouTube uses to uniquely identify the user that added the - * item to the playlist. + * The ID that YouTube uses to uniquely identify the user that added the item to the playlist. */ channelId?: string; /** @@ -3308,30 +2854,23 @@ export namespace youtube_v3 { */ description?: string; /** - * The ID that YouTube uses to uniquely identify the playlist that the - * playlist item is in. + * The ID that YouTube uses to uniquely identify the playlist that the playlist item is in. */ playlistId?: string; /** - * The order in which the item appears in the playlist. The value uses a - * zero-based index, so the first item has a position of 0, the second item - * has a position of 1, and so forth. + * The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth. */ position?: number; /** - * The date and time that the item was added to the playlist. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * The id object contains information that can be used to uniquely identify - * the resource that is included in the playlist as the playlist item. + * The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item. */ resourceId?: Schema$ResourceId; /** - * A map of thumbnail images associated with the playlist item. For each - * object in the map, the key is the name of the thumbnail image, and the - * value is an object that contains other information about the thumbnail. + * A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -3362,19 +2901,16 @@ export namespace youtube_v3 { */ items?: Schema$Playlist[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#playlistListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#playlistListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -3403,13 +2939,11 @@ export namespace youtube_v3 { embedHtml?: string; } /** - * Basic details about a playlist, including title, description and - * thumbnails. + * Basic details about a playlist, including title, description and thumbnails. */ export interface Schema$PlaylistSnippet { /** - * The ID that YouTube uses to uniquely identify the channel that published - * the playlist. + * The ID that YouTube uses to uniquely identify the channel that published the playlist. */ channelId?: string; /** @@ -3429,8 +2963,7 @@ export namespace youtube_v3 { */ localized?: Schema$PlaylistLocalization; /** - * The date and time that the playlist was created. The value is specified - * in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** @@ -3438,9 +2971,7 @@ export namespace youtube_v3 { */ tags?: string[]; /** - * A map of thumbnail images associated with the playlist. For each object - * in the map, the key is the name of the thumbnail image, and the value is - * an object that contains other information about the thumbnail. + * A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -3459,8 +2990,7 @@ export namespace youtube_v3 { */ export interface Schema$PromotedItem { /** - * A custom message to display for this promotion. This field is currently - * ignored unless the promoted item is a website. + * A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website. */ customMessage?: string; /** @@ -3468,26 +2998,20 @@ export namespace youtube_v3 { */ id?: Schema$PromotedItemId; /** - * If true, the content owner's name will be used when displaying the - * promotion. This field can only be set when the update is made on behalf - * of the content owner. + * If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner. */ promotedByContentOwner?: boolean; /** - * The temporal position within the video where the promoted item will be - * displayed. If present, it overrides the default timing. + * The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing. */ timing?: Schema$InvideoTiming; } /** - * Describes a single promoted item id. It is a union of various possible - * types. + * Describes a single promoted item id. It is a union of various possible types. */ export interface Schema$PromotedItemId { /** - * If type is recentUpload, this field identifies the channel from which to - * take the recent upload. If missing, the channel is assumed to be the same - * channel for which the invideoPromotion is set. + * If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set. */ recentlyUploadedBy?: string; /** @@ -3495,15 +3019,11 @@ export namespace youtube_v3 { */ type?: string; /** - * If the promoted item represents a video, this field represents the unique - * YouTube ID identifying it. This field will be present only if type has - * the value video. + * If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video. */ videoId?: string; /** - * If the promoted item represents a website, this field represents the url - * pointing to the website. This field will be present only if type has the - * value website. + * If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website. */ websiteUrl?: string; } @@ -3521,14 +3041,11 @@ export namespace youtube_v3 { value?: string; } /** - * A resource id is a generic reference that points to another YouTube - * resource. + * A resource id is a generic reference that points to another YouTube resource. */ export interface Schema$ResourceId { /** - * The ID that YouTube uses to uniquely identify the referred resource, if - * that resource is a channel. This property is only present if the - * resourceId.kind value is youtube#channel. + * The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel. */ channelId?: string; /** @@ -3536,15 +3053,11 @@ export namespace youtube_v3 { */ kind?: string; /** - * The ID that YouTube uses to uniquely identify the referred resource, if - * that resource is a playlist. This property is only present if the - * resourceId.kind value is youtube#playlist. + * The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist. */ playlistId?: string; /** - * The ID that YouTube uses to uniquely identify the referred resource, if - * that resource is a video. This property is only present if the - * resourceId.kind value is youtube#video. + * The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video. */ videoId?: string; } @@ -3562,19 +3075,16 @@ export namespace youtube_v3 { */ items?: Schema$SearchResult[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#searchListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; regionCode?: string; @@ -3585,10 +3095,7 @@ export namespace youtube_v3 { visitorId?: string; } /** - * A search result contains information about a YouTube video, channel, or - * playlist that matches the search parameters specified in an API request. - * While a search result points to a uniquely identifiable resource, like a - * video, it does not have its own persistent data. + * A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data. */ export interface Schema$SearchResult { /** @@ -3596,36 +3103,28 @@ export namespace youtube_v3 { */ etag?: string; /** - * The id object contains information that can be used to uniquely identify - * the resource that matches the search request. + * The id object contains information that can be used to uniquely identify the resource that matches the search request. */ id?: Schema$ResourceId; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#searchResult". + * Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult". */ kind?: string; /** - * The snippet object contains basic details about a search result, such as - * its title or description. For example, if the search result is a video, - * then the title will be the video's title and the description will be - * the video's description. + * The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description. */ snippet?: Schema$SearchResultSnippet; } /** - * Basic details about a search result, including title, description and - * thumbnails of the item referenced by the search result. + * Basic details about a search result, including title, description and thumbnails of the item referenced by the search result. */ export interface Schema$SearchResultSnippet { /** - * The value that YouTube uses to uniquely identify the channel that - * published the resource that the search result identifies. + * The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies. */ channelId?: string; /** - * The title of the channel that published the resource that the search - * result identifies. + * The title of the channel that published the resource that the search result identifies. */ channelTitle?: string; /** @@ -3633,21 +3132,15 @@ export namespace youtube_v3 { */ description?: string; /** - * It indicates if the resource (video or channel) has upcoming/active live - * broadcast content. Or it's "none" if there is not any - * upcoming/active live broadcasts. + * It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts. */ liveBroadcastContent?: string; /** - * The creation date and time of the resource that the search result - * identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) - * format. + * The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * A map of thumbnail images associated with the search result. For each - * object in the map, the key is the name of the thumbnail image, and the - * value is an object that contains other information about the thumbnail. + * A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -3656,9 +3149,7 @@ export namespace youtube_v3 { title?: string; } /** - * A sponsor resource represents a sponsor for a YouTube channel. A sponsor - * provides recurring monetary support to a creator and receives special - * benefits. + * A sponsor resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits. */ export interface Schema$Sponsor { /** @@ -3666,8 +3157,7 @@ export namespace youtube_v3 { */ etag?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#sponsor". + * Identifies what kind of resource this is. Value: the fixed string "youtube#sponsor". */ kind?: string; /** @@ -3689,13 +3179,11 @@ export namespace youtube_v3 { */ items?: Schema$Sponsor[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#sponsorListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#sponsorListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; @@ -3719,21 +3207,16 @@ export namespace youtube_v3 { */ sponsorDetails?: Schema$ChannelProfileDetails; /** - * The date and time when the user became a sponsor. The value is specified - * in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when the user became a sponsor. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ sponsorSince?: string; } /** - * A subscription resource contains information about a YouTube user - * subscription. A subscription notifies a user when new videos are added to a - * channel or when another user takes one of several actions on YouTube, such - * as uploading a video, rating a video, or commenting on a video. + * A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video. */ export interface Schema$Subscription { /** - * The contentDetails object contains basic statistics about the - * subscription. + * The contentDetails object contains basic statistics about the subscription. */ contentDetails?: Schema$SubscriptionContentDetails; /** @@ -3745,13 +3228,11 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#subscription". + * Identifies what kind of resource this is. Value: the fixed string "youtube#subscription". */ kind?: string; /** - * The snippet object contains basic details about the subscription, - * including its title and the channel that the user subscribed to. + * The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to. */ snippet?: Schema$SubscriptionSnippet; /** @@ -3768,8 +3249,7 @@ export namespace youtube_v3 { */ activityType?: string; /** - * The number of new items in the subscription since its content was last - * read. + * The number of new items in the subscription since its content was last read. */ newItemCount?: number; /** @@ -3791,19 +3271,16 @@ export namespace youtube_v3 { */ items?: Schema$Subscription[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#subscriptionListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -3813,13 +3290,11 @@ export namespace youtube_v3 { visitorId?: string; } /** - * Basic details about a subscription, including title, description and - * thumbnails of the subscribed item. + * Basic details about a subscription, including title, description and thumbnails of the subscribed item. */ export interface Schema$SubscriptionSnippet { /** - * The ID that YouTube uses to uniquely identify the subscriber's - * channel. + * The ID that YouTube uses to uniquely identify the subscriber's channel. */ channelId?: string; /** @@ -3831,19 +3306,15 @@ export namespace youtube_v3 { */ description?: string; /** - * The date and time that the subscription was created. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * The id object contains information about the channel that the user - * subscribed to. + * The id object contains information about the channel that the user subscribed to. */ resourceId?: Schema$ResourceId; /** - * A map of thumbnail images associated with the video. For each object in - * the map, the key is the name of the thumbnail image, and the value is an - * object that contains other information about the thumbnail. + * A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -3852,8 +3323,7 @@ export namespace youtube_v3 { title?: string; } /** - * Basic details about a subscription's subscriber including title, - * description, channel ID and thumbnails. + * Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. */ export interface Schema$SubscriptionSubscriberSnippet { /** @@ -3874,8 +3344,7 @@ export namespace youtube_v3 { title?: string; } /** - * A superChatEvent resource represents a Super Chat purchase on a YouTube - * channel. + * A superChatEvent resource represents a Super Chat purchase on a YouTube channel. */ export interface Schema$SuperChatEvent { /** @@ -3887,8 +3356,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#superChatEvent". + * Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEvent". */ kind?: string; /** @@ -3910,13 +3378,11 @@ export namespace youtube_v3 { */ items?: Schema$SuperChatEvent[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#superChatEventListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEventListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; @@ -3928,8 +3394,7 @@ export namespace youtube_v3 { } export interface Schema$SuperChatEventSnippet { /** - * The purchase amount, in micros of the purchase currency. e.g., 1 is - * represented as 1000000. + * The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000. */ amountMicros?: string; /** @@ -3941,8 +3406,7 @@ export namespace youtube_v3 { */ commentText?: string; /** - * The date and time when the event occurred. The value is specified in ISO - * 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when the event occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ createdAt?: string; /** @@ -3950,8 +3414,7 @@ export namespace youtube_v3 { */ currency?: string; /** - * A rendered string that displays the purchase amount and currency (e.g., - * "$1.00"). The string is rendered for the given language. + * A rendered string that displays the purchase amount and currency (e.g., "$1.00"). The string is rendered for the given language. */ displayString?: string; /** @@ -3963,18 +3426,15 @@ export namespace youtube_v3 { */ isSuperStickerEvent?: boolean; /** - * The tier for the paid message, which is based on the amount of money - * spent to purchase the message. + * The tier for the paid message, which is based on the amount of money spent to purchase the message. */ messageType?: number; /** - * If this event is a Super Chat for Good purchase, this field will contain - * information about the charity the purchase is donated to. + * If this event is a Super Chat for Good purchase, this field will contain information about the charity the purchase is donated to. */ nonprofit?: Schema$Nonprofit; /** - * If this event is a Super Sticker event, this field will contain metadata - * about the Super Sticker. + * If this event is a Super Sticker event, this field will contain metadata about the Super Sticker. */ superStickerMetadata?: Schema$SuperStickerMetadata; /** @@ -3984,8 +3444,7 @@ export namespace youtube_v3 { } export interface Schema$SuperStickerMetadata { /** - * Internationalized alt text that describes the sticker image and any - * animation associated with it. + * Internationalized alt text that describes the sticker image and any animation associated with it. */ altText?: string; /** @@ -3993,9 +3452,7 @@ export namespace youtube_v3 { */ altTextLanguage?: string; /** - * Unique identifier of the Super Sticker. This is a shorter form of the - * alt_text that includes pack name and a recognizable characteristic of the - * sticker. + * Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker. */ stickerId?: string; } @@ -4055,8 +3512,7 @@ export namespace youtube_v3 { */ items?: Schema$ThumbnailDetails[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#thumbnailSetResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#thumbnailSetResponse". */ kind?: string; /** @@ -4073,13 +3529,11 @@ export namespace youtube_v3 { */ export interface Schema$Video { /** - * Age restriction details related to a video. This data can only be - * retrieved by the video owner. + * Age restriction details related to a video. This data can only be retrieved by the video owner. */ ageGating?: Schema$VideoAgeGating; /** - * The contentDetails object contains information about the video content, - * including the length of the video and its aspect ratio. + * The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. */ contentDetails?: Schema$VideoContentDetails; /** @@ -4087,10 +3541,7 @@ export namespace youtube_v3 { */ etag?: string; /** - * The fileDetails object encapsulates information about the video file that - * was uploaded to YouTube, including the file's resolution, duration, - * audio and video codecs, stream bitrates, and more. This data can only be - * retrieved by the video owner. + * The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner. */ fileDetails?: Schema$VideoFileDetails; /** @@ -4098,14 +3549,11 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#video". + * Identifies what kind of resource this is. Value: the fixed string "youtube#video". */ kind?: string; /** - * The liveStreamingDetails object contains metadata about a live video - * broadcast. The object will only be present in a video resource if the - * video is an upcoming, live, or completed live broadcast. + * The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. */ liveStreamingDetails?: Schema$VideoLiveStreamingDetails; /** @@ -4113,40 +3561,27 @@ export namespace youtube_v3 { */ localizations?: {[key: string]: Schema$VideoLocalization}; /** - * The monetizationDetails object encapsulates information about the - * monetization status of the video. + * The monetizationDetails object encapsulates information about the monetization status of the video. */ monetizationDetails?: Schema$VideoMonetizationDetails; /** - * The player object contains information that you would use to play the - * video in an embedded player. + * The player object contains information that you would use to play the video in an embedded player. */ player?: Schema$VideoPlayer; /** - * The processingDetails object encapsulates information about YouTube's - * progress in processing the uploaded video file. The properties in the - * object identify the current processing status and an estimate of the time - * remaining until YouTube finishes processing the video. This part also - * indicates whether different types of data or content, such as file - * details or thumbnail images, are available for the video. The - * processingProgress object is designed to be polled so that the video - * uploaded can track the progress that YouTube has made in processing the - * uploaded video file. This data can only be retrieved by the video owner. + * The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner. */ processingDetails?: Schema$VideoProcessingDetails; /** - * The projectDetails object contains information about the project specific - * video metadata. + * The projectDetails object contains information about the project specific video metadata. */ projectDetails?: Schema$VideoProjectDetails; /** - * The recordingDetails object encapsulates information about the location, - * date and address where the video was recorded. + * The recordingDetails object encapsulates information about the location, date and address where the video was recorded. */ recordingDetails?: Schema$VideoRecordingDetails; /** - * The snippet object contains basic details about the video, such as its - * title, description, and category. + * The snippet object contains basic details about the video, such as its title, description, and category. */ snippet?: Schema$VideoSnippet; /** @@ -4154,19 +3589,15 @@ export namespace youtube_v3 { */ statistics?: Schema$VideoStatistics; /** - * The status object contains information about the video's uploading, - * processing, and privacy statuses. + * The status object contains information about the video's uploading, processing, and privacy statuses. */ status?: Schema$VideoStatus; /** - * The suggestions object encapsulates suggestions that identify - * opportunities to improve the video quality or the metadata for the - * uploaded video. This data can only be retrieved by the video owner. + * The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner. */ suggestions?: Schema$VideoSuggestions; /** - * The topicDetails object encapsulates information about Freebase topics - * associated with the video. + * The topicDetails object encapsulates information about Freebase topics associated with the video. */ topicDetails?: Schema$VideoTopicDetails; } @@ -4180,14 +3611,11 @@ export namespace youtube_v3 { */ language?: string; /** - * The high-level, or primary, reason that the content is abusive. The value - * is an abuse report reason ID. + * The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID. */ reasonId?: string; /** - * The specific, or secondary, reason that this content is abusive (if - * available). The value is an abuse report reason ID that is a valid - * secondary reason for the primary reason. + * The specific, or secondary, reason that this content is abusive (if available). The value is an abuse report reason ID that is a valid secondary reason for the primary reason. */ secondaryReasonId?: string; /** @@ -4196,9 +3624,7 @@ export namespace youtube_v3 { videoId?: string; } /** - * A videoAbuseReportReason resource identifies a reason that a video could be - * reported as abusive. Video abuse report reasons are used with - * video.ReportAbuse. + * A videoAbuseReportReason resource identifies a reason that a video could be reported as abusive. Video abuse report reasons are used with video.ReportAbuse. */ export interface Schema$VideoAbuseReportReason { /** @@ -4210,8 +3636,7 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#videoAbuseReportReason". + * Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReason". */ kind?: string; /** @@ -4233,8 +3658,7 @@ export namespace youtube_v3 { */ items?: Schema$VideoAbuseReportReason[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#videoAbuseReportReasonListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReasonListResponse". */ kind?: string; /** @@ -4251,8 +3675,7 @@ export namespace youtube_v3 { */ label?: string; /** - * The secondary reasons associated with this reason, if any are available. - * (There might be 0 or more.) + * The secondary reasons associated with this reason, if any are available. (There might be 0 or more.) */ secondaryReasons?: Schema$VideoAbuseReportSecondaryReason[]; } @@ -4268,16 +3691,11 @@ export namespace youtube_v3 { } export interface Schema$VideoAgeGating { /** - * Indicates whether or not the video has alcoholic beverage content. Only - * users of legal purchasing age in a particular country, as identified by - * ICAP, can view the content. + * Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. */ alcoholContent?: boolean; /** - * Age-restricted trailers. For redband trailers and adult-rated - * video-games. Only users aged 18+ can view the content. The the field is - * true the content is restricted to viewers aged 18+. Otherwise The field - * won't be present. + * Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. */ restricted?: boolean; /** @@ -4286,8 +3704,7 @@ export namespace youtube_v3 { videoGameRating?: string; } /** - * A videoCategory resource identifies a category that has been or could be - * associated with uploaded videos. + * A videoCategory resource identifies a category that has been or could be associated with uploaded videos. */ export interface Schema$VideoCategory { /** @@ -4299,13 +3716,11 @@ export namespace youtube_v3 { */ id?: string; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#videoCategory". + * Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategory". */ kind?: string; /** - * The snippet object contains basic details about the video category, - * including its title. + * The snippet object contains basic details about the video category, including its title. */ snippet?: Schema$VideoCategorySnippet; } @@ -4319,25 +3734,20 @@ export namespace youtube_v3 { */ eventId?: string; /** - * A list of video categories that can be associated with YouTube videos. In - * this map, the video category ID is the map key, and its value is the - * corresponding videoCategory resource. + * A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding videoCategory resource. */ items?: Schema$VideoCategory[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#videoCategoryListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategoryListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -4369,43 +3779,31 @@ export namespace youtube_v3 { */ caption?: string; /** - * Specifies the ratings that the video received under various rating - * schemes. + * Specifies the ratings that the video received under various rating schemes. */ contentRating?: Schema$ContentRating; /** - * The countryRestriction object contains information about the countries - * where a video is (or is not) viewable. + * The countryRestriction object contains information about the countries where a video is (or is not) viewable. */ countryRestriction?: Schema$AccessPolicy; /** - * The value of definition indicates whether the video is available in high - * definition or only in standard definition. + * The value of definition indicates whether the video is available in high definition or only in standard definition. */ definition?: string; /** - * The value of dimension indicates whether the video is available in 3D or - * in 2D. + * The value of dimension indicates whether the video is available in 3D or in 2D. */ dimension?: string; /** - * The length of the video. The tag value is an ISO 8601 duration in the - * format PT#M#S, in which the letters PT indicate that the value specifies - * a period of time, and the letters M and S refer to length in minutes and - * seconds, respectively. The # characters preceding the M and S letters are - * both integers that specify the number of minutes (or seconds) of the - * video. For example, a value of PT15M51S indicates that the video is 15 - * minutes and 51 seconds long. + * The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long. */ duration?: string; /** - * Indicates whether the video uploader has provided a custom thumbnail - * image for the video. This property is only visible to the video uploader. + * Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. */ hasCustomThumbnail?: boolean; /** - * The value of is_license_content indicates whether the video is licensed - * content. + * The value of is_license_content indicates whether the video is licensed content. */ licensedContent?: boolean; /** @@ -4413,10 +3811,7 @@ export namespace youtube_v3 { */ projection?: string; /** - * The regionRestriction object contains information about the countries - * where a video is (or is not) viewable. The object will contain either the - * contentDetails.regionRestriction.allowed property or the - * contentDetails.regionRestriction.blocked property. + * The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property. */ regionRestriction?: Schema$VideoContentDetailsRegionRestriction; } @@ -4425,36 +3820,24 @@ export namespace youtube_v3 { */ export interface Schema$VideoContentDetailsRegionRestriction { /** - * A list of region codes that identify countries where the video is - * viewable. If this property is present and a country is not listed in its - * value, then the video is blocked from appearing in that country. If this - * property is present and contains an empty list, the video is blocked in - * all countries. + * A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries. */ allowed?: string[]; /** - * A list of region codes that identify countries where the video is - * blocked. If this property is present and a country is not listed in its - * value, then the video is viewable in that country. If this property is - * present and contains an empty list, the video is viewable in all - * countries. + * A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries. */ blocked?: string[]; } /** - * Describes original video file properties, including technical details about - * audio and video streams, but also metadata information like content length, - * digitization time, or geotagging information. + * Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. */ export interface Schema$VideoFileDetails { /** - * A list of audio streams contained in the uploaded video file. Each item - * in the list contains detailed metadata about an audio stream. + * A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. */ audioStreams?: Schema$VideoFileDetailsAudioStream[]; /** - * The uploaded video file's combined (video and audio) bitrate in bits - * per second. + * The uploaded video file's combined (video and audio) bitrate in bits per second. */ bitrateBps?: string; /** @@ -4462,10 +3845,7 @@ export namespace youtube_v3 { */ container?: string; /** - * The date and time when the uploaded video file was created. The value is - * specified in ISO 8601 format. Currently, the following ISO 8601 formats - * are supported: - Date only: YYYY-MM-DD - Naive time: - * YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM + * The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM */ creationTime?: string; /** @@ -4473,25 +3853,19 @@ export namespace youtube_v3 { */ durationMs?: string; /** - * The uploaded file's name. This field is present whether a video file - * or another type of file was uploaded. + * The uploaded file's name. This field is present whether a video file or another type of file was uploaded. */ fileName?: string; /** - * The uploaded file's size in bytes. This field is present whether a - * video file or another type of file was uploaded. + * The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. */ fileSize?: string; /** - * The uploaded file's type as detected by YouTube's video - * processing engine. Currently, YouTube only processes video files, but - * this field is present whether a video file or another type of file was - * uploaded. + * The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded. */ fileType?: string; /** - * A list of video streams contained in the uploaded video file. Each item - * in the list contains detailed metadata about a video stream. + * A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. */ videoStreams?: Schema$VideoFileDetailsVideoStream[]; } @@ -4512,8 +3886,7 @@ export namespace youtube_v3 { */ codec?: string; /** - * A value that uniquely identifies a video vendor. Typically, the value is - * a four-letter vendor code. + * A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. */ vendor?: string; } @@ -4522,8 +3895,7 @@ export namespace youtube_v3 { */ export interface Schema$VideoFileDetailsVideoStream { /** - * The video content's display aspect ratio, which specifies the aspect - * ratio in which the video should be displayed. + * The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. */ aspectRatio?: number; /** @@ -4543,18 +3915,15 @@ export namespace youtube_v3 { */ heightPixels?: number; /** - * The amount that YouTube needs to rotate the original source content to - * properly display the video. + * The amount that YouTube needs to rotate the original source content to properly display the video. */ rotation?: string; /** - * A value that uniquely identifies a video vendor. Typically, the value is - * a four-letter vendor code. + * A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. */ vendor?: string; /** - * The encoded video content's width in pixels. You can calculate the - * video's encoding aspect ratio as width_pixels / height_pixels. + * The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels. */ widthPixels?: number; } @@ -4572,8 +3941,7 @@ export namespace youtube_v3 { */ items?: Schema$VideoRating[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#videoGetRatingResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse". */ kind?: string; /** @@ -4595,19 +3963,16 @@ export namespace youtube_v3 { */ items?: Schema$Video[]; /** - * Identifies what kind of resource this is. Value: the fixed string - * "youtube#videoListResponse". + * Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse". */ kind?: string; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. */ nextPageToken?: string; pageInfo?: Schema$PageInfo; /** - * The token that can be used as the value of the pageToken parameter to - * retrieve the previous page in the result set. + * The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. */ prevPageToken?: string; tokenPagination?: Schema$TokenPagination; @@ -4621,46 +3986,27 @@ export namespace youtube_v3 { */ export interface Schema$VideoLiveStreamingDetails { /** - * The ID of the currently active live chat attached to this video. This - * field is filled only if the video is a currently live broadcast that has - * live chat. Once the broadcast transitions to complete this field will be - * removed and the live chat closed down. For persistent broadcasts that - * live chat id will no longer be tied to this video but rather to the new - * video being displayed at the persistent page. + * The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. */ activeLiveChatId?: string; /** - * The time that the broadcast actually ended. The value is specified in ISO - * 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available - * until the broadcast is over. + * The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over. */ actualEndTime?: string; /** - * The time that the broadcast actually started. The value is specified in - * ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be - * available until the broadcast begins. + * The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. */ actualStartTime?: string; /** - * The number of viewers currently watching the broadcast. The property and - * its value will be present if the broadcast has current viewers and the - * broadcast owner has not hidden the viewcount for the video. Note that - * YouTube stops tracking the number of concurrent viewers for a broadcast - * when the broadcast ends. So, this property would not identify the number - * of viewers watching an archived video of a live broadcast that already - * ended. + * The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. */ concurrentViewers?: string; /** - * The time that the broadcast is scheduled to end. The value is specified - * in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the - * property is not present, then the broadcast is scheduled to continue - * indefinitely. + * The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. */ scheduledEndTime?: string; /** - * The time that the broadcast is scheduled to begin. The value is specified - * in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ scheduledStartTime?: string; } @@ -4701,57 +4047,39 @@ export namespace youtube_v3 { embedWidth?: string; } /** - * Describes processing status and progress and availability of some other - * Video resource parts. + * Describes processing status and progress and availability of some other Video resource parts. */ export interface Schema$VideoProcessingDetails { /** - * This value indicates whether video editing suggestions, which might - * improve video quality or the playback experience, are available for the - * video. You can retrieve these suggestions by requesting the suggestions - * part in your videos.list() request. + * This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. */ editorSuggestionsAvailability?: string; /** - * This value indicates whether file details are available for the uploaded - * video. You can retrieve a video's file details by requesting the - * fileDetails part in your videos.list() request. + * This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request. */ fileDetailsAvailability?: string; /** - * The reason that YouTube failed to process the video. This property will - * only have a value if the processingStatus property's value is failed. + * The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed. */ processingFailureReason?: string; /** - * This value indicates whether the video processing engine has generated - * suggestions that might improve YouTube's ability to process the the - * video, warnings that explain video processing problems, or errors that - * cause video processing problems. You can retrieve these suggestions by - * requesting the suggestions part in your videos.list() request. + * This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. */ processingIssuesAvailability?: string; /** - * The processingProgress object contains information about the progress - * YouTube has made in processing the video. The values are really only - * relevant if the video's processing status is processing. + * The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing. */ processingProgress?: Schema$VideoProcessingDetailsProcessingProgress; /** - * The video's processing status. This value indicates whether YouTube - * was able to process the video or if the video is still being processed. + * The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed. */ processingStatus?: string; /** - * This value indicates whether keyword (tag) suggestions are available for - * the video. Tags can be added to a video's metadata to make it easier - * for other users to find the video. You can retrieve these suggestions by - * requesting the suggestions part in your videos.list() request. + * This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. */ tagSuggestionsAvailability?: string; /** - * This value indicates whether thumbnail images have been generated for the - * video. + * This value indicates whether thumbnail images have been generated for the video. */ thumbnailsAvailability?: string; } @@ -4760,24 +4088,15 @@ export namespace youtube_v3 { */ export interface Schema$VideoProcessingDetailsProcessingProgress { /** - * The number of parts of the video that YouTube has already processed. You - * can estimate the percentage of the video that YouTube has already - * processed by calculating: 100 * parts_processed / parts_total Note that - * since the estimated number of parts could increase without a - * corresponding increase in the number of parts that have already been - * processed, it is possible that the calculated progress could periodically - * decrease while YouTube processes a video. + * The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video. */ partsProcessed?: string; /** - * An estimate of the total number of parts that need to be processed for - * the video. The number may be updated with more precise estimates while - * YouTube processes the video. + * An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video. */ partsTotal?: string; /** - * An estimate of the amount of time, in millseconds, that YouTube needs to - * finish processing the video. + * An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. */ timeLeftMs?: string; } @@ -4807,14 +4126,12 @@ export namespace youtube_v3 { */ locationDescription?: string; /** - * The date and time when the video was recorded. The value is specified in - * ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. + * The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. */ recordingDate?: string; } /** - * Basic details about a video, including title, description, uploader, - * thumbnails and category. + * Basic details about a video, including title, description, uploader, thumbnails and category. */ export interface Schema$VideoSnippet { /** @@ -4822,8 +4139,7 @@ export namespace youtube_v3 { */ categoryId?: string; /** - * The ID that YouTube uses to uniquely identify the channel that the video - * was uploaded to. + * The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. */ channelId?: string; /** @@ -4831,8 +4147,7 @@ export namespace youtube_v3 { */ channelTitle?: string; /** - * The default_audio_language property specifies the language spoken in the - * video's default audio track. + * The default_audio_language property specifies the language spoken in the video's default audio track. */ defaultAudioLanguage?: string; /** @@ -4844,29 +4159,23 @@ export namespace youtube_v3 { */ description?: string; /** - * Indicates if the video is an upcoming/active live broadcast. Or it's - * "none" if the video is not an upcoming/active live broadcast. + * Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. */ liveBroadcastContent?: string; /** - * Localized snippet selected with the hl parameter. If no such localization - * exists, this field is populated with the default snippet. (Read-only) + * Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only) */ localized?: Schema$VideoLocalization; /** - * The date and time that the video was uploaded. The value is specified in - * ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** - * A list of keyword tags associated with the video. Tags may contain - * spaces. + * A list of keyword tags associated with the video. Tags may contain spaces. */ tags?: string[]; /** - * A map of thumbnail images associated with the video. For each object in - * the map, the key is the name of the thumbnail image, and the value is an - * object that contains other information about the thumbnail. + * A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -4875,8 +4184,7 @@ export namespace youtube_v3 { title?: string; } /** - * Statistics about the video, such as the number of times the video was - * viewed or liked. + * Statistics about the video, such as the number of times the video was viewed or liked. */ export interface Schema$VideoStatistics { /** @@ -4884,18 +4192,15 @@ export namespace youtube_v3 { */ commentCount?: string; /** - * The number of users who have indicated that they disliked the video by - * giving it a negative rating. + * The number of users who have indicated that they disliked the video by giving it a negative rating. */ dislikeCount?: string; /** - * The number of users who currently have the video marked as a favorite - * video. + * The number of users who currently have the video marked as a favorite video. */ favoriteCount?: string; /** - * The number of users who have indicated that they liked the video by - * giving it a positive rating. + * The number of users who have indicated that they liked the video by giving it a positive rating. */ likeCount?: string; /** @@ -4912,8 +4217,7 @@ export namespace youtube_v3 { */ embeddable?: boolean; /** - * This value explains why a video failed to upload. This property is only - * present if the uploadStatus property indicates that the upload failed. + * This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. */ failureReason?: string; /** @@ -4925,21 +4229,15 @@ export namespace youtube_v3 { */ privacyStatus?: string; /** - * This value indicates if the extended video statistics on the watch page - * can be viewed by everyone. Note that the view count, likes, etc will - * still be visible if this is disabled. + * This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. */ publicStatsViewable?: boolean; /** - * The date and time when the video is scheduled to publish. It can be set - * only if the privacy status of the video is private. The value is - * specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishAt?: string; /** - * This value explains why YouTube rejected an uploaded video. This property - * is only present if the uploadStatus property indicates that the upload - * was rejected. + * This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. */ rejectionReason?: string; /** @@ -4948,40 +4246,27 @@ export namespace youtube_v3 { uploadStatus?: string; } /** - * Specifies suggestions on how to improve video content, including encoding - * hints, tag suggestions, and editor suggestions. + * Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. */ export interface Schema$VideoSuggestions { /** - * A list of video editing operations that might improve the video quality - * or playback experience of the uploaded video. + * A list of video editing operations that might improve the video quality or playback experience of the uploaded video. */ editorSuggestions?: string[]; /** - * A list of errors that will prevent YouTube from successfully processing - * the uploaded video video. These errors indicate that, regardless of the - * video's current processing status, eventually, that status will - * almost certainly be failed. + * A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed. */ processingErrors?: string[]; /** - * A list of suggestions that may improve YouTube's ability to process - * the video. + * A list of suggestions that may improve YouTube's ability to process the video. */ processingHints?: string[]; /** - * A list of reasons why YouTube may have difficulty transcoding the - * uploaded video or that might result in an erroneous transcoding. These - * warnings are generated before YouTube actually processes the uploaded - * video file. In addition, they identify issues that are unlikely to cause - * the video processing to fail but that might cause problems such as sync - * issues, video artifacts, or a missing audio track. + * A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track. */ processingWarnings?: string[]; /** - * A list of keyword tags that could be added to the video's metadata to - * increase the likelihood that users will locate your video when searching - * or browsing on YouTube. + * A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube. */ tagSuggestions?: Schema$VideoSuggestionsTagSuggestion[]; } @@ -4990,11 +4275,7 @@ export namespace youtube_v3 { */ export interface Schema$VideoSuggestionsTagSuggestion { /** - * A set of video categories for which the tag is relevant. You can use this - * information to display appropriate tag suggestions based on the video - * category that the video uploader associates with the video. By default, - * tag suggestions are relevant for all categories if there are no restricts - * defined for the keyword. + * A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword. */ categoryRestricts?: string[]; /** @@ -5007,21 +4288,15 @@ export namespace youtube_v3 { */ export interface Schema$VideoTopicDetails { /** - * Similar to topic_id, except that these topics are merely relevant to the - * video. These are topics that may be mentioned in, or appear in the video. - * You can retrieve information about each topic using Freebase Topic API. + * Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API. */ relevantTopicIds?: string[]; /** - * A list of Wikipedia URLs that provide a high-level description of the - * video's content. + * A list of Wikipedia URLs that provide a high-level description of the video's content. */ topicCategories?: string[]; /** - * A list of Freebase topic IDs that are centrally associated with the - * video. These are topics that are centrally featured in the video, and it - * can be said that the video is mainly about each of these. You can - * retrieve information about each topic using the Freebase Topic API. + * A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API. */ topicIds?: string[]; } @@ -5034,8 +4309,7 @@ export namespace youtube_v3 { */ backgroundColor?: string; /** - * An ID that uniquely identifies a playlist that displays next to the video - * player. + * An ID that uniquely identifies a playlist that displays next to the video player. */ featuredPlaylistId?: string; /** @@ -5052,13 +4326,7 @@ export namespace youtube_v3 { /** * youtube.activities.insert - * @desc Posts a bulletin for a specific channel. (The user submitting the - * request must be authorized to act on the channel's behalf.) Note: Even - * though an activity resource can contain information about actions like a - * user rating a video or marking a video as a favorite, you need to use - * other API methods to generate those activity resources. For example, you - * would use the API's videos.rate() method to rate a video and the - * playlistItems.insert() method to mark a video as a favorite. + * @desc Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.) Note: Even though an activity resource can contain information about actions like a user rating a video or marking a video as a favorite, you need to use other API methods to generate those activity resources. For example, you would use the API's videos.rate() method to rate a video and the playlistItems.insert() method to mark a video as a favorite. * @alias youtube.activities.insert * @memberOf! () * @@ -5131,11 +4399,7 @@ export namespace youtube_v3 { /** * youtube.activities.list - * @desc Returns a list of channel activity events that match the request - * criteria. For example, you can retrieve events associated with a - * particular channel, events associated with the user's subscriptions and - * Google+ friends, or the YouTube home page feed, which is customized for - * each user. + * @desc Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user. * @alias youtube.activities.list * @memberOf! () * @@ -5225,9 +4489,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. */ part?: string; @@ -5243,64 +4505,39 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channelId parameter specifies a unique YouTube channel ID. The API - * will then return a list of that channel's activities. + * The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities. */ channelId?: string; /** - * Set this parameter's value to true to retrieve the activity feed that - * displays on the YouTube home page for the currently authenticated user. + * Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user. */ home?: boolean; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to retrieve a feed of the - * authenticated user's activities. + * Set this parameter's value to true to retrieve a feed of the authenticated user's activities. */ mine?: boolean; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * activity resource properties that the API response will include. If the - * parameter identifies a property that contains child properties, the child - * properties will be included in the response. For example, in an activity - * resource, the snippet property contains other properties that identify - * the type of activity, a display title for the activity, and so forth. If - * you set part=snippet, the API response will also contain all of those - * nested properties. + * The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. */ part?: string; /** - * The publishedAfter parameter specifies the earliest date and time that an - * activity could have occurred for that activity to be included in the API - * response. If the parameter value specifies a day, but not a time, then - * any activities that occurred that day will be included in the result set. - * The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAfter?: string; /** - * The publishedBefore parameter specifies the date and time before which an - * activity must have occurred for that activity to be included in the API - * response. If the parameter value specifies a day, but not a time, then - * any activities that occurred that day will be excluded from the result - * set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedBefore?: string; /** - * The regionCode parameter instructs the API to return results for the - * specified country. The parameter value is an ISO 3166-1 alpha-2 country - * code. YouTube uses this value when the authorized user's previous - * activity on YouTube does not provide enough information to generate the - * activity feed. + * The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed. */ regionCode?: string; } @@ -5386,10 +4623,7 @@ export namespace youtube_v3 { /** * youtube.captions.download - * @desc Downloads a caption track. The caption track is returned in its - * original format unless the request specifies a value for the tfmt - * parameter and in its original language unless the request specifies a - * value for the tlang parameter. + * @desc Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter. * @alias youtube.captions.download * @memberOf! () * @@ -5547,10 +4781,7 @@ export namespace youtube_v3 { /** * youtube.captions.list - * @desc Returns a list of caption tracks that are associated with a - * specified video. Note that the API response does not contain the actual - * captions and that the captions.download method provides the ability to - * retrieve a caption track. + * @desc Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track. * @alias youtube.captions.list * @memberOf! () * @@ -5627,9 +4858,7 @@ export namespace youtube_v3 { /** * youtube.captions.update - * @desc Updates a caption track. When updating a caption track, you can - * change the track's draft status, upload a new caption file for the track, - * or both. + * @desc Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both. * @alias youtube.captions.update * @memberOf! () * @@ -5717,27 +4946,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter identifies the caption track that is being deleted. The - * value is a caption track ID as identified by the id property in a caption - * resource. + * The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource. */ id?: string; /** - * ID of the Google+ Page for the channel that the request is be on behalf - * of + * ID of the Google+ Page for the channel that the request is be on behalf of */ onBehalfOf?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -5749,41 +4966,23 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter identifies the caption track that is being retrieved. - * The value is a caption track ID as identified by the id property in a - * caption resource. + * The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource. */ id?: string; /** - * ID of the Google+ Page for the channel that the request is be on behalf - * of + * ID of the Google+ Page for the channel that the request is be on behalf of */ onBehalfOf?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The tfmt parameter specifies that the caption track should be returned in - * a specific format. If the parameter is not included in the request, the - * track is returned in its original format. + * The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format. */ tfmt?: string; /** - * The tlang parameter specifies that the API response should return a - * translation of the specified caption track. The parameter value is an ISO - * 639-1 two-letter language code that identifies the desired caption - * language. The translation is generated by using machine translation, such - * as Google Translate. + * The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate. */ tlang?: string; } @@ -5794,36 +4993,19 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the Google+ Page for the channel that the request is be on behalf - * of + * ID of the Google+ Page for the channel that the request is be on behalf of */ onBehalfOf?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter specifies the caption resource parts that the API - * response will include. Set the parameter value to snippet. + * The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. */ part?: string; /** - * The sync parameter indicates whether YouTube should automatically - * synchronize the caption file with the audio track of the video. If you - * set the value to true, YouTube will disregard any time codes that are in - * the uploaded caption file and generate new time codes for the captions. - * You should set the sync parameter to true if you are uploading a - * transcript, which has no time codes, or if you suspect the time codes in - * your file are incorrect and want YouTube to try to fix them. + * The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions. You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them. */ sync?: boolean; @@ -5854,9 +5036,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of IDs that identify - * the caption resources that should be retrieved. Each ID must identify a - * caption track associated with the specified video. + * The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video. */ id?: string; /** @@ -5864,27 +5044,15 @@ export namespace youtube_v3 { */ onBehalfOf?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter specifies a comma-separated list of one or more - * caption resource parts that the API response will include. The part names - * that you can include in the parameter value are id and snippet. + * The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet. */ part?: string; /** - * The videoId parameter specifies the YouTube video ID of the video for - * which the API should return caption tracks. + * The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks. */ videoId?: string; } @@ -5895,37 +5063,19 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the Google+ Page for the channel that the request is be on behalf - * of + * ID of the Google+ Page for the channel that the request is be on behalf of */ onBehalfOf?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. Set the property value to - * snippet if you are updating the track's draft status. Otherwise, set the - * property value to id. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id. */ part?: string; /** - * Note: The API server only processes the parameter value if the request - * contains an updated caption file. The sync parameter indicates whether - * YouTube should automatically synchronize the caption file with the audio - * track of the video. If you set the value to true, YouTube will - * automatically synchronize the caption track with the audio track. + * Note: The API server only processes the parameter value if the request contains an updated caption file. The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track. */ sync?: boolean; @@ -5958,15 +5108,7 @@ export namespace youtube_v3 { /** * youtube.channelBanners.insert - * @desc Uploads a channel banner image to YouTube. This method represents - * the first two steps in a three-step process to update the banner image - * for a channel: - Call the channelBanners.insert method to upload the - * binary image data to YouTube. The image must have a 16:9 aspect ratio and - * be at least 2120x1192 pixels. - Extract the url property's value from the - * response that the API returns for step 1. - Call the channels.update - * method to update the channel's branding settings. Set the - * brandingSettings.image.bannerExternalUrl property's value to the URL - * obtained in step 2. + * @desc Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. - Extract the url property's value from the response that the API returns for step 1. - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. * @alias youtube.channelBanners.insert * @memberOf! () * @@ -6057,27 +5199,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channelId parameter identifies the YouTube channel to which the - * banner is uploaded. The channelId parameter was introduced as a required - * parameter in May 2017. As this was a backward-incompatible change, - * channelBanners.insert requests that do not specify this parameter will - * not return an error until six months have passed from the time that the - * parameter was introduced. Please see the API Terms of Service for the - * official policy regarding backward incompatible changes and the API - * revision history for the exact date that the parameter was introduced. + * The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced. */ channelId?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -6110,8 +5236,7 @@ export namespace youtube_v3 { /** * youtube.channels.list - * @desc Returns a collection of zero or more channel resources that match - * the request criteria. + * @desc Returns a collection of zero or more channel resources that match the request criteria. * @alias youtube.channels.list * @memberOf! () * @@ -6194,9 +5319,7 @@ export namespace youtube_v3 { /** * youtube.channels.update - * @desc Updates a channel's metadata. Note that this method currently only - * supports updates to the channel resource's brandingSettings and - * invideoPromotion objects and their child properties. + * @desc Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties. * @alias youtube.channels.update * @memberOf! () * @@ -6275,77 +5398,47 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The categoryId parameter specifies a YouTube guide category, thereby - * requesting YouTube channels associated with that category. + * The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category. */ categoryId?: string; /** - * The forUsername parameter specifies a YouTube username, thereby - * requesting the channel associated with that username. + * The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username. */ forUsername?: string; /** - * The hl parameter should be used for filter out the properties that are - * not in the given language. Used for the brandingSettings part. + * The hl parameter should be used for filter out the properties that are not in the given language. Used for the brandingSettings part. */ hl?: string; /** - * The id parameter specifies a comma-separated list of the YouTube channel - * ID(s) for the resource(s) that are being retrieved. In a channel - * resource, the id property specifies the channel's YouTube channel ID. + * The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. Set this parameter's value to true to instruct the API to only - * return channels managed by the content owner that the - * onBehalfOfContentOwner parameter specifies. The user must be - * authenticated as a CMS account linked to the specified content owner and - * onBehalfOfContentOwner must be provided. + * Note: This parameter is intended exclusively for YouTube content partners. Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. */ managedByMe?: boolean; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to instruct the API to only return - * channels owned by the authenticated user. + * Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user. */ mine?: boolean; /** - * Use the subscriptions.list method and its mySubscribers parameter to - * retrieve a list of subscribers to the authenticated user's channel. + * Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers to the authenticated user's channel. */ mySubscribers?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * channel resource properties that the API response will include. If the - * parameter identifies a property that contains child properties, the child - * properties will be included in the response. For example, in a channel - * resource, the contentDetails property contains other properties, such as - * the uploads properties. As such, if you set part=contentDetails, the API - * response will also contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. */ part?: string; } @@ -6356,25 +5449,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The onBehalfOfContentOwner parameter indicates that the authenticated - * user is acting on behalf of the content owner specified in the parameter - * value. This parameter is intended for YouTube content partners that own - * and manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with needs to - * be linked to the specified YouTube content owner. + * The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. The API currently only - * allows the parameter value to be set to either brandingSettings or - * invideoPromotion. (You cannot update both of those parts with a single - * request.) Note that this method overrides the existing values for all of - * the mutable properties that are contained in any parts that the parameter - * value specifies. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. */ part?: string; @@ -6542,8 +5621,7 @@ export namespace youtube_v3 { /** * youtube.channelSections.list - * @desc Returns channelSection resources that match the API request - * criteria. + * @desc Returns channelSection resources that match the API request criteria. * @alias youtube.channelSections.list * @memberOf! () * @@ -6712,22 +5790,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube channelSection ID for the resource - * that is being deleted. In a channelSection resource, the id property - * specifies the YouTube channelSection ID. + * The id parameter specifies the YouTube channelSection ID for the resource that is being deleted. In a channelSection resource, the id property specifies the YouTube channelSection ID. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -6739,42 +5806,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. The part names that you - * can include in the parameter value are snippet and contentDetails. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. */ part?: string; @@ -6791,55 +5831,27 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channelId parameter specifies a YouTube channel ID. The API will only - * return that channel's channelSections. + * The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections. */ channelId?: string; /** - * The hl parameter indicates that the snippet.localized property values in - * the returned channelSection resources should be in the specified language - * if localized values for that language are available. For example, if the - * API request specifies hl=de, the snippet.localized properties in the API - * response will contain German titles if German titles are available. - * Channel owners can provide localized channel section titles using either - * the channelSections.insert or channelSections.update method. + * The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method. */ hl?: string; /** - * The id parameter specifies a comma-separated list of the YouTube - * channelSection ID(s) for the resource(s) that are being retrieved. In a - * channelSection resource, the id property specifies the YouTube - * channelSection ID. + * The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID. */ id?: string; /** - * Set this parameter's value to true to retrieve a feed of the - * authenticated user's channelSections. + * Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections. */ mine?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter specifies a comma-separated list of one or more - * channelSection resource properties that the API response will include. - * The part names that you can include in the parameter value are id, - * snippet, and contentDetails. If the parameter identifies a property that - * contains child properties, the child properties will be included in the - * response. For example, in a channelSection resource, the snippet property - * contains other properties, such as a display title for the - * channelSection. If you set part=snippet, the API response will also - * contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set part=snippet, the API response will also contain all of those nested properties. */ part?: string; } @@ -6851,23 +5863,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. The part names that you - * can include in the parameter value are snippet and contentDetails. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. */ part?: string; @@ -6956,8 +5956,7 @@ export namespace youtube_v3 { /** * youtube.comments.insert - * @desc Creates a reply to an existing comment. Note: To create a top-level - * comment, use the commentThreads.insert method. + * @desc Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method. * @alias youtube.comments.insert * @memberOf! () * @@ -7107,8 +6106,7 @@ export namespace youtube_v3 { /** * youtube.comments.markAsSpam - * @desc Expresses the caller's opinion that one or more comments should be - * flagged as spam. + * @desc Expresses the caller's opinion that one or more comments should be flagged as spam. * @alias youtube.comments.markAsSpam * @memberOf! () * @@ -7180,9 +6178,7 @@ export namespace youtube_v3 { /** * youtube.comments.setModerationStatus - * @desc Sets the moderation status of one or more comments. The API request - * must be authorized by the owner of the channel or video associated with - * the comments. + * @desc Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments. * @alias youtube.comments.setModerationStatus * @memberOf! () * @@ -7334,8 +6330,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the comment ID for the resource that is being - * deleted. + * The id parameter specifies the comment ID for the resource that is being deleted. */ id?: string; } @@ -7346,9 +6341,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter identifies the properties that the API response will - * include. Set the parameter value to snippet. The snippet part has a quota - * cost of 2 units. + * The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. */ part?: string; @@ -7364,39 +6357,27 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of comment IDs for the - * resources that are being retrieved. In a comment resource, the id - * property specifies the comment's ID. + * The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. Note: This parameter is not - * supported for use in conjunction with the id parameter. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is not supported for use in conjunction with the id parameter. */ maxResults?: number; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken property - * identifies the next page of the result that can be retrieved. Note: This - * parameter is not supported for use in conjunction with the id parameter. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved. Note: This parameter is not supported for use in conjunction with the id parameter. */ pageToken?: string; /** - * The parentId parameter specifies the ID of the comment for which replies - * should be retrieved. Note: YouTube currently supports replies only for - * top-level comments. However, replies to replies may be supported in the - * future. + * The parentId parameter specifies the ID of the comment for which replies should be retrieved. Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future. */ parentId?: string; /** - * The part parameter specifies a comma-separated list of one or more - * comment resource properties that the API response will include. + * The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include. */ part?: string; /** - * This parameter indicates whether the API should return comments formatted - * as HTML or as plain text. + * This parameter indicates whether the API should return comments formatted as HTML or as plain text. */ textFormat?: string; } @@ -7408,8 +6389,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of IDs of comments that - * the caller believes should be classified as spam. + * The id parameter specifies a comma-separated list of IDs of comments that the caller believes should be classified as spam. */ id?: string; } @@ -7421,15 +6401,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The banAuthor parameter lets you indicate that you want to automatically - * reject any additional comments written by the comment's author. Set the - * parameter value to true to ban the author. Note: This parameter is only - * valid if the moderationStatus parameter is also set to rejected. + * The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author. Note: This parameter is only valid if the moderationStatus parameter is also set to rejected. */ banAuthor?: boolean; /** - * The id parameter specifies a comma-separated list of IDs that identify - * the comments for which you are updating the moderation status. + * The id parameter specifies a comma-separated list of IDs that identify the comments for which you are updating the moderation status. */ id?: string; /** @@ -7444,10 +6420,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter identifies the properties that the API response will - * include. You must at least include the snippet part in the parameter - * value since that part contains all of the properties that the API request - * can update. + * The part parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. */ part?: string; @@ -7465,8 +6438,7 @@ export namespace youtube_v3 { /** * youtube.commentThreads.insert - * @desc Creates a new top-level comment. To add a reply to an existing - * comment, use the comments.insert method instead. + * @desc Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead. * @alias youtube.commentThreads.insert * @memberOf! () * @@ -7541,8 +6513,7 @@ export namespace youtube_v3 { /** * youtube.commentThreads.list - * @desc Returns a list of comment threads that match the API request - * parameters. + * @desc Returns a list of comment threads that match the API request parameters. * @alias youtube.commentThreads.list * @memberOf! () * @@ -7715,9 +6686,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter identifies the properties that the API response will - * include. Set the parameter value to snippet. The snippet part has a quota - * cost of 2 units. + * The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units. */ part?: string; @@ -7734,69 +6703,47 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The allThreadsRelatedToChannelId parameter instructs the API to return - * all comment threads associated with the specified channel. The response - * can include comments about the channel or about the channel's videos. + * The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos. */ allThreadsRelatedToChannelId?: string; /** - * The channelId parameter instructs the API to return comment threads - * containing comments about the specified channel. (The response will not - * include comments left on videos that the channel uploaded.) + * The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.) */ channelId?: string; /** - * The id parameter specifies a comma-separated list of comment thread IDs - * for the resources that should be retrieved. + * The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. Note: This parameter is not - * supported for use in conjunction with the id parameter. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is not supported for use in conjunction with the id parameter. */ maxResults?: number; /** - * Set this parameter to limit the returned comment threads to a particular - * moderation state. Note: This parameter is not supported for use in - * conjunction with the id parameter. + * Set this parameter to limit the returned comment threads to a particular moderation state. Note: This parameter is not supported for use in conjunction with the id parameter. */ moderationStatus?: string; /** - * The order parameter specifies the order in which the API response should - * list comment threads. Valid values are: - time - Comment threads are - * ordered by time. This is the default behavior. - relevance - Comment - * threads are ordered by relevance.Note: This parameter is not supported - * for use in conjunction with the id parameter. + * The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter. */ order?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken property - * identifies the next page of the result that can be retrieved. Note: This - * parameter is not supported for use in conjunction with the id parameter. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved. Note: This parameter is not supported for use in conjunction with the id parameter. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * commentThread resource properties that the API response will include. + * The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. */ part?: string; /** - * The searchTerms parameter instructs the API to limit the API response to - * only contain comments that contain the specified search terms. Note: - * This parameter is not supported for use in conjunction with the id - * parameter. + * The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms. Note: This parameter is not supported for use in conjunction with the id parameter. */ searchTerms?: string; /** - * Set this parameter's value to html or plainText to instruct the API to - * return the comments left by users in html formatted or in plain text. + * Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text. */ textFormat?: string; /** - * The videoId parameter instructs the API to return comment threads - * associated with the specified video ID. + * The videoId parameter instructs the API to return comment threads associated with the specified video ID. */ videoId?: string; } @@ -7808,10 +6755,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter specifies a comma-separated list of commentThread - * resource properties that the API response will include. You must at least - * include the snippet part in the parameter value since that part contains - * all of the properties that the API request can update. + * The part parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update. */ part?: string; @@ -7829,8 +6773,7 @@ export namespace youtube_v3 { /** * youtube.guideCategories.list - * @desc Returns a list of categories that can be associated with YouTube - * channels. + * @desc Returns a list of categories that can be associated with YouTube channels. * @alias youtube.guideCategories.list * @memberOf! () * @@ -7921,26 +6864,19 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hl parameter specifies the language that will be used for text values - * in the API response. + * The hl parameter specifies the language that will be used for text values in the API response. */ hl?: string; /** - * The id parameter specifies a comma-separated list of the YouTube channel - * category ID(s) for the resource(s) that are being retrieved. In a - * guideCategory resource, the id property specifies the YouTube channel - * category ID. + * The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID. */ id?: string; /** - * The part parameter specifies the guideCategory resource properties that - * the API response will include. Set the parameter value to snippet. + * The part parameter specifies the guideCategory resource properties that the API response will include. Set the parameter value to snippet. */ part?: string; /** - * The regionCode parameter instructs the API to return the list of guide - * categories available in the specified country. The parameter value is an - * ISO 3166-1 alpha-2 country code. + * The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; } @@ -7953,8 +6889,7 @@ export namespace youtube_v3 { /** * youtube.i18nLanguages.list - * @desc Returns a list of application languages that the YouTube website - * supports. + * @desc Returns a list of application languages that the YouTube website supports. * @alias youtube.i18nLanguages.list * @memberOf! () * @@ -8038,13 +6973,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hl parameter specifies the language that should be used for text - * values in the API response. + * The hl parameter specifies the language that should be used for text values in the API response. */ hl?: string; /** - * The part parameter specifies the i18nLanguage resource properties that - * the API response will include. Set the parameter value to snippet. + * The part parameter specifies the i18nLanguage resource properties that the API response will include. Set the parameter value to snippet. */ part?: string; } @@ -8057,8 +6990,7 @@ export namespace youtube_v3 { /** * youtube.i18nRegions.list - * @desc Returns a list of content regions that the YouTube website - * supports. + * @desc Returns a list of content regions that the YouTube website supports. * @alias youtube.i18nRegions.list * @memberOf! () * @@ -8140,13 +7072,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hl parameter specifies the language that should be used for text - * values in the API response. + * The hl parameter specifies the language that should be used for text values in the API response. */ hl?: string; /** - * The part parameter specifies the i18nRegion resource properties that the - * API response will include. Set the parameter value to snippet. + * The part parameter specifies the i18nRegion resource properties that the API response will include. Set the parameter value to snippet. */ part?: string; } @@ -8159,10 +7089,7 @@ export namespace youtube_v3 { /** * youtube.liveBroadcasts.bind - * @desc Binds a YouTube broadcast to a stream or removes an existing - * binding between a broadcast and a stream. A broadcast can only be bound - * to one video stream, though a video stream may be bound to more than one - * broadcast. + * @desc Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. * @alias youtube.liveBroadcasts.bind * @memberOf! () * @@ -8240,8 +7167,7 @@ export namespace youtube_v3 { /** * youtube.liveBroadcasts.control - * @desc Controls the settings for a slate that can be displayed in the - * broadcast stream. + * @desc Controls the settings for a slate that can be displayed in the broadcast stream. * @alias youtube.liveBroadcasts.control * @memberOf! () * @@ -8472,8 +7398,7 @@ export namespace youtube_v3 { /** * youtube.liveBroadcasts.list - * @desc Returns a list of YouTube broadcasts that match the API request - * parameters. + * @desc Returns a list of YouTube broadcasts that match the API request parameters. * @alias youtube.liveBroadcasts.list * @memberOf! () * @@ -8562,12 +7487,7 @@ export namespace youtube_v3 { /** * youtube.liveBroadcasts.transition - * @desc Changes the status of a YouTube live broadcast and initiates any - * processes associated with the new status. For example, when you - * transition a broadcast's status to testing, YouTube starts to transmit - * video to that broadcast's monitor stream. Before calling this method, you - * should confirm that the value of the status.streamStatus property for the - * stream bound to your broadcast is active. + * @desc Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. * @alias youtube.liveBroadcasts.transition * @memberOf! () * @@ -8645,8 +7565,7 @@ export namespace youtube_v3 { /** * youtube.liveBroadcasts.update - * @desc Updates a broadcast. For example, you could modify the broadcast - * settings defined in the liveBroadcast resource's contentDetails object. + * @desc Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. * @alias youtube.liveBroadcasts.update * @memberOf! () * @@ -8730,53 +7649,23 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the unique ID of the broadcast that is being - * bound to a video stream. + * The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter specifies a comma-separated list of one or more - * liveBroadcast resource properties that the API response will include. The - * part names that you can include in the parameter value are id, snippet, - * contentDetails, and status. + * The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. */ part?: string; /** - * The streamId parameter specifies the unique ID of the video stream that - * is being bound to a broadcast. If this parameter is omitted, the API will - * remove any existing binding between the broadcast and a video stream. + * The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream. */ streamId?: string; } @@ -8788,71 +7677,31 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The displaySlate parameter specifies whether the slate is being enabled - * or disabled. + * The displaySlate parameter specifies whether the slate is being enabled or disabled. */ displaySlate?: boolean; /** - * The id parameter specifies the YouTube live broadcast ID that uniquely - * identifies the broadcast in which the slate is being updated. + * The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated. */ id?: string; /** - * The offsetTimeMs parameter specifies a positive time offset when the - * specified slate change will occur. The value is measured in milliseconds - * from the beginning of the broadcast's monitor stream, which is the time - * that the testing phase for the broadcast began. Even though it is - * specified in milliseconds, the value is actually an approximation, and - * YouTube completes the requested action as closely as possible to that - * time. If you do not specify a value for this parameter, then YouTube - * performs the action as soon as possible. See the Getting started guide - * for more details. Important: You should only specify a value for this - * parameter if your broadcast stream is delayed. + * The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time. If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details. Important: You should only specify a value for this parameter if your broadcast stream is delayed. */ offsetTimeMs?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter specifies a comma-separated list of one or more - * liveBroadcast resource properties that the API response will include. The - * part names that you can include in the parameter value are id, snippet, - * contentDetails, and status. + * The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. */ part?: string; /** - * The walltime parameter specifies the wall clock time at which the - * specified slate change will occur. The value is specified in ISO 8601 - * (YYYY-MM-DDThh:mm:ss.sssZ) format. + * The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. */ walltime?: string; } @@ -8864,40 +7713,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube live broadcast ID for the resource - * that is being deleted. + * The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; } @@ -8909,43 +7733,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. The part properties that - * you can include in the parameter value are id, snippet, contentDetails, - * and status. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. */ part?: string; @@ -8962,76 +7758,39 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The broadcastStatus parameter filters the API response to only include - * broadcasts with the specified status. + * The broadcastStatus parameter filters the API response to only include broadcasts with the specified status. */ broadcastStatus?: string; /** - * The broadcastType parameter filters the API response to only include - * broadcasts with the specified type. This is only compatible with the mine - * filter for now. + * The broadcastType parameter filters the API response to only include broadcasts with the specified type. This is only compatible with the mine filter for now. */ broadcastType?: string; /** - * The id parameter specifies a comma-separated list of YouTube broadcast - * IDs that identify the broadcasts being retrieved. In a liveBroadcast - * resource, the id property specifies the broadcast's ID. + * The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * The mine parameter can be used to instruct the API to only return - * broadcasts owned by the authenticated user. Set the parameter value to - * true to only retrieve your own broadcasts. + * The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts. */ mine?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * liveBroadcast resource properties that the API response will include. The - * part names that you can include in the parameter value are id, snippet, - * contentDetails, and status. + * The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. */ part?: string; } @@ -9043,54 +7802,23 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The broadcastStatus parameter identifies the state to which the broadcast - * is changing. Note that to transition a broadcast to either the testing or - * live state, the status.streamStatus must be active for the stream that - * the broadcast is bound to. + * The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to transition a broadcast to either the testing or live state, the status.streamStatus must be active for the stream that the broadcast is bound to. */ broadcastStatus?: string; /** - * The id parameter specifies the unique ID of the broadcast that is - * transitioning to another status. + * The id parameter specifies the unique ID of the broadcast that is transitioning to another status. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter specifies a comma-separated list of one or more - * liveBroadcast resource properties that the API response will include. The - * part names that you can include in the parameter value are id, snippet, - * contentDetails, and status. + * The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. */ part?: string; } @@ -9102,51 +7830,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. The part properties that - * you can include in the parameter value are id, snippet, contentDetails, - * and status. Note that this method will override the existing values for - * all of the mutable properties that are contained in any parts that the - * parameter value specifies. For example, a broadcast's privacy status is - * defined in the status part. As such, if your request is updating a - * private or unlisted broadcast, and the request's part parameter value - * includes the status part, the broadcast's privacy setting will be updated - * to whatever value the request body specifies. If the request body does - * not specify a value, the existing privacy setting will be removed and the - * broadcast will revert to the default privacy setting. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting. */ part?: string; @@ -9318,8 +8010,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter identifies the chat ban to remove. The value uniquely - * identifies both the ban and the chat. + * The id parameter identifies the chat ban to remove. The value uniquely identifies both the ban and the chat. */ id?: string; } @@ -9331,10 +8022,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response returns. Set the parameter value to - * snippet. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet. */ part?: string; @@ -9592,8 +8280,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube chat message ID of the resource - * that is being deleted. + * The id parameter specifies the YouTube chat message ID of the resource that is being deleted. */ id?: string; } @@ -9605,9 +8292,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter serves two purposes. It identifies the properties that - * the write operation will set as well as the properties that the API - * response will include. Set the parameter value to snippet. + * The part parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet. */ part?: string; @@ -9624,40 +8309,27 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hl parameter instructs the API to retrieve localized resource - * metadata for a specific application language that the YouTube website - * supports. The parameter value must be a language code included in the - * list returned by the i18nLanguages.list method. If localized resource - * details are available in that language, the resource's snippet.localized - * object will contain the localized values. However, if localized details - * are not available, the snippet.localized object will contain resource - * details in the resource's default language. + * The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language. */ hl?: string; /** - * The liveChatId parameter specifies the ID of the chat whose messages will - * be returned. + * The liveChatId parameter specifies the ID of the chat whose messages will be returned. */ liveChatId?: string; /** - * The maxResults parameter specifies the maximum number of messages that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of messages that should be returned in the result set. */ maxResults?: number; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken property - * identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies the liveChatComment resource parts that the - * API response will include. Supported values are id and snippet. + * The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. */ part?: string; /** - * The profileImageSize parameter specifies the size of the user profile - * pictures that should be returned in the result set. Default: 88. + * The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88. */ profileImageSize?: number; } @@ -9910,8 +8582,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter identifies the chat moderator to remove. The value - * uniquely identifies both the moderator and the chat. + * The id parameter identifies the chat moderator to remove. The value uniquely identifies both the moderator and the chat. */ id?: string; } @@ -9923,10 +8594,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response returns. Set the parameter value to - * snippet. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet. */ part?: string; @@ -9943,24 +8611,19 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The liveChatId parameter specifies the YouTube live chat for which the - * API should return moderators. + * The liveChatId parameter specifies the YouTube live chat for which the API should return moderators. */ liveChatId?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies the liveChatModerator resource parts that - * the API response will include. Supported values are id and snippet. + * The part parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet. */ part?: string; } @@ -10047,8 +8710,7 @@ export namespace youtube_v3 { /** * youtube.liveStreams.insert - * @desc Creates a video stream. The stream enables you to send your video - * to YouTube, which can then broadcast the video to your audience. + * @desc Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience. * @alias youtube.liveStreams.insert * @memberOf! () * @@ -10125,8 +8787,7 @@ export namespace youtube_v3 { /** * youtube.liveStreams.list - * @desc Returns a list of video streams that match the API request - * parameters. + * @desc Returns a list of video streams that match the API request parameters. * @alias youtube.liveStreams.list * @memberOf! () * @@ -10207,9 +8868,7 @@ export namespace youtube_v3 { /** * youtube.liveStreams.update - * @desc Updates a video stream. If the properties that you want to change - * cannot be updated, then you need to create a new stream with the proper - * settings. + * @desc Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings. * @alias youtube.liveStreams.update * @memberOf! () * @@ -10293,40 +8952,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube live stream ID for the resource - * that is being deleted. + * The id parameter specifies the YouTube live stream ID for the resource that is being deleted. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; } @@ -10338,42 +8972,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. The part properties that - * you can include in the parameter value are id, snippet, cdn, and status. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. */ part?: string; @@ -10389,65 +8996,31 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of YouTube stream IDs - * that identify the streams being retrieved. In a liveStream resource, the - * id property specifies the stream's ID. + * The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * The mine parameter can be used to instruct the API to only return streams - * owned by the authenticated user. Set the parameter value to true to only - * retrieve your own streams. + * The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams. */ mine?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * liveStream resource properties that the API response will include. The - * part names that you can include in the parameter value are id, snippet, - * cdn, and status. + * The part parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status. */ part?: string; } @@ -10459,46 +9032,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. The part properties that - * you can include in the parameter value are id, snippet, cdn, and status. - * Note that this method will override the existing values for all of the - * mutable properties that are contained in any parts that the parameter - * value specifies. If the request body does not specify a value for a - * mutable property, the existing value for that property will be removed. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed. */ part?: string; @@ -10665,9 +9207,7 @@ export namespace youtube_v3 { /** * youtube.playlistItems.list - * @desc Returns a collection of playlist items that match the API request - * parameters. You can retrieve all of the playlist items in a specified - * playlist or retrieve one or more playlist items by their unique IDs. + * @desc Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs. * @alias youtube.playlistItems.list * @memberOf! () * @@ -10749,8 +9289,7 @@ export namespace youtube_v3 { /** * youtube.playlistItems.update - * @desc Modifies a playlist item. For example, you could update the item's - * position in the playlist. + * @desc Modifies a playlist item. For example, you could update the item's position in the playlist. * @alias youtube.playlistItems.update * @memberOf! () * @@ -10833,22 +9372,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube playlist item ID for the playlist - * item that is being deleted. In a playlistItem resource, the id property - * specifies the playlist item's ID. + * The id parameter specifies the YouTube playlist item ID for the playlist item that is being deleted. In a playlistItem resource, the id property specifies the playlist item's ID. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -10860,22 +9388,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. */ part?: string; @@ -10892,55 +9409,31 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of one or more unique - * playlist item IDs. + * The id parameter specifies a comma-separated list of one or more unique playlist item IDs. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * playlistItem resource properties that the API response will include. If - * the parameter identifies a property that contains child properties, the - * child properties will be included in the response. For example, in a - * playlistItem resource, the snippet property contains numerous fields, - * including the title, description, position, and resourceId properties. As - * such, if you set part=snippet, the API response will contain all of those - * properties. + * The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties. */ part?: string; /** - * The playlistId parameter specifies the unique ID of the playlist for - * which you want to retrieve playlist items. Note that even though this is - * an optional parameter, every request to retrieve playlist items must - * specify a value for either the id parameter or the playlistId parameter. + * The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter. */ playlistId?: string; /** - * The videoId parameter specifies that the request should return only the - * playlist items that contain the specified video. + * The videoId parameter specifies that the request should return only the playlist items that contain the specified video. */ videoId?: string; } @@ -10952,32 +9445,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. Note that this method - * will override the existing values for all of the mutable properties that - * are contained in any parts that the parameter value specifies. For - * example, a playlist item can specify a start time and end time, which - * identify the times portion of the video that should play when users watch - * the video in the playlist. If your request is updating a playlist item - * that sets these values, and the request's part parameter value includes - * the contentDetails part, the playlist item's start and end times will be - * updated to whatever value the request body specifies. If the request body - * does not specify values, the existing start and end times will be removed - * and replaced with the default settings. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings. */ part?: string; @@ -11141,10 +9613,7 @@ export namespace youtube_v3 { /** * youtube.playlists.list - * @desc Returns a collection of playlists that match the API request - * parameters. For example, you can retrieve all playlists that the - * authenticated user owns, or you can retrieve one or more playlists by - * their unique IDs. + * @desc Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. * @alias youtube.playlists.list * @memberOf! () * @@ -11227,8 +9696,7 @@ export namespace youtube_v3 { /** * youtube.playlists.update - * @desc Modifies a playlist. For example, you could change a playlist's - * title, description, or privacy status. + * @desc Modifies a playlist. For example, you could change a playlist's title, description, or privacy status. * @alias youtube.playlists.update * @memberOf! () * @@ -11307,22 +9775,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube playlist ID for the playlist that - * is being deleted. In a playlist resource, the id property specifies the - * playlist's ID. + * The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -11333,41 +9790,15 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. */ part?: string; @@ -11383,77 +9814,39 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This value indicates that the API should only return the specified - * channel's playlists. + * This value indicates that the API should only return the specified channel's playlists. */ channelId?: string; /** - * The hl parameter should be used for filter out the properties that are - * not in the given language. Used for the snippet part. + * The hl parameter should be used for filter out the properties that are not in the given language. Used for the snippet part. */ hl?: string; /** - * The id parameter specifies a comma-separated list of the YouTube playlist - * ID(s) for the resource(s) that are being retrieved. In a playlist - * resource, the id property specifies the playlist's YouTube playlist ID. + * The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to instruct the API to only return - * playlists owned by the authenticated user. + * Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user. */ mine?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * playlist resource properties that the API response will include. If the - * parameter identifies a property that contains child properties, the child - * properties will be included in the response. For example, in a playlist - * resource, the snippet property contains properties like author, title, - * description, tags, and timeCreated. As such, if you set part=snippet, the - * API response will contain all of those properties. + * The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties. */ part?: string; } @@ -11464,28 +9857,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. Note that this method - * will override the existing values for mutable properties that are - * contained in any parts that the request body specifies. For example, a - * playlist's description is contained in the snippet part, which must be - * included in the request body. If the request does not specify a value for - * the snippet.description property, the playlist's existing description - * will be deleted. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for mutable properties that are contained in any parts that the request body specifies. For example, a playlist's description is contained in the snippet part, which must be included in the request body. If the request does not specify a value for the snippet.description property, the playlist's existing description will be deleted. */ part?: string; @@ -11503,10 +9879,7 @@ export namespace youtube_v3 { /** * youtube.search.list - * @desc Returns a collection of search results that match the query - * parameters specified in the API request. By default, a search result set - * identifies matching video, channel, and playlist resources, but you can - * also configure queries to only retrieve a specific type of resource. + * @desc Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. * @alias youtube.search.list * @memberOf! () * @@ -11612,223 +9985,127 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channelId parameter indicates that the API response should only - * contain resources created by the channel + * The channelId parameter indicates that the API response should only contain resources created by the channel */ channelId?: string; /** - * The channelType parameter lets you restrict a search to a particular type - * of channel. + * The channelType parameter lets you restrict a search to a particular type of channel. */ channelType?: string; /** - * The eventType parameter restricts a search to broadcast events. If you - * specify a value for this parameter, you must also set the type - * parameter's value to video. + * The eventType parameter restricts a search to broadcast events. If you specify a value for this parameter, you must also set the type parameter's value to video. */ eventType?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The forContentOwner parameter restricts the search to only - * retrieve resources owned by the content owner specified by the - * onBehalfOfContentOwner parameter. The user must be authenticated using a - * CMS account linked to the specified content owner and - * onBehalfOfContentOwner must be provided. + * Note: This parameter is intended exclusively for YouTube content partners. The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated using a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. */ forContentOwner?: boolean; /** - * The forDeveloper parameter restricts the search to only retrieve videos - * uploaded via the developer's application or website. The API server uses - * the request's authorization credentials to identify the developer. - * Therefore, a developer can restrict results to videos uploaded through - * the developer's own app or website but not to videos uploaded through - * other apps or sites. + * The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website. The API server uses the request's authorization credentials to identify the developer. Therefore, a developer can restrict results to videos uploaded through the developer's own app or website but not to videos uploaded through other apps or sites. */ forDeveloper?: boolean; /** - * The forMine parameter restricts the search to only retrieve videos owned - * by the authenticated user. If you set this parameter to true, then the - * type parameter's value must also be set to video. + * The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. If you set this parameter to true, then the type parameter's value must also be set to video. */ forMine?: boolean; /** - * The location parameter, in conjunction with the locationRadius parameter, - * defines a circular geographic area and also restricts a search to videos - * that specify, in their metadata, a geographic location that falls within - * that area. The parameter value is a string that specifies - * latitude/longitude coordinates e.g. (37.42307,-122.08427). - The - * location parameter value identifies the point at the center of the area. - * - The locationRadius parameter specifies the maximum distance that the - * location associated with a video can be from that point for the video to - * still be included in the search results.The API returns an error if your - * request specifies a value for the location parameter but does not also - * specify a value for the locationRadius parameter. + * The location parameter, in conjunction with the locationRadius parameter, defines a circular geographic area and also restricts a search to videos that specify, in their metadata, a geographic location that falls within that area. The parameter value is a string that specifies latitude/longitude coordinates e.g. (37.42307,-122.08427). - The location parameter value identifies the point at the center of the area. - The locationRadius parameter specifies the maximum distance that the location associated with a video can be from that point for the video to still be included in the search results.The API returns an error if your request specifies a value for the location parameter but does not also specify a value for the locationRadius parameter. */ location?: string; /** - * The locationRadius parameter, in conjunction with the location parameter, - * defines a circular geographic area. The parameter value must be a - * floating point number followed by a measurement unit. Valid measurement - * units are m, km, ft, and mi. For example, valid parameter values include - * 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius - * parameter values larger than 1000 kilometers. Note: See the definition - * of the location parameter for more information. + * The locationRadius parameter, in conjunction with the location parameter, defines a circular geographic area. The parameter value must be a floating point number followed by a measurement unit. Valid measurement units are m, km, ft, and mi. For example, valid parameter values include 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius parameter values larger than 1000 kilometers. Note: See the definition of the location parameter for more information. */ locationRadius?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The order parameter specifies the method that will be used to order - * resources in the API response. + * The order parameter specifies the method that will be used to order resources in the API response. */ order?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more search - * resource properties that the API response will include. Set the parameter - * value to snippet. + * The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet. */ part?: string; /** - * The publishedAfter parameter indicates that the API response should only - * contain resources created after the specified time. The value is an RFC - * 3339 formatted date-time value (1970-01-01T00:00:00Z). + * The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). */ publishedAfter?: string; /** - * The publishedBefore parameter indicates that the API response should only - * contain resources created before the specified time. The value is an RFC - * 3339 formatted date-time value (1970-01-01T00:00:00Z). + * The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z). */ publishedBefore?: string; /** - * The q parameter specifies the query term to search for. Your request can - * also use the Boolean NOT (-) and OR (|) operators to exclude videos or to - * find videos that are associated with one of several search terms. For - * example, to search for videos matching either "boating" or "sailing", set - * the q parameter value to boating|sailing. Similarly, to search for videos - * matching either "boating" or "sailing" but not "fishing", set the q - * parameter value to boating|sailing -fishing. Note that the pipe character - * must be URL-escaped when it is sent in your API request. The URL-escaped - * value for the pipe character is %7C. + * The q parameter specifies the query term to search for. Your request can also use the Boolean NOT (-) and OR (|) operators to exclude videos or to find videos that are associated with one of several search terms. For example, to search for videos matching either "boating" or "sailing", set the q parameter value to boating|sailing. Similarly, to search for videos matching either "boating" or "sailing" but not "fishing", set the q parameter value to boating|sailing -fishing. Note that the pipe character must be URL-escaped when it is sent in your API request. The URL-escaped value for the pipe character is %7C. */ q?: string; /** - * The regionCode parameter instructs the API to return search results for - * the specified country. The parameter value is an ISO 3166-1 alpha-2 - * country code. + * The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; /** - * The relatedToVideoId parameter retrieves a list of videos that are - * related to the video that the parameter value identifies. The parameter - * value must be set to a YouTube video ID and, if you are using this - * parameter, the type parameter must be set to video. + * The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video. */ relatedToVideoId?: string; /** - * The relevanceLanguage parameter instructs the API to return search - * results that are most relevant to the specified language. The parameter - * value is typically an ISO 639-1 two-letter language code. However, you - * should use the values zh-Hans for simplified Chinese and zh-Hant for - * traditional Chinese. Please note that results in other languages will - * still be returned if they are highly relevant to the search query term. + * The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language. The parameter value is typically an ISO 639-1 two-letter language code. However, you should use the values zh-Hans for simplified Chinese and zh-Hant for traditional Chinese. Please note that results in other languages will still be returned if they are highly relevant to the search query term. */ relevanceLanguage?: string; /** - * The safeSearch parameter indicates whether the search results should - * include restricted content as well as standard content. + * The safeSearch parameter indicates whether the search results should include restricted content as well as standard content. */ safeSearch?: string; /** - * The topicId parameter indicates that the API response should only contain - * resources associated with the specified topic. The value identifies a - * Freebase topic ID. + * The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID. */ topicId?: string; /** - * The type parameter restricts a search query to only retrieve a particular - * type of resource. The value is a comma-separated list of resource types. + * The type parameter restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types. */ type?: string; /** - * The videoCaption parameter indicates whether the API should filter video - * search results based on whether they have captions. If you specify a - * value for this parameter, you must also set the type parameter's value to - * video. + * The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoCaption?: string; /** - * The videoCategoryId parameter filters video search results based on their - * category. If you specify a value for this parameter, you must also set - * the type parameter's value to video. + * The videoCategoryId parameter filters video search results based on their category. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoCategoryId?: string; /** - * The videoDefinition parameter lets you restrict a search to only include - * either high definition (HD) or standard definition (SD) videos. HD videos - * are available for playback in at least 720p, though higher resolutions, - * like 1080p, might also be available. If you specify a value for this - * parameter, you must also set the type parameter's value to video. + * The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoDefinition?: string; /** - * The videoDimension parameter lets you restrict a search to only retrieve - * 2D or 3D videos. If you specify a value for this parameter, you must also - * set the type parameter's value to video. + * The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoDimension?: string; /** - * The videoDuration parameter filters video search results based on their - * duration. If you specify a value for this parameter, you must also set - * the type parameter's value to video. + * The videoDuration parameter filters video search results based on their duration. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoDuration?: string; /** - * The videoEmbeddable parameter lets you to restrict a search to only - * videos that can be embedded into a webpage. If you specify a value for - * this parameter, you must also set the type parameter's value to video. + * The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoEmbeddable?: string; /** - * The videoLicense parameter filters search results to only include videos - * with a particular license. YouTube lets video uploaders choose to attach - * either the Creative Commons license or the standard YouTube license to - * each of their videos. If you specify a value for this parameter, you must - * also set the type parameter's value to video. + * The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoLicense?: string; /** - * The videoSyndicated parameter lets you to restrict a search to only - * videos that can be played outside youtube.com. If you specify a value for - * this parameter, you must also set the type parameter's value to video. + * The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoSyndicated?: string; /** - * The videoType parameter lets you restrict a search to a particular type - * of videos. If you specify a value for this parameter, you must also set - * the type parameter's value to video. + * The videoType parameter lets you restrict a search to a particular type of videos. If you specify a value for this parameter, you must also set the type parameter's value to video. */ videoType?: string; } @@ -11927,19 +10204,15 @@ export namespace youtube_v3 { */ filter?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies the sponsor resource parts that the API - * response will include. Supported values are id and snippet. + * The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet. */ part?: string; } @@ -12193,9 +10466,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube subscription ID for the resource - * that is being deleted. In a subscription resource, the id property - * specifies the YouTube subscription ID. + * The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID. */ id?: string; } @@ -12207,9 +10478,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. */ part?: string; @@ -12226,94 +10495,51 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channelId parameter specifies a YouTube channel ID. The API will only - * return that channel's subscriptions. + * The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions. */ channelId?: string; /** - * The forChannelId parameter specifies a comma-separated list of channel - * IDs. The API response will then only contain subscriptions matching those - * channels. + * The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels. */ forChannelId?: string; /** - * The id parameter specifies a comma-separated list of the YouTube - * subscription ID(s) for the resource(s) that are being retrieved. In a - * subscription resource, the id property specifies the YouTube subscription - * ID. + * The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID. */ id?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * Set this parameter's value to true to retrieve a feed of the - * authenticated user's subscriptions. + * Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions. */ mine?: boolean; /** - * Set this parameter's value to true to retrieve a feed of the subscribers - * of the authenticated user in reverse chronological order (newest first). + * Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in reverse chronological order (newest first). */ myRecentSubscribers?: boolean; /** - * Set this parameter's value to true to retrieve a feed of the subscribers - * of the authenticated user in no particular order. + * Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in no particular order. */ mySubscribers?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The order parameter specifies the method that will be used to sort - * resources in the API response. + * The order parameter specifies the method that will be used to sort resources in the API response. */ order?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more - * subscription resource properties that the API response will include. If - * the parameter identifies a property that contains child properties, the - * child properties will be included in the response. For example, in a - * subscription resource, the snippet property contains other properties, - * such as a display title for the subscription. If you set part=snippet, - * the API response will also contain all of those nested properties. + * The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties. */ part?: string; } @@ -12417,30 +10643,19 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hl parameter instructs the API to retrieve localized resource - * metadata for a specific application language that the YouTube website - * supports. The parameter value must be a language code included in the - * list returned by the i18nLanguages.list method. If localized resource - * details are available in that language, the resource's snippet.localized - * object will contain the localized values. However, if localized details - * are not available, the snippet.localized object will contain resource - * details in the resource's default language. + * The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language. */ hl?: string; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. */ maxResults?: number; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. */ pageToken?: string; /** - * The part parameter specifies the superChatEvent resource parts that the - * API response will include. Supported values are id and snippet. + * The part parameter specifies the superChatEvent resource parts that the API response will include. Supported values are id and snippet. */ part?: string; } @@ -12453,8 +10668,7 @@ export namespace youtube_v3 { /** * youtube.thumbnails.set - * @desc Uploads a custom video thumbnail to YouTube and sets it for a - * video. + * @desc Uploads a custom video thumbnail to YouTube and sets it for a video. * @alias youtube.thumbnails.set * @memberOf! () * @@ -12543,21 +10757,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The videoId parameter specifies a YouTube video ID for which the custom - * video thumbnail is being provided. + * The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided. */ videoId?: string; @@ -12585,8 +10789,7 @@ export namespace youtube_v3 { /** * youtube.videoAbuseReportReasons.list - * @desc Returns a list of abuse reasons that can be used for reporting - * abusive videos. + * @desc Returns a list of abuse reasons that can be used for reporting abusive videos. * @alias youtube.videoAbuseReportReasons.list * @memberOf! () * @@ -12677,13 +10880,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hl parameter specifies the language that should be used for text - * values in the API response. + * The hl parameter specifies the language that should be used for text values in the API response. */ hl?: string; /** - * The part parameter specifies the videoCategory resource parts that the - * API response will include. Supported values are id and snippet. + * The part parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet. */ part?: string; } @@ -12696,8 +10897,7 @@ export namespace youtube_v3 { /** * youtube.videoCategories.list - * @desc Returns a list of categories that can be associated with YouTube - * videos. + * @desc Returns a list of categories that can be associated with YouTube videos. * @alias youtube.videoCategories.list * @memberOf! () * @@ -12788,24 +10988,19 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The hl parameter specifies the language that should be used for text - * values in the API response. + * The hl parameter specifies the language that should be used for text values in the API response. */ hl?: string; /** - * The id parameter specifies a comma-separated list of video category IDs - * for the resources that you are retrieving. + * The id parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving. */ id?: string; /** - * The part parameter specifies the videoCategory resource properties that - * the API response will include. Set the parameter value to snippet. + * The part parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet. */ part?: string; /** - * The regionCode parameter instructs the API to return the list of video - * categories available in the specified country. The parameter value is an - * ISO 3166-1 alpha-2 country code. + * The regionCode parameter instructs the API to return the list of video categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; } @@ -12887,8 +11082,7 @@ export namespace youtube_v3 { /** * youtube.videos.getRating - * @desc Retrieves the ratings that the authorized user gave to a list of - * specified videos. + * @desc Retrieves the ratings that the authorized user gave to a list of specified videos. * @alias youtube.videos.getRating * @memberOf! () * @@ -12966,8 +11160,7 @@ export namespace youtube_v3 { /** * youtube.videos.insert - * @desc Uploads a video to YouTube and optionally sets the video's - * metadata. + * @desc Uploads a video to YouTube and optionally sets the video's metadata. * @alias youtube.videos.insert * @memberOf! () * @@ -13130,8 +11323,7 @@ export namespace youtube_v3 { /** * youtube.videos.rate - * @desc Add a like or dislike rating to a video or remove a rating from a - * video. + * @desc Add a like or dislike rating to a video or remove a rating from a video. * @alias youtube.videos.rate * @memberOf! () * @@ -13352,22 +11544,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube video ID for the resource that is - * being deleted. In a video resource, the id property specifies the video's - * ID. + * The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -13378,22 +11559,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of the YouTube video - * ID(s) for the resource(s) for which you are retrieving rating data. In a - * video resource, the id property specifies the video's ID. + * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) for which you are retrieving rating data. In a video resource, the id property specifies the video's ID. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -13404,65 +11574,27 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The autoLevels parameter indicates whether YouTube should automatically - * enhance the video's lighting and color. + * The autoLevels parameter indicates whether YouTube should automatically enhance the video's lighting and color. */ autoLevels?: boolean; /** - * The notifySubscribers parameter indicates whether YouTube should send a - * notification about the new video to users who subscribe to the video's - * channel. A parameter value of True indicates that subscribers will be - * notified of newly uploaded videos. However, a channel owner who is - * uploading many videos might prefer to set the value to False to avoid - * sending a notification about each new video to the channel's subscribers. + * The notifySubscribers parameter indicates whether YouTube should send a notification about the new video to users who subscribe to the video's channel. A parameter value of True indicates that subscribers will be notified of newly uploaded videos. However, a channel owner who is uploading many videos might prefer to set the value to False to avoid sending a notification about each new video to the channel's subscribers. */ notifySubscribers?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * This parameter can only be used in a properly authorized request. Note: - * This parameter is intended exclusively for YouTube content partners. The - * onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID - * of the channel to which a video is being added. This parameter is - * required when a request specifies a value for the onBehalfOfContentOwner - * parameter, and it can only be used in conjunction with that parameter. In - * addition, the request must be authorized using a CMS account that is - * linked to the content owner that the onBehalfOfContentOwner parameter - * specifies. Finally, the channel that the onBehalfOfContentOwnerChannel - * parameter value specifies must be linked to the content owner that the - * onBehalfOfContentOwner parameter specifies. This parameter is intended - * for YouTube content partners that own and manage many different YouTube - * channels. It allows content owners to authenticate once and perform - * actions on behalf of the channel specified in the parameter value, - * without having to provide authentication credentials for each separate - * channel. + * This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. */ onBehalfOfContentOwnerChannel?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. Note that not all parts - * contain properties that can be set when inserting or updating a video. - * For example, the statistics object encapsulates statistics that YouTube - * calculates for a video and does not contain values that you can set or - * modify. If the parameter value specifies a part that does not contain - * mutable values, that part will still be included in the API response. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. */ part?: string; /** - * The stabilize parameter indicates whether YouTube should adjust the video - * to remove shaky camera motions. + * The stabilize parameter indicates whether YouTube should adjust the video to remove shaky camera motions. */ stabilize?: boolean; @@ -13497,20 +11629,11 @@ export namespace youtube_v3 { */ chart?: string; /** - * The hl parameter instructs the API to retrieve localized resource - * metadata for a specific application language that the YouTube website - * supports. The parameter value must be a language code included in the - * list returned by the i18nLanguages.list method. If localized resource - * details are available in that language, the resource's snippet.localized - * object will contain the localized values. However, if localized details - * are not available, the snippet.localized object will contain resource - * details in the resource's default language. + * The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language. */ hl?: string; /** - * The id parameter specifies a comma-separated list of the YouTube video - * ID(s) for the resource(s) that are being retrieved. In a video resource, - * the id property specifies the video's ID. + * The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. */ id?: string; /** @@ -13518,73 +11641,39 @@ export namespace youtube_v3 { */ locale?: string; /** - * The maxHeight parameter specifies a maximum height of the embedded - * player. If maxWidth is provided, maxHeight may not be reached in order to - * not violate the width request. + * The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request. */ maxHeight?: number; /** - * The maxResults parameter specifies the maximum number of items that - * should be returned in the result set. Note: This parameter is supported - * for use in conjunction with the myRating and chart parameters, but it is - * not supported for use in conjunction with the id parameter. + * The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter. */ maxResults?: number; /** - * The maxWidth parameter specifies a maximum width of the embedded player. - * If maxHeight is provided, maxWidth may not be reached in order to not - * violate the height request. + * The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request. */ maxWidth?: number; /** - * Set this parameter's value to like or dislike to instruct the API to only - * return videos liked or disliked by the authenticated user. + * Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user. */ myRating?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken and - * prevPageToken properties identify other pages that could be retrieved. - * Note: This parameter is supported for use in conjunction with the - * myRating and chart parameters, but it is not supported for use in - * conjunction with the id parameter. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter. */ pageToken?: string; /** - * The part parameter specifies a comma-separated list of one or more video - * resource properties that the API response will include. If the parameter - * identifies a property that contains child properties, the child - * properties will be included in the response. For example, in a video - * resource, the snippet property contains the channelId, title, - * description, tags, and categoryId properties. As such, if you set - * part=snippet, the API response will contain all of those properties. + * The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties. */ part?: string; /** - * The regionCode parameter instructs the API to select a video chart - * available in the specified region. This parameter can only be used in - * conjunction with the chart parameter. The parameter value is an ISO - * 3166-1 alpha-2 country code. + * The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code. */ regionCode?: string; /** - * The videoCategoryId parameter identifies the video category for which the - * chart should be retrieved. This parameter can only be used in conjunction - * with the chart parameter. By default, charts are not restricted to a - * particular category. + * The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category. */ videoCategoryId?: string; } @@ -13595,8 +11684,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube video ID of the video that is - * being rated or having its rating removed. + * The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed. */ id?: string; /** @@ -13612,16 +11700,7 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -13637,36 +11716,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The actual CMS account that the user authenticates with must be - * linked to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The part parameter serves two purposes in this operation. It identifies - * the properties that the write operation will set as well as the - * properties that the API response will include. Note that this method - * will override the existing values for all of the mutable properties that - * are contained in any parts that the parameter value specifies. For - * example, a video's privacy setting is contained in the status part. As - * such, if your request is updating a private video, and the request's part - * parameter value includes the status part, the video's privacy setting - * will be updated to whatever value the request body specifies. If the - * request body does not specify a value, the existing privacy setting will - * be removed and the video will revert to the default privacy setting. In - * addition, not all parts contain properties that can be set when inserting - * or updating a video. For example, the statistics object encapsulates - * statistics that YouTube calculates for a video and does not contain - * values that you can set or modify. If the parameter value specifies a - * part that does not contain mutable values, that part will still be - * included in the API response. + * The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. */ part?: string; @@ -13842,21 +11896,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channelId parameter specifies the YouTube channel ID for which the - * watermark is being provided. + * The channelId parameter specifies the YouTube channel ID for which the watermark is being provided. */ channelId?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -13887,21 +11931,11 @@ export namespace youtube_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channelId parameter specifies the YouTube channel ID for which the - * watermark is being unset. + * The channelId parameter specifies the YouTube channel ID for which the watermark is being unset. */ channelId?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } diff --git a/src/apis/youtubeAnalytics/package.json b/src/apis/youtubeAnalytics/package.json index fe23acff68e..6d6e0ead3ea 100644 --- a/src/apis/youtubeAnalytics/package.json +++ b/src/apis/youtubeAnalytics/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/youtubeAnalytics/v1.ts b/src/apis/youtubeAnalytics/v1.ts index d5c22a2bd3f..eaf16740936 100644 --- a/src/apis/youtubeAnalytics/v1.ts +++ b/src/apis/youtubeAnalytics/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace youtubeAnalytics_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace youtubeAnalytics_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -97,7 +94,10 @@ export namespace youtubeAnalytics_v1 { reports: Resource$Reports; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.groupItems = new Resource$Groupitems(this.context); this.groups = new Resource$Groups(this.context); @@ -120,8 +120,7 @@ export namespace youtubeAnalytics_v1 { resource?: {id?: string; kind?: string}; } /** - * A paginated list of grouList resources returned in response to a - * youtubeAnalytics.groupApi.list request. + * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. */ export interface Schema$GroupItemListResponse { etag?: string; @@ -129,8 +128,7 @@ export namespace youtubeAnalytics_v1 { kind?: string; } /** - * A paginated list of grouList resources returned in response to a - * youtubeAnalytics.groupApi.list request. + * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. */ export interface Schema$GroupListResponse { etag?: string; @@ -139,23 +137,11 @@ export namespace youtubeAnalytics_v1 { nextPageToken?: string; } /** - * Contains a single result table. The table is returned as an array of rows - * that contain the values for the cells of the table. Depending on the metric - * or dimension, the cell can contain a string (video ID, country code) or a - * number (number of views or number of likes). + * Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes). */ export interface Schema$ResultTable { /** - * This value specifies information about the data returned in the rows - * fields. Each item in the columnHeaders list identifies a field returned - * in the rows value, which contains a list of comma-delimited data. The - * columnHeaders list will begin with the dimensions specified in the API - * request, which will be followed by the metrics specified in the API - * request. The order of both dimensions and metrics will match the ordering - * in the API request. For example, if the API request contains the - * parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the - * API response will return columns in this order: - * ageGroup,gender,viewerPercentage. + * This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage. */ columnHeaders?: Array<{ columnType?: string; @@ -163,19 +149,11 @@ export namespace youtubeAnalytics_v1 { name?: string; }>; /** - * This value specifies the type of data included in the API response. For - * the query method, the kind property value will be - * youtubeAnalytics#resultTable. + * This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable. */ kind?: string; /** - * The list contains all rows of the result table. Each item in the list is - * an array that contains comma-delimited data corresponding to a single row - * of data. The order of the comma-delimited data fields will match the - * order of the columns listed in the columnHeaders field. If no data is - * available for the given query, the rows element will be omitted from the - * response. The response for a query with the day dimension will not - * contain rows for the most recent days. + * The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days. */ rows?: any[][]; } @@ -336,8 +314,7 @@ export namespace youtubeAnalytics_v1 { /** * youtubeAnalytics.groupItems.list - * @desc Returns a collection of group items that match the API request - * parameters. + * @desc Returns a collection of group items that match the API request parameters. * @alias youtubeAnalytics.groupItems.list * @memberOf! () * @@ -420,21 +397,11 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube group item ID for the group that - * is being deleted. + * The id parameter specifies the YouTube group item ID for the group that is being deleted. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -446,16 +413,7 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -471,21 +429,11 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the unique ID of the group for which you want - * to retrieve group items. + * The id parameter specifies the unique ID of the group for which you want to retrieve group items. */ groupId?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -642,10 +590,7 @@ export namespace youtubeAnalytics_v1 { /** * youtubeAnalytics.groups.list - * @desc Returns a collection of groups that match the API request - * parameters. For example, you can retrieve all groups that the - * authenticated user owns, or you can retrieve one or more groups by their - * unique IDs. + * @desc Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. * @alias youtubeAnalytics.groups.list * @memberOf! () * @@ -799,21 +744,11 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube group ID for the group that is - * being deleted. + * The id parameter specifies the YouTube group ID for the group that is being deleted. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -824,16 +759,7 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -849,33 +775,19 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of the YouTube group - * ID(s) for the resource(s) that are being retrieved. In a group resource, - * the id property specifies the group's YouTube group ID. + * The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. */ id?: string; /** - * Set this parameter's value to true to instruct the API to only return - * groups owned by the authenticated user. + * Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user. */ mine?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken property - * identifies the next page that can be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved. */ pageToken?: string; } @@ -886,16 +798,7 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -1002,48 +905,27 @@ export namespace youtubeAnalytics_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The currency to which financial metrics should be converted. The default - * is US Dollar (USD). If the result contains no financial metrics, this - * flag will be ignored. Responds with an error if the specified currency is - * not recognized. + * The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized. */ currency?: string; /** - * A comma-separated list of YouTube Analytics dimensions, such as views or - * ageGroup,gender. See the Available Reports document for a list of the - * reports that you can retrieve and the dimensions used for those reports. - * Also see the Dimensions document for definitions of those dimensions. + * A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions. */ dimensions?: string; /** - * The end date for fetching YouTube Analytics data. The value should be in - * YYYY-MM-DD format. + * The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. */ 'end-date'?: string; /** - * A list of filters that should be applied when retrieving YouTube - * Analytics data. The Available Reports document identifies the dimensions - * that can be used to filter each report, and the Dimensions document - * defines those dimensions. If a request uses multiple filters, join them - * together with a semicolon (;), and the returned result table will satisfy - * both filters. For example, a filters parameter value of - * video==dMH0bHeiRNg;country==IT restricts the result set to include data - * for the given video in Italy. + * A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy. */ filters?: string; /** - * Identifies the YouTube channel or content owner for which you are - * retrieving YouTube Analytics data. - To request data for a YouTube user, - * set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID - * specifies the unique YouTube channel ID. - To request data for a YouTube - * CMS content owner, set the ids parameter value to - * contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content - * owner. + * Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. */ ids?: string; /** - * If set to true historical data (i.e. channel data from before the linking - * of the channel to the content owner) will be retrieved. + * If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved. */ 'include-historical-channel-data'?: boolean; /** @@ -1051,27 +933,19 @@ export namespace youtubeAnalytics_v1 { */ 'max-results'?: number; /** - * A comma-separated list of YouTube Analytics metrics, such as views or - * likes,dislikes. See the Available Reports document for a list of the - * reports that you can retrieve and the metrics available in each report, - * and see the Metrics document for definitions of those metrics. + * A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. */ metrics?: string; /** - * A comma-separated list of dimensions or metrics that determine the sort - * order for YouTube Analytics data. By default the sort order is ascending. - * The '-' prefix causes descending sort order. + * A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order. */ sort?: string; /** - * The start date for fetching YouTube Analytics data. The value should be - * in YYYY-MM-DD format. + * The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. */ 'start-date'?: string; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter (one-based, - * inclusive). + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive). */ 'start-index'?: number; } diff --git a/src/apis/youtubeAnalytics/v1beta1.ts b/src/apis/youtubeAnalytics/v1beta1.ts index fd3046f9608..a6670790170 100644 --- a/src/apis/youtubeAnalytics/v1beta1.ts +++ b/src/apis/youtubeAnalytics/v1beta1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -51,9 +51,7 @@ export namespace youtubeAnalytics_v1beta1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -65,8 +63,7 @@ export namespace youtubeAnalytics_v1beta1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not - * exceed 40 characters. + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** @@ -97,7 +94,10 @@ export namespace youtubeAnalytics_v1beta1 { reports: Resource$Reports; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.groupItems = new Resource$Groupitems(this.context); this.groups = new Resource$Groups(this.context); @@ -120,8 +120,7 @@ export namespace youtubeAnalytics_v1beta1 { resource?: {id?: string; kind?: string}; } /** - * A paginated list of grouList resources returned in response to a - * youtubeAnalytics.groupApi.list request. + * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. */ export interface Schema$GroupItemListResponse { etag?: string; @@ -129,8 +128,7 @@ export namespace youtubeAnalytics_v1beta1 { kind?: string; } /** - * A paginated list of grouList resources returned in response to a - * youtubeAnalytics.groupApi.list request. + * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. */ export interface Schema$GroupListResponse { etag?: string; @@ -139,23 +137,11 @@ export namespace youtubeAnalytics_v1beta1 { nextPageToken?: string; } /** - * Contains a single result table. The table is returned as an array of rows - * that contain the values for the cells of the table. Depending on the metric - * or dimension, the cell can contain a string (video ID, country code) or a - * number (number of views or number of likes). + * Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes). */ export interface Schema$ResultTable { /** - * This value specifies information about the data returned in the rows - * fields. Each item in the columnHeaders list identifies a field returned - * in the rows value, which contains a list of comma-delimited data. The - * columnHeaders list will begin with the dimensions specified in the API - * request, which will be followed by the metrics specified in the API - * request. The order of both dimensions and metrics will match the ordering - * in the API request. For example, if the API request contains the - * parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the - * API response will return columns in this order: - * ageGroup,gender,viewerPercentage. + * This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage. */ columnHeaders?: Array<{ columnType?: string; @@ -163,19 +149,11 @@ export namespace youtubeAnalytics_v1beta1 { name?: string; }>; /** - * This value specifies the type of data included in the API response. For - * the query method, the kind property value will be - * youtubeAnalytics#resultTable. + * This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable. */ kind?: string; /** - * The list contains all rows of the result table. Each item in the list is - * an array that contains comma-delimited data corresponding to a single row - * of data. The order of the comma-delimited data fields will match the - * order of the columns listed in the columnHeaders field. If no data is - * available for the given query, the rows element will be omitted from the - * response. The response for a query with the day dimension will not - * contain rows for the most recent days. + * The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days. */ rows?: any[][]; } @@ -336,8 +314,7 @@ export namespace youtubeAnalytics_v1beta1 { /** * youtubeAnalytics.groupItems.list - * @desc Returns a collection of group items that match the API request - * parameters. + * @desc Returns a collection of group items that match the API request parameters. * @alias youtubeAnalytics.groupItems.list * @memberOf! () * @@ -420,21 +397,11 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube group item ID for the group that - * is being deleted. + * The id parameter specifies the YouTube group item ID for the group that is being deleted. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -446,16 +413,7 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -471,21 +429,11 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the unique ID of the group for which you want - * to retrieve group items. + * The id parameter specifies the unique ID of the group for which you want to retrieve group items. */ groupId?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -642,10 +590,7 @@ export namespace youtubeAnalytics_v1beta1 { /** * youtubeAnalytics.groups.list - * @desc Returns a collection of groups that match the API request - * parameters. For example, you can retrieve all groups that the - * authenticated user owns, or you can retrieve one or more groups by their - * unique IDs. + * @desc Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. * @alias youtubeAnalytics.groups.list * @memberOf! () * @@ -799,21 +744,11 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies the YouTube group ID for the group that is - * being deleted. + * The id parameter specifies the YouTube group ID for the group that is being deleted. */ id?: string; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -824,16 +759,7 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -849,33 +775,19 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id parameter specifies a comma-separated list of the YouTube group - * ID(s) for the resource(s) that are being retrieved. In a group resource, - * the id property specifies the group's YouTube group ID. + * The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. */ id?: string; /** - * Set this parameter's value to true to instruct the API to only return - * groups owned by the authenticated user. + * Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user. */ mine?: boolean; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The pageToken parameter identifies a specific page in the result set that - * should be returned. In an API response, the nextPageToken property - * identifies the next page that can be retrieved. + * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved. */ pageToken?: string; } @@ -886,16 +798,7 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Note: This parameter is intended exclusively for YouTube content - * partners. The onBehalfOfContentOwner parameter indicates that the - * request's authorization credentials identify a YouTube CMS user who is - * acting on behalf of the content owner specified in the parameter value. - * This parameter is intended for YouTube content partners that own and - * manage many different YouTube channels. It allows content owners to - * authenticate once and get access to all their video and channel data, - * without having to provide authentication credentials for each individual - * channel. The CMS account that the user authenticates with must be linked - * to the specified YouTube content owner. + * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -1002,48 +905,27 @@ export namespace youtubeAnalytics_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The currency to which financial metrics should be converted. The default - * is US Dollar (USD). If the result contains no financial metrics, this - * flag will be ignored. Responds with an error if the specified currency is - * not recognized. + * The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized. */ currency?: string; /** - * A comma-separated list of YouTube Analytics dimensions, such as views or - * ageGroup,gender. See the Available Reports document for a list of the - * reports that you can retrieve and the dimensions used for those reports. - * Also see the Dimensions document for definitions of those dimensions. + * A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions. */ dimensions?: string; /** - * The end date for fetching YouTube Analytics data. The value should be in - * YYYY-MM-DD format. + * The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. */ 'end-date'?: string; /** - * A list of filters that should be applied when retrieving YouTube - * Analytics data. The Available Reports document identifies the dimensions - * that can be used to filter each report, and the Dimensions document - * defines those dimensions. If a request uses multiple filters, join them - * together with a semicolon (;), and the returned result table will satisfy - * both filters. For example, a filters parameter value of - * video==dMH0bHeiRNg;country==IT restricts the result set to include data - * for the given video in Italy. + * A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy. */ filters?: string; /** - * Identifies the YouTube channel or content owner for which you are - * retrieving YouTube Analytics data. - To request data for a YouTube user, - * set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID - * specifies the unique YouTube channel ID. - To request data for a YouTube - * CMS content owner, set the ids parameter value to - * contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content - * owner. + * Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. */ ids?: string; /** - * If set to true historical data (i.e. channel data from before the linking - * of the channel to the content owner) will be retrieved. + * If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved. */ 'include-historical-channel-data'?: boolean; /** @@ -1051,27 +933,19 @@ export namespace youtubeAnalytics_v1beta1 { */ 'max-results'?: number; /** - * A comma-separated list of YouTube Analytics metrics, such as views or - * likes,dislikes. See the Available Reports document for a list of the - * reports that you can retrieve and the metrics available in each report, - * and see the Metrics document for definitions of those metrics. + * A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. */ metrics?: string; /** - * A comma-separated list of dimensions or metrics that determine the sort - * order for YouTube Analytics data. By default the sort order is ascending. - * The '-' prefix causes descending sort order. + * A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order. */ sort?: string; /** - * The start date for fetching YouTube Analytics data. The value should be - * in YYYY-MM-DD format. + * The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. */ 'start-date'?: string; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter (one-based, - * inclusive). + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive). */ 'start-index'?: number; } diff --git a/src/apis/youtubeAnalytics/v2.ts b/src/apis/youtubeAnalytics/v2.ts index 179d87b26aa..55b80606355 100644 --- a/src/apis/youtubeAnalytics/v2.ts +++ b/src/apis/youtubeAnalytics/v2.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace youtubeAnalytics_v2 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace youtubeAnalytics_v2 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -114,7 +110,10 @@ export namespace youtubeAnalytics_v2 { reports: Resource$Reports; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.groupItems = new Resource$Groupitems(this.context); this.groups = new Resource$Groups(this.context); @@ -136,15 +135,11 @@ export namespace youtubeAnalytics_v2 { */ export interface Schema$ErrorProto { /** - * Error arguments, to be used when building user-friendly error messages - * given the error domain and code. Different error codes require different - * arguments. + * Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. */ argument?: string[]; /** - * Error code in the error domain. This should correspond to a value of the - * enum type whose name is in domain. See the core error domain in - * error_domain.proto. + * Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. */ code?: string; /** @@ -152,39 +147,25 @@ export namespace youtubeAnalytics_v2 { */ debugInfo?: string; /** - * Error domain. RoSy services can define their own domain and error codes. - * This should normally be the name of an enum type, such as: - * gdata.CoreErrorDomain + * Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain */ domain?: string; /** - * A short explanation for the error, which can be shared outside Google. - * Please set domain, code and arguments whenever possible instead of this - * error message so that external APIs can build safe error messages - * themselves. External messages built in a RoSy interface will most likely - * refer to information and concepts that are not available externally and - * should not be exposed. It is safer if external APIs can understand the - * errors and decide what the error message should look like. + * A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like. */ externalErrorMessage?: string; /** - * Location of the error, as specified by the location type. If - * location_type is PATH, this should be a path to a field that's - * relative to the request, using FieldPath notation - * (net/proto2/util/public/field_path.h). Examples: - * authenticated_user.gaia_id resource.address[2].country + * Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country */ location?: string; locationType?: string; } /** - * Request Error information. The presence of an error field signals that the - * operation has failed. + * Request Error information. The presence of an error field signals that the operation has failed. */ export interface Schema$Errors { /** - * Global error code. Deprecated and ignored. Set custom error codes in - * ErrorProto.domain and ErrorProto.code instead. + * Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. */ code?: string; /** @@ -192,8 +173,7 @@ export namespace youtubeAnalytics_v2 { */ error?: Schema$ErrorProto[]; /** - * Request identifier generated by the service, which can be used to - * identify the error in the logs + * Request identifier generated by the service, which can be used to identify the error in the logs */ requestId?: string; } @@ -202,8 +182,7 @@ export namespace youtubeAnalytics_v2 { */ export interface Schema$Group { /** - * The `contentDetails` object contains additional information about the - * group, such as the number and type of items that it contains. + * The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains. */ contentDetails?: Schema$GroupContentDetails; /** @@ -219,13 +198,11 @@ export namespace youtubeAnalytics_v2 { */ id?: string; /** - * Identifies the API resource's type. The value will be - * `youtube#group`. + * Identifies the API resource's type. The value will be `youtube#group`. */ kind?: string; /** - * The `snippet` object contains basic information about the group, - * including its creation date and name. + * The `snippet` object contains basic information about the group, including its creation date and name. */ snippet?: Schema$GroupSnippet; } @@ -238,9 +215,7 @@ export namespace youtubeAnalytics_v2 { */ itemCount?: string; /** - * The type of resources that the group contains. Valid values for this - * property are: * `youtube#channel` * `youtube#playlist` * - * `youtube#video` * `youtubePartner#asset` + * The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` */ itemType?: string; } @@ -257,41 +232,29 @@ export namespace youtubeAnalytics_v2 { */ etag?: string; /** - * The ID that YouTube uses to uniquely identify the group that contains the - * item. + * The ID that YouTube uses to uniquely identify the group that contains the item. */ groupId?: string; /** - * The ID that YouTube uses to uniquely identify the `channel`, `video`, - * `playlist`, or `asset` resource that is included in the group. Note that - * this ID refers specifically to the inclusion of that resource in a - * particular group and is different than the channel ID, video ID, playlist - * ID, or asset ID that uniquely identifies the resource itself. The - * `resource.id` property's value specifies the unique channel, video, - * playlist, or asset ID. + * The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. */ id?: string; /** - * Identifies the API resource's type. The value will be - * `youtube#groupItem`. + * Identifies the API resource's type. The value will be `youtube#groupItem`. */ kind?: string; /** - * The `resource` object contains information that identifies the item being - * added to the group. + * The `resource` object contains information that identifies the item being added to the group. */ resource?: Schema$GroupItemResource; } export interface Schema$GroupItemResource { /** - * The channel, video, playlist, or asset ID that YouTube uses to uniquely - * identify the item that is being added to the group. + * The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. */ id?: string; /** - * Identifies the type of resource being added to the group. Valid values - * for this property are: * `youtube#channel` * `youtube#playlist` * - * `youtube#video` * `youtubePartner#asset` + * Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` */ kind?: string; } @@ -300,8 +263,7 @@ export namespace youtubeAnalytics_v2 { */ export interface Schema$GroupSnippet { /** - * The date and time that the group was created. The value is specified in - * ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + * The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. */ publishedAt?: string; /** @@ -322,13 +284,11 @@ export namespace youtubeAnalytics_v2 { */ etag?: string; /** - * A list of groups that match the API request parameters. Each item in the - * list represents a `groupItem` resource. + * A list of groups that match the API request parameters. Each item in the list represents a `groupItem` resource. */ items?: Schema$GroupItem[]; /** - * Identifies the API resource's type. The value will be - * `youtube#groupItemListResponse`. + * Identifies the API resource's type. The value will be `youtube#groupItemListResponse`. */ kind?: string; } @@ -345,18 +305,15 @@ export namespace youtubeAnalytics_v2 { */ etag?: string; /** - * A list of groups that match the API request parameters. Each item in the - * list represents a `group` resource. + * A list of groups that match the API request parameters. Each item in the list represents a `group` resource. */ items?: Schema$Group[]; /** - * Identifies the API resource's type. The value will be - * `youtube#groupListResponse`. + * Identifies the API resource's type. The value will be `youtube#groupListResponse`. */ kind?: string; /** - * The token that can be used as the value of the `pageToken` parameter to - * retrieve the next page in the result set. + * The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. */ nextPageToken?: string; } @@ -365,16 +322,7 @@ export namespace youtubeAnalytics_v2 { */ export interface Schema$QueryResponse { /** - * This value specifies information about the data returned in the `rows` - * fields. Each item in the `columnHeaders` list identifies a field returned - * in the `rows` value, which contains a list of comma-delimited data. The - * `columnHeaders` list will begin with the dimensions specified in the API - * request, which will be followed by the metrics specified in the API - * request. The order of both dimensions and metrics will match the ordering - * in the API request. For example, if the API request contains the - * parameters `dimensions=ageGroup,gender&metrics=viewerPercentage`, the - * API response will return columns in this order: `ageGroup`, `gender`, - * `viewerPercentage`. + * This value specifies information about the data returned in the `rows` fields. Each item in the `columnHeaders` list identifies a field returned in the `rows` value, which contains a list of comma-delimited data. The `columnHeaders` list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters `dimensions=ageGroup,gender&metrics=viewerPercentage`, the API response will return columns in this order: `ageGroup`, `gender`, `viewerPercentage`. */ columnHeaders?: Schema$ResultTableColumnHeader[]; /** @@ -382,19 +330,11 @@ export namespace youtubeAnalytics_v2 { */ errors?: Schema$Errors; /** - * This value specifies the type of data included in the API response. For - * the query method, the kind property value will be - * `youtubeAnalytics#resultTable`. + * This value specifies the type of data included in the API response. For the query method, the kind property value will be `youtubeAnalytics#resultTable`. */ kind?: string; /** - * The list contains all rows of the result table. Each item in the list is - * an array that contains comma-delimited data corresponding to a single row - * of data. The order of the comma-delimited data fields will match the - * order of the columns listed in the `columnHeaders` field. If no data is - * available for the given query, the `rows` element will be omitted from - * the response. The response for a query with the `day` dimension will not - * contain rows for the most recent days. + * The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the `columnHeaders` field. If no data is available for the given query, the `rows` element will be omitted from the response. The response for a query with the `day` dimension will not contain rows for the most recent days. */ rows?: any[][]; } @@ -570,8 +510,7 @@ export namespace youtubeAnalytics_v2 { /** * youtubeAnalytics.groupItems.list - * @desc Returns a collection of group items that match the API request - * parameters. + * @desc Returns a collection of group items that match the API request parameters. * @alias youtubeAnalytics.groupItems.list * @memberOf! () * @@ -652,21 +591,11 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The `id` parameter specifies the YouTube group item ID of the group item - * that is being deleted. + * The `id` parameter specifies the YouTube group item ID of the group item that is being deleted. */ id?: string; /** - * This parameter can only be used in a properly authorized request. - * **Note:** This parameter is intended exclusively for YouTube content - * partners that own and manage many different YouTube channels. The - * `onBehalfOfContentOwner` parameter indicates that the request's - * authorization credentials identify a YouTube user who is acting on behalf - * of the content owner specified in the parameter value. It allows content - * owners to authenticate once and get access to all their video and channel - * data, without having to provide authentication credentials for each - * individual channel. The account that the user authenticates with must be - * linked to the specified YouTube content owner. + * This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -678,16 +607,7 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This parameter can only be used in a properly authorized request. - * **Note:** This parameter is intended exclusively for YouTube content - * partners that own and manage many different YouTube channels. The - * `onBehalfOfContentOwner` parameter indicates that the request's - * authorization credentials identify a YouTube user who is acting on behalf - * of the content owner specified in the parameter value. It allows content - * owners to authenticate once and get access to all their video and channel - * data, without having to provide authentication credentials for each - * individual channel. The account that the user authenticates with must be - * linked to the specified YouTube content owner. + * This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -703,21 +623,11 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The `groupId` parameter specifies the unique ID of the group for which - * you want to retrieve group items. + * The `groupId` parameter specifies the unique ID of the group for which you want to retrieve group items. */ groupId?: string; /** - * This parameter can only be used in a properly authorized request. - * **Note:** This parameter is intended exclusively for YouTube content - * partners that own and manage many different YouTube channels. The - * `onBehalfOfContentOwner` parameter indicates that the request's - * authorization credentials identify a YouTube user who is acting on behalf - * of the content owner specified in the parameter value. It allows content - * owners to authenticate once and get access to all their video and channel - * data, without having to provide authentication credentials for each - * individual channel. The account that the user authenticates with must be - * linked to the specified YouTube content owner. + * This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -872,10 +782,7 @@ export namespace youtubeAnalytics_v2 { /** * youtubeAnalytics.groups.list - * @desc Returns a collection of groups that match the API request - * parameters. For example, you can retrieve all groups that the - * authenticated user owns, or you can retrieve one or more groups by their - * unique IDs. + * @desc Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. * @alias youtubeAnalytics.groups.list * @memberOf! () * @@ -1025,21 +932,11 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The `id` parameter specifies the YouTube group ID of the group that is - * being deleted. + * The `id` parameter specifies the YouTube group ID of the group that is being deleted. */ id?: string; /** - * This parameter can only be used in a properly authorized request. - * **Note:** This parameter is intended exclusively for YouTube content - * partners that own and manage many different YouTube channels. The - * `onBehalfOfContentOwner` parameter indicates that the request's - * authorization credentials identify a YouTube user who is acting on behalf - * of the content owner specified in the parameter value. It allows content - * owners to authenticate once and get access to all their video and channel - * data, without having to provide authentication credentials for each - * individual channel. The account that the user authenticates with must be - * linked to the specified YouTube content owner. + * This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; } @@ -1050,16 +947,7 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This parameter can only be used in a properly authorized request. - * **Note:** This parameter is intended exclusively for YouTube content - * partners that own and manage many different YouTube channels. The - * `onBehalfOfContentOwner` parameter indicates that the request's - * authorization credentials identify a YouTube user who is acting on behalf - * of the content owner specified in the parameter value. It allows content - * owners to authenticate once and get access to all their video and channel - * data, without having to provide authentication credentials for each - * individual channel. The account that the user authenticates with must be - * linked to the specified YouTube content owner. + * This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -1075,37 +963,19 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The `id` parameter specifies a comma-separated list of the YouTube group - * ID(s) for the resource(s) that are being retrieved. Each group must be - * owned by the authenticated user. In a `group` resource, the `id` property - * specifies the group's YouTube group ID. Note that if you do not specify - * a value for the `id` parameter, then you must set the `mine` parameter to - * `true`. + * The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`. */ id?: string; /** - * This parameter can only be used in a properly authorized request. Set - * this parameter's value to true to retrieve all groups owned by the - * authenticated user. + * This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user. */ mine?: boolean; /** - * This parameter can only be used in a properly authorized request. - * **Note:** This parameter is intended exclusively for YouTube content - * partners that own and manage many different YouTube channels. The - * `onBehalfOfContentOwner` parameter indicates that the request's - * authorization credentials identify a YouTube user who is acting on behalf - * of the content owner specified in the parameter value. It allows content - * owners to authenticate once and get access to all their video and channel - * data, without having to provide authentication credentials for each - * individual channel. The account that the user authenticates with must be - * linked to the specified YouTube content owner. + * This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; /** - * The `pageToken` parameter identifies a specific page in the result set - * that should be returned. In an API response, the `nextPageToken` property - * identifies the next page that can be retrieved. + * The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved. */ pageToken?: string; } @@ -1116,16 +986,7 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * This parameter can only be used in a properly authorized request. - * **Note:** This parameter is intended exclusively for YouTube content - * partners that own and manage many different YouTube channels. The - * `onBehalfOfContentOwner` parameter indicates that the request's - * authorization credentials identify a YouTube user who is acting on behalf - * of the content owner specified in the parameter value. It allows content - * owners to authenticate once and get access to all their video and channel - * data, without having to provide authentication credentials for each - * individual channel. The account that the user authenticates with must be - * linked to the specified YouTube content owner. + * This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. */ onBehalfOfContentOwner?: string; @@ -1230,52 +1091,27 @@ export namespace youtubeAnalytics_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The currency to which financial metrics should be converted. The default - * is US Dollar (USD). If the result contains no financial metrics, this - * flag will be ignored. Responds with an error if the specified currency is - * not recognized.", pattern: [A-Z]{3} + * The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3} */ currency?: string; /** - * A comma-separated list of YouTube Analytics dimensions, such as `views` - * or `ageGroup,gender`. See the [Available - * Reports](/youtube/analytics/v2/available_reports) document for a list of - * the reports that you can retrieve and the dimensions used for those - * reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims) - * document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+ + * A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+ */ dimensions?: string; /** - * The end date for fetching YouTube Analytics data. The value should be in - * `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2} + * The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2} */ endDate?: string; /** - * A list of filters that should be applied when retrieving YouTube - * Analytics data. The [Available - * Reports](/youtube/analytics/v2/available_reports) document identifies the - * dimensions that can be used to filter each report, and the - * [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those - * dimensions. If a request uses multiple filters, join them together with a - * semicolon (`;`), and the returned result table will satisfy both filters. - * For example, a filters parameter value of - * `video==dMH0bHeiRNg;country==IT` restricts the result set to include data - * for the given video in Italy.", + * A list of filters that should be applied when retrieving YouTube Analytics data. The [Available Reports](/youtube/analytics/v2/available_reports) document identifies the dimensions that can be used to filter each report, and the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (`;`), and the returned result table will satisfy both filters. For example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` restricts the result set to include data for the given video in Italy.", */ filters?: string; /** - * Identifies the YouTube channel or content owner for which you are - * retrieving YouTube Analytics data. - To request data for a YouTube user, - * set the `ids` parameter value to `channel==CHANNEL_ID`, where - * `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data - * for a YouTube CMS content owner, set the `ids` parameter value to - * `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the - * content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+ + * Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the `ids` parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+ */ ids?: string; /** - * If set to true historical data (i.e. channel data from before the linking - * of the channel to the content owner) will be retrieved.", + * If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.", */ includeHistoricalChannelData?: boolean; /** @@ -1283,31 +1119,19 @@ export namespace youtubeAnalytics_v2 { */ maxResults?: number; /** - * A comma-separated list of YouTube Analytics metrics, such as `views` or - * `likes,dislikes`. See the [Available - * Reports](/youtube/analytics/v2/available_reports) document for a list of - * the reports that you can retrieve and the metrics available in each - * report, and see the [Metrics](/youtube/analytics/v2/dimsmets/mets) - * document for definitions of those metrics. required: true, pattern: - * [0-9a-zA-Z,]+ + * A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the metrics available in each report, and see the [Metrics](/youtube/analytics/v2/dimsmets/mets) document for definitions of those metrics. required: true, pattern: [0-9a-zA-Z,]+ */ metrics?: string; /** - * A comma-separated list of dimensions or metrics that determine the sort - * order for YouTube Analytics data. By default the sort order is ascending. - * The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+ + * A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+ */ sort?: string; /** - * The start date for fetching YouTube Analytics data. The value should be - * in `YYYY-MM-DD` format. required: true, pattern: - * "[0-9]{4}-[0-9]{2}-[0-9]{2} + * The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2} */ startDate?: string; /** - * An index of the first entity to retrieve. Use this parameter as a - * pagination mechanism along with the max-results parameter (one-based, - * inclusive).", minValue: 1 + * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1 */ startIndex?: number; } diff --git a/src/apis/youtubereporting/package.json b/src/apis/youtubereporting/package.json index f8f7a6e6491..689fd7d7dda 100644 --- a/src/apis/youtubereporting/package.json +++ b/src/apis/youtubereporting/package.json @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,7 +29,7 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", diff --git a/src/apis/youtubereporting/v1.ts b/src/apis/youtubereporting/v1.ts index 991facb6d10..876242ca860 100644 --- a/src/apis/youtubereporting/v1.ts +++ b/src/apis/youtubereporting/v1.ts @@ -14,21 +14,21 @@ * limitations under the License. */ -import {GaxiosPromise} from 'gaxios'; import { - Compute, - JWT, OAuth2Client, + JWT, + Compute, UserRefreshClient, } from 'google-auth-library'; import { - APIRequestContext, - BodyResponseCallback, - createAPIRequest, - GlobalOptions, GoogleConfigurable, + createAPIRequest, MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, } from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; // tslint:disable: no-any // tslint:disable: class-name @@ -63,9 +63,7 @@ export namespace youtubereporting_v1 { */ fields?: string; /** - * API key. Your API key identifies your project and provides you with API - * access, quota, and reports. Required unless you provide an OAuth 2.0 - * token. + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** @@ -77,9 +75,7 @@ export namespace youtubereporting_v1 { */ prettyPrint?: boolean; /** - * Available to use for quota purposes for server-side applications. Can be - * any arbitrary string assigned to a user, but should not exceed 40 - * characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** @@ -95,8 +91,7 @@ export namespace youtubereporting_v1 { /** * YouTube Reporting API * - * Schedules reporting jobs containing your YouTube Analytics data and - * downloads the resulting bulk data reports in the form of CSV files. + * Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files. * * @example * const {google} = require('googleapis'); @@ -115,7 +110,10 @@ export namespace youtubereporting_v1 { reportTypes: Resource$Reporttypes; constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; + this.context = { + _options: options || {}, + google, + }; this.jobs = new Resource$Jobs(this.context); this.media = new Resource$Media(this.context); @@ -124,11 +122,7 @@ export namespace youtubereporting_v1 { } /** - * A generic empty message that you can re-use to avoid defining duplicated - * empty messages in your APIs. A typical example is to use it as the request - * or the response type of an API method. For instance: service Foo { rpc - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON - * representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -471,8 +465,7 @@ export namespace youtubereporting_v1 { */ createTime?: string; /** - * The date/time when this job will expire/expired. After a job expired, no - * new reports are generated. + * The date/time when this job will expire/expired. After a job expired, no new reports are generated. */ expireTime?: string; /** @@ -484,13 +477,11 @@ export namespace youtubereporting_v1 { */ name?: string; /** - * The type of reports this job creates. Corresponds to the ID of a - * ReportType. + * The type of reports this job creates. Corresponds to the ID of a ReportType. */ reportTypeId?: string; /** - * True if this a system-managed job that cannot be modified by the user; - * otherwise false. + * True if this a system-managed job that cannot be modified by the user; otherwise false. */ systemManaged?: boolean; } @@ -503,9 +494,7 @@ export namespace youtubereporting_v1 { */ jobs?: Schema$Job[]; /** - * A token to retrieve next page of results. Pass this value in the - * ListJobsRequest.page_token field in the subsequent call to `ListJobs` - * method to retrieve the next page of results. + * A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results. */ nextPageToken?: string; } @@ -514,9 +503,7 @@ export namespace youtubereporting_v1 { */ export interface Schema$ListReportsResponse { /** - * A token to retrieve next page of results. Pass this value in the - * ListReportsRequest.page_token field in the subsequent call to - * `ListReports` method to retrieve the next page of results. + * A token to retrieve next page of results. Pass this value in the ListReportsRequest.page_token field in the subsequent call to `ListReports` method to retrieve the next page of results. */ nextPageToken?: string; /** @@ -529,9 +516,7 @@ export namespace youtubereporting_v1 { */ export interface Schema$ListReportTypesResponse { /** - * A token to retrieve next page of results. Pass this value in the - * ListReportTypesRequest.page_token field in the subsequent call to - * `ListReportTypes` method to retrieve the next page of results. + * A token to retrieve next page of results. Pass this value in the ListReportTypesRequest.page_token field in the subsequent call to `ListReportTypes` method to retrieve the next page of results. */ nextPageToken?: string; /** @@ -540,8 +525,7 @@ export namespace youtubereporting_v1 { reportTypes?: Schema$ReportType[]; } /** - * A report's metadata including the URL from which the report itself can - * be downloaded. + * A report's metadata including the URL from which the report itself can be downloaded. */ export interface Schema$Report { /** @@ -553,8 +537,7 @@ export namespace youtubereporting_v1 { */ downloadUrl?: string; /** - * The end of the time period that the report instance covers. The value is - * exclusive. + * The end of the time period that the report instance covers. The value is exclusive. */ endTime?: string; /** @@ -570,8 +553,7 @@ export namespace youtubereporting_v1 { */ jobId?: string; /** - * The start of the time period that the report instance covers. The value - * is inclusive. + * The start of the time period that the report instance covers. The value is inclusive. */ startTime?: string; } @@ -592,9 +574,7 @@ export namespace youtubereporting_v1 { */ name?: string; /** - * True if this a system-managed report type; otherwise false. Reporting - * jobs for system-managed report types are created automatically and can - * thus not be used in the `CreateJob` method. + * True if this a system-managed report type; otherwise false. Reporting jobs for system-managed report types are created automatically and can thus not be used in the `CreateJob` method. */ systemManaged?: boolean; } @@ -899,8 +879,7 @@ export namespace youtubereporting_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The content owner's external ID on which behalf the user is acting on. If - * not set, the user is acting for himself (his own channel). + * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; @@ -920,8 +899,7 @@ export namespace youtubereporting_v1 { */ jobId?: string; /** - * The content owner's external ID on which behalf the user is acting on. If - * not set, the user is acting for himself (his own channel). + * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; } @@ -936,8 +914,7 @@ export namespace youtubereporting_v1 { */ jobId?: string; /** - * The content owner's external ID on which behalf the user is acting on. If - * not set, the user is acting for himself (his own channel). + * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; } @@ -948,25 +925,19 @@ export namespace youtubereporting_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set to true, also system-managed jobs will be returned; otherwise only - * user-created jobs will be returned. System-managed jobs can neither be - * modified nor deleted. + * If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted. */ includeSystemManaged?: boolean; /** - * The content owner's external ID on which behalf the user is acting on. If - * not set, the user is acting for himself (his own channel). + * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** - * Requested page size. Server may return fewer jobs than requested. If - * unspecified, server will pick an appropriate default. + * Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListReportTypesResponse.next_page_token - * returned in response to the previous call to the `ListJobs` method. + * A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method. */ pageToken?: string; } @@ -1053,8 +1024,7 @@ export namespace youtubereporting_v1 { /** * youtubereporting.jobs.reports.list - * @desc Lists reports created by a specific job. Returns NOT_FOUND if the - * job does not exist. + * @desc Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist. * @alias youtubereporting.jobs.reports.list * @memberOf! () * @@ -1145,8 +1115,7 @@ export namespace youtubereporting_v1 { */ jobId?: string; /** - * The content owner's external ID on which behalf the user is acting on. If - * not set, the user is acting for himself (his own channel). + * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** @@ -1170,29 +1139,23 @@ export namespace youtubereporting_v1 { */ jobId?: string; /** - * The content owner's external ID on which behalf the user is acting on. If - * not set, the user is acting for himself (his own channel). + * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** - * Requested page size. Server may return fewer report types than requested. - * If unspecified, server will pick an appropriate default. + * Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListReportsResponse.next_page_token - * returned in response to the previous call to the `ListReports` method. + * A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method. */ pageToken?: string; /** - * If set, only reports whose start time is greater than or equal the - * specified date/time are returned. + * If set, only reports whose start time is greater than or equal the specified date/time are returned. */ startTimeAtOrAfter?: string; /** - * If set, only reports whose start time is smaller than the specified - * date/time are returned. + * If set, only reports whose start time is smaller than the specified date/time are returned. */ startTimeBefore?: string; } @@ -1205,8 +1168,7 @@ export namespace youtubereporting_v1 { /** * youtubereporting.media.download - * @desc Method for media download. Download is supported on the URI - * `/v1/media/{+name}?alt=media`. + * @desc Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`. * @alias youtubereporting.media.download * @memberOf! () * @@ -1381,26 +1343,19 @@ export namespace youtubereporting_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If set to true, also system-managed report types will be returned; - * otherwise only the report types that can be used to create new reporting - * jobs will be returned. + * If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned. */ includeSystemManaged?: boolean; /** - * The content owner's external ID on which behalf the user is acting on. If - * not set, the user is acting for himself (his own channel). + * The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). */ onBehalfOfContentOwner?: string; /** - * Requested page size. Server may return fewer report types than requested. - * If unspecified, server will pick an appropriate default. + * Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A token identifying a page of results the server should return. - * Typically, this is the value of ListReportTypesResponse.next_page_token - * returned in response to the previous call to the `ListReportTypes` - * method. + * A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method. */ pageToken?: string; } diff --git a/src/generator/templates/api-endpoint.njk b/src/generator/templates/api-endpoint.njk index 149b97910aa..112d3de4fe5 100644 --- a/src/generator/templates/api-endpoint.njk +++ b/src/generator/templates/api-endpoint.njk @@ -18,8 +18,20 @@ * limitations under the License. */ -import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library'; -import { GoogleConfigurable, createAPIRequest, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common'; +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext +} from 'googleapis-common'; import { GaxiosPromise } from 'gaxios'; // tslint:disable: no-any @@ -75,7 +87,7 @@ export class {{ Name }} { constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { _options: options || {}, - google + google, }; {% if api.resources %} diff --git a/src/generator/templates/api-index.njk b/src/generator/templates/api-index.njk index 3432482d242..61f718b0e55 100644 --- a/src/generator/templates/api-index.njk +++ b/src/generator/templates/api-index.njk @@ -13,7 +13,11 @@ /*! THIS FILE IS AUTO-GENERATED */ -import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import { + AuthPlus, + getAPI, + GoogleConfigurable +} from 'googleapis-common'; {% for versionName, version in api %} import { {{ name }}_{{ version|replace('.','_') }} } from './{{ version }}'; {% endfor %} diff --git a/src/generator/templates/method-partial.njk b/src/generator/templates/method-partial.njk index cc58279dfe8..adba491121f 100644 --- a/src/generator/templates/method-partial.njk +++ b/src/generator/templates/method-partial.njk @@ -68,7 +68,7 @@ {% if m.mediaUpload.protocols.simple.path %}mediaUrl: (rootUrl + {{ ('/' + m.mediaUpload.protocols.simple.path)|buildurl|safe }}).replace(/([^:]\/)\/+/g, '$1'),{% endif %} requiredParams: [{% if m.parameterOrder.length %}'{{ m.parameterOrder|join("', '")|safe }}'{% endif %}], pathParams: [{% if pathParams.length %}'{{ pathParams|join("', '")|safe }}'{% endif %}], - context: this.context + context: this.context, }; {% set responseType = "Schema$" + m.response.$ref|default() %} if (callback) { diff --git a/src/generator/templates/package.json.njk b/src/generator/templates/package.json.njk index d9d271fe5b5..39146520e5a 100644 --- a/src/generator/templates/package.json.njk +++ b/src/generator/templates/package.json.njk @@ -18,7 +18,7 @@ "url": "https://github.com/googleapis/google-api-nodejs-client.git" }, "engines": { - "node": ">=6.0.0" + "node": ">=8.0.0" }, "scripts": { "fix": "gts fix", @@ -29,12 +29,12 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^0.7.0" + "googleapis-common": "^2.0.0" }, "devDependencies": { "gts": "^1.0.0", - "null-loader": "^0.1.1", - "ts-loader": "^5.3.3", + "null-loader": "^1.0.0", + "ts-loader": "^6.0.0", "typedoc": "^0.14.0", "typescript": "~3.4.0", "webpack": "^4.28.4", diff --git a/src/index.ts b/src/index.ts index a4aa05e3300..dc516525639 100644 --- a/src/index.ts +++ b/src/index.ts @@ -115,6 +115,7 @@ export {content_v2_1} from './apis/content/v2.1'; export {content_v2} from './apis/content/v2'; export {customsearch_v1} from './apis/customsearch/v1'; export {dataflow_v1b3} from './apis/dataflow/v1b3'; +export {datafusion_v1beta1} from './apis/datafusion/v1beta1'; export {dataproc_v1} from './apis/dataproc/v1'; export {dataproc_v1beta2} from './apis/dataproc/v1beta2'; export {datastore_v1} from './apis/datastore/v1'; @@ -165,7 +166,6 @@ export {genomics_v2alpha1} from './apis/genomics/v2alpha1'; export {gmail_v1} from './apis/gmail/v1'; export {groupsmigration_v1} from './apis/groupsmigration/v1'; export {groupssettings_v1} from './apis/groupssettings/v1'; -export {healthcare_v1alpha} from './apis/healthcare/v1alpha'; export {healthcare_v1alpha2} from './apis/healthcare/v1alpha2'; export {healthcare_v1beta1} from './apis/healthcare/v1beta1'; export {iam_v1} from './apis/iam/v1';